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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 212 by schoenebeck, Wed Jul 28 14:17:29 2004 UTC revision 1800 by schoenebeck, Sun Dec 7 01:26:46 2008 UTC
# Line 11  Line 11 
11  <?rfc symrefs="yes" ?>  <?rfc symrefs="yes" ?>
12  <?rfc sortrefs="yes"?>  <?rfc sortrefs="yes"?>
13  <?rfc iprnotified="no" ?>  <?rfc iprnotified="no" ?>
 <?rfc strict="yes" ?>  
14    
15  <rfc category="std" ipr="full2026" docName="lscp.txt">  <!-- FIXME: next attribute should actually be "yes", temporarily disbled due
16         to an annoying "missing Normative/Informative References" error message -->
17    <?rfc strict="no" ?>
18    
19    <rfc category="std" ipr="full3978" docName="LSCP 1.4">
20      <front>      <front>
21          <title>LinuxSampler Control Protocol</title>          <title>LinuxSampler Control Protocol</title>
22          <author initials='C.S.' surname="Schoenebeck" fullname='C.          <author initials='C.S.' surname="Schoenebeck" fullname='C.
# Line 31  Schoenebeck'> Line 34  Schoenebeck'>
34                  <email>schoenebeck at software minus engineering dot org</email>                  <email>schoenebeck at software minus engineering dot org</email>
35              </address>              </address>
36          </author>          </author>
37          <date month="June" year="2004"/>          <date month="December" year="2008"/>
38          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
39          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
40          <abstract>          <abstract>
41              <t>The LinuxSampler Control Protocol (LSCP) is an              <t>The LinuxSampler Control Protocol (LSCP) is an
42              application-level protocol primarily intended for local and              application-level protocol primarily intended for local and
43              remote controlling the LinuxSampler main application, which is a              remote controlling the LinuxSampler backend application, which is a
44              sophisticated console application essentially playing back audio              sophisticated server-like console application essentially playing
45              samples and manipulating the samples in real time to certain              back audio samples and manipulating the samples in real time to
46              extent.</t>              certain extent.</t>
47          </abstract>          </abstract>
48      </front>      </front>
49    
# Line 58  Schoenebeck'> Line 61  Schoenebeck'>
61              (front-end) and server (LinuxSampler) respectively. Lines in              (front-end) and server (LinuxSampler) respectively. Lines in
62              examples must be interpreted as every line being CRLF              examples must be interpreted as every line being CRLF
63              terminated (carriage return character followed by line feed              terminated (carriage return character followed by line feed
64              character as defined in the ASCII standard), thus the following              character as defined in the ASCII standard <xref target="RFC20"/>),
65              example:</t>              thus the following example:</t>
66    
67              <t>              <t>
68                  <list>                  <list>
# Line 112  Schoenebeck'> Line 115  Schoenebeck'>
115              return and line feed characters respectively.</t>              return and line feed characters respectively.</t>
116          </section>          </section>
117    
118            <section title="Versioning of this specification" anchor="LSCP versioning">
119                <t>LSCP will certainly be extended and enhanced by-and-by. Each official
120                release of the LSCP specification will be tagged with a unique version
121                tuple. The version tuple consists at least of a major and minor version
122                number like:
123                </t>
124                <t>
125                    <list>
126                        <t>"1.2"</t>
127                    </list>
128                </t>
129                <t>
130                In this example the major version number would be "1" and the minor
131                version number would be "2". Note that the version tuple might also
132                have more than two elements. The major version number defines a
133                group of backward compatible versions. That means a frontend is
134                compatible to the connected sampler if and only if the LSCP versions
135                to which each of the two parties complies to, match both of the
136                following rules:
137                </t>
138                <t>Compatibility:</t>
139                <t>
140                    <list style="numbers">
141                        <t>The frontend's LSCP major version and the sampler's LSCP
142                        major version are exactly equal.</t>
143                        <t>The frontend's LSCP minor version is less or equal than
144                        the sampler's LSCP minor version.</t>
145                    </list>
146                </t>
147                <t>
148                Compatibility can only be claimed if both rules are true.
149                The frontend can use the
150                <xref target="GET SERVER INFO">"GET SERVER INFO"</xref> command to
151                get the version of the LSCP specification the sampler complies with.
152                </t>
153            </section>
154    
155          <section title="Introduction">          <section title="Introduction">
156              <t>LinuxSampler is a so called software sampler application              <t>LinuxSampler is a so called software sampler application
157              capable to playback audio samples from a computer's Random              capable to playback audio samples from a computer's Random
# Line 122  Schoenebeck'> Line 162  Schoenebeck'>
162              referred in this document as "sampler channels". The channels              referred in this document as "sampler channels". The channels
163              are in such way virtual as they can be connected to an              are in such way virtual as they can be connected to an
164              arbitrary MIDI input method and arbitrary MIDI channel (e.g.              arbitrary MIDI input method and arbitrary MIDI channel (e.g.
165              sampler channel 17 could be connected to an Alsa sequencer              sampler channel 17 could be connected to an ALSA sequencer
166              device 64:0 and listening to MIDI channel 1 there). Each sampler              device 64:0 and listening to MIDI channel 1 there). Each sampler
167              engine will be assigned an own instance of one of the available              channel will be associated with an instance of one of the available
168              sampler engines (e.g. GigEngine, DLSEngine). The audio output of              sampler engines (e.g. GigEngine, DLSEngine). The audio output of
169              each sampler channel can be routed to an arbitrary audio output              each sampler channel can be routed to an arbitrary audio output
170              method (Alsa / Jack) and an arbitrary audio output channel              method (ALSA / JACK) and an arbitrary audio output channel
171              there.</t>              there.</t>
172          </section>          </section>
173    
# Line 154  Schoenebeck'> Line 194  Schoenebeck'>
194              methods will be described next.</t>              methods will be described next.</t>
195    
196              <section title="Request/response communication method">              <section title="Request/response communication method">
197                  <t>This simple communication method is based on TCP. The                  <t>This simple communication method is based on
198                    <xref target="RFC793">TCP</xref>. The
199                  front-end application establishes a TCP connection to the                  front-end application establishes a TCP connection to the
200                  LinuxSampler instance on a certain host system. Then the                  LinuxSampler instance on a certain host system. Then the
201                  front-end application will send certain ASCII based commands                  front-end application will send certain ASCII based commands
# Line 216  Schoenebeck'> Line 257  Schoenebeck'>
257                      &lt;warning-message&gt; and &lt;error-message&gt; are                      &lt;warning-message&gt; and &lt;error-message&gt; are
258                      human readable descriptions of the warning or error                      human readable descriptions of the warning or error
259                      respectively.</t>                      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>                      <t>Normal result sets could be:</t>
280                      <t>                      <t>
281                          <list style="numbers">                          <list style="numbers">
# Line 234  Schoenebeck'> Line 294  Schoenebeck'>
294                              <t>"OK"</t>                              <t>"OK"</t>
295                          </list>                          </list>
296                      </t>                      </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                      <t>Single line result sets are command specific. One
305                      example of a single line result set is an empty line.                      example of a single line result set is an empty line.
306                      Multi-line result sets are command specific and may                      Multi-line result sets are command specific and may
# Line 244  Schoenebeck'> Line 311  Schoenebeck'>
311                              <t>"."</t>                              <t>"."</t>
312                          </list>                          </list>
313                      </t>                      </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                      <t>In addition to above mentioned formats, warnings and
329                      empty result sets MAY be indexed. In this case, they                      empty result sets MAY be indexed. In this case, they
330                      have the following formats respectively:</t>                      have the following formats respectively:</t>
# Line 258  Schoenebeck'> Line 339  Schoenebeck'>
339                      related to or other integer value.</t>                      related to or other integer value.</t>
340                      <t>Each line of the result set MUST end with                      <t>Each line of the result set MUST end with
341                      &lt;CRLF&gt;.</t>                      &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>                  </section>
356              </section>              </section>
357              <section title="Subscribe/notify communication method">              <section title="Subscribe/notify communication method">
# Line 326  Schoenebeck'> Line 420  Schoenebeck'>
420    
421                  <t>where &lt;event-id&gt; will be replace by the respective                  <t>where &lt;event-id&gt; will be replace by the respective
422                  event that client is no longer interested in receiving. For                  event that client is no longer interested in receiving. For
423                  a list of supported events see chapter 6.</t>                  a list of supported events see <xref target="events" />.</t>
424    
425                  <t>Example: the fill states of disk stream buffers have                  <t>Example: the fill states of disk stream buffers have
426                  changed on sampler channel 4 and the LinuxSampler instance                  changed on sampler channel 4 and the LinuxSampler instance
# Line 372  Schoenebeck'> Line 466  Schoenebeck'>
466              </section>              </section>
467          </section>          </section>
468    
469          <section title="Description for control commands">          <section title="Description for control commands" anchor="control_commands">
470              <t>This chapter will describe the available control commands              <t>This chapter will describe the available control commands
471              that can be sent on the TCP connection in detail. Some certain              that can be sent on the TCP connection in detail. Some certain
472              commands (e.g. "GET CHANNEL INFO" or "GET ENGINE INFO") lead to              commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref>
473                or <xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref>) lead to
474              multiple-line responses. In this case LinuxSampler signals the              multiple-line responses. In this case LinuxSampler signals the
475              end of the response by a "." (single dot) line.</t>              end of the response by a "." (single dot) line.</t>
476    
# Line 390  Schoenebeck'> Line 485  Schoenebeck'>
485              <section title="Configuring audio drivers">              <section title="Configuring audio drivers">
486                  <t>Instances of drivers in LinuxSampler are called devices.                  <t>Instances of drivers in LinuxSampler are called devices.
487                  You can use multiple audio devices simultaneously, e.g. to                  You can use multiple audio devices simultaneously, e.g. to
488                  output the sound of one sampler channel using the Alsa audio                  output the sound of one sampler channel using the ALSA audio
489                  output driver, and on another sampler channel you might want                  output driver, and on another sampler channel you might want
490                  to use the Jack audio output driver. For particular audio                  to use the JACK audio output driver. For particular audio
491                  output systems it's also possible to create several devices                  output systems it's also possible to create several devices
492                  of the same audio output driver, e.g. two separate Alsa                  of the same audio output driver, e.g. two separate ALSA
493                  audio output devices for using two different sound cards at                  audio output devices for using two different sound cards at
494                  the same time. This chapter describes all commands to                  the same time. This chapter describes all commands to
495                  configure LinuxSampler's audio output devices and their                  configure LinuxSampler's audio output devices and their
# Line 419  Schoenebeck'> Line 514  Schoenebeck'>
514                  what parameters drivers are offering, how to retrieve their                  what parameters drivers are offering, how to retrieve their
515                  possible values, etc.</t>                  possible values, etc.</t>
516    
517                  <section title="Getting all available audio output drivers">                  <section title="Getting amount of available audio output drivers" anchor="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">
518                        <t>Use the following command to get the number of
519                        audio output drivers currently available for the
520                        LinuxSampler instance:</t>
521                        <t>
522                            <list>
523                                <t>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS</t>
524                            </list>
525                        </t>
526                        <t>Possible Answers:</t>
527                        <t>
528                            <list>
529                                <t>LinuxSampler will answer by sending the
530                                number of audio output drivers.</t>
531                            </list>
532                        </t>
533                        <t>Example:</t>
534                        <t>
535                            <list>
536                                <t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t>
537                                <t>S: "2"</t>
538                            </list>
539                        </t>
540                    </section>
541    
542                    <section title="Getting all available audio output drivers" anchor="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
543                      <t>Use the following command to list all audio output                      <t>Use the following command to list all audio output
544                      drivers currently available for the LinuxSampler                      drivers currently available for the LinuxSampler
545                      instance:</t>                      instance:</t>
546                      <t>                      <t>
547                          <list>                          <list>
548                              <t>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS</t>                              <t>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS</t>
549                          </list>                          </list>
550                      </t>                      </t>
551                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 439  Schoenebeck'> Line 559  Schoenebeck'>
559                      <t>Example:</t>                      <t>Example:</t>
560                      <t>                      <t>
561                          <list>                          <list>
562                              <t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t>                              <t>C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t>
563                              <t>S: "Alsa,Jack"</t>                              <t>S: "ALSA,JACK"</t>
564                          </list>                          </list>
565                      </t>                      </t>
566                  </section>                  </section>
567    
568                  <section title="Getting information about a specific audio                  <section title="Getting information about a specific audio
569                  output driver">                  output driver" anchor="GET AUDIO_OUTPUT_DRIVER INFO">
570                      <t>Use the following command to get detailed information                      <t>Use the following command to get detailed information
571                      about a specific audio output driver:</t>                      about a specific audio output driver:</t>
572                      <t>                      <t>
# Line 456  Schoenebeck'> Line 576  Schoenebeck'>
576                          </list>                          </list>
577                      </t>                      </t>
578                      <t>Where &lt;audio-output-driver&gt; is the name of the                      <t>Where &lt;audio-output-driver&gt; is the name of the
579                      audio output driver, returned by the "GET                      audio output driver, returned by the
580                      AVAILABLE_AUDIO_OUTPUT_DRIVERS" command.</t>                      <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command.</t>
581                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
582                      <t>                      <t>
583                          <list>                          <list>
# Line 506  Schoenebeck'> Line 626  Schoenebeck'>
626                      <t>Example:</t>                      <t>Example:</t>
627                      <t>                      <t>
628                        <list>                        <list>
629                            <t>C: "GET AUDIO_OUTPUT_DRIVER INFO Alsa"</t>                            <t>C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"</t>
630                            <t>S: "DESCRIPTION: Advanced Linux Sound                            <t>S: "DESCRIPTION: Advanced Linux Sound
631                            Architecture"</t>                            Architecture"</t>
632                            <t>&nbsp;&nbsp;&nbsp;"VERSION: 1.0"</t>                            <t>&nbsp;&nbsp;&nbsp;"VERSION: 1.0"</t>
633                            <t>&nbsp;&nbsp;&nbsp;"PARAMETERS:                            <t>&nbsp;&nbsp;&nbsp;"PARAMETERS:
634                            driver,channels,samplerate,active,fragments,                            DRIVER,CHANNELS,SAMPLERATE,ACTIVE,FRAGMENTS,
635                            fragmentsize,card"</t>                            FRAGMENTSIZE,CARD"</t>
636                            <t>&nbsp;&nbsp;&nbsp;"."</t>                            <t>&nbsp;&nbsp;&nbsp;"."</t>
637                        </list>                        </list>
638                      </t>                      </t>
639                  </section>                  </section>
640    
641                  <section title="Getting information about specific audio                  <section title="Getting information about specific audio
642                  output driver parameter">                  output driver parameter" anchor="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">
643                      <t>Use the following command to get detailed information                      <t>Use the following command to get detailed information
644                      about a  specific audio output driver parameter:</t>                      about a  specific audio output driver parameter:</t>
645                      <t>                      <t>
# Line 528  Schoenebeck'> Line 648  Schoenebeck'>
648                          </list>                          </list>
649                      </t>                      </t>
650                      <t>Where &lt;audio&gt; is the name of the audio output                      <t>Where &lt;audio&gt; is the name of the audio output
651                      driver as returned by the "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS" command,                      driver as returned by the <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
652                        "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command,
653                      &lt;prm&gt; a specific parameter name for which information should be                      &lt;prm&gt; a specific parameter name for which information should be
654                      obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO" command) and                      obtained (as returned by the
655                        <xref target="GET AUDIO_OUTPUT_DRIVER INFO">"GET AUDIO_OUTPUT_DRIVER INFO"</xref> command) and
656                      &lt;deplist&gt; is an optional list of parameters on which the sought                      &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                      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                      pairs in form of "key1=val1 key2=val2 ...", where character string values
# Line 542  Schoenebeck'> Line 664  Schoenebeck'>
664                      <t>                      <t>
665                          <list>                          <list>
666                              <t>LinuxSampler will answer by sending a                              <t>LinuxSampler will answer by sending a
667                              &lz;CRLF&gt; separated list.                              &lt;CRLF&gt; separated list.
668                              Each answer line begins with the information category name                              Each answer line begins with the information category name
669                              followed by a colon and then a space character &lt;SP&gt; and                              followed by a colon and then a space character &lt;SP&gt; and
670                              finally                              finally
# Line 577  Schoenebeck'> Line 699  Schoenebeck'>
699                                <list>                                <list>
700                                  <t>either true or false, defines if this parameter must be                                  <t>either true or false, defines if this parameter must be
701                                  given when the device is to be created with the                                  given when the device is to be created with the
702                                  'CREATE AUDIO_OUTPUT_DEVICE' command                                  <xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref>
703                                  (always returned, no matter which driver parameter)</t>                                  command (always returned, no matter which driver parameter)</t>
704                                </list>                                </list>
705                              </t>                              </t>
706    
# Line 586  Schoenebeck'> Line 708  Schoenebeck'>
708                                <list>                                <list>
709                                  <t>either true or false, if false then this parameter can                                  <t>either true or false, if false then this parameter can
710                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
711                                  the 'CREATE AUDIO_OUTPUT_DEVICE' command                                  the <xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref>
712                                  (always returned, no matter which driver parameter)</t>                                  command (always returned, no matter which driver parameter)</t>
713                                </list>                                </list>
714                              </t>                              </t>
715    
# Line 602  Schoenebeck'> Line 724  Schoenebeck'>
724    
725                              <t>DEPENDS -                              <t>DEPENDS -
726                                <list>                                <list>
727                                  <t>comma separated list of paramters this parameter depends                                  <t>comma separated list of parameters this parameter depends
728                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',
729                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these
730                                  listed parameters, for example assuming that an audio                                  listed parameters, for example assuming that an audio
731                                  driver (like the Alsa driver) offers parameters 'card'                                  driver (like the ALSA driver) offers parameters 'card'
732                                  and 'samplerate' then parameter 'samplerate' would                                  and 'samplerate' then parameter 'samplerate' would
733                                  depend on 'card' because the possible values for                                  depend on 'card' because the possible values for
734                                  'samplerate' depends on the sound card which can be                                  'samplerate' depends on the sound card which can be
# Line 619  Schoenebeck'> Line 741  Schoenebeck'>
741                                <list>                                <list>
742                                  <t>reflects the default value for this parameter which is                                  <t>reflects the default value for this parameter which is
743                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
744                                  given with the 'CREATE AUDIO_OUTPUT_DEVICE' command,                                  given with the <xref target="CREATE AUDIO_OUTPUT_DEVICE">
745                                    'CREATE AUDIO_OUTPUT_DEVICE'</xref> command,
746                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
747                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
748                                  apostrophes (')                                  apostrophes (')
# Line 647  Schoenebeck'> Line 770  Schoenebeck'>
770                                </list>                                </list>
771                              </t>                              </t>
772    
773                              <t>POSSIBILITES -                              <t>POSSIBILITIES -
774                                <list>                                <list>
775                                  <t>comma separated list of possible values for this                                  <t>comma separated list of possible values for this
776                                  parameter, character strings are encapsulated into                                  parameter, character strings are encapsulated into
# Line 663  Schoenebeck'> Line 786  Schoenebeck'>
786                      <t>Examples:</t>                      <t>Examples:</t>
787                      <t>                      <t>
788                          <list>                          <list>
789                              <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO Alsa card"</t>                              <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"</t>
790                              <t>S: "DESCRIPTION: sound card to be used"</t>                              <t>S: "DESCRIPTION: sound card to be used"</t>
791                              <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>                              <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>
792                              <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>                              <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>
793                              <t>&nbsp;&nbsp;&nbsp;"FIX: true"</t>                              <t>&nbsp;&nbsp;&nbsp;"FIX: true"</t>
794                              <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>                              <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>
795                              <t>&nbsp;&nbsp;&nbsp;"DEFAULT: '0,0'"</t>                              <t>&nbsp;&nbsp;&nbsp;"DEFAULT: '0,0'"</t>
796                              <t>&nbsp;&nbsp;&nbsp;"POSSIBILITES: '0,0','1,0','2,0'"</t>                              <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: '0,0','1,0','2,0'"</t>
797                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
798                          </list>                          </list>
799                      </t>                      </t>
800                      <t>                      <t>
801                          <list>                          <list>
802                              <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO Alsa samplerate"</t>                              <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"</t>
803                              <t>S: "DESCRIPTION: output sample rate in Hz"</t>                              <t>S: "DESCRIPTION: output sample rate in Hz"</t>
804                              <t>&nbsp;&nbsp;&nbsp;"TYPE: INT"</t>                              <t>&nbsp;&nbsp;&nbsp;"TYPE: INT"</t>
805                              <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>                              <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>
# Line 689  Schoenebeck'> Line 812  Schoenebeck'>
812                      </t>                      </t>
813                      <t>                      <t>
814                          <list>                          <list>
815                              <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO Alsa samplerate card='0,0'"</t>                              <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE CARD='0,0'"</t>
816                              <t>S: "DESCRIPTION: output sample rate in Hz"</t>                              <t>S: "DESCRIPTION: output sample rate in Hz"</t>
817                              <t>&nbsp;&nbsp;&nbsp;"TYPE: INT"</t>                              <t>&nbsp;&nbsp;&nbsp;"TYPE: INT"</t>
818                              <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>                              <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>
# Line 704  Schoenebeck'> Line 827  Schoenebeck'>
827                      </t>                      </t>
828                  </section>                  </section>
829    
830                  <section title="Creating an audio output device">                  <section title="Creating an audio output device" anchor="CREATE AUDIO_OUTPUT_DEVICE">
831                      <t>Use the following command to create a new audio output device for  the desired audio output system:</t>                      <t>Use the following command to create a new audio output device for  the desired audio output system:</t>
832    
833                      <t>                      <t>
# Line 714  Schoenebeck'> Line 837  Schoenebeck'>
837                      </t>                      </t>
838    
839                      <t>Where &lt;audio-output-driver&gt; should be replaced by the desired audio                      <t>Where &lt;audio-output-driver&gt; should be replaced by the desired audio
840                      output system and &lt;param-list&gt; by an optional list of driver                      output system as returned by the
841                        <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref>
842                        command and &lt;param-list&gt; by an optional list of driver
843                      specific parameters in form of "key1=val1 key2=val2 ...", where                      specific parameters in form of "key1=val1 key2=val2 ...", where
844                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
845                      Note that there might be drivers which require parameter(s) to be                      Note that there might be drivers which require parameter(s) to be
# Line 750  Schoenebeck'> Line 875  Schoenebeck'>
875                      <t>Examples:</t>                      <t>Examples:</t>
876                      <t>                      <t>
877                          <list>                          <list>
878                              <t>C: "CREATE AUDIO_OUTPUT_DEVICE Alsa"</t>                              <t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"</t>
879                              <t>S: "OK[0]"</t>                              <t>S: "OK[0]"</t>
880                          </list>                          </list>
881                      </t>                      </t>
882                      <t>                      <t>
883                          <list>                          <list>
884                              <t>C: "CREATE AUDIO_OUTPUT_DEVICE Alsa card='2,0' samplerate=96000"</t>                              <t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"</t>
885                              <t>S: "OK[1]"</t>                              <t>S: "OK[1]"</t>
886                          </list>                          </list>
887                      </t>                      </t>
888                  </section>                  </section>
889    
890                  <section title="Destroying an audio output device">                  <section title="Destroying an audio output device" anchor="DESTROY AUDIO_OUTPUT_DEVICE">
891                      <t>Use the following command to destroy a created output device:</t>                      <t>Use the following command to destroy a created output device:</t>
892                      <t>                      <t>
893                          <list>                          <list>
# Line 770  Schoenebeck'> Line 895  Schoenebeck'>
895                          </list>                          </list>
896                      </t>                      </t>
897                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
898                      audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE" or                      audio output device as given by the
899                      "GET AUDIO_OUTPUT_DEVICES" command.</t>                      <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
900                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
901                        command.</t>
902                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
903                      <t>                      <t>
904                          <list>                          <list>
# Line 806  Schoenebeck'> Line 933  Schoenebeck'>
933                      </t>                      </t>
934                  </section>                  </section>
935    
936                  <section title="Getting all created audio output device count">                  <section title="Getting all created audio output device count" anchor="GET AUDIO_OUTPUT_DEVICES">
937                      <t>Use the following command to count all created audio output devices:</t>                      <t>Use the following command to count all created audio output devices:</t>
938                      <t>                      <t>
939                          <list>                          <list>
# Line 829  Schoenebeck'> Line 956  Schoenebeck'>
956                      </t>                      </t>
957                  </section>                  </section>
958    
959                  <section title="Getting all created audio output device list">                  <section title="Getting all created audio output device list" anchor="LIST AUDIO_OUTPUT_DEVICES">
960                      <t>Use the following command to list all created audio output devices:</t>                      <t>Use the following command to list all created audio output devices:</t>
961                      <t>                      <t>
962                          <list>                          <list>
# Line 852  Schoenebeck'> Line 979  Schoenebeck'>
979                      </t>                      </t>
980                  </section>                  </section>
981    
982                  <section title="Getting current settings of an audio output device">                  <section title="Getting current settings of an audio output device" anchor="GET AUDIO_OUTPUT_DEVICE INFO">
983                      <t>Use the following command to get current settings of a specific, created audio output device:</t>                      <t>Use the following command to get current settings of a specific, created audio output device:</t>
984                      <t>                      <t>
985                          <list>                          <list>
986                              <t>GET AUDIO_OUTPUT_DEVICE INFO &lt;device-id&gt;</t>                              <t>GET AUDIO_OUTPUT_DEVICE INFO &lt;device-id&gt;</t>
987                          </list>                          </list>
988                      </t>                      </t>
989                      <t>Where &lt;device-id&gt; should be replaced by be numerical ID                      <t>Where &lt;device-id&gt; should be replaced by numerical ID
990                      of the audio output device as e.g. returned by the                      of the audio output device as e.g. returned by the
991                      "GET AUDIO_OUTPUT_DEVICES" command.</t>                      <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> command.</t>
992                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
993                      <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.                      <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
994                      Each answer line begins with the information category name                      Each answer line begins with the information category name
# Line 872  Schoenebeck'> Line 999  Schoenebeck'>
999                      information categories are defined (independently of device):</t>                      information categories are defined (independently of device):</t>
1000                      <t>                      <t>
1001                          <list>                          <list>
1002                              <t>driver -                              <t>DRIVER -
1003                                  <list>                                  <list>
1004                                      <t>identifier of the used audio output driver, as also                                      <t>identifier of the used audio output driver, as also
1005                                      returned by the "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"                                      returned by the
1006                                        <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
1007                                        "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref>
1008                                      command</t>                                      command</t>
1009                                  </list>                                  </list>
1010                              </t>                              </t>
1011                              <t>channels -                              <t>CHANNELS -
1012                                  <list>                                  <list>
1013                                      <t>amount of audio output channels this device currently                                      <t>amount of audio output channels this device currently
1014                                      offers</t>                                      offers</t>
1015                                  </list>                                  </list>
1016                              </t>                              </t>
1017                              <t>samplerate -                              <t>SAMPLERATE -
1018                                  <list>                                  <list>
1019                                      <t>playback sample rate the device uses</t>                                      <t>playback sample rate the device uses</t>
1020                                  </list>                                  </list>
1021                              </t>                              </t>
1022                              <t>active -                              <t>ACTIVE -
1023                                  <list>                                  <list>
1024                                      <t>either true or false, if false then the audio device is                                      <t>either true or false, if false then the audio device is
1025                                      inactive and doesn't output any sound, nor do the                                      inactive and doesn't output any sound, nor do the
# Line 904  Schoenebeck'> Line 1033  Schoenebeck'>
1033                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
1034                      returned by all audio output devices. Every audio output driver                      returned by all audio output devices. Every audio output driver
1035                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
1036                      "GET AUDIO_OUTPUT_DRIVER INFO" command) which are also returned                      <xref target="GET AUDIO_OUTPUT_DRIVER INFO" />)
1037                      by this command.</t>                      which are also returned by this command.</t>
1038                      <t>Example:</t>                      <t>Example:</t>
1039                      <t>                      <t>
1040                          <list>                          <list>
1041                              <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t>                              <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t>
1042                              <t>S: "driver: Alsa"</t>                              <t>S: "DRIVER: ALSA"</t>
1043                              <t>&nbsp;&nbsp;&nbsp;"channels: 2"</t>                              <t>&nbsp;&nbsp;&nbsp;"CHANNELS: 2"</t>
1044                              <t>&nbsp;&nbsp;&nbsp;"samplerate: 44100"</t>                              <t>&nbsp;&nbsp;&nbsp;"SAMPLERATE: 44100"</t>
1045                              <t>&nbsp;&nbsp;&nbsp;"active: true"</t>                              <t>&nbsp;&nbsp;&nbsp;"ACTIVE: true"</t>
1046                              <t>&nbsp;&nbsp;&nbsp;"fragments: 2"</t>                              <t>&nbsp;&nbsp;&nbsp;"FRAGMENTS: 2"</t>
1047                              <t>&nbsp;&nbsp;&nbsp;"fragmentsize: 128"</t>                              <t>&nbsp;&nbsp;&nbsp;"FRAGMENTSIZE: 128"</t>
1048                              <t>&nbsp;&nbsp;&nbsp;"card: '0,0'"</t>                              <t>&nbsp;&nbsp;&nbsp;"CARD: '0,0'"</t>
1049                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
1050                          </list>                          </list>
1051                      </t>                      </t>
1052                  </section>                  </section>
1053    
1054    
1055                  <section title="Changing settings of audio output devices">                  <section title="Changing settings of audio output devices" anchor="SET AUDIO_OUTPUT_DEVICE_PARAMETER">
1056                      <t>Use the following command to alter a specific setting of a created audio output device:</t>                      <t>Use the following command to alter a specific setting of a created audio output device:</t>
1057                      <t>                      <t>
1058                          <list>                          <list>
# Line 931  Schoenebeck'> Line 1060  Schoenebeck'>
1060                          </list>                          </list>
1061                      </t>                      </t>
1062                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
1063                      audio output device, &lt;key&gt; by the name of the parameter to change                      audio output device as given by the
1064                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1065                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1066                        command, &lt;key&gt; by the name of the parameter to change
1067                      and &lt;value&gt; by the new value for this parameter.</t>                      and &lt;value&gt; by the new value for this parameter.</t>
1068                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1069                      <t>                      <t>
# Line 959  Schoenebeck'> Line 1091  Schoenebeck'>
1091                      <t>Example:</t>                      <t>Example:</t>
1092                      <t>                      <t>
1093                          <list>                          <list>
1094                              <t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 fragmentsize=128"</t>                              <t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"</t>
1095                              <t>S: "OK"</t>                              <t>S: "OK"</t>
1096                          </list>                          </list>
1097                      </t>                      </t>
1098                  </section>                  </section>
1099    
1100                  <section title="Getting information about an audio channel">                  <section title="Getting information about an audio channel" anchor="GET AUDIO_OUTPUT_CHANNEL INFO">
1101                      <t>Use the following command to get information about an audio channel:</t>                      <t>Use the following command to get information about an audio channel:</t>
1102                      <t>                      <t>
1103                          <list>                          <list>
1104                              <t>GET AUDIO_OUTPUT_CHANNEL INFO &lt;device-id&gt; &lt;audio-chan&gt;</t>                              <t>GET AUDIO_OUTPUT_CHANNEL INFO &lt;device-id&gt; &lt;audio-chan&gt;</t>
1105                          </list>                          </list>
1106                      </t>                      </t>
1107                      <t>Where &lt;device-id&gt; is the numerical ID of the audio output device                      <t>Where &lt;device-id&gt; is the numerical ID of the audio output device as given by the
1108                      and &lt;audio-chan&gt; the audio channel number.</t>                      <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1109                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1110                        command and &lt;audio-chan&gt; the audio channel number.</t>
1111                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1112                      <t>                      <t>
1113                          <list>                          <list>
# Line 1003  Schoenebeck'> Line 1137  Schoenebeck'>
1137                                      </t>                                      </t>
1138                                      <t>MIX_CHANNEL_DESTINATION -                                      <t>MIX_CHANNEL_DESTINATION -
1139                                          <list>                                          <list>
1140                                              <t>reflects the real audio channel (of the same audio                                              <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                                              output device) this mix channel refers to, means where
1143                                              the audio signal actually will be routed / added to                                              the audio signal actually will be routed / added to
1144                                              (only returned in case the audio channel is mix channel)</t>                                              (only returned in case the audio channel is mix channel)</t>
# Line 1056  Schoenebeck'> Line 1191  Schoenebeck'>
1191                              <t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"</t>                              <t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"</t>
1192                              <t>S: "NAME: 'ardour (left)'"</t>                              <t>S: "NAME: 'ardour (left)'"</t>
1193                              <t>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: false"</t>                              <t>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: false"</t>
1194                              <t>&nbsp;&nbsp;&nbsp;"jack_bindings: 'ardour:0'"</t>                              <t>&nbsp;&nbsp;&nbsp;"JACK_BINDINGS: 'ardour:0'"</t>
1195                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
1196                          </list>                          </list>
1197                      </t>                      </t>
1198                  </section>                  </section>
1199    
1200                  <section title="Getting information about specific audio channel parameter">                  <section title="Getting information about specific audio channel parameter" anchor="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO">
1201                      <t>Use the following command to get detailed information about specific audio channel parameter:</t>                      <t>Use the following command to get detailed information about specific audio channel parameter:</t>
1202    
1203                      <t>                      <t>
# Line 1071  Schoenebeck'> Line 1206  Schoenebeck'>
1206                          </list>                          </list>
1207                      </t>                      </t>
1208    
1209                      <t>Where &lt;dev-id&gt; is the numerical ID of the audio output device as returned                      <t>Where &lt;dev-id&gt; is the numerical ID of the audio output device as returned by the
1210                      by the "GET AUDIO_OUTPUT_DEVICES" command, &lt;chan&gt; the audio channel number                      <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1211                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1212                        command, &lt;chan&gt; the audio channel number
1213                      and &lt;param&gt; a specific channel parameter name for which information should                      and &lt;param&gt; a specific channel parameter name for which information should
1214                      be obtained (as returned by the "GET AUDIO_OUTPUT_CHANNEL INFO" command).</t>                      be obtained (as returned by the <xref target="GET AUDIO_OUTPUT_CHANNEL INFO">
1215                        "GET AUDIO_OUTPUT_CHANNEL INFO"</xref> command).</t>
1216                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1217    
1218                      <t>                      <t>
# Line 1137  Schoenebeck'> Line 1275  Schoenebeck'>
1275                                              parameter)</t>                                              parameter)</t>
1276                                          </list>                                          </list>
1277                                      </t>                                      </t>
1278                                      <t>POSSIBILITES -                                      <t>POSSIBILITIES -
1279                                          <list>                                          <list>
1280                                              <t>comma separated list of possible values for this                                              <t>comma separated list of possible values for this
1281                                              parameter, character strings are encapsulated into                                              parameter, character strings are encapsulated into
# Line 1154  Schoenebeck'> Line 1292  Schoenebeck'>
1292                      <t>Example:</t>                      <t>Example:</t>
1293                      <t>                      <t>
1294                          <list>                          <list>
1295                              <t>C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 jack_bindings"</t>                              <t>C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"</t>
1296                              <t>S: "DESCRIPTION: bindings to other Jack clients"</t>                              <t>S: "DESCRIPTION: bindings to other JACK clients"</t>
1297                              <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>                              <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>
1298                              <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>                              <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
1299                              <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"</t>                              <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"</t>
1300                              <t>&nbsp;&nbsp;&nbsp;"POSSIBILITES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t>                              <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t>
1301                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
1302                          </list>                          </list>
1303                      </t>                      </t>
1304                  </section>                  </section>
1305    
1306                  <section title="Changing settings of audio output channels">                  <section title="Changing settings of audio output channels" anchor="SET AUDIO_OUTPUT_CHANNEL_PARAMETER">
1307                      <t>Use the following command to alter a specific setting of an audio output channel:</t>                      <t>Use the following command to alter a specific setting of an audio output channel:</t>
1308                      <t>                      <t>
1309                          <list>                          <list>
1310                              <t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER &lt;dev-id&gt; &lt;chn&gt; &lt;key&gt;=&lt;value&gt;</t>                              <t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER &lt;dev-id&gt; &lt;chn&gt; &lt;key&gt;=&lt;value&gt;</t>
1311                          </list>                          </list>
1312                      </t>                      </t>
1313                      <t>Where &lt;dev-id&gt; should be replaced by the numerical ID of the audio                      <t>Where &lt;dev-id&gt; should be replaced by the numerical ID of the audio output device as returned by the
1314                      device, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the                      <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1315                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1316                        command, &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>                      parameter to change and &lt;value&gt; by the new value for this parameter.</t>
1318                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1319                      <t>                      <t>
# Line 1201  Schoenebeck'> Line 1341  Schoenebeck'>
1341                      <t>Example:</t>                      <t>Example:</t>
1342                      <t>                      <t>
1343                          <list>                          <list>
1344                              <t>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 jack_bindings='PCM:0'"</t>                              <t>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:0'"</t>
1345                              <t>S: "OK"</t>                              <t>S: "OK"</t>
1346                          </list>                          </list>
1347                      </t>                      </t>
# Line 1217  Schoenebeck'> Line 1357  Schoenebeck'>
1357              <section title="Configuring MIDI input drivers">              <section title="Configuring MIDI input drivers">
1358                  <t>Instances of drivers in LinuxSampler are called devices. You can use                  <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                  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                  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                  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                  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>                  commands to configure LinuxSampler's MIDI input devices and their parameters.</t>
# Line 1241  Schoenebeck'> Line 1381  Schoenebeck'>
1381                  showing how to retrieve what parameters drivers are offering, how to retrieve their                  showing how to retrieve what parameters drivers are offering, how to retrieve their
1382                  possible values, etc.</t>                  possible values, etc.</t>
1383    
1384                  <section title="Getting all available MIDI input drivers">                  <section title="Getting amount of available MIDI input drivers" anchor="GET AVAILABLE_MIDI_INPUT_DRIVERS">
1385                        <t>Use the following command to get the number of
1386                        MIDI input drivers currently available for the
1387                        LinuxSampler instance:</t>
1388                        <t>
1389                            <list>
1390                                <t>GET AVAILABLE_MIDI_INPUT_DRIVERS</t>
1391                            </list>
1392                        </t>
1393                        <t>Possible Answers:</t>
1394                        <t>
1395                            <list>
1396                                <t>LinuxSampler will answer by sending the
1397                                number of available MIDI input drivers.</t>
1398                            </list>
1399                        </t>
1400                        <t>Example:</t>
1401                        <t>
1402                            <list>
1403                                <t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t>
1404                                <t>S: "2"</t>
1405                            </list>
1406                        </t>
1407                    </section>
1408    
1409                    <section title="Getting all available MIDI input drivers" anchor="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1410                      <t>Use the following command to list all MIDI input drivers currently available                      <t>Use the following command to list all MIDI input drivers currently available
1411                      for the LinuxSampler instance:</t>                      for the LinuxSampler instance:</t>
1412                      <t>                      <t>
1413                          <list>                          <list>
1414                              <t>GET AVAILABLE_MIDI_INPUT_DRIVERS</t>                              <t>LIST AVAILABLE_MIDI_INPUT_DRIVERS</t>
1415                          </list>                          </list>
1416                      </t>                      </t>
1417                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 1259  Schoenebeck'> Line 1424  Schoenebeck'>
1424                      <t>Example:</t>                      <t>Example:</t>
1425                      <t>                      <t>
1426                          <list>                          <list>
1427                              <t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t>                              <t>C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</t>
1428                              <t>S: "Alsa,Jack"</t>                              <t>S: "ALSA,JACK"</t>
1429                          </list>                          </list>
1430                      </t>                      </t>
1431                  </section>                  </section>
1432    
1433                  <section title="Getting information about a specific MIDI input driver">                  <section title="Getting information about a specific MIDI input driver" anchor="GET MIDI_INPUT_DRIVER INFO">
1434                      <t>Use the following command to get detailed information about a specific MIDI input driver:</t>                      <t>Use the following command to get detailed information about a specific MIDI input driver:</t>
1435                      <t>                      <t>
1436                          <list>                          <list>
1437                              <t>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;</t>                              <t>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;</t>
1438                          </list>                          </list>
1439                      </t>                      </t>
1440                      <t>Where &lt;midi-input-driver&gt; is the name of the MIDI input driver.</t>                      <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>                      <t>Possible Answers:</t>
1444                      <t>                      <t>
1445                          <list>                          <list>
# Line 1310  Schoenebeck'> Line 1477  Schoenebeck'>
1477    
1478                      <t>                      <t>
1479                          <list>                          <list>
1480                              <t>C: "GET MIDI_INPUT_DRIVER INFO Alsa"</t>                              <t>C: "GET MIDI_INPUT_DRIVER INFO ALSA"</t>
1481                              <t>S: "DESCRIPTION: Advanced Linux Sound Architecture"</t>                              <t>S: "DESCRIPTION: Advanced Linux Sound Architecture"</t>
1482                              <t>&nbsp;&nbsp;&nbsp;"VERSION: 1.0"</t>                              <t>&nbsp;&nbsp;&nbsp;"VERSION: 1.0"</t>
1483                              <t>&nbsp;&nbsp;&nbsp;"PARAMETERS: driver,active"</t>                              <t>&nbsp;&nbsp;&nbsp;"PARAMETERS: DRIVER,ACTIVE"</t>
1484                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
1485                          </list>                          </list>
1486                      </t>                      </t>
1487                  </section>                  </section>
1488    
1489                  <section title="Getting information about specific MIDI input driver parameter">                  <section title="Getting information about specific MIDI input driver parameter" anchor="GET MIDI_INPUT_DRIVER_PARAMETER INFO">
1490                      <t>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:</t>                      <t>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:</t>
1491                      <t>                      <t>
1492                          <list>                          <list>
# Line 1327  Schoenebeck'> Line 1494  Schoenebeck'>
1494                          </list>                          </list>
1495                      </t>                      </t>
1496    
1497                      <t>Where &lt;midi-t&gt; is the name of the MIDI input driver as returned                      <t>Where &lt;midit&gt; is the name of the MIDI input driver as returned
1498                      by the "GET AVAILABLE_MIDI_INPUT_DRIVERS" command, &lt;param&gt; a specific                      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                      parameter name for which information should be obtained (as returned by the
1501                      "GET MIDI_INPUT_DRIVER INFO" command) and &lt;deplist&gt; is an optional list                      <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,                      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 ...",                      &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                      where character string values are encapsulated into apostrophes ('). Arguments
# Line 1371  Schoenebeck'> Line 1540  Schoenebeck'>
1540                                <list>                                <list>
1541                                  <t>either true or false, defines if this parameter must be                                  <t>either true or false, defines if this parameter must be
1542                                  given when the device is to be created with the                                  given when the device is to be created with the
1543                                  'CREATE MIDI_INPUT_DEVICE' command                                  <xref target="CREATE MIDI_INPUT_DEVICE">
1544                                    'CREATE MIDI_INPUT_DEVICE'</xref> command
1545                                  (always returned, no matter which driver parameter)</t>                                  (always returned, no matter which driver parameter)</t>
1546                                </list>                                </list>
1547                              </t>                              </t>
# Line 1380  Schoenebeck'> Line 1550  Schoenebeck'>
1550                                <list>                                <list>
1551                                  <t>either true or false, if false then this parameter can                                  <t>either true or false, if false then this parameter can
1552                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
1553                                  the 'CREATE MIDI_INPUT_DEVICE' command                                  the <xref target="CREATE MIDI_INPUT_DEVICE">
1554                                    'CREATE MIDI_INPUT_DEVICE'</xref> command
1555                                  (always returned, no matter which driver parameter)</t>                                  (always returned, no matter which driver parameter)</t>
1556                                </list>                                </list>
1557                              </t>                              </t>
# Line 1396  Schoenebeck'> Line 1567  Schoenebeck'>
1567    
1568                              <t>DEPENDS -                              <t>DEPENDS -
1569                                <list>                                <list>
1570                                  <t>comma separated list of paramters this parameter depends                                  <t>comma separated list of parameters this parameter depends
1571                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',
1572                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these
1573                                  listed parameters, for example assuming that an audio                                  listed parameters, for example assuming that an audio
1574                                  driver (like the Alsa driver) offers parameters 'card'                                  driver (like the ALSA driver) offers parameters 'card'
1575                                  and 'samplerate' then parameter 'samplerate' would                                  and 'samplerate' then parameter 'samplerate' would
1576                                  depend on 'card' because the possible values for                                  depend on 'card' because the possible values for
1577                                  'samplerate' depends on the sound card which can be                                  'samplerate' depends on the sound card which can be
# Line 1413  Schoenebeck'> Line 1584  Schoenebeck'>
1584                                <list>                                <list>
1585                                  <t>reflects the default value for this parameter which is                                  <t>reflects the default value for this parameter which is
1586                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
1587                                  given with the 'CREATE MIDI_INPUT_DEVICE' command,                                  given with the <xref target="CREATE MIDI_INPUT_DEVICE">
1588                                    'CREATE MIDI_INPUT_DEVICE'</xref> command,
1589                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
1590                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
1591                                  apostrophes (')                                  apostrophes (')
# Line 1441  Schoenebeck'> Line 1613  Schoenebeck'>
1613                                </list>                                </list>
1614                              </t>                              </t>
1615    
1616                              <t>POSSIBILITES -                              <t>POSSIBILITIES -
1617                                <list>                                <list>
1618                                  <t>comma separated list of possible values for this                                  <t>comma separated list of possible values for this
1619                                  parameter, character strings are encapsulated into                                  parameter, character strings are encapsulated into
# Line 1457  Schoenebeck'> Line 1629  Schoenebeck'>
1629                      <t>Example:</t>                      <t>Example:</t>
1630                      <t>                      <t>
1631                          <list>                          <list>
1632                              <t>C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO Alsa active"</t>                              <t>C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"</t>
1633                              <t>S: "DESCRIPTION: Whether device is enabled"</t>                              <t>S: "DESCRIPTION: Whether device is enabled"</t>
1634                              <t>&nbsp;&nbsp;&nbsp;"TYPE: BOOL"</t>                              <t>&nbsp;&nbsp;&nbsp;"TYPE: BOOL"</t>
1635                              <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>                              <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>
# Line 1469  Schoenebeck'> Line 1641  Schoenebeck'>
1641                      </t>                      </t>
1642                  </section>                  </section>
1643    
1644                  <section title="Creating a MIDI input device">                  <section title="Creating a MIDI input device" anchor="CREATE MIDI_INPUT_DEVICE">
1645                      <t>Use the following command to create a new MIDI input device for  the desired MIDI input system:</t>                      <t>Use the following command to create a new MIDI input device for  the desired MIDI input system:</t>
1646                      <t>                      <t>
1647                          <list>                          <list>
# Line 1477  Schoenebeck'> Line 1649  Schoenebeck'>
1649                          </list>                          </list>
1650                      </t>                      </t>
1651    
1652                      <t>Where &lt;midi-input-driver&gt; should be replaced by the desired MIDI input system and &lt;param-list&gt; by an                      <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                      optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where
1656                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
1657                      Note that there might be drivers which require parameter(s) to be                      Note that there might be drivers which require parameter(s) to be
# Line 1511  Schoenebeck'> Line 1685  Schoenebeck'>
1685                      <t>Example:</t>                      <t>Example:</t>
1686                      <t>                      <t>
1687                          <list>                          <list>
1688                              <t>C: "CREATE MIDI_INPUT_DEVICE Alsa"</t>                              <t>C: "CREATE MIDI_INPUT_DEVICE ALSA"</t>
1689                              <t>S: "OK[0]"</t>                              <t>S: "OK[0]"</t>
1690                          </list>                          </list>
1691                      </t>                      </t>
1692                  </section>                  </section>
1693    
1694                  <section title="Destroying a MIDI input device">                  <section title="Destroying a MIDI input device" anchor="DESTROY MIDI_INPUT_DEVICE">
1695                      <t>Use the following command to destroy a created MIDI input device:</t>                      <t>Use the following command to destroy a created MIDI input device:</t>
1696                      <t>                      <t>
1697                          <list>                          <list>
1698                              <t>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;</t>                              <t>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;</t>
1699                          </list>                          </list>
1700                      </t>                      </t>
1701                      <t>Where &lt;device-id&gt; should be replaced by the device's numerical ID.</t>                      <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>                      <t>Possible Answers:</t>
1706                      <t>                      <t>
1707                          <list>                          <list>
# Line 1556  Schoenebeck'> Line 1733  Schoenebeck'>
1733                      </t>                      </t>
1734                  </section>                  </section>
1735    
1736                  <section title="Getting all created MIDI input device count">                  <section title="Getting all created MIDI input device count" anchor="GET MIDI_INPUT_DEVICES">
1737                      <t>Use the following command to count all created MIDI input devices:</t>                      <t>Use the following command to count all created MIDI input devices:</t>
1738                      <t>                      <t>
1739                          <list>                          <list>
# Line 1580  Schoenebeck'> Line 1757  Schoenebeck'>
1757                  </section>                  </section>
1758    
1759    
1760                  <section title="Getting all created MIDI input device list">                  <section title="Getting all created MIDI input device list" anchor="LIST MIDI_INPUT_DEVICES">
1761                      <t>Use the following command to list all created MIDI input devices:</t>                      <t>Use the following command to list all created MIDI input devices:</t>
1762                      <t>                      <t>
1763                          <list>                          <list>
# Line 1609  Schoenebeck'> Line 1786  Schoenebeck'>
1786                      </t>                      </t>
1787                  </section>                  </section>
1788    
1789                  <section title="Getting current settings of a MIDI input device">                  <section title="Getting current settings of a MIDI input device" anchor="GET MIDI_INPUT_DEVICE INFO">
1790                      <t>Use the following command to get current settings of a specific, created MIDI input device:</t>                      <t>Use the following command to get current settings of a specific, created MIDI input device:</t>
1791                      <t>                      <t>
1792                          <list>                          <list>
1793                              <t>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;</t>                              <t>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;</t>
1794                          </list>                          </list>
1795                      </t>                      </t>
1796                      <t>Where &lt;device-id&gt; is the numerical ID of the MIDI input device.</t>                      <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>                      <t>Possible Answers:</t>
1801                      <t>                      <t>
1802                          <list>                          <list>
# Line 1633  Schoenebeck'> Line 1813  Schoenebeck'>
1813                                      <t>DRIVER -                                      <t>DRIVER -
1814                                          <list>                                          <list>
1815                                              <t>identifier of the used MIDI input driver, as e.g.                                              <t>identifier of the used MIDI input driver, as e.g.
1816                                              returned by the "GET AVAILABLE_MIDI_INPUT_DRIVERS"                                              returned by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1817                                                "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref>
1818                                              command</t>                                              command</t>
1819                                          </list>                                          </list>
1820                                      </t>                                      </t>
# Line 1656  Schoenebeck'> Line 1837  Schoenebeck'>
1837                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
1838                      returned by all MIDI input devices. Every MIDI input driver                      returned by all MIDI input devices. Every MIDI input driver
1839                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
1840                      "GET MIDI_INPUT_DRIVER INFO" command) which are also returned                      <xref target="GET MIDI_INPUT_DRIVER INFO">
1841                        "GET MIDI_INPUT_DRIVER INFO"</xref> command) which are also returned
1842                      by this command.</t>                      by this command.</t>
1843    
1844                      <t>Example:</t>                      <t>Example:</t>
1845                      <t>                      <t>
1846                          <list>                          <list>
1847                              <t>C: "GET MIDI_INPUT_DEVICE INFO 0"</t>                              <t>C: "GET MIDI_INPUT_DEVICE INFO 0"</t>
1848                              <t>S: "driver: Alsa"</t>                              <t>S: "DRIVER: ALSA"</t>
1849                              <t>&nbsp;&nbsp;&nbsp;"active: true"</t>                              <t>&nbsp;&nbsp;&nbsp;"ACTIVE: true"</t>
1850                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
1851                          </list>                          </list>
1852                      </t>                      </t>
1853                  </section>                  </section>
1854    
1855                  <section title="Changing settings of audio output devices">                  <section title="Changing settings of MIDI input devices" anchor="SET MIDI_INPUT_DEVICE_PARAMETER">
1856                      <t>Use the following command to alter a specific setting of a created MIDI input device:</t>                      <t>Use the following command to alter a specific setting of a created MIDI input device:</t>
1857                      <t>                      <t>
1858                          <list>                          <list>
# Line 1679  Schoenebeck'> Line 1861  Schoenebeck'>
1861                      </t>                      </t>
1862    
1863                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
1864                      MIDI input device, &lt;key&gt; by the name of the parameter to change and                      MIDI input device as returned by the
1865                        <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1866                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1867                        command, &lt;key&gt; by the name of the parameter to change and
1868                      &lt;value&gt; by the new value for this parameter.</t>                      &lt;value&gt; by the new value for this parameter.</t>
1869    
1870                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 1707  Schoenebeck'> Line 1892  Schoenebeck'>
1892                      <t>Example:</t>                      <t>Example:</t>
1893                      <t>                      <t>
1894                          <list>                          <list>
1895                              <t>C: "SET MIDI_INPUT_DEVICE PARAMETER 0 ACTIVE=false"</t>                              <t>C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"</t>
1896                              <t>S: "OK"</t>                              <t>S: "OK"</t>
1897                          </list>                          </list>
1898                      </t>                      </t>
1899                  </section>                  </section>
1900    
1901                  <section title="Getting information about a MIDI port">                  <section title="Getting information about a MIDI port" anchor="GET MIDI_INPUT_PORT INFO">
1902                      <t>Use the following command to get information about a MIDI port:</t>                      <t>Use the following command to get information about a MIDI port:</t>
1903                      <t>                      <t>
1904                          <list>                          <list>
1905                              <t>GET MIDI_INPUT_PORT INFO &lt;device-id&gt; &lt;midi-port&gt;</t>                              <t>GET MIDI_INPUT_PORT INFO &lt;device-id&gt; &lt;midi-port&gt;</t>
1906                          </list>                          </list>
1907                      </t>                      </t>
1908                      <t>Where &lt;device-id&gt; is the numerical ID of the MIDI input device                      <t>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
1909                      and &lt;midi-port&gt; the MIDI input port number.</t>                      <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1910                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1911                        command and &lt;midi-port&gt; the MIDI input port number.</t>
1912                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1913                      <t>                      <t>
1914                          <list>                          <list>
# Line 1748  Schoenebeck'> Line 1935  Schoenebeck'>
1935                      <t>                      <t>
1936                          <list>                          <list>
1937                              <t>C: "GET MIDI_INPUT_PORT INFO 0 0"</t>                              <t>C: "GET MIDI_INPUT_PORT INFO 0 0"</t>
1938                              <t>S: "name: 'Masterkeyboard'"</t>                              <t>S: "NAME: 'Masterkeyboard'"</t>
1939                              <t>&nbsp;&nbsp;&nbsp;"alsa_seq_bindings: '64:0'"</t>                              <t>&nbsp;&nbsp;&nbsp;"ALSA_SEQ_BINDINGS: '64:0'"</t>
1940                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
1941                          </list>                          </list>
1942                      </t>                      </t>
1943                  </section>                  </section>
1944    
1945                  <section title="Getting information about specific MIDI port parameter">                  <section title="Getting information about specific MIDI port parameter" anchor="GET MIDI_INPUT_PORT_PARAMETER INFO">
1946                      <t>Use the following command to get detailed information about specific MIDI port parameter:</t>                      <t>Use the following command to get detailed information about specific MIDI port parameter:</t>
1947                      <t>                      <t>
1948                          <list>                          <list>
# Line 1763  Schoenebeck'> Line 1950  Schoenebeck'>
1950                          </list>                          </list>
1951                      </t>                      </t>
1952    
1953                      <t>Where &lt;dev-id&gt; is the numerical ID of the MIDI input device as returned                      <t>Where &lt;dev-id&gt; is the numerical ID of the MIDI input device as returned by the
1954                      by the "GET MIDI_INPUT_DEVICES" command, &lt;port&gt; the MIDI port number and                      <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1955                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1956                        command, &lt;port&gt; the MIDI port number and
1957                      &lt;param&gt; a specific port parameter name for which information should be                      &lt;param&gt; a specific port parameter name for which information should be
1958                      obtained (as returned by the "GET MIDI_INPUT_PORT INFO" command).</t>                      obtained (as returned by the <xref target="GET MIDI_INPUT_PORT INFO">
1959                        "GET MIDI_INPUT_PORT INFO"</xref> command).</t>
1960    
1961                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1962                      <t>                      <t>
# Line 1829  Schoenebeck'> Line 2019  Schoenebeck'>
2019                                      parameter)</t>                                      parameter)</t>
2020                                  </list>                                  </list>
2021                              </t>                              </t>
2022                              <t>POSSIBILITES -                              <t>POSSIBILITIES -
2023                                  <list>                                  <list>
2024                                      <t>comma separated list of possible values for this                                      <t>comma separated list of possible values for this
2025                                      parameter, character strings are encapsulated into                                      parameter, character strings are encapsulated into
# Line 1846  Schoenebeck'> Line 2036  Schoenebeck'>
2036                      <t>Example:</t>                      <t>Example:</t>
2037                      <t>                      <t>
2038                          <list>                          <list>
2039                              <t>C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 alsa_seq_bindings"</t>                              <t>C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"</t>
2040                              <t>S: "DESCRIPTION: bindings to other Alsa sequencer clients"</t>                              <t>S: "DESCRIPTION: bindings to other ALSA sequencer clients"</t>
2041                              <t>"TYPE: STRING"</t>                              <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>
2042                              <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>                              <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
2043                              <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"</t>                              <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"</t>
2044                              <t>&nbsp;&nbsp;&nbsp;"POSSIBILITES: '64:0','68:0','68:1'"</t>                              <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: '64:0','68:0','68:1'"</t>
2045                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
2046                          </list>                          </list>
2047                      </t>                      </t>
2048                  </section>                  </section>
2049    
2050                  <section title="Changing settings of MIDI input ports">                  <section title="Changing settings of MIDI input ports" anchor="SET MIDI_INPUT_PORT_PARAMETER">
2051                      <t>Use the following command to alter a specific setting of a MIDI input port:</t>                      <t>Use the following command to alter a specific setting of a MIDI input port:</t>
2052                      <t>                      <t>
2053                          <list>                          <list>
2054                              <t>SET MIDI_INPUT_PORT PARAMETER &lt;device-id&gt; &lt;port&gt; &lt;key&gt;=&lt;value&gt;</t>                              <t>SET MIDI_INPUT_PORT_PARAMETER &lt;device-id&gt; &lt;port&gt; &lt;key&gt;=&lt;value&gt;</t>
2055                          </list>                          </list>
2056                      </t>                      </t>
2057    
2058                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
2059                      MIDI device, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of                      MIDI device as returned by the
2060                        <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
2061                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
2062                        command, &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                      the parameter to change and &lt;value&gt; by the new value for this
2064                      parameter.</t>                      parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes)
2065                        for specifying no value for parameters allowing a list of values.</t>
2066    
2067                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2068                      <t>                      <t>
# Line 1895  Schoenebeck'> Line 2089  Schoenebeck'>
2089                      <t>Example:</t>                      <t>Example:</t>
2090                      <t>                      <t>
2091                          <list>                          <list>
2092                              <t></t>                              <t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"</t>
2093                                <t>S: "OK"</t>
2094                            </list>
2095                        </t>
2096                        <t>
2097                            <list>
2098                                <t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"</t>
2099                                <t>S: "OK"</t>
2100                          </list>                          </list>
2101                      </t>                      </t>
2102                  </section>                  </section>
2103              </section>              </section>
2104    
2105              <section title="Configuring sampler channels">              <section title="Configuring sampler channels">
2106                  <t>The following commands describe how to add and remove sampler channels, deploy                  <t>The following commands describe how to add and remove sampler channels, associate a
2107                  sampler engines, load instruments and connect sampler channels to MIDI and audio devices.</t>                  sampler channel with a sampler engine, load instruments and connect sampler channels to
2108                    MIDI and audio devices.</t>
2109    
2110                  <section title="Loading an instrument">                  <section title="Loading an instrument" anchor="LOAD INSTRUMENT">
2111                      <t>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:</t>                      <t>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:</t>
2112                      <t>                      <t>
2113                          <list>                          <list>
# Line 1919  Schoenebeck'> Line 2121  Schoenebeck'>
2121                      number of the sampler channel the instrument should be assigned to.                      number of the sampler channel the instrument should be assigned to.
2122                      Each sampler channel can only have one instrument.</t>                      Each sampler channel can only have one instrument.</t>
2123    
2124                        <t>Notice: since LSCP 1.2 the &lt;filename&gt; argument supports
2125                        escape characters for special characters (see chapter
2126                        "<xref target="character_set">Character Set and Escape Sequences</xref>"
2127                        for details) and accordingly backslash characters in the filename
2128                        MUST now be escaped as well!</t>
2129    
2130                      <t>The difference between regular and NON_MODAL versions of the command                      <t>The difference between regular and NON_MODAL versions of the command
2131                      is that the regular command returns OK only after the instrument has been                      is that the regular command returns OK only after the instrument has been
2132                      fully loaded and the channel is ready to be used while NON_MODAL version                      fully loaded and the channel is ready to be used while NON_MODAL version
2133                      returns immediately and a background process is launched to load the instrument                      returns immediately and a background process is launched to load the instrument
2134                      on the channel. GET CHANNEL INFO command can be used to obtain loading                      on the channel. The <xref target="GET CHANNEL INFO">GET CHANNEL INFO</xref>
2135                        command can be used to obtain loading
2136                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks
2137                      such as making sure that the file could be read and it is of a proper format                      such as making sure that the file could be read and it is of a proper format
2138                      and SHOULD return ERR and SHOULD not launch the background process should any                      and SHOULD return ERR and SHOULD not launch the background process should any
# Line 1953  Schoenebeck'> Line 2162  Schoenebeck'>
2162                              </t>                              </t>
2163                          </list>                          </list>
2164                      </t>                      </t>
2165                      <t>Example:</t>                      <t>Example (Unix):</t>
2166                      <t>                      <t>
2167                          <list>                          <list>
2168                              <t></t>                              <t>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0</t>
2169                                <t>S: OK</t>
2170                            </list>
2171                        </t>
2172                        <t>Example (Windows):</t>
2173                        <t>
2174                            <list>
2175                                <t>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0</t>
2176                                <t>S: OK</t>
2177                          </list>                          </list>
2178                      </t>                      </t>
2179                  </section>                  </section>
2180    
2181                  <section title="Loading a sampler engine">                  <section title="Loading a sampler engine" anchor="LOAD ENGINE">
2182                      <t>A sample engine can be deployed and assigned to a specific sampler                      <t>A sampler engine type can be associated to a specific sampler
2183                      channel by the following command:</t>                      channel by the following command:</t>
2184                      <t>                      <t>
2185                          <list>                          <list>
# Line 1970  Schoenebeck'> Line 2187  Schoenebeck'>
2187                          </list>                          </list>
2188                      </t>                      </t>
2189    
2190                      <t>Where &lt;engine-name&gt; is usually the C++ class name of the engine                      <t>Where &lt;engine-name&gt; is an engine name as obtained by the
2191                      implementation and &lt;sampler-channel&gt; the sampler channel the                      <xref target="LIST AVAILABLE_ENGINES">
2192                      deployed engine should be assigned to. Even if the respective                      "LIST AVAILABLE_ENGINES"</xref> command and &lt;sampler-channel&gt;
2193                      sampler channel has already a deployed engine with that engine                      the sampler channel as returned by the
2194                      name, a new engine instance will be assigned to the sampler channel.</t>                      <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> or
2195                        <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command where
2196                        the engine type should be assigned to. This command should be issued
2197                        after adding a new sampler channel and before any other control
2198                        commands on the new sampler channel. It can also be used to change
2199                        the engine type of a sampler channel. This command has (currently) no
2200                        way to define or force if a new engine instance should be created and
2201                        assigned to the given sampler channel or if an already existing
2202                        instance of that engine type, shared with other sampler channels,
2203                        should be used.</t>
2204    
2205                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2206                      <t>                      <t>
# Line 2007  Schoenebeck'> Line 2233  Schoenebeck'>
2233                      </t>                      </t>
2234                  </section>                  </section>
2235    
2236                  <section title="Getting all created sampler channel count">                  <section title="Getting all created sampler channel count" anchor="GET CHANNELS">
2237                      <t>The number of sampler channels can change on runtime. To get the                      <t>The number of sampler channels can change on runtime. To get the
2238                      current amount of sampler channels, the front-end can send the                      current amount of sampler channels, the front-end can send the
2239                      following command:</t>                      following command:</t>
# Line 2031  Schoenebeck'> Line 2257  Schoenebeck'>
2257                      </t>                      </t>
2258                  </section>                  </section>
2259    
2260                  <section title="Getting all created sampler channel list">                  <section title="Getting all created sampler channel list" anchor="LIST CHANNELS">
2261                      <t>The number of sampler channels can change on runtime. To get the                      <t>The number of sampler channels can change on runtime. To get the
2262                      current list of sampler channels, the front-end can send the                      current list of sampler channels, the front-end can send the
2263                      following command:</t>                      following command:</t>
# Line 2056  Schoenebeck'> Line 2282  Schoenebeck'>
2282                      </t>                      </t>
2283                  </section>                  </section>
2284    
2285                  <section title="Adding a new sampler channel">                  <section title="Adding a new sampler channel" anchor="ADD CHANNEL">
2286                      <t>A new sampler channel can be added to the end of the sampler                      <t>A new sampler channel can be added to the end of the sampler
2287                      channel list by sending the following command:</t>                      channel list by sending the following command:</t>
2288                      <t>                      <t>
# Line 2080  Schoenebeck'> Line 2306  Schoenebeck'>
2306                                  <list>                                  <list>
2307                                      <t>in case a new sampler channel could be added, where                                      <t>in case a new sampler channel could be added, where
2308                                      &lt;sampler-channel&gt; reflects the channel number of the new                                      &lt;sampler-channel&gt; reflects the channel number of the new
2309                                      created sampler channel which should the be used to set up                                      created sampler channel which should be used to set up
2310                                      the sampler channel by sending subsequent intialization                                      the sampler channel by sending subsequent initialization
2311                                      commands</t>                                      commands</t>
2312                                  </list>                                  </list>
2313                              </t>                              </t>
# Line 2108  Schoenebeck'> Line 2334  Schoenebeck'>
2334                      </t>                      </t>
2335                  </section>                  </section>
2336    
2337                  <section title="Removing a sampler channel">                  <section title="Removing a sampler channel" anchor="REMOVE CHANNEL">
2338                      <t>A sampler channel can be removed by sending the following command:</t>                      <t>A sampler channel can be removed by sending the following command:</t>
2339                      <t>                      <t>
2340                          <list>                          <list>
# Line 2116  Schoenebeck'> Line 2342  Schoenebeck'>
2342                          </list>                          </list>
2343                      </t>                      </t>
2344    
2345                      <t>This will decrement the sampler channel count by one and also                      <t>Where &lt;sampler-channel&gt; should be replaced by the
2346                      decrement the channel numbers of all subsequent sampler channels by                      number of the sampler channel as given by the
2347                      one.</t>                      <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2348                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref>
2349                        command. The channel numbers of all subsequent sampler channels
2350                        remain the same.</t>
2351    
2352                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2353                      <t>                      <t>
# Line 2151  Schoenebeck'> Line 2380  Schoenebeck'>
2380                      </t>                      </t>
2381                  </section>                  </section>
2382    
2383                  <section title="Getting all available engines">                  <section title="Getting amount of available engines" anchor="GET AVAILABLE_ENGINES">
2384                      <t>The front-end can ask for all available engines by sending the following command:</t>                      <t>The front-end can ask for the number of available engines by sending the following command:</t>
2385                      <t>                      <t>
2386                          <list>                          <list>
2387                              <t>GET AVAILABLE_ENGINES</t>                              <t>GET AVAILABLE_ENGINES</t>
# Line 2161  Schoenebeck'> Line 2390  Schoenebeck'>
2390                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2391                      <t>                      <t>
2392                          <list>                          <list>
2393                              <t>LinuxSampler will answer by sending a comma separated character                              <t>LinuxSampler will answer by sending the number of available engines.</t>
                             string of the engines' C++ class names.</t>  
