/[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 2023 by schoenebeck, Sun Nov 1 12:59:16 2009 UTC
# Line 3  Line 3 
3  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
4  <meta name="description" content="LinuxSampler Control Protocol">  <meta name="description" content="LinuxSampler Control Protocol">
5  <meta name="keywords" content="LSCP">  <meta name="keywords" content="LSCP">
6  <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">  <meta name="generator" content="xml2rfc v1.34 (http://xml.resource.org/)">
7  <style type='text/css'><!--  <style type='text/css'><!--
8          body {          body {
9                  font-family: verdana, charcoal, helvetica, arial, sans-serif;                  font-family: verdana, charcoal, helvetica, arial, sans-serif;
# 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: May 5, 2010</td><td class="header">November 1, 2009</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.5</h1>
151    
152    <h3>Abstract</h3>
153    
154    <p>The LinuxSampler Control Protocol (LSCP) is an
155                application-level protocol primarily intended for local and
156                remote controlling the LinuxSampler backend application, which is a
157                sophisticated server-like console application essentially playing
158                back audio samples and manipulating the samples in real time to
159                certain extent.
160    </p>
161  <h3>Status of this Memo</h3>  <h3>Status of this Memo</h3>
162  <p>  <p>
163  By submitting this Internet-Draft,  By submitting this Internet-Draft,
# Line 173  The list of current Internet-Drafts can Line 182  The list of current Internet-Drafts can
182  The list of Internet-Draft Shadow Directories can be accessed at  The list of Internet-Draft Shadow Directories can be accessed at
183  <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>
184  <p>  <p>
185  This Internet-Draft will expire on November 25, 2007.</p>  This Internet-Draft will expire on May 5, 2010.</p>
186    <a name="toc"></a><br /><hr />
 <h3>Copyright Notice</h3>  
 <p>  
 Copyright &copy; The IETF Trust (2007).</p>  
   
 <h3>Abstract</h3>  
   
 <p>The LinuxSampler Control Protocol (LSCP) is an  
             application-level protocol primarily intended for local and  
             remote controlling the LinuxSampler backend application, which is a  
             sophisticated server-like console application essentially playing  
             back audio samples and manipulating the samples in real time to  
             certain extent.  
 </p><a name="toc"></a><br /><hr />  
187  <h3>Table of Contents</h3>  <h3>Table of Contents</h3>
188  <p class="toc">  <p class="toc">
189  <a href="#anchor1">1.</a>&nbsp;  <a href="#anchor1">1.</a>&nbsp;
# Line 336  Altering effect send's audio routing<br Line 332  Altering effect send's audio routing<br
332  Altering effect send's MIDI controller<br />  Altering effect send's MIDI controller<br />
333  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.33.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.33.</a>&nbsp;
334  Altering effect send's send level<br />  Altering effect send's send level<br />
335  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.34.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SEND CHANNEL MIDI_DATA">6.4.34.</a>&nbsp;
336    Sending MIDI messages to sampler channel<br />
337    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.35.</a>&nbsp;
338  Resetting a sampler channel<br />  Resetting a sampler channel<br />
339  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;
340  Controlling connection<br />  Controlling connection<br />
# Line 354  Global commands<br /> Line 352  Global commands<br />
352  Current number of active voices<br />  Current number of active voices<br />
353  &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;
354  Maximum amount of active voices<br />  Maximum amount of active voices<br />
355  &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;
356    Current number of active disk streams<br />
357    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET">6.6.4.</a>&nbsp;
358  Reset sampler<br />  Reset sampler<br />
359  &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;
360  General sampler informations<br />  General sampler informations<br />
361  &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;
362  Getting global volume attenuation<br />  Getting global volume attenuation<br />
363  &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;
364  Setting global volume attenuation<br />  Setting global volume attenuation<br />
365    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET VOICES">6.6.8.</a>&nbsp;
366    Getting global voice limit<br />
367    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOICES">6.6.9.</a>&nbsp;
368    Setting global voice limit<br />
369    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET STREAMS">6.6.10.</a>&nbsp;
370    Getting global disk stream limit<br />
371    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET STREAMS">6.6.11.</a>&nbsp;
372    Setting global disk stream limit<br />
373  &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;
374  MIDI Instrument Mapping<br />  MIDI Instrument Mapping<br />
375  &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;
376  Create a new MIDI instrument map<br />  Create a new MIDI instrument map<br />
377  &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;
378  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 440  Changing the description of instrument<b
440  Finding instruments<br />  Finding instruments<br />
441  &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;
442  Getting job status information<br />  Getting job status information<br />
443    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a>&nbsp;
444    Formatting the instruments database<br />
445    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FIND LOST DB_INSTRUMENT_FILES">6.8.23.</a>&nbsp;
446    Checking for lost instrument files<br />
447    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT FILE_PATH">6.8.24.</a>&nbsp;
448    Replacing an instrument file<br />
449    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#editing_instruments">6.9.</a>&nbsp;
450    Editing Instruments<br />
451    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#EDIT INSTRUMENT">6.9.1.</a>&nbsp;
452    Opening an appropriate instrument editor application<br />
453    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#file_management">6.10.</a>&nbsp;
454    Managing Files<br />
455    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FILE INSTRUMENTS">6.10.1.</a>&nbsp;
456    Retrieving amount of instruments of a file<br />
457    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST FILE INSTRUMENTS">6.10.2.</a>&nbsp;
458    Retrieving all instruments of a file<br />
459    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FILE INSTRUMENT INFO">6.10.3.</a>&nbsp;
460    Retrieving informations about one instrument in a file<br />
461  <a href="#command_syntax">7.</a>&nbsp;  <a href="#command_syntax">7.</a>&nbsp;
462  Command Syntax<br />  Command Syntax<br />
463    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#character_set">7.1.</a>&nbsp;
464    Character Set and Escape Sequences<br />
465  <a href="#events">8.</a>&nbsp;  <a href="#events">8.</a>&nbsp;
466  Events<br />  Events<br />
467  &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 474  Number of MIDI input devices changed<br
474  MIDI input device's settings changed<br />  MIDI input device's settings changed<br />
475  &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;
476  Number of sampler channels changed<br />  Number of sampler channels changed<br />
477  &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;
478    MIDI data on a sampler channel arrived<br />
479    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DEVICE_MIDI">8.7.</a>&nbsp;
480    MIDI data on a MIDI input device arrived<br />
481    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.8.</a>&nbsp;
482  Number of active voices changed<br />  Number of active voices changed<br />
483  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">8.7.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">8.9.</a>&nbsp;
484  Number of active disk streams changed<br />  Number of active disk streams changed<br />
485  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">8.8.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">8.10.</a>&nbsp;
486  Disk stream buffer fill state changed<br />  Disk stream buffer fill state changed<br />
487  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_INFO">8.9.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_INFO">8.11.</a>&nbsp;
488  Channel information changed<br />  Channel information changed<br />
489  &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.12.</a>&nbsp;
490  Number of effect sends changed<br />  Number of effect sends changed<br />
491  &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.13.</a>&nbsp;
492  Effect send information changed<br />  Effect send information changed<br />
493  &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.14.</a>&nbsp;
494  Total number of active voices changed<br />  Total number of active voices changed<br />
495  &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.15.</a>&nbsp;
496    Total number of active disk streams changed<br />
497    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.16.</a>&nbsp;
498  Number of MIDI instrument maps changed<br />  Number of MIDI instrument maps changed<br />
499  &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.17.</a>&nbsp;
500  MIDI instrument map information changed<br />  MIDI instrument map information changed<br />
501  &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.18.</a>&nbsp;
502  Number of MIDI instruments changed<br />  Number of MIDI instruments changed<br />
503  &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.19.</a>&nbsp;
504  MIDI instrument information changed<br />  MIDI instrument information changed<br />
505  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.20.</a>&nbsp;
506  Global settings changed<br />  Global settings changed<br />
507  &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.21.</a>&nbsp;
508  Number of database instrument directories changed<br />  Number of database instrument directories changed<br />
509  &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.22.</a>&nbsp;
510  Database instrument directory information changed<br />  Database instrument directory information changed<br />
511  &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.23.</a>&nbsp;
512  Number of database instruments changed<br />  Number of database instruments changed<br />
513  &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.24.</a>&nbsp;
514  Database instrument information changed<br />  Database instrument information changed<br />
515  &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.25.</a>&nbsp;
516  Database job status information changed<br />  Database job status information changed<br />
517  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.23.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.26.</a>&nbsp;
518  Miscellaneous and debugging events<br />  Miscellaneous and debugging events<br />
519  <a href="#anchor14">9.</a>&nbsp;  <a href="#anchor14">9.</a>&nbsp;
520  Security Considerations<br />  Security Considerations<br />
# Line 512  Requirements notation</h3> Line 546  Requirements notation</h3>
546              (front-end) and server (LinuxSampler) respectively. Lines in              (front-end) and server (LinuxSampler) respectively. Lines in
547              examples must be interpreted as every line being CRLF              examples must be interpreted as every line being CRLF
548              terminated (carriage return character followed by line feed              terminated (carriage return character followed by line feed
549              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>),
550              example:              thus the following example:
551  </p>  </p>
552  <p>  <p>
553                  </p>                  </p>
# Line 3299  Changing settings of MIDI input ports</h Line 3333  Changing settings of MIDI input ports</h
3333                      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>
3334                      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
3335                      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
3336                      parameter.                      parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes)
3337                        for specifying no value for parameters allowing a list of values.
3338  </p>  </p>
3339  <p>Possible Answers:  <p>Possible Answers:
3340  </p>  </p>
# Line 3340  Changing settings of MIDI input ports</h Line 3375  Changing settings of MIDI input ports</h
3375  <p>  <p>
3376                          </p>                          </p>
3377  <blockquote class="text">  <blockquote class="text">
3378    <p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"
3379    </p>
3380    <p>S: "OK"
3381    </p>
3382    </blockquote><p>
3383                        
3384    </p>
3385  <p>  <p>
3386                            </p>
3387    <blockquote class="text">
3388    <p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"
3389    </p>
3390    <p>S: "OK"
3391  </p>  </p>
3392  </blockquote><p>  </blockquote><p>
3393                                            
# Line 3375  Loading an instrument</h3> Line 3422  Loading an instrument</h3>
3422                      number of the sampler channel the instrument should be assigned to.                      number of the sampler channel the instrument should be assigned to.
3423                      Each sampler channel can only have one instrument.                      Each sampler channel can only have one instrument.
3424  </p>  </p>
3425    <p>Notice: since LSCP 1.2 the &lt;filename&gt; argument supports
3426                        escape characters for special characters (see chapter
3427                        "<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>"
3428                        for details) and accordingly backslash characters in the filename
3429                        MUST now be escaped as well!
3430    </p>
3431  <p>The difference between regular and NON_MODAL versions of the command  <p>The difference between regular and NON_MODAL versions of the command
3432                      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
3433                      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 3475  Loading an instrument</h3>
3475  </blockquote><p>  </blockquote><p>
3476                                            
3477  </p>  </p>
3478  <p>Example:  <p>Example (Unix):
3479  </p>  </p>
3480  <p>  <p>
3481                          </p>                          </p>
3482  <blockquote class="text">  <blockquote class="text">
3483    <p>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0
3484    </p>
3485    <p>S: OK
3486    </p>
3487    </blockquote><p>
3488                        
3489    </p>
3490    <p>Example (Windows):
3491    </p>
3492  <p>  <p>
3493                            </p>
3494    <blockquote class="text">
3495    <p>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0
3496    </p>
3497    <p>S: OK
3498  </p>  </p>
3499  </blockquote><p>  </blockquote><p>
3500                                            
# Line 3842  Getting information about an engine</h3> Line 3909  Getting information about an engine</h3>
3909                                          </p>                                          </p>
3910  <blockquote class="text">  <blockquote class="text">
3911  <p>arbitrary description text about the engine  <p>arbitrary description text about the engine
3912                                                (note that the character string may contain
3913                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
3914  </p>  </p>
3915  </blockquote>  </blockquote>
3916                                                                            
# Line 3927  Getting sampler channel information</h3> Line 3996  Getting sampler channel information</h3>
3996  <blockquote class="text">  <blockquote class="text">
3997  <p>numerical ID of the audio output device which is  <p>numerical ID of the audio output device which is
3998                                              currently connected to this sampler channel to output                                              currently connected to this sampler channel to output
3999                                              the audio signal, "NONE" if there's no device                                              the audio signal, "-1" if there's no device
4000                                              connected to this sampler channel                                              connected to this sampler channel
4001  </p>  </p>
4002  </blockquote>  </blockquote>
# Line 3961  Getting sampler channel information</h3> Line 4030  Getting sampler channel information</h3>
4030  <blockquote class="text">  <blockquote class="text">
4031  <p>the file name of the loaded instrument, "NONE" if  <p>the file name of the loaded instrument, "NONE" if
4032                                              there's no instrument yet loaded for this sampler                                              there's no instrument yet loaded for this sampler
4033                                              channel                                              channel (note: since LSCP 1.2 this path may contain
4034                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
4035  </p>  </p>
4036  </blockquote>  </blockquote>
4037                                                                            
# Line 3969  Getting sampler channel information</h3> Line 4039  Getting sampler channel information</h3>
4039  <p>INSTRUMENT_NR -  <p>INSTRUMENT_NR -
4040                                          </p>                                          </p>
4041  <blockquote class="text">  <blockquote class="text">
4042  <p>the instrument index number of the loaded instrument  <p>the instrument index number of the loaded instrument,
4043                                                "-1" if there's no instrument loaded for this sampler
4044                                                channel
4045  </p>  </p>
4046  </blockquote>  </blockquote>
4047                                                                            
# Line 3978  Getting sampler channel information</h3> Line 4050  Getting sampler channel information</h3>
4050                                          </p>                                          </p>
4051  <blockquote class="text">  <blockquote class="text">
4052  <p>the instrument name of the loaded instrument  <p>the instrument name of the loaded instrument
4053                                                (note: since LSCP 1.2 this character string may contain
4054                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
4055  </p>  </p>
4056  </blockquote>  </blockquote>
4057                                                                            
# Line 3985  Getting sampler channel information</h3> Line 4059  Getting sampler channel information</h3>
4059  <p>INSTRUMENT_STATUS -  <p>INSTRUMENT_STATUS -
4060                                          </p>                                          </p>
4061  <blockquote class="text">  <blockquote class="text">
4062  <p>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative  <p>Integer values 0 to 100 indicating loading progress
4063                                              value indicates a loading exception. Value of 100 indicates that the instrument is fully                                              percentage for the instrument. Negative
4064                                                value indicates a loading exception (also returns "-1" in case no
4065                                                instrument was yet to be loaded on the sampler channel).
4066                                                Value of 100 indicates that the instrument is fully
4067                                              loaded.                                              loaded.
4068  </p>  </p>
4069  </blockquote>  </blockquote>
# Line 3997  Getting sampler channel information</h3> Line 4074  Getting sampler channel information</h3>
4074  <blockquote class="text">  <blockquote class="text">
4075  <p>numerical ID of the MIDI input device which is  <p>numerical ID of the MIDI input device which is
4076                                              currently connected to this sampler channel to deliver                                              currently connected to this sampler channel to deliver
4077                                              MIDI input commands, "NONE" if there's no device                                              MIDI input commands, "-1" if there's no device
4078                                              connected to this sampler channel                                              connected to this sampler channel
4079  </p>  </p>
4080  </blockquote>  </blockquote>
# Line 4006  Getting sampler channel information</h3> Line 4083  Getting sampler channel information</h3>
4083  <p>MIDI_INPUT_PORT -  <p>MIDI_INPUT_PORT -
4084                                          </p>                                          </p>
4085  <blockquote class="text">  <blockquote class="text">
4086  <p>port number of the MIDI input device  <p>port number of the MIDI input device (in case a
4087                                                MIDI device was already assigned to the sampler
4088                                                channel)
4089  </p>  </p>
4090  </blockquote>  </blockquote>
4091                                                                            
# Line 5053  Adding an effect send to a sampler chann Line 5132  Adding an effect send to a sampler chann
5132                      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;
5133                      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
5134                      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
5135                      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
5136                        encapsulated into apostrophes and supports escape sequences as described in chapter
5137                        "<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>".
5138  </p>  </p>
5139  <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
5140                      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 5403  Getting effect send information</h3>
5403                                          </p>                                          </p>
5404  <blockquote class="text">  <blockquote class="text">
5405  <p>name of the effect send entity  <p>name of the effect send entity
5406                                                (note that this character string may contain
5407                                                 <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
5408  </p>  </p>
5409  </blockquote>  </blockquote>
5410                                                                            
# Line 5412  Changing effect send's name</h3> Line 5495  Changing effect send's name</h3>
5495                      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>
5496                      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
5497                      &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
5498                      does not have to be unique.                      does not have to be unique (name MUST be encapsulated into apostrophes
5499                        and supports escape sequences as described in chapter
5500                        "<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>").
5501                        
5502  </p>  </p>
5503  <p>Possible Answers:  <p>Possible Answers:
5504  </p>  </p>
# Line 5676  Altering effect send's send level</h3> Line 5762  Altering effect send's send level</h3>
5762  </blockquote><p>  </blockquote><p>
5763                                            
5764  </p>  </p>
5765  <a name="RESET CHANNEL"></a><br /><hr />  <a name="SEND CHANNEL MIDI_DATA"></a><br /><hr />
5766  <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>
5767  <a name="rfc.section.6.4.34"></a><h3>6.4.34.&nbsp;  <a name="rfc.section.6.4.34"></a><h3>6.4.34.&nbsp;
5768    Sending MIDI messages to sampler channel</h3>
5769    
5770    <p>The front-end can send MIDI events to a specific sampler channel
5771                        by sending the following command:
5772    </p>
5773    <p>
5774                            </p>
5775    <blockquote class="text">
5776    <p>SEND CHANNEL MIDI_DATA &lt;midi-msg&gt; &lt;sampler-chan&gt; &lt;arg1&gt; &lt;arg2&gt;
5777    </p>
5778    </blockquote><p>
5779                        
5780    </p>
5781    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5782                        as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
5783                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command,
5784                        &lt;arg1&gt; and &lt;arg2&gt; arguments depend on the &lt;midi-msg&gt; argument, which
5785                        specifies the MIDI message type. Currently, the following MIDI messages are supported:
5786    </p>
5787    <p>
5788                            </p>
5789    <blockquote class="text">
5790    <p>"NOTE_ON" -
5791                                    </p>
5792    <blockquote class="text">
5793    <p>For turning on MIDI notes, where &lt;arg1&gt;
5794                                        specifies the key number and &lt;arg2&gt; the velocity
5795                                        as described in the MIDI specification.
5796    </p>
5797    </blockquote>
5798                                
5799    
5800    <p>"NOTE_OFF" -
5801                                    </p>
5802    <blockquote class="text">
5803    <p>For turning a currently playing MIDI note off, where &lt;arg1&gt;
5804                                        specifies the key number and &lt;arg2&gt; the velocity
5805                                        as described in the MIDI specification.
5806    </p>
5807    </blockquote>
5808                                
5809    
5810    <p>"CC" -
5811                                    </p>
5812    <blockquote class="text">
5813    <p>For changing a MIDI controller, where &lt;arg1&gt;
5814                                        specifies the controller number and &lt;arg2&gt; the
5815                                        new value of the controller as described in the Control
5816                                        Change section of the MIDI specification.
5817    </p>
5818    </blockquote>
5819                                
5820    
5821    </blockquote><p>
5822                        
5823    </p>
5824    <p>CAUTION: This command is provided for implementations of virtual MIDI keyboards
5825                        and no realtime guarantee whatsoever will be made!
5826    </p>
5827    <p>Possible Answers:
5828    </p>
5829    <p>
5830                            </p>
5831    <blockquote class="text">
5832    <p>"OK" -
5833                                    </p>
5834    <blockquote class="text">
5835    <p>on success
5836    </p>
5837    </blockquote>
5838                                
5839    
5840    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5841                                    </p>
5842    <blockquote class="text">
5843    <p>in case it failed, providing an appropriate error code and error message
5844    </p>
5845    </blockquote>
5846                                
5847    
5848    </blockquote><p>
5849                        
5850    </p>
5851    <p>Example:
5852    </p>
5853    <p>
5854                            </p>
5855    <blockquote class="text">
5856    <p>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"
5857    </p>
5858    <p>S: "OK"
5859    </p>
5860    </blockquote><p>
5861                        
5862    </p>
5863    <a name="RESET CHANNEL"></a><br /><hr />
5864    <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>
5865    <a name="rfc.section.6.4.35"></a><h3>6.4.35.&nbsp;
5866  Resetting a sampler channel</h3>  Resetting a sampler channel</h3>
5867    
5868  <p>The front-end can reset a particular sampler channel by sending the following command:  <p>The front-end can reset a particular sampler channel by sending the following command:
# Line 6013  Maximum amount of active voices</h3> Line 6197  Maximum amount of active voices</h3>
6197  </blockquote><p>  </blockquote><p>
6198                                            
6199  </p>  </p>
6200  <a name="RESET"></a><br /><hr />  <a name="GET TOTAL_STREAM_COUNT"></a><br /><hr />
6201  <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>
6202  <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;
6203    Current number of active disk streams</h3>
6204    
6205    <p>The front-end can ask for the current number of active disk streams on
6206                        the sampler by sending the following command:
6207    </p>
6208    <p>
6209                            </p>
6210    <blockquote class="text">
6211    <p>GET TOTAL_STREAM_COUNT
6212    </p>
6213    </blockquote><p>
6214                        
6215    </p>
6216    <p>Possible Answers:
6217    </p>
6218    <p>
6219                            </p>
6220    <blockquote class="text">
6221    <p>LinuxSampler will answer by returning the number of all active
6222                                disk streams on the sampler.
6223    </p>
6224    </blockquote><p>
6225                        
6226    </p>
6227    <a name="RESET"></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>
6229    <a name="rfc.section.6.6.4"></a><h3>6.6.4.&nbsp;
6230  Reset sampler</h3>  Reset sampler</h3>
6231    
6232  <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 6267  Reset sampler</h3>
6267  </p>  </p>
6268  <a name="GET SERVER INFO"></a><br /><hr />  <a name="GET SERVER INFO"></a><br /><hr />
6269  <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>
6270  <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;
6271  General sampler informations</h3>  General sampler informations</h3>
6272    
6273  <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 6300  General sampler informations</h3>
6300                                          </p>                                          </p>
6301  <blockquote class="text">  <blockquote class="text">
6302  <p>arbitrary textual description about the sampler  <p>arbitrary textual description about the sampler
6303                                                (note that the character string may contain
6304                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
6305  </p>  </p>
6306  </blockquote>  </blockquote>
6307                                                                            
# Line 6130  General sampler informations</h3> Line 6343  General sampler informations</h3>
6343  </p>  </p>
6344  <a name="GET VOLUME"></a><br /><hr />  <a name="GET VOLUME"></a><br /><hr />
6345  <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>
6346  <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;
6347  Getting global volume attenuation</h3>  Getting global volume attenuation</h3>
6348    
6349  <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 6376  Getting global volume attenuation</h3>
6376  </p>  </p>
6377  <a name="SET VOLUME"></a><br /><hr />  <a name="SET VOLUME"></a><br /><hr />
6378  <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>
6379  <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;
6380  Setting global volume attenuation</h3>  Setting global volume attenuation</h3>
6381    
6382  <p>The client can alter the current global sampler-wide volume  <p>The client can alter the current global sampler-wide volume
# Line 6216  Setting global volume attenuation</h3> Line 6429  Setting global volume attenuation</h3>
6429  </blockquote><p>  </blockquote><p>
6430                                            
6431  </p>  </p>
6432    <a name="GET VOICES"></a><br /><hr />
6433    <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>
6434    <a name="rfc.section.6.6.8"></a><h3>6.6.8.&nbsp;
6435    Getting global voice limit</h3>
6436    
6437    <p>The client can ask for the current global sampler-wide limit
6438                           for maximum voices by sending the following command:
6439    </p>
6440    <p>
6441                            </p>
6442    <blockquote class="text">
6443    <p>GET VOICES
6444    </p>
6445    </blockquote><p>
6446                        
6447    </p>
6448    <p>Possible Answers:
6449    </p>
6450    <p>
6451                            </p>
6452    <blockquote class="text">
6453    <p>LinuxSampler will answer by returning the number for
6454                                   the current limit of maximum voices.
6455    </p>
6456    </blockquote><p>
6457                        
6458    </p>
6459    <p>The voice limit setting defines how many voices should maximum
6460                           be processed by the sampler at the same time. If the user
6461                           triggers new notes which would exceed that voice limit, the
6462                           sampler engine will react by stealing old voices for those
6463                           newly triggered notes. Note that the amount of voices triggered
6464                           by a new note can be larger than one and is dependent to the
6465                           respective instrument and probably further criterias.
6466    </p>
6467    <a name="SET VOICES"></a><br /><hr />
6468    <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>
6469    <a name="rfc.section.6.6.9"></a><h3>6.6.9.&nbsp;
6470    Setting global voice limit</h3>
6471    
6472    <p>The client can alter the current global sampler-wide limit
6473                        for maximum voices by sending the following command:
6474    </p>
6475    <p>
6476                            </p>
6477    <blockquote class="text">
6478    <p>SET VOICES &lt;max-voices&gt;
6479    </p>
6480    </blockquote><p>
6481                        
6482    </p>
6483    <p>Where &lt;max-voices&gt; should be replaced by the integer
6484                       value, reflecting the new global amount limit of maximum voices.
6485                       This value has to be larger than 0.
6486    </p>
6487    <p>Possible Answers:
6488    </p>
6489    <p>
6490                            </p>
6491    <blockquote class="text">
6492    <p>"OK" -
6493                                    </p>
6494    <blockquote class="text">
6495    <p>on success
6496    </p>
6497    </blockquote>
6498                                
6499    
6500    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6501                                    </p>
6502    <blockquote class="text">
6503    <p>if the voice limit was set, but there are noteworthy
6504                                        issue(s) related, providing an appropriate warning code and
6505                                        warning message
6506    </p>
6507    </blockquote>
6508                                
6509    
6510    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6511                                    </p>
6512    <blockquote class="text">
6513    <p>in case it failed, providing an appropriate error code and error message
6514    </p>
6515    </blockquote>
6516                                
6517    
6518    </blockquote><p>
6519                        
6520    </p>
6521    <p>Note: the given value will be passed to all sampler engine instances.
6522                           The total amount of maximum voices on the running system might thus
6523                           be as big as the given value multiplied by the current amount of engine
6524                           instances.
6525    </p>
6526    <p>Caution: when adjusting the voice limit, you SHOULD also
6527                            adjust the disk stream limit respectively and vice versa.
6528    </p>
6529    <a name="GET STREAMS"></a><br /><hr />
6530    <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>
6531    <a name="rfc.section.6.6.10"></a><h3>6.6.10.&nbsp;
6532    Getting global disk stream limit</h3>
6533    
6534    <p>The client can ask for the current global sampler-wide limit
6535                           for maximum disk streams by sending the following command:
6536    </p>
6537    <p>
6538                            </p>
6539    <blockquote class="text">
6540    <p>GET STREAMS
6541    </p>
6542    </blockquote><p>
6543                        
6544    </p>
6545    <p>Possible Answers:
6546    </p>
6547    <p>
6548                            </p>
6549    <blockquote class="text">
6550    <p>LinuxSampler will answer by returning the number for
6551                                   the current limit of maximum disk streams.
6552    </p>
6553    </blockquote><p>
6554                        
6555    </p>
6556    <p>The disk stream limit setting defines how many disk streams should
6557                           maximum be processed by a sampler engine at the same time. The
6558                           higher this value, the more memory (RAM) will be occupied, since
6559                           every disk streams allocates a certain buffer size for being able
6560                           to perform its streaming operations.
6561    </p>
6562    <a name="SET STREAMS"></a><br /><hr />
6563    <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>
6564    <a name="rfc.section.6.6.11"></a><h3>6.6.11.&nbsp;
6565    Setting global disk stream limit</h3>
6566    
6567    <p>The client can alter the current global sampler-wide limit
6568                        for maximum disk streams by sending the following command:
6569    </p>
6570    <p>
6571                            </p>
6572    <blockquote class="text">
6573    <p>SET STREAMS &lt;max-streams&gt;
6574    </p>
6575    </blockquote><p>
6576                        
6577    </p>
6578    <p>Where &lt;max-streams&gt; should be replaced by the integer
6579                       value, reflecting the new global amount limit of maximum disk streams.
6580                       This value has to be positive.
6581    </p>
6582    <p>Possible Answers:
6583    </p>
6584    <p>
6585                            </p>
6586    <blockquote class="text">
6587    <p>"OK" -
6588                                    </p>
6589    <blockquote class="text">
6590    <p>on success
6591    </p>
6592    </blockquote>
6593                                
6594    
6595    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6596                                    </p>
6597    <blockquote class="text">
6598    <p>if the disk stream limit was set, but there are noteworthy
6599                                        issue(s) related, providing an appropriate warning code and
6600                                        warning message
6601    </p>
6602    </blockquote>
6603                                
6604    
6605    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6606                                    </p>
6607    <blockquote class="text">
6608    <p>in case it failed, providing an appropriate error code and error message
6609    </p>
6610    </blockquote>
6611                                
6612    
6613    </blockquote><p>
6614                        
6615    </p>
6616    <p>Note: the given value will be passed to all sampler engine instances.
6617                           The total amount of maximum disk streams on the running system might
6618                           thus be as big as the given value multiplied by the current amount of
6619                           engine instances.
6620    </p>
6621    <p>Caution: when adjusting the disk stream limit, you SHOULD also
6622                            adjust the voice limit respectively and vice versa.
6623    </p>
6624  <a name="MIDI Instrument Mapping"></a><br /><hr />  <a name="MIDI Instrument Mapping"></a><br /><hr />
6625  <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>
6626  <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;  <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;
# Line 6250  MIDI Instrument Mapping</h3> Line 6655  MIDI Instrument Mapping</h3>
6655                  cause the sampler to switch to the respective instrument as                  cause the sampler to switch to the respective instrument as
6656                  reflected by the current MIDI instrument map.                  reflected by the current MIDI instrument map.
6657  </p>  </p>
6658  <a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr />  <a name="ADD MIDI_INSTRUMENT_MAP"></a><br /><hr />
6659  <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>
6660  <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;
6661  Create a new MIDI instrument map</h3>  Create a new MIDI instrument map</h3>
# Line 6268  Create a new MIDI instrument map</h3> Line 6673  Create a new MIDI instrument map</h3>
6673  </p>  </p>
6674  <p>Where &lt;name&gt; is an optional argument allowing to  <p>Where &lt;name&gt; is an optional argument allowing to
6675                      assign a custom name to the new map. MIDI instrument Map                      assign a custom name to the new map. MIDI instrument Map
6676                      names do not have to be unique.                      names do not have to be unique, but MUST be encapsulated
6677                        into apostrophes and support escape sequences as described
6678                        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>".
6679                        
6680  </p>  </p>
6681  <p>Possible Answers:  <p>Possible Answers:
6682  </p>  </p>
# Line 6526  Getting MIDI instrument map information< Line 6934  Getting MIDI instrument map information<
6934  <blockquote class="text">  <blockquote class="text">
6935  <p>custom name of the given map,  <p>custom name of the given map,
6936                                              which does not have to be unique                                              which does not have to be unique
6937                                                (note that this character string may contain
6938                                                 <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
6939  </p>  </p>
6940  </blockquote>  </blockquote>
6941                                                                            
# Line 6581  Renaming a MIDI instrument map</h3> Line 6991  Renaming a MIDI instrument map</h3>
6991  </p>  </p>
6992  <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
6993                      &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
6994                      have to be unique.                      have to be unique (name MUST be encapsulated into apostrophes
6995                        and supports escape sequences as described in chapter
6996                        "<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>").
6997                        
6998  </p>  </p>
6999  <p>Possible Answers:  <p>Possible Answers:
7000  </p>  </p>
# Line 6647  Create or replace a MIDI instrument map Line 7060  Create or replace a MIDI instrument map
7060                      index, &lt;engine_name&gt; a sampler engine name as returned by                      index, &lt;engine_name&gt; a sampler engine name as returned by
7061                      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>
7062                      command (not encapsulated into apostrophes), &lt;filename&gt; the name                      command (not encapsulated into apostrophes), &lt;filename&gt; the name
7063                      of the instrument's file to be deployed (encapsulated into apostrophes),                      of the instrument's file to be deployed (encapsulated into apostrophes,
7064                        supporting escape sequences as described in chapter
7065                        "<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>"),
7066                      &lt;instrument_index&gt; the index (integer value) of the instrument                      &lt;instrument_index&gt; the index (integer value) of the instrument
7067                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
7068                      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 7159  Create or replace a MIDI instrument map
7159                      load modes of entries, the frontend should retrieve the actual                      load modes of entries, the frontend should retrieve the actual
7160                      mode by i.e. sending                      mode by i.e. sending
7161                      <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>
7162                      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
7163                      set a custom name (encapsulated into apostrophes) for the mapping                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
7164                      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
7165                        mapping entry, useful for frontends for displaying an appropriate name for
7166                      mapped instruments (using                      mapped instruments (using
7167                      <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>).
7168                                            
# Line 7068  Get current settings of MIDI instrument Line 7484  Get current settings of MIDI instrument
7484                                      changed with the                                      changed with the
7485                                      <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>
7486                                      command and does not have to be unique.                                      command and does not have to be unique.
7487                                        (note that this character string may contain
7488                                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
7489  </p>  </p>
7490  </blockquote>  </blockquote>
7491                                                            
# Line 7084  Get current settings of MIDI instrument Line 7502  Get current settings of MIDI instrument
7502  <p>"INSTRUMENT_FILE" -  <p>"INSTRUMENT_FILE" -
7503                                  </p>                                  </p>
7504  <blockquote class="text">  <blockquote class="text">
7505  <p>File name of the instrument.  <p>File name of the instrument
7506                                        (note that this path may contain
7507                                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>).
7508  </p>  </p>
7509  </blockquote>  </blockquote>
7510                                                            
# Line 7102  Get current settings of MIDI instrument Line 7522  Get current settings of MIDI instrument
7522  <blockquote class="text">  <blockquote class="text">
7523  <p>Name of the loaded instrument as reflected by its file.  <p>Name of the loaded instrument as reflected by its file.
7524                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
7525                                      cannot be changed.                                      cannot be changed (note that this character string may contain
7526                                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>).
7527  </p>  </p>
7528  </blockquote>  </blockquote>
7529                                                            
# Line 7237  Managing Instruments Database</h3> Line 7658  Managing Instruments Database</h3>
7658  <p>The following commands describe how to use and manage  <p>The following commands describe how to use and manage
7659                  the instruments database.                  the instruments database.
7660  </p>  </p>
7661    <p>Notice:
7662    </p>
7663    <p>
7664                            </p>
7665    <blockquote class="text">
7666    <p>All command arguments representing a path or
7667                                instrument/directory name support escape sequences as described in chapter
7668                                "<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>".
7669                                
7670    </p>
7671    <p>All occurrences of a forward slash in instrument and directory
7672                                   names are escaped with its hex (\x2f) or octal (\057) escape sequence.
7673                                
7674    </p>
7675    </blockquote><p>
7676                        
7677    </p>
7678  <a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr />  <a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7679  <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>
7680  <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 7940  Getting instrument directory information
7940  <p>DESCRIPTION -  <p>DESCRIPTION -
7941                                          </p>                                          </p>
7942  <blockquote class="text">  <blockquote class="text">
7943  <p>A brief description of the directory content  <p>A brief description of the directory content.
7944                                                Note that the character string may contain
7945                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
7946  </p>  </p>
7947  </blockquote>  </blockquote>
7948                                                                            
# Line 7747  Changing the description of directory</h Line 8187  Changing the description of directory</h
8187                                            
8188  </p>  </p>
8189  <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
8190                      &lt;desc&gt; is the new description for the directory.                      &lt;desc&gt; is the new description for the directory
8191                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
8192                        "<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>").
8193  </p>  </p>
8194  <p>Possible Answers:  <p>Possible Answers:
8195  </p>  </p>
# Line 7814  Finding directories</h3> Line 8256  Finding directories</h3>
8256                            </p>                            </p>
8257  <blockquote class="text">  <blockquote class="text">
8258  <p>Restricts the search to directories, which names  <p>Restricts the search to directories, which names
8259                                satisfy the supplied search string.                                satisfy the supplied search string (encapsulated into apostrophes,
8260                                  supporting escape sequences as described in chapter
8261                                  "<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>").
8262  </p>  </p>
8263  </blockquote><p>  </blockquote><p>
8264                                                
# Line 7857  Finding directories</h3> Line 8301  Finding directories</h3>
8301                            </p>                            </p>
8302  <blockquote class="text">  <blockquote class="text">
8303  <p>Restricts the search to directories with description  <p>Restricts the search to directories with description
8304                                that satisfies the supplied search string.                                that satisfies the supplied search string
8305                                  (encapsulated into apostrophes, supporting escape
8306                                  sequences as described in chapter
8307                                  "<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>").
8308  </p>  </p>
8309  </blockquote><p>  </blockquote><p>
8310                                                
# Line 7920  Adding instruments to the instruments da Line 8367  Adding instruments to the instruments da
8367  <p>  <p>
8368                          </p>                          </p>
8369  <blockquote class="text">  <blockquote class="text">
8370  <p>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]  <p>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;[ FILE_AS_DIR]] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]
8371  </p>  </p>
8372  </blockquote><p>  </blockquote><p>
8373                                            
# Line 7978  Adding instruments to the instruments da Line 8425  Adding instruments to the instruments da
8425  </blockquote><p>  </blockquote><p>
8426                                            
8427  </p>  </p>
8428    <p> If FILE_AS_DIR argument is supplied, all instruments in an instrument
8429                     file will be added to a separate directory in the instruments database, which
8430                     name will be the name of the instrument file with the file extension stripped off.
8431                    
8432    </p>
8433  <p>The difference between regular and NON_MODAL versions of the command  <p>The difference between regular and NON_MODAL versions of the command
8434                      is that the regular command returns when the scanning is finished                      is that the regular command returns when the scanning is finished
8435                      while NON_MODAL version returns immediately and a background process is launched.                      while NON_MODAL version returns immediately and a background process is launched.
# Line 8238  Getting instrument information</h3> Line 8690  Getting instrument information</h3>
8690                                          </p>                                          </p>
8691  <blockquote class="text">  <blockquote class="text">
8692  <p>File name of the instrument.  <p>File name of the instrument.
8693                                                Note that the character string may contain
8694                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8695  </p>  </p>
8696  </blockquote>  </blockquote>
8697                                                                            
# Line 8297  Getting instrument information</h3> Line 8751  Getting instrument information</h3>
8751  <p>DESCRIPTION -  <p>DESCRIPTION -
8752                                          </p>                                          </p>
8753  <blockquote class="text">  <blockquote class="text">
8754  <p>A brief description of the instrument  <p>A brief description of the instrument.
8755                                                Note that the character string may contain
8756                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8757  </p>  </p>
8758  </blockquote>  </blockquote>
8759                                                                            
# Line 8314  Getting instrument information</h3> Line 8770  Getting instrument information</h3>
8770  <p>PRODUCT -  <p>PRODUCT -
8771                                          </p>                                          </p>
8772  <blockquote class="text">  <blockquote class="text">
8773  <p>The product title of the instrument  <p>The product title of the instrument.
8774                                                Note that the character string may contain
8775                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8776  </p>  </p>
8777  </blockquote>  </blockquote>
8778                                                                            
# Line 8322  Getting instrument information</h3> Line 8780  Getting instrument information</h3>
8780  <p>ARTISTS -  <p>ARTISTS -
8781                                          </p>                                          </p>
8782  <blockquote class="text">  <blockquote class="text">
8783  <p>Lists the artist names  <p>Lists the artist names.
8784                                                Note that the character string may contain
8785                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8786  </p>  </p>
8787  </blockquote>  </blockquote>
8788                                                                            
# Line 8332  Getting instrument information</h3> Line 8792  Getting instrument information</h3>
8792  <blockquote class="text">  <blockquote class="text">
8793  <p>Provides a list of keywords that refer to the instrument.  <p>Provides a list of keywords that refer to the instrument.
8794                                              Keywords are separated with semicolon and blank.                                              Keywords are separated with semicolon and blank.
8795                                                Note that the character string may contain
8796                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8797  </p>  </p>
8798  </blockquote>  </blockquote>
8799                                                                            
# Line 8572  Changing the description of instrument</ Line 9034  Changing the description of instrument</
9034                                            
9035  </p>  </p>
9036  <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
9037                      &lt;desc&gt; is the new description for the instrument.                      &lt;desc&gt; is the new description for the instrument
9038                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
9039                        "<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>").
9040  </p>  </p>
9041  <p>Possible Answers:  <p>Possible Answers:
9042  </p>  </p>
# Line 8639  Finding instruments</h3> Line 9103  Finding instruments</h3>
9103                            </p>                            </p>
9104  <blockquote class="text">  <blockquote class="text">
9105  <p>Restricts the search to instruments, which names  <p>Restricts the search to instruments, which names
9106                                satisfy the supplied search string.                                satisfy the supplied search string (encapsulated into apostrophes,
9107                                  supporting escape sequences as described in chapter
9108                                  "<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>").
9109  </p>  </p>
9110  </blockquote><p>  </blockquote><p>
9111                                                
# Line 8649  Finding instruments</h3> Line 9115  Finding instruments</h3>
9115  <p>SIZE=[&lt;min&gt;]..[&lt;max&gt;]  <p>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
9116                            </p>                            </p>
9117  <blockquote class="text">  <blockquote class="text">
9118  <p>Restricts the search to instruments, which  <p>Restricts the search to instruments, which
9119                                size is in the specified range. If &lt;min&gt; is omitted,                                size is in the specified range. If &lt;min&gt; is omitted,
9120                                the search results are restricted to instruments with size less then                                the search results are restricted to instruments with size less then
9121                                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 9163  Finding instruments</h3>
9163                            </p>                            </p>
9164  <blockquote class="text">  <blockquote class="text">
9165  <p>Restricts the search to instruments with description  <p>Restricts the search to instruments with description
9166                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
9167                                  supporting escape sequences as described in chapter
9168                                  "<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>").
9169  </p>  </p>
9170  </blockquote><p>  </blockquote><p>
9171                                                
# Line 8708  Finding instruments</h3> Line 9176  Finding instruments</h3>
9176                            </p>                            </p>
9177  <blockquote class="text">  <blockquote class="text">
9178  <p>Restricts the search to instruments with product info  <p>Restricts the search to instruments with product info
9179                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
9180                                  supporting escape sequences as described in chapter
9181                                  "<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>").
9182  </p>  </p>
9183  </blockquote><p>  </blockquote><p>
9184                                                
# Line 8719  Finding instruments</h3> Line 9189  Finding instruments</h3>
9189                            </p>                            </p>
9190  <blockquote class="text">  <blockquote class="text">
9191  <p>Restricts the search to instruments with artists info  <p>Restricts the search to instruments with artists info
9192                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
9193                                  supporting escape sequences as described in chapter
9194                                  "<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>").
9195  </p>  </p>
9196  </blockquote><p>  </blockquote><p>
9197                                                
# Line 8730  Finding instruments</h3> Line 9202  Finding instruments</h3>
9202                            </p>                            </p>
9203  <blockquote class="text">  <blockquote class="text">
9204  <p>Restricts the search to instruments with keyword list  <p>Restricts the search to instruments with keyword list
9205                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
9206                                  supporting escape sequences as described in chapter
9207                                  "<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>").
9208  </p>  </p>
9209  </blockquote><p>  </blockquote><p>
9210                                                
# Line 8740  Finding instruments</h3> Line 9214  Finding instruments</h3>
9214  <p>IS_DRUM=true | false  <p>IS_DRUM=true | false
9215                            </p>                            </p>
9216  <blockquote class="text">  <blockquote class="text">
9217  <p>Either true or false. Restricts the search to  <p>Either true or false. Restricts the search to
9218                                drum kits or chromatic instruments.                                drum kits or chromatic instruments.
9219  </p>  </p>
9220  </blockquote><p>  </blockquote><p>
# Line 8900  Getting job status information</h3> Line 9374  Getting job status information</h3>
9374  </blockquote><p>  </blockquote><p>
9375                                            
9376  </p>  </p>
9377    <a name="FORMAT INSTRUMENTS_DB"></a><br /><hr />
9378    <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>
9379    <a name="rfc.section.6.8.22"></a><h3>6.8.22.&nbsp;
9380    Formatting the instruments database</h3>
9381    
9382    <p>The front-end can remove all instruments and directories and re-create
9383                        the instruments database structure (e.g., in case of a database corruption)
9384                        by sending the following command:
9385    </p>
9386    <p>
9387                            </p>
9388    <blockquote class="text">
9389    <p>FORMAT INSTRUMENTS_DB
9390    </p>
9391    </blockquote><p>
9392                        
9393    </p>
9394    <p>Possible Answers:
9395    </p>
9396    <p>
9397                            </p>
9398    <blockquote class="text">
9399    <p>"OK" -
9400                                    </p>
9401    <blockquote class="text">
9402    <p>on success
9403    </p>
9404    </blockquote>
9405                                
9406    
9407    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9408                                    </p>
9409    <blockquote class="text">
9410    <p>If the formatting of the instruments database
9411                                        failed.
9412    </p>
9413    </blockquote>
9414                                
9415    
9416    </blockquote><p>
9417                        
9418    </p>
9419    <a name="FIND LOST DB_INSTRUMENT_FILES"></a><br /><hr />
9420    <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>
9421    <a name="rfc.section.6.8.23"></a><h3>6.8.23.&nbsp;
9422    Checking for lost instrument files</h3>
9423    
9424    <p>The front-end can retrieve the list of all instrument files in the instruments database
9425                        that don't exist in the filesystem by sending the following command:
9426    </p>
9427    <p>
9428                            </p>
9429    <blockquote class="text">
9430    <p>FIND LOST DB_INSTRUMENT_FILES
9431    </p>
9432    </blockquote><p>
9433                        
9434    </p>
9435    <p>Possible Answers:
9436    </p>
9437    <p>
9438                            </p>
9439    <blockquote class="text">
9440    <p>A comma separated list with the absolute path names
9441                                (encapsulated into apostrophes) of all lost instrument files.
9442    </p>
9443    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9444                                    </p>
9445    <blockquote class="text">
9446    <p>in case it failed, providing an appropriate error code and error message.
9447    </p>
9448    </blockquote>
9449                                
9450    
9451    </blockquote><p>
9452                        
9453    </p>
9454    <p>Example:
9455    </p>
9456    <p>
9457                            </p>
9458    <blockquote class="text">
9459    <p>C: "FIND LOST DB_INSTRUMENT_FILES"
9460    </p>
9461    <p>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"
9462    </p>
9463    </blockquote><p>
9464                        
9465    </p>
9466    <a name="SET DB_INSTRUMENT FILE_PATH"></a><br /><hr />
9467    <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>
9468    <a name="rfc.section.6.8.24"></a><h3>6.8.24.&nbsp;
9469    Replacing an instrument file</h3>
9470    
9471    <p>The front-end can substitute all occurrences of an instrument file
9472                        in the instruments database with a new one by sending the following command:
9473    </p>
9474    <p>
9475                            </p>
9476    <blockquote class="text">
9477    <p>SET DB_INSTRUMENT FILE_PATH &lt;old_path&gt; &lt;new_path&gt;
9478    </p>
9479    </blockquote><p>
9480                        
9481    </p>
9482    <p>Where &lt;old_path&gt; is the absolute path name of the instrument file
9483                        to substitute with &lt;new_path&gt;.
9484    </p>
9485    <p>Possible Answers:
9486    </p>
9487    <p>
9488                            </p>
9489    <blockquote class="text">
9490    <p>"OK" -
9491                                    </p>
9492    <blockquote class="text">
9493    <p>on success
9494    </p>
9495    </blockquote>
9496                                
9497    
9498    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9499                                    </p>
9500    <blockquote class="text">
9501    <p>in case it failed, providing an appropriate error code and error message.
9502    </p>
9503    </blockquote>
9504                                
9505    
9506    </blockquote><p>
9507                        
9508    </p>
9509    <p>Example:
9510    </p>
9511    <p>
9512                            </p>
9513    <blockquote class="text">
9514    <p>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"
9515    </p>
9516    <p>S: "OK"
9517    </p>
9518    </blockquote><p>
9519                        
9520    </p>
9521    <a name="editing_instruments"></a><br /><hr />
9522    <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>
9523    <a name="rfc.section.6.9"></a><h3>6.9.&nbsp;
9524    Editing Instruments</h3>
9525    
9526    <p>The sampler allows to edit instruments while playing with the
9527                    sampler by spawning an external (3rd party) instrument editor
9528                    application for a given instrument. The 3rd party instrument
9529                    editor applications have to place a respective plugin DLL file
9530                    into the sampler's plugins directory. The sampler will
9531                    automatically try to load all plugin DLLs in that directory on
9532                    startup and only on startup!
9533    </p>
9534    <p>At the moment there is only one command for this feature set,
9535                    but this will most probably change in future.
9536    </p>
9537    <a name="EDIT INSTRUMENT"></a><br /><hr />
9538    <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>
9539    <a name="rfc.section.6.9.1"></a><h3>6.9.1.&nbsp;
9540    Opening an appropriate instrument editor application</h3>
9541    
9542    <p>The front-end can request to open an appropriate instrument
9543                        editor application by sending the following command:
9544    </p>
9545    <p>
9546                            </p>
9547    <blockquote class="text">
9548    <p>EDIT CHANNEL INSTRUMENT &lt;sampler-channel&gt;
9549    </p>
9550    </blockquote><p>
9551                        
9552    </p>
9553    <p>Where &lt;sampler-channel&gt; should be replaced by the
9554                        number of the sampler channel as given by the
9555                        <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
9556                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a>
9557                        command.
9558    </p>
9559    <p>The sampler will try to ask all registered instrument
9560                        editors (or to be more specific: their sampler plugins)
9561                        whether they are capable to handle the instrument on the
9562                        given sampler channel. The sampler will simply use the first
9563                        instrument editor application which replied with a positive
9564                        answer and spawn that instrument editor application within
9565                        the sampler's process and provide that application access
9566                        to the instrument's data structures, so both applications
9567                        can share and access the same instruments data at the same
9568                        time, thus allowing to immediately hear changes with the
9569                        sampler made by the instrument editor.
9570    </p>
9571    <p>Note: consequently instrument editors are always spawned
9572                        locally on the same machine where the sampler is running
9573                        on!
9574    </p>
9575    <p>Possible Answers:
9576    </p>
9577    <p>
9578                            </p>
9579    <blockquote class="text">
9580    <p>"OK" -
9581                                    </p>
9582    <blockquote class="text">
9583    <p>when an appropriate instrument editor was
9584                                        launched
9585    </p>
9586    </blockquote>
9587                                
9588    
9589    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
9590                                    </p>
9591    <blockquote class="text">
9592    <p>when an appropriate instrument editor was
9593                                        launched, but there are noteworthy issues
9594    </p>
9595    </blockquote>
9596                                
9597    
9598    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9599                                    </p>
9600    <blockquote class="text">
9601    <p>when an appropriate instrument editor
9602                                        could not be launched
9603    </p>
9604    </blockquote>
9605                                
9606    
9607    </blockquote><p>
9608                        
9609    </p>
9610    <p>Examples:
9611    </p>
9612    <p>
9613                            </p>
9614    <blockquote class="text">
9615    <p>C: "EDIT CHANNEL INSTRUMENT 0"
9616    </p>
9617    <p>S: "OK"
9618    </p>
9619    </blockquote><p>
9620                        
9621    </p>
9622    <a name="file_management"></a><br /><hr />
9623    <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>
9624    <a name="rfc.section.6.10"></a><h3>6.10.&nbsp;
9625    Managing Files</h3>
9626    
9627    <p>You can query detailed informations about files located
9628                    at the same system where the sampler instance is running on.
9629                    Using this command set allows to retrieve file informations
9630                    even remotely from another machine.
9631    </p>
9632    <a name="GET FILE INSTRUMENTS"></a><br /><hr />
9633    <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>
9634    <a name="rfc.section.6.10.1"></a><h3>6.10.1.&nbsp;
9635    Retrieving amount of instruments of a file</h3>
9636    
9637    <p>The front-end can retrieve the amount of instruments
9638                        within a given instrument file by sending the
9639                        following command:
9640    </p>
9641    <p>
9642                            </p>
9643    <blockquote class="text">
9644    <p>GET FILE INSTRUMENTS &lt;filename&gt;
9645    </p>
9646    </blockquote><p>
9647                        
9648    </p>
9649    <p>Where &lt;filename&gt; is the name of the instrument
9650                        file (encapsulated into apostrophes, supporting escape
9651                        sequences as described in chapter
9652                        "<a class='info' href='#character_set'>Character Set and Escape
9653                            Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
9654    </p>
9655    <p>The sampler will try to ask all sampler engines,
9656                        whether they support the given file and ask the first
9657                        engine with a positive answer for the amount of
9658                        instruments.
9659    </p>
9660    <p>Possible Answers:
9661    </p>
9662    <p>
9663                            </p>
9664    <blockquote class="text">
9665    <p>On success, the sampler will answer by
9666                                   returning the amount of instruments.
9667                                
9668    </p>
9669    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9670                                    </p>
9671    <blockquote class="text">
9672    <p>if the file could not be handled
9673    </p>
9674    </blockquote>
9675                                
9676    
9677    </blockquote><p>
9678                        
9679    </p>
9680    <p>Examples:
9681    </p>
9682    <p>
9683                            </p>
9684    <blockquote class="text">
9685    <p>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
9686    </p>
9687    <p>S: "10"
9688    </p>
9689    </blockquote><p>
9690                        
9691    </p>
9692    <a name="LIST FILE INSTRUMENTS"></a><br /><hr />
9693    <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>
9694    <a name="rfc.section.6.10.2"></a><h3>6.10.2.&nbsp;
9695    Retrieving all instruments of a file</h3>
9696    
9697    <p>The front-end can retrieve a list of all instruments
9698                        within a given instrument file by sending the
9699                        following command:
9700    </p>
9701    <p>
9702                            </p>
9703    <blockquote class="text">
9704    <p>LIST FILE INSTRUMENTS &lt;filename&gt;
9705    </p>
9706    </blockquote><p>
9707                        
9708    </p>
9709    <p>Where &lt;filename&gt; is the name of the instrument
9710                        file (encapsulated into apostrophes, supporting escape
9711                        sequences as described in chapter
9712                        "<a class='info' href='#character_set'>Character Set and Escape
9713                            Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
9714    </p>
9715    <p>The sampler will try to ask all sampler engines,
9716                        whether they support the given file and ask the first
9717                        engine with a positive answer for a list of IDs for the
9718                        instruments in the given file.
9719    </p>
9720    <p>Possible Answers:
9721    </p>
9722    <p>
9723                            </p>
9724    <blockquote class="text">
9725    <p>On success, the sampler will answer by
9726                                   returning a comma separated list of
9727                                   instrument IDs.
9728                                
9729    </p>
9730    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9731                                    </p>
9732    <blockquote class="text">
9733    <p>if the file could not be handled
9734    </p>
9735    </blockquote>
9736                                
9737    
9738    </blockquote><p>
9739                        
9740    </p>
9741    <p>Examples:
9742    </p>
9743    <p>
9744                            </p>
9745    <blockquote class="text">
9746    <p>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
9747    </p>
9748    <p>S: "0,1,2,3,4,5,6,7,8,9"
9749    </p>
9750    </blockquote><p>
9751                        
9752    </p>
9753    <a name="GET FILE INSTRUMENT INFO"></a><br /><hr />
9754    <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>
9755    <a name="rfc.section.6.10.3"></a><h3>6.10.3.&nbsp;
9756    Retrieving informations about one instrument in a file</h3>
9757    
9758    <p>The front-end can retrieve detailed informations
9759                        about a specific instrument within a given instrument
9760                        file by sending the following command:
9761    </p>
9762    <p>
9763                            </p>
9764    <blockquote class="text">
9765    <p>GET FILE INSTRUMENT INFO &lt;filename&gt;
9766                                &lt;instr-id&gt;
9767    </p>
9768    </blockquote><p>
9769                        
9770    </p>
9771    <p>Where &lt;filename&gt; is the name of the instrument
9772                        file (encapsulated into apostrophes, supporting escape
9773                        sequences as described in chapter
9774                        "<a class='info' href='#character_set'>Character Set and Escape
9775                            Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") and &lt;instr-id&gt; is the numeric
9776                        instrument ID as returned by the
9777                        <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.
9778    </p>
9779    <p>The sampler will try to ask all sampler engines,
9780                        whether they support the given file and ask the first
9781                        engine with a positive answer for informations about the
9782                        specific instrument in the given file.
9783    </p>
9784    <p>Possible Answers:
9785    </p>
9786    <p>
9787                            </p>
9788    <blockquote class="text">
9789    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
9790                                Each answer line begins with the settings category name
9791                                followed by a colon and then a space character &lt;SP&gt; and finally
9792                                the info character string to that setting category. At the
9793                                moment the following categories are defined:
9794    </p>
9795    <p>
9796                                    </p>
9797    <blockquote class="text">
9798    <p>NAME -
9799                                            </p>
9800    <blockquote class="text">
9801    <p>name of the instrument as
9802                                                stored in the instrument file
9803    </p>
9804    </blockquote>
9805                                        
9806    
9807    <p>FORMAT_FAMILY -
9808                                            </p>
9809    <blockquote class="text">
9810    <p>name of the sampler format
9811                                                of the given instrument
9812    </p>
9813    </blockquote>
9814                                        
9815    
9816    <p>FORMAT_VERSION -
9817                                            </p>
9818    <blockquote class="text">
9819    <p>version of the sampler format
9820                                                the instrumen is stored as
9821    </p>
9822    </blockquote>
9823                                        
9824    
9825    <p>PRODUCT -
9826                                            </p>
9827    <blockquote class="text">
9828    <p>official product name of the
9829                                                instrument as stored in the file
9830                                                
9831    </p>
9832    </blockquote>
9833                                        
9834    
9835    <p>ARTISTS -
9836                                            </p>
9837    <blockquote class="text">
9838    <p>artists / sample library
9839                                                vendor of the instrument
9840    </p>
9841    </blockquote>
9842                                        
9843    
9844    <p>KEY_BINDINGS -
9845                                            </p>
9846    <blockquote class="text">
9847    <p>comma separated list of integer values representing
9848                                                   the instrument's key mapping in the range between 0 .. 127,
9849                                                   reflecting the analog meaning of the MIDI specification.
9850    </p>
9851    </blockquote>
9852                                        
9853    
9854    <p>KEYSWITCH_BINDINGS -
9855                                            </p>
9856    <blockquote class="text">
9857    <p>comma separated list of integer values representing
9858                                                   the instrument's keyswitch mapping in the range between 0 .. 127,
9859                                                   reflecting the analog meaning of the MIDI specification.
9860    </p>
9861    </blockquote>
9862                                        
9863    
9864    </blockquote>
9865                                
9866    
9867    </blockquote><p>
9868                        
9869    </p>
9870    <p>The mentioned fields above don't have to be in particular order.
9871    </p>
9872    <p>Example:
9873    </p>
9874    <p>
9875                            </p>
9876    <blockquote class="text">
9877    <p>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"
9878    </p>
9879    <p>S: "NAME: Lunatic Loops"
9880    </p>
9881    <p>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"
9882    </p>
9883    <p>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 3"
9884    </p>
9885    <p>&nbsp;&nbsp;&nbsp;"PRODUCT: The Backbone Bongo Beats"
9886    </p>
9887    <p>&nbsp;&nbsp;&nbsp;"ARTISTS: Jimmy the Fish"
9888    </p>
9889    <p>&nbsp;&nbsp;&nbsp;"."
9890    </p>
9891    </blockquote><p>
9892                        
9893    </p>
9894  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
9895  <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>
9896  <a name="rfc.section.7"></a><h3>7.&nbsp;  <a name="rfc.section.7"></a><h3>7.&nbsp;
# Line 9015  Command Syntax</h3> Line 10006  Command Syntax</h3>
10006  <p>/ COPY SP copy_instruction  <p>/ COPY SP copy_instruction
10007                                    
10008  </p>  </p>
10009    <p>/ EDIT SP edit_instruction
10010                    
10011    </p>
10012    <p>/ FORMAT SP format_instruction
10013                    
10014    </p>
10015    <p>/ SEND SP send_instruction
10016                    
10017    </p>
10018  <p>/ RESET  <p>/ RESET
10019                                    
10020  </p>  </p>
# Line 9030  Command Syntax</h3> Line 10030  Command Syntax</h3>
10030  <p>CHANNEL  <p>CHANNEL
10031                                    
10032  </p>  </p>
10033  <p>/ DB_INSTRUMENT_DIRECTORY SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP db_path
10034                    
10035    </p>
10036    <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
10037                    
10038    </p>
10039    <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename
10040                                    
10041  </p>  </p>
10042  <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
10043                                    
10044  </p>  </p>
10045  <p>/ DB_INSTRUMENTS SP scan_mode SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename
10046                                    
10047  </p>  </p>
10048  <p>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
10049                                    
10050  </p>  </p>
10051  <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
10052                                    
10053  </p>  </p>
10054  <p>/ DB_INSTRUMENTS SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP db_path SP filename
10055                                    
10056  </p>  </p>
10057  <p>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index  <p>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index
10058                                    
10059  </p>  </p>
10060  <p>/ MIDI_INSTRUMENT_MAP  <p>/ MIDI_INSTRUMENT_MAP
# Line 9078  Command Syntax</h3> Line 10084  Command Syntax</h3>
10084  <p>/ CHANNEL_COUNT  <p>/ CHANNEL_COUNT
10085                                    
10086  </p>  </p>
10087    <p>/ CHANNEL_MIDI
10088                    
10089    </p>
10090    <p>/ DEVICE_MIDI
10091                    
10092    </p>
10093  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
10094                                    
10095  </p>  </p>
# Line 9126  Command Syntax</h3> Line 10138  Command Syntax</h3>
10138  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
10139                                    
10140  </p>  </p>
10141    <p>/ TOTAL_STREAM_COUNT
10142                    
10143    </p>
10144  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
10145                                    
10146  </p>  </p>
# Line 9153  Command Syntax</h3> Line 10168  Command Syntax</h3>
10168  <p>/ CHANNEL_COUNT  <p>/ CHANNEL_COUNT
10169                                    
10170  </p>  </p>
10171    <p>/ CHANNEL_MIDI
10172                    
10173    </p>
10174    <p>/ DEVICE_MIDI
10175                    
10176    </p>
10177  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
10178                                    
10179  </p>  </p>
# Line 9201  Command Syntax</h3> Line 10222  Command Syntax</h3>
10222  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
10223                                    
10224  </p>  </p>
10225    <p>/ TOTAL_STREAM_COUNT
10226                    
10227    </p>
10228  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
10229                                    
10230  </p>  </p>
# Line 9249  Command Syntax</h3> Line 10273  Command Syntax</h3>
10273  <p>/ MIDI_INSTRUMENT_MAP SP ALL  <p>/ MIDI_INSTRUMENT_MAP SP ALL
10274                                    
10275  </p>  </p>
10276  <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
10277                                    
10278  </p>  </p>
10279  <p>/ DB_INSTRUMENT_DIRECTORY SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP db_path
10280                                    
10281  </p>  </p>
10282  <p>/ DB_INSTRUMENT SP pathname  <p>/ DB_INSTRUMENT SP db_path
10283                                    
10284  </p>  </p>
10285  </blockquote><p>  </blockquote><p>
# Line 9336  Command Syntax</h3> Line 10360  Command Syntax</h3>
10360  <p>/ SERVER SP INFO  <p>/ SERVER SP INFO
10361                                    
10362  </p>  </p>
10363    <p>/ TOTAL_STREAM_COUNT
10364                    
10365    </p>
10366  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
10367                                    
10368  </p>  </p>
# Line 9363  Command Syntax</h3> Line 10390  Command Syntax</h3>
10390  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
10391                                    
10392  </p>  </p>
10393  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
10394                                    
10395  </p>  </p>
10396  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path
10397                                    
10398  </p>  </p>
10399  <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
10400                                    
10401  </p>  </p>
10402  <p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
10403                                    
10404  </p>  </p>
10405  <p>/ DB_INSTRUMENTS SP pathname  <p>/ DB_INSTRUMENTS SP db_path
10406                                    
10407  </p>  </p>
10408  <p>/ DB_INSTRUMENT SP INFO SP pathname  <p>/ DB_INSTRUMENT SP INFO SP db_path
10409                                    
10410  </p>  </p>
10411  <p>/ DB_INSTRUMENTS_JOB SP INFO SP number  <p>/ DB_INSTRUMENTS_JOB SP INFO SP number
# Line 9387  Command Syntax</h3> Line 10414  Command Syntax</h3>
10414  <p>/ VOLUME  <p>/ VOLUME
10415                                    
10416  </p>  </p>
10417    <p>/ VOICES
10418                    
10419    </p>
10420    <p>/ STREAMS
10421                    
10422    </p>
10423    <p>/ FILE SP INSTRUMENTS SP filename
10424                    
10425    </p>
10426    <p>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
10427                    
10428    </p>
10429  </blockquote><p>  </blockquote><p>
10430    
10431  </p>  </p>
# Line 9402  Command Syntax</h3> Line 10441  Command Syntax</h3>
10441  <p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list  <p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
10442                                    
10443  </p>  </p>
10444    <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
10445                    
10446    </p>
10447  <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
10448                                    
10449  </p>  </p>
# Line 9423  Command Syntax</h3> Line 10465  Command Syntax</h3>
10465  <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
10466                                    
10467  </p>  </p>
10468  <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname  <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
10469                                    
10470  </p>  </p>
10471  <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval  <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
10472                                    
10473  </p>  </p>
10474  <p>/ DB_INSTRUMENT SP NAME SP pathname SP dirname  <p>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
10475                                    
10476  </p>  </p>
10477  <p>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval  <p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
10478                    
10479    </p>
10480    <p>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename
10481                                    
10482  </p>  </p>
10483  <p>/ ECHO SP boolean  <p>/ ECHO SP boolean
# Line 9441  Command Syntax</h3> Line 10486  Command Syntax</h3>
10486  <p>/ VOLUME SP volume_value  <p>/ VOLUME SP volume_value
10487                                    
10488  </p>  </p>
10489    <p>/ VOICES SP number
10490                    
10491    </p>
10492    <p>/ STREAMS SP number
10493                    
10494    </p>
10495  </blockquote><p>  </blockquote><p>
10496    
10497  </p>  </p>
# Line 9492  Command Syntax</h3> Line 10543  Command Syntax</h3>
10543  <p>find_instruction =  <p>find_instruction =
10544          </p>          </p>
10545  <blockquote class="text">  <blockquote class="text">
10546  <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
10547                    
10548    </p>
10549    <p>/ DB_INSTRUMENTS SP db_path SP query_val_list
10550                                    
10551  </p>  </p>
10552  <p>/ DB_INSTRUMENTS SP pathname SP query_val_list  <p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list
10553                                    
10554  </p>  </p>
10555  <p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP query_val_list  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
10556                                    
10557  </p>  </p>
10558  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list  <p>/ LOST SP DB_INSTRUMENT_FILES
10559                                    
10560  </p>  </p>
10561  </blockquote><p>  </blockquote><p>
# Line 9510  Command Syntax</h3> Line 10564  Command Syntax</h3>
10564  <p>move_instruction =  <p>move_instruction =
10565          </p>          </p>
10566  <blockquote class="text">  <blockquote class="text">
10567  <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname  <p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
10568                                    
10569  </p>  </p>
10570  <p>/ DB_INSTRUMENT SP pathname SP pathname  <p>/ DB_INSTRUMENT SP db_path SP db_path
10571                                    
10572  </p>  </p>
10573  </blockquote><p>  </blockquote><p>
# Line 9522  Command Syntax</h3> Line 10576  Command Syntax</h3>
10576  <p>copy_instruction =  <p>copy_instruction =
10577          </p>          </p>
10578  <blockquote class="text">  <blockquote class="text">
10579  <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname  <p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
10580                                    
10581  </p>  </p>
10582  <p>/ DB_INSTRUMENT SP pathname SP pathname  <p>/ DB_INSTRUMENT SP db_path SP db_path
10583                                    
10584  </p>  </p>
10585  </blockquote><p>  </blockquote><p>
# Line 9606  Command Syntax</h3> Line 10660  Command Syntax</h3>
10660  </blockquote><p>  </blockquote><p>
10661    
10662  </p>  </p>
10663    <p>edit_instruction =
10664            </p>
10665    <blockquote class="text">
10666    <p>CHANNEL SP INSTRUMENT SP sampler_channel
10667                    
10668    </p>
10669    </blockquote><p>
10670    
10671    </p>
10672    <p>format_instruction =
10673            </p>
10674    <blockquote class="text">
10675    <p>INSTRUMENTS_DB
10676                    
10677    </p>
10678    </blockquote><p>
10679    
10680    </p>
10681  <p>modal_arg =  <p>modal_arg =
10682          </p>          </p>
10683  <blockquote class="text">  <blockquote class="text">
# Line 9675  Command Syntax</h3> Line 10747  Command Syntax</h3>
10747  <p>/ FX_SENDS SP sampler_channel  <p>/ FX_SENDS SP sampler_channel
10748                                    
10749  </p>  </p>
10750  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
10751                    
10752    </p>
10753    <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path
10754                    
10755    </p>
10756    <p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
10757                                    
10758  </p>  </p>
10759  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname  <p>/ DB_INSTRUMENTS SP db_path
10760                                    
10761  </p>  </p>
10762  <p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname  <p>/ FILE SP INSTRUMENTS SP filename
10763                                    
10764  </p>  </p>
10765  <p>/ DB_INSTRUMENTS SP pathname  </blockquote><p>
10766    
10767    </p>
10768    <p>send_instruction =
10769            </p>
10770    <blockquote class="text">
10771    <p>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number
10772                                    
10773  </p>  </p>
10774  </blockquote><p>  </blockquote><p>
# Line 9867  Command Syntax</h3> Line 10951  Command Syntax</h3>
10951  </blockquote><p>  </blockquote><p>
10952    
10953  </p>  </p>
10954  <p>pathname =  <p>filename =
         </p>  
 <blockquote class="text">  
 <p>stringval  
                   
 </p>  
 </blockquote><p>  
   
 </p>  
 <p>dirname =  
10955          </p>          </p>
10956  <blockquote class="text">  <blockquote class="text">
10957  <p>stringval  <p>path
10958                                    
10959  </p>  </p>
10960  </blockquote><p>  </blockquote><p>
10961    
10962  </p>  </p>
10963  <p>filename =  <p>db_path =
10964          </p>          </p>
10965  <blockquote class="text">  <blockquote class="text">
10966  <p>stringval  <p>path
10967                                    
10968  </p>  </p>
10969  </blockquote><p>  </blockquote><p>
# Line 9897  Command Syntax</h3> Line 10972  Command Syntax</h3>
10972  <p>map_name =  <p>map_name =
10973          </p>          </p>
10974  <blockquote class="text">  <blockquote class="text">
10975  <p>stringval  <p>stringval_escaped
10976                                    
10977  </p>  </p>
10978  </blockquote><p>  </blockquote><p>
# Line 9906  Command Syntax</h3> Line 10981  Command Syntax</h3>
10981  <p>entry_name =  <p>entry_name =
10982          </p>          </p>
10983  <blockquote class="text">  <blockquote class="text">
10984  <p>stringval  <p>stringval_escaped
10985                                    
10986  </p>  </p>
10987  </blockquote><p>  </blockquote><p>
# Line 9915  Command Syntax</h3> Line 10990  Command Syntax</h3>
10990  <p>fx_send_name =  <p>fx_send_name =
10991          </p>          </p>
10992  <blockquote class="text">  <blockquote class="text">
10993  <p>stringval  <p>stringval_escaped
10994                                    
10995  </p>  </p>
10996  </blockquote><p>  </blockquote><p>
# Line 9966  Command Syntax</h3> Line 11041  Command Syntax</h3>
11041  <p>query_val =  <p>query_val =
11042          </p>          </p>
11043  <blockquote class="text">  <blockquote class="text">
11044  <p>string  <p>text_escaped
11045                                    
11046  </p>  </p>
11047  <p>/ stringval  <p>/ stringval_escaped
11048                                    
11049  </p>  </p>
11050  </blockquote><p>  </blockquote><p>
# Line 9990  Command Syntax</h3> Line 11065  Command Syntax</h3>
11065  </blockquote><p>  </blockquote><p>
11066    
11067  </p>  </p>
11068    <a name="character_set"></a><br /><hr />
11069    <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>
11070    <a name="rfc.section.7.1"></a><h3>7.1.&nbsp;
11071    Character Set and Escape Sequences</h3>
11072    
11073    <p>Older versions of this protocol up to and including v1.1 only
11074                    supported the standard ASCII character set (ASCII code 0 - 127)
11075                    <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
11076                    however support the Extended ASCII character set (ASCII code
11077                    0 - 255). The same group of younger protocols also support
11078                    escape sequences, but only for certain, explicitly declared
11079                    parts of the protocol. The supported escape sequences are
11080                    defined as follows:
11081    </p><table class="full" align="center" border="0" cellpadding="2" cellspacing="2">
11082    <col align="left"><col align="left">
11083    <tr><th align="left">ASCII Character Sequence</th><th align="left">Translated into (Name)</th></tr>
11084    <tr>
11085    <td align="left">\n</td>
11086    <td align="left">new line</td>
11087    </tr>
11088    <tr>
11089    <td align="left">\r</td>
11090    <td align="left">carriage return</td>
11091    </tr>
11092    <tr>
11093    <td align="left">\f</td>
11094    <td align="left">form feed</td>
11095    </tr>
11096    <tr>
11097    <td align="left">\t</td>
11098    <td align="left">horizontal tab</td>
11099    </tr>
11100    <tr>
11101    <td align="left">\v</td>
11102    <td align="left">vertical tab</td>
11103    </tr>
11104    <tr>
11105    <td align="left">\'</td>
11106    <td align="left">apostrophe</td>
11107    </tr>
11108    <tr>
11109    <td align="left">\"</td>
11110    <td align="left">quotation mark</td>
11111    </tr>
11112    <tr>
11113    <td align="left">\\</td>
11114    <td align="left">backslash</td>
11115    </tr>
11116    <tr>
11117    <td align="left">\OOO</td>
11118    <td align="left">three digit octal ASCII code of the character</td>
11119    </tr>
11120    <tr>
11121    <td align="left">\xHH</td>
11122    <td align="left">two digit hex ASCII code of the character</td>
11123    </tr>
11124    </table>
11125    <br clear="all" />
11126    
11127    <p>Notice: due to the transition of certain parts of the
11128                    protocol which now support escape sequences, a slight backward
11129                    incompatibility to protocols version v1.1 and younger has been
11130                    introduced. The only difference is that in parts of the protocol
11131                    where escape characters are now supported, a backslash characters
11132                    MUST be escaped as well (that is as double backslash), whereas
11133                    in the old versions a single backslash was sufficient.
11134    </p>
11135    <p>The following LSCP commands support escape sequences as part
11136                    of their filename / path based arguments and / or may contain
11137                    a filename / path with escape sequences in their response:
11138                    </p>
11139    <blockquote class="text">
11140    <p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a>
11141    </p>
11142    <p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
11143    </p>
11144    <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>
11145    </p>
11146    <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>
11147    </p>
11148    <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>
11149    </p>
11150    <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>
11151    </p>
11152    <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>
11153    </p>
11154    <p><a class='info' href='#REMOVE DB_INSTRUMENT'>"REMOVE DB_INSTRUMENT"<span> (</span><span class='info'>Removing an instrument</span><span>)</span></a>
11155    </p>
11156    <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>
11157    </p>
11158    <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>
11159    </p>
11160    <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>
11161    </p>
11162    <p><a class='info' href='#GET DB_INSTRUMENTS'>"GET DB_INSTRUMENTS"<span> (</span><span class='info'>Getting amount of instruments</span><span>)</span></a>
11163    </p>
11164    <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>
11165    </p>
11166    <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>
11167    </p>
11168    <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>
11169    </p>
11170    <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>
11171    </p>
11172    <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>
11173    </p>
11174    <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>
11175    </p>
11176    <p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a>
11177    </p>
11178    <p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a>
11179    </p>
11180    <p><a class='info' href='#MOVE DB_INSTRUMENT'>"MOVE DB_INSTRUMENT"<span> (</span><span class='info'>Moving an instrument</span><span>)</span></a>
11181    </p>
11182    <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>
11183    </p>
11184    <p><a class='info' href='#COPY DB_INSTRUMENT'>"COPY DB_INSTRUMENT"<span> (</span><span class='info'>Copying instruments</span><span>)</span></a>
11185    </p>
11186    <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>
11187    </p>
11188    <p><a class='info' href='#FIND LOST DB_INSTRUMENT_FILES'>"FIND LOST DB_INSTRUMENT_FILES"<span> (</span><span class='info'>Checking for lost instrument files</span><span>)</span></a>
11189    </p>
11190    <p><a class='info' href='#SET DB_INSTRUMENT FILE_PATH'>"SET DB_INSTRUMENT FILE_PATH"<span> (</span><span class='info'>Replacing an instrument file</span><span>)</span></a>
11191    </p>
11192    <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>
11193    </p>
11194    <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>
11195    </p>
11196    <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>
11197    </p>
11198    </blockquote><p>
11199                    Note that the forward slash character ('/') has a special meaning in
11200                    filename / path based arguments: it acts as separator of the nodes in
11201                    the path, thus if a directory- or filename includes a forward slash
11202                    (not intended as path node separator), you MUST escape that slash
11203                    either with the respective hex escape sequence ("\x2f") or with the
11204                    respective octal escape sequence ("\057").
11205                    
11206    </p>
11207    <p>
11208                    Note for Windows: file path arguments in LSCP are expected
11209                    to use forward slashes as directory node separator similar
11210                    to Unix based operating systems. In contrast to Unix however
11211                    a Windows typical drive character is expected to be
11212                    prefixed to the path. That is an original Windows file path
11213                    like "D:\Sounds\My.gig" would become in LSCP:
11214                    "D:/Sounds/My.gig".
11215                    
11216    </p>
11217    <p>
11218                    The following LSCP commands even support escape sequences as
11219                    part of at least one of their text-based arguments (i.e. entity name,
11220                    description) and / or may contain escape sequences in at least one of
11221                    their text-based fields in their response:
11222                    </p>
11223    <blockquote class="text">
11224    <p><a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a>
11225    </p>
11226    <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>
11227    </p>
11228    <p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
11229    </p>
11230    <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>
11231    </p>
11232    <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>
11233    </p>
11234    <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>
11235    </p>
11236    <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>
11237    </p>
11238    <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>
11239    </p>
11240    <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>
11241    </p>
11242    <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>
11243    </p>
11244    <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>
11245    </p>
11246    <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>
11247    </p>
11248    <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>
11249    </p>
11250    <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>
11251    </p>
11252    <p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a>
11253    </p>
11254    <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>
11255    </p>
11256    <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>
11257    </p>
11258    <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>
11259    </p>
11260    <p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a>
11261    </p>
11262    </blockquote><p>
11263                    Please note that these lists are manually maintained. If you
11264                    find a command that also supports escape sequences we forgot to
11265                    mention here, please report it!
11266                    
11267    </p>
11268  <a name="events"></a><br /><hr />  <a name="events"></a><br /><hr />
11269  <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>
11270  <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 11425  Number of sampler channels changed</h3>
11425  <p>where &lt;channels&gt; will be replaced by the new number  <p>where &lt;channels&gt; will be replaced by the new number
11426                  of sampler channels.                  of sampler channels.
11427  </p>  </p>
11428  <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE CHANNEL_MIDI"></a><br /><hr />
11429  <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>
11430  <a name="rfc.section.8.6"></a><h3>8.6.&nbsp;  <a name="rfc.section.8.6"></a><h3>8.6.&nbsp;
11431    MIDI data on a sampler channel arrived</h3>
11432    
11433    <p>Client may want to be notified when MIDI data arrive on sampler channels on
11434                    back-end side, by issuing the following command:
11435    </p>
11436    <p>
11437                        </p>
11438    <blockquote class="text">
11439    <p>SUBSCRIBE CHANNEL_MIDI
11440    </p>
11441    </blockquote><p>
11442                    
11443    </p>
11444    <p>Server will start sending one of the the following notification messages:
11445    </p>
11446    <p>
11447                        </p>
11448    <blockquote class="text">
11449    <p>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_ON  &lt;note&gt; &lt;velocity&gt;"
11450    </p>
11451    <p>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"
11452    </p>
11453    </blockquote><p>
11454                    
11455    </p>
11456    <p>where &lt;channel-id&gt; will be replaced by the ID of the sampler channel where the MIDI
11457                    data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
11458                    0 .. 127, reflecting the analog meaning of the MIDI specification.
11459                    
11460    </p>
11461    <p>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
11462                    delivered by this mechanism! With other words: events could be lost at any time!
11463                    This restriction was made to keep the RT-safeness of the backend's MIDI and audio
11464                    thread unaffected by this feature.
11465    </p>
11466    <a name="SUBSCRIBE DEVICE_MIDI"></a><br /><hr />
11467    <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>
11468    <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;
11469    MIDI data on a MIDI input device arrived</h3>
11470    
11471    <p>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:
11472    </p>
11473    <p>
11474                                </p>
11475    <blockquote class="text">
11476    <p>SUBSCRIBE DEVICE_MIDI
11477    </p>
11478    </blockquote><p>
11479                        
11480    </p>
11481    <p>Server will start sending one of the the following notification messages:
11482    </p>
11483    <p>
11484                                </p>
11485    <blockquote class="text">
11486    <p>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_ON &lt;note&gt; &lt;velocity&gt;"
11487    </p>
11488    <p>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"
11489    </p>
11490    </blockquote><p>
11491                        
11492    </p>
11493    <p>where &lt;device-id&gt; &lt;port-id&gt; will be replaced
11494                           by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI
11495                           data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
11496                           0 .. 127, reflecting the analog meaning of the MIDI specification.
11497                        
11498    </p>
11499    <p>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
11500                           delivered by this mechanism! With other words: events could be lost at any time!
11501                           This restriction was made to keep the RT-safeness of the backend's MIDI and audio
11502                           thread unaffected by this feature.
11503    </p>
11504    <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />
11505    <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>
11506    <a name="rfc.section.8.8"></a><h3>8.8.&nbsp;
11507  Number of active voices changed</h3>  Number of active voices changed</h3>
11508    
11509  <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 11533  Number of active voices changed</h3>
11533  </p>  </p>
11534  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />
11535  <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>
11536  <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;  <a name="rfc.section.8.9"></a><h3>8.9.&nbsp;
11537  Number of active disk streams changed</h3>  Number of active disk streams changed</h3>
11538    
11539  <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 11563  Number of active disk streams changed</h
11563  </p>  </p>
11564  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />
11565  <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>
11566  <a name="rfc.section.8.8"></a><h3>8.8.&nbsp;  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
11567  Disk stream buffer fill state changed</h3>  Disk stream buffer fill state changed</h3>
11568    
11569  <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 11594  Disk stream buffer fill state changed</h
11594  </p>  </p>
11595  <a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr />  <a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr />
11596  <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>
11597  <a name="rfc.section.8.9"></a><h3>8.9.&nbsp;  <a name="rfc.section.8.11"></a><h3>8.11.&nbsp;
11598  Channel information changed</h3>  Channel information changed</h3>
11599    
11600  <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 11627  Channel information changed</h3>
11627  </p>  </p>
11628  <a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr />  <a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr />
11629  <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>
11630  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;  <a name="rfc.section.8.12"></a><h3>8.12.&nbsp;
11631  Number of effect sends changed</h3>  Number of effect sends changed</h3>
11632    
11633  <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
11634                  a particular sampler channel is changed by issuing the following command:                  a particular sampler channel is changed by issuing the following command:
11635  </p>  </p>
11636  <p>  <p>
# Line 10306  Number of effect sends changed</h3> Line 11657  Number of effect sends changed</h3>
11657  </p>  </p>
11658  <a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr />  <a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr />
11659  <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>
11660  <a name="rfc.section.8.11"></a><h3>8.11.&nbsp;  <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;
11661  Effect send information changed</h3>  Effect send information changed</h3>
11662    
11663  <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 11687  Effect send information changed</h3>
11687  </p>  </p>
11688  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />
11689  <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>
11690  <a name="rfc.section.8.12"></a><h3>8.12.&nbsp;  <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;
11691  Total number of active voices changed</h3>  Total number of active voices changed</h3>
11692    
11693  <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 11714  Total number of active voices changed</h
11714  <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
11715                  all currently active voices.                  all currently active voices.
11716  </p>  </p>
11717    <a name="SUBSCRIBE TOTAL_STREAM_COUNT"></a><br /><hr />
11718    <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>
11719    <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;
11720    Total number of active disk streams changed</h3>
11721    
11722    <p>Client may want to be notified when the total number of disk streams on the
11723                    back-end changes by issuing the following command:
11724    </p>
11725    <p>
11726                        </p>
11727    <blockquote class="text">
11728    <p>SUBSCRIBE TOTAL_STREAM_COUNT
11729    </p>
11730    </blockquote><p>
11731                    
11732    </p>
11733    <p>Server will start sending the following notification messages:
11734    </p>
11735    <p>
11736                        </p>
11737    <blockquote class="text">
11738    <p>"NOTIFY:TOTAL_STREAM_COUNT:&lt;streams&gt;"
11739    </p>
11740    </blockquote><p>
11741                    
11742    </p>
11743    <p>where &lt;streams&gt; will be replaced by the new number of
11744                    all currently active disk streams.
11745    </p>
11746  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr />  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr />
11747  <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>
11748  <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;  <a name="rfc.section.8.16"></a><h3>8.16.&nbsp;
11749  Number of MIDI instrument maps changed</h3>  Number of MIDI instrument maps changed</h3>
11750    
11751  <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 11774  Number of MIDI instrument maps changed</
11774  </p>  </p>
11775  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr />  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr />
11776  <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>
11777  <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;  <a name="rfc.section.8.17"></a><h3>8.17.&nbsp;
11778  MIDI instrument map information changed</h3>  MIDI instrument map information changed</h3>
11779    
11780  <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 11807  MIDI instrument map information changed<
11807  </p>  </p>
11808  <a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr />  <a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr />
11809  <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>
11810  <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;  <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;
11811  Number of MIDI instruments changed</h3>  Number of MIDI instruments changed</h3>
11812    
11813  <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 11837  Number of MIDI instruments changed</h3>
11837  </p>  </p>
11838  <a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr />  <a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr />
11839  <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>
11840  <a name="rfc.section.8.16"></a><h3>8.16.&nbsp;  <a name="rfc.section.8.19"></a><h3>8.19.&nbsp;
11841  MIDI instrument information changed</h3>  MIDI instrument information changed</h3>
11842    
11843  <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 11871  MIDI instrument information changed</h3>
11871  </p>  </p>
11872  <a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr />  <a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr />
11873  <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>
11874  <a name="rfc.section.8.17"></a><h3>8.17.&nbsp;  <a name="rfc.section.8.20"></a><h3>8.20.&nbsp;
11875  Global settings changed</h3>  Global settings changed</h3>
11876    
11877  <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 10516  Global settings changed</h3> Line 11896  Global settings changed</h3>
11896                          new global volume parameter.                          new global volume parameter.
11897  </p>  </p>
11898  </blockquote><p>  </blockquote><p>
11899                        </p>
11900    <blockquote class="text">
11901    <p>"NOTIFY:GLOBAL_INFO:VOICES &lt;max-voices&gt;" - Notifies that the
11902                            golbal limit of the sampler for maximum voices is changed, where
11903                            &lt;max-voices&gt; will be an integer value, reflecting the
11904                            new global voice limit parameter.
11905    </p>
11906    </blockquote><p>
11907                        </p>
11908    <blockquote class="text">
11909    <p>"NOTIFY:GLOBAL_INFO:STREAMS &lt;max-streams&gt;" - Notifies that the
11910                            golbal limit of the sampler for maximum disk streams is changed, where
11911                            &lt;max-streams&gt; will be an integer value, reflecting the
11912                            new global disk streams limit parameter.
11913    </p>
11914    </blockquote><p>
11915                                    
11916  </p>  </p>
11917  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />
11918  <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>
11919  <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;  <a name="rfc.section.8.21"></a><h3>8.21.&nbsp;
11920  Number of database instrument directories changed</h3>  Number of database instrument directories changed</h3>
11921    
11922  <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 11950  Number of database instrument directorie
11950  </p>  </p>
11951  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr />
11952  <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>
11953  <a name="rfc.section.8.19"></a><h3>8.19.&nbsp;  <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;
11954  Database instrument directory information changed</h3>  Database instrument directory information changed</h3>
11955    
11956  <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 11995  Database instrument directory informatio
11995  </p>  </p>
11996  <a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr />
11997  <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>
11998  <a name="rfc.section.8.20"></a><h3>8.20.&nbsp;  <a name="rfc.section.8.23"></a><h3>8.23.&nbsp;
11999  Number of database instruments changed</h3>  Number of database instruments changed</h3>
12000    
12001  <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 12029  Number of database instruments changed</
12029  </p>  </p>
12030  <a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr />
12031  <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>
12032  <a name="rfc.section.8.21"></a><h3>8.21.&nbsp;  <a name="rfc.section.8.24"></a><h3>8.24.&nbsp;
12033  Database instrument information changed</h3>  Database instrument information changed</h3>
12034    
12035  <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 12074  Database instrument information changed<
12074  </p>  </p>
12075  <a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr />
12076  <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>
12077  <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;  <a name="rfc.section.8.25"></a><h3>8.25.&nbsp;
12078  Database job status information changed</h3>  Database job status information changed</h3>
12079    
12080  <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 12107  Database job status information changed<
12107  </p>  </p>
12108  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
12109  <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>
12110  <a name="rfc.section.8.23"></a><h3>8.23.&nbsp;  <a name="rfc.section.8.26"></a><h3>8.26.&nbsp;
12111  Miscellaneous and debugging events</h3>  Miscellaneous and debugging events</h3>
12112    
12113  <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 12172  Acknowledgments</h3>
12172  <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>
12173  <h3>11.&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
12174  <table width="99%" border="0">  <table width="99%" border="0">
12175    <tr><td class="author-text" valign="top"><a name="RFC20">[RFC20]</a></td>
12176    <td class="author-text">UCLA, &ldquo;<a href="http://tools.ietf.org/html/rfc20">ASCII format for Network Interchange</a>,&rdquo; RFC&nbsp;20, 1969.</td></tr>
12177  <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>
12178  <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="http://tools.ietf.org/html/rfc2119">Key words for use in RFCs to Indicate Requirement Levels</a>,&rdquo; RFC&nbsp;2119, 1997.</td></tr>
12179  <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>
12180  <td class="author-text">Crocker, D. and P. Overell, &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc2234.txt">Augmented BNF for Syntax Specifications</a>,&rdquo; RFC&nbsp;2234, 1997.</td></tr>  <td class="author-text">Crocker, D. and P. Overell, &ldquo;<a href="http://tools.ietf.org/html/rfc2234">Augmented BNF for Syntax Specifications</a>,&rdquo; RFC&nbsp;2234, 1997.</td></tr>
12181  <tr><td class="author-text" valign="top"><a name="RFC793">[RFC793]</a></td>  <tr><td class="author-text" valign="top"><a name="RFC793">[RFC793]</a></td>
12182  <td class="author-text">Defense Advanced Research Projects Agency, &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc793.txt">TRANSMISSION CONTROL PROTOCOL</a>,&rdquo; RFC&nbsp;793, 1981.</td></tr>  <td class="author-text">Defense Advanced Research Projects Agency, &ldquo;<a href="http://tools.ietf.org/html/rfc793">TRANSMISSION CONTROL PROTOCOL</a>,&rdquo; RFC&nbsp;793, 1981.</td></tr>
12183  </table>  </table>
12184    
12185  <a name="rfc.authors"></a><br /><hr />  <a name="rfc.authors"></a><br /><hr />
# Line 10806  Schoenebeck</td></tr> Line 12204  Schoenebeck</td></tr>
12204  <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>
12205  <h3>Full Copyright Statement</h3>  <h3>Full Copyright Statement</h3>
12206  <p class='copyright'>  <p class='copyright'>
12207  Copyright &copy; The IETF Trust (2007).</p>  Copyright &copy; The IETF Trust (2009).</p>
12208  <p class='copyright'>  <p class='copyright'>
12209  This document is subject to the rights,  This document is subject to the rights,
12210  licenses and restrictions contained in BCP&nbsp;78,  licenses and restrictions contained in BCP&nbsp;78,
# Line 10848  or other Line 12246  or other
12246  proprietary rights that may cover technology that may be required  proprietary rights that may cover technology that may be required
12247  to implement this standard.  to implement this standard.
12248  Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p>  Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p>
 <h3>Acknowledgment</h3>  
 <p class='copyright'>  
 Funding for the RFC Editor function is provided by  
 the IETF Administrative Support Activity (IASA).</p>  
12249  </body></html>  </body></html>
12250    
Legend:
Removed from v.1201  
changed lines
  Added in v.2023
  ViewVC Help
Powered by ViewVC