/[svn]/web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.xml
ViewVC logotype

Diff of /web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.xml

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

revision 542 by senoner, Sun May 15 15:31:45 2005 UTC revision 575 by schoenebeck, Tue May 24 03:26:22 2005 UTC
# Line 13  Line 13 
13  <?rfc iprnotified="no" ?>  <?rfc iprnotified="no" ?>
14  <?rfc strict="yes" ?>  <?rfc strict="yes" ?>
15    
16  <rfc category="std" ipr="full2026" docName="lscp.txt">  <rfc category="std" ipr="full2026" docName="LSCP 1.0">
17      <front>      <front>
18          <title>LinuxSampler Control Protocol</title>          <title>LinuxSampler Control Protocol</title>
19          <author initials='C.S.' surname="Schoenebeck" fullname='C.          <author initials='C.S.' surname="Schoenebeck" fullname='C.
# Line 37  Schoenebeck'> Line 37  Schoenebeck'>
37          <abstract>          <abstract>
38              <t>The LinuxSampler Control Protocol (LSCP) is an              <t>The LinuxSampler Control Protocol (LSCP) is an
39              application-level protocol primarily intended for local and              application-level protocol primarily intended for local and
40              remote controlling the LinuxSampler main application, which is a              remote controlling the LinuxSampler backend application, which is a
41              sophisticated console application essentially playing back audio              sophisticated server-like console application essentially playing
42              samples and manipulating the samples in real time to certain              back audio samples and manipulating the samples in real time to
43              extent.</t>              certain extent.</t>
44          </abstract>          </abstract>
45      </front>      </front>
46    
# Line 112  Schoenebeck'> Line 112  Schoenebeck'>
112              return and line feed characters respectively.</t>              return and line feed characters respectively.</t>
113          </section>          </section>
114    
115            <section title="Versioning of this specification" anchor="LSCP versioning">
116                <t>LSCP will certainly be extended and enhanced by-and-by. Each official
117                release of the LSCP specification will be tagged with a unique version
118                tuple. The version tuple consists at least of a major and minor version
119                number like:
120                </t>
121                <t>
122                    <list>
123                        <t>"1.2"</t>
124                    </list>
125                </t>
126                <t>
127                In this example the major version number would be "1" and the minor
128                version number would be "2". Note that the version tuple might also
129                have more than two elements. The major version number defines a
130                group of backward compatible versions. That means a frontend is
131                compatible to the connected sampler if and only if the LSCP versions
132                to which each of the two parties complies to, match both of the
133                following rules:
134                </t>
135                <t>Compatibility:</t>
136                <t>
137                    <list style="numbers">
138                        <t>The frontend's LSCP major version and the sampler's LSCP
139                        major version are exactly equal.</t>
140                        <t>The frontend's LSCP minor version is less or equal than
141                        the sampler's LSCP minor version.</t>
142                    </list>
143                </t>
144                <t>
145                Compatibility can only be claimed if both rules are true.
146                The frontend can use the
147                <xref target="GET SERVER INFO">"GET SERVER INFO"</xref> command to
148                get the version of the LSCP specification the sampler complies with.
149                </t>
150            </section>
151    
152          <section title="Introduction">          <section title="Introduction">
153              <t>LinuxSampler is a so called software sampler application              <t>LinuxSampler is a so called software sampler application
154              capable to playback audio samples from a computer's Random              capable to playback audio samples from a computer's Random
# Line 124  Schoenebeck'> Line 161  Schoenebeck'>
161              arbitrary MIDI input method and arbitrary MIDI channel (e.g.              arbitrary MIDI input method and arbitrary MIDI channel (e.g.
162              sampler channel 17 could be connected to an ALSA sequencer              sampler channel 17 could be connected to an ALSA sequencer
163              device 64:0 and listening to MIDI channel 1 there). Each sampler              device 64:0 and listening to MIDI channel 1 there). Each sampler
164              engine will be assigned an own instance of one of the available              channel will be associated with an instance of one of the available
165              sampler engines (e.g. GigEngine, DLSEngine). The audio output of              sampler engines (e.g. GigEngine, DLSEngine). The audio output of
166              each sampler channel can be routed to an arbitrary audio output              each sampler channel can be routed to an arbitrary audio output
167              method (ALSA / JACK) and an arbitrary audio output channel              method (ALSA / JACK) and an arbitrary audio output channel
# Line 154  Schoenebeck'> Line 191  Schoenebeck'>
191              methods will be described next.</t>              methods will be described next.</t>
192    
193              <section title="Request/response communication method">              <section title="Request/response communication method">
194                  <t>This simple communication method is based on TCP. The                  <t>This simple communication method is based on
195                    <xref target="RFC793">TCP</xref>. The
196                  front-end application establishes a TCP connection to the                  front-end application establishes a TCP connection to the
197                  LinuxSampler instance on a certain host system. Then the                  LinuxSampler instance on a certain host system. Then the
198                  front-end application will send certain ASCII based commands                  front-end application will send certain ASCII based commands
# Line 425  Schoenebeck'> Line 463  Schoenebeck'>
463              </section>              </section>
464          </section>          </section>
465    
466          <section title="Description for control commands">          <section title="Description for control commands" anchor="control_commands">
467              <t>This chapter will describe the available control commands              <t>This chapter will describe the available control commands
468              that can be sent on the TCP connection in detail. Some certain              that can be sent on the TCP connection in detail. Some certain
469              commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref>              commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref>
# Line 683  Schoenebeck'> Line 721  Schoenebeck'>
721    
722                              <t>DEPENDS -                              <t>DEPENDS -
723                                <list>                                <list>
724                                  <t>comma separated list of paramters this parameter depends                                  <t>comma separated list of parameters this parameter depends
725                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',
726                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these
727                                  listed parameters, for example assuming that an audio                                  listed parameters, for example assuming that an audio
# Line 796  Schoenebeck'> Line 834  Schoenebeck'>
834                      </t>                      </t>
835    
836                      <t>Where &lt;audio-output-driver&gt; should be replaced by the desired audio                      <t>Where &lt;audio-output-driver&gt; should be replaced by the desired audio
837                      output system and &lt;param-list&gt; by an optional list of driver                      output system as returned by the
838                        <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref>
839                        command and &lt;param-list&gt; by an optional list of driver
840                      specific parameters in form of "key1=val1 key2=val2 ...", where                      specific parameters in form of "key1=val1 key2=val2 ...", where
841                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
842                      Note that there might be drivers which require parameter(s) to be                      Note that there might be drivers which require parameter(s) to be
# Line 1017  Schoenebeck'> Line 1057  Schoenebeck'>
1057                          </list>                          </list>
1058                      </t>                      </t>
1059                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
1060                      audio output device, &lt;key&gt; by the name of the parameter to change                      audio output device as given by the
1061                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1062                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1063                        command, &lt;key&gt; by the name of the parameter to change
1064                      and &lt;value&gt; by the new value for this parameter.</t>                      and &lt;value&gt; by the new value for this parameter.</t>
1065                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1066                      <t>                      <t>
# Line 1058  Schoenebeck'> Line 1101  Schoenebeck'>
1101                              <t>GET AUDIO_OUTPUT_CHANNEL INFO &lt;device-id&gt; &lt;audio-chan&gt;</t>                              <t>GET AUDIO_OUTPUT_CHANNEL INFO &lt;device-id&gt; &lt;audio-chan&gt;</t>
1102                          </list>                          </list>
1103                      </t>                      </t>
1104                      <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
1105                      and &lt;audio-chan&gt; the audio channel number.</t>                      <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1106                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1107                        command and &lt;audio-chan&gt; the audio channel number.</t>
1108                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1109                      <t>                      <t>
1110                          <list>                          <list>
# Line 1158  Schoenebeck'> Line 1203  Schoenebeck'>
1203                          </list>                          </list>
1204                      </t>                      </t>
1205    
1206                      <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
1207                      by the <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>                      <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1208                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1209                      command, &lt;chan&gt; the audio channel number                      command, &lt;chan&gt; the audio channel number
1210                      and &lt;param&gt; a specific channel parameter name for which information should                      and &lt;param&gt; a specific channel parameter name for which information should
1211                      be obtained (as returned by the <xref target="GET AUDIO_OUTPUT_CHANNEL INFO">                      be obtained (as returned by the <xref target="GET AUDIO_OUTPUT_CHANNEL INFO">
# Line 1261  Schoenebeck'> Line 1307  Schoenebeck'>
1307                              <t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER &lt;dev-id&gt; &lt;chn&gt; &lt;key&gt;=&lt;value&gt;</t>                              <t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER &lt;dev-id&gt; &lt;chn&gt; &lt;key&gt;=&lt;value&gt;</t>
1308                          </list>                          </list>
1309                      </t>                      </t>
1310                      <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
1311                      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>
1312                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1313                        command, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the
1314                      parameter to change and &lt;value&gt; by the new value for this parameter.</t>                      parameter to change and &lt;value&gt; by the new value for this parameter.</t>
1315                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1316                      <t>                      <t>
# Line 1386  Schoenebeck'> Line 1434  Schoenebeck'>
1434                              <t>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;</t>                              <t>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;</t>
1435                          </list>                          </list>
1436                      </t>                      </t>
1437                      <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
1438                        by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1439                        "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command.</t>
1440                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1441                      <t>                      <t>
1442                          <list>                          <list>
# Line 1441  Schoenebeck'> Line 1491  Schoenebeck'>
1491                          </list>                          </list>
1492                      </t>                      </t>
1493    
1494                      <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
1495                      by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">                      by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1496                      "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command, &lt;param&gt; a specific                      "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command, &lt;param&gt; a specific
1497                      parameter name for which information should be obtained (as returned by the                      parameter name for which information should be obtained (as returned by the
# Line 1514  Schoenebeck'> Line 1564  Schoenebeck'>
1564    
1565                              <t>DEPENDS -                              <t>DEPENDS -
1566                                <list>                                <list>
1567                                  <t>comma separated list of paramters this parameter depends                                  <t>comma separated list of parameters this parameter depends
1568                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',
1569                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these
1570                                  listed parameters, for example assuming that an audio                                  listed parameters, for example assuming that an audio
# Line 1596  Schoenebeck'> Line 1646  Schoenebeck'>
1646                          </list>                          </list>
1647                      </t>                      </t>
1648    
1649                      <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
1650                        by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1651                        "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command and &lt;param-list&gt; by an
1652                      optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where                      optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where
1653                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
1654                      Note that there might be drivers which require parameter(s) to be                      Note that there might be drivers which require parameter(s) to be
# Line 1643  Schoenebeck'> Line 1695  Schoenebeck'>
1695                              <t>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;</t>                              <t>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;</t>
1696                          </list>                          </list>
1697                      </t>                      </t>
1698                      <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
1699                        <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1700                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1701                        command.</t>
1702                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1703                      <t>                      <t>
1704                          <list>                          <list>
# Line 1735  Schoenebeck'> Line 1790  Schoenebeck'>
1790                              <t>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;</t>                              <t>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;</t>
1791                          </list>                          </list>
1792                      </t>                      </t>
1793                      <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
1794                        <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1795                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1796                        command.</t>
1797                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1798                      <t>                      <t>
1799                          <list>                          <list>
# Line 1800  Schoenebeck'> Line 1858  Schoenebeck'>
1858                      </t>                      </t>
1859    
1860                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
1861                      MIDI input device, &lt;key&gt; by the name of the parameter to change and                      MIDI input device as returned by the
1862                        <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1863                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1864                        command, &lt;key&gt; by the name of the parameter to change and
1865                      &lt;value&gt; by the new value for this parameter.</t>                      &lt;value&gt; by the new value for this parameter.</t>
1866    
1867                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 1841  Schoenebeck'> Line 1902  Schoenebeck'>
1902                              <t>GET MIDI_INPUT_PORT INFO &lt;device-id&gt; &lt;midi-port&gt;</t>                              <t>GET MIDI_INPUT_PORT INFO &lt;device-id&gt; &lt;midi-port&gt;</t>
1903                          </list>                          </list>
1904                      </t>                      </t>
1905                      <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
1906                      and &lt;midi-port&gt; the MIDI input port number.</t>                      <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1907                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1908                        command and &lt;midi-port&gt; the MIDI input port number.</t>
1909                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1910                      <t>                      <t>
1911                          <list>                          <list>
# Line 1884  Schoenebeck'> Line 1947  Schoenebeck'>
1947                          </list>                          </list>
1948                      </t>                      </t>
1949    
1950                      <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
1951                      by the <xref target="LIST MIDI_INPUT_DEVICES">                      <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1952                      "LIST MIDI_INPUT_DEVICES"</xref> command, &lt;port&gt; the MIDI port number and                      or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1953                        command, &lt;port&gt; the MIDI port number and
1954                      &lt;param&gt; a specific port parameter name for which information should be                      &lt;param&gt; a specific port parameter name for which information should be
1955                      obtained (as returned by the <xref target="GET MIDI_INPUT_PORT INFO">                      obtained (as returned by the <xref target="GET MIDI_INPUT_PORT INFO">
1956                      "GET MIDI_INPUT_PORT INFO"</xref> command).</t>                      "GET MIDI_INPUT_PORT INFO"</xref> command).</t>
# Line 1989  Schoenebeck'> Line 2053  Schoenebeck'>
2053                      </t>                      </t>
2054    
2055                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
2056                      MIDI device, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of                      MIDI device as returned by the
2057                        <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
2058                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
2059                        command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
2060                      the parameter to change and &lt;value&gt; by the new value for this                      the parameter to change and &lt;value&gt; by the new value for this
2061                      parameter.</t>                      parameter.</t>
2062    
# Line 2025  Schoenebeck'> Line 2092  Schoenebeck'>
2092              </section>              </section>
2093    
2094              <section title="Configuring sampler channels">              <section title="Configuring sampler channels">
2095                  <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
2096                  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
2097                    MIDI and audio devices.</t>
2098    
2099                  <section title="Loading an instrument" anchor="LOAD INSTRUMENT">                  <section title="Loading an instrument" anchor="LOAD INSTRUMENT">
2100                      <t>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:</t>                      <t>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:</t>
# Line 2086  Schoenebeck'> Line 2154  Schoenebeck'>
2154                  </section>                  </section>
2155    
2156                  <section title="Loading a sampler engine" anchor="LOAD ENGINE">                  <section title="Loading a sampler engine" anchor="LOAD ENGINE">
2157                      <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
2158                      channel by the following command:</t>                      channel by the following command:</t>
2159                      <t>                      <t>
2160                          <list>                          <list>
# Line 2096  Schoenebeck'> Line 2164  Schoenebeck'>
2164    
2165                      <t>Where &lt;engine-name&gt; is an engine name as obtained by the                      <t>Where &lt;engine-name&gt; is an engine name as obtained by the
2166                      <xref target="LIST AVAILABLE_ENGINES">                      <xref target="LIST AVAILABLE_ENGINES">
2167                      "LIST AVAILABLE_ENGINES"</xref> command and &lt;sampler-channel&gt; the sampler channel the                      "LIST AVAILABLE_ENGINES"</xref> command and &lt;sampler-channel&gt;
2168                      deployed engine should be assigned to. Even if the respective                      the sampler channel as returned by the
2169                      sampler channel has already a deployed engine with that engine                      <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> or
2170                      name, a new engine instance will be assigned to the sampler channel.</t>                      <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command where
2171                        the engine type should be assigned to. This command should be issued
2172                        after adding a new sampler channel and before any other control
2173                        commands on the new sampler channel. It can also be used to change
2174                        the engine type of a sampler channel. This command has (currently) no
2175                        way to define or force if a new engine instance should be created and
2176                        assigned to the given sampler channel or if an already existing
2177                        instance of that engine type, shared with other sampler channels,
2178                        should be used.</t>
2179    
2180                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2181                      <t>                      <t>
# Line 2205  Schoenebeck'> Line 2281  Schoenebeck'>
2281                                  <list>                                  <list>
2282                                      <t>in case a new sampler channel could be added, where                                      <t>in case a new sampler channel could be added, where
2283                                      &lt;sampler-channel&gt; reflects the channel number of the new                                      &lt;sampler-channel&gt; reflects the channel number of the new
2284                                      created sampler channel which should the be used to set up                                      created sampler channel which should be used to set up
2285                                      the sampler channel by sending subsequent intialization                                      the sampler channel by sending subsequent initialization
2286                                      commands</t>                                      commands</t>
2287                                  </list>                                  </list>
2288                              </t>                              </t>
# Line 2241  Schoenebeck'> Line 2317  Schoenebeck'>
2317                          </list>                          </list>
2318                      </t>                      </t>
2319    
2320                      <t>This will decrement the sampler channel count by one and also                      <t>Where &lt;sampler-channel&gt; should be replaced by the
2321                      decrement the channel numbers of all subsequent sampler channels by                      number of the sampler channel as given by the
2322                      one.</t>                      <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2323                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref>
2324                        command. The channel numbers of all subsequent sampler channels
2325                        remain the same.</t>
2326    
2327                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2328                      <t>                      <t>
# Line 2308  Schoenebeck'> Line 2387  Schoenebeck'>
2387                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2388                      <t>                      <t>
2389                          <list>                          <list>
2390                              <t>LinuxSampler will answer by sending a comma separated character                              <t>LinuxSampler will answer by sending a comma separated list
2391                              string of the engines' names. Engine names can consist of lower and                              of the engines' names encapsulated into apostrophes (').
2392                              upper cases, digits and underlines ("_" character).</t>                              Engine names can consist of lower and upper cases,
2393                                digits and underlines ("_" character).</t>
2394                          </list>                          </list>
2395                      </t>                      </t>
2396                      <t>Example:</t>                      <t>Example:</t>
2397                      <t>                      <t>
2398                          <list>                          <list>
2399                              <t>C: "LIST AVAILABLE_ENGINES"</t>                              <t>C: "LIST AVAILABLE_ENGINES"</t>
2400                              <t>S: "GigEngine,AkaiEngine,DLSEngine,JoesCustomEngine"</t>                              <t>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"</t>
2401                          </list>                          </list>
2402                      </t>                      </t>
2403                  </section>                  </section>
# Line 2380  Schoenebeck'> Line 2460  Schoenebeck'>
2460                              <t>GET CHANNEL INFO &lt;sampler-channel&gt;</t>                              <t>GET CHANNEL INFO &lt;sampler-channel&gt;</t>
2461                          </list>                          </list>
2462                      </t>                      </t>
2463                      <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
2464                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2465                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2466                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2467                      <t>                      <t>
2468                          <list>                          <list>
# Line 2394  Schoenebeck'> Line 2476  Schoenebeck'>
2476                                  <list>                                  <list>
2477                                      <t>ENGINE_NAME -                                      <t>ENGINE_NAME -
2478                                          <list>                                          <list>
2479                                              <t>name of the engine that is deployed on the sampler                                              <t>name of the engine that is associated with the sampler
2480                                              channel, "NONE" if there's no engine deployed yet for                                              channel, "NONE" if there's no engine associated yet for
2481                                              this sampler channel</t>                                              this sampler channel</t>
2482                                          </list>                                          </list>
2483                                      </t>                                      </t>
# Line 2509  Schoenebeck'> Line 2591  Schoenebeck'>
2591                              <t>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;</t>                              <t>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;</t>
2592                          </list>                          </list>
2593                      </t>                      </t>
2594                      <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
2595                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2596                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2597    
2598                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2599                      <t>                      <t>
# Line 2534  Schoenebeck'> Line 2618  Schoenebeck'>
2618                              <t>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;</t>                              <t>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;</t>
2619                          </list>                          </list>
2620                      </t>                      </t>
2621                      <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
2622                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2623                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2624    
2625                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2626                      <t>                      <t>
# Line 2568  Schoenebeck'> Line 2654  Schoenebeck'>
2654                          </list>                          </list>
2655                      </t>                      </t>
2656                      <t>to get the fill state in percent, where &lt;sampler-channel&gt; is the                      <t>to get the fill state in percent, where &lt;sampler-channel&gt; is the
2657                      sampler channel number the front-end is interested in.</t>                      sampler channel number the front-end is interested in
2658                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2659                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2660    
2661                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2662                      <t>                      <t>
# Line 2612  Schoenebeck'> Line 2700  Schoenebeck'>
2700                              <t>SET CHANNEL AUDIO_OUTPUT_DEVICE &lt;sampler-channel&gt; &lt;audio-device-id&gt;</t>                              <t>SET CHANNEL AUDIO_OUTPUT_DEVICE &lt;sampler-channel&gt; &lt;audio-device-id&gt;</t>
2701                          </list>                          </list>
2702                      </t>                      </t>
2703                      <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
2704                      device and &lt;sampler-channel&gt; is the respective sampler channel                      number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2705                      number.</t>                      or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
2706                        &lt;audio-device-id&gt; is the numerical ID of the audio output device as given by the
2707                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
2708                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
2709                        command.</t>
2710    
2711                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2712                      <t>                      <t>
# Line 2697  Schoenebeck'> Line 2789  Schoenebeck'>
2789                              <t>SET CHANNEL AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;audio-out&gt; &lt;audio-in&gt;</t>                              <t>SET CHANNEL AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;audio-out&gt; &lt;audio-in&gt;</t>
2790                          </list>                          </list>
2791                      </t>                      </t>
2792                      <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
2793                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2794                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, &lt;audio-out&gt; is the
2795                      numerical ID of the sampler channel's audio output channel which should be                      numerical ID of the sampler channel's audio output channel which should be
2796                      rerouted and &lt;audio-in&gt; is the numerical ID of the audio channel of the selected audio                      rerouted and &lt;audio-in&gt; is the numerical ID of the audio channel of the selected audio
2797                      output device where &lt;audio-out&gt; should be routed to.</t>                      output device where &lt;audio-out&gt; should be routed to.</t>
# Line 2740  Schoenebeck'> Line 2834  Schoenebeck'>
2834                              <t>SET CHANNEL MIDI_INPUT_DEVICE &lt;sampler-channel&gt; &lt;midi-device-id&gt;</t>                              <t>SET CHANNEL MIDI_INPUT_DEVICE &lt;sampler-channel&gt; &lt;midi-device-id&gt;</t>
2835                          </list>                          </list>
2836                      </t>                      </t>
2837                      <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
2838                      the numerical ID of the MIDI input device.</t>                      as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2839                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command
2840                        and &lt;midi-device-id&gt; is  the numerical ID of the MIDI input device as returned by the
2841                        <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
2842                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command.</t>
2843    
2844                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2845                      <t>                      <t>
# Line 2845  Schoenebeck'> Line 2943  Schoenebeck'>
2943                              </t>                              </t>
2944                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2945                                  <list>                                  <list>
2946                                      <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>
2947                                  </list>                                  </list>
2948                              </t>                              </t>
2949                          </list>                          </list>
# Line 3153  Schoenebeck'> Line 3251  Schoenebeck'>
3251                          </list>                          </list>
3252                      </t>                      </t>
3253                  </section>                  </section>
3254    
3255                    <section title="General sampler informations" anchor="GET SERVER INFO">
3256                        <t>The client can ask for general informations about the LinuxSampler
3257                           instance by sending the following command:</t>
3258                        <t>
3259                            <list>
3260                                <t>GET SERVER INFO</t>
3261                            </list>
3262                        </t>
3263                        <t>Possible Answers:</t>
3264                        <t>
3265                            <list>
3266                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
3267                                   Each answer line begins with the information category name
3268                                   followed by a colon and then a space character &lt;SP&gt; and finally
3269                                   the info character string to that information category. At the
3270                                   moment the following categories are defined:
3271                                </t>
3272                                <t>
3273                                    <list>
3274                                        <t>DESCRIPTION -
3275                                            <list>
3276                                                <t>arbitrary textual description about the sampler</t>
3277                                            </list>
3278                                        </t>
3279                                        <t>VERSION -
3280                                            <list>
3281                                                <t>version of the sampler</t>
3282                                            </list>
3283                                        </t>
3284                                        <t>PROTOCOL_VERSION -
3285                                            <list>
3286                                                <t>version of the LSCP specification the sampler
3287                                                complies with (see <xref target="LSCP versioning" /> for details)</t>
3288                                            </list>
3289                                        </t>
3290                                    </list>
3291                                </t>
3292                            </list>
3293                        </t>
3294                        <t>The mentioned fields above don't have to be in particular order.
3295                        Other fields might be added in future.</t>
3296                    </section>
3297              </section>              </section>
3298          </section>          </section>
3299    
3300          <section title="Command Syntax" anchor="command_syntax">          <section title="Command Syntax" anchor="command_syntax">
3301              <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"/>
3302              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"/>)
3303              the command syntax.</t>              where applicable.
3304                </t>
3305                <!--
3306                    This section is automatically generated by scripts/update_grammar.pl
3307                    from src/network/lscp.y (yacc input file). Do not modify this section
3308                    manually !
3309                -->
3310                <!-- GRAMMAR_BNF_BEGIN - do NOT delete or modify this line !!! -->
3311    
3312    <t>input =
3313            <list>
3314                    <t>line LF
3315                    </t>
3316                    <t>/ line CR LF
3317                    </t>
3318            </list>
3319    </t>
3320    <t>line =
3321            <list>
3322                    <t>/* epsilon (empty line ignored) */
3323                    </t>
3324                    <t>/ comment
3325                    </t>
3326                    <t>/ command
3327                    </t>
3328                    <t>/ error
3329                    </t>
3330            </list>
3331    </t>
3332    <t>comment =
3333            <list>
3334                    <t>'#'
3335                    </t>
3336                    <t>/ comment '#'
3337                    </t>
3338                    <t>/ comment SP
3339                    </t>
3340                    <t>/ comment number
3341                    </t>
3342                    <t>/ comment string
3343                    </t>
3344            </list>
3345    </t>
3346    <t>command =
3347            <list>
3348                    <t>ADD SP CHANNEL
3349                    </t>
3350                    <t>/ GET SP get_instruction
3351                    </t>
3352                    <t>/ CREATE SP create_instruction
3353                    </t>
3354                    <t>/ DESTROY SP destroy_instruction
3355                    </t>
3356                    <t>/ LIST SP list_instruction
3357                    </t>
3358                    <t>/ LOAD SP load_instruction
3359                    </t>
3360                    <t>/ REMOVE SP CHANNEL SP sampler_channel
3361                    </t>
3362                    <t>/ SET SP set_instruction
3363                    </t>
3364                    <t>/ SUBSCRIBE SP subscribe_event
3365                    </t>
3366                    <t>/ UNSUBSCRIBE SP unsubscribe_event
3367                    </t>
3368                    <t>/ SELECT SP text
3369                    </t>
3370                    <t>/ RESET SP CHANNEL SP sampler_channel
3371                    </t>
3372                    <t>/ RESET
3373                    </t>
3374                    <t>/ QUIT
3375                    </t>
3376            </list>
3377    </t>
3378    <t>subscribe_event =
3379            <list>
3380                    <t>CHANNEL_COUNT
3381                    </t>
3382                    <t>/ VOICE_COUNT
3383                    </t>
3384                    <t>/ STREAM_COUNT
3385                    </t>
3386                    <t>/ BUFFER_FILL
3387                    </t>
3388                    <t>/ CHANNEL_INFO
3389                    </t>
3390                    <t>/ MISCELLANEOUS
3391                    </t>
3392            </list>
3393    </t>
3394    <t>unsubscribe_event =
3395            <list>
3396                    <t>CHANNEL_COUNT
3397                    </t>
3398                    <t>/ VOICE_COUNT
3399                    </t>
3400                    <t>/ STREAM_COUNT
3401                    </t>
3402                    <t>/ BUFFER_FILL
3403                    </t>
3404                    <t>/ CHANNEL_INFO
3405                    </t>
3406                    <t>/ MISCELLANEOUS
3407                    </t>
3408            </list>
3409    </t>
3410    <t>get_instruction =
3411            <list>
3412                    <t>AVAILABLE_ENGINES
3413                    </t>
3414                    <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
3415                    </t>
3416                    <t>/ MIDI_INPUT_DRIVER SP INFO SP string
3417                    </t>
3418                    <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
3419                    </t>
3420                    <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
3421                    </t>
3422                    <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
3423                    </t>
3424                    <t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string
3425                    </t>
3426                    <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
3427                    </t>
3428                    <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
3429                    </t>
3430                    <t>/ AUDIO_OUTPUT_DEVICES
3431                    </t>
3432                    <t>/ MIDI_INPUT_DEVICES
3433                    </t>
3434                    <t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number
3435                    </t>
3436                    <t>/ MIDI_INPUT_DEVICE SP INFO SP number
3437                    </t>
3438                    <t>/ MIDI_INPUT_PORT SP INFO SP number SP number
3439                    </t>
3440                    <t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
3441                    </t>
3442                    <t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
3443                    </t>
3444                    <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string
3445                    </t>
3446                    <t>/ CHANNELS
3447                    </t>
3448                    <t>/ CHANNEL SP INFO SP sampler_channel
3449                    </t>
3450                    <t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
3451                    </t>
3452                    <t>/ CHANNEL SP STREAM_COUNT SP sampler_channel
3453                    </t>
3454                    <t>/ CHANNEL SP VOICE_COUNT SP sampler_channel
3455                    </t>
3456                    <t>/ ENGINE SP INFO SP engine_name
3457                    </t>
3458                    <t>/ SERVER SP INFO
3459                    </t>
3460            </list>
3461    </t>
3462    <t>set_instruction =
3463            <list>
3464                    <t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
3465                    </t>
3466                    <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list
3467                    </t>
3468                    <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
3469                    </t>
3470                    <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
3471                    </t>
3472                    <t>/ CHANNEL SP set_chan_instruction
3473                    </t>
3474                    <t>/ ECHO SP boolean
3475                    </t>
3476            </list>
3477    </t>
3478    <t>create_instruction =
3479            <list>
3480                    <t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list
3481                    </t>
3482                    <t>/ AUDIO_OUTPUT_DEVICE SP string
3483                    </t>
3484                    <t>/ MIDI_INPUT_DEVICE SP string SP key_val_list
3485                    </t>
3486                    <t>/ MIDI_INPUT_DEVICE SP string
3487                    </t>
3488            </list>
3489    </t>
3490    <t>destroy_instruction =
3491            <list>
3492                    <t>AUDIO_OUTPUT_DEVICE SP number
3493                    </t>
3494                    <t>/ MIDI_INPUT_DEVICE SP number
3495                    </t>
3496            </list>
3497    </t>
3498    <t>load_instruction =
3499            <list>
3500                    <t>INSTRUMENT SP load_instr_args
3501                    </t>
3502                    <t>/ ENGINE SP load_engine_args
3503                    </t>
3504            </list>
3505    </t>
3506    <t>set_chan_instruction =
3507            <list>
3508                    <t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
3509                    </t>
3510                    <t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index
3511                    </t>
3512                    <t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
3513                    </t>
3514                    <t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index
3515                    </t>
3516                    <t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index
3517                    </t>
3518                    <t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
3519                    </t>
3520                    <t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index
3521                    </t>
3522                    <t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
3523                    </t>
3524                    <t>/ VOLUME SP sampler_channel SP volume_value
3525                    </t>
3526            </list>
3527    </t>
3528    <t>key_val_list =
3529            <list>
3530                    <t>string '=' param_val_list
3531                    </t>
3532                    <t>/ key_val_list SP string '=' param_val_list
3533                    </t>
3534            </list>
3535    </t>
3536    <t>buffer_size_type =
3537            <list>
3538                    <t>BYTES
3539                    </t>
3540                    <t>/ PERCENTAGE
3541                    </t>
3542            </list>
3543    </t>
3544    <t>list_instruction =
3545            <list>
3546                    <t>AUDIO_OUTPUT_DEVICES
3547                    </t>
3548                    <t>/ MIDI_INPUT_DEVICES
3549                    </t>
3550                    <t>/ CHANNELS
3551                    </t>
3552                    <t>/ AVAILABLE_ENGINES
3553                    </t>
3554                    <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
3555                    </t>
3556                    <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
3557                    </t>
3558            </list>
3559    </t>
3560    <t>load_instr_args =
3561            <list>
3562                    <t>filename SP instrument_index SP sampler_channel
3563                    </t>
3564                    <t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel
3565                    </t>
3566            </list>
3567    </t>
3568    <t>load_engine_args =
3569            <list>
3570                    <t>engine_name SP sampler_channel
3571                    </t>
3572            </list>
3573    </t>
3574    <t>device_index =
3575            <list>
3576                    <t>number
3577                    </t>
3578            </list>
3579    </t>
3580    <t>audio_channel_index =
3581            <list>
3582                    <t>number
3583                    </t>
3584            </list>
3585    </t>
3586    <t>audio_output_type_name =
3587            <list>
3588                    <t>string
3589                    </t>
3590            </list>
3591    </t>
3592    <t>midi_input_port_index =
3593            <list>
3594                    <t>number
3595                    </t>
3596            </list>
3597    </t>
3598    <t>midi_input_channel_index =
3599            <list>
3600                    <t>number
3601                    </t>
3602                    <t>/ ALL
3603                    </t>
3604            </list>
3605    </t>
3606    <t>midi_input_type_name =
3607            <list>
3608                    <t>string
3609                    </t>
3610            </list>
3611    </t>
3612    <t>volume_value =
3613            <list>
3614                    <t>dotnum
3615                    </t>
3616                    <t>/ number
3617                    </t>
3618            </list>
3619    </t>
3620    <t>sampler_channel =
3621            <list>
3622                    <t>number
3623                    </t>
3624            </list>
3625    </t>
3626    <t>instrument_index =
3627            <list>
3628                    <t>number
3629                    </t>
3630            </list>
3631    </t>
3632    <t>engine_name =
3633            <list>
3634                    <t>string
3635                    </t>
3636            </list>
3637    </t>
3638    <t>filename =
3639            <list>
3640                    <t>stringval
3641                    </t>
3642            </list>
3643    </t>
3644    <t>param_val_list =
3645            <list>
3646                    <t>param_val
3647                    </t>
3648                    <t>/ param_val_list','param_val
3649                    </t>
3650            </list>
3651    </t>
3652    <t>param_val =
3653            <list>
3654                    <t>string
3655                    </t>
3656                    <t>/ '\'' string '\''
3657                    </t>
3658                    <t>/ '\"' string '\"'
3659                    </t>
3660                    <t>/ number
3661                    </t>
3662                    <t>/ dotnum
3663                    </t>
3664            </list>
3665    </t>
3666    
3667                <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
3668          </section>          </section>
3669    
3670          <section title="Events" anchor="events">          <section title="Events" anchor="events">
# Line 3170  Schoenebeck'> Line 3675  Schoenebeck'>
3675                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
3676                  <t>                  <t>
3677                      <list>                      <list>
3678                          <t>SUBSCRIBE CHANNELS</t>                          <t>SUBSCRIBE CHANNEL_COUNT</t>
3679                      </list>                      </list>
3680                  </t>                  </t>
3681                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
3682                  <t>                  <t>
3683                      <list>                      <list>
3684                          <t>"NOTIFY:CHANNELS:&lt;channels&gt;"</t>                          <t>"NOTIFY:CHANNEL_COUNT:&lt;channels&gt;"</t>
3685                      </list>                      </list>
3686                  </t>                  </t>
3687                  <t>where &lt;channels&gt; will be replaced by the new number                  <t>where &lt;channels&gt; will be replaced by the new number
# Line 3244  Schoenebeck'> Line 3749  Schoenebeck'>
3749    
3750              <section title="Channel information changed" anchor="SUBSCRIBE INFO">              <section title="Channel information changed" anchor="SUBSCRIBE INFO">
3751                  <t>Client may want to be notified when changes were made to sampler channels on the                  <t>Client may want to be notified when changes were made to sampler channels on the
3752                  back-end changes by issuing the following command:</t>                  back-end by issuing the following command:</t>
3753                  <t>                  <t>
3754                      <list>                      <list>
3755                          <t>SUBSCRIBE INFO</t>                          <t>SUBSCRIBE CHANNEL_INFO</t>
3756                      </list>                      </list>
3757                  </t>                  </t>
3758                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
3759                  <t>                  <t>
3760                      <list>                      <list>
3761                          <t>"NOTIFY:INFO:&lt;sampler-channel&gt;"</t>                          <t>"NOTIFY:CHANNEL_INFO:&lt;sampler-channel&gt;"</t>
3762                      </list>                      </list>
3763                  </t>                  </t>
3764                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
# Line 3300  Schoenebeck'> Line 3805  Schoenebeck'>
3805                      <t>Rui Nuno Capela</t>                      <t>Rui Nuno Capela</t>
3806                      <t>Vladimir Senkov</t>                      <t>Vladimir Senkov</t>
3807                      <t>Mark Knecht</t>                      <t>Mark Knecht</t>
3808                        <t>Grigor Iliev</t>
3809                  </list>                  </list>
3810              </t>              </t>
3811          </section>          </section>
# Line 3307  Schoenebeck'> Line 3813  Schoenebeck'>
3813      </middle>      </middle>
3814    
3815      <back>      <back>
3816          <references>&rfc2119;</references>          <references>
3817                <reference anchor="RFC2119">
3818                    <front>
3819                        <title>Key words for use in RFCs to Indicate Requirement Levels</title>
3820                        <author initials="S." surname="Bradner" fullname="Scott Bradner">
3821                            <organization>Harvard University</organization>
3822                        </author>
3823                        <date year="1997"></date>
3824                    </front>
3825                    <seriesInfo name="RFC" value="2119" />
3826                </reference>
3827                <reference anchor="RFC793">
3828                    <front>
3829                        <title>TRANSMISSION CONTROL PROTOCOL</title>
3830                        <author>
3831                            <organization>Defense Advanced Research Projects Agency</organization>
3832                        </author>
3833                        <date year="1981"></date>
3834                    </front>
3835                    <seriesInfo name="RFC" value="793" />
3836                </reference>
3837                <reference anchor="RFC2234">
3838                    <front>
3839                        <title>Augmented BNF for Syntax Specifications</title>
3840                        <author initials="D.H." surname="Crocker" fullname="David H. Crocker">
3841                            <organization>Internet Mail Consortium</organization>
3842                        </author>
3843                        <author initials="P." surname="Overell" fullname="Paul Overell">
3844                            <organization>Demon Internet Ltd</organization>
3845                        </author>
3846                        <date year="1997"></date>
3847                    </front>
3848                    <seriesInfo name="RFC" value="2234" />
3849                </reference>
3850             </references>
3851      </back>      </back>
3852    
3853  </rfc>  </rfc>
Legend:
Removed from v.542  
changed lines
  Added in v.575
  ViewVC Help
Powered by ViewVC