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

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

Parent Directory | Revision Log | View Patch Patch

-revision 377 by senkov,
Sun Feb 13 00:10:53 2005 UTC
+revision 1135 by iliev,
Thu Mar 29 09:40:45 2007 UTC
 Line 11
  <?rfc symrefs="yes" ?>
  <?rfc sortrefs="yes"?>
  <?rfc iprnotified="no" ?>
- <?rfc strict="yes" ?>
- <rfc category="std" ipr="full2026" docName="lscp.txt">
+ <!-- FIXME: next attribute should actually be "yes", temporarily disbled due
+      to an annoying "missing Normative/Informative References" error message -->
+ <?rfc strict="no" ?>
+ <rfc category="std" ipr="full3978" docName="LSCP 1.2">
      <front>
          <title>LinuxSampler Control Protocol</title>
          <author initials='C.S.' surname="Schoenebeck" fullname='C.
-Line 31 
 Schoenebeck'>
+Line 34 
 Schoenebeck'>
                  <email>schoenebeck at software minus engineering dot org</email>
              </address>
          </author>
-         <date month="Jan" year="2005"/>
+         <date month="March" year="2007"/>
          <workgroup>LinuxSampler Developers</workgroup>
          <keyword>LSCP</keyword>
          <abstract>
              <t>The LinuxSampler Control Protocol (LSCP) is an
              application-level protocol primarily intended for local and
-             remote controlling the LinuxSampler main application, which is a
+             remote controlling the LinuxSampler backend application, which is a
-             sophisticated console application essentially playing back audio
+             sophisticated server-like console application essentially playing
-             samples and manipulating the samples in real time to certain
+             back audio samples and manipulating the samples in real time to
-             extent.</t>
+             certain extent.</t>
          </abstract>
      </front>
-Line 112 
 Schoenebeck'>
+Line 115 
 Schoenebeck'>
              return and line feed characters respectively.</t>
          </section>
+         <section title="Versioning of this specification" anchor="LSCP versioning">
+             <t>LSCP will certainly be extended and enhanced by-and-by. Each official
+             release of the LSCP specification will be tagged with a unique version
+             tuple. The version tuple consists at least of a major and minor version
+             number like:
+             </t>
+             <t>
+                 <list>
+                     <t>"1.2"</t>
+                 </list>
+             </t>
+             <t>
+             In this example the major version number would be "1" and the minor
+             version number would be "2". Note that the version tuple might also
+             have more than two elements. The major version number defines a
+             group of backward compatible versions. That means a frontend is
+             compatible to the connected sampler if and only if the LSCP versions
+             to which each of the two parties complies to, match both of the
+             following rules:
+             </t>
+             <t>Compatibility:</t>
+             <t>
+                 <list style="numbers">
+                     <t>The frontend's LSCP major version and the sampler's LSCP
+                     major version are exactly equal.</t>
+                     <t>The frontend's LSCP minor version is less or equal than
+                     the sampler's LSCP minor version.</t>
+                 </list>
+             </t>
+             <t>
+             Compatibility can only be claimed if both rules are true.
+             The frontend can use the
+             <xref target="GET SERVER INFO">"GET SERVER INFO"</xref> command to
+             get the version of the LSCP specification the sampler complies with.
+             </t>
+         </section>
          <section title="Introduction">
              <t>LinuxSampler is a so called software sampler application
              capable to playback audio samples from a computer's Random
-Line 124 
 Schoenebeck'>
+Line 164 
 Schoenebeck'>
              arbitrary MIDI input method and arbitrary MIDI channel (e.g.
              sampler channel 17 could be connected to an ALSA sequencer
              device 64:0 and listening to MIDI channel 1 there). Each sampler
-             engine will be assigned an own instance of one of the available
+             channel will be associated with an instance of one of the available
              sampler engines (e.g. GigEngine, DLSEngine). The audio output of
              each sampler channel can be routed to an arbitrary audio output
              method (ALSA / JACK) and an arbitrary audio output channel
-Line 154 
 Schoenebeck'>
+Line 194 
 Schoenebeck'>
              methods will be described next.</t>
              <section title="Request/response communication method">
-                 <t>This simple communication method is based on TCP. The
+                 <t>This simple communication method is based on
+                 <xref target="RFC793">TCP</xref>. The
                  front-end application establishes a TCP connection to the
                  LinuxSampler instance on a certain host system. Then the
                  front-end application will send certain ASCII based commands
-Line 216 
 Schoenebeck'>
+Line 257 
 Schoenebeck'>
                      &lt;warning-message&gt; and &lt;error-message&gt; are
                      human readable descriptions of the warning or error
                      respectively.</t>
+                     <t>Examples:</t>
+                     <t>
+                         <list>
+                             <t>C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0</t>
+                             <t>S: "WRN:32:This is a 24 bit patch which is not supported natively yet."</t>
+                         </list>
+                     </t>
+                     <t>
+                         <list>
+                             <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"</t>
+                             <t>S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter 'EAR'."</t>
+                         </list>
+                     </t>
+                     <t>
+                         <list>
+                             <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"</t>
+                             <t>S: "ERR:9:There is no audio output device with index 123456."</t>
+                         </list>
+                     </t>
                      <t>Normal result sets could be:</t>
                      <t>
                          <list style="numbers">
-Line 234 
 Schoenebeck'>
+Line 294 
 Schoenebeck'>
                              <t>"OK"</t>
                          </list>
                      </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
                      <t>Single line result sets are command specific. One
                      example of a single line result set is an empty line.
                      Multi-line result sets are command specific and may
-Line 244 
 Schoenebeck'>
+Line 311 
 Schoenebeck'>
                              <t>"."</t>
                          </list>
                      </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t>
+                             <t>S: "DRIVER: ALSA"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"CHANNELS: 2"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"SAMPLERATE: 44100"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"ACTIVE: true"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"FRAGMENTS: 2"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"FRAGMENTSIZE: 128"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"CARD: '0,0'"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"."</t>
+                         </list>
+                     </t>
                      <t>In addition to above mentioned formats, warnings and
                      empty result sets MAY be indexed. In this case, they
                      have the following formats respectively:</t>
-Line 258 
 Schoenebeck'>
+Line 339 
 Schoenebeck'>
                      related to or other integer value.</t>
                      <t>Each line of the result set MUST end with
                      &lt;CRLF&gt;.</t>
+                     <t>Examples:</t>
+                     <t>
+                         <list>
+                             <t>C: "ADD CHANNEL"</t>
+                             <t>S: "OK[12]"</t>
+                         </list>
+                     </t>
+                     <t>
+                         <list>
+                             <t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"</t>
+                             <t>S: "WRN[0]:32:Sample rate not supported, using 44100 instead."</t>
+                         </list>
+                     </t>
                  </section>
              </section>
              <section title="Subscribe/notify communication method">
-Line 326 
 Schoenebeck'>
+Line 420 
 Schoenebeck'>
                  <t>where &lt;event-id&gt; will be replace by the respective
                  event that client is no longer interested in receiving. For
-                 a list of supported events see chapter 6.</t>
+                 a list of supported events see <xref target="events" />.</t>
                  <t>Example: the fill states of disk stream buffers have
                  changed on sampler channel 4 and the LinuxSampler instance
-Line 372 
 Schoenebeck'>
+Line 466 
 Schoenebeck'>
              </section>
          </section>
-         <section title="Description for control commands">
+         <section title="Description for control commands" anchor="control_commands">
              <t>This chapter will describe the available control commands
              that can be sent on the TCP connection in detail. Some certain
-             commands (e.g. "GET CHANNEL INFO" or "GET ENGINE INFO") lead to
+             commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref>
+             or <xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref>) lead to
              multiple-line responses. In this case LinuxSampler signals the
              end of the response by a "." (single dot) line.</t>
-Line 419 
 Schoenebeck'>
+Line 514 
 Schoenebeck'>
                  what parameters drivers are offering, how to retrieve their
                  possible values, etc.</t>
-                 <section title="Getting all available audio output drivers">
+                 <section title="Getting amount of available audio output drivers" anchor="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">
+                     <t>Use the following command to get the number of
+                     audio output drivers currently available for the
+                     LinuxSampler instance:</t>
+                     <t>
+                         <list>
+                             <t>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>LinuxSampler will answer by sending the
+                             number of audio output drivers.</t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t>
+                             <t>S: "2"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Getting all available audio output drivers" anchor="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
                      <t>Use the following command to list all audio output
                      drivers currently available for the LinuxSampler
                      instance:</t>
                      <t>
                          <list>
-                             <t>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS</t>
+                             <t>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS</t>
                          </list>
                      </t>
                      <t>Possible Answers:</t>
-Line 439 
 Schoenebeck'>
+Line 559 
 Schoenebeck'>
                      <t>Example:</t>
                      <t>
                          <list>
-                             <t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t>
+                             <t>C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t>
                              <t>S: "ALSA,JACK"</t>
                          </list>
                      </t>
                  </section>
                  <section title="Getting information about a specific audio
-                 output driver">
+                 output driver" anchor="GET AUDIO_OUTPUT_DRIVER INFO">
                      <t>Use the following command to get detailed information
                      about a specific audio output driver:</t>
                      <t>
-Line 456 
 Schoenebeck'>
+Line 576 
 Schoenebeck'>
                          </list>
                      </t>
                      <t>Where &lt;audio-output-driver&gt; is the name of the
-                     audio output driver, returned by the "GET
+                     audio output driver, returned by the
-                     AVAILABLE_AUDIO_OUTPUT_DRIVERS" command.</t>
+                     <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command.</t>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-Line 519 
 Schoenebeck'>
+Line 639 
 Schoenebeck'>
                  </section>
                  <section title="Getting information about specific audio
-                 output driver parameter">
+                 output driver parameter" anchor="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">
                      <t>Use the following command to get detailed information
                      about a  specific audio output driver parameter:</t>
                      <t>
-Line 528 
 Schoenebeck'>
+Line 648 
 Schoenebeck'>
                          </list>
                      </t>
                      <t>Where &lt;audio&gt; is the name of the audio output
-                     driver as returned by the "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS" command,
+                     driver as returned by the <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
+                     "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command,
                      &lt;prm&gt; a specific parameter name for which information should be
-                     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO" command) and
+                     obtained (as returned by the
+                     <xref target="GET AUDIO_OUTPUT_DRIVER INFO">"GET AUDIO_OUTPUT_DRIVER INFO"</xref> command) and
                      &lt;deplist&gt; is an optional list of parameters on which the sought
                      parameter &lt;prm&gt; depends on, &lt;deplist&gt; is a list of key-value
                      pairs in form of "key1=val1 key2=val2 ...", where character string values
-Line 542 
 Schoenebeck'>
+Line 664 
 Schoenebeck'>
                      <t>
                          <list>
                              <t>LinuxSampler will answer by sending a
-                             &lz;CRLF&gt; separated list.
+                             &lt;CRLF&gt; separated list.
                              Each answer line begins with the information category name
                              followed by a colon and then a space character &lt;SP&gt; and
                              finally
-Line 577 
 Schoenebeck'>
+Line 699 
 Schoenebeck'>
                                <list>
                                  <t>either true or false, defines if this parameter must be
                                  given when the device is to be created with the
-                                 'CREATE AUDIO_OUTPUT_DEVICE' command
+                                 <xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref>
-                                 (always returned, no matter which driver parameter)</t>
+                                 command (always returned, no matter which driver parameter)</t>
                                </list>
                              </t>
-Line 586 
 Schoenebeck'>
+Line 708 
 Schoenebeck'>
                                <list>
                                  <t>either true or false, if false then this parameter can
                                  be changed at any time, once the device is created by
-                                 the 'CREATE AUDIO_OUTPUT_DEVICE' command
+                                 the <xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref>
-                                 (always returned, no matter which driver parameter)</t>
+                                 command (always returned, no matter which driver parameter)</t>
                                </list>
                              </t>
-Line 602 
 Schoenebeck'>
+Line 724 
 Schoenebeck'>
                              <t>DEPENDS -
                                <list>
-                                 <t>comma separated list of paramters this parameter depends
+                                 <t>comma separated list of parameters this parameter depends
                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',
                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these
                                  listed parameters, for example assuming that an audio
-Line 619 
 Schoenebeck'>
+Line 741 
 Schoenebeck'>
                                <list>
                                  <t>reflects the default value for this parameter which is
                                  used when the device is created and not explicitly
