/[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 1201 by iliev, Thu May 24 14:22:39 2007 UTC revision 1685 by schoenebeck, Thu Feb 14 14:41:08 2008 UTC
# 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: November 25, 2007</td><td class="header">May 24, 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<br />LSCP 1.2</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 November 25, 2007.</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 432  Changing the description of instrument<b Line 434  Changing the description of instrument<b
434  Finding instruments<br />  Finding instruments<br />
435  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENTS_JOB INFO">6.8.21.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENTS_JOB INFO">6.8.21.</a>&nbsp;
436  Getting job status information<br />  Getting job status information<br />
437    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a>&nbsp;
438    Formatting the instruments database<br />
439    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#editing_instruments">6.9.</a>&nbsp;
440    Editing Instruments<br />
441    &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 />
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;
454    Character Set and Escape Sequences<br />
455  <a href="#events">8.</a>&nbsp;  <a href="#events">8.</a>&nbsp;
456  Events<br />  Events<br />
457  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a>&nbsp;
# Line 446  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 512  Requirements notation</h3> Line 534  Requirements notation</h3>
534              (front-end) and server (LinuxSampler) respectively. Lines in              (front-end) and server (LinuxSampler) respectively. Lines in
535              examples must be interpreted as every line being CRLF              examples must be interpreted as every line being CRLF
536              terminated (carriage return character followed by line feed              terminated (carriage return character followed by line feed
537              character as defined in the ASCII standard), thus the following              character as defined in the ASCII standard <a class='info' href='#RFC20'>[RFC20]<span> (</span><span class='info'>UCLA, &ldquo;ASCII format for Network Interchange,&rdquo; 1969.</span><span>)</span></a>),
538              example:              thus the following example:
539  </p>  </p>
540  <p>  <p>
541                  </p>                  </p>
# Line 3299  Changing settings of MIDI input ports</h Line 3321  Changing settings of MIDI input ports</h
3321                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
3322                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
3323                      the parameter to change and &lt;value&gt; by the new value for this                      the parameter to change and &lt;value&gt; by the new value for this
3324                      parameter.                      parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes)
3325                        for specifying no value for parameters allowing a list of values.
3326  </p>  </p>
3327  <p>Possible Answers:  <p>Possible Answers:
3328  </p>  </p>
# Line 3340  Changing settings of MIDI input ports</h Line 3363  Changing settings of MIDI input ports</h
3363  <p>  <p>
3364                          </p>                          </p>
3365  <blockquote class="text">  <blockquote class="text">
3366    <p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"
3367    </p>
3368    <p>S: "OK"
3369    </p>
3370    </blockquote><p>
3371                        
3372    </p>
3373  <p>  <p>
3374                            </p>
3375    <blockquote class="text">
3376    <p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"
3377    </p>
3378    <p>S: "OK"
3379  </p>  </p>
3380  </blockquote><p>  </blockquote><p>
3381                                            
# Line 3375  Loading an instrument</h3> Line 3410  Loading an instrument</h3>
3410                      number of the sampler channel the instrument should be assigned to.                      number of the sampler channel the instrument should be assigned to.
3411                      Each sampler channel can only have one instrument.                      Each sampler channel can only have one instrument.
3412  </p>  </p>
3413    <p>Notice: since LSCP 1.2 the &lt;filename&gt; argument supports
3414                        escape characters for special characters (see chapter
3415                        "<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>"
3416                        for details) and accordingly backslash characters in the filename
3417                        MUST now be escaped as well!
3418    </p>
3419  <p>The difference between regular and NON_MODAL versions of the command  <p>The difference between regular and NON_MODAL versions of the command
3420                      is that the regular command returns OK only after the instrument has been                      is that the regular command returns OK only after the instrument has been
3421                      fully loaded and the channel is ready to be used while NON_MODAL version                      fully loaded and the channel is ready to be used while NON_MODAL version
# Line 3422  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 3842  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 3961  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 3978  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 5053  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 5322  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 5412  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 6013  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 6056  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 6089  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 6130  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 6163  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 6250  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 6268  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 6526  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 6581  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 6647  Create or replace a MIDI instrument map Line 6751  Create or replace a MIDI instrument map
6751                      index, &lt;engine_name&gt; a sampler engine name as returned by                      index, &lt;engine_name&gt; a sampler engine name as returned by
6752                      the <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a>                      the <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a>
6753                      command (not encapsulated into apostrophes), &lt;filename&gt; the name                      command (not encapsulated into apostrophes), &lt;filename&gt; the name
6754                      of the instrument's file to be deployed (encapsulated into apostrophes),                      of the instrument's file to be deployed (encapsulated into apostrophes,
6755                        supporting escape sequences as described in chapter
6756                        "<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>"),
6757                      &lt;instrument_index&gt; the index (integer value) of the instrument                      &lt;instrument_index&gt; the index (integer value) of the instrument
6758                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
6759                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
# Line 6744  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 7068  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 7084  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 7102  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 7237  Managing Instruments Database</h3> Line 7349  Managing Instruments Database</h3>
7349  <p>The following commands describe how to use and manage  <p>The following commands describe how to use and manage
7350                  the instruments database.                  the instruments database.
7351  </p>  </p>
7352    <p>Notice:
7353    </p>
7354    <p>
7355                            </p>
7356    <blockquote class="text">
7357    <p>All command arguments representing a path or
7358                                instrument/directory name support escape sequences as described in chapter
7359                                "<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>".
7360                                
7361    </p>
7362    <p>All occurrences of a forward slash in instrument and directory
7363                                   names are escaped with its hex (\x2f) or octal (\057) escape sequence.
7364                                
7365    </p>
7366    </blockquote><p>
7367                        
7368    </p>
7369  <a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr />  <a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7370  <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>
7371  <a name="rfc.section.6.8.1"></a><h3>6.8.1.&nbsp;  <a name="rfc.section.6.8.1"></a><h3>6.8.1.&nbsp;
# Line 7502  Getting instrument directory information Line 7631  Getting instrument directory information
7631  <p>DESCRIPTION -  <p>DESCRIPTION -
7632                                          </p>                                          </p>
7633  <blockquote class="text">  <blockquote class="text">
7634  <p>A brief description of the directory content  <p>A brief description of the directory content.
7635                                                Note that the character string may contain
7636                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
7637  </p>  </p>
7638  </blockquote>  </blockquote>
7639                                                                            
# Line 7747  Changing the description of directory</h Line 7878  Changing the description of directory</h
7878                                            
7879  </p>  </p>
7880  <p>Where &lt;dir&gt; is the absolute path name of the directory and  <p>Where &lt;dir&gt; is the absolute path name of the directory and
7881                      &lt;desc&gt; is the new description for the directory.                      &lt;desc&gt; is the new description for the directory
7882                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
7883                        "<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>").
7884  </p>  </p>
7885  <p>Possible Answers:  <p>Possible Answers:
7886  </p>  </p>
# Line 7814  Finding directories</h3> Line 7947  Finding directories</h3>
7947                            </p>                            </p>
7948  <blockquote class="text">  <blockquote class="text">
7949  <p>Restricts the search to directories, which names  <p>Restricts the search to directories, which names
7950                                satisfy the supplied search string.                                satisfy the supplied search string (encapsulated into apostrophes,
7951                                  supporting escape sequences as described in chapter
7952                                  "<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>").
7953  </p>  </p>
7954  </blockquote><p>  </blockquote><p>
7955                                                
# Line 7857  Finding directories</h3> Line 7992  Finding directories</h3>
7992                            </p>                            </p>
7993  <blockquote class="text">  <blockquote class="text">
7994  <p>Restricts the search to directories with description  <p>Restricts the search to directories with description
7995                                that satisfies the supplied search string.                                that satisfies the supplied search string
7996                                  (encapsulated into apostrophes, supporting escape
7997                                  sequences as described in chapter
7998                                  "<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>").
7999  </p>  </p>
8000  </blockquote><p>  </blockquote><p>
8001                                                
# Line 8238  Getting instrument information</h3> Line 8376  Getting instrument information</h3>
8376                                          </p>                                          </p>
8377  <blockquote class="text">  <blockquote class="text">
8378  <p>File name of the instrument.  <p>File name of the instrument.
8379                                                Note that the character string may contain
8380                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8381  </p>  </p>
8382  </blockquote>  </blockquote>
8383                                                                            
# Line 8297  Getting instrument information</h3> Line 8437  Getting instrument information</h3>
8437  <p>DESCRIPTION -  <p>DESCRIPTION -
8438                                          </p>                                          </p>
8439  <blockquote class="text">  <blockquote class="text">
8440  <p>A brief description of the instrument  <p>A brief description of the instrument.
8441                                                Note that the character string may contain
8442                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8443  </p>  </p>
8444  </blockquote>  </blockquote>
8445                                                                            
# Line 8314  Getting instrument information</h3> Line 8456  Getting instrument information</h3>
8456  <p>PRODUCT -  <p>PRODUCT -
8457                                          </p>                                          </p>
8458  <blockquote class="text">  <blockquote class="text">
8459  <p>The product title of the instrument  <p>The product title of the instrument.
8460                                                Note that the character string may contain
8461                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8462  </p>  </p>
8463  </blockquote>  </blockquote>
8464                                                                            
# Line 8322  Getting instrument information</h3> Line 8466  Getting instrument information</h3>
8466  <p>ARTISTS -  <p>ARTISTS -
8467                                          </p>                                          </p>
8468  <blockquote class="text">  <blockquote class="text">
8469  <p>Lists the artist names  <p>Lists the artist names.
8470                                                Note that the character string may contain
8471                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8472  </p>  </p>
8473  </blockquote>  </blockquote>
8474                                                                            
# Line 8332  Getting instrument information</h3> Line 8478  Getting instrument information</h3>
8478  <blockquote class="text">  <blockquote class="text">
8479  <p>Provides a list of keywords that refer to the instrument.  <p>Provides a list of keywords that refer to the instrument.
8480                                              Keywords are separated with semicolon and blank.                                              Keywords are separated with semicolon and blank.
8481                                                Note that the character string may contain
8482                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8483  </p>  </p>
8484  </blockquote>  </blockquote>
8485                                                                            
# Line 8572  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
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>").
8726  </p>  </p>
8727  <p>Possible Answers:  <p>Possible Answers:
8728  </p>  </p>
# Line 8639  Finding instruments</h3> Line 8789  Finding instruments</h3>
8789                            </p>                            </p>
8790  <blockquote class="text">  <blockquote class="text">
8791  <p>Restricts the search to instruments, which names  <p>Restricts the search to instruments, which names
8792                                satisfy the supplied search string.                                satisfy the supplied search string (encapsulated into apostrophes,
8793                                  supporting escape sequences as described in chapter
8794                                  "<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>").
8795  </p>  </p>
8796  </blockquote><p>  </blockquote><p>
8797                                                
# Line 8649  Finding instruments</h3> Line 8801  Finding instruments</h3>
8801  <p>SIZE=[&lt;min&gt;]..[&lt;max&gt;]  <p>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
8802                            </p>                            </p>
8803  <blockquote class="text">  <blockquote class="text">
8804  <p>Restricts the search to instruments, which  <p>Restricts the search to instruments, which
8805                                size is in the specified range. If &lt;min&gt; is omitted,                                size is in the specified range. If &lt;min&gt; is omitted,
8806                                the search results are restricted to instruments with size less then                                the search results are restricted to instruments with size less then
8807                                or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the                                or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
# Line 8697  Finding instruments</h3> Line 8849  Finding instruments</h3>
8849                            </p>                            </p>
8850  <blockquote class="text">  <blockquote class="text">
8851  <p>Restricts the search to instruments with description  <p>Restricts the search to instruments with description
8852                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
8853                                  supporting escape sequences as described in chapter
8854                                  "<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>").
8855  </p>  </p>
8856  </blockquote><p>  </blockquote><p>
8857                                                
# Line 8708  Finding instruments</h3> Line 8862  Finding instruments</h3>
8862                            </p>                            </p>
8863  <blockquote class="text">  <blockquote class="text">
8864  <p>Restricts the search to instruments with product info  <p>Restricts the search to instruments with product info
8865                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
8866                                  supporting escape sequences as described in chapter
8867                                  "<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>").
8868  </p>  </p>
8869  </blockquote><p>  </blockquote><p>
8870                                                
# Line 8719  Finding instruments</h3> Line 8875  Finding instruments</h3>
8875                            </p>                            </p>
8876  <blockquote class="text">  <blockquote class="text">
8877  <p>Restricts the search to instruments with artists info  <p>Restricts the search to instruments with artists info
8878                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
8879                                  supporting escape sequences as described in chapter
8880                                  "<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>").
8881  </p>  </p>
8882  </blockquote><p>  </blockquote><p>
8883                                                
# Line 8730  Finding instruments</h3> Line 8888  Finding instruments</h3>
8888                            </p>                            </p>
8889  <blockquote class="text">  <blockquote class="text">
8890  <p>Restricts the search to instruments with keyword list  <p>Restricts the search to instruments with keyword list
8891                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
8892                                  supporting escape sequences as described in chapter
8893                                  "<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>").
8894  </p>  </p>
8895  </blockquote><p>  </blockquote><p>
8896                                                
# Line 8740  Finding instruments</h3> Line 8900  Finding instruments</h3>
8900  <p>IS_DRUM=true | false  <p>IS_DRUM=true | false
8901                            </p>                            </p>
8902  <blockquote class="text">  <blockquote class="text">
8903  <p>Either true or false. Restricts the search to  <p>Either true or false. Restricts the search to
8904                                drum kits or chromatic instruments.                                drum kits or chromatic instruments.
8905  </p>  </p>
8906  </blockquote><p>  </blockquote><p>
# Line 8900  Getting job status information</h3> Line 9060  Getting job status information</h3>
9060  </blockquote><p>  </blockquote><p>
9061                                            
9062  </p>  </p>
9063    <a name="FORMAT INSTRUMENTS_DB"></a><br /><hr />
9064    <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>
9065    <a name="rfc.section.6.8.22"></a><h3>6.8.22.&nbsp;
9066    Formatting the instruments database</h3>
9067    
9068    <p>The front-end can remove all instruments and directories and re-create
9069                        the instruments database structure (e.g., in case of a database corruption)
9070                        by sending the following command:
9071    </p>
9072    <p>
9073                            </p>
9074    <blockquote class="text">
9075    <p>FORMAT INSTRUMENTS_DB
9076    </p>
9077    </blockquote><p>
9078                        
9079    </p>
9080    <p>Possible Answers:
9081    </p>
9082    <p>
9083                            </p>
9084    <blockquote class="text">
9085    <p>"OK" -
9086                                    </p>
9087    <blockquote class="text">
9088    <p>on success
9089    </p>
9090    </blockquote>
9091                                
9092    
9093    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9094                                    </p>
9095    <blockquote class="text">
9096    <p>If the formatting of the instruments database
9097                                        failed.
9098    </p>
9099    </blockquote>
9100                                
9101    
9102    </blockquote><p>
9103                        
9104    </p>
9105    <a name="editing_instruments"></a><br /><hr />
9106    <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>
9107    <a name="rfc.section.6.9"></a><h3>6.9.&nbsp;
9108    Editing Instruments</h3>
9109    
9110    <p>The sampler allows to edit instruments while playing with the
9111                    sampler by spawning an external (3rd party) instrument editor
9112                    application for a given instrument. The 3rd party instrument
9113                    editor applications have to place a respective plugin DLL file
9114                    into the sampler's plugins directory. The sampler will
9115                    automatically try to load all plugin DLLs in that directory on
9116                    startup and only on startup!
9117    </p>
9118    <p>At the moment there is only one command for this feature set,
9119                    but this will most probably change in future.
9120    </p>
9121    <a name="EDIT INSTRUMENT"></a><br /><hr />
9122    <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>
9123    <a name="rfc.section.6.9.1"></a><h3>6.9.1.&nbsp;
9124    Opening an appropriate instrument editor application</h3>
9125    
9126    <p>The front-end can request to open an appropriate instrument
9127                        editor application by sending the following command:
9128    </p>
9129    <p>
9130                            </p>
9131    <blockquote class="text">
9132    <p>EDIT CHANNEL INSTRUMENT &lt;sampler-channel&gt;
9133    </p>
9134    </blockquote><p>
9135                        
9136    </p>
9137    <p>Where &lt;sampler-channel&gt; should be replaced by the
9138                        number of the sampler channel as given by the
9139                        <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
9140                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a>
9141                        command.
9142    </p>
9143    <p>The sampler will try to ask all registered instrument
9144                        editors (or to be more specific: their sampler plugins)
9145                        whether they are capable to handle the instrument on the
9146                        given sampler channel. The sampler will simply use the first
9147                        instrument editor application which replied with a positive
9148                        answer and spawn that instrument editor application within
9149                        the sampler's process and provide that application access
9150                        to the instrument's data structures, so both applications
9151                        can share and access the same instruments data at the same
9152                        time, thus allowing to immediately hear changes with the
9153                        sampler made by the instrument editor.
9154    </p>
9155    <p>Note: consequently instrument editors are always spawned
9156                        locally on the same machine where the sampler is running
9157                        on!
9158    </p>
9159    <p>Possible Answers:
9160    </p>
9161    <p>
9162                            </p>
9163    <blockquote class="text">
9164    <p>"OK" -
9165                                    </p>
9166    <blockquote class="text">
9167    <p>when an appropriate instrument editor was
9168                                        launched
9169    </p>
9170    </blockquote>
9171                                
9172    
9173    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
9174                                    </p>
9175    <blockquote class="text">
9176    <p>when an appropriate instrument editor was
9177                                        launched, but there are noteworthy issues
9178    </p>
9179    </blockquote>
9180                                
9181    
9182    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9183                                    </p>
9184    <blockquote class="text">
9185    <p>when an appropriate instrument editor
9186                                        could not be launched
9187    </p>
9188    </blockquote>
9189                                
9190    
9191    </blockquote><p>
9192                        
9193    </p>
9194    <p>Examples:
9195    </p>
9196    <p>
9197                            </p>
9198    <blockquote class="text">
9199    <p>C: "EDIT CHANNEL INSTRUMENT 0"
9200    </p>
9201    <p>S: "OK"
9202    </p>
9203    </blockquote><p>
9204                        
9205    </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 9015  Command Syntax</h3> Line 9570  Command Syntax</h3>
9570  <p>/ COPY SP copy_instruction  <p>/ COPY SP copy_instruction
9571                                    
9572  </p>  </p>
9573    <p>/ EDIT SP edit_instruction
9574                    
9575    </p>
9576    <p>/ FORMAT SP format_instruction
9577                    
9578    </p>
9579  <p>/ RESET  <p>/ RESET
9580                                    
9581  </p>  </p>
# Line 9030  Command Syntax</h3> Line 9591  Command Syntax</h3>
9591  <p>CHANNEL  <p>CHANNEL
9592                                    
9593  </p>  </p>
9594  <p>/ DB_INSTRUMENT_DIRECTORY SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP db_path
9595                                    
9596  </p>  </p>
9597  <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
9598                                    
9599  </p>  </p>
9600  <p>/ DB_INSTRUMENTS SP scan_mode SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
9601                                    
9602  </p>  </p>
9603  <p>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
9604                                    
9605  </p>  </p>
9606  <p>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP instrument_index  <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index
9607                                    
9608  </p>  </p>
9609  <p>/ DB_INSTRUMENTS SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP db_path SP filename
9610                                    
9611  </p>  </p>
9612  <p>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index  <p>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index
9613                                    
9614  </p>  </p>
9615  <p>/ MIDI_INSTRUMENT_MAP  <p>/ MIDI_INSTRUMENT_MAP
# Line 9078  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 9126  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 9153  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 9201  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 9249  Command Syntax</h3> Line 9822  Command Syntax</h3>
9822  <p>/ MIDI_INSTRUMENT_MAP SP ALL  <p>/ MIDI_INSTRUMENT_MAP SP ALL
9823                                    
9824  </p>  </p>
9825  <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
9826                                    
9827  </p>  </p>
9828  <p>/ DB_INSTRUMENT_DIRECTORY SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP db_path
9829                                    
9830  </p>  </p>
9831  <p>/ DB_INSTRUMENT SP pathname  <p>/ DB_INSTRUMENT SP db_path
9832                                    
9833  </p>  </p>
9834  </blockquote><p>  </blockquote><p>
# Line 9336  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 9363  Command Syntax</h3> Line 9939  Command Syntax</h3>
9939  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
9940                                    
9941  </p>  </p>
9942  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
9943                                    
9944  </p>  </p>
9945  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path
9946                                    
9947  </p>  </p>
9948  <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
9949                                    
9950  </p>  </p>
9951  <p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
9952                                    
9953  </p>  </p>
9954  <p>/ DB_INSTRUMENTS SP pathname  <p>/ DB_INSTRUMENTS SP db_path
9955                                    
9956  </p>  </p>
9957  <p>/ DB_INSTRUMENT SP INFO SP pathname  <p>/ DB_INSTRUMENT SP INFO SP db_path
9958                                    
9959  </p>  </p>
9960  <p>/ DB_INSTRUMENTS_JOB SP INFO SP number  <p>/ DB_INSTRUMENTS_JOB SP INFO SP number
# Line 9387  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 9402  Command Syntax</h3> Line 9984  Command Syntax</h3>
9984  <p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list  <p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
9985                                    
9986  </p>  </p>
9987    <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
9988                    
9989    </p>
9990  <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list  <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
9991                                    
9992  </p>  </p>
# Line 9423  Command Syntax</h3> Line 10008  Command Syntax</h3>
10008  <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value  <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
10009                                    
10010  </p>  </p>
10011  <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname  <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
10012                                    
10013  </p>  </p>
10014  <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval  <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
10015                                    
10016  </p>  </p>
10017  <p>/ DB_INSTRUMENT SP NAME SP pathname SP dirname  <p>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
10018                                    
10019  </p>  </p>
10020  <p>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval  <p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
10021                                    
10022  </p>  </p>
10023  <p>/ ECHO SP boolean  <p>/ ECHO SP boolean
# Line 9492  Command Syntax</h3> Line 10077  Command Syntax</h3>
10077  <p>find_instruction =  <p>find_instruction =
10078          </p>          </p>
10079  <blockquote class="text">  <blockquote class="text">
10080  <p>DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list  <p>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
10081                                    
10082  </p>  </p>
10083  <p>/ DB_INSTRUMENTS SP pathname SP query_val_list  <p>/ DB_INSTRUMENTS SP db_path SP query_val_list
10084                                    
10085  </p>  </p>
10086  <p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP query_val_list  <p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list
10087                                    
10088  </p>  </p>
10089  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
10090                                    
10091  </p>  </p>
10092  </blockquote><p>  </blockquote><p>
# Line 9510  Command Syntax</h3> Line 10095  Command Syntax</h3>
10095  <p>move_instruction =  <p>move_instruction =
10096          </p>          </p>
10097  <blockquote class="text">  <blockquote class="text">
10098  <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname  <p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
10099                                    
10100  </p>  </p>
10101  <p>/ DB_INSTRUMENT SP pathname SP pathname  <p>/ DB_INSTRUMENT SP db_path SP db_path
10102                                    
10103  </p>  </p>
10104  </blockquote><p>  </blockquote><p>
# Line 9522  Command Syntax</h3> Line 10107  Command Syntax</h3>
10107  <p>copy_instruction =  <p>copy_instruction =
10108          </p>          </p>
10109  <blockquote class="text">  <blockquote class="text">
10110  <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname  <p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
10111                                    
10112  </p>  </p>
10113  <p>/ DB_INSTRUMENT SP pathname SP pathname  <p>/ DB_INSTRUMENT SP db_path SP db_path
10114                                    
10115  </p>  </p>
10116  </blockquote><p>  </blockquote><p>
# Line 9606  Command Syntax</h3> Line 10191  Command Syntax</h3>
10191  </blockquote><p>  </blockquote><p>
10192    
10193  </p>  </p>
10194    <p>edit_instruction =
10195            </p>
10196    <blockquote class="text">
10197    <p>CHANNEL SP INSTRUMENT SP sampler_channel
10198                    
10199    </p>
10200    </blockquote><p>
10201    
10202    </p>
10203    <p>format_instruction =
10204            </p>
10205    <blockquote class="text">
10206    <p>INSTRUMENTS_DB
10207                    
10208    </p>
10209    </blockquote><p>
10210    
10211    </p>
10212  <p>modal_arg =  <p>modal_arg =
10213          </p>          </p>
10214  <blockquote class="text">  <blockquote class="text">
# Line 9675  Command Syntax</h3> Line 10278  Command Syntax</h3>
10278  <p>/ FX_SENDS SP sampler_channel  <p>/ FX_SENDS SP sampler_channel
10279                                    
10280  </p>  </p>
10281  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
10282                    
10283    </p>
10284    <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path
10285                                    
10286  </p>  </p>
10287  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname  <p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
10288                                    
10289  </p>  </p>
10290  <p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENTS SP db_path
10291                                    
10292  </p>  </p>
10293  <p>/ DB_INSTRUMENTS SP pathname  <p>/ FILE SP INSTRUMENTS SP filename
10294                                    
10295  </p>  </p>
10296  </blockquote><p>  </blockquote><p>
# Line 9867  Command Syntax</h3> Line 10473  Command Syntax</h3>
10473  </blockquote><p>  </blockquote><p>
10474    
10475  </p>  </p>
10476  <p>pathname =  <p>filename =
         </p>  
 <blockquote class="text">  
 <p>stringval  
                   
 </p>  
 </blockquote><p>  
   
 </p>  
 <p>dirname =  
