--- linuxsampler/trunk/Documentation/lscp.xml 2014/03/09 21:34:03 2534 +++ linuxsampler/trunk/Documentation/lscp.xml 2019/03/11 15:07:49 3501 @@ -16,7 +16,7 @@ to an annoying "missing Normative/Informative References" error message --> - + LinuxSampler Control Protocol "SET FX_SEND AUDIO_OUTPUT_CHANNEL". + Note: there are two possible approaches to apply audio effects with FX sends: + you can either use a) internal effects or b) external effects. + By default, that is as initial routing, effect sends are automatically routed + directly to the sampler channel's audio output device and the effect send's + audio channels are by default automatically routed to the last audio channels + of that audio output device (for the purpose of applying effects externally that is, + e.g. by using another application), that way you can i.e. first increase the + amount of audio channels on the audio output device for having dedicated effect + send output channels and when "CREATE FX_SEND" is called, those channels will + automatically be picked. You can alter the destination channels however with + "SET FX_SEND AUDIO_OUTPUT_CHANNEL". + If your intention is rather to use internal effects instead of external effects, + then you first need to load those internal effects + and then assign the FX sends to the desired internal effect by sending + "SET FX_SEND EFFECT". Note: Create effect sends on a sampler channel only when needed, because having effect @@ -3875,10 +3883,10 @@ or "LIST FX_SENDS" command, <audio-src> is the numerical ID of the effect send's audio channel which should be rerouted and <audio-dst> is the numerical ID of - the audio channel of the selected audio output device where <audio-src> - should be routed to. If an internal send effect is assigned - to the effect send, then this setting defines the audio - channel routing to that effect instance respectively. + either a) the audio output channel of the sampler channel's audio output + device (i.e. if external effect shall be applied) or b) of the audio + input channel of an internal effect assigned to the FX send where + <audio-src> should be routed to. Note that effect sends can only route audio to the same audio output device as assigned to the effect send's sampler channel. Also note that an @@ -3922,7 +3930,7 @@
- The front-end can (re-)assign a destination effect to an + The front-end can (re-)assign an internal destination effect to an effect send by sending the following command: @@ -3944,6 +3952,16 @@ chain position in the effect chain which hosts the actual destination effect. + Note: This command MUST NOT be used if you want to apply + audio effects externally! By default FX sends are routed directly + to the audio output device for that purpose. + You can also revert this command later on by sending + "REMOVE FX_SEND EFFECT", + which will cause the FX send to be routed directly to the sampler channel's + audio output device instead (i.e. for using external effects instead of + internal effects). + + Possible Answers: @@ -4440,8 +4458,8 @@
-
- The client can ask for general informations about the LinuxSampler +
+ The client can ask for general information about the LinuxSampler instance by sending the following command: @@ -5222,7 +5240,7 @@ just reflects the key of the respective map entry, thus subsequent "GET MIDI_INSTRUMENT INFO" - command(s) are necessary to retrieve detailed informations + command(s) are necessary to retrieve detailed information about each entry. @@ -6766,9 +6784,9 @@
- You can query detailed informations about files located + You can query detailed information about files located at the same system where the sampler instance is running on. - Using this command set allows to retrieve file informations + Using this command set allows to retrieve file information even remotely from another machine.
@@ -6858,8 +6876,8 @@
-
- The front-end can retrieve detailed informations +
+ The front-end can retrieve detailed information about a specific instrument within a given instrument file by sending the following command: @@ -6879,7 +6897,7 @@ The sampler will try to ask all sampler engines, whether they support the given file and ask the first - engine with a positive answer for informations about the + engine with a positive answer for information about the specific instrument in the given file. Possible Answers: @@ -6959,17 +6977,29 @@
- Audio effects (e.g. reverb, delay, compression) can be - applied to the audio signals generated by the sampler. The - sampler usually provides a set of internal audio effects for - this task. The exact set of effects depends on the availability + There are two possible approaches to apply audio effects + (e.g. reverb, delay, compression). + You can either a) load and apply internal effects or you can b) route + effect sends directly to dedicated output channels of your + audio device and apply effects externally (e.g. by routing + those dedicated output channels to another application). + This chapter describes how to load and manage internal effects. + If your intention is rather to apply effects externally, then + you can omit this chapter. For applying effects externally, you + just need to create FX sends + on the respective sampler channel(s) + and adjust their destination audio channels + appropriately, because by default FX sends are automatically routed + directly to the audio output device. + The sampler usually provides a set of internal audio effects. + The exact set of effects depends on the availability of third party effect plugins installed on the system where the - sampler runs on. + sampler runs on (e.g. LADSPA plugins). At the moment only "send effects" are supported. Support for "insert effects" and "master effects" is planned to be added at a later point. The following commands allow to retrieve the set of internal - effects available to the sampler, detailed informations about + effects available to the sampler, detailed information about those effects and to create and destroy instances of such effects. After an instance of an effect is created, the effect instance can be inserted into the audio signal path of the @@ -7049,7 +7079,7 @@
- The front-end can ask for general informations about an + The front-end can ask for general information about an effect by sending the following command: @@ -7359,7 +7389,7 @@
- The front-end can ask for the current informations about + The front-end can ask for the current information about a particular effect instance by sending the following command: @@ -7455,7 +7485,7 @@ (e.g. depth of a reverb effect, duration of a delay effect, dry / wet signal ratio). Those controllable effect parameters are called "input controls". The front-end can ask for the - current informations of an effect instance's input control + current information of an effect instance's input control by sending the following command: @@ -7760,7 +7790,7 @@
- The front-end can ask for informations of a send effect + The front-end can ask for information of a send effect chain by sending the following command: