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="November" year="2009"/> |
<date month="October" year="2010"/> |
38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
40 |
<abstract> |
<abstract> |
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> |
6674 |
</t> |
</t> |
6675 |
</section> |
</section> |
6676 |
</section> |
</section> |
6677 |
|
<section title="Managing Effects" anchor="effects"> |
6678 |
|
<t>Audio effects (e.g. reverb, delay, compression) can be |
6679 |
|
applied to the audio signals generated by the sampler. The |
6680 |
|
sampler usually provides a set of internal audio effects for |
6681 |
|
this task. The exact set of effects depends on the availability |
6682 |
|
of third party effect plugins installed on the system where the |
6683 |
|
sampler runs on.</t> |
6684 |
|
<t>At the moment only "send effects" are supported. Support for |
6685 |
|
"insert effects" and "master effects" is planned to be added at |
6686 |
|
a later point.</t> |
6687 |
|
<t>The following commands allow to retrieve the set of internal |
6688 |
|
effects available to the sampler, detailed informations about |
6689 |
|
those effects and to create and destroy instances of such |
6690 |
|
effects. After an instance of an effect is created, the effect |
6691 |
|
instance can be inserted into the audio signal path of the |
6692 |
|
sampler, e.g. as send effect.</t> |
6693 |
|
<t>The sampler allows to create an arbitrary amount of so called |
6694 |
|
send effect chains. Each effect chain can host an arbitrary |
6695 |
|
amount of effect instances. The output of the first effect |
6696 |
|
instance in an effect chain is fed to the input of the second |
6697 |
|
effect instance of the chain and so on. So effects in one chain |
6698 |
|
are processed sequentially. Send effect chains however are |
6699 |
|
processed in parallel to other send effect chains. Audio signals |
6700 |
|
of sampler channels are fed to send effects by creating FX sends |
6701 |
|
to the respective sampler channel and assigning a destination |
6702 |
|
send effect to that FX by using the |
6703 |
|
<xref target="SET FX_SEND EFFECT">"SET FX_SEND EFFECT"</xref> |
6704 |
|
command. The latter allows to route the FX send to the beginning |
6705 |
|
of a send effect chain, as well as directly to any other |
6706 |
|
position of the send effect chain.</t> |
6707 |
|
|
6708 |
|
<section title="Retrieve amount of available effects" anchor="GET AVAILABLE_EFFECTS"> |
6709 |
|
<t>The front-end can retrieve the amount of internal |
6710 |
|
effects, available to the sampler by sending |
6711 |
|
the following command:</t> |
6712 |
|
<t> |
6713 |
|
<list> |
6714 |
|
<t>GET AVAILABLE_EFFECTS</t> |
6715 |
|
</list> |
6716 |
|
</t> |
6717 |
|
|
6718 |
|
<t>Possible Answers:</t> |
6719 |
|
<t> |
6720 |
|
<list> |
6721 |
|
<t>The sampler will answer by returning the current |
6722 |
|
number of effects available to the sampler.</t> |
6723 |
|
</list> |
6724 |
|
</t> |
6725 |
|
|
6726 |
|
<t>Examples:</t> |
6727 |
|
<t> |
6728 |
|
<list> |
6729 |
|
<t>C: "GET AVAILABLE_EFFECTS"</t> |
6730 |
|
<t>S: "129"</t> |
6731 |
|
</list> |
6732 |
|
</t> |
6733 |
|
</section> |
6734 |
|
|
6735 |
|
<section title="Get list of available effects" anchor="LIST AVAILABLE_EFFECTS"> |
6736 |
|
<t>The set of available internal effects can change at |
6737 |
|
runtime. The front-end can retrieve the list of internal |
6738 |
|
effects, available to the sampler by sending the following |
6739 |
|
command:</t> |
6740 |
|
<t> |
6741 |
|
<list> |
6742 |
|
<t>LIST AVAILABLE_EFFECTS</t> |
6743 |
|
</list> |
6744 |
|
</t> |
6745 |
|
|
6746 |
|
<t>Possible Answers:</t> |
6747 |
|
<t> |
6748 |
|
<list> |
6749 |
|
<t>The sampler will answer by returning a comma |
6750 |
|
separated list with numerical IDs of effects. Note: |
6751 |
|
the numercial ID of an effect is generated by the |
6752 |
|
sampler for the current moment. The numerical ID of |
6753 |
|
the same effect can change at runtime, e.g. when the |
6754 |
|
user requests a rescan of available effect plugins. |
6755 |
|
</t> |
6756 |
|
</list> |
6757 |
|
</t> |
6758 |
|
<t>Example:</t> |
6759 |
|
<t> |
6760 |
|
<list> |
6761 |
|
<t>C: "LIST AVAILABLE_EFFECTS"</t> |
6762 |
|
<t>S: "5,6,7,120,121,122,123,124"</t> |
6763 |
|
</list> |
6764 |
|
</t> |
6765 |
|
</section> |
6766 |
|
|
6767 |
|
<section title="Retrieving general information about an effect" anchor="GET EFFECT INFO"> |
6768 |
|
<t>The front-end can ask for general informations about an |
6769 |
|
effect by sending the following command:</t> |
6770 |
|
<t> |
6771 |
|
<list> |
6772 |
|
<t>GET EFFECT INFO <effect-index></t> |
6773 |
|
</list> |
6774 |
|
</t> |
6775 |
|
<t>Where <effect-index> is the numerical ID of an |
6776 |
|
effect as returned by the |
6777 |
|
<xref target="LIST AVAILABLE_EFFECTS">"LIST AVAILABLE_EFFECTS"</xref> |
6778 |
|
command.</t> |
6779 |
|
<t>Possible Answers:</t> |
6780 |
|
<t> |
6781 |
|
<list> |
6782 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
6783 |
|
Each answer line begins with the effect information |
6784 |
|
category name, followed by a colon and then a space |
6785 |
|
character <SP> and finally the info character |
6786 |
|
string to that effect information category. At the |
6787 |
|
moment the following categories are defined:</t> |
6788 |
|
<t> |
6789 |
|
<list> |
6790 |
|
<t>SYSTEM - |
6791 |
|
<list> |
6792 |
|
<t>name of the effect plugin system |
6793 |
|
the effect is based on |
6794 |
|
(e.g. "LADSPA")</t> |
6795 |
|
</list> |
6796 |
|
</t> |
6797 |
|
<t>MODULE - |
6798 |
|
<list> |
6799 |
|
<t>module of the effect plugin |
6800 |
|
system that contains this effect, |
6801 |
|
the module is usually the |
6802 |
|
dynamic-linked library (DLL) |
6803 |
|
filename of the effect plugin, |
6804 |
|
including full path (note that this |
6805 |
|
filename may contain |
6806 |
|
<xref target="character_set">escape sequences</xref>)</t> |
6807 |
|
</list> |
6808 |
|
</t> |
6809 |
|
<t>NAME - |
6810 |
|
<list> |
6811 |
|
<t>character string defining the |
6812 |
|
unique name of the effect within its |
6813 |
|
module (note that the character |
6814 |
|
string may contain |
6815 |
|
<xref target="character_set">escape sequences</xref>)</t> |
6816 |
|
</list> |
6817 |
|
</t> |
6818 |
|
<t>DESCRIPTION - |
6819 |
|
<list> |
6820 |
|
<t>human readable name of the |
6821 |
|
effect, intended to be displayed in |
6822 |
|
user interfaces (note that the |
6823 |
|
character string may contain |
6824 |
|
<xref target="character_set">escape sequences</xref>)</t> |
6825 |
|
</list> |
6826 |
|
</t> |
6827 |
|
</list> |
6828 |
|
</t> |
6829 |
|
</list> |
6830 |
|
</t> |
6831 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
6832 |
|
|
6833 |
|
<t>Example:</t> |
6834 |
|
<t> |
6835 |
|
<list> |
6836 |
|
<t>C: "GET EFFECT INFO 121"</t> |
6837 |
|
<t>S: "SYSTEM: LADSPA"</t> |
6838 |
|
<t> "MODULE: /usr/lib/ladspa/lowpass_iir_1891.so"</t> |
6839 |
|
<t> "NAME: lowpass_iir"</t> |
6840 |
|
<t> "DESCRIPTION: Glame Lowpass Filter"</t> |
6841 |
|
<t> "."</t> |
6842 |
|
</list> |
6843 |
|
</t> |
6844 |
|
</section> |
6845 |
|
|
6846 |
|
<section title="Creating an instance of an effect by its portable ID" anchor="CREATE EFFECT_INSTANCE"> |
6847 |
|
<t>The front-end can spawn an instance of the desired |
6848 |
|
effect by sending the following command:</t> |
6849 |
|
<t> |
6850 |
|
<list> |
6851 |
|
<t>CREATE EFFECT_INSTANCE <effect-system> <module> <effect-name></t> |
6852 |
|
</list> |
6853 |
|
</t> |
6854 |
|
<t>Where <effect-system> is the "SYSTEM" field, |
6855 |
|
<module> the "MODULE" field and <effect-name> |
6856 |
|
the "NAME" field as returned by the |
6857 |
|
<xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref> |
6858 |
|
command. The filename of argument <module> and the |
6859 |
|
character string of argument <effect-name> may contain |
6860 |
|
<xref target="character_set">escape sequences</xref>.</t> |
6861 |
|
|
6862 |
|
<t>The sampler will try to load the requested effect and to |
6863 |
|
create an instance of it. To allow loading the same effect |
6864 |
|
on a different machine, probably even running a completely |
6865 |
|
different operating system (e.g. Linux vs. Windows), the |
6866 |
|
sampler tries to match <module> "softly". That means |
6867 |
|
it first tries to find an effect that exactly matches the |
6868 |
|
given <module> argument. If there is no exact match, |
6869 |
|
the sampler will try to lower the restrictions on matching |
6870 |
|
the <module> argument more and more, e.g. by ignoring |
6871 |
|
upper / lower case differences and by ignoring the path of |
6872 |
|
the DLL filename and file extension. If there is still no |
6873 |
|
match at the end, the sampler will try to ignore the |
6874 |
|
<module> argument completely and as a last resort |
6875 |
|
search for an effect that only matches the given |
6876 |
|
<effect-system> and <effect-name> arguments.</t> |
6877 |
|
|
6878 |
|
<t>Possible Answers:</t> |
6879 |
|
<t> |
6880 |
|
<list> |
6881 |
|
<t>"OK[<effect-instance>]" - |
6882 |
|
<list> |
6883 |
|
<t>in case the effect instance was |
6884 |
|
successfully created, where |
6885 |
|
<effect-instance> is the numerical ID |
6886 |
|
of the new effect instance</t> |
6887 |
|
</list> |
6888 |
|
</t> |
6889 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
6890 |
|
<list> |
6891 |
|
<t>in case the effect instance was spawned |
6892 |
|
successfully, but there are noteworthy |
6893 |
|
issue(s) related, providing an appropriate |
6894 |
|
warning code and warning message</t> |
6895 |
|
</list> |
6896 |
|
</t> |
6897 |
|
<t>"ERR:<error-code>:<error-message>" - |
6898 |
|
<list> |
6899 |
|
<t>if the effect could not be instantiated</t> |
6900 |
|
</list> |
6901 |
|
</t> |
6902 |
|
</list> |
6903 |
|
</t> |
6904 |
|
|
6905 |
|
<t>Examples:</t> |
6906 |
|
<t> |
6907 |
|
<list> |
6908 |
|
<t>C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/mod_delay_1419.so' 'modDelay'"</t> |
6909 |
|
<t>S: "OK[0]"</t> |
6910 |
|
</list> |
6911 |
|
</t> |
6912 |
|
</section> |
6913 |
|
|
6914 |
|
<section title="Creating an instance of an effect by its numerical ID" anchor="CREATE EFFECT_INSTANCE (non-portable)"> |
6915 |
|
<t>The front-end can spawn an instance of the desired |
6916 |
|
effect by sending the following command:</t> |
6917 |
|
<t> |
6918 |
|
<list> |
6919 |
|
<t>CREATE EFFECT_INSTANCE <effect-index></t> |
6920 |
|
</list> |
6921 |
|
</t> |
6922 |
|
<t>Where <effect-index> is the numerical ID of the |
6923 |
|
effect as returned by the |
6924 |
|
<xref target="LIST AVAILABLE_EFFECTS">"LIST AVAILABLE_EFFECTS"</xref> |
6925 |
|
command.</t> |
6926 |
|
|
6927 |
|
<t>The sampler will try to load the requested effect and to |
6928 |
|
create an instance of it.</t> |
6929 |
|
|
6930 |
|
<t>Note: Since the numerical ID of a certain effect can |
6931 |
|
change at any time, you should not use this command in |
6932 |
|
LSCP files to restore a certain effect at a later time! To |
6933 |
|
store a sampler session including all its effects, use the |
6934 |
|
<xref target="CREATE EFFECT_INSTANCE">portable text-based |
6935 |
|
version of "CREATE EFFECT_INSTANCE"</xref> instead! This |
6936 |
|
allows to restore a sampler session with all its effects |
6937 |
|
also on other machines, possibly even running a completely |
6938 |
|
different operating system (e.g. Linux vs. Windows), with |
6939 |
|
different plugin directories or plugin DLL names.</t> |
6940 |
|
|
6941 |
|
<t>Possible Answers:</t> |
6942 |
|
<t> |
6943 |
|
<list> |
6944 |
|
<t>"OK[<effect-instance>]" - |
6945 |
|
<list> |
6946 |
|
<t>in case the effect instance was |
6947 |
|
successfully created, where |
6948 |
|
<effect-instance> is the numerical ID |
6949 |
|
of the new effect instance</t> |
6950 |
|
</list> |
6951 |
|
</t> |
6952 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
6953 |
|
<list> |
6954 |
|
<t>in case the effect instance was spawned |
6955 |
|
successfully, but there are noteworthy |
6956 |
|
issue(s) related, providing an appropriate |
6957 |
|
warning code and warning message</t> |
6958 |
|
</list> |
6959 |
|
</t> |
6960 |
|
<t>"ERR:<error-code>:<error-message>" - |
6961 |
|
<list> |
6962 |
|
<t>if the effect could not be instantiated</t> |
6963 |
|
</list> |
6964 |
|
</t> |
6965 |
|
</list> |
6966 |
|
</t> |
6967 |
|
|
6968 |
|
<t>Examples:</t> |
6969 |
|
<t> |
6970 |
|
<list> |
6971 |
|
<t>C: "CREATE EFFECT_INSTANCE 72"</t> |
6972 |
|
<t>S: "OK[5]"</t> |
6973 |
|
</list> |
6974 |
|
</t> |
6975 |
|
</section> |
6976 |
|
|
6977 |
|
<section title="Destroy an effect instance" anchor="DESTROY EFFECT_INSTANCE"> |
6978 |
|
<t>The front-end can destroy an unusued effect instance and |
6979 |
|
thus freeing it from memory by sending the following command:</t> |
6980 |
|
<t> |
6981 |
|
<list> |
6982 |
|
<t>DESTROY EFFECT_INSTANCE <effect-instance></t> |
6983 |
|
</list> |
6984 |
|
</t> |
6985 |
|
<t>Where <effect-instance> is the numerical ID of the |
6986 |
|
effect instance as returned by the |
6987 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
6988 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
6989 |
|
command.</t> |
6990 |
|
|
6991 |
|
<t>The effect instance can only be destroyed if it's not |
6992 |
|
used in any part of the sampler's audio signal path anymore. |
6993 |
|
If the effect instance is still in use somewhere, trying to |
6994 |
|
destroy the effect instance will result in an error |
6995 |
|
message.</t> |
6996 |
|
|
6997 |
|
<t>Possible Answers:</t> |
6998 |
|
<t> |
6999 |
|
<list> |
7000 |
|
<t>"OK" - |
7001 |
|
<list> |
7002 |
|
<t>in case the effect instance was successfully destroyed</t> |
7003 |
|
</list> |
7004 |
|
</t> |
7005 |
|
<t>"ERR:<error-code>:<error-message>" - |
7006 |
|
<list> |
7007 |
|
<t>in case it failed, providing an appropriate error code and |
7008 |
|
error message</t> |
7009 |
|
</list> |
7010 |
|
</t> |
7011 |
|
</list> |
7012 |
|
</t> |
7013 |
|
|
7014 |
|
<t>Examples:</t> |
7015 |
|
<t> |
7016 |
|
<list> |
7017 |
|
<t>C: "DESTROY EFFECT_INSTANCE 5"</t> |
7018 |
|
<t>S: "OK"</t> |
7019 |
|
</list> |
7020 |
|
</t> |
7021 |
|
</section> |
7022 |
|
|
7023 |
|
<section title="Retrieve amount of effect instances" anchor="GET EFFECT_INSTANCES"> |
7024 |
|
<t>The front-end can retrieve the current amount of effect |
7025 |
|
instances by sending the following command:</t> |
7026 |
|
<t> |
7027 |
|
<list> |
7028 |
|
<t>GET EFFECT_INSTANCES</t> |
7029 |
|
</list> |
7030 |
|
</t> |
7031 |
|
|
7032 |
|
<t>Possible Answers:</t> |
7033 |
|
<t> |
7034 |
|
<list> |
7035 |
|
<t>The sampler will answer by returning the current |
7036 |
|
number of effect instances created and not yet |
7037 |
|
destroyed in the current sampler session.</t> |
7038 |
|
</list> |
7039 |
|
</t> |
7040 |
|
|
7041 |
|
<t>Examples:</t> |
7042 |
|
<t> |
7043 |
|
<list> |
7044 |
|
<t>C: "GET EFFECT_INSTANCES"</t> |
7045 |
|
<t>S: "14"</t> |
7046 |
|
</list> |
7047 |
|
</t> |
7048 |
|
</section> |
7049 |
|
|
7050 |
|
<section title="Get list of effect instances" anchor="LIST EFFECT_INSTANCES"> |
7051 |
|
<t>The front-end can retrieve the current list of effect |
7052 |
|
instances by sending the following command:</t> |
7053 |
|
<t> |
7054 |
|
<list> |
7055 |
|
<t>LIST EFFECT_INSTANCES</t> |
7056 |
|
</list> |
7057 |
|
</t> |
7058 |
|
|
7059 |
|
<t>Possible Answers:</t> |
7060 |
|
<t> |
7061 |
|
<list> |
7062 |
|
<t>The sampler will answer by returning a comma |
7063 |
|
separated list with numerical IDs of effects |
7064 |
|
instances. |
7065 |
|
</t> |
7066 |
|
</list> |
7067 |
|
</t> |
7068 |
|
<t>Example:</t> |
7069 |
|
<t> |
7070 |
|
<list> |
7071 |
|
<t>C: "LIST EFFECT_INSTANCES"</t> |
7072 |
|
<t>S: "9,11,14,15,16,17,25"</t> |
7073 |
|
</list> |
7074 |
|
</t> |
7075 |
|
</section> |
7076 |
|
|
7077 |
|
<section title="Retrieving current information about an effect instance" anchor="GET EFFECT_INSTANCE INFO"> |
7078 |
|
<t>The front-end can ask for the current informations about |
7079 |
|
a particular effect instance by sending the following command:</t> |
7080 |
|
<t> |
7081 |
|
<list> |
7082 |
|
<t>GET EFFECT_INSTANCE INFO <effect-instance></t> |
7083 |
|
</list> |
7084 |
|
</t> |
7085 |
|
<t>Where <effect-instance> is the numerical ID of an |
7086 |
|
effect instance as returned by the |
7087 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> |
7088 |
|
or |
7089 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7090 |
|
command.</t> |
7091 |
|
|
7092 |
|
<t>Possible Answers:</t> |
7093 |
|
<t> |
7094 |
|
<list> |
7095 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
7096 |
|
Each answer line begins with the information |
7097 |
|
category name, followed by a colon and then a space |
7098 |
|
character <SP> and finally the info character |
7099 |
|
string to that information category. At the |
7100 |
|
moment the following categories are defined:</t> |
7101 |
|
<t> |
7102 |
|
<list> |
7103 |
|
<t>SYSTEM - |
7104 |
|
<list> |
7105 |
|
<t>name of the effect plugin system |
7106 |
|
the effect is based on |
7107 |
|
(e.g. "LADSPA")</t> |
7108 |
|
</list> |
7109 |
|
</t> |
7110 |
|
<t>MODULE - |
7111 |
|
<list> |
7112 |
|
<t>module of the effect plugin |
7113 |
|
system that contains this effect, |
7114 |
|
the module is usually the |
7115 |
|
dynamic-linked library (DLL) |
7116 |
|
filename of the effect plugin, |
7117 |
|
including full path (note that this |
7118 |
|
filename may contain |
7119 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7120 |
|
</list> |
7121 |
|
</t> |
7122 |
|
<t>NAME - |
7123 |
|
<list> |
7124 |
|
<t>character string defining the |
7125 |
|
unique name of the effect within its |
7126 |
|
module (note that the character |
7127 |
|
string may contain |
7128 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7129 |
|
</list> |
7130 |
|
</t> |
7131 |
|
<t>DESCRIPTION - |
7132 |
|
<list> |
7133 |
|
<t>human readable name of the |
7134 |
|
effect, intended to be displayed in |
7135 |
|
user interfaces (note that the |
7136 |
|
character string may contain |
7137 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7138 |
|
</list> |
7139 |
|
</t> |
7140 |
|
<t>INPUT_CONTROLS - |
7141 |
|
<list> |
7142 |
|
<t>amount of input controls the |
7143 |
|
effect instance provides, to allow |
7144 |
|
controlling the effect parameters in |
7145 |
|
realtime</t> |
7146 |
|
</list> |
7147 |
|
</t> |
7148 |
|
</list> |
7149 |
|
</t> |
7150 |
|
</list> |
7151 |
|
</t> |
7152 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
7153 |
|
|
7154 |
|
<t>Example:</t> |
7155 |
|
<t> |
7156 |
|
<list> |
7157 |
|
<t>C: "GET EFFECT_INSTANCE INFO 3"</t> |
7158 |
|
<t>S: "SYSTEM: LADSPA"</t> |
7159 |
|
<t> "MODULE: /usr/lib/ladspa/mod_delay_1419.so"</t> |
7160 |
|
<t> "NAME: modDelay"</t> |
7161 |
|
<t> "DESCRIPTION: Modulatable delay"</t> |
7162 |
|
<t> "INPUT_CONTROLS: 1"</t> |
7163 |
|
<t> "."</t> |
7164 |
|
</list> |
7165 |
|
</t> |
7166 |
|
</section> |
7167 |
|
|
7168 |
|
<section title="Retrieving information about an effect parameter" anchor="GET EFFECT_INSTANCE_INPUT_CONTROL INFO"> |
7169 |
|
<t>Effects typically provide a certain set of effect |
7170 |
|
parameters which can be altered by the user in realtime |
7171 |
|
(e.g. depth of a reverb effect, duration of a delay effect, |
7172 |
|
dry / wet signal ratio). Those controllable effect parameters |
7173 |
|
are called "input controls". The front-end can ask for the |
7174 |
|
current informations of an effect instance's input control |
7175 |
|
by sending the following command:</t> |
7176 |
|
<t> |
7177 |
|
<list> |
7178 |
|
<t>GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-control></t> |
7179 |
|
</list> |
7180 |
|
</t> |
7181 |
|
<t>Where <effect-instance> is the numerical ID of an |
7182 |
|
effect instance as returned by the |
7183 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> |
7184 |
|
or |
7185 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7186 |
|
command and <input-control> is the index of the input |
7187 |
|
control within the numerical bounds as returned by the |
7188 |
|
"INPUT_CONTROLS" field of the |
7189 |
|
<xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref> |
7190 |
|
command.</t> |
7191 |
|
|
7192 |
|
<t>Possible Answers:</t> |
7193 |
|
<t> |
7194 |
|
<list> |
7195 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
7196 |
|
Each answer line begins with the information |
7197 |
|
category name, followed by a colon and then a space |
7198 |
|
character <SP> and finally the info character |
7199 |
|
string to that information category. There are |
7200 |
|
information categories which are always returned, |
7201 |
|
independent of the respective effect parameter and |
7202 |
|
there are optional information categories |
7203 |
|
which are only shown for certain effect parameters. |
7204 |
|
At the moment the following categories are defined:</t> |
7205 |
|
<t> |
7206 |
|
<list> |
7207 |
|
<t>DESCRIPTION - |
7208 |
|
<list> |
7209 |
|
<t>(always returned) |
7210 |
|
human readable name of the |
7211 |
|
effect parameter, intended to be |
7212 |
|
displayed in user interfaces (note |
7213 |
|
that the character string may |
7214 |
|
contain <xref target="character_set">escape sequences</xref>)</t> |
7215 |
|
</list> |
7216 |
|
</t> |
7217 |
|
<t>VALUE - |
7218 |
|
<list> |
7219 |
|
<t> |
7220 |
|
(always returned) |
7221 |
|
current (optional dotted) |
7222 |
|
floating point value of this effect |
7223 |
|
parameter</t> |
7224 |
|
</list> |
7225 |
|
</t> |
7226 |
|
<t>RANGE_MIN - |
7227 |
|
<list> |
7228 |
|
<t> |
7229 |
|
(optionally returned) |
7230 |
|
minimum allowed value for this |
7231 |
|
effect parameter</t> |
7232 |
|
</list> |
7233 |
|
</t> |
7234 |
|
<t>RANGE_MAX - |
7235 |
|
<list> |
7236 |
|
<t> |
7237 |
|
(optionally returned) |
7238 |
|
maximum allowed value for this |
7239 |
|
effect parameter</t> |
7240 |
|
</list> |
7241 |
|
</t> |
7242 |
|
<t>POSSIBILITIES - |
7243 |
|
<list> |
7244 |
|
<t> |
7245 |
|
(optionally returned) |
7246 |
|
comma separated list of |
7247 |
|
(optional dotted) floating point |
7248 |
|
numbers, reflecting the exact set of |
7249 |
|
possible values for this effect |
7250 |
|
parameter</t> |
7251 |
|
</list> |
7252 |
|
</t> |
7253 |
|
<t>DEFAULT - |
7254 |
|
<list> |
7255 |
|
<t> |
7256 |
|
(optionally returned) |
7257 |
|
default value of this effect |
7258 |
|
parameter</t> |
7259 |
|
</list> |
7260 |
|
</t> |
7261 |
|
</list> |
7262 |
|
</t> |
7263 |
|
</list> |
7264 |
|
</t> |
7265 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
7266 |
|
|
7267 |
|
<t>Example:</t> |
7268 |
|
<t> |
7269 |
|
<list> |
7270 |
|
<t>C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0"</t> |
7271 |
|
<t>S: "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> |
</section> |
7696 |
|
|
7697 |
<section title="Command Syntax" anchor="command_syntax"> |
<section title="Command Syntax" anchor="command_syntax"> |
7964 |
</t> |
</t> |
7965 |
<t>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos |
<t>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos |
7966 |
</t> |
</t> |
7967 |
<t>/ FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id |
<t>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id |
7968 |
</t> |
</t> |
7969 |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
7970 |
</t> |
</t> |
8110 |
</t> |
</t> |
8111 |
<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 |
8112 |
</t> |
</t> |
8113 |
<t>/ FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos |
<t>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos |
8114 |
</t> |
</t> |
8115 |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
8116 |
</t> |
</t> |
8658 |
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
8659 |
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
8660 |
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
8661 |
|
<t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t> |
8662 |
|
<t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t> |
8663 |
|
<t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t> |
8664 |
</list> |
</list> |
8665 |
Note that the forward slash character ('/') has a special meaning in |
Note that the forward slash character ('/') has a special meaning in |
8666 |
filename / path based arguments: it acts as separator of the nodes in |
filename / path based arguments: it acts as separator of the nodes in |
8705 |
<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> |
8706 |
<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> |
8707 |
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
8708 |
|
<t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t> |
8709 |
|
<t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t> |
8710 |
|
<t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t> |
8711 |
</list> |
</list> |
8712 |
Please note that these lists are manually maintained. If you |
Please note that these lists are manually maintained. If you |
8713 |
find a command that also supports escape sequences we forgot to |
find a command that also supports escape sequences we forgot to |