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

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

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

revision 561 by schoenebeck, Sat May 21 20:01:32 2005 UTC revision 571 by schoenebeck, Mon May 23 17:41:34 2005 UTC
# 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 rule:
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 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 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 2384  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 2398  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 2513  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 2538  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 2572  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 2616  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 2701  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 2744  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 3157  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 settings 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    
# Line 3312  Schoenebeck'> Line 3449  Schoenebeck'>
3449      </middle>      </middle>
3450    
3451      <back>      <back>
3452          <references>&rfc2119;</references>          <references>
3453                <reference anchor="RFC2119">
3454                    <front>
3455                        <title>Key words for use in RFCs to Indicate Requirement Levels</title>
3456                        <author initials="S." surname="Bradner" fullname="Scott Bradner">
3457                            <organization>Harvard University</organization>
3458                        </author>
3459                        <date year="1997"></date>
3460                    </front>
3461                    <seriesInfo name="RFC" value="2119" />
3462                    <seriesInfo name="STD" value="1" />
3463                </reference>
3464                <reference anchor="RFC793">
3465                    <front>
3466                        <title>TRANSMISSION CONTROL PROTOCOL</title>
3467                        <author>
3468                            <organization>Defense Advanced Research Projects Agency</organization>
3469                        </author>
3470                        <date year="1981"></date>
3471                    </front>
3472                    <seriesInfo name="RFC" value="793" />
3473                    <seriesInfo name="STD" value="1" />
3474                </reference>
3475             </references>
3476      </back>      </back>
3477    
3478  </rfc>  </rfc>
Legend:
Removed from v.561  
changed lines
  Added in v.571
  ViewVC Help
Powered by ViewVC