2394                          </list>                          </list>
2395                      </t>                      </t>
2396                      <t>Example:</t>                      <t>Example:</t>
2397                      <t>                      <t>
2398                          <list>                          <list>
2399                              <t>C: "GET AVAILABLE_ENGINES"</t>                              <t>C: "GET AVAILABLE_ENGINES"</t>
2400                              <t>S: "GigEngine,AkaiEngine,DLSEngine,JoesCustomEngine"</t>                              <t>S: "4"</t>
2401                          </list>                          </list>
2402                      </t>                      </t>
2403                  </section>                  </section>
2404    
2405                  <section title="Getting information about an engine">                  <section title="Getting all available engines" anchor="LIST AVAILABLE_ENGINES">
2406                        <t>The front-end can ask for a list of all available engines by sending the following command:</t>
2407                        <t>
2408                            <list>
2409                                <t>LIST AVAILABLE_ENGINES</t>
2410                            </list>
2411                        </t>
2412                        <t>Possible Answers:</t>
2413                        <t>
2414                            <list>
2415                                <t>LinuxSampler will answer by sending a comma separated list
2416                                of the engines' names encapsulated into apostrophes (').
2417                                Engine names can consist of lower and upper cases,
2418                                digits and underlines ("_" character).</t>
2419                            </list>
2420                        </t>
2421                        <t>Example:</t>
2422                        <t>
2423                            <list>
2424                                <t>C: "LIST AVAILABLE_ENGINES"</t>
2425                                <t>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"</t>
2426                            </list>
2427                        </t>
2428                    </section>
2429    
2430                    <section title="Getting information about an engine" anchor="GET ENGINE INFO">
2431                      <t>The front-end can ask for information about a specific engine by                      <t>The front-end can ask for information about a specific engine by
2432                      sending the following command:</t>                      sending the following command:</t>
2433                      <t>                      <t>
# Line 2182  Schoenebeck'> Line 2435  Schoenebeck'>
2435                              <t>GET ENGINE INFO &lt;engine-name&gt;</t>                              <t>GET ENGINE INFO &lt;engine-name&gt;</t>
2436                          </list>                          </list>
2437                      </t>                      </t>
2438                      <t>Where &lt;engine-name&gt; is usually the C++ class name of the engine implementation.</t>                      <t>Where &lt;engine-name&gt; is an engine name as obtained by the
2439                        <xref target="LIST AVAILABLE_ENGINES">
2440                        "LIST AVAILABLE_ENGINES"</xref> command.</t>
2441                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2442                      <t>                      <t>
2443                          <list>                          <list>
2444                              <t>LinuxSampler will answer by sending &lt;&gt; separated list.                              <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
2445                              Each answer line begins with the information category name                              Each answer line begins with the information category name
2446                              followed by a colon and then a space character &lt;SP&gt; and finally                              followed by a colon and then a space character &lt;SP&gt; and finally
2447                              the info character string to that info category. At the moment                              the info character string to that info category. At the moment
# Line 2196  Schoenebeck'> Line 2451  Schoenebeck'>
2451                                  <list>                                  <list>
2452                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
2453                                          <list>                                          <list>
2454                                              <t>arbitrary description text about the engine</t>                                              <t>arbitrary description text about the engine
2455                                                (note that the character string may contain
2456                                                <xref target="character_set">escape sequences</xref>)</t>
2457                                          </list>                                          </list>
2458                                      </t>                                      </t>
2459                                       <t>VERSION -                                       <t>VERSION -
# Line 2222  Schoenebeck'> Line 2479  Schoenebeck'>
2479                      </t>                      </t>
2480                  </section>                  </section>
2481    
2482                  <section title="Getting sampler channel information">                  <section title="Getting sampler channel information" anchor="GET CHANNEL INFO">
2483                      <t>The front-end can ask for the current settings of a sampler channel                      <t>The front-end can ask for the current settings of a sampler channel
2484                      by sending the following command:</t>                      by sending the following command:</t>
2485                      <t>                      <t>
# Line 2230  Schoenebeck'> Line 2487  Schoenebeck'>
2487                              <t>GET CHANNEL INFO &lt;sampler-channel&gt;</t>                              <t>GET CHANNEL INFO &lt;sampler-channel&gt;</t>
2488                          </list>                          </list>
2489                      </t>                      </t>
2490                      <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in.</t>                      <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
2491                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2492                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2493                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2494                      <t>                      <t>
2495                          <list>                          <list>
# Line 2244  Schoenebeck'> Line 2503  Schoenebeck'>
2503                                  <list>                                  <list>
2504                                      <t>ENGINE_NAME -                                      <t>ENGINE_NAME -
2505                                          <list>                                          <list>
2506                                              <t>name of the engine that is deployed on the sampler                                              <t>name of the engine that is associated with the sampler
2507                                              channel, "NONE" if there's no engine deployed yet for                                              channel, "NONE" if there's no engine associated yet for
2508                                              this sampler channel</t>                                              this sampler channel</t>
2509                                          </list>                                          </list>
2510                                      </t>                                      </t>
# Line 2278  Schoenebeck'> Line 2537  Schoenebeck'>
2537                                          <list>                                          <list>
2538                                              <t>the file name of the loaded instrument, "NONE" if                                              <t>the file name of the loaded instrument, "NONE" if
2539                                              there's no instrument yet loaded for this sampler                                              there's no instrument yet loaded for this sampler
2540                                              channel</t>                                              channel (note: since LSCP 1.2 this path may contain
2541                                                <xref target="character_set">escape sequences</xref>)</t>
2542                                          </list>                                          </list>
2543                                      </t>                                      </t>
2544                                      <t>INSTRUMENT_NR -                                      <t>INSTRUMENT_NR -
# Line 2286  Schoenebeck'> Line 2546  Schoenebeck'>
2546                                              <t>the instrument index number of the loaded instrument</t>                                              <t>the instrument index number of the loaded instrument</t>
2547                                          </list>                                          </list>
2548                                      </t>                                      </t>
2549                                        <t>INSTRUMENT_NAME -
2550                                            <list>
2551                                                <t>the instrument name of the loaded instrument
2552                                                (note: since LSCP 1.2 this character string may contain
2553                                                <xref target="character_set">escape sequences</xref>)</t>
2554                                            </list>
2555                                        </t>
2556                                      <t>INSTRUMENT_STATUS -                                      <t>INSTRUMENT_STATUS -
2557                                          <list>                                          <list>
2558                                              <t>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative                                              <t>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative
# Line 2315  Schoenebeck'> Line 2582  Schoenebeck'>
2582                                      <t>VOLUME -                                      <t>VOLUME -
2583                                          <list>                                          <list>
2584                                              <t>optionally dotted number for the channel volume factor                                              <t>optionally dotted number for the channel volume factor
2585                                              (where a value < 1.0 means attenuation and a value >                                              (where a value &lt; 1.0 means attenuation and a value >
2586                                              1.0 means amplification)</t>                                              1.0 means amplification)</t>
2587                                          </list>                                          </list>
2588                                      </t>                                      </t>
2589                                        <t>MUTE -
2590                                            <list>
2591                                                <t>Determines whether the channel is muted, "true" if the
2592                                                channel is muted, "false" if the channel is not muted, and
2593                                                "MUTED_BY_SOLO" if the channel is muted because of the
2594                                                presence of a solo channel and will be unmuted when
2595                                                there are no solo channels left</t>
2596                                            </list>
2597                                        </t>
2598                                        <t>SOLO -
2599                                            <list>
2600                                                <t>Determines whether this is a solo channel, "true" if
2601                                                the channel is a solo channel; "false" otherwise</t>
2602                                            </list>
2603                                        </t>
2604                                        <t>MIDI_INSTRUMENT_MAP -
2605                                            <list>
2606                                                <t>Determines to which MIDI instrument map this sampler
2607                                                channel is assigned to. Read chapter
2608                                                <xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref>
2609                                                for a list of possible values.</t>
2610                                            </list>
2611                                        </t>
2612                                  </list>                                  </list>
2613                              </t>                              </t>
2614                          </list>                          </list>
# Line 2336  Schoenebeck'> Line 2626  Schoenebeck'>
2626                              <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 0,1"</t>                              <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 0,1"</t>
2627                              <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"</t>                              <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"</t>
2628                              <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>                              <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
2629                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Fazioli Piano"</t>
2630                              <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_STATUS: 100"</t>                              <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_STATUS: 100"</t>
2631                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_DEVICE: 0"</t>                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_DEVICE: 0"</t>
2632                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_PORT: 0"</t>                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_PORT: 0"</t>
2633                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"</t>                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"</t>
2634                                <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
2635                                <t>&nbsp;&nbsp;&nbsp;"MUTE: false"</t>
2636                                <t>&nbsp;&nbsp;&nbsp;"SOLO: false"</t>
2637                                <t>&nbsp;&nbsp;&nbsp;"MIDI_INSTRUMENT_MAP: NONE"</t>
2638                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
2639                          </list>                          </list>
2640                      </t>                      </t>
2641                  </section>                  </section>
2642    
2643                  <section title="Current number of active voices">                  <section title="Current number of active voices" anchor="GET CHANNEL VOICE_COUNT">
2644                      <t>The front-end can ask for the current number of active voices on a                      <t>The front-end can ask for the current number of active voices on a
2645                      sampler channel by sending the following command:</t>                      sampler channel by sending the following command:</t>
2646                      <t>                      <t>
# Line 2353  Schoenebeck'> Line 2648  Schoenebeck'>
2648                              <t>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;</t>                              <t>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;</t>
2649                          </list>                          </list>
2650                      </t>                      </t>
2651                      <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in.</t>                      <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>                      <t>Possible Answers:</t>
2656                      <t>                      <t>
# Line 2370  Schoenebeck'> Line 2667  Schoenebeck'>
2667                      </t>                      </t>
2668                  </section>                  </section>
2669    
2670                  <section title="Current number of active disk streams">                  <section title="Current number of active disk streams" anchor="GET CHANNEL STREAM_COUNT">
2671                      <t>The front-end can ask for the current number of active disk streams                      <t>The front-end can ask for the current number of active disk streams
2672                      on a sampler channel by sending the following command:</t>                      on a sampler channel by sending the following command:</t>
2673                      <t>                      <t>
# Line 2378  Schoenebeck'> Line 2675  Schoenebeck'>
2675                              <t>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;</t>                              <t>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;</t>
2676                          </list>                          </list>
2677                      </t>                      </t>
2678                      <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in.</t>                      <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
2679                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2680                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2681    
2682                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2683                      <t>                      <t>
# Line 2397  Schoenebeck'> Line 2696  Schoenebeck'>
2696                      </t>                      </t>
2697                  </section>                  </section>
2698    
2699                  <section title="Current fill state of disk stream buffers">                  <section title="Current fill state of disk stream buffers" anchor="GET CHANNEL BUFFER_FILL">
2700                      <t>The front-end can ask for the current fill state of all disk streams                      <t>The front-end can ask for the current fill state of all disk streams
2701                      on a sampler channel by sending the following command:</t>                      on a sampler channel by sending the following command:</t>
2702                      <t>                      <t>
# Line 2412  Schoenebeck'> Line 2711  Schoenebeck'>
2711                          </list>                          </list>
2712                      </t>                      </t>
2713                      <t>to get the fill state in percent, where &lt;sampler-channel&gt; is the                      <t>to get the fill state in percent, where &lt;sampler-channel&gt; is the
2714                      sampler channel number the front-end is interested in.</t>                      sampler channel number the front-end is interested in
2715                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2716                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2717    
2718                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2719                      <t>                      <t>
# Line 2448  Schoenebeck'> Line 2749  Schoenebeck'>
2749                      </t>                      </t>
2750                  </section>                  </section>
2751    
2752                  <section title="Setting audio output device">                  <section title="Setting audio output device" anchor="SET CHANNEL AUDIO_OUTPUT_DEVICE">
2753                      <t>The front-end can set the audio output device on a specific sampler                      <t>The front-end can set the audio output device on a specific sampler
2754                      channel by sending the following command:</t>                      channel by sending the following command:</t>
2755                      <t>                      <t>
# Line 2456  Schoenebeck'> Line 2757  Schoenebeck'>
2757                              <t>SET CHANNEL AUDIO_OUTPUT_DEVICE &lt;sampler-channel&gt; &lt;audio-device-id&gt;</t>                              <t>SET CHANNEL AUDIO_OUTPUT_DEVICE &lt;sampler-channel&gt; &lt;audio-device-id&gt;</t>
2758                          </list>                          </list>
2759                      </t>                      </t>
2760                      <t>Where &lt;audio-device-id&gt; is the numerical ID of the audio output                      <t>Where &lt;sampler-channel&gt; is the respective sampler channel
2761                      device and &lt;sampler-channel&gt; is the respective sampler channel                      number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2762                      number.</t>                      or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
2763                        &lt;audio-device-id&gt; is the numerical ID of the audio output device as given by the
2764                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
2765                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
2766                        command.</t>
2767    
2768                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2769                      <t>                      <t>
# Line 2490  Schoenebeck'> Line 2795  Schoenebeck'>
2795                      </t>                      </t>
2796                  </section>                  </section>
2797    
2798                  <section title="Setting audio output type">                  <section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYPE">
2799                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>
2800    
2801                      <t>The front-end can alter the audio output type on a specific sampler                      <t>The front-end can alter the audio output type on a specific sampler
# Line 2500  Schoenebeck'> Line 2805  Schoenebeck'>
2805                              <t>SET CHANNEL AUDIO_OUTPUT_TYPE &lt;sampler-channel&gt; &lt;audio-output-type&gt;</t>                              <t>SET CHANNEL AUDIO_OUTPUT_TYPE &lt;sampler-channel&gt; &lt;audio-output-type&gt;</t>
2806                          </list>                          </list>
2807                      </t>                      </t>
2808                      <t>Where &lt;audio-output-type&gt; is currently either "Alsa" or "Jack" and                      <t>Where &lt;audio-output-type&gt; is currently either "ALSA" or "JACK" and
2809                      &lt;sampler-channel&gt; is the respective sampler channel number.</t>                      &lt;sampler-channel&gt; is the respective sampler channel number.</t>
2810    
2811                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 2533  Schoenebeck'> Line 2838  Schoenebeck'>
2838                      </t>                      </t>
2839                  </section>                  </section>
2840    
2841                  <section title="Setting audio output channel">                  <section title="Setting audio output channel" anchor="SET CHANNEL AUDIO_OUTPUT_CHANNEL">
2842                      <t>The front-end can alter the audio output channel on a specific                      <t>The front-end can alter the audio output channel on a specific
2843                      sampler channel by sending the following command:</t>                      sampler channel by sending the following command:</t>
2844                      <t>                      <t>
# Line 2541  Schoenebeck'> Line 2846  Schoenebeck'>
2846                              <t>SET CHANNEL AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;audio-out&gt; &lt;audio-in&gt;</t>                              <t>SET CHANNEL AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;audio-out&gt; &lt;audio-in&gt;</t>
2847                          </list>                          </list>
2848                      </t>                      </t>
2849                      <t>Where &lt;sampler-chan&gt; is the sampler channel, &lt;audio-out&gt; is the                      <t>Where &lt;sampler-chan&gt; is the sampler channel number
2850                      sampler channel's audio output channel which should be                      as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2851                      rerouted and &lt;audio-in&gt; the audio channel of the selected audio                      or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, &lt;audio-out&gt; is the
2852                        numerical ID of the sampler channel's audio output channel which should be
2853                        rerouted and &lt;audio-in&gt; is the numerical ID of the audio channel of the selected audio
2854                      output device where &lt;audio-out&gt; should be routed to.</t>                      output device where &lt;audio-out&gt; should be routed to.</t>
2855    
2856                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 2576  Schoenebeck'> Line 2883  Schoenebeck'>
2883                      </t>                      </t>
2884                  </section>                  </section>
2885    
2886                  <section title="Setting MIDI input device">                  <section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE">
2887                      <t>The front-end can set the MIDI input device on a specific sampler                      <t>The front-end can set the MIDI input device on a specific sampler
2888                      channel by sending the following command:</t>                      channel by sending the following command:</t>
2889                      <t>                      <t>
# Line 2584  Schoenebeck'> Line 2891  Schoenebeck'>
2891                              <t>SET CHANNEL MIDI_INPUT_DEVICE &lt;sampler-channel&gt; &lt;midi-device-id&gt;</t>                              <t>SET CHANNEL MIDI_INPUT_DEVICE &lt;sampler-channel&gt; &lt;midi-device-id&gt;</t>
2892                          </list>                          </list>
2893                      </t>                      </t>
2894                      <t></t>                      <t>Where &lt;sampler-channel&gt; is the sampler channel number
2895                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2896                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command
2897                        and &lt;midi-device-id&gt; is  the numerical ID of the MIDI input device as returned by the
2898                        <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
2899                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command.</t>
2900    
2901                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2902                      <t>                      <t>
# Line 2616  Schoenebeck'> Line 2928  Schoenebeck'>
2928                      </t>                      </t>
2929                  </section>                  </section>
2930    
2931                  <section title="Setting MIDI input type">                  <section title="Setting MIDI input type" anchor="SET CHANNEL MIDI_INPUT_TYPE">
2932                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>
2933    
2934                      <t>The front-end can alter the MIDI input type on a specific sampler                      <t>The front-end can alter the MIDI input type on a specific sampler
# Line 2626  Schoenebeck'> Line 2938  Schoenebeck'>
2938                              <t>SET CHANNEL MIDI_INPUT_TYPE &lt;sampler-channel&gt; &lt;midi-input-type&gt;</t>                              <t>SET CHANNEL MIDI_INPUT_TYPE &lt;sampler-channel&gt; &lt;midi-input-type&gt;</t>
2939                          </list>                          </list>
2940                      </t>                      </t>
2941                      <t>Where &lt;midi-input-type&gt; is currently only "Alsa" and                      <t>Where &lt;midi-input-type&gt; is currently only "ALSA" and
2942                      &lt;sampler-channel&gt; is the respective sampler channel number.</t>                      &lt;sampler-channel&gt; is the respective sampler channel number.</t>
2943    
2944                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 2659  Schoenebeck'> Line 2971  Schoenebeck'>
2971                      </t>                      </t>
2972                  </section>                  </section>
2973    
2974                  <section title="Setting MIDI input port">                  <section title="Setting MIDI input port" anchor="SET CHANNEL MIDI_INPUT_PORT">
2975                      <t>The front-end can alter the input MIDI port on a specific sampler                      <t>The front-end can alter the MIDI input port on a specific sampler
2976                      channel by sending the following command:</t>                      channel by sending the following command:</t>
2977                      <t>                      <t>
2978                          <list>                          <list>
# Line 2688  Schoenebeck'> Line 3000  Schoenebeck'>
3000                              </t>                              </t>
3001                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3002                                  <list>                                  <list>
3003                                      <t>in case it failed, providing an appropriate error code and error messag</t>                                      <t>in case it failed, providing an appropriate error code and error message</t>
3004                                  </list>                                  </list>
3005                              </t>                              </t>
3006                          </list>                          </list>
# Line 2701  Schoenebeck'> Line 3013  Schoenebeck'>
3013                      </t>                      </t>
3014                  </section>                  </section>
3015    
3016                  <section title="Setting MIDI input channel">                  <section title="Setting MIDI input channel" anchor="SET CHANNEL MIDI_INPUT_CHANNEL">
3017                      <t>The front-end can alter the MIDI channel a sampler channel should                      <t>The front-end can alter the MIDI channel a sampler channel should
3018                      listen to by sending the following command:</t>                      listen to by sending the following command:</t>
3019                      <t>                      <t>
# Line 2709  Schoenebeck'> Line 3021  Schoenebeck'>
3021                              <t>SET CHANNEL MIDI_INPUT_CHANNEL &lt;sampler-channel&gt; &lt;midi-input-chan&gt;</t>                              <t>SET CHANNEL MIDI_INPUT_CHANNEL &lt;sampler-channel&gt; &lt;midi-input-chan&gt;</t>
3022                          </list>                          </list>
3023                      </t>                      </t>
3024                      <t>Where &lt;midi-input-chan&gt; is the new MIDI input channel where                      <t>Where &lt;midi-input-chan&gt; is the number of the new MIDI input channel where
3025                      &lt;sampler-channel&gt; should listen to or "ALL" to listen on all 16 MIDI                      &lt;sampler-channel&gt; should listen to or "ALL" to listen on all 16 MIDI
3026                      channels.</t>                      channels.</t>
3027    
# Line 2743  Schoenebeck'> Line 3055  Schoenebeck'>
3055                      </t>                      </t>
3056                  </section>                  </section>
3057    
3058                  <section title="Setting channel volume">                  <section title="Setting channel volume" anchor="SET CHANNEL VOLUME">
3059                      <t>The front-end can alter the volume of a sampler channel by sending                      <t>The front-end can alter the volume of a sampler channel by sending
3060                      the following command:</t>                      the following command:</t>
3061                      <t>                      <t>
# Line 2786  Schoenebeck'> Line 3098  Schoenebeck'>
3098                      </t>                      </t>
3099                  </section>                  </section>
3100    
3101                  <section title="Resetting a sampler channel">                  <section title="Muting a sampler channel" anchor="SET CHANNEL MUTE">
3102                        <t>The front-end can mute/unmute a specific sampler
3103                        channel by sending the following command:</t>
3104                        <t>
3105                            <list>
3106                                <t>SET CHANNEL MUTE &lt;sampler-channel&gt; &lt;mute&gt;</t>
3107                            </list>
3108                        </t>
3109                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3110                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3111                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3112                        &lt;mute&gt; should be replaced either by "1" to mute the channel or "0"
3113                        to unmute the channel.</t>
3114    
3115                        <t>Possible Answers:</t>
3116                        <t>
3117                            <list>
3118                                <t>"OK" -
3119                                    <list>
3120                                        <t>on success</t>
3121                                    </list>
3122                                </t>
3123                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3124                                    <list>
3125                                        <t>if the channel was muted/unmuted, but there are noteworthy
3126                                        issue(s) related, providing an appropriate warning code and
3127                                        warning message</t>
3128                                    </list>
3129                                </t>
3130                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3131                                    <list>
3132                                        <t>in case it failed, providing an appropriate error code and error message</t>
3133                                    </list>
3134                                </t>
3135                            </list>
3136                        </t>
3137                        <t>Examples:</t>
3138                        <t>
3139                            <list>
3140                                <t></t>
3141                            </list>
3142                        </t>
3143                    </section>
3144    
3145                    <section title="Soloing a sampler channel" anchor="SET CHANNEL SOLO">
3146                        <t>The front-end can solo/unsolo a specific sampler channel
3147                        by sending the following command:</t>
3148                        <t>
3149                            <list>
3150                                <t>SET CHANNEL SOLO &lt;sampler-channel&gt; &lt;solo&gt;</t>
3151                            </list>
3152                        </t>
3153                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3154                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3155                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3156                        &lt;solo&gt; should be replaced either by "1" to solo the channel or "0"
3157                        to unsolo the channel.</t>
3158    
3159                        <t>Possible Answers:</t>
3160                        <t>
3161                            <list>
3162                                <t>"OK" -
3163                                    <list>
3164                                        <t>on success</t>
3165                                    </list>
3166                                </t>
3167                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3168                                    <list>
3169                                        <t>if the channel was soloed/unsoloed, but there are noteworthy
3170                                        issue(s) related, providing an appropriate warning code and
3171                                        warning message</t>
3172                                    </list>
3173                                </t>
3174                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3175                                    <list>
3176                                        <t>in case it failed, providing an appropriate error code and error message</t>
3177                                    </list>
3178                                </t>
3179                            </list>
3180                        </t>
3181                        <t>Examples:</t>
3182                        <t>
3183                            <list>
3184                                <t></t>
3185                            </list>
3186                        </t>
3187                    </section>
3188    
3189                    <section title="Assigning a MIDI instrument map to a sampler channel" anchor="SET CHANNEL MIDI_INSTRUMENT_MAP">
3190                        <t>The front-end can assign a MIDI instrument map to a specific sampler channel
3191                        by sending the following command:</t>
3192                        <t>
3193                            <list>
3194                                <t>SET CHANNEL MIDI_INSTRUMENT_MAP &lt;sampler-channel&gt; &lt;map&gt;</t>
3195                            </list>
3196                        </t>
3197                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3198                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3199                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3200                        &lt;map&gt; can have the following possibilites:</t>
3201                        <t>
3202                            <list>
3203                                <t>"NONE" -
3204                                    <list>
3205                                        <t>This is the default setting. In this case
3206                                        the sampler channel is not assigned any MIDI
3207                                        instrument map and thus will ignore all MIDI
3208                                        program change messages.</t>
3209                                    </list>
3210                                </t>
3211                                <t>"DEFAULT" -
3212                                    <list>
3213                                        <t>The sampler channel will always use the
3214                                        default MIDI instrument map to handle MIDI
3215                                        program change messages.</t>
3216                                    </list>
3217                                </t>
3218                                <t>numeric ID -
3219                                    <list>
3220                                        <t>You can assign a specific MIDI instrument map
3221                                        by replacing &lt;map&gt; with the respective numeric
3222                                        ID of the MIDI instrument map as returned by the
3223                                        <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
3224                                        command. Once that map will be deleted, the sampler
3225                                        channel would fall back to "NONE".</t>
3226                                    </list>
3227                                </t>
3228                            </list>
3229                        </t>
3230                        <t>Read chapter <xref target="MIDI Instrument Mapping">"MIDI Instrument Mapping"</xref>
3231                        for details regarding MIDI instrument mapping.</t>
3232    
3233                        <t>Possible Answers:</t>
3234                        <t>
3235                            <list>
3236                                <t>"OK" -
3237                                    <list>
3238                                        <t>on success</t>
3239                                    </list>
3240                                </t>
3241                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3242                                    <list>
3243                                        <t>in case it failed, providing an appropriate error code and error message</t>
3244                                    </list>
3245                                </t>
3246                            </list>
3247                        </t>
3248    
3249                        <t>Examples:</t>
3250                        <t>
3251                            <list>
3252                                <t></t>
3253                            </list>
3254                        </t>
3255                    </section>
3256    
3257                    <section title="Adding an effect send to a sampler channel" anchor="CREATE FX_SEND">
3258                        <t>The front-end can create an additional effect send on a specific sampler channel
3259                        by sending the following command:</t>
3260                        <t>
3261                            <list>
3262                                <t>CREATE FX_SEND &lt;sampler-channel&gt; &lt;midi-ctrl&gt; [&lt;name&gt;]</t>
3263                            </list>
3264                        </t>
3265                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3266                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3267                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the
3268                        sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
3269                        is a number between 0..127 defining the MIDI controller which can alter the
3270                        effect send level and &lt;name&gt; is an optional argument defining a name
3271                        for the effect send entity. The name does not have to be unique, but MUST be
3272                        encapsulated into apostrophes and supports escape sequences as described in chapter
3273                        "<xref target="character_set">Character Set and Escape Sequences</xref>".</t>
3274    
3275                        <t>By default, that is as initial routing, the effect send's audio channels
3276                        are automatically routed to the last audio channels of the sampler channel's
3277                        audio output device, that way you can i.e. first increase the amount of audio
3278                        channels on the audio output device for having dedicated effect send output
3279                        channels and when "CREATE FX_SEND" is called, those channels will automatically
3280                        be picked. You can alter the destination channels however with
3281                        <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>.
3282                        </t>
3283    
3284                        <t>Note: Create effect sends on a sampler channel only when needed, because having effect
3285                        sends on a sampler channel will decrease runtime performance, because for implementing channel
3286                        effect sends, separate (sampler channel local) audio buffers are needed to render and mix
3287                        the voices and route the audio signal afterwards to the master outputs and effect send
3288                        outputs (along with their respective effect send levels). A sampler channel without effect
3289                        sends however can mix its voices directly into the audio output devices's audio buffers
3290                        and is thus faster.
3291                        </t>
3292    
3293                        <t>Possible Answers:</t>
3294                        <t>
3295                            <list>
3296                                <t>"OK[&lt;fx-send-id&gt;]" -
3297                                    <list>
3298                                        <t>in case a new effect send could be added to the
3299                                        sampler channel, where &lt;fx-send-id&gt; reflects the
3300                                        unique ID of the newly created effect send entity</t>
3301                                    </list>
3302                                </t>
3303                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3304                                    <list>
3305                                        <t>when a new effect send could not be added, i.e.
3306                                        due to invalid parameters</t>
3307                                    </list>
3308                                </t>
3309                            </list>
3310                        </t>
3311    
3312                        <t>Examples:</t>
3313                        <t>
3314                            <list>
3315                                <t>C: "CREATE FX_SEND 0 91 'Reverb Send'"</t>
3316                                <t>S: "OK[0]"</t>
3317                            </list>
3318                        </t>
3319                        <t>
3320                            <list>
3321                                <t>C: "CREATE FX_SEND 0 93"</t>
3322                                <t>S: "OK[1]"</t>
3323                            </list>
3324                        </t>
3325                    </section>
3326    
3327                    <section title="Removing an effect send from a sampler channel" anchor="DESTROY FX_SEND">
3328                        <t>The front-end can remove an existing effect send on a specific sampler channel
3329                        by sending the following command:</t>
3330                        <t>
3331                            <list>
3332                                <t>DESTROY FX_SEND &lt;sampler-channel&gt; &lt;fx-send-id&gt;</t>
3333                            </list>
3334                        </t>
3335                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3336                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3337                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the
3338                        sampler channel from which the effect send should be removed from and
3339                        &lt;fx-send-id&gt; is the respective effect send number as returned by the
3340                        <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3341                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t>
3342    
3343                        <t>Possible Answers:</t>
3344                        <t>
3345                            <list>
3346                                <t>"OK" -
3347                                    <list>
3348                                        <t>on success</t>
3349                                    </list>
3350                                </t>
3351                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3352                                    <list>
3353                                        <t>in case it failed, providing an appropriate error code and
3354                                        error message</t>
3355                                    </list>
3356                                </t>
3357                            </list>
3358                        </t>
3359    
3360                        <t>Example:</t>
3361                        <t>
3362                            <list>
3363                                <t>C: "DESTROY FX_SEND 0 0"</t>
3364                                <t>S: "OK"</t>
3365                            </list>
3366                        </t>
3367                    </section>
3368    
3369                    <section title="Getting amount of effect sends on a sampler channel" anchor="GET FX_SENDS">
3370                        <t>The front-end can ask for the amount of effect sends on a specific sampler channel
3371                        by sending the following command:</t>
3372                        <t>
3373                            <list>
3374                                <t>GET 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 the number of effect
3385                                sends on the given sampler channel.</t>
3386                            </list>
3387                        </t>
3388    
3389                        <t>Example:</t>
3390                        <t>
3391                            <list>
3392                                <t>C: "GET FX_SENDS 0"</t>
3393                                <t>S: "2"</t>
3394                            </list>
3395                        </t>
3396                    </section>
3397    
3398                    <section title="Listing all effect sends on a sampler channel" anchor="LIST FX_SENDS">
3399                        <t>The front-end can ask for a list of effect sends on a specific sampler channel
3400                        by sending the following command:</t>
3401                        <t>
3402                            <list>
3403                                <t>LIST FX_SENDS &lt;sampler-channel&gt;</t>
3404                            </list>
3405                        </t>
3406                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3407                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3408                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
3409    
3410                        <t>Possible Answers:</t>
3411                        <t>
3412                            <list>
3413                                <t>The sampler will answer by returning a comma separated list
3414                                with all effect sends' numerical IDs on the given sampler
3415                                channel.</t>
3416                            </list>
3417                        </t>
3418    
3419                        <t>Examples:</t>
3420                        <t>
3421                            <list>
3422                                <t>C: "LIST FX_SENDS 0"</t>
3423                                <t>S: "0,1"</t>
3424                            </list>
3425                        </t>
3426                        <t>
3427                            <list>
3428                                <t>C: "LIST FX_SENDS 1"</t>
3429                                <t>S: ""</t>
3430                            </list>
3431                        </t>
3432                    </section>
3433    
3434                    <section title="Getting effect send information" anchor="GET FX_SEND INFO">
3435                        <t>The front-end can ask for the current settings of an effect send entity
3436                        by sending the following command:</t>
3437                        <t>
3438                            <list>
3439                                <t>GET FX_SEND INFO &lt;sampler-channel&gt; &lt;fx-send-id&gt;</t>
3440                            </list>
3441                        </t>
3442                        <t>Where &lt;sampler-channel&gt; is the sampler channel number
3443                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3444                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3445                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3446                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3447                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.
3448                       </t>
3449    
3450                        <t>Possible Answers:</t>
3451                        <t>
3452                            <list>
3453                                <t>The sampler will answer by sending a &lt;CRLF&gt; separated list.
3454                                Each answer line begins with the settings category name
3455                                followed by a colon and then a space character &lt;SP&gt; and finally
3456                                the info character string to that setting category. At the
3457                                moment the following categories are defined:</t>
3458    
3459                                <t>
3460                                    <list>
3461                                        <t>NAME -
3462                                            <list>
3463                                                <t>name of the effect send entity
3464                                                (note that this character string may contain
3465                                                 <xref target="character_set">escape sequences</xref>)</t>
3466                                            </list>
3467                                        </t>
3468                                        <t>MIDI_CONTROLLER -
3469                                            <list>
3470                                                <t>a value between 0 and 127 reflecting the MIDI controller
3471                                                which is able to modify the effect send's send level</t>
3472                                            </list>
3473                                        </t>
3474                                        <t>LEVEL -
3475                                            <list>
3476                                                <t>optionally dotted number reflecting the effect send's
3477                                                current send level (where a value &lt; 1.0 means attenuation
3478                                                and a value > 1.0 means amplification)</t>
3479                                            </list>
3480                                        </t>
3481                                        <t>AUDIO_OUTPUT_ROUTING -
3482                                            <list>
3483                                                <t>comma separated list which reflects to which audio
3484                                                channel of the selected audio output device each
3485                                                effect send output channel is routed to, e.g. "0,3" would
3486                                                mean the effect send's output channel 0 is routed to channel
3487                                                0 of the audio output device and the effect send's output
3488                                                channel 1 is routed to the channel 3 of the audio
3489                                                output device (see
3490                                                <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>
3491                                                for details)</t>
3492                                            </list>
3493                                        </t>
3494                                    </list>
3495                                </t>
3496                            </list>
3497                        </t>
3498                        <t>The mentioned fields above don't have to be in particular order.</t>
3499    
3500                        <t>Example:</t>
3501                        <t>
3502                            <list>
3503                                <t>C: "GET FX_SEND INFO 0 0"</t>
3504                                <t>S: "NAME: Reverb Send"</t>
3505                                <t>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"</t>
3506                                <t>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"</t>
3507                                <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"</t>
3508                                <t>&nbsp;&nbsp;&nbsp;"."</t>
3509                            </list>
3510                        </t>
3511                    </section>
3512    
3513                    <section title="Changing effect send's name" anchor="SET FX_SEND NAME">
3514                        <t>The front-end can alter the current name of an effect
3515                        send entity by sending the following command:</t>
3516                        <t>
3517                            <list>
3518                                <t>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;</t>
3519                            </list>
3520                        </t>
3521                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3522                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3523                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3524                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3525                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3526                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3527                        &lt;name&gt; is the new name of the effect send entity, which
3528                        does not have to be unique (name MUST be encapsulated into apostrophes
3529                        and supports escape sequences as described in chapter
3530                        "<xref target="character_set">Character Set and Escape Sequences</xref>").
3531                        </t>
3532    
3533                        <t>Possible Answers:</t>
3534                        <t>
3535                            <list>
3536                                <t>"OK" -
3537                                    <list>
3538                                        <t>on success</t>
3539                                    </list>
3540                                </t>
3541                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3542                                    <list>
3543                                        <t>in case it failed, providing an appropriate error code and error message</t>
3544                                    </list>
3545                                </t>
3546                            </list>
3547                        </t>
3548                        <t>Example:</t>
3549                        <t>
3550                            <list>
3551                                <t>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"</t>
3552                                <t>S: "OK"</t>
3553                            </list>
3554                        </t>
3555                    </section>
3556    
3557                    <section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL">
3558                        <t>The front-end can alter the destination of an effect send's audio channel on a specific
3559                        sampler channel by sending the following command:</t>
3560                        <t>
3561                            <list>
3562                                <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>
3563                            </list>
3564                        </t>
3565                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3566                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3567                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3568                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3569                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3570                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command,
3571                        &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
3572                        which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
3573                        the audio channel of the selected audio output device where &lt;audio-src&gt;
3574                        should be routed to.</t>
3575    
3576                        <t>Note that effect sends can only route audio to the same audio output
3577                        device as assigned to the effect send's sampler channel. Also note that an
3578                        effect send entity does always have exactly as much audio channels as its
3579                        sampler channel. So if the sampler channel is stereo, the effect send does
3580                        have two audio channels as well. Also keep in mind that the amount of audio
3581                        channels on a sampler channel might be dependant not only to the deployed
3582                        sampler engine on the sampler channel, but also dependant to the instrument
3583                        currently loaded. However you can (effectively) turn an i.e. stereo effect
3584                        send into a mono one by simply altering its audio routing appropriately.</t>
3585    
3586                        <t>Possible Answers:</t>
3587                        <t>
3588                            <list>
3589                                <t>"OK" -
3590                                    <list>
3591                                        <t>on success</t>
3592                                    </list>
3593                                </t>
3594                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3595                                    <list>
3596                                        <t>if audio output channel was set, but there are noteworthy
3597                                        issue(s) related, providing an appropriate warning code and
3598                                        warning message</t>
3599                                    </list>
3600                                </t>
3601                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3602                                    <list>
3603                                        <t>in case it failed, providing an appropriate error code and error message</t>
3604                                    </list>
3605                                </t>
3606                            </list>
3607                        </t>
3608                        <t>Example:</t>
3609                        <t>
3610                            <list>
3611                                <t>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"</t>
3612                                <t>S: "OK"</t>
3613                            </list>
3614                        </t>
3615                    </section>
3616    
3617                    <section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER">
3618                        <t>The front-end can alter the MIDI controller of an effect
3619                        send entity by sending the following command:</t>
3620                        <t>
3621                            <list>
3622                                <t>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;</t>
3623                            </list>
3624                        </t>
3625                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3626                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3627                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3628                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3629                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3630                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3631                        &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
3632                        able to modify the effect send's send level.</t>
3633    
3634                        <t>Possible Answers:</t>
3635                        <t>
3636                            <list>
3637                                <t>"OK" -
3638                                    <list>
3639                                        <t>on success</t>
3640                                    </list>
3641                                </t>
3642                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3643                                    <list>
3644                                        <t>if MIDI controller was set, but there are noteworthy
3645                                        issue(s) related, providing an appropriate warning code and
3646                                        warning message</t>
3647                                    </list>
3648                                </t>
3649                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3650                                    <list>
3651                                        <t>in case it failed, providing an appropriate error code and error message</t>
3652                                    </list>
3653                                </t>
3654                            </list>
3655                        </t>
3656                        <t>Example:</t>
3657                        <t>
3658                            <list>
3659                                <t>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"</t>
3660                                <t>S: "OK"</t>
3661                            </list>
3662                        </t>
3663                    </section>
3664    
3665                    <section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL">
3666                        <t>The front-end can alter the current send level of an effect
3667                        send entity by sending the following command:</t>
3668                        <t>
3669                            <list>
3670                                <t>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;</t>
3671                            </list>
3672                        </t>
3673                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3674                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3675                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3676                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3677                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3678                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3679                        &lt;volume&gt; is an optionally dotted positive number (a value
3680                        smaller than 1.0 means attenuation, whereas a value greater than
3681                        1.0 means amplification) reflecting the new send level.</t>
3682    
3683                        <t>Possible Answers:</t>
3684                        <t>
3685                            <list>
3686                                <t>"OK" -
3687                                    <list>
3688                                        <t>on success</t>
3689                                    </list>
3690                                </t>
3691                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3692                                    <list>
3693                                        <t>if new send level was set, but there are noteworthy
3694                                        issue(s) related, providing an appropriate warning code and
3695                                        warning message</t>
3696                                    </list>
3697                                </t>
3698                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3699                                    <list>
3700                                        <t>in case it failed, providing an appropriate error code and error message</t>
3701                                    </list>
3702                                </t>
3703                            </list>
3704                        </t>
3705                        <t>Example:</t>
3706                        <t>
3707                            <list>
3708                                <t>C: "SET FX_SEND LEVEL 0 0 0.15"</t>
3709                                <t>S: "OK"</t>
3710                            </list>
3711                        </t>
3712                    </section>
3713    
3714                    <section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA">
3715                        <t>The front-end can send MIDI events to specific sampler channel
3716                        by sending the following command:</t>
3717                        <t>
3718                            <list>
3719                                <t>SEND CHANNEL MIDI_DATA &lt;midi-msg&gt; &lt;sampler-chan&gt; &lt;arg1&gt; &lt;arg2&gt;</t>
3720                            </list>
3721                        </t>
3722                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3723                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3724                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3725                        &lt;arg1&gt; and &lt;arg2&gt; arguments depend on the &lt;midi-msg&gt; argument, which
3726                        specifies the MIDI message type. Currently, the following MIDI messages are supported:</t>
3727                        <t>
3728                            <list>
3729                                <t>"NOTE_ON" -
3730                                    <list>
3731                                        <t>For turning on MIDI notes, where &lt;arg1&gt;
3732                                        specifies the key number and &lt;arg2&gt; the velocity
3733                                        as described in the MIDI specification.</t>
3734                                    </list>
3735                                </t>
3736                                <t>"NOTE_OFF" -
3737                                    <list>
3738                                        <t>For turning a currently playing MIDI note off, where &lt;arg1&gt;
3739                                        specifies the key number and &lt;arg2&gt; the velocity
3740                                        as described in the MIDI specification.</t>
3741                                    </list>
3742                                </t>
3743                            </list>
3744                        </t>
3745                        <t>CAUTION: This command is provided for implementations of virtual MIDI keyboards
3746                        and no realtime guarantee whatsoever will be made!</t>
3747                        <t>Possible Answers:</t>
3748                        <t>
3749                            <list>
3750                                <t>"OK" -
3751                                    <list>
3752                                        <t>on success</t>
3753                                    </list>
3754                                </t>
3755                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3756                                    <list>
3757                                        <t>in case it failed, providing an appropriate error code and error message</t>
3758                                    </list>
3759                                </t>
3760                            </list>
3761                        </t>
3762                        <t>Example:</t>
3763                        <t>
3764                            <list>
3765                                <t>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"</t>
3766                                <t>S: "OK"</t>
3767                            </list>
3768                        </t>
3769                    </section>
3770    
3771                    <section title="Resetting a sampler channel" anchor="RESET CHANNEL">
3772                      <t>The front-end can reset a particular sampler channel by sending the following command:</t>                      <t>The front-end can reset a particular sampler channel by sending the following command:</t>
3773                      <t>                      <t>
3774                          <list>                          <list>
# Line 2834  Schoenebeck'> Line 3816  Schoenebeck'>
3816              <section title="Controlling connection">              <section title="Controlling connection">
3817                  <t>The following commands are used to control the connection to LinuxSampler.</t>                  <t>The following commands are used to control the connection to LinuxSampler.</t>
3818    
3819                  <section title="Register front-end for receiving event messages">                  <section title="Register front-end for receiving event messages" anchor="SUBSCRIBE">
3820                      <t>The front-end can register itself to the LinuxSampler application to                      <t>The front-end can register itself to the LinuxSampler application to
3821                      be informed about noteworthy events by sending this command:</t>                      be informed about noteworthy events by sending this command:</t>
3822                      <t>                      <t>
# Line 2876  Schoenebeck'> Line 3858  Schoenebeck'>
3858                      </t>                      </t>
3859                  </section>                  </section>
3860    
3861                  <section title="Unregister front-end for not receiving UDP event messages anymore">                  <section title="Unregister front-end for not receiving event messages" anchor="UNSUBSCRIBE">
3862                      <t>The front-end can unregister itself if it doesn't want to receive event                      <t>The front-end can unregister itself if it doesn't want to receive event
3863                      messages anymore by sending the following command:</t>                      messages anymore by sending the following command:</t>
3864                      <t>                      <t>
# Line 2918  Schoenebeck'> Line 3900  Schoenebeck'>
3900                      </t>                      </t>
3901                  </section>                  </section>
3902    
3903                  <section title="Enable or disable echo of commands">                  <section title="Enable or disable echo of commands" anchor="SET ECHO">
3904                      <t>To enable or disable back sending of commands to the client the following command can be used:</t>                      <t>To enable or disable back sending of commands to the client the following command can be used:</t>
3905                      <t>                      <t>
3906                          <list>                          <list>
# Line 2956  Schoenebeck'> Line 3938  Schoenebeck'>
3938                      </t>                      </t>
3939                  </section>                  </section>
3940    
3941                  <section title="Close client connection">                  <section title="Close client connection" anchor="QUIT">
3942                      <t>The client can close its network connection to LinuxSampler by sending the following command:</t>                      <t>The client can close its network connection to LinuxSampler by sending the following command:</t>
3943                      <t>                      <t>
3944                          <list>                          <list>
# Line 2971  Schoenebeck'> Line 3953  Schoenebeck'>
3953              <section title="Global commands">              <section title="Global commands">
3954                  <t>The following commands have global impact on the sampler.</t>                  <t>The following commands have global impact on the sampler.</t>
3955    
3956                  <section title="Reset sampler">                  <section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT">
3957                        <t>The front-end can ask for the current number of active voices on
3958                        the sampler by sending the following command:</t>
3959                        <t>
3960                            <list>
3961                                <t>GET TOTAL_VOICE_COUNT</t>
3962                            </list>
3963                        </t>
3964    
3965                        <t>Possible Answers:</t>
3966                        <t>
3967                            <list>
3968                                <t>LinuxSampler will answer by returning the number of all active
3969                                voices on the sampler.</t>
3970                            </list>
3971                        </t>
3972                    </section>
3973    
3974                    <section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX">
3975                        <t>The front-end can ask for the maximum number of active voices
3976                        by sending the following command:</t>
3977                        <t>
3978                            <list>
3979                                <t>GET TOTAL_VOICE_COUNT_MAX</t>
3980                            </list>
3981                        </t>
3982    
3983                        <t>Possible Answers:</t>
3984                        <t>
3985                            <list>
3986                                <t>LinuxSampler will answer by returning the maximum number
3987                                of active voices.</t>
3988                            </list>
3989                        </t>
3990                    </section>
3991    
3992                    <section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT">
3993                        <t>The front-end can ask for the current number of active disk streams on
3994                        the sampler by sending the following command:</t>
3995                        <t>
3996                            <list>
3997                                <t>GET TOTAL_STREAM_COUNT</t>
3998                            </list>
3999                        </t>
4000    
4001                        <t>Possible Answers:</t>
4002                        <t>
4003                            <list>
4004                                <t>LinuxSampler will answer by returning the number of all active
4005                                disk streams on the sampler.</t>
4006                            </list>
4007                        </t>
4008                    </section>
4009    
4010                    <section title="Reset sampler" anchor="RESET">
4011                      <t>The front-end can reset the whole sampler by sending the following command:</t>                      <t>The front-end can reset the whole sampler by sending the following command:</t>
4012                      <t>                      <t>
4013                          <list>                          <list>
# Line 2996  Schoenebeck'> Line 4032  Schoenebeck'>
4032                          </list>                          </list>
4033                      </t>                      </t>
4034                  </section>                  </section>
4035    
4036                    <section title="General sampler informations" anchor="GET SERVER INFO">
4037                        <t>The client can ask for general informations about the LinuxSampler
4038                           instance by sending the following command:</t>
4039                        <t>
4040                            <list>
4041                                <t>GET SERVER INFO</t>
4042                            </list>
4043                        </t>
4044                        <t>Possible Answers:</t>
4045                        <t>
4046                            <list>
4047                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
4048                                   Each answer line begins with the information category name
4049                                   followed by a colon and then a space character &lt;SP&gt; and finally
4050                                   the info character string to that information category. At the
4051                                   moment the following categories are defined:
4052                                </t>
4053                                <t>
4054                                    <list>
4055                                        <t>DESCRIPTION -
4056                                            <list>
4057                                                <t>arbitrary textual description about the sampler
4058                                                (note that the character string may contain
4059                                                <xref target="character_set">escape sequences</xref>)</t>
4060                                            </list>
4061                                        </t>
4062                                        <t>VERSION -
4063                                            <list>
4064                                                <t>version of the sampler</t>
4065                                            </list>
4066                                        </t>
4067                                        <t>PROTOCOL_VERSION -
4068                                            <list>
4069                                                <t>version of the LSCP specification the sampler
4070                                                complies with (see <xref target="LSCP versioning" /> for details)</t>
4071                                            </list>
4072                                        </t>
4073                                        <t>INSTRUMENTS_DB_SUPPORT -
4074                                            <list>
4075                                                <t>either yes or no, specifies whether the
4076                                                sampler is build with instruments database support.</t>
4077                                            </list>
4078                                        </t>
4079                                    </list>
4080                                </t>
4081                            </list>
4082                        </t>
4083                        <t>The mentioned fields above don't have to be in particular order.
4084                        Other fields might be added in future.</t>
4085                    </section>
4086    
4087                    <section title="Getting global volume attenuation" anchor="GET VOLUME">
4088                        <t>The client can ask for the current global sampler-wide volume
4089                        attenuation by sending the following command:</t>
4090                        <t>
4091                            <list>
4092                                <t>GET VOLUME</t>
4093                            </list>
4094                        </t>
4095                        <t>Possible Answers:</t>
4096                        <t>
4097                            <list>
4098                                <t>The sampler will always answer by returning the optional
4099                                dotted floating point coefficient, reflecting the current
4100                                global volume attenuation.
4101                                </t>
4102                            </list>
4103                        </t>
4104                        <t>Note: it is up to the respective sampler engine whether to obey
4105                        that global volume parameter or not, but in general all engines SHOULD
4106                        use this parameter.</t>
4107                    </section>
4108    
4109                    <section title="Setting global volume attenuation" anchor="SET VOLUME">
4110                        <t>The client can alter the current global sampler-wide volume
4111                        attenuation by sending the following command:</t>
4112                        <t>
4113                            <list>
4114                                <t>SET VOLUME &lt;volume&gt;</t>
4115                            </list>
4116                        </t>
4117                       <t>Where &lt;volume&gt; should be replaced by the optional dotted
4118                       floating point value, reflecting the new global volume parameter.
4119                       This value might usually be in the range between 0.0 and 1.0, that
4120                       is for attenuating the overall volume.</t>
4121    
4122                        <t>Possible Answers:</t>
4123                        <t>
4124                            <list>
4125                                <t>"OK" -
4126                                    <list>
4127                                        <t>on success</t>
4128                                    </list>
4129                                </t>
4130                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4131                                    <list>
4132                                        <t>if the global volume was set, but there are noteworthy
4133                                        issue(s) related, providing an appropriate warning code and
4134                                        warning message</t>
4135                                    </list>
4136                                </t>
4137                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4138                                    <list>
4139                                        <t>in case it failed, providing an appropriate error code and error message</t>
4140                                    </list>
4141                                </t>
4142                            </list>
4143                        </t>
4144                    </section>
4145    
4146                    <section title="Getting global voice limit" anchor="GET VOICES">
4147                        <t>The client can ask for the current global sampler-wide limit
4148                           for maximum voices by sending the following command:</t>
4149                        <t>
4150                            <list>
4151                                <t>GET VOICES</t>
4152                            </list>
4153                        </t>
4154                        <t>Possible Answers:</t>
4155                        <t>
4156                            <list>
4157                                <t>LinuxSampler will answer by returning the number for
4158                                   the current limit of maximum voices.</t>
4159                            </list>
4160                        </t>
4161    
4162                        <t>The voice limit setting defines how many voices should maximum
4163                           be processed by the sampler at the same time. If the user
4164                           triggers new notes which would exceed that voice limit, the
4165                           sampler engine will react by stealing old voices for those
4166                           newly triggered notes. Note that the amount of voices triggered
4167                           by a new note can be larger than one and is dependent to the
4168                           respective instrument and probably further criterias.</t>
4169                    </section>
4170    
4171                    <section title="Setting global voice limit" anchor="SET VOICES">
4172                        <t>The client can alter the current global sampler-wide limit
4173                        for maximum voices by sending the following command:</t>
4174                        <t>
4175                            <list>
4176                                <t>SET VOICES &lt;max-voices&gt;</t>
4177                            </list>
4178                        </t>
4179                       <t>Where &lt;max-voices&gt; should be replaced by the integer
4180                       value, reflecting the new global amount limit of maximum voices.
4181                       This value has to be larger than 0.</t>
4182    
4183                        <t>Possible Answers:</t>
4184                        <t>
4185                            <list>
4186                                <t>"OK" -
4187                                    <list>
4188                                        <t>on success</t>
4189                                    </list>
4190                                </t>
4191                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4192                                    <list>
4193                                        <t>if the voice limit was set, but there are noteworthy
4194                                        issue(s) related, providing an appropriate warning code and
4195                                        warning message</t>
4196                                    </list>
4197                                </t>
4198                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4199                                    <list>
4200                                        <t>in case it failed, providing an appropriate error code and error message</t>
4201                                    </list>
4202                                </t>
4203                            </list>
4204                        </t>
4205    
4206                        <t>Note: the given value will be passed to all sampler engine instances.
4207                           The total amount of maximum voices on the running system might thus
4208                           be as big as the given value multiplied by the current amount of engine
4209                           instances.</t>
4210    
4211                         <t>Caution: when adjusting the voice limit, you SHOULD also
4212                            adjust the disk stream limit respectively and vice versa.</t>
4213                    </section>
4214    
4215                    <section title="Getting global disk stream limit" anchor="GET STREAMS">
4216                        <t>The client can ask for the current global sampler-wide limit
4217                           for maximum disk streams by sending the following command:</t>
4218                        <t>
4219                            <list>
4220                                <t>GET STREAMS</t>
4221                            </list>
4222                        </t>
4223                        <t>Possible Answers:</t>
4224                        <t>
4225                            <list>
4226                                <t>LinuxSampler will answer by returning the number for
4227                                   the current limit of maximum disk streams.</t>
4228                            </list>
4229                        </t>
4230    
4231                        <t>The disk stream limit setting defines how many disk streams should
4232                           maximum be processed by a sampler engine at the same time. The
4233                           higher this value, the more memory (RAM) will be occupied, since
4234                           every disk streams allocates a certain buffer size for being able
4235                           to perform its streaming operations.</t>
4236                    </section>
4237    
4238                    <section title="Setting global disk stream limit" anchor="SET STREAMS">
4239                        <t>The client can alter the current global sampler-wide limit
4240                        for maximum disk streams by sending the following command:</t>
4241                        <t>
4242                            <list>
4243                                <t>SET STREAMS &lt;max-streams&gt;</t>
4244                            </list>
4245                        </t>
4246                       <t>Where &lt;max-streams&gt; should be replaced by the integer
4247                       value, reflecting the new global amount limit of maximum disk streams.
4248                       This value has to be positive.</t>
4249    
4250                        <t>Possible Answers:</t>
4251                        <t>
4252                            <list>
4253                                <t>"OK" -
4254                                    <list>
4255                                        <t>on success</t>
4256                                    </list>
4257                                </t>
4258                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4259                                    <list>
4260                                        <t>if the disk stream limit was set, but there are noteworthy
4261                                        issue(s) related, providing an appropriate warning code and
4262                                        warning message</t>
4263                                    </list>
4264                                </t>
4265                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4266                                    <list>
4267                                        <t>in case it failed, providing an appropriate error code and error message</t>
4268                                    </list>
4269                                </t>
4270                            </list>
4271                        </t>
4272    
4273                        <t>Note: the given value will be passed to all sampler engine instances.
4274                           The total amount of maximum disk streams on the running system might
4275                           thus be as big as the given value multiplied by the current amount of
4276                           engine instances.</t>
4277    
4278                         <t>Caution: when adjusting the disk stream limit, you SHOULD also
4279                            adjust the voice limit respectively and vice versa.</t>
4280                    </section>
4281    
4282                </section>
4283    
4284    
4285                <section title="MIDI Instrument Mapping" anchor="MIDI Instrument Mapping">
4286                    <t>The MIDI protocol provides a way to switch between instruments
4287                    by sending so called MIDI bank select and MIDI program change
4288                    messages which are essentially just numbers. The following commands
4289                    allow to actually map arbitrary MIDI bank select / program change
4290                    numbers with real instruments.</t>
4291                    <t>The sampler allows to manage an arbitrary amount of MIDI
4292                    instrument maps which define which instrument to load on
4293                    which MIDI program change message.</t>
4294                    <t>By default, that is when the sampler is launched, there is no
4295                    map, thus the sampler will simply ignore all program change
4296                    messages. The front-end has to explicitly create at least one
4297                    map, add entries to the map and tell the respective sampler
4298                    channel(s) which MIDI instrument map to use, so the sampler
4299                    knows how to react on a given program change message on the
4300                    respective sampler channel, that is by switching to the
4301                    respectively defined engine type and loading the respective
4302                    instrument. See command
4303                    <xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref>
4304                    for how to assign a MIDI instrument map to a sampler channel.</t>
4305                    <t>Also note per MIDI specification a bank select message does not
4306                    cause to switch to another instrument. Instead when receiving a
4307                    bank select message the bank value will be stored and a subsequent
4308                    program change message (which may occur at any time) will finally
4309                    cause the sampler to switch to the respective instrument as
4310                    reflected by the current MIDI instrument map.</t>
4311    
4312                    <section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT_MAP">
4313                        <t>The front-end can add a new MIDI instrument map by sending
4314                        the following command:</t>
4315                        <t>
4316                            <list>
4317                                <t>ADD MIDI_INSTRUMENT_MAP [&lt;name&gt;]</t>
4318                            </list>
4319                        </t>
4320                        <t>Where &lt;name&gt; is an optional argument allowing to
4321                        assign a custom name to the new map. MIDI instrument Map
4322                        names do not have to be unique, but MUST be encapsulated
4323                        into apostrophes and support escape sequences as described
4324                        in chapter "<xref target="character_set">Character Set and Escape Sequences</xref>".
4325                        </t>
4326    
4327                        <t>Possible Answers:</t>
4328                        <t>
4329                            <list>
4330                                <t>"OK[&lt;map&gt;]" -
4331                                    <list>
4332                                        <t>in case a new MIDI instrument map could
4333                                        be added, where &lt;map&gt; reflects the
4334                                        unique ID of the newly created MIDI
4335                                        instrument map</t>
4336                                    </list>
4337                                </t>
4338                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4339                                    <list>
4340                                        <t>when a new map could not be created, which
4341                                        might never occur in practice</t>
4342                                    </list>
4343                                </t>
4344                            </list>
4345                        </t>
4346    
4347                        <t>Examples:</t>
4348                        <t>
4349                            <list>
4350                                <t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"</t>
4351                                <t>S: "OK[0]"</t>
4352                            </list>
4353                        </t>
4354                        <t>
4355                            <list>
4356                                <t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"</t>
4357                                <t>S: "OK[1]"</t>
4358                            </list>
4359                        </t>
4360                        <t>
4361                            <list>
4362                                <t>C: "ADD MIDI_INSTRUMENT_MAP"</t>
4363                                <t>S: "OK[5]"</t>
4364                            </list>
4365                        </t>
4366                    </section>
4367    
4368                    <section title="Delete one particular or all MIDI instrument maps" anchor="REMOVE MIDI_INSTRUMENT_MAP">
4369                        <t>The front-end can delete a particular MIDI instrument map
4370                        by sending the following command:</t>
4371                        <t>
4372                            <list>
4373                                <t>REMOVE MIDI_INSTRUMENT_MAP &lt;map&gt;</t>
4374                            </list>
4375                        </t>
4376                        <t>Where &lt;map&gt; reflects the unique ID of the map to delete
4377                        as returned by the <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
4378                        command.</t>
4379                        <t>The front-end can delete all MIDI instrument maps by
4380                        sending the following command:</t>
4381                        <t>
4382                            <list>
4383                                <t>REMOVE MIDI_INSTRUMENT_MAP ALL</t>
4384                            </list>
4385                        </t>
4386    
4387                        <t>Possible Answers:</t>
4388                        <t>
4389                            <list>
4390                                <t>"OK" -
4391                                    <list>
4392                                        <t>in case the map(s) could be deleted</t>
4393                                    </list>
4394                                </t>
4395                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4396                                    <list>
4397                                        <t>when the given map does not exist</t>
4398                                    </list>
4399                                </t>
4400                            </list>
4401                        </t>
4402    
4403                        <t>Examples:</t>
4404                        <t>
4405                            <list>
4406                                <t>C: "REMOVE MIDI_INSTRUMENT_MAP 0"</t>
4407                                <t>S: "OK"</t>
4408                            </list>
4409                        </t>
4410                        <t>
4411                            <list>
4412                                <t>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"</t>
4413                                <t>S: "OK"</t>
4414                            </list>
4415                        </t>
4416                    </section>
4417    
4418                    <section title="Get amount of existing MIDI instrument maps" anchor="GET MIDI_INSTRUMENT_MAPS">
4419                        <t>The front-end can retrieve the current amount of MIDI
4420                        instrument maps by sending the following command:</t>
4421                        <t>
4422                            <list>
4423                                <t>GET MIDI_INSTRUMENT_MAPS</t>
4424                            </list>
4425                        </t>
4426    
4427                        <t>Possible Answers:</t>
4428                        <t>
4429                            <list>
4430                                <t>The sampler will answer by returning the current
4431                                number of MIDI instrument maps.</t>
4432                            </list>
4433                        </t>
4434    
4435                        <t>Example:</t>
4436                        <t>
4437                            <list>
4438                                <t>C: "GET MIDI_INSTRUMENT_MAPS"</t>
4439                                <t>S: "2"</t>
4440                            </list>
4441                        </t>
4442                    </section>
4443    
4444                    <section title="Getting all created MIDI instrument maps" anchor="LIST MIDI_INSTRUMENT_MAPS">
4445                        <t>The number of MIDI instrument maps can change on runtime. To get the
4446                        current list of MIDI instrument maps, the front-end can send the
4447                        following command:</t>
4448                        <t>
4449                            <list>
4450                                <t>LIST MIDI_INSTRUMENT_MAPS</t>
4451                            </list>
4452                        </t>
4453                        <t>Possible Answers:</t>
4454                        <t>
4455                            <list>
4456                                <t>The sampler will answer by returning a comma separated list
4457                                with all MIDI instrument maps' numerical IDs.</t>
4458                            </list>
4459                        </t>
4460                        <t>Example:</t>
4461                        <t>
4462                            <list>
4463                                <t>C: "LIST MIDI_INSTRUMENT_MAPS"</t>
4464                                <t>S: "0,1,5,12"</t>
4465                            </list>
4466                        </t>
4467                    </section>
4468    
4469                    <section title="Getting MIDI instrument map information" anchor="GET MIDI_INSTRUMENT_MAP INFO">
4470                        <t>The front-end can ask for the current settings of a MIDI
4471                        instrument map by sending the following command:</t>
4472                        <t>
4473                            <list>
4474                                <t>GET MIDI_INSTRUMENT_MAP INFO &lt;map&gt;</t>
4475                            </list>
4476                        </t>
4477                        <t>Where &lt;map&gt; is the numerical ID of the map the
4478                        front-end is interested in as returned by the
4479                        <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
4480                        command.</t>
4481    
4482                        <t>Possible Answers:</t>
4483                        <t>
4484                            <list>
4485                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
4486                                Each answer line begins with the settings category name
4487                                followed by a colon and then a space character &lt;SP&gt; and finally
4488                                the info character string to that setting category. At the
4489                                moment the following categories are defined:</t>
4490    
4491                                <t>
4492                                    <list>
4493                                        <t>NAME -
4494                                            <list>
4495                                                <t>custom name of the given map,
4496                                                which does not have to be unique
4497                                                (note that this character string may contain
4498                                                 <xref target="character_set">escape sequences</xref>)</t>
4499                                            </list>
4500                                        </t>
4501                                        <t>DEFAULT -
4502                                            <list>
4503                                                <t>either true or false,
4504                                                defines whether this map is the default map</t>
4505                                            </list>
4506                                        </t>
4507                                    </list>
4508                                </t>
4509                            </list>
4510                        </t>
4511                        <t>The mentioned fields above don't have to be in particular order.</t>
4512    
4513                        <t>Example:</t>
4514                        <t>
4515                            <list>
4516                                <t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t>
4517                                <t>S: "NAME: Standard Map"</t>
4518                                <t>&nbsp;&nbsp;&nbsp;"DEFAULT: true"</t>
4519                                <t>&nbsp;&nbsp;&nbsp;"."</t>
4520                            </list>
4521                        </t>
4522                    </section>
4523    
4524                    <section title="Renaming a MIDI instrument map" anchor="SET MIDI_INSTRUMENT_MAP NAME">
4525                        <t>The front-end can alter the custom name of a MIDI
4526                        instrument map by sending the following command:</t>
4527                        <t>
4528                            <list>
4529                                <t>SET MIDI_INSTRUMENT_MAP NAME &lt;map&gt; &lt;name&gt;</t>
4530                            </list>
4531                        </t>
4532                        <t>Where &lt;map&gt; is the numerical ID of the map and
4533                        &lt;name&gt; the new custom name of the map, which does not
4534                        have to be unique (name MUST be encapsulated into apostrophes
4535                        and supports escape sequences as described in chapter
4536                        "<xref target="character_set">Character Set and Escape Sequences</xref>").
4537                        </t>
4538    
4539                        <t>Possible Answers:</t>
4540                        <t>
4541                            <list>
4542                                <t>"OK" -
4543                                    <list>
4544                                        <t>on success</t>
4545                                    </list>
4546                                </t>
4547                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4548                                    <list>
4549                                        <t>in case the given map does not exist</t>
4550                                    </list>
4551                                </t>
4552                            </list>
4553                        </t>
4554    
4555                        <t>Example:</t>
4556                        <t>
4557                            <list>
4558                                <t>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"</t>
4559                                <t>S: "OK"</t>
4560                            </list>
4561                        </t>
4562                    </section>
4563    
4564                    <section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT">
4565                        <t>The front-end can create a new or replace an existing entry
4566                        in a sampler's MIDI instrument map by sending the following
4567                        command:</t>
4568                        <t>
4569                            <list>
4570                                <t>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
4571                                &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
4572                                &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
4573                                [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>
4574                            </list>
4575                        </t>
4576                        <t>Where &lt;map&gt; is the numeric ID of the map to alter,
4577                        &lt;midi_bank&gt; is an integer value between
4578                        0..16383 reflecting the MIDI bank select index,
4579                        &lt;midi_prog&gt; an
4580                        integer value between 0..127 reflecting the MIDI program change
4581                        index, &lt;engine_name&gt; a sampler engine name as returned by
4582                        the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>
4583                        command (not encapsulated into apostrophes), &lt;filename&gt; the name
4584                        of the instrument's file to be deployed (encapsulated into apostrophes,
4585                        supporting escape sequences as described in chapter
4586                        "<xref target="character_set">Character Set and Escape Sequences</xref>"),
4587                        &lt;instrument_index&gt; the index (integer value) of the instrument
4588                        within the given file, &lt;volume_value&gt; reflects the master
4589                        volume of the instrument as optionally dotted number (where a
4590                        value &lt; 1.0 means attenuation and a value > 1.0 means
4591                        amplification). This parameter easily allows to adjust the
4592                        volume of all intruments within a custom instrument map
4593                        without having to adjust their instrument files. The
4594                        OPTIONAL &lt;instr_load_mode&gt; argument defines the life
4595                        time of the instrument, that is when the instrument should
4596                        be loaded, when freed and has exactly the following
4597                        possibilities:</t>
4598                        <t>
4599                            <list>
4600                                <t>"ON_DEMAND" -
4601                                    <list>
4602                                        <t>The instrument will be loaded when needed,
4603                                        that is when demanded by at least one sampler
4604                                        channel. It will immediately be freed from memory
4605                                        when not needed by any sampler channel anymore.</t>
4606                                    </list>
4607                                </t>
4608                                <t>"ON_DEMAND_HOLD" -
4609                                    <list>
4610                                        <t>The instrument will be loaded when needed,
4611                                        that is when demanded by at least one sampler
4612                                        channel. It will be kept in memory even when
4613                                        not needed by any sampler channel anymore.
4614                                        Instruments with this mode are only freed
4615                                        when the sampler is reset or all mapping
4616                                        entries with this mode (and respective
4617                                        instrument) are explicitly changed to
4618                                        "ON_DEMAND" and no sampler channel is using
4619                                        the instrument anymore.</t>
4620                                    </list>
4621                                </t>
4622                                <t>"PERSISTENT" -
4623                                    <list>
4624                                        <t>The instrument will immediately be loaded
4625                                        into memory when this mapping
4626                                        command is sent and the instrument is kept all
4627                                        the time. Instruments with this mode are
4628                                        only freed when the sampler is reset or all
4629                                        mapping entries with this mode (and
4630                                        respective instrument) are explicitly
4631                                        changed to "ON_DEMAND" and no sampler
4632                                        channel is using the instrument anymore.</t>
4633                                    </list>
4634                                </t>
4635                                <t>not supplied -
4636                                    <list>
4637                                        <t>In case there is no &lt;instr_load_mode&gt;
4638                                        argument given, it will be up to the
4639                                        InstrumentManager to decide which mode to use.
4640                                        Usually it will use "ON_DEMAND" if an entry
4641                                        for the given instrument does not exist in
4642                                        the InstrumentManager's list yet, otherwise
4643                                        if an entry already exists, it will simply
4644                                        stick with the mode currently reflected by
4645                                        the already existing entry, that is it will
4646                                        not change the mode.</t>
4647                                    </list>
4648                                </t>
4649                            </list>
4650                        </t>
4651                        <t>
4652                        The &lt;instr_load_mode&gt; argument thus allows to define an
4653                        appropriate strategy (low memory consumption vs. fast
4654                        instrument switching) for each instrument individually. Note, the
4655                        following restrictions apply to this argument: "ON_DEMAND_HOLD" and
4656                        "PERSISTENT" have to be supported by the respective sampler engine
4657                        (which is technically the case when the engine provides an
4658                        InstrumentManager for its format). If this is not the case the
4659                        argument will automatically fall back to the default value
4660                        "ON_DEMAND". Also the load mode of one instrument may
4661                        automatically change the laod mode of other instrument(s), i.e.
4662                        because the instruments are part of the same file and the
4663                        engine does not allow a way to manage load modes for them
4664                        individually. Due to this, in case the frontend shows the
4665                        load modes of entries, the frontend should retrieve the actual
4666                        mode by i.e. sending
4667                        <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
4668                        command(s). Finally the OPTIONAL &lt;name&gt; argument allows to set a custom name
4669                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
4670                        "<xref target="character_set">Character Set and Escape Sequences</xref>") for the
4671                        mapping entry, useful for frontends for displaying an appropriate name for
4672                        mapped instruments (using
4673                        <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
4674                        </t>
4675                        <t>
4676                        By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4677                        completely established in the sampler. The OPTIONAL "NON_MODAL" argument
4678                        however causes the respective "MAP MIDI_INSTRUMENT" command to return
4679                        immediately, that is to let the sampler establish the mapping in the
4680                        background. So this argument might be especially useful for mappings with
4681                        a "PERSISTENT" type, because these have to load the respective instruments
4682                        immediately and might thus block for a very long time. It is recommended
4683                        however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
4684                        because it has the following drawbacks: as "NON_MODAL" instructions return
4685                        immediately, they may not necessarily return an error i.e. when the given
4686                        instrument file turns out to be corrupt, beside that subsequent commands
4687                        in a LSCP instruction sequence might fail, because mandatory mappings are
4688                        not yet completed.
4689                        </t>
4690    
4691                        <t>Possible Answers:</t>
4692                        <t>
4693                            <list>
4694                                <t>"OK" -
4695                                    <list>
4696                                        <t>usually</t>
4697                                    </list>
4698                                </t>
4699                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4700                                    <list>
4701                                        <t>when the given map or engine does not exist or a value
4702                                        is out of range</t>
4703                                    </list>
4704                                </t>
4705                            </list>
4706                        </t>
4707    
4708                        <t>Examples:</t>
4709                        <t>
4710                            <list>
4711                                <t>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"</t>
4712                                <t>S: "OK"</t>
4713                            </list>
4714                        </t>
4715                        <t>
4716                            <list>
4717                                <t>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"</t>
4718                                <t>S: "OK"</t>
4719                            </list>
4720                        </t>
4721                        <t>
4722                            <list>
4723                                <t>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"</t>
4724                                <t>S: "OK"</t>
4725                                <t>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"</t>
4726                                <t>S: "OK"</t>
4727                            </list>
4728                        </t>
4729                        <t>
4730                            <list>
4731                                <t>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>
4732                                <t>S: "OK"</t>
4733                            </list>
4734                        </t>
4735                    </section>
4736    
4737                    <section title="Getting ammount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS">
4738                        <t>The front-end can query the amount of currently existing
4739                        entries in a MIDI instrument map by sending the following
4740                        command:</t>
4741                        <t>
4742                            <list>
4743                                <t>GET MIDI_INSTRUMENTS &lt;map&gt;</t>
4744                            </list>
4745                        </t>
4746                        <t>The front-end can query the amount of currently existing
4747                        entries in all MIDI instrument maps by sending the following
4748                        command:</t>
4749                        <t>
4750                            <list>
4751                                <t>GET MIDI_INSTRUMENTS ALL</t>
4752                            </list>
4753                        </t>
4754                        <t>Possible Answers:</t>
4755                        <t>
4756                            <list>
4757                                <t>The sampler will answer by sending the current number of
4758                                entries in the MIDI instrument map(s).</t>
4759                            </list>
4760                        </t>
4761    
4762                        <t>Example:</t>
4763                        <t>
4764                            <list>
4765                                <t>C: "GET MIDI_INSTRUMENTS 0"</t>
4766                                <t>S: "234"</t>
4767                            </list>
4768                        </t>
4769                        <t>
4770                            <list>
4771                                <t>C: "GET MIDI_INSTRUMENTS ALL"</t>
4772                                <t>S: "954"</t>
4773                            </list>
4774                        </t>
4775                    </section>
4776    
4777                    <section title="Getting indeces of all entries of a MIDI instrument map" anchor="LIST MIDI_INSTRUMENTS">
4778                        <t>The front-end can query a list of all currently existing
4779                        entries in a certain MIDI instrument map by sending the following
4780                        command:</t>
4781                        <t>
4782                            <list>
4783                                <t>LIST MIDI_INSTRUMENTS &lt;map&gt;</t>
4784                            </list>
4785                        </t>
4786                        <t>Where &lt;map&gt; is the numeric ID of the MIDI instrument map.</t>
4787                        <t>The front-end can query a list of all currently existing
4788                        entries of all MIDI instrument maps by sending the following
4789                        command:</t>
4790                        <t>
4791                            <list>
4792                                <t>LIST MIDI_INSTRUMENTS ALL</t>
4793                            </list>
4794                        </t>
4795    
4796                        <t>Possible Answers:</t>
4797                        <t>
4798                            <list>
4799                                <t>The sampler will answer by sending a comma separated
4800                                list of map ID - MIDI bank - MIDI program triples, where
4801                                each triple is encapsulated into curly braces. The
4802                                list is returned in one single line. Each triple
4803                                just reflects the key of the respective map entry,
4804                                thus subsequent
4805                                <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
4806                                command(s) are necessary to retrieve detailed informations
4807                                about each entry.</t>
4808                            </list>
4809                        </t>
4810    
4811                        <t>Example:</t>
4812                        <t>
4813                            <list>
4814                                <t>C: "LIST MIDI_INSTRUMENTS 0"</t>
4815                                <t>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"</t>
4816                            </list>
4817                        </t>
4818                    </section>
4819    
4820                    <section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT">
4821                        <t>The front-end can delete an entry from a MIDI instrument
4822                        map by sending the following command:</t>
4823                        <t>
4824                            <list>
4825                                <t>UNMAP MIDI_INSTRUMENT &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;</t>
4826                            </list>
4827                        </t>
4828                        <t>
4829                        Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
4830                        &lt;midi_bank&gt; is an integer value between 0..16383
4831                        reflecting the MIDI bank value and
4832                        &lt;midi_prog&gt; an integer value between
4833                        0..127 reflecting the MIDI program value of the map's entrie's key
4834                        index triple.
4835                        </t>
4836    
4837                        <t>Possible Answers:</t>
4838                        <t>
4839                            <list>
4840                                <t>"OK" -
4841                                    <list>
4842                                        <t>usually</t>
4843                                    </list>
4844                                </t>
4845                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4846                                    <list>
4847                                        <t>when index out of bounds</t>
4848                                    </list>
4849                                </t>
4850                            </list>
4851                        </t>
4852    
4853                        <t>Example:</t>
4854                        <t>
4855                            <list>
4856                                <t>C: "UNMAP MIDI_INSTRUMENT 0 2 127"</t>
4857                                <t>S: "OK"</t>
4858                            </list>
4859                        </t>
4860                    </section>
4861    
4862                    <section title="Get current settings of MIDI instrument map entry" anchor="GET MIDI_INSTRUMENT INFO">
4863                        <t>The front-end can retrieve the current settings of a certain
4864                        instrument map entry by sending the following command:</t>
4865                        <t>
4866                            <list>
4867                                <t>GET MIDI_INSTRUMENT INFO &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;</t>
4868                            </list>
4869                        </t>
4870                        <t>
4871                        Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
4872                        &lt;midi_bank&gt; is an integer value between 0..16383
4873                        reflecting the MIDI bank value, &lt;midi_bank&gt;
4874                        and &lt;midi_prog&gt; an integer value between
4875                        0..127 reflecting the MIDI program value of the map's entrie's key
4876                        index triple.
4877                        </t>
4878    
4879                        <t>Possible Answers:</t>
4880                        <t>
4881                            <list>
4882                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt;
4883                                separated list. Each answer line begins with the
4884                                information category name followed by a colon and then
4885                                a space character &lt;SP&gt; and finally the info
4886                                character string to that info category. At the moment
4887                                the following categories are defined:</t>
4888                                <t>"NAME" -
4889                                    <list>
4890                                        <t>Name for this MIDI instrument map entry (if defined).
4891                                        This name shall be used by frontends for displaying a
4892                                        name for this mapped instrument. It can be set and
4893                                        changed with the
4894                                        <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref>
4895                                        command and does not have to be unique.
4896                                        (note that this character string may contain
4897                                        <xref target="character_set">escape sequences</xref>)</t>
4898                                    </list>
4899                                </t>
4900                                <t>"ENGINE_NAME" -
4901                                    <list>
4902                                        <t>Name of the engine to be deployed for this
4903                                        instrument.</t>
4904                                    </list>
4905                                </t>
4906                                <t>"INSTRUMENT_FILE" -
4907                                    <list>
4908                                        <t>File name of the instrument
4909                                        (note that this path may contain
4910                                        <xref target="character_set">escape sequences</xref>).</t>
4911                                    </list>
4912                                </t>
4913                                <t>"INSTRUMENT_NR" -
4914                                    <list>
4915                                        <t>Index of the instrument within the file.</t>
4916                                    </list>
4917                                </t>
4918                                <t>"INSTRUMENT_NAME" -
4919                                    <list>
4920                                        <t>Name of the loaded instrument as reflected by its file.
4921                                        In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4922                                        cannot be changed (note that this character string may contain
4923                                        <xref target="character_set">escape sequences</xref>).</t>
4924                                    </list>
4925                                </t>
4926                                <t>"LOAD_MODE" -
4927                                    <list>
4928                                        <t>Life time of instrument
4929                                        (see <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> for details about this setting).</t>
4930                                    </list>
4931                                </t>
4932                                <t>"VOLUME" -
4933                                    <list>
4934                                        <t>master volume of the instrument as optionally
4935                                        dotted number (where a value &lt; 1.0 means attenuation
4936                                        and a value > 1.0 means amplification)</t>
4937                                    </list>
4938                                </t>
4939                                <t>The mentioned fields above don't have to be in particular order.</t>
4940                            </list>
4941                        </t>
4942    
4943                        <t>Example:</t>
4944                        <t>
4945                            <list>
4946                                <t>C: "GET MIDI_INSTRUMENT INFO 1 45 120"</t>
4947                                <t>S: "NAME: Drums for Foo Song"</t>
4948                                <t>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"</t>
4949                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t>
4950                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
4951                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Joe's Drumkit"</t>
4952                                <t>&nbsp;&nbsp;&nbsp;"LOAD_MODE: PERSISTENT"</t>
4953                                <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
4954                                <t>&nbsp;&nbsp;&nbsp;"."</t>
4955                            </list>
4956                        </t>
4957                    </section>
4958    
4959                    <section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS">
4960                        <t>The front-end can clear a whole MIDI instrument map, that
4961                        is delete all its entries by sending the following command:</t>
4962                        <t>
4963                            <list>
4964                                <t>CLEAR MIDI_INSTRUMENTS &lt;map&gt;</t>
4965                            </list>
4966                        </t>
4967                        <t>Where &lt;map&gt; is the numeric ID of the map to clear.</t>
4968                        <t>The front-end can clear all MIDI instrument maps, that
4969                        is delete all entries of all maps by sending the following
4970                        command:</t>
4971                        <t>
4972                            <list>
4973                                <t>CLEAR MIDI_INSTRUMENTS ALL</t>
4974                            </list>
4975                        </t>
4976                        <t>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the
4977                        maps, only their entries, thus the map's settings like
4978                        custom name will be preservevd.</t>
4979    
4980                       <t>Possible Answers:</t>
4981                        <t>
4982                            <list>
4983                                <t>"OK" -
4984                                    <list>
4985                                        <t>always</t>
4986                                    </list>
4987                                </t>
4988                            </list>
4989                        </t>
4990    
4991                        <t>Examples:</t>
4992                        <t>
4993                           <list>
4994                                <t>C: "CLEAR MIDI_INSTRUMENTS 0"</t>
4995                                <t>S: "OK"</t>
4996                            </list>
4997                        </t>
4998                        <t>
4999                           <list>
5000                                <t>C: "CLEAR MIDI_INSTRUMENTS ALL"</t>
5001                                <t>S: "OK"</t>
5002                            </list>
5003                        </t>
5004                    </section>
5005                </section>
5006    
5007    
5008                <section title="Managing Instruments Database" anchor="Managing Instruments Database">
5009                    <t>The following commands describe how to use and manage
5010                    the instruments database.</t>
5011                    <t>Notice:</t>
5012                        <t>
5013                            <list>
5014                                <t>All command arguments representing a path or
5015                                instrument/directory name support escape sequences as described in chapter
5016                                "<xref target="character_set">Character Set and Escape Sequences</xref>".
5017                                </t>
5018                                <t>All occurrences of a forward slash in instrument and directory
5019                                   names are escaped with its hex (\x2f) or octal (\057) escape sequence.
5020                                </t>
5021                            </list>
5022                        </t>
5023    
5024                    <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">
5025                        <t>The front-end can add a new instrument directory to the
5026                        instruments database by sending the following command:</t>
5027                        <t>
5028                            <list>
5029                                <t>ADD DB_INSTRUMENT_DIRECTORY &lt;dir&gt;</t>
5030                            </list>
5031                        </t>
5032                        <t>Where &lt;dir&gt; is the absolute path name of the directory
5033                        to be created (encapsulated into apostrophes).</t>
5034    
5035                        <t>Possible Answers:</t>
5036                        <t>
5037                            <list>
5038                                <t>"OK" -
5039                                    <list>
5040                                        <t>on success</t>
5041                                    </list>
5042                                </t>
5043                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5044                                    <list>
5045                                        <t>when the directory could not be created, which
5046                                        can happen if the directory already exists or the
5047                                        name contains not allowed symbols</t>
5048                                    </list>
5049                                </t>
5050                            </list>
5051                        </t>
5052    
5053                        <t>Examples:</t>
5054                        <t>
5055                            <list>
5056                                <t>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"</t>
5057                                <t>S: "OK"</t>
5058                            </list>
5059                        </t>
5060                    </section>
5061    
5062                    <section title="Deleting an instrument directory" anchor="REMOVE DB_INSTRUMENT_DIRECTORY">
5063                        <t>The front-end can delete a particular instrument directory
5064                        from the instruments database by sending the following command:</t>
5065                        <t>
5066                            <list>
5067                                <t>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] &lt;dir&gt;</t>
5068                            </list>
5069                        </t>
5070                        <t>Where &lt;dir&gt; is the absolute path name of the directory
5071                        to delete. The optional FORCE argument can be used to
5072                        force the deletion of a non-empty directory and all its content.</t>
5073    
5074                        <t>Possible Answers:</t>
5075                        <t>
5076                            <list>
5077                                <t>"OK" -
5078                                    <list>
5079                                        <t>if the directory is deleted successfully</t>
5080                                    </list>
5081                                </t>
5082                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5083                                    <list>
5084                                        <t>if the given directory does not exist, or
5085                                        if trying to delete a non-empty directory,
5086                                        without using the FORCE argument.</t>
5087                                    </list>
5088                                </t>
5089                            </list>
5090                        </t>
5091    
5092                        <t>Examples:</t>
5093                        <t>
5094                            <list>
5095                                <t>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"</t>
5096                                <t>S: "OK"</t>
5097                            </list>
5098                        </t>
5099                    </section>
5100    
5101                    <section title="Getting amount of instrument directories" anchor="GET DB_INSTRUMENT_DIRECTORIES">
5102                        <t>The front-end can retrieve the current amount of
5103                        directories in a specific directory by sending the following command:</t>
5104                        <t>
5105                            <list>
5106                                <t>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
5107                            </list>
5108                        </t>
5109                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5110                        name of the directory. If RECURSIVE is specified, the number of
5111                        all directories, including those located in subdirectories of the
5112                        specified directory, will be returned.</t>
5113    
5114                        <t>Possible Answers:</t>
5115                        <t>
5116                            <list>
5117                                <t>The current number of instrument directories
5118                                in the specified directory.</t>
5119                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5120                                    <list>
5121                                        <t>if the given directory does not exist.</t>
5122                                    </list>
5123                                </t>
5124                            </list>
5125                        </t>
5126    
5127                        <t>Example:</t>
5128                        <t>
5129                            <list>
5130                                <t>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"</t>
5131                                <t>S: "2"</t>
5132                            </list>
5133                        </t>
5134                    </section>
5135    
5136                    <section title="Listing all directories in specific directory" anchor="LIST DB_INSTRUMENT_DIRECTORIES">
5137                        <t>The front-end can retrieve the current list of directories
5138                        in specific directory by sending the following command:</t>
5139                        <t>
5140                            <list>
5141                                <t>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
5142                            </list>
5143                        </t>
5144                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5145                        name of the directory. If RECURSIVE is specified, the absolute path names
5146                        of all directories, including those located in subdirectories of the
5147                        specified directory, will be returned.</t>
5148    
5149                        <t>Possible Answers:</t>
5150                        <t>
5151                            <list>
5152                                <t>A comma separated list of all instrument directories
5153                                (encapsulated into apostrophes) in the specified directory.</t>
5154                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5155                                    <list>
5156                                        <t>if the given directory does not exist.</t>
5157                                    </list>
5158                                </t>
5159                            </list>
5160                        </t>
5161                        <t>Example:</t>
5162                        <t>
5163                            <list>
5164                                <t>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"</t>
5165                                <t>S: "'Piano Collection','Percussion Collection'"</t>
5166                            </list>
5167                        </t>
5168                        <t>
5169                            <list>
5170                                <t>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"</t>
5171                                <t>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"</t>
5172                            </list>
5173                        </t>
5174                    </section>
5175    
5176                    <section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO">
5177                        <t>The front-end can ask for the current settings of an
5178                        instrument directory by sending the following command:</t>
5179                        <t>
5180                            <list>
5181                                <t>GET DB_INSTRUMENT_DIRECTORY INFO &lt;dir&gt;</t>
5182                            </list>
5183                        </t>
5184                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5185                        name of the directory the front-end is interested in.</t>
5186    
5187                        <t>Possible Answers:</t>
5188                        <t>
5189                            <list>
5190                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5191                                Each answer line begins with the settings category name
5192                                followed by a colon and then a space character &lt;SP&gt; and finally
5193                                the info character string to that setting category. At the
5194                                moment the following categories are defined:</t>
5195    
5196                                <t>
5197                                    <list>
5198                                        <t>DESCRIPTION -
5199                                            <list>
5200                                                <t>A brief description of the directory content.
5201                                                Note that the character string may contain
5202                                                <xref target="character_set">escape sequences</xref>.</t>
5203                                            </list>
5204                                        </t>
5205                                        <t>CREATED -
5206                                            <list>
5207                                                <t>The creation date and time of the directory,
5208                                                represented in "YYYY-MM-DD HH:MM:SS" format</t>
5209                                            </list>
5210                                        </t>
5211                                        <t>MODIFIED -
5212                                            <list>
5213                                                <t>The date and time of the last modification of the
5214                                                directory, represented in "YYYY-MM-DD HH:MM:SS" format</t>
5215                                            </list>
5216                                        </t>
5217                                    </list>
5218                                </t>
5219                            </list>
5220                        </t>
5221                        <t>The mentioned fields above don't have to be in particular order.</t>
5222    
5223                        <t>Example:</t>
5224                        <t>
5225                            <list>
5226                                <t>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"</t>
5227                                <t>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."</t>
5228                                <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
5229                                <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
5230                                <t>&nbsp;&nbsp;&nbsp;"."</t>
5231                            </list>
5232                        </t>
5233                    </section>
5234    
5235                    <section title="Renaming an instrument directory" anchor="SET DB_INSTRUMENT_DIRECTORY NAME">
5236                        <t>The front-end can alter the name of a specific
5237                        instrument directory by sending the following command:</t>
5238                        <t>
5239                            <list>
5240                                <t>SET DB_INSTRUMENT_DIRECTORY NAME &lt;dir&gt; &lt;name&gt;</t>
5241                            </list>
5242                        </t>
5243                        <t>Where &lt;dir&gt; is the absolute path name of the directory and
5244                        &lt;name&gt; is the new name for that directory.</t>
5245    
5246                        <t>Possible Answers:</t>
5247                        <t>
5248                            <list>
5249                                <t>"OK" -
5250                                    <list>
5251                                        <t>on success</t>
5252                                    </list>
5253                                </t>
5254                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5255                                    <list>
5256                                        <t>in case the given directory does not exists,
5257                                        or if a directory with name equal to the new
5258                                        name already exists.</t>
5259                                    </list>
5260                                </t>
5261                            </list>
5262                        </t>
5263    
5264                        <t>Example:</t>
5265                        <t>
5266                            <list>
5267                                <t>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"</t>
5268                                <t>S: "OK"</t>
5269                            </list>
5270                        </t>
5271                    </section>
5272    
5273                    <section title="Moving an instrument directory" anchor="MOVE DB_INSTRUMENT_DIRECTORY">
5274                        <t>The front-end can move a specific
5275                        instrument directory by sending the following command:</t>
5276                        <t>
5277                            <list>
5278                                <t>MOVE DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5279                            </list>
5280                        </t>
5281                        <t>Where &lt;dir&gt; is the absolute path name of the directory
5282                        to move and &lt;dst&gt; is the location where the directory will
5283                        be moved to.</t>
5284    
5285                        <t>Possible Answers:</t>
5286                        <t>
5287                            <list>
5288                                <t>"OK" -
5289                                    <list>
5290                                        <t>on success</t>
5291                                    </list>
5292                                </t>
5293                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5294                                    <list>
5295                                        <t>in case a given directory does not exists,
5296                                        or if a directory with name equal to the name
5297                                        of the specified directory already exists in
5298                                        the destination directory. Error is also thrown
5299                                        when trying to move a directory to a subdirectory
5300                                        of itself.</t>
5301                                    </list>
5302                                </t>
5303                            </list>
5304                        </t>
5305    
5306                        <t>Example:</t>
5307                        <t>
5308                            <list>
5309                                <t>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"</t>
5310                                <t>S: "OK"</t>
5311                            </list>
5312                        </t>
5313                    </section>
5314    
5315                    <section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY">
5316                        <t>The front-end can copy a specific
5317                        instrument directory by sending the following command:</t>
5318                        <t>
5319                            <list>
5320                                <t>COPY DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5321                            </list>
5322                        </t>
5323                        <t>Where &lt;dir&gt; is the absolute path name of the directory
5324                        to copy and &lt;dst&gt; is the location where the directory will
5325                        be copied to.</t>
5326    
5327                        <t>Possible Answers:</t>
5328                        <t>
5329                            <list>
5330                                <t>"OK" -
5331                                    <list>
5332                                        <t>on success</t>
5333                                    </list>
5334                                </t>
5335                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5336                                    <list>
5337                                        <t>in case a given directory does not exists,
5338                                        or if a directory with name equal to the name
5339                                        of the specified directory already exists in
5340                                        the destination directory. Error is also thrown
5341                                        when trying to copy a directory to a subdirectory
5342                                        of itself.</t>
5343                                    </list>
5344                                </t>
5345                            </list>
5346                        </t>
5347    
5348                        <t>Example:</t>
5349                        <t>
5350                            <list>
5351                                <t>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"</t>
5352                                <t>S: "OK"</t>
5353                            </list>
5354                        </t>
5355                    </section>
5356    
5357                    <section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">
5358                        <t>The front-end can alter the description of a specific
5359                        instrument directory by sending the following command:</t>
5360                        <t>
5361                            <list>
5362                                <t>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION &lt;dir&gt; &lt;desc&gt;</t>
5363                            </list>
5364                        </t>
5365                        <t>Where &lt;dir&gt; is the absolute path name of the directory and
5366                        &lt;desc&gt; is the new description for the directory
5367                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
5368                        "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5369    
5370                        <t>Possible Answers:</t>
5371                        <t>
5372                            <list>
5373                                <t>"OK" -
5374                                    <list>
5375                                        <t>on success</t>
5376                                    </list>
5377                                </t>
5378                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5379                                    <list>
5380                                        <t>in case the given directory does not exists.</t>
5381                                    </list>
5382                                </t>
5383                            </list>
5384                        </t>
5385    
5386                        <t>Example:</t>
5387                        <t>
5388                            <list>
5389                                <t>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"</t>
5390                                <t>S: "OK"</t>
5391                            </list>
5392                        </t>
5393                    </section>
5394    
5395                    <section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES">
5396                        <t>The front-end can search for directories
5397                        in specific directory by sending the following command:</t>
5398                        <t>
5399                            <list>
5400                                <t>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5401                            </list>
5402                        </t>
5403                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5404                        name of the directory to search in. If NON_RECURSIVE is specified, the
5405                        directories located in subdirectories of the specified directory will not
5406                        be searched. &lt;criteria-list&gt; is a list of search criterias
5407                        in form of "key1=val1 key2=val2 ...". The following criterias are
5408                        allowed:</t>
5409                        <t>
5410                          <t>NAME='&lt;search-string&gt;'
5411                              <list>
5412                                  <t>Restricts the search to directories, which names
5413                                  satisfy the supplied search string (encapsulated into apostrophes,
5414                                  supporting escape sequences as described in chapter
5415                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5416                              </list>
5417                          </t>
5418    
5419                          <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5420                              <list>
5421                                  <t>Restricts the search to directories, which creation
5422                                  date satisfies the specified period, where &lt;date-after&gt;
5423                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5424                                  If &lt;date-after&gt; is omitted the search is restricted to
5425                                  directories created before &lt;date-before&gt;. If
5426                                  &lt;date-before&gt; is omitted, the search is restricted
5427                                  to directories created after &lt;date-after&gt;.</t>
5428                              </list>
5429                          </t>
5430    
5431                          <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5432                              <list>
5433                                  <t>Restricts the search to directories, which
5434                                  date of last modification satisfies the specified period, where
5435                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5436                                  format. If &lt;date-after&gt; is omitted the search is restricted to
5437                                  directories, which are last modified before &lt;date-before&gt;. If
5438                                  &lt;date-before&gt; is omitted, the search is restricted to directories,
5439                                  which are last modified after &lt;date-after&gt;.</t>
5440                              </list>
5441                          </t>
5442    
5443                          <t>DESCRIPTION='&lt;search-string&gt;'
5444                              <list>
5445                                  <t>Restricts the search to directories with description
5446                                  that satisfies the supplied search string
5447                                  (encapsulated into apostrophes, supporting escape
5448                                  sequences as described in chapter
5449                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5450                              </list>
5451                          </t>
5452                        </t>
5453    
5454                        <t>Where &lt;search-string&gt; is either a regular expression, or a
5455                        word list separated with spaces for OR search and with '+' for AND search.</t>
5456    
5457                        <t>Possible Answers:</t>
5458                        <t>
5459                            <list>
5460                                <t>A comma separated list with the absolute path names (encapsulated into
5461                                apostrophes) of all directories in the specified directory that satisfy
5462                                the supplied search criterias.</t>
5463                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5464                                    <list>
5465                                        <t>if the given directory does not exist.</t>
5466                                    </list>
5467                                </t>
5468                            </list>
5469                        </t>
5470                        <t>Example:</t>
5471                        <t>
5472                            <list>
5473                                <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"</t>
5474                                <t>S: "'/Piano Collection'"</t>
5475                            </list>
5476                        </t>
5477                        <t>
5478                            <list>
5479                                <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"</t>
5480                                <t>S: "'/Piano Collection','/Percussions'"</t>
5481                            </list>
5482                        </t>
5483                    </section>
5484    
5485                    <section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS">
5486                        <t>The front-end can add one or more instruments
5487                        to the instruments database by sending the following command:</t>
5488                        <t>
5489                            <list>
5490                                <t>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;[ FILE_AS_DIR]] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]</t>
5491                            </list>
5492                        </t>
5493                        <t>Where &lt;db_dir&gt; is the absolute path name of a directory
5494                        (encapsulated into apostrophes) in the instruments database in which
5495                        only the new instruments (that are not already in the database) will
5496                        be added, &lt;file_path&gt; is the absolute path name of a file or
5497                        directory in the file system (encapsulated into apostrophes). In case
5498                        an instrument file is supplied, only the instruments in the specified
5499                        file will be added to the instruments database. If the optional
5500                        &lt;instr_index&gt; (the index of the instrument within the given file)
5501                        is supplied too, then only the specified instrument will be added.
5502                        In case a directory is supplied, the instruments in that directory
5503                        will be added. The OPTIONAL &lt;mode&gt; argument is only applied
5504                        when a directory is provided as &lt;file_path&gt; and specifies how the
5505                        scanning will be done and has exactly the following possibilities:</t>
5506                        <t>
5507                            <list>
5508                                <t>"RECURSIVE" -
5509                                    <list>
5510                                        <t>All instruments will be processed, including those
5511                                        in the subdirectories, and the respective subdirectory
5512                                        tree structure will be recreated in the instruments
5513                                        database</t>
5514                                    </list>
5515                                </t>
5516                                <t>"NON_RECURSIVE" -
5517                                    <list>
5518                                        <t>Only the instruments in the specified directory
5519                                        will be added, the instruments in the subdirectories
5520                                        will not be processed.</t>
5521                                    </list>
5522                                </t>
5523                                <t>"FLAT" -
5524                                    <list>
5525                                        <t>All instruments will be processed, including those
5526                                        in the subdirectories, but the respective subdirectory
5527                                        structure will not be recreated in the instruments
5528                                        database. All instruments will be added directly in
5529                                        the specified database directory.</t>
5530                                    </list>
5531                                </t>
5532                            </list>
5533                        </t>
5534    
5535                     <t> If FILE_AS_DIR argument is supplied, all instruments in an instrument
5536                     file will be added to a separate directory in the instruments database, which
5537                     name will be the name of the instrument file with the file extension stripped off.
5538                     </t>
5539                     <t>The difference between regular and NON_MODAL versions of the command
5540                        is that the regular command returns when the scanning is finished
5541                        while NON_MODAL version returns immediately and a background process is launched.
5542                        The <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref>
5543                        command can be used to monitor the scanning progress.</t>
5544    
5545                        <t>Possible Answers:</t>
5546                        <t>
5547                            <list>
5548                                <t>"OK" -
5549                                    <list>
5550                                        <t>on success when NON_MODAL is not supplied</t>
5551                                    </list>
5552                                </t>
5553                                <t>"OK[&lt;job-id&gt;]" -
5554                                    <list>
5555                                        <t>on success when NON_MODAL is supplied, where &lt;job-id&gt;
5556                                        is a numerical ID used to obtain status information about the job progress.
5557                                        See <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref>
5558                                        </t>
5559                                    </list>
5560                                </t>
5561                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5562                                    <list>
5563                                        <t>if an invalid path is specified.</t>
5564                                    </list>
5565                                </t>
5566                            </list>
5567                        </t>
5568    
5569                        <t>Examples:</t>
5570                        <t>
5571                            <list>
5572                                <t>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"</t>
5573                                <t>S: "OK"</t>
5574                            </list>
5575                        </t>
5576                    </section>
5577    
5578                    <section title="Removing an instrument" anchor="REMOVE DB_INSTRUMENT">
5579                        <t>The front-end can remove a particular instrument
5580                        from the instruments database by sending the following command:</t>
5581                        <t>
5582                            <list>
5583                                <t>REMOVE DB_INSTRUMENT &lt;instr_path&gt;</t>
5584                            </list>
5585                        </t>
5586                        <t>Where &lt;instr_path&gt; is the absolute path name
5587                        (in the instruments database) of the instrument to remove.</t>
5588    
5589                        <t>Possible Answers:</t>
5590                        <t>
5591                            <list>
5592                                <t>"OK" -
5593                                    <list>
5594                                        <t>if the instrument is removed successfully</t>
5595                                    </list>
5596                                </t>
5597                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5598                                    <list>
5599                                        <t>if the given path does not exist or
5600                                        is a directory.</t>
5601                                    </list>
5602                                </t>
5603                            </list>
5604                        </t>
5605    
5606                        <t>Examples:</t>
5607                        <t>
5608                            <list>
5609                                <t>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"</t>
5610                                <t>S: "OK"</t>
5611                            </list>
5612                        </t>
5613                    </section>
5614    
5615                    <section title="Getting amount of instruments" anchor="GET DB_INSTRUMENTS">
5616                        <t>The front-end can retrieve the current amount of
5617                        instruments in a specific directory by sending the following command:</t>
5618                        <t>
5619                            <list>
5620                                <t>GET DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5621                            </list>
5622                        </t>
5623                        <t>Where &lt;dir&gt; should be replaced by the absolute path name
5624                        of the directory. If RECURSIVE is specified, the number of all
5625                        instruments, including those located in subdirectories of the
5626                        specified directory, will be returned.</t>
5627    
5628                        <t>Possible Answers:</t>
5629                        <t>
5630                            <list>
5631                                <t>The current number of instruments
5632                                in the specified directory.</t>
5633                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5634                                    <list>
5635                                        <t>if the given directory does not exist.</t>
5636                                    </list>
5637                                </t>
5638                            </list>
5639                        </t>
5640    
5641                        <t>Example:</t>
5642                        <t>
5643                            <list>
5644                                <t>C: "GET DB_INSTRUMENTS '/Piano Collection'"</t>
5645                                <t>S: "2"</t>
5646                            </list>
5647                        </t>
5648                    </section>
5649    
5650                    <section title="Listing all instruments in specific directory" anchor="LIST DB_INSTRUMENTS">
5651                        <t>The front-end can retrieve the current list of instruments
5652                        in specific directory by sending the following command:</t>
5653                        <t>
5654                            <list>
5655                                <t>LIST DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5656                            </list>
5657                        </t>
5658                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5659                        name of the directory. If RECURSIVE is specified, the absolute path
5660                        names of all instruments, including those located in subdirectories
5661                        of the specified directory, will be returned.</t>
5662    
5663                        <t>Possible Answers:</t>
5664                        <t>
5665                            <list>
5666                                <t>A comma separated list of all instruments
5667                                (encapsulated into apostrophes) in the specified directory.</t>
5668                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5669                                    <list>
5670                                        <t>if the given directory does not exist.</t>
5671                                    </list>
5672                                </t>
5673                            </list>
5674                        </t>
5675                        <t>Example:</t>
5676                        <t>
5677                            <list>
5678                                <t>C: "LIST DB_INSTRUMENTS '/Piano Collection'"</t>
5679                                <t>S: "'Bosendorfer 290','Steinway D'"</t>
5680                            </list>
5681                        </t>
5682                        <t>
5683                            <list>
5684                                <t>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"</t>
5685                                <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"</t>
5686                            </list>
5687                        </t>
5688                    </section>
5689    
5690                    <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO">
5691                        <t>The front-end can ask for the current settings of an
5692                        instrument by sending the following command:</t>
5693                        <t>
5694                            <list>
5695                                <t>GET DB_INSTRUMENT INFO &lt;instr_path&gt;</t>
5696                            </list>
5697                        </t>
5698                        <t>Where &lt;instr_path&gt; should be replaced by the absolute path
5699                        name of the instrument the front-end is interested in.</t>
5700    
5701                        <t>Possible Answers:</t>
5702                        <t>
5703                            <list>
5704                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5705                                Each answer line begins with the settings category name
5706                                followed by a colon and then a space character &lt;SP&gt; and finally
5707                                the info character string to that setting category. At the
5708                                moment the following categories are defined:</t>
5709    
5710                                <t>
5711                                    <list>
5712                                        <t>INSTRUMENT_FILE -
5713                                            <list>
5714                                                <t>File name of the instrument.
5715                                                Note that the character string may contain
5716                                                <xref target="character_set">escape sequences</xref>.</t>
5717                                            </list>
5718                                        </t>
5719                                        <t>INSTRUMENT_NR -
5720                                            <list>
5721                                                <t>Index of the instrument within the file.</t>
5722                                            </list>
5723                                        </t>
5724                                        <t>FORMAT_FAMILY -
5725                                            <list>
5726                                                <t>The format family of the instrument.</t>
5727                                            </list>
5728                                        </t>
5729                                        <t>FORMAT_VERSION -
5730                                            <list>
5731                                                <t>The format version of the instrument.</t>
5732                                            </list>
5733                                        </t>
5734                                        <t>SIZE -
5735                                            <list>
5736                                                <t>The size of the instrument in bytes.</t>
5737                                            </list>
5738                                        </t>
5739                                        <t>CREATED -
5740                                            <list>
5741                                                <t>The date and time when the instrument is added
5742                                                in the instruments database, represented in
5743                                               "YYYY-MM-DD HH:MM:SS" format</t>
5744                                            </list>
5745                                        </t>
5746                                        <t>MODIFIED -
5747                                            <list>
5748                                                <t>The date and time of the last modification of the
5749                                                instrument's database settings, represented in
5750                                                "YYYY-MM-DD HH:MM:SS" format</t>
5751                                            </list>
5752                                        </t>
5753                                        <t>DESCRIPTION -
5754                                            <list>
5755                                                <t>A brief description of the instrument.
5756                                                Note that the character string may contain
5757                                                <xref target="character_set">escape sequences</xref>.</t>
5758                                            </list>
5759                                        </t>
5760                                        <t>IS_DRUM -
5761                                            <list>
5762                                                <t>either true or false, determines whether the
5763                                                instrument is a drumkit or a chromatic instrument</t>
5764                                            </list>
5765                                        </t>
5766                                        <t>PRODUCT -
5767                                            <list>
5768                                                <t>The product title of the instrument.
5769                                                Note that the character string may contain
5770                                                <xref target="character_set">escape sequences</xref>.</t>
5771                                            </list>
5772                                        </t>
5773                                        <t>ARTISTS -
5774                                            <list>
5775                                                <t>Lists the artist names.
5776                                                Note that the character string may contain
5777                                                <xref target="character_set">escape sequences</xref>.</t>
5778                                            </list>
5779                                        </t>
5780                                        <t>KEYWORDS -
5781                                            <list>
5782                                                <t>Provides a list of keywords that refer to the instrument.
5783                                                Keywords are separated with semicolon and blank.
5784                                                Note that the character string may contain
5785                                                <xref target="character_set">escape sequences</xref>.</t>
5786                                            </list>
5787                                        </t>
5788                                    </list>
5789                                </t>
5790                            </list>
5791                        </t>
5792                        <t>The mentioned fields above don't have to be in particular order.</t>
5793    
5794                        <t>Example:</t>
5795                        <t>
5796                            <list>
5797                                <t>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"</t>
5798                                <t>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"</t>
5799                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
5800                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
5801                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 2"</t>
5802                                <t>&nbsp;&nbsp;&nbsp;"SIZE: 2050871870"</t>
5803                                <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
5804                                <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
5805                                <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: "</t>
5806                                <t>&nbsp;&nbsp;&nbsp;"IS_DRUM: false"</t>
5807                                <t>&nbsp;&nbsp;&nbsp;"PRODUCT: GRANDIOSO Bosendorfer 290"</t>
5808                                <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Post Musical Instruments"</t>
5809                                <t>&nbsp;&nbsp;&nbsp;"KEYWORDS: Bosendorfer"</t>
5810                                <t>&nbsp;&nbsp;&nbsp;"."</t>
5811                            </list>
5812                        </t>
5813                    </section>
5814    
5815                    <section title="Renaming an instrument" anchor="SET DB_INSTRUMENT NAME">
5816                        <t>The front-end can alter the name of a specific
5817                        instrument by sending the following command:</t>
5818                        <t>
5819                            <list>
5820                                <t>SET DB_INSTRUMENT NAME &lt;instr&gt; &lt;name&gt;</t>
5821                            </list>
5822                        </t>
5823                        <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5824                        &lt;name&gt; is the new name for that instrument.</t>
5825    
5826                        <t>Possible Answers:</t>
5827                        <t>
5828                            <list>
5829                                <t>"OK" -
5830                                    <list>
5831                                        <t>on success</t>
5832                                    </list>
5833                                </t>
5834                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5835                                    <list>
5836                                        <t>in case the given instrument does not exists,
5837                                        or if an instrument with name equal to the new
5838                                        name already exists.</t>
5839                                    </list>
5840                                </t>
5841                            </list>
5842                        </t>
5843    
5844                        <t>Example:</t>
5845                        <t>
5846                            <list>
5847                                <t>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"</t>
5848                                <t>S: "OK"</t>
5849                            </list>
5850                        </t>
5851                    </section>
5852    
5853                    <section title="Moving an instrument" anchor="MOVE DB_INSTRUMENT">
5854                        <t>The front-end can move a specific instrument to another directory by
5855                        sending the following command:</t>
5856                        <t>
5857                            <list>
5858                                <t>MOVE DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5859                            </list>
5860                        </t>
5861                        <t>Where &lt;instr&gt; is the absolute path name of the instrument
5862                        to move and &lt;dst&gt; is the directory where the instrument will
5863                        be moved to.</t>
5864    
5865                        <t>Possible Answers:</t>
5866                        <t>
5867                            <list>
5868                                <t>"OK" -
5869                                    <list>
5870                                        <t>on success</t>
5871                                    </list>
5872                                </t>
5873                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5874                                    <list>
5875                                        <t>in case the given instrument does not exists,
5876                                        or if an instrument with name equal to the name of the
5877                                        specified instrument already exists in the destination
5878                                        directory.</t>
5879                                    </list>
5880                                </t>
5881                            </list>
5882                        </t>
5883    
5884                        <t>Example:</t>
5885                        <t>
5886                            <list>
5887                                <t>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"</t>
5888                                <t>S: "OK"</t>
5889                            </list>
5890                        </t>
5891                    </section>
5892    
5893                    <section title="Copying instruments" anchor="COPY DB_INSTRUMENT">
5894                        <t>The front-end can copy a specific instrument to another directory by
5895                        sending the following command:</t>
5896                        <t>
5897                            <list>
5898                                <t>COPY DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5899                            </list>
5900                        </t>
5901                        <t>Where &lt;instr&gt; is the absolute path name of the instrument
5902                        to copy and &lt;dst&gt; is the directory where the instrument will
5903                        be copied to.</t>
5904    
5905                        <t>Possible Answers:</t>
5906                        <t>
5907                            <list>
5908                                <t>"OK" -
5909                                    <list>
5910                                        <t>on success</t>
5911                                    </list>
5912                                </t>
5913                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5914                                    <list>
5915                                        <t>in case the given instrument does not exists,
5916                                        or if an instrument with name equal to the name of the
5917                                        specified instrument already exists in the destination
5918                                        directory.</t>
5919                                    </list>
5920                                </t>
5921                            </list>
5922                        </t>
5923    
5924                        <t>Example:</t>
5925                        <t>
5926                            <list>
5927                                <t>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"</t>
5928                                <t>S: "OK"</t>
5929                            </list>
5930                        </t>
5931                    </section>
5932    
5933                    <section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION">
5934                        <t>The front-end can alter the description of a specific
5935                        instrument by sending the following command:</t>
5936                        <t>
5937                            <list>
5938                                <t>SET DB_INSTRUMENT DESCRIPTION &lt;instr&gt; &lt;desc&gt;</t>
5939                            </list>
5940                        </t>
5941                        <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5942                        &lt;desc&gt; is the new description for the instrument
5943                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
5944                        "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5945    
5946                        <t>Possible Answers:</t>
5947                        <t>
5948                            <list>
5949                                <t>"OK" -
5950                                    <list>
5951                                        <t>on success</t>
5952                                    </list>
5953                                </t>
5954                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5955                                    <list>
5956                                        <t>in case the given instrument does not exists.</t>
5957                                    </list>
5958                                </t>
5959                            </list>
5960                        </t>
5961    
5962                        <t>Example:</t>
5963                        <t>
5964                            <list>
5965                                <t>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"</t>
5966                                <t>S: "OK"</t>
5967                            </list>
5968                        </t>
5969                    </section>
5970    
5971                    <section title="Finding instruments" anchor="FIND DB_INSTRUMENTS">
5972                        <t>The front-end can search for instruments
5973                        in specific directory by sending the following command:</t>
5974                        <t>
5975                            <list>
5976                                <t>FIND DB_INSTRUMENTS [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5977                            </list>
5978                        </t>
5979                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5980                        name of the directory to search in. If NON_RECURSIVE is specified, the
5981                        directories located in subdirectories of the specified directory will not
5982                        be searched. &lt;criteria-list&gt; is a list of search criterias
5983                        in form of "key1=val1 key2=val2 ...". The following criterias are
5984                        allowed:</t>
5985                        <t>
5986                          <t>NAME='&lt;search-string&gt;'
5987                              <list>
5988                                  <t>Restricts the search to instruments, which names
5989                                  satisfy the supplied search string (encapsulated into apostrophes,
5990                                  supporting escape sequences as described in chapter
5991                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5992                              </list>
5993                          </t>
5994    
5995                          <t>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
5996                              <list>
5997                                  <t>Restricts the search to instruments, which
5998                                  size is in the specified range. If &lt;min&gt; is omitted,
5999                                  the search results are restricted to instruments with size less then
6000                                  or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
6001                                  search is restricted to instruments with size greater then
6002                                  or equal to &lt;min&gt;.</t>
6003                              </list>
6004                          </t>
6005    
6006                          <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
6007                              <list>
6008                                  <t>Restricts the search to instruments, which creation
6009                                  date satisfies the specified period, where &lt;date-after&gt;
6010                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
6011                                  If &lt;date-after&gt; is omitted the search is restricted to
6012                                  instruments created before &lt;date-before&gt;. If
6013                                  &lt;date-before&gt; is omitted, the search is restricted
6014                                  to instruments created after &lt;date-after&gt;.</t>
6015                              </list>
6016                          </t>
6017    
6018                          <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
6019                              <list>
6020                                  <t>Restricts the search to instruments, which
6021                                  date of last modification satisfies the specified period, where
6022                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
6023                                  format. If &lt;date-after&gt; is omitted the search is restricted to
6024                                  instruments, which are last modified before &lt;date-before&gt;. If
6025                                  &lt;date-before&gt; is omitted, the search is restricted to instruments,
6026                                  which are last modified after &lt;date-after&gt;.</t>
6027                              </list>
6028                          </t>
6029    
6030                          <t>DESCRIPTION='&lt;search-string&gt;'
6031                              <list>
6032                                  <t>Restricts the search to instruments with description
6033                                  that satisfies the supplied search string (encapsulated into apostrophes,
6034                                  supporting escape sequences as described in chapter
6035                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
6036                              </list>
6037                          </t>
6038    
6039                          <t>PRODUCT='&lt;search-string&gt;'
6040                              <list>
6041                                  <t>Restricts the search to instruments with product info
6042                                  that satisfies the supplied search string (encapsulated into apostrophes,
6043                                  supporting escape sequences as described in chapter
6044                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
6045                              </list>
6046                          </t>
6047    
6048                          <t>ARTISTS='&lt;search-string&gt;'
6049                              <list>
6050                                  <t>Restricts the search to instruments with artists info
6051                                  that satisfies the supplied search string (encapsulated into apostrophes,
6052                                  supporting escape sequences as described in chapter
6053                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
6054                              </list>
6055                          </t>
6056    
6057                          <t>KEYWORDS='&lt;search-string&gt;'
6058                              <list>
6059                                  <t>Restricts the search to instruments with keyword list
6060                                  that satisfies the supplied search string (encapsulated into apostrophes,
6061                                  supporting escape sequences as described in chapter
6062                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
6063                              </list>
6064                          </t>
6065    
6066                          <t>IS_DRUM=true | false
6067                              <list>
6068                                  <t>Either true or false. Restricts the search to
6069                                  drum kits or chromatic instruments.</t>
6070                              </list>
6071                          </t>
6072    
6073                          <t>FORMAT_FAMILIES='&lt;format-list&gt;'
6074                              <list>
6075                                  <t>Restricts the search to instruments of the supplied format families,
6076                                  where &lt;format-list&gt; is a comma separated list of format families.</t>
6077                              </list>
6078                          </t>
6079                        </t>
6080    
6081                        <t>Where &lt;search-string&gt; is either a regular expression, or a
6082                        word list separated with spaces for OR search and with '+' for AND search.</t>
6083    
6084                        <t>Possible Answers:</t>
6085                        <t>
6086                            <list>
6087                                <t>A comma separated list with the absolute path names (encapsulated into
6088                                apostrophes) of all instruments in the specified directory that satisfy
6089                                the supplied search criterias.</t>
6090                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6091                                    <list>
6092                                        <t>if the given directory does not exist.</t>
6093                                    </list>
6094                                </t>
6095                            </list>
6096                        </t>
6097                        <t>Example:</t>
6098                        <t>
6099                            <list>
6100                                <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"</t>
6101                                <t>S: "'/Piano Collection/Bosendorfer 290'"</t>
6102                            </list>
6103                        </t>
6104                        <t>
6105                            <list>
6106                                <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"</t>
6107                                <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"</t>
6108                            </list>
6109                        </t>
6110                    </section>
6111    
6112                    <section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO">
6113                        <t>The front-end can ask for the current status of a
6114                        particular database instruments job by sending the following command:</t>
6115                        <t>
6116                            <list>
6117                                <t>GET DB_INSTRUMENTS_JOB INFO &lt;job-id&gt;</t>
6118                            </list>
6119                        </t>
6120                        <t>Where &lt;job-id&gt; should be replaced by the numerical ID
6121                        of the job the front-end is interested in.</t>
6122    
6123                        <t>Possible Answers:</t>
6124                        <t>
6125                            <list>
6126                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6127                                Each answer line begins with the settings category name
6128                                followed by a colon and then a space character &lt;SP&gt; and finally
6129                                the info character string to that setting category. At the
6130                                moment the following categories are defined:</t>
6131    
6132                                <t>
6133                                    <list>
6134                                        <t>FILES_TOTAL -
6135                                            <list>
6136                                                <t>The total number of files scheduled for scanning</t>
6137                                            </list>
6138                                        </t>
6139                                        <t>FILES_SCANNED -
6140                                            <list>
6141                                                <t>The current number of scanned files</t>
6142                                            </list>
6143                                        </t>
6144                                        <t>SCANNING -
6145                                            <list>
6146                                                <t>The absolute path name of the file which is currently
6147                                                being scanned</t>
6148                                            </list>
6149                                        </t>
6150                                        <t>STATUS -
6151                                            <list>
6152                                                <t>An integer value between 0 and 100 indicating the
6153                                                scanning progress percentage of the file which is
6154                                                currently being scanned</t>
6155                                            </list>
6156                                        </t>
6157                                    </list>
6158                                </t>
6159                            </list>
6160                        </t>
6161                        <t>The mentioned fields above don't have to be in particular order.</t>
6162    
6163                        <t>Example:</t>
6164                        <t>
6165                            <list>
6166                                <t>C: "GET DB_INSTRUMENTS_JOB INFO 2"</t>
6167                                <t>S: "FILES_TOTAL: 12"</t>
6168                                <t>&nbsp;&nbsp;&nbsp;"FILES_SCANNED: 7"</t>
6169                                <t>&nbsp;&nbsp;&nbsp;"SCANNING: /home/me/gigs/Bosendorfer 290.gig"</t>
6170                                <t>&nbsp;&nbsp;&nbsp;"STATUS: 42"</t>
6171                                <t>&nbsp;&nbsp;&nbsp;"."</t>
6172                            </list>
6173                        </t>
6174                    </section>
6175    
6176                    <section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB">
6177                        <t>The front-end can remove all instruments and directories and re-create
6178                        the instruments database structure (e.g., in case of a database corruption)
6179                        by sending the following command:</t>
6180                        <t>
6181                            <list>
6182                                <t>FORMAT INSTRUMENTS_DB</t>
6183                            </list>
6184                        </t>
6185    
6186                        <t>Possible Answers:</t>
6187                        <t>
6188                            <list>
6189                                <t>"OK" -
6190                                    <list>
6191                                        <t>on success</t>
6192                                    </list>
6193                                </t>
6194                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6195                                    <list>
6196                                        <t>If the formatting of the instruments database
6197                                        failed.</t>
6198                                    </list>
6199                                </t>
6200                            </list>
6201                        </t>
6202                    </section>
6203    
6204                    <section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES">
6205                        <t>The front-end can retrieve the list of all instrument files in the instruments database
6206                        that don't exist in the filesystem by sending the following command:</t>
6207                        <t>
6208                            <list>
6209                                <t>FIND LOST DB_INSTRUMENT_FILES</t>
6210                            </list>
6211                        </t>
6212    
6213                        <t>Possible Answers:</t>
6214                        <t>
6215                            <list>
6216                                <t>A comma separated list with the absolute path names
6217                                (encapsulated into apostrophes) of all lost instrument files.</t>
6218                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6219                                    <list>
6220                                        <t>in case it failed, providing an appropriate error code and error message.</t>
6221                                    </list>
6222                                </t>
6223                            </list>
6224                        </t>
6225                        <t>Example:</t>
6226                        <t>
6227                            <list>
6228                                <t>C: "FIND LOST DB_INSTRUMENT_FILES"</t>
6229                                <t>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"</t>
6230                            </list>
6231                        </t>
6232                    </section>
6233    
6234                    <section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH">
6235                        <t>The front-end can substitute all occurrences of an instrument file
6236                        in the instruments database with a new one by sending the following command:</t>
6237                        <t>
6238                            <list>
6239                                <t>SET DB_INSTRUMENT FILE_PATH &lt;old_path&gt; &lt;new_path&gt;</t>
6240                            </list>
6241                        </t>
6242                        <t>Where &lt;old_path&gt; is the absolute path name of the instrument file
6243                        to substitute with &lt;new_path&gt;.</t>
6244    
6245                        <t>Possible Answers:</t>
6246                        <t>
6247                            <list>
6248                                <t>"OK" -
6249                                    <list>
6250                                        <t>on success</t>
6251                                    </list>
6252                                </t>
6253                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6254                                    <list>
6255                                        <t>in case it failed, providing an appropriate error code and error message.</t>
6256                                    </list>
6257                                </t>
6258                            </list>
6259                        </t>
6260    
6261                        <t>Example:</t>
6262                        <t>
6263                            <list>
6264                                <t>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"</t>
6265                                <t>S: "OK"</t>
6266                            </list>
6267                        </t>
6268                    </section>
6269    
6270                </section>
6271    
6272    
6273    
6274                <section title="Editing Instruments" anchor="editing_instruments">
6275                    <t>The sampler allows to edit instruments while playing with the
6276                    sampler by spawning an external (3rd party) instrument editor
6277                    application for a given instrument. The 3rd party instrument
6278                    editor applications have to place a respective plugin DLL file
6279                    into the sampler's plugins directory. The sampler will
6280                    automatically try to load all plugin DLLs in that directory on
6281                    startup and only on startup!</t>
6282                    <t>At the moment there is only one command for this feature set,
6283                    but this will most probably change in future.</t>
6284    
6285                    <section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT">
6286                        <t>The front-end can request to open an appropriate instrument
6287                        editor application by sending the following command:</t>
6288                        <t>
6289                            <list>
6290                                <t>EDIT CHANNEL INSTRUMENT &lt;sampler-channel&gt;</t>
6291                            </list>
6292                        </t>
6293                        <t>Where &lt;sampler-channel&gt; should be replaced by the
6294                        number of the sampler channel as given by the
6295                        <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
6296                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref>
6297                        command.</t>
6298    
6299                        <t>The sampler will try to ask all registered instrument
6300                        editors (or to be more specific: their sampler plugins)
6301                        whether they are capable to handle the instrument on the
6302                        given sampler channel. The sampler will simply use the first
6303                        instrument editor application which replied with a positive
6304                        answer and spawn that instrument editor application within
6305                        the sampler's process and provide that application access
6306                        to the instrument's data structures, so both applications
6307                        can share and access the same instruments data at the same
6308                        time, thus allowing to immediately hear changes with the
6309                        sampler made by the instrument editor.</t>
6310    
6311                        <t>Note: consequently instrument editors are always spawned
6312                        locally on the same machine where the sampler is running
6313                        on!</t>
6314    
6315                        <t>Possible Answers:</t>
6316                        <t>
6317                            <list>
6318                                <t>"OK" -
6319                                    <list>
6320                                        <t>when an appropriate instrument editor was
6321                                        launched</t>
6322                                    </list>
6323                                </t>
6324                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6325                                    <list>
6326                                        <t>when an appropriate instrument editor was
6327                                        launched, but there are noteworthy issues</t>
6328                                    </list>
6329                                </t>
6330                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6331                                    <list>
6332                                        <t>when an appropriate instrument editor
6333                                        could not be launched</t>
6334                                    </list>
6335                                </t>
6336                            </list>
6337                        </t>
6338    
6339                        <t>Examples:</t>
6340                        <t>
6341                            <list>
6342                                <t>C: "EDIT CHANNEL INSTRUMENT 0"</t>
6343                                <t>S: "OK"</t>
6344                            </list>
6345                        </t>
6346                    </section>
6347                </section>
6348    
6349                <section title="Managing Files" anchor="file_management">
6350                    <t>You can query detailed informations about files located
6351                    at the same system where the sampler instance is running on.
6352                    Using this command set allows to retrieve file informations
6353                    even remotely from another machine.</t>
6354    
6355                    <section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS">
6356                        <t>The front-end can retrieve the amount of instruments
6357                        within a given instrument file by sending the
6358                        following command:</t>
6359                        <t>
6360                            <list>
6361                                <t>GET FILE INSTRUMENTS &lt;filename&gt;</t>
6362                            </list>
6363                        </t>
6364                        <t>Where &lt;filename&gt; is the name of the instrument
6365                        file (encapsulated into apostrophes, supporting escape
6366                        sequences as described in chapter
6367                        "<xref target="character_set">Character Set and Escape
6368                            Sequences</xref>").</t>
6369    
6370                        <t>The sampler will try to ask all sampler engines,
6371                        whether they support the given file and ask the first
6372                        engine with a positive answer for the amount of
6373                        instruments.</t>
6374    
6375                        <t>Possible Answers:</t>
6376                        <t>
6377                            <list>
6378                                <t>On success, the sampler will answer by
6379                                   returning the amount of instruments.
6380                                </t>
6381                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6382                                    <list>
6383                                        <t>if the file could not be handled</t>
6384                                    </list>
6385                                </t>
6386                            </list>
6387                        </t>
6388    
6389                        <t>Examples:</t>
6390                        <t>
6391                            <list>
6392                                <t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t>
6393                                <t>S: "10"</t>
6394                            </list>
6395                        </t>
6396                    </section>
6397    
6398                    <section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS">
6399                        <t>The front-end can retrieve a list of all instruments
6400                        within a given instrument file by sending the
6401                        following command:</t>
6402                        <t>
6403                            <list>
6404                                <t>LIST FILE INSTRUMENTS &lt;filename&gt;</t>
6405                            </list>
6406                        </t>
6407                        <t>Where &lt;filename&gt; is the name of the instrument
6408                        file (encapsulated into apostrophes, supporting escape
6409                        sequences as described in chapter
6410                        "<xref target="character_set">Character Set and Escape
6411                            Sequences</xref>").</t>
6412    
6413                        <t>The sampler will try to ask all sampler engines,
6414                        whether they support the given file and ask the first
6415                        engine with a positive answer for a list of IDs for the
6416                        instruments in the given file.</t>
6417    
6418                        <t>Possible Answers:</t>
6419                        <t>
6420                            <list>
6421                                <t>On success, the sampler will answer by
6422                                   returning a comma separated list of
6423                                   instrument IDs.
6424                                </t>
6425                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6426                                    <list>
6427                                        <t>if the file could not be handled</t>
6428                                    </list>
6429                                </t>
6430                            </list>
6431                        </t>
6432    
6433                        <t>Examples:</t>
6434                        <t>
6435                            <list>
6436                                <t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t>
6437                                <t>S: "0,1,2,3,4,5,6,7,8,9"</t>
6438                            </list>
6439                        </t>
6440                    </section>
6441    
6442                    <section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO">
6443                        <t>The front-end can retrieve detailed informations
6444                        about a specific instrument within a given instrument
6445                        file by sending the following command:</t>
6446                        <t>
6447                            <list>
6448                                <t>GET FILE INSTRUMENT INFO &lt;filename&gt;
6449                                &lt;instr-id&gt;</t>
6450                            </list>
6451                        </t>
6452                        <t>Where &lt;filename&gt; is the name of the instrument
6453                        file (encapsulated into apostrophes, supporting escape
6454                        sequences as described in chapter
6455                        "<xref target="character_set">Character Set and Escape
6456                            Sequences</xref>") and &lt;instr-id&gt; is the numeric
6457                        instrument ID as returned by the
6458                        <xref target="LIST FILE INSTRUMENTS">
6459                        "LIST FILE INSTRUMENTS"</xref> command.</t>
6460    
6461                        <t>The sampler will try to ask all sampler engines,
6462                        whether they support the given file and ask the first
6463                        engine with a positive answer for informations about the
6464                        specific instrument in the given file.</t>
6465    
6466                        <t>Possible Answers:</t>
6467                        <t>
6468                            <list>
6469                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6470                                Each answer line begins with the settings category name
6471                                followed by a colon and then a space character &lt;SP&gt; and finally
6472                                the info character string to that setting category. At the
6473                                moment the following categories are defined:</t>
6474    
6475                                <t>
6476                                    <list>
6477                                        <t>NAME -
6478                                            <list>
6479                                                <t>name of the instrument as
6480                                                stored in the instrument file</t>
6481                                            </list>
6482                                        </t>
6483                                        <t>FORMAT_FAMILY -
6484                                            <list>
6485                                                <t>name of the sampler format
6486                                                of the given instrument</t>
6487                                            </list>
6488                                        </t>
6489                                        <t>FORMAT_VERSION -
6490                                            <list>
6491                                                <t>version of the sampler format
6492                                                the instrumen is stored as</t>
6493                                            </list>
6494                                        </t>
6495                                        <t>PRODUCT -
6496                                            <list>
6497                                                <t>official product name of the
6498                                                instrument as stored in the file
6499                                                </t>
6500                                            </list>
6501                                        </t>
6502                                        <t>ARTISTS -
6503                                            <list>
6504                                                <t>artists / sample library
6505                                                vendor of the instrument</t>
6506                                            </list>
6507                                        </t>
6508                                        <t>KEY_BINDINGS -
6509                                            <list>
6510                                                <t>comma separated list of integer values representing
6511                                                   the instrument's key mapping in the range between 0 .. 127,
6512                                                   reflecting the analog meaning of the MIDI specification.</t>
6513                                            </list>
6514                                        </t>
6515                                        <t>KEYSWITCH_BINDINGS -
6516                                            <list>
6517                                                <t>comma separated list of integer values representing
6518                                                   the instrument's keyswitch mapping in the range between 0 .. 127,
6519                                                   reflecting the analog meaning of the MIDI specification.</t>
6520                                            </list>
6521                                        </t>
6522                                    </list>
6523                                </t>
6524                            </list>
6525                        </t>
6526                        <t>The mentioned fields above don't have to be in particular order.</t>
6527    
6528                        <t>Example:</t>
6529                        <t>
6530                            <list>
6531                                <t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t>
6532                                <t>S: "NAME: Lunatic Loops"</t>
6533                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
6534                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 3"</t>
6535                                <t>&nbsp;&nbsp;&nbsp;"PRODUCT: The Backbone Bongo Beats"</t>
6536                                <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Jimmy the Fish"</t>
6537                                <t>&nbsp;&nbsp;&nbsp;"."</t>
6538                            </list>
6539                        </t>
6540                    </section>
6541              </section>              </section>
6542          </section>          </section>
6543    
6544          <section title="Command Syntax">          <section title="Command Syntax" anchor="command_syntax">
6545              <t>TODO: will soon automatically included from src/network/lscp.y,              <t>The grammar of the control protocol as descibed in <xref target="control_commands"/>
6546              meanwhile have a look at that file to get the exact definition of              is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>)
6547              the command syntax.</t>              where applicable.
6548                </t>
6549                <!--
6550                    This section is automatically generated by scripts/update_grammar.pl
6551                    from src/network/lscp.y (yacc input file). Do not modify this section
6552                    manually !
6553                -->
6554                <!-- GRAMMAR_BNF_BEGIN - do NOT delete or modify this line !!! -->
6555    
6556    <t>input =
6557            <list>
6558                    <t>line LF
6559                    </t>
6560                    <t>/ line CR LF
6561                    </t>
6562            </list>
6563    </t>
6564    <t>line =
6565            <list>
6566                    <t>/* epsilon (empty line ignored) */
6567                    </t>
6568                    <t>/ comment
6569                    </t>
6570                    <t>/ command
6571                    </t>
6572                    <t>/ error
6573                    </t>
6574            </list>
6575    </t>
6576    <t>comment =
6577            <list>
6578                    <t>'#'
6579                    </t>
6580                    <t>/ comment '#'
6581                    </t>
6582                    <t>/ comment SP
6583                    </t>
6584                    <t>/ comment number
6585                    </t>
6586                    <t>/ comment string
6587                    </t>
6588            </list>
6589    </t>
6590    <t>command =
6591            <list>
6592                    <t>ADD SP add_instruction
6593                    </t>
6594                    <t>/ MAP SP map_instruction
6595                    </t>
6596                    <t>/ UNMAP SP unmap_instruction
6597                    </t>
6598                    <t>/ GET SP get_instruction
6599                    </t>
6600                    <t>/ CREATE SP create_instruction
6601                    </t>
6602                    <t>/ DESTROY SP destroy_instruction
6603                    </t>
6604                    <t>/ LIST SP list_instruction
6605                    </t>
6606                    <t>/ LOAD SP load_instruction
6607                    </t>
6608                    <t>/ REMOVE SP remove_instruction
6609                    </t>
6610                    <t>/ SET SP set_instruction
6611                    </t>
6612                    <t>/ SUBSCRIBE SP subscribe_event
6613                    </t>
6614                    <t>/ UNSUBSCRIBE SP unsubscribe_event
6615                    </t>
6616                    <t>/ RESET SP reset_instruction
6617                    </t>
6618                    <t>/ CLEAR SP clear_instruction
6619                    </t>
6620                    <t>/ FIND SP find_instruction
6621                    </t>
6622                    <t>/ MOVE SP move_instruction
6623                    </t>
6624                    <t>/ COPY SP copy_instruction
6625                    </t>
6626                    <t>/ EDIT SP edit_instruction
6627                    </t>
6628                    <t>/ FORMAT SP format_instruction
6629                    </t>
6630                    <t>/ SEND SP send_instruction
6631                    </t>
6632                    <t>/ RESET
6633                    </t>
6634                    <t>/ QUIT
6635                    </t>
6636            </list>
6637    </t>
6638    <t>add_instruction =
6639            <list>
6640                    <t>CHANNEL
6641                    </t>
6642                    <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
6643                    </t>
6644                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
6645                    </t>
6646                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename
6647                    </t>
6648                    <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6649                    </t>
6650                    <t>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename
6651                    </t>
6652                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6653                    </t>
6654                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index
6655                    </t>
6656                    <t>/ DB_INSTRUMENTS SP db_path SP filename
6657                    </t>
6658                    <t>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6659                    </t>
6660                    <t>/ MIDI_INSTRUMENT_MAP
6661                    </t>
6662                    <t>/ MIDI_INSTRUMENT_MAP SP map_name
6663                    </t>
6664            </list>
6665    </t>
6666    <t>subscribe_event =
6667            <list>
6668                    <t>AUDIO_OUTPUT_DEVICE_COUNT
6669                    </t>
6670                    <t>/ AUDIO_OUTPUT_DEVICE_INFO
6671                    </t>
6672                    <t>/ MIDI_INPUT_DEVICE_COUNT
6673                    </t>
6674                    <t>/ MIDI_INPUT_DEVICE_INFO
6675                    </t>
6676                    <t>/ CHANNEL_COUNT
6677                    </t>
6678                    <t>/ CHANNEL_MIDI
6679                    </t>
6680                    <t>/ DEVICE_MIDI
6681                    </t>
6682                    <t>/ VOICE_COUNT
6683                    </t>
6684                    <t>/ STREAM_COUNT
6685                    </t>
6686                    <t>/ BUFFER_FILL
6687                    </t>
6688                    <t>/ CHANNEL_INFO
6689                    </t>
6690                    <t>/ FX_SEND_COUNT
6691                    </t>
6692                    <t>/ FX_SEND_INFO
6693                    </t>
6694                    <t>/ MIDI_INSTRUMENT_MAP_COUNT
6695                    </t>
6696                    <t>/ MIDI_INSTRUMENT_MAP_INFO
6697                    </t>
6698                    <t>/ MIDI_INSTRUMENT_COUNT
6699                    </t>
6700                    <t>/ MIDI_INSTRUMENT_INFO
6701                    </t>
6702                    <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
6703                    </t>
6704                    <t>/ DB_INSTRUMENT_DIRECTORY_INFO
6705                    </t>
6706                    <t>/ DB_INSTRUMENT_COUNT
6707                    </t>
6708                    <t>/ DB_INSTRUMENT_INFO
6709                    </t>
6710                    <t>/ DB_INSTRUMENTS_JOB_INFO
6711                    </t>
6712                    <t>/ MISCELLANEOUS
6713                    </t>
6714                    <t>/ TOTAL_STREAM_COUNT
6715                    </t>
6716                    <t>/ TOTAL_VOICE_COUNT
6717                    </t>
6718                    <t>/ GLOBAL_INFO
6719                    </t>
6720            </list>
6721    </t>
6722    <t>unsubscribe_event =
6723            <list>
6724                    <t>AUDIO_OUTPUT_DEVICE_COUNT
6725                    </t>
6726                    <t>/ AUDIO_OUTPUT_DEVICE_INFO
6727                    </t>
6728                    <t>/ MIDI_INPUT_DEVICE_COUNT
6729                    </t>
6730                    <t>/ MIDI_INPUT_DEVICE_INFO
6731                    </t>
6732                    <t>/ CHANNEL_COUNT
6733                    </t>
6734                    <t>/ CHANNEL_MIDI
6735                    </t>
6736                    <t>/ DEVICE_MIDI
6737                    </t>
6738                    <t>/ VOICE_COUNT
6739                    </t>
6740                    <t>/ STREAM_COUNT
6741                    </t>
6742                    <t>/ BUFFER_FILL
6743                    </t>
6744                    <t>/ CHANNEL_INFO
6745                    </t>
6746                    <t>/ FX_SEND_COUNT
6747                    </t>
6748                    <t>/ FX_SEND_INFO
6749                    </t>
6750                    <t>/ MIDI_INSTRUMENT_MAP_COUNT
6751                    </t>
6752                    <t>/ MIDI_INSTRUMENT_MAP_INFO
6753                    </t>
6754                    <t>/ MIDI_INSTRUMENT_COUNT
6755                    </t>
6756                    <t>/ MIDI_INSTRUMENT_INFO
6757                    </t>
6758                    <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
6759                    </t>
6760                    <t>/ DB_INSTRUMENT_DIRECTORY_INFO
6761                    </t>
6762                    <t>/ DB_INSTRUMENT_COUNT
6763                    </t>
6764                    <t>/ DB_INSTRUMENT_INFO
6765                    </t>
6766                    <t>/ DB_INSTRUMENTS_JOB_INFO
6767                    </t>
6768                    <t>/ MISCELLANEOUS
6769                    </t>
6770                    <t>/ TOTAL_STREAM_COUNT
6771                    </t>
6772                    <t>/ TOTAL_VOICE_COUNT
6773                    </t>
6774                    <t>/ GLOBAL_INFO
6775                    </t>
6776            </list>
6777    </t>
6778    <t>map_instruction =
6779            <list>
6780                    <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
6781                    </t>
6782                    <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
6783                    </t>
6784                    <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
6785                    </t>
6786                    <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
6787                    </t>
6788            </list>
6789    </t>
6790    <t>unmap_instruction =
6791            <list>
6792                    <t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
6793                    </t>
6794            </list>
6795    </t>
6796    <t>remove_instruction =
6797            <list>
6798                    <t>CHANNEL SP sampler_channel
6799                    </t>
6800                    <t>/ MIDI_INSTRUMENT_MAP SP midi_map
6801                    </t>
6802                    <t>/ MIDI_INSTRUMENT_MAP SP ALL
6803                    </t>
6804                    <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6805                    </t>
6806                    <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
6807                    </t>
6808                    <t>/ DB_INSTRUMENT SP db_path
6809                    </t>
6810            </list>
6811    </t>
6812    <t>get_instruction =
6813            <list>
6814                    <t>AVAILABLE_ENGINES
6815                    </t>
6816                    <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
6817                    </t>
6818                    <t>/ MIDI_INPUT_DRIVER SP INFO SP string
6819                    </t>
6820                    <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
6821                    </t>
6822                    <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
6823                    </t>
6824                    <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
6825                    </t>
6826                    <t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string
6827                    </t>
6828                    <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
6829                    </t>
6830                    <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
6831                    </t>
6832                    <t>/ AUDIO_OUTPUT_DEVICES
6833                    </t>
6834                    <t>/ MIDI_INPUT_DEVICES
6835                    </t>
6836                    <t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number
6837                    </t>
6838                    <t>/ MIDI_INPUT_DEVICE SP INFO SP number
6839                    </t>
6840                    <t>/ MIDI_INPUT_PORT SP INFO SP number SP number
6841                    </t>
6842                    <t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
6843                    </t>
6844                    <t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
6845                    </t>
6846                    <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string
6847                    </t>
6848                    <t>/ CHANNELS
6849                    </t>
6850                    <t>/ CHANNEL SP INFO SP sampler_channel
6851                    </t>
6852                    <t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
6853                    </t>
6854                    <t>/ CHANNEL SP STREAM_COUNT SP sampler_channel
6855                    </t>
6856                    <t>/ CHANNEL SP VOICE_COUNT SP sampler_channel
6857                    </t>
6858                    <t>/ ENGINE SP INFO SP engine_name
6859                    </t>
6860                    <t>/ SERVER SP INFO
6861                    </t>
6862                    <t>/ TOTAL_STREAM_COUNT
6863                    </t>
6864                    <t>/ TOTAL_VOICE_COUNT
6865                    </t>
6866                    <t>/ TOTAL_VOICE_COUNT_MAX
6867                    </t>
6868                    <t>/ MIDI_INSTRUMENTS SP midi_map
6869                    </t>
6870                    <t>/ MIDI_INSTRUMENTS SP ALL
6871                    </t>
6872                    <t>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
6873                    </t>
6874                    <t>/ MIDI_INSTRUMENT_MAPS
6875                    </t>
6876                    <t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
6877                    </t>
6878                    <t>/ FX_SENDS SP sampler_channel
6879                    </t>
6880                    <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
6881                    </t>
6882                    <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6883                    </t>
6884                    <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
6885                    </t>
6886                    <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
6887                    </t>
6888                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
6889                    </t>
6890                    <t>/ DB_INSTRUMENTS SP db_path
6891                    </t>
6892                    <t>/ DB_INSTRUMENT SP INFO SP db_path
6893                    </t>
6894                    <t>/ DB_INSTRUMENTS_JOB SP INFO SP number
6895                    </t>
6896                    <t>/ VOLUME
6897                    </t>
6898                    <t>/ VOICES
6899                    </t>
6900                    <t>/ STREAMS
6901                    </t>
6902                    <t>/ FILE SP INSTRUMENTS SP filename
6903                    </t>
6904                    <t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
6905                    </t>
6906            </list>
6907    </t>
6908    <t>set_instruction =
6909            <list>
6910                    <t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
6911                    </t>
6912                    <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list
6913                    </t>
6914                    <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
6915                    </t>
6916                    <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
6917                    </t>
6918                    <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
6919                    </t>
6920                    <t>/ CHANNEL SP set_chan_instruction
6921                    </t>
6922                    <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6923                    </t>
6924                    <t>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
6925                    </t>
6926                    <t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
6927                    </t>
6928                    <t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
6929                    </t>
6930                    <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
6931                    </t>
6932                    <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6933                    </t>
6934                    <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
6935                    </t>
6936                    <t>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
6937                    </t>
6938                    <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6939                    </t>
6940                    <t>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename
6941                    </t>
6942                    <t>/ ECHO SP boolean
6943                    </t>
6944                    <t>/ VOLUME SP volume_value
6945                    </t>
6946                    <t>/ VOICES SP number
6947                    </t>
6948                    <t>/ STREAMS SP number
6949                    </t>
6950            </list>
6951    </t>
6952    <t>create_instruction =
6953            <list>
6954                    <t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list
6955                    </t>
6956                    <t>/ AUDIO_OUTPUT_DEVICE SP string
6957                    </t>
6958                    <t>/ MIDI_INPUT_DEVICE SP string SP key_val_list
6959                    </t>
6960                    <t>/ MIDI_INPUT_DEVICE SP string
6961                    </t>
6962                    <t>/ FX_SEND SP sampler_channel SP midi_ctrl
6963                    </t>
6964                    <t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
6965                    </t>
6966            </list>
6967    </t>
6968    <t>reset_instruction =
6969            <list>
6970                    <t>CHANNEL SP sampler_channel
6971                    </t>
6972            </list>
6973    </t>
6974    <t>clear_instruction =
6975            <list>
6976                    <t>MIDI_INSTRUMENTS SP midi_map
6977                    </t>
6978                    <t>/ MIDI_INSTRUMENTS SP ALL
6979                    </t>
6980            </list>
6981    </t>
6982    <t>find_instruction =
6983            <list>
6984                    <t>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
6985                    </t>
6986                    <t>/ DB_INSTRUMENTS SP db_path SP query_val_list
6987                    </t>
6988                    <t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list
6989                    </t>
6990                    <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6991                    </t>
6992                    <t>/ LOST SP DB_INSTRUMENT_FILES
6993                    </t>
6994            </list>
6995    </t>
6996    <t>move_instruction =
6997            <list>
6998                    <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6999                    </t>
7000                    <t>/ DB_INSTRUMENT SP db_path SP db_path
7001                    </t>
7002            </list>
7003    </t>
7004    <t>copy_instruction =
7005            <list>
7006                    <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
7007                    </t>
7008                    <t>/ DB_INSTRUMENT SP db_path SP db_path
7009                    </t>
7010            </list>
7011    </t>
7012    <t>destroy_instruction =
7013            <list>
7014                    <t>AUDIO_OUTPUT_DEVICE SP number
7015                    </t>
7016                    <t>/ MIDI_INPUT_DEVICE SP number
7017                    </t>
7018                    <t>/ FX_SEND SP sampler_channel SP fx_send_id
7019                    </t>
7020            </list>
7021    </t>
7022    <t>load_instruction =
7023            <list>
7024                    <t>INSTRUMENT SP load_instr_args
7025                    </t>
7026                    <t>/ ENGINE SP load_engine_args
7027                    </t>
7028            </list>
7029    </t>
7030    <t>set_chan_instruction =
7031            <list>
7032                    <t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
7033                    </t>
7034                    <t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index
7035                    </t>
7036                    <t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
7037                    </t>
7038                    <t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index
7039                    </t>
7040                    <t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index
7041                    </t>
7042                    <t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
7043                    </t>
7044                    <t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index
7045                    </t>
7046                    <t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
7047                    </t>
7048                    <t>/ VOLUME SP sampler_channel SP volume_value
7049                    </t>
7050                    <t>/ MUTE SP sampler_channel SP boolean
7051                    </t>
7052                    <t>/ SOLO SP sampler_channel SP boolean
7053                    </t>
7054                    <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
7055                    </t>
7056                    <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
7057                    </t>
7058                    <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
7059                    </t>
7060            </list>
7061    </t>
7062    <t>edit_instruction =
7063            <list>
7064                    <t>CHANNEL SP INSTRUMENT SP sampler_channel
7065                    </t>
7066            </list>
7067    </t>
7068    <t>format_instruction =
7069            <list>
7070                    <t>INSTRUMENTS_DB
7071                    </t>
7072            </list>
7073    </t>
7074    <t>modal_arg =
7075            <list>
7076                    <t>/* epsilon (empty argument) */
7077                    </t>
7078                    <t>/ NON_MODAL SP
7079                    </t>
7080            </list>
7081    </t>
7082    <t>key_val_list =
7083            <list>
7084                    <t>string '=' param_val_list
7085                    </t>
7086                    <t>/ key_val_list SP string '=' param_val_list
7087                    </t>
7088            </list>
7089    </t>
7090    <t>buffer_size_type =
7091            <list>
7092                    <t>BYTES
7093                    </t>
7094                    <t>/ PERCENTAGE
7095                    </t>
7096            </list>
7097    </t>
7098    <t>list_instruction =
7099            <list>
7100                    <t>AUDIO_OUTPUT_DEVICES
7101                    </t>
7102                    <t>/ MIDI_INPUT_DEVICES
7103                    </t>
7104                    <t>/ CHANNELS
7105                    </t>
7106                    <t>/ AVAILABLE_ENGINES
7107                    </t>
7108                    <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
7109                    </t>
7110                    <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
7111                    </t>
7112                    <t>/ MIDI_INSTRUMENTS SP midi_map
7113                    </t>
7114                    <t>/ MIDI_INSTRUMENTS SP ALL
7115                    </t>
7116                    <t>/ MIDI_INSTRUMENT_MAPS
7117                    </t>
7118                    <t>/ FX_SENDS SP sampler_channel
7119                    </t>
7120                    <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
7121                    </t>
7122                    <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
7123                    </t>
7124                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
7125                    </t>
7126                    <t>/ DB_INSTRUMENTS SP db_path
7127                    </t>
7128                    <t>/ FILE SP INSTRUMENTS SP filename
7129                    </t>
7130            </list>
7131    </t>
7132    <t>send_instruction =
7133            <list>
7134                    <t>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number
7135                    </t>
7136            </list>
7137    </t>
7138    <t>load_instr_args =
7139            <list>
7140                    <t>filename SP instrument_index SP sampler_channel
7141                    </t>
7142                    <t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel
7143                    </t>
7144            </list>
7145    </t>
7146    <t>load_engine_args =
7147            <list>
7148                    <t>engine_name SP sampler_channel
7149                    </t>
7150            </list>
7151    </t>
7152    <t>instr_load_mode =
7153            <list>
7154                    <t>ON_DEMAND
7155                    </t>
7156                    <t>/ ON_DEMAND_HOLD
7157                    </t>
7158                    <t>/ PERSISTENT
7159                    </t>
7160            </list>
7161    </t>
7162    <t>device_index =
7163            <list>
7164                    <t>number
7165                    </t>
7166            </list>
7167    </t>
7168    <t>audio_channel_index =
7169            <list>
7170                    <t>number
7171                    </t>
7172            </list>
7173    </t>
7174    <t>audio_output_type_name =
7175            <list>
7176                    <t>string
7177                    </t>
7178            </list>
7179    </t>
7180    <t>midi_input_port_index =
7181            <list>
7182                    <t>number
7183                    </t>
7184            </list>
7185    </t>
7186    <t>midi_input_channel_index =
7187            <list>
7188                    <t>number
7189                    </t>
7190                    <t>/ ALL
7191                    </t>
7192            </list>
7193    </t>
7194    <t>midi_input_type_name =
7195            <list>
7196                    <t>string
7197                    </t>
7198            </list>
7199    </t>
7200    <t>midi_map =
7201            <list>
7202                    <t>number
7203                    </t>
7204            </list>
7205    </t>
7206    <t>midi_bank =
7207            <list>
7208                    <t>number
7209                    </t>
7210            </list>
7211    </t>
7212    <t>midi_prog =
7213            <list>
7214                    <t>number
7215                    </t>
7216            </list>
7217    </t>
7218    <t>midi_ctrl =
7219            <list>
7220                    <t>number
7221                    </t>
7222            </list>
7223    </t>
7224    <t>volume_value =
7225            <list>
7226                    <t>dotnum
7227                    </t>
7228                    <t>/ number
7229                    </t>
7230            </list>
7231    </t>
7232    <t>sampler_channel =
7233            <list>
7234                    <t>number
7235                    </t>
7236            </list>
7237    </t>
7238    <t>instrument_index =
7239            <list>
7240                    <t>number
7241                    </t>
7242            </list>
7243    </t>
7244    <t>fx_send_id =
7245            <list>
7246                    <t>number
7247                    </t>
7248            </list>
7249    </t>
7250    <t>engine_name =
7251            <list>
7252                    <t>string
7253                    </t>
7254            </list>
7255    </t>
7256    <t>filename =
7257            <list>
7258                    <t>path
7259                    </t>
7260            </list>
7261    </t>
7262    <t>db_path =
7263            <list>
7264                    <t>path
7265                    </t>
7266            </list>
7267    </t>
7268    <t>map_name =
7269            <list>
7270                    <t>stringval_escaped
7271                    </t>
7272            </list>
7273    </t>
7274    <t>entry_name =
7275            <list>
7276                    <t>stringval_escaped
7277                    </t>
7278            </list>
7279    </t>
7280    <t>fx_send_name =
7281            <list>
7282                    <t>stringval_escaped
7283                    </t>
7284            </list>
7285    </t>
7286    <t>param_val_list =
7287            <list>
7288                    <t>param_val
7289                    </t>
7290                    <t>/ param_val_list','param_val
7291                    </t>
7292            </list>
7293    </t>
7294    
7295    <t>param_val =
7296            <list>
7297                    <t>string
7298                    </t>
7299                    <t>/ stringval
7300                    </t>
7301                    <t>/ number
7302                    </t>
7303                    <t>/ dotnum
7304                    </t>
7305            </list>
7306    </t>
7307    <t>query_val_list =
7308            <list>
7309                    <t>string '=' query_val
7310                    </t>
7311                    <t>/ query_val_list SP string '=' query_val
7312                    </t>
7313            </list>
7314    </t>
7315    <t>query_val =
7316            <list>
7317                    <t>text_escaped
7318                    </t>
7319                    <t>/ stringval_escaped
7320                    </t>
7321            </list>
7322    </t>
7323    <t>scan_mode =
7324            <list>
7325                    <t>RECURSIVE
7326                    </t>
7327                    <t>/ NON_RECURSIVE
7328                    </t>
7329                    <t>/ FLAT
7330                    </t>
7331            </list>
7332    </t>
7333    
7334                <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
7335    
7336                <section title="Character Set and Escape Sequences" anchor="character_set">
7337                    <t>Older versions of this protocol up to and including v1.1 only
7338                    supported the standard ASCII character set (ASCII code 0 - 127)
7339                    <xref target="RFC20"/>, all younger versions of this protocol
7340                    however support the Extended ASCII character set (ASCII code
7341                    0 - 255). The same group of younger protocols also support
7342                    escape sequences, but only for certain, explicitly declared
7343                    parts of the protocol. The supported escape sequences are
7344                    defined as follows:</t>
7345                    <texttable>
7346                        <ttcol>ASCII Character Sequence</ttcol>
7347                        <ttcol>Translated into (Name)</ttcol>
7348                        <c>\n</c> <c>new line</c>
7349                        <c>\r</c> <c>carriage return</c>
7350                        <c>\f</c> <c>form feed</c>
7351                        <c>\t</c> <c>horizontal tab</c>
7352                        <c>\v</c> <c>vertical tab</c>
7353                        <c>\'</c> <c>apostrophe</c>
7354                        <c>\"</c> <c>quotation mark</c>
7355                        <c>\\</c> <c>backslash</c>
7356                        <c>\OOO</c> <c>three digit octal ASCII code of the character</c>
7357                        <c>\xHH</c> <c>two digit hex ASCII code of the character</c>
7358                    </texttable>
7359                    <t>Notice: due to the transition of certain parts of the
7360                    protocol which now support escape sequences, a slight backward
7361                    incompatibility to protocols version v1.1 and younger has been
7362                    introduced. The only difference is that in parts of the protocol
7363                    where escape characters are now supported, a backslash characters
7364                    MUST be escaped as well (that is as double backslash), whereas
7365                    in the old versions a single backslash was sufficient.</t>
7366    
7367                    <t>The following LSCP commands support escape sequences as part
7368                    of their filename / path based arguments and / or may contain
7369                    a filename / path with escape sequences in their response:
7370                    <list>
7371                        <t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t>
7372                        <t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t>
7373                        <t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t>
7374                        <t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t>
7375                        <t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t>
7376                        <t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t>
7377                        <t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
7378                        <t><xref target="REMOVE DB_INSTRUMENT">"REMOVE DB_INSTRUMENT"</xref></t>
7379                        <t><xref target="GET DB_INSTRUMENT_DIRECTORIES">"GET DB_INSTRUMENT_DIRECTORIES"</xref></t>
7380                        <t><xref target="LIST DB_INSTRUMENT_DIRECTORIES">"LIST DB_INSTRUMENT_DIRECTORIES"</xref></t>
7381                        <t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t>
7382                        <t><xref target="GET DB_INSTRUMENTS">"GET DB_INSTRUMENTS"</xref></t>
7383                        <t><xref target="LIST DB_INSTRUMENTS">"LIST DB_INSTRUMENTS"</xref></t>
7384                        <t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t>
7385                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t>
7386                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t>
7387                        <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
7388                        <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
7389                        <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
7390                        <t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t>
7391                        <t><xref target="MOVE DB_INSTRUMENT">"MOVE DB_INSTRUMENT"</xref></t>
7392                        <t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
7393                        <t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t>
7394                        <t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t>
7395                        <t><xref target="FIND LOST DB_INSTRUMENT_FILES">"FIND LOST DB_INSTRUMENT_FILES"</xref></t>
7396                        <t><xref target="SET DB_INSTRUMENT FILE_PATH">"SET DB_INSTRUMENT FILE_PATH"</xref></t>
7397                        <t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t>
7398                        <t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t>
7399                        <t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t>
7400                    </list>
7401                    Note that the forward slash character ('/') has a special meaning in
7402                    filename / path based arguments: it acts as separator of the nodes in
7403                    the path, thus if a directory- or filename includes a forward slash
7404                    (not intended as path node separator), you MUST escape that slash
7405                    either with the respective hex escape sequence ("\x2f") or with the
7406                    respective octal escape sequence ("\057").
7407                    </t>
7408    
7409                    <t>
7410                    Note for Windows: file path arguments in LSCP are expected
7411                    to use forward slashes as directory node separator similar
7412                    to Unix based operating systems. In contrast to Unix however
7413                    a Windows typical drive character is expected to be
7414                    prefixed to the path. That is an original Windows file path
7415                    like "D:\Sounds\My.gig" would become in LSCP:
7416                    "D:/Sounds/My.gig".
7417                    </t>
7418    
7419                    <t>
7420                    The following LSCP commands even support escape sequences as
7421                    part of at least one of their text-based arguments (i.e. entity name,
7422                    description) and / or may contain escape sequences in at least one of
7423                    their text-based fields in their response:
7424                    <list>
7425                        <t><xref target="GET SERVER INFO">"GET SERVER INFO"</xref></t>
7426                        <t><xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref></t>
7427                        <t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t>
7428                        <t><xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref></t>
7429                        <t><xref target="GET FX_SEND INFO">"GET FX_SEND INFO"</xref></t>
7430                        <t><xref target="SET FX_SEND NAME">"SET FX_SEND NAME"</xref></t>
7431                        <t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t>
7432                        <t><xref target="GET MIDI_INSTRUMENT_MAP INFO">"GET MIDI_INSTRUMENT_MAP INFO"</xref></t>
7433                        <t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t>
7434                        <t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t>
7435                        <t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t>
7436                        <t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t>
7437                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t>
7438                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t>
7439                        <t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t>
7440                        <t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t>
7441                        <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
7442                        <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
7443                        <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
7444                    </list>
7445                    Please note that these lists are manually maintained. If you
7446                    find a command that also supports escape sequences we forgot to
7447                    mention here, please report it!
7448                    </t>
7449                </section>
7450          </section>          </section>
7451    
7452          <section title="Events">          <section title="Events" anchor="events">
7453              <t>This chapter will describe all currently defined events supported by LinuxSampler.</t>              <t>This chapter will describe all currently defined events supported by LinuxSampler.</t>
7454    
7455              <section title="Number of sampler channels changed">              <section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">
7456                    <t>Client may want to be notified when the total number of audio output devices on the
7457                    back-end changes by issuing the following command:</t>
7458                    <t>
7459                        <list>
7460                            <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t>
7461                        </list>
7462                    </t>
7463                    <t>Server will start sending the following notification messages:</t>
7464                    <t>
7465                        <list>
7466                            <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
7467                        </list>
7468                    </t>
7469                    <t>where &lt;devices&gt; will be replaced by the new number
7470                    of audio output devices.</t>
7471                </section>
7472    
7473                <section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">
7474                    <t>Client may want to be notified when changes were made to audio output devices on the
7475                    back-end by issuing the following command:</t>
7476                    <t>
7477                        <list>
7478                            <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t>
7479                        </list>
7480                    </t>
7481                    <t>Server will start sending the following notification messages:</t>
7482                    <t>
7483                        <list>
7484                            <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
7485                        </list>
7486                    </t>
7487                    <t>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
7488                    which settings has been changed. The front-end will have to send
7489                    the respective command to actually get the audio output device info. Because these messages
7490                    will be triggered by LSCP commands issued by other clients rather than real
7491                    time events happening on the server, it is believed that an empty notification
7492                    message is sufficient here.</t>
7493                </section>
7494    
7495                <section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">
7496                    <t>Client may want to be notified when the total number of MIDI input devices on the
7497                    back-end changes by issuing the following command:</t>
7498                    <t>
7499                        <list>
7500                            <t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t>
7501                        </list>
7502                    </t>
7503                    <t>Server will start sending the following notification messages:</t>
7504                    <t>
7505                        <list>
7506                            <t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
7507                        </list>
7508                    </t>
7509                    <t>where &lt;devices&gt; will be replaced by the new number
7510                    of MIDI input devices.</t>
7511                </section>
7512    
7513                <section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO">
7514                    <t>Client may want to be notified when changes were made to MIDI input devices on the
7515                    back-end by issuing the following command:</t>
7516                    <t>
7517                        <list>
7518                            <t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t>
7519                        </list>
7520                    </t>
7521                    <t>Server will start sending the following notification messages:</t>
7522                    <t>
7523                        <list>
7524                            <t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
7525                        </list>
7526                    </t>
7527                    <t>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
7528                    which settings has been changed. The front-end will have to send
7529                    the respective command to actually get the MIDI input device info. Because these messages
7530                    will be triggered by LSCP commands issued by other clients rather than real
7531                    time events happening on the server, it is believed that an empty notification
7532                    message is sufficient here.</t>
7533                </section>
7534    
7535                <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT">
7536                  <t>Client may want to be notified when the total number of channels on the                  <t>Client may want to be notified when the total number of channels on the
7537                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
7538                  <t>                  <t>
7539                      <list>                      <list>
7540                          <t>SUBSCRIBE CHANNELS</t>                          <t>SUBSCRIBE CHANNEL_COUNT</t>
7541                      </list>                      </list>
7542                  </t>                  </t>
7543                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
7544                  <t>                  <t>
7545                      <list>                      <list>
7546                          <t>"NOTIFY:CHANNELS:&lt;channels&gt;"</t>                          <t>"NOTIFY:CHANNEL_COUNT:&lt;channels&gt;"</t>
7547                      </list>                      </list>
7548                  </t>                  </t>
7549                  <t>where &lt;channels&gt; will be replaced by the new number                  <t>where &lt;channels&gt; will be replaced by the new number
7550                  of sampler channels.</t>                  of sampler channels.</t>
7551              </section>              </section>
7552    
7553              <section title="Number of active voices changed">              <section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI">
7554                    <t>Client may want to be notified when MIDI data arrive on sampler channels on
7555                    back-end side, by issuing the following command:</t>
7556                    <t>
7557                        <list>
7558                            <t>SUBSCRIBE CHANNEL_MIDI</t>
7559                        </list>
7560                    </t>
7561                    <t>Server will start sending one of the the following notification messages:</t>
7562                    <t>
7563                        <list>
7564                            <t>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_ON  &lt;note&gt; &lt;velocity&gt;"</t>
7565                            <t>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"</t>
7566                        </list>
7567                    </t>
7568                    <t>where &lt;channel-id&gt; will be replaced by the ID of the sampler channel where the MIDI
7569                    data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
7570                    0 .. 127, reflecting the analog meaning of the MIDI specification.
7571                    </t>
7572                    <t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
7573                    delivered by this mechanism! With other words: events could be lost at any time!
7574                    This restriction was made to keep the RT-safeness of the backend's MIDI and audio
7575                    thread unaffected by this feature.</t>
7576                </section>
7577    
7578                <section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI">
7579                        <t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t>
7580                        <t>
7581                                <list>
7582                                        <t>SUBSCRIBE DEVICE_MIDI</t>
7583                                </list>
7584                        </t>
7585                        <t>Server will start sending one of the the following notification messages:</t>
7586                        <t>
7587                                <list>
7588                                        <t>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_ON &lt;note&gt; &lt;velocity&gt;"</t>
7589                                        <t>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"</t>
7590                                </list>
7591                        </t>
7592                        <t>where &lt;device-id&gt; &lt;port-id&gt; will be replaced
7593                           by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI
7594                           data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
7595                           0 .. 127, reflecting the analog meaning of the MIDI specification.
7596                        </t>
7597                        <t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
7598                           delivered by this mechanism! With other words: events could be lost at any time!
7599                           This restriction was made to keep the RT-safeness of the backend's MIDI and audio
7600                           thread unaffected by this feature.</t>
7601                </section>
7602    
7603                <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">
7604                  <t>Client may want to be notified when the number of voices on the                  <t>Client may want to be notified when the number of voices on the
7605                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
7606                  <t>                  <t>
# Line 3037  Schoenebeck'> Line 7611  Schoenebeck'>
7611                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
7612                  <t>                  <t>
7613                      <list>                      <list>
7614                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices>&gt;</t>                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"</t>
7615                      </list>                      </list>
7616                  </t>                  </t>
7617                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
7618                  voice count change occurred and &lt;voices>&gt; by the new number of                  voice count change occurred and &lt;voices&gt; by the new number of
7619                  active voices on that channel.</t>                  active voices on that channel.</t>
7620              </section>              </section>
7621    
7622              <section title="Number of active disk streams changed">              <section title="Number of active disk streams changed" anchor="SUBSCRIBE STREAM_COUNT">
7623                  <t>Client may want to be notified when the number of streams on the back-end                  <t>Client may want to be notified when the number of streams on the back-end
7624                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t>                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t>
7625                  <t>                  <t>
# Line 3064  Schoenebeck'> Line 7638  Schoenebeck'>
7638                  active disk streams on that channel.</t>                  active disk streams on that channel.</t>
7639              </section>              </section>
7640    
7641              <section title="Disk stream buffer fill state changed">              <section title="Disk stream buffer fill state changed" anchor="SUBSCRIBE BUFFER_FILL">
7642                  <t>Client may want to be notified when the number of streams on the back-end                  <t>Client may want to be notified when the buffer fill state of a disk stream
7643                  changes by issuing the following command:</t>                  on the back-end changes by issuing the following command:</t>
7644                  <t>                  <t>
7645                      <list>                      <list>
7646                          <t>SUBSCRIBE BUFFER_FILL</t>                          <t>SUBSCRIBE BUFFER_FILL</t>
# Line 3079  Schoenebeck'> Line 7653  Schoenebeck'>
7653                      </list>                      </list>
7654                  </t>                  </t>
7655                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
7656                  buffer fill state change occurred and &lt;fill-data&gt; will be replaced by the                  buffer fill state change occurred on and &lt;fill-data&gt; will be replaced by the
7657                  buffer fill data for this channel as described in 4.4.12 as if the                  buffer fill data for this channel as described in <xref target="GET CHANNEL BUFFER_FILL" />
7658                  "GET CHANNEL BUFFER_FILL PERCENTAGE" was issued on this channel.</t>                  as if the <xref target="GET CHANNEL BUFFER_FILL">
7659                    "GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t>
7660              </section>              </section>
7661    
7662              <section title="Channel information changed">              <section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO">
7663                  <t>Client may want to be notified when changes were made to sampler channels on the                  <t>Client may want to be notified when changes were made to sampler channels on the
7664                  back-end changes by issuing the following command:</t>                  back-end by issuing the following command:</t>
7665                  <t>                  <t>
7666                      <list>                      <list>
7667                          <t>SUBSCRIBE INFO</t>                          <t>SUBSCRIBE CHANNEL_INFO</t>
7668                      </list>                      </list>
7669                  </t>                  </t>
7670                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
7671                  <t>                  <t>
7672                      <list>                      <list>
7673                          <t>"NOTIFY:INFO:&lt;sampler-channel&gt;"</t>                          <t>"NOTIFY:CHANNEL_INFO:&lt;sampler-channel&gt;"</t>
7674                      </list>                      </list>
7675                  </t>                  </t>
7676                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
# Line 3106  Schoenebeck'> Line 7681  Schoenebeck'>
7681                  message is sufficient here.</t>                  message is sufficient here.</t>
7682              </section>              </section>
7683    
7684              <section title="Miscellaneous and debugging events">              <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
7685                    <t>Client may want to be notified when the number of effect sends on
7686                    a particular sampler channel is changed by issuing the following command:</t>
7687                    <t>
7688                        <list>
7689                            <t>SUBSCRIBE FX_SEND_COUNT</t>
7690                        </list>
7691                    </t>
7692                    <t>Server will start sending the following notification messages:</t>
7693                    <t>
7694                        <list>
7695                            <t>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"</t>
7696                        </list>
7697                    </t>
7698                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
7699                    channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
7700                    be replaced by the new number of effect sends on that channel.</t>
7701                </section>
7702    
7703                <section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO">
7704                    <t>Client may want to be notified when changes were made to effect sends on a
7705                    a particular sampler channel by issuing the following command:</t>
7706                    <t>
7707                        <list>
7708                            <t>SUBSCRIBE FX_SEND_INFO</t>
7709                        </list>
7710                    </t>
7711                    <t>Server will start sending the following notification messages:</t>
7712                    <t>
7713                        <list>
7714                            <t>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"</t>
7715                        </list>
7716                    </t>
7717                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
7718                    channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
7719                    be replaced by the numerical ID of the changed effect send.</t>
7720                </section>
7721    
7722                <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT">
7723                    <t>Client may want to be notified when the total number of voices on the
7724                    back-end changes by issuing the following command:</t>
7725                    <t>
7726                        <list>
7727                            <t>SUBSCRIBE TOTAL_VOICE_COUNT</t>
7728                        </list>
7729                    </t>
7730                    <t>Server will start sending the following notification messages:</t>
7731                    <t>
7732                        <list>
7733                            <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"</t>
7734                        </list>
7735                    </t>
7736                    <t>where &lt;voices&gt; will be replaced by the new number of
7737                    all currently active voices.</t>
7738                </section>
7739    
7740                <section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT">
7741                    <t>Client may want to be notified when the total number of disk streams on the
7742                    back-end changes by issuing the following command:</t>
7743                    <t>
7744                        <list>
7745                            <t>SUBSCRIBE TOTAL_STREAM_COUNT</t>
7746                        </list>
7747                    </t>
7748                    <t>Server will start sending the following notification messages:</t>
7749                    <t>
7750                        <list>
7751                            <t>"NOTIFY:TOTAL_STREAM_COUNT:&lt;streams&gt;"</t>
7752                        </list>
7753                    </t>
7754                    <t>where &lt;streams&gt; will be replaced by the new number of
7755                    all currently active disk streams.</t>
7756                </section>
7757    
7758                <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">
7759                    <t>Client may want to be notified when the number of MIDI instrument maps on the
7760                    back-end changes by issuing the following command:</t>
7761                    <t>
7762                        <list>
7763                            <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t>
7764                        </list>
7765                    </t>
7766                    <t>Server will start sending the following notification messages:</t>
7767                    <t>
7768                        <list>
7769                            <t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"</t>
7770                        </list>
7771                    </t>
7772                    <t>where &lt;maps&gt; will be replaced by the new number
7773                    of MIDI instrument maps.</t>
7774                </section>
7775    
7776                <section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">
7777                    <t>Client may want to be notified when changes were made to MIDI instrument maps on the
7778                    back-end by issuing the following command:</t>
7779                    <t>
7780                        <list>
7781                            <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t>
7782                        </list>
7783                    </t>
7784                    <t>Server will start sending the following notification messages:</t>
7785                    <t>
7786                        <list>
7787                            <t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"</t>
7788                        </list>
7789                    </t>
7790                    <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
7791                    for which information changes occurred. The front-end will have to send
7792                    the respective command to actually get the MIDI instrument map info. Because these messages
7793                    will be triggered by LSCP commands issued by other clients rather than real
7794                    time events happening on the server, it is believed that an empty notification
7795                    message is sufficient here.</t>
7796                </section>
7797    
7798                <section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT">
7799                    <t>Client may want to be notified when the number of MIDI instrument maps on the
7800                    back-end changes by issuing the following command:</t>
7801                    <t>
7802                        <list>
7803                            <t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t>
7804                        </list>
7805                    </t>
7806                    <t>Server will start sending the following notification messages:</t>
7807                    <t>
7808                        <list>
7809                            <t>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"</t>
7810                        </list>
7811                    </t>
7812                    <t>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
7813                    the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
7814                    the new number of MIDI instruments in the specified map.</t>
7815                </section>
7816    
7817                <section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO">
7818                    <t>Client may want to be notified when changes were made to MIDI instruments on the
7819                    back-end by issuing the following command:</t>
7820                    <t>
7821                        <list>
7822                            <t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t>
7823                        </list>
7824                    </t>
7825                    <t>Server will start sending the following notification messages:</t>
7826                    <t>
7827                        <list>
7828                            <t>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"</t>
7829                        </list>
7830                    </t>
7831                    <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
7832                    in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
7833                    the location of the changed MIDI instrument in the map. The front-end will have to send
7834                    the respective command to actually get the MIDI instrument info. Because these messages
7835                    will be triggered by LSCP commands issued by other clients rather than real
7836                    time events happening on the server, it is believed that an empty notification
7837                    message is sufficient here.</t>
7838                </section>
7839    
7840                <section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO">
7841                    <t>Client may want to be notified when changes to the global settings
7842                    of the sampler were made by issuing the following command:</t>
7843                    <t>
7844                        <list>
7845                            <t>SUBSCRIBE GLOBAL_INFO</t>
7846                        </list>
7847                    </t>
7848                    <t>Server will start sending the following types of notification messages:</t>
7849                    <t>
7850                        <list>
7851                            <t>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
7852                            golbal volume of the sampler is changed, where &lt;volume&gt; will be
7853                            replaced by the optional dotted floating point value, reflecting the
7854                            new global volume parameter.</t>
7855                        </list>
7856                        <list>
7857                            <t>"NOTIFY:GLOBAL_INFO:VOICES &lt;max-voices&gt;" - Notifies that the
7858                            golbal limit of the sampler for maximum voices is changed, where
7859                            &lt;max-voices&gt; will be an integer value, reflecting the
7860                            new global voice limit parameter.</t>
7861                        </list>
7862                        <list>
7863                            <t>"NOTIFY:GLOBAL_INFO:STREAMS &lt;max-streams&gt;" - Notifies that the
7864                            golbal limit of the sampler for maximum disk streams is changed, where
7865                            &lt;max-streams&gt; will be an integer value, reflecting the
7866                            new global disk streams limit parameter.</t>
7867                        </list>
7868                    </t>
7869                </section>
7870    
7871                <section title="Number of database instrument directories changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">
7872                    <t>Client may want to be notified when the number of instrument
7873                    directories in a particular directory in the instruments database
7874                    is changed by issuing the following command:</t>
7875                    <t>
7876                        <list>
7877                            <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT</t>
7878                        </list>
7879                    </t>
7880                    <t>Server will start sending the following notification messages:</t>
7881                    <t>
7882                        <list>
7883                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:&lt;dir-path&gt;"</t>
7884                        </list>
7885                    </t>
7886                    <t>where &lt;dir-path&gt; will be replaced by the absolute path
7887                    name of the directory in the instruments database,
7888                    in which the number of directories is changed.</t>
7889                    <t>Note that when a non-empty directory is removed, this event
7890                    is not sent for the subdirectories in that directory.</t>
7891                </section>
7892    
7893                <section title="Database instrument directory information changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">
7894                    <t>Client may want to be notified when changes were made to directories
7895                    in the instruments database by issuing the following command:</t>
7896                    <t>
7897                        <list>
7898                            <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO</t>
7899                        </list>
7900                    </t>
7901                    <t>Server will start sending the following notification messages:</t>
7902                    <t>
7903                        <list>
7904                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:&lt;dir-path&gt;"</t>
7905                        </list>
7906                    </t>
7907                    <t>where &lt;dir-path&gt; will be replaced by the absolute path name
7908                    of the directory, for which information changes occurred. The front-end will have to send
7909                    the respective command to actually get the updated directory info. Because these messages
7910                    will be triggered by LSCP commands issued by other clients rather than real
7911                    time events happening on the server, it is believed that an empty notification
7912                    message is sufficient here.</t>
7913                    <t>
7914                        <list>
7915                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME &lt;old-dir-path&gt; &lt;new-name&gt;"</t>
7916                        </list>
7917                    </t>
7918                    <t>where &lt;old-dir-path&gt; is the old absolute path name of the directory
7919                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
7920                    the new name of the directory, encapsulated into apostrophes.</t>
7921                </section>
7922    
7923                <section title="Number of database instruments changed" anchor="SUBSCRIBE DB_INSTRUMENT_COUNT">
7924                    <t>Client may want to be notified when the number of instruments
7925                    in a particular directory in the instruments database
7926                    is changed by issuing the following command:</t>
7927                    <t>
7928                        <list>
7929                            <t>SUBSCRIBE DB_INSTRUMENT_COUNT</t>
7930                        </list>
7931                    </t>
7932                    <t>Server will start sending the following notification messages:</t>
7933                    <t>
7934                        <list>
7935                            <t>"NOTIFY:DB_INSTRUMENT_COUNT:&lt;dir-path&gt;"</t>
7936                        </list>
7937                    </t>
7938                    <t>where &lt;dir-path&gt; will be replaced by the absolute path
7939                    name of the directory in the instruments database,
7940                    in which the number of instruments is changed.</t>
7941                    <t>Note that when a non-empty directory is removed, this event
7942                    is not sent for the instruments in that directory.</t>
7943                </section>
7944    
7945                <section title="Database instrument information changed" anchor="SUBSCRIBE DB_INSTRUMENT_INFO">
7946                    <t>Client may want to be notified when changes were made to instruments
7947                    in the instruments database by issuing the following command:</t>
7948                    <t>
7949                        <list>
7950                            <t>SUBSCRIBE DB_INSTRUMENT_INFO</t>
7951                        </list>
7952                    </t>
7953                    <t>Server will start sending the following notification messages:</t>
7954                    <t>
7955                        <list>
7956                            <t>"NOTIFY:DB_INSTRUMENT_INFO:&lt;instr-path&gt;"</t>
7957                        </list>
7958                    </t>
7959                    <t>where &lt;instr-path&gt; will be replaced by the absolute path name
7960                    of the instrument, which settings are changed. The front-end will have to send
7961                    the respective command to actually get the updated directory info. Because these messages
7962                    will be triggered by LSCP commands issued by other clients rather than real
7963                    time events happening on the server, it is believed that an empty notification
7964                    message is sufficient here.</t>
7965                    <t>
7966                        <list>
7967                            <t>"NOTIFY:DB_INSTRUMENT_INFO:NAME &lt;old-instr-path&gt; &lt;new-name&gt;"</t>
7968                        </list>
7969                    </t>
7970                    <t>where &lt;old-instr-path&gt; is the old absolute path name of the instrument
7971                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
7972                    the new name of the instrument, encapsulated into apostrophes.</t>
7973                </section>
7974    
7975                <section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">
7976                    <t>Client may want to be notified when the status of particular database
7977                    instruments job is changed by issuing the following command:</t>
7978                    <t>
7979                        <list>
7980                            <t>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO</t>
7981                        </list>
7982                    </t>
7983                    <t>Server will start sending the following notification messages:</t>
7984                    <t>
7985                        <list>
7986                            <t>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:&lt;job-id&gt;"</t>
7987                        </list>
7988                    </t>
7989                    <t>where &lt;job-id&gt; will be replaced by the numerical ID of the job,
7990                    which status is changed. The front-end will have to send the respective
7991                    command to actually get the status info. Because these messages
7992                    will be triggered by LSCP commands issued by other clients rather than real
7993                    time events happening on the server, it is believed that an empty notification
7994                    message is sufficient here.</t>
7995                </section>
7996    
7997                <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
7998                  <t>Client may want to be notified of miscellaneous and debugging events occurring at                  <t>Client may want to be notified of miscellaneous and debugging events occurring at
7999                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
8000                  <t>                  <t>
# Line 3142  Schoenebeck'> Line 8030  Schoenebeck'>
8030                      <t>Rui Nuno Capela</t>                      <t>Rui Nuno Capela</t>
8031                      <t>Vladimir Senkov</t>                      <t>Vladimir Senkov</t>
8032                      <t>Mark Knecht</t>                      <t>Mark Knecht</t>
8033                        <t>Grigor Iliev</t>
8034                  </list>                  </list>
8035              </t>              </t>
8036          </section>          </section>
# Line 3149  Schoenebeck'> Line 8038  Schoenebeck'>
8038      </middle>      </middle>
8039    
8040      <back>      <back>
8041          <references>&rfc2119;</references>          <references>
8042                <reference anchor="RFC2119">
8043                    <front>
8044                        <title>Key words for use in RFCs to Indicate Requirement Levels</title>
8045                        <author initials="S." surname="Bradner" fullname="Scott Bradner">
8046                            <organization>Harvard University</organization>
8047                        </author>
8048                        <date year="1997"></date>
8049                    </front>
8050                    <seriesInfo name="RFC" value="2119" />
8051                </reference>
8052                <reference anchor="RFC793">
8053                    <front>
8054                        <title>TRANSMISSION CONTROL PROTOCOL</title>
8055                        <author>
8056                            <organization>Defense Advanced Research Projects Agency</organization>
8057                        </author>
8058                        <date year="1981"></date>
8059                    </front>
8060                    <seriesInfo name="RFC" value="793" />
8061                </reference>
8062                <reference anchor="RFC2234">
8063                    <front>
8064                        <title>Augmented BNF for Syntax Specifications</title>
8065                        <author initials="D.H." surname="Crocker" fullname="David H. Crocker">
8066                            <organization>Internet Mail Consortium</organization>
8067                        </author>
8068                        <author initials="P." surname="Overell" fullname="Paul Overell">
8069                            <organization>Demon Internet Ltd</organization>
8070                        </author>
8071                        <date year="1997"></date>
8072                    </front>
8073                    <seriesInfo name="RFC" value="2234" />
8074                </reference>
8075                <reference anchor="RFC20">
8076                    <front>
8077                        <title>ASCII format for Network Interchange</title>
8078                        <author>
8079                            <organization>UCLA</organization>
8080                        </author>
8081                        <date year="1969"></date>
8082                    </front>
8083                    <seriesInfo name="RFC" value="20" />
8084                </reference>
8085             </references>
8086      </back>      </back>
8087    
8088  </rfc>  </rfc>

Legend:
Removed from v.212  
changed lines
  Added in v.1800

  ViewVC Help
Powered by ViewVC