--- linuxsampler/trunk/Documentation/lscp.xml 2005/02/13 00:10:53 377
+++ linuxsampler/trunk/Documentation/lscp.xml 2005/04/06 19:24:39 494
@@ -216,6 +216,25 @@
<warning-message> and <error-message> are
human readable descriptions of the warning or error
respectively.
+ Examples:
+
+
+ C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0
+ S: "WRN:32:This is a 24 bit patch which is not supported natively yet."
+
+
+
+
+ C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"
+ S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter 'EAR'."
+
+
+
+
+ C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"
+ S: "ERR:9:There is no audio output device with index 123456."
+
+
Normal result sets could be:
@@ -234,6 +253,13 @@
"OK"
+ Example:
+
+
+ C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"
+ S: "OK"
+
+
Single line result sets are command specific. One
example of a single line result set is an empty line.
Multi-line result sets are command specific and may
@@ -244,6 +270,20 @@
"."
+ Example:
+
+
+ C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
+ S: "DRIVER: ALSA"
+ "CHANNELS: 2"
+ "SAMPLERATE: 44100"
+ "ACTIVE: true"
+ "FRAGMENTS: 2"
+ "FRAGMENTSIZE: 128"
+ "CARD: '0,0'"
+ "."
+
+
In addition to above mentioned formats, warnings and
empty result sets MAY be indexed. In this case, they
have the following formats respectively:
@@ -258,6 +298,19 @@
related to or other integer value.
Each line of the result set MUST end with
<CRLF>.
+ Examples:
+
+
+ C: "ADD CHANNEL"
+ S: "OK[12]"
+
+
+
+
+ C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"
+ S: "WRN[0]:32:Sample rate not supported, using 44100 instead."
+
+
@@ -542,7 +595,7 @@
LinuxSampler will answer by sending a
- &lz;CRLF> separated list.
+ <CRLF> separated list.
Each answer line begins with the information category name
followed by a colon and then a space character <SP> and
finally
@@ -647,7 +700,7 @@
- POSSIBILITES -
+ POSSIBILITIES -
comma separated list of possible values for this
parameter, character strings are encapsulated into
@@ -670,7 +723,7 @@
"FIX: true"
"MULTIPLICITY: false"
"DEFAULT: '0,0'"
- "POSSIBILITES: '0,0','1,0','2,0'"
+ "POSSIBILITIES: '0,0','1,0','2,0'"
"."
@@ -859,9 +912,9 @@
GET AUDIO_OUTPUT_DEVICE INFO <device-id>
- Where <device-id> should be replaced by be numerical ID
+ Where <device-id> should be replaced by numerical ID
of the audio output device as e.g. returned by the
- "GET AUDIO_OUTPUT_DEVICES" command.
+ "LIST AUDIO_OUTPUT_DEVICES" command.
Possible Answers:
LinuxSampler will answer by sending a <CRLF> separated list.
Each answer line begins with the information category name
@@ -1003,7 +1056,8 @@
MIX_CHANNEL_DESTINATION -
- reflects the real audio channel (of the same audio
+ numerical ID (positive integer including 0)
+ which reflects the real audio channel (of the same audio
output device) this mix channel refers to, means where
the audio signal actually will be routed / added to
(only returned in case the audio channel is mix channel)
@@ -1137,7 +1191,7 @@
parameter)
- POSSIBILITES -
+ POSSIBILITIES -
comma separated list of possible values for this
parameter, character strings are encapsulated into
@@ -1159,7 +1213,7 @@
"TYPE: STRING"
"FIX: false"
"MULTIPLICITY: true"
- "POSSIBILITES: 'PCM:0','PCM:1','ardour:0','ardour:1'"
+ "POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"
"."
@@ -1441,7 +1495,7 @@
- POSSIBILITES -
+ POSSIBILITIES -
comma separated list of possible values for this
parameter, character strings are encapsulated into
@@ -1670,7 +1724,7 @@
-
+
Use the following command to alter a specific setting of a created MIDI input device:
@@ -1707,7 +1761,7 @@
Example:
- C: "SET MIDI_INPUT_DEVICE PARAMETER 0 ACTIVE=false"
+ C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"
S: "OK"
@@ -1764,7 +1818,7 @@
Where <dev-id> is the numerical ID of the MIDI input device as returned
- by the "GET MIDI_INPUT_DEVICES" command, <port> the MIDI port number and
+ by the "LIST MIDI_INPUT_DEVICES" command, <port> the MIDI port number and
<param> a specific port parameter name for which information should be
obtained (as returned by the "GET MIDI_INPUT_PORT INFO" command).
@@ -1829,7 +1883,7 @@
parameter)
- POSSIBILITES -
+ POSSIBILITIES -
comma separated list of possible values for this
parameter, character strings are encapsulated into
@@ -1851,7 +1905,7 @@
"TYPE: STRING"
"FIX: false"
"MULTIPLICITY: true"
- "POSSIBILITES: '64:0','68:0','68:1'"
+ "POSSIBILITIES: '64:0','68:0','68:1'"
"."
@@ -1970,8 +2024,8 @@
- Where <engine-name> is usually the C++ class name of the engine
- implementation and <sampler-channel> the sampler channel the
+ Where <engine-name> is an engine name as obtained by the
+ "GET AVAILABLE_ENGINES" command and <sampler-channel> the sampler channel the
deployed engine should be assigned to. Even if the respective
sampler channel has already a deployed engine with that engine
name, a new engine instance will be assigned to the sampler channel.
@@ -2162,7 +2216,8 @@
LinuxSampler will answer by sending a comma separated character
- string of the engines' C++ class names.
+ string of the engines' names. Engine names can consist of lower and
+ upper cases, digits and underlines ("_" character).
Example:
@@ -2182,11 +2237,12 @@
GET ENGINE INFO <engine-name>
- Where <engine-name> is usually the C++ class name of the engine implementation.
+ Where <engine-name> is an engine name as obtained by the
+ "GET AVAILABLE_ENGINES" command.
Possible Answers:
- LinuxSampler will answer by sending <> separated list.
+ LinuxSampler will answer by sending a <CRLF> separated list.
Each answer line begins with the information category name
followed by a colon and then a space character <SP> and finally
the info character string to that info category. At the moment