/[svn]/web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.html
ViewVC logotype

Diff of /web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1363 by schoenebeck, Sun Sep 30 21:51:14 2007 UTC revision 1685 by schoenebeck, Thu Feb 14 14:41:08 2008 UTC
# Line 1  Line 1 
1  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2  <html lang="en"><head><title>LinuxSampler Control Protocol (draft)</title>  <html lang="en"><head><title>LinuxSampler Control Protocol</title>
3  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
4  <meta name="description" content="LinuxSampler Control Protocol (draft)">  <meta name="description" content="LinuxSampler Control Protocol">
5  <meta name="keywords" content="LSCP">  <meta name="keywords" content="LSCP">
6  <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">  <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">
7  <style type='text/css'><!--  <style type='text/css'><!--
# Line 145  Line 145 
145  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>
146  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>
147  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>
148  <tr><td class="header">Expires: March 4, 2008</td><td class="header">September 2007</td></tr>  <tr><td class="header">Expires: August 17, 2008</td><td class="header">February 14, 2008</td></tr>
149  </table></td></tr></table>  </table></td></tr></table>
150  <h1><br />LinuxSampler Control Protocol (draft)<br />LSCP 1.2cvs</h1>  <h1><br />LinuxSampler Control Protocol<br />LSCP 1.4</h1>
151    
152  <h3>Status of this Memo</h3>  <h3>Status of this Memo</h3>
153  <p>  <p>
# Line 173  The list of current Internet-Drafts can Line 173  The list of current Internet-Drafts can
173  The list of Internet-Draft Shadow Directories can be accessed at  The list of Internet-Draft Shadow Directories can be accessed at
174  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>
175  <p>  <p>
176  This Internet-Draft will expire on March 4, 2008.</p>  This Internet-Draft will expire on August 17, 2008.</p>
177    
178  <h3>Copyright Notice</h3>  <h3>Copyright Notice</h3>
179  <p>  <p>
180  Copyright &copy; The IETF Trust (2007).</p>  Copyright &copy; The IETF Trust (2008).</p>
181    
182  <h3>Abstract</h3>  <h3>Abstract</h3>
183    
# Line 354  Global commands<br /> Line 354  Global commands<br />
354  Current number of active voices<br />  Current number of active voices<br />
355  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a>&nbsp;
356  Maximum amount of active voices<br />  Maximum amount of active voices<br />
357  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET">6.6.3.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET TOTAL_STREAM_COUNT">6.6.3.</a>&nbsp;
358    Current number of active disk streams<br />
359    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET">6.6.4.</a>&nbsp;
360  Reset sampler<br />  Reset sampler<br />
361  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.4.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.5.</a>&nbsp;
362  General sampler informations<br />  General sampler informations<br />
363  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET VOLUME">6.6.5.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET VOLUME">6.6.6.</a>&nbsp;
364  Getting global volume attenuation<br />  Getting global volume attenuation<br />
365  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOLUME">6.6.6.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOLUME">6.6.7.</a>&nbsp;
366  Setting global volume attenuation<br />  Setting global volume attenuation<br />
367  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#MIDI Instrument Mapping">6.7.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#MIDI Instrument Mapping">6.7.</a>&nbsp;
368  MIDI Instrument Mapping<br />  MIDI Instrument Mapping<br />
369  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD MIDI_INSTRUMENT MAP">6.7.1.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a>&nbsp;
370  Create a new MIDI instrument map<br />  Create a new MIDI instrument map<br />
371  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a>&nbsp;
372  Delete one particular or all MIDI instrument maps<br />  Delete one particular or all MIDI instrument maps<br />
# Line 438  Formatting the instruments database<br / Line 440  Formatting the instruments database<br /
440  Editing Instruments<br />  Editing Instruments<br />
441  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#EDIT INSTRUMENT">6.9.1.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#EDIT INSTRUMENT">6.9.1.</a>&nbsp;
442  Opening an appropriate instrument editor application<br />  Opening an appropriate instrument editor application<br />
443    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#file_management">6.10.</a>&nbsp;
444    Managing Files<br />
445    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FILE INSTRUMENTS">6.10.1.</a>&nbsp;
446    Retrieving amount of instruments of a file<br />
447    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST FILE INSTRUMENTS">6.10.2.</a>&nbsp;
448    Retrieving all instruments of a file<br />
449    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FILE INSTRUMENT INFO">6.10.3.</a>&nbsp;
450    Retrieving informations about one instrument in a file<br />
451  <a href="#command_syntax">7.</a>&nbsp;  <a href="#command_syntax">7.</a>&nbsp;
452  Command Syntax<br />  Command Syntax<br />
453  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#character_set">7.1.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#character_set">7.1.</a>&nbsp;
# Line 454  Number of MIDI input devices changed<br Line 464  Number of MIDI input devices changed<br
464  MIDI input device's settings changed<br />  MIDI input device's settings changed<br />
465  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a>&nbsp;
466  Number of sampler channels changed<br />  Number of sampler channels changed<br />
467  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.6.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_MIDI">8.6.</a>&nbsp;
468    MIDI data on a sampler channel arrived<br />
469    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.7.</a>&nbsp;
470  Number of active voices changed<br />  Number of active voices changed<br />
471  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">8.7.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">8.8.</a>&nbsp;
472  Number of active disk streams changed<br />  Number of active disk streams changed<br />
473  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">8.8.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">8.9.</a>&nbsp;
474  Disk stream buffer fill state changed<br />  Disk stream buffer fill state changed<br />
475  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_INFO">8.9.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_INFO">8.10.</a>&nbsp;
476  Channel information changed<br />  Channel information changed<br />
477  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_COUNT">8.10.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_COUNT">8.11.</a>&nbsp;
478  Number of effect sends changed<br />  Number of effect sends changed<br />
479  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_INFO">8.11.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_INFO">8.12.</a>&nbsp;
480  Effect send information changed<br />  Effect send information changed<br />
481  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.13.</a>&nbsp;
482  Total number of active voices changed<br />  Total number of active voices changed<br />
483  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.13.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_STREAM_COUNT">8.14.</a>&nbsp;
484    Total number of active disk streams changed<br />
485    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.15.</a>&nbsp;
486  Number of MIDI instrument maps changed<br />  Number of MIDI instrument maps changed<br />
487  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.14.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.16.</a>&nbsp;
488  MIDI instrument map information changed<br />  MIDI instrument map information changed<br />
489  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.15.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.17.</a>&nbsp;
490  Number of MIDI instruments changed<br />  Number of MIDI instruments changed<br />
491  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.16.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.18.</a>&nbsp;
492  MIDI instrument information changed<br />  MIDI instrument information changed<br />
493  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.19.</a>&nbsp;
494  Global settings changed<br />  Global settings changed<br />
495  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.18.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.20.</a>&nbsp;
496  Number of database instrument directories changed<br />  Number of database instrument directories changed<br />
497  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.19.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.21.</a>&nbsp;
498  Database instrument directory information changed<br />  Database instrument directory information changed<br />
499  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.20.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.22.</a>&nbsp;
500  Number of database instruments changed<br />  Number of database instruments changed<br />
501  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.21.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.23.</a>&nbsp;
502  Database instrument information changed<br />  Database instrument information changed<br />
503  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.22.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.24.</a>&nbsp;
504  Database job status information changed<br />  Database job status information changed<br />
505  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.23.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.25.</a>&nbsp;
506  Miscellaneous and debugging events<br />  Miscellaneous and debugging events<br />
507  <a href="#anchor14">9.</a>&nbsp;  <a href="#anchor14">9.</a>&nbsp;
508  Security Considerations<br />  Security Considerations<br />
# Line 3449  Loading an instrument</h3> Line 3463  Loading an instrument</h3>
3463  </blockquote><p>  </blockquote><p>
3464                                            
3465  </p>  </p>
3466  <p>Example:  <p>Example (Unix):
3467  </p>  </p>
3468  <p>  <p>
3469                          </p>                          </p>
3470  <blockquote class="text">  <blockquote class="text">
3471    <p>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0
3472    </p>
3473    <p>S: OK
3474    </p>
3475    </blockquote><p>
3476                        
3477    </p>
3478    <p>Example (Windows):
3479    </p>
3480  <p>  <p>
3481                            </p>
3482    <blockquote class="text">
3483    <p>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0
3484    </p>
3485    <p>S: OK
3486  </p>  </p>
3487  </blockquote><p>  </blockquote><p>
3488                                            
# Line 3869  Getting information about an engine</h3> Line 3897  Getting information about an engine</h3>
3897                                          </p>                                          </p>
3898  <blockquote class="text">  <blockquote class="text">
3899  <p>arbitrary description text about the engine  <p>arbitrary description text about the engine
3900                                                (note that the character string may contain
3901                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
3902  </p>  </p>
3903  </blockquote>  </blockquote>
3904                                                                            
# Line 3988  Getting sampler channel information</h3> Line 4018  Getting sampler channel information</h3>
4018  <blockquote class="text">  <blockquote class="text">
4019  <p>the file name of the loaded instrument, "NONE" if  <p>the file name of the loaded instrument, "NONE" if
4020                                              there's no instrument yet loaded for this sampler                                              there's no instrument yet loaded for this sampler
4021                                              channel                                              channel (note: since LSCP 1.2 this path may contain
4022                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
4023  </p>  </p>
4024  </blockquote>  </blockquote>
4025                                                                            
# Line 4005  Getting sampler channel information</h3> Line 4036  Getting sampler channel information</h3>
4036                                          </p>                                          </p>
4037  <blockquote class="text">  <blockquote class="text">
4038  <p>the instrument name of the loaded instrument  <p>the instrument name of the loaded instrument
4039                                                (note: since LSCP 1.2 this character string may contain
4040                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
4041  </p>  </p>
4042  </blockquote>  </blockquote>
4043                                                                            
# Line 5080  Adding an effect send to a sampler chann Line 5113  Adding an effect send to a sampler chann
5113                      sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;                      sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
5114                      is a number between 0..127 defining the MIDI controller which can alter the                      is a number between 0..127 defining the MIDI controller which can alter the
5115                      effect send level and &lt;name&gt; is an optional argument defining a name                      effect send level and &lt;name&gt; is an optional argument defining a name
5116                      for the effect send entity. The name does not have to be unique.                      for the effect send entity. The name does not have to be unique, but MUST be
5117                        encapsulated into apostrophes and supports escape sequences as described in chapter
5118                        "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>".
5119  </p>  </p>
5120  <p>By default, that is as initial routing, the effect send's audio channels  <p>By default, that is as initial routing, the effect send's audio channels
5121                      are automatically routed to the last audio channels of the sampler channel's                      are automatically routed to the last audio channels of the sampler channel's
# Line 5349  Getting effect send information</h3> Line 5384  Getting effect send information</h3>
5384                                          </p>                                          </p>
5385  <blockquote class="text">  <blockquote class="text">
5386  <p>name of the effect send entity  <p>name of the effect send entity
5387                                                (note that this character string may contain
5388                                                 <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
5389  </p>  </p>
5390  </blockquote>  </blockquote>
5391                                                                            
# Line 5439  Changing effect send's name</h3> Line 5476  Changing effect send's name</h3>
5476                      as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>                      as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
5477                      or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and                      or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and
5478                      &lt;name&gt; is the new name of the effect send entity, which                      &lt;name&gt; is the new name of the effect send entity, which
5479                      does not have to be unique.                      does not have to be unique (name MUST be encapsulated into apostrophes
5480                        and supports escape sequences as described in chapter
5481                        "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
5482                        
5483  </p>  </p>
5484  <p>Possible Answers:  <p>Possible Answers:
5485  </p>  </p>
# Line 6040  Maximum amount of active voices</h3> Line 6080  Maximum amount of active voices</h3>
6080  </blockquote><p>  </blockquote><p>
6081                                            
6082  </p>  </p>
6083  <a name="RESET"></a><br /><hr />  <a name="GET TOTAL_STREAM_COUNT"></a><br /><hr />
6084  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6085  <a name="rfc.section.6.6.3"></a><h3>6.6.3.&nbsp;  <a name="rfc.section.6.6.3"></a><h3>6.6.3.&nbsp;
6086    Current number of active disk streams</h3>
6087    
6088    <p>The front-end can ask for the current number of active disk streams on
6089                        the sampler by sending the following command:
6090    </p>
6091    <p>
6092                            </p>
6093    <blockquote class="text">
6094    <p>GET TOTAL_STREAM_COUNT
6095    </p>
6096    </blockquote><p>
6097                        
6098    </p>
6099    <p>Possible Answers:
6100    </p>
6101    <p>
6102                            </p>
6103    <blockquote class="text">
6104    <p>LinuxSampler will answer by returning the number of all active
6105                                disk streams on the sampler.
6106    </p>
6107    </blockquote><p>
6108                        
6109    </p>
6110    <a name="RESET"></a><br /><hr />
6111    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6112    <a name="rfc.section.6.6.4"></a><h3>6.6.4.&nbsp;
6113  Reset sampler</h3>  Reset sampler</h3>
6114    
6115  <p>The front-end can reset the whole sampler by sending the following command:  <p>The front-end can reset the whole sampler by sending the following command:
# Line 6083  Reset sampler</h3> Line 6150  Reset sampler</h3>
6150  </p>  </p>
6151  <a name="GET SERVER INFO"></a><br /><hr />  <a name="GET SERVER INFO"></a><br /><hr />
6152  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6153  <a name="rfc.section.6.6.4"></a><h3>6.6.4.&nbsp;  <a name="rfc.section.6.6.5"></a><h3>6.6.5.&nbsp;
6154  General sampler informations</h3>  General sampler informations</h3>
6155    
6156  <p>The client can ask for general informations about the LinuxSampler  <p>The client can ask for general informations about the LinuxSampler
# Line 6116  General sampler informations</h3> Line 6183  General sampler informations</h3>
6183                                          </p>                                          </p>
6184  <blockquote class="text">  <blockquote class="text">
6185  <p>arbitrary textual description about the sampler  <p>arbitrary textual description about the sampler
6186                                                (note that the character string may contain
6187                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
6188  </p>  </p>
6189  </blockquote>  </blockquote>
6190                                                                            
# Line 6157  General sampler informations</h3> Line 6226  General sampler informations</h3>
6226  </p>  </p>
6227  <a name="GET VOLUME"></a><br /><hr />  <a name="GET VOLUME"></a><br /><hr />
6228  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6229  <a name="rfc.section.6.6.5"></a><h3>6.6.5.&nbsp;  <a name="rfc.section.6.6.6"></a><h3>6.6.6.&nbsp;
6230  Getting global volume attenuation</h3>  Getting global volume attenuation</h3>
6231    
6232  <p>The client can ask for the current global sampler-wide volume  <p>The client can ask for the current global sampler-wide volume
# Line 6190  Getting global volume attenuation</h3> Line 6259  Getting global volume attenuation</h3>
6259  </p>  </p>
6260  <a name="SET VOLUME"></a><br /><hr />  <a name="SET VOLUME"></a><br /><hr />
6261  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6262  <a name="rfc.section.6.6.6"></a><h3>6.6.6.&nbsp;  <a name="rfc.section.6.6.7"></a><h3>6.6.7.&nbsp;
6263  Setting global volume attenuation</h3>  Setting global volume attenuation</h3>
6264    
6265  <p>The client can alter the current global sampler-wide volume  <p>The client can alter the current global sampler-wide volume
# Line 6277  MIDI Instrument Mapping</h3> Line 6346  MIDI Instrument Mapping</h3>
6346                  cause the sampler to switch to the respective instrument as                  cause the sampler to switch to the respective instrument as
6347                  reflected by the current MIDI instrument map.                  reflected by the current MIDI instrument map.
6348  </p>  </p>
6349  <a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr />  <a name="ADD MIDI_INSTRUMENT_MAP"></a><br /><hr />
6350  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6351  <a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;  <a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;
6352  Create a new MIDI instrument map</h3>  Create a new MIDI instrument map</h3>
# Line 6295  Create a new MIDI instrument map</h3> Line 6364  Create a new MIDI instrument map</h3>
6364  </p>  </p>
6365  <p>Where &lt;name&gt; is an optional argument allowing to  <p>Where &lt;name&gt; is an optional argument allowing to
6366                      assign a custom name to the new map. MIDI instrument Map                      assign a custom name to the new map. MIDI instrument Map
6367                      names do not have to be unique.                      names do not have to be unique, but MUST be encapsulated
6368                        into apostrophes and support escape sequences as described
6369                        in chapter "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>".
6370                        
6371  </p>  </p>
6372  <p>Possible Answers:  <p>Possible Answers:
6373  </p>  </p>
# Line 6553  Getting MIDI instrument map information< Line 6625  Getting MIDI instrument map information<
6625  <blockquote class="text">  <blockquote class="text">
6626  <p>custom name of the given map,  <p>custom name of the given map,
6627                                              which does not have to be unique                                              which does not have to be unique
6628                                                (note that this character string may contain
6629                                                 <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
6630  </p>  </p>
6631  </blockquote>  </blockquote>
6632                                                                            
# Line 6608  Renaming a MIDI instrument map</h3> Line 6682  Renaming a MIDI instrument map</h3>
6682  </p>  </p>
6683  <p>Where &lt;map&gt; is the numerical ID of the map and  <p>Where &lt;map&gt; is the numerical ID of the map and
6684                      &lt;name&gt; the new custom name of the map, which does not                      &lt;name&gt; the new custom name of the map, which does not
6685                      have to be unique.                      have to be unique (name MUST be encapsulated into apostrophes
6686                        and supports escape sequences as described in chapter
6687                        "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
6688                        
6689  </p>  </p>
6690  <p>Possible Answers:  <p>Possible Answers:
6691  </p>  </p>
# Line 6773  Create or replace a MIDI instrument map Line 6850  Create or replace a MIDI instrument map
6850                      load modes of entries, the frontend should retrieve the actual                      load modes of entries, the frontend should retrieve the actual
6851                      mode by i.e. sending                      mode by i.e. sending
6852                      <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>                      <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>
6853                      command(s). Finally the OPTIONAL &lt;name&gt; argument allows to                      command(s). Finally the OPTIONAL &lt;name&gt; argument allows to set a custom name
6854                      set a custom name (encapsulated into apostrophes) for the mapping                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
6855                      entry, useful for frontends for displaying an appropriate name for                      "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") for the
6856                        mapping entry, useful for frontends for displaying an appropriate name for
6857                      mapped instruments (using                      mapped instruments (using
6858                      <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>).                      <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>).
6859                                            
# Line 7097  Get current settings of MIDI instrument Line 7175  Get current settings of MIDI instrument
7175                                      changed with the                                      changed with the
7176                                      <a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a>                                      <a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a>
7177                                      command and does not have to be unique.                                      command and does not have to be unique.
7178                                        (note that this character string may contain
7179                                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
7180  </p>  </p>
7181  </blockquote>  </blockquote>
7182                                                            
# Line 7113  Get current settings of MIDI instrument Line 7193  Get current settings of MIDI instrument
7193  <p>"INSTRUMENT_FILE" -  <p>"INSTRUMENT_FILE" -
7194                                  </p>                                  </p>
7195  <blockquote class="text">  <blockquote class="text">
7196  <p>File name of the instrument.  <p>File name of the instrument
7197                                        (note that this path may contain
7198                                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>).
7199  </p>  </p>
7200  </blockquote>  </blockquote>
7201                                                            
# Line 7131  Get current settings of MIDI instrument Line 7213  Get current settings of MIDI instrument
7213  <blockquote class="text">  <blockquote class="text">
7214  <p>Name of the loaded instrument as reflected by its file.  <p>Name of the loaded instrument as reflected by its file.
7215                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
7216                                      cannot be changed.                                      cannot be changed (note that this character string may contain
7217                                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>).
7218  </p>  </p>
7219  </blockquote>  </blockquote>
7220                                                            
# Line 8637  Changing the description of instrument</ Line 8720  Changing the description of instrument</
8720                                            
8721  </p>  </p>
8722  <p>Where &lt;instr&gt; is the absolute path name of the instrument and  <p>Where &lt;instr&gt; is the absolute path name of the instrument and
8723                      &lt;desc&gt; is the new description for the instrument                      &lt;desc&gt; is the new description for the instrument
8724                      (encapsulated into apostrophes, supporting escape sequences as described in chapter                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
8725                      "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").                      "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
8726  </p>  </p>
# Line 9046  Opening an appropriate instrument editor Line 9129  Opening an appropriate instrument editor
9129  <p>  <p>
9130                          </p>                          </p>
9131  <blockquote class="text">  <blockquote class="text">
9132  <p>EDIT INSTRUMENT &lt;sampler-channel&gt;  <p>EDIT CHANNEL INSTRUMENT &lt;sampler-channel&gt;
9133  </p>  </p>
9134  </blockquote><p>  </blockquote><p>
9135                                            
# Line 9113  Opening an appropriate instrument editor Line 9196  Opening an appropriate instrument editor
9196  <p>  <p>
9197                          </p>                          </p>
9198  <blockquote class="text">  <blockquote class="text">
9199  <p>C: "EDIT INSTRUMENT 0"  <p>C: "EDIT CHANNEL INSTRUMENT 0"
9200  </p>  </p>
9201  <p>S: "OK"  <p>S: "OK"
9202  </p>  </p>
9203  </blockquote><p>  </blockquote><p>
9204                                            
9205  </p>  </p>
9206    <a name="file_management"></a><br /><hr />
9207    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9208    <a name="rfc.section.6.10"></a><h3>6.10.&nbsp;
9209    Managing Files</h3>
9210    
9211    <p>You can query detailed informations about files located
9212                    at the same system where the sampler instance is running on.
9213                    Using this command set allows to retrieve file informations
9214                    even remotely from another machine.
9215    </p>
9216    <a name="GET FILE INSTRUMENTS"></a><br /><hr />
9217    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9218    <a name="rfc.section.6.10.1"></a><h3>6.10.1.&nbsp;
9219    Retrieving amount of instruments of a file</h3>
9220    
9221    <p>The front-end can retrieve the amount of instruments
9222                        within a given instrument file by sending the
9223                        following command:
9224    </p>
9225    <p>
9226                            </p>
9227    <blockquote class="text">
9228    <p>GET FILE INSTRUMENTS &lt;filename&gt;
9229    </p>
9230    </blockquote><p>
9231                        
9232    </p>
9233    <p>Where &lt;filename&gt; is the name of the instrument
9234                        file (encapsulated into apostrophes, supporting escape
9235                        sequences as described in chapter
9236                        "<a class='info' href='#character_set'>Character Set and Escape
9237                            Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
9238    </p>
9239    <p>The sampler will try to ask all sampler engines,
9240                        whether they support the given file and ask the first
9241                        engine with a positive answer for the amount of
9242                        instruments.
9243    </p>
9244    <p>Possible Answers:
9245    </p>
9246    <p>
9247                            </p>
9248    <blockquote class="text">
9249    <p>On success, the sampler will answer by
9250                                   returning the amount of instruments.
9251                                
9252    </p>
9253    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9254                                    </p>
9255    <blockquote class="text">
9256    <p>if the file could not be handled
9257    </p>
9258    </blockquote>
9259                                
9260    
9261    </blockquote><p>
9262                        
9263    </p>
9264    <p>Examples:
9265    </p>
9266    <p>
9267                            </p>
9268    <blockquote class="text">
9269    <p>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
9270    </p>
9271    <p>S: "10"
9272    </p>
9273    </blockquote><p>
9274                        
9275    </p>
9276    <a name="LIST FILE INSTRUMENTS"></a><br /><hr />
9277    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9278    <a name="rfc.section.6.10.2"></a><h3>6.10.2.&nbsp;
9279    Retrieving all instruments of a file</h3>
9280    
9281    <p>The front-end can retrieve a list of all instruments
9282                        within a given instrument file by sending the
9283                        following command:
9284    </p>
9285    <p>
9286                            </p>
9287    <blockquote class="text">
9288    <p>LIST FILE INSTRUMENTS &lt;filename&gt;
9289    </p>
9290    </blockquote><p>
9291                        
9292    </p>
9293    <p>Where &lt;filename&gt; is the name of the instrument
9294                        file (encapsulated into apostrophes, supporting escape
9295                        sequences as described in chapter
9296                        "<a class='info' href='#character_set'>Character Set and Escape
9297                            Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
9298    </p>
9299    <p>The sampler will try to ask all sampler engines,
9300                        whether they support the given file and ask the first
9301                        engine with a positive answer for a list of IDs for the
9302                        instruments in the given file.
9303    </p>
9304    <p>Possible Answers:
9305    </p>
9306    <p>
9307                            </p>
9308    <blockquote class="text">
9309    <p>On success, the sampler will answer by
9310                                   returning a comma separated list of
9311                                   instrument IDs.
9312                                
9313    </p>
9314    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9315                                    </p>
9316    <blockquote class="text">
9317    <p>if the file could not be handled
9318    </p>
9319    </blockquote>
9320                                
9321    
9322    </blockquote><p>
9323                        
9324    </p>
9325    <p>Examples:
9326    </p>
9327    <p>
9328                            </p>
9329    <blockquote class="text">
9330    <p>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
9331    </p>
9332    <p>S: "0,1,2,3,4,5,6,7,8,9"
9333    </p>
9334    </blockquote><p>
9335                        
9336    </p>
9337    <a name="GET FILE INSTRUMENT INFO"></a><br /><hr />
9338    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9339    <a name="rfc.section.6.10.3"></a><h3>6.10.3.&nbsp;
9340    Retrieving informations about one instrument in a file</h3>
9341    
9342    <p>The front-end can retrieve detailed informations
9343                        about a specific instrument within a given instrument
9344                        file by sending the following command:
9345    </p>
9346    <p>
9347                            </p>
9348    <blockquote class="text">
9349    <p>GET FILE INSTRUMENT INFO &lt;filename&gt;
9350                                &lt;instr-id&gt;
9351    </p>
9352    </blockquote><p>
9353                        
9354    </p>
9355    <p>Where &lt;filename&gt; is the name of the instrument
9356                        file (encapsulated into apostrophes, supporting escape
9357                        sequences as described in chapter
9358                        "<a class='info' href='#character_set'>Character Set and Escape
9359                            Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") and &lt;instr-id&gt; is the numeric
9360                        instrument ID as returned by the
9361                        <a class='info' href='#LIST FILE INSTRUMENTS'>"LIST FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving all instruments of a file</span><span>)</span></a> command.
9362    </p>
9363    <p>The sampler will try to ask all sampler engines,
9364                        whether they support the given file and ask the first
9365                        engine with a positive answer for informations about the
9366                        specific instrument in the given file.
9367    </p>
9368    <p>Possible Answers:
9369    </p>
9370    <p>
9371                            </p>
9372    <blockquote class="text">
9373    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
9374                                Each answer line begins with the settings category name
9375                                followed by a colon and then a space character &lt;SP&gt; and finally
9376                                the info character string to that setting category. At the
9377                                moment the following categories are defined:
9378    </p>
9379    <p>
9380                                    </p>
9381    <blockquote class="text">
9382    <p>NAME -
9383                                            </p>
9384    <blockquote class="text">
9385    <p>name of the instrument as
9386                                                stored in the instrument file
9387    </p>
9388    </blockquote>
9389                                        
9390    
9391    <p>FORMAT_FAMILY -
9392                                            </p>
9393    <blockquote class="text">
9394    <p>name of the sampler format
9395                                                of the given instrument
9396    </p>
9397    </blockquote>
9398                                        
9399    
9400    <p>FORMAT_VERSION -
9401                                            </p>
9402    <blockquote class="text">
9403    <p>version of the sampler format
9404                                                the instrumen is stored as
9405    </p>
9406    </blockquote>
9407                                        
9408    
9409    <p>PRODUCT -
9410                                            </p>
9411    <blockquote class="text">
9412    <p>official product name of the
9413                                                instrument as stored in the file
9414                                                
9415    </p>
9416    </blockquote>
9417                                        
9418    
9419    <p>ARTISTS -
9420                                            </p>
9421    <blockquote class="text">
9422    <p>artists / sample library
9423                                                vendor of the instrument
9424    </p>
9425    </blockquote>
9426                                        
9427    
9428    </blockquote>
9429                                
9430    
9431    </blockquote><p>
9432                        
9433    </p>
9434    <p>The mentioned fields above don't have to be in particular order.
9435    </p>
9436    <p>Example:
9437    </p>
9438    <p>
9439                            </p>
9440    <blockquote class="text">
9441    <p>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"
9442    </p>
9443    <p>S: "NAME: Lunatic Loops"
9444    </p>
9445    <p>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"
9446    </p>
9447    <p>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 3"
9448    </p>
9449    <p>&nbsp;&nbsp;&nbsp;"PRODUCT: The Backbone Bongo Beats"
9450    </p>
9451    <p>&nbsp;&nbsp;&nbsp;"ARTISTS: Jimmy the Fish"
9452    </p>
9453    <p>&nbsp;&nbsp;&nbsp;"."
9454    </p>
9455    </blockquote><p>
9456                        
9457    </p>
9458  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
9459  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9460  <a name="rfc.section.7"></a><h3>7.&nbsp;  <a name="rfc.section.7"></a><h3>7.&nbsp;
# Line 9304  Command Syntax</h3> Line 9639  Command Syntax</h3>
9639  <p>/ CHANNEL_COUNT  <p>/ CHANNEL_COUNT
9640                                    
9641  </p>  </p>
9642    <p>/ CHANNEL_MIDI
9643                    
9644    </p>
9645  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
9646                                    
9647  </p>  </p>
# Line 9352  Command Syntax</h3> Line 9690  Command Syntax</h3>
9690  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
9691                                    
9692  </p>  </p>
9693    <p>/ TOTAL_STREAM_COUNT
9694                    
9695    </p>
9696  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
9697                                    
9698  </p>  </p>
# Line 9379  Command Syntax</h3> Line 9720  Command Syntax</h3>
9720  <p>/ CHANNEL_COUNT  <p>/ CHANNEL_COUNT
9721                                    
9722  </p>  </p>
9723    <p>/ CHANNEL_MIDI
9724                    
9725    </p>
9726  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
9727                                    
9728  </p>  </p>
# Line 9427  Command Syntax</h3> Line 9771  Command Syntax</h3>
9771  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
9772                                    
9773  </p>  </p>
9774    <p>/ TOTAL_STREAM_COUNT
9775                    
9776    </p>
9777  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
9778                                    
9779  </p>  </p>
# Line 9562  Command Syntax</h3> Line 9909  Command Syntax</h3>
9909  <p>/ SERVER SP INFO  <p>/ SERVER SP INFO
9910                                    
9911  </p>  </p>
9912    <p>/ TOTAL_STREAM_COUNT
9913                    
9914    </p>
9915  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
9916                                    
9917  </p>  </p>
# Line 9613  Command Syntax</h3> Line 9963  Command Syntax</h3>
9963  <p>/ VOLUME  <p>/ VOLUME
9964                                    
9965  </p>  </p>
9966    <p>/ FILE SP INSTRUMENTS SP filename
9967                    
9968    </p>
9969    <p>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
9970                    
9971    </p>
9972  </blockquote><p>  </blockquote><p>
9973    
9974  </p>  </p>
# Line 9838  Command Syntax</h3> Line 10194  Command Syntax</h3>
10194  <p>edit_instruction =  <p>edit_instruction =
10195          </p>          </p>
10196  <blockquote class="text">  <blockquote class="text">
10197  <p>INSTRUMENT SP sampler_channel  <p>CHANNEL SP INSTRUMENT SP sampler_channel
10198                                    
10199  </p>  </p>
10200  </blockquote><p>  </blockquote><p>
# Line 9934  Command Syntax</h3> Line 10290  Command Syntax</h3>
10290  <p>/ DB_INSTRUMENTS SP db_path  <p>/ DB_INSTRUMENTS SP db_path
10291                                    
10292  </p>  </p>
10293    <p>/ FILE SP INSTRUMENTS SP filename
10294                    
10295    </p>
10296  </blockquote><p>  </blockquote><p>
10297    
10298  </p>  </p>
# Line 10135  Command Syntax</h3> Line 10494  Command Syntax</h3>
10494  <p>map_name =  <p>map_name =
10495          </p>          </p>
10496  <blockquote class="text">  <blockquote class="text">
10497  <p>stringval  <p>stringval_escaped
10498                                    
10499  </p>  </p>
10500  </blockquote><p>  </blockquote><p>
# Line 10144  Command Syntax</h3> Line 10503  Command Syntax</h3>
10503  <p>entry_name =  <p>entry_name =
10504          </p>          </p>
10505  <blockquote class="text">  <blockquote class="text">
10506  <p>stringval  <p>stringval_escaped
10507                                    
10508  </p>  </p>
10509  </blockquote><p>  </blockquote><p>
# Line 10153  Command Syntax</h3> Line 10512  Command Syntax</h3>
10512  <p>fx_send_name =  <p>fx_send_name =
10513          </p>          </p>
10514  <blockquote class="text">  <blockquote class="text">
10515  <p>stringval  <p>stringval_escaped
10516                                    
10517  </p>  </p>
10518  </blockquote><p>  </blockquote><p>
# Line 10204  Command Syntax</h3> Line 10563  Command Syntax</h3>
10563  <p>query_val =  <p>query_val =
10564          </p>          </p>
10565  <blockquote class="text">  <blockquote class="text">
10566  <p>textval_escaped  <p>text_escaped
10567                                    
10568  </p>  </p>
10569  <p>/ stringval_escaped  <p>/ stringval_escaped
# Line 10294  Character Set and Escape Sequences</h3> Line 10653  Character Set and Escape Sequences</h3>
10653                  MUST be escaped as well (that is as double backslash), whereas                  MUST be escaped as well (that is as double backslash), whereas
10654                  in the old versions a single backslash was sufficient.                  in the old versions a single backslash was sufficient.
10655  </p>  </p>
10656    <p>The following LSCP commands support escape sequences as part
10657                    of their filename / path based arguments and / or may contain
10658                    a filename / path with escape sequences in their response:
10659                    </p>
10660    <blockquote class="text">
10661    <p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a>
10662    </p>
10663    <p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
10664    </p>
10665    <p><a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a>
10666    </p>
10667    <p><a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>
10668    </p>
10669    <p><a class='info' href='#ADD DB_INSTRUMENT_DIRECTORY'>"ADD DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Creating a new instrument directory</span><span>)</span></a>
10670    </p>
10671    <p><a class='info' href='#ADD DB_INSTRUMENTS'>"ADD DB_INSTRUMENTS"<span> (</span><span class='info'>Adding instruments to the instruments database</span><span>)</span></a>
10672    </p>
10673    <p><a class='info' href='#REMOVE DB_INSTRUMENT_DIRECTORY'>"REMOVE DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Deleting an instrument directory</span><span>)</span></a>
10674    </p>
10675    <p><a class='info' href='#REMOVE DB_INSTRUMENT'>"REMOVE DB_INSTRUMENT"<span> (</span><span class='info'>Removing an instrument</span><span>)</span></a>
10676    </p>
10677    <p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORIES'>"GET DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Getting amount of instrument directories</span><span>)</span></a>
10678    </p>
10679    <p><a class='info' href='#LIST DB_INSTRUMENT_DIRECTORIES'>"LIST DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Listing all directories in specific directory</span><span>)</span></a>
10680    </p>
10681    <p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORY INFO'>"GET DB_INSTRUMENT_DIRECTORY INFO"<span> (</span><span class='info'>Getting instrument directory information</span><span>)</span></a>
10682    </p>
10683    <p><a class='info' href='#GET DB_INSTRUMENTS'>"GET DB_INSTRUMENTS"<span> (</span><span class='info'>Getting amount of instruments</span><span>)</span></a>
10684    </p>
10685    <p><a class='info' href='#LIST DB_INSTRUMENTS'>"LIST DB_INSTRUMENTS"<span> (</span><span class='info'>Listing all instruments in specific directory</span><span>)</span></a>
10686    </p>
10687    <p><a class='info' href='#GET DB_INSTRUMENT INFO'>"GET DB_INSTRUMENT INFO"<span> (</span><span class='info'>Getting instrument information</span><span>)</span></a>
10688    </p>
10689    <p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY NAME'>"SET DB_INSTRUMENT_DIRECTORY NAME"<span> (</span><span class='info'>Renaming an instrument directory</span><span>)</span></a>
10690    </p>
10691    <p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION'>"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"<span> (</span><span class='info'>Changing the description of directory</span><span>)</span></a>
10692    </p>
10693    <p><a class='info' href='#SET DB_INSTRUMENT NAME'>"SET DB_INSTRUMENT NAME"<span> (</span><span class='info'>Renaming an instrument</span><span>)</span></a>
10694    </p>
10695    <p><a class='info' href='#SET DB_INSTRUMENT DESCRIPTION'>"SET DB_INSTRUMENT DESCRIPTION"<span> (</span><span class='info'>Changing the description of instrument</span><span>)</span></a>
10696    </p>
10697    <p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a>
10698    </p>
10699    <p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a>
10700    </p>
10701    <p><a class='info' href='#MOVE DB_INSTRUMENT'>"MOVE DB_INSTRUMENT"<span> (</span><span class='info'>Moving an instrument</span><span>)</span></a>
10702    </p>
10703    <p><a class='info' href='#MOVE DB_INSTRUMENT_DIRECTORY'>"MOVE DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Moving an instrument directory</span><span>)</span></a>
10704    </p>
10705    <p><a class='info' href='#COPY DB_INSTRUMENT'>"COPY DB_INSTRUMENT"<span> (</span><span class='info'>Copying instruments</span><span>)</span></a>
10706    </p>
10707    <p><a class='info' href='#COPY DB_INSTRUMENT_DIRECTORY'>"COPY DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Copying instrument directories</span><span>)</span></a>
10708    </p>
10709    <p><a class='info' href='#GET FILE INSTRUMENTS'>"GET FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving amount of instruments of a file</span><span>)</span></a>
10710    </p>
10711    <p><a class='info' href='#LIST FILE INSTRUMENTS'>"LIST FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving all instruments of a file</span><span>)</span></a>
10712    </p>
10713    <p><a class='info' href='#GET FILE INSTRUMENT INFO'>"GET FILE INSTRUMENT INFO"<span> (</span><span class='info'>Retrieving informations about one instrument in a file</span><span>)</span></a>
10714    </p>
10715    </blockquote><p>
10716                    Note that the forward slash character ('/') has a special meaning in
10717                    filename / path based arguments: it acts as separator of the nodes in
10718                    the path, thus if a directory- or filename includes a forward slash
10719                    (not intended as path node separator), you MUST escape that slash
10720                    either with the respective hex escape sequence ("\x2f") or with the
10721                    respective octal escape sequence ("\057").
10722                    
10723    </p>
10724    <p>
10725                    Note for Windows: file path arguments in LSCP are expected
10726                    to use forward slashes as directory node separator similar
10727                    to Unix based operating systems. In contrast to Unix however
10728                    a Windows typical drive character is expected to be
10729                    prefixed to the path. That is an original Windows file path
10730                    like "D:\Sounds\My.gig" would become in LSCP:
10731                    "D:/Sounds/My.gig".
10732                    
10733    </p>
10734    <p>
10735                    The following LSCP commands even support escape sequences as
10736                    part of at least one of their text-based arguments (i.e. entity name,
10737                    description) and / or may contain escape sequences in at least one of
10738                    their text-based fields in their response:
10739                    </p>
10740    <blockquote class="text">
10741    <p><a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a>
10742    </p>
10743    <p><a class='info' href='#GET ENGINE INFO'>"GET ENGINE INFO"<span> (</span><span class='info'>Getting information about an engine</span><span>)</span></a>
10744    </p>
10745    <p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
10746    </p>
10747    <p><a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
10748    </p>
10749    <p><a class='info' href='#GET FX_SEND INFO'>"GET FX_SEND INFO"<span> (</span><span class='info'>Getting effect send information</span><span>)</span></a>
10750    </p>
10751    <p><a class='info' href='#SET FX_SEND NAME'>"SET FX_SEND NAME"<span> (</span><span class='info'>Changing effect send's name</span><span>)</span></a>
10752    </p>
10753    <p><a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>
10754    </p>
10755    <p><a class='info' href='#GET MIDI_INSTRUMENT_MAP INFO'>"GET MIDI_INSTRUMENT_MAP INFO"<span> (</span><span class='info'>Getting MIDI instrument map information</span><span>)</span></a>
10756    </p>
10757    <p><a class='info' href='#ADD MIDI_INSTRUMENT_MAP'>"ADD MIDI_INSTRUMENT_MAP"<span> (</span><span class='info'>Create a new MIDI instrument map</span><span>)</span></a>
10758    </p>
10759    <p><a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a>
10760    </p>
10761    <p><a class='info' href='#SET MIDI_INSTRUMENT_MAP NAME'>"SET MIDI_INSTRUMENT_MAP NAME"<span> (</span><span class='info'>Renaming a MIDI instrument map</span><span>)</span></a>
10762    </p>
10763    <p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORY INFO'>"GET DB_INSTRUMENT_DIRECTORY INFO"<span> (</span><span class='info'>Getting instrument directory information</span><span>)</span></a>
10764    </p>
10765    <p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY NAME'>"SET DB_INSTRUMENT_DIRECTORY NAME"<span> (</span><span class='info'>Renaming an instrument directory</span><span>)</span></a>
10766    </p>
10767    <p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION'>"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"<span> (</span><span class='info'>Changing the description of directory</span><span>)</span></a>
10768    </p>
10769    <p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a>
10770    </p>
10771    <p><a class='info' href='#GET DB_INSTRUMENT INFO'>"GET DB_INSTRUMENT INFO"<span> (</span><span class='info'>Getting instrument information</span><span>)</span></a>
10772    </p>
10773    <p><a class='info' href='#SET DB_INSTRUMENT NAME'>"SET DB_INSTRUMENT NAME"<span> (</span><span class='info'>Renaming an instrument</span><span>)</span></a>
10774    </p>
10775    <p><a class='info' href='#SET DB_INSTRUMENT DESCRIPTION'>"SET DB_INSTRUMENT DESCRIPTION"<span> (</span><span class='info'>Changing the description of instrument</span><span>)</span></a>
10776    </p>
10777    <p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a>
10778    </p>
10779    </blockquote><p>
10780                    Please note that these lists are manually maintained. If you
10781                    find a command that also supports escape sequences we forgot to
10782                    mention here, please report it!
10783                    
10784    </p>
10785  <a name="events"></a><br /><hr />  <a name="events"></a><br /><hr />
10786  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10787  <a name="rfc.section.8"></a><h3>8.&nbsp;  <a name="rfc.section.8"></a><h3>8.&nbsp;
# Line 10454  Number of sampler channels changed</h3> Line 10942  Number of sampler channels changed</h3>
10942  <p>where &lt;channels&gt; will be replaced by the new number  <p>where &lt;channels&gt; will be replaced by the new number
10943                  of sampler channels.                  of sampler channels.
10944  </p>  </p>
10945  <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE CHANNEL_MIDI"></a><br /><hr />
10946  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10947  <a name="rfc.section.8.6"></a><h3>8.6.&nbsp;  <a name="rfc.section.8.6"></a><h3>8.6.&nbsp;
10948    MIDI data on a sampler channel arrived</h3>
10949    
10950    <p>Client may want to be notified when MIDI data arrive on sampler channels on
10951                    back-end side, by issuing the following command:
10952    </p>
10953    <p>
10954                        </p>
10955    <blockquote class="text">
10956    <p>SUBSCRIBE CHANNEL_MIDI
10957    </p>
10958    </blockquote><p>
10959                    
10960    </p>
10961    <p>Server will start sending one of the the following notification messages:
10962    </p>
10963    <p>
10964                        </p>
10965    <blockquote class="text">
10966    <p>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_ON  &lt;note&gt; &lt;velocity&gt;"
10967    </p>
10968    <p>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"
10969    </p>
10970    </blockquote><p>
10971                    
10972    </p>
10973    <p>where &lt;channel-id&gt; will be replaced by the ID of the sampler channel where the MIDI
10974                    data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
10975                    0 .. 127, reflecting the analog meaning of the MIDI specification.
10976                    
10977    </p>
10978    <p>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
10979                    delivered by this mechanism! With other words: events could be lost at any time!
10980                    This restriction was made to keep the RT-safeness of the backend's MIDI and audio
10981                    thread unaffected by this feature.
10982    </p>
10983    <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />
10984    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10985    <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;
10986  Number of active voices changed</h3>  Number of active voices changed</h3>
10987    
10988  <p>Client may want to be notified when the number of voices on the  <p>Client may want to be notified when the number of voices on the
# Line 10486  Number of active voices changed</h3> Line 11012  Number of active voices changed</h3>
11012  </p>  </p>
11013  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />
11014  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11015  <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;  <a name="rfc.section.8.8"></a><h3>8.8.&nbsp;
11016  Number of active disk streams changed</h3>  Number of active disk streams changed</h3>
11017    
11018  <p>Client may want to be notified when the number of streams on the back-end  <p>Client may want to be notified when the number of streams on the back-end
# Line 10516  Number of active disk streams changed</h Line 11042  Number of active disk streams changed</h
11042  </p>  </p>
11043  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />
11044  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11045  <a name="rfc.section.8.8"></a><h3>8.8.&nbsp;  <a name="rfc.section.8.9"></a><h3>8.9.&nbsp;
11046  Disk stream buffer fill state changed</h3>  Disk stream buffer fill state changed</h3>
11047    
11048  <p>Client may want to be notified when the buffer fill state of a disk stream  <p>Client may want to be notified when the buffer fill state of a disk stream
# Line 10547  Disk stream buffer fill state changed</h Line 11073  Disk stream buffer fill state changed</h
11073  </p>  </p>
11074  <a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr />  <a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr />
11075  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11076  <a name="rfc.section.8.9"></a><h3>8.9.&nbsp;  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
11077  Channel information changed</h3>  Channel information changed</h3>
11078    
11079  <p>Client may want to be notified when changes were made to sampler channels on the  <p>Client may want to be notified when changes were made to sampler channels on the
# Line 10580  Channel information changed</h3> Line 11106  Channel information changed</h3>
11106  </p>  </p>
11107  <a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr />  <a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr />
11108  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11109  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;  <a name="rfc.section.8.11"></a><h3>8.11.&nbsp;
11110  Number of effect sends changed</h3>  Number of effect sends changed</h3>
11111    
11112  <p>Client may want to be notified when the number of effect sends on  <p>Client may want to be notified when the number of effect sends on
# Line 10610  Number of effect sends changed</h3> Line 11136  Number of effect sends changed</h3>
11136  </p>  </p>
11137  <a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr />  <a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr />
11138  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11139  <a name="rfc.section.8.11"></a><h3>8.11.&nbsp;  <a name="rfc.section.8.12"></a><h3>8.12.&nbsp;
11140  Effect send information changed</h3>  Effect send information changed</h3>
11141    
11142  <p>Client may want to be notified when changes were made to effect sends on a  <p>Client may want to be notified when changes were made to effect sends on a
# Line 10640  Effect send information changed</h3> Line 11166  Effect send information changed</h3>
11166  </p>  </p>
11167  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />
11168  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11169  <a name="rfc.section.8.12"></a><h3>8.12.&nbsp;  <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;
11170  Total number of active voices changed</h3>  Total number of active voices changed</h3>
11171    
11172  <p>Client may want to be notified when the total number of voices on the  <p>Client may want to be notified when the total number of voices on the
# Line 10667  Total number of active voices changed</h Line 11193  Total number of active voices changed</h
11193  <p>where &lt;voices&gt; will be replaced by the new number of  <p>where &lt;voices&gt; will be replaced by the new number of
11194                  all currently active voices.                  all currently active voices.
11195  </p>  </p>
11196    <a name="SUBSCRIBE TOTAL_STREAM_COUNT"></a><br /><hr />
11197    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11198    <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;
11199    Total number of active disk streams changed</h3>
11200    
11201    <p>Client may want to be notified when the total number of disk streams on the
11202                    back-end changes by issuing the following command:
11203    </p>
11204    <p>
11205                        </p>
11206    <blockquote class="text">
11207    <p>SUBSCRIBE TOTAL_STREAM_COUNT
11208    </p>
11209    </blockquote><p>
11210                    
11211    </p>
11212    <p>Server will start sending the following notification messages:
11213    </p>
11214    <p>
11215                        </p>
11216    <blockquote class="text">
11217    <p>"NOTIFY:TOTAL_STREAM_COUNT:&lt;streams&gt;"
11218    </p>
11219    </blockquote><p>
11220                    
11221    </p>
11222    <p>where &lt;streams&gt; will be replaced by the new number of
11223                    all currently active disk streams.
11224    </p>
11225  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr />  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr />
11226  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11227  <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;  <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;
11228  Number of MIDI instrument maps changed</h3>  Number of MIDI instrument maps changed</h3>
11229    
11230  <p>Client may want to be notified when the number of MIDI instrument maps on the  <p>Client may want to be notified when the number of MIDI instrument maps on the
# Line 10698  Number of MIDI instrument maps changed</ Line 11253  Number of MIDI instrument maps changed</
11253  </p>  </p>
11254  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr />  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr />
11255  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11256  <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;  <a name="rfc.section.8.16"></a><h3>8.16.&nbsp;
11257  MIDI instrument map information changed</h3>  MIDI instrument map information changed</h3>
11258    
11259  <p>Client may want to be notified when changes were made to MIDI instrument maps on the  <p>Client may want to be notified when changes were made to MIDI instrument maps on the
# Line 10731  MIDI instrument map information changed< Line 11286  MIDI instrument map information changed<
11286  </p>  </p>
11287  <a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr />  <a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr />
11288  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11289  <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;  <a name="rfc.section.8.17"></a><h3>8.17.&nbsp;
11290  Number of MIDI instruments changed</h3>  Number of MIDI instruments changed</h3>
11291    
11292  <p>Client may want to be notified when the number of MIDI instrument maps on the  <p>Client may want to be notified when the number of MIDI instrument maps on the
# Line 10761  Number of MIDI instruments changed</h3> Line 11316  Number of MIDI instruments changed</h3>
11316  </p>  </p>
11317  <a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr />  <a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr />
11318  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11319  <a name="rfc.section.8.16"></a><h3>8.16.&nbsp;  <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;
11320  MIDI instrument information changed</h3>  MIDI instrument information changed</h3>
11321    
11322  <p>Client may want to be notified when changes were made to MIDI instruments on the  <p>Client may want to be notified when changes were made to MIDI instruments on the
# Line 10795  MIDI instrument information changed</h3> Line 11350  MIDI instrument information changed</h3>
11350  </p>  </p>
11351  <a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr />  <a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr />
11352  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11353  <a name="rfc.section.8.17"></a><h3>8.17.&nbsp;  <a name="rfc.section.8.19"></a><h3>8.19.&nbsp;
11354  Global settings changed</h3>  Global settings changed</h3>
11355    
11356  <p>Client may want to be notified when changes to the global settings  <p>Client may want to be notified when changes to the global settings
# Line 10824  Global settings changed</h3> Line 11379  Global settings changed</h3>
11379  </p>  </p>
11380  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />
11381  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11382  <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;  <a name="rfc.section.8.20"></a><h3>8.20.&nbsp;
11383  Number of database instrument directories changed</h3>  Number of database instrument directories changed</h3>
11384    
11385  <p>Client may want to be notified when the number of instrument  <p>Client may want to be notified when the number of instrument
# Line 10858  Number of database instrument directorie Line 11413  Number of database instrument directorie
11413  </p>  </p>
11414  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr />
11415  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11416  <a name="rfc.section.8.19"></a><h3>8.19.&nbsp;  <a name="rfc.section.8.21"></a><h3>8.21.&nbsp;
11417  Database instrument directory information changed</h3>  Database instrument directory information changed</h3>
11418    
11419  <p>Client may want to be notified when changes were made to directories  <p>Client may want to be notified when changes were made to directories
# Line 10903  Database instrument directory informatio Line 11458  Database instrument directory informatio
11458  </p>  </p>
11459  <a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr />
11460  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11461  <a name="rfc.section.8.20"></a><h3>8.20.&nbsp;  <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;
11462  Number of database instruments changed</h3>  Number of database instruments changed</h3>
11463    
11464  <p>Client may want to be notified when the number of instruments  <p>Client may want to be notified when the number of instruments
# Line 10937  Number of database instruments changed</ Line 11492  Number of database instruments changed</
11492  </p>  </p>
11493  <a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr />
11494  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11495  <a name="rfc.section.8.21"></a><h3>8.21.&nbsp;  <a name="rfc.section.8.23"></a><h3>8.23.&nbsp;
11496  Database instrument information changed</h3>  Database instrument information changed</h3>
11497    
11498  <p>Client may want to be notified when changes were made to instruments  <p>Client may want to be notified when changes were made to instruments
# Line 10982  Database instrument information changed< Line 11537  Database instrument information changed<
11537  </p>  </p>
11538  <a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr />
11539  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11540  <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;  <a name="rfc.section.8.24"></a><h3>8.24.&nbsp;
11541  Database job status information changed</h3>  Database job status information changed</h3>
11542    
11543  <p>Client may want to be notified when the status of particular database  <p>Client may want to be notified when the status of particular database
# Line 11015  Database job status information changed< Line 11570  Database job status information changed<
11570  </p>  </p>
11571  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
11572  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11573  <a name="rfc.section.8.23"></a><h3>8.23.&nbsp;  <a name="rfc.section.8.25"></a><h3>8.25.&nbsp;
11574  Miscellaneous and debugging events</h3>  Miscellaneous and debugging events</h3>
11575    
11576  <p>Client may want to be notified of miscellaneous and debugging events occurring at  <p>Client may want to be notified of miscellaneous and debugging events occurring at
# Line 11112  Schoenebeck</td></tr> Line 11667  Schoenebeck</td></tr>
11667  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11668  <h3>Full Copyright Statement</h3>  <h3>Full Copyright Statement</h3>
11669  <p class='copyright'>  <p class='copyright'>
11670  Copyright &copy; The IETF Trust (2007).</p>  Copyright &copy; The IETF Trust (2008).</p>
11671  <p class='copyright'>  <p class='copyright'>
11672  This document is subject to the rights,  This document is subject to the rights,
11673  licenses and restrictions contained in BCP&nbsp;78,  licenses and restrictions contained in BCP&nbsp;78,
Legend:
Removed from v.1363  
changed lines
  Added in v.1685
  ViewVC Help
Powered by ViewVC