31 |
<email>schoenebeck at software minus engineering dot org</email> |
<email>schoenebeck at software minus engineering dot org</email> |
32 |
</address> |
</address> |
33 |
</author> |
</author> |
34 |
<date month="June" year="2004"/> |
<date month="Apr" year="2005"/> |
35 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
36 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
37 |
<abstract> |
<abstract> |
216 |
<warning-message> and <error-message> are |
<warning-message> and <error-message> are |
217 |
human readable descriptions of the warning or error |
human readable descriptions of the warning or error |
218 |
respectively.</t> |
respectively.</t> |
219 |
|
<t>Examples:</t> |
220 |
|
<t> |
221 |
|
<list> |
222 |
|
<t>C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0</t> |
223 |
|
<t>S: "WRN:32:This is a 24 bit patch which is not supported natively yet."</t> |
224 |
|
</list> |
225 |
|
</t> |
226 |
|
<t> |
227 |
|
<list> |
228 |
|
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"</t> |
229 |
|
<t>S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter 'EAR'."</t> |
230 |
|
</list> |
231 |
|
</t> |
232 |
|
<t> |
233 |
|
<list> |
234 |
|
<t>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"</t> |
235 |
|
<t>S: "ERR:9:There is no audio output device with index 123456."</t> |
236 |
|
</list> |
237 |
|
</t> |
238 |
<t>Normal result sets could be:</t> |
<t>Normal result sets could be:</t> |
239 |
<t> |
<t> |
240 |
<list style="numbers"> |
<list style="numbers"> |
253 |
<t>"OK"</t> |
<t>"OK"</t> |
254 |
</list> |
</list> |
255 |
</t> |
</t> |
256 |
|
<t>Example:</t> |
257 |
|
<t> |
258 |
|
<list> |
259 |
|
<t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"</t> |
260 |
|
<t>S: "OK"</t> |
261 |
|
</list> |
262 |
|
</t> |
263 |
<t>Single line result sets are command specific. One |
<t>Single line result sets are command specific. One |
264 |
example of a single line result set is an empty line. |
example of a single line result set is an empty line. |
265 |
Multi-line result sets are command specific and may |
Multi-line result sets are command specific and may |
270 |
<t>"."</t> |
<t>"."</t> |
271 |
</list> |
</list> |
272 |
</t> |
</t> |
273 |
|
<t>Example:</t> |
274 |
|
<t> |
275 |
|
<list> |
276 |
|
<t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t> |
277 |
|
<t>S: "DRIVER: ALSA"</t> |
278 |
|
<t> "CHANNELS: 2"</t> |
279 |
|
<t> "SAMPLERATE: 44100"</t> |
280 |
|
<t> "ACTIVE: true"</t> |
281 |
|
<t> "FRAGMENTS: 2"</t> |
282 |
|
<t> "FRAGMENTSIZE: 128"</t> |
283 |
|
<t> "CARD: '0,0'"</t> |
284 |
|
<t> "."</t> |
285 |
|
</list> |
286 |
|
</t> |
287 |
<t>In addition to above mentioned formats, warnings and |
<t>In addition to above mentioned formats, warnings and |
288 |
empty result sets MAY be indexed. In this case, they |
empty result sets MAY be indexed. In this case, they |
289 |
have the following formats respectively:</t> |
have the following formats respectively:</t> |
298 |
related to or other integer value.</t> |
related to or other integer value.</t> |
299 |
<t>Each line of the result set MUST end with |
<t>Each line of the result set MUST end with |
300 |
<CRLF>.</t> |
<CRLF>.</t> |
301 |
|
<t>Examples:</t> |
302 |
|
<t> |
303 |
|
<list> |
304 |
|
<t>C: "ADD CHANNEL"</t> |
305 |
|
<t>S: "OK[12]"</t> |
306 |
|
</list> |
307 |
|
</t> |
308 |
|
<t> |
309 |
|
<list> |
310 |
|
<t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"</t> |
311 |
|
<t>S: "WRN[0]:32:Sample rate not supported, using 44100 instead."</t> |
312 |
|
</list> |
313 |
|
</t> |
314 |
</section> |
</section> |
315 |
</section> |
</section> |
316 |
<section title="Subscribe/notify communication method"> |
<section title="Subscribe/notify communication method"> |
595 |
<t> |
<t> |
596 |
<list> |
<list> |
597 |
<t>LinuxSampler will answer by sending a |
<t>LinuxSampler will answer by sending a |
598 |
&lz;CRLF> separated list. |
<CRLF> separated list. |
599 |
Each answer line begins with the information category name |
Each answer line begins with the information category name |
600 |
followed by a colon and then a space character <SP> and |
followed by a colon and then a space character <SP> and |
601 |
finally |
finally |
700 |
</list> |
</list> |
701 |
</t> |
</t> |
702 |
|
|
703 |
<t>POSSIBILITES - |
<t>POSSIBILITIES - |
704 |
<list> |
<list> |
705 |
<t>comma separated list of possible values for this |
<t>comma separated list of possible values for this |
706 |
parameter, character strings are encapsulated into |
parameter, character strings are encapsulated into |
723 |
<t> "FIX: true"</t> |
<t> "FIX: true"</t> |
724 |
<t> "MULTIPLICITY: false"</t> |
<t> "MULTIPLICITY: false"</t> |
725 |
<t> "DEFAULT: '0,0'"</t> |
<t> "DEFAULT: '0,0'"</t> |
726 |
<t> "POSSIBILITES: '0,0','1,0','2,0'"</t> |
<t> "POSSIBILITIES: '0,0','1,0','2,0'"</t> |
727 |
<t> "."</t> |
<t> "."</t> |
728 |
</list> |
</list> |
729 |
</t> |
</t> |
912 |
<t>GET AUDIO_OUTPUT_DEVICE INFO <device-id></t> |
<t>GET AUDIO_OUTPUT_DEVICE INFO <device-id></t> |
913 |
</list> |
</list> |
914 |
</t> |
</t> |
915 |
<t>Where <device-id> should be replaced by be numerical ID |
<t>Where <device-id> should be replaced by numerical ID |
916 |
of the audio output device as e.g. returned by the |
of the audio output device as e.g. returned by the |
917 |
"GET AUDIO_OUTPUT_DEVICES" command.</t> |
"LIST AUDIO_OUTPUT_DEVICES" command.</t> |
918 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
919 |
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
920 |
Each answer line begins with the information category name |
Each answer line begins with the information category name |
1056 |
</t> |
</t> |
1057 |
<t>MIX_CHANNEL_DESTINATION - |
<t>MIX_CHANNEL_DESTINATION - |
1058 |
<list> |
<list> |
1059 |
<t>reflects the real audio channel (of the same audio |
<t>numerical ID (positive integer including 0) |
1060 |
|
which reflects the real audio channel (of the same audio |
1061 |
output device) this mix channel refers to, means where |
output device) this mix channel refers to, means where |
1062 |
the audio signal actually will be routed / added to |
the audio signal actually will be routed / added to |
1063 |
(only returned in case the audio channel is mix channel)</t> |
(only returned in case the audio channel is mix channel)</t> |
1191 |
parameter)</t> |
parameter)</t> |
1192 |
</list> |
</list> |
1193 |
</t> |
</t> |
1194 |
<t>POSSIBILITES - |
<t>POSSIBILITIES - |
1195 |
<list> |
<list> |
1196 |
<t>comma separated list of possible values for this |
<t>comma separated list of possible values for this |
1197 |
parameter, character strings are encapsulated into |
parameter, character strings are encapsulated into |
1213 |
<t> "TYPE: STRING"</t> |
<t> "TYPE: STRING"</t> |
1214 |
<t> "FIX: false"</t> |
<t> "FIX: false"</t> |
1215 |
<t> "MULTIPLICITY: true"</t> |
<t> "MULTIPLICITY: true"</t> |
1216 |
<t> "POSSIBILITES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t> |
<t> "POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t> |
1217 |
<t> "."</t> |
<t> "."</t> |
1218 |
</list> |
</list> |
1219 |
</t> |
</t> |
1495 |
</list> |
</list> |
1496 |
</t> |
</t> |
1497 |
|
|
1498 |
<t>POSSIBILITES - |
<t>POSSIBILITIES - |
1499 |
<list> |
<list> |
1500 |
<t>comma separated list of possible values for this |
<t>comma separated list of possible values for this |
1501 |
parameter, character strings are encapsulated into |
parameter, character strings are encapsulated into |
1724 |
</t> |
</t> |
1725 |
</section> |
</section> |
1726 |
|
|
1727 |
<section title="Changing settings of audio output devices"> |
<section title="Changing settings of MIDI input devices"> |
1728 |
<t>Use the following command to alter a specific setting of a created MIDI input device:</t> |
<t>Use the following command to alter a specific setting of a created MIDI input device:</t> |
1729 |
<t> |
<t> |
1730 |
<list> |
<list> |
1761 |
<t>Example:</t> |
<t>Example:</t> |
1762 |
<t> |
<t> |
1763 |
<list> |
<list> |
1764 |
<t>C: "SET MIDI_INPUT_DEVICE PARAMETER 0 ACTIVE=false"</t> |
<t>C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"</t> |
1765 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
1766 |
</list> |
</list> |
1767 |
</t> |
</t> |
1818 |
</t> |
</t> |
1819 |
|
|
1820 |
<t>Where <dev-id> is the numerical ID of the MIDI input device as returned |
<t>Where <dev-id> is the numerical ID of the MIDI input device as returned |
1821 |
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 |
1822 |
<param> a specific port parameter name for which information should be |
<param> a specific port parameter name for which information should be |
1823 |
obtained (as returned by the "GET MIDI_INPUT_PORT INFO" command).</t> |
obtained (as returned by the "GET MIDI_INPUT_PORT INFO" command).</t> |
1824 |
|
|
1883 |
parameter)</t> |
parameter)</t> |
1884 |
</list> |
</list> |
1885 |
</t> |
</t> |
1886 |
<t>POSSIBILITES - |
<t>POSSIBILITIES - |
1887 |
<list> |
<list> |
1888 |
<t>comma separated list of possible values for this |
<t>comma separated list of possible values for this |
1889 |
parameter, character strings are encapsulated into |
parameter, character strings are encapsulated into |
1905 |
<t> "TYPE: STRING"</t> |
<t> "TYPE: STRING"</t> |
1906 |
<t> "FIX: false"</t> |
<t> "FIX: false"</t> |
1907 |
<t> "MULTIPLICITY: true"</t> |
<t> "MULTIPLICITY: true"</t> |
1908 |
<t> "POSSIBILITES: '64:0','68:0','68:1'"</t> |
<t> "POSSIBILITIES: '64:0','68:0','68:1'"</t> |
1909 |
<t> "."</t> |
<t> "."</t> |
1910 |
</list> |
</list> |
1911 |
</t> |
</t> |
2024 |
</list> |
</list> |
2025 |
</t> |
</t> |
2026 |
|
|
2027 |
<t>Where <engine-name> is usually the C++ class name of the engine |
<t>Where <engine-name> is an engine name as obtained by the |
2028 |
implementation and <sampler-channel> the sampler channel the |
"GET AVAILABLE_ENGINES" command and <sampler-channel> the sampler channel the |
2029 |
deployed engine should be assigned to. Even if the respective |
deployed engine should be assigned to. Even if the respective |
2030 |
sampler channel has already a deployed engine with that engine |
sampler channel has already a deployed engine with that engine |
2031 |
name, a new engine instance will be assigned to the sampler channel.</t> |
name, a new engine instance will be assigned to the sampler channel.</t> |
2216 |
<t> |
<t> |
2217 |
<list> |
<list> |
2218 |
<t>LinuxSampler will answer by sending a comma separated character |
<t>LinuxSampler will answer by sending a comma separated character |
2219 |
string of the engines' C++ class names.</t> |
string of the engines' names. Engine names can consist of lower and |
2220 |
|
upper cases, digits and underlines ("_" character).</t> |
2221 |
</list> |
</list> |
2222 |
</t> |
</t> |
2223 |
<t>Example:</t> |
<t>Example:</t> |
2237 |
<t>GET ENGINE INFO <engine-name></t> |
<t>GET ENGINE INFO <engine-name></t> |
2238 |
</list> |
</list> |
2239 |
</t> |
</t> |
2240 |
<t>Where <engine-name> is usually the C++ class name of the engine implementation.</t> |
<t>Where <engine-name> is an engine name as obtained by the |
2241 |
|
"GET AVAILABLE_ENGINES" command.</t> |
2242 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2243 |
<t> |
<t> |
2244 |
<list> |
<list> |
2245 |
<t>LinuxSampler will answer by sending <> separated list. |
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
2246 |
Each answer line begins with the information category name |
Each answer line begins with the information category name |
2247 |
followed by a colon and then a space character <SP> and finally |
followed by a colon and then a space character <SP> and finally |
2248 |
the info character string to that info category. At the moment |
the info character string to that info category. At the moment |
2342 |
<t>the instrument index number of the loaded instrument</t> |
<t>the instrument index number of the loaded instrument</t> |
2343 |
</list> |
</list> |
2344 |
</t> |
</t> |
2345 |
|
<t>INSTRUMENT_NAME - |
2346 |
|
<list> |
2347 |
|
<t>the instrument name of the loaded instrument</t> |
2348 |
|
</list> |
2349 |
|
</t> |
2350 |
<t>INSTRUMENT_STATUS - |
<t>INSTRUMENT_STATUS - |
2351 |
<list> |
<list> |
2352 |
<t>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative |
<t>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative |
2397 |
<t> "AUDIO_OUTPUT_ROUTING: 0,1"</t> |
<t> "AUDIO_OUTPUT_ROUTING: 0,1"</t> |
2398 |
<t> "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"</t> |
<t> "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"</t> |
2399 |
<t> "INSTRUMENT_NR: 0"</t> |
<t> "INSTRUMENT_NR: 0"</t> |
2400 |
|
<t> "INSTRUMENT_NAME: Fazioli Piano"</t> |
2401 |
<t> "INSTRUMENT_STATUS: 100"</t> |
<t> "INSTRUMENT_STATUS: 100"</t> |
2402 |
<t> "MIDI_INPUT_DEVICE: 0"</t> |
<t> "MIDI_INPUT_DEVICE: 0"</t> |
2403 |
<t> "MIDI_INPUT_PORT: 0"</t> |
<t> "MIDI_INPUT_PORT: 0"</t> |
2938 |
</t> |
</t> |
2939 |
</section> |
</section> |
2940 |
|
|
2941 |
<section title="Unregister front-end for not receiving UDP event messages anymore"> |
<section title="Unregister front-end for not receiving event messages"> |
2942 |
<t>The front-end can unregister itself if it doesn't want to receive event |
<t>The front-end can unregister itself if it doesn't want to receive event |
2943 |
messages anymore by sending the following command:</t> |
messages anymore by sending the following command:</t> |
2944 |
<t> |
<t> |