/[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 499 by schoenebeck, Fri Apr 15 11:54:22 2005 UTC revision 534 by schoenebeck, Mon May 9 17:40:33 2005 UTC
# Line 31  Schoenebeck'> Line 31  Schoenebeck'>
31                  <email>schoenebeck at software minus engineering dot org</email>                  <email>schoenebeck at software minus engineering dot org</email>
32              </address>              </address>
33          </author>          </author>
34          <date month="Apr" year="2005"/>          <date month="May" year="2005"/>
35          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
36          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
37          <abstract>          <abstract>
# Line 379  Schoenebeck'> Line 379  Schoenebeck'>
379    
380                  <t>where &lt;event-id&gt; will be replace by the respective                  <t>where &lt;event-id&gt; will be replace by the respective
381                  event that client is no longer interested in receiving. For                  event that client is no longer interested in receiving. For
382                  a list of supported events see chapter 6.</t>                  a list of supported events see <xref target="events" />.</t>
383    
384                  <t>Example: the fill states of disk stream buffers have                  <t>Example: the fill states of disk stream buffers have
385                  changed on sampler channel 4 and the LinuxSampler instance                  changed on sampler channel 4 and the LinuxSampler instance
# Line 428  Schoenebeck'> Line 428  Schoenebeck'>
428          <section title="Description for control commands">          <section title="Description for control commands">
429              <t>This chapter will describe the available control commands              <t>This chapter will describe the available control commands
430              that can be sent on the TCP connection in detail. Some certain              that can be sent on the TCP connection in detail. Some certain
431              commands (e.g. "GET CHANNEL INFO" or "GET ENGINE INFO") lead to              commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref>
432                or <xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref>) lead to
433              multiple-line responses. In this case LinuxSampler signals the              multiple-line responses. In this case LinuxSampler signals the
434              end of the response by a "." (single dot) line.</t>              end of the response by a "." (single dot) line.</t>
435    
# Line 472  Schoenebeck'> Line 473  Schoenebeck'>
473                  what parameters drivers are offering, how to retrieve their                  what parameters drivers are offering, how to retrieve their
474                  possible values, etc.</t>                  possible values, etc.</t>
475    
476                  <section title="Getting all available audio output drivers">                  <section title="Getting amount of available audio output drivers" anchor="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">
477                        <t>Use the following command to get the number of
478                        audio output drivers currently available for the
479                        LinuxSampler instance:</t>
480                        <t>
481                            <list>
482                                <t>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS</t>
483                            </list>
484                        </t>
485                        <t>Possible Answers:</t>
486                        <t>
487                            <list>
488                                <t>LinuxSampler will answer by sending the
489                                number of audio output drivers.</t>
490                            </list>
491                        </t>
492                        <t>Example:</t>
493                        <t>
494                            <list>
495                                <t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t>
496                                <t>S: "2"</t>
497                            </list>
498                        </t>
499                    </section>
500    
501                    <section title="Getting all available audio output drivers" anchor="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
502                      <t>Use the following command to list all audio output                      <t>Use the following command to list all audio output
503                      drivers currently available for the LinuxSampler                      drivers currently available for the LinuxSampler
504                      instance:</t>                      instance:</t>
505                      <t>                      <t>
506                          <list>                          <list>
507                              <t>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS</t>                              <t>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS</t>
508                          </list>                          </list>
509                      </t>                      </t>
510                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 492  Schoenebeck'> Line 518  Schoenebeck'>
518                      <t>Example:</t>                      <t>Example:</t>
519                      <t>                      <t>
520                          <list>                          <list>
521                              <t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t>                              <t>C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t>
522                              <t>S: "ALSA,JACK"</t>                              <t>S: "ALSA,JACK"</t>
523                          </list>                          </list>
524                      </t>                      </t>
525                  </section>                  </section>
526    
527                  <section title="Getting information about a specific audio                  <section title="Getting information about a specific audio
528                  output driver">                  output driver" anchor="GET AUDIO_OUTPUT_DRIVER INFO">
529                      <t>Use the following command to get detailed information                      <t>Use the following command to get detailed information
530                      about a specific audio output driver:</t>                      about a specific audio output driver:</t>
531                      <t>                      <t>
# Line 509  Schoenebeck'> Line 535  Schoenebeck'>
535                          </list>                          </list>
536                      </t>                      </t>
537                      <t>Where &lt;audio-output-driver&gt; is the name of the                      <t>Where &lt;audio-output-driver&gt; is the name of the
538                      audio output driver, returned by the "GET                      audio output driver, returned by the
539                      AVAILABLE_AUDIO_OUTPUT_DRIVERS" command.</t>                      <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command.</t>
540                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
541                      <t>                      <t>
542                          <list>                          <list>
# Line 572  Schoenebeck'> Line 598  Schoenebeck'>
598                  </section>                  </section>
599    
600                  <section title="Getting information about specific audio                  <section title="Getting information about specific audio
601                  output driver parameter">                  output driver parameter" anchor="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">
602                      <t>Use the following command to get detailed information                      <t>Use the following command to get detailed information
603                      about a  specific audio output driver parameter:</t>                      about a  specific audio output driver parameter:</t>
604                      <t>                      <t>
# Line 581  Schoenebeck'> Line 607  Schoenebeck'>
607                          </list>                          </list>
608                      </t>                      </t>
609                      <t>Where &lt;audio&gt; is the name of the audio output                      <t>Where &lt;audio&gt; is the name of the audio output
610                      driver as returned by the "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS" command,                      driver as returned by the <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
611                        "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command,
612                      &lt;prm&gt; a specific parameter name for which information should be                      &lt;prm&gt; a specific parameter name for which information should be
613                      obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO" command) and                      obtained (as returned by the
614                        <xref target="GET AUDIO_OUTPUT_DRIVER INFO">"GET AUDIO_OUTPUT_DRIVER INFO"</xref> command) and
615                      &lt;deplist&gt; is an optional list of parameters on which the sought                      &lt;deplist&gt; is an optional list of parameters on which the sought
616                      parameter &lt;prm&gt; depends on, &lt;deplist&gt; is a list of key-value                      parameter &lt;prm&gt; depends on, &lt;deplist&gt; is a list of key-value
617                      pairs in form of "key1=val1 key2=val2 ...", where character string values                      pairs in form of "key1=val1 key2=val2 ...", where character string values
# Line 630  Schoenebeck'> Line 658  Schoenebeck'>
658                                <list>                                <list>
659                                  <t>either true or false, defines if this parameter must be                                  <t>either true or false, defines if this parameter must be
660                                  given when the device is to be created with the                                  given when the device is to be created with the
661                                  'CREATE AUDIO_OUTPUT_DEVICE' command                                  <xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref>
662                                  (always returned, no matter which driver parameter)</t>                                  command (always returned, no matter which driver parameter)</t>
663                                </list>                                </list>
664                              </t>                              </t>
665    
# Line 639  Schoenebeck'> Line 667  Schoenebeck'>
667                                <list>                                <list>
668                                  <t>either true or false, if false then this parameter can                                  <t>either true or false, if false then this parameter can
669                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
670                                  the 'CREATE AUDIO_OUTPUT_DEVICE' command                                  the <xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref>
671                                  (always returned, no matter which driver parameter)</t>                                  command (always returned, no matter which driver parameter)</t>
672                                </list>                                </list>
673                              </t>                              </t>
674    
# Line 672  Schoenebeck'> Line 700  Schoenebeck'>
700                                <list>                                <list>
701                                  <t>reflects the default value for this parameter which is                                  <t>reflects the default value for this parameter which is
702                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
703                                  given with the 'CREATE AUDIO_OUTPUT_DEVICE' command,                                  given with the <xref target="CREATE AUDIO_OUTPUT_DEVICE">
704                                    'CREATE AUDIO_OUTPUT_DEVICE'</xref> command,
705                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
706                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
707                                  apostrophes (')                                  apostrophes (')
# Line 757  Schoenebeck'> Line 786  Schoenebeck'>
786                      </t>                      </t>
787                  </section>                  </section>
788    
789                  <section title="Creating an audio output device">                  <section title="Creating an audio output device" anchor="CREATE AUDIO_OUTPUT_DEVICE">
790                      <t>Use the following command to create a new audio output device for  the desired audio output system:</t>                      <t>Use the following command to create a new audio output device for  the desired audio output system:</t>
791    
792                      <t>                      <t>
# Line 815  Schoenebeck'> Line 844  Schoenebeck'>
844                      </t>                      </t>
845                  </section>                  </section>
846    
847                  <section title="Destroying an audio output device">                  <section title="Destroying an audio output device" anchor="DESTROY AUDIO_OUTPUT_DEVICE">
848                      <t>Use the following command to destroy a created output device:</t>                      <t>Use the following command to destroy a created output device:</t>
849                      <t>                      <t>
850                          <list>                          <list>
# Line 823  Schoenebeck'> Line 852  Schoenebeck'>
852                          </list>                          </list>
853                      </t>                      </t>
854                      <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
855                      audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE" or                      audio output device as given by the
856                      "GET AUDIO_OUTPUT_DEVICES" command.</t>                      <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
857                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
858                        command.</t>
859                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
860                      <t>                      <t>
861                          <list>                          <list>
# Line 859  Schoenebeck'> Line 890  Schoenebeck'>
890                      </t>                      </t>
891                  </section>                  </section>
892    
893                  <section title="Getting all created audio output device count">                  <section title="Getting all created audio output device count" anchor="GET AUDIO_OUTPUT_DEVICES">
894                      <t>Use the following command to count all created audio output devices:</t>                      <t>Use the following command to count all created audio output devices:</t>
895                      <t>                      <t>
896                          <list>                          <list>
# Line 882  Schoenebeck'> Line 913  Schoenebeck'>
913                      </t>                      </t>
914                  </section>                  </section>
915    
916                  <section title="Getting all created audio output device list">                  <section title="Getting all created audio output device list" anchor="LIST AUDIO_OUTPUT_DEVICES">
917                      <t>Use the following command to list all created audio output devices:</t>                      <t>Use the following command to list all created audio output devices:</t>
918                      <t>                      <t>
919                          <list>                          <list>
# Line 905  Schoenebeck'> Line 936  Schoenebeck'>
936                      </t>                      </t>
937                  </section>                  </section>
938    
939                  <section title="Getting current settings of an audio output device">                  <section title="Getting current settings of an audio output device" anchor="GET AUDIO_OUTPUT_DEVICE INFO">
940                      <t>Use the following command to get current settings of a specific, created audio output device:</t>                      <t>Use the following command to get current settings of a specific, created audio output device:</t>
941                      <t>                      <t>
942                          <list>                          <list>
# Line 914  Schoenebeck'> Line 945  Schoenebeck'>
945                      </t>                      </t>
946                      <t>Where &lt;device-id&gt; should be replaced by numerical ID                      <t>Where &lt;device-id&gt; should be replaced by numerical ID
947                      of the audio output device as e.g. returned by the                      of the audio output device as e.g. returned by the
948                      "LIST AUDIO_OUTPUT_DEVICES" command.</t>                      <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> command.</t>
949                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
950                      <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.                      <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
951                      Each answer line begins with the information category name                      Each answer line begins with the information category name
# Line 928  Schoenebeck'> Line 959  Schoenebeck'>
959                              <t>DRIVER -                              <t>DRIVER -
960                                  <list>                                  <list>
961                                      <t>identifier of the used audio output driver, as also                                      <t>identifier of the used audio output driver, as also
962                                      returned by the "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"                                      returned by the
963                                        <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
964                                        "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref>
965                                      command</t>                                      command</t>
966                                  </list>                                  </list>
967                              </t>                              </t>
# Line 957  Schoenebeck'> Line 990  Schoenebeck'>
990                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
991                      returned by all audio output devices. Every audio output driver                      returned by all audio output devices. Every audio output driver
992                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
993                      "GET AUDIO_OUTPUT_DRIVER INFO" command) which are also returned                      <xref target="GET AUDIO_OUTPUT_DRIVER INFO" />)
994                      by this command.</t>                      which are also returned by this command.</t>
995                      <t>Example:</t>                      <t>Example:</t>
996                      <t>                      <t>
997                          <list>                          <list>
# Line 976  Schoenebeck'> Line 1009  Schoenebeck'>
1009                  </section>                  </section>
1010    
1011    
1012                  <section title="Changing settings of audio output devices">                  <section title="Changing settings of audio output devices" anchor="SET AUDIO_OUTPUT_DEVICE_PARAMETER">
1013                      <t>Use the following command to alter a specific setting of a created audio output device:</t>                      <t>Use the following command to alter a specific setting of a created audio output device:</t>
1014                      <t>                      <t>
1015                          <list>                          <list>
# Line 1018  Schoenebeck'> Line 1051  Schoenebeck'>
1051                      </t>                      </t>
1052                  </section>                  </section>
1053    
1054                  <section title="Getting information about an audio channel">                  <section title="Getting information about an audio channel" anchor="GET AUDIO_OUTPUT_CHANNEL INFO">
1055                      <t>Use the following command to get information about an audio channel:</t>                      <t>Use the following command to get information about an audio channel:</t>
1056                      <t>                      <t>
1057                          <list>                          <list>
# Line 1116  Schoenebeck'> Line 1149  Schoenebeck'>
1149                      </t>                      </t>
1150                  </section>                  </section>
1151    
1152                  <section title="Getting information about specific audio channel parameter">                  <section title="Getting information about specific audio channel parameter" anchor="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO">
1153                      <t>Use the following command to get detailed information about specific audio channel parameter:</t>                      <t>Use the following command to get detailed information about specific audio channel parameter:</t>
1154    
1155                      <t>                      <t>
# Line 1126  Schoenebeck'> Line 1159  Schoenebeck'>
1159                      </t>                      </t>
1160    
1161                      <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
1162                      by the "GET AUDIO_OUTPUT_DEVICES" command, &lt;chan&gt; the audio channel number                      by the <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1163                        command, &lt;chan&gt; the audio channel number
1164                      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
1165                      be obtained (as returned by the "GET AUDIO_OUTPUT_CHANNEL INFO" command).</t>                      be obtained (as returned by the <xref target="GET AUDIO_OUTPUT_CHANNEL INFO">
1166                        "GET AUDIO_OUTPUT_CHANNEL INFO"</xref> command).</t>
1167                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1168    
1169                      <t>                      <t>
# Line 1219  Schoenebeck'> Line 1254  Schoenebeck'>
1254                      </t>                      </t>
1255                  </section>                  </section>
1256    
1257                  <section title="Changing settings of audio output channels">                  <section title="Changing settings of audio output channels" anchor="SET AUDIO_OUTPUT_CHANNEL_PARAMETER">
1258                      <t>Use the following command to alter a specific setting of an audio output channel:</t>                      <t>Use the following command to alter a specific setting of an audio output channel:</t>
1259                      <t>                      <t>
1260                          <list>                          <list>
# Line 1295  Schoenebeck'> Line 1330  Schoenebeck'>
1330                  showing how to retrieve what parameters drivers are offering, how to retrieve their                  showing how to retrieve what parameters drivers are offering, how to retrieve their
1331                  possible values, etc.</t>                  possible values, etc.</t>
1332    
1333                  <section title="Getting all available MIDI input drivers">                  <section title="Getting amount of available MIDI input drivers" anchor="GET AVAILABLE_MIDI_INPUT_DRIVERS">
1334                        <t>Use the following command to get the number of
1335                        MIDI input drivers currently available for the
1336                        LinuxSampler instance:</t>
1337                        <t>
1338                            <list>
1339                                <t>GET AVAILABLE_MIDI_INPUT_DRIVERS</t>
1340                            </list>
1341                        </t>
1342                        <t>Possible Answers:</t>
1343                        <t>
1344                            <list>
1345                                <t>LinuxSampler will answer by sending the
1346                                number of available MIDI input drivers.</t>
1347                            </list>
1348                        </t>
1349                        <t>Example:</t>
1350                        <t>
1351                            <list>
1352                                <t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t>
1353                                <t>S: "2"</t>
1354                            </list>
1355                        </t>
1356                    </section>
1357    
1358                    <section title="Getting all available MIDI input drivers" anchor="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1359                      <t>Use the following command to list all MIDI input drivers currently available                      <t>Use the following command to list all MIDI input drivers currently available
1360                      for the LinuxSampler instance:</t>                      for the LinuxSampler instance:</t>
1361                      <t>                      <t>
1362                          <list>                          <list>
1363                              <t>GET AVAILABLE_MIDI_INPUT_DRIVERS</t>                              <t>LIST AVAILABLE_MIDI_INPUT_DRIVERS</t>
1364                          </list>                          </list>
1365                      </t>                      </t>
1366                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 1313  Schoenebeck'> Line 1373  Schoenebeck'>
1373                      <t>Example:</t>                      <t>Example:</t>
1374                      <t>                      <t>
1375                          <list>                          <list>
1376                              <t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t>                              <t>C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</t>
1377                              <t>S: "ALSA,JACK"</t>                              <t>S: "ALSA,JACK"</t>
1378                          </list>                          </list>
1379                      </t>                      </t>
1380                  </section>                  </section>
1381    
1382                  <section title="Getting information about a specific MIDI input driver">                  <section title="Getting information about a specific MIDI input driver" anchor="GET MIDI_INPUT_DRIVER INFO">
1383                      <t>Use the following command to get detailed information about a specific MIDI input driver:</t>                      <t>Use the following command to get detailed information about a specific MIDI input driver:</t>
1384                      <t>                      <t>
1385                          <list>                          <list>
# Line 1373  Schoenebeck'> Line 1433  Schoenebeck'>
1433                      </t>                      </t>
1434                  </section>                  </section>
1435    
1436                  <section title="Getting information about specific MIDI input driver parameter">                  <section title="Getting information about specific MIDI input driver parameter" anchor="GET MIDI_INPUT_DRIVER_PARAMETER INFO">
1437                      <t>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:</t>                      <t>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:</t>
1438                      <t>                      <t>
1439                          <list>                          <list>
# Line 1382  Schoenebeck'> Line 1442  Schoenebeck'>
1442                      </t>                      </t>
1443    
1444                      <t>Where &lt;midi-t&gt; is the name of the MIDI input driver as returned                      <t>Where &lt;midi-t&gt; is the name of the MIDI input driver as returned
1445                      by the "GET AVAILABLE_MIDI_INPUT_DRIVERS" command, &lt;param&gt; a specific                      by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1446                        "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command, &lt;param&gt; a specific
1447                      parameter name for which information should be obtained (as returned by the                      parameter name for which information should be obtained (as returned by the
1448                      "GET MIDI_INPUT_DRIVER INFO" command) and &lt;deplist&gt; is an optional list                      <xref target="GET MIDI_INPUT_DRIVER INFO">
1449                        "GET MIDI_INPUT_DRIVER INFO"</xref> command) and &lt;deplist&gt; is an optional list
1450                      of parameters on which the sought parameter &lt;param&gt; depends on,                      of parameters on which the sought parameter &lt;param&gt; depends on,
1451                      &lt;deplist&gt; is a key-value pair list in form of "key1=val1 key2=val2 ...",                      &lt;deplist&gt; is a key-value pair list in form of "key1=val1 key2=val2 ...",
1452                      where character string values are encapsulated into apostrophes ('). Arguments                      where character string values are encapsulated into apostrophes ('). Arguments
# Line 1425  Schoenebeck'> Line 1487  Schoenebeck'>
1487                                <list>                                <list>
1488                                  <t>either true or false, defines if this parameter must be                                  <t>either true or false, defines if this parameter must be
1489                                  given when the device is to be created with the                                  given when the device is to be created with the
1490                                  'CREATE MIDI_INPUT_DEVICE' command                                  <xref target="CREATE MIDI_INPUT_DEVICE">
1491                                    'CREATE MIDI_INPUT_DEVICE'</xref> command
1492                                  (always returned, no matter which driver parameter)</t>                                  (always returned, no matter which driver parameter)</t>
1493                                </list>                                </list>
1494                              </t>                              </t>
# Line 1434  Schoenebeck'> Line 1497  Schoenebeck'>
1497                                <list>                                <list>
1498                                  <t>either true or false, if false then this parameter can                                  <t>either true or false, if false then this parameter can
1499                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
1500                                  the 'CREATE MIDI_INPUT_DEVICE' command                                  the <xref target="CREATE MIDI_INPUT_DEVICE">
1501                                    'CREATE MIDI_INPUT_DEVICE'</xref> command
1502                                  (always returned, no matter which driver parameter)</t>                                  (always returned, no matter which driver parameter)</t>
1503                                </list>                                </list>
1504                              </t>                              </t>
# Line 1467  Schoenebeck'> Line 1531  Schoenebeck'>
1531                                <list>                                <list>
1532                                  <t>reflects the default value for this parameter which is                                  <t>reflects the default value for this parameter which is
1533                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
1534                                  given with the 'CREATE MIDI_INPUT_DEVICE' command,                                  given with the <xref target="CREATE MIDI_INPUT_DEVICE">
1535                                    'CREATE MIDI_INPUT_DEVICE'</xref> command,
1536                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
1537                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
1538                                  apostrophes (')                                  apostrophes (')
# Line 1523  Schoenebeck'> Line 1588  Schoenebeck'>
1588                      </t>                      </t>
1589                  </section>                  </section>
1590    
1591                  <section title="Creating a MIDI input device">                  <section title="Creating a MIDI input device" anchor="CREATE MIDI_INPUT_DEVICE">
1592                      <t>Use the following command to create a new MIDI input device for  the desired MIDI input system:</t>                      <t>Use the following command to create a new MIDI input device for  the desired MIDI input system:</t>
1593                      <t>                      <t>
1594                          <list>                          <list>
# Line 1571  Schoenebeck'> Line 1636  Schoenebeck'>
1636                      </t>                      </t>
1637                  </section>                  </section>
1638    
1639                  <section title="Destroying a MIDI input device">                  <section title="Destroying a MIDI input device" anchor="DESTROY MIDI_INPUT_DEVICE">
1640                      <t>Use the following command to destroy a created MIDI input device:</t>                      <t>Use the following command to destroy a created MIDI input device:</t>
1641                      <t>                      <t>
1642                          <list>                          <list>
# Line 1610  Schoenebeck'> Line 1675  Schoenebeck'>
1675                      </t>                      </t>
1676                  </section>                  </section>
1677    
1678                  <section title="Getting all created MIDI input device count">                  <section title="Getting all created MIDI input device count" anchor="GET MIDI_INPUT_DEVICES">
1679                      <t>Use the following command to count all created MIDI input devices:</t>                      <t>Use the following command to count all created MIDI input devices:</t>
1680                      <t>                      <t>
1681                          <list>                          <list>
# Line 1634  Schoenebeck'> Line 1699  Schoenebeck'>
1699                  </section>                  </section>
1700    
1701    
1702                  <section title="Getting all created MIDI input device list">                  <section title="Getting all created MIDI input device list" anchor="LIST MIDI_INPUT_DEVICES">
1703                      <t>Use the following command to list all created MIDI input devices:</t>                      <t>Use the following command to list all created MIDI input devices:</t>
1704                      <t>                      <t>
1705                          <list>                          <list>
# Line 1663  Schoenebeck'> Line 1728  Schoenebeck'>
1728                      </t>                      </t>
1729                  </section>                  </section>
1730    
1731                  <section title="Getting current settings of a MIDI input device">                  <section title="Getting current settings of a MIDI input device" anchor="GET MIDI_INPUT_DEVICE INFO">
1732                      <t>Use the following command to get current settings of a specific, created MIDI input device:</t>                      <t>Use the following command to get current settings of a specific, created MIDI input device:</t>
1733                      <t>                      <t>
1734                          <list>                          <list>
# Line 1687  Schoenebeck'> Line 1752  Schoenebeck'>
1752                                      <t>DRIVER -                                      <t>DRIVER -
1753                                          <list>                                          <list>
1754                                              <t>identifier of the used MIDI input driver, as e.g.                                              <t>identifier of the used MIDI input driver, as e.g.
1755                                              returned by the "GET AVAILABLE_MIDI_INPUT_DRIVERS"                                              returned by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1756                                                "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref>
1757                                              command</t>                                              command</t>
1758                                          </list>                                          </list>
1759                                      </t>                                      </t>
# Line 1710  Schoenebeck'> Line 1776  Schoenebeck'>
1776                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
1777                      returned by all MIDI input devices. Every MIDI input driver                      returned by all MIDI input devices. Every MIDI input driver
1778                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
1779                      "GET MIDI_INPUT_DRIVER INFO" command) which are also returned                      <xref target="GET MIDI_INPUT_DRIVER INFO">
1780                        "GET MIDI_INPUT_DRIVER INFO"</xref> command) which are also returned
1781                      by this command.</t>                      by this command.</t>
1782    
1783                      <t>Example:</t>                      <t>Example:</t>
# Line 1724  Schoenebeck'> Line 1791  Schoenebeck'>
1791                      </t>                      </t>
1792                  </section>                  </section>
1793    
1794                  <section title="Changing settings of MIDI input devices">                  <section title="Changing settings of MIDI input devices" anchor="SET MIDI_INPUT_DEVICE_PARAMETER">
1795                      <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>
1796                      <t>                      <t>
1797                          <list>                          <list>
# Line 1767  Schoenebeck'> Line 1834  Schoenebeck'>
1834                      </t>                      </t>
1835                  </section>                  </section>
1836    
1837                  <section title="Getting information about a MIDI port">                  <section title="Getting information about a MIDI port" anchor="GET MIDI_INPUT_PORT INFO">
1838                      <t>Use the following command to get information about a MIDI port:</t>                      <t>Use the following command to get information about a MIDI port:</t>
1839                      <t>                      <t>
1840                          <list>                          <list>
# Line 1809  Schoenebeck'> Line 1876  Schoenebeck'>
1876                      </t>                      </t>
1877                  </section>                  </section>
1878    
1879                  <section title="Getting information about specific MIDI port parameter">                  <section title="Getting information about specific MIDI port parameter" anchor="GET MIDI_INPUT_PORT_PARAMETER INFO">
1880                      <t>Use the following command to get detailed information about specific MIDI port parameter:</t>                      <t>Use the following command to get detailed information about specific MIDI port parameter:</t>
1881                      <t>                      <t>
1882                          <list>                          <list>
# Line 1818  Schoenebeck'> Line 1885  Schoenebeck'>
1885                      </t>                      </t>
1886    
1887                      <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
1888                      by the "LIST MIDI_INPUT_DEVICES" command, &lt;port&gt; the MIDI port number and                      by the <xref target="LIST MIDI_INPUT_DEVICES">
1889                        "LIST MIDI_INPUT_DEVICES"</xref> command, &lt;port&gt; the MIDI port number and
1890                      &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
1891                      obtained (as returned by the "GET MIDI_INPUT_PORT INFO" command).</t>                      obtained (as returned by the <xref target="GET MIDI_INPUT_PORT INFO">
1892                        "GET MIDI_INPUT_PORT INFO"</xref> command).</t>
1893    
1894                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1895                      <t>                      <t>
# Line 1911  Schoenebeck'> Line 1980  Schoenebeck'>
1980                      </t>                      </t>
1981                  </section>                  </section>
1982    
1983                  <section title="Changing settings of MIDI input ports">                  <section title="Changing settings of MIDI input ports" anchor="SET MIDI_INPUT_PORT_PARAMETER">
1984                      <t>Use the following command to alter a specific setting of a MIDI input port:</t>                      <t>Use the following command to alter a specific setting of a MIDI input port:</t>
1985                      <t>                      <t>
1986                          <list>                          <list>
# Line 1959  Schoenebeck'> Line 2028  Schoenebeck'>
2028                  <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, deploy
2029                  sampler engines, load instruments and connect sampler channels to MIDI and audio devices.</t>                  sampler engines, load instruments and connect sampler channels to MIDI and audio devices.</t>
2030    
2031                  <section title="Loading an instrument">                  <section title="Loading an instrument" anchor="LOAD INSTRUMENT">
2032                      <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>
2033                      <t>                      <t>
2034                          <list>                          <list>
# Line 1977  Schoenebeck'> Line 2046  Schoenebeck'>
2046                      is that the regular command returns OK only after the instrument has been                      is that the regular command returns OK only after the instrument has been
2047                      fully loaded and the channel is ready to be used while NON_MODAL version                      fully loaded and the channel is ready to be used while NON_MODAL version
2048                      returns immediately and a background process is launched to load the instrument                      returns immediately and a background process is launched to load the instrument
2049                      on the channel. GET CHANNEL INFO command can be used to obtain loading                      on the channel. The <xref target="GET CHANNEL INFO">GET CHANNEL INFO</xref>
2050                        command can be used to obtain loading
2051                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks
2052                      such as making sure that the file could be read and it is of a proper format                      such as making sure that the file could be read and it is of a proper format
2053                      and SHOULD return ERR and SHOULD not launch the background process should any                      and SHOULD return ERR and SHOULD not launch the background process should any
# Line 2015  Schoenebeck'> Line 2085  Schoenebeck'>
2085                      </t>                      </t>
2086                  </section>                  </section>
2087    
2088                  <section title="Loading a sampler engine">                  <section title="Loading a sampler engine" anchor="LOAD ENGINE">
2089                      <t>A sample engine can be deployed and assigned to a specific sampler                      <t>A sample engine can be deployed and assigned to a specific sampler
2090                      channel by the following command:</t>                      channel by the following command:</t>
2091                      <t>                      <t>
# Line 2025  Schoenebeck'> Line 2095  Schoenebeck'>
2095                      </t>                      </t>
2096    
2097                      <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
2098                      "GET AVAILABLE_ENGINES" command and &lt;sampler-channel&gt; the sampler channel the                      <xref target="LIST AVAILABLE_ENGINES">
2099                        "LIST AVAILABLE_ENGINES"</xref> command and &lt;sampler-channel&gt; the sampler channel the
2100                      deployed engine should be assigned to. Even if the respective                      deployed engine should be assigned to. Even if the respective
2101                      sampler channel has already a deployed engine with that engine                      sampler channel has already a deployed engine with that engine
2102                      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 2061  Schoenebeck'> Line 2132  Schoenebeck'>
2132                      </t>                      </t>
2133                  </section>                  </section>
2134    
2135                  <section title="Getting all created sampler channel count">                  <section title="Getting all created sampler channel count" anchor="GET CHANNELS">
2136                      <t>The number of sampler channels can change on runtime. To get the                      <t>The number of sampler channels can change on runtime. To get the
2137                      current amount of sampler channels, the front-end can send the                      current amount of sampler channels, the front-end can send the
2138                      following command:</t>                      following command:</t>
# Line 2085  Schoenebeck'> Line 2156  Schoenebeck'>
2156                      </t>                      </t>
2157                  </section>                  </section>
2158    
2159                  <section title="Getting all created sampler channel list">                  <section title="Getting all created sampler channel list" anchor="LIST CHANNELS">
2160                      <t>The number of sampler channels can change on runtime. To get the                      <t>The number of sampler channels can change on runtime. To get the
2161                      current list of sampler channels, the front-end can send the                      current list of sampler channels, the front-end can send the
2162                      following command:</t>                      following command:</t>
# Line 2110  Schoenebeck'> Line 2181  Schoenebeck'>
2181                      </t>                      </t>
2182                  </section>                  </section>
2183    
2184                  <section title="Adding a new sampler channel">                  <section title="Adding a new sampler channel" anchor="ADD CHANNEL">
2185                      <t>A new sampler channel can be added to the end of the sampler                      <t>A new sampler channel can be added to the end of the sampler
2186                      channel list by sending the following command:</t>                      channel list by sending the following command:</t>
2187                      <t>                      <t>
# Line 2162  Schoenebeck'> Line 2233  Schoenebeck'>
2233                      </t>                      </t>
2234                  </section>                  </section>
2235    
2236                  <section title="Removing a sampler channel">                  <section title="Removing a sampler channel" anchor="REMOVE CHANNEL">
2237                      <t>A sampler channel can be removed by sending the following command:</t>                      <t>A sampler channel can be removed by sending the following command:</t>
2238                      <t>                      <t>
2239                          <list>                          <list>
# Line 2205  Schoenebeck'> Line 2276  Schoenebeck'>
2276                      </t>                      </t>
2277                  </section>                  </section>
2278    
2279                  <section title="Getting all available engines">                  <section title="Getting amount of available engines" anchor="GET AVAILABLE_ENGINES">
2280                      <t>The front-end can ask for all available engines by sending the following command:</t>                      <t>The front-end can ask for the number of available engines by sending the following command:</t>
2281                      <t>                      <t>
2282                          <list>                          <list>
2283                              <t>GET AVAILABLE_ENGINES</t>                              <t>GET AVAILABLE_ENGINES</t>
# Line 2215  Schoenebeck'> Line 2286  Schoenebeck'>
2286                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2287                      <t>                      <t>
2288                          <list>                          <list>
2289                                <t>LinuxSampler will answer by sending the number of available engines.</t>
2290                            </list>
2291                        </t>
2292                        <t>Example:</t>
2293                        <t>
2294                            <list>
2295                                <t>C: "GET AVAILABLE_ENGINES"</t>
2296                                <t>S: "4"</t>
2297                            </list>
2298                        </t>
2299                    </section>
2300    
2301                    <section title="Getting all available engines" anchor="LIST AVAILABLE_ENGINES">
2302                        <t>The front-end can ask for a list of all available engines by sending the following command:</t>
2303                        <t>
2304                            <list>
2305                                <t>LIST AVAILABLE_ENGINES</t>
2306                            </list>
2307                        </t>
2308                        <t>Possible Answers:</t>
2309                        <t>
2310                            <list>
2311                              <t>LinuxSampler will answer by sending a comma separated character                              <t>LinuxSampler will answer by sending a comma separated character
2312                              string of the engines' names. Engine names can consist of lower and                              string of the engines' names. Engine names can consist of lower and
2313                              upper cases, digits and underlines ("_" character).</t>                              upper cases, digits and underlines ("_" character).</t>
# Line 2223  Schoenebeck'> Line 2316  Schoenebeck'>
2316                      <t>Example:</t>                      <t>Example:</t>
2317                      <t>                      <t>
2318                          <list>                          <list>
2319                              <t>C: "GET AVAILABLE_ENGINES"</t>                              <t>C: "LIST AVAILABLE_ENGINES"</t>
2320                              <t>S: "GigEngine,AkaiEngine,DLSEngine,JoesCustomEngine"</t>                              <t>S: "GigEngine,AkaiEngine,DLSEngine,JoesCustomEngine"</t>
2321                          </list>                          </list>
2322                      </t>                      </t>
2323                  </section>                  </section>
2324    
2325                  <section title="Getting information about an engine">                  <section title="Getting information about an engine" anchor="GET ENGINE INFO">
2326                      <t>The front-end can ask for information about a specific engine by                      <t>The front-end can ask for information about a specific engine by
2327                      sending the following command:</t>                      sending the following command:</t>
2328                      <t>                      <t>
# Line 2238  Schoenebeck'> Line 2331  Schoenebeck'>
2331                          </list>                          </list>
2332                      </t>                      </t>
2333                      <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
2334                      "GET AVAILABLE_ENGINES" command.</t>                      <xref target="LIST AVAILABLE_ENGINES">
2335                        "LIST AVAILABLE_ENGINES"</xref> command.</t>
2336                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2337                      <t>                      <t>
2338                          <list>                          <list>
# Line 2278  Schoenebeck'> Line 2372  Schoenebeck'>
2372                      </t>                      </t>
2373                  </section>                  </section>
2374    
2375                  <section title="Getting sampler channel information">                  <section title="Getting sampler channel information" anchor="GET CHANNEL INFO">
2376                      <t>The front-end can ask for the current settings of a sampler channel                      <t>The front-end can ask for the current settings of a sampler channel
2377                      by sending the following command:</t>                      by sending the following command:</t>
2378                      <t>                      <t>
# Line 2407  Schoenebeck'> Line 2501  Schoenebeck'>
2501                      </t>                      </t>
2502                  </section>                  </section>
2503    
2504                  <section title="Current number of active voices">                  <section title="Current number of active voices" anchor="GET CHANNEL VOICE_COUNT">
2505                      <t>The front-end can ask for the current number of active voices on a                      <t>The front-end can ask for the current number of active voices on a
2506                      sampler channel by sending the following command:</t>                      sampler channel by sending the following command:</t>
2507                      <t>                      <t>
# Line 2432  Schoenebeck'> Line 2526  Schoenebeck'>
2526                      </t>                      </t>
2527                  </section>                  </section>
2528    
2529                  <section title="Current number of active disk streams">                  <section title="Current number of active disk streams" anchor="GET CHANNEL STREAM_COUNT">
2530                      <t>The front-end can ask for the current number of active disk streams                      <t>The front-end can ask for the current number of active disk streams
2531                      on a sampler channel by sending the following command:</t>                      on a sampler channel by sending the following command:</t>
2532                      <t>                      <t>
# Line 2459  Schoenebeck'> Line 2553  Schoenebeck'>
2553                      </t>                      </t>
2554                  </section>                  </section>
2555    
2556                  <section title="Current fill state of disk stream buffers">                  <section title="Current fill state of disk stream buffers" anchor="GET CHANNEL BUFFER_FILL">
2557                      <t>The front-end can ask for the current fill state of all disk streams                      <t>The front-end can ask for the current fill state of all disk streams
2558                      on a sampler channel by sending the following command:</t>                      on a sampler channel by sending the following command:</t>
2559                      <t>                      <t>
# Line 2510  Schoenebeck'> Line 2604  Schoenebeck'>
2604                      </t>                      </t>
2605                  </section>                  </section>
2606    
2607                  <section title="Setting audio output device">                  <section title="Setting audio output device" anchor="SET CHANNEL AUDIO_OUTPUT_DEVICE">
2608                      <t>The front-end can set the audio output device on a specific sampler                      <t>The front-end can set the audio output device on a specific sampler
2609                      channel by sending the following command:</t>                      channel by sending the following command:</t>
2610                      <t>                      <t>
# Line 2552  Schoenebeck'> Line 2646  Schoenebeck'>
2646                      </t>                      </t>
2647                  </section>                  </section>
2648    
2649                  <section title="Setting audio output type">                  <section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYP">
2650                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>
2651    
2652                      <t>The front-end can alter the audio output type on a specific sampler                      <t>The front-end can alter the audio output type on a specific sampler
# Line 2595  Schoenebeck'> Line 2689  Schoenebeck'>
2689                      </t>                      </t>
2690                  </section>                  </section>
2691    
2692                  <section title="Setting audio output channel">                  <section title="Setting audio output channel" anchor="SET CHANNEL AUDIO_OUTPUT_CHANNEL">
2693                      <t>The front-end can alter the audio output channel on a specific                      <t>The front-end can alter the audio output channel on a specific
2694                      sampler channel by sending the following command:</t>                      sampler channel by sending the following command:</t>
2695                      <t>                      <t>
# Line 2638  Schoenebeck'> Line 2732  Schoenebeck'>
2732                      </t>                      </t>
2733                  </section>                  </section>
2734    
2735                  <section title="Setting MIDI input device">                  <section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE">
2736                      <t>The front-end can set the MIDI input device on a specific sampler                      <t>The front-end can set the MIDI input device on a specific sampler
2737                      channel by sending the following command:</t>                      channel by sending the following command:</t>
2738                      <t>                      <t>
# Line 2679  Schoenebeck'> Line 2773  Schoenebeck'>
2773                      </t>                      </t>
2774                  </section>                  </section>
2775    
2776                  <section title="Setting MIDI input type">                  <section title="Setting MIDI input type" anchor="SET CHANNEL MIDI_INPUT_TYPE">
2777                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>
2778    
2779                      <t>The front-end can alter the MIDI input type on a specific sampler                      <t>The front-end can alter the MIDI input type on a specific sampler
# Line 2722  Schoenebeck'> Line 2816  Schoenebeck'>
2816                      </t>                      </t>
2817                  </section>                  </section>
2818    
2819                  <section title="Setting MIDI input port">                  <section title="Setting MIDI input port" anchor="SET CHANNEL MIDI_INPUT_PORT">
2820                      <t>The front-end can alter the MIDI input port on a specific sampler                      <t>The front-end can alter the MIDI input port on a specific sampler
2821                      channel by sending the following command:</t>                      channel by sending the following command:</t>
2822                      <t>                      <t>
# Line 2764  Schoenebeck'> Line 2858  Schoenebeck'>
2858                      </t>                      </t>
2859                  </section>                  </section>
2860    
2861                  <section title="Setting MIDI input channel">                  <section title="Setting MIDI input channel" anchor="SET CHANNEL MIDI_INPUT_CHANNEL">
2862                      <t>The front-end can alter the MIDI channel a sampler channel should                      <t>The front-end can alter the MIDI channel a sampler channel should
2863                      listen to by sending the following command:</t>                      listen to by sending the following command:</t>
2864                      <t>                      <t>
# Line 2806  Schoenebeck'> Line 2900  Schoenebeck'>
2900                      </t>                      </t>
2901                  </section>                  </section>
2902    
2903                  <section title="Setting channel volume">                  <section title="Setting channel volume" anchor="SET CHANNEL VOLUME">
2904                      <t>The front-end can alter the volume of a sampler channel by sending                      <t>The front-end can alter the volume of a sampler channel by sending
2905                      the following command:</t>                      the following command:</t>
2906                      <t>                      <t>
# Line 2849  Schoenebeck'> Line 2943  Schoenebeck'>
2943                      </t>                      </t>
2944                  </section>                  </section>
2945    
2946                  <section title="Resetting a sampler channel">                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">
2947                      <t>The front-end can reset a particular sampler channel by sending the following command:</t>                      <t>The front-end can reset a particular sampler channel by sending the following command:</t>
2948                      <t>                      <t>
2949                          <list>                          <list>
# Line 2897  Schoenebeck'> Line 2991  Schoenebeck'>
2991              <section title="Controlling connection">              <section title="Controlling connection">
2992                  <t>The following commands are used to control the connection to LinuxSampler.</t>                  <t>The following commands are used to control the connection to LinuxSampler.</t>
2993    
2994                  <section title="Register front-end for receiving event messages">                  <section title="Register front-end for receiving event messages" anchor="SUBSCRIBE">
2995                      <t>The front-end can register itself to the LinuxSampler application to                      <t>The front-end can register itself to the LinuxSampler application to
2996                      be informed about noteworthy events by sending this command:</t>                      be informed about noteworthy events by sending this command:</t>
2997                      <t>                      <t>
# Line 2939  Schoenebeck'> Line 3033  Schoenebeck'>
3033                      </t>                      </t>
3034                  </section>                  </section>
3035    
3036                  <section title="Unregister front-end for not receiving event messages">                  <section title="Unregister front-end for not receiving event messages" anchor="UNSUBSCRIBE">
3037                      <t>The front-end can unregister itself if it doesn't want to receive event                      <t>The front-end can unregister itself if it doesn't want to receive event
3038                      messages anymore by sending the following command:</t>                      messages anymore by sending the following command:</t>
3039                      <t>                      <t>
# Line 2981  Schoenebeck'> Line 3075  Schoenebeck'>
3075                      </t>                      </t>
3076                  </section>                  </section>
3077    
3078                  <section title="Enable or disable echo of commands">                  <section title="Enable or disable echo of commands" anchor="SET ECHO">
3079                      <t>To enable or disable back sending of commands to the client the following command can be used:</t>                      <t>To enable or disable back sending of commands to the client the following command can be used:</t>
3080                      <t>                      <t>
3081                          <list>                          <list>
# Line 3019  Schoenebeck'> Line 3113  Schoenebeck'>
3113                      </t>                      </t>
3114                  </section>                  </section>
3115    
3116                  <section title="Close client connection">                  <section title="Close client connection" anchor="QUIT">
3117                      <t>The client can close its network connection to LinuxSampler by sending the following command:</t>                      <t>The client can close its network connection to LinuxSampler by sending the following command:</t>
3118                      <t>                      <t>
3119                          <list>                          <list>
# Line 3034  Schoenebeck'> Line 3128  Schoenebeck'>
3128              <section title="Global commands">              <section title="Global commands">
3129                  <t>The following commands have global impact on the sampler.</t>                  <t>The following commands have global impact on the sampler.</t>
3130    
3131                  <section title="Reset sampler">                  <section title="Reset sampler" anchor="RESET">
3132                      <t>The front-end can reset the whole sampler by sending the following command:</t>                      <t>The front-end can reset the whole sampler by sending the following command:</t>
3133                      <t>                      <t>
3134                          <list>                          <list>
# Line 3062  Schoenebeck'> Line 3156  Schoenebeck'>
3156              </section>              </section>
3157          </section>          </section>
3158    
3159          <section title="Command Syntax">          <section title="Command Syntax" anchor="command_syntax">
3160              <t>TODO: will soon automatically included from src/network/lscp.y,              <t>TODO: will soon automatically included from src/network/lscp.y,
3161              meanwhile have a look at that file to get the exact definition of              meanwhile have a look at that file to get the exact definition of
3162              the command syntax.</t>              the command syntax.</t>
3163          </section>          </section>
3164    
3165          <section title="Events">          <section title="Events" anchor="events">
3166              <t>This chapter will describe all currently defined events supported by LinuxSampler.</t>              <t>This chapter will describe all currently defined events supported by LinuxSampler.</t>
3167    
3168              <section title="Number of sampler channels changed">              <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL">
3169                  <t>Client may want to be notified when the total number of channels on the                  <t>Client may want to be notified when the total number of channels on the
3170                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
3171                  <t>                  <t>
# Line 3089  Schoenebeck'> Line 3183  Schoenebeck'>
3183                  of sampler channels.</t>                  of sampler channels.</t>
3184              </section>              </section>
3185    
3186              <section title="Number of active voices changed">              <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">
3187                  <t>Client may want to be notified when the number of voices on the                  <t>Client may want to be notified when the number of voices on the
3188                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
3189                  <t>                  <t>
# Line 3108  Schoenebeck'> Line 3202  Schoenebeck'>
3202                  active voices on that channel.</t>                  active voices on that channel.</t>
3203              </section>              </section>
3204    
3205              <section title="Number of active disk streams changed">              <section title="Number of active disk streams changed" anchor="SUBSCRIBE STREAM_COUNT">
3206                  <t>Client may want to be notified when the number of streams on the back-end                  <t>Client may want to be notified when the number of streams on the back-end
3207                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t>                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t>
3208                  <t>                  <t>
# Line 3127  Schoenebeck'> Line 3221  Schoenebeck'>
3221                  active disk streams on that channel.</t>                  active disk streams on that channel.</t>
3222              </section>              </section>
3223    
3224              <section title="Disk stream buffer fill state changed">              <section title="Disk stream buffer fill state changed" anchor="SUBSCRIBE BUFFER_FILL">
3225                  <t>Client may want to be notified when the buffer fill state of a disk stream                  <t>Client may want to be notified when the buffer fill state of a disk stream
3226                  on the back-end changes by issuing the following command:</t>                  on the back-end changes by issuing the following command:</t>
3227                  <t>                  <t>
# Line 3142  Schoenebeck'> Line 3236  Schoenebeck'>
3236                      </list>                      </list>
3237                  </t>                  </t>
3238                  <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
3239                  buffer fill state change occurred and &lt;fill-data&gt; will be replaced by the                  buffer fill state change occurred on and &lt;fill-data&gt; will be replaced by the
3240                  buffer fill data for this channel as described in 5.4.12 as if the                  buffer fill data for this channel as described in <xref target="GET CHANNEL BUFFER_FILL" />
3241                  "GET CHANNEL BUFFER_FILL PERCENTAGE" was issued on this channel.</t>                  as if the <xref target="GET CHANNEL BUFFER_FILL">
3242                    "GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t>
3243              </section>              </section>
3244    
3245              <section title="Channel information changed">              <section title="Channel information changed" anchor="SUBSCRIBE INFO">
3246                  <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
3247                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
3248                  <t>                  <t>
# Line 3169  Schoenebeck'> Line 3264  Schoenebeck'>
3264                  message is sufficient here.</t>                  message is sufficient here.</t>
3265              </section>              </section>
3266    
3267              <section title="Miscellaneous and debugging events">              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
3268                  <t>Client may want to be notified of miscellaneous and debugging events occurring at                  <t>Client may want to be notified of miscellaneous and debugging events occurring at
3269                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
3270                  <t>                  <t>
Legend:
Removed from v.499  
changed lines
  Added in v.534
  ViewVC Help
Powered by ViewVC