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.5"> |
<rfc category="std" ipr="full3978" docName="LSCP 1.7"> |
20 |
<front> |
<front> |
21 |
<title>LinuxSampler Control Protocol</title> |
<title>LinuxSampler Control Protocol</title> |
22 |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
23 |
Schoenebeck'> |
Schoenebeck'> |
24 |
<organization> |
<organization> |
25 |
Interessengemeinschaft Software Engineering e. V. |
LinuxSampler.org |
26 |
</organization> |
</organization> |
27 |
<address> |
<address> |
28 |
<postal> |
<postal> |
29 |
<street>Max-Planck-Str. 39</street> |
<street>Crudebyte Engineering</street> |
30 |
|
<street>Hofgartenstr. 3</street> |
31 |
<!-- <code>74081</code> --> |
<!-- <code>74081</code> --> |
32 |
<city>74081 Heilbronn</city> |
<city>74189 Weinsberg</city> |
33 |
<country>Germany</country> |
<country>Germany</country> |
34 |
</postal> |
</postal> |
35 |
<email>schoenebeck at software minus engineering dot org</email> |
<phone>+49 7134 911614</phone> |
36 |
|
<email>cuse@users.sf.net</email> |
37 |
</address> |
</address> |
38 |
</author> |
</author> |
39 |
<date month="June" year="2011"/> |
<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> |
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> |
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> |
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, "-1" 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>DEPRECATED: THIS FIELD WILL DISAPPEAR!</t> |
2596 |
<t>port number of the MIDI input device (in case a |
<t>port number of the MIDI input device (in case a |
2597 |
MIDI device was already assigned to the sampler |
MIDI device was already assigned to the sampler |
2598 |
channel)</t> |
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> |
3551 |
encapsulated into apostrophes and supports escape sequences as described in chapter |
encapsulated into apostrophes and supports escape sequences as described in chapter |
3552 |
"<xref target="character_set">Character Set and Escape Sequences</xref>".</t> |
"<xref target="character_set">Character Set and Escape Sequences</xref>".</t> |
3553 |
|
|
3554 |
<t>By default, that is as initial routing, the effect send's audio channels |
<t>Note: there are two possible approaches to apply audio effects with FX sends: |
3555 |
are automatically routed to the last audio channels of the sampler channel's |
you can either use a) internal effects or b) external effects. |
3556 |
audio output device, that way you can i.e. first increase the amount of audio |
By default, that is as initial routing, effect sends are automatically routed |
3557 |
channels on the audio output device for having dedicated effect send output |
directly to the sampler channel's audio output device and the effect send's |
3558 |
channels and when "CREATE FX_SEND" is called, those channels will automatically |
audio channels are by default automatically routed to the last audio channels |
3559 |
be picked. You can alter the destination channels however with |
of that audio output device (for the purpose of applying effects externally that is, |
3560 |
<xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>. |
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> |
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> |
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. If an internal send effect is assigned |
device (i.e. if external effect shall be applied) or b) of the audio |
3888 |
to the effect send, then this setting defines the audio |
input channel of an internal effect assigned to the FX send where |
3889 |
channel routing to that effect instance respectively.</t> |
<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="Assigning destination effect to an effect send" anchor="SET FX_SEND EFFECT"> |
<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 a destination effect to an |
<t>The front-end can (re-)assign an internal destination effect to an |
3934 |
effect send by sending the following command:</t> |
effect send by sending the following command:</t> |
3935 |
<t> |
<t> |
3936 |
<list> |
<list> |
3952 |
chain position in the effect chain which hosts the actual |
chain position in the effect chain which hosts the actual |
3953 |
destination effect.</t> |
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> |
<t>Possible Answers:</t> |
3966 |
<t> |
<t> |
3967 |
<list> |
<list> |
3986 |
</t> |
</t> |
3987 |
</section> |
</section> |
3988 |
|
|
3989 |
<section title="Removing destination effect from an effect send" anchor="REMOVE FX_SEND EFFECT"> |
<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 |
<t>The front-end can (re-)assign a destination effect to an |
3991 |
effect send by sending the following command:</t> |
effect send by sending the following command:</t> |
3992 |
<t> |
<t> |
4031 |
</t> |
</t> |
4032 |
</section> |
</section> |
4033 |
|
|
4034 |
<section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER"> |
<section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER" 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="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA"> |
<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 |
<t>The front-end can send MIDI events to a specific sampler channel |
4133 |
by sending the following command:</t> |
by sending the following command:</t> |
4134 |
<t> |
<t> |
4193 |
</t> |
</t> |
4194 |
</section> |
</section> |
4195 |
|
|
4196 |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
<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"> |
<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 |
<t>The front-end can ask for the current number of active disk streams on |
4419 |
the sampler by sending the following command:</t> |
the sampler by sending the following command:</t> |
4420 |
<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> |
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> |
4580 |
</t> |
</t> |
4581 |
</section> |
</section> |
4582 |
|
|
4583 |
<section title="Getting global voice limit" anchor="GET VOICES"> |
<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 |
<t>The client can ask for the current global sampler-wide limit |
4585 |
for maximum voices by sending the following command:</t> |
for maximum voices by sending the following command:</t> |
4586 |
<t> |
<t> |
4605 |
respective instrument and probably further criterias.</t> |
respective instrument and probably further criterias.</t> |
4606 |
</section> |
</section> |
4607 |
|
|
4608 |
<section title="Setting global voice limit" anchor="SET VOICES"> |
<section title="Setting global voice limit" anchor="SET VOICES" lscp_cmd="true"> |
4609 |
<t>The client can alter the current global sampler-wide limit |
<t>The client can alter the current global sampler-wide limit |
4610 |
for maximum voices by sending the following command:</t> |
for maximum voices by sending the following command:</t> |
4611 |
<t> |
<t> |
4649 |
adjust the disk stream limit respectively and vice versa.</t> |
adjust the disk stream limit respectively and vice versa.</t> |
4650 |
</section> |
</section> |
4651 |
|
|
4652 |
<section title="Getting global disk stream limit" anchor="GET STREAMS"> |
<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 |
<t>The client can ask for the current global sampler-wide limit |
4654 |
for maximum disk streams by sending the following command:</t> |
for maximum disk streams by sending the following command:</t> |
4655 |
<t> |
<t> |
4672 |
to perform its streaming operations.</t> |
to perform its streaming operations.</t> |
4673 |
</section> |
</section> |
4674 |
|
|
4675 |
<section title="Setting global disk stream limit" anchor="SET STREAMS"> |
<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 |
<t>The client can alter the current global sampler-wide limit |
4677 |
for maximum disk streams by sending the following command:</t> |
for maximum disk streams by sending the following command:</t> |
4678 |
<t> |
<t> |
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> |
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> |
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> |
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> |
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> |
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> |
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> |
6638 |
</t> |
</t> |
6639 |
</section> |
</section> |
6640 |
|
|
6641 |
<section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES"> |
<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 |
<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> |
that don't exist in the filesystem by sending the following command:</t> |
6644 |
<t> |
<t> |
6668 |
</t> |
</t> |
6669 |
</section> |
</section> |
6670 |
|
|
6671 |
<section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH"> |
<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 |
<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> |
in the instruments database with a new one by sending the following command:</t> |
6674 |
<t> |
<t> |
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> |
6784 |
</section> |
</section> |
6785 |
|
|
6786 |
<section title="Managing Files" anchor="file_management"> |
<section title="Managing Files" anchor="file_management"> |
6787 |
<t>You can query detailed informations about files located |
<t>You can query detailed information about files located |
6788 |
at the same system where the sampler instance is running on. |
at the same system where the sampler instance is running on. |
6789 |
Using this command set allows to retrieve file informations |
Using this command set allows to retrieve file information |
6790 |
even remotely from another machine.</t> |
even remotely from another machine.</t> |
6791 |
|
|
6792 |
<section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS"> |
<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 |
<t>The front-end can retrieve the amount of instruments |
6794 |
within a given instrument file by sending the |
within a given instrument file by sending the |
6795 |
following command:</t> |
following command:</t> |
6832 |
</t> |
</t> |
6833 |
</section> |
</section> |
6834 |
|
|
6835 |
<section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS"> |
<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 |
<t>The front-end can retrieve a list of all instruments |
6837 |
within a given instrument file by sending the |
within a given instrument file by sending the |
6838 |
following command:</t> |
following command:</t> |
6876 |
</t> |
</t> |
6877 |
</section> |
</section> |
6878 |
|
|
6879 |
<section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO"> |
<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 informations |
<t>The front-end can retrieve detailed information |
6881 |
about a specific instrument within a given instrument |
about a specific instrument within a given instrument |
6882 |
file by sending the following command:</t> |
file by sending the following command:</t> |
6883 |
<t> |
<t> |
6897 |
|
|
6898 |
<t>The sampler will try to ask all sampler engines, |
<t>The sampler will try to ask all sampler engines, |
6899 |
whether they support the given file and ask the first |
whether they support the given file and ask the first |
6900 |
engine with a positive answer for informations about the |
engine with a positive answer for information about the |
6901 |
specific instrument in the given file.</t> |
specific instrument in the given file.</t> |
6902 |
|
|
6903 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
6977 |
</section> |
</section> |
6978 |
</section> |
</section> |
6979 |
<section title="Managing Effects" anchor="effects"> |
<section title="Managing Effects" anchor="effects"> |
6980 |
<t>Audio effects (e.g. reverb, delay, compression) can be |
<t>There are two possible approaches to apply audio effects |
6981 |
applied to the audio signals generated by the sampler. The |
(e.g. reverb, delay, compression). |
6982 |
sampler usually provides a set of internal audio effects for |
You can either a) load and apply internal effects or you can b) route |
6983 |
this task. The exact set of effects depends on the availability |
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 |
of third party effect plugins installed on the system where the |
6997 |
sampler runs on.</t> |
sampler runs on (e.g. LADSPA plugins).</t> |
6998 |
<t>At the moment only "send effects" are supported. Support for |
<t>At the moment only "send effects" are supported. Support for |
6999 |
"insert effects" and "master effects" is planned to be added at |
"insert effects" and "master effects" is planned to be added at |
7000 |
a later point.</t> |
a later point.</t> |
7001 |
<t>The following commands allow to retrieve the set of internal |
<t>The following commands allow to retrieve the set of internal |
7002 |
effects available to the sampler, detailed informations about |
effects available to the sampler, detailed information about |
7003 |
those effects and to create and destroy instances of such |
those effects and to create and destroy instances of such |
7004 |
effects. After an instance of an effect is created, the effect |
effects. After an instance of an effect is created, the effect |
7005 |
instance can be inserted into the audio signal path of the |
instance can be inserted into the audio signal path of the |
7019 |
of a send effect chain, as well as directly to any other |
of a send effect chain, as well as directly to any other |
7020 |
position of the send effect chain.</t> |
position of the send effect chain.</t> |
7021 |
|
|
7022 |
<section title="Retrieve amount of available effects" anchor="GET AVAILABLE_EFFECTS"> |
<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 |
<t>The front-end can retrieve the amount of internal |
7024 |
effects, available to the sampler by sending |
effects, available to the sampler by sending |
7025 |
the following command:</t> |
the following command:</t> |
7046 |
</t> |
</t> |
7047 |
</section> |
</section> |
7048 |
|
|
7049 |
<section title="Get list of available effects" anchor="LIST AVAILABLE_EFFECTS"> |
<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 |
<t>The set of available internal effects can change at |
7051 |
runtime. The front-end can retrieve the list of internal |
runtime. The front-end can retrieve the list of internal |
7052 |
effects, available to the sampler by sending the following |
effects, available to the sampler by sending the following |
7078 |
</t> |
</t> |
7079 |
</section> |
</section> |
7080 |
|
|
7081 |
<section title="Retrieving general information about an effect" anchor="GET EFFECT INFO"> |
<section title="Retrieving general information about an effect" anchor="GET EFFECT INFO" lscp_cmd="true"> |
7082 |
<t>The front-end can ask for general informations about an |
<t>The front-end can ask for general information about an |
7083 |
effect by sending the following command:</t> |
effect by sending the following command:</t> |
7084 |
<t> |
<t> |
7085 |
<list> |
<list> |
7157 |
</t> |
</t> |
7158 |
</section> |
</section> |
7159 |
|
|
7160 |
<section title="Creating an instance of an effect by its portable ID" anchor="CREATE EFFECT_INSTANCE"> |
<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 |
<t>The front-end can spawn an instance of the desired |
7162 |
effect by sending the following command:</t> |
effect by sending the following command:</t> |
7163 |
<t> |
<t> |
7288 |
</t> |
</t> |
7289 |
</section> |
</section> |
7290 |
|
|
7291 |
<section title="Destroy an effect instance" anchor="DESTROY EFFECT_INSTANCE"> |
<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 |
<t>The front-end can destroy an unusued effect instance and |
7293 |
thus freeing it from memory by sending the following command:</t> |
thus freeing it from memory by sending the following command:</t> |
7294 |
<t> |
<t> |
7334 |
</t> |
</t> |
7335 |
</section> |
</section> |
7336 |
|
|
7337 |
<section title="Retrieve amount of effect instances" anchor="GET EFFECT_INSTANCES"> |
<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 |
<t>The front-end can retrieve the current amount of effect |
7339 |
instances by sending the following command:</t> |
instances by sending the following command:</t> |
7340 |
<t> |
<t> |
7361 |
</t> |
</t> |
7362 |
</section> |
</section> |
7363 |
|
|
7364 |
<section title="Get list of effect instances" anchor="LIST EFFECT_INSTANCES"> |
<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 |
<t>The front-end can retrieve the current list of effect |
7366 |
instances by sending the following command:</t> |
instances by sending the following command:</t> |
7367 |
<t> |
<t> |
7388 |
</t> |
</t> |
7389 |
</section> |
</section> |
7390 |
|
|
7391 |
<section title="Retrieving current information about an effect instance" anchor="GET EFFECT_INSTANCE INFO"> |
<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 informations about |
<t>The front-end can ask for the current information about |
7393 |
a particular effect instance by sending the following command:</t> |
a particular effect instance by sending the following command:</t> |
7394 |
<t> |
<t> |
7395 |
<list> |
<list> |
7479 |
</t> |
</t> |
7480 |
</section> |
</section> |
7481 |
|
|
7482 |
<section title="Retrieving information about an effect parameter" anchor="GET EFFECT_INSTANCE_INPUT_CONTROL INFO"> |
<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 |
<t>Effects typically provide a certain set of effect |
7484 |
parameters which can be altered by the user in realtime |
parameters which can be altered by the user in realtime |
7485 |
(e.g. depth of a reverb effect, duration of a delay effect, |
(e.g. depth of a reverb effect, duration of a delay effect, |
7486 |
dry / wet signal ratio). Those controllable effect parameters |
dry / wet signal ratio). Those controllable effect parameters |
7487 |
are called "input controls". The front-end can ask for the |
are called "input controls". The front-end can ask for the |
7488 |
current informations of an effect instance's input control |
current information of an effect instance's input control |
7489 |
by sending the following command:</t> |
by sending the following command:</t> |
7490 |
<t> |
<t> |
7491 |
<list> |
<list> |
7590 |
</t> |
</t> |
7591 |
</section> |
</section> |
7592 |
|
|
7593 |
<section title="Altering an effect parameter" anchor="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE"> |
<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 |
<t>The front-end can alter the current value of an effect |
7595 |
parameter by sending the following command:</t> |
parameter by sending the following command:</t> |
7596 |
<t> |
<t> |
7635 |
</t> |
</t> |
7636 |
</section> |
</section> |
7637 |
|
|
7638 |
<section title="Retrieve amount of send effect chains" anchor="GET SEND_EFFECT_CHAINS"> |
<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 |
<t>The front-end can retrieve the current amount of send |
7640 |
effect chains of an audio output device by sending the |
effect chains of an audio output device by sending the |
7641 |
following command:</t> |
following command:</t> |
7668 |
</t> |
</t> |
7669 |
</section> |
</section> |
7670 |
|
|
7671 |
<section title="Retrieve list of send effect chains" anchor="LIST SEND_EFFECT_CHAINS"> |
<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 |
<t>The front-end can retrieve the current list of send |
7673 |
effect chains of an audio output device by sending the |
effect chains of an audio output device by sending the |
7674 |
following command:</t> |
following command:</t> |
7702 |
</t> |
</t> |
7703 |
</section> |
</section> |
7704 |
|
|
7705 |
<section title="Add send effect chain" anchor="ADD SEND_EFFECT_CHAIN"> |
<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 |
<t>The front-end can add a send effect chain by sending the |
7707 |
following command:</t> |
following command:</t> |
7708 |
<t> |
<t> |
7744 |
</t> |
</t> |
7745 |
</section> |
</section> |
7746 |
|
|
7747 |
<section title="Remove send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN"> |
<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 |
<t>The front-end can remove a send effect chain by sending |
7749 |
the following command:</t> |
the following command:</t> |
7750 |
<t> |
<t> |
7789 |
</t> |
</t> |
7790 |
</section> |
</section> |
7791 |
|
|
7792 |
<section title="Retrieving information about a send effect chain" anchor="GET SEND_EFFECT_CHAIN INFO"> |
<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 informations of a send effect |
<t>The front-end can ask for information of a send effect |
7794 |
chain by sending the following command:</t> |
chain by sending the following command:</t> |
7795 |
<t> |
<t> |
7796 |
<list> |
<list> |
7851 |
</t> |
</t> |
7852 |
</section> |
</section> |
7853 |
|
|
7854 |
<section title="Append effect instance to a send effect chain" anchor="APPEND SEND_EFFECT_CHAIN EFFECT"> |
<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 |
<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> |
end of a send effect chain by sending the following command:</t> |
7857 |
<t> |
<t> |
7903 |
</t> |
</t> |
7904 |
</section> |
</section> |
7905 |
|
|
7906 |
<section title="Insert effect instance to a send effect chain" anchor="INSERT SEND_EFFECT_CHAIN EFFECT"> |
<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 |
<t>The front-end can add an unused effect instance to a |
7908 |
certain position of a send effect chain by sending the |
certain position of a send effect chain by sending the |
7909 |
following command:</t> |
following command:</t> |
7958 |
</t> |
</t> |
7959 |
</section> |
</section> |
7960 |
|
|
7961 |
<section title="Remove effect instance from send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN EFFECT"> |
<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 |
<t>The front-end can remove an effect instance from a |
7963 |
certain position of a send effect chain by sending the |
certain position of a send effect chain by sending the |
7964 |
following command:</t> |
following command:</t> |
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 = |
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 |
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 |
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 |
<t>/ VOICES SP number |
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 |
<t>/ AVAILABLE_EFFECTS |
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="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI"> |
<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 |
<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> |
back-end side, by issuing the following command:</t> |
9177 |
<t> |
<t> |
9196 |
thread unaffected by this feature.</t> |
thread unaffected by this feature.</t> |
9197 |
</section> |
</section> |
9198 |
|
|
9199 |
<section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI"> |
<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> |
<t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t> |
9201 |
<t> |
<t> |
9202 |
<list> |
<list> |
9221 |
thread unaffected by this feature.</t> |
thread unaffected by this feature.</t> |
9222 |
</section> |
</section> |
9223 |
|
|
9224 |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
<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="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_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 |
<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> |
back-end changes by issuing the following command:</t> |
9364 |
<t> |
<t> |
9376 |
all currently active disk streams.</t> |
all currently active disk streams.</t> |
9377 |
</section> |
</section> |
9378 |
|
|
9379 |
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT" 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> |
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="Number of effect instances changed" anchor="SUBSCRIBE EFFECT_INSTANCE_COUNT"> |
<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 |
<t>Client may want to be notified when the number of effect instances |
9620 |
is changed by issuing the following command:</t> |
is changed by issuing the following command:</t> |
9621 |
<t> |
<t> |
9633 |
of effect instances.</t> |
of effect instances.</t> |
9634 |
</section> |
</section> |
9635 |
|
|
9636 |
<section title="Effect instance information changed" anchor="SUBSCRIBE EFFECT_INSTANCE_INFO"> |
<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 |
<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> |
on the back-end by issuing the following command:</t> |
9639 |
<t> |
<t> |
9651 |
of the effect instance.</t> |
of the effect instance.</t> |
9652 |
</section> |
</section> |
9653 |
|
|
9654 |
<section title="Number of send effect chains changed" anchor="SUBSCRIBE SEND_EFFECT_CHAIN_COUNT"> |
<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 |
<t>Client may want to be notified when the number of send effect chains |
9656 |
is changed by issuing the following command:</t> |
is changed by issuing the following command:</t> |
9657 |
<t> |
<t> |
9670 |
<chains> will be replaced by the new number of send effect chains.</t> |
<chains> will be replaced by the new number of send effect chains.</t> |
9671 |
</section> |
</section> |
9672 |
|
|
9673 |
<section title="Send effect chain information changed" anchor="SUBSCRIBE SEND_EFFECT_CHAIN_INFO"> |
<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 |
<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> |
on the back-end by issuing the following command:</t> |
9676 |
<t> |
<t> |
9692 |
</t> |
</t> |
9693 |
</section> |
</section> |
9694 |
|
|
9695 |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
<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> |