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

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

Parent Directory | Revision Log | View Patch Patch

-revision 499 by schoenebeck,
Fri Apr 15 11:54:22 2005 UTC
+revision 937 by schoenebeck,
Fri Nov 24 17:43:09 2006 UTC
 Line 13
  <?rfc iprnotified="no" ?>
  <?rfc strict="yes" ?>
- <rfc category="std" ipr="full2026" docName="lscp.txt">
+ <rfc category="std" ipr="full2026" docName="LSCP 1.1">
      <front>
          <title>LinuxSampler Control Protocol</title>
          <author initials='C.S.' surname="Schoenebeck" fullname='C.
 Line 31 
 Schoenebeck'>
                  <email>schoenebeck at software minus engineering dot org</email>
              </address>
          </author>
-         <date month="Apr" year="2005"/>
+         <date month="November" year="2006"/>
          <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'>
              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 161 
 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 191 
 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 379 
 Schoenebeck'>
+Line 417 
 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 425 
 Schoenebeck'>
+Line 463 
 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 472 
 Schoenebeck'>
+Line 511 
 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 492 
 Schoenebeck'>
+Line 556 
 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 509 
 Schoenebeck'>
+Line 573 
 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 572 
 Schoenebeck'>
+Line 636 
 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 581 
 Schoenebeck'>
+Line 645 
 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 630 
 Schoenebeck'>
+Line 696 
 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 639 
 Schoenebeck'>
+Line 705 
 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 655 
 Schoenebeck'>
+Line 721 
 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 672 
 Schoenebeck'>
+Line 738 
 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 757 
 Schoenebeck'>
+Line 824 
 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 767 
 Schoenebeck'>
+Line 834 
 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 815 
 Schoenebeck'>
+Line 884 
 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 823 
 Schoenebeck'>
+Line 892 
 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 859 
 Schoenebeck'>
+Line 930 
 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 882 
 Schoenebeck'>
+Line 953 
 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 905 
 Schoenebeck'>
+Line 976 
 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>
-Line 914 
 Schoenebeck'>
+Line 985 
 Schoenebeck'>
                      </t>
                      <t>Where &lt;device-id&gt; should be replaced by numerical ID
                      of the audio output device as e.g. returned by the
-                     "LIST 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 928 
 Schoenebeck'>
+Line 999 
 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 957 
 Schoenebeck'>
+Line 1030 
 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 976 
 Schoenebeck'>
+Line 1049 
 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 984 
 Schoenebeck'>
+Line 1057 
 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 1018 
 Schoenebeck'>
+Line 1094 
 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 1116 
 Schoenebeck'>
+Line 1194 
 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 1125 
 Schoenebeck'>
+Line 1203 
 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 1219 
 Schoenebeck'>
+Line 1300 
 Schoenebeck'>
                      </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 1295 
 Schoenebeck'>
+Line 1378 
 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 1313 
 Schoenebeck'>
+Line 1421 
 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 1373 
 Schoenebeck'>
+Line 1483 
 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 1381 
 Schoenebeck'>
+Line 1491 
 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 1425 
 Schoenebeck'>
+Line 1537 
 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 1434 
 Schoenebeck'>
+Line 1547 
 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 1450 
 Schoenebeck'>
+Line 1564 
 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 1467 
 Schoenebeck'>
+Line 1581 
 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 1523 
 Schoenebeck'>
+Line 1638 
 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 1531 
 Schoenebeck'>
+Line 1646 
 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 1571 
 Schoenebeck'>
+Line 1688 
 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 1610 
 Schoenebeck'>
+Line 1730 
 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 1634 
 Schoenebeck'>
+Line 1754 
 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 1663 
 Schoenebeck'>
+Line 1783 
 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 1687 
 Schoenebeck'>
+Line 1810 
 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 1710 
 Schoenebeck'>
+Line 1834 
 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 1724 
 Schoenebeck'>
+Line 1849 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Changing settings of MIDI input 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 1733 
 Schoenebeck'>
+Line 1858 
 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 1767 
 Schoenebeck'>
