/[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 1773 by iliev, Wed Sep 10 15:14:31 2008 UTC revision 2189 by iliev, Fri Jun 24 19:57:07 2011 UTC
# Line 3  Line 3 
3  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
4  <meta name="description" content="LinuxSampler Control Protocol">  <meta name="description" content="LinuxSampler Control Protocol">
5  <meta name="keywords" content="LSCP">  <meta name="keywords" content="LSCP">
6  <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">  <meta name="generator" content="xml2rfc v1.34 (http://xml.resource.org/)">
7  <style type='text/css'><!--  <style type='text/css'><!--
8          body {          body {
9                  font-family: verdana, charcoal, helvetica, arial, sans-serif;                  font-family: verdana, charcoal, helvetica, arial, sans-serif;
# Line 145  Line 145 
145  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>
146  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>
147  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>
148  <tr><td class="header">Expires: March 14, 2009</td><td class="header">September 10, 2008</td></tr>  <tr><td class="header">Expires: December 26, 2011</td><td class="header">June 24, 2011</td></tr>
149  </table></td></tr></table>  </table></td></tr></table>
150  <h1><br />LinuxSampler Control Protocol<br />LSCP 1.4</h1>  <h1><br />LinuxSampler Control Protocol<br />LSCP 1.5</h1>
151    
152    <h3>Abstract</h3>
153    
154    <p>The LinuxSampler Control Protocol (LSCP) is an
155                application-level protocol primarily intended for local and
156                remote controlling the LinuxSampler backend application, which is a
157                sophisticated server-like console application essentially playing
158                back audio samples and manipulating the samples in real time to
159                certain extent.
160    </p>
161  <h3>Status of this Memo</h3>  <h3>Status of this Memo</h3>
162  <p>  <p>
163  By submitting this Internet-Draft,  By submitting this Internet-Draft,
# Line 173  The list of current Internet-Drafts can Line 182  The list of current Internet-Drafts can
182  The list of Internet-Draft Shadow Directories can be accessed at  The list of Internet-Draft Shadow Directories can be accessed at
183  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>
184  <p>  <p>
185  This Internet-Draft will expire on March 14, 2009.</p>  This Internet-Draft will expire on December 26, 2011.</p>
186    <a name="toc"></a><br /><hr />
 <h3>Copyright Notice</h3>  
 <p>  
 Copyright &copy; The IETF Trust (2008).</p>  
   
 <h3>Abstract</h3>  
   
 <p>The LinuxSampler Control Protocol (LSCP) is an  
             application-level protocol primarily intended for local and  
             remote controlling the LinuxSampler backend application, which is a  
             sophisticated server-like console application essentially playing  
             back audio samples and manipulating the samples in real time to  
             certain extent.  
 </p><a name="toc"></a><br /><hr />  
187  <h3>Table of Contents</h3>  <h3>Table of Contents</h3>
188  <p class="toc">  <p class="toc">
189  <a href="#anchor1">1.</a>&nbsp;  <a href="#anchor1">1.</a>&nbsp;
# Line 332  Getting effect send information<br /> Line 328  Getting effect send information<br />
328  Changing effect send's name<br />  Changing effect send's name<br />
329  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a>&nbsp;
330  Altering effect send's audio routing<br />  Altering effect send's audio routing<br />
331  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.32.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND EFFECT">6.4.32.</a>&nbsp;
332    Assigning destination effect to an effect send<br />
333    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE FX_SEND EFFECT">6.4.33.</a>&nbsp;
334    Removing destination effect from an effect send<br />
335    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.34.</a>&nbsp;
336  Altering effect send's MIDI controller<br />  Altering effect send's MIDI controller<br />
337  &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.35.</a>&nbsp;
338  Altering effect send's send level<br />  Altering effect send's send level<br />
339  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SEND CHANNEL MIDI_DATA">6.4.34.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SEND CHANNEL MIDI_DATA">6.4.36.</a>&nbsp;
340  Sending MIDI messages to sampler channel<br />  Sending MIDI messages to sampler channel<br />
341  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.35.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.37.</a>&nbsp;
342  Resetting a sampler channel<br />  Resetting a sampler channel<br />
343  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;
344  Controlling connection<br />  Controlling connection<br />
# Line 366  General sampler informations<br /> Line 366  General sampler informations<br />
366  Getting global volume attenuation<br />  Getting global volume attenuation<br />
367  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOLUME">6.6.7.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOLUME">6.6.7.</a>&nbsp;
368  Setting global volume attenuation<br />  Setting global volume attenuation<br />
369    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET VOICES">6.6.8.</a>&nbsp;
370    Getting global voice limit<br />
371    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOICES">6.6.9.</a>&nbsp;
372    Setting global voice limit<br />
373    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET STREAMS">6.6.10.</a>&nbsp;
374    Getting global disk stream limit<br />
375    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET STREAMS">6.6.11.</a>&nbsp;
376    Setting global disk stream limit<br />
377  &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;
378  MIDI Instrument Mapping<br />  MIDI Instrument Mapping<br />
379  &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 454  Retrieving amount of instruments of a fi Line 462  Retrieving amount of instruments of a fi
462  Retrieving all instruments of a file<br />  Retrieving all instruments of a file<br />
463  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FILE INSTRUMENT INFO">6.10.3.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FILE INSTRUMENT INFO">6.10.3.</a>&nbsp;
464  Retrieving informations about one instrument in a file<br />  Retrieving informations about one instrument in a file<br />
465    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#effects">6.11.</a>&nbsp;
466    Managing Effects<br />
467    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_EFFECTS">6.11.1.</a>&nbsp;
468    Retrieve amount of available effects<br />
469    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_EFFECTS">6.11.2.</a>&nbsp;
470    Get list of available effects<br />
471    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET EFFECT INFO">6.11.3.</a>&nbsp;
472    Retrieving general information about an effect<br />
473    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE EFFECT_INSTANCE">6.11.4.</a>&nbsp;
474    Creating an instance of an effect by its portable ID<br />
475    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE EFFECT_INSTANCE (non-portable)">6.11.5.</a>&nbsp;
476    Creating an instance of an effect by its numerical ID<br />
477    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY EFFECT_INSTANCE">6.11.6.</a>&nbsp;
478    Destroy an effect instance<br />
479    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET EFFECT_INSTANCES">6.11.7.</a>&nbsp;
480    Retrieve amount of effect instances<br />
481    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST EFFECT_INSTANCES">6.11.8.</a>&nbsp;
482    Get list of effect instances<br />
483    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET EFFECT_INSTANCE INFO">6.11.9.</a>&nbsp;
484    Retrieving current information about an effect instance<br />
485    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET EFFECT_INSTANCE_INPUT_CONTROL INFO">6.11.10.</a>&nbsp;
486    Retrieving information about an effect parameter<br />
487    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET EFFECT_INSTANCE_INPUT_CONTROL VALUE">6.11.11.</a>&nbsp;
488    Altering an effect parameter<br />
489    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SEND_EFFECT_CHAINS">6.11.12.</a>&nbsp;
490    Retrieve amount of send effect chains<br />
491    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST SEND_EFFECT_CHAINS">6.11.13.</a>&nbsp;
492    Retrieve list of send effect chains<br />
493    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD SEND_EFFECT_CHAIN">6.11.14.</a>&nbsp;
494    Add send effect chain<br />
495    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE SEND_EFFECT_CHAIN">6.11.15.</a>&nbsp;
496    Remove send effect chain<br />
497    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SEND_EFFECT_CHAIN INFO">6.11.16.</a>&nbsp;
498    Retrieving information about a send effect chain<br />
499    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#APPEND SEND_EFFECT_CHAIN EFFECT">6.11.17.</a>&nbsp;
500    Append effect instance to a send effect chain<br />
501    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#INSERT SEND_EFFECT_CHAIN EFFECT">6.11.18.</a>&nbsp;
502    Insert effect instance to a send effect chain<br />
503    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE SEND_EFFECT_CHAIN EFFECT">6.11.19.</a>&nbsp;
504    Remove effect instance from send effect chain<br />
505  <a href="#command_syntax">7.</a>&nbsp;  <a href="#command_syntax">7.</a>&nbsp;
506  Command Syntax<br />  Command Syntax<br />
507  &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 510  Number of database instruments changed<b Line 558  Number of database instruments changed<b
558  Database instrument information changed<br />  Database instrument information changed<br />
559  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.25.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.25.</a>&nbsp;
560  Database job status information changed<br />  Database job status information changed<br />
561  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.26.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE EFFECT_INSTANCE_COUNT">8.26.</a>&nbsp;
562    Number of effect instances changed<br />
563    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE EFFECT_INSTANCE_INFO">8.27.</a>&nbsp;
564    Effect instance information changed<br />
565    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE SEND_EFFECT_CHAIN_COUNT">8.28.</a>&nbsp;
566    Number of send effect chains changed<br />
567    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE SEND_EFFECT_CHAIN_INFO">8.29.</a>&nbsp;
568    Send effect chain information changed<br />
569    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.30.</a>&nbsp;
570  Miscellaneous and debugging events<br />  Miscellaneous and debugging events<br />
571  <a href="#anchor14">9.</a>&nbsp;  <a href="#anchor14">9.</a>&nbsp;
572  Security Considerations<br />  Security Considerations<br />
# Line 3992  Getting sampler channel information</h3> Line 4048  Getting sampler channel information</h3>
4048  <blockquote class="text">  <blockquote class="text">
4049  <p>numerical ID of the audio output device which is  <p>numerical ID of the audio output device which is
4050                                              currently connected to this sampler channel to output                                              currently connected to this sampler channel to output
4051                                              the audio signal, "NONE" if there's no device                                              the audio signal, "-1" if there's no device
4052                                              connected to this sampler channel                                              connected to this sampler channel
4053  </p>  </p>
4054  </blockquote>  </blockquote>
# Line 4035  Getting sampler channel information</h3> Line 4091  Getting sampler channel information</h3>
4091  <p>INSTRUMENT_NR -  <p>INSTRUMENT_NR -
4092                                          </p>                                          </p>
4093  <blockquote class="text">  <blockquote class="text">
4094  <p>the instrument index number of the loaded instrument  <p>the instrument index number of the loaded instrument,
4095                                                "-1" if there's no instrument loaded for this sampler
4096                                                channel
4097  </p>  </p>
4098  </blockquote>  </blockquote>
4099                                                                            
# Line 4053  Getting sampler channel information</h3> Line 4111  Getting sampler channel information</h3>
4111  <p>INSTRUMENT_STATUS -  <p>INSTRUMENT_STATUS -
4112                                          </p>                                          </p>
4113  <blockquote class="text">  <blockquote class="text">
4114  <p>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative  <p>Integer values 0 to 100 indicating loading progress
4115                                              value indicates a loading exception. Value of 100 indicates that the instrument is fully                                              percentage for the instrument. Negative
4116                                                value indicates a loading exception (also returns "-1" in case no
4117                                                instrument was yet to be loaded on the sampler channel).
4118                                                Value of 100 indicates that the instrument is fully
4119                                              loaded.                                              loaded.
4120  </p>  </p>
4121  </blockquote>  </blockquote>
# Line 4065  Getting sampler channel information</h3> Line 4126  Getting sampler channel information</h3>
4126  <blockquote class="text">  <blockquote class="text">
4127  <p>numerical ID of the MIDI input device which is  <p>numerical ID of the MIDI input device which is
4128                                              currently connected to this sampler channel to deliver                                              currently connected to this sampler channel to deliver
4129                                              MIDI input commands, "NONE" if there's no device                                              MIDI input commands, "-1" if there's no device
4130                                              connected to this sampler channel                                              connected to this sampler channel
4131  </p>  </p>
4132  </blockquote>  </blockquote>
# Line 4074  Getting sampler channel information</h3> Line 4135  Getting sampler channel information</h3>
4135  <p>MIDI_INPUT_PORT -  <p>MIDI_INPUT_PORT -
4136                                          </p>                                          </p>
4137  <blockquote class="text">  <blockquote class="text">
4138  <p>port number of the MIDI input device  <p>port number of the MIDI input device (in case a
4139                                                MIDI device was already assigned to the sampler
4140                                                channel)
4141  </p>  </p>
4142  </blockquote>  </blockquote>
4143                                                                            
# Line 5428  Getting effect send information</h3> Line 5491  Getting effect send information</h3>
5491                                              channel 1 is routed to the channel 3 of the audio                                              channel 1 is routed to the channel 3 of the audio
5492                                              output device (see                                              output device (see
5493                                              <a class='info' href='#SET FX_SEND AUDIO_OUTPUT_CHANNEL'>"SET FX_SEND AUDIO_OUTPUT_CHANNEL"<span> (</span><span class='info'>Altering effect send's audio routing</span><span>)</span></a>                                              <a class='info' href='#SET FX_SEND AUDIO_OUTPUT_CHANNEL'>"SET FX_SEND AUDIO_OUTPUT_CHANNEL"<span> (</span><span class='info'>Altering effect send's audio routing</span><span>)</span></a>
5494                                              for details)                                              for details), if an internal send
5495                                                effect is assigned to the effect
5496                                                send, then this setting defines the
5497                                                audio channel routing to that
5498                                                effect instance respectively
5499    </p>
5500    </blockquote>
5501                                        
5502    
5503    <p>EFFECT -
5504                                            </p>
5505    <blockquote class="text">
5506    <p>destination send effect chain ID
5507                                                and destination effect chain
5508                                                position, separated by comma in the
5509                                                form "&lt;effect-chain&gt;,&lt;chain-pos&gt;"
5510                                                or "NONE" if there is no send effect
5511                                                assigned to the effect send
5512  </p>  </p>
5513  </blockquote>  </blockquote>
5514                                                                            
# Line 5456  Getting effect send information</h3> Line 5536  Getting effect send information</h3>
5536  </p>  </p>
5537  <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"  <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"
5538  </p>  </p>
5539    <p>&nbsp;&nbsp;&nbsp;"EFFECT: NONE"
5540    </p>
5541    <p>&nbsp;&nbsp;&nbsp;"."
5542    </p>
5543    </blockquote><p>
5544                        
5545    </p>
5546    <p>
5547                            </p>
5548    <blockquote class="text">
5549    <p>C: "GET FX_SEND INFO 0 1"
5550    </p>
5551    <p>S: "NAME: Delay Send (Internal)"
5552    </p>
5553    <p>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 93"
5554    </p>
5555    <p>&nbsp;&nbsp;&nbsp;"LEVEL: 0.51"
5556    </p>
5557    <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 1,2"
5558    </p>
5559    <p>&nbsp;&nbsp;&nbsp;"EFFECT: 2,0"
5560    </p>
5561  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
5562  </p>  </p>
5563  </blockquote><p>  </blockquote><p>
# Line 5550  Altering effect send's audio routing</h3 Line 5652  Altering effect send's audio routing</h3
5652                      &lt;audio-src&gt; is the numerical ID of the effect send's audio channel                      &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
5653                      which should be rerouted and &lt;audio-dst&gt; is the numerical ID of                      which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
5654                      the audio channel of the selected audio output device where &lt;audio-src&gt;                      the audio channel of the selected audio output device where &lt;audio-src&gt;
5655                      should be routed to.                      should be routed to. If an internal send effect is assigned
5656                        to the effect send, then this setting defines the audio
5657                        channel routing to that effect instance respectively.
5658  </p>  </p>
5659  <p>Note that effect sends can only route audio to the same audio output  <p>Note that effect sends can only route audio to the same audio output
5660                      device as assigned to the effect send's sampler channel. Also note that an                      device as assigned to the effect send's sampler channel. Also note that an
# Line 5608  Altering effect send's audio routing</h3 Line 5712  Altering effect send's audio routing</h3
5712  </blockquote><p>  </blockquote><p>
5713                                            
5714  </p>  </p>
5715  <a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />  <a name="SET FX_SEND EFFECT"></a><br /><hr />
5716  <table 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>
5717  <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;  <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;
5718    Assigning destination effect to an effect send</h3>
5719    
5720    <p>The front-end can (re-)assign a destination effect to an
5721                        effect send by sending the following command:
5722    </p>
5723    <p>
5724                            </p>
5725    <blockquote class="text">
5726    <p>SET FX_SEND EFFECT &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;effect-chain&gt; &lt;chain-pos&gt;
5727    </p>
5728    </blockquote><p>
5729                        
5730    </p>
5731    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5732                        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>
5733                        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,
5734                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5735                        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>
5736                        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,
5737                        &lt;effect-chain&gt; by the numerical ID of the destination
5738                        effect chain as returned by the
5739                        <a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a>
5740                        or
5741                        <a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a>
5742                        command and &lt;chain-pos&gt; reflects the exact effect
5743                        chain position in the effect chain which hosts the actual
5744                        destination effect.
5745    </p>
5746    <p>Possible Answers:
5747    </p>
5748    <p>
5749                            </p>
5750    <blockquote class="text">
5751    <p>"OK" -
5752                                    </p>
5753    <blockquote class="text">
5754    <p>on success
5755    </p>
5756    </blockquote>
5757                                
5758    
5759    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5760                                    </p>
5761    <blockquote class="text">
5762    <p>in case it failed, providing an appropriate error code and error message
5763    </p>
5764    </blockquote>
5765                                
5766    
5767    </blockquote><p>
5768                        
5769    </p>
5770    <p>Example:
5771    </p>
5772    <p>
5773                            </p>
5774    <blockquote class="text">
5775    <p>C: "SET FX_SEND EFFECT 0 0 2 5"
5776    </p>
5777    <p>S: "OK"
5778    </p>
5779    </blockquote><p>
5780                        
5781    </p>
5782    <a name="REMOVE FX_SEND EFFECT"></a><br /><hr />
5783    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5784    <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;
5785    Removing destination effect from an effect send</h3>
5786    
5787    <p>The front-end can (re-)assign a destination effect to an
5788                        effect send by sending the following command:
5789    </p>
5790    <p>
5791                            </p>
5792    <blockquote class="text">
5793    <p>REMOVE FX_SEND EFFECT &lt;sampler-chan&gt; &lt;fx-send-id&gt;
5794    </p>
5795    </blockquote><p>
5796                        
5797    </p>
5798    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5799                        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>
5800                        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,
5801                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5802                        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>
5803                        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.
5804    </p>
5805    <p>After the destination effect has been removed from the
5806                        effect send, the audio signal of the effect send will be
5807                        routed directly to the audio output device, according to the
5808                        audio channel routing setting of the effect send.
5809                        
5810    </p>
5811    <p>Possible Answers:
5812    </p>
5813    <p>
5814                            </p>
5815    <blockquote class="text">
5816    <p>"OK" -
5817                                    </p>
5818    <blockquote class="text">
5819    <p>on success
5820    </p>
5821    </blockquote>
5822                                
5823    
5824    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5825                                    </p>
5826    <blockquote class="text">
5827    <p>in case it failed, providing an appropriate error code and error message
5828    </p>
5829    </blockquote>
5830                                
5831    
5832    </blockquote><p>
5833                        
5834    </p>
5835    <p>Example:
5836    </p>
5837    <p>
5838                            </p>
5839    <blockquote class="text">
5840    <p>C: "REMOVE FX_SEND EFFECT 0 0"
5841    </p>
5842    <p>S: "OK"
5843    </p>
5844    </blockquote><p>
5845                        
5846    </p>
5847    <a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />
5848    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5849    <a name="rfc.section.6.4.34"></a><h3>6.4.34.&nbsp;
5850  Altering effect send's MIDI controller</h3>  Altering effect send's MIDI controller</h3>
5851    
5852  <p>The front-end can alter the MIDI controller of an effect  <p>The front-end can alter the MIDI controller of an effect
# Line 5681  Altering effect send's MIDI controller</ Line 5917  Altering effect send's MIDI controller</
5917  </p>  </p>
5918  <a name="SET FX_SEND LEVEL"></a><br /><hr />  <a name="SET FX_SEND LEVEL"></a><br /><hr />
5919  <table 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>
5920  <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;  <a name="rfc.section.6.4.35"></a><h3>6.4.35.&nbsp;
5921  Altering effect send's send level</h3>  Altering effect send's send level</h3>
5922    
5923  <p>The front-end can alter the current send level of an effect  <p>The front-end can alter the current send level of an effect
# Line 5753  Altering effect send's send level</h3> Line 5989  Altering effect send's send level</h3>
5989  </p>  </p>
5990  <a name="SEND CHANNEL MIDI_DATA"></a><br /><hr />  <a name="SEND CHANNEL MIDI_DATA"></a><br /><hr />
5991  <table 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>
5992  <a name="rfc.section.6.4.34"></a><h3>6.4.34.&nbsp;  <a name="rfc.section.6.4.36"></a><h3>6.4.36.&nbsp;
5993  Sending MIDI messages to sampler channel</h3>  Sending MIDI messages to sampler channel</h3>
5994    
5995  <p>The front-end can send MIDI events to specific sampler channel  <p>The front-end can send MIDI events to a specific sampler channel
5996                      by sending the following command:                      by sending the following command:
5997  </p>  </p>
5998  <p>  <p>
# Line 5796  Sending MIDI messages to sampler channel Line 6032  Sending MIDI messages to sampler channel
6032  </blockquote>  </blockquote>
6033                                                            
6034    
6035    <p>"CC" -
6036                                    </p>
6037    <blockquote class="text">
6038    <p>For changing a MIDI controller, where &lt;arg1&gt;
6039                                        specifies the controller number and &lt;arg2&gt; the
6040                                        new value of the controller as described in the Control
6041                                        Change section of the MIDI specification.
6042    </p>
6043    </blockquote>
6044                                
6045    
6046  </blockquote><p>  </blockquote><p>
6047                                            
6048  </p>  </p>
# Line 5840  Sending MIDI messages to sampler channel Line 6087  Sending MIDI messages to sampler channel
6087  </p>  </p>
6088  <a name="RESET CHANNEL"></a><br /><hr />  <a name="RESET CHANNEL"></a><br /><hr />
6089  <table 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>
6090  <a name="rfc.section.6.4.35"></a><h3>6.4.35.&nbsp;  <a name="rfc.section.6.4.37"></a><h3>6.4.37.&nbsp;
6091  Resetting a sampler channel</h3>  Resetting a sampler channel</h3>
6092    
6093  <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 6407  Setting global volume attenuation</h3> Line 6654  Setting global volume attenuation</h3>
6654  </blockquote><p>  </blockquote><p>
6655                                            
6656  </p>  </p>
6657    <a name="GET VOICES"></a><br /><hr />
6658    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6659    <a name="rfc.section.6.6.8"></a><h3>6.6.8.&nbsp;
6660    Getting global voice limit</h3>
6661    
6662    <p>The client can ask for the current global sampler-wide limit
6663                           for maximum voices by sending the following command:
6664    </p>
6665    <p>
6666                            </p>
6667    <blockquote class="text">
6668    <p>GET VOICES
6669    </p>
6670    </blockquote><p>
6671                        
6672    </p>
6673    <p>Possible Answers:
6674    </p>
6675    <p>
6676                            </p>
6677    <blockquote class="text">
6678    <p>LinuxSampler will answer by returning the number for
6679                                   the current limit of maximum voices.
6680    </p>
6681    </blockquote><p>
6682                        
6683    </p>
6684    <p>The voice limit setting defines how many voices should maximum
6685                           be processed by the sampler at the same time. If the user
6686                           triggers new notes which would exceed that voice limit, the
6687                           sampler engine will react by stealing old voices for those
6688                           newly triggered notes. Note that the amount of voices triggered
6689                           by a new note can be larger than one and is dependent to the
6690                           respective instrument and probably further criterias.
6691    </p>
6692    <a name="SET VOICES"></a><br /><hr />
6693    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6694    <a name="rfc.section.6.6.9"></a><h3>6.6.9.&nbsp;
6695    Setting global voice limit</h3>
6696    
6697    <p>The client can alter the current global sampler-wide limit
6698                        for maximum voices by sending the following command:
6699    </p>
6700    <p>
6701                            </p>
6702    <blockquote class="text">
6703    <p>SET VOICES &lt;max-voices&gt;
6704    </p>
6705    </blockquote><p>
6706                        
6707    </p>
6708    <p>Where &lt;max-voices&gt; should be replaced by the integer
6709                       value, reflecting the new global amount limit of maximum voices.
6710                       This value has to be larger than 0.
6711    </p>
6712    <p>Possible Answers:
6713    </p>
6714    <p>
6715                            </p>
6716    <blockquote class="text">
6717    <p>"OK" -
6718                                    </p>
6719    <blockquote class="text">
6720    <p>on success
6721    </p>
6722    </blockquote>
6723                                
6724    
6725    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6726                                    </p>
6727    <blockquote class="text">
6728    <p>if the voice limit was set, but there are noteworthy
6729                                        issue(s) related, providing an appropriate warning code and
6730                                        warning message
6731    </p>
6732    </blockquote>
6733                                
6734    
6735    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6736                                    </p>
6737    <blockquote class="text">
6738    <p>in case it failed, providing an appropriate error code and error message
6739    </p>
6740    </blockquote>
6741                                
6742    
6743    </blockquote><p>
6744                        
6745    </p>
6746    <p>Note: the given value will be passed to all sampler engine instances.
6747                           The total amount of maximum voices on the running system might thus
6748                           be as big as the given value multiplied by the current amount of engine
6749                           instances.
6750    </p>
6751    <p>Caution: when adjusting the voice limit, you SHOULD also
6752                            adjust the disk stream limit respectively and vice versa.
6753    </p>
6754    <a name="GET STREAMS"></a><br /><hr />
6755    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6756    <a name="rfc.section.6.6.10"></a><h3>6.6.10.&nbsp;
6757    Getting global disk stream limit</h3>
6758    
6759    <p>The client can ask for the current global sampler-wide limit
6760                           for maximum disk streams by sending the following command:
6761    </p>
6762    <p>
6763                            </p>
6764    <blockquote class="text">
6765    <p>GET STREAMS
6766    </p>
6767    </blockquote><p>
6768                        
6769    </p>
6770    <p>Possible Answers:
6771    </p>
6772    <p>
6773                            </p>
6774    <blockquote class="text">
6775    <p>LinuxSampler will answer by returning the number for
6776                                   the current limit of maximum disk streams.
6777    </p>
6778    </blockquote><p>
6779                        
6780    </p>
6781    <p>The disk stream limit setting defines how many disk streams should
6782                           maximum be processed by a sampler engine at the same time. The
6783                           higher this value, the more memory (RAM) will be occupied, since
6784                           every disk streams allocates a certain buffer size for being able
6785                           to perform its streaming operations.
6786    </p>
6787    <a name="SET STREAMS"></a><br /><hr />
6788    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6789    <a name="rfc.section.6.6.11"></a><h3>6.6.11.&nbsp;
6790    Setting global disk stream limit</h3>
6791    
6792    <p>The client can alter the current global sampler-wide limit
6793                        for maximum disk streams by sending the following command:
6794    </p>
6795    <p>
6796                            </p>
6797    <blockquote class="text">
6798    <p>SET STREAMS &lt;max-streams&gt;
6799    </p>
6800    </blockquote><p>
6801                        
6802    </p>
6803    <p>Where &lt;max-streams&gt; should be replaced by the integer
6804                       value, reflecting the new global amount limit of maximum disk streams.
6805                       This value has to be positive.
6806    </p>
6807    <p>Possible Answers:
6808    </p>
6809    <p>
6810                            </p>
6811    <blockquote class="text">
6812    <p>"OK" -
6813                                    </p>
6814    <blockquote class="text">
6815    <p>on success
6816    </p>
6817    </blockquote>
6818                                
6819    
6820    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6821                                    </p>
6822    <blockquote class="text">
6823    <p>if the disk stream limit was set, but there are noteworthy
6824                                        issue(s) related, providing an appropriate warning code and
6825                                        warning message
6826    </p>
6827    </blockquote>
6828                                
6829    
6830    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6831                                    </p>
6832    <blockquote class="text">
6833    <p>in case it failed, providing an appropriate error code and error message
6834    </p>
6835    </blockquote>
6836                                
6837    
6838    </blockquote><p>
6839                        
6840    </p>
6841    <p>Note: the given value will be passed to all sampler engine instances.
6842                           The total amount of maximum disk streams on the running system might
6843                           thus be as big as the given value multiplied by the current amount of
6844                           engine instances.
6845    </p>
6846    <p>Caution: when adjusting the disk stream limit, you SHOULD also
6847                            adjust the voice limit respectively and vice versa.
6848    </p>
6849  <a name="MIDI Instrument Mapping"></a><br /><hr />  <a name="MIDI Instrument Mapping"></a><br /><hr />
6850  <table 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>
6851  <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;  <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;
# Line 8153  Adding instruments to the instruments da Line 8592  Adding instruments to the instruments da
8592  <p>  <p>
8593                          </p>                          </p>
8594  <blockquote class="text">  <blockquote class="text">
8595  <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;]
8596  </p>  </p>
8597  </blockquote><p>  </blockquote><p>
8598                                            
# Line 8211  Adding instruments to the instruments da Line 8650  Adding instruments to the instruments da
8650  </blockquote><p>  </blockquote><p>
8651                                            
8652  </p>  </p>
8653    <p> If FILE_AS_DIR argument is supplied, all instruments in an instrument
8654                     file will be added to a separate directory in the instruments database, which
8655                     name will be the name of the instrument file with the file extension stripped off.
8656                    
8657    </p>
8658  <p>The difference between regular and NON_MODAL versions of the command  <p>The difference between regular and NON_MODAL versions of the command
8659                      is that the regular command returns when the scanning is finished                      is that the regular command returns when the scanning is finished
8660                      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 9672  Retrieving informations about one instru Line 10116  Retrieving informations about one instru
10116  </blockquote><p>  </blockquote><p>
10117                                            
10118  </p>  </p>
10119    <a name="effects"></a><br /><hr />
10120    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10121    <a name="rfc.section.6.11"></a><h3>6.11.&nbsp;
10122    Managing Effects</h3>
10123    
10124    <p>Audio effects (e.g. reverb, delay, compression) can be
10125                    applied to the audio signals generated by the sampler. The
10126                    sampler usually provides a set of internal audio effects for
10127                    this task. The exact set of effects depends on the availability
10128                    of third party effect plugins installed on the system where the
10129                    sampler runs on.
10130    </p>
10131    <p>At the moment only "send effects" are supported. Support for
10132                    "insert effects" and "master effects" is planned to be added at
10133                    a later point.
10134    </p>
10135    <p>The following commands allow to retrieve the set of internal
10136                    effects available to the sampler, detailed informations about
10137                    those effects and to create and destroy instances of such
10138                    effects. After an instance of an effect is created, the effect
10139                    instance can be inserted into the audio signal path of the
10140                    sampler, e.g. as send effect.
10141    </p>
10142    <p>The sampler allows to create an arbitrary amount of so called
10143                    send effect chains. Each effect chain can host an arbitrary
10144                    amount of effect instances. The output of the first effect
10145                    instance in an effect chain is fed to the input of the second
10146                    effect instance of the chain and so on. So effects in one chain
10147                    are processed sequentially. Send effect chains however are
10148                    processed in parallel to other send effect chains. Audio signals
10149                    of sampler channels are fed to send effects by creating FX sends
10150                    to the respective sampler channel and assigning a destination
10151                    send effect to that FX by using the
10152                    <a class='info' href='#SET FX_SEND EFFECT'>"SET FX_SEND EFFECT"<span> (</span><span class='info'>Assigning destination effect to an effect send</span><span>)</span></a>
10153                    command. The latter allows to route the FX send to the beginning
10154                    of a send effect chain, as well as directly to any other
10155                    position of the send effect chain.
10156    </p>
10157    <a name="GET AVAILABLE_EFFECTS"></a><br /><hr />
10158    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10159    <a name="rfc.section.6.11.1"></a><h3>6.11.1.&nbsp;
10160    Retrieve amount of available effects</h3>
10161    
10162    <p>The front-end can retrieve the amount of internal
10163                        effects, available to the sampler by sending
10164                        the following command:
10165    </p>
10166    <p>
10167                            </p>
10168    <blockquote class="text">
10169    <p>GET AVAILABLE_EFFECTS
10170    </p>
10171    </blockquote><p>
10172                        
10173    </p>
10174    <p>Possible Answers:
10175    </p>
10176    <p>
10177                            </p>
10178    <blockquote class="text">
10179    <p>The sampler will answer by returning the current
10180                                number of effects available to the sampler.
10181    </p>
10182    </blockquote><p>
10183                        
10184    </p>
10185    <p>Examples:
10186    </p>
10187    <p>
10188                            </p>
10189    <blockquote class="text">
10190    <p>C: "GET AVAILABLE_EFFECTS"
10191    </p>
10192    <p>S: "129"
10193    </p>
10194    </blockquote><p>
10195                        
10196    </p>
10197    <a name="LIST AVAILABLE_EFFECTS"></a><br /><hr />
10198    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10199    <a name="rfc.section.6.11.2"></a><h3>6.11.2.&nbsp;
10200    Get list of available effects</h3>
10201    
10202    <p>The set of available internal effects can change at
10203                        runtime. The front-end can retrieve the list of internal
10204                        effects, available to the sampler by sending the following
10205                        command:
10206    </p>
10207    <p>
10208                            </p>
10209    <blockquote class="text">
10210    <p>LIST AVAILABLE_EFFECTS
10211    </p>
10212    </blockquote><p>
10213                        
10214    </p>
10215    <p>Possible Answers:
10216    </p>
10217    <p>
10218                            </p>
10219    <blockquote class="text">
10220    <p>The sampler will answer by returning a comma
10221                                separated list with numerical IDs of effects. Note:
10222                                the numercial ID of an effect is generated by the
10223                                sampler for the current moment. The numerical ID of
10224                                the same effect can change at runtime, e.g. when the
10225                                user requests a rescan of available effect plugins.
10226                                
10227    </p>
10228    </blockquote><p>
10229                        
10230    </p>
10231    <p>Example:
10232    </p>
10233    <p>
10234                            </p>
10235    <blockquote class="text">
10236    <p>C: "LIST AVAILABLE_EFFECTS"
10237    </p>
10238    <p>S: "5,6,7,120,121,122,123,124"
10239    </p>
10240    </blockquote><p>
10241                        
10242    </p>
10243    <a name="GET EFFECT INFO"></a><br /><hr />
10244    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10245    <a name="rfc.section.6.11.3"></a><h3>6.11.3.&nbsp;
10246    Retrieving general information about an effect</h3>
10247    
10248    <p>The front-end can ask for general informations about an
10249                        effect by sending the following command:
10250    </p>
10251    <p>
10252                            </p>
10253    <blockquote class="text">
10254    <p>GET EFFECT INFO &lt;effect-index&gt;
10255    </p>
10256    </blockquote><p>
10257                        
10258    </p>
10259    <p>Where &lt;effect-index&gt; is the numerical ID of an
10260                        effect as returned by the
10261                        <a class='info' href='#LIST AVAILABLE_EFFECTS'>"LIST AVAILABLE_EFFECTS"<span> (</span><span class='info'>Get list of available effects</span><span>)</span></a>
10262                        command.
10263    </p>
10264    <p>Possible Answers:
10265    </p>
10266    <p>
10267                            </p>
10268    <blockquote class="text">
10269    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
10270                                Each answer line begins with the effect information
10271                                category name, followed by a colon and then a space
10272                                character &lt;SP&gt; and finally the info character
10273                                string to that effect information category. At the
10274                                moment the following categories are defined:
10275    </p>
10276    <p>
10277                                    </p>
10278    <blockquote class="text">
10279    <p>SYSTEM -
10280                                            </p>
10281    <blockquote class="text">
10282    <p>name of the effect plugin system
10283                                                the effect is based on
10284                                                (e.g. "LADSPA")
10285    </p>
10286    </blockquote>
10287                                        
10288    
10289    <p>MODULE -
10290                                            </p>
10291    <blockquote class="text">
10292    <p>module of the effect plugin
10293                                                system that contains this effect,
10294                                                the module is usually the
10295                                                dynamic-linked library (DLL)
10296                                                filename of the effect plugin,
10297                                                including full path (note that this
10298                                                filename may contain
10299                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
10300    </p>
10301    </blockquote>
10302                                        
10303    
10304    <p>NAME -
10305                                            </p>
10306    <blockquote class="text">
10307    <p>character string defining the
10308                                                unique name of the effect within its
10309                                                module (note that the character
10310                                                string may contain
10311                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
10312    </p>
10313    </blockquote>
10314                                        
10315    
10316    <p>DESCRIPTION -
10317                                            </p>
10318    <blockquote class="text">
10319    <p>human readable name of the
10320                                                effect, intended to be displayed in
10321                                                user interfaces (note that the
10322                                                character string may contain
10323                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
10324    </p>
10325    </blockquote>
10326                                        
10327    
10328    </blockquote>
10329                                
10330    
10331    </blockquote><p>
10332                        
10333    </p>
10334    <p>The mentioned fields above don't have to be in particular order.
10335    </p>
10336    <p>Example:
10337    </p>
10338    <p>
10339                            </p>
10340    <blockquote class="text">
10341    <p>C: "GET EFFECT INFO 121"
10342    </p>
10343    <p>S: "SYSTEM: LADSPA"
10344    </p>
10345    <p>&nbsp;&nbsp;&nbsp;"MODULE: /usr/lib/ladspa/lowpass_iir_1891.so"
10346    </p>
10347    <p>&nbsp;&nbsp;&nbsp;"NAME: lowpass_iir"
10348    </p>
10349    <p>&nbsp;&nbsp;&nbsp;"DESCRIPTION: Glame Lowpass Filter"
10350    </p>
10351    <p>&nbsp;&nbsp;&nbsp;"."
10352    </p>
10353    </blockquote><p>
10354                        
10355    </p>
10356    <a name="CREATE EFFECT_INSTANCE"></a><br /><hr />
10357    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10358    <a name="rfc.section.6.11.4"></a><h3>6.11.4.&nbsp;
10359    Creating an instance of an effect by its portable ID</h3>
10360    
10361    <p>The front-end can spawn an instance of the desired
10362                        effect by sending the following command:
10363    </p>
10364    <p>
10365                            </p>
10366    <blockquote class="text">
10367    <p>CREATE EFFECT_INSTANCE &lt;effect-system&gt; &lt;module&gt; &lt;effect-name&gt;
10368    </p>
10369    </blockquote><p>
10370                        
10371    </p>
10372    <p>Where &lt;effect-system&gt; is the "SYSTEM" field,
10373                        &lt;module&gt; the "MODULE" field and &lt;effect-name&gt;
10374                        the "NAME" field as returned by the
10375                        <a class='info' href='#GET EFFECT INFO'>"GET EFFECT INFO"<span> (</span><span class='info'>Retrieving general information about an effect</span><span>)</span></a>
10376                        command. The filename of argument &lt;module&gt; and the
10377                        character string of argument &lt;effect-name&gt; may contain
10378                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
10379    </p>
10380    <p>The sampler will try to load the requested effect and to
10381                        create an instance of it. To allow loading the same effect
10382                        on a different machine, probably even running a completely
10383                        different operating system (e.g. Linux vs. Windows), the
10384                        sampler tries to match &lt;module&gt; "softly". That means
10385                        it first tries to find an effect that exactly matches the
10386                        given &lt;module&gt; argument. If there is no exact match,
10387                        the sampler will try to lower the restrictions on matching
10388                        the &lt;module&gt; argument more and more, e.g. by ignoring
10389                        upper / lower case differences and by ignoring the path of
10390                        the DLL filename and file extension. If there is still no
10391                        match at the end, the sampler will try to ignore the
10392                        &lt;module&gt; argument completely and as a last resort
10393                        search for an effect that only matches the given
10394                        &lt;effect-system&gt; and &lt;effect-name&gt; arguments.
10395    </p>
10396    <p>Possible Answers:
10397    </p>
10398    <p>
10399                            </p>
10400    <blockquote class="text">
10401    <p>"OK[&lt;effect-instance&gt;]" -
10402                                    </p>
10403    <blockquote class="text">
10404    <p>in case the effect instance was
10405                                        successfully created, where
10406                                        &lt;effect-instance&gt; is the numerical ID
10407                                        of the new effect instance
10408    </p>
10409    </blockquote>
10410                                
10411    
10412    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
10413                                    </p>
10414    <blockquote class="text">
10415    <p>in case the effect instance was spawned
10416                                        successfully, but there are noteworthy
10417                                        issue(s) related, providing an appropriate
10418                                        warning code and warning message
10419    </p>
10420    </blockquote>
10421                                
10422    
10423    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
10424                                    </p>
10425    <blockquote class="text">
10426    <p>if the effect could not be instantiated
10427    </p>
10428    </blockquote>
10429                                
10430    
10431    </blockquote><p>
10432                        
10433    </p>
10434    <p>Examples:
10435    </p>
10436    <p>
10437                            </p>
10438    <blockquote class="text">
10439    <p>C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/mod_delay_1419.so' 'modDelay'"
10440    </p>
10441    <p>S: "OK[0]"
10442    </p>
10443    </blockquote><p>
10444                        
10445    </p>
10446    <a name="CREATE EFFECT_INSTANCE (non-portable)"></a><br /><hr />
10447    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10448    <a name="rfc.section.6.11.5"></a><h3>6.11.5.&nbsp;
10449    Creating an instance of an effect by its numerical ID</h3>
10450    
10451    <p>The front-end can spawn an instance of the desired
10452                        effect by sending the following command:
10453    </p>
10454    <p>
10455                            </p>
10456    <blockquote class="text">
10457    <p>CREATE EFFECT_INSTANCE &lt;effect-index&gt;
10458    </p>
10459    </blockquote><p>
10460                        
10461    </p>
10462    <p>Where &lt;effect-index&gt; is the numerical ID of the
10463                        effect as returned by the
10464                        <a class='info' href='#LIST AVAILABLE_EFFECTS'>"LIST AVAILABLE_EFFECTS"<span> (</span><span class='info'>Get list of available effects</span><span>)</span></a>
10465                        command.
10466    </p>
10467    <p>The sampler will try to load the requested effect and to
10468                        create an instance of it.
10469    </p>
10470    <p>Note: Since the numerical ID of a certain effect can
10471                        change at any time, you should not use this command in
10472                        LSCP files to restore a certain effect at a later time! To
10473                        store a sampler session including all its effects, use the
10474                        <a class='info' href='#CREATE EFFECT_INSTANCE'>portable text-based
10475                        version of "CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> instead! This
10476                        allows to restore a sampler session with all its effects
10477                        also on other machines, possibly even running a completely
10478                        different operating system (e.g. Linux vs. Windows), with
10479                        different plugin directories or plugin DLL names.
10480    </p>
10481    <p>Possible Answers:
10482    </p>
10483    <p>
10484                            </p>
10485    <blockquote class="text">
10486    <p>"OK[&lt;effect-instance&gt;]" -
10487                                    </p>
10488    <blockquote class="text">
10489    <p>in case the effect instance was
10490                                        successfully created, where
10491                                        &lt;effect-instance&gt; is the numerical ID
10492                                        of the new effect instance
10493    </p>
10494    </blockquote>
10495                                
10496    
10497    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
10498                                    </p>
10499    <blockquote class="text">
10500    <p>in case the effect instance was spawned
10501                                        successfully, but there are noteworthy
10502                                        issue(s) related, providing an appropriate
10503                                        warning code and warning message
10504    </p>
10505    </blockquote>
10506                                
10507    
10508    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
10509                                    </p>
10510    <blockquote class="text">
10511    <p>if the effect could not be instantiated
10512    </p>
10513    </blockquote>
10514                                
10515    
10516    </blockquote><p>
10517                        
10518    </p>
10519    <p>Examples:
10520    </p>
10521    <p>
10522                            </p>
10523    <blockquote class="text">
10524    <p>C: "CREATE EFFECT_INSTANCE 72"
10525    </p>
10526    <p>S: "OK[5]"
10527    </p>
10528    </blockquote><p>
10529                        
10530    </p>
10531    <a name="DESTROY EFFECT_INSTANCE"></a><br /><hr />
10532    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10533    <a name="rfc.section.6.11.6"></a><h3>6.11.6.&nbsp;
10534    Destroy an effect instance</h3>
10535    
10536    <p>The front-end can destroy an unusued effect instance and
10537                        thus freeing it from memory by sending the following command:
10538    </p>
10539    <p>
10540                            </p>
10541    <blockquote class="text">
10542    <p>DESTROY EFFECT_INSTANCE &lt;effect-instance&gt;
10543    </p>
10544    </blockquote><p>
10545                        
10546    </p>
10547    <p>Where &lt;effect-instance&gt; is the numerical ID of the
10548                        effect instance as returned by the
10549                        <a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> or
10550                        <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
10551                        command.
10552    </p>
10553    <p>The effect instance can only be destroyed if it's not
10554                        used in any part of the sampler's audio signal path anymore.
10555                        If the effect instance is still in use somewhere, trying to
10556                        destroy the effect instance will result in an error
10557                        message.
10558    </p>
10559    <p>Possible Answers:
10560    </p>
10561    <p>
10562                            </p>
10563    <blockquote class="text">
10564    <p>"OK" -
10565                                    </p>
10566    <blockquote class="text">
10567    <p>in case the effect instance was successfully destroyed
10568    </p>
10569    </blockquote>
10570                                
10571    
10572    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
10573                                    </p>
10574    <blockquote class="text">
10575    <p>in case it failed, providing an appropriate error code and
10576                                        error message
10577    </p>
10578    </blockquote>
10579                                
10580    
10581    </blockquote><p>
10582                        
10583    </p>
10584    <p>Examples:
10585    </p>
10586    <p>
10587                            </p>
10588    <blockquote class="text">
10589    <p>C: "DESTROY EFFECT_INSTANCE 5"
10590    </p>
10591    <p>S: "OK"
10592    </p>
10593    </blockquote><p>
10594                        
10595    </p>
10596    <a name="GET EFFECT_INSTANCES"></a><br /><hr />
10597    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10598    <a name="rfc.section.6.11.7"></a><h3>6.11.7.&nbsp;
10599    Retrieve amount of effect instances</h3>
10600    
10601    <p>The front-end can retrieve the current amount of effect
10602                        instances by sending the following command:
10603    </p>
10604    <p>
10605                            </p>
10606    <blockquote class="text">
10607    <p>GET EFFECT_INSTANCES
10608    </p>
10609    </blockquote><p>
10610                        
10611    </p>
10612    <p>Possible Answers:
10613    </p>
10614    <p>
10615                            </p>
10616    <blockquote class="text">
10617    <p>The sampler will answer by returning the current
10618                                number of effect instances created and not yet
10619                                destroyed in the current sampler session.
10620    </p>
10621    </blockquote><p>
10622                        
10623    </p>
10624    <p>Examples:
10625    </p>
10626    <p>
10627                            </p>
10628    <blockquote class="text">
10629    <p>C: "GET EFFECT_INSTANCES"
10630    </p>
10631    <p>S: "14"
10632    </p>
10633    </blockquote><p>
10634                        
10635    </p>
10636    <a name="LIST EFFECT_INSTANCES"></a><br /><hr />
10637    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10638    <a name="rfc.section.6.11.8"></a><h3>6.11.8.&nbsp;
10639    Get list of effect instances</h3>
10640    
10641    <p>The front-end can retrieve the current list of effect
10642                        instances by sending the following command:
10643    </p>
10644    <p>
10645                            </p>
10646    <blockquote class="text">
10647    <p>LIST EFFECT_INSTANCES
10648    </p>
10649    </blockquote><p>
10650                        
10651    </p>
10652    <p>Possible Answers:
10653    </p>
10654    <p>
10655                            </p>
10656    <blockquote class="text">
10657    <p>The sampler will answer by returning a comma
10658                                separated list with numerical IDs of effects
10659                                instances.
10660                                
10661    </p>
10662    </blockquote><p>
10663                        
10664    </p>
10665    <p>Example:
10666    </p>
10667    <p>
10668                            </p>
10669    <blockquote class="text">
10670    <p>C: "LIST EFFECT_INSTANCES"
10671    </p>
10672    <p>S: "9,11,14,15,16,17,25"
10673    </p>
10674    </blockquote><p>
10675                        
10676    </p>
10677    <a name="GET EFFECT_INSTANCE INFO"></a><br /><hr />
10678    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10679    <a name="rfc.section.6.11.9"></a><h3>6.11.9.&nbsp;
10680    Retrieving current information about an effect instance</h3>
10681    
10682    <p>The front-end can ask for the current informations about
10683                        a particular effect instance by sending the following command:
10684    </p>
10685    <p>
10686                            </p>
10687    <blockquote class="text">
10688    <p>GET EFFECT_INSTANCE INFO &lt;effect-instance&gt;
10689    </p>
10690    </blockquote><p>
10691                        
10692    </p>
10693    <p>Where &lt;effect-instance&gt; is the numerical ID of an
10694                        effect instance as returned by the
10695                        <a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a>
10696                        or
10697                        <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
10698                        command.
10699    </p>
10700    <p>Possible Answers:
10701    </p>
10702    <p>
10703                            </p>
10704    <blockquote class="text">
10705    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
10706                                Each answer line begins with the information
10707                                category name, followed by a colon and then a space
10708                                character &lt;SP&gt; and finally the info character
10709                                string to that information category. At the
10710                                moment the following categories are defined:
10711    </p>
10712    <p>
10713                                    </p>
10714    <blockquote class="text">
10715    <p>SYSTEM -
10716                                            </p>
10717    <blockquote class="text">
10718    <p>name of the effect plugin system
10719                                                the effect is based on
10720                                                (e.g. "LADSPA")
10721    </p>
10722    </blockquote>
10723                                        
10724    
10725    <p>MODULE -
10726                                            </p>
10727    <blockquote class="text">
10728    <p>module of the effect plugin
10729                                                system that contains this effect,
10730                                                the module is usually the
10731                                                dynamic-linked library (DLL)
10732                                                filename of the effect plugin,
10733                                                including full path (note that this
10734                                                filename may contain
10735                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
10736    </p>
10737    </blockquote>
10738                                        
10739    
10740    <p>NAME -
10741                                            </p>
10742    <blockquote class="text">
10743    <p>character string defining the
10744                                                unique name of the effect within its
10745                                                module (note that the character
10746                                                string may contain
10747                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
10748    </p>
10749    </blockquote>
10750                                        
10751    
10752    <p>DESCRIPTION -
10753                                            </p>
10754    <blockquote class="text">
10755    <p>human readable name of the
10756                                                effect, intended to be displayed in
10757                                                user interfaces (note that the
10758                                                character string may contain
10759                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
10760    </p>
10761    </blockquote>
10762                                        
10763    
10764    <p>INPUT_CONTROLS -
10765                                            </p>
10766    <blockquote class="text">
10767    <p>amount of input controls the
10768                                                effect instance provides, to allow
10769                                                controlling the effect parameters in
10770                                                realtime
10771    </p>
10772    </blockquote>
10773                                        
10774    
10775    </blockquote>
10776                                
10777    
10778    </blockquote><p>
10779                        
10780    </p>
10781    <p>The mentioned fields above don't have to be in particular order.
10782    </p>
10783    <p>Example:
10784    </p>
10785    <p>
10786                            </p>
10787    <blockquote class="text">
10788    <p>C: "GET EFFECT_INSTANCE INFO 3"
10789    </p>
10790    <p>S: "SYSTEM: LADSPA"
10791    </p>
10792    <p>&nbsp;&nbsp;&nbsp;"MODULE: /usr/lib/ladspa/mod_delay_1419.so"
10793    </p>
10794    <p>&nbsp;&nbsp;&nbsp;"NAME: modDelay"
10795    </p>
10796    <p>&nbsp;&nbsp;&nbsp;"DESCRIPTION: Modulatable delay"
10797    </p>
10798    <p>&nbsp;&nbsp;&nbsp;"INPUT_CONTROLS: 1"
10799    </p>
10800    <p>&nbsp;&nbsp;&nbsp;"."
10801    </p>
10802    </blockquote><p>
10803                        
10804    </p>
10805    <a name="GET EFFECT_INSTANCE_INPUT_CONTROL INFO"></a><br /><hr />
10806    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10807    <a name="rfc.section.6.11.10"></a><h3>6.11.10.&nbsp;
10808    Retrieving information about an effect parameter</h3>
10809    
10810    <p>Effects typically provide a certain set of effect
10811                        parameters which can be altered by the user in realtime
10812                        (e.g. depth of a reverb effect, duration of a delay effect,
10813                        dry / wet signal ratio). Those controllable effect parameters
10814                        are called "input controls". The front-end can ask for the
10815                        current informations of an effect instance's input control
10816                        by sending the following command:
10817    </p>
10818    <p>
10819                            </p>
10820    <blockquote class="text">
10821    <p>GET EFFECT_INSTANCE_INPUT_CONTROL INFO &lt;effect-instance&gt; &lt;input-control&gt;
10822    </p>
10823    </blockquote><p>
10824                        
10825    </p>
10826    <p>Where &lt;effect-instance&gt; is the numerical ID of an
10827                        effect instance as returned by the
10828                        <a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a>
10829                        or
10830                        <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
10831                        command and &lt;input-control&gt; is the index of the input
10832                        control within the numerical bounds as returned by the
10833                        "INPUT_CONTROLS" field of the
10834                        <a class='info' href='#GET EFFECT_INSTANCE INFO'>"GET EFFECT_INSTANCE INFO"<span> (</span><span class='info'>Retrieving current information about an effect instance</span><span>)</span></a>
10835                        command.
10836    </p>
10837    <p>Possible Answers:
10838    </p>
10839    <p>
10840                            </p>
10841    <blockquote class="text">
10842    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
10843                                Each answer line begins with the information
10844                                category name, followed by a colon and then a space
10845                                character &lt;SP&gt; and finally the info character
10846                                string to that information category. There are
10847                                information categories which are always returned,
10848                                independent of the respective effect parameter and
10849                                there are optional information categories
10850                                which are only shown for certain effect parameters.
10851                                At the moment the following categories are defined:
10852    </p>
10853    <p>
10854                                    </p>
10855    <blockquote class="text">
10856    <p>DESCRIPTION -
10857                                            </p>
10858    <blockquote class="text">
10859    <p>(always returned)
10860                                                human readable name of the
10861                                                effect parameter, intended to be
10862                                                displayed in user interfaces (note
10863                                                that the character string may
10864                                                contain <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
10865    </p>
10866    </blockquote>
10867                                        
10868    
10869    <p>VALUE -
10870                                            </p>
10871    <blockquote class="text">
10872    <p>
10873                                                (always returned)
10874                                                current (optional dotted)
10875                                                floating point value of this effect
10876                                                parameter
10877    </p>
10878    </blockquote>
10879                                        
10880    
10881    <p>RANGE_MIN -
10882                                            </p>
10883    <blockquote class="text">
10884    <p>
10885                                                (optionally returned)
10886                                                minimum allowed value for this
10887                                                effect parameter
10888    </p>
10889    </blockquote>
10890                                        
10891    
10892    <p>RANGE_MAX -
10893                                            </p>
10894    <blockquote class="text">
10895    <p>
10896                                                (optionally returned)
10897                                                maximum allowed value for this
10898                                                effect parameter
10899    </p>
10900    </blockquote>
10901                                        
10902    
10903    <p>POSSIBILITIES -
10904                                            </p>
10905    <blockquote class="text">
10906    <p>
10907                                                (optionally returned)
10908                                                comma separated list of
10909                                                (optional dotted) floating point
10910                                                numbers, reflecting the exact set of
10911                                                possible values for this effect
10912                                                parameter
10913    </p>
10914    </blockquote>
10915                                        
10916    
10917    <p>DEFAULT -
10918                                            </p>
10919    <blockquote class="text">
10920    <p>
10921                                                (optionally returned)
10922                                                default value of this effect
10923                                                parameter
10924    </p>
10925    </blockquote>
10926                                        
10927    
10928    </blockquote>
10929                                
10930    
10931    </blockquote><p>
10932                        
10933    </p>
10934    <p>The mentioned fields above don't have to be in particular order.
10935    </p>
10936    <p>Example:
10937    </p>
10938    <p>
10939                            </p>
10940    <blockquote class="text">
10941    <p>C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0"
10942    </p>
10943    <p>S: "DESCRIPTION: Base delay (s)"
10944    </p>
10945    <p>&nbsp;&nbsp;&nbsp;"VALUE: 0.500"
10946    </p>
10947    <p>&nbsp;&nbsp;&nbsp;"RANGE_MIN: 0.000"
10948    </p>
10949    <p>&nbsp;&nbsp;&nbsp;"."
10950    </p>
10951    </blockquote><p>
10952                        
10953    </p>
10954    <a name="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE"></a><br /><hr />
10955    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10956    <a name="rfc.section.6.11.11"></a><h3>6.11.11.&nbsp;
10957    Altering an effect parameter</h3>
10958    
10959    <p>The front-end can alter the current value of an effect
10960                        parameter by sending the following command:
10961    </p>
10962    <p>
10963                            </p>
10964    <blockquote class="text">
10965    <p>SET EFFECT_INSTANCE_INPUT_CONTROL VALUE &lt;effect-instance&gt; &lt;input-control&gt; &lt;value&gt;
10966    </p>
10967    </blockquote><p>
10968                        
10969    </p>
10970    <p>Where &lt;effect-instance&gt; is the numerical ID of the
10971                        effect instance as returned by the
10972                        <a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> or
10973                        <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
10974                        command, &lt;input-control&gt; is the index of the input
10975                        control within the numerical bounds as returned by the
10976                        "INPUT_CONTROLS" field of the
10977                        <a class='info' href='#GET EFFECT_INSTANCE INFO'>"GET EFFECT_INSTANCE INFO"<span> (</span><span class='info'>Retrieving current information about an effect instance</span><span>)</span></a>
10978                        command and &lt;value&gt; is the new (optional dotted)
10979                        floating point value for this effect parameter.
10980    </p>
10981    <p>Possible Answers:
10982    </p>
10983    <p>
10984                            </p>
10985    <blockquote class="text">
10986    <p>"OK" -
10987                                    </p>
10988    <blockquote class="text">
10989    <p>in case the effect was altered successfully
10990    </p>
10991    </blockquote>
10992                                
10993    
10994    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
10995                                    </p>
10996    <blockquote class="text">
10997    <p>in case it failed, providing an appropriate error code and
10998                                        error message
10999    </p>
11000    </blockquote>
11001                                
11002    
11003    </blockquote><p>
11004                        
11005    </p>
11006    <p>Examples:
11007    </p>
11008    <p>
11009                            </p>
11010    <blockquote class="text">
11011    <p>C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5"
11012    </p>
11013    <p>S: "OK"
11014    </p>
11015    </blockquote><p>
11016                        
11017    </p>
11018    <a name="GET SEND_EFFECT_CHAINS"></a><br /><hr />
11019    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11020    <a name="rfc.section.6.11.12"></a><h3>6.11.12.&nbsp;
11021    Retrieve amount of send effect chains</h3>
11022    
11023    <p>The front-end can retrieve the current amount of send
11024                        effect chains of an audio output device by sending the
11025                        following command:
11026    </p>
11027    <p>
11028                            </p>
11029    <blockquote class="text">
11030    <p>GET SEND_EFFECT_CHAINS &lt;audio-device&gt;
11031    </p>
11032    </blockquote><p>
11033                        
11034    </p>
11035    <p>Where &lt;audio-device&gt; should be replaced by the
11036                        numerical ID of the audio output device as given by the
11037                        <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
11038                        or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
11039                        command.
11040    </p>
11041    <p>Possible Answers:
11042    </p>
11043    <p>
11044                            </p>
11045    <blockquote class="text">
11046    <p>The sampler will answer by returning the current
11047                                number of send effect chains of the supplied audio
11048                                output device.
11049    </p>
11050    </blockquote><p>
11051                        
11052    </p>
11053    <p>Examples:
11054    </p>
11055    <p>
11056                            </p>
11057    <blockquote class="text">
11058    <p>C: "GET SEND_EFFECT_CHAINS 0"
11059    </p>
11060    <p>S: "4"
11061    </p>
11062    </blockquote><p>
11063                        
11064    </p>
11065    <a name="LIST SEND_EFFECT_CHAINS"></a><br /><hr />
11066    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11067    <a name="rfc.section.6.11.13"></a><h3>6.11.13.&nbsp;
11068    Retrieve list of send effect chains</h3>
11069    
11070    <p>The front-end can retrieve the current list of send
11071                        effect chains of an audio output device by sending the
11072                        following command:
11073    </p>
11074    <p>
11075                            </p>
11076    <blockquote class="text">
11077    <p>LIST SEND_EFFECT_CHAINS &lt;audio-device&gt;
11078    </p>
11079    </blockquote><p>
11080                        
11081    </p>
11082    <p>Where &lt;audio-device&gt; should be replaced by the
11083                        numerical ID of the audio output device as given by the
11084                        <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
11085                        or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
11086                        command.
11087    </p>
11088    <p>Possible Answers:
11089    </p>
11090    <p>
11091                            </p>
11092    <blockquote class="text">
11093    <p>The sampler will answer by returning a comma
11094                                separated list with numerical IDs of send effect
11095                                chains of the supplied audio output device.
11096                                
11097    </p>
11098    </blockquote><p>
11099                        
11100    </p>
11101    <p>Examples:
11102    </p>
11103    <p>
11104                            </p>
11105    <blockquote class="text">
11106    <p>C: "LIST SEND_EFFECT_CHAINS 0"
11107    </p>
11108    <p>S: "3,4,7"
11109    </p>
11110    </blockquote><p>
11111                        
11112    </p>
11113    <a name="ADD SEND_EFFECT_CHAIN"></a><br /><hr />
11114    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11115    <a name="rfc.section.6.11.14"></a><h3>6.11.14.&nbsp;
11116    Add send effect chain</h3>
11117    
11118    <p>The front-end can add a send effect chain by sending the
11119                        following command:
11120    </p>
11121    <p>
11122                            </p>
11123    <blockquote class="text">
11124    <p>ADD SEND_EFFECT_CHAIN &lt;audio-device&gt;
11125    </p>
11126    </blockquote><p>
11127                        
11128    </p>
11129    <p>Where &lt;audio-device&gt; should be replaced by the
11130                        numerical ID of the audio output device as given by the
11131                        <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
11132                        or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
11133                        command.
11134    </p>
11135    <p>Possible Answers:
11136    </p>
11137    <p>
11138                            </p>
11139    <blockquote class="text">
11140    <p>"OK[&lt;effect-chain&gt;]" -
11141                                    </p>
11142    <blockquote class="text">
11143    <p>in case the send effect chain was
11144                                        added successfully, where
11145                                        &lt;effect-chain&gt; is the numerical ID
11146                                        of the new send effect chain
11147    </p>
11148    </blockquote>
11149                                
11150    
11151    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
11152                                    </p>
11153    <blockquote class="text">
11154    <p>if the send effect chain could not be added
11155    </p>
11156    </blockquote>
11157                                
11158    
11159    </blockquote><p>
11160                        
11161    </p>
11162    <p>Examples:
11163    </p>
11164    <p>
11165                            </p>
11166    <blockquote class="text">
11167    <p>C: "ADD SEND_EFFECT_CHAIN 0"
11168    </p>
11169    <p>S: "OK[2]"
11170    </p>
11171    </blockquote><p>
11172                        
11173    </p>
11174    <a name="REMOVE SEND_EFFECT_CHAIN"></a><br /><hr />
11175    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11176    <a name="rfc.section.6.11.15"></a><h3>6.11.15.&nbsp;
11177    Remove send effect chain</h3>
11178    
11179    <p>The front-end can remove a send effect chain by sending
11180                        the following command:
11181    </p>
11182    <p>
11183                            </p>
11184    <blockquote class="text">
11185    <p>REMOVE SEND_EFFECT_CHAIN &lt;audio-device&gt; &lt;effect-chain&gt;
11186    </p>
11187    </blockquote><p>
11188                        
11189    </p>
11190    <p>Where &lt;audio-device&gt; should be replaced by the
11191                        numerical ID of the audio output device as given by the
11192                        <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
11193                        or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
11194                        command and &lt;effect-chain&gt; by the numerical ID as
11195                        returned by the
11196                        <a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a>
11197                        or
11198                        <a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a>
11199                        command.
11200    </p>
11201    <p>Possible Answers:
11202    </p>
11203    <p>
11204                            </p>
11205    <blockquote class="text">
11206    <p>"OK" -
11207                                    </p>
11208    <blockquote class="text">
11209    <p>in case the send effect chain was
11210                                        removed successfully
11211    </p>
11212    </blockquote>
11213                                
11214    
11215    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
11216                                    </p>
11217    <blockquote class="text">
11218    <p>if the send effect chain could not be removed
11219    </p>
11220    </blockquote>
11221                                
11222    
11223    </blockquote><p>
11224                        
11225    </p>
11226    <p>Examples:
11227    </p>
11228    <p>
11229                            </p>
11230    <blockquote class="text">
11231    <p>C: "REMOVE SEND_EFFECT_CHAIN 0 2"
11232    </p>
11233    <p>S: "OK"
11234    </p>
11235    </blockquote><p>
11236                        
11237    </p>
11238    <a name="GET SEND_EFFECT_CHAIN INFO"></a><br /><hr />
11239    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11240    <a name="rfc.section.6.11.16"></a><h3>6.11.16.&nbsp;
11241    Retrieving information about a send effect chain</h3>
11242    
11243    <p>The front-end can ask for informations of a send effect
11244                        chain by sending the following command:
11245    </p>
11246    <p>
11247                            </p>
11248    <blockquote class="text">
11249    <p>GET SEND_EFFECT_CHAIN INFO &lt;audio-device&gt; &lt;effect-chain&gt;
11250    </p>
11251    </blockquote><p>
11252                        
11253    </p>
11254    <p>Where &lt;audio-device&gt; should be replaced by the
11255                        numerical ID of the audio output device as given by the
11256                        <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
11257                        or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
11258                        command and &lt;effect-chain&gt; by the numerical ID as
11259                        returned by the
11260                        <a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a>
11261                        or
11262                        <a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a>
11263                        command.
11264    </p>
11265    <p>Possible Answers:
11266    </p>
11267    <p>
11268                            </p>
11269    <blockquote class="text">
11270    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
11271                                Each answer line begins with the information
11272                                category name, followed by a colon and then a space
11273                                character &lt;SP&gt; and finally the info character
11274                                string to that information category.
11275                                At the moment the following categories are defined:
11276    </p>
11277    <p>
11278                                    </p>
11279    <blockquote class="text">
11280    <p>EFFECT_COUNT -
11281                                            </p>
11282    <blockquote class="text">
11283    <p>amount of effects in this send
11284                                                effect chain
11285    </p>
11286    </blockquote>
11287                                        
11288    
11289    <p>EFFECT_SEQUENCE -
11290                                            </p>
11291    <blockquote class="text">
11292    <p>comma separated list of the
11293                                                numerical IDs of the effect
11294                                                instances in this send effect chain,
11295                                                in the order as they are procssed in
11296                                                the effect chain
11297    </p>
11298    </blockquote>
11299                                        
11300    
11301    </blockquote>
11302                                
11303    
11304    </blockquote><p>
11305                        
11306    </p>
11307    <p>The mentioned fields above don't have to be in particular order.
11308    </p>
11309    <p>Example:
11310    </p>
11311    <p>
11312                            </p>
11313    <blockquote class="text">
11314    <p>C: "GET SEND_EFFECT_CHAIN INFO 0 2"
11315    </p>
11316    <p>S: "EFFECT_COUNT: 3"
11317    </p>
11318    <p>&nbsp;&nbsp;&nbsp;"EFFECT_SEQUENCE: 31,4,7"
11319    </p>
11320    <p>&nbsp;&nbsp;&nbsp;"."
11321    </p>
11322    </blockquote><p>
11323                        
11324    </p>
11325    <a name="APPEND SEND_EFFECT_CHAIN EFFECT"></a><br /><hr />
11326    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11327    <a name="rfc.section.6.11.17"></a><h3>6.11.17.&nbsp;
11328    Append effect instance to a send effect chain</h3>
11329    
11330    <p>The front-end can add an unused effect instance to the
11331                        end of a send effect chain by sending the following command:
11332    </p>
11333    <p>
11334                            </p>
11335    <blockquote class="text">
11336    <p>APPEND SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;effect-instance&gt;
11337    </p>
11338    </blockquote><p>
11339                        
11340    </p>
11341    <p>Where &lt;audio-device&gt; should be replaced by the
11342                        numerical ID of the audio output device as given by the
11343                        <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
11344                        or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
11345                        command and &lt;effect-chain&gt; by the numerical ID as
11346                        returned by the
11347                        <a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a>
11348                        or
11349                        <a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a>
11350                        command and &lt;effect-instance&gt; as returned by the
11351                        <a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> or
11352                        <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
11353                        command.
11354    </p>
11355    <p>Only unused effect instances can be added to the effect
11356                        chain. Trying to add an effect instance which is already in
11357                        use somewhere in the audio signal path of the sampler will
11358                        result in an error.
11359    </p>
11360    <p>Possible Answers:
11361    </p>
11362    <p>
11363                            </p>
11364    <blockquote class="text">
11365    <p>"OK" -
11366                                    </p>
11367    <blockquote class="text">
11368    <p>in case the effect instance was
11369                                        added successfully to the chain
11370    </p>
11371    </blockquote>
11372                                
11373    
11374    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
11375                                    </p>
11376    <blockquote class="text">
11377    <p>if the effect instance could not be added
11378    </p>
11379    </blockquote>
11380                                
11381    
11382    </blockquote><p>
11383                        
11384    </p>
11385    <p>Examples:
11386    </p>
11387    <p>
11388                            </p>
11389    <blockquote class="text">
11390    <p>C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38"
11391    </p>
11392    <p>S: "OK"
11393    </p>
11394    </blockquote><p>
11395                        
11396    </p>
11397    <a name="INSERT SEND_EFFECT_CHAIN EFFECT"></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>
11399    <a name="rfc.section.6.11.18"></a><h3>6.11.18.&nbsp;
11400    Insert effect instance to a send effect chain</h3>
11401    
11402    <p>The front-end can add an unused effect instance to a
11403                        certain position of a send effect chain by sending the
11404                        following command:
11405    </p>
11406    <p>
11407                            </p>
11408    <blockquote class="text">
11409    <p>INSERT SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;chain-pos&gt; &lt;effect-instance&gt;
11410    </p>
11411    </blockquote><p>
11412                        
11413    </p>
11414    <p>Where &lt;audio-device&gt; should be replaced by the
11415                        numerical ID of the audio output device as given by the
11416                        <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
11417                        or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
11418                        command, &lt;effect-chain&gt; by the numerical ID as
11419                        returned by the
11420                        <a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a>
11421                        or
11422                        <a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a>
11423                        command, &lt;effect-instance&gt; as returned by the
11424                        <a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> or
11425                        <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
11426                        command and &lt;chain-pos&gt; the exact position of the
11427                        effect chain where the supplied effect shall be inserted
11428                        to.
11429    </p>
11430    <p>Only unused effect instances can be added to the effect
11431                        chain. Trying to add an effect instance which is already in
11432                        use somewhere in the audio signal path of the sampler will
11433                        result in an error.
11434    </p>
11435    <p>Possible Answers:
11436    </p>
11437    <p>
11438                            </p>
11439    <blockquote class="text">
11440    <p>"OK" -
11441                                    </p>
11442    <blockquote class="text">
11443    <p>in case the effect instance was
11444                                        added successfully to the chain
11445    </p>
11446    </blockquote>
11447                                
11448    
11449    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
11450                                    </p>
11451    <blockquote class="text">
11452    <p>if the effect instance could not be added
11453    </p>
11454    </blockquote>
11455                                
11456    
11457    </blockquote><p>
11458                        
11459    </p>
11460    <p>Examples:
11461    </p>
11462    <p>
11463                            </p>
11464    <blockquote class="text">
11465    <p>C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38"
11466    </p>
11467    <p>S: "OK"
11468    </p>
11469    </blockquote><p>
11470                        
11471    </p>
11472    <a name="REMOVE SEND_EFFECT_CHAIN EFFECT"></a><br /><hr />
11473    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11474    <a name="rfc.section.6.11.19"></a><h3>6.11.19.&nbsp;
11475    Remove effect instance from send effect chain</h3>
11476    
11477    <p>The front-end can remove an effect instance from a
11478                        certain position of a send effect chain by sending the
11479                        following command:
11480    </p>
11481    <p>
11482                            </p>
11483    <blockquote class="text">
11484    <p>REMOVE SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;chain-pos&gt;
11485    </p>
11486    </blockquote><p>
11487                        
11488    </p>
11489    <p>Where &lt;audio-device&gt; should be replaced by the
11490                        numerical ID of the audio output device as given by the
11491                        <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
11492                        or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
11493                        command, &lt;effect-chain&gt; by the numerical ID as
11494                        returned by the
11495                        <a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a>
11496                        or
11497                        <a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a>
11498                        command and &lt;chain-pos&gt; the exact position of the
11499                        effect instance to be removed from the effect chain.
11500    </p>
11501    <p>Possible Answers:
11502    </p>
11503    <p>
11504                            </p>
11505    <blockquote class="text">
11506    <p>"OK" -
11507                                    </p>
11508    <blockquote class="text">
11509    <p>in case the effect instance was
11510                                        removed successfully
11511    </p>
11512    </blockquote>
11513                                
11514    
11515    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
11516                                    </p>
11517    <blockquote class="text">
11518    <p>if the effect instance could not be removed
11519    </p>
11520    </blockquote>
11521                                
11522    
11523    </blockquote><p>
11524                        
11525    </p>
11526    <p>Examples:
11527    </p>
11528    <p>
11529                            </p>
11530    <blockquote class="text">
11531    <p>C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4"
11532    </p>
11533    <p>S: "OK"
11534    </p>
11535    </blockquote><p>
11536                        
11537    </p>
11538  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
11539  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11540  <a name="rfc.section.7"></a><h3>7.&nbsp;  <a name="rfc.section.7"></a><h3>7.&nbsp;
# Line 9791  Command Syntax</h3> Line 11654  Command Syntax</h3>
11654                                    
11655  </p>  </p>
11656  <p>/ FORMAT SP format_instruction  <p>/ FORMAT SP format_instruction
11657                                    
11658    </p>
11659    <p>/ SEND SP send_instruction
11660                    
11661    </p>
11662    <p>/ APPEND SP append_instruction
11663                    
11664  </p>  </p>
11665  <p>SEND SP send_instruction  <p>/ INSERT SP insert_instruction
11666                                    
11667  </p>  </p>
11668  <p>/ RESET  <p>/ RESET
# Line 9817  Command Syntax</h3> Line 11686  Command Syntax</h3>
11686  <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
11687                                    
11688  </p>  </p>
11689    <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename
11690                    
11691    </p>
11692  <p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename  <p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
11693                                    
11694  </p>  </p>
11695    <p>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename
11696                    
11697    </p>
11698  <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename  <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
11699                                    
11700  </p>  </p>
# Line 9838  Command Syntax</h3> Line 11713  Command Syntax</h3>
11713  <p>/ MIDI_INSTRUMENT_MAP SP map_name  <p>/ MIDI_INSTRUMENT_MAP SP map_name
11714                                    
11715  </p>  </p>
11716    <p>/ SEND_EFFECT_CHAIN SP device_index
11717                    
11718    </p>
11719  </blockquote><p>  </blockquote><p>
11720    
11721  </p>  </p>
# Line 9922  Command Syntax</h3> Line 11800  Command Syntax</h3>
11800  <p>/ GLOBAL_INFO  <p>/ GLOBAL_INFO
11801                                    
11802  </p>  </p>
11803    <p>/ EFFECT_INSTANCE_COUNT
11804                    
11805    </p>
11806    <p>/ EFFECT_INSTANCE_INFO
11807                    
11808    </p>
11809    <p>/ SEND_EFFECT_CHAIN_COUNT
11810                    
11811    </p>
11812    <p>/ SEND_EFFECT_CHAIN_INFO
11813                    
11814    </p>
11815  </blockquote><p>  </blockquote><p>
11816    
11817  </p>  </p>
# Line 10006  Command Syntax</h3> Line 11896  Command Syntax</h3>
11896  <p>/ GLOBAL_INFO  <p>/ GLOBAL_INFO
11897                                    
11898  </p>  </p>
11899    <p>/ EFFECT_INSTANCE_COUNT
11900                    
11901    </p>
11902    <p>/ EFFECT_INSTANCE_INFO
11903                    
11904    </p>
11905    <p>/ SEND_EFFECT_CHAIN_COUNT
11906                    
11907    </p>
11908    <p>/ SEND_EFFECT_CHAIN_INFO
11909                    
11910    </p>
11911  </blockquote><p>  </blockquote><p>
11912    
11913  </p>  </p>
# Line 10048  Command Syntax</h3> Line 11950  Command Syntax</h3>
11950  <p>/ MIDI_INSTRUMENT_MAP SP ALL  <p>/ MIDI_INSTRUMENT_MAP SP ALL
11951                                    
11952  </p>  </p>
11953    <p>/ SEND_EFFECT_CHAIN SP device_index SP effect_chain
11954                    
11955    </p>
11956    <p>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos
11957                    
11958    </p>
11959    <p>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id
11960                    
11961    </p>
11962  <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path  <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
11963                                    
11964  </p>  </p>
# Line 10066  Command Syntax</h3> Line 11977  Command Syntax</h3>
11977  <p>AVAILABLE_ENGINES  <p>AVAILABLE_ENGINES
11978                                    
11979  </p>  </p>
11980    <p>/ AVAILABLE_EFFECTS
11981                    
11982    </p>
11983    <p>/ EFFECT_INSTANCES
11984                    
11985    </p>
11986    <p>/ EFFECT SP INFO SP effect_index
11987                    
11988    </p>
11989    <p>/ EFFECT_INSTANCE SP INFO SP effect_instance
11990                    
11991    </p>
11992    <p>/ EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP input_control
11993                    
11994    </p>
11995    <p>/ SEND_EFFECT_CHAINS SP device_index
11996                    
11997    </p>
11998    <p>/ SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain
11999                    
12000    </p>
12001  <p>/ AVAILABLE_MIDI_INPUT_DRIVERS  <p>/ AVAILABLE_MIDI_INPUT_DRIVERS
12002                                    
12003  </p>  </p>
# Line 10189  Command Syntax</h3> Line 12121  Command Syntax</h3>
12121  <p>/ VOLUME  <p>/ VOLUME
12122                                    
12123  </p>  </p>
12124    <p>/ VOICES
12125                    
12126    </p>
12127    <p>/ STREAMS
12128                    
12129    </p>
12130  <p>/ FILE SP INSTRUMENTS SP filename  <p>/ FILE SP INSTRUMENTS SP filename
12131                                    
12132  </p>  </p>
# Line 10216  Command Syntax</h3> Line 12154  Command Syntax</h3>
12154  <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list  <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
12155                                    
12156  </p>  </p>
12157    <p>/ EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP input_control SP control_value
12158                    
12159    </p>
12160  <p>/ CHANNEL SP set_chan_instruction  <p>/ CHANNEL SP set_chan_instruction
12161                                    
12162  </p>  </p>
# Line 10234  Command Syntax</h3> Line 12175  Command Syntax</h3>
12175  <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value  <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
12176                                    
12177  </p>  </p>
12178    <p>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos
12179                    
12180    </p>
12181  <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped  <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
12182                                    
12183  </p>  </p>
# Line 10255  Command Syntax</h3> Line 12199  Command Syntax</h3>
12199  <p>/ VOLUME SP volume_value  <p>/ VOLUME SP volume_value
12200                                    
12201  </p>  </p>
12202    <p>/ VOICES SP number
12203                    
12204    </p>
12205    <p>/ STREAMS SP number
12206                    
12207    </p>
12208  </blockquote><p>  </blockquote><p>
12209    
12210  </p>  </p>
# Line 10279  Command Syntax</h3> Line 12229  Command Syntax</h3>
12229  <p>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name  <p>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
12230                                    
12231  </p>  </p>
12232    <p>/ EFFECT_INSTANCE SP effect_index
12233                    
12234    </p>
12235    <p>/ EFFECT_INSTANCE SP effect_system SP module SP effect_name
12236                    
12237    </p>
12238  </blockquote><p>  </blockquote><p>
12239    
12240  </p>  </p>
# Line 10360  Command Syntax</h3> Line 12316  Command Syntax</h3>
12316  <p>/ FX_SEND SP sampler_channel SP fx_send_id  <p>/ FX_SEND SP sampler_channel SP fx_send_id
12317                                    
12318  </p>  </p>
12319    <p>/ EFFECT_INSTANCE SP number
12320                    
12321    </p>
12322  </blockquote><p>  </blockquote><p>
12323    
12324  </p>  </p>
# Line 10375  Command Syntax</h3> Line 12334  Command Syntax</h3>
12334  </blockquote><p>  </blockquote><p>
12335    
12336  </p>  </p>
12337    <p>append_instruction =
12338            </p>
12339    <blockquote class="text">
12340    <p>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP effect_instance
12341                    
12342    </p>
12343    </blockquote><p>
12344    
12345    </p>
12346    <p>insert_instruction =
12347            </p>
12348    <blockquote class="text">
12349    <p>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos SP effect_instance
12350                    
12351    </p>
12352    </blockquote><p>
12353    
12354    </p>
12355  <p>set_chan_instruction =  <p>set_chan_instruction =
12356          </p>          </p>
12357  <blockquote class="text">  <blockquote class="text">
# Line 10492  Command Syntax</h3> Line 12469  Command Syntax</h3>
12469  <p>/ AVAILABLE_ENGINES  <p>/ AVAILABLE_ENGINES
12470                                    
12471  </p>  </p>
12472    <p>/ AVAILABLE_EFFECTS
12473                    
12474    </p>
12475    <p>/ EFFECT_INSTANCES
12476                    
12477    </p>
12478    <p>/ SEND_EFFECT_CHAINS SP number
12479                    
12480    </p>
12481  <p>/ AVAILABLE_MIDI_INPUT_DRIVERS  <p>/ AVAILABLE_MIDI_INPUT_DRIVERS
12482                                    
12483  </p>  </p>
# Line 10573  Command Syntax</h3> Line 12559  Command Syntax</h3>
12559  </blockquote><p>  </blockquote><p>
12560    
12561  </p>  </p>
12562    <p>effect_instance =
12563            </p>
12564    <blockquote class="text">
12565    <p>number
12566                    
12567    </p>
12568    </blockquote><p>
12569    
12570    </p>
12571  <p>device_index =  <p>device_index =
12572          </p>          </p>
12573  <blockquote class="text">  <blockquote class="text">
# Line 10678  Command Syntax</h3> Line 12673  Command Syntax</h3>
12673  </blockquote><p>  </blockquote><p>
12674    
12675  </p>  </p>
12676    <p>control_value =
12677            </p>
12678    <blockquote class="text">
12679    <p>real
12680                    
12681    </p>
12682    </blockquote><p>
12683    
12684    </p>
12685  <p>sampler_channel =  <p>sampler_channel =
12686          </p>          </p>
12687  <blockquote class="text">  <blockquote class="text">
# Line 10759  Command Syntax</h3> Line 12763  Command Syntax</h3>
12763  </blockquote><p>  </blockquote><p>
12764    
12765  </p>  </p>
12766    <p>effect_name =
12767            </p>
12768    <blockquote class="text">
12769    <p>stringval_escaped
12770                    
12771    </p>
12772    </blockquote><p>
12773    
12774    </p>
12775    <p>effect_index =
12776            </p>
12777    <blockquote class="text">
12778    <p>number
12779                    
12780    </p>
12781    </blockquote><p>
12782    
12783    </p>
12784    <p>effect_chain =
12785            </p>
12786    <blockquote class="text">
12787    <p>number
12788                    
12789    </p>
12790    </blockquote><p>
12791    
12792    </p>
12793    <p>chain_pos =
12794            </p>
12795    <blockquote class="text">
12796    <p>number
12797                    
12798    </p>
12799    </blockquote><p>
12800    
12801    </p>
12802    <p>input_control =
12803            </p>
12804    <blockquote class="text">
12805    <p>number
12806                    
12807    </p>
12808    </blockquote><p>
12809    
12810    </p>
12811  <p>param_val_list =  <p>param_val_list =
12812          </p>          </p>
12813  <blockquote class="text">  <blockquote class="text">
# Line 10828  Command Syntax</h3> Line 12877  Command Syntax</h3>
12877  </blockquote><p>  </blockquote><p>
12878    
12879  </p>  </p>
12880    <p>effect_system =
12881            </p>
12882    <blockquote class="text">
12883    <p>string
12884                    
12885    </p>
12886    </blockquote><p>
12887    
12888    </p>
12889    <p>module =
12890            </p>
12891    <blockquote class="text">
12892    <p>filename
12893                    
12894    </p>
12895    </blockquote><p>
12896    
12897    </p>
12898  <a name="character_set"></a><br /><hr />  <a name="character_set"></a><br /><hr />
12899  <table 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>
12900  <a name="rfc.section.7.1"></a><h3>7.1.&nbsp;  <a name="rfc.section.7.1"></a><h3>7.1.&nbsp;
# Line 10885  Character Set and Escape Sequences</h3> Line 12952  Character Set and Escape Sequences</h3>
12952  <td align="left">two digit hex ASCII code of the character</td>  <td align="left">two digit hex ASCII code of the character</td>
12953  </tr>  </tr>
12954  </table>  </table>
12955    <br clear="all" />
12956    
12957  <p>Notice: due to the transition of certain parts of the  <p>Notice: due to the transition of certain parts of the
12958                  protocol which now support escape sequences, a slight backward                  protocol which now support escape sequences, a slight backward
# Line 10957  Character Set and Escape Sequences</h3> Line 13025  Character Set and Escape Sequences</h3>
13025  </p>  </p>
13026  <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>  <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>
13027  </p>  </p>
13028    <p><a class='info' href='#GET EFFECT INFO'>"GET EFFECT INFO"<span> (</span><span class='info'>Retrieving general information about an effect</span><span>)</span></a>
13029    </p>
13030    <p><a class='info' href='#GET EFFECT_INSTANCE INFO'>"GET EFFECT_INSTANCE INFO"<span> (</span><span class='info'>Retrieving current information about an effect instance</span><span>)</span></a>
13031    </p>
13032    <p><a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a>
13033    </p>
13034  </blockquote><p>  </blockquote><p>
13035                  Note that the forward slash character ('/') has a special meaning in                  Note that the forward slash character ('/') has a special meaning in
13036                  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 11021  Character Set and Escape Sequences</h3> Line 13095  Character Set and Escape Sequences</h3>
13095  </p>  </p>
13096  <p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</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>
13097  </p>  </p>
13098    <p><a class='info' href='#GET EFFECT INFO'>"GET EFFECT INFO"<span> (</span><span class='info'>Retrieving general information about an effect</span><span>)</span></a>
13099    </p>
13100    <p><a class='info' href='#GET EFFECT_INSTANCE INFO'>"GET EFFECT_INSTANCE INFO"<span> (</span><span class='info'>Retrieving current information about an effect instance</span><span>)</span></a>
13101    </p>
13102    <p><a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a>
13103    </p>
13104  </blockquote><p>  </blockquote><p>
13105                  Please note that these lists are manually maintained. If you                  Please note that these lists are manually maintained. If you
13106                  find a command that also supports escape sequences we forgot to                  find a command that also supports escape sequences we forgot to
# Line 11658  Global settings changed</h3> Line 13738  Global settings changed</h3>
13738                          new global volume parameter.                          new global volume parameter.
13739  </p>  </p>
13740  </blockquote><p>  </blockquote><p>
13741                        </p>
13742    <blockquote class="text">
13743    <p>"NOTIFY:GLOBAL_INFO:VOICES &lt;max-voices&gt;" - Notifies that the
13744                            golbal limit of the sampler for maximum voices is changed, where
13745                            &lt;max-voices&gt; will be an integer value, reflecting the
13746                            new global voice limit parameter.
13747    </p>
13748    </blockquote><p>
13749                        </p>
13750    <blockquote class="text">
13751    <p>"NOTIFY:GLOBAL_INFO:STREAMS &lt;max-streams&gt;" - Notifies that the
13752                            golbal limit of the sampler for maximum disk streams is changed, where
13753                            &lt;max-streams&gt; will be an integer value, reflecting the
13754                            new global disk streams limit parameter.
13755    </p>
13756    </blockquote><p>
13757                                    
13758  </p>  </p>
13759  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />
# Line 11851  Database job status information changed< Line 13947  Database job status information changed<
13947                  time events happening on the server, it is believed that an empty notification                  time events happening on the server, it is believed that an empty notification
13948                  message is sufficient here.                  message is sufficient here.
13949  </p>  </p>
13950  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />  <a name="SUBSCRIBE EFFECT_INSTANCE_COUNT"></a><br /><hr />
13951  <table 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>
13952  <a name="rfc.section.8.26"></a><h3>8.26.&nbsp;  <a name="rfc.section.8.26"></a><h3>8.26.&nbsp;
13953    Number of effect instances changed</h3>
13954    
13955    <p>Client may want to be notified when the number of effect instances
13956                    is changed by issuing the following command:
13957    </p>
13958    <p>
13959                        </p>
13960    <blockquote class="text">
13961    <p>SUBSCRIBE EFFECT_INSTANCE_COUNT
13962    </p>
13963    </blockquote><p>
13964                    
13965    </p>
13966    <p>Server will start sending the following notification messages:
13967    </p>
13968    <p>
13969                        </p>
13970    <blockquote class="text">
13971    <p>"EFFECT_INSTANCE_COUNT:&lt;instances&gt;"
13972    </p>
13973    </blockquote><p>
13974                    
13975    </p>
13976    <p>where &lt;instances&gt; will be replaced by the new number
13977                    of effect instances.
13978    </p>
13979    <a name="SUBSCRIBE EFFECT_INSTANCE_INFO"></a><br /><hr />
13980    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
13981    <a name="rfc.section.8.27"></a><h3>8.27.&nbsp;
13982    Effect instance information changed</h3>
13983    
13984    <p>Client may want to be notified when changes were made to effect instances
13985                    on the back-end by issuing the following command:
13986    </p>
13987    <p>
13988                        </p>
13989    <blockquote class="text">
13990    <p>SUBSCRIBE EFFECT_INSTANCE_INFO
13991    </p>
13992    </blockquote><p>
13993                    
13994    </p>
13995    <p>Server will start sending the following notification messages:
13996    </p>
13997    <p>
13998                       </p>
13999    <blockquote class="text">
14000    <p>"EFFECT_INSTANCE_INFO:&lt;instance-id&gt;"
14001    </p>
14002    </blockquote><p>
14003                    
14004    </p>
14005    <p>where &lt;instance-id&gt; will be replaced by the numerical ID
14006                    of the effect instance.
14007    </p>
14008    <a name="SUBSCRIBE SEND_EFFECT_CHAIN_COUNT"></a><br /><hr />
14009    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
14010    <a name="rfc.section.8.28"></a><h3>8.28.&nbsp;
14011    Number of send effect chains changed</h3>
14012    
14013    <p>Client may want to be notified when the number of send effect chains
14014                    is changed by issuing the following command:
14015    </p>
14016    <p>
14017                        </p>
14018    <blockquote class="text">
14019    <p>SUBSCRIBE SEND_EFFECT_CHAIN_COUNT
14020    </p>
14021    </blockquote><p>
14022                    
14023    </p>
14024    <p>Server will start sending the following notification messages:
14025    </p>
14026    <p>
14027                        </p>
14028    <blockquote class="text">
14029    <p>"NOTIFY:SEND_EFFECT_CHAIN_COUNT:&lt;device-id&gt; &lt;chains&gt;"
14030    </p>
14031    </blockquote><p>
14032                    
14033    </p>
14034    <p>where &lt;device-id&gt; will be replaced by the numerical ID of the audio
14035                    output device, in which the number of send effect chains is changed and
14036                    &lt;chains&gt; will be replaced by the new number of send effect chains.
14037    </p>
14038    <a name="SUBSCRIBE SEND_EFFECT_CHAIN_INFO"></a><br /><hr />
14039    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
14040    <a name="rfc.section.8.29"></a><h3>8.29.&nbsp;
14041    Send effect chain information changed</h3>
14042    
14043    <p>Client may want to be notified when changes were made to send effect chains
14044                    on the back-end by issuing the following command:
14045    </p>
14046    <p>
14047                        </p>
14048    <blockquote class="text">
14049    <p>SUBSCRIBE SEND_EFFECT_CHAIN_INFO
14050    </p>
14051    </blockquote><p>
14052                    
14053    </p>
14054    <p>Server will start sending the following notification messages:
14055    </p>
14056    <p>
14057                       </p>
14058    <blockquote class="text">
14059    <p>"SEND_EFFECT_CHAIN_INFO:&lt;device-id&gt; &lt;chain-id&gt; &lt;instances&gt;" -
14060                            Notifies that the number of effect instances in a particular send effect chain
14061                            is changed, where &lt;device-id&gt; will be replaced by the numerical ID of the audio
14062                            output device the send effect chain belongs to, &lt;chain-id&gt; will be replaced
14063                            by the numerical ID of the send effect chain in which the number of effect instances
14064                            has changed and &lt;instances&gt; will be replaced by the new number
14065                            of effect instances in the specified send effect chain.
14066    </p>
14067    </blockquote><p>
14068                    
14069    </p>
14070    <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
14071    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
14072    <a name="rfc.section.8.30"></a><h3>8.30.&nbsp;
14073  Miscellaneous and debugging events</h3>  Miscellaneous and debugging events</h3>
14074    
14075  <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 11919  Acknowledgments</h3> Line 14135  Acknowledgments</h3>
14135  <h3>11.&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
14136  <table width="99%" border="0">  <table width="99%" border="0">
14137  <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>
14138  <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>
14139  <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>
14140  <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>
14141  <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>
14142  <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>
14143  <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>
14144  <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>
14145  </table>  </table>
14146    
14147  <a name="rfc.authors"></a><br /><hr />  <a name="rfc.authors"></a><br /><hr />
# Line 11950  Schoenebeck</td></tr> Line 14166  Schoenebeck</td></tr>
14166  <table 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>
14167  <h3>Full Copyright Statement</h3>  <h3>Full Copyright Statement</h3>
14168  <p class='copyright'>  <p class='copyright'>
14169  Copyright &copy; The IETF Trust (2008).</p>  Copyright &copy; The IETF Trust (2011).</p>
14170  <p class='copyright'>  <p class='copyright'>
14171  This document is subject to the rights,  This document is subject to the rights,
14172  licenses and restrictions contained in BCP&nbsp;78,  licenses and restrictions contained in BCP&nbsp;78,
# Line 11992  or other Line 14208  or other
14208  proprietary rights that may cover technology that may be required  proprietary rights that may cover technology that may be required
14209  to implement this standard.  to implement this standard.
14210  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>  
14211  </body></html>  </body></html>
Legend:
Removed from v.1773  
changed lines
  Added in v.2189
  ViewVC Help
Powered by ViewVC