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; |
145 |
<tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr> |
<tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr> |
146 |
<tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr> |
<tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr> |
147 |
<tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr> |
<tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr> |
148 |
<tr><td class="header">Expires: March 14, 2009</td><td class="header">September 10, 2008</td></tr> |
<tr><td class="header">Expires: April 8, 2011</td><td class="header">October 5, 2010</td></tr> |
149 |
</table></td></tr></table> |
</table></td></tr></table> |
150 |
<h1><br />LinuxSampler Control Protocol<br />LSCP 1.4</h1> |
<h1><br />LinuxSampler Control Protocol<br />LSCP 1.5</h1> |
151 |
|
|
152 |
|
<h3>Abstract</h3> |
153 |
|
|
154 |
|
<p>The LinuxSampler Control Protocol (LSCP) is an |
155 |
|
application-level protocol primarily intended for local and |
156 |
|
remote controlling the LinuxSampler backend application, which is a |
157 |
|
sophisticated server-like console application essentially playing |
158 |
|
back audio samples and manipulating the samples in real time to |
159 |
|
certain extent. |
160 |
|
</p> |
161 |
<h3>Status of this Memo</h3> |
<h3>Status of this Memo</h3> |
162 |
<p> |
<p> |
163 |
By submitting this Internet-Draft, |
By submitting this Internet-Draft, |
167 |
in accordance with Section 6 of BCP 79.</p> |
in accordance with Section 6 of BCP 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 “work in progress.”</p> |
them other than as “work in progress.”</p> |
178 |
<p> |
<p> |
179 |
The list of current Internet-Drafts can be accessed at |
This Internet-Draft will expire on April 8, 2011.</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 © 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> |
<a href="#anchor1">1.</a> |
322 |
Changing effect send's name<br /> |
Changing effect send's name<br /> |
323 |
<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a> |
<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a> |
324 |
Altering effect send's audio routing<br /> |
Altering effect send's audio routing<br /> |
325 |
<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.32.</a> |
<a href="#SET FX_SEND EFFECT">6.4.32.</a> |
326 |
|
Assigning destination effect to an effect send<br /> |
327 |
|
<a href="#REMOVE FX_SEND EFFECT">6.4.33.</a> |
328 |
|
Removing destination effect from an effect send<br /> |
329 |
|
<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.34.</a> |
330 |
Altering effect send's MIDI controller<br /> |
Altering effect send's MIDI controller<br /> |
331 |
<a href="#SET FX_SEND LEVEL">6.4.33.</a> |
<a href="#SET FX_SEND LEVEL">6.4.35.</a> |
332 |
Altering effect send's send level<br /> |
Altering effect send's send level<br /> |
333 |
<a href="#SEND CHANNEL MIDI_DATA">6.4.34.</a> |
<a href="#SEND CHANNEL MIDI_DATA">6.4.36.</a> |
334 |
Sending MIDI messages to sampler channel<br /> |
Sending MIDI messages to sampler channel<br /> |
335 |
<a href="#RESET CHANNEL">6.4.35.</a> |
<a href="#RESET CHANNEL">6.4.37.</a> |
336 |
Resetting a sampler channel<br /> |
Resetting a sampler channel<br /> |
337 |
<a href="#anchor12">6.5.</a> |
<a href="#anchor12">6.5.</a> |
338 |
Controlling connection<br /> |
Controlling connection<br /> |
360 |
Getting global volume attenuation<br /> |
Getting global volume attenuation<br /> |
361 |
<a href="#SET VOLUME">6.6.7.</a> |
<a href="#SET VOLUME">6.6.7.</a> |
362 |
Setting global volume attenuation<br /> |
Setting global volume attenuation<br /> |
363 |
|
<a href="#GET VOICES">6.6.8.</a> |
364 |
|
Getting global voice limit<br /> |
365 |
|
<a href="#SET VOICES">6.6.9.</a> |
366 |
|
Setting global voice limit<br /> |
367 |
|
<a href="#GET STREAMS">6.6.10.</a> |
368 |
|
Getting global disk stream limit<br /> |
369 |
|
<a href="#SET STREAMS">6.6.11.</a> |
370 |
|
Setting global disk stream limit<br /> |
371 |
<a href="#MIDI Instrument Mapping">6.7.</a> |
<a href="#MIDI Instrument Mapping">6.7.</a> |
372 |
MIDI Instrument Mapping<br /> |
MIDI Instrument Mapping<br /> |
373 |
<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a> |
<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a> |
456 |
Retrieving all instruments of a file<br /> |
Retrieving all instruments of a file<br /> |
457 |
<a href="#GET FILE INSTRUMENT INFO">6.10.3.</a> |
<a href="#GET FILE INSTRUMENT INFO">6.10.3.</a> |
458 |
Retrieving informations about one instrument in a file<br /> |
Retrieving informations about one instrument in a file<br /> |
459 |
|
<a href="#effects">6.11.</a> |
460 |
|
Managing Effects<br /> |
461 |
|
<a href="#GET AVAILABLE_EFFECTS">6.11.1.</a> |
462 |
|
Retrieve amount of available effects<br /> |
463 |
|
<a href="#LIST AVAILABLE_EFFECTS">6.11.2.</a> |
464 |
|
Get list of available effects<br /> |
465 |
|
<a href="#GET EFFECT INFO">6.11.3.</a> |
466 |
|
Retrieving general information about an effect<br /> |
467 |
|
<a href="#CREATE EFFECT_INSTANCE">6.11.4.</a> |
468 |
|
Creating an instance of an effect by its portable ID<br /> |
469 |
|
<a href="#CREATE EFFECT_INSTANCE (non-portable)">6.11.5.</a> |
470 |
|
Creating an instance of an effect by its numerical ID<br /> |
471 |
|
<a href="#DESTROY EFFECT_INSTANCE">6.11.6.</a> |
472 |
|
Destroy an effect instance<br /> |
473 |
|
<a href="#GET EFFECT_INSTANCES">6.11.7.</a> |
474 |
|
Retrieve amount of effect instances<br /> |
475 |
|
<a href="#LIST EFFECT_INSTANCES">6.11.8.</a> |
476 |
|
Get list of effect instances<br /> |
477 |
|
<a href="#GET EFFECT_INSTANCE INFO">6.11.9.</a> |
478 |
|
Retrieving current information about an effect instance<br /> |
479 |
|
<a href="#GET EFFECT_INSTANCE_INPUT_CONTROL INFO">6.11.10.</a> |
480 |
|
Retrieving information about an effect parameter<br /> |
481 |
|
<a href="#SET EFFECT_INSTANCE_INPUT_CONTROL VALUE">6.11.11.</a> |
482 |
|
Altering an effect parameter<br /> |
483 |
|
<a href="#GET SEND_EFFECT_CHAINS">6.11.12.</a> |
484 |
|
Retrieve amount of send effect chains<br /> |
485 |
|
<a href="#LIST SEND_EFFECT_CHAINS">6.11.13.</a> |
486 |
|
Retrieve list of send effect chains<br /> |
487 |
|
<a href="#ADD SEND_EFFECT_CHAIN">6.11.14.</a> |
488 |
|
Add send effect chain<br /> |
489 |
|
<a href="#REMOVE SEND_EFFECT_CHAIN">6.11.15.</a> |
490 |
|
Remove send effect chain<br /> |
491 |
|
<a href="#GET SEND_EFFECT_CHAIN INFO">6.11.16.</a> |
492 |
|
Retrieving information about a send effect chain<br /> |
493 |
|
<a href="#APPEND SEND_EFFECT_CHAIN EFFECT">6.11.17.</a> |
494 |
|
Append effect instance to a send effect chain<br /> |
495 |
|
<a href="#INSERT SEND_EFFECT_CHAIN EFFECT">6.11.18.</a> |
496 |
|
Insert effect instance to a send effect chain<br /> |
497 |
|
<a href="#REMOVE SEND_EFFECT_CHAIN EFFECT">6.11.19.</a> |
498 |
|
Remove effect instance from send effect chain<br /> |
499 |
<a href="#command_syntax">7.</a> |
<a href="#command_syntax">7.</a> |
500 |
Command Syntax<br /> |
Command Syntax<br /> |
501 |
<a href="#character_set">7.1.</a> |
<a href="#character_set">7.1.</a> |
4034 |
<blockquote class="text"> |
<blockquote class="text"> |
4035 |
<p>numerical ID of the audio output device which is |
<p>numerical ID of the audio output device which is |
4036 |
currently connected to this sampler channel to output |
currently connected to this sampler channel to output |
4037 |
the audio signal, "NONE" if there's no device |
the audio signal, "-1" if there's no device |
4038 |
connected to this sampler channel |
connected to this sampler channel |
4039 |
</p> |
</p> |
4040 |
</blockquote> |
</blockquote> |
4077 |
<p>INSTRUMENT_NR - |
<p>INSTRUMENT_NR - |
4078 |
</p> |
</p> |
4079 |
<blockquote class="text"> |
<blockquote class="text"> |
4080 |
<p>the instrument index number of the loaded instrument |
<p>the instrument index number of the loaded instrument, |
4081 |
|
"-1" if there's no instrument loaded for this sampler |
4082 |
|
channel |
4083 |
</p> |
</p> |
4084 |
</blockquote> |
</blockquote> |
4085 |
|
|
4097 |
<p>INSTRUMENT_STATUS - |
<p>INSTRUMENT_STATUS - |
4098 |
</p> |
</p> |
4099 |
<blockquote class="text"> |
<blockquote class="text"> |
4100 |
<p>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative |
<p>Integer values 0 to 100 indicating loading progress |
4101 |
value indicates a loading exception. Value of 100 indicates that the instrument is fully |
percentage for the instrument. Negative |
4102 |
|
value indicates a loading exception (also returns "-1" in case no |
4103 |
|
instrument was yet to be loaded on the sampler channel). |
4104 |
|
Value of 100 indicates that the instrument is fully |
4105 |
loaded. |
loaded. |
4106 |
</p> |
</p> |
4107 |
</blockquote> |
</blockquote> |
4112 |
<blockquote class="text"> |
<blockquote class="text"> |
4113 |
<p>numerical ID of the MIDI input device which is |
<p>numerical ID of the MIDI input device which is |
4114 |
currently connected to this sampler channel to deliver |
currently connected to this sampler channel to deliver |
4115 |
MIDI input commands, "NONE" if there's no device |
MIDI input commands, "-1" if there's no device |
4116 |
connected to this sampler channel |
connected to this sampler channel |
4117 |
</p> |
</p> |
4118 |
</blockquote> |
</blockquote> |
4121 |
<p>MIDI_INPUT_PORT - |
<p>MIDI_INPUT_PORT - |
4122 |
</p> |
</p> |
4123 |
<blockquote class="text"> |
<blockquote class="text"> |
4124 |
<p>port number of the MIDI input device |
<p>port number of the MIDI input device (in case a |
4125 |
|
MIDI device was already assigned to the sampler |
4126 |
|
channel) |
4127 |
</p> |
</p> |
4128 |
</blockquote> |
</blockquote> |
4129 |
|
|
5477 |
channel 1 is routed to the channel 3 of the audio |
channel 1 is routed to the channel 3 of the audio |
5478 |
output device (see |
output device (see |
5479 |
<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> |
5480 |
for details) |
for details), if an internal send |
5481 |
|
effect is assigned to the effect |
5482 |
|
send, then this setting defines the |
5483 |
|
audio channel routing to that |
5484 |
|
effect instance respectively |
5485 |
|
</p> |
5486 |
|
</blockquote> |
5487 |
|
|
5488 |
|
|
5489 |
|
<p>EFFECT - |
5490 |
|
</p> |
5491 |
|
<blockquote class="text"> |
5492 |
|
<p>destination send effect chain ID |
5493 |
|
and destination effect chain |
5494 |
|
position, separated by comma in the |
5495 |
|
form "<effect-chain>,<chain-pos>" |
5496 |
|
or "NONE" if there is no send effect |
5497 |
|
assigned to the effect send |
5498 |
</p> |
</p> |
5499 |
</blockquote> |
</blockquote> |
5500 |
|
|
5522 |
</p> |
</p> |
5523 |
<p> "AUDIO_OUTPUT_ROUTING: 2,3" |
<p> "AUDIO_OUTPUT_ROUTING: 2,3" |
5524 |
</p> |
</p> |
5525 |
|
<p> "EFFECT: NONE" |
5526 |
|
</p> |
5527 |
|
<p> "." |
5528 |
|
</p> |
5529 |
|
</blockquote><p> |
5530 |
|
|
5531 |
|
</p> |
5532 |
|
<p> |
5533 |
|
</p> |
5534 |
|
<blockquote class="text"> |
5535 |
|
<p>C: "GET FX_SEND INFO 0 1" |
5536 |
|
</p> |
5537 |
|
<p>S: "NAME: Delay Send (Internal)" |
5538 |
|
</p> |
5539 |
|
<p> "MIDI_CONTROLLER: 93" |
5540 |
|
</p> |
5541 |
|
<p> "LEVEL: 0.51" |
5542 |
|
</p> |
5543 |
|
<p> "AUDIO_OUTPUT_ROUTING: 1,2" |
5544 |
|
</p> |
5545 |
|
<p> "EFFECT: 2,0" |
5546 |
|
</p> |
5547 |
<p> "." |
<p> "." |
5548 |
</p> |
</p> |
5549 |
</blockquote><p> |
</blockquote><p> |
5638 |
<audio-src> is the numerical ID of the effect send's audio channel |
<audio-src> is the numerical ID of the effect send's audio channel |
5639 |
which should be rerouted and <audio-dst> is the numerical ID of |
which should be rerouted and <audio-dst> is the numerical ID of |
5640 |
the audio channel of the selected audio output device where <audio-src> |
the audio channel of the selected audio output device where <audio-src> |
5641 |
should be routed to. |
should be routed to. If an internal send effect is assigned |
5642 |
|
to the effect send, then this setting defines the audio |
5643 |
|
channel routing to that effect instance respectively. |
5644 |
</p> |
</p> |
5645 |
<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 |
5646 |
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 |
5698 |
</blockquote><p> |
</blockquote><p> |
5699 |
|
|
5700 |
</p> |
</p> |
5701 |
<a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr /> |
<a name="SET FX_SEND EFFECT"></a><br /><hr /> |
5702 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5703 |
<a name="rfc.section.6.4.32"></a><h3>6.4.32. |
<a name="rfc.section.6.4.32"></a><h3>6.4.32. |
5704 |
|
Assigning destination effect to an effect send</h3> |
5705 |
|
|
5706 |
|
<p>The front-end can (re-)assign a destination effect to an |
5707 |
|
effect send by sending the following command: |
5708 |
|
</p> |
5709 |
|
<p> |
5710 |
|
</p> |
5711 |
|
<blockquote class="text"> |
5712 |
|
<p>SET FX_SEND EFFECT <sampler-chan> <fx-send-id> <effect-chain> <chain-pos> |
5713 |
|
</p> |
5714 |
|
</blockquote><p> |
5715 |
|
|
5716 |
|
</p> |
5717 |
|
<p>Where <sampler-chan> is the sampler channel number |
5718 |
|
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> |
5719 |
|
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, |
5720 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
5721 |
|
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> |
5722 |
|
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, |
5723 |
|
<effect-chain> by the numerical ID of the destination |
5724 |
|
effect chain as returned by the |
5725 |
|
<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> |
5726 |
|
or |
5727 |
|
<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> |
5728 |
|
command and <chain-pos> reflects the exact effect |
5729 |
|
chain position in the effect chain which hosts the actual |
5730 |
|
destination effect. |
5731 |
|
</p> |
5732 |
|
<p>Possible Answers: |
5733 |
|
</p> |
5734 |
|
<p> |
5735 |
|
</p> |
5736 |
|
<blockquote class="text"> |
5737 |
|
<p>"OK" - |
5738 |
|
</p> |
5739 |
|
<blockquote class="text"> |
5740 |
|
<p>on success |
5741 |
|
</p> |
5742 |
|
</blockquote> |
5743 |
|
|
5744 |
|
|
5745 |
|
<p>"ERR:<error-code>:<error-message>" - |
5746 |
|
</p> |
5747 |
|
<blockquote class="text"> |
5748 |
|
<p>in case it failed, providing an appropriate error code and error message |
5749 |
|
</p> |
5750 |
|
</blockquote> |
5751 |
|
|
5752 |
|
|
5753 |
|
</blockquote><p> |
5754 |
|
|
5755 |
|
</p> |
5756 |
|
<p>Example: |
5757 |
|
</p> |
5758 |
|
<p> |
5759 |
|
</p> |
5760 |
|
<blockquote class="text"> |
5761 |
|
<p>C: "SET FX_SEND EFFECT 0 0 2 5" |
5762 |
|
</p> |
5763 |
|
<p>S: "OK" |
5764 |
|
</p> |
5765 |
|
</blockquote><p> |
5766 |
|
|
5767 |
|
</p> |
5768 |
|
<a name="REMOVE FX_SEND EFFECT"></a><br /><hr /> |
5769 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5770 |
|
<a name="rfc.section.6.4.33"></a><h3>6.4.33. |
5771 |
|
Removing destination effect from an effect send</h3> |
5772 |
|
|
5773 |
|
<p>The front-end can (re-)assign a destination effect to an |
5774 |
|
effect send by sending the following command: |
5775 |
|
</p> |
5776 |
|
<p> |
5777 |
|
</p> |
5778 |
|
<blockquote class="text"> |
5779 |
|
<p>REMOVE FX_SEND EFFECT <sampler-chan> <fx-send-id> |
5780 |
|
</p> |
5781 |
|
</blockquote><p> |
5782 |
|
|
5783 |
|
</p> |
5784 |
|
<p>Where <sampler-chan> is the sampler channel number |
5785 |
|
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> |
5786 |
|
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, |
5787 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
5788 |
|
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> |
5789 |
|
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. |
5790 |
|
</p> |
5791 |
|
<p>After the destination effect has been removed from the |
5792 |
|
effect send, the audio signal of the effect send will be |
5793 |
|
routed directly to the audio output device, according to the |
5794 |
|
audio channel routing setting of the effect send. |
5795 |
|
|
5796 |
|
</p> |
5797 |
|
<p>Possible Answers: |
5798 |
|
</p> |
5799 |
|
<p> |
5800 |
|
</p> |
5801 |
|
<blockquote class="text"> |
5802 |
|
<p>"OK" - |
5803 |
|
</p> |
5804 |
|
<blockquote class="text"> |
5805 |
|
<p>on success |
5806 |
|
</p> |
5807 |
|
</blockquote> |
5808 |
|
|
5809 |
|
|
5810 |
|
<p>"ERR:<error-code>:<error-message>" - |
5811 |
|
</p> |
5812 |
|
<blockquote class="text"> |
5813 |
|
<p>in case it failed, providing an appropriate error code and error message |
5814 |
|
</p> |
5815 |
|
</blockquote> |
5816 |
|
|
5817 |
|
|
5818 |
|
</blockquote><p> |
5819 |
|
|
5820 |
|
</p> |
5821 |
|
<p>Example: |
5822 |
|
</p> |
5823 |
|
<p> |
5824 |
|
</p> |
5825 |
|
<blockquote class="text"> |
5826 |
|
<p>C: "REMOVE FX_SEND EFFECT 0 0" |
5827 |
|
</p> |
5828 |
|
<p>S: "OK" |
5829 |
|
</p> |
5830 |
|
</blockquote><p> |
5831 |
|
|
5832 |
|
</p> |
5833 |
|
<a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr /> |
5834 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5835 |
|
<a name="rfc.section.6.4.34"></a><h3>6.4.34. |
5836 |
Altering effect send's MIDI controller</h3> |
Altering effect send's MIDI controller</h3> |
5837 |
|
|
5838 |
<p>The front-end can alter the MIDI controller of an effect |
<p>The front-end can alter the MIDI controller of an effect |
5903 |
</p> |
</p> |
5904 |
<a name="SET FX_SEND LEVEL"></a><br /><hr /> |
<a name="SET FX_SEND LEVEL"></a><br /><hr /> |
5905 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5906 |
<a name="rfc.section.6.4.33"></a><h3>6.4.33. |
<a name="rfc.section.6.4.35"></a><h3>6.4.35. |
5907 |
Altering effect send's send level</h3> |
Altering effect send's send level</h3> |
5908 |
|
|
5909 |
<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 |
5975 |
</p> |
</p> |
5976 |
<a name="SEND CHANNEL MIDI_DATA"></a><br /><hr /> |
<a name="SEND CHANNEL MIDI_DATA"></a><br /><hr /> |
5977 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5978 |
<a name="rfc.section.6.4.34"></a><h3>6.4.34. |
<a name="rfc.section.6.4.36"></a><h3>6.4.36. |
5979 |
Sending MIDI messages to sampler channel</h3> |
Sending MIDI messages to sampler channel</h3> |
5980 |
|
|
5981 |
<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 |
5982 |
by sending the following command: |
by sending the following command: |
5983 |
</p> |
</p> |
5984 |
<p> |
<p> |
6018 |
</blockquote> |
</blockquote> |
6019 |
|
|
6020 |
|
|
6021 |
|
<p>"CC" - |
6022 |
|
</p> |
6023 |
|
<blockquote class="text"> |
6024 |
|
<p>For changing a MIDI controller, where <arg1> |
6025 |
|
specifies the controller number and <arg2> the |
6026 |
|
new value of the controller as described in the Control |
6027 |
|
Change section of the MIDI specification. |
6028 |
|
</p> |
6029 |
|
</blockquote> |
6030 |
|
|
6031 |
|
|
6032 |
</blockquote><p> |
</blockquote><p> |
6033 |
|
|
6034 |
</p> |
</p> |
6073 |
</p> |
</p> |
6074 |
<a name="RESET CHANNEL"></a><br /><hr /> |
<a name="RESET CHANNEL"></a><br /><hr /> |
6075 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6076 |
<a name="rfc.section.6.4.35"></a><h3>6.4.35. |
<a name="rfc.section.6.4.37"></a><h3>6.4.37. |
6077 |
Resetting a sampler channel</h3> |
Resetting a sampler channel</h3> |
6078 |
|
|
6079 |
<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: |
6640 |
</blockquote><p> |
</blockquote><p> |
6641 |
|
|
6642 |
</p> |
</p> |
6643 |
|
<a name="GET VOICES"></a><br /><hr /> |
6644 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6645 |
|
<a name="rfc.section.6.6.8"></a><h3>6.6.8. |
6646 |
|
Getting global voice limit</h3> |
6647 |
|
|
6648 |
|
<p>The client can ask for the current global sampler-wide limit |
6649 |
|
for maximum voices by sending the following command: |
6650 |
|
</p> |
6651 |
|
<p> |
6652 |
|
</p> |
6653 |
|
<blockquote class="text"> |
6654 |
|
<p>GET VOICES |
6655 |
|
</p> |
6656 |
|
</blockquote><p> |
6657 |
|
|
6658 |
|
</p> |
6659 |
|
<p>Possible Answers: |
6660 |
|
</p> |
6661 |
|
<p> |
6662 |
|
</p> |
6663 |
|
<blockquote class="text"> |
6664 |
|
<p>LinuxSampler will answer by returning the number for |
6665 |
|
the current limit of maximum voices. |
6666 |
|
</p> |
6667 |
|
</blockquote><p> |
6668 |
|
|
6669 |
|
</p> |
6670 |
|
<p>The voice limit setting defines how many voices should maximum |
6671 |
|
be processed by the sampler at the same time. If the user |
6672 |
|
triggers new notes which would exceed that voice limit, the |
6673 |
|
sampler engine will react by stealing old voices for those |
6674 |
|
newly triggered notes. Note that the amount of voices triggered |
6675 |
|
by a new note can be larger than one and is dependent to the |
6676 |
|
respective instrument and probably further criterias. |
6677 |
|
</p> |
6678 |
|
<a name="SET VOICES"></a><br /><hr /> |
6679 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6680 |
|
<a name="rfc.section.6.6.9"></a><h3>6.6.9. |
6681 |
|
Setting global voice limit</h3> |
6682 |
|
|
6683 |
|
<p>The client can alter the current global sampler-wide limit |
6684 |
|
for maximum voices by sending the following command: |
6685 |
|
</p> |
6686 |
|
<p> |
6687 |
|
</p> |
6688 |
|
<blockquote class="text"> |
6689 |
|
<p>SET VOICES <max-voices> |
6690 |
|
</p> |
6691 |
|
</blockquote><p> |
6692 |
|
|
6693 |
|
</p> |
6694 |
|
<p>Where <max-voices> should be replaced by the integer |
6695 |
|
value, reflecting the new global amount limit of maximum voices. |
6696 |
|
This value has to be larger than 0. |
6697 |
|
</p> |
6698 |
|
<p>Possible Answers: |
6699 |
|
</p> |
6700 |
|
<p> |
6701 |
|
</p> |
6702 |
|
<blockquote class="text"> |
6703 |
|
<p>"OK" - |
6704 |
|
</p> |
6705 |
|
<blockquote class="text"> |
6706 |
|
<p>on success |
6707 |
|
</p> |
6708 |
|
</blockquote> |
6709 |
|
|
6710 |
|
|
6711 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
6712 |
|
</p> |
6713 |
|
<blockquote class="text"> |
6714 |
|
<p>if the voice limit was set, but there are noteworthy |
6715 |
|
issue(s) related, providing an appropriate warning code and |
6716 |
|
warning message |
6717 |
|
</p> |
6718 |
|
</blockquote> |
6719 |
|
|
6720 |
|
|
6721 |
|
<p>"ERR:<error-code>:<error-message>" - |
6722 |
|
</p> |
6723 |
|
<blockquote class="text"> |
6724 |
|
<p>in case it failed, providing an appropriate error code and error message |
6725 |
|
</p> |
6726 |
|
</blockquote> |
6727 |
|
|
6728 |
|
|
6729 |
|
</blockquote><p> |
6730 |
|
|
6731 |
|
</p> |
6732 |
|
<p>Note: the given value will be passed to all sampler engine instances. |
6733 |
|
The total amount of maximum voices on the running system might thus |
6734 |
|
be as big as the given value multiplied by the current amount of engine |
6735 |
|
instances. |
6736 |
|
</p> |
6737 |
|
<p>Caution: when adjusting the voice limit, you SHOULD also |
6738 |
|
adjust the disk stream limit respectively and vice versa. |
6739 |
|
</p> |
6740 |
|
<a name="GET STREAMS"></a><br /><hr /> |
6741 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6742 |
|
<a name="rfc.section.6.6.10"></a><h3>6.6.10. |
6743 |
|
Getting global disk stream limit</h3> |
6744 |
|
|
6745 |
|
<p>The client can ask for the current global sampler-wide limit |
6746 |
|
for maximum disk streams by sending the following command: |
6747 |
|
</p> |
6748 |
|
<p> |
6749 |
|
</p> |
6750 |
|
<blockquote class="text"> |
6751 |
|
<p>GET STREAMS |
6752 |
|
</p> |
6753 |
|
</blockquote><p> |
6754 |
|
|
6755 |
|
</p> |
6756 |
|
<p>Possible Answers: |
6757 |
|
</p> |
6758 |
|
<p> |
6759 |
|
</p> |
6760 |
|
<blockquote class="text"> |
6761 |
|
<p>LinuxSampler will answer by returning the number for |
6762 |
|
the current limit of maximum disk streams. |
6763 |
|
</p> |
6764 |
|
</blockquote><p> |
6765 |
|
|
6766 |
|
</p> |
6767 |
|
<p>The disk stream limit setting defines how many disk streams should |
6768 |
|
maximum be processed by a sampler engine at the same time. The |
6769 |
|
higher this value, the more memory (RAM) will be occupied, since |
6770 |
|
every disk streams allocates a certain buffer size for being able |
6771 |
|
to perform its streaming operations. |
6772 |
|
</p> |
6773 |
|
<a name="SET STREAMS"></a><br /><hr /> |
6774 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6775 |
|
<a name="rfc.section.6.6.11"></a><h3>6.6.11. |
6776 |
|
Setting global disk stream limit</h3> |
6777 |
|
|
6778 |
|
<p>The client can alter the current global sampler-wide limit |
6779 |
|
for maximum disk streams by sending the following command: |
6780 |
|
</p> |
6781 |
|
<p> |
6782 |
|
</p> |
6783 |
|
<blockquote class="text"> |
6784 |
|
<p>SET STREAMS <max-streams> |
6785 |
|
</p> |
6786 |
|
</blockquote><p> |
6787 |
|
|
6788 |
|
</p> |
6789 |
|
<p>Where <max-streams> should be replaced by the integer |
6790 |
|
value, reflecting the new global amount limit of maximum disk streams. |
6791 |
|
This value has to be positive. |
6792 |
|
</p> |
6793 |
|
<p>Possible Answers: |
6794 |
|
</p> |
6795 |
|
<p> |
6796 |
|
</p> |
6797 |
|
<blockquote class="text"> |
6798 |
|
<p>"OK" - |
6799 |
|
</p> |
6800 |
|
<blockquote class="text"> |
6801 |
|
<p>on success |
6802 |
|
</p> |
6803 |
|
</blockquote> |
6804 |
|
|
6805 |
|
|
6806 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
6807 |
|
</p> |
6808 |
|
<blockquote class="text"> |
6809 |
|
<p>if the disk stream limit was set, but there are noteworthy |
6810 |
|
issue(s) related, providing an appropriate warning code and |
6811 |
|
warning message |
6812 |
|
</p> |
6813 |
|
</blockquote> |
6814 |
|
|
6815 |
|
|
6816 |
|
<p>"ERR:<error-code>:<error-message>" - |
6817 |
|
</p> |
6818 |
|
<blockquote class="text"> |
6819 |
|
<p>in case it failed, providing an appropriate error code and error message |
6820 |
|
</p> |
6821 |
|
</blockquote> |
6822 |
|
|
6823 |
|
|
6824 |
|
</blockquote><p> |
6825 |
|
|
6826 |
|
</p> |
6827 |
|
<p>Note: the given value will be passed to all sampler engine instances. |
6828 |
|
The total amount of maximum disk streams on the running system might |
6829 |
|
thus be as big as the given value multiplied by the current amount of |
6830 |
|
engine instances. |
6831 |
|
</p> |
6832 |
|
<p>Caution: when adjusting the disk stream limit, you SHOULD also |
6833 |
|
adjust the voice limit respectively and vice versa. |
6834 |
|
</p> |
6835 |
<a name="MIDI Instrument Mapping"></a><br /><hr /> |
<a name="MIDI Instrument Mapping"></a><br /><hr /> |
6836 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6837 |
<a name="rfc.section.6.7"></a><h3>6.7. |
<a name="rfc.section.6.7"></a><h3>6.7. |
8578 |
<p> |
<p> |
8579 |
</p> |
</p> |
8580 |
<blockquote class="text"> |
<blockquote class="text"> |
8581 |
<p>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path> [<instr_index>] |
<p>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>[ FILE_AS_DIR]] <db_dir> <file_path> [<instr_index>] |
8582 |
</p> |
</p> |
8583 |
</blockquote><p> |
</blockquote><p> |
8584 |
|
|
8636 |
</blockquote><p> |
</blockquote><p> |
8637 |
|
|
8638 |
</p> |
</p> |
8639 |
|
<p> If FILE_AS_DIR argument is supplied, all instruments in an instrument |
8640 |
|
file will be added to a separate directory in the instruments database, which |
8641 |
|
name will be the name of the instrument file with the file extension stripped off. |
8642 |
|
|
8643 |
|
</p> |
8644 |
<p>The difference between regular and NON_MODAL versions of the command |
<p>The difference between regular and NON_MODAL versions of the command |
8645 |
is that the regular command returns when the scanning is finished |
is that the regular command returns when the scanning is finished |
8646 |
while NON_MODAL version returns immediately and a background process is launched. |
while NON_MODAL version returns immediately and a background process is launched. |
10102 |
</blockquote><p> |
</blockquote><p> |
10103 |
|
|
10104 |
</p> |
</p> |
10105 |
|
<a name="effects"></a><br /><hr /> |
10106 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10107 |
|
<a name="rfc.section.6.11"></a><h3>6.11. |
10108 |
|
Managing Effects</h3> |
10109 |
|
|
10110 |
|
<p>Audio effects (e.g. reverb, delay, compression) can be |
10111 |
|
applied to the audio signals generated by the sampler. The |
10112 |
|
sampler usually provides a set of internal audio effects for |
10113 |
|
this task. The exact set of effects depends on the availability |
10114 |
|
of third party effect plugins installed on the system where the |
10115 |
|
sampler runs on. |
10116 |
|
</p> |
10117 |
|
<p>At the moment only "send effects" are supported. Support for |
10118 |
|
"insert effects" and "master effects" is planned to be added at |
10119 |
|
a later point. |
10120 |
|
</p> |
10121 |
|
<p>The following commands allow to retrieve the set of internal |
10122 |
|
effects available to the sampler, detailed informations about |
10123 |
|
those effects and to create and destroy instances of such |
10124 |
|
effects. After an instance of an effect is created, the effect |
10125 |
|
instance can be inserted into the audio signal path of the |
10126 |
|
sampler, e.g. as send effect. |
10127 |
|
</p> |
10128 |
|
<p>The sampler allows to create an arbitrary amount of so called |
10129 |
|
send effect chains. Each effect chain can host an arbitrary |
10130 |
|
amount of effect instances. The output of the first effect |
10131 |
|
instance in an effect chain is fed to the input of the second |
10132 |
|
effect instance of the chain and so on. So effects in one chain |
10133 |
|
are processed sequentially. Send effect chains however are |
10134 |
|
processed in parallel to other send effect chains. Audio signals |
10135 |
|
of sampler channels are fed to send effects by creating FX sends |
10136 |
|
to the respective sampler channel and assigning a destination |
10137 |
|
send effect to that FX by using the |
10138 |
|
<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> |
10139 |
|
command. The latter allows to route the FX send to the beginning |
10140 |
|
of a send effect chain, as well as directly to any other |
10141 |
|
position of the send effect chain. |
10142 |
|
</p> |
10143 |
|
<a name="GET AVAILABLE_EFFECTS"></a><br /><hr /> |
10144 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10145 |
|
<a name="rfc.section.6.11.1"></a><h3>6.11.1. |
10146 |
|
Retrieve amount of available effects</h3> |
10147 |
|
|
10148 |
|
<p>The front-end can retrieve the amount of internal |
10149 |
|
effects, available to the sampler by sending |
10150 |
|
the following command: |
10151 |
|
</p> |
10152 |
|
<p> |
10153 |
|
</p> |
10154 |
|
<blockquote class="text"> |
10155 |
|
<p>GET AVAILABLE_EFFECTS |
10156 |
|
</p> |
10157 |
|
</blockquote><p> |
10158 |
|
|
10159 |
|
</p> |
10160 |
|
<p>Possible Answers: |
10161 |
|
</p> |
10162 |
|
<p> |
10163 |
|
</p> |
10164 |
|
<blockquote class="text"> |
10165 |
|
<p>The sampler will answer by returning the current |
10166 |
|
number of effects available to the sampler. |
10167 |
|
</p> |
10168 |
|
</blockquote><p> |
10169 |
|
|
10170 |
|
</p> |
10171 |
|
<p>Examples: |
10172 |
|
</p> |
10173 |
|
<p> |
10174 |
|
</p> |
10175 |
|
<blockquote class="text"> |
10176 |
|
<p>C: "GET AVAILABLE_EFFECTS" |
10177 |
|
</p> |
10178 |
|
<p>S: "129" |
10179 |
|
</p> |
10180 |
|
</blockquote><p> |
10181 |
|
|
10182 |
|
</p> |
10183 |
|
<a name="LIST AVAILABLE_EFFECTS"></a><br /><hr /> |
10184 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10185 |
|
<a name="rfc.section.6.11.2"></a><h3>6.11.2. |
10186 |
|
Get list of available effects</h3> |
10187 |
|
|
10188 |
|
<p>The set of available internal effects can change at |
10189 |
|
runtime. The front-end can retrieve the list of internal |
10190 |
|
effects, available to the sampler by sending the following |
10191 |
|
command: |
10192 |
|
</p> |
10193 |
|
<p> |
10194 |
|
</p> |
10195 |
|
<blockquote class="text"> |
10196 |
|
<p>LIST AVAILABLE_EFFECTS |
10197 |
|
</p> |
10198 |
|
</blockquote><p> |
10199 |
|
|
10200 |
|
</p> |
10201 |
|
<p>Possible Answers: |
10202 |
|
</p> |
10203 |
|
<p> |
10204 |
|
</p> |
10205 |
|
<blockquote class="text"> |
10206 |
|
<p>The sampler will answer by returning a comma |
10207 |
|
separated list with numerical IDs of effects. Note: |
10208 |
|
the numercial ID of an effect is generated by the |
10209 |
|
sampler for the current moment. The numerical ID of |
10210 |
|
the same effect can change at runtime, e.g. when the |
10211 |
|
user requests a rescan of available effect plugins. |
10212 |
|
|
10213 |
|
</p> |
10214 |
|
</blockquote><p> |
10215 |
|
|
10216 |
|
</p> |
10217 |
|
<p>Example: |
10218 |
|
</p> |
10219 |
|
<p> |
10220 |
|
</p> |
10221 |
|
<blockquote class="text"> |
10222 |
|
<p>C: "LIST AVAILABLE_EFFECTS" |
10223 |
|
</p> |
10224 |
|
<p>S: "5,6,7,120,121,122,123,124" |
10225 |
|
</p> |
10226 |
|
</blockquote><p> |
10227 |
|
|
10228 |
|
</p> |
10229 |
|
<a name="GET EFFECT INFO"></a><br /><hr /> |
10230 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10231 |
|
<a name="rfc.section.6.11.3"></a><h3>6.11.3. |
10232 |
|
Retrieving general information about an effect</h3> |
10233 |
|
|
10234 |
|
<p>The front-end can ask for general informations about an |
10235 |
|
effect by sending the following command: |
10236 |
|
</p> |
10237 |
|
<p> |
10238 |
|
</p> |
10239 |
|
<blockquote class="text"> |
10240 |
|
<p>GET EFFECT INFO <effect-index> |
10241 |
|
</p> |
10242 |
|
</blockquote><p> |
10243 |
|
|
10244 |
|
</p> |
10245 |
|
<p>Where <effect-index> is the numerical ID of an |
10246 |
|
effect as returned by the |
10247 |
|
<a class='info' href='#LIST AVAILABLE_EFFECTS'>"LIST AVAILABLE_EFFECTS"<span> (</span><span class='info'>Get list of available effects</span><span>)</span></a> |
10248 |
|
command. |
10249 |
|
</p> |
10250 |
|
<p>Possible Answers: |
10251 |
|
</p> |
10252 |
|
<p> |
10253 |
|
</p> |
10254 |
|
<blockquote class="text"> |
10255 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
10256 |
|
Each answer line begins with the effect information |
10257 |
|
category name, followed by a colon and then a space |
10258 |
|
character <SP> and finally the info character |
10259 |
|
string to that effect information category. At the |
10260 |
|
moment the following categories are defined: |
10261 |
|
</p> |
10262 |
|
<p> |
10263 |
|
</p> |
10264 |
|
<blockquote class="text"> |
10265 |
|
<p>SYSTEM - |
10266 |
|
</p> |
10267 |
|
<blockquote class="text"> |
10268 |
|
<p>name of the effect plugin system |
10269 |
|
the effect is based on |
10270 |
|
(e.g. "LADSPA") |
10271 |
|
</p> |
10272 |
|
</blockquote> |
10273 |
|
|
10274 |
|
|
10275 |
|
<p>MODULE - |
10276 |
|
</p> |
10277 |
|
<blockquote class="text"> |
10278 |
|
<p>module of the effect plugin |
10279 |
|
system that contains this effect, |
10280 |
|
the module is usually the |
10281 |
|
dynamic-linked library (DLL) |
10282 |
|
filename of the effect plugin, |
10283 |
|
including full path (note that this |
10284 |
|
filename may contain |
10285 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10286 |
|
</p> |
10287 |
|
</blockquote> |
10288 |
|
|
10289 |
|
|
10290 |
|
<p>NAME - |
10291 |
|
</p> |
10292 |
|
<blockquote class="text"> |
10293 |
|
<p>character string defining the |
10294 |
|
unique name of the effect within its |
10295 |
|
module (note that the character |
10296 |
|
string may contain |
10297 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10298 |
|
</p> |
10299 |
|
</blockquote> |
10300 |
|
|
10301 |
|
|
10302 |
|
<p>DESCRIPTION - |
10303 |
|
</p> |
10304 |
|
<blockquote class="text"> |
10305 |
|
<p>human readable name of the |
10306 |
|
effect, intended to be displayed in |
10307 |
|
user interfaces (note that the |
10308 |
|
character string may contain |
10309 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10310 |
|
</p> |
10311 |
|
</blockquote> |
10312 |
|
|
10313 |
|
|
10314 |
|
</blockquote> |
10315 |
|
|
10316 |
|
|
10317 |
|
</blockquote><p> |
10318 |
|
|
10319 |
|
</p> |
10320 |
|
<p>The mentioned fields above don't have to be in particular order. |
10321 |
|
</p> |
10322 |
|
<p>Example: |
10323 |
|
</p> |
10324 |
|
<p> |
10325 |
|
</p> |
10326 |
|
<blockquote class="text"> |
10327 |
|
<p>C: "GET EFFECT INFO 121" |
10328 |
|
</p> |
10329 |
|
<p>S: "SYSTEM: LADSPA" |
10330 |
|
</p> |
10331 |
|
<p> "MODULE: /usr/lib/ladspa/lowpass_iir_1891.so" |
10332 |
|
</p> |
10333 |
|
<p> "NAME: lowpass_iir" |
10334 |
|
</p> |
10335 |
|
<p> "DESCRIPTION: Glame Lowpass Filter" |
10336 |
|
</p> |
10337 |
|
<p> "." |
10338 |
|
</p> |
10339 |
|
</blockquote><p> |
10340 |
|
|
10341 |
|
</p> |
10342 |
|
<a name="CREATE EFFECT_INSTANCE"></a><br /><hr /> |
10343 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10344 |
|
<a name="rfc.section.6.11.4"></a><h3>6.11.4. |
10345 |
|
Creating an instance of an effect by its portable ID</h3> |
10346 |
|
|
10347 |
|
<p>The front-end can spawn an instance of the desired |
10348 |
|
effect by sending the following command: |
10349 |
|
</p> |
10350 |
|
<p> |
10351 |
|
</p> |
10352 |
|
<blockquote class="text"> |
10353 |
|
<p>CREATE EFFECT_INSTANCE <effect-system> <module> <effect-name> |
10354 |
|
</p> |
10355 |
|
</blockquote><p> |
10356 |
|
|
10357 |
|
</p> |
10358 |
|
<p>Where <effect-system> is the "SYSTEM" field, |
10359 |
|
<module> the "MODULE" field and <effect-name> |
10360 |
|
the "NAME" field as returned by the |
10361 |
|
<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> |
10362 |
|
command. The filename of argument <module> and the |
10363 |
|
character string of argument <effect-name> may contain |
10364 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
10365 |
|
</p> |
10366 |
|
<p>The sampler will try to load the requested effect and to |
10367 |
|
create an instance of it. To allow loading the same effect |
10368 |
|
on a different machine, probably even running a completely |
10369 |
|
different operating system (e.g. Linux vs. Windows), the |
10370 |
|
sampler tries to match <module> "softly". That means |
10371 |
|
it first tries to find an effect that exactly matches the |
10372 |
|
given <module> argument. If there is no exact match, |
10373 |
|
the sampler will try to lower the restrictions on matching |
10374 |
|
the <module> argument more and more, e.g. by ignoring |
10375 |
|
upper / lower case differences and by ignoring the path of |
10376 |
|
the DLL filename and file extension. If there is still no |
10377 |
|
match at the end, the sampler will try to ignore the |
10378 |
|
<module> argument completely and as a last resort |
10379 |
|
search for an effect that only matches the given |
10380 |
|
<effect-system> and <effect-name> arguments. |
10381 |
|
</p> |
10382 |
|
<p>Possible Answers: |
10383 |
|
</p> |
10384 |
|
<p> |
10385 |
|
</p> |
10386 |
|
<blockquote class="text"> |
10387 |
|
<p>"OK[<effect-instance>]" - |
10388 |
|
</p> |
10389 |
|
<blockquote class="text"> |
10390 |
|
<p>in case the effect instance was |
10391 |
|
successfully created, where |
10392 |
|
<effect-instance> is the numerical ID |
10393 |
|
of the new effect instance |
10394 |
|
</p> |
10395 |
|
</blockquote> |
10396 |
|
|
10397 |
|
|
10398 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
10399 |
|
</p> |
10400 |
|
<blockquote class="text"> |
10401 |
|
<p>in case the effect instance was spawned |
10402 |
|
successfully, but there are noteworthy |
10403 |
|
issue(s) related, providing an appropriate |
10404 |
|
warning code and warning message |
10405 |
|
</p> |
10406 |
|
</blockquote> |
10407 |
|
|
10408 |
|
|
10409 |
|
<p>"ERR:<error-code>:<error-message>" - |
10410 |
|
</p> |
10411 |
|
<blockquote class="text"> |
10412 |
|
<p>if the effect could not be instantiated |
10413 |
|
</p> |
10414 |
|
</blockquote> |
10415 |
|
|
10416 |
|
|
10417 |
|
</blockquote><p> |
10418 |
|
|
10419 |
|
</p> |
10420 |
|
<p>Examples: |
10421 |
|
</p> |
10422 |
|
<p> |
10423 |
|
</p> |
10424 |
|
<blockquote class="text"> |
10425 |
|
<p>C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/mod_delay_1419.so' 'modDelay'" |
10426 |
|
</p> |
10427 |
|
<p>S: "OK[0]" |
10428 |
|
</p> |
10429 |
|
</blockquote><p> |
10430 |
|
|
10431 |
|
</p> |
10432 |
|
<a name="CREATE EFFECT_INSTANCE (non-portable)"></a><br /><hr /> |
10433 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10434 |
|
<a name="rfc.section.6.11.5"></a><h3>6.11.5. |
10435 |
|
Creating an instance of an effect by its numerical ID</h3> |
10436 |
|
|
10437 |
|
<p>The front-end can spawn an instance of the desired |
10438 |
|
effect by sending the following command: |
10439 |
|
</p> |
10440 |
|
<p> |
10441 |
|
</p> |
10442 |
|
<blockquote class="text"> |
10443 |
|
<p>CREATE EFFECT_INSTANCE <effect-index> |
10444 |
|
</p> |
10445 |
|
</blockquote><p> |
10446 |
|
|
10447 |
|
</p> |
10448 |
|
<p>Where <effect-index> is the numerical ID of the |
10449 |
|
effect as returned by the |
10450 |
|
<a class='info' href='#LIST AVAILABLE_EFFECTS'>"LIST AVAILABLE_EFFECTS"<span> (</span><span class='info'>Get list of available effects</span><span>)</span></a> |
10451 |
|
command. |
10452 |
|
</p> |
10453 |
|
<p>The sampler will try to load the requested effect and to |
10454 |
|
create an instance of it. |
10455 |
|
</p> |
10456 |
|
<p>Note: Since the numerical ID of a certain effect can |
10457 |
|
change at any time, you should not use this command in |
10458 |
|
LSCP files to restore a certain effect at a later time! To |
10459 |
|
store a sampler session including all its effects, use the |
10460 |
|
<a class='info' href='#CREATE EFFECT_INSTANCE'>portable text-based |
10461 |
|
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 |
10462 |
|
allows to restore a sampler session with all its effects |
10463 |
|
also on other machines, possibly even running a completely |
10464 |
|
different operating system (e.g. Linux vs. Windows), with |
10465 |
|
different plugin directories or plugin DLL names. |
10466 |
|
</p> |
10467 |
|
<p>Possible Answers: |
10468 |
|
</p> |
10469 |
|
<p> |
10470 |
|
</p> |
10471 |
|
<blockquote class="text"> |
10472 |
|
<p>"OK[<effect-instance>]" - |
10473 |
|
</p> |
10474 |
|
<blockquote class="text"> |
10475 |
|
<p>in case the effect instance was |
10476 |
|
successfully created, where |
10477 |
|
<effect-instance> is the numerical ID |
10478 |
|
of the new effect instance |
10479 |
|
</p> |
10480 |
|
</blockquote> |
10481 |
|
|
10482 |
|
|
10483 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
10484 |
|
</p> |
10485 |
|
<blockquote class="text"> |
10486 |
|
<p>in case the effect instance was spawned |
10487 |
|
successfully, but there are noteworthy |
10488 |
|
issue(s) related, providing an appropriate |
10489 |
|
warning code and warning message |
10490 |
|
</p> |
10491 |
|
</blockquote> |
10492 |
|
|
10493 |
|
|
10494 |
|
<p>"ERR:<error-code>:<error-message>" - |
10495 |
|
</p> |
10496 |
|
<blockquote class="text"> |
10497 |
|
<p>if the effect could not be instantiated |
10498 |
|
</p> |
10499 |
|
</blockquote> |
10500 |
|
|
10501 |
|
|
10502 |
|
</blockquote><p> |
10503 |
|
|
10504 |
|
</p> |
10505 |
|
<p>Examples: |
10506 |
|
</p> |
10507 |
|
<p> |
10508 |
|
</p> |
10509 |
|
<blockquote class="text"> |
10510 |
|
<p>C: "CREATE EFFECT_INSTANCE 72" |
10511 |
|
</p> |
10512 |
|
<p>S: "OK[5]" |
10513 |
|
</p> |
10514 |
|
</blockquote><p> |
10515 |
|
|
10516 |
|
</p> |
10517 |
|
<a name="DESTROY EFFECT_INSTANCE"></a><br /><hr /> |
10518 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10519 |
|
<a name="rfc.section.6.11.6"></a><h3>6.11.6. |
10520 |
|
Destroy an effect instance</h3> |
10521 |
|
|
10522 |
|
<p>The front-end can destroy an unusued effect instance and |
10523 |
|
thus freeing it from memory by sending the following command: |
10524 |
|
</p> |
10525 |
|
<p> |
10526 |
|
</p> |
10527 |
|
<blockquote class="text"> |
10528 |
|
<p>DESTROY EFFECT_INSTANCE <effect-instance> |
10529 |
|
</p> |
10530 |
|
</blockquote><p> |
10531 |
|
|
10532 |
|
</p> |
10533 |
|
<p>Where <effect-instance> is the numerical ID of the |
10534 |
|
effect instance as returned by the |
10535 |
|
<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 |
10536 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
10537 |
|
command. |
10538 |
|
</p> |
10539 |
|
<p>The effect instance can only be destroyed if it's not |
10540 |
|
used in any part of the sampler's audio signal path anymore. |
10541 |
|
If the effect instance is still in use somewhere, trying to |
10542 |
|
destroy the effect instance will result in an error |
10543 |
|
message. |
10544 |
|
</p> |
10545 |
|
<p>Possible Answers: |
10546 |
|
</p> |
10547 |
|
<p> |
10548 |
|
</p> |
10549 |
|
<blockquote class="text"> |
10550 |
|
<p>"OK" - |
10551 |
|
</p> |
10552 |
|
<blockquote class="text"> |
10553 |
|
<p>in case the effect instance was successfully destroyed |
10554 |
|
</p> |
10555 |
|
</blockquote> |
10556 |
|
|
10557 |
|
|
10558 |
|
<p>"ERR:<error-code>:<error-message>" - |
10559 |
|
</p> |
10560 |
|
<blockquote class="text"> |
10561 |
|
<p>in case it failed, providing an appropriate error code and |
10562 |
|
error message |
10563 |
|
</p> |
10564 |
|
</blockquote> |
10565 |
|
|
10566 |
|
|
10567 |
|
</blockquote><p> |
10568 |
|
|
10569 |
|
</p> |
10570 |
|
<p>Examples: |
10571 |
|
</p> |
10572 |
|
<p> |
10573 |
|
</p> |
10574 |
|
<blockquote class="text"> |
10575 |
|
<p>C: "DESTROY EFFECT_INSTANCE 5" |
10576 |
|
</p> |
10577 |
|
<p>S: "OK" |
10578 |
|
</p> |
10579 |
|
</blockquote><p> |
10580 |
|
|
10581 |
|
</p> |
10582 |
|
<a name="GET EFFECT_INSTANCES"></a><br /><hr /> |
10583 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10584 |
|
<a name="rfc.section.6.11.7"></a><h3>6.11.7. |
10585 |
|
Retrieve amount of effect instances</h3> |
10586 |
|
|
10587 |
|
<p>The front-end can retrieve the current amount of effect |
10588 |
|
instances by sending the following command: |
10589 |
|
</p> |
10590 |
|
<p> |
10591 |
|
</p> |
10592 |
|
<blockquote class="text"> |
10593 |
|
<p>GET EFFECT_INSTANCES |
10594 |
|
</p> |
10595 |
|
</blockquote><p> |
10596 |
|
|
10597 |
|
</p> |
10598 |
|
<p>Possible Answers: |
10599 |
|
</p> |
10600 |
|
<p> |
10601 |
|
</p> |
10602 |
|
<blockquote class="text"> |
10603 |
|
<p>The sampler will answer by returning the current |
10604 |
|
number of effect instances created and not yet |
10605 |
|
destroyed in the current sampler session. |
10606 |
|
</p> |
10607 |
|
</blockquote><p> |
10608 |
|
|
10609 |
|
</p> |
10610 |
|
<p>Examples: |
10611 |
|
</p> |
10612 |
|
<p> |
10613 |
|
</p> |
10614 |
|
<blockquote class="text"> |
10615 |
|
<p>C: "GET EFFECT_INSTANCES" |
10616 |
|
</p> |
10617 |
|
<p>S: "14" |
10618 |
|
</p> |
10619 |
|
</blockquote><p> |
10620 |
|
|
10621 |
|
</p> |
10622 |
|
<a name="LIST EFFECT_INSTANCES"></a><br /><hr /> |
10623 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10624 |
|
<a name="rfc.section.6.11.8"></a><h3>6.11.8. |
10625 |
|
Get list of effect instances</h3> |
10626 |
|
|
10627 |
|
<p>The front-end can retrieve the current list of effect |
10628 |
|
instances by sending the following command: |
10629 |
|
</p> |
10630 |
|
<p> |
10631 |
|
</p> |
10632 |
|
<blockquote class="text"> |
10633 |
|
<p>LIST EFFECT_INSTANCES |
10634 |
|
</p> |
10635 |
|
</blockquote><p> |
10636 |
|
|
10637 |
|
</p> |
10638 |
|
<p>Possible Answers: |
10639 |
|
</p> |
10640 |
|
<p> |
10641 |
|
</p> |
10642 |
|
<blockquote class="text"> |
10643 |
|
<p>The sampler will answer by returning a comma |
10644 |
|
separated list with numerical IDs of effects |
10645 |
|
instances. |
10646 |
|
|
10647 |
|
</p> |
10648 |
|
</blockquote><p> |
10649 |
|
|
10650 |
|
</p> |
10651 |
|
<p>Example: |
10652 |
|
</p> |
10653 |
|
<p> |
10654 |
|
</p> |
10655 |
|
<blockquote class="text"> |
10656 |
|
<p>C: "LIST EFFECT_INSTANCES" |
10657 |
|
</p> |
10658 |
|
<p>S: "9,11,14,15,16,17,25" |
10659 |
|
</p> |
10660 |
|
</blockquote><p> |
10661 |
|
|
10662 |
|
</p> |
10663 |
|
<a name="GET EFFECT_INSTANCE INFO"></a><br /><hr /> |
10664 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10665 |
|
<a name="rfc.section.6.11.9"></a><h3>6.11.9. |
10666 |
|
Retrieving current information about an effect instance</h3> |
10667 |
|
|
10668 |
|
<p>The front-end can ask for the current informations about |
10669 |
|
a particular effect instance by sending the following command: |
10670 |
|
</p> |
10671 |
|
<p> |
10672 |
|
</p> |
10673 |
|
<blockquote class="text"> |
10674 |
|
<p>GET EFFECT_INSTANCE INFO <effect-instance> |
10675 |
|
</p> |
10676 |
|
</blockquote><p> |
10677 |
|
|
10678 |
|
</p> |
10679 |
|
<p>Where <effect-instance> is the numerical ID of an |
10680 |
|
effect instance as returned by the |
10681 |
|
<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> |
10682 |
|
or |
10683 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
10684 |
|
command. |
10685 |
|
</p> |
10686 |
|
<p>Possible Answers: |
10687 |
|
</p> |
10688 |
|
<p> |
10689 |
|
</p> |
10690 |
|
<blockquote class="text"> |
10691 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
10692 |
|
Each answer line begins with the information |
10693 |
|
category name, followed by a colon and then a space |
10694 |
|
character <SP> and finally the info character |
10695 |
|
string to that information category. At the |
10696 |
|
moment the following categories are defined: |
10697 |
|
</p> |
10698 |
|
<p> |
10699 |
|
</p> |
10700 |
|
<blockquote class="text"> |
10701 |
|
<p>SYSTEM - |
10702 |
|
</p> |
10703 |
|
<blockquote class="text"> |
10704 |
|
<p>name of the effect plugin system |
10705 |
|
the effect is based on |
10706 |
|
(e.g. "LADSPA") |
10707 |
|
</p> |
10708 |
|
</blockquote> |
10709 |
|
|
10710 |
|
|
10711 |
|
<p>MODULE - |
10712 |
|
</p> |
10713 |
|
<blockquote class="text"> |
10714 |
|
<p>module of the effect plugin |
10715 |
|
system that contains this effect, |
10716 |
|
the module is usually the |
10717 |
|
dynamic-linked library (DLL) |
10718 |
|
filename of the effect plugin, |
10719 |
|
including full path (note that this |
10720 |
|
filename may contain |
10721 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10722 |
|
</p> |
10723 |
|
</blockquote> |
10724 |
|
|
10725 |
|
|
10726 |
|
<p>NAME - |
10727 |
|
</p> |
10728 |
|
<blockquote class="text"> |
10729 |
|
<p>character string defining the |
10730 |
|
unique name of the effect within its |
10731 |
|
module (note that the character |
10732 |
|
string may contain |
10733 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10734 |
|
</p> |
10735 |
|
</blockquote> |
10736 |
|
|
10737 |
|
|
10738 |
|
<p>DESCRIPTION - |
10739 |
|
</p> |
10740 |
|
<blockquote class="text"> |
10741 |
|
<p>human readable name of the |
10742 |
|
effect, intended to be displayed in |
10743 |
|
user interfaces (note that the |
10744 |
|
character string may contain |
10745 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10746 |
|
</p> |
10747 |
|
</blockquote> |
10748 |
|
|
10749 |
|
|
10750 |
|
<p>INPUT_CONTROLS - |
10751 |
|
</p> |
10752 |
|
<blockquote class="text"> |
10753 |
|
<p>amount of input controls the |
10754 |
|
effect instance provides, to allow |
10755 |
|
controlling the effect parameters in |
10756 |
|
realtime |
10757 |
|
</p> |
10758 |
|
</blockquote> |
10759 |
|
|
10760 |
|
|
10761 |
|
</blockquote> |
10762 |
|
|
10763 |
|
|
10764 |
|
</blockquote><p> |
10765 |
|
|
10766 |
|
</p> |
10767 |
|
<p>The mentioned fields above don't have to be in particular order. |
10768 |
|
</p> |
10769 |
|
<p>Example: |
10770 |
|
</p> |
10771 |
|
<p> |
10772 |
|
</p> |
10773 |
|
<blockquote class="text"> |
10774 |
|
<p>C: "GET EFFECT_INSTANCE INFO 3" |
10775 |
|
</p> |
10776 |
|
<p>S: "SYSTEM: LADSPA" |
10777 |
|
</p> |
10778 |
|
<p> "MODULE: /usr/lib/ladspa/mod_delay_1419.so" |
10779 |
|
</p> |
10780 |
|
<p> "NAME: modDelay" |
10781 |
|
</p> |
10782 |
|
<p> "DESCRIPTION: Modulatable delay" |
10783 |
|
</p> |
10784 |
|
<p> "INPUT_CONTROLS: 1" |
10785 |
|
</p> |
10786 |
|
<p> "." |
10787 |
|
</p> |
10788 |
|
</blockquote><p> |
10789 |
|
|
10790 |
|
</p> |
10791 |
|
<a name="GET EFFECT_INSTANCE_INPUT_CONTROL INFO"></a><br /><hr /> |
10792 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10793 |
|
<a name="rfc.section.6.11.10"></a><h3>6.11.10. |
10794 |
|
Retrieving information about an effect parameter</h3> |
10795 |
|
|
10796 |
|
<p>Effects typically provide a certain set of effect |
10797 |
|
parameters which can be altered by the user in realtime |
10798 |
|
(e.g. depth of a reverb effect, duration of a delay effect, |
10799 |
|
dry / wet signal ratio). Those controllable effect parameters |
10800 |
|
are called "input controls". The front-end can ask for the |
10801 |
|
current informations of an effect instance's input control |
10802 |
|
by sending the following command: |
10803 |
|
</p> |
10804 |
|
<p> |
10805 |
|
</p> |
10806 |
|
<blockquote class="text"> |
10807 |
|
<p>GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-control> |
10808 |
|
</p> |
10809 |
|
</blockquote><p> |
10810 |
|
|
10811 |
|
</p> |
10812 |
|
<p>Where <effect-instance> is the numerical ID of an |
10813 |
|
effect instance as returned by the |
10814 |
|
<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> |
10815 |
|
or |
10816 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
10817 |
|
command and <input-control> is the index of the input |
10818 |
|
control within the numerical bounds as returned by the |
10819 |
|
"INPUT_CONTROLS" field of the |
10820 |
|
<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> |
10821 |
|
command. |
10822 |
|
</p> |
10823 |
|
<p>Possible Answers: |
10824 |
|
</p> |
10825 |
|
<p> |
10826 |
|
</p> |
10827 |
|
<blockquote class="text"> |
10828 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
10829 |
|
Each answer line begins with the information |
10830 |
|
category name, followed by a colon and then a space |
10831 |
|
character <SP> and finally the info character |
10832 |
|
string to that information category. There are |
10833 |
|
information categories which are always returned, |
10834 |
|
independent of the respective effect parameter and |
10835 |
|
there are optional information categories |
10836 |
|
which are only shown for certain effect parameters. |
10837 |
|
At the moment the following categories are defined: |
10838 |
|
</p> |
10839 |
|
<p> |
10840 |
|
</p> |
10841 |
|
<blockquote class="text"> |
10842 |
|
<p>DESCRIPTION - |
10843 |
|
</p> |
10844 |
|
<blockquote class="text"> |
10845 |
|
<p>(always returned) |
10846 |
|
human readable name of the |
10847 |
|
effect parameter, intended to be |
10848 |
|
displayed in user interfaces (note |
10849 |
|
that the character string may |
10850 |
|
contain <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10851 |
|
</p> |
10852 |
|
</blockquote> |
10853 |
|
|
10854 |
|
|
10855 |
|
<p>VALUE - |
10856 |
|
</p> |
10857 |
|
<blockquote class="text"> |
10858 |
|
<p> |
10859 |
|
(always returned) |
10860 |
|
current (optional dotted) |
10861 |
|
floating point value of this effect |
10862 |
|
parameter |
10863 |
|
</p> |
10864 |
|
</blockquote> |
10865 |
|
|
10866 |
|
|
10867 |
|
<p>RANGE_MIN - |
10868 |
|
</p> |
10869 |
|
<blockquote class="text"> |
10870 |
|
<p> |
10871 |
|
(optionally returned) |
10872 |
|
minimum allowed value for this |
10873 |
|
effect parameter |
10874 |
|
</p> |
10875 |
|
</blockquote> |
10876 |
|
|
10877 |
|
|
10878 |
|
<p>RANGE_MAX - |
10879 |
|
</p> |
10880 |
|
<blockquote class="text"> |
10881 |
|
<p> |
10882 |
|
(optionally returned) |
10883 |
|
maximum allowed value for this |
10884 |
|
effect parameter |
10885 |
|
</p> |
10886 |
|
</blockquote> |
10887 |
|
|
10888 |
|
|
10889 |
|
<p>POSSIBILITIES - |
10890 |
|
</p> |
10891 |
|
<blockquote class="text"> |
10892 |
|
<p> |
10893 |
|
(optionally returned) |
10894 |
|
comma separated list of |
10895 |
|
(optional dotted) floating point |
10896 |
|
numbers, reflecting the exact set of |
10897 |
|
possible values for this effect |
10898 |
|
parameter |
10899 |
|
</p> |
10900 |
|
</blockquote> |
10901 |
|
|
10902 |
|
|
10903 |
|
<p>DEFAULT - |
10904 |
|
</p> |
10905 |
|
<blockquote class="text"> |
10906 |
|
<p> |
10907 |
|
(optionally returned) |
10908 |
|
default value of this effect |
10909 |
|
parameter |
10910 |
|
</p> |
10911 |
|
</blockquote> |
10912 |
|
|
10913 |
|
|
10914 |
|
</blockquote> |
10915 |
|
|
10916 |
|
|
10917 |
|
</blockquote><p> |
10918 |
|
|
10919 |
|
</p> |
10920 |
|
<p>The mentioned fields above don't have to be in particular order. |
10921 |
|
</p> |
10922 |
|
<p>Example: |
10923 |
|
</p> |
10924 |
|
<p> |
10925 |
|
</p> |
10926 |
|
<blockquote class="text"> |
10927 |
|
<p>C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0" |
10928 |
|
</p> |
10929 |
|
<p>S: "DESCRIPTION: Base delay (s)" |
10930 |
|
</p> |
10931 |
|
<p> "VALUE: 0.500" |
10932 |
|
</p> |
10933 |
|
<p> "RANGE_MIN: 0.000" |
10934 |
|
</p> |
10935 |
|
<p> "." |
10936 |
|
</p> |
10937 |
|
</blockquote><p> |
10938 |
|
|
10939 |
|
</p> |
10940 |
|
<a name="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE"></a><br /><hr /> |
10941 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10942 |
|
<a name="rfc.section.6.11.11"></a><h3>6.11.11. |
10943 |
|
Altering an effect parameter</h3> |
10944 |
|
|
10945 |
|
<p>The front-end can alter the current value of an effect |
10946 |
|
parameter by sending the following command: |
10947 |
|
</p> |
10948 |
|
<p> |
10949 |
|
</p> |
10950 |
|
<blockquote class="text"> |
10951 |
|
<p>SET EFFECT_INSTANCE_INPUT_CONTROL VALUE <effect-instance> <input-control> <value> |
10952 |
|
</p> |
10953 |
|
</blockquote><p> |
10954 |
|
|
10955 |
|
</p> |
10956 |
|
<p>Where <effect-instance> is the numerical ID of the |
10957 |
|
effect instance as returned by the |
10958 |
|
<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 |
10959 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
10960 |
|
command, <input-control> is the index of the input |
10961 |
|
control within the numerical bounds as returned by the |
10962 |
|
"INPUT_CONTROLS" field of the |
10963 |
|
<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> |
10964 |
|
command and <value> is the new (optional dotted) |
10965 |
|
floating point value for this effect parameter. |
10966 |
|
</p> |
10967 |
|
<p>Possible Answers: |
10968 |
|
</p> |
10969 |
|
<p> |
10970 |
|
</p> |
10971 |
|
<blockquote class="text"> |
10972 |
|
<p>"OK" - |
10973 |
|
</p> |
10974 |
|
<blockquote class="text"> |
10975 |
|
<p>in case the effect was altered successfully |
10976 |
|
</p> |
10977 |
|
</blockquote> |
10978 |
|
|
10979 |
|
|
10980 |
|
<p>"ERR:<error-code>:<error-message>" - |
10981 |
|
</p> |
10982 |
|
<blockquote class="text"> |
10983 |
|
<p>in case it failed, providing an appropriate error code and |
10984 |
|
error message |
10985 |
|
</p> |
10986 |
|
</blockquote> |
10987 |
|
|
10988 |
|
|
10989 |
|
</blockquote><p> |
10990 |
|
|
10991 |
|
</p> |
10992 |
|
<p>Examples: |
10993 |
|
</p> |
10994 |
|
<p> |
10995 |
|
</p> |
10996 |
|
<blockquote class="text"> |
10997 |
|
<p>C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5" |
10998 |
|
</p> |
10999 |
|
<p>S: "OK" |
11000 |
|
</p> |
11001 |
|
</blockquote><p> |
11002 |
|
|
11003 |
|
</p> |
11004 |
|
<a name="GET SEND_EFFECT_CHAINS"></a><br /><hr /> |
11005 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11006 |
|
<a name="rfc.section.6.11.12"></a><h3>6.11.12. |
11007 |
|
Retrieve amount of send effect chains</h3> |
11008 |
|
|
11009 |
|
<p>The front-end can retrieve the current amount of send |
11010 |
|
effect chains of an audio output device by sending the |
11011 |
|
following command: |
11012 |
|
</p> |
11013 |
|
<p> |
11014 |
|
</p> |
11015 |
|
<blockquote class="text"> |
11016 |
|
<p>GET SEND_EFFECT_CHAINS <audio-device> |
11017 |
|
</p> |
11018 |
|
</blockquote><p> |
11019 |
|
|
11020 |
|
</p> |
11021 |
|
<p>Where <audio-device> should be replaced by the |
11022 |
|
numerical ID of the audio output device as given by the |
11023 |
|
<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> |
11024 |
|
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> |
11025 |
|
command. |
11026 |
|
</p> |
11027 |
|
<p>Possible Answers: |
11028 |
|
</p> |
11029 |
|
<p> |
11030 |
|
</p> |
11031 |
|
<blockquote class="text"> |
11032 |
|
<p>The sampler will answer by returning the current |
11033 |
|
number of send effect chains of the supplied audio |
11034 |
|
output device. |
11035 |
|
</p> |
11036 |
|
</blockquote><p> |
11037 |
|
|
11038 |
|
</p> |
11039 |
|
<p>Examples: |
11040 |
|
</p> |
11041 |
|
<p> |
11042 |
|
</p> |
11043 |
|
<blockquote class="text"> |
11044 |
|
<p>C: "GET SEND_EFFECT_CHAINS 0" |
11045 |
|
</p> |
11046 |
|
<p>S: "4" |
11047 |
|
</p> |
11048 |
|
</blockquote><p> |
11049 |
|
|
11050 |
|
</p> |
11051 |
|
<a name="LIST SEND_EFFECT_CHAINS"></a><br /><hr /> |
11052 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11053 |
|
<a name="rfc.section.6.11.13"></a><h3>6.11.13. |
11054 |
|
Retrieve list of send effect chains</h3> |
11055 |
|
|
11056 |
|
<p>The front-end can retrieve the current list of send |
11057 |
|
effect chains of an audio output device by sending the |
11058 |
|
following command: |
11059 |
|
</p> |
11060 |
|
<p> |
11061 |
|
</p> |
11062 |
|
<blockquote class="text"> |
11063 |
|
<p>LIST SEND_EFFECT_CHAINS <audio-device> |
11064 |
|
</p> |
11065 |
|
</blockquote><p> |
11066 |
|
|
11067 |
|
</p> |
11068 |
|
<p>Where <audio-device> should be replaced by the |
11069 |
|
numerical ID of the audio output device as given by the |
11070 |
|
<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> |
11071 |
|
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> |
11072 |
|
command. |
11073 |
|
</p> |
11074 |
|
<p>Possible Answers: |
11075 |
|
</p> |
11076 |
|
<p> |
11077 |
|
</p> |
11078 |
|
<blockquote class="text"> |
11079 |
|
<p>The sampler will answer by returning a comma |
11080 |
|
separated list with numerical IDs of send effect |
11081 |
|
chains of the supplied audio output device. |
11082 |
|
|
11083 |
|
</p> |
11084 |
|
</blockquote><p> |
11085 |
|
|
11086 |
|
</p> |
11087 |
|
<p>Examples: |
11088 |
|
</p> |
11089 |
|
<p> |
11090 |
|
</p> |
11091 |
|
<blockquote class="text"> |
11092 |
|
<p>C: "LIST SEND_EFFECT_CHAINS 0" |
11093 |
|
</p> |
11094 |
|
<p>S: "3,4,7" |
11095 |
|
</p> |
11096 |
|
</blockquote><p> |
11097 |
|
|
11098 |
|
</p> |
11099 |
|
<a name="ADD SEND_EFFECT_CHAIN"></a><br /><hr /> |
11100 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11101 |
|
<a name="rfc.section.6.11.14"></a><h3>6.11.14. |
11102 |
|
Add send effect chain</h3> |
11103 |
|
|
11104 |
|
<p>The front-end can add a send effect chain by sending the |
11105 |
|
following command: |
11106 |
|
</p> |
11107 |
|
<p> |
11108 |
|
</p> |
11109 |
|
<blockquote class="text"> |
11110 |
|
<p>ADD SEND_EFFECT_CHAIN <audio-device> |
11111 |
|
</p> |
11112 |
|
</blockquote><p> |
11113 |
|
|
11114 |
|
</p> |
11115 |
|
<p>Where <audio-device> should be replaced by the |
11116 |
|
numerical ID of the audio output device as given by the |
11117 |
|
<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> |
11118 |
|
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> |
11119 |
|
command. |
11120 |
|
</p> |
11121 |
|
<p>Possible Answers: |
11122 |
|
</p> |
11123 |
|
<p> |
11124 |
|
</p> |
11125 |
|
<blockquote class="text"> |
11126 |
|
<p>"OK[<effect-chain>]" - |
11127 |
|
</p> |
11128 |
|
<blockquote class="text"> |
11129 |
|
<p>in case the send effect chain was |
11130 |
|
added successfully, where |
11131 |
|
<effect-chain> is the numerical ID |
11132 |
|
of the new send effect chain |
11133 |
|
</p> |
11134 |
|
</blockquote> |
11135 |
|
|
11136 |
|
|
11137 |
|
<p>"ERR:<error-code>:<error-message>" - |
11138 |
|
</p> |
11139 |
|
<blockquote class="text"> |
11140 |
|
<p>if the send effect chain could not be added |
11141 |
|
</p> |
11142 |
|
</blockquote> |
11143 |
|
|
11144 |
|
|
11145 |
|
</blockquote><p> |
11146 |
|
|
11147 |
|
</p> |
11148 |
|
<p>Examples: |
11149 |
|
</p> |
11150 |
|
<p> |
11151 |
|
</p> |
11152 |
|
<blockquote class="text"> |
11153 |
|
<p>C: "ADD SEND_EFFECT_CHAIN 0" |
11154 |
|
</p> |
11155 |
|
<p>S: "OK[2]" |
11156 |
|
</p> |
11157 |
|
</blockquote><p> |
11158 |
|
|
11159 |
|
</p> |
11160 |
|
<a name="REMOVE SEND_EFFECT_CHAIN"></a><br /><hr /> |
11161 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11162 |
|
<a name="rfc.section.6.11.15"></a><h3>6.11.15. |
11163 |
|
Remove send effect chain</h3> |
11164 |
|
|
11165 |
|
<p>The front-end can remove a send effect chain by sending |
11166 |
|
the following command: |
11167 |
|
</p> |
11168 |
|
<p> |
11169 |
|
</p> |
11170 |
|
<blockquote class="text"> |
11171 |
|
<p>REMOVE SEND_EFFECT_CHAIN <audio-device> <effect-chain> |
11172 |
|
</p> |
11173 |
|
</blockquote><p> |
11174 |
|
|
11175 |
|
</p> |
11176 |
|
<p>Where <audio-device> should be replaced by the |
11177 |
|
numerical ID of the audio output device as given by the |
11178 |
|
<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> |
11179 |
|
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> |
11180 |
|
command and <effect-chain> by the numerical ID as |
11181 |
|
returned by the |
11182 |
|
<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> |
11183 |
|
or |
11184 |
|
<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> |
11185 |
|
command. |
11186 |
|
</p> |
11187 |
|
<p>Possible Answers: |
11188 |
|
</p> |
11189 |
|
<p> |
11190 |
|
</p> |
11191 |
|
<blockquote class="text"> |
11192 |
|
<p>"OK" - |
11193 |
|
</p> |
11194 |
|
<blockquote class="text"> |
11195 |
|
<p>in case the send effect chain was |
11196 |
|
removed successfully |
11197 |
|
</p> |
11198 |
|
</blockquote> |
11199 |
|
|
11200 |
|
|
11201 |
|
<p>"ERR:<error-code>:<error-message>" - |
11202 |
|
</p> |
11203 |
|
<blockquote class="text"> |
11204 |
|
<p>if the send effect chain could not be removed |
11205 |
|
</p> |
11206 |
|
</blockquote> |
11207 |
|
|
11208 |
|
|
11209 |
|
</blockquote><p> |
11210 |
|
|
11211 |
|
</p> |
11212 |
|
<p>Examples: |
11213 |
|
</p> |
11214 |
|
<p> |
11215 |
|
</p> |
11216 |
|
<blockquote class="text"> |
11217 |
|
<p>C: "REMOVE SEND_EFFECT_CHAIN 0 2" |
11218 |
|
</p> |
11219 |
|
<p>S: "OK" |
11220 |
|
</p> |
11221 |
|
</blockquote><p> |
11222 |
|
|
11223 |
|
</p> |
11224 |
|
<a name="GET SEND_EFFECT_CHAIN INFO"></a><br /><hr /> |
11225 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11226 |
|
<a name="rfc.section.6.11.16"></a><h3>6.11.16. |
11227 |
|
Retrieving information about a send effect chain</h3> |
11228 |
|
|
11229 |
|
<p>The front-end can ask for informations of a send effect |
11230 |
|
chain by sending the following command: |
11231 |
|
</p> |
11232 |
|
<p> |
11233 |
|
</p> |
11234 |
|
<blockquote class="text"> |
11235 |
|
<p>GET SEND_EFFECT_CHAIN INFO <audio-device> <effect-chain> |
11236 |
|
</p> |
11237 |
|
</blockquote><p> |
11238 |
|
|
11239 |
|
</p> |
11240 |
|
<p>Where <audio-device> should be replaced by the |
11241 |
|
numerical ID of the audio output device as given by the |
11242 |
|
<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> |
11243 |
|
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> |
11244 |
|
command and <effect-chain> by the numerical ID as |
11245 |
|
returned by the |
11246 |
|
<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> |
11247 |
|
or |
11248 |
|
<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> |
11249 |
|
command. |
11250 |
|
</p> |
11251 |
|
<p>Possible Answers: |
11252 |
|
</p> |
11253 |
|
<p> |
11254 |
|
</p> |
11255 |
|
<blockquote class="text"> |
11256 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
11257 |
|
Each answer line begins with the information |
11258 |
|
category name, followed by a colon and then a space |
11259 |
|
character <SP> and finally the info character |
11260 |
|
string to that information category. |
11261 |
|
At the moment the following categories are defined: |
11262 |
|
</p> |
11263 |
|
<p> |
11264 |
|
</p> |
11265 |
|
<blockquote class="text"> |
11266 |
|
<p>EFFECT_COUNT - |
11267 |
|
</p> |
11268 |
|
<blockquote class="text"> |
11269 |
|
<p>amount of effects in this send |
11270 |
|
effect chain |
11271 |
|
</p> |
11272 |
|
</blockquote> |
11273 |
|
|
11274 |
|
|
11275 |
|
<p>EFFECT_SEQUENCE - |
11276 |
|
</p> |
11277 |
|
<blockquote class="text"> |
11278 |
|
<p>comma separated list of the |
11279 |
|
numerical IDs of the effect |
11280 |
|
instances in this send effect chain, |
11281 |
|
in the order as they are procssed in |
11282 |
|
the effect chain |
11283 |
|
</p> |
11284 |
|
</blockquote> |
11285 |
|
|
11286 |
|
|
11287 |
|
</blockquote> |
11288 |
|
|
11289 |
|
|
11290 |
|
</blockquote><p> |
11291 |
|
|
11292 |
|
</p> |
11293 |
|
<p>The mentioned fields above don't have to be in particular order. |
11294 |
|
</p> |
11295 |
|
<p>Example: |
11296 |
|
</p> |
11297 |
|
<p> |
11298 |
|
</p> |
11299 |
|
<blockquote class="text"> |
11300 |
|
<p>C: "GET SEND_EFFECT_CHAIN INFO 0 2" |
11301 |
|
</p> |
11302 |
|
<p>S: "EFFECT_COUNT: 3" |
11303 |
|
</p> |
11304 |
|
<p> "EFFECT_SEQUENCE: 31,4,7" |
11305 |
|
</p> |
11306 |
|
<p> "." |
11307 |
|
</p> |
11308 |
|
</blockquote><p> |
11309 |
|
|
11310 |
|
</p> |
11311 |
|
<a name="APPEND SEND_EFFECT_CHAIN EFFECT"></a><br /><hr /> |
11312 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11313 |
|
<a name="rfc.section.6.11.17"></a><h3>6.11.17. |
11314 |
|
Append effect instance to a send effect chain</h3> |
11315 |
|
|
11316 |
|
<p>The front-end can add an unused effect instance to the |
11317 |
|
end of a send effect chain by sending the following command: |
11318 |
|
</p> |
11319 |
|
<p> |
11320 |
|
</p> |
11321 |
|
<blockquote class="text"> |
11322 |
|
<p>APPEND SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <effect-instance> |
11323 |
|
</p> |
11324 |
|
</blockquote><p> |
11325 |
|
|
11326 |
|
</p> |
11327 |
|
<p>Where <audio-device> should be replaced by the |
11328 |
|
numerical ID of the audio output device as given by the |
11329 |
|
<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> |
11330 |
|
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> |
11331 |
|
command and <effect-chain> by the numerical ID as |
11332 |
|
returned by the |
11333 |
|
<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> |
11334 |
|
or |
11335 |
|
<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> |
11336 |
|
command and <effect-instance> as returned by the |
11337 |
|
<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 |
11338 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
11339 |
|
command. |
11340 |
|
</p> |
11341 |
|
<p>Only unused effect instances can be added to the effect |
11342 |
|
chain. Trying to add an effect instance which is already in |
11343 |
|
use somewhere in the audio signal path of the sampler will |
11344 |
|
result in an error. |
11345 |
|
</p> |
11346 |
|
<p>Possible Answers: |
11347 |
|
</p> |
11348 |
|
<p> |
11349 |
|
</p> |
11350 |
|
<blockquote class="text"> |
11351 |
|
<p>"OK" - |
11352 |
|
</p> |
11353 |
|
<blockquote class="text"> |
11354 |
|
<p>in case the effect instance was |
11355 |
|
added successfully to the chain |
11356 |
|
</p> |
11357 |
|
</blockquote> |
11358 |
|
|
11359 |
|
|
11360 |
|
<p>"ERR:<error-code>:<error-message>" - |
11361 |
|
</p> |
11362 |
|
<blockquote class="text"> |
11363 |
|
<p>if the effect instance could not be added |
11364 |
|
</p> |
11365 |
|
</blockquote> |
11366 |
|
|
11367 |
|
|
11368 |
|
</blockquote><p> |
11369 |
|
|
11370 |
|
</p> |
11371 |
|
<p>Examples: |
11372 |
|
</p> |
11373 |
|
<p> |
11374 |
|
</p> |
11375 |
|
<blockquote class="text"> |
11376 |
|
<p>C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38" |
11377 |
|
</p> |
11378 |
|
<p>S: "OK" |
11379 |
|
</p> |
11380 |
|
</blockquote><p> |
11381 |
|
|
11382 |
|
</p> |
11383 |
|
<a name="INSERT SEND_EFFECT_CHAIN EFFECT"></a><br /><hr /> |
11384 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11385 |
|
<a name="rfc.section.6.11.18"></a><h3>6.11.18. |
11386 |
|
Insert effect instance to a send effect chain</h3> |
11387 |
|
|
11388 |
|
<p>The front-end can add an unused effect instance to a |
11389 |
|
certain position of a send effect chain by sending the |
11390 |
|
following command: |
11391 |
|
</p> |
11392 |
|
<p> |
11393 |
|
</p> |
11394 |
|
<blockquote class="text"> |
11395 |
|
<p>INSERT SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos> <effect-instance> |
11396 |
|
</p> |
11397 |
|
</blockquote><p> |
11398 |
|
|
11399 |
|
</p> |
11400 |
|
<p>Where <audio-device> should be replaced by the |
11401 |
|
numerical ID of the audio output device as given by the |
11402 |
|
<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> |
11403 |
|
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> |
11404 |
|
command, <effect-chain> by the numerical ID as |
11405 |
|
returned by the |
11406 |
|
<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> |
11407 |
|
or |
11408 |
|
<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> |
11409 |
|
command, <effect-instance> as returned by the |
11410 |
|
<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 |
11411 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
11412 |
|
command and <chain-pos> the exact position of the |
11413 |
|
effect chain where the supplied effect shall be inserted |
11414 |
|
to. |
11415 |
|
</p> |
11416 |
|
<p>Only unused effect instances can be added to the effect |
11417 |
|
chain. Trying to add an effect instance which is already in |
11418 |
|
use somewhere in the audio signal path of the sampler will |
11419 |
|
result in an error. |
11420 |
|
</p> |
11421 |
|
<p>Possible Answers: |
11422 |
|
</p> |
11423 |
|
<p> |
11424 |
|
</p> |
11425 |
|
<blockquote class="text"> |
11426 |
|
<p>"OK" - |
11427 |
|
</p> |
11428 |
|
<blockquote class="text"> |
11429 |
|
<p>in case the effect instance was |
11430 |
|
added successfully to the chain |
11431 |
|
</p> |
11432 |
|
</blockquote> |
11433 |
|
|
11434 |
|
|
11435 |
|
<p>"ERR:<error-code>:<error-message>" - |
11436 |
|
</p> |
11437 |
|
<blockquote class="text"> |
11438 |
|
<p>if the effect instance could not be added |
11439 |
|
</p> |
11440 |
|
</blockquote> |
11441 |
|
|
11442 |
|
|
11443 |
|
</blockquote><p> |
11444 |
|
|
11445 |
|
</p> |
11446 |
|
<p>Examples: |
11447 |
|
</p> |
11448 |
|
<p> |
11449 |
|
</p> |
11450 |
|
<blockquote class="text"> |
11451 |
|
<p>C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38" |
11452 |
|
</p> |
11453 |
|
<p>S: "OK" |
11454 |
|
</p> |
11455 |
|
</blockquote><p> |
11456 |
|
|
11457 |
|
</p> |
11458 |
|
<a name="REMOVE SEND_EFFECT_CHAIN EFFECT"></a><br /><hr /> |
11459 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11460 |
|
<a name="rfc.section.6.11.19"></a><h3>6.11.19. |
11461 |
|
Remove effect instance from send effect chain</h3> |
11462 |
|
|
11463 |
|
<p>The front-end can remove an effect instance from a |
11464 |
|
certain position of a send effect chain by sending the |
11465 |
|
following command: |
11466 |
|
</p> |
11467 |
|
<p> |
11468 |
|
</p> |
11469 |
|
<blockquote class="text"> |
11470 |
|
<p>REMOVE SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos> |
11471 |
|
</p> |
11472 |
|
</blockquote><p> |
11473 |
|
|
11474 |
|
</p> |
11475 |
|
<p>Where <audio-device> should be replaced by the |
11476 |
|
numerical ID of the audio output device as given by the |
11477 |
|
<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> |
11478 |
|
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> |
11479 |
|
command, <effect-chain> by the numerical ID as |
11480 |
|
returned by the |
11481 |
|
<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> |
11482 |
|
or |
11483 |
|
<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> |
11484 |
|
command and <chain-pos> the exact position of the |
11485 |
|
effect instance to be removed from the effect chain. |
11486 |
|
</p> |
11487 |
|
<p>Possible Answers: |
11488 |
|
</p> |
11489 |
|
<p> |
11490 |
|
</p> |
11491 |
|
<blockquote class="text"> |
11492 |
|
<p>"OK" - |
11493 |
|
</p> |
11494 |
|
<blockquote class="text"> |
11495 |
|
<p>in case the effect instance was |
11496 |
|
removed successfully |
11497 |
|
</p> |
11498 |
|
</blockquote> |
11499 |
|
|
11500 |
|
|
11501 |
|
<p>"ERR:<error-code>:<error-message>" - |
11502 |
|
</p> |
11503 |
|
<blockquote class="text"> |
11504 |
|
<p>if the effect instance could not be removed |
11505 |
|
</p> |
11506 |
|
</blockquote> |
11507 |
|
|
11508 |
|
|
11509 |
|
</blockquote><p> |
11510 |
|
|
11511 |
|
</p> |
11512 |
|
<p>Examples: |
11513 |
|
</p> |
11514 |
|
<p> |
11515 |
|
</p> |
11516 |
|
<blockquote class="text"> |
11517 |
|
<p>C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4" |
11518 |
|
</p> |
11519 |
|
<p>S: "OK" |
11520 |
|
</p> |
11521 |
|
</blockquote><p> |
11522 |
|
|
11523 |
|
</p> |
11524 |
<a name="command_syntax"></a><br /><hr /> |
<a name="command_syntax"></a><br /><hr /> |
11525 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11526 |
<a name="rfc.section.7"></a><h3>7. |
<a name="rfc.section.7"></a><h3>7. |
11640 |
|
|
11641 |
</p> |
</p> |
11642 |
<p>/ FORMAT SP format_instruction |
<p>/ FORMAT SP format_instruction |
11643 |
|
|
11644 |
|
</p> |
11645 |
|
<p>/ SEND SP send_instruction |
11646 |
|
|
11647 |
|
</p> |
11648 |
|
<p>/ APPEND SP append_instruction |
11649 |
|
|
11650 |
</p> |
</p> |
11651 |
<p>SEND SP send_instruction |
<p>/ INSERT SP insert_instruction |
11652 |
|
|
11653 |
</p> |
</p> |
11654 |
<p>/ RESET |
<p>/ RESET |
11672 |
<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 |
11673 |
|
|
11674 |
</p> |
</p> |
11675 |
|
<p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
11676 |
|
|
11677 |
|
</p> |
11678 |
<p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
<p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
11679 |
|
|
11680 |
</p> |
</p> |
11681 |
|
<p>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
11682 |
|
|
11683 |
|
</p> |
11684 |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
11685 |
|
|
11686 |
</p> |
</p> |
11699 |
<p>/ MIDI_INSTRUMENT_MAP SP map_name |
<p>/ MIDI_INSTRUMENT_MAP SP map_name |
11700 |
|
|
11701 |
</p> |
</p> |
11702 |
|
<p>/ SEND_EFFECT_CHAIN SP device_index |
11703 |
|
|
11704 |
|
</p> |
11705 |
</blockquote><p> |
</blockquote><p> |
11706 |
|
|
11707 |
</p> |
</p> |
11912 |
<p>/ MIDI_INSTRUMENT_MAP SP ALL |
<p>/ MIDI_INSTRUMENT_MAP SP ALL |
11913 |
|
|
11914 |
</p> |
</p> |
11915 |
|
<p>/ SEND_EFFECT_CHAIN SP device_index SP effect_chain |
11916 |
|
|
11917 |
|
</p> |
11918 |
|
<p>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos |
11919 |
|
|
11920 |
|
</p> |
11921 |
|
<p>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id |
11922 |
|
|
11923 |
|
</p> |
11924 |
<p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
<p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
11925 |
|
|
11926 |
</p> |
</p> |
11939 |
<p>AVAILABLE_ENGINES |
<p>AVAILABLE_ENGINES |
11940 |
|
|
11941 |
</p> |
</p> |
11942 |
|
<p>/ AVAILABLE_EFFECTS |
11943 |
|
|
11944 |
|
</p> |
11945 |
|
<p>/ EFFECT_INSTANCES |
11946 |
|
|
11947 |
|
</p> |
11948 |
|
<p>/ EFFECT SP INFO SP effect_index |
11949 |
|
|
11950 |
|
</p> |
11951 |
|
<p>/ EFFECT_INSTANCE SP INFO SP effect_instance |
11952 |
|
|
11953 |
|
</p> |
11954 |
|
<p>/ EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP input_control |
11955 |
|
|
11956 |
|
</p> |
11957 |
|
<p>/ SEND_EFFECT_CHAINS SP device_index |
11958 |
|
|
11959 |
|
</p> |
11960 |
|
<p>/ SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain |
11961 |
|
|
11962 |
|
</p> |
11963 |
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS |
11964 |
|
|
11965 |
</p> |
</p> |
12083 |
<p>/ VOLUME |
<p>/ VOLUME |
12084 |
|
|
12085 |
</p> |
</p> |
12086 |
|
<p>/ VOICES |
12087 |
|
|
12088 |
|
</p> |
12089 |
|
<p>/ STREAMS |
12090 |
|
|
12091 |
|
</p> |
12092 |
<p>/ FILE SP INSTRUMENTS SP filename |
<p>/ FILE SP INSTRUMENTS SP filename |
12093 |
|
|
12094 |
</p> |
</p> |
12116 |
<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 |
12117 |
|
|
12118 |
</p> |
</p> |
12119 |
|
<p>/ EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP input_control SP control_value |
12120 |
|
|
12121 |
|
</p> |
12122 |
<p>/ CHANNEL SP set_chan_instruction |
<p>/ CHANNEL SP set_chan_instruction |
12123 |
|
|
12124 |
</p> |
</p> |
12137 |
<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 |
12138 |
|
|
12139 |
</p> |
</p> |
12140 |
|
<p>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos |
12141 |
|
|
12142 |
|
</p> |
12143 |
<p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
<p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
12144 |
|
|
12145 |
</p> |
</p> |
12161 |
<p>/ VOLUME SP volume_value |
<p>/ VOLUME SP volume_value |
12162 |
|
|
12163 |
</p> |
</p> |
12164 |
|
<p>/ VOICES SP number |
12165 |
|
|
12166 |
|
</p> |
12167 |
|
<p>/ STREAMS SP number |
12168 |
|
|
12169 |
|
</p> |
12170 |
</blockquote><p> |
</blockquote><p> |
12171 |
|
|
12172 |
</p> |
</p> |
12191 |
<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 |
12192 |
|
|
12193 |
</p> |
</p> |
12194 |
|
<p>/ EFFECT_INSTANCE SP effect_index |
12195 |
|
|
12196 |
|
</p> |
12197 |
|
<p>/ EFFECT_INSTANCE SP effect_system SP module SP effect_name |
12198 |
|
|
12199 |
|
</p> |
12200 |
</blockquote><p> |
</blockquote><p> |
12201 |
|
|
12202 |
</p> |
</p> |
12278 |
<p>/ FX_SEND SP sampler_channel SP fx_send_id |
<p>/ FX_SEND SP sampler_channel SP fx_send_id |
12279 |
|
|
12280 |
</p> |
</p> |
12281 |
|
<p>/ EFFECT_INSTANCE SP number |
12282 |
|
|
12283 |
|
</p> |
12284 |
</blockquote><p> |
</blockquote><p> |
12285 |
|
|
12286 |
</p> |
</p> |
12296 |
</blockquote><p> |
</blockquote><p> |
12297 |
|
|
12298 |
</p> |
</p> |
12299 |
|
<p>append_instruction = |
12300 |
|
</p> |
12301 |
|
<blockquote class="text"> |
12302 |
|
<p>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP effect_instance |
12303 |
|
|
12304 |
|
</p> |
12305 |
|
</blockquote><p> |
12306 |
|
|
12307 |
|
</p> |
12308 |
|
<p>insert_instruction = |
12309 |
|
</p> |
12310 |
|
<blockquote class="text"> |
12311 |
|
<p>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos SP effect_instance |
12312 |
|
|
12313 |
|
</p> |
12314 |
|
</blockquote><p> |
12315 |
|
|
12316 |
|
</p> |
12317 |
<p>set_chan_instruction = |
<p>set_chan_instruction = |
12318 |
</p> |
</p> |
12319 |
<blockquote class="text"> |
<blockquote class="text"> |
12431 |
<p>/ AVAILABLE_ENGINES |
<p>/ AVAILABLE_ENGINES |
12432 |
|
|
12433 |
</p> |
</p> |
12434 |
|
<p>/ AVAILABLE_EFFECTS |
12435 |
|
|
12436 |
|
</p> |
12437 |
|
<p>/ EFFECT_INSTANCES |
12438 |
|
|
12439 |
|
</p> |
12440 |
|
<p>/ SEND_EFFECT_CHAINS SP number |
12441 |
|
|
12442 |
|
</p> |
12443 |
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS |
12444 |
|
|
12445 |
</p> |
</p> |
12521 |
</blockquote><p> |
</blockquote><p> |
12522 |
|
|
12523 |
</p> |
</p> |
12524 |
|
<p>effect_instance = |
12525 |
|
</p> |
12526 |
|
<blockquote class="text"> |
12527 |
|
<p>number |
12528 |
|
|
12529 |
|
</p> |
12530 |
|
</blockquote><p> |
12531 |
|
|
12532 |
|
</p> |
12533 |
<p>device_index = |
<p>device_index = |
12534 |
</p> |
</p> |
12535 |
<blockquote class="text"> |
<blockquote class="text"> |
12635 |
</blockquote><p> |
</blockquote><p> |
12636 |
|
|
12637 |
</p> |
</p> |
12638 |
|
<p>control_value = |
12639 |
|
</p> |
12640 |
|
<blockquote class="text"> |
12641 |
|
<p>real |
12642 |
|
|
12643 |
|
</p> |
12644 |
|
</blockquote><p> |
12645 |
|
|
12646 |
|
</p> |
12647 |
<p>sampler_channel = |
<p>sampler_channel = |
12648 |
</p> |
</p> |
12649 |
<blockquote class="text"> |
<blockquote class="text"> |
12725 |
</blockquote><p> |
</blockquote><p> |
12726 |
|
|
12727 |
</p> |
</p> |
12728 |
|
<p>effect_name = |
12729 |
|
</p> |
12730 |
|
<blockquote class="text"> |
12731 |
|
<p>stringval_escaped |
12732 |
|
|
12733 |
|
</p> |
12734 |
|
</blockquote><p> |
12735 |
|
|
12736 |
|
</p> |
12737 |
|
<p>effect_index = |
12738 |
|
</p> |
12739 |
|
<blockquote class="text"> |
12740 |
|
<p>number |
12741 |
|
|
12742 |
|
</p> |
12743 |
|
</blockquote><p> |
12744 |
|
|
12745 |
|
</p> |
12746 |
|
<p>effect_chain = |
12747 |
|
</p> |
12748 |
|
<blockquote class="text"> |
12749 |
|
<p>number |
12750 |
|
|
12751 |
|
</p> |
12752 |
|
</blockquote><p> |
12753 |
|
|
12754 |
|
</p> |
12755 |
|
<p>chain_pos = |
12756 |
|
</p> |
12757 |
|
<blockquote class="text"> |
12758 |
|
<p>number |
12759 |
|
|
12760 |
|
</p> |
12761 |
|
</blockquote><p> |
12762 |
|
|
12763 |
|
</p> |
12764 |
|
<p>input_control = |
12765 |
|
</p> |
12766 |
|
<blockquote class="text"> |
12767 |
|
<p>number |
12768 |
|
|
12769 |
|
</p> |
12770 |
|
</blockquote><p> |
12771 |
|
|
12772 |
|
</p> |
12773 |
<p>param_val_list = |
<p>param_val_list = |
12774 |
</p> |
</p> |
12775 |
<blockquote class="text"> |
<blockquote class="text"> |
12839 |
</blockquote><p> |
</blockquote><p> |
12840 |
|
|
12841 |
</p> |
</p> |
12842 |
|
<p>effect_system = |
12843 |
|
</p> |
12844 |
|
<blockquote class="text"> |
12845 |
|
<p>string |
12846 |
|
|
12847 |
|
</p> |
12848 |
|
</blockquote><p> |
12849 |
|
|
12850 |
|
</p> |
12851 |
|
<p>module = |
12852 |
|
</p> |
12853 |
|
<blockquote class="text"> |
12854 |
|
<p>filename |
12855 |
|
|
12856 |
|
</p> |
12857 |
|
</blockquote><p> |
12858 |
|
|
12859 |
|
</p> |
12860 |
<a name="character_set"></a><br /><hr /> |
<a name="character_set"></a><br /><hr /> |
12861 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
12862 |
<a name="rfc.section.7.1"></a><h3>7.1. |
<a name="rfc.section.7.1"></a><h3>7.1. |
12914 |
<td align="left">two digit hex ASCII code of the character</td> |
<td align="left">two digit hex ASCII code of the character</td> |
12915 |
</tr> |
</tr> |
12916 |
</table> |
</table> |
12917 |
|
<br clear="all" /> |
12918 |
|
|
12919 |
<p>Notice: due to the transition of certain parts of the |
<p>Notice: due to the transition of certain parts of the |
12920 |
protocol which now support escape sequences, a slight backward |
protocol which now support escape sequences, a slight backward |
12987 |
</p> |
</p> |
12988 |
<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> |
12989 |
</p> |
</p> |
12990 |
|
<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> |
12991 |
|
</p> |
12992 |
|
<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> |
12993 |
|
</p> |
12994 |
|
<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> |
12995 |
|
</p> |
12996 |
</blockquote><p> |
</blockquote><p> |
12997 |
Note that the forward slash character ('/') has a special meaning in |
Note that the forward slash character ('/') has a special meaning in |
12998 |
filename / path based arguments: it acts as separator of the nodes in |
filename / path based arguments: it acts as separator of the nodes in |
13057 |
</p> |
</p> |
13058 |
<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> |
13059 |
</p> |
</p> |
13060 |
|
<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> |
13061 |
|
</p> |
13062 |
|
<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> |
13063 |
|
</p> |
13064 |
|
<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> |
13065 |
|
</p> |
13066 |
</blockquote><p> |
</blockquote><p> |
13067 |
Please note that these lists are manually maintained. If you |
Please note that these lists are manually maintained. If you |
13068 |
find a command that also supports escape sequences we forgot to |
find a command that also supports escape sequences we forgot to |
13700 |
new global volume parameter. |
new global volume parameter. |
13701 |
</p> |
</p> |
13702 |
</blockquote><p> |
</blockquote><p> |
13703 |
|
</p> |
13704 |
|
<blockquote class="text"> |
13705 |
|
<p>"NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the |
13706 |
|
golbal limit of the sampler for maximum voices is changed, where |
13707 |
|
<max-voices> will be an integer value, reflecting the |
13708 |
|
new global voice limit parameter. |
13709 |
|
</p> |
13710 |
|
</blockquote><p> |
13711 |
|
</p> |
13712 |
|
<blockquote class="text"> |
13713 |
|
<p>"NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the |
13714 |
|
golbal limit of the sampler for maximum disk streams is changed, where |
13715 |
|
<max-streams> will be an integer value, reflecting the |
13716 |
|
new global disk streams limit parameter. |
13717 |
|
</p> |
13718 |
|
</blockquote><p> |
13719 |
|
|
13720 |
</p> |
</p> |
13721 |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
13977 |
<h3>11. References</h3> |
<h3>11. References</h3> |
13978 |
<table width="99%" border="0"> |
<table width="99%" border="0"> |
13979 |
<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> |
13980 |
<td class="author-text">UCLA, “<a href="ftp://ftp.isi.edu/in-notes/rfc20.txt">ASCII format for Network Interchange</a>,” RFC 20, 1969.</td></tr> |
<td class="author-text">UCLA, “<a href="http://tools.ietf.org/html/rfc20">ASCII format for Network Interchange</a>,” RFC 20, 1969.</td></tr> |
13981 |
<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> |
13982 |
<td class="author-text">Bradner, S., “<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">Key words for use in RFCs to Indicate Requirement Levels</a>,” RFC 2119, 1997.</td></tr> |
<td class="author-text">Bradner, S., “<a href="http://tools.ietf.org/html/rfc2119">Key words for use in RFCs to Indicate Requirement Levels</a>,” RFC 2119, 1997.</td></tr> |
13983 |
<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> |
13984 |
<td class="author-text">Crocker, D. and P. Overell, “<a href="ftp://ftp.isi.edu/in-notes/rfc2234.txt">Augmented BNF for Syntax Specifications</a>,” RFC 2234, 1997.</td></tr> |
<td class="author-text">Crocker, D. and P. Overell, “<a href="http://tools.ietf.org/html/rfc2234">Augmented BNF for Syntax Specifications</a>,” RFC 2234, 1997.</td></tr> |
13985 |
<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> |
13986 |
<td class="author-text">Defense Advanced Research Projects Agency, “<a href="ftp://ftp.isi.edu/in-notes/rfc793.txt">TRANSMISSION CONTROL PROTOCOL</a>,” RFC 793, 1981.</td></tr> |
<td class="author-text">Defense Advanced Research Projects Agency, “<a href="http://tools.ietf.org/html/rfc793">TRANSMISSION CONTROL PROTOCOL</a>,” RFC 793, 1981.</td></tr> |
13987 |
</table> |
</table> |
13988 |
|
|
13989 |
<a name="rfc.authors"></a><br /><hr /> |
<a name="rfc.authors"></a><br /><hr /> |
14008 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
14009 |
<h3>Full Copyright Statement</h3> |
<h3>Full Copyright Statement</h3> |
14010 |
<p class='copyright'> |
<p class='copyright'> |
14011 |
Copyright © The IETF Trust (2008).</p> |
Copyright © The IETF Trust (2010).</p> |
14012 |
<p class='copyright'> |
<p class='copyright'> |
14013 |
This document is subject to the rights, |
This document is subject to the rights, |
14014 |
licenses and restrictions contained in BCP 78, |
licenses and restrictions contained in BCP 78, |
14050 |
proprietary rights that may cover technology that may be required |
proprietary rights that may cover technology that may be required |
14051 |
to implement this standard. |
to implement this standard. |
14052 |
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> |
|
14053 |
</body></html> |
</body></html> |