-                                 given with the 'CREATE AUDIO_OUTPUT_DEVICE' command,
+                                 given with the <xref target="CREATE AUDIO_OUTPUT_DEVICE">
+                                 'CREATE AUDIO_OUTPUT_DEVICE'</xref> command,
                                  in case of MULTIPLCITY=true, this is a comma separated
                                  list, that's why character strings are encapsulated into
                                  apostrophes (')
-Line 647 
 Schoenebeck'>
+Line 770 
 Schoenebeck'>
                                </list>
                              </t>
-                             <t>POSSIBILITES -
+                             <t>POSSIBILITIES -
                                <list>
                                  <t>comma separated list of possible values for this
                                  parameter, character strings are encapsulated into
-Line 670 
 Schoenebeck'>
+Line 793 
 Schoenebeck'>
                              <t>&nbsp;&nbsp;&nbsp;"FIX: true"</t>
                              <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>
                              <t>&nbsp;&nbsp;&nbsp;"DEFAULT: '0,0'"</t>
-                             <t>&nbsp;&nbsp;&nbsp;"POSSIBILITES: '0,0','1,0','2,0'"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: '0,0','1,0','2,0'"</t>
                              <t>&nbsp;&nbsp;&nbsp;"."</t>
                          </list>
                      </t>
-Line 704 
 Schoenebeck'>
+Line 827 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Creating an audio output device">
+                 <section title="Creating an audio output device" anchor="CREATE AUDIO_OUTPUT_DEVICE">
                      <t>Use the following command to create a new audio output device for  the desired audio output system:</t>
                      <t>
-Line 714 
 Schoenebeck'>
+Line 837 
 Schoenebeck'>
                      </t>
                      <t>Where &lt;audio-output-driver&gt; should be replaced by the desired audio
-                     output system and &lt;param-list&gt; by an optional list of driver
+                     output system as returned by the
+                     <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref>
+                     command and &lt;param-list&gt; by an optional list of driver
                      specific parameters in form of "key1=val1 key2=val2 ...", where
                      character string values should be encapsulated into apostrophes (').
                      Note that there might be drivers which require parameter(s) to be
-Line 762 
 Schoenebeck'>
+Line 887 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Destroying an audio output device">
+                 <section title="Destroying an audio output device" anchor="DESTROY AUDIO_OUTPUT_DEVICE">
                      <t>Use the following command to destroy a created output device:</t>
                      <t>
                          <list>
-Line 770 
 Schoenebeck'>
+Line 895 
 Schoenebeck'>
                          </list>
                      </t>
                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
-                     audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE" or
+                     audio output device as given by the
-                     "GET AUDIO_OUTPUT_DEVICES" command.</t>
+                     <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
+                     or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
+                     command.</t>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-Line 806 
 Schoenebeck'>
+Line 933 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Getting all created audio output device count">
+                 <section title="Getting all created audio output device count" anchor="GET AUDIO_OUTPUT_DEVICES">
                      <t>Use the following command to count all created audio output devices:</t>
                      <t>
                          <list>
-Line 829 
 Schoenebeck'>
+Line 956 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Getting all created audio output device list">
+                 <section title="Getting all created audio output device list" anchor="LIST AUDIO_OUTPUT_DEVICES">
                      <t>Use the following command to list all created audio output devices:</t>
                      <t>
                          <list>
-Line 852 
 Schoenebeck'>
+Line 979 
 Schoenebeck'>
                      </t>
                  </section>
-                 <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">
                      <t>Use the following command to get current settings of a specific, created audio output device:</t>
                      <t>
                          <list>
                              <t>GET AUDIO_OUTPUT_DEVICE INFO &lt;device-id&gt;</t>
                          </list>
                      </t>
-                     <t>Where &lt;device-id&gt; should be replaced by be numerical ID
+                     <t>Where &lt;device-id&gt; should be replaced by numerical ID
                      of the audio output device as e.g. returned by the
-                     "GET AUDIO_OUTPUT_DEVICES" command.</t>
+                     <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> command.</t>
                      <t>Possible Answers:</t>
                      <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                      Each answer line begins with the information category name
-Line 875 
 Schoenebeck'>
+Line 1002 
 Schoenebeck'>
                              <t>DRIVER -
                                  <list>
                                      <t>identifier of the used audio output driver, as also
-                                     returned by the "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"
+                                     returned by the
+                                     <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
+                                     "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref>
                                      command</t>
                                  </list>
                              </t>
-Line 904 
 Schoenebeck'>
+Line 1033 
 Schoenebeck'>
                      order. The fields above are only those fields which are
                      returned by all audio output devices. Every audio output driver
                      might have its own, additional driver specific parameters (see
-                     "GET AUDIO_OUTPUT_DRIVER INFO" command) which are also returned
+                     <xref target="GET AUDIO_OUTPUT_DRIVER INFO" />)
-                     by this command.</t>
+                     which are also returned by this command.</t>
                      <t>Example:</t>
                      <t>
                          <list>
-Line 923 
 Schoenebeck'>
+Line 1052 
 Schoenebeck'>
                  </section>
-                 <section title="Changing settings of audio output devices">
+                 <section title="Changing settings of audio output devices" anchor="SET AUDIO_OUTPUT_DEVICE_PARAMETER">
                      <t>Use the following command to alter a specific setting of a created audio output device:</t>
                      <t>
                          <list>
-Line 931 
 Schoenebeck'>
+Line 1060 
 Schoenebeck'>
                          </list>
                      </t>
                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
-                     audio output device, &lt;key&gt; by the name of the parameter to change
+                     audio output device as given by the
+                     <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
+                     or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
+                     command, &lt;key&gt; by the name of the parameter to change
                      and &lt;value&gt; by the new value for this parameter.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 965 
 Schoenebeck'>
+Line 1097 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Getting information about an audio channel">
+                 <section title="Getting information about an audio channel" anchor="GET AUDIO_OUTPUT_CHANNEL INFO">
                      <t>Use the following command to get information about an audio channel:</t>
                      <t>
                          <list>
                              <t>GET AUDIO_OUTPUT_CHANNEL INFO &lt;device-id&gt; &lt;audio-chan&gt;</t>
                          </list>
                      </t>
-                     <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
-                     and &lt;audio-chan&gt; the audio channel number.</t>
+                     <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
+                     or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
+                     command and &lt;audio-chan&gt; the audio channel number.</t>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-Line 1003 
 Schoenebeck'>
+Line 1137 
 Schoenebeck'>
                                      </t>
                                      <t>MIX_CHANNEL_DESTINATION -
                                          <list>
-                                             <t>reflects the real audio channel (of the same audio
+                                             <t>numerical ID (positive integer including 0)
+                                             which reflects the real audio channel (of the same audio
                                              output device) this mix channel refers to, means where
                                              the audio signal actually will be routed / added to
                                              (only returned in case the audio channel is mix channel)</t>
-Line 1062 
 Schoenebeck'>
+Line 1197 
 Schoenebeck'>
                      </t>
                  </section>
-                 <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">
                      <t>Use the following command to get detailed information about specific audio channel parameter:</t>
                      <t>
-Line 1071 
 Schoenebeck'>
+Line 1206 
 Schoenebeck'>
                          </list>
                      </t>
-                     <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
-                     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>
+                     or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
+                     command, &lt;chan&gt; the audio channel number
                      and &lt;param&gt; a specific channel parameter name for which information should
-                     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">
+                     "GET AUDIO_OUTPUT_CHANNEL INFO"</xref> command).</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 1137 
 Schoenebeck'>
+Line 1275 
 Schoenebeck'>
                                              parameter)</t>
                                          </list>
                                      </t>
-                                     <t>POSSIBILITES -
+                                     <t>POSSIBILITIES -
                                          <list>
                                              <t>comma separated list of possible values for this
                                              parameter, character strings are encapsulated into
-Line 1159 
 Schoenebeck'>
+Line 1297 
 Schoenebeck'>
                              <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>
                              <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
                              <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"</t>
-                             <t>&nbsp;&nbsp;&nbsp;"POSSIBILITES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t>
                              <t>&nbsp;&nbsp;&nbsp;"."</t>
                          </list>
                      </t>
                  </section>
-                 <section title="Changing settings of audio output channels">
+                 <section title="Changing settings of audio output channels" anchor="SET AUDIO_OUTPUT_CHANNEL_PARAMETER">
                      <t>Use the following command to alter a specific setting of an audio output channel:</t>
                      <t>
                          <list>
                              <t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER &lt;dev-id&gt; &lt;chn&gt; &lt;key&gt;=&lt;value&gt;</t>
                          </list>
                      </t>
-                     <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
-                     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>
+                     or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
+                     command, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the
                      parameter to change and &lt;value&gt; by the new value for this parameter.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 1241 
 Schoenebeck'>
+Line 1381 
 Schoenebeck'>
                  showing how to retrieve what parameters drivers are offering, how to retrieve their
                  possible values, etc.</t>
-                 <section title="Getting all available MIDI input drivers">
+                 <section title="Getting amount of available MIDI input drivers" anchor="GET AVAILABLE_MIDI_INPUT_DRIVERS">
+                     <t>Use the following command to get the number of
+                     MIDI input drivers currently available for the
+                     LinuxSampler instance:</t>
+                     <t>
+                         <list>
+                             <t>GET AVAILABLE_MIDI_INPUT_DRIVERS</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>LinuxSampler will answer by sending the
+                             number of available MIDI input drivers.</t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t>
+                             <t>S: "2"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Getting all available MIDI input drivers" anchor="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
                      <t>Use the following command to list all MIDI input drivers currently available
                      for the LinuxSampler instance:</t>
                      <t>
                          <list>
-                             <t>GET AVAILABLE_MIDI_INPUT_DRIVERS</t>
+                             <t>LIST AVAILABLE_MIDI_INPUT_DRIVERS</t>
                          </list>
                      </t>
                      <t>Possible Answers:</t>
-Line 1259 
 Schoenebeck'>
+Line 1424 
 Schoenebeck'>
                      <t>Example:</t>
                      <t>
                          <list>
-                             <t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t>
+                             <t>C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</t>
                              <t>S: "ALSA,JACK"</t>
                          </list>
                      </t>
                  </section>
-                 <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">
                      <t>Use the following command to get detailed information about a specific MIDI input driver:</t>
                      <t>
                          <list>
                              <t>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;</t>
                          </list>
                      </t>
-                     <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
+                     by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
+                     "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command.</t>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-Line 1319 
 Schoenebeck'>
+Line 1486 
 Schoenebeck'>
                      </t>
                  </section>
-                 <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">
                      <t>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:</t>
                      <t>
                          <list>
-Line 1327 
 Schoenebeck'>
+Line 1494 
 Schoenebeck'>
                          </list>
                      </t>