+Line 1895 
 Schoenebeck'>
                      </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 1809 
 Schoenebeck'>
+Line 1939 
 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 1817 
 Schoenebeck'>
+Line 1947 
 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 "LIST 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 1911 
 Schoenebeck'>
+Line 2044 
 Schoenebeck'>
                      </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 1920 
 Schoenebeck'>
+Line 2053 
 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 1956 
 Schoenebeck'>
+Line 2092 
 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 1977 
 Schoenebeck'>
+Line 2114 
 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 2015 
 Schoenebeck'>
+Line 2153 
 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 2025 
 Schoenebeck'>
+Line 2163 
 Schoenebeck'>
                      </t>
                      <t>Where &lt;engine-name&gt; is an engine name as obtained by the
-                     "GET AVAILABLE_ENGINES" command 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 2061 
 Schoenebeck'>
+Line 2208 
 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 2085 
 Schoenebeck'>
+Line 2232 
 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 2110 
 Schoenebeck'>
+Line 2257 
 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 2134 
 Schoenebeck'>
+Line 2281 
 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 2162 
 Schoenebeck'>
+Line 2309 
 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 2170 
 Schoenebeck'>
+Line 2317 
 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 2205 
 Schoenebeck'>
+Line 2355 
 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 2215 
 Schoenebeck'>
+Line 2365 
 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' names. Engine names can consist of lower and
-                             upper cases, digits and underlines ("_" character).</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 2238 
 Schoenebeck'>
+Line 2411 
 Schoenebeck'>
                          </list>
                      </t>
                      <t>Where &lt;engine-name&gt; is an engine name as obtained by the
-                     "GET AVAILABLE_ENGINES" command.</t>
+                     <xref target="LIST AVAILABLE_ENGINES">
+                     "LIST AVAILABLE_ENGINES"</xref> command.</t>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-Line 2278 
 Schoenebeck'>
+Line 2452 
 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 2286 
 Schoenebeck'>
+Line 2460 
 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 2300 
 Schoenebeck'>
+Line 2476 
 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 2380 
 Schoenebeck'>
+Line 2556 
 Schoenebeck'>
 .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>
                                  </list>
                              </t>
                          </list>
-Line 2407 
 Schoenebeck'>
+Line 2598 
 Schoenebeck'>
                      </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 2415 
 Schoenebeck'>
+Line 2606 
 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 2432 
 Schoenebeck'>
+Line 2625 
 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 2440 
 Schoenebeck'>
+Line 2633 
 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 2459 
 Schoenebeck'>
+Line 2654 
 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 2474 
 Schoenebeck'>
+Line 2669 
 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 2510 
 Schoenebeck'>
+Line 2707 
 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 2518 
 Schoenebeck'>
+Line 2715 
 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 2552 
 Schoenebeck'>
+Line 2753 
 Schoenebeck'>
                      </t>
                  </section>
-                 <section title="Setting audio output type">
+                 <section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYP">
                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>
                      <t>The front-end can alter the audio output type on a specific sampler
-Line 2595 
 Schoenebeck'>
+Line 2796 
 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 2603 
 Schoenebeck'>
+Line 2804 
 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 number, &lt;audio-out&gt; is the
+                     <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;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>
-Line 2638 
 Schoenebeck'>
+Line 2841 
 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 2646 
 Schoenebeck'>
+Line 2849 
 Schoenebeck'>
                              <t>SET CHANNEL MIDI_INPUT_DEVICE &lt;sampler-channel&gt; &lt;midi-device-id&gt;</t>
                          </list>
                      </t>
-                     <t>Where &lt;sampler-channel&gt; is the sampler channel number and &lt;midi-device-id&gt; is the
+                     <t>Where &lt;sampler-channel&gt; is the sampler channel number
-                     the numerical ID of the MIDI input device.</t>
+                     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 2679 
 Schoenebeck'>
+Line 2886 
 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 2722 
 Schoenebeck'>
+Line 2929 
 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 MIDI input port on a specific sampler
                      channel by sending the following command:</t>
                      <t>
