13 |
<?rfc iprnotified="no" ?> |
<?rfc iprnotified="no" ?> |
14 |
<?rfc strict="yes" ?> |
<?rfc strict="yes" ?> |
15 |
|
|
16 |
<rfc category="std" ipr="full2026" docName="lscp.txt"> |
<rfc category="std" ipr="full2026" docName="LSCP 1.1"> |
17 |
<front> |
<front> |
18 |
<title>LinuxSampler Control Protocol</title> |
<title>LinuxSampler Control Protocol</title> |
19 |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
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="June" year="2004"/> |
<date month="September" 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 rules: |
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 |
159 |
referred in this document as "sampler channels". The channels |
referred in this document as "sampler channels". The channels |
160 |
are in such way virtual as they can be connected to an |
are in such way virtual as they can be connected to an |
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 |
168 |
there.</t> |
there.</t> |
169 |
</section> |
</section> |
170 |
|
|
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 |
254 |
<warning-message> and <error-message> are |
<warning-message> and <error-message> are |
255 |
human readable descriptions of the warning or error |
human readable descriptions of the warning or error |
256 |
respectively.</t> |
respectively.</t> |
257 |
|
<t>Examples:</t> |
258 |
|
<t> |
259 |
|
<list> |
260 |
|
<t>C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0</t> |
261 |
|
<t>S: "WRN:32:This is a 24 bit patch which is not supported natively yet."</t> |
262 |
|
</list> |
263 |
|
</t> |
264 |
|
<t> |
265 |
|
<list> |
266 |
|
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"</t> |
267 |
|
<t>S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter 'EAR'."</t> |
268 |
|
</list> |
269 |
|
</t> |
270 |
|
<t> |
271 |
|
<list> |
272 |
|
<t>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"</t> |
273 |
|
<t>S: "ERR:9:There is no audio output device with index 123456."</t> |
274 |
|
</list> |
275 |
|
</t> |
276 |
<t>Normal result sets could be:</t> |
<t>Normal result sets could be:</t> |
277 |
<t> |
<t> |
278 |
<list style="numbers"> |
<list style="numbers"> |
291 |
<t>"OK"</t> |
<t>"OK"</t> |
292 |
</list> |
</list> |
293 |
</t> |
</t> |
294 |
|
<t>Example:</t> |
295 |
|
<t> |
296 |
|
<list> |
297 |
|
<t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"</t> |
298 |
|
<t>S: "OK"</t> |
299 |
|
</list> |
300 |
|
</t> |
301 |
<t>Single line result sets are command specific. One |
<t>Single line result sets are command specific. One |
302 |
example of a single line result set is an empty line. |
example of a single line result set is an empty line. |
303 |
Multi-line result sets are command specific and may |
Multi-line result sets are command specific and may |
308 |
<t>"."</t> |
<t>"."</t> |
309 |
</list> |
</list> |
310 |
</t> |
</t> |
311 |
|
<t>Example:</t> |
312 |
|
<t> |
313 |
|
<list> |
314 |
|
<t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t> |
315 |
|
<t>S: "DRIVER: ALSA"</t> |
316 |
|
<t> "CHANNELS: 2"</t> |
317 |
|
<t> "SAMPLERATE: 44100"</t> |
318 |
|
<t> "ACTIVE: true"</t> |
319 |
|
<t> "FRAGMENTS: 2"</t> |
320 |
|
<t> "FRAGMENTSIZE: 128"</t> |
321 |
|
<t> "CARD: '0,0'"</t> |
322 |
|
<t> "."</t> |
323 |
|
</list> |
324 |
|
</t> |
325 |
<t>In addition to above mentioned formats, warnings and |
<t>In addition to above mentioned formats, warnings and |
326 |
empty result sets MAY be indexed. In this case, they |
empty result sets MAY be indexed. In this case, they |
327 |
have the following formats respectively:</t> |
have the following formats respectively:</t> |
336 |
related to or other integer value.</t> |
related to or other integer value.</t> |
337 |
<t>Each line of the result set MUST end with |
<t>Each line of the result set MUST end with |
338 |
<CRLF>.</t> |
<CRLF>.</t> |
339 |
|
<t>Examples:</t> |
340 |
|
<t> |
341 |
|
<list> |
342 |
|
<t>C: "ADD CHANNEL"</t> |
343 |
|
<t>S: "OK[12]"</t> |
344 |
|
</list> |
345 |
|
</t> |
346 |
|
<t> |
347 |
|
<list> |
348 |
|
<t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"</t> |
349 |
|
<t>S: "WRN[0]:32:Sample rate not supported, using 44100 instead."</t> |
350 |
|
</list> |
351 |
|
</t> |
352 |
</section> |
</section> |
353 |
</section> |
</section> |
354 |
<section title="Subscribe/notify communication method"> |
<section title="Subscribe/notify communication method"> |
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 |
463 |
</section> |
</section> |
464 |
</section> |
</section> |
465 |
|
|
466 |
<section title="Description for control commands"> |
<section title="Description for control commands" anchor="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 |
|
|
482 |
<section title="Configuring audio drivers"> |
<section title="Configuring audio drivers"> |
483 |
<t>Instances of drivers in LinuxSampler are called devices. |
<t>Instances of drivers in LinuxSampler are called devices. |
484 |
You can use multiple audio devices simultaneously, e.g. to |
You can use multiple audio devices simultaneously, e.g. to |
485 |
output the sound of one sampler channel using the Alsa audio |
output the sound of one sampler channel using the ALSA audio |
486 |
output driver, and on another sampler channel you might want |
output driver, and on another sampler channel you might want |
487 |
to use the Jack audio output driver. For particular audio |
to use the JACK audio output driver. For particular audio |
488 |
output systems it's also possible to create several devices |
output systems it's also possible to create several devices |
489 |
of the same audio output driver, e.g. two separate Alsa |
of the same audio output driver, e.g. two separate ALSA |
490 |
audio output devices for using two different sound cards at |
audio output devices for using two different sound cards at |
491 |
the same time. This chapter describes all commands to |
the same time. This chapter describes all commands to |
492 |
configure LinuxSampler's audio output devices and their |
configure LinuxSampler's audio output devices and their |
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> |
623 |
<t>Example:</t> |
<t>Example:</t> |
624 |
<t> |
<t> |
625 |
<list> |
<list> |
626 |
<t>C: "GET AUDIO_OUTPUT_DRIVER INFO Alsa"</t> |
<t>C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"</t> |
627 |
<t>S: "DESCRIPTION: Advanced Linux Sound |
<t>S: "DESCRIPTION: Advanced Linux Sound |
628 |
Architecture"</t> |
Architecture"</t> |
629 |
<t> "VERSION: 1.0"</t> |
<t> "VERSION: 1.0"</t> |
630 |
<t> "PARAMETERS: |
<t> "PARAMETERS: |
631 |
driver,channels,samplerate,active,fragments, |
DRIVER,CHANNELS,SAMPLERATE,ACTIVE,FRAGMENTS, |
632 |
fragmentsize,card"</t> |
FRAGMENTSIZE,CARD"</t> |
633 |
<t> "."</t> |
<t> "."</t> |
634 |
</list> |
</list> |
635 |
</t> |
</t> |
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 |
661 |
<t> |
<t> |
662 |
<list> |
<list> |
663 |
<t>LinuxSampler will answer by sending a |
<t>LinuxSampler will answer by sending a |
664 |
&lz;CRLF> separated list. |
<CRLF> separated list. |
665 |
Each answer line begins with the information category name |
Each answer line begins with the information category name |
666 |
followed by a colon and then a space character <SP> and |
followed by a colon and then a space character <SP> and |
667 |
finally |
finally |
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 |
728 |
driver (like the Alsa driver) offers parameters 'card' |
driver (like the ALSA driver) offers parameters 'card' |
729 |
and 'samplerate' then parameter 'samplerate' would |
and 'samplerate' then parameter 'samplerate' would |
730 |
depend on 'card' because the possible values for |
depend on 'card' because the possible values for |
731 |
'samplerate' depends on the sound card which can be |
'samplerate' depends on the sound card which can be |
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 (') |
767 |
</list> |
</list> |
768 |
</t> |
</t> |
769 |
|
|
770 |
<t>POSSIBILITES - |
<t>POSSIBILITIES - |
771 |
<list> |
<list> |
772 |
<t>comma separated list of possible values for this |
<t>comma separated list of possible values for this |
773 |
parameter, character strings are encapsulated into |
parameter, character strings are encapsulated into |
783 |
<t>Examples:</t> |
<t>Examples:</t> |
784 |
<t> |
<t> |
785 |
<list> |
<list> |
786 |
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO Alsa card"</t> |
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"</t> |
787 |
<t>S: "DESCRIPTION: sound card to be used"</t> |
<t>S: "DESCRIPTION: sound card to be used"</t> |
788 |
<t> "TYPE: STRING"</t> |
<t> "TYPE: STRING"</t> |
789 |
<t> "MANDATORY: false"</t> |
<t> "MANDATORY: false"</t> |
790 |
<t> "FIX: true"</t> |
<t> "FIX: true"</t> |
791 |
<t> "MULTIPLICITY: false"</t> |
<t> "MULTIPLICITY: false"</t> |
792 |
<t> "DEFAULT: '0,0'"</t> |
<t> "DEFAULT: '0,0'"</t> |
793 |
<t> "POSSIBILITES: '0,0','1,0','2,0'"</t> |
<t> "POSSIBILITIES: '0,0','1,0','2,0'"</t> |
794 |
<t> "."</t> |
<t> "."</t> |
795 |
</list> |
</list> |
796 |
</t> |
</t> |
797 |
<t> |
<t> |
798 |
<list> |
<list> |
799 |
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO Alsa samplerate"</t> |
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"</t> |
800 |
<t>S: "DESCRIPTION: output sample rate in Hz"</t> |
<t>S: "DESCRIPTION: output sample rate in Hz"</t> |
801 |
<t> "TYPE: INT"</t> |
<t> "TYPE: INT"</t> |
802 |
<t> "MANDATORY: false"</t> |
<t> "MANDATORY: false"</t> |
809 |
</t> |
</t> |
810 |
<t> |
<t> |
811 |
<list> |
<list> |
812 |
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO Alsa samplerate card='0,0'"</t> |
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE CARD='0,0'"</t> |
813 |
<t>S: "DESCRIPTION: output sample rate in Hz"</t> |
<t>S: "DESCRIPTION: output sample rate in Hz"</t> |
814 |
<t> "TYPE: INT"</t> |
<t> "TYPE: INT"</t> |
815 |
<t> "MANDATORY: false"</t> |
<t> "MANDATORY: false"</t> |
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 |
872 |
<t>Examples:</t> |
<t>Examples:</t> |
873 |
<t> |
<t> |
874 |
<list> |
<list> |
875 |
<t>C: "CREATE AUDIO_OUTPUT_DEVICE Alsa"</t> |
<t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"</t> |
876 |
<t>S: "OK[0]"</t> |
<t>S: "OK[0]"</t> |
877 |
</list> |
</list> |
878 |
</t> |
</t> |
879 |
<t> |
<t> |
880 |
<list> |
<list> |
881 |
<t>C: "CREATE AUDIO_OUTPUT_DEVICE Alsa card='2,0' samplerate=96000"</t> |
<t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"</t> |
882 |
<t>S: "OK[1]"</t> |
<t>S: "OK[1]"</t> |
883 |
</list> |
</list> |
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> |
983 |
<t>GET AUDIO_OUTPUT_DEVICE INFO <device-id></t> |
<t>GET AUDIO_OUTPUT_DEVICE INFO <device-id></t> |
984 |
</list> |
</list> |
985 |
</t> |
</t> |
986 |
<t>Where <device-id> should be replaced by be 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 |
"GET 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 |
996 |
information categories are defined (independently of device):</t> |
information categories are defined (independently of device):</t> |
997 |
<t> |
<t> |
998 |
<list> |
<list> |
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> |
1008 |
<t>channels - |
<t>CHANNELS - |
1009 |
<list> |
<list> |
1010 |
<t>amount of audio output channels this device currently |
<t>amount of audio output channels this device currently |
1011 |
offers</t> |
offers</t> |
1012 |
</list> |
</list> |
1013 |
</t> |
</t> |
1014 |
<t>samplerate - |
<t>SAMPLERATE - |
1015 |
<list> |
<list> |
1016 |
<t>playback sample rate the device uses</t> |
<t>playback sample rate the device uses</t> |
1017 |
</list> |
</list> |
1018 |
</t> |
</t> |
1019 |
<t>active - |
<t>ACTIVE - |
1020 |
<list> |
<list> |
1021 |
<t>either true or false, if false then the audio device is |
<t>either true or false, if false then the audio device is |
1022 |
inactive and doesn't output any sound, nor do the |
inactive and doesn't output any sound, nor do the |
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> |
1038 |
<t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t> |
<t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t> |
1039 |
<t>S: "driver: Alsa"</t> |
<t>S: "DRIVER: ALSA"</t> |
1040 |
<t> "channels: 2"</t> |
<t> "CHANNELS: 2"</t> |
1041 |
<t> "samplerate: 44100"</t> |
<t> "SAMPLERATE: 44100"</t> |
1042 |
<t> "active: true"</t> |
<t> "ACTIVE: true"</t> |
1043 |
<t> "fragments: 2"</t> |
<t> "FRAGMENTS: 2"</t> |
1044 |
<t> "fragmentsize: 128"</t> |
<t> "FRAGMENTSIZE: 128"</t> |
1045 |
<t> "card: '0,0'"</t> |
<t> "CARD: '0,0'"</t> |
1046 |
<t> "."</t> |
<t> "."</t> |
1047 |
</list> |
</list> |
1048 |
</t> |
</t> |
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> |
1088 |
<t>Example:</t> |
<t>Example:</t> |
1089 |
<t> |
<t> |
1090 |
<list> |
<list> |
1091 |
<t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 fragmentsize=128"</t> |
<t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"</t> |
1092 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
1093 |
</list> |
</list> |
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> |
1134 |
</t> |
</t> |
1135 |
<t>MIX_CHANNEL_DESTINATION - |
<t>MIX_CHANNEL_DESTINATION - |
1136 |
<list> |
<list> |
1137 |
<t>reflects the real audio channel (of the same audio |
<t>numerical ID (positive integer including 0) |
1138 |
|
which reflects the real audio channel (of the same audio |
1139 |
output device) this mix channel refers to, means where |
output device) this mix channel refers to, means where |
1140 |
the audio signal actually will be routed / added to |
the audio signal actually will be routed / added to |
1141 |
(only returned in case the audio channel is mix channel)</t> |
(only returned in case the audio channel is mix channel)</t> |
1188 |
<t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"</t> |
<t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"</t> |
1189 |
<t>S: "NAME: 'ardour (left)'"</t> |
<t>S: "NAME: 'ardour (left)'"</t> |
1190 |
<t> "IS_MIX_CHANNEL: false"</t> |
<t> "IS_MIX_CHANNEL: false"</t> |
1191 |
<t> "jack_bindings: 'ardour:0'"</t> |
<t> "JACK_BINDINGS: 'ardour:0'"</t> |
1192 |
<t> "."</t> |
<t> "."</t> |
1193 |
</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> |
1272 |
parameter)</t> |
parameter)</t> |
1273 |
</list> |
</list> |
1274 |
</t> |
</t> |
1275 |
<t>POSSIBILITES - |
<t>POSSIBILITIES - |
1276 |
<list> |
<list> |
1277 |
<t>comma separated list of possible values for this |
<t>comma separated list of possible values for this |
1278 |
parameter, character strings are encapsulated into |
parameter, character strings are encapsulated into |
1289 |
<t>Example:</t> |
<t>Example:</t> |
1290 |
<t> |
<t> |
1291 |
<list> |
<list> |
1292 |
<t>C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 jack_bindings"</t> |
<t>C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"</t> |
1293 |
<t>S: "DESCRIPTION: bindings to other Jack clients"</t> |
<t>S: "DESCRIPTION: bindings to other JACK clients"</t> |
1294 |
<t> "TYPE: STRING"</t> |
<t> "TYPE: STRING"</t> |
1295 |
<t> "FIX: false"</t> |
<t> "FIX: false"</t> |
1296 |
<t> "MULTIPLICITY: true"</t> |
<t> "MULTIPLICITY: true"</t> |
1297 |
<t> "POSSIBILITES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t> |
<t> "POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t> |
1298 |
<t> "."</t> |
<t> "."</t> |
1299 |
</list> |
</list> |
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> |
1338 |
<t>Example:</t> |
<t>Example:</t> |
1339 |
<t> |
<t> |
1340 |
<list> |
<list> |
1341 |
<t>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 jack_bindings='PCM:0'"</t> |
<t>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:0'"</t> |
1342 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
1343 |
</list> |
</list> |
1344 |
</t> |
</t> |
1354 |
<section title="Configuring MIDI input drivers"> |
<section title="Configuring MIDI input drivers"> |
1355 |
<t>Instances of drivers in LinuxSampler are called devices. You can use |
<t>Instances of drivers in LinuxSampler are called devices. You can use |
1356 |
multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as |
multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as |
1357 |
MIDI input on one sampler channel and Alsa as MIDI input on another sampler |
MIDI input on one sampler channel and ALSA as MIDI input on another sampler |
1358 |
channel. For particular MIDI input systems it's also possible to create |
channel. For particular MIDI input systems it's also possible to create |
1359 |
several devices of the same MIDI input type. This chapter describes all |
several devices of the same MIDI input type. This chapter describes all |
1360 |
commands to configure LinuxSampler's MIDI input devices and their parameters.</t> |
commands to configure LinuxSampler's MIDI input devices and their parameters.</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> |
1474 |
|
|
1475 |
<t> |
<t> |
1476 |
<list> |
<list> |
1477 |
<t>C: "GET MIDI_INPUT_DRIVER INFO Alsa"</t> |
<t>C: "GET MIDI_INPUT_DRIVER INFO ALSA"</t> |
1478 |
<t>S: "DESCRIPTION: Advanced Linux Sound Architecture"</t> |
<t>S: "DESCRIPTION: Advanced Linux Sound Architecture"</t> |
1479 |
<t> "VERSION: 1.0"</t> |
<t> "VERSION: 1.0"</t> |
1480 |
<t> "PARAMETERS: driver,active"</t> |
<t> "PARAMETERS: DRIVER,ACTIVE"</t> |
1481 |
<t> "."</t> |
<t> "."</t> |
1482 |
</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 |
1571 |
driver (like the Alsa driver) offers parameters 'card' |
driver (like the ALSA driver) offers parameters 'card' |
1572 |
and 'samplerate' then parameter 'samplerate' would |
and 'samplerate' then parameter 'samplerate' would |
1573 |
depend on 'card' because the possible values for |
depend on 'card' because the possible values for |
1574 |
'samplerate' depends on the sound card which can be |
'samplerate' depends on the sound card which can be |
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 (') |
1610 |
</list> |
</list> |
1611 |
</t> |
</t> |
1612 |
|
|
1613 |
<t>POSSIBILITES - |
<t>POSSIBILITIES - |
1614 |
<list> |
<list> |
1615 |
<t>comma separated list of possible values for this |
<t>comma separated list of possible values for this |
1616 |
parameter, character strings are encapsulated into |
parameter, character strings are encapsulated into |
1626 |
<t>Example:</t> |
<t>Example:</t> |
1627 |
<t> |
<t> |
1628 |
<list> |
<list> |
1629 |
<t>C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO Alsa active"</t> |
<t>C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"</t> |
1630 |
<t>S: "DESCRIPTION: Whether device is enabled"</t> |
<t>S: "DESCRIPTION: Whether device is enabled"</t> |
1631 |
<t> "TYPE: BOOL"</t> |
<t> "TYPE: BOOL"</t> |
1632 |
<t> "MANDATORY: false"</t> |
<t> "MANDATORY: false"</t> |
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 |
1682 |
<t>Example:</t> |
<t>Example:</t> |
1683 |
<t> |
<t> |
1684 |
<list> |
<list> |
1685 |
<t>C: "CREATE MIDI_INPUT_DEVICE Alsa"</t> |
<t>C: "CREATE MIDI_INPUT_DEVICE ALSA"</t> |
1686 |
<t>S: "OK[0]"</t> |
<t>S: "OK[0]"</t> |
1687 |
</list> |
</list> |
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> |
1842 |
<t> |
<t> |
1843 |
<list> |
<list> |
1844 |
<t>C: "GET MIDI_INPUT_DEVICE INFO 0"</t> |
<t>C: "GET MIDI_INPUT_DEVICE INFO 0"</t> |
1845 |
<t>S: "driver: Alsa"</t> |
<t>S: "DRIVER: ALSA"</t> |
1846 |
<t> "active: true"</t> |
<t> "ACTIVE: true"</t> |
1847 |
<t> "."</t> |
<t> "."</t> |
1848 |
</list> |
</list> |
1849 |
</t> |
</t> |
1850 |
</section> |
</section> |
1851 |
|
|
1852 |
<section title="Changing settings of audio output 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> |
1889 |
<t>Example:</t> |
<t>Example:</t> |
1890 |
<t> |
<t> |
1891 |
<list> |
<list> |
1892 |
<t>C: "SET MIDI_INPUT_DEVICE PARAMETER 0 ACTIVE=false"</t> |
<t>C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"</t> |
1893 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
1894 |
</list> |
</list> |
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> |
1932 |
<t> |
<t> |
1933 |
<list> |
<list> |
1934 |
<t>C: "GET MIDI_INPUT_PORT INFO 0 0"</t> |
<t>C: "GET MIDI_INPUT_PORT INFO 0 0"</t> |
1935 |
<t>S: "name: 'Masterkeyboard'"</t> |
<t>S: "NAME: 'Masterkeyboard'"</t> |
1936 |
<t> "alsa_seq_bindings: '64:0'"</t> |
<t> "ALSA_SEQ_BINDINGS: '64:0'"</t> |
1937 |
<t> "."</t> |
<t> "."</t> |
1938 |
</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 "GET 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> |
2016 |
parameter)</t> |
parameter)</t> |
2017 |
</list> |
</list> |
2018 |
</t> |
</t> |
2019 |
<t>POSSIBILITES - |
<t>POSSIBILITIES - |
2020 |
<list> |
<list> |
2021 |
<t>comma separated list of possible values for this |
<t>comma separated list of possible values for this |
2022 |
parameter, character strings are encapsulated into |
parameter, character strings are encapsulated into |
2033 |
<t>Example:</t> |
<t>Example:</t> |
2034 |
<t> |
<t> |
2035 |
<list> |
<list> |
2036 |
<t>C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 alsa_seq_bindings"</t> |
<t>C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"</t> |
2037 |
<t>S: "DESCRIPTION: bindings to other Alsa sequencer clients"</t> |
<t>S: "DESCRIPTION: bindings to other ALSA sequencer clients"</t> |
2038 |
<t>"TYPE: STRING"</t> |
<t> "TYPE: STRING"</t> |
2039 |
<t> "FIX: false"</t> |
<t> "FIX: false"</t> |
2040 |
<t> "MULTIPLICITY: true"</t> |
<t> "MULTIPLICITY: true"</t> |
2041 |
<t> "POSSIBILITES: '64:0','68:0','68:1'"</t> |
<t> "POSSIBILITIES: '64:0','68:0','68:1'"</t> |
2042 |
<t> "."</t> |
<t> "."</t> |
2043 |
</list> |
</list> |
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> |
2051 |
<t>SET MIDI_INPUT_PORT PARAMETER <device-id> <port> <key>=<value></t> |
<t>SET MIDI_INPUT_PORT_PARAMETER <device-id> <port> <key>=<value></t> |
2052 |
</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> |
2162 |
</list> |
</list> |
2163 |
</t> |
</t> |
2164 |
|
|
2165 |
<t>Where <engine-name> is usually the C++ class name of the engine |
<t>Where <engine-name> is an engine name as obtained by the |
2166 |
implementation 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' C++ class names.</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> |
</list> |
2377 |
</t> |
</t> |
2378 |
</section> |
</section> |
2379 |
|
|
2380 |
<section title="Getting information about an engine"> |
<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> |
2402 |
|
</t> |
2403 |
|
</section> |
2404 |
|
|
2405 |
|
<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> |
2410 |
<t>GET ENGINE INFO <engine-name></t> |
<t>GET ENGINE INFO <engine-name></t> |
2411 |
</list> |
</list> |
2412 |
</t> |
</t> |
2413 |
<t>Where <engine-name> is usually the C++ class name of the engine implementation.</t> |
<t>Where <engine-name> is an engine name as obtained by the |
2414 |
|
<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> |
2419 |
<t>LinuxSampler will answer by sending <> separated list. |
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
2420 |
Each answer line begins with the information category name |
Each answer line begins with the information category name |
2421 |
followed by a colon and then a space character <SP> and finally |
followed by a colon and then a space character <SP> and finally |
2422 |
the info character string to that info category. At the moment |
the info character string to that info category. At the moment |
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> |
2518 |
<t>the instrument index number of the loaded instrument</t> |
<t>the instrument index number of the loaded instrument</t> |
2519 |
</list> |
</list> |
2520 |
</t> |
</t> |
2521 |
|
<t>INSTRUMENT_NAME - |
2522 |
|
<list> |
2523 |
|
<t>the instrument name of the loaded instrument</t> |
2524 |
|
</list> |
2525 |
|
</t> |
2526 |
<t>INSTRUMENT_STATUS - |
<t>INSTRUMENT_STATUS - |
2527 |
<list> |
<list> |
2528 |
<t>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative |
<t>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative |
2556 |
1.0 means amplification)</t> |
1.0 means amplification)</t> |
2557 |
</list> |
</list> |
2558 |
</t> |
</t> |
2559 |
|
<t>MUTE - |
2560 |
|
<list> |
2561 |
|
<t>Determines whether the channel is muted, "true" if the |
2562 |
|
channel is muted, "false" if the channel is not muted, and |
2563 |
|
"MUTED_BY_SOLO" if the channel is muted because of the |
2564 |
|
presence of a solo channel and will be unmuted when |
2565 |
|
there are no solo channels left</t> |
2566 |
|
</list> |
2567 |
|
</t> |
2568 |
|
<t>SOLO - |
2569 |
|
<list> |
2570 |
|
<t>Determines whether this is a solo channel, "true" if |
2571 |
|
the channel is a solo channel; "false" otherwise</t> |
2572 |
|
</list> |
2573 |
|
</t> |
2574 |
</list> |
</list> |
2575 |
</t> |
</t> |
2576 |
</list> |
</list> |
2588 |
<t> "AUDIO_OUTPUT_ROUTING: 0,1"</t> |
<t> "AUDIO_OUTPUT_ROUTING: 0,1"</t> |
2589 |
<t> "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"</t> |
<t> "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"</t> |
2590 |
<t> "INSTRUMENT_NR: 0"</t> |
<t> "INSTRUMENT_NR: 0"</t> |
2591 |
|
<t> "INSTRUMENT_NAME: Fazioli Piano"</t> |
2592 |
<t> "INSTRUMENT_STATUS: 100"</t> |
<t> "INSTRUMENT_STATUS: 100"</t> |
2593 |
<t> "MIDI_INPUT_DEVICE: 0"</t> |
<t> "MIDI_INPUT_DEVICE: 0"</t> |
2594 |
<t> "MIDI_INPUT_PORT: 0"</t> |
<t> "MIDI_INPUT_PORT: 0"</t> |
2598 |
</t> |
</t> |
2599 |
</section> |
</section> |
2600 |
|
|
2601 |
<section title="Current number of active voices"> |
<section title="Current number of active voices" anchor="GET CHANNEL VOICE_COUNT"> |
2602 |
<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 |
2603 |
sampler channel by sending the following command:</t> |
sampler channel by sending the following command:</t> |
2604 |
<t> |
<t> |
2606 |
<t>GET CHANNEL VOICE_COUNT <sampler-channel></t> |
<t>GET CHANNEL VOICE_COUNT <sampler-channel></t> |
2607 |
</list> |
</list> |
2608 |
</t> |
</t> |
2609 |
<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 |
2610 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2611 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
2612 |
|
|
2613 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2614 |
<t> |
<t> |
2625 |
</t> |
</t> |
2626 |
</section> |
</section> |
2627 |
|
|
2628 |
<section title="Current number of active disk streams"> |
<section title="Current number of active disk streams" anchor="GET CHANNEL STREAM_COUNT"> |
2629 |
<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 |
2630 |
on a sampler channel by sending the following command:</t> |
on a sampler channel by sending the following command:</t> |
2631 |
<t> |
<t> |
2633 |
<t>GET CHANNEL STREAM_COUNT <sampler-channel></t> |
<t>GET CHANNEL STREAM_COUNT <sampler-channel></t> |
2634 |
</list> |
</list> |
2635 |
</t> |
</t> |
2636 |
<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 |
2637 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2638 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
2639 |
|
|
2640 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2641 |
<t> |
<t> |
2654 |
</t> |
</t> |
2655 |
</section> |
</section> |
2656 |
|
|
2657 |
<section title="Current fill state of disk stream buffers"> |
<section title="Current fill state of disk stream buffers" anchor="GET CHANNEL BUFFER_FILL"> |
2658 |
<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 |
2659 |
on a sampler channel by sending the following command:</t> |
on a sampler channel by sending the following command:</t> |
2660 |
<t> |
<t> |
2669 |
</list> |
</list> |
2670 |
</t> |
</t> |
2671 |
<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 |
2672 |
sampler channel number the front-end is interested in.</t> |
sampler channel number the front-end is interested in |
2673 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2674 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
2675 |
|
|
2676 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2677 |
<t> |
<t> |
2707 |
</t> |
</t> |
2708 |
</section> |
</section> |
2709 |
|
|
2710 |
<section title="Setting audio output device"> |
<section title="Setting audio output device" anchor="SET CHANNEL AUDIO_OUTPUT_DEVICE"> |
2711 |
<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 |
2712 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
2713 |
<t> |
<t> |
2715 |
<t>SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel> <audio-device-id></t> |
<t>SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel> <audio-device-id></t> |
2716 |
</list> |
</list> |
2717 |
</t> |
</t> |
2718 |
<t>Where <audio-device-id> is the numerical ID of the audio output |
<t>Where <sampler-channel> is the respective sampler channel |
2719 |
device and <sampler-channel> is the respective sampler channel |
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2720 |
number.</t> |
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
2721 |
|
<audio-device-id> is the numerical ID of the audio output device as given by the |
2722 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
2723 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
2724 |
|
command.</t> |
2725 |
|
|
2726 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2727 |
<t> |
<t> |
2753 |
</t> |
</t> |
2754 |
</section> |
</section> |
2755 |
|
|
2756 |
<section title="Setting audio output type"> |
<section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYP"> |
2757 |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
2758 |
|
|
2759 |
<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 |
2763 |
<t>SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-type></t> |
<t>SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-type></t> |
2764 |
</list> |
</list> |
2765 |
</t> |
</t> |
2766 |
<t>Where <audio-output-type> is currently either "Alsa" or "Jack" and |
<t>Where <audio-output-type> is currently either "ALSA" or "JACK" and |
2767 |
<sampler-channel> is the respective sampler channel number.</t> |
<sampler-channel> is the respective sampler channel number.</t> |
2768 |
|
|
2769 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2796 |
</t> |
</t> |
2797 |
</section> |
</section> |
2798 |
|
|
2799 |
<section title="Setting audio output channel"> |
<section title="Setting audio output channel" anchor="SET CHANNEL AUDIO_OUTPUT_CHANNEL"> |
2800 |
<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 |
2801 |
sampler channel by sending the following command:</t> |
sampler channel by sending the following command:</t> |
2802 |
<t> |
<t> |
2804 |
<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> |
2805 |
</list> |
</list> |
2806 |
</t> |
</t> |
2807 |
<t>Where <sampler-chan> is the sampler channel, <audio-out> is the |
<t>Where <sampler-chan> is the sampler channel number |
2808 |
sampler channel's audio output channel which should be |
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2809 |
rerouted and <audio-in> the audio channel of the selected audio |
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, <audio-out> is the |
2810 |
|
numerical ID of the sampler channel's audio output channel which should be |
2811 |
|
rerouted and <audio-in> is the numerical ID of the audio channel of the selected audio |
2812 |
output device where <audio-out> should be routed to.</t> |
output device where <audio-out> should be routed to.</t> |
2813 |
|
|
2814 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2841 |
</t> |
</t> |
2842 |
</section> |
</section> |
2843 |
|
|
2844 |
<section title="Setting MIDI input device"> |
<section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE"> |
2845 |
<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 |
2846 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
2847 |
<t> |
<t> |
2849 |
<t>SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id></t> |
<t>SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id></t> |
2850 |
</list> |
</list> |
2851 |
</t> |
</t> |
2852 |
<t></t> |
<t>Where <sampler-channel> is the sampler channel number |
2853 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2854 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command |
2855 |
|
and <midi-device-id> is the numerical ID of the MIDI input device as returned by the |
2856 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
2857 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command.</t> |
2858 |
|
|
2859 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2860 |
<t> |
<t> |
2886 |
</t> |
</t> |
2887 |
</section> |
</section> |
2888 |
|
|
2889 |
<section title="Setting MIDI input type"> |
<section title="Setting MIDI input type" anchor="SET CHANNEL MIDI_INPUT_TYPE"> |
2890 |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
2891 |
|
|
2892 |
<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 |
2896 |
<t>SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type></t> |
<t>SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type></t> |
2897 |
</list> |
</list> |
2898 |
</t> |
</t> |
2899 |
<t>Where <midi-input-type> is currently only "Alsa" and |
<t>Where <midi-input-type> is currently only "ALSA" and |
2900 |
<sampler-channel> is the respective sampler channel number.</t> |
<sampler-channel> is the respective sampler channel number.</t> |
2901 |
|
|
2902 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2929 |
</t> |
</t> |
2930 |
</section> |
</section> |
2931 |
|
|
2932 |
<section title="Setting MIDI input port"> |
<section title="Setting MIDI input port" anchor="SET CHANNEL MIDI_INPUT_PORT"> |
2933 |
<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 |
2934 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
2935 |
<t> |
<t> |
2936 |
<list> |
<list> |
2958 |
</t> |
</t> |
2959 |
<t>"ERR:<error-code>:<error-message>" - |
<t>"ERR:<error-code>:<error-message>" - |
2960 |
<list> |
<list> |
2961 |
<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> |
2962 |
</list> |
</list> |
2963 |
</t> |
</t> |
2964 |
</list> |
</list> |
2971 |
</t> |
</t> |
2972 |
</section> |
</section> |
2973 |
|
|
2974 |
<section title="Setting MIDI input channel"> |
<section title="Setting MIDI input channel" anchor="SET CHANNEL MIDI_INPUT_CHANNEL"> |
2975 |
<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 |
2976 |
listen to by sending the following command:</t> |
listen to by sending the following command:</t> |
2977 |
<t> |
<t> |
2979 |
<t>SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan></t> |
<t>SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan></t> |
2980 |
</list> |
</list> |
2981 |
</t> |
</t> |
2982 |
<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 |
2983 |
<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 |
2984 |
channels.</t> |
channels.</t> |
2985 |
|
|
3013 |
</t> |
</t> |
3014 |
</section> |
</section> |
3015 |
|
|
3016 |
<section title="Setting channel volume"> |
<section title="Setting channel volume" anchor="SET CHANNEL VOLUME"> |
3017 |
<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 |
3018 |
the following command:</t> |
the following command:</t> |
3019 |
<t> |
<t> |
3056 |
</t> |
</t> |
3057 |
</section> |
</section> |
3058 |
|
|
3059 |
<section title="Resetting a sampler channel"> |
<section title="Muting a sampler channel" anchor="SET CHANNEL MUTE"> |
3060 |
|
<t>The front-end can mute/unmute a specific sampler |
3061 |
|
channel by sending the following command:</t> |
3062 |
|
<t> |
3063 |
|
<list> |
3064 |
|
<t>SET CHANNEL MUTE <sampler-channel> <mute></t> |
3065 |
|
</list> |
3066 |
|
</t> |
3067 |
|
<t>Where <sampler-channel> is the respective sampler channel |
3068 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3069 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
3070 |
|
<mute> should be replaced either by "1" to mute the channel or "0" |
3071 |
|
to unmute the channel.</t> |
3072 |
|
|
3073 |
|
<t>Possible Answers:</t> |
3074 |
|
<t> |
3075 |
|
<list> |
3076 |
|
<t>"OK" - |
3077 |
|
<list> |
3078 |
|
<t>on success</t> |
3079 |
|
</list> |
3080 |
|
</t> |
3081 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3082 |
|
<list> |
3083 |
|
<t>if the channel was muted/unmuted, but there are noteworthy |
3084 |
|
issue(s) related, providing an appropriate warning code and |
3085 |
|
warning message</t> |
3086 |
|
</list> |
3087 |
|
</t> |
3088 |
|
<t>"ERR:<error-code>:<error-message>" - |
3089 |
|
<list> |
3090 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3091 |
|
</list> |
3092 |
|
</t> |
3093 |
|
</list> |
3094 |
|
</t> |
3095 |
|
<t>Examples:</t> |
3096 |
|
<t> |
3097 |
|
<list> |
3098 |
|
<t></t> |
3099 |
|
</list> |
3100 |
|
</t> |
3101 |
|
</section> |
3102 |
|
|
3103 |
|
<section title="Soloing a sampler channel" anchor="SET CHANNEL SOLO"> |
3104 |
|
<t>The front-end can solo/unsolo a specific sampler channel |
3105 |
|
by sending the following command:</t> |
3106 |
|
<t> |
3107 |
|
<list> |
3108 |
|
<t>SET CHANNEL SOLO <sampler-channel> <solo></t> |
3109 |
|
</list> |
3110 |
|
</t> |
3111 |
|
<t>Where <sampler-channel> is the respective sampler channel |
3112 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3113 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
3114 |
|
<solo> should be replaced either by "1" to solo the channel or "0" |
3115 |
|
to unsolo the channel.</t> |
3116 |
|
|
3117 |
|
<t>Possible Answers:</t> |
3118 |
|
<t> |
3119 |
|
<list> |
3120 |
|
<t>"OK" - |
3121 |
|
<list> |
3122 |
|
<t>on success</t> |
3123 |
|
</list> |
3124 |
|
</t> |
3125 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3126 |
|
<list> |
3127 |
|
<t>if the channel was soloed/unsoloed, but there are noteworthy |
3128 |
|
issue(s) related, providing an appropriate warning code and |
3129 |
|
warning message</t> |
3130 |
|
</list> |
3131 |
|
</t> |
3132 |
|
<t>"ERR:<error-code>:<error-message>" - |
3133 |
|
<list> |
3134 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3135 |
|
</list> |
3136 |
|
</t> |
3137 |
|
</list> |
3138 |
|
</t> |
3139 |
|
<t>Examples:</t> |
3140 |
|
<t> |
3141 |
|
<list> |
3142 |
|
<t></t> |
3143 |
|
</list> |
3144 |
|
</t> |
3145 |
|
</section> |
3146 |
|
|
3147 |
|
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
3148 |
<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> |
3149 |
<t> |
<t> |
3150 |
<list> |
<list> |
3192 |
<section title="Controlling connection"> |
<section title="Controlling connection"> |
3193 |
<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> |
3194 |
|
|
3195 |
<section title="Register front-end for receiving event messages"> |
<section title="Register front-end for receiving event messages" anchor="SUBSCRIBE"> |
3196 |
<t>The front-end can register itself to the LinuxSampler application to |
<t>The front-end can register itself to the LinuxSampler application to |
3197 |
be informed about noteworthy events by sending this command:</t> |
be informed about noteworthy events by sending this command:</t> |
3198 |
<t> |
<t> |
3234 |
</t> |
</t> |
3235 |
</section> |
</section> |
3236 |
|
|
3237 |
<section title="Unregister front-end for not receiving UDP event messages anymore"> |
<section title="Unregister front-end for not receiving event messages" anchor="UNSUBSCRIBE"> |
3238 |
<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 |
3239 |
messages anymore by sending the following command:</t> |
messages anymore by sending the following command:</t> |
3240 |
<t> |
<t> |
3276 |
</t> |
</t> |
3277 |
</section> |
</section> |
3278 |
|
|
3279 |
<section title="Enable or disable echo of commands"> |
<section title="Enable or disable echo of commands" anchor="SET ECHO"> |
3280 |
<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> |
3281 |
<t> |
<t> |
3282 |
<list> |
<list> |
3314 |
</t> |
</t> |
3315 |
</section> |
</section> |
3316 |
|
|
3317 |
<section title="Close client connection"> |
<section title="Close client connection" anchor="QUIT"> |
3318 |
<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> |
3319 |
<t> |
<t> |
3320 |
<list> |
<list> |
3325 |
LinuxSampler than really useful for a front-end implementation.</t> |
LinuxSampler than really useful for a front-end implementation.</t> |
3326 |
</section> |
</section> |
3327 |
</section> |
</section> |
3328 |
|
|
3329 |
|
<section title="Global commands"> |
3330 |
|
<t>The following commands have global impact on the sampler.</t> |
3331 |
|
|
3332 |
|
<section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT"> |
3333 |
|
<t>The front-end can ask for the current number of active voices on |
3334 |
|
the sampler by sending the following command:</t> |
3335 |
|
<t> |
3336 |
|
<list> |
3337 |
|
<t>GET TOTAL_VOICE_COUNT</t> |
3338 |
|
</list> |
3339 |
|
</t> |
3340 |
|
|
3341 |
|
<t>Possible Answers:</t> |
3342 |
|
<t> |
3343 |
|
<list> |
3344 |
|
<t>LinuxSampler will answer by returning the number of all active |
3345 |
|
voices on the sampler.</t> |
3346 |
|
</list> |
3347 |
|
</t> |
3348 |
|
</section> |
3349 |
|
|
3350 |
|
<section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX"> |
3351 |
|
<t>The front-end can ask for the maximum number of active voices |
3352 |
|
by sending the following command:</t> |
3353 |
|
<t> |
3354 |
|
<list> |
3355 |
|
<t>GET TOTAL_VOICE_COUNT_MAX</t> |
3356 |
|
</list> |
3357 |
|
</t> |
3358 |
|
|
3359 |
|
<t>Possible Answers:</t> |
3360 |
|
<t> |
3361 |
|
<list> |
3362 |
|
<t>LinuxSampler will answer by returning the maximum number |
3363 |
|
of active voices.</t> |
3364 |
|
</list> |
3365 |
|
</t> |
3366 |
|
</section> |
3367 |
|
|
3368 |
|
<section title="Reset sampler" anchor="RESET"> |
3369 |
|
<t>The front-end can reset the whole sampler by sending the following command:</t> |
3370 |
|
<t> |
3371 |
|
<list> |
3372 |
|
<t>RESET</t> |
3373 |
|
</list> |
3374 |
|
</t> |
3375 |
|
|
3376 |
|
<t>Possible Answers:</t> |
3377 |
|
<t> |
3378 |
|
<list> |
3379 |
|
<t>"OK" - |
3380 |
|
<list> |
3381 |
|
<t>always</t> |
3382 |
|
</list> |
3383 |
|
</t> |
3384 |
|
</list> |
3385 |
|
</t> |
3386 |
|
<t>Examples:</t> |
3387 |
|
<t> |
3388 |
|
<list> |
3389 |
|
<t></t> |
3390 |
|
</list> |
3391 |
|
</t> |
3392 |
|
</section> |
3393 |
|
|
3394 |
|
<section title="General sampler informations" anchor="GET SERVER INFO"> |
3395 |
|
<t>The client can ask for general informations about the LinuxSampler |
3396 |
|
instance by sending the following command:</t> |
3397 |
|
<t> |
3398 |
|
<list> |
3399 |
|
<t>GET SERVER INFO</t> |
3400 |
|
</list> |
3401 |
|
</t> |
3402 |
|
<t>Possible Answers:</t> |
3403 |
|
<t> |
3404 |
|
<list> |
3405 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
3406 |
|
Each answer line begins with the information category name |
3407 |
|
followed by a colon and then a space character <SP> and finally |
3408 |
|
the info character string to that information category. At the |
3409 |
|
moment the following categories are defined: |
3410 |
|
</t> |
3411 |
|
<t> |
3412 |
|
<list> |
3413 |
|
<t>DESCRIPTION - |
3414 |
|
<list> |
3415 |
|
<t>arbitrary textual description about the sampler</t> |
3416 |
|
</list> |
3417 |
|
</t> |
3418 |
|
<t>VERSION - |
3419 |
|
<list> |
3420 |
|
<t>version of the sampler</t> |
3421 |
|
</list> |
3422 |
|
</t> |
3423 |
|
<t>PROTOCOL_VERSION - |
3424 |
|
<list> |
3425 |
|
<t>version of the LSCP specification the sampler |
3426 |
|
complies with (see <xref target="LSCP versioning" /> for details)</t> |
3427 |
|
</list> |
3428 |
|
</t> |
3429 |
|
</list> |
3430 |
|
</t> |
3431 |
|
</list> |
3432 |
|
</t> |
3433 |
|
<t>The mentioned fields above don't have to be in particular order. |
3434 |
|
Other fields might be added in future.</t> |
3435 |
|
</section> |
3436 |
|
</section> |
3437 |
</section> |
</section> |
3438 |
|
|
3439 |
<section title="Command Syntax"> |
<section title="Command Syntax" anchor="command_syntax"> |
3440 |
<t>TODO: will soon automatically included from src/network/lscp.y</t> |
<t>The grammar of the control protocol as descibed in <xref target="control_commands"/> |
3441 |
|
is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>) |
3442 |
|
where applicable. |
3443 |
|
</t> |
3444 |
|
<!-- |
3445 |
|
This section is automatically generated by scripts/update_grammar.pl |
3446 |
|
from src/network/lscp.y (yacc input file). Do not modify this section |
3447 |
|
manually ! |
3448 |
|
--> |
3449 |
|
<!-- GRAMMAR_BNF_BEGIN - do NOT delete or modify this line !!! --> |
3450 |
|
|
3451 |
|
<t>input = |
3452 |
|
<list> |
3453 |
|
<t>line LF |
3454 |
|
</t> |
3455 |
|
<t>/ line CR LF |
3456 |
|
</t> |
3457 |
|
</list> |
3458 |
|
</t> |
3459 |
|
<t>line = |
3460 |
|
<list> |
3461 |
|
<t>/* epsilon (empty line ignored) */ |
3462 |
|
</t> |
3463 |
|
<t>/ comment |
3464 |
|
</t> |
3465 |
|
<t>/ command |
3466 |
|
</t> |
3467 |
|
<t>/ error |
3468 |
|
</t> |
3469 |
|
</list> |
3470 |
|
</t> |
3471 |
|
<t>comment = |
3472 |
|
<list> |
3473 |
|
<t>'#' |
3474 |
|
</t> |
3475 |
|
<t>/ comment '#' |
3476 |
|
</t> |
3477 |
|
<t>/ comment SP |
3478 |
|
</t> |
3479 |
|
<t>/ comment number |
3480 |
|
</t> |
3481 |
|
<t>/ comment string |
3482 |
|
</t> |
3483 |
|
</list> |
3484 |
|
</t> |
3485 |
|
<t>command = |
3486 |
|
<list> |
3487 |
|
<t>ADD SP CHANNEL |
3488 |
|
</t> |
3489 |
|
<t>/ GET SP get_instruction |
3490 |
|
</t> |
3491 |
|
<t>/ CREATE SP create_instruction |
3492 |
|
</t> |
3493 |
|
<t>/ DESTROY SP destroy_instruction |
3494 |
|
</t> |
3495 |
|
<t>/ LIST SP list_instruction |
3496 |
|
</t> |
3497 |
|
<t>/ LOAD SP load_instruction |
3498 |
|
</t> |
3499 |
|
<t>/ REMOVE SP CHANNEL SP sampler_channel |
3500 |
|
</t> |
3501 |
|
<t>/ SET SP set_instruction |
3502 |
|
</t> |
3503 |
|
<t>/ SUBSCRIBE SP subscribe_event |
3504 |
|
</t> |
3505 |
|
<t>/ UNSUBSCRIBE SP unsubscribe_event |
3506 |
|
</t> |
3507 |
|
<t>/ SELECT SP text |
3508 |
|
</t> |
3509 |
|
<t>/ RESET SP CHANNEL SP sampler_channel |
3510 |
|
</t> |
3511 |
|
<t>/ RESET |
3512 |
|
</t> |
3513 |
|
<t>/ QUIT |
3514 |
|
</t> |
3515 |
|
</list> |
3516 |
|
</t> |
3517 |
|
<t>subscribe_event = |
3518 |
|
<list> |
3519 |
|
<t>CHANNEL_COUNT |
3520 |
|
</t> |
3521 |
|
<t>/ VOICE_COUNT |
3522 |
|
</t> |
3523 |
|
<t>/ STREAM_COUNT |
3524 |
|
</t> |
3525 |
|
<t>/ BUFFER_FILL |
3526 |
|
</t> |
3527 |
|
<t>/ CHANNEL_INFO |
3528 |
|
</t> |
3529 |
|
<t>/ MISCELLANEOUS |
3530 |
|
</t> |
3531 |
|
<t>/ TOTAL_VOICE_COUNT |
3532 |
|
</t> |
3533 |
|
</list> |
3534 |
|
</t> |
3535 |
|
<t>unsubscribe_event = |
3536 |
|
<list> |
3537 |
|
<t>CHANNEL_COUNT |
3538 |
|
</t> |
3539 |
|
<t>/ VOICE_COUNT |
3540 |
|
</t> |
3541 |
|
<t>/ STREAM_COUNT |
3542 |
|
</t> |
3543 |
|
<t>/ BUFFER_FILL |
3544 |
|
</t> |
3545 |
|
<t>/ CHANNEL_INFO |
3546 |
|
</t> |
3547 |
|
<t>/ MISCELLANEOUS |
3548 |
|
</t> |
3549 |
|
<t>/ TOTAL_VOICE_COUNT |
3550 |
|
</t> |
3551 |
|
</list> |
3552 |
|
</t> |
3553 |
|
<t>get_instruction = |
3554 |
|
<list> |
3555 |
|
<t>AVAILABLE_ENGINES |
3556 |
|
</t> |
3557 |
|
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
3558 |
|
</t> |
3559 |
|
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
3560 |
|
</t> |
3561 |
|
<t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string |
3562 |
|
</t> |
3563 |
|
<t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list |
3564 |
|
</t> |
3565 |
|
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
3566 |
|
</t> |
3567 |
|
<t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string |
3568 |
|
</t> |
3569 |
|
<t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string |
3570 |
|
</t> |
3571 |
|
<t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list |
3572 |
|
</t> |
3573 |
|
<t>/ AUDIO_OUTPUT_DEVICES |
3574 |
|
</t> |
3575 |
|
<t>/ MIDI_INPUT_DEVICES |
3576 |
|
</t> |
3577 |
|
<t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number |
3578 |
|
</t> |
3579 |
|
<t>/ MIDI_INPUT_DEVICE SP INFO SP number |
3580 |
|
</t> |
3581 |
|
<t>/ MIDI_INPUT_PORT SP INFO SP number SP number |
3582 |
|
</t> |
3583 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string |
3584 |
|
</t> |
3585 |
|
<t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number |
3586 |
|
</t> |
3587 |
|
<t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string |
3588 |
|
</t> |
3589 |
|
<t>/ CHANNELS |
3590 |
|
</t> |
3591 |
|
<t>/ CHANNEL SP INFO SP sampler_channel |
3592 |
|
</t> |
3593 |
|
<t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel |
3594 |
|
</t> |
3595 |
|
<t>/ CHANNEL SP STREAM_COUNT SP sampler_channel |
3596 |
|
</t> |
3597 |
|
<t>/ CHANNEL SP VOICE_COUNT SP sampler_channel |
3598 |
|
</t> |
3599 |
|
<t>/ ENGINE SP INFO SP engine_name |
3600 |
|
</t> |
3601 |
|
<t>/ SERVER SP INFO |
3602 |
|
</t> |
3603 |
|
<t>/ TOTAL_VOICE_COUNT |
3604 |
|
</t> |
3605 |
|
<t>/ TOTAL_VOICE_COUNT_MAX |
3606 |
|
</t> |
3607 |
|
</list> |
3608 |
|
</t> |
3609 |
|
<t>set_instruction = |
3610 |
|
<list> |
3611 |
|
<t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
3612 |
|
</t> |
3613 |
|
<t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list |
3614 |
|
</t> |
3615 |
|
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
3616 |
|
</t> |
3617 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
3618 |
|
</t> |
3619 |
|
<t>/ CHANNEL SP set_chan_instruction |
3620 |
|
</t> |
3621 |
|
<t>/ ECHO SP boolean |
3622 |
|
</t> |
3623 |
|
</list> |
3624 |
|
</t> |
3625 |
|
<t>create_instruction = |
3626 |
|
<list> |
3627 |
|
<t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list |
3628 |
|
</t> |
3629 |
|
<t>/ AUDIO_OUTPUT_DEVICE SP string |
3630 |
|
</t> |
3631 |
|
<t>/ MIDI_INPUT_DEVICE SP string SP key_val_list |
3632 |
|
</t> |
3633 |
|
<t>/ MIDI_INPUT_DEVICE SP string |
3634 |
|
</t> |
3635 |
|
</list> |
3636 |
|
</t> |
3637 |
|
<t>destroy_instruction = |
3638 |
|
<list> |
3639 |
|
<t>AUDIO_OUTPUT_DEVICE SP number |
3640 |
|
</t> |
3641 |
|
<t>/ MIDI_INPUT_DEVICE SP number |
3642 |
|
</t> |
3643 |
|
</list> |
3644 |
|
</t> |
3645 |
|
<t>load_instruction = |
3646 |
|
<list> |
3647 |
|
<t>INSTRUMENT SP load_instr_args |
3648 |
|
</t> |
3649 |
|
<t>/ ENGINE SP load_engine_args |
3650 |
|
</t> |
3651 |
|
</list> |
3652 |
|
</t> |
3653 |
|
<t>set_chan_instruction = |
3654 |
|
<list> |
3655 |
|
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
3656 |
|
</t> |
3657 |
|
<t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index |
3658 |
|
</t> |
3659 |
|
<t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name |
3660 |
|
</t> |
3661 |
|
<t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index |
3662 |
|
</t> |
3663 |
|
<t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index |
3664 |
|
</t> |
3665 |
|
<t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index |
3666 |
|
</t> |
3667 |
|
<t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index |
3668 |
|
</t> |
3669 |
|
<t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name |
3670 |
|
</t> |
3671 |
|
<t>/ VOLUME SP sampler_channel SP volume_value |
3672 |
|
</t> |
3673 |
|
<t>/ MUTE SP sampler_channel SP boolean |
3674 |
|
</t> |
3675 |
|
<t>/ SOLO SP sampler_channel SP boolean |
3676 |
|
</t> |
3677 |
|
</list> |
3678 |
|
</t> |
3679 |
|
<t>key_val_list = |
3680 |
|
<list> |
3681 |
|
<t>string '=' param_val_list |
3682 |
|
</t> |
3683 |
|
<t>/ key_val_list SP string '=' param_val_list |
3684 |
|
</t> |
3685 |
|
</list> |
3686 |
|
</t> |
3687 |
|
<t>buffer_size_type = |
3688 |
|
<list> |
3689 |
|
<t>BYTES |
3690 |
|
</t> |
3691 |
|
<t>/ PERCENTAGE |
3692 |
|
</t> |
3693 |
|
</list> |
3694 |
|
</t> |
3695 |
|
<t>list_instruction = |
3696 |
|
<list> |
3697 |
|
<t>AUDIO_OUTPUT_DEVICES |
3698 |
|
</t> |
3699 |
|
<t>/ MIDI_INPUT_DEVICES |
3700 |
|
</t> |
3701 |
|
<t>/ CHANNELS |
3702 |
|
</t> |
3703 |
|
<t>/ AVAILABLE_ENGINES |
3704 |
|
</t> |
3705 |
|
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
3706 |
|
</t> |
3707 |
|
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
3708 |
|
</t> |
3709 |
|
</list> |
3710 |
|
</t> |
3711 |
|
<t>load_instr_args = |
3712 |
|
<list> |
3713 |
|
<t>filename SP instrument_index SP sampler_channel |
3714 |
|
</t> |
3715 |
|
<t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel |
3716 |
|
</t> |
3717 |
|
</list> |
3718 |
|
</t> |
3719 |
|
<t>load_engine_args = |
3720 |
|
<list> |
3721 |
|
<t>engine_name SP sampler_channel |
3722 |
|
</t> |
3723 |
|
</list> |
3724 |
|
</t> |
3725 |
|
<t>device_index = |
3726 |
|
<list> |
3727 |
|
<t>number |
3728 |
|
</t> |
3729 |
|
</list> |
3730 |
|
</t> |
3731 |
|
<t>audio_channel_index = |
3732 |
|
<list> |
3733 |
|
<t>number |
3734 |
|
</t> |
3735 |
|
</list> |
3736 |
|
</t> |
3737 |
|
<t>audio_output_type_name = |
3738 |
|
<list> |
3739 |
|
<t>string |
3740 |
|
</t> |
3741 |
|
</list> |
3742 |
|
</t> |
3743 |
|
<t>midi_input_port_index = |
3744 |
|
<list> |
3745 |
|
<t>number |
3746 |
|
</t> |
3747 |
|
</list> |
3748 |
|
</t> |
3749 |
|
<t>midi_input_channel_index = |
3750 |
|
<list> |
3751 |
|
<t>number |
3752 |
|
</t> |
3753 |
|
<t>/ ALL |
3754 |
|
</t> |
3755 |
|
</list> |
3756 |
|
</t> |
3757 |
|
<t>midi_input_type_name = |
3758 |
|
<list> |
3759 |
|
<t>string |
3760 |
|
</t> |
3761 |
|
</list> |
3762 |
|
</t> |
3763 |
|
<t>volume_value = |
3764 |
|
<list> |
3765 |
|
<t>dotnum |
3766 |
|
</t> |
3767 |
|
<t>/ number |
3768 |
|
</t> |
3769 |
|
</list> |
3770 |
|
</t> |
3771 |
|
<t>sampler_channel = |
3772 |
|
<list> |
3773 |
|
<t>number |
3774 |
|
</t> |
3775 |
|
</list> |
3776 |
|
</t> |
3777 |
|
<t>instrument_index = |
3778 |
|
<list> |
3779 |
|
<t>number |
3780 |
|
</t> |
3781 |
|
</list> |
3782 |
|
</t> |
3783 |
|
<t>engine_name = |
3784 |
|
<list> |
3785 |
|
<t>string |
3786 |
|
</t> |
3787 |
|
</list> |
3788 |
|
</t> |
3789 |
|
<t>filename = |
3790 |
|
<list> |
3791 |
|
<t>stringval |
3792 |
|
</t> |
3793 |
|
</list> |
3794 |
|
</t> |
3795 |
|
<t>param_val_list = |
3796 |
|
<list> |
3797 |
|
<t>param_val |
3798 |
|
</t> |
3799 |
|
<t>/ param_val_list','param_val |
3800 |
|
</t> |
3801 |
|
</list> |
3802 |
|
</t> |
3803 |
|
<t>param_val = |
3804 |
|
<list> |
3805 |
|
<t>string |
3806 |
|
</t> |
3807 |
|
<t>/ stringval |
3808 |
|
</t> |
3809 |
|
<t>/ number |
3810 |
|
</t> |
3811 |
|
<t>/ dotnum |
3812 |
|
</t> |
3813 |
|
</list> |
3814 |
|
</t> |
3815 |
|
|
3816 |
|
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
3817 |
</section> |
</section> |
3818 |
|
|
3819 |
<section title="Events"> |
<section title="Events" anchor="events"> |
3820 |
<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> |
3821 |
|
|
3822 |
<section title="Number of sampler channels changed"> |
<section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL"> |
3823 |
<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 |
3824 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
3825 |
<t> |
<t> |
3826 |
<list> |
<list> |
3827 |
<t>SUBSCRIBE CHANNELS</t> |
<t>SUBSCRIBE CHANNEL_COUNT</t> |
3828 |
</list> |
</list> |
3829 |
</t> |
</t> |
3830 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
3831 |
<t> |
<t> |
3832 |
<list> |
<list> |
3833 |
<t>"NOTIFY:CHANNELS:<channels>"</t> |
<t>"NOTIFY:CHANNEL_COUNT:<channels>"</t> |
3834 |
</list> |
</list> |
3835 |
</t> |
</t> |
3836 |
<t>where <channels> will be replaced by the new number |
<t>where <channels> will be replaced by the new number |
3837 |
of sampler channels.</t> |
of sampler channels.</t> |
3838 |
</section> |
</section> |
3839 |
|
|
3840 |
<section title="Number of active voices changed"> |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
3841 |
<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 |
3842 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
3843 |
<t> |
<t> |
3848 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
3849 |
<t> |
<t> |
3850 |
<list> |
<list> |
3851 |
<t>"NOTIFY:VOICE_COUNT:<sampler-channel> <voices>></t> |
<t>"NOTIFY:VOICE_COUNT:<sampler-channel> <voices></t> |
3852 |
</list> |
</list> |
3853 |
</t> |
</t> |
3854 |
<t>where <sampler-channel> will be replaced by the sampler channel the |
<t>where <sampler-channel> will be replaced by the sampler channel the |
3855 |
voice count change occurred and <voices>> by the new number of |
voice count change occurred and <voices> by the new number of |
3856 |
active voices on that channel.</t> |
active voices on that channel.</t> |
3857 |
</section> |
</section> |
3858 |
|
|
3859 |
<section title="Number of active disk streams changed"> |
<section title="Number of active disk streams changed" anchor="SUBSCRIBE STREAM_COUNT"> |
3860 |
<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 |
3861 |
changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t> |
changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t> |
3862 |
<t> |
<t> |
3875 |
active disk streams on that channel.</t> |
active disk streams on that channel.</t> |
3876 |
</section> |
</section> |
3877 |
|
|
3878 |
<section title="Disk stream buffer fill state changed"> |
<section title="Disk stream buffer fill state changed" anchor="SUBSCRIBE BUFFER_FILL"> |
3879 |
<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 |
3880 |
changes by issuing the following command:</t> |
on the back-end changes by issuing the following command:</t> |
3881 |
<t> |
<t> |
3882 |
<list> |
<list> |
3883 |
<t>SUBSCRIBE BUFFER_FILL</t> |
<t>SUBSCRIBE BUFFER_FILL</t> |
3890 |
</list> |
</list> |
3891 |
</t> |
</t> |
3892 |
<t>where <sampler-channel> will be replaced by the sampler channel the |
<t>where <sampler-channel> will be replaced by the sampler channel the |
3893 |
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 |
3894 |
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" /> |
3895 |
"GET CHANNEL BUFFER_FILL PERCENTAGE" was issued on this channel.</t> |
as if the <xref target="GET CHANNEL BUFFER_FILL"> |
3896 |
|
"GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t> |
3897 |
</section> |
</section> |
3898 |
|
|
3899 |
<section title="Channel information changed"> |
<section title="Channel information changed" anchor="SUBSCRIBE INFO"> |
3900 |
<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 |
3901 |
back-end changes by issuing the following command:</t> |
back-end by issuing the following command:</t> |
3902 |
<t> |
<t> |
3903 |
<list> |
<list> |
3904 |
<t>SUBSCRIBE INFO</t> |
<t>SUBSCRIBE CHANNEL_INFO</t> |
3905 |
</list> |
</list> |
3906 |
</t> |
</t> |
3907 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
3908 |
<t> |
<t> |
3909 |
<list> |
<list> |
3910 |
<t>"NOTIFY:INFO:<sampler-channel>"</t> |
<t>"NOTIFY:CHANNEL_INFO:<sampler-channel>"</t> |
3911 |
</list> |
</list> |
3912 |
</t> |
</t> |
3913 |
<t>where <sampler-channel> will be replaced by the sampler channel the |
<t>where <sampler-channel> will be replaced by the sampler channel the |
3918 |
message is sufficient here.</t> |
message is sufficient here.</t> |
3919 |
</section> |
</section> |
3920 |
|
|
3921 |
<section title="Miscellaneous and debugging events"> |
<section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT"> |
3922 |
|
<t>Client may want to be notified when the total number of voices on the |
3923 |
|
back-end changes by issuing the following command:</t> |
3924 |
|
<t> |
3925 |
|
<list> |
3926 |
|
<t>SUBSCRIBE TOTAL_VOICE_COUNT</t> |
3927 |
|
</list> |
3928 |
|
</t> |
3929 |
|
<t>Server will start sending the following notification messages:</t> |
3930 |
|
<t> |
3931 |
|
<list> |
3932 |
|
<t>"NOTIFY:TOTAL_VOICE_COUNT:<voices></t> |
3933 |
|
</list> |
3934 |
|
</t> |
3935 |
|
<t>where <voices> will be replaced by the new number of |
3936 |
|
all currently active voices.</t> |
3937 |
|
</section> |
3938 |
|
|
3939 |
|
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
3940 |
<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 |
3941 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |
3942 |
<t> |
<t> |
3972 |
<t>Rui Nuno Capela</t> |
<t>Rui Nuno Capela</t> |
3973 |
<t>Vladimir Senkov</t> |
<t>Vladimir Senkov</t> |
3974 |
<t>Mark Knecht</t> |
<t>Mark Knecht</t> |
3975 |
|
<t>Grigor Iliev</t> |
3976 |
</list> |
</list> |
3977 |
</t> |
</t> |
3978 |
</section> |
</section> |
3980 |
</middle> |
</middle> |
3981 |
|
|
3982 |
<back> |
<back> |
3983 |
<references>&rfc2119;</references> |
<references> |
3984 |
|
<reference anchor="RFC2119"> |
3985 |
|
<front> |
3986 |
|
<title>Key words for use in RFCs to Indicate Requirement Levels</title> |
3987 |
|
<author initials="S." surname="Bradner" fullname="Scott Bradner"> |
3988 |
|
<organization>Harvard University</organization> |
3989 |
|
</author> |
3990 |
|
<date year="1997"></date> |
3991 |
|
</front> |
3992 |
|
<seriesInfo name="RFC" value="2119" /> |
3993 |
|
</reference> |
3994 |
|
<reference anchor="RFC793"> |
3995 |
|
<front> |
3996 |
|
<title>TRANSMISSION CONTROL PROTOCOL</title> |
3997 |
|
<author> |
3998 |
|
<organization>Defense Advanced Research Projects Agency</organization> |
3999 |
|
</author> |
4000 |
|
<date year="1981"></date> |
4001 |
|
</front> |
4002 |
|
<seriesInfo name="RFC" value="793" /> |
4003 |
|
</reference> |
4004 |
|
<reference anchor="RFC2234"> |
4005 |
|
<front> |
4006 |
|
<title>Augmented BNF for Syntax Specifications</title> |
4007 |
|
<author initials="D.H." surname="Crocker" fullname="David H. Crocker"> |
4008 |
|
<organization>Internet Mail Consortium</organization> |
4009 |
|
</author> |
4010 |
|
<author initials="P." surname="Overell" fullname="Paul Overell"> |
4011 |
|
<organization>Demon Internet Ltd</organization> |
4012 |
|
</author> |
4013 |
|
<date year="1997"></date> |
4014 |
|
</front> |
4015 |
|
<seriesInfo name="RFC" value="2234" /> |
4016 |
|
</reference> |
4017 |
|
</references> |
4018 |
</back> |
</back> |
4019 |
|
|
4020 |
</rfc> |
</rfc> |