-                     <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
-                     by the "GET AVAILABLE_MIDI_INPUT_DRIVERS" command, &lt;param&gt; a specific
+                     by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
+                     "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command, &lt;param&gt; a specific
                      parameter name for which information should be obtained (as returned by the
-                     "GET MIDI_INPUT_DRIVER INFO" command) and &lt;deplist&gt; is an optional list
+                     <xref target="GET MIDI_INPUT_DRIVER INFO">
+                     "GET MIDI_INPUT_DRIVER INFO"</xref> command) and &lt;deplist&gt; is an optional list
                      of parameters on which the sought parameter &lt;param&gt; depends on,
                      &lt;deplist&gt; is a key-value pair list in form of "key1=val1 key2=val2 ...",
                      where character string values are encapsulated into apostrophes ('). Arguments
-Line 1371 
 Schoenebeck'>
+Line 1540 
 Schoenebeck'>
                                <list>
                                  <t>either true or false, defines if this parameter must be
                                  given when the device is to be created with the
-                                 'CREATE MIDI_INPUT_DEVICE' command
+                                 <xref target="CREATE MIDI_INPUT_DEVICE">
+                                 'CREATE MIDI_INPUT_DEVICE'</xref> command
                                  (always returned, no matter which driver parameter)</t>
                                </list>
                              </t>
-Line 1380 
 Schoenebeck'>
+Line 1550 
 Schoenebeck'>
                                <list>
                                  <t>either true or false, if false then this parameter can
                                  be changed at any time, once the device is created by
-                                 the 'CREATE MIDI_INPUT_DEVICE' command
+                                 the <xref target="CREATE MIDI_INPUT_DEVICE">
+                                 'CREATE MIDI_INPUT_DEVICE'</xref> command
                                  (always returned, no matter which driver parameter)</t>
                                </list>
                              </t>
-Line 1396 
 Schoenebeck'>
+Line 1567 
 Schoenebeck'>
                              <t>DEPENDS -
                                <list>
-                                 <t>comma separated list of paramters this parameter depends
+                                 <t>comma separated list of parameters this parameter depends
                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',
                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these
                                  listed parameters, for example assuming that an audio
-Line 1413 
 Schoenebeck'>
+Line 1584 
 Schoenebeck'>
                                <list>
                                  <t>reflects the default value for this parameter which is
                                  used when the device is created and not explicitly
-                                 given with the 'CREATE MIDI_INPUT_DEVICE' command,
+                                 given with the <xref target="CREATE MIDI_INPUT_DEVICE">
+                                 'CREATE MIDI_INPUT_DEVICE'</xref> command,
                                  in case of MULTIPLCITY=true, this is a comma separated
                                  list, that's why character strings are encapsulated into
                                  apostrophes (')
-Line 1441 
 Schoenebeck'>
+Line 1613 
 Schoenebeck'>
                                </list>
                              </t>
-                             <t>POSSIBILITES -
+                             <t>POSSIBILITIES -
                                <list>
                                  <t>comma separated list of possible values for this
                                  parameter, character strings are encapsulated into
-Line 1469 
 Schoenebeck'>
+Line 1641 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Creating a MIDI input device">
+                 <section title="Creating a MIDI input device" anchor="CREATE MIDI_INPUT_DEVICE">
                      <t>Use the following command to create a new MIDI input device for  the desired MIDI input system:</t>
                      <t>
                          <list>
-Line 1477 
 Schoenebeck'>
+Line 1649 
 Schoenebeck'>
                          </list>
                      </t>
-                     <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
+                     by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
+                     "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command and &lt;param-list&gt; by an
                      optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where
                      character string values should be encapsulated into apostrophes (').
                      Note that there might be drivers which require parameter(s) to be
-Line 1517 
 Schoenebeck'>
+Line 1691 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Destroying a MIDI input device">
+                 <section title="Destroying a MIDI input device" anchor="DESTROY MIDI_INPUT_DEVICE">
                      <t>Use the following command to destroy a created MIDI input device:</t>
                      <t>
                          <list>
                              <t>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;</t>
                          </list>
                      </t>
-                     <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
+                     <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
+                     or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
+                     command.</t>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-Line 1556 
 Schoenebeck'>
+Line 1733 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Getting all created MIDI input device count">
+                 <section title="Getting all created MIDI input device count" anchor="GET MIDI_INPUT_DEVICES">
                      <t>Use the following command to count all created MIDI input devices:</t>
                      <t>
                          <list>
-Line 1580 
 Schoenebeck'>
+Line 1757 
 Schoenebeck'>
                  </section>
-                 <section title="Getting all created MIDI input device list">
+                 <section title="Getting all created MIDI input device list" anchor="LIST MIDI_INPUT_DEVICES">
                      <t>Use the following command to list all created MIDI input devices:</t>
                      <t>
                          <list>
-Line 1609 
 Schoenebeck'>
+Line 1786 
 Schoenebeck'>
                      </t>
                  </section>
-                 <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">
                      <t>Use the following command to get current settings of a specific, created MIDI input device:</t>
                      <t>
                          <list>
                              <t>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;</t>
                          </list>
                      </t>
-                     <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
+                     <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
+                     or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
+                     command.</t>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-Line 1633 
 Schoenebeck'>
+Line 1813 
 Schoenebeck'>
                                      <t>DRIVER -
                                          <list>
                                              <t>identifier of the used MIDI input driver, as e.g.
-                                             returned by the "GET AVAILABLE_MIDI_INPUT_DRIVERS"
+                                             returned by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
+                                             "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref>
                                              command</t>
                                          </list>
                                      </t>
-Line 1656 
 Schoenebeck'>
+Line 1837 
 Schoenebeck'>
                      order. The fields above are only those fields which are
                      returned by all MIDI input devices. Every MIDI input driver
                      might have its own, additional driver specific parameters (see
-                     "GET MIDI_INPUT_DRIVER INFO" command) which are also returned
+                     <xref target="GET MIDI_INPUT_DRIVER INFO">
+                     "GET MIDI_INPUT_DRIVER INFO"</xref> command) which are also returned
                      by this command.</t>
                      <t>Example:</t>
-Line 1670 
 Schoenebeck'>
+Line 1852 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Changing settings of audio output devices">
+                 <section title="Changing settings of MIDI input devices" anchor="SET MIDI_INPUT_DEVICE_PARAMETER">
                      <t>Use the following command to alter a specific setting of a created MIDI input device:</t>
                      <t>
                          <list>
-Line 1679 
 Schoenebeck'>
+Line 1861 
 Schoenebeck'>
                      </t>
                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
-                     MIDI input device, &lt;key&gt; by the name of the parameter to change and
+                     MIDI input device as returned by the
+                     <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
+                     or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
+                     command, &lt;key&gt; by the name of the parameter to change and
                      &lt;value&gt; by the new value for this parameter.</t>
                      <t>Possible Answers:</t>
-Line 1707 
 Schoenebeck'>
+Line 1892 
 Schoenebeck'>
                      <t>Example:</t>
                      <t>
                          <list>
-                             <t>C: "SET MIDI_INPUT_DEVICE PARAMETER 0 ACTIVE=false"</t>
+                             <t>C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"</t>
                              <t>S: "OK"</t>
                          </list>
                      </t>
                  </section>
-                 <section title="Getting information about a MIDI port">
+                 <section title="Getting information about a MIDI port" anchor="GET MIDI_INPUT_PORT INFO">
                      <t>Use the following command to get information about a MIDI port:</t>
                      <t>
                          <list>
                              <t>GET MIDI_INPUT_PORT INFO &lt;device-id&gt; &lt;midi-port&gt;</t>
                          </list>
                      </t>
-                     <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
-                     and &lt;midi-port&gt; the MIDI input port number.</t>
+                     <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
+                     or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
+                     command and &lt;midi-port&gt; the MIDI input port number.</t>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-Line 1755 
 Schoenebeck'>
+Line 1942 
 Schoenebeck'>
                      </t>
                  </section>
-                 <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">
                      <t>Use the following command to get detailed information about specific MIDI port parameter:</t>
                      <t>
                          <list>
-Line 1763 
 Schoenebeck'>
+Line 1950 
 Schoenebeck'>
                          </list>
                      </t>
-                     <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
-                     by the "GET MIDI_INPUT_DEVICES" command, &lt;port&gt; the MIDI port number and
+                     <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
+                     or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
+                     command, &lt;port&gt; the MIDI port number and
                      &lt;param&gt; a specific port parameter name for which information should be
-                     obtained (as returned by the "GET MIDI_INPUT_PORT INFO" command).</t>
+                     obtained (as returned by the <xref target="GET MIDI_INPUT_PORT INFO">
+                     "GET MIDI_INPUT_PORT INFO"</xref> command).</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 1829 
 Schoenebeck'>
+Line 2019 
 Schoenebeck'>
                                      parameter)</t>
                                  </list>
                              </t>
-                             <t>POSSIBILITES -
+                             <t>POSSIBILITIES -
                                  <list>
                                      <t>comma separated list of possible values for this
                                      parameter, character strings are encapsulated into
-Line 1851 
 Schoenebeck'>
+Line 2041 
 Schoenebeck'>
                              <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>
                              <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
                              <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"</t>
-                             <t>&nbsp;&nbsp;&nbsp;"POSSIBILITES: '64:0','68:0','68:1'"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: '64:0','68:0','68:1'"</t>
                              <t>&nbsp;&nbsp;&nbsp;"."</t>
                          </list>
                      </t>
                  </section>
-                 <section title="Changing settings of MIDI input ports">
+                 <section title="Changing settings of MIDI input ports" anchor="SET MIDI_INPUT_PORT_PARAMETER">
                      <t>Use the following command to alter a specific setting of a MIDI input port:</t>
                      <t>
                          <list>
-Line 1866 
 Schoenebeck'>
+Line 2056 
 Schoenebeck'>
                      </t>
                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
-                     MIDI device, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
+                     MIDI device as returned by the
+                     <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
+                     or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
+                     command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
                      the parameter to change and &lt;value&gt; by the new value for this
                      parameter.</t>
-Line 1902 
 Schoenebeck'>
+Line 2095 
 Schoenebeck'>
              </section>
              <section title="Configuring sampler channels">
-                 <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
-                 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
+                 MIDI and audio devices.</t>
-                 <section title="Loading an instrument">
+                 <section title="Loading an instrument" anchor="LOAD INSTRUMENT">
                      <t>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:</t>
                      <t>
                          <list>
-Line 1923 
 Schoenebeck'>
+Line 2117 
 Schoenebeck'>
                      is that the regular command returns OK only after the instrument has been
                      fully loaded and the channel is ready to be used while NON_MODAL version
                      returns immediately and a background process is launched to load the instrument
-                     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>
+                     command can be used to obtain loading
                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks
                      such as making sure that the file could be read and it is of a proper format
                      and SHOULD return ERR and SHOULD not launch the background process should any
-Line 1961 
 Schoenebeck'>
+Line 2156 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Loading a sampler engine">
+                 <section title="Loading a sampler engine" anchor="LOAD ENGINE">
-                     <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
                      channel by the following command:</t>
                      <t>
                          <list>
-Line 1970 
 Schoenebeck'>
+Line 2165 
 Schoenebeck'>
                          </list>
                      </t>
-                     <t>Where &lt;engine-name&gt; is usually the C++ class name of the engine
+                     <t>Where &lt;engine-name&gt; is an engine name as obtained by the
-                     implementation and &lt;sampler-channel&gt; the sampler channel the
+                     <xref target="LIST AVAILABLE_ENGINES">
-                     deployed engine should be assigned to. Even if the respective
+                     "LIST AVAILABLE_ENGINES"</xref> command and &lt;sampler-channel&gt;
-                     sampler channel has already a deployed engine with that engine
+                     the sampler channel as returned by the
-                     name, a new engine instance will be assigned to the sampler channel.</t>
+                     <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> or
+                     <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command where
+                     the engine type should be assigned to. This command should be issued
+                     after adding a new sampler channel and before any other control
+                     commands on the new sampler channel. It can also be used to change
+                     the engine type of a sampler channel. This command has (currently) no
+                     way to define or force if a new engine instance should be created and
+                     assigned to the given sampler channel or if an already existing
+                     instance of that engine type, shared with other sampler channels,
+                     should be used.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 2007 
 Schoenebeck'>
+Line 2211 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Getting all created sampler channel count">
+                 <section title="Getting all created sampler channel count" anchor="GET CHANNELS">
                      <t>The number of sampler channels can change on runtime. To get the
                      current amount of sampler channels, the front-end can send the
                      following command:</t>
-Line 2031 
 Schoenebeck'>
+Line 2235 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Getting all created sampler channel list">
+                 <section title="Getting all created sampler channel list" anchor="LIST CHANNELS">
                      <t>The number of sampler channels can change on runtime. To get the
                      current list of sampler channels, the front-end can send the
                      following command:</t>
-Line 2056 
 Schoenebeck'>
+Line 2260 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Adding a new sampler channel">
+                 <section title="Adding a new sampler channel" anchor="ADD CHANNEL">
                      <t>A new sampler channel can be added to the end of the sampler
                      channel list by sending the following command:</t>
                      <t>
-Line 2080 
 Schoenebeck'>
+Line 2284 
 Schoenebeck'>
                                  <list>
                                      <t>in case a new sampler channel could be added, where
                                      &lt;sampler-channel&gt; reflects the channel number of the new
-                                     created sampler channel which should the be used to set up
+                                     created sampler channel which should be used to set up
-                                     the sampler channel by sending subsequent intialization
+                                     the sampler channel by sending subsequent initialization
                                      commands</t>
                                  </list>
                              </t>
-Line 2108 
 Schoenebeck'>
+Line 2312 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Removing a sampler channel">
+                 <section title="Removing a sampler channel" anchor="REMOVE CHANNEL">
                      <t>A sampler channel can be removed by sending the following command:</t>
                      <t>
                          <list>
-Line 2116 
 Schoenebeck'>
+Line 2320 
 Schoenebeck'>
                          </list>
                      </t>
-                     <t>This will decrement the sampler channel count by one and also
+                     <t>Where &lt;sampler-channel&gt; should be replaced by the
-                     decrement the channel numbers of all subsequent sampler channels by
+                     number of the sampler channel as given by the
-                     one.</t>
+                     <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref>
+                     command. The channel numbers of all subsequent sampler channels
+                     remain the same.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 2151 
 Schoenebeck'>
+Line 2358 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Getting all available engines">
+                 <section title="Getting amount of available engines" anchor="GET AVAILABLE_ENGINES">
-                     <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>
                      <t>
                          <list>
                              <t>GET AVAILABLE_ENGINES</t>
-Line 2161 
 Schoenebeck'>
+Line 2368 
 Schoenebeck'>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-                             <t>LinuxSampler will answer by sending a comma separated character
+                             <t>LinuxSampler will answer by sending the number of available engines.</t>
-                             string of the engines' C++ class names.</t>
                          </list>
                      </t>
                      <t>Example:</t>
                      <t>
                          <list>
                              <t>C: "GET AVAILABLE_ENGINES"</t>
-                             <t>S: "GigEngine,AkaiEngine,DLSEngine,JoesCustomEngine"</t>
+                             <t>S: "4"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Getting all available engines" anchor="LIST AVAILABLE_ENGINES">
+                     <t>The front-end can ask for a list of all available engines by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>LIST AVAILABLE_ENGINES</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>LinuxSampler will answer by sending a comma separated list
+                             of the engines' names encapsulated into apostrophes (').
+                             Engine names can consist of lower and upper cases,
+                             digits and underlines ("_" character).</t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "LIST AVAILABLE_ENGINES"</t>
+                             <t>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"</t>
                          </list>
                      </t>
                  </section>
-                 <section title="Getting information about an engine">
+                 <section title="Getting information about an engine" anchor="GET ENGINE INFO">
                      <t>The front-end can ask for information about a specific engine by
                      sending the following command:</t>
                      <t>
-Line 2182 
 Schoenebeck'>
+Line 2413 
 Schoenebeck'>
                              <t>GET ENGINE INFO &lt;engine-name&gt;</t>
                          </list>
                      </t>
-                     <t>Where &lt;engine-name&gt; is usually the C++ class name of the engine implementation.</t>
+                     <t>Where &lt;engine-name&gt; is an engine name as obtained by the
+                     <xref target="LIST AVAILABLE_ENGINES">
+                     "LIST AVAILABLE_ENGINES"</xref> command.</t>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-                             <t>LinuxSampler will answer by sending &lt;&gt; separated list.
+                             <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                              Each answer line begins with the information category name
                              followed by a colon and then a space character &lt;SP&gt; and finally
                              the info character string to that info category. At the moment
-Line 2222 
 Schoenebeck'>
+Line 2455 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Getting sampler channel information">
+                 <section title="Getting sampler channel information" anchor="GET CHANNEL INFO">
                      <t>The front-end can ask for the current settings of a sampler channel
                      by sending the following command:</t>
                      <t>
-Line 2230 
 Schoenebeck'>
+Line 2463 
 Schoenebeck'>
                              <t>GET CHANNEL INFO &lt;sampler-channel&gt;</t>
                          </list>
                      </t>
-                     <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
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-Line 2244 
 Schoenebeck'>
+Line 2479 
 Schoenebeck'>
                                  <list>
                                      <t>ENGINE_NAME -
                                          <list>
-                                             <t>name of the engine that is deployed on the sampler
+                                             <t>name of the engine that is associated with the sampler
-                                             channel, "NONE" if there's no engine deployed yet for
+                                             channel, "NONE" if there's no engine associated yet for
                                              this sampler channel</t>
                                          </list>
                                      </t>
