/[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 1390 by schoenebeck, Sun Oct 7 14:07:48 2007 UTC revision 1805 by schoenebeck, Wed Dec 10 22:10:17 2008 UTC
# Line 1  Line 1 
1  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2  <html lang="en"><head><title>LinuxSampler Control Protocol (draft)</title>  <html lang="en"><head><title>LinuxSampler Control Protocol</title>
3  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
4  <meta name="description" content="LinuxSampler Control Protocol (draft)">  <meta name="description" content="LinuxSampler Control Protocol">
5  <meta name="keywords" content="LSCP">  <meta name="keywords" content="LSCP">
6  <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">  <meta name="generator" content="xml2rfc v1.33 (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: April 9, 2008</td><td class="header">October 7, 2007</td></tr>  <tr><td class="header">Expires: June 13, 2009</td><td class="header">December 10, 2008</td></tr>
149  </table></td></tr></table>  </table></td></tr></table>
150  <h1><br />LinuxSampler Control Protocol (draft)<br />LSCP 1.2cvs</h1>  <h1><br />LinuxSampler Control Protocol<br />LSCP 1.4</h1>
151    
152  <h3>Status of this Memo</h3>  <h3>Status of this Memo</h3>
153  <p>  <p>
# Line 173  The list of current Internet-Drafts can Line 173  The list of current Internet-Drafts can
173  The list of Internet-Draft Shadow Directories can be accessed at  The list of Internet-Draft Shadow Directories can be accessed at
174  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>
175  <p>  <p>
176  This Internet-Draft will expire on April 9, 2008.</p>  This Internet-Draft will expire on June 13, 2009.</p>
   
 <h3>Copyright Notice</h3>  
 <p>  
 Copyright &copy; The IETF Trust (2007).</p>  
177    
178  <h3>Abstract</h3>  <h3>Abstract</h3>
179    
# 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;
# Line 434  Finding instruments<br /> Line 442  Finding instruments<br />
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;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a>&nbsp;
444  Formatting the instruments database<br />  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;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#editing_instruments">6.9.</a>&nbsp;
450  Editing Instruments<br />  Editing Instruments<br />
451  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#EDIT INSTRUMENT">6.9.1.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#EDIT INSTRUMENT">6.9.1.</a>&nbsp;
452  Opening an appropriate instrument editor application<br />  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;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#character_set">7.1.</a>&nbsp;
# Line 454  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 3449  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 3869  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 3954  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 3988  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 3996  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 4005  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 4012  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 4024  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 4033  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 5351  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 5708  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 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    </blockquote><p>
5811                        
5812    </p>
5813    <p>CAUTION: This command is provided for implementations of virtual MIDI keyboards
5814                        and no realtime guarantee whatsoever will be made!
5815    </p>
5816    <p>Possible Answers:
5817    </p>
5818    <p>
5819                            </p>
5820    <blockquote class="text">
5821    <p>"OK" -
5822                                    </p>
5823    <blockquote class="text">
5824    <p>on success
5825    </p>
5826    </blockquote>
5827                                
5828    
5829    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5830                                    </p>
5831    <blockquote class="text">
5832    <p>in case it failed, providing an appropriate error code and error message
5833    </p>
5834    </blockquote>
5835                                
5836    
5837    </blockquote><p>
5838                        
5839    </p>
5840    <p>Example:
5841    </p>
5842    <p>
5843                            </p>
5844    <blockquote class="text">
5845    <p>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"
5846    </p>
5847    <p>S: "OK"
5848    </p>
5849    </blockquote><p>
5850                        
5851    </p>
5852    <a name="RESET CHANNEL"></a><br /><hr />
5853    <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>
5854    <a name="rfc.section.6.4.35"></a><h3>6.4.35.&nbsp;
5855  Resetting a sampler channel</h3>  Resetting a sampler channel</h3>
5856    
5857  <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 6045  Maximum amount of active voices</h3> Line 6186  Maximum amount of active voices</h3>
6186  </blockquote><p>  </blockquote><p>
6187                                            
6188  </p>  </p>
6189  <a name="RESET"></a><br /><hr />  <a name="GET TOTAL_STREAM_COUNT"></a><br /><hr />
6190  <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>
6191  <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;
6192    Current number of active disk streams</h3>
6193    
6194    <p>The front-end can ask for the current number of active disk streams on
6195                        the sampler by sending the following command:
6196    </p>
6197    <p>
6198                            </p>
6199    <blockquote class="text">
6200    <p>GET TOTAL_STREAM_COUNT
6201    </p>
6202    </blockquote><p>
6203                        
6204    </p>
6205    <p>Possible Answers:
6206    </p>
6207    <p>
6208                            </p>
6209    <blockquote class="text">
6210    <p>LinuxSampler will answer by returning the number of all active
6211                                disk streams on the sampler.
6212    </p>
6213    </blockquote><p>
6214                        
6215    </p>
6216    <a name="RESET"></a><br /><hr />
6217    <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>
6218    <a name="rfc.section.6.6.4"></a><h3>6.6.4.&nbsp;
6219  Reset sampler</h3>  Reset sampler</h3>
6220    
6221  <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 6088  Reset sampler</h3> Line 6256  Reset sampler</h3>
6256  </p>  </p>
6257  <a name="GET SERVER INFO"></a><br /><hr />  <a name="GET SERVER INFO"></a><br /><hr />
6258  <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>
6259  <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;
6260  General sampler informations</h3>  General sampler informations</h3>
6261    
6262  <p>The client can ask for general informations about the LinuxSampler  <p>The client can ask for general informations about the LinuxSampler
# Line 6164  General sampler informations</h3> Line 6332  General sampler informations</h3>
6332  </p>  </p>
6333  <a name="GET VOLUME"></a><br /><hr />  <a name="GET VOLUME"></a><br /><hr />
6334  <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>
6335  <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;
6336  Getting global volume attenuation</h3>  Getting global volume attenuation</h3>
6337    
6338  <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 6197  Getting global volume attenuation</h3> Line 6365  Getting global volume attenuation</h3>
6365  </p>  </p>
6366  <a name="SET VOLUME"></a><br /><hr />  <a name="SET VOLUME"></a><br /><hr />
6367  <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>
6368  <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;
6369  Setting global volume attenuation</h3>  Setting global volume attenuation</h3>
6370    
6371  <p>The client can alter the current global sampler-wide volume  <p>The client can alter the current global sampler-wide volume
# Line 6250  Setting global volume attenuation</h3> Line 6418  Setting global volume attenuation</h3>
6418  </blockquote><p>  </blockquote><p>
6419                                            
6420  </p>  </p>
6421    <a name="GET VOICES"></a><br /><hr />
6422    <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>
6423    <a name="rfc.section.6.6.8"></a><h3>6.6.8.&nbsp;
6424    Getting global voice limit</h3>
6425    
6426    <p>The client can ask for the current global sampler-wide limit
6427                           for maximum voices by sending the following command:
6428    </p>
6429    <p>
6430                            </p>
6431    <blockquote class="text">
6432    <p>GET VOICES
6433    </p>
6434    </blockquote><p>
6435                        
6436    </p>
6437    <p>Possible Answers:
6438    </p>
6439    <p>
6440                            </p>
6441    <blockquote class="text">
6442    <p>LinuxSampler will answer by returning the number for
6443                                   the current limit of maximum voices.
6444    </p>
6445    </blockquote><p>
6446                        
6447    </p>
6448    <p>The voice limit setting defines how many voices should maximum
6449                           be processed by the sampler at the same time. If the user
6450                           triggers new notes which would exceed that voice limit, the
6451                           sampler engine will react by stealing old voices for those
6452                           newly triggered notes. Note that the amount of voices triggered
6453                           by a new note can be larger than one and is dependent to the
6454                           respective instrument and probably further criterias.
6455    </p>
6456    <a name="SET VOICES"></a><br /><hr />
6457    <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>
6458    <a name="rfc.section.6.6.9"></a><h3>6.6.9.&nbsp;
6459    Setting global voice limit</h3>
6460    
6461    <p>The client can alter the current global sampler-wide limit
6462                        for maximum voices by sending the following command:
6463    </p>
6464    <p>
6465                            </p>
6466    <blockquote class="text">
6467    <p>SET VOICES &lt;max-voices&gt;
6468    </p>
6469    </blockquote><p>
6470                        
6471    </p>
6472    <p>Where &lt;max-voices&gt; should be replaced by the integer
6473                       value, reflecting the new global amount limit of maximum voices.
6474                       This value has to be larger than 0.
6475    </p>
6476    <p>Possible Answers:
6477    </p>
6478    <p>
6479                            </p>
6480    <blockquote class="text">
6481    <p>"OK" -
6482                                    </p>
6483    <blockquote class="text">
6484    <p>on success
6485    </p>
6486    </blockquote>
6487                                
6488    
6489    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6490                                    </p>
6491    <blockquote class="text">
6492    <p>if the voice limit was set, but there are noteworthy
6493                                        issue(s) related, providing an appropriate warning code and
6494                                        warning message
6495    </p>
6496    </blockquote>
6497                                
6498    
6499    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6500                                    </p>
6501    <blockquote class="text">
6502    <p>in case it failed, providing an appropriate error code and error message
6503    </p>
6504    </blockquote>
6505                                
6506    
6507    </blockquote><p>
6508                        
6509    </p>
6510    <p>Note: the given value will be passed to all sampler engine instances.
6511                           The total amount of maximum voices on the running system might thus
6512                           be as big as the given value multiplied by the current amount of engine
6513                           instances.
6514    </p>
6515    <p>Caution: when adjusting the voice limit, you SHOULD also
6516                            adjust the disk stream limit respectively and vice versa.
6517    </p>
6518    <a name="GET STREAMS"></a><br /><hr />
6519    <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>
6520    <a name="rfc.section.6.6.10"></a><h3>6.6.10.&nbsp;
6521    Getting global disk stream limit</h3>
6522    
6523    <p>The client can ask for the current global sampler-wide limit
6524                           for maximum disk streams by sending the following command:
6525    </p>
6526    <p>
6527                            </p>
6528    <blockquote class="text">
6529    <p>GET STREAMS
6530    </p>
6531    </blockquote><p>
6532                        
6533    </p>
6534    <p>Possible Answers:
6535    </p>
6536    <p>
6537                            </p>
6538    <blockquote class="text">
6539    <p>LinuxSampler will answer by returning the number for
6540                                   the current limit of maximum disk streams.
6541    </p>
6542    </blockquote><p>
6543                        
6544    </p>
6545    <p>The disk stream limit setting defines how many disk streams should
6546                           maximum be processed by a sampler engine at the same time. The
6547                           higher this value, the more memory (RAM) will be occupied, since
6548                           every disk streams allocates a certain buffer size for being able
6549                           to perform its streaming operations.
6550    </p>
6551    <a name="SET STREAMS"></a><br /><hr />
6552    <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>
6553    <a name="rfc.section.6.6.11"></a><h3>6.6.11.&nbsp;
6554    Setting global disk stream limit</h3>
6555    
6556    <p>The client can alter the current global sampler-wide limit
6557                        for maximum disk streams by sending the following command:
6558    </p>
6559    <p>
6560                            </p>
6561    <blockquote class="text">
6562    <p>SET STREAMS &lt;max-streams&gt;
6563    </p>
6564    </blockquote><p>
6565                        
6566    </p>
6567    <p>Where &lt;max-streams&gt; should be replaced by the integer
6568                       value, reflecting the new global amount limit of maximum disk streams.
6569                       This value has to be positive.
6570    </p>
6571    <p>Possible Answers:
6572    </p>
6573    <p>
6574                            </p>
6575    <blockquote class="text">
6576    <p>"OK" -
6577                                    </p>
6578    <blockquote class="text">
6579    <p>on success
6580    </p>
6581    </blockquote>
6582                                
6583    
6584    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6585                                    </p>
6586    <blockquote class="text">
6587    <p>if the disk stream limit was set, but there are noteworthy
6588                                        issue(s) related, providing an appropriate warning code and
6589                                        warning message
6590    </p>
6591    </blockquote>
6592                                
6593    
6594    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6595                                    </p>
6596    <blockquote class="text">
6597    <p>in case it failed, providing an appropriate error code and error message
6598    </p>
6599    </blockquote>
6600                                
6601    
6602    </blockquote><p>
6603                        
6604    </p>
6605    <p>Note: the given value will be passed to all sampler engine instances.
6606                           The total amount of maximum disk streams on the running system might
6607                           thus be as big as the given value multiplied by the current amount of
6608                           engine instances.
6609    </p>
6610    <p>Caution: when adjusting the disk stream limit, you SHOULD also
6611                            adjust the voice limit respectively and vice versa.
6612    </p>
6613  <a name="MIDI Instrument Mapping"></a><br /><hr />  <a name="MIDI Instrument Mapping"></a><br /><hr />
6614  <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>
6615  <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;  <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;
# Line 6563  Getting MIDI instrument map information< Line 6923  Getting MIDI instrument map information<
6923  <blockquote class="text">  <blockquote class="text">
6924  <p>custom name of the given map,  <p>custom name of the given map,
6925                                              which does not have to be unique                                              which does not have to be unique
6926                                                (note that this character string may contain
6927                                                 <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
6928  </p>  </p>
6929  </blockquote>  </blockquote>
6930                                                                            
# Line 7111  Get current settings of MIDI instrument Line 7473  Get current settings of MIDI instrument
7473                                      changed with the                                      changed with the
7474                                      <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>
7475                                      command and does not have to be unique.                                      command and does not have to be unique.
7476                                        (note that this character string may contain
7477                                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
7478  </p>  </p>
7479  </blockquote>  </blockquote>
7480                                                            
# Line 7127  Get current settings of MIDI instrument Line 7491  Get current settings of MIDI instrument
7491  <p>"INSTRUMENT_FILE" -  <p>"INSTRUMENT_FILE" -
7492                                  </p>                                  </p>
7493  <blockquote class="text">  <blockquote class="text">
7494  <p>File name of the instrument.  <p>File name of the instrument
7495                                        (note that this path may contain
7496                                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>).
7497  </p>  </p>
7498  </blockquote>  </blockquote>
7499                                                            
# Line 7145  Get current settings of MIDI instrument Line 7511  Get current settings of MIDI instrument
7511  <blockquote class="text">  <blockquote class="text">
7512  <p>Name of the loaded instrument as reflected by its file.  <p>Name of the loaded instrument as reflected by its file.
7513                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
7514                                      cannot be changed.                                      cannot be changed (note that this character string may contain
7515                                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>).
7516  </p>  </p>
7517  </blockquote>  </blockquote>
7518                                                            
# Line 7989  Adding instruments to the instruments da Line 8356  Adding instruments to the instruments da
8356  <p>  <p>
8357                          </p>                          </p>
8358  <blockquote class="text">  <blockquote class="text">
8359  <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;]
8360  </p>  </p>
8361  </blockquote><p>  </blockquote><p>
8362                                            
# Line 8047  Adding instruments to the instruments da Line 8414  Adding instruments to the instruments da
8414  </blockquote><p>  </blockquote><p>
8415                                            
8416  </p>  </p>
8417    <p> If FILE_AS_DIR argument is supplied, all instruments in an instrument
8418                     file will be added to a separate directory in the instruments database, which
8419                     name will be the name of the instrument file with the file extension stripped off.
8420                    
8421    </p>
8422  <p>The difference between regular and NON_MODAL versions of the command  <p>The difference between regular and NON_MODAL versions of the command
8423                      is that the regular command returns when the scanning is finished                      is that the regular command returns when the scanning is finished
8424                      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 8651  Changing the description of instrument</ Line 9023  Changing the description of instrument</
9023                                            
9024  </p>  </p>
9025  <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
9026                      &lt;desc&gt; is the new description for the instrument                      &lt;desc&gt; is the new description for the instrument
9027                      (encapsulated into apostrophes, supporting escape sequences as described in chapter                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
9028                      "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").                      "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
9029  </p>  </p>
# Line 9033  Formatting the instruments database</h3> Line 9405  Formatting the instruments database</h3>
9405  </blockquote><p>  </blockquote><p>
9406                                            
9407  </p>  </p>
9408    <a name="FIND LOST DB_INSTRUMENT_FILES"></a><br /><hr />
9409    <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>
9410    <a name="rfc.section.6.8.23"></a><h3>6.8.23.&nbsp;
9411    Checking for lost instrument files</h3>
9412    
9413    <p>The front-end can retrieve the list of all instrument files in the instruments database
9414                        that don't exist in the filesystem by sending the following command:
9415    </p>
9416    <p>
9417                            </p>
9418    <blockquote class="text">
9419    <p>FIND LOST DB_INSTRUMENT_FILES
9420    </p>
9421    </blockquote><p>
9422                        
9423    </p>
9424    <p>Possible Answers:
9425    </p>
9426    <p>
9427                            </p>
9428    <blockquote class="text">
9429    <p>A comma separated list with the absolute path names
9430                                (encapsulated into apostrophes) of all lost instrument files.
9431    </p>
9432    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9433                                    </p>
9434    <blockquote class="text">
9435    <p>in case it failed, providing an appropriate error code and error message.
9436    </p>
9437    </blockquote>
9438                                
9439    
9440    </blockquote><p>
9441                        
9442    </p>
9443    <p>Example:
9444    </p>
9445    <p>
9446                            </p>
9447    <blockquote class="text">
9448    <p>C: "FIND LOST DB_INSTRUMENT_FILES"
9449    </p>
9450    <p>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"
9451    </p>
9452    </blockquote><p>
9453                        
9454    </p>
9455    <a name="SET DB_INSTRUMENT FILE_PATH"></a><br /><hr />
9456    <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>
9457    <a name="rfc.section.6.8.24"></a><h3>6.8.24.&nbsp;
9458    Replacing an instrument file</h3>
9459    
9460    <p>The front-end can substitute all occurrences of an instrument file
9461                        in the instruments database with a new one by sending the following command:
9462    </p>
9463    <p>
9464                            </p>
9465    <blockquote class="text">
9466    <p>SET DB_INSTRUMENT FILE_PATH &lt;old_path&gt; &lt;new_path&gt;
9467    </p>
9468    </blockquote><p>
9469                        
9470    </p>
9471    <p>Where &lt;old_path&gt; is the absolute path name of the instrument file
9472                        to substitute with &lt;new_path&gt;.
9473    </p>
9474    <p>Possible Answers:
9475    </p>
9476    <p>
9477                            </p>
9478    <blockquote class="text">
9479    <p>"OK" -
9480                                    </p>
9481    <blockquote class="text">
9482    <p>on success
9483    </p>
9484    </blockquote>
9485                                
9486    
9487    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9488                                    </p>
9489    <blockquote class="text">
9490    <p>in case it failed, providing an appropriate error code and error message.
9491    </p>
9492    </blockquote>
9493                                
9494    
9495    </blockquote><p>
9496                        
9497    </p>
9498    <p>Example:
9499    </p>
9500    <p>
9501                            </p>
9502    <blockquote class="text">
9503    <p>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"
9504    </p>
9505    <p>S: "OK"
9506    </p>
9507    </blockquote><p>
9508                        
9509    </p>
9510  <a name="editing_instruments"></a><br /><hr />  <a name="editing_instruments"></a><br /><hr />
9511  <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>
9512  <a name="rfc.section.6.9"></a><h3>6.9.&nbsp;  <a name="rfc.section.6.9"></a><h3>6.9.&nbsp;
# Line 9060  Opening an appropriate instrument editor Line 9534  Opening an appropriate instrument editor
9534  <p>  <p>
9535                          </p>                          </p>
9536  <blockquote class="text">  <blockquote class="text">
9537  <p>EDIT INSTRUMENT &lt;sampler-channel&gt;  <p>EDIT CHANNEL INSTRUMENT &lt;sampler-channel&gt;
9538  </p>  </p>
9539  </blockquote><p>  </blockquote><p>
9540                                            
# Line 9127  Opening an appropriate instrument editor Line 9601  Opening an appropriate instrument editor
9601  <p>  <p>
9602                          </p>                          </p>
9603  <blockquote class="text">  <blockquote class="text">
9604  <p>C: "EDIT INSTRUMENT 0"  <p>C: "EDIT CHANNEL INSTRUMENT 0"
9605  </p>  </p>
9606  <p>S: "OK"  <p>S: "OK"
9607  </p>  </p>
9608  </blockquote><p>  </blockquote><p>
9609                                            
9610  </p>  </p>
9611    <a name="file_management"></a><br /><hr />
9612    <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>
9613    <a name="rfc.section.6.10"></a><h3>6.10.&nbsp;
9614    Managing Files</h3>
9615    
9616    <p>You can query detailed informations about files located
9617                    at the same system where the sampler instance is running on.
9618                    Using this command set allows to retrieve file informations
9619                    even remotely from another machine.
9620    </p>
9621    <a name="GET FILE INSTRUMENTS"></a><br /><hr />
9622    <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>
9623    <a name="rfc.section.6.10.1"></a><h3>6.10.1.&nbsp;
9624    Retrieving amount of instruments of a file</h3>
9625    
9626    <p>The front-end can retrieve the amount of instruments
9627                        within a given instrument file by sending the
9628                        following command:
9629    </p>
9630    <p>
9631                            </p>
9632    <blockquote class="text">
9633    <p>GET FILE INSTRUMENTS &lt;filename&gt;
9634    </p>
9635    </blockquote><p>
9636                        
9637    </p>
9638    <p>Where &lt;filename&gt; is the name of the instrument
9639                        file (encapsulated into apostrophes, supporting escape
9640                        sequences as described in chapter
9641                        "<a class='info' href='#character_set'>Character Set and Escape
9642                            Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
9643    </p>
9644    <p>The sampler will try to ask all sampler engines,
9645                        whether they support the given file and ask the first
9646                        engine with a positive answer for the amount of
9647                        instruments.
9648    </p>
9649    <p>Possible Answers:
9650    </p>
9651    <p>
9652                            </p>
9653    <blockquote class="text">
9654    <p>On success, the sampler will answer by
9655                                   returning the amount of instruments.
9656                                
9657    </p>
9658    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9659                                    </p>
9660    <blockquote class="text">
9661    <p>if the file could not be handled
9662    </p>
9663    </blockquote>
9664                                
9665    
9666    </blockquote><p>
9667                        
9668    </p>
9669    <p>Examples:
9670    </p>
9671    <p>
9672                            </p>
9673    <blockquote class="text">
9674    <p>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
9675    </p>
9676    <p>S: "10"
9677    </p>
9678    </blockquote><p>
9679                        
9680    </p>
9681    <a name="LIST FILE INSTRUMENTS"></a><br /><hr />
9682    <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>
9683    <a name="rfc.section.6.10.2"></a><h3>6.10.2.&nbsp;
9684    Retrieving all instruments of a file</h3>
9685    
9686    <p>The front-end can retrieve a list of all instruments
9687                        within a given instrument file by sending the
9688                        following command:
9689    </p>
9690    <p>
9691                            </p>
9692    <blockquote class="text">
9693    <p>LIST FILE INSTRUMENTS &lt;filename&gt;
9694    </p>
9695    </blockquote><p>
9696                        
9697    </p>
9698    <p>Where &lt;filename&gt; is the name of the instrument
9699                        file (encapsulated into apostrophes, supporting escape
9700                        sequences as described in chapter
9701                        "<a class='info' href='#character_set'>Character Set and Escape
9702                            Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
9703    </p>
9704    <p>The sampler will try to ask all sampler engines,
9705                        whether they support the given file and ask the first
9706                        engine with a positive answer for a list of IDs for the
9707                        instruments in the given file.
9708    </p>
9709    <p>Possible Answers:
9710    </p>
9711    <p>
9712                            </p>
9713    <blockquote class="text">
9714    <p>On success, the sampler will answer by
9715                                   returning a comma separated list of
9716                                   instrument IDs.
9717                                
9718    </p>
9719    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9720                                    </p>
9721    <blockquote class="text">
9722    <p>if the file could not be handled
9723    </p>
9724    </blockquote>
9725                                
9726    
9727    </blockquote><p>
9728                        
9729    </p>
9730    <p>Examples:
9731    </p>
9732    <p>
9733                            </p>
9734    <blockquote class="text">
9735    <p>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
9736    </p>
9737    <p>S: "0,1,2,3,4,5,6,7,8,9"
9738    </p>
9739    </blockquote><p>
9740                        
9741    </p>
9742    <a name="GET FILE INSTRUMENT INFO"></a><br /><hr />
9743    <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>
9744    <a name="rfc.section.6.10.3"></a><h3>6.10.3.&nbsp;
9745    Retrieving informations about one instrument in a file</h3>
9746    
9747    <p>The front-end can retrieve detailed informations
9748                        about a specific instrument within a given instrument
9749                        file by sending the following command:
9750    </p>
9751    <p>
9752                            </p>
9753    <blockquote class="text">
9754    <p>GET FILE INSTRUMENT INFO &lt;filename&gt;
9755                                &lt;instr-id&gt;
9756    </p>
9757    </blockquote><p>
9758                        
9759    </p>
9760    <p>Where &lt;filename&gt; is the name of the instrument
9761                        file (encapsulated into apostrophes, supporting escape
9762                        sequences as described in chapter
9763                        "<a class='info' href='#character_set'>Character Set and Escape
9764                            Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") and &lt;instr-id&gt; is the numeric
9765                        instrument ID as returned by the
9766                        <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.
9767    </p>
9768    <p>The sampler will try to ask all sampler engines,
9769                        whether they support the given file and ask the first
9770                        engine with a positive answer for informations about the
9771                        specific instrument in the given file.
9772    </p>
9773    <p>Possible Answers:
9774    </p>
9775    <p>
9776                            </p>
9777    <blockquote class="text">
9778    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
9779                                Each answer line begins with the settings category name
9780                                followed by a colon and then a space character &lt;SP&gt; and finally
9781                                the info character string to that setting category. At the
9782                                moment the following categories are defined:
9783    </p>
9784    <p>
9785                                    </p>
9786    <blockquote class="text">
9787    <p>NAME -
9788                                            </p>
9789    <blockquote class="text">
9790    <p>name of the instrument as
9791                                                stored in the instrument file
9792    </p>
9793    </blockquote>
9794                                        
9795    
9796    <p>FORMAT_FAMILY -
9797                                            </p>
9798    <blockquote class="text">
9799    <p>name of the sampler format
9800                                                of the given instrument
9801    </p>
9802    </blockquote>
9803                                        
9804    
9805    <p>FORMAT_VERSION -
9806                                            </p>
9807    <blockquote class="text">
9808    <p>version of the sampler format
9809                                                the instrumen is stored as
9810    </p>
9811    </blockquote>
9812                                        
9813    
9814    <p>PRODUCT -
9815                                            </p>
9816    <blockquote class="text">
9817    <p>official product name of the
9818                                                instrument as stored in the file
9819                                                
9820    </p>
9821    </blockquote>
9822                                        
9823    
9824    <p>ARTISTS -
9825                                            </p>
9826    <blockquote class="text">
9827    <p>artists / sample library
9828                                                vendor of the instrument
9829    </p>
9830    </blockquote>
9831                                        
9832    
9833    <p>KEY_BINDINGS -
9834                                            </p>
9835    <blockquote class="text">
9836    <p>comma separated list of integer values representing
9837                                                   the instrument's key mapping in the range between 0 .. 127,
9838                                                   reflecting the analog meaning of the MIDI specification.
9839    </p>
9840    </blockquote>
9841                                        
9842    
9843    <p>KEYSWITCH_BINDINGS -
9844                                            </p>
9845    <blockquote class="text">
9846    <p>comma separated list of integer values representing
9847                                                   the instrument's keyswitch mapping in the range between 0 .. 127,
9848                                                   reflecting the analog meaning of the MIDI specification.
9849    </p>
9850    </blockquote>
9851                                        
9852    
9853    </blockquote>
9854                                
9855    
9856    </blockquote><p>
9857                        
9858    </p>
9859    <p>The mentioned fields above don't have to be in particular order.
9860    </p>
9861    <p>Example:
9862    </p>
9863    <p>
9864                            </p>
9865    <blockquote class="text">
9866    <p>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"
9867    </p>
9868    <p>S: "NAME: Lunatic Loops"
9869    </p>
9870    <p>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"
9871    </p>
9872    <p>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 3"
9873    </p>
9874    <p>&nbsp;&nbsp;&nbsp;"PRODUCT: The Backbone Bongo Beats"
9875    </p>
9876    <p>&nbsp;&nbsp;&nbsp;"ARTISTS: Jimmy the Fish"
9877    </p>
9878    <p>&nbsp;&nbsp;&nbsp;"."
9879    </p>
9880    </blockquote><p>
9881                        
9882    </p>
9883  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
9884  <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>
9885  <a name="rfc.section.7"></a><h3>7.&nbsp;  <a name="rfc.section.7"></a><h3>7.&nbsp;
# Line 9255  Command Syntax</h3> Line 10001  Command Syntax</h3>
10001  <p>/ FORMAT SP format_instruction  <p>/ FORMAT SP format_instruction
10002                                    
10003  </p>  </p>
10004    <p>/ SEND SP send_instruction
10005                    
10006    </p>
10007  <p>/ RESET  <p>/ RESET
10008                                    
10009  </p>  </p>
# Line 9276  Command Syntax</h3> Line 10025  Command Syntax</h3>
10025  <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename  <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
10026                                    
10027  </p>  </p>
10028    <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename
10029                    
10030    </p>
10031  <p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename  <p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
10032                                    
10033  </p>  </p>
10034    <p>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename
10035                    
10036    </p>
10037  <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename  <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
10038                                    
10039  </p>  </p>
# Line 9318  Command Syntax</h3> Line 10073  Command Syntax</h3>
10073  <p>/ CHANNEL_COUNT  <p>/ CHANNEL_COUNT
10074                                    
10075  </p>  </p>
10076    <p>/ CHANNEL_MIDI
10077                    
10078    </p>
10079    <p>/ DEVICE_MIDI
10080                    
10081    </p>
10082  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
10083                                    
10084  </p>  </p>
# Line 9366  Command Syntax</h3> Line 10127  Command Syntax</h3>
10127  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
10128                                    
10129  </p>  </p>
10130    <p>/ TOTAL_STREAM_COUNT
10131                    
10132    </p>
10133  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
10134                                    
10135  </p>  </p>
# Line 9393  Command Syntax</h3> Line 10157  Command Syntax</h3>
10157  <p>/ CHANNEL_COUNT  <p>/ CHANNEL_COUNT
10158                                    
10159  </p>  </p>
10160    <p>/ CHANNEL_MIDI
10161                    
10162    </p>
10163    <p>/ DEVICE_MIDI
10164                    
10165    </p>
10166  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
10167                                    
10168  </p>  </p>
# Line 9441  Command Syntax</h3> Line 10211  Command Syntax</h3>
10211  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
10212                                    
10213  </p>  </p>
10214    <p>/ TOTAL_STREAM_COUNT
10215                    
10216    </p>
10217  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
10218                                    
10219  </p>  </p>
# Line 9576  Command Syntax</h3> Line 10349  Command Syntax</h3>
10349  <p>/ SERVER SP INFO  <p>/ SERVER SP INFO
10350                                    
10351  </p>  </p>
10352    <p>/ TOTAL_STREAM_COUNT
10353                    
10354    </p>
10355  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
10356                                    
10357  </p>  </p>
# Line 9627  Command Syntax</h3> Line 10403  Command Syntax</h3>
10403  <p>/ VOLUME  <p>/ VOLUME
10404                                    
10405  </p>  </p>
10406    <p>/ VOICES
10407                    
10408    </p>
10409    <p>/ STREAMS
10410                    
10411    </p>
10412    <p>/ FILE SP INSTRUMENTS SP filename
10413                    
10414    </p>
10415    <p>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
10416                    
10417    </p>
10418  </blockquote><p>  </blockquote><p>
10419    
10420  </p>  </p>
# Line 9678  Command Syntax</h3> Line 10466  Command Syntax</h3>
10466  <p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped  <p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
10467                                    
10468  </p>  </p>
10469    <p>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename
10470                    
10471    </p>
10472  <p>/ ECHO SP boolean  <p>/ ECHO SP boolean
10473                                    
10474  </p>  </p>
10475  <p>/ VOLUME SP volume_value  <p>/ VOLUME SP volume_value
10476                                    
10477  </p>  </p>
10478    <p>/ VOICES SP number
10479                    
10480    </p>
10481    <p>/ STREAMS SP number
10482                    
10483    </p>
10484  </blockquote><p>  </blockquote><p>
10485    
10486  </p>  </p>
# Line 9747  Command Syntax</h3> Line 10544  Command Syntax</h3>
10544  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
10545                                    
10546  </p>  </p>
10547    <p>/ LOST SP DB_INSTRUMENT_FILES
10548                    
10549    </p>
10550  </blockquote><p>  </blockquote><p>
10551    
10552  </p>  </p>
# Line 9852  Command Syntax</h3> Line 10652  Command Syntax</h3>
10652  <p>edit_instruction =  <p>edit_instruction =
10653          </p>          </p>
10654  <blockquote class="text">  <blockquote class="text">
10655  <p>INSTRUMENT SP sampler_channel  <p>CHANNEL SP INSTRUMENT SP sampler_channel
10656                                    
10657  </p>  </p>
10658  </blockquote><p>  </blockquote><p>
# Line 9948  Command Syntax</h3> Line 10748  Command Syntax</h3>
10748  <p>/ DB_INSTRUMENTS SP db_path  <p>/ DB_INSTRUMENTS SP db_path
10749                                    
10750  </p>  </p>
10751    <p>/ FILE SP INSTRUMENTS SP filename
10752                    
10753    </p>
10754    </blockquote><p>
10755    
10756    </p>
10757    <p>send_instruction =
10758            </p>
10759    <blockquote class="text">
10760    <p>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number
10761                    
10762    </p>
10763  </blockquote><p>  </blockquote><p>
10764    
10765  </p>  </p>
# Line 10299  Character Set and Escape Sequences</h3> Line 11111  Character Set and Escape Sequences</h3>
11111  <td align="left">two digit hex ASCII code of the character</td>  <td align="left">two digit hex ASCII code of the character</td>
11112  </tr>  </tr>
11113  </table>  </table>
11114    <br clear="all" />
11115    
11116  <p>Notice: due to the transition of certain parts of the  <p>Notice: due to the transition of certain parts of the
11117                  protocol which now support escape sequences, a slight backward                  protocol which now support escape sequences, a slight backward
# Line 10309  Character Set and Escape Sequences</h3> Line 11122  Character Set and Escape Sequences</h3>
11122                  in the old versions a single backslash was sufficient.                  in the old versions a single backslash was sufficient.
11123  </p>  </p>
11124  <p>The following LSCP commands support escape sequences as part  <p>The following LSCP commands support escape sequences as part
11125                  of their filename / path based arguments:                  of their filename / path based arguments and / or may contain
11126                    a filename / path with escape sequences in their response:
11127                  </p>                  </p>
11128  <blockquote class="text">  <blockquote class="text">
11129  <p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a>  <p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a>
11130  </p>  </p>
11131    <p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
11132    </p>
11133  <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>  <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>
11134  </p>  </p>
11135    <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>
11136    </p>
11137  <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>  <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>
11138  </p>  </p>
11139  <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>  <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>
# Line 10356  Character Set and Escape Sequences</h3> Line 11174  Character Set and Escape Sequences</h3>
11174  </p>  </p>
11175  <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>  <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>
11176  </p>  </p>
11177    <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>
11178    </p>
11179    <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>
11180    </p>
11181    <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>
11182    </p>
11183    <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>
11184    </p>
11185    <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>
11186    </p>
11187  </blockquote><p>  </blockquote><p>
11188                  Note that the forward slash character ('/') has a special meaning in                  Note that the forward slash character ('/') has a special meaning in
11189                  filename / path based arguments: it acts as separator of the nodes in                  filename / path based arguments: it acts as separator of the nodes in
# Line 10366  Character Set and Escape Sequences</h3> Line 11194  Character Set and Escape Sequences</h3>
11194                                    
11195  </p>  </p>
11196  <p>  <p>
11197                    Note for Windows: file path arguments in LSCP are expected
11198                    to use forward slashes as directory node separator similar
11199                    to Unix based operating systems. In contrast to Unix however
11200                    a Windows typical drive character is expected to be
11201                    prefixed to the path. That is an original Windows file path
11202                    like "D:\Sounds\My.gig" would become in LSCP:
11203                    "D:/Sounds/My.gig".
11204                    
11205    </p>
11206    <p>
11207                  The following LSCP commands even support escape sequences as                  The following LSCP commands even support escape sequences as
11208                  part of at least one of their text-based arguments (i.e. entity name,                  part of at least one of their text-based arguments (i.e. entity name,
11209                  description):                  description) and / or may contain escape sequences in at least one of
11210                    their text-based fields in their response:
11211                  </p>                  </p>
11212  <blockquote class="text">  <blockquote class="text">
11213    <p><a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a>
11214    </p>
11215    <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>
11216    </p>
11217    <p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
11218    </p>
11219    <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>
11220    </p>
11221    <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>
11222    </p>
11223    <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>
11224    </p>
11225    <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>
11226    </p>
11227    <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>
11228    </p>
11229  <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>  <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>
11230  </p>  </p>
11231  <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>  <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>
11232  </p>  </p>
11233  <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>  <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>
11234  </p>  </p>
11235    <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>
11236    </p>
11237  <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>  <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>
11238  </p>  </p>
11239  <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>  <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>
11240  </p>  </p>
11241    <p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a>
11242    </p>
11243    <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>
11244    </p>
11245  <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>  <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>
11246  </p>  </p>
11247  <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>  <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>
11248  </p>  </p>
11249  <p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a>  <p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a>
11250  </p>  </p>
11251  </blockquote><p>  </blockquote><p>
11252                  Please note that these lists are manually maintained. If you                  Please note that these lists are manually maintained. If you
# Line 10553  Number of sampler channels changed</h3> Line 11414  Number of sampler channels changed</h3>
11414  <p>where &lt;channels&gt; will be replaced by the new number  <p>where &lt;channels&gt; will be replaced by the new number
11415                  of sampler channels.                  of sampler channels.
11416  </p>  </p>
11417  <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE CHANNEL_MIDI"></a><br /><hr />
11418  <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>
11419  <a name="rfc.section.8.6"></a><h3>8.6.&nbsp;  <a name="rfc.section.8.6"></a><h3>8.6.&nbsp;
11420    MIDI data on a sampler channel arrived</h3>
11421    
11422    <p>Client may want to be notified when MIDI data arrive on sampler channels on
11423                    back-end side, by issuing the following command:
11424    </p>
11425    <p>
11426                        </p>
11427    <blockquote class="text">
11428    <p>SUBSCRIBE CHANNEL_MIDI
11429    </p>
11430    </blockquote><p>
11431                    
11432    </p>
11433    <p>Server will start sending one of the the following notification messages:
11434    </p>
11435    <p>
11436                        </p>
11437    <blockquote class="text">
11438    <p>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_ON  &lt;note&gt; &lt;velocity&gt;"
11439    </p>
11440    <p>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"
11441    </p>
11442    </blockquote><p>
11443                    
11444    </p>
11445    <p>where &lt;channel-id&gt; will be replaced by the ID of the sampler channel where the MIDI
11446                    data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
11447                    0 .. 127, reflecting the analog meaning of the MIDI specification.
11448                    
11449    </p>
11450    <p>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
11451                    delivered by this mechanism! With other words: events could be lost at any time!
11452                    This restriction was made to keep the RT-safeness of the backend's MIDI and audio
11453                    thread unaffected by this feature.
11454    </p>
11455    <a name="SUBSCRIBE DEVICE_MIDI"></a><br /><hr />
11456    <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>
11457    <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;
11458    MIDI data on a MIDI input device arrived</h3>
11459    
11460    <p>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:
11461    </p>
11462    <p>
11463                                </p>
11464    <blockquote class="text">
11465    <p>SUBSCRIBE DEVICE_MIDI
11466    </p>
11467    </blockquote><p>
11468                        
11469    </p>
11470    <p>Server will start sending one of the the following notification messages:
11471    </p>
11472    <p>
11473                                </p>
11474    <blockquote class="text">
11475    <p>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_ON &lt;note&gt; &lt;velocity&gt;"
11476    </p>
11477    <p>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"
11478    </p>
11479    </blockquote><p>
11480                        
11481    </p>
11482    <p>where &lt;device-id&gt; &lt;port-id&gt; will be replaced
11483                           by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI
11484                           data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
11485                           0 .. 127, reflecting the analog meaning of the MIDI specification.
11486                        
11487    </p>
11488    <p>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
11489                           delivered by this mechanism! With other words: events could be lost at any time!
11490                           This restriction was made to keep the RT-safeness of the backend's MIDI and audio
11491                           thread unaffected by this feature.
11492    </p>
11493    <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />
11494    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11495    <a name="rfc.section.8.8"></a><h3>8.8.&nbsp;
11496  Number of active voices changed</h3>  Number of active voices changed</h3>
11497    
11498  <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 10585  Number of active voices changed</h3> Line 11522  Number of active voices changed</h3>
11522  </p>  </p>
11523  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />
11524  <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>
11525  <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;  <a name="rfc.section.8.9"></a><h3>8.9.&nbsp;
11526  Number of active disk streams changed</h3>  Number of active disk streams changed</h3>
11527    
11528  <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 10615  Number of active disk streams changed</h Line 11552  Number of active disk streams changed</h
11552  </p>  </p>
11553  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />
11554  <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>
11555  <a name="rfc.section.8.8"></a><h3>8.8.&nbsp;  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
11556  Disk stream buffer fill state changed</h3>  Disk stream buffer fill state changed</h3>
11557    
11558  <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 10646  Disk stream buffer fill state changed</h Line 11583  Disk stream buffer fill state changed</h
11583  </p>  </p>
11584  <a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr />  <a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr />
11585  <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>
11586  <a name="rfc.section.8.9"></a><h3>8.9.&nbsp;  <a name="rfc.section.8.11"></a><h3>8.11.&nbsp;
11587  Channel information changed</h3>  Channel information changed</h3>
11588    
11589  <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 10679  Channel information changed</h3> Line 11616  Channel information changed</h3>
11616  </p>  </p>
11617  <a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr />  <a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr />
11618  <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>
11619  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;  <a name="rfc.section.8.12"></a><h3>8.12.&nbsp;
11620  Number of effect sends changed</h3>  Number of effect sends changed</h3>
11621    
11622  <p>Client may want to be notified when the number of effect sends on  <p>Client may want to be notified when the number of effect sends on
# Line 10709  Number of effect sends changed</h3> Line 11646  Number of effect sends changed</h3>
11646  </p>  </p>
11647  <a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr />  <a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr />
11648  <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>
11649  <a name="rfc.section.8.11"></a><h3>8.11.&nbsp;  <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;
11650  Effect send information changed</h3>  Effect send information changed</h3>
11651    
11652  <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 10739  Effect send information changed</h3> Line 11676  Effect send information changed</h3>
11676  </p>  </p>
11677  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />
11678  <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>
11679  <a name="rfc.section.8.12"></a><h3>8.12.&nbsp;  <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;
11680  Total number of active voices changed</h3>  Total number of active voices changed</h3>
11681    
11682  <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 10766  Total number of active voices changed</h Line 11703  Total number of active voices changed</h
11703  <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
11704                  all currently active voices.                  all currently active voices.
11705  </p>  </p>
11706    <a name="SUBSCRIBE TOTAL_STREAM_COUNT"></a><br /><hr />
11707    <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>
11708    <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;
11709    Total number of active disk streams changed</h3>
11710    
11711    <p>Client may want to be notified when the total number of disk streams on the
11712                    back-end changes by issuing the following command:
11713    </p>
11714    <p>
11715                        </p>
11716    <blockquote class="text">
11717    <p>SUBSCRIBE TOTAL_STREAM_COUNT
11718    </p>
11719    </blockquote><p>
11720                    
11721    </p>
11722    <p>Server will start sending the following notification messages:
11723    </p>
11724    <p>
11725                        </p>
11726    <blockquote class="text">
11727    <p>"NOTIFY:TOTAL_STREAM_COUNT:&lt;streams&gt;"
11728    </p>
11729    </blockquote><p>
11730                    
11731    </p>
11732    <p>where &lt;streams&gt; will be replaced by the new number of
11733                    all currently active disk streams.
11734    </p>
11735  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr />  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr />
11736  <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>
11737  <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;  <a name="rfc.section.8.16"></a><h3>8.16.&nbsp;
11738  Number of MIDI instrument maps changed</h3>  Number of MIDI instrument maps changed</h3>
11739    
11740  <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 10797  Number of MIDI instrument maps changed</ Line 11763  Number of MIDI instrument maps changed</
11763  </p>  </p>
11764  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr />  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr />
11765  <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>
11766  <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;  <a name="rfc.section.8.17"></a><h3>8.17.&nbsp;
11767  MIDI instrument map information changed</h3>  MIDI instrument map information changed</h3>
11768    
11769  <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 10830  MIDI instrument map information changed< Line 11796  MIDI instrument map information changed<
11796  </p>  </p>
11797  <a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr />  <a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr />
11798  <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>
11799  <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;  <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;
11800  Number of MIDI instruments changed</h3>  Number of MIDI instruments changed</h3>
11801    
11802  <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 10860  Number of MIDI instruments changed</h3> Line 11826  Number of MIDI instruments changed</h3>
11826  </p>  </p>
11827  <a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr />  <a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr />
11828  <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>
11829  <a name="rfc.section.8.16"></a><h3>8.16.&nbsp;  <a name="rfc.section.8.19"></a><h3>8.19.&nbsp;
11830  MIDI instrument information changed</h3>  MIDI instrument information changed</h3>
11831    
11832  <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 10894  MIDI instrument information changed</h3> Line 11860  MIDI instrument information changed</h3>
11860  </p>  </p>
11861  <a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr />  <a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr />
11862  <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>
11863  <a name="rfc.section.8.17"></a><h3>8.17.&nbsp;  <a name="rfc.section.8.20"></a><h3>8.20.&nbsp;
11864  Global settings changed</h3>  Global settings changed</h3>
11865    
11866  <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 10919  Global settings changed</h3> Line 11885  Global settings changed</h3>
11885                          new global volume parameter.                          new global volume parameter.
11886  </p>  </p>
11887  </blockquote><p>  </blockquote><p>
11888                        </p>
11889    <blockquote class="text">
11890    <p>"NOTIFY:GLOBAL_INFO:VOICES &lt;max-voices&gt;" - Notifies that the
11891                            golbal limit of the sampler for maximum voices is changed, where
11892                            &lt;max-voices&gt; will be an integer value, reflecting the
11893                            new global voice limit parameter.
11894    </p>
11895    </blockquote><p>
11896                        </p>
11897    <blockquote class="text">
11898    <p>"NOTIFY:GLOBAL_INFO:STREAMS &lt;max-streams&gt;" - Notifies that the
11899                            golbal limit of the sampler for maximum disk streams is changed, where
11900                            &lt;max-streams&gt; will be an integer value, reflecting the
11901                            new global disk streams limit parameter.
11902    </p>
11903    </blockquote><p>
11904                                    
11905  </p>  </p>
11906  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />
11907  <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>
11908  <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;  <a name="rfc.section.8.21"></a><h3>8.21.&nbsp;
11909  Number of database instrument directories changed</h3>  Number of database instrument directories changed</h3>
11910    
11911  <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 10957  Number of database instrument directorie Line 11939  Number of database instrument directorie
11939  </p>  </p>
11940  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr />
11941  <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>
11942  <a name="rfc.section.8.19"></a><h3>8.19.&nbsp;  <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;
11943  Database instrument directory information changed</h3>  Database instrument directory information changed</h3>
11944    
11945  <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 11002  Database instrument directory informatio Line 11984  Database instrument directory informatio
11984  </p>  </p>
11985  <a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr />
11986  <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>
11987  <a name="rfc.section.8.20"></a><h3>8.20.&nbsp;  <a name="rfc.section.8.23"></a><h3>8.23.&nbsp;
11988  Number of database instruments changed</h3>  Number of database instruments changed</h3>
11989    
11990  <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 11036  Number of database instruments changed</ Line 12018  Number of database instruments changed</
12018  </p>  </p>
12019  <a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr />
12020  <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>
12021  <a name="rfc.section.8.21"></a><h3>8.21.&nbsp;  <a name="rfc.section.8.24"></a><h3>8.24.&nbsp;
12022  Database instrument information changed</h3>  Database instrument information changed</h3>
12023    
12024  <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 11081  Database instrument information changed< Line 12063  Database instrument information changed<
12063  </p>  </p>
12064  <a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr />
12065  <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>
12066  <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;  <a name="rfc.section.8.25"></a><h3>8.25.&nbsp;
12067  Database job status information changed</h3>  Database job status information changed</h3>
12068    
12069  <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 11114  Database job status information changed< Line 12096  Database job status information changed<
12096  </p>  </p>
12097  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
12098  <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>
12099  <a name="rfc.section.8.23"></a><h3>8.23.&nbsp;  <a name="rfc.section.8.26"></a><h3>8.26.&nbsp;
12100  Miscellaneous and debugging events</h3>  Miscellaneous and debugging events</h3>
12101    
12102  <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 11180  Acknowledgments</h3> Line 12162  Acknowledgments</h3>
12162  <h3>11.&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
12163  <table width="99%" border="0">  <table width="99%" border="0">
12164  <tr><td class="author-text" valign="top"><a name="RFC20">[RFC20]</a></td>  <tr><td class="author-text" valign="top"><a name="RFC20">[RFC20]</a></td>
12165  <td class="author-text">UCLA, &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc20.txt">ASCII format for Network Interchange</a>,&rdquo; RFC&nbsp;20, 1969.</td></tr>  <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>
12166  <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>
12167  <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>
12168  <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>
12169  <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>
12170  <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>
12171  <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>
12172  </table>  </table>
12173    
12174  <a name="rfc.authors"></a><br /><hr />  <a name="rfc.authors"></a><br /><hr />
# Line 11211  Schoenebeck</td></tr> Line 12193  Schoenebeck</td></tr>
12193  <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>
12194  <h3>Full Copyright Statement</h3>  <h3>Full Copyright Statement</h3>
12195  <p class='copyright'>  <p class='copyright'>
12196  Copyright &copy; The IETF Trust (2007).</p>  Copyright &copy; The IETF Trust (2008).</p>
12197  <p class='copyright'>  <p class='copyright'>
12198  This document is subject to the rights,  This document is subject to the rights,
12199  licenses and restrictions contained in BCP&nbsp;78,  licenses and restrictions contained in BCP&nbsp;78,
# Line 11253  or other Line 12235  or other
12235  proprietary rights that may cover technology that may be required  proprietary rights that may cover technology that may be required
12236  to implement this standard.  to implement this standard.
12237  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>  
12238  </body></html>  </body></html>
12239    
Legend:
Removed from v.1390  
changed lines
  Added in v.1805
  ViewVC Help
Powered by ViewVC