31 |
<email>schoenebeck at software minus engineering dot org</email> |
<email>schoenebeck at software minus engineering dot org</email> |
32 |
</address> |
</address> |
33 |
</author> |
</author> |
34 |
<date month="Apr" year="2005"/> |
<date month="May" year="2005"/> |
35 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
36 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
37 |
<abstract> |
<abstract> |
38 |
<t>The LinuxSampler Control Protocol (LSCP) is an |
<t>The LinuxSampler Control Protocol (LSCP) is an |
39 |
application-level protocol primarily intended for local and |
application-level protocol primarily intended for local and |
40 |
remote controlling the LinuxSampler main application, which is a |
remote controlling the LinuxSampler backend application, which is a |
41 |
sophisticated console application essentially playing back audio |
sophisticated server-like console application essentially playing |
42 |
samples and manipulating the samples in real time to certain |
back audio samples and manipulating the samples in real time to |
43 |
extent.</t> |
certain extent.</t> |
44 |
</abstract> |
</abstract> |
45 |
</front> |
</front> |
46 |
|
|
112 |
return and line feed characters respectively.</t> |
return and line feed characters respectively.</t> |
113 |
</section> |
</section> |
114 |
|
|
115 |
|
<section title="Versioning of this specification" anchor="LSCP versioning"> |
116 |
|
<t>LSCP will certainly be extended and enhanced by-and-by. Each official |
117 |
|
release of the LSCP specification will be tagged with a unique version |
118 |
|
tuple. The version tuple consists at least of a major and minor version |
119 |
|
number like: |
120 |
|
</t> |
121 |
|
<t> |
122 |
|
<list> |
123 |
|
<t>"1.2"</t> |
124 |
|
</list> |
125 |
|
</t> |
126 |
|
<t> |
127 |
|
In this example the major version number would be "1" and the minor |
128 |
|
version number would be "2". Note that the version tuple might also |
129 |
|
have more than two elements. The major version number defines a |
130 |
|
group of backward compatible versions. That means a frontend is |
131 |
|
compatible to the connected sampler if and only if the LSCP versions |
132 |
|
to which each of the two parties complies to, match both of the |
133 |
|
following rule: |
134 |
|
</t> |
135 |
|
<t>Compatibility:</t> |
136 |
|
<t> |
137 |
|
<list style="numbers"> |
138 |
|
<t>The frontend's LSCP major version and the sampler's LSCP |
139 |
|
major version are exactly equal.</t> |
140 |
|
<t>The frontend's LSCP minor version is less or equal than |
141 |
|
the sampler's LSCP minor version.</t> |
142 |
|
</list> |
143 |
|
</t> |
144 |
|
<t> |
145 |
|
Compatibility can only be claimed if both rules are true. |
146 |
|
The frontend can use the |
147 |
|
<xref target="GET SERVER INFO">"GET SERVER INFO"</xref> command to |
148 |
|
get the version of the LSCP specification the sampler complies with. |
149 |
|
</t> |
150 |
|
</section> |
151 |
|
|
152 |
<section title="Introduction"> |
<section title="Introduction"> |
153 |
<t>LinuxSampler is a so called software sampler application |
<t>LinuxSampler is a so called software sampler application |
154 |
capable to playback audio samples from a computer's Random |
capable to playback audio samples from a computer's Random |
161 |
arbitrary MIDI input method and arbitrary MIDI channel (e.g. |
arbitrary MIDI input method and arbitrary MIDI channel (e.g. |
162 |
sampler channel 17 could be connected to an ALSA sequencer |
sampler channel 17 could be connected to an ALSA sequencer |
163 |
device 64:0 and listening to MIDI channel 1 there). Each sampler |
device 64:0 and listening to MIDI channel 1 there). Each sampler |
164 |
engine will be assigned an own instance of one of the available |
channel will be associated with an instance of one of the available |
165 |
sampler engines (e.g. GigEngine, DLSEngine). The audio output of |
sampler engines (e.g. GigEngine, DLSEngine). The audio output of |
166 |
each sampler channel can be routed to an arbitrary audio output |
each sampler channel can be routed to an arbitrary audio output |
167 |
method (ALSA / JACK) and an arbitrary audio output channel |
method (ALSA / JACK) and an arbitrary audio output channel |
191 |
methods will be described next.</t> |
methods will be described next.</t> |
192 |
|
|
193 |
<section title="Request/response communication method"> |
<section title="Request/response communication method"> |
194 |
<t>This simple communication method is based on TCP. The |
<t>This simple communication method is based on |
195 |
|
<xref target="RFC793">TCP</xref>. The |
196 |
front-end application establishes a TCP connection to the |
front-end application establishes a TCP connection to the |
197 |
LinuxSampler instance on a certain host system. Then the |
LinuxSampler instance on a certain host system. Then the |
198 |
front-end application will send certain ASCII based commands |
front-end application will send certain ASCII based commands |
417 |
|
|
418 |
<t>where <event-id> will be replace by the respective |
<t>where <event-id> will be replace by the respective |
419 |
event that client is no longer interested in receiving. For |
event that client is no longer interested in receiving. For |
420 |
a list of supported events see chapter 6.</t> |
a list of supported events see <xref target="events" />.</t> |
421 |
|
|
422 |
<t>Example: the fill states of disk stream buffers have |
<t>Example: the fill states of disk stream buffers have |
423 |
changed on sampler channel 4 and the LinuxSampler instance |
changed on sampler channel 4 and the LinuxSampler instance |
466 |
<section title="Description for control commands"> |
<section title="Description for control commands"> |
467 |
<t>This chapter will describe the available control commands |
<t>This chapter will describe the available control commands |
468 |
that can be sent on the TCP connection in detail. Some certain |
that can be sent on the TCP connection in detail. Some certain |
469 |
commands (e.g. "GET CHANNEL INFO" or "GET ENGINE INFO") lead to |
commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref> |
470 |
|
or <xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref>) lead to |
471 |
multiple-line responses. In this case LinuxSampler signals the |
multiple-line responses. In this case LinuxSampler signals the |
472 |
end of the response by a "." (single dot) line.</t> |
end of the response by a "." (single dot) line.</t> |
473 |
|
|
511 |
what parameters drivers are offering, how to retrieve their |
what parameters drivers are offering, how to retrieve their |
512 |
possible values, etc.</t> |
possible values, etc.</t> |
513 |
|
|
514 |
<section title="Getting all available audio output drivers"> |
<section title="Getting amount of available audio output drivers" anchor="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"> |
515 |
|
<t>Use the following command to get the number of |
516 |
|
audio output drivers currently available for the |
517 |
|
LinuxSampler instance:</t> |
518 |
|
<t> |
519 |
|
<list> |
520 |
|
<t>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS</t> |
521 |
|
</list> |
522 |
|
</t> |
523 |
|
<t>Possible Answers:</t> |
524 |
|
<t> |
525 |
|
<list> |
526 |
|
<t>LinuxSampler will answer by sending the |
527 |
|
number of audio output drivers.</t> |
528 |
|
</list> |
529 |
|
</t> |
530 |
|
<t>Example:</t> |
531 |
|
<t> |
532 |
|
<list> |
533 |
|
<t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t> |
534 |
|
<t>S: "2"</t> |
535 |
|
</list> |
536 |
|
</t> |
537 |
|
</section> |
538 |
|
|
539 |
|
<section title="Getting all available audio output drivers" anchor="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"> |
540 |
<t>Use the following command to list all audio output |
<t>Use the following command to list all audio output |
541 |
drivers currently available for the LinuxSampler |
drivers currently available for the LinuxSampler |
542 |
instance:</t> |
instance:</t> |
543 |
<t> |
<t> |
544 |
<list> |
<list> |
545 |
<t>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS</t> |
<t>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS</t> |
546 |
</list> |
</list> |
547 |
</t> |
</t> |
548 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
556 |
<t>Example:</t> |
<t>Example:</t> |
557 |
<t> |
<t> |
558 |
<list> |
<list> |
559 |
<t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t> |
<t>C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t> |
560 |
<t>S: "ALSA,JACK"</t> |
<t>S: "ALSA,JACK"</t> |
561 |
</list> |
</list> |
562 |
</t> |
</t> |
563 |
</section> |
</section> |
564 |
|
|
565 |
<section title="Getting information about a specific audio |
<section title="Getting information about a specific audio |
566 |
output driver"> |
output driver" anchor="GET AUDIO_OUTPUT_DRIVER INFO"> |
567 |
<t>Use the following command to get detailed information |
<t>Use the following command to get detailed information |
568 |
about a specific audio output driver:</t> |
about a specific audio output driver:</t> |
569 |
<t> |
<t> |
573 |
</list> |
</list> |
574 |
</t> |
</t> |
575 |
<t>Where <audio-output-driver> is the name of the |
<t>Where <audio-output-driver> is the name of the |
576 |
audio output driver, returned by the "GET |
audio output driver, returned by the |
577 |
AVAILABLE_AUDIO_OUTPUT_DRIVERS" command.</t> |
<xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command.</t> |
578 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
579 |
<t> |
<t> |
580 |
<list> |
<list> |
636 |
</section> |
</section> |
637 |
|
|
638 |
<section title="Getting information about specific audio |
<section title="Getting information about specific audio |
639 |
output driver parameter"> |
output driver parameter" anchor="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"> |
640 |
<t>Use the following command to get detailed information |
<t>Use the following command to get detailed information |
641 |
about a specific audio output driver parameter:</t> |
about a specific audio output driver parameter:</t> |
642 |
<t> |
<t> |
645 |
</list> |
</list> |
646 |
</t> |
</t> |
647 |
<t>Where <audio> is the name of the audio output |
<t>Where <audio> is the name of the audio output |
648 |
driver as returned by the "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS" command, |
driver as returned by the <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"> |
649 |
|
"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command, |
650 |
<prm> a specific parameter name for which information should be |
<prm> a specific parameter name for which information should be |
651 |
obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO" command) and |
obtained (as returned by the |
652 |
|
<xref target="GET AUDIO_OUTPUT_DRIVER INFO">"GET AUDIO_OUTPUT_DRIVER INFO"</xref> command) and |
653 |
<deplist> is an optional list of parameters on which the sought |
<deplist> is an optional list of parameters on which the sought |
654 |
parameter <prm> depends on, <deplist> is a list of key-value |
parameter <prm> depends on, <deplist> is a list of key-value |
655 |
pairs in form of "key1=val1 key2=val2 ...", where character string values |
pairs in form of "key1=val1 key2=val2 ...", where character string values |
696 |
<list> |
<list> |
697 |
<t>either true or false, defines if this parameter must be |
<t>either true or false, defines if this parameter must be |
698 |
given when the device is to be created with the |
given when the device is to be created with the |
699 |
'CREATE AUDIO_OUTPUT_DEVICE' command |
<xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref> |
700 |
(always returned, no matter which driver parameter)</t> |
command (always returned, no matter which driver parameter)</t> |
701 |
</list> |
</list> |
702 |
</t> |
</t> |
703 |
|
|
705 |
<list> |
<list> |
706 |
<t>either true or false, if false then this parameter can |
<t>either true or false, if false then this parameter can |
707 |
be changed at any time, once the device is created by |
be changed at any time, once the device is created by |
708 |
the 'CREATE AUDIO_OUTPUT_DEVICE' command |
the <xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref> |
709 |
(always returned, no matter which driver parameter)</t> |
command (always returned, no matter which driver parameter)</t> |
710 |
</list> |
</list> |
711 |
</t> |
</t> |
712 |
|
|
721 |
|
|
722 |
<t>DEPENDS - |
<t>DEPENDS - |
723 |
<list> |
<list> |
724 |
<t>comma separated list of paramters this parameter depends |
<t>comma separated list of parameters this parameter depends |
725 |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
726 |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
727 |
listed parameters, for example assuming that an audio |
listed parameters, for example assuming that an audio |
738 |
<list> |
<list> |
739 |
<t>reflects the default value for this parameter which is |
<t>reflects the default value for this parameter which is |
740 |
used when the device is created and not explicitly |
used when the device is created and not explicitly |
741 |
given with the 'CREATE AUDIO_OUTPUT_DEVICE' command, |
given with the <xref target="CREATE AUDIO_OUTPUT_DEVICE"> |
742 |
|
'CREATE AUDIO_OUTPUT_DEVICE'</xref> command, |
743 |
in case of MULTIPLCITY=true, this is a comma separated |
in case of MULTIPLCITY=true, this is a comma separated |
744 |
list, that's why character strings are encapsulated into |
list, that's why character strings are encapsulated into |
745 |
apostrophes (') |
apostrophes (') |
824 |
</t> |
</t> |
825 |
</section> |
</section> |
826 |
|
|
827 |
<section title="Creating an audio output device"> |
<section title="Creating an audio output device" anchor="CREATE AUDIO_OUTPUT_DEVICE"> |
828 |
<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> |
829 |
|
|
830 |
<t> |
<t> |
834 |
</t> |
</t> |
835 |
|
|
836 |
<t>Where <audio-output-driver> should be replaced by the desired audio |
<t>Where <audio-output-driver> should be replaced by the desired audio |
837 |
output system and <param-list> by an optional list of driver |
output system as returned by the |
838 |
|
<xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> |
839 |
|
command and <param-list> by an optional list of driver |
840 |
specific parameters in form of "key1=val1 key2=val2 ...", where |
specific parameters in form of "key1=val1 key2=val2 ...", where |
841 |
character string values should be encapsulated into apostrophes ('). |
character string values should be encapsulated into apostrophes ('). |
842 |
Note that there might be drivers which require parameter(s) to be |
Note that there might be drivers which require parameter(s) to be |
884 |
</t> |
</t> |
885 |
</section> |
</section> |
886 |
|
|
887 |
<section title="Destroying an audio output device"> |
<section title="Destroying an audio output device" anchor="DESTROY AUDIO_OUTPUT_DEVICE"> |
888 |
<t>Use the following command to destroy a created output device:</t> |
<t>Use the following command to destroy a created output device:</t> |
889 |
<t> |
<t> |
890 |
<list> |
<list> |
892 |
</list> |
</list> |
893 |
</t> |
</t> |
894 |
<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 |
895 |
audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE" or |
audio output device as given by the |
896 |
"GET AUDIO_OUTPUT_DEVICES" command.</t> |
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
897 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
898 |
|
command.</t> |
899 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
900 |
<t> |
<t> |
901 |
<list> |
<list> |
930 |
</t> |
</t> |
931 |
</section> |
</section> |
932 |
|
|
933 |
<section title="Getting all created audio output device count"> |
<section title="Getting all created audio output device count" anchor="GET AUDIO_OUTPUT_DEVICES"> |
934 |
<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> |
935 |
<t> |
<t> |
936 |
<list> |
<list> |
953 |
</t> |
</t> |
954 |
</section> |
</section> |
955 |
|
|
956 |
<section title="Getting all created audio output device list"> |
<section title="Getting all created audio output device list" anchor="LIST AUDIO_OUTPUT_DEVICES"> |
957 |
<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> |
958 |
<t> |
<t> |
959 |
<list> |
<list> |
976 |
</t> |
</t> |
977 |
</section> |
</section> |
978 |
|
|
979 |
<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"> |
980 |
<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> |
981 |
<t> |
<t> |
982 |
<list> |
<list> |
985 |
</t> |
</t> |
986 |
<t>Where <device-id> should be replaced by numerical ID |
<t>Where <device-id> should be replaced by numerical ID |
987 |
of the audio output device as e.g. returned by the |
of the audio output device as e.g. returned by the |
988 |
"LIST AUDIO_OUTPUT_DEVICES" command.</t> |
<xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> command.</t> |
989 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
990 |
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
991 |
Each answer line begins with the information category name |
Each answer line begins with the information category name |
999 |
<t>DRIVER - |
<t>DRIVER - |
1000 |
<list> |
<list> |
1001 |
<t>identifier of the used audio output driver, as also |
<t>identifier of the used audio output driver, as also |
1002 |
returned by the "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS" |
returned by the |
1003 |
|
<xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"> |
1004 |
|
"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> |
1005 |
command</t> |
command</t> |
1006 |
</list> |
</list> |
1007 |
</t> |
</t> |
1030 |
order. The fields above are only those fields which are |
order. The fields above are only those fields which are |
1031 |
returned by all audio output devices. Every audio output driver |
returned by all audio output devices. Every audio output driver |
1032 |
might have its own, additional driver specific parameters (see |
might have its own, additional driver specific parameters (see |
1033 |
"GET AUDIO_OUTPUT_DRIVER INFO" command) which are also returned |
<xref target="GET AUDIO_OUTPUT_DRIVER INFO" />) |
1034 |
by this command.</t> |
which are also returned by this command.</t> |
1035 |
<t>Example:</t> |
<t>Example:</t> |
1036 |
<t> |
<t> |
1037 |
<list> |
<list> |
1049 |
</section> |
</section> |
1050 |
|
|
1051 |
|
|
1052 |
<section title="Changing settings of audio output devices"> |
<section title="Changing settings of audio output devices" anchor="SET AUDIO_OUTPUT_DEVICE_PARAMETER"> |
1053 |
<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> |
1054 |
<t> |
<t> |
1055 |
<list> |
<list> |
1057 |
</list> |
</list> |
1058 |
</t> |
</t> |
1059 |
<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 |
1060 |
audio output device, <key> by the name of the parameter to change |
audio output device as given by the |
1061 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
1062 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
1063 |
|
command, <key> by the name of the parameter to change |
1064 |
and <value> by the new value for this parameter.</t> |
and <value> by the new value for this parameter.</t> |
1065 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1066 |
<t> |
<t> |
1094 |
</t> |
</t> |
1095 |
</section> |
</section> |
1096 |
|
|
1097 |
<section title="Getting information about an audio channel"> |
<section title="Getting information about an audio channel" anchor="GET AUDIO_OUTPUT_CHANNEL INFO"> |
1098 |
<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> |
1099 |
<t> |
<t> |
1100 |
<list> |
<list> |
1101 |
<t>GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan></t> |
<t>GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan></t> |
1102 |
</list> |
</list> |
1103 |
</t> |
</t> |
1104 |
<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 |
1105 |
and <audio-chan> the audio channel number.</t> |
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
1106 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
1107 |
|
command and <audio-chan> the audio channel number.</t> |
1108 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1109 |
<t> |
<t> |
1110 |
<list> |
<list> |
1194 |
</t> |
</t> |
1195 |
</section> |
</section> |
1196 |
|
|
1197 |
<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"> |
1198 |
<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> |
1199 |
|
|
1200 |
<t> |
<t> |
1203 |
</list> |
</list> |
1204 |
</t> |
</t> |
1205 |
|
|
1206 |
<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 |
1207 |
by the "GET AUDIO_OUTPUT_DEVICES" command, <chan> the audio channel number |
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
1208 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
1209 |
|
command, <chan> the audio channel number |
1210 |
and <param> a specific channel parameter name for which information should |
and <param> a specific channel parameter name for which information should |
1211 |
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"> |
1212 |
|
"GET AUDIO_OUTPUT_CHANNEL INFO"</xref> command).</t> |
1213 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1214 |
|
|
1215 |
<t> |
<t> |
1300 |
</t> |
</t> |
1301 |
</section> |
</section> |
1302 |
|
|
1303 |
<section title="Changing settings of audio output channels"> |
<section title="Changing settings of audio output channels" anchor="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"> |
1304 |
<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> |
1305 |
<t> |
<t> |
1306 |
<list> |
<list> |
1307 |
<t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value></t> |
<t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value></t> |
1308 |
</list> |
</list> |
1309 |
</t> |
</t> |
1310 |
<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 |
1311 |
device, <chn> by the audio channel number, <key> by the name of the |
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
1312 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
1313 |
|
command, <chn> by the audio channel number, <key> by the name of the |
1314 |
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> |
1315 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1316 |
<t> |
<t> |
1378 |
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 |
1379 |
possible values, etc.</t> |
possible values, etc.</t> |
1380 |
|
|
1381 |
<section title="Getting all available MIDI input drivers"> |
<section title="Getting amount of available MIDI input drivers" anchor="GET AVAILABLE_MIDI_INPUT_DRIVERS"> |
1382 |
|
<t>Use the following command to get the number of |
1383 |
|
MIDI input drivers currently available for the |
1384 |
|
LinuxSampler instance:</t> |
1385 |
|
<t> |
1386 |
|
<list> |
1387 |
|
<t>GET AVAILABLE_MIDI_INPUT_DRIVERS</t> |
1388 |
|
</list> |
1389 |
|
</t> |
1390 |
|
<t>Possible Answers:</t> |
1391 |
|
<t> |
1392 |
|
<list> |
1393 |
|
<t>LinuxSampler will answer by sending the |
1394 |
|
number of available MIDI input drivers.</t> |
1395 |
|
</list> |
1396 |
|
</t> |
1397 |
|
<t>Example:</t> |
1398 |
|
<t> |
1399 |
|
<list> |
1400 |
|
<t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t> |
1401 |
|
<t>S: "2"</t> |
1402 |
|
</list> |
1403 |
|
</t> |
1404 |
|
</section> |
1405 |
|
|
1406 |
|
<section title="Getting all available MIDI input drivers" anchor="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
1407 |
<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 |
1408 |
for the LinuxSampler instance:</t> |
for the LinuxSampler instance:</t> |
1409 |
<t> |
<t> |
1410 |
<list> |
<list> |
1411 |
<t>GET AVAILABLE_MIDI_INPUT_DRIVERS</t> |
<t>LIST AVAILABLE_MIDI_INPUT_DRIVERS</t> |
1412 |
</list> |
</list> |
1413 |
</t> |
</t> |
1414 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1421 |
<t>Example:</t> |
<t>Example:</t> |
1422 |
<t> |
<t> |
1423 |
<list> |
<list> |
1424 |
<t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t> |
<t>C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</t> |
1425 |
<t>S: "ALSA,JACK"</t> |
<t>S: "ALSA,JACK"</t> |
1426 |
</list> |
</list> |
1427 |
</t> |
</t> |
1428 |
</section> |
</section> |
1429 |
|
|
1430 |
<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"> |
1431 |
<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> |
1432 |
<t> |
<t> |
1433 |
<list> |
<list> |
1434 |
<t>GET MIDI_INPUT_DRIVER INFO <midi-input-driver></t> |
<t>GET MIDI_INPUT_DRIVER INFO <midi-input-driver></t> |
1435 |
</list> |
</list> |
1436 |
</t> |
</t> |
1437 |
<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 |
1438 |
|
by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
1439 |
|
"LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command.</t> |
1440 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1441 |
<t> |
<t> |
1442 |
<list> |
<list> |
1483 |
</t> |
</t> |
1484 |
</section> |
</section> |
1485 |
|
|
1486 |
<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"> |
1487 |
<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> |
1488 |
<t> |
<t> |
1489 |
<list> |
<list> |
1491 |
</list> |
</list> |
1492 |
</t> |
</t> |
1493 |
|
|
1494 |
<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 |
1495 |
by the "GET AVAILABLE_MIDI_INPUT_DRIVERS" command, <param> a specific |
by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
1496 |
|
"LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command, <param> a specific |
1497 |
parameter name for which information should be obtained (as returned by the |
parameter name for which information should be obtained (as returned by the |
1498 |
"GET MIDI_INPUT_DRIVER INFO" command) and <deplist> is an optional list |
<xref target="GET MIDI_INPUT_DRIVER INFO"> |
1499 |
|
"GET MIDI_INPUT_DRIVER INFO"</xref> command) and <deplist> is an optional list |
1500 |
of parameters on which the sought parameter <param> depends on, |
of parameters on which the sought parameter <param> depends on, |
1501 |
<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 ...", |
1502 |
where character string values are encapsulated into apostrophes ('). Arguments |
where character string values are encapsulated into apostrophes ('). Arguments |
1537 |
<list> |
<list> |
1538 |
<t>either true or false, defines if this parameter must be |
<t>either true or false, defines if this parameter must be |
1539 |
given when the device is to be created with the |
given when the device is to be created with the |
1540 |
'CREATE MIDI_INPUT_DEVICE' command |
<xref target="CREATE MIDI_INPUT_DEVICE"> |
1541 |
|
'CREATE MIDI_INPUT_DEVICE'</xref> command |
1542 |
(always returned, no matter which driver parameter)</t> |
(always returned, no matter which driver parameter)</t> |
1543 |
</list> |
</list> |
1544 |
</t> |
</t> |
1547 |
<list> |
<list> |
1548 |
<t>either true or false, if false then this parameter can |
<t>either true or false, if false then this parameter can |
1549 |
be changed at any time, once the device is created by |
be changed at any time, once the device is created by |
1550 |
the 'CREATE MIDI_INPUT_DEVICE' command |
the <xref target="CREATE MIDI_INPUT_DEVICE"> |
1551 |
|
'CREATE MIDI_INPUT_DEVICE'</xref> command |
1552 |
(always returned, no matter which driver parameter)</t> |
(always returned, no matter which driver parameter)</t> |
1553 |
</list> |
</list> |
1554 |
</t> |
</t> |
1564 |
|
|
1565 |
<t>DEPENDS - |
<t>DEPENDS - |
1566 |
<list> |
<list> |
1567 |
<t>comma separated list of paramters this parameter depends |
<t>comma separated list of parameters this parameter depends |
1568 |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
1569 |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
1570 |
listed parameters, for example assuming that an audio |
listed parameters, for example assuming that an audio |
1581 |
<list> |
<list> |
1582 |
<t>reflects the default value for this parameter which is |
<t>reflects the default value for this parameter which is |
1583 |
used when the device is created and not explicitly |
used when the device is created and not explicitly |
1584 |
given with the 'CREATE MIDI_INPUT_DEVICE' command, |
given with the <xref target="CREATE MIDI_INPUT_DEVICE"> |
1585 |
|
'CREATE MIDI_INPUT_DEVICE'</xref> command, |
1586 |
in case of MULTIPLCITY=true, this is a comma separated |
in case of MULTIPLCITY=true, this is a comma separated |
1587 |
list, that's why character strings are encapsulated into |
list, that's why character strings are encapsulated into |
1588 |
apostrophes (') |
apostrophes (') |
1638 |
</t> |
</t> |
1639 |
</section> |
</section> |
1640 |
|
|
1641 |
<section title="Creating a MIDI input device"> |
<section title="Creating a MIDI input device" anchor="CREATE MIDI_INPUT_DEVICE"> |
1642 |
<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> |
1643 |
<t> |
<t> |
1644 |
<list> |
<list> |
1646 |
</list> |
</list> |
1647 |
</t> |
</t> |
1648 |
|
|
1649 |
<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 |
1650 |
|
by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
1651 |
|
"LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command and <param-list> by an |
1652 |
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 |
1653 |
character string values should be encapsulated into apostrophes ('). |
character string values should be encapsulated into apostrophes ('). |
1654 |
Note that there might be drivers which require parameter(s) to be |
Note that there might be drivers which require parameter(s) to be |
1688 |
</t> |
</t> |
1689 |
</section> |
</section> |
1690 |
|
|
1691 |
<section title="Destroying a MIDI input device"> |
<section title="Destroying a MIDI input device" anchor="DESTROY MIDI_INPUT_DEVICE"> |
1692 |
<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> |
1693 |
<t> |
<t> |
1694 |
<list> |
<list> |
1695 |
<t>DESTROY MIDI_INPUT_DEVICE <device-id></t> |
<t>DESTROY MIDI_INPUT_DEVICE <device-id></t> |
1696 |
</list> |
</list> |
1697 |
</t> |
</t> |
1698 |
<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 |
1699 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
1700 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
1701 |
|
command.</t> |
1702 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1703 |
<t> |
<t> |
1704 |
<list> |
<list> |
1730 |
</t> |
</t> |
1731 |
</section> |
</section> |
1732 |
|
|
1733 |
<section title="Getting all created MIDI input device count"> |
<section title="Getting all created MIDI input device count" anchor="GET MIDI_INPUT_DEVICES"> |
1734 |
<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> |
1735 |
<t> |
<t> |
1736 |
<list> |
<list> |
1754 |
</section> |
</section> |
1755 |
|
|
1756 |
|
|
1757 |
<section title="Getting all created MIDI input device list"> |
<section title="Getting all created MIDI input device list" anchor="LIST MIDI_INPUT_DEVICES"> |
1758 |
<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> |
1759 |
<t> |
<t> |
1760 |
<list> |
<list> |
1783 |
</t> |
</t> |
1784 |
</section> |
</section> |
1785 |
|
|
1786 |
<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"> |
1787 |
<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> |
1788 |
<t> |
<t> |
1789 |
<list> |
<list> |
1790 |
<t>GET MIDI_INPUT_DEVICE INFO <device-id></t> |
<t>GET MIDI_INPUT_DEVICE INFO <device-id></t> |
1791 |
</list> |
</list> |
1792 |
</t> |
</t> |
1793 |
<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 |
1794 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
1795 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
1796 |
|
command.</t> |
1797 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1798 |
<t> |
<t> |
1799 |
<list> |
<list> |
1810 |
<t>DRIVER - |
<t>DRIVER - |
1811 |
<list> |
<list> |
1812 |
<t>identifier of the used MIDI input driver, as e.g. |
<t>identifier of the used MIDI input driver, as e.g. |
1813 |
returned by the "GET AVAILABLE_MIDI_INPUT_DRIVERS" |
returned by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
1814 |
|
"LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> |
1815 |
command</t> |
command</t> |
1816 |
</list> |
</list> |
1817 |
</t> |
</t> |
1834 |
order. The fields above are only those fields which are |
order. The fields above are only those fields which are |
1835 |
returned by all MIDI input devices. Every MIDI input driver |
returned by all MIDI input devices. Every MIDI input driver |
1836 |
might have its own, additional driver specific parameters (see |
might have its own, additional driver specific parameters (see |
1837 |
"GET MIDI_INPUT_DRIVER INFO" command) which are also returned |
<xref target="GET MIDI_INPUT_DRIVER INFO"> |
1838 |
|
"GET MIDI_INPUT_DRIVER INFO"</xref> command) which are also returned |
1839 |
by this command.</t> |
by this command.</t> |
1840 |
|
|
1841 |
<t>Example:</t> |
<t>Example:</t> |
1849 |
</t> |
</t> |
1850 |
</section> |
</section> |
1851 |
|
|
1852 |
<section title="Changing settings of MIDI input devices"> |
<section title="Changing settings of MIDI input devices" anchor="SET MIDI_INPUT_DEVICE_PARAMETER"> |
1853 |
<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> |
1854 |
<t> |
<t> |
1855 |
<list> |
<list> |
1858 |
</t> |
</t> |
1859 |
|
|
1860 |
<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 |
1861 |
MIDI input device, <key> by the name of the parameter to change and |
MIDI input device as returned by the |
1862 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
1863 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
1864 |
|
command, <key> by the name of the parameter to change and |
1865 |
<value> by the new value for this parameter.</t> |
<value> by the new value for this parameter.</t> |
1866 |
|
|
1867 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1895 |
</t> |
</t> |
1896 |
</section> |
</section> |
1897 |
|
|
1898 |
<section title="Getting information about a MIDI port"> |
<section title="Getting information about a MIDI port" anchor="GET MIDI_INPUT_PORT INFO"> |
1899 |
<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> |
1900 |
<t> |
<t> |
1901 |
<list> |
<list> |
1902 |
<t>GET MIDI_INPUT_PORT INFO <device-id> <midi-port></t> |
<t>GET MIDI_INPUT_PORT INFO <device-id> <midi-port></t> |
1903 |
</list> |
</list> |
1904 |
</t> |
</t> |
1905 |
<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 |
1906 |
and <midi-port> the MIDI input port number.</t> |
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
1907 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
1908 |
|
command and <midi-port> the MIDI input port number.</t> |
1909 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1910 |
<t> |
<t> |
1911 |
<list> |
<list> |
1939 |
</t> |
</t> |
1940 |
</section> |
</section> |
1941 |
|
|
1942 |
<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"> |
1943 |
<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> |
1944 |
<t> |
<t> |
1945 |
<list> |
<list> |
1947 |
</list> |
</list> |
1948 |
</t> |
</t> |
1949 |
|
|
1950 |
<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 |
1951 |
by the "LIST MIDI_INPUT_DEVICES" command, <port> the MIDI port number and |
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
1952 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
1953 |
|
command, <port> the MIDI port number and |
1954 |
<param> a specific port parameter name for which information should be |
<param> a specific port parameter name for which information should be |
1955 |
obtained (as returned by the "GET MIDI_INPUT_PORT INFO" command).</t> |
obtained (as returned by the <xref target="GET MIDI_INPUT_PORT INFO"> |
1956 |
|
"GET MIDI_INPUT_PORT INFO"</xref> command).</t> |
1957 |
|
|
1958 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1959 |
<t> |
<t> |
2044 |
</t> |
</t> |
2045 |
</section> |
</section> |
2046 |
|
|
2047 |
<section title="Changing settings of MIDI input ports"> |
<section title="Changing settings of MIDI input ports" anchor="SET MIDI_INPUT_PORT_PARAMETER"> |
2048 |
<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> |
2049 |
<t> |
<t> |
2050 |
<list> |
<list> |
2053 |
</t> |
</t> |
2054 |
|
|
2055 |
<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 |
2056 |
MIDI device, <port> by the MIDI port number, <key> by the name of |
MIDI device as returned by the |
2057 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
2058 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
2059 |
|
command, <port> by the MIDI port number, <key> by the name of |
2060 |
the parameter to change and <value> by the new value for this |
the parameter to change and <value> by the new value for this |
2061 |
parameter.</t> |
parameter.</t> |
2062 |
|
|
2092 |
</section> |
</section> |
2093 |
|
|
2094 |
<section title="Configuring sampler channels"> |
<section title="Configuring sampler channels"> |
2095 |
<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 |
2096 |
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 |
2097 |
|
MIDI and audio devices.</t> |
2098 |
|
|
2099 |
<section title="Loading an instrument"> |
<section title="Loading an instrument" anchor="LOAD INSTRUMENT"> |
2100 |
<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> |
2101 |
<t> |
<t> |
2102 |
<list> |
<list> |
2114 |
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 |
2115 |
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 |
2116 |
returns immediately and a background process is launched to load the instrument |
returns immediately and a background process is launched to load the instrument |
2117 |
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> |
2118 |
|
command can be used to obtain loading |
2119 |
progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks |
progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks |
2120 |
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 |
2121 |
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 |
2153 |
</t> |
</t> |
2154 |
</section> |
</section> |
2155 |
|
|
2156 |
<section title="Loading a sampler engine"> |
<section title="Loading a sampler engine" anchor="LOAD ENGINE"> |
2157 |
<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 |
2158 |
channel by the following command:</t> |
channel by the following command:</t> |
2159 |
<t> |
<t> |
2160 |
<list> |
<list> |
2163 |
</t> |
</t> |
2164 |
|
|
2165 |
<t>Where <engine-name> is an engine name as obtained by the |
<t>Where <engine-name> is an engine name as obtained by the |
2166 |
"GET AVAILABLE_ENGINES" command and <sampler-channel> the sampler channel the |
<xref target="LIST AVAILABLE_ENGINES"> |
2167 |
deployed engine should be assigned to. Even if the respective |
"LIST AVAILABLE_ENGINES"</xref> command and <sampler-channel> |
2168 |
sampler channel has already a deployed engine with that engine |
the sampler channel as returned by the |
2169 |
name, a new engine instance will be assigned to the sampler channel.</t> |
<xref target="ADD CHANNEL">"ADD CHANNEL"</xref> or |
2170 |
|
<xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command where |
2171 |
|
the engine type should be assigned to. This command should be issued |
2172 |
|
after adding a new sampler channel and before any other control |
2173 |
|
commands on the new sampler channel. It can also be used to change |
2174 |
|
the engine type of a sampler channel. This command has (currently) no |
2175 |
|
way to define or force if a new engine instance should be created and |
2176 |
|
assigned to the given sampler channel or if an already existing |
2177 |
|
instance of that engine type, shared with other sampler channels, |
2178 |
|
should be used.</t> |
2179 |
|
|
2180 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2181 |
<t> |
<t> |
2208 |
</t> |
</t> |
2209 |
</section> |
</section> |
2210 |
|
|
2211 |
<section title="Getting all created sampler channel count"> |
<section title="Getting all created sampler channel count" anchor="GET CHANNELS"> |
2212 |
<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 |
2213 |
current amount of sampler channels, the front-end can send the |
current amount of sampler channels, the front-end can send the |
2214 |
following command:</t> |
following command:</t> |
2232 |
</t> |
</t> |
2233 |
</section> |
</section> |
2234 |
|
|
2235 |
<section title="Getting all created sampler channel list"> |
<section title="Getting all created sampler channel list" anchor="LIST CHANNELS"> |
2236 |
<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 |
2237 |
current list of sampler channels, the front-end can send the |
current list of sampler channels, the front-end can send the |
2238 |
following command:</t> |
following command:</t> |
2257 |
</t> |
</t> |
2258 |
</section> |
</section> |
2259 |
|
|
2260 |
<section title="Adding a new sampler channel"> |
<section title="Adding a new sampler channel" anchor="ADD CHANNEL"> |
2261 |
<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 |
2262 |
channel list by sending the following command:</t> |
channel list by sending the following command:</t> |
2263 |
<t> |
<t> |
2281 |
<list> |
<list> |
2282 |
<t>in case a new sampler channel could be added, where |
<t>in case a new sampler channel could be added, where |
2283 |
<sampler-channel> reflects the channel number of the new |
<sampler-channel> reflects the channel number of the new |
2284 |
created sampler channel which should the be used to set up |
created sampler channel which should be used to set up |
2285 |
the sampler channel by sending subsequent intialization |
the sampler channel by sending subsequent initialization |
2286 |
commands</t> |
commands</t> |
2287 |
</list> |
</list> |
2288 |
</t> |
</t> |
2309 |
</t> |
</t> |
2310 |
</section> |
</section> |
2311 |
|
|
2312 |
<section title="Removing a sampler channel"> |
<section title="Removing a sampler channel" anchor="REMOVE CHANNEL"> |
2313 |
<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> |
2314 |
<t> |
<t> |
2315 |
<list> |
<list> |
2317 |
</list> |
</list> |
2318 |
</t> |
</t> |
2319 |
|
|
2320 |
<t>This will decrement the sampler channel count by one and also |
<t>Where <sampler-channel> should be replaced by the |
2321 |
decrement the channel numbers of all subsequent sampler channels by |
number of the sampler channel as given by the |
2322 |
one.</t> |
<xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2323 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> |
2324 |
|
command. The channel numbers of all subsequent sampler channels |
2325 |
|
remain the same.</t> |
2326 |
|
|
2327 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2328 |
<t> |
<t> |
2355 |
</t> |
</t> |
2356 |
</section> |
</section> |
2357 |
|
|
2358 |
<section title="Getting all available engines"> |
<section title="Getting amount of available engines" anchor="GET AVAILABLE_ENGINES"> |
2359 |
<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> |
2360 |
<t> |
<t> |
2361 |
<list> |
<list> |
2362 |
<t>GET AVAILABLE_ENGINES</t> |
<t>GET AVAILABLE_ENGINES</t> |
2365 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2366 |
<t> |
<t> |
2367 |
<list> |
<list> |
2368 |
<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> |
|
2369 |
</list> |
</list> |
2370 |
</t> |
</t> |
2371 |
<t>Example:</t> |
<t>Example:</t> |
2372 |
<t> |
<t> |
2373 |
<list> |
<list> |
2374 |
<t>C: "GET AVAILABLE_ENGINES"</t> |
<t>C: "GET AVAILABLE_ENGINES"</t> |
2375 |
<t>S: "GigEngine,AkaiEngine,DLSEngine,JoesCustomEngine"</t> |
<t>S: "4"</t> |
2376 |
|
</list> |
2377 |
|
</t> |
2378 |
|
</section> |
2379 |
|
|
2380 |
|
<section title="Getting all available engines" anchor="LIST AVAILABLE_ENGINES"> |
2381 |
|
<t>The front-end can ask for a list of all available engines by sending the following command:</t> |
2382 |
|
<t> |
2383 |
|
<list> |
2384 |
|
<t>LIST AVAILABLE_ENGINES</t> |
2385 |
|
</list> |
2386 |
|
</t> |
2387 |
|
<t>Possible Answers:</t> |
2388 |
|
<t> |
2389 |
|
<list> |
2390 |
|
<t>LinuxSampler will answer by sending a comma separated list |
2391 |
|
of the engines' names encapsulated into apostrophes ('). |
2392 |
|
Engine names can consist of lower and upper cases, |
2393 |
|
digits and underlines ("_" character).</t> |
2394 |
|
</list> |
2395 |
|
</t> |
2396 |
|
<t>Example:</t> |
2397 |
|
<t> |
2398 |
|
<list> |
2399 |
|
<t>C: "LIST AVAILABLE_ENGINES"</t> |
2400 |
|
<t>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"</t> |
2401 |
</list> |
</list> |
2402 |
</t> |
</t> |
2403 |
</section> |
</section> |
2404 |
|
|
2405 |
<section title="Getting information about an engine"> |
<section title="Getting information about an engine" anchor="GET ENGINE INFO"> |
2406 |
<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 |
2407 |
sending the following command:</t> |
sending the following command:</t> |
2408 |
<t> |
<t> |
2411 |
</list> |
</list> |
2412 |
</t> |
</t> |
2413 |
<t>Where <engine-name> is an engine name as obtained by the |
<t>Where <engine-name> is an engine name as obtained by the |
2414 |
"GET AVAILABLE_ENGINES" command.</t> |
<xref target="LIST AVAILABLE_ENGINES"> |
2415 |
|
"LIST AVAILABLE_ENGINES"</xref> command.</t> |
2416 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2417 |
<t> |
<t> |
2418 |
<list> |
<list> |
2452 |
</t> |
</t> |
2453 |
</section> |
</section> |
2454 |
|
|
2455 |
<section title="Getting sampler channel information"> |
<section title="Getting sampler channel information" anchor="GET CHANNEL INFO"> |
2456 |
<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 |
2457 |
by sending the following command:</t> |
by sending the following command:</t> |
2458 |
<t> |
<t> |
2460 |
<t>GET CHANNEL INFO <sampler-channel></t> |
<t>GET CHANNEL INFO <sampler-channel></t> |
2461 |
</list> |
</list> |
2462 |
</t> |
</t> |
2463 |
<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 |
2464 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2465 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
2466 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2467 |
<t> |
<t> |
2468 |
<list> |
<list> |
2476 |
<list> |
<list> |
2477 |
<t>ENGINE_NAME - |
<t>ENGINE_NAME - |
2478 |
<list> |
<list> |
2479 |
<t>name of the engine that is deployed on the sampler |
<t>name of the engine that is associated with the sampler |
2480 |
channel, "NONE" if there's no engine deployed yet for |
channel, "NONE" if there's no engine associated yet for |
2481 |
this sampler channel</t> |
this sampler channel</t> |
2482 |
</list> |
</list> |
2483 |
</t> |
</t> |
2583 |
</t> |
</t> |
2584 |
</section> |
</section> |
2585 |
|
|
2586 |
<section title="Current number of active voices"> |
<section title="Current number of active voices" anchor="GET CHANNEL VOICE_COUNT"> |
2587 |
<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 |
2588 |
sampler channel by sending the following command:</t> |
sampler channel by sending the following command:</t> |
2589 |
<t> |
<t> |
2591 |
<t>GET CHANNEL VOICE_COUNT <sampler-channel></t> |
<t>GET CHANNEL VOICE_COUNT <sampler-channel></t> |
2592 |
</list> |
</list> |
2593 |
</t> |
</t> |
2594 |
<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 |
2595 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2596 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
2597 |
|
|
2598 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2599 |
<t> |
<t> |
2610 |
</t> |
</t> |
2611 |
</section> |
</section> |
2612 |
|
|
2613 |
<section title="Current number of active disk streams"> |
<section title="Current number of active disk streams" anchor="GET CHANNEL STREAM_COUNT"> |
2614 |
<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 |
2615 |
on a sampler channel by sending the following command:</t> |
on a sampler channel by sending the following command:</t> |
2616 |
<t> |
<t> |
2618 |
<t>GET CHANNEL STREAM_COUNT <sampler-channel></t> |
<t>GET CHANNEL STREAM_COUNT <sampler-channel></t> |
2619 |
</list> |
</list> |
2620 |
</t> |
</t> |
2621 |
<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 |
2622 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2623 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
2624 |
|
|
2625 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2626 |
<t> |
<t> |
2639 |
</t> |
</t> |
2640 |
</section> |
</section> |
2641 |
|
|
2642 |
<section title="Current fill state of disk stream buffers"> |
<section title="Current fill state of disk stream buffers" anchor="GET CHANNEL BUFFER_FILL"> |
2643 |
<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 |
2644 |
on a sampler channel by sending the following command:</t> |
on a sampler channel by sending the following command:</t> |
2645 |
<t> |
<t> |
2654 |
</list> |
</list> |
2655 |
</t> |
</t> |
2656 |
<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 |
2657 |
sampler channel number the front-end is interested in.</t> |
sampler channel number the front-end is interested in |
2658 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2659 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
2660 |
|
|
2661 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2662 |
<t> |
<t> |
2692 |
</t> |
</t> |
2693 |
</section> |
</section> |
2694 |
|
|
2695 |
<section title="Setting audio output device"> |
<section title="Setting audio output device" anchor="SET CHANNEL AUDIO_OUTPUT_DEVICE"> |
2696 |
<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 |
2697 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
2698 |
<t> |
<t> |
2700 |
<t>SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel> <audio-device-id></t> |
<t>SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel> <audio-device-id></t> |
2701 |
</list> |
</list> |
2702 |
</t> |
</t> |
2703 |
<t>Where <audio-device-id> is the numerical ID of the audio output |
<t>Where <sampler-channel> is the respective sampler channel |
2704 |
device and <sampler-channel> is the respective sampler channel |
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2705 |
number.</t> |
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
2706 |
|
<audio-device-id> is the numerical ID of the audio output device as given by the |
2707 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
2708 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
2709 |
|
command.</t> |
2710 |
|
|
2711 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2712 |
<t> |
<t> |
2738 |
</t> |
</t> |
2739 |
</section> |
</section> |
2740 |
|
|
2741 |
<section title="Setting audio output type"> |
<section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYP"> |
2742 |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
2743 |
|
|
2744 |
<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 |
2781 |
</t> |
</t> |
2782 |
</section> |
</section> |
2783 |
|
|
2784 |
<section title="Setting audio output channel"> |
<section title="Setting audio output channel" anchor="SET CHANNEL AUDIO_OUTPUT_CHANNEL"> |
2785 |
<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 |
2786 |
sampler channel by sending the following command:</t> |
sampler channel by sending the following command:</t> |
2787 |
<t> |
<t> |
2789 |
<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> |
2790 |
</list> |
</list> |
2791 |
</t> |
</t> |
2792 |
<t>Where <sampler-chan> is the sampler channel number, <audio-out> is the |
<t>Where <sampler-chan> is the sampler channel number |
2793 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2794 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, <audio-out> is the |
2795 |
numerical ID of the sampler channel's audio output channel which should be |
numerical ID of the sampler channel's audio output channel which should be |
2796 |
rerouted and <audio-in> is the numerical ID of the audio channel of the selected audio |
rerouted and <audio-in> is the numerical ID of the audio channel of the selected audio |
2797 |
output device where <audio-out> should be routed to.</t> |
output device where <audio-out> should be routed to.</t> |
2826 |
</t> |
</t> |
2827 |
</section> |
</section> |
2828 |
|
|
2829 |
<section title="Setting MIDI input device"> |
<section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE"> |
2830 |
<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 |
2831 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
2832 |
<t> |
<t> |
2834 |
<t>SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id></t> |
<t>SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id></t> |
2835 |
</list> |
</list> |
2836 |
</t> |
</t> |
2837 |
<t>Where <sampler-channel> is the sampler channel number and <midi-device-id> is the |
<t>Where <sampler-channel> is the sampler channel number |
2838 |
the numerical ID of the MIDI input device.</t> |
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2839 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command |
2840 |
|
and <midi-device-id> is the numerical ID of the MIDI input device as returned by the |
2841 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
2842 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command.</t> |
2843 |
|
|
2844 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2845 |
<t> |
<t> |
2871 |
</t> |
</t> |
2872 |
</section> |
</section> |
2873 |
|
|
2874 |
<section title="Setting MIDI input type"> |
<section title="Setting MIDI input type" anchor="SET CHANNEL MIDI_INPUT_TYPE"> |
2875 |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
2876 |
|
|
2877 |
<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 |
2914 |
</t> |
</t> |
2915 |
</section> |
</section> |
2916 |
|
|
2917 |
<section title="Setting MIDI input port"> |
<section title="Setting MIDI input port" anchor="SET CHANNEL MIDI_INPUT_PORT"> |
2918 |
<t>The front-end can alter the MIDI input port on a specific sampler |
<t>The front-end can alter the MIDI input port on a specific sampler |
2919 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
2920 |
<t> |
<t> |
2943 |
</t> |
</t> |
2944 |
<t>"ERR:<error-code>:<error-message>" - |
<t>"ERR:<error-code>:<error-message>" - |
2945 |
<list> |
<list> |
2946 |
<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> |
2947 |
</list> |
</list> |
2948 |
</t> |
</t> |
2949 |
</list> |
</list> |
2956 |
</t> |
</t> |
2957 |
</section> |
</section> |
2958 |
|
|
2959 |
<section title="Setting MIDI input channel"> |
<section title="Setting MIDI input channel" anchor="SET CHANNEL MIDI_INPUT_CHANNEL"> |
2960 |
<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 |
2961 |
listen to by sending the following command:</t> |
listen to by sending the following command:</t> |
2962 |
<t> |
<t> |
2998 |
</t> |
</t> |
2999 |
</section> |
</section> |
3000 |
|
|
3001 |
<section title="Setting channel volume"> |
<section title="Setting channel volume" anchor="SET CHANNEL VOLUME"> |
3002 |
<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 |
3003 |
the following command:</t> |
the following command:</t> |
3004 |
<t> |
<t> |
3041 |
</t> |
</t> |
3042 |
</section> |
</section> |
3043 |
|
|
3044 |
<section title="Resetting a sampler channel"> |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
3045 |
<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> |
3046 |
<t> |
<t> |
3047 |
<list> |
<list> |
3089 |
<section title="Controlling connection"> |
<section title="Controlling connection"> |
3090 |
<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> |
3091 |
|
|
3092 |
<section title="Register front-end for receiving event messages"> |
<section title="Register front-end for receiving event messages" anchor="SUBSCRIBE"> |
3093 |
<t>The front-end can register itself to the LinuxSampler application to |
<t>The front-end can register itself to the LinuxSampler application to |
3094 |
be informed about noteworthy events by sending this command:</t> |
be informed about noteworthy events by sending this command:</t> |
3095 |
<t> |
<t> |
3131 |
</t> |
</t> |
3132 |
</section> |
</section> |
3133 |
|
|
3134 |
<section title="Unregister front-end for not receiving event messages"> |
<section title="Unregister front-end for not receiving event messages" anchor="UNSUBSCRIBE"> |
3135 |
<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 |
3136 |
messages anymore by sending the following command:</t> |
messages anymore by sending the following command:</t> |
3137 |
<t> |
<t> |
3173 |
</t> |
</t> |
3174 |
</section> |
</section> |
3175 |
|
|
3176 |
<section title="Enable or disable echo of commands"> |
<section title="Enable or disable echo of commands" anchor="SET ECHO"> |
3177 |
<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> |
3178 |
<t> |
<t> |
3179 |
<list> |
<list> |
3211 |
</t> |
</t> |
3212 |
</section> |
</section> |
3213 |
|
|
3214 |
<section title="Close client connection"> |
<section title="Close client connection" anchor="QUIT"> |
3215 |
<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> |
3216 |
<t> |
<t> |
3217 |
<list> |
<list> |
3226 |
<section title="Global commands"> |
<section title="Global commands"> |
3227 |
<t>The following commands have global impact on the sampler.</t> |
<t>The following commands have global impact on the sampler.</t> |
3228 |
|
|
3229 |
<section title="Reset sampler"> |
<section title="Reset sampler" anchor="RESET"> |
3230 |
<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> |
3231 |
<t> |
<t> |
3232 |
<list> |
<list> |
3251 |
</list> |
</list> |
3252 |
</t> |
</t> |
3253 |
</section> |
</section> |
3254 |
|
|
3255 |
|
<section title="General sampler informations" anchor="GET SERVER INFO"> |
3256 |
|
<t>The client can ask for general informations about the LinuxSampler |
3257 |
|
instance by sending the following command:</t> |
3258 |
|
<t> |
3259 |
|
<list> |
3260 |
|
<t>GET SERVER INFO</t> |
3261 |
|
</list> |
3262 |
|
</t> |
3263 |
|
<t>Possible Answers:</t> |
3264 |
|
<t> |
3265 |
|
<list> |
3266 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
3267 |
|
Each answer line begins with the settings category name |
3268 |
|
followed by a colon and then a space character <SP> and finally |
3269 |
|
the info character string to that information category. At the |
3270 |
|
moment the following categories are defined: |
3271 |
|
</t> |
3272 |
|
<t> |
3273 |
|
<list> |
3274 |
|
<t>DESCRIPTION - |
3275 |
|
<list> |
3276 |
|
<t>arbitrary textual description about the sampler</t> |
3277 |
|
</list> |
3278 |
|
</t> |
3279 |
|
<t>VERSION - |
3280 |
|
<list> |
3281 |
|
<t>version of the sampler</t> |
3282 |
|
</list> |
3283 |
|
</t> |
3284 |
|
<t>PROTOCOL_VERSION - |
3285 |
|
<list> |
3286 |
|
<t>version of the LSCP specification the sampler |
3287 |
|
complies with (see <xref target="LSCP versioning" /> for details)</t> |
3288 |
|
</list> |
3289 |
|
</t> |
3290 |
|
</list> |
3291 |
|
</t> |
3292 |
|
</list> |
3293 |
|
</t> |
3294 |
|
<t>The mentioned fields above don't have to be in particular order. |
3295 |
|
Other fields might be added in future.</t> |
3296 |
|
</section> |
3297 |
</section> |
</section> |
3298 |
</section> |
</section> |
3299 |
|
|
3300 |
<section title="Command Syntax"> |
<section title="Command Syntax" anchor="command_syntax"> |
3301 |
<t>TODO: will soon automatically included from src/network/lscp.y, |
<t>TODO: will soon automatically included from src/network/lscp.y, |
3302 |
meanwhile have a look at that file to get the exact definition of |
meanwhile have a look at that file to get the exact definition of |
3303 |
the command syntax.</t> |
the command syntax.</t> |
3304 |
</section> |
</section> |
3305 |
|
|
3306 |
<section title="Events"> |
<section title="Events" anchor="events"> |
3307 |
<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> |
3308 |
|
|
3309 |
<section title="Number of sampler channels changed"> |
<section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL"> |
3310 |
<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 |
3311 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
3312 |
<t> |
<t> |
3313 |
<list> |
<list> |
3314 |
<t>SUBSCRIBE CHANNELS</t> |
<t>SUBSCRIBE CHANNEL_COUNT</t> |
3315 |
</list> |
</list> |
3316 |
</t> |
</t> |
3317 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
3318 |
<t> |
<t> |
3319 |
<list> |
<list> |
3320 |
<t>"NOTIFY:CHANNELS:<channels>"</t> |
<t>"NOTIFY:CHANNEL_COUNT:<channels>"</t> |
3321 |
</list> |
</list> |
3322 |
</t> |
</t> |
3323 |
<t>where <channels> will be replaced by the new number |
<t>where <channels> will be replaced by the new number |
3324 |
of sampler channels.</t> |
of sampler channels.</t> |
3325 |
</section> |
</section> |
3326 |
|
|
3327 |
<section title="Number of active voices changed"> |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
3328 |
<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 |
3329 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
3330 |
<t> |
<t> |
3343 |
active voices on that channel.</t> |
active voices on that channel.</t> |
3344 |
</section> |
</section> |
3345 |
|
|
3346 |
<section title="Number of active disk streams changed"> |
<section title="Number of active disk streams changed" anchor="SUBSCRIBE STREAM_COUNT"> |
3347 |
<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 |
3348 |
changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t> |
changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t> |
3349 |
<t> |
<t> |
3362 |
active disk streams on that channel.</t> |
active disk streams on that channel.</t> |
3363 |
</section> |
</section> |
3364 |
|
|
3365 |
<section title="Disk stream buffer fill state changed"> |
<section title="Disk stream buffer fill state changed" anchor="SUBSCRIBE BUFFER_FILL"> |
3366 |
<t>Client may want to be notified when the buffer fill state of a disk stream |
<t>Client may want to be notified when the buffer fill state of a disk stream |
3367 |
on the back-end changes by issuing the following command:</t> |
on the back-end changes by issuing the following command:</t> |
3368 |
<t> |
<t> |
3377 |
</list> |
</list> |
3378 |
</t> |
</t> |
3379 |
<t>where <sampler-channel> will be replaced by the sampler channel the |
<t>where <sampler-channel> will be replaced by the sampler channel the |
3380 |
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 |
3381 |
buffer fill data for this channel as described in 5.4.12 as if the |
buffer fill data for this channel as described in <xref target="GET CHANNEL BUFFER_FILL" /> |
3382 |
"GET CHANNEL BUFFER_FILL PERCENTAGE" was issued on this channel.</t> |
as if the <xref target="GET CHANNEL BUFFER_FILL"> |
3383 |
|
"GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t> |
3384 |
</section> |
</section> |
3385 |
|
|
3386 |
<section title="Channel information changed"> |
<section title="Channel information changed" anchor="SUBSCRIBE INFO"> |
3387 |
<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 |
3388 |
back-end changes by issuing the following command:</t> |
back-end by issuing the following command:</t> |
3389 |
<t> |
<t> |
3390 |
<list> |
<list> |
3391 |
<t>SUBSCRIBE INFO</t> |
<t>SUBSCRIBE CHANNEL_INFO</t> |
3392 |
</list> |
</list> |
3393 |
</t> |
</t> |
3394 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
3395 |
<t> |
<t> |
3396 |
<list> |
<list> |
3397 |
<t>"NOTIFY:INFO:<sampler-channel>"</t> |
<t>"NOTIFY:CHANNEL_INFO:<sampler-channel>"</t> |
3398 |
</list> |
</list> |
3399 |
</t> |
</t> |
3400 |
<t>where <sampler-channel> will be replaced by the sampler channel the |
<t>where <sampler-channel> will be replaced by the sampler channel the |
3405 |
message is sufficient here.</t> |
message is sufficient here.</t> |
3406 |
</section> |
</section> |
3407 |
|
|
3408 |
<section title="Miscellaneous and debugging events"> |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
3409 |
<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 |
3410 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |
3411 |
<t> |
<t> |
3441 |
<t>Rui Nuno Capela</t> |
<t>Rui Nuno Capela</t> |
3442 |
<t>Vladimir Senkov</t> |
<t>Vladimir Senkov</t> |
3443 |
<t>Mark Knecht</t> |
<t>Mark Knecht</t> |
3444 |
|
<t>Grigor Iliev</t> |
3445 |
</list> |
</list> |
3446 |
</t> |
</t> |
3447 |
</section> |
</section> |
3449 |
</middle> |
</middle> |
3450 |
|
|
3451 |
<back> |
<back> |
3452 |
<references>&rfc2119;</references> |
<references> |
3453 |
|
<reference anchor="RFC2119"> |
3454 |
|
<front> |
3455 |
|
<title>Key words for use in RFCs to Indicate Requirement Levels</title> |
3456 |
|
<author initials="S." surname="Bradner" fullname="Scott Bradner"> |
3457 |
|
<organization>Harvard University</organization> |
3458 |
|
</author> |
3459 |
|
<date year="1997"></date> |
3460 |
|
</front> |
3461 |
|
<seriesInfo name="RFC" value="2119" /> |
3462 |
|
<seriesInfo name="STD" value="1" /> |
3463 |
|
</reference> |
3464 |
|
<reference anchor="RFC793"> |
3465 |
|
<front> |
3466 |
|
<title>TRANSMISSION CONTROL PROTOCOL</title> |
3467 |
|
<author> |
3468 |
|
<organization>Defense Advanced Research Projects Agency</organization> |
3469 |
|
</author> |
3470 |
|
<date year="1981"></date> |
3471 |
|
</front> |
3472 |
|
<seriesInfo name="RFC" value="793" /> |
3473 |
|
<seriesInfo name="STD" value="1" /> |
3474 |
|
</reference> |
3475 |
|
</references> |
3476 |
</back> |
</back> |
3477 |
|
|
3478 |
</rfc> |
</rfc> |