-Line 2320 
 Schoenebeck'>
+Line 2555 
 Schoenebeck'>
                                      <t>VOLUME -
                                          <list>
                                              <t>optionally dotted number for the channel volume factor
-                                             (where a value < 1.0 means attenuation and a value >
+                                             (where a value &lt; 1.0 means attenuation and a value >
 .0 means amplification)</t>
                                          </list>
                                      </t>
+                                     <t>MUTE -
+                                         <list>
+                                             <t>Determines whether the channel is muted, "true" if the
+                                             channel is muted, "false" if the channel is not muted, and
+                                             "MUTED_BY_SOLO" if the channel is muted because of the
+                                             presence of a solo channel and will be unmuted when
+                                             there are no solo channels left</t>
+                                         </list>
+                                     </t>
+                                     <t>SOLO -
+                                         <list>
+                                             <t>Determines whether this is a solo channel, "true" if
+                                             the channel is a solo channel; "false" otherwise</t>
+                                         </list>
+                                     </t>
+                                     <t>MIDI_INSTRUMENT_MAP -
+                                         <list>
+                                             <t>Determines to which MIDI instrument map this sampler
+                                             channel is assigned to. Read chapter
+                                             <xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref>
+                                             for a list of possible values.</t>
+                                         </list>
+                                     </t>
                                  </list>
                              </t>
                          </list>
-Line 2346 
 Schoenebeck'>
+Line 2604 
 Schoenebeck'>
                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_DEVICE: 0"</t>
                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_PORT: 0"</t>
                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"MUTE: false"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"SOLO: false"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"MIDI_INSTRUMENT_MAP: NONE"</t>
                              <t>&nbsp;&nbsp;&nbsp;"."</t>
                          </list>
                      </t>
                  </section>
-                 <section title="Current number of active voices">
+                 <section title="Current number of active voices" anchor="GET CHANNEL VOICE_COUNT">
                      <t>The front-end can ask for the current number of active voices on a
                      sampler channel by sending the following command:</t>
                      <t>
-Line 2359 
 Schoenebeck'>
+Line 2621 
 Schoenebeck'>
                              <t>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;</t>
                          </list>
                      </t>
-                     <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
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 2376 
 Schoenebeck'>
+Line 2640 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Current number of active disk streams">
+                 <section title="Current number of active disk streams" anchor="GET CHANNEL STREAM_COUNT">
                      <t>The front-end can ask for the current number of active disk streams
                      on a sampler channel by sending the following command:</t>
                      <t>
-Line 2384 
 Schoenebeck'>
+Line 2648 
 Schoenebeck'>
                              <t>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;</t>
                          </list>
                      </t>
-                     <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
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 2403 
 Schoenebeck'>
+Line 2669 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Current fill state of disk stream buffers">
+                 <section title="Current fill state of disk stream buffers" anchor="GET CHANNEL BUFFER_FILL">
                      <t>The front-end can ask for the current fill state of all disk streams
                      on a sampler channel by sending the following command:</t>
                      <t>
-Line 2418 
 Schoenebeck'>
+Line 2684 
 Schoenebeck'>
                          </list>
                      </t>
                      <t>to get the fill state in percent, where &lt;sampler-channel&gt; is the
-                     sampler channel number the front-end is interested in.</t>
+                     sampler channel number the front-end is interested in
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 2454 
 Schoenebeck'>
+Line 2722 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Setting audio output device">
+                 <section title="Setting audio output device" anchor="SET CHANNEL AUDIO_OUTPUT_DEVICE">
                      <t>The front-end can set the audio output device on a specific sampler
                      channel by sending the following command:</t>
                      <t>
-Line 2462 
 Schoenebeck'>
+Line 2730 
 Schoenebeck'>
                              <t>SET CHANNEL AUDIO_OUTPUT_DEVICE &lt;sampler-channel&gt; &lt;audio-device-id&gt;</t>
                          </list>
                      </t>
-                     <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
-                     device and &lt;sampler-channel&gt; is the respective sampler channel
+                     number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
-                     number.</t>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
+                     &lt;audio-device-id&gt; is the numerical ID of the audio output device as given by the
+                     <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
+                     or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
+                     command.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 2496 
 Schoenebeck'>
+Line 2768 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Setting audio output type">
+                 <section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYPE">
                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>
                      <t>The front-end can alter the audio output type on a specific sampler
-Line 2539 
 Schoenebeck'>
+Line 2811 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Setting audio output channel">
+                 <section title="Setting audio output channel" anchor="SET CHANNEL AUDIO_OUTPUT_CHANNEL">
                      <t>The front-end can alter the audio output channel on a specific
                      sampler channel by sending the following command:</t>
                      <t>
-Line 2547 
 Schoenebeck'>
+Line 2819 
 Schoenebeck'>
                              <t>SET CHANNEL AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;audio-out&gt; &lt;audio-in&gt;</t>
                          </list>
                      </t>
-                     <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
-                     sampler channel's audio output channel which should be
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
-                     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
+                     numerical ID of the sampler channel's audio output channel which should be
+                     rerouted and &lt;audio-in&gt; is the numerical ID of the audio channel of the selected audio
                      output device where &lt;audio-out&gt; should be routed to.</t>
                      <t>Possible Answers:</t>
-Line 2582 
 Schoenebeck'>
+Line 2856 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Setting MIDI input device">
+                 <section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE">
                      <t>The front-end can set the MIDI input device on a specific sampler
                      channel by sending the following command:</t>
                      <t>
-Line 2590 
 Schoenebeck'>
+Line 2864 
 Schoenebeck'>
                              <t>SET CHANNEL MIDI_INPUT_DEVICE &lt;sampler-channel&gt; &lt;midi-device-id&gt;</t>
                          </list>
                      </t>
-                     <t></t>
+                     <t>Where &lt;sampler-channel&gt; is the sampler channel number
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command
+                     and &lt;midi-device-id&gt; is  the numerical ID of the MIDI input device as returned by the
+                     <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
+                     or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 2622 
 Schoenebeck'>
+Line 2901 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Setting MIDI input type">
+                 <section title="Setting MIDI input type" anchor="SET CHANNEL MIDI_INPUT_TYPE">
                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>
                      <t>The front-end can alter the MIDI input type on a specific sampler
-Line 2665 
 Schoenebeck'>
+Line 2944 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Setting MIDI input port">
+                 <section title="Setting MIDI input port" anchor="SET CHANNEL MIDI_INPUT_PORT">
-                     <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
                      channel by sending the following command:</t>
                      <t>
                          <list>
-Line 2694 
 Schoenebeck'>
+Line 2973 
 Schoenebeck'>
                              </t>
                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                  <list>
-                                     <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>
                                  </list>
                              </t>
                          </list>
-Line 2707 
 Schoenebeck'>
+Line 2986 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Setting MIDI input channel">
+                 <section title="Setting MIDI input channel" anchor="SET CHANNEL MIDI_INPUT_CHANNEL">
                      <t>The front-end can alter the MIDI channel a sampler channel should
                      listen to by sending the following command:</t>
                      <t>
-Line 2715 
 Schoenebeck'>
+Line 2994 
 Schoenebeck'>
                              <t>SET CHANNEL MIDI_INPUT_CHANNEL &lt;sampler-channel&gt; &lt;midi-input-chan&gt;</t>
                          </list>
                      </t>
-                     <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
                      &lt;sampler-channel&gt; should listen to or "ALL" to listen on all 16 MIDI
                      channels.</t>
-Line 2749 
 Schoenebeck'>
+Line 3028 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Setting channel volume">
+                 <section title="Setting channel volume" anchor="SET CHANNEL VOLUME">
                      <t>The front-end can alter the volume of a sampler channel by sending
                      the following command:</t>
                      <t>
-Line 2792 
 Schoenebeck'>
+Line 3071 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Resetting a sampler channel">
+                 <section title="Muting a sampler channel" anchor="SET CHANNEL MUTE">
+                     <t>The front-end can mute/unmute a specific sampler
+                     channel by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>SET CHANNEL MUTE &lt;sampler-channel&gt; &lt;mute&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;sampler-channel&gt; is the respective sampler channel
+                     number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
+                     &lt;mute&gt; should be replaced either by "1" to mute the channel or "0"
+                     to unmute the channel.</t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>on success</t>
+                                 </list>
+                             </t>
+                             <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
+                                 <list>
+                                     <t>if the channel was muted/unmuted, but there are noteworthy
+                                     issue(s) related, providing an appropriate warning code and
+                                     warning message</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>in case it failed, providing an appropriate error code and error message</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Examples:</t>
+                     <t>
+                         <list>
+                             <t></t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Soloing a sampler channel" anchor="SET CHANNEL SOLO">
+                     <t>The front-end can solo/unsolo a specific sampler channel
+                     by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>SET CHANNEL SOLO &lt;sampler-channel&gt; &lt;solo&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;sampler-channel&gt; is the respective sampler channel
+                     number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
+                     &lt;solo&gt; should be replaced either by "1" to solo the channel or "0"
+                     to unsolo the channel.</t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>on success</t>
+                                 </list>
+                             </t>
+                             <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
+                                 <list>
+                                     <t>if the channel was soloed/unsoloed, but there are noteworthy
+                                     issue(s) related, providing an appropriate warning code and
+                                     warning message</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>in case it failed, providing an appropriate error code and error message</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Examples:</t>
+                     <t>
+                         <list>
+                             <t></t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Assigning a MIDI instrument map to a sampler channel" anchor="SET CHANNEL MIDI_INSTRUMENT_MAP">
+                     <t>The front-end can assign a MIDI instrument map to a specific sampler channel
+                     by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>SET CHANNEL MIDI_INSTRUMENT_MAP &lt;sampler-channel&gt; &lt;map&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;sampler-channel&gt; is the respective sampler channel
+                     number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
+                     &lt;map&gt; can have the following possibilites:</t>
+                     <t>
+                         <list>
+                             <t>"NONE" -
+                                 <list>
+                                     <t>This is the default setting. In this case
+                                     the sampler channel is not assigned any MIDI
+                                     instrument map and thus will ignore all MIDI
+                                     program change messages.</t>
+                                 </list>
+                             </t>
+                             <t>"DEFAULT" -
+                                 <list>
+                                     <t>The sampler channel will always use the
+                                     default MIDI instrument map to handle MIDI
+                                     program change messages.</t>
+                                 </list>
+                             </t>
+                             <t>numeric ID -
+                                 <list>
+                                     <t>You can assign a specific MIDI instrument map
+                                     by replacing &lt;map&gt; with the respective numeric
+                                     ID of the MIDI instrument map as returned by the
+                                     <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
+                                     command. Once that map will be deleted, the sampler
+                                     channel would fall back to "NONE".</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Read chapter <xref target="MIDI Instrument Mapping">"MIDI Instrument Mapping"</xref>
+                     for details regarding MIDI instrument mapping.</t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>on success</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>in case it failed, providing an appropriate error code and error message</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Examples:</t>
+                     <t>
+                         <list>
+                             <t></t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Adding an effect send to a sampler channel" anchor="CREATE FX_SEND">
+                     <t>The front-end can create an additional effect send on a specific sampler channel
+                     by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>CREATE FX_SEND &lt;sampler-channel&gt; &lt;midi-ctrl&gt; [&lt;name&gt;]</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;sampler-channel&gt; is the respective sampler channel
+                     number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the
+                     sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
+                     is a number between 0..127 defining the MIDI controller which can alter the
+                     effect send level and &lt;name&gt; is an optional argument defining a name
+                     for the effect send entity. The name does not have to be unique.</t>
+                     <t>By default, that is as initial routing, the effect send's audio channels
+                     are automatically routed to the last audio channels of the sampler channel's
+                     audio output device, that way you can i.e. first increase the amount of audio
+                     channels on the audio output device for having dedicated effect send output
+                     channels and when "CREATE FX_SEND" is called, those channels will automatically
+                     be picked. You can alter the destination channels however with
+                     <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>.
+                     </t>
+                     <t>Note: Create effect sends on a sampler channel only when needed, because having effect
+                     sends on a sampler channel will decrease runtime performance, because for implementing channel
+                     effect sends, separate (sampler channel local) audio buffers are needed to render and mix
+                     the voices and route the audio signal afterwards to the master outputs and effect send
+                     outputs (along with their respective effect send levels). A sampler channel without effect
+                     sends however can mix its voices directly into the audio output devices's audio buffers
+                     and is thus faster.
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK[&lt;fx-send-id&gt;]" -
+                                 <list>
+                                     <t>in case a new effect send could be added to the
+                                     sampler channel, where &lt;fx-send-id&gt; reflects the
+                                     unique ID of the newly created effect send entity</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>when a new effect send could not be added, i.e.
+                                     due to invalid parameters</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Examples:</t>
+                     <t>
+                         <list>
+                             <t>C: "CREATE FX_SEND 0 91 'Reverb Send'"</t>
+                             <t>S: "OK[0]"</t>
+                         </list>
+                     </t>
+                     <t>
+                         <list>
+                             <t>C: "CREATE FX_SEND 0 93"</t>
+                             <t>S: "OK[1]"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Removing an effect send from a sampler channel" anchor="DESTROY FX_SEND">
+                     <t>The front-end can remove an existing effect send on a specific sampler channel
+                     by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>DESTROY FX_SEND &lt;sampler-channel&gt; &lt;fx-send-id&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;sampler-channel&gt; is the respective sampler channel
+                     number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the
+                     sampler channel from which the effect send should be removed from and
+                     &lt;fx-send-id&gt; is the respective effect send number as returned by the
+                     <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
+                     or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>on success</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>in case it failed, providing an appropriate error code and
+                                     error message</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "DESTROY FX_SEND 0 0"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Getting amount of effect sends on a sampler channel" anchor="GET FX_SENDS">
+                     <t>The front-end can ask for the amount of effect sends on a specific sampler channel
+                     by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>GET FX_SENDS &lt;sampler-channel&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;sampler-channel&gt; is the respective sampler channel
+                     number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>The sampler will answer by returning the number of effect
+                             sends on the given sampler channel.</t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "GET FX_SENDS 0"</t>
+                             <t>S: "2"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Listing all effect sends on a sampler channel" anchor="LIST FX_SENDS">
+                     <t>The front-end can ask for a list of effect sends on a specific sampler channel
+                     by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>LIST FX_SENDS &lt;sampler-channel&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;sampler-channel&gt; is the respective sampler channel
+                     number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>The sampler will answer by returning a comma separated list
+                             with all effect sends' numerical IDs on the given sampler
+                             channel.</t>
+                         </list>
+                     </t>
+                     <t>Examples:</t>
+                     <t>
+                         <list>
+                             <t>C: "LIST FX_SENDS 0"</t>
+                             <t>S: "0,1"</t>
+                         </list>
+                     </t>
+                     <t>
+                         <list>
+                             <t>C: "LIST FX_SENDS 1"</t>
+                             <t>S: ""</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Getting effect send information" anchor="GET FX_SEND INFO">
+                     <t>The front-end can ask for the current settings of an effect send entity
+                     by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>GET FX_SEND INFO &lt;sampler-channel&gt; &lt;fx-send-id&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;sampler-channel&gt; is the sampler channel number
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
+                     &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
+                     as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
+                     or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.
+                    </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>The sampler will answer by sending a &lt;CRLF&gt; separated list.
+                             Each answer line begins with the settings category name
+                             followed by a colon and then a space character &lt;SP&gt; and finally
+                             the info character string to that setting category. At the
+                             moment the following categories are defined:</t>
+                             <t>
+                                 <list>
+                                     <t>NAME -
+                                         <list>
+                                             <t>name of the effect send entity</t>
+                                         </list>
+                                     </t>
+                                     <t>MIDI_CONTROLLER -
+                                         <list>
+                                             <t>a value between 0 and 127 reflecting the MIDI controller
+                                             which is able to modify the effect send's send level</t>
+                                         </list>
+                                     </t>
+                                     <t>LEVEL -
+                                         <list>
+                                             <t>optionally dotted number reflecting the effect send's
+                                             current send level (where a value &lt; 1.0 means attenuation
+                                             and a value > 1.0 means amplification)</t>
+                                         </list>
+                                     </t>
+                                     <t>AUDIO_OUTPUT_ROUTING -
+                                         <list>
+                                             <t>comma separated list which reflects to which audio
+                                             channel of the selected audio output device each
+                                             effect send output channel is routed to, e.g. "0,3" would
+                                             mean the effect send's output channel 0 is routed to channel
+of the audio output device and the effect send's output
+                                             channel 1 is routed to the channel 3 of the audio
+                                             output device (see
+                                             <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>
+                                             for details)</t>
+                                         </list>
+                                     </t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>The mentioned fields above don't have to be in particular order.</t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "GET FX_SEND INFO 0 0"</t>
+                             <t>S: "NAME: Reverb Send"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"."</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Changing effect send's name" anchor="SET FX_SEND NAME">
+                     <t>The front-end can alter the current name of an effect
+                     send entity by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;sampler-chan&gt; is the sampler channel number
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
+                     &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
+                     as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
+                     or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
+                     &lt;name&gt; is the new name of the effect send entity, which
+                     does not have to be unique.</t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>on success</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>in case it failed, providing an appropriate error code and error message</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL">
+                     <t>The front-end can alter the destination of an effect send's audio channel on a specific
+                     sampler channel by sending the following command:</t>
+                     <t>
+                         <list>
+                             <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>
+                         </list>
+                     </t>
+                     <t>Where &lt;sampler-chan&gt; is the sampler channel number
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
+                     &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
+                     as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
+                     or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command,
+                     &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
+                     which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
+                     the audio channel of the selected audio output device where &lt;audio-src&gt;
+                     should be routed to.</t>
+                     <t>Note that effect sends can only route audio to the same audio output
+                     device as assigned to the effect send's sampler channel. Also note that an
+                     effect send entity does always have exactly as much audio channels as its
+                     sampler channel. So if the sampler channel is stereo, the effect send does
+                     have two audio channels as well. Also keep in mind that the amount of audio
+                     channels on a sampler channel might be dependant not only to the deployed
+                     sampler engine on the sampler channel, but also dependant to the instrument
+                     currently loaded. However you can (effectively) turn an i.e. stereo effect
+                     send into a mono one by simply altering its audio routing appropriately.</t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>on success</t>
+                                 </list>
+                             </t>
+                             <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
+                                 <list>
+                                     <t>if audio output channel was set, but there are noteworthy
+                                     issue(s) related, providing an appropriate warning code and
+                                     warning message</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>in case it failed, providing an appropriate error code and error message</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER">
+                     <t>The front-end can alter the MIDI controller of an effect
+                     send entity by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;sampler-chan&gt; is the sampler channel number
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
+                     &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
+                     as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
+                     or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
+                     &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
+                     able to modify the effect send's send level.</t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>on success</t>
+                                 </list>
+                             </t>
+                             <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
+                                 <list>
+                                     <t>if MIDI controller was set, but there are noteworthy
+                                     issue(s) related, providing an appropriate warning code and
+                                     warning message</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>in case it failed, providing an appropriate error code and error message</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL">
+                     <t>The front-end can alter the current send level of an effect
+                     send entity by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;sampler-chan&gt; is the sampler channel number
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
+                     &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
+                     as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
+                     or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
+                     &lt;volume&gt; is an optionally dotted positive number (a value
+                     smaller than 1.0 means attenuation, whereas a value greater than
+.0 means amplification) reflecting the new send level.</t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>on success</t>
+                                 </list>
+                             </t>
+                             <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
+                                 <list>
+                                     <t>if new send level was set, but there are noteworthy
+                                     issue(s) related, providing an appropriate warning code and
+                                     warning message</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>in case it failed, providing an appropriate error code and error message</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "SET FX_SEND LEVEL 0 0 0.15"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Resetting a sampler channel" anchor="RESET CHANNEL">
                      <t>The front-end can reset a particular sampler channel by sending the following command:</t>
                      <t>
                          <list>
-Line 2840 
 Schoenebeck'>
+Line 3725 
 Schoenebeck'>
              <section title="Controlling connection">
                  <t>The following commands are used to control the connection to LinuxSampler.</t>
-                 <section title="Register front-end for receiving event messages">
+                 <section title="Register front-end for receiving event messages" anchor="SUBSCRIBE">
                      <t>The front-end can register itself to the LinuxSampler application to
                      be informed about noteworthy events by sending this command:</t>
                      <t>
-Line 2882 
 Schoenebeck'>
+Line 3767 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Unregister front-end for not receiving event messages">
+                 <section title="Unregister front-end for not receiving event messages" anchor="UNSUBSCRIBE">
                      <t>The front-end can unregister itself if it doesn't want to receive event
                      messages anymore by sending the following command:</t>
                      <t>
-Line 2924 
 Schoenebeck'>
+Line 3809 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Enable or disable echo of commands">
+                 <section title="Enable or disable echo of commands" anchor="SET ECHO">
                      <t>To enable or disable back sending of commands to the client the following command can be used:</t>
                      <t>
                          <list>
-Line 2962 
 Schoenebeck'>
+Line 3847 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Close client connection">
+                 <section title="Close client connection" anchor="QUIT">
                      <t>The client can close its network connection to LinuxSampler by sending the following command:</t>
                      <t>
                          <list>
-Line 2977 
 Schoenebeck'>
+Line 3862 
 Schoenebeck'>
              <section title="Global commands">
                  <t>The following commands have global impact on the sampler.</t>
-                 <section title="Reset sampler">
+                 <section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT">
+                     <t>The front-end can ask for the current number of active voices on
+                     the sampler by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>GET TOTAL_VOICE_COUNT</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>LinuxSampler will answer by returning the number of all active
+                             voices on the sampler.</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX">
+                     <t>The front-end can ask for the maximum number of active voices
+                     by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>GET TOTAL_VOICE_COUNT_MAX</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>LinuxSampler will answer by returning the maximum number
+                             of active voices.</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Reset sampler" anchor="RESET">
                      <t>The front-end can reset the whole sampler by sending the following command:</t>
                      <t>
                          <list>
-Line 3002 
 Schoenebeck'>
+Line 3923 
 Schoenebeck'>
                          </list>
                      </t>
                  </section>
+                 <section title="General sampler informations" anchor="GET SERVER INFO">
+                     <t>The client can ask for general informations about the LinuxSampler
+                        instance by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>GET SERVER INFO</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
+                                Each answer line begins with the information category name
+                                followed by a colon and then a space character &lt;SP&gt; and finally
+                                the info character string to that information category. At the
+                                moment the following categories are defined:
+                             </t>
+                             <t>
+                                 <list>
+                                     <t>DESCRIPTION -
+                                         <list>
+                                             <t>arbitrary textual description about the sampler</t>
+                                         </list>
+                                     </t>
+                                     <t>VERSION -
+                                         <list>
+                                             <t>version of the sampler</t>
+                                         </list>
+                                     </t>
+                                     <t>PROTOCOL_VERSION -
+                                         <list>
+                                             <t>version of the LSCP specification the sampler
+                                             complies with (see <xref target="LSCP versioning" /> for details)</t>
+                                         </list>
+                                     </t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>The mentioned fields above don't have to be in particular order.
+                     Other fields might be added in future.</t>
+                 </section>
+                 <section title="Getting global volume attenuation" anchor="GET VOLUME">
+                     <t>The client can ask for the current global sampler-wide volume
+                     attenuation by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>GET VOLUME</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>The sampler will always answer by returning the optional
+                             dotted floating point coefficient, reflecting the current
+                             global volume attenuation.
+                             </t>
+                         </list>
+                     </t>
+                     <t>Note: it is up to the respective sampler engine whether to obey
+                     that global volume parameter or not, but in general all engines SHOULD
+                     use this parameter.</t>
+                 </section>
+                 <section title="Setting global volume attenuation" anchor="SET VOLUME">
+                     <t>The client can alter the current global sampler-wide volume
+                     attenuation by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>SET VOLUME &lt;volume&gt;</t>
+                         </list>
+                     </t>
+                    <t>Where &lt;volume&gt; should be replaced by the optional dotted
+                    floating point value, reflecting the new global volume parameter.
+                    This value might usually be in the range between 0.0 and 1.0, that
+                    is for attenuating the overall volume.</t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>on success</t>
+                                 </list>
+                             </t>
+                             <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
+                                 <list>
+                                     <t>if the global volume was set, but there are noteworthy
+                                     issue(s) related, providing an appropriate warning code and
+                                     warning message</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>in case it failed, providing an appropriate error code and error message</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                 </section>
+             </section>
+             <section title="MIDI Instrument Mapping" anchor="MIDI Instrument Mapping">
+                 <t>The MIDI protocol provides a way to switch between instruments
+                 by sending so called MIDI bank select and MIDI program change
+                 messages which are essentially just numbers. The following commands
+                 allow to actually map arbitrary MIDI bank select / program change
+                 numbers with real instruments.</t>
+                 <t>The sampler allows to manage an arbitrary amount of MIDI
+                 instrument maps which define which instrument to load on
+                 which MIDI program change message.</t>
+                 <t>By default, that is when the sampler is launched, there is no
+                 map, thus the sampler will simply ignore all program change
+                 messages. The front-end has to explicitly create at least one
+                 map, add entries to the map and tell the respective sampler
+                 channel(s) which MIDI instrument map to use, so the sampler
+                 knows how to react on a given program change message on the
+                 respective sampler channel, that is by switching to the
+                 respectively defined engine type and loading the respective
+                 instrument. See command
+                 <xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref>
+                 for how to assign a MIDI instrument map to a sampler channel.</t>
+                 <t>Also note per MIDI specification a bank select message does not
+                 cause to switch to another instrument. Instead when receiving a
+                 bank select message the bank value will be stored and a subsequent
+                 program change message (which may occur at any time) will finally
+                 cause the sampler to switch to the respective instrument as
+                 reflected by the current MIDI instrument map.</t>
+                 <section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT MAP">
+                     <t>The front-end can add a new MIDI instrument map by sending
+                     the following command:</t>
+                     <t>
+                         <list>
+                             <t>ADD MIDI_INSTRUMENT_MAP [&lt;name&gt;]</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;name&gt; is an optional argument allowing to
+                     assign a custom name to the new map. MIDI instrument Map
+                     names do not have to be unique.</t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK[&lt;map&gt;]" -
+                                 <list>
+                                     <t>in case a new MIDI instrument map could
+                                     be added, where &lt;map&gt; reflects the
+                                     unique ID of the newly created MIDI
+                                     instrument map</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>when a new map could not be created, which
+                                     might never occur in practice</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Examples:</t>
+                     <t>
+                         <list>
+                             <t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"</t>
+                             <t>S: "OK[0]"</t>
+                         </list>
+                     </t>
+                     <t>
+                         <list>
+                             <t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"</t>
+                             <t>S: "OK[1]"</t>
+                         </list>
+                     </t>
+                     <t>
+                         <list>
+                             <t>C: "ADD MIDI_INSTRUMENT_MAP"</t>
+                             <t>S: "OK[5]"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Delete one particular or all MIDI instrument maps" anchor="REMOVE MIDI_INSTRUMENT_MAP">
+                     <t>The front-end can delete a particular MIDI instrument map
+                     by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>REMOVE MIDI_INSTRUMENT_MAP &lt;map&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;map&gt; reflects the unique ID of the map to delete
+                     as returned by the <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
+                     command.</t>
+                     <t>The front-end can delete all MIDI instrument maps by
+                     sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>REMOVE MIDI_INSTRUMENT_MAP ALL</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>in case the map(s) could be deleted</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>when the given map does not exist</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Examples:</t>
+                     <t>
+                         <list>
+                             <t>C: "REMOVE MIDI_INSTRUMENT_MAP 0"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                     <t>
+                         <list>
+                             <t>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Get amount of existing MIDI instrument maps" anchor="GET MIDI_INSTRUMENT_MAPS">
+                     <t>The front-end can retrieve the current amount of MIDI
+                     instrument maps by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>GET MIDI_INSTRUMENT_MAPS</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>The sampler will answer by returning the current
+                             number of MIDI instrument maps.</t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "GET MIDI_INSTRUMENT_MAPS"</t>
+                             <t>S: "2"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Getting all created MIDI instrument maps" anchor="LIST MIDI_INSTRUMENT_MAPS">
+                     <t>The number of MIDI instrument maps can change on runtime. To get the
+                     current list of MIDI instrument maps, the front-end can send the
+                     following command:</t>
+                     <t>
+                         <list>
+                             <t>LIST MIDI_INSTRUMENT_MAPS</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>The sampler will answer by returning a comma separated list
+                             with all MIDI instrument maps' numerical IDs.</t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "LIST MIDI_INSTRUMENT_MAPS"</t>
+                             <t>S: "0,1,5,12"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Getting MIDI instrument map information" anchor="GET MIDI_INSTRUMENT_MAP INFO">
+                     <t>The front-end can ask for the current settings of a MIDI
+                     instrument map by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>GET MIDI_INSTRUMENT_MAP INFO &lt;map&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;map&gt; is the numerical ID of the map the
+                     front-end is interested in as returned by the
+                     <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
+                     command.</t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
+                             Each answer line begins with the settings category name
+                             followed by a colon and then a space character &lt;SP&gt; and finally
+                             the info character string to that setting category. At the
+                             moment the following categories are defined:</t>
+                             <t>
+                                 <list>
+                                     <t>NAME -
+                                         <list>
+                                             <t>custom name of the given map,
+                                             which does not have to be unique</t>
+                                         </list>
+                                     </t>
+                                     <t>DEFAULT -
+                                         <list>
+                                             <t>either true or false,
+                                             defines whether this map is the default map</t>
+                                         </list>
+                                     </t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>The mentioned fields above don't have to be in particular order.</t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t>
+                             <t>S: "NAME: Standard Map"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"."</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Renaming a MIDI instrument map" anchor="SET MIDI_INSTRUMENT_MAP NAME">
+                     <t>The front-end can alter the custom name of a MIDI
+                     instrument map by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>SET MIDI_INSTRUMENT_MAP NAME &lt;map&gt; &lt;name&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;map&gt; is the numerical ID of the map and
+                     &lt;name&gt; the new custom name of the map, which does not
+                     have to be unique.</t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>on success</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>in case the given map does not exist</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT">
+                     <t>The front-end can create a new or replace an existing entry
+                     in a sampler's MIDI instrument map by sending the following
+                     command:</t>
+                     <t>
+                         <list>
+                             <t>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
+                             &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
+                             &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
+                             [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;map&gt; is the numeric ID of the map to alter,
+                     &lt;midi_bank&gt; is an integer value between
+..16383 reflecting the MIDI bank select index,
+                     &lt;midi_prog&gt; an
+                     integer value between 0..127 reflecting the MIDI program change
+                     index, &lt;engine_name&gt; a sampler engine name as returned by
+                     the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>
+                     command (not encapsulated into apostrophes), &lt;filename&gt; the name
+                     of the instrument's file to be deployed (encapsulated into apostrophes),
+                     &lt;instrument_index&gt; the index (integer value) of the instrument
+                     within the given file, &lt;volume_value&gt; reflects the master
+                     volume of the instrument as optionally dotted number (where a
+                     value &lt; 1.0 means attenuation and a value > 1.0 means
+                     amplification). This parameter easily allows to adjust the
+                     volume of all intruments within a custom instrument map
+                     without having to adjust their instrument files. The
+                     OPTIONAL &lt;instr_load_mode&gt; argument defines the life
+                     time of the instrument, that is when the instrument should
+                     be loaded, when freed and has exactly the following
+                     possibilities:</t>
+                     <t>
+                         <list>
+                             <t>"ON_DEMAND" -
+                                 <list>
+                                     <t>The instrument will be loaded when needed,
+                                     that is when demanded by at least one sampler
+                                     channel. It will immediately be freed from memory
+                                     when not needed by any sampler channel anymore.</t>
+                                 </list>
+                             </t>
+                             <t>"ON_DEMAND_HOLD" -
+                                 <list>
+                                     <t>The instrument will be loaded when needed,
+                                     that is when demanded by at least one sampler
+                                     channel. It will be kept in memory even when
+                                     not needed by any sampler channel anymore.
+                                     Instruments with this mode are only freed
+                                     when the sampler is reset or all mapping
+                                     entries with this mode (and respective
+                                     instrument) are explicitly changed to
+                                     "ON_DEMAND" and no sampler channel is using
+                                     the instrument anymore.</t>
+                                 </list>
+                             </t>
+                             <t>"PERSISTENT" -
+                                 <list>
+                                     <t>The instrument will immediately be loaded
+                                     into memory when this mapping
+                                     command is sent and the instrument is kept all
+                                     the time. Instruments with this mode are
+                                     only freed when the sampler is reset or all
+                                     mapping entries with this mode (and
+                                     respective instrument) are explicitly
+                                     changed to "ON_DEMAND" and no sampler
+                                     channel is using the instrument anymore.</t>
+                                 </list>
+                             </t>
+                             <t>not supplied -
+                                 <list>
+                                     <t>In case there is no &lt;instr_load_mode&gt;
+                                     argument given, it will be up to the
+                                     InstrumentManager to decide which mode to use.
+                                     Usually it will use "ON_DEMAND" if an entry
+                                     for the given instrument does not exist in
+                                     the InstrumentManager's list yet, otherwise
+                                     if an entry already exists, it will simply
+                                     stick with the mode currently reflected by
+                                     the already existing entry, that is it will
+                                     not change the mode.</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>
+                     The &lt;instr_load_mode&gt; argument thus allows to define an
+                     appropriate strategy (low memory consumption vs. fast
+                     instrument switching) for each instrument individually. Note, the
+                     following restrictions apply to this argument: "ON_DEMAND_HOLD" and
+                     "PERSISTENT" have to be supported by the respective sampler engine
+                     (which is technically the case when the engine provides an
+                     InstrumentManager for its format). If this is not the case the
+                     argument will automatically fall back to the default value
+                     "ON_DEMAND". Also the load mode of one instrument may
+                     automatically change the laod mode of other instrument(s), i.e.
+                     because the instruments are part of the same file and the
+                     engine does not allow a way to manage load modes for them
+                     individually. Due to this, in case the frontend shows the
+                     load modes of entries, the frontend should retrieve the actual
+                     mode by i.e. sending
+                     <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
+                     command(s). Finally the OPTIONAL &lt;name&gt; argument allows to
+                     set a custom name (encapsulated into apostrophes) for the mapping
+                     entry, useful for frontends for displaying an appropriate name for
+                     mapped instruments (using
+                     <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
+                     </t>
+                     <t>
+                     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
+                     completely established in the sampler. The OPTIONAL "NON_MODAL" argument
+                     however causes the respective "MAP MIDI_INSTRUMENT" command to return
+                     immediately, that is to let the sampler establish the mapping in the
+                     background. So this argument might be especially useful for mappings with
+                     a "PERSISTENT" type, because these have to load the respective instruments
+                     immediately and might thus block for a very long time. It is recommended
+                     however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
+                     because it has the following drawbacks: as "NON_MODAL" instructions return
+                     immediately, they may not necessarily return an error i.e. when the given
+                     instrument file turns out to be corrupt, beside that subsequent commands
+                     in a LSCP instruction sequence might fail, because mandatory mappings are
+                     not yet completed.
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>usually</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>when the given map or engine does not exist or a value
+                                     is out of range</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Examples:</t>
+                     <t>
+                         <list>
+                             <t>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                     <t>
+                         <list>
+                             <t>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                     <t>
+                         <list>
+                             <t>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"</t>
+                             <t>S: "OK"</t>
+                             <t>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                     <t>
+                         <list>
+                             <t>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Getting ammount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS">
+                     <t>The front-end can query the amount of currently existing
+                     entries in a MIDI instrument map by sending the following
+                     command:</t>
+                     <t>
+                         <list>
+                             <t>GET MIDI_INSTRUMENTS &lt;map&gt;</t>
+                         </list>
+                     </t>
+                     <t>The front-end can query the amount of currently existing
+                     entries in all MIDI instrument maps by sending the following
+                     command:</t>
+                     <t>
+                         <list>
+                             <t>GET MIDI_INSTRUMENTS ALL</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>The sampler will answer by sending the current number of
+                             entries in the MIDI instrument map(s).</t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "GET MIDI_INSTRUMENTS 0"</t>
+                             <t>S: "234"</t>
+                         </list>
+                     </t>
+                     <t>
+                         <list>
+                             <t>C: "GET MIDI_INSTRUMENTS ALL"</t>
+                             <t>S: "954"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Getting indeces of all entries of a MIDI instrument map" anchor="LIST MIDI_INSTRUMENTS">
+                     <t>The front-end can query a list of all currently existing
+                     entries in a certain MIDI instrument map by sending the following
+                     command:</t>
+                     <t>
+                         <list>
+                             <t>LIST MIDI_INSTRUMENTS &lt;map&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;map&gt; is the numeric ID of the MIDI instrument map.</t>
+                     <t>The front-end can query a list of all currently existing
+                     entries of all MIDI instrument maps by sending the following
+                     command:</t>
+                     <t>
+                         <list>
+                             <t>LIST MIDI_INSTRUMENTS ALL</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>The sampler will answer by sending a comma separated
+                             list of map ID - MIDI bank - MIDI program triples, where
+                             each triple is encapsulated into curly braces. The
+                             list is returned in one single line. Each triple
+                             just reflects the key of the respective map entry,
+                             thus subsequent
+                             <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
+                             command(s) are necessary to retrieve detailed informations
+                             about each entry.</t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "LIST MIDI_INSTRUMENTS 0"</t>
+                             <t>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT">
+                     <t>The front-end can delete an entry from a MIDI instrument
+                     map by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>UNMAP MIDI_INSTRUMENT &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;</t>
+                         </list>
+                     </t>
+                     <t>
+                     Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
+                     &lt;midi_bank&gt; is an integer value between 0..16383
+                     reflecting the MIDI bank value and
+                     &lt;midi_prog&gt; an integer value between
+..127 reflecting the MIDI program value of the map's entrie's key
+                     index triple.
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>usually</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>when index out of bounds</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "UNMAP MIDI_INSTRUMENT 0 2 127"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Get current settings of MIDI instrument map entry" anchor="GET MIDI_INSTRUMENT INFO">
+                     <t>The front-end can retrieve the current settings of a certain
+                     instrument map entry by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>GET MIDI_INSTRUMENT INFO &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;</t>
+                         </list>
+                     </t>
+                     <t>
+                     Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
+                     &lt;midi_bank&gt; is an integer value between 0..16383
+                     reflecting the MIDI bank value, &lt;midi_bank&gt;
+                     and &lt;midi_prog&gt; an integer value between
+..127 reflecting the MIDI program value of the map's entrie's key
+                     index triple.
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>LinuxSampler will answer by sending a &lt;CRLF&gt;
+                             separated list. Each answer line begins with the
+                             information category name followed by a colon and then
+                             a space character &lt;SP&gt; and finally the info
+                             character string to that info category. At the moment
+                             the following categories are defined:</t>
+                             <t>"NAME" -
+                                 <list>
+                                     <t>Name for this MIDI instrument map entry (if defined).
+                                     This name shall be used by frontends for displaying a
+                                     name for this mapped instrument. It can be set and
+                                     changed with the
+                                     <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref>
+                                     command and does not have to be unique.</t>
+                                 </list>
+                             </t>
+                             <t>"ENGINE_NAME" -
+                                 <list>
+                                     <t>Name of the engine to be deployed for this
+                                     instrument.</t>
+                                 </list>
+                             </t>
+                             <t>"INSTRUMENT_FILE" -
+                                 <list>
+                                     <t>File name of the instrument.</t>
+                                 </list>
+                             </t>
+                             <t>"INSTRUMENT_NR" -
+                                 <list>
+                                     <t>Index of the instrument within the file.</t>
+                                 </list>
+                             </t>
+                             <t>"INSTRUMENT_NAME" -
+                                 <list>
+                                     <t>Name of the loaded instrument as reflected by its file.
+                                     In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
+                                     cannot be changed.</t>
+                                 </list>
+                             </t>
+                             <t>"LOAD_MODE" -
+                                 <list>
+                                     <t>Life time of instrument
+                                     (see <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> for details about this setting).</t>
+                                 </list>
+                             </t>
+                             <t>"VOLUME" -
+                                 <list>
+                                     <t>master volume of the instrument as optionally
+                                     dotted number (where a value &lt; 1.0 means attenuation
+                                     and a value > 1.0 means amplification)</t>
+                                 </list>
+                             </t>
+                             <t>The mentioned fields above don't have to be in particular order.</t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "GET MIDI_INSTRUMENT INFO 1 45 120"</t>
+                             <t>S: "NAME: Drums for Foo Song"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Joe's Drumkit"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"LOAD_MODE: PERSISTENT"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"."</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS">
+                     <t>The front-end can clear a whole MIDI instrument map, that
+                     is delete all its entries by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>CLEAR MIDI_INSTRUMENTS &lt;map&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;map&gt; is the numeric ID of the map to clear.</t>
+                     <t>The front-end can clear all MIDI instrument maps, that
+                     is delete all entries of all maps by sending the following
+                     command:</t>
+                     <t>
+                         <list>
+                             <t>CLEAR MIDI_INSTRUMENTS ALL</t>
+                         </list>
+                     </t>
+                     <t>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the
+                     maps, only their entries, thus the map's settings like
+                     custom name will be preservevd.</t>
+                    <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>always</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Examples:</t>
+                     <t>
+                        <list>
+                             <t>C: "CLEAR MIDI_INSTRUMENTS 0"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                     <t>
+                        <list>
+                             <t>C: "CLEAR MIDI_INSTRUMENTS ALL"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                 </section>
              </section>
          </section>
-         <section title="Command Syntax">
-             <t>TODO: will soon automatically included from src/network/lscp.y,
+         <section title="Command Syntax" anchor="command_syntax">
-             meanwhile have a look at that file to get the exact definition of
+             <t>The grammar of the control protocol as descibed in <xref target="control_commands"/>
-             the command syntax.</t>
+             is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>)
+             where applicable.
+             </t>
+             <!--
+                 This section is automatically generated by scripts/update_grammar.pl
+                 from src/network/lscp.y (yacc input file). Do not modify this section
+                 manually !
+             -->
+             <!-- GRAMMAR_BNF_BEGIN - do NOT delete or modify this line !!! -->
+ <t>input =
+         <list>
+                 <t>line LF
+                 </t>
+                 <t>/ line CR LF
+                 </t>
+         </list>
+ </t>
+ <t>line =
+         <list>
+                 <t>/* epsilon (empty line ignored) */
+                 </t>
+                 <t>/ comment
+                 </t>
+                 <t>/ command
+                 </t>
+                 <t>/ error
+                 </t>
+         </list>
+ </t>
+ <t>comment =
+         <list>
+                 <t>'#'
+                 </t>
+                 <t>/ comment '#'
+                 </t>
+                 <t>/ comment SP
+                 </t>
+                 <t>/ comment number
+                 </t>
+                 <t>/ comment string
+                 </t>
+         </list>
+ </t>
+ <t>command =
+         <list>
+                 <t>ADD SP add_instruction
+                 </t>
+                 <t>/ MAP SP map_instruction
+                 </t>
+                 <t>/ UNMAP SP unmap_instruction
+                 </t>
+                 <t>/ GET SP get_instruction
+                 </t>
+                 <t>/ CREATE SP create_instruction
+                 </t>
+                 <t>/ DESTROY SP destroy_instruction
+                 </t>
+                 <t>/ LIST SP list_instruction
+                 </t>
+                 <t>/ LOAD SP load_instruction
+                 </t>
+                 <t>/ REMOVE SP remove_instruction
+                 </t>
+                 <t>/ SET SP set_instruction
+                 </t>
+                 <t>/ SUBSCRIBE SP subscribe_event
+                 </t>
+                 <t>/ UNSUBSCRIBE SP unsubscribe_event
+                 </t>
+                 <t>/ SELECT SP text
+                 </t>
+                 <t>/ RESET SP reset_instruction
+                 </t>
+                 <t>/ CLEAR SP clear_instruction
+                 </t>
+                 <t>/ RESET
+                 </t>
+                 <t>/ QUIT
+                 </t>
+         </list>
+ </t>
+ <t>add_instruction =
+         <list>
+                 <t>CHANNEL
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_MAP
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_MAP SP map_name
+                 </t>
+         </list>
+ </t>
+ <t>subscribe_event =
+         <list>
+                 <t>AUDIO_OUTPUT_DEVICE_COUNT
+                 </t>
+                 <t>/ AUDIO_OUTPUT_DEVICE_INFO
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE_COUNT
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE_INFO
+                 </t>
+                 <t>/ CHANNEL_COUNT
+                 </t>
+                 <t>/ VOICE_COUNT
+                 </t>
+                 <t>/ STREAM_COUNT
+                 </t>
+                 <t>/ BUFFER_FILL
+                 </t>
+                 <t>/ CHANNEL_INFO
+                 </t>
+                 <t>/ FX_SEND_COUNT
+                 </t>
+                 <t>/ FX_SEND_INFO
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_MAP_COUNT
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_MAP_INFO
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_COUNT
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_INFO
+                 </t>
+                 <t>/ MISCELLANEOUS
+                 </t>
+                 <t>/ TOTAL_VOICE_COUNT
+                 </t>
+                 <t>/ GLOBAL_INFO
+                 </t>
+         </list>
+ </t>
+ <t>unsubscribe_event =
+         <list>
+                 <t>AUDIO_OUTPUT_DEVICE_COUNT
+                 </t>
+                 <t>/ AUDIO_OUTPUT_DEVICE_INFO
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE_COUNT
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE_INFO
+                 </t>
+                 <t>/ CHANNEL_COUNT
+                 </t>
+                 <t>/ VOICE_COUNT
+                 </t>
+                 <t>/ STREAM_COUNT
+                 </t>
+                 <t>/ BUFFER_FILL
+                 </t>
+                 <t>/ CHANNEL_INFO
+                 </t>
+                 <t>/ FX_SEND_COUNT
+                 </t>
+                 <t>/ FX_SEND_INFO
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_MAP_COUNT
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_MAP_INFO
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_COUNT
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_INFO
+                 </t>
+                 <t>/ MISCELLANEOUS
+                 </t>
+                 <t>/ TOTAL_VOICE_COUNT
+                 </t>
+                 <t>/ GLOBAL_INFO
+                 </t>
+         </list>
+ </t>
+ <t>map_instruction =
+         <list>
+                 <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
+                 </t>
+                 <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
+                 </t>
+                 <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
+                 </t>
+                 <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
+                 </t>
+         </list>
+ </t>
+ <t>unmap_instruction =
+         <list>
+                 <t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
+                 </t>
+         </list>
+ </t>
+ <t>remove_instruction =
+         <list>
+                 <t>CHANNEL SP sampler_channel
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_MAP SP midi_map
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_MAP SP ALL
+                 </t>
+         </list>
+ </t>
+ <t>get_instruction =
+         <list>
+                 <t>AVAILABLE_ENGINES
+                 </t>
+                 <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
+                 </t>
+                 <t>/ MIDI_INPUT_DRIVER SP INFO SP string
+                 </t>
+                 <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
+                 </t>
+                 <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
+                 </t>
+                 <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
+                 </t>
+                 <t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string
+                 </t>
+                 <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
+                 </t>
+                 <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
+                 </t>
+                 <t>/ AUDIO_OUTPUT_DEVICES
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICES
+                 </t>
+                 <t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE SP INFO SP number
+                 </t>
+                 <t>/ MIDI_INPUT_PORT SP INFO SP number SP number
+                 </t>
+                 <t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
+                 </t>
+                 <t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
+                 </t>
+                 <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string
+                 </t>
+                 <t>/ CHANNELS
+                 </t>
+                 <t>/ CHANNEL SP INFO SP sampler_channel
+                 </t>
+                 <t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
+                 </t>
+                 <t>/ CHANNEL SP STREAM_COUNT SP sampler_channel
+                 </t>
+                 <t>/ CHANNEL SP VOICE_COUNT SP sampler_channel
+                 </t>
+                 <t>/ ENGINE SP INFO SP engine_name
+                 </t>
+                 <t>/ SERVER SP INFO
+                 </t>
+                 <t>/ TOTAL_VOICE_COUNT
+                 </t>
+                 <t>/ TOTAL_VOICE_COUNT_MAX
+                 </t>
+                 <t>/ MIDI_INSTRUMENTS SP midi_map
+                 </t>
+                 <t>/ MIDI_INSTRUMENTS SP ALL
+                 </t>
+                 <t>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_MAPS
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
+                 </t>
+                 <t>/ FX_SENDS SP sampler_channel
+                 </t>
+                 <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
+                 </t>
+                 <t>/ VOLUME
+                 </t>
+         </list>
+ </t>
+ <t>set_instruction =
+         <list>
+                 <t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
+                 </t>
+                 <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
+                 </t>
+                 <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
+                 </t>
+                 <t>/ CHANNEL SP set_chan_instruction
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
+                 </t>
+                 <t>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
+                 </t>
+                 <t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
+                 </t>
+                 <t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
+                 </t>
+                 <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
+                 </t>
+                 <t>/ ECHO SP boolean
+                 </t>
+                 <t>/ VOLUME SP volume_value
+                 </t>
+         </list>
+ </t>
+ <t>create_instruction =
+         <list>
+                 <t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list
+                 </t>
+                 <t>/ AUDIO_OUTPUT_DEVICE SP string
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE SP string SP key_val_list
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE SP string
+                 </t>
+                 <t>/ FX_SEND SP sampler_channel SP midi_ctrl
+                 </t>
+                 <t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
+                 </t>
+         </list>
+ </t>
+ <t>reset_instruction =
+         <list>
+                 <t>CHANNEL SP sampler_channel
+                 </t>
+         </list>
+ </t>
+ <t>clear_instruction =
+         <list>
+                 <t>MIDI_INSTRUMENTS SP midi_map
+                 </t>
+                 <t>/ MIDI_INSTRUMENTS SP ALL
+                 </t>
+         </list>
+ </t>
+ <t>destroy_instruction =
+         <list>
+                 <t>AUDIO_OUTPUT_DEVICE SP number
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE SP number
+                 </t>
+                 <t>/ FX_SEND SP sampler_channel SP fx_send_id
+                 </t>
+         </list>
+ </t>
+ <t>load_instruction =
+         <list>
+                 <t>INSTRUMENT SP load_instr_args
+                 </t>
+                 <t>/ ENGINE SP load_engine_args
+                 </t>
+         </list>
+ </t>
+ <t>set_chan_instruction =
+         <list>
+                 <t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
+                 </t>
+                 <t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index
+                 </t>
+                 <t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
+                 </t>
+                 <t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index
+                 </t>
+                 <t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
+                 </t>
+                 <t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index
+                 </t>
+                 <t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
+                 </t>
+                 <t>/ VOLUME SP sampler_channel SP volume_value
+                 </t>
+                 <t>/ MUTE SP sampler_channel SP boolean
+                 </t>
+                 <t>/ SOLO SP sampler_channel SP boolean
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
+                 </t>
+         </list>
+ </t>
+ <t>modal_arg =
+         <list>
+                 <t>/* epsilon (empty argument) */
+                 </t>
+                 <t>/ NON_MODAL SP
+                 </t>
+         </list>
+ </t>
+ <t>key_val_list =
+         <list>
+                 <t>string '=' param_val_list
+                 </t>
+                 <t>/ key_val_list SP string '=' param_val_list
+                 </t>
+         </list>
+ </t>
+ <t>buffer_size_type =
+         <list>
+                 <t>BYTES
+                 </t>
+                 <t>/ PERCENTAGE
+                 </t>
+         </list>
+ </t>
+ <t>list_instruction =
+         <list>
+                 <t>AUDIO_OUTPUT_DEVICES
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICES
+                 </t>
+                 <t>/ CHANNELS
+                 </t>
+                 <t>/ AVAILABLE_ENGINES
+                 </t>
+                 <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
+                 </t>
+                 <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
+                 </t>
+                 <t>/ MIDI_INSTRUMENTS SP midi_map
+                 </t>
+                 <t>/ MIDI_INSTRUMENTS SP ALL
+                 </t>
+                 <t>/ MIDI_INSTRUMENT_MAPS
+                 </t>
+                 <t>/ FX_SENDS SP sampler_channel
+                 </t>
+         </list>
+ </t>
+ <t>load_instr_args =
+         <list>
+                 <t>filename SP instrument_index SP sampler_channel
+                 </t>
+                 <t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel
+                 </t>
+         </list>
+ </t>
+ <t>load_engine_args =
+         <list>
+                 <t>engine_name SP sampler_channel
+                 </t>
+         </list>
+ </t>
+ <t>instr_load_mode =
+         <list>
+                 <t>ON_DEMAND
+                 </t>
+                 <t>/ ON_DEMAND_HOLD
+                 </t>
+                 <t>/ PERSISTENT
+                 </t>
+         </list>
+ </t>
+ <t>device_index =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>audio_channel_index =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>audio_output_type_name =
+         <list>
+                 <t>string
+                 </t>
+         </list>
+ </t>
+ <t>midi_input_port_index =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>midi_input_channel_index =
+         <list>
+                 <t>number
+                 </t>
+                 <t>/ ALL
+                 </t>
+         </list>
+ </t>
+ <t>midi_input_type_name =
+         <list>
+                 <t>string
+                 </t>
+         </list>
+ </t>
+ <t>midi_map =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>midi_bank =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>midi_prog =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>midi_ctrl =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>volume_value =
+         <list>
+                 <t>dotnum
+                 </t>
+                 <t>/ number
+                 </t>
+         </list>
+ </t>
+ <t>sampler_channel =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>instrument_index =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>fx_send_id =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>engine_name =
+         <list>
+                 <t>string
+                 </t>
+         </list>
+ </t>
+ <t>filename =
+         <list>
+                 <t>stringval
+                 </t>
+         </list>
+ </t>
+ <t>map_name =
+         <list>
+                 <t>stringval
+                 </t>
+         </list>
+ </t>
+ <t>entry_name =
+         <list>
+                 <t>stringval
+                 </t>
+         </list>
+ </t>
+ <t>fx_send_name =
+         <list>
+                 <t>stringval
+                 </t>
+         </list>
+ </t>
+ <t>param_val_list =
+         <list>
+                 <t>param_val
+                 </t>
+                 <t>/ param_val_list','param_val
+                 </t>
+         </list>
+ </t>
+ <t>param_val =
+         <list>
+                 <t>string
+                 </t>
+                 <t>/ stringval
+                 </t>
+                 <t>/ number
+                 </t>
+                 <t>/ dotnum
+                 </t>
+         </list>
+ </t>
+             <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
          </section>
-         <section title="Events">
+         <section title="Events" anchor="events">
              <t>This chapter will describe all currently defined events supported by LinuxSampler.</t>
-             <section title="Number of sampler channels changed">
+             <section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">
+                 <t>Client may want to be notified when the total number of audio output devices on the
+                 back-end changes by issuing the following command:</t>
+                 <t>
+                     <list>
+                         <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t>
+                     </list>
+                 </t>
+                 <t>Server will start sending the following notification messages:</t>
+                 <t>
+                     <list>
+                         <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
+                     </list>
+                 </t>
+                 <t>where &lt;devices&gt; will be replaced by the new number
+                 of audio output devices.</t>
+             </section>
+             <section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">
+                 <t>Client may want to be notified when changes were made to audio output devices on the
+                 back-end by issuing the following command:</t>
+                 <t>
+                     <list>
+                         <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t>
+                     </list>
+                 </t>
+                 <t>Server will start sending the following notification messages:</t>
+                 <t>
+                     <list>
+                         <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
+                     </list>
+                 </t>
+                 <t>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
+                 which settings has been changed. The front-end will have to send
+                 the respective command to actually get the audio output device info. Because these messages
+                 will be triggered by LSCP commands issued by other clients rather than real
+                 time events happening on the server, it is believed that an empty notification
+                 message is sufficient here.</t>
+             </section>
+             <section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">
+                 <t>Client may want to be notified when the total number of MIDI input devices on the
+                 back-end changes by issuing the following command:</t>
+                 <t>
+                     <list>
+                         <t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t>
+                     </list>
+                 </t>
+                 <t>Server will start sending the following notification messages:</t>
+                 <t>
+                     <list>
+                         <t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
+                     </list>
+                 </t>
+                 <t>where &lt;devices&gt; will be replaced by the new number
+                 of MIDI input devices.</t>
+             </section>
+             <section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO">
+                 <t>Client may want to be notified when changes were made to MIDI input devices on the
+                 back-end by issuing the following command:</t>
+                 <t>
+                     <list>
+                         <t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t>
+                     </list>
+                 </t>
+                 <t>Server will start sending the following notification messages:</t>
+                 <t>
+                     <list>
+                         <t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
+                     </list>
+                 </t>
+                 <t>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
+                 which settings has been changed. The front-end will have to send
+                 the respective command to actually get the MIDI input device info. Because these messages
+                 will be triggered by LSCP commands issued by other clients rather than real
+                 time events happening on the server, it is believed that an empty notification
+                 message is sufficient here.</t>
+             </section>
+             <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT">
                  <t>Client may want to be notified when the total number of channels on the
                  back-end changes by issuing the following command:</t>
                  <t>
                      <list>
-                         <t>SUBSCRIBE CHANNELS</t>
+                         <t>SUBSCRIBE CHANNEL_COUNT</t>
                      </list>
                  </t>
                  <t>Server will start sending the following notification messages:</t>
                  <t>
                      <list>
-                         <t>"NOTIFY:CHANNELS:&lt;channels&gt;"</t>
+                         <t>"NOTIFY:CHANNEL_COUNT:&lt;channels&gt;"</t>
                      </list>
                  </t>
                  <t>where &lt;channels&gt; will be replaced by the new number
                  of sampler channels.</t>
              </section>
-             <section title="Number of active voices changed">
+             <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">
                  <t>Client may want to be notified when the number of voices on the
                  back-end changes by issuing the following command:</t>
                  <t>
-Line 3043 
 Schoenebeck'>
+Line 5444 
 Schoenebeck'>
                  <t>Server will start sending the following notification messages:</t>
                  <t>
                      <list>
-                         <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices>&gt;</t>
+                         <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"</t>
                      </list>
                  </t>
                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
-                 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
                  active voices on that channel.</t>
              </section>
-             <section title="Number of active disk streams changed">
+             <section title="Number of active disk streams changed" anchor="SUBSCRIBE STREAM_COUNT">
                  <t>Client may want to be notified when the number of streams on the back-end
                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t>
                  <t>
-Line 3070 
 Schoenebeck'>
+Line 5471 
 Schoenebeck'>
                  active disk streams on that channel.</t>
              </section>
-             <section title="Disk stream buffer fill state changed">
+             <section title="Disk stream buffer fill state changed" anchor="SUBSCRIBE BUFFER_FILL">
-                 <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
-                 changes by issuing the following command:</t>
+                 on the back-end changes by issuing the following command:</t>
                  <t>
                      <list>
                          <t>SUBSCRIBE BUFFER_FILL</t>
-Line 3085 
 Schoenebeck'>
+Line 5486 
 Schoenebeck'>
                      </list>
                  </t>
                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
-                 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
-                 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" />
-                 "GET CHANNEL BUFFER_FILL PERCENTAGE" was issued on this channel.</t>
+                 as if the <xref target="GET CHANNEL BUFFER_FILL">
+                 "GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t>
              </section>
-             <section title="Channel information changed">
+             <section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO">
                  <t>Client may want to be notified when changes were made to sampler channels on the
-                 back-end changes by issuing the following command:</t>
+                 back-end by issuing the following command:</t>
                  <t>
                      <list>
-                         <t>SUBSCRIBE INFO</t>
+                         <t>SUBSCRIBE CHANNEL_INFO</t>
                      </list>
                  </t>
                  <t>Server will start sending the following notification messages:</t>
                  <t>
                      <list>
-                         <t>"NOTIFY:INFO:&lt;sampler-channel&gt;"</t>
+                         <t>"NOTIFY:CHANNEL_INFO:&lt;sampler-channel&gt;"</t>
                      </list>
                  </t>
                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
-Line 3112 
 Schoenebeck'>
+Line 5514 
 Schoenebeck'>
                  message is sufficient here.</t>
              </section>
-             <section title="Miscellaneous and debugging events">
+             <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
+                 <t>Client may want to be notified when the number of effect sends on
+                 a particular sampler channel is changed by issuing the following command:</t>
+                 <t>
+                     <list>
+                         <t>SUBSCRIBE FX_SEND_COUNT</t>
+                     </list>
+                 </t>
+                 <t>Server will start sending the following notification messages:</t>
+                 <t>
+                     <list>
+                         <t>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"</t>
+                     </list>
+                 </t>
+                 <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
+                 channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
+                 be replaced by the new number of effect sends on that channel.</t>
+             </section>
+             <section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO">
+                 <t>Client may want to be notified when changes were made to effect sends on a
+                 a particular sampler channel by issuing the following command:</t>
+                 <t>
+                     <list>
+                         <t>SUBSCRIBE FX_SEND_INFO</t>
+                     </list>
+                 </t>
+                 <t>Server will start sending the following notification messages:</t>
+                 <t>
+                     <list>
+                         <t>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"</t>
+                     </list>
+                 </t>
+                 <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
+                 channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
+                 be replaced by the numerical ID of the changed effect send.</t>
+             </section>
+             <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT">
+                 <t>Client may want to be notified when the total number of voices on the
+                 back-end changes by issuing the following command:</t>
+                 <t>
+                     <list>
+                         <t>SUBSCRIBE TOTAL_VOICE_COUNT</t>
+                     </list>
+                 </t>
+                 <t>Server will start sending the following notification messages:</t>
+                 <t>
+                     <list>
+                         <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"</t>
+                     </list>
+                 </t>
+                 <t>where &lt;voices&gt; will be replaced by the new number of
+                 all currently active voices.</t>
+             </section>
+             <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">
+                 <t>Client may want to be notified when the number of MIDI instrument maps on the
+                 back-end changes by issuing the following command:</t>
+                 <t>
+                     <list>
+                         <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t>
+                     </list>
+                 </t>
+                 <t>Server will start sending the following notification messages:</t>
+                 <t>
+                     <list>
+                         <t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"</t>
+                     </list>
+                 </t>
+                 <t>where &lt;maps&gt; will be replaced by the new number
+                 of MIDI instrument maps.</t>
+             </section>
+             <section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">
+                 <t>Client may want to be notified when changes were made to MIDI instrument maps on the
+                 back-end by issuing the following command:</t>
+                 <t>
+                     <list>
+                         <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t>
+                     </list>
+                 </t>
+                 <t>Server will start sending the following notification messages:</t>
+                 <t>
+                     <list>
+                         <t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"</t>
+                     </list>
+                 </t>
+                 <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
+                 for which information changes occurred. The front-end will have to send
+                 the respective command to actually get the MIDI instrument map info. Because these messages
+                 will be triggered by LSCP commands issued by other clients rather than real
+                 time events happening on the server, it is believed that an empty notification
+                 message is sufficient here.</t>
+             </section>
+             <section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT">
+                 <t>Client may want to be notified when the number of MIDI instrument maps on the
+                 back-end changes by issuing the following command:</t>
+                 <t>
+                     <list>
+                         <t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t>
+                     </list>
+                 </t>
+                 <t>Server will start sending the following notification messages:</t>
+                 <t>
+                     <list>
+                         <t>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"</t>
+                     </list>
+                 </t>
+                 <t>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
+                 the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
+                 the new number of MIDI instruments in the specified map.</t>
+             </section>
+             <section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO">
+                 <t>Client may want to be notified when changes were made to MIDI instruments on the
+                 back-end by issuing the following command:</t>
+                 <t>
+                     <list>
+                         <t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t>
+                     </list>
+                 </t>
+                 <t>Server will start sending the following notification messages:</t>
+                 <t>
+                     <list>
+                         <t>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"</t>
+                     </list>
+                 </t>
+                 <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
+                 in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
+                 the location of the changed MIDI instrument in the map. The front-end will have to send
+                 the respective command to actually get the MIDI instrument info. Because these messages
+                 will be triggered by LSCP commands issued by other clients rather than real
+                 time events happening on the server, it is believed that an empty notification
+                 message is sufficient here.</t>
+             </section>
+             <section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO">
+                 <t>Client may want to be notified when changes to the global settings
+                 of the sampler were made by issuing the following command:</t>
+                 <t>
+                     <list>
+                         <t>SUBSCRIBE GLOBAL_INFO</t>
+                     </list>
+                 </t>
+                 <t>Server will start sending the following types of notification messages:</t>
+                 <t>
+                     <list>
+                         <t>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
+                         golbal volume of the sampler is changed, where &lt;volume&gt; will be
+                         replaced by the optional dotted floating point value, reflecting the
+                         new global volume parameter.</t>
+                     </list>
+                 </t>
+             </section>
+             <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
                  <t>Client may want to be notified of miscellaneous and debugging events occurring at
                  the server by issuing the following command:</t>
                  <t>
-Line 3148 
 Schoenebeck'>
+Line 5707 
 Schoenebeck'>
                      <t>Rui Nuno Capela</t>
                      <t>Vladimir Senkov</t>
                      <t>Mark Knecht</t>
+                     <t>Grigor Iliev</t>
                  </list>
              </t>
          </section>
-Line 3155 
 Schoenebeck'>
+Line 5715 
 Schoenebeck'>
      </middle>
      <back>
-         <references>&rfc2119;</references>
+         <references>
+             <reference anchor="RFC2119">
+                 <front>
+                     <title>Key words for use in RFCs to Indicate Requirement Levels</title>
+                     <author initials="S." surname="Bradner" fullname="Scott Bradner">
+                         <organization>Harvard University</organization>
+                     </author>
+                     <date year="1997"></date>
+                 </front>
+                 <seriesInfo name="RFC" value="2119" />
+             </reference>
+             <reference anchor="RFC793">
+                 <front>
+                     <title>TRANSMISSION CONTROL PROTOCOL</title>
+                     <author>
+                         <organization>Defense Advanced Research Projects Agency</organization>
+                     </author>
+                     <date year="1981"></date>
+                 </front>
+                 <seriesInfo name="RFC" value="793" />
+             </reference>
+             <reference anchor="RFC2234">
+                 <front>
+                     <title>Augmented BNF for Syntax Specifications</title>
+                     <author initials="D.H." surname="Crocker" fullname="David H. Crocker">
+                         <organization>Internet Mail Consortium</organization>
+                     </author>
+                     <author initials="P." surname="Overell" fullname="Paul Overell">
+                         <organization>Demon Internet Ltd</organization>
+                     </author>
+                     <date year="1997"></date>
+                 </front>
+                 <seriesInfo name="RFC" value="2234" />
+             </reference>
+          </references>
      </back>
  </rfc>

 Legend:



Removed from v.377
 


changed lines


 
Added in v.1135
 Legend:



Removed from v.377
 


changed lines


 
Added in v.1135
-Removed from v.377
+Added in v.1135

	ViewVC Help
Powered by ViewVC