-Line 2751 
 Schoenebeck'>
+Line 2958 
 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 2764 
 Schoenebeck'>
+Line 2971 
 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 2806 
 Schoenebeck'>
+Line 3013 
 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 2849 
 Schoenebeck'>
+Line 3056 
 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="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 2897 
 Schoenebeck'>
+Line 3192 
 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 2939 
 Schoenebeck'>
+Line 3234 
 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 2981 
 Schoenebeck'>
+Line 3276 
 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 3019 
 Schoenebeck'>
+Line 3314 
 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 3034 
 Schoenebeck'>
+Line 3329 
 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 3059 
 Schoenebeck'>
+Line 3390 
 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>
          </section>
-         <section title="Command Syntax">
+         <section title="Command Syntax" anchor="command_syntax">
-             <t>TODO: will soon automatically included from src/network/lscp.y,
+             <t>The grammar of the control protocol as descibed in <xref target="control_commands"/>
-             meanwhile have a look at that file to get the exact definition of
+             is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>)
-             the command syntax.</t>
+             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 CHANNEL
+                 </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 CHANNEL SP sampler_channel
+                 </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 CHANNEL SP sampler_channel
+                 </t>
+                 <t>/ RESET
+                 </t>
+                 <t>/ QUIT
+                 </t>
+         </list>
+ </t>
+ <t>subscribe_event =
+         <list>
+                 <t>CHANNEL_COUNT
+                 </t>
+                 <t>/ VOICE_COUNT
+                 </t>
+                 <t>/ STREAM_COUNT
+                 </t>
+                 <t>/ BUFFER_FILL
+                 </t>
+                 <t>/ CHANNEL_INFO
+                 </t>
+                 <t>/ MISCELLANEOUS
+                 </t>
+                 <t>/ TOTAL_VOICE_COUNT
+                 </t>
+         </list>
+ </t>
+ <t>unsubscribe_event =
+         <list>
+                 <t>CHANNEL_COUNT
+                 </t>
+                 <t>/ VOICE_COUNT
+                 </t>
+                 <t>/ STREAM_COUNT
+                 </t>
+                 <t>/ BUFFER_FILL
+                 </t>
+                 <t>/ CHANNEL_INFO
+                 </t>
+                 <t>/ MISCELLANEOUS
+                 </t>
+                 <t>/ TOTAL_VOICE_COUNT
+                 </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>
+         </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>/ ECHO SP boolean
+                 </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>
+         </list>
+ </t>
+ <t>destroy_instruction =
+         <list>
+                 <t>AUDIO_OUTPUT_DEVICE SP number
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE SP number
+                 </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>
+         </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>
+         </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>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>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>engine_name =
+         <list>
+                 <t>string
+                 </t>
+         </list>
+ </t>
+ <t>filename =
+         <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 sampler channels changed" anchor="SUBSCRIBE CHANNEL">
                  <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 3108 
 Schoenebeck'>
+Line 3856 
 Schoenebeck'>
                  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 3127 
 Schoenebeck'>
+Line 3875 
 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 buffer fill state of a disk stream
                  on the back-end changes by issuing the following command:</t>
                  <t>
-Line 3142 
 Schoenebeck'>
+Line 3890 
 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 5.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 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 3169 
 Schoenebeck'>
+Line 3918 
 Schoenebeck'>
                  message is sufficient here.</t>
              </section>
-             <section title="Miscellaneous and debugging events">
+             <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="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 3205 
 Schoenebeck'>
+Line 3972 
 Schoenebeck'>
                      <t>Rui Nuno Capela</t>
                      <t>Vladimir Senkov</t>
                      <t>Mark Knecht</t>
+                     <t>Grigor Iliev</t>
                  </list>
              </t>
          </section>
-Line 3212 
 Schoenebeck'>
+Line 3980 
 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.499
 


changed lines


 
Added in v.937
 Legend:



Removed from v.499
 


changed lines


 
Added in v.937
-Removed from v.499
+Added in v.937

	ViewVC Help
Powered by ViewVC