| 16 |
to an annoying "missing Normative/Informative References" error message --> |
to an annoying "missing Normative/Informative References" error message --> |
| 17 |
<?rfc strict="no" ?> |
<?rfc strict="no" ?> |
| 18 |
|
|
| 19 |
<rfc category="std" ipr="full3978" docName="LSCP 1.4"> |
<rfc category="std" ipr="full3978" docName="LSCP 1.5"> |
| 20 |
<front> |
<front> |
| 21 |
<title>LinuxSampler Control Protocol</title> |
<title>LinuxSampler Control Protocol</title> |
| 22 |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
| 34 |
<email>schoenebeck at software minus engineering dot org</email> |
<email>schoenebeck at software minus engineering dot org</email> |
| 35 |
</address> |
</address> |
| 36 |
</author> |
</author> |
| 37 |
<date month="September" year="2008"/> |
<date month="October" year="2010"/> |
| 38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
| 39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
| 40 |
<abstract> |
<abstract> |
| 2512 |
<list> |
<list> |
| 2513 |
<t>numerical ID of the audio output device which is |
<t>numerical ID of the audio output device which is |
| 2514 |
currently connected to this sampler channel to output |
currently connected to this sampler channel to output |
| 2515 |
the audio signal, "NONE" if there's no device |
the audio signal, "-1" if there's no device |
| 2516 |
connected to this sampler channel</t> |
connected to this sampler channel</t> |
| 2517 |
</list> |
</list> |
| 2518 |
</t> |
</t> |
| 2543 |
</t> |
</t> |
| 2544 |
<t>INSTRUMENT_NR - |
<t>INSTRUMENT_NR - |
| 2545 |
<list> |
<list> |
| 2546 |
<t>the instrument index number of the loaded instrument</t> |
<t>the instrument index number of the loaded instrument, |
| 2547 |
|
"-1" if there's no instrument loaded for this sampler |
| 2548 |
|
channel</t> |
| 2549 |
</list> |
</list> |
| 2550 |
</t> |
</t> |
| 2551 |
<t>INSTRUMENT_NAME - |
<t>INSTRUMENT_NAME - |
| 2557 |
</t> |
</t> |
| 2558 |
<t>INSTRUMENT_STATUS - |
<t>INSTRUMENT_STATUS - |
| 2559 |
<list> |
<list> |
| 2560 |
<t>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative |
<t>Integer values 0 to 100 indicating loading progress |
| 2561 |
value indicates a loading exception. Value of 100 indicates that the instrument is fully |
percentage for the instrument. Negative |
| 2562 |
|
value indicates a loading exception (also returns "-1" in case no |
| 2563 |
|
instrument was yet to be loaded on the sampler channel). |
| 2564 |
|
Value of 100 indicates that the instrument is fully |
| 2565 |
loaded.</t> |
loaded.</t> |
| 2566 |
</list> |
</list> |
| 2567 |
</t> |
</t> |
| 2569 |
<list> |
<list> |
| 2570 |
<t>numerical ID of the MIDI input device which is |
<t>numerical ID of the MIDI input device which is |
| 2571 |
currently connected to this sampler channel to deliver |
currently connected to this sampler channel to deliver |
| 2572 |
MIDI input commands, "NONE" if there's no device |
MIDI input commands, "-1" if there's no device |
| 2573 |
connected to this sampler channel</t> |
connected to this sampler channel</t> |
| 2574 |
</list> |
</list> |
| 2575 |
</t> |
</t> |
| 2576 |
<t>MIDI_INPUT_PORT - |
<t>MIDI_INPUT_PORT - |
| 2577 |
<list> |
<list> |
| 2578 |
<t>port number of the MIDI input device</t> |
<t>port number of the MIDI input device (in case a |
| 2579 |
|
MIDI device was already assigned to the sampler |
| 2580 |
|
channel)</t> |
| 2581 |
</list> |
</list> |
| 2582 |
</t> |
</t> |
| 2583 |
<t>MIDI_INPUT_CHANNEL - |
<t>MIDI_INPUT_CHANNEL - |
| 3495 |
channel 1 is routed to the channel 3 of the audio |
channel 1 is routed to the channel 3 of the audio |
| 3496 |
output device (see |
output device (see |
| 3497 |
<xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref> |
<xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref> |
| 3498 |
for details)</t> |
for details), if an internal send |
| 3499 |
|
effect is assigned to the effect |
| 3500 |
|
send, then this setting defines the |
| 3501 |
|
audio channel routing to that |
| 3502 |
|
effect instance respectively</t> |
| 3503 |
|
</list> |
| 3504 |
|
</t> |
| 3505 |
|
<t>EFFECT - |
| 3506 |
|
<list> |
| 3507 |
|
<t>destination send effect chain ID |
| 3508 |
|
and destination effect chain |
| 3509 |
|
position, separated by comma in the |
| 3510 |
|
form "<effect-chain>,<chain-pos>" |
| 3511 |
|
or "NONE" if there is no send effect |
| 3512 |
|
assigned to the effect send</t> |
| 3513 |
</list> |
</list> |
| 3514 |
</t> |
</t> |
| 3515 |
</list> |
</list> |
| 3526 |
<t> "MIDI_CONTROLLER: 91"</t> |
<t> "MIDI_CONTROLLER: 91"</t> |
| 3527 |
<t> "LEVEL: 0.3"</t> |
<t> "LEVEL: 0.3"</t> |
| 3528 |
<t> "AUDIO_OUTPUT_ROUTING: 2,3"</t> |
<t> "AUDIO_OUTPUT_ROUTING: 2,3"</t> |
| 3529 |
|
<t> "EFFECT: NONE"</t> |
| 3530 |
|
<t> "."</t> |
| 3531 |
|
</list> |
| 3532 |
|
</t> |
| 3533 |
|
<t> |
| 3534 |
|
<list> |
| 3535 |
|
<t>C: "GET FX_SEND INFO 0 1"</t> |
| 3536 |
|
<t>S: "NAME: Delay Send (Internal)"</t> |
| 3537 |
|
<t> "MIDI_CONTROLLER: 93"</t> |
| 3538 |
|
<t> "LEVEL: 0.51"</t> |
| 3539 |
|
<t> "AUDIO_OUTPUT_ROUTING: 1,2"</t> |
| 3540 |
|
<t> "EFFECT: 2,0"</t> |
| 3541 |
<t> "."</t> |
<t> "."</t> |
| 3542 |
</list> |
</list> |
| 3543 |
</t> |
</t> |
| 3604 |
<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 |
| 3605 |
which should be rerouted and <audio-dst> is the numerical ID of |
which should be rerouted and <audio-dst> is the numerical ID of |
| 3606 |
the audio channel of the selected audio output device where <audio-src> |
the audio channel of the selected audio output device where <audio-src> |
| 3607 |
should be routed to.</t> |
should be routed to. If an internal send effect is assigned |
| 3608 |
|
to the effect send, then this setting defines the audio |
| 3609 |
|
channel routing to that effect instance respectively.</t> |
| 3610 |
|
|
| 3611 |
<t>Note that effect sends can only route audio to the same audio output |
<t>Note that effect sends can only route audio to the same audio output |
| 3612 |
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 |
| 3649 |
</t> |
</t> |
| 3650 |
</section> |
</section> |
| 3651 |
|
|
| 3652 |
|
<section title="Assigning destination effect to an effect send" anchor="SET FX_SEND EFFECT"> |
| 3653 |
|
<t>The front-end can (re-)assign a destination effect to an |
| 3654 |
|
effect send by sending the following command:</t> |
| 3655 |
|
<t> |
| 3656 |
|
<list> |
| 3657 |
|
<t>SET FX_SEND EFFECT <sampler-chan> <fx-send-id> <effect-chain> <chain-pos></t> |
| 3658 |
|
</list> |
| 3659 |
|
</t> |
| 3660 |
|
<t>Where <sampler-chan> is the sampler channel number |
| 3661 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3662 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
| 3663 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
| 3664 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
| 3665 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command, |
| 3666 |
|
<effect-chain> by the numerical ID of the destination |
| 3667 |
|
effect chain as returned by the |
| 3668 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
| 3669 |
|
or |
| 3670 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
| 3671 |
|
command and <chain-pos> reflects the exact effect |
| 3672 |
|
chain position in the effect chain which hosts the actual |
| 3673 |
|
destination effect.</t> |
| 3674 |
|
|
| 3675 |
|
<t>Possible Answers:</t> |
| 3676 |
|
<t> |
| 3677 |
|
<list> |
| 3678 |
|
<t>"OK" - |
| 3679 |
|
<list> |
| 3680 |
|
<t>on success</t> |
| 3681 |
|
</list> |
| 3682 |
|
</t> |
| 3683 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3684 |
|
<list> |
| 3685 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 3686 |
|
</list> |
| 3687 |
|
</t> |
| 3688 |
|
</list> |
| 3689 |
|
</t> |
| 3690 |
|
<t>Example:</t> |
| 3691 |
|
<t> |
| 3692 |
|
<list> |
| 3693 |
|
<t>C: "SET FX_SEND EFFECT 0 0 2 5"</t> |
| 3694 |
|
<t>S: "OK"</t> |
| 3695 |
|
</list> |
| 3696 |
|
</t> |
| 3697 |
|
</section> |
| 3698 |
|
|
| 3699 |
|
<section title="Removing destination effect from an effect send" anchor="REMOVE FX_SEND EFFECT"> |
| 3700 |
|
<t>The front-end can (re-)assign a destination effect to an |
| 3701 |
|
effect send by sending the following command:</t> |
| 3702 |
|
<t> |
| 3703 |
|
<list> |
| 3704 |
|
<t>REMOVE FX_SEND EFFECT <sampler-chan> <fx-send-id></t> |
| 3705 |
|
</list> |
| 3706 |
|
</t> |
| 3707 |
|
<t>Where <sampler-chan> is the sampler channel number |
| 3708 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3709 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
| 3710 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
| 3711 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
| 3712 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t> |
| 3713 |
|
|
| 3714 |
|
<t>After the destination effect has been removed from the |
| 3715 |
|
effect send, the audio signal of the effect send will be |
| 3716 |
|
routed directly to the audio output device, according to the |
| 3717 |
|
audio channel routing setting of the effect send. |
| 3718 |
|
</t> |
| 3719 |
|
|
| 3720 |
|
<t>Possible Answers:</t> |
| 3721 |
|
<t> |
| 3722 |
|
<list> |
| 3723 |
|
<t>"OK" - |
| 3724 |
|
<list> |
| 3725 |
|
<t>on success</t> |
| 3726 |
|
</list> |
| 3727 |
|
</t> |
| 3728 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3729 |
|
<list> |
| 3730 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 3731 |
|
</list> |
| 3732 |
|
</t> |
| 3733 |
|
</list> |
| 3734 |
|
</t> |
| 3735 |
|
<t>Example:</t> |
| 3736 |
|
<t> |
| 3737 |
|
<list> |
| 3738 |
|
<t>C: "REMOVE FX_SEND EFFECT 0 0"</t> |
| 3739 |
|
<t>S: "OK"</t> |
| 3740 |
|
</list> |
| 3741 |
|
</t> |
| 3742 |
|
</section> |
| 3743 |
|
|
| 3744 |
<section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER"> |
<section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER"> |
| 3745 |
<t>The front-end can alter the MIDI controller of an effect |
<t>The front-end can alter the MIDI controller of an effect |
| 3746 |
send entity by sending the following command:</t> |
send entity by sending the following command:</t> |
| 3839 |
</section> |
</section> |
| 3840 |
|
|
| 3841 |
<section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA"> |
<section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA"> |
| 3842 |
<t>The front-end can send MIDI events to specific sampler channel |
<t>The front-end can send MIDI events to a specific sampler channel |
| 3843 |
by sending the following command:</t> |
by sending the following command:</t> |
| 3844 |
<t> |
<t> |
| 3845 |
<list> |
<list> |
| 3867 |
as described in the MIDI specification.</t> |
as described in the MIDI specification.</t> |
| 3868 |
</list> |
</list> |
| 3869 |
</t> |
</t> |
| 3870 |
|
<t>"CC" - |
| 3871 |
|
<list> |
| 3872 |
|
<t>For changing a MIDI controller, where <arg1> |
| 3873 |
|
specifies the controller number and <arg2> the |
| 3874 |
|
new value of the controller as described in the Control |
| 3875 |
|
Change section of the MIDI specification.</t> |
| 3876 |
|
</list> |
| 3877 |
|
</t> |
| 3878 |
</list> |
</list> |
| 3879 |
</t> |
</t> |
| 3880 |
<t>CAUTION: This command is provided for implementations of virtual MIDI keyboards |
<t>CAUTION: This command is provided for implementations of virtual MIDI keyboards |
| 4277 |
</list> |
</list> |
| 4278 |
</t> |
</t> |
| 4279 |
</section> |
</section> |
| 4280 |
|
|
| 4281 |
|
<section title="Getting global voice limit" anchor="GET VOICES"> |
| 4282 |
|
<t>The client can ask for the current global sampler-wide limit |
| 4283 |
|
for maximum voices by sending the following command:</t> |
| 4284 |
|
<t> |
| 4285 |
|
<list> |
| 4286 |
|
<t>GET VOICES</t> |
| 4287 |
|
</list> |
| 4288 |
|
</t> |
| 4289 |
|
<t>Possible Answers:</t> |
| 4290 |
|
<t> |
| 4291 |
|
<list> |
| 4292 |
|
<t>LinuxSampler will answer by returning the number for |
| 4293 |
|
the current limit of maximum voices.</t> |
| 4294 |
|
</list> |
| 4295 |
|
</t> |
| 4296 |
|
|
| 4297 |
|
<t>The voice limit setting defines how many voices should maximum |
| 4298 |
|
be processed by the sampler at the same time. If the user |
| 4299 |
|
triggers new notes which would exceed that voice limit, the |
| 4300 |
|
sampler engine will react by stealing old voices for those |
| 4301 |
|
newly triggered notes. Note that the amount of voices triggered |
| 4302 |
|
by a new note can be larger than one and is dependent to the |
| 4303 |
|
respective instrument and probably further criterias.</t> |
| 4304 |
|
</section> |
| 4305 |
|
|
| 4306 |
|
<section title="Setting global voice limit" anchor="SET VOICES"> |
| 4307 |
|
<t>The client can alter the current global sampler-wide limit |
| 4308 |
|
for maximum voices by sending the following command:</t> |
| 4309 |
|
<t> |
| 4310 |
|
<list> |
| 4311 |
|
<t>SET VOICES <max-voices></t> |
| 4312 |
|
</list> |
| 4313 |
|
</t> |
| 4314 |
|
<t>Where <max-voices> should be replaced by the integer |
| 4315 |
|
value, reflecting the new global amount limit of maximum voices. |
| 4316 |
|
This value has to be larger than 0.</t> |
| 4317 |
|
|
| 4318 |
|
<t>Possible Answers:</t> |
| 4319 |
|
<t> |
| 4320 |
|
<list> |
| 4321 |
|
<t>"OK" - |
| 4322 |
|
<list> |
| 4323 |
|
<t>on success</t> |
| 4324 |
|
</list> |
| 4325 |
|
</t> |
| 4326 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
| 4327 |
|
<list> |
| 4328 |
|
<t>if the voice limit was set, but there are noteworthy |
| 4329 |
|
issue(s) related, providing an appropriate warning code and |
| 4330 |
|
warning message</t> |
| 4331 |
|
</list> |
| 4332 |
|
</t> |
| 4333 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 4334 |
|
<list> |
| 4335 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 4336 |
|
</list> |
| 4337 |
|
</t> |
| 4338 |
|
</list> |
| 4339 |
|
</t> |
| 4340 |
|
|
| 4341 |
|
<t>Note: the given value will be passed to all sampler engine instances. |
| 4342 |
|
The total amount of maximum voices on the running system might thus |
| 4343 |
|
be as big as the given value multiplied by the current amount of engine |
| 4344 |
|
instances.</t> |
| 4345 |
|
|
| 4346 |
|
<t>Caution: when adjusting the voice limit, you SHOULD also |
| 4347 |
|
adjust the disk stream limit respectively and vice versa.</t> |
| 4348 |
|
</section> |
| 4349 |
|
|
| 4350 |
|
<section title="Getting global disk stream limit" anchor="GET STREAMS"> |
| 4351 |
|
<t>The client can ask for the current global sampler-wide limit |
| 4352 |
|
for maximum disk streams by sending the following command:</t> |
| 4353 |
|
<t> |
| 4354 |
|
<list> |
| 4355 |
|
<t>GET STREAMS</t> |
| 4356 |
|
</list> |
| 4357 |
|
</t> |
| 4358 |
|
<t>Possible Answers:</t> |
| 4359 |
|
<t> |
| 4360 |
|
<list> |
| 4361 |
|
<t>LinuxSampler will answer by returning the number for |
| 4362 |
|
the current limit of maximum disk streams.</t> |
| 4363 |
|
</list> |
| 4364 |
|
</t> |
| 4365 |
|
|
| 4366 |
|
<t>The disk stream limit setting defines how many disk streams should |
| 4367 |
|
maximum be processed by a sampler engine at the same time. The |
| 4368 |
|
higher this value, the more memory (RAM) will be occupied, since |
| 4369 |
|
every disk streams allocates a certain buffer size for being able |
| 4370 |
|
to perform its streaming operations.</t> |
| 4371 |
|
</section> |
| 4372 |
|
|
| 4373 |
|
<section title="Setting global disk stream limit" anchor="SET STREAMS"> |
| 4374 |
|
<t>The client can alter the current global sampler-wide limit |
| 4375 |
|
for maximum disk streams by sending the following command:</t> |
| 4376 |
|
<t> |
| 4377 |
|
<list> |
| 4378 |
|
<t>SET STREAMS <max-streams></t> |
| 4379 |
|
</list> |
| 4380 |
|
</t> |
| 4381 |
|
<t>Where <max-streams> should be replaced by the integer |
| 4382 |
|
value, reflecting the new global amount limit of maximum disk streams. |
| 4383 |
|
This value has to be positive.</t> |
| 4384 |
|
|
| 4385 |
|
<t>Possible Answers:</t> |
| 4386 |
|
<t> |
| 4387 |
|
<list> |
| 4388 |
|
<t>"OK" - |
| 4389 |
|
<list> |
| 4390 |
|
<t>on success</t> |
| 4391 |
|
</list> |
| 4392 |
|
</t> |
| 4393 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
| 4394 |
|
<list> |
| 4395 |
|
<t>if the disk stream limit was set, but there are noteworthy |
| 4396 |
|
issue(s) related, providing an appropriate warning code and |
| 4397 |
|
warning message</t> |
| 4398 |
|
</list> |
| 4399 |
|
</t> |
| 4400 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 4401 |
|
<list> |
| 4402 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 4403 |
|
</list> |
| 4404 |
|
</t> |
| 4405 |
|
</list> |
| 4406 |
|
</t> |
| 4407 |
|
|
| 4408 |
|
<t>Note: the given value will be passed to all sampler engine instances. |
| 4409 |
|
The total amount of maximum disk streams on the running system might |
| 4410 |
|
thus be as big as the given value multiplied by the current amount of |
| 4411 |
|
engine instances.</t> |
| 4412 |
|
|
| 4413 |
|
<t>Caution: when adjusting the disk stream limit, you SHOULD also |
| 4414 |
|
adjust the voice limit respectively and vice versa.</t> |
| 4415 |
|
</section> |
| 4416 |
|
|
| 4417 |
</section> |
</section> |
| 4418 |
|
|
| 4419 |
|
|
| 6674 |
</t> |
</t> |
| 6675 |
</section> |
</section> |
| 6676 |
</section> |
</section> |
| 6677 |
|
<section title="Managing Effects" anchor="effects"> |
| 6678 |
|
<t>Audio effects (e.g. reverb, delay, compression) can be |
| 6679 |
|
applied to the audio signals generated by the sampler. The |
| 6680 |
|
sampler usually provides a set of internal audio effects for |
| 6681 |
|
this task. The exact set of effects depends on the availability |
| 6682 |
|
of third party effect plugins installed on the system where the |
| 6683 |
|
sampler runs on.</t> |
| 6684 |
|
<t>At the moment only "send effects" are supported. Support for |
| 6685 |
|
"insert effects" and "master effects" is planned to be added at |
| 6686 |
|
a later point.</t> |
| 6687 |
|
<t>The following commands allow to retrieve the set of internal |
| 6688 |
|
effects available to the sampler, detailed informations about |
| 6689 |
|
those effects and to create and destroy instances of such |
| 6690 |
|
effects. After an instance of an effect is created, the effect |
| 6691 |
|
instance can be inserted into the audio signal path of the |
| 6692 |
|
sampler, e.g. as send effect.</t> |
| 6693 |
|
<t>The sampler allows to create an arbitrary amount of so called |
| 6694 |
|
send effect chains. Each effect chain can host an arbitrary |
| 6695 |
|
amount of effect instances. The output of the first effect |
| 6696 |
|
instance in an effect chain is fed to the input of the second |
| 6697 |
|
effect instance of the chain and so on. So effects in one chain |
| 6698 |
|
are processed sequentially. Send effect chains however are |
| 6699 |
|
processed in parallel to other send effect chains. Audio signals |
| 6700 |
|
of sampler channels are fed to send effects by creating FX sends |
| 6701 |
|
to the respective sampler channel and assigning a destination |
| 6702 |
|
send effect to that FX by using the |
| 6703 |
|
<xref target="SET FX_SEND EFFECT">"SET FX_SEND EFFECT"</xref> |
| 6704 |
|
command. The latter allows to route the FX send to the beginning |
| 6705 |
|
of a send effect chain, as well as directly to any other |
| 6706 |
|
position of the send effect chain.</t> |
| 6707 |
|
|
| 6708 |
|
<section title="Retrieve amount of available effects" anchor="GET AVAILABLE_EFFECTS"> |
| 6709 |
|
<t>The front-end can retrieve the amount of internal |
| 6710 |
|
effects, available to the sampler by sending |
| 6711 |
|
the following command:</t> |
| 6712 |
|
<t> |
| 6713 |
|
<list> |
| 6714 |
|
<t>GET AVAILABLE_EFFECTS</t> |
| 6715 |
|
</list> |
| 6716 |
|
</t> |
| 6717 |
|
|
| 6718 |
|
<t>Possible Answers:</t> |
| 6719 |
|
<t> |
| 6720 |
|
<list> |
| 6721 |
|
<t>The sampler will answer by returning the current |
| 6722 |
|
number of effects available to the sampler.</t> |
| 6723 |
|
</list> |
| 6724 |
|
</t> |
| 6725 |
|
|
| 6726 |
|
<t>Examples:</t> |
| 6727 |
|
<t> |
| 6728 |
|
<list> |
| 6729 |
|
<t>C: "GET AVAILABLE_EFFECTS"</t> |
| 6730 |
|
<t>S: "129"</t> |
| 6731 |
|
</list> |
| 6732 |
|
</t> |
| 6733 |
|
</section> |
| 6734 |
|
|
| 6735 |
|
<section title="Get list of available effects" anchor="LIST AVAILABLE_EFFECTS"> |
| 6736 |
|
<t>The set of available internal effects can change at |
| 6737 |
|
runtime. The front-end can retrieve the list of internal |
| 6738 |
|
effects, available to the sampler by sending the following |
| 6739 |
|
command:</t> |
| 6740 |
|
<t> |
| 6741 |
|
<list> |
| 6742 |
|
<t>LIST AVAILABLE_EFFECTS</t> |
| 6743 |
|
</list> |
| 6744 |
|
</t> |
| 6745 |
|
|
| 6746 |
|
<t>Possible Answers:</t> |
| 6747 |
|
<t> |
| 6748 |
|
<list> |
| 6749 |
|
<t>The sampler will answer by returning a comma |
| 6750 |
|
separated list with numerical IDs of effects. Note: |
| 6751 |
|
the numercial ID of an effect is generated by the |
| 6752 |
|
sampler for the current moment. The numerical ID of |
| 6753 |
|
the same effect can change at runtime, e.g. when the |
| 6754 |
|
user requests a rescan of available effect plugins. |
| 6755 |
|
</t> |
| 6756 |
|
</list> |
| 6757 |
|
</t> |
| 6758 |
|
<t>Example:</t> |
| 6759 |
|
<t> |
| 6760 |
|
<list> |
| 6761 |
|
<t>C: "LIST AVAILABLE_EFFECTS"</t> |
| 6762 |
|
<t>S: "5,6,7,120,121,122,123,124"</t> |
| 6763 |
|
</list> |
| 6764 |
|
</t> |
| 6765 |
|
</section> |
| 6766 |
|
|
| 6767 |
|
<section title="Retrieving general information about an effect" anchor="GET EFFECT INFO"> |
| 6768 |
|
<t>The front-end can ask for general informations about an |
| 6769 |
|
effect by sending the following command:</t> |
| 6770 |
|
<t> |
| 6771 |
|
<list> |
| 6772 |
|
<t>GET EFFECT INFO <effect-index></t> |
| 6773 |
|
</list> |
| 6774 |
|
</t> |
| 6775 |
|
<t>Where <effect-index> is the numerical ID of an |
| 6776 |
|
effect as returned by the |
| 6777 |
|
<xref target="LIST AVAILABLE_EFFECTS">"LIST AVAILABLE_EFFECTS"</xref> |
| 6778 |
|
command.</t> |
| 6779 |
|
<t>Possible Answers:</t> |
| 6780 |
|
<t> |
| 6781 |
|
<list> |
| 6782 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
| 6783 |
|
Each answer line begins with the effect information |
| 6784 |
|
category name, followed by a colon and then a space |
| 6785 |
|
character <SP> and finally the info character |
| 6786 |
|
string to that effect information category. At the |
| 6787 |
|
moment the following categories are defined:</t> |
| 6788 |
|
<t> |
| 6789 |
|
<list> |
| 6790 |
|
<t>SYSTEM - |
| 6791 |
|
<list> |
| 6792 |
|
<t>name of the effect plugin system |
| 6793 |
|
the effect is based on |
| 6794 |
|
(e.g. "LADSPA")</t> |
| 6795 |
|
</list> |
| 6796 |
|
</t> |
| 6797 |
|
<t>MODULE - |
| 6798 |
|
<list> |
| 6799 |
|
<t>module of the effect plugin |
| 6800 |
|
system that contains this effect, |
| 6801 |
|
the module is usually the |
| 6802 |
|
dynamic-linked library (DLL) |
| 6803 |
|
filename of the effect plugin, |
| 6804 |
|
including full path (note that this |
| 6805 |
|
filename may contain |
| 6806 |
|
<xref target="character_set">escape sequences</xref>)</t> |
| 6807 |
|
</list> |
| 6808 |
|
</t> |
| 6809 |
|
<t>NAME - |
| 6810 |
|
<list> |
| 6811 |
|
<t>character string defining the |
| 6812 |
|
unique name of the effect within its |
| 6813 |
|
module (note that the character |
| 6814 |
|
string may contain |
| 6815 |
|
<xref target="character_set">escape sequences</xref>)</t> |
| 6816 |
|
</list> |
| 6817 |
|
</t> |
| 6818 |
|
<t>DESCRIPTION - |
| 6819 |
|
<list> |
| 6820 |
|
<t>human readable name of the |
| 6821 |
|
effect, intended to be displayed in |
| 6822 |
|
user interfaces (note that the |
| 6823 |
|
character string may contain |
| 6824 |
|
<xref target="character_set">escape sequences</xref>)</t> |
| 6825 |
|
</list> |
| 6826 |
|
</t> |
| 6827 |
|
</list> |
| 6828 |
|
</t> |
| 6829 |
|
</list> |
| 6830 |
|
</t> |
| 6831 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
| 6832 |
|
|
| 6833 |
|
<t>Example:</t> |
| 6834 |
|
<t> |
| 6835 |
|
<list> |
| 6836 |
|
<t>C: "GET EFFECT INFO 121"</t> |
| 6837 |
|
<t>S: "SYSTEM: LADSPA"</t> |
| 6838 |
|
<t> "MODULE: /usr/lib/ladspa/lowpass_iir_1891.so"</t> |
| 6839 |
|
<t> "NAME: lowpass_iir"</t> |
| 6840 |
|
<t> "DESCRIPTION: Glame Lowpass Filter"</t> |
| 6841 |
|
<t> "."</t> |
| 6842 |
|
</list> |
| 6843 |
|
</t> |
| 6844 |
|
</section> |
| 6845 |
|
|
| 6846 |
|
<section title="Creating an instance of an effect by its portable ID" anchor="CREATE EFFECT_INSTANCE"> |
| 6847 |
|
<t>The front-end can spawn an instance of the desired |
| 6848 |
|
effect by sending the following command:</t> |
| 6849 |
|
<t> |
| 6850 |
|
<list> |
| 6851 |
|
<t>CREATE EFFECT_INSTANCE <effect-system> <module> <effect-name></t> |
| 6852 |
|
</list> |
| 6853 |
|
</t> |
| 6854 |
|
<t>Where <effect-system> is the "SYSTEM" field, |
| 6855 |
|
<module> the "MODULE" field and <effect-name> |
| 6856 |
|
the "NAME" field as returned by the |
| 6857 |
|
<xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref> |
| 6858 |
|
command. The filename of argument <module> and the |
| 6859 |
|
character string of argument <effect-name> may contain |
| 6860 |
|
<xref target="character_set">escape sequences</xref>.</t> |
| 6861 |
|
|
| 6862 |
|
<t>The sampler will try to load the requested effect and to |
| 6863 |
|
create an instance of it. To allow loading the same effect |
| 6864 |
|
on a different machine, probably even running a completely |
| 6865 |
|
different operating system (e.g. Linux vs. Windows), the |
| 6866 |
|
sampler tries to match <module> "softly". That means |
| 6867 |
|
it first tries to find an effect that exactly matches the |
| 6868 |
|
given <module> argument. If there is no exact match, |
| 6869 |
|
the sampler will try to lower the restrictions on matching |
| 6870 |
|
the <module> argument more and more, e.g. by ignoring |
| 6871 |
|
upper / lower case differences and by ignoring the path of |
| 6872 |
|
the DLL filename and file extension. If there is still no |
| 6873 |
|
match at the end, the sampler will try to ignore the |
| 6874 |
|
<module> argument completely and as a last resort |
| 6875 |
|
search for an effect that only matches the given |
| 6876 |
|
<effect-system> and <effect-name> arguments.</t> |
| 6877 |
|
|
| 6878 |
|
<t>Possible Answers:</t> |
| 6879 |
|
<t> |
| 6880 |
|
<list> |
| 6881 |
|
<t>"OK[<effect-instance>]" - |
| 6882 |
|
<list> |
| 6883 |
|
<t>in case the effect instance was |
| 6884 |
|
successfully created, where |
| 6885 |
|
<effect-instance> is the numerical ID |
| 6886 |
|
of the new effect instance</t> |
| 6887 |
|
</list> |
| 6888 |
|
</t> |
| 6889 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
| 6890 |
|
<list> |
| 6891 |
|
<t>in case the effect instance was spawned |
| 6892 |
|
successfully, but there are noteworthy |
| 6893 |
|
issue(s) related, providing an appropriate |
| 6894 |
|
warning code and warning message</t> |
| 6895 |
|
</list> |
| 6896 |
|
</t> |
| 6897 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 6898 |
|
<list> |
| 6899 |
|
<t>if the effect could not be instantiated</t> |
| 6900 |
|
</list> |
| 6901 |
|
</t> |
| 6902 |
|
</list> |
| 6903 |
|
</t> |
| 6904 |
|
|
| 6905 |
|
<t>Examples:</t> |
| 6906 |
|
<t> |
| 6907 |
|
<list> |
| 6908 |
|
<t>C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/mod_delay_1419.so' 'modDelay'"</t> |
| 6909 |
|
<t>S: "OK[0]"</t> |
| 6910 |
|
</list> |
| 6911 |
|
</t> |
| 6912 |
|
</section> |
| 6913 |
|
|
| 6914 |
|
<section title="Creating an instance of an effect by its numerical ID" anchor="CREATE EFFECT_INSTANCE (non-portable)"> |
| 6915 |
|
<t>The front-end can spawn an instance of the desired |
| 6916 |
|
effect by sending the following command:</t> |
| 6917 |
|
<t> |
| 6918 |
|
<list> |
| 6919 |
|
<t>CREATE EFFECT_INSTANCE <effect-index></t> |
| 6920 |
|
</list> |
| 6921 |
|
</t> |
| 6922 |
|
<t>Where <effect-index> is the numerical ID of the |
| 6923 |
|
effect as returned by the |
| 6924 |
|
<xref target="LIST AVAILABLE_EFFECTS">"LIST AVAILABLE_EFFECTS"</xref> |
| 6925 |
|
command.</t> |
| 6926 |
|
|
| 6927 |
|
<t>The sampler will try to load the requested effect and to |
| 6928 |
|
create an instance of it.</t> |
| 6929 |
|
|
| 6930 |
|
<t>Note: Since the numerical ID of a certain effect can |
| 6931 |
|
change at any time, you should not use this command in |
| 6932 |
|
LSCP files to restore a certain effect at a later time! To |
| 6933 |
|
store a sampler session including all its effects, use the |
| 6934 |
|
<xref target="CREATE EFFECT_INSTANCE">portable text-based |
| 6935 |
|
version of "CREATE EFFECT_INSTANCE"</xref> instead! This |
| 6936 |
|
allows to restore a sampler session with all its effects |
| 6937 |
|
also on other machines, possibly even running a completely |
| 6938 |
|
different operating system (e.g. Linux vs. Windows), with |
| 6939 |
|
different plugin directories or plugin DLL names.</t> |
| 6940 |
|
|
| 6941 |
|
<t>Possible Answers:</t> |
| 6942 |
|
<t> |
| 6943 |
|
<list> |
| 6944 |
|
<t>"OK[<effect-instance>]" - |
| 6945 |
|
<list> |
| 6946 |
|
<t>in case the effect instance was |
| 6947 |
|
successfully created, where |
| 6948 |
|
<effect-instance> is the numerical ID |
| 6949 |
|
of the new effect instance</t> |
| 6950 |
|
</list> |
| 6951 |
|
</t> |
| 6952 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
| 6953 |
|
<list> |
| 6954 |
|
<t>in case the effect instance was spawned |
| 6955 |
|
successfully, but there are noteworthy |
| 6956 |
|
issue(s) related, providing an appropriate |
| 6957 |
|
warning code and warning message</t> |
| 6958 |
|
</list> |
| 6959 |
|
</t> |
| 6960 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 6961 |
|
<list> |
| 6962 |
|
<t>if the effect could not be instantiated</t> |
| 6963 |
|
</list> |
| 6964 |
|
</t> |
| 6965 |
|
</list> |
| 6966 |
|
</t> |
| 6967 |
|
|
| 6968 |
|
<t>Examples:</t> |
| 6969 |
|
<t> |
| 6970 |
|
<list> |
| 6971 |
|
<t>C: "CREATE EFFECT_INSTANCE 72"</t> |
| 6972 |
|
<t>S: "OK[5]"</t> |
| 6973 |
|
</list> |
| 6974 |
|
</t> |
| 6975 |
|
</section> |
| 6976 |
|
|
| 6977 |
|
<section title="Destroy an effect instance" anchor="DESTROY EFFECT_INSTANCE"> |
| 6978 |
|
<t>The front-end can destroy an unusued effect instance and |
| 6979 |
|
thus freeing it from memory by sending the following command:</t> |
| 6980 |
|
<t> |
| 6981 |
|
<list> |
| 6982 |
|
<t>DESTROY EFFECT_INSTANCE <effect-instance></t> |
| 6983 |
|
</list> |
| 6984 |
|
</t> |
| 6985 |
|
<t>Where <effect-instance> is the numerical ID of the |
| 6986 |
|
effect instance as returned by the |
| 6987 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
| 6988 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
| 6989 |
|
command.</t> |
| 6990 |
|
|
| 6991 |
|
<t>The effect instance can only be destroyed if it's not |
| 6992 |
|
used in any part of the sampler's audio signal path anymore. |
| 6993 |
|
If the effect instance is still in use somewhere, trying to |
| 6994 |
|
destroy the effect instance will result in an error |
| 6995 |
|
message.</t> |
| 6996 |
|
|
| 6997 |
|
<t>Possible Answers:</t> |
| 6998 |
|
<t> |
| 6999 |
|
<list> |
| 7000 |
|
<t>"OK" - |
| 7001 |
|
<list> |
| 7002 |
|
<t>in case the effect instance was successfully destroyed</t> |
| 7003 |
|
</list> |
| 7004 |
|
</t> |
| 7005 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 7006 |
|
<list> |
| 7007 |
|
<t>in case it failed, providing an appropriate error code and |
| 7008 |
|
error message</t> |
| 7009 |
|
</list> |
| 7010 |
|
</t> |
| 7011 |
|
</list> |
| 7012 |
|
</t> |
| 7013 |
|
|
| 7014 |
|
<t>Examples:</t> |
| 7015 |
|
<t> |
| 7016 |
|
<list> |
| 7017 |
|
<t>C: "DESTROY EFFECT_INSTANCE 5"</t> |
| 7018 |
|
<t>S: "OK"</t> |
| 7019 |
|
</list> |
| 7020 |
|
</t> |
| 7021 |
|
</section> |
| 7022 |
|
|
| 7023 |
|
<section title="Retrieve amount of effect instances" anchor="GET EFFECT_INSTANCES"> |
| 7024 |
|
<t>The front-end can retrieve the current amount of effect |
| 7025 |
|
instances by sending the following command:</t> |
| 7026 |
|
<t> |
| 7027 |
|
<list> |
| 7028 |
|
<t>GET EFFECT_INSTANCES</t> |
| 7029 |
|
</list> |
| 7030 |
|
</t> |
| 7031 |
|
|
| 7032 |
|
<t>Possible Answers:</t> |
| 7033 |
|
<t> |
| 7034 |
|
<list> |
| 7035 |
|
<t>The sampler will answer by returning the current |
| 7036 |
|
number of effect instances created and not yet |
| 7037 |
|
destroyed in the current sampler session.</t> |
| 7038 |
|
</list> |
| 7039 |
|
</t> |
| 7040 |
|
|
| 7041 |
|
<t>Examples:</t> |
| 7042 |
|
<t> |
| 7043 |
|
<list> |
| 7044 |
|
<t>C: "GET EFFECT_INSTANCES"</t> |
| 7045 |
|
<t>S: "14"</t> |
| 7046 |
|
</list> |
| 7047 |
|
</t> |
| 7048 |
|
</section> |
| 7049 |
|
|
| 7050 |
|
<section title="Get list of effect instances" anchor="LIST EFFECT_INSTANCES"> |
| 7051 |
|
<t>The front-end can retrieve the current list of effect |
| 7052 |
|
instances by sending the following command:</t> |
| 7053 |
|
<t> |
| 7054 |
|
<list> |
| 7055 |
|
<t>LIST EFFECT_INSTANCES</t> |
| 7056 |
|
</list> |
| 7057 |
|
</t> |
| 7058 |
|
|
| 7059 |
|
<t>Possible Answers:</t> |
| 7060 |
|
<t> |
| 7061 |
|
<list> |
| 7062 |
|
<t>The sampler will answer by returning a comma |
| 7063 |
|
separated list with numerical IDs of effects |
| 7064 |
|
instances. |
| 7065 |
|
</t> |
| 7066 |
|
</list> |
| 7067 |
|
</t> |
| 7068 |
|
<t>Example:</t> |
| 7069 |
|
<t> |
| 7070 |
|
<list> |
| 7071 |
|
<t>C: "LIST EFFECT_INSTANCES"</t> |
| 7072 |
|
<t>S: "9,11,14,15,16,17,25"</t> |
| 7073 |
|
</list> |
| 7074 |
|
</t> |
| 7075 |
|
</section> |
| 7076 |
|
|
| 7077 |
|
<section title="Retrieving current information about an effect instance" anchor="GET EFFECT_INSTANCE INFO"> |
| 7078 |
|
<t>The front-end can ask for the current informations about |
| 7079 |
|
a particular effect instance by sending the following command:</t> |
| 7080 |
|
<t> |
| 7081 |
|
<list> |
| 7082 |
|
<t>GET EFFECT_INSTANCE INFO <effect-instance></t> |
| 7083 |
|
</list> |
| 7084 |
|
</t> |
| 7085 |
|
<t>Where <effect-instance> is the numerical ID of an |
| 7086 |
|
effect instance as returned by the |
| 7087 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> |
| 7088 |
|
or |
| 7089 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
| 7090 |
|
command.</t> |
| 7091 |
|
|
| 7092 |
|
<t>Possible Answers:</t> |
| 7093 |
|
<t> |
| 7094 |
|
<list> |
| 7095 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
| 7096 |
|
Each answer line begins with the information |
| 7097 |
|
category name, followed by a colon and then a space |
| 7098 |
|
character <SP> and finally the info character |
| 7099 |
|
string to that information category. At the |
| 7100 |
|
moment the following categories are defined:</t> |
| 7101 |
|
<t> |
| 7102 |
|
<list> |
| 7103 |
|
<t>SYSTEM - |
| 7104 |
|
<list> |
| 7105 |
|
<t>name of the effect plugin system |
| 7106 |
|
the effect is based on |
| 7107 |
|
(e.g. "LADSPA")</t> |
| 7108 |
|
</list> |
| 7109 |
|
</t> |
| 7110 |
|
<t>MODULE - |
| 7111 |
|
<list> |
| 7112 |
|
<t>module of the effect plugin |
| 7113 |
|
system that contains this effect, |
| 7114 |
|
the module is usually the |
| 7115 |
|
dynamic-linked library (DLL) |
| 7116 |
|
filename of the effect plugin, |
| 7117 |
|
including full path (note that this |
| 7118 |
|
filename may contain |
| 7119 |
|
<xref target="character_set">escape sequences</xref>)</t> |
| 7120 |
|
</list> |
| 7121 |
|
</t> |
| 7122 |
|
<t>NAME - |
| 7123 |
|
<list> |
| 7124 |
|
<t>character string defining the |
| 7125 |
|
unique name of the effect within its |
| 7126 |
|
module (note that the character |
| 7127 |
|
string may contain |
| 7128 |
|
<xref target="character_set">escape sequences</xref>)</t> |
| 7129 |
|
</list> |
| 7130 |
|
</t> |
| 7131 |
|
<t>DESCRIPTION - |
| 7132 |
|
<list> |
| 7133 |
|
<t>human readable name of the |
| 7134 |
|
effect, intended to be displayed in |
| 7135 |
|
user interfaces (note that the |
| 7136 |
|
character string may contain |
| 7137 |
|
<xref target="character_set">escape sequences</xref>)</t> |
| 7138 |
|
</list> |
| 7139 |
|
</t> |
| 7140 |
|
<t>INPUT_CONTROLS - |
| 7141 |
|
<list> |
| 7142 |
|
<t>amount of input controls the |
| 7143 |
|
effect instance provides, to allow |
| 7144 |
|
controlling the effect parameters in |
| 7145 |
|
realtime</t> |
| 7146 |
|
</list> |
| 7147 |
|
</t> |
| 7148 |
|
</list> |
| 7149 |
|
</t> |
| 7150 |
|
</list> |
| 7151 |
|
</t> |
| 7152 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
| 7153 |
|
|
| 7154 |
|
<t>Example:</t> |
| 7155 |
|
<t> |
| 7156 |
|
<list> |
| 7157 |
|
<t>C: "GET EFFECT_INSTANCE INFO 3"</t> |
| 7158 |
|
<t>S: "SYSTEM: LADSPA"</t> |
| 7159 |
|
<t> "MODULE: /usr/lib/ladspa/mod_delay_1419.so"</t> |
| 7160 |
|
<t> "NAME: modDelay"</t> |
| 7161 |
|
<t> "DESCRIPTION: Modulatable delay"</t> |
| 7162 |
|
<t> "INPUT_CONTROLS: 1"</t> |
| 7163 |
|
<t> "."</t> |
| 7164 |
|
</list> |
| 7165 |
|
</t> |
| 7166 |
|
</section> |
| 7167 |
|
|
| 7168 |
|
<section title="Retrieving information about an effect parameter" anchor="GET EFFECT_INSTANCE_INPUT_CONTROL INFO"> |
| 7169 |
|
<t>Effects typically provide a certain set of effect |
| 7170 |
|
parameters which can be altered by the user in realtime |
| 7171 |
|
(e.g. depth of a reverb effect, duration of a delay effect, |
| 7172 |
|
dry / wet signal ratio). Those controllable effect parameters |
| 7173 |
|
are called "input controls". The front-end can ask for the |
| 7174 |
|
current informations of an effect instance's input control |
| 7175 |
|
by sending the following command:</t> |
| 7176 |
|
<t> |
| 7177 |
|
<list> |
| 7178 |
|
<t>GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-control></t> |
| 7179 |
|
</list> |
| 7180 |
|
</t> |
| 7181 |
|
<t>Where <effect-instance> is the numerical ID of an |
| 7182 |
|
effect instance as returned by the |
| 7183 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> |
| 7184 |
|
or |
| 7185 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
| 7186 |
|
command and <input-control> is the index of the input |
| 7187 |
|
control within the numerical bounds as returned by the |
| 7188 |
|
"INPUT_CONTROLS" field of the |
| 7189 |
|
<xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref> |
| 7190 |
|
command.</t> |
| 7191 |
|
|
| 7192 |
|
<t>Possible Answers:</t> |
| 7193 |
|
<t> |
| 7194 |
|
<list> |
| 7195 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
| 7196 |
|
Each answer line begins with the information |
| 7197 |
|
category name, followed by a colon and then a space |
| 7198 |
|
character <SP> and finally the info character |
| 7199 |
|
string to that information category. There are |
| 7200 |
|
information categories which are always returned, |
| 7201 |
|
independent of the respective effect parameter and |
| 7202 |
|
there are optional information categories |
| 7203 |
|
which are only shown for certain effect parameters. |
| 7204 |
|
At the moment the following categories are defined:</t> |
| 7205 |
|
<t> |
| 7206 |
|
<list> |
| 7207 |
|
<t>DESCRIPTION - |
| 7208 |
|
<list> |
| 7209 |
|
<t>(always returned) |
| 7210 |
|
human readable name of the |
| 7211 |
|
effect parameter, intended to be |
| 7212 |
|
displayed in user interfaces (note |
| 7213 |
|
that the character string may |
| 7214 |
|
contain <xref target="character_set">escape sequences</xref>)</t> |
| 7215 |
|
</list> |
| 7216 |
|
</t> |
| 7217 |
|
<t>VALUE - |
| 7218 |
|
<list> |
| 7219 |
|
<t> |
| 7220 |
|
(always returned) |
| 7221 |
|
current (optional dotted) |
| 7222 |
|
floating point value of this effect |
| 7223 |
|
parameter</t> |
| 7224 |
|
</list> |
| 7225 |
|
</t> |
| 7226 |
|
<t>RANGE_MIN - |
| 7227 |
|
<list> |
| 7228 |
|
<t> |
| 7229 |
|
(optionally returned) |
| 7230 |
|
minimum allowed value for this |
| 7231 |
|
effect parameter</t> |
| 7232 |
|
</list> |
| 7233 |
|
</t> |
| 7234 |
|
<t>RANGE_MAX - |
| 7235 |
|
<list> |
| 7236 |
|
<t> |
| 7237 |
|
(optionally returned) |
| 7238 |
|
maximum allowed value for this |
| 7239 |
|
effect parameter</t> |
| 7240 |
|
</list> |
| 7241 |
|
</t> |
| 7242 |
|
<t>POSSIBILITIES - |
| 7243 |
|
<list> |
| 7244 |
|
<t> |
| 7245 |
|
(optionally returned) |
| 7246 |
|
comma separated list of |
| 7247 |
|
(optional dotted) floating point |
| 7248 |
|
numbers, reflecting the exact set of |
| 7249 |
|
possible values for this effect |
| 7250 |
|
parameter</t> |
| 7251 |
|
</list> |
| 7252 |
|
</t> |
| 7253 |
|
<t>DEFAULT - |
| 7254 |
|
<list> |
| 7255 |
|
<t> |
| 7256 |
|
(optionally returned) |
| 7257 |
|
default value of this effect |
| 7258 |
|
parameter</t> |
| 7259 |
|
</list> |
| 7260 |
|
</t> |
| 7261 |
|
</list> |
| 7262 |
|
</t> |
| 7263 |
|
</list> |
| 7264 |
|
</t> |
| 7265 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
| 7266 |
|
|
| 7267 |
|
<t>Example:</t> |
| 7268 |
|
<t> |
| 7269 |
|
<list> |
| 7270 |
|
<t>C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0"</t> |
| 7271 |
|
<t>S: "SYSTEM: LADSPA"</t> |
| 7272 |
|
<t> "DESCRIPTION: Base delay (s)"</t> |
| 7273 |
|
<t> "VALUE: 0.500"</t> |
| 7274 |
|
<t> "RANGE_MIN: 0.000"</t> |
| 7275 |
|
<t> "."</t> |
| 7276 |
|
</list> |
| 7277 |
|
</t> |
| 7278 |
|
</section> |
| 7279 |
|
|
| 7280 |
|
<section title="Altering an effect parameter" anchor="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE"> |
| 7281 |
|
<t>The front-end can alter the current value of an effect |
| 7282 |
|
parameter by sending the following command:</t> |
| 7283 |
|
<t> |
| 7284 |
|
<list> |
| 7285 |
|
<t>SET EFFECT_INSTANCE_INPUT_CONTROL VALUE <effect-instance> <input-control> <value></t> |
| 7286 |
|
</list> |
| 7287 |
|
</t> |
| 7288 |
|
<t>Where <effect-instance> is the numerical ID of the |
| 7289 |
|
effect instance as returned by the |
| 7290 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
| 7291 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
| 7292 |
|
command, <input-control> is the index of the input |
| 7293 |
|
control within the numerical bounds as returned by the |
| 7294 |
|
"INPUT_CONTROLS" field of the |
| 7295 |
|
<xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref> |
| 7296 |
|
command and <value> is the new (optional dotted) |
| 7297 |
|
floating point value for this effect parameter.</t> |
| 7298 |
|
|
| 7299 |
|
<t>Possible Answers:</t> |
| 7300 |
|
<t> |
| 7301 |
|
<list> |
| 7302 |
|
<t>"OK" - |
| 7303 |
|
<list> |
| 7304 |
|
<t>in case the effect was altered successfully</t> |
| 7305 |
|
</list> |
| 7306 |
|
</t> |
| 7307 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 7308 |
|
<list> |
| 7309 |
|
<t>in case it failed, providing an appropriate error code and |
| 7310 |
|
error message</t> |
| 7311 |
|
</list> |
| 7312 |
|
</t> |
| 7313 |
|
</list> |
| 7314 |
|
</t> |
| 7315 |
|
|
| 7316 |
|
<t>Examples:</t> |
| 7317 |
|
<t> |
| 7318 |
|
<list> |
| 7319 |
|
<t>C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5"</t> |
| 7320 |
|
<t>S: "OK"</t> |
| 7321 |
|
</list> |
| 7322 |
|
</t> |
| 7323 |
|
</section> |
| 7324 |
|
|
| 7325 |
|
<section title="Retrieve amount of send effect chains" anchor="GET SEND_EFFECT_CHAINS"> |
| 7326 |
|
<t>The front-end can retrieve the current amount of send |
| 7327 |
|
effect chains of an audio output device by sending the |
| 7328 |
|
following command:</t> |
| 7329 |
|
<t> |
| 7330 |
|
<list> |
| 7331 |
|
<t>GET SEND_EFFECT_CHAINS <audio-device></t> |
| 7332 |
|
</list> |
| 7333 |
|
</t> |
| 7334 |
|
<t>Where <audio-device> should be replaced by the |
| 7335 |
|
numerical ID of the audio output device as given by the |
| 7336 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
| 7337 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
| 7338 |
|
command.</t> |
| 7339 |
|
|
| 7340 |
|
<t>Possible Answers:</t> |
| 7341 |
|
<t> |
| 7342 |
|
<list> |
| 7343 |
|
<t>The sampler will answer by returning the current |
| 7344 |
|
number of send effect chains of the supplied audio |
| 7345 |
|
output device.</t> |
| 7346 |
|
</list> |
| 7347 |
|
</t> |
| 7348 |
|
|
| 7349 |
|
<t>Examples:</t> |
| 7350 |
|
<t> |
| 7351 |
|
<list> |
| 7352 |
|
<t>C: "GET SEND_EFFECT_CHAINS 0"</t> |
| 7353 |
|
<t>S: "4"</t> |
| 7354 |
|
</list> |
| 7355 |
|
</t> |
| 7356 |
|
</section> |
| 7357 |
|
|
| 7358 |
|
<section title="Retrieve list of send effect chains" anchor="LIST SEND_EFFECT_CHAINS"> |
| 7359 |
|
<t>The front-end can retrieve the current list of send |
| 7360 |
|
effect chains of an audio output device by sending the |
| 7361 |
|
following command:</t> |
| 7362 |
|
<t> |
| 7363 |
|
<list> |
| 7364 |
|
<t>LIST SEND_EFFECT_CHAINS <audio-device></t> |
| 7365 |
|
</list> |
| 7366 |
|
</t> |
| 7367 |
|
<t>Where <audio-device> should be replaced by the |
| 7368 |
|
numerical ID of the audio output device as given by the |
| 7369 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
| 7370 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
| 7371 |
|
command.</t> |
| 7372 |
|
|
| 7373 |
|
<t>Possible Answers:</t> |
| 7374 |
|
<t> |
| 7375 |
|
<list> |
| 7376 |
|
<t>The sampler will answer by returning a comma |
| 7377 |
|
separated list with numerical IDs of send effect |
| 7378 |
|
chains of the supplied audio output device. |
| 7379 |
|
</t> |
| 7380 |
|
</list> |
| 7381 |
|
</t> |
| 7382 |
|
|
| 7383 |
|
<t>Examples:</t> |
| 7384 |
|
<t> |
| 7385 |
|
<list> |
| 7386 |
|
<t>C: "LIST SEND_EFFECT_CHAINS 0"</t> |
| 7387 |
|
<t>S: "3,4,7"</t> |
| 7388 |
|
</list> |
| 7389 |
|
</t> |
| 7390 |
|
</section> |
| 7391 |
|
|
| 7392 |
|
<section title="Add send effect chain" anchor="ADD SEND_EFFECT_CHAIN"> |
| 7393 |
|
<t>The front-end can add a send effect chain by sending the |
| 7394 |
|
following command:</t> |
| 7395 |
|
<t> |
| 7396 |
|
<list> |
| 7397 |
|
<t>ADD SEND_EFFECT_CHAIN <audio-device></t> |
| 7398 |
|
</list> |
| 7399 |
|
</t> |
| 7400 |
|
<t>Where <audio-device> should be replaced by the |
| 7401 |
|
numerical ID of the audio output device as given by the |
| 7402 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
| 7403 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
| 7404 |
|
command.</t> |
| 7405 |
|
|
| 7406 |
|
<t>Possible Answers:</t> |
| 7407 |
|
<t> |
| 7408 |
|
<list> |
| 7409 |
|
<t>"OK[<effect-chain>]" - |
| 7410 |
|
<list> |
| 7411 |
|
<t>in case the send effect chain was |
| 7412 |
|
added successfully, where |
| 7413 |
|
<effect-chain> is the numerical ID |
| 7414 |
|
of the new send effect chain</t> |
| 7415 |
|
</list> |
| 7416 |
|
</t> |
| 7417 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 7418 |
|
<list> |
| 7419 |
|
<t>if the send effect chain could not be added</t> |
| 7420 |
|
</list> |
| 7421 |
|
</t> |
| 7422 |
|
</list> |
| 7423 |
|
</t> |
| 7424 |
|
|
| 7425 |
|
<t>Examples:</t> |
| 7426 |
|
<t> |
| 7427 |
|
<list> |
| 7428 |
|
<t>C: "ADD SEND_EFFECT_CHAIN 0"</t> |
| 7429 |
|
<t>S: "OK[2]"</t> |
| 7430 |
|
</list> |
| 7431 |
|
</t> |
| 7432 |
|
</section> |
| 7433 |
|
|
| 7434 |
|
<section title="Remove send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN"> |
| 7435 |
|
<t>The front-end can remove a send effect chain by sending |
| 7436 |
|
the following command:</t> |
| 7437 |
|
<t> |
| 7438 |
|
<list> |
| 7439 |
|
<t>REMOVE SEND_EFFECT_CHAIN <audio-device> <effect-chain></t> |
| 7440 |
|
</list> |
| 7441 |
|
</t> |
| 7442 |
|
<t>Where <audio-device> should be replaced by the |
| 7443 |
|
numerical ID of the audio output device as given by the |
| 7444 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
| 7445 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
| 7446 |
|
command and <effect-chain> by the numerical ID as |
| 7447 |
|
returned by the |
| 7448 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
| 7449 |
|
or |
| 7450 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
| 7451 |
|
command.</t> |
| 7452 |
|
|
| 7453 |
|
<t>Possible Answers:</t> |
| 7454 |
|
<t> |
| 7455 |
|
<list> |
| 7456 |
|
<t>"OK" - |
| 7457 |
|
<list> |
| 7458 |
|
<t>in case the send effect chain was |
| 7459 |
|
removed successfully</t> |
| 7460 |
|
</list> |
| 7461 |
|
</t> |
| 7462 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 7463 |
|
<list> |
| 7464 |
|
<t>if the send effect chain could not be removed</t> |
| 7465 |
|
</list> |
| 7466 |
|
</t> |
| 7467 |
|
</list> |
| 7468 |
|
</t> |
| 7469 |
|
|
| 7470 |
|
<t>Examples:</t> |
| 7471 |
|
<t> |
| 7472 |
|
<list> |
| 7473 |
|
<t>C: "REMOVE SEND_EFFECT_CHAIN 0 2"</t> |
| 7474 |
|
<t>S: "OK"</t> |
| 7475 |
|
</list> |
| 7476 |
|
</t> |
| 7477 |
|
</section> |
| 7478 |
|
|
| 7479 |
|
<section title="Retrieving information about a send effect chain" anchor="GET SEND_EFFECT_CHAIN INFO"> |
| 7480 |
|
<t>The front-end can ask for informations of a send effect |
| 7481 |
|
chain by sending the following command:</t> |
| 7482 |
|
<t> |
| 7483 |
|
<list> |
| 7484 |
|
<t>GET SEND_EFFECT_CHAIN INFO <audio-device> <effect-chain></t> |
| 7485 |
|
</list> |
| 7486 |
|
</t> |
| 7487 |
|
<t>Where <audio-device> should be replaced by the |
| 7488 |
|
numerical ID of the audio output device as given by the |
| 7489 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
| 7490 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
| 7491 |
|
command and <effect-chain> by the numerical ID as |
| 7492 |
|
returned by the |
| 7493 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
| 7494 |
|
or |
| 7495 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
| 7496 |
|
command.</t> |
| 7497 |
|
|
| 7498 |
|
<t>Possible Answers:</t> |
| 7499 |
|
<t> |
| 7500 |
|
<list> |
| 7501 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
| 7502 |
|
Each answer line begins with the information |
| 7503 |
|
category name, followed by a colon and then a space |
| 7504 |
|
character <SP> and finally the info character |
| 7505 |
|
string to that information category. |
| 7506 |
|
At the moment the following categories are defined:</t> |
| 7507 |
|
<t> |
| 7508 |
|
<list> |
| 7509 |
|
<t>EFFECT_COUNT - |
| 7510 |
|
<list> |
| 7511 |
|
<t>amount of effects in this send |
| 7512 |
|
effect chain</t> |
| 7513 |
|
</list> |
| 7514 |
|
</t> |
| 7515 |
|
<t>EFFECT_SEQUENCE - |
| 7516 |
|
<list> |
| 7517 |
|
<t>comma separated list of the |
| 7518 |
|
numerical IDs of the effect |
| 7519 |
|
instances in this send effect chain, |
| 7520 |
|
in the order as they are procssed in |
| 7521 |
|
the effect chain</t> |
| 7522 |
|
</list> |
| 7523 |
|
</t> |
| 7524 |
|
</list> |
| 7525 |
|
</t> |
| 7526 |
|
</list> |
| 7527 |
|
</t> |
| 7528 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
| 7529 |
|
|
| 7530 |
|
<t>Example:</t> |
| 7531 |
|
<t> |
| 7532 |
|
<list> |
| 7533 |
|
<t>C: "GET SEND_EFFECT_CHAIN INFO 0 2"</t> |
| 7534 |
|
<t>S: "EFFECT_COUNT: 3"</t> |
| 7535 |
|
<t> "EFFECT_SEQUENCE: 31,4,7"</t> |
| 7536 |
|
<t> "."</t> |
| 7537 |
|
</list> |
| 7538 |
|
</t> |
| 7539 |
|
</section> |
| 7540 |
|
|
| 7541 |
|
<section title="Append effect instance to a send effect chain" anchor="APPEND SEND_EFFECT_CHAIN EFFECT"> |
| 7542 |
|
<t>The front-end can add an unused effect instance to the |
| 7543 |
|
end of a send effect chain by sending the following command:</t> |
| 7544 |
|
<t> |
| 7545 |
|
<list> |
| 7546 |
|
<t>APPEND SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <effect-instance></t> |
| 7547 |
|
</list> |
| 7548 |
|
</t> |
| 7549 |
|
<t>Where <audio-device> should be replaced by the |
| 7550 |
|
numerical ID of the audio output device as given by the |
| 7551 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
| 7552 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
| 7553 |
|
command and <effect-chain> by the numerical ID as |
| 7554 |
|
returned by the |
| 7555 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
| 7556 |
|
or |
| 7557 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
| 7558 |
|
command and <effect-instance> as returned by the |
| 7559 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
| 7560 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
| 7561 |
|
command.</t> |
| 7562 |
|
<t>Only unused effect instances can be added to the effect |
| 7563 |
|
chain. Trying to add an effect instance which is already in |
| 7564 |
|
use somewhere in the audio signal path of the sampler will |
| 7565 |
|
result in an error.</t> |
| 7566 |
|
|
| 7567 |
|
<t>Possible Answers:</t> |
| 7568 |
|
<t> |
| 7569 |
|
<list> |
| 7570 |
|
<t>"OK" - |
| 7571 |
|
<list> |
| 7572 |
|
<t>in case the effect instance was |
| 7573 |
|
added successfully to the chain</t> |
| 7574 |
|
</list> |
| 7575 |
|
</t> |
| 7576 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 7577 |
|
<list> |
| 7578 |
|
<t>if the effect instance could not be added</t> |
| 7579 |
|
</list> |
| 7580 |
|
</t> |
| 7581 |
|
</list> |
| 7582 |
|
</t> |
| 7583 |
|
|
| 7584 |
|
<t>Examples:</t> |
| 7585 |
|
<t> |
| 7586 |
|
<list> |
| 7587 |
|
<t>C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38"</t> |
| 7588 |
|
<t>S: "OK"</t> |
| 7589 |
|
</list> |
| 7590 |
|
</t> |
| 7591 |
|
</section> |
| 7592 |
|
|
| 7593 |
|
<section title="Insert effect instance to a send effect chain" anchor="INSERT SEND_EFFECT_CHAIN EFFECT"> |
| 7594 |
|
<t>The front-end can add an unused effect instance to a |
| 7595 |
|
certain position of a send effect chain by sending the |
| 7596 |
|
following command:</t> |
| 7597 |
|
<t> |
| 7598 |
|
<list> |
| 7599 |
|
<t>INSERT SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos> <effect-instance></t> |
| 7600 |
|
</list> |
| 7601 |
|
</t> |
| 7602 |
|
<t>Where <audio-device> should be replaced by the |
| 7603 |
|
numerical ID of the audio output device as given by the |
| 7604 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
| 7605 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
| 7606 |
|
command, <effect-chain> by the numerical ID as |
| 7607 |
|
returned by the |
| 7608 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
| 7609 |
|
or |
| 7610 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
| 7611 |
|
command, <effect-instance> as returned by the |
| 7612 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
| 7613 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
| 7614 |
|
command and <chain-pos> the exact position of the |
| 7615 |
|
effect chain where the supplied effect shall be inserted |
| 7616 |
|
to.</t> |
| 7617 |
|
<t>Only unused effect instances can be added to the effect |
| 7618 |
|
chain. Trying to add an effect instance which is already in |
| 7619 |
|
use somewhere in the audio signal path of the sampler will |
| 7620 |
|
result in an error.</t> |
| 7621 |
|
|
| 7622 |
|
<t>Possible Answers:</t> |
| 7623 |
|
<t> |
| 7624 |
|
<list> |
| 7625 |
|
<t>"OK" - |
| 7626 |
|
<list> |
| 7627 |
|
<t>in case the effect instance was |
| 7628 |
|
added successfully to the chain</t> |
| 7629 |
|
</list> |
| 7630 |
|
</t> |
| 7631 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 7632 |
|
<list> |
| 7633 |
|
<t>if the effect instance could not be added</t> |
| 7634 |
|
</list> |
| 7635 |
|
</t> |
| 7636 |
|
</list> |
| 7637 |
|
</t> |
| 7638 |
|
|
| 7639 |
|
<t>Examples:</t> |
| 7640 |
|
<t> |
| 7641 |
|
<list> |
| 7642 |
|
<t>C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38"</t> |
| 7643 |
|
<t>S: "OK"</t> |
| 7644 |
|
</list> |
| 7645 |
|
</t> |
| 7646 |
|
</section> |
| 7647 |
|
|
| 7648 |
|
<section title="Remove effect instance from send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN EFFECT"> |
| 7649 |
|
<t>The front-end can remove an effect instance from a |
| 7650 |
|
certain position of a send effect chain by sending the |
| 7651 |
|
following command:</t> |
| 7652 |
|
<t> |
| 7653 |
|
<list> |
| 7654 |
|
<t>REMOVE SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos></t> |
| 7655 |
|
</list> |
| 7656 |
|
</t> |
| 7657 |
|
<t>Where <audio-device> should be replaced by the |
| 7658 |
|
numerical ID of the audio output device as given by the |
| 7659 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
| 7660 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
| 7661 |
|
command, <effect-chain> by the numerical ID as |
| 7662 |
|
returned by the |
| 7663 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
| 7664 |
|
or |
| 7665 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
| 7666 |
|
command and <chain-pos> the exact position of the |
| 7667 |
|
effect instance to be removed from the effect chain.</t> |
| 7668 |
|
|
| 7669 |
|
<t>Possible Answers:</t> |
| 7670 |
|
<t> |
| 7671 |
|
<list> |
| 7672 |
|
<t>"OK" - |
| 7673 |
|
<list> |
| 7674 |
|
<t>in case the effect instance was |
| 7675 |
|
removed successfully</t> |
| 7676 |
|
</list> |
| 7677 |
|
</t> |
| 7678 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 7679 |
|
<list> |
| 7680 |
|
<t>if the effect instance could not be removed</t> |
| 7681 |
|
</list> |
| 7682 |
|
</t> |
| 7683 |
|
</list> |
| 7684 |
|
</t> |
| 7685 |
|
|
| 7686 |
|
<t>Examples:</t> |
| 7687 |
|
<t> |
| 7688 |
|
<list> |
| 7689 |
|
<t>C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4"</t> |
| 7690 |
|
<t>S: "OK"</t> |
| 7691 |
|
</list> |
| 7692 |
|
</t> |
| 7693 |
|
</section> |
| 7694 |
|
|
| 7695 |
|
</section> |
| 7696 |
</section> |
</section> |
| 7697 |
|
|
| 7698 |
<section title="Command Syntax" anchor="command_syntax"> |
<section title="Command Syntax" anchor="command_syntax"> |
| 7783 |
</t> |
</t> |
| 7784 |
<t>/ SEND SP send_instruction |
<t>/ SEND SP send_instruction |
| 7785 |
</t> |
</t> |
| 7786 |
|
<t>/ APPEND SP append_instruction |
| 7787 |
|
</t> |
| 7788 |
|
<t>/ INSERT SP insert_instruction |
| 7789 |
|
</t> |
| 7790 |
<t>/ RESET |
<t>/ RESET |
| 7791 |
</t> |
</t> |
| 7792 |
<t>/ QUIT |
<t>/ QUIT |
| 7819 |
</t> |
</t> |
| 7820 |
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
| 7821 |
</t> |
</t> |
| 7822 |
|
<t>/ SEND_EFFECT_CHAIN SP device_index |
| 7823 |
|
</t> |
| 7824 |
</list> |
</list> |
| 7825 |
</t> |
</t> |
| 7826 |
<t>subscribe_event = |
<t>subscribe_event = |
| 7961 |
</t> |
</t> |
| 7962 |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
| 7963 |
</t> |
</t> |
| 7964 |
|
<t>/ SEND_EFFECT_CHAIN SP device_index SP effect_chain |
| 7965 |
|
</t> |
| 7966 |
|
<t>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos |
| 7967 |
|
</t> |
| 7968 |
|
<t>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id |
| 7969 |
|
</t> |
| 7970 |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
| 7971 |
</t> |
</t> |
| 7972 |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
| 7979 |
<list> |
<list> |
| 7980 |
<t>AVAILABLE_ENGINES |
<t>AVAILABLE_ENGINES |
| 7981 |
</t> |
</t> |
| 7982 |
|
<t>/ AVAILABLE_EFFECTS |
| 7983 |
|
</t> |
| 7984 |
|
<t>/ EFFECT_INSTANCES |
| 7985 |
|
</t> |
| 7986 |
|
<t>/ EFFECT SP INFO SP effect_index |
| 7987 |
|
</t> |
| 7988 |
|
<t>/ EFFECT_INSTANCE SP INFO SP effect_instance |
| 7989 |
|
</t> |
| 7990 |
|
<t>/ EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP input_control |
| 7991 |
|
</t> |
| 7992 |
|
<t>/ SEND_EFFECT_CHAINS SP device_index |
| 7993 |
|
</t> |
| 7994 |
|
<t>/ SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain |
| 7995 |
|
</t> |
| 7996 |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
| 7997 |
</t> |
</t> |
| 7998 |
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
| 8075 |
</t> |
</t> |
| 8076 |
<t>/ VOLUME |
<t>/ VOLUME |
| 8077 |
</t> |
</t> |
| 8078 |
|
<t>/ VOICES |
| 8079 |
|
</t> |
| 8080 |
|
<t>/ STREAMS |
| 8081 |
|
</t> |
| 8082 |
<t>/ FILE SP INSTRUMENTS SP filename |
<t>/ FILE SP INSTRUMENTS SP filename |
| 8083 |
</t> |
</t> |
| 8084 |
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
| 8097 |
</t> |
</t> |
| 8098 |
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
| 8099 |
</t> |
</t> |
| 8100 |
|
<t>/ EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP input_control SP control_value |
| 8101 |
|
</t> |
| 8102 |
<t>/ CHANNEL SP set_chan_instruction |
<t>/ CHANNEL SP set_chan_instruction |
| 8103 |
</t> |
</t> |
| 8104 |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
| 8111 |
</t> |
</t> |
| 8112 |
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
| 8113 |
</t> |
</t> |
| 8114 |
|
<t>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos |
| 8115 |
|
</t> |
| 8116 |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
| 8117 |
</t> |
</t> |
| 8118 |
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped |
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped |
| 8127 |
</t> |
</t> |
| 8128 |
<t>/ VOLUME SP volume_value |
<t>/ VOLUME SP volume_value |
| 8129 |
</t> |
</t> |
| 8130 |
|
<t>/ VOICES SP number |
| 8131 |
|
</t> |
| 8132 |
|
<t>/ STREAMS SP number |
| 8133 |
|
</t> |
| 8134 |
</list> |
</list> |
| 8135 |
</t> |
</t> |
| 8136 |
<t>create_instruction = |
<t>create_instruction = |
| 8147 |
</t> |
</t> |
| 8148 |
<t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
<t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
| 8149 |
</t> |
</t> |
| 8150 |
|
<t>/ EFFECT_INSTANCE SP effect_index |
| 8151 |
|
</t> |
| 8152 |
|
<t>/ EFFECT_INSTANCE SP effect_system SP module SP effect_name |
| 8153 |
|
</t> |
| 8154 |
</list> |
</list> |
| 8155 |
</t> |
</t> |
| 8156 |
<t>reset_instruction = |
<t>reset_instruction = |
| 8205 |
</t> |
</t> |
| 8206 |
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
| 8207 |
</t> |
</t> |
| 8208 |
|
<t>/ EFFECT_INSTANCE SP number |
| 8209 |
|
</t> |
| 8210 |
</list> |
</list> |
| 8211 |
</t> |
</t> |
| 8212 |
<t>load_instruction = |
<t>load_instruction = |
| 8217 |
</t> |
</t> |
| 8218 |
</list> |
</list> |
| 8219 |
</t> |
</t> |
| 8220 |
|
<t>append_instruction = |
| 8221 |
|
<list> |
| 8222 |
|
<t>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP effect_instance |
| 8223 |
|
</t> |
| 8224 |
|
</list> |
| 8225 |
|
</t> |
| 8226 |
|
<t>insert_instruction = |
| 8227 |
|
<list> |
| 8228 |
|
<t>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos SP effect_instance |
| 8229 |
|
</t> |
| 8230 |
|
</list> |
| 8231 |
|
</t> |
| 8232 |
<t>set_chan_instruction = |
<t>set_chan_instruction = |
| 8233 |
<list> |
<list> |
| 8234 |
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
| 8307 |
</t> |
</t> |
| 8308 |
<t>/ AVAILABLE_ENGINES |
<t>/ AVAILABLE_ENGINES |
| 8309 |
</t> |
</t> |
| 8310 |
|
<t>/ AVAILABLE_EFFECTS |
| 8311 |
|
</t> |
| 8312 |
|
<t>/ EFFECT_INSTANCES |
| 8313 |
|
</t> |
| 8314 |
|
<t>/ SEND_EFFECT_CHAINS SP number |
| 8315 |
|
</t> |
| 8316 |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
| 8317 |
</t> |
</t> |
| 8318 |
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
| 8367 |
</t> |
</t> |
| 8368 |
</list> |
</list> |
| 8369 |
</t> |
</t> |
| 8370 |
|
<t>effect_instance = |
| 8371 |
|
<list> |
| 8372 |
|
<t>number |
| 8373 |
|
</t> |
| 8374 |
|
</list> |
| 8375 |
|
</t> |
| 8376 |
<t>device_index = |
<t>device_index = |
| 8377 |
<list> |
<list> |
| 8378 |
<t>number |
<t>number |
| 8443 |
</t> |
</t> |
| 8444 |
</list> |
</list> |
| 8445 |
</t> |
</t> |
| 8446 |
|
<t>control_value = |
| 8447 |
|
<list> |
| 8448 |
|
<t>real |
| 8449 |
|
</t> |
| 8450 |
|
</list> |
| 8451 |
|
</t> |
| 8452 |
<t>sampler_channel = |
<t>sampler_channel = |
| 8453 |
<list> |
<list> |
| 8454 |
<t>number |
<t>number |
| 8503 |
</t> |
</t> |
| 8504 |
</list> |
</list> |
| 8505 |
</t> |
</t> |
| 8506 |
|
<t>effect_name = |
| 8507 |
|
<list> |
| 8508 |
|
<t>stringval_escaped |
| 8509 |
|
</t> |
| 8510 |
|
</list> |
| 8511 |
|
</t> |
| 8512 |
|
<t>effect_index = |
| 8513 |
|
<list> |
| 8514 |
|
<t>number |
| 8515 |
|
</t> |
| 8516 |
|
</list> |
| 8517 |
|
</t> |
| 8518 |
|
<t>effect_chain = |
| 8519 |
|
<list> |
| 8520 |
|
<t>number |
| 8521 |
|
</t> |
| 8522 |
|
</list> |
| 8523 |
|
</t> |
| 8524 |
|
<t>chain_pos = |
| 8525 |
|
<list> |
| 8526 |
|
<t>number |
| 8527 |
|
</t> |
| 8528 |
|
</list> |
| 8529 |
|
</t> |
| 8530 |
|
<t>input_control = |
| 8531 |
|
<list> |
| 8532 |
|
<t>number |
| 8533 |
|
</t> |
| 8534 |
|
</list> |
| 8535 |
|
</t> |
| 8536 |
<t>param_val_list = |
<t>param_val_list = |
| 8537 |
<list> |
<list> |
| 8538 |
<t>param_val |
<t>param_val |
| 8580 |
</t> |
</t> |
| 8581 |
</list> |
</list> |
| 8582 |
</t> |
</t> |
| 8583 |
|
<t>effect_system = |
| 8584 |
|
<list> |
| 8585 |
|
<t>string |
| 8586 |
|
</t> |
| 8587 |
|
</list> |
| 8588 |
|
</t> |
| 8589 |
|
<t>module = |
| 8590 |
|
<list> |
| 8591 |
|
<t>filename |
| 8592 |
|
</t> |
| 8593 |
|
</list> |
| 8594 |
|
</t> |
| 8595 |
|
|
| 8596 |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
| 8597 |
|
|
| 8659 |
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
| 8660 |
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
| 8661 |
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
| 8662 |
|
<t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t> |
| 8663 |
|
<t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t> |
| 8664 |
|
<t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t> |
| 8665 |
</list> |
</list> |
| 8666 |
Note that the forward slash character ('/') has a special meaning in |
Note that the forward slash character ('/') has a special meaning in |
| 8667 |
filename / path based arguments: it acts as separator of the nodes in |
filename / path based arguments: it acts as separator of the nodes in |
| 8706 |
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
| 8707 |
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
| 8708 |
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
| 8709 |
|
<t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t> |
| 8710 |
|
<t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t> |
| 8711 |
|
<t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t> |
| 8712 |
</list> |
</list> |
| 8713 |
Please note that these lists are manually maintained. If you |
Please note that these lists are manually maintained. If you |
| 8714 |
find a command that also supports escape sequences we forgot to |
find a command that also supports escape sequences we forgot to |
| 9121 |
replaced by the optional dotted floating point value, reflecting the |
replaced by the optional dotted floating point value, reflecting the |
| 9122 |
new global volume parameter.</t> |
new global volume parameter.</t> |
| 9123 |
</list> |
</list> |
| 9124 |
|
<list> |
| 9125 |
|
<t>"NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the |
| 9126 |
|
golbal limit of the sampler for maximum voices is changed, where |
| 9127 |
|
<max-voices> will be an integer value, reflecting the |
| 9128 |
|
new global voice limit parameter.</t> |
| 9129 |
|
</list> |
| 9130 |
|
<list> |
| 9131 |
|
<t>"NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the |
| 9132 |
|
golbal limit of the sampler for maximum disk streams is changed, where |
| 9133 |
|
<max-streams> will be an integer value, reflecting the |
| 9134 |
|
new global disk streams limit parameter.</t> |
| 9135 |
|
</list> |
| 9136 |
</t> |
</t> |
| 9137 |
</section> |
</section> |
| 9138 |
|
|
Parent Directory
| 
Revision Log
| 
Patch