--- linuxsampler/trunk/Documentation/lscp.xml 2007/02/19 19:38:04 1047
+++ linuxsampler/trunk/Documentation/lscp.xml 2007/03/29 09:40:45 1135
@@ -34,7 +34,7 @@
schoenebeck at software minus engineering dot org
-
+
LinuxSampler Developers
LSCP
@@ -3479,6 +3479,47 @@
+
+ The front-end can alter the current name of an effect
+ send entity by sending the following command:
+
+
+ SET FX_SEND NAME <sampler-chan> <fx-send-id> <name>
+
+
+ Where <sampler-chan> is the sampler channel number
+ as returned by the "ADD CHANNEL"
+ or "LIST CHANNELS" command,
+ <fx-send-id> reflects the numerical ID of the effect send entity
+ as returned by the "CREATE FX_SEND"
+ or "LIST FX_SENDS" command and
+ <name> is the new name of the effect send entity, which
+ does not have to be unique.
+
+ Possible Answers:
+
+
+ "OK" -
+
+ on success
+
+
+ "ERR:<error-code>:<error-message>" -
+
+ in case it failed, providing an appropriate error code and error message
+
+
+
+
+ Example:
+
+
+ C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
+ S: "OK"
+
+
+
+
The front-end can alter the destination of an effect send's audio channel on a specific
sampler channel by sending the following command:
@@ -4198,6 +4239,12 @@
which does not have to be unique
+ DEFAULT -
+
+ either true or false,
+ defines whether this map is the default map
+
+
@@ -4803,6 +4850,10 @@
/ CHANNEL_INFO
+ / FX_SEND_COUNT
+
+ / FX_SEND_INFO
+
/ MIDI_INSTRUMENT_MAP_COUNT
/ MIDI_INSTRUMENT_MAP_INFO
@@ -4815,6 +4866,8 @@
/ TOTAL_VOICE_COUNT
+ / GLOBAL_INFO
+
unsubscribe_event =
@@ -4837,6 +4890,10 @@
/ CHANNEL_INFO
+ / FX_SEND_COUNT
+
+ / FX_SEND_INFO
+
/ MIDI_INSTRUMENT_MAP_COUNT
/ MIDI_INSTRUMENT_MAP_INFO
@@ -4849,6 +4906,8 @@
/ TOTAL_VOICE_COUNT
+ / GLOBAL_INFO
+
map_instruction =
@@ -4965,6 +5024,8 @@
/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
+ / FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
+
/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
@@ -5383,7 +5444,7 @@
Server will start sending the following notification messages:
- "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>
+ "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
where <sampler-channel> will be replaced by the sampler channel the
@@ -5453,6 +5514,44 @@
message is sufficient here.
+
+ Client may want to be notified when the number of effect sends on
+ a particular sampler channel is changed by issuing the following command:
+
+
+ SUBSCRIBE FX_SEND_COUNT
+
+
+ Server will start sending the following notification messages:
+
+
+ "NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"
+
+
+ where <channel-id> will be replaced by the numerical ID of the sampler
+ channel, on which the effect sends number is changed and <fx-sends> will
+ be replaced by the new number of effect sends on that channel.
+
+
+
+ Client may want to be notified when changes were made to effect sends on a
+ a particular sampler channel by issuing the following command:
+
+
+ SUBSCRIBE FX_SEND_INFO
+
+
+ Server will start sending the following notification messages:
+
+
+ "NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"
+
+
+ where <channel-id> will be replaced by the numerical ID of the sampler
+ channel, on which an effect send entity is changed and <fx-send-id> will
+ be replaced by the numerical ID of the changed effect send.
+
+
Client may want to be notified when the total number of voices on the
back-end changes by issuing the following command:
@@ -5464,7 +5563,7 @@
Server will start sending the following notification messages:
- "NOTIFY:TOTAL_VOICE_COUNT:<voices>
+ "NOTIFY:TOTAL_VOICE_COUNT:<voices>"
where <voices> will be replaced by the new number of
@@ -5553,6 +5652,25 @@
message is sufficient here.
+
+ Client may want to be notified when changes to the global settings
+ of the sampler were made by issuing the following command:
+
+
+ SUBSCRIBE GLOBAL_INFO
+
+
+ Server will start sending the following types of notification messages:
+
+
+ "NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the
+ golbal volume of the sampler is changed, where <volume> will be
+ replaced by the optional dotted floating point value, reflecting the
+ new global volume parameter.
+
+
+
+
Client may want to be notified of miscellaneous and debugging events occurring at
the server by issuing the following command: