--- linuxsampler/trunk/Documentation/lscp.xml 2007/10/10 22:41:51 1398
+++ linuxsampler/trunk/Documentation/lscp.xml 2007/10/11 18:53:29 1399
@@ -2443,7 +2443,9 @@
DESCRIPTION -
- arbitrary description text about the engine
+ arbitrary description text about the engine
+ (note that the character string may contain
+ escape sequences)
VERSION -
@@ -2527,7 +2529,8 @@
the file name of the loaded instrument, "NONE" if
there's no instrument yet loaded for this sampler
- channel
+ channel (note: since LSCP 1.2 this path may contain
+ escape sequences)
INSTRUMENT_NR -
@@ -2537,7 +2540,9 @@
INSTRUMENT_NAME -
- the instrument name of the loaded instrument
+ the instrument name of the loaded instrument
+ (note: since LSCP 1.2 this character string may contain
+ escape sequences)
INSTRUMENT_STATUS -
@@ -3447,7 +3452,9 @@
NAME -
- name of the effect send entity
+ name of the effect send entity
+ (note that this character string may contain
+ escape sequences)
MIDI_CONTROLLER -
@@ -4266,7 +4273,9 @@
NAME -
custom name of the given map,
- which does not have to be unique
+ which does not have to be unique
+ (note that this character string may contain
+ escape sequences)
DEFAULT -
@@ -4663,7 +4672,9 @@
name for this mapped instrument. It can be set and
changed with the
"MAP MIDI_INSTRUMENT"
- command and does not have to be unique.
+ command and does not have to be unique.
+ (note that this character string may contain
+ escape sequences)
"ENGINE_NAME" -
@@ -4674,7 +4685,9 @@
"INSTRUMENT_FILE" -
- File name of the instrument.
+ File name of the instrument
+ (note that this path may contain
+ escape sequences).
"INSTRUMENT_NR" -
@@ -4686,7 +4699,8 @@
Name of the loaded instrument as reflected by its file.
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
- cannot be changed.
+ cannot be changed (note that this character string may contain
+ escape sequences).
"LOAD_MODE" -
@@ -6824,10 +6838,13 @@
in the old versions a single backslash was sufficient.
The following LSCP commands support escape sequences as part
- of their filename / path based arguments:
+ of their filename / path based arguments and / or may contain
+ a filename / path with escape sequences in their response:
"LOAD INSTRUMENT"
+ "GET CHANNEL INFO"
"MAP MIDI_INSTRUMENT"
+ "GET MIDI_INSTRUMENT INFO"
"ADD DB_INSTRUMENT_DIRECTORY"
"ADD DB_INSTRUMENTS"
"REMOVE DB_INSTRUMENT_DIRECTORY"
@@ -6860,10 +6877,17 @@
The following LSCP commands even support escape sequences as
part of at least one of their text-based arguments (i.e. entity name,
- description):
+ description) and / or may contain escape sequences in at least one of
+ their text-based fields in their response:
+ "GET SERVER INFO"
+ "GET ENGINE INFO"
+ "GET CHANNEL INFO"
"CREATE FX_SEND"
+ "GET FX_SEND INFO"
"SET FX_SEND NAME"
+ "GET MIDI_INSTRUMENT INFO"
+ "GET MIDI_INSTRUMENT_MAP INFO"
"ADD MIDI_INSTRUMENT_MAP"
"MAP MIDI_INSTRUMENT"
"SET MIDI_INSTRUMENT_MAP NAME"