16 |
to an annoying "missing Normative/Informative References" error message --> |
to an annoying "missing Normative/Informative References" error message --> |
17 |
<?rfc strict="no" ?> |
<?rfc strict="no" ?> |
18 |
|
|
19 |
<rfc category="std" ipr="full3978" docName="LSCP 1.2"> |
<rfc category="std" ipr="full3978" docName="LSCP 1.6"> |
20 |
<front> |
<front> |
21 |
<title>LinuxSampler Control Protocol</title> |
<title>LinuxSampler Control Protocol</title> |
22 |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
23 |
Schoenebeck'> |
Schoenebeck'> |
24 |
<organization> |
<organization> |
25 |
Interessengemeinschaft Software Engineering e. V. |
LinuxSampler.org |
26 |
</organization> |
</organization> |
27 |
<address> |
<address> |
28 |
<postal> |
<postal> |
29 |
<street>Max-Planck-Str. 39</street> |
<street>Crudebyte Engineering</street> |
30 |
|
<street>Hofgartenstr. 3</street> |
31 |
<!-- <code>74081</code> --> |
<!-- <code>74081</code> --> |
32 |
<city>74081 Heilbronn</city> |
<city>74189 Weinsberg</city> |
33 |
<country>Germany</country> |
<country>Germany</country> |
34 |
</postal> |
</postal> |
35 |
<email>schoenebeck at software minus engineering dot org</email> |
<phone>+49 7134 911614</phone> |
36 |
|
<email>cuse@users.sf.net</email> |
37 |
</address> |
</address> |
38 |
</author> |
</author> |
39 |
<date month="March" year="2007"/> |
<date month="January" year="2014"/> |
40 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
41 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
42 |
<abstract> |
<abstract> |
63 |
(front-end) and server (LinuxSampler) respectively. Lines in |
(front-end) and server (LinuxSampler) respectively. Lines in |
64 |
examples must be interpreted as every line being CRLF |
examples must be interpreted as every line being CRLF |
65 |
terminated (carriage return character followed by line feed |
terminated (carriage return character followed by line feed |
66 |
character as defined in the ASCII standard), thus the following |
character as defined in the ASCII standard <xref target="RFC20"/>), |
67 |
example:</t> |
thus the following example:</t> |
68 |
|
|
69 |
<t> |
<t> |
70 |
<list> |
<list> |
2063 |
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
2064 |
command, <port> by the MIDI port number, <key> by the name of |
command, <port> by the MIDI port number, <key> by the name of |
2065 |
the parameter to change and <value> by the new value for this |
the parameter to change and <value> by the new value for this |
2066 |
parameter.</t> |
parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes) |
2067 |
|
for specifying no value for parameters allowing a list of values.</t> |
2068 |
|
|
2069 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2070 |
<t> |
<t> |
2091 |
<t>Example:</t> |
<t>Example:</t> |
2092 |
<t> |
<t> |
2093 |
<list> |
<list> |
2094 |
<t></t> |
<t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"</t> |
2095 |
|
<t>S: "OK"</t> |
2096 |
|
</list> |
2097 |
|
</t> |
2098 |
|
<t> |
2099 |
|
<list> |
2100 |
|
<t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"</t> |
2101 |
|
<t>S: "OK"</t> |
2102 |
</list> |
</list> |
2103 |
</t> |
</t> |
2104 |
</section> |
</section> |
2123 |
number of the sampler channel the instrument should be assigned to. |
number of the sampler channel the instrument should be assigned to. |
2124 |
Each sampler channel can only have one instrument.</t> |
Each sampler channel can only have one instrument.</t> |
2125 |
|
|
2126 |
|
<t>Notice: since LSCP 1.2 the <filename> argument supports |
2127 |
|
escape characters for special characters (see chapter |
2128 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>" |
2129 |
|
for details) and accordingly backslash characters in the filename |
2130 |
|
MUST now be escaped as well!</t> |
2131 |
|
|
2132 |
<t>The difference between regular and NON_MODAL versions of the command |
<t>The difference between regular and NON_MODAL versions of the command |
2133 |
is that the regular command returns OK only after the instrument has been |
is that the regular command returns OK only after the instrument has been |
2134 |
fully loaded and the channel is ready to be used while NON_MODAL version |
fully loaded and the channel is ready to be used while NON_MODAL version |
2164 |
</t> |
</t> |
2165 |
</list> |
</list> |
2166 |
</t> |
</t> |
2167 |
<t>Example:</t> |
<t>Example (Unix):</t> |
2168 |
<t> |
<t> |
2169 |
<list> |
<list> |
2170 |
<t></t> |
<t>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0</t> |
2171 |
|
<t>S: OK</t> |
2172 |
|
</list> |
2173 |
|
</t> |
2174 |
|
<t>Example (Windows):</t> |
2175 |
|
<t> |
2176 |
|
<list> |
2177 |
|
<t>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0</t> |
2178 |
|
<t>S: OK</t> |
2179 |
</list> |
</list> |
2180 |
</t> |
</t> |
2181 |
</section> |
</section> |
2424 |
<t> |
<t> |
2425 |
<list> |
<list> |
2426 |
<t>C: "LIST AVAILABLE_ENGINES"</t> |
<t>C: "LIST AVAILABLE_ENGINES"</t> |
2427 |
<t>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"</t> |
<t>S: "'gig','sfz','sf2'"</t> |
2428 |
</list> |
</list> |
2429 |
</t> |
</t> |
2430 |
</section> |
</section> |
2453 |
<list> |
<list> |
2454 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
2455 |
<list> |
<list> |
2456 |
<t>arbitrary description text about the engine</t> |
<t>arbitrary description text about the engine |
2457 |
|
(note that the character string may contain |
2458 |
|
<xref target="character_set">escape sequences</xref>)</t> |
2459 |
</list> |
</list> |
2460 |
</t> |
</t> |
2461 |
<t>VERSION - |
<t>VERSION - |
2470 |
|
|
2471 |
<t>The mentioned fields above don't have to be in particular order.</t> |
<t>The mentioned fields above don't have to be in particular order.</t> |
2472 |
|
|
2473 |
<t>Example:</t> |
<t>Examples:</t> |
2474 |
<t> |
<t> |
2475 |
<list> |
<list> |
2476 |
<t>C: "GET ENGINE INFO JoesCustomEngine"</t> |
<t>C: "GET ENGINE INFO gig"</t> |
2477 |
<t>S: "DESCRIPTION: this is Joe's custom sampler engine"</t> |
<t>S: "DESCRIPTION: GigaSampler Format Engine"</t> |
2478 |
<t> "VERSION: testing-1.0"</t> |
<t> "VERSION: 1.110"</t> |
2479 |
|
<t> "."</t> |
2480 |
|
<t>C: "GET ENGINE INFO sf2"</t> |
2481 |
|
<t>S: "DESCRIPTION: SoundFont Format Engine"</t> |
2482 |
|
<t> "VERSION: 1.4"</t> |
2483 |
|
<t> "."</t> |
2484 |
|
<t>C: "GET ENGINE INFO sfz"</t> |
2485 |
|
<t>S: "DESCRIPTION: SFZ Format Engine"</t> |
2486 |
|
<t> "VERSION: 1.11"</t> |
2487 |
<t> "."</t> |
<t> "."</t> |
2488 |
</list> |
</list> |
2489 |
</t> |
</t> |
2522 |
<list> |
<list> |
2523 |
<t>numerical ID of the audio output device which is |
<t>numerical ID of the audio output device which is |
2524 |
currently connected to this sampler channel to output |
currently connected to this sampler channel to output |
2525 |
the audio signal, "NONE" if there's no device |
the audio signal, "-1" if there's no device |
2526 |
connected to this sampler channel</t> |
connected to this sampler channel</t> |
2527 |
</list> |
</list> |
2528 |
</t> |
</t> |
2547 |
<list> |
<list> |
2548 |
<t>the file name of the loaded instrument, "NONE" if |
<t>the file name of the loaded instrument, "NONE" if |
2549 |
there's no instrument yet loaded for this sampler |
there's no instrument yet loaded for this sampler |
2550 |
channel</t> |
channel (note: since LSCP 1.2 this path may contain |
2551 |
|
<xref target="character_set">escape sequences</xref>)</t> |
2552 |
</list> |
</list> |
2553 |
</t> |
</t> |
2554 |
<t>INSTRUMENT_NR - |
<t>INSTRUMENT_NR - |
2555 |
<list> |
<list> |
2556 |
<t>the instrument index number of the loaded instrument</t> |
<t>the instrument index number of the loaded instrument, |
2557 |
|
"-1" if there's no instrument loaded for this sampler |
2558 |
|
channel</t> |
2559 |
</list> |
</list> |
2560 |
</t> |
</t> |
2561 |
<t>INSTRUMENT_NAME - |
<t>INSTRUMENT_NAME - |
2562 |
<list> |
<list> |
2563 |
<t>the instrument name of the loaded instrument</t> |
<t>the instrument name of the loaded instrument |
2564 |
|
(note: since LSCP 1.2 this character string may contain |
2565 |
|
<xref target="character_set">escape sequences</xref>)</t> |
2566 |
</list> |
</list> |
2567 |
</t> |
</t> |
2568 |
<t>INSTRUMENT_STATUS - |
<t>INSTRUMENT_STATUS - |
2569 |
<list> |
<list> |
2570 |
<t>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative |
<t>Integer values 0 to 100 indicating loading progress |
2571 |
value indicates a loading exception. Value of 100 indicates that the instrument is fully |
percentage for the instrument. Negative |
2572 |
|
value indicates a loading exception (also returns "-1" in case no |
2573 |
|
instrument was yet to be loaded on the sampler channel). |
2574 |
|
Value of 100 indicates that the instrument is fully |
2575 |
loaded.</t> |
loaded.</t> |
2576 |
</list> |
</list> |
2577 |
</t> |
</t> |
2578 |
<t>MIDI_INPUT_DEVICE - |
<t>MIDI_INPUT_DEVICE - |
2579 |
<list> |
<list> |
2580 |
|
<t>DEPRECATED: THIS FIELD WILL DISAPPEAR!</t> |
2581 |
<t>numerical ID of the MIDI input device which is |
<t>numerical ID of the MIDI input device which is |
2582 |
currently connected to this sampler channel to deliver |
currently connected to this sampler channel to deliver |
2583 |
MIDI input commands, "NONE" if there's no device |
MIDI input commands, "-1" if there's no device |
2584 |
connected to this sampler channel</t> |
connected to this sampler channel</t> |
2585 |
|
<t>Should not be used anymore as of LSCP v1.6 and younger. |
2586 |
|
This field is currently only preserved for backward compatibility. |
2587 |
|
</t> |
2588 |
|
<t>This field a relict from times where only one MIDI input per |
2589 |
|
sampler channel was allowed. Use <xref target="LIST CHANNEL MIDI_INPUTS">"GET CHANNEL MIDI_INPUTS"</xref> |
2590 |
|
instead.</t> |
2591 |
</list> |
</list> |
2592 |
</t> |
</t> |
2593 |
<t>MIDI_INPUT_PORT - |
<t>MIDI_INPUT_PORT - |
2594 |
<list> |
<list> |
2595 |
<t>port number of the MIDI input device</t> |
<t>DEPRECATED: THIS FIELD WILL DISAPPEAR!</t> |
2596 |
|
<t>port number of the MIDI input device (in case a |
2597 |
|
MIDI device was already assigned to the sampler |
2598 |
|
channel)</t> |
2599 |
|
<t>Should not be used anymore as of LSCP v1.6 and younger. |
2600 |
|
This field is currently only preserved for backward compatibility. |
2601 |
|
</t> |
2602 |
|
<t>This field a relict from times where only one MIDI input per |
2603 |
|
sampler channel was allowed. Use <xref target="LIST CHANNEL MIDI_INPUTS">"GET CHANNEL MIDI_INPUTS"</xref> |
2604 |
|
instead.</t> |
2605 |
</list> |
</list> |
2606 |
</t> |
</t> |
2607 |
<t>MIDI_INPUT_CHANNEL - |
<t>MIDI_INPUT_CHANNEL - |
2650 |
<t> |
<t> |
2651 |
<list> |
<list> |
2652 |
<t>C: "GET CHANNEL INFO 34"</t> |
<t>C: "GET CHANNEL INFO 34"</t> |
2653 |
<t>S: "ENGINE_NAME: GigEngine"</t> |
<t>S: "ENGINE_NAME: gig"</t> |
2654 |
<t> "VOLUME: 1.0"</t> |
<t> "VOLUME: 1.0"</t> |
2655 |
<t> "AUDIO_OUTPUT_DEVICE: 0"</t> |
<t> "AUDIO_OUTPUT_DEVICE: 0"</t> |
2656 |
<t> "AUDIO_OUTPUT_CHANNELS: 2"</t> |
<t> "AUDIO_OUTPUT_CHANNELS: 2"</t> |
2827 |
</section> |
</section> |
2828 |
|
|
2829 |
<section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYPE"> |
<section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYPE"> |
2830 |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR!</t> |
2831 |
|
|
2832 |
<t>The front-end can alter the audio output type on a specific sampler |
<t>The front-end can alter the audio output type on a specific sampler |
2833 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
2867 |
<t></t> |
<t></t> |
2868 |
</list> |
</list> |
2869 |
</t> |
</t> |
2870 |
|
<t>Deprecated:</t> |
2871 |
|
<t> |
2872 |
|
<list> |
2873 |
|
<t>Should not be used anymore. This command is currently only preserved for backward compatibility.</t> |
2874 |
|
<t>This command is a relict from times where there was no sophisticated driver management yet. Use <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> and <xref target="SET CHANNEL AUDIO_OUTPUT_DEVICE">"SET CHANNEL AUDIO_OUTPUT_DEVICE"</xref> instead.</t> |
2875 |
|
</list> |
2876 |
|
</t> |
2877 |
</section> |
</section> |
2878 |
|
|
2879 |
<section title="Setting audio output channel" anchor="SET CHANNEL AUDIO_OUTPUT_CHANNEL"> |
<section title="Setting audio output channel" anchor="SET CHANNEL AUDIO_OUTPUT_CHANNEL"> |
2921 |
</t> |
</t> |
2922 |
</section> |
</section> |
2923 |
|
|
2924 |
|
<section title="Add MIDI input to sampler channel" anchor="ADD CHANNEL MIDI_INPUT"> |
2925 |
|
<t>The front-end can add a MIDI input on a specific sampler |
2926 |
|
channel by sending the following command:</t> |
2927 |
|
<t> |
2928 |
|
<list> |
2929 |
|
<t>ADD CHANNEL MIDI_INPUT <sampler-channel> <midi-device-id> [<midi-input-port>]</t> |
2930 |
|
</list> |
2931 |
|
</t> |
2932 |
|
<t>Where <sampler-channel> is the sampler channel number |
2933 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2934 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command |
2935 |
|
and <midi-device-id> is the numerical ID of the MIDI input |
2936 |
|
device as returned by the |
2937 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
2938 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command, |
2939 |
|
and <midi-input-port> is an optional MIDI input port number of that |
2940 |
|
MIDI input device. If <midi-input-port> is omitted, |
2941 |
|
then the MIDI input device's first port (port number 0) is |
2942 |
|
used. |
2943 |
|
</t> |
2944 |
|
|
2945 |
|
<t>Possible Answers:</t> |
2946 |
|
<t> |
2947 |
|
<list> |
2948 |
|
<t>"OK" - |
2949 |
|
<list> |
2950 |
|
<t>on success</t> |
2951 |
|
</list> |
2952 |
|
</t> |
2953 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
2954 |
|
<list> |
2955 |
|
<t>if MIDI input port was connected, but there are noteworthy |
2956 |
|
issue(s) related, providing an appropriate warning code and |
2957 |
|
warning message</t> |
2958 |
|
</list> |
2959 |
|
</t> |
2960 |
|
<t>"ERR:<error-code>:<error-message>" - |
2961 |
|
<list> |
2962 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
2963 |
|
</list> |
2964 |
|
</t> |
2965 |
|
</list> |
2966 |
|
</t> |
2967 |
|
<t>Examples:</t> |
2968 |
|
<t> |
2969 |
|
<list> |
2970 |
|
<t>C: "ADD CHANNEL MIDI_INPUT 0 0"</t> |
2971 |
|
<t>S: "OK"</t> |
2972 |
|
<t>C: "ADD CHANNEL MIDI_INPUT 1 0"</t> |
2973 |
|
<t>S: "OK"</t> |
2974 |
|
<t>C: "ADD CHANNEL MIDI_INPUT 1 1 1"</t> |
2975 |
|
<t>S: "OK"</t> |
2976 |
|
<t>C: "ADD CHANNEL MIDI_INPUT 1 2 0"</t> |
2977 |
|
<t>S: "OK"</t> |
2978 |
|
</list> |
2979 |
|
</t> |
2980 |
|
<t>Since:</t> |
2981 |
|
<t> |
2982 |
|
<list> |
2983 |
|
<t>Introduced with LSCP v1.6</t> |
2984 |
|
</list> |
2985 |
|
</t> |
2986 |
|
</section> |
2987 |
|
|
2988 |
|
<section title="Remove MIDI input(s) from sampler channel" anchor="REMOVE CHANNEL MIDI_INPUT"> |
2989 |
|
<t>The front-end can remove one ore more MIDI input(s) on a |
2990 |
|
specific sampler channel by sending the following command:</t> |
2991 |
|
<t> |
2992 |
|
<list> |
2993 |
|
<t>REMOVE CHANNEL MIDI_INPUT <sampler-channel> [<midi-device-id> [<midi-input-port>]]</t> |
2994 |
|
</list> |
2995 |
|
</t> |
2996 |
|
<t>Where <sampler-channel> is the sampler channel number |
2997 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2998 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command |
2999 |
|
and <midi-device-id> and <midi-input-port> are |
3000 |
|
optional numerical IDs defining the MIDI input device and |
3001 |
|
one of its MIDI ports as returned by the |
3002 |
|
<xref target="LIST CHANNEL MIDI_INPUTS">"LIST CHANNEL MIDI_INPUTS"</xref> command. |
3003 |
|
</t> |
3004 |
|
|
3005 |
|
<t> |
3006 |
|
If <midi-input-port> is omitted, then all MIDI input |
3007 |
|
ports of <midi-device-id> are disconnected from this |
3008 |
|
sampler channel. |
3009 |
|
</t> |
3010 |
|
|
3011 |
|
<t> |
3012 |
|
If both, <midi-device-id> and <midi-input-port> |
3013 |
|
are omitted, then all MIDI input ports currently connected |
3014 |
|
to this sampler channel are disconnected from this sampler |
3015 |
|
channel. |
3016 |
|
</t> |
3017 |
|
|
3018 |
|
<t>Possible Answers:</t> |
3019 |
|
<t> |
3020 |
|
<list> |
3021 |
|
<t>"OK" - |
3022 |
|
<list> |
3023 |
|
<t>on success</t> |
3024 |
|
</list> |
3025 |
|
</t> |
3026 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3027 |
|
<list> |
3028 |
|
<t>if MIDI input porst were disconnected, but there are noteworthy |
3029 |
|
issue(s) related, providing an appropriate warning code and |
3030 |
|
warning message</t> |
3031 |
|
</list> |
3032 |
|
</t> |
3033 |
|
<t>"ERR:<error-code>:<error-message>" - |
3034 |
|
<list> |
3035 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3036 |
|
</list> |
3037 |
|
</t> |
3038 |
|
</list> |
3039 |
|
</t> |
3040 |
|
<t>Examples:</t> |
3041 |
|
<t> |
3042 |
|
<list> |
3043 |
|
<t>C: "REMOVE CHANNEL MIDI_INPUT 0"</t> |
3044 |
|
<t>S: "OK"</t> |
3045 |
|
<t>C: "REMOVE CHANNEL MIDI_INPUT 1"</t> |
3046 |
|
<t>S: "OK"</t> |
3047 |
|
<t>C: "REMOVE CHANNEL MIDI_INPUT 1 2 0"</t> |
3048 |
|
<t>S: "OK"</t> |
3049 |
|
</list> |
3050 |
|
</t> |
3051 |
|
<t>Since:</t> |
3052 |
|
<t> |
3053 |
|
<list> |
3054 |
|
<t>Introduced with LSCP v1.6</t> |
3055 |
|
</list> |
3056 |
|
</t> |
3057 |
|
</section> |
3058 |
|
|
3059 |
|
<section title="Getting all MIDI inputs of a sampler channel" anchor="LIST CHANNEL MIDI_INPUTS"> |
3060 |
|
<t>The front-end can query a list of all currently connected |
3061 |
|
MIDI inputs of a certain sampler channel by sending the following |
3062 |
|
command:</t> |
3063 |
|
<t> |
3064 |
|
<list> |
3065 |
|
<t>LIST CHANNEL MIDI_INPUTS <sampler-channel></t> |
3066 |
|
</list> |
3067 |
|
</t> |
3068 |
|
<t>Where <sampler-channel> is the sampler channel number |
3069 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3070 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command. |
3071 |
|
</t> |
3072 |
|
|
3073 |
|
<t>Possible Answers:</t> |
3074 |
|
<t> |
3075 |
|
<list> |
3076 |
|
<t>The sampler will answer by sending a comma separated |
3077 |
|
list of MIDI input device ID - MIDI input port number pairs, where |
3078 |
|
each pair is encapsulated into curly braces. The |
3079 |
|
list is returned in one single line. The MIDI input |
3080 |
|
device ID corresponds to the number returned by |
3081 |
|
<xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
3082 |
|
and the port number is the index of the respective MIDI |
3083 |
|
port of that MIDI input device.</t> |
3084 |
|
</list> |
3085 |
|
</t> |
3086 |
|
|
3087 |
|
<t>Example:</t> |
3088 |
|
<t> |
3089 |
|
<list> |
3090 |
|
<t>C: "LIST CHANNEL MIDI_INPUTS 0"</t> |
3091 |
|
<t>S: "{0,0},{1,3},{2,0}"</t> |
3092 |
|
</list> |
3093 |
|
</t> |
3094 |
|
|
3095 |
|
<t>Since:</t> |
3096 |
|
<t> |
3097 |
|
<list> |
3098 |
|
<t>Introduced with LSCP v1.6</t> |
3099 |
|
</list> |
3100 |
|
</t> |
3101 |
|
</section> |
3102 |
|
|
3103 |
<section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE"> |
<section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE"> |
3104 |
|
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR!</t> |
3105 |
|
|
3106 |
<t>The front-end can set the MIDI input device on a specific sampler |
<t>The front-end can set the MIDI input device on a specific sampler |
3107 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
3108 |
<t> |
<t> |
3117 |
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
3118 |
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command.</t> |
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command.</t> |
3119 |
|
|
3120 |
|
<t> |
3121 |
|
If more than 1 MIDI inputs are currently connected to this |
3122 |
|
sampler channel: Sending this command will disconnect ALL |
3123 |
|
currently connected MIDI input ports connected to this |
3124 |
|
sampler channel before establishing the new MIDI input |
3125 |
|
connection. So this command does NOT add the connection, |
3126 |
|
it replaces all existing ones instead. This behavior is due |
3127 |
|
to preserving full behavior backward compatibility. |
3128 |
|
</t> |
3129 |
|
|
3130 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
3131 |
<t> |
<t> |
3132 |
<list> |
<list> |
3155 |
<t></t> |
<t></t> |
3156 |
</list> |
</list> |
3157 |
</t> |
</t> |
3158 |
|
<t>Deprecated:</t> |
3159 |
|
<t> |
3160 |
|
<list> |
3161 |
|
<t>Should not be used anymore as of LSCP v1.6 and younger. This command is currently only preserved for backward compatibility.</t> |
3162 |
|
<t>This command is a relict from times where only one MIDI input per sampler channel was allowed. Use <xref target="ADD CHANNEL MIDI_INPUT">"ADD CHANNEL MIDI_INPUT"</xref> and <xref target="REMOVE CHANNEL MIDI_INPUT">"REMOVE CHANNEL MIDI_INPUT"</xref> instead.</t> |
3163 |
|
</list> |
3164 |
|
</t> |
3165 |
</section> |
</section> |
3166 |
|
|
3167 |
<section title="Setting MIDI input type" anchor="SET CHANNEL MIDI_INPUT_TYPE"> |
<section title="Setting MIDI input type" anchor="SET CHANNEL MIDI_INPUT_TYPE"> |
3168 |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR!</t> |
3169 |
|
|
3170 |
<t>The front-end can alter the MIDI input type on a specific sampler |
<t>The front-end can alter the MIDI input type on a specific sampler |
3171 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
3177 |
<t>Where <midi-input-type> is currently only "ALSA" and |
<t>Where <midi-input-type> is currently only "ALSA" and |
3178 |
<sampler-channel> is the respective sampler channel number.</t> |
<sampler-channel> is the respective sampler channel number.</t> |
3179 |
|
|
3180 |
|
<t> |
3181 |
|
If more than 1 MIDI inputs are currently connected to this |
3182 |
|
sampler channel: Sending this command will disconnect ALL |
3183 |
|
currently connected MIDI input ports connected to this |
3184 |
|
sampler channel before establishing the new MIDI input |
3185 |
|
connection. So this command does NOT add the connection, |
3186 |
|
it replaces all existing ones instead. This behavior is due |
3187 |
|
to preserving full behavior backward compatibility. |
3188 |
|
</t> |
3189 |
|
|
3190 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
3191 |
<t> |
<t> |
3192 |
<list> |
<list> |
3215 |
<t></t> |
<t></t> |
3216 |
</list> |
</list> |
3217 |
</t> |
</t> |
3218 |
|
<t>Deprecated:</t> |
3219 |
|
<t> |
3220 |
|
<list> |
3221 |
|
<t>Should not be used anymore. This command is currently only preserved for backward compatibility.</t> |
3222 |
|
<t>This command is a relict from times where only 1 MIDI input per sampler channels was allowed and where no sophisticated driver management existed yet. Use <xref target="ADD CHANNEL MIDI_INPUT">"ADD CHANNEL MIDI_INPUT"</xref> and <xref target="REMOVE CHANNEL MIDI_INPUT">"REMOVE CHANNEL MIDI_INPUT"</xref> instead.</t> |
3223 |
|
</list> |
3224 |
|
</t> |
3225 |
</section> |
</section> |
3226 |
|
|
3227 |
<section title="Setting MIDI input port" anchor="SET CHANNEL MIDI_INPUT_PORT"> |
<section title="Setting MIDI input port" anchor="SET CHANNEL MIDI_INPUT_PORT"> |
3228 |
|
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR!</t> |
3229 |
|
|
3230 |
<t>The front-end can alter the MIDI input port on a specific sampler |
<t>The front-end can alter the MIDI input port on a specific sampler |
3231 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
3232 |
<t> |
<t> |
3237 |
<t>Where <midi-input-port> is a MIDI input port number of the |
<t>Where <midi-input-port> is a MIDI input port number of the |
3238 |
MIDI input device connected to the sampler channel given by |
MIDI input device connected to the sampler channel given by |
3239 |
<sampler-channel>.</t> |
<sampler-channel>.</t> |
3240 |
|
|
3241 |
|
<t> |
3242 |
|
If more than 1 MIDI inputs are currently connected to this |
3243 |
|
sampler channel: Sending this command will switch the |
3244 |
|
connection of the first (and only the first) MIDI input port |
3245 |
|
currently being connected to this sampler channel, to |
3246 |
|
another port of the same MIDI input device. Or in other |
3247 |
|
words: the first MIDI input port currently connected to |
3248 |
|
this sampler channel will be disconnected, and the requested |
3249 |
|
other port of its MIDI input device will be connected to |
3250 |
|
this sampler channel instead. This behavior is due |
3251 |
|
to preserving full behavior backward compatibility. |
3252 |
|
</t> |
3253 |
|
|
3254 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
3255 |
<t> |
<t> |
3279 |
<t></t> |
<t></t> |
3280 |
</list> |
</list> |
3281 |
</t> |
</t> |
3282 |
|
<t>Deprecated:</t> |
3283 |
|
<t> |
3284 |
|
<list> |
3285 |
|
<t>Should not be used anymore. This command is currently only preserved for backward compatibility.</t> |
3286 |
|
<t>This command is a relict from times where only one MIDI input per sampler channel was allowed. Use <xref target="ADD CHANNEL MIDI_INPUT">"ADD CHANNEL MIDI_INPUT"</xref> and <xref target="REMOVE CHANNEL MIDI_INPUT">"REMOVE CHANNEL MIDI_INPUT"</xref> instead.</t> |
3287 |
|
</list> |
3288 |
|
</t> |
3289 |
</section> |
</section> |
3290 |
|
|
3291 |
<section title="Setting MIDI input channel" anchor="SET CHANNEL MIDI_INPUT_CHANNEL"> |
<section title="Setting MIDI input channel" anchor="SET CHANNEL MIDI_INPUT_CHANNEL"> |
3296 |
<t>SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan></t> |
<t>SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan></t> |
3297 |
</list> |
</list> |
3298 |
</t> |
</t> |
3299 |
<t>Where <midi-input-chan> is the number of the new MIDI input channel where |
<t>Where <midi-input-chan> is the number |
3300 |
<sampler-channel> should listen to or "ALL" to listen on all 16 MIDI |
of the new MIDI input channel (zero indexed!) where |
3301 |
|
<sampler-channel> should listen to, or "ALL" to listen on all 16 MIDI |
3302 |
channels.</t> |
channels.</t> |
3303 |
|
|
3304 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
3326 |
<t>Examples:</t> |
<t>Examples:</t> |
3327 |
<t> |
<t> |
3328 |
<list> |
<list> |
3329 |
<t></t> |
<t>C: "SET CHANNEL MIDI_INPUT_CHANNEL 0 0"</t> |
3330 |
|
<t>S: "OK"</t> |
3331 |
|
<t>C: "SET CHANNEL MIDI_INPUT_CHANNEL 1 ALL"</t> |
3332 |
|
<t>S: "OK"</t> |
3333 |
</list> |
</list> |
3334 |
</t> |
</t> |
3335 |
</section> |
</section> |
3547 |
sampler channel on which the effect send should be created on, <midi-ctrl> |
sampler channel on which the effect send should be created on, <midi-ctrl> |
3548 |
is a number between 0..127 defining the MIDI controller which can alter the |
is a number between 0..127 defining the MIDI controller which can alter the |
3549 |
effect send level and <name> is an optional argument defining a name |
effect send level and <name> is an optional argument defining a name |
3550 |
for the effect send entity. The name does not have to be unique.</t> |
for the effect send entity. The name does not have to be unique, but MUST be |
3551 |
|
encapsulated into apostrophes and supports escape sequences as described in chapter |
3552 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>".</t> |
3553 |
|
|
3554 |
<t>By default, that is as initial routing, the effect send's audio channels |
<t>By default, that is as initial routing, the effect send's audio channels |
3555 |
are automatically routed to the last audio channels of the sampler channel's |
are automatically routed to the last audio channels of the sampler channel's |
3739 |
<list> |
<list> |
3740 |
<t>NAME - |
<t>NAME - |
3741 |
<list> |
<list> |
3742 |
<t>name of the effect send entity</t> |
<t>name of the effect send entity |
3743 |
|
(note that this character string may contain |
3744 |
|
<xref target="character_set">escape sequences</xref>)</t> |
3745 |
</list> |
</list> |
3746 |
</t> |
</t> |
3747 |
<t>MIDI_CONTROLLER - |
<t>MIDI_CONTROLLER - |
3767 |
channel 1 is routed to the channel 3 of the audio |
channel 1 is routed to the channel 3 of the audio |
3768 |
output device (see |
output device (see |
3769 |
<xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref> |
<xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref> |
3770 |
for details)</t> |
for details), if an internal send |
3771 |
|
effect is assigned to the effect |
3772 |
|
send, then this setting defines the |
3773 |
|
audio channel routing to that |
3774 |
|
effect instance respectively</t> |
3775 |
|
</list> |
3776 |
|
</t> |
3777 |
|
<t>EFFECT - |
3778 |
|
<list> |
3779 |
|
<t>destination send effect chain ID |
3780 |
|
and destination effect chain |
3781 |
|
position, separated by comma in the |
3782 |
|
form "<effect-chain>,<chain-pos>" |
3783 |
|
or "NONE" if there is no send effect |
3784 |
|
assigned to the effect send</t> |
3785 |
</list> |
</list> |
3786 |
</t> |
</t> |
3787 |
</list> |
</list> |
3798 |
<t> "MIDI_CONTROLLER: 91"</t> |
<t> "MIDI_CONTROLLER: 91"</t> |
3799 |
<t> "LEVEL: 0.3"</t> |
<t> "LEVEL: 0.3"</t> |
3800 |
<t> "AUDIO_OUTPUT_ROUTING: 2,3"</t> |
<t> "AUDIO_OUTPUT_ROUTING: 2,3"</t> |
3801 |
|
<t> "EFFECT: NONE"</t> |
3802 |
|
<t> "."</t> |
3803 |
|
</list> |
3804 |
|
</t> |
3805 |
|
<t> |
3806 |
|
<list> |
3807 |
|
<t>C: "GET FX_SEND INFO 0 1"</t> |
3808 |
|
<t>S: "NAME: Delay Send (Internal)"</t> |
3809 |
|
<t> "MIDI_CONTROLLER: 93"</t> |
3810 |
|
<t> "LEVEL: 0.51"</t> |
3811 |
|
<t> "AUDIO_OUTPUT_ROUTING: 1,2"</t> |
3812 |
|
<t> "EFFECT: 2,0"</t> |
3813 |
<t> "."</t> |
<t> "."</t> |
3814 |
</list> |
</list> |
3815 |
</t> |
</t> |
3830 |
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3831 |
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
3832 |
<name> is the new name of the effect send entity, which |
<name> is the new name of the effect send entity, which |
3833 |
does not have to be unique.</t> |
does not have to be unique (name MUST be encapsulated into apostrophes |
3834 |
|
and supports escape sequences as described in chapter |
3835 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"). |
3836 |
|
</t> |
3837 |
|
|
3838 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
3839 |
<t> |
<t> |
3876 |
<audio-src> is the numerical ID of the effect send's audio channel |
<audio-src> is the numerical ID of the effect send's audio channel |
3877 |
which should be rerouted and <audio-dst> is the numerical ID of |
which should be rerouted and <audio-dst> is the numerical ID of |
3878 |
the audio channel of the selected audio output device where <audio-src> |
the audio channel of the selected audio output device where <audio-src> |
3879 |
should be routed to.</t> |
should be routed to. If an internal send effect is assigned |
3880 |
|
to the effect send, then this setting defines the audio |
3881 |
|
channel routing to that effect instance respectively.</t> |
3882 |
|
|
3883 |
<t>Note that effect sends can only route audio to the same audio output |
<t>Note that effect sends can only route audio to the same audio output |
3884 |
device as assigned to the effect send's sampler channel. Also note that an |
device as assigned to the effect send's sampler channel. Also note that an |
3921 |
</t> |
</t> |
3922 |
</section> |
</section> |
3923 |
|
|
3924 |
|
<section title="Assigning destination effect to an effect send" anchor="SET FX_SEND EFFECT"> |
3925 |
|
<t>The front-end can (re-)assign a destination effect to an |
3926 |
|
effect send by sending the following command:</t> |
3927 |
|
<t> |
3928 |
|
<list> |
3929 |
|
<t>SET FX_SEND EFFECT <sampler-chan> <fx-send-id> <effect-chain> <chain-pos></t> |
3930 |
|
</list> |
3931 |
|
</t> |
3932 |
|
<t>Where <sampler-chan> is the sampler channel number |
3933 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3934 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3935 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3936 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3937 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command, |
3938 |
|
<effect-chain> by the numerical ID of the destination |
3939 |
|
effect chain as returned by the |
3940 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
3941 |
|
or |
3942 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
3943 |
|
command and <chain-pos> reflects the exact effect |
3944 |
|
chain position in the effect chain which hosts the actual |
3945 |
|
destination effect.</t> |
3946 |
|
|
3947 |
|
<t>Possible Answers:</t> |
3948 |
|
<t> |
3949 |
|
<list> |
3950 |
|
<t>"OK" - |
3951 |
|
<list> |
3952 |
|
<t>on success</t> |
3953 |
|
</list> |
3954 |
|
</t> |
3955 |
|
<t>"ERR:<error-code>:<error-message>" - |
3956 |
|
<list> |
3957 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3958 |
|
</list> |
3959 |
|
</t> |
3960 |
|
</list> |
3961 |
|
</t> |
3962 |
|
<t>Example:</t> |
3963 |
|
<t> |
3964 |
|
<list> |
3965 |
|
<t>C: "SET FX_SEND EFFECT 0 0 2 5"</t> |
3966 |
|
<t>S: "OK"</t> |
3967 |
|
</list> |
3968 |
|
</t> |
3969 |
|
</section> |
3970 |
|
|
3971 |
|
<section title="Removing destination effect from an effect send" anchor="REMOVE FX_SEND EFFECT"> |
3972 |
|
<t>The front-end can (re-)assign a destination effect to an |
3973 |
|
effect send by sending the following command:</t> |
3974 |
|
<t> |
3975 |
|
<list> |
3976 |
|
<t>REMOVE FX_SEND EFFECT <sampler-chan> <fx-send-id></t> |
3977 |
|
</list> |
3978 |
|
</t> |
3979 |
|
<t>Where <sampler-chan> is the sampler channel number |
3980 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3981 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3982 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3983 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3984 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t> |
3985 |
|
|
3986 |
|
<t>After the destination effect has been removed from the |
3987 |
|
effect send, the audio signal of the effect send will be |
3988 |
|
routed directly to the audio output device, according to the |
3989 |
|
audio channel routing setting of the effect send. |
3990 |
|
</t> |
3991 |
|
|
3992 |
|
<t>Possible Answers:</t> |
3993 |
|
<t> |
3994 |
|
<list> |
3995 |
|
<t>"OK" - |
3996 |
|
<list> |
3997 |
|
<t>on success</t> |
3998 |
|
</list> |
3999 |
|
</t> |
4000 |
|
<t>"ERR:<error-code>:<error-message>" - |
4001 |
|
<list> |
4002 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
4003 |
|
</list> |
4004 |
|
</t> |
4005 |
|
</list> |
4006 |
|
</t> |
4007 |
|
<t>Example:</t> |
4008 |
|
<t> |
4009 |
|
<list> |
4010 |
|
<t>C: "REMOVE FX_SEND EFFECT 0 0"</t> |
4011 |
|
<t>S: "OK"</t> |
4012 |
|
</list> |
4013 |
|
</t> |
4014 |
|
</section> |
4015 |
|
|
4016 |
<section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER"> |
<section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER"> |
4017 |
<t>The front-end can alter the MIDI controller of an effect |
<t>The front-end can alter the MIDI controller of an effect |
4018 |
send entity by sending the following command:</t> |
send entity by sending the following command:</t> |
4110 |
</t> |
</t> |
4111 |
</section> |
</section> |
4112 |
|
|
4113 |
|
<section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA"> |
4114 |
|
<t>The front-end can send MIDI events to a specific sampler channel |
4115 |
|
by sending the following command:</t> |
4116 |
|
<t> |
4117 |
|
<list> |
4118 |
|
<t>SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2></t> |
4119 |
|
</list> |
4120 |
|
</t> |
4121 |
|
<t>Where <sampler-chan> is the sampler channel number |
4122 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
4123 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
4124 |
|
<arg1> and <arg2> arguments depend on the <midi-msg> argument, which |
4125 |
|
specifies the MIDI message type. Currently, the following MIDI messages are supported:</t> |
4126 |
|
<t> |
4127 |
|
<list> |
4128 |
|
<t>"NOTE_ON" - |
4129 |
|
<list> |
4130 |
|
<t>For turning on MIDI notes, where <arg1> |
4131 |
|
specifies the key number and <arg2> the velocity |
4132 |
|
as described in the MIDI specification.</t> |
4133 |
|
</list> |
4134 |
|
</t> |
4135 |
|
<t>"NOTE_OFF" - |
4136 |
|
<list> |
4137 |
|
<t>For turning a currently playing MIDI note off, where <arg1> |
4138 |
|
specifies the key number and <arg2> the velocity |
4139 |
|
as described in the MIDI specification.</t> |
4140 |
|
</list> |
4141 |
|
</t> |
4142 |
|
<t>"CC" - |
4143 |
|
<list> |
4144 |
|
<t>For changing a MIDI controller, where <arg1> |
4145 |
|
specifies the controller number and <arg2> the |
4146 |
|
new value of the controller as described in the Control |
4147 |
|
Change section of the MIDI specification.</t> |
4148 |
|
</list> |
4149 |
|
</t> |
4150 |
|
</list> |
4151 |
|
</t> |
4152 |
|
<t>CAUTION: This command is provided for implementations of virtual MIDI keyboards |
4153 |
|
and no realtime guarantee whatsoever will be made!</t> |
4154 |
|
<t>Possible Answers:</t> |
4155 |
|
<t> |
4156 |
|
<list> |
4157 |
|
<t>"OK" - |
4158 |
|
<list> |
4159 |
|
<t>on success</t> |
4160 |
|
</list> |
4161 |
|
</t> |
4162 |
|
<t>"ERR:<error-code>:<error-message>" - |
4163 |
|
<list> |
4164 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
4165 |
|
</list> |
4166 |
|
</t> |
4167 |
|
</list> |
4168 |
|
</t> |
4169 |
|
<t>Example:</t> |
4170 |
|
<t> |
4171 |
|
<list> |
4172 |
|
<t>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"</t> |
4173 |
|
<t>S: "OK"</t> |
4174 |
|
</list> |
4175 |
|
</t> |
4176 |
|
</section> |
4177 |
|
|
4178 |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
4179 |
<t>The front-end can reset a particular sampler channel by sending the following command:</t> |
<t>The front-end can reset a particular sampler channel by sending the following command:</t> |
4180 |
<t> |
<t> |
4396 |
</t> |
</t> |
4397 |
</section> |
</section> |
4398 |
|
|
4399 |
|
<section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT"> |
4400 |
|
<t>The front-end can ask for the current number of active disk streams on |
4401 |
|
the sampler by sending the following command:</t> |
4402 |
|
<t> |
4403 |
|
<list> |
4404 |
|
<t>GET TOTAL_STREAM_COUNT</t> |
4405 |
|
</list> |
4406 |
|
</t> |
4407 |
|
|
4408 |
|
<t>Possible Answers:</t> |
4409 |
|
<t> |
4410 |
|
<list> |
4411 |
|
<t>LinuxSampler will answer by returning the number of all active |
4412 |
|
disk streams on the sampler.</t> |
4413 |
|
</list> |
4414 |
|
</t> |
4415 |
|
</section> |
4416 |
|
|
4417 |
<section title="Reset sampler" anchor="RESET"> |
<section title="Reset sampler" anchor="RESET"> |
4418 |
<t>The front-end can reset the whole sampler by sending the following command:</t> |
<t>The front-end can reset the whole sampler by sending the following command:</t> |
4419 |
<t> |
<t> |
4461 |
<list> |
<list> |
4462 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
4463 |
<list> |
<list> |
4464 |
<t>arbitrary textual description about the sampler</t> |
<t>arbitrary textual description about the sampler |
4465 |
|
(note that the character string may contain |
4466 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4467 |
</list> |
</list> |
4468 |
</t> |
</t> |
4469 |
<t>VERSION - |
<t>VERSION - |
4477 |
complies with (see <xref target="LSCP versioning" /> for details)</t> |
complies with (see <xref target="LSCP versioning" /> for details)</t> |
4478 |
</list> |
</list> |
4479 |
</t> |
</t> |
4480 |
|
<t>INSTRUMENTS_DB_SUPPORT - |
4481 |
|
<list> |
4482 |
|
<t>either yes or no, specifies whether the |
4483 |
|
sampler is build with instruments database support.</t> |
4484 |
|
</list> |
4485 |
|
</t> |
4486 |
</list> |
</list> |
4487 |
</t> |
</t> |
4488 |
</list> |
</list> |
4489 |
</t> |
</t> |
4490 |
<t>The mentioned fields above don't have to be in particular order. |
<t>The mentioned fields above don't have to be in particular order. |
4491 |
Other fields might be added in future.</t> |
Other fields might be added in future.</t> |
4492 |
|
|
4493 |
|
<t>Example:</t> |
4494 |
|
<t> |
4495 |
|
<list> |
4496 |
|
<t>C: "GET SERVER INFO"</t> |
4497 |
|
<t>S: "DESCRIPTION: LinuxSampler - modular, streaming capable sampler"</t> |
4498 |
|
<t> "VERSION: 1.0.0.svn23"</t> |
4499 |
|
<t> "PROTOCOL_VERSION: 1.5"</t> |
4500 |
|
<t> "INSTRUMENTS_DB_SUPPORT: no"</t> |
4501 |
|
<t> "."</t> |
4502 |
|
</list> |
4503 |
|
</t> |
4504 |
</section> |
</section> |
4505 |
|
|
4506 |
<section title="Getting global volume attenuation" anchor="GET VOLUME"> |
<section title="Getting global volume attenuation" anchor="GET VOLUME"> |
4561 |
</list> |
</list> |
4562 |
</t> |
</t> |
4563 |
</section> |
</section> |
4564 |
|
|
4565 |
|
<section title="Getting global voice limit" anchor="GET VOICES"> |
4566 |
|
<t>The client can ask for the current global sampler-wide limit |
4567 |
|
for maximum voices by sending the following command:</t> |
4568 |
|
<t> |
4569 |
|
<list> |
4570 |
|
<t>GET VOICES</t> |
4571 |
|
</list> |
4572 |
|
</t> |
4573 |
|
<t>Possible Answers:</t> |
4574 |
|
<t> |
4575 |
|
<list> |
4576 |
|
<t>LinuxSampler will answer by returning the number for |
4577 |
|
the current limit of maximum voices.</t> |
4578 |
|
</list> |
4579 |
|
</t> |
4580 |
|
|
4581 |
|
<t>The voice limit setting defines how many voices should maximum |
4582 |
|
be processed by the sampler at the same time. If the user |
4583 |
|
triggers new notes which would exceed that voice limit, the |
4584 |
|
sampler engine will react by stealing old voices for those |
4585 |
|
newly triggered notes. Note that the amount of voices triggered |
4586 |
|
by a new note can be larger than one and is dependent to the |
4587 |
|
respective instrument and probably further criterias.</t> |
4588 |
|
</section> |
4589 |
|
|
4590 |
|
<section title="Setting global voice limit" anchor="SET VOICES"> |
4591 |
|
<t>The client can alter the current global sampler-wide limit |
4592 |
|
for maximum voices by sending the following command:</t> |
4593 |
|
<t> |
4594 |
|
<list> |
4595 |
|
<t>SET VOICES <max-voices></t> |
4596 |
|
</list> |
4597 |
|
</t> |
4598 |
|
<t>Where <max-voices> should be replaced by the integer |
4599 |
|
value, reflecting the new global amount limit of maximum voices. |
4600 |
|
This value has to be larger than 0.</t> |
4601 |
|
|
4602 |
|
<t>Possible Answers:</t> |
4603 |
|
<t> |
4604 |
|
<list> |
4605 |
|
<t>"OK" - |
4606 |
|
<list> |
4607 |
|
<t>on success</t> |
4608 |
|
</list> |
4609 |
|
</t> |
4610 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
4611 |
|
<list> |
4612 |
|
<t>if the voice limit was set, but there are noteworthy |
4613 |
|
issue(s) related, providing an appropriate warning code and |
4614 |
|
warning message</t> |
4615 |
|
</list> |
4616 |
|
</t> |
4617 |
|
<t>"ERR:<error-code>:<error-message>" - |
4618 |
|
<list> |
4619 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
4620 |
|
</list> |
4621 |
|
</t> |
4622 |
|
</list> |
4623 |
|
</t> |
4624 |
|
|
4625 |
|
<t>Note: the given value will be passed to all sampler engine instances. |
4626 |
|
The total amount of maximum voices on the running system might thus |
4627 |
|
be as big as the given value multiplied by the current amount of engine |
4628 |
|
instances.</t> |
4629 |
|
|
4630 |
|
<t>Caution: when adjusting the voice limit, you SHOULD also |
4631 |
|
adjust the disk stream limit respectively and vice versa.</t> |
4632 |
|
</section> |
4633 |
|
|
4634 |
|
<section title="Getting global disk stream limit" anchor="GET STREAMS"> |
4635 |
|
<t>The client can ask for the current global sampler-wide limit |
4636 |
|
for maximum disk streams by sending the following command:</t> |
4637 |
|
<t> |
4638 |
|
<list> |
4639 |
|
<t>GET STREAMS</t> |
4640 |
|
</list> |
4641 |
|
</t> |
4642 |
|
<t>Possible Answers:</t> |
4643 |
|
<t> |
4644 |
|
<list> |
4645 |
|
<t>LinuxSampler will answer by returning the number for |
4646 |
|
the current limit of maximum disk streams.</t> |
4647 |
|
</list> |
4648 |
|
</t> |
4649 |
|
|
4650 |
|
<t>The disk stream limit setting defines how many disk streams should |
4651 |
|
maximum be processed by a sampler engine at the same time. The |
4652 |
|
higher this value, the more memory (RAM) will be occupied, since |
4653 |
|
every disk streams allocates a certain buffer size for being able |
4654 |
|
to perform its streaming operations.</t> |
4655 |
|
</section> |
4656 |
|
|
4657 |
|
<section title="Setting global disk stream limit" anchor="SET STREAMS"> |
4658 |
|
<t>The client can alter the current global sampler-wide limit |
4659 |
|
for maximum disk streams by sending the following command:</t> |
4660 |
|
<t> |
4661 |
|
<list> |
4662 |
|
<t>SET STREAMS <max-streams></t> |
4663 |
|
</list> |
4664 |
|
</t> |
4665 |
|
<t>Where <max-streams> should be replaced by the integer |
4666 |
|
value, reflecting the new global amount limit of maximum disk streams. |
4667 |
|
This value has to be positive.</t> |
4668 |
|
|
4669 |
|
<t>Possible Answers:</t> |
4670 |
|
<t> |
4671 |
|
<list> |
4672 |
|
<t>"OK" - |
4673 |
|
<list> |
4674 |
|
<t>on success</t> |
4675 |
|
</list> |
4676 |
|
</t> |
4677 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
4678 |
|
<list> |
4679 |
|
<t>if the disk stream limit was set, but there are noteworthy |
4680 |
|
issue(s) related, providing an appropriate warning code and |
4681 |
|
warning message</t> |
4682 |
|
</list> |
4683 |
|
</t> |
4684 |
|
<t>"ERR:<error-code>:<error-message>" - |
4685 |
|
<list> |
4686 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
4687 |
|
</list> |
4688 |
|
</t> |
4689 |
|
</list> |
4690 |
|
</t> |
4691 |
|
|
4692 |
|
<t>Note: the given value will be passed to all sampler engine instances. |
4693 |
|
The total amount of maximum disk streams on the running system might |
4694 |
|
thus be as big as the given value multiplied by the current amount of |
4695 |
|
engine instances.</t> |
4696 |
|
|
4697 |
|
<t>Caution: when adjusting the disk stream limit, you SHOULD also |
4698 |
|
adjust the voice limit respectively and vice versa.</t> |
4699 |
|
</section> |
4700 |
|
|
4701 |
</section> |
</section> |
4702 |
|
|
4703 |
|
|
4728 |
cause the sampler to switch to the respective instrument as |
cause the sampler to switch to the respective instrument as |
4729 |
reflected by the current MIDI instrument map.</t> |
reflected by the current MIDI instrument map.</t> |
4730 |
|
|
4731 |
<section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT MAP"> |
<section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT_MAP"> |
4732 |
<t>The front-end can add a new MIDI instrument map by sending |
<t>The front-end can add a new MIDI instrument map by sending |
4733 |
the following command:</t> |
the following command:</t> |
4734 |
<t> |
<t> |
4738 |
</t> |
</t> |
4739 |
<t>Where <name> is an optional argument allowing to |
<t>Where <name> is an optional argument allowing to |
4740 |
assign a custom name to the new map. MIDI instrument Map |
assign a custom name to the new map. MIDI instrument Map |
4741 |
names do not have to be unique.</t> |
names do not have to be unique, but MUST be encapsulated |
4742 |
|
into apostrophes and support escape sequences as described |
4743 |
|
in chapter "<xref target="character_set">Character Set and Escape Sequences</xref>". |
4744 |
|
</t> |
4745 |
|
|
4746 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
4747 |
<t> |
<t> |
4912 |
<t>NAME - |
<t>NAME - |
4913 |
<list> |
<list> |
4914 |
<t>custom name of the given map, |
<t>custom name of the given map, |
4915 |
which does not have to be unique</t> |
which does not have to be unique |
4916 |
|
(note that this character string may contain |
4917 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4918 |
</list> |
</list> |
4919 |
</t> |
</t> |
4920 |
<t>DEFAULT - |
<t>DEFAULT - |
4950 |
</t> |
</t> |
4951 |
<t>Where <map> is the numerical ID of the map and |
<t>Where <map> is the numerical ID of the map and |
4952 |
<name> the new custom name of the map, which does not |
<name> the new custom name of the map, which does not |
4953 |
have to be unique.</t> |
have to be unique (name MUST be encapsulated into apostrophes |
4954 |
|
and supports escape sequences as described in chapter |
4955 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"). |
4956 |
|
</t> |
4957 |
|
|
4958 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
4959 |
<t> |
<t> |
5000 |
index, <engine_name> a sampler engine name as returned by |
index, <engine_name> a sampler engine name as returned by |
5001 |
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
5002 |
command (not encapsulated into apostrophes), <filename> the name |
command (not encapsulated into apostrophes), <filename> the name |
5003 |
of the instrument's file to be deployed (encapsulated into apostrophes), |
of the instrument's file to be deployed (encapsulated into apostrophes, |
5004 |
|
supporting escape sequences as described in chapter |
5005 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"), |
5006 |
<instrument_index> the index (integer value) of the instrument |
<instrument_index> the index (integer value) of the instrument |
5007 |
within the given file, <volume_value> reflects the master |
within the given file, <volume_value> reflects the master |
5008 |
volume of the instrument as optionally dotted number (where a |
volume of the instrument as optionally dotted number (where a |
5084 |
load modes of entries, the frontend should retrieve the actual |
load modes of entries, the frontend should retrieve the actual |
5085 |
mode by i.e. sending |
mode by i.e. sending |
5086 |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
5087 |
command(s). Finally the OPTIONAL <name> argument allows to |
command(s). Finally the OPTIONAL <name> argument allows to set a custom name |
5088 |
set a custom name (encapsulated into apostrophes) for the mapping |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
5089 |
entry, useful for frontends for displaying an appropriate name for |
"<xref target="character_set">Character Set and Escape Sequences</xref>") for the |
5090 |
|
mapping entry, useful for frontends for displaying an appropriate name for |
5091 |
mapped instruments (using |
mapped instruments (using |
5092 |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
5093 |
</t> |
</t> |
5153 |
</t> |
</t> |
5154 |
</section> |
</section> |
5155 |
|
|
5156 |
<section title="Getting ammount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS"> |
<section title="Getting amount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS"> |
5157 |
<t>The front-end can query the amount of currently existing |
<t>The front-end can query the amount of currently existing |
5158 |
entries in a MIDI instrument map by sending the following |
entries in a MIDI instrument map by sending the following |
5159 |
command:</t> |
command:</t> |
5311 |
name for this mapped instrument. It can be set and |
name for this mapped instrument. It can be set and |
5312 |
changed with the |
changed with the |
5313 |
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
5314 |
command and does not have to be unique.</t> |
command and does not have to be unique. |
5315 |
|
(note that this character string may contain |
5316 |
|
<xref target="character_set">escape sequences</xref>)</t> |
5317 |
</list> |
</list> |
5318 |
</t> |
</t> |
5319 |
<t>"ENGINE_NAME" - |
<t>"ENGINE_NAME" - |
5324 |
</t> |
</t> |
5325 |
<t>"INSTRUMENT_FILE" - |
<t>"INSTRUMENT_FILE" - |
5326 |
<list> |
<list> |
5327 |
<t>File name of the instrument.</t> |
<t>File name of the instrument |
5328 |
|
(note that this path may contain |
5329 |
|
<xref target="character_set">escape sequences</xref>).</t> |
5330 |
</list> |
</list> |
5331 |
</t> |
</t> |
5332 |
<t>"INSTRUMENT_NR" - |
<t>"INSTRUMENT_NR" - |
5338 |
<list> |
<list> |
5339 |
<t>Name of the loaded instrument as reflected by its file. |
<t>Name of the loaded instrument as reflected by its file. |
5340 |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
5341 |
cannot be changed.</t> |
cannot be changed (note that this character string may contain |
5342 |
|
<xref target="character_set">escape sequences</xref>).</t> |
5343 |
</list> |
</list> |
5344 |
</t> |
</t> |
5345 |
<t>"LOAD_MODE" - |
<t>"LOAD_MODE" - |
5423 |
</section> |
</section> |
5424 |
</section> |
</section> |
5425 |
|
|
|
</section> |
|
5426 |
|
|
5427 |
|
<section title="Managing Instruments Database" anchor="Managing Instruments Database"> |
5428 |
|
<t>The following commands describe how to use and manage |
5429 |
|
the instruments database.</t> |
5430 |
|
<t>Notice:</t> |
5431 |
|
<t> |
5432 |
|
<list> |
5433 |
|
<t>All command arguments representing a path or |
5434 |
|
instrument/directory name support escape sequences as described in chapter |
5435 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>". |
5436 |
|
</t> |
5437 |
|
<t>All occurrences of a forward slash in instrument and directory |
5438 |
|
names are escaped with its hex (\x2f) or octal (\057) escape sequence. |
5439 |
|
</t> |
5440 |
|
</list> |
5441 |
|
</t> |
5442 |
|
|
5443 |
|
<section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY"> |
5444 |
|
<t>The front-end can add a new instrument directory to the |
5445 |
|
instruments database by sending the following command:</t> |
5446 |
|
<t> |
5447 |
|
<list> |
5448 |
|
<t>ADD DB_INSTRUMENT_DIRECTORY <dir></t> |
5449 |
|
</list> |
5450 |
|
</t> |
5451 |
|
<t>Where <dir> is the absolute path name of the directory |
5452 |
|
to be created (encapsulated into apostrophes).</t> |
5453 |
|
|
5454 |
|
<t>Possible Answers:</t> |
5455 |
|
<t> |
5456 |
|
<list> |
5457 |
|
<t>"OK" - |
5458 |
|
<list> |
5459 |
|
<t>on success</t> |
5460 |
|
</list> |
5461 |
|
</t> |
5462 |
|
<t>"ERR:<error-code>:<error-message>" - |
5463 |
|
<list> |
5464 |
|
<t>when the directory could not be created, which |
5465 |
|
can happen if the directory already exists or the |
5466 |
|
name contains not allowed symbols</t> |
5467 |
|
</list> |
5468 |
|
</t> |
5469 |
|
</list> |
5470 |
|
</t> |
5471 |
|
|
5472 |
|
<t>Examples:</t> |
5473 |
|
<t> |
5474 |
|
<list> |
5475 |
|
<t>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"</t> |
5476 |
|
<t>S: "OK"</t> |
5477 |
|
</list> |
5478 |
|
</t> |
5479 |
|
</section> |
5480 |
|
|
5481 |
|
<section title="Deleting an instrument directory" anchor="REMOVE DB_INSTRUMENT_DIRECTORY"> |
5482 |
|
<t>The front-end can delete a particular instrument directory |
5483 |
|
from the instruments database by sending the following command:</t> |
5484 |
|
<t> |
5485 |
|
<list> |
5486 |
|
<t>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir></t> |
5487 |
|
</list> |
5488 |
|
</t> |
5489 |
|
<t>Where <dir> is the absolute path name of the directory |
5490 |
|
to delete. The optional FORCE argument can be used to |
5491 |
|
force the deletion of a non-empty directory and all its content.</t> |
5492 |
|
|
5493 |
|
<t>Possible Answers:</t> |
5494 |
|
<t> |
5495 |
|
<list> |
5496 |
|
<t>"OK" - |
5497 |
|
<list> |
5498 |
|
<t>if the directory is deleted successfully</t> |
5499 |
|
</list> |
5500 |
|
</t> |
5501 |
|
<t>"ERR:<error-code>:<error-message>" - |
5502 |
|
<list> |
5503 |
|
<t>if the given directory does not exist, or |
5504 |
|
if trying to delete a non-empty directory, |
5505 |
|
without using the FORCE argument.</t> |
5506 |
|
</list> |
5507 |
|
</t> |
5508 |
|
</list> |
5509 |
|
</t> |
5510 |
|
|
5511 |
|
<t>Examples:</t> |
5512 |
|
<t> |
5513 |
|
<list> |
5514 |
|
<t>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"</t> |
5515 |
|
<t>S: "OK"</t> |
5516 |
|
</list> |
5517 |
|
</t> |
5518 |
|
</section> |
5519 |
|
|
5520 |
|
<section title="Getting amount of instrument directories" anchor="GET DB_INSTRUMENT_DIRECTORIES"> |
5521 |
|
<t>The front-end can retrieve the current amount of |
5522 |
|
directories in a specific directory by sending the following command:</t> |
5523 |
|
<t> |
5524 |
|
<list> |
5525 |
|
<t>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir></t> |
5526 |
|
</list> |
5527 |
|
</t> |
5528 |
|
<t>Where <dir> should be replaced by the absolute path |
5529 |
|
name of the directory. If RECURSIVE is specified, the number of |
5530 |
|
all directories, including those located in subdirectories of the |
5531 |
|
specified directory, will be returned.</t> |
5532 |
|
|
5533 |
|
<t>Possible Answers:</t> |
5534 |
|
<t> |
5535 |
|
<list> |
5536 |
|
<t>The current number of instrument directories |
5537 |
|
in the specified directory.</t> |
5538 |
|
<t>"ERR:<error-code>:<error-message>" - |
5539 |
|
<list> |
5540 |
|
<t>if the given directory does not exist.</t> |
5541 |
|
</list> |
5542 |
|
</t> |
5543 |
|
</list> |
5544 |
|
</t> |
5545 |
|
|
5546 |
|
<t>Example:</t> |
5547 |
|
<t> |
5548 |
|
<list> |
5549 |
|
<t>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"</t> |
5550 |
|
<t>S: "2"</t> |
5551 |
|
</list> |
5552 |
|
</t> |
5553 |
|
</section> |
5554 |
|
|
5555 |
|
<section title="Listing all directories in specific directory" anchor="LIST DB_INSTRUMENT_DIRECTORIES"> |
5556 |
|
<t>The front-end can retrieve the current list of directories |
5557 |
|
in specific directory by sending the following command:</t> |
5558 |
|
<t> |
5559 |
|
<list> |
5560 |
|
<t>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir></t> |
5561 |
|
</list> |
5562 |
|
</t> |
5563 |
|
<t>Where <dir> should be replaced by the absolute path |
5564 |
|
name of the directory. If RECURSIVE is specified, the absolute path names |
5565 |
|
of all directories, including those located in subdirectories of the |
5566 |
|
specified directory, will be returned.</t> |
5567 |
|
|
5568 |
|
<t>Possible Answers:</t> |
5569 |
|
<t> |
5570 |
|
<list> |
5571 |
|
<t>A comma separated list of all instrument directories |
5572 |
|
(encapsulated into apostrophes) in the specified directory.</t> |
5573 |
|
<t>"ERR:<error-code>:<error-message>" - |
5574 |
|
<list> |
5575 |
|
<t>if the given directory does not exist.</t> |
5576 |
|
</list> |
5577 |
|
</t> |
5578 |
|
</list> |
5579 |
|
</t> |
5580 |
|
<t>Example:</t> |
5581 |
|
<t> |
5582 |
|
<list> |
5583 |
|
<t>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"</t> |
5584 |
|
<t>S: "'Piano Collection','Percussion Collection'"</t> |
5585 |
|
</list> |
5586 |
|
</t> |
5587 |
|
<t> |
5588 |
|
<list> |
5589 |
|
<t>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"</t> |
5590 |
|
<t>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"</t> |
5591 |
|
</list> |
5592 |
|
</t> |
5593 |
|
</section> |
5594 |
|
|
5595 |
|
<section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO"> |
5596 |
|
<t>The front-end can ask for the current settings of an |
5597 |
|
instrument directory by sending the following command:</t> |
5598 |
|
<t> |
5599 |
|
<list> |
5600 |
|
<t>GET DB_INSTRUMENT_DIRECTORY INFO <dir></t> |
5601 |
|
</list> |
5602 |
|
</t> |
5603 |
|
<t>Where <dir> should be replaced by the absolute path |
5604 |
|
name of the directory the front-end is interested in.</t> |
5605 |
|
|
5606 |
|
<t>Possible Answers:</t> |
5607 |
|
<t> |
5608 |
|
<list> |
5609 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
5610 |
|
Each answer line begins with the settings category name |
5611 |
|
followed by a colon and then a space character <SP> and finally |
5612 |
|
the info character string to that setting category. At the |
5613 |
|
moment the following categories are defined:</t> |
5614 |
|
|
5615 |
|
<t> |
5616 |
|
<list> |
5617 |
|
<t>DESCRIPTION - |
5618 |
|
<list> |
5619 |
|
<t>A brief description of the directory content. |
5620 |
|
Note that the character string may contain |
5621 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5622 |
|
</list> |
5623 |
|
</t> |
5624 |
|
<t>CREATED - |
5625 |
|
<list> |
5626 |
|
<t>The creation date and time of the directory, |
5627 |
|
represented in "YYYY-MM-DD HH:MM:SS" format</t> |
5628 |
|
</list> |
5629 |
|
</t> |
5630 |
|
<t>MODIFIED - |
5631 |
|
<list> |
5632 |
|
<t>The date and time of the last modification of the |
5633 |
|
directory, represented in "YYYY-MM-DD HH:MM:SS" format</t> |
5634 |
|
</list> |
5635 |
|
</t> |
5636 |
|
</list> |
5637 |
|
</t> |
5638 |
|
</list> |
5639 |
|
</t> |
5640 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
5641 |
|
|
5642 |
|
<t>Example:</t> |
5643 |
|
<t> |
5644 |
|
<list> |
5645 |
|
<t>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"</t> |
5646 |
|
<t>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."</t> |
5647 |
|
<t> "CREATED: 2007-02-05 10:23:12"</t> |
5648 |
|
<t> "MODIFIED: 2007-04-07 12:50:21"</t> |
5649 |
|
<t> "."</t> |
5650 |
|
</list> |
5651 |
|
</t> |
5652 |
|
</section> |
5653 |
|
|
5654 |
|
<section title="Renaming an instrument directory" anchor="SET DB_INSTRUMENT_DIRECTORY NAME"> |
5655 |
|
<t>The front-end can alter the name of a specific |
5656 |
|
instrument directory by sending the following command:</t> |
5657 |
|
<t> |
5658 |
|
<list> |
5659 |
|
<t>SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name></t> |
5660 |
|
</list> |
5661 |
|
</t> |
5662 |
|
<t>Where <dir> is the absolute path name of the directory and |
5663 |
|
<name> is the new name for that directory.</t> |
5664 |
|
|
5665 |
|
<t>Possible Answers:</t> |
5666 |
|
<t> |
5667 |
|
<list> |
5668 |
|
<t>"OK" - |
5669 |
|
<list> |
5670 |
|
<t>on success</t> |
5671 |
|
</list> |
5672 |
|
</t> |
5673 |
|
<t>"ERR:<error-code>:<error-message>" - |
5674 |
|
<list> |
5675 |
|
<t>in case the given directory does not exists, |
5676 |
|
or if a directory with name equal to the new |
5677 |
|
name already exists.</t> |
5678 |
|
</list> |
5679 |
|
</t> |
5680 |
|
</list> |
5681 |
|
</t> |
5682 |
|
|
5683 |
|
<t>Example:</t> |
5684 |
|
<t> |
5685 |
|
<list> |
5686 |
|
<t>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"</t> |
5687 |
|
<t>S: "OK"</t> |
5688 |
|
</list> |
5689 |
|
</t> |
5690 |
|
</section> |
5691 |
|
|
5692 |
|
<section title="Moving an instrument directory" anchor="MOVE DB_INSTRUMENT_DIRECTORY"> |
5693 |
|
<t>The front-end can move a specific |
5694 |
|
instrument directory by sending the following command:</t> |
5695 |
|
<t> |
5696 |
|
<list> |
5697 |
|
<t>MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst></t> |
5698 |
|
</list> |
5699 |
|
</t> |
5700 |
|
<t>Where <dir> is the absolute path name of the directory |
5701 |
|
to move and <dst> is the location where the directory will |
5702 |
|
be moved to.</t> |
5703 |
|
|
5704 |
|
<t>Possible Answers:</t> |
5705 |
|
<t> |
5706 |
|
<list> |
5707 |
|
<t>"OK" - |
5708 |
|
<list> |
5709 |
|
<t>on success</t> |
5710 |
|
</list> |
5711 |
|
</t> |
5712 |
|
<t>"ERR:<error-code>:<error-message>" - |
5713 |
|
<list> |
5714 |
|
<t>in case a given directory does not exists, |
5715 |
|
or if a directory with name equal to the name |
5716 |
|
of the specified directory already exists in |
5717 |
|
the destination directory. Error is also thrown |
5718 |
|
when trying to move a directory to a subdirectory |
5719 |
|
of itself.</t> |
5720 |
|
</list> |
5721 |
|
</t> |
5722 |
|
</list> |
5723 |
|
</t> |
5724 |
|
|
5725 |
|
<t>Example:</t> |
5726 |
|
<t> |
5727 |
|
<list> |
5728 |
|
<t>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"</t> |
5729 |
|
<t>S: "OK"</t> |
5730 |
|
</list> |
5731 |
|
</t> |
5732 |
|
</section> |
5733 |
|
|
5734 |
|
<section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY"> |
5735 |
|
<t>The front-end can copy a specific |
5736 |
|
instrument directory by sending the following command:</t> |
5737 |
|
<t> |
5738 |
|
<list> |
5739 |
|
<t>COPY DB_INSTRUMENT_DIRECTORY <dir> <dst></t> |
5740 |
|
</list> |
5741 |
|
</t> |
5742 |
|
<t>Where <dir> is the absolute path name of the directory |
5743 |
|
to copy and <dst> is the location where the directory will |
5744 |
|
be copied to.</t> |
5745 |
|
|
5746 |
|
<t>Possible Answers:</t> |
5747 |
|
<t> |
5748 |
|
<list> |
5749 |
|
<t>"OK" - |
5750 |
|
<list> |
5751 |
|
<t>on success</t> |
5752 |
|
</list> |
5753 |
|
</t> |
5754 |
|
<t>"ERR:<error-code>:<error-message>" - |
5755 |
|
<list> |
5756 |
|
<t>in case a given directory does not exists, |
5757 |
|
or if a directory with name equal to the name |
5758 |
|
of the specified directory already exists in |
5759 |
|
the destination directory. Error is also thrown |
5760 |
|
when trying to copy a directory to a subdirectory |
5761 |
|
of itself.</t> |
5762 |
|
</list> |
5763 |
|
</t> |
5764 |
|
</list> |
5765 |
|
</t> |
5766 |
|
|
5767 |
|
<t>Example:</t> |
5768 |
|
<t> |
5769 |
|
<list> |
5770 |
|
<t>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"</t> |
5771 |
|
<t>S: "OK"</t> |
5772 |
|
</list> |
5773 |
|
</t> |
5774 |
|
</section> |
5775 |
|
|
5776 |
|
<section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"> |
5777 |
|
<t>The front-end can alter the description of a specific |
5778 |
|
instrument directory by sending the following command:</t> |
5779 |
|
<t> |
5780 |
|
<list> |
5781 |
|
<t>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc></t> |
5782 |
|
</list> |
5783 |
|
</t> |
5784 |
|
<t>Where <dir> is the absolute path name of the directory and |
5785 |
|
<desc> is the new description for the directory |
5786 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
5787 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5788 |
|
|
5789 |
|
<t>Possible Answers:</t> |
5790 |
|
<t> |
5791 |
|
<list> |
5792 |
|
<t>"OK" - |
5793 |
|
<list> |
5794 |
|
<t>on success</t> |
5795 |
|
</list> |
5796 |
|
</t> |
5797 |
|
<t>"ERR:<error-code>:<error-message>" - |
5798 |
|
<list> |
5799 |
|
<t>in case the given directory does not exists.</t> |
5800 |
|
</list> |
5801 |
|
</t> |
5802 |
|
</list> |
5803 |
|
</t> |
5804 |
|
|
5805 |
|
<t>Example:</t> |
5806 |
|
<t> |
5807 |
|
<list> |
5808 |
|
<t>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"</t> |
5809 |
|
<t>S: "OK"</t> |
5810 |
|
</list> |
5811 |
|
</t> |
5812 |
|
</section> |
5813 |
|
|
5814 |
|
<section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES"> |
5815 |
|
<t>The front-end can search for directories |
5816 |
|
in specific directory by sending the following command:</t> |
5817 |
|
<t> |
5818 |
|
<list> |
5819 |
|
<t>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] <dir> <criteria-list></t> |
5820 |
|
</list> |
5821 |
|
</t> |
5822 |
|
<t>Where <dir> should be replaced by the absolute path |
5823 |
|
name of the directory to search in. If NON_RECURSIVE is specified, the |
5824 |
|
directories located in subdirectories of the specified directory will not |
5825 |
|
be searched. <criteria-list> is a list of search criterias |
5826 |
|
in form of "key1=val1 key2=val2 ...". The following criterias are |
5827 |
|
allowed:</t> |
5828 |
|
<t> |
5829 |
|
<t>NAME='<search-string>' |
5830 |
|
<list> |
5831 |
|
<t>Restricts the search to directories, which names |
5832 |
|
satisfy the supplied search string (encapsulated into apostrophes, |
5833 |
|
supporting escape sequences as described in chapter |
5834 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5835 |
|
</list> |
5836 |
|
</t> |
5837 |
|
|
5838 |
|
<t>CREATED='[<date-after>]..[<date-before>]' |
5839 |
|
<list> |
5840 |
|
<t>Restricts the search to directories, which creation |
5841 |
|
date satisfies the specified period, where <date-after> |
5842 |
|
and <date-before> are in "YYYY-MM-DD HH:MM:SS" format. |
5843 |
|
If <date-after> is omitted the search is restricted to |
5844 |
|
directories created before <date-before>. If |
5845 |
|
<date-before> is omitted, the search is restricted |
5846 |
|
to directories created after <date-after>.</t> |
5847 |
|
</list> |
5848 |
|
</t> |
5849 |
|
|
5850 |
|
<t>MODIFIED='[<date-after>]..[<date-before>]' |
5851 |
|
<list> |
5852 |
|
<t>Restricts the search to directories, which |
5853 |
|
date of last modification satisfies the specified period, where |
5854 |
|
<date-after> and <date-before> are in "YYYY-MM-DD HH:MM:SS" |
5855 |
|
format. If <date-after> is omitted the search is restricted to |
5856 |
|
directories, which are last modified before <date-before>. If |
5857 |
|
<date-before> is omitted, the search is restricted to directories, |
5858 |
|
which are last modified after <date-after>.</t> |
5859 |
|
</list> |
5860 |
|
</t> |
5861 |
|
|
5862 |
|
<t>DESCRIPTION='<search-string>' |
5863 |
|
<list> |
5864 |
|
<t>Restricts the search to directories with description |
5865 |
|
that satisfies the supplied search string |
5866 |
|
(encapsulated into apostrophes, supporting escape |
5867 |
|
sequences as described in chapter |
5868 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5869 |
|
</list> |
5870 |
|
</t> |
5871 |
|
</t> |
5872 |
|
|
5873 |
|
<t>Where <search-string> is either a regular expression, or a |
5874 |
|
word list separated with spaces for OR search and with '+' for AND search.</t> |
5875 |
|
|
5876 |
|
<t>Possible Answers:</t> |
5877 |
|
<t> |
5878 |
|
<list> |
5879 |
|
<t>A comma separated list with the absolute path names (encapsulated into |
5880 |
|
apostrophes) of all directories in the specified directory that satisfy |
5881 |
|
the supplied search criterias.</t> |
5882 |
|
<t>"ERR:<error-code>:<error-message>" - |
5883 |
|
<list> |
5884 |
|
<t>if the given directory does not exist.</t> |
5885 |
|
</list> |
5886 |
|
</t> |
5887 |
|
</list> |
5888 |
|
</t> |
5889 |
|
<t>Example:</t> |
5890 |
|
<t> |
5891 |
|
<list> |
5892 |
|
<t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"</t> |
5893 |
|
<t>S: "'/Piano Collection'"</t> |
5894 |
|
</list> |
5895 |
|
</t> |
5896 |
|
<t> |
5897 |
|
<list> |
5898 |
|
<t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"</t> |
5899 |
|
<t>S: "'/Piano Collection','/Percussions'"</t> |
5900 |
|
</list> |
5901 |
|
</t> |
5902 |
|
</section> |
5903 |
|
|
5904 |
|
<section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS"> |
5905 |
|
<t>The front-end can add one or more instruments |
5906 |
|
to the instruments database by sending the following command:</t> |
5907 |
|
<t> |
5908 |
|
<list> |
5909 |
|
<t>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>[ FILE_AS_DIR]] <db_dir> <file_path> [<instr_index>]</t> |
5910 |
|
</list> |
5911 |
|
</t> |
5912 |
|
<t>Where <db_dir> is the absolute path name of a directory |
5913 |
|
(encapsulated into apostrophes) in the instruments database in which |
5914 |
|
only the new instruments (that are not already in the database) will |
5915 |
|
be added, <file_path> is the absolute path name of a file or |
5916 |
|
directory in the file system (encapsulated into apostrophes). In case |
5917 |
|
an instrument file is supplied, only the instruments in the specified |
5918 |
|
file will be added to the instruments database. If the optional |
5919 |
|
<instr_index> (the index of the instrument within the given file) |
5920 |
|
is supplied too, then only the specified instrument will be added. |
5921 |
|
In case a directory is supplied, the instruments in that directory |
5922 |
|
will be added. The OPTIONAL <mode> argument is only applied |
5923 |
|
when a directory is provided as <file_path> and specifies how the |
5924 |
|
scanning will be done and has exactly the following possibilities:</t> |
5925 |
|
<t> |
5926 |
|
<list> |
5927 |
|
<t>"RECURSIVE" - |
5928 |
|
<list> |
5929 |
|
<t>All instruments will be processed, including those |
5930 |
|
in the subdirectories, and the respective subdirectory |
5931 |
|
tree structure will be recreated in the instruments |
5932 |
|
database</t> |
5933 |
|
</list> |
5934 |
|
</t> |
5935 |
|
<t>"NON_RECURSIVE" - |
5936 |
|
<list> |
5937 |
|
<t>Only the instruments in the specified directory |
5938 |
|
will be added, the instruments in the subdirectories |
5939 |
|
will not be processed.</t> |
5940 |
|
</list> |
5941 |
|
</t> |
5942 |
|
<t>"FLAT" - |
5943 |
|
<list> |
5944 |
|
<t>All instruments will be processed, including those |
5945 |
|
in the subdirectories, but the respective subdirectory |
5946 |
|
structure will not be recreated in the instruments |
5947 |
|
database. All instruments will be added directly in |
5948 |
|
the specified database directory.</t> |
5949 |
|
</list> |
5950 |
|
</t> |
5951 |
|
</list> |
5952 |
|
</t> |
5953 |
|
|
5954 |
|
<t> If FILE_AS_DIR argument is supplied, all instruments in an instrument |
5955 |
|
file will be added to a separate directory in the instruments database, which |
5956 |
|
name will be the name of the instrument file with the file extension stripped off. |
5957 |
|
</t> |
5958 |
|
<t>The difference between regular and NON_MODAL versions of the command |
5959 |
|
is that the regular command returns when the scanning is finished |
5960 |
|
while NON_MODAL version returns immediately and a background process is launched. |
5961 |
|
The <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref> |
5962 |
|
command can be used to monitor the scanning progress.</t> |
5963 |
|
|
5964 |
|
<t>Possible Answers:</t> |
5965 |
|
<t> |
5966 |
|
<list> |
5967 |
|
<t>"OK" - |
5968 |
|
<list> |
5969 |
|
<t>on success when NON_MODAL is not supplied</t> |
5970 |
|
</list> |
5971 |
|
</t> |
5972 |
|
<t>"OK[<job-id>]" - |
5973 |
|
<list> |
5974 |
|
<t>on success when NON_MODAL is supplied, where <job-id> |
5975 |
|
is a numerical ID used to obtain status information about the job progress. |
5976 |
|
See <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref> |
5977 |
|
</t> |
5978 |
|
</list> |
5979 |
|
</t> |
5980 |
|
<t>"ERR:<error-code>:<error-message>" - |
5981 |
|
<list> |
5982 |
|
<t>if an invalid path is specified.</t> |
5983 |
|
</list> |
5984 |
|
</t> |
5985 |
|
</list> |
5986 |
|
</t> |
5987 |
|
|
5988 |
|
<t>Examples:</t> |
5989 |
|
<t> |
5990 |
|
<list> |
5991 |
|
<t>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"</t> |
5992 |
|
<t>S: "OK"</t> |
5993 |
|
</list> |
5994 |
|
</t> |
5995 |
|
</section> |
5996 |
|
|
5997 |
|
<section title="Removing an instrument" anchor="REMOVE DB_INSTRUMENT"> |
5998 |
|
<t>The front-end can remove a particular instrument |
5999 |
|
from the instruments database by sending the following command:</t> |
6000 |
|
<t> |
6001 |
|
<list> |
6002 |
|
<t>REMOVE DB_INSTRUMENT <instr_path></t> |
6003 |
|
</list> |
6004 |
|
</t> |
6005 |
|
<t>Where <instr_path> is the absolute path name |
6006 |
|
(in the instruments database) of the instrument to remove.</t> |
6007 |
|
|
6008 |
|
<t>Possible Answers:</t> |
6009 |
|
<t> |
6010 |
|
<list> |
6011 |
|
<t>"OK" - |
6012 |
|
<list> |
6013 |
|
<t>if the instrument is removed successfully</t> |
6014 |
|
</list> |
6015 |
|
</t> |
6016 |
|
<t>"ERR:<error-code>:<error-message>" - |
6017 |
|
<list> |
6018 |
|
<t>if the given path does not exist or |
6019 |
|
is a directory.</t> |
6020 |
|
</list> |
6021 |
|
</t> |
6022 |
|
</list> |
6023 |
|
</t> |
6024 |
|
|
6025 |
|
<t>Examples:</t> |
6026 |
|
<t> |
6027 |
|
<list> |
6028 |
|
<t>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"</t> |
6029 |
|
<t>S: "OK"</t> |
6030 |
|
</list> |
6031 |
|
</t> |
6032 |
|
</section> |
6033 |
|
|
6034 |
|
<section title="Getting amount of instruments" anchor="GET DB_INSTRUMENTS"> |
6035 |
|
<t>The front-end can retrieve the current amount of |
6036 |
|
instruments in a specific directory by sending the following command:</t> |
6037 |
|
<t> |
6038 |
|
<list> |
6039 |
|
<t>GET DB_INSTRUMENTS [RECURSIVE] <dir></t> |
6040 |
|
</list> |
6041 |
|
</t> |
6042 |
|
<t>Where <dir> should be replaced by the absolute path name |
6043 |
|
of the directory. If RECURSIVE is specified, the number of all |
6044 |
|
instruments, including those located in subdirectories of the |
6045 |
|
specified directory, will be returned.</t> |
6046 |
|
|
6047 |
|
<t>Possible Answers:</t> |
6048 |
|
<t> |
6049 |
|
<list> |
6050 |
|
<t>The current number of instruments |
6051 |
|
in the specified directory.</t> |
6052 |
|
<t>"ERR:<error-code>:<error-message>" - |
6053 |
|
<list> |
6054 |
|
<t>if the given directory does not exist.</t> |
6055 |
|
</list> |
6056 |
|
</t> |
6057 |
|
</list> |
6058 |
|
</t> |
6059 |
|
|
6060 |
|
<t>Example:</t> |
6061 |
|
<t> |
6062 |
|
<list> |
6063 |
|
<t>C: "GET DB_INSTRUMENTS '/Piano Collection'"</t> |
6064 |
|
<t>S: "2"</t> |
6065 |
|
</list> |
6066 |
|
</t> |
6067 |
|
</section> |
6068 |
|
|
6069 |
|
<section title="Listing all instruments in specific directory" anchor="LIST DB_INSTRUMENTS"> |
6070 |
|
<t>The front-end can retrieve the current list of instruments |
6071 |
|
in specific directory by sending the following command:</t> |
6072 |
|
<t> |
6073 |
|
<list> |
6074 |
|
<t>LIST DB_INSTRUMENTS [RECURSIVE] <dir></t> |
6075 |
|
</list> |
6076 |
|
</t> |
6077 |
|
<t>Where <dir> should be replaced by the absolute path |
6078 |
|
name of the directory. If RECURSIVE is specified, the absolute path |
6079 |
|
names of all instruments, including those located in subdirectories |
6080 |
|
of the specified directory, will be returned.</t> |
6081 |
|
|
6082 |
|
<t>Possible Answers:</t> |
6083 |
|
<t> |
6084 |
|
<list> |
6085 |
|
<t>A comma separated list of all instruments |
6086 |
|
(encapsulated into apostrophes) in the specified directory.</t> |
6087 |
|
<t>"ERR:<error-code>:<error-message>" - |
6088 |
|
<list> |
6089 |
|
<t>if the given directory does not exist.</t> |
6090 |
|
</list> |
6091 |
|
</t> |
6092 |
|
</list> |
6093 |
|
</t> |
6094 |
|
<t>Example:</t> |
6095 |
|
<t> |
6096 |
|
<list> |
6097 |
|
<t>C: "LIST DB_INSTRUMENTS '/Piano Collection'"</t> |
6098 |
|
<t>S: "'Bosendorfer 290','Steinway D'"</t> |
6099 |
|
</list> |
6100 |
|
</t> |
6101 |
|
<t> |
6102 |
|
<list> |
6103 |
|
<t>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"</t> |
6104 |
|
<t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"</t> |
6105 |
|
</list> |
6106 |
|
</t> |
6107 |
|
</section> |
6108 |
|
|
6109 |
|
<section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO"> |
6110 |
|
<t>The front-end can ask for the current settings of an |
6111 |
|
instrument by sending the following command:</t> |
6112 |
|
<t> |
6113 |
|
<list> |
6114 |
|
<t>GET DB_INSTRUMENT INFO <instr_path></t> |
6115 |
|
</list> |
6116 |
|
</t> |
6117 |
|
<t>Where <instr_path> should be replaced by the absolute path |
6118 |
|
name of the instrument the front-end is interested in.</t> |
6119 |
|
|
6120 |
|
<t>Possible Answers:</t> |
6121 |
|
<t> |
6122 |
|
<list> |
6123 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
6124 |
|
Each answer line begins with the settings category name |
6125 |
|
followed by a colon and then a space character <SP> and finally |
6126 |
|
the info character string to that setting category. At the |
6127 |
|
moment the following categories are defined:</t> |
6128 |
|
|
6129 |
|
<t> |
6130 |
|
<list> |
6131 |
|
<t>INSTRUMENT_FILE - |
6132 |
|
<list> |
6133 |
|
<t>File name of the instrument. |
6134 |
|
Note that the character string may contain |
6135 |
|
<xref target="character_set">escape sequences</xref>.</t> |
6136 |
|
</list> |
6137 |
|
</t> |
6138 |
|
<t>INSTRUMENT_NR - |
6139 |
|
<list> |
6140 |
|
<t>Index of the instrument within the file.</t> |
6141 |
|
</list> |
6142 |
|
</t> |
6143 |
|
<t>FORMAT_FAMILY - |
6144 |
|
<list> |
6145 |
|
<t>The format family of the instrument.</t> |
6146 |
|
</list> |
6147 |
|
</t> |
6148 |
|
<t>FORMAT_VERSION - |
6149 |
|
<list> |
6150 |
|
<t>The format version of the instrument.</t> |
6151 |
|
</list> |
6152 |
|
</t> |
6153 |
|
<t>SIZE - |
6154 |
|
<list> |
6155 |
|
<t>The size of the instrument in bytes.</t> |
6156 |
|
</list> |
6157 |
|
</t> |
6158 |
|
<t>CREATED - |
6159 |
|
<list> |
6160 |
|
<t>The date and time when the instrument is added |
6161 |
|
in the instruments database, represented in |
6162 |
|
"YYYY-MM-DD HH:MM:SS" format</t> |
6163 |
|
</list> |
6164 |
|
</t> |
6165 |
|
<t>MODIFIED - |
6166 |
|
<list> |
6167 |
|
<t>The date and time of the last modification of the |
6168 |
|
instrument's database settings, represented in |
6169 |
|
"YYYY-MM-DD HH:MM:SS" format</t> |
6170 |
|
</list> |
6171 |
|
</t> |
6172 |
|
<t>DESCRIPTION - |
6173 |
|
<list> |
6174 |
|
<t>A brief description of the instrument. |
6175 |
|
Note that the character string may contain |
6176 |
|
<xref target="character_set">escape sequences</xref>.</t> |
6177 |
|
</list> |
6178 |
|
</t> |
6179 |
|
<t>IS_DRUM - |
6180 |
|
<list> |
6181 |
|
<t>either true or false, determines whether the |
6182 |
|
instrument is a drumkit or a chromatic instrument</t> |
6183 |
|
</list> |
6184 |
|
</t> |
6185 |
|
<t>PRODUCT - |
6186 |
|
<list> |
6187 |
|
<t>The product title of the instrument. |
6188 |
|
Note that the character string may contain |
6189 |
|
<xref target="character_set">escape sequences</xref>.</t> |
6190 |
|
</list> |
6191 |
|
</t> |
6192 |
|
<t>ARTISTS - |
6193 |
|
<list> |
6194 |
|
<t>Lists the artist names. |
6195 |
|
Note that the character string may contain |
6196 |
|
<xref target="character_set">escape sequences</xref>.</t> |
6197 |
|
</list> |
6198 |
|
</t> |
6199 |
|
<t>KEYWORDS - |
6200 |
|
<list> |
6201 |
|
<t>Provides a list of keywords that refer to the instrument. |
6202 |
|
Keywords are separated with semicolon and blank. |
6203 |
|
Note that the character string may contain |
6204 |
|
<xref target="character_set">escape sequences</xref>.</t> |
6205 |
|
</list> |
6206 |
|
</t> |
6207 |
|
</list> |
6208 |
|
</t> |
6209 |
|
</list> |
6210 |
|
</t> |
6211 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
6212 |
|
|
6213 |
|
<t>Example:</t> |
6214 |
|
<t> |
6215 |
|
<list> |
6216 |
|
<t>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"</t> |
6217 |
|
<t>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"</t> |
6218 |
|
<t> "INSTRUMENT_NR: 0"</t> |
6219 |
|
<t> "FORMAT_FAMILY: GIG"</t> |
6220 |
|
<t> "FORMAT_VERSION: 2"</t> |
6221 |
|
<t> "SIZE: 2050871870"</t> |
6222 |
|
<t> "CREATED: 2007-02-05 10:23:12"</t> |
6223 |
|
<t> "MODIFIED: 2007-04-07 12:50:21"</t> |
6224 |
|
<t> "DESCRIPTION: "</t> |
6225 |
|
<t> "IS_DRUM: false"</t> |
6226 |
|
<t> "PRODUCT: GRANDIOSO Bosendorfer 290"</t> |
6227 |
|
<t> "ARTISTS: Post Musical Instruments"</t> |
6228 |
|
<t> "KEYWORDS: Bosendorfer"</t> |
6229 |
|
<t> "."</t> |
6230 |
|
</list> |
6231 |
|
</t> |
6232 |
|
</section> |
6233 |
|
|
6234 |
|
<section title="Renaming an instrument" anchor="SET DB_INSTRUMENT NAME"> |
6235 |
|
<t>The front-end can alter the name of a specific |
6236 |
|
instrument by sending the following command:</t> |
6237 |
|
<t> |
6238 |
|
<list> |
6239 |
|
<t>SET DB_INSTRUMENT NAME <instr> <name></t> |
6240 |
|
</list> |
6241 |
|
</t> |
6242 |
|
<t>Where <instr> is the absolute path name of the instrument and |
6243 |
|
<name> is the new name for that instrument.</t> |
6244 |
|
|
6245 |
|
<t>Possible Answers:</t> |
6246 |
|
<t> |
6247 |
|
<list> |
6248 |
|
<t>"OK" - |
6249 |
|
<list> |
6250 |
|
<t>on success</t> |
6251 |
|
</list> |
6252 |
|
</t> |
6253 |
|
<t>"ERR:<error-code>:<error-message>" - |
6254 |
|
<list> |
6255 |
|
<t>in case the given instrument does not exists, |
6256 |
|
or if an instrument with name equal to the new |
6257 |
|
name already exists.</t> |
6258 |
|
</list> |
6259 |
|
</t> |
6260 |
|
</list> |
6261 |
|
</t> |
6262 |
|
|
6263 |
|
<t>Example:</t> |
6264 |
|
<t> |
6265 |
|
<list> |
6266 |
|
<t>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"</t> |
6267 |
|
<t>S: "OK"</t> |
6268 |
|
</list> |
6269 |
|
</t> |
6270 |
|
</section> |
6271 |
|
|
6272 |
|
<section title="Moving an instrument" anchor="MOVE DB_INSTRUMENT"> |
6273 |
|
<t>The front-end can move a specific instrument to another directory by |
6274 |
|
sending the following command:</t> |
6275 |
|
<t> |
6276 |
|
<list> |
6277 |
|
<t>MOVE DB_INSTRUMENT <instr> <dst></t> |
6278 |
|
</list> |
6279 |
|
</t> |
6280 |
|
<t>Where <instr> is the absolute path name of the instrument |
6281 |
|
to move and <dst> is the directory where the instrument will |
6282 |
|
be moved to.</t> |
6283 |
|
|
6284 |
|
<t>Possible Answers:</t> |
6285 |
|
<t> |
6286 |
|
<list> |
6287 |
|
<t>"OK" - |
6288 |
|
<list> |
6289 |
|
<t>on success</t> |
6290 |
|
</list> |
6291 |
|
</t> |
6292 |
|
<t>"ERR:<error-code>:<error-message>" - |
6293 |
|
<list> |
6294 |
|
<t>in case the given instrument does not exists, |
6295 |
|
or if an instrument with name equal to the name of the |
6296 |
|
specified instrument already exists in the destination |
6297 |
|
directory.</t> |
6298 |
|
</list> |
6299 |
|
</t> |
6300 |
|
</list> |
6301 |
|
</t> |
6302 |
|
|
6303 |
|
<t>Example:</t> |
6304 |
|
<t> |
6305 |
|
<list> |
6306 |
|
<t>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"</t> |
6307 |
|
<t>S: "OK"</t> |
6308 |
|
</list> |
6309 |
|
</t> |
6310 |
|
</section> |
6311 |
|
|
6312 |
|
<section title="Copying instruments" anchor="COPY DB_INSTRUMENT"> |
6313 |
|
<t>The front-end can copy a specific instrument to another directory by |
6314 |
|
sending the following command:</t> |
6315 |
|
<t> |
6316 |
|
<list> |
6317 |
|
<t>COPY DB_INSTRUMENT <instr> <dst></t> |
6318 |
|
</list> |
6319 |
|
</t> |
6320 |
|
<t>Where <instr> is the absolute path name of the instrument |
6321 |
|
to copy and <dst> is the directory where the instrument will |
6322 |
|
be copied to.</t> |
6323 |
|
|
6324 |
|
<t>Possible Answers:</t> |
6325 |
|
<t> |
6326 |
|
<list> |
6327 |
|
<t>"OK" - |
6328 |
|
<list> |
6329 |
|
<t>on success</t> |
6330 |
|
</list> |
6331 |
|
</t> |
6332 |
|
<t>"ERR:<error-code>:<error-message>" - |
6333 |
|
<list> |
6334 |
|
<t>in case the given instrument does not exists, |
6335 |
|
or if an instrument with name equal to the name of the |
6336 |
|
specified instrument already exists in the destination |
6337 |
|
directory.</t> |
6338 |
|
</list> |
6339 |
|
</t> |
6340 |
|
</list> |
6341 |
|
</t> |
6342 |
|
|
6343 |
|
<t>Example:</t> |
6344 |
|
<t> |
6345 |
|
<list> |
6346 |
|
<t>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"</t> |
6347 |
|
<t>S: "OK"</t> |
6348 |
|
</list> |
6349 |
|
</t> |
6350 |
|
</section> |
6351 |
|
|
6352 |
|
<section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION"> |
6353 |
|
<t>The front-end can alter the description of a specific |
6354 |
|
instrument by sending the following command:</t> |
6355 |
|
<t> |
6356 |
|
<list> |
6357 |
|
<t>SET DB_INSTRUMENT DESCRIPTION <instr> <desc></t> |
6358 |
|
</list> |
6359 |
|
</t> |
6360 |
|
<t>Where <instr> is the absolute path name of the instrument and |
6361 |
|
<desc> is the new description for the instrument |
6362 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
6363 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6364 |
|
|
6365 |
|
<t>Possible Answers:</t> |
6366 |
|
<t> |
6367 |
|
<list> |
6368 |
|
<t>"OK" - |
6369 |
|
<list> |
6370 |
|
<t>on success</t> |
6371 |
|
</list> |
6372 |
|
</t> |
6373 |
|
<t>"ERR:<error-code>:<error-message>" - |
6374 |
|
<list> |
6375 |
|
<t>in case the given instrument does not exists.</t> |
6376 |
|
</list> |
6377 |
|
</t> |
6378 |
|
</list> |
6379 |
|
</t> |
6380 |
|
|
6381 |
|
<t>Example:</t> |
6382 |
|
<t> |
6383 |
|
<list> |
6384 |
|
<t>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"</t> |
6385 |
|
<t>S: "OK"</t> |
6386 |
|
</list> |
6387 |
|
</t> |
6388 |
|
</section> |
6389 |
|
|
6390 |
|
<section title="Finding instruments" anchor="FIND DB_INSTRUMENTS"> |
6391 |
|
<t>The front-end can search for instruments |
6392 |
|
in specific directory by sending the following command:</t> |
6393 |
|
<t> |
6394 |
|
<list> |
6395 |
|
<t>FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list></t> |
6396 |
|
</list> |
6397 |
|
</t> |
6398 |
|
<t>Where <dir> should be replaced by the absolute path |
6399 |
|
name of the directory to search in. If NON_RECURSIVE is specified, the |
6400 |
|
directories located in subdirectories of the specified directory will not |
6401 |
|
be searched. <criteria-list> is a list of search criterias |
6402 |
|
in form of "key1=val1 key2=val2 ...". The following criterias are |
6403 |
|
allowed:</t> |
6404 |
|
<t> |
6405 |
|
<t>NAME='<search-string>' |
6406 |
|
<list> |
6407 |
|
<t>Restricts the search to instruments, which names |
6408 |
|
satisfy the supplied search string (encapsulated into apostrophes, |
6409 |
|
supporting escape sequences as described in chapter |
6410 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6411 |
|
</list> |
6412 |
|
</t> |
6413 |
|
|
6414 |
|
<t>SIZE=[<min>]..[<max>] |
6415 |
|
<list> |
6416 |
|
<t>Restricts the search to instruments, which |
6417 |
|
size is in the specified range. If <min> is omitted, |
6418 |
|
the search results are restricted to instruments with size less then |
6419 |
|
or equal to <max>. If <max> is omitted, the |
6420 |
|
search is restricted to instruments with size greater then |
6421 |
|
or equal to <min>.</t> |
6422 |
|
</list> |
6423 |
|
</t> |
6424 |
|
|
6425 |
|
<t>CREATED='[<date-after>]..[<date-before>]' |
6426 |
|
<list> |
6427 |
|
<t>Restricts the search to instruments, which creation |
6428 |
|
date satisfies the specified period, where <date-after> |
6429 |
|
and <date-before> are in "YYYY-MM-DD HH:MM:SS" format. |
6430 |
|
If <date-after> is omitted the search is restricted to |
6431 |
|
instruments created before <date-before>. If |
6432 |
|
<date-before> is omitted, the search is restricted |
6433 |
|
to instruments created after <date-after>.</t> |
6434 |
|
</list> |
6435 |
|
</t> |
6436 |
|
|
6437 |
|
<t>MODIFIED='[<date-after>]..[<date-before>]' |
6438 |
|
<list> |
6439 |
|
<t>Restricts the search to instruments, which |
6440 |
|
date of last modification satisfies the specified period, where |
6441 |
|
<date-after> and <date-before> are in "YYYY-MM-DD HH:MM:SS" |
6442 |
|
format. If <date-after> is omitted the search is restricted to |
6443 |
|
instruments, which are last modified before <date-before>. If |
6444 |
|
<date-before> is omitted, the search is restricted to instruments, |
6445 |
|
which are last modified after <date-after>.</t> |
6446 |
|
</list> |
6447 |
|
</t> |
6448 |
|
|
6449 |
|
<t>DESCRIPTION='<search-string>' |
6450 |
|
<list> |
6451 |
|
<t>Restricts the search to instruments with description |
6452 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
6453 |
|
supporting escape sequences as described in chapter |
6454 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6455 |
|
</list> |
6456 |
|
</t> |
6457 |
|
|
6458 |
|
<t>PRODUCT='<search-string>' |
6459 |
|
<list> |
6460 |
|
<t>Restricts the search to instruments with product info |
6461 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
6462 |
|
supporting escape sequences as described in chapter |
6463 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6464 |
|
</list> |
6465 |
|
</t> |
6466 |
|
|
6467 |
|
<t>ARTISTS='<search-string>' |
6468 |
|
<list> |
6469 |
|
<t>Restricts the search to instruments with artists info |
6470 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
6471 |
|
supporting escape sequences as described in chapter |
6472 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6473 |
|
</list> |
6474 |
|
</t> |
6475 |
|
|
6476 |
|
<t>KEYWORDS='<search-string>' |
6477 |
|
<list> |
6478 |
|
<t>Restricts the search to instruments with keyword list |
6479 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
6480 |
|
supporting escape sequences as described in chapter |
6481 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6482 |
|
</list> |
6483 |
|
</t> |
6484 |
|
|
6485 |
|
<t>IS_DRUM=true | false |
6486 |
|
<list> |
6487 |
|
<t>Either true or false. Restricts the search to |
6488 |
|
drum kits or chromatic instruments.</t> |
6489 |
|
</list> |
6490 |
|
</t> |
6491 |
|
|
6492 |
|
<t>FORMAT_FAMILIES='<format-list>' |
6493 |
|
<list> |
6494 |
|
<t>Restricts the search to instruments of the supplied format families, |
6495 |
|
where <format-list> is a comma separated list of format families.</t> |
6496 |
|
</list> |
6497 |
|
</t> |
6498 |
|
</t> |
6499 |
|
|
6500 |
|
<t>Where <search-string> is either a regular expression, or a |
6501 |
|
word list separated with spaces for OR search and with '+' for AND search.</t> |
6502 |
|
|
6503 |
|
<t>Possible Answers:</t> |
6504 |
|
<t> |
6505 |
|
<list> |
6506 |
|
<t>A comma separated list with the absolute path names (encapsulated into |
6507 |
|
apostrophes) of all instruments in the specified directory that satisfy |
6508 |
|
the supplied search criterias.</t> |
6509 |
|
<t>"ERR:<error-code>:<error-message>" - |
6510 |
|
<list> |
6511 |
|
<t>if the given directory does not exist.</t> |
6512 |
|
</list> |
6513 |
|
</t> |
6514 |
|
</list> |
6515 |
|
</t> |
6516 |
|
<t>Example:</t> |
6517 |
|
<t> |
6518 |
|
<list> |
6519 |
|
<t>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"</t> |
6520 |
|
<t>S: "'/Piano Collection/Bosendorfer 290'"</t> |
6521 |
|
</list> |
6522 |
|
</t> |
6523 |
|
<t> |
6524 |
|
<list> |
6525 |
|
<t>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"</t> |
6526 |
|
<t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"</t> |
6527 |
|
</list> |
6528 |
|
</t> |
6529 |
|
</section> |
6530 |
|
|
6531 |
|
<section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO"> |
6532 |
|
<t>The front-end can ask for the current status of a |
6533 |
|
particular database instruments job by sending the following command:</t> |
6534 |
|
<t> |
6535 |
|
<list> |
6536 |
|
<t>GET DB_INSTRUMENTS_JOB INFO <job-id></t> |
6537 |
|
</list> |
6538 |
|
</t> |
6539 |
|
<t>Where <job-id> should be replaced by the numerical ID |
6540 |
|
of the job the front-end is interested in.</t> |
6541 |
|
|
6542 |
|
<t>Possible Answers:</t> |
6543 |
|
<t> |
6544 |
|
<list> |
6545 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
6546 |
|
Each answer line begins with the settings category name |
6547 |
|
followed by a colon and then a space character <SP> and finally |
6548 |
|
the info character string to that setting category. At the |
6549 |
|
moment the following categories are defined:</t> |
6550 |
|
|
6551 |
|
<t> |
6552 |
|
<list> |
6553 |
|
<t>FILES_TOTAL - |
6554 |
|
<list> |
6555 |
|
<t>The total number of files scheduled for scanning</t> |
6556 |
|
</list> |
6557 |
|
</t> |
6558 |
|
<t>FILES_SCANNED - |
6559 |
|
<list> |
6560 |
|
<t>The current number of scanned files</t> |
6561 |
|
</list> |
6562 |
|
</t> |
6563 |
|
<t>SCANNING - |
6564 |
|
<list> |
6565 |
|
<t>The absolute path name of the file which is currently |
6566 |
|
being scanned</t> |
6567 |
|
</list> |
6568 |
|
</t> |
6569 |
|
<t>STATUS - |
6570 |
|
<list> |
6571 |
|
<t>An integer value between 0 and 100 indicating the |
6572 |
|
scanning progress percentage of the file which is |
6573 |
|
currently being scanned</t> |
6574 |
|
</list> |
6575 |
|
</t> |
6576 |
|
</list> |
6577 |
|
</t> |
6578 |
|
</list> |
6579 |
|
</t> |
6580 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
6581 |
|
|
6582 |
|
<t>Example:</t> |
6583 |
|
<t> |
6584 |
|
<list> |
6585 |
|
<t>C: "GET DB_INSTRUMENTS_JOB INFO 2"</t> |
6586 |
|
<t>S: "FILES_TOTAL: 12"</t> |
6587 |
|
<t> "FILES_SCANNED: 7"</t> |
6588 |
|
<t> "SCANNING: /home/me/gigs/Bosendorfer 290.gig"</t> |
6589 |
|
<t> "STATUS: 42"</t> |
6590 |
|
<t> "."</t> |
6591 |
|
</list> |
6592 |
|
</t> |
6593 |
|
</section> |
6594 |
|
|
6595 |
|
<section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB"> |
6596 |
|
<t>The front-end can remove all instruments and directories and re-create |
6597 |
|
the instruments database structure (e.g., in case of a database corruption) |
6598 |
|
by sending the following command:</t> |
6599 |
|
<t> |
6600 |
|
<list> |
6601 |
|
<t>FORMAT INSTRUMENTS_DB</t> |
6602 |
|
</list> |
6603 |
|
</t> |
6604 |
|
|
6605 |
|
<t>Possible Answers:</t> |
6606 |
|
<t> |
6607 |
|
<list> |
6608 |
|
<t>"OK" - |
6609 |
|
<list> |
6610 |
|
<t>on success</t> |
6611 |
|
</list> |
6612 |
|
</t> |
6613 |
|
<t>"ERR:<error-code>:<error-message>" - |
6614 |
|
<list> |
6615 |
|
<t>If the formatting of the instruments database |
6616 |
|
failed.</t> |
6617 |
|
</list> |
6618 |
|
</t> |
6619 |
|
</list> |
6620 |
|
</t> |
6621 |
|
</section> |
6622 |
|
|
6623 |
|
<section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES"> |
6624 |
|
<t>The front-end can retrieve the list of all instrument files in the instruments database |
6625 |
|
that don't exist in the filesystem by sending the following command:</t> |
6626 |
|
<t> |
6627 |
|
<list> |
6628 |
|
<t>FIND LOST DB_INSTRUMENT_FILES</t> |
6629 |
|
</list> |
6630 |
|
</t> |
6631 |
|
|
6632 |
|
<t>Possible Answers:</t> |
6633 |
|
<t> |
6634 |
|
<list> |
6635 |
|
<t>A comma separated list with the absolute path names |
6636 |
|
(encapsulated into apostrophes) of all lost instrument files.</t> |
6637 |
|
<t>"ERR:<error-code>:<error-message>" - |
6638 |
|
<list> |
6639 |
|
<t>in case it failed, providing an appropriate error code and error message.</t> |
6640 |
|
</list> |
6641 |
|
</t> |
6642 |
|
</list> |
6643 |
|
</t> |
6644 |
|
<t>Example:</t> |
6645 |
|
<t> |
6646 |
|
<list> |
6647 |
|
<t>C: "FIND LOST DB_INSTRUMENT_FILES"</t> |
6648 |
|
<t>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"</t> |
6649 |
|
</list> |
6650 |
|
</t> |
6651 |
|
</section> |
6652 |
|
|
6653 |
|
<section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH"> |
6654 |
|
<t>The front-end can substitute all occurrences of an instrument file |
6655 |
|
in the instruments database with a new one by sending the following command:</t> |
6656 |
|
<t> |
6657 |
|
<list> |
6658 |
|
<t>SET DB_INSTRUMENT FILE_PATH <old_path> <new_path></t> |
6659 |
|
</list> |
6660 |
|
</t> |
6661 |
|
<t>Where <old_path> is the absolute path name of the instrument file |
6662 |
|
to substitute with <new_path>.</t> |
6663 |
|
|
6664 |
|
<t>Possible Answers:</t> |
6665 |
|
<t> |
6666 |
|
<list> |
6667 |
|
<t>"OK" - |
6668 |
|
<list> |
6669 |
|
<t>on success</t> |
6670 |
|
</list> |
6671 |
|
</t> |
6672 |
|
<t>"ERR:<error-code>:<error-message>" - |
6673 |
|
<list> |
6674 |
|
<t>in case it failed, providing an appropriate error code and error message.</t> |
6675 |
|
</list> |
6676 |
|
</t> |
6677 |
|
</list> |
6678 |
|
</t> |
6679 |
|
|
6680 |
|
<t>Example:</t> |
6681 |
|
<t> |
6682 |
|
<list> |
6683 |
|
<t>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"</t> |
6684 |
|
<t>S: "OK"</t> |
6685 |
|
</list> |
6686 |
|
</t> |
6687 |
|
</section> |
6688 |
|
|
6689 |
|
</section> |
6690 |
|
|
6691 |
|
|
6692 |
|
|
6693 |
|
<section title="Editing Instruments" anchor="editing_instruments"> |
6694 |
|
<t>The sampler allows to edit instruments while playing with the |
6695 |
|
sampler by spawning an external (3rd party) instrument editor |
6696 |
|
application for a given instrument. The 3rd party instrument |
6697 |
|
editor applications have to place a respective plugin DLL file |
6698 |
|
into the sampler's plugins directory. The sampler will |
6699 |
|
automatically try to load all plugin DLLs in that directory on |
6700 |
|
startup and only on startup!</t> |
6701 |
|
<t>At the moment there is only one command for this feature set, |
6702 |
|
but this will most probably change in future.</t> |
6703 |
|
|
6704 |
|
<section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT"> |
6705 |
|
<t>The front-end can request to open an appropriate instrument |
6706 |
|
editor application by sending the following command:</t> |
6707 |
|
<t> |
6708 |
|
<list> |
6709 |
|
<t>EDIT CHANNEL INSTRUMENT <sampler-channel></t> |
6710 |
|
</list> |
6711 |
|
</t> |
6712 |
|
<t>Where <sampler-channel> should be replaced by the |
6713 |
|
number of the sampler channel as given by the |
6714 |
|
<xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
6715 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> |
6716 |
|
command.</t> |
6717 |
|
|
6718 |
|
<t>The sampler will try to ask all registered instrument |
6719 |
|
editors (or to be more specific: their sampler plugins) |
6720 |
|
whether they are capable to handle the instrument on the |
6721 |
|
given sampler channel. The sampler will simply use the first |
6722 |
|
instrument editor application which replied with a positive |
6723 |
|
answer and spawn that instrument editor application within |
6724 |
|
the sampler's process and provide that application access |
6725 |
|
to the instrument's data structures, so both applications |
6726 |
|
can share and access the same instruments data at the same |
6727 |
|
time, thus allowing to immediately hear changes with the |
6728 |
|
sampler made by the instrument editor.</t> |
6729 |
|
|
6730 |
|
<t>Note: consequently instrument editors are always spawned |
6731 |
|
locally on the same machine where the sampler is running |
6732 |
|
on!</t> |
6733 |
|
|
6734 |
|
<t>Possible Answers:</t> |
6735 |
|
<t> |
6736 |
|
<list> |
6737 |
|
<t>"OK" - |
6738 |
|
<list> |
6739 |
|
<t>when an appropriate instrument editor was |
6740 |
|
launched</t> |
6741 |
|
</list> |
6742 |
|
</t> |
6743 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
6744 |
|
<list> |
6745 |
|
<t>when an appropriate instrument editor was |
6746 |
|
launched, but there are noteworthy issues</t> |
6747 |
|
</list> |
6748 |
|
</t> |
6749 |
|
<t>"ERR:<error-code>:<error-message>" - |
6750 |
|
<list> |
6751 |
|
<t>when an appropriate instrument editor |
6752 |
|
could not be launched</t> |
6753 |
|
</list> |
6754 |
|
</t> |
6755 |
|
</list> |
6756 |
|
</t> |
6757 |
|
|
6758 |
|
<t>Examples:</t> |
6759 |
|
<t> |
6760 |
|
<list> |
6761 |
|
<t>C: "EDIT CHANNEL INSTRUMENT 0"</t> |
6762 |
|
<t>S: "OK"</t> |
6763 |
|
</list> |
6764 |
|
</t> |
6765 |
|
</section> |
6766 |
|
</section> |
6767 |
|
|
6768 |
|
<section title="Managing Files" anchor="file_management"> |
6769 |
|
<t>You can query detailed informations about files located |
6770 |
|
at the same system where the sampler instance is running on. |
6771 |
|
Using this command set allows to retrieve file informations |
6772 |
|
even remotely from another machine.</t> |
6773 |
|
|
6774 |
|
<section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS"> |
6775 |
|
<t>The front-end can retrieve the amount of instruments |
6776 |
|
within a given instrument file by sending the |
6777 |
|
following command:</t> |
6778 |
|
<t> |
6779 |
|
<list> |
6780 |
|
<t>GET FILE INSTRUMENTS <filename></t> |
6781 |
|
</list> |
6782 |
|
</t> |
6783 |
|
<t>Where <filename> is the name of the instrument |
6784 |
|
file (encapsulated into apostrophes, supporting escape |
6785 |
|
sequences as described in chapter |
6786 |
|
"<xref target="character_set">Character Set and Escape |
6787 |
|
Sequences</xref>").</t> |
6788 |
|
|
6789 |
|
<t>The sampler will try to ask all sampler engines, |
6790 |
|
whether they support the given file and ask the first |
6791 |
|
engine with a positive answer for the amount of |
6792 |
|
instruments.</t> |
6793 |
|
|
6794 |
|
<t>Possible Answers:</t> |
6795 |
|
<t> |
6796 |
|
<list> |
6797 |
|
<t>On success, the sampler will answer by |
6798 |
|
returning the amount of instruments. |
6799 |
|
</t> |
6800 |
|
<t>"ERR:<error-code>:<error-message>" - |
6801 |
|
<list> |
6802 |
|
<t>if the file could not be handled</t> |
6803 |
|
</list> |
6804 |
|
</t> |
6805 |
|
</list> |
6806 |
|
</t> |
6807 |
|
|
6808 |
|
<t>Examples:</t> |
6809 |
|
<t> |
6810 |
|
<list> |
6811 |
|
<t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
6812 |
|
<t>S: "10"</t> |
6813 |
|
</list> |
6814 |
|
</t> |
6815 |
|
</section> |
6816 |
|
|
6817 |
|
<section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS"> |
6818 |
|
<t>The front-end can retrieve a list of all instruments |
6819 |
|
within a given instrument file by sending the |
6820 |
|
following command:</t> |
6821 |
|
<t> |
6822 |
|
<list> |
6823 |
|
<t>LIST FILE INSTRUMENTS <filename></t> |
6824 |
|
</list> |
6825 |
|
</t> |
6826 |
|
<t>Where <filename> is the name of the instrument |
6827 |
|
file (encapsulated into apostrophes, supporting escape |
6828 |
|
sequences as described in chapter |
6829 |
|
"<xref target="character_set">Character Set and Escape |
6830 |
|
Sequences</xref>").</t> |
6831 |
|
|
6832 |
|
<t>The sampler will try to ask all sampler engines, |
6833 |
|
whether they support the given file and ask the first |
6834 |
|
engine with a positive answer for a list of IDs for the |
6835 |
|
instruments in the given file.</t> |
6836 |
|
|
6837 |
|
<t>Possible Answers:</t> |
6838 |
|
<t> |
6839 |
|
<list> |
6840 |
|
<t>On success, the sampler will answer by |
6841 |
|
returning a comma separated list of |
6842 |
|
instrument IDs. |
6843 |
|
</t> |
6844 |
|
<t>"ERR:<error-code>:<error-message>" - |
6845 |
|
<list> |
6846 |
|
<t>if the file could not be handled</t> |
6847 |
|
</list> |
6848 |
|
</t> |
6849 |
|
</list> |
6850 |
|
</t> |
6851 |
|
|
6852 |
|
<t>Examples:</t> |
6853 |
|
<t> |
6854 |
|
<list> |
6855 |
|
<t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
6856 |
|
<t>S: "0,1,2,3,4,5,6,7,8,9"</t> |
6857 |
|
</list> |
6858 |
|
</t> |
6859 |
|
</section> |
6860 |
|
|
6861 |
|
<section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO"> |
6862 |
|
<t>The front-end can retrieve detailed informations |
6863 |
|
about a specific instrument within a given instrument |
6864 |
|
file by sending the following command:</t> |
6865 |
|
<t> |
6866 |
|
<list> |
6867 |
|
<t>GET FILE INSTRUMENT INFO <filename> |
6868 |
|
<instr-id></t> |
6869 |
|
</list> |
6870 |
|
</t> |
6871 |
|
<t>Where <filename> is the name of the instrument |
6872 |
|
file (encapsulated into apostrophes, supporting escape |
6873 |
|
sequences as described in chapter |
6874 |
|
"<xref target="character_set">Character Set and Escape |
6875 |
|
Sequences</xref>") and <instr-id> is the numeric |
6876 |
|
instrument ID as returned by the |
6877 |
|
<xref target="LIST FILE INSTRUMENTS"> |
6878 |
|
"LIST FILE INSTRUMENTS"</xref> command.</t> |
6879 |
|
|
6880 |
|
<t>The sampler will try to ask all sampler engines, |
6881 |
|
whether they support the given file and ask the first |
6882 |
|
engine with a positive answer for informations about the |
6883 |
|
specific instrument in the given file.</t> |
6884 |
|
|
6885 |
|
<t>Possible Answers:</t> |
6886 |
|
<t> |
6887 |
|
<list> |
6888 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
6889 |
|
Each answer line begins with the settings category name |
6890 |
|
followed by a colon and then a space character <SP> and finally |
6891 |
|
the info character string to that setting category. At the |
6892 |
|
moment the following categories are defined:</t> |
6893 |
|
|
6894 |
|
<t> |
6895 |
|
<list> |
6896 |
|
<t>NAME - |
6897 |
|
<list> |
6898 |
|
<t>name of the instrument as |
6899 |
|
stored in the instrument file</t> |
6900 |
|
</list> |
6901 |
|
</t> |
6902 |
|
<t>FORMAT_FAMILY - |
6903 |
|
<list> |
6904 |
|
<t>name of the sampler format |
6905 |
|
of the given instrument</t> |
6906 |
|
</list> |
6907 |
|
</t> |
6908 |
|
<t>FORMAT_VERSION - |
6909 |
|
<list> |
6910 |
|
<t>version of the sampler format |
6911 |
|
the instrumen is stored as</t> |
6912 |
|
</list> |
6913 |
|
</t> |
6914 |
|
<t>PRODUCT - |
6915 |
|
<list> |
6916 |
|
<t>official product name of the |
6917 |
|
instrument as stored in the file |
6918 |
|
</t> |
6919 |
|
</list> |
6920 |
|
</t> |
6921 |
|
<t>ARTISTS - |
6922 |
|
<list> |
6923 |
|
<t>artists / sample library |
6924 |
|
vendor of the instrument</t> |
6925 |
|
</list> |
6926 |
|
</t> |
6927 |
|
<t>KEY_BINDINGS - |
6928 |
|
<list> |
6929 |
|
<t>comma separated list of integer values representing |
6930 |
|
the instrument's key mapping in the range between 0 .. 127, |
6931 |
|
reflecting the analog meaning of the MIDI specification.</t> |
6932 |
|
</list> |
6933 |
|
</t> |
6934 |
|
<t>KEYSWITCH_BINDINGS - |
6935 |
|
<list> |
6936 |
|
<t>comma separated list of integer values representing |
6937 |
|
the instrument's keyswitch mapping in the range between 0 .. 127, |
6938 |
|
reflecting the analog meaning of the MIDI specification.</t> |
6939 |
|
</list> |
6940 |
|
</t> |
6941 |
|
</list> |
6942 |
|
</t> |
6943 |
|
</list> |
6944 |
|
</t> |
6945 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
6946 |
|
|
6947 |
|
<t>Example:</t> |
6948 |
|
<t> |
6949 |
|
<list> |
6950 |
|
<t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t> |
6951 |
|
<t>S: "NAME: Lunatic Loops"</t> |
6952 |
|
<t> "FORMAT_FAMILY: GIG"</t> |
6953 |
|
<t> "FORMAT_VERSION: 3"</t> |
6954 |
|
<t> "PRODUCT: The Backbone Bongo Beats"</t> |
6955 |
|
<t> "ARTISTS: Jimmy the Fish"</t> |
6956 |
|
<t> "."</t> |
6957 |
|
</list> |
6958 |
|
</t> |
6959 |
|
</section> |
6960 |
|
</section> |
6961 |
|
<section title="Managing Effects" anchor="effects"> |
6962 |
|
<t>Audio effects (e.g. reverb, delay, compression) can be |
6963 |
|
applied to the audio signals generated by the sampler. The |
6964 |
|
sampler usually provides a set of internal audio effects for |
6965 |
|
this task. The exact set of effects depends on the availability |
6966 |
|
of third party effect plugins installed on the system where the |
6967 |
|
sampler runs on.</t> |
6968 |
|
<t>At the moment only "send effects" are supported. Support for |
6969 |
|
"insert effects" and "master effects" is planned to be added at |
6970 |
|
a later point.</t> |
6971 |
|
<t>The following commands allow to retrieve the set of internal |
6972 |
|
effects available to the sampler, detailed informations about |
6973 |
|
those effects and to create and destroy instances of such |
6974 |
|
effects. After an instance of an effect is created, the effect |
6975 |
|
instance can be inserted into the audio signal path of the |
6976 |
|
sampler, e.g. as send effect.</t> |
6977 |
|
<t>The sampler allows to create an arbitrary amount of so called |
6978 |
|
send effect chains. Each effect chain can host an arbitrary |
6979 |
|
amount of effect instances. The output of the first effect |
6980 |
|
instance in an effect chain is fed to the input of the second |
6981 |
|
effect instance of the chain and so on. So effects in one chain |
6982 |
|
are processed sequentially. Send effect chains however are |
6983 |
|
processed in parallel to other send effect chains. Audio signals |
6984 |
|
of sampler channels are fed to send effects by creating FX sends |
6985 |
|
to the respective sampler channel and assigning a destination |
6986 |
|
send effect to that FX by using the |
6987 |
|
<xref target="SET FX_SEND EFFECT">"SET FX_SEND EFFECT"</xref> |
6988 |
|
command. The latter allows to route the FX send to the beginning |
6989 |
|
of a send effect chain, as well as directly to any other |
6990 |
|
position of the send effect chain.</t> |
6991 |
|
|
6992 |
|
<section title="Retrieve amount of available effects" anchor="GET AVAILABLE_EFFECTS"> |
6993 |
|
<t>The front-end can retrieve the amount of internal |
6994 |
|
effects, available to the sampler by sending |
6995 |
|
the following command:</t> |
6996 |
|
<t> |
6997 |
|
<list> |
6998 |
|
<t>GET AVAILABLE_EFFECTS</t> |
6999 |
|
</list> |
7000 |
|
</t> |
7001 |
|
|
7002 |
|
<t>Possible Answers:</t> |
7003 |
|
<t> |
7004 |
|
<list> |
7005 |
|
<t>The sampler will answer by returning the current |
7006 |
|
number of effects available to the sampler.</t> |
7007 |
|
</list> |
7008 |
|
</t> |
7009 |
|
|
7010 |
|
<t>Examples:</t> |
7011 |
|
<t> |
7012 |
|
<list> |
7013 |
|
<t>C: "GET AVAILABLE_EFFECTS"</t> |
7014 |
|
<t>S: "129"</t> |
7015 |
|
</list> |
7016 |
|
</t> |
7017 |
|
</section> |
7018 |
|
|
7019 |
|
<section title="Get list of available effects" anchor="LIST AVAILABLE_EFFECTS"> |
7020 |
|
<t>The set of available internal effects can change at |
7021 |
|
runtime. The front-end can retrieve the list of internal |
7022 |
|
effects, available to the sampler by sending the following |
7023 |
|
command:</t> |
7024 |
|
<t> |
7025 |
|
<list> |
7026 |
|
<t>LIST AVAILABLE_EFFECTS</t> |
7027 |
|
</list> |
7028 |
|
</t> |
7029 |
|
|
7030 |
|
<t>Possible Answers:</t> |
7031 |
|
<t> |
7032 |
|
<list> |
7033 |
|
<t>The sampler will answer by returning a comma |
7034 |
|
separated list with numerical IDs of effects. Note: |
7035 |
|
the numercial ID of an effect is generated by the |
7036 |
|
sampler for the current moment. The numerical ID of |
7037 |
|
the same effect can change at runtime, e.g. when the |
7038 |
|
user requests a rescan of available effect plugins. |
7039 |
|
</t> |
7040 |
|
</list> |
7041 |
|
</t> |
7042 |
|
<t>Example:</t> |
7043 |
|
<t> |
7044 |
|
<list> |
7045 |
|
<t>C: "LIST AVAILABLE_EFFECTS"</t> |
7046 |
|
<t>S: "5,6,7,120,121,122,123,124"</t> |
7047 |
|
</list> |
7048 |
|
</t> |
7049 |
|
</section> |
7050 |
|
|
7051 |
|
<section title="Retrieving general information about an effect" anchor="GET EFFECT INFO"> |
7052 |
|
<t>The front-end can ask for general informations about an |
7053 |
|
effect by sending the following command:</t> |
7054 |
|
<t> |
7055 |
|
<list> |
7056 |
|
<t>GET EFFECT INFO <effect-index></t> |
7057 |
|
</list> |
7058 |
|
</t> |
7059 |
|
<t>Where <effect-index> is the numerical ID of an |
7060 |
|
effect as returned by the |
7061 |
|
<xref target="LIST AVAILABLE_EFFECTS">"LIST AVAILABLE_EFFECTS"</xref> |
7062 |
|
command.</t> |
7063 |
|
<t>Possible Answers:</t> |
7064 |
|
<t> |
7065 |
|
<list> |
7066 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
7067 |
|
Each answer line begins with the effect information |
7068 |
|
category name, followed by a colon and then a space |
7069 |
|
character <SP> and finally the info character |
7070 |
|
string to that effect information category. At the |
7071 |
|
moment the following categories are defined:</t> |
7072 |
|
<t> |
7073 |
|
<list> |
7074 |
|
<t>SYSTEM - |
7075 |
|
<list> |
7076 |
|
<t>name of the effect plugin system |
7077 |
|
the effect is based on |
7078 |
|
(e.g. "LADSPA")</t> |
7079 |
|
</list> |
7080 |
|
</t> |
7081 |
|
<t>MODULE - |
7082 |
|
<list> |
7083 |
|
<t>module of the effect plugin |
7084 |
|
system that contains this effect, |
7085 |
|
the module is usually the |
7086 |
|
dynamic-linked library (DLL) |
7087 |
|
filename of the effect plugin, |
7088 |
|
including full path (note that this |
7089 |
|
filename may contain |
7090 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7091 |
|
</list> |
7092 |
|
</t> |
7093 |
|
<t>NAME - |
7094 |
|
<list> |
7095 |
|
<t>character string defining the |
7096 |
|
unique name of the effect within its |
7097 |
|
module (note that the character |
7098 |
|
string may contain |
7099 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7100 |
|
</list> |
7101 |
|
</t> |
7102 |
|
<t>DESCRIPTION - |
7103 |
|
<list> |
7104 |
|
<t>human readable name of the |
7105 |
|
effect, intended to be displayed in |
7106 |
|
user interfaces (note that the |
7107 |
|
character string may contain |
7108 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7109 |
|
</list> |
7110 |
|
</t> |
7111 |
|
</list> |
7112 |
|
</t> |
7113 |
|
</list> |
7114 |
|
</t> |
7115 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
7116 |
|
|
7117 |
|
<t>Example:</t> |
7118 |
|
<t> |
7119 |
|
<list> |
7120 |
|
<t>C: "GET EFFECT INFO 121"</t> |
7121 |
|
<t>S: "SYSTEM: LADSPA"</t> |
7122 |
|
<t> "MODULE: /usr/lib/ladspa/lowpass_iir_1891.so"</t> |
7123 |
|
<t> "NAME: lowpass_iir"</t> |
7124 |
|
<t> "DESCRIPTION: Glame Lowpass Filter"</t> |
7125 |
|
<t> "."</t> |
7126 |
|
</list> |
7127 |
|
</t> |
7128 |
|
</section> |
7129 |
|
|
7130 |
|
<section title="Creating an instance of an effect by its portable ID" anchor="CREATE EFFECT_INSTANCE"> |
7131 |
|
<t>The front-end can spawn an instance of the desired |
7132 |
|
effect by sending the following command:</t> |
7133 |
|
<t> |
7134 |
|
<list> |
7135 |
|
<t>CREATE EFFECT_INSTANCE <effect-system> <module> <effect-name></t> |
7136 |
|
</list> |
7137 |
|
</t> |
7138 |
|
<t>Where <effect-system> is the "SYSTEM" field, |
7139 |
|
<module> the "MODULE" field and <effect-name> |
7140 |
|
the "NAME" field as returned by the |
7141 |
|
<xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref> |
7142 |
|
command. The filename of argument <module> and the |
7143 |
|
character string of argument <effect-name> may contain |
7144 |
|
<xref target="character_set">escape sequences</xref>.</t> |
7145 |
|
|
7146 |
|
<t>The sampler will try to load the requested effect and to |
7147 |
|
create an instance of it. To allow loading the same effect |
7148 |
|
on a different machine, probably even running a completely |
7149 |
|
different operating system (e.g. Linux vs. Windows), the |
7150 |
|
sampler tries to match <module> "softly". That means |
7151 |
|
it first tries to find an effect that exactly matches the |
7152 |
|
given <module> argument. If there is no exact match, |
7153 |
|
the sampler will try to lower the restrictions on matching |
7154 |
|
the <module> argument more and more, e.g. by ignoring |
7155 |
|
upper / lower case differences and by ignoring the path of |
7156 |
|
the DLL filename and file extension. If there is still no |
7157 |
|
match at the end, the sampler will try to ignore the |
7158 |
|
<module> argument completely and as a last resort |
7159 |
|
search for an effect that only matches the given |
7160 |
|
<effect-system> and <effect-name> arguments.</t> |
7161 |
|
|
7162 |
|
<t>Possible Answers:</t> |
7163 |
|
<t> |
7164 |
|
<list> |
7165 |
|
<t>"OK[<effect-instance>]" - |
7166 |
|
<list> |
7167 |
|
<t>in case the effect instance was |
7168 |
|
successfully created, where |
7169 |
|
<effect-instance> is the numerical ID |
7170 |
|
of the new effect instance</t> |
7171 |
|
</list> |
7172 |
|
</t> |
7173 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
7174 |
|
<list> |
7175 |
|
<t>in case the effect instance was spawned |
7176 |
|
successfully, but there are noteworthy |
7177 |
|
issue(s) related, providing an appropriate |
7178 |
|
warning code and warning message</t> |
7179 |
|
</list> |
7180 |
|
</t> |
7181 |
|
<t>"ERR:<error-code>:<error-message>" - |
7182 |
|
<list> |
7183 |
|
<t>if the effect could not be instantiated</t> |
7184 |
|
</list> |
7185 |
|
</t> |
7186 |
|
</list> |
7187 |
|
</t> |
7188 |
|
|
7189 |
|
<t>Examples:</t> |
7190 |
|
<t> |
7191 |
|
<list> |
7192 |
|
<t>C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/mod_delay_1419.so' 'modDelay'"</t> |
7193 |
|
<t>S: "OK[0]"</t> |
7194 |
|
</list> |
7195 |
|
</t> |
7196 |
|
</section> |
7197 |
|
|
7198 |
|
<section title="Creating an instance of an effect by its numerical ID" anchor="CREATE EFFECT_INSTANCE (non-portable)"> |
7199 |
|
<t>The front-end can spawn an instance of the desired |
7200 |
|
effect by sending the following command:</t> |
7201 |
|
<t> |
7202 |
|
<list> |
7203 |
|
<t>CREATE EFFECT_INSTANCE <effect-index></t> |
7204 |
|
</list> |
7205 |
|
</t> |
7206 |
|
<t>Where <effect-index> is the numerical ID of the |
7207 |
|
effect as returned by the |
7208 |
|
<xref target="LIST AVAILABLE_EFFECTS">"LIST AVAILABLE_EFFECTS"</xref> |
7209 |
|
command.</t> |
7210 |
|
|
7211 |
|
<t>The sampler will try to load the requested effect and to |
7212 |
|
create an instance of it.</t> |
7213 |
|
|
7214 |
|
<t>Note: Since the numerical ID of a certain effect can |
7215 |
|
change at any time, you should not use this command in |
7216 |
|
LSCP files to restore a certain effect at a later time! To |
7217 |
|
store a sampler session including all its effects, use the |
7218 |
|
<xref target="CREATE EFFECT_INSTANCE">portable text-based |
7219 |
|
version of "CREATE EFFECT_INSTANCE"</xref> instead! This |
7220 |
|
allows to restore a sampler session with all its effects |
7221 |
|
also on other machines, possibly even running a completely |
7222 |
|
different operating system (e.g. Linux vs. Windows), with |
7223 |
|
different plugin directories or plugin DLL names.</t> |
7224 |
|
|
7225 |
|
<t>Possible Answers:</t> |
7226 |
|
<t> |
7227 |
|
<list> |
7228 |
|
<t>"OK[<effect-instance>]" - |
7229 |
|
<list> |
7230 |
|
<t>in case the effect instance was |
7231 |
|
successfully created, where |
7232 |
|
<effect-instance> is the numerical ID |
7233 |
|
of the new effect instance</t> |
7234 |
|
</list> |
7235 |
|
</t> |
7236 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
7237 |
|
<list> |
7238 |
|
<t>in case the effect instance was spawned |
7239 |
|
successfully, but there are noteworthy |
7240 |
|
issue(s) related, providing an appropriate |
7241 |
|
warning code and warning message</t> |
7242 |
|
</list> |
7243 |
|
</t> |
7244 |
|
<t>"ERR:<error-code>:<error-message>" - |
7245 |
|
<list> |
7246 |
|
<t>if the effect could not be instantiated</t> |
7247 |
|
</list> |
7248 |
|
</t> |
7249 |
|
</list> |
7250 |
|
</t> |
7251 |
|
|
7252 |
|
<t>Examples:</t> |
7253 |
|
<t> |
7254 |
|
<list> |
7255 |
|
<t>C: "CREATE EFFECT_INSTANCE 72"</t> |
7256 |
|
<t>S: "OK[5]"</t> |
7257 |
|
</list> |
7258 |
|
</t> |
7259 |
|
</section> |
7260 |
|
|
7261 |
|
<section title="Destroy an effect instance" anchor="DESTROY EFFECT_INSTANCE"> |
7262 |
|
<t>The front-end can destroy an unusued effect instance and |
7263 |
|
thus freeing it from memory by sending the following command:</t> |
7264 |
|
<t> |
7265 |
|
<list> |
7266 |
|
<t>DESTROY EFFECT_INSTANCE <effect-instance></t> |
7267 |
|
</list> |
7268 |
|
</t> |
7269 |
|
<t>Where <effect-instance> is the numerical ID of the |
7270 |
|
effect instance as returned by the |
7271 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
7272 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7273 |
|
command.</t> |
7274 |
|
|
7275 |
|
<t>The effect instance can only be destroyed if it's not |
7276 |
|
used in any part of the sampler's audio signal path anymore. |
7277 |
|
If the effect instance is still in use somewhere, trying to |
7278 |
|
destroy the effect instance will result in an error |
7279 |
|
message.</t> |
7280 |
|
|
7281 |
|
<t>Possible Answers:</t> |
7282 |
|
<t> |
7283 |
|
<list> |
7284 |
|
<t>"OK" - |
7285 |
|
<list> |
7286 |
|
<t>in case the effect instance was successfully destroyed</t> |
7287 |
|
</list> |
7288 |
|
</t> |
7289 |
|
<t>"ERR:<error-code>:<error-message>" - |
7290 |
|
<list> |
7291 |
|
<t>in case it failed, providing an appropriate error code and |
7292 |
|
error message</t> |
7293 |
|
</list> |
7294 |
|
</t> |
7295 |
|
</list> |
7296 |
|
</t> |
7297 |
|
|
7298 |
|
<t>Examples:</t> |
7299 |
|
<t> |
7300 |
|
<list> |
7301 |
|
<t>C: "DESTROY EFFECT_INSTANCE 5"</t> |
7302 |
|
<t>S: "OK"</t> |
7303 |
|
</list> |
7304 |
|
</t> |
7305 |
|
</section> |
7306 |
|
|
7307 |
|
<section title="Retrieve amount of effect instances" anchor="GET EFFECT_INSTANCES"> |
7308 |
|
<t>The front-end can retrieve the current amount of effect |
7309 |
|
instances by sending the following command:</t> |
7310 |
|
<t> |
7311 |
|
<list> |
7312 |
|
<t>GET EFFECT_INSTANCES</t> |
7313 |
|
</list> |
7314 |
|
</t> |
7315 |
|
|
7316 |
|
<t>Possible Answers:</t> |
7317 |
|
<t> |
7318 |
|
<list> |
7319 |
|
<t>The sampler will answer by returning the current |
7320 |
|
number of effect instances created and not yet |
7321 |
|
destroyed in the current sampler session.</t> |
7322 |
|
</list> |
7323 |
|
</t> |
7324 |
|
|
7325 |
|
<t>Examples:</t> |
7326 |
|
<t> |
7327 |
|
<list> |
7328 |
|
<t>C: "GET EFFECT_INSTANCES"</t> |
7329 |
|
<t>S: "14"</t> |
7330 |
|
</list> |
7331 |
|
</t> |
7332 |
|
</section> |
7333 |
|
|
7334 |
|
<section title="Get list of effect instances" anchor="LIST EFFECT_INSTANCES"> |
7335 |
|
<t>The front-end can retrieve the current list of effect |
7336 |
|
instances by sending the following command:</t> |
7337 |
|
<t> |
7338 |
|
<list> |
7339 |
|
<t>LIST EFFECT_INSTANCES</t> |
7340 |
|
</list> |
7341 |
|
</t> |
7342 |
|
|
7343 |
|
<t>Possible Answers:</t> |
7344 |
|
<t> |
7345 |
|
<list> |
7346 |
|
<t>The sampler will answer by returning a comma |
7347 |
|
separated list with numerical IDs of effects |
7348 |
|
instances. |
7349 |
|
</t> |
7350 |
|
</list> |
7351 |
|
</t> |
7352 |
|
<t>Example:</t> |
7353 |
|
<t> |
7354 |
|
<list> |
7355 |
|
<t>C: "LIST EFFECT_INSTANCES"</t> |
7356 |
|
<t>S: "9,11,14,15,16,17,25"</t> |
7357 |
|
</list> |
7358 |
|
</t> |
7359 |
|
</section> |
7360 |
|
|
7361 |
|
<section title="Retrieving current information about an effect instance" anchor="GET EFFECT_INSTANCE INFO"> |
7362 |
|
<t>The front-end can ask for the current informations about |
7363 |
|
a particular effect instance by sending the following command:</t> |
7364 |
|
<t> |
7365 |
|
<list> |
7366 |
|
<t>GET EFFECT_INSTANCE INFO <effect-instance></t> |
7367 |
|
</list> |
7368 |
|
</t> |
7369 |
|
<t>Where <effect-instance> is the numerical ID of an |
7370 |
|
effect instance as returned by the |
7371 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> |
7372 |
|
or |
7373 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7374 |
|
command.</t> |
7375 |
|
|
7376 |
|
<t>Possible Answers:</t> |
7377 |
|
<t> |
7378 |
|
<list> |
7379 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
7380 |
|
Each answer line begins with the information |
7381 |
|
category name, followed by a colon and then a space |
7382 |
|
character <SP> and finally the info character |
7383 |
|
string to that information category. At the |
7384 |
|
moment the following categories are defined:</t> |
7385 |
|
<t> |
7386 |
|
<list> |
7387 |
|
<t>SYSTEM - |
7388 |
|
<list> |
7389 |
|
<t>name of the effect plugin system |
7390 |
|
the effect is based on |
7391 |
|
(e.g. "LADSPA")</t> |
7392 |
|
</list> |
7393 |
|
</t> |
7394 |
|
<t>MODULE - |
7395 |
|
<list> |
7396 |
|
<t>module of the effect plugin |
7397 |
|
system that contains this effect, |
7398 |
|
the module is usually the |
7399 |
|
dynamic-linked library (DLL) |
7400 |
|
filename of the effect plugin, |
7401 |
|
including full path (note that this |
7402 |
|
filename may contain |
7403 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7404 |
|
</list> |
7405 |
|
</t> |
7406 |
|
<t>NAME - |
7407 |
|
<list> |
7408 |
|
<t>character string defining the |
7409 |
|
unique name of the effect within its |
7410 |
|
module (note that the character |
7411 |
|
string may contain |
7412 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7413 |
|
</list> |
7414 |
|
</t> |
7415 |
|
<t>DESCRIPTION - |
7416 |
|
<list> |
7417 |
|
<t>human readable name of the |
7418 |
|
effect, intended to be displayed in |
7419 |
|
user interfaces (note that the |
7420 |
|
character string may contain |
7421 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7422 |
|
</list> |
7423 |
|
</t> |
7424 |
|
<t>INPUT_CONTROLS - |
7425 |
|
<list> |
7426 |
|
<t>amount of input controls the |
7427 |
|
effect instance provides, to allow |
7428 |
|
controlling the effect parameters in |
7429 |
|
realtime</t> |
7430 |
|
</list> |
7431 |
|
</t> |
7432 |
|
</list> |
7433 |
|
</t> |
7434 |
|
</list> |
7435 |
|
</t> |
7436 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
7437 |
|
|
7438 |
|
<t>Example:</t> |
7439 |
|
<t> |
7440 |
|
<list> |
7441 |
|
<t>C: "GET EFFECT_INSTANCE INFO 3"</t> |
7442 |
|
<t>S: "SYSTEM: LADSPA"</t> |
7443 |
|
<t> "MODULE: /usr/lib/ladspa/mod_delay_1419.so"</t> |
7444 |
|
<t> "NAME: modDelay"</t> |
7445 |
|
<t> "DESCRIPTION: Modulatable delay"</t> |
7446 |
|
<t> "INPUT_CONTROLS: 1"</t> |
7447 |
|
<t> "."</t> |
7448 |
|
</list> |
7449 |
|
</t> |
7450 |
|
</section> |
7451 |
|
|
7452 |
|
<section title="Retrieving information about an effect parameter" anchor="GET EFFECT_INSTANCE_INPUT_CONTROL INFO"> |
7453 |
|
<t>Effects typically provide a certain set of effect |
7454 |
|
parameters which can be altered by the user in realtime |
7455 |
|
(e.g. depth of a reverb effect, duration of a delay effect, |
7456 |
|
dry / wet signal ratio). Those controllable effect parameters |
7457 |
|
are called "input controls". The front-end can ask for the |
7458 |
|
current informations of an effect instance's input control |
7459 |
|
by sending the following command:</t> |
7460 |
|
<t> |
7461 |
|
<list> |
7462 |
|
<t>GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-control></t> |
7463 |
|
</list> |
7464 |
|
</t> |
7465 |
|
<t>Where <effect-instance> is the numerical ID of an |
7466 |
|
effect instance as returned by the |
7467 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> |
7468 |
|
or |
7469 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7470 |
|
command and <input-control> is the index of the input |
7471 |
|
control within the numerical bounds as returned by the |
7472 |
|
"INPUT_CONTROLS" field of the |
7473 |
|
<xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref> |
7474 |
|
command.</t> |
7475 |
|
|
7476 |
|
<t>Possible Answers:</t> |
7477 |
|
<t> |
7478 |
|
<list> |
7479 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
7480 |
|
Each answer line begins with the information |
7481 |
|
category name, followed by a colon and then a space |
7482 |
|
character <SP> and finally the info character |
7483 |
|
string to that information category. There are |
7484 |
|
information categories which are always returned, |
7485 |
|
independent of the respective effect parameter and |
7486 |
|
there are optional information categories |
7487 |
|
which are only shown for certain effect parameters. |
7488 |
|
At the moment the following categories are defined:</t> |
7489 |
|
<t> |
7490 |
|
<list> |
7491 |
|
<t>DESCRIPTION - |
7492 |
|
<list> |
7493 |
|
<t>(always returned) |
7494 |
|
human readable name of the |
7495 |
|
effect parameter, intended to be |
7496 |
|
displayed in user interfaces (note |
7497 |
|
that the character string may |
7498 |
|
contain <xref target="character_set">escape sequences</xref>)</t> |
7499 |
|
</list> |
7500 |
|
</t> |
7501 |
|
<t>VALUE - |
7502 |
|
<list> |
7503 |
|
<t> |
7504 |
|
(always returned) |
7505 |
|
current (optional dotted) |
7506 |
|
floating point value of this effect |
7507 |
|
parameter</t> |
7508 |
|
</list> |
7509 |
|
</t> |
7510 |
|
<t>RANGE_MIN - |
7511 |
|
<list> |
7512 |
|
<t> |
7513 |
|
(optionally returned) |
7514 |
|
minimum allowed value for this |
7515 |
|
effect parameter</t> |
7516 |
|
</list> |
7517 |
|
</t> |
7518 |
|
<t>RANGE_MAX - |
7519 |
|
<list> |
7520 |
|
<t> |
7521 |
|
(optionally returned) |
7522 |
|
maximum allowed value for this |
7523 |
|
effect parameter</t> |
7524 |
|
</list> |
7525 |
|
</t> |
7526 |
|
<t>POSSIBILITIES - |
7527 |
|
<list> |
7528 |
|
<t> |
7529 |
|
(optionally returned) |
7530 |
|
comma separated list of |
7531 |
|
(optional dotted) floating point |
7532 |
|
numbers, reflecting the exact set of |
7533 |
|
possible values for this effect |
7534 |
|
parameter</t> |
7535 |
|
</list> |
7536 |
|
</t> |
7537 |
|
<t>DEFAULT - |
7538 |
|
<list> |
7539 |
|
<t> |
7540 |
|
(optionally returned) |
7541 |
|
default value of this effect |
7542 |
|
parameter</t> |
7543 |
|
</list> |
7544 |
|
</t> |
7545 |
|
</list> |
7546 |
|
</t> |
7547 |
|
</list> |
7548 |
|
</t> |
7549 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
7550 |
|
|
7551 |
|
<t>Example:</t> |
7552 |
|
<t> |
7553 |
|
<list> |
7554 |
|
<t>C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0"</t> |
7555 |
|
<t>S: "DESCRIPTION: Base delay (s)"</t> |
7556 |
|
<t> "VALUE: 0.500"</t> |
7557 |
|
<t> "RANGE_MIN: 0.000"</t> |
7558 |
|
<t> "."</t> |
7559 |
|
</list> |
7560 |
|
</t> |
7561 |
|
</section> |
7562 |
|
|
7563 |
|
<section title="Altering an effect parameter" anchor="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE"> |
7564 |
|
<t>The front-end can alter the current value of an effect |
7565 |
|
parameter by sending the following command:</t> |
7566 |
|
<t> |
7567 |
|
<list> |
7568 |
|
<t>SET EFFECT_INSTANCE_INPUT_CONTROL VALUE <effect-instance> <input-control> <value></t> |
7569 |
|
</list> |
7570 |
|
</t> |
7571 |
|
<t>Where <effect-instance> is the numerical ID of the |
7572 |
|
effect instance as returned by the |
7573 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
7574 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7575 |
|
command, <input-control> is the index of the input |
7576 |
|
control within the numerical bounds as returned by the |
7577 |
|
"INPUT_CONTROLS" field of the |
7578 |
|
<xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref> |
7579 |
|
command and <value> is the new (optional dotted) |
7580 |
|
floating point value for this effect parameter.</t> |
7581 |
|
|
7582 |
|
<t>Possible Answers:</t> |
7583 |
|
<t> |
7584 |
|
<list> |
7585 |
|
<t>"OK" - |
7586 |
|
<list> |
7587 |
|
<t>in case the effect was altered successfully</t> |
7588 |
|
</list> |
7589 |
|
</t> |
7590 |
|
<t>"ERR:<error-code>:<error-message>" - |
7591 |
|
<list> |
7592 |
|
<t>in case it failed, providing an appropriate error code and |
7593 |
|
error message</t> |
7594 |
|
</list> |
7595 |
|
</t> |
7596 |
|
</list> |
7597 |
|
</t> |
7598 |
|
|
7599 |
|
<t>Examples:</t> |
7600 |
|
<t> |
7601 |
|
<list> |
7602 |
|
<t>C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5"</t> |
7603 |
|
<t>S: "OK"</t> |
7604 |
|
</list> |
7605 |
|
</t> |
7606 |
|
</section> |
7607 |
|
|
7608 |
|
<section title="Retrieve amount of send effect chains" anchor="GET SEND_EFFECT_CHAINS"> |
7609 |
|
<t>The front-end can retrieve the current amount of send |
7610 |
|
effect chains of an audio output device by sending the |
7611 |
|
following command:</t> |
7612 |
|
<t> |
7613 |
|
<list> |
7614 |
|
<t>GET SEND_EFFECT_CHAINS <audio-device></t> |
7615 |
|
</list> |
7616 |
|
</t> |
7617 |
|
<t>Where <audio-device> should be replaced by the |
7618 |
|
numerical ID of the audio output device as given by the |
7619 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7620 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7621 |
|
command.</t> |
7622 |
|
|
7623 |
|
<t>Possible Answers:</t> |
7624 |
|
<t> |
7625 |
|
<list> |
7626 |
|
<t>The sampler will answer by returning the current |
7627 |
|
number of send effect chains of the supplied audio |
7628 |
|
output device.</t> |
7629 |
|
</list> |
7630 |
|
</t> |
7631 |
|
|
7632 |
|
<t>Examples:</t> |
7633 |
|
<t> |
7634 |
|
<list> |
7635 |
|
<t>C: "GET SEND_EFFECT_CHAINS 0"</t> |
7636 |
|
<t>S: "4"</t> |
7637 |
|
</list> |
7638 |
|
</t> |
7639 |
|
</section> |
7640 |
|
|
7641 |
|
<section title="Retrieve list of send effect chains" anchor="LIST SEND_EFFECT_CHAINS"> |
7642 |
|
<t>The front-end can retrieve the current list of send |
7643 |
|
effect chains of an audio output device by sending the |
7644 |
|
following command:</t> |
7645 |
|
<t> |
7646 |
|
<list> |
7647 |
|
<t>LIST SEND_EFFECT_CHAINS <audio-device></t> |
7648 |
|
</list> |
7649 |
|
</t> |
7650 |
|
<t>Where <audio-device> should be replaced by the |
7651 |
|
numerical ID of the audio output device as given by the |
7652 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7653 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7654 |
|
command.</t> |
7655 |
|
|
7656 |
|
<t>Possible Answers:</t> |
7657 |
|
<t> |
7658 |
|
<list> |
7659 |
|
<t>The sampler will answer by returning a comma |
7660 |
|
separated list with numerical IDs of send effect |
7661 |
|
chains of the supplied audio output device. |
7662 |
|
</t> |
7663 |
|
</list> |
7664 |
|
</t> |
7665 |
|
|
7666 |
|
<t>Examples:</t> |
7667 |
|
<t> |
7668 |
|
<list> |
7669 |
|
<t>C: "LIST SEND_EFFECT_CHAINS 0"</t> |
7670 |
|
<t>S: "3,4,7"</t> |
7671 |
|
</list> |
7672 |
|
</t> |
7673 |
|
</section> |
7674 |
|
|
7675 |
|
<section title="Add send effect chain" anchor="ADD SEND_EFFECT_CHAIN"> |
7676 |
|
<t>The front-end can add a send effect chain by sending the |
7677 |
|
following command:</t> |
7678 |
|
<t> |
7679 |
|
<list> |
7680 |
|
<t>ADD SEND_EFFECT_CHAIN <audio-device></t> |
7681 |
|
</list> |
7682 |
|
</t> |
7683 |
|
<t>Where <audio-device> should be replaced by the |
7684 |
|
numerical ID of the audio output device as given by the |
7685 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7686 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7687 |
|
command.</t> |
7688 |
|
|
7689 |
|
<t>Possible Answers:</t> |
7690 |
|
<t> |
7691 |
|
<list> |
7692 |
|
<t>"OK[<effect-chain>]" - |
7693 |
|
<list> |
7694 |
|
<t>in case the send effect chain was |
7695 |
|
added successfully, where |
7696 |
|
<effect-chain> is the numerical ID |
7697 |
|
of the new send effect chain</t> |
7698 |
|
</list> |
7699 |
|
</t> |
7700 |
|
<t>"ERR:<error-code>:<error-message>" - |
7701 |
|
<list> |
7702 |
|
<t>if the send effect chain could not be added</t> |
7703 |
|
</list> |
7704 |
|
</t> |
7705 |
|
</list> |
7706 |
|
</t> |
7707 |
|
|
7708 |
|
<t>Examples:</t> |
7709 |
|
<t> |
7710 |
|
<list> |
7711 |
|
<t>C: "ADD SEND_EFFECT_CHAIN 0"</t> |
7712 |
|
<t>S: "OK[2]"</t> |
7713 |
|
</list> |
7714 |
|
</t> |
7715 |
|
</section> |
7716 |
|
|
7717 |
|
<section title="Remove send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN"> |
7718 |
|
<t>The front-end can remove a send effect chain by sending |
7719 |
|
the following command:</t> |
7720 |
|
<t> |
7721 |
|
<list> |
7722 |
|
<t>REMOVE SEND_EFFECT_CHAIN <audio-device> <effect-chain></t> |
7723 |
|
</list> |
7724 |
|
</t> |
7725 |
|
<t>Where <audio-device> should be replaced by the |
7726 |
|
numerical ID of the audio output device as given by the |
7727 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7728 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7729 |
|
command and <effect-chain> by the numerical ID as |
7730 |
|
returned by the |
7731 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7732 |
|
or |
7733 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7734 |
|
command.</t> |
7735 |
|
|
7736 |
|
<t>Possible Answers:</t> |
7737 |
|
<t> |
7738 |
|
<list> |
7739 |
|
<t>"OK" - |
7740 |
|
<list> |
7741 |
|
<t>in case the send effect chain was |
7742 |
|
removed successfully</t> |
7743 |
|
</list> |
7744 |
|
</t> |
7745 |
|
<t>"ERR:<error-code>:<error-message>" - |
7746 |
|
<list> |
7747 |
|
<t>if the send effect chain could not be removed</t> |
7748 |
|
</list> |
7749 |
|
</t> |
7750 |
|
</list> |
7751 |
|
</t> |
7752 |
|
|
7753 |
|
<t>Examples:</t> |
7754 |
|
<t> |
7755 |
|
<list> |
7756 |
|
<t>C: "REMOVE SEND_EFFECT_CHAIN 0 2"</t> |
7757 |
|
<t>S: "OK"</t> |
7758 |
|
</list> |
7759 |
|
</t> |
7760 |
|
</section> |
7761 |
|
|
7762 |
|
<section title="Retrieving information about a send effect chain" anchor="GET SEND_EFFECT_CHAIN INFO"> |
7763 |
|
<t>The front-end can ask for informations of a send effect |
7764 |
|
chain by sending the following command:</t> |
7765 |
|
<t> |
7766 |
|
<list> |
7767 |
|
<t>GET SEND_EFFECT_CHAIN INFO <audio-device> <effect-chain></t> |
7768 |
|
</list> |
7769 |
|
</t> |
7770 |
|
<t>Where <audio-device> should be replaced by the |
7771 |
|
numerical ID of the audio output device as given by the |
7772 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7773 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7774 |
|
command and <effect-chain> by the numerical ID as |
7775 |
|
returned by the |
7776 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7777 |
|
or |
7778 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7779 |
|
command.</t> |
7780 |
|
|
7781 |
|
<t>Possible Answers:</t> |
7782 |
|
<t> |
7783 |
|
<list> |
7784 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
7785 |
|
Each answer line begins with the information |
7786 |
|
category name, followed by a colon and then a space |
7787 |
|
character <SP> and finally the info character |
7788 |
|
string to that information category. |
7789 |
|
At the moment the following categories are defined:</t> |
7790 |
|
<t> |
7791 |
|
<list> |
7792 |
|
<t>EFFECT_COUNT - |
7793 |
|
<list> |
7794 |
|
<t>amount of effects in this send |
7795 |
|
effect chain</t> |
7796 |
|
</list> |
7797 |
|
</t> |
7798 |
|
<t>EFFECT_SEQUENCE - |
7799 |
|
<list> |
7800 |
|
<t>comma separated list of the |
7801 |
|
numerical IDs of the effect |
7802 |
|
instances in this send effect chain, |
7803 |
|
in the order as they are procssed in |
7804 |
|
the effect chain</t> |
7805 |
|
</list> |
7806 |
|
</t> |
7807 |
|
</list> |
7808 |
|
</t> |
7809 |
|
</list> |
7810 |
|
</t> |
7811 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
7812 |
|
|
7813 |
|
<t>Example:</t> |
7814 |
|
<t> |
7815 |
|
<list> |
7816 |
|
<t>C: "GET SEND_EFFECT_CHAIN INFO 0 2"</t> |
7817 |
|
<t>S: "EFFECT_COUNT: 3"</t> |
7818 |
|
<t> "EFFECT_SEQUENCE: 31,4,7"</t> |
7819 |
|
<t> "."</t> |
7820 |
|
</list> |
7821 |
|
</t> |
7822 |
|
</section> |
7823 |
|
|
7824 |
|
<section title="Append effect instance to a send effect chain" anchor="APPEND SEND_EFFECT_CHAIN EFFECT"> |
7825 |
|
<t>The front-end can add an unused effect instance to the |
7826 |
|
end of a send effect chain by sending the following command:</t> |
7827 |
|
<t> |
7828 |
|
<list> |
7829 |
|
<t>APPEND SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <effect-instance></t> |
7830 |
|
</list> |
7831 |
|
</t> |
7832 |
|
<t>Where <audio-device> should be replaced by the |
7833 |
|
numerical ID of the audio output device as given by the |
7834 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7835 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7836 |
|
command and <effect-chain> by the numerical ID as |
7837 |
|
returned by the |
7838 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7839 |
|
or |
7840 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7841 |
|
command and <effect-instance> as returned by the |
7842 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
7843 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7844 |
|
command.</t> |
7845 |
|
<t>Only unused effect instances can be added to the effect |
7846 |
|
chain. Trying to add an effect instance which is already in |
7847 |
|
use somewhere in the audio signal path of the sampler will |
7848 |
|
result in an error.</t> |
7849 |
|
|
7850 |
|
<t>Possible Answers:</t> |
7851 |
|
<t> |
7852 |
|
<list> |
7853 |
|
<t>"OK" - |
7854 |
|
<list> |
7855 |
|
<t>in case the effect instance was |
7856 |
|
added successfully to the chain</t> |
7857 |
|
</list> |
7858 |
|
</t> |
7859 |
|
<t>"ERR:<error-code>:<error-message>" - |
7860 |
|
<list> |
7861 |
|
<t>if the effect instance could not be added</t> |
7862 |
|
</list> |
7863 |
|
</t> |
7864 |
|
</list> |
7865 |
|
</t> |
7866 |
|
|
7867 |
|
<t>Examples:</t> |
7868 |
|
<t> |
7869 |
|
<list> |
7870 |
|
<t>C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38"</t> |
7871 |
|
<t>S: "OK"</t> |
7872 |
|
</list> |
7873 |
|
</t> |
7874 |
|
</section> |
7875 |
|
|
7876 |
|
<section title="Insert effect instance to a send effect chain" anchor="INSERT SEND_EFFECT_CHAIN EFFECT"> |
7877 |
|
<t>The front-end can add an unused effect instance to a |
7878 |
|
certain position of a send effect chain by sending the |
7879 |
|
following command:</t> |
7880 |
|
<t> |
7881 |
|
<list> |
7882 |
|
<t>INSERT SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos> <effect-instance></t> |
7883 |
|
</list> |
7884 |
|
</t> |
7885 |
|
<t>Where <audio-device> should be replaced by the |
7886 |
|
numerical ID of the audio output device as given by the |
7887 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7888 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7889 |
|
command, <effect-chain> by the numerical ID as |
7890 |
|
returned by the |
7891 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7892 |
|
or |
7893 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7894 |
|
command, <effect-instance> as returned by the |
7895 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
7896 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7897 |
|
command and <chain-pos> the exact position of the |
7898 |
|
effect chain where the supplied effect shall be inserted |
7899 |
|
to.</t> |
7900 |
|
<t>Only unused effect instances can be added to the effect |
7901 |
|
chain. Trying to add an effect instance which is already in |
7902 |
|
use somewhere in the audio signal path of the sampler will |
7903 |
|
result in an error.</t> |
7904 |
|
|
7905 |
|
<t>Possible Answers:</t> |
7906 |
|
<t> |
7907 |
|
<list> |
7908 |
|
<t>"OK" - |
7909 |
|
<list> |
7910 |
|
<t>in case the effect instance was |
7911 |
|
added successfully to the chain</t> |
7912 |
|
</list> |
7913 |
|
</t> |
7914 |
|
<t>"ERR:<error-code>:<error-message>" - |
7915 |
|
<list> |
7916 |
|
<t>if the effect instance could not be added</t> |
7917 |
|
</list> |
7918 |
|
</t> |
7919 |
|
</list> |
7920 |
|
</t> |
7921 |
|
|
7922 |
|
<t>Examples:</t> |
7923 |
|
<t> |
7924 |
|
<list> |
7925 |
|
<t>C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38"</t> |
7926 |
|
<t>S: "OK"</t> |
7927 |
|
</list> |
7928 |
|
</t> |
7929 |
|
</section> |
7930 |
|
|
7931 |
|
<section title="Remove effect instance from send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN EFFECT"> |
7932 |
|
<t>The front-end can remove an effect instance from a |
7933 |
|
certain position of a send effect chain by sending the |
7934 |
|
following command:</t> |
7935 |
|
<t> |
7936 |
|
<list> |
7937 |
|
<t>REMOVE SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos></t> |
7938 |
|
</list> |
7939 |
|
</t> |
7940 |
|
<t>Where <audio-device> should be replaced by the |
7941 |
|
numerical ID of the audio output device as given by the |
7942 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7943 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7944 |
|
command, <effect-chain> by the numerical ID as |
7945 |
|
returned by the |
7946 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7947 |
|
or |
7948 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7949 |
|
command and <chain-pos> the exact position of the |
7950 |
|
effect instance to be removed from the effect chain.</t> |
7951 |
|
|
7952 |
|
<t>Possible Answers:</t> |
7953 |
|
<t> |
7954 |
|
<list> |
7955 |
|
<t>"OK" - |
7956 |
|
<list> |
7957 |
|
<t>in case the effect instance was |
7958 |
|
removed successfully</t> |
7959 |
|
</list> |
7960 |
|
</t> |
7961 |
|
<t>"ERR:<error-code>:<error-message>" - |
7962 |
|
<list> |
7963 |
|
<t>if the effect instance could not be removed</t> |
7964 |
|
</list> |
7965 |
|
</t> |
7966 |
|
</list> |
7967 |
|
</t> |
7968 |
|
|
7969 |
|
<t>Examples:</t> |
7970 |
|
<t> |
7971 |
|
<list> |
7972 |
|
<t>C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4"</t> |
7973 |
|
<t>S: "OK"</t> |
7974 |
|
</list> |
7975 |
|
</t> |
7976 |
|
</section> |
7977 |
|
|
7978 |
|
</section> |
7979 |
|
</section> |
7980 |
|
|
7981 |
<section title="Command Syntax" anchor="command_syntax"> |
<section title="Command Syntax" anchor="command_syntax"> |
7982 |
<t>The grammar of the control protocol as descibed in <xref target="control_commands"/> |
<t>The grammar of the control protocol as descibed in <xref target="control_commands"/> |
8050 |
</t> |
</t> |
8051 |
<t>/ UNSUBSCRIBE SP unsubscribe_event |
<t>/ UNSUBSCRIBE SP unsubscribe_event |
8052 |
</t> |
</t> |
|
<t>/ SELECT SP text |
|
|
</t> |
|
8053 |
<t>/ RESET SP reset_instruction |
<t>/ RESET SP reset_instruction |
8054 |
</t> |
</t> |
8055 |
<t>/ CLEAR SP clear_instruction |
<t>/ CLEAR SP clear_instruction |
8056 |
</t> |
</t> |
8057 |
|
<t>/ FIND SP find_instruction |
8058 |
|
</t> |
8059 |
|
<t>/ MOVE SP move_instruction |
8060 |
|
</t> |
8061 |
|
<t>/ COPY SP copy_instruction |
8062 |
|
</t> |
8063 |
|
<t>/ EDIT SP edit_instruction |
8064 |
|
</t> |
8065 |
|
<t>/ FORMAT SP format_instruction |
8066 |
|
</t> |
8067 |
|
<t>/ SEND SP send_instruction |
8068 |
|
</t> |
8069 |
|
<t>/ APPEND SP append_instruction |
8070 |
|
</t> |
8071 |
|
<t>/ INSERT SP insert_instruction |
8072 |
|
</t> |
8073 |
<t>/ RESET |
<t>/ RESET |
8074 |
</t> |
</t> |
8075 |
<t>/ QUIT |
<t>/ QUIT |
8080 |
<list> |
<list> |
8081 |
<t>CHANNEL |
<t>CHANNEL |
8082 |
</t> |
</t> |
8083 |
|
<t>/ CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index |
8084 |
|
</t> |
8085 |
|
<t>/ CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index |
8086 |
|
</t> |
8087 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
8088 |
|
</t> |
8089 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
8090 |
|
</t> |
8091 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
8092 |
|
</t> |
8093 |
|
<t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
8094 |
|
</t> |
8095 |
|
<t>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
8096 |
|
</t> |
8097 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
8098 |
|
</t> |
8099 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index |
8100 |
|
</t> |
8101 |
|
<t>/ DB_INSTRUMENTS SP db_path SP filename |
8102 |
|
</t> |
8103 |
|
<t>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index |
8104 |
|
</t> |
8105 |
<t>/ MIDI_INSTRUMENT_MAP |
<t>/ MIDI_INSTRUMENT_MAP |
8106 |
</t> |
</t> |
8107 |
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
8108 |
</t> |
</t> |
8109 |
|
<t>/ SEND_EFFECT_CHAIN SP device_index |
8110 |
|
</t> |
8111 |
</list> |
</list> |
8112 |
</t> |
</t> |
8113 |
<t>subscribe_event = |
<t>subscribe_event = |
8122 |
</t> |
</t> |
8123 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
8124 |
</t> |
</t> |
8125 |
|
<t>/ CHANNEL_MIDI |
8126 |
|
</t> |
8127 |
|
<t>/ DEVICE_MIDI |
8128 |
|
</t> |
8129 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
8130 |
</t> |
</t> |
8131 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
8146 |
</t> |
</t> |
8147 |
<t>/ MIDI_INSTRUMENT_INFO |
<t>/ MIDI_INSTRUMENT_INFO |
8148 |
</t> |
</t> |
8149 |
|
<t>/ DB_INSTRUMENT_DIRECTORY_COUNT |
8150 |
|
</t> |
8151 |
|
<t>/ DB_INSTRUMENT_DIRECTORY_INFO |
8152 |
|
</t> |
8153 |
|
<t>/ DB_INSTRUMENT_COUNT |
8154 |
|
</t> |
8155 |
|
<t>/ DB_INSTRUMENT_INFO |
8156 |
|
</t> |
8157 |
|
<t>/ DB_INSTRUMENTS_JOB_INFO |
8158 |
|
</t> |
8159 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
8160 |
</t> |
</t> |
8161 |
|
<t>/ TOTAL_STREAM_COUNT |
8162 |
|
</t> |
8163 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
8164 |
</t> |
</t> |
8165 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
8166 |
</t> |
</t> |
8167 |
|
<t>/ EFFECT_INSTANCE_COUNT |
8168 |
|
</t> |
8169 |
|
<t>/ EFFECT_INSTANCE_INFO |
8170 |
|
</t> |
8171 |
|
<t>/ SEND_EFFECT_CHAIN_COUNT |
8172 |
|
</t> |
8173 |
|
<t>/ SEND_EFFECT_CHAIN_INFO |
8174 |
|
</t> |
8175 |
</list> |
</list> |
8176 |
</t> |
</t> |
8177 |
<t>unsubscribe_event = |
<t>unsubscribe_event = |
8186 |
</t> |
</t> |
8187 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
8188 |
</t> |
</t> |
8189 |
|
<t>/ CHANNEL_MIDI |
8190 |
|
</t> |
8191 |
|
<t>/ DEVICE_MIDI |
8192 |
|
</t> |
8193 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
8194 |
</t> |
</t> |
8195 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
8210 |
</t> |
</t> |
8211 |
<t>/ MIDI_INSTRUMENT_INFO |
<t>/ MIDI_INSTRUMENT_INFO |
8212 |
</t> |
</t> |
8213 |
|
<t>/ DB_INSTRUMENT_DIRECTORY_COUNT |
8214 |
|
</t> |
8215 |
|
<t>/ DB_INSTRUMENT_DIRECTORY_INFO |
8216 |
|
</t> |
8217 |
|
<t>/ DB_INSTRUMENT_COUNT |
8218 |
|
</t> |
8219 |
|
<t>/ DB_INSTRUMENT_INFO |
8220 |
|
</t> |
8221 |
|
<t>/ DB_INSTRUMENTS_JOB_INFO |
8222 |
|
</t> |
8223 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
8224 |
</t> |
</t> |
8225 |
|
<t>/ TOTAL_STREAM_COUNT |
8226 |
|
</t> |
8227 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
8228 |
</t> |
</t> |
8229 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
8230 |
</t> |
</t> |
8231 |
|
<t>/ EFFECT_INSTANCE_COUNT |
8232 |
|
</t> |
8233 |
|
<t>/ EFFECT_INSTANCE_INFO |
8234 |
|
</t> |
8235 |
|
<t>/ SEND_EFFECT_CHAIN_COUNT |
8236 |
|
</t> |
8237 |
|
<t>/ SEND_EFFECT_CHAIN_INFO |
8238 |
|
</t> |
8239 |
</list> |
</list> |
8240 |
</t> |
</t> |
8241 |
<t>map_instruction = |
<t>map_instruction = |
8260 |
<list> |
<list> |
8261 |
<t>CHANNEL SP sampler_channel |
<t>CHANNEL SP sampler_channel |
8262 |
</t> |
</t> |
8263 |
|
<t>/ CHANNEL SP MIDI_INPUT SP sampler_channel |
8264 |
|
</t> |
8265 |
|
<t>/ CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index |
8266 |
|
</t> |
8267 |
|
<t>/ CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index |
8268 |
|
</t> |
8269 |
<t>/ MIDI_INSTRUMENT_MAP SP midi_map |
<t>/ MIDI_INSTRUMENT_MAP SP midi_map |
8270 |
</t> |
</t> |
8271 |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
8272 |
</t> |
</t> |
8273 |
|
<t>/ SEND_EFFECT_CHAIN SP device_index SP effect_chain |
8274 |
|
</t> |
8275 |
|
<t>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos |
8276 |
|
</t> |
8277 |
|
<t>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id |
8278 |
|
</t> |
8279 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
8280 |
|
</t> |
8281 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
8282 |
|
</t> |
8283 |
|
<t>/ DB_INSTRUMENT SP db_path |
8284 |
|
</t> |
8285 |
</list> |
</list> |
8286 |
</t> |
</t> |
8287 |
<t>get_instruction = |
<t>get_instruction = |
8288 |
<list> |
<list> |
8289 |
<t>AVAILABLE_ENGINES |
<t>AVAILABLE_ENGINES |
8290 |
</t> |
</t> |
8291 |
|
<t>/ AVAILABLE_EFFECTS |
8292 |
|
</t> |
8293 |
|
<t>/ EFFECT_INSTANCES |
8294 |
|
</t> |
8295 |
|
<t>/ EFFECT SP INFO SP effect_index |
8296 |
|
</t> |
8297 |
|
<t>/ EFFECT_INSTANCE SP INFO SP effect_instance |
8298 |
|
</t> |
8299 |
|
<t>/ EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP input_control |
8300 |
|
</t> |
8301 |
|
<t>/ SEND_EFFECT_CHAINS SP device_index |
8302 |
|
</t> |
8303 |
|
<t>/ SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain |
8304 |
|
</t> |
8305 |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
8306 |
</t> |
</t> |
8307 |
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
8348 |
</t> |
</t> |
8349 |
<t>/ SERVER SP INFO |
<t>/ SERVER SP INFO |
8350 |
</t> |
</t> |
8351 |
|
<t>/ TOTAL_STREAM_COUNT |
8352 |
|
</t> |
8353 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
8354 |
</t> |
</t> |
8355 |
<t>/ TOTAL_VOICE_COUNT_MAX |
<t>/ TOTAL_VOICE_COUNT_MAX |
8368 |
</t> |
</t> |
8369 |
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
8370 |
</t> |
</t> |
8371 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
8372 |
|
</t> |
8373 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
8374 |
|
</t> |
8375 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path |
8376 |
|
</t> |
8377 |
|
<t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
8378 |
|
</t> |
8379 |
|
<t>/ DB_INSTRUMENTS SP db_path |
8380 |
|
</t> |
8381 |
|
<t>/ DB_INSTRUMENT SP INFO SP db_path |
8382 |
|
</t> |
8383 |
|
<t>/ DB_INSTRUMENTS_JOB SP INFO SP number |
8384 |
|
</t> |
8385 |
<t>/ VOLUME |
<t>/ VOLUME |
8386 |
</t> |
</t> |
8387 |
|
<t>/ VOICES |
8388 |
|
</t> |
8389 |
|
<t>/ STREAMS |
8390 |
|
</t> |
8391 |
|
<t>/ FILE SP INSTRUMENTS SP filename |
8392 |
|
</t> |
8393 |
|
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
8394 |
|
</t> |
8395 |
</list> |
</list> |
8396 |
</t> |
</t> |
8397 |
<t>set_instruction = |
<t>set_instruction = |
8402 |
</t> |
</t> |
8403 |
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
8404 |
</t> |
</t> |
8405 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE |
8406 |
|
</t> |
8407 |
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
8408 |
</t> |
</t> |
8409 |
|
<t>/ EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP input_control SP control_value |
8410 |
|
</t> |
8411 |
<t>/ CHANNEL SP set_chan_instruction |
<t>/ CHANNEL SP set_chan_instruction |
8412 |
</t> |
</t> |
8413 |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
8420 |
</t> |
</t> |
8421 |
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
8422 |
</t> |
</t> |
8423 |
|
<t>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos |
8424 |
|
</t> |
8425 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
8426 |
|
</t> |
8427 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped |
8428 |
|
</t> |
8429 |
|
<t>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped |
8430 |
|
</t> |
8431 |
|
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
8432 |
|
</t> |
8433 |
|
<t>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename |
8434 |
|
</t> |
8435 |
<t>/ ECHO SP boolean |
<t>/ ECHO SP boolean |
8436 |
</t> |
</t> |
8437 |
<t>/ VOLUME SP volume_value |
<t>/ VOLUME SP volume_value |
8438 |
</t> |
</t> |
8439 |
|
<t>/ VOICES SP number |
8440 |
|
</t> |
8441 |
|
<t>/ STREAMS SP number |
8442 |
|
</t> |
8443 |
</list> |
</list> |
8444 |
</t> |
</t> |
8445 |
<t>create_instruction = |
<t>create_instruction = |
8456 |
</t> |
</t> |
8457 |
<t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
<t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
8458 |
</t> |
</t> |
8459 |
|
<t>/ EFFECT_INSTANCE SP effect_index |
8460 |
|
</t> |
8461 |
|
<t>/ EFFECT_INSTANCE SP effect_system SP module SP effect_name |
8462 |
|
</t> |
8463 |
</list> |
</list> |
8464 |
</t> |
</t> |
8465 |
<t>reset_instruction = |
<t>reset_instruction = |
8476 |
</t> |
</t> |
8477 |
</list> |
</list> |
8478 |
</t> |
</t> |
8479 |
|
<t>find_instruction = |
8480 |
|
<list> |
8481 |
|
<t>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list |
8482 |
|
</t> |
8483 |
|
<t>/ DB_INSTRUMENTS SP db_path SP query_val_list |
8484 |
|
</t> |
8485 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list |
8486 |
|
</t> |
8487 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
8488 |
|
</t> |
8489 |
|
<t>/ LOST SP DB_INSTRUMENT_FILES |
8490 |
|
</t> |
8491 |
|
</list> |
8492 |
|
</t> |
8493 |
|
<t>move_instruction = |
8494 |
|
<list> |
8495 |
|
<t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
8496 |
|
</t> |
8497 |
|
<t>/ DB_INSTRUMENT SP db_path SP db_path |
8498 |
|
</t> |
8499 |
|
</list> |
8500 |
|
</t> |
8501 |
|
<t>copy_instruction = |
8502 |
|
<list> |
8503 |
|
<t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
8504 |
|
</t> |
8505 |
|
<t>/ DB_INSTRUMENT SP db_path SP db_path |
8506 |
|
</t> |
8507 |
|
</list> |
8508 |
|
</t> |
8509 |
<t>destroy_instruction = |
<t>destroy_instruction = |
8510 |
<list> |
<list> |
8511 |
<t>AUDIO_OUTPUT_DEVICE SP number |
<t>AUDIO_OUTPUT_DEVICE SP number |
8514 |
</t> |
</t> |
8515 |
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
8516 |
</t> |
</t> |
8517 |
|
<t>/ EFFECT_INSTANCE SP number |
8518 |
|
</t> |
8519 |
</list> |
</list> |
8520 |
</t> |
</t> |
8521 |
<t>load_instruction = |
<t>load_instruction = |
8526 |
</t> |
</t> |
8527 |
</list> |
</list> |
8528 |
</t> |
</t> |
8529 |
|
<t>append_instruction = |
8530 |
|
<list> |
8531 |
|
<t>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP effect_instance |
8532 |
|
</t> |
8533 |
|
</list> |
8534 |
|
</t> |
8535 |
|
<t>insert_instruction = |
8536 |
|
<list> |
8537 |
|
<t>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos SP effect_instance |
8538 |
|
</t> |
8539 |
|
</list> |
8540 |
|
</t> |
8541 |
<t>set_chan_instruction = |
<t>set_chan_instruction = |
8542 |
<list> |
<list> |
8543 |
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
8570 |
</t> |
</t> |
8571 |
</list> |
</list> |
8572 |
</t> |
</t> |
8573 |
|
<t>edit_instruction = |
8574 |
|
<list> |
8575 |
|
<t>CHANNEL SP INSTRUMENT SP sampler_channel |
8576 |
|
</t> |
8577 |
|
</list> |
8578 |
|
</t> |
8579 |
|
<t>format_instruction = |
8580 |
|
<list> |
8581 |
|
<t>INSTRUMENTS_DB |
8582 |
|
</t> |
8583 |
|
</list> |
8584 |
|
</t> |
8585 |
<t>modal_arg = |
<t>modal_arg = |
8586 |
<list> |
<list> |
8587 |
<t>/* epsilon (empty argument) */ |
<t>/* epsilon (empty argument) */ |
8614 |
</t> |
</t> |
8615 |
<t>/ CHANNELS |
<t>/ CHANNELS |
8616 |
</t> |
</t> |
8617 |
|
<t>/ CHANNEL SP MIDI_INPUTS SP sampler_channel |
8618 |
|
</t> |
8619 |
<t>/ AVAILABLE_ENGINES |
<t>/ AVAILABLE_ENGINES |
8620 |
</t> |
</t> |
8621 |
|
<t>/ AVAILABLE_EFFECTS |
8622 |
|
</t> |
8623 |
|
<t>/ EFFECT_INSTANCES |
8624 |
|
</t> |
8625 |
|
<t>/ SEND_EFFECT_CHAINS SP number |
8626 |
|
</t> |
8627 |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
8628 |
</t> |
</t> |
8629 |
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
8636 |
</t> |
</t> |
8637 |
<t>/ FX_SENDS SP sampler_channel |
<t>/ FX_SENDS SP sampler_channel |
8638 |
</t> |
</t> |
8639 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
8640 |
|
</t> |
8641 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
8642 |
|
</t> |
8643 |
|
<t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
8644 |
|
</t> |
8645 |
|
<t>/ DB_INSTRUMENTS SP db_path |
8646 |
|
</t> |
8647 |
|
<t>/ FILE SP INSTRUMENTS SP filename |
8648 |
|
</t> |
8649 |
|
</list> |
8650 |
|
</t> |
8651 |
|
<t>send_instruction = |
8652 |
|
<list> |
8653 |
|
<t>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number |
8654 |
|
</t> |
8655 |
</list> |
</list> |
8656 |
</t> |
</t> |
8657 |
<t>load_instr_args = |
<t>load_instr_args = |
8678 |
</t> |
</t> |
8679 |
</list> |
</list> |
8680 |
</t> |
</t> |
8681 |
|
<t>effect_instance = |
8682 |
|
<list> |
8683 |
|
<t>number |
8684 |
|
</t> |
8685 |
|
</list> |
8686 |
|
</t> |
8687 |
<t>device_index = |
<t>device_index = |
8688 |
<list> |
<list> |
8689 |
<t>number |
<t>number |
8754 |
</t> |
</t> |
8755 |
</list> |
</list> |
8756 |
</t> |
</t> |
8757 |
|
<t>control_value = |
8758 |
|
<list> |
8759 |
|
<t>real |
8760 |
|
</t> |
8761 |
|
</list> |
8762 |
|
</t> |
8763 |
<t>sampler_channel = |
<t>sampler_channel = |
8764 |
<list> |
<list> |
8765 |
<t>number |
<t>number |
8786 |
</t> |
</t> |
8787 |
<t>filename = |
<t>filename = |
8788 |
<list> |
<list> |
8789 |
<t>stringval |
<t>path |
8790 |
|
</t> |
8791 |
|
</list> |
8792 |
|
</t> |
8793 |
|
<t>db_path = |
8794 |
|
<list> |
8795 |
|
<t>path |
8796 |
</t> |
</t> |
8797 |
</list> |
</list> |
8798 |
</t> |
</t> |
8799 |
<t>map_name = |
<t>map_name = |
8800 |
<list> |
<list> |
8801 |
<t>stringval |
<t>stringval_escaped |
8802 |
</t> |
</t> |
8803 |
</list> |
</list> |
8804 |
</t> |
</t> |
8805 |
<t>entry_name = |
<t>entry_name = |
8806 |
<list> |
<list> |
8807 |
<t>stringval |
<t>stringval_escaped |
8808 |
</t> |
</t> |
8809 |
</list> |
</list> |
8810 |
</t> |
</t> |
8811 |
<t>fx_send_name = |
<t>fx_send_name = |
8812 |
<list> |
<list> |
8813 |
<t>stringval |
<t>stringval_escaped |
8814 |
|
</t> |
8815 |
|
</list> |
8816 |
|
</t> |
8817 |
|
<t>effect_name = |
8818 |
|
<list> |
8819 |
|
<t>stringval_escaped |
8820 |
|
</t> |
8821 |
|
</list> |
8822 |
|
</t> |
8823 |
|
<t>effect_index = |
8824 |
|
<list> |
8825 |
|
<t>number |
8826 |
|
</t> |
8827 |
|
</list> |
8828 |
|
</t> |
8829 |
|
<t>effect_chain = |
8830 |
|
<list> |
8831 |
|
<t>number |
8832 |
|
</t> |
8833 |
|
</list> |
8834 |
|
</t> |
8835 |
|
<t>chain_pos = |
8836 |
|
<list> |
8837 |
|
<t>number |
8838 |
|
</t> |
8839 |
|
</list> |
8840 |
|
</t> |
8841 |
|
<t>input_control = |
8842 |
|
<list> |
8843 |
|
<t>number |
8844 |
</t> |
</t> |
8845 |
</list> |
</list> |
8846 |
</t> |
</t> |
8852 |
</t> |
</t> |
8853 |
</list> |
</list> |
8854 |
</t> |
</t> |
8855 |
|
|
8856 |
<t>param_val = |
<t>param_val = |
8857 |
<list> |
<list> |
8858 |
<t>string |
<t>string |
8865 |
</t> |
</t> |
8866 |
</list> |
</list> |
8867 |
</t> |
</t> |
8868 |
|
<t>query_val_list = |
8869 |
|
<list> |
8870 |
|
<t>string '=' query_val |
8871 |
|
</t> |
8872 |
|
<t>/ query_val_list SP string '=' query_val |
8873 |
|
</t> |
8874 |
|
</list> |
8875 |
|
</t> |
8876 |
|
<t>query_val = |
8877 |
|
<list> |
8878 |
|
<t>text_escaped |
8879 |
|
</t> |
8880 |
|
<t>/ stringval_escaped |
8881 |
|
</t> |
8882 |
|
</list> |
8883 |
|
</t> |
8884 |
|
<t>scan_mode = |
8885 |
|
<list> |
8886 |
|
<t>RECURSIVE |
8887 |
|
</t> |
8888 |
|
<t>/ NON_RECURSIVE |
8889 |
|
</t> |
8890 |
|
<t>/ FLAT |
8891 |
|
</t> |
8892 |
|
</list> |
8893 |
|
</t> |
8894 |
|
<t>effect_system = |
8895 |
|
<list> |
8896 |
|
<t>string |
8897 |
|
</t> |
8898 |
|
</list> |
8899 |
|
</t> |
8900 |
|
<t>module = |
8901 |
|
<list> |
8902 |
|
<t>filename |
8903 |
|
</t> |
8904 |
|
</list> |
8905 |
|
</t> |
8906 |
|
|
8907 |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
8908 |
|
|
8909 |
|
<section title="Character Set and Escape Sequences" anchor="character_set"> |
8910 |
|
<t>Older versions of this protocol up to and including v1.1 only |
8911 |
|
supported the standard ASCII character set (ASCII code 0 - 127) |
8912 |
|
<xref target="RFC20"/>, all younger versions of this protocol |
8913 |
|
however support the Extended ASCII character set (ASCII code |
8914 |
|
0 - 255). The same group of younger protocols also support |
8915 |
|
escape sequences, but only for certain, explicitly declared |
8916 |
|
parts of the protocol. The supported escape sequences are |
8917 |
|
defined as follows:</t> |
8918 |
|
<texttable> |
8919 |
|
<ttcol>ASCII Character Sequence</ttcol> |
8920 |
|
<ttcol>Translated into (Name)</ttcol> |
8921 |
|
<c>\n</c> <c>new line</c> |
8922 |
|
<c>\r</c> <c>carriage return</c> |
8923 |
|
<c>\f</c> <c>form feed</c> |
8924 |
|
<c>\t</c> <c>horizontal tab</c> |
8925 |
|
<c>\v</c> <c>vertical tab</c> |
8926 |
|
<c>\'</c> <c>apostrophe</c> |
8927 |
|
<c>\"</c> <c>quotation mark</c> |
8928 |
|
<c>\\</c> <c>backslash</c> |
8929 |
|
<c>\OOO</c> <c>three digit octal ASCII code of the character</c> |
8930 |
|
<c>\xHH</c> <c>two digit hex ASCII code of the character</c> |
8931 |
|
</texttable> |
8932 |
|
<t>Notice: due to the transition of certain parts of the |
8933 |
|
protocol which now support escape sequences, a slight backward |
8934 |
|
incompatibility to protocols version v1.1 and younger has been |
8935 |
|
introduced. The only difference is that in parts of the protocol |
8936 |
|
where escape characters are now supported, a backslash characters |
8937 |
|
MUST be escaped as well (that is as double backslash), whereas |
8938 |
|
in the old versions a single backslash was sufficient.</t> |
8939 |
|
|
8940 |
|
<t>The following LSCP commands support escape sequences as part |
8941 |
|
of their filename / path based arguments and / or may contain |
8942 |
|
a filename / path with escape sequences in their response: |
8943 |
|
<list> |
8944 |
|
<t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t> |
8945 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
8946 |
|
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
8947 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
8948 |
|
<t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t> |
8949 |
|
<t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t> |
8950 |
|
<t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
8951 |
|
<t><xref target="REMOVE DB_INSTRUMENT">"REMOVE DB_INSTRUMENT"</xref></t> |
8952 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORIES">"GET DB_INSTRUMENT_DIRECTORIES"</xref></t> |
8953 |
|
<t><xref target="LIST DB_INSTRUMENT_DIRECTORIES">"LIST DB_INSTRUMENT_DIRECTORIES"</xref></t> |
8954 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
8955 |
|
<t><xref target="GET DB_INSTRUMENTS">"GET DB_INSTRUMENTS"</xref></t> |
8956 |
|
<t><xref target="LIST DB_INSTRUMENTS">"LIST DB_INSTRUMENTS"</xref></t> |
8957 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
8958 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
8959 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
8960 |
|
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
8961 |
|
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
8962 |
|
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
8963 |
|
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
8964 |
|
<t><xref target="MOVE DB_INSTRUMENT">"MOVE DB_INSTRUMENT"</xref></t> |
8965 |
|
<t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
8966 |
|
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
8967 |
|
<t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t> |
8968 |
|
<t><xref target="FIND LOST DB_INSTRUMENT_FILES">"FIND LOST DB_INSTRUMENT_FILES"</xref></t> |
8969 |
|
<t><xref target="SET DB_INSTRUMENT FILE_PATH">"SET DB_INSTRUMENT FILE_PATH"</xref></t> |
8970 |
|
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
8971 |
|
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
8972 |
|
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
8973 |
|
<t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t> |
8974 |
|
<t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t> |
8975 |
|
<t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t> |
8976 |
|
</list> |
8977 |
|
Note that the forward slash character ('/') has a special meaning in |
8978 |
|
filename / path based arguments: it acts as separator of the nodes in |
8979 |
|
the path, thus if a directory- or filename includes a forward slash |
8980 |
|
(not intended as path node separator), you MUST escape that slash |
8981 |
|
either with the respective hex escape sequence ("\x2f") or with the |
8982 |
|
respective octal escape sequence ("\057"). |
8983 |
|
</t> |
8984 |
|
|
8985 |
|
<t> |
8986 |
|
Note for Windows: file path arguments in LSCP are expected |
8987 |
|
to use forward slashes as directory node separator similar |
8988 |
|
to Unix based operating systems. In contrast to Unix however |
8989 |
|
a Windows typical drive character is expected to be |
8990 |
|
prefixed to the path. That is an original Windows file path |
8991 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
8992 |
|
"D:/Sounds/My.gig". |
8993 |
|
</t> |
8994 |
|
|
8995 |
|
<t> |
8996 |
|
The following LSCP commands even support escape sequences as |
8997 |
|
part of at least one of their text-based arguments (i.e. entity name, |
8998 |
|
description) and / or may contain escape sequences in at least one of |
8999 |
|
their text-based fields in their response: |
9000 |
|
<list> |
9001 |
|
<t><xref target="GET SERVER INFO">"GET SERVER INFO"</xref></t> |
9002 |
|
<t><xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref></t> |
9003 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
9004 |
|
<t><xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref></t> |
9005 |
|
<t><xref target="GET FX_SEND INFO">"GET FX_SEND INFO"</xref></t> |
9006 |
|
<t><xref target="SET FX_SEND NAME">"SET FX_SEND NAME"</xref></t> |
9007 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
9008 |
|
<t><xref target="GET MIDI_INSTRUMENT_MAP INFO">"GET MIDI_INSTRUMENT_MAP INFO"</xref></t> |
9009 |
|
<t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t> |
9010 |
|
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
9011 |
|
<t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t> |
9012 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
9013 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
9014 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
9015 |
|
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
9016 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
9017 |
|
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
9018 |
|
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
9019 |
|
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
9020 |
|
<t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t> |
9021 |
|
<t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t> |
9022 |
|
<t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t> |
9023 |
|
</list> |
9024 |
|
Please note that these lists are manually maintained. If you |
9025 |
|
find a command that also supports escape sequences we forgot to |
9026 |
|
mention here, please report it! |
9027 |
|
</t> |
9028 |
|
</section> |
9029 |
</section> |
</section> |
9030 |
|
|
9031 |
<section title="Events" anchor="events"> |
<section title="Events" anchor="events"> |
9129 |
of sampler channels.</t> |
of sampler channels.</t> |
9130 |
</section> |
</section> |
9131 |
|
|
9132 |
|
<section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI"> |
9133 |
|
<t>Client may want to be notified when MIDI data arrive on sampler channels on |
9134 |
|
back-end side, by issuing the following command:</t> |
9135 |
|
<t> |
9136 |
|
<list> |
9137 |
|
<t>SUBSCRIBE CHANNEL_MIDI</t> |
9138 |
|
</list> |
9139 |
|
</t> |
9140 |
|
<t>Server will start sending one of the the following notification messages:</t> |
9141 |
|
<t> |
9142 |
|
<list> |
9143 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"</t> |
9144 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>"</t> |
9145 |
|
</list> |
9146 |
|
</t> |
9147 |
|
<t>where <channel-id> will be replaced by the ID of the sampler channel where the MIDI |
9148 |
|
data arrived. <note> and <velocity> are integer values in the range between |
9149 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
9150 |
|
</t> |
9151 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
9152 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
9153 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
9154 |
|
thread unaffected by this feature.</t> |
9155 |
|
</section> |
9156 |
|
|
9157 |
|
<section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI"> |
9158 |
|
<t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t> |
9159 |
|
<t> |
9160 |
|
<list> |
9161 |
|
<t>SUBSCRIBE DEVICE_MIDI</t> |
9162 |
|
</list> |
9163 |
|
</t> |
9164 |
|
<t>Server will start sending one of the the following notification messages:</t> |
9165 |
|
<t> |
9166 |
|
<list> |
9167 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note> <velocity>"</t> |
9168 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note> <velocity>"</t> |
9169 |
|
</list> |
9170 |
|
</t> |
9171 |
|
<t>where <device-id> <port-id> will be replaced |
9172 |
|
by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI |
9173 |
|
data arrived. <note> and <velocity> are integer values in the range between |
9174 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
9175 |
|
</t> |
9176 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
9177 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
9178 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
9179 |
|
thread unaffected by this feature.</t> |
9180 |
|
</section> |
9181 |
|
|
9182 |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
9183 |
<t>Client may want to be notified when the number of voices on the |
<t>Client may want to be notified when the number of voices on the |
9184 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
9261 |
</section> |
</section> |
9262 |
|
|
9263 |
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
9264 |
<t>Client may want to be notified when the number of effect sends on |
<t>Client may want to be notified when the number of effect sends on |
9265 |
a particular sampler channel is changed by issuing the following command:</t> |
a particular sampler channel is changed by issuing the following command:</t> |
9266 |
<t> |
<t> |
9267 |
<list> |
<list> |
9316 |
all currently active voices.</t> |
all currently active voices.</t> |
9317 |
</section> |
</section> |
9318 |
|
|
9319 |
|
<section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT"> |
9320 |
|
<t>Client may want to be notified when the total number of disk streams on the |
9321 |
|
back-end changes by issuing the following command:</t> |
9322 |
|
<t> |
9323 |
|
<list> |
9324 |
|
<t>SUBSCRIBE TOTAL_STREAM_COUNT</t> |
9325 |
|
</list> |
9326 |
|
</t> |
9327 |
|
<t>Server will start sending the following notification messages:</t> |
9328 |
|
<t> |
9329 |
|
<list> |
9330 |
|
<t>"NOTIFY:TOTAL_STREAM_COUNT:<streams>"</t> |
9331 |
|
</list> |
9332 |
|
</t> |
9333 |
|
<t>where <streams> will be replaced by the new number of |
9334 |
|
all currently active disk streams.</t> |
9335 |
|
</section> |
9336 |
|
|
9337 |
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
9338 |
<t>Client may want to be notified when the number of MIDI instrument maps on the |
<t>Client may want to be notified when the number of MIDI instrument maps on the |
9339 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
9432 |
replaced by the optional dotted floating point value, reflecting the |
replaced by the optional dotted floating point value, reflecting the |
9433 |
new global volume parameter.</t> |
new global volume parameter.</t> |
9434 |
</list> |
</list> |
9435 |
|
<list> |
9436 |
|
<t>"NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the |
9437 |
|
golbal limit of the sampler for maximum voices is changed, where |
9438 |
|
<max-voices> will be an integer value, reflecting the |
9439 |
|
new global voice limit parameter.</t> |
9440 |
|
</list> |
9441 |
|
<list> |
9442 |
|
<t>"NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the |
9443 |
|
golbal limit of the sampler for maximum disk streams is changed, where |
9444 |
|
<max-streams> will be an integer value, reflecting the |
9445 |
|
new global disk streams limit parameter.</t> |
9446 |
|
</list> |
9447 |
|
</t> |
9448 |
|
</section> |
9449 |
|
|
9450 |
|
<section title="Number of database instrument directories changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"> |
9451 |
|
<t>Client may want to be notified when the number of instrument |
9452 |
|
directories in a particular directory in the instruments database |
9453 |
|
is changed by issuing the following command:</t> |
9454 |
|
<t> |
9455 |
|
<list> |
9456 |
|
<t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT</t> |
9457 |
|
</list> |
9458 |
|
</t> |
9459 |
|
<t>Server will start sending the following notification messages:</t> |
9460 |
|
<t> |
9461 |
|
<list> |
9462 |
|
<t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>"</t> |
9463 |
|
</list> |
9464 |
|
</t> |
9465 |
|
<t>where <dir-path> will be replaced by the absolute path |
9466 |
|
name of the directory in the instruments database, |
9467 |
|
in which the number of directories is changed.</t> |
9468 |
|
<t>Note that when a non-empty directory is removed, this event |
9469 |
|
is not sent for the subdirectories in that directory.</t> |
9470 |
|
</section> |
9471 |
|
|
9472 |
|
<section title="Database instrument directory information changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"> |
9473 |
|
<t>Client may want to be notified when changes were made to directories |
9474 |
|
in the instruments database by issuing the following command:</t> |
9475 |
|
<t> |
9476 |
|
<list> |
9477 |
|
<t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO</t> |
9478 |
|
</list> |
9479 |
|
</t> |
9480 |
|
<t>Server will start sending the following notification messages:</t> |
9481 |
|
<t> |
9482 |
|
<list> |
9483 |
|
<t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:<dir-path>"</t> |
9484 |
|
</list> |
9485 |
|
</t> |
9486 |
|
<t>where <dir-path> will be replaced by the absolute path name |
9487 |
|
of the directory, for which information changes occurred. The front-end will have to send |
9488 |
|
the respective command to actually get the updated directory info. Because these messages |
9489 |
|
will be triggered by LSCP commands issued by other clients rather than real |
9490 |
|
time events happening on the server, it is believed that an empty notification |
9491 |
|
message is sufficient here.</t> |
9492 |
|
<t> |
9493 |
|
<list> |
9494 |
|
<t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME <old-dir-path> <new-name>"</t> |
9495 |
|
</list> |
9496 |
|
</t> |
9497 |
|
<t>where <old-dir-path> is the old absolute path name of the directory |
9498 |
|
(encapsulated into apostrophes), which name is changes and <new-name> is |
9499 |
|
the new name of the directory, encapsulated into apostrophes.</t> |
9500 |
|
</section> |
9501 |
|
|
9502 |
|
<section title="Number of database instruments changed" anchor="SUBSCRIBE DB_INSTRUMENT_COUNT"> |
9503 |
|
<t>Client may want to be notified when the number of instruments |
9504 |
|
in a particular directory in the instruments database |
9505 |
|
is changed by issuing the following command:</t> |
9506 |
|
<t> |
9507 |
|
<list> |
9508 |
|
<t>SUBSCRIBE DB_INSTRUMENT_COUNT</t> |
9509 |
|
</list> |
9510 |
|
</t> |
9511 |
|
<t>Server will start sending the following notification messages:</t> |
9512 |
|
<t> |
9513 |
|
<list> |
9514 |
|
<t>"NOTIFY:DB_INSTRUMENT_COUNT:<dir-path>"</t> |
9515 |
|
</list> |
9516 |
|
</t> |
9517 |
|
<t>where <dir-path> will be replaced by the absolute path |
9518 |
|
name of the directory in the instruments database, |
9519 |
|
in which the number of instruments is changed.</t> |
9520 |
|
<t>Note that when a non-empty directory is removed, this event |
9521 |
|
is not sent for the instruments in that directory.</t> |
9522 |
|
</section> |
9523 |
|
|
9524 |
|
<section title="Database instrument information changed" anchor="SUBSCRIBE DB_INSTRUMENT_INFO"> |
9525 |
|
<t>Client may want to be notified when changes were made to instruments |
9526 |
|
in the instruments database by issuing the following command:</t> |
9527 |
|
<t> |
9528 |
|
<list> |
9529 |
|
<t>SUBSCRIBE DB_INSTRUMENT_INFO</t> |
9530 |
|
</list> |
9531 |
|
</t> |
9532 |
|
<t>Server will start sending the following notification messages:</t> |
9533 |
|
<t> |
9534 |
|
<list> |
9535 |
|
<t>"NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"</t> |
9536 |
|
</list> |
9537 |
|
</t> |
9538 |
|
<t>where <instr-path> will be replaced by the absolute path name |
9539 |
|
of the instrument, which settings are changed. The front-end will have to send |
9540 |
|
the respective command to actually get the updated directory info. Because these messages |
9541 |
|
will be triggered by LSCP commands issued by other clients rather than real |
9542 |
|
time events happening on the server, it is believed that an empty notification |
9543 |
|
message is sufficient here.</t> |
9544 |
|
<t> |
9545 |
|
<list> |
9546 |
|
<t>"NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"</t> |
9547 |
|
</list> |
9548 |
|
</t> |
9549 |
|
<t>where <old-instr-path> is the old absolute path name of the instrument |
9550 |
|
(encapsulated into apostrophes), which name is changes and <new-name> is |
9551 |
|
the new name of the instrument, encapsulated into apostrophes.</t> |
9552 |
|
</section> |
9553 |
|
|
9554 |
|
<section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"> |
9555 |
|
<t>Client may want to be notified when the status of particular database |
9556 |
|
instruments job is changed by issuing the following command:</t> |
9557 |
|
<t> |
9558 |
|
<list> |
9559 |
|
<t>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO</t> |
9560 |
|
</list> |
9561 |
|
</t> |
9562 |
|
<t>Server will start sending the following notification messages:</t> |
9563 |
|
<t> |
9564 |
|
<list> |
9565 |
|
<t>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>"</t> |
9566 |
|
</list> |
9567 |
|
</t> |
9568 |
|
<t>where <job-id> will be replaced by the numerical ID of the job, |
9569 |
|
which status is changed. The front-end will have to send the respective |
9570 |
|
command to actually get the status info. Because these messages |
9571 |
|
will be triggered by LSCP commands issued by other clients rather than real |
9572 |
|
time events happening on the server, it is believed that an empty notification |
9573 |
|
message is sufficient here.</t> |
9574 |
|
</section> |
9575 |
|
|
9576 |
|
<section title="Number of effect instances changed" anchor="SUBSCRIBE EFFECT_INSTANCE_COUNT"> |
9577 |
|
<t>Client may want to be notified when the number of effect instances |
9578 |
|
is changed by issuing the following command:</t> |
9579 |
|
<t> |
9580 |
|
<list> |
9581 |
|
<t>SUBSCRIBE EFFECT_INSTANCE_COUNT</t> |
9582 |
|
</list> |
9583 |
|
</t> |
9584 |
|
<t>Server will start sending the following notification messages:</t> |
9585 |
|
<t> |
9586 |
|
<list> |
9587 |
|
<t>"EFFECT_INSTANCE_COUNT:<instances>"</t> |
9588 |
|
</list> |
9589 |
|
</t> |
9590 |
|
<t>where <instances> will be replaced by the new number |
9591 |
|
of effect instances.</t> |
9592 |
|
</section> |
9593 |
|
|
9594 |
|
<section title="Effect instance information changed" anchor="SUBSCRIBE EFFECT_INSTANCE_INFO"> |
9595 |
|
<t>Client may want to be notified when changes were made to effect instances |
9596 |
|
on the back-end by issuing the following command:</t> |
9597 |
|
<t> |
9598 |
|
<list> |
9599 |
|
<t>SUBSCRIBE EFFECT_INSTANCE_INFO</t> |
9600 |
|
</list> |
9601 |
|
</t> |
9602 |
|
<t>Server will start sending the following notification messages:</t> |
9603 |
|
<t> |
9604 |
|
<list> |
9605 |
|
<t>"EFFECT_INSTANCE_INFO:<instance-id>"</t> |
9606 |
|
</list> |
9607 |
|
</t> |
9608 |
|
<t>where <instance-id> will be replaced by the numerical ID |
9609 |
|
of the effect instance.</t> |
9610 |
|
</section> |
9611 |
|
|
9612 |
|
<section title="Number of send effect chains changed" anchor="SUBSCRIBE SEND_EFFECT_CHAIN_COUNT"> |
9613 |
|
<t>Client may want to be notified when the number of send effect chains |
9614 |
|
is changed by issuing the following command:</t> |
9615 |
|
<t> |
9616 |
|
<list> |
9617 |
|
<t>SUBSCRIBE SEND_EFFECT_CHAIN_COUNT</t> |
9618 |
|
</list> |
9619 |
|
</t> |
9620 |
|
<t>Server will start sending the following notification messages:</t> |
9621 |
|
<t> |
9622 |
|
<list> |
9623 |
|
<t>"NOTIFY:SEND_EFFECT_CHAIN_COUNT:<device-id> <chains>"</t> |
9624 |
|
</list> |
9625 |
|
</t> |
9626 |
|
<t>where <device-id> will be replaced by the numerical ID of the audio |
9627 |
|
output device, in which the number of send effect chains is changed and |
9628 |
|
<chains> will be replaced by the new number of send effect chains.</t> |
9629 |
|
</section> |
9630 |
|
|
9631 |
|
<section title="Send effect chain information changed" anchor="SUBSCRIBE SEND_EFFECT_CHAIN_INFO"> |
9632 |
|
<t>Client may want to be notified when changes were made to send effect chains |
9633 |
|
on the back-end by issuing the following command:</t> |
9634 |
|
<t> |
9635 |
|
<list> |
9636 |
|
<t>SUBSCRIBE SEND_EFFECT_CHAIN_INFO</t> |
9637 |
|
</list> |
9638 |
|
</t> |
9639 |
|
<t>Server will start sending the following notification messages:</t> |
9640 |
|
<t> |
9641 |
|
<list> |
9642 |
|
<t>"SEND_EFFECT_CHAIN_INFO:<device-id> <chain-id> <instances>" - |
9643 |
|
Notifies that the number of effect instances in a particular send effect chain |
9644 |
|
is changed, where <device-id> will be replaced by the numerical ID of the audio |
9645 |
|
output device the send effect chain belongs to, <chain-id> will be replaced |
9646 |
|
by the numerical ID of the send effect chain in which the number of effect instances |
9647 |
|
has changed and <instances> will be replaced by the new number |
9648 |
|
of effect instances in the specified send effect chain.</t> |
9649 |
|
</list> |
9650 |
</t> |
</t> |
9651 |
</section> |
</section> |
9652 |
|
|
9728 |
</front> |
</front> |
9729 |
<seriesInfo name="RFC" value="2234" /> |
<seriesInfo name="RFC" value="2234" /> |
9730 |
</reference> |
</reference> |
9731 |
|
<reference anchor="RFC20"> |
9732 |
|
<front> |
9733 |
|
<title>ASCII format for Network Interchange</title> |
9734 |
|
<author> |
9735 |
|
<organization>UCLA</organization> |
9736 |
|
</author> |
9737 |
|
<date year="1969"></date> |
9738 |
|
</front> |
9739 |
|
<seriesInfo name="RFC" value="20" /> |
9740 |
|
</reference> |
9741 |
</references> |
</references> |
9742 |
</back> |
</back> |
9743 |
|
|