/[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 2498 by schoenebeck, Thu Jan 9 22:05:21 2014 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.35 (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 143  Line 143 
143  <table 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>
144  <table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1">  <table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1">
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">LinuxSampler.org</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">January 9, 2014</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: July 13, 2014</td><td class="header">&nbsp;</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.6</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 158  and any of which he or she becomes aware Line 167  and any of which he or she becomes aware
167  in accordance with Section&nbsp;6 of BCP&nbsp;79.</p>  in accordance with Section&nbsp;6 of BCP&nbsp;79.</p>
168  <p>  <p>
169  Internet-Drafts are working documents of the Internet Engineering  Internet-Drafts are working documents of the Internet Engineering
170  Task Force (IETF), its areas, and its working groups.  Task Force (IETF).  Note that other groups may also distribute
171  Note that other groups may also distribute working documents as  working documents as Internet-Drafts.  The list of current
172  Internet-Drafts.</p>  Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.</p>
173  <p>  <p>
174  Internet-Drafts are draft documents valid for a maximum of six months  Internet-Drafts are draft documents valid for a maximum of six months
175  and may be updated, replaced, or obsoleted by other documents at any time.  and may be updated, replaced, or obsoleted by other documents at any time.
176  It is inappropriate to use Internet-Drafts as reference material or to cite  It is inappropriate to use Internet-Drafts as reference material or to cite
177  them other than as &ldquo;work in progress.&rdquo;</p>  them other than as &ldquo;work in progress.&rdquo;</p>
178  <p>  <p>
179  The list of current Internet-Drafts can be accessed at  This Internet-Draft will expire on July 13, 2014.</p>
180  <a href='http://www.ietf.org/ietf/1id-abstracts.txt'>http://www.ietf.org/ietf/1id-abstracts.txt</a>.</p>  <a name="toc"></a><br /><hr />
 <p>  
 The list of Internet-Draft Shadow Directories can be accessed at  
 <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>  
 <p>  
 This Internet-Draft will expire on March 14, 2009.</p>  
   
 <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 />  
181  <h3>Table of Contents</h3>  <h3>Table of Contents</h3>
182  <p class="toc">  <p class="toc">
183  <a href="#anchor1">1.</a>&nbsp;  <a href="#anchor1">1.</a>&nbsp;
# Line 302  Setting audio output device<br /> Line 292  Setting audio output device<br />
292  Setting audio output type<br />  Setting audio output type<br />
293  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_CHANNEL">6.4.16.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_CHANNEL">6.4.16.</a>&nbsp;
294  Setting audio output channel<br />  Setting audio output channel<br />
295  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_DEVICE">6.4.17.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD CHANNEL MIDI_INPUT">6.4.17.</a>&nbsp;
296    Add MIDI input to sampler channel<br />
297    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE CHANNEL MIDI_INPUT">6.4.18.</a>&nbsp;
298    Remove MIDI input(s) from sampler channel<br />
299    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST CHANNEL MIDI_INPUTS">6.4.19.</a>&nbsp;
300    Getting all MIDI inputs of a sampler channel<br />
301    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_DEVICE">6.4.20.</a>&nbsp;
302  Setting MIDI input device<br />  Setting MIDI input device<br />
303  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_TYPE">6.4.18.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_TYPE">6.4.21.</a>&nbsp;
304  Setting MIDI input type<br />  Setting MIDI input type<br />
305  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_PORT">6.4.19.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_PORT">6.4.22.</a>&nbsp;
306  Setting MIDI input port<br />  Setting MIDI input port<br />
307  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_CHANNEL">6.4.20.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_CHANNEL">6.4.23.</a>&nbsp;
308  Setting MIDI input channel<br />  Setting MIDI input channel<br />
309  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL VOLUME">6.4.21.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL VOLUME">6.4.24.</a>&nbsp;
310  Setting channel volume<br />  Setting channel volume<br />
311  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MUTE">6.4.22.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MUTE">6.4.25.</a>&nbsp;
312  Muting a sampler channel<br />  Muting a sampler channel<br />
313  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL SOLO">6.4.23.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL SOLO">6.4.26.</a>&nbsp;
314  Soloing a sampler channel<br />  Soloing a sampler channel<br />
315  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INSTRUMENT_MAP">6.4.24.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INSTRUMENT_MAP">6.4.27.</a>&nbsp;
316  Assigning a MIDI instrument map to a sampler channel<br />  Assigning a MIDI instrument map to a sampler channel<br />
317  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE FX_SEND">6.4.25.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE FX_SEND">6.4.28.</a>&nbsp;
318  Adding an effect send to a sampler channel<br />  Adding an effect send to a sampler channel<br />
319  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY FX_SEND">6.4.26.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY FX_SEND">6.4.29.</a>&nbsp;
320  Removing an effect send from a sampler channel<br />  Removing an effect send from a sampler channel<br />
321  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SENDS">6.4.27.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SENDS">6.4.30.</a>&nbsp;
322  Getting amount of effect sends on a sampler channel<br />  Getting amount of effect sends on a sampler channel<br />
323  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST FX_SENDS">6.4.28.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST FX_SENDS">6.4.31.</a>&nbsp;
324  Listing all effect sends on a sampler channel<br />  Listing all effect sends on a sampler channel<br />
325  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SEND INFO">6.4.29.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SEND INFO">6.4.32.</a>&nbsp;
326  Getting effect send information<br />  Getting effect send information<br />
327  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND NAME">6.4.30.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND NAME">6.4.33.</a>&nbsp;
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.34.</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.35.</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.36.</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.37.</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.38.</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.39.</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.40.</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 383  Renaming a MIDI instrument map<br /> Line 391  Renaming a MIDI instrument map<br />
391  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MAP MIDI_INSTRUMENT">6.7.7.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MAP MIDI_INSTRUMENT">6.7.7.</a>&nbsp;
392  Create or replace a MIDI instrument map entry<br />  Create or replace a MIDI instrument map entry<br />
393  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENTS">6.7.8.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENTS">6.7.8.</a>&nbsp;
394  Getting ammount of MIDI instrument map entries<br />  Getting amount of MIDI instrument map entries<br />
395  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INSTRUMENTS">6.7.9.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INSTRUMENTS">6.7.9.</a>&nbsp;
396  Getting indeces of all entries of a MIDI instrument map<br />  Getting indeces of all entries of a MIDI instrument map<br />
397  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#UNMAP MIDI_INSTRUMENT">6.7.10.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#UNMAP MIDI_INSTRUMENT">6.7.10.</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 3863  Getting all available engines</h3> Line 3919  Getting all available engines</h3>
3919  <blockquote class="text">  <blockquote class="text">
3920  <p>C: "LIST AVAILABLE_ENGINES"  <p>C: "LIST AVAILABLE_ENGINES"
3921  </p>  </p>
3922  <p>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"  <p>S: "'gig','sfz','sf2'"
3923  </p>  </p>
3924  </blockquote><p>  </blockquote><p>
3925                                            
# Line 3927  Getting information about an engine</h3> Line 3983  Getting information about an engine</h3>
3983  </p>  </p>
3984  <p>The mentioned fields above don't have to be in particular order.  <p>The mentioned fields above don't have to be in particular order.
3985  </p>  </p>
3986  <p>Example:  <p>Examples:
3987  </p>  </p>
3988  <p>  <p>
3989                          </p>                          </p>
3990  <blockquote class="text">  <blockquote class="text">
3991  <p>C: "GET ENGINE INFO JoesCustomEngine"  <p>C: "GET ENGINE INFO gig"
3992    </p>
3993    <p>S: "DESCRIPTION: GigaSampler Format Engine"
3994    </p>
3995    <p>&nbsp;&nbsp;&nbsp;"VERSION: 1.110"
3996    </p>
3997    <p>&nbsp;&nbsp;&nbsp;"."
3998    </p>
3999    <p>C: "GET ENGINE INFO sf2"
4000  </p>  </p>
4001  <p>S: "DESCRIPTION: this is Joe's custom sampler engine"  <p>S: "DESCRIPTION: SoundFont Format Engine"
4002  </p>  </p>
4003  <p>&nbsp;&nbsp;&nbsp;"VERSION: testing-1.0"  <p>&nbsp;&nbsp;&nbsp;"VERSION: 1.4"
4004    </p>
4005    <p>&nbsp;&nbsp;&nbsp;"."
4006    </p>
4007    <p>C: "GET ENGINE INFO sfz"
4008    </p>
4009    <p>S: "DESCRIPTION: SFZ Format Engine"
4010    </p>
4011    <p>&nbsp;&nbsp;&nbsp;"VERSION: 1.11"
4012  </p>  </p>
4013  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
4014  </p>  </p>
# Line 3992  Getting sampler channel information</h3> Line 4064  Getting sampler channel information</h3>
4064  <blockquote class="text">  <blockquote class="text">
4065  <p>numerical ID of the audio output device which is  <p>numerical ID of the audio output device which is
4066                                              currently connected to this sampler channel to output                                              currently connected to this sampler channel to output
4067                                              the audio signal, "NONE" if there's no device                                              the audio signal, "-1" if there's no device
4068                                              connected to this sampler channel                                              connected to this sampler channel
4069  </p>  </p>
4070  </blockquote>  </blockquote>
# Line 4035  Getting sampler channel information</h3> Line 4107  Getting sampler channel information</h3>
4107  <p>INSTRUMENT_NR -  <p>INSTRUMENT_NR -
4108                                          </p>                                          </p>
4109  <blockquote class="text">  <blockquote class="text">
4110  <p>the instrument index number of the loaded instrument  <p>the instrument index number of the loaded instrument,
4111                                                "-1" if there's no instrument loaded for this sampler
4112                                                channel
4113  </p>  </p>
4114  </blockquote>  </blockquote>
4115                                                                            
# Line 4053  Getting sampler channel information</h3> Line 4127  Getting sampler channel information</h3>
4127  <p>INSTRUMENT_STATUS -  <p>INSTRUMENT_STATUS -
4128                                          </p>                                          </p>
4129  <blockquote class="text">  <blockquote class="text">
4130  <p>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative  <p>Integer values 0 to 100 indicating loading progress
4131                                              value indicates a loading exception. Value of 100 indicates that the instrument is fully                                              percentage for the instrument. Negative
4132                                                value indicates a loading exception (also returns "-1" in case no
4133                                                instrument was yet to be loaded on the sampler channel).
4134                                                Value of 100 indicates that the instrument is fully
4135                                              loaded.                                              loaded.
4136  </p>  </p>
4137  </blockquote>  </blockquote>
# Line 4065  Getting sampler channel information</h3> Line 4142  Getting sampler channel information</h3>
4142  <blockquote class="text">  <blockquote class="text">
4143  <p>numerical ID of the MIDI input device which is  <p>numerical ID of the MIDI input device which is
4144                                              currently connected to this sampler channel to deliver                                              currently connected to this sampler channel to deliver
4145                                              MIDI input commands, "NONE" if there's no device                                              MIDI input commands, "-1" if there's no device
4146                                              connected to this sampler channel                                              connected to this sampler channel
4147  </p>  </p>
4148  </blockquote>  </blockquote>
# Line 4074  Getting sampler channel information</h3> Line 4151  Getting sampler channel information</h3>
4151  <p>MIDI_INPUT_PORT -  <p>MIDI_INPUT_PORT -
4152                                          </p>                                          </p>
4153  <blockquote class="text">  <blockquote class="text">
4154  <p>port number of the MIDI input device  <p>port number of the MIDI input device (in case a
4155                                                MIDI device was already assigned to the sampler
4156                                                channel)
4157  </p>  </p>
4158  </blockquote>  </blockquote>
4159                                                                            
# Line 4145  Getting sampler channel information</h3> Line 4224  Getting sampler channel information</h3>
4224  <blockquote class="text">  <blockquote class="text">
4225  <p>C: "GET CHANNEL INFO 34"  <p>C: "GET CHANNEL INFO 34"
4226  </p>  </p>
4227  <p>S: "ENGINE_NAME: GigEngine"  <p>S: "ENGINE_NAME: gig"
4228  </p>  </p>
4229  <p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"  <p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
4230  </p>  </p>
# Line 4417  Setting audio output device</h3> Line 4496  Setting audio output device</h3>
4496  <a name="rfc.section.6.4.15"></a><h3>6.4.15.&nbsp;  <a name="rfc.section.6.4.15"></a><h3>6.4.15.&nbsp;
4497  Setting audio output type</h3>  Setting audio output type</h3>
4498    
4499  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR!
4500  </p>  </p>
4501  <p>The front-end can alter the audio output type on a specific sampler  <p>The front-end can alter the audio output type on a specific sampler
4502                      channel by sending the following command:                      channel by sending the following command:
# Line 4477  Setting audio output type</h3> Line 4556  Setting audio output type</h3>
4556  </blockquote><p>  </blockquote><p>
4557                                            
4558  </p>  </p>
4559    <p>Deprecated:
4560    </p>
4561    <p>
4562                            </p>
4563    <blockquote class="text">
4564    <p>Should not be used anymore. This command is currently only preserved for backward compatibility.
4565    </p>
4566    <p>This command is a relict from times where there was no sophisticated driver management yet. Use <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> and <a class='info' href='#SET CHANNEL AUDIO_OUTPUT_DEVICE'>"SET CHANNEL AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Setting audio output device</span><span>)</span></a> instead.
4567    </p>
4568    </blockquote><p>
4569                        
4570    </p>
4571  <a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr />  <a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
4572  <table 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>
4573  <a name="rfc.section.6.4.16"></a><h3>6.4.16.&nbsp;  <a name="rfc.section.6.4.16"></a><h3>6.4.16.&nbsp;
# Line 4544  Setting audio output channel</h3> Line 4635  Setting audio output channel</h3>
4635  </blockquote><p>  </blockquote><p>
4636                                            
4637  </p>  </p>
4638  <a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr />  <a name="ADD CHANNEL MIDI_INPUT"></a><br /><hr />
4639  <table 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>
4640  <a name="rfc.section.6.4.17"></a><h3>6.4.17.&nbsp;  <a name="rfc.section.6.4.17"></a><h3>6.4.17.&nbsp;
4641    Add MIDI input to sampler channel</h3>
4642    
4643    <p>The front-end can add a MIDI input on a specific sampler
4644                        channel by sending the following command:
4645    </p>
4646    <p>
4647                            </p>
4648    <blockquote class="text">
4649    <p>ADD CHANNEL MIDI_INPUT &lt;sampler-channel&gt; &lt;midi-device-id&gt; [&lt;midi-input-port&gt;]
4650    </p>
4651    </blockquote><p>
4652                        
4653    </p>
4654    <p>Where &lt;sampler-channel&gt; is the sampler channel number
4655                        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>
4656                        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
4657                        and &lt;midi-device-id&gt; is the numerical ID of the MIDI input
4658                        device as returned by the
4659                        <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
4660                        or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a> command,
4661                        and &lt;midi-input-port&gt; is an optional MIDI input port number of that
4662                        MIDI input device. If &lt;midi-input-port&gt; is omitted,
4663                        then the MIDI input device's first port (port number 0) is
4664                        used.
4665                        
4666    </p>
4667    <p>Possible Answers:
4668    </p>
4669    <p>
4670                            </p>
4671    <blockquote class="text">
4672    <p>"OK" -
4673                                    </p>
4674    <blockquote class="text">
4675    <p>on success
4676    </p>
4677    </blockquote>
4678                                
4679    
4680    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4681                                    </p>
4682    <blockquote class="text">
4683    <p>if MIDI input port was connected, but there are noteworthy
4684                                        issue(s) related, providing an appropriate warning code and
4685                                        warning message
4686    </p>
4687    </blockquote>
4688                                
4689    
4690    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4691                                    </p>
4692    <blockquote class="text">
4693    <p>in case it failed, providing an appropriate error code and error message
4694    </p>
4695    </blockquote>
4696                                
4697    
4698    </blockquote><p>
4699                        
4700    </p>
4701    <p>Examples:
4702    </p>
4703    <p>
4704                            </p>
4705    <blockquote class="text">
4706    <p>C: "ADD CHANNEL MIDI_INPUT 0 0"
4707    </p>
4708    <p>S: "OK"
4709    </p>
4710    <p>C: "ADD CHANNEL MIDI_INPUT 1 0"
4711    </p>
4712    <p>S: "OK"
4713    </p>
4714    <p>C: "ADD CHANNEL MIDI_INPUT 1 1 1"
4715    </p>
4716    <p>S: "OK"
4717    </p>
4718    <p>C: "ADD CHANNEL MIDI_INPUT 1 2 0"
4719    </p>
4720    <p>S: "OK"
4721    </p>
4722    </blockquote><p>
4723                        
4724    </p>
4725    <p>Since:
4726    </p>
4727    <p>
4728                            </p>
4729    <blockquote class="text">
4730    <p>Introduced with LSCP v1.6
4731    </p>
4732    </blockquote><p>
4733                        
4734    </p>
4735    <a name="REMOVE CHANNEL MIDI_INPUT"></a><br /><hr />
4736    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4737    <a name="rfc.section.6.4.18"></a><h3>6.4.18.&nbsp;
4738    Remove MIDI input(s) from sampler channel</h3>
4739    
4740    <p>The front-end can remove one ore more MIDI input(s) on a
4741                        specific sampler channel by sending the following command:
4742    </p>
4743    <p>
4744                            </p>
4745    <blockquote class="text">
4746    <p>REMOVE CHANNEL MIDI_INPUT &lt;sampler-channel&gt; [&lt;midi-device-id&gt; [&lt;midi-input-port&gt;]]
4747    </p>
4748    </blockquote><p>
4749                        
4750    </p>
4751    <p>Where &lt;sampler-channel&gt; is the sampler channel number
4752                        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>
4753                        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
4754                        and &lt;midi-device-id&gt; and &lt;midi-input-port&gt; are
4755                        optional numerical IDs defining the MIDI input device and
4756                        one of its MIDI ports as returned by the
4757                        <a class='info' href='#LIST CHANNEL MIDI_INPUTS'>"LIST CHANNEL MIDI_INPUTS"<span> (</span><span class='info'>Getting all MIDI inputs of a sampler channel</span><span>)</span></a> command.
4758                        
4759    </p>
4760    <p>
4761                        If &lt;midi-input-port&gt; is omitted, then all MIDI input
4762                        ports of &lt;midi-device-id&gt; are disconnected from this
4763                        sampler channel.
4764                        
4765    </p>
4766    <p>
4767                        If both, &lt;midi-device-id&gt; and &lt;midi-input-port&gt;
4768                        are omitted, then all MIDI input ports currently connected
4769                        to this sampler channel are disconnected from this sampler
4770                        channel.
4771                        
4772    </p>
4773    <p>Possible Answers:
4774    </p>
4775    <p>
4776                            </p>
4777    <blockquote class="text">
4778    <p>"OK" -
4779                                    </p>
4780    <blockquote class="text">
4781    <p>on success
4782    </p>
4783    </blockquote>
4784                                
4785    
4786    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4787                                    </p>
4788    <blockquote class="text">
4789    <p>if MIDI input porst were disconnected, but there are noteworthy
4790                                        issue(s) related, providing an appropriate warning code and
4791                                        warning message
4792    </p>
4793    </blockquote>
4794                                
4795    
4796    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4797                                    </p>
4798    <blockquote class="text">
4799    <p>in case it failed, providing an appropriate error code and error message
4800    </p>
4801    </blockquote>
4802                                
4803    
4804    </blockquote><p>
4805                        
4806    </p>
4807    <p>Examples:
4808    </p>
4809    <p>
4810                            </p>
4811    <blockquote class="text">
4812    <p>C: "REMOVE CHANNEL MIDI_INPUT 0"
4813    </p>
4814    <p>S: "OK"
4815    </p>
4816    <p>C: "REMOVE CHANNEL MIDI_INPUT 1"
4817    </p>
4818    <p>S: "OK"
4819    </p>
4820    <p>C: "REMOVE CHANNEL MIDI_INPUT 1 2 0"
4821    </p>
4822    <p>S: "OK"
4823    </p>
4824    </blockquote><p>
4825                        
4826    </p>
4827    <p>Since:
4828    </p>
4829    <p>
4830                            </p>
4831    <blockquote class="text">
4832    <p>Introduced with LSCP v1.6
4833    </p>
4834    </blockquote><p>
4835                        
4836    </p>
4837    <a name="LIST CHANNEL MIDI_INPUTS"></a><br /><hr />
4838    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4839    <a name="rfc.section.6.4.19"></a><h3>6.4.19.&nbsp;
4840    Getting all MIDI inputs of a sampler channel</h3>
4841    
4842    <p>The front-end can query a list of all currently connected
4843                        MIDI inputs of a certain sampler channel by sending the following
4844                        command:
4845    </p>
4846    <p>
4847                            </p>
4848    <blockquote class="text">
4849    <p>LIST CHANNEL MIDI_INPUTS &lt;sampler-channel&gt;
4850    </p>
4851    </blockquote><p>
4852                        
4853    </p>
4854    <p>Where &lt;sampler-channel&gt; is the sampler channel number
4855                        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>
4856                        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.
4857                        
4858    </p>
4859    <p>Possible Answers:
4860    </p>
4861    <p>
4862                            </p>
4863    <blockquote class="text">
4864    <p>The sampler will answer by sending a comma separated
4865                                list of MIDI input device ID - MIDI input port number pairs, where
4866                                each pair is encapsulated into curly braces. The
4867                                list is returned in one single line. The MIDI input
4868                                device ID corresponds to the number returned by
4869                                <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
4870                                and the port number is the index of the respective MIDI
4871                                port of that MIDI input device.
4872    </p>
4873    </blockquote><p>
4874                        
4875    </p>
4876    <p>Example:
4877    </p>
4878    <p>
4879                            </p>
4880    <blockquote class="text">
4881    <p>C: "LIST CHANNEL MIDI_INPUTS 0"
4882    </p>
4883    <p>S: "{0,0},{1,3},{2,0}"
4884    </p>
4885    </blockquote><p>
4886                        
4887    </p>
4888    <p>Since:
4889    </p>
4890    <p>
4891                            </p>
4892    <blockquote class="text">
4893    <p>Introduced with LSCP v1.6
4894    </p>
4895    </blockquote><p>
4896                        
4897    </p>
4898    <a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr />
4899    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4900    <a name="rfc.section.6.4.20"></a><h3>6.4.20.&nbsp;
4901  Setting MIDI input device</h3>  Setting MIDI input device</h3>
4902    
4903    <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR!
4904    </p>
4905  <p>The front-end can set the MIDI input device on a specific sampler  <p>The front-end can set the MIDI input device on a specific sampler
4906                      channel by sending the following command:                      channel by sending the following command:
4907  </p>  </p>
# Line 4567  Setting MIDI input device</h3> Line 4920  Setting MIDI input device</h3>
4920                      <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>                      <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
4921                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a> command.                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a> command.
4922  </p>  </p>
4923    <p>
4924                        If more than 1 MIDI inputs are currently connected to this
4925                        sampler channel: Sending this command will disconnect ALL
4926                        currently connected MIDI input ports connected to this
4927                        sampler channel before establishing the new MIDI input
4928                        connection. So this command does NOT add the connection,
4929                        it replaces all existing ones instead. This behavior is due
4930                        to preserving full behavior backward compatibility.
4931                        
4932    </p>
4933  <p>Possible Answers:  <p>Possible Answers:
4934  </p>  </p>
4935  <p>  <p>
# Line 4611  Setting MIDI input device</h3> Line 4974  Setting MIDI input device</h3>
4974  </blockquote><p>  </blockquote><p>
4975                                            
4976  </p>  </p>
4977    <p>Deprecated:
4978    </p>
4979    <p>
4980                            </p>
4981    <blockquote class="text">
4982    <p>Should not be used anymore as of LSCP v1.6 and younger. This command is currently only preserved for backward compatibility.
4983    </p>
4984    <p>This command is a relict from times where only one MIDI input per sampler channel was allowed. Use <a class='info' href='#ADD CHANNEL MIDI_INPUT'>"ADD CHANNEL MIDI_INPUT"<span> (</span><span class='info'>Add MIDI input to sampler channel</span><span>)</span></a> and <a class='info' href='#REMOVE CHANNEL MIDI_INPUT'>"REMOVE CHANNEL MIDI_INPUT"<span> (</span><span class='info'>Remove MIDI input(s) from sampler channel</span><span>)</span></a> instead.
4985    </p>
4986    </blockquote><p>
4987                        
4988    </p>
4989  <a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr />
4990  <table 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>
4991  <a name="rfc.section.6.4.18"></a><h3>6.4.18.&nbsp;  <a name="rfc.section.6.4.21"></a><h3>6.4.21.&nbsp;
4992  Setting MIDI input type</h3>  Setting MIDI input type</h3>
4993    
4994  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR!
4995  </p>  </p>
4996  <p>The front-end can alter the MIDI input type on a specific sampler  <p>The front-end can alter the MIDI input type on a specific sampler
4997                      channel by sending the following command:                      channel by sending the following command:
# Line 4632  Setting MIDI input type</h3> Line 5007  Setting MIDI input type</h3>
5007  <p>Where &lt;midi-input-type&gt; is currently only "ALSA" and  <p>Where &lt;midi-input-type&gt; is currently only "ALSA" and
5008                      &lt;sampler-channel&gt; is the respective sampler channel number.                      &lt;sampler-channel&gt; is the respective sampler channel number.
5009  </p>  </p>
5010    <p>
5011                        If more than 1 MIDI inputs are currently connected to this
5012                        sampler channel: Sending this command will disconnect ALL
5013                        currently connected MIDI input ports connected to this
5014                        sampler channel before establishing the new MIDI input
5015                        connection. So this command does NOT add the connection,
5016                        it replaces all existing ones instead. This behavior is due
5017                        to preserving full behavior backward compatibility.
5018                        
5019    </p>
5020  <p>Possible Answers:  <p>Possible Answers:
5021  </p>  </p>
5022  <p>  <p>
# Line 4676  Setting MIDI input type</h3> Line 5061  Setting MIDI input type</h3>
5061  </blockquote><p>  </blockquote><p>
5062                                            
5063  </p>  </p>
5064    <p>Deprecated:
5065    </p>
5066    <p>
5067                            </p>
5068    <blockquote class="text">
5069    <p>Should not be used anymore. This command is currently only preserved for backward compatibility.
5070    </p>
5071    <p>This command is a relict from times where only 1 MIDI input per sampler channels was allowed and where no sophisticated driver management existed yet. Use <a class='info' href='#ADD CHANNEL MIDI_INPUT'>"ADD CHANNEL MIDI_INPUT"<span> (</span><span class='info'>Add MIDI input to sampler channel</span><span>)</span></a> and <a class='info' href='#REMOVE CHANNEL MIDI_INPUT'>"REMOVE CHANNEL MIDI_INPUT"<span> (</span><span class='info'>Remove MIDI input(s) from sampler channel</span><span>)</span></a> instead.
5072    </p>
5073    </blockquote><p>
5074                        
5075    </p>
5076  <a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr />
5077  <table 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>
5078  <a name="rfc.section.6.4.19"></a><h3>6.4.19.&nbsp;  <a name="rfc.section.6.4.22"></a><h3>6.4.22.&nbsp;
5079  Setting MIDI input port</h3>  Setting MIDI input port</h3>
5080    
5081    <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR!
5082    </p>
5083  <p>The front-end can alter the MIDI input port on a specific sampler  <p>The front-end can alter the MIDI input port on a specific sampler
5084                      channel by sending the following command:                      channel by sending the following command:
5085  </p>  </p>
# Line 4696  Setting MIDI input port</h3> Line 5095  Setting MIDI input port</h3>
5095                      MIDI input device connected to the sampler channel given by                      MIDI input device connected to the sampler channel given by
5096                      &lt;sampler-channel&gt;.                      &lt;sampler-channel&gt;.
5097  </p>  </p>
5098    <p>
5099                        If more than 1 MIDI inputs are currently connected to this
5100                        sampler channel: Sending this command will switch the
5101                        connection of the first (and only the first) MIDI input port
5102                        currently being connected to this sampler channel, to
5103                        another port of the same MIDI input device. Or in other
5104                        words: the first MIDI input port currently connected to
5105                        this sampler channel will be disconnected, and the requested
5106                        other port of its MIDI input device will be connected to
5107                        this sampler channel instead. This behavior is due
5108                        to preserving full behavior backward compatibility.
5109                        
5110    </p>
5111  <p>Possible Answers:  <p>Possible Answers:
5112  </p>  </p>
5113  <p>  <p>
# Line 4740  Setting MIDI input port</h3> Line 5152  Setting MIDI input port</h3>
5152  </blockquote><p>  </blockquote><p>
5153                                            
5154  </p>  </p>
5155    <p>Deprecated:
5156    </p>
5157    <p>
5158                            </p>
5159    <blockquote class="text">
5160    <p>Should not be used anymore. This command is currently only preserved for backward compatibility.
5161    </p>
5162    <p>This command is a relict from times where only one MIDI input per sampler channel was allowed. Use <a class='info' href='#ADD CHANNEL MIDI_INPUT'>"ADD CHANNEL MIDI_INPUT"<span> (</span><span class='info'>Add MIDI input to sampler channel</span><span>)</span></a> and <a class='info' href='#REMOVE CHANNEL MIDI_INPUT'>"REMOVE CHANNEL MIDI_INPUT"<span> (</span><span class='info'>Remove MIDI input(s) from sampler channel</span><span>)</span></a> instead.
5163    </p>
5164    </blockquote><p>
5165                        
5166    </p>
5167  <a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr />
5168  <table 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>
5169  <a name="rfc.section.6.4.20"></a><h3>6.4.20.&nbsp;  <a name="rfc.section.6.4.23"></a><h3>6.4.23.&nbsp;
5170  Setting MIDI input channel</h3>  Setting MIDI input channel</h3>
5171    
5172  <p>The front-end can alter the MIDI channel a sampler channel should  <p>The front-end can alter the MIDI channel a sampler channel should
# Line 4756  Setting MIDI input channel</h3> Line 5180  Setting MIDI input channel</h3>
5180  </blockquote><p>  </blockquote><p>
5181                                            
5182  </p>  </p>
5183  <p>Where &lt;midi-input-chan&gt; is the number of the new MIDI input channel where  <p>Where &lt;midi-input-chan&gt; is the number
5184                      &lt;sampler-channel&gt; should listen to or "ALL" to listen on all 16 MIDI                      of the new MIDI input channel (zero indexed!) where
5185                        &lt;sampler-channel&gt; should listen to, or "ALL" to listen on all 16 MIDI
5186                      channels.                      channels.
5187  </p>  </p>
5188  <p>Possible Answers:  <p>Possible Answers:
# Line 4799  Setting MIDI input channel</h3> Line 5224  Setting MIDI input channel</h3>
5224  <p>  <p>
5225                          </p>                          </p>
5226  <blockquote class="text">  <blockquote class="text">
5227  <p>  <p>C: "SET CHANNEL MIDI_INPUT_CHANNEL 0 0"
5228    </p>
5229    <p>S: "OK"
5230    </p>
5231    <p>C: "SET CHANNEL MIDI_INPUT_CHANNEL 1 ALL"
5232    </p>
5233    <p>S: "OK"
5234  </p>  </p>
5235  </blockquote><p>  </blockquote><p>
5236                                            
5237  </p>  </p>
5238  <a name="SET CHANNEL VOLUME"></a><br /><hr />  <a name="SET CHANNEL VOLUME"></a><br /><hr />
5239  <table 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>
5240  <a name="rfc.section.6.4.21"></a><h3>6.4.21.&nbsp;  <a name="rfc.section.6.4.24"></a><h3>6.4.24.&nbsp;
5241  Setting channel volume</h3>  Setting channel volume</h3>
5242    
5243  <p>The front-end can alter the volume of a sampler channel by sending  <p>The front-end can alter the volume of a sampler channel by sending
# Line 4871  Setting channel volume</h3> Line 5302  Setting channel volume</h3>
5302  </p>  </p>
5303  <a name="SET CHANNEL MUTE"></a><br /><hr />  <a name="SET CHANNEL MUTE"></a><br /><hr />
5304  <table 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>
5305  <a name="rfc.section.6.4.22"></a><h3>6.4.22.&nbsp;  <a name="rfc.section.6.4.25"></a><h3>6.4.25.&nbsp;
5306  Muting a sampler channel</h3>  Muting a sampler channel</h3>
5307    
5308  <p>The front-end can mute/unmute a specific sampler  <p>The front-end can mute/unmute a specific sampler
# Line 4937  Muting a sampler channel</h3> Line 5368  Muting a sampler channel</h3>
5368  </p>  </p>
5369  <a name="SET CHANNEL SOLO"></a><br /><hr />  <a name="SET CHANNEL SOLO"></a><br /><hr />
5370  <table 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>
5371  <a name="rfc.section.6.4.23"></a><h3>6.4.23.&nbsp;  <a name="rfc.section.6.4.26"></a><h3>6.4.26.&nbsp;
5372  Soloing a sampler channel</h3>  Soloing a sampler channel</h3>
5373    
5374  <p>The front-end can solo/unsolo a specific sampler channel  <p>The front-end can solo/unsolo a specific sampler channel
# Line 5003  Soloing a sampler channel</h3> Line 5434  Soloing a sampler channel</h3>
5434  </p>  </p>
5435  <a name="SET CHANNEL MIDI_INSTRUMENT_MAP"></a><br /><hr />  <a name="SET CHANNEL MIDI_INSTRUMENT_MAP"></a><br /><hr />
5436  <table 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>
5437  <a name="rfc.section.6.4.24"></a><h3>6.4.24.&nbsp;  <a name="rfc.section.6.4.27"></a><h3>6.4.27.&nbsp;
5438  Assigning a MIDI instrument map to a sampler channel</h3>  Assigning a MIDI instrument map to a sampler channel</h3>
5439    
5440  <p>The front-end can assign a MIDI instrument map to a specific sampler channel  <p>The front-end can assign a MIDI instrument map to a specific sampler channel
# Line 5101  Assigning a MIDI instrument map to a sam Line 5532  Assigning a MIDI instrument map to a sam
5532  </p>  </p>
5533  <a name="CREATE FX_SEND"></a><br /><hr />  <a name="CREATE FX_SEND"></a><br /><hr />
5534  <table 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>
5535  <a name="rfc.section.6.4.25"></a><h3>6.4.25.&nbsp;  <a name="rfc.section.6.4.28"></a><h3>6.4.28.&nbsp;
5536  Adding an effect send to a sampler channel</h3>  Adding an effect send to a sampler channel</h3>
5537    
5538  <p>The front-end can create an additional effect send on a specific sampler channel  <p>The front-end can create an additional effect send on a specific sampler channel
# Line 5194  Adding an effect send to a sampler chann Line 5625  Adding an effect send to a sampler chann
5625  </p>  </p>
5626  <a name="DESTROY FX_SEND"></a><br /><hr />  <a name="DESTROY FX_SEND"></a><br /><hr />
5627  <table 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>
5628  <a name="rfc.section.6.4.26"></a><h3>6.4.26.&nbsp;  <a name="rfc.section.6.4.29"></a><h3>6.4.29.&nbsp;
5629  Removing an effect send from a sampler channel</h3>  Removing an effect send from a sampler channel</h3>
5630    
5631  <p>The front-end can remove an existing effect send on a specific sampler channel  <p>The front-end can remove an existing effect send on a specific sampler channel
# Line 5255  Removing an effect send from a sampler c Line 5686  Removing an effect send from a sampler c
5686  </p>  </p>
5687  <a name="GET FX_SENDS"></a><br /><hr />  <a name="GET FX_SENDS"></a><br /><hr />
5688  <table 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>
5689  <a name="rfc.section.6.4.27"></a><h3>6.4.27.&nbsp;  <a name="rfc.section.6.4.30"></a><h3>6.4.30.&nbsp;
5690  Getting amount of effect sends on a sampler channel</h3>  Getting amount of effect sends on a sampler channel</h3>
5691    
5692  <p>The front-end can ask for the amount of effect sends on a specific sampler channel  <p>The front-end can ask for the amount of effect sends on a specific sampler channel
# Line 5298  Getting amount of effect sends on a samp Line 5729  Getting amount of effect sends on a samp
5729  </p>  </p>
5730  <a name="LIST FX_SENDS"></a><br /><hr />  <a name="LIST FX_SENDS"></a><br /><hr />
5731  <table 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>
5732  <a name="rfc.section.6.4.28"></a><h3>6.4.28.&nbsp;  <a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;
5733  Listing all effect sends on a sampler channel</h3>  Listing all effect sends on a sampler channel</h3>
5734    
5735  <p>The front-end can ask for a list of effect sends on a specific sampler channel  <p>The front-end can ask for a list of effect sends on a specific sampler channel
# Line 5352  Listing all effect sends on a sampler ch Line 5783  Listing all effect sends on a sampler ch
5783  </p>  </p>
5784  <a name="GET FX_SEND INFO"></a><br /><hr />  <a name="GET FX_SEND INFO"></a><br /><hr />
5785  <table 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>
5786  <a name="rfc.section.6.4.29"></a><h3>6.4.29.&nbsp;  <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;
5787  Getting effect send information</h3>  Getting effect send information</h3>
5788    
5789  <p>The front-end can ask for the current settings of an effect send entity  <p>The front-end can ask for the current settings of an effect send entity
# Line 5428  Getting effect send information</h3> Line 5859  Getting effect send information</h3>
5859                                              channel 1 is routed to the channel 3 of the audio                                              channel 1 is routed to the channel 3 of the audio
5860                                              output device (see                                              output device (see
5861                                              <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>
5862                                              for details)                                              for details), if an internal send
5863                                                effect is assigned to the effect
5864                                                send, then this setting defines the
5865                                                audio channel routing to that
5866                                                effect instance respectively
5867    </p>
5868    </blockquote>
5869                                        
5870    
5871    <p>EFFECT -
5872                                            </p>
5873    <blockquote class="text">
5874    <p>destination send effect chain ID
5875                                                and destination effect chain
5876                                                position, separated by comma in the
5877                                                form "&lt;effect-chain&gt;,&lt;chain-pos&gt;"
5878                                                or "NONE" if there is no send effect
5879                                                assigned to the effect send
5880  </p>  </p>
5881  </blockquote>  </blockquote>
5882                                                                            
# Line 5456  Getting effect send information</h3> Line 5904  Getting effect send information</h3>
5904  </p>  </p>
5905  <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"  <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"
5906  </p>  </p>
5907    <p>&nbsp;&nbsp;&nbsp;"EFFECT: NONE"
5908    </p>
5909    <p>&nbsp;&nbsp;&nbsp;"."
5910    </p>
5911    </blockquote><p>
5912                        
5913    </p>
5914    <p>
5915                            </p>
5916    <blockquote class="text">
5917    <p>C: "GET FX_SEND INFO 0 1"
5918    </p>
5919    <p>S: "NAME: Delay Send (Internal)"
5920    </p>
5921    <p>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 93"
5922    </p>
5923    <p>&nbsp;&nbsp;&nbsp;"LEVEL: 0.51"
5924    </p>
5925    <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 1,2"
5926    </p>
5927    <p>&nbsp;&nbsp;&nbsp;"EFFECT: 2,0"
5928    </p>
5929  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
5930  </p>  </p>
5931  </blockquote><p>  </blockquote><p>
# Line 5463  Getting effect send information</h3> Line 5933  Getting effect send information</h3>
5933  </p>  </p>
5934  <a name="SET FX_SEND NAME"></a><br /><hr />  <a name="SET FX_SEND NAME"></a><br /><hr />
5935  <table 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>
5936  <a name="rfc.section.6.4.30"></a><h3>6.4.30.&nbsp;  <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;
5937  Changing effect send's name</h3>  Changing effect send's name</h3>
5938    
5939  <p>The front-end can alter the current name of an effect  <p>The front-end can alter the current name of an effect
# Line 5527  Changing effect send's name</h3> Line 5997  Changing effect send's name</h3>
5997  </p>  </p>
5998  <a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr />  <a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
5999  <table 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>
6000  <a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;  <a name="rfc.section.6.4.34"></a><h3>6.4.34.&nbsp;
6001  Altering effect send's audio routing</h3>  Altering effect send's audio routing</h3>
6002    
6003  <p>The front-end can alter the destination of an effect send's audio channel on a specific  <p>The front-end can alter the destination of an effect send's audio channel on a specific
# Line 5550  Altering effect send's audio routing</h3 Line 6020  Altering effect send's audio routing</h3
6020                      &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
6021                      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
6022                      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;
6023                      should be routed to.                      should be routed to. If an internal send effect is assigned
6024                        to the effect send, then this setting defines the audio
6025                        channel routing to that effect instance respectively.
6026  </p>  </p>
6027  <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
6028                      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 6080  Altering effect send's audio routing</h3
6080  </blockquote><p>  </blockquote><p>
6081                                            
6082  </p>  </p>
6083    <a name="SET FX_SEND EFFECT"></a><br /><hr />
6084    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6085    <a name="rfc.section.6.4.35"></a><h3>6.4.35.&nbsp;
6086    Assigning destination effect to an effect send</h3>
6087    
6088    <p>The front-end can (re-)assign a destination effect to an
6089                        effect send by sending the following command:
6090    </p>
6091    <p>
6092                            </p>
6093    <blockquote class="text">
6094    <p>SET FX_SEND EFFECT &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;effect-chain&gt; &lt;chain-pos&gt;
6095    </p>
6096    </blockquote><p>
6097                        
6098    </p>
6099    <p>Where &lt;sampler-chan&gt; is the sampler channel number
6100                        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>
6101                        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,
6102                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
6103                        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>
6104                        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,
6105                        &lt;effect-chain&gt; by the numerical ID of the destination
6106                        effect chain as returned by the
6107                        <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>
6108                        or
6109                        <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>
6110                        command and &lt;chain-pos&gt; reflects the exact effect
6111                        chain position in the effect chain which hosts the actual
6112                        destination effect.
6113    </p>
6114    <p>Possible Answers:
6115    </p>
6116    <p>
6117                            </p>
6118    <blockquote class="text">
6119    <p>"OK" -
6120                                    </p>
6121    <blockquote class="text">
6122    <p>on success
6123    </p>
6124    </blockquote>
6125                                
6126    
6127    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6128                                    </p>
6129    <blockquote class="text">
6130    <p>in case it failed, providing an appropriate error code and error message
6131    </p>
6132    </blockquote>
6133                                
6134    
6135    </blockquote><p>
6136                        
6137    </p>
6138    <p>Example:
6139    </p>
6140    <p>
6141                            </p>
6142    <blockquote class="text">
6143    <p>C: "SET FX_SEND EFFECT 0 0 2 5"
6144    </p>
6145    <p>S: "OK"
6146    </p>
6147    </blockquote><p>
6148                        
6149    </p>
6150    <a name="REMOVE FX_SEND EFFECT"></a><br /><hr />
6151    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6152    <a name="rfc.section.6.4.36"></a><h3>6.4.36.&nbsp;
6153    Removing destination effect from an effect send</h3>
6154    
6155    <p>The front-end can (re-)assign a destination effect to an
6156                        effect send by sending the following command:
6157    </p>
6158    <p>
6159                            </p>
6160    <blockquote class="text">
6161    <p>REMOVE FX_SEND EFFECT &lt;sampler-chan&gt; &lt;fx-send-id&gt;
6162    </p>
6163    </blockquote><p>
6164                        
6165    </p>
6166    <p>Where &lt;sampler-chan&gt; is the sampler channel number
6167                        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>
6168                        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,
6169                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
6170                        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>
6171                        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.
6172    </p>
6173    <p>After the destination effect has been removed from the
6174                        effect send, the audio signal of the effect send will be
6175                        routed directly to the audio output device, according to the
6176                        audio channel routing setting of the effect send.
6177                        
6178    </p>
6179    <p>Possible Answers:
6180    </p>
6181    <p>
6182                            </p>
6183    <blockquote class="text">
6184    <p>"OK" -
6185                                    </p>
6186    <blockquote class="text">
6187    <p>on success
6188    </p>
6189    </blockquote>
6190                                
6191    
6192    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6193                                    </p>
6194    <blockquote class="text">
6195    <p>in case it failed, providing an appropriate error code and error message
6196    </p>
6197    </blockquote>
6198                                
6199    
6200    </blockquote><p>
6201                        
6202    </p>
6203    <p>Example:
6204    </p>
6205    <p>
6206                            </p>
6207    <blockquote class="text">
6208    <p>C: "REMOVE FX_SEND EFFECT 0 0"
6209    </p>
6210    <p>S: "OK"
6211    </p>
6212    </blockquote><p>
6213                        
6214    </p>
6215  <a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />  <a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />
6216  <table 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>
6217  <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;  <a name="rfc.section.6.4.37"></a><h3>6.4.37.&nbsp;
6218  Altering effect send's MIDI controller</h3>  Altering effect send's MIDI controller</h3>
6219    
6220  <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 6285  Altering effect send's MIDI controller</
6285  </p>  </p>
6286  <a name="SET FX_SEND LEVEL"></a><br /><hr />  <a name="SET FX_SEND LEVEL"></a><br /><hr />
6287  <table 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>
6288  <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;  <a name="rfc.section.6.4.38"></a><h3>6.4.38.&nbsp;
6289  Altering effect send's send level</h3>  Altering effect send's send level</h3>
6290    
6291  <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 6357  Altering effect send's send level</h3>
6357  </p>  </p>
6358  <a name="SEND CHANNEL MIDI_DATA"></a><br /><hr />  <a name="SEND CHANNEL MIDI_DATA"></a><br /><hr />
6359  <table 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>
6360  <a name="rfc.section.6.4.34"></a><h3>6.4.34.&nbsp;  <a name="rfc.section.6.4.39"></a><h3>6.4.39.&nbsp;
6361  Sending MIDI messages to sampler channel</h3>  Sending MIDI messages to sampler channel</h3>
6362    
6363  <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
6364                      by sending the following command:                      by sending the following command:
6365  </p>  </p>
6366  <p>  <p>
# Line 5796  Sending MIDI messages to sampler channel Line 6400  Sending MIDI messages to sampler channel
6400  </blockquote>  </blockquote>
6401                                                            
6402    
6403    <p>"CC" -
6404                                    </p>
6405    <blockquote class="text">
6406    <p>For changing a MIDI controller, where &lt;arg1&gt;
6407                                        specifies the controller number and &lt;arg2&gt; the
6408                                        new value of the controller as described in the Control
6409                                        Change section of the MIDI specification.
6410    </p>
6411    </blockquote>
6412                                
6413    
6414  </blockquote><p>  </blockquote><p>
6415                                            
6416  </p>  </p>
# Line 5840  Sending MIDI messages to sampler channel Line 6455  Sending MIDI messages to sampler channel
6455  </p>  </p>
6456  <a name="RESET CHANNEL"></a><br /><hr />  <a name="RESET CHANNEL"></a><br /><hr />
6457  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6458  <a name="rfc.section.6.4.35"></a><h3>6.4.35.&nbsp;  <a name="rfc.section.6.4.40"></a><h3>6.4.40.&nbsp;
6459  Resetting a sampler channel</h3>  Resetting a sampler channel</h3>
6460    
6461  <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 6319  General sampler informations</h3> Line 6934  General sampler informations</h3>
6934  <p>The mentioned fields above don't have to be in particular order.  <p>The mentioned fields above don't have to be in particular order.
6935                      Other fields might be added in future.                      Other fields might be added in future.
6936  </p>  </p>
6937    <p>Example:
6938    </p>
6939    <p>
6940                            </p>
6941    <blockquote class="text">
6942    <p>C: "GET SERVER INFO"
6943    </p>
6944    <p>S: "DESCRIPTION: LinuxSampler - modular, streaming capable sampler"
6945    </p>
6946    <p>&nbsp;&nbsp;&nbsp;"VERSION: 1.0.0.svn23"
6947    </p>
6948    <p>&nbsp;&nbsp;&nbsp;"PROTOCOL_VERSION: 1.5"
6949    </p>
6950    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENTS_DB_SUPPORT: no"
6951    </p>
6952    <p>&nbsp;&nbsp;&nbsp;"."
6953    </p>
6954    </blockquote><p>
6955                        
6956    </p>
6957  <a name="GET VOLUME"></a><br /><hr />  <a name="GET VOLUME"></a><br /><hr />
6958  <table 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>
6959  <a name="rfc.section.6.6.6"></a><h3>6.6.6.&nbsp;  <a name="rfc.section.6.6.6"></a><h3>6.6.6.&nbsp;
# Line 6407  Setting global volume attenuation</h3> Line 7042  Setting global volume attenuation</h3>
7042  </blockquote><p>  </blockquote><p>
7043                                            
7044  </p>  </p>
7045    <a name="GET VOICES"></a><br /><hr />
7046    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7047    <a name="rfc.section.6.6.8"></a><h3>6.6.8.&nbsp;
7048    Getting global voice limit</h3>
7049    
7050    <p>The client can ask for the current global sampler-wide limit
7051                           for maximum voices by sending the following command:
7052    </p>
7053    <p>
7054                            </p>
7055    <blockquote class="text">
7056    <p>GET VOICES
7057    </p>
7058    </blockquote><p>
7059                        
7060    </p>
7061    <p>Possible Answers:
7062    </p>
7063    <p>
7064                            </p>
7065    <blockquote class="text">
7066    <p>LinuxSampler will answer by returning the number for
7067                                   the current limit of maximum voices.
7068    </p>
7069    </blockquote><p>
7070                        
7071    </p>
7072    <p>The voice limit setting defines how many voices should maximum
7073                           be processed by the sampler at the same time. If the user
7074                           triggers new notes which would exceed that voice limit, the
7075                           sampler engine will react by stealing old voices for those
7076                           newly triggered notes. Note that the amount of voices triggered
7077                           by a new note can be larger than one and is dependent to the
7078                           respective instrument and probably further criterias.
7079    </p>
7080    <a name="SET VOICES"></a><br /><hr />
7081    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7082    <a name="rfc.section.6.6.9"></a><h3>6.6.9.&nbsp;
7083    Setting global voice limit</h3>
7084    
7085    <p>The client can alter the current global sampler-wide limit
7086                        for maximum voices by sending the following command:
7087    </p>
7088    <p>
7089                            </p>
7090    <blockquote class="text">
7091    <p>SET VOICES &lt;max-voices&gt;
7092    </p>
7093    </blockquote><p>
7094                        
7095    </p>
7096    <p>Where &lt;max-voices&gt; should be replaced by the integer
7097                       value, reflecting the new global amount limit of maximum voices.
7098                       This value has to be larger than 0.
7099    </p>
7100    <p>Possible Answers:
7101    </p>
7102    <p>
7103                            </p>
7104    <blockquote class="text">
7105    <p>"OK" -
7106                                    </p>
7107    <blockquote class="text">
7108    <p>on success
7109    </p>
7110    </blockquote>
7111                                
7112    
7113    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
7114                                    </p>
7115    <blockquote class="text">
7116    <p>if the voice limit was set, but there are noteworthy
7117                                        issue(s) related, providing an appropriate warning code and
7118                                        warning message
7119    </p>
7120    </blockquote>
7121                                
7122    
7123    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7124                                    </p>
7125    <blockquote class="text">
7126    <p>in case it failed, providing an appropriate error code and error message
7127    </p>
7128    </blockquote>
7129                                
7130    
7131    </blockquote><p>
7132                        
7133    </p>
7134    <p>Note: the given value will be passed to all sampler engine instances.
7135                           The total amount of maximum voices on the running system might thus
7136                           be as big as the given value multiplied by the current amount of engine
7137                           instances.
7138    </p>
7139    <p>Caution: when adjusting the voice limit, you SHOULD also
7140                            adjust the disk stream limit respectively and vice versa.
7141    </p>
7142    <a name="GET STREAMS"></a><br /><hr />
7143    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7144    <a name="rfc.section.6.6.10"></a><h3>6.6.10.&nbsp;
7145    Getting global disk stream limit</h3>
7146    
7147    <p>The client can ask for the current global sampler-wide limit
7148                           for maximum disk streams by sending the following command:
7149    </p>
7150    <p>
7151                            </p>
7152    <blockquote class="text">
7153    <p>GET STREAMS
7154    </p>
7155    </blockquote><p>
7156                        
7157    </p>
7158    <p>Possible Answers:
7159    </p>
7160    <p>
7161                            </p>
7162    <blockquote class="text">
7163    <p>LinuxSampler will answer by returning the number for
7164                                   the current limit of maximum disk streams.
7165    </p>
7166    </blockquote><p>
7167                        
7168    </p>
7169    <p>The disk stream limit setting defines how many disk streams should
7170                           maximum be processed by a sampler engine at the same time. The
7171                           higher this value, the more memory (RAM) will be occupied, since
7172                           every disk streams allocates a certain buffer size for being able
7173                           to perform its streaming operations.
7174    </p>
7175    <a name="SET STREAMS"></a><br /><hr />
7176    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7177    <a name="rfc.section.6.6.11"></a><h3>6.6.11.&nbsp;
7178    Setting global disk stream limit</h3>
7179    
7180    <p>The client can alter the current global sampler-wide limit
7181                        for maximum disk streams by sending the following command:
7182    </p>
7183    <p>
7184                            </p>
7185    <blockquote class="text">
7186    <p>SET STREAMS &lt;max-streams&gt;
7187    </p>
7188    </blockquote><p>
7189                        
7190    </p>
7191    <p>Where &lt;max-streams&gt; should be replaced by the integer
7192                       value, reflecting the new global amount limit of maximum disk streams.
7193                       This value has to be positive.
7194    </p>
7195    <p>Possible Answers:
7196    </p>
7197    <p>
7198                            </p>
7199    <blockquote class="text">
7200    <p>"OK" -
7201                                    </p>
7202    <blockquote class="text">
7203    <p>on success
7204    </p>
7205    </blockquote>
7206                                
7207    
7208    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
7209                                    </p>
7210    <blockquote class="text">
7211    <p>if the disk stream limit was set, but there are noteworthy
7212                                        issue(s) related, providing an appropriate warning code and
7213                                        warning message
7214    </p>
7215    </blockquote>
7216                                
7217    
7218    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7219                                    </p>
7220    <blockquote class="text">
7221    <p>in case it failed, providing an appropriate error code and error message
7222    </p>
7223    </blockquote>
7224                                
7225    
7226    </blockquote><p>
7227                        
7228    </p>
7229    <p>Note: the given value will be passed to all sampler engine instances.
7230                           The total amount of maximum disk streams on the running system might
7231                           thus be as big as the given value multiplied by the current amount of
7232                           engine instances.
7233    </p>
7234    <p>Caution: when adjusting the disk stream limit, you SHOULD also
7235                            adjust the voice limit respectively and vice versa.
7236    </p>
7237  <a name="MIDI Instrument Mapping"></a><br /><hr />  <a name="MIDI Instrument Mapping"></a><br /><hr />
7238  <table 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>
7239  <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;  <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;
# Line 7043  Create or replace a MIDI instrument map Line 7870  Create or replace a MIDI instrument map
7870  <a name="GET MIDI_INSTRUMENTS"></a><br /><hr />  <a name="GET MIDI_INSTRUMENTS"></a><br /><hr />
7871  <table 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>
7872  <a name="rfc.section.6.7.8"></a><h3>6.7.8.&nbsp;  <a name="rfc.section.6.7.8"></a><h3>6.7.8.&nbsp;
7873  Getting ammount of MIDI instrument map entries</h3>  Getting amount of MIDI instrument map entries</h3>
7874    
7875  <p>The front-end can query the amount of currently existing  <p>The front-end can query the amount of currently existing
7876                      entries in a MIDI instrument map by sending the following                      entries in a MIDI instrument map by sending the following
# Line 8153  Adding instruments to the instruments da Line 8980  Adding instruments to the instruments da
8980  <p>  <p>
8981                          </p>                          </p>
8982  <blockquote class="text">  <blockquote class="text">
8983  <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;]
8984  </p>  </p>
8985  </blockquote><p>  </blockquote><p>
8986                                            
# Line 8211  Adding instruments to the instruments da Line 9038  Adding instruments to the instruments da
9038  </blockquote><p>  </blockquote><p>
9039                                            
9040  </p>  </p>
9041    <p> If FILE_AS_DIR argument is supplied, all instruments in an instrument
9042                     file will be added to a separate directory in the instruments database, which
9043                     name will be the name of the instrument file with the file extension stripped off.
9044                    
9045    </p>
9046  <p>The difference between regular and NON_MODAL versions of the command  <p>The difference between regular and NON_MODAL versions of the command
9047                      is that the regular command returns when the scanning is finished                      is that the regular command returns when the scanning is finished
9048                      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 10504  Retrieving informations about one instru
10504  </blockquote><p>  </blockquote><p>
10505                                            
10506  </p>  </p>
10507    <a name="effects"></a><br /><hr />
10508    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10509    <a name="rfc.section.6.11"></a><h3>6.11.&nbsp;
10510    Managing Effects</h3>
10511    
10512    <p>Audio effects (e.g. reverb, delay, compression) can be
10513                    applied to the audio signals generated by the sampler. The
10514                    sampler usually provides a set of internal audio effects for
10515                    this task. The exact set of effects depends on the availability
10516                    of third party effect plugins installed on the system where the
10517                    sampler runs on.
10518    </p>
10519    <p>At the moment only "send effects" are supported. Support for
10520                    "insert effects" and "master effects" is planned to be added at
10521                    a later point.
10522    </p>
10523    <p>The following commands allow to retrieve the set of internal
10524                    effects available to the sampler, detailed informations about
10525                    those effects and to create and destroy instances of such
10526                    effects. After an instance of an effect is created, the effect
10527                    instance can be inserted into the audio signal path of the
10528                    sampler, e.g. as send effect.
10529    </p>
10530    <p>The sampler allows to create an arbitrary amount of so called
10531                    send effect chains. Each effect chain can host an arbitrary
10532                    amount of effect instances. The output of the first effect
10533                    instance in an effect chain is fed to the input of the second
10534                    effect instance of the chain and so on. So effects in one chain
10535                    are processed sequentially. Send effect chains however are
10536                    processed in parallel to other send effect chains. Audio signals
10537                    of sampler channels are fed to send effects by creating FX sends
10538                    to the respective sampler channel and assigning a destination
10539                    send effect to that FX by using the
10540                    <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>
10541                    command. The latter allows to route the FX send to the beginning
10542                    of a send effect chain, as well as directly to any other
10543                    position of the send effect chain.
10544    </p>
10545    <a name="GET AVAILABLE_EFFECTS"></a><br /><hr />
10546    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10547    <a name="rfc.section.6.11.1"></a><h3>6.11.1.&nbsp;
10548    Retrieve amount of available effects</h3>
10549    
10550    <p>The front-end can retrieve the amount of internal
10551                        effects, available to the sampler by sending
10552                        the following command:
10553    </p>
10554    <p>
10555                            </p>
10556    <blockquote class="text">
10557    <p>GET AVAILABLE_EFFECTS
10558    </p>
10559    </blockquote><p>
10560                        
10561    </p>
10562    <p>Possible Answers:
10563    </p>
10564    <p>
10565                            </p>
10566    <blockquote class="text">
10567    <p>The sampler will answer by returning the current
10568                                number of effects available to the sampler.
10569    </p>
10570    </blockquote><p>
10571                        
10572    </p>
10573    <p>Examples:
10574    </p>
10575    <p>
10576                            </p>
10577    <blockquote class="text">
10578    <p>C: "GET AVAILABLE_EFFECTS"
10579    </p>
10580    <p>S: "129"
10581    </p>
10582    </blockquote><p>
10583                        
10584    </p>
10585    <a name="LIST AVAILABLE_EFFECTS"></a><br /><hr />
10586    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10587    <a name="rfc.section.6.11.2"></a><h3>6.11.2.&nbsp;
10588    Get list of available effects</h3>
10589    
10590    <p>The set of available internal effects can change at
10591                        runtime. The front-end can retrieve the list of internal
10592                        effects, available to the sampler by sending the following
10593                        command:
10594    </p>
10595    <p>
10596                            </p>
10597    <blockquote class="text">
10598    <p>LIST AVAILABLE_EFFECTS
10599    </p>
10600    </blockquote><p>
10601                        
10602    </p>
10603    <p>Possible Answers:
10604    </p>
10605    <p>
10606                            </p>
10607    <blockquote class="text">
10608    <p>The sampler will answer by returning a comma
10609                                separated list with numerical IDs of effects. Note:
10610                                the numercial ID of an effect is generated by the
10611                                sampler for the current moment. The numerical ID of
10612                                the same effect can change at runtime, e.g. when the
10613                                user requests a rescan of available effect plugins.
10614                                
10615    </p>
10616    </blockquote><p>
10617                        
10618    </p>
10619    <p>Example:
10620    </p>
10621    <p>
10622                            </p>
10623    <blockquote class="text">
10624    <p>C: "LIST AVAILABLE_EFFECTS"
10625    </p>
10626    <p>S: "5,6,7,120,121,122,123,124"
10627    </p>
10628    </blockquote><p>
10629                        
10630    </p>
10631    <a name="GET EFFECT INFO"></a><br /><hr />
10632    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10633    <a name="rfc.section.6.11.3"></a><h3>6.11.3.&nbsp;
10634    Retrieving general information about an effect</h3>
10635    
10636    <p>The front-end can ask for general informations about an
10637                        effect by sending the following command:
10638    </p>
10639    <p>
10640                            </p>
10641    <blockquote class="text">
10642    <p>GET EFFECT INFO &lt;effect-index&gt;
10643    </p>
10644    </blockquote><p>
10645                        
10646    </p>
10647    <p>Where &lt;effect-index&gt; is the numerical ID of an
10648                        effect as returned by the
10649                        <a class='info' href='#LIST AVAILABLE_EFFECTS'>"LIST AVAILABLE_EFFECTS"<span> (</span><span class='info'>Get list of available effects</span><span>)</span></a>
10650                        command.
10651    </p>
10652    <p>Possible Answers:
10653    </p>
10654    <p>
10655                            </p>
10656    <blockquote class="text">
10657    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
10658                                Each answer line begins with the effect information
10659                                category name, followed by a colon and then a space
10660                                character &lt;SP&gt; and finally the info character
10661                                string to that effect information category. At the
10662                                moment the following categories are defined:
10663    </p>
10664    <p>
10665                                    </p>
10666    <blockquote class="text">
10667    <p>SYSTEM -
10668                                            </p>
10669    <blockquote class="text">
10670    <p>name of the effect plugin system
10671                                                the effect is based on
10672                                                (e.g. "LADSPA")
10673    </p>
10674    </blockquote>
10675                                        
10676    
10677    <p>MODULE -
10678                                            </p>
10679    <blockquote class="text">
10680    <p>module of the effect plugin
10681                                                system that contains this effect,
10682                                                the module is usually the
10683                                                dynamic-linked library (DLL)
10684                                                filename of the effect plugin,
10685                                                including full path (note that this
10686                                                filename may contain
10687                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
10688    </p>
10689    </blockquote>
10690                                        
10691    
10692    <p>NAME -
10693                                            </p>
10694    <blockquote class="text">
10695    <p>character string defining the
10696                                                unique name of the effect within its
10697                                                module (note that the character
10698                                                string may contain
10699                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
10700    </p>
10701    </blockquote>
10702                                        
10703    
10704    <p>DESCRIPTION -
10705                                            </p>
10706    <blockquote class="text">
10707    <p>human readable name of the
10708                                                effect, intended to be displayed in
10709                                                user interfaces (note that the
10710                                                character string may contain
10711                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
10712    </p>
10713    </blockquote>
10714                                        
10715    
10716    </blockquote>
10717                                
10718    
10719    </blockquote><p>
10720                        
10721    </p>
10722    <p>The mentioned fields above don't have to be in particular order.
10723    </p>
10724    <p>Example:
10725    </p>
10726    <p>
10727                            </p>
10728    <blockquote class="text">
10729    <p>C: "GET EFFECT INFO 121"
10730    </p>
10731    <p>S: "SYSTEM: LADSPA"
10732    </p>
10733    <p>&nbsp;&nbsp;&nbsp;"MODULE: /usr/lib/ladspa/lowpass_iir_1891.so"
10734    </p>
10735    <p>&nbsp;&nbsp;&nbsp;"NAME: lowpass_iir"
10736    </p>
10737    <p>&nbsp;&nbsp;&nbsp;"DESCRIPTION: Glame Lowpass Filter"
10738    </p>
10739    <p>&nbsp;&nbsp;&nbsp;"."
10740    </p>
10741    </blockquote><p>
10742                        
10743    </p>
10744    <a name="CREATE EFFECT_INSTANCE"></a><br /><hr />
10745    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10746    <a name="rfc.section.6.11.4"></a><h3>6.11.4.&nbsp;
10747    Creating an instance of an effect by its portable ID</h3>
10748    
10749    <p>The front-end can spawn an instance of the desired
10750                        effect by sending the following command:
10751    </p>
10752    <p>
10753                            </p>
10754    <blockquote class="text">
10755    <p>CREATE EFFECT_INSTANCE &lt;effect-system&gt; &lt;module&gt; &lt;effect-name&gt;
10756    </p>
10757    </blockquote><p>
10758                        
10759    </p>
10760    <p>Where &lt;effect-system&gt; is the "SYSTEM" field,
10761                        &lt;module&gt; the "MODULE" field and &lt;effect-name&gt;
10762                        the "NAME" field as returned by the
10763                        <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>
10764                        command. The filename of argument &lt;module&gt; and the
10765                        character string of argument &lt;effect-name&gt; may contain
10766                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
10767    </p>
10768    <p>The sampler will try to load the requested effect and to
10769                        create an instance of it. To allow loading the same effect
10770                        on a different machine, probably even running a completely
10771                        different operating system (e.g. Linux vs. Windows), the
10772                        sampler tries to match &lt;module&gt; "softly". That means
10773                        it first tries to find an effect that exactly matches the
10774                        given &lt;module&gt; argument. If there is no exact match,
10775                        the sampler will try to lower the restrictions on matching
10776                        the &lt;module&gt; argument more and more, e.g. by ignoring
10777                        upper / lower case differences and by ignoring the path of
10778                        the DLL filename and file extension. If there is still no
10779                        match at the end, the sampler will try to ignore the
10780                        &lt;module&gt; argument completely and as a last resort
10781                        search for an effect that only matches the given
10782                        &lt;effect-system&gt; and &lt;effect-name&gt; arguments.
10783    </p>
10784    <p>Possible Answers:
10785    </p>
10786    <p>
10787                            </p>
10788    <blockquote class="text">
10789    <p>"OK[&lt;effect-instance&gt;]" -
10790                                    </p>
10791    <blockquote class="text">
10792    <p>in case the effect instance was
10793                                        successfully created, where
10794                                        &lt;effect-instance&gt; is the numerical ID
10795                                        of the new effect instance
10796    </p>
10797    </blockquote>
10798                                
10799    
10800    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
10801                                    </p>
10802    <blockquote class="text">
10803    <p>in case the effect instance was spawned
10804                                        successfully, but there are noteworthy
10805                                        issue(s) related, providing an appropriate
10806                                        warning code and warning message
10807    </p>
10808    </blockquote>
10809                                
10810    
10811    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
10812                                    </p>
10813    <blockquote class="text">
10814    <p>if the effect could not be instantiated
10815    </p>
10816    </blockquote>
10817                                
10818    
10819    </blockquote><p>
10820                        
10821    </p>
10822    <p>Examples:
10823    </p>
10824    <p>
10825                            </p>
10826    <blockquote class="text">
10827    <p>C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/mod_delay_1419.so' 'modDelay'"
10828    </p>
10829    <p>S: "OK[0]"
10830    </p>
10831    </blockquote><p>
10832                        
10833    </p>
10834    <a name="CREATE EFFECT_INSTANCE (non-portable)"></a><br /><hr />
10835    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10836    <a name="rfc.section.6.11.5"></a><h3>6.11.5.&nbsp;
10837    Creating an instance of an effect by its numerical ID</h3>
10838    
10839    <p>The front-end can spawn an instance of the desired
10840                        effect by sending the following command:
10841    </p>
10842    <p>
10843                            </p>
10844    <blockquote class="text">
10845    <p>CREATE EFFECT_INSTANCE &lt;effect-index&gt;
10846    </p>
10847    </blockquote><p>
10848                        
10849    </p>
10850    <p>Where &lt;effect-index&gt; is the numerical ID of the
10851                        effect as returned by the
10852                        <a class='info' href='#LIST AVAILABLE_EFFECTS'>"LIST AVAILABLE_EFFECTS"<span> (</span><span class='info'>Get list of available effects</span><span>)</span></a>
10853                        command.
10854    </p>
10855    <p>The sampler will try to load the requested effect and to
10856                        create an instance of it.
10857    </p>
10858    <p>Note: Since the numerical ID of a certain effect can
10859                        change at any time, you should not use this command in
10860                        LSCP files to restore a certain effect at a later time! To
10861                        store a sampler session including all its effects, use the
10862                        <a class='info' href='#CREATE EFFECT_INSTANCE'>portable text-based
10863                        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
10864                        allows to restore a sampler session with all its effects
10865                        also on other machines, possibly even running a completely
10866                        different operating system (e.g. Linux vs. Windows), with
10867                        different plugin directories or plugin DLL names.
10868    </p>
10869    <p>Possible Answers:
10870    </p>
10871    <p>
10872                            </p>
10873    <blockquote class="text">
10874    <p>"OK[&lt;effect-instance&gt;]" -
10875                                    </p>
10876    <blockquote class="text">
10877    <p>in case the effect instance was
10878                                        successfully created, where
10879                                        &lt;effect-instance&gt; is the numerical ID
10880                                        of the new effect instance
10881    </p>
10882    </blockquote>
10883                                
10884    
10885    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
10886                                    </p>
10887    <blockquote class="text">
10888    <p>in case the effect instance was spawned
10889                                        successfully, but there are noteworthy
10890                                        issue(s) related, providing an appropriate
10891                                        warning code and warning message
10892    </p>
10893    </blockquote>
10894                                
10895    
10896    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
10897                                    </p>
10898    <blockquote class="text">
10899    <p>if the effect could not be instantiated
10900    </p>
10901    </blockquote>
10902                                
10903    
10904    </blockquote><p>
10905                        
10906    </p>
10907    <p>Examples:
10908    </p>
10909    <p>
10910                            </p>
10911    <blockquote class="text">
10912    <p>C: "CREATE EFFECT_INSTANCE 72"
10913    </p>
10914    <p>S: "OK[5]"
10915    </p>
10916    </blockquote><p>
10917                        
10918    </p>
10919    <a name="DESTROY EFFECT_INSTANCE"></a><br /><hr />
10920    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10921    <a name="rfc.section.6.11.6"></a><h3>6.11.6.&nbsp;
10922    Destroy an effect instance</h3>
10923    
10924    <p>The front-end can destroy an unusued effect instance and
10925                        thus freeing it from memory by sending the following command:
10926    </p>
10927    <p>
10928                            </p>
10929    <blockquote class="text">
10930    <p>DESTROY EFFECT_INSTANCE &lt;effect-instance&gt;
10931    </p>
10932    </blockquote><p>
10933                        
10934    </p>
10935    <p>Where &lt;effect-instance&gt; is the numerical ID of the
10936                        effect instance as returned by the
10937                        <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
10938                        <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
10939                        command.
10940    </p>
10941    <p>The effect instance can only be destroyed if it's not
10942                        used in any part of the sampler's audio signal path anymore.
10943                        If the effect instance is still in use somewhere, trying to
10944                        destroy the effect instance will result in an error
10945                        message.
10946    </p>
10947    <p>Possible Answers:
10948    </p>
10949    <p>
10950                            </p>
10951    <blockquote class="text">
10952    <p>"OK" -
10953                                    </p>
10954    <blockquote class="text">
10955    <p>in case the effect instance was successfully destroyed
10956    </p>
10957    </blockquote>
10958                                
10959    
10960    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
10961                                    </p>
10962    <blockquote class="text">
10963    <p>in case it failed, providing an appropriate error code and
10964                                        error message
10965    </p>
10966    </blockquote>
10967                                
10968    
10969    </blockquote><p>
10970                        
10971    </p>
10972    <p>Examples:
10973    </p>
10974    <p>
10975                            </p>
10976    <blockquote class="text">
10977    <p>C: "DESTROY EFFECT_INSTANCE 5"
10978    </p>
10979    <p>S: "OK"
10980    </p>
10981    </blockquote><p>
10982                        
10983    </p>
10984    <a name="GET EFFECT_INSTANCES"></a><br /><hr />
10985    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10986    <a name="rfc.section.6.11.7"></a><h3>6.11.7.&nbsp;
10987    Retrieve amount of effect instances</h3>
10988    
10989    <p>The front-end can retrieve the current amount of effect
10990                        instances by sending the following command:
10991    </p>
10992    <p>
10993                            </p>
10994    <blockquote class="text">
10995    <p>GET EFFECT_INSTANCES
10996    </p>
10997    </blockquote><p>
10998                        
10999    </p>
11000    <p>Possible Answers:
11001    </p>
11002    <p>
11003                            </p>
11004    <blockquote class="text">
11005    <p>The sampler will answer by returning the current
11006                                number of effect instances created and not yet
11007                                destroyed in the current sampler session.
11008    </p>
11009    </blockquote><p>
11010                        
11011    </p>
11012    <p>Examples:
11013    </p>
11014    <p>
11015                            </p>
11016    <blockquote class="text">
11017    <p>C: "GET EFFECT_INSTANCES"
11018    </p>
11019    <p>S: "14"
11020    </p>
11021    </blockquote><p>
11022                        
11023    </p>
11024    <a name="LIST EFFECT_INSTANCES"></a><br /><hr />
11025    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11026    <a name="rfc.section.6.11.8"></a><h3>6.11.8.&nbsp;
11027    Get list of effect instances</h3>
11028    
11029    <p>The front-end can retrieve the current list of effect
11030                        instances by sending the following command:
11031    </p>
11032    <p>
11033                            </p>
11034    <blockquote class="text">
11035    <p>LIST EFFECT_INSTANCES
11036    </p>
11037    </blockquote><p>
11038                        
11039    </p>
11040    <p>Possible Answers:
11041    </p>
11042    <p>
11043                            </p>
11044    <blockquote class="text">
11045    <p>The sampler will answer by returning a comma
11046                                separated list with numerical IDs of effects
11047                                instances.
11048                                
11049    </p>
11050    </blockquote><p>
11051                        
11052    </p>
11053    <p>Example:
11054    </p>
11055    <p>
11056                            </p>
11057    <blockquote class="text">
11058    <p>C: "LIST EFFECT_INSTANCES"
11059    </p>
11060    <p>S: "9,11,14,15,16,17,25"
11061    </p>
11062    </blockquote><p>
11063                        
11064    </p>
11065    <a name="GET EFFECT_INSTANCE INFO"></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.9"></a><h3>6.11.9.&nbsp;
11068    Retrieving current information about an effect instance</h3>
11069    
11070    <p>The front-end can ask for the current informations about
11071                        a particular effect instance by sending the following command:
11072    </p>
11073    <p>
11074                            </p>
11075    <blockquote class="text">
11076    <p>GET EFFECT_INSTANCE INFO &lt;effect-instance&gt;
11077    </p>
11078    </blockquote><p>
11079                        
11080    </p>
11081    <p>Where &lt;effect-instance&gt; is the numerical ID of an
11082                        effect instance as returned by the
11083                        <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>
11084                        or
11085                        <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
11086                        command.
11087    </p>
11088    <p>Possible Answers:
11089    </p>
11090    <p>
11091                            </p>
11092    <blockquote class="text">
11093    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
11094                                Each answer line begins with the information
11095                                category name, followed by a colon and then a space
11096                                character &lt;SP&gt; and finally the info character
11097                                string to that information category. At the
11098                                moment the following categories are defined:
11099    </p>
11100    <p>
11101                                    </p>
11102    <blockquote class="text">
11103    <p>SYSTEM -
11104                                            </p>
11105    <blockquote class="text">
11106    <p>name of the effect plugin system
11107                                                the effect is based on
11108                                                (e.g. "LADSPA")
11109    </p>
11110    </blockquote>
11111                                        
11112    
11113    <p>MODULE -
11114                                            </p>
11115    <blockquote class="text">
11116    <p>module of the effect plugin
11117                                                system that contains this effect,
11118                                                the module is usually the
11119                                                dynamic-linked library (DLL)
11120                                                filename of the effect plugin,
11121                                                including full path (note that this
11122                                                filename may contain
11123                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
11124    </p>
11125    </blockquote>
11126                                        
11127    
11128    <p>NAME -
11129                                            </p>
11130    <blockquote class="text">
11131    <p>character string defining the
11132                                                unique name of the effect within its
11133                                                module (note that the character
11134                                                string may contain
11135                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
11136    </p>
11137    </blockquote>
11138                                        
11139    
11140    <p>DESCRIPTION -
11141                                            </p>
11142    <blockquote class="text">
11143    <p>human readable name of the
11144                                                effect, intended to be displayed in
11145                                                user interfaces (note that the
11146                                                character string may contain
11147                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
11148    </p>
11149    </blockquote>
11150                                        
11151    
11152    <p>INPUT_CONTROLS -
11153                                            </p>
11154    <blockquote class="text">
11155    <p>amount of input controls the
11156                                                effect instance provides, to allow
11157                                                controlling the effect parameters in
11158                                                realtime
11159    </p>
11160    </blockquote>
11161                                        
11162    
11163    </blockquote>
11164                                
11165    
11166    </blockquote><p>
11167                        
11168    </p>
11169    <p>The mentioned fields above don't have to be in particular order.
11170    </p>
11171    <p>Example:
11172    </p>
11173    <p>
11174                            </p>
11175    <blockquote class="text">
11176    <p>C: "GET EFFECT_INSTANCE INFO 3"
11177    </p>
11178    <p>S: "SYSTEM: LADSPA"
11179    </p>
11180    <p>&nbsp;&nbsp;&nbsp;"MODULE: /usr/lib/ladspa/mod_delay_1419.so"
11181    </p>
11182    <p>&nbsp;&nbsp;&nbsp;"NAME: modDelay"
11183    </p>
11184    <p>&nbsp;&nbsp;&nbsp;"DESCRIPTION: Modulatable delay"
11185    </p>
11186    <p>&nbsp;&nbsp;&nbsp;"INPUT_CONTROLS: 1"
11187    </p>
11188    <p>&nbsp;&nbsp;&nbsp;"."
11189    </p>
11190    </blockquote><p>
11191                        
11192    </p>
11193    <a name="GET EFFECT_INSTANCE_INPUT_CONTROL INFO"></a><br /><hr />
11194    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11195    <a name="rfc.section.6.11.10"></a><h3>6.11.10.&nbsp;
11196    Retrieving information about an effect parameter</h3>
11197    
11198    <p>Effects typically provide a certain set of effect
11199                        parameters which can be altered by the user in realtime
11200                        (e.g. depth of a reverb effect, duration of a delay effect,
11201                        dry / wet signal ratio). Those controllable effect parameters
11202                        are called "input controls". The front-end can ask for the
11203                        current informations of an effect instance's input control
11204                        by sending the following command:
11205    </p>
11206    <p>
11207                            </p>
11208    <blockquote class="text">
11209    <p>GET EFFECT_INSTANCE_INPUT_CONTROL INFO &lt;effect-instance&gt; &lt;input-control&gt;
11210    </p>
11211    </blockquote><p>
11212                        
11213    </p>
11214    <p>Where &lt;effect-instance&gt; is the numerical ID of an
11215                        effect instance as returned by the
11216                        <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>
11217                        or
11218                        <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
11219                        command and &lt;input-control&gt; is the index of the input
11220                        control within the numerical bounds as returned by the
11221                        "INPUT_CONTROLS" field of the
11222                        <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>
11223                        command.
11224    </p>
11225    <p>Possible Answers:
11226    </p>
11227    <p>
11228                            </p>
11229    <blockquote class="text">
11230    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
11231                                Each answer line begins with the information
11232                                category name, followed by a colon and then a space
11233                                character &lt;SP&gt; and finally the info character
11234                                string to that information category. There are
11235                                information categories which are always returned,
11236                                independent of the respective effect parameter and
11237                                there are optional information categories
11238                                which are only shown for certain effect parameters.
11239                                At the moment the following categories are defined:
11240    </p>
11241    <p>
11242                                    </p>
11243    <blockquote class="text">
11244    <p>DESCRIPTION -
11245                                            </p>
11246    <blockquote class="text">
11247    <p>(always returned)
11248                                                human readable name of the
11249                                                effect parameter, intended to be
11250                                                displayed in user interfaces (note
11251                                                that the character string may
11252                                                contain <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
11253    </p>
11254    </blockquote>
11255                                        
11256    
11257    <p>VALUE -
11258                                            </p>
11259    <blockquote class="text">
11260    <p>
11261                                                (always returned)
11262                                                current (optional dotted)
11263                                                floating point value of this effect
11264                                                parameter
11265    </p>
11266    </blockquote>
11267                                        
11268    
11269    <p>RANGE_MIN -
11270                                            </p>
11271    <blockquote class="text">
11272    <p>
11273                                                (optionally returned)
11274                                                minimum allowed value for this
11275                                                effect parameter
11276    </p>
11277    </blockquote>
11278                                        
11279    
11280    <p>RANGE_MAX -
11281                                            </p>
11282    <blockquote class="text">
11283    <p>
11284                                                (optionally returned)
11285                                                maximum allowed value for this
11286                                                effect parameter
11287    </p>
11288    </blockquote>
11289                                        
11290    
11291    <p>POSSIBILITIES -
11292                                            </p>
11293    <blockquote class="text">
11294    <p>
11295                                                (optionally returned)
11296                                                comma separated list of
11297                                                (optional dotted) floating point
11298                                                numbers, reflecting the exact set of
11299                                                possible values for this effect
11300                                                parameter
11301    </p>
11302    </blockquote>
11303                                        
11304    
11305    <p>DEFAULT -
11306                                            </p>
11307    <blockquote class="text">
11308    <p>
11309                                                (optionally returned)
11310                                                default value of this effect
11311                                                parameter
11312    </p>
11313    </blockquote>
11314                                        
11315    
11316    </blockquote>
11317                                
11318    
11319    </blockquote><p>
11320                        
11321    </p>
11322    <p>The mentioned fields above don't have to be in particular order.
11323    </p>
11324    <p>Example:
11325    </p>
11326    <p>
11327                            </p>
11328    <blockquote class="text">
11329    <p>C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0"
11330    </p>
11331    <p>S: "DESCRIPTION: Base delay (s)"
11332    </p>
11333    <p>&nbsp;&nbsp;&nbsp;"VALUE: 0.500"
11334    </p>
11335    <p>&nbsp;&nbsp;&nbsp;"RANGE_MIN: 0.000"
11336    </p>
11337    <p>&nbsp;&nbsp;&nbsp;"."
11338    </p>
11339    </blockquote><p>
11340                        
11341    </p>
11342    <a name="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE"></a><br /><hr />
11343    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11344    <a name="rfc.section.6.11.11"></a><h3>6.11.11.&nbsp;
11345    Altering an effect parameter</h3>
11346    
11347    <p>The front-end can alter the current value of an effect
11348                        parameter by sending the following command:
11349    </p>
11350    <p>
11351                            </p>
11352    <blockquote class="text">
11353    <p>SET EFFECT_INSTANCE_INPUT_CONTROL VALUE &lt;effect-instance&gt; &lt;input-control&gt; &lt;value&gt;
11354    </p>
11355    </blockquote><p>
11356                        
11357    </p>
11358    <p>Where &lt;effect-instance&gt; is the numerical ID of the
11359                        effect instance as returned by the
11360                        <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
11361                        <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
11362                        command, &lt;input-control&gt; is the index of the input
11363                        control within the numerical bounds as returned by the
11364                        "INPUT_CONTROLS" field of the
11365                        <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>
11366                        command and &lt;value&gt; is the new (optional dotted)
11367                        floating point value for this effect parameter.
11368    </p>
11369    <p>Possible Answers:
11370    </p>
11371    <p>
11372                            </p>
11373    <blockquote class="text">
11374    <p>"OK" -
11375                                    </p>
11376    <blockquote class="text">
11377    <p>in case the effect was altered successfully
11378    </p>
11379    </blockquote>
11380                                
11381    
11382    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
11383                                    </p>
11384    <blockquote class="text">
11385    <p>in case it failed, providing an appropriate error code and
11386                                        error message
11387    </p>
11388    </blockquote>
11389                                
11390    
11391    </blockquote><p>
11392                        
11393    </p>
11394    <p>Examples:
11395    </p>
11396    <p>
11397                            </p>
11398    <blockquote class="text">
11399    <p>C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5"
11400    </p>
11401    <p>S: "OK"
11402    </p>
11403    </blockquote><p>
11404                        
11405    </p>
11406    <a name="GET SEND_EFFECT_CHAINS"></a><br /><hr />
11407    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11408    <a name="rfc.section.6.11.12"></a><h3>6.11.12.&nbsp;
11409    Retrieve amount of send effect chains</h3>
11410    
11411    <p>The front-end can retrieve the current amount of send
11412                        effect chains of an audio output device by sending the
11413                        following command:
11414    </p>
11415    <p>
11416                            </p>
11417    <blockquote class="text">
11418    <p>GET SEND_EFFECT_CHAINS &lt;audio-device&gt;
11419    </p>
11420    </blockquote><p>
11421                        
11422    </p>
11423    <p>Where &lt;audio-device&gt; should be replaced by the
11424                        numerical ID of the audio output device as given by the
11425                        <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>
11426                        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>
11427                        command.
11428    </p>
11429    <p>Possible Answers:
11430    </p>
11431    <p>
11432                            </p>
11433    <blockquote class="text">
11434    <p>The sampler will answer by returning the current
11435                                number of send effect chains of the supplied audio
11436                                output device.
11437    </p>
11438    </blockquote><p>
11439                        
11440    </p>
11441    <p>Examples:
11442    </p>
11443    <p>
11444                            </p>
11445    <blockquote class="text">
11446    <p>C: "GET SEND_EFFECT_CHAINS 0"
11447    </p>
11448    <p>S: "4"
11449    </p>
11450    </blockquote><p>
11451                        
11452    </p>
11453    <a name="LIST SEND_EFFECT_CHAINS"></a><br /><hr />
11454    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11455    <a name="rfc.section.6.11.13"></a><h3>6.11.13.&nbsp;
11456    Retrieve list of send effect chains</h3>
11457    
11458    <p>The front-end can retrieve the current list of send
11459                        effect chains of an audio output device by sending the
11460                        following command:
11461    </p>
11462    <p>
11463                            </p>
11464    <blockquote class="text">
11465    <p>LIST SEND_EFFECT_CHAINS &lt;audio-device&gt;
11466    </p>
11467    </blockquote><p>
11468                        
11469    </p>
11470    <p>Where &lt;audio-device&gt; should be replaced by the
11471                        numerical ID of the audio output device as given by the
11472                        <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>
11473                        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>
11474                        command.
11475    </p>
11476    <p>Possible Answers:
11477    </p>
11478    <p>
11479                            </p>
11480    <blockquote class="text">
11481    <p>The sampler will answer by returning a comma
11482                                separated list with numerical IDs of send effect
11483                                chains of the supplied audio output device.
11484                                
11485    </p>
11486    </blockquote><p>
11487                        
11488    </p>
11489    <p>Examples:
11490    </p>
11491    <p>
11492                            </p>
11493    <blockquote class="text">
11494    <p>C: "LIST SEND_EFFECT_CHAINS 0"
11495    </p>
11496    <p>S: "3,4,7"
11497    </p>
11498    </blockquote><p>
11499                        
11500    </p>
11501    <a name="ADD SEND_EFFECT_CHAIN"></a><br /><hr />
11502    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11503    <a name="rfc.section.6.11.14"></a><h3>6.11.14.&nbsp;
11504    Add send effect chain</h3>
11505    
11506    <p>The front-end can add a send effect chain by sending the
11507                        following command:
11508    </p>
11509    <p>
11510                            </p>
11511    <blockquote class="text">
11512    <p>ADD SEND_EFFECT_CHAIN &lt;audio-device&gt;
11513    </p>
11514    </blockquote><p>
11515                        
11516    </p>
11517    <p>Where &lt;audio-device&gt; should be replaced by the
11518                        numerical ID of the audio output device as given by the
11519                        <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>
11520                        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>
11521                        command.
11522    </p>
11523    <p>Possible Answers:
11524    </p>
11525    <p>
11526                            </p>
11527    <blockquote class="text">
11528    <p>"OK[&lt;effect-chain&gt;]" -
11529                                    </p>
11530    <blockquote class="text">
11531    <p>in case the send effect chain was
11532                                        added successfully, where
11533                                        &lt;effect-chain&gt; is the numerical ID
11534                                        of the new send effect chain
11535    </p>
11536    </blockquote>
11537                                
11538    
11539    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
11540                                    </p>
11541    <blockquote class="text">
11542    <p>if the send effect chain could not be added
11543    </p>
11544    </blockquote>
11545                                
11546    
11547    </blockquote><p>
11548                        
11549    </p>
11550    <p>Examples:
11551    </p>
11552    <p>
11553                            </p>
11554    <blockquote class="text">
11555    <p>C: "ADD SEND_EFFECT_CHAIN 0"
11556    </p>
11557    <p>S: "OK[2]"
11558    </p>
11559    </blockquote><p>
11560                        
11561    </p>
11562    <a name="REMOVE SEND_EFFECT_CHAIN"></a><br /><hr />
11563    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11564    <a name="rfc.section.6.11.15"></a><h3>6.11.15.&nbsp;
11565    Remove send effect chain</h3>
11566    
11567    <p>The front-end can remove a send effect chain by sending
11568                        the following command:
11569    </p>
11570    <p>
11571                            </p>
11572    <blockquote class="text">
11573    <p>REMOVE SEND_EFFECT_CHAIN &lt;audio-device&gt; &lt;effect-chain&gt;
11574    </p>
11575    </blockquote><p>
11576                        
11577    </p>
11578    <p>Where &lt;audio-device&gt; should be replaced by the
11579                        numerical ID of the audio output device as given by the
11580                        <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>
11581                        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>
11582                        command and &lt;effect-chain&gt; by the numerical ID as
11583                        returned by the
11584                        <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>
11585                        or
11586                        <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>
11587                        command.
11588    </p>
11589    <p>Possible Answers:
11590    </p>
11591    <p>
11592                            </p>
11593    <blockquote class="text">
11594    <p>"OK" -
11595                                    </p>
11596    <blockquote class="text">
11597    <p>in case the send effect chain was
11598                                        removed successfully
11599    </p>
11600    </blockquote>
11601                                
11602    
11603    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
11604                                    </p>
11605    <blockquote class="text">
11606    <p>if the send effect chain could not be removed
11607    </p>
11608    </blockquote>
11609                                
11610    
11611    </blockquote><p>
11612                        
11613    </p>
11614    <p>Examples:
11615    </p>
11616    <p>
11617                            </p>
11618    <blockquote class="text">
11619    <p>C: "REMOVE SEND_EFFECT_CHAIN 0 2"
11620    </p>
11621    <p>S: "OK"
11622    </p>
11623    </blockquote><p>
11624                        
11625    </p>
11626    <a name="GET SEND_EFFECT_CHAIN INFO"></a><br /><hr />
11627    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11628    <a name="rfc.section.6.11.16"></a><h3>6.11.16.&nbsp;
11629    Retrieving information about a send effect chain</h3>
11630    
11631    <p>The front-end can ask for informations of a send effect
11632                        chain by sending the following command:
11633    </p>
11634    <p>
11635                            </p>
11636    <blockquote class="text">
11637    <p>GET SEND_EFFECT_CHAIN INFO &lt;audio-device&gt; &lt;effect-chain&gt;
11638    </p>
11639    </blockquote><p>
11640                        
11641    </p>
11642    <p>Where &lt;audio-device&gt; should be replaced by the
11643                        numerical ID of the audio output device as given by the
11644                        <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>
11645                        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>
11646                        command and &lt;effect-chain&gt; by the numerical ID as
11647                        returned by the
11648                        <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>
11649                        or
11650                        <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>
11651                        command.
11652    </p>
11653    <p>Possible Answers:
11654    </p>
11655    <p>
11656                            </p>
11657    <blockquote class="text">
11658    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
11659                                Each answer line begins with the information
11660                                category name, followed by a colon and then a space
11661                                character &lt;SP&gt; and finally the info character
11662                                string to that information category.
11663                                At the moment the following categories are defined:
11664    </p>
11665    <p>
11666                                    </p>
11667    <blockquote class="text">
11668    <p>EFFECT_COUNT -
11669                                            </p>
11670    <blockquote class="text">
11671    <p>amount of effects in this send
11672                                                effect chain
11673    </p>
11674    </blockquote>
11675                                        
11676    
11677    <p>EFFECT_SEQUENCE -
11678                                            </p>
11679    <blockquote class="text">
11680    <p>comma separated list of the
11681                                                numerical IDs of the effect
11682                                                instances in this send effect chain,
11683                                                in the order as they are procssed in
11684                                                the effect chain
11685    </p>
11686    </blockquote>
11687                                        
11688    
11689    </blockquote>
11690                                
11691    
11692    </blockquote><p>
11693                        
11694    </p>
11695    <p>The mentioned fields above don't have to be in particular order.
11696    </p>
11697    <p>Example:
11698    </p>
11699    <p>
11700                            </p>
11701    <blockquote class="text">
11702    <p>C: "GET SEND_EFFECT_CHAIN INFO 0 2"
11703    </p>
11704    <p>S: "EFFECT_COUNT: 3"
11705    </p>
11706    <p>&nbsp;&nbsp;&nbsp;"EFFECT_SEQUENCE: 31,4,7"
11707    </p>
11708    <p>&nbsp;&nbsp;&nbsp;"."
11709    </p>
11710    </blockquote><p>
11711                        
11712    </p>
11713    <a name="APPEND SEND_EFFECT_CHAIN EFFECT"></a><br /><hr />
11714    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11715    <a name="rfc.section.6.11.17"></a><h3>6.11.17.&nbsp;
11716    Append effect instance to a send effect chain</h3>
11717    
11718    <p>The front-end can add an unused effect instance to the
11719                        end of a send effect chain by sending the following command:
11720    </p>
11721    <p>
11722                            </p>
11723    <blockquote class="text">
11724    <p>APPEND SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;effect-instance&gt;
11725    </p>
11726    </blockquote><p>
11727                        
11728    </p>
11729    <p>Where &lt;audio-device&gt; should be replaced by the
11730                        numerical ID of the audio output device as given by the
11731                        <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>
11732                        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>
11733                        command and &lt;effect-chain&gt; by the numerical ID as
11734                        returned by the
11735                        <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>
11736                        or
11737                        <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>
11738                        command and &lt;effect-instance&gt; as returned by the
11739                        <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
11740                        <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
11741                        command.
11742    </p>
11743    <p>Only unused effect instances can be added to the effect
11744                        chain. Trying to add an effect instance which is already in
11745                        use somewhere in the audio signal path of the sampler will
11746                        result in an error.
11747    </p>
11748    <p>Possible Answers:
11749    </p>
11750    <p>
11751                            </p>
11752    <blockquote class="text">
11753    <p>"OK" -
11754                                    </p>
11755    <blockquote class="text">
11756    <p>in case the effect instance was
11757                                        added successfully to the chain
11758    </p>
11759    </blockquote>
11760                                
11761    
11762    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
11763                                    </p>
11764    <blockquote class="text">
11765    <p>if the effect instance could not be added
11766    </p>
11767    </blockquote>
11768                                
11769    
11770    </blockquote><p>
11771                        
11772    </p>
11773    <p>Examples:
11774    </p>
11775    <p>
11776                            </p>
11777    <blockquote class="text">
11778    <p>C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38"
11779    </p>
11780    <p>S: "OK"
11781    </p>
11782    </blockquote><p>
11783                        
11784    </p>
11785    <a name="INSERT SEND_EFFECT_CHAIN EFFECT"></a><br /><hr />
11786    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11787    <a name="rfc.section.6.11.18"></a><h3>6.11.18.&nbsp;
11788    Insert effect instance to a send effect chain</h3>
11789    
11790    <p>The front-end can add an unused effect instance to a
11791                        certain position of a send effect chain by sending the
11792                        following command:
11793    </p>
11794    <p>
11795                            </p>
11796    <blockquote class="text">
11797    <p>INSERT SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;chain-pos&gt; &lt;effect-instance&gt;
11798    </p>
11799    </blockquote><p>
11800                        
11801    </p>
11802    <p>Where &lt;audio-device&gt; should be replaced by the
11803                        numerical ID of the audio output device as given by the
11804                        <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>
11805                        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>
11806                        command, &lt;effect-chain&gt; by the numerical ID as
11807                        returned by the
11808                        <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>
11809                        or
11810                        <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>
11811                        command, &lt;effect-instance&gt; as returned by the
11812                        <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
11813                        <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
11814                        command and &lt;chain-pos&gt; the exact position of the
11815                        effect chain where the supplied effect shall be inserted
11816                        to.
11817    </p>
11818    <p>Only unused effect instances can be added to the effect
11819                        chain. Trying to add an effect instance which is already in
11820                        use somewhere in the audio signal path of the sampler will
11821                        result in an error.
11822    </p>
11823    <p>Possible Answers:
11824    </p>
11825    <p>
11826                            </p>
11827    <blockquote class="text">
11828    <p>"OK" -
11829                                    </p>
11830    <blockquote class="text">
11831    <p>in case the effect instance was
11832                                        added successfully to the chain
11833    </p>
11834    </blockquote>
11835                                
11836    
11837    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
11838                                    </p>
11839    <blockquote class="text">
11840    <p>if the effect instance could not be added
11841    </p>
11842    </blockquote>
11843                                
11844    
11845    </blockquote><p>
11846                        
11847    </p>
11848    <p>Examples:
11849    </p>
11850    <p>
11851                            </p>
11852    <blockquote class="text">
11853    <p>C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38"
11854    </p>
11855    <p>S: "OK"
11856    </p>
11857    </blockquote><p>
11858                        
11859    </p>
11860    <a name="REMOVE SEND_EFFECT_CHAIN EFFECT"></a><br /><hr />
11861    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11862    <a name="rfc.section.6.11.19"></a><h3>6.11.19.&nbsp;
11863    Remove effect instance from send effect chain</h3>
11864    
11865    <p>The front-end can remove an effect instance from a
11866                        certain position of a send effect chain by sending the
11867                        following command:
11868    </p>
11869    <p>
11870                            </p>
11871    <blockquote class="text">
11872    <p>REMOVE SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;chain-pos&gt;
11873    </p>
11874    </blockquote><p>
11875                        
11876    </p>
11877    <p>Where &lt;audio-device&gt; should be replaced by the
11878                        numerical ID of the audio output device as given by the
11879                        <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>
11880                        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>
11881                        command, &lt;effect-chain&gt; by the numerical ID as
11882                        returned by the
11883                        <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>
11884                        or
11885                        <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>
11886                        command and &lt;chain-pos&gt; the exact position of the
11887                        effect instance to be removed from the effect chain.
11888    </p>
11889    <p>Possible Answers:
11890    </p>
11891    <p>
11892                            </p>
11893    <blockquote class="text">
11894    <p>"OK" -
11895                                    </p>
11896    <blockquote class="text">
11897    <p>in case the effect instance was
11898                                        removed successfully
11899    </p>
11900    </blockquote>
11901                                
11902    
11903    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
11904                                    </p>
11905    <blockquote class="text">
11906    <p>if the effect instance could not be removed
11907    </p>
11908    </blockquote>
11909                                
11910    
11911    </blockquote><p>
11912                        
11913    </p>
11914    <p>Examples:
11915    </p>
11916    <p>
11917                            </p>
11918    <blockquote class="text">
11919    <p>C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4"
11920    </p>
11921    <p>S: "OK"
11922    </p>
11923    </blockquote><p>
11924                        
11925    </p>
11926  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
11927  <table 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>
11928  <a name="rfc.section.7"></a><h3>7.&nbsp;  <a name="rfc.section.7"></a><h3>7.&nbsp;
# Line 9791  Command Syntax</h3> Line 12042  Command Syntax</h3>
12042                                    
12043  </p>  </p>
12044  <p>/ FORMAT SP format_instruction  <p>/ FORMAT SP format_instruction
12045                                    
12046    </p>
12047    <p>/ SEND SP send_instruction
12048                    
12049    </p>
12050    <p>/ APPEND SP append_instruction
12051                    
12052  </p>  </p>
12053  <p>SEND SP send_instruction  <p>/ INSERT SP insert_instruction
12054                                    
12055  </p>  </p>
12056  <p>/ RESET  <p>/ RESET
# Line 9811  Command Syntax</h3> Line 12068  Command Syntax</h3>
12068  <p>CHANNEL  <p>CHANNEL
12069                                    
12070  </p>  </p>
12071    <p>/ CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index
12072                    
12073    </p>
12074    <p>/ CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index
12075                    
12076    </p>
12077  <p>/ DB_INSTRUMENT_DIRECTORY SP db_path  <p>/ DB_INSTRUMENT_DIRECTORY SP db_path
12078                                    
12079  </p>  </p>
12080  <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
12081                                    
12082  </p>  </p>
12083    <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename
12084                    
12085    </p>
12086  <p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename  <p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
12087                                    
12088  </p>  </p>
12089    <p>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename
12090                    
12091    </p>
12092  <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename  <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
12093                                    
12094  </p>  </p>
# Line 9838  Command Syntax</h3> Line 12107  Command Syntax</h3>
12107  <p>/ MIDI_INSTRUMENT_MAP SP map_name  <p>/ MIDI_INSTRUMENT_MAP SP map_name
12108                                    
12109  </p>  </p>
12110    <p>/ SEND_EFFECT_CHAIN SP device_index
12111                    
12112    </p>
12113  </blockquote><p>  </blockquote><p>
12114    
12115  </p>  </p>
# Line 9922  Command Syntax</h3> Line 12194  Command Syntax</h3>
12194  <p>/ GLOBAL_INFO  <p>/ GLOBAL_INFO
12195                                    
12196  </p>  </p>
12197    <p>/ EFFECT_INSTANCE_COUNT
12198                    
12199    </p>
12200    <p>/ EFFECT_INSTANCE_INFO
12201                    
12202    </p>
12203    <p>/ SEND_EFFECT_CHAIN_COUNT
12204                    
12205    </p>
12206    <p>/ SEND_EFFECT_CHAIN_INFO
12207                    
12208    </p>
12209  </blockquote><p>  </blockquote><p>
12210    
12211  </p>  </p>
# Line 10006  Command Syntax</h3> Line 12290  Command Syntax</h3>
12290  <p>/ GLOBAL_INFO  <p>/ GLOBAL_INFO
12291                                    
12292  </p>  </p>
12293    <p>/ EFFECT_INSTANCE_COUNT
12294                    
12295    </p>
12296    <p>/ EFFECT_INSTANCE_INFO
12297                    
12298    </p>
12299    <p>/ SEND_EFFECT_CHAIN_COUNT
12300                    
12301    </p>
12302    <p>/ SEND_EFFECT_CHAIN_INFO
12303                    
12304    </p>
12305  </blockquote><p>  </blockquote><p>
12306    
12307  </p>  </p>
# Line 10042  Command Syntax</h3> Line 12338  Command Syntax</h3>
12338  <p>CHANNEL SP sampler_channel  <p>CHANNEL SP sampler_channel
12339                                    
12340  </p>  </p>
12341    <p>/ CHANNEL SP MIDI_INPUT SP sampler_channel
12342                    
12343    </p>
12344    <p>/ CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index
12345                    
12346    </p>
12347    <p>/ CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index
12348                    
12349    </p>
12350  <p>/ MIDI_INSTRUMENT_MAP SP midi_map  <p>/ MIDI_INSTRUMENT_MAP SP midi_map
12351                                    
12352  </p>  </p>
12353  <p>/ MIDI_INSTRUMENT_MAP SP ALL  <p>/ MIDI_INSTRUMENT_MAP SP ALL
12354                                    
12355  </p>  </p>
12356    <p>/ SEND_EFFECT_CHAIN SP device_index SP effect_chain
12357                    
12358    </p>
12359    <p>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos
12360                    
12361    </p>
12362    <p>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id
12363                    
12364    </p>
12365  <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path  <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
12366                                    
12367  </p>  </p>
# Line 10066  Command Syntax</h3> Line 12380  Command Syntax</h3>
12380  <p>AVAILABLE_ENGINES  <p>AVAILABLE_ENGINES
12381                                    
12382  </p>  </p>
12383    <p>/ AVAILABLE_EFFECTS
12384                    
12385    </p>
12386    <p>/ EFFECT_INSTANCES
12387                    
12388    </p>
12389    <p>/ EFFECT SP INFO SP effect_index
12390                    
12391    </p>
12392    <p>/ EFFECT_INSTANCE SP INFO SP effect_instance
12393                    
12394    </p>
12395    <p>/ EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP input_control
12396                    
12397    </p>
12398    <p>/ SEND_EFFECT_CHAINS SP device_index
12399                    
12400    </p>
12401    <p>/ SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain
12402                    
12403    </p>
12404  <p>/ AVAILABLE_MIDI_INPUT_DRIVERS  <p>/ AVAILABLE_MIDI_INPUT_DRIVERS
12405                                    
12406  </p>  </p>
# Line 10189  Command Syntax</h3> Line 12524  Command Syntax</h3>
12524  <p>/ VOLUME  <p>/ VOLUME
12525                                    
12526  </p>  </p>
12527    <p>/ VOICES
12528                    
12529    </p>
12530    <p>/ STREAMS
12531                    
12532    </p>
12533  <p>/ FILE SP INSTRUMENTS SP filename  <p>/ FILE SP INSTRUMENTS SP filename
12534                                    
12535  </p>  </p>
# Line 10216  Command Syntax</h3> Line 12557  Command Syntax</h3>
12557  <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
12558                                    
12559  </p>  </p>
12560    <p>/ EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP input_control SP control_value
12561                    
12562    </p>
12563  <p>/ CHANNEL SP set_chan_instruction  <p>/ CHANNEL SP set_chan_instruction
12564                                    
12565  </p>  </p>
# Line 10234  Command Syntax</h3> Line 12578  Command Syntax</h3>
12578  <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
12579                                    
12580  </p>  </p>
12581    <p>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos
12582                    
12583    </p>
12584  <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped  <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
12585                                    
12586  </p>  </p>
# Line 10255  Command Syntax</h3> Line 12602  Command Syntax</h3>
12602  <p>/ VOLUME SP volume_value  <p>/ VOLUME SP volume_value
12603                                    
12604  </p>  </p>
12605    <p>/ VOICES SP number
12606                    
12607    </p>
12608    <p>/ STREAMS SP number
12609                    
12610    </p>
12611  </blockquote><p>  </blockquote><p>
12612    
12613  </p>  </p>
# Line 10279  Command Syntax</h3> Line 12632  Command Syntax</h3>
12632  <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
12633                                    
12634  </p>  </p>
12635    <p>/ EFFECT_INSTANCE SP effect_index
12636                    
12637    </p>
12638    <p>/ EFFECT_INSTANCE SP effect_system SP module SP effect_name
12639                    
12640    </p>
12641  </blockquote><p>  </blockquote><p>
12642    
12643  </p>  </p>
# Line 10360  Command Syntax</h3> Line 12719  Command Syntax</h3>
12719  <p>/ FX_SEND SP sampler_channel SP fx_send_id  <p>/ FX_SEND SP sampler_channel SP fx_send_id
12720                                    
12721  </p>  </p>
12722    <p>/ EFFECT_INSTANCE SP number
12723                    
12724    </p>
12725  </blockquote><p>  </blockquote><p>
12726    
12727  </p>  </p>
# Line 10375  Command Syntax</h3> Line 12737  Command Syntax</h3>
12737  </blockquote><p>  </blockquote><p>
12738    
12739  </p>  </p>
12740    <p>append_instruction =
12741            </p>
12742    <blockquote class="text">
12743    <p>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP effect_instance
12744                    
12745    </p>
12746    </blockquote><p>
12747    
12748    </p>
12749    <p>insert_instruction =
12750            </p>
12751    <blockquote class="text">
12752    <p>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos SP effect_instance
12753                    
12754    </p>
12755    </blockquote><p>
12756    
12757    </p>
12758  <p>set_chan_instruction =  <p>set_chan_instruction =
12759          </p>          </p>
12760  <blockquote class="text">  <blockquote class="text">
# Line 10489  Command Syntax</h3> Line 12869  Command Syntax</h3>
12869  <p>/ CHANNELS  <p>/ CHANNELS
12870                                    
12871  </p>  </p>
12872    <p>/ CHANNEL SP MIDI_INPUTS SP sampler_channel
12873                    
12874    </p>
12875  <p>/ AVAILABLE_ENGINES  <p>/ AVAILABLE_ENGINES
12876                                    
12877  </p>  </p>
12878    <p>/ AVAILABLE_EFFECTS
12879                    
12880    </p>
12881    <p>/ EFFECT_INSTANCES
12882                    
12883    </p>
12884    <p>/ SEND_EFFECT_CHAINS SP number
12885                    
12886    </p>
12887  <p>/ AVAILABLE_MIDI_INPUT_DRIVERS  <p>/ AVAILABLE_MIDI_INPUT_DRIVERS
12888                                    
12889  </p>  </p>
# Line 10573  Command Syntax</h3> Line 12965  Command Syntax</h3>
12965  </blockquote><p>  </blockquote><p>
12966    
12967  </p>  </p>
12968    <p>effect_instance =
12969            </p>
12970    <blockquote class="text">
12971    <p>number
12972                    
12973    </p>
12974    </blockquote><p>
12975    
12976    </p>
12977  <p>device_index =  <p>device_index =
12978          </p>          </p>
12979  <blockquote class="text">  <blockquote class="text">
# Line 10678  Command Syntax</h3> Line 13079  Command Syntax</h3>
13079  </blockquote><p>  </blockquote><p>
13080    
13081  </p>  </p>
13082    <p>control_value =
13083            </p>
13084    <blockquote class="text">
13085    <p>real
13086                    
13087    </p>
13088    </blockquote><p>
13089    
13090    </p>
13091  <p>sampler_channel =  <p>sampler_channel =
13092          </p>          </p>
13093  <blockquote class="text">  <blockquote class="text">
# Line 10759  Command Syntax</h3> Line 13169  Command Syntax</h3>
13169  </blockquote><p>  </blockquote><p>
13170    
13171  </p>  </p>
13172    <p>effect_name =
13173            </p>
13174    <blockquote class="text">
13175    <p>stringval_escaped
13176                    
13177    </p>
13178    </blockquote><p>
13179    
13180    </p>
13181    <p>effect_index =
13182            </p>
13183    <blockquote class="text">
13184    <p>number
13185                    
13186    </p>
13187    </blockquote><p>
13188    
13189    </p>
13190    <p>effect_chain =
13191            </p>
13192    <blockquote class="text">
13193    <p>number
13194                    
13195    </p>
13196    </blockquote><p>
13197    
13198    </p>
13199    <p>chain_pos =
13200            </p>
13201    <blockquote class="text">
13202    <p>number
13203                    
13204    </p>
13205    </blockquote><p>
13206    
13207    </p>
13208    <p>input_control =
13209            </p>
13210    <blockquote class="text">
13211    <p>number
13212                    
13213    </p>
13214    </blockquote><p>
13215    
13216    </p>
13217  <p>param_val_list =  <p>param_val_list =
13218          </p>          </p>
13219  <blockquote class="text">  <blockquote class="text">
# Line 10828  Command Syntax</h3> Line 13283  Command Syntax</h3>
13283  </blockquote><p>  </blockquote><p>
13284    
13285  </p>  </p>
13286    <p>effect_system =
13287            </p>
13288    <blockquote class="text">
13289    <p>string
13290                    
13291    </p>
13292    </blockquote><p>
13293    
13294    </p>
13295    <p>module =
13296            </p>
13297    <blockquote class="text">
13298    <p>filename
13299                    
13300    </p>
13301    </blockquote><p>
13302    
13303    </p>
13304  <a name="character_set"></a><br /><hr />  <a name="character_set"></a><br /><hr />
13305  <table 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>
13306  <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 13358  Character Set and Escape Sequences</h3>
13358  <td align="left">two digit hex ASCII code of the character</td>  <td align="left">two digit hex ASCII code of the character</td>
13359  </tr>  </tr>
13360  </table>  </table>
13361    <br clear="all" />
13362    
13363  <p>Notice: due to the transition of certain parts of the  <p>Notice: due to the transition of certain parts of the
13364                  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 13431  Character Set and Escape Sequences</h3>
13431  </p>  </p>
13432  <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>
13433  </p>  </p>
13434    <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>
13435    </p>
13436    <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>
13437    </p>
13438    <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>
13439    </p>
13440  </blockquote><p>  </blockquote><p>
13441                  Note that the forward slash character ('/') has a special meaning in                  Note that the forward slash character ('/') has a special meaning in
13442                  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 13501  Character Set and Escape Sequences</h3>
13501  </p>  </p>
13502  <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>
13503  </p>  </p>
13504    <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>
13505    </p>
13506    <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>
13507    </p>
13508    <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>
13509    </p>
13510  </blockquote><p>  </blockquote><p>
13511                  Please note that these lists are manually maintained. If you                  Please note that these lists are manually maintained. If you
13512                  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 14144  Global settings changed</h3>
14144                          new global volume parameter.                          new global volume parameter.
14145  </p>  </p>
14146  </blockquote><p>  </blockquote><p>
14147                        </p>
14148    <blockquote class="text">
14149    <p>"NOTIFY:GLOBAL_INFO:VOICES &lt;max-voices&gt;" - Notifies that the
14150                            golbal limit of the sampler for maximum voices is changed, where
14151                            &lt;max-voices&gt; will be an integer value, reflecting the
14152                            new global voice limit parameter.
14153    </p>
14154    </blockquote><p>
14155                        </p>
14156    <blockquote class="text">
14157    <p>"NOTIFY:GLOBAL_INFO:STREAMS &lt;max-streams&gt;" - Notifies that the
14158                            golbal limit of the sampler for maximum disk streams is changed, where
14159                            &lt;max-streams&gt; will be an integer value, reflecting the
14160                            new global disk streams limit parameter.
14161    </p>
14162    </blockquote><p>
14163                                    
14164  </p>  </p>
14165  <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 14353  Database job status information changed<
14353                  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
14354                  message is sufficient here.                  message is sufficient here.
14355  </p>  </p>
14356  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />  <a name="SUBSCRIBE EFFECT_INSTANCE_COUNT"></a><br /><hr />
14357  <table 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>
14358  <a name="rfc.section.8.26"></a><h3>8.26.&nbsp;  <a name="rfc.section.8.26"></a><h3>8.26.&nbsp;
14359    Number of effect instances changed</h3>
14360    
14361    <p>Client may want to be notified when the number of effect instances
14362                    is changed by issuing the following command:
14363    </p>
14364    <p>
14365                        </p>
14366    <blockquote class="text">
14367    <p>SUBSCRIBE EFFECT_INSTANCE_COUNT
14368    </p>
14369    </blockquote><p>
14370                    
14371    </p>
14372    <p>Server will start sending the following notification messages:
14373    </p>
14374    <p>
14375                        </p>
14376    <blockquote class="text">
14377    <p>"EFFECT_INSTANCE_COUNT:&lt;instances&gt;"
14378    </p>
14379    </blockquote><p>
14380                    
14381    </p>
14382    <p>where &lt;instances&gt; will be replaced by the new number
14383                    of effect instances.
14384    </p>
14385    <a name="SUBSCRIBE EFFECT_INSTANCE_INFO"></a><br /><hr />
14386    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
14387    <a name="rfc.section.8.27"></a><h3>8.27.&nbsp;
14388    Effect instance information changed</h3>
14389    
14390    <p>Client may want to be notified when changes were made to effect instances
14391                    on the back-end by issuing the following command:
14392    </p>
14393    <p>
14394                        </p>
14395    <blockquote class="text">
14396    <p>SUBSCRIBE EFFECT_INSTANCE_INFO
14397    </p>
14398    </blockquote><p>
14399                    
14400    </p>
14401    <p>Server will start sending the following notification messages:
14402    </p>
14403    <p>
14404                       </p>
14405    <blockquote class="text">
14406    <p>"EFFECT_INSTANCE_INFO:&lt;instance-id&gt;"
14407    </p>
14408    </blockquote><p>
14409                    
14410    </p>
14411    <p>where &lt;instance-id&gt; will be replaced by the numerical ID
14412                    of the effect instance.
14413    </p>
14414    <a name="SUBSCRIBE SEND_EFFECT_CHAIN_COUNT"></a><br /><hr />
14415    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
14416    <a name="rfc.section.8.28"></a><h3>8.28.&nbsp;
14417    Number of send effect chains changed</h3>
14418    
14419    <p>Client may want to be notified when the number of send effect chains
14420                    is changed by issuing the following command:
14421    </p>
14422    <p>
14423                        </p>
14424    <blockquote class="text">
14425    <p>SUBSCRIBE SEND_EFFECT_CHAIN_COUNT
14426    </p>
14427    </blockquote><p>
14428                    
14429    </p>
14430    <p>Server will start sending the following notification messages:
14431    </p>
14432    <p>
14433                        </p>
14434    <blockquote class="text">
14435    <p>"NOTIFY:SEND_EFFECT_CHAIN_COUNT:&lt;device-id&gt; &lt;chains&gt;"
14436    </p>
14437    </blockquote><p>
14438                    
14439    </p>
14440    <p>where &lt;device-id&gt; will be replaced by the numerical ID of the audio
14441                    output device, in which the number of send effect chains is changed and
14442                    &lt;chains&gt; will be replaced by the new number of send effect chains.
14443    </p>
14444    <a name="SUBSCRIBE SEND_EFFECT_CHAIN_INFO"></a><br /><hr />
14445    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
14446    <a name="rfc.section.8.29"></a><h3>8.29.&nbsp;
14447    Send effect chain information changed</h3>
14448    
14449    <p>Client may want to be notified when changes were made to send effect chains
14450                    on the back-end by issuing the following command:
14451    </p>
14452    <p>
14453                        </p>
14454    <blockquote class="text">
14455    <p>SUBSCRIBE SEND_EFFECT_CHAIN_INFO
14456    </p>
14457    </blockquote><p>
14458                    
14459    </p>
14460    <p>Server will start sending the following notification messages:
14461    </p>
14462    <p>
14463                       </p>
14464    <blockquote class="text">
14465    <p>"SEND_EFFECT_CHAIN_INFO:&lt;device-id&gt; &lt;chain-id&gt; &lt;instances&gt;" -
14466                            Notifies that the number of effect instances in a particular send effect chain
14467                            is changed, where &lt;device-id&gt; will be replaced by the numerical ID of the audio
14468                            output device the send effect chain belongs to, &lt;chain-id&gt; will be replaced
14469                            by the numerical ID of the send effect chain in which the number of effect instances
14470                            has changed and &lt;instances&gt; will be replaced by the new number
14471                            of effect instances in the specified send effect chain.
14472    </p>
14473    </blockquote><p>
14474                    
14475    </p>
14476    <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
14477    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
14478    <a name="rfc.section.8.30"></a><h3>8.30.&nbsp;
14479  Miscellaneous and debugging events</h3>  Miscellaneous and debugging events</h3>
14480    
14481  <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 14541  Acknowledgments</h3>
14541  <h3>11.&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
14542  <table width="99%" border="0">  <table width="99%" border="0">
14543  <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>
14544  <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>
14545  <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>
14546  <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>
14547  <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>
14548  <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>
14549  <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>
14550  <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>
14551  </table>  </table>
14552    
14553  <a name="rfc.authors"></a><br /><hr />  <a name="rfc.authors"></a><br /><hr />
# Line 11936  Acknowledgments</h3> Line 14558  Acknowledgments</h3>
14558  <td class="author-text">C.  <td class="author-text">C.
14559  Schoenebeck</td></tr>  Schoenebeck</td></tr>
14560  <tr><td class="author-text">&nbsp;</td>  <tr><td class="author-text">&nbsp;</td>
14561  <td class="author-text">Interessengemeinschaft Software Engineering e. V.</td></tr>  <td class="author-text">LinuxSampler.org</td></tr>
14562    <tr><td class="author-text">&nbsp;</td>
14563    <td class="author-text">Crudebyte Engineering</td></tr>
14564  <tr><td class="author-text">&nbsp;</td>  <tr><td class="author-text">&nbsp;</td>
14565  <td class="author-text">Max-Planck-Str. 39</td></tr>  <td class="author-text">Hofgartenstr. 3</td></tr>
14566  <tr><td class="author-text">&nbsp;</td>  <tr><td class="author-text">&nbsp;</td>
14567  <td class="author-text">74081 Heilbronn</td></tr>  <td class="author-text">74189 Weinsberg</td></tr>
14568  <tr><td class="author-text">&nbsp;</td>  <tr><td class="author-text">&nbsp;</td>
14569  <td class="author-text">Germany</td></tr>  <td class="author-text">Germany</td></tr>
14570    <tr><td class="author" align="right">Phone:&nbsp;</td>
14571    <td class="author-text">+49 7134 911614</td></tr>
14572  <tr><td class="author" align="right">Email:&nbsp;</td>  <tr><td class="author" align="right">Email:&nbsp;</td>
14573  <td class="author-text"><a href="mailto:schoenebeck at software minus engineering dot org">schoenebeck at software minus engineering dot org</a></td></tr>  <td class="author-text"><a href="mailto:cuse@users.sf.net">cuse@users.sf.net</a></td></tr>
14574  </table>  </table>
14575  <a name="rfc.copyright"></a><br /><hr />  <a name="rfc.copyright"></a><br /><hr />
14576  <table 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>
14577  <h3>Full Copyright Statement</h3>  <h3>Full Copyright Statement</h3>
14578  <p class='copyright'>  <p class='copyright'>
14579  Copyright &copy; The IETF Trust (2008).</p>  Copyright &copy; The IETF Trust (2014).</p>
14580  <p class='copyright'>  <p class='copyright'>
14581  This document is subject to the rights,  This document is subject to the rights,
14582  licenses and restrictions contained in BCP&nbsp;78,  licenses and restrictions contained in BCP&nbsp;78,
# Line 11992  or other Line 14618  or other
14618  proprietary rights that may cover technology that may be required  proprietary rights that may cover technology that may be required
14619  to implement this standard.  to implement this standard.
14620  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>  
14621  </body></html>  </body></html>

Legend:
Removed from v.1773  
changed lines
  Added in v.2498

  ViewVC Help
Powered by ViewVC