10477          </p>          </p>
10478  <blockquote class="text">  <blockquote class="text">
10479  <p>stringval  <p>path
10480                                    
10481  </p>  </p>
10482  </blockquote><p>  </blockquote><p>
10483    
10484  </p>  </p>
10485  <p>filename =  <p>db_path =
10486          </p>          </p>
10487  <blockquote class="text">  <blockquote class="text">
10488  <p>stringval  <p>path
10489                                    
10490  </p>  </p>
10491  </blockquote><p>  </blockquote><p>
# Line 9897  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 9906  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 9915  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 9966  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>string  <p>text_escaped
10567                                    
10568  </p>  </p>
10569  <p>/ stringval  <p>/ stringval_escaped
10570                                    
10571  </p>  </p>
10572  </blockquote><p>  </blockquote><p>
# Line 9990  Command Syntax</h3> Line 10587  Command Syntax</h3>
10587  </blockquote><p>  </blockquote><p>
10588    
10589  </p>  </p>
10590    <a name="character_set"></a><br /><hr />
10591    <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>
10592    <a name="rfc.section.7.1"></a><h3>7.1.&nbsp;
10593    Character Set and Escape Sequences</h3>
10594    
10595    <p>Older versions of this protocol up to and including v1.1 only
10596                    supported the standard ASCII character set (ASCII code 0 - 127)
10597                    <a class='info' href='#RFC20'>[RFC20]<span> (</span><span class='info'>UCLA, &ldquo;ASCII format for Network Interchange,&rdquo; 1969.</span><span>)</span></a>, all younger versions of this protocol
10598                    however support the Extended ASCII character set (ASCII code
10599                    0 - 255). The same group of younger protocols also support
10600                    escape sequences, but only for certain, explicitly declared
10601                    parts of the protocol. The supported escape sequences are
10602                    defined as follows:
10603    </p><table class="full" align="center" border="0" cellpadding="2" cellspacing="2">
10604    <col align="left"><col align="left">
10605    <tr><th align="left">ASCII Character Sequence</th><th align="left">Translated into (Name)</th></tr>
10606    <tr>
10607    <td align="left">\n</td>
10608    <td align="left">new line</td>
10609    </tr>
10610    <tr>
10611    <td align="left">\r</td>
10612    <td align="left">carriage return</td>
10613    </tr>
10614    <tr>
10615    <td align="left">\f</td>
10616    <td align="left">form feed</td>
10617    </tr>
10618    <tr>
10619    <td align="left">\t</td>
10620    <td align="left">horizontal tab</td>
10621    </tr>
10622    <tr>
10623    <td align="left">\v</td>
10624    <td align="left">vertical tab</td>
10625    </tr>
10626    <tr>
10627    <td align="left">\'</td>
10628    <td align="left">apostrophe</td>
10629    </tr>
10630    <tr>
10631    <td align="left">\"</td>
10632    <td align="left">quotation mark</td>
10633    </tr>
10634    <tr>
10635    <td align="left">\\</td>
10636    <td align="left">backslash</td>
10637    </tr>
10638    <tr>
10639    <td align="left">\OOO</td>
10640    <td align="left">three digit octal ASCII code of the character</td>
10641    </tr>
10642    <tr>
10643    <td align="left">\xHH</td>
10644    <td align="left">two digit hex ASCII code of the character</td>
10645    </tr>
10646    </table>
10647    
10648    <p>Notice: due to the transition of certain parts of the
10649                    protocol which now support escape sequences, a slight backward
10650                    incompatibility to protocols version v1.1 and younger has been
10651                    introduced. The only difference is that in parts of the protocol
10652                    where escape characters are now supported, a backslash characters
10653                    MUST be escaped as well (that is as double backslash), whereas
10654                    in the old versions a single backslash was sufficient.
10655    </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 10150  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 10182  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 10212  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 10243  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 10276  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
11113                  a particular sampler channel is changed by issuing the following command:                  a particular sampler channel is changed by issuing the following command:
11114  </p>  </p>
11115  <p>  <p>
# Line 10306  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 10336  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 10363  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 10394  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 10427  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 10457  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 10491  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 10520  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 10554  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 10599  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 10633  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 10678  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 10711  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 10776  Acknowledgments</h3> Line 11635  Acknowledgments</h3>
11635  <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>
11636  <h3>11.&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
11637  <table width="99%" border="0">  <table width="99%" border="0">
11638    <tr><td class="author-text" valign="top"><a name="RFC20">[RFC20]</a></td>
11639    <td class="author-text">UCLA, &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc20.txt">ASCII format for Network Interchange</a>,&rdquo; RFC&nbsp;20, 1969.</td></tr>
11640  <tr><td class="author-text" valign="top"><a name="RFC2119">[RFC2119]</a></td>  <tr><td class="author-text" valign="top"><a name="RFC2119">[RFC2119]</a></td>
11641  <td class="author-text">Bradner, S., &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">Key words for use in RFCs to Indicate Requirement Levels</a>,&rdquo; RFC&nbsp;2119, 1997.</td></tr>  <td class="author-text">Bradner, S., &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">Key words for use in RFCs to Indicate Requirement Levels</a>,&rdquo; RFC&nbsp;2119, 1997.</td></tr>
11642  <tr><td class="author-text" valign="top"><a name="RFC2234">[RFC2234]</a></td>  <tr><td class="author-text" valign="top"><a name="RFC2234">[RFC2234]</a></td>
# Line 10806  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,
# Line 10853  Please address the information to the IE Line 11714  Please address the information to the IE
11714  Funding for the RFC Editor function is provided by  Funding for the RFC Editor function is provided by
11715  the IETF Administrative Support Activity (IASA).</p>  the IETF Administrative Support Activity (IASA).</p>
11716  </body></html>  </body></html>
11717    

Legend:
Removed from v.1201  
changed lines
  Added in v.1685

  ViewVC Help
Powered by ViewVC