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.2cvs"> |
<rfc category="std" ipr="full3978" docName="LSCP 1.7"> |
20 |
<front> |
<front> |
21 |
<title>LinuxSampler Control Protocol (draft)</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="September" year="2007"/> |
<date month="March" year="2019"/> |
40 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
41 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
42 |
<abstract> |
<abstract> |
516 |
what parameters drivers are offering, how to retrieve their |
what parameters drivers are offering, how to retrieve their |
517 |
possible values, etc.</t> |
possible values, etc.</t> |
518 |
|
|
519 |
<section title="Getting amount of available audio output drivers" anchor="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"> |
<section title="Getting amount of available audio output drivers" anchor="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS" lscp_cmd="true"> |
520 |
<t>Use the following command to get the number of |
<t>Use the following command to get the number of |
521 |
audio output drivers currently available for the |
audio output drivers currently available for the |
522 |
LinuxSampler instance:</t> |
LinuxSampler instance:</t> |
541 |
</t> |
</t> |
542 |
</section> |
</section> |
543 |
|
|
544 |
<section title="Getting all available audio output drivers" anchor="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"> |
<section title="Getting all available audio output drivers" anchor="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" lscp_cmd="true"> |
545 |
<t>Use the following command to list all audio output |
<t>Use the following command to list all audio output |
546 |
drivers currently available for the LinuxSampler |
drivers currently available for the LinuxSampler |
547 |
instance:</t> |
instance:</t> |
568 |
</section> |
</section> |
569 |
|
|
570 |
<section title="Getting information about a specific audio |
<section title="Getting information about a specific audio |
571 |
output driver" anchor="GET AUDIO_OUTPUT_DRIVER INFO"> |
output driver" anchor="GET AUDIO_OUTPUT_DRIVER INFO" lscp_cmd="true"> |
572 |
<t>Use the following command to get detailed information |
<t>Use the following command to get detailed information |
573 |
about a specific audio output driver:</t> |
about a specific audio output driver:</t> |
574 |
<t> |
<t> |
641 |
</section> |
</section> |
642 |
|
|
643 |
<section title="Getting information about specific audio |
<section title="Getting information about specific audio |
644 |
output driver parameter" anchor="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"> |
output driver parameter" anchor="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO" lscp_cmd="true"> |
645 |
<t>Use the following command to get detailed information |
<t>Use the following command to get detailed information |
646 |
about a specific audio output driver parameter:</t> |
about a specific audio output driver parameter:</t> |
647 |
<t> |
<t> |
829 |
</t> |
</t> |
830 |
</section> |
</section> |
831 |
|
|
832 |
<section title="Creating an audio output device" anchor="CREATE AUDIO_OUTPUT_DEVICE"> |
<section title="Creating an audio output device" anchor="CREATE AUDIO_OUTPUT_DEVICE" lscp_cmd="true"> |
833 |
<t>Use the following command to create a new audio output device for the desired audio output system:</t> |
<t>Use the following command to create a new audio output device for the desired audio output system:</t> |
834 |
|
|
835 |
<t> |
<t> |
889 |
</t> |
</t> |
890 |
</section> |
</section> |
891 |
|
|
892 |
<section title="Destroying an audio output device" anchor="DESTROY AUDIO_OUTPUT_DEVICE"> |
<section title="Destroying an audio output device" anchor="DESTROY AUDIO_OUTPUT_DEVICE" lscp_cmd="true"> |
893 |
<t>Use the following command to destroy a created output device:</t> |
<t>Use the following command to destroy a created output device:</t> |
894 |
<t> |
<t> |
895 |
<list> |
<list> |
958 |
</t> |
</t> |
959 |
</section> |
</section> |
960 |
|
|
961 |
<section title="Getting all created audio output device list" anchor="LIST AUDIO_OUTPUT_DEVICES"> |
<section title="Getting all created audio output device list" anchor="LIST AUDIO_OUTPUT_DEVICES" lscp_cmd="true"> |
962 |
<t>Use the following command to list all created audio output devices:</t> |
<t>Use the following command to list all created audio output devices:</t> |
963 |
<t> |
<t> |
964 |
<list> |
<list> |
981 |
</t> |
</t> |
982 |
</section> |
</section> |
983 |
|
|
984 |
<section title="Getting current settings of an audio output device" anchor="GET AUDIO_OUTPUT_DEVICE INFO"> |
<section title="Getting current settings of an audio output device" anchor="GET AUDIO_OUTPUT_DEVICE INFO" lscp_cmd="true"> |
985 |
<t>Use the following command to get current settings of a specific, created audio output device:</t> |
<t>Use the following command to get current settings of a specific, created audio output device:</t> |
986 |
<t> |
<t> |
987 |
<list> |
<list> |
1054 |
</section> |
</section> |
1055 |
|
|
1056 |
|
|
1057 |
<section title="Changing settings of audio output devices" anchor="SET AUDIO_OUTPUT_DEVICE_PARAMETER"> |
<section title="Changing settings of audio output devices" anchor="SET AUDIO_OUTPUT_DEVICE_PARAMETER" lscp_cmd="true"> |
1058 |
<t>Use the following command to alter a specific setting of a created audio output device:</t> |
<t>Use the following command to alter a specific setting of a created audio output device:</t> |
1059 |
<t> |
<t> |
1060 |
<list> |
<list> |
1099 |
</t> |
</t> |
1100 |
</section> |
</section> |
1101 |
|
|
1102 |
<section title="Getting information about an audio channel" anchor="GET AUDIO_OUTPUT_CHANNEL INFO"> |
<section title="Getting information about an audio channel" anchor="GET AUDIO_OUTPUT_CHANNEL INFO" lscp_cmd="true"> |
1103 |
<t>Use the following command to get information about an audio channel:</t> |
<t>Use the following command to get information about an audio channel:</t> |
1104 |
<t> |
<t> |
1105 |
<list> |
<list> |
1199 |
</t> |
</t> |
1200 |
</section> |
</section> |
1201 |
|
|
1202 |
<section title="Getting information about specific audio channel parameter" anchor="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"> |
<section title="Getting information about specific audio channel parameter" anchor="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO" lscp_cmd="true"> |
1203 |
<t>Use the following command to get detailed information about specific audio channel parameter:</t> |
<t>Use the following command to get detailed information about specific audio channel parameter:</t> |
1204 |
|
|
1205 |
<t> |
<t> |
1305 |
</t> |
</t> |
1306 |
</section> |
</section> |
1307 |
|
|
1308 |
<section title="Changing settings of audio output channels" anchor="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"> |
<section title="Changing settings of audio output channels" anchor="SET AUDIO_OUTPUT_CHANNEL_PARAMETER" lscp_cmd="true"> |
1309 |
<t>Use the following command to alter a specific setting of an audio output channel:</t> |
<t>Use the following command to alter a specific setting of an audio output channel:</t> |
1310 |
<t> |
<t> |
1311 |
<list> |
<list> |
1383 |
showing how to retrieve what parameters drivers are offering, how to retrieve their |
showing how to retrieve what parameters drivers are offering, how to retrieve their |
1384 |
possible values, etc.</t> |
possible values, etc.</t> |
1385 |
|
|
1386 |
<section title="Getting amount of available MIDI input drivers" anchor="GET AVAILABLE_MIDI_INPUT_DRIVERS"> |
<section title="Getting amount of available MIDI input drivers" anchor="GET AVAILABLE_MIDI_INPUT_DRIVERS" lscp_cmd="true"> |
1387 |
<t>Use the following command to get the number of |
<t>Use the following command to get the number of |
1388 |
MIDI input drivers currently available for the |
MIDI input drivers currently available for the |
1389 |
LinuxSampler instance:</t> |
LinuxSampler instance:</t> |
1408 |
</t> |
</t> |
1409 |
</section> |
</section> |
1410 |
|
|
1411 |
<section title="Getting all available MIDI input drivers" anchor="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
<section title="Getting all available MIDI input drivers" anchor="LIST AVAILABLE_MIDI_INPUT_DRIVERS" lscp_cmd="true"> |
1412 |
<t>Use the following command to list all MIDI input drivers currently available |
<t>Use the following command to list all MIDI input drivers currently available |
1413 |
for the LinuxSampler instance:</t> |
for the LinuxSampler instance:</t> |
1414 |
<t> |
<t> |
1432 |
</t> |
</t> |
1433 |
</section> |
</section> |
1434 |
|
|
1435 |
<section title="Getting information about a specific MIDI input driver" anchor="GET MIDI_INPUT_DRIVER INFO"> |
<section title="Getting information about a specific MIDI input driver" anchor="GET MIDI_INPUT_DRIVER INFO" lscp_cmd="true"> |
1436 |
<t>Use the following command to get detailed information about a specific MIDI input driver:</t> |
<t>Use the following command to get detailed information about a specific MIDI input driver:</t> |
1437 |
<t> |
<t> |
1438 |
<list> |
<list> |
1488 |
</t> |
</t> |
1489 |
</section> |
</section> |
1490 |
|
|
1491 |
<section title="Getting information about specific MIDI input driver parameter" anchor="GET MIDI_INPUT_DRIVER_PARAMETER INFO"> |
<section title="Getting information about specific MIDI input driver parameter" anchor="GET MIDI_INPUT_DRIVER_PARAMETER INFO" lscp_cmd="true"> |
1492 |
<t>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:</t> |
<t>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:</t> |
1493 |
<t> |
<t> |
1494 |
<list> |
<list> |
1643 |
</t> |
</t> |
1644 |
</section> |
</section> |
1645 |
|
|
1646 |
<section title="Creating a MIDI input device" anchor="CREATE MIDI_INPUT_DEVICE"> |
<section title="Creating a MIDI input device" anchor="CREATE MIDI_INPUT_DEVICE" lscp_cmd="true"> |
1647 |
<t>Use the following command to create a new MIDI input device for the desired MIDI input system:</t> |
<t>Use the following command to create a new MIDI input device for the desired MIDI input system:</t> |
1648 |
<t> |
<t> |
1649 |
<list> |
<list> |
1693 |
</t> |
</t> |
1694 |
</section> |
</section> |
1695 |
|
|
1696 |
<section title="Destroying a MIDI input device" anchor="DESTROY MIDI_INPUT_DEVICE"> |
<section title="Destroying a MIDI input device" anchor="DESTROY MIDI_INPUT_DEVICE" lscp_cmd="true"> |
1697 |
<t>Use the following command to destroy a created MIDI input device:</t> |
<t>Use the following command to destroy a created MIDI input device:</t> |
1698 |
<t> |
<t> |
1699 |
<list> |
<list> |
1735 |
</t> |
</t> |
1736 |
</section> |
</section> |
1737 |
|
|
1738 |
<section title="Getting all created MIDI input device count" anchor="GET MIDI_INPUT_DEVICES"> |
<section title="Getting all created MIDI input device count" anchor="GET MIDI_INPUT_DEVICES" lscp_cmd="true"> |
1739 |
<t>Use the following command to count all created MIDI input devices:</t> |
<t>Use the following command to count all created MIDI input devices:</t> |
1740 |
<t> |
<t> |
1741 |
<list> |
<list> |
1759 |
</section> |
</section> |
1760 |
|
|
1761 |
|
|
1762 |
<section title="Getting all created MIDI input device list" anchor="LIST MIDI_INPUT_DEVICES"> |
<section title="Getting all created MIDI input device list" anchor="LIST MIDI_INPUT_DEVICES" lscp_cmd="true"> |
1763 |
<t>Use the following command to list all created MIDI input devices:</t> |
<t>Use the following command to list all created MIDI input devices:</t> |
1764 |
<t> |
<t> |
1765 |
<list> |
<list> |
1788 |
</t> |
</t> |
1789 |
</section> |
</section> |
1790 |
|
|
1791 |
<section title="Getting current settings of a MIDI input device" anchor="GET MIDI_INPUT_DEVICE INFO"> |
<section title="Getting current settings of a MIDI input device" anchor="GET MIDI_INPUT_DEVICE INFO" lscp_cmd="true"> |
1792 |
<t>Use the following command to get current settings of a specific, created MIDI input device:</t> |
<t>Use the following command to get current settings of a specific, created MIDI input device:</t> |
1793 |
<t> |
<t> |
1794 |
<list> |
<list> |
1854 |
</t> |
</t> |
1855 |
</section> |
</section> |
1856 |
|
|
1857 |
<section title="Changing settings of MIDI input devices" anchor="SET MIDI_INPUT_DEVICE_PARAMETER"> |
<section title="Changing settings of MIDI input devices" anchor="SET MIDI_INPUT_DEVICE_PARAMETER" lscp_cmd="true"> |
1858 |
<t>Use the following command to alter a specific setting of a created MIDI input device:</t> |
<t>Use the following command to alter a specific setting of a created MIDI input device:</t> |
1859 |
<t> |
<t> |
1860 |
<list> |
<list> |
1900 |
</t> |
</t> |
1901 |
</section> |
</section> |
1902 |
|
|
1903 |
<section title="Getting information about a MIDI port" anchor="GET MIDI_INPUT_PORT INFO"> |
<section title="Getting information about a MIDI port" anchor="GET MIDI_INPUT_PORT INFO" lscp_cmd="true"> |
1904 |
<t>Use the following command to get information about a MIDI port:</t> |
<t>Use the following command to get information about a MIDI port:</t> |
1905 |
<t> |
<t> |
1906 |
<list> |
<list> |
1944 |
</t> |
</t> |
1945 |
</section> |
</section> |
1946 |
|
|
1947 |
<section title="Getting information about specific MIDI port parameter" anchor="GET MIDI_INPUT_PORT_PARAMETER INFO"> |
<section title="Getting information about specific MIDI port parameter" anchor="GET MIDI_INPUT_PORT_PARAMETER INFO" lscp_cmd="true"> |
1948 |
<t>Use the following command to get detailed information about specific MIDI port parameter:</t> |
<t>Use the following command to get detailed information about specific MIDI port parameter:</t> |
1949 |
<t> |
<t> |
1950 |
<list> |
<list> |
2049 |
</t> |
</t> |
2050 |
</section> |
</section> |
2051 |
|
|
2052 |
<section title="Changing settings of MIDI input ports" anchor="SET MIDI_INPUT_PORT_PARAMETER"> |
<section title="Changing settings of MIDI input ports" anchor="SET MIDI_INPUT_PORT_PARAMETER" lscp_cmd="true"> |
2053 |
<t>Use the following command to alter a specific setting of a MIDI input port:</t> |
<t>Use the following command to alter a specific setting of a MIDI input port:</t> |
2054 |
<t> |
<t> |
2055 |
<list> |
<list> |
2109 |
sampler channel with a sampler engine, load instruments and connect sampler channels to |
sampler channel with a sampler engine, load instruments and connect sampler channels to |
2110 |
MIDI and audio devices.</t> |
MIDI and audio devices.</t> |
2111 |
|
|
2112 |
<section title="Loading an instrument" anchor="LOAD INSTRUMENT"> |
<section title="Loading an instrument" anchor="LOAD INSTRUMENT" lscp_cmd="true"> |
2113 |
<t>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:</t> |
<t>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:</t> |
2114 |
<t> |
<t> |
2115 |
<list> |
<list> |
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> |
2235 |
</t> |
</t> |
2236 |
</section> |
</section> |
2237 |
|
|
2238 |
<section title="Getting all created sampler channel count" anchor="GET CHANNELS"> |
<section title="Getting all created sampler channel count" anchor="GET CHANNELS" lscp_cmd="true"> |
2239 |
<t>The number of sampler channels can change on runtime. To get the |
<t>The number of sampler channels can change on runtime. To get the |
2240 |
current amount of sampler channels, the front-end can send the |
current amount of sampler channels, the front-end can send the |
2241 |
following command:</t> |
following command:</t> |
2259 |
</t> |
</t> |
2260 |
</section> |
</section> |
2261 |
|
|
2262 |
<section title="Getting all created sampler channel list" anchor="LIST CHANNELS"> |
<section title="Getting all created sampler channel list" anchor="LIST CHANNELS" lscp_cmd="true"> |
2263 |
<t>The number of sampler channels can change on runtime. To get the |
<t>The number of sampler channels can change on runtime. To get the |
2264 |
current list of sampler channels, the front-end can send the |
current list of sampler channels, the front-end can send the |
2265 |
following command:</t> |
following command:</t> |
2284 |
</t> |
</t> |
2285 |
</section> |
</section> |
2286 |
|
|
2287 |
<section title="Adding a new sampler channel" anchor="ADD CHANNEL"> |
<section title="Adding a new sampler channel" anchor="ADD CHANNEL" lscp_cmd="true"> |
2288 |
<t>A new sampler channel can be added to the end of the sampler |
<t>A new sampler channel can be added to the end of the sampler |
2289 |
channel list by sending the following command:</t> |
channel list by sending the following command:</t> |
2290 |
<t> |
<t> |
2336 |
</t> |
</t> |
2337 |
</section> |
</section> |
2338 |
|
|
2339 |
<section title="Removing a sampler channel" anchor="REMOVE CHANNEL"> |
<section title="Removing a sampler channel" anchor="REMOVE CHANNEL" lscp_cmd="true"> |
2340 |
<t>A sampler channel can be removed by sending the following command:</t> |
<t>A sampler channel can be removed by sending the following command:</t> |
2341 |
<t> |
<t> |
2342 |
<list> |
<list> |
2382 |
</t> |
</t> |
2383 |
</section> |
</section> |
2384 |
|
|
2385 |
<section title="Getting amount of available engines" anchor="GET AVAILABLE_ENGINES"> |
<section title="Getting amount of available engines" anchor="GET AVAILABLE_ENGINES" lscp_cmd="true"> |
2386 |
<t>The front-end can ask for the number of available engines by sending the following command:</t> |
<t>The front-end can ask for the number of available engines by sending the following command:</t> |
2387 |
<t> |
<t> |
2388 |
<list> |
<list> |
2404 |
</t> |
</t> |
2405 |
</section> |
</section> |
2406 |
|
|
2407 |
<section title="Getting all available engines" anchor="LIST AVAILABLE_ENGINES"> |
<section title="Getting all available engines" anchor="LIST AVAILABLE_ENGINES" lscp_cmd="true"> |
2408 |
<t>The front-end can ask for a list of all available engines by sending the following command:</t> |
<t>The front-end can ask for a list of all available engines by sending the following command:</t> |
2409 |
<t> |
<t> |
2410 |
<list> |
<list> |
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> |
2431 |
|
|
2432 |
<section title="Getting information about an engine" anchor="GET ENGINE INFO"> |
<section title="Getting information about an engine" anchor="GET ENGINE INFO" lscp_cmd="true"> |
2433 |
<t>The front-end can ask for information about a specific engine by |
<t>The front-end can ask for information about a specific engine by |
2434 |
sending the following command:</t> |
sending the following command:</t> |
2435 |
<t> |
<t> |
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> |
2490 |
</section> |
</section> |
2491 |
|
|
2492 |
<section title="Getting sampler channel information" anchor="GET CHANNEL INFO"> |
<section title="Getting sampler channel information" anchor="GET CHANNEL INFO" lscp_cmd="true"> |
2493 |
<t>The front-end can ask for the current settings of a sampler channel |
<t>The front-end can ask for the current settings of a sampler channel |
2494 |
by sending the following command:</t> |
by sending the following command:</t> |
2495 |
<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> |
2671 |
</t> |
</t> |
2672 |
</section> |
</section> |
2673 |
|
|
2674 |
<section title="Current number of active voices" anchor="GET CHANNEL VOICE_COUNT"> |
<section title="Current number of active voices" anchor="GET CHANNEL VOICE_COUNT" lscp_cmd="true"> |
2675 |
<t>The front-end can ask for the current number of active voices on a |
<t>The front-end can ask for the current number of active voices on a |
2676 |
sampler channel by sending the following command:</t> |
sampler channel by sending the following command:</t> |
2677 |
<t> |
<t> |
2698 |
</t> |
</t> |
2699 |
</section> |
</section> |
2700 |
|
|
2701 |
<section title="Current number of active disk streams" anchor="GET CHANNEL STREAM_COUNT"> |
<section title="Current number of active disk streams" anchor="GET CHANNEL STREAM_COUNT" lscp_cmd="true"> |
2702 |
<t>The front-end can ask for the current number of active disk streams |
<t>The front-end can ask for the current number of active disk streams |
2703 |
on a sampler channel by sending the following command:</t> |
on a sampler channel by sending the following command:</t> |
2704 |
<t> |
<t> |
2727 |
</t> |
</t> |
2728 |
</section> |
</section> |
2729 |
|
|
2730 |
<section title="Current fill state of disk stream buffers" anchor="GET CHANNEL BUFFER_FILL"> |
<section title="Current fill state of disk stream buffers" anchor="GET CHANNEL BUFFER_FILL" lscp_cmd="true"> |
2731 |
<t>The front-end can ask for the current fill state of all disk streams |
<t>The front-end can ask for the current fill state of all disk streams |
2732 |
on a sampler channel by sending the following command:</t> |
on a sampler channel by sending the following command:</t> |
2733 |
<t> |
<t> |
2780 |
</t> |
</t> |
2781 |
</section> |
</section> |
2782 |
|
|
2783 |
<section title="Setting audio output device" anchor="SET CHANNEL AUDIO_OUTPUT_DEVICE"> |
<section title="Setting audio output device" anchor="SET CHANNEL AUDIO_OUTPUT_DEVICE" lscp_cmd="true"> |
2784 |
<t>The front-end can set the audio output device on a specific sampler |
<t>The front-end can set the audio output device on a specific sampler |
2785 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
2786 |
<t> |
<t> |
2826 |
</t> |
</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" lscp_cmd="true"> |
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" lscp_cmd="true"> |
2880 |
<t>The front-end can alter the audio output channel on a specific |
<t>The front-end can alter the audio output channel on a specific |
2881 |
sampler channel by sending the following command:</t> |
sampler channel by sending the following command:</t> |
2882 |
<t> |
<t> |
2921 |
</t> |
</t> |
2922 |
</section> |
</section> |
2923 |
|
|
2924 |
<section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE"> |
<section title="Add MIDI input to sampler channel" anchor="ADD CHANNEL MIDI_INPUT" lscp_cmd="true"> |
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" lscp_cmd="true"> |
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" lscp_cmd="true"> |
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" lscp_cmd="true"> |
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" lscp_cmd="true"> |
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" lscp_cmd="true"> |
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" lscp_cmd="true"> |
3292 |
<t>The front-end can alter the MIDI channel a sampler channel should |
<t>The front-end can alter the MIDI channel a sampler channel should |
3293 |
listen to by sending the following command:</t> |
listen to by sending the following command:</t> |
3294 |
<t> |
<t> |
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> |
3336 |
|
|
3337 |
<section title="Setting channel volume" anchor="SET CHANNEL VOLUME"> |
<section title="Setting channel volume" anchor="SET CHANNEL VOLUME" lscp_cmd="true"> |
3338 |
<t>The front-end can alter the volume of a sampler channel by sending |
<t>The front-end can alter the volume of a sampler channel by sending |
3339 |
the following command:</t> |
the following command:</t> |
3340 |
<t> |
<t> |
3377 |
</t> |
</t> |
3378 |
</section> |
</section> |
3379 |
|
|
3380 |
<section title="Muting a sampler channel" anchor="SET CHANNEL MUTE"> |
<section title="Muting a sampler channel" anchor="SET CHANNEL MUTE" lscp_cmd="true"> |
3381 |
<t>The front-end can mute/unmute a specific sampler |
<t>The front-end can mute/unmute a specific sampler |
3382 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
3383 |
<t> |
<t> |
3421 |
</t> |
</t> |
3422 |
</section> |
</section> |
3423 |
|
|
3424 |
<section title="Soloing a sampler channel" anchor="SET CHANNEL SOLO"> |
<section title="Soloing a sampler channel" anchor="SET CHANNEL SOLO" lscp_cmd="true"> |
3425 |
<t>The front-end can solo/unsolo a specific sampler channel |
<t>The front-end can solo/unsolo a specific sampler channel |
3426 |
by sending the following command:</t> |
by sending the following command:</t> |
3427 |
<t> |
<t> |
3465 |
</t> |
</t> |
3466 |
</section> |
</section> |
3467 |
|
|
3468 |
<section title="Assigning a MIDI instrument map to a sampler channel" anchor="SET CHANNEL MIDI_INSTRUMENT_MAP"> |
<section title="Assigning a MIDI instrument map to a sampler channel" anchor="SET CHANNEL MIDI_INSTRUMENT_MAP" lscp_cmd="true"> |
3469 |
<t>The front-end can assign a MIDI instrument map to a specific sampler channel |
<t>The front-end can assign a MIDI instrument map to a specific sampler channel |
3470 |
by sending the following command:</t> |
by sending the following command:</t> |
3471 |
<t> |
<t> |
3533 |
</t> |
</t> |
3534 |
</section> |
</section> |
3535 |
|
|
3536 |
<section title="Adding an effect send to a sampler channel" anchor="CREATE FX_SEND"> |
<section title="Adding an effect send to a sampler channel" anchor="CREATE FX_SEND" lscp_cmd="true"> |
3537 |
<t>The front-end can create an additional effect send on a specific sampler channel |
<t>The front-end can create an additional effect send on a specific sampler channel |
3538 |
by sending the following command:</t> |
by sending the following command:</t> |
3539 |
<t> |
<t> |
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 |
<t>By default, that is as initial routing, the effect send's audio channels |
"<xref target="character_set">Character Set and Escape Sequences</xref>".</t> |
3553 |
are automatically routed to the last audio channels of the sampler channel's |
|
3554 |
audio output device, that way you can i.e. first increase the amount of audio |
<t>Note: there are two possible approaches to apply audio effects with FX sends: |
3555 |
channels on the audio output device for having dedicated effect send output |
you can either use a) internal effects or b) external effects. |
3556 |
channels and when "CREATE FX_SEND" is called, those channels will automatically |
By default, that is as initial routing, effect sends are automatically routed |
3557 |
be picked. You can alter the destination channels however with |
directly to the sampler channel's audio output device and the effect send's |
3558 |
<xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>. |
audio channels are by default automatically routed to the last audio channels |
3559 |
|
of that audio output device (for the purpose of applying effects externally that is, |
3560 |
|
e.g. by using another application), that way you can i.e. first increase the |
3561 |
|
amount of audio channels on the audio output device for having dedicated effect |
3562 |
|
send output channels and when "CREATE FX_SEND" is called, those channels will |
3563 |
|
automatically be picked. You can alter the destination channels however with |
3564 |
|
<xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>. |
3565 |
|
If your intention is rather to use internal effects instead of external effects, |
3566 |
|
then you first need to <xref target="effects">load those internal effects</xref> |
3567 |
|
and then assign the FX sends to the desired internal effect by sending |
3568 |
|
<xref target="SET FX_SEND EFFECT">"SET FX_SEND EFFECT"</xref>. |
3569 |
</t> |
</t> |
3570 |
|
|
3571 |
<t>Note: Create effect sends on a sampler channel only when needed, because having effect |
<t>Note: Create effect sends on a sampler channel only when needed, because having effect |
3611 |
</t> |
</t> |
3612 |
</section> |
</section> |
3613 |
|
|
3614 |
<section title="Removing an effect send from a sampler channel" anchor="DESTROY FX_SEND"> |
<section title="Removing an effect send from a sampler channel" anchor="DESTROY FX_SEND" lscp_cmd="true"> |
3615 |
<t>The front-end can remove an existing effect send on a specific sampler channel |
<t>The front-end can remove an existing effect send on a specific sampler channel |
3616 |
by sending the following command:</t> |
by sending the following command:</t> |
3617 |
<t> |
<t> |
3653 |
</t> |
</t> |
3654 |
</section> |
</section> |
3655 |
|
|
3656 |
<section title="Getting amount of effect sends on a sampler channel" anchor="GET FX_SENDS"> |
<section title="Getting amount of effect sends on a sampler channel" anchor="GET FX_SENDS" lscp_cmd="true"> |
3657 |
<t>The front-end can ask for the amount of effect sends on a specific sampler channel |
<t>The front-end can ask for the amount of effect sends on a specific sampler channel |
3658 |
by sending the following command:</t> |
by sending the following command:</t> |
3659 |
<t> |
<t> |
3682 |
</t> |
</t> |
3683 |
</section> |
</section> |
3684 |
|
|
3685 |
<section title="Listing all effect sends on a sampler channel" anchor="LIST FX_SENDS"> |
<section title="Listing all effect sends on a sampler channel" anchor="LIST FX_SENDS" lscp_cmd="true"> |
3686 |
<t>The front-end can ask for a list of effect sends on a specific sampler channel |
<t>The front-end can ask for a list of effect sends on a specific sampler channel |
3687 |
by sending the following command:</t> |
by sending the following command:</t> |
3688 |
<t> |
<t> |
3718 |
</t> |
</t> |
3719 |
</section> |
</section> |
3720 |
|
|
3721 |
<section title="Getting effect send information" anchor="GET FX_SEND INFO"> |
<section title="Getting effect send information" anchor="GET FX_SEND INFO" lscp_cmd="true"> |
3722 |
<t>The front-end can ask for the current settings of an effect send entity |
<t>The front-end can ask for the current settings of an effect send entity |
3723 |
by sending the following command:</t> |
by sending the following command:</t> |
3724 |
<t> |
<t> |
3747 |
<list> |
<list> |
3748 |
<t>NAME - |
<t>NAME - |
3749 |
<list> |
<list> |
3750 |
<t>name of the effect send entity</t> |
<t>name of the effect send entity |
3751 |
|
(note that this character string may contain |
3752 |
|
<xref target="character_set">escape sequences</xref>)</t> |
3753 |
</list> |
</list> |
3754 |
</t> |
</t> |
3755 |
<t>MIDI_CONTROLLER - |
<t>MIDI_CONTROLLER - |
3775 |
channel 1 is routed to the channel 3 of the audio |
channel 1 is routed to the channel 3 of the audio |
3776 |
output device (see |
output device (see |
3777 |
<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> |
3778 |
for details)</t> |
for details), if an internal send |
3779 |
|
effect is assigned to the effect |
3780 |
|
send, then this setting defines the |
3781 |
|
audio channel routing to that |
3782 |
|
effect instance respectively</t> |
3783 |
|
</list> |
3784 |
|
</t> |
3785 |
|
<t>EFFECT - |
3786 |
|
<list> |
3787 |
|
<t>destination send effect chain ID |
3788 |
|
and destination effect chain |
3789 |
|
position, separated by comma in the |
3790 |
|
form "<effect-chain>,<chain-pos>" |
3791 |
|
or "NONE" if there is no send effect |
3792 |
|
assigned to the effect send</t> |
3793 |
</list> |
</list> |
3794 |
</t> |
</t> |
3795 |
</list> |
</list> |
3806 |
<t> "MIDI_CONTROLLER: 91"</t> |
<t> "MIDI_CONTROLLER: 91"</t> |
3807 |
<t> "LEVEL: 0.3"</t> |
<t> "LEVEL: 0.3"</t> |
3808 |
<t> "AUDIO_OUTPUT_ROUTING: 2,3"</t> |
<t> "AUDIO_OUTPUT_ROUTING: 2,3"</t> |
3809 |
|
<t> "EFFECT: NONE"</t> |
3810 |
|
<t> "."</t> |
3811 |
|
</list> |
3812 |
|
</t> |
3813 |
|
<t> |
3814 |
|
<list> |
3815 |
|
<t>C: "GET FX_SEND INFO 0 1"</t> |
3816 |
|
<t>S: "NAME: Delay Send (Internal)"</t> |
3817 |
|
<t> "MIDI_CONTROLLER: 93"</t> |
3818 |
|
<t> "LEVEL: 0.51"</t> |
3819 |
|
<t> "AUDIO_OUTPUT_ROUTING: 1,2"</t> |
3820 |
|
<t> "EFFECT: 2,0"</t> |
3821 |
<t> "."</t> |
<t> "."</t> |
3822 |
</list> |
</list> |
3823 |
</t> |
</t> |
3824 |
</section> |
</section> |
3825 |
|
|
3826 |
<section title="Changing effect send's name" anchor="SET FX_SEND NAME"> |
<section title="Changing effect send's name" anchor="SET FX_SEND NAME" lscp_cmd="true"> |
3827 |
<t>The front-end can alter the current name of an effect |
<t>The front-end can alter the current name of an effect |
3828 |
send entity by sending the following command:</t> |
send entity by sending the following command:</t> |
3829 |
<t> |
<t> |
3838 |
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> |
3839 |
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
3840 |
<name> is the new name of the effect send entity, which |
<name> is the new name of the effect send entity, which |
3841 |
does not have to be unique.</t> |
does not have to be unique (name MUST be encapsulated into apostrophes |
3842 |
|
and supports escape sequences as described in chapter |
3843 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"). |
3844 |
|
</t> |
3845 |
|
|
3846 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
3847 |
<t> |
<t> |
3867 |
</t> |
</t> |
3868 |
</section> |
</section> |
3869 |
|
|
3870 |
<section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL"> |
<section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL" lscp_cmd="true"> |
3871 |
<t>The front-end can alter the destination of an effect send's audio channel on a specific |
<t>The front-end can alter the destination of an effect send's audio channel on a specific |
3872 |
sampler channel by sending the following command:</t> |
sampler channel by sending the following command:</t> |
3873 |
<t> |
<t> |
3883 |
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command, |
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command, |
3884 |
<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 |
3885 |
which should be rerouted and <audio-dst> is the numerical ID of |
which should be rerouted and <audio-dst> is the numerical ID of |
3886 |
the audio channel of the selected audio output device where <audio-src> |
either a) the audio output channel of the sampler channel's audio output |
3887 |
should be routed to.</t> |
device (i.e. if external effect shall be applied) or b) of the audio |
3888 |
|
input channel of an internal effect assigned to the FX send where |
3889 |
|
<audio-src> should be routed to.</t> |
3890 |
|
|
3891 |
<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 |
3892 |
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 |
3929 |
</t> |
</t> |
3930 |
</section> |
</section> |
3931 |
|
|
3932 |
<section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER"> |
<section title="Assigning destination effect to an effect send" anchor="SET FX_SEND EFFECT" lscp_cmd="true"> |
3933 |
|
<t>The front-end can (re-)assign an internal destination effect to an |
3934 |
|
effect send by sending the following command:</t> |
3935 |
|
<t> |
3936 |
|
<list> |
3937 |
|
<t>SET FX_SEND EFFECT <sampler-chan> <fx-send-id> <effect-chain> <chain-pos></t> |
3938 |
|
</list> |
3939 |
|
</t> |
3940 |
|
<t>Where <sampler-chan> is the sampler channel number |
3941 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3942 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3943 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3944 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3945 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command, |
3946 |
|
<effect-chain> by the numerical ID of the destination |
3947 |
|
effect chain as returned by the |
3948 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
3949 |
|
or |
3950 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
3951 |
|
command and <chain-pos> reflects the exact effect |
3952 |
|
chain position in the effect chain which hosts the actual |
3953 |
|
destination effect.</t> |
3954 |
|
|
3955 |
|
<t>Note: This command MUST NOT be used if you want to apply |
3956 |
|
audio effects externally! By default FX sends are routed directly |
3957 |
|
to the audio output device for that purpose. |
3958 |
|
You can also revert this command later on by sending |
3959 |
|
<xref target="REMOVE FX_SEND EFFECT">"REMOVE FX_SEND EFFECT"</xref>, |
3960 |
|
which will cause the FX send to be routed directly to the sampler channel's |
3961 |
|
audio output device instead (i.e. for using external effects instead of |
3962 |
|
internal effects). |
3963 |
|
</t> |
3964 |
|
|
3965 |
|
<t>Possible Answers:</t> |
3966 |
|
<t> |
3967 |
|
<list> |
3968 |
|
<t>"OK" - |
3969 |
|
<list> |
3970 |
|
<t>on success</t> |
3971 |
|
</list> |
3972 |
|
</t> |
3973 |
|
<t>"ERR:<error-code>:<error-message>" - |
3974 |
|
<list> |
3975 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3976 |
|
</list> |
3977 |
|
</t> |
3978 |
|
</list> |
3979 |
|
</t> |
3980 |
|
<t>Example:</t> |
3981 |
|
<t> |
3982 |
|
<list> |
3983 |
|
<t>C: "SET FX_SEND EFFECT 0 0 2 5"</t> |
3984 |
|
<t>S: "OK"</t> |
3985 |
|
</list> |
3986 |
|
</t> |
3987 |
|
</section> |
3988 |
|
|
3989 |
|
<section title="Removing destination effect from an effect send" anchor="REMOVE FX_SEND EFFECT" lscp_cmd="true"> |
3990 |
|
<t>The front-end can (re-)assign a destination effect to an |
3991 |
|
effect send by sending the following command:</t> |
3992 |
|
<t> |
3993 |
|
<list> |
3994 |
|
<t>REMOVE FX_SEND EFFECT <sampler-chan> <fx-send-id></t> |
3995 |
|
</list> |
3996 |
|
</t> |
3997 |
|
<t>Where <sampler-chan> is the sampler channel number |
3998 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3999 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
4000 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
4001 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
4002 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t> |
4003 |
|
|
4004 |
|
<t>After the destination effect has been removed from the |
4005 |
|
effect send, the audio signal of the effect send will be |
4006 |
|
routed directly to the audio output device, according to the |
4007 |
|
audio channel routing setting of the effect send. |
4008 |
|
</t> |
4009 |
|
|
4010 |
|
<t>Possible Answers:</t> |
4011 |
|
<t> |
4012 |
|
<list> |
4013 |
|
<t>"OK" - |
4014 |
|
<list> |
4015 |
|
<t>on success</t> |
4016 |
|
</list> |
4017 |
|
</t> |
4018 |
|
<t>"ERR:<error-code>:<error-message>" - |
4019 |
|
<list> |
4020 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
4021 |
|
</list> |
4022 |
|
</t> |
4023 |
|
</list> |
4024 |
|
</t> |
4025 |
|
<t>Example:</t> |
4026 |
|
<t> |
4027 |
|
<list> |
4028 |
|
<t>C: "REMOVE FX_SEND EFFECT 0 0"</t> |
4029 |
|
<t>S: "OK"</t> |
4030 |
|
</list> |
4031 |
|
</t> |
4032 |
|
</section> |
4033 |
|
|
4034 |
|
<section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER" lscp_cmd="true"> |
4035 |
<t>The front-end can alter the MIDI controller of an effect |
<t>The front-end can alter the MIDI controller of an effect |
4036 |
send entity by sending the following command:</t> |
send entity by sending the following command:</t> |
4037 |
<t> |
<t> |
4079 |
</t> |
</t> |
4080 |
</section> |
</section> |
4081 |
|
|
4082 |
<section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL"> |
<section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL" lscp_cmd="true"> |
4083 |
<t>The front-end can alter the current send level of an effect |
<t>The front-end can alter the current send level of an effect |
4084 |
send entity by sending the following command:</t> |
send entity by sending the following command:</t> |
4085 |
<t> |
<t> |
4128 |
</t> |
</t> |
4129 |
</section> |
</section> |
4130 |
|
|
4131 |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
<section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA" lscp_cmd="true"> |
4132 |
|
<t>The front-end can send MIDI events to a specific sampler channel |
4133 |
|
by sending the following command:</t> |
4134 |
|
<t> |
4135 |
|
<list> |
4136 |
|
<t>SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2></t> |
4137 |
|
</list> |
4138 |
|
</t> |
4139 |
|
<t>Where <sampler-chan> is the sampler channel number |
4140 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
4141 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
4142 |
|
<arg1> and <arg2> arguments depend on the <midi-msg> argument, which |
4143 |
|
specifies the MIDI message type. Currently, the following MIDI messages are supported:</t> |
4144 |
|
<t> |
4145 |
|
<list> |
4146 |
|
<t>"NOTE_ON" - |
4147 |
|
<list> |
4148 |
|
<t>For turning on MIDI notes, where <arg1> |
4149 |
|
specifies the key number and <arg2> the velocity |
4150 |
|
as described in the MIDI specification.</t> |
4151 |
|
</list> |
4152 |
|
</t> |
4153 |
|
<t>"NOTE_OFF" - |
4154 |
|
<list> |
4155 |
|
<t>For turning a currently playing MIDI note off, where <arg1> |
4156 |
|
specifies the key number and <arg2> the velocity |
4157 |
|
as described in the MIDI specification.</t> |
4158 |
|
</list> |
4159 |
|
</t> |
4160 |
|
<t>"CC" - |
4161 |
|
<list> |
4162 |
|
<t>For changing a MIDI controller, where <arg1> |
4163 |
|
specifies the controller number and <arg2> the |
4164 |
|
new value of the controller as described in the Control |
4165 |
|
Change section of the MIDI specification.</t> |
4166 |
|
</list> |
4167 |
|
</t> |
4168 |
|
</list> |
4169 |
|
</t> |
4170 |
|
<t>CAUTION: This command is provided for implementations of virtual MIDI keyboards |
4171 |
|
and no realtime guarantee whatsoever will be made!</t> |
4172 |
|
<t>Possible Answers:</t> |
4173 |
|
<t> |
4174 |
|
<list> |
4175 |
|
<t>"OK" - |
4176 |
|
<list> |
4177 |
|
<t>on success</t> |
4178 |
|
</list> |
4179 |
|
</t> |
4180 |
|
<t>"ERR:<error-code>:<error-message>" - |
4181 |
|
<list> |
4182 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
4183 |
|
</list> |
4184 |
|
</t> |
4185 |
|
</list> |
4186 |
|
</t> |
4187 |
|
<t>Example:</t> |
4188 |
|
<t> |
4189 |
|
<list> |
4190 |
|
<t>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"</t> |
4191 |
|
<t>S: "OK"</t> |
4192 |
|
</list> |
4193 |
|
</t> |
4194 |
|
</section> |
4195 |
|
|
4196 |
|
<section title="Resetting a sampler channel" anchor="RESET CHANNEL" lscp_cmd="true"> |
4197 |
<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> |
4198 |
<t> |
<t> |
4199 |
<list> |
<list> |
4241 |
<section title="Controlling connection"> |
<section title="Controlling connection"> |
4242 |
<t>The following commands are used to control the connection to LinuxSampler.</t> |
<t>The following commands are used to control the connection to LinuxSampler.</t> |
4243 |
|
|
4244 |
<section title="Register front-end for receiving event messages" anchor="SUBSCRIBE"> |
<section title="Register front-end for receiving event messages" anchor="SUBSCRIBE" lscp_cmd="true"> |
4245 |
<t>The front-end can register itself to the LinuxSampler application to |
<t>The front-end can register itself to the LinuxSampler application to |
4246 |
be informed about noteworthy events by sending this command:</t> |
be informed about noteworthy events by sending this command:</t> |
4247 |
<t> |
<t> |
4283 |
</t> |
</t> |
4284 |
</section> |
</section> |
4285 |
|
|
4286 |
<section title="Unregister front-end for not receiving event messages" anchor="UNSUBSCRIBE"> |
<section title="Unregister front-end for not receiving event messages" anchor="UNSUBSCRIBE" lscp_cmd="true"> |
4287 |
<t>The front-end can unregister itself if it doesn't want to receive event |
<t>The front-end can unregister itself if it doesn't want to receive event |
4288 |
messages anymore by sending the following command:</t> |
messages anymore by sending the following command:</t> |
4289 |
<t> |
<t> |
4325 |
</t> |
</t> |
4326 |
</section> |
</section> |
4327 |
|
|
4328 |
<section title="Enable or disable echo of commands" anchor="SET ECHO"> |
<section title="Enable or disable echo of commands" anchor="SET ECHO" lscp_cmd="true"> |
4329 |
<t>To enable or disable back sending of commands to the client the following command can be used:</t> |
<t>To enable or disable back sending of commands to the client the following command can be used:</t> |
4330 |
<t> |
<t> |
4331 |
<list> |
<list> |
4363 |
</t> |
</t> |
4364 |
</section> |
</section> |
4365 |
|
|
4366 |
<section title="Close client connection" anchor="QUIT"> |
<section title="Close client connection" anchor="QUIT" lscp_cmd="true"> |
4367 |
<t>The client can close its network connection to LinuxSampler by sending the following command:</t> |
<t>The client can close its network connection to LinuxSampler by sending the following command:</t> |
4368 |
<t> |
<t> |
4369 |
<list> |
<list> |
4378 |
<section title="Global commands"> |
<section title="Global commands"> |
4379 |
<t>The following commands have global impact on the sampler.</t> |
<t>The following commands have global impact on the sampler.</t> |
4380 |
|
|
4381 |
<section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT"> |
<section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT" lscp_cmd="true"> |
4382 |
<t>The front-end can ask for the current number of active voices on |
<t>The front-end can ask for the current number of active voices on |
4383 |
the sampler by sending the following command:</t> |
the sampler by sending the following command:</t> |
4384 |
<t> |
<t> |
4396 |
</t> |
</t> |
4397 |
</section> |
</section> |
4398 |
|
|
4399 |
<section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX"> |
<section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX" lscp_cmd="true"> |
4400 |
<t>The front-end can ask for the maximum number of active voices |
<t>The front-end can ask for the maximum number of active voices |
4401 |
by sending the following command:</t> |
by sending the following command:</t> |
4402 |
<t> |
<t> |
4414 |
</t> |
</t> |
4415 |
</section> |
</section> |
4416 |
|
|
4417 |
|
<section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT" lscp_cmd="true"> |
4418 |
|
<t>The front-end can ask for the current number of active disk streams on |
4419 |
|
the sampler by sending the following command:</t> |
4420 |
|
<t> |
4421 |
|
<list> |
4422 |
|
<t>GET TOTAL_STREAM_COUNT</t> |
4423 |
|
</list> |
4424 |
|
</t> |
4425 |
|
|
4426 |
|
<t>Possible Answers:</t> |
4427 |
|
<t> |
4428 |
|
<list> |
4429 |
|
<t>LinuxSampler will answer by returning the number of all active |
4430 |
|
disk streams on the sampler.</t> |
4431 |
|
</list> |
4432 |
|
</t> |
4433 |
|
</section> |
4434 |
|
|
4435 |
<section title="Reset sampler" anchor="RESET"> |
<section title="Reset sampler" anchor="RESET"> |
4436 |
<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> |
4437 |
<t> |
<t> |
4458 |
</t> |
</t> |
4459 |
</section> |
</section> |
4460 |
|
|
4461 |
<section title="General sampler informations" anchor="GET SERVER INFO"> |
<section title="General sampler information" anchor="GET SERVER INFO" lscp_cmd="true"> |
4462 |
<t>The client can ask for general informations about the LinuxSampler |
<t>The client can ask for general information about the LinuxSampler |
4463 |
instance by sending the following command:</t> |
instance by sending the following command:</t> |
4464 |
<t> |
<t> |
4465 |
<list> |
<list> |
4479 |
<list> |
<list> |
4480 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
4481 |
<list> |
<list> |
4482 |
<t>arbitrary textual description about the sampler |
<t>arbitrary textual description about the sampler |
4483 |
(note that the character string may contain |
(note that the character string may contain |
4484 |
<xref target="character_set">escape sequences</xref>)</t> |
<xref target="character_set">escape sequences</xref>)</t> |
4485 |
</list> |
</list> |
4486 |
</t> |
</t> |
4507 |
</t> |
</t> |
4508 |
<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. |
4509 |
Other fields might be added in future.</t> |
Other fields might be added in future.</t> |
4510 |
|
|
4511 |
|
<t>Example:</t> |
4512 |
|
<t> |
4513 |
|
<list> |
4514 |
|
<t>C: "GET SERVER INFO"</t> |
4515 |
|
<t>S: "DESCRIPTION: LinuxSampler - modular, streaming capable sampler"</t> |
4516 |
|
<t> "VERSION: 1.0.0.svn23"</t> |
4517 |
|
<t> "PROTOCOL_VERSION: 1.5"</t> |
4518 |
|
<t> "INSTRUMENTS_DB_SUPPORT: no"</t> |
4519 |
|
<t> "."</t> |
4520 |
|
</list> |
4521 |
|
</t> |
4522 |
</section> |
</section> |
4523 |
|
|
4524 |
<section title="Getting global volume attenuation" anchor="GET VOLUME"> |
<section title="Getting global volume attenuation" anchor="GET VOLUME" lscp_cmd="true"> |
4525 |
<t>The client can ask for the current global sampler-wide volume |
<t>The client can ask for the current global sampler-wide volume |
4526 |
attenuation by sending the following command:</t> |
attenuation by sending the following command:</t> |
4527 |
<t> |
<t> |
4543 |
use this parameter.</t> |
use this parameter.</t> |
4544 |
</section> |
</section> |
4545 |
|
|
4546 |
<section title="Setting global volume attenuation" anchor="SET VOLUME"> |
<section title="Setting global volume attenuation" anchor="SET VOLUME" lscp_cmd="true"> |
4547 |
<t>The client can alter the current global sampler-wide volume |
<t>The client can alter the current global sampler-wide volume |
4548 |
attenuation by sending the following command:</t> |
attenuation by sending the following command:</t> |
4549 |
<t> |
<t> |
4579 |
</list> |
</list> |
4580 |
</t> |
</t> |
4581 |
</section> |
</section> |
4582 |
|
|
4583 |
|
<section title="Getting global voice limit" anchor="GET VOICES" lscp_cmd="true"> |
4584 |
|
<t>The client can ask for the current global sampler-wide limit |
4585 |
|
for maximum voices by sending the following command:</t> |
4586 |
|
<t> |
4587 |
|
<list> |
4588 |
|
<t>GET VOICES</t> |
4589 |
|
</list> |
4590 |
|
</t> |
4591 |
|
<t>Possible Answers:</t> |
4592 |
|
<t> |
4593 |
|
<list> |
4594 |
|
<t>LinuxSampler will answer by returning the number for |
4595 |
|
the current limit of maximum voices.</t> |
4596 |
|
</list> |
4597 |
|
</t> |
4598 |
|
|
4599 |
|
<t>The voice limit setting defines how many voices should maximum |
4600 |
|
be processed by the sampler at the same time. If the user |
4601 |
|
triggers new notes which would exceed that voice limit, the |
4602 |
|
sampler engine will react by stealing old voices for those |
4603 |
|
newly triggered notes. Note that the amount of voices triggered |
4604 |
|
by a new note can be larger than one and is dependent to the |
4605 |
|
respective instrument and probably further criterias.</t> |
4606 |
|
</section> |
4607 |
|
|
4608 |
|
<section title="Setting global voice limit" anchor="SET VOICES" lscp_cmd="true"> |
4609 |
|
<t>The client can alter the current global sampler-wide limit |
4610 |
|
for maximum voices by sending the following command:</t> |
4611 |
|
<t> |
4612 |
|
<list> |
4613 |
|
<t>SET VOICES <max-voices></t> |
4614 |
|
</list> |
4615 |
|
</t> |
4616 |
|
<t>Where <max-voices> should be replaced by the integer |
4617 |
|
value, reflecting the new global amount limit of maximum voices. |
4618 |
|
This value has to be larger than 0.</t> |
4619 |
|
|
4620 |
|
<t>Possible Answers:</t> |
4621 |
|
<t> |
4622 |
|
<list> |
4623 |
|
<t>"OK" - |
4624 |
|
<list> |
4625 |
|
<t>on success</t> |
4626 |
|
</list> |
4627 |
|
</t> |
4628 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
4629 |
|
<list> |
4630 |
|
<t>if the voice limit was set, but there are noteworthy |
4631 |
|
issue(s) related, providing an appropriate warning code and |
4632 |
|
warning message</t> |
4633 |
|
</list> |
4634 |
|
</t> |
4635 |
|
<t>"ERR:<error-code>:<error-message>" - |
4636 |
|
<list> |
4637 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
4638 |
|
</list> |
4639 |
|
</t> |
4640 |
|
</list> |
4641 |
|
</t> |
4642 |
|
|
4643 |
|
<t>Note: the given value will be passed to all sampler engine instances. |
4644 |
|
The total amount of maximum voices on the running system might thus |
4645 |
|
be as big as the given value multiplied by the current amount of engine |
4646 |
|
instances.</t> |
4647 |
|
|
4648 |
|
<t>Caution: when adjusting the voice limit, you SHOULD also |
4649 |
|
adjust the disk stream limit respectively and vice versa.</t> |
4650 |
|
</section> |
4651 |
|
|
4652 |
|
<section title="Getting global disk stream limit" anchor="GET STREAMS" lscp_cmd="true"> |
4653 |
|
<t>The client can ask for the current global sampler-wide limit |
4654 |
|
for maximum disk streams by sending the following command:</t> |
4655 |
|
<t> |
4656 |
|
<list> |
4657 |
|
<t>GET STREAMS</t> |
4658 |
|
</list> |
4659 |
|
</t> |
4660 |
|
<t>Possible Answers:</t> |
4661 |
|
<t> |
4662 |
|
<list> |
4663 |
|
<t>LinuxSampler will answer by returning the number for |
4664 |
|
the current limit of maximum disk streams.</t> |
4665 |
|
</list> |
4666 |
|
</t> |
4667 |
|
|
4668 |
|
<t>The disk stream limit setting defines how many disk streams should |
4669 |
|
maximum be processed by a sampler engine at the same time. The |
4670 |
|
higher this value, the more memory (RAM) will be occupied, since |
4671 |
|
every disk streams allocates a certain buffer size for being able |
4672 |
|
to perform its streaming operations.</t> |
4673 |
|
</section> |
4674 |
|
|
4675 |
|
<section title="Setting global disk stream limit" anchor="SET STREAMS" lscp_cmd="true"> |
4676 |
|
<t>The client can alter the current global sampler-wide limit |
4677 |
|
for maximum disk streams by sending the following command:</t> |
4678 |
|
<t> |
4679 |
|
<list> |
4680 |
|
<t>SET STREAMS <max-streams></t> |
4681 |
|
</list> |
4682 |
|
</t> |
4683 |
|
<t>Where <max-streams> should be replaced by the integer |
4684 |
|
value, reflecting the new global amount limit of maximum disk streams. |
4685 |
|
This value has to be positive.</t> |
4686 |
|
|
4687 |
|
<t>Possible Answers:</t> |
4688 |
|
<t> |
4689 |
|
<list> |
4690 |
|
<t>"OK" - |
4691 |
|
<list> |
4692 |
|
<t>on success</t> |
4693 |
|
</list> |
4694 |
|
</t> |
4695 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
4696 |
|
<list> |
4697 |
|
<t>if the disk stream limit was set, but there are noteworthy |
4698 |
|
issue(s) related, providing an appropriate warning code and |
4699 |
|
warning message</t> |
4700 |
|
</list> |
4701 |
|
</t> |
4702 |
|
<t>"ERR:<error-code>:<error-message>" - |
4703 |
|
<list> |
4704 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
4705 |
|
</list> |
4706 |
|
</t> |
4707 |
|
</list> |
4708 |
|
</t> |
4709 |
|
|
4710 |
|
<t>Note: the given value will be passed to all sampler engine instances. |
4711 |
|
The total amount of maximum disk streams on the running system might |
4712 |
|
thus be as big as the given value multiplied by the current amount of |
4713 |
|
engine instances.</t> |
4714 |
|
|
4715 |
|
<t>Caution: when adjusting the disk stream limit, you SHOULD also |
4716 |
|
adjust the voice limit respectively and vice versa.</t> |
4717 |
|
</section> |
4718 |
|
|
4719 |
</section> |
</section> |
4720 |
|
|
4721 |
|
|
4746 |
cause the sampler to switch to the respective instrument as |
cause the sampler to switch to the respective instrument as |
4747 |
reflected by the current MIDI instrument map.</t> |
reflected by the current MIDI instrument map.</t> |
4748 |
|
|
4749 |
<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" lscp_cmd="true"> |
4750 |
<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 |
4751 |
the following command:</t> |
the following command:</t> |
4752 |
<t> |
<t> |
4756 |
</t> |
</t> |
4757 |
<t>Where <name> is an optional argument allowing to |
<t>Where <name> is an optional argument allowing to |
4758 |
assign a custom name to the new map. MIDI instrument Map |
assign a custom name to the new map. MIDI instrument Map |
4759 |
names do not have to be unique.</t> |
names do not have to be unique, but MUST be encapsulated |
4760 |
|
into apostrophes and support escape sequences as described |
4761 |
|
in chapter "<xref target="character_set">Character Set and Escape Sequences</xref>". |
4762 |
|
</t> |
4763 |
|
|
4764 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
4765 |
<t> |
<t> |
4802 |
</t> |
</t> |
4803 |
</section> |
</section> |
4804 |
|
|
4805 |
<section title="Delete one particular or all MIDI instrument maps" anchor="REMOVE MIDI_INSTRUMENT_MAP"> |
<section title="Delete one particular or all MIDI instrument maps" anchor="REMOVE MIDI_INSTRUMENT_MAP" lscp_cmd="true"> |
4806 |
<t>The front-end can delete a particular MIDI instrument map |
<t>The front-end can delete a particular MIDI instrument map |
4807 |
by sending the following command:</t> |
by sending the following command:</t> |
4808 |
<t> |
<t> |
4852 |
</t> |
</t> |
4853 |
</section> |
</section> |
4854 |
|
|
4855 |
<section title="Get amount of existing MIDI instrument maps" anchor="GET MIDI_INSTRUMENT_MAPS"> |
<section title="Get amount of existing MIDI instrument maps" anchor="GET MIDI_INSTRUMENT_MAPS" lscp_cmd="true"> |
4856 |
<t>The front-end can retrieve the current amount of MIDI |
<t>The front-end can retrieve the current amount of MIDI |
4857 |
instrument maps by sending the following command:</t> |
instrument maps by sending the following command:</t> |
4858 |
<t> |
<t> |
4878 |
</t> |
</t> |
4879 |
</section> |
</section> |
4880 |
|
|
4881 |
<section title="Getting all created MIDI instrument maps" anchor="LIST MIDI_INSTRUMENT_MAPS"> |
<section title="Getting all created MIDI instrument maps" anchor="LIST MIDI_INSTRUMENT_MAPS" lscp_cmd="true"> |
4882 |
<t>The number of MIDI instrument maps can change on runtime. To get the |
<t>The number of MIDI instrument maps can change on runtime. To get the |
4883 |
current list of MIDI instrument maps, the front-end can send the |
current list of MIDI instrument maps, the front-end can send the |
4884 |
following command:</t> |
following command:</t> |
4903 |
</t> |
</t> |
4904 |
</section> |
</section> |
4905 |
|
|
4906 |
<section title="Getting MIDI instrument map information" anchor="GET MIDI_INSTRUMENT_MAP INFO"> |
<section title="Getting MIDI instrument map information" anchor="GET MIDI_INSTRUMENT_MAP INFO" lscp_cmd="true"> |
4907 |
<t>The front-end can ask for the current settings of a MIDI |
<t>The front-end can ask for the current settings of a MIDI |
4908 |
instrument map by sending the following command:</t> |
instrument map by sending the following command:</t> |
4909 |
<t> |
<t> |
4930 |
<t>NAME - |
<t>NAME - |
4931 |
<list> |
<list> |
4932 |
<t>custom name of the given map, |
<t>custom name of the given map, |
4933 |
which does not have to be unique</t> |
which does not have to be unique |
4934 |
|
(note that this character string may contain |
4935 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4936 |
</list> |
</list> |
4937 |
</t> |
</t> |
4938 |
<t>DEFAULT - |
<t>DEFAULT - |
4958 |
</t> |
</t> |
4959 |
</section> |
</section> |
4960 |
|
|
4961 |
<section title="Renaming a MIDI instrument map" anchor="SET MIDI_INSTRUMENT_MAP NAME"> |
<section title="Renaming a MIDI instrument map" anchor="SET MIDI_INSTRUMENT_MAP NAME" lscp_cmd="true"> |
4962 |
<t>The front-end can alter the custom name of a MIDI |
<t>The front-end can alter the custom name of a MIDI |
4963 |
instrument map by sending the following command:</t> |
instrument map by sending the following command:</t> |
4964 |
<t> |
<t> |
4968 |
</t> |
</t> |
4969 |
<t>Where <map> is the numerical ID of the map and |
<t>Where <map> is the numerical ID of the map and |
4970 |
<name> the new custom name of the map, which does not |
<name> the new custom name of the map, which does not |
4971 |
have to be unique.</t> |
have to be unique (name MUST be encapsulated into apostrophes |
4972 |
|
and supports escape sequences as described in chapter |
4973 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"). |
4974 |
|
</t> |
4975 |
|
|
4976 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
4977 |
<t> |
<t> |
4998 |
</t> |
</t> |
4999 |
</section> |
</section> |
5000 |
|
|
5001 |
<section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT"> |
<section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT" lscp_cmd="true"> |
5002 |
<t>The front-end can create a new or replace an existing entry |
<t>The front-end can create a new or replace an existing entry |
5003 |
in a sampler's MIDI instrument map by sending the following |
in a sampler's MIDI instrument map by sending the following |
5004 |
command:</t> |
command:</t> |
5171 |
</t> |
</t> |
5172 |
</section> |
</section> |
5173 |
|
|
5174 |
<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" lscp_cmd="true"> |
5175 |
<t>The front-end can query the amount of currently existing |
<t>The front-end can query the amount of currently existing |
5176 |
entries in a MIDI instrument map by sending the following |
entries in a MIDI instrument map by sending the following |
5177 |
command:</t> |
command:</t> |
5211 |
</t> |
</t> |
5212 |
</section> |
</section> |
5213 |
|
|
5214 |
<section title="Getting indeces of all entries of a MIDI instrument map" anchor="LIST MIDI_INSTRUMENTS"> |
<section title="Getting indeces of all entries of a MIDI instrument map" anchor="LIST MIDI_INSTRUMENTS" lscp_cmd="true"> |
5215 |
<t>The front-end can query a list of all currently existing |
<t>The front-end can query a list of all currently existing |
5216 |
entries in a certain MIDI instrument map by sending the following |
entries in a certain MIDI instrument map by sending the following |
5217 |
command:</t> |
command:</t> |
5240 |
just reflects the key of the respective map entry, |
just reflects the key of the respective map entry, |
5241 |
thus subsequent |
thus subsequent |
5242 |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
5243 |
command(s) are necessary to retrieve detailed informations |
command(s) are necessary to retrieve detailed information |
5244 |
about each entry.</t> |
about each entry.</t> |
5245 |
</list> |
</list> |
5246 |
</t> |
</t> |
5254 |
</t> |
</t> |
5255 |
</section> |
</section> |
5256 |
|
|
5257 |
<section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT"> |
<section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT" lscp_cmd="true"> |
5258 |
<t>The front-end can delete an entry from a MIDI instrument |
<t>The front-end can delete an entry from a MIDI instrument |
5259 |
map by sending the following command:</t> |
map by sending the following command:</t> |
5260 |
<t> |
<t> |
5296 |
</t> |
</t> |
5297 |
</section> |
</section> |
5298 |
|
|
5299 |
<section title="Get current settings of MIDI instrument map entry" anchor="GET MIDI_INSTRUMENT INFO"> |
<section title="Get current settings of MIDI instrument map entry" anchor="GET MIDI_INSTRUMENT INFO" lscp_cmd="true"> |
5300 |
<t>The front-end can retrieve the current settings of a certain |
<t>The front-end can retrieve the current settings of a certain |
5301 |
instrument map entry by sending the following command:</t> |
instrument map entry by sending the following command:</t> |
5302 |
<t> |
<t> |
5329 |
name for this mapped instrument. It can be set and |
name for this mapped instrument. It can be set and |
5330 |
changed with the |
changed with the |
5331 |
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
5332 |
command and does not have to be unique.</t> |
command and does not have to be unique. |
5333 |
|
(note that this character string may contain |
5334 |
|
<xref target="character_set">escape sequences</xref>)</t> |
5335 |
</list> |
</list> |
5336 |
</t> |
</t> |
5337 |
<t>"ENGINE_NAME" - |
<t>"ENGINE_NAME" - |
5342 |
</t> |
</t> |
5343 |
<t>"INSTRUMENT_FILE" - |
<t>"INSTRUMENT_FILE" - |
5344 |
<list> |
<list> |
5345 |
<t>File name of the instrument.</t> |
<t>File name of the instrument |
5346 |
|
(note that this path may contain |
5347 |
|
<xref target="character_set">escape sequences</xref>).</t> |
5348 |
</list> |
</list> |
5349 |
</t> |
</t> |
5350 |
<t>"INSTRUMENT_NR" - |
<t>"INSTRUMENT_NR" - |
5356 |
<list> |
<list> |
5357 |
<t>Name of the loaded instrument as reflected by its file. |
<t>Name of the loaded instrument as reflected by its file. |
5358 |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
5359 |
cannot be changed.</t> |
cannot be changed (note that this character string may contain |
5360 |
|
<xref target="character_set">escape sequences</xref>).</t> |
5361 |
</list> |
</list> |
5362 |
</t> |
</t> |
5363 |
<t>"LOAD_MODE" - |
<t>"LOAD_MODE" - |
5393 |
</t> |
</t> |
5394 |
</section> |
</section> |
5395 |
|
|
5396 |
<section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS"> |
<section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS" lscp_cmd="true"> |
5397 |
<t>The front-end can clear a whole MIDI instrument map, that |
<t>The front-end can clear a whole MIDI instrument map, that |
5398 |
is delete all its entries by sending the following command:</t> |
is delete all its entries by sending the following command:</t> |
5399 |
<t> |
<t> |
5458 |
</list> |
</list> |
5459 |
</t> |
</t> |
5460 |
|
|
5461 |
<section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY"> |
<section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY" lscp_cmd="true"> |
5462 |
<t>The front-end can add a new instrument directory to the |
<t>The front-end can add a new instrument directory to the |
5463 |
instruments database by sending the following command:</t> |
instruments database by sending the following command:</t> |
5464 |
<t> |
<t> |
5496 |
</t> |
</t> |
5497 |
</section> |
</section> |
5498 |
|
|
5499 |
<section title="Deleting an instrument directory" anchor="REMOVE DB_INSTRUMENT_DIRECTORY"> |
<section title="Deleting an instrument directory" anchor="REMOVE DB_INSTRUMENT_DIRECTORY" lscp_cmd="true"> |
5500 |
<t>The front-end can delete a particular instrument directory |
<t>The front-end can delete a particular instrument directory |
5501 |
from the instruments database by sending the following command:</t> |
from the instruments database by sending the following command:</t> |
5502 |
<t> |
<t> |
5535 |
</t> |
</t> |
5536 |
</section> |
</section> |
5537 |
|
|
5538 |
<section title="Getting amount of instrument directories" anchor="GET DB_INSTRUMENT_DIRECTORIES"> |
<section title="Getting amount of instrument directories" anchor="GET DB_INSTRUMENT_DIRECTORIES" lscp_cmd="true"> |
5539 |
<t>The front-end can retrieve the current amount of |
<t>The front-end can retrieve the current amount of |
5540 |
directories in a specific directory by sending the following command:</t> |
directories in a specific directory by sending the following command:</t> |
5541 |
<t> |
<t> |
5570 |
</t> |
</t> |
5571 |
</section> |
</section> |
5572 |
|
|
5573 |
<section title="Listing all directories in specific directory" anchor="LIST DB_INSTRUMENT_DIRECTORIES"> |
<section title="Listing all directories in specific directory" anchor="LIST DB_INSTRUMENT_DIRECTORIES" lscp_cmd="true"> |
5574 |
<t>The front-end can retrieve the current list of directories |
<t>The front-end can retrieve the current list of directories |
5575 |
in specific directory by sending the following command:</t> |
in specific directory by sending the following command:</t> |
5576 |
<t> |
<t> |
5610 |
</t> |
</t> |
5611 |
</section> |
</section> |
5612 |
|
|
5613 |
<section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO"> |
<section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO" lscp_cmd="true"> |
5614 |
<t>The front-end can ask for the current settings of an |
<t>The front-end can ask for the current settings of an |
5615 |
instrument directory by sending the following command:</t> |
instrument directory by sending the following command:</t> |
5616 |
<t> |
<t> |
5669 |
</t> |
</t> |
5670 |
</section> |
</section> |
5671 |
|
|
5672 |
<section title="Renaming an instrument directory" anchor="SET DB_INSTRUMENT_DIRECTORY NAME"> |
<section title="Renaming an instrument directory" anchor="SET DB_INSTRUMENT_DIRECTORY NAME" lscp_cmd="true"> |
5673 |
<t>The front-end can alter the name of a specific |
<t>The front-end can alter the name of a specific |
5674 |
instrument directory by sending the following command:</t> |
instrument directory by sending the following command:</t> |
5675 |
<t> |
<t> |
5707 |
</t> |
</t> |
5708 |
</section> |
</section> |
5709 |
|
|
5710 |
<section title="Moving an instrument directory" anchor="MOVE DB_INSTRUMENT_DIRECTORY"> |
<section title="Moving an instrument directory" anchor="MOVE DB_INSTRUMENT_DIRECTORY" lscp_cmd="true"> |
5711 |
<t>The front-end can move a specific |
<t>The front-end can move a specific |
5712 |
instrument directory by sending the following command:</t> |
instrument directory by sending the following command:</t> |
5713 |
<t> |
<t> |
5749 |
</t> |
</t> |
5750 |
</section> |
</section> |
5751 |
|
|
5752 |
<section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY"> |
<section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY" lscp_cmd="true"> |
5753 |
<t>The front-end can copy a specific |
<t>The front-end can copy a specific |
5754 |
instrument directory by sending the following command:</t> |
instrument directory by sending the following command:</t> |
5755 |
<t> |
<t> |
5791 |
</t> |
</t> |
5792 |
</section> |
</section> |
5793 |
|
|
5794 |
<section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"> |
<section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" lscp_cmd="true"> |
5795 |
<t>The front-end can alter the description of a specific |
<t>The front-end can alter the description of a specific |
5796 |
instrument directory by sending the following command:</t> |
instrument directory by sending the following command:</t> |
5797 |
<t> |
<t> |
5829 |
</t> |
</t> |
5830 |
</section> |
</section> |
5831 |
|
|
5832 |
<section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES"> |
<section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES" lscp_cmd="true"> |
5833 |
<t>The front-end can search for directories |
<t>The front-end can search for directories |
5834 |
in specific directory by sending the following command:</t> |
in specific directory by sending the following command:</t> |
5835 |
<t> |
<t> |
5919 |
</t> |
</t> |
5920 |
</section> |
</section> |
5921 |
|
|
5922 |
<section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS"> |
<section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS" lscp_cmd="true"> |
5923 |
<t>The front-end can add one or more instruments |
<t>The front-end can add one or more instruments |
5924 |
to the instruments database by sending the following command:</t> |
to the instruments database by sending the following command:</t> |
5925 |
<t> |
<t> |
5926 |
<list> |
<list> |
5927 |
<t>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path> [<instr_index>]</t> |
<t>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>[ FILE_AS_DIR]] <db_dir> <file_path> [<instr_index>]</t> |
5928 |
</list> |
</list> |
5929 |
</t> |
</t> |
5930 |
<t>Where <db_dir> is the absolute path name of a directory |
<t>Where <db_dir> is the absolute path name of a directory |
5969 |
</list> |
</list> |
5970 |
</t> |
</t> |
5971 |
|
|
5972 |
|
<t> If FILE_AS_DIR argument is supplied, all instruments in an instrument |
5973 |
|
file will be added to a separate directory in the instruments database, which |
5974 |
|
name will be the name of the instrument file with the file extension stripped off. |
5975 |
|
</t> |
5976 |
<t>The difference between regular and NON_MODAL versions of the command |
<t>The difference between regular and NON_MODAL versions of the command |
5977 |
is that the regular command returns when the scanning is finished |
is that the regular command returns when the scanning is finished |
5978 |
while NON_MODAL version returns immediately and a background process is launched. |
while NON_MODAL version returns immediately and a background process is launched. |
6012 |
</t> |
</t> |
6013 |
</section> |
</section> |
6014 |
|
|
6015 |
<section title="Removing an instrument" anchor="REMOVE DB_INSTRUMENT"> |
<section title="Removing an instrument" anchor="REMOVE DB_INSTRUMENT" lscp_cmd="true"> |
6016 |
<t>The front-end can remove a particular instrument |
<t>The front-end can remove a particular instrument |
6017 |
from the instruments database by sending the following command:</t> |
from the instruments database by sending the following command:</t> |
6018 |
<t> |
<t> |
6049 |
</t> |
</t> |
6050 |
</section> |
</section> |
6051 |
|
|
6052 |
<section title="Getting amount of instruments" anchor="GET DB_INSTRUMENTS"> |
<section title="Getting amount of instruments" anchor="GET DB_INSTRUMENTS" lscp_cmd="true"> |
6053 |
<t>The front-end can retrieve the current amount of |
<t>The front-end can retrieve the current amount of |
6054 |
instruments in a specific directory by sending the following command:</t> |
instruments in a specific directory by sending the following command:</t> |
6055 |
<t> |
<t> |
6084 |
</t> |
</t> |
6085 |
</section> |
</section> |
6086 |
|
|
6087 |
<section title="Listing all instruments in specific directory" anchor="LIST DB_INSTRUMENTS"> |
<section title="Listing all instruments in specific directory" anchor="LIST DB_INSTRUMENTS" lscp_cmd="true"> |
6088 |
<t>The front-end can retrieve the current list of instruments |
<t>The front-end can retrieve the current list of instruments |
6089 |
in specific directory by sending the following command:</t> |
in specific directory by sending the following command:</t> |
6090 |
<t> |
<t> |
6124 |
</t> |
</t> |
6125 |
</section> |
</section> |
6126 |
|
|
6127 |
<section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO"> |
<section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO" lscp_cmd="true"> |
6128 |
<t>The front-end can ask for the current settings of an |
<t>The front-end can ask for the current settings of an |
6129 |
instrument by sending the following command:</t> |
instrument by sending the following command:</t> |
6130 |
<t> |
<t> |
6249 |
</t> |
</t> |
6250 |
</section> |
</section> |
6251 |
|
|
6252 |
<section title="Renaming an instrument" anchor="SET DB_INSTRUMENT NAME"> |
<section title="Renaming an instrument" anchor="SET DB_INSTRUMENT NAME" lscp_cmd="true"> |
6253 |
<t>The front-end can alter the name of a specific |
<t>The front-end can alter the name of a specific |
6254 |
instrument by sending the following command:</t> |
instrument by sending the following command:</t> |
6255 |
<t> |
<t> |
6287 |
</t> |
</t> |
6288 |
</section> |
</section> |
6289 |
|
|
6290 |
<section title="Moving an instrument" anchor="MOVE DB_INSTRUMENT"> |
<section title="Moving an instrument" anchor="MOVE DB_INSTRUMENT" lscp_cmd="true"> |
6291 |
<t>The front-end can move a specific instrument to another directory by |
<t>The front-end can move a specific instrument to another directory by |
6292 |
sending the following command:</t> |
sending the following command:</t> |
6293 |
<t> |
<t> |
6327 |
</t> |
</t> |
6328 |
</section> |
</section> |
6329 |
|
|
6330 |
<section title="Copying instruments" anchor="COPY DB_INSTRUMENT"> |
<section title="Copying instruments" anchor="COPY DB_INSTRUMENT" lscp_cmd="true"> |
6331 |
<t>The front-end can copy a specific instrument to another directory by |
<t>The front-end can copy a specific instrument to another directory by |
6332 |
sending the following command:</t> |
sending the following command:</t> |
6333 |
<t> |
<t> |
6367 |
</t> |
</t> |
6368 |
</section> |
</section> |
6369 |
|
|
6370 |
<section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION"> |
<section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION" lscp_cmd="true"> |
6371 |
<t>The front-end can alter the description of a specific |
<t>The front-end can alter the description of a specific |
6372 |
instrument by sending the following command:</t> |
instrument by sending the following command:</t> |
6373 |
<t> |
<t> |
6376 |
</list> |
</list> |
6377 |
</t> |
</t> |
6378 |
<t>Where <instr> is the absolute path name of the instrument and |
<t>Where <instr> is the absolute path name of the instrument and |
6379 |
<desc> is the new description for the instrument |
<desc> is the new description for the instrument |
6380 |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
6381 |
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6382 |
|
|
6405 |
</t> |
</t> |
6406 |
</section> |
</section> |
6407 |
|
|
6408 |
<section title="Finding instruments" anchor="FIND DB_INSTRUMENTS"> |
<section title="Finding instruments" anchor="FIND DB_INSTRUMENTS" lscp_cmd="true"> |
6409 |
<t>The front-end can search for instruments |
<t>The front-end can search for instruments |
6410 |
in specific directory by sending the following command:</t> |
in specific directory by sending the following command:</t> |
6411 |
<t> |
<t> |
6546 |
</t> |
</t> |
6547 |
</section> |
</section> |
6548 |
|
|
6549 |
<section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO"> |
<section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO" lscp_cmd="true"> |
6550 |
<t>The front-end can ask for the current status of a |
<t>The front-end can ask for the current status of a |
6551 |
particular database instruments job by sending the following command:</t> |
particular database instruments job by sending the following command:</t> |
6552 |
<t> |
<t> |
6610 |
</t> |
</t> |
6611 |
</section> |
</section> |
6612 |
|
|
6613 |
<section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB"> |
<section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB" lscp_cmd="true"> |
6614 |
<t>The front-end can remove all instruments and directories and re-create |
<t>The front-end can remove all instruments and directories and re-create |
6615 |
the instruments database structure (e.g., in case of a database corruption) |
the instruments database structure (e.g., in case of a database corruption) |
6616 |
by sending the following command:</t> |
by sending the following command:</t> |
6619 |
<t>FORMAT INSTRUMENTS_DB</t> |
<t>FORMAT INSTRUMENTS_DB</t> |
6620 |
</list> |
</list> |
6621 |
</t> |
</t> |
6622 |
|
|
6623 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
6624 |
<t> |
<t> |
6625 |
<list> |
<list> |
6638 |
</t> |
</t> |
6639 |
</section> |
</section> |
6640 |
|
|
6641 |
|
<section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES" lscp_cmd="true"> |
6642 |
|
<t>The front-end can retrieve the list of all instrument files in the instruments database |
6643 |
|
that don't exist in the filesystem by sending the following command:</t> |
6644 |
|
<t> |
6645 |
|
<list> |
6646 |
|
<t>FIND LOST DB_INSTRUMENT_FILES</t> |
6647 |
|
</list> |
6648 |
|
</t> |
6649 |
|
|
6650 |
|
<t>Possible Answers:</t> |
6651 |
|
<t> |
6652 |
|
<list> |
6653 |
|
<t>A comma separated list with the absolute path names |
6654 |
|
(encapsulated into apostrophes) of all lost instrument files.</t> |
6655 |
|
<t>"ERR:<error-code>:<error-message>" - |
6656 |
|
<list> |
6657 |
|
<t>in case it failed, providing an appropriate error code and error message.</t> |
6658 |
|
</list> |
6659 |
|
</t> |
6660 |
|
</list> |
6661 |
|
</t> |
6662 |
|
<t>Example:</t> |
6663 |
|
<t> |
6664 |
|
<list> |
6665 |
|
<t>C: "FIND LOST DB_INSTRUMENT_FILES"</t> |
6666 |
|
<t>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"</t> |
6667 |
|
</list> |
6668 |
|
</t> |
6669 |
|
</section> |
6670 |
|
|
6671 |
|
<section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH" lscp_cmd="true"> |
6672 |
|
<t>The front-end can substitute all occurrences of an instrument file |
6673 |
|
in the instruments database with a new one by sending the following command:</t> |
6674 |
|
<t> |
6675 |
|
<list> |
6676 |
|
<t>SET DB_INSTRUMENT FILE_PATH <old_path> <new_path></t> |
6677 |
|
</list> |
6678 |
|
</t> |
6679 |
|
<t>Where <old_path> is the absolute path name of the instrument file |
6680 |
|
to substitute with <new_path>.</t> |
6681 |
|
|
6682 |
|
<t>Possible Answers:</t> |
6683 |
|
<t> |
6684 |
|
<list> |
6685 |
|
<t>"OK" - |
6686 |
|
<list> |
6687 |
|
<t>on success</t> |
6688 |
|
</list> |
6689 |
|
</t> |
6690 |
|
<t>"ERR:<error-code>:<error-message>" - |
6691 |
|
<list> |
6692 |
|
<t>in case it failed, providing an appropriate error code and error message.</t> |
6693 |
|
</list> |
6694 |
|
</t> |
6695 |
|
</list> |
6696 |
|
</t> |
6697 |
|
|
6698 |
|
<t>Example:</t> |
6699 |
|
<t> |
6700 |
|
<list> |
6701 |
|
<t>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"</t> |
6702 |
|
<t>S: "OK"</t> |
6703 |
|
</list> |
6704 |
|
</t> |
6705 |
|
</section> |
6706 |
|
|
6707 |
</section> |
</section> |
6708 |
|
|
6709 |
|
|
6719 |
<t>At the moment there is only one command for this feature set, |
<t>At the moment there is only one command for this feature set, |
6720 |
but this will most probably change in future.</t> |
but this will most probably change in future.</t> |
6721 |
|
|
6722 |
<section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT"> |
<section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT" lscp_cmd="true"> |
6723 |
<t>The front-end can request to open an appropriate instrument |
<t>The front-end can request to open an appropriate instrument |
6724 |
editor application by sending the following command:</t> |
editor application by sending the following command:</t> |
6725 |
<t> |
<t> |
6726 |
<list> |
<list> |
6727 |
<t>EDIT INSTRUMENT <sampler-channel></t> |
<t>EDIT CHANNEL INSTRUMENT <sampler-channel></t> |
6728 |
</list> |
</list> |
6729 |
</t> |
</t> |
6730 |
<t>Where <sampler-channel> should be replaced by the |
<t>Where <sampler-channel> should be replaced by the |
6776 |
<t>Examples:</t> |
<t>Examples:</t> |
6777 |
<t> |
<t> |
6778 |
<list> |
<list> |
6779 |
<t>C: "EDIT INSTRUMENT 0"</t> |
<t>C: "EDIT CHANNEL INSTRUMENT 0"</t> |
6780 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
6781 |
</list> |
</list> |
6782 |
</t> |
</t> |
6783 |
</section> |
</section> |
6784 |
</section> |
</section> |
|
</section> |
|
6785 |
|
|
6786 |
|
<section title="Managing Files" anchor="file_management"> |
6787 |
|
<t>You can query detailed information about files located |
6788 |
|
at the same system where the sampler instance is running on. |
6789 |
|
Using this command set allows to retrieve file information |
6790 |
|
even remotely from another machine.</t> |
6791 |
|
|
6792 |
|
<section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS" lscp_cmd="true"> |
6793 |
|
<t>The front-end can retrieve the amount of instruments |
6794 |
|
within a given instrument file by sending the |
6795 |
|
following command:</t> |
6796 |
|
<t> |
6797 |
|
<list> |
6798 |
|
<t>GET FILE INSTRUMENTS <filename></t> |
6799 |
|
</list> |
6800 |
|
</t> |
6801 |
|
<t>Where <filename> is the name of the instrument |
6802 |
|
file (encapsulated into apostrophes, supporting escape |
6803 |
|
sequences as described in chapter |
6804 |
|
"<xref target="character_set">Character Set and Escape |
6805 |
|
Sequences</xref>").</t> |
6806 |
|
|
6807 |
|
<t>The sampler will try to ask all sampler engines, |
6808 |
|
whether they support the given file and ask the first |
6809 |
|
engine with a positive answer for the amount of |
6810 |
|
instruments.</t> |
6811 |
|
|
6812 |
|
<t>Possible Answers:</t> |
6813 |
|
<t> |
6814 |
|
<list> |
6815 |
|
<t>On success, the sampler will answer by |
6816 |
|
returning the amount of instruments. |
6817 |
|
</t> |
6818 |
|
<t>"ERR:<error-code>:<error-message>" - |
6819 |
|
<list> |
6820 |
|
<t>if the file could not be handled</t> |
6821 |
|
</list> |
6822 |
|
</t> |
6823 |
|
</list> |
6824 |
|
</t> |
6825 |
|
|
6826 |
|
<t>Examples:</t> |
6827 |
|
<t> |
6828 |
|
<list> |
6829 |
|
<t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
6830 |
|
<t>S: "10"</t> |
6831 |
|
</list> |
6832 |
|
</t> |
6833 |
|
</section> |
6834 |
|
|
6835 |
|
<section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS" lscp_cmd="true"> |
6836 |
|
<t>The front-end can retrieve a list of all instruments |
6837 |
|
within a given instrument file by sending the |
6838 |
|
following command:</t> |
6839 |
|
<t> |
6840 |
|
<list> |
6841 |
|
<t>LIST FILE INSTRUMENTS <filename></t> |
6842 |
|
</list> |
6843 |
|
</t> |
6844 |
|
<t>Where <filename> is the name of the instrument |
6845 |
|
file (encapsulated into apostrophes, supporting escape |
6846 |
|
sequences as described in chapter |
6847 |
|
"<xref target="character_set">Character Set and Escape |
6848 |
|
Sequences</xref>").</t> |
6849 |
|
|
6850 |
|
<t>The sampler will try to ask all sampler engines, |
6851 |
|
whether they support the given file and ask the first |
6852 |
|
engine with a positive answer for a list of IDs for the |
6853 |
|
instruments in the given file.</t> |
6854 |
|
|
6855 |
|
<t>Possible Answers:</t> |
6856 |
|
<t> |
6857 |
|
<list> |
6858 |
|
<t>On success, the sampler will answer by |
6859 |
|
returning a comma separated list of |
6860 |
|
instrument IDs. |
6861 |
|
</t> |
6862 |
|
<t>"ERR:<error-code>:<error-message>" - |
6863 |
|
<list> |
6864 |
|
<t>if the file could not be handled</t> |
6865 |
|
</list> |
6866 |
|
</t> |
6867 |
|
</list> |
6868 |
|
</t> |
6869 |
|
|
6870 |
|
<t>Examples:</t> |
6871 |
|
<t> |
6872 |
|
<list> |
6873 |
|
<t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
6874 |
|
<t>S: "0,1,2,3,4,5,6,7,8,9"</t> |
6875 |
|
</list> |
6876 |
|
</t> |
6877 |
|
</section> |
6878 |
|
|
6879 |
|
<section title="Retrieving information about one instrument in a file" anchor="GET FILE INSTRUMENT INFO" lscp_cmd="true"> |
6880 |
|
<t>The front-end can retrieve detailed information |
6881 |
|
about a specific instrument within a given instrument |
6882 |
|
file by sending the following command:</t> |
6883 |
|
<t> |
6884 |
|
<list> |
6885 |
|
<t>GET FILE INSTRUMENT INFO <filename> |
6886 |
|
<instr-id></t> |
6887 |
|
</list> |
6888 |
|
</t> |
6889 |
|
<t>Where <filename> is the name of the instrument |
6890 |
|
file (encapsulated into apostrophes, supporting escape |
6891 |
|
sequences as described in chapter |
6892 |
|
"<xref target="character_set">Character Set and Escape |
6893 |
|
Sequences</xref>") and <instr-id> is the numeric |
6894 |
|
instrument ID as returned by the |
6895 |
|
<xref target="LIST FILE INSTRUMENTS"> |
6896 |
|
"LIST FILE INSTRUMENTS"</xref> command.</t> |
6897 |
|
|
6898 |
|
<t>The sampler will try to ask all sampler engines, |
6899 |
|
whether they support the given file and ask the first |
6900 |
|
engine with a positive answer for information about the |
6901 |
|
specific instrument in the given file.</t> |
6902 |
|
|
6903 |
|
<t>Possible Answers:</t> |
6904 |
|
<t> |
6905 |
|
<list> |
6906 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
6907 |
|
Each answer line begins with the settings category name |
6908 |
|
followed by a colon and then a space character <SP> and finally |
6909 |
|
the info character string to that setting category. At the |
6910 |
|
moment the following categories are defined:</t> |
6911 |
|
|
6912 |
|
<t> |
6913 |
|
<list> |
6914 |
|
<t>NAME - |
6915 |
|
<list> |
6916 |
|
<t>name of the instrument as |
6917 |
|
stored in the instrument file</t> |
6918 |
|
</list> |
6919 |
|
</t> |
6920 |
|
<t>FORMAT_FAMILY - |
6921 |
|
<list> |
6922 |
|
<t>name of the sampler format |
6923 |
|
of the given instrument</t> |
6924 |
|
</list> |
6925 |
|
</t> |
6926 |
|
<t>FORMAT_VERSION - |
6927 |
|
<list> |
6928 |
|
<t>version of the sampler format |
6929 |
|
the instrumen is stored as</t> |
6930 |
|
</list> |
6931 |
|
</t> |
6932 |
|
<t>PRODUCT - |
6933 |
|
<list> |
6934 |
|
<t>official product name of the |
6935 |
|
instrument as stored in the file |
6936 |
|
</t> |
6937 |
|
</list> |
6938 |
|
</t> |
6939 |
|
<t>ARTISTS - |
6940 |
|
<list> |
6941 |
|
<t>artists / sample library |
6942 |
|
vendor of the instrument</t> |
6943 |
|
</list> |
6944 |
|
</t> |
6945 |
|
<t>KEY_BINDINGS - |
6946 |
|
<list> |
6947 |
|
<t>comma separated list of integer values representing |
6948 |
|
the instrument's key mapping in the range between 0 .. 127, |
6949 |
|
reflecting the analog meaning of the MIDI specification.</t> |
6950 |
|
</list> |
6951 |
|
</t> |
6952 |
|
<t>KEYSWITCH_BINDINGS - |
6953 |
|
<list> |
6954 |
|
<t>comma separated list of integer values representing |
6955 |
|
the instrument's keyswitch mapping in the range between 0 .. 127, |
6956 |
|
reflecting the analog meaning of the MIDI specification.</t> |
6957 |
|
</list> |
6958 |
|
</t> |
6959 |
|
</list> |
6960 |
|
</t> |
6961 |
|
</list> |
6962 |
|
</t> |
6963 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
6964 |
|
|
6965 |
|
<t>Example:</t> |
6966 |
|
<t> |
6967 |
|
<list> |
6968 |
|
<t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t> |
6969 |
|
<t>S: "NAME: Lunatic Loops"</t> |
6970 |
|
<t> "FORMAT_FAMILY: GIG"</t> |
6971 |
|
<t> "FORMAT_VERSION: 3"</t> |
6972 |
|
<t> "PRODUCT: The Backbone Bongo Beats"</t> |
6973 |
|
<t> "ARTISTS: Jimmy the Fish"</t> |
6974 |
|
<t> "."</t> |
6975 |
|
</list> |
6976 |
|
</t> |
6977 |
|
</section> |
6978 |
|
</section> |
6979 |
|
<section title="Managing Effects" anchor="effects"> |
6980 |
|
<t>There are two possible approaches to apply audio effects |
6981 |
|
(e.g. reverb, delay, compression). |
6982 |
|
You can either a) load and apply internal effects or you can b) route |
6983 |
|
effect sends directly to dedicated output channels of your |
6984 |
|
audio device and apply effects externally (e.g. by routing |
6985 |
|
those dedicated output channels to another application).</t> |
6986 |
|
<t>This chapter describes how to load and manage internal effects. |
6987 |
|
If your intention is rather to apply effects externally, then |
6988 |
|
you can omit this chapter. For applying effects externally, you |
6989 |
|
just need to <xref target="CREATE FX_SEND">create FX sends</xref> |
6990 |
|
on the respective sampler channel(s) |
6991 |
|
and <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">adjust their destination audio channels</xref> |
6992 |
|
appropriately, because by default FX sends are automatically routed |
6993 |
|
directly to the audio output device.</t> |
6994 |
|
<t>The sampler usually provides a set of internal audio effects. |
6995 |
|
The exact set of effects depends on the availability |
6996 |
|
of third party effect plugins installed on the system where the |
6997 |
|
sampler runs on (e.g. LADSPA plugins).</t> |
6998 |
|
<t>At the moment only "send effects" are supported. Support for |
6999 |
|
"insert effects" and "master effects" is planned to be added at |
7000 |
|
a later point.</t> |
7001 |
|
<t>The following commands allow to retrieve the set of internal |
7002 |
|
effects available to the sampler, detailed information about |
7003 |
|
those effects and to create and destroy instances of such |
7004 |
|
effects. After an instance of an effect is created, the effect |
7005 |
|
instance can be inserted into the audio signal path of the |
7006 |
|
sampler, e.g. as send effect.</t> |
7007 |
|
<t>The sampler allows to create an arbitrary amount of so called |
7008 |
|
send effect chains. Each effect chain can host an arbitrary |
7009 |
|
amount of effect instances. The output of the first effect |
7010 |
|
instance in an effect chain is fed to the input of the second |
7011 |
|
effect instance of the chain and so on. So effects in one chain |
7012 |
|
are processed sequentially. Send effect chains however are |
7013 |
|
processed in parallel to other send effect chains. Audio signals |
7014 |
|
of sampler channels are fed to send effects by creating FX sends |
7015 |
|
to the respective sampler channel and assigning a destination |
7016 |
|
send effect to that FX by using the |
7017 |
|
<xref target="SET FX_SEND EFFECT">"SET FX_SEND EFFECT"</xref> |
7018 |
|
command. The latter allows to route the FX send to the beginning |
7019 |
|
of a send effect chain, as well as directly to any other |
7020 |
|
position of the send effect chain.</t> |
7021 |
|
|
7022 |
|
<section title="Retrieve amount of available effects" anchor="GET AVAILABLE_EFFECTS" lscp_cmd="true"> |
7023 |
|
<t>The front-end can retrieve the amount of internal |
7024 |
|
effects, available to the sampler by sending |
7025 |
|
the following command:</t> |
7026 |
|
<t> |
7027 |
|
<list> |
7028 |
|
<t>GET AVAILABLE_EFFECTS</t> |
7029 |
|
</list> |
7030 |
|
</t> |
7031 |
|
|
7032 |
|
<t>Possible Answers:</t> |
7033 |
|
<t> |
7034 |
|
<list> |
7035 |
|
<t>The sampler will answer by returning the current |
7036 |
|
number of effects available to the sampler.</t> |
7037 |
|
</list> |
7038 |
|
</t> |
7039 |
|
|
7040 |
|
<t>Examples:</t> |
7041 |
|
<t> |
7042 |
|
<list> |
7043 |
|
<t>C: "GET AVAILABLE_EFFECTS"</t> |
7044 |
|
<t>S: "129"</t> |
7045 |
|
</list> |
7046 |
|
</t> |
7047 |
|
</section> |
7048 |
|
|
7049 |
|
<section title="Get list of available effects" anchor="LIST AVAILABLE_EFFECTS" lscp_cmd="true"> |
7050 |
|
<t>The set of available internal effects can change at |
7051 |
|
runtime. The front-end can retrieve the list of internal |
7052 |
|
effects, available to the sampler by sending the following |
7053 |
|
command:</t> |
7054 |
|
<t> |
7055 |
|
<list> |
7056 |
|
<t>LIST AVAILABLE_EFFECTS</t> |
7057 |
|
</list> |
7058 |
|
</t> |
7059 |
|
|
7060 |
|
<t>Possible Answers:</t> |
7061 |
|
<t> |
7062 |
|
<list> |
7063 |
|
<t>The sampler will answer by returning a comma |
7064 |
|
separated list with numerical IDs of effects. Note: |
7065 |
|
the numercial ID of an effect is generated by the |
7066 |
|
sampler for the current moment. The numerical ID of |
7067 |
|
the same effect can change at runtime, e.g. when the |
7068 |
|
user requests a rescan of available effect plugins. |
7069 |
|
</t> |
7070 |
|
</list> |
7071 |
|
</t> |
7072 |
|
<t>Example:</t> |
7073 |
|
<t> |
7074 |
|
<list> |
7075 |
|
<t>C: "LIST AVAILABLE_EFFECTS"</t> |
7076 |
|
<t>S: "5,6,7,120,121,122,123,124"</t> |
7077 |
|
</list> |
7078 |
|
</t> |
7079 |
|
</section> |
7080 |
|
|
7081 |
|
<section title="Retrieving general information about an effect" anchor="GET EFFECT INFO" lscp_cmd="true"> |
7082 |
|
<t>The front-end can ask for general information about an |
7083 |
|
effect by sending the following command:</t> |
7084 |
|
<t> |
7085 |
|
<list> |
7086 |
|
<t>GET EFFECT INFO <effect-index></t> |
7087 |
|
</list> |
7088 |
|
</t> |
7089 |
|
<t>Where <effect-index> is the numerical ID of an |
7090 |
|
effect as returned by the |
7091 |
|
<xref target="LIST AVAILABLE_EFFECTS">"LIST AVAILABLE_EFFECTS"</xref> |
7092 |
|
command.</t> |
7093 |
|
<t>Possible Answers:</t> |
7094 |
|
<t> |
7095 |
|
<list> |
7096 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
7097 |
|
Each answer line begins with the effect information |
7098 |
|
category name, followed by a colon and then a space |
7099 |
|
character <SP> and finally the info character |
7100 |
|
string to that effect information category. At the |
7101 |
|
moment the following categories are defined:</t> |
7102 |
|
<t> |
7103 |
|
<list> |
7104 |
|
<t>SYSTEM - |
7105 |
|
<list> |
7106 |
|
<t>name of the effect plugin system |
7107 |
|
the effect is based on |
7108 |
|
(e.g. "LADSPA")</t> |
7109 |
|
</list> |
7110 |
|
</t> |
7111 |
|
<t>MODULE - |
7112 |
|
<list> |
7113 |
|
<t>module of the effect plugin |
7114 |
|
system that contains this effect, |
7115 |
|
the module is usually the |
7116 |
|
dynamic-linked library (DLL) |
7117 |
|
filename of the effect plugin, |
7118 |
|
including full path (note that this |
7119 |
|
filename may contain |
7120 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7121 |
|
</list> |
7122 |
|
</t> |
7123 |
|
<t>NAME - |
7124 |
|
<list> |
7125 |
|
<t>character string defining the |
7126 |
|
unique name of the effect within its |
7127 |
|
module (note that the character |
7128 |
|
string may contain |
7129 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7130 |
|
</list> |
7131 |
|
</t> |
7132 |
|
<t>DESCRIPTION - |
7133 |
|
<list> |
7134 |
|
<t>human readable name of the |
7135 |
|
effect, intended to be displayed in |
7136 |
|
user interfaces (note that the |
7137 |
|
character string may contain |
7138 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7139 |
|
</list> |
7140 |
|
</t> |
7141 |
|
</list> |
7142 |
|
</t> |
7143 |
|
</list> |
7144 |
|
</t> |
7145 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
7146 |
|
|
7147 |
|
<t>Example:</t> |
7148 |
|
<t> |
7149 |
|
<list> |
7150 |
|
<t>C: "GET EFFECT INFO 121"</t> |
7151 |
|
<t>S: "SYSTEM: LADSPA"</t> |
7152 |
|
<t> "MODULE: /usr/lib/ladspa/lowpass_iir_1891.so"</t> |
7153 |
|
<t> "NAME: lowpass_iir"</t> |
7154 |
|
<t> "DESCRIPTION: Glame Lowpass Filter"</t> |
7155 |
|
<t> "."</t> |
7156 |
|
</list> |
7157 |
|
</t> |
7158 |
|
</section> |
7159 |
|
|
7160 |
|
<section title="Creating an instance of an effect by its portable ID" anchor="CREATE EFFECT_INSTANCE" lscp_cmd="true"> |
7161 |
|
<t>The front-end can spawn an instance of the desired |
7162 |
|
effect by sending the following command:</t> |
7163 |
|
<t> |
7164 |
|
<list> |
7165 |
|
<t>CREATE EFFECT_INSTANCE <effect-system> <module> <effect-name></t> |
7166 |
|
</list> |
7167 |
|
</t> |
7168 |
|
<t>Where <effect-system> is the "SYSTEM" field, |
7169 |
|
<module> the "MODULE" field and <effect-name> |
7170 |
|
the "NAME" field as returned by the |
7171 |
|
<xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref> |
7172 |
|
command. The filename of argument <module> and the |
7173 |
|
character string of argument <effect-name> may contain |
7174 |
|
<xref target="character_set">escape sequences</xref>.</t> |
7175 |
|
|
7176 |
|
<t>The sampler will try to load the requested effect and to |
7177 |
|
create an instance of it. To allow loading the same effect |
7178 |
|
on a different machine, probably even running a completely |
7179 |
|
different operating system (e.g. Linux vs. Windows), the |
7180 |
|
sampler tries to match <module> "softly". That means |
7181 |
|
it first tries to find an effect that exactly matches the |
7182 |
|
given <module> argument. If there is no exact match, |
7183 |
|
the sampler will try to lower the restrictions on matching |
7184 |
|
the <module> argument more and more, e.g. by ignoring |
7185 |
|
upper / lower case differences and by ignoring the path of |
7186 |
|
the DLL filename and file extension. If there is still no |
7187 |
|
match at the end, the sampler will try to ignore the |
7188 |
|
<module> argument completely and as a last resort |
7189 |
|
search for an effect that only matches the given |
7190 |
|
<effect-system> and <effect-name> arguments.</t> |
7191 |
|
|
7192 |
|
<t>Possible Answers:</t> |
7193 |
|
<t> |
7194 |
|
<list> |
7195 |
|
<t>"OK[<effect-instance>]" - |
7196 |
|
<list> |
7197 |
|
<t>in case the effect instance was |
7198 |
|
successfully created, where |
7199 |
|
<effect-instance> is the numerical ID |
7200 |
|
of the new effect instance</t> |
7201 |
|
</list> |
7202 |
|
</t> |
7203 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
7204 |
|
<list> |
7205 |
|
<t>in case the effect instance was spawned |
7206 |
|
successfully, but there are noteworthy |
7207 |
|
issue(s) related, providing an appropriate |
7208 |
|
warning code and warning message</t> |
7209 |
|
</list> |
7210 |
|
</t> |
7211 |
|
<t>"ERR:<error-code>:<error-message>" - |
7212 |
|
<list> |
7213 |
|
<t>if the effect could not be instantiated</t> |
7214 |
|
</list> |
7215 |
|
</t> |
7216 |
|
</list> |
7217 |
|
</t> |
7218 |
|
|
7219 |
|
<t>Examples:</t> |
7220 |
|
<t> |
7221 |
|
<list> |
7222 |
|
<t>C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/mod_delay_1419.so' 'modDelay'"</t> |
7223 |
|
<t>S: "OK[0]"</t> |
7224 |
|
</list> |
7225 |
|
</t> |
7226 |
|
</section> |
7227 |
|
|
7228 |
|
<section title="Creating an instance of an effect by its numerical ID" anchor="CREATE EFFECT_INSTANCE (non-portable)"> |
7229 |
|
<t>The front-end can spawn an instance of the desired |
7230 |
|
effect by sending the following command:</t> |
7231 |
|
<t> |
7232 |
|
<list> |
7233 |
|
<t>CREATE EFFECT_INSTANCE <effect-index></t> |
7234 |
|
</list> |
7235 |
|
</t> |
7236 |
|
<t>Where <effect-index> is the numerical ID of the |
7237 |
|
effect as returned by the |
7238 |
|
<xref target="LIST AVAILABLE_EFFECTS">"LIST AVAILABLE_EFFECTS"</xref> |
7239 |
|
command.</t> |
7240 |
|
|
7241 |
|
<t>The sampler will try to load the requested effect and to |
7242 |
|
create an instance of it.</t> |
7243 |
|
|
7244 |
|
<t>Note: Since the numerical ID of a certain effect can |
7245 |
|
change at any time, you should not use this command in |
7246 |
|
LSCP files to restore a certain effect at a later time! To |
7247 |
|
store a sampler session including all its effects, use the |
7248 |
|
<xref target="CREATE EFFECT_INSTANCE">portable text-based |
7249 |
|
version of "CREATE EFFECT_INSTANCE"</xref> instead! This |
7250 |
|
allows to restore a sampler session with all its effects |
7251 |
|
also on other machines, possibly even running a completely |
7252 |
|
different operating system (e.g. Linux vs. Windows), with |
7253 |
|
different plugin directories or plugin DLL names.</t> |
7254 |
|
|
7255 |
|
<t>Possible Answers:</t> |
7256 |
|
<t> |
7257 |
|
<list> |
7258 |
|
<t>"OK[<effect-instance>]" - |
7259 |
|
<list> |
7260 |
|
<t>in case the effect instance was |
7261 |
|
successfully created, where |
7262 |
|
<effect-instance> is the numerical ID |
7263 |
|
of the new effect instance</t> |
7264 |
|
</list> |
7265 |
|
</t> |
7266 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
7267 |
|
<list> |
7268 |
|
<t>in case the effect instance was spawned |
7269 |
|
successfully, but there are noteworthy |
7270 |
|
issue(s) related, providing an appropriate |
7271 |
|
warning code and warning message</t> |
7272 |
|
</list> |
7273 |
|
</t> |
7274 |
|
<t>"ERR:<error-code>:<error-message>" - |
7275 |
|
<list> |
7276 |
|
<t>if the effect could not be instantiated</t> |
7277 |
|
</list> |
7278 |
|
</t> |
7279 |
|
</list> |
7280 |
|
</t> |
7281 |
|
|
7282 |
|
<t>Examples:</t> |
7283 |
|
<t> |
7284 |
|
<list> |
7285 |
|
<t>C: "CREATE EFFECT_INSTANCE 72"</t> |
7286 |
|
<t>S: "OK[5]"</t> |
7287 |
|
</list> |
7288 |
|
</t> |
7289 |
|
</section> |
7290 |
|
|
7291 |
|
<section title="Destroy an effect instance" anchor="DESTROY EFFECT_INSTANCE" lscp_cmd="true"> |
7292 |
|
<t>The front-end can destroy an unusued effect instance and |
7293 |
|
thus freeing it from memory by sending the following command:</t> |
7294 |
|
<t> |
7295 |
|
<list> |
7296 |
|
<t>DESTROY EFFECT_INSTANCE <effect-instance></t> |
7297 |
|
</list> |
7298 |
|
</t> |
7299 |
|
<t>Where <effect-instance> is the numerical ID of the |
7300 |
|
effect instance as returned by the |
7301 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
7302 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7303 |
|
command.</t> |
7304 |
|
|
7305 |
|
<t>The effect instance can only be destroyed if it's not |
7306 |
|
used in any part of the sampler's audio signal path anymore. |
7307 |
|
If the effect instance is still in use somewhere, trying to |
7308 |
|
destroy the effect instance will result in an error |
7309 |
|
message.</t> |
7310 |
|
|
7311 |
|
<t>Possible Answers:</t> |
7312 |
|
<t> |
7313 |
|
<list> |
7314 |
|
<t>"OK" - |
7315 |
|
<list> |
7316 |
|
<t>in case the effect instance was successfully destroyed</t> |
7317 |
|
</list> |
7318 |
|
</t> |
7319 |
|
<t>"ERR:<error-code>:<error-message>" - |
7320 |
|
<list> |
7321 |
|
<t>in case it failed, providing an appropriate error code and |
7322 |
|
error message</t> |
7323 |
|
</list> |
7324 |
|
</t> |
7325 |
|
</list> |
7326 |
|
</t> |
7327 |
|
|
7328 |
|
<t>Examples:</t> |
7329 |
|
<t> |
7330 |
|
<list> |
7331 |
|
<t>C: "DESTROY EFFECT_INSTANCE 5"</t> |
7332 |
|
<t>S: "OK"</t> |
7333 |
|
</list> |
7334 |
|
</t> |
7335 |
|
</section> |
7336 |
|
|
7337 |
|
<section title="Retrieve amount of effect instances" anchor="GET EFFECT_INSTANCES" lscp_cmd="true"> |
7338 |
|
<t>The front-end can retrieve the current amount of effect |
7339 |
|
instances by sending the following command:</t> |
7340 |
|
<t> |
7341 |
|
<list> |
7342 |
|
<t>GET EFFECT_INSTANCES</t> |
7343 |
|
</list> |
7344 |
|
</t> |
7345 |
|
|
7346 |
|
<t>Possible Answers:</t> |
7347 |
|
<t> |
7348 |
|
<list> |
7349 |
|
<t>The sampler will answer by returning the current |
7350 |
|
number of effect instances created and not yet |
7351 |
|
destroyed in the current sampler session.</t> |
7352 |
|
</list> |
7353 |
|
</t> |
7354 |
|
|
7355 |
|
<t>Examples:</t> |
7356 |
|
<t> |
7357 |
|
<list> |
7358 |
|
<t>C: "GET EFFECT_INSTANCES"</t> |
7359 |
|
<t>S: "14"</t> |
7360 |
|
</list> |
7361 |
|
</t> |
7362 |
|
</section> |
7363 |
|
|
7364 |
|
<section title="Get list of effect instances" anchor="LIST EFFECT_INSTANCES" lscp_cmd="true"> |
7365 |
|
<t>The front-end can retrieve the current list of effect |
7366 |
|
instances by sending the following command:</t> |
7367 |
|
<t> |
7368 |
|
<list> |
7369 |
|
<t>LIST EFFECT_INSTANCES</t> |
7370 |
|
</list> |
7371 |
|
</t> |
7372 |
|
|
7373 |
|
<t>Possible Answers:</t> |
7374 |
|
<t> |
7375 |
|
<list> |
7376 |
|
<t>The sampler will answer by returning a comma |
7377 |
|
separated list with numerical IDs of effects |
7378 |
|
instances. |
7379 |
|
</t> |
7380 |
|
</list> |
7381 |
|
</t> |
7382 |
|
<t>Example:</t> |
7383 |
|
<t> |
7384 |
|
<list> |
7385 |
|
<t>C: "LIST EFFECT_INSTANCES"</t> |
7386 |
|
<t>S: "9,11,14,15,16,17,25"</t> |
7387 |
|
</list> |
7388 |
|
</t> |
7389 |
|
</section> |
7390 |
|
|
7391 |
|
<section title="Retrieving current information about an effect instance" anchor="GET EFFECT_INSTANCE INFO" lscp_cmd="true"> |
7392 |
|
<t>The front-end can ask for the current information about |
7393 |
|
a particular effect instance by sending the following command:</t> |
7394 |
|
<t> |
7395 |
|
<list> |
7396 |
|
<t>GET EFFECT_INSTANCE INFO <effect-instance></t> |
7397 |
|
</list> |
7398 |
|
</t> |
7399 |
|
<t>Where <effect-instance> is the numerical ID of an |
7400 |
|
effect instance as returned by the |
7401 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> |
7402 |
|
or |
7403 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7404 |
|
command.</t> |
7405 |
|
|
7406 |
|
<t>Possible Answers:</t> |
7407 |
|
<t> |
7408 |
|
<list> |
7409 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
7410 |
|
Each answer line begins with the information |
7411 |
|
category name, followed by a colon and then a space |
7412 |
|
character <SP> and finally the info character |
7413 |
|
string to that information category. At the |
7414 |
|
moment the following categories are defined:</t> |
7415 |
|
<t> |
7416 |
|
<list> |
7417 |
|
<t>SYSTEM - |
7418 |
|
<list> |
7419 |
|
<t>name of the effect plugin system |
7420 |
|
the effect is based on |
7421 |
|
(e.g. "LADSPA")</t> |
7422 |
|
</list> |
7423 |
|
</t> |
7424 |
|
<t>MODULE - |
7425 |
|
<list> |
7426 |
|
<t>module of the effect plugin |
7427 |
|
system that contains this effect, |
7428 |
|
the module is usually the |
7429 |
|
dynamic-linked library (DLL) |
7430 |
|
filename of the effect plugin, |
7431 |
|
including full path (note that this |
7432 |
|
filename may contain |
7433 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7434 |
|
</list> |
7435 |
|
</t> |
7436 |
|
<t>NAME - |
7437 |
|
<list> |
7438 |
|
<t>character string defining the |
7439 |
|
unique name of the effect within its |
7440 |
|
module (note that the character |
7441 |
|
string may contain |
7442 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7443 |
|
</list> |
7444 |
|
</t> |
7445 |
|
<t>DESCRIPTION - |
7446 |
|
<list> |
7447 |
|
<t>human readable name of the |
7448 |
|
effect, intended to be displayed in |
7449 |
|
user interfaces (note that the |
7450 |
|
character string may contain |
7451 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7452 |
|
</list> |
7453 |
|
</t> |
7454 |
|
<t>INPUT_CONTROLS - |
7455 |
|
<list> |
7456 |
|
<t>amount of input controls the |
7457 |
|
effect instance provides, to allow |
7458 |
|
controlling the effect parameters in |
7459 |
|
realtime</t> |
7460 |
|
</list> |
7461 |
|
</t> |
7462 |
|
</list> |
7463 |
|
</t> |
7464 |
|
</list> |
7465 |
|
</t> |
7466 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
7467 |
|
|
7468 |
|
<t>Example:</t> |
7469 |
|
<t> |
7470 |
|
<list> |
7471 |
|
<t>C: "GET EFFECT_INSTANCE INFO 3"</t> |
7472 |
|
<t>S: "SYSTEM: LADSPA"</t> |
7473 |
|
<t> "MODULE: /usr/lib/ladspa/mod_delay_1419.so"</t> |
7474 |
|
<t> "NAME: modDelay"</t> |
7475 |
|
<t> "DESCRIPTION: Modulatable delay"</t> |
7476 |
|
<t> "INPUT_CONTROLS: 1"</t> |
7477 |
|
<t> "."</t> |
7478 |
|
</list> |
7479 |
|
</t> |
7480 |
|
</section> |
7481 |
|
|
7482 |
|
<section title="Retrieving information about an effect parameter" anchor="GET EFFECT_INSTANCE_INPUT_CONTROL INFO" lscp_cmd="true"> |
7483 |
|
<t>Effects typically provide a certain set of effect |
7484 |
|
parameters which can be altered by the user in realtime |
7485 |
|
(e.g. depth of a reverb effect, duration of a delay effect, |
7486 |
|
dry / wet signal ratio). Those controllable effect parameters |
7487 |
|
are called "input controls". The front-end can ask for the |
7488 |
|
current information of an effect instance's input control |
7489 |
|
by sending the following command:</t> |
7490 |
|
<t> |
7491 |
|
<list> |
7492 |
|
<t>GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-control></t> |
7493 |
|
</list> |
7494 |
|
</t> |
7495 |
|
<t>Where <effect-instance> is the numerical ID of an |
7496 |
|
effect instance as returned by the |
7497 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> |
7498 |
|
or |
7499 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7500 |
|
command and <input-control> is the index of the input |
7501 |
|
control within the numerical bounds as returned by the |
7502 |
|
"INPUT_CONTROLS" field of the |
7503 |
|
<xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref> |
7504 |
|
command.</t> |
7505 |
|
|
7506 |
|
<t>Possible Answers:</t> |
7507 |
|
<t> |
7508 |
|
<list> |
7509 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
7510 |
|
Each answer line begins with the information |
7511 |
|
category name, followed by a colon and then a space |
7512 |
|
character <SP> and finally the info character |
7513 |
|
string to that information category. There are |
7514 |
|
information categories which are always returned, |
7515 |
|
independent of the respective effect parameter and |
7516 |
|
there are optional information categories |
7517 |
|
which are only shown for certain effect parameters. |
7518 |
|
At the moment the following categories are defined:</t> |
7519 |
|
<t> |
7520 |
|
<list> |
7521 |
|
<t>DESCRIPTION - |
7522 |
|
<list> |
7523 |
|
<t>(always returned) |
7524 |
|
human readable name of the |
7525 |
|
effect parameter, intended to be |
7526 |
|
displayed in user interfaces (note |
7527 |
|
that the character string may |
7528 |
|
contain <xref target="character_set">escape sequences</xref>)</t> |
7529 |
|
</list> |
7530 |
|
</t> |
7531 |
|
<t>VALUE - |
7532 |
|
<list> |
7533 |
|
<t> |
7534 |
|
(always returned) |
7535 |
|
current (optional dotted) |
7536 |
|
floating point value of this effect |
7537 |
|
parameter</t> |
7538 |
|
</list> |
7539 |
|
</t> |
7540 |
|
<t>RANGE_MIN - |
7541 |
|
<list> |
7542 |
|
<t> |
7543 |
|
(optionally returned) |
7544 |
|
minimum allowed value for this |
7545 |
|
effect parameter</t> |
7546 |
|
</list> |
7547 |
|
</t> |
7548 |
|
<t>RANGE_MAX - |
7549 |
|
<list> |
7550 |
|
<t> |
7551 |
|
(optionally returned) |
7552 |
|
maximum allowed value for this |
7553 |
|
effect parameter</t> |
7554 |
|
</list> |
7555 |
|
</t> |
7556 |
|
<t>POSSIBILITIES - |
7557 |
|
<list> |
7558 |
|
<t> |
7559 |
|
(optionally returned) |
7560 |
|
comma separated list of |
7561 |
|
(optional dotted) floating point |
7562 |
|
numbers, reflecting the exact set of |
7563 |
|
possible values for this effect |
7564 |
|
parameter</t> |
7565 |
|
</list> |
7566 |
|
</t> |
7567 |
|
<t>DEFAULT - |
7568 |
|
<list> |
7569 |
|
<t> |
7570 |
|
(optionally returned) |
7571 |
|
default value of this effect |
7572 |
|
parameter</t> |
7573 |
|
</list> |
7574 |
|
</t> |
7575 |
|
</list> |
7576 |
|
</t> |
7577 |
|
</list> |
7578 |
|
</t> |
7579 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
7580 |
|
|
7581 |
|
<t>Example:</t> |
7582 |
|
<t> |
7583 |
|
<list> |
7584 |
|
<t>C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0"</t> |
7585 |
|
<t>S: "DESCRIPTION: Base delay (s)"</t> |
7586 |
|
<t> "VALUE: 0.500"</t> |
7587 |
|
<t> "RANGE_MIN: 0.000"</t> |
7588 |
|
<t> "."</t> |
7589 |
|
</list> |
7590 |
|
</t> |
7591 |
|
</section> |
7592 |
|
|
7593 |
|
<section title="Altering an effect parameter" anchor="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE" lscp_cmd="true"> |
7594 |
|
<t>The front-end can alter the current value of an effect |
7595 |
|
parameter by sending the following command:</t> |
7596 |
|
<t> |
7597 |
|
<list> |
7598 |
|
<t>SET EFFECT_INSTANCE_INPUT_CONTROL VALUE <effect-instance> <input-control> <value></t> |
7599 |
|
</list> |
7600 |
|
</t> |
7601 |
|
<t>Where <effect-instance> is the numerical ID of the |
7602 |
|
effect instance as returned by the |
7603 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
7604 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7605 |
|
command, <input-control> is the index of the input |
7606 |
|
control within the numerical bounds as returned by the |
7607 |
|
"INPUT_CONTROLS" field of the |
7608 |
|
<xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref> |
7609 |
|
command and <value> is the new (optional dotted) |
7610 |
|
floating point value for this effect parameter.</t> |
7611 |
|
|
7612 |
|
<t>Possible Answers:</t> |
7613 |
|
<t> |
7614 |
|
<list> |
7615 |
|
<t>"OK" - |
7616 |
|
<list> |
7617 |
|
<t>in case the effect was altered successfully</t> |
7618 |
|
</list> |
7619 |
|
</t> |
7620 |
|
<t>"ERR:<error-code>:<error-message>" - |
7621 |
|
<list> |
7622 |
|
<t>in case it failed, providing an appropriate error code and |
7623 |
|
error message</t> |
7624 |
|
</list> |
7625 |
|
</t> |
7626 |
|
</list> |
7627 |
|
</t> |
7628 |
|
|
7629 |
|
<t>Examples:</t> |
7630 |
|
<t> |
7631 |
|
<list> |
7632 |
|
<t>C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5"</t> |
7633 |
|
<t>S: "OK"</t> |
7634 |
|
</list> |
7635 |
|
</t> |
7636 |
|
</section> |
7637 |
|
|
7638 |
|
<section title="Retrieve amount of send effect chains" anchor="GET SEND_EFFECT_CHAINS" lscp_cmd="true"> |
7639 |
|
<t>The front-end can retrieve the current amount of send |
7640 |
|
effect chains of an audio output device by sending the |
7641 |
|
following command:</t> |
7642 |
|
<t> |
7643 |
|
<list> |
7644 |
|
<t>GET SEND_EFFECT_CHAINS <audio-device></t> |
7645 |
|
</list> |
7646 |
|
</t> |
7647 |
|
<t>Where <audio-device> should be replaced by the |
7648 |
|
numerical ID of the audio output device as given by the |
7649 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7650 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7651 |
|
command.</t> |
7652 |
|
|
7653 |
|
<t>Possible Answers:</t> |
7654 |
|
<t> |
7655 |
|
<list> |
7656 |
|
<t>The sampler will answer by returning the current |
7657 |
|
number of send effect chains of the supplied audio |
7658 |
|
output device.</t> |
7659 |
|
</list> |
7660 |
|
</t> |
7661 |
|
|
7662 |
|
<t>Examples:</t> |
7663 |
|
<t> |
7664 |
|
<list> |
7665 |
|
<t>C: "GET SEND_EFFECT_CHAINS 0"</t> |
7666 |
|
<t>S: "4"</t> |
7667 |
|
</list> |
7668 |
|
</t> |
7669 |
|
</section> |
7670 |
|
|
7671 |
|
<section title="Retrieve list of send effect chains" anchor="LIST SEND_EFFECT_CHAINS" lscp_cmd="true"> |
7672 |
|
<t>The front-end can retrieve the current list of send |
7673 |
|
effect chains of an audio output device by sending the |
7674 |
|
following command:</t> |
7675 |
|
<t> |
7676 |
|
<list> |
7677 |
|
<t>LIST SEND_EFFECT_CHAINS <audio-device></t> |
7678 |
|
</list> |
7679 |
|
</t> |
7680 |
|
<t>Where <audio-device> should be replaced by the |
7681 |
|
numerical ID of the audio output device as given by the |
7682 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7683 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7684 |
|
command.</t> |
7685 |
|
|
7686 |
|
<t>Possible Answers:</t> |
7687 |
|
<t> |
7688 |
|
<list> |
7689 |
|
<t>The sampler will answer by returning a comma |
7690 |
|
separated list with numerical IDs of send effect |
7691 |
|
chains of the supplied audio output device. |
7692 |
|
</t> |
7693 |
|
</list> |
7694 |
|
</t> |
7695 |
|
|
7696 |
|
<t>Examples:</t> |
7697 |
|
<t> |
7698 |
|
<list> |
7699 |
|
<t>C: "LIST SEND_EFFECT_CHAINS 0"</t> |
7700 |
|
<t>S: "3,4,7"</t> |
7701 |
|
</list> |
7702 |
|
</t> |
7703 |
|
</section> |
7704 |
|
|
7705 |
|
<section title="Add send effect chain" anchor="ADD SEND_EFFECT_CHAIN" lscp_cmd="true"> |
7706 |
|
<t>The front-end can add a send effect chain by sending the |
7707 |
|
following command:</t> |
7708 |
|
<t> |
7709 |
|
<list> |
7710 |
|
<t>ADD SEND_EFFECT_CHAIN <audio-device></t> |
7711 |
|
</list> |
7712 |
|
</t> |
7713 |
|
<t>Where <audio-device> should be replaced by the |
7714 |
|
numerical ID of the audio output device as given by the |
7715 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7716 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7717 |
|
command.</t> |
7718 |
|
|
7719 |
|
<t>Possible Answers:</t> |
7720 |
|
<t> |
7721 |
|
<list> |
7722 |
|
<t>"OK[<effect-chain>]" - |
7723 |
|
<list> |
7724 |
|
<t>in case the send effect chain was |
7725 |
|
added successfully, where |
7726 |
|
<effect-chain> is the numerical ID |
7727 |
|
of the new send effect chain</t> |
7728 |
|
</list> |
7729 |
|
</t> |
7730 |
|
<t>"ERR:<error-code>:<error-message>" - |
7731 |
|
<list> |
7732 |
|
<t>if the send effect chain could not be added</t> |
7733 |
|
</list> |
7734 |
|
</t> |
7735 |
|
</list> |
7736 |
|
</t> |
7737 |
|
|
7738 |
|
<t>Examples:</t> |
7739 |
|
<t> |
7740 |
|
<list> |
7741 |
|
<t>C: "ADD SEND_EFFECT_CHAIN 0"</t> |
7742 |
|
<t>S: "OK[2]"</t> |
7743 |
|
</list> |
7744 |
|
</t> |
7745 |
|
</section> |
7746 |
|
|
7747 |
|
<section title="Remove send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN" lscp_cmd="true"> |
7748 |
|
<t>The front-end can remove a send effect chain by sending |
7749 |
|
the following command:</t> |
7750 |
|
<t> |
7751 |
|
<list> |
7752 |
|
<t>REMOVE SEND_EFFECT_CHAIN <audio-device> <effect-chain></t> |
7753 |
|
</list> |
7754 |
|
</t> |
7755 |
|
<t>Where <audio-device> should be replaced by the |
7756 |
|
numerical ID of the audio output device as given by the |
7757 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7758 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7759 |
|
command and <effect-chain> by the numerical ID as |
7760 |
|
returned by the |
7761 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7762 |
|
or |
7763 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7764 |
|
command.</t> |
7765 |
|
|
7766 |
|
<t>Possible Answers:</t> |
7767 |
|
<t> |
7768 |
|
<list> |
7769 |
|
<t>"OK" - |
7770 |
|
<list> |
7771 |
|
<t>in case the send effect chain was |
7772 |
|
removed successfully</t> |
7773 |
|
</list> |
7774 |
|
</t> |
7775 |
|
<t>"ERR:<error-code>:<error-message>" - |
7776 |
|
<list> |
7777 |
|
<t>if the send effect chain could not be removed</t> |
7778 |
|
</list> |
7779 |
|
</t> |
7780 |
|
</list> |
7781 |
|
</t> |
7782 |
|
|
7783 |
|
<t>Examples:</t> |
7784 |
|
<t> |
7785 |
|
<list> |
7786 |
|
<t>C: "REMOVE SEND_EFFECT_CHAIN 0 2"</t> |
7787 |
|
<t>S: "OK"</t> |
7788 |
|
</list> |
7789 |
|
</t> |
7790 |
|
</section> |
7791 |
|
|
7792 |
|
<section title="Retrieving information about a send effect chain" anchor="GET SEND_EFFECT_CHAIN INFO" lscp_cmd="true"> |
7793 |
|
<t>The front-end can ask for information of a send effect |
7794 |
|
chain by sending the following command:</t> |
7795 |
|
<t> |
7796 |
|
<list> |
7797 |
|
<t>GET SEND_EFFECT_CHAIN INFO <audio-device> <effect-chain></t> |
7798 |
|
</list> |
7799 |
|
</t> |
7800 |
|
<t>Where <audio-device> should be replaced by the |
7801 |
|
numerical ID of the audio output device as given by the |
7802 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7803 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7804 |
|
command and <effect-chain> by the numerical ID as |
7805 |
|
returned by the |
7806 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7807 |
|
or |
7808 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7809 |
|
command.</t> |
7810 |
|
|
7811 |
|
<t>Possible Answers:</t> |
7812 |
|
<t> |
7813 |
|
<list> |
7814 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
7815 |
|
Each answer line begins with the information |
7816 |
|
category name, followed by a colon and then a space |
7817 |
|
character <SP> and finally the info character |
7818 |
|
string to that information category. |
7819 |
|
At the moment the following categories are defined:</t> |
7820 |
|
<t> |
7821 |
|
<list> |
7822 |
|
<t>EFFECT_COUNT - |
7823 |
|
<list> |
7824 |
|
<t>amount of effects in this send |
7825 |
|
effect chain</t> |
7826 |
|
</list> |
7827 |
|
</t> |
7828 |
|
<t>EFFECT_SEQUENCE - |
7829 |
|
<list> |
7830 |
|
<t>comma separated list of the |
7831 |
|
numerical IDs of the effect |
7832 |
|
instances in this send effect chain, |
7833 |
|
in the order as they are procssed in |
7834 |
|
the effect chain</t> |
7835 |
|
</list> |
7836 |
|
</t> |
7837 |
|
</list> |
7838 |
|
</t> |
7839 |
|
</list> |
7840 |
|
</t> |
7841 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
7842 |
|
|
7843 |
|
<t>Example:</t> |
7844 |
|
<t> |
7845 |
|
<list> |
7846 |
|
<t>C: "GET SEND_EFFECT_CHAIN INFO 0 2"</t> |
7847 |
|
<t>S: "EFFECT_COUNT: 3"</t> |
7848 |
|
<t> "EFFECT_SEQUENCE: 31,4,7"</t> |
7849 |
|
<t> "."</t> |
7850 |
|
</list> |
7851 |
|
</t> |
7852 |
|
</section> |
7853 |
|
|
7854 |
|
<section title="Append effect instance to a send effect chain" anchor="APPEND SEND_EFFECT_CHAIN EFFECT" lscp_cmd="true"> |
7855 |
|
<t>The front-end can add an unused effect instance to the |
7856 |
|
end of a send effect chain by sending the following command:</t> |
7857 |
|
<t> |
7858 |
|
<list> |
7859 |
|
<t>APPEND SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <effect-instance></t> |
7860 |
|
</list> |
7861 |
|
</t> |
7862 |
|
<t>Where <audio-device> should be replaced by the |
7863 |
|
numerical ID of the audio output device as given by the |
7864 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7865 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7866 |
|
command and <effect-chain> by the numerical ID as |
7867 |
|
returned by the |
7868 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7869 |
|
or |
7870 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7871 |
|
command and <effect-instance> as returned by the |
7872 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
7873 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7874 |
|
command.</t> |
7875 |
|
<t>Only unused effect instances can be added to the effect |
7876 |
|
chain. Trying to add an effect instance which is already in |
7877 |
|
use somewhere in the audio signal path of the sampler will |
7878 |
|
result in an error.</t> |
7879 |
|
|
7880 |
|
<t>Possible Answers:</t> |
7881 |
|
<t> |
7882 |
|
<list> |
7883 |
|
<t>"OK" - |
7884 |
|
<list> |
7885 |
|
<t>in case the effect instance was |
7886 |
|
added successfully to the chain</t> |
7887 |
|
</list> |
7888 |
|
</t> |
7889 |
|
<t>"ERR:<error-code>:<error-message>" - |
7890 |
|
<list> |
7891 |
|
<t>if the effect instance could not be added</t> |
7892 |
|
</list> |
7893 |
|
</t> |
7894 |
|
</list> |
7895 |
|
</t> |
7896 |
|
|
7897 |
|
<t>Examples:</t> |
7898 |
|
<t> |
7899 |
|
<list> |
7900 |
|
<t>C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38"</t> |
7901 |
|
<t>S: "OK"</t> |
7902 |
|
</list> |
7903 |
|
</t> |
7904 |
|
</section> |
7905 |
|
|
7906 |
|
<section title="Insert effect instance to a send effect chain" anchor="INSERT SEND_EFFECT_CHAIN EFFECT" lscp_cmd="true"> |
7907 |
|
<t>The front-end can add an unused effect instance to a |
7908 |
|
certain position of a send effect chain by sending the |
7909 |
|
following command:</t> |
7910 |
|
<t> |
7911 |
|
<list> |
7912 |
|
<t>INSERT SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos> <effect-instance></t> |
7913 |
|
</list> |
7914 |
|
</t> |
7915 |
|
<t>Where <audio-device> should be replaced by the |
7916 |
|
numerical ID of the audio output device as given by the |
7917 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7918 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7919 |
|
command, <effect-chain> by the numerical ID as |
7920 |
|
returned by the |
7921 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7922 |
|
or |
7923 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7924 |
|
command, <effect-instance> as returned by the |
7925 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
7926 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7927 |
|
command and <chain-pos> the exact position of the |
7928 |
|
effect chain where the supplied effect shall be inserted |
7929 |
|
to.</t> |
7930 |
|
<t>Only unused effect instances can be added to the effect |
7931 |
|
chain. Trying to add an effect instance which is already in |
7932 |
|
use somewhere in the audio signal path of the sampler will |
7933 |
|
result in an error.</t> |
7934 |
|
|
7935 |
|
<t>Possible Answers:</t> |
7936 |
|
<t> |
7937 |
|
<list> |
7938 |
|
<t>"OK" - |
7939 |
|
<list> |
7940 |
|
<t>in case the effect instance was |
7941 |
|
added successfully to the chain</t> |
7942 |
|
</list> |
7943 |
|
</t> |
7944 |
|
<t>"ERR:<error-code>:<error-message>" - |
7945 |
|
<list> |
7946 |
|
<t>if the effect instance could not be added</t> |
7947 |
|
</list> |
7948 |
|
</t> |
7949 |
|
</list> |
7950 |
|
</t> |
7951 |
|
|
7952 |
|
<t>Examples:</t> |
7953 |
|
<t> |
7954 |
|
<list> |
7955 |
|
<t>C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38"</t> |
7956 |
|
<t>S: "OK"</t> |
7957 |
|
</list> |
7958 |
|
</t> |
7959 |
|
</section> |
7960 |
|
|
7961 |
|
<section title="Remove effect instance from send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN EFFECT" lscp_cmd="true"> |
7962 |
|
<t>The front-end can remove an effect instance from a |
7963 |
|
certain position of a send effect chain by sending the |
7964 |
|
following command:</t> |
7965 |
|
<t> |
7966 |
|
<list> |
7967 |
|
<t>REMOVE SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos></t> |
7968 |
|
</list> |
7969 |
|
</t> |
7970 |
|
<t>Where <audio-device> should be replaced by the |
7971 |
|
numerical ID of the audio output device as given by the |
7972 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7973 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7974 |
|
command, <effect-chain> by the numerical ID as |
7975 |
|
returned by the |
7976 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7977 |
|
or |
7978 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7979 |
|
command and <chain-pos> the exact position of the |
7980 |
|
effect instance to be removed from the effect chain.</t> |
7981 |
|
|
7982 |
|
<t>Possible Answers:</t> |
7983 |
|
<t> |
7984 |
|
<list> |
7985 |
|
<t>"OK" - |
7986 |
|
<list> |
7987 |
|
<t>in case the effect instance was |
7988 |
|
removed successfully</t> |
7989 |
|
</list> |
7990 |
|
</t> |
7991 |
|
<t>"ERR:<error-code>:<error-message>" - |
7992 |
|
<list> |
7993 |
|
<t>if the effect instance could not be removed</t> |
7994 |
|
</list> |
7995 |
|
</t> |
7996 |
|
</list> |
7997 |
|
</t> |
7998 |
|
|
7999 |
|
<t>Examples:</t> |
8000 |
|
<t> |
8001 |
|
<list> |
8002 |
|
<t>C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4"</t> |
8003 |
|
<t>S: "OK"</t> |
8004 |
|
</list> |
8005 |
|
</t> |
8006 |
|
</section> |
8007 |
|
|
8008 |
|
</section> |
8009 |
|
</section> |
8010 |
|
|
8011 |
<section title="Command Syntax" anchor="command_syntax"> |
<section title="Command Syntax" anchor="command_syntax"> |
8012 |
<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"/> |
8022 |
|
|
8023 |
<t>input = |
<t>input = |
8024 |
<list> |
<list> |
8025 |
<t>line LF |
<t>line |
8026 |
</t> |
</t> |
8027 |
<t>/ line CR LF |
<t>/ error |
8028 |
</t> |
</t> |
8029 |
</list> |
</list> |
8030 |
</t> |
</t> |
8031 |
<t>line = |
<t>line = |
8032 |
<list> |
<list> |
8033 |
<t>/* epsilon (empty line ignored) */ |
<t>statement LF |
8034 |
|
</t> |
8035 |
|
<t>/ statement CR LF |
8036 |
|
</t> |
8037 |
|
</list> |
8038 |
|
</t> |
8039 |
|
<t>statement = |
8040 |
|
<list> |
8041 |
|
<t>/* epsilon (empty statement/line ignored) */ |
8042 |
</t> |
</t> |
8043 |
<t>/ comment |
<t>/ comment |
8044 |
</t> |
</t> |
8045 |
<t>/ command |
<t>/ command |
8046 |
</t> |
</t> |
|
<t>/ error |
|
|
</t> |
|
8047 |
</list> |
</list> |
8048 |
</t> |
</t> |
8049 |
<t>comment = |
<t>comment = |
8100 |
</t> |
</t> |
8101 |
<t>/ FORMAT SP format_instruction |
<t>/ FORMAT SP format_instruction |
8102 |
</t> |
</t> |
8103 |
|
<t>/ SEND SP send_instruction |
8104 |
|
</t> |
8105 |
|
<t>/ APPEND SP append_instruction |
8106 |
|
</t> |
8107 |
|
<t>/ INSERT SP insert_instruction |
8108 |
|
</t> |
8109 |
<t>/ RESET |
<t>/ RESET |
8110 |
</t> |
</t> |
8111 |
<t>/ QUIT |
<t>/ QUIT |
8116 |
<list> |
<list> |
8117 |
<t>CHANNEL |
<t>CHANNEL |
8118 |
</t> |
</t> |
8119 |
|
<t>/ CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index |
8120 |
|
</t> |
8121 |
|
<t>/ CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index |
8122 |
|
</t> |
8123 |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
8124 |
</t> |
</t> |
8125 |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
8126 |
</t> |
</t> |
8127 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
8128 |
|
</t> |
8129 |
<t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
<t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
8130 |
</t> |
</t> |
8131 |
|
<t>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
8132 |
|
</t> |
8133 |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
8134 |
</t> |
</t> |
8135 |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index |
8142 |
</t> |
</t> |
8143 |
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
8144 |
</t> |
</t> |
8145 |
|
<t>/ SEND_EFFECT_CHAIN SP device_index |
8146 |
|
</t> |
8147 |
</list> |
</list> |
8148 |
</t> |
</t> |
8149 |
<t>subscribe_event = |
<t>subscribe_event = |
8158 |
</t> |
</t> |
8159 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
8160 |
</t> |
</t> |
8161 |
|
<t>/ CHANNEL_MIDI |
8162 |
|
</t> |
8163 |
|
<t>/ DEVICE_MIDI |
8164 |
|
</t> |
8165 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
8166 |
</t> |
</t> |
8167 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
8194 |
</t> |
</t> |
8195 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
8196 |
</t> |
</t> |
8197 |
|
<t>/ TOTAL_STREAM_COUNT |
8198 |
|
</t> |
8199 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
8200 |
</t> |
</t> |
8201 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
8202 |
</t> |
</t> |
8203 |
|
<t>/ EFFECT_INSTANCE_COUNT |
8204 |
|
</t> |
8205 |
|
<t>/ EFFECT_INSTANCE_INFO |
8206 |
|
</t> |
8207 |
|
<t>/ SEND_EFFECT_CHAIN_COUNT |
8208 |
|
</t> |
8209 |
|
<t>/ SEND_EFFECT_CHAIN_INFO |
8210 |
|
</t> |
8211 |
</list> |
</list> |
8212 |
</t> |
</t> |
8213 |
<t>unsubscribe_event = |
<t>unsubscribe_event = |
8222 |
</t> |
</t> |
8223 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
8224 |
</t> |
</t> |
8225 |
|
<t>/ CHANNEL_MIDI |
8226 |
|
</t> |
8227 |
|
<t>/ DEVICE_MIDI |
8228 |
|
</t> |
8229 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
8230 |
</t> |
</t> |
8231 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
8258 |
</t> |
</t> |
8259 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
8260 |
</t> |
</t> |
8261 |
|
<t>/ TOTAL_STREAM_COUNT |
8262 |
|
</t> |
8263 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
8264 |
</t> |
</t> |
8265 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
8266 |
</t> |
</t> |
8267 |
|
<t>/ EFFECT_INSTANCE_COUNT |
8268 |
|
</t> |
8269 |
|
<t>/ EFFECT_INSTANCE_INFO |
8270 |
|
</t> |
8271 |
|
<t>/ SEND_EFFECT_CHAIN_COUNT |
8272 |
|
</t> |
8273 |
|
<t>/ SEND_EFFECT_CHAIN_INFO |
8274 |
|
</t> |
8275 |
</list> |
</list> |
8276 |
</t> |
</t> |
8277 |
<t>map_instruction = |
<t>map_instruction = |
8296 |
<list> |
<list> |
8297 |
<t>CHANNEL SP sampler_channel |
<t>CHANNEL SP sampler_channel |
8298 |
</t> |
</t> |
8299 |
|
<t>/ CHANNEL SP MIDI_INPUT SP sampler_channel |
8300 |
|
</t> |
8301 |
|
<t>/ CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index |
8302 |
|
</t> |
8303 |
|
<t>/ CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index |
8304 |
|
</t> |
8305 |
<t>/ MIDI_INSTRUMENT_MAP SP midi_map |
<t>/ MIDI_INSTRUMENT_MAP SP midi_map |
8306 |
</t> |
</t> |
8307 |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
8308 |
</t> |
</t> |
8309 |
|
<t>/ SEND_EFFECT_CHAIN SP device_index SP effect_chain |
8310 |
|
</t> |
8311 |
|
<t>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos |
8312 |
|
</t> |
8313 |
|
<t>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id |
8314 |
|
</t> |
8315 |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
8316 |
</t> |
</t> |
8317 |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
8324 |
<list> |
<list> |
8325 |
<t>AVAILABLE_ENGINES |
<t>AVAILABLE_ENGINES |
8326 |
</t> |
</t> |
8327 |
|
<t>/ AVAILABLE_EFFECTS |
8328 |
|
</t> |
8329 |
|
<t>/ EFFECT_INSTANCES |
8330 |
|
</t> |
8331 |
|
<t>/ EFFECT SP INFO SP effect_index |
8332 |
|
</t> |
8333 |
|
<t>/ EFFECT_INSTANCE SP INFO SP effect_instance |
8334 |
|
</t> |
8335 |
|
<t>/ EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP input_control |
8336 |
|
</t> |
8337 |
|
<t>/ SEND_EFFECT_CHAINS SP device_index |
8338 |
|
</t> |
8339 |
|
<t>/ SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain |
8340 |
|
</t> |
8341 |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
8342 |
</t> |
</t> |
8343 |
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
8384 |
</t> |
</t> |
8385 |
<t>/ SERVER SP INFO |
<t>/ SERVER SP INFO |
8386 |
</t> |
</t> |
8387 |
|
<t>/ TOTAL_STREAM_COUNT |
8388 |
|
</t> |
8389 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
8390 |
</t> |
</t> |
8391 |
<t>/ TOTAL_VOICE_COUNT_MAX |
<t>/ TOTAL_VOICE_COUNT_MAX |
8420 |
</t> |
</t> |
8421 |
<t>/ VOLUME |
<t>/ VOLUME |
8422 |
</t> |
</t> |
8423 |
|
<t>/ VOICES |
8424 |
|
</t> |
8425 |
|
<t>/ STREAMS |
8426 |
|
</t> |
8427 |
|
<t>/ FILE SP INSTRUMENTS SP filename |
8428 |
|
</t> |
8429 |
|
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
8430 |
|
</t> |
8431 |
</list> |
</list> |
8432 |
</t> |
</t> |
8433 |
<t>set_instruction = |
<t>set_instruction = |
8442 |
</t> |
</t> |
8443 |
<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 |
8444 |
</t> |
</t> |
8445 |
|
<t>/ EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP input_control SP control_value |
8446 |
|
</t> |
8447 |
<t>/ CHANNEL SP set_chan_instruction |
<t>/ CHANNEL SP set_chan_instruction |
8448 |
</t> |
</t> |
8449 |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
8456 |
</t> |
</t> |
8457 |
<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 |
8458 |
</t> |
</t> |
8459 |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP raw_path |
<t>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos |
8460 |
</t> |
</t> |
8461 |
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP raw_path |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
8462 |
</t> |
</t> |
8463 |
<t>/ DB_INSTRUMENT SP NAME SP db_path SP raw_path |
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped |
8464 |
</t> |
</t> |
8465 |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP raw_path |
<t>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped |
8466 |
|
</t> |
8467 |
|
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
8468 |
|
</t> |
8469 |
|
<t>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename |
8470 |
</t> |
</t> |
8471 |
<t>/ ECHO SP boolean |
<t>/ ECHO SP boolean |
8472 |
</t> |
</t> |
8473 |
|
<t>/ SHELL SP INTERACT SP boolean |
8474 |
|
</t> |
8475 |
|
<t>/ SHELL SP AUTO_CORRECT SP boolean |
8476 |
|
</t> |
8477 |
|
<t>/ SHELL SP DOC SP boolean |
8478 |
|
</t> |
8479 |
<t>/ VOLUME SP volume_value |
<t>/ VOLUME SP volume_value |
8480 |
</t> |
</t> |
8481 |
|
<t>/ VOICES SP number |
8482 |
|
</t> |
8483 |
|
<t>/ STREAMS SP number |
8484 |
|
</t> |
8485 |
</list> |
</list> |
8486 |
</t> |
</t> |
8487 |
<t>create_instruction = |
<t>create_instruction = |
8498 |
</t> |
</t> |
8499 |
<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 |
8500 |
</t> |
</t> |
8501 |
|
<t>/ EFFECT_INSTANCE SP effect_index |
8502 |
|
</t> |
8503 |
|
<t>/ EFFECT_INSTANCE SP effect_system SP module SP effect_name |
8504 |
|
</t> |
8505 |
</list> |
</list> |
8506 |
</t> |
</t> |
8507 |
<t>reset_instruction = |
<t>reset_instruction = |
8528 |
</t> |
</t> |
8529 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
8530 |
</t> |
</t> |
8531 |
|
<t>/ LOST SP DB_INSTRUMENT_FILES |
8532 |
|
</t> |
8533 |
</list> |
</list> |
8534 |
</t> |
</t> |
8535 |
<t>move_instruction = |
<t>move_instruction = |
8556 |
</t> |
</t> |
8557 |
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
8558 |
</t> |
</t> |
8559 |
|
<t>/ EFFECT_INSTANCE SP number |
8560 |
|
</t> |
8561 |
</list> |
</list> |
8562 |
</t> |
</t> |
8563 |
<t>load_instruction = |
<t>load_instruction = |
8568 |
</t> |
</t> |
8569 |
</list> |
</list> |
8570 |
</t> |
</t> |
8571 |
|
<t>append_instruction = |
8572 |
|
<list> |
8573 |
|
<t>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP effect_instance |
8574 |
|
</t> |
8575 |
|
</list> |
8576 |
|
</t> |
8577 |
|
<t>insert_instruction = |
8578 |
|
<list> |
8579 |
|
<t>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos SP effect_instance |
8580 |
|
</t> |
8581 |
|
</list> |
8582 |
|
</t> |
8583 |
<t>set_chan_instruction = |
<t>set_chan_instruction = |
8584 |
<list> |
<list> |
8585 |
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
8614 |
</t> |
</t> |
8615 |
<t>edit_instruction = |
<t>edit_instruction = |
8616 |
<list> |
<list> |
8617 |
<t>INSTRUMENT SP sampler_channel |
<t>CHANNEL SP INSTRUMENT SP sampler_channel |
8618 |
</t> |
</t> |
8619 |
</list> |
</list> |
8620 |
</t> |
</t> |
8656 |
</t> |
</t> |
8657 |
<t>/ CHANNELS |
<t>/ CHANNELS |
8658 |
</t> |
</t> |
8659 |
|
<t>/ CHANNEL SP MIDI_INPUTS SP sampler_channel |
8660 |
|
</t> |
8661 |
<t>/ AVAILABLE_ENGINES |
<t>/ AVAILABLE_ENGINES |
8662 |
</t> |
</t> |
8663 |
|
<t>/ AVAILABLE_EFFECTS |
8664 |
|
</t> |
8665 |
|
<t>/ EFFECT_INSTANCES |
8666 |
|
</t> |
8667 |
|
<t>/ SEND_EFFECT_CHAINS SP number |
8668 |
|
</t> |
8669 |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
8670 |
</t> |
</t> |
8671 |
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
8686 |
</t> |
</t> |
8687 |
<t>/ DB_INSTRUMENTS SP db_path |
<t>/ DB_INSTRUMENTS SP db_path |
8688 |
</t> |
</t> |
8689 |
|
<t>/ FILE SP INSTRUMENTS SP filename |
8690 |
|
</t> |
8691 |
|
</list> |
8692 |
|
</t> |
8693 |
|
<t>send_instruction = |
8694 |
|
<list> |
8695 |
|
<t>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number |
8696 |
|
</t> |
8697 |
</list> |
</list> |
8698 |
</t> |
</t> |
8699 |
<t>load_instr_args = |
<t>load_instr_args = |
8720 |
</t> |
</t> |
8721 |
</list> |
</list> |
8722 |
</t> |
</t> |
8723 |
|
<t>effect_instance = |
8724 |
|
<list> |
8725 |
|
<t>number |
8726 |
|
</t> |
8727 |
|
</list> |
8728 |
|
</t> |
8729 |
<t>device_index = |
<t>device_index = |
8730 |
<list> |
<list> |
8731 |
<t>number |
<t>number |
8796 |
</t> |
</t> |
8797 |
</list> |
</list> |
8798 |
</t> |
</t> |
8799 |
|
<t>control_value = |
8800 |
|
<list> |
8801 |
|
<t>real |
8802 |
|
</t> |
8803 |
|
</list> |
8804 |
|
</t> |
8805 |
<t>sampler_channel = |
<t>sampler_channel = |
8806 |
<list> |
<list> |
8807 |
<t>number |
<t>number |
8840 |
</t> |
</t> |
8841 |
<t>map_name = |
<t>map_name = |
8842 |
<list> |
<list> |
8843 |
<t>stringval |
<t>stringval_escaped |
8844 |
</t> |
</t> |
8845 |
</list> |
</list> |
8846 |
</t> |
</t> |
8847 |
<t>entry_name = |
<t>entry_name = |
8848 |
<list> |
<list> |
8849 |
<t>stringval |
<t>stringval_escaped |
8850 |
</t> |
</t> |
8851 |
</list> |
</list> |
8852 |
</t> |
</t> |
8853 |
<t>fx_send_name = |
<t>fx_send_name = |
8854 |
<list> |
<list> |
8855 |
<t>stringval |
<t>stringval_escaped |
8856 |
|
</t> |
8857 |
|
</list> |
8858 |
|
</t> |
8859 |
|
<t>effect_name = |
8860 |
|
<list> |
8861 |
|
<t>stringval_escaped |
8862 |
|
</t> |
8863 |
|
</list> |
8864 |
|
</t> |
8865 |
|
<t>effect_index = |
8866 |
|
<list> |
8867 |
|
<t>number |
8868 |
|
</t> |
8869 |
|
</list> |
8870 |
|
</t> |
8871 |
|
<t>effect_chain = |
8872 |
|
<list> |
8873 |
|
<t>number |
8874 |
|
</t> |
8875 |
|
</list> |
8876 |
|
</t> |
8877 |
|
<t>chain_pos = |
8878 |
|
<list> |
8879 |
|
<t>number |
8880 |
|
</t> |
8881 |
|
</list> |
8882 |
|
</t> |
8883 |
|
<t>input_control = |
8884 |
|
<list> |
8885 |
|
<t>number |
8886 |
</t> |
</t> |
8887 |
</list> |
</list> |
8888 |
</t> |
</t> |
8917 |
</t> |
</t> |
8918 |
<t>query_val = |
<t>query_val = |
8919 |
<list> |
<list> |
8920 |
<t>raw_path_base |
<t>text_escaped |
8921 |
</t> |
</t> |
8922 |
<t>/ raw_path |
<t>/ stringval_escaped |
8923 |
</t> |
</t> |
8924 |
</list> |
</list> |
8925 |
</t> |
</t> |
8933 |
</t> |
</t> |
8934 |
</list> |
</list> |
8935 |
</t> |
</t> |
8936 |
|
<t>effect_system = |
8937 |
|
<list> |
8938 |
|
<t>string |
8939 |
|
</t> |
8940 |
|
</list> |
8941 |
|
</t> |
8942 |
|
<t>module = |
8943 |
|
<list> |
8944 |
|
<t>filename |
8945 |
|
</t> |
8946 |
|
</list> |
8947 |
|
</t> |
8948 |
|
|
8949 |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
8950 |
|
|
8978 |
where escape characters are now supported, a backslash characters |
where escape characters are now supported, a backslash characters |
8979 |
MUST be escaped as well (that is as double backslash), whereas |
MUST be escaped as well (that is as double backslash), whereas |
8980 |
in the old versions a single backslash was sufficient.</t> |
in the old versions a single backslash was sufficient.</t> |
8981 |
|
|
8982 |
|
<t>The following LSCP commands support escape sequences as part |
8983 |
|
of their filename / path based arguments and / or may contain |
8984 |
|
a filename / path with escape sequences in their response: |
8985 |
|
<list> |
8986 |
|
<t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t> |
8987 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
8988 |
|
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
8989 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
8990 |
|
<t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t> |
8991 |
|
<t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t> |
8992 |
|
<t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
8993 |
|
<t><xref target="REMOVE DB_INSTRUMENT">"REMOVE DB_INSTRUMENT"</xref></t> |
8994 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORIES">"GET DB_INSTRUMENT_DIRECTORIES"</xref></t> |
8995 |
|
<t><xref target="LIST DB_INSTRUMENT_DIRECTORIES">"LIST DB_INSTRUMENT_DIRECTORIES"</xref></t> |
8996 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
8997 |
|
<t><xref target="GET DB_INSTRUMENTS">"GET DB_INSTRUMENTS"</xref></t> |
8998 |
|
<t><xref target="LIST DB_INSTRUMENTS">"LIST DB_INSTRUMENTS"</xref></t> |
8999 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
9000 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
9001 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
9002 |
|
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
9003 |
|
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
9004 |
|
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
9005 |
|
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
9006 |
|
<t><xref target="MOVE DB_INSTRUMENT">"MOVE DB_INSTRUMENT"</xref></t> |
9007 |
|
<t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
9008 |
|
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
9009 |
|
<t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t> |
9010 |
|
<t><xref target="FIND LOST DB_INSTRUMENT_FILES">"FIND LOST DB_INSTRUMENT_FILES"</xref></t> |
9011 |
|
<t><xref target="SET DB_INSTRUMENT FILE_PATH">"SET DB_INSTRUMENT FILE_PATH"</xref></t> |
9012 |
|
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
9013 |
|
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
9014 |
|
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
9015 |
|
<t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t> |
9016 |
|
<t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t> |
9017 |
|
<t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t> |
9018 |
|
</list> |
9019 |
|
Note that the forward slash character ('/') has a special meaning in |
9020 |
|
filename / path based arguments: it acts as separator of the nodes in |
9021 |
|
the path, thus if a directory- or filename includes a forward slash |
9022 |
|
(not intended as path node separator), you MUST escape that slash |
9023 |
|
either with the respective hex escape sequence ("\x2f") or with the |
9024 |
|
respective octal escape sequence ("\057"). |
9025 |
|
</t> |
9026 |
|
|
9027 |
|
<t> |
9028 |
|
Note for Windows: file path arguments in LSCP are expected |
9029 |
|
to use forward slashes as directory node separator similar |
9030 |
|
to Unix based operating systems. In contrast to Unix however |
9031 |
|
a Windows typical drive character is expected to be |
9032 |
|
prefixed to the path. That is an original Windows file path |
9033 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
9034 |
|
"D:/Sounds/My.gig". |
9035 |
|
</t> |
9036 |
|
|
9037 |
|
<t> |
9038 |
|
The following LSCP commands even support escape sequences as |
9039 |
|
part of at least one of their text-based arguments (i.e. entity name, |
9040 |
|
description) and / or may contain escape sequences in at least one of |
9041 |
|
their text-based fields in their response: |
9042 |
|
<list> |
9043 |
|
<t><xref target="GET SERVER INFO">"GET SERVER INFO"</xref></t> |
9044 |
|
<t><xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref></t> |
9045 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
9046 |
|
<t><xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref></t> |
9047 |
|
<t><xref target="GET FX_SEND INFO">"GET FX_SEND INFO"</xref></t> |
9048 |
|
<t><xref target="SET FX_SEND NAME">"SET FX_SEND NAME"</xref></t> |
9049 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
9050 |
|
<t><xref target="GET MIDI_INSTRUMENT_MAP INFO">"GET MIDI_INSTRUMENT_MAP INFO"</xref></t> |
9051 |
|
<t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t> |
9052 |
|
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
9053 |
|
<t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t> |
9054 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
9055 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
9056 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
9057 |
|
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
9058 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
9059 |
|
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
9060 |
|
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
9061 |
|
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
9062 |
|
<t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t> |
9063 |
|
<t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t> |
9064 |
|
<t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t> |
9065 |
|
</list> |
9066 |
|
Please note that these lists are manually maintained. If you |
9067 |
|
find a command that also supports escape sequences we forgot to |
9068 |
|
mention here, please report it! |
9069 |
|
</t> |
9070 |
</section> |
</section> |
9071 |
</section> |
</section> |
9072 |
|
|
9073 |
<section title="Events" anchor="events"> |
<section title="Events" anchor="events"> |
9074 |
<t>This chapter will describe all currently defined events supported by LinuxSampler.</t> |
<t>This chapter will describe all currently defined events supported by LinuxSampler.</t> |
9075 |
|
|
9076 |
<section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"> |
<section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT" lscp_cmd="true"> |
9077 |
<t>Client may want to be notified when the total number of audio output devices on the |
<t>Client may want to be notified when the total number of audio output devices on the |
9078 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
9079 |
<t> |
<t> |
9091 |
of audio output devices.</t> |
of audio output devices.</t> |
9092 |
</section> |
</section> |
9093 |
|
|
9094 |
<section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"> |
<section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO" lscp_cmd="true"> |
9095 |
<t>Client may want to be notified when changes were made to audio output devices on the |
<t>Client may want to be notified when changes were made to audio output devices on the |
9096 |
back-end by issuing the following command:</t> |
back-end by issuing the following command:</t> |
9097 |
<t> |
<t> |
9113 |
message is sufficient here.</t> |
message is sufficient here.</t> |
9114 |
</section> |
</section> |
9115 |
|
|
9116 |
<section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"> |
<section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT" lscp_cmd="true"> |
9117 |
<t>Client may want to be notified when the total number of MIDI input devices on the |
<t>Client may want to be notified when the total number of MIDI input devices on the |
9118 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
9119 |
<t> |
<t> |
9131 |
of MIDI input devices.</t> |
of MIDI input devices.</t> |
9132 |
</section> |
</section> |
9133 |
|
|
9134 |
<section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"> |
<section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO" lscp_cmd="true"> |
9135 |
<t>Client may want to be notified when changes were made to MIDI input devices on the |
<t>Client may want to be notified when changes were made to MIDI input devices on the |
9136 |
back-end by issuing the following command:</t> |
back-end by issuing the following command:</t> |
9137 |
<t> |
<t> |
9153 |
message is sufficient here.</t> |
message is sufficient here.</t> |
9154 |
</section> |
</section> |
9155 |
|
|
9156 |
<section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT"> |
<section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT" lscp_cmd="true"> |
9157 |
<t>Client may want to be notified when the total number of channels on the |
<t>Client may want to be notified when the total number of channels on the |
9158 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
9159 |
<t> |
<t> |
9171 |
of sampler channels.</t> |
of sampler channels.</t> |
9172 |
</section> |
</section> |
9173 |
|
|
9174 |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
<section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI" lscp_cmd="true"> |
9175 |
|
<t>Client may want to be notified when MIDI data arrive on sampler channels on |
9176 |
|
back-end side, by issuing the following command:</t> |
9177 |
|
<t> |
9178 |
|
<list> |
9179 |
|
<t>SUBSCRIBE CHANNEL_MIDI</t> |
9180 |
|
</list> |
9181 |
|
</t> |
9182 |
|
<t>Server will start sending one of the the following notification messages:</t> |
9183 |
|
<t> |
9184 |
|
<list> |
9185 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"</t> |
9186 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>"</t> |
9187 |
|
</list> |
9188 |
|
</t> |
9189 |
|
<t>where <channel-id> will be replaced by the ID of the sampler channel where the MIDI |
9190 |
|
data arrived. <note> and <velocity> are integer values in the range between |
9191 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
9192 |
|
</t> |
9193 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
9194 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
9195 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
9196 |
|
thread unaffected by this feature.</t> |
9197 |
|
</section> |
9198 |
|
|
9199 |
|
<section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI" lscp_cmd="true"> |
9200 |
|
<t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t> |
9201 |
|
<t> |
9202 |
|
<list> |
9203 |
|
<t>SUBSCRIBE DEVICE_MIDI</t> |
9204 |
|
</list> |
9205 |
|
</t> |
9206 |
|
<t>Server will start sending one of the the following notification messages:</t> |
9207 |
|
<t> |
9208 |
|
<list> |
9209 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note> <velocity>"</t> |
9210 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note> <velocity>"</t> |
9211 |
|
</list> |
9212 |
|
</t> |
9213 |
|
<t>where <device-id> <port-id> will be replaced |
9214 |
|
by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI |
9215 |
|
data arrived. <note> and <velocity> are integer values in the range between |
9216 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
9217 |
|
</t> |
9218 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
9219 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
9220 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
9221 |
|
thread unaffected by this feature.</t> |
9222 |
|
</section> |
9223 |
|
|
9224 |
|
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT" lscp_cmd="true"> |
9225 |
<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 |
9226 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
9227 |
<t> |
<t> |
9240 |
active voices on that channel.</t> |
active voices on that channel.</t> |
9241 |
</section> |
</section> |
9242 |
|
|
9243 |
<section title="Number of active disk streams changed" anchor="SUBSCRIBE STREAM_COUNT"> |
<section title="Number of active disk streams changed" anchor="SUBSCRIBE STREAM_COUNT" lscp_cmd="true"> |
9244 |
<t>Client may want to be notified when the number of streams on the back-end |
<t>Client may want to be notified when the number of streams on the back-end |
9245 |
changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t> |
changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t> |
9246 |
<t> |
<t> |
9259 |
active disk streams on that channel.</t> |
active disk streams on that channel.</t> |
9260 |
</section> |
</section> |
9261 |
|
|
9262 |
<section title="Disk stream buffer fill state changed" anchor="SUBSCRIBE BUFFER_FILL"> |
<section title="Disk stream buffer fill state changed" anchor="SUBSCRIBE BUFFER_FILL" lscp_cmd="true"> |
9263 |
<t>Client may want to be notified when the buffer fill state of a disk stream |
<t>Client may want to be notified when the buffer fill state of a disk stream |
9264 |
on the back-end changes by issuing the following command:</t> |
on the back-end changes by issuing the following command:</t> |
9265 |
<t> |
<t> |
9280 |
"GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t> |
"GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t> |
9281 |
</section> |
</section> |
9282 |
|
|
9283 |
<section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO"> |
<section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO" lscp_cmd="true"> |
9284 |
<t>Client may want to be notified when changes were made to sampler channels on the |
<t>Client may want to be notified when changes were made to sampler channels on the |
9285 |
back-end by issuing the following command:</t> |
back-end by issuing the following command:</t> |
9286 |
<t> |
<t> |
9302 |
message is sufficient here.</t> |
message is sufficient here.</t> |
9303 |
</section> |
</section> |
9304 |
|
|
9305 |
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT" lscp_cmd="true"> |
9306 |
<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 |
9307 |
a particular sampler channel is changed by issuing the following command:</t> |
a particular sampler channel is changed by issuing the following command:</t> |
9308 |
<t> |
<t> |
9321 |
be replaced by the new number of effect sends on that channel.</t> |
be replaced by the new number of effect sends on that channel.</t> |
9322 |
</section> |
</section> |
9323 |
|
|
9324 |
<section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO"> |
<section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO" lscp_cmd="true"> |
9325 |
<t>Client may want to be notified when changes were made to effect sends on a |
<t>Client may want to be notified when changes were made to effect sends on a |
9326 |
a particular sampler channel by issuing the following command:</t> |
a particular sampler channel by issuing the following command:</t> |
9327 |
<t> |
<t> |
9340 |
be replaced by the numerical ID of the changed effect send.</t> |
be replaced by the numerical ID of the changed effect send.</t> |
9341 |
</section> |
</section> |
9342 |
|
|
9343 |
<section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT"> |
<section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT" lscp_cmd="true"> |
9344 |
<t>Client may want to be notified when the total number of voices on the |
<t>Client may want to be notified when the total number of voices on the |
9345 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
9346 |
<t> |
<t> |
9358 |
all currently active voices.</t> |
all currently active voices.</t> |
9359 |
</section> |
</section> |
9360 |
|
|
9361 |
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
<section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT" lscp_cmd="true"> |
9362 |
|
<t>Client may want to be notified when the total number of disk streams on the |
9363 |
|
back-end changes by issuing the following command:</t> |
9364 |
|
<t> |
9365 |
|
<list> |
9366 |
|
<t>SUBSCRIBE TOTAL_STREAM_COUNT</t> |
9367 |
|
</list> |
9368 |
|
</t> |
9369 |
|
<t>Server will start sending the following notification messages:</t> |
9370 |
|
<t> |
9371 |
|
<list> |
9372 |
|
<t>"NOTIFY:TOTAL_STREAM_COUNT:<streams>"</t> |
9373 |
|
</list> |
9374 |
|
</t> |
9375 |
|
<t>where <streams> will be replaced by the new number of |
9376 |
|
all currently active disk streams.</t> |
9377 |
|
</section> |
9378 |
|
|
9379 |
|
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT" lscp_cmd="true"> |
9380 |
<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 |
9381 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
9382 |
<t> |
<t> |
9394 |
of MIDI instrument maps.</t> |
of MIDI instrument maps.</t> |
9395 |
</section> |
</section> |
9396 |
|
|
9397 |
<section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"> |
<section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO" lscp_cmd="true"> |
9398 |
<t>Client may want to be notified when changes were made to MIDI instrument maps on the |
<t>Client may want to be notified when changes were made to MIDI instrument maps on the |
9399 |
back-end by issuing the following command:</t> |
back-end by issuing the following command:</t> |
9400 |
<t> |
<t> |
9416 |
message is sufficient here.</t> |
message is sufficient here.</t> |
9417 |
</section> |
</section> |
9418 |
|
|
9419 |
<section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT"> |
<section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT" lscp_cmd="true"> |
9420 |
<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 |
9421 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
9422 |
<t> |
<t> |
9435 |
the new number of MIDI instruments in the specified map.</t> |
the new number of MIDI instruments in the specified map.</t> |
9436 |
</section> |
</section> |
9437 |
|
|
9438 |
<section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO"> |
<section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO" lscp_cmd="true"> |
9439 |
<t>Client may want to be notified when changes were made to MIDI instruments on the |
<t>Client may want to be notified when changes were made to MIDI instruments on the |
9440 |
back-end by issuing the following command:</t> |
back-end by issuing the following command:</t> |
9441 |
<t> |
<t> |
9458 |
message is sufficient here.</t> |
message is sufficient here.</t> |
9459 |
</section> |
</section> |
9460 |
|
|
9461 |
<section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO"> |
<section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO" lscp_cmd="true"> |
9462 |
<t>Client may want to be notified when changes to the global settings |
<t>Client may want to be notified when changes to the global settings |
9463 |
of the sampler were made by issuing the following command:</t> |
of the sampler were made by issuing the following command:</t> |
9464 |
<t> |
<t> |
9474 |
replaced by the optional dotted floating point value, reflecting the |
replaced by the optional dotted floating point value, reflecting the |
9475 |
new global volume parameter.</t> |
new global volume parameter.</t> |
9476 |
</list> |
</list> |
9477 |
|
<list> |
9478 |
|
<t>"NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the |
9479 |
|
golbal limit of the sampler for maximum voices is changed, where |
9480 |
|
<max-voices> will be an integer value, reflecting the |
9481 |
|
new global voice limit parameter.</t> |
9482 |
|
</list> |
9483 |
|
<list> |
9484 |
|
<t>"NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the |
9485 |
|
golbal limit of the sampler for maximum disk streams is changed, where |
9486 |
|
<max-streams> will be an integer value, reflecting the |
9487 |
|
new global disk streams limit parameter.</t> |
9488 |
|
</list> |
9489 |
</t> |
</t> |
9490 |
</section> |
</section> |
9491 |
|
|
9492 |
<section title="Number of database instrument directories changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"> |
<section title="Number of database instrument directories changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT" lscp_cmd="true"> |
9493 |
<t>Client may want to be notified when the number of instrument |
<t>Client may want to be notified when the number of instrument |
9494 |
directories in a particular directory in the instruments database |
directories in a particular directory in the instruments database |
9495 |
is changed by issuing the following command:</t> |
is changed by issuing the following command:</t> |
9511 |
is not sent for the subdirectories in that directory.</t> |
is not sent for the subdirectories in that directory.</t> |
9512 |
</section> |
</section> |
9513 |
|
|
9514 |
<section title="Database instrument directory information changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"> |
<section title="Database instrument directory information changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO" lscp_cmd="true"> |
9515 |
<t>Client may want to be notified when changes were made to directories |
<t>Client may want to be notified when changes were made to directories |
9516 |
in the instruments database by issuing the following command:</t> |
in the instruments database by issuing the following command:</t> |
9517 |
<t> |
<t> |
9541 |
the new name of the directory, encapsulated into apostrophes.</t> |
the new name of the directory, encapsulated into apostrophes.</t> |
9542 |
</section> |
</section> |
9543 |
|
|
9544 |
<section title="Number of database instruments changed" anchor="SUBSCRIBE DB_INSTRUMENT_COUNT"> |
<section title="Number of database instruments changed" anchor="SUBSCRIBE DB_INSTRUMENT_COUNT" lscp_cmd="true"> |
9545 |
<t>Client may want to be notified when the number of instruments |
<t>Client may want to be notified when the number of instruments |
9546 |
in a particular directory in the instruments database |
in a particular directory in the instruments database |
9547 |
is changed by issuing the following command:</t> |
is changed by issuing the following command:</t> |
9563 |
is not sent for the instruments in that directory.</t> |
is not sent for the instruments in that directory.</t> |
9564 |
</section> |
</section> |
9565 |
|
|
9566 |
<section title="Database instrument information changed" anchor="SUBSCRIBE DB_INSTRUMENT_INFO"> |
<section title="Database instrument information changed" anchor="SUBSCRIBE DB_INSTRUMENT_INFO" lscp_cmd="true"> |
9567 |
<t>Client may want to be notified when changes were made to instruments |
<t>Client may want to be notified when changes were made to instruments |
9568 |
in the instruments database by issuing the following command:</t> |
in the instruments database by issuing the following command:</t> |
9569 |
<t> |
<t> |
9593 |
the new name of the instrument, encapsulated into apostrophes.</t> |
the new name of the instrument, encapsulated into apostrophes.</t> |
9594 |
</section> |
</section> |
9595 |
|
|
9596 |
<section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"> |
<section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO" lscp_cmd="true"> |
9597 |
<t>Client may want to be notified when the status of particular database |
<t>Client may want to be notified when the status of particular database |
9598 |
instruments job is changed by issuing the following command:</t> |
instruments job is changed by issuing the following command:</t> |
9599 |
<t> |
<t> |
9615 |
message is sufficient here.</t> |
message is sufficient here.</t> |
9616 |
</section> |
</section> |
9617 |
|
|
9618 |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
<section title="Number of effect instances changed" anchor="SUBSCRIBE EFFECT_INSTANCE_COUNT" lscp_cmd="true"> |
9619 |
|
<t>Client may want to be notified when the number of effect instances |
9620 |
|
is changed by issuing the following command:</t> |
9621 |
|
<t> |
9622 |
|
<list> |
9623 |
|
<t>SUBSCRIBE EFFECT_INSTANCE_COUNT</t> |
9624 |
|
</list> |
9625 |
|
</t> |
9626 |
|
<t>Server will start sending the following notification messages:</t> |
9627 |
|
<t> |
9628 |
|
<list> |
9629 |
|
<t>"EFFECT_INSTANCE_COUNT:<instances>"</t> |
9630 |
|
</list> |
9631 |
|
</t> |
9632 |
|
<t>where <instances> will be replaced by the new number |
9633 |
|
of effect instances.</t> |
9634 |
|
</section> |
9635 |
|
|
9636 |
|
<section title="Effect instance information changed" anchor="SUBSCRIBE EFFECT_INSTANCE_INFO" lscp_cmd="true"> |
9637 |
|
<t>Client may want to be notified when changes were made to effect instances |
9638 |
|
on the back-end by issuing the following command:</t> |
9639 |
|
<t> |
9640 |
|
<list> |
9641 |
|
<t>SUBSCRIBE EFFECT_INSTANCE_INFO</t> |
9642 |
|
</list> |
9643 |
|
</t> |
9644 |
|
<t>Server will start sending the following notification messages:</t> |
9645 |
|
<t> |
9646 |
|
<list> |
9647 |
|
<t>"EFFECT_INSTANCE_INFO:<instance-id>"</t> |
9648 |
|
</list> |
9649 |
|
</t> |
9650 |
|
<t>where <instance-id> will be replaced by the numerical ID |
9651 |
|
of the effect instance.</t> |
9652 |
|
</section> |
9653 |
|
|
9654 |
|
<section title="Number of send effect chains changed" anchor="SUBSCRIBE SEND_EFFECT_CHAIN_COUNT" lscp_cmd="true"> |
9655 |
|
<t>Client may want to be notified when the number of send effect chains |
9656 |
|
is changed by issuing the following command:</t> |
9657 |
|
<t> |
9658 |
|
<list> |
9659 |
|
<t>SUBSCRIBE SEND_EFFECT_CHAIN_COUNT</t> |
9660 |
|
</list> |
9661 |
|
</t> |
9662 |
|
<t>Server will start sending the following notification messages:</t> |
9663 |
|
<t> |
9664 |
|
<list> |
9665 |
|
<t>"NOTIFY:SEND_EFFECT_CHAIN_COUNT:<device-id> <chains>"</t> |
9666 |
|
</list> |
9667 |
|
</t> |
9668 |
|
<t>where <device-id> will be replaced by the numerical ID of the audio |
9669 |
|
output device, in which the number of send effect chains is changed and |
9670 |
|
<chains> will be replaced by the new number of send effect chains.</t> |
9671 |
|
</section> |
9672 |
|
|
9673 |
|
<section title="Send effect chain information changed" anchor="SUBSCRIBE SEND_EFFECT_CHAIN_INFO" lscp_cmd="true"> |
9674 |
|
<t>Client may want to be notified when changes were made to send effect chains |
9675 |
|
on the back-end by issuing the following command:</t> |
9676 |
|
<t> |
9677 |
|
<list> |
9678 |
|
<t>SUBSCRIBE SEND_EFFECT_CHAIN_INFO</t> |
9679 |
|
</list> |
9680 |
|
</t> |
9681 |
|
<t>Server will start sending the following notification messages:</t> |
9682 |
|
<t> |
9683 |
|
<list> |
9684 |
|
<t>"SEND_EFFECT_CHAIN_INFO:<device-id> <chain-id> <instances>" - |
9685 |
|
Notifies that the number of effect instances in a particular send effect chain |
9686 |
|
is changed, where <device-id> will be replaced by the numerical ID of the audio |
9687 |
|
output device the send effect chain belongs to, <chain-id> will be replaced |
9688 |
|
by the numerical ID of the send effect chain in which the number of effect instances |
9689 |
|
has changed and <instances> will be replaced by the new number |
9690 |
|
of effect instances in the specified send effect chain.</t> |
9691 |
|
</list> |
9692 |
|
</t> |
9693 |
|
</section> |
9694 |
|
|
9695 |
|
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS" lscp_cmd="true"> |
9696 |
<t>Client may want to be notified of miscellaneous and debugging events occurring at |
<t>Client may want to be notified of miscellaneous and debugging events occurring at |
9697 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |
9698 |
<t> |
<t> |