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

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

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

revision 1363 by schoenebeck, Sun Sep 30 21:51:14 2007 UTC revision 1696 by schoenebeck, Sat Feb 16 01:16:39 2008 UTC
# Line 1  Line 1 
1  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2  <html lang="en"><head><title>LinuxSampler Control Protocol (draft)</title>  <html lang="en"><head><title>LinuxSampler Control Protocol</title>
3  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
4  <meta name="description" content="LinuxSampler Control Protocol (draft)">  <meta name="description" content="LinuxSampler Control Protocol">
5  <meta name="keywords" content="LSCP">  <meta name="keywords" content="LSCP">
6  <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">  <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">
7  <style type='text/css'><!--  <style type='text/css'><!--
# Line 145  Line 145 
145  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>
146  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>
147  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>
148  <tr><td class="header">Expires: March 4, 2008</td><td class="header">September 2007</td></tr>  <tr><td class="header">Expires: August 19, 2008</td><td class="header">February 16, 2008</td></tr>
149  </table></td></tr></table>  </table></td></tr></table>
150  <h1><br />LinuxSampler Control Protocol (draft)<br />LSCP 1.2cvs</h1>  <h1><br />LinuxSampler Control Protocol<br />LSCP 1.4</h1>
151    
152  <h3>Status of this Memo</h3>  <h3>Status of this Memo</h3>
153  <p>  <p>
# Line 173  The list of current Internet-Drafts can Line 173  The list of current Internet-Drafts can
173  The list of Internet-Draft Shadow Directories can be accessed at  The list of Internet-Draft Shadow Directories can be accessed at
174  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>
175  <p>  <p>
176  This Internet-Draft will expire on March 4, 2008.</p>  This Internet-Draft will expire on August 19, 2008.</p>
177    
178  <h3>Copyright Notice</h3>  <h3>Copyright Notice</h3>
179  <p>  <p>
180  Copyright &copy; The IETF Trust (2007).</p>  Copyright &copy; The IETF Trust (2008).</p>
181    
182  <h3>Abstract</h3>  <h3>Abstract</h3>
183    
# Line 354  Global commands<br /> Line 354  Global commands<br />
354  Current number of active voices<br />  Current number of active voices<br />
355  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a>&nbsp;
356  Maximum amount of active voices<br />  Maximum amount of active voices<br />
357  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET">6.6.3.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET TOTAL_STREAM_COUNT">6.6.3.</a>&nbsp;
358    Current number of active disk streams<br />
359    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET">6.6.4.</a>&nbsp;
360  Reset sampler<br />  Reset sampler<br />
361  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.4.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.5.</a>&nbsp;
362  General sampler informations<br />  General sampler informations<br />
363  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET VOLUME">6.6.5.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET VOLUME">6.6.6.</a>&nbsp;
364  Getting global volume attenuation<br />  Getting global volume attenuation<br />
365  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOLUME">6.6.6.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOLUME">6.6.7.</a>&nbsp;
366  Setting global volume attenuation<br />  Setting global volume attenuation<br />
367  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#MIDI Instrument Mapping">6.7.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#MIDI Instrument Mapping">6.7.</a>&nbsp;
368  MIDI Instrument Mapping<br />  MIDI Instrument Mapping<br />
369  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD MIDI_INSTRUMENT MAP">6.7.1.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a>&nbsp;
370  Create a new MIDI instrument map<br />  Create a new MIDI instrument map<br />
371  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a>&nbsp;
372  Delete one particular or all MIDI instrument maps<br />  Delete one particular or all MIDI instrument maps<br />
# Line 438  Formatting the instruments database<br / Line 440  Formatting the instruments database<br /
440  Editing Instruments<br />  Editing Instruments<br />
441  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#EDIT INSTRUMENT">6.9.1.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#EDIT INSTRUMENT">6.9.1.</a>&nbsp;
442  Opening an appropriate instrument editor application<br />  Opening an appropriate instrument editor application<br />
443    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#file_management">6.10.</a>&nbsp;
444    Managing Files<br />
445    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FILE INSTRUMENTS">6.10.1.</a>&nbsp;
446    Retrieving amount of instruments of a file<br />
447    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST FILE INSTRUMENTS">6.10.2.</a>&nbsp;
448    Retrieving all instruments of a file<br />
449    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FILE INSTRUMENT INFO">6.10.3.</a>&nbsp;
450    Retrieving informations about one instrument in a file<br />
451  <a href="#command_syntax">7.</a>&nbsp;  <a href="#command_syntax">7.</a>&nbsp;
452  Command Syntax<br />  Command Syntax<br />
453  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#character_set">7.1.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#character_set">7.1.</a>&nbsp;
# Line 454  Number of MIDI input devices changed<br Line 464  Number of MIDI input devices changed<br
464  MIDI input device's settings changed<br />  MIDI input device's settings changed<br />
465  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a>&nbsp;
466  Number of sampler channels changed<br />  Number of sampler channels changed<br />
467  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.6.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_MIDI">8.6.</a>&nbsp;
468    MIDI data on a sampler channel arrived<br />
469    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DEVICE_MIDI">8.7.</a>&nbsp;
470    MIDI data on a MIDI input device arrived<br />
471    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.8.</a>&nbsp;
472  Number of active voices changed<br />  Number of active voices changed<br />
473  &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;
474  Number of active disk streams changed<br />  Number of active disk streams changed<br />
475  &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;
476  Disk stream buffer fill state changed<br />  Disk stream buffer fill state changed<br />
477  &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;
478  Channel information changed<br />  Channel information changed<br />
479  &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;
480  Number of effect sends changed<br />  Number of effect sends changed<br />
481  &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;
482  Effect send information changed<br />  Effect send information changed<br />
483  &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;
484  Total number of active voices changed<br />  Total number of active voices changed<br />
485  &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;
486    Total number of active disk streams changed<br />
487    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.16.</a>&nbsp;
488  Number of MIDI instrument maps changed<br />  Number of MIDI instrument maps changed<br />
489  &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;
490  MIDI instrument map information changed<br />  MIDI instrument map information changed<br />
491  &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;
492  Number of MIDI instruments changed<br />  Number of MIDI instruments changed<br />
493  &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;
494  MIDI instrument information changed<br />  MIDI instrument information changed<br />
495  &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;
496  Global settings changed<br />  Global settings changed<br />
497  &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;
498  Number of database instrument directories changed<br />  Number of database instrument directories changed<br />
499  &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;
500  Database instrument directory information changed<br />  Database instrument directory information changed<br />
501  &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;
502  Number of database instruments changed<br />  Number of database instruments changed<br />
503  &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;
504  Database instrument information changed<br />  Database instrument information changed<br />
505  &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;
506  Database job status information changed<br />  Database job status information changed<br />
507  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.23.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.26.</a>&nbsp;
508  Miscellaneous and debugging events<br />  Miscellaneous and debugging events<br />
509  <a href="#anchor14">9.</a>&nbsp;  <a href="#anchor14">9.</a>&nbsp;
510  Security Considerations<br />  Security Considerations<br />
# Line 3449  Loading an instrument</h3> Line 3465  Loading an instrument</h3>
3465  </blockquote><p>  </blockquote><p>
3466                                            
3467  </p>  </p>
3468  <p>Example:  <p>Example (Unix):
3469  </p>  </p>
3470  <p>  <p>
3471                          </p>                          </p>
3472  <blockquote class="text">  <blockquote class="text">
3473    <p>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0
3474    </p>
3475    <p>S: OK
3476    </p>
3477    </blockquote><p>
3478                        
3479    </p>
3480    <p>Example (Windows):
3481    </p>
3482  <p>  <p>
3483                            </p>
3484    <blockquote class="text">
3485    <p>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0
3486    </p>
3487    <p>S: OK
3488  </p>  </p>
3489  </blockquote><p>  </blockquote><p>
3490                                            
# Line 3869  Getting information about an engine</h3> Line 3899  Getting information about an engine</h3>
3899                                          </p>                                          </p>
3900  <blockquote class="text">  <blockquote class="text">
3901  <p>arbitrary description text about the engine  <p>arbitrary description text about the engine
3902                                                (note that the character string may contain
3903                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
3904  </p>  </p>
3905  </blockquote>  </blockquote>
3906                                                                            
# Line 3988  Getting sampler channel information</h3> Line 4020  Getting sampler channel information</h3>
4020  <blockquote class="text">  <blockquote class="text">
4021  <p>the file name of the loaded instrument, "NONE" if  <p>the file name of the loaded instrument, "NONE" if
4022                                              there's no instrument yet loaded for this sampler                                              there's no instrument yet loaded for this sampler
4023                                              channel                                              channel (note: since LSCP 1.2 this path may contain
4024                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
4025  </p>  </p>
4026  </blockquote>  </blockquote>
4027                                                                            
# Line 4005  Getting sampler channel information</h3> Line 4038  Getting sampler channel information</h3>
4038                                          </p>                                          </p>
4039  <blockquote class="text">  <blockquote class="text">
4040  <p>the instrument name of the loaded instrument  <p>the instrument name of the loaded instrument
4041                                                (note: since LSCP 1.2 this character string may contain
4042                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
4043  </p>  </p>
4044  </blockquote>  </blockquote>
4045                                                                            
# Line 5080  Adding an effect send to a sampler chann Line 5115  Adding an effect send to a sampler chann
5115                      sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;                      sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
5116                      is a number between 0..127 defining the MIDI controller which can alter the                      is a number between 0..127 defining the MIDI controller which can alter the
5117                      effect send level and &lt;name&gt; is an optional argument defining a name                      effect send level and &lt;name&gt; is an optional argument defining a name
5118                      for the effect send entity. The name does not have to be unique.                      for the effect send entity. The name does not have to be unique, but MUST be
5119                        encapsulated into apostrophes and supports escape sequences as described in chapter
5120                        "<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>".
5121  </p>  </p>
5122  <p>By default, that is as initial routing, the effect send's audio channels  <p>By default, that is as initial routing, the effect send's audio channels
5123                      are automatically routed to the last audio channels of the sampler channel's                      are automatically routed to the last audio channels of the sampler channel's
# Line 5349  Getting effect send information</h3> Line 5386  Getting effect send information</h3>
5386                                          </p>                                          </p>
5387  <blockquote class="text">  <blockquote class="text">
5388  <p>name of the effect send entity  <p>name of the effect send entity
5389                                                (note that this character string may contain
5390                                                 <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
5391  </p>  </p>
5392  </blockquote>  </blockquote>
5393                                                                            
# Line 5439  Changing effect send's name</h3> Line 5478  Changing effect send's name</h3>
5478                      as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>                      as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
5479                      or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and                      or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and
5480                      &lt;name&gt; is the new name of the effect send entity, which                      &lt;name&gt; is the new name of the effect send entity, which
5481                      does not have to be unique.                      does not have to be unique (name MUST be encapsulated into apostrophes
5482                        and supports escape sequences as described in chapter
5483                        "<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>").
5484                        
5485  </p>  </p>
5486  <p>Possible Answers:  <p>Possible Answers:
5487  </p>  </p>
# Line 6040  Maximum amount of active voices</h3> Line 6082  Maximum amount of active voices</h3>
6082  </blockquote><p>  </blockquote><p>
6083                                            
6084  </p>  </p>
6085  <a name="RESET"></a><br /><hr />  <a name="GET TOTAL_STREAM_COUNT"></a><br /><hr />
6086  <table 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>
6087  <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;
6088    Current number of active disk streams</h3>
6089    
6090    <p>The front-end can ask for the current number of active disk streams on
6091                        the sampler by sending the following command:
6092    </p>
6093    <p>
6094                            </p>
6095    <blockquote class="text">
6096    <p>GET TOTAL_STREAM_COUNT
6097    </p>
6098    </blockquote><p>
6099                        
6100    </p>
6101    <p>Possible Answers:
6102    </p>
6103    <p>
6104                            </p>
6105    <blockquote class="text">
6106    <p>LinuxSampler will answer by returning the number of all active
6107                                disk streams on the sampler.
6108    </p>
6109    </blockquote><p>
6110                        
6111    </p>
6112    <a name="RESET"></a><br /><hr />
6113    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6114    <a name="rfc.section.6.6.4"></a><h3>6.6.4.&nbsp;
6115  Reset sampler</h3>  Reset sampler</h3>
6116    
6117  <p>The front-end can reset the whole sampler by sending the following command:  <p>The front-end can reset the whole sampler by sending the following command:
# Line 6083  Reset sampler</h3> Line 6152  Reset sampler</h3>
6152  </p>  </p>
6153  <a name="GET SERVER INFO"></a><br /><hr />  <a name="GET SERVER INFO"></a><br /><hr />
6154  <table 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>
6155  <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;
6156  General sampler informations</h3>  General sampler informations</h3>
6157    
6158  <p>The client can ask for general informations about the LinuxSampler  <p>The client can ask for general informations about the LinuxSampler
# Line 6116  General sampler informations</h3> Line 6185  General sampler informations</h3>
6185                                          </p>                                          </p>
6186  <blockquote class="text">  <blockquote class="text">
6187  <p>arbitrary textual description about the sampler  <p>arbitrary textual description about the sampler
6188                                                (note that the character string may contain
6189                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
6190  </p>  </p>
6191  </blockquote>  </blockquote>
6192                                                                            
# Line 6157  General sampler informations</h3> Line 6228  General sampler informations</h3>
6228  </p>  </p>
6229  <a name="GET VOLUME"></a><br /><hr />  <a name="GET VOLUME"></a><br /><hr />
6230  <table 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>
6231  <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;
6232  Getting global volume attenuation</h3>  Getting global volume attenuation</h3>
6233    
6234  <p>The client can ask for the current global sampler-wide volume  <p>The client can ask for the current global sampler-wide volume
# Line 6190  Getting global volume attenuation</h3> Line 6261  Getting global volume attenuation</h3>
6261  </p>  </p>
6262  <a name="SET VOLUME"></a><br /><hr />  <a name="SET VOLUME"></a><br /><hr />
6263  <table 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>
6264  <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;
6265  Setting global volume attenuation</h3>  Setting global volume attenuation</h3>
6266    
6267  <p>The client can alter the current global sampler-wide volume  <p>The client can alter the current global sampler-wide volume
# Line 6277  MIDI Instrument Mapping</h3> Line 6348  MIDI Instrument Mapping</h3>
6348                  cause the sampler to switch to the respective instrument as                  cause the sampler to switch to the respective instrument as
6349                  reflected by the current MIDI instrument map.                  reflected by the current MIDI instrument map.
6350  </p>  </p>
6351  <a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr />  <a name="ADD MIDI_INSTRUMENT_MAP"></a><br /><hr />
6352  <table 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>
6353  <a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;  <a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;
6354  Create a new MIDI instrument map</h3>  Create a new MIDI instrument map</h3>
# Line 6295  Create a new MIDI instrument map</h3> Line 6366  Create a new MIDI instrument map</h3>
6366  </p>  </p>
6367  <p>Where &lt;name&gt; is an optional argument allowing to  <p>Where &lt;name&gt; is an optional argument allowing to
6368                      assign a custom name to the new map. MIDI instrument Map                      assign a custom name to the new map. MIDI instrument Map
6369                      names do not have to be unique.                      names do not have to be unique, but MUST be encapsulated
6370                        into apostrophes and support escape sequences as described
6371                        in chapter "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>".
6372                        
6373  </p>  </p>
6374  <p>Possible Answers:  <p>Possible Answers:
6375  </p>  </p>
# Line 6553  Getting MIDI instrument map information< Line 6627  Getting MIDI instrument map information<
6627  <blockquote class="text">  <blockquote class="text">
6628  <p>custom name of the given map,  <p>custom name of the given map,
6629                                              which does not have to be unique                                              which does not have to be unique
6630                                                (note that this character string may contain
6631                                                 <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
6632  </p>  </p>
6633  </blockquote>  </blockquote>
6634                                                                            
# Line 6608  Renaming a MIDI instrument map</h3> Line 6684  Renaming a MIDI instrument map</h3>
6684  </p>  </p>
6685  <p>Where &lt;map&gt; is the numerical ID of the map and  <p>Where &lt;map&gt; is the numerical ID of the map and
6686                      &lt;name&gt; the new custom name of the map, which does not                      &lt;name&gt; the new custom name of the map, which does not
6687                      have to be unique.                      have to be unique (name MUST be encapsulated into apostrophes
6688                        and supports escape sequences as described in chapter
6689                        "<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>").
6690                        
6691  </p>  </p>
6692  <p>Possible Answers:  <p>Possible Answers:
6693  </p>  </p>
# Line 6773  Create or replace a MIDI instrument map Line 6852  Create or replace a MIDI instrument map
6852                      load modes of entries, the frontend should retrieve the actual                      load modes of entries, the frontend should retrieve the actual
6853                      mode by i.e. sending                      mode by i.e. sending
6854                      <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>                      <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>
6855                      command(s). Finally the OPTIONAL &lt;name&gt; argument allows to                      command(s). Finally the OPTIONAL &lt;name&gt; argument allows to set a custom name
6856                      set a custom name (encapsulated into apostrophes) for the mapping                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
6857                      entry, useful for frontends for displaying an appropriate name for                      "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") for the
6858                        mapping entry, useful for frontends for displaying an appropriate name for
6859                      mapped instruments (using                      mapped instruments (using
6860                      <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>).                      <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>).
6861                                            
# Line 7097  Get current settings of MIDI instrument Line 7177  Get current settings of MIDI instrument
7177                                      changed with the                                      changed with the
7178                                      <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>
7179                                      command and does not have to be unique.                                      command and does not have to be unique.
7180                                        (note that this character string may contain
7181                                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
7182  </p>  </p>
7183  </blockquote>  </blockquote>
7184                                                            
# Line 7113  Get current settings of MIDI instrument Line 7195  Get current settings of MIDI instrument
7195  <p>"INSTRUMENT_FILE" -  <p>"INSTRUMENT_FILE" -
7196                                  </p>                                  </p>
7197  <blockquote class="text">  <blockquote class="text">
7198  <p>File name of the instrument.  <p>File name of the instrument
7199                                        (note that this path may contain
7200                                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>).
7201  </p>  </p>
7202  </blockquote>  </blockquote>
7203                                                            
# Line 7131  Get current settings of MIDI instrument Line 7215  Get current settings of MIDI instrument
7215  <blockquote class="text">  <blockquote class="text">
7216  <p>Name of the loaded instrument as reflected by its file.  <p>Name of the loaded instrument as reflected by its file.
7217                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
7218                                      cannot be changed.                                      cannot be changed (note that this character string may contain
7219                                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>).
7220  </p>  </p>
7221  </blockquote>  </blockquote>
7222                                                            
# Line 8637  Changing the description of instrument</ Line 8722  Changing the description of instrument</
8722                                            
8723  </p>  </p>
8724  <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
8725                      &lt;desc&gt; is the new description for the instrument                      &lt;desc&gt; is the new description for the instrument
8726                      (encapsulated into apostrophes, supporting escape sequences as described in chapter                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
8727                      "<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>").
8728  </p>  </p>
# Line 9046  Opening an appropriate instrument editor Line 9131  Opening an appropriate instrument editor
9131  <p>  <p>
9132                          </p>                          </p>
9133  <blockquote class="text">  <blockquote class="text">
9134  <p>EDIT INSTRUMENT &lt;sampler-channel&gt;  <p>EDIT CHANNEL INSTRUMENT &lt;sampler-channel&gt;
9135  </p>  </p>
9136  </blockquote><p>  </blockquote><p>
9137                                            
# Line 9113  Opening an appropriate instrument editor Line 9198  Opening an appropriate instrument editor
9198  <p>  <p>
9199                          </p>                          </p>
9200  <blockquote class="text">  <blockquote class="text">
9201  <p>C: "EDIT INSTRUMENT 0"  <p>C: "EDIT CHANNEL INSTRUMENT 0"
9202  </p>  </p>
9203  <p>S: "OK"  <p>S: "OK"
9204  </p>  </p>
9205  </blockquote><p>  </blockquote><p>
9206                                            
9207  </p>  </p>
9208    <a name="file_management"></a><br /><hr />
9209    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9210    <a name="rfc.section.6.10"></a><h3>6.10.&nbsp;
9211    Managing Files</h3>
9212    
9213    <p>You can query detailed informations about files located
9214                    at the same system where the sampler instance is running on.
9215                    Using this command set allows to retrieve file informations
9216                    even remotely from another machine.
9217    </p>
9218    <a name="GET FILE INSTRUMENTS"></a><br /><hr />
9219    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9220    <a name="rfc.section.6.10.1"></a><h3>6.10.1.&nbsp;
9221    Retrieving amount of instruments of a file</h3>
9222    
9223    <p>The front-end can retrieve the amount of instruments
9224                        within a given instrument file by sending the
9225                        following command:
9226    </p>
9227    <p>
9228                            </p>
9229    <blockquote class="text">
9230    <p>GET FILE INSTRUMENTS &lt;filename&gt;
9231    </p>
9232    </blockquote><p>
9233                        
9234    </p>
9235    <p>Where &lt;filename&gt; is the name of the instrument
9236                        file (encapsulated into apostrophes, supporting escape
9237                        sequences as described in chapter
9238                        "<a class='info' href='#character_set'>Character Set and Escape
9239                            Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
9240    </p>
9241    <p>The sampler will try to ask all sampler engines,
9242                        whether they support the given file and ask the first
9243                        engine with a positive answer for the amount of
9244                        instruments.
9245    </p>
9246    <p>Possible Answers:
9247    </p>
9248    <p>
9249                            </p>
9250    <blockquote class="text">
9251    <p>On success, the sampler will answer by
9252                                   returning the amount of instruments.
9253                                
9254    </p>
9255    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9256                                    </p>
9257    <blockquote class="text">
9258    <p>if the file could not be handled
9259    </p>
9260    </blockquote>
9261                                
9262    
9263    </blockquote><p>
9264                        
9265    </p>
9266    <p>Examples:
9267    </p>
9268    <p>
9269                            </p>
9270    <blockquote class="text">
9271    <p>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
9272    </p>
9273    <p>S: "10"
9274    </p>
9275    </blockquote><p>
9276                        
9277    </p>
9278    <a name="LIST FILE INSTRUMENTS"></a><br /><hr />
9279    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9280    <a name="rfc.section.6.10.2"></a><h3>6.10.2.&nbsp;
9281    Retrieving all instruments of a file</h3>
9282    
9283    <p>The front-end can retrieve a list of all instruments
9284                        within a given instrument file by sending the
9285                        following command:
9286    </p>
9287    <p>
9288                            </p>
9289    <blockquote class="text">
9290    <p>LIST FILE INSTRUMENTS &lt;filename&gt;
9291    </p>
9292    </blockquote><p>
9293                        
9294    </p>
9295    <p>Where &lt;filename&gt; is the name of the instrument
9296                        file (encapsulated into apostrophes, supporting escape
9297                        sequences as described in chapter
9298                        "<a class='info' href='#character_set'>Character Set and Escape
9299                            Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
9300    </p>
9301    <p>The sampler will try to ask all sampler engines,
9302                        whether they support the given file and ask the first
9303                        engine with a positive answer for a list of IDs for the
9304                        instruments in the given file.
9305    </p>
9306    <p>Possible Answers:
9307    </p>
9308    <p>
9309                            </p>
9310    <blockquote class="text">
9311    <p>On success, the sampler will answer by
9312                                   returning a comma separated list of
9313                                   instrument IDs.
9314                                
9315    </p>
9316    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9317                                    </p>
9318    <blockquote class="text">
9319    <p>if the file could not be handled
9320    </p>
9321    </blockquote>
9322                                
9323    
9324    </blockquote><p>
9325                        
9326    </p>
9327    <p>Examples:
9328    </p>
9329    <p>
9330                            </p>
9331    <blockquote class="text">
9332    <p>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
9333    </p>
9334    <p>S: "0,1,2,3,4,5,6,7,8,9"
9335    </p>
9336    </blockquote><p>
9337                        
9338    </p>
9339    <a name="GET FILE INSTRUMENT INFO"></a><br /><hr />
9340    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9341    <a name="rfc.section.6.10.3"></a><h3>6.10.3.&nbsp;
9342    Retrieving informations about one instrument in a file</h3>
9343    
9344    <p>The front-end can retrieve detailed informations
9345                        about a specific instrument within a given instrument
9346                        file by sending the following command:
9347    </p>
9348    <p>
9349                            </p>
9350    <blockquote class="text">
9351    <p>GET FILE INSTRUMENT INFO &lt;filename&gt;
9352                                &lt;instr-id&gt;
9353    </p>
9354    </blockquote><p>
9355                        
9356    </p>
9357    <p>Where &lt;filename&gt; is the name of the instrument
9358                        file (encapsulated into apostrophes, supporting escape
9359                        sequences as described in chapter
9360                        "<a class='info' href='#character_set'>Character Set and Escape
9361                            Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") and &lt;instr-id&gt; is the numeric
9362                        instrument ID as returned by the
9363                        <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.
9364    </p>
9365    <p>The sampler will try to ask all sampler engines,
9366                        whether they support the given file and ask the first
9367                        engine with a positive answer for informations about the
9368                        specific instrument in the given file.
9369    </p>
9370    <p>Possible Answers:
9371    </p>
9372    <p>
9373                            </p>
9374    <blockquote class="text">
9375    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
9376                                Each answer line begins with the settings category name
9377                                followed by a colon and then a space character &lt;SP&gt; and finally
9378                                the info character string to that setting category. At the
9379                                moment the following categories are defined:
9380    </p>
9381    <p>
9382                                    </p>
9383    <blockquote class="text">
9384    <p>NAME -
9385                                            </p>
9386    <blockquote class="text">
9387    <p>name of the instrument as
9388                                                stored in the instrument file
9389    </p>
9390    </blockquote>
9391                                        
9392    
9393    <p>FORMAT_FAMILY -
9394                                            </p>
9395    <blockquote class="text">
9396    <p>name of the sampler format
9397                                                of the given instrument
9398    </p>
9399    </blockquote>
9400                                        
9401    
9402    <p>FORMAT_VERSION -
9403                                            </p>
9404    <blockquote class="text">
9405    <p>version of the sampler format
9406                                                the instrumen is stored as
9407    </p>
9408    </blockquote>
9409                                        
9410    
9411    <p>PRODUCT -
9412                                            </p>
9413    <blockquote class="text">
9414    <p>official product name of the
9415                                                instrument as stored in the file
9416                                                
9417    </p>
9418    </blockquote>
9419                                        
9420    
9421    <p>ARTISTS -
9422                                            </p>
9423    <blockquote class="text">
9424    <p>artists / sample library
9425                                                vendor of the instrument
9426    </p>
9427    </blockquote>
9428                                        
9429    
9430    </blockquote>
9431                                
9432    
9433    </blockquote><p>
9434                        
9435    </p>
9436    <p>The mentioned fields above don't have to be in particular order.
9437    </p>
9438    <p>Example:
9439    </p>
9440    <p>
9441                            </p>
9442    <blockquote class="text">
9443    <p>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"
9444    </p>
9445    <p>S: "NAME: Lunatic Loops"
9446    </p>
9447    <p>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"
9448    </p>
9449    <p>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 3"
9450    </p>
9451    <p>&nbsp;&nbsp;&nbsp;"PRODUCT: The Backbone Bongo Beats"
9452    </p>
9453    <p>&nbsp;&nbsp;&nbsp;"ARTISTS: Jimmy the Fish"
9454    </p>
9455    <p>&nbsp;&nbsp;&nbsp;"."
9456    </p>
9457    </blockquote><p>
9458                        
9459    </p>
9460  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
9461  <table 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>
9462  <a name="rfc.section.7"></a><h3>7.&nbsp;  <a name="rfc.section.7"></a><h3>7.&nbsp;
# Line 9304  Command Syntax</h3> Line 9641  Command Syntax</h3>
9641  <p>/ CHANNEL_COUNT  <p>/ CHANNEL_COUNT
9642                                    
9643  </p>  </p>
9644    <p>/ CHANNEL_MIDI
9645                    
9646    </p>
9647    <p>/ DEVICE_MIDI
9648                    
9649    </p>
9650  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
9651                                    
9652  </p>  </p>
# Line 9352  Command Syntax</h3> Line 9695  Command Syntax</h3>
9695  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
9696                                    
9697  </p>  </p>
9698    <p>/ TOTAL_STREAM_COUNT
9699                    
9700    </p>
9701  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
9702                                    
9703  </p>  </p>
# Line 9379  Command Syntax</h3> Line 9725  Command Syntax</h3>
9725  <p>/ CHANNEL_COUNT  <p>/ CHANNEL_COUNT
9726                                    
9727  </p>  </p>
9728    <p>/ CHANNEL_MIDI
9729                    
9730    </p>
9731    <p>/ DEVICE_MIDI
9732                    
9733    </p>
9734  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
9735                                    
9736  </p>  </p>
# Line 9427  Command Syntax</h3> Line 9779  Command Syntax</h3>
9779  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
9780                                    
9781  </p>  </p>
9782    <p>/ TOTAL_STREAM_COUNT
9783                    
9784    </p>
9785  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
9786                                    
9787  </p>  </p>
# Line 9562  Command Syntax</h3> Line 9917  Command Syntax</h3>
9917  <p>/ SERVER SP INFO  <p>/ SERVER SP INFO
9918                                    
9919  </p>  </p>
9920    <p>/ TOTAL_STREAM_COUNT
9921                    
9922    </p>
9923  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
9924                                    
9925  </p>  </p>
# Line 9613  Command Syntax</h3> Line 9971  Command Syntax</h3>
9971  <p>/ VOLUME  <p>/ VOLUME
9972                                    
9973  </p>  </p>
9974    <p>/ FILE SP INSTRUMENTS SP filename
9975                    
9976    </p>
9977    <p>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
9978                    
9979    </p>
9980  </blockquote><p>  </blockquote><p>
9981    
9982  </p>  </p>
# Line 9838  Command Syntax</h3> Line 10202  Command Syntax</h3>
10202  <p>edit_instruction =  <p>edit_instruction =
10203          </p>          </p>
10204  <blockquote class="text">  <blockquote class="text">
10205  <p>INSTRUMENT SP sampler_channel  <p>CHANNEL SP INSTRUMENT SP sampler_channel
10206                                    
10207  </p>  </p>
10208  </blockquote><p>  </blockquote><p>
# Line 9934  Command Syntax</h3> Line 10298  Command Syntax</h3>
10298  <p>/ DB_INSTRUMENTS SP db_path  <p>/ DB_INSTRUMENTS SP db_path
10299                                    
10300  </p>  </p>
10301    <p>/ FILE SP INSTRUMENTS SP filename
10302                    
10303    </p>
10304  </blockquote><p>  </blockquote><p>
10305    
10306  </p>  </p>
# Line 10135  Command Syntax</h3> Line 10502  Command Syntax</h3>
10502  <p>map_name =  <p>map_name =
10503          </p>          </p>
10504  <blockquote class="text">  <blockquote class="text">
10505  <p>stringval  <p>stringval_escaped
10506                                    
10507  </p>  </p>
10508  </blockquote><p>  </blockquote><p>
# Line 10144  Command Syntax</h3> Line 10511  Command Syntax</h3>
10511  <p>entry_name =  <p>entry_name =
10512          </p>          </p>
10513  <blockquote class="text">  <blockquote class="text">
10514  <p>stringval  <p>stringval_escaped
10515                                    
10516  </p>  </p>
10517  </blockquote><p>  </blockquote><p>
# Line 10153  Command Syntax</h3> Line 10520  Command Syntax</h3>
10520  <p>fx_send_name =  <p>fx_send_name =
10521          </p>          </p>
10522  <blockquote class="text">  <blockquote class="text">
10523  <p>stringval  <p>stringval_escaped
10524                                    
10525  </p>  </p>
10526  </blockquote><p>  </blockquote><p>
# Line 10204  Command Syntax</h3> Line 10571  Command Syntax</h3>
10571  <p>query_val =  <p>query_val =
10572          </p>          </p>
10573  <blockquote class="text">  <blockquote class="text">
10574  <p>textval_escaped  <p>text_escaped
10575                                    
10576  </p>  </p>
10577  <p>/ stringval_escaped  <p>/ stringval_escaped
# Line 10294  Character Set and Escape Sequences</h3> Line 10661  Character Set and Escape Sequences</h3>
10661                  MUST be escaped as well (that is as double backslash), whereas                  MUST be escaped as well (that is as double backslash), whereas
10662                  in the old versions a single backslash was sufficient.                  in the old versions a single backslash was sufficient.
10663  </p>  </p>
10664    <p>The following LSCP commands support escape sequences as part
10665                    of their filename / path based arguments and / or may contain
10666                    a filename / path with escape sequences in their response:
10667                    </p>
10668    <blockquote class="text">
10669    <p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a>
10670    </p>
10671    <p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
10672    </p>
10673    <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>
10674    </p>
10675    <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>
10676    </p>
10677    <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>
10678    </p>
10679    <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>
10680    </p>
10681    <p><a class='info' href='#REMOVE DB_INSTRUMENT_DIRECTORY'>"REMOVE DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Deleting an instrument directory</span><span>)</span></a>
10682    </p>
10683    <p><a class='info' href='#REMOVE DB_INSTRUMENT'>"REMOVE DB_INSTRUMENT"<span> (</span><span class='info'>Removing an instrument</span><span>)</span></a>
10684    </p>
10685    <p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORIES'>"GET DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Getting amount of instrument directories</span><span>)</span></a>
10686    </p>
10687    <p><a class='info' href='#LIST DB_INSTRUMENT_DIRECTORIES'>"LIST DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Listing all directories in specific directory</span><span>)</span></a>
10688    </p>
10689    <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>
10690    </p>
10691    <p><a class='info' href='#GET DB_INSTRUMENTS'>"GET DB_INSTRUMENTS"<span> (</span><span class='info'>Getting amount of instruments</span><span>)</span></a>
10692    </p>
10693    <p><a class='info' href='#LIST DB_INSTRUMENTS'>"LIST DB_INSTRUMENTS"<span> (</span><span class='info'>Listing all instruments in specific directory</span><span>)</span></a>
10694    </p>
10695    <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>
10696    </p>
10697    <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>
10698    </p>
10699    <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>
10700    </p>
10701    <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>
10702    </p>
10703    <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>
10704    </p>
10705    <p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a>
10706    </p>
10707    <p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a>
10708    </p>
10709    <p><a class='info' href='#MOVE DB_INSTRUMENT'>"MOVE DB_INSTRUMENT"<span> (</span><span class='info'>Moving an instrument</span><span>)</span></a>
10710    </p>
10711    <p><a class='info' href='#MOVE DB_INSTRUMENT_DIRECTORY'>"MOVE DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Moving an instrument directory</span><span>)</span></a>
10712    </p>
10713    <p><a class='info' href='#COPY DB_INSTRUMENT'>"COPY DB_INSTRUMENT"<span> (</span><span class='info'>Copying instruments</span><span>)</span></a>
10714    </p>
10715    <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>
10716    </p>
10717    <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>
10718    </p>
10719    <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>
10720    </p>
10721    <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>
10722    </p>
10723    </blockquote><p>
10724                    Note that the forward slash character ('/') has a special meaning in
10725                    filename / path based arguments: it acts as separator of the nodes in
10726                    the path, thus if a directory- or filename includes a forward slash
10727                    (not intended as path node separator), you MUST escape that slash
10728                    either with the respective hex escape sequence ("\x2f") or with the
10729                    respective octal escape sequence ("\057").
10730                    
10731    </p>
10732    <p>
10733                    Note for Windows: file path arguments in LSCP are expected
10734                    to use forward slashes as directory node separator similar
10735                    to Unix based operating systems. In contrast to Unix however
10736                    a Windows typical drive character is expected to be
10737                    prefixed to the path. That is an original Windows file path
10738                    like "D:\Sounds\My.gig" would become in LSCP:
10739                    "D:/Sounds/My.gig".
10740                    
10741    </p>
10742    <p>
10743                    The following LSCP commands even support escape sequences as
10744                    part of at least one of their text-based arguments (i.e. entity name,
10745                    description) and / or may contain escape sequences in at least one of
10746                    their text-based fields in their response:
10747                    </p>
10748    <blockquote class="text">
10749    <p><a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a>
10750    </p>
10751    <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>
10752    </p>
10753    <p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
10754    </p>
10755    <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>
10756    </p>
10757    <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>
10758    </p>
10759    <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>
10760    </p>
10761    <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>
10762    </p>
10763    <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>
10764    </p>
10765    <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>
10766    </p>
10767    <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>
10768    </p>
10769    <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>
10770    </p>
10771    <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>
10772    </p>
10773    <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>
10774    </p>
10775    <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>
10776    </p>
10777    <p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a>
10778    </p>
10779    <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>
10780    </p>
10781    <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>
10782    </p>
10783    <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>
10784    </p>
10785    <p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a>
10786    </p>
10787    </blockquote><p>
10788                    Please note that these lists are manually maintained. If you
10789                    find a command that also supports escape sequences we forgot to
10790                    mention here, please report it!
10791                    
10792    </p>
10793  <a name="events"></a><br /><hr />  <a name="events"></a><br /><hr />
10794  <table 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>
10795  <a name="rfc.section.8"></a><h3>8.&nbsp;  <a name="rfc.section.8"></a><h3>8.&nbsp;
# Line 10454  Number of sampler channels changed</h3> Line 10950  Number of sampler channels changed</h3>
10950  <p>where &lt;channels&gt; will be replaced by the new number  <p>where &lt;channels&gt; will be replaced by the new number
10951                  of sampler channels.                  of sampler channels.
10952  </p>  </p>
10953  <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE CHANNEL_MIDI"></a><br /><hr />
10954  <table 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>
10955  <a name="rfc.section.8.6"></a><h3>8.6.&nbsp;  <a name="rfc.section.8.6"></a><h3>8.6.&nbsp;
10956    MIDI data on a sampler channel arrived</h3>
10957    
10958    <p>Client may want to be notified when MIDI data arrive on sampler channels on
10959                    back-end side, by issuing the following command:
10960    </p>
10961    <p>
10962                        </p>
10963    <blockquote class="text">
10964    <p>SUBSCRIBE CHANNEL_MIDI
10965    </p>
10966    </blockquote><p>
10967                    
10968    </p>
10969    <p>Server will start sending one of the the following notification messages:
10970    </p>
10971    <p>
10972                        </p>
10973    <blockquote class="text">
10974    <p>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_ON  &lt;note&gt; &lt;velocity&gt;"
10975    </p>
10976    <p>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"
10977    </p>
10978    </blockquote><p>
10979                    
10980    </p>
10981    <p>where &lt;channel-id&gt; will be replaced by the ID of the sampler channel where the MIDI
10982                    data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
10983                    0 .. 127, reflecting the analog meaning of the MIDI specification.
10984                    
10985    </p>
10986    <p>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
10987                    delivered by this mechanism! With other words: events could be lost at any time!
10988                    This restriction was made to keep the RT-safeness of the backend's MIDI and audio
10989                    thread unaffected by this feature.
10990    </p>
10991    <a name="SUBSCRIBE DEVICE_MIDI"></a><br /><hr />
10992    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10993    <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;
10994    MIDI data on a MIDI input device arrived</h3>
10995    
10996    <p>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:
10997    </p>
10998    <p>
10999                                </p>
11000    <blockquote class="text">
11001    <p>SUBSCRIBE DEVICE_MIDI
11002    </p>
11003    </blockquote><p>
11004                        
11005    </p>
11006    <p>Server will start sending one of the the following notification messages:
11007    </p>
11008    <p>
11009                                </p>
11010    <blockquote class="text">
11011    <p>"NOTIFY:CHANNEL_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_ON &lt;note&gt; &lt;velocity&gt;"
11012    </p>
11013    <p>"NOTIFY:CHANNEL_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"
11014    </p>
11015    </blockquote><p>
11016                        
11017    </p>
11018    <p>where &lt;device-id&gt; &lt;port-id&gt; will be replaced
11019                           by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI
11020                           data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
11021                           0 .. 127, reflecting the analog meaning of the MIDI specification.
11022                        
11023    </p>
11024    <p>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
11025                           delivered by this mechanism! With other words: events could be lost at any time!
11026                           This restriction was made to keep the RT-safeness of the backend's MIDI and audio
11027                           thread unaffected by this feature.
11028    </p>
11029    <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />
11030    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11031    <a name="rfc.section.8.8"></a><h3>8.8.&nbsp;
11032  Number of active voices changed</h3>  Number of active voices changed</h3>
11033    
11034  <p>Client may want to be notified when the number of voices on the  <p>Client may want to be notified when the number of voices on the
# Line 10486  Number of active voices changed</h3> Line 11058  Number of active voices changed</h3>
11058  </p>  </p>
11059  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />
11060  <table 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>
11061  <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;  <a name="rfc.section.8.9"></a><h3>8.9.&nbsp;
11062  Number of active disk streams changed</h3>  Number of active disk streams changed</h3>
11063    
11064  <p>Client may want to be notified when the number of streams on the back-end  <p>Client may want to be notified when the number of streams on the back-end
# Line 10516  Number of active disk streams changed</h Line 11088  Number of active disk streams changed</h
11088  </p>  </p>
11089  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />
11090  <table 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>
11091  <a name="rfc.section.8.8"></a><h3>8.8.&nbsp;  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
11092  Disk stream buffer fill state changed</h3>  Disk stream buffer fill state changed</h3>
11093    
11094  <p>Client may want to be notified when the buffer fill state of a disk stream  <p>Client may want to be notified when the buffer fill state of a disk stream
# Line 10547  Disk stream buffer fill state changed</h Line 11119  Disk stream buffer fill state changed</h
11119  </p>  </p>
11120  <a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr />  <a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr />
11121  <table 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>
11122  <a name="rfc.section.8.9"></a><h3>8.9.&nbsp;  <a name="rfc.section.8.11"></a><h3>8.11.&nbsp;
11123  Channel information changed</h3>  Channel information changed</h3>
11124    
11125  <p>Client may want to be notified when changes were made to sampler channels on the  <p>Client may want to be notified when changes were made to sampler channels on the
# Line 10580  Channel information changed</h3> Line 11152  Channel information changed</h3>
11152  </p>  </p>
11153  <a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr />  <a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr />
11154  <table 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>
11155  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;  <a name="rfc.section.8.12"></a><h3>8.12.&nbsp;
11156  Number of effect sends changed</h3>  Number of effect sends changed</h3>
11157    
11158  <p>Client may want to be notified when the number of effect sends on  <p>Client may want to be notified when the number of effect sends on
# Line 10610  Number of effect sends changed</h3> Line 11182  Number of effect sends changed</h3>
11182  </p>  </p>
11183  <a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr />  <a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr />
11184  <table 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>
11185  <a name="rfc.section.8.11"></a><h3>8.11.&nbsp;  <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;
11186  Effect send information changed</h3>  Effect send information changed</h3>
11187    
11188  <p>Client may want to be notified when changes were made to effect sends on a  <p>Client may want to be notified when changes were made to effect sends on a
# Line 10640  Effect send information changed</h3> Line 11212  Effect send information changed</h3>
11212  </p>  </p>
11213  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />
11214  <table 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>
11215  <a name="rfc.section.8.12"></a><h3>8.12.&nbsp;  <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;
11216  Total number of active voices changed</h3>  Total number of active voices changed</h3>
11217    
11218  <p>Client may want to be notified when the total number of voices on the  <p>Client may want to be notified when the total number of voices on the
# Line 10667  Total number of active voices changed</h Line 11239  Total number of active voices changed</h
11239  <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
11240                  all currently active voices.                  all currently active voices.
11241  </p>  </p>
11242    <a name="SUBSCRIBE TOTAL_STREAM_COUNT"></a><br /><hr />
11243    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11244    <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;
11245    Total number of active disk streams changed</h3>
11246    
11247    <p>Client may want to be notified when the total number of disk streams on the
11248                    back-end changes by issuing the following command:
11249    </p>
11250    <p>
11251                        </p>
11252    <blockquote class="text">
11253    <p>SUBSCRIBE TOTAL_STREAM_COUNT
11254    </p>
11255    </blockquote><p>
11256                    
11257    </p>
11258    <p>Server will start sending the following notification messages:
11259    </p>
11260    <p>
11261                        </p>
11262    <blockquote class="text">
11263    <p>"NOTIFY:TOTAL_STREAM_COUNT:&lt;streams&gt;"
11264    </p>
11265    </blockquote><p>
11266                    
11267    </p>
11268    <p>where &lt;streams&gt; will be replaced by the new number of
11269                    all currently active disk streams.
11270    </p>
11271  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr />  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr />
11272  <table 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>
11273  <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;  <a name="rfc.section.8.16"></a><h3>8.16.&nbsp;
11274  Number of MIDI instrument maps changed</h3>  Number of MIDI instrument maps changed</h3>
11275    
11276  <p>Client may want to be notified when the number of MIDI instrument maps on the  <p>Client may want to be notified when the number of MIDI instrument maps on the
# Line 10698  Number of MIDI instrument maps changed</ Line 11299  Number of MIDI instrument maps changed</
11299  </p>  </p>
11300  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr />  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr />
11301  <table 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>
11302  <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;  <a name="rfc.section.8.17"></a><h3>8.17.&nbsp;
11303  MIDI instrument map information changed</h3>  MIDI instrument map information changed</h3>
11304    
11305  <p>Client may want to be notified when changes were made to MIDI instrument maps on the  <p>Client may want to be notified when changes were made to MIDI instrument maps on the
# Line 10731  MIDI instrument map information changed< Line 11332  MIDI instrument map information changed<
11332  </p>  </p>
11333  <a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr />  <a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr />
11334  <table 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>
11335  <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;  <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;
11336  Number of MIDI instruments changed</h3>  Number of MIDI instruments changed</h3>
11337    
11338  <p>Client may want to be notified when the number of MIDI instrument maps on the  <p>Client may want to be notified when the number of MIDI instrument maps on the
# Line 10761  Number of MIDI instruments changed</h3> Line 11362  Number of MIDI instruments changed</h3>
11362  </p>  </p>
11363  <a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr />  <a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr />
11364  <table 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>
11365  <a name="rfc.section.8.16"></a><h3>8.16.&nbsp;  <a name="rfc.section.8.19"></a><h3>8.19.&nbsp;
11366  MIDI instrument information changed</h3>  MIDI instrument information changed</h3>
11367    
11368  <p>Client may want to be notified when changes were made to MIDI instruments on the  <p>Client may want to be notified when changes were made to MIDI instruments on the
# Line 10795  MIDI instrument information changed</h3> Line 11396  MIDI instrument information changed</h3>
11396  </p>  </p>
11397  <a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr />  <a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr />
11398  <table 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>
11399  <a name="rfc.section.8.17"></a><h3>8.17.&nbsp;  <a name="rfc.section.8.20"></a><h3>8.20.&nbsp;
11400  Global settings changed</h3>  Global settings changed</h3>
11401    
11402  <p>Client may want to be notified when changes to the global settings  <p>Client may want to be notified when changes to the global settings
# Line 10824  Global settings changed</h3> Line 11425  Global settings changed</h3>
11425  </p>  </p>
11426  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />
11427  <table 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>
11428  <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;  <a name="rfc.section.8.21"></a><h3>8.21.&nbsp;
11429  Number of database instrument directories changed</h3>  Number of database instrument directories changed</h3>
11430    
11431  <p>Client may want to be notified when the number of instrument  <p>Client may want to be notified when the number of instrument
# Line 10858  Number of database instrument directorie Line 11459  Number of database instrument directorie
11459  </p>  </p>
11460  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr />
11461  <table 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>
11462  <a name="rfc.section.8.19"></a><h3>8.19.&nbsp;  <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;
11463  Database instrument directory information changed</h3>  Database instrument directory information changed</h3>
11464    
11465  <p>Client may want to be notified when changes were made to directories  <p>Client may want to be notified when changes were made to directories
# Line 10903  Database instrument directory informatio Line 11504  Database instrument directory informatio
11504  </p>  </p>
11505  <a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr />
11506  <table 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>
11507  <a name="rfc.section.8.20"></a><h3>8.20.&nbsp;  <a name="rfc.section.8.23"></a><h3>8.23.&nbsp;
11508  Number of database instruments changed</h3>  Number of database instruments changed</h3>
11509    
11510  <p>Client may want to be notified when the number of instruments  <p>Client may want to be notified when the number of instruments
# Line 10937  Number of database instruments changed</ Line 11538  Number of database instruments changed</
11538  </p>  </p>
11539  <a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr />
11540  <table 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>
11541  <a name="rfc.section.8.21"></a><h3>8.21.&nbsp;  <a name="rfc.section.8.24"></a><h3>8.24.&nbsp;
11542  Database instrument information changed</h3>  Database instrument information changed</h3>
11543    
11544  <p>Client may want to be notified when changes were made to instruments  <p>Client may want to be notified when changes were made to instruments
# Line 10982  Database instrument information changed< Line 11583  Database instrument information changed<
11583  </p>  </p>
11584  <a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENTS_JOB_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.22"></a><h3>8.22.&nbsp;  <a name="rfc.section.8.25"></a><h3>8.25.&nbsp;
11587  Database job status information changed</h3>  Database job status information changed</h3>
11588    
11589  <p>Client may want to be notified when the status of particular database  <p>Client may want to be notified when the status of particular database
# Line 11015  Database job status information changed< Line 11616  Database job status information changed<
11616  </p>  </p>
11617  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />  <a name="SUBSCRIBE MISCELLANEOUS"></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.23"></a><h3>8.23.&nbsp;  <a name="rfc.section.8.26"></a><h3>8.26.&nbsp;
11620  Miscellaneous and debugging events</h3>  Miscellaneous and debugging events</h3>
11621    
11622  <p>Client may want to be notified of miscellaneous and debugging events occurring at  <p>Client may want to be notified of miscellaneous and debugging events occurring at
# Line 11112  Schoenebeck</td></tr> Line 11713  Schoenebeck</td></tr>
11713  <table 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>
11714  <h3>Full Copyright Statement</h3>  <h3>Full Copyright Statement</h3>
11715  <p class='copyright'>  <p class='copyright'>
11716  Copyright &copy; The IETF Trust (2007).</p>  Copyright &copy; The IETF Trust (2008).</p>
11717  <p class='copyright'>  <p class='copyright'>
11718  This document is subject to the rights,  This document is subject to the rights,
11719  licenses and restrictions contained in BCP&nbsp;78,  licenses and restrictions contained in BCP&nbsp;78,
Legend:
Removed from v.1363  
changed lines
  Added in v.1696
  ViewVC Help
Powered by ViewVC