/[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 495 by schoenebeck, Wed Apr 6 19:35:02 2005 UTC revision 1554 by schoenebeck, Thu Dec 6 01:38:31 2007 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.3">
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="Apr" year="2005"/>          <date month="December" year="2007"/>
38          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
39          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
40          <abstract>          <abstract>
41              <t>The LinuxSampler Control Protocol (LSCP) is an              <t>The LinuxSampler Control Protocol (LSCP) is an
42              application-level protocol primarily intended for local and              application-level protocol primarily intended for local and
43              remote controlling the LinuxSampler main application, which is a              remote controlling the LinuxSampler backend application, which is a
44              sophisticated console application essentially playing back audio              sophisticated server-like console application essentially playing
45              samples and manipulating the samples in real time to certain              back audio samples and manipulating the samples in real time to
46              extent.</t>              certain extent.</t>
47          </abstract>          </abstract>
48      </front>      </front>
49    
# 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 124  Schoenebeck'> Line 164  Schoenebeck'>
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
# 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 234  Schoenebeck'> Line 275  Schoenebeck'>
275                              <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"</t>                              <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"</t>
276                              <t>S: "ERR:9:There is no audio output device with index 123456."</t>                              <t>S: "ERR:9:There is no audio output device with index 123456."</t>
277                          </list>                          </list>
278                      </t>                                          </t>
279                      <t>Normal result sets could be:</t>                      <t>Normal result sets could be:</t>
280                      <t>                      <t>
281                          <list style="numbers">                          <list style="numbers">
# Line 379  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 425  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 472  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 492  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 509  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 572  Schoenebeck'> Line 639  Schoenebeck'>
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 581  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 630  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 639  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 655  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
# Line 672  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 757  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 767  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 815  Schoenebeck'> Line 887  Schoenebeck'>
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 823  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 859  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 882  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 905  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>
# Line 914  Schoenebeck'> Line 988  Schoenebeck'>
988                      </t>                      </t>
989                      <t>Where &lt;device-id&gt; should be replaced by 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                      "LIST AUDIO_OUTPUT_DEVICES" command.</t>                      <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> command.</t>
992                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
993                      <t>LinuxSampler will answer by sending a &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 928  Schoenebeck'> Line 1002  Schoenebeck'>
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>
# Line 957  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>
# Line 976  Schoenebeck'> Line 1052  Schoenebeck'>
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 984  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 1018  Schoenebeck'> Line 1097  Schoenebeck'>
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 1116  Schoenebeck'> Line 1197  Schoenebeck'>
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 1125  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 1219  Schoenebeck'> Line 1303  Schoenebeck'>
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 1295  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 1313  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 1373  Schoenebeck'> Line 1486  Schoenebeck'>
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 1381  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 1425  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 1434  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 1450  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
# Line 1467  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 1523  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 1531  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 1571  Schoenebeck'> Line 1691  Schoenebeck'>
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 1610  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 1634  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 1663  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 1687  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 1710  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>
# Line 1724  Schoenebeck'> Line 1852  Schoenebeck'>
1852                      </t>                      </t>
1853                  </section>                  </section>
1854    
1855                  <section title="Changing settings of MIDI input devices">                  <section title="Changing settings of MIDI input devices" anchor="SET MIDI_INPUT_DEVICE_PARAMETER">
1856                      <t>Use the following command to alter a specific setting of a created MIDI input device:</t>                      <t>Use the following command to alter a specific setting of a created MIDI input device:</t>
1857                      <t>                      <t>
1858                          <list>                          <list>
# Line 1733  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 1767  Schoenebeck'> Line 1898  Schoenebeck'>
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 1809  Schoenebeck'> Line 1942  Schoenebeck'>
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 1817  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 "LIST 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 1911  Schoenebeck'> Line 2047  Schoenebeck'>
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>
# Line 1920  Schoenebeck'> Line 2056  Schoenebeck'>
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 1949  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 1973  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 2007  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 2025  Schoenebeck'> Line 2188  Schoenebeck'>
2188                      </t>                      </t>
2189    
2190                      <t>Where &lt;engine-name&gt; is an engine name as obtained by the                      <t>Where &lt;engine-name&gt; is an engine name as obtained by the
2191                      "GET AVAILABLE_ENGINES" command 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 2061  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 2085  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 2110  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 2134  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 2162  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 2170  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 2205  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 2215  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' names. Engine names can consist of lower and  
                             upper cases, digits and underlines ("_" character).</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>
2402                        </t>
2403                    </section>
2404    
2405                    <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>                          </list>
2427                      </t>                      </t>
2428                  </section>                  </section>
2429    
2430                  <section title="Getting information about an engine">                  <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 2238  Schoenebeck'> Line 2436  Schoenebeck'>
2436                          </list>                          </list>
2437                      </t>                      </t>
2438                      <t>Where &lt;engine-name&gt; is an engine name as obtained by the                      <t>Where &lt;engine-name&gt; is an engine name as obtained by the
2439                      "GET AVAILABLE_ENGINES" command.</t>                      <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>
# Line 2252  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 2278  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 2286  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 2300  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 2334  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 2344  Schoenebeck'> Line 2548  Schoenebeck'>
2548                                      </t>                                      </t>
2549                                      <t>INSTRUMENT_NAME -                                      <t>INSTRUMENT_NAME -
2550                                          <list>                                          <list>
2551                                              <t>the instrument name of the loaded instrument</t>                                              <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>                                          </list>
2555                                      </t>                                      </t>
2556                                      <t>INSTRUMENT_STATUS -                                      <t>INSTRUMENT_STATUS -
# Line 2376  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 2402  Schoenebeck'> Line 2631  Schoenebeck'>
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 2415  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 2432  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 2440  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 2459  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 2474  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 2510  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 2518  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 2552  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 2595  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 2603  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 2638  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 2646  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 2678  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 2721  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 2750  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 2763  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 2771  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 2805  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 2848  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="Resetting a sampler channel" anchor="RESET CHANNEL">
3715                      <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>
3716                      <t>                      <t>
3717                          <list>                          <list>
# Line 2896  Schoenebeck'> Line 3759  Schoenebeck'>
3759              <section title="Controlling connection">              <section title="Controlling connection">
3760                  <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>
3761    
3762                  <section title="Register front-end for receiving event messages">                  <section title="Register front-end for receiving event messages" anchor="SUBSCRIBE">
3763                      <t>The front-end can register itself to the LinuxSampler application to                      <t>The front-end can register itself to the LinuxSampler application to
3764                      be informed about noteworthy events by sending this command:</t>                      be informed about noteworthy events by sending this command:</t>
3765                      <t>                      <t>
# Line 2938  Schoenebeck'> Line 3801  Schoenebeck'>
3801                      </t>                      </t>
3802                  </section>                  </section>
3803    
3804                  <section title="Unregister front-end for not receiving event messages">                  <section title="Unregister front-end for not receiving event messages" anchor="UNSUBSCRIBE">
3805                      <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
3806                      messages anymore by sending the following command:</t>                      messages anymore by sending the following command:</t>
3807                      <t>                      <t>
# Line 2980  Schoenebeck'> Line 3843  Schoenebeck'>
3843                      </t>                      </t>
3844                  </section>                  </section>
3845    
3846                  <section title="Enable or disable echo of commands">                  <section title="Enable or disable echo of commands" anchor="SET ECHO">
3847                      <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>
3848                      <t>                      <t>
3849                          <list>                          <list>
# Line 3018  Schoenebeck'> Line 3881  Schoenebeck'>
3881                      </t>                      </t>
3882                  </section>                  </section>
3883    
3884                  <section title="Close client connection">                  <section title="Close client connection" anchor="QUIT">
3885                      <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>
3886                      <t>                      <t>
3887                          <list>                          <list>
# Line 3033  Schoenebeck'> Line 3896  Schoenebeck'>
3896              <section title="Global commands">              <section title="Global commands">
3897                  <t>The following commands have global impact on the sampler.</t>                  <t>The following commands have global impact on the sampler.</t>
3898    
3899                  <section title="Reset sampler">                  <section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT">
3900                        <t>The front-end can ask for the current number of active voices on
3901                        the sampler by sending the following command:</t>
3902                        <t>
3903                            <list>
3904                                <t>GET TOTAL_VOICE_COUNT</t>
3905                            </list>
3906                        </t>
3907    
3908                        <t>Possible Answers:</t>
3909                        <t>
3910                            <list>
3911                                <t>LinuxSampler will answer by returning the number of all active
3912                                voices on the sampler.</t>
3913                            </list>
3914                        </t>
3915                    </section>
3916    
3917                    <section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX">
3918                        <t>The front-end can ask for the maximum number of active voices
3919                        by sending the following command:</t>
3920                        <t>
3921                            <list>
3922                                <t>GET TOTAL_VOICE_COUNT_MAX</t>
3923                            </list>
3924                        </t>
3925    
3926                        <t>Possible Answers:</t>
3927                        <t>
3928                            <list>
3929                                <t>LinuxSampler will answer by returning the maximum number
3930                                of active voices.</t>
3931                            </list>
3932                        </t>
3933                    </section>
3934    
3935                    <section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT">
3936                        <t>The front-end can ask for the current number of active disk streams on
3937                        the sampler by sending the following command:</t>
3938                        <t>
3939                            <list>
3940                                <t>GET TOTAL_STREAM_COUNT</t>
3941                            </list>
3942                        </t>
3943    
3944                        <t>Possible Answers:</t>
3945                        <t>
3946                            <list>
3947                                <t>LinuxSampler will answer by returning the number of all active
3948                                disk streams on the sampler.</t>
3949                            </list>
3950                        </t>
3951                    </section>
3952    
3953                    <section title="Reset sampler" anchor="RESET">
3954                      <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>
3955                      <t>                      <t>
3956                          <list>                          <list>
# Line 3058  Schoenebeck'> Line 3975  Schoenebeck'>
3975                          </list>                          </list>
3976                      </t>                      </t>
3977                  </section>                  </section>
3978    
3979                    <section title="General sampler informations" anchor="GET SERVER INFO">
3980                        <t>The client can ask for general informations about the LinuxSampler
3981                           instance by sending the following command:</t>
3982                        <t>
3983                            <list>
3984                                <t>GET SERVER INFO</t>
3985                            </list>
3986                        </t>
3987                        <t>Possible Answers:</t>
3988                        <t>
3989                            <list>
3990                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
3991                                   Each answer line begins with the information category name
3992                                   followed by a colon and then a space character &lt;SP&gt; and finally
3993                                   the info character string to that information category. At the
3994                                   moment the following categories are defined:
3995                                </t>
3996                                <t>
3997                                    <list>
3998                                        <t>DESCRIPTION -
3999                                            <list>
4000                                                <t>arbitrary textual description about the sampler
4001                                                (note that the character string may contain
4002                                                <xref target="character_set">escape sequences</xref>)</t>
4003                                            </list>
4004                                        </t>
4005                                        <t>VERSION -
4006                                            <list>
4007                                                <t>version of the sampler</t>
4008                                            </list>
4009                                        </t>
4010                                        <t>PROTOCOL_VERSION -
4011                                            <list>
4012                                                <t>version of the LSCP specification the sampler
4013                                                complies with (see <xref target="LSCP versioning" /> for details)</t>
4014                                            </list>
4015                                        </t>
4016                                        <t>INSTRUMENTS_DB_SUPPORT -
4017                                            <list>
4018                                                <t>either yes or no, specifies whether the
4019                                                sampler is build with instruments database support.</t>
4020                                            </list>
4021                                        </t>
4022                                    </list>
4023                                </t>
4024                            </list>
4025                        </t>
4026                        <t>The mentioned fields above don't have to be in particular order.
4027                        Other fields might be added in future.</t>
4028                    </section>
4029    
4030                    <section title="Getting global volume attenuation" anchor="GET VOLUME">
4031                        <t>The client can ask for the current global sampler-wide volume
4032                        attenuation by sending the following command:</t>
4033                        <t>
4034                            <list>
4035                                <t>GET VOLUME</t>
4036                            </list>
4037                        </t>
4038                        <t>Possible Answers:</t>
4039                        <t>
4040                            <list>
4041                                <t>The sampler will always answer by returning the optional
4042                                dotted floating point coefficient, reflecting the current
4043                                global volume attenuation.
4044                                </t>
4045                            </list>
4046                        </t>
4047                        <t>Note: it is up to the respective sampler engine whether to obey
4048                        that global volume parameter or not, but in general all engines SHOULD
4049                        use this parameter.</t>
4050                    </section>
4051    
4052                    <section title="Setting global volume attenuation" anchor="SET VOLUME">
4053                        <t>The client can alter the current global sampler-wide volume
4054                        attenuation by sending the following command:</t>
4055                        <t>
4056                            <list>
4057                                <t>SET VOLUME &lt;volume&gt;</t>
4058                            </list>
4059                        </t>
4060                       <t>Where &lt;volume&gt; should be replaced by the optional dotted
4061                       floating point value, reflecting the new global volume parameter.
4062                       This value might usually be in the range between 0.0 and 1.0, that
4063                       is for attenuating the overall volume.</t>
4064    
4065                        <t>Possible Answers:</t>
4066                        <t>
4067                            <list>
4068                                <t>"OK" -
4069                                    <list>
4070                                        <t>on success</t>
4071                                    </list>
4072                                </t>
4073                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4074                                    <list>
4075                                        <t>if the global volume was set, but there are noteworthy
4076                                        issue(s) related, providing an appropriate warning code and
4077                                        warning message</t>
4078                                    </list>
4079                                </t>
4080                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4081                                    <list>
4082                                        <t>in case it failed, providing an appropriate error code and error message</t>
4083                                    </list>
4084                                </t>
4085                            </list>
4086                        </t>
4087                    </section>
4088                </section>
4089    
4090    
4091                <section title="MIDI Instrument Mapping" anchor="MIDI Instrument Mapping">
4092                    <t>The MIDI protocol provides a way to switch between instruments
4093                    by sending so called MIDI bank select and MIDI program change
4094                    messages which are essentially just numbers. The following commands
4095                    allow to actually map arbitrary MIDI bank select / program change
4096                    numbers with real instruments.</t>
4097                    <t>The sampler allows to manage an arbitrary amount of MIDI
4098                    instrument maps which define which instrument to load on
4099                    which MIDI program change message.</t>
4100                    <t>By default, that is when the sampler is launched, there is no
4101                    map, thus the sampler will simply ignore all program change
4102                    messages. The front-end has to explicitly create at least one
4103                    map, add entries to the map and tell the respective sampler
4104                    channel(s) which MIDI instrument map to use, so the sampler
4105                    knows how to react on a given program change message on the
4106                    respective sampler channel, that is by switching to the
4107                    respectively defined engine type and loading the respective
4108                    instrument. See command
4109                    <xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref>
4110                    for how to assign a MIDI instrument map to a sampler channel.</t>
4111                    <t>Also note per MIDI specification a bank select message does not
4112                    cause to switch to another instrument. Instead when receiving a
4113                    bank select message the bank value will be stored and a subsequent
4114                    program change message (which may occur at any time) will finally
4115                    cause the sampler to switch to the respective instrument as
4116                    reflected by the current MIDI instrument map.</t>
4117    
4118                    <section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT_MAP">
4119                        <t>The front-end can add a new MIDI instrument map by sending
4120                        the following command:</t>
4121                        <t>
4122                            <list>
4123                                <t>ADD MIDI_INSTRUMENT_MAP [&lt;name&gt;]</t>
4124                            </list>
4125                        </t>
4126                        <t>Where &lt;name&gt; is an optional argument allowing to
4127                        assign a custom name to the new map. MIDI instrument Map
4128                        names do not have to be unique, but MUST be encapsulated
4129                        into apostrophes and support escape sequences as described
4130                        in chapter "<xref target="character_set">Character Set and Escape Sequences</xref>".
4131                        </t>
4132    
4133                        <t>Possible Answers:</t>
4134                        <t>
4135                            <list>
4136                                <t>"OK[&lt;map&gt;]" -
4137                                    <list>
4138                                        <t>in case a new MIDI instrument map could
4139                                        be added, where &lt;map&gt; reflects the
4140                                        unique ID of the newly created MIDI
4141                                        instrument map</t>
4142                                    </list>
4143                                </t>
4144                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4145                                    <list>
4146                                        <t>when a new map could not be created, which
4147                                        might never occur in practice</t>
4148                                    </list>
4149                                </t>
4150                            </list>
4151                        </t>
4152    
4153                        <t>Examples:</t>
4154                        <t>
4155                            <list>
4156                                <t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"</t>
4157                                <t>S: "OK[0]"</t>
4158                            </list>
4159                        </t>
4160                        <t>
4161                            <list>
4162                                <t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"</t>
4163                                <t>S: "OK[1]"</t>
4164                            </list>
4165                        </t>
4166                        <t>
4167                            <list>
4168                                <t>C: "ADD MIDI_INSTRUMENT_MAP"</t>
4169                                <t>S: "OK[5]"</t>
4170                            </list>
4171                        </t>
4172                    </section>
4173    
4174                    <section title="Delete one particular or all MIDI instrument maps" anchor="REMOVE MIDI_INSTRUMENT_MAP">
4175                        <t>The front-end can delete a particular MIDI instrument map
4176                        by sending the following command:</t>
4177                        <t>
4178                            <list>
4179                                <t>REMOVE MIDI_INSTRUMENT_MAP &lt;map&gt;</t>
4180                            </list>
4181                        </t>
4182                        <t>Where &lt;map&gt; reflects the unique ID of the map to delete
4183                        as returned by the <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
4184                        command.</t>
4185                        <t>The front-end can delete all MIDI instrument maps by
4186                        sending the following command:</t>
4187                        <t>
4188                            <list>
4189                                <t>REMOVE MIDI_INSTRUMENT_MAP ALL</t>
4190                            </list>
4191                        </t>
4192    
4193                        <t>Possible Answers:</t>
4194                        <t>
4195                            <list>
4196                                <t>"OK" -
4197                                    <list>
4198                                        <t>in case the map(s) could be deleted</t>
4199                                    </list>
4200                                </t>
4201                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4202                                    <list>
4203                                        <t>when the given map does not exist</t>
4204                                    </list>
4205                                </t>
4206                            </list>
4207                        </t>
4208    
4209                        <t>Examples:</t>
4210                        <t>
4211                            <list>
4212                                <t>C: "REMOVE MIDI_INSTRUMENT_MAP 0"</t>
4213                                <t>S: "OK"</t>
4214                            </list>
4215                        </t>
4216                        <t>
4217                            <list>
4218                                <t>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"</t>
4219                                <t>S: "OK"</t>
4220                            </list>
4221                        </t>
4222                    </section>
4223    
4224                    <section title="Get amount of existing MIDI instrument maps" anchor="GET MIDI_INSTRUMENT_MAPS">
4225                        <t>The front-end can retrieve the current amount of MIDI
4226                        instrument maps by sending the following command:</t>
4227                        <t>
4228                            <list>
4229                                <t>GET MIDI_INSTRUMENT_MAPS</t>
4230                            </list>
4231                        </t>
4232    
4233                        <t>Possible Answers:</t>
4234                        <t>
4235                            <list>
4236                                <t>The sampler will answer by returning the current
4237                                number of MIDI instrument maps.</t>
4238                            </list>
4239                        </t>
4240    
4241                        <t>Example:</t>
4242                        <t>
4243                            <list>
4244                                <t>C: "GET MIDI_INSTRUMENT_MAPS"</t>
4245                                <t>S: "2"</t>
4246                            </list>
4247                        </t>
4248                    </section>
4249    
4250                    <section title="Getting all created MIDI instrument maps" anchor="LIST MIDI_INSTRUMENT_MAPS">
4251                        <t>The number of MIDI instrument maps can change on runtime. To get the
4252                        current list of MIDI instrument maps, the front-end can send the
4253                        following command:</t>
4254                        <t>
4255                            <list>
4256                                <t>LIST MIDI_INSTRUMENT_MAPS</t>
4257                            </list>
4258                        </t>
4259                        <t>Possible Answers:</t>
4260                        <t>
4261                            <list>
4262                                <t>The sampler will answer by returning a comma separated list
4263                                with all MIDI instrument maps' numerical IDs.</t>
4264                            </list>
4265                        </t>
4266                        <t>Example:</t>
4267                        <t>
4268                            <list>
4269                                <t>C: "LIST MIDI_INSTRUMENT_MAPS"</t>
4270                                <t>S: "0,1,5,12"</t>
4271                            </list>
4272                        </t>
4273                    </section>
4274    
4275                    <section title="Getting MIDI instrument map information" anchor="GET MIDI_INSTRUMENT_MAP INFO">
4276                        <t>The front-end can ask for the current settings of a MIDI
4277                        instrument map by sending the following command:</t>
4278                        <t>
4279                            <list>
4280                                <t>GET MIDI_INSTRUMENT_MAP INFO &lt;map&gt;</t>
4281                            </list>
4282                        </t>
4283                        <t>Where &lt;map&gt; is the numerical ID of the map the
4284                        front-end is interested in as returned by the
4285                        <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
4286                        command.</t>
4287    
4288                        <t>Possible Answers:</t>
4289                        <t>
4290                            <list>
4291                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
4292                                Each answer line begins with the settings category name
4293                                followed by a colon and then a space character &lt;SP&gt; and finally
4294                                the info character string to that setting category. At the
4295                                moment the following categories are defined:</t>
4296    
4297                                <t>
4298                                    <list>
4299                                        <t>NAME -
4300                                            <list>
4301                                                <t>custom name of the given map,
4302                                                which does not have to be unique
4303                                                (note that this character string may contain
4304                                                 <xref target="character_set">escape sequences</xref>)</t>
4305                                            </list>
4306                                        </t>
4307                                        <t>DEFAULT -
4308                                            <list>
4309                                                <t>either true or false,
4310                                                defines whether this map is the default map</t>
4311                                            </list>
4312                                        </t>
4313                                    </list>
4314                                </t>
4315                            </list>
4316                        </t>
4317                        <t>The mentioned fields above don't have to be in particular order.</t>
4318    
4319                        <t>Example:</t>
4320                        <t>
4321                            <list>
4322                                <t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t>
4323                                <t>S: "NAME: Standard Map"</t>
4324                                <t>&nbsp;&nbsp;&nbsp;"DEFAULT: true"</t>
4325                                <t>&nbsp;&nbsp;&nbsp;"."</t>
4326                            </list>
4327                        </t>
4328                    </section>
4329    
4330                    <section title="Renaming a MIDI instrument map" anchor="SET MIDI_INSTRUMENT_MAP NAME">
4331                        <t>The front-end can alter the custom name of a MIDI
4332                        instrument map by sending the following command:</t>
4333                        <t>
4334                            <list>
4335                                <t>SET MIDI_INSTRUMENT_MAP NAME &lt;map&gt; &lt;name&gt;</t>
4336                            </list>
4337                        </t>
4338                        <t>Where &lt;map&gt; is the numerical ID of the map and
4339                        &lt;name&gt; the new custom name of the map, which does not
4340                        have to be unique (name MUST be encapsulated into apostrophes
4341                        and supports escape sequences as described in chapter
4342                        "<xref target="character_set">Character Set and Escape Sequences</xref>").
4343                        </t>
4344    
4345                        <t>Possible Answers:</t>
4346                        <t>
4347                            <list>
4348                                <t>"OK" -
4349                                    <list>
4350                                        <t>on success</t>
4351                                    </list>
4352                                </t>
4353                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4354                                    <list>
4355                                        <t>in case the given map does not exist</t>
4356                                    </list>
4357                                </t>
4358                            </list>
4359                        </t>
4360    
4361                        <t>Example:</t>
4362                        <t>
4363                            <list>
4364                                <t>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"</t>
4365                                <t>S: "OK"</t>
4366                            </list>
4367                        </t>
4368                    </section>
4369    
4370                    <section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT">
4371                        <t>The front-end can create a new or replace an existing entry
4372                        in a sampler's MIDI instrument map by sending the following
4373                        command:</t>
4374                        <t>
4375                            <list>
4376                                <t>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
4377                                &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
4378                                &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
4379                                [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>
4380                            </list>
4381                        </t>
4382                        <t>Where &lt;map&gt; is the numeric ID of the map to alter,
4383                        &lt;midi_bank&gt; is an integer value between
4384                        0..16383 reflecting the MIDI bank select index,
4385                        &lt;midi_prog&gt; an
4386                        integer value between 0..127 reflecting the MIDI program change
4387                        index, &lt;engine_name&gt; a sampler engine name as returned by
4388                        the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>
4389                        command (not encapsulated into apostrophes), &lt;filename&gt; the name
4390                        of the instrument's file to be deployed (encapsulated into apostrophes,
4391                        supporting escape sequences as described in chapter
4392                        "<xref target="character_set">Character Set and Escape Sequences</xref>"),
4393                        &lt;instrument_index&gt; the index (integer value) of the instrument
4394                        within the given file, &lt;volume_value&gt; reflects the master
4395                        volume of the instrument as optionally dotted number (where a
4396                        value &lt; 1.0 means attenuation and a value > 1.0 means
4397                        amplification). This parameter easily allows to adjust the
4398                        volume of all intruments within a custom instrument map
4399                        without having to adjust their instrument files. The
4400                        OPTIONAL &lt;instr_load_mode&gt; argument defines the life
4401                        time of the instrument, that is when the instrument should
4402                        be loaded, when freed and has exactly the following
4403                        possibilities:</t>
4404                        <t>
4405                            <list>
4406                                <t>"ON_DEMAND" -
4407                                    <list>
4408                                        <t>The instrument will be loaded when needed,
4409                                        that is when demanded by at least one sampler
4410                                        channel. It will immediately be freed from memory
4411                                        when not needed by any sampler channel anymore.</t>
4412                                    </list>
4413                                </t>
4414                                <t>"ON_DEMAND_HOLD" -
4415                                    <list>
4416                                        <t>The instrument will be loaded when needed,
4417                                        that is when demanded by at least one sampler
4418                                        channel. It will be kept in memory even when
4419                                        not needed by any sampler channel anymore.
4420                                        Instruments with this mode are only freed
4421                                        when the sampler is reset or all mapping
4422                                        entries with this mode (and respective
4423                                        instrument) are explicitly changed to
4424                                        "ON_DEMAND" and no sampler channel is using
4425                                        the instrument anymore.</t>
4426                                    </list>
4427                                </t>
4428                                <t>"PERSISTENT" -
4429                                    <list>
4430                                        <t>The instrument will immediately be loaded
4431                                        into memory when this mapping
4432                                        command is sent and the instrument is kept all
4433                                        the time. Instruments with this mode are
4434                                        only freed when the sampler is reset or all
4435                                        mapping entries with this mode (and
4436                                        respective instrument) are explicitly
4437                                        changed to "ON_DEMAND" and no sampler
4438                                        channel is using the instrument anymore.</t>
4439                                    </list>
4440                                </t>
4441                                <t>not supplied -
4442                                    <list>
4443                                        <t>In case there is no &lt;instr_load_mode&gt;
4444                                        argument given, it will be up to the
4445                                        InstrumentManager to decide which mode to use.
4446                                        Usually it will use "ON_DEMAND" if an entry
4447                                        for the given instrument does not exist in
4448                                        the InstrumentManager's list yet, otherwise
4449                                        if an entry already exists, it will simply
4450                                        stick with the mode currently reflected by
4451                                        the already existing entry, that is it will
4452                                        not change the mode.</t>
4453                                    </list>
4454                                </t>
4455                            </list>
4456                        </t>
4457                        <t>
4458                        The &lt;instr_load_mode&gt; argument thus allows to define an
4459                        appropriate strategy (low memory consumption vs. fast
4460                        instrument switching) for each instrument individually. Note, the
4461                        following restrictions apply to this argument: "ON_DEMAND_HOLD" and
4462                        "PERSISTENT" have to be supported by the respective sampler engine
4463                        (which is technically the case when the engine provides an
4464                        InstrumentManager for its format). If this is not the case the
4465                        argument will automatically fall back to the default value
4466                        "ON_DEMAND". Also the load mode of one instrument may
4467                        automatically change the laod mode of other instrument(s), i.e.
4468                        because the instruments are part of the same file and the
4469                        engine does not allow a way to manage load modes for them
4470                        individually. Due to this, in case the frontend shows the
4471                        load modes of entries, the frontend should retrieve the actual
4472                        mode by i.e. sending
4473                        <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
4474                        command(s). Finally the OPTIONAL &lt;name&gt; argument allows to set a custom name
4475                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
4476                        "<xref target="character_set">Character Set and Escape Sequences</xref>") for the
4477                        mapping entry, useful for frontends for displaying an appropriate name for
4478                        mapped instruments (using
4479                        <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
4480                        </t>
4481                        <t>
4482                        By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4483                        completely established in the sampler. The OPTIONAL "NON_MODAL" argument
4484                        however causes the respective "MAP MIDI_INSTRUMENT" command to return
4485                        immediately, that is to let the sampler establish the mapping in the
4486                        background. So this argument might be especially useful for mappings with
4487                        a "PERSISTENT" type, because these have to load the respective instruments
4488                        immediately and might thus block for a very long time. It is recommended
4489                        however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
4490                        because it has the following drawbacks: as "NON_MODAL" instructions return
4491                        immediately, they may not necessarily return an error i.e. when the given
4492                        instrument file turns out to be corrupt, beside that subsequent commands
4493                        in a LSCP instruction sequence might fail, because mandatory mappings are
4494                        not yet completed.
4495                        </t>
4496    
4497                        <t>Possible Answers:</t>
4498                        <t>
4499                            <list>
4500                                <t>"OK" -
4501                                    <list>
4502                                        <t>usually</t>
4503                                    </list>
4504                                </t>
4505                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4506                                    <list>
4507                                        <t>when the given map or engine does not exist or a value
4508                                        is out of range</t>
4509                                    </list>
4510                                </t>
4511                            </list>
4512                        </t>
4513    
4514                        <t>Examples:</t>
4515                        <t>
4516                            <list>
4517                                <t>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"</t>
4518                                <t>S: "OK"</t>
4519                            </list>
4520                        </t>
4521                        <t>
4522                            <list>
4523                                <t>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"</t>
4524                                <t>S: "OK"</t>
4525                            </list>
4526                        </t>
4527                        <t>
4528                            <list>
4529                                <t>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"</t>
4530                                <t>S: "OK"</t>
4531                                <t>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"</t>
4532                                <t>S: "OK"</t>
4533                            </list>
4534                        </t>
4535                        <t>
4536                            <list>
4537                                <t>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>
4538                                <t>S: "OK"</t>
4539                            </list>
4540                        </t>
4541                    </section>
4542    
4543                    <section title="Getting ammount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS">
4544                        <t>The front-end can query the amount of currently existing
4545                        entries in a MIDI instrument map by sending the following
4546                        command:</t>
4547                        <t>
4548                            <list>
4549                                <t>GET MIDI_INSTRUMENTS &lt;map&gt;</t>
4550                            </list>
4551                        </t>
4552                        <t>The front-end can query the amount of currently existing
4553                        entries in all MIDI instrument maps by sending the following
4554                        command:</t>
4555                        <t>
4556                            <list>
4557                                <t>GET MIDI_INSTRUMENTS ALL</t>
4558                            </list>
4559                        </t>
4560                        <t>Possible Answers:</t>
4561                        <t>
4562                            <list>
4563                                <t>The sampler will answer by sending the current number of
4564                                entries in the MIDI instrument map(s).</t>
4565                            </list>
4566                        </t>
4567    
4568                        <t>Example:</t>
4569                        <t>
4570                            <list>
4571                                <t>C: "GET MIDI_INSTRUMENTS 0"</t>
4572                                <t>S: "234"</t>
4573                            </list>
4574                        </t>
4575                        <t>
4576                            <list>
4577                                <t>C: "GET MIDI_INSTRUMENTS ALL"</t>
4578                                <t>S: "954"</t>
4579                            </list>
4580                        </t>
4581                    </section>
4582    
4583                    <section title="Getting indeces of all entries of a MIDI instrument map" anchor="LIST MIDI_INSTRUMENTS">
4584                        <t>The front-end can query a list of all currently existing
4585                        entries in a certain MIDI instrument map by sending the following
4586                        command:</t>
4587                        <t>
4588                            <list>
4589                                <t>LIST MIDI_INSTRUMENTS &lt;map&gt;</t>
4590                            </list>
4591                        </t>
4592                        <t>Where &lt;map&gt; is the numeric ID of the MIDI instrument map.</t>
4593                        <t>The front-end can query a list of all currently existing
4594                        entries of all MIDI instrument maps by sending the following
4595                        command:</t>
4596                        <t>
4597                            <list>
4598                                <t>LIST MIDI_INSTRUMENTS ALL</t>
4599                            </list>
4600                        </t>
4601    
4602                        <t>Possible Answers:</t>
4603                        <t>
4604                            <list>
4605                                <t>The sampler will answer by sending a comma separated
4606                                list of map ID - MIDI bank - MIDI program triples, where
4607                                each triple is encapsulated into curly braces. The
4608                                list is returned in one single line. Each triple
4609                                just reflects the key of the respective map entry,
4610                                thus subsequent
4611                                <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
4612                                command(s) are necessary to retrieve detailed informations
4613                                about each entry.</t>
4614                            </list>
4615                        </t>
4616    
4617                        <t>Example:</t>
4618                        <t>
4619                            <list>
4620                                <t>C: "LIST MIDI_INSTRUMENTS 0"</t>
4621                                <t>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"</t>
4622                            </list>
4623                        </t>
4624                    </section>
4625    
4626                    <section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT">
4627                        <t>The front-end can delete an entry from a MIDI instrument
4628                        map by sending the following command:</t>
4629                        <t>
4630                            <list>
4631                                <t>UNMAP MIDI_INSTRUMENT &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;</t>
4632                            </list>
4633                        </t>
4634                        <t>
4635                        Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
4636                        &lt;midi_bank&gt; is an integer value between 0..16383
4637                        reflecting the MIDI bank value and
4638                        &lt;midi_prog&gt; an integer value between
4639                        0..127 reflecting the MIDI program value of the map's entrie's key
4640                        index triple.
4641                        </t>
4642    
4643                        <t>Possible Answers:</t>
4644                        <t>
4645                            <list>
4646                                <t>"OK" -
4647                                    <list>
4648                                        <t>usually</t>
4649                                    </list>
4650                                </t>
4651                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4652                                    <list>
4653                                        <t>when index out of bounds</t>
4654                                    </list>
4655                                </t>
4656                            </list>
4657                        </t>
4658    
4659                        <t>Example:</t>
4660                        <t>
4661                            <list>
4662                                <t>C: "UNMAP MIDI_INSTRUMENT 0 2 127"</t>
4663                                <t>S: "OK"</t>
4664                            </list>
4665                        </t>
4666                    </section>
4667    
4668                    <section title="Get current settings of MIDI instrument map entry" anchor="GET MIDI_INSTRUMENT INFO">
4669                        <t>The front-end can retrieve the current settings of a certain
4670                        instrument map entry by sending the following command:</t>
4671                        <t>
4672                            <list>
4673                                <t>GET MIDI_INSTRUMENT INFO &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;</t>
4674                            </list>
4675                        </t>
4676                        <t>
4677                        Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
4678                        &lt;midi_bank&gt; is an integer value between 0..16383
4679                        reflecting the MIDI bank value, &lt;midi_bank&gt;
4680                        and &lt;midi_prog&gt; an integer value between
4681                        0..127 reflecting the MIDI program value of the map's entrie's key
4682                        index triple.
4683                        </t>
4684    
4685                        <t>Possible Answers:</t>
4686                        <t>
4687                            <list>
4688                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt;
4689                                separated list. Each answer line begins with the
4690                                information category name followed by a colon and then
4691                                a space character &lt;SP&gt; and finally the info
4692                                character string to that info category. At the moment
4693                                the following categories are defined:</t>
4694                                <t>"NAME" -
4695                                    <list>
4696                                        <t>Name for this MIDI instrument map entry (if defined).
4697                                        This name shall be used by frontends for displaying a
4698                                        name for this mapped instrument. It can be set and
4699                                        changed with the
4700                                        <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref>
4701                                        command and does not have to be unique.
4702                                        (note that this character string may contain
4703                                        <xref target="character_set">escape sequences</xref>)</t>
4704                                    </list>
4705                                </t>
4706                                <t>"ENGINE_NAME" -
4707                                    <list>
4708                                        <t>Name of the engine to be deployed for this
4709                                        instrument.</t>
4710                                    </list>
4711                                </t>
4712                                <t>"INSTRUMENT_FILE" -
4713                                    <list>
4714                                        <t>File name of the instrument
4715                                        (note that this path may contain
4716                                        <xref target="character_set">escape sequences</xref>).</t>
4717                                    </list>
4718                                </t>
4719                                <t>"INSTRUMENT_NR" -
4720                                    <list>
4721                                        <t>Index of the instrument within the file.</t>
4722                                    </list>
4723                                </t>
4724                                <t>"INSTRUMENT_NAME" -
4725                                    <list>
4726                                        <t>Name of the loaded instrument as reflected by its file.
4727                                        In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4728                                        cannot be changed (note that this character string may contain
4729                                        <xref target="character_set">escape sequences</xref>).</t>
4730                                    </list>
4731                                </t>
4732                                <t>"LOAD_MODE" -
4733                                    <list>
4734                                        <t>Life time of instrument
4735                                        (see <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> for details about this setting).</t>
4736                                    </list>
4737                                </t>
4738                                <t>"VOLUME" -
4739                                    <list>
4740                                        <t>master volume of the instrument as optionally
4741                                        dotted number (where a value &lt; 1.0 means attenuation
4742                                        and a value > 1.0 means amplification)</t>
4743                                    </list>
4744                                </t>
4745                                <t>The mentioned fields above don't have to be in particular order.</t>
4746                            </list>
4747                        </t>
4748    
4749                        <t>Example:</t>
4750                        <t>
4751                            <list>
4752                                <t>C: "GET MIDI_INSTRUMENT INFO 1 45 120"</t>
4753                                <t>S: "NAME: Drums for Foo Song"</t>
4754                                <t>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"</t>
4755                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t>
4756                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
4757                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Joe's Drumkit"</t>
4758                                <t>&nbsp;&nbsp;&nbsp;"LOAD_MODE: PERSISTENT"</t>
4759                                <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
4760                                <t>&nbsp;&nbsp;&nbsp;"."</t>
4761                            </list>
4762                        </t>
4763                    </section>
4764    
4765                    <section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS">
4766                        <t>The front-end can clear a whole MIDI instrument map, that
4767                        is delete all its entries by sending the following command:</t>
4768                        <t>
4769                            <list>
4770                                <t>CLEAR MIDI_INSTRUMENTS &lt;map&gt;</t>
4771                            </list>
4772                        </t>
4773                        <t>Where &lt;map&gt; is the numeric ID of the map to clear.</t>
4774                        <t>The front-end can clear all MIDI instrument maps, that
4775                        is delete all entries of all maps by sending the following
4776                        command:</t>
4777                        <t>
4778                            <list>
4779                                <t>CLEAR MIDI_INSTRUMENTS ALL</t>
4780                            </list>
4781                        </t>
4782                        <t>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the
4783                        maps, only their entries, thus the map's settings like
4784                        custom name will be preservevd.</t>
4785    
4786                       <t>Possible Answers:</t>
4787                        <t>
4788                            <list>
4789                                <t>"OK" -
4790                                    <list>
4791                                        <t>always</t>
4792                                    </list>
4793                                </t>
4794                            </list>
4795                        </t>
4796    
4797                        <t>Examples:</t>
4798                        <t>
4799                           <list>
4800                                <t>C: "CLEAR MIDI_INSTRUMENTS 0"</t>
4801                                <t>S: "OK"</t>
4802                            </list>
4803                        </t>
4804                        <t>
4805                           <list>
4806                                <t>C: "CLEAR MIDI_INSTRUMENTS ALL"</t>
4807                                <t>S: "OK"</t>
4808                            </list>
4809                        </t>
4810                    </section>
4811                </section>
4812    
4813    
4814                <section title="Managing Instruments Database" anchor="Managing Instruments Database">
4815                    <t>The following commands describe how to use and manage
4816                    the instruments database.</t>
4817                    <t>Notice:</t>
4818                        <t>
4819                            <list>
4820                                <t>All command arguments representing a path or
4821                                instrument/directory name support escape sequences as described in chapter
4822                                "<xref target="character_set">Character Set and Escape Sequences</xref>".
4823                                </t>
4824                                <t>All occurrences of a forward slash in instrument and directory
4825                                   names are escaped with its hex (\x2f) or octal (\057) escape sequence.
4826                                </t>
4827                            </list>
4828                        </t>
4829    
4830                    <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">
4831                        <t>The front-end can add a new instrument directory to the
4832                        instruments database by sending the following command:</t>
4833                        <t>
4834                            <list>
4835                                <t>ADD DB_INSTRUMENT_DIRECTORY &lt;dir&gt;</t>
4836                            </list>
4837                        </t>
4838                        <t>Where &lt;dir&gt; is the absolute path name of the directory
4839                        to be created (encapsulated into apostrophes).</t>
4840    
4841                        <t>Possible Answers:</t>
4842                        <t>
4843                            <list>
4844                                <t>"OK" -
4845                                    <list>
4846                                        <t>on success</t>
4847                                    </list>
4848                                </t>
4849                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4850                                    <list>
4851                                        <t>when the directory could not be created, which
4852                                        can happen if the directory already exists or the
4853                                        name contains not allowed symbols</t>
4854                                    </list>
4855                                </t>
4856                            </list>
4857                        </t>
4858    
4859                        <t>Examples:</t>
4860                        <t>
4861                            <list>
4862                                <t>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"</t>
4863                                <t>S: "OK"</t>
4864                            </list>
4865                        </t>
4866                    </section>
4867    
4868                    <section title="Deleting an instrument directory" anchor="REMOVE DB_INSTRUMENT_DIRECTORY">
4869                        <t>The front-end can delete a particular instrument directory
4870                        from the instruments database by sending the following command:</t>
4871                        <t>
4872                            <list>
4873                                <t>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] &lt;dir&gt;</t>
4874                            </list>
4875                        </t>
4876                        <t>Where &lt;dir&gt; is the absolute path name of the directory
4877                        to delete. The optional FORCE argument can be used to
4878                        force the deletion of a non-empty directory and all its content.</t>
4879    
4880                        <t>Possible Answers:</t>
4881                        <t>
4882                            <list>
4883                                <t>"OK" -
4884                                    <list>
4885                                        <t>if the directory is deleted successfully</t>
4886                                    </list>
4887                                </t>
4888                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4889                                    <list>
4890                                        <t>if the given directory does not exist, or
4891                                        if trying to delete a non-empty directory,
4892                                        without using the FORCE argument.</t>
4893                                    </list>
4894                                </t>
4895                            </list>
4896                        </t>
4897    
4898                        <t>Examples:</t>
4899                        <t>
4900                            <list>
4901                                <t>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"</t>
4902                                <t>S: "OK"</t>
4903                            </list>
4904                        </t>
4905                    </section>
4906    
4907                    <section title="Getting amount of instrument directories" anchor="GET DB_INSTRUMENT_DIRECTORIES">
4908                        <t>The front-end can retrieve the current amount of
4909                        directories in a specific directory by sending the following command:</t>
4910                        <t>
4911                            <list>
4912                                <t>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4913                            </list>
4914                        </t>
4915                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4916                        name of the directory. If RECURSIVE is specified, the number of
4917                        all directories, including those located in subdirectories of the
4918                        specified directory, will be returned.</t>
4919    
4920                        <t>Possible Answers:</t>
4921                        <t>
4922                            <list>
4923                                <t>The current number of instrument directories
4924                                in the specified directory.</t>
4925                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4926                                    <list>
4927                                        <t>if the given directory does not exist.</t>
4928                                    </list>
4929                                </t>
4930                            </list>
4931                        </t>
4932    
4933                        <t>Example:</t>
4934                        <t>
4935                            <list>
4936                                <t>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"</t>
4937                                <t>S: "2"</t>
4938                            </list>
4939                        </t>
4940                    </section>
4941    
4942                    <section title="Listing all directories in specific directory" anchor="LIST DB_INSTRUMENT_DIRECTORIES">
4943                        <t>The front-end can retrieve the current list of directories
4944                        in specific directory by sending the following command:</t>
4945                        <t>
4946                            <list>
4947                                <t>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4948                            </list>
4949                        </t>
4950                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4951                        name of the directory. If RECURSIVE is specified, the absolute path names
4952                        of all directories, including those located in subdirectories of the
4953                        specified directory, will be returned.</t>
4954    
4955                        <t>Possible Answers:</t>
4956                        <t>
4957                            <list>
4958                                <t>A comma separated list of all instrument directories
4959                                (encapsulated into apostrophes) in the specified directory.</t>
4960                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4961                                    <list>
4962                                        <t>if the given directory does not exist.</t>
4963                                    </list>
4964                                </t>
4965                            </list>
4966                        </t>
4967                        <t>Example:</t>
4968                        <t>
4969                            <list>
4970                                <t>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"</t>
4971                                <t>S: "'Piano Collection','Percussion Collection'"</t>
4972                            </list>
4973                        </t>
4974                        <t>
4975                            <list>
4976                                <t>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"</t>
4977                                <t>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"</t>
4978                            </list>
4979                        </t>
4980                    </section>
4981    
4982                    <section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO">
4983                        <t>The front-end can ask for the current settings of an
4984                        instrument directory by sending the following command:</t>
4985                        <t>
4986                            <list>
4987                                <t>GET DB_INSTRUMENT_DIRECTORY INFO &lt;dir&gt;</t>
4988                            </list>
4989                        </t>
4990                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4991                        name of the directory the front-end is interested in.</t>
4992    
4993                        <t>Possible Answers:</t>
4994                        <t>
4995                            <list>
4996                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
4997                                Each answer line begins with the settings category name
4998                                followed by a colon and then a space character &lt;SP&gt; and finally
4999                                the info character string to that setting category. At the
5000                                moment the following categories are defined:</t>
5001    
5002                                <t>
5003                                    <list>
5004                                        <t>DESCRIPTION -
5005                                            <list>
5006                                                <t>A brief description of the directory content.
5007                                                Note that the character string may contain
5008                                                <xref target="character_set">escape sequences</xref>.</t>
5009                                            </list>
5010                                        </t>
5011                                        <t>CREATED -
5012                                            <list>
5013                                                <t>The creation date and time of the directory,
5014                                                represented in "YYYY-MM-DD HH:MM:SS" format</t>
5015                                            </list>
5016                                        </t>
5017                                        <t>MODIFIED -
5018                                            <list>
5019                                                <t>The date and time of the last modification of the
5020                                                directory, represented in "YYYY-MM-DD HH:MM:SS" format</t>
5021                                            </list>
5022                                        </t>
5023                                    </list>
5024                                </t>
5025                            </list>
5026                        </t>
5027                        <t>The mentioned fields above don't have to be in particular order.</t>
5028    
5029                        <t>Example:</t>
5030                        <t>
5031                            <list>
5032                                <t>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"</t>
5033                                <t>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."</t>
5034                                <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
5035                                <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
5036                                <t>&nbsp;&nbsp;&nbsp;"."</t>
5037                            </list>
5038                        </t>
5039                    </section>
5040    
5041                    <section title="Renaming an instrument directory" anchor="SET DB_INSTRUMENT_DIRECTORY NAME">
5042                        <t>The front-end can alter the name of a specific
5043                        instrument directory by sending the following command:</t>
5044                        <t>
5045                            <list>
5046                                <t>SET DB_INSTRUMENT_DIRECTORY NAME &lt;dir&gt; &lt;name&gt;</t>
5047                            </list>
5048                        </t>
5049                        <t>Where &lt;dir&gt; is the absolute path name of the directory and
5050                        &lt;name&gt; is the new name for that directory.</t>
5051    
5052                        <t>Possible Answers:</t>
5053                        <t>
5054                            <list>
5055                                <t>"OK" -
5056                                    <list>
5057                                        <t>on success</t>
5058                                    </list>
5059                                </t>
5060                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5061                                    <list>
5062                                        <t>in case the given directory does not exists,
5063                                        or if a directory with name equal to the new
5064                                        name already exists.</t>
5065                                    </list>
5066                                </t>
5067                            </list>
5068                        </t>
5069    
5070                        <t>Example:</t>
5071                        <t>
5072                            <list>
5073                                <t>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"</t>
5074                                <t>S: "OK"</t>
5075                            </list>
5076                        </t>
5077                    </section>
5078    
5079                    <section title="Moving an instrument directory" anchor="MOVE DB_INSTRUMENT_DIRECTORY">
5080                        <t>The front-end can move a specific
5081                        instrument directory by sending the following command:</t>
5082                        <t>
5083                            <list>
5084                                <t>MOVE DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5085                            </list>
5086                        </t>
5087                        <t>Where &lt;dir&gt; is the absolute path name of the directory
5088                        to move and &lt;dst&gt; is the location where the directory will
5089                        be moved to.</t>
5090    
5091                        <t>Possible Answers:</t>
5092                        <t>
5093                            <list>
5094                                <t>"OK" -
5095                                    <list>
5096                                        <t>on success</t>
5097                                    </list>
5098                                </t>
5099                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5100                                    <list>
5101                                        <t>in case a given directory does not exists,
5102                                        or if a directory with name equal to the name
5103                                        of the specified directory already exists in
5104                                        the destination directory. Error is also thrown
5105                                        when trying to move a directory to a subdirectory
5106                                        of itself.</t>
5107                                    </list>
5108                                </t>
5109                            </list>
5110                        </t>
5111    
5112                        <t>Example:</t>
5113                        <t>
5114                            <list>
5115                                <t>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"</t>
5116                                <t>S: "OK"</t>
5117                            </list>
5118                        </t>
5119                    </section>
5120    
5121                    <section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY">
5122                        <t>The front-end can copy a specific
5123                        instrument directory by sending the following command:</t>
5124                        <t>
5125                            <list>
5126                                <t>COPY DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5127                            </list>
5128                        </t>
5129                        <t>Where &lt;dir&gt; is the absolute path name of the directory
5130                        to copy and &lt;dst&gt; is the location where the directory will
5131                        be copied to.</t>
5132    
5133                        <t>Possible Answers:</t>
5134                        <t>
5135                            <list>
5136                                <t>"OK" -
5137                                    <list>
5138                                        <t>on success</t>
5139                                    </list>
5140                                </t>
5141                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5142                                    <list>
5143                                        <t>in case a given directory does not exists,
5144                                        or if a directory with name equal to the name
5145                                        of the specified directory already exists in
5146                                        the destination directory. Error is also thrown
5147                                        when trying to copy a directory to a subdirectory
5148                                        of itself.</t>
5149                                    </list>
5150                                </t>
5151                            </list>
5152                        </t>
5153    
5154                        <t>Example:</t>
5155                        <t>
5156                            <list>
5157                                <t>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"</t>
5158                                <t>S: "OK"</t>
5159                            </list>
5160                        </t>
5161                    </section>
5162    
5163                    <section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">
5164                        <t>The front-end can alter the description of a specific
5165                        instrument directory by sending the following command:</t>
5166                        <t>
5167                            <list>
5168                                <t>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION &lt;dir&gt; &lt;desc&gt;</t>
5169                            </list>
5170                        </t>
5171                        <t>Where &lt;dir&gt; is the absolute path name of the directory and
5172                        &lt;desc&gt; is the new description for the directory
5173                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
5174                        "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5175    
5176                        <t>Possible Answers:</t>
5177                        <t>
5178                            <list>
5179                                <t>"OK" -
5180                                    <list>
5181                                        <t>on success</t>
5182                                    </list>
5183                                </t>
5184                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5185                                    <list>
5186                                        <t>in case the given directory does not exists.</t>
5187                                    </list>
5188                                </t>
5189                            </list>
5190                        </t>
5191    
5192                        <t>Example:</t>
5193                        <t>
5194                            <list>
5195                                <t>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"</t>
5196                                <t>S: "OK"</t>
5197                            </list>
5198                        </t>
5199                    </section>
5200    
5201                    <section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES">
5202                        <t>The front-end can search for directories
5203                        in specific directory by sending the following command:</t>
5204                        <t>
5205                            <list>
5206                                <t>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5207                            </list>
5208                        </t>
5209                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5210                        name of the directory to search in. If NON_RECURSIVE is specified, the
5211                        directories located in subdirectories of the specified directory will not
5212                        be searched. &lt;criteria-list&gt; is a list of search criterias
5213                        in form of "key1=val1 key2=val2 ...". The following criterias are
5214                        allowed:</t>
5215                        <t>
5216                          <t>NAME='&lt;search-string&gt;'
5217                              <list>
5218                                  <t>Restricts the search to directories, which names
5219                                  satisfy the supplied search string (encapsulated into apostrophes,
5220                                  supporting escape sequences as described in chapter
5221                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5222                              </list>
5223                          </t>
5224    
5225                          <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5226                              <list>
5227                                  <t>Restricts the search to directories, which creation
5228                                  date satisfies the specified period, where &lt;date-after&gt;
5229                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5230                                  If &lt;date-after&gt; is omitted the search is restricted to
5231                                  directories created before &lt;date-before&gt;. If
5232                                  &lt;date-before&gt; is omitted, the search is restricted
5233                                  to directories created after &lt;date-after&gt;.</t>
5234                              </list>
5235                          </t>
5236    
5237                          <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5238                              <list>
5239                                  <t>Restricts the search to directories, which
5240                                  date of last modification satisfies the specified period, where
5241                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5242                                  format. If &lt;date-after&gt; is omitted the search is restricted to
5243                                  directories, which are last modified before &lt;date-before&gt;. If
5244                                  &lt;date-before&gt; is omitted, the search is restricted to directories,
5245                                  which are last modified after &lt;date-after&gt;.</t>
5246                              </list>
5247                          </t>
5248    
5249                          <t>DESCRIPTION='&lt;search-string&gt;'
5250                              <list>
5251                                  <t>Restricts the search to directories with description
5252                                  that satisfies the supplied search string
5253                                  (encapsulated into apostrophes, supporting escape
5254                                  sequences as described in chapter
5255                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5256                              </list>
5257                          </t>
5258                        </t>
5259    
5260                        <t>Where &lt;search-string&gt; is either a regular expression, or a
5261                        word list separated with spaces for OR search and with '+' for AND search.</t>
5262    
5263                        <t>Possible Answers:</t>
5264                        <t>
5265                            <list>
5266                                <t>A comma separated list with the absolute path names (encapsulated into
5267                                apostrophes) of all directories in the specified directory that satisfy
5268                                the supplied search criterias.</t>
5269                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5270                                    <list>
5271                                        <t>if the given directory does not exist.</t>
5272                                    </list>
5273                                </t>
5274                            </list>
5275                        </t>
5276                        <t>Example:</t>
5277                        <t>
5278                            <list>
5279                                <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"</t>
5280                                <t>S: "'/Piano Collection'"</t>
5281                            </list>
5282                        </t>
5283                        <t>
5284                            <list>
5285                                <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"</t>
5286                                <t>S: "'/Piano Collection','/Percussions'"</t>
5287                            </list>
5288                        </t>
5289                    </section>
5290    
5291                    <section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS">
5292                        <t>The front-end can add one or more instruments
5293                        to the instruments database by sending the following command:</t>
5294                        <t>
5295                            <list>
5296                                <t>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]</t>
5297                            </list>
5298                        </t>
5299                        <t>Where &lt;db_dir&gt; is the absolute path name of a directory
5300                        (encapsulated into apostrophes) in the instruments database in which
5301                        only the new instruments (that are not already in the database) will
5302                        be added, &lt;file_path&gt; is the absolute path name of a file or
5303                        directory in the file system (encapsulated into apostrophes). In case
5304                        an instrument file is supplied, only the instruments in the specified
5305                        file will be added to the instruments database. If the optional
5306                        &lt;instr_index&gt; (the index of the instrument within the given file)
5307                        is supplied too, then only the specified instrument will be added.
5308                        In case a directory is supplied, the instruments in that directory
5309                        will be added. The OPTIONAL &lt;mode&gt; argument is only applied
5310                        when a directory is provided as &lt;file_path&gt; and specifies how the
5311                        scanning will be done and has exactly the following possibilities:</t>
5312                        <t>
5313                            <list>
5314                                <t>"RECURSIVE" -
5315                                    <list>
5316                                        <t>All instruments will be processed, including those
5317                                        in the subdirectories, and the respective subdirectory
5318                                        tree structure will be recreated in the instruments
5319                                        database</t>
5320                                    </list>
5321                                </t>
5322                                <t>"NON_RECURSIVE" -
5323                                    <list>
5324                                        <t>Only the instruments in the specified directory
5325                                        will be added, the instruments in the subdirectories
5326                                        will not be processed.</t>
5327                                    </list>
5328                                </t>
5329                                <t>"FLAT" -
5330                                    <list>
5331                                        <t>All instruments will be processed, including those
5332                                        in the subdirectories, but the respective subdirectory
5333                                        structure will not be recreated in the instruments
5334                                        database. All instruments will be added directly in
5335                                        the specified database directory.</t>
5336                                    </list>
5337                                </t>
5338                            </list>
5339                        </t>
5340    
5341                     <t>The difference between regular and NON_MODAL versions of the command
5342                        is that the regular command returns when the scanning is finished
5343                        while NON_MODAL version returns immediately and a background process is launched.
5344                        The <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref>
5345                        command can be used to monitor the scanning progress.</t>
5346    
5347                        <t>Possible Answers:</t>
5348                        <t>
5349                            <list>
5350                                <t>"OK" -
5351                                    <list>
5352                                        <t>on success when NON_MODAL is not supplied</t>
5353                                    </list>
5354                                </t>
5355                                <t>"OK[&lt;job-id&gt;]" -
5356                                    <list>
5357                                        <t>on success when NON_MODAL is supplied, where &lt;job-id&gt;
5358                                        is a numerical ID used to obtain status information about the job progress.
5359                                        See <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref>
5360                                        </t>
5361                                    </list>
5362                                </t>
5363                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5364                                    <list>
5365                                        <t>if an invalid path is specified.</t>
5366                                    </list>
5367                                </t>
5368                            </list>
5369                        </t>
5370    
5371                        <t>Examples:</t>
5372                        <t>
5373                            <list>
5374                                <t>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"</t>
5375                                <t>S: "OK"</t>
5376                            </list>
5377                        </t>
5378                    </section>
5379    
5380                    <section title="Removing an instrument" anchor="REMOVE DB_INSTRUMENT">
5381                        <t>The front-end can remove a particular instrument
5382                        from the instruments database by sending the following command:</t>
5383                        <t>
5384                            <list>
5385                                <t>REMOVE DB_INSTRUMENT &lt;instr_path&gt;</t>
5386                            </list>
5387                        </t>
5388                        <t>Where &lt;instr_path&gt; is the absolute path name
5389                        (in the instruments database) of the instrument to remove.</t>
5390    
5391                        <t>Possible Answers:</t>
5392                        <t>
5393                            <list>
5394                                <t>"OK" -
5395                                    <list>
5396                                        <t>if the instrument is removed successfully</t>
5397                                    </list>
5398                                </t>
5399                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5400                                    <list>
5401                                        <t>if the given path does not exist or
5402                                        is a directory.</t>
5403                                    </list>
5404                                </t>
5405                            </list>
5406                        </t>
5407    
5408                        <t>Examples:</t>
5409                        <t>
5410                            <list>
5411                                <t>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"</t>
5412                                <t>S: "OK"</t>
5413                            </list>
5414                        </t>
5415                    </section>
5416    
5417                    <section title="Getting amount of instruments" anchor="GET DB_INSTRUMENTS">
5418                        <t>The front-end can retrieve the current amount of
5419                        instruments in a specific directory by sending the following command:</t>
5420                        <t>
5421                            <list>
5422                                <t>GET DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5423                            </list>
5424                        </t>
5425                        <t>Where &lt;dir&gt; should be replaced by the absolute path name
5426                        of the directory. If RECURSIVE is specified, the number of all
5427                        instruments, including those located in subdirectories of the
5428                        specified directory, will be returned.</t>
5429    
5430                        <t>Possible Answers:</t>
5431                        <t>
5432                            <list>
5433                                <t>The current number of instruments
5434                                in the specified directory.</t>
5435                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5436                                    <list>
5437                                        <t>if the given directory does not exist.</t>
5438                                    </list>
5439                                </t>
5440                            </list>
5441                        </t>
5442    
5443                        <t>Example:</t>
5444                        <t>
5445                            <list>
5446                                <t>C: "GET DB_INSTRUMENTS '/Piano Collection'"</t>
5447                                <t>S: "2"</t>
5448                            </list>
5449                        </t>
5450                    </section>
5451    
5452                    <section title="Listing all instruments in specific directory" anchor="LIST DB_INSTRUMENTS">
5453                        <t>The front-end can retrieve the current list of instruments
5454                        in specific directory by sending the following command:</t>
5455                        <t>
5456                            <list>
5457                                <t>LIST DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5458                            </list>
5459                        </t>
5460                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5461                        name of the directory. If RECURSIVE is specified, the absolute path
5462                        names of all instruments, including those located in subdirectories
5463                        of the specified directory, will be returned.</t>
5464    
5465                        <t>Possible Answers:</t>
5466                        <t>
5467                            <list>
5468                                <t>A comma separated list of all instruments
5469                                (encapsulated into apostrophes) in the specified directory.</t>
5470                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5471                                    <list>
5472                                        <t>if the given directory does not exist.</t>
5473                                    </list>
5474                                </t>
5475                            </list>
5476                        </t>
5477                        <t>Example:</t>
5478                        <t>
5479                            <list>
5480                                <t>C: "LIST DB_INSTRUMENTS '/Piano Collection'"</t>
5481                                <t>S: "'Bosendorfer 290','Steinway D'"</t>
5482                            </list>
5483                        </t>
5484                        <t>
5485                            <list>
5486                                <t>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"</t>
5487                                <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"</t>
5488                            </list>
5489                        </t>
5490                    </section>
5491    
5492                    <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO">
5493                        <t>The front-end can ask for the current settings of an
5494                        instrument by sending the following command:</t>
5495                        <t>
5496                            <list>
5497                                <t>GET DB_INSTRUMENT INFO &lt;instr_path&gt;</t>
5498                            </list>
5499                        </t>
5500                        <t>Where &lt;instr_path&gt; should be replaced by the absolute path
5501                        name of the instrument the front-end is interested in.</t>
5502    
5503                        <t>Possible Answers:</t>
5504                        <t>
5505                            <list>
5506                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5507                                Each answer line begins with the settings category name
5508                                followed by a colon and then a space character &lt;SP&gt; and finally
5509                                the info character string to that setting category. At the
5510                                moment the following categories are defined:</t>
5511    
5512                                <t>
5513                                    <list>
5514                                        <t>INSTRUMENT_FILE -
5515                                            <list>
5516                                                <t>File name of the instrument.
5517                                                Note that the character string may contain
5518                                                <xref target="character_set">escape sequences</xref>.</t>
5519                                            </list>
5520                                        </t>
5521                                        <t>INSTRUMENT_NR -
5522                                            <list>
5523                                                <t>Index of the instrument within the file.</t>
5524                                            </list>
5525                                        </t>
5526                                        <t>FORMAT_FAMILY -
5527                                            <list>
5528                                                <t>The format family of the instrument.</t>
5529                                            </list>
5530                                        </t>
5531                                        <t>FORMAT_VERSION -
5532                                            <list>
5533                                                <t>The format version of the instrument.</t>
5534                                            </list>
5535                                        </t>
5536                                        <t>SIZE -
5537                                            <list>
5538                                                <t>The size of the instrument in bytes.</t>
5539                                            </list>
5540                                        </t>
5541                                        <t>CREATED -
5542                                            <list>
5543                                                <t>The date and time when the instrument is added
5544                                                in the instruments database, represented in
5545                                               "YYYY-MM-DD HH:MM:SS" format</t>
5546                                            </list>
5547                                        </t>
5548                                        <t>MODIFIED -
5549                                            <list>
5550                                                <t>The date and time of the last modification of the
5551                                                instrument's database settings, represented in
5552                                                "YYYY-MM-DD HH:MM:SS" format</t>
5553                                            </list>
5554                                        </t>
5555                                        <t>DESCRIPTION -
5556                                            <list>
5557                                                <t>A brief description of the instrument.
5558                                                Note that the character string may contain
5559                                                <xref target="character_set">escape sequences</xref>.</t>
5560                                            </list>
5561                                        </t>
5562                                        <t>IS_DRUM -
5563                                            <list>
5564                                                <t>either true or false, determines whether the
5565                                                instrument is a drumkit or a chromatic instrument</t>
5566                                            </list>
5567                                        </t>
5568                                        <t>PRODUCT -
5569                                            <list>
5570                                                <t>The product title of the instrument.
5571                                                Note that the character string may contain
5572                                                <xref target="character_set">escape sequences</xref>.</t>
5573                                            </list>
5574                                        </t>
5575                                        <t>ARTISTS -
5576                                            <list>
5577                                                <t>Lists the artist names.
5578                                                Note that the character string may contain
5579                                                <xref target="character_set">escape sequences</xref>.</t>
5580                                            </list>
5581                                        </t>
5582                                        <t>KEYWORDS -
5583                                            <list>
5584                                                <t>Provides a list of keywords that refer to the instrument.
5585                                                Keywords are separated with semicolon and blank.
5586                                                Note that the character string may contain
5587                                                <xref target="character_set">escape sequences</xref>.</t>
5588                                            </list>
5589                                        </t>
5590                                    </list>
5591                                </t>
5592                            </list>
5593                        </t>
5594                        <t>The mentioned fields above don't have to be in particular order.</t>
5595    
5596                        <t>Example:</t>
5597                        <t>
5598                            <list>
5599                                <t>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"</t>
5600                                <t>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"</t>
5601                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
5602                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
5603                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 2"</t>
5604                                <t>&nbsp;&nbsp;&nbsp;"SIZE: 2050871870"</t>
5605                                <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
5606                                <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
5607                                <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: "</t>
5608                                <t>&nbsp;&nbsp;&nbsp;"IS_DRUM: false"</t>
5609                                <t>&nbsp;&nbsp;&nbsp;"PRODUCT: GRANDIOSO Bosendorfer 290"</t>
5610                                <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Post Musical Instruments"</t>
5611                                <t>&nbsp;&nbsp;&nbsp;"KEYWORDS: Bosendorfer"</t>
5612                                <t>&nbsp;&nbsp;&nbsp;"."</t>
5613                            </list>
5614                        </t>
5615                    </section>
5616    
5617                    <section title="Renaming an instrument" anchor="SET DB_INSTRUMENT NAME">
5618                        <t>The front-end can alter the name of a specific
5619                        instrument by sending the following command:</t>
5620                        <t>
5621                            <list>
5622                                <t>SET DB_INSTRUMENT NAME &lt;instr&gt; &lt;name&gt;</t>
5623                            </list>
5624                        </t>
5625                        <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5626                        &lt;name&gt; is the new name for that instrument.</t>
5627    
5628                        <t>Possible Answers:</t>
5629                        <t>
5630                            <list>
5631                                <t>"OK" -
5632                                    <list>
5633                                        <t>on success</t>
5634                                    </list>
5635                                </t>
5636                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5637                                    <list>
5638                                        <t>in case the given instrument does not exists,
5639                                        or if an instrument with name equal to the new
5640                                        name already exists.</t>
5641                                    </list>
5642                                </t>
5643                            </list>
5644                        </t>
5645    
5646                        <t>Example:</t>
5647                        <t>
5648                            <list>
5649                                <t>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"</t>
5650                                <t>S: "OK"</t>
5651                            </list>
5652                        </t>
5653                    </section>
5654    
5655                    <section title="Moving an instrument" anchor="MOVE DB_INSTRUMENT">
5656                        <t>The front-end can move a specific instrument to another directory by
5657                        sending the following command:</t>
5658                        <t>
5659                            <list>
5660                                <t>MOVE DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5661                            </list>
5662                        </t>
5663                        <t>Where &lt;instr&gt; is the absolute path name of the instrument
5664                        to move and &lt;dst&gt; is the directory where the instrument will
5665                        be moved to.</t>
5666    
5667                        <t>Possible Answers:</t>
5668                        <t>
5669                            <list>
5670                                <t>"OK" -
5671                                    <list>
5672                                        <t>on success</t>
5673                                    </list>
5674                                </t>
5675                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5676                                    <list>
5677                                        <t>in case the given instrument does not exists,
5678                                        or if an instrument with name equal to the name of the
5679                                        specified instrument already exists in the destination
5680                                        directory.</t>
5681                                    </list>
5682                                </t>
5683                            </list>
5684                        </t>
5685    
5686                        <t>Example:</t>
5687                        <t>
5688                            <list>
5689                                <t>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"</t>
5690                                <t>S: "OK"</t>
5691                            </list>
5692                        </t>
5693                    </section>
5694    
5695                    <section title="Copying instruments" anchor="COPY DB_INSTRUMENT">
5696                        <t>The front-end can copy a specific instrument to another directory by
5697                        sending the following command:</t>
5698                        <t>
5699                            <list>
5700                                <t>COPY DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5701                            </list>
5702                        </t>
5703                        <t>Where &lt;instr&gt; is the absolute path name of the instrument
5704                        to copy and &lt;dst&gt; is the directory where the instrument will
5705                        be copied to.</t>
5706    
5707                        <t>Possible Answers:</t>
5708                        <t>
5709                            <list>
5710                                <t>"OK" -
5711                                    <list>
5712                                        <t>on success</t>
5713                                    </list>
5714                                </t>
5715                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5716                                    <list>
5717                                        <t>in case the given instrument does not exists,
5718                                        or if an instrument with name equal to the name of the
5719                                        specified instrument already exists in the destination
5720                                        directory.</t>
5721                                    </list>
5722                                </t>
5723                            </list>
5724                        </t>
5725    
5726                        <t>Example:</t>
5727                        <t>
5728                            <list>
5729                                <t>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"</t>
5730                                <t>S: "OK"</t>
5731                            </list>
5732                        </t>
5733                    </section>
5734    
5735                    <section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION">
5736                        <t>The front-end can alter the description of a specific
5737                        instrument by sending the following command:</t>
5738                        <t>
5739                            <list>
5740                                <t>SET DB_INSTRUMENT DESCRIPTION &lt;instr&gt; &lt;desc&gt;</t>
5741                            </list>
5742                        </t>
5743                        <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5744                        &lt;desc&gt; is the new description for the instrument
5745                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
5746                        "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5747    
5748                        <t>Possible Answers:</t>
5749                        <t>
5750                            <list>
5751                                <t>"OK" -
5752                                    <list>
5753                                        <t>on success</t>
5754                                    </list>
5755                                </t>
5756                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5757                                    <list>
5758                                        <t>in case the given instrument does not exists.</t>
5759                                    </list>
5760                                </t>
5761                            </list>
5762                        </t>
5763    
5764                        <t>Example:</t>
5765                        <t>
5766                            <list>
5767                                <t>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"</t>
5768                                <t>S: "OK"</t>
5769                            </list>
5770                        </t>
5771                    </section>
5772    
5773                    <section title="Finding instruments" anchor="FIND DB_INSTRUMENTS">
5774                        <t>The front-end can search for instruments
5775                        in specific directory by sending the following command:</t>
5776                        <t>
5777                            <list>
5778                                <t>FIND DB_INSTRUMENTS [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5779                            </list>
5780                        </t>
5781                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5782                        name of the directory to search in. If NON_RECURSIVE is specified, the
5783                        directories located in subdirectories of the specified directory will not
5784                        be searched. &lt;criteria-list&gt; is a list of search criterias
5785                        in form of "key1=val1 key2=val2 ...". The following criterias are
5786                        allowed:</t>
5787                        <t>
5788                          <t>NAME='&lt;search-string&gt;'
5789                              <list>
5790                                  <t>Restricts the search to instruments, which names
5791                                  satisfy the supplied search string (encapsulated into apostrophes,
5792                                  supporting escape sequences as described in chapter
5793                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5794                              </list>
5795                          </t>
5796    
5797                          <t>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
5798                              <list>
5799                                  <t>Restricts the search to instruments, which
5800                                  size is in the specified range. If &lt;min&gt; is omitted,
5801                                  the search results are restricted to instruments with size less then
5802                                  or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
5803                                  search is restricted to instruments with size greater then
5804                                  or equal to &lt;min&gt;.</t>
5805                              </list>
5806                          </t>
5807    
5808                          <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5809                              <list>
5810                                  <t>Restricts the search to instruments, which creation
5811                                  date satisfies the specified period, where &lt;date-after&gt;
5812                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5813                                  If &lt;date-after&gt; is omitted the search is restricted to
5814                                  instruments created before &lt;date-before&gt;. If
5815                                  &lt;date-before&gt; is omitted, the search is restricted
5816                                  to instruments created after &lt;date-after&gt;.</t>
5817                              </list>
5818                          </t>
5819    
5820                          <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5821                              <list>
5822                                  <t>Restricts the search to instruments, which
5823                                  date of last modification satisfies the specified period, where
5824                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5825                                  format. If &lt;date-after&gt; is omitted the search is restricted to
5826                                  instruments, which are last modified before &lt;date-before&gt;. If
5827                                  &lt;date-before&gt; is omitted, the search is restricted to instruments,
5828                                  which are last modified after &lt;date-after&gt;.</t>
5829                              </list>
5830                          </t>
5831    
5832                          <t>DESCRIPTION='&lt;search-string&gt;'
5833                              <list>
5834                                  <t>Restricts the search to instruments with description
5835                                  that satisfies the supplied search string (encapsulated into apostrophes,
5836                                  supporting escape sequences as described in chapter
5837                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5838                              </list>
5839                          </t>
5840    
5841                          <t>PRODUCT='&lt;search-string&gt;'
5842                              <list>
5843                                  <t>Restricts the search to instruments with product info
5844                                  that satisfies the supplied search string (encapsulated into apostrophes,
5845                                  supporting escape sequences as described in chapter
5846                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5847                              </list>
5848                          </t>
5849    
5850                          <t>ARTISTS='&lt;search-string&gt;'
5851                              <list>
5852                                  <t>Restricts the search to instruments with artists info
5853                                  that satisfies the supplied search string (encapsulated into apostrophes,
5854                                  supporting escape sequences as described in chapter
5855                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5856                              </list>
5857                          </t>
5858    
5859                          <t>KEYWORDS='&lt;search-string&gt;'
5860                              <list>
5861                                  <t>Restricts the search to instruments with keyword list
5862                                  that satisfies the supplied search string (encapsulated into apostrophes,
5863                                  supporting escape sequences as described in chapter
5864                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5865                              </list>
5866                          </t>
5867    
5868                          <t>IS_DRUM=true | false
5869                              <list>
5870                                  <t>Either true or false. Restricts the search to
5871                                  drum kits or chromatic instruments.</t>
5872                              </list>
5873                          </t>
5874    
5875                          <t>FORMAT_FAMILIES='&lt;format-list&gt;'
5876                              <list>
5877                                  <t>Restricts the search to instruments of the supplied format families,
5878                                  where &lt;format-list&gt; is a comma separated list of format families.</t>
5879                              </list>
5880                          </t>
5881                        </t>
5882    
5883                        <t>Where &lt;search-string&gt; is either a regular expression, or a
5884                        word list separated with spaces for OR search and with '+' for AND search.</t>
5885    
5886                        <t>Possible Answers:</t>
5887                        <t>
5888                            <list>
5889                                <t>A comma separated list with the absolute path names (encapsulated into
5890                                apostrophes) of all instruments in the specified directory that satisfy
5891                                the supplied search criterias.</t>
5892                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5893                                    <list>
5894                                        <t>if the given directory does not exist.</t>
5895                                    </list>
5896                                </t>
5897                            </list>
5898                        </t>
5899                        <t>Example:</t>
5900                        <t>
5901                            <list>
5902                                <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"</t>
5903                                <t>S: "'/Piano Collection/Bosendorfer 290'"</t>
5904                            </list>
5905                        </t>
5906                        <t>
5907                            <list>
5908                                <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"</t>
5909                                <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"</t>
5910                            </list>
5911                        </t>
5912                    </section>
5913    
5914                    <section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO">
5915                        <t>The front-end can ask for the current status of a
5916                        particular database instruments job by sending the following command:</t>
5917                        <t>
5918                            <list>
5919                                <t>GET DB_INSTRUMENTS_JOB INFO &lt;job-id&gt;</t>
5920                            </list>
5921                        </t>
5922                        <t>Where &lt;job-id&gt; should be replaced by the numerical ID
5923                        of the job the front-end is interested in.</t>
5924    
5925                        <t>Possible Answers:</t>
5926                        <t>
5927                            <list>
5928                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5929                                Each answer line begins with the settings category name
5930                                followed by a colon and then a space character &lt;SP&gt; and finally
5931                                the info character string to that setting category. At the
5932                                moment the following categories are defined:</t>
5933    
5934                                <t>
5935                                    <list>
5936                                        <t>FILES_TOTAL -
5937                                            <list>
5938                                                <t>The total number of files scheduled for scanning</t>
5939                                            </list>
5940                                        </t>
5941                                        <t>FILES_SCANNED -
5942                                            <list>
5943                                                <t>The current number of scanned files</t>
5944                                            </list>
5945                                        </t>
5946                                        <t>SCANNING -
5947                                            <list>
5948                                                <t>The absolute path name of the file which is currently
5949                                                being scanned</t>
5950                                            </list>
5951                                        </t>
5952                                        <t>STATUS -
5953                                            <list>
5954                                                <t>An integer value between 0 and 100 indicating the
5955                                                scanning progress percentage of the file which is
5956                                                currently being scanned</t>
5957                                            </list>
5958                                        </t>
5959                                    </list>
5960                                </t>
5961                            </list>
5962                        </t>
5963                        <t>The mentioned fields above don't have to be in particular order.</t>
5964    
5965                        <t>Example:</t>
5966                        <t>
5967                            <list>
5968                                <t>C: "GET DB_INSTRUMENTS_JOB INFO 2"</t>
5969                                <t>S: "FILES_TOTAL: 12"</t>
5970                                <t>&nbsp;&nbsp;&nbsp;"FILES_SCANNED: 7"</t>
5971                                <t>&nbsp;&nbsp;&nbsp;"SCANNING: /home/me/gigs/Bosendorfer 290.gig"</t>
5972                                <t>&nbsp;&nbsp;&nbsp;"STATUS: 42"</t>
5973                                <t>&nbsp;&nbsp;&nbsp;"."</t>
5974                            </list>
5975                        </t>
5976                    </section>
5977    
5978                    <section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB">
5979                        <t>The front-end can remove all instruments and directories and re-create
5980                        the instruments database structure (e.g., in case of a database corruption)
5981                        by sending the following command:</t>
5982                        <t>
5983                            <list>
5984                                <t>FORMAT INSTRUMENTS_DB</t>
5985                            </list>
5986                        </t>
5987    
5988                        <t>Possible Answers:</t>
5989                        <t>
5990                            <list>
5991                                <t>"OK" -
5992                                    <list>
5993                                        <t>on success</t>
5994                                    </list>
5995                                </t>
5996                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5997                                    <list>
5998                                        <t>If the formatting of the instruments database
5999                                        failed.</t>
6000                                    </list>
6001                                </t>
6002                            </list>
6003                        </t>
6004                    </section>
6005    
6006                </section>
6007    
6008    
6009    
6010                <section title="Editing Instruments" anchor="editing_instruments">
6011                    <t>The sampler allows to edit instruments while playing with the
6012                    sampler by spawning an external (3rd party) instrument editor
6013                    application for a given instrument. The 3rd party instrument
6014                    editor applications have to place a respective plugin DLL file
6015                    into the sampler's plugins directory. The sampler will
6016                    automatically try to load all plugin DLLs in that directory on
6017                    startup and only on startup!</t>
6018                    <t>At the moment there is only one command for this feature set,
6019                    but this will most probably change in future.</t>
6020    
6021                    <section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT">
6022                        <t>The front-end can request to open an appropriate instrument
6023                        editor application by sending the following command:</t>
6024                        <t>
6025                            <list>
6026                                <t>EDIT CHANNEL INSTRUMENT &lt;sampler-channel&gt;</t>
6027                            </list>
6028                        </t>
6029                        <t>Where &lt;sampler-channel&gt; should be replaced by the
6030                        number of the sampler channel as given by the
6031                        <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
6032                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref>
6033                        command.</t>
6034    
6035                        <t>The sampler will try to ask all registered instrument
6036                        editors (or to be more specific: their sampler plugins)
6037                        whether they are capable to handle the instrument on the
6038                        given sampler channel. The sampler will simply use the first
6039                        instrument editor application which replied with a positive
6040                        answer and spawn that instrument editor application within
6041                        the sampler's process and provide that application access
6042                        to the instrument's data structures, so both applications
6043                        can share and access the same instruments data at the same
6044                        time, thus allowing to immediately hear changes with the
6045                        sampler made by the instrument editor.</t>
6046    
6047                        <t>Note: consequently instrument editors are always spawned
6048                        locally on the same machine where the sampler is running
6049                        on!</t>
6050    
6051                        <t>Possible Answers:</t>
6052                        <t>
6053                            <list>
6054                                <t>"OK" -
6055                                    <list>
6056                                        <t>when an appropriate instrument editor was
6057                                        launched</t>
6058                                    </list>
6059                                </t>
6060                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6061                                    <list>
6062                                        <t>when an appropriate instrument editor was
6063                                        launched, but there are noteworthy issues</t>
6064                                    </list>
6065                                </t>
6066                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6067                                    <list>
6068                                        <t>when an appropriate instrument editor
6069                                        could not be launched</t>
6070                                    </list>
6071                                </t>
6072                            </list>
6073                        </t>
6074    
6075                        <t>Examples:</t>
6076                        <t>
6077                            <list>
6078                                <t>C: "EDIT CHANNEL INSTRUMENT 0"</t>
6079                                <t>S: "OK"</t>
6080                            </list>
6081                        </t>
6082                    </section>
6083                </section>
6084    
6085                <section title="Managing Files" anchor="file_management">
6086                    <t>You can query detailed informations about files located
6087                    at the same system where the sampler instance is running on.
6088                    Using this command set allows to retrieve file informations
6089                    even remotely from another machine.</t>
6090    
6091                    <section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS">
6092                        <t>The front-end can retrieve the amount of instruments
6093                        within a given instrument file by sending the
6094                        following command:</t>
6095                        <t>
6096                            <list>
6097                                <t>GET FILE INSTRUMENTS &lt;filename&gt;</t>
6098                            </list>
6099                        </t>
6100                        <t>Where &lt;filename&gt; is the name of the instrument
6101                        file (encapsulated into apostrophes, supporting escape
6102                        sequences as described in chapter
6103                        "<xref target="character_set">Character Set and Escape
6104                            Sequences</xref>").</t>
6105    
6106                        <t>The sampler will try to ask all sampler engines,
6107                        whether they support the given file and ask the first
6108                        engine with a positive answer for the amount of
6109                        instruments.</t>
6110    
6111                        <t>Possible Answers:</t>
6112                        <t>
6113                            <list>
6114                                <t>On success, the sampler will answer by
6115                                   returning the amount of instruments.
6116                                </t>
6117                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6118                                    <list>
6119                                        <t>if the file could not be handled</t>
6120                                    </list>
6121                                </t>
6122                            </list>
6123                        </t>
6124    
6125                        <t>Examples:</t>
6126                        <t>
6127                            <list>
6128                                <t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t>
6129                                <t>S: "10"</t>
6130                            </list>
6131                        </t>
6132                    </section>
6133    
6134                    <section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS">
6135                        <t>The front-end can retrieve a list of all instruments
6136                        within a given instrument file by sending the
6137                        following command:</t>
6138                        <t>
6139                            <list>
6140                                <t>LIST FILE INSTRUMENTS &lt;filename&gt;</t>
6141                            </list>
6142                        </t>
6143                        <t>Where &lt;filename&gt; is the name of the instrument
6144                        file (encapsulated into apostrophes, supporting escape
6145                        sequences as described in chapter
6146                        "<xref target="character_set">Character Set and Escape
6147                            Sequences</xref>").</t>
6148    
6149                        <t>The sampler will try to ask all sampler engines,
6150                        whether they support the given file and ask the first
6151                        engine with a positive answer for a list of IDs for the
6152                        instruments in the given file.</t>
6153    
6154                        <t>Possible Answers:</t>
6155                        <t>
6156                            <list>
6157                                <t>On success, the sampler will answer by
6158                                   returning a comma separated list of
6159                                   instrument IDs.
6160                                </t>
6161                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6162                                    <list>
6163                                        <t>if the file could not be handled</t>
6164                                    </list>
6165                                </t>
6166                            </list>
6167                        </t>
6168    
6169                        <t>Examples:</t>
6170                        <t>
6171                            <list>
6172                                <t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t>
6173                                <t>S: "0,1,2,3,4,5,6,7,8,9"</t>
6174                            </list>
6175                        </t>
6176                    </section>
6177    
6178                    <section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO">
6179                        <t>The front-end can retrieve detailed informations
6180                        about a specific instrument within a given instrument
6181                        file by sending the following command:</t>
6182                        <t>
6183                            <list>
6184                                <t>GET FILE INSTRUMENT INFO &lt;filename&gt;
6185                                &lt;instr-id&gt;</t>
6186                            </list>
6187                        </t>
6188                        <t>Where &lt;filename&gt; is the name of the instrument
6189                        file (encapsulated into apostrophes, supporting escape
6190                        sequences as described in chapter
6191                        "<xref target="character_set">Character Set and Escape
6192                            Sequences</xref>") and &lt;instr-id&gt; is the numeric
6193                        instrument ID as returned by the
6194                        <xref target="LIST FILE INSTRUMENTS">
6195                        "LIST FILE INSTRUMENTS"</xref> command.</t>
6196    
6197                        <t>The sampler will try to ask all sampler engines,
6198                        whether they support the given file and ask the first
6199                        engine with a positive answer for informations about the
6200                        specific instrument in the given file.</t>
6201    
6202                        <t>Possible Answers:</t>
6203                        <t>
6204                            <list>
6205                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6206                                Each answer line begins with the settings category name
6207                                followed by a colon and then a space character &lt;SP&gt; and finally
6208                                the info character string to that setting category. At the
6209                                moment the following categories are defined:</t>
6210    
6211                                <t>
6212                                    <list>
6213                                        <t>NAME -
6214                                            <list>
6215                                                <t>name of the instrument as
6216                                                stored in the instrument file</t>
6217                                            </list>
6218                                        </t>
6219                                        <t>FORMAT_FAMILY -
6220                                            <list>
6221                                                <t>name of the sampler format
6222                                                of the given instrument</t>
6223                                            </list>
6224                                        </t>
6225                                        <t>FORMAT_VERSION -
6226                                            <list>
6227                                                <t>version of the sampler format
6228                                                the instrumen is stored as</t>
6229                                            </list>
6230                                        </t>
6231                                        <t>PRODUCT -
6232                                            <list>
6233                                                <t>official product name of the
6234                                                instrument as stored in the file
6235                                                </t>
6236                                            </list>
6237                                        </t>
6238                                        <t>ARTISTS -
6239                                            <list>
6240                                                <t>artists / sample library
6241                                                vendor of the instrument</t>
6242                                            </list>
6243                                        </t>
6244                                    </list>
6245                                </t>
6246                            </list>
6247                        </t>
6248                        <t>The mentioned fields above don't have to be in particular order.</t>
6249    
6250                        <t>Example:</t>
6251                        <t>
6252                            <list>
6253                                <t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t>
6254                                <t>S: "NAME: Lunatic Loops"</t>
6255                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
6256                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 3"</t>
6257                                <t>&nbsp;&nbsp;&nbsp;"PRODUCT: The Backbone Bongo Beats"</t>
6258                                <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Jimmy the Fish"</t>
6259                                <t>&nbsp;&nbsp;&nbsp;"."</t>
6260                            </list>
6261                        </t>
6262                    </section>
6263              </section>              </section>
6264          </section>          </section>
6265    
6266          <section title="Command Syntax">          <section title="Command Syntax" anchor="command_syntax">
6267              <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"/>
6268              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"/>)
6269              the command syntax.</t>              where applicable.
6270                </t>
6271                <!--
6272                    This section is automatically generated by scripts/update_grammar.pl
6273                    from src/network/lscp.y (yacc input file). Do not modify this section
6274                    manually !
6275                -->
6276                <!-- GRAMMAR_BNF_BEGIN - do NOT delete or modify this line !!! -->
6277    
6278    <t>input =
6279            <list>
6280                    <t>line LF
6281                    </t>
6282                    <t>/ line CR LF
6283                    </t>
6284            </list>
6285    </t>
6286    <t>line =
6287            <list>
6288                    <t>/* epsilon (empty line ignored) */
6289                    </t>
6290                    <t>/ comment
6291                    </t>
6292                    <t>/ command
6293                    </t>
6294                    <t>/ error
6295                    </t>
6296            </list>
6297    </t>
6298    <t>comment =
6299            <list>
6300                    <t>'#'
6301                    </t>
6302                    <t>/ comment '#'
6303                    </t>
6304                    <t>/ comment SP
6305                    </t>
6306                    <t>/ comment number
6307                    </t>
6308                    <t>/ comment string
6309                    </t>
6310            </list>
6311    </t>
6312    <t>command =
6313            <list>
6314                    <t>ADD SP add_instruction
6315                    </t>
6316                    <t>/ MAP SP map_instruction
6317                    </t>
6318                    <t>/ UNMAP SP unmap_instruction
6319                    </t>
6320                    <t>/ GET SP get_instruction
6321                    </t>
6322                    <t>/ CREATE SP create_instruction
6323                    </t>
6324                    <t>/ DESTROY SP destroy_instruction
6325                    </t>
6326                    <t>/ LIST SP list_instruction
6327                    </t>
6328                    <t>/ LOAD SP load_instruction
6329                    </t>
6330                    <t>/ REMOVE SP remove_instruction
6331                    </t>
6332                    <t>/ SET SP set_instruction
6333                    </t>
6334                    <t>/ SUBSCRIBE SP subscribe_event
6335                    </t>
6336                    <t>/ UNSUBSCRIBE SP unsubscribe_event
6337                    </t>
6338                    <t>/ RESET SP reset_instruction
6339                    </t>
6340                    <t>/ CLEAR SP clear_instruction
6341                    </t>
6342                    <t>/ FIND SP find_instruction
6343                    </t>
6344                    <t>/ MOVE SP move_instruction
6345                    </t>
6346                    <t>/ COPY SP copy_instruction
6347                    </t>
6348                    <t>/ EDIT SP edit_instruction
6349                    </t>
6350                    <t>/ FORMAT SP format_instruction
6351                    </t>
6352                    <t>/ RESET
6353                    </t>
6354                    <t>/ QUIT
6355                    </t>
6356            </list>
6357    </t>
6358    <t>add_instruction =
6359            <list>
6360                    <t>CHANNEL
6361                    </t>
6362                    <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
6363                    </t>
6364                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
6365                    </t>
6366                    <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6367                    </t>
6368                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6369                    </t>
6370                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index
6371                    </t>
6372                    <t>/ DB_INSTRUMENTS SP db_path SP filename
6373                    </t>
6374                    <t>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6375                    </t>
6376                    <t>/ MIDI_INSTRUMENT_MAP
6377                    </t>
6378                    <t>/ MIDI_INSTRUMENT_MAP SP map_name
6379                    </t>
6380            </list>
6381    </t>
6382    <t>subscribe_event =
6383            <list>
6384                    <t>AUDIO_OUTPUT_DEVICE_COUNT
6385                    </t>
6386                    <t>/ AUDIO_OUTPUT_DEVICE_INFO
6387                    </t>
6388                    <t>/ MIDI_INPUT_DEVICE_COUNT
6389                    </t>
6390                    <t>/ MIDI_INPUT_DEVICE_INFO
6391                    </t>
6392                    <t>/ CHANNEL_COUNT
6393                    </t>
6394                    <t>/ VOICE_COUNT
6395                    </t>
6396                    <t>/ STREAM_COUNT
6397                    </t>
6398                    <t>/ BUFFER_FILL
6399                    </t>
6400                    <t>/ CHANNEL_INFO
6401                    </t>
6402                    <t>/ FX_SEND_COUNT
6403                    </t>
6404                    <t>/ FX_SEND_INFO
6405                    </t>
6406                    <t>/ MIDI_INSTRUMENT_MAP_COUNT
6407                    </t>
6408                    <t>/ MIDI_INSTRUMENT_MAP_INFO
6409                    </t>
6410                    <t>/ MIDI_INSTRUMENT_COUNT
6411                    </t>
6412                    <t>/ MIDI_INSTRUMENT_INFO
6413                    </t>
6414                    <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
6415                    </t>
6416                    <t>/ DB_INSTRUMENT_DIRECTORY_INFO
6417                    </t>
6418                    <t>/ DB_INSTRUMENT_COUNT
6419                    </t>
6420                    <t>/ DB_INSTRUMENT_INFO
6421                    </t>
6422                    <t>/ DB_INSTRUMENTS_JOB_INFO
6423                    </t>
6424                    <t>/ MISCELLANEOUS
6425                    </t>
6426                    <t>/ TOTAL_STREAM_COUNT
6427                    </t>
6428                    <t>/ TOTAL_VOICE_COUNT
6429                    </t>
6430                    <t>/ GLOBAL_INFO
6431                    </t>
6432            </list>
6433    </t>
6434    <t>unsubscribe_event =
6435            <list>
6436                    <t>AUDIO_OUTPUT_DEVICE_COUNT
6437                    </t>
6438                    <t>/ AUDIO_OUTPUT_DEVICE_INFO
6439                    </t>
6440                    <t>/ MIDI_INPUT_DEVICE_COUNT
6441                    </t>
6442                    <t>/ MIDI_INPUT_DEVICE_INFO
6443                    </t>
6444                    <t>/ CHANNEL_COUNT
6445                    </t>
6446                    <t>/ VOICE_COUNT
6447                    </t>
6448                    <t>/ STREAM_COUNT
6449                    </t>
6450                    <t>/ BUFFER_FILL
6451                    </t>
6452                    <t>/ CHANNEL_INFO
6453                    </t>
6454                    <t>/ FX_SEND_COUNT
6455                    </t>
6456                    <t>/ FX_SEND_INFO
6457                    </t>
6458                    <t>/ MIDI_INSTRUMENT_MAP_COUNT
6459                    </t>
6460                    <t>/ MIDI_INSTRUMENT_MAP_INFO
6461                    </t>
6462                    <t>/ MIDI_INSTRUMENT_COUNT
6463                    </t>
6464                    <t>/ MIDI_INSTRUMENT_INFO
6465                    </t>
6466                    <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
6467                    </t>
6468                    <t>/ DB_INSTRUMENT_DIRECTORY_INFO
6469                    </t>
6470                    <t>/ DB_INSTRUMENT_COUNT
6471                    </t>
6472                    <t>/ DB_INSTRUMENT_INFO
6473                    </t>
6474                    <t>/ DB_INSTRUMENTS_JOB_INFO
6475                    </t>
6476                    <t>/ MISCELLANEOUS
6477                    </t>
6478                    <t>/ TOTAL_STREAM_COUNT
6479                    </t>
6480                    <t>/ TOTAL_VOICE_COUNT
6481                    </t>
6482                    <t>/ GLOBAL_INFO
6483                    </t>
6484            </list>
6485    </t>
6486    <t>map_instruction =
6487            <list>
6488                    <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
6489                    </t>
6490                    <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
6491                    </t>
6492                    <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
6493                    </t>
6494                    <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
6495                    </t>
6496            </list>
6497    </t>
6498    <t>unmap_instruction =
6499            <list>
6500                    <t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
6501                    </t>
6502            </list>
6503    </t>
6504    <t>remove_instruction =
6505            <list>
6506                    <t>CHANNEL SP sampler_channel
6507                    </t>
6508                    <t>/ MIDI_INSTRUMENT_MAP SP midi_map
6509                    </t>
6510                    <t>/ MIDI_INSTRUMENT_MAP SP ALL
6511                    </t>
6512                    <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6513                    </t>
6514                    <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
6515                    </t>
6516                    <t>/ DB_INSTRUMENT SP db_path
6517                    </t>
6518            </list>
6519    </t>
6520    <t>get_instruction =
6521            <list>
6522                    <t>AVAILABLE_ENGINES
6523                    </t>
6524                    <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
6525                    </t>
6526                    <t>/ MIDI_INPUT_DRIVER SP INFO SP string
6527                    </t>
6528                    <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
6529                    </t>
6530                    <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
6531                    </t>
6532                    <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
6533                    </t>
6534                    <t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string
6535                    </t>
6536                    <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
6537                    </t>
6538                    <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
6539                    </t>
6540                    <t>/ AUDIO_OUTPUT_DEVICES
6541                    </t>
6542                    <t>/ MIDI_INPUT_DEVICES
6543                    </t>
6544                    <t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number
6545                    </t>
6546                    <t>/ MIDI_INPUT_DEVICE SP INFO SP number
6547                    </t>
6548                    <t>/ MIDI_INPUT_PORT SP INFO SP number SP number
6549                    </t>
6550                    <t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
6551                    </t>
6552                    <t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
6553                    </t>
6554                    <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string
6555                    </t>
6556                    <t>/ CHANNELS
6557                    </t>
6558                    <t>/ CHANNEL SP INFO SP sampler_channel
6559                    </t>
6560                    <t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
6561                    </t>
6562                    <t>/ CHANNEL SP STREAM_COUNT SP sampler_channel
6563                    </t>
6564                    <t>/ CHANNEL SP VOICE_COUNT SP sampler_channel
6565                    </t>
6566                    <t>/ ENGINE SP INFO SP engine_name
6567                    </t>
6568                    <t>/ SERVER SP INFO
6569                    </t>
6570                    <t>/ TOTAL_STREAM_COUNT
6571                    </t>
6572                    <t>/ TOTAL_VOICE_COUNT
6573                    </t>
6574                    <t>/ TOTAL_VOICE_COUNT_MAX
6575                    </t>
6576                    <t>/ MIDI_INSTRUMENTS SP midi_map
6577                    </t>
6578                    <t>/ MIDI_INSTRUMENTS SP ALL
6579                    </t>
6580                    <t>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
6581                    </t>
6582                    <t>/ MIDI_INSTRUMENT_MAPS
6583                    </t>
6584                    <t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
6585                    </t>
6586                    <t>/ FX_SENDS SP sampler_channel
6587                    </t>
6588                    <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
6589                    </t>
6590                    <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6591                    </t>
6592                    <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
6593                    </t>
6594                    <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
6595                    </t>
6596                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
6597                    </t>
6598                    <t>/ DB_INSTRUMENTS SP db_path
6599                    </t>
6600                    <t>/ DB_INSTRUMENT SP INFO SP db_path
6601                    </t>
6602                    <t>/ DB_INSTRUMENTS_JOB SP INFO SP number
6603                    </t>
6604                    <t>/ VOLUME
6605                    </t>
6606                    <t>/ FILE SP INSTRUMENTS SP filename
6607                    </t>
6608                    <t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
6609                    </t>
6610            </list>
6611    </t>
6612    <t>set_instruction =
6613            <list>
6614                    <t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
6615                    </t>
6616                    <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list
6617                    </t>
6618                    <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
6619                    </t>
6620                    <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
6621                    </t>
6622                    <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
6623                    </t>
6624                    <t>/ CHANNEL SP set_chan_instruction
6625                    </t>
6626                    <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6627                    </t>
6628                    <t>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
6629                    </t>
6630                    <t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
6631                    </t>
6632                    <t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
6633                    </t>
6634                    <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
6635                    </t>
6636                    <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6637                    </t>
6638                    <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
6639                    </t>
6640                    <t>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
6641                    </t>
6642                    <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6643                    </t>
6644                    <t>/ ECHO SP boolean
6645                    </t>
6646                    <t>/ VOLUME SP volume_value
6647                    </t>
6648            </list>
6649    </t>
6650    <t>create_instruction =
6651            <list>
6652                    <t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list
6653                    </t>
6654                    <t>/ AUDIO_OUTPUT_DEVICE SP string
6655                    </t>
6656                    <t>/ MIDI_INPUT_DEVICE SP string SP key_val_list
6657                    </t>
6658                    <t>/ MIDI_INPUT_DEVICE SP string
6659                    </t>
6660                    <t>/ FX_SEND SP sampler_channel SP midi_ctrl
6661                    </t>
6662                    <t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
6663                    </t>
6664            </list>
6665    </t>
6666    <t>reset_instruction =
6667            <list>
6668                    <t>CHANNEL SP sampler_channel
6669                    </t>
6670            </list>
6671    </t>
6672    <t>clear_instruction =
6673            <list>
6674                    <t>MIDI_INSTRUMENTS SP midi_map
6675                    </t>
6676                    <t>/ MIDI_INSTRUMENTS SP ALL
6677                    </t>
6678            </list>
6679    </t>
6680    <t>find_instruction =
6681            <list>
6682                    <t>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
6683                    </t>
6684                    <t>/ DB_INSTRUMENTS SP db_path SP query_val_list
6685                    </t>
6686                    <t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list
6687                    </t>
6688                    <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6689                    </t>
6690            </list>
6691    </t>
6692    <t>move_instruction =
6693            <list>
6694                    <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6695                    </t>
6696                    <t>/ DB_INSTRUMENT SP db_path SP db_path
6697                    </t>
6698            </list>
6699    </t>
6700    <t>copy_instruction =
6701            <list>
6702                    <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6703                    </t>
6704                    <t>/ DB_INSTRUMENT SP db_path SP db_path
6705                    </t>
6706            </list>
6707    </t>
6708    <t>destroy_instruction =
6709            <list>
6710                    <t>AUDIO_OUTPUT_DEVICE SP number
6711                    </t>
6712                    <t>/ MIDI_INPUT_DEVICE SP number
6713                    </t>
6714                    <t>/ FX_SEND SP sampler_channel SP fx_send_id
6715                    </t>
6716            </list>
6717    </t>
6718    <t>load_instruction =
6719            <list>
6720                    <t>INSTRUMENT SP load_instr_args
6721                    </t>
6722                    <t>/ ENGINE SP load_engine_args
6723                    </t>
6724            </list>
6725    </t>
6726    <t>set_chan_instruction =
6727            <list>
6728                    <t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
6729                    </t>
6730                    <t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index
6731                    </t>
6732                    <t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
6733                    </t>
6734                    <t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index
6735                    </t>
6736                    <t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index
6737                    </t>
6738                    <t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
6739                    </t>
6740                    <t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index
6741                    </t>
6742                    <t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
6743                    </t>
6744                    <t>/ VOLUME SP sampler_channel SP volume_value
6745                    </t>
6746                    <t>/ MUTE SP sampler_channel SP boolean
6747                    </t>
6748                    <t>/ SOLO SP sampler_channel SP boolean
6749                    </t>
6750                    <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
6751                    </t>
6752                    <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
6753                    </t>
6754                    <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
6755                    </t>
6756            </list>
6757    </t>
6758    <t>edit_instruction =
6759            <list>
6760                    <t>CHANNEL SP INSTRUMENT SP sampler_channel
6761                    </t>
6762            </list>
6763    </t>
6764    <t>format_instruction =
6765            <list>
6766                    <t>INSTRUMENTS_DB
6767                    </t>
6768            </list>
6769    </t>
6770    <t>modal_arg =
6771            <list>
6772                    <t>/* epsilon (empty argument) */
6773                    </t>
6774                    <t>/ NON_MODAL SP
6775                    </t>
6776            </list>
6777    </t>
6778    <t>key_val_list =
6779            <list>
6780                    <t>string '=' param_val_list
6781                    </t>
6782                    <t>/ key_val_list SP string '=' param_val_list
6783                    </t>
6784            </list>
6785    </t>
6786    <t>buffer_size_type =
6787            <list>
6788                    <t>BYTES
6789                    </t>
6790                    <t>/ PERCENTAGE
6791                    </t>
6792            </list>
6793    </t>
6794    <t>list_instruction =
6795            <list>
6796                    <t>AUDIO_OUTPUT_DEVICES
6797                    </t>
6798                    <t>/ MIDI_INPUT_DEVICES
6799                    </t>
6800                    <t>/ CHANNELS
6801                    </t>
6802                    <t>/ AVAILABLE_ENGINES
6803                    </t>
6804                    <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
6805                    </t>
6806                    <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
6807                    </t>
6808                    <t>/ MIDI_INSTRUMENTS SP midi_map
6809                    </t>
6810                    <t>/ MIDI_INSTRUMENTS SP ALL
6811                    </t>
6812                    <t>/ MIDI_INSTRUMENT_MAPS
6813                    </t>
6814                    <t>/ FX_SENDS SP sampler_channel
6815                    </t>
6816                    <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6817                    </t>
6818                    <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
6819                    </t>
6820                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
6821                    </t>
6822                    <t>/ DB_INSTRUMENTS SP db_path
6823                    </t>
6824                    <t>/ FILE SP INSTRUMENTS SP filename
6825                    </t>
6826            </list>
6827    </t>
6828    <t>load_instr_args =
6829            <list>
6830                    <t>filename SP instrument_index SP sampler_channel
6831                    </t>
6832                    <t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel
6833                    </t>
6834            </list>
6835    </t>
6836    <t>load_engine_args =
6837            <list>
6838                    <t>engine_name SP sampler_channel
6839                    </t>
6840            </list>
6841    </t>
6842    <t>instr_load_mode =
6843            <list>
6844                    <t>ON_DEMAND
6845                    </t>
6846                    <t>/ ON_DEMAND_HOLD
6847                    </t>
6848                    <t>/ PERSISTENT
6849                    </t>
6850            </list>
6851    </t>
6852    <t>device_index =
6853            <list>
6854                    <t>number
6855                    </t>
6856            </list>
6857    </t>
6858    <t>audio_channel_index =
6859            <list>
6860                    <t>number
6861                    </t>
6862            </list>
6863    </t>
6864    <t>audio_output_type_name =
6865            <list>
6866                    <t>string
6867                    </t>
6868            </list>
6869    </t>
6870    <t>midi_input_port_index =
6871            <list>
6872                    <t>number
6873                    </t>
6874            </list>
6875    </t>
6876    <t>midi_input_channel_index =
6877            <list>
6878                    <t>number
6879                    </t>
6880                    <t>/ ALL
6881                    </t>
6882            </list>
6883    </t>
6884    <t>midi_input_type_name =
6885            <list>
6886                    <t>string
6887                    </t>
6888            </list>
6889    </t>
6890    <t>midi_map =
6891            <list>
6892                    <t>number
6893                    </t>
6894            </list>
6895    </t>
6896    <t>midi_bank =
6897            <list>
6898                    <t>number
6899                    </t>
6900            </list>
6901    </t>
6902    <t>midi_prog =
6903            <list>
6904                    <t>number
6905                    </t>
6906            </list>
6907    </t>
6908    <t>midi_ctrl =
6909            <list>
6910                    <t>number
6911                    </t>
6912            </list>
6913    </t>
6914    <t>volume_value =
6915            <list>
6916                    <t>dotnum
6917                    </t>
6918                    <t>/ number
6919                    </t>
6920            </list>
6921    </t>
6922    <t>sampler_channel =
6923            <list>
6924                    <t>number
6925                    </t>
6926            </list>
6927    </t>
6928    <t>instrument_index =
6929            <list>
6930                    <t>number
6931                    </t>
6932            </list>
6933    </t>
6934    <t>fx_send_id =
6935            <list>
6936                    <t>number
6937                    </t>
6938            </list>
6939    </t>
6940    <t>engine_name =
6941            <list>
6942                    <t>string
6943                    </t>
6944            </list>
6945    </t>
6946    <t>filename =
6947            <list>
6948                    <t>path
6949                    </t>
6950            </list>
6951    </t>
6952    <t>db_path =
6953            <list>
6954                    <t>path
6955                    </t>
6956            </list>
6957    </t>
6958    <t>map_name =
6959            <list>
6960                    <t>stringval_escaped
6961                    </t>
6962            </list>
6963    </t>
6964    <t>entry_name =
6965            <list>
6966                    <t>stringval_escaped
6967                    </t>
6968            </list>
6969    </t>
6970    <t>fx_send_name =
6971            <list>
6972                    <t>stringval_escaped
6973                    </t>
6974            </list>
6975    </t>
6976    <t>param_val_list =
6977            <list>
6978                    <t>param_val
6979                    </t>
6980                    <t>/ param_val_list','param_val
6981                    </t>
6982            </list>
6983    </t>
6984    
6985    <t>param_val =
6986            <list>
6987                    <t>string
6988                    </t>
6989                    <t>/ stringval
6990                    </t>
6991                    <t>/ number
6992                    </t>
6993                    <t>/ dotnum
6994                    </t>
6995            </list>
6996    </t>
6997    <t>query_val_list =
6998            <list>
6999                    <t>string '=' query_val
7000                    </t>
7001                    <t>/ query_val_list SP string '=' query_val
7002                    </t>
7003            </list>
7004    </t>
7005    <t>query_val =
7006            <list>
7007                    <t>text_escaped
7008                    </t>
7009                    <t>/ stringval_escaped
7010                    </t>
7011            </list>
7012    </t>
7013    <t>scan_mode =
7014            <list>
7015                    <t>RECURSIVE
7016                    </t>
7017                    <t>/ NON_RECURSIVE
7018                    </t>
7019                    <t>/ FLAT
7020                    </t>
7021            </list>
7022    </t>
7023    
7024                <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
7025    
7026                <section title="Character Set and Escape Sequences" anchor="character_set">
7027                    <t>Older versions of this protocol up to and including v1.1 only
7028                    supported the standard ASCII character set (ASCII code 0 - 127)
7029                    <xref target="RFC20"/>, all younger versions of this protocol
7030                    however support the Extended ASCII character set (ASCII code
7031                    0 - 255). The same group of younger protocols also support
7032                    escape sequences, but only for certain, explicitly declared
7033                    parts of the protocol. The supported escape sequences are
7034                    defined as follows:</t>
7035                    <texttable>
7036                        <ttcol>ASCII Character Sequence</ttcol>
7037                        <ttcol>Translated into (Name)</ttcol>
7038                        <c>\n</c> <c>new line</c>
7039                        <c>\r</c> <c>carriage return</c>
7040                        <c>\f</c> <c>form feed</c>
7041                        <c>\t</c> <c>horizontal tab</c>
7042                        <c>\v</c> <c>vertical tab</c>
7043                        <c>\'</c> <c>apostrophe</c>
7044                        <c>\"</c> <c>quotation mark</c>
7045                        <c>\\</c> <c>backslash</c>
7046                        <c>\OOO</c> <c>three digit octal ASCII code of the character</c>
7047                        <c>\xHH</c> <c>two digit hex ASCII code of the character</c>
7048                    </texttable>
7049                    <t>Notice: due to the transition of certain parts of the
7050                    protocol which now support escape sequences, a slight backward
7051                    incompatibility to protocols version v1.1 and younger has been
7052                    introduced. The only difference is that in parts of the protocol
7053                    where escape characters are now supported, a backslash characters
7054                    MUST be escaped as well (that is as double backslash), whereas
7055                    in the old versions a single backslash was sufficient.</t>
7056    
7057                    <t>The following LSCP commands support escape sequences as part
7058                    of their filename / path based arguments and / or may contain
7059                    a filename / path with escape sequences in their response:
7060                    <list>
7061                        <t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t>
7062                        <t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t>
7063                        <t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t>
7064                        <t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t>
7065                        <t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t>
7066                        <t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t>
7067                        <t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
7068                        <t><xref target="REMOVE DB_INSTRUMENT">"REMOVE DB_INSTRUMENT"</xref></t>
7069                        <t><xref target="GET DB_INSTRUMENT_DIRECTORIES">"GET DB_INSTRUMENT_DIRECTORIES"</xref></t>
7070                        <t><xref target="LIST DB_INSTRUMENT_DIRECTORIES">"LIST DB_INSTRUMENT_DIRECTORIES"</xref></t>
7071                        <t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t>
7072                        <t><xref target="GET DB_INSTRUMENTS">"GET DB_INSTRUMENTS"</xref></t>
7073                        <t><xref target="LIST DB_INSTRUMENTS">"LIST DB_INSTRUMENTS"</xref></t>
7074                        <t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t>
7075                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t>
7076                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t>
7077                        <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
7078                        <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
7079                        <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
7080                        <t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t>
7081                        <t><xref target="MOVE DB_INSTRUMENT">"MOVE DB_INSTRUMENT"</xref></t>
7082                        <t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
7083                        <t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t>
7084                        <t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t>
7085                        <t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t>
7086                        <t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t>
7087                        <t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t>
7088                    </list>
7089                    Note that the forward slash character ('/') has a special meaning in
7090                    filename / path based arguments: it acts as separator of the nodes in
7091                    the path, thus if a directory- or filename includes a forward slash
7092                    (not intended as path node separator), you MUST escape that slash
7093                    either with the respective hex escape sequence ("\x2f") or with the
7094                    respective octal escape sequence ("\057").
7095                    </t>
7096    
7097                    <t>
7098                    Note for Windows: file path arguments in LSCP are expected
7099                    to use forward slashes as directory node separator similar
7100                    to Unix based operating systems. In contrast to Unix however
7101                    a Windows typical drive character is expected to be
7102                    prefixed to the path. That is an original Windows file path
7103                    like "D:\Sounds\My.gig" would become in LSCP:
7104                    "D:/Sounds/My.gig".
7105                    </t>
7106    
7107                    <t>
7108                    The following LSCP commands even support escape sequences as
7109                    part of at least one of their text-based arguments (i.e. entity name,
7110                    description) and / or may contain escape sequences in at least one of
7111                    their text-based fields in their response:
7112                    <list>
7113                        <t><xref target="GET SERVER INFO">"GET SERVER INFO"</xref></t>
7114                        <t><xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref></t>
7115                        <t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t>
7116                        <t><xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref></t>
7117                        <t><xref target="GET FX_SEND INFO">"GET FX_SEND INFO"</xref></t>
7118                        <t><xref target="SET FX_SEND NAME">"SET FX_SEND NAME"</xref></t>
7119                        <t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t>
7120                        <t><xref target="GET MIDI_INSTRUMENT_MAP INFO">"GET MIDI_INSTRUMENT_MAP INFO"</xref></t>
7121                        <t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t>
7122                        <t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t>
7123                        <t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t>
7124                        <t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t>
7125                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t>
7126                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t>
7127                        <t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t>
7128                        <t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t>
7129                        <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
7130                        <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
7131                        <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
7132                    </list>
7133                    Please note that these lists are manually maintained. If you
7134                    find a command that also supports escape sequences we forgot to
7135                    mention here, please report it!
7136                    </t>
7137                </section>
7138          </section>          </section>
7139    
7140          <section title="Events">          <section title="Events" anchor="events">
7141              <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>
7142    
7143              <section title="Number of sampler channels changed">              <section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">
7144                    <t>Client may want to be notified when the total number of audio output devices on the
7145                    back-end changes by issuing the following command:</t>
7146                    <t>
7147                        <list>
7148                            <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t>
7149                        </list>
7150                    </t>
7151                    <t>Server will start sending the following notification messages:</t>
7152                    <t>
7153                        <list>
7154                            <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
7155                        </list>
7156                    </t>
7157                    <t>where &lt;devices&gt; will be replaced by the new number
7158                    of audio output devices.</t>
7159                </section>
7160    
7161                <section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">
7162                    <t>Client may want to be notified when changes were made to audio output devices on the
7163                    back-end by issuing the following command:</t>
7164                    <t>
7165                        <list>
7166                            <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t>
7167                        </list>
7168                    </t>
7169                    <t>Server will start sending the following notification messages:</t>
7170                    <t>
7171                        <list>
7172                            <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
7173                        </list>
7174                    </t>
7175                    <t>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
7176                    which settings has been changed. The front-end will have to send
7177                    the respective command to actually get the audio output device info. Because these messages
7178                    will be triggered by LSCP commands issued by other clients rather than real
7179                    time events happening on the server, it is believed that an empty notification
7180                    message is sufficient here.</t>
7181                </section>
7182    
7183                <section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">
7184                    <t>Client may want to be notified when the total number of MIDI input devices on the
7185                    back-end changes by issuing the following command:</t>
7186                    <t>
7187                        <list>
7188                            <t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t>
7189                        </list>
7190                    </t>
7191                    <t>Server will start sending the following notification messages:</t>
7192                    <t>
7193                        <list>
7194                            <t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
7195                        </list>
7196                    </t>
7197                    <t>where &lt;devices&gt; will be replaced by the new number
7198                    of MIDI input devices.</t>
7199                </section>
7200    
7201                <section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO">
7202                    <t>Client may want to be notified when changes were made to MIDI input devices on the
7203                    back-end by issuing the following command:</t>
7204                    <t>
7205                        <list>
7206                            <t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t>
7207                        </list>
7208                    </t>
7209                    <t>Server will start sending the following notification messages:</t>
7210                    <t>
7211                        <list>
7212                            <t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
7213                        </list>
7214                    </t>
7215                    <t>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
7216                    which settings has been changed. The front-end will have to send
7217                    the respective command to actually get the MIDI input device info. Because these messages
7218                    will be triggered by LSCP commands issued by other clients rather than real
7219                    time events happening on the server, it is believed that an empty notification
7220                    message is sufficient here.</t>
7221                </section>
7222    
7223                <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT">
7224                  <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
7225                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
7226                  <t>                  <t>
7227                      <list>                      <list>
7228                          <t>SUBSCRIBE CHANNELS</t>                          <t>SUBSCRIBE CHANNEL_COUNT</t>
7229                      </list>                      </list>
7230                  </t>                  </t>
7231                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
7232                  <t>                  <t>
7233                      <list>                      <list>
7234                          <t>"NOTIFY:CHANNELS:&lt;channels&gt;"</t>                          <t>"NOTIFY:CHANNEL_COUNT:&lt;channels&gt;"</t>
7235                      </list>                      </list>
7236                  </t>                  </t>
7237                  <t>where &lt;channels&gt; will be replaced by the new number                  <t>where &lt;channels&gt; will be replaced by the new number
7238                  of sampler channels.</t>                  of sampler channels.</t>
7239              </section>              </section>
7240    
7241              <section title="Number of active voices changed">              <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">
7242                  <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
7243                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
7244                  <t>                  <t>
# Line 3099  Schoenebeck'> Line 7249  Schoenebeck'>
7249                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
7250                  <t>                  <t>
7251                      <list>                      <list>
7252                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices>&gt;</t>                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"</t>
7253                      </list>                      </list>
7254                  </t>                  </t>
7255                  <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
7256                  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
7257                  active voices on that channel.</t>                  active voices on that channel.</t>
7258              </section>              </section>
7259    
7260              <section title="Number of active disk streams changed">              <section title="Number of active disk streams changed" anchor="SUBSCRIBE STREAM_COUNT">
7261                  <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
7262                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t>                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t>
7263                  <t>                  <t>
# Line 3126  Schoenebeck'> Line 7276  Schoenebeck'>
7276                  active disk streams on that channel.</t>                  active disk streams on that channel.</t>
7277              </section>              </section>
7278    
7279              <section title="Disk stream buffer fill state changed">              <section title="Disk stream buffer fill state changed" anchor="SUBSCRIBE BUFFER_FILL">
7280                  <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
7281                  changes by issuing the following command:</t>                  on the back-end changes by issuing the following command:</t>
7282                  <t>                  <t>
7283                      <list>                      <list>
7284                          <t>SUBSCRIBE BUFFER_FILL</t>                          <t>SUBSCRIBE BUFFER_FILL</t>
# Line 3141  Schoenebeck'> Line 7291  Schoenebeck'>
7291                      </list>                      </list>
7292                  </t>                  </t>
7293                  <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
7294                  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
7295                  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" />
7296                  "GET CHANNEL BUFFER_FILL PERCENTAGE" was issued on this channel.</t>                  as if the <xref target="GET CHANNEL BUFFER_FILL">
7297                    "GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t>
7298              </section>              </section>
7299    
7300              <section title="Channel information changed">              <section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO">
7301                  <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
7302                  back-end changes by issuing the following command:</t>                  back-end by issuing the following command:</t>
7303                  <t>                  <t>
7304                      <list>                      <list>
7305                          <t>SUBSCRIBE INFO</t>                          <t>SUBSCRIBE CHANNEL_INFO</t>
7306                      </list>                      </list>
7307                  </t>                  </t>
7308                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
7309                  <t>                  <t>
7310                      <list>                      <list>
7311                          <t>"NOTIFY:INFO:&lt;sampler-channel&gt;"</t>                          <t>"NOTIFY:CHANNEL_INFO:&lt;sampler-channel&gt;"</t>
7312                      </list>                      </list>
7313                  </t>                  </t>
7314                  <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 3168  Schoenebeck'> Line 7319  Schoenebeck'>
7319                  message is sufficient here.</t>                  message is sufficient here.</t>
7320              </section>              </section>
7321    
7322              <section title="Miscellaneous and debugging events">              <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
7323                    <t>Client may want to be notified when the number of effect sends on
7324                    a particular sampler channel is changed by issuing the following command:</t>
7325                    <t>
7326                        <list>
7327                            <t>SUBSCRIBE FX_SEND_COUNT</t>
7328                        </list>
7329                    </t>
7330                    <t>Server will start sending the following notification messages:</t>
7331                    <t>
7332                        <list>
7333                            <t>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"</t>
7334                        </list>
7335                    </t>
7336                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
7337                    channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
7338                    be replaced by the new number of effect sends on that channel.</t>
7339                </section>
7340    
7341                <section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO">
7342                    <t>Client may want to be notified when changes were made to effect sends on a
7343                    a particular sampler channel by issuing the following command:</t>
7344                    <t>
7345                        <list>
7346                            <t>SUBSCRIBE FX_SEND_INFO</t>
7347                        </list>
7348                    </t>
7349                    <t>Server will start sending the following notification messages:</t>
7350                    <t>
7351                        <list>
7352                            <t>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"</t>
7353                        </list>
7354                    </t>
7355                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
7356                    channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
7357                    be replaced by the numerical ID of the changed effect send.</t>
7358                </section>
7359    
7360                <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT">
7361                    <t>Client may want to be notified when the total number of voices on the
7362                    back-end changes by issuing the following command:</t>
7363                    <t>
7364                        <list>
7365                            <t>SUBSCRIBE TOTAL_VOICE_COUNT</t>
7366                        </list>
7367                    </t>
7368                    <t>Server will start sending the following notification messages:</t>
7369                    <t>
7370                        <list>
7371                            <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"</t>
7372                        </list>
7373                    </t>
7374                    <t>where &lt;voices&gt; will be replaced by the new number of
7375                    all currently active voices.</t>
7376                </section>
7377    
7378                <section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT">
7379                    <t>Client may want to be notified when the total number of disk streams on the
7380                    back-end changes by issuing the following command:</t>
7381                    <t>
7382                        <list>
7383                            <t>SUBSCRIBE TOTAL_STREAM_COUNT</t>
7384                        </list>
7385                    </t>
7386                    <t>Server will start sending the following notification messages:</t>
7387                    <t>
7388                        <list>
7389                            <t>"NOTIFY:TOTAL_STREAM_COUNT:&lt;streams&gt;"</t>
7390                        </list>
7391                    </t>
7392                    <t>where &lt;streams&gt; will be replaced by the new number of
7393                    all currently active disk streams.</t>
7394                </section>
7395    
7396                <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">
7397                    <t>Client may want to be notified when the number of MIDI instrument maps on the
7398                    back-end changes by issuing the following command:</t>
7399                    <t>
7400                        <list>
7401                            <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t>
7402                        </list>
7403                    </t>
7404                    <t>Server will start sending the following notification messages:</t>
7405                    <t>
7406                        <list>
7407                            <t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"</t>
7408                        </list>
7409                    </t>
7410                    <t>where &lt;maps&gt; will be replaced by the new number
7411                    of MIDI instrument maps.</t>
7412                </section>
7413    
7414                <section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">
7415                    <t>Client may want to be notified when changes were made to MIDI instrument maps on the
7416                    back-end by issuing the following command:</t>
7417                    <t>
7418                        <list>
7419                            <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t>
7420                        </list>
7421                    </t>
7422                    <t>Server will start sending the following notification messages:</t>
7423                    <t>
7424                        <list>
7425                            <t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"</t>
7426                        </list>
7427                    </t>
7428                    <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
7429                    for which information changes occurred. The front-end will have to send
7430                    the respective command to actually get the MIDI instrument map info. Because these messages
7431                    will be triggered by LSCP commands issued by other clients rather than real
7432                    time events happening on the server, it is believed that an empty notification
7433                    message is sufficient here.</t>
7434                </section>
7435    
7436                <section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT">
7437                    <t>Client may want to be notified when the number of MIDI instrument maps on the
7438                    back-end changes by issuing the following command:</t>
7439                    <t>
7440                        <list>
7441                            <t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t>
7442                        </list>
7443                    </t>
7444                    <t>Server will start sending the following notification messages:</t>
7445                    <t>
7446                        <list>
7447                            <t>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"</t>
7448                        </list>
7449                    </t>
7450                    <t>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
7451                    the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
7452                    the new number of MIDI instruments in the specified map.</t>
7453                </section>
7454    
7455                <section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO">
7456                    <t>Client may want to be notified when changes were made to MIDI instruments on the
7457                    back-end by issuing the following command:</t>
7458                    <t>
7459                        <list>
7460                            <t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t>
7461                        </list>
7462                    </t>
7463                    <t>Server will start sending the following notification messages:</t>
7464                    <t>
7465                        <list>
7466                            <t>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"</t>
7467                        </list>
7468                    </t>
7469                    <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
7470                    in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
7471                    the location of the changed MIDI instrument in the map. The front-end will have to send
7472                    the respective command to actually get the MIDI instrument info. Because these messages
7473                    will be triggered by LSCP commands issued by other clients rather than real
7474                    time events happening on the server, it is believed that an empty notification
7475                    message is sufficient here.</t>
7476                </section>
7477    
7478                <section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO">
7479                    <t>Client may want to be notified when changes to the global settings
7480                    of the sampler were made by issuing the following command:</t>
7481                    <t>
7482                        <list>
7483                            <t>SUBSCRIBE GLOBAL_INFO</t>
7484                        </list>
7485                    </t>
7486                    <t>Server will start sending the following types of notification messages:</t>
7487                    <t>
7488                        <list>
7489                            <t>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
7490                            golbal volume of the sampler is changed, where &lt;volume&gt; will be
7491                            replaced by the optional dotted floating point value, reflecting the
7492                            new global volume parameter.</t>
7493                        </list>
7494                    </t>
7495                </section>
7496    
7497                <section title="Number of database instrument directories changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">
7498                    <t>Client may want to be notified when the number of instrument
7499                    directories in a particular directory in the instruments database
7500                    is changed by issuing the following command:</t>
7501                    <t>
7502                        <list>
7503                            <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT</t>
7504                        </list>
7505                    </t>
7506                    <t>Server will start sending the following notification messages:</t>
7507                    <t>
7508                        <list>
7509                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:&lt;dir-path&gt;"</t>
7510                        </list>
7511                    </t>
7512                    <t>where &lt;dir-path&gt; will be replaced by the absolute path
7513                    name of the directory in the instruments database,
7514                    in which the number of directories is changed.</t>
7515                    <t>Note that when a non-empty directory is removed, this event
7516                    is not sent for the subdirectories in that directory.</t>
7517                </section>
7518    
7519                <section title="Database instrument directory information changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">
7520                    <t>Client may want to be notified when changes were made to directories
7521                    in the instruments database by issuing the following command:</t>
7522                    <t>
7523                        <list>
7524                            <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO</t>
7525                        </list>
7526                    </t>
7527                    <t>Server will start sending the following notification messages:</t>
7528                    <t>
7529                        <list>
7530                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:&lt;dir-path&gt;"</t>
7531                        </list>
7532                    </t>
7533                    <t>where &lt;dir-path&gt; will be replaced by the absolute path name
7534                    of the directory, for which information changes occurred. The front-end will have to send
7535                    the respective command to actually get the updated directory info. Because these messages
7536                    will be triggered by LSCP commands issued by other clients rather than real
7537                    time events happening on the server, it is believed that an empty notification
7538                    message is sufficient here.</t>
7539                    <t>
7540                        <list>
7541                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME &lt;old-dir-path&gt; &lt;new-name&gt;"</t>
7542                        </list>
7543                    </t>
7544                    <t>where &lt;old-dir-path&gt; is the old absolute path name of the directory
7545                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
7546                    the new name of the directory, encapsulated into apostrophes.</t>
7547                </section>
7548    
7549                <section title="Number of database instruments changed" anchor="SUBSCRIBE DB_INSTRUMENT_COUNT">
7550                    <t>Client may want to be notified when the number of instruments
7551                    in a particular directory in the instruments database
7552                    is changed by issuing the following command:</t>
7553                    <t>
7554                        <list>
7555                            <t>SUBSCRIBE DB_INSTRUMENT_COUNT</t>
7556                        </list>
7557                    </t>
7558                    <t>Server will start sending the following notification messages:</t>
7559                    <t>
7560                        <list>
7561                            <t>"NOTIFY:DB_INSTRUMENT_COUNT:&lt;dir-path&gt;"</t>
7562                        </list>
7563                    </t>
7564                    <t>where &lt;dir-path&gt; will be replaced by the absolute path
7565                    name of the directory in the instruments database,
7566                    in which the number of instruments is changed.</t>
7567                    <t>Note that when a non-empty directory is removed, this event
7568                    is not sent for the instruments in that directory.</t>
7569                </section>
7570    
7571                <section title="Database instrument information changed" anchor="SUBSCRIBE DB_INSTRUMENT_INFO">
7572                    <t>Client may want to be notified when changes were made to instruments
7573                    in the instruments database by issuing the following command:</t>
7574                    <t>
7575                        <list>
7576                            <t>SUBSCRIBE DB_INSTRUMENT_INFO</t>
7577                        </list>
7578                    </t>
7579                    <t>Server will start sending the following notification messages:</t>
7580                    <t>
7581                        <list>
7582                            <t>"NOTIFY:DB_INSTRUMENT_INFO:&lt;instr-path&gt;"</t>
7583                        </list>
7584                    </t>
7585                    <t>where &lt;instr-path&gt; will be replaced by the absolute path name
7586                    of the instrument, which settings are changed. The front-end will have to send
7587                    the respective command to actually get the updated directory info. Because these messages
7588                    will be triggered by LSCP commands issued by other clients rather than real
7589                    time events happening on the server, it is believed that an empty notification
7590                    message is sufficient here.</t>
7591                    <t>
7592                        <list>
7593                            <t>"NOTIFY:DB_INSTRUMENT_INFO:NAME &lt;old-instr-path&gt; &lt;new-name&gt;"</t>
7594                        </list>
7595                    </t>
7596                    <t>where &lt;old-instr-path&gt; is the old absolute path name of the instrument
7597                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
7598                    the new name of the instrument, encapsulated into apostrophes.</t>
7599                </section>
7600    
7601                <section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">
7602                    <t>Client may want to be notified when the status of particular database
7603                    instruments job is changed by issuing the following command:</t>
7604                    <t>
7605                        <list>
7606                            <t>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO</t>
7607                        </list>
7608                    </t>
7609                    <t>Server will start sending the following notification messages:</t>
7610                    <t>
7611                        <list>
7612                            <t>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:&lt;job-id&gt;"</t>
7613                        </list>
7614                    </t>
7615                    <t>where &lt;job-id&gt; will be replaced by the numerical ID of the job,
7616                    which status is changed. The front-end will have to send the respective
7617                    command to actually get the status info. Because these messages
7618                    will be triggered by LSCP commands issued by other clients rather than real
7619                    time events happening on the server, it is believed that an empty notification
7620                    message is sufficient here.</t>
7621                </section>
7622    
7623                <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
7624                  <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
7625                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
7626                  <t>                  <t>
# Line 3204  Schoenebeck'> Line 7656  Schoenebeck'>
7656                      <t>Rui Nuno Capela</t>                      <t>Rui Nuno Capela</t>
7657                      <t>Vladimir Senkov</t>                      <t>Vladimir Senkov</t>
7658                      <t>Mark Knecht</t>                      <t>Mark Knecht</t>
7659                        <t>Grigor Iliev</t>
7660                  </list>                  </list>
7661              </t>              </t>
7662          </section>          </section>
# Line 3211  Schoenebeck'> Line 7664  Schoenebeck'>
7664      </middle>      </middle>
7665    
7666      <back>      <back>
7667          <references>&rfc2119;</references>          <references>
7668                <reference anchor="RFC2119">
7669                    <front>
7670                        <title>Key words for use in RFCs to Indicate Requirement Levels</title>
7671                        <author initials="S." surname="Bradner" fullname="Scott Bradner">
7672                            <organization>Harvard University</organization>
7673                        </author>
7674                        <date year="1997"></date>
7675                    </front>
7676                    <seriesInfo name="RFC" value="2119" />
7677                </reference>
7678                <reference anchor="RFC793">
7679                    <front>
7680                        <title>TRANSMISSION CONTROL PROTOCOL</title>
7681                        <author>
7682                            <organization>Defense Advanced Research Projects Agency</organization>
7683                        </author>
7684                        <date year="1981"></date>
7685                    </front>
7686                    <seriesInfo name="RFC" value="793" />
7687                </reference>
7688                <reference anchor="RFC2234">
7689                    <front>
7690                        <title>Augmented BNF for Syntax Specifications</title>
7691                        <author initials="D.H." surname="Crocker" fullname="David H. Crocker">
7692                            <organization>Internet Mail Consortium</organization>
7693                        </author>
7694                        <author initials="P." surname="Overell" fullname="Paul Overell">
7695                            <organization>Demon Internet Ltd</organization>
7696                        </author>
7697                        <date year="1997"></date>
7698                    </front>
7699                    <seriesInfo name="RFC" value="2234" />
7700                </reference>
7701                <reference anchor="RFC20">
7702                    <front>
7703                        <title>ASCII format for Network Interchange</title>
7704                        <author>
7705                            <organization>UCLA</organization>
7706                        </author>
7707                        <date year="1969"></date>
7708                    </front>
7709                    <seriesInfo name="RFC" value="20" />
7710                </reference>
7711             </references>
7712      </back>      </back>
7713    
7714  </rfc>  </rfc>

Legend:
Removed from v.495  
changed lines
  Added in v.1554

  ViewVC Help
Powered by ViewVC