/[svn]/linuxsampler/trunk/Documentation/lscp.xml
ViewVC logotype

Contents of /linuxsampler/trunk/Documentation/lscp.xml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1188 - (show annotations) (download) (as text)
Wed May 16 14:37:22 2007 UTC (16 years, 10 months ago) by iliev
File MIME type: text/xml
File size: 351075 byte(s)
- updating the date

1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
4 <!ENTITY rfc2119 PUBLIC ''
5 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml'>
6 ]>
7
8 <?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
9
10 <?rfc toc="yes" ?>
11 <?rfc symrefs="yes" ?>
12 <?rfc sortrefs="yes"?>
13 <?rfc iprnotified="no" ?>
14
15 <!-- FIXME: next attribute should actually be "yes", temporarily disbled due
16 to an annoying "missing Normative/Informative References" error message -->
17 <?rfc strict="no" ?>
18
19 <rfc category="std" ipr="full3978" docName="LSCP 1.2">
20 <front>
21 <title>LinuxSampler Control Protocol</title>
22 <author initials='C.S.' surname="Schoenebeck" fullname='C.
23 Schoenebeck'>
24 <organization>
25 Interessengemeinschaft Software Engineering e. V.
26 </organization>
27 <address>
28 <postal>
29 <street>Max-Planck-Str. 39</street>
30 <!-- <code>74081</code> -->
31 <city>74081 Heilbronn</city>
32 <country>Germany</country>
33 </postal>
34 <email>schoenebeck at software minus engineering dot org</email>
35 </address>
36 </author>
37 <date month="May" year="2007"/>
38 <workgroup>LinuxSampler Developers</workgroup>
39 <keyword>LSCP</keyword>
40 <abstract>
41 <t>The LinuxSampler Control Protocol (LSCP) is an
42 application-level protocol primarily intended for local and
43 remote controlling the LinuxSampler backend application, which is a
44 sophisticated server-like console application essentially playing
45 back audio samples and manipulating the samples in real time to
46 certain extent.</t>
47 </abstract>
48 </front>
49
50 <middle>
51 <section title="Requirements notation">
52 <t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
53 "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
54 and "OPTIONAL" in this document are to be interpreted as
55 described in <xref target="RFC2119"/>.</t>
56
57 <t>This protocol is always case-sensitive if not explicitly
58 claimed the opposite.</t>
59
60 <t>In examples, "C:" and "S:" indicate lines sent by the client
61 (front-end) and server (LinuxSampler) respectively. Lines in
62 examples must be interpreted as every line being CRLF
63 terminated (carriage return character followed by line feed
64 character as defined in the ASCII standard), thus the following
65 example:</t>
66
67 <t>
68 <list>
69 <t>C: "some line"</t>
70 <t>&nbsp;&nbsp;&nbsp;"another line"</t>
71 </list>
72 </t>
73
74 <t>must actually be interpreted as client sending the following
75 message:</t>
76
77 <t>
78 <list>
79 <t>"some line&lt;CR&gt;&lt;LF&gt;another
80 line&lt;CR&gt;&lt;LF&gt;"</t>
81 </list>
82 </t>
83
84 <t>where &lt;CR&gt; symbolizes the carriage return character and
85 &lt;LF&gt; the line feed character as defined in the ASCII
86 standard.</t>
87
88 <t>Due to technical reasons, messages can arbitrary be
89 fragmented, means the following example:</t>
90
91 <t>
92 <list>
93 <t>S: "abcd"</t>
94 </list>
95 </t>
96
97 <t>could also happen to be sent in three messages like in the
98 following sequence scenario:</t>
99
100 <t>
101 <list style="symbols">
102 <t>server sending message "a"</t>
103 <t>followed by a delay (pause) with
104 arbitrary duration</t>
105 <t>followed by server sending message
106 "bcd&lt;CR&gt;"</t>
107 <t>again followed by a delay (pause) with arbitrary
108 duration</t>
109 <t>followed by server sending the message
110 "&lt;LF&gt;"</t>
111 </list>
112 </t>
113
114 <t>where again &lt;CR&gt; and &lt;LF&gt; symbolize the carriage
115 return and line feed characters respectively.</t>
116 </section>
117
118 <section title="Versioning of this specification" anchor="LSCP versioning">
119 <t>LSCP will certainly be extended and enhanced by-and-by. Each official
120 release of the LSCP specification will be tagged with a unique version
121 tuple. The version tuple consists at least of a major and minor version
122 number like:
123 </t>
124 <t>
125 <list>
126 <t>"1.2"</t>
127 </list>
128 </t>
129 <t>
130 In this example the major version number would be "1" and the minor
131 version number would be "2". Note that the version tuple might also
132 have more than two elements. The major version number defines a
133 group of backward compatible versions. That means a frontend is
134 compatible to the connected sampler if and only if the LSCP versions
135 to which each of the two parties complies to, match both of the
136 following rules:
137 </t>
138 <t>Compatibility:</t>
139 <t>
140 <list style="numbers">
141 <t>The frontend's LSCP major version and the sampler's LSCP
142 major version are exactly equal.</t>
143 <t>The frontend's LSCP minor version is less or equal than
144 the sampler's LSCP minor version.</t>
145 </list>
146 </t>
147 <t>
148 Compatibility can only be claimed if both rules are true.
149 The frontend can use the
150 <xref target="GET SERVER INFO">"GET SERVER INFO"</xref> command to
151 get the version of the LSCP specification the sampler complies with.
152 </t>
153 </section>
154
155 <section title="Introduction">
156 <t>LinuxSampler is a so called software sampler application
157 capable to playback audio samples from a computer's Random
158 Access Memory (RAM) as well as directly streaming it from disk.
159 LinuxSampler is designed to be modular. It provides several so
160 called "sampler engines" where each engine is specialized for a
161 certain purpose. LinuxSampler has virtual channels which will be
162 referred in this document as "sampler channels". The channels
163 are in such way virtual as they can be connected to an
164 arbitrary MIDI input method and arbitrary MIDI channel (e.g.
165 sampler channel 17 could be connected to an ALSA sequencer
166 device 64:0 and listening to MIDI channel 1 there). Each sampler
167 channel will be associated with an instance of one of the available
168 sampler engines (e.g. GigEngine, DLSEngine). The audio output of
169 each sampler channel can be routed to an arbitrary audio output
170 method (ALSA / JACK) and an arbitrary audio output channel
171 there.</t>
172 </section>
173
174 <section title="Focus of this protocol">
175 <t>Main focus of this protocol is to provide a way to configure
176 a running LinuxSampler instance and to retrieve information
177 about it. The focus of this protocol is not to provide a way to
178 control synthesis parameters or even to trigger or release
179 notes. Or in other words; the focus are those functionalities
180 which are not covered by MIDI or which may at most be handled
181 via MIDI System Exclusive Messages.</t>
182 </section>
183
184 <section title="Communication Overview">
185 <t>There are two distinct methods of communication between a
186 running instance of LinuxSampler and one or more control
187 applications, so called "front-ends": a simple request/response
188 communication method used by the clients to give commands to the
189 server as well as to inquire about server's status and a
190 subscribe/notify communication method used by the client to
191 subscribe to and receive notifications of certain events as they
192 happen on the server. The latter needs more effort to be
193 implemented in the front-end application. The two communication
194 methods will be described next.</t>
195
196 <section title="Request/response communication method">
197 <t>This simple communication method is based on
198 <xref target="RFC793">TCP</xref>. The
199 front-end application establishes a TCP connection to the
200 LinuxSampler instance on a certain host system. Then the
201 front-end application will send certain ASCII based commands
202 as defined in this document (every command line must be CRLF
203 terminated - see "Conventions used in this document" at the
204 beginning of this document) and the LinuxSampler application
205 will response after a certain process time with an
206 appropriate ASCII based answer, also as defined in this
207 document. So this TCP communication is simply based on query
208 and answer paradigm. That way LinuxSampler is only able to
209 answer on queries from front-ends, but not able to
210 automatically send messages to the client if it's not asked
211 to. The fronted should not reconnect to LinuxSampler for
212 every single command, instead it should keep the connection
213 established and simply resend message(s) for subsequent
214 commands. To keep information in the front-end up-to-date
215 the front-end has to periodically send new requests to get
216 the current information from the LinuxSampler instance. This
217 is often referred to as "polling". While polling is simple
218 to implement and may be OK to use in some cases, there may
219 be disadvantages to polling such as network traffic overhead
220 and information being out of date.
221 It is possible for a client or several clients to open more
222 than one connection to the server at the same time. It is
223 also possible to send more than one request to the server
224 at the same time but if those requests are sent over the
225 same connection server MUST execute them sequentially. Upon
226 executing a request server will produce a result set and
227 send it to the client. Each and every request made by the
228 client MUST result in a result set being sent back to the
229 client. No other data other than a result set may be sent by
230 a server to a client. No result set may be sent to a client
231 without the client sending request to the server first. On
232 any particular connection, result sets MUST be sent in their
233 entirety without being interrupted by other result sets. If
234 several requests got queued up at the server they MUST be
235 processed in the order they were received and result sets
236 MUST be sent back in the same order.</t>
237
238 <section title="Result format">
239 <t>Result set could be one of the following types:</t>
240 <t>
241 <list style="numbers">
242 <t>Normal</t>
243 <t>Warning</t>
244 <t>Error</t>
245 </list>
246 </t>
247 <t>Warning and Error result sets MUST be single line and
248 have the following format:</t>
249 <t>
250 <list style="symbols">
251 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;"</t>
252 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;"</t>
253 </list>
254 </t>
255 <t>Where &lt;warning-code&gt; and &lt;error-code&gt; are
256 numeric unique identifiers of the warning or error and
257 &lt;warning-message&gt; and &lt;error-message&gt; are
258 human readable descriptions of the warning or error
259 respectively.</t>
260 <t>Examples:</t>
261 <t>
262 <list>
263 <t>C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0</t>
264 <t>S: "WRN:32:This is a 24 bit patch which is not supported natively yet."</t>
265 </list>
266 </t>
267 <t>
268 <list>
269 <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"</t>
270 <t>S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter 'EAR'."</t>
271 </list>
272 </t>
273 <t>
274 <list>
275 <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"</t>
276 <t>S: "ERR:9:There is no audio output device with index 123456."</t>
277 </list>
278 </t>
279 <t>Normal result sets could be:</t>
280 <t>
281 <list style="numbers">
282 <t>Empty</t>
283 <t>Single line</t>
284 <t>Multi-line</t>
285 </list>
286 </t>
287 <t> Empty result set is issued when the server only
288 needed to acknowledge the fact that the request was
289 received and it was processed successfully and no
290 additional information is available. This result set has
291 the following format:</t>
292 <t>
293 <list>
294 <t>"OK"</t>
295 </list>
296 </t>
297 <t>Example:</t>
298 <t>
299 <list>
300 <t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"</t>
301 <t>S: "OK"</t>
302 </list>
303 </t>
304 <t>Single line result sets are command specific. One
305 example of a single line result set is an empty line.
306 Multi-line result sets are command specific and may
307 include one or more lines of information. They MUST
308 always end with the following line:</t>
309 <t>
310 <list>
311 <t>"."</t>
312 </list>
313 </t>
314 <t>Example:</t>
315 <t>
316 <list>
317 <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t>
318 <t>S: "DRIVER: ALSA"</t>
319 <t>&nbsp;&nbsp;&nbsp;"CHANNELS: 2"</t>
320 <t>&nbsp;&nbsp;&nbsp;"SAMPLERATE: 44100"</t>
321 <t>&nbsp;&nbsp;&nbsp;"ACTIVE: true"</t>
322 <t>&nbsp;&nbsp;&nbsp;"FRAGMENTS: 2"</t>
323 <t>&nbsp;&nbsp;&nbsp;"FRAGMENTSIZE: 128"</t>
324 <t>&nbsp;&nbsp;&nbsp;"CARD: '0,0'"</t>
325 <t>&nbsp;&nbsp;&nbsp;"."</t>
326 </list>
327 </t>
328 <t>In addition to above mentioned formats, warnings and
329 empty result sets MAY be indexed. In this case, they
330 have the following formats respectively:</t>
331 <t>
332 <list style="symbols">
333 <t>"WRN[&lt;index&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;"</t>
334 <t>"OK[&lt;index&gt;]"</t>
335 </list>
336 </t>
337 <t>where &lt;index&gt; is command specific and is used
338 to indicate channel number that the result set was
339 related to or other integer value.</t>
340 <t>Each line of the result set MUST end with
341 &lt;CRLF&gt;.</t>
342 <t>Examples:</t>
343 <t>
344 <list>
345 <t>C: "ADD CHANNEL"</t>
346 <t>S: "OK[12]"</t>
347 </list>
348 </t>
349 <t>
350 <list>
351 <t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"</t>
352 <t>S: "WRN[0]:32:Sample rate not supported, using 44100 instead."</t>
353 </list>
354 </t>
355 </section>
356 </section>
357 <section title="Subscribe/notify communication method">
358 <t>This more sophisticated communication method is actually
359 only an extension of the simple request/response
360 communication method. The front-end still uses a TCP
361 connection and sends the same commands on the TCP
362 connection. Two extra commands are SUBSCRIBE and UNSUBSCRIBE
363 commands that allow a client to tell the server that it is
364 interested in receiving notifications about certain events
365 as they happen on the server. The SUBSCRIBE command has the
366 following syntax:</t>
367
368 <t>
369 <list>
370 <t>SUBSCRIBE &lt;event-id&gt;</t>
371 </list>
372 </t>
373
374 <t>where &lt;event-id&gt; will be replaced by the respective
375 event that client wants to subscribe to. Upon receiving such
376 request, server SHOULD respond with OK and start sending
377 EVENT notifications when a given even has occurred to the
378 front-end when an event has occurred. It MAY be possible
379 certain events may be sent before OK response during real
380 time nature of their generation. Event messages have the
381 following format:</t>
382
383 <t>
384 <list>
385 <t>NOTIFY:&lt;event-id&gt;:&lt;custom-event-data&gt;</t>
386 </list>
387 </t>
388
389 <t>where &lt;event-id&gt; uniquely identifies the event that
390 has occurred and &lt;custom-event-data&gt; is event
391 specific.</t>
392
393 <t>Several rules must be followed by the server when
394 generating events:</t>
395
396 <t>
397 <list style="numbers">
398 <t>Events MUST NOT be sent to any client who has not
399 issued an appropriate SUBSCRIBE command.</t>
400 <t>Events MUST only be sent using the same
401 connection that was used to subscribe to them.</t>
402 <t>When response is being sent to the client, event
403 MUST be inserted in the stream before or after the
404 response, but NOT in the middle. Same is true about
405 the response. It should never be inserted in the
406 middle of the event message as well as any other
407 response.</t>
408 </list>
409 </t>
410
411 <t>If the client is not interested in a particular event
412 anymore it MAY issue UNSUBSCRIBE command using the following
413 syntax:</t>
414
415 <t>
416 <list>
417 <t>UNSUBSCRIBE &lt;event-id&gt;</t>
418 </list>
419 </t>
420
421 <t>where &lt;event-id&gt; will be replace by the respective
422 event that client is no longer interested in receiving. For
423 a list of supported events see <xref target="events" />.</t>
424
425 <t>Example: the fill states of disk stream buffers have
426 changed on sampler channel 4 and the LinuxSampler instance
427 will react by sending the following message to all clients
428 who subscribed to this event:</t>
429
430 <t>
431 <list>
432 <t>NOTIFY:CHANNEL_BUFFER_FILL:4 [35]62%,[33]80%,[37]98%</t>
433 </list>
434 </t>
435
436 <t>Which means there are currently three active streams on
437 sampler channel 4, where the stream with ID "35" is filled
438 by 62%, stream with ID 33 is filled by 80% and stream with
439 ID 37 is filled by 98%.</t>
440
441 <t>Clients may choose to open more than one connection to
442 the server and use some connections to receive notifications
443 while using other connections to issue commands to the
444 back-end. This is entirely legal and up to the
445 implementation. This does not change the protocol in any way
446 and no special restrictions exist on the server to allow or
447 disallow this or to track what connections belong to what
448 front-ends. Server will listen on a single port, accept
449 multiple connections and support protocol described in this
450 specification in it's entirety on this single port on each
451 connection that it accepted.</t>
452
453 <t>Due to the fact that TCP is used for this communication,
454 dead peers will be detected automatically by the OS TCP
455 stack. While it may take a while to detect dead peers if no
456 traffic is being sent from server to client (TCP keep-alive
457 timer is set to 2 hours on many OSes) it will not be an
458 issue here as when notifications are sent by the server,
459 dead client will be detected quickly.</t>
460
461 <t>When connection is closed for any reason server MUST
462 forget all subscriptions that were made on this connection.
463 If client reconnects it MUST resubscribe to all events that
464 it wants to receive.</t>
465
466 </section>
467 </section>
468
469 <section title="Description for control commands" anchor="control_commands">
470 <t>This chapter will describe the available control commands
471 that can be sent on the TCP connection in detail. Some certain
472 commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref>
473 or <xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref>) lead to
474 multiple-line responses. In this case LinuxSampler signals the
475 end of the response by a "." (single dot) line.</t>
476
477 <section title="Ignored lines and comments">
478 <t>White lines, that is lines which only contain space and
479 tabulator characters, and lines that start with a "#"
480 character are ignored, thus it's possible for example to
481 group commands and to place comments in a LSCP script
482 file.</t>
483 </section>
484
485 <section title="Configuring audio drivers">
486 <t>Instances of drivers in LinuxSampler are called devices.
487 You can use multiple audio devices simultaneously, e.g. to
488 output the sound of one sampler channel using the ALSA audio
489 output driver, and on another sampler channel you might want
490 to use the JACK audio output driver. For particular audio
491 output systems it's also possible to create several devices
492 of the same audio output driver, e.g. two separate ALSA
493 audio output devices for using two different sound cards at
494 the same time. This chapter describes all commands to
495 configure LinuxSampler's audio output devices and their
496 parameters.</t>
497
498 <t>Instead of defining commands and parameters for each
499 driver individually, all possible parameters, their meanings
500 and possible values have to be obtained at runtime. This
501 makes the protocol a bit abstract, but has the advantage,
502 that front-ends can be written independently of what drivers
503 are currently implemented and what parameters these drivers
504 are actually offering. This means front-ends can even handle
505 drivers which are implemented somewhere in future without
506 modifying the front-end at all.</t>
507
508 <t>Note: examples in this chapter showing particular
509 parameters of drivers are not meant as specification of the
510 drivers' parameters. Driver implementations in LinuxSampler
511 might have complete different parameter names and meanings
512 than shown in these examples or might change in future, so
513 these examples are only meant for showing how to retrieve
514 what parameters drivers are offering, how to retrieve their
515 possible values, etc.</t>
516
517 <section title="Getting amount of available audio output drivers" anchor="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">
518 <t>Use the following command to get the number of
519 audio output drivers currently available for the
520 LinuxSampler instance:</t>
521 <t>
522 <list>
523 <t>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS</t>
524 </list>
525 </t>
526 <t>Possible Answers:</t>
527 <t>
528 <list>
529 <t>LinuxSampler will answer by sending the
530 number of audio output drivers.</t>
531 </list>
532 </t>
533 <t>Example:</t>
534 <t>
535 <list>
536 <t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t>
537 <t>S: "2"</t>
538 </list>
539 </t>
540 </section>
541
542 <section title="Getting all available audio output drivers" anchor="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
543 <t>Use the following command to list all audio output
544 drivers currently available for the LinuxSampler
545 instance:</t>
546 <t>
547 <list>
548 <t>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS</t>
549 </list>
550 </t>
551 <t>Possible Answers:</t>
552 <t>
553 <list>
554 <t>LinuxSampler will answer by sending comma
555 separated character strings, each symbolizing an
556 audio output driver.</t>
557 </list>
558 </t>
559 <t>Example:</t>
560 <t>
561 <list>
562 <t>C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t>
563 <t>S: "ALSA,JACK"</t>
564 </list>
565 </t>
566 </section>
567
568 <section title="Getting information about a specific audio
569 output driver" anchor="GET AUDIO_OUTPUT_DRIVER INFO">
570 <t>Use the following command to get detailed information
571 about a specific audio output driver:</t>
572 <t>
573 <list>
574 <t>GET AUDIO_OUTPUT_DRIVER INFO
575 &lt;audio-output-driver&gt;</t>
576 </list>
577 </t>
578 <t>Where &lt;audio-output-driver&gt; is the name of the
579 audio output driver, returned by the
580 <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command.</t>
581 <t>Possible Answers:</t>
582 <t>
583 <list>
584 <t>LinuxSampler will answer by sending a
585 &lt;CRLF&gt; separated list. Each answer line
586 begins with the information category name
587 followed by a colon and then a space character
588 &lt;SP&gt; and finally the info character string
589 to that info category. At the moment the
590 following information categories are
591 defined:</t>
592
593 <t>
594 <list>
595 <t>DESCRIPTION -
596 <list>
597 <t> character string describing the
598 audio output driver</t>
599 </list>
600 </t>
601
602 <t>VERSION -
603 <list>
604 <t>character string reflecting the
605 driver's version</t>
606 </list>
607 </t>
608
609 <t>PARAMETERS -
610 <list>
611 <t>comma separated list of all
612 parameters available for the given
613 audio output driver, at least
614 parameters 'channels', 'samplerate'
615 and 'active' are offered by all audio
616 output drivers</t>
617 </list>
618 </t>
619 </list>
620 </t>
621
622 <t>The mentioned fields above don't have to be
623 in particular order.</t>
624 </list>
625 </t>
626 <t>Example:</t>
627 <t>
628 <list>
629 <t>C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"</t>
630 <t>S: "DESCRIPTION: Advanced Linux Sound
631 Architecture"</t>
632 <t>&nbsp;&nbsp;&nbsp;"VERSION: 1.0"</t>
633 <t>&nbsp;&nbsp;&nbsp;"PARAMETERS:
634 DRIVER,CHANNELS,SAMPLERATE,ACTIVE,FRAGMENTS,
635 FRAGMENTSIZE,CARD"</t>
636 <t>&nbsp;&nbsp;&nbsp;"."</t>
637 </list>
638 </t>
639 </section>
640
641 <section title="Getting information about specific audio
642 output driver parameter" anchor="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">
643 <t>Use the following command to get detailed information
644 about a specific audio output driver parameter:</t>
645 <t>
646 <list>
647 <t>GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO &lt;audio&gt; &lt;prm&gt; [&lt;deplist&gt;]</t>
648 </list>
649 </t>
650 <t>Where &lt;audio&gt; is the name of the audio output
651 driver as returned by the <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
652 "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command,
653 &lt;prm&gt; a specific parameter name for which information should be
654 obtained (as returned by the
655 <xref target="GET AUDIO_OUTPUT_DRIVER INFO">"GET AUDIO_OUTPUT_DRIVER INFO"</xref> command) and
656 &lt;deplist&gt; is an optional list of parameters on which the sought
657 parameter &lt;prm&gt; depends on, &lt;deplist&gt; is a list of key-value
658 pairs in form of "key1=val1 key2=val2 ...", where character string values
659 are encapsulated into apostrophes ('). Arguments given with &lt;deplist&gt;
660 which are not dependency parameters of &lt;prm&gt; will be ignored, means
661 the front-end application can simply put all parameters into &lt;deplist&gt;
662 with the values already selected by the user.</t>
663 <t>Possible Answers:</t>
664 <t>
665 <list>
666 <t>LinuxSampler will answer by sending a
667 &lt;CRLF&gt; separated list.
668 Each answer line begins with the information category name
669 followed by a colon and then a space character &lt;SP&gt; and
670 finally
671 the info character string to that info category. There are
672 information which is always returned, independently of the
673 given driver parameter and there are optional information
674 which is only shown dependently to given driver parameter. At
675 the moment the following information categories are defined:</t>
676 </list>
677 </t>
678
679 <t>
680 <list>
681 <t>TYPE -
682 <list>
683 <t>either "BOOL" for boolean value(s) or
684 "INT" for integer
685 value(s) or "FLOAT" for dotted number(s) or "STRING" for
686 character string(s)
687 (always returned, no matter which driver parameter)</t>
688 </list>
689 </t>
690
691 <t>DESCRIPTION -
692 <list>
693 <t>arbitrary text describing the purpose of the parameter
694 (always returned, no matter which driver parameter)</t>
695 </list>
696 </t>
697
698 <t>MANDATORY -
699 <list>
700 <t>either true or false, defines if this parameter must be
701 given when the device is to be created with the
702 <xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref>
703 command (always returned, no matter which driver parameter)</t>
704 </list>
705 </t>
706
707 <t>FIX -
708 <list>
709 <t>either true or false, if false then this parameter can
710 be changed at any time, once the device is created by
711 the <xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref>
712 command (always returned, no matter which driver parameter)</t>
713 </list>
714 </t>
715
716 <t>MULTIPLICITY -
717 <list>
718 <t>either true or false, defines if this parameter allows
719 only one value or a list of values, where true means
720 multiple values and false only a single value allowed
721 (always returned, no matter which driver parameter)</t>
722 </list>
723 </t>
724
725 <t>DEPENDS -
726 <list>
727 <t>comma separated list of parameters this parameter depends
728 on, means the values for fields 'DEFAULT', 'RANGE_MIN',
729 'RANGE_MAX' and 'POSSIBILITIES' might depend on these
730 listed parameters, for example assuming that an audio
731 driver (like the ALSA driver) offers parameters 'card'
732 and 'samplerate' then parameter 'samplerate' would
733 depend on 'card' because the possible values for
734 'samplerate' depends on the sound card which can be
735 chosen by the 'card' parameter
736 (optionally returned, dependent to driver parameter)</t>
737 </list>
738 </t>
739
740 <t>DEFAULT -
741 <list>
742 <t>reflects the default value for this parameter which is
743 used when the device is created and not explicitly
744 given with the <xref target="CREATE AUDIO_OUTPUT_DEVICE">
745 'CREATE AUDIO_OUTPUT_DEVICE'</xref> command,
746 in case of MULTIPLCITY=true, this is a comma separated
747 list, that's why character strings are encapsulated into
748 apostrophes (')
749 (optionally returned, dependent to driver parameter)</t>
750 </list>
751 </t>
752
753 <t>RANGE_MIN -
754 <list>
755 <t>defines lower limit of the allowed value range for this
756 parameter, can be an integer value as well as a dotted
757 number, this parameter is often used in conjunction
758 with RANGE_MAX, but may also appear without
759 (optionally returned, dependent to driver parameter)</t>
760 </list>
761 </t>
762
763 <t>RANGE_MAX -
764 <list>
765 <t>defines upper limit of the allowed value range for this
766 parameter, can be an integer value as well as a dotted
767 number, this parameter is often used in conjunction with
768 RANGE_MIN, but may also appear without
769 (optionally returned, dependent to driver parameter)</t>
770 </list>
771 </t>
772
773 <t>POSSIBILITIES -
774 <list>
775 <t>comma separated list of possible values for this
776 parameter, character strings are encapsulated into
777 apostrophes
778 (optionally returned, dependent to driver parameter)</t>
779 </list>
780 </t>
781 </list>
782 </t>
783
784 <t>The mentioned fields above don't have to be in particular order.</t>
785
786 <t>Examples:</t>
787 <t>
788 <list>
789 <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"</t>
790 <t>S: "DESCRIPTION: sound card to be used"</t>
791 <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>
792 <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>
793 <t>&nbsp;&nbsp;&nbsp;"FIX: true"</t>
794 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>
795 <t>&nbsp;&nbsp;&nbsp;"DEFAULT: '0,0'"</t>
796 <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: '0,0','1,0','2,0'"</t>
797 <t>&nbsp;&nbsp;&nbsp;"."</t>
798 </list>
799 </t>
800 <t>
801 <list>
802 <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"</t>
803 <t>S: "DESCRIPTION: output sample rate in Hz"</t>
804 <t>&nbsp;&nbsp;&nbsp;"TYPE: INT"</t>
805 <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>
806 <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
807 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>
808 <t>&nbsp;&nbsp;&nbsp;"DEPENDS: card"</t>
809 <t>&nbsp;&nbsp;&nbsp;"DEFAULT: 44100"</t>
810 <t>&nbsp;&nbsp;&nbsp;"."</t>
811 </list>
812 </t>
813 <t>
814 <list>
815 <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE CARD='0,0'"</t>
816 <t>S: "DESCRIPTION: output sample rate in Hz"</t>
817 <t>&nbsp;&nbsp;&nbsp;"TYPE: INT"</t>
818 <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>
819 <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
820 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>
821 <t>&nbsp;&nbsp;&nbsp;"DEPENDS: card"</t>
822 <t>&nbsp;&nbsp;&nbsp;"DEFAULT: 44100"</t>
823 <t>&nbsp;&nbsp;&nbsp;"RANGE_MIN: 22050"</t>
824 <t>&nbsp;&nbsp;&nbsp;"RANGE_MAX: 96000"</t>
825 <t>&nbsp;&nbsp;&nbsp;"."</t>
826 </list>
827 </t>
828 </section>
829
830 <section title="Creating an audio output device" anchor="CREATE AUDIO_OUTPUT_DEVICE">
831 <t>Use the following command to create a new audio output device for the desired audio output system:</t>
832
833 <t>
834 <list>
835 <t>CREATE AUDIO_OUTPUT_DEVICE &lt;audio-output-driver&gt; [&lt;param-list&gt;]</t>
836 </list>
837 </t>
838
839 <t>Where &lt;audio-output-driver&gt; should be replaced by the desired audio
840 output system as returned by the
841 <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref>
842 command and &lt;param-list&gt; by an optional list of driver
843 specific parameters in form of "key1=val1 key2=val2 ...", where
844 character string values should be encapsulated into apostrophes (').
845 Note that there might be drivers which require parameter(s) to be
846 given with this command. Use the previously described commands in
847 this chapter to get this information.</t>
848
849 <t>Possible Answers:</t>
850 <t>
851 <list>
852 <t>"OK[&lt;device-id&gt;]" -
853 <list>
854 <t>in case the device was successfully created, where
855 &lt;device-id&gt; is the numerical ID of the new device</t>
856 </list>
857 </t>
858 <t>"WRN[&lt;device-id&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;" -
859 <list>
860 <t>in case the device was created successfully, where
861 &lt;device-id&gt; is the numerical ID of the new device, but there
862 are noteworthy issue(s) related (e.g. sound card doesn't
863 support given hardware parameters and the driver is using
864 fall-back values), providing an appropriate warning code and
865 warning message</t>
866 </list>
867 </t>
868 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
869 <list>
870 <t>in case it failed, providing an appropriate error code and error message</t>
871 </list>
872 </t>
873 </list>
874 </t>
875 <t>Examples:</t>
876 <t>
877 <list>
878 <t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"</t>
879 <t>S: "OK[0]"</t>
880 </list>
881 </t>
882 <t>
883 <list>
884 <t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"</t>
885 <t>S: "OK[1]"</t>
886 </list>
887 </t>
888 </section>
889
890 <section title="Destroying an audio output device" anchor="DESTROY AUDIO_OUTPUT_DEVICE">
891 <t>Use the following command to destroy a created output device:</t>
892 <t>
893 <list>
894 <t>DESTROY AUDIO_OUTPUT_DEVICE &lt;device-id&gt;</t>
895 </list>
896 </t>
897 <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
898 audio output device as given by the
899 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
900 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
901 command.</t>
902 <t>Possible Answers:</t>
903 <t>
904 <list>
905 <t>"OK" -
906 <list>
907 <t>in case the device was successfully destroyed</t>
908 </list>
909 </t>
910 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
911 <list>
912 <t>in case the device was destroyed successfully, but there are
913 noteworthy issue(s) related (e.g. an audio over ethernet
914 driver was unloaded but the other host might not be
915 informed about this situation), providing an appropriate
916 warning code and warning message</t>
917 </list>
918 </t>
919 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
920 <list>
921 <t>in case it failed, providing an appropriate error code and
922 error message</t>
923 </list>
924 </t>
925 </list>
926 </t>
927 <t>Example:</t>
928 <t>
929 <list>
930 <t>C: "DESTROY AUDIO_OUTPUT_DEVICE 0"</t>
931 <t>S: "OK"</t>
932 </list>
933 </t>
934 </section>
935
936 <section title="Getting all created audio output device count" anchor="GET AUDIO_OUTPUT_DEVICES">
937 <t>Use the following command to count all created audio output devices:</t>
938 <t>
939 <list>
940 <t>GET AUDIO_OUTPUT_DEVICES</t>
941 </list>
942 </t>
943 <t>Possible Answers:</t>
944 <t>
945 <list>
946 <t>LinuxSampler will answer by sending the current number of all
947 audio output devices.</t>
948 </list>
949 </t>
950 <t>Example:</t>
951 <t>
952 <list>
953 <t>C: "GET AUDIO_OUTPUT_DEVICES"</t>
954 <t>S: "4"</t>
955 </list>
956 </t>
957 </section>
958
959 <section title="Getting all created audio output device list" anchor="LIST AUDIO_OUTPUT_DEVICES">
960 <t>Use the following command to list all created audio output devices:</t>
961 <t>
962 <list>
963 <t>LIST AUDIO_OUTPUT_DEVICES</t>
964 </list>
965 </t>
966 <t>Possible Answers:</t>
967 <t>
968 <list>
969 <t>LinuxSampler will answer by sending a comma separated list with
970 the numerical IDs of all audio output devices.</t>
971 </list>
972 </t>
973 <t>Example:</t>
974 <t>
975 <list>
976 <t>C: "LIST AUDIO_OUTPUT_DEVICES"</t>
977 <t>S: "0,1,4,5"</t>
978 </list>
979 </t>
980 </section>
981
982 <section title="Getting current settings of an audio output device" anchor="GET AUDIO_OUTPUT_DEVICE INFO">
983 <t>Use the following command to get current settings of a specific, created audio output device:</t>
984 <t>
985 <list>
986 <t>GET AUDIO_OUTPUT_DEVICE INFO &lt;device-id&gt;</t>
987 </list>
988 </t>
989 <t>Where &lt;device-id&gt; should be replaced by numerical ID
990 of the audio output device as e.g. returned by the
991 <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> command.</t>
992 <t>Possible Answers:</t>
993 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
994 Each answer line begins with the information category name
995 followed by a colon and then a space character &lt;SP&gt; and finally
996 the info character string to that info category. As some
997 parameters might allow multiple values, character strings are
998 encapsulated into apostrophes ('). At the moment the following
999 information categories are defined (independently of device):</t>
1000 <t>
1001 <list>
1002 <t>DRIVER -
1003 <list>
1004 <t>identifier of the used audio output driver, as also
1005 returned by the
1006 <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
1007 "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref>
1008 command</t>
1009 </list>
1010 </t>
1011 <t>CHANNELS -
1012 <list>
1013 <t>amount of audio output channels this device currently
1014 offers</t>
1015 </list>
1016 </t>
1017 <t>SAMPLERATE -
1018 <list>
1019 <t>playback sample rate the device uses</t>
1020 </list>
1021 </t>
1022 <t>ACTIVE -
1023 <list>
1024 <t>either true or false, if false then the audio device is
1025 inactive and doesn't output any sound, nor do the
1026 sampler channels connected to this audio device render
1027 any audio</t>
1028 </list>
1029 </t>
1030 </list>
1031 </t>
1032 <t>The mentioned fields above don't have to be in particular
1033 order. The fields above are only those fields which are
1034 returned by all audio output devices. Every audio output driver
1035 might have its own, additional driver specific parameters (see
1036 <xref target="GET AUDIO_OUTPUT_DRIVER INFO" />)
1037 which are also returned by this command.</t>
1038 <t>Example:</t>
1039 <t>
1040 <list>
1041 <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t>
1042 <t>S: "DRIVER: ALSA"</t>
1043 <t>&nbsp;&nbsp;&nbsp;"CHANNELS: 2"</t>
1044 <t>&nbsp;&nbsp;&nbsp;"SAMPLERATE: 44100"</t>
1045 <t>&nbsp;&nbsp;&nbsp;"ACTIVE: true"</t>
1046 <t>&nbsp;&nbsp;&nbsp;"FRAGMENTS: 2"</t>
1047 <t>&nbsp;&nbsp;&nbsp;"FRAGMENTSIZE: 128"</t>
1048 <t>&nbsp;&nbsp;&nbsp;"CARD: '0,0'"</t>
1049 <t>&nbsp;&nbsp;&nbsp;"."</t>
1050 </list>
1051 </t>
1052 </section>
1053
1054
1055 <section title="Changing settings of audio output devices" anchor="SET AUDIO_OUTPUT_DEVICE_PARAMETER">
1056 <t>Use the following command to alter a specific setting of a created audio output device:</t>
1057 <t>
1058 <list>
1059 <t>SET AUDIO_OUTPUT_DEVICE_PARAMETER &lt;device-id&gt; &lt;key&gt;=&lt;value&gt;</t>
1060 </list>
1061 </t>
1062 <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
1063 audio output device as given by the
1064 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1065 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1066 command, &lt;key&gt; by the name of the parameter to change
1067 and &lt;value&gt; by the new value for this parameter.</t>
1068 <t>Possible Answers:</t>
1069 <t>
1070 <list>
1071 <t>"OK" -
1072 <list>
1073 <t>in case setting was successfully changed</t>
1074 </list>
1075 </t>
1076 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1077 <list>
1078 <t>in case setting was changed successfully, but there are
1079 noteworthy issue(s) related, providing an appropriate
1080 warning code and warning message</t>
1081 </list>
1082 </t>
1083 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1084 <list>
1085 <t>in case it failed, providing an appropriate error code and
1086 error message</t>
1087 </list>
1088 </t>
1089 </list>
1090 </t>
1091 <t>Example:</t>
1092 <t>
1093 <list>
1094 <t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"</t>
1095 <t>S: "OK"</t>
1096 </list>
1097 </t>
1098 </section>
1099
1100 <section title="Getting information about an audio channel" anchor="GET AUDIO_OUTPUT_CHANNEL INFO">
1101 <t>Use the following command to get information about an audio channel:</t>
1102 <t>
1103 <list>
1104 <t>GET AUDIO_OUTPUT_CHANNEL INFO &lt;device-id&gt; &lt;audio-chan&gt;</t>
1105 </list>
1106 </t>
1107 <t>Where &lt;device-id&gt; is the numerical ID of the audio output device as given by the
1108 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1109 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1110 command and &lt;audio-chan&gt; the audio channel number.</t>
1111 <t>Possible Answers:</t>
1112 <t>
1113 <list>
1114 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1115 Each answer line begins with the information category name
1116 followed by a colon and then a space character &lt;SP&gt; and finally
1117 the info character string to that info category. At the moment
1118 the following information categories are defined:</t>
1119
1120 <t>
1121 <list>
1122 <t>NAME -
1123 <list>
1124 <t>arbitrary character string naming the channel, which
1125 doesn't have to be unique (always returned by all audio channels)</t>
1126 </list>
1127 </t>
1128 <t>IS_MIX_CHANNEL -
1129 <list>
1130 <t>either true or false, a mix-channel is not a real,
1131 independent audio channel, but a virtual channel which
1132 is mixed to another real channel, this mechanism is
1133 needed for sampler engines which need more audio
1134 channels than the used audio system might be able to offer
1135 (always returned by all audio channels)</t>
1136 </list>
1137 </t>
1138 <t>MIX_CHANNEL_DESTINATION -
1139 <list>
1140 <t>numerical ID (positive integer including 0)
1141 which reflects the real audio channel (of the same audio
1142 output device) this mix channel refers to, means where
1143 the audio signal actually will be routed / added to
1144 (only returned in case the audio channel is mix channel)</t>
1145 </list>
1146 </t>
1147 </list>
1148 </t>
1149 </list>
1150 </t>
1151
1152 <t>The mentioned fields above don't have to be in particular
1153 order. The fields above are only those fields which are
1154 generally returned for the described cases by all audio
1155 channels regardless of the audio driver. Every audio channel
1156 might have its own, additional driver and channel specific
1157 parameters.</t>
1158
1159 <t>Examples:</t>
1160
1161 <t>
1162 <list>
1163 <t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"</t>
1164 <t>S: "NAME: studio monitor left"</t>
1165 <t>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: false"</t>
1166 <t>&nbsp;&nbsp;&nbsp;"."</t>
1167 </list>
1168 </t>
1169
1170 <t>
1171 <list>
1172 <t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 1"</t>
1173 <t>S: "NAME: studio monitor right"</t>
1174 <t>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: false"</t>
1175 <t>&nbsp;&nbsp;&nbsp;"."</t>
1176 </list>
1177 </t>
1178
1179 <t>
1180 <list>
1181 <t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 2"</t>
1182 <t>S: "NAME: studio monitor left"</t>
1183 <t>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: true"</t>
1184 <t>&nbsp;&nbsp;&nbsp;"MIX_CHANNEL_DESTINATION: 1"</t>
1185 <t>&nbsp;&nbsp;&nbsp;"."</t>
1186 </list>
1187 </t>
1188
1189 <t>
1190 <list>
1191 <t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"</t>
1192 <t>S: "NAME: 'ardour (left)'"</t>
1193 <t>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: false"</t>
1194 <t>&nbsp;&nbsp;&nbsp;"JACK_BINDINGS: 'ardour:0'"</t>
1195 <t>&nbsp;&nbsp;&nbsp;"."</t>
1196 </list>
1197 </t>
1198 </section>
1199
1200 <section title="Getting information about specific audio channel parameter" anchor="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO">
1201 <t>Use the following command to get detailed information about specific audio channel parameter:</t>
1202
1203 <t>
1204 <list>
1205 <t>GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO &lt;dev-id&gt; &lt;chan&gt; &lt;param&gt;</t>
1206 </list>
1207 </t>
1208
1209 <t>Where &lt;dev-id&gt; is the numerical ID of the audio output device as returned by the
1210 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1211 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1212 command, &lt;chan&gt; the audio channel number
1213 and &lt;param&gt; a specific channel parameter name for which information should
1214 be obtained (as returned by the <xref target="GET AUDIO_OUTPUT_CHANNEL INFO">
1215 "GET AUDIO_OUTPUT_CHANNEL INFO"</xref> command).</t>
1216 <t>Possible Answers:</t>
1217
1218 <t>
1219 <list>
1220 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1221 Each answer line begins with the information category name
1222 followed by a colon and then a space character &lt;SP&gt; and finally
1223 the info character string to that info category. There are
1224 information which is always returned, independently of the
1225 given channel parameter and there is optional information
1226 which is only shown dependently to the given audio channel. At
1227 the moment the following information categories are defined:</t>
1228 <t>
1229 <list>
1230 <t>TYPE -
1231 <list>
1232 <t>either "BOOL" for boolean value(s) or "INT" for integer
1233 value(s) or "FLOAT" for dotted number(s) or "STRING" for
1234 character string(s)
1235 (always returned)</t>
1236 </list>
1237 </t>
1238 <t>DESCRIPTION -
1239 <list>
1240 <t>arbitrary text describing the purpose of the parameter (always returned)</t>
1241 </list>
1242 </t>
1243 <t>FIX -
1244 <list>
1245 <t>either true or false, if true then this parameter is
1246 read only, thus cannot be altered
1247 (always returned)</t>
1248 </list>
1249 </t>
1250 <t>MULTIPLICITY -
1251 <list>
1252 <t>either true or false, defines if this parameter allows
1253 only one value or a list of values, where true means
1254 multiple values and false only a single value allowed
1255 (always returned)</t>
1256 </list>
1257 </t>
1258 <t>RANGE_MIN -
1259 <list>
1260 <t>defines lower limit of the allowed value range for this
1261 parameter, can be an integer value as well as a dotted
1262 number, usually used in conjunction with 'RANGE_MAX',
1263 but may also appear without
1264 (optionally returned, dependent to driver and channel
1265 parameter)</t>
1266 </list>
1267 </t>
1268 <t>RANGE_MAX -
1269 <list>
1270 <t>defines upper limit of the allowed value range for this
1271 parameter, can be an integer value as well as a dotted
1272 number, usually used in conjunction with 'RANGE_MIN',
1273 but may also appear without
1274 (optionally returned, dependent to driver and channel
1275 parameter)</t>
1276 </list>
1277 </t>
1278 <t>POSSIBILITIES -
1279 <list>
1280 <t>comma separated list of possible values for this
1281 parameter, character strings are encapsulated into
1282 apostrophes
1283 (optionally returned, dependent to driver and channel
1284 parameter)</t>
1285 </list>
1286 </t>
1287 </list>
1288 </t>
1289 <t>The mentioned fields above don't have to be in particular order.</t>
1290 </list>
1291 </t>
1292 <t>Example:</t>
1293 <t>
1294 <list>
1295 <t>C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"</t>
1296 <t>S: "DESCRIPTION: bindings to other JACK clients"</t>
1297 <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>
1298 <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
1299 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"</t>
1300 <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t>
1301 <t>&nbsp;&nbsp;&nbsp;"."</t>
1302 </list>
1303 </t>
1304 </section>
1305
1306 <section title="Changing settings of audio output channels" anchor="SET AUDIO_OUTPUT_CHANNEL_PARAMETER">
1307 <t>Use the following command to alter a specific setting of an audio output channel:</t>
1308 <t>
1309 <list>
1310 <t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER &lt;dev-id&gt; &lt;chn&gt; &lt;key&gt;=&lt;value&gt;</t>
1311 </list>
1312 </t>
1313 <t>Where &lt;dev-id&gt; should be replaced by the numerical ID of the audio output device as returned by the
1314 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1315 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1316 command, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the
1317 parameter to change and &lt;value&gt; by the new value for this parameter.</t>
1318 <t>Possible Answers:</t>
1319 <t>
1320 <list>
1321 <t>"OK" -
1322 <list>
1323 <t>in case setting was successfully changed</t>
1324 </list>
1325 </t>
1326 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1327 <list>
1328 <t>in case setting was changed successfully, but there are
1329 noteworthy issue(s) related, providing an appropriate
1330 warning code and warning message</t>
1331 </list>
1332 </t>
1333 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1334 <list>
1335 <t>in case it failed, providing an appropriate error code and
1336 error message</t>
1337 </list>
1338 </t>
1339 </list>
1340 </t>
1341 <t>Example:</t>
1342 <t>
1343 <list>
1344 <t>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:0'"</t>
1345 <t>S: "OK"</t>
1346 </list>
1347 </t>
1348 <t>
1349 <list>
1350 <t>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 NAME='monitor left'"</t>
1351 <t>S: "OK"</t>
1352 </list>
1353 </t>
1354 </section>
1355 </section>
1356
1357 <section title="Configuring MIDI input drivers">
1358 <t>Instances of drivers in LinuxSampler are called devices. You can use
1359 multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as
1360 MIDI input on one sampler channel and ALSA as MIDI input on another sampler
1361 channel. For particular MIDI input systems it's also possible to create
1362 several devices of the same MIDI input type. This chapter describes all
1363 commands to configure LinuxSampler's MIDI input devices and their parameters.</t>
1364
1365 <t>Instead of defining commands and parameters for each driver individually,
1366 all possible parameters, their meanings and possible values have to be obtained
1367 at runtime. This makes the protocol a bit abstract, but has the advantage, that
1368 front-ends can be written independently of what drivers are currently implemented
1369 and what parameters these drivers are actually offering. This means front-ends can
1370 even handle drivers which are implemented somewhere in future without modifying
1371 the front-end at all.</t>
1372
1373 <t>Commands for configuring MIDI input devices are pretty much the same as the
1374 commands for configuring audio output drivers, already described in the last
1375 chapter.</t>
1376
1377 <t>Note: examples in this chapter showing particular parameters of drivers are
1378 not meant as specification of the drivers' parameters. Driver implementations in
1379 LinuxSampler might have complete different parameter names and meanings than shown
1380 in these examples or might change in future, so these examples are only meant for
1381 showing how to retrieve what parameters drivers are offering, how to retrieve their
1382 possible values, etc.</t>
1383
1384 <section title="Getting amount of available MIDI input drivers" anchor="GET AVAILABLE_MIDI_INPUT_DRIVERS">
1385 <t>Use the following command to get the number of
1386 MIDI input drivers currently available for the
1387 LinuxSampler instance:</t>
1388 <t>
1389 <list>
1390 <t>GET AVAILABLE_MIDI_INPUT_DRIVERS</t>
1391 </list>
1392 </t>
1393 <t>Possible Answers:</t>
1394 <t>
1395 <list>
1396 <t>LinuxSampler will answer by sending the
1397 number of available MIDI input drivers.</t>
1398 </list>
1399 </t>
1400 <t>Example:</t>
1401 <t>
1402 <list>
1403 <t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t>
1404 <t>S: "2"</t>
1405 </list>
1406 </t>
1407 </section>
1408
1409 <section title="Getting all available MIDI input drivers" anchor="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1410 <t>Use the following command to list all MIDI input drivers currently available
1411 for the LinuxSampler instance:</t>
1412 <t>
1413 <list>
1414 <t>LIST AVAILABLE_MIDI_INPUT_DRIVERS</t>
1415 </list>
1416 </t>
1417 <t>Possible Answers:</t>
1418 <t>
1419 <list>
1420 <t>LinuxSampler will answer by sending comma separated character
1421 strings, each symbolizing a MIDI input driver.</t>
1422 </list>
1423 </t>
1424 <t>Example:</t>
1425 <t>
1426 <list>
1427 <t>C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</t>
1428 <t>S: "ALSA,JACK"</t>
1429 </list>
1430 </t>
1431 </section>
1432
1433 <section title="Getting information about a specific MIDI input driver" anchor="GET MIDI_INPUT_DRIVER INFO">
1434 <t>Use the following command to get detailed information about a specific MIDI input driver:</t>
1435 <t>
1436 <list>
1437 <t>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;</t>
1438 </list>
1439 </t>
1440 <t>Where &lt;midi-input-driver&gt; is the name of the MIDI input driver as returned
1441 by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1442 "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command.</t>
1443 <t>Possible Answers:</t>
1444 <t>
1445 <list>
1446 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1447 Each answer line begins with the information category name
1448 followed by a colon and then a space character &lt;SP&gt; and finally
1449 the info character string to that info category. At the moment
1450 the following information categories are defined:</t>
1451
1452 <t>
1453 <list>
1454 <t>DESCRIPTION -
1455 <list>
1456 <t>arbitrary description text about the MIDI input driver</t>
1457 </list>
1458 </t>
1459 <t>VERSION -
1460 <list>
1461 <t>arbitrary character string regarding the driver's version</t>
1462 </list>
1463 </t>
1464 <t>PARAMETERS -
1465 <list>
1466 <t>comma separated list of all parameters available for the given MIDI input driver</t>
1467 </list>
1468 </t>
1469 </list>
1470 </t>
1471
1472 <t>The mentioned fields above don't have to be in particular order.</t>
1473 </list>
1474 </t>
1475
1476 <t>Example:</t>
1477
1478 <t>
1479 <list>
1480 <t>C: "GET MIDI_INPUT_DRIVER INFO ALSA"</t>
1481 <t>S: "DESCRIPTION: Advanced Linux Sound Architecture"</t>
1482 <t>&nbsp;&nbsp;&nbsp;"VERSION: 1.0"</t>
1483 <t>&nbsp;&nbsp;&nbsp;"PARAMETERS: DRIVER,ACTIVE"</t>
1484 <t>&nbsp;&nbsp;&nbsp;"."</t>
1485 </list>
1486 </t>
1487 </section>
1488
1489 <section title="Getting information about specific MIDI input driver parameter" anchor="GET MIDI_INPUT_DRIVER_PARAMETER INFO">
1490 <t>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:</t>
1491 <t>
1492 <list>
1493 <t>GET MIDI_INPUT_DRIVER_PARAMETER INFO &lt;midit&gt; &lt;param&gt; [&lt;deplist&gt;]</t>
1494 </list>
1495 </t>
1496
1497 <t>Where &lt;midit&gt; is the name of the MIDI input driver as returned
1498 by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1499 "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command, &lt;param&gt; a specific
1500 parameter name for which information should be obtained (as returned by the
1501 <xref target="GET MIDI_INPUT_DRIVER INFO">
1502 "GET MIDI_INPUT_DRIVER INFO"</xref> command) and &lt;deplist&gt; is an optional list
1503 of parameters on which the sought parameter &lt;param&gt; depends on,
1504 &lt;deplist&gt; is a key-value pair list in form of "key1=val1 key2=val2 ...",
1505 where character string values are encapsulated into apostrophes ('). Arguments
1506 given with &lt;deplist&gt; which are not dependency parameters of &lt;param&gt;
1507 will be ignored, means the front-end application can simply put all parameters
1508 in &lt;deplist&gt; with the values selected by the user.</t>
1509
1510 <t>Possible Answers:</t>
1511
1512 <t>LinuxSampler will answer by sending a &lt;CRLF> separated list.
1513 Each answer line begins with the information category name
1514 followed by a colon and then a space character &lt;SP> and finally
1515 the info character string to that info category. There is
1516 information which is always returned, independent of the
1517 given driver parameter and there is optional information
1518 which is only shown dependent to given driver parameter. At
1519 the moment the following information categories are defined:</t>
1520
1521 <t>
1522 <list>
1523 <t>TYPE -
1524 <list>
1525 <t>either "BOOL" for boolean value(s) or "INT" for integer
1526 value(s) or "FLOAT" for dotted number(s) or "STRING" for
1527 character string(s)
1528 (always returned, no matter which driver parameter)</t>
1529 </list>
1530 </t>
1531
1532 <t>DESCRIPTION -
1533 <list>
1534 <t>arbitrary text describing the purpose of the parameter
1535 (always returned, no matter which driver parameter)</t>
1536 </list>
1537 </t>
1538
1539 <t>MANDATORY -
1540 <list>
1541 <t>either true or false, defines if this parameter must be
1542 given when the device is to be created with the
1543 <xref target="CREATE MIDI_INPUT_DEVICE">
1544 'CREATE MIDI_INPUT_DEVICE'</xref> command
1545 (always returned, no matter which driver parameter)</t>
1546 </list>
1547 </t>
1548
1549 <t>FIX -
1550 <list>
1551 <t>either true or false, if false then this parameter can
1552 be changed at any time, once the device is created by
1553 the <xref target="CREATE MIDI_INPUT_DEVICE">
1554 'CREATE MIDI_INPUT_DEVICE'</xref> command
1555 (always returned, no matter which driver parameter)</t>
1556 </list>
1557 </t>
1558
1559 <t>MULTIPLICITY -
1560 <list>
1561 <t>either true or false, defines if this parameter allows
1562 only one value or a list of values, where true means
1563 multiple values and false only a single value allowed
1564 (always returned, no matter which driver parameter)</t>
1565 </list>
1566 </t>
1567
1568 <t>DEPENDS -
1569 <list>
1570 <t>comma separated list of parameters this parameter depends
1571 on, means the values for fields 'DEFAULT', 'RANGE_MIN',
1572 'RANGE_MAX' and 'POSSIBILITIES' might depend on these
1573 listed parameters, for example assuming that an audio
1574 driver (like the ALSA driver) offers parameters 'card'
1575 and 'samplerate' then parameter 'samplerate' would
1576 depend on 'card' because the possible values for
1577 'samplerate' depends on the sound card which can be
1578 chosen by the 'card' parameter
1579 (optionally returned, dependent to driver parameter)</t>
1580 </list>
1581 </t>
1582
1583 <t>DEFAULT -
1584 <list>
1585 <t>reflects the default value for this parameter which is
1586 used when the device is created and not explicitly
1587 given with the <xref target="CREATE MIDI_INPUT_DEVICE">
1588 'CREATE MIDI_INPUT_DEVICE'</xref> command,
1589 in case of MULTIPLCITY=true, this is a comma separated
1590 list, that's why character strings are encapsulated into
1591 apostrophes (')
1592 (optionally returned, dependent to driver parameter)</t>
1593 </list>
1594 </t>
1595
1596 <t>RANGE_MIN -
1597 <list>
1598 <t>defines lower limit of the allowed value range for this
1599 parameter, can be an integer value as well as a dotted
1600 number, this parameter is often used in conjunction
1601 with RANGE_MAX, but may also appear without
1602 (optionally returned, dependent to driver parameter)</t>
1603 </list>
1604 </t>
1605
1606 <t>RANGE_MAX -
1607 <list>
1608 <t>defines upper limit of the allowed value range for this
1609 parameter, can be an integer value as well as a dotted
1610 number, this parameter is often used in conjunction with
1611 RANGE_MIN, but may also appear without
1612 (optionally returned, dependent to driver parameter)</t>
1613 </list>
1614 </t>
1615
1616 <t>POSSIBILITIES -
1617 <list>
1618 <t>comma separated list of possible values for this
1619 parameter, character strings are encapsulated into
1620 apostrophes
1621 (optionally returned, dependent to driver parameter)</t>
1622 </list>
1623 </t>
1624 </list>
1625 </t>
1626
1627 <t>The mentioned fields above don't have to be in particular order.</t>
1628
1629 <t>Example:</t>
1630 <t>
1631 <list>
1632 <t>C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"</t>
1633 <t>S: "DESCRIPTION: Whether device is enabled"</t>
1634 <t>&nbsp;&nbsp;&nbsp;"TYPE: BOOL"</t>
1635 <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>
1636 <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
1637 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>
1638 <t>&nbsp;&nbsp;&nbsp;"DEFAULT: true"</t>
1639 <t>&nbsp;&nbsp;&nbsp;"."</t>
1640 </list>
1641 </t>
1642 </section>
1643
1644 <section title="Creating a MIDI input device" anchor="CREATE MIDI_INPUT_DEVICE">
1645 <t>Use the following command to create a new MIDI input device for the desired MIDI input system:</t>
1646 <t>
1647 <list>
1648 <t>CREATE MIDI_INPUT_DEVICE &lt;midi-input-driver&gt; [&lt;param-list&gt;]</t>
1649 </list>
1650 </t>
1651
1652 <t>Where &lt;midi-input-driver&gt; should be replaced by the desired MIDI input system as returned
1653 by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1654 "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command and &lt;param-list&gt; by an
1655 optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where
1656 character string values should be encapsulated into apostrophes (').
1657 Note that there might be drivers which require parameter(s) to be
1658 given with this command. Use the previously described commands in
1659 this chapter to get that information.</t>
1660
1661 <t>Possible Answers:</t>
1662 <t>
1663 <list>
1664 <t>"OK[&lt;device-id&gt;]" -
1665 <list>
1666 <t>in case the device was successfully created, where
1667 &lt;device-id&gt; is the numerical ID of the new device</t>
1668 </list>
1669 </t>
1670 <t>"WRN[&lt;device-id&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1671 <list>
1672 <t>in case the driver was loaded successfully, where
1673 &lt;device-id&gt; is the numerical ID of the new device, but
1674 there are noteworthy issue(s) related, providing an
1675 appropriate warning code and warning message</t>
1676 </list>
1677 </t>
1678 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1679 <list>
1680 <t>in case it failed, providing an appropriate error code and error message</t>
1681 </list>
1682 </t>
1683 </list>
1684 </t>
1685 <t>Example:</t>
1686 <t>
1687 <list>
1688 <t>C: "CREATE MIDI_INPUT_DEVICE ALSA"</t>
1689 <t>S: "OK[0]"</t>
1690 </list>
1691 </t>
1692 </section>
1693
1694 <section title="Destroying a MIDI input device" anchor="DESTROY MIDI_INPUT_DEVICE">
1695 <t>Use the following command to destroy a created MIDI input device:</t>
1696 <t>
1697 <list>
1698 <t>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;</t>
1699 </list>
1700 </t>
1701 <t>Where &lt;device-id&gt; should be replaced by the device's numerical ID as returned by the
1702 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1703 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1704 command.</t>
1705 <t>Possible Answers:</t>
1706 <t>
1707 <list>
1708 <t>"OK" -
1709 <list>
1710 <t>in case the device was successfully destroyed</t>
1711 </list>
1712 </t>
1713 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1714 <list>
1715 <t>in case the device was destroyed, but there are noteworthy
1716 issue(s) related, providing an appropriate warning code and
1717 warning message</t>
1718 </list>
1719 </t>
1720 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1721 <list>
1722 <t>in case it failed, providing an appropriate error code and error message</t>
1723 </list>
1724 </t>
1725 </list>
1726 </t>
1727 <t>Example:</t>
1728 <t>
1729 <list>
1730 <t>C: "DESTROY MIDI_INPUT_DEVICE 0"</t>
1731 <t>S: "OK"</t>
1732 </list>
1733 </t>
1734 </section>
1735
1736 <section title="Getting all created MIDI input device count" anchor="GET MIDI_INPUT_DEVICES">
1737 <t>Use the following command to count all created MIDI input devices:</t>
1738 <t>
1739 <list>
1740 <t>GET MIDI_INPUT_DEVICES</t>
1741 </list>
1742 </t>
1743 <t>Possible Answers:</t>
1744 <t>
1745 <list>
1746 <t>LinuxSampler will answer by sending the current number of all
1747 MIDI input devices.</t>
1748 </list>
1749 </t>
1750 <t>Example:</t>
1751 <t>
1752 <list>
1753 <t>C: "GET MIDI_INPUT_DEVICES"</t>
1754 <t>S: "3"</t>
1755 </list>
1756 </t>
1757 </section>
1758
1759
1760 <section title="Getting all created MIDI input device list" anchor="LIST MIDI_INPUT_DEVICES">
1761 <t>Use the following command to list all created MIDI input devices:</t>
1762 <t>
1763 <list>
1764 <t>LIST MIDI_INPUT_DEVICES</t>
1765 </list>
1766 </t>
1767 <t>Possible Answers:</t>
1768 <t>
1769 <list>
1770 <t>LinuxSampler will answer by sending a comma separated list
1771 with the numerical Ids of all created MIDI input devices.</t>
1772 </list>
1773 </t>
1774 <t>Examples:</t>
1775 <t>
1776 <list>
1777 <t>C: "LIST MIDI_INPUT_DEVICES"</t>
1778 <t>S: "0,1,2"</t>
1779 </list>
1780 </t>
1781 <t>
1782 <list>
1783 <t>C: "LIST MIDI_INPUT_DEVICES"</t>
1784 <t>S: "1,3"</t>
1785 </list>
1786 </t>
1787 </section>
1788
1789 <section title="Getting current settings of a MIDI input device" anchor="GET MIDI_INPUT_DEVICE INFO">
1790 <t>Use the following command to get current settings of a specific, created MIDI input device:</t>
1791 <t>
1792 <list>
1793 <t>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;</t>
1794 </list>
1795 </t>
1796 <t>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
1797 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1798 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1799 command.</t>
1800 <t>Possible Answers:</t>
1801 <t>
1802 <list>
1803 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1804 Each answer line begins with the information category name
1805 followed by a colon and then a space character &lt;SP&gt; and finally
1806 the info character string to that info category. As some
1807 parameters might allow multiple values, character strings are
1808 encapsulated into apostrophes ('). At the moment the following
1809 information categories are defined (independent of driver):</t>
1810
1811 <t>
1812 <list>
1813 <t>DRIVER -
1814 <list>
1815 <t>identifier of the used MIDI input driver, as e.g.
1816 returned by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1817 "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref>
1818 command</t>
1819 </list>
1820 </t>
1821 </list>
1822 <list>
1823 <t>ACTIVE -
1824 <list>
1825 <t>either true or false, if false then the MIDI device is
1826 inactive and doesn't listen to any incoming MIDI events
1827 and thus doesn't forward them to connected sampler
1828 channels</t>
1829 </list>
1830 </t>
1831 </list>
1832 </t>
1833 </list>
1834 </t>
1835
1836 <t>The mentioned fields above don't have to be in particular
1837 order. The fields above are only those fields which are
1838 returned by all MIDI input devices. Every MIDI input driver
1839 might have its own, additional driver specific parameters (see
1840 <xref target="GET MIDI_INPUT_DRIVER INFO">
1841 "GET MIDI_INPUT_DRIVER INFO"</xref> command) which are also returned
1842 by this command.</t>
1843
1844 <t>Example:</t>
1845 <t>
1846 <list>
1847 <t>C: "GET MIDI_INPUT_DEVICE INFO 0"</t>
1848 <t>S: "DRIVER: ALSA"</t>
1849 <t>&nbsp;&nbsp;&nbsp;"ACTIVE: true"</t>
1850 <t>&nbsp;&nbsp;&nbsp;"."</t>
1851 </list>
1852 </t>
1853 </section>
1854
1855 <section title="Changing settings of MIDI input devices" anchor="SET MIDI_INPUT_DEVICE_PARAMETER">
1856 <t>Use the following command to alter a specific setting of a created MIDI input device:</t>
1857 <t>
1858 <list>
1859 <t>SET MIDI_INPUT_DEVICE_PARAMETER &lt;device-id&gt; &lt;key&gt;=&lt;value&gt;</t>
1860 </list>
1861 </t>
1862
1863 <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
1864 MIDI input device as returned by the
1865 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1866 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1867 command, &lt;key&gt; by the name of the parameter to change and
1868 &lt;value&gt; by the new value for this parameter.</t>
1869
1870 <t>Possible Answers:</t>
1871 <t>
1872 <list>
1873 <t>"OK" -
1874 <list>
1875 <t>in case setting was successfully changed</t>
1876 </list>
1877 </t>
1878 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1879 <list>
1880 <t>in case setting was changed successfully, but there are
1881 noteworthy issue(s) related, providing an appropriate
1882 warning code and warning message</t>
1883 </list>
1884 </t>
1885 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1886 <list>
1887 <t>in case it failed, providing an appropriate error code and error message</t>
1888 </list>
1889 </t>
1890 </list>
1891 </t>
1892 <t>Example:</t>
1893 <t>
1894 <list>
1895 <t>C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"</t>
1896 <t>S: "OK"</t>
1897 </list>
1898 </t>
1899 </section>
1900
1901 <section title="Getting information about a MIDI port" anchor="GET MIDI_INPUT_PORT INFO">
1902 <t>Use the following command to get information about a MIDI port:</t>
1903 <t>
1904 <list>
1905 <t>GET MIDI_INPUT_PORT INFO &lt;device-id&gt; &lt;midi-port&gt;</t>
1906 </list>
1907 </t>
1908 <t>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
1909 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1910 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1911 command and &lt;midi-port&gt; the MIDI input port number.</t>
1912 <t>Possible Answers:</t>
1913 <t>
1914 <list>
1915 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1916 Each answer line begins with the information category name
1917 followed by a colon and then a space character &lt;SP&gt; and finally
1918 the info character string to that info category. At the moment
1919 the following information categories are defined:</t>
1920
1921 <t>NAME -
1922 <list>
1923 <t>arbitrary character string naming the port</t>
1924 </list>
1925 </t>
1926 </list>
1927 </t>
1928
1929 <t>The field above is only the one which is returned by all MIDI
1930 ports regardless of the MIDI driver and port. Every MIDI port
1931 might have its own, additional driver and port specific
1932 parameters.</t>
1933
1934 <t>Example:</t>
1935 <t>
1936 <list>
1937 <t>C: "GET MIDI_INPUT_PORT INFO 0 0"</t>
1938 <t>S: "NAME: 'Masterkeyboard'"</t>
1939 <t>&nbsp;&nbsp;&nbsp;"ALSA_SEQ_BINDINGS: '64:0'"</t>
1940 <t>&nbsp;&nbsp;&nbsp;"."</t>
1941 </list>
1942 </t>
1943 </section>
1944
1945 <section title="Getting information about specific MIDI port parameter" anchor="GET MIDI_INPUT_PORT_PARAMETER INFO">
1946 <t>Use the following command to get detailed information about specific MIDI port parameter:</t>
1947 <t>
1948 <list>
1949 <t>GET MIDI_INPUT_PORT_PARAMETER INFO &lt;dev-id&gt; &lt;port&gt; &lt;param&gt;</t>
1950 </list>
1951 </t>
1952
1953 <t>Where &lt;dev-id&gt; is the numerical ID of the MIDI input device as returned by the
1954 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1955 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1956 command, &lt;port&gt; the MIDI port number and
1957 &lt;param&gt; a specific port parameter name for which information should be
1958 obtained (as returned by the <xref target="GET MIDI_INPUT_PORT INFO">
1959 "GET MIDI_INPUT_PORT INFO"</xref> command).</t>
1960
1961 <t>Possible Answers:</t>
1962 <t>
1963 <list>
1964 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1965 Each answer line begins with the information category name
1966 followed by a colon and then a space character &lt;SP&gt; and finally
1967 the info character string to that info category. There is
1968 information which is always returned, independently of the
1969 given channel parameter and there is optional information
1970 which are only shown dependently to the given MIDI port. At the
1971 moment the following information categories are defined:</t>
1972
1973 <t>TYPE -
1974 <list>
1975 <t>either "BOOL" for boolean value(s) or "INT" for integer
1976 value(s) or "FLOAT" for dotted number(s) or "STRING" for
1977 character string(s)
1978 (always returned)</t>
1979 </list>
1980 </t>
1981 <t>DESCRIPTION -
1982 <list>
1983 <t>arbitrary text describing the purpose of the parameter
1984 (always returned)</t>
1985 </list>
1986 </t>
1987 <t>FIX -
1988 <list>
1989 <t>either true or false, if true then this parameter is
1990 read only, thus cannot be altered
1991 (always returned)</t>
1992 </list>
1993 </t>
1994 <t>MULTIPLICITY -
1995 <list>
1996 <t>either true or false, defines if this parameter allows
1997 only one value or a list of values, where true means
1998 multiple values and false only a single value allowed
1999 (always returned)</t>
2000 </list>
2001 </t>
2002 <t>RANGE_MIN -
2003 <list>
2004 <t>defines lower limit of the allowed value range for this
2005 parameter, can be an integer value as well as a dotted
2006 number, this parameter is usually used in conjunction
2007 with 'RANGE_MAX' but may also appear without
2008 (optionally returned, dependent to driver and port
2009 parameter)</t>
2010 </list>
2011 </t>
2012 <t>RANGE_MAX -
2013 <list>
2014 <t>defines upper limit of the allowed value range for this
2015 parameter, can be an integer value as well as a dotted
2016 number, this parameter is usually used in conjunction
2017 with 'RANGE_MIN' but may also appear without
2018 (optionally returned, dependent to driver and port
2019 parameter)</t>
2020 </list>
2021 </t>
2022 <t>POSSIBILITIES -
2023 <list>
2024 <t>comma separated list of possible values for this
2025 parameter, character strings are encapsulated into
2026 apostrophes
2027 (optionally returned, dependent to device and port
2028 parameter)</t>
2029 </list>
2030 </t>
2031 </list>
2032 </t>
2033
2034 <t>The mentioned fields above don't have to be in particular order.</t>
2035
2036 <t>Example:</t>
2037 <t>
2038 <list>
2039 <t>C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"</t>
2040 <t>S: "DESCRIPTION: bindings to other ALSA sequencer clients"</t>
2041 <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>
2042 <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
2043 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"</t>
2044 <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: '64:0','68:0','68:1'"</t>
2045 <t>&nbsp;&nbsp;&nbsp;"."</t>
2046 </list>
2047 </t>
2048 </section>
2049
2050 <section title="Changing settings of MIDI input ports" anchor="SET MIDI_INPUT_PORT_PARAMETER">
2051 <t>Use the following command to alter a specific setting of a MIDI input port:</t>
2052 <t>
2053 <list>
2054 <t>SET MIDI_INPUT_PORT_PARAMETER &lt;device-id&gt; &lt;port&gt; &lt;key&gt;=&lt;value&gt;</t>
2055 </list>
2056 </t>
2057
2058 <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
2059 MIDI device as returned by the
2060 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
2061 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
2062 command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
2063 the parameter to change and &lt;value&gt; by the new value for this
2064 parameter.</t>
2065
2066 <t>Possible Answers:</t>
2067 <t>
2068 <list>
2069 <t>"OK" -
2070 <list>
2071 <t>in case setting was successfully changed</t>
2072 </list>
2073 </t>
2074 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2075 <list>
2076 <t>in case setting was changed successfully, but there are
2077 noteworthy issue(s) related, providing an appropriate
2078 warning code and warning message</t>
2079 </list>
2080 </t>
2081 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2082 <list>
2083 <t>in case it failed, providing an appropriate error code and error message</t>
2084 </list>
2085 </t>
2086 </list>
2087 </t>
2088 <t>Example:</t>
2089 <t>
2090 <list>
2091 <t></t>
2092 </list>
2093 </t>
2094 </section>
2095 </section>
2096
2097 <section title="Configuring sampler channels">
2098 <t>The following commands describe how to add and remove sampler channels, associate a
2099 sampler channel with a sampler engine, load instruments and connect sampler channels to
2100 MIDI and audio devices.</t>
2101
2102 <section title="Loading an instrument" anchor="LOAD INSTRUMENT">
2103 <t>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:</t>
2104 <t>
2105 <list>
2106 <t>LOAD INSTRUMENT [NON_MODAL] '&lt;filename&gt;' &lt;instr-index&gt; &lt;sampler-channel&gt;</t>
2107 </list>
2108 </t>
2109
2110 <t>Where &lt;filename&gt; is the name of the instrument file on the
2111 LinuxSampler instance's host system, &lt;instr-index&gt; the index of the
2112 instrument in the instrument file and &lt;sampler-channel> is the
2113 number of the sampler channel the instrument should be assigned to.
2114 Each sampler channel can only have one instrument.</t>
2115
2116 <t>The difference between regular and NON_MODAL versions of the command
2117 is that the regular command returns OK only after the instrument has been
2118 fully loaded and the channel is ready to be used while NON_MODAL version
2119 returns immediately and a background process is launched to load the instrument
2120 on the channel. The <xref target="GET CHANNEL INFO">GET CHANNEL INFO</xref>
2121 command can be used to obtain loading
2122 progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks
2123 such as making sure that the file could be read and it is of a proper format
2124 and SHOULD return ERR and SHOULD not launch the background process should any
2125 errors be detected at that point.</t>
2126
2127 <t>Possible Answers:</t>
2128 <t>
2129 <list>
2130 <t>"OK" -
2131 <list>
2132 <t>in case the instrument was successfully loaded</t>
2133 </list>
2134 </t>
2135 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2136 <list>
2137 <t>in case the instrument was loaded successfully, but there
2138 are noteworthy issue(s) related (e.g. Engine doesn't support
2139 one or more patch parameters provided by the loaded
2140 instrument file), providing an appropriate warning code and
2141 warning message</t>
2142 </list>
2143 </t>
2144 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2145 <list>
2146 <t>in case it failed, providing an appropriate error code and error message</t>
2147 </list>
2148 </t>
2149 </list>
2150 </t>
2151 <t>Example:</t>
2152 <t>
2153 <list>
2154 <t></t>
2155 </list>
2156 </t>
2157 </section>
2158
2159 <section title="Loading a sampler engine" anchor="LOAD ENGINE">
2160 <t>A sampler engine type can be associated to a specific sampler
2161 channel by the following command:</t>
2162 <t>
2163 <list>
2164 <t>LOAD ENGINE &lt;engine-name&gt; &lt;sampler-channel&gt;</t>
2165 </list>
2166 </t>
2167
2168 <t>Where &lt;engine-name&gt; is an engine name as obtained by the
2169 <xref target="LIST AVAILABLE_ENGINES">
2170 "LIST AVAILABLE_ENGINES"</xref> command and &lt;sampler-channel&gt;
2171 the sampler channel as returned by the
2172 <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> or
2173 <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command where
2174 the engine type should be assigned to. This command should be issued
2175 after adding a new sampler channel and before any other control
2176 commands on the new sampler channel. It can also be used to change
2177 the engine type of a sampler channel. This command has (currently) no
2178 way to define or force if a new engine instance should be created and
2179 assigned to the given sampler channel or if an already existing
2180 instance of that engine type, shared with other sampler channels,
2181 should be used.</t>
2182
2183 <t>Possible Answers:</t>
2184 <t>
2185 <list>
2186 <t>"OK" -
2187 <list>
2188 <t>in case the engine was successfully deployed</t>
2189 </list>
2190 </t>
2191 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2192 <list>
2193 <t>in case the engine was deployed successfully, but there
2194 are noteworthy issue(s) related, providing an appropriate
2195 warning code and warning message</t>
2196 </list>
2197 </t>
2198 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2199 <list>
2200 <t>in case it failed, providing an appropriate error code and
2201 error message</t>
2202 </list>
2203 </t>
2204 </list>
2205 </t>
2206 <t>Example:</t>
2207 <t>
2208 <list>
2209 <t></t>
2210 </list>
2211 </t>
2212 </section>
2213
2214 <section title="Getting all created sampler channel count" anchor="GET CHANNELS">
2215 <t>The number of sampler channels can change on runtime. To get the
2216 current amount of sampler channels, the front-end can send the
2217 following command:</t>
2218 <t>
2219 <list>
2220 <t>GET CHANNELS</t>
2221 </list>
2222 </t>
2223 <t>Possible Answers:</t>
2224 <t>
2225 <list>
2226 <t>LinuxSampler will answer by returning the current number of sampler channels.</t>
2227 </list>
2228 </t>
2229 <t>Example:</t>
2230 <t>
2231 <list>
2232 <t>C: "GET CHANNELS"</t>
2233 <t>S: "12"</t>
2234 </list>
2235 </t>
2236 </section>
2237
2238 <section title="Getting all created sampler channel list" anchor="LIST CHANNELS">
2239 <t>The number of sampler channels can change on runtime. To get the
2240 current list of sampler channels, the front-end can send the
2241 following command:</t>
2242 <t>
2243 <list>
2244 <t>LIST CHANNELS</t>
2245 </list>
2246 </t>
2247 <t>Possible Answers:</t>
2248 <t>
2249 <list>
2250 <t>LinuxSampler will answer by returning a comma separated list
2251 with all sampler channels numerical IDs.</t>
2252 </list>
2253 </t>
2254 <t>Example:</t>
2255 <t>
2256 <list>
2257 <t>C: "LIST CHANNELS"</t>
2258 <t>S: "0,1,2,3,4,5,6,9,10,11,15,20"</t>
2259 </list>
2260 </t>
2261 </section>
2262
2263 <section title="Adding a new sampler channel" anchor="ADD CHANNEL">
2264 <t>A new sampler channel can be added to the end of the sampler
2265 channel list by sending the following command:</t>
2266 <t>
2267 <list>
2268 <t>ADD CHANNEL</t>
2269 </list>
2270 </t>
2271 <t>This will increment the sampler channel count by one and the new
2272 sampler channel will be appended to the end of the sampler channel
2273 list. The front-end should send the respective, related commands
2274 right after to e.g. load an engine, load an instrument and setting
2275 input, output method and eventually other commands to initialize
2276 the new channel. The front-end should use the sampler channel
2277 returned by the answer of this command to perform the previously
2278 recommended commands, to avoid race conditions e.g. with other
2279 front-ends that might also have sent an "ADD CHANNEL" command.</t>
2280 <t>Possible Answers:</t>
2281 <t>
2282 <list>
2283 <t>"OK[&lt;sampler-channel&gt;]" -
2284 <list>
2285 <t>in case a new sampler channel could be added, where
2286 &lt;sampler-channel&gt; reflects the channel number of the new
2287 created sampler channel which should be used to set up
2288 the sampler channel by sending subsequent initialization
2289 commands</t>
2290 </list>
2291 </t>
2292 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2293 <list>
2294 <t>in case a new channel was added successfully, but there are
2295 noteworthy issue(s) related, providing an appropriate
2296 warning code and warning message</t>
2297 </list>
2298 </t>
2299 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2300 <list>
2301 <t>in case it failed, providing an appropriate error code and
2302 error message</t>
2303 </list>
2304 </t>
2305 </list>
2306 </t>
2307 <t>Example:</t>
2308 <t>
2309 <list>
2310 <t></t>
2311 </list>
2312 </t>
2313 </section>
2314
2315 <section title="Removing a sampler channel" anchor="REMOVE CHANNEL">
2316 <t>A sampler channel can be removed by sending the following command:</t>
2317 <t>
2318 <list>
2319 <t>REMOVE CHANNEL &lt;sampler-channel&gt;</t>
2320 </list>
2321 </t>
2322
2323 <t>Where &lt;sampler-channel&gt; should be replaced by the
2324 number of the sampler channel as given by the
2325 <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2326 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref>
2327 command. The channel numbers of all subsequent sampler channels
2328 remain the same.</t>
2329
2330 <t>Possible Answers:</t>
2331 <t>
2332 <list>
2333 <t>"OK" -
2334 <list>
2335 <t>in case the given sampler channel could be removed</t>
2336 </list>
2337 </t>
2338 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2339 <list>
2340 <t>in case the given channel was removed, but there are
2341 noteworthy issue(s) related, providing an appropriate
2342 warning code and warning message</t>
2343 </list>
2344 </t>
2345 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2346 <list>
2347 <t>in case it failed, providing an appropriate error code and
2348 error message</t>
2349 </list>
2350 </t>
2351 </list>
2352 </t>
2353 <t>Example:</t>
2354 <t>
2355 <list>
2356 <t></t>
2357 </list>
2358 </t>
2359 </section>
2360
2361 <section title="Getting amount of available engines" anchor="GET AVAILABLE_ENGINES">
2362 <t>The front-end can ask for the number of available engines by sending the following command:</t>
2363 <t>
2364 <list>
2365 <t>GET AVAILABLE_ENGINES</t>
2366 </list>
2367 </t>
2368 <t>Possible Answers:</t>
2369 <t>
2370 <list>
2371 <t>LinuxSampler will answer by sending the number of available engines.</t>
2372 </list>
2373 </t>
2374 <t>Example:</t>
2375 <t>
2376 <list>
2377 <t>C: "GET AVAILABLE_ENGINES"</t>
2378 <t>S: "4"</t>
2379 </list>
2380 </t>
2381 </section>
2382
2383 <section title="Getting all available engines" anchor="LIST AVAILABLE_ENGINES">
2384 <t>The front-end can ask for a list of all available engines by sending the following command:</t>
2385 <t>
2386 <list>
2387 <t>LIST AVAILABLE_ENGINES</t>
2388 </list>
2389 </t>
2390 <t>Possible Answers:</t>
2391 <t>
2392 <list>
2393 <t>LinuxSampler will answer by sending a comma separated list
2394 of the engines' names encapsulated into apostrophes (').
2395 Engine names can consist of lower and upper cases,
2396 digits and underlines ("_" character).</t>
2397 </list>
2398 </t>
2399 <t>Example:</t>
2400 <t>
2401 <list>
2402 <t>C: "LIST AVAILABLE_ENGINES"</t>
2403 <t>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"</t>
2404 </list>
2405 </t>
2406 </section>
2407
2408 <section title="Getting information about an engine" anchor="GET ENGINE INFO">
2409 <t>The front-end can ask for information about a specific engine by
2410 sending the following command:</t>
2411 <t>
2412 <list>
2413 <t>GET ENGINE INFO &lt;engine-name&gt;</t>
2414 </list>
2415 </t>
2416 <t>Where &lt;engine-name&gt; is an engine name as obtained by the
2417 <xref target="LIST AVAILABLE_ENGINES">
2418 "LIST AVAILABLE_ENGINES"</xref> command.</t>
2419 <t>Possible Answers:</t>
2420 <t>
2421 <list>
2422 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
2423 Each answer line begins with the information category name
2424 followed by a colon and then a space character &lt;SP&gt; and finally
2425 the info character string to that info category. At the moment
2426 the following categories are defined:</t>
2427
2428 <t>
2429 <list>
2430 <t>DESCRIPTION -
2431 <list>
2432 <t>arbitrary description text about the engine</t>
2433 </list>
2434 </t>
2435 <t>VERSION -
2436 <list>
2437 <t>arbitrary character string regarding the engine's version</t>
2438 </list>
2439 </t>
2440 </list>
2441 </t>
2442 </list>
2443 </t>
2444
2445 <t>The mentioned fields above don't have to be in particular order.</t>
2446
2447 <t>Example:</t>
2448 <t>
2449 <list>
2450 <t>C: "GET ENGINE INFO JoesCustomEngine"</t>
2451 <t>S: "DESCRIPTION: this is Joe's custom sampler engine"</t>
2452 <t>&nbsp;&nbsp;&nbsp;"VERSION: testing-1.0"</t>
2453 <t>&nbsp;&nbsp;&nbsp;"."</t>
2454 </list>
2455 </t>
2456 </section>
2457
2458 <section title="Getting sampler channel information" anchor="GET CHANNEL INFO">
2459 <t>The front-end can ask for the current settings of a sampler channel
2460 by sending the following command:</t>
2461 <t>
2462 <list>
2463 <t>GET CHANNEL INFO &lt;sampler-channel&gt;</t>
2464 </list>
2465 </t>
2466 <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
2467 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2468 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2469 <t>Possible Answers:</t>
2470 <t>
2471 <list>
2472 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
2473 Each answer line begins with the settings category name
2474 followed by a colon and then a space character &lt;SP&gt; and finally
2475 the info character string to that setting category. At the
2476 moment the following categories are defined:</t>
2477
2478 <t>
2479 <list>
2480 <t>ENGINE_NAME -
2481 <list>
2482 <t>name of the engine that is associated with the sampler
2483 channel, "NONE" if there's no engine associated yet for
2484 this sampler channel</t>
2485 </list>
2486 </t>
2487 <t>AUDIO_OUTPUT_DEVICE -
2488 <list>
2489 <t>numerical ID of the audio output device which is
2490 currently connected to this sampler channel to output
2491 the audio signal, "NONE" if there's no device
2492 connected to this sampler channel</t>
2493 </list>
2494 </t>
2495 <t>AUDIO_OUTPUT_CHANNELS -
2496 <list>
2497 <t>number of output channels the sampler channel offers
2498 (dependent to used sampler engine and loaded instrument)</t>
2499 </list>
2500 </t>
2501 <t>AUDIO_OUTPUT_ROUTING -
2502 <list>
2503 <t>comma separated list which reflects to which audio
2504 channel of the selected audio output device each
2505 sampler output channel is routed to, e.g. "0,3" would
2506 mean the engine's output channel 0 is routed to channel
2507 0 of the audio output device and the engine's output
2508 channel 1 is routed to the channel 3 of the audio
2509 output device</t>
2510 </list>
2511 </t>
2512 <t>INSTRUMENT_FILE -
2513 <list>
2514 <t>the file name of the loaded instrument, "NONE" if
2515 there's no instrument yet loaded for this sampler
2516 channel</t>
2517 </list>
2518 </t>
2519 <t>INSTRUMENT_NR -
2520 <list>
2521 <t>the instrument index number of the loaded instrument</t>
2522 </list>
2523 </t>
2524 <t>INSTRUMENT_NAME -
2525 <list>
2526 <t>the instrument name of the loaded instrument</t>
2527 </list>
2528 </t>
2529 <t>INSTRUMENT_STATUS -
2530 <list>
2531 <t>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative
2532 value indicates a loading exception. Value of 100 indicates that the instrument is fully
2533 loaded.</t>
2534 </list>
2535 </t>
2536 <t>MIDI_INPUT_DEVICE -
2537 <list>
2538 <t>numerical ID of the MIDI input device which is
2539 currently connected to this sampler channel to deliver
2540 MIDI input commands, "NONE" if there's no device
2541 connected to this sampler channel</t>
2542 </list>
2543 </t>
2544 <t>MIDI_INPUT_PORT -
2545 <list>
2546 <t>port number of the MIDI input device</t>
2547 </list>
2548 </t>
2549 <t>MIDI_INPUT_CHANNEL -
2550 <list>
2551 <t>the MIDI input channel number this sampler channel
2552 should listen to or "ALL" to listen on all MIDI channels</t>
2553 </list>
2554 </t>
2555 <t>VOLUME -
2556 <list>
2557 <t>optionally dotted number for the channel volume factor
2558 (where a value &lt; 1.0 means attenuation and a value >
2559 1.0 means amplification)</t>
2560 </list>
2561 </t>
2562 <t>MUTE -
2563 <list>
2564 <t>Determines whether the channel is muted, "true" if the
2565 channel is muted, "false" if the channel is not muted, and
2566 "MUTED_BY_SOLO" if the channel is muted because of the
2567 presence of a solo channel and will be unmuted when
2568 there are no solo channels left</t>
2569 </list>
2570 </t>
2571 <t>SOLO -
2572 <list>
2573 <t>Determines whether this is a solo channel, "true" if
2574 the channel is a solo channel; "false" otherwise</t>
2575 </list>
2576 </t>
2577 <t>MIDI_INSTRUMENT_MAP -
2578 <list>
2579 <t>Determines to which MIDI instrument map this sampler
2580 channel is assigned to. Read chapter
2581 <xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref>
2582 for a list of possible values.</t>
2583 </list>
2584 </t>
2585 </list>
2586 </t>
2587 </list>
2588 </t>
2589 <t>The mentioned fields above don't have to be in particular order.</t>
2590
2591 <t>Example:</t>
2592 <t>
2593 <list>
2594 <t>C: "GET CHANNEL INFO 34"</t>
2595 <t>S: "ENGINE_NAME: GigEngine"</t>
2596 <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
2597 <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_DEVICE: 0"</t>
2598 <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_CHANNELS: 2"</t>
2599 <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 0,1"</t>
2600 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"</t>
2601 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
2602 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Fazioli Piano"</t>
2603 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_STATUS: 100"</t>
2604 <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_DEVICE: 0"</t>
2605 <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_PORT: 0"</t>
2606 <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"</t>
2607 <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
2608 <t>&nbsp;&nbsp;&nbsp;"MUTE: false"</t>
2609 <t>&nbsp;&nbsp;&nbsp;"SOLO: false"</t>
2610 <t>&nbsp;&nbsp;&nbsp;"MIDI_INSTRUMENT_MAP: NONE"</t>
2611 <t>&nbsp;&nbsp;&nbsp;"."</t>
2612 </list>
2613 </t>
2614 </section>
2615
2616 <section title="Current number of active voices" anchor="GET CHANNEL VOICE_COUNT">
2617 <t>The front-end can ask for the current number of active voices on a
2618 sampler channel by sending the following command:</t>
2619 <t>
2620 <list>
2621 <t>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;</t>
2622 </list>
2623 </t>
2624 <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
2625 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2626 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2627
2628 <t>Possible Answers:</t>
2629 <t>
2630 <list>
2631 <t>LinuxSampler will answer by returning the number of active
2632 voices on that channel.</t>
2633 </list>
2634 </t>
2635 <t>Example:</t>
2636 <t>
2637 <list>
2638 <t></t>
2639 </list>
2640 </t>
2641 </section>
2642
2643 <section title="Current number of active disk streams" anchor="GET CHANNEL STREAM_COUNT">
2644 <t>The front-end can ask for the current number of active disk streams
2645 on a sampler channel by sending the following command:</t>
2646 <t>
2647 <list>
2648 <t>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;</t>
2649 </list>
2650 </t>
2651 <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
2652 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2653 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2654
2655 <t>Possible Answers:</t>
2656 <t>
2657 <list>
2658 <t>LinuxSampler will answer by returning the number of active
2659 disk streams on that channel in case the engine supports disk
2660 streaming, if the engine doesn't support disk streaming it will
2661 return "NA" for not available.</t>
2662 </list>
2663 </t>
2664 <t>Example:</t>
2665 <t>
2666 <list>
2667 <t></t>
2668 </list>
2669 </t>
2670 </section>
2671
2672 <section title="Current fill state of disk stream buffers" anchor="GET CHANNEL BUFFER_FILL">
2673 <t>The front-end can ask for the current fill state of all disk streams
2674 on a sampler channel by sending the following command:</t>
2675 <t>
2676 <list>
2677 <t>GET CHANNEL BUFFER_FILL BYTES &lt;sampler-channel&gt;</t>
2678 </list>
2679 </t>
2680 <t>to get the fill state in bytes or</t>
2681 <t>
2682 <list>
2683 <t>GET CHANNEL BUFFER_FILL PERCENTAGE &lt;sampler-channel&gt;</t>
2684 </list>
2685 </t>
2686 <t>to get the fill state in percent, where &lt;sampler-channel&gt; is the
2687 sampler channel number the front-end is interested in
2688 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2689 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2690
2691 <t>Possible Answers:</t>
2692 <t>
2693 <list>
2694 <t>LinuxSampler will either answer by returning a comma separated
2695 string with the fill state of all disk stream buffers on that
2696 channel or an empty line if there are no active disk streams or
2697 "NA" for *not available* in case the engine which is deployed
2698 doesn't support disk streaming. Each entry in the answer list
2699 will begin with the stream's ID in brackets followed by the
2700 numerical representation of the fill size (either in bytes or
2701 percentage). Note: due to efficiency reasons the fill states in
2702 the response are not in particular order, thus the front-end has
2703 to sort them by itself if necessary.</t>
2704 </list>
2705 </t>
2706 <t>Examples:</t>
2707 <t>
2708 <list>
2709 <t>C: "GET CHANNEL BUFFER_FILL BYTES 4"</t>
2710 <t>S: "[115]420500,[116]510300,[75]110000,[120]230700"</t>
2711 </list>
2712
2713 <list>
2714 <t>C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"</t>
2715 <t>S: "[115]90%,[116]98%,[75]40%,[120]62%"</t>
2716 </list>
2717
2718 <list>
2719 <t>C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"</t>
2720 <t>S: ""</t>
2721 </list>
2722 </t>
2723 </section>
2724
2725 <section title="Setting audio output device" anchor="SET CHANNEL AUDIO_OUTPUT_DEVICE">
2726 <t>The front-end can set the audio output device on a specific sampler
2727 channel by sending the following command:</t>
2728 <t>
2729 <list>
2730 <t>SET CHANNEL AUDIO_OUTPUT_DEVICE &lt;sampler-channel&gt; &lt;audio-device-id&gt;</t>
2731 </list>
2732 </t>
2733 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
2734 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2735 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
2736 &lt;audio-device-id&gt; is the numerical ID of the audio output device as given by the
2737 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
2738 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
2739 command.</t>
2740
2741 <t>Possible Answers:</t>
2742 <t>
2743 <list>
2744 <t>"OK" -
2745 <list>
2746 <t>on success</t>
2747 </list>
2748 </t>
2749 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2750 <list>
2751 <t>if audio output device was set, but there are noteworthy
2752 issue(s) related, providing an appropriate warning code and
2753 warning message</t>
2754 </list>
2755 </t>
2756 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2757 <list>
2758 <t>in case it failed, providing an appropriate error code and error message</t>
2759 </list>
2760 </t>
2761 </list>
2762 </t>
2763 <t>Examples:</t>
2764 <t>
2765 <list>
2766 <t></t>
2767 </list>
2768 </t>
2769 </section>
2770
2771 <section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYPE">
2772 <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>
2773
2774 <t>The front-end can alter the audio output type on a specific sampler
2775 channel by sending the following command:</t>
2776 <t>
2777 <list>
2778 <t>SET CHANNEL AUDIO_OUTPUT_TYPE &lt;sampler-channel&gt; &lt;audio-output-type&gt;</t>
2779 </list>
2780 </t>
2781 <t>Where &lt;audio-output-type&gt; is currently either "ALSA" or "JACK" and
2782 &lt;sampler-channel&gt; is the respective sampler channel number.</t>
2783
2784 <t>Possible Answers:</t>
2785 <t>
2786 <list>
2787 <t>"OK" -
2788 <list>
2789 <t>on success</t>
2790 </list>
2791 </t>
2792 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2793 <list>
2794 <t>if audio output type was set, but there are noteworthy
2795 issue(s) related, providing an appropriate warning code and
2796 warning message</t>
2797 </list>
2798 </t>
2799 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2800 <list>
2801 <t>in case it failed, providing an appropriate error code and error message</t>
2802 </list>
2803 </t>
2804 </list>
2805 </t>
2806 <t>Examples:</t>
2807 <t>
2808 <list>
2809 <t></t>
2810 </list>
2811 </t>
2812 </section>
2813
2814 <section title="Setting audio output channel" anchor="SET CHANNEL AUDIO_OUTPUT_CHANNEL">
2815 <t>The front-end can alter the audio output channel on a specific
2816 sampler channel by sending the following command:</t>
2817 <t>
2818 <list>
2819 <t>SET CHANNEL AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;audio-out&gt; &lt;audio-in&gt;</t>
2820 </list>
2821 </t>
2822 <t>Where &lt;sampler-chan&gt; is the sampler channel number
2823 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2824 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, &lt;audio-out&gt; is the
2825 numerical ID of the sampler channel's audio output channel which should be
2826 rerouted and &lt;audio-in&gt; is the numerical ID of the audio channel of the selected audio
2827 output device where &lt;audio-out&gt; should be routed to.</t>
2828
2829 <t>Possible Answers:</t>
2830 <t>
2831 <list>
2832 <t>"OK" -
2833 <list>
2834 <t>on success</t>
2835 </list>
2836 </t>
2837 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2838 <list>
2839 <t>if audio output channel was set, but there are noteworthy
2840 issue(s) related, providing an appropriate warning code and
2841 warning message</t>
2842 </list>
2843 </t>
2844 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2845 <list>
2846 <t>in case it failed, providing an appropriate error code and error message</t>
2847 </list>
2848 </t>
2849 </list>
2850 </t>
2851 <t>Examples:</t>
2852 <t>
2853 <list>
2854 <t></t>
2855 </list>
2856 </t>
2857 </section>
2858
2859 <section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE">
2860 <t>The front-end can set the MIDI input device on a specific sampler
2861 channel by sending the following command:</t>
2862 <t>
2863 <list>
2864 <t>SET CHANNEL MIDI_INPUT_DEVICE &lt;sampler-channel&gt; &lt;midi-device-id&gt;</t>
2865 </list>
2866 </t>
2867 <t>Where &lt;sampler-channel&gt; is the sampler channel number
2868 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2869 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command
2870 and &lt;midi-device-id&gt; is the numerical ID of the MIDI input device as returned by the
2871 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
2872 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command.</t>
2873
2874 <t>Possible Answers:</t>
2875 <t>
2876 <list>
2877 <t>"OK" -
2878 <list>
2879 <t>on success</t>
2880 </list>
2881 </t>
2882 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2883 <list>
2884 <t>if MIDI input device was set, but there are noteworthy
2885 issue(s) related, providing an appropriate warning code and
2886 warning message</t>
2887 </list>
2888 </t>
2889 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2890 <list>
2891 <t>in case it failed, providing an appropriate error code and error message</t>
2892 </list>
2893 </t>
2894 </list>
2895 </t>
2896 <t>Examples:</t>
2897 <t>
2898 <list>
2899 <t></t>
2900 </list>
2901 </t>
2902 </section>
2903
2904 <section title="Setting MIDI input type" anchor="SET CHANNEL MIDI_INPUT_TYPE">
2905 <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>
2906
2907 <t>The front-end can alter the MIDI input type on a specific sampler
2908 channel by sending the following command:</t>
2909 <t>
2910 <list>
2911 <t>SET CHANNEL MIDI_INPUT_TYPE &lt;sampler-channel&gt; &lt;midi-input-type&gt;</t>
2912 </list>
2913 </t>
2914 <t>Where &lt;midi-input-type&gt; is currently only "ALSA" and
2915 &lt;sampler-channel&gt; is the respective sampler channel number.</t>
2916
2917 <t>Possible Answers:</t>
2918 <t>
2919 <list>
2920 <t>"OK" -
2921 <list>
2922 <t>on success</t>
2923 </list>
2924 </t>
2925 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2926 <list>
2927 <t>if MIDI input type was set, but there are noteworthy
2928 issue(s) related, providing an appropriate warning code and
2929 warning message</t>
2930 </list>
2931 </t>
2932 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2933 <list>
2934 <t>in case it failed, providing an appropriate error code and error message</t>
2935 </list>
2936 </t>
2937 </list>
2938 </t>
2939 <t>Examples:</t>
2940 <t>
2941 <list>
2942 <t></t>
2943 </list>
2944 </t>
2945 </section>
2946
2947 <section title="Setting MIDI input port" anchor="SET CHANNEL MIDI_INPUT_PORT">
2948 <t>The front-end can alter the MIDI input port on a specific sampler
2949 channel by sending the following command:</t>
2950 <t>
2951 <list>
2952 <t>SET CHANNEL MIDI_INPUT_PORT &lt;sampler-channel&gt; &lt;midi-input-port&gt;</t>
2953 </list>
2954 </t>
2955 <t>Where &lt;midi-input-port&gt; is a MIDI input port number of the
2956 MIDI input device connected to the sampler channel given by
2957 &lt;sampler-channel&gt;.</t>
2958
2959 <t>Possible Answers:</t>
2960 <t>
2961 <list>
2962 <t>"OK" -
2963 <list>
2964 <t>on success</t>
2965 </list>
2966 </t>
2967 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2968 <list>
2969 <t>if MIDI input port was set, but there are noteworthy
2970 issue(s) related, providing an appropriate warning code and
2971 warning message</t>
2972 </list>
2973 </t>
2974 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2975 <list>
2976 <t>in case it failed, providing an appropriate error code and error message</t>
2977 </list>
2978 </t>
2979 </list>
2980 </t>
2981 <t>Examples:</t>
2982 <t>
2983 <list>
2984 <t></t>
2985 </list>
2986 </t>
2987 </section>
2988
2989 <section title="Setting MIDI input channel" anchor="SET CHANNEL MIDI_INPUT_CHANNEL">
2990 <t>The front-end can alter the MIDI channel a sampler channel should
2991 listen to by sending the following command:</t>
2992 <t>
2993 <list>
2994 <t>SET CHANNEL MIDI_INPUT_CHANNEL &lt;sampler-channel&gt; &lt;midi-input-chan&gt;</t>
2995 </list>
2996 </t>
2997 <t>Where &lt;midi-input-chan&gt; is the number of the new MIDI input channel where
2998 &lt;sampler-channel&gt; should listen to or "ALL" to listen on all 16 MIDI
2999 channels.</t>
3000
3001 <t>Possible Answers:</t>
3002 <t>
3003 <list>
3004 <t>"OK" -
3005 <list>
3006 <t>on success</t>
3007 </list>
3008 </t>
3009 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3010 <list>
3011 <t>if MIDI input channel was set, but there are noteworthy
3012 issue(s) related, providing an appropriate warning code and
3013 warning message</t>
3014 </list>
3015 </t>
3016 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3017 <list>
3018 <t>in case it failed, providing an appropriate error code and error message</t>
3019 </list>
3020 </t>
3021 </list>
3022 </t>
3023 <t>Examples:</t>
3024 <t>
3025 <list>
3026 <t></t>
3027 </list>
3028 </t>
3029 </section>
3030
3031 <section title="Setting channel volume" anchor="SET CHANNEL VOLUME">
3032 <t>The front-end can alter the volume of a sampler channel by sending
3033 the following command:</t>
3034 <t>
3035 <list>
3036 <t>SET CHANNEL VOLUME &lt;sampler-channel&gt; &lt;volume&gt;</t>
3037 </list>
3038 </t>
3039 <t>Where &lt;volume&gt; is an optionally dotted positive number (a value
3040 smaller than 1.0 means attenuation, whereas a value greater than
3041 1.0 means amplification) and &lt;sampler-channel&gt; defines the sampler
3042 channel where this volume factor should be set.</t>
3043
3044 <t>Possible Answers:</t>
3045 <t>
3046 <list>
3047 <t>"OK" -
3048 <list>
3049 <t>on success</t>
3050 </list>
3051 </t>
3052 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3053 <list>
3054 <t>if channel volume was set, but there are noteworthy
3055 issue(s) related, providing an appropriate warning code and
3056 warning message</t>
3057 </list>
3058 </t>
3059 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3060 <list>
3061 <t>in case it failed, providing an appropriate error code and error message</t>
3062 </list>
3063 </t>
3064 </list>
3065 </t>
3066 <t>Examples:</t>
3067 <t>
3068 <list>
3069 <t></t>
3070 </list>
3071 </t>
3072 </section>
3073
3074 <section title="Muting a sampler channel" anchor="SET CHANNEL MUTE">
3075 <t>The front-end can mute/unmute a specific sampler
3076 channel by sending the following command:</t>
3077 <t>
3078 <list>
3079 <t>SET CHANNEL MUTE &lt;sampler-channel&gt; &lt;mute&gt;</t>
3080 </list>
3081 </t>
3082 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3083 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3084 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3085 &lt;mute&gt; should be replaced either by "1" to mute the channel or "0"
3086 to unmute the channel.</t>
3087
3088 <t>Possible Answers:</t>
3089 <t>
3090 <list>
3091 <t>"OK" -
3092 <list>
3093 <t>on success</t>
3094 </list>
3095 </t>
3096 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3097 <list>
3098 <t>if the channel was muted/unmuted, but there are noteworthy
3099 issue(s) related, providing an appropriate warning code and
3100 warning message</t>
3101 </list>
3102 </t>
3103 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3104 <list>
3105 <t>in case it failed, providing an appropriate error code and error message</t>
3106 </list>
3107 </t>
3108 </list>
3109 </t>
3110 <t>Examples:</t>
3111 <t>
3112 <list>
3113 <t></t>
3114 </list>
3115 </t>
3116 </section>
3117
3118 <section title="Soloing a sampler channel" anchor="SET CHANNEL SOLO">
3119 <t>The front-end can solo/unsolo a specific sampler channel
3120 by sending the following command:</t>
3121 <t>
3122 <list>
3123 <t>SET CHANNEL SOLO &lt;sampler-channel&gt; &lt;solo&gt;</t>
3124 </list>
3125 </t>
3126 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3127 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3128 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3129 &lt;solo&gt; should be replaced either by "1" to solo the channel or "0"
3130 to unsolo the channel.</t>
3131
3132 <t>Possible Answers:</t>
3133 <t>
3134 <list>
3135 <t>"OK" -
3136 <list>
3137 <t>on success</t>
3138 </list>
3139 </t>
3140 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3141 <list>
3142 <t>if the channel was soloed/unsoloed, but there are noteworthy
3143 issue(s) related, providing an appropriate warning code and
3144 warning message</t>
3145 </list>
3146 </t>
3147 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3148 <list>
3149 <t>in case it failed, providing an appropriate error code and error message</t>
3150 </list>
3151 </t>
3152 </list>
3153 </t>
3154 <t>Examples:</t>
3155 <t>
3156 <list>
3157 <t></t>
3158 </list>
3159 </t>
3160 </section>
3161
3162 <section title="Assigning a MIDI instrument map to a sampler channel" anchor="SET CHANNEL MIDI_INSTRUMENT_MAP">
3163 <t>The front-end can assign a MIDI instrument map to a specific sampler channel
3164 by sending the following command:</t>
3165 <t>
3166 <list>
3167 <t>SET CHANNEL MIDI_INSTRUMENT_MAP &lt;sampler-channel&gt; &lt;map&gt;</t>
3168 </list>
3169 </t>
3170 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3171 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3172 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3173 &lt;map&gt; can have the following possibilites:</t>
3174 <t>
3175 <list>
3176 <t>"NONE" -
3177 <list>
3178 <t>This is the default setting. In this case
3179 the sampler channel is not assigned any MIDI
3180 instrument map and thus will ignore all MIDI
3181 program change messages.</t>
3182 </list>
3183 </t>
3184 <t>"DEFAULT" -
3185 <list>
3186 <t>The sampler channel will always use the
3187 default MIDI instrument map to handle MIDI
3188 program change messages.</t>
3189 </list>
3190 </t>
3191 <t>numeric ID -
3192 <list>
3193 <t>You can assign a specific MIDI instrument map
3194 by replacing &lt;map&gt; with the respective numeric
3195 ID of the MIDI instrument map as returned by the
3196 <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
3197 command. Once that map will be deleted, the sampler
3198 channel would fall back to "NONE".</t>
3199 </list>
3200 </t>
3201 </list>
3202 </t>
3203 <t>Read chapter <xref target="MIDI Instrument Mapping">"MIDI Instrument Mapping"</xref>
3204 for details regarding MIDI instrument mapping.</t>
3205
3206 <t>Possible Answers:</t>
3207 <t>
3208 <list>
3209 <t>"OK" -
3210 <list>
3211 <t>on success</t>
3212 </list>
3213 </t>
3214 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3215 <list>
3216 <t>in case it failed, providing an appropriate error code and error message</t>
3217 </list>
3218 </t>
3219 </list>
3220 </t>
3221
3222 <t>Examples:</t>
3223 <t>
3224 <list>
3225 <t></t>
3226 </list>
3227 </t>
3228 </section>
3229
3230 <section title="Adding an effect send to a sampler channel" anchor="CREATE FX_SEND">
3231 <t>The front-end can create an additional effect send on a specific sampler channel
3232 by sending the following command:</t>
3233 <t>
3234 <list>
3235 <t>CREATE FX_SEND &lt;sampler-channel&gt; &lt;midi-ctrl&gt; [&lt;name&gt;]</t>
3236 </list>
3237 </t>
3238 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3239 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3240 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the
3241 sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
3242 is a number between 0..127 defining the MIDI controller which can alter the
3243 effect send level and &lt;name&gt; is an optional argument defining a name
3244 for the effect send entity. The name does not have to be unique.</t>
3245
3246 <t>By default, that is as initial routing, the effect send's audio channels
3247 are automatically routed to the last audio channels of the sampler channel's
3248 audio output device, that way you can i.e. first increase the amount of audio
3249 channels on the audio output device for having dedicated effect send output
3250 channels and when "CREATE FX_SEND" is called, those channels will automatically
3251 be picked. You can alter the destination channels however with
3252 <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>.
3253 </t>
3254
3255 <t>Note: Create effect sends on a sampler channel only when needed, because having effect
3256 sends on a sampler channel will decrease runtime performance, because for implementing channel
3257 effect sends, separate (sampler channel local) audio buffers are needed to render and mix
3258 the voices and route the audio signal afterwards to the master outputs and effect send
3259 outputs (along with their respective effect send levels). A sampler channel without effect
3260 sends however can mix its voices directly into the audio output devices's audio buffers
3261 and is thus faster.
3262 </t>
3263
3264 <t>Possible Answers:</t>
3265 <t>
3266 <list>
3267 <t>"OK[&lt;fx-send-id&gt;]" -
3268 <list>
3269 <t>in case a new effect send could be added to the
3270 sampler channel, where &lt;fx-send-id&gt; reflects the
3271 unique ID of the newly created effect send entity</t>
3272 </list>
3273 </t>
3274 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3275 <list>
3276 <t>when a new effect send could not be added, i.e.
3277 due to invalid parameters</t>
3278 </list>
3279 </t>
3280 </list>
3281 </t>
3282
3283 <t>Examples:</t>
3284 <t>
3285 <list>
3286 <t>C: "CREATE FX_SEND 0 91 'Reverb Send'"</t>
3287 <t>S: "OK[0]"</t>
3288 </list>
3289 </t>
3290 <t>
3291 <list>
3292 <t>C: "CREATE FX_SEND 0 93"</t>
3293 <t>S: "OK[1]"</t>
3294 </list>
3295 </t>
3296 </section>
3297
3298 <section title="Removing an effect send from a sampler channel" anchor="DESTROY FX_SEND">
3299 <t>The front-end can remove an existing effect send on a specific sampler channel
3300 by sending the following command:</t>
3301 <t>
3302 <list>
3303 <t>DESTROY FX_SEND &lt;sampler-channel&gt; &lt;fx-send-id&gt;</t>
3304 </list>
3305 </t>
3306 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3307 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3308 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the
3309 sampler channel from which the effect send should be removed from and
3310 &lt;fx-send-id&gt; is the respective effect send number as returned by the
3311 <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3312 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t>
3313
3314 <t>Possible Answers:</t>
3315 <t>
3316 <list>
3317 <t>"OK" -
3318 <list>
3319 <t>on success</t>
3320 </list>
3321 </t>
3322 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3323 <list>
3324 <t>in case it failed, providing an appropriate error code and
3325 error message</t>
3326 </list>
3327 </t>
3328 </list>
3329 </t>
3330
3331 <t>Example:</t>
3332 <t>
3333 <list>
3334 <t>C: "DESTROY FX_SEND 0 0"</t>
3335 <t>S: "OK"</t>
3336 </list>
3337 </t>
3338 </section>
3339
3340 <section title="Getting amount of effect sends on a sampler channel" anchor="GET FX_SENDS">
3341 <t>The front-end can ask for the amount of effect sends on a specific sampler channel
3342 by sending the following command:</t>
3343 <t>
3344 <list>
3345 <t>GET FX_SENDS &lt;sampler-channel&gt;</t>
3346 </list>
3347 </t>
3348 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3349 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3350 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
3351
3352 <t>Possible Answers:</t>
3353 <t>
3354 <list>
3355 <t>The sampler will answer by returning the number of effect
3356 sends on the given sampler channel.</t>
3357 </list>
3358 </t>
3359
3360 <t>Example:</t>
3361 <t>
3362 <list>
3363 <t>C: "GET FX_SENDS 0"</t>
3364 <t>S: "2"</t>
3365 </list>
3366 </t>
3367 </section>
3368
3369 <section title="Listing all effect sends on a sampler channel" anchor="LIST FX_SENDS">
3370 <t>The front-end can ask for a list of effect sends on a specific sampler channel
3371 by sending the following command:</t>
3372 <t>
3373 <list>
3374 <t>LIST FX_SENDS &lt;sampler-channel&gt;</t>
3375 </list>
3376 </t>
3377 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3378 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3379 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
3380
3381 <t>Possible Answers:</t>
3382 <t>
3383 <list>
3384 <t>The sampler will answer by returning a comma separated list
3385 with all effect sends' numerical IDs on the given sampler
3386 channel.</t>
3387 </list>
3388 </t>
3389
3390 <t>Examples:</t>
3391 <t>
3392 <list>
3393 <t>C: "LIST FX_SENDS 0"</t>
3394 <t>S: "0,1"</t>
3395 </list>
3396 </t>
3397 <t>
3398 <list>
3399 <t>C: "LIST FX_SENDS 1"</t>
3400 <t>S: ""</t>
3401 </list>
3402 </t>
3403 </section>
3404
3405 <section title="Getting effect send information" anchor="GET FX_SEND INFO">
3406 <t>The front-end can ask for the current settings of an effect send entity
3407 by sending the following command:</t>
3408 <t>
3409 <list>
3410 <t>GET FX_SEND INFO &lt;sampler-channel&gt; &lt;fx-send-id&gt;</t>
3411 </list>
3412 </t>
3413 <t>Where &lt;sampler-channel&gt; is the sampler channel number
3414 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3415 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3416 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3417 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3418 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.
3419 </t>
3420
3421 <t>Possible Answers:</t>
3422 <t>
3423 <list>
3424 <t>The sampler will answer by sending a &lt;CRLF&gt; separated list.
3425 Each answer line begins with the settings category name
3426 followed by a colon and then a space character &lt;SP&gt; and finally
3427 the info character string to that setting category. At the
3428 moment the following categories are defined:</t>
3429
3430 <t>
3431 <list>
3432 <t>NAME -
3433 <list>
3434 <t>name of the effect send entity</t>
3435 </list>
3436 </t>
3437 <t>MIDI_CONTROLLER -
3438 <list>
3439 <t>a value between 0 and 127 reflecting the MIDI controller
3440 which is able to modify the effect send's send level</t>
3441 </list>
3442 </t>
3443 <t>LEVEL -
3444 <list>
3445 <t>optionally dotted number reflecting the effect send's
3446 current send level (where a value &lt; 1.0 means attenuation
3447 and a value > 1.0 means amplification)</t>
3448 </list>
3449 </t>
3450 <t>AUDIO_OUTPUT_ROUTING -
3451 <list>
3452 <t>comma separated list which reflects to which audio
3453 channel of the selected audio output device each
3454 effect send output channel is routed to, e.g. "0,3" would
3455 mean the effect send's output channel 0 is routed to channel
3456 0 of the audio output device and the effect send's output
3457 channel 1 is routed to the channel 3 of the audio
3458 output device (see
3459 <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>
3460 for details)</t>
3461 </list>
3462 </t>
3463 </list>
3464 </t>
3465 </list>
3466 </t>
3467 <t>The mentioned fields above don't have to be in particular order.</t>
3468
3469 <t>Example:</t>
3470 <t>
3471 <list>
3472 <t>C: "GET FX_SEND INFO 0 0"</t>
3473 <t>S: "NAME: Reverb Send"</t>
3474 <t>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"</t>
3475 <t>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"</t>
3476 <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"</t>
3477 <t>&nbsp;&nbsp;&nbsp;"."</t>
3478 </list>
3479 </t>
3480 </section>
3481
3482 <section title="Changing effect send's name" anchor="SET FX_SEND NAME">
3483 <t>The front-end can alter the current name of an effect
3484 send entity by sending the following command:</t>
3485 <t>
3486 <list>
3487 <t>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;</t>
3488 </list>
3489 </t>
3490 <t>Where &lt;sampler-chan&gt; is the sampler channel number
3491 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3492 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3493 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3494 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3495 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3496 &lt;name&gt; is the new name of the effect send entity, which
3497 does not have to be unique.</t>
3498
3499 <t>Possible Answers:</t>
3500 <t>
3501 <list>
3502 <t>"OK" -
3503 <list>
3504 <t>on success</t>
3505 </list>
3506 </t>
3507 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3508 <list>
3509 <t>in case it failed, providing an appropriate error code and error message</t>
3510 </list>
3511 </t>
3512 </list>
3513 </t>
3514 <t>Example:</t>
3515 <t>
3516 <list>
3517 <t>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"</t>
3518 <t>S: "OK"</t>
3519 </list>
3520 </t>
3521 </section>
3522
3523 <section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL">
3524 <t>The front-end can alter the destination of an effect send's audio channel on a specific
3525 sampler channel by sending the following command:</t>
3526 <t>
3527 <list>
3528 <t>SET FX_SEND AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;audio-src&gt; &lt;audio-dst&gt;</t>
3529 </list>
3530 </t>
3531 <t>Where &lt;sampler-chan&gt; is the sampler channel number
3532 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3533 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3534 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3535 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3536 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command,
3537 &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
3538 which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
3539 the audio channel of the selected audio output device where &lt;audio-src&gt;
3540 should be routed to.</t>
3541
3542 <t>Note that effect sends can only route audio to the same audio output
3543 device as assigned to the effect send's sampler channel. Also note that an
3544 effect send entity does always have exactly as much audio channels as its
3545 sampler channel. So if the sampler channel is stereo, the effect send does
3546 have two audio channels as well. Also keep in mind that the amount of audio
3547 channels on a sampler channel might be dependant not only to the deployed
3548 sampler engine on the sampler channel, but also dependant to the instrument
3549 currently loaded. However you can (effectively) turn an i.e. stereo effect
3550 send into a mono one by simply altering its audio routing appropriately.</t>
3551
3552 <t>Possible Answers:</t>
3553 <t>
3554 <list>
3555 <t>"OK" -
3556 <list>
3557 <t>on success</t>
3558 </list>
3559 </t>
3560 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3561 <list>
3562 <t>if audio output channel was set, but there are noteworthy
3563 issue(s) related, providing an appropriate warning code and
3564 warning message</t>
3565 </list>
3566 </t>
3567 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3568 <list>
3569 <t>in case it failed, providing an appropriate error code and error message</t>
3570 </list>
3571 </t>
3572 </list>
3573 </t>
3574 <t>Example:</t>
3575 <t>
3576 <list>
3577 <t>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"</t>
3578 <t>S: "OK"</t>
3579 </list>
3580 </t>
3581 </section>
3582
3583 <section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER">
3584 <t>The front-end can alter the MIDI controller of an effect
3585 send entity by sending the following command:</t>
3586 <t>
3587 <list>
3588 <t>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;</t>
3589 </list>
3590 </t>
3591 <t>Where &lt;sampler-chan&gt; is the sampler channel number
3592 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3593 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3594 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3595 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3596 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3597 &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
3598 able to modify the effect send's send level.</t>
3599
3600 <t>Possible Answers:</t>
3601 <t>
3602 <list>
3603 <t>"OK" -
3604 <list>
3605 <t>on success</t>
3606 </list>
3607 </t>
3608 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3609 <list>
3610 <t>if MIDI controller was set, but there are noteworthy
3611 issue(s) related, providing an appropriate warning code and
3612 warning message</t>
3613 </list>
3614 </t>
3615 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3616 <list>
3617 <t>in case it failed, providing an appropriate error code and error message</t>
3618 </list>
3619 </t>
3620 </list>
3621 </t>
3622 <t>Example:</t>
3623 <t>
3624 <list>
3625 <t>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"</t>
3626 <t>S: "OK"</t>
3627 </list>
3628 </t>
3629 </section>
3630
3631 <section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL">
3632 <t>The front-end can alter the current send level of an effect
3633 send entity by sending the following command:</t>
3634 <t>
3635 <list>
3636 <t>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;</t>
3637 </list>
3638 </t>
3639 <t>Where &lt;sampler-chan&gt; is the sampler channel number
3640 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3641 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3642 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3643 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3644 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3645 &lt;volume&gt; is an optionally dotted positive number (a value
3646 smaller than 1.0 means attenuation, whereas a value greater than
3647 1.0 means amplification) reflecting the new send level.</t>
3648
3649 <t>Possible Answers:</t>
3650 <t>
3651 <list>
3652 <t>"OK" -
3653 <list>
3654 <t>on success</t>
3655 </list>
3656 </t>
3657 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3658 <list>
3659 <t>if new send level was set, but there are noteworthy
3660 issue(s) related, providing an appropriate warning code and
3661 warning message</t>
3662 </list>
3663 </t>
3664 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3665 <list>
3666 <t>in case it failed, providing an appropriate error code and error message</t>
3667 </list>
3668 </t>
3669 </list>
3670 </t>
3671 <t>Example:</t>
3672 <t>
3673 <list>
3674 <t>C: "SET FX_SEND LEVEL 0 0 0.15"</t>
3675 <t>S: "OK"</t>
3676 </list>
3677 </t>
3678 </section>
3679
3680 <section title="Resetting a sampler channel" anchor="RESET CHANNEL">
3681 <t>The front-end can reset a particular sampler channel by sending the following command:</t>
3682 <t>
3683 <list>
3684 <t>RESET CHANNEL &lt;sampler-channel&gt;</t>
3685 </list>
3686 </t>
3687 <t>
3688 Where &lt;sampler-channel&gt; defines the sampler channel to be reset.
3689 This will cause the engine on that sampler channel, its voices and
3690 eventually disk streams and all control and status variables to be
3691 reset.</t>
3692
3693 <t>Possible Answers:</t>
3694 <t>
3695 <list>
3696 <t>"OK" -
3697 <list>
3698 <t>on success</t>
3699 </list>
3700 </t>
3701 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3702 <list>
3703 <t>if channel was reset, but there are noteworthy issue(s)
3704 related, providing an appropriate warning code and warning
3705 message</t>
3706 </list>
3707 </t>
3708 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3709 <list>
3710 <t>in case it failed, providing an appropriate error code and
3711 error message</t>
3712 </list>
3713 </t>
3714 </list>
3715 </t>
3716 <t>Examples:</t>
3717 <t>
3718 <list>
3719 <t></t>
3720 </list>
3721 </t>
3722 </section>
3723 </section>
3724
3725 <section title="Controlling connection">
3726 <t>The following commands are used to control the connection to LinuxSampler.</t>
3727
3728 <section title="Register front-end for receiving event messages" anchor="SUBSCRIBE">
3729 <t>The front-end can register itself to the LinuxSampler application to
3730 be informed about noteworthy events by sending this command:</t>
3731 <t>
3732 <list>
3733 <t>SUBSCRIBE &lt;event-id&gt;</t>
3734 </list>
3735 </t>
3736 <t>where &lt;event-id&gt; will be replaced by the respective event that
3737 client wants to subscribe to.</t>
3738
3739 <t>Possible Answers:</t>
3740 <t>
3741 <list>
3742 <t>"OK" -
3743 <list>
3744 <t>on success</t>
3745 </list>
3746 </t>
3747 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3748 <list>
3749 <t>if registration succeeded, but there are noteworthy
3750 issue(s) related, providing an appropriate warning code and
3751 warning message</t>
3752 </list>
3753 </t>
3754 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3755 <list>
3756 <t>in case it failed, providing an appropriate error code and
3757 error message</t>
3758 </list>
3759 </t>
3760 </list>
3761 </t>
3762 <t>Examples:</t>
3763 <t>
3764 <list>
3765 <t></t>
3766 </list>
3767 </t>
3768 </section>
3769
3770 <section title="Unregister front-end for not receiving event messages" anchor="UNSUBSCRIBE">
3771 <t>The front-end can unregister itself if it doesn't want to receive event
3772 messages anymore by sending the following command:</t>
3773 <t>
3774 <list>
3775 <t>UNSUBSCRIBE &lt;event-id&gt;</t>
3776 </list>
3777 </t>
3778 <t>Where &lt;event-id&gt; will be replaced by the respective event that
3779 client doesn't want to receive anymore.</t>
3780
3781 <t>Possible Answers:</t>
3782 <t>
3783 <list>
3784 <t>"OK" -
3785 <list>
3786 <t>on success</t>
3787 </list>
3788 </t>
3789 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3790 <list>
3791 <t>if unregistration succeeded, but there are noteworthy
3792 issue(s) related, providing an appropriate warning code and
3793 warning message</t>
3794 </list>
3795 </t>
3796 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3797 <list>
3798 <t>in case it failed, providing an appropriate error code and
3799 error message</t>
3800 </list>
3801 </t>
3802 </list>
3803 </t>
3804 <t>Examples:</t>
3805 <t>
3806 <list>
3807 <t></t>
3808 </list>
3809 </t>
3810 </section>
3811
3812 <section title="Enable or disable echo of commands" anchor="SET ECHO">
3813 <t>To enable or disable back sending of commands to the client the following command can be used:</t>
3814 <t>
3815 <list>
3816 <t>SET ECHO &lt;value&gt;</t>
3817 </list>
3818 </t>
3819 <t>Where &lt;value&gt; should be replaced either by "1" to enable echo mode
3820 or "0" to disable echo mode. When echo mode is enabled, all
3821 commands send to LinuxSampler will be immediately send back and
3822 after this echo the actual response to the command will be
3823 returned. Echo mode will only be altered for the client connection
3824 that issued the "SET ECHO" command, not globally for all client
3825 connections.</t>
3826
3827 <t>Possible Answers:</t>
3828 <t>
3829 <list>
3830 <t>"OK" -
3831 <list>
3832 <t>usually</t>
3833 </list>
3834 </t>
3835 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3836 <list>
3837 <t>on syntax error, e.g. non boolean value</t>
3838 </list>
3839 </t>
3840 </list>
3841 </t>
3842 <t>Examples:</t>
3843 <t>
3844 <list>
3845 <t></t>
3846 </list>
3847 </t>
3848 </section>
3849
3850 <section title="Close client connection" anchor="QUIT">
3851 <t>The client can close its network connection to LinuxSampler by sending the following command:</t>
3852 <t>
3853 <list>
3854 <t>QUIT</t>
3855 </list>
3856 </t>
3857 <t>This is probably more interesting for manual telnet connections to
3858 LinuxSampler than really useful for a front-end implementation.</t>
3859 </section>
3860 </section>
3861
3862 <section title="Global commands">
3863 <t>The following commands have global impact on the sampler.</t>
3864
3865 <section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT">
3866 <t>The front-end can ask for the current number of active voices on
3867 the sampler by sending the following command:</t>
3868 <t>
3869 <list>
3870 <t>GET TOTAL_VOICE_COUNT</t>
3871 </list>
3872 </t>
3873
3874 <t>Possible Answers:</t>
3875 <t>
3876 <list>
3877 <t>LinuxSampler will answer by returning the number of all active
3878 voices on the sampler.</t>
3879 </list>
3880 </t>
3881 </section>
3882
3883 <section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX">
3884 <t>The front-end can ask for the maximum number of active voices
3885 by sending the following command:</t>
3886 <t>
3887 <list>
3888 <t>GET TOTAL_VOICE_COUNT_MAX</t>
3889 </list>
3890 </t>
3891
3892 <t>Possible Answers:</t>
3893 <t>
3894 <list>
3895 <t>LinuxSampler will answer by returning the maximum number
3896 of active voices.</t>
3897 </list>
3898 </t>
3899 </section>
3900
3901 <section title="Reset sampler" anchor="RESET">
3902 <t>The front-end can reset the whole sampler by sending the following command:</t>
3903 <t>
3904 <list>
3905 <t>RESET</t>
3906 </list>
3907 </t>
3908
3909 <t>Possible Answers:</t>
3910 <t>
3911 <list>
3912 <t>"OK" -
3913 <list>
3914 <t>always</t>
3915 </list>
3916 </t>
3917 </list>
3918 </t>
3919 <t>Examples:</t>
3920 <t>
3921 <list>
3922 <t></t>
3923 </list>
3924 </t>
3925 </section>
3926
3927 <section title="General sampler informations" anchor="GET SERVER INFO">
3928 <t>The client can ask for general informations about the LinuxSampler
3929 instance by sending the following command:</t>
3930 <t>
3931 <list>
3932 <t>GET SERVER INFO</t>
3933 </list>
3934 </t>
3935 <t>Possible Answers:</t>
3936 <t>
3937 <list>
3938 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
3939 Each answer line begins with the information category name
3940 followed by a colon and then a space character &lt;SP&gt; and finally
3941 the info character string to that information category. At the
3942 moment the following categories are defined:
3943 </t>
3944 <t>
3945 <list>
3946 <t>DESCRIPTION -
3947 <list>
3948 <t>arbitrary textual description about the sampler</t>
3949 </list>
3950 </t>
3951 <t>VERSION -
3952 <list>
3953 <t>version of the sampler</t>
3954 </list>
3955 </t>
3956 <t>PROTOCOL_VERSION -
3957 <list>
3958 <t>version of the LSCP specification the sampler
3959 complies with (see <xref target="LSCP versioning" /> for details)</t>
3960 </list>
3961 </t>
3962 <t>INSTRUMENTS_DB_SUPPORT -
3963 <list>
3964 <t>either yes or no, specifies whether the
3965 sampler is build with instruments database support.</t>
3966 </list>
3967 </t>
3968 </list>
3969 </t>
3970 </list>
3971 </t>
3972 <t>The mentioned fields above don't have to be in particular order.
3973 Other fields might be added in future.</t>
3974 </section>
3975
3976 <section title="Getting global volume attenuation" anchor="GET VOLUME">
3977 <t>The client can ask for the current global sampler-wide volume
3978 attenuation by sending the following command:</t>
3979 <t>
3980 <list>
3981 <t>GET VOLUME</t>
3982 </list>
3983 </t>
3984 <t>Possible Answers:</t>
3985 <t>
3986 <list>
3987 <t>The sampler will always answer by returning the optional
3988 dotted floating point coefficient, reflecting the current
3989 global volume attenuation.
3990 </t>
3991 </list>
3992 </t>
3993 <t>Note: it is up to the respective sampler engine whether to obey
3994 that global volume parameter or not, but in general all engines SHOULD
3995 use this parameter.</t>
3996 </section>
3997
3998 <section title="Setting global volume attenuation" anchor="SET VOLUME">
3999 <t>The client can alter the current global sampler-wide volume
4000 attenuation by sending the following command:</t>
4001 <t>
4002 <list>
4003 <t>SET VOLUME &lt;volume&gt;</t>
4004 </list>
4005 </t>
4006 <t>Where &lt;volume&gt; should be replaced by the optional dotted
4007 floating point value, reflecting the new global volume parameter.
4008 This value might usually be in the range between 0.0 and 1.0, that
4009 is for attenuating the overall volume.</t>
4010
4011 <t>Possible Answers:</t>
4012 <t>
4013 <list>
4014 <t>"OK" -
4015 <list>
4016 <t>on success</t>
4017 </list>
4018 </t>
4019 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4020 <list>
4021 <t>if the global volume was set, but there are noteworthy
4022 issue(s) related, providing an appropriate warning code and
4023 warning message</t>
4024 </list>
4025 </t>
4026 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4027 <list>
4028 <t>in case it failed, providing an appropriate error code and error message</t>
4029 </list>
4030 </t>
4031 </list>
4032 </t>
4033 </section>
4034 </section>
4035
4036
4037 <section title="MIDI Instrument Mapping" anchor="MIDI Instrument Mapping">
4038 <t>The MIDI protocol provides a way to switch between instruments
4039 by sending so called MIDI bank select and MIDI program change
4040 messages which are essentially just numbers. The following commands
4041 allow to actually map arbitrary MIDI bank select / program change
4042 numbers with real instruments.</t>
4043 <t>The sampler allows to manage an arbitrary amount of MIDI
4044 instrument maps which define which instrument to load on
4045 which MIDI program change message.</t>
4046 <t>By default, that is when the sampler is launched, there is no
4047 map, thus the sampler will simply ignore all program change
4048 messages. The front-end has to explicitly create at least one
4049 map, add entries to the map and tell the respective sampler
4050 channel(s) which MIDI instrument map to use, so the sampler
4051 knows how to react on a given program change message on the
4052 respective sampler channel, that is by switching to the
4053 respectively defined engine type and loading the respective
4054 instrument. See command
4055 <xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref>
4056 for how to assign a MIDI instrument map to a sampler channel.</t>
4057 <t>Also note per MIDI specification a bank select message does not
4058 cause to switch to another instrument. Instead when receiving a
4059 bank select message the bank value will be stored and a subsequent
4060 program change message (which may occur at any time) will finally
4061 cause the sampler to switch to the respective instrument as
4062 reflected by the current MIDI instrument map.</t>
4063
4064 <section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT MAP">
4065 <t>The front-end can add a new MIDI instrument map by sending
4066 the following command:</t>
4067 <t>
4068 <list>
4069 <t>ADD MIDI_INSTRUMENT_MAP [&lt;name&gt;]</t>
4070 </list>
4071 </t>
4072 <t>Where &lt;name&gt; is an optional argument allowing to
4073 assign a custom name to the new map. MIDI instrument Map
4074 names do not have to be unique.</t>
4075
4076 <t>Possible Answers:</t>
4077 <t>
4078 <list>
4079 <t>"OK[&lt;map&gt;]" -
4080 <list>
4081 <t>in case a new MIDI instrument map could
4082 be added, where &lt;map&gt; reflects the
4083 unique ID of the newly created MIDI
4084 instrument map</t>
4085 </list>
4086 </t>
4087 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4088 <list>
4089 <t>when a new map could not be created, which
4090 might never occur in practice</t>
4091 </list>
4092 </t>
4093 </list>
4094 </t>
4095
4096 <t>Examples:</t>
4097 <t>
4098 <list>
4099 <t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"</t>
4100 <t>S: "OK[0]"</t>
4101 </list>
4102 </t>
4103 <t>
4104 <list>
4105 <t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"</t>
4106 <t>S: "OK[1]"</t>
4107 </list>
4108 </t>
4109 <t>
4110 <list>
4111 <t>C: "ADD MIDI_INSTRUMENT_MAP"</t>
4112 <t>S: "OK[5]"</t>
4113 </list>
4114 </t>
4115 </section>
4116
4117 <section title="Delete one particular or all MIDI instrument maps" anchor="REMOVE MIDI_INSTRUMENT_MAP">
4118 <t>The front-end can delete a particular MIDI instrument map
4119 by sending the following command:</t>
4120 <t>
4121 <list>
4122 <t>REMOVE MIDI_INSTRUMENT_MAP &lt;map&gt;</t>
4123 </list>
4124 </t>
4125 <t>Where &lt;map&gt; reflects the unique ID of the map to delete
4126 as returned by the <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
4127 command.</t>
4128 <t>The front-end can delete all MIDI instrument maps by
4129 sending the following command:</t>
4130 <t>
4131 <list>
4132 <t>REMOVE MIDI_INSTRUMENT_MAP ALL</t>
4133 </list>
4134 </t>
4135
4136 <t>Possible Answers:</t>
4137 <t>
4138 <list>
4139 <t>"OK" -
4140 <list>
4141 <t>in case the map(s) could be deleted</t>
4142 </list>
4143 </t>
4144 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4145 <list>
4146 <t>when the given map does not exist</t>
4147 </list>
4148 </t>
4149 </list>
4150 </t>
4151
4152 <t>Examples:</t>
4153 <t>
4154 <list>
4155 <t>C: "REMOVE MIDI_INSTRUMENT_MAP 0"</t>
4156 <t>S: "OK"</t>
4157 </list>
4158 </t>
4159 <t>
4160 <list>
4161 <t>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"</t>
4162 <t>S: "OK"</t>
4163 </list>
4164 </t>
4165 </section>
4166
4167 <section title="Get amount of existing MIDI instrument maps" anchor="GET MIDI_INSTRUMENT_MAPS">
4168 <t>The front-end can retrieve the current amount of MIDI
4169 instrument maps by sending the following command:</t>
4170 <t>
4171 <list>
4172 <t>GET MIDI_INSTRUMENT_MAPS</t>
4173 </list>
4174 </t>
4175
4176 <t>Possible Answers:</t>
4177 <t>
4178 <list>
4179 <t>The sampler will answer by returning the current
4180 number of MIDI instrument maps.</t>
4181 </list>
4182 </t>
4183
4184 <t>Example:</t>
4185 <t>
4186 <list>
4187 <t>C: "GET MIDI_INSTRUMENT_MAPS"</t>
4188 <t>S: "2"</t>
4189 </list>
4190 </t>
4191 </section>
4192
4193 <section title="Getting all created MIDI instrument maps" anchor="LIST MIDI_INSTRUMENT_MAPS">
4194 <t>The number of MIDI instrument maps can change on runtime. To get the
4195 current list of MIDI instrument maps, the front-end can send the
4196 following command:</t>
4197 <t>
4198 <list>
4199 <t>LIST MIDI_INSTRUMENT_MAPS</t>
4200 </list>
4201 </t>
4202 <t>Possible Answers:</t>
4203 <t>
4204 <list>
4205 <t>The sampler will answer by returning a comma separated list
4206 with all MIDI instrument maps' numerical IDs.</t>
4207 </list>
4208 </t>
4209 <t>Example:</t>
4210 <t>
4211 <list>
4212 <t>C: "LIST MIDI_INSTRUMENT_MAPS"</t>
4213 <t>S: "0,1,5,12"</t>
4214 </list>
4215 </t>
4216 </section>
4217
4218 <section title="Getting MIDI instrument map information" anchor="GET MIDI_INSTRUMENT_MAP INFO">
4219 <t>The front-end can ask for the current settings of a MIDI
4220 instrument map by sending the following command:</t>
4221 <t>
4222 <list>
4223 <t>GET MIDI_INSTRUMENT_MAP INFO &lt;map&gt;</t>
4224 </list>
4225 </t>
4226 <t>Where &lt;map&gt; is the numerical ID of the map the
4227 front-end is interested in as returned by the
4228 <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
4229 command.</t>
4230
4231 <t>Possible Answers:</t>
4232 <t>
4233 <list>
4234 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
4235 Each answer line begins with the settings category name
4236 followed by a colon and then a space character &lt;SP&gt; and finally
4237 the info character string to that setting category. At the
4238 moment the following categories are defined:</t>
4239
4240 <t>
4241 <list>
4242 <t>NAME -
4243 <list>
4244 <t>custom name of the given map,
4245 which does not have to be unique</t>
4246 </list>
4247 </t>
4248 <t>DEFAULT -
4249 <list>
4250 <t>either true or false,
4251 defines whether this map is the default map</t>
4252 </list>
4253 </t>
4254 </list>
4255 </t>
4256 </list>
4257 </t>
4258 <t>The mentioned fields above don't have to be in particular order.</t>
4259
4260 <t>Example:</t>
4261 <t>
4262 <list>
4263 <t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t>
4264 <t>S: "NAME: Standard Map"</t>
4265 <t>&nbsp;&nbsp;&nbsp;"DEFAULT: true"</t>
4266 <t>&nbsp;&nbsp;&nbsp;"."</t>
4267 </list>
4268 </t>
4269 </section>
4270
4271 <section title="Renaming a MIDI instrument map" anchor="SET MIDI_INSTRUMENT_MAP NAME">
4272 <t>The front-end can alter the custom name of a MIDI
4273 instrument map by sending the following command:</t>
4274 <t>
4275 <list>
4276 <t>SET MIDI_INSTRUMENT_MAP NAME &lt;map&gt; &lt;name&gt;</t>
4277 </list>
4278 </t>
4279 <t>Where &lt;map&gt; is the numerical ID of the map and
4280 &lt;name&gt; the new custom name of the map, which does not
4281 have to be unique.</t>
4282
4283 <t>Possible Answers:</t>
4284 <t>
4285 <list>
4286 <t>"OK" -
4287 <list>
4288 <t>on success</t>
4289 </list>
4290 </t>
4291 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4292 <list>
4293 <t>in case the given map does not exist</t>
4294 </list>
4295 </t>
4296 </list>
4297 </t>
4298
4299 <t>Example:</t>
4300 <t>
4301 <list>
4302 <t>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"</t>
4303 <t>S: "OK"</t>
4304 </list>
4305 </t>
4306 </section>
4307
4308 <section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT">
4309 <t>The front-end can create a new or replace an existing entry
4310 in a sampler's MIDI instrument map by sending the following
4311 command:</t>
4312 <t>
4313 <list>
4314 <t>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
4315 &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
4316 &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
4317 [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>
4318 </list>
4319 </t>
4320 <t>Where &lt;map&gt; is the numeric ID of the map to alter,
4321 &lt;midi_bank&gt; is an integer value between
4322 0..16383 reflecting the MIDI bank select index,
4323 &lt;midi_prog&gt; an
4324 integer value between 0..127 reflecting the MIDI program change
4325 index, &lt;engine_name&gt; a sampler engine name as returned by
4326 the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>
4327 command (not encapsulated into apostrophes), &lt;filename&gt; the name
4328 of the instrument's file to be deployed (encapsulated into apostrophes),
4329 &lt;instrument_index&gt; the index (integer value) of the instrument
4330 within the given file, &lt;volume_value&gt; reflects the master
4331 volume of the instrument as optionally dotted number (where a
4332 value &lt; 1.0 means attenuation and a value > 1.0 means
4333 amplification). This parameter easily allows to adjust the
4334 volume of all intruments within a custom instrument map
4335 without having to adjust their instrument files. The
4336 OPTIONAL &lt;instr_load_mode&gt; argument defines the life
4337 time of the instrument, that is when the instrument should
4338 be loaded, when freed and has exactly the following
4339 possibilities:</t>
4340 <t>
4341 <list>
4342 <t>"ON_DEMAND" -
4343 <list>
4344 <t>The instrument will be loaded when needed,
4345 that is when demanded by at least one sampler
4346 channel. It will immediately be freed from memory
4347 when not needed by any sampler channel anymore.</t>
4348 </list>
4349 </t>
4350 <t>"ON_DEMAND_HOLD" -
4351 <list>
4352 <t>The instrument will be loaded when needed,
4353 that is when demanded by at least one sampler
4354 channel. It will be kept in memory even when
4355 not needed by any sampler channel anymore.
4356 Instruments with this mode are only freed
4357 when the sampler is reset or all mapping
4358 entries with this mode (and respective
4359 instrument) are explicitly changed to
4360 "ON_DEMAND" and no sampler channel is using
4361 the instrument anymore.</t>
4362 </list>
4363 </t>
4364 <t>"PERSISTENT" -
4365 <list>
4366 <t>The instrument will immediately be loaded
4367 into memory when this mapping
4368 command is sent and the instrument is kept all
4369 the time. Instruments with this mode are
4370 only freed when the sampler is reset or all
4371 mapping entries with this mode (and
4372 respective instrument) are explicitly
4373 changed to "ON_DEMAND" and no sampler
4374 channel is using the instrument anymore.</t>
4375 </list>
4376 </t>
4377 <t>not supplied -
4378 <list>
4379 <t>In case there is no &lt;instr_load_mode&gt;
4380 argument given, it will be up to the
4381 InstrumentManager to decide which mode to use.
4382 Usually it will use "ON_DEMAND" if an entry
4383 for the given instrument does not exist in
4384 the InstrumentManager's list yet, otherwise
4385 if an entry already exists, it will simply
4386 stick with the mode currently reflected by
4387 the already existing entry, that is it will
4388 not change the mode.</t>
4389 </list>
4390 </t>
4391 </list>
4392 </t>
4393 <t>
4394 The &lt;instr_load_mode&gt; argument thus allows to define an
4395 appropriate strategy (low memory consumption vs. fast
4396 instrument switching) for each instrument individually. Note, the
4397 following restrictions apply to this argument: "ON_DEMAND_HOLD" and
4398 "PERSISTENT" have to be supported by the respective sampler engine
4399 (which is technically the case when the engine provides an
4400 InstrumentManager for its format). If this is not the case the
4401 argument will automatically fall back to the default value
4402 "ON_DEMAND". Also the load mode of one instrument may
4403 automatically change the laod mode of other instrument(s), i.e.
4404 because the instruments are part of the same file and the
4405 engine does not allow a way to manage load modes for them
4406 individually. Due to this, in case the frontend shows the
4407 load modes of entries, the frontend should retrieve the actual
4408 mode by i.e. sending
4409 <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
4410 command(s). Finally the OPTIONAL &lt;name&gt; argument allows to
4411 set a custom name (encapsulated into apostrophes) for the mapping
4412 entry, useful for frontends for displaying an appropriate name for
4413 mapped instruments (using
4414 <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
4415 </t>
4416 <t>
4417 By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4418 completely established in the sampler. The OPTIONAL "NON_MODAL" argument
4419 however causes the respective "MAP MIDI_INSTRUMENT" command to return
4420 immediately, that is to let the sampler establish the mapping in the
4421 background. So this argument might be especially useful for mappings with
4422 a "PERSISTENT" type, because these have to load the respective instruments
4423 immediately and might thus block for a very long time. It is recommended
4424 however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
4425 because it has the following drawbacks: as "NON_MODAL" instructions return
4426 immediately, they may not necessarily return an error i.e. when the given
4427 instrument file turns out to be corrupt, beside that subsequent commands
4428 in a LSCP instruction sequence might fail, because mandatory mappings are
4429 not yet completed.
4430 </t>
4431
4432 <t>Possible Answers:</t>
4433 <t>
4434 <list>
4435 <t>"OK" -
4436 <list>
4437 <t>usually</t>
4438 </list>
4439 </t>
4440 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4441 <list>
4442 <t>when the given map or engine does not exist or a value
4443 is out of range</t>
4444 </list>
4445 </t>
4446 </list>
4447 </t>
4448
4449 <t>Examples:</t>
4450 <t>
4451 <list>
4452 <t>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"</t>
4453 <t>S: "OK"</t>
4454 </list>
4455 </t>
4456 <t>
4457 <list>
4458 <t>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"</t>
4459 <t>S: "OK"</t>
4460 </list>
4461 </t>
4462 <t>
4463 <list>
4464 <t>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"</t>
4465 <t>S: "OK"</t>
4466 <t>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"</t>
4467 <t>S: "OK"</t>
4468 </list>
4469 </t>
4470 <t>
4471 <list>
4472 <t>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>
4473 <t>S: "OK"</t>
4474 </list>
4475 </t>
4476 </section>
4477
4478 <section title="Getting ammount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS">
4479 <t>The front-end can query the amount of currently existing
4480 entries in a MIDI instrument map by sending the following
4481 command:</t>
4482 <t>
4483 <list>
4484 <t>GET MIDI_INSTRUMENTS &lt;map&gt;</t>
4485 </list>
4486 </t>
4487 <t>The front-end can query the amount of currently existing
4488 entries in all MIDI instrument maps by sending the following
4489 command:</t>
4490 <t>
4491 <list>
4492 <t>GET MIDI_INSTRUMENTS ALL</t>
4493 </list>
4494 </t>
4495 <t>Possible Answers:</t>
4496 <t>
4497 <list>
4498 <t>The sampler will answer by sending the current number of
4499 entries in the MIDI instrument map(s).</t>
4500 </list>
4501 </t>
4502
4503 <t>Example:</t>
4504 <t>
4505 <list>
4506 <t>C: "GET MIDI_INSTRUMENTS 0"</t>
4507 <t>S: "234"</t>
4508 </list>
4509 </t>
4510 <t>
4511 <list>
4512 <t>C: "GET MIDI_INSTRUMENTS ALL"</t>
4513 <t>S: "954"</t>
4514 </list>
4515 </t>
4516 </section>
4517
4518 <section title="Getting indeces of all entries of a MIDI instrument map" anchor="LIST MIDI_INSTRUMENTS">
4519 <t>The front-end can query a list of all currently existing
4520 entries in a certain MIDI instrument map by sending the following
4521 command:</t>
4522 <t>
4523 <list>
4524 <t>LIST MIDI_INSTRUMENTS &lt;map&gt;</t>
4525 </list>
4526 </t>
4527 <t>Where &lt;map&gt; is the numeric ID of the MIDI instrument map.</t>
4528 <t>The front-end can query a list of all currently existing
4529 entries of all MIDI instrument maps by sending the following
4530 command:</t>
4531 <t>
4532 <list>
4533 <t>LIST MIDI_INSTRUMENTS ALL</t>
4534 </list>
4535 </t>
4536
4537 <t>Possible Answers:</t>
4538 <t>
4539 <list>
4540 <t>The sampler will answer by sending a comma separated
4541 list of map ID - MIDI bank - MIDI program triples, where
4542 each triple is encapsulated into curly braces. The
4543 list is returned in one single line. Each triple
4544 just reflects the key of the respective map entry,
4545 thus subsequent
4546 <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
4547 command(s) are necessary to retrieve detailed informations
4548 about each entry.</t>
4549 </list>
4550 </t>
4551
4552 <t>Example:</t>
4553 <t>
4554 <list>
4555 <t>C: "LIST MIDI_INSTRUMENTS 0"</t>
4556 <t>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"</t>
4557 </list>
4558 </t>
4559 </section>
4560
4561 <section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT">
4562 <t>The front-end can delete an entry from a MIDI instrument
4563 map by sending the following command:</t>
4564 <t>
4565 <list>
4566 <t>UNMAP MIDI_INSTRUMENT &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;</t>
4567 </list>
4568 </t>
4569 <t>
4570 Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
4571 &lt;midi_bank&gt; is an integer value between 0..16383
4572 reflecting the MIDI bank value and
4573 &lt;midi_prog&gt; an integer value between
4574 0..127 reflecting the MIDI program value of the map's entrie's key
4575 index triple.
4576 </t>
4577
4578 <t>Possible Answers:</t>
4579 <t>
4580 <list>
4581 <t>"OK" -
4582 <list>
4583 <t>usually</t>
4584 </list>
4585 </t>
4586 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4587 <list>
4588 <t>when index out of bounds</t>
4589 </list>
4590 </t>
4591 </list>
4592 </t>
4593
4594 <t>Example:</t>
4595 <t>
4596 <list>
4597 <t>C: "UNMAP MIDI_INSTRUMENT 0 2 127"</t>
4598 <t>S: "OK"</t>
4599 </list>
4600 </t>
4601 </section>
4602
4603 <section title="Get current settings of MIDI instrument map entry" anchor="GET MIDI_INSTRUMENT INFO">
4604 <t>The front-end can retrieve the current settings of a certain
4605 instrument map entry by sending the following command:</t>
4606 <t>
4607 <list>
4608 <t>GET MIDI_INSTRUMENT INFO &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;</t>
4609 </list>
4610 </t>
4611 <t>
4612 Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
4613 &lt;midi_bank&gt; is an integer value between 0..16383
4614 reflecting the MIDI bank value, &lt;midi_bank&gt;
4615 and &lt;midi_prog&gt; an integer value between
4616 0..127 reflecting the MIDI program value of the map's entrie's key
4617 index triple.
4618 </t>
4619
4620 <t>Possible Answers:</t>
4621 <t>
4622 <list>
4623 <t>LinuxSampler will answer by sending a &lt;CRLF&gt;
4624 separated list. Each answer line begins with the
4625 information category name followed by a colon and then
4626 a space character &lt;SP&gt; and finally the info
4627 character string to that info category. At the moment
4628 the following categories are defined:</t>
4629 <t>"NAME" -
4630 <list>
4631 <t>Name for this MIDI instrument map entry (if defined).
4632 This name shall be used by frontends for displaying a
4633 name for this mapped instrument. It can be set and
4634 changed with the
4635 <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref>
4636 command and does not have to be unique.</t>
4637 </list>
4638 </t>
4639 <t>"ENGINE_NAME" -
4640 <list>
4641 <t>Name of the engine to be deployed for this
4642 instrument.</t>
4643 </list>
4644 </t>
4645 <t>"INSTRUMENT_FILE" -
4646 <list>
4647 <t>File name of the instrument.</t>
4648 </list>
4649 </t>
4650 <t>"INSTRUMENT_NR" -
4651 <list>
4652 <t>Index of the instrument within the file.</t>
4653 </list>
4654 </t>
4655 <t>"INSTRUMENT_NAME" -
4656 <list>
4657 <t>Name of the loaded instrument as reflected by its file.
4658 In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4659 cannot be changed.</t>
4660 </list>
4661 </t>
4662 <t>"LOAD_MODE" -
4663 <list>
4664 <t>Life time of instrument
4665 (see <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> for details about this setting).</t>
4666 </list>
4667 </t>
4668 <t>"VOLUME" -
4669 <list>
4670 <t>master volume of the instrument as optionally
4671 dotted number (where a value &lt; 1.0 means attenuation
4672 and a value > 1.0 means amplification)</t>
4673 </list>
4674 </t>
4675 <t>The mentioned fields above don't have to be in particular order.</t>
4676 </list>
4677 </t>
4678
4679 <t>Example:</t>
4680 <t>
4681 <list>
4682 <t>C: "GET MIDI_INSTRUMENT INFO 1 45 120"</t>
4683 <t>S: "NAME: Drums for Foo Song"</t>
4684 <t>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"</t>
4685 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t>
4686 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
4687 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Joe's Drumkit"</t>
4688 <t>&nbsp;&nbsp;&nbsp;"LOAD_MODE: PERSISTENT"</t>
4689 <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
4690 <t>&nbsp;&nbsp;&nbsp;"."</t>
4691 </list>
4692 </t>
4693 </section>
4694
4695 <section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS">
4696 <t>The front-end can clear a whole MIDI instrument map, that
4697 is delete all its entries by sending the following command:</t>
4698 <t>
4699 <list>
4700 <t>CLEAR MIDI_INSTRUMENTS &lt;map&gt;</t>
4701 </list>
4702 </t>
4703 <t>Where &lt;map&gt; is the numeric ID of the map to clear.</t>
4704 <t>The front-end can clear all MIDI instrument maps, that
4705 is delete all entries of all maps by sending the following
4706 command:</t>
4707 <t>
4708 <list>
4709 <t>CLEAR MIDI_INSTRUMENTS ALL</t>
4710 </list>
4711 </t>
4712 <t>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the
4713 maps, only their entries, thus the map's settings like
4714 custom name will be preservevd.</t>
4715
4716 <t>Possible Answers:</t>
4717 <t>
4718 <list>
4719 <t>"OK" -
4720 <list>
4721 <t>always</t>
4722 </list>
4723 </t>
4724 </list>
4725 </t>
4726
4727 <t>Examples:</t>
4728 <t>
4729 <list>
4730 <t>C: "CLEAR MIDI_INSTRUMENTS 0"</t>
4731 <t>S: "OK"</t>
4732 </list>
4733 </t>
4734 <t>
4735 <list>
4736 <t>C: "CLEAR MIDI_INSTRUMENTS ALL"</t>
4737 <t>S: "OK"</t>
4738 </list>
4739 </t>
4740 </section>
4741 </section>
4742
4743
4744 <section title="Managing Instruments Database" anchor="Managing Instruments Database">
4745 <t>The following commands describe how to use and manage
4746 the instruments database.</t>
4747
4748 <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">
4749 <t>The front-end can add a new instrument directory to the
4750 instruments database by sending the following command:</t>
4751 <t>
4752 <list>
4753 <t>ADD DB_INSTRUMENT_DIRECTORY &lt;dir&gt;</t>
4754 </list>
4755 </t>
4756 <t>Where &lt;dir&gt; is the absolute path name of the directory
4757 to be created (encapsulated into apostrophes).</t>
4758
4759 <t>Possible Answers:</t>
4760 <t>
4761 <list>
4762 <t>"OK" -
4763 <list>
4764 <t>on success</t>
4765 </list>
4766 </t>
4767 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4768 <list>
4769 <t>when the directory could not be created, which
4770 can happen if the directory already exists or the
4771 name contains not allowed symbols</t>
4772 </list>
4773 </t>
4774 </list>
4775 </t>
4776
4777 <t>Examples:</t>
4778 <t>
4779 <list>
4780 <t>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"</t>
4781 <t>S: "OK"</t>
4782 </list>
4783 </t>
4784 </section>
4785
4786 <section title="Deleting an instrument directory" anchor="REMOVE DB_INSTRUMENT_DIRECTORY">
4787 <t>The front-end can delete a particular instrument directory
4788 from the instruments database by sending the following command:</t>
4789 <t>
4790 <list>
4791 <t>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] &lt;dir&gt;</t>
4792 </list>
4793 </t>
4794 <t>Where &lt;dir&gt; is the absolute path name of the directory
4795 to delete. The optional FORCE argument can be used to
4796 force the deletion of a non-empty directory and all its content.</t>
4797
4798 <t>Possible Answers:</t>
4799 <t>
4800 <list>
4801 <t>"OK" -
4802 <list>
4803 <t>if the directory is deleted successfully</t>
4804 </list>
4805 </t>
4806 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4807 <list>
4808 <t>if the given directory does not exist, or
4809 if trying to delete a non-empty directory,
4810 without using the FORCE argument.</t>
4811 </list>
4812 </t>
4813 </list>
4814 </t>
4815
4816 <t>Examples:</t>
4817 <t>
4818 <list>
4819 <t>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"</t>
4820 <t>S: "OK"</t>
4821 </list>
4822 </t>
4823 </section>
4824
4825 <section title="Getting amount of instrument directories" anchor="GET DB_INSTRUMENT_DIRECTORIES">
4826 <t>The front-end can retrieve the current amount of
4827 directories in a specific directory by sending the following command:</t>
4828 <t>
4829 <list>
4830 <t>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4831 </list>
4832 </t>
4833 <t>Where &lt;dir&gt; should be replaced by the absolute path
4834 name of the directory. If RECURSIVE is specified, the number of
4835 all directories, including those located in subdirectories of the
4836 specified directory, will be returned.</t>
4837
4838 <t>Possible Answers:</t>
4839 <t>
4840 <list>
4841 <t>The current number of instrument directories
4842 in the specified directory.</t>
4843 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4844 <list>
4845 <t>if the given directory does not exist.</t>
4846 </list>
4847 </t>
4848 </list>
4849 </t>
4850
4851 <t>Example:</t>
4852 <t>
4853 <list>
4854 <t>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"</t>
4855 <t>S: "2"</t>
4856 </list>
4857 </t>
4858 </section>
4859
4860 <section title="Listing all directories in specific directory" anchor="LIST DB_INSTRUMENT_DIRECTORIES">
4861 <t>The front-end can retrieve the current list of directories
4862 in specific directory by sending the following command:</t>
4863 <t>
4864 <list>
4865 <t>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4866 </list>
4867 </t>
4868 <t>Where &lt;dir&gt; should be replaced by the absolute path
4869 name of the directory. If RECURSIVE is specified, the absolute path names
4870 of all directories, including those located in subdirectories of the
4871 specified directory, will be returned.</t>
4872
4873 <t>Possible Answers:</t>
4874 <t>
4875 <list>
4876 <t>A comma separated list of all instrument directories
4877 (encapsulated into apostrophes) in the specified directory.</t>
4878 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4879 <list>
4880 <t>if the given directory does not exist.</t>
4881 </list>
4882 </t>
4883 </list>
4884 </t>
4885 <t>Example:</t>
4886 <t>
4887 <list>
4888 <t>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"</t>
4889 <t>S: "'Piano Collection','Percussion Collection'"</t>
4890 </list>
4891 </t>
4892 <t>
4893 <list>
4894 <t>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"</t>
4895 <t>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"</t>
4896 </list>
4897 </t>
4898 </section>
4899
4900 <section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO">
4901 <t>The front-end can ask for the current settings of an
4902 instrument directory by sending the following command:</t>
4903 <t>
4904 <list>
4905 <t>GET DB_INSTRUMENT_DIRECTORY INFO &lt;dir&gt;</t>
4906 </list>
4907 </t>
4908 <t>Where &lt;dir&gt; should be replaced by the absolute path
4909 name of the directory the front-end is interested in.</t>
4910
4911 <t>Possible Answers:</t>
4912 <t>
4913 <list>
4914 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
4915 Each answer line begins with the settings category name
4916 followed by a colon and then a space character &lt;SP&gt; and finally
4917 the info character string to that setting category. At the
4918 moment the following categories are defined:</t>
4919
4920 <t>
4921 <list>
4922 <t>DESCRIPTION -
4923 <list>
4924 <t>A brief description of the directory content</t>
4925 </list>
4926 </t>
4927 <t>CREATED -
4928 <list>
4929 <t>The creation date and time of the directory,
4930 represented in "YYYY-MM-DD HH:MM:SS" format</t>
4931 </list>
4932 </t>
4933 <t>MODIFIED -
4934 <list>
4935 <t>The date and time of the last modification of the
4936 directory, represented in "YYYY-MM-DD HH:MM:SS" format</t>
4937 </list>
4938 </t>
4939 </list>
4940 </t>
4941 </list>
4942 </t>
4943 <t>The mentioned fields above don't have to be in particular order.</t>
4944
4945 <t>Example:</t>
4946 <t>
4947 <list>
4948 <t>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"</t>
4949 <t>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."</t>
4950 <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
4951 <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
4952 <t>&nbsp;&nbsp;&nbsp;"."</t>
4953 </list>
4954 </t>
4955 </section>
4956
4957 <section title="Renaming an instrument directory" anchor="SET DB_INSTRUMENT_DIRECTORY NAME">
4958 <t>The front-end can alter the name of a specific
4959 instrument directory by sending the following command:</t>
4960 <t>
4961 <list>
4962 <t>SET DB_INSTRUMENT_DIRECTORY NAME &lt;dir&gt; &lt;name&gt;</t>
4963 </list>
4964 </t>
4965 <t>Where &lt;dir&gt; is the absolute path name of the directory and
4966 &lt;name&gt; is the new name for that directory.</t>
4967
4968 <t>Possible Answers:</t>
4969 <t>
4970 <list>
4971 <t>"OK" -
4972 <list>
4973 <t>on success</t>
4974 </list>
4975 </t>
4976 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4977 <list>
4978 <t>in case the given directory does not exists,
4979 or if a directory with name equal to the new
4980 name already exists.</t>
4981 </list>
4982 </t>
4983 </list>
4984 </t>
4985
4986 <t>Example:</t>
4987 <t>
4988 <list>
4989 <t>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"</t>
4990 <t>S: "OK"</t>
4991 </list>
4992 </t>
4993 </section>
4994
4995 <section title="Moving an instrument directory" anchor="MOVE DB_INSTRUMENT_DIRECTORY">
4996 <t>The front-end can move a specific
4997 instrument directory by sending the following command:</t>
4998 <t>
4999 <list>
5000 <t>MOVE DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5001 </list>
5002 </t>
5003 <t>Where &lt;dir&gt; is the absolute path name of the directory
5004 to move and &lt;dst&gt; is the location where the directory will
5005 be moved to.</t>
5006
5007 <t>Possible Answers:</t>
5008 <t>
5009 <list>
5010 <t>"OK" -
5011 <list>
5012 <t>on success</t>
5013 </list>
5014 </t>
5015 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5016 <list>
5017 <t>in case a given directory does not exists,
5018 or if a directory with name equal to the name
5019 of the specified directory already exists in
5020 the destination directory. Error is also thrown
5021 when trying to move a directory to a subdirectory
5022 of itself.</t>
5023 </list>
5024 </t>
5025 </list>
5026 </t>
5027
5028 <t>Example:</t>
5029 <t>
5030 <list>
5031 <t>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"</t>
5032 <t>S: "OK"</t>
5033 </list>
5034 </t>
5035 </section>
5036
5037 <section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY">
5038 <t>The front-end can copy a specific
5039 instrument directory by sending the following command:</t>
5040 <t>
5041 <list>
5042 <t>COPY DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5043 </list>
5044 </t>
5045 <t>Where &lt;dir&gt; is the absolute path name of the directory
5046 to copy and &lt;dst&gt; is the location where the directory will
5047 be copied to.</t>
5048
5049 <t>Possible Answers:</t>
5050 <t>
5051 <list>
5052 <t>"OK" -
5053 <list>
5054 <t>on success</t>
5055 </list>
5056 </t>
5057 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5058 <list>
5059 <t>in case a given directory does not exists,
5060 or if a directory with name equal to the name
5061 of the specified directory already exists in
5062 the destination directory. Error is also thrown
5063 when trying to copy a directory to a subdirectory
5064 of itself.</t>
5065 </list>
5066 </t>
5067 </list>
5068 </t>
5069
5070 <t>Example:</t>
5071 <t>
5072 <list>
5073 <t>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"</t>
5074 <t>S: "OK"</t>
5075 </list>
5076 </t>
5077 </section>
5078
5079 <section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">
5080 <t>The front-end can alter the description of a specific
5081 instrument directory by sending the following command:</t>
5082 <t>
5083 <list>
5084 <t>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION &lt;dir&gt; &lt;desc&gt;</t>
5085 </list>
5086 </t>
5087 <t>Where &lt;dir&gt; is the absolute path name of the directory and
5088 &lt;desc&gt; is the new description for the directory.</t>
5089
5090 <t>Possible Answers:</t>
5091 <t>
5092 <list>
5093 <t>"OK" -
5094 <list>
5095 <t>on success</t>
5096 </list>
5097 </t>
5098 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5099 <list>
5100 <t>in case the given directory does not exists.</t>
5101 </list>
5102 </t>
5103 </list>
5104 </t>
5105
5106 <t>Example:</t>
5107 <t>
5108 <list>
5109 <t>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"</t>
5110 <t>S: "OK"</t>
5111 </list>
5112 </t>
5113 </section>
5114
5115 <section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES">
5116 <t>The front-end can search for directories
5117 in specific directory by sending the following command:</t>
5118 <t>
5119 <list>
5120 <t>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5121 </list>
5122 </t>
5123 <t>Where &lt;dir&gt; should be replaced by the absolute path
5124 name of the directory to search in. If NON_RECURSIVE is specified, the
5125 directories located in subdirectories of the specified directory will not
5126 be searched. &lt;criteria-list&gt; is a list of search criterias
5127 in form of "key1=val1 key2=val2 ...". The following criterias are
5128 allowed:</t>
5129 <t>
5130 <t>NAME='&lt;search-string&gt;'
5131 <list>
5132 <t>Restricts the search to directories, which names
5133 satisfy the supplied search string.</t>
5134 </list>
5135 </t>
5136
5137 <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5138 <list>
5139 <t>Restricts the search to directories, which creation
5140 date satisfies the specified period, where &lt;date-after&gt;
5141 and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5142 If &lt;date-after&gt; is omitted the search is restricted to
5143 directories created before &lt;date-before&gt;. If
5144 &lt;date-before&gt; is omitted, the search is restricted
5145 to directories created after &lt;date-after&gt;.</t>
5146 </list>
5147 </t>
5148
5149 <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5150 <list>
5151 <t>Restricts the search to directories, which
5152 date of last modification satisfies the specified period, where
5153 &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5154 format. If &lt;date-after&gt; is omitted the search is restricted to
5155 directories, which are last modified before &lt;date-before&gt;. If
5156 &lt;date-before&gt; is omitted, the search is restricted to directories,
5157 which are last modified after &lt;date-after&gt;.</t>
5158 </list>
5159 </t>
5160
5161 <t>DESCRIPTION='&lt;search-string&gt;'
5162 <list>
5163 <t>Restricts the search to directories with description
5164 that satisfies the supplied search string.</t>
5165 </list>
5166 </t>
5167 </t>
5168
5169 <t>Where &lt;search-string&gt; is either a regular expression, or a
5170 word list separated with spaces for OR search and with '+' for AND search.</t>
5171
5172 <t>Possible Answers:</t>
5173 <t>
5174 <list>
5175 <t>A comma separated list with the absolute path names (encapsulated into
5176 apostrophes) of all directories in the specified directory that satisfy
5177 the supplied search criterias.</t>
5178 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5179 <list>
5180 <t>if the given directory does not exist.</t>
5181 </list>
5182 </t>
5183 </list>
5184 </t>
5185 <t>Example:</t>
5186 <t>
5187 <list>
5188 <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"</t>
5189 <t>S: "'/Piano Collection'"</t>
5190 </list>
5191 </t>
5192 <t>
5193 <list>
5194 <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"</t>
5195 <t>S: "'/Piano Collection','/Percussions'"</t>
5196 </list>
5197 </t>
5198 </section>
5199
5200 <section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS">
5201 <t>The front-end can add one or more instruments
5202 to the instruments database by sending the following command:</t>
5203 <t>
5204 <list>
5205 <t>ADD DB_INSTRUMENTS [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]</t>
5206 </list>
5207 </t>
5208 <t>Where &lt;db_dir&gt; is the absolute path name of a directory
5209 (encapsulated into apostrophes) in the instruments database in which
5210 only the new instruments (that are not already in the database) will
5211 be added, &lt;file_path&gt; is the absolute path name of a file or
5212 directory in the file system (encapsulated into apostrophes). In case
5213 an instrument file is supplied, only the instruments in the specified
5214 file will be added to the instruments database. If the optional
5215 &lt;instr_index&gt; (the index of the instrument within the given file)
5216 is supplied too, then only the specified instrument will be added.
5217 In case a directory is supplied, the instruments in that directory
5218 will be added. The OPTIONAL &lt;mode&gt; argument is only applied
5219 when a directory is provided as &lt;file_path&gt; and specifies how the
5220 scanning will be done and has exactly the following possibilities:</t>
5221 <t>
5222 <list>
5223 <t>"NON_RECURSIVE" -
5224 <list>
5225 <t>Only the instruments in the specified directory
5226 will be added, the instruments in the subdirectories
5227 will not be processed.</t>
5228 </list>
5229 </t>
5230 <t>"FLAT" -
5231 <list>
5232 <t>All instruments will be processed, including those
5233 in the subdirectories, but the respective subdirectory
5234 structure will not be recreated in the instruments
5235 database. All instruments will be added directly in
5236 the specified database directory.</t>
5237 </list>
5238 </t>
5239 <t>not supplied -
5240 <list>
5241 <t>The subdirectory tree structure will be recreated
5242 in the instruments database and all instruments will be
5243 processed and added to the respective subdirectory
5244 in the instruments database.</t>
5245 </list>
5246 </t>
5247 </list>
5248 </t>
5249
5250 <t>Possible Answers:</t>
5251 <t>
5252 <list>
5253 <t>"OK" -
5254 <list>
5255 <t>on success</t>
5256 </list>
5257 </t>
5258 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5259 <list>
5260 <t>if an invalid path is specified.</t>
5261 </list>
5262 </t>
5263 </list>
5264 </t>
5265
5266 <t>Examples:</t>
5267 <t>
5268 <list>
5269 <t>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"</t>
5270 <t>S: "OK"</t>
5271 </list>
5272 </t>
5273 </section>
5274
5275 <section title="Removing an instrument" anchor="REMOVE DB_INSTRUMENT">
5276 <t>The front-end can remove a particular instrument
5277 from the instruments database by sending the following command:</t>
5278 <t>
5279 <list>
5280 <t>REMOVE DB_INSTRUMENT &lt;instr_path&gt;</t>
5281 </list>
5282 </t>
5283 <t>Where &lt;instr_path&gt; is the absolute path name
5284 (in the instruments database) of the instrument to remove.</t>
5285
5286 <t>Possible Answers:</t>
5287 <t>
5288 <list>
5289 <t>"OK" -
5290 <list>
5291 <t>if the instrument is removed successfully</t>
5292 </list>
5293 </t>
5294 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5295 <list>
5296 <t>if the given path does not exist or
5297 is a directory.</t>
5298 </list>
5299 </t>
5300 </list>
5301 </t>
5302
5303 <t>Examples:</t>
5304 <t>
5305 <list>
5306 <t>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"</t>
5307 <t>S: "OK"</t>
5308 </list>
5309 </t>
5310 </section>
5311
5312 <section title="Getting amount of instruments" anchor="GET DB_INSTRUMENTS">
5313 <t>The front-end can retrieve the current amount of
5314 instruments in a specific directory by sending the following command:</t>
5315 <t>
5316 <list>
5317 <t>GET DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5318 </list>
5319 </t>
5320 <t>Where &lt;dir&gt; should be replaced by the absolute path name
5321 of the directory. If RECURSIVE is specified, the number of all
5322 instruments, including those located in subdirectories of the
5323 specified directory, will be returned.</t>
5324
5325 <t>Possible Answers:</t>
5326 <t>
5327 <list>
5328 <t>The current number of instruments
5329 in the specified directory.</t>
5330 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5331 <list>
5332 <t>if the given directory does not exist.</t>
5333 </list>
5334 </t>
5335 </list>
5336 </t>
5337
5338 <t>Example:</t>
5339 <t>
5340 <list>
5341 <t>C: "GET DB_INSTRUMENTS '/Piano Collection'"</t>
5342 <t>S: "2"</t>
5343 </list>
5344 </t>
5345 </section>
5346
5347 <section title="Listing all instruments in specific directory" anchor="LIST DB_INSTRUMENTS">
5348 <t>The front-end can retrieve the current list of instruments
5349 in specific directory by sending the following command:</t>
5350 <t>
5351 <list>
5352 <t>LIST DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5353 </list>
5354 </t>
5355 <t>Where &lt;dir&gt; should be replaced by the absolute path
5356 name of the directory. If RECURSIVE is specified, the absolute path
5357 names of all instruments, including those located in subdirectories
5358 of the specified directory, will be returned.</t>
5359
5360 <t>Possible Answers:</t>
5361 <t>
5362 <list>
5363 <t>A comma separated list of all instruments
5364 (encapsulated into apostrophes) in the specified directory.</t>
5365 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5366 <list>
5367 <t>if the given directory does not exist.</t>
5368 </list>
5369 </t>
5370 </list>
5371 </t>
5372 <t>Example:</t>
5373 <t>
5374 <list>
5375 <t>C: "LIST DB_INSTRUMENTS '/Piano Collection'"</t>
5376 <t>S: "'Bosendorfer 290','Steinway D'"</t>
5377 </list>
5378 </t>
5379 <t>
5380 <list>
5381 <t>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"</t>
5382 <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"</t>
5383 </list>
5384 </t>
5385 </section>
5386
5387 <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO">
5388 <t>The front-end can ask for the current settings of an
5389 instrument by sending the following command:</t>
5390 <t>
5391 <list>
5392 <t>GET DB_INSTRUMENT INFO &lt;instr_path&gt;</t>
5393 </list>
5394 </t>
5395 <t>Where &lt;instr_path&gt; should be replaced by the absolute path
5396 name of the instrument the front-end is interested in.</t>
5397
5398 <t>Possible Answers:</t>
5399 <t>
5400 <list>
5401 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5402 Each answer line begins with the settings category name
5403 followed by a colon and then a space character &lt;SP&gt; and finally
5404 the info character string to that setting category. At the
5405 moment the following categories are defined:</t>
5406
5407 <t>
5408 <list>
5409 <t>INSTRUMENT_FILE -
5410 <list>
5411 <t>File name of the instrument.</t>
5412 </list>
5413 </t>
5414 <t>INSTRUMENT_NR -
5415 <list>
5416 <t>Index of the instrument within the file.</t>
5417 </list>
5418 </t>
5419 <t>FORMAT_FAMILY -
5420 <list>
5421 <t>The format family of the instrument.</t>
5422 </list>
5423 </t>
5424 <t>FORMAT_VERSION -
5425 <list>
5426 <t>The format version of the instrument.</t>
5427 </list>
5428 </t>
5429 <t>SIZE -
5430 <list>
5431 <t>The size of the instrument in bytes.</t>
5432 </list>
5433 </t>
5434 <t>CREATED -
5435 <list>
5436 <t>The date and time when the instrument is added
5437 in the instruments database, represented in
5438 "YYYY-MM-DD HH:MM:SS" format</t>
5439 </list>
5440 </t>
5441 <t>MODIFIED -
5442 <list>
5443 <t>The date and time of the last modification of the
5444 instrument's database settings, represented in
5445 "YYYY-MM-DD HH:MM:SS" format</t>
5446 </list>
5447 </t>
5448 <t>DESCRIPTION -
5449 <list>
5450 <t>A brief description of the instrument</t>
5451 </list>
5452 </t>
5453 <t>IS_DRUM -
5454 <list>
5455 <t>either true or false, determines whether the
5456 instrument is a drumkit or a chromatic instrument</t>
5457 </list>
5458 </t>
5459 <t>PRODUCT -
5460 <list>
5461 <t>The product title of the instrument</t>
5462 </list>
5463 </t>
5464 <t>ARTISTS -
5465 <list>
5466 <t>Lists the artist names</t>
5467 </list>
5468 </t>
5469 <t>KEYWORDS -
5470 <list>
5471 <t>Provides a list of keywords that refer to the instrument.
5472 Keywords are separated with semicolon and blank.</t>
5473 </list>
5474 </t>
5475 </list>
5476 </t>
5477 </list>
5478 </t>
5479 <t>The mentioned fields above don't have to be in particular order.</t>
5480
5481 <t>Example:</t>
5482 <t>
5483 <list>
5484 <t>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"</t>
5485 <t>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"</t>
5486 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
5487 <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
5488 <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 2"</t>
5489 <t>&nbsp;&nbsp;&nbsp;"SIZE: 2050871870"</t>
5490 <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
5491 <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
5492 <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: "</t>
5493 <t>&nbsp;&nbsp;&nbsp;"IS_DRUM: false"</t>
5494 <t>&nbsp;&nbsp;&nbsp;"PRODUCT: GRANDIOSO Bosendorfer 290"</t>
5495 <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Post Musical Instruments"</t>
5496 <t>&nbsp;&nbsp;&nbsp;"KEYWORDS: Bosendorfer"</t>
5497 <t>&nbsp;&nbsp;&nbsp;"."</t>
5498 </list>
5499 </t>
5500 </section>
5501
5502 <section title="Renaming an instrument" anchor="SET DB_INSTRUMENT NAME">
5503 <t>The front-end can alter the name of a specific
5504 instrument by sending the following command:</t>
5505 <t>
5506 <list>
5507 <t>SET DB_INSTRUMENT NAME &lt;instr&gt; &lt;name&gt;</t>
5508 </list>
5509 </t>
5510 <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5511 &lt;name&gt; is the new name for that instrument.</t>
5512
5513 <t>Possible Answers:</t>
5514 <t>
5515 <list>
5516 <t>"OK" -
5517 <list>
5518 <t>on success</t>
5519 </list>
5520 </t>
5521 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5522 <list>
5523 <t>in case the given instrument does not exists,
5524 or if an instrument with name equal to the new
5525 name already exists.</t>
5526 </list>
5527 </t>
5528 </list>
5529 </t>
5530
5531 <t>Example:</t>
5532 <t>
5533 <list>
5534 <t>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"</t>
5535 <t>S: "OK"</t>
5536 </list>
5537 </t>
5538 </section>
5539
5540 <section title="Moving an instrument" anchor="MOVE DB_INSTRUMENT">
5541 <t>The front-end can move a specific instrument to another directory by
5542 sending the following command:</t>
5543 <t>
5544 <list>
5545 <t>MOVE DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5546 </list>
5547 </t>
5548 <t>Where &lt;instr&gt; is the absolute path name of the instrument
5549 to move and &lt;dst&gt; is the directory where the instrument will
5550 be moved to.</t>
5551
5552 <t>Possible Answers:</t>
5553 <t>
5554 <list>
5555 <t>"OK" -
5556 <list>
5557 <t>on success</t>
5558 </list>
5559 </t>
5560 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5561 <list>
5562 <t>in case the given instrument does not exists,
5563 or if an instrument with name equal to the name of the
5564 specified instrument already exists in the destination
5565 directory.</t>
5566 </list>
5567 </t>
5568 </list>
5569 </t>
5570
5571 <t>Example:</t>
5572 <t>
5573 <list>
5574 <t>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"</t>
5575 <t>S: "OK"</t>
5576 </list>
5577 </t>
5578 </section>
5579
5580 <section title="Copying instruments" anchor="COPY DB_INSTRUMENT">
5581 <t>The front-end can copy a specific instrument to another directory by
5582 sending the following command:</t>
5583 <t>
5584 <list>
5585 <t>COPY DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5586 </list>
5587 </t>
5588 <t>Where &lt;instr&gt; is the absolute path name of the instrument
5589 to copy and &lt;dst&gt; is the directory where the instrument will
5590 be copied to.</t>
5591
5592 <t>Possible Answers:</t>
5593 <t>
5594 <list>
5595 <t>"OK" -
5596 <list>
5597 <t>on success</t>
5598 </list>
5599 </t>
5600 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5601 <list>
5602 <t>in case the given instrument does not exists,
5603 or if an instrument with name equal to the name of the
5604 specified instrument already exists in the destination
5605 directory.</t>
5606 </list>
5607 </t>
5608 </list>
5609 </t>
5610
5611 <t>Example:</t>
5612 <t>
5613 <list>
5614 <t>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"</t>
5615 <t>S: "OK"</t>
5616 </list>
5617 </t>
5618 </section>
5619
5620 <section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION">
5621 <t>The front-end can alter the description of a specific
5622 instrument by sending the following command:</t>
5623 <t>
5624 <list>
5625 <t>SET DB_INSTRUMENT DESCRIPTION &lt;instr&gt; &lt;desc&gt;</t>
5626 </list>
5627 </t>
5628 <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5629 &lt;desc&gt; is the new description for the instrument.</t>
5630
5631 <t>Possible Answers:</t>
5632 <t>
5633 <list>
5634 <t>"OK" -
5635 <list>
5636 <t>on success</t>
5637 </list>
5638 </t>
5639 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5640 <list>
5641 <t>in case the given instrument does not exists.</t>
5642 </list>
5643 </t>
5644 </list>
5645 </t>
5646
5647 <t>Example:</t>
5648 <t>
5649 <list>
5650 <t>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"</t>
5651 <t>S: "OK"</t>
5652 </list>
5653 </t>
5654 </section>
5655
5656 <section title="Finding instruments" anchor="FIND DB_INSTRUMENTS">
5657 <t>The front-end can search for instruments
5658 in specific directory by sending the following command:</t>
5659 <t>
5660 <list>
5661 <t>FIND DB_INSTRUMENTS [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5662 </list>
5663 </t>
5664 <t>Where &lt;dir&gt; should be replaced by the absolute path
5665 name of the directory to search in. If NON_RECURSIVE is specified, the
5666 directories located in subdirectories of the specified directory will not
5667 be searched. &lt;criteria-list&gt; is a list of search criterias
5668 in form of "key1=val1 key2=val2 ...". The following criterias are
5669 allowed:</t>
5670 <t>
5671 <t>NAME='&lt;search-string&gt;'
5672 <list>
5673 <t>Restricts the search to instruments, which names
5674 satisfy the supplied search string.</t>
5675 </list>
5676 </t>
5677
5678 <t>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
5679 <list>
5680 <t>Restricts the search to instruments, which
5681 size is in the specified range. If &lt;min&gt; is omitted,
5682 the search results are restricted to instruments with size less then
5683 or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
5684 search is restricted to instruments with size greater then
5685 or equal to &lt;min&gt;.</t>
5686 </list>
5687 </t>
5688
5689 <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5690 <list>
5691 <t>Restricts the search to instruments, which creation
5692 date satisfies the specified period, where &lt;date-after&gt;
5693 and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5694 If &lt;date-after&gt; is omitted the search is restricted to
5695 instruments created before &lt;date-before&gt;. If
5696 &lt;date-before&gt; is omitted, the search is restricted
5697 to instruments created after &lt;date-after&gt;.</t>
5698 </list>
5699 </t>
5700
5701 <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5702 <list>
5703 <t>Restricts the search to instruments, which
5704 date of last modification satisfies the specified period, where
5705 &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5706 format. If &lt;date-after&gt; is omitted the search is restricted to
5707 instruments, which are last modified before &lt;date-before&gt;. If
5708 &lt;date-before&gt; is omitted, the search is restricted to instruments,
5709 which are last modified after &lt;date-after&gt;.</t>
5710 </list>
5711 </t>
5712
5713 <t>DESCRIPTION='&lt;search-string&gt;'
5714 <list>
5715 <t>Restricts the search to instruments with description
5716 that satisfies the supplied search string.</t>
5717 </list>
5718 </t>
5719
5720 <t>PRODUCT='&lt;search-string&gt;'
5721 <list>
5722 <t>Restricts the search to instruments with product info
5723 that satisfies the supplied search string.</t>
5724 </list>
5725 </t>
5726
5727 <t>ARTISTS='&lt;search-string&gt;'
5728 <list>
5729 <t>Restricts the search to instruments with artists info
5730 that satisfies the supplied search string.</t>
5731 </list>
5732 </t>
5733
5734 <t>KEYWORDS='&lt;search-string&gt;'
5735 <list>
5736 <t>Restricts the search to instruments with keyword list
5737 that satisfies the supplied search string.</t>
5738 </list>
5739 </t>
5740
5741 <t>IS_DRUM=true | false
5742 <list>
5743 <t>Either true or false. Restricts the search to
5744 drum kits or chromatic instruments.</t>
5745 </list>
5746 </t>
5747
5748 <t>FORMAT_FAMILIES='&lt;format-list&gt;'
5749 <list>
5750 <t>Restricts the search to instruments of the supplied format families,
5751 where &lt;format-list&gt; is a comma separated list of format families.</t>
5752 </list>
5753 </t>
5754 </t>
5755
5756 <t>Where &lt;search-string&gt; is either a regular expression, or a
5757 word list separated with spaces for OR search and with '+' for AND search.</t>
5758
5759 <t>Possible Answers:</t>
5760 <t>
5761 <list>
5762 <t>A comma separated list with the absolute path names (encapsulated into
5763 apostrophes) of all instruments in the specified directory that satisfy
5764 the supplied search criterias.</t>
5765 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5766 <list>
5767 <t>if the given directory does not exist.</t>
5768 </list>
5769 </t>
5770 </list>
5771 </t>
5772 <t>Example:</t>
5773 <t>
5774 <list>
5775 <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"</t>
5776 <t>S: "'/Piano Collection/Bosendorfer 290'"</t>
5777 </list>
5778 </t>
5779 <t>
5780 <list>
5781 <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"</t>
5782 <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"</t>
5783 </list>
5784 </t>
5785 </section>
5786
5787 </section>
5788
5789 </section>
5790
5791
5792 <section title="Command Syntax" anchor="command_syntax">
5793 <t>The grammar of the control protocol as descibed in <xref target="control_commands"/>
5794 is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>)
5795 where applicable.
5796 </t>
5797 <!--
5798 This section is automatically generated by scripts/update_grammar.pl
5799 from src/network/lscp.y (yacc input file). Do not modify this section
5800 manually !
5801 -->
5802 <!-- GRAMMAR_BNF_BEGIN - do NOT delete or modify this line !!! -->
5803
5804 <t>input =
5805 <list>
5806 <t>line LF
5807 </t>
5808 <t>/ line CR LF
5809 </t>
5810 </list>
5811 </t>
5812 <t>line =
5813 <list>
5814 <t>/* epsilon (empty line ignored) */
5815 </t>
5816 <t>/ comment
5817 </t>
5818 <t>/ command
5819 </t>
5820 <t>/ error
5821 </t>
5822 </list>
5823 </t>
5824 <t>comment =
5825 <list>
5826 <t>'#'
5827 </t>
5828 <t>/ comment '#'
5829 </t>
5830 <t>/ comment SP
5831 </t>
5832 <t>/ comment number
5833 </t>
5834 <t>/ comment string
5835 </t>
5836 </list>
5837 </t>
5838 <t>command =
5839 <list>
5840 <t>ADD SP add_instruction
5841 </t>
5842 <t>/ MAP SP map_instruction
5843 </t>
5844 <t>/ UNMAP SP unmap_instruction
5845 </t>
5846 <t>/ GET SP get_instruction
5847 </t>
5848 <t>/ CREATE SP create_instruction
5849 </t>
5850 <t>/ DESTROY SP destroy_instruction
5851 </t>
5852 <t>/ LIST SP list_instruction
5853 </t>
5854 <t>/ LOAD SP load_instruction
5855 </t>
5856 <t>/ REMOVE SP remove_instruction
5857 </t>
5858 <t>/ SET SP set_instruction
5859 </t>
5860 <t>/ SUBSCRIBE SP subscribe_event
5861 </t>
5862 <t>/ UNSUBSCRIBE SP unsubscribe_event
5863 </t>
5864 <t>/ RESET SP reset_instruction
5865 </t>
5866 <t>/ CLEAR SP clear_instruction
5867 </t>
5868 <t>/ FIND SP find_instruction
5869 </t>
5870 <t>/ MOVE SP move_instruction
5871 </t>
5872 <t>/ COPY SP copy_instruction
5873 </t>
5874 <t>/ RESET
5875 </t>
5876 <t>/ QUIT
5877 </t>
5878 </list>
5879 </t>
5880 <t>add_instruction =
5881 <list>
5882 <t>CHANNEL
5883 </t>
5884 <t>/ DB_INSTRUMENT_DIRECTORY SP pathname
5885 </t>
5886 <t>/ DB_INSTRUMENTS SP FLAT SP pathname SP pathname
5887 </t>
5888 <t>/ DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname
5889 </t>
5890 <t>/ DB_INSTRUMENTS SP pathname SP pathname
5891 </t>
5892 <t>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index
5893 </t>
5894 <t>/ MIDI_INSTRUMENT_MAP
5895 </t>
5896 <t>/ MIDI_INSTRUMENT_MAP SP map_name
5897 </t>
5898 </list>
5899 </t>
5900 <t>subscribe_event =
5901 <list>
5902 <t>AUDIO_OUTPUT_DEVICE_COUNT
5903 </t>
5904 <t>/ AUDIO_OUTPUT_DEVICE_INFO
5905 </t>
5906 <t>/ MIDI_INPUT_DEVICE_COUNT
5907 </t>
5908 <t>/ MIDI_INPUT_DEVICE_INFO
5909 </t>
5910 <t>/ CHANNEL_COUNT
5911 </t>
5912 <t>/ VOICE_COUNT
5913 </t>
5914 <t>/ STREAM_COUNT
5915 </t>
5916 <t>/ BUFFER_FILL
5917 </t>
5918 <t>/ CHANNEL_INFO
5919 </t>
5920 <t>/ FX_SEND_COUNT
5921 </t>
5922 <t>/ FX_SEND_INFO
5923 </t>
5924 <t>/ MIDI_INSTRUMENT_MAP_COUNT
5925 </t>
5926 <t>/ MIDI_INSTRUMENT_MAP_INFO
5927 </t>
5928 <t>/ MIDI_INSTRUMENT_COUNT
5929 </t>
5930 <t>/ MIDI_INSTRUMENT_INFO
5931 </t>
5932 <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
5933 </t>
5934 <t>/ DB_INSTRUMENT_DIRECTORY_INFO
5935 </t>
5936 <t>/ DB_INSTRUMENT_COUNT
5937 </t>
5938 <t>/ DB_INSTRUMENT_INFO
5939 </t>
5940 <t>/ MISCELLANEOUS
5941 </t>
5942 <t>/ TOTAL_VOICE_COUNT
5943 </t>
5944 <t>/ GLOBAL_INFO
5945 </t>
5946 </list>
5947 </t>
5948 <t>unsubscribe_event =
5949 <list>
5950 <t>AUDIO_OUTPUT_DEVICE_COUNT
5951 </t>
5952 <t>/ AUDIO_OUTPUT_DEVICE_INFO
5953 </t>
5954 <t>/ MIDI_INPUT_DEVICE_COUNT
5955 </t>
5956 <t>/ MIDI_INPUT_DEVICE_INFO
5957 </t>
5958 <t>/ CHANNEL_COUNT
5959 </t>
5960 <t>/ VOICE_COUNT
5961 </t>
5962 <t>/ STREAM_COUNT
5963 </t>
5964 <t>/ BUFFER_FILL
5965 </t>
5966 <t>/ CHANNEL_INFO
5967 </t>
5968 <t>/ FX_SEND_COUNT
5969 </t>
5970 <t>/ FX_SEND_INFO
5971 </t>
5972 <t>/ MIDI_INSTRUMENT_MAP_COUNT
5973 </t>
5974 <t>/ MIDI_INSTRUMENT_MAP_INFO
5975 </t>
5976 <t>/ MIDI_INSTRUMENT_COUNT
5977 </t>
5978 <t>/ MIDI_INSTRUMENT_INFO
5979 </t>
5980 <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
5981 </t>
5982 <t>/ DB_INSTRUMENT_DIRECTORY_INFO
5983 </t>
5984 <t>/ DB_INSTRUMENT_COUNT
5985 </t>
5986 <t>/ DB_INSTRUMENT_INFO
5987 </t>
5988 <t>/ MISCELLANEOUS
5989 </t>
5990 <t>/ TOTAL_VOICE_COUNT
5991 </t>
5992 <t>/ GLOBAL_INFO
5993 </t>
5994 </list>
5995 </t>
5996 <t>map_instruction =
5997 <list>
5998 <t>MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value
5999 </t>
6000 <t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode
6001 </t>
6002 <t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name
6003 </t>
6004 <t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name
6005 </t>
6006 </list>
6007 </t>
6008 <t>unmap_instruction =
6009 <list>
6010 <t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
6011 </t>
6012 </list>
6013 </t>
6014 <t>remove_instruction =
6015 <list>
6016 <t>CHANNEL SP sampler_channel
6017 </t>
6018 <t>/ MIDI_INSTRUMENT_MAP SP midi_map
6019 </t>
6020 <t>/ MIDI_INSTRUMENT_MAP SP ALL
6021 </t>
6022 <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname
6023 </t>
6024 <t>/ DB_INSTRUMENT_DIRECTORY SP pathname
6025 </t>
6026 <t>/ DB_INSTRUMENT SP pathname
6027 </t>
6028 </list>
6029 </t>
6030 <t>get_instruction =
6031 <list>
6032 <t>AVAILABLE_ENGINES
6033 </t>
6034 <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
6035 </t>
6036 <t>/ MIDI_INPUT_DRIVER SP INFO SP string
6037 </t>
6038 <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
6039 </t>
6040 <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
6041 </t>
6042 <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
6043 </t>
6044 <t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string
6045 </t>
6046 <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
6047 </t>
6048 <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
6049 </t>
6050 <t>/ AUDIO_OUTPUT_DEVICES
6051 </t>
6052 <t>/ MIDI_INPUT_DEVICES
6053 </t>
6054 <t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number
6055 </t>
6056 <t>/ MIDI_INPUT_DEVICE SP INFO SP number
6057 </t>
6058 <t>/ MIDI_INPUT_PORT SP INFO SP number SP number
6059 </t>
6060 <t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
6061 </t>
6062 <t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
6063 </t>
6064 <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string
6065 </t>
6066 <t>/ CHANNELS
6067 </t>
6068 <t>/ CHANNEL SP INFO SP sampler_channel
6069 </t>
6070 <t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
6071 </t>
6072 <t>/ CHANNEL SP STREAM_COUNT SP sampler_channel
6073 </t>
6074 <t>/ CHANNEL SP VOICE_COUNT SP sampler_channel
6075 </t>
6076 <t>/ ENGINE SP INFO SP engine_name
6077 </t>
6078 <t>/ SERVER SP INFO
6079 </t>
6080 <t>/ TOTAL_VOICE_COUNT
6081 </t>
6082 <t>/ TOTAL_VOICE_COUNT_MAX
6083 </t>
6084 <t>/ MIDI_INSTRUMENTS SP midi_map
6085 </t>
6086 <t>/ MIDI_INSTRUMENTS SP ALL
6087 </t>
6088 <t>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
6089 </t>
6090 <t>/ MIDI_INSTRUMENT_MAPS
6091 </t>
6092 <t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
6093 </t>
6094 <t>/ FX_SENDS SP sampler_channel
6095 </t>
6096 <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
6097 </t>
6098 <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
6099 </t>
6100 <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname
6101 </t>
6102 <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
6103 </t>
6104 <t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname
6105 </t>
6106 <t>/ DB_INSTRUMENTS SP pathname
6107 </t>
6108 <t>/ DB_INSTRUMENT SP INFO SP pathname
6109 </t>
6110 <t>/ VOLUME
6111 </t>
6112 </list>
6113 </t>
6114 <t>set_instruction =
6115 <list>
6116 <t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
6117 </t>
6118 <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list
6119 </t>
6120 <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
6121 </t>
6122 <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
6123 </t>
6124 <t>/ CHANNEL SP set_chan_instruction
6125 </t>
6126 <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6127 </t>
6128 <t>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
6129 </t>
6130 <t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
6131 </t>
6132 <t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
6133 </t>
6134 <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
6135 </t>
6136 <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname
6137 </t>
6138 <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval
6139 </t>
6140 <t>/ DB_INSTRUMENT SP NAME SP pathname SP dirname
6141 </t>
6142 <t>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval
6143 </t>
6144 <t>/ ECHO SP boolean
6145 </t>
6146 <t>/ VOLUME SP volume_value
6147 </t>
6148 </list>
6149 </t>
6150 <t>create_instruction =
6151 <list>
6152 <t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list
6153 </t>
6154 <t>/ AUDIO_OUTPUT_DEVICE SP string
6155 </t>
6156 <t>/ MIDI_INPUT_DEVICE SP string SP key_val_list
6157 </t>
6158 <t>/ MIDI_INPUT_DEVICE SP string
6159 </t>
6160 <t>/ FX_SEND SP sampler_channel SP midi_ctrl
6161 </t>
6162 <t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
6163 </t>
6164 </list>
6165 </t>
6166 <t>reset_instruction =
6167 <list>
6168 <t>CHANNEL SP sampler_channel
6169 </t>
6170 </list>
6171 </t>
6172 <t>clear_instruction =
6173 <list>
6174 <t>MIDI_INSTRUMENTS SP midi_map
6175 </t>
6176 <t>/ MIDI_INSTRUMENTS SP ALL
6177 </t>
6178 </list>
6179 </t>
6180 <t>find_instruction =
6181 <list>
6182 <t>DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list
6183 </t>
6184 <t>/ DB_INSTRUMENTS SP pathname SP query_val_list
6185 </t>
6186 <t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP query_val_list
6187 </t>
6188 <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list
6189 </t>
6190 </list>
6191 </t>
6192 <t>move_instruction =
6193 <list>
6194 <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
6195 </t>
6196 <t>/ DB_INSTRUMENT SP pathname SP pathname
6197 </t>
6198 </list>
6199 </t>
6200 <t>copy_instruction =
6201 <list>
6202 <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
6203 </t>
6204 <t>/ DB_INSTRUMENT SP pathname SP pathname
6205 </t>
6206 </list>
6207 </t>
6208 <t>destroy_instruction =
6209 <list>
6210 <t>AUDIO_OUTPUT_DEVICE SP number
6211 </t>
6212 <t>/ MIDI_INPUT_DEVICE SP number
6213 </t>
6214 <t>/ FX_SEND SP sampler_channel SP fx_send_id
6215 </t>
6216 </list>
6217 </t>
6218 <t>load_instruction =
6219 <list>
6220 <t>INSTRUMENT SP load_instr_args
6221 </t>
6222 <t>/ ENGINE SP load_engine_args
6223 </t>
6224 </list>
6225 </t>
6226 <t>set_chan_instruction =
6227 <list>
6228 <t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
6229 </t>
6230 <t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index
6231 </t>
6232 <t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
6233 </t>
6234 <t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index
6235 </t>
6236 <t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index
6237 </t>
6238 <t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
6239 </t>
6240 <t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index
6241 </t>
6242 <t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
6243 </t>
6244 <t>/ VOLUME SP sampler_channel SP volume_value
6245 </t>
6246 <t>/ MUTE SP sampler_channel SP boolean
6247 </t>
6248 <t>/ SOLO SP sampler_channel SP boolean
6249 </t>
6250 <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
6251 </t>
6252 <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
6253 </t>
6254 <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
6255 </t>
6256 </list>
6257 </t>
6258 <t>modal_arg =
6259 <list>
6260 <t>/* epsilon (empty argument) */
6261 </t>
6262 <t>/ NON_MODAL SP
6263 </t>
6264 </list>
6265 </t>
6266 <t>key_val_list =
6267 <list>
6268 <t>string '=' param_val_list
6269 </t>
6270 <t>/ key_val_list SP string '=' param_val_list
6271 </t>
6272 </list>
6273 </t>
6274 <t>buffer_size_type =
6275 <list>
6276 <t>BYTES
6277 </t>
6278 <t>/ PERCENTAGE
6279 </t>
6280 </list>
6281 </t>
6282 <t>list_instruction =
6283 <list>
6284 <t>AUDIO_OUTPUT_DEVICES
6285 </t>
6286 <t>/ MIDI_INPUT_DEVICES
6287 </t>
6288 <t>/ CHANNELS
6289 </t>
6290 <t>/ AVAILABLE_ENGINES
6291 </t>
6292 <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
6293 </t>
6294 <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
6295 </t>
6296 <t>/ MIDI_INSTRUMENTS SP midi_map
6297 </t>
6298 <t>/ MIDI_INSTRUMENTS SP ALL
6299 </t>
6300 <t>/ MIDI_INSTRUMENT_MAPS
6301 </t>
6302 <t>/ FX_SENDS SP sampler_channel
6303 </t>
6304 <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
6305 </t>
6306 <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname
6307 </t>
6308 <t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname
6309 </t>
6310 <t>/ DB_INSTRUMENTS SP pathname
6311 </t>
6312 </list>
6313 </t>
6314 <t>load_instr_args =
6315 <list>
6316 <t>filename SP instrument_index SP sampler_channel
6317 </t>
6318 <t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel
6319 </t>
6320 </list>
6321 </t>
6322 <t>load_engine_args =
6323 <list>
6324 <t>engine_name SP sampler_channel
6325 </t>
6326 </list>
6327 </t>
6328 <t>instr_load_mode =
6329 <list>
6330 <t>ON_DEMAND
6331 </t>
6332 <t>/ ON_DEMAND_HOLD
6333 </t>
6334 <t>/ PERSISTENT
6335 </t>
6336 </list>
6337 </t>
6338 <t>device_index =
6339 <list>
6340 <t>number
6341 </t>
6342 </list>
6343 </t>
6344 <t>audio_channel_index =
6345 <list>
6346 <t>number
6347 </t>
6348 </list>
6349 </t>
6350 <t>audio_output_type_name =
6351 <list>
6352 <t>string
6353 </t>
6354 </list>
6355 </t>
6356 <t>midi_input_port_index =
6357 <list>
6358 <t>number
6359 </t>
6360 </list>
6361 </t>
6362 <t>midi_input_channel_index =
6363 <list>
6364 <t>number
6365 </t>
6366 <t>/ ALL
6367 </t>
6368 </list>
6369 </t>
6370 <t>midi_input_type_name =
6371 <list>
6372 <t>string
6373 </t>
6374 </list>
6375 </t>
6376 <t>midi_map =
6377 <list>
6378 <t>number
6379 </t>
6380 </list>
6381 </t>
6382 <t>midi_bank =
6383 <list>
6384 <t>number
6385 </t>
6386 </list>
6387 </t>
6388 <t>midi_prog =
6389 <list>
6390 <t>number
6391 </t>
6392 </list>
6393 </t>
6394 <t>midi_ctrl =
6395 <list>
6396 <t>number
6397 </t>
6398 </list>
6399 </t>
6400 <t>volume_value =
6401 <list>
6402 <t>dotnum
6403 </t>
6404 <t>/ number
6405 </t>
6406 </list>
6407 </t>
6408 <t>sampler_channel =
6409 <list>
6410 <t>number
6411 </t>
6412 </list>
6413 </t>
6414 <t>instrument_index =
6415 <list>
6416 <t>number
6417 </t>
6418 </list>
6419 </t>
6420 <t>fx_send_id =
6421 <list>
6422 <t>number
6423 </t>
6424 </list>
6425 </t>
6426 <t>engine_name =
6427 <list>
6428 <t>string
6429 </t>
6430 </list>
6431 </t>
6432 <t>pathname =
6433 <list>
6434 <t>stringval
6435 </t>
6436 </list>
6437 </t>
6438 <t>dirname =
6439 <list>
6440 <t>stringval
6441 </t>
6442 </list>
6443 </t>
6444 <t>filename =
6445 <list>
6446 <t>stringval
6447 </t>
6448 </list>
6449 </t>
6450 <t>map_name =
6451 <list>
6452 <t>stringval
6453 </t>
6454 </list>
6455 </t>
6456 <t>entry_name =
6457 <list>
6458 <t>stringval
6459 </t>
6460 </list>
6461 </t>
6462 <t>fx_send_name =
6463 <list>
6464 <t>stringval
6465 </t>
6466 </list>
6467 </t>
6468 <t>param_val_list =
6469 <list>
6470 <t>param_val
6471 </t>
6472 <t>/ param_val_list','param_val
6473 </t>
6474 </list>
6475 </t>
6476 <t>param_val =
6477 <list>
6478 <t>string
6479 </t>
6480 <t>/ stringval
6481 </t>
6482 <t>/ number
6483 </t>
6484 <t>/ dotnum
6485 </t>
6486 </list>
6487 </t>
6488 <t>query_val_list =
6489 <list>
6490 <t>string '=' query_val
6491 </t>
6492 <t>/ query_val_list SP string '=' query_val
6493 </t>
6494 </list>
6495 </t>
6496 <t>query_val =
6497 <list>
6498 <t>string
6499 </t>
6500 <t>/ stringval
6501 </t>
6502 </list>
6503 </t>
6504
6505 <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
6506 </section>
6507
6508 <section title="Events" anchor="events">
6509 <t>This chapter will describe all currently defined events supported by LinuxSampler.</t>
6510
6511 <section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">
6512 <t>Client may want to be notified when the total number of audio output devices on the
6513 back-end changes by issuing the following command:</t>
6514 <t>
6515 <list>
6516 <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t>
6517 </list>
6518 </t>
6519 <t>Server will start sending the following notification messages:</t>
6520 <t>
6521 <list>
6522 <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
6523 </list>
6524 </t>
6525 <t>where &lt;devices&gt; will be replaced by the new number
6526 of audio output devices.</t>
6527 </section>
6528
6529 <section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">
6530 <t>Client may want to be notified when changes were made to audio output devices on the
6531 back-end by issuing the following command:</t>
6532 <t>
6533 <list>
6534 <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t>
6535 </list>
6536 </t>
6537 <t>Server will start sending the following notification messages:</t>
6538 <t>
6539 <list>
6540 <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
6541 </list>
6542 </t>
6543 <t>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
6544 which settings has been changed. The front-end will have to send
6545 the respective command to actually get the audio output device info. Because these messages
6546 will be triggered by LSCP commands issued by other clients rather than real
6547 time events happening on the server, it is believed that an empty notification
6548 message is sufficient here.</t>
6549 </section>
6550
6551 <section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">
6552 <t>Client may want to be notified when the total number of MIDI input devices on the
6553 back-end changes by issuing the following command:</t>
6554 <t>
6555 <list>
6556 <t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t>
6557 </list>
6558 </t>
6559 <t>Server will start sending the following notification messages:</t>
6560 <t>
6561 <list>
6562 <t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
6563 </list>
6564 </t>
6565 <t>where &lt;devices&gt; will be replaced by the new number
6566 of MIDI input devices.</t>
6567 </section>
6568
6569 <section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO">
6570 <t>Client may want to be notified when changes were made to MIDI input devices on the
6571 back-end by issuing the following command:</t>
6572 <t>
6573 <list>
6574 <t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t>
6575 </list>
6576 </t>
6577 <t>Server will start sending the following notification messages:</t>
6578 <t>
6579 <list>
6580 <t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
6581 </list>
6582 </t>
6583 <t>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
6584 which settings has been changed. The front-end will have to send
6585 the respective command to actually get the MIDI input device info. Because these messages
6586 will be triggered by LSCP commands issued by other clients rather than real
6587 time events happening on the server, it is believed that an empty notification
6588 message is sufficient here.</t>
6589 </section>
6590
6591 <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT">
6592 <t>Client may want to be notified when the total number of channels on the
6593 back-end changes by issuing the following command:</t>
6594 <t>
6595 <list>
6596 <t>SUBSCRIBE CHANNEL_COUNT</t>
6597 </list>
6598 </t>
6599 <t>Server will start sending the following notification messages:</t>
6600 <t>
6601 <list>
6602 <t>"NOTIFY:CHANNEL_COUNT:&lt;channels&gt;"</t>
6603 </list>
6604 </t>
6605 <t>where &lt;channels&gt; will be replaced by the new number
6606 of sampler channels.</t>
6607 </section>
6608
6609 <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">
6610 <t>Client may want to be notified when the number of voices on the
6611 back-end changes by issuing the following command:</t>
6612 <t>
6613 <list>
6614 <t>SUBSCRIBE VOICE_COUNT</t>
6615 </list>
6616 </t>
6617 <t>Server will start sending the following notification messages:</t>
6618 <t>
6619 <list>
6620 <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"</t>
6621 </list>
6622 </t>
6623 <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
6624 voice count change occurred and &lt;voices&gt; by the new number of
6625 active voices on that channel.</t>
6626 </section>
6627
6628 <section title="Number of active disk streams changed" anchor="SUBSCRIBE STREAM_COUNT">
6629 <t>Client may want to be notified when the number of streams on the back-end
6630 changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t>
6631 <t>
6632 <list>
6633 <t>SUBSCRIBE STREAM_COUNT</t>
6634 </list>
6635 </t>
6636 <t>Server will start sending the following notification messages:</t>
6637 <t>
6638 <list>
6639 <t>"NOTIFY:STREAM_COUNT:&lt;sampler-channel&gt; &lt;streams&gt;"</t>
6640 </list>
6641 </t>
6642 <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
6643 stream count change occurred and &lt;streams&gt; by the new number of
6644 active disk streams on that channel.</t>
6645 </section>
6646
6647 <section title="Disk stream buffer fill state changed" anchor="SUBSCRIBE BUFFER_FILL">
6648 <t>Client may want to be notified when the buffer fill state of a disk stream
6649 on the back-end changes by issuing the following command:</t>
6650 <t>
6651 <list>
6652 <t>SUBSCRIBE BUFFER_FILL</t>
6653 </list>
6654 </t>
6655 <t>Server will start sending the following notification messages:</t>
6656 <t>
6657 <list>
6658 <t>"NOTIFY:BUFFER_FILL:&lt;sampler-channel&gt; &lt;fill-data&gt;"</t>
6659 </list>
6660 </t>
6661 <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
6662 buffer fill state change occurred on and &lt;fill-data&gt; will be replaced by the
6663 buffer fill data for this channel as described in <xref target="GET CHANNEL BUFFER_FILL" />
6664 as if the <xref target="GET CHANNEL BUFFER_FILL">
6665 "GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t>
6666 </section>
6667
6668 <section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO">
6669 <t>Client may want to be notified when changes were made to sampler channels on the
6670 back-end by issuing the following command:</t>
6671 <t>
6672 <list>
6673 <t>SUBSCRIBE CHANNEL_INFO</t>
6674 </list>
6675 </t>
6676 <t>Server will start sending the following notification messages:</t>
6677 <t>
6678 <list>
6679 <t>"NOTIFY:CHANNEL_INFO:&lt;sampler-channel&gt;"</t>
6680 </list>
6681 </t>
6682 <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
6683 channel info change occurred. The front-end will have to send
6684 the respective command to actually get the channel info. Because these messages
6685 will be triggered by LSCP commands issued by other clients rather than real
6686 time events happening on the server, it is believed that an empty notification
6687 message is sufficient here.</t>
6688 </section>
6689
6690 <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
6691 <t>Client may want to be notified when the number of effect sends on
6692 a particular sampler channel is changed by issuing the following command:</t>
6693 <t>
6694 <list>
6695 <t>SUBSCRIBE FX_SEND_COUNT</t>
6696 </list>
6697 </t>
6698 <t>Server will start sending the following notification messages:</t>
6699 <t>
6700 <list>
6701 <t>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"</t>
6702 </list>
6703 </t>
6704 <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
6705 channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
6706 be replaced by the new number of effect sends on that channel.</t>
6707 </section>
6708
6709 <section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO">
6710 <t>Client may want to be notified when changes were made to effect sends on a
6711 a particular sampler channel by issuing the following command:</t>
6712 <t>
6713 <list>
6714 <t>SUBSCRIBE FX_SEND_INFO</t>
6715 </list>
6716 </t>
6717 <t>Server will start sending the following notification messages:</t>
6718 <t>
6719 <list>
6720 <t>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"</t>
6721 </list>
6722 </t>
6723 <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
6724 channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
6725 be replaced by the numerical ID of the changed effect send.</t>
6726 </section>
6727
6728 <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT">
6729 <t>Client may want to be notified when the total number of voices on the
6730 back-end changes by issuing the following command:</t>
6731 <t>
6732 <list>
6733 <t>SUBSCRIBE TOTAL_VOICE_COUNT</t>
6734 </list>
6735 </t>
6736 <t>Server will start sending the following notification messages:</t>
6737 <t>
6738 <list>
6739 <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"</t>
6740 </list>
6741 </t>
6742 <t>where &lt;voices&gt; will be replaced by the new number of
6743 all currently active voices.</t>
6744 </section>
6745
6746 <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">
6747 <t>Client may want to be notified when the number of MIDI instrument maps on the
6748 back-end changes by issuing the following command:</t>
6749 <t>
6750 <list>
6751 <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t>
6752 </list>
6753 </t>
6754 <t>Server will start sending the following notification messages:</t>
6755 <t>
6756 <list>
6757 <t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"</t>
6758 </list>
6759 </t>
6760 <t>where &lt;maps&gt; will be replaced by the new number
6761 of MIDI instrument maps.</t>
6762 </section>
6763
6764 <section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">
6765 <t>Client may want to be notified when changes were made to MIDI instrument maps on the
6766 back-end by issuing the following command:</t>
6767 <t>
6768 <list>
6769 <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t>
6770 </list>
6771 </t>
6772 <t>Server will start sending the following notification messages:</t>
6773 <t>
6774 <list>
6775 <t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"</t>
6776 </list>
6777 </t>
6778 <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
6779 for which information changes occurred. The front-end will have to send
6780 the respective command to actually get the MIDI instrument map info. Because these messages
6781 will be triggered by LSCP commands issued by other clients rather than real
6782 time events happening on the server, it is believed that an empty notification
6783 message is sufficient here.</t>
6784 </section>
6785
6786 <section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT">
6787 <t>Client may want to be notified when the number of MIDI instrument maps on the
6788 back-end changes by issuing the following command:</t>
6789 <t>
6790 <list>
6791 <t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t>
6792 </list>
6793 </t>
6794 <t>Server will start sending the following notification messages:</t>
6795 <t>
6796 <list>
6797 <t>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"</t>
6798 </list>
6799 </t>
6800 <t>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
6801 the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
6802 the new number of MIDI instruments in the specified map.</t>
6803 </section>
6804
6805 <section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO">
6806 <t>Client may want to be notified when changes were made to MIDI instruments on the
6807 back-end by issuing the following command:</t>
6808 <t>
6809 <list>
6810 <t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t>
6811 </list>
6812 </t>
6813 <t>Server will start sending the following notification messages:</t>
6814 <t>
6815 <list>
6816 <t>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"</t>
6817 </list>
6818 </t>
6819 <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
6820 in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
6821 the location of the changed MIDI instrument in the map. The front-end will have to send
6822 the respective command to actually get the MIDI instrument info. Because these messages
6823 will be triggered by LSCP commands issued by other clients rather than real
6824 time events happening on the server, it is believed that an empty notification
6825 message is sufficient here.</t>
6826 </section>
6827
6828 <section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO">
6829 <t>Client may want to be notified when changes to the global settings
6830 of the sampler were made by issuing the following command:</t>
6831 <t>
6832 <list>
6833 <t>SUBSCRIBE GLOBAL_INFO</t>
6834 </list>
6835 </t>
6836 <t>Server will start sending the following types of notification messages:</t>
6837 <t>
6838 <list>
6839 <t>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
6840 golbal volume of the sampler is changed, where &lt;volume&gt; will be
6841 replaced by the optional dotted floating point value, reflecting the
6842 new global volume parameter.</t>
6843 </list>
6844 </t>
6845 </section>
6846
6847 <section title="Number of database instrument directories changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">
6848 <t>Client may want to be notified when the number of instrument
6849 directories in a particular directory in the instruments database
6850 is changed by issuing the following command:</t>
6851 <t>
6852 <list>
6853 <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT</t>
6854 </list>
6855 </t>
6856 <t>Server will start sending the following notification messages:</t>
6857 <t>
6858 <list>
6859 <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:&lt;dir-path&gt;"</t>
6860 </list>
6861 </t>
6862 <t>where &lt;dir-path&gt; will be replaced by the absolute path
6863 name of the directory in the instruments database,
6864 in which the number of directories is changed.</t>
6865 <t>Note that when a non-empty directory is removed, this event
6866 is not sent for the subdirectories in that directory.</t>
6867 </section>
6868
6869 <section title="Database instrument directory information changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">
6870 <t>Client may want to be notified when changes were made to directories
6871 in the instruments database by issuing the following command:</t>
6872 <t>
6873 <list>
6874 <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO</t>
6875 </list>
6876 </t>
6877 <t>Server will start sending the following notification messages:</t>
6878 <t>
6879 <list>
6880 <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:&lt;dir-path&gt;"</t>
6881 </list>
6882 </t>
6883 <t>where &lt;dir-path&gt; will be replaced by the absolute path name
6884 of the directory, for which information changes occurred. The front-end will have to send
6885 the respective command to actually get the updated directory info. Because these messages
6886 will be triggered by LSCP commands issued by other clients rather than real
6887 time events happening on the server, it is believed that an empty notification
6888 message is sufficient here.</t>
6889 <t>
6890 <list>
6891 <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME &lt;old-dir-path&gt; &lt;new-name&gt;"</t>
6892 </list>
6893 </t>
6894 <t>where &lt;old-dir-path&gt; is the old absolute path name of the directory
6895 (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
6896 the new name of the directory, encapsulated into apostrophes.</t>
6897 </section>
6898
6899 <section title="Number of database instruments changed" anchor="SUBSCRIBE DB_INSTRUMENT_COUNT">
6900 <t>Client may want to be notified when the number of instruments
6901 in a particular directory in the instruments database
6902 is changed by issuing the following command:</t>
6903 <t>
6904 <list>
6905 <t>SUBSCRIBE DB_INSTRUMENT_COUNT</t>
6906 </list>
6907 </t>
6908 <t>Server will start sending the following notification messages:</t>
6909 <t>
6910 <list>
6911 <t>"NOTIFY:DB_INSTRUMENT_COUNT:&lt;dir-path&gt;"</t>
6912 </list>
6913 </t>
6914 <t>where &lt;dir-path&gt; will be replaced by the absolute path
6915 name of the directory in the instruments database,
6916 in which the number of instruments is changed.</t>
6917 <t>Note that when a non-empty directory is removed, this event
6918 is not sent for the instruments in that directory.</t>
6919 </section>
6920
6921 <section title="Database instrument information changed" anchor="SUBSCRIBE DB_INSTRUMENT_INFO">
6922 <t>Client may want to be notified when changes were made to instruments
6923 in the instruments database by issuing the following command:</t>
6924 <t>
6925 <list>
6926 <t>SUBSCRIBE DB_INSTRUMENT_INFO</t>
6927 </list>
6928 </t>
6929 <t>Server will start sending the following notification messages:</t>
6930 <t>
6931 <list>
6932 <t>"NOTIFY:DB_INSTRUMENT_INFO:&lt;instr-path&gt;"</t>
6933 </list>
6934 </t>
6935 <t>where &lt;instr-path&gt; will be replaced by the absolute path name
6936 of the instrument, which settings are changed. The front-end will have to send
6937 the respective command to actually get the updated directory info. Because these messages
6938 will be triggered by LSCP commands issued by other clients rather than real
6939 time events happening on the server, it is believed that an empty notification
6940 message is sufficient here.</t>
6941 <t>
6942 <list>
6943 <t>"NOTIFY:DB_INSTRUMENT_INFO:NAME &lt;old-instr-path&gt; &lt;new-name&gt;"</t>
6944 </list>
6945 </t>
6946 <t>where &lt;old-instr-path&gt; is the old absolute path name of the instrument
6947 (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
6948 the new name of the instrument, encapsulated into apostrophes.</t>
6949 </section>
6950
6951 <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
6952 <t>Client may want to be notified of miscellaneous and debugging events occurring at
6953 the server by issuing the following command:</t>
6954 <t>
6955 <list>
6956 <t>SUBSCRIBE MISCELLANEOUS</t>
6957 </list>
6958 </t>
6959 <t>Server will start sending the following notification messages:</t>
6960 <t>
6961 <list>
6962 <t>"NOTIFY:MISCELLANEOUS:&lt;string&gt;"</t>
6963 </list>
6964 </t>
6965 <t>where &lt;string&gt; will be replaced by whatever data server
6966 wants to send to the client. Client MAY display this data to the
6967 user AS IS to facilitate debugging.</t>
6968 </section>
6969 </section>
6970
6971 <section title="Security Considerations">
6972 <t>As there is so far no method of authentication and authorization
6973 defined and so not required for a client applications to succeed to
6974 connect, running LinuxSampler might be a security risk for the host
6975 system the LinuxSampler instance is running on.</t>
6976 </section>
6977
6978 <section title="Acknowledgments">
6979 <t>This document has benefited greatly from the comments of the
6980 following people, discussed on the LinuxSampler developer's mailing
6981 list:</t>
6982 <t>
6983 <list>
6984 <t>Rui Nuno Capela</t>
6985 <t>Vladimir Senkov</t>
6986 <t>Mark Knecht</t>
6987 <t>Grigor Iliev</t>
6988 </list>
6989 </t>
6990 </section>
6991
6992 </middle>
6993
6994 <back>
6995 <references>
6996 <reference anchor="RFC2119">
6997 <front>
6998 <title>Key words for use in RFCs to Indicate Requirement Levels</title>
6999 <author initials="S." surname="Bradner" fullname="Scott Bradner">
7000 <organization>Harvard University</organization>
7001 </author>
7002 <date year="1997"></date>
7003 </front>
7004 <seriesInfo name="RFC" value="2119" />
7005 </reference>
7006 <reference anchor="RFC793">
7007 <front>
7008 <title>TRANSMISSION CONTROL PROTOCOL</title>
7009 <author>
7010 <organization>Defense Advanced Research Projects Agency</organization>
7011 </author>
7012 <date year="1981"></date>
7013 </front>
7014 <seriesInfo name="RFC" value="793" />
7015 </reference>
7016 <reference anchor="RFC2234">
7017 <front>
7018 <title>Augmented BNF for Syntax Specifications</title>
7019 <author initials="D.H." surname="Crocker" fullname="David H. Crocker">
7020 <organization>Internet Mail Consortium</organization>
7021 </author>
7022 <author initials="P." surname="Overell" fullname="Paul Overell">
7023 <organization>Demon Internet Ltd</organization>
7024 </author>
7025 <date year="1997"></date>
7026 </front>
7027 <seriesInfo name="RFC" value="2234" />
7028 </reference>
7029 </references>
7030 </back>
7031
7032 </rfc>

  ViewVC Help
Powered by ViewVC