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.2cvs"> |
<rfc category="std" ipr="full3978" docName="LSCP 1.5"> |
20 |
<front> |
<front> |
21 |
<title>LinuxSampler Control Protocol (draft)</title> |
<title>LinuxSampler Control Protocol</title> |
22 |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
23 |
Schoenebeck'> |
Schoenebeck'> |
24 |
<organization> |
<organization> |
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="October" year="2007"/> |
<date month="June" year="2011"/> |
38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
40 |
<abstract> |
<abstract> |
2162 |
</t> |
</t> |
2163 |
</list> |
</list> |
2164 |
</t> |
</t> |
2165 |
<t>Example:</t> |
<t>Example (Unix):</t> |
2166 |
<t> |
<t> |
2167 |
<list> |
<list> |
2168 |
<t></t> |
<t>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0</t> |
2169 |
|
<t>S: OK</t> |
2170 |
|
</list> |
2171 |
|
</t> |
2172 |
|
<t>Example (Windows):</t> |
2173 |
|
<t> |
2174 |
|
<list> |
2175 |
|
<t>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0</t> |
2176 |
|
<t>S: OK</t> |
2177 |
</list> |
</list> |
2178 |
</t> |
</t> |
2179 |
</section> |
</section> |
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> |
3838 |
</t> |
</t> |
3839 |
</section> |
</section> |
3840 |
|
|
3841 |
|
<section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA"> |
3842 |
|
<t>The front-end can send MIDI events to a specific sampler channel |
3843 |
|
by sending the following command:</t> |
3844 |
|
<t> |
3845 |
|
<list> |
3846 |
|
<t>SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2></t> |
3847 |
|
</list> |
3848 |
|
</t> |
3849 |
|
<t>Where <sampler-chan> is the sampler channel number |
3850 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3851 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3852 |
|
<arg1> and <arg2> arguments depend on the <midi-msg> argument, which |
3853 |
|
specifies the MIDI message type. Currently, the following MIDI messages are supported:</t> |
3854 |
|
<t> |
3855 |
|
<list> |
3856 |
|
<t>"NOTE_ON" - |
3857 |
|
<list> |
3858 |
|
<t>For turning on MIDI notes, where <arg1> |
3859 |
|
specifies the key number and <arg2> the velocity |
3860 |
|
as described in the MIDI specification.</t> |
3861 |
|
</list> |
3862 |
|
</t> |
3863 |
|
<t>"NOTE_OFF" - |
3864 |
|
<list> |
3865 |
|
<t>For turning a currently playing MIDI note off, where <arg1> |
3866 |
|
specifies the key number and <arg2> the velocity |
3867 |
|
as described in the MIDI specification.</t> |
3868 |
|
</list> |
3869 |
|
</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> |
3879 |
|
</t> |
3880 |
|
<t>CAUTION: This command is provided for implementations of virtual MIDI keyboards |
3881 |
|
and no realtime guarantee whatsoever will be made!</t> |
3882 |
|
<t>Possible Answers:</t> |
3883 |
|
<t> |
3884 |
|
<list> |
3885 |
|
<t>"OK" - |
3886 |
|
<list> |
3887 |
|
<t>on success</t> |
3888 |
|
</list> |
3889 |
|
</t> |
3890 |
|
<t>"ERR:<error-code>:<error-message>" - |
3891 |
|
<list> |
3892 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3893 |
|
</list> |
3894 |
|
</t> |
3895 |
|
</list> |
3896 |
|
</t> |
3897 |
|
<t>Example:</t> |
3898 |
|
<t> |
3899 |
|
<list> |
3900 |
|
<t>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"</t> |
3901 |
|
<t>S: "OK"</t> |
3902 |
|
</list> |
3903 |
|
</t> |
3904 |
|
</section> |
3905 |
|
|
3906 |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
3907 |
<t>The front-end can reset a particular sampler channel by sending the following command:</t> |
<t>The front-end can reset a particular sampler channel by sending the following command:</t> |
3908 |
<t> |
<t> |
4124 |
</t> |
</t> |
4125 |
</section> |
</section> |
4126 |
|
|
4127 |
|
<section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT"> |
4128 |
|
<t>The front-end can ask for the current number of active disk streams on |
4129 |
|
the sampler by sending the following command:</t> |
4130 |
|
<t> |
4131 |
|
<list> |
4132 |
|
<t>GET TOTAL_STREAM_COUNT</t> |
4133 |
|
</list> |
4134 |
|
</t> |
4135 |
|
|
4136 |
|
<t>Possible Answers:</t> |
4137 |
|
<t> |
4138 |
|
<list> |
4139 |
|
<t>LinuxSampler will answer by returning the number of all active |
4140 |
|
disk streams on the sampler.</t> |
4141 |
|
</list> |
4142 |
|
</t> |
4143 |
|
</section> |
4144 |
|
|
4145 |
<section title="Reset sampler" anchor="RESET"> |
<section title="Reset sampler" anchor="RESET"> |
4146 |
<t>The front-end can reset the whole sampler by sending the following command:</t> |
<t>The front-end can reset the whole sampler by sending the following command:</t> |
4147 |
<t> |
<t> |
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 |
|
|
5622 |
to the instruments database by sending the following command:</t> |
to the instruments database by sending the following command:</t> |
5623 |
<t> |
<t> |
5624 |
<list> |
<list> |
5625 |
<t>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path> [<instr_index>]</t> |
<t>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>[ FILE_AS_DIR]] <db_dir> <file_path> [<instr_index>]</t> |
5626 |
</list> |
</list> |
5627 |
</t> |
</t> |
5628 |
<t>Where <db_dir> is the absolute path name of a directory |
<t>Where <db_dir> is the absolute path name of a directory |
5667 |
</list> |
</list> |
5668 |
</t> |
</t> |
5669 |
|
|
5670 |
|
<t> If FILE_AS_DIR argument is supplied, all instruments in an instrument |
5671 |
|
file will be added to a separate directory in the instruments database, which |
5672 |
|
name will be the name of the instrument file with the file extension stripped off. |
5673 |
|
</t> |
5674 |
<t>The difference between regular and NON_MODAL versions of the command |
<t>The difference between regular and NON_MODAL versions of the command |
5675 |
is that the regular command returns when the scanning is finished |
is that the regular command returns when the scanning is finished |
5676 |
while NON_MODAL version returns immediately and a background process is launched. |
while NON_MODAL version returns immediately and a background process is launched. |
6074 |
</list> |
</list> |
6075 |
</t> |
</t> |
6076 |
<t>Where <instr> is the absolute path name of the instrument and |
<t>Where <instr> is the absolute path name of the instrument and |
6077 |
<desc> is the new description for the instrument |
<desc> is the new description for the instrument |
6078 |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
6079 |
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6080 |
|
|
6317 |
<t>FORMAT INSTRUMENTS_DB</t> |
<t>FORMAT INSTRUMENTS_DB</t> |
6318 |
</list> |
</list> |
6319 |
</t> |
</t> |
6320 |
|
|
6321 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
6322 |
<t> |
<t> |
6323 |
<list> |
<list> |
6336 |
</t> |
</t> |
6337 |
</section> |
</section> |
6338 |
|
|
6339 |
|
<section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES"> |
6340 |
|
<t>The front-end can retrieve the list of all instrument files in the instruments database |
6341 |
|
that don't exist in the filesystem by sending the following command:</t> |
6342 |
|
<t> |
6343 |
|
<list> |
6344 |
|
<t>FIND LOST DB_INSTRUMENT_FILES</t> |
6345 |
|
</list> |
6346 |
|
</t> |
6347 |
|
|
6348 |
|
<t>Possible Answers:</t> |
6349 |
|
<t> |
6350 |
|
<list> |
6351 |
|
<t>A comma separated list with the absolute path names |
6352 |
|
(encapsulated into apostrophes) of all lost instrument files.</t> |
6353 |
|
<t>"ERR:<error-code>:<error-message>" - |
6354 |
|
<list> |
6355 |
|
<t>in case it failed, providing an appropriate error code and error message.</t> |
6356 |
|
</list> |
6357 |
|
</t> |
6358 |
|
</list> |
6359 |
|
</t> |
6360 |
|
<t>Example:</t> |
6361 |
|
<t> |
6362 |
|
<list> |
6363 |
|
<t>C: "FIND LOST DB_INSTRUMENT_FILES"</t> |
6364 |
|
<t>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"</t> |
6365 |
|
</list> |
6366 |
|
</t> |
6367 |
|
</section> |
6368 |
|
|
6369 |
|
<section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH"> |
6370 |
|
<t>The front-end can substitute all occurrences of an instrument file |
6371 |
|
in the instruments database with a new one by sending the following command:</t> |
6372 |
|
<t> |
6373 |
|
<list> |
6374 |
|
<t>SET DB_INSTRUMENT FILE_PATH <old_path> <new_path></t> |
6375 |
|
</list> |
6376 |
|
</t> |
6377 |
|
<t>Where <old_path> is the absolute path name of the instrument file |
6378 |
|
to substitute with <new_path>.</t> |
6379 |
|
|
6380 |
|
<t>Possible Answers:</t> |
6381 |
|
<t> |
6382 |
|
<list> |
6383 |
|
<t>"OK" - |
6384 |
|
<list> |
6385 |
|
<t>on success</t> |
6386 |
|
</list> |
6387 |
|
</t> |
6388 |
|
<t>"ERR:<error-code>:<error-message>" - |
6389 |
|
<list> |
6390 |
|
<t>in case it failed, providing an appropriate error code and error message.</t> |
6391 |
|
</list> |
6392 |
|
</t> |
6393 |
|
</list> |
6394 |
|
</t> |
6395 |
|
|
6396 |
|
<t>Example:</t> |
6397 |
|
<t> |
6398 |
|
<list> |
6399 |
|
<t>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"</t> |
6400 |
|
<t>S: "OK"</t> |
6401 |
|
</list> |
6402 |
|
</t> |
6403 |
|
</section> |
6404 |
|
|
6405 |
</section> |
</section> |
6406 |
|
|
6407 |
|
|
6422 |
editor application by sending the following command:</t> |
editor application by sending the following command:</t> |
6423 |
<t> |
<t> |
6424 |
<list> |
<list> |
6425 |
<t>EDIT INSTRUMENT <sampler-channel></t> |
<t>EDIT CHANNEL INSTRUMENT <sampler-channel></t> |
6426 |
</list> |
</list> |
6427 |
</t> |
</t> |
6428 |
<t>Where <sampler-channel> should be replaced by the |
<t>Where <sampler-channel> should be replaced by the |
6474 |
<t>Examples:</t> |
<t>Examples:</t> |
6475 |
<t> |
<t> |
6476 |
<list> |
<list> |
6477 |
<t>C: "EDIT INSTRUMENT 0"</t> |
<t>C: "EDIT CHANNEL INSTRUMENT 0"</t> |
6478 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
6479 |
</list> |
</list> |
6480 |
</t> |
</t> |
6481 |
</section> |
</section> |
6482 |
</section> |
</section> |
|
</section> |
|
6483 |
|
|
6484 |
|
<section title="Managing Files" anchor="file_management"> |
6485 |
|
<t>You can query detailed informations about files located |
6486 |
|
at the same system where the sampler instance is running on. |
6487 |
|
Using this command set allows to retrieve file informations |
6488 |
|
even remotely from another machine.</t> |
6489 |
|
|
6490 |
|
<section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS"> |
6491 |
|
<t>The front-end can retrieve the amount of instruments |
6492 |
|
within a given instrument file by sending the |
6493 |
|
following command:</t> |
6494 |
|
<t> |
6495 |
|
<list> |
6496 |
|
<t>GET FILE INSTRUMENTS <filename></t> |
6497 |
|
</list> |
6498 |
|
</t> |
6499 |
|
<t>Where <filename> is the name of the instrument |
6500 |
|
file (encapsulated into apostrophes, supporting escape |
6501 |
|
sequences as described in chapter |
6502 |
|
"<xref target="character_set">Character Set and Escape |
6503 |
|
Sequences</xref>").</t> |
6504 |
|
|
6505 |
|
<t>The sampler will try to ask all sampler engines, |
6506 |
|
whether they support the given file and ask the first |
6507 |
|
engine with a positive answer for the amount of |
6508 |
|
instruments.</t> |
6509 |
|
|
6510 |
|
<t>Possible Answers:</t> |
6511 |
|
<t> |
6512 |
|
<list> |
6513 |
|
<t>On success, the sampler will answer by |
6514 |
|
returning the amount of instruments. |
6515 |
|
</t> |
6516 |
|
<t>"ERR:<error-code>:<error-message>" - |
6517 |
|
<list> |
6518 |
|
<t>if the file could not be handled</t> |
6519 |
|
</list> |
6520 |
|
</t> |
6521 |
|
</list> |
6522 |
|
</t> |
6523 |
|
|
6524 |
|
<t>Examples:</t> |
6525 |
|
<t> |
6526 |
|
<list> |
6527 |
|
<t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
6528 |
|
<t>S: "10"</t> |
6529 |
|
</list> |
6530 |
|
</t> |
6531 |
|
</section> |
6532 |
|
|
6533 |
|
<section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS"> |
6534 |
|
<t>The front-end can retrieve a list of all instruments |
6535 |
|
within a given instrument file by sending the |
6536 |
|
following command:</t> |
6537 |
|
<t> |
6538 |
|
<list> |
6539 |
|
<t>LIST FILE INSTRUMENTS <filename></t> |
6540 |
|
</list> |
6541 |
|
</t> |
6542 |
|
<t>Where <filename> is the name of the instrument |
6543 |
|
file (encapsulated into apostrophes, supporting escape |
6544 |
|
sequences as described in chapter |
6545 |
|
"<xref target="character_set">Character Set and Escape |
6546 |
|
Sequences</xref>").</t> |
6547 |
|
|
6548 |
|
<t>The sampler will try to ask all sampler engines, |
6549 |
|
whether they support the given file and ask the first |
6550 |
|
engine with a positive answer for a list of IDs for the |
6551 |
|
instruments in the given file.</t> |
6552 |
|
|
6553 |
|
<t>Possible Answers:</t> |
6554 |
|
<t> |
6555 |
|
<list> |
6556 |
|
<t>On success, the sampler will answer by |
6557 |
|
returning a comma separated list of |
6558 |
|
instrument IDs. |
6559 |
|
</t> |
6560 |
|
<t>"ERR:<error-code>:<error-message>" - |
6561 |
|
<list> |
6562 |
|
<t>if the file could not be handled</t> |
6563 |
|
</list> |
6564 |
|
</t> |
6565 |
|
</list> |
6566 |
|
</t> |
6567 |
|
|
6568 |
|
<t>Examples:</t> |
6569 |
|
<t> |
6570 |
|
<list> |
6571 |
|
<t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
6572 |
|
<t>S: "0,1,2,3,4,5,6,7,8,9"</t> |
6573 |
|
</list> |
6574 |
|
</t> |
6575 |
|
</section> |
6576 |
|
|
6577 |
|
<section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO"> |
6578 |
|
<t>The front-end can retrieve detailed informations |
6579 |
|
about a specific instrument within a given instrument |
6580 |
|
file by sending the following command:</t> |
6581 |
|
<t> |
6582 |
|
<list> |
6583 |
|
<t>GET FILE INSTRUMENT INFO <filename> |
6584 |
|
<instr-id></t> |
6585 |
|
</list> |
6586 |
|
</t> |
6587 |
|
<t>Where <filename> is the name of the instrument |
6588 |
|
file (encapsulated into apostrophes, supporting escape |
6589 |
|
sequences as described in chapter |
6590 |
|
"<xref target="character_set">Character Set and Escape |
6591 |
|
Sequences</xref>") and <instr-id> is the numeric |
6592 |
|
instrument ID as returned by the |
6593 |
|
<xref target="LIST FILE INSTRUMENTS"> |
6594 |
|
"LIST FILE INSTRUMENTS"</xref> command.</t> |
6595 |
|
|
6596 |
|
<t>The sampler will try to ask all sampler engines, |
6597 |
|
whether they support the given file and ask the first |
6598 |
|
engine with a positive answer for informations about the |
6599 |
|
specific instrument in the given file.</t> |
6600 |
|
|
6601 |
|
<t>Possible Answers:</t> |
6602 |
|
<t> |
6603 |
|
<list> |
6604 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
6605 |
|
Each answer line begins with the settings category name |
6606 |
|
followed by a colon and then a space character <SP> and finally |
6607 |
|
the info character string to that setting category. At the |
6608 |
|
moment the following categories are defined:</t> |
6609 |
|
|
6610 |
|
<t> |
6611 |
|
<list> |
6612 |
|
<t>NAME - |
6613 |
|
<list> |
6614 |
|
<t>name of the instrument as |
6615 |
|
stored in the instrument file</t> |
6616 |
|
</list> |
6617 |
|
</t> |
6618 |
|
<t>FORMAT_FAMILY - |
6619 |
|
<list> |
6620 |
|
<t>name of the sampler format |
6621 |
|
of the given instrument</t> |
6622 |
|
</list> |
6623 |
|
</t> |
6624 |
|
<t>FORMAT_VERSION - |
6625 |
|
<list> |
6626 |
|
<t>version of the sampler format |
6627 |
|
the instrumen is stored as</t> |
6628 |
|
</list> |
6629 |
|
</t> |
6630 |
|
<t>PRODUCT - |
6631 |
|
<list> |
6632 |
|
<t>official product name of the |
6633 |
|
instrument as stored in the file |
6634 |
|
</t> |
6635 |
|
</list> |
6636 |
|
</t> |
6637 |
|
<t>ARTISTS - |
6638 |
|
<list> |
6639 |
|
<t>artists / sample library |
6640 |
|
vendor of the instrument</t> |
6641 |
|
</list> |
6642 |
|
</t> |
6643 |
|
<t>KEY_BINDINGS - |
6644 |
|
<list> |
6645 |
|
<t>comma separated list of integer values representing |
6646 |
|
the instrument's key mapping in the range between 0 .. 127, |
6647 |
|
reflecting the analog meaning of the MIDI specification.</t> |
6648 |
|
</list> |
6649 |
|
</t> |
6650 |
|
<t>KEYSWITCH_BINDINGS - |
6651 |
|
<list> |
6652 |
|
<t>comma separated list of integer values representing |
6653 |
|
the instrument's keyswitch mapping in the range between 0 .. 127, |
6654 |
|
reflecting the analog meaning of the MIDI specification.</t> |
6655 |
|
</list> |
6656 |
|
</t> |
6657 |
|
</list> |
6658 |
|
</t> |
6659 |
|
</list> |
6660 |
|
</t> |
6661 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
6662 |
|
|
6663 |
|
<t>Example:</t> |
6664 |
|
<t> |
6665 |
|
<list> |
6666 |
|
<t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t> |
6667 |
|
<t>S: "NAME: Lunatic Loops"</t> |
6668 |
|
<t> "FORMAT_FAMILY: GIG"</t> |
6669 |
|
<t> "FORMAT_VERSION: 3"</t> |
6670 |
|
<t> "PRODUCT: The Backbone Bongo Beats"</t> |
6671 |
|
<t> "ARTISTS: Jimmy the Fish"</t> |
6672 |
|
<t> "."</t> |
6673 |
|
</list> |
6674 |
|
</t> |
6675 |
|
</section> |
6676 |
|
</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: "DESCRIPTION: Base delay (s)"</t> |
7272 |
|
<t> "VALUE: 0.500"</t> |
7273 |
|
<t> "RANGE_MIN: 0.000"</t> |
7274 |
|
<t> "."</t> |
7275 |
|
</list> |
7276 |
|
</t> |
7277 |
|
</section> |
7278 |
|
|
7279 |
|
<section title="Altering an effect parameter" anchor="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE"> |
7280 |
|
<t>The front-end can alter the current value of an effect |
7281 |
|
parameter by sending the following command:</t> |
7282 |
|
<t> |
7283 |
|
<list> |
7284 |
|
<t>SET EFFECT_INSTANCE_INPUT_CONTROL VALUE <effect-instance> <input-control> <value></t> |
7285 |
|
</list> |
7286 |
|
</t> |
7287 |
|
<t>Where <effect-instance> is the numerical ID of the |
7288 |
|
effect instance as returned by the |
7289 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
7290 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7291 |
|
command, <input-control> is the index of the input |
7292 |
|
control within the numerical bounds as returned by the |
7293 |
|
"INPUT_CONTROLS" field of the |
7294 |
|
<xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref> |
7295 |
|
command and <value> is the new (optional dotted) |
7296 |
|
floating point value for this effect parameter.</t> |
7297 |
|
|
7298 |
|
<t>Possible Answers:</t> |
7299 |
|
<t> |
7300 |
|
<list> |
7301 |
|
<t>"OK" - |
7302 |
|
<list> |
7303 |
|
<t>in case the effect was altered successfully</t> |
7304 |
|
</list> |
7305 |
|
</t> |
7306 |
|
<t>"ERR:<error-code>:<error-message>" - |
7307 |
|
<list> |
7308 |
|
<t>in case it failed, providing an appropriate error code and |
7309 |
|
error message</t> |
7310 |
|
</list> |
7311 |
|
</t> |
7312 |
|
</list> |
7313 |
|
</t> |
7314 |
|
|
7315 |
|
<t>Examples:</t> |
7316 |
|
<t> |
7317 |
|
<list> |
7318 |
|
<t>C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5"</t> |
7319 |
|
<t>S: "OK"</t> |
7320 |
|
</list> |
7321 |
|
</t> |
7322 |
|
</section> |
7323 |
|
|
7324 |
|
<section title="Retrieve amount of send effect chains" anchor="GET SEND_EFFECT_CHAINS"> |
7325 |
|
<t>The front-end can retrieve the current amount of send |
7326 |
|
effect chains of an audio output device by sending the |
7327 |
|
following command:</t> |
7328 |
|
<t> |
7329 |
|
<list> |
7330 |
|
<t>GET SEND_EFFECT_CHAINS <audio-device></t> |
7331 |
|
</list> |
7332 |
|
</t> |
7333 |
|
<t>Where <audio-device> should be replaced by the |
7334 |
|
numerical ID of the audio output device as given by the |
7335 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7336 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7337 |
|
command.</t> |
7338 |
|
|
7339 |
|
<t>Possible Answers:</t> |
7340 |
|
<t> |
7341 |
|
<list> |
7342 |
|
<t>The sampler will answer by returning the current |
7343 |
|
number of send effect chains of the supplied audio |
7344 |
|
output device.</t> |
7345 |
|
</list> |
7346 |
|
</t> |
7347 |
|
|
7348 |
|
<t>Examples:</t> |
7349 |
|
<t> |
7350 |
|
<list> |
7351 |
|
<t>C: "GET SEND_EFFECT_CHAINS 0"</t> |
7352 |
|
<t>S: "4"</t> |
7353 |
|
</list> |
7354 |
|
</t> |
7355 |
|
</section> |
7356 |
|
|
7357 |
|
<section title="Retrieve list of send effect chains" anchor="LIST SEND_EFFECT_CHAINS"> |
7358 |
|
<t>The front-end can retrieve the current list of send |
7359 |
|
effect chains of an audio output device by sending the |
7360 |
|
following command:</t> |
7361 |
|
<t> |
7362 |
|
<list> |
7363 |
|
<t>LIST SEND_EFFECT_CHAINS <audio-device></t> |
7364 |
|
</list> |
7365 |
|
</t> |
7366 |
|
<t>Where <audio-device> should be replaced by the |
7367 |
|
numerical ID of the audio output device as given by the |
7368 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7369 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7370 |
|
command.</t> |
7371 |
|
|
7372 |
|
<t>Possible Answers:</t> |
7373 |
|
<t> |
7374 |
|
<list> |
7375 |
|
<t>The sampler will answer by returning a comma |
7376 |
|
separated list with numerical IDs of send effect |
7377 |
|
chains of the supplied audio output device. |
7378 |
|
</t> |
7379 |
|
</list> |
7380 |
|
</t> |
7381 |
|
|
7382 |
|
<t>Examples:</t> |
7383 |
|
<t> |
7384 |
|
<list> |
7385 |
|
<t>C: "LIST SEND_EFFECT_CHAINS 0"</t> |
7386 |
|
<t>S: "3,4,7"</t> |
7387 |
|
</list> |
7388 |
|
</t> |
7389 |
|
</section> |
7390 |
|
|
7391 |
|
<section title="Add send effect chain" anchor="ADD SEND_EFFECT_CHAIN"> |
7392 |
|
<t>The front-end can add a send effect chain by sending the |
7393 |
|
following command:</t> |
7394 |
|
<t> |
7395 |
|
<list> |
7396 |
|
<t>ADD SEND_EFFECT_CHAIN <audio-device></t> |
7397 |
|
</list> |
7398 |
|
</t> |
7399 |
|
<t>Where <audio-device> should be replaced by the |
7400 |
|
numerical ID of the audio output device as given by the |
7401 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7402 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7403 |
|
command.</t> |
7404 |
|
|
7405 |
|
<t>Possible Answers:</t> |
7406 |
|
<t> |
7407 |
|
<list> |
7408 |
|
<t>"OK[<effect-chain>]" - |
7409 |
|
<list> |
7410 |
|
<t>in case the send effect chain was |
7411 |
|
added successfully, where |
7412 |
|
<effect-chain> is the numerical ID |
7413 |
|
of the new send effect chain</t> |
7414 |
|
</list> |
7415 |
|
</t> |
7416 |
|
<t>"ERR:<error-code>:<error-message>" - |
7417 |
|
<list> |
7418 |
|
<t>if the send effect chain could not be added</t> |
7419 |
|
</list> |
7420 |
|
</t> |
7421 |
|
</list> |
7422 |
|
</t> |
7423 |
|
|
7424 |
|
<t>Examples:</t> |
7425 |
|
<t> |
7426 |
|
<list> |
7427 |
|
<t>C: "ADD SEND_EFFECT_CHAIN 0"</t> |
7428 |
|
<t>S: "OK[2]"</t> |
7429 |
|
</list> |
7430 |
|
</t> |
7431 |
|
</section> |
7432 |
|
|
7433 |
|
<section title="Remove send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN"> |
7434 |
|
<t>The front-end can remove a send effect chain by sending |
7435 |
|
the following command:</t> |
7436 |
|
<t> |
7437 |
|
<list> |
7438 |
|
<t>REMOVE SEND_EFFECT_CHAIN <audio-device> <effect-chain></t> |
7439 |
|
</list> |
7440 |
|
</t> |
7441 |
|
<t>Where <audio-device> should be replaced by the |
7442 |
|
numerical ID of the audio output device as given by the |
7443 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7444 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7445 |
|
command and <effect-chain> by the numerical ID as |
7446 |
|
returned by the |
7447 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7448 |
|
or |
7449 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7450 |
|
command.</t> |
7451 |
|
|
7452 |
|
<t>Possible Answers:</t> |
7453 |
|
<t> |
7454 |
|
<list> |
7455 |
|
<t>"OK" - |
7456 |
|
<list> |
7457 |
|
<t>in case the send effect chain was |
7458 |
|
removed successfully</t> |
7459 |
|
</list> |
7460 |
|
</t> |
7461 |
|
<t>"ERR:<error-code>:<error-message>" - |
7462 |
|
<list> |
7463 |
|
<t>if the send effect chain could not be removed</t> |
7464 |
|
</list> |
7465 |
|
</t> |
7466 |
|
</list> |
7467 |
|
</t> |
7468 |
|
|
7469 |
|
<t>Examples:</t> |
7470 |
|
<t> |
7471 |
|
<list> |
7472 |
|
<t>C: "REMOVE SEND_EFFECT_CHAIN 0 2"</t> |
7473 |
|
<t>S: "OK"</t> |
7474 |
|
</list> |
7475 |
|
</t> |
7476 |
|
</section> |
7477 |
|
|
7478 |
|
<section title="Retrieving information about a send effect chain" anchor="GET SEND_EFFECT_CHAIN INFO"> |
7479 |
|
<t>The front-end can ask for informations of a send effect |
7480 |
|
chain by sending the following command:</t> |
7481 |
|
<t> |
7482 |
|
<list> |
7483 |
|
<t>GET SEND_EFFECT_CHAIN INFO <audio-device> <effect-chain></t> |
7484 |
|
</list> |
7485 |
|
</t> |
7486 |
|
<t>Where <audio-device> should be replaced by the |
7487 |
|
numerical ID of the audio output device as given by the |
7488 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7489 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7490 |
|
command and <effect-chain> by the numerical ID as |
7491 |
|
returned by the |
7492 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7493 |
|
or |
7494 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7495 |
|
command.</t> |
7496 |
|
|
7497 |
|
<t>Possible Answers:</t> |
7498 |
|
<t> |
7499 |
|
<list> |
7500 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
7501 |
|
Each answer line begins with the information |
7502 |
|
category name, followed by a colon and then a space |
7503 |
|
character <SP> and finally the info character |
7504 |
|
string to that information category. |
7505 |
|
At the moment the following categories are defined:</t> |
7506 |
|
<t> |
7507 |
|
<list> |
7508 |
|
<t>EFFECT_COUNT - |
7509 |
|
<list> |
7510 |
|
<t>amount of effects in this send |
7511 |
|
effect chain</t> |
7512 |
|
</list> |
7513 |
|
</t> |
7514 |
|
<t>EFFECT_SEQUENCE - |
7515 |
|
<list> |
7516 |
|
<t>comma separated list of the |
7517 |
|
numerical IDs of the effect |
7518 |
|
instances in this send effect chain, |
7519 |
|
in the order as they are procssed in |
7520 |
|
the effect chain</t> |
7521 |
|
</list> |
7522 |
|
</t> |
7523 |
|
</list> |
7524 |
|
</t> |
7525 |
|
</list> |
7526 |
|
</t> |
7527 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
7528 |
|
|
7529 |
|
<t>Example:</t> |
7530 |
|
<t> |
7531 |
|
<list> |
7532 |
|
<t>C: "GET SEND_EFFECT_CHAIN INFO 0 2"</t> |
7533 |
|
<t>S: "EFFECT_COUNT: 3"</t> |
7534 |
|
<t> "EFFECT_SEQUENCE: 31,4,7"</t> |
7535 |
|
<t> "."</t> |
7536 |
|
</list> |
7537 |
|
</t> |
7538 |
|
</section> |
7539 |
|
|
7540 |
|
<section title="Append effect instance to a send effect chain" anchor="APPEND SEND_EFFECT_CHAIN EFFECT"> |
7541 |
|
<t>The front-end can add an unused effect instance to the |
7542 |
|
end of a send effect chain by sending the following command:</t> |
7543 |
|
<t> |
7544 |
|
<list> |
7545 |
|
<t>APPEND SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <effect-instance></t> |
7546 |
|
</list> |
7547 |
|
</t> |
7548 |
|
<t>Where <audio-device> should be replaced by the |
7549 |
|
numerical ID of the audio output device as given by the |
7550 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7551 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7552 |
|
command and <effect-chain> by the numerical ID as |
7553 |
|
returned by the |
7554 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7555 |
|
or |
7556 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7557 |
|
command and <effect-instance> as returned by the |
7558 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
7559 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7560 |
|
command.</t> |
7561 |
|
<t>Only unused effect instances can be added to the effect |
7562 |
|
chain. Trying to add an effect instance which is already in |
7563 |
|
use somewhere in the audio signal path of the sampler will |
7564 |
|
result in an error.</t> |
7565 |
|
|
7566 |
|
<t>Possible Answers:</t> |
7567 |
|
<t> |
7568 |
|
<list> |
7569 |
|
<t>"OK" - |
7570 |
|
<list> |
7571 |
|
<t>in case the effect instance was |
7572 |
|
added successfully to the chain</t> |
7573 |
|
</list> |
7574 |
|
</t> |
7575 |
|
<t>"ERR:<error-code>:<error-message>" - |
7576 |
|
<list> |
7577 |
|
<t>if the effect instance could not be added</t> |
7578 |
|
</list> |
7579 |
|
</t> |
7580 |
|
</list> |
7581 |
|
</t> |
7582 |
|
|
7583 |
|
<t>Examples:</t> |
7584 |
|
<t> |
7585 |
|
<list> |
7586 |
|
<t>C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38"</t> |
7587 |
|
<t>S: "OK"</t> |
7588 |
|
</list> |
7589 |
|
</t> |
7590 |
|
</section> |
7591 |
|
|
7592 |
|
<section title="Insert effect instance to a send effect chain" anchor="INSERT SEND_EFFECT_CHAIN EFFECT"> |
7593 |
|
<t>The front-end can add an unused effect instance to a |
7594 |
|
certain position of a send effect chain by sending the |
7595 |
|
following command:</t> |
7596 |
|
<t> |
7597 |
|
<list> |
7598 |
|
<t>INSERT SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos> <effect-instance></t> |
7599 |
|
</list> |
7600 |
|
</t> |
7601 |
|
<t>Where <audio-device> should be replaced by the |
7602 |
|
numerical ID of the audio output device as given by the |
7603 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7604 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7605 |
|
command, <effect-chain> by the numerical ID as |
7606 |
|
returned by the |
7607 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7608 |
|
or |
7609 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7610 |
|
command, <effect-instance> as returned by the |
7611 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
7612 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7613 |
|
command and <chain-pos> the exact position of the |
7614 |
|
effect chain where the supplied effect shall be inserted |
7615 |
|
to.</t> |
7616 |
|
<t>Only unused effect instances can be added to the effect |
7617 |
|
chain. Trying to add an effect instance which is already in |
7618 |
|
use somewhere in the audio signal path of the sampler will |
7619 |
|
result in an error.</t> |
7620 |
|
|
7621 |
|
<t>Possible Answers:</t> |
7622 |
|
<t> |
7623 |
|
<list> |
7624 |
|
<t>"OK" - |
7625 |
|
<list> |
7626 |
|
<t>in case the effect instance was |
7627 |
|
added successfully to the chain</t> |
7628 |
|
</list> |
7629 |
|
</t> |
7630 |
|
<t>"ERR:<error-code>:<error-message>" - |
7631 |
|
<list> |
7632 |
|
<t>if the effect instance could not be added</t> |
7633 |
|
</list> |
7634 |
|
</t> |
7635 |
|
</list> |
7636 |
|
</t> |
7637 |
|
|
7638 |
|
<t>Examples:</t> |
7639 |
|
<t> |
7640 |
|
<list> |
7641 |
|
<t>C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38"</t> |
7642 |
|
<t>S: "OK"</t> |
7643 |
|
</list> |
7644 |
|
</t> |
7645 |
|
</section> |
7646 |
|
|
7647 |
|
<section title="Remove effect instance from send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN EFFECT"> |
7648 |
|
<t>The front-end can remove an effect instance from a |
7649 |
|
certain position of a send effect chain by sending the |
7650 |
|
following command:</t> |
7651 |
|
<t> |
7652 |
|
<list> |
7653 |
|
<t>REMOVE SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos></t> |
7654 |
|
</list> |
7655 |
|
</t> |
7656 |
|
<t>Where <audio-device> should be replaced by the |
7657 |
|
numerical ID of the audio output device as given by the |
7658 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7659 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7660 |
|
command, <effect-chain> by the numerical ID as |
7661 |
|
returned by the |
7662 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7663 |
|
or |
7664 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7665 |
|
command and <chain-pos> the exact position of the |
7666 |
|
effect instance to be removed from the effect chain.</t> |
7667 |
|
|
7668 |
|
<t>Possible Answers:</t> |
7669 |
|
<t> |
7670 |
|
<list> |
7671 |
|
<t>"OK" - |
7672 |
|
<list> |
7673 |
|
<t>in case the effect instance was |
7674 |
|
removed successfully</t> |
7675 |
|
</list> |
7676 |
|
</t> |
7677 |
|
<t>"ERR:<error-code>:<error-message>" - |
7678 |
|
<list> |
7679 |
|
<t>if the effect instance could not be removed</t> |
7680 |
|
</list> |
7681 |
|
</t> |
7682 |
|
</list> |
7683 |
|
</t> |
7684 |
|
|
7685 |
|
<t>Examples:</t> |
7686 |
|
<t> |
7687 |
|
<list> |
7688 |
|
<t>C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4"</t> |
7689 |
|
<t>S: "OK"</t> |
7690 |
|
</list> |
7691 |
|
</t> |
7692 |
|
</section> |
7693 |
|
|
7694 |
|
</section> |
7695 |
|
</section> |
7696 |
|
|
7697 |
<section title="Command Syntax" anchor="command_syntax"> |
<section title="Command Syntax" anchor="command_syntax"> |
7698 |
<t>The grammar of the control protocol as descibed in <xref target="control_commands"/> |
<t>The grammar of the control protocol as descibed in <xref target="control_commands"/> |
7780 |
</t> |
</t> |
7781 |
<t>/ FORMAT SP format_instruction |
<t>/ FORMAT SP format_instruction |
7782 |
</t> |
</t> |
7783 |
|
<t>/ SEND SP send_instruction |
7784 |
|
</t> |
7785 |
|
<t>/ APPEND SP append_instruction |
7786 |
|
</t> |
7787 |
|
<t>/ INSERT SP insert_instruction |
7788 |
|
</t> |
7789 |
<t>/ RESET |
<t>/ RESET |
7790 |
</t> |
</t> |
7791 |
<t>/ QUIT |
<t>/ QUIT |
7800 |
</t> |
</t> |
7801 |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
7802 |
</t> |
</t> |
7803 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
7804 |
|
</t> |
7805 |
<t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
<t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
7806 |
</t> |
</t> |
7807 |
|
<t>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
7808 |
|
</t> |
7809 |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
7810 |
</t> |
</t> |
7811 |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index |
7818 |
</t> |
</t> |
7819 |
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
7820 |
</t> |
</t> |
7821 |
|
<t>/ SEND_EFFECT_CHAIN SP device_index |
7822 |
|
</t> |
7823 |
</list> |
</list> |
7824 |
</t> |
</t> |
7825 |
<t>subscribe_event = |
<t>subscribe_event = |
7834 |
</t> |
</t> |
7835 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
7836 |
</t> |
</t> |
7837 |
|
<t>/ CHANNEL_MIDI |
7838 |
|
</t> |
7839 |
|
<t>/ DEVICE_MIDI |
7840 |
|
</t> |
7841 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
7842 |
</t> |
</t> |
7843 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
7870 |
</t> |
</t> |
7871 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
7872 |
</t> |
</t> |
7873 |
|
<t>/ TOTAL_STREAM_COUNT |
7874 |
|
</t> |
7875 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
7876 |
</t> |
</t> |
7877 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
7878 |
</t> |
</t> |
7879 |
|
<t>/ EFFECT_INSTANCE_COUNT |
7880 |
|
</t> |
7881 |
|
<t>/ EFFECT_INSTANCE_INFO |
7882 |
|
</t> |
7883 |
|
<t>/ SEND_EFFECT_CHAIN_COUNT |
7884 |
|
</t> |
7885 |
|
<t>/ SEND_EFFECT_CHAIN_INFO |
7886 |
|
</t> |
7887 |
</list> |
</list> |
7888 |
</t> |
</t> |
7889 |
<t>unsubscribe_event = |
<t>unsubscribe_event = |
7898 |
</t> |
</t> |
7899 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
7900 |
</t> |
</t> |
7901 |
|
<t>/ CHANNEL_MIDI |
7902 |
|
</t> |
7903 |
|
<t>/ DEVICE_MIDI |
7904 |
|
</t> |
7905 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
7906 |
</t> |
</t> |
7907 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
7934 |
</t> |
</t> |
7935 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
7936 |
</t> |
</t> |
7937 |
|
<t>/ TOTAL_STREAM_COUNT |
7938 |
|
</t> |
7939 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
7940 |
</t> |
</t> |
7941 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
7942 |
</t> |
</t> |
7943 |
|
<t>/ EFFECT_INSTANCE_COUNT |
7944 |
|
</t> |
7945 |
|
<t>/ EFFECT_INSTANCE_INFO |
7946 |
|
</t> |
7947 |
|
<t>/ SEND_EFFECT_CHAIN_COUNT |
7948 |
|
</t> |
7949 |
|
<t>/ SEND_EFFECT_CHAIN_INFO |
7950 |
|
</t> |
7951 |
</list> |
</list> |
7952 |
</t> |
</t> |
7953 |
<t>map_instruction = |
<t>map_instruction = |
7976 |
</t> |
</t> |
7977 |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
7978 |
</t> |
</t> |
7979 |
|
<t>/ SEND_EFFECT_CHAIN SP device_index SP effect_chain |
7980 |
|
</t> |
7981 |
|
<t>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos |
7982 |
|
</t> |
7983 |
|
<t>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id |
7984 |
|
</t> |
7985 |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
7986 |
</t> |
</t> |
7987 |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
7994 |
<list> |
<list> |
7995 |
<t>AVAILABLE_ENGINES |
<t>AVAILABLE_ENGINES |
7996 |
</t> |
</t> |
7997 |
|
<t>/ AVAILABLE_EFFECTS |
7998 |
|
</t> |
7999 |
|
<t>/ EFFECT_INSTANCES |
8000 |
|
</t> |
8001 |
|
<t>/ EFFECT SP INFO SP effect_index |
8002 |
|
</t> |
8003 |
|
<t>/ EFFECT_INSTANCE SP INFO SP effect_instance |
8004 |
|
</t> |
8005 |
|
<t>/ EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP input_control |
8006 |
|
</t> |
8007 |
|
<t>/ SEND_EFFECT_CHAINS SP device_index |
8008 |
|
</t> |
8009 |
|
<t>/ SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain |
8010 |
|
</t> |
8011 |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
8012 |
</t> |
</t> |
8013 |
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
8054 |
</t> |
</t> |
8055 |
<t>/ SERVER SP INFO |
<t>/ SERVER SP INFO |
8056 |
</t> |
</t> |
8057 |
|
<t>/ TOTAL_STREAM_COUNT |
8058 |
|
</t> |
8059 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
8060 |
</t> |
</t> |
8061 |
<t>/ TOTAL_VOICE_COUNT_MAX |
<t>/ TOTAL_VOICE_COUNT_MAX |
8090 |
</t> |
</t> |
8091 |
<t>/ VOLUME |
<t>/ VOLUME |
8092 |
</t> |
</t> |
8093 |
|
<t>/ VOICES |
8094 |
|
</t> |
8095 |
|
<t>/ STREAMS |
8096 |
|
</t> |
8097 |
|
<t>/ FILE SP INSTRUMENTS SP filename |
8098 |
|
</t> |
8099 |
|
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
8100 |
|
</t> |
8101 |
</list> |
</list> |
8102 |
</t> |
</t> |
8103 |
<t>set_instruction = |
<t>set_instruction = |
8112 |
</t> |
</t> |
8113 |
<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 |
8114 |
</t> |
</t> |
8115 |
|
<t>/ EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP input_control SP control_value |
8116 |
|
</t> |
8117 |
<t>/ CHANNEL SP set_chan_instruction |
<t>/ CHANNEL SP set_chan_instruction |
8118 |
</t> |
</t> |
8119 |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
8126 |
</t> |
</t> |
8127 |
<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 |
8128 |
</t> |
</t> |
8129 |
|
<t>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos |
8130 |
|
</t> |
8131 |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
8132 |
</t> |
</t> |
8133 |
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped |
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped |
8136 |
</t> |
</t> |
8137 |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
8138 |
</t> |
</t> |
8139 |
|
<t>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename |
8140 |
|
</t> |
8141 |
<t>/ ECHO SP boolean |
<t>/ ECHO SP boolean |
8142 |
</t> |
</t> |
8143 |
<t>/ VOLUME SP volume_value |
<t>/ VOLUME SP volume_value |
8144 |
</t> |
</t> |
8145 |
|
<t>/ VOICES SP number |
8146 |
|
</t> |
8147 |
|
<t>/ STREAMS SP number |
8148 |
|
</t> |
8149 |
</list> |
</list> |
8150 |
</t> |
</t> |
8151 |
<t>create_instruction = |
<t>create_instruction = |
8162 |
</t> |
</t> |
8163 |
<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 |
8164 |
</t> |
</t> |
8165 |
|
<t>/ EFFECT_INSTANCE SP effect_index |
8166 |
|
</t> |
8167 |
|
<t>/ EFFECT_INSTANCE SP effect_system SP module SP effect_name |
8168 |
|
</t> |
8169 |
</list> |
</list> |
8170 |
</t> |
</t> |
8171 |
<t>reset_instruction = |
<t>reset_instruction = |
8192 |
</t> |
</t> |
8193 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
8194 |
</t> |
</t> |
8195 |
|
<t>/ LOST SP DB_INSTRUMENT_FILES |
8196 |
|
</t> |
8197 |
</list> |
</list> |
8198 |
</t> |
</t> |
8199 |
<t>move_instruction = |
<t>move_instruction = |
8220 |
</t> |
</t> |
8221 |
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
8222 |
</t> |
</t> |
8223 |
|
<t>/ EFFECT_INSTANCE SP number |
8224 |
|
</t> |
8225 |
</list> |
</list> |
8226 |
</t> |
</t> |
8227 |
<t>load_instruction = |
<t>load_instruction = |
8232 |
</t> |
</t> |
8233 |
</list> |
</list> |
8234 |
</t> |
</t> |
8235 |
|
<t>append_instruction = |
8236 |
|
<list> |
8237 |
|
<t>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP effect_instance |
8238 |
|
</t> |
8239 |
|
</list> |
8240 |
|
</t> |
8241 |
|
<t>insert_instruction = |
8242 |
|
<list> |
8243 |
|
<t>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos SP effect_instance |
8244 |
|
</t> |
8245 |
|
</list> |
8246 |
|
</t> |
8247 |
<t>set_chan_instruction = |
<t>set_chan_instruction = |
8248 |
<list> |
<list> |
8249 |
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
8278 |
</t> |
</t> |
8279 |
<t>edit_instruction = |
<t>edit_instruction = |
8280 |
<list> |
<list> |
8281 |
<t>INSTRUMENT SP sampler_channel |
<t>CHANNEL SP INSTRUMENT SP sampler_channel |
8282 |
</t> |
</t> |
8283 |
</list> |
</list> |
8284 |
</t> |
</t> |
8322 |
</t> |
</t> |
8323 |
<t>/ AVAILABLE_ENGINES |
<t>/ AVAILABLE_ENGINES |
8324 |
</t> |
</t> |
8325 |
|
<t>/ AVAILABLE_EFFECTS |
8326 |
|
</t> |
8327 |
|
<t>/ EFFECT_INSTANCES |
8328 |
|
</t> |
8329 |
|
<t>/ SEND_EFFECT_CHAINS SP number |
8330 |
|
</t> |
8331 |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
8332 |
</t> |
</t> |
8333 |
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
8348 |
</t> |
</t> |
8349 |
<t>/ DB_INSTRUMENTS SP db_path |
<t>/ DB_INSTRUMENTS SP db_path |
8350 |
</t> |
</t> |
8351 |
|
<t>/ FILE SP INSTRUMENTS SP filename |
8352 |
|
</t> |
8353 |
|
</list> |
8354 |
|
</t> |
8355 |
|
<t>send_instruction = |
8356 |
|
<list> |
8357 |
|
<t>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number |
8358 |
|
</t> |
8359 |
</list> |
</list> |
8360 |
</t> |
</t> |
8361 |
<t>load_instr_args = |
<t>load_instr_args = |
8382 |
</t> |
</t> |
8383 |
</list> |
</list> |
8384 |
</t> |
</t> |
8385 |
|
<t>effect_instance = |
8386 |
|
<list> |
8387 |
|
<t>number |
8388 |
|
</t> |
8389 |
|
</list> |
8390 |
|
</t> |
8391 |
<t>device_index = |
<t>device_index = |
8392 |
<list> |
<list> |
8393 |
<t>number |
<t>number |
8458 |
</t> |
</t> |
8459 |
</list> |
</list> |
8460 |
</t> |
</t> |
8461 |
|
<t>control_value = |
8462 |
|
<list> |
8463 |
|
<t>real |
8464 |
|
</t> |
8465 |
|
</list> |
8466 |
|
</t> |
8467 |
<t>sampler_channel = |
<t>sampler_channel = |
8468 |
<list> |
<list> |
8469 |
<t>number |
<t>number |
8518 |
</t> |
</t> |
8519 |
</list> |
</list> |
8520 |
</t> |
</t> |
8521 |
|
<t>effect_name = |
8522 |
|
<list> |
8523 |
|
<t>stringval_escaped |
8524 |
|
</t> |
8525 |
|
</list> |
8526 |
|
</t> |
8527 |
|
<t>effect_index = |
8528 |
|
<list> |
8529 |
|
<t>number |
8530 |
|
</t> |
8531 |
|
</list> |
8532 |
|
</t> |
8533 |
|
<t>effect_chain = |
8534 |
|
<list> |
8535 |
|
<t>number |
8536 |
|
</t> |
8537 |
|
</list> |
8538 |
|
</t> |
8539 |
|
<t>chain_pos = |
8540 |
|
<list> |
8541 |
|
<t>number |
8542 |
|
</t> |
8543 |
|
</list> |
8544 |
|
</t> |
8545 |
|
<t>input_control = |
8546 |
|
<list> |
8547 |
|
<t>number |
8548 |
|
</t> |
8549 |
|
</list> |
8550 |
|
</t> |
8551 |
<t>param_val_list = |
<t>param_val_list = |
8552 |
<list> |
<list> |
8553 |
<t>param_val |
<t>param_val |
8595 |
</t> |
</t> |
8596 |
</list> |
</list> |
8597 |
</t> |
</t> |
8598 |
|
<t>effect_system = |
8599 |
|
<list> |
8600 |
|
<t>string |
8601 |
|
</t> |
8602 |
|
</list> |
8603 |
|
</t> |
8604 |
|
<t>module = |
8605 |
|
<list> |
8606 |
|
<t>filename |
8607 |
|
</t> |
8608 |
|
</list> |
8609 |
|
</t> |
8610 |
|
|
8611 |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
8612 |
|
|
8669 |
<t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
<t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
8670 |
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
8671 |
<t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t> |
<t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t> |
8672 |
|
<t><xref target="FIND LOST DB_INSTRUMENT_FILES">"FIND LOST DB_INSTRUMENT_FILES"</xref></t> |
8673 |
|
<t><xref target="SET DB_INSTRUMENT FILE_PATH">"SET DB_INSTRUMENT FILE_PATH"</xref></t> |
8674 |
|
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
8675 |
|
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
8676 |
|
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
8677 |
|
<t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t> |
8678 |
|
<t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t> |
8679 |
|
<t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t> |
8680 |
</list> |
</list> |
8681 |
Note that the forward slash character ('/') has a special meaning in |
Note that the forward slash character ('/') has a special meaning in |
8682 |
filename / path based arguments: it acts as separator of the nodes in |
filename / path based arguments: it acts as separator of the nodes in |
8687 |
</t> |
</t> |
8688 |
|
|
8689 |
<t> |
<t> |
8690 |
|
Note for Windows: file path arguments in LSCP are expected |
8691 |
|
to use forward slashes as directory node separator similar |
8692 |
|
to Unix based operating systems. In contrast to Unix however |
8693 |
|
a Windows typical drive character is expected to be |
8694 |
|
prefixed to the path. That is an original Windows file path |
8695 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
8696 |
|
"D:/Sounds/My.gig". |
8697 |
|
</t> |
8698 |
|
|
8699 |
|
<t> |
8700 |
The following LSCP commands even support escape sequences as |
The following LSCP commands even support escape sequences as |
8701 |
part of at least one of their text-based arguments (i.e. entity name, |
part of at least one of their text-based arguments (i.e. entity name, |
8702 |
description) and / or may contain escape sequences in at least one of |
description) and / or may contain escape sequences in at least one of |
8713 |
<t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t> |
<t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t> |
8714 |
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
8715 |
<t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t> |
<t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t> |
8716 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
8717 |
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
8718 |
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
8719 |
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
8720 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
8721 |
<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> |
8722 |
<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> |
8723 |
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
8724 |
|
<t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t> |
8725 |
|
<t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t> |
8726 |
|
<t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t> |
8727 |
</list> |
</list> |
8728 |
Please note that these lists are manually maintained. If you |
Please note that these lists are manually maintained. If you |
8729 |
find a command that also supports escape sequences we forgot to |
find a command that also supports escape sequences we forgot to |
8833 |
of sampler channels.</t> |
of sampler channels.</t> |
8834 |
</section> |
</section> |
8835 |
|
|
8836 |
|
<section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI"> |
8837 |
|
<t>Client may want to be notified when MIDI data arrive on sampler channels on |
8838 |
|
back-end side, by issuing the following command:</t> |
8839 |
|
<t> |
8840 |
|
<list> |
8841 |
|
<t>SUBSCRIBE CHANNEL_MIDI</t> |
8842 |
|
</list> |
8843 |
|
</t> |
8844 |
|
<t>Server will start sending one of the the following notification messages:</t> |
8845 |
|
<t> |
8846 |
|
<list> |
8847 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"</t> |
8848 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>"</t> |
8849 |
|
</list> |
8850 |
|
</t> |
8851 |
|
<t>where <channel-id> will be replaced by the ID of the sampler channel where the MIDI |
8852 |
|
data arrived. <note> and <velocity> are integer values in the range between |
8853 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
8854 |
|
</t> |
8855 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
8856 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
8857 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
8858 |
|
thread unaffected by this feature.</t> |
8859 |
|
</section> |
8860 |
|
|
8861 |
|
<section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI"> |
8862 |
|
<t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t> |
8863 |
|
<t> |
8864 |
|
<list> |
8865 |
|
<t>SUBSCRIBE DEVICE_MIDI</t> |
8866 |
|
</list> |
8867 |
|
</t> |
8868 |
|
<t>Server will start sending one of the the following notification messages:</t> |
8869 |
|
<t> |
8870 |
|
<list> |
8871 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note> <velocity>"</t> |
8872 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note> <velocity>"</t> |
8873 |
|
</list> |
8874 |
|
</t> |
8875 |
|
<t>where <device-id> <port-id> will be replaced |
8876 |
|
by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI |
8877 |
|
data arrived. <note> and <velocity> are integer values in the range between |
8878 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
8879 |
|
</t> |
8880 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
8881 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
8882 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
8883 |
|
thread unaffected by this feature.</t> |
8884 |
|
</section> |
8885 |
|
|
8886 |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
8887 |
<t>Client may want to be notified when the number of voices on the |
<t>Client may want to be notified when the number of voices on the |
8888 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
9020 |
all currently active voices.</t> |
all currently active voices.</t> |
9021 |
</section> |
</section> |
9022 |
|
|
9023 |
|
<section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT"> |
9024 |
|
<t>Client may want to be notified when the total number of disk streams on the |
9025 |
|
back-end changes by issuing the following command:</t> |
9026 |
|
<t> |
9027 |
|
<list> |
9028 |
|
<t>SUBSCRIBE TOTAL_STREAM_COUNT</t> |
9029 |
|
</list> |
9030 |
|
</t> |
9031 |
|
<t>Server will start sending the following notification messages:</t> |
9032 |
|
<t> |
9033 |
|
<list> |
9034 |
|
<t>"NOTIFY:TOTAL_STREAM_COUNT:<streams>"</t> |
9035 |
|
</list> |
9036 |
|
</t> |
9037 |
|
<t>where <streams> will be replaced by the new number of |
9038 |
|
all currently active disk streams.</t> |
9039 |
|
</section> |
9040 |
|
|
9041 |
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
9042 |
<t>Client may want to be notified when the number of MIDI instrument maps on the |
<t>Client may want to be notified when the number of MIDI instrument maps on the |
9043 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
9136 |
replaced by the optional dotted floating point value, reflecting the |
replaced by the optional dotted floating point value, reflecting the |
9137 |
new global volume parameter.</t> |
new global volume parameter.</t> |
9138 |
</list> |
</list> |
9139 |
|
<list> |
9140 |
|
<t>"NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the |
9141 |
|
golbal limit of the sampler for maximum voices is changed, where |
9142 |
|
<max-voices> will be an integer value, reflecting the |
9143 |
|
new global voice limit parameter.</t> |
9144 |
|
</list> |
9145 |
|
<list> |
9146 |
|
<t>"NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the |
9147 |
|
golbal limit of the sampler for maximum disk streams is changed, where |
9148 |
|
<max-streams> will be an integer value, reflecting the |
9149 |
|
new global disk streams limit parameter.</t> |
9150 |
|
</list> |
9151 |
</t> |
</t> |
9152 |
</section> |
</section> |
9153 |
|
|
9277 |
message is sufficient here.</t> |
message is sufficient here.</t> |
9278 |
</section> |
</section> |
9279 |
|
|
9280 |
|
<section title="Number of effect instances changed" anchor="SUBSCRIBE EFFECT_INSTANCE_COUNT"> |
9281 |
|
<t>Client may want to be notified when the number of effect instances |
9282 |
|
is changed by issuing the following command:</t> |
9283 |
|
<t> |
9284 |
|
<list> |
9285 |
|
<t>SUBSCRIBE EFFECT_INSTANCE_COUNT</t> |
9286 |
|
</list> |
9287 |
|
</t> |
9288 |
|
<t>Server will start sending the following notification messages:</t> |
9289 |
|
<t> |
9290 |
|
<list> |
9291 |
|
<t>"EFFECT_INSTANCE_COUNT:<instances>"</t> |
9292 |
|
</list> |
9293 |
|
</t> |
9294 |
|
<t>where <instances> will be replaced by the new number |
9295 |
|
of effect instances.</t> |
9296 |
|
</section> |
9297 |
|
|
9298 |
|
<section title="Effect instance information changed" anchor="SUBSCRIBE EFFECT_INSTANCE_INFO"> |
9299 |
|
<t>Client may want to be notified when changes were made to effect instances |
9300 |
|
on the back-end by issuing the following command:</t> |
9301 |
|
<t> |
9302 |
|
<list> |
9303 |
|
<t>SUBSCRIBE EFFECT_INSTANCE_INFO</t> |
9304 |
|
</list> |
9305 |
|
</t> |
9306 |
|
<t>Server will start sending the following notification messages:</t> |
9307 |
|
<t> |
9308 |
|
<list> |
9309 |
|
<t>"EFFECT_INSTANCE_INFO:<instance-id>"</t> |
9310 |
|
</list> |
9311 |
|
</t> |
9312 |
|
<t>where <instance-id> will be replaced by the numerical ID |
9313 |
|
of the effect instance.</t> |
9314 |
|
</section> |
9315 |
|
|
9316 |
|
<section title="Number of send effect chains changed" anchor="SUBSCRIBE SEND_EFFECT_CHAIN_COUNT"> |
9317 |
|
<t>Client may want to be notified when the number of send effect chains |
9318 |
|
is changed by issuing the following command:</t> |
9319 |
|
<t> |
9320 |
|
<list> |
9321 |
|
<t>SUBSCRIBE SEND_EFFECT_CHAIN_COUNT</t> |
9322 |
|
</list> |
9323 |
|
</t> |
9324 |
|
<t>Server will start sending the following notification messages:</t> |
9325 |
|
<t> |
9326 |
|
<list> |
9327 |
|
<t>"NOTIFY:SEND_EFFECT_CHAIN_COUNT:<device-id> <chains>"</t> |
9328 |
|
</list> |
9329 |
|
</t> |
9330 |
|
<t>where <device-id> will be replaced by the numerical ID of the audio |
9331 |
|
output device, in which the number of send effect chains is changed and |
9332 |
|
<chains> will be replaced by the new number of send effect chains.</t> |
9333 |
|
</section> |
9334 |
|
|
9335 |
|
<section title="Send effect chain information changed" anchor="SUBSCRIBE SEND_EFFECT_CHAIN_INFO"> |
9336 |
|
<t>Client may want to be notified when changes were made to send effect chains |
9337 |
|
on the back-end by issuing the following command:</t> |
9338 |
|
<t> |
9339 |
|
<list> |
9340 |
|
<t>SUBSCRIBE SEND_EFFECT_CHAIN_INFO</t> |
9341 |
|
</list> |
9342 |
|
</t> |
9343 |
|
<t>Server will start sending the following notification messages:</t> |
9344 |
|
<t> |
9345 |
|
<list> |
9346 |
|
<t>"SEND_EFFECT_CHAIN_INFO:<device-id> <chain-id> <instances>" - |
9347 |
|
Notifies that the number of effect instances in a particular send effect chain |
9348 |
|
is changed, where <device-id> will be replaced by the numerical ID of the audio |
9349 |
|
output device the send effect chain belongs to, <chain-id> will be replaced |
9350 |
|
by the numerical ID of the send effect chain in which the number of effect instances |
9351 |
|
has changed and <instances> will be replaced by the new number |
9352 |
|
of effect instances in the specified send effect chain.</t> |
9353 |
|
</list> |
9354 |
|
</t> |
9355 |
|
</section> |
9356 |
|
|
9357 |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
9358 |
<t>Client may want to be notified of miscellaneous and debugging events occurring at |
<t>Client may want to be notified of miscellaneous and debugging events occurring at |
9359 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |