/[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 377 by senkov, Sun Feb 13 00:10:53 2005 UTC revision 494 by schoenebeck, Wed Apr 6 19:24:39 2005 UTC
# Line 216  Schoenebeck'> Line 216  Schoenebeck'>
216                      <warning-message> and <error-message> are                      <warning-message> and <error-message> are
217                      human readable descriptions of the warning or error                      human readable descriptions of the warning or error
218                      respectively.</t>                      respectively.</t>
219                        <t>Examples:</t>
220                        <t>
221                            <list>
222                                <t>C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0</t>
223                                <t>S: "WRN:32:This is a 24 bit patch which is not supported natively yet."</t>
224                            </list>
225                        </t>
226                        <t>
227                            <list>
228                                <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"</t>
229                                <t>S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter 'EAR'."</t>
230                            </list>
231                        </t>
232                        <t>
233                            <list>
234                                <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"</t>
235                                <t>S: "ERR:9:There is no audio output device with index 123456."</t>
236                            </list>
237                        </t>                    
238                      <t>Normal result sets could be:</t>                      <t>Normal result sets could be:</t>
239                      <t>                      <t>
240                          <list style="numbers">                          <list style="numbers">
# Line 234  Schoenebeck'> Line 253  Schoenebeck'>
253                              <t>"OK"</t>                              <t>"OK"</t>
254                          </list>                          </list>
255                      </t>                      </t>
256                        <t>Example:</t>
257                        <t>
258                            <list>
259                                <t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"</t>
260                                <t>S: "OK"</t>
261                            </list>
262                        </t>
263                      <t>Single line result sets are command specific. One                      <t>Single line result sets are command specific. One
264                      example of a single line result set is an empty line.                      example of a single line result set is an empty line.
265                      Multi-line result sets are command specific and may                      Multi-line result sets are command specific and may
# Line 244  Schoenebeck'> Line 270  Schoenebeck'>
270                              <t>"."</t>                              <t>"."</t>
271                          </list>                          </list>
272                      </t>                      </t>
273                        <t>Example:</t>
274                        <t>
275                            <list>
276                                <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t>
277                                <t>S: "DRIVER: ALSA"</t>
278                                <t>&nbsp;&nbsp;&nbsp;"CHANNELS: 2"</t>
279                                <t>&nbsp;&nbsp;&nbsp;"SAMPLERATE: 44100"</t>
280                                <t>&nbsp;&nbsp;&nbsp;"ACTIVE: true"</t>
281                                <t>&nbsp;&nbsp;&nbsp;"FRAGMENTS: 2"</t>
282                                <t>&nbsp;&nbsp;&nbsp;"FRAGMENTSIZE: 128"</t>
283                                <t>&nbsp;&nbsp;&nbsp;"CARD: '0,0'"</t>
284                                <t>&nbsp;&nbsp;&nbsp;"."</t>
285                            </list>
286                        </t>
287                      <t>In addition to above mentioned formats, warnings and                      <t>In addition to above mentioned formats, warnings and
288                      empty result sets MAY be indexed. In this case, they                      empty result sets MAY be indexed. In this case, they
289                      have the following formats respectively:</t>                      have the following formats respectively:</t>
# Line 258  Schoenebeck'> Line 298  Schoenebeck'>
298                      related to or other integer value.</t>                      related to or other integer value.</t>
299                      <t>Each line of the result set MUST end with                      <t>Each line of the result set MUST end with
300                      &lt;CRLF&gt;.</t>                      &lt;CRLF&gt;.</t>
301                        <t>Examples:</t>
302                        <t>
303                            <list>
304                                <t>C: "ADD CHANNEL"</t>
305                                <t>S: "OK[12]"</t>
306                            </list>
307                        </t>
308                        <t>
309                            <list>
310                                <t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"</t>
311                                <t>S: "WRN[0]:32:Sample rate not supported, using 44100 instead."</t>
312                            </list>
313                        </t>
314                  </section>                  </section>
315              </section>              </section>
316              <section title="Subscribe/notify communication method">              <section title="Subscribe/notify communication method">
# Line 542  Schoenebeck'> Line 595  Schoenebeck'>
595                      <t>                      <t>
596                          <list>                          <list>
597                              <t>LinuxSampler will answer by sending a                              <t>LinuxSampler will answer by sending a
598                              &lz;CRLF&gt; separated list.                              &lt;CRLF&gt; separated list.
599                              Each answer line begins with the information category name                              Each answer line begins with the information category name
600                              followed by a colon and then a space character &lt;SP&gt; and                              followed by a colon and then a space character &lt;SP&gt; and
601                              finally                              finally
# Line 647  Schoenebeck'> Line 700  Schoenebeck'>
700                                </list>                                </list>
701                              </t>                              </t>
702    
703                              <t>POSSIBILITES -                              <t>POSSIBILITIES -
704                                <list>                                <list>
705                                  <t>comma separated list of possible values for this                                  <t>comma separated list of possible values for this
706                                  parameter, character strings are encapsulated into                                  parameter, character strings are encapsulated into
# Line 670  Schoenebeck'> Line 723  Schoenebeck'>
723                              <t>&nbsp;&nbsp;&nbsp;"FIX: true"</t>                              <t>&nbsp;&nbsp;&nbsp;"FIX: true"</t>
724                              <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>                              <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>
725                              <t>&nbsp;&nbsp;&nbsp;"DEFAULT: '0,0'"</t>                              <t>&nbsp;&nbsp;&nbsp;"DEFAULT: '0,0'"</t>
726                              <t>&nbsp;&nbsp;&nbsp;"POSSIBILITES: '0,0','1,0','2,0'"</t>                              <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: '0,0','1,0','2,0'"</t>
727                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
728                          </list>                          </list>
729                      </t>                      </t>
# Line 859  Schoenebeck'> Line 912  Schoenebeck'>
912                              <t>GET AUDIO_OUTPUT_DEVICE INFO &lt;device-id&gt;</t>                              <t>GET AUDIO_OUTPUT_DEVICE INFO &lt;device-id&gt;</t>
913                          </list>                          </list>
914                      </t>                      </t>
915                      <t>Where &lt;device-id&gt; should be replaced by be numerical ID                      <t>Where &lt;device-id&gt; should be replaced by numerical ID
916                      of the audio output device as e.g. returned by the                      of the audio output device as e.g. returned by the
917                      "GET AUDIO_OUTPUT_DEVICES" command.</t>                      "LIST AUDIO_OUTPUT_DEVICES" command.</t>
918                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
919                      <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.                      <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
920                      Each answer line begins with the information category name                      Each answer line begins with the information category name
# Line 1003  Schoenebeck'> Line 1056  Schoenebeck'>
1056                                      </t>                                      </t>
1057                                      <t>MIX_CHANNEL_DESTINATION -                                      <t>MIX_CHANNEL_DESTINATION -
1058                                          <list>                                          <list>
1059                                              <t>reflects the real audio channel (of the same audio                                              <t>numerical ID (positive integer including 0)
1060                                                which reflects the real audio channel (of the same audio
1061                                              output device) this mix channel refers to, means where                                              output device) this mix channel refers to, means where
1062                                              the audio signal actually will be routed / added to                                              the audio signal actually will be routed / added to
1063                                              (only returned in case the audio channel is mix channel)</t>                                              (only returned in case the audio channel is mix channel)</t>
# Line 1137  Schoenebeck'> Line 1191  Schoenebeck'>
1191                                              parameter)</t>                                              parameter)</t>
1192                                          </list>                                          </list>
1193                                      </t>                                      </t>
1194                                      <t>POSSIBILITES -                                      <t>POSSIBILITIES -
1195                                          <list>                                          <list>
1196                                              <t>comma separated list of possible values for this                                              <t>comma separated list of possible values for this
1197                                              parameter, character strings are encapsulated into                                              parameter, character strings are encapsulated into
# Line 1159  Schoenebeck'> Line 1213  Schoenebeck'>
1213                              <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>                              <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>
1214                              <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>                              <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
1215                              <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"</t>                              <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"</t>
1216                              <t>&nbsp;&nbsp;&nbsp;"POSSIBILITES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t>                              <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t>
1217                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
1218                          </list>                          </list>
1219                      </t>                      </t>
# Line 1441  Schoenebeck'> Line 1495  Schoenebeck'>
1495                                </list>                                </list>
1496                              </t>                              </t>
1497    
1498                              <t>POSSIBILITES -                              <t>POSSIBILITIES -
1499                                <list>                                <list>
1500                                  <t>comma separated list of possible values for this                                  <t>comma separated list of possible values for this
1501                                  parameter, character strings are encapsulated into                                  parameter, character strings are encapsulated into
# Line 1670  Schoenebeck'> Line 1724  Schoenebeck'>
1724                      </t>                      </t>
1725                  </section>                  </section>
1726    
1727                  <section title="Changing settings of audio output devices">                  <section title="Changing settings of MIDI input devices">
1728                      <t>Use the following command to alter a specific setting of a created MIDI input device:</t>                      <t>Use the following command to alter a specific setting of a created MIDI input device:</t>
1729                      <t>                      <t>
1730                          <list>                          <list>
# Line 1707  Schoenebeck'> Line 1761  Schoenebeck'>
1761                      <t>Example:</t>                      <t>Example:</t>
1762                      <t>                      <t>
1763                          <list>                          <list>
1764                              <t>C: "SET MIDI_INPUT_DEVICE PARAMETER 0 ACTIVE=false"</t>                              <t>C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"</t>
1765                              <t>S: "OK"</t>                              <t>S: "OK"</t>
1766                          </list>                          </list>
1767                      </t>                      </t>
# Line 1764  Schoenebeck'> Line 1818  Schoenebeck'>
1818                      </t>                      </t>
1819    
1820                      <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
1821                      by the "GET MIDI_INPUT_DEVICES" command, &lt;port&gt; the MIDI port number and                      by the "LIST MIDI_INPUT_DEVICES" command, &lt;port&gt; the MIDI port number and
1822                      &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
1823                      obtained (as returned by the "GET MIDI_INPUT_PORT INFO" command).</t>                      obtained (as returned by the "GET MIDI_INPUT_PORT INFO" command).</t>
1824    
# Line 1829  Schoenebeck'> Line 1883  Schoenebeck'>
1883                                      parameter)</t>                                      parameter)</t>
1884                                  </list>                                  </list>
1885                              </t>                              </t>
1886                              <t>POSSIBILITES -                              <t>POSSIBILITIES -
1887                                  <list>                                  <list>
1888                                      <t>comma separated list of possible values for this                                      <t>comma separated list of possible values for this
1889                                      parameter, character strings are encapsulated into                                      parameter, character strings are encapsulated into
# Line 1851  Schoenebeck'> Line 1905  Schoenebeck'>
1905                              <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>                              <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>
1906                              <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>                              <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
1907                              <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"</t>                              <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"</t>
1908                              <t>&nbsp;&nbsp;&nbsp;"POSSIBILITES: '64:0','68:0','68:1'"</t>                              <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: '64:0','68:0','68:1'"</t>
1909                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
1910                          </list>                          </list>
1911                      </t>                      </t>
# Line 1970  Schoenebeck'> Line 2024  Schoenebeck'>
2024                          </list>                          </list>
2025                      </t>                      </t>
2026    
2027                      <t>Where &lt;engine-name&gt; is usually the C++ class name of the engine                      <t>Where &lt;engine-name&gt; is an engine name as obtained by the
2028                      implementation and &lt;sampler-channel&gt; the sampler channel the                      "GET AVAILABLE_ENGINES" command and &lt;sampler-channel&gt; the sampler channel the
2029                      deployed engine should be assigned to. Even if the respective                      deployed engine should be assigned to. Even if the respective
2030                      sampler channel has already a deployed engine with that engine                      sampler channel has already a deployed engine with that engine
2031                      name, a new engine instance will be assigned to the sampler channel.</t>                      name, a new engine instance will be assigned to the sampler channel.</t>
# Line 2162  Schoenebeck'> Line 2216  Schoenebeck'>
2216                      <t>                      <t>
2217                          <list>                          <list>
2218                              <t>LinuxSampler will answer by sending a comma separated character                              <t>LinuxSampler will answer by sending a comma separated character
2219                              string of the engines' C++ class names.</t>                              string of the engines' names. Engine names can consist of lower and
2220                                upper cases, digits and underlines ("_" character).</t>
2221                          </list>                          </list>
2222                      </t>                      </t>
2223                      <t>Example:</t>                      <t>Example:</t>
# Line 2182  Schoenebeck'> Line 2237  Schoenebeck'>
2237                              <t>GET ENGINE INFO &lt;engine-name&gt;</t>                              <t>GET ENGINE INFO &lt;engine-name&gt;</t>
2238                          </list>                          </list>
2239                      </t>                      </t>
2240                      <t>Where &lt;engine-name&gt; is usually the C++ class name of the engine implementation.</t>                      <t>Where &lt;engine-name&gt; is an engine name as obtained by the
2241                        "GET AVAILABLE_ENGINES" command.</t>
2242                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2243                      <t>                      <t>
2244                          <list>                          <list>
2245                              <t>LinuxSampler will answer by sending &lt;&gt; separated list.                              <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
2246                              Each answer line begins with the information category name                              Each answer line begins with the information category name
2247                              followed by a colon and then a space character &lt;SP&gt; and finally                              followed by a colon and then a space character &lt;SP&gt; and finally
2248                              the info character string to that info category. At the moment                              the info character string to that info category. At the moment

Legend:
Removed from v.377  
changed lines
  Added in v.494

  ViewVC Help
Powered by ViewVC