/[svn]/linuxsampler/trunk/Documentation/lscp.xml
ViewVC logotype

Diff of /linuxsampler/trunk/Documentation/lscp.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2137 by schoenebeck, Mon Oct 4 12:20:23 2010 UTC revision 2138 by schoenebeck, Mon Oct 4 22:11:53 2010 UTC
# Line 34  Schoenebeck'> Line 34  Schoenebeck'>
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>
# Line 3495  Schoenebeck'> Line 3495  Schoenebeck'>
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>SEND_EFFECT -
3506                                            <list>
3507                                                <t>destination send effect chain ID
3508                                                and destination effect chain
3509                                                position, separated by comma in the
3510                                                form "&lt;effect-chain&gt;,&lt;chain-pos&gt;"
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>
# Line 3578  Schoenebeck'> Line 3592  Schoenebeck'>
3592                      &lt;audio-src&gt; is the numerical ID of the effect send's audio channel                      &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
3593                      which should be rerouted and &lt;audio-dst&gt; is the numerical ID of                      which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
3594                      the audio channel of the selected audio output device where &lt;audio-src&gt;                      the audio channel of the selected audio output device where &lt;audio-src&gt;
3595                      should be routed to.</t>                      should be routed to. If an internal send effect is assigned
3596                        to the effect send, then this setting defines the audio
3597                        channel routing to that effect instance respectively.</t>
3598    
3599                      <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
3600                      device as assigned to the effect send's sampler channel. Also note that an                      device as assigned to the effect send's sampler channel. Also note that an
# Line 3621  Schoenebeck'> Line 3637  Schoenebeck'>
3637                      </t>                      </t>
3638                  </section>                  </section>
3639    
3640                    <section title="Assigning destination effect to an effect send" anchor="SET FX_SEND SEND_EFFECT">
3641                        <t>The front-end can (re-)assign a destination effect to an
3642                        effect send by sending the following command:</t>
3643                        <t>
3644                            <list>
3645                                <t>SET FX_SEND SEND_EFFECT &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;effect-chain&gt; &lt;chain-pos&gt;</t>
3646                            </list>
3647                        </t>
3648                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3649                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3650                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3651                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3652                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3653                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command,
3654                        &lt;effect-chain&gt; by the numerical ID of the destination
3655                        effect chain as returned by the
3656                        <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
3657                        or
3658                        <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
3659                        command and &lt;chain-pos&gt; reflects the exact effect
3660                        chain position in the effect chain which hosts the actual
3661                        destination effect.</t>
3662    
3663                        <t>Possible Answers:</t>
3664                        <t>
3665                            <list>
3666                                <t>"OK" -
3667                                    <list>
3668                                        <t>on success</t>
3669                                    </list>
3670                                </t>
3671                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3672                                    <list>
3673                                        <t>in case it failed, providing an appropriate error code and error message</t>
3674                                    </list>
3675                                </t>
3676                            </list>
3677                        </t>
3678                        <t>Example:</t>
3679                        <t>
3680                            <list>
3681                                <t>C: "SET FX_SEND SEND_EFFECT 0 0 2 5"</t>
3682                                <t>S: "OK"</t>
3683                            </list>
3684                        </t>
3685                    </section>
3686    
3687                    <section title="Removing destination effect from an effect send" anchor="REMOVE FX_SEND SEND_EFFECT">
3688                        <t>The front-end can (re-)assign a destination effect to an
3689                        effect send by sending the following command:</t>
3690                        <t>
3691                            <list>
3692                                <t>REMOVE FX_SEND SEND_EFFECT &lt;sampler-chan&gt; &lt;fx-send-id&gt;</t>
3693                            </list>
3694                        </t>
3695                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3696                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3697                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3698                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3699                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3700                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t>
3701    
3702                        <t>After the destination effect has been removed from the
3703                        effect send, the audio signal of the effect send will be
3704                        routed directly to the audio output device, according to the
3705                        audio channel routing setting of the effect send.
3706                        </t>
3707    
3708                        <t>Possible Answers:</t>
3709                        <t>
3710                            <list>
3711                                <t>"OK" -
3712                                    <list>
3713                                        <t>on success</t>
3714                                    </list>
3715                                </t>
3716                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3717                                    <list>
3718                                        <t>in case it failed, providing an appropriate error code and error message</t>
3719                                    </list>
3720                                </t>
3721                            </list>
3722                        </t>
3723                        <t>Example:</t>
3724                        <t>
3725                            <list>
3726                                <t>C: "REMOVE FX_SEND SEND_EFFECT 0 0"</t>
3727                                <t>S: "OK"</t>
3728                            </list>
3729                        </t>
3730                    </section>
3731    
3732                  <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">
3733                      <t>The front-end can alter the MIDI controller of an effect                      <t>The front-end can alter the MIDI controller of an effect
3734                      send entity by sending the following command:</t>                      send entity by sending the following command:</t>
# Line 6554  Schoenebeck'> Line 6662  Schoenebeck'>
6662                      </t>                      </t>
6663                  </section>                  </section>
6664              </section>              </section>
6665                <section title="Managing Effects" anchor="effects">
6666                    <t>Audio effects (e.g. reverb, delay, compression) can be
6667                    applied to the audio signals generated by the sampler. The
6668                    sampler usually provides a set of internal audio effects for
6669                    this task. The exact set of effects depends on the availability
6670                    of third party effect plugins installed on the system where the
6671                    sampler runs on.</t>
6672                    <t>At the moment only "send effects" are supported. Support for
6673                    "insert effects" and "master effects" is planned to be added at
6674                    a later point.</t>
6675                    <t>The following commands allow to retrieve the set of internal
6676                    effects available to the sampler, detailed informations about
6677                    those effects and to create and destroy instances of such
6678                    effects. After an instance of an effect is created, the effect
6679                    instance can be inserted into the audio signal path of the
6680                    sampler, e.g. as send effect.</t>
6681                    <t>The sampler allows to create an arbitrary amount of so called
6682                    send effect chains. Each effect chain can host an arbitrary
6683                    amount of effect instances. The output of the first effect
6684                    instance in an effect chain is fed to the input of the second
6685                    effect instance of the chain and so on. So effects in one chain
6686                    are processed sequentially. Send effect chains however are
6687                    processed in parallel to other send effect chains. Audio signals
6688                    of sampler channels are fed to send effects by creating FX sends
6689                    to the respective sampler channel and assigning a destination
6690                    send effect to that FX by using the
6691                    <xref target="SET FX_SEND SEND_EFFECT">"SET FX_SEND SEND_EFFECT"</xref>
6692                    command. The latter allows to route the FX send to the beginning
6693                    of a send effect chain, as well as directly to any other
6694                    position of the send effect chain.</t>
6695    
6696                    <section title="Retrieve amount of available effects" anchor="GET AVAILABLE_EFFECTS">
6697                        <t>The front-end can retrieve the amount of internal
6698                        effects, available to the sampler by sending
6699                        the following command:</t>
6700                        <t>
6701                            <list>
6702                                <t>GET AVAILABLE_EFFECTS</t>
6703                            </list>
6704                        </t>
6705    
6706                        <t>Possible Answers:</t>
6707                        <t>
6708                            <list>
6709                                <t>The sampler will answer by returning the current
6710                                number of effects available to the sampler.</t>
6711                            </list>
6712                        </t>
6713    
6714                        <t>Examples:</t>
6715                        <t>
6716                            <list>
6717                                <t>C: "GET AVAILABLE_EFFECTS"</t>
6718                                <t>S: "129"</t>
6719                            </list>
6720                        </t>
6721                    </section>
6722    
6723                    <section title="Get list of available effects" anchor="LIST AVAILABLE_EFFECTS">
6724                        <t>The set of available internal effects can change at
6725                        runtime. The front-end can retrieve the list of internal
6726                        effects, available to the sampler by sending the following
6727                        command:</t>
6728                        <t>
6729                            <list>
6730                                <t>LIST AVAILABLE_EFFECTS</t>
6731                            </list>
6732                        </t>
6733    
6734                        <t>Possible Answers:</t>
6735                        <t>
6736                            <list>
6737                                <t>The sampler will answer by returning a comma
6738                                separated list with numerical IDs of effects. Note:
6739                                the numercial ID of an effect is generated by the
6740                                sampler for the current moment. The numerical ID of
6741                                the same effect can change at runtime, e.g. when the
6742                                user requests a rescan of available effect plugins.
6743                                </t>
6744                            </list>
6745                        </t>
6746                        <t>Example:</t>
6747                        <t>
6748                            <list>
6749                                <t>C: "LIST AVAILABLE_EFFECTS"</t>
6750                                <t>S: "5,6,7,120,121,122,123,124"</t>
6751                            </list>
6752                        </t>
6753                    </section>
6754    
6755                    <section title="Retrieving general information about an effect" anchor="GET EFFECT INFO">
6756                        <t>The front-end can ask for general informations about an
6757                        effect by sending the following command:</t>
6758                        <t>
6759                            <list>
6760                                <t>GET EFFECT INFO &lt;effect-index&gt;</t>
6761                            </list>
6762                        </t>
6763                        <t>Where &lt;effect-index&gt; is the numerical ID of an
6764                        effect as returned by the
6765                        <xref target="LIST AVAILABLE_EFFECTS">"LIST AVAILABLE_EFFECTS"</xref>
6766                        command.</t>
6767                        <t>Possible Answers:</t>
6768                        <t>
6769                            <list>
6770                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6771                                Each answer line begins with the effect information
6772                                category name, followed by a colon and then a space
6773                                character &lt;SP&gt; and finally the info character
6774                                string to that effect information category. At the
6775                                moment the following categories are defined:</t>
6776                                <t>
6777                                    <list>
6778                                        <t>SYSTEM -
6779                                            <list>
6780                                                <t>name of the effect plugin system
6781                                                the effect is based on
6782                                                (e.g. "LADSPA")</t>
6783                                            </list>
6784                                        </t>
6785                                        <t>MODULE -
6786                                            <list>
6787                                                <t>module of the effect plugin
6788                                                system that contains this effect,
6789                                                the module is usually the
6790                                                dynamic-linked library (DLL)
6791                                                filename of the effect plugin,
6792                                                including full path (note that this
6793                                                filename may contain
6794                                                <xref target="character_set">escape sequences</xref>)</t>
6795                                            </list>
6796                                        </t>
6797                                        <t>NAME -
6798                                            <list>
6799                                                <t>character string defining the
6800                                                unique name of the effect within its
6801                                                module (note that the character
6802                                                string may contain
6803                                                <xref target="character_set">escape sequences</xref>)</t>
6804                                            </list>
6805                                        </t>
6806                                        <t>DESCRIPTION -
6807                                            <list>
6808                                                <t>human readable name of the
6809                                                effect, intended to be displayed in
6810                                                user interfaces (note that the
6811                                                character string may contain
6812                                                <xref target="character_set">escape sequences</xref>)</t>
6813                                            </list>
6814                                        </t>
6815                                    </list>
6816                                </t>
6817                            </list>
6818                        </t>
6819                        <t>The mentioned fields above don't have to be in particular order.</t>
6820    
6821                        <t>Example:</t>
6822                        <t>
6823                            <list>
6824                                <t>C: "GET EFFECT INFO 121"</t>
6825                                <t>S: "SYSTEM: LADSPA"</t>
6826                                <t>&nbsp;&nbsp;&nbsp;"MODULE: /usr/lib/ladspa/lowpass_iir_1891.so"</t>
6827                                <t>&nbsp;&nbsp;&nbsp;"NAME: lowpass_iir"</t>
6828                                <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: Glame Lowpass Filter"</t>
6829                                <t>&nbsp;&nbsp;&nbsp;"."</t>
6830                            </list>
6831                        </t>
6832                    </section>
6833    
6834                    <section title="Creating an instance of an effect by its portable ID" anchor="CREATE EFFECT_INSTANCE">
6835                        <t>The front-end can spawn an instance of the desired
6836                        effect by sending the following command:</t>
6837                        <t>
6838                            <list>
6839                                <t>CREATE EFFECT_INSTANCE &lt;effect-system&gt; &lt;module&gt; &lt;effect-name&gt;</t>
6840                            </list>
6841                        </t>
6842                        <t>Where &lt;effect-system&gt; is the "SYSTEM" field,
6843                        &lt;module&gt; the "MODULE" field and &lt;effect-name&gt;
6844                        the "NAME" field as returned by the
6845                        <xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref>
6846                        command. The filename of argument &lt;module&gt; and the
6847                        character string of argument &lt;effect-name&gt; may contain
6848                        <xref target="character_set">escape sequences</xref>.</t>
6849    
6850                        <t>The sampler will try to load the requested effect and to
6851                        create an instance of it. To allow loading the same effect
6852                        on a different machine, probably even running a completely
6853                        different operating system (e.g. Linux vs. Windows), the
6854                        sampler tries to match &lt;module&gt; "softly". That means
6855                        it first tries to find an effect that exactly matches the
6856                        given &lt;module&gt; argument. If there is no exact match,
6857                        the sampler will try to lower the restrictions on matching
6858                        the &lt;module&gt; argument more and more, e.g. by ignoring
6859                        upper / lower case differences and by ignoring the path of
6860                        the DLL filename and file extension. If there is still no
6861                        match at the end, the sampler will try to ignore the
6862                        &lt;module&gt; argument completely and as a last resort
6863                        search for an effect that only matches the given
6864                        &lt;effect-system&gt; and &lt;effect-name&gt; arguments.</t>
6865    
6866                        <t>Possible Answers:</t>
6867                        <t>
6868                            <list>
6869                                <t>"OK[&lt;effect-instance&gt;]" -
6870                                    <list>
6871                                        <t>in case the effect instance was
6872                                        successfully created, where
6873                                        &lt;effect-instance&gt; is the numerical ID
6874                                        of the new effect instance</t>
6875                                    </list>
6876                                </t>
6877                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6878                                    <list>
6879                                        <t>in case the effect instance was spawned
6880                                        successfully, but there are noteworthy
6881                                        issue(s) related, providing an appropriate
6882                                        warning code and warning message</t>
6883                                    </list>
6884                                </t>
6885                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6886                                    <list>
6887                                        <t>if the effect could not be instantiated</t>
6888                                    </list>
6889                                </t>
6890                            </list>
6891                        </t>
6892    
6893                        <t>Examples:</t>
6894                        <t>
6895                            <list>
6896                                <t>C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/mod_delay_1419.so' 'modDelay'"</t>
6897                                <t>S: "OK[0]"</t>
6898                            </list>
6899                        </t>
6900                    </section>
6901    
6902                    <section title="Creating an instance of an effect by its numerical ID" anchor="CREATE EFFECT_INSTANCE (non-portable)">
6903                        <t>The front-end can spawn an instance of the desired
6904                        effect by sending the following command:</t>
6905                        <t>
6906                            <list>
6907                                <t>CREATE EFFECT_INSTANCE &lt;effect-index&gt;</t>
6908                            </list>
6909                        </t>
6910                        <t>Where &lt;effect-index&gt; is the numerical ID of the
6911                        effect as returned by the
6912                        <xref target="LIST AVAILABLE_EFFECTS">"LIST AVAILABLE_EFFECTS"</xref>
6913                        command.</t>
6914    
6915                        <t>The sampler will try to load the requested effect and to
6916                        create an instance of it.</t>
6917    
6918                        <t>Note: Since the numerical ID of a certain effect can
6919                        change at any time, you should not use this command in
6920                        LSCP files to restore a certain effect at a later time! To
6921                        store a sampler session including all its effects, use the
6922                        <xref target="CREATE EFFECT_INSTANCE">portable text-based
6923                        version of "CREATE EFFECT_INSTANCE"</xref> instead! This
6924                        allows to restore a sampler session with all its effects
6925                        also on other machines, possibly even running a completely
6926                        different operating system (e.g. Linux vs. Windows), with
6927                        different plugin directories or plugin DLL names.</t>
6928    
6929                        <t>Possible Answers:</t>
6930                        <t>
6931                            <list>
6932                                <t>"OK[&lt;effect-instance&gt;]" -
6933                                    <list>
6934                                        <t>in case the effect instance was
6935                                        successfully created, where
6936                                        &lt;effect-instance&gt; is the numerical ID
6937                                        of the new effect instance</t>
6938                                    </list>
6939                                </t>
6940                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6941                                    <list>
6942                                        <t>in case the effect instance was spawned
6943                                        successfully, but there are noteworthy
6944                                        issue(s) related, providing an appropriate
6945                                        warning code and warning message</t>
6946                                    </list>
6947                                </t>
6948                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6949                                    <list>
6950                                        <t>if the effect could not be instantiated</t>
6951                                    </list>
6952                                </t>
6953                            </list>
6954                        </t>
6955    
6956                        <t>Examples:</t>
6957                        <t>
6958                            <list>
6959                                <t>C: "CREATE EFFECT_INSTANCE 72"</t>
6960                                <t>S: "OK[5]"</t>
6961                            </list>
6962                        </t>
6963                    </section>
6964    
6965                    <section title="Destroy an effect instance" anchor="DESTROY EFFECT_INSTANCE">
6966                        <t>The front-end can destroy an unusued effect instance and
6967                        thus freeing it from memory by sending the following command:</t>
6968                        <t>
6969                            <list>
6970                                <t>DESTROY EFFECT_INSTANCE &lt;effect-instance&gt;</t>
6971                            </list>
6972                        </t>
6973                        <t>Where &lt;effect-instance&gt; is the numerical ID of the
6974                        effect instance as returned by the
6975                        <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or
6976                        <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
6977                        command.</t>
6978    
6979                        <t>The effect instance can only be destroyed if it's not
6980                        used in any part of the sampler's audio signal path anymore.
6981                        If the effect instance is still in use somewhere, trying to
6982                        destroy the effect instance will result in an error
6983                        message.</t>
6984    
6985                        <t>Possible Answers:</t>
6986                        <t>
6987                            <list>
6988                                <t>"OK" -
6989                                    <list>
6990                                        <t>in case the effect instance was successfully destroyed</t>
6991                                    </list>
6992                                </t>
6993                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6994                                    <list>
6995                                        <t>in case it failed, providing an appropriate error code and
6996                                        error message</t>
6997                                    </list>
6998                                </t>
6999                            </list>
7000                        </t>
7001    
7002                        <t>Examples:</t>
7003                        <t>
7004                            <list>
7005                                <t>C: "DESTROY EFFECT_INSTANCE 5"</t>
7006                                <t>S: "OK"</t>
7007                            </list>
7008                        </t>
7009                    </section>
7010    
7011                    <section title="Retrieve amount of effect instances" anchor="GET EFFECT_INSTANCES">
7012                        <t>The front-end can retrieve the current amount of effect
7013                        instances by sending the following command:</t>
7014                        <t>
7015                            <list>
7016                                <t>GET EFFECT_INSTANCES</t>
7017                            </list>
7018                        </t>
7019    
7020                        <t>Possible Answers:</t>
7021                        <t>
7022                            <list>
7023                                <t>The sampler will answer by returning the current
7024                                number of effect instances created and not yet
7025                                destroyed in the current sampler session.</t>
7026                            </list>
7027                        </t>
7028    
7029                        <t>Examples:</t>
7030                        <t>
7031                            <list>
7032                                <t>C: "GET EFFECT_INSTANCES"</t>
7033                                <t>S: "14"</t>
7034                            </list>
7035                        </t>
7036                    </section>
7037    
7038                    <section title="Get list of effect instances" anchor="LIST EFFECT_INSTANCES">
7039                        <t>The front-end can retrieve the current list of effect
7040                        instances by sending the following command:</t>
7041                        <t>
7042                            <list>
7043                                <t>LIST EFFECT_INSTANCES</t>
7044                            </list>
7045                        </t>
7046    
7047                        <t>Possible Answers:</t>
7048                        <t>
7049                            <list>
7050                                <t>The sampler will answer by returning a comma
7051                                separated list with numerical IDs of effects
7052                                instances.
7053                                </t>
7054                            </list>
7055                        </t>
7056                        <t>Example:</t>
7057                        <t>
7058                            <list>
7059                                <t>C: "LIST EFFECT_INSTANCES"</t>
7060                                <t>S: "9,11,14,15,16,17,25"</t>
7061                            </list>
7062                        </t>
7063                    </section>
7064    
7065                    <section title="Retrieving current information about an effect instance" anchor="GET EFFECT_INSTANCE INFO">
7066                        <t>The front-end can ask for the current informations about
7067                        a particular effect instance by sending the following command:</t>
7068                        <t>
7069                            <list>
7070                                <t>GET EFFECT_INSTANCE INFO &lt;effect-instance&gt;</t>
7071                            </list>
7072                        </t>
7073                        <t>Where &lt;effect-instance&gt; is the numerical ID of an
7074                        effect instance as returned by the
7075                        <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref>
7076                        or
7077                        <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
7078                        command.</t>
7079    
7080                        <t>Possible Answers:</t>
7081                        <t>
7082                            <list>
7083                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
7084                                Each answer line begins with the information
7085                                category name, followed by a colon and then a space
7086                                character &lt;SP&gt; and finally the info character
7087                                string to that information category. At the
7088                                moment the following categories are defined:</t>
7089                                <t>
7090                                    <list>
7091                                        <t>SYSTEM -
7092                                            <list>
7093                                                <t>name of the effect plugin system
7094                                                the effect is based on
7095                                                (e.g. "LADSPA")</t>
7096                                            </list>
7097                                        </t>
7098                                        <t>MODULE -
7099                                            <list>
7100                                                <t>module of the effect plugin
7101                                                system that contains this effect,
7102                                                the module is usually the
7103                                                dynamic-linked library (DLL)
7104                                                filename of the effect plugin,
7105                                                including full path (note that this
7106                                                filename may contain
7107                                                <xref target="character_set">escape sequences</xref>)</t>
7108                                            </list>
7109                                        </t>
7110                                        <t>NAME -
7111                                            <list>
7112                                                <t>character string defining the
7113                                                unique name of the effect within its
7114                                                module (note that the character
7115                                                string may contain
7116                                                <xref target="character_set">escape sequences</xref>)</t>
7117                                            </list>
7118                                        </t>
7119                                        <t>DESCRIPTION -
7120                                            <list>
7121                                                <t>human readable name of the
7122                                                effect, intended to be displayed in
7123                                                user interfaces (note that the
7124                                                character string may contain
7125                                                <xref target="character_set">escape sequences</xref>)</t>
7126                                            </list>
7127                                        </t>
7128                                        <t>INPUT_CONTROLS -
7129                                            <list>
7130                                                <t>amount of input controls the
7131                                                effect instance provides, to allow
7132                                                controlling the effect parameters in
7133                                                realtime</t>
7134                                            </list>
7135                                        </t>
7136                                    </list>
7137                                </t>
7138                            </list>
7139                        </t>
7140                        <t>The mentioned fields above don't have to be in particular order.</t>
7141    
7142                        <t>Example:</t>
7143                        <t>
7144                            <list>
7145                                <t>C: "GET EFFECT_INSTANCE INFO 3"</t>
7146                                <t>S: "SYSTEM: LADSPA"</t>
7147                                <t>&nbsp;&nbsp;&nbsp;"MODULE: /usr/lib/ladspa/mod_delay_1419.so"</t>
7148                                <t>&nbsp;&nbsp;&nbsp;"NAME: modDelay"</t>
7149                                <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: Modulatable delay"</t>
7150                                <t>&nbsp;&nbsp;&nbsp;"INPUT_CONTROLS: 1"</t>
7151                                <t>&nbsp;&nbsp;&nbsp;"."</t>
7152                            </list>
7153                        </t>
7154                    </section>
7155    
7156                    <section title="Retrieving information about an effect parameter" anchor="GET EFFECT_INSTANCE_INPUT_CONTROL INFO">
7157                        <t>Effects typically provide a certain set of effect
7158                        parameters which can be altered by the user in realtime
7159                        (e.g. depth of a reverb effect, duration of a delay effect,
7160                        dry / wet signal ratio). Those controllable effect parameters
7161                        are called "input controls". The front-end can ask for the
7162                        current informations of an effect instance's input control
7163                        by sending the following command:</t>
7164                        <t>
7165                            <list>
7166                                <t>GET EFFECT_INSTANCE_INPUT_CONTROL INFO &lt;effect-instance&gt; &lt;input-control&gt;</t>
7167                            </list>
7168                        </t>
7169                        <t>Where &lt;effect-instance&gt; is the numerical ID of an
7170                        effect instance as returned by the
7171                        <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref>
7172                        or
7173                        <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
7174                        command and &lt;input-control&gt; is the index of the input
7175                        control within the numerical bounds as returned by the
7176                        "INPUT_CONTROLS" field of the
7177                        <xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref>
7178                        command.</t>
7179    
7180                        <t>Possible Answers:</t>
7181                        <t>
7182                            <list>
7183                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
7184                                Each answer line begins with the information
7185                                category name, followed by a colon and then a space
7186                                character &lt;SP&gt; and finally the info character
7187                                string to that information category. There are
7188                                information categories which are always returned,
7189                                independent of the respective effect parameter and
7190                                there are optional information categories
7191                                which are only shown for certain effect parameters.
7192                                At the moment the following categories are defined:</t>
7193                                <t>
7194                                    <list>
7195                                        <t>DESCRIPTION -
7196                                            <list>
7197                                                <t>(always returned)
7198                                                human readable name of the
7199                                                effect parameter, intended to be
7200                                                displayed in user interfaces (note
7201                                                that the character string may
7202                                                contain <xref target="character_set">escape sequences</xref>)</t>
7203                                            </list>
7204                                        </t>
7205                                        <t>VALUE -
7206                                            <list>
7207                                                <t>
7208                                                (always returned)
7209                                                current (optional dotted)
7210                                                floating point value of this effect
7211                                                parameter</t>
7212                                            </list>
7213                                        </t>
7214                                        <t>RANGE_MIN -
7215                                            <list>
7216                                                <t>
7217                                                (optionally returned)
7218                                                minimum allowed value for this
7219                                                effect parameter</t>
7220                                            </list>
7221                                        </t>
7222                                        <t>RANGE_MAX -
7223                                            <list>
7224                                                <t>
7225                                                (optionally returned)
7226                                                maximum allowed value for this
7227                                                effect parameter</t>
7228                                            </list>
7229                                        </t>
7230                                        <t>POSSIBILITIES -
7231                                            <list>
7232                                                <t>
7233                                                (optionally returned)
7234                                                comma separated list of
7235                                                (optional dotted) floating point
7236                                                numbers, reflecting the exact set of
7237                                                possible values for this effect
7238                                                parameter</t>
7239                                            </list>
7240                                        </t>
7241                                        <t>DEFAULT -
7242                                            <list>
7243                                                <t>
7244                                                (optionally returned)
7245                                                default value of this effect
7246                                                parameter</t>
7247                                            </list>
7248                                        </t>
7249                                    </list>
7250                                </t>
7251                            </list>
7252                        </t>
7253                        <t>The mentioned fields above don't have to be in particular order.</t>
7254    
7255                        <t>Example:</t>
7256                        <t>
7257                            <list>
7258                                <t>C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0"</t>
7259                                <t>S: "SYSTEM: LADSPA"</t>
7260                                <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: Base delay (s)"</t>
7261                                <t>&nbsp;&nbsp;&nbsp;"VALUE: 0.500"</t>
7262                                <t>&nbsp;&nbsp;&nbsp;"RANGE_MIN: 0.000"</t>
7263                                <t>&nbsp;&nbsp;&nbsp;"."</t>
7264                            </list>
7265                        </t>
7266                    </section>
7267    
7268                    <section title="Altering an effect parameter" anchor="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE">
7269                        <t>The front-end can alter the current value of an effect
7270                        parameter by sending the following command:</t>
7271                        <t>
7272                            <list>
7273                                <t>SET EFFECT_INSTANCE_INPUT_CONTROL VALUE &lt;effect-instance&gt; &lt;input-control&gt; &lt;value&gt;</t>
7274                            </list>
7275                        </t>
7276                        <t>Where &lt;effect-instance&gt; is the numerical ID of the
7277                        effect instance as returned by the
7278                        <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or
7279                        <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
7280                        command, &lt;input-control&gt; is the index of the input
7281                        control within the numerical bounds as returned by the
7282                        "INPUT_CONTROLS" field of the
7283                        <xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref>
7284                        command and &lt;value&gt; is the new (optional dotted)
7285                        floating point value for this effect parameter.</t>
7286    
7287                        <t>Possible Answers:</t>
7288                        <t>
7289                            <list>
7290                                <t>"OK" -
7291                                    <list>
7292                                        <t>in case the effect was altered successfully</t>
7293                                    </list>
7294                                </t>
7295                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7296                                    <list>
7297                                        <t>in case it failed, providing an appropriate error code and
7298                                        error message</t>
7299                                    </list>
7300                                </t>
7301                            </list>
7302                        </t>
7303    
7304                        <t>Examples:</t>
7305                        <t>
7306                            <list>
7307                                <t>C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5"</t>
7308                                <t>S: "OK"</t>
7309                            </list>
7310                        </t>
7311                    </section>
7312    
7313                    <section title="Retrieve amount of send effect chains" anchor="GET SEND_EFFECT_CHAINS">
7314                        <t>The front-end can retrieve the current amount of send
7315                        effect chains of an audio output device by sending the
7316                        following command:</t>
7317                        <t>
7318                            <list>
7319                                <t>GET SEND_EFFECT_CHAINS &lt;audio-device&gt;</t>
7320                            </list>
7321                        </t>
7322                        <t>Where &lt;audio-device&gt; should be replaced by the
7323                        numerical ID of the audio output device as given by the
7324                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7325                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7326                        command.</t>
7327    
7328                        <t>Possible Answers:</t>
7329                        <t>
7330                            <list>
7331                                <t>The sampler will answer by returning the current
7332                                number of send effect chains of the supplied audio
7333                                output device.</t>
7334                            </list>
7335                        </t>
7336    
7337                        <t>Examples:</t>
7338                        <t>
7339                            <list>
7340                                <t>C: "GET SEND_EFFECT_CHAINS 0"</t>
7341                                <t>S: "4"</t>
7342                            </list>
7343                        </t>
7344                    </section>
7345    
7346                    <section title="Retrieve list of send effect chains" anchor="LIST SEND_EFFECT_CHAINS">
7347                        <t>The front-end can retrieve the current list of send
7348                        effect chains of an audio output device by sending the
7349                        following command:</t>
7350                        <t>
7351                            <list>
7352                                <t>LIST SEND_EFFECT_CHAINS &lt;audio-device&gt;</t>
7353                            </list>
7354                        </t>
7355                        <t>Where &lt;audio-device&gt; should be replaced by the
7356                        numerical ID of the audio output device as given by the
7357                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7358                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7359                        command.</t>
7360    
7361                        <t>Possible Answers:</t>
7362                        <t>
7363                            <list>
7364                                <t>The sampler will answer by returning a comma
7365                                separated list with numerical IDs of send effect
7366                                chains of the supplied audio output device.
7367                                </t>
7368                            </list>
7369                        </t>
7370    
7371                        <t>Examples:</t>
7372                        <t>
7373                            <list>
7374                                <t>C: "LIST SEND_EFFECT_CHAINS 0"</t>
7375                                <t>S: "3,4,7"</t>
7376                            </list>
7377                        </t>
7378                    </section>
7379    
7380                    <section title="Add send effect chain" anchor="ADD SEND_EFFECT_CHAIN">
7381                        <t>The front-end can add a send effect chain by sending the
7382                        following command:</t>
7383                        <t>
7384                            <list>
7385                                <t>ADD SEND_EFFECT_CHAIN &lt;audio-device&gt;</t>
7386                            </list>
7387                        </t>
7388                        <t>Where &lt;audio-device&gt; should be replaced by the
7389                        numerical ID of the audio output device as given by the
7390                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7391                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7392                        command.</t>
7393    
7394                        <t>Possible Answers:</t>
7395                        <t>
7396                            <list>
7397                                <t>"OK[&lt;effect-chain&gt;]" -
7398                                    <list>
7399                                        <t>in case the send effect chain was
7400                                        added successfully, where
7401                                        &lt;effect-chain&gt; is the numerical ID
7402                                        of the new send effect chain</t>
7403                                    </list>
7404                                </t>
7405                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7406                                    <list>
7407                                        <t>if the send effect chain could not be added</t>
7408                                    </list>
7409                                </t>
7410                            </list>
7411                        </t>
7412    
7413                        <t>Examples:</t>
7414                        <t>
7415                            <list>
7416                                <t>C: "ADD SEND_EFFECT_CHAIN 0"</t>
7417                                <t>S: "OK[2]"</t>
7418                            </list>
7419                        </t>
7420                    </section>
7421    
7422                    <section title="Remove send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN">
7423                        <t>The front-end can remove a send effect chain by sending
7424                        the following command:</t>
7425                        <t>
7426                            <list>
7427                                <t>REMOVE SEND_EFFECT_CHAIN &lt;audio-device&gt; &lt;effect-chain&gt;</t>
7428                            </list>
7429                        </t>
7430                        <t>Where &lt;audio-device&gt; should be replaced by the
7431                        numerical ID of the audio output device as given by the
7432                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7433                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7434                        command and &lt;effect-chain&gt; by the numerical ID as
7435                        returned by the
7436                        <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
7437                        or
7438                        <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
7439                        command.</t>
7440    
7441                        <t>Possible Answers:</t>
7442                        <t>
7443                            <list>
7444                                <t>"OK" -
7445                                    <list>
7446                                        <t>in case the send effect chain was
7447                                        removed successfully</t>
7448                                    </list>
7449                                </t>
7450                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7451                                    <list>
7452                                        <t>if the send effect chain could not be removed</t>
7453                                    </list>
7454                                </t>
7455                            </list>
7456                        </t>
7457    
7458                        <t>Examples:</t>
7459                        <t>
7460                            <list>
7461                                <t>C: "REMOVE SEND_EFFECT_CHAIN 0 2"</t>
7462                                <t>S: "OK"</t>
7463                            </list>
7464                        </t>
7465                    </section>
7466    
7467                    <section title="Retrieving information about a send effect chain" anchor="GET SEND_EFFECT_CHAIN INFO">
7468                        <t>The front-end can ask for informations of a send effect
7469                        chain by sending the following command:</t>
7470                        <t>
7471                            <list>
7472                                <t>GET SEND_EFFECT_CHAIN INFO &lt;audio-device&gt; &lt;effect-chain&gt;</t>
7473                            </list>
7474                        </t>
7475                        <t>Where &lt;audio-device&gt; should be replaced by the
7476                        numerical ID of the audio output device as given by the
7477                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7478                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7479                        command and &lt;effect-chain&gt; by the numerical ID as
7480                        returned by the
7481                        <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
7482                        or
7483                        <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
7484                        command.</t>
7485    
7486                        <t>Possible Answers:</t>
7487                        <t>
7488                            <list>
7489                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
7490                                Each answer line begins with the information
7491                                category name, followed by a colon and then a space
7492                                character &lt;SP&gt; and finally the info character
7493                                string to that information category.
7494                                At the moment the following categories are defined:</t>
7495                                <t>
7496                                    <list>
7497                                        <t>EFFECT_COUNT -
7498                                            <list>
7499                                                <t>amount of effects in this send
7500                                                effect chain</t>
7501                                            </list>
7502                                        </t>
7503                                        <t>EFFECT_SEQUENCE -
7504                                            <list>
7505                                                <t>comma separated list of the
7506                                                numerical IDs of the effect
7507                                                instances in this send effect chain,
7508                                                in the order as they are procssed in
7509                                                the effect chain</t>
7510                                            </list>
7511                                        </t>
7512                                    </list>
7513                                </t>
7514                            </list>
7515                        </t>
7516                        <t>The mentioned fields above don't have to be in particular order.</t>
7517    
7518                        <t>Example:</t>
7519                        <t>
7520                            <list>
7521                                <t>C: "GET SEND_EFFECT_CHAIN INFO 0 2"</t>
7522                                <t>S: "EFFECT_COUNT: 3"</t>
7523                                <t>&nbsp;&nbsp;&nbsp;"EFFECT_SEQUENCE: 31,4,7"</t>
7524                                <t>&nbsp;&nbsp;&nbsp;"."</t>
7525                            </list>
7526                        </t>
7527                    </section>
7528    
7529                    <section title="Append effect instance to a send effect chain" anchor="APPEND SEND_EFFECT_CHAIN EFFECT">
7530                        <t>The front-end can add an unused effect instance to the
7531                        end of a send effect chain by sending the following command:</t>
7532                        <t>
7533                            <list>
7534                                <t>APPEND SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;effect-instance&gt;</t>
7535                            </list>
7536                        </t>
7537                        <t>Where &lt;audio-device&gt; should be replaced by the
7538                        numerical ID of the audio output device as given by the
7539                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7540                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7541                        command and &lt;effect-chain&gt; by the numerical ID as
7542                        returned by the
7543                        <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
7544                        or
7545                        <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
7546                        command and &lt;effect-instance&gt; as returned by the
7547                        <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or
7548                        <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
7549                        command.</t>
7550                        <t>Only unused effect instances can be added to the effect
7551                        chain. Trying to add an effect instance which is already in
7552                        use somewhere in the audio signal path of the sampler will
7553                        result in an error.</t>
7554    
7555                        <t>Possible Answers:</t>
7556                        <t>
7557                            <list>
7558                                <t>"OK" -
7559                                    <list>
7560                                        <t>in case the effect instance was
7561                                        added successfully to the chain</t>
7562                                    </list>
7563                                </t>
7564                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7565                                    <list>
7566                                        <t>if the effect instance could not be added</t>
7567                                    </list>
7568                                </t>
7569                            </list>
7570                        </t>
7571    
7572                        <t>Examples:</t>
7573                        <t>
7574                            <list>
7575                                <t>C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38"</t>
7576                                <t>S: "OK"</t>
7577                            </list>
7578                        </t>
7579                    </section>
7580    
7581                    <section title="Insert effect instance to a send effect chain" anchor="INSERT SEND_EFFECT_CHAIN EFFECT">
7582                        <t>The front-end can add an unused effect instance to a
7583                        certain position of a send effect chain by sending the
7584                        following command:</t>
7585                        <t>
7586                            <list>
7587                                <t>INSERT SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;chain-pos&gt; &lt;effect-instance&gt;</t>
7588                            </list>
7589                        </t>
7590                        <t>Where &lt;audio-device&gt; should be replaced by the
7591                        numerical ID of the audio output device as given by the
7592                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7593                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7594                        command, &lt;effect-chain&gt; by the numerical ID as
7595                        returned by the
7596                        <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
7597                        or
7598                        <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
7599                        command, &lt;effect-instance&gt; as returned by the
7600                        <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or
7601                        <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
7602                        command and &lt;chain-pos&gt; the exact position of the
7603                        effect chain where the supplied effect shall be inserted
7604                        to.</t>
7605                        <t>Only unused effect instances can be added to the effect
7606                        chain. Trying to add an effect instance which is already in
7607                        use somewhere in the audio signal path of the sampler will
7608                        result in an error.</t>
7609    
7610                        <t>Possible Answers:</t>
7611                        <t>
7612                            <list>
7613                                <t>"OK" -
7614                                    <list>
7615                                        <t>in case the effect instance was
7616                                        added successfully to the chain</t>
7617                                    </list>
7618                                </t>
7619                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7620                                    <list>
7621                                        <t>if the effect instance could not be added</t>
7622                                    </list>
7623                                </t>
7624                            </list>
7625                        </t>
7626    
7627                        <t>Examples:</t>
7628                        <t>
7629                            <list>
7630                                <t>C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38"</t>
7631                                <t>S: "OK"</t>
7632                            </list>
7633                        </t>
7634                    </section>
7635    
7636                    <section title="Remove effect instance from send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN EFFECT">
7637                        <t>The front-end can remove an effect instance from a
7638                        certain position of a send effect chain by sending the
7639                        following command:</t>
7640                        <t>
7641                            <list>
7642                                <t>REMOVE SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;chain-pos&gt;</t>
7643                            </list>
7644                        </t>
7645                        <t>Where &lt;audio-device&gt; should be replaced by the
7646                        numerical ID of the audio output device as given by the
7647                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7648                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7649                        command, &lt;effect-chain&gt; by the numerical ID as
7650                        returned by the
7651                        <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
7652                        or
7653                        <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
7654                        command and &lt;chain-pos&gt; the exact position of the
7655                        effect instance to be removed from the effect chain.</t>
7656    
7657                        <t>Possible Answers:</t>
7658                        <t>
7659                            <list>
7660                                <t>"OK" -
7661                                    <list>
7662                                        <t>in case the effect instance was
7663                                        removed successfully</t>
7664                                    </list>
7665                                </t>
7666                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7667                                    <list>
7668                                        <t>if the effect instance could not be removed</t>
7669                                    </list>
7670                                </t>
7671                            </list>
7672                        </t>
7673    
7674                        <t>Examples:</t>
7675                        <t>
7676                            <list>
7677                                <t>C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4"</t>
7678                                <t>S: "OK"</t>
7679                            </list>
7680                        </t>
7681                    </section>
7682    
7683                </section>
7684          </section>          </section>
7685    
7686          <section title="Command Syntax" anchor="command_syntax">          <section title="Command Syntax" anchor="command_syntax">
# Line 7520  Schoenebeck'> Line 8647  Schoenebeck'>
8647                      <t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t>                      <t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t>
8648                      <t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t>                      <t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t>
8649                      <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>
8650                        <t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t>
8651                        <t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t>
8652                        <t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t>
8653                  </list>                  </list>
8654                  Note that the forward slash character ('/') has a special meaning in                  Note that the forward slash character ('/') has a special meaning in
8655                  filename / path based arguments: it acts as separator of the nodes in                  filename / path based arguments: it acts as separator of the nodes in
# Line 7564  Schoenebeck'> Line 8694  Schoenebeck'>
8694                      <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>
8695                      <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>
8696                      <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>                      <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
8697                        <t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t>
8698                        <t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t>
8699                        <t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t>
8700                  </list>                  </list>
8701                  Please note that these lists are manually maintained. If you                  Please note that these lists are manually maintained. If you
8702                  find a command that also supports escape sequences we forgot to                  find a command that also supports escape sequences we forgot to
Legend:
Removed from v.2137  
changed lines
  Added in v.2138
  ViewVC Help
Powered by ViewVC