| 11 |
<?rfc symrefs="yes" ?> |
<?rfc symrefs="yes" ?> |
| 12 |
<?rfc sortrefs="yes"?> |
<?rfc sortrefs="yes"?> |
| 13 |
<?rfc iprnotified="no" ?> |
<?rfc iprnotified="no" ?> |
|
<?rfc strict="yes" ?> |
|
| 14 |
|
|
| 15 |
<rfc category="std" ipr="full2026" docName="lscp.txt"> |
<!-- FIXME: next attribute should actually be "yes", temporarily disbled due |
| 16 |
|
to an annoying "missing Normative/Informative References" error message --> |
| 17 |
|
<?rfc strict="no" ?> |
| 18 |
|
|
| 19 |
|
<rfc category="std" ipr="full3978" docName="LSCP 1.2"> |
| 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. |
| 34 |
<email>schoenebeck at software minus engineering dot org</email> |
<email>schoenebeck at software minus engineering dot org</email> |
| 35 |
</address> |
</address> |
| 36 |
</author> |
</author> |
| 37 |
<date month="Jan" year="2005"/> |
<date month="March" year="2007"/> |
| 38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
| 39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
| 40 |
<abstract> |
<abstract> |
| 41 |
<t>The LinuxSampler Control Protocol (LSCP) is an |
<t>The LinuxSampler Control Protocol (LSCP) is an |
| 42 |
application-level protocol primarily intended for local and |
application-level protocol primarily intended for local and |
| 43 |
remote controlling the LinuxSampler main application, which is a |
remote controlling the LinuxSampler backend application, which is a |
| 44 |
sophisticated console application essentially playing back audio |
sophisticated server-like console application essentially playing |
| 45 |
samples and manipulating the samples in real time to certain |
back audio samples and manipulating the samples in real time to |
| 46 |
extent.</t> |
certain extent.</t> |
| 47 |
</abstract> |
</abstract> |
| 48 |
</front> |
</front> |
| 49 |
|
|
| 115 |
return and line feed characters respectively.</t> |
return and line feed characters respectively.</t> |
| 116 |
</section> |
</section> |
| 117 |
|
|
| 118 |
|
<section title="Versioning of this specification" anchor="LSCP versioning"> |
| 119 |
|
<t>LSCP will certainly be extended and enhanced by-and-by. Each official |
| 120 |
|
release of the LSCP specification will be tagged with a unique version |
| 121 |
|
tuple. The version tuple consists at least of a major and minor version |
| 122 |
|
number like: |
| 123 |
|
</t> |
| 124 |
|
<t> |
| 125 |
|
<list> |
| 126 |
|
<t>"1.2"</t> |
| 127 |
|
</list> |
| 128 |
|
</t> |
| 129 |
|
<t> |
| 130 |
|
In this example the major version number would be "1" and the minor |
| 131 |
|
version number would be "2". Note that the version tuple might also |
| 132 |
|
have more than two elements. The major version number defines a |
| 133 |
|
group of backward compatible versions. That means a frontend is |
| 134 |
|
compatible to the connected sampler if and only if the LSCP versions |
| 135 |
|
to which each of the two parties complies to, match both of the |
| 136 |
|
following rules: |
| 137 |
|
</t> |
| 138 |
|
<t>Compatibility:</t> |
| 139 |
|
<t> |
| 140 |
|
<list style="numbers"> |
| 141 |
|
<t>The frontend's LSCP major version and the sampler's LSCP |
| 142 |
|
major version are exactly equal.</t> |
| 143 |
|
<t>The frontend's LSCP minor version is less or equal than |
| 144 |
|
the sampler's LSCP minor version.</t> |
| 145 |
|
</list> |
| 146 |
|
</t> |
| 147 |
|
<t> |
| 148 |
|
Compatibility can only be claimed if both rules are true. |
| 149 |
|
The frontend can use the |
| 150 |
|
<xref target="GET SERVER INFO">"GET SERVER INFO"</xref> command to |
| 151 |
|
get the version of the LSCP specification the sampler complies with. |
| 152 |
|
</t> |
| 153 |
|
</section> |
| 154 |
|
|
| 155 |
<section title="Introduction"> |
<section title="Introduction"> |
| 156 |
<t>LinuxSampler is a so called software sampler application |
<t>LinuxSampler is a so called software sampler application |
| 157 |
capable to playback audio samples from a computer's Random |
capable to playback audio samples from a computer's Random |
| 164 |
arbitrary MIDI input method and arbitrary MIDI channel (e.g. |
arbitrary MIDI input method and arbitrary MIDI channel (e.g. |
| 165 |
sampler channel 17 could be connected to an ALSA sequencer |
sampler channel 17 could be connected to an ALSA sequencer |
| 166 |
device 64:0 and listening to MIDI channel 1 there). Each sampler |
device 64:0 and listening to MIDI channel 1 there). Each sampler |
| 167 |
engine will be assigned an own instance of one of the available |
channel will be associated with an instance of one of the available |
| 168 |
sampler engines (e.g. GigEngine, DLSEngine). The audio output of |
sampler engines (e.g. GigEngine, DLSEngine). The audio output of |
| 169 |
each sampler channel can be routed to an arbitrary audio output |
each sampler channel can be routed to an arbitrary audio output |
| 170 |
method (ALSA / JACK) and an arbitrary audio output channel |
method (ALSA / JACK) and an arbitrary audio output channel |
| 194 |
methods will be described next.</t> |
methods will be described next.</t> |
| 195 |
|
|
| 196 |
<section title="Request/response communication method"> |
<section title="Request/response communication method"> |
| 197 |
<t>This simple communication method is based on TCP. The |
<t>This simple communication method is based on |
| 198 |
|
<xref target="RFC793">TCP</xref>. The |
| 199 |
front-end application establishes a TCP connection to the |
front-end application establishes a TCP connection to the |
| 200 |
LinuxSampler instance on a certain host system. Then the |
LinuxSampler instance on a certain host system. Then the |
| 201 |
front-end application will send certain ASCII based commands |
front-end application will send certain ASCII based commands |
| 275 |
<t>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"</t> |
<t>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"</t> |
| 276 |
<t>S: "ERR:9:There is no audio output device with index 123456."</t> |
<t>S: "ERR:9:There is no audio output device with index 123456."</t> |
| 277 |
</list> |
</list> |
| 278 |
</t> |
</t> |
| 279 |
<t>Normal result sets could be:</t> |
<t>Normal result sets could be:</t> |
| 280 |
<t> |
<t> |
| 281 |
<list style="numbers"> |
<list style="numbers"> |
| 420 |
|
|
| 421 |
<t>where <event-id> will be replace by the respective |
<t>where <event-id> will be replace by the respective |
| 422 |
event that client is no longer interested in receiving. For |
event that client is no longer interested in receiving. For |
| 423 |
a list of supported events see chapter 6.</t> |
a list of supported events see <xref target="events" />.</t> |
| 424 |
|
|
| 425 |
<t>Example: the fill states of disk stream buffers have |
<t>Example: the fill states of disk stream buffers have |
| 426 |
changed on sampler channel 4 and the LinuxSampler instance |
changed on sampler channel 4 and the LinuxSampler instance |
| 466 |
</section> |
</section> |
| 467 |
</section> |
</section> |
| 468 |
|
|
| 469 |
<section title="Description for control commands"> |
<section title="Description for control commands" anchor="control_commands"> |
| 470 |
<t>This chapter will describe the available control commands |
<t>This chapter will describe the available control commands |
| 471 |
that can be sent on the TCP connection in detail. Some certain |
that can be sent on the TCP connection in detail. Some certain |
| 472 |
commands (e.g. "GET CHANNEL INFO" or "GET ENGINE INFO") lead to |
commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref> |
| 473 |
|
or <xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref>) lead to |
| 474 |
multiple-line responses. In this case LinuxSampler signals the |
multiple-line responses. In this case LinuxSampler signals the |
| 475 |
end of the response by a "." (single dot) line.</t> |
end of the response by a "." (single dot) line.</t> |
| 476 |
|
|
| 514 |
what parameters drivers are offering, how to retrieve their |
what parameters drivers are offering, how to retrieve their |
| 515 |
possible values, etc.</t> |
possible values, etc.</t> |
| 516 |
|
|
| 517 |
<section title="Getting all available audio output drivers"> |
<section title="Getting amount of available audio output drivers" anchor="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"> |
| 518 |
|
<t>Use the following command to get the number of |
| 519 |
|
audio output drivers currently available for the |
| 520 |
|
LinuxSampler instance:</t> |
| 521 |
|
<t> |
| 522 |
|
<list> |
| 523 |
|
<t>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS</t> |
| 524 |
|
</list> |
| 525 |
|
</t> |
| 526 |
|
<t>Possible Answers:</t> |
| 527 |
|
<t> |
| 528 |
|
<list> |
| 529 |
|
<t>LinuxSampler will answer by sending the |
| 530 |
|
number of audio output drivers.</t> |
| 531 |
|
</list> |
| 532 |
|
</t> |
| 533 |
|
<t>Example:</t> |
| 534 |
|
<t> |
| 535 |
|
<list> |
| 536 |
|
<t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t> |
| 537 |
|
<t>S: "2"</t> |
| 538 |
|
</list> |
| 539 |
|
</t> |
| 540 |
|
</section> |
| 541 |
|
|
| 542 |
|
<section title="Getting all available audio output drivers" anchor="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"> |
| 543 |
<t>Use the following command to list all audio output |
<t>Use the following command to list all audio output |
| 544 |
drivers currently available for the LinuxSampler |
drivers currently available for the LinuxSampler |
| 545 |
instance:</t> |
instance:</t> |
| 546 |
<t> |
<t> |
| 547 |
<list> |
<list> |
| 548 |
<t>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS</t> |
<t>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS</t> |
| 549 |
</list> |
</list> |
| 550 |
</t> |
</t> |
| 551 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 559 |
<t>Example:</t> |
<t>Example:</t> |
| 560 |
<t> |
<t> |
| 561 |
<list> |
<list> |
| 562 |
<t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t> |
<t>C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t> |
| 563 |
<t>S: "ALSA,JACK"</t> |
<t>S: "ALSA,JACK"</t> |
| 564 |
</list> |
</list> |
| 565 |
</t> |
</t> |
| 566 |
</section> |
</section> |
| 567 |
|
|
| 568 |
<section title="Getting information about a specific audio |
<section title="Getting information about a specific audio |
| 569 |
output driver"> |
output driver" anchor="GET AUDIO_OUTPUT_DRIVER INFO"> |
| 570 |
<t>Use the following command to get detailed information |
<t>Use the following command to get detailed information |
| 571 |
about a specific audio output driver:</t> |
about a specific audio output driver:</t> |
| 572 |
<t> |
<t> |
| 576 |
</list> |
</list> |
| 577 |
</t> |
</t> |
| 578 |
<t>Where <audio-output-driver> is the name of the |
<t>Where <audio-output-driver> is the name of the |
| 579 |
audio output driver, returned by the "GET |
audio output driver, returned by the |
| 580 |
AVAILABLE_AUDIO_OUTPUT_DRIVERS" command.</t> |
<xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command.</t> |
| 581 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 582 |
<t> |
<t> |
| 583 |
<list> |
<list> |
| 639 |
</section> |
</section> |
| 640 |
|
|
| 641 |
<section title="Getting information about specific audio |
<section title="Getting information about specific audio |
| 642 |
output driver parameter"> |
output driver parameter" anchor="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"> |
| 643 |
<t>Use the following command to get detailed information |
<t>Use the following command to get detailed information |
| 644 |
about a specific audio output driver parameter:</t> |
about a specific audio output driver parameter:</t> |
| 645 |
<t> |
<t> |
| 648 |
</list> |
</list> |
| 649 |
</t> |
</t> |
| 650 |
<t>Where <audio> is the name of the audio output |
<t>Where <audio> is the name of the audio output |
| 651 |
driver as returned by the "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS" command, |
driver as returned by the <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"> |
| 652 |
|
"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command, |
| 653 |
<prm> a specific parameter name for which information should be |
<prm> a specific parameter name for which information should be |
| 654 |
obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO" command) and |
obtained (as returned by the |
| 655 |
|
<xref target="GET AUDIO_OUTPUT_DRIVER INFO">"GET AUDIO_OUTPUT_DRIVER INFO"</xref> command) and |
| 656 |
<deplist> is an optional list of parameters on which the sought |
<deplist> is an optional list of parameters on which the sought |
| 657 |
parameter <prm> depends on, <deplist> is a list of key-value |
parameter <prm> depends on, <deplist> is a list of key-value |
| 658 |
pairs in form of "key1=val1 key2=val2 ...", where character string values |
pairs in form of "key1=val1 key2=val2 ...", where character string values |
| 699 |
<list> |
<list> |
| 700 |
<t>either true or false, defines if this parameter must be |
<t>either true or false, defines if this parameter must be |
| 701 |
given when the device is to be created with the |
given when the device is to be created with the |
| 702 |
'CREATE AUDIO_OUTPUT_DEVICE' command |
<xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref> |
| 703 |
(always returned, no matter which driver parameter)</t> |
command (always returned, no matter which driver parameter)</t> |
| 704 |
</list> |
</list> |
| 705 |
</t> |
</t> |
| 706 |
|
|
| 708 |
<list> |
<list> |
| 709 |
<t>either true or false, if false then this parameter can |
<t>either true or false, if false then this parameter can |
| 710 |
be changed at any time, once the device is created by |
be changed at any time, once the device is created by |
| 711 |
the 'CREATE AUDIO_OUTPUT_DEVICE' command |
the <xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref> |
| 712 |
(always returned, no matter which driver parameter)</t> |
command (always returned, no matter which driver parameter)</t> |
| 713 |
</list> |
</list> |
| 714 |
</t> |
</t> |
| 715 |
|
|
| 724 |
|
|
| 725 |
<t>DEPENDS - |
<t>DEPENDS - |
| 726 |
<list> |
<list> |
| 727 |
<t>comma separated list of paramters this parameter depends |
<t>comma separated list of parameters this parameter depends |
| 728 |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
| 729 |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
| 730 |
listed parameters, for example assuming that an audio |
listed parameters, for example assuming that an audio |
| 741 |
<list> |
<list> |
| 742 |
<t>reflects the default value for this parameter which is |
<t>reflects the default value for this parameter which is |
| 743 |
used when the device is created and not explicitly |
used when the device is created and not explicitly |
| 744 |
given with the 'CREATE AUDIO_OUTPUT_DEVICE' command, |
given with the <xref target="CREATE AUDIO_OUTPUT_DEVICE"> |
| 745 |
|
'CREATE AUDIO_OUTPUT_DEVICE'</xref> command, |
| 746 |
in case of MULTIPLCITY=true, this is a comma separated |
in case of MULTIPLCITY=true, this is a comma separated |
| 747 |
list, that's why character strings are encapsulated into |
list, that's why character strings are encapsulated into |
| 748 |
apostrophes (') |
apostrophes (') |
| 827 |
</t> |
</t> |
| 828 |
</section> |
</section> |
| 829 |
|
|
| 830 |
<section title="Creating an audio output device"> |
<section title="Creating an audio output device" anchor="CREATE AUDIO_OUTPUT_DEVICE"> |
| 831 |
<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> |
| 832 |
|
|
| 833 |
<t> |
<t> |
| 837 |
</t> |
</t> |
| 838 |
|
|
| 839 |
<t>Where <audio-output-driver> should be replaced by the desired audio |
<t>Where <audio-output-driver> should be replaced by the desired audio |
| 840 |
output system and <param-list> by an optional list of driver |
output system as returned by the |
| 841 |
|
<xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> |
| 842 |
|
command and <param-list> by an optional list of driver |
| 843 |
specific parameters in form of "key1=val1 key2=val2 ...", where |
specific parameters in form of "key1=val1 key2=val2 ...", where |
| 844 |
character string values should be encapsulated into apostrophes ('). |
character string values should be encapsulated into apostrophes ('). |
| 845 |
Note that there might be drivers which require parameter(s) to be |
Note that there might be drivers which require parameter(s) to be |
| 887 |
</t> |
</t> |
| 888 |
</section> |
</section> |
| 889 |
|
|
| 890 |
<section title="Destroying an audio output device"> |
<section title="Destroying an audio output device" anchor="DESTROY AUDIO_OUTPUT_DEVICE"> |
| 891 |
<t>Use the following command to destroy a created output device:</t> |
<t>Use the following command to destroy a created output device:</t> |
| 892 |
<t> |
<t> |
| 893 |
<list> |
<list> |
| 895 |
</list> |
</list> |
| 896 |
</t> |
</t> |
| 897 |
<t>Where <device-id> should be replaced by the numerical ID of the |
<t>Where <device-id> should be replaced by the numerical ID of the |
| 898 |
audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE" or |
audio output device as given by the |
| 899 |
"GET AUDIO_OUTPUT_DEVICES" command.</t> |
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
| 900 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
| 901 |
|
command.</t> |
| 902 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 903 |
<t> |
<t> |
| 904 |
<list> |
<list> |
| 933 |
</t> |
</t> |
| 934 |
</section> |
</section> |
| 935 |
|
|
| 936 |
<section title="Getting all created audio output device count"> |
<section title="Getting all created audio output device count" anchor="GET AUDIO_OUTPUT_DEVICES"> |
| 937 |
<t>Use the following command to count all created audio output devices:</t> |
<t>Use the following command to count all created audio output devices:</t> |
| 938 |
<t> |
<t> |
| 939 |
<list> |
<list> |
| 956 |
</t> |
</t> |
| 957 |
</section> |
</section> |
| 958 |
|
|
| 959 |
<section title="Getting all created audio output device list"> |
<section title="Getting all created audio output device list" anchor="LIST AUDIO_OUTPUT_DEVICES"> |
| 960 |
<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> |
| 961 |
<t> |
<t> |
| 962 |
<list> |
<list> |
| 979 |
</t> |
</t> |
| 980 |
</section> |
</section> |
| 981 |
|
|
| 982 |
<section title="Getting current settings of an audio output device"> |
<section title="Getting current settings of an audio output device" anchor="GET AUDIO_OUTPUT_DEVICE INFO"> |
| 983 |
<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> |
| 984 |
<t> |
<t> |
| 985 |
<list> |
<list> |
| 988 |
</t> |
</t> |
| 989 |
<t>Where <device-id> should be replaced by numerical ID |
<t>Where <device-id> should be replaced by numerical ID |
| 990 |
of the audio output device as e.g. returned by the |
of the audio output device as e.g. returned by the |
| 991 |
"LIST AUDIO_OUTPUT_DEVICES" command.</t> |
<xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> command.</t> |
| 992 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 993 |
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
| 994 |
Each answer line begins with the information category name |
Each answer line begins with the information category name |
| 1002 |
<t>DRIVER - |
<t>DRIVER - |
| 1003 |
<list> |
<list> |
| 1004 |
<t>identifier of the used audio output driver, as also |
<t>identifier of the used audio output driver, as also |
| 1005 |
returned by the "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS" |
returned by the |
| 1006 |
|
<xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"> |
| 1007 |
|
"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> |
| 1008 |
command</t> |
command</t> |
| 1009 |
</list> |
</list> |
| 1010 |
</t> |
</t> |
| 1033 |
order. The fields above are only those fields which are |
order. The fields above are only those fields which are |
| 1034 |
returned by all audio output devices. Every audio output driver |
returned by all audio output devices. Every audio output driver |
| 1035 |
might have its own, additional driver specific parameters (see |
might have its own, additional driver specific parameters (see |
| 1036 |
"GET AUDIO_OUTPUT_DRIVER INFO" command) which are also returned |
<xref target="GET AUDIO_OUTPUT_DRIVER INFO" />) |
| 1037 |
by this command.</t> |
which are also returned by this command.</t> |
| 1038 |
<t>Example:</t> |
<t>Example:</t> |
| 1039 |
<t> |
<t> |
| 1040 |
<list> |
<list> |
| 1052 |
</section> |
</section> |
| 1053 |
|
|
| 1054 |
|
|
| 1055 |
<section title="Changing settings of audio output devices"> |
<section title="Changing settings of audio output devices" anchor="SET AUDIO_OUTPUT_DEVICE_PARAMETER"> |
| 1056 |
<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> |
| 1057 |
<t> |
<t> |
| 1058 |
<list> |
<list> |
| 1060 |
</list> |
</list> |
| 1061 |
</t> |
</t> |
| 1062 |
<t>Where <device-id> should be replaced by the numerical ID of the |
<t>Where <device-id> should be replaced by the numerical ID of the |
| 1063 |
audio output device, <key> by the name of the parameter to change |
audio output device as given by the |
| 1064 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
| 1065 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
| 1066 |
|
command, <key> by the name of the parameter to change |
| 1067 |
and <value> by the new value for this parameter.</t> |
and <value> by the new value for this parameter.</t> |
| 1068 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 1069 |
<t> |
<t> |
| 1097 |
</t> |
</t> |
| 1098 |
</section> |
</section> |
| 1099 |
|
|
| 1100 |
<section title="Getting information about an audio channel"> |
<section title="Getting information about an audio channel" anchor="GET AUDIO_OUTPUT_CHANNEL INFO"> |
| 1101 |
<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> |
| 1102 |
<t> |
<t> |
| 1103 |
<list> |
<list> |
| 1104 |
<t>GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan></t> |
<t>GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan></t> |
| 1105 |
</list> |
</list> |
| 1106 |
</t> |
</t> |
| 1107 |
<t>Where <device-id> is the numerical ID of the audio output device |
<t>Where <device-id> is the numerical ID of the audio output device as given by the |
| 1108 |
and <audio-chan> the audio channel number.</t> |
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
| 1109 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
| 1110 |
|
command and <audio-chan> the audio channel number.</t> |
| 1111 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 1112 |
<t> |
<t> |
| 1113 |
<list> |
<list> |
| 1197 |
</t> |
</t> |
| 1198 |
</section> |
</section> |
| 1199 |
|
|
| 1200 |
<section title="Getting information about specific audio channel parameter"> |
<section title="Getting information about specific audio channel parameter" anchor="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"> |
| 1201 |
<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> |
| 1202 |
|
|
| 1203 |
<t> |
<t> |
| 1206 |
</list> |
</list> |
| 1207 |
</t> |
</t> |
| 1208 |
|
|
| 1209 |
<t>Where <dev-id> is the numerical ID of the audio output device as returned |
<t>Where <dev-id> is the numerical ID of the audio output device as returned by the |
| 1210 |
by the "GET AUDIO_OUTPUT_DEVICES" command, <chan> the audio channel number |
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
| 1211 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
| 1212 |
|
command, <chan> the audio channel number |
| 1213 |
and <param> a specific channel parameter name for which information should |
and <param> a specific channel parameter name for which information should |
| 1214 |
be obtained (as returned by the "GET AUDIO_OUTPUT_CHANNEL INFO" command).</t> |
be obtained (as returned by the <xref target="GET AUDIO_OUTPUT_CHANNEL INFO"> |
| 1215 |
|
"GET AUDIO_OUTPUT_CHANNEL INFO"</xref> command).</t> |
| 1216 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 1217 |
|
|
| 1218 |
<t> |
<t> |
| 1303 |
</t> |
</t> |
| 1304 |
</section> |
</section> |
| 1305 |
|
|
| 1306 |
<section title="Changing settings of audio output channels"> |
<section title="Changing settings of audio output channels" anchor="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"> |
| 1307 |
<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> |
| 1308 |
<t> |
<t> |
| 1309 |
<list> |
<list> |
| 1310 |
<t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value></t> |
<t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value></t> |
| 1311 |
</list> |
</list> |
| 1312 |
</t> |
</t> |
| 1313 |
<t>Where <dev-id> should be replaced by the numerical ID of the audio |
<t>Where <dev-id> should be replaced by the numerical ID of the audio output device as returned by the |
| 1314 |
device, <chn> by the audio channel number, <key> by the name of the |
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
| 1315 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
| 1316 |
|
command, <chn> by the audio channel number, <key> by the name of the |
| 1317 |
parameter to change and <value> by the new value for this parameter.</t> |
parameter to change and <value> by the new value for this parameter.</t> |
| 1318 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 1319 |
<t> |
<t> |
| 1381 |
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 |
| 1382 |
possible values, etc.</t> |
possible values, etc.</t> |
| 1383 |
|
|
| 1384 |
<section title="Getting all available MIDI input drivers"> |
<section title="Getting amount of available MIDI input drivers" anchor="GET AVAILABLE_MIDI_INPUT_DRIVERS"> |
| 1385 |
|
<t>Use the following command to get the number of |
| 1386 |
|
MIDI input drivers currently available for the |
| 1387 |
|
LinuxSampler instance:</t> |
| 1388 |
|
<t> |
| 1389 |
|
<list> |
| 1390 |
|
<t>GET AVAILABLE_MIDI_INPUT_DRIVERS</t> |
| 1391 |
|
</list> |
| 1392 |
|
</t> |
| 1393 |
|
<t>Possible Answers:</t> |
| 1394 |
|
<t> |
| 1395 |
|
<list> |
| 1396 |
|
<t>LinuxSampler will answer by sending the |
| 1397 |
|
number of available MIDI input drivers.</t> |
| 1398 |
|
</list> |
| 1399 |
|
</t> |
| 1400 |
|
<t>Example:</t> |
| 1401 |
|
<t> |
| 1402 |
|
<list> |
| 1403 |
|
<t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t> |
| 1404 |
|
<t>S: "2"</t> |
| 1405 |
|
</list> |
| 1406 |
|
</t> |
| 1407 |
|
</section> |
| 1408 |
|
|
| 1409 |
|
<section title="Getting all available MIDI input drivers" anchor="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
| 1410 |
<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 |
| 1411 |
for the LinuxSampler instance:</t> |
for the LinuxSampler instance:</t> |
| 1412 |
<t> |
<t> |
| 1413 |
<list> |
<list> |
| 1414 |
<t>GET AVAILABLE_MIDI_INPUT_DRIVERS</t> |
<t>LIST AVAILABLE_MIDI_INPUT_DRIVERS</t> |
| 1415 |
</list> |
</list> |
| 1416 |
</t> |
</t> |
| 1417 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 1424 |
<t>Example:</t> |
<t>Example:</t> |
| 1425 |
<t> |
<t> |
| 1426 |
<list> |
<list> |
| 1427 |
<t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t> |
<t>C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</t> |
| 1428 |
<t>S: "ALSA,JACK"</t> |
<t>S: "ALSA,JACK"</t> |
| 1429 |
</list> |
</list> |
| 1430 |
</t> |
</t> |
| 1431 |
</section> |
</section> |
| 1432 |
|
|
| 1433 |
<section title="Getting information about a specific MIDI input driver"> |
<section title="Getting information about a specific MIDI input driver" anchor="GET MIDI_INPUT_DRIVER INFO"> |
| 1434 |
<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> |
| 1435 |
<t> |
<t> |
| 1436 |
<list> |
<list> |
| 1437 |
<t>GET MIDI_INPUT_DRIVER INFO <midi-input-driver></t> |
<t>GET MIDI_INPUT_DRIVER INFO <midi-input-driver></t> |
| 1438 |
</list> |
</list> |
| 1439 |
</t> |
</t> |
| 1440 |
<t>Where <midi-input-driver> is the name of the MIDI input driver.</t> |
<t>Where <midi-input-driver> is the name of the MIDI input driver as returned |
| 1441 |
|
by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
| 1442 |
|
"LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command.</t> |
| 1443 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 1444 |
<t> |
<t> |
| 1445 |
<list> |
<list> |
| 1486 |
</t> |
</t> |
| 1487 |
</section> |
</section> |
| 1488 |
|
|
| 1489 |
<section title="Getting information about specific MIDI input driver parameter"> |
<section title="Getting information about specific MIDI input driver parameter" anchor="GET MIDI_INPUT_DRIVER_PARAMETER INFO"> |
| 1490 |
<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> |
| 1491 |
<t> |
<t> |
| 1492 |
<list> |
<list> |
| 1494 |
</list> |
</list> |
| 1495 |
</t> |
</t> |
| 1496 |
|
|
| 1497 |
<t>Where <midi-t> is the name of the MIDI input driver as returned |
<t>Where <midit> is the name of the MIDI input driver as returned |
| 1498 |
by the "GET AVAILABLE_MIDI_INPUT_DRIVERS" command, <param> a specific |
by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
| 1499 |
|
"LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command, <param> a specific |
| 1500 |
parameter name for which information should be obtained (as returned by the |
parameter name for which information should be obtained (as returned by the |
| 1501 |
"GET MIDI_INPUT_DRIVER INFO" command) and <deplist> is an optional list |
<xref target="GET MIDI_INPUT_DRIVER INFO"> |
| 1502 |
|
"GET MIDI_INPUT_DRIVER INFO"</xref> command) and <deplist> is an optional list |
| 1503 |
of parameters on which the sought parameter <param> depends on, |
of parameters on which the sought parameter <param> depends on, |
| 1504 |
<deplist> is a key-value pair list in form of "key1=val1 key2=val2 ...", |
<deplist> is a key-value pair list in form of "key1=val1 key2=val2 ...", |
| 1505 |
where character string values are encapsulated into apostrophes ('). Arguments |
where character string values are encapsulated into apostrophes ('). Arguments |
| 1540 |
<list> |
<list> |
| 1541 |
<t>either true or false, defines if this parameter must be |
<t>either true or false, defines if this parameter must be |
| 1542 |
given when the device is to be created with the |
given when the device is to be created with the |
| 1543 |
'CREATE MIDI_INPUT_DEVICE' command |
<xref target="CREATE MIDI_INPUT_DEVICE"> |
| 1544 |
|
'CREATE MIDI_INPUT_DEVICE'</xref> command |
| 1545 |
(always returned, no matter which driver parameter)</t> |
(always returned, no matter which driver parameter)</t> |
| 1546 |
</list> |
</list> |
| 1547 |
</t> |
</t> |
| 1550 |
<list> |
<list> |
| 1551 |
<t>either true or false, if false then this parameter can |
<t>either true or false, if false then this parameter can |
| 1552 |
be changed at any time, once the device is created by |
be changed at any time, once the device is created by |
| 1553 |
the 'CREATE MIDI_INPUT_DEVICE' command |
the <xref target="CREATE MIDI_INPUT_DEVICE"> |
| 1554 |
|
'CREATE MIDI_INPUT_DEVICE'</xref> command |
| 1555 |
(always returned, no matter which driver parameter)</t> |
(always returned, no matter which driver parameter)</t> |
| 1556 |
</list> |
</list> |
| 1557 |
</t> |
</t> |
| 1567 |
|
|
| 1568 |
<t>DEPENDS - |
<t>DEPENDS - |
| 1569 |
<list> |
<list> |
| 1570 |
<t>comma separated list of paramters this parameter depends |
<t>comma separated list of parameters this parameter depends |
| 1571 |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
| 1572 |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
| 1573 |
listed parameters, for example assuming that an audio |
listed parameters, for example assuming that an audio |
| 1584 |
<list> |
<list> |
| 1585 |
<t>reflects the default value for this parameter which is |
<t>reflects the default value for this parameter which is |
| 1586 |
used when the device is created and not explicitly |
used when the device is created and not explicitly |
| 1587 |
given with the 'CREATE MIDI_INPUT_DEVICE' command, |
given with the <xref target="CREATE MIDI_INPUT_DEVICE"> |
| 1588 |
|
'CREATE MIDI_INPUT_DEVICE'</xref> command, |
| 1589 |
in case of MULTIPLCITY=true, this is a comma separated |
in case of MULTIPLCITY=true, this is a comma separated |
| 1590 |
list, that's why character strings are encapsulated into |
list, that's why character strings are encapsulated into |
| 1591 |
apostrophes (') |
apostrophes (') |
| 1641 |
</t> |
</t> |
| 1642 |
</section> |
</section> |
| 1643 |
|
|
| 1644 |
<section title="Creating a MIDI input device"> |
<section title="Creating a MIDI input device" anchor="CREATE MIDI_INPUT_DEVICE"> |
| 1645 |
<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> |
| 1646 |
<t> |
<t> |
| 1647 |
<list> |
<list> |
| 1649 |
</list> |
</list> |
| 1650 |
</t> |
</t> |
| 1651 |
|
|
| 1652 |
<t>Where <midi-input-driver> should be replaced by the desired MIDI input system and <param-list> by an |
<t>Where <midi-input-driver> should be replaced by the desired MIDI input system as returned |
| 1653 |
|
by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
| 1654 |
|
"LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command and <param-list> by an |
| 1655 |
optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where |
optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where |
| 1656 |
character string values should be encapsulated into apostrophes ('). |
character string values should be encapsulated into apostrophes ('). |
| 1657 |
Note that there might be drivers which require parameter(s) to be |
Note that there might be drivers which require parameter(s) to be |
| 1691 |
</t> |
</t> |
| 1692 |
</section> |
</section> |
| 1693 |
|
|
| 1694 |
<section title="Destroying a MIDI input device"> |
<section title="Destroying a MIDI input device" anchor="DESTROY MIDI_INPUT_DEVICE"> |
| 1695 |
<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> |
| 1696 |
<t> |
<t> |
| 1697 |
<list> |
<list> |
| 1698 |
<t>DESTROY MIDI_INPUT_DEVICE <device-id></t> |
<t>DESTROY MIDI_INPUT_DEVICE <device-id></t> |
| 1699 |
</list> |
</list> |
| 1700 |
</t> |
</t> |
| 1701 |
<t>Where <device-id> should be replaced by the device's numerical ID.</t> |
<t>Where <device-id> should be replaced by the device's numerical ID as returned by the |
| 1702 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
| 1703 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
| 1704 |
|
command.</t> |
| 1705 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 1706 |
<t> |
<t> |
| 1707 |
<list> |
<list> |
| 1733 |
</t> |
</t> |
| 1734 |
</section> |
</section> |
| 1735 |
|
|
| 1736 |
<section title="Getting all created MIDI input device count"> |
<section title="Getting all created MIDI input device count" anchor="GET MIDI_INPUT_DEVICES"> |
| 1737 |
<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> |
| 1738 |
<t> |
<t> |
| 1739 |
<list> |
<list> |
| 1757 |
</section> |
</section> |
| 1758 |
|
|
| 1759 |
|
|
| 1760 |
<section title="Getting all created MIDI input device list"> |
<section title="Getting all created MIDI input device list" anchor="LIST MIDI_INPUT_DEVICES"> |
| 1761 |
<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> |
| 1762 |
<t> |
<t> |
| 1763 |
<list> |
<list> |
| 1786 |
</t> |
</t> |
| 1787 |
</section> |
</section> |
| 1788 |
|
|
| 1789 |
<section title="Getting current settings of a MIDI input device"> |
<section title="Getting current settings of a MIDI input device" anchor="GET MIDI_INPUT_DEVICE INFO"> |
| 1790 |
<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> |
| 1791 |
<t> |
<t> |
| 1792 |
<list> |
<list> |
| 1793 |
<t>GET MIDI_INPUT_DEVICE INFO <device-id></t> |
<t>GET MIDI_INPUT_DEVICE INFO <device-id></t> |
| 1794 |
</list> |
</list> |
| 1795 |
</t> |
</t> |
| 1796 |
<t>Where <device-id> is the numerical ID of the MIDI input device.</t> |
<t>Where <device-id> is the numerical ID of the MIDI input device as returned by the |
| 1797 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
| 1798 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
| 1799 |
|
command.</t> |
| 1800 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 1801 |
<t> |
<t> |
| 1802 |
<list> |
<list> |
| 1813 |
<t>DRIVER - |
<t>DRIVER - |
| 1814 |
<list> |
<list> |
| 1815 |
<t>identifier of the used MIDI input driver, as e.g. |
<t>identifier of the used MIDI input driver, as e.g. |
| 1816 |
returned by the "GET AVAILABLE_MIDI_INPUT_DRIVERS" |
returned by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
| 1817 |
|
"LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> |
| 1818 |
command</t> |
command</t> |
| 1819 |
</list> |
</list> |
| 1820 |
</t> |
</t> |
| 1837 |
order. The fields above are only those fields which are |
order. The fields above are only those fields which are |
| 1838 |
returned by all MIDI input devices. Every MIDI input driver |
returned by all MIDI input devices. Every MIDI input driver |
| 1839 |
might have its own, additional driver specific parameters (see |
might have its own, additional driver specific parameters (see |
| 1840 |
"GET MIDI_INPUT_DRIVER INFO" command) which are also returned |
<xref target="GET MIDI_INPUT_DRIVER INFO"> |
| 1841 |
|
"GET MIDI_INPUT_DRIVER INFO"</xref> command) which are also returned |
| 1842 |
by this command.</t> |
by this command.</t> |
| 1843 |
|
|
| 1844 |
<t>Example:</t> |
<t>Example:</t> |
| 1852 |
</t> |
</t> |
| 1853 |
</section> |
</section> |
| 1854 |
|
|
| 1855 |
<section title="Changing settings of MIDI input devices"> |
<section title="Changing settings of MIDI input devices" anchor="SET MIDI_INPUT_DEVICE_PARAMETER"> |
| 1856 |
<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> |
| 1857 |
<t> |
<t> |
| 1858 |
<list> |
<list> |
| 1861 |
</t> |
</t> |
| 1862 |
|
|
| 1863 |
<t>Where <device-id> should be replaced by the numerical ID of the |
<t>Where <device-id> should be replaced by the numerical ID of the |
| 1864 |
MIDI input device, <key> by the name of the parameter to change and |
MIDI input device as returned by the |
| 1865 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
| 1866 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
| 1867 |
|
command, <key> by the name of the parameter to change and |
| 1868 |
<value> by the new value for this parameter.</t> |
<value> by the new value for this parameter.</t> |
| 1869 |
|
|
| 1870 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 1898 |
</t> |
</t> |
| 1899 |
</section> |
</section> |
| 1900 |
|
|
| 1901 |
<section title="Getting information about a MIDI port"> |
<section title="Getting information about a MIDI port" anchor="GET MIDI_INPUT_PORT INFO"> |
| 1902 |
<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> |
| 1903 |
<t> |
<t> |
| 1904 |
<list> |
<list> |
| 1905 |
<t>GET MIDI_INPUT_PORT INFO <device-id> <midi-port></t> |
<t>GET MIDI_INPUT_PORT INFO <device-id> <midi-port></t> |
| 1906 |
</list> |
</list> |
| 1907 |
</t> |
</t> |
| 1908 |
<t>Where <device-id> is the numerical ID of the MIDI input device |
<t>Where <device-id> is the numerical ID of the MIDI input device as returned by the |
| 1909 |
and <midi-port> the MIDI input port number.</t> |
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
| 1910 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
| 1911 |
|
command and <midi-port> the MIDI input port number.</t> |
| 1912 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 1913 |
<t> |
<t> |
| 1914 |
<list> |
<list> |
| 1942 |
</t> |
</t> |
| 1943 |
</section> |
</section> |
| 1944 |
|
|
| 1945 |
<section title="Getting information about specific MIDI port parameter"> |
<section title="Getting information about specific MIDI port parameter" anchor="GET MIDI_INPUT_PORT_PARAMETER INFO"> |
| 1946 |
<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> |
| 1947 |
<t> |
<t> |
| 1948 |
<list> |
<list> |
| 1950 |
</list> |
</list> |
| 1951 |
</t> |
</t> |
| 1952 |
|
|
| 1953 |
<t>Where <dev-id> is the numerical ID of the MIDI input device as returned |
<t>Where <dev-id> is the numerical ID of the MIDI input device as returned by the |
| 1954 |
by the "LIST MIDI_INPUT_DEVICES" command, <port> the MIDI port number and |
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
| 1955 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
| 1956 |
|
command, <port> the MIDI port number and |
| 1957 |
<param> a specific port parameter name for which information should be |
<param> a specific port parameter name for which information should be |
| 1958 |
obtained (as returned by the "GET MIDI_INPUT_PORT INFO" command).</t> |
obtained (as returned by the <xref target="GET MIDI_INPUT_PORT INFO"> |
| 1959 |
|
"GET MIDI_INPUT_PORT INFO"</xref> command).</t> |
| 1960 |
|
|
| 1961 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 1962 |
<t> |
<t> |
| 2047 |
</t> |
</t> |
| 2048 |
</section> |
</section> |
| 2049 |
|
|
| 2050 |
<section title="Changing settings of MIDI input ports"> |
<section title="Changing settings of MIDI input ports" anchor="SET MIDI_INPUT_PORT_PARAMETER"> |
| 2051 |
<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> |
| 2052 |
<t> |
<t> |
| 2053 |
<list> |
<list> |
| 2056 |
</t> |
</t> |
| 2057 |
|
|
| 2058 |
<t>Where <device-id> should be replaced by the numerical ID of the |
<t>Where <device-id> should be replaced by the numerical ID of the |
| 2059 |
MIDI device, <port> by the MIDI port number, <key> by the name of |
MIDI device as returned by the |
| 2060 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
| 2061 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
| 2062 |
|
command, <port> by the MIDI port number, <key> by the name of |
| 2063 |
the parameter to change and <value> by the new value for this |
the parameter to change and <value> by the new value for this |
| 2064 |
parameter.</t> |
parameter.</t> |
| 2065 |
|
|
| 2095 |
</section> |
</section> |
| 2096 |
|
|
| 2097 |
<section title="Configuring sampler channels"> |
<section title="Configuring sampler channels"> |
| 2098 |
<t>The following commands describe how to add and remove sampler channels, deploy |
<t>The following commands describe how to add and remove sampler channels, associate a |
| 2099 |
sampler engines, load instruments and connect sampler channels to MIDI and audio devices.</t> |
sampler channel with a sampler engine, load instruments and connect sampler channels to |
| 2100 |
|
MIDI and audio devices.</t> |
| 2101 |
|
|
| 2102 |
<section title="Loading an instrument"> |
<section title="Loading an instrument" anchor="LOAD INSTRUMENT"> |
| 2103 |
<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> |
| 2104 |
<t> |
<t> |
| 2105 |
<list> |
<list> |
| 2117 |
is that the regular command returns OK only after the instrument has been |
is that the regular command returns OK only after the instrument has been |
| 2118 |
fully loaded and the channel is ready to be used while NON_MODAL version |
fully loaded and the channel is ready to be used while NON_MODAL version |
| 2119 |
returns immediately and a background process is launched to load the instrument |
returns immediately and a background process is launched to load the instrument |
| 2120 |
on the channel. GET CHANNEL INFO command can be used to obtain loading |
on the channel. The <xref target="GET CHANNEL INFO">GET CHANNEL INFO</xref> |
| 2121 |
|
command can be used to obtain loading |
| 2122 |
progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks |
progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks |
| 2123 |
such as making sure that the file could be read and it is of a proper format |
such as making sure that the file could be read and it is of a proper format |
| 2124 |
and SHOULD return ERR and SHOULD not launch the background process should any |
and SHOULD return ERR and SHOULD not launch the background process should any |
| 2156 |
</t> |
</t> |
| 2157 |
</section> |
</section> |
| 2158 |
|
|
| 2159 |
<section title="Loading a sampler engine"> |
<section title="Loading a sampler engine" anchor="LOAD ENGINE"> |
| 2160 |
<t>A sample engine can be deployed and assigned to a specific sampler |
<t>A sampler engine type can be associated to a specific sampler |
| 2161 |
channel by the following command:</t> |
channel by the following command:</t> |
| 2162 |
<t> |
<t> |
| 2163 |
<list> |
<list> |
| 2166 |
</t> |
</t> |
| 2167 |
|
|
| 2168 |
<t>Where <engine-name> is an engine name as obtained by the |
<t>Where <engine-name> is an engine name as obtained by the |
| 2169 |
"GET AVAILABLE_ENGINES" command and <sampler-channel> the sampler channel the |
<xref target="LIST AVAILABLE_ENGINES"> |
| 2170 |
deployed engine should be assigned to. Even if the respective |
"LIST AVAILABLE_ENGINES"</xref> command and <sampler-channel> |
| 2171 |
sampler channel has already a deployed engine with that engine |
the sampler channel as returned by the |
| 2172 |
name, a new engine instance will be assigned to the sampler channel.</t> |
<xref target="ADD CHANNEL">"ADD CHANNEL"</xref> or |
| 2173 |
|
<xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command where |
| 2174 |
|
the engine type should be assigned to. This command should be issued |
| 2175 |
|
after adding a new sampler channel and before any other control |
| 2176 |
|
commands on the new sampler channel. It can also be used to change |
| 2177 |
|
the engine type of a sampler channel. This command has (currently) no |
| 2178 |
|
way to define or force if a new engine instance should be created and |
| 2179 |
|
assigned to the given sampler channel or if an already existing |
| 2180 |
|
instance of that engine type, shared with other sampler channels, |
| 2181 |
|
should be used.</t> |
| 2182 |
|
|
| 2183 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 2184 |
<t> |
<t> |
| 2211 |
</t> |
</t> |
| 2212 |
</section> |
</section> |
| 2213 |
|
|
| 2214 |
<section title="Getting all created sampler channel count"> |
<section title="Getting all created sampler channel count" anchor="GET CHANNELS"> |
| 2215 |
<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 |
| 2216 |
current amount of sampler channels, the front-end can send the |
current amount of sampler channels, the front-end can send the |
| 2217 |
following command:</t> |
following command:</t> |
| 2235 |
</t> |
</t> |
| 2236 |
</section> |
</section> |
| 2237 |
|
|
| 2238 |
<section title="Getting all created sampler channel list"> |
<section title="Getting all created sampler channel list" anchor="LIST CHANNELS"> |
| 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 list of sampler channels, the front-end can send the |
current list of sampler channels, the front-end can send the |
| 2241 |
following command:</t> |
following command:</t> |
| 2260 |
</t> |
</t> |
| 2261 |
</section> |
</section> |
| 2262 |
|
|
| 2263 |
<section title="Adding a new sampler channel"> |
<section title="Adding a new sampler channel" anchor="ADD CHANNEL"> |
| 2264 |
<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 |
| 2265 |
channel list by sending the following command:</t> |
channel list by sending the following command:</t> |
| 2266 |
<t> |
<t> |
| 2284 |
<list> |
<list> |
| 2285 |
<t>in case a new sampler channel could be added, where |
<t>in case a new sampler channel could be added, where |
| 2286 |
<sampler-channel> reflects the channel number of the new |
<sampler-channel> reflects the channel number of the new |
| 2287 |
created sampler channel which should the be used to set up |
created sampler channel which should be used to set up |
| 2288 |
the sampler channel by sending subsequent intialization |
the sampler channel by sending subsequent initialization |
| 2289 |
commands</t> |
commands</t> |
| 2290 |
</list> |
</list> |
| 2291 |
</t> |
</t> |
| 2312 |
</t> |
</t> |
| 2313 |
</section> |
</section> |
| 2314 |
|
|
| 2315 |
<section title="Removing a sampler channel"> |
<section title="Removing a sampler channel" anchor="REMOVE CHANNEL"> |
| 2316 |
<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> |
| 2317 |
<t> |
<t> |
| 2318 |
<list> |
<list> |
| 2320 |
</list> |
</list> |
| 2321 |
</t> |
</t> |
| 2322 |
|
|
| 2323 |
<t>This will decrement the sampler channel count by one and also |
<t>Where <sampler-channel> should be replaced by the |
| 2324 |
decrement the channel numbers of all subsequent sampler channels by |
number of the sampler channel as given by the |
| 2325 |
one.</t> |
<xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 2326 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> |
| 2327 |
|
command. The channel numbers of all subsequent sampler channels |
| 2328 |
|
remain the same.</t> |
| 2329 |
|
|
| 2330 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 2331 |
<t> |
<t> |
| 2358 |
</t> |
</t> |
| 2359 |
</section> |
</section> |
| 2360 |
|
|
| 2361 |
<section title="Getting all available engines"> |
<section title="Getting amount of available engines" anchor="GET AVAILABLE_ENGINES"> |
| 2362 |
<t>The front-end can ask for all 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> |
| 2363 |
<t> |
<t> |
| 2364 |
<list> |
<list> |
| 2365 |
<t>GET AVAILABLE_ENGINES</t> |
<t>GET AVAILABLE_ENGINES</t> |
| 2368 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 2369 |
<t> |
<t> |
| 2370 |
<list> |
<list> |
| 2371 |
<t>LinuxSampler will answer by sending a comma separated character |
<t>LinuxSampler will answer by sending the number of available engines.</t> |
|
string of the engines' names. Engine names can consist of lower and |
|
|
upper cases, digits and underlines ("_" character).</t> |
|
| 2372 |
</list> |
</list> |
| 2373 |
</t> |
</t> |
| 2374 |
<t>Example:</t> |
<t>Example:</t> |
| 2375 |
<t> |
<t> |
| 2376 |
<list> |
<list> |
| 2377 |
<t>C: "GET AVAILABLE_ENGINES"</t> |
<t>C: "GET AVAILABLE_ENGINES"</t> |
| 2378 |
<t>S: "GigEngine,AkaiEngine,DLSEngine,JoesCustomEngine"</t> |
<t>S: "4"</t> |
| 2379 |
</list> |
</list> |
| 2380 |
</t> |
</t> |
| 2381 |
</section> |
</section> |
| 2382 |
|
|
| 2383 |
<section title="Getting information about an engine"> |
<section title="Getting all available engines" anchor="LIST AVAILABLE_ENGINES"> |
| 2384 |
|
<t>The front-end can ask for a list of all available engines by sending the following command:</t> |
| 2385 |
|
<t> |
| 2386 |
|
<list> |
| 2387 |
|
<t>LIST AVAILABLE_ENGINES</t> |
| 2388 |
|
</list> |
| 2389 |
|
</t> |
| 2390 |
|
<t>Possible Answers:</t> |
| 2391 |
|
<t> |
| 2392 |
|
<list> |
| 2393 |
|
<t>LinuxSampler will answer by sending a comma separated list |
| 2394 |
|
of the engines' names encapsulated into apostrophes ('). |
| 2395 |
|
Engine names can consist of lower and upper cases, |
| 2396 |
|
digits and underlines ("_" character).</t> |
| 2397 |
|
</list> |
| 2398 |
|
</t> |
| 2399 |
|
<t>Example:</t> |
| 2400 |
|
<t> |
| 2401 |
|
<list> |
| 2402 |
|
<t>C: "LIST AVAILABLE_ENGINES"</t> |
| 2403 |
|
<t>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"</t> |
| 2404 |
|
</list> |
| 2405 |
|
</t> |
| 2406 |
|
</section> |
| 2407 |
|
|
| 2408 |
|
<section title="Getting information about an engine" anchor="GET ENGINE INFO"> |
| 2409 |
<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 |
| 2410 |
sending the following command:</t> |
sending the following command:</t> |
| 2411 |
<t> |
<t> |
| 2414 |
</list> |
</list> |
| 2415 |
</t> |
</t> |
| 2416 |
<t>Where <engine-name> is an engine name as obtained by the |
<t>Where <engine-name> is an engine name as obtained by the |
| 2417 |
"GET AVAILABLE_ENGINES" command.</t> |
<xref target="LIST AVAILABLE_ENGINES"> |
| 2418 |
|
"LIST AVAILABLE_ENGINES"</xref> command.</t> |
| 2419 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 2420 |
<t> |
<t> |
| 2421 |
<list> |
<list> |
| 2455 |
</t> |
</t> |
| 2456 |
</section> |
</section> |
| 2457 |
|
|
| 2458 |
<section title="Getting sampler channel information"> |
<section title="Getting sampler channel information" anchor="GET CHANNEL INFO"> |
| 2459 |
<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 |
| 2460 |
by sending the following command:</t> |
by sending the following command:</t> |
| 2461 |
<t> |
<t> |
| 2463 |
<t>GET CHANNEL INFO <sampler-channel></t> |
<t>GET CHANNEL INFO <sampler-channel></t> |
| 2464 |
</list> |
</list> |
| 2465 |
</t> |
</t> |
| 2466 |
<t>Where <sampler-channel> is the sampler channel number the front-end is interested in.</t> |
<t>Where <sampler-channel> is the sampler channel number the front-end is interested in |
| 2467 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 2468 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
| 2469 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 2470 |
<t> |
<t> |
| 2471 |
<list> |
<list> |
| 2479 |
<list> |
<list> |
| 2480 |
<t>ENGINE_NAME - |
<t>ENGINE_NAME - |
| 2481 |
<list> |
<list> |
| 2482 |
<t>name of the engine that is deployed on the sampler |
<t>name of the engine that is associated with the sampler |
| 2483 |
channel, "NONE" if there's no engine deployed yet for |
channel, "NONE" if there's no engine associated yet for |
| 2484 |
this sampler channel</t> |
this sampler channel</t> |
| 2485 |
</list> |
</list> |
| 2486 |
</t> |
</t> |
| 2555 |
<t>VOLUME - |
<t>VOLUME - |
| 2556 |
<list> |
<list> |
| 2557 |
<t>optionally dotted number for the channel volume factor |
<t>optionally dotted number for the channel volume factor |
| 2558 |
(where a value < 1.0 means attenuation and a value > |
(where a value < 1.0 means attenuation and a value > |
| 2559 |
1.0 means amplification)</t> |
1.0 means amplification)</t> |
| 2560 |
</list> |
</list> |
| 2561 |
</t> |
</t> |
| 2562 |
|
<t>MUTE - |
| 2563 |
|
<list> |
| 2564 |
|
<t>Determines whether the channel is muted, "true" if the |
| 2565 |
|
channel is muted, "false" if the channel is not muted, and |
| 2566 |
|
"MUTED_BY_SOLO" if the channel is muted because of the |
| 2567 |
|
presence of a solo channel and will be unmuted when |
| 2568 |
|
there are no solo channels left</t> |
| 2569 |
|
</list> |
| 2570 |
|
</t> |
| 2571 |
|
<t>SOLO - |
| 2572 |
|
<list> |
| 2573 |
|
<t>Determines whether this is a solo channel, "true" if |
| 2574 |
|
the channel is a solo channel; "false" otherwise</t> |
| 2575 |
|
</list> |
| 2576 |
|
</t> |
| 2577 |
|
<t>MIDI_INSTRUMENT_MAP - |
| 2578 |
|
<list> |
| 2579 |
|
<t>Determines to which MIDI instrument map this sampler |
| 2580 |
|
channel is assigned to. Read chapter |
| 2581 |
|
<xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref> |
| 2582 |
|
for a list of possible values.</t> |
| 2583 |
|
</list> |
| 2584 |
|
</t> |
| 2585 |
</list> |
</list> |
| 2586 |
</t> |
</t> |
| 2587 |
</list> |
</list> |
| 2604 |
<t> "MIDI_INPUT_DEVICE: 0"</t> |
<t> "MIDI_INPUT_DEVICE: 0"</t> |
| 2605 |
<t> "MIDI_INPUT_PORT: 0"</t> |
<t> "MIDI_INPUT_PORT: 0"</t> |
| 2606 |
<t> "MIDI_INPUT_CHANNEL: 5"</t> |
<t> "MIDI_INPUT_CHANNEL: 5"</t> |
| 2607 |
|
<t> "VOLUME: 1.0"</t> |
| 2608 |
|
<t> "MUTE: false"</t> |
| 2609 |
|
<t> "SOLO: false"</t> |
| 2610 |
|
<t> "MIDI_INSTRUMENT_MAP: NONE"</t> |
| 2611 |
<t> "."</t> |
<t> "."</t> |
| 2612 |
</list> |
</list> |
| 2613 |
</t> |
</t> |
| 2614 |
</section> |
</section> |
| 2615 |
|
|
| 2616 |
<section title="Current number of active voices"> |
<section title="Current number of active voices" anchor="GET CHANNEL VOICE_COUNT"> |
| 2617 |
<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 |
| 2618 |
sampler channel by sending the following command:</t> |
sampler channel by sending the following command:</t> |
| 2619 |
<t> |
<t> |
| 2621 |
<t>GET CHANNEL VOICE_COUNT <sampler-channel></t> |
<t>GET CHANNEL VOICE_COUNT <sampler-channel></t> |
| 2622 |
</list> |
</list> |
| 2623 |
</t> |
</t> |
| 2624 |
<t>Where <sampler-channel> is the sampler channel number the front-end is interested in.</t> |
<t>Where <sampler-channel> is the sampler channel number the front-end is interested in |
| 2625 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 2626 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
| 2627 |
|
|
| 2628 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 2629 |
<t> |
<t> |
| 2640 |
</t> |
</t> |
| 2641 |
</section> |
</section> |
| 2642 |
|
|
| 2643 |
<section title="Current number of active disk streams"> |
<section title="Current number of active disk streams" anchor="GET CHANNEL STREAM_COUNT"> |
| 2644 |
<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 |
| 2645 |
on a sampler channel by sending the following command:</t> |
on a sampler channel by sending the following command:</t> |
| 2646 |
<t> |
<t> |
| 2648 |
<t>GET CHANNEL STREAM_COUNT <sampler-channel></t> |
<t>GET CHANNEL STREAM_COUNT <sampler-channel></t> |
| 2649 |
</list> |
</list> |
| 2650 |
</t> |
</t> |
| 2651 |
<t>Where <sampler-channel> is the sampler channel number the front-end is interested in.</t> |
<t>Where <sampler-channel> is the sampler channel number the front-end is interested in |
| 2652 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 2653 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
| 2654 |
|
|
| 2655 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 2656 |
<t> |
<t> |
| 2669 |
</t> |
</t> |
| 2670 |
</section> |
</section> |
| 2671 |
|
|
| 2672 |
<section title="Current fill state of disk stream buffers"> |
<section title="Current fill state of disk stream buffers" anchor="GET CHANNEL BUFFER_FILL"> |
| 2673 |
<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 |
| 2674 |
on a sampler channel by sending the following command:</t> |
on a sampler channel by sending the following command:</t> |
| 2675 |
<t> |
<t> |
| 2684 |
</list> |
</list> |
| 2685 |
</t> |
</t> |
| 2686 |
<t>to get the fill state in percent, where <sampler-channel> is the |
<t>to get the fill state in percent, where <sampler-channel> is the |
| 2687 |
sampler channel number the front-end is interested in.</t> |
sampler channel number the front-end is interested in |
| 2688 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 2689 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
| 2690 |
|
|
| 2691 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 2692 |
<t> |
<t> |
| 2722 |
</t> |
</t> |
| 2723 |
</section> |
</section> |
| 2724 |
|
|
| 2725 |
<section title="Setting audio output device"> |
<section title="Setting audio output device" anchor="SET CHANNEL AUDIO_OUTPUT_DEVICE"> |
| 2726 |
<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 |
| 2727 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
| 2728 |
<t> |
<t> |
| 2730 |
<t>SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel> <audio-device-id></t> |
<t>SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel> <audio-device-id></t> |
| 2731 |
</list> |
</list> |
| 2732 |
</t> |
</t> |
| 2733 |
<t>Where <audio-device-id> is the numerical ID of the audio output |
<t>Where <sampler-channel> is the respective sampler channel |
| 2734 |
device and <sampler-channel> is the respective sampler channel |
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 2735 |
number.</t> |
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
| 2736 |
|
<audio-device-id> is the numerical ID of the audio output device as given by the |
| 2737 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
| 2738 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
| 2739 |
|
command.</t> |
| 2740 |
|
|
| 2741 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 2742 |
<t> |
<t> |
| 2768 |
</t> |
</t> |
| 2769 |
</section> |
</section> |
| 2770 |
|
|
| 2771 |
<section title="Setting audio output type"> |
<section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYPE"> |
| 2772 |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
| 2773 |
|
|
| 2774 |
<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 |
| 2811 |
</t> |
</t> |
| 2812 |
</section> |
</section> |
| 2813 |
|
|
| 2814 |
<section title="Setting audio output channel"> |
<section title="Setting audio output channel" anchor="SET CHANNEL AUDIO_OUTPUT_CHANNEL"> |
| 2815 |
<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 |
| 2816 |
sampler channel by sending the following command:</t> |
sampler channel by sending the following command:</t> |
| 2817 |
<t> |
<t> |
| 2819 |
<t>SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out> <audio-in></t> |
<t>SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out> <audio-in></t> |
| 2820 |
</list> |
</list> |
| 2821 |
</t> |
</t> |
| 2822 |
<t>Where <sampler-chan> is the sampler channel, <audio-out> is the |
<t>Where <sampler-chan> is the sampler channel number |
| 2823 |
sampler channel's audio output channel which should be |
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 2824 |
rerouted and <audio-in> the audio channel of the selected audio |
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, <audio-out> is the |
| 2825 |
|
numerical ID of the sampler channel's audio output channel which should be |
| 2826 |
|
rerouted and <audio-in> is the numerical ID of the audio channel of the selected audio |
| 2827 |
output device where <audio-out> should be routed to.</t> |
output device where <audio-out> should be routed to.</t> |
| 2828 |
|
|
| 2829 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 2856 |
</t> |
</t> |
| 2857 |
</section> |
</section> |
| 2858 |
|
|
| 2859 |
<section title="Setting MIDI input device"> |
<section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE"> |
| 2860 |
<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 |
| 2861 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
| 2862 |
<t> |
<t> |
| 2864 |
<t>SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id></t> |
<t>SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id></t> |
| 2865 |
</list> |
</list> |
| 2866 |
</t> |
</t> |
| 2867 |
<t></t> |
<t>Where <sampler-channel> is the sampler channel number |
| 2868 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 2869 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command |
| 2870 |
|
and <midi-device-id> is the numerical ID of the MIDI input device as returned by the |
| 2871 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
| 2872 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command.</t> |
| 2873 |
|
|
| 2874 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 2875 |
<t> |
<t> |
| 2901 |
</t> |
</t> |
| 2902 |
</section> |
</section> |
| 2903 |
|
|
| 2904 |
<section title="Setting MIDI input type"> |
<section title="Setting MIDI input type" anchor="SET CHANNEL MIDI_INPUT_TYPE"> |
| 2905 |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
| 2906 |
|
|
| 2907 |
<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 |
| 2944 |
</t> |
</t> |
| 2945 |
</section> |
</section> |
| 2946 |
|
|
| 2947 |
<section title="Setting MIDI input port"> |
<section title="Setting MIDI input port" anchor="SET CHANNEL MIDI_INPUT_PORT"> |
| 2948 |
<t>The front-end can alter the input MIDI port on a specific sampler |
<t>The front-end can alter the MIDI input port on a specific sampler |
| 2949 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
| 2950 |
<t> |
<t> |
| 2951 |
<list> |
<list> |
| 2973 |
</t> |
</t> |
| 2974 |
<t>"ERR:<error-code>:<error-message>" - |
<t>"ERR:<error-code>:<error-message>" - |
| 2975 |
<list> |
<list> |
| 2976 |
<t>in case it failed, providing an appropriate error code and error messag</t> |
<t>in case it failed, providing an appropriate error code and error message</t> |
| 2977 |
</list> |
</list> |
| 2978 |
</t> |
</t> |
| 2979 |
</list> |
</list> |
| 2986 |
</t> |
</t> |
| 2987 |
</section> |
</section> |
| 2988 |
|
|
| 2989 |
<section title="Setting MIDI input channel"> |
<section title="Setting MIDI input channel" anchor="SET CHANNEL MIDI_INPUT_CHANNEL"> |
| 2990 |
<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 |
| 2991 |
listen to by sending the following command:</t> |
listen to by sending the following command:</t> |
| 2992 |
<t> |
<t> |
| 2994 |
<t>SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan></t> |
<t>SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan></t> |
| 2995 |
</list> |
</list> |
| 2996 |
</t> |
</t> |
| 2997 |
<t>Where <midi-input-chan> is the new MIDI input channel where |
<t>Where <midi-input-chan> is the number of the new MIDI input channel where |
| 2998 |
<sampler-channel> should listen to or "ALL" to listen on all 16 MIDI |
<sampler-channel> should listen to or "ALL" to listen on all 16 MIDI |
| 2999 |
channels.</t> |
channels.</t> |
| 3000 |
|
|
| 3028 |
</t> |
</t> |
| 3029 |
</section> |
</section> |
| 3030 |
|
|
| 3031 |
<section title="Setting channel volume"> |
<section title="Setting channel volume" anchor="SET CHANNEL VOLUME"> |
| 3032 |
<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 |
| 3033 |
the following command:</t> |
the following command:</t> |
| 3034 |
<t> |
<t> |
| 3071 |
</t> |
</t> |
| 3072 |
</section> |
</section> |
| 3073 |
|
|
| 3074 |
<section title="Resetting a sampler channel"> |
<section title="Muting a sampler channel" anchor="SET CHANNEL MUTE"> |
| 3075 |
|
<t>The front-end can mute/unmute a specific sampler |
| 3076 |
|
channel by sending the following command:</t> |
| 3077 |
|
<t> |
| 3078 |
|
<list> |
| 3079 |
|
<t>SET CHANNEL MUTE <sampler-channel> <mute></t> |
| 3080 |
|
</list> |
| 3081 |
|
</t> |
| 3082 |
|
<t>Where <sampler-channel> is the respective sampler channel |
| 3083 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3084 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
| 3085 |
|
<mute> should be replaced either by "1" to mute the channel or "0" |
| 3086 |
|
to unmute the channel.</t> |
| 3087 |
|
|
| 3088 |
|
<t>Possible Answers:</t> |
| 3089 |
|
<t> |
| 3090 |
|
<list> |
| 3091 |
|
<t>"OK" - |
| 3092 |
|
<list> |
| 3093 |
|
<t>on success</t> |
| 3094 |
|
</list> |
| 3095 |
|
</t> |
| 3096 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
| 3097 |
|
<list> |
| 3098 |
|
<t>if the channel was muted/unmuted, but there are noteworthy |
| 3099 |
|
issue(s) related, providing an appropriate warning code and |
| 3100 |
|
warning message</t> |
| 3101 |
|
</list> |
| 3102 |
|
</t> |
| 3103 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3104 |
|
<list> |
| 3105 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 3106 |
|
</list> |
| 3107 |
|
</t> |
| 3108 |
|
</list> |
| 3109 |
|
</t> |
| 3110 |
|
<t>Examples:</t> |
| 3111 |
|
<t> |
| 3112 |
|
<list> |
| 3113 |
|
<t></t> |
| 3114 |
|
</list> |
| 3115 |
|
</t> |
| 3116 |
|
</section> |
| 3117 |
|
|
| 3118 |
|
<section title="Soloing a sampler channel" anchor="SET CHANNEL SOLO"> |
| 3119 |
|
<t>The front-end can solo/unsolo a specific sampler channel |
| 3120 |
|
by sending the following command:</t> |
| 3121 |
|
<t> |
| 3122 |
|
<list> |
| 3123 |
|
<t>SET CHANNEL SOLO <sampler-channel> <solo></t> |
| 3124 |
|
</list> |
| 3125 |
|
</t> |
| 3126 |
|
<t>Where <sampler-channel> is the respective sampler channel |
| 3127 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3128 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
| 3129 |
|
<solo> should be replaced either by "1" to solo the channel or "0" |
| 3130 |
|
to unsolo the channel.</t> |
| 3131 |
|
|
| 3132 |
|
<t>Possible Answers:</t> |
| 3133 |
|
<t> |
| 3134 |
|
<list> |
| 3135 |
|
<t>"OK" - |
| 3136 |
|
<list> |
| 3137 |
|
<t>on success</t> |
| 3138 |
|
</list> |
| 3139 |
|
</t> |
| 3140 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
| 3141 |
|
<list> |
| 3142 |
|
<t>if the channel was soloed/unsoloed, but there are noteworthy |
| 3143 |
|
issue(s) related, providing an appropriate warning code and |
| 3144 |
|
warning message</t> |
| 3145 |
|
</list> |
| 3146 |
|
</t> |
| 3147 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3148 |
|
<list> |
| 3149 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 3150 |
|
</list> |
| 3151 |
|
</t> |
| 3152 |
|
</list> |
| 3153 |
|
</t> |
| 3154 |
|
<t>Examples:</t> |
| 3155 |
|
<t> |
| 3156 |
|
<list> |
| 3157 |
|
<t></t> |
| 3158 |
|
</list> |
| 3159 |
|
</t> |
| 3160 |
|
</section> |
| 3161 |
|
|
| 3162 |
|
<section title="Assigning a MIDI instrument map to a sampler channel" anchor="SET CHANNEL MIDI_INSTRUMENT_MAP"> |
| 3163 |
|
<t>The front-end can assign a MIDI instrument map to a specific sampler channel |
| 3164 |
|
by sending the following command:</t> |
| 3165 |
|
<t> |
| 3166 |
|
<list> |
| 3167 |
|
<t>SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <map></t> |
| 3168 |
|
</list> |
| 3169 |
|
</t> |
| 3170 |
|
<t>Where <sampler-channel> is the respective sampler channel |
| 3171 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3172 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
| 3173 |
|
<map> can have the following possibilites:</t> |
| 3174 |
|
<t> |
| 3175 |
|
<list> |
| 3176 |
|
<t>"NONE" - |
| 3177 |
|
<list> |
| 3178 |
|
<t>This is the default setting. In this case |
| 3179 |
|
the sampler channel is not assigned any MIDI |
| 3180 |
|
instrument map and thus will ignore all MIDI |
| 3181 |
|
program change messages.</t> |
| 3182 |
|
</list> |
| 3183 |
|
</t> |
| 3184 |
|
<t>"DEFAULT" - |
| 3185 |
|
<list> |
| 3186 |
|
<t>The sampler channel will always use the |
| 3187 |
|
default MIDI instrument map to handle MIDI |
| 3188 |
|
program change messages.</t> |
| 3189 |
|
</list> |
| 3190 |
|
</t> |
| 3191 |
|
<t>numeric ID - |
| 3192 |
|
<list> |
| 3193 |
|
<t>You can assign a specific MIDI instrument map |
| 3194 |
|
by replacing <map> with the respective numeric |
| 3195 |
|
ID of the MIDI instrument map as returned by the |
| 3196 |
|
<xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref> |
| 3197 |
|
command. Once that map will be deleted, the sampler |
| 3198 |
|
channel would fall back to "NONE".</t> |
| 3199 |
|
</list> |
| 3200 |
|
</t> |
| 3201 |
|
</list> |
| 3202 |
|
</t> |
| 3203 |
|
<t>Read chapter <xref target="MIDI Instrument Mapping">"MIDI Instrument Mapping"</xref> |
| 3204 |
|
for details regarding MIDI instrument mapping.</t> |
| 3205 |
|
|
| 3206 |
|
<t>Possible Answers:</t> |
| 3207 |
|
<t> |
| 3208 |
|
<list> |
| 3209 |
|
<t>"OK" - |
| 3210 |
|
<list> |
| 3211 |
|
<t>on success</t> |
| 3212 |
|
</list> |
| 3213 |
|
</t> |
| 3214 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3215 |
|
<list> |
| 3216 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 3217 |
|
</list> |
| 3218 |
|
</t> |
| 3219 |
|
</list> |
| 3220 |
|
</t> |
| 3221 |
|
|
| 3222 |
|
<t>Examples:</t> |
| 3223 |
|
<t> |
| 3224 |
|
<list> |
| 3225 |
|
<t></t> |
| 3226 |
|
</list> |
| 3227 |
|
</t> |
| 3228 |
|
</section> |
| 3229 |
|
|
| 3230 |
|
<section title="Adding an effect send to a sampler channel" anchor="CREATE FX_SEND"> |
| 3231 |
|
<t>The front-end can create an additional effect send on a specific sampler channel |
| 3232 |
|
by sending the following command:</t> |
| 3233 |
|
<t> |
| 3234 |
|
<list> |
| 3235 |
|
<t>CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>]</t> |
| 3236 |
|
</list> |
| 3237 |
|
</t> |
| 3238 |
|
<t>Where <sampler-channel> is the respective sampler channel |
| 3239 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3240 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the |
| 3241 |
|
sampler channel on which the effect send should be created on, <midi-ctrl> |
| 3242 |
|
is a number between 0..127 defining the MIDI controller which can alter the |
| 3243 |
|
effect send level and <name> is an optional argument defining a name |
| 3244 |
|
for the effect send entity. The name does not have to be unique.</t> |
| 3245 |
|
|
| 3246 |
|
<t>By default, that is as initial routing, the effect send's audio channels |
| 3247 |
|
are automatically routed to the last audio channels of the sampler channel's |
| 3248 |
|
audio output device, that way you can i.e. first increase the amount of audio |
| 3249 |
|
channels on the audio output device for having dedicated effect send output |
| 3250 |
|
channels and when "CREATE FX_SEND" is called, those channels will automatically |
| 3251 |
|
be picked. You can alter the destination channels however with |
| 3252 |
|
<xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>. |
| 3253 |
|
</t> |
| 3254 |
|
|
| 3255 |
|
<t>Note: Create effect sends on a sampler channel only when needed, because having effect |
| 3256 |
|
sends on a sampler channel will decrease runtime performance, because for implementing channel |
| 3257 |
|
effect sends, separate (sampler channel local) audio buffers are needed to render and mix |
| 3258 |
|
the voices and route the audio signal afterwards to the master outputs and effect send |
| 3259 |
|
outputs (along with their respective effect send levels). A sampler channel without effect |
| 3260 |
|
sends however can mix its voices directly into the audio output devices's audio buffers |
| 3261 |
|
and is thus faster. |
| 3262 |
|
</t> |
| 3263 |
|
|
| 3264 |
|
<t>Possible Answers:</t> |
| 3265 |
|
<t> |
| 3266 |
|
<list> |
| 3267 |
|
<t>"OK[<fx-send-id>]" - |
| 3268 |
|
<list> |
| 3269 |
|
<t>in case a new effect send could be added to the |
| 3270 |
|
sampler channel, where <fx-send-id> reflects the |
| 3271 |
|
unique ID of the newly created effect send entity</t> |
| 3272 |
|
</list> |
| 3273 |
|
</t> |
| 3274 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3275 |
|
<list> |
| 3276 |
|
<t>when a new effect send could not be added, i.e. |
| 3277 |
|
due to invalid parameters</t> |
| 3278 |
|
</list> |
| 3279 |
|
</t> |
| 3280 |
|
</list> |
| 3281 |
|
</t> |
| 3282 |
|
|
| 3283 |
|
<t>Examples:</t> |
| 3284 |
|
<t> |
| 3285 |
|
<list> |
| 3286 |
|
<t>C: "CREATE FX_SEND 0 91 'Reverb Send'"</t> |
| 3287 |
|
<t>S: "OK[0]"</t> |
| 3288 |
|
</list> |
| 3289 |
|
</t> |
| 3290 |
|
<t> |
| 3291 |
|
<list> |
| 3292 |
|
<t>C: "CREATE FX_SEND 0 93"</t> |
| 3293 |
|
<t>S: "OK[1]"</t> |
| 3294 |
|
</list> |
| 3295 |
|
</t> |
| 3296 |
|
</section> |
| 3297 |
|
|
| 3298 |
|
<section title="Removing an effect send from a sampler channel" anchor="DESTROY FX_SEND"> |
| 3299 |
|
<t>The front-end can remove an existing effect send on a specific sampler channel |
| 3300 |
|
by sending the following command:</t> |
| 3301 |
|
<t> |
| 3302 |
|
<list> |
| 3303 |
|
<t>DESTROY FX_SEND <sampler-channel> <fx-send-id></t> |
| 3304 |
|
</list> |
| 3305 |
|
</t> |
| 3306 |
|
<t>Where <sampler-channel> is the respective sampler channel |
| 3307 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3308 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the |
| 3309 |
|
sampler channel from which the effect send should be removed from and |
| 3310 |
|
<fx-send-id> is the respective effect send number as returned by the |
| 3311 |
|
<xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
| 3312 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t> |
| 3313 |
|
|
| 3314 |
|
<t>Possible Answers:</t> |
| 3315 |
|
<t> |
| 3316 |
|
<list> |
| 3317 |
|
<t>"OK" - |
| 3318 |
|
<list> |
| 3319 |
|
<t>on success</t> |
| 3320 |
|
</list> |
| 3321 |
|
</t> |
| 3322 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3323 |
|
<list> |
| 3324 |
|
<t>in case it failed, providing an appropriate error code and |
| 3325 |
|
error message</t> |
| 3326 |
|
</list> |
| 3327 |
|
</t> |
| 3328 |
|
</list> |
| 3329 |
|
</t> |
| 3330 |
|
|
| 3331 |
|
<t>Example:</t> |
| 3332 |
|
<t> |
| 3333 |
|
<list> |
| 3334 |
|
<t>C: "DESTROY FX_SEND 0 0"</t> |
| 3335 |
|
<t>S: "OK"</t> |
| 3336 |
|
</list> |
| 3337 |
|
</t> |
| 3338 |
|
</section> |
| 3339 |
|
|
| 3340 |
|
<section title="Getting amount of effect sends on a sampler channel" anchor="GET FX_SENDS"> |
| 3341 |
|
<t>The front-end can ask for the amount of effect sends on a specific sampler channel |
| 3342 |
|
by sending the following command:</t> |
| 3343 |
|
<t> |
| 3344 |
|
<list> |
| 3345 |
|
<t>GET FX_SENDS <sampler-channel></t> |
| 3346 |
|
</list> |
| 3347 |
|
</t> |
| 3348 |
|
<t>Where <sampler-channel> is the respective sampler channel |
| 3349 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3350 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
| 3351 |
|
|
| 3352 |
|
<t>Possible Answers:</t> |
| 3353 |
|
<t> |
| 3354 |
|
<list> |
| 3355 |
|
<t>The sampler will answer by returning the number of effect |
| 3356 |
|
sends on the given sampler channel.</t> |
| 3357 |
|
</list> |
| 3358 |
|
</t> |
| 3359 |
|
|
| 3360 |
|
<t>Example:</t> |
| 3361 |
|
<t> |
| 3362 |
|
<list> |
| 3363 |
|
<t>C: "GET FX_SENDS 0"</t> |
| 3364 |
|
<t>S: "2"</t> |
| 3365 |
|
</list> |
| 3366 |
|
</t> |
| 3367 |
|
</section> |
| 3368 |
|
|
| 3369 |
|
<section title="Listing all effect sends on a sampler channel" anchor="LIST FX_SENDS"> |
| 3370 |
|
<t>The front-end can ask for a list of effect sends on a specific sampler channel |
| 3371 |
|
by sending the following command:</t> |
| 3372 |
|
<t> |
| 3373 |
|
<list> |
| 3374 |
|
<t>LIST FX_SENDS <sampler-channel></t> |
| 3375 |
|
</list> |
| 3376 |
|
</t> |
| 3377 |
|
<t>Where <sampler-channel> is the respective sampler channel |
| 3378 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3379 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
| 3380 |
|
|
| 3381 |
|
<t>Possible Answers:</t> |
| 3382 |
|
<t> |
| 3383 |
|
<list> |
| 3384 |
|
<t>The sampler will answer by returning a comma separated list |
| 3385 |
|
with all effect sends' numerical IDs on the given sampler |
| 3386 |
|
channel.</t> |
| 3387 |
|
</list> |
| 3388 |
|
</t> |
| 3389 |
|
|
| 3390 |
|
<t>Examples:</t> |
| 3391 |
|
<t> |
| 3392 |
|
<list> |
| 3393 |
|
<t>C: "LIST FX_SENDS 0"</t> |
| 3394 |
|
<t>S: "0,1"</t> |
| 3395 |
|
</list> |
| 3396 |
|
</t> |
| 3397 |
|
<t> |
| 3398 |
|
<list> |
| 3399 |
|
<t>C: "LIST FX_SENDS 1"</t> |
| 3400 |
|
<t>S: ""</t> |
| 3401 |
|
</list> |
| 3402 |
|
</t> |
| 3403 |
|
</section> |
| 3404 |
|
|
| 3405 |
|
<section title="Getting effect send information" anchor="GET FX_SEND INFO"> |
| 3406 |
|
<t>The front-end can ask for the current settings of an effect send entity |
| 3407 |
|
by sending the following command:</t> |
| 3408 |
|
<t> |
| 3409 |
|
<list> |
| 3410 |
|
<t>GET FX_SEND INFO <sampler-channel> <fx-send-id></t> |
| 3411 |
|
</list> |
| 3412 |
|
</t> |
| 3413 |
|
<t>Where <sampler-channel> is the sampler channel number |
| 3414 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3415 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
| 3416 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
| 3417 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
| 3418 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command. |
| 3419 |
|
</t> |
| 3420 |
|
|
| 3421 |
|
<t>Possible Answers:</t> |
| 3422 |
|
<t> |
| 3423 |
|
<list> |
| 3424 |
|
<t>The sampler will answer by sending a <CRLF> separated list. |
| 3425 |
|
Each answer line begins with the settings category name |
| 3426 |
|
followed by a colon and then a space character <SP> and finally |
| 3427 |
|
the info character string to that setting category. At the |
| 3428 |
|
moment the following categories are defined:</t> |
| 3429 |
|
|
| 3430 |
|
<t> |
| 3431 |
|
<list> |
| 3432 |
|
<t>NAME - |
| 3433 |
|
<list> |
| 3434 |
|
<t>name of the effect send entity</t> |
| 3435 |
|
</list> |
| 3436 |
|
</t> |
| 3437 |
|
<t>MIDI_CONTROLLER - |
| 3438 |
|
<list> |
| 3439 |
|
<t>a value between 0 and 127 reflecting the MIDI controller |
| 3440 |
|
which is able to modify the effect send's send level</t> |
| 3441 |
|
</list> |
| 3442 |
|
</t> |
| 3443 |
|
<t>LEVEL - |
| 3444 |
|
<list> |
| 3445 |
|
<t>optionally dotted number reflecting the effect send's |
| 3446 |
|
current send level (where a value < 1.0 means attenuation |
| 3447 |
|
and a value > 1.0 means amplification)</t> |
| 3448 |
|
</list> |
| 3449 |
|
</t> |
| 3450 |
|
<t>AUDIO_OUTPUT_ROUTING - |
| 3451 |
|
<list> |
| 3452 |
|
<t>comma separated list which reflects to which audio |
| 3453 |
|
channel of the selected audio output device each |
| 3454 |
|
effect send output channel is routed to, e.g. "0,3" would |
| 3455 |
|
mean the effect send's output channel 0 is routed to channel |
| 3456 |
|
0 of the audio output device and the effect send's output |
| 3457 |
|
channel 1 is routed to the channel 3 of the audio |
| 3458 |
|
output device (see |
| 3459 |
|
<xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref> |
| 3460 |
|
for details)</t> |
| 3461 |
|
</list> |
| 3462 |
|
</t> |
| 3463 |
|
</list> |
| 3464 |
|
</t> |
| 3465 |
|
</list> |
| 3466 |
|
</t> |
| 3467 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
| 3468 |
|
|
| 3469 |
|
<t>Example:</t> |
| 3470 |
|
<t> |
| 3471 |
|
<list> |
| 3472 |
|
<t>C: "GET FX_SEND INFO 0 0"</t> |
| 3473 |
|
<t>S: "NAME: Reverb Send"</t> |
| 3474 |
|
<t> "MIDI_CONTROLLER: 91"</t> |
| 3475 |
|
<t> "LEVEL: 0.3"</t> |
| 3476 |
|
<t> "AUDIO_OUTPUT_ROUTING: 2,3"</t> |
| 3477 |
|
<t> "."</t> |
| 3478 |
|
</list> |
| 3479 |
|
</t> |
| 3480 |
|
</section> |
| 3481 |
|
|
| 3482 |
|
<section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL"> |
| 3483 |
|
<t>The front-end can alter the destination of an effect send's audio channel on a specific |
| 3484 |
|
sampler channel by sending the following command:</t> |
| 3485 |
|
<t> |
| 3486 |
|
<list> |
| 3487 |
|
<t>SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id> <audio-src> <audio-dst></t> |
| 3488 |
|
</list> |
| 3489 |
|
</t> |
| 3490 |
|
<t>Where <sampler-chan> is the sampler channel number |
| 3491 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3492 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
| 3493 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
| 3494 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
| 3495 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command, |
| 3496 |
|
<audio-src> is the numerical ID of the effect send's audio channel |
| 3497 |
|
which should be rerouted and <audio-dst> is the numerical ID of |
| 3498 |
|
the audio channel of the selected audio output device where <audio-src> |
| 3499 |
|
should be routed to.</t> |
| 3500 |
|
|
| 3501 |
|
<t>Note that effect sends can only route audio to the same audio output |
| 3502 |
|
device as assigned to the effect send's sampler channel. Also note that an |
| 3503 |
|
effect send entity does always have exactly as much audio channels as its |
| 3504 |
|
sampler channel. So if the sampler channel is stereo, the effect send does |
| 3505 |
|
have two audio channels as well. Also keep in mind that the amount of audio |
| 3506 |
|
channels on a sampler channel might be dependant not only to the deployed |
| 3507 |
|
sampler engine on the sampler channel, but also dependant to the instrument |
| 3508 |
|
currently loaded. However you can (effectively) turn an i.e. stereo effect |
| 3509 |
|
send into a mono one by simply altering its audio routing appropriately.</t> |
| 3510 |
|
|
| 3511 |
|
<t>Possible Answers:</t> |
| 3512 |
|
<t> |
| 3513 |
|
<list> |
| 3514 |
|
<t>"OK" - |
| 3515 |
|
<list> |
| 3516 |
|
<t>on success</t> |
| 3517 |
|
</list> |
| 3518 |
|
</t> |
| 3519 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
| 3520 |
|
<list> |
| 3521 |
|
<t>if audio output channel was set, but there are noteworthy |
| 3522 |
|
issue(s) related, providing an appropriate warning code and |
| 3523 |
|
warning message</t> |
| 3524 |
|
</list> |
| 3525 |
|
</t> |
| 3526 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3527 |
|
<list> |
| 3528 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 3529 |
|
</list> |
| 3530 |
|
</t> |
| 3531 |
|
</list> |
| 3532 |
|
</t> |
| 3533 |
|
<t>Example:</t> |
| 3534 |
|
<t> |
| 3535 |
|
<list> |
| 3536 |
|
<t>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"</t> |
| 3537 |
|
<t>S: "OK"</t> |
| 3538 |
|
</list> |
| 3539 |
|
</t> |
| 3540 |
|
</section> |
| 3541 |
|
|
| 3542 |
|
<section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER"> |
| 3543 |
|
<t>The front-end can alter the MIDI controller of an effect |
| 3544 |
|
send entity by sending the following command:</t> |
| 3545 |
|
<t> |
| 3546 |
|
<list> |
| 3547 |
|
<t>SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-ctrl></t> |
| 3548 |
|
</list> |
| 3549 |
|
</t> |
| 3550 |
|
<t>Where <sampler-chan> is the sampler channel number |
| 3551 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3552 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
| 3553 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
| 3554 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
| 3555 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
| 3556 |
|
<midi-ctrl> reflects the MIDI controller which shall be |
| 3557 |
|
able to modify the effect send's send level.</t> |
| 3558 |
|
|
| 3559 |
|
<t>Possible Answers:</t> |
| 3560 |
|
<t> |
| 3561 |
|
<list> |
| 3562 |
|
<t>"OK" - |
| 3563 |
|
<list> |
| 3564 |
|
<t>on success</t> |
| 3565 |
|
</list> |
| 3566 |
|
</t> |
| 3567 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
| 3568 |
|
<list> |
| 3569 |
|
<t>if MIDI controller was set, but there are noteworthy |
| 3570 |
|
issue(s) related, providing an appropriate warning code and |
| 3571 |
|
warning message</t> |
| 3572 |
|
</list> |
| 3573 |
|
</t> |
| 3574 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3575 |
|
<list> |
| 3576 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 3577 |
|
</list> |
| 3578 |
|
</t> |
| 3579 |
|
</list> |
| 3580 |
|
</t> |
| 3581 |
|
<t>Example:</t> |
| 3582 |
|
<t> |
| 3583 |
|
<list> |
| 3584 |
|
<t>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"</t> |
| 3585 |
|
<t>S: "OK"</t> |
| 3586 |
|
</list> |
| 3587 |
|
</t> |
| 3588 |
|
</section> |
| 3589 |
|
|
| 3590 |
|
<section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL"> |
| 3591 |
|
<t>The front-end can alter the current send level of an effect |
| 3592 |
|
send entity by sending the following command:</t> |
| 3593 |
|
<t> |
| 3594 |
|
<list> |
| 3595 |
|
<t>SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume></t> |
| 3596 |
|
</list> |
| 3597 |
|
</t> |
| 3598 |
|
<t>Where <sampler-chan> is the sampler channel number |
| 3599 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3600 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
| 3601 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
| 3602 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
| 3603 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
| 3604 |
|
<volume> is an optionally dotted positive number (a value |
| 3605 |
|
smaller than 1.0 means attenuation, whereas a value greater than |
| 3606 |
|
1.0 means amplification) reflecting the new send level.</t> |
| 3607 |
|
|
| 3608 |
|
<t>Possible Answers:</t> |
| 3609 |
|
<t> |
| 3610 |
|
<list> |
| 3611 |
|
<t>"OK" - |
| 3612 |
|
<list> |
| 3613 |
|
<t>on success</t> |
| 3614 |
|
</list> |
| 3615 |
|
</t> |
| 3616 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
| 3617 |
|
<list> |
| 3618 |
|
<t>if new send level was set, but there are noteworthy |
| 3619 |
|
issue(s) related, providing an appropriate warning code and |
| 3620 |
|
warning message</t> |
| 3621 |
|
</list> |
| 3622 |
|
</t> |
| 3623 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3624 |
|
<list> |
| 3625 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 3626 |
|
</list> |
| 3627 |
|
</t> |
| 3628 |
|
</list> |
| 3629 |
|
</t> |
| 3630 |
|
<t>Example:</t> |
| 3631 |
|
<t> |
| 3632 |
|
<list> |
| 3633 |
|
<t>C: "SET FX_SEND LEVEL 0 0 0.15"</t> |
| 3634 |
|
<t>S: "OK"</t> |
| 3635 |
|
</list> |
| 3636 |
|
</t> |
| 3637 |
|
</section> |
| 3638 |
|
|
| 3639 |
|
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
| 3640 |
<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> |
| 3641 |
<t> |
<t> |
| 3642 |
<list> |
<list> |
| 3684 |
<section title="Controlling connection"> |
<section title="Controlling connection"> |
| 3685 |
<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> |
| 3686 |
|
|
| 3687 |
<section title="Register front-end for receiving event messages"> |
<section title="Register front-end for receiving event messages" anchor="SUBSCRIBE"> |
| 3688 |
<t>The front-end can register itself to the LinuxSampler application to |
<t>The front-end can register itself to the LinuxSampler application to |
| 3689 |
be informed about noteworthy events by sending this command:</t> |
be informed about noteworthy events by sending this command:</t> |
| 3690 |
<t> |
<t> |
| 3726 |
</t> |
</t> |
| 3727 |
</section> |
</section> |
| 3728 |
|
|
| 3729 |
<section title="Unregister front-end for not receiving event messages"> |
<section title="Unregister front-end for not receiving event messages" anchor="UNSUBSCRIBE"> |
| 3730 |
<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 |
| 3731 |
messages anymore by sending the following command:</t> |
messages anymore by sending the following command:</t> |
| 3732 |
<t> |
<t> |
| 3768 |
</t> |
</t> |
| 3769 |
</section> |
</section> |
| 3770 |
|
|
| 3771 |
<section title="Enable or disable echo of commands"> |
<section title="Enable or disable echo of commands" anchor="SET ECHO"> |
| 3772 |
<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> |
| 3773 |
<t> |
<t> |
| 3774 |
<list> |
<list> |
| 3806 |
</t> |
</t> |
| 3807 |
</section> |
</section> |
| 3808 |
|
|
| 3809 |
<section title="Close client connection"> |
<section title="Close client connection" anchor="QUIT"> |
| 3810 |
<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> |
| 3811 |
<t> |
<t> |
| 3812 |
<list> |
<list> |
| 3821 |
<section title="Global commands"> |
<section title="Global commands"> |
| 3822 |
<t>The following commands have global impact on the sampler.</t> |
<t>The following commands have global impact on the sampler.</t> |
| 3823 |
|
|
| 3824 |
<section title="Reset sampler"> |
<section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT"> |
| 3825 |
|
<t>The front-end can ask for the current number of active voices on |
| 3826 |
|
the sampler by sending the following command:</t> |
| 3827 |
|
<t> |
| 3828 |
|
<list> |
| 3829 |
|
<t>GET TOTAL_VOICE_COUNT</t> |
| 3830 |
|
</list> |
| 3831 |
|
</t> |
| 3832 |
|
|
| 3833 |
|
<t>Possible Answers:</t> |
| 3834 |
|
<t> |
| 3835 |
|
<list> |
| 3836 |
|
<t>LinuxSampler will answer by returning the number of all active |
| 3837 |
|
voices on the sampler.</t> |
| 3838 |
|
</list> |
| 3839 |
|
</t> |
| 3840 |
|
</section> |
| 3841 |
|
|
| 3842 |
|
<section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX"> |
| 3843 |
|
<t>The front-end can ask for the maximum number of active voices |
| 3844 |
|
by sending the following command:</t> |
| 3845 |
|
<t> |
| 3846 |
|
<list> |
| 3847 |
|
<t>GET TOTAL_VOICE_COUNT_MAX</t> |
| 3848 |
|
</list> |
| 3849 |
|
</t> |
| 3850 |
|
|
| 3851 |
|
<t>Possible Answers:</t> |
| 3852 |
|
<t> |
| 3853 |
|
<list> |
| 3854 |
|
<t>LinuxSampler will answer by returning the maximum number |
| 3855 |
|
of active voices.</t> |
| 3856 |
|
</list> |
| 3857 |
|
</t> |
| 3858 |
|
</section> |
| 3859 |
|
|
| 3860 |
|
<section title="Reset sampler" anchor="RESET"> |
| 3861 |
<t>The front-end can reset the whole sampler by sending the following command:</t> |
<t>The front-end can reset the whole sampler by sending the following command:</t> |
| 3862 |
<t> |
<t> |
| 3863 |
<list> |
<list> |
| 3882 |
</list> |
</list> |
| 3883 |
</t> |
</t> |
| 3884 |
</section> |
</section> |
| 3885 |
|
|
| 3886 |
|
<section title="General sampler informations" anchor="GET SERVER INFO"> |
| 3887 |
|
<t>The client can ask for general informations about the LinuxSampler |
| 3888 |
|
instance by sending the following command:</t> |
| 3889 |
|
<t> |
| 3890 |
|
<list> |
| 3891 |
|
<t>GET SERVER INFO</t> |
| 3892 |
|
</list> |
| 3893 |
|
</t> |
| 3894 |
|
<t>Possible Answers:</t> |
| 3895 |
|
<t> |
| 3896 |
|
<list> |
| 3897 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
| 3898 |
|
Each answer line begins with the information category name |
| 3899 |
|
followed by a colon and then a space character <SP> and finally |
| 3900 |
|
the info character string to that information category. At the |
| 3901 |
|
moment the following categories are defined: |
| 3902 |
|
</t> |
| 3903 |
|
<t> |
| 3904 |
|
<list> |
| 3905 |
|
<t>DESCRIPTION - |
| 3906 |
|
<list> |
| 3907 |
|
<t>arbitrary textual description about the sampler</t> |
| 3908 |
|
</list> |
| 3909 |
|
</t> |
| 3910 |
|
<t>VERSION - |
| 3911 |
|
<list> |
| 3912 |
|
<t>version of the sampler</t> |
| 3913 |
|
</list> |
| 3914 |
|
</t> |
| 3915 |
|
<t>PROTOCOL_VERSION - |
| 3916 |
|
<list> |
| 3917 |
|
<t>version of the LSCP specification the sampler |
| 3918 |
|
complies with (see <xref target="LSCP versioning" /> for details)</t> |
| 3919 |
|
</list> |
| 3920 |
|
</t> |
| 3921 |
|
</list> |
| 3922 |
|
</t> |
| 3923 |
|
</list> |
| 3924 |
|
</t> |
| 3925 |
|
<t>The mentioned fields above don't have to be in particular order. |
| 3926 |
|
Other fields might be added in future.</t> |
| 3927 |
|
</section> |
| 3928 |
|
|
| 3929 |
|
<section title="Getting global volume attenuation" anchor="GET VOLUME"> |
| 3930 |
|
<t>The client can ask for the current global sampler-wide volume |
| 3931 |
|
attenuation by sending the following command:</t> |
| 3932 |
|
<t> |
| 3933 |
|
<list> |
| 3934 |
|
<t>GET VOLUME</t> |
| 3935 |
|
</list> |
| 3936 |
|
</t> |
| 3937 |
|
<t>Possible Answers:</t> |
| 3938 |
|
<t> |
| 3939 |
|
<list> |
| 3940 |
|
<t>The sampler will always answer by returning the optional |
| 3941 |
|
dotted floating point coefficient, reflecting the current |
| 3942 |
|
global volume attenuation. |
| 3943 |
|
</t> |
| 3944 |
|
</list> |
| 3945 |
|
</t> |
| 3946 |
|
<t>Note: it is up to the respective sampler engine whether to obey |
| 3947 |
|
that global volume parameter or not, but in general all engines SHOULD |
| 3948 |
|
use this parameter.</t> |
| 3949 |
|
</section> |
| 3950 |
|
|
| 3951 |
|
<section title="Setting global volume attenuation" anchor="SET VOLUME"> |
| 3952 |
|
<t>The client can alter the current global sampler-wide volume |
| 3953 |
|
attenuation by sending the following command:</t> |
| 3954 |
|
<t> |
| 3955 |
|
<list> |
| 3956 |
|
<t>SET VOLUME <volume></t> |
| 3957 |
|
</list> |
| 3958 |
|
</t> |
| 3959 |
|
<t>Where <volume> should be replaced by the optional dotted |
| 3960 |
|
floating point value, reflecting the new global volume parameter. |
| 3961 |
|
This value might usually be in the range between 0.0 and 1.0, that |
| 3962 |
|
is for attenuating the overall volume.</t> |
| 3963 |
|
|
| 3964 |
|
<t>Possible Answers:</t> |
| 3965 |
|
<t> |
| 3966 |
|
<list> |
| 3967 |
|
<t>"OK" - |
| 3968 |
|
<list> |
| 3969 |
|
<t>on success</t> |
| 3970 |
|
</list> |
| 3971 |
|
</t> |
| 3972 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
| 3973 |
|
<list> |
| 3974 |
|
<t>if the global volume was set, but there are noteworthy |
| 3975 |
|
issue(s) related, providing an appropriate warning code and |
| 3976 |
|
warning message</t> |
| 3977 |
|
</list> |
| 3978 |
|
</t> |
| 3979 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3980 |
|
<list> |
| 3981 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 3982 |
|
</list> |
| 3983 |
|
</t> |
| 3984 |
|
</list> |
| 3985 |
|
</t> |
| 3986 |
|
</section> |
| 3987 |
</section> |
</section> |
| 3988 |
|
|
| 3989 |
|
|
| 3990 |
|
<section title="MIDI Instrument Mapping" anchor="MIDI Instrument Mapping"> |
| 3991 |
|
<t>The MIDI protocol provides a way to switch between instruments |
| 3992 |
|
by sending so called MIDI bank select and MIDI program change |
| 3993 |
|
messages which are essentially just numbers. The following commands |
| 3994 |
|
allow to actually map arbitrary MIDI bank select / program change |
| 3995 |
|
numbers with real instruments.</t> |
| 3996 |
|
<t>The sampler allows to manage an arbitrary amount of MIDI |
| 3997 |
|
instrument maps which define which instrument to load on |
| 3998 |
|
which MIDI program change message.</t> |
| 3999 |
|
<t>By default, that is when the sampler is launched, there is no |
| 4000 |
|
map, thus the sampler will simply ignore all program change |
| 4001 |
|
messages. The front-end has to explicitly create at least one |
| 4002 |
|
map, add entries to the map and tell the respective sampler |
| 4003 |
|
channel(s) which MIDI instrument map to use, so the sampler |
| 4004 |
|
knows how to react on a given program change message on the |
| 4005 |
|
respective sampler channel, that is by switching to the |
| 4006 |
|
respectively defined engine type and loading the respective |
| 4007 |
|
instrument. See command |
| 4008 |
|
<xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref> |
| 4009 |
|
for how to assign a MIDI instrument map to a sampler channel.</t> |
| 4010 |
|
<t>Also note per MIDI specification a bank select message does not |
| 4011 |
|
cause to switch to another instrument. Instead when receiving a |
| 4012 |
|
bank select message the bank value will be stored and a subsequent |
| 4013 |
|
program change message (which may occur at any time) will finally |
| 4014 |
|
cause the sampler to switch to the respective instrument as |
| 4015 |
|
reflected by the current MIDI instrument map.</t> |
| 4016 |
|
|
| 4017 |
|
<section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT MAP"> |
| 4018 |
|
<t>The front-end can add a new MIDI instrument map by sending |
| 4019 |
|
the following command:</t> |
| 4020 |
|
<t> |
| 4021 |
|
<list> |
| 4022 |
|
<t>ADD MIDI_INSTRUMENT_MAP [<name>]</t> |
| 4023 |
|
</list> |
| 4024 |
|
</t> |
| 4025 |
|
<t>Where <name> is an optional argument allowing to |
| 4026 |
|
assign a custom name to the new map. MIDI instrument Map |
| 4027 |
|
names do not have to be unique.</t> |
| 4028 |
|
|
| 4029 |
|
<t>Possible Answers:</t> |
| 4030 |
|
<t> |
| 4031 |
|
<list> |
| 4032 |
|
<t>"OK[<map>]" - |
| 4033 |
|
<list> |
| 4034 |
|
<t>in case a new MIDI instrument map could |
| 4035 |
|
be added, where <map> reflects the |
| 4036 |
|
unique ID of the newly created MIDI |
| 4037 |
|
instrument map</t> |
| 4038 |
|
</list> |
| 4039 |
|
</t> |
| 4040 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 4041 |
|
<list> |
| 4042 |
|
<t>when a new map could not be created, which |
| 4043 |
|
might never occur in practice</t> |
| 4044 |
|
</list> |
| 4045 |
|
</t> |
| 4046 |
|
</list> |
| 4047 |
|
</t> |
| 4048 |
|
|
| 4049 |
|
<t>Examples:</t> |
| 4050 |
|
<t> |
| 4051 |
|
<list> |
| 4052 |
|
<t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"</t> |
| 4053 |
|
<t>S: "OK[0]"</t> |
| 4054 |
|
</list> |
| 4055 |
|
</t> |
| 4056 |
|
<t> |
| 4057 |
|
<list> |
| 4058 |
|
<t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"</t> |
| 4059 |
|
<t>S: "OK[1]"</t> |
| 4060 |
|
</list> |
| 4061 |
|
</t> |
| 4062 |
|
<t> |
| 4063 |
|
<list> |
| 4064 |
|
<t>C: "ADD MIDI_INSTRUMENT_MAP"</t> |
| 4065 |
|
<t>S: "OK[5]"</t> |
| 4066 |
|
</list> |
| 4067 |
|
</t> |
| 4068 |
|
</section> |
| 4069 |
|
|
| 4070 |
|
<section title="Delete one particular or all MIDI instrument maps" anchor="REMOVE MIDI_INSTRUMENT_MAP"> |
| 4071 |
|
<t>The front-end can delete a particular MIDI instrument map |
| 4072 |
|
by sending the following command:</t> |
| 4073 |
|
<t> |
| 4074 |
|
<list> |
| 4075 |
|
<t>REMOVE MIDI_INSTRUMENT_MAP <map></t> |
| 4076 |
|
</list> |
| 4077 |
|
</t> |
| 4078 |
|
<t>Where <map> reflects the unique ID of the map to delete |
| 4079 |
|
as returned by the <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref> |
| 4080 |
|
command.</t> |
| 4081 |
|
<t>The front-end can delete all MIDI instrument maps by |
| 4082 |
|
sending the following command:</t> |
| 4083 |
|
<t> |
| 4084 |
|
<list> |
| 4085 |
|
<t>REMOVE MIDI_INSTRUMENT_MAP ALL</t> |
| 4086 |
|
</list> |
| 4087 |
|
</t> |
| 4088 |
|
|
| 4089 |
|
<t>Possible Answers:</t> |
| 4090 |
|
<t> |
| 4091 |
|
<list> |
| 4092 |
|
<t>"OK" - |
| 4093 |
|
<list> |
| 4094 |
|
<t>in case the map(s) could be deleted</t> |
| 4095 |
|
</list> |
| 4096 |
|
</t> |
| 4097 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 4098 |
|
<list> |
| 4099 |
|
<t>when the given map does not exist</t> |
| 4100 |
|
</list> |
| 4101 |
|
</t> |
| 4102 |
|
</list> |
| 4103 |
|
</t> |
| 4104 |
|
|
| 4105 |
|
<t>Examples:</t> |
| 4106 |
|
<t> |
| 4107 |
|
<list> |
| 4108 |
|
<t>C: "REMOVE MIDI_INSTRUMENT_MAP 0"</t> |
| 4109 |
|
<t>S: "OK"</t> |
| 4110 |
|
</list> |
| 4111 |
|
</t> |
| 4112 |
|
<t> |
| 4113 |
|
<list> |
| 4114 |
|
<t>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"</t> |
| 4115 |
|
<t>S: "OK"</t> |
| 4116 |
|
</list> |
| 4117 |
|
</t> |
| 4118 |
|
</section> |
| 4119 |
|
|
| 4120 |
|
<section title="Get amount of existing MIDI instrument maps" anchor="GET MIDI_INSTRUMENT_MAPS"> |
| 4121 |
|
<t>The front-end can retrieve the current amount of MIDI |
| 4122 |
|
instrument maps by sending the following command:</t> |
| 4123 |
|
<t> |
| 4124 |
|
<list> |
| 4125 |
|
<t>GET MIDI_INSTRUMENT_MAPS</t> |
| 4126 |
|
</list> |
| 4127 |
|
</t> |
| 4128 |
|
|
| 4129 |
|
<t>Possible Answers:</t> |
| 4130 |
|
<t> |
| 4131 |
|
<list> |
| 4132 |
|
<t>The sampler will answer by returning the current |
| 4133 |
|
number of MIDI instrument maps.</t> |
| 4134 |
|
</list> |
| 4135 |
|
</t> |
| 4136 |
|
|
| 4137 |
|
<t>Example:</t> |
| 4138 |
|
<t> |
| 4139 |
|
<list> |
| 4140 |
|
<t>C: "GET MIDI_INSTRUMENT_MAPS"</t> |
| 4141 |
|
<t>S: "2"</t> |
| 4142 |
|
</list> |
| 4143 |
|
</t> |
| 4144 |
|
</section> |
| 4145 |
|
|
| 4146 |
|
<section title="Getting all created MIDI instrument maps" anchor="LIST MIDI_INSTRUMENT_MAPS"> |
| 4147 |
|
<t>The number of MIDI instrument maps can change on runtime. To get the |
| 4148 |
|
current list of MIDI instrument maps, the front-end can send the |
| 4149 |
|
following command:</t> |
| 4150 |
|
<t> |
| 4151 |
|
<list> |
| 4152 |
|
<t>LIST MIDI_INSTRUMENT_MAPS</t> |
| 4153 |
|
</list> |
| 4154 |
|
</t> |
| 4155 |
|
<t>Possible Answers:</t> |
| 4156 |
|
<t> |
| 4157 |
|
<list> |
| 4158 |
|
<t>The sampler will answer by returning a comma separated list |
| 4159 |
|
with all MIDI instrument maps' numerical IDs.</t> |
| 4160 |
|
</list> |
| 4161 |
|
</t> |
| 4162 |
|
<t>Example:</t> |
| 4163 |
|
<t> |
| 4164 |
|
<list> |
| 4165 |
|
<t>C: "LIST MIDI_INSTRUMENT_MAPS"</t> |
| 4166 |
|
<t>S: "0,1,5,12"</t> |
| 4167 |
|
</list> |
| 4168 |
|
</t> |
| 4169 |
|
</section> |
| 4170 |
|
|
| 4171 |
|
<section title="Getting MIDI instrument map information" anchor="GET MIDI_INSTRUMENT_MAP INFO"> |
| 4172 |
|
<t>The front-end can ask for the current settings of a MIDI |
| 4173 |
|
instrument map by sending the following command:</t> |
| 4174 |
|
<t> |
| 4175 |
|
<list> |
| 4176 |
|
<t>GET MIDI_INSTRUMENT_MAP INFO <map></t> |
| 4177 |
|
</list> |
| 4178 |
|
</t> |
| 4179 |
|
<t>Where <map> is the numerical ID of the map the |
| 4180 |
|
front-end is interested in as returned by the |
| 4181 |
|
<xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref> |
| 4182 |
|
command.</t> |
| 4183 |
|
|
| 4184 |
|
<t>Possible Answers:</t> |
| 4185 |
|
<t> |
| 4186 |
|
<list> |
| 4187 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
| 4188 |
|
Each answer line begins with the settings category name |
| 4189 |
|
followed by a colon and then a space character <SP> and finally |
| 4190 |
|
the info character string to that setting category. At the |
| 4191 |
|
moment the following categories are defined:</t> |
| 4192 |
|
|
| 4193 |
|
<t> |
| 4194 |
|
<list> |
| 4195 |
|
<t>NAME - |
| 4196 |
|
<list> |
| 4197 |
|
<t>custom name of the given map, |
| 4198 |
|
which does not have to be unique</t> |
| 4199 |
|
</list> |
| 4200 |
|
</t> |
| 4201 |
|
</list> |
| 4202 |
|
</t> |
| 4203 |
|
</list> |
| 4204 |
|
</t> |
| 4205 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
| 4206 |
|
|
| 4207 |
|
<t>Example:</t> |
| 4208 |
|
<t> |
| 4209 |
|
<list> |
| 4210 |
|
<t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t> |
| 4211 |
|
<t>S: "NAME: Standard Map"</t> |
| 4212 |
|
<t> "."</t> |
| 4213 |
|
</list> |
| 4214 |
|
</t> |
| 4215 |
|
</section> |
| 4216 |
|
|
| 4217 |
|
<section title="Renaming a MIDI instrument map" anchor="SET MIDI_INSTRUMENT_MAP NAME"> |
| 4218 |
|
<t>The front-end can alter the custom name of a MIDI |
| 4219 |
|
instrument map by sending the following command:</t> |
| 4220 |
|
<t> |
| 4221 |
|
<list> |
| 4222 |
|
<t>SET MIDI_INSTRUMENT_MAP NAME <map> <name></t> |
| 4223 |
|
</list> |
| 4224 |
|
</t> |
| 4225 |
|
<t>Where <map> is the numerical ID of the map and |
| 4226 |
|
<name> the new custom name of the map, which does not |
| 4227 |
|
have to be unique.</t> |
| 4228 |
|
|
| 4229 |
|
<t>Possible Answers:</t> |
| 4230 |
|
<t> |
| 4231 |
|
<list> |
| 4232 |
|
<t>"OK" - |
| 4233 |
|
<list> |
| 4234 |
|
<t>on success</t> |
| 4235 |
|
</list> |
| 4236 |
|
</t> |
| 4237 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 4238 |
|
<list> |
| 4239 |
|
<t>in case the given map does not exist</t> |
| 4240 |
|
</list> |
| 4241 |
|
</t> |
| 4242 |
|
</list> |
| 4243 |
|
</t> |
| 4244 |
|
|
| 4245 |
|
<t>Example:</t> |
| 4246 |
|
<t> |
| 4247 |
|
<list> |
| 4248 |
|
<t>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"</t> |
| 4249 |
|
<t>S: "OK"</t> |
| 4250 |
|
</list> |
| 4251 |
|
</t> |
| 4252 |
|
</section> |
| 4253 |
|
|
| 4254 |
|
<section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT"> |
| 4255 |
|
<t>The front-end can create a new or replace an existing entry |
| 4256 |
|
in a sampler's MIDI instrument map by sending the following |
| 4257 |
|
command:</t> |
| 4258 |
|
<t> |
| 4259 |
|
<list> |
| 4260 |
|
<t>MAP MIDI_INSTRUMENT [NON_MODAL] <map> |
| 4261 |
|
<midi_bank> <midi_prog> <engine_name> |
| 4262 |
|
<filename> <instrument_index> <volume_value> |
| 4263 |
|
[<instr_load_mode>] [<name>]</t> |
| 4264 |
|
</list> |
| 4265 |
|
</t> |
| 4266 |
|
<t>Where <map> is the numeric ID of the map to alter, |
| 4267 |
|
<midi_bank> is an integer value between |
| 4268 |
|
0..16383 reflecting the MIDI bank select index, |
| 4269 |
|
<midi_prog> an |
| 4270 |
|
integer value between 0..127 reflecting the MIDI program change |
| 4271 |
|
index, <engine_name> a sampler engine name as returned by |
| 4272 |
|
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
| 4273 |
|
command (not encapsulated into apostrophes), <filename> the name |
| 4274 |
|
of the instrument's file to be deployed (encapsulated into apostrophes), |
| 4275 |
|
<instrument_index> the index (integer value) of the instrument |
| 4276 |
|
within the given file, <volume_value> reflects the master |
| 4277 |
|
volume of the instrument as optionally dotted number (where a |
| 4278 |
|
value < 1.0 means attenuation and a value > 1.0 means |
| 4279 |
|
amplification). This parameter easily allows to adjust the |
| 4280 |
|
volume of all intruments within a custom instrument map |
| 4281 |
|
without having to adjust their instrument files. The |
| 4282 |
|
OPTIONAL <instr_load_mode> argument defines the life |
| 4283 |
|
time of the instrument, that is when the instrument should |
| 4284 |
|
be loaded, when freed and has exactly the following |
| 4285 |
|
possibilities:</t> |
| 4286 |
|
<t> |
| 4287 |
|
<list> |
| 4288 |
|
<t>"ON_DEMAND" - |
| 4289 |
|
<list> |
| 4290 |
|
<t>The instrument will be loaded when needed, |
| 4291 |
|
that is when demanded by at least one sampler |
| 4292 |
|
channel. It will immediately be freed from memory |
| 4293 |
|
when not needed by any sampler channel anymore.</t> |
| 4294 |
|
</list> |
| 4295 |
|
</t> |
| 4296 |
|
<t>"ON_DEMAND_HOLD" - |
| 4297 |
|
<list> |
| 4298 |
|
<t>The instrument will be loaded when needed, |
| 4299 |
|
that is when demanded by at least one sampler |
| 4300 |
|
channel. It will be kept in memory even when |
| 4301 |
|
not needed by any sampler channel anymore. |
| 4302 |
|
Instruments with this mode are only freed |
| 4303 |
|
when the sampler is reset or all mapping |
| 4304 |
|
entries with this mode (and respective |
| 4305 |
|
instrument) are explicitly changed to |
| 4306 |
|
"ON_DEMAND" and no sampler channel is using |
| 4307 |
|
the instrument anymore.</t> |
| 4308 |
|
</list> |
| 4309 |
|
</t> |
| 4310 |
|
<t>"PERSISTENT" - |
| 4311 |
|
<list> |
| 4312 |
|
<t>The instrument will immediately be loaded |
| 4313 |
|
into memory when this mapping |
| 4314 |
|
command is sent and the instrument is kept all |
| 4315 |
|
the time. Instruments with this mode are |
| 4316 |
|
only freed when the sampler is reset or all |
| 4317 |
|
mapping entries with this mode (and |
| 4318 |
|
respective instrument) are explicitly |
| 4319 |
|
changed to "ON_DEMAND" and no sampler |
| 4320 |
|
channel is using the instrument anymore.</t> |
| 4321 |
|
</list> |
| 4322 |
|
</t> |
| 4323 |
|
<t>not supplied - |
| 4324 |
|
<list> |
| 4325 |
|
<t>In case there is no <instr_load_mode> |
| 4326 |
|
argument given, it will be up to the |
| 4327 |
|
InstrumentManager to decide which mode to use. |
| 4328 |
|
Usually it will use "ON_DEMAND" if an entry |
| 4329 |
|
for the given instrument does not exist in |
| 4330 |
|
the InstrumentManager's list yet, otherwise |
| 4331 |
|
if an entry already exists, it will simply |
| 4332 |
|
stick with the mode currently reflected by |
| 4333 |
|
the already existing entry, that is it will |
| 4334 |
|
not change the mode.</t> |
| 4335 |
|
</list> |
| 4336 |
|
</t> |
| 4337 |
|
</list> |
| 4338 |
|
</t> |
| 4339 |
|
<t> |
| 4340 |
|
The <instr_load_mode> argument thus allows to define an |
| 4341 |
|
appropriate strategy (low memory consumption vs. fast |
| 4342 |
|
instrument switching) for each instrument individually. Note, the |
| 4343 |
|
following restrictions apply to this argument: "ON_DEMAND_HOLD" and |
| 4344 |
|
"PERSISTENT" have to be supported by the respective sampler engine |
| 4345 |
|
(which is technically the case when the engine provides an |
| 4346 |
|
InstrumentManager for its format). If this is not the case the |
| 4347 |
|
argument will automatically fall back to the default value |
| 4348 |
|
"ON_DEMAND". Also the load mode of one instrument may |
| 4349 |
|
automatically change the laod mode of other instrument(s), i.e. |
| 4350 |
|
because the instruments are part of the same file and the |
| 4351 |
|
engine does not allow a way to manage load modes for them |
| 4352 |
|
individually. Due to this, in case the frontend shows the |
| 4353 |
|
load modes of entries, the frontend should retrieve the actual |
| 4354 |
|
mode by i.e. sending |
| 4355 |
|
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
| 4356 |
|
command(s). Finally the OPTIONAL <name> argument allows to |
| 4357 |
|
set a custom name (encapsulated into apostrophes) for the mapping |
| 4358 |
|
entry, useful for frontends for displaying an appropriate name for |
| 4359 |
|
mapped instruments (using |
| 4360 |
|
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
| 4361 |
|
</t> |
| 4362 |
|
<t> |
| 4363 |
|
By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is |
| 4364 |
|
completely established in the sampler. The OPTIONAL "NON_MODAL" argument |
| 4365 |
|
however causes the respective "MAP MIDI_INSTRUMENT" command to return |
| 4366 |
|
immediately, that is to let the sampler establish the mapping in the |
| 4367 |
|
background. So this argument might be especially useful for mappings with |
| 4368 |
|
a "PERSISTENT" type, because these have to load the respective instruments |
| 4369 |
|
immediately and might thus block for a very long time. It is recommended |
| 4370 |
|
however to use the OPTIONAL "NON_MODAL" argument only if really necessary, |
| 4371 |
|
because it has the following drawbacks: as "NON_MODAL" instructions return |
| 4372 |
|
immediately, they may not necessarily return an error i.e. when the given |
| 4373 |
|
instrument file turns out to be corrupt, beside that subsequent commands |
| 4374 |
|
in a LSCP instruction sequence might fail, because mandatory mappings are |
| 4375 |
|
not yet completed. |
| 4376 |
|
</t> |
| 4377 |
|
|
| 4378 |
|
<t>Possible Answers:</t> |
| 4379 |
|
<t> |
| 4380 |
|
<list> |
| 4381 |
|
<t>"OK" - |
| 4382 |
|
<list> |
| 4383 |
|
<t>usually</t> |
| 4384 |
|
</list> |
| 4385 |
|
</t> |
| 4386 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 4387 |
|
<list> |
| 4388 |
|
<t>when the given map or engine does not exist or a value |
| 4389 |
|
is out of range</t> |
| 4390 |
|
</list> |
| 4391 |
|
</t> |
| 4392 |
|
</list> |
| 4393 |
|
</t> |
| 4394 |
|
|
| 4395 |
|
<t>Examples:</t> |
| 4396 |
|
<t> |
| 4397 |
|
<list> |
| 4398 |
|
<t>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"</t> |
| 4399 |
|
<t>S: "OK"</t> |
| 4400 |
|
</list> |
| 4401 |
|
</t> |
| 4402 |
|
<t> |
| 4403 |
|
<list> |
| 4404 |
|
<t>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"</t> |
| 4405 |
|
<t>S: "OK"</t> |
| 4406 |
|
</list> |
| 4407 |
|
</t> |
| 4408 |
|
<t> |
| 4409 |
|
<list> |
| 4410 |
|
<t>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"</t> |
| 4411 |
|
<t>S: "OK"</t> |
| 4412 |
|
<t>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"</t> |
| 4413 |
|
<t>S: "OK"</t> |
| 4414 |
|
</list> |
| 4415 |
|
</t> |
| 4416 |
|
<t> |
| 4417 |
|
<list> |
| 4418 |
|
<t>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t> |
| 4419 |
|
<t>S: "OK"</t> |
| 4420 |
|
</list> |
| 4421 |
|
</t> |
| 4422 |
|
</section> |
| 4423 |
|
|
| 4424 |
|
<section title="Getting ammount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS"> |
| 4425 |
|
<t>The front-end can query the amount of currently existing |
| 4426 |
|
entries in a MIDI instrument map by sending the following |
| 4427 |
|
command:</t> |
| 4428 |
|
<t> |
| 4429 |
|
<list> |
| 4430 |
|
<t>GET MIDI_INSTRUMENTS <map></t> |
| 4431 |
|
</list> |
| 4432 |
|
</t> |
| 4433 |
|
<t>The front-end can query the amount of currently existing |
| 4434 |
|
entries in all MIDI instrument maps by sending the following |
| 4435 |
|
command:</t> |
| 4436 |
|
<t> |
| 4437 |
|
<list> |
| 4438 |
|
<t>GET MIDI_INSTRUMENTS ALL</t> |
| 4439 |
|
</list> |
| 4440 |
|
</t> |
| 4441 |
|
<t>Possible Answers:</t> |
| 4442 |
|
<t> |
| 4443 |
|
<list> |
| 4444 |
|
<t>The sampler will answer by sending the current number of |
| 4445 |
|
entries in the MIDI instrument map(s).</t> |
| 4446 |
|
</list> |
| 4447 |
|
</t> |
| 4448 |
|
|
| 4449 |
|
<t>Example:</t> |
| 4450 |
|
<t> |
| 4451 |
|
<list> |
| 4452 |
|
<t>C: "GET MIDI_INSTRUMENTS 0"</t> |
| 4453 |
|
<t>S: "234"</t> |
| 4454 |
|
</list> |
| 4455 |
|
</t> |
| 4456 |
|
<t> |
| 4457 |
|
<list> |
| 4458 |
|
<t>C: "GET MIDI_INSTRUMENTS ALL"</t> |
| 4459 |
|
<t>S: "954"</t> |
| 4460 |
|
</list> |
| 4461 |
|
</t> |
| 4462 |
|
</section> |
| 4463 |
|
|
| 4464 |
|
<section title="Getting indeces of all entries of a MIDI instrument map" anchor="LIST MIDI_INSTRUMENTS"> |
| 4465 |
|
<t>The front-end can query a list of all currently existing |
| 4466 |
|
entries in a certain MIDI instrument map by sending the following |
| 4467 |
|
command:</t> |
| 4468 |
|
<t> |
| 4469 |
|
<list> |
| 4470 |
|
<t>LIST MIDI_INSTRUMENTS <map></t> |
| 4471 |
|
</list> |
| 4472 |
|
</t> |
| 4473 |
|
<t>Where <map> is the numeric ID of the MIDI instrument map.</t> |
| 4474 |
|
<t>The front-end can query a list of all currently existing |
| 4475 |
|
entries of all MIDI instrument maps by sending the following |
| 4476 |
|
command:</t> |
| 4477 |
|
<t> |
| 4478 |
|
<list> |
| 4479 |
|
<t>LIST MIDI_INSTRUMENTS ALL</t> |
| 4480 |
|
</list> |
| 4481 |
|
</t> |
| 4482 |
|
|
| 4483 |
|
<t>Possible Answers:</t> |
| 4484 |
|
<t> |
| 4485 |
|
<list> |
| 4486 |
|
<t>The sampler will answer by sending a comma separated |
| 4487 |
|
list of map ID - MIDI bank - MIDI program triples, where |
| 4488 |
|
each triple is encapsulated into curly braces. The |
| 4489 |
|
list is returned in one single line. Each triple |
| 4490 |
|
just reflects the key of the respective map entry, |
| 4491 |
|
thus subsequent |
| 4492 |
|
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
| 4493 |
|
command(s) are necessary to retrieve detailed informations |
| 4494 |
|
about each entry.</t> |
| 4495 |
|
</list> |
| 4496 |
|
</t> |
| 4497 |
|
|
| 4498 |
|
<t>Example:</t> |
| 4499 |
|
<t> |
| 4500 |
|
<list> |
| 4501 |
|
<t>C: "LIST MIDI_INSTRUMENTS 0"</t> |
| 4502 |
|
<t>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"</t> |
| 4503 |
|
</list> |
| 4504 |
|
</t> |
| 4505 |
|
</section> |
| 4506 |
|
|
| 4507 |
|
<section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT"> |
| 4508 |
|
<t>The front-end can delete an entry from a MIDI instrument |
| 4509 |
|
map by sending the following command:</t> |
| 4510 |
|
<t> |
| 4511 |
|
<list> |
| 4512 |
|
<t>UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog></t> |
| 4513 |
|
</list> |
| 4514 |
|
</t> |
| 4515 |
|
<t> |
| 4516 |
|
Where <map> is the numeric ID of the MIDI instrument map, |
| 4517 |
|
<midi_bank> is an integer value between 0..16383 |
| 4518 |
|
reflecting the MIDI bank value and |
| 4519 |
|
<midi_prog> an integer value between |
| 4520 |
|
0..127 reflecting the MIDI program value of the map's entrie's key |
| 4521 |
|
index triple. |
| 4522 |
|
</t> |
| 4523 |
|
|
| 4524 |
|
<t>Possible Answers:</t> |
| 4525 |
|
<t> |
| 4526 |
|
<list> |
| 4527 |
|
<t>"OK" - |
| 4528 |
|
<list> |
| 4529 |
|
<t>usually</t> |
| 4530 |
|
</list> |
| 4531 |
|
</t> |
| 4532 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 4533 |
|
<list> |
| 4534 |
|
<t>when index out of bounds</t> |
| 4535 |
|
</list> |
| 4536 |
|
</t> |
| 4537 |
|
</list> |
| 4538 |
|
</t> |
| 4539 |
|
|
| 4540 |
|
<t>Example:</t> |
| 4541 |
|
<t> |
| 4542 |
|
<list> |
| 4543 |
|
<t>C: "UNMAP MIDI_INSTRUMENT 0 2 127"</t> |
| 4544 |
|
<t>S: "OK"</t> |
| 4545 |
|
</list> |
| 4546 |
|
</t> |
| 4547 |
|
</section> |
| 4548 |
|
|
| 4549 |
|
<section title="Get current settings of MIDI instrument map entry" anchor="GET MIDI_INSTRUMENT INFO"> |
| 4550 |
|
<t>The front-end can retrieve the current settings of a certain |
| 4551 |
|
instrument map entry by sending the following command:</t> |
| 4552 |
|
<t> |
| 4553 |
|
<list> |
| 4554 |
|
<t>GET MIDI_INSTRUMENT INFO <map> <midi_bank> <midi_prog></t> |
| 4555 |
|
</list> |
| 4556 |
|
</t> |
| 4557 |
|
<t> |
| 4558 |
|
Where <map> is the numeric ID of the MIDI instrument map, |
| 4559 |
|
<midi_bank> is an integer value between 0..16383 |
| 4560 |
|
reflecting the MIDI bank value, <midi_bank> |
| 4561 |
|
and <midi_prog> an integer value between |
| 4562 |
|
0..127 reflecting the MIDI program value of the map's entrie's key |
| 4563 |
|
index triple. |
| 4564 |
|
</t> |
| 4565 |
|
|
| 4566 |
|
<t>Possible Answers:</t> |
| 4567 |
|
<t> |
| 4568 |
|
<list> |
| 4569 |
|
<t>LinuxSampler will answer by sending a <CRLF> |
| 4570 |
|
separated list. Each answer line begins with the |
| 4571 |
|
information category name followed by a colon and then |
| 4572 |
|
a space character <SP> and finally the info |
| 4573 |
|
character string to that info category. At the moment |
| 4574 |
|
the following categories are defined:</t> |
| 4575 |
|
<t>"NAME" - |
| 4576 |
|
<list> |
| 4577 |
|
<t>Name for this MIDI instrument map entry (if defined). |
| 4578 |
|
This name shall be used by frontends for displaying a |
| 4579 |
|
name for this mapped instrument. It can be set and |
| 4580 |
|
changed with the |
| 4581 |
|
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
| 4582 |
|
command and does not have to be unique.</t> |
| 4583 |
|
</list> |
| 4584 |
|
</t> |
| 4585 |
|
<t>"ENGINE_NAME" - |
| 4586 |
|
<list> |
| 4587 |
|
<t>Name of the engine to be deployed for this |
| 4588 |
|
instrument.</t> |
| 4589 |
|
</list> |
| 4590 |
|
</t> |
| 4591 |
|
<t>"INSTRUMENT_FILE" - |
| 4592 |
|
<list> |
| 4593 |
|
<t>File name of the instrument.</t> |
| 4594 |
|
</list> |
| 4595 |
|
</t> |
| 4596 |
|
<t>"INSTRUMENT_NR" - |
| 4597 |
|
<list> |
| 4598 |
|
<t>Index of the instrument within the file.</t> |
| 4599 |
|
</list> |
| 4600 |
|
</t> |
| 4601 |
|
<t>"INSTRUMENT_NAME" - |
| 4602 |
|
<list> |
| 4603 |
|
<t>Name of the loaded instrument as reflected by its file. |
| 4604 |
|
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
| 4605 |
|
cannot be changed.</t> |
| 4606 |
|
</list> |
| 4607 |
|
</t> |
| 4608 |
|
<t>"LOAD_MODE" - |
| 4609 |
|
<list> |
| 4610 |
|
<t>Life time of instrument |
| 4611 |
|
(see <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> for details about this setting).</t> |
| 4612 |
|
</list> |
| 4613 |
|
</t> |
| 4614 |
|
<t>"VOLUME" - |
| 4615 |
|
<list> |
| 4616 |
|
<t>master volume of the instrument as optionally |
| 4617 |
|
dotted number (where a value < 1.0 means attenuation |
| 4618 |
|
and a value > 1.0 means amplification)</t> |
| 4619 |
|
</list> |
| 4620 |
|
</t> |
| 4621 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
| 4622 |
|
</list> |
| 4623 |
|
</t> |
| 4624 |
|
|
| 4625 |
|
<t>Example:</t> |
| 4626 |
|
<t> |
| 4627 |
|
<list> |
| 4628 |
|
<t>C: "GET MIDI_INSTRUMENT INFO 1 45 120"</t> |
| 4629 |
|
<t>S: "NAME: Drums for Foo Song"</t> |
| 4630 |
|
<t> "ENGINE_NAME: GigEngine"</t> |
| 4631 |
|
<t> "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t> |
| 4632 |
|
<t> "INSTRUMENT_NR: 0"</t> |
| 4633 |
|
<t> "INSTRUMENT_NAME: Joe's Drumkit"</t> |
| 4634 |
|
<t> "LOAD_MODE: PERSISTENT"</t> |
| 4635 |
|
<t> "VOLUME: 1.0"</t> |
| 4636 |
|
<t> "."</t> |
| 4637 |
|
</list> |
| 4638 |
|
</t> |
| 4639 |
|
</section> |
| 4640 |
|
|
| 4641 |
|
<section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS"> |
| 4642 |
|
<t>The front-end can clear a whole MIDI instrument map, that |
| 4643 |
|
is delete all its entries by sending the following command:</t> |
| 4644 |
|
<t> |
| 4645 |
|
<list> |
| 4646 |
|
<t>CLEAR MIDI_INSTRUMENTS <map></t> |
| 4647 |
|
</list> |
| 4648 |
|
</t> |
| 4649 |
|
<t>Where <map> is the numeric ID of the map to clear.</t> |
| 4650 |
|
<t>The front-end can clear all MIDI instrument maps, that |
| 4651 |
|
is delete all entries of all maps by sending the following |
| 4652 |
|
command:</t> |
| 4653 |
|
<t> |
| 4654 |
|
<list> |
| 4655 |
|
<t>CLEAR MIDI_INSTRUMENTS ALL</t> |
| 4656 |
|
</list> |
| 4657 |
|
</t> |
| 4658 |
|
<t>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the |
| 4659 |
|
maps, only their entries, thus the map's settings like |
| 4660 |
|
custom name will be preservevd.</t> |
| 4661 |
|
|
| 4662 |
|
<t>Possible Answers:</t> |
| 4663 |
|
<t> |
| 4664 |
|
<list> |
| 4665 |
|
<t>"OK" - |
| 4666 |
|
<list> |
| 4667 |
|
<t>always</t> |
| 4668 |
|
</list> |
| 4669 |
|
</t> |
| 4670 |
|
</list> |
| 4671 |
|
</t> |
| 4672 |
|
|
| 4673 |
|
<t>Examples:</t> |
| 4674 |
|
<t> |
| 4675 |
|
<list> |
| 4676 |
|
<t>C: "CLEAR MIDI_INSTRUMENTS 0"</t> |
| 4677 |
|
<t>S: "OK"</t> |
| 4678 |
|
</list> |
| 4679 |
|
</t> |
| 4680 |
|
<t> |
| 4681 |
|
<list> |
| 4682 |
|
<t>C: "CLEAR MIDI_INSTRUMENTS ALL"</t> |
| 4683 |
|
<t>S: "OK"</t> |
| 4684 |
|
</list> |
| 4685 |
|
</t> |
| 4686 |
|
</section> |
| 4687 |
|
</section> |
| 4688 |
|
|
| 4689 |
</section> |
</section> |
| 4690 |
|
|
| 4691 |
<section title="Command Syntax"> |
|
| 4692 |
<t>TODO: will soon automatically included from src/network/lscp.y, |
<section title="Command Syntax" anchor="command_syntax"> |
| 4693 |
meanwhile have a look at that file to get the exact definition of |
<t>The grammar of the control protocol as descibed in <xref target="control_commands"/> |
| 4694 |
the command syntax.</t> |
is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>) |
| 4695 |
|
where applicable. |
| 4696 |
|
</t> |
| 4697 |
|
<!-- |
| 4698 |
|
This section is automatically generated by scripts/update_grammar.pl |
| 4699 |
|
from src/network/lscp.y (yacc input file). Do not modify this section |
| 4700 |
|
manually ! |
| 4701 |
|
--> |
| 4702 |
|
<!-- GRAMMAR_BNF_BEGIN - do NOT delete or modify this line !!! --> |
| 4703 |
|
|
| 4704 |
|
<t>input = |
| 4705 |
|
<list> |
| 4706 |
|
<t>line LF |
| 4707 |
|
</t> |
| 4708 |
|
<t>/ line CR LF |
| 4709 |
|
</t> |
| 4710 |
|
</list> |
| 4711 |
|
</t> |
| 4712 |
|
<t>line = |
| 4713 |
|
<list> |
| 4714 |
|
<t>/* epsilon (empty line ignored) */ |
| 4715 |
|
</t> |
| 4716 |
|
<t>/ comment |
| 4717 |
|
</t> |
| 4718 |
|
<t>/ command |
| 4719 |
|
</t> |
| 4720 |
|
<t>/ error |
| 4721 |
|
</t> |
| 4722 |
|
</list> |
| 4723 |
|
</t> |
| 4724 |
|
<t>comment = |
| 4725 |
|
<list> |
| 4726 |
|
<t>'#' |
| 4727 |
|
</t> |
| 4728 |
|
<t>/ comment '#' |
| 4729 |
|
</t> |
| 4730 |
|
<t>/ comment SP |
| 4731 |
|
</t> |
| 4732 |
|
<t>/ comment number |
| 4733 |
|
</t> |
| 4734 |
|
<t>/ comment string |
| 4735 |
|
</t> |
| 4736 |
|
</list> |
| 4737 |
|
</t> |
| 4738 |
|
<t>command = |
| 4739 |
|
<list> |
| 4740 |
|
<t>ADD SP add_instruction |
| 4741 |
|
</t> |
| 4742 |
|
<t>/ MAP SP map_instruction |
| 4743 |
|
</t> |
| 4744 |
|
<t>/ UNMAP SP unmap_instruction |
| 4745 |
|
</t> |
| 4746 |
|
<t>/ GET SP get_instruction |
| 4747 |
|
</t> |
| 4748 |
|
<t>/ CREATE SP create_instruction |
| 4749 |
|
</t> |
| 4750 |
|
<t>/ DESTROY SP destroy_instruction |
| 4751 |
|
</t> |
| 4752 |
|
<t>/ LIST SP list_instruction |
| 4753 |
|
</t> |
| 4754 |
|
<t>/ LOAD SP load_instruction |
| 4755 |
|
</t> |
| 4756 |
|
<t>/ REMOVE SP remove_instruction |
| 4757 |
|
</t> |
| 4758 |
|
<t>/ SET SP set_instruction |
| 4759 |
|
</t> |
| 4760 |
|
<t>/ SUBSCRIBE SP subscribe_event |
| 4761 |
|
</t> |
| 4762 |
|
<t>/ UNSUBSCRIBE SP unsubscribe_event |
| 4763 |
|
</t> |
| 4764 |
|
<t>/ SELECT SP text |
| 4765 |
|
</t> |
| 4766 |
|
<t>/ RESET SP reset_instruction |
| 4767 |
|
</t> |
| 4768 |
|
<t>/ CLEAR SP clear_instruction |
| 4769 |
|
</t> |
| 4770 |
|
<t>/ RESET |
| 4771 |
|
</t> |
| 4772 |
|
<t>/ QUIT |
| 4773 |
|
</t> |
| 4774 |
|
</list> |
| 4775 |
|
</t> |
| 4776 |
|
<t>add_instruction = |
| 4777 |
|
<list> |
| 4778 |
|
<t>CHANNEL |
| 4779 |
|
</t> |
| 4780 |
|
<t>/ MIDI_INSTRUMENT_MAP |
| 4781 |
|
</t> |
| 4782 |
|
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
| 4783 |
|
</t> |
| 4784 |
|
</list> |
| 4785 |
|
</t> |
| 4786 |
|
<t>subscribe_event = |
| 4787 |
|
<list> |
| 4788 |
|
<t>AUDIO_OUTPUT_DEVICE_COUNT |
| 4789 |
|
</t> |
| 4790 |
|
<t>/ AUDIO_OUTPUT_DEVICE_INFO |
| 4791 |
|
</t> |
| 4792 |
|
<t>/ MIDI_INPUT_DEVICE_COUNT |
| 4793 |
|
</t> |
| 4794 |
|
<t>/ MIDI_INPUT_DEVICE_INFO |
| 4795 |
|
</t> |
| 4796 |
|
<t>/ CHANNEL_COUNT |
| 4797 |
|
</t> |
| 4798 |
|
<t>/ VOICE_COUNT |
| 4799 |
|
</t> |
| 4800 |
|
<t>/ STREAM_COUNT |
| 4801 |
|
</t> |
| 4802 |
|
<t>/ BUFFER_FILL |
| 4803 |
|
</t> |
| 4804 |
|
<t>/ CHANNEL_INFO |
| 4805 |
|
</t> |
| 4806 |
|
<t>/ MIDI_INSTRUMENT_MAP_COUNT |
| 4807 |
|
</t> |
| 4808 |
|
<t>/ MIDI_INSTRUMENT_MAP_INFO |
| 4809 |
|
</t> |
| 4810 |
|
<t>/ MIDI_INSTRUMENT_COUNT |
| 4811 |
|
</t> |
| 4812 |
|
<t>/ MIDI_INSTRUMENT_INFO |
| 4813 |
|
</t> |
| 4814 |
|
<t>/ MISCELLANEOUS |
| 4815 |
|
</t> |
| 4816 |
|
<t>/ TOTAL_VOICE_COUNT |
| 4817 |
|
</t> |
| 4818 |
|
</list> |
| 4819 |
|
</t> |
| 4820 |
|
<t>unsubscribe_event = |
| 4821 |
|
<list> |
| 4822 |
|
<t>AUDIO_OUTPUT_DEVICE_COUNT |
| 4823 |
|
</t> |
| 4824 |
|
<t>/ AUDIO_OUTPUT_DEVICE_INFO |
| 4825 |
|
</t> |
| 4826 |
|
<t>/ MIDI_INPUT_DEVICE_COUNT |
| 4827 |
|
</t> |
| 4828 |
|
<t>/ MIDI_INPUT_DEVICE_INFO |
| 4829 |
|
</t> |
| 4830 |
|
<t>/ CHANNEL_COUNT |
| 4831 |
|
</t> |
| 4832 |
|
<t>/ VOICE_COUNT |
| 4833 |
|
</t> |
| 4834 |
|
<t>/ STREAM_COUNT |
| 4835 |
|
</t> |
| 4836 |
|
<t>/ BUFFER_FILL |
| 4837 |
|
</t> |
| 4838 |
|
<t>/ CHANNEL_INFO |
| 4839 |
|
</t> |
| 4840 |
|
<t>/ MIDI_INSTRUMENT_MAP_COUNT |
| 4841 |
|
</t> |
| 4842 |
|
<t>/ MIDI_INSTRUMENT_MAP_INFO |
| 4843 |
|
</t> |
| 4844 |
|
<t>/ MIDI_INSTRUMENT_COUNT |
| 4845 |
|
</t> |
| 4846 |
|
<t>/ MIDI_INSTRUMENT_INFO |
| 4847 |
|
</t> |
| 4848 |
|
<t>/ MISCELLANEOUS |
| 4849 |
|
</t> |
| 4850 |
|
<t>/ TOTAL_VOICE_COUNT |
| 4851 |
|
</t> |
| 4852 |
|
</list> |
| 4853 |
|
</t> |
| 4854 |
|
<t>map_instruction = |
| 4855 |
|
<list> |
| 4856 |
|
<t>MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value |
| 4857 |
|
</t> |
| 4858 |
|
<t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode |
| 4859 |
|
</t> |
| 4860 |
|
<t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name |
| 4861 |
|
</t> |
| 4862 |
|
<t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name |
| 4863 |
|
</t> |
| 4864 |
|
</list> |
| 4865 |
|
</t> |
| 4866 |
|
<t>unmap_instruction = |
| 4867 |
|
<list> |
| 4868 |
|
<t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog |
| 4869 |
|
</t> |
| 4870 |
|
</list> |
| 4871 |
|
</t> |
| 4872 |
|
<t>remove_instruction = |
| 4873 |
|
<list> |
| 4874 |
|
<t>CHANNEL SP sampler_channel |
| 4875 |
|
</t> |
| 4876 |
|
<t>/ MIDI_INSTRUMENT_MAP SP midi_map |
| 4877 |
|
</t> |
| 4878 |
|
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
| 4879 |
|
</t> |
| 4880 |
|
</list> |
| 4881 |
|
</t> |
| 4882 |
|
<t>get_instruction = |
| 4883 |
|
<list> |
| 4884 |
|
<t>AVAILABLE_ENGINES |
| 4885 |
|
</t> |
| 4886 |
|
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
| 4887 |
|
</t> |
| 4888 |
|
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
| 4889 |
|
</t> |
| 4890 |
|
<t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string |
| 4891 |
|
</t> |
| 4892 |
|
<t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list |
| 4893 |
|
</t> |
| 4894 |
|
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
| 4895 |
|
</t> |
| 4896 |
|
<t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string |
| 4897 |
|
</t> |
| 4898 |
|
<t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string |
| 4899 |
|
</t> |
| 4900 |
|
<t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list |
| 4901 |
|
</t> |
| 4902 |
|
<t>/ AUDIO_OUTPUT_DEVICES |
| 4903 |
|
</t> |
| 4904 |
|
<t>/ MIDI_INPUT_DEVICES |
| 4905 |
|
</t> |
| 4906 |
|
<t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number |
| 4907 |
|
</t> |
| 4908 |
|
<t>/ MIDI_INPUT_DEVICE SP INFO SP number |
| 4909 |
|
</t> |
| 4910 |
|
<t>/ MIDI_INPUT_PORT SP INFO SP number SP number |
| 4911 |
|
</t> |
| 4912 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string |
| 4913 |
|
</t> |
| 4914 |
|
<t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number |
| 4915 |
|
</t> |
| 4916 |
|
<t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string |
| 4917 |
|
</t> |
| 4918 |
|
<t>/ CHANNELS |
| 4919 |
|
</t> |
| 4920 |
|
<t>/ CHANNEL SP INFO SP sampler_channel |
| 4921 |
|
</t> |
| 4922 |
|
<t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel |
| 4923 |
|
</t> |
| 4924 |
|
<t>/ CHANNEL SP STREAM_COUNT SP sampler_channel |
| 4925 |
|
</t> |
| 4926 |
|
<t>/ CHANNEL SP VOICE_COUNT SP sampler_channel |
| 4927 |
|
</t> |
| 4928 |
|
<t>/ ENGINE SP INFO SP engine_name |
| 4929 |
|
</t> |
| 4930 |
|
<t>/ SERVER SP INFO |
| 4931 |
|
</t> |
| 4932 |
|
<t>/ TOTAL_VOICE_COUNT |
| 4933 |
|
</t> |
| 4934 |
|
<t>/ TOTAL_VOICE_COUNT_MAX |
| 4935 |
|
</t> |
| 4936 |
|
<t>/ MIDI_INSTRUMENTS SP midi_map |
| 4937 |
|
</t> |
| 4938 |
|
<t>/ MIDI_INSTRUMENTS SP ALL |
| 4939 |
|
</t> |
| 4940 |
|
<t>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog |
| 4941 |
|
</t> |
| 4942 |
|
<t>/ MIDI_INSTRUMENT_MAPS |
| 4943 |
|
</t> |
| 4944 |
|
<t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
| 4945 |
|
</t> |
| 4946 |
|
<t>/ FX_SENDS SP sampler_channel |
| 4947 |
|
</t> |
| 4948 |
|
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
| 4949 |
|
</t> |
| 4950 |
|
<t>/ VOLUME |
| 4951 |
|
</t> |
| 4952 |
|
</list> |
| 4953 |
|
</t> |
| 4954 |
|
<t>set_instruction = |
| 4955 |
|
<list> |
| 4956 |
|
<t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
| 4957 |
|
</t> |
| 4958 |
|
<t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list |
| 4959 |
|
</t> |
| 4960 |
|
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
| 4961 |
|
</t> |
| 4962 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
| 4963 |
|
</t> |
| 4964 |
|
<t>/ CHANNEL SP set_chan_instruction |
| 4965 |
|
</t> |
| 4966 |
|
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
| 4967 |
|
</t> |
| 4968 |
|
<t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index |
| 4969 |
|
</t> |
| 4970 |
|
<t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl |
| 4971 |
|
</t> |
| 4972 |
|
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
| 4973 |
|
</t> |
| 4974 |
|
<t>/ ECHO SP boolean |
| 4975 |
|
</t> |
| 4976 |
|
<t>/ VOLUME SP volume_value |
| 4977 |
|
</t> |
| 4978 |
|
</list> |
| 4979 |
|
</t> |
| 4980 |
|
<t>create_instruction = |
| 4981 |
|
<list> |
| 4982 |
|
<t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list |
| 4983 |
|
</t> |
| 4984 |
|
<t>/ AUDIO_OUTPUT_DEVICE SP string |
| 4985 |
|
</t> |
| 4986 |
|
<t>/ MIDI_INPUT_DEVICE SP string SP key_val_list |
| 4987 |
|
</t> |
| 4988 |
|
<t>/ MIDI_INPUT_DEVICE SP string |
| 4989 |
|
</t> |
| 4990 |
|
<t>/ FX_SEND SP sampler_channel SP midi_ctrl |
| 4991 |
|
</t> |
| 4992 |
|
<t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
| 4993 |
|
</t> |
| 4994 |
|
</list> |
| 4995 |
|
</t> |
| 4996 |
|
<t>reset_instruction = |
| 4997 |
|
<list> |
| 4998 |
|
<t>CHANNEL SP sampler_channel |
| 4999 |
|
</t> |
| 5000 |
|
</list> |
| 5001 |
|
</t> |
| 5002 |
|
<t>clear_instruction = |
| 5003 |
|
<list> |
| 5004 |
|
<t>MIDI_INSTRUMENTS SP midi_map |
| 5005 |
|
</t> |
| 5006 |
|
<t>/ MIDI_INSTRUMENTS SP ALL |
| 5007 |
|
</t> |
| 5008 |
|
</list> |
| 5009 |
|
</t> |
| 5010 |
|
<t>destroy_instruction = |
| 5011 |
|
<list> |
| 5012 |
|
<t>AUDIO_OUTPUT_DEVICE SP number |
| 5013 |
|
</t> |
| 5014 |
|
<t>/ MIDI_INPUT_DEVICE SP number |
| 5015 |
|
</t> |
| 5016 |
|
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
| 5017 |
|
</t> |
| 5018 |
|
</list> |
| 5019 |
|
</t> |
| 5020 |
|
<t>load_instruction = |
| 5021 |
|
<list> |
| 5022 |
|
<t>INSTRUMENT SP load_instr_args |
| 5023 |
|
</t> |
| 5024 |
|
<t>/ ENGINE SP load_engine_args |
| 5025 |
|
</t> |
| 5026 |
|
</list> |
| 5027 |
|
</t> |
| 5028 |
|
<t>set_chan_instruction = |
| 5029 |
|
<list> |
| 5030 |
|
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
| 5031 |
|
</t> |
| 5032 |
|
<t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index |
| 5033 |
|
</t> |
| 5034 |
|
<t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name |
| 5035 |
|
</t> |
| 5036 |
|
<t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index |
| 5037 |
|
</t> |
| 5038 |
|
<t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index |
| 5039 |
|
</t> |
| 5040 |
|
<t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index |
| 5041 |
|
</t> |
| 5042 |
|
<t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index |
| 5043 |
|
</t> |
| 5044 |
|
<t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name |
| 5045 |
|
</t> |
| 5046 |
|
<t>/ VOLUME SP sampler_channel SP volume_value |
| 5047 |
|
</t> |
| 5048 |
|
<t>/ MUTE SP sampler_channel SP boolean |
| 5049 |
|
</t> |
| 5050 |
|
<t>/ SOLO SP sampler_channel SP boolean |
| 5051 |
|
</t> |
| 5052 |
|
<t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map |
| 5053 |
|
</t> |
| 5054 |
|
<t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE |
| 5055 |
|
</t> |
| 5056 |
|
<t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT |
| 5057 |
|
</t> |
| 5058 |
|
</list> |
| 5059 |
|
</t> |
| 5060 |
|
<t>modal_arg = |
| 5061 |
|
<list> |
| 5062 |
|
<t>/* epsilon (empty argument) */ |
| 5063 |
|
</t> |
| 5064 |
|
<t>/ NON_MODAL SP |
| 5065 |
|
</t> |
| 5066 |
|
</list> |
| 5067 |
|
</t> |
| 5068 |
|
<t>key_val_list = |
| 5069 |
|
<list> |
| 5070 |
|
<t>string '=' param_val_list |
| 5071 |
|
</t> |
| 5072 |
|
<t>/ key_val_list SP string '=' param_val_list |
| 5073 |
|
</t> |
| 5074 |
|
</list> |
| 5075 |
|
</t> |
| 5076 |
|
<t>buffer_size_type = |
| 5077 |
|
<list> |
| 5078 |
|
<t>BYTES |
| 5079 |
|
</t> |
| 5080 |
|
<t>/ PERCENTAGE |
| 5081 |
|
</t> |
| 5082 |
|
</list> |
| 5083 |
|
</t> |
| 5084 |
|
<t>list_instruction = |
| 5085 |
|
<list> |
| 5086 |
|
<t>AUDIO_OUTPUT_DEVICES |
| 5087 |
|
</t> |
| 5088 |
|
<t>/ MIDI_INPUT_DEVICES |
| 5089 |
|
</t> |
| 5090 |
|
<t>/ CHANNELS |
| 5091 |
|
</t> |
| 5092 |
|
<t>/ AVAILABLE_ENGINES |
| 5093 |
|
</t> |
| 5094 |
|
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
| 5095 |
|
</t> |
| 5096 |
|
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
| 5097 |
|
</t> |
| 5098 |
|
<t>/ MIDI_INSTRUMENTS SP midi_map |
| 5099 |
|
</t> |
| 5100 |
|
<t>/ MIDI_INSTRUMENTS SP ALL |
| 5101 |
|
</t> |
| 5102 |
|
<t>/ MIDI_INSTRUMENT_MAPS |
| 5103 |
|
</t> |
| 5104 |
|
<t>/ FX_SENDS SP sampler_channel |
| 5105 |
|
</t> |
| 5106 |
|
</list> |
| 5107 |
|
</t> |
| 5108 |
|
<t>load_instr_args = |
| 5109 |
|
<list> |
| 5110 |
|
<t>filename SP instrument_index SP sampler_channel |
| 5111 |
|
</t> |
| 5112 |
|
<t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel |
| 5113 |
|
</t> |
| 5114 |
|
</list> |
| 5115 |
|
</t> |
| 5116 |
|
<t>load_engine_args = |
| 5117 |
|
<list> |
| 5118 |
|
<t>engine_name SP sampler_channel |
| 5119 |
|
</t> |
| 5120 |
|
</list> |
| 5121 |
|
</t> |
| 5122 |
|
<t>instr_load_mode = |
| 5123 |
|
<list> |
| 5124 |
|
<t>ON_DEMAND |
| 5125 |
|
</t> |
| 5126 |
|
<t>/ ON_DEMAND_HOLD |
| 5127 |
|
</t> |
| 5128 |
|
<t>/ PERSISTENT |
| 5129 |
|
</t> |
| 5130 |
|
</list> |
| 5131 |
|
</t> |
| 5132 |
|
<t>device_index = |
| 5133 |
|
<list> |
| 5134 |
|
<t>number |
| 5135 |
|
</t> |
| 5136 |
|
</list> |
| 5137 |
|
</t> |
| 5138 |
|
<t>audio_channel_index = |
| 5139 |
|
<list> |
| 5140 |
|
<t>number |
| 5141 |
|
</t> |
| 5142 |
|
</list> |
| 5143 |
|
</t> |
| 5144 |
|
<t>audio_output_type_name = |
| 5145 |
|
<list> |
| 5146 |
|
<t>string |
| 5147 |
|
</t> |
| 5148 |
|
</list> |
| 5149 |
|
</t> |
| 5150 |
|
<t>midi_input_port_index = |
| 5151 |
|
<list> |
| 5152 |
|
<t>number |
| 5153 |
|
</t> |
| 5154 |
|
</list> |
| 5155 |
|
</t> |
| 5156 |
|
<t>midi_input_channel_index = |
| 5157 |
|
<list> |
| 5158 |
|
<t>number |
| 5159 |
|
</t> |
| 5160 |
|
<t>/ ALL |
| 5161 |
|
</t> |
| 5162 |
|
</list> |
| 5163 |
|
</t> |
| 5164 |
|
<t>midi_input_type_name = |
| 5165 |
|
<list> |
| 5166 |
|
<t>string |
| 5167 |
|
</t> |
| 5168 |
|
</list> |
| 5169 |
|
</t> |
| 5170 |
|
<t>midi_map = |
| 5171 |
|
<list> |
| 5172 |
|
<t>number |
| 5173 |
|
</t> |
| 5174 |
|
</list> |
| 5175 |
|
</t> |
| 5176 |
|
<t>midi_bank = |
| 5177 |
|
<list> |
| 5178 |
|
<t>number |
| 5179 |
|
</t> |
| 5180 |
|
</list> |
| 5181 |
|
</t> |
| 5182 |
|
<t>midi_prog = |
| 5183 |
|
<list> |
| 5184 |
|
<t>number |
| 5185 |
|
</t> |
| 5186 |
|
</list> |
| 5187 |
|
</t> |
| 5188 |
|
<t>midi_ctrl = |
| 5189 |
|
<list> |
| 5190 |
|
<t>number |
| 5191 |
|
</t> |
| 5192 |
|
</list> |
| 5193 |
|
</t> |
| 5194 |
|
<t>volume_value = |
| 5195 |
|
<list> |
| 5196 |
|
<t>dotnum |
| 5197 |
|
</t> |
| 5198 |
|
<t>/ number |
| 5199 |
|
</t> |
| 5200 |
|
</list> |
| 5201 |
|
</t> |
| 5202 |
|
<t>sampler_channel = |
| 5203 |
|
<list> |
| 5204 |
|
<t>number |
| 5205 |
|
</t> |
| 5206 |
|
</list> |
| 5207 |
|
</t> |
| 5208 |
|
<t>instrument_index = |
| 5209 |
|
<list> |
| 5210 |
|
<t>number |
| 5211 |
|
</t> |
| 5212 |
|
</list> |
| 5213 |
|
</t> |
| 5214 |
|
<t>fx_send_id = |
| 5215 |
|
<list> |
| 5216 |
|
<t>number |
| 5217 |
|
</t> |
| 5218 |
|
</list> |
| 5219 |
|
</t> |
| 5220 |
|
<t>engine_name = |
| 5221 |
|
<list> |
| 5222 |
|
<t>string |
| 5223 |
|
</t> |
| 5224 |
|
</list> |
| 5225 |
|
</t> |
| 5226 |
|
<t>filename = |
| 5227 |
|
<list> |
| 5228 |
|
<t>stringval |
| 5229 |
|
</t> |
| 5230 |
|
</list> |
| 5231 |
|
</t> |
| 5232 |
|
<t>map_name = |
| 5233 |
|
<list> |
| 5234 |
|
<t>stringval |
| 5235 |
|
</t> |
| 5236 |
|
</list> |
| 5237 |
|
</t> |
| 5238 |
|
<t>entry_name = |
| 5239 |
|
<list> |
| 5240 |
|
<t>stringval |
| 5241 |
|
</t> |
| 5242 |
|
</list> |
| 5243 |
|
</t> |
| 5244 |
|
<t>fx_send_name = |
| 5245 |
|
<list> |
| 5246 |
|
<t>stringval |
| 5247 |
|
</t> |
| 5248 |
|
</list> |
| 5249 |
|
</t> |
| 5250 |
|
<t>param_val_list = |
| 5251 |
|
<list> |
| 5252 |
|
<t>param_val |
| 5253 |
|
</t> |
| 5254 |
|
<t>/ param_val_list','param_val |
| 5255 |
|
</t> |
| 5256 |
|
</list> |
| 5257 |
|
</t> |
| 5258 |
|
<t>param_val = |
| 5259 |
|
<list> |
| 5260 |
|
<t>string |
| 5261 |
|
</t> |
| 5262 |
|
<t>/ stringval |
| 5263 |
|
</t> |
| 5264 |
|
<t>/ number |
| 5265 |
|
</t> |
| 5266 |
|
<t>/ dotnum |
| 5267 |
|
</t> |
| 5268 |
|
</list> |
| 5269 |
|
</t> |
| 5270 |
|
|
| 5271 |
|
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
| 5272 |
</section> |
</section> |
| 5273 |
|
|
| 5274 |
<section title="Events"> |
<section title="Events" anchor="events"> |
| 5275 |
<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> |
| 5276 |
|
|
| 5277 |
<section title="Number of sampler channels changed"> |
<section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"> |
| 5278 |
|
<t>Client may want to be notified when the total number of audio output devices on the |
| 5279 |
|
back-end changes by issuing the following command:</t> |
| 5280 |
|
<t> |
| 5281 |
|
<list> |
| 5282 |
|
<t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t> |
| 5283 |
|
</list> |
| 5284 |
|
</t> |
| 5285 |
|
<t>Server will start sending the following notification messages:</t> |
| 5286 |
|
<t> |
| 5287 |
|
<list> |
| 5288 |
|
<t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"</t> |
| 5289 |
|
</list> |
| 5290 |
|
</t> |
| 5291 |
|
<t>where <devices> will be replaced by the new number |
| 5292 |
|
of audio output devices.</t> |
| 5293 |
|
</section> |
| 5294 |
|
|
| 5295 |
|
<section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"> |
| 5296 |
|
<t>Client may want to be notified when changes were made to audio output devices on the |
| 5297 |
|
back-end by issuing the following command:</t> |
| 5298 |
|
<t> |
| 5299 |
|
<list> |
| 5300 |
|
<t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t> |
| 5301 |
|
</list> |
| 5302 |
|
</t> |
| 5303 |
|
<t>Server will start sending the following notification messages:</t> |
| 5304 |
|
<t> |
| 5305 |
|
<list> |
| 5306 |
|
<t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"</t> |
| 5307 |
|
</list> |
| 5308 |
|
</t> |
| 5309 |
|
<t>where <device-id> will be replaced by the numerical ID of the audio output device, |
| 5310 |
|
which settings has been changed. The front-end will have to send |
| 5311 |
|
the respective command to actually get the audio output device info. Because these messages |
| 5312 |
|
will be triggered by LSCP commands issued by other clients rather than real |
| 5313 |
|
time events happening on the server, it is believed that an empty notification |
| 5314 |
|
message is sufficient here.</t> |
| 5315 |
|
</section> |
| 5316 |
|
|
| 5317 |
|
<section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"> |
| 5318 |
|
<t>Client may want to be notified when the total number of MIDI input devices on the |
| 5319 |
|
back-end changes by issuing the following command:</t> |
| 5320 |
|
<t> |
| 5321 |
|
<list> |
| 5322 |
|
<t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t> |
| 5323 |
|
</list> |
| 5324 |
|
</t> |
| 5325 |
|
<t>Server will start sending the following notification messages:</t> |
| 5326 |
|
<t> |
| 5327 |
|
<list> |
| 5328 |
|
<t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"</t> |
| 5329 |
|
</list> |
| 5330 |
|
</t> |
| 5331 |
|
<t>where <devices> will be replaced by the new number |
| 5332 |
|
of MIDI input devices.</t> |
| 5333 |
|
</section> |
| 5334 |
|
|
| 5335 |
|
<section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"> |
| 5336 |
|
<t>Client may want to be notified when changes were made to MIDI input devices on the |
| 5337 |
|
back-end by issuing the following command:</t> |
| 5338 |
|
<t> |
| 5339 |
|
<list> |
| 5340 |
|
<t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t> |
| 5341 |
|
</list> |
| 5342 |
|
</t> |
| 5343 |
|
<t>Server will start sending the following notification messages:</t> |
| 5344 |
|
<t> |
| 5345 |
|
<list> |
| 5346 |
|
<t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"</t> |
| 5347 |
|
</list> |
| 5348 |
|
</t> |
| 5349 |
|
<t>where <device-id> will be replaced by the numerical ID of the MIDI input device, |
| 5350 |
|
which settings has been changed. The front-end will have to send |
| 5351 |
|
the respective command to actually get the MIDI input device info. Because these messages |
| 5352 |
|
will be triggered by LSCP commands issued by other clients rather than real |
| 5353 |
|
time events happening on the server, it is believed that an empty notification |
| 5354 |
|
message is sufficient here.</t> |
| 5355 |
|
</section> |
| 5356 |
|
|
| 5357 |
|
<section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT"> |
| 5358 |
<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 |
| 5359 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
| 5360 |
<t> |
<t> |
| 5361 |
<list> |
<list> |
| 5362 |
<t>SUBSCRIBE CHANNELS</t> |
<t>SUBSCRIBE CHANNEL_COUNT</t> |
| 5363 |
</list> |
</list> |
| 5364 |
</t> |
</t> |
| 5365 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
| 5366 |
<t> |
<t> |
| 5367 |
<list> |
<list> |
| 5368 |
<t>"NOTIFY:CHANNELS:<channels>"</t> |
<t>"NOTIFY:CHANNEL_COUNT:<channels>"</t> |
| 5369 |
</list> |
</list> |
| 5370 |
</t> |
</t> |
| 5371 |
<t>where <channels> will be replaced by the new number |
<t>where <channels> will be replaced by the new number |
| 5372 |
of sampler channels.</t> |
of sampler channels.</t> |
| 5373 |
</section> |
</section> |
| 5374 |
|
|
| 5375 |
<section title="Number of active voices changed"> |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
| 5376 |
<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 |
| 5377 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
| 5378 |
<t> |
<t> |
| 5383 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
| 5384 |
<t> |
<t> |
| 5385 |
<list> |
<list> |
| 5386 |
<t>"NOTIFY:VOICE_COUNT:<sampler-channel> <voices>></t> |
<t>"NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"</t> |
| 5387 |
</list> |
</list> |
| 5388 |
</t> |
</t> |
| 5389 |
<t>where <sampler-channel> will be replaced by the sampler channel the |
<t>where <sampler-channel> will be replaced by the sampler channel the |
| 5390 |
voice count change occurred and <voices>> by the new number of |
voice count change occurred and <voices> by the new number of |
| 5391 |
active voices on that channel.</t> |
active voices on that channel.</t> |
| 5392 |
</section> |
</section> |
| 5393 |
|
|
| 5394 |
<section title="Number of active disk streams changed"> |
<section title="Number of active disk streams changed" anchor="SUBSCRIBE STREAM_COUNT"> |
| 5395 |
<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 |
| 5396 |
changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t> |
changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t> |
| 5397 |
<t> |
<t> |
| 5410 |
active disk streams on that channel.</t> |
active disk streams on that channel.</t> |
| 5411 |
</section> |
</section> |
| 5412 |
|
|
| 5413 |
<section title="Disk stream buffer fill state changed"> |
<section title="Disk stream buffer fill state changed" anchor="SUBSCRIBE BUFFER_FILL"> |
| 5414 |
<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 buffer fill state of a disk stream |
| 5415 |
changes by issuing the following command:</t> |
on the back-end changes by issuing the following command:</t> |
| 5416 |
<t> |
<t> |
| 5417 |
<list> |
<list> |
| 5418 |
<t>SUBSCRIBE BUFFER_FILL</t> |
<t>SUBSCRIBE BUFFER_FILL</t> |
| 5425 |
</list> |
</list> |
| 5426 |
</t> |
</t> |
| 5427 |
<t>where <sampler-channel> will be replaced by the sampler channel the |
<t>where <sampler-channel> will be replaced by the sampler channel the |
| 5428 |
buffer fill state change occurred and <fill-data> will be replaced by the |
buffer fill state change occurred on and <fill-data> will be replaced by the |
| 5429 |
buffer fill data for this channel as described in 4.4.12 as if the |
buffer fill data for this channel as described in <xref target="GET CHANNEL BUFFER_FILL" /> |
| 5430 |
"GET CHANNEL BUFFER_FILL PERCENTAGE" was issued on this channel.</t> |
as if the <xref target="GET CHANNEL BUFFER_FILL"> |
| 5431 |
|
"GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t> |
| 5432 |
</section> |
</section> |
| 5433 |
|
|
| 5434 |
<section title="Channel information changed"> |
<section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO"> |
| 5435 |
<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 |
| 5436 |
back-end changes by issuing the following command:</t> |
back-end by issuing the following command:</t> |
| 5437 |
<t> |
<t> |
| 5438 |
<list> |
<list> |
| 5439 |
<t>SUBSCRIBE INFO</t> |
<t>SUBSCRIBE CHANNEL_INFO</t> |
| 5440 |
</list> |
</list> |
| 5441 |
</t> |
</t> |
| 5442 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
| 5443 |
<t> |
<t> |
| 5444 |
<list> |
<list> |
| 5445 |
<t>"NOTIFY:INFO:<sampler-channel>"</t> |
<t>"NOTIFY:CHANNEL_INFO:<sampler-channel>"</t> |
| 5446 |
</list> |
</list> |
| 5447 |
</t> |
</t> |
| 5448 |
<t>where <sampler-channel> will be replaced by the sampler channel the |
<t>where <sampler-channel> will be replaced by the sampler channel the |
| 5453 |
message is sufficient here.</t> |
message is sufficient here.</t> |
| 5454 |
</section> |
</section> |
| 5455 |
|
|
| 5456 |
<section title="Miscellaneous and debugging events"> |
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
| 5457 |
|
<t>Client may want to be notified when the number of effect sends on |
| 5458 |
|
a particular sampler channel is changed by issuing the following command:</t> |
| 5459 |
|
<t> |
| 5460 |
|
<list> |
| 5461 |
|
<t>SUBSCRIBE FX_SEND_COUNT</t> |
| 5462 |
|
</list> |
| 5463 |
|
</t> |
| 5464 |
|
<t>Server will start sending the following notification messages:</t> |
| 5465 |
|
<t> |
| 5466 |
|
<list> |
| 5467 |
|
<t>"NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"</t> |
| 5468 |
|
</list> |
| 5469 |
|
</t> |
| 5470 |
|
<t>where <channel-id> will be replaced by the numerical ID of the sampler |
| 5471 |
|
channel, on which the effect sends number is changed and <fx-sends> will |
| 5472 |
|
be replaced by the new number of effect sends on that channel.</t> |
| 5473 |
|
</section> |
| 5474 |
|
|
| 5475 |
|
<section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO"> |
| 5476 |
|
<t>Client may want to be notified when changes were made to effect sends on a |
| 5477 |
|
a particular sampler channel by issuing the following command:</t> |
| 5478 |
|
<t> |
| 5479 |
|
<list> |
| 5480 |
|
<t>SUBSCRIBE FX_SEND_INFO</t> |
| 5481 |
|
</list> |
| 5482 |
|
</t> |
| 5483 |
|
<t>Server will start sending the following notification messages:</t> |
| 5484 |
|
<t> |
| 5485 |
|
<list> |
| 5486 |
|
<t>"NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"</t> |
| 5487 |
|
</list> |
| 5488 |
|
</t> |
| 5489 |
|
<t>where <channel-id> will be replaced by the numerical ID of the sampler |
| 5490 |
|
channel, on which an effect send entity is changed and <fx-send-id> will |
| 5491 |
|
be replaced by the numerical ID of the changed effect send.</t> |
| 5492 |
|
</section> |
| 5493 |
|
|
| 5494 |
|
<section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT"> |
| 5495 |
|
<t>Client may want to be notified when the total number of voices on the |
| 5496 |
|
back-end changes by issuing the following command:</t> |
| 5497 |
|
<t> |
| 5498 |
|
<list> |
| 5499 |
|
<t>SUBSCRIBE TOTAL_VOICE_COUNT</t> |
| 5500 |
|
</list> |
| 5501 |
|
</t> |
| 5502 |
|
<t>Server will start sending the following notification messages:</t> |
| 5503 |
|
<t> |
| 5504 |
|
<list> |
| 5505 |
|
<t>"NOTIFY:TOTAL_VOICE_COUNT:<voices>"</t> |
| 5506 |
|
</list> |
| 5507 |
|
</t> |
| 5508 |
|
<t>where <voices> will be replaced by the new number of |
| 5509 |
|
all currently active voices.</t> |
| 5510 |
|
</section> |
| 5511 |
|
|
| 5512 |
|
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
| 5513 |
|
<t>Client may want to be notified when the number of MIDI instrument maps on the |
| 5514 |
|
back-end changes by issuing the following command:</t> |
| 5515 |
|
<t> |
| 5516 |
|
<list> |
| 5517 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t> |
| 5518 |
|
</list> |
| 5519 |
|
</t> |
| 5520 |
|
<t>Server will start sending the following notification messages:</t> |
| 5521 |
|
<t> |
| 5522 |
|
<list> |
| 5523 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"</t> |
| 5524 |
|
</list> |
| 5525 |
|
</t> |
| 5526 |
|
<t>where <maps> will be replaced by the new number |
| 5527 |
|
of MIDI instrument maps.</t> |
| 5528 |
|
</section> |
| 5529 |
|
|
| 5530 |
|
<section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"> |
| 5531 |
|
<t>Client may want to be notified when changes were made to MIDI instrument maps on the |
| 5532 |
|
back-end by issuing the following command:</t> |
| 5533 |
|
<t> |
| 5534 |
|
<list> |
| 5535 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t> |
| 5536 |
|
</list> |
| 5537 |
|
</t> |
| 5538 |
|
<t>Server will start sending the following notification messages:</t> |
| 5539 |
|
<t> |
| 5540 |
|
<list> |
| 5541 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"</t> |
| 5542 |
|
</list> |
| 5543 |
|
</t> |
| 5544 |
|
<t>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
| 5545 |
|
for which information changes occurred. The front-end will have to send |
| 5546 |
|
the respective command to actually get the MIDI instrument map info. Because these messages |
| 5547 |
|
will be triggered by LSCP commands issued by other clients rather than real |
| 5548 |
|
time events happening on the server, it is believed that an empty notification |
| 5549 |
|
message is sufficient here.</t> |
| 5550 |
|
</section> |
| 5551 |
|
|
| 5552 |
|
<section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT"> |
| 5553 |
|
<t>Client may want to be notified when the number of MIDI instrument maps on the |
| 5554 |
|
back-end changes by issuing the following command:</t> |
| 5555 |
|
<t> |
| 5556 |
|
<list> |
| 5557 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t> |
| 5558 |
|
</list> |
| 5559 |
|
</t> |
| 5560 |
|
<t>Server will start sending the following notification messages:</t> |
| 5561 |
|
<t> |
| 5562 |
|
<list> |
| 5563 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"</t> |
| 5564 |
|
</list> |
| 5565 |
|
</t> |
| 5566 |
|
<t>where <map-id> is the numerical ID of the MIDI instrument map, in which |
| 5567 |
|
the nuber of instruments has changed and <instruments> will be replaced by |
| 5568 |
|
the new number of MIDI instruments in the specified map.</t> |
| 5569 |
|
</section> |
| 5570 |
|
|
| 5571 |
|
<section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO"> |
| 5572 |
|
<t>Client may want to be notified when changes were made to MIDI instruments on the |
| 5573 |
|
back-end by issuing the following command:</t> |
| 5574 |
|
<t> |
| 5575 |
|
<list> |
| 5576 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t> |
| 5577 |
|
</list> |
| 5578 |
|
</t> |
| 5579 |
|
<t>Server will start sending the following notification messages:</t> |
| 5580 |
|
<t> |
| 5581 |
|
<list> |
| 5582 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"</t> |
| 5583 |
|
</list> |
| 5584 |
|
</t> |
| 5585 |
|
<t>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
| 5586 |
|
in which a MIDI instrument is changed. <bank> and <program> specifies |
| 5587 |
|
the location of the changed MIDI instrument in the map. The front-end will have to send |
| 5588 |
|
the respective command to actually get the MIDI instrument info. Because these messages |
| 5589 |
|
will be triggered by LSCP commands issued by other clients rather than real |
| 5590 |
|
time events happening on the server, it is believed that an empty notification |
| 5591 |
|
message is sufficient here.</t> |
| 5592 |
|
</section> |
| 5593 |
|
|
| 5594 |
|
<section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO"> |
| 5595 |
|
<t>Client may want to be notified when changes to the global settings |
| 5596 |
|
of the sampler were made by issuing the following command:</t> |
| 5597 |
|
<t> |
| 5598 |
|
<list> |
| 5599 |
|
<t>SUBSCRIBE GLOBAL_INFO</t> |
| 5600 |
|
</list> |
| 5601 |
|
</t> |
| 5602 |
|
<t>Server will start sending the following types of notification messages:</t> |
| 5603 |
|
<t> |
| 5604 |
|
<list> |
| 5605 |
|
<t>"NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the |
| 5606 |
|
golbal volume of the sampler is changed, where <volume> will be |
| 5607 |
|
replaced by the optional dotted floating point value, reflecting the |
| 5608 |
|
new global volume parameter.</t> |
| 5609 |
|
</list> |
| 5610 |
|
</t> |
| 5611 |
|
</section> |
| 5612 |
|
|
| 5613 |
|
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
| 5614 |
<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 |
| 5615 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |
| 5616 |
<t> |
<t> |
| 5646 |
<t>Rui Nuno Capela</t> |
<t>Rui Nuno Capela</t> |
| 5647 |
<t>Vladimir Senkov</t> |
<t>Vladimir Senkov</t> |
| 5648 |
<t>Mark Knecht</t> |
<t>Mark Knecht</t> |
| 5649 |
|
<t>Grigor Iliev</t> |
| 5650 |
</list> |
</list> |
| 5651 |
</t> |
</t> |
| 5652 |
</section> |
</section> |
| 5654 |
</middle> |
</middle> |
| 5655 |
|
|
| 5656 |
<back> |
<back> |
| 5657 |
<references>&rfc2119;</references> |
<references> |
| 5658 |
|
<reference anchor="RFC2119"> |
| 5659 |
|
<front> |
| 5660 |
|
<title>Key words for use in RFCs to Indicate Requirement Levels</title> |
| 5661 |
|
<author initials="S." surname="Bradner" fullname="Scott Bradner"> |
| 5662 |
|
<organization>Harvard University</organization> |
| 5663 |
|
</author> |
| 5664 |
|
<date year="1997"></date> |
| 5665 |
|
</front> |
| 5666 |
|
<seriesInfo name="RFC" value="2119" /> |
| 5667 |
|
</reference> |
| 5668 |
|
<reference anchor="RFC793"> |
| 5669 |
|
<front> |
| 5670 |
|
<title>TRANSMISSION CONTROL PROTOCOL</title> |
| 5671 |
|
<author> |
| 5672 |
|
<organization>Defense Advanced Research Projects Agency</organization> |
| 5673 |
|
</author> |
| 5674 |
|
<date year="1981"></date> |
| 5675 |
|
</front> |
| 5676 |
|
<seriesInfo name="RFC" value="793" /> |
| 5677 |
|
</reference> |
| 5678 |
|
<reference anchor="RFC2234"> |
| 5679 |
|
<front> |
| 5680 |
|
<title>Augmented BNF for Syntax Specifications</title> |
| 5681 |
|
<author initials="D.H." surname="Crocker" fullname="David H. Crocker"> |
| 5682 |
|
<organization>Internet Mail Consortium</organization> |
| 5683 |
|
</author> |
| 5684 |
|
<author initials="P." surname="Overell" fullname="Paul Overell"> |
| 5685 |
|
<organization>Demon Internet Ltd</organization> |
| 5686 |
|
</author> |
| 5687 |
|
<date year="1997"></date> |
| 5688 |
|
</front> |
| 5689 |
|
<seriesInfo name="RFC" value="2234" /> |
| 5690 |
|
</reference> |
| 5691 |
|
</references> |
| 5692 |
</back> |
</back> |
| 5693 |
|
|
| 5694 |
</rfc> |
</rfc> |
Parent Directory
| 
Revision Log
| 
Patch