/[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 2516 by schoenebeck, Thu Feb 6 21:11:23 2014 UTC revision 3502 by schoenebeck, Mon Mar 11 15:42:54 2019 UTC
# Line 1  Line 1 
1  <?xml version="1.0" encoding="UTF-8"?>  <?xml version="1.0" encoding="UTF-8"?>
2    
3    <!-- NOTE: Use xml2rfc -n switch to avoid irrelevant DTD errors for now. -->
4    
5  <!DOCTYPE rfc SYSTEM "rfc2629.dtd" [  <!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
6      <!ENTITY rfc2119 PUBLIC ''      <!ENTITY rfc2119 PUBLIC ''
7        'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml'>        'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml'>
# Line 16  Line 18 
18       to an annoying "missing Normative/Informative References" error message -->       to an annoying "missing Normative/Informative References" error message -->
19  <?rfc strict="no" ?>  <?rfc strict="no" ?>
20    
21  <rfc category="std" ipr="full3978" docName="LSCP 1.6">  <rfc category="info" ipr="noDerivativesTrust200902" docName="LSCP 1.7">
22      <front>      <front>
23          <title>LinuxSampler Control Protocol</title>          <title>LinuxSampler Control Protocol</title>
24          <author initials='C.S.' surname="Schoenebeck" fullname='C.          <author initials='C.S.' surname="Schoenebeck" fullname='C.
25  Schoenebeck'>  Schoenebeck' role="editor">
26              <organization>              <organization>
27                  LinuxSampler.org                  LinuxSampler.org
28              </organization>              </organization>
# Line 36  Schoenebeck'> Line 38  Schoenebeck'>
38                  <email>cuse@users.sf.net</email>                  <email>cuse@users.sf.net</email>
39              </address>              </address>
40          </author>          </author>
41          <date month="January" year="2014"/>          <date month="March" year="2019"/>
42          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
43          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
44          <abstract>          <abstract>
# Line 516  Schoenebeck'> Line 518  Schoenebeck'>
518                  what parameters drivers are offering, how to retrieve their                  what parameters drivers are offering, how to retrieve their
519                  possible values, etc.</t>                  possible values, etc.</t>
520    
521                  <section title="Getting amount of available audio output drivers" anchor="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">                  <section title="Getting amount of available audio output drivers" anchor="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS" lscp_cmd="true">
522                      <t>Use the following command to get the number of                      <t>Use the following command to get the number of
523                      audio output drivers currently available for the                      audio output drivers currently available for the
524                      LinuxSampler instance:</t>                      LinuxSampler instance:</t>
# Line 541  Schoenebeck'> Line 543  Schoenebeck'>
543                      </t>                      </t>
544                  </section>                  </section>
545    
546                  <section title="Getting all available audio output drivers" anchor="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">                  <section title="Getting all available audio output drivers" anchor="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" lscp_cmd="true">
547                      <t>Use the following command to list all audio output                      <t>Use the following command to list all audio output
548                      drivers currently available for the LinuxSampler                      drivers currently available for the LinuxSampler
549                      instance:</t>                      instance:</t>
# Line 568  Schoenebeck'> Line 570  Schoenebeck'>
570                  </section>                  </section>
571    
572                  <section title="Getting information about a specific audio                  <section title="Getting information about a specific audio
573                  output driver" anchor="GET AUDIO_OUTPUT_DRIVER INFO">                  output driver" anchor="GET AUDIO_OUTPUT_DRIVER INFO" lscp_cmd="true">
574                      <t>Use the following command to get detailed information                      <t>Use the following command to get detailed information
575                      about a specific audio output driver:</t>                      about a specific audio output driver:</t>
576                      <t>                      <t>
# Line 641  Schoenebeck'> Line 643  Schoenebeck'>
643                  </section>                  </section>
644    
645                  <section title="Getting information about specific audio                  <section title="Getting information about specific audio
646                  output driver parameter" anchor="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">                  output driver parameter" anchor="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO" lscp_cmd="true">
647                      <t>Use the following command to get detailed information                      <t>Use the following command to get detailed information
648                      about a  specific audio output driver parameter:</t>                      about a  specific audio output driver parameter:</t>
649                      <t>                      <t>
# Line 829  Schoenebeck'> Line 831  Schoenebeck'>
831                      </t>                      </t>
832                  </section>                  </section>
833    
834                  <section title="Creating an audio output device" anchor="CREATE AUDIO_OUTPUT_DEVICE">                  <section title="Creating an audio output device" anchor="CREATE AUDIO_OUTPUT_DEVICE" lscp_cmd="true">
835                      <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>
836    
837                      <t>                      <t>
# Line 889  Schoenebeck'> Line 891  Schoenebeck'>
891                      </t>                      </t>
892                  </section>                  </section>
893    
894                  <section title="Destroying an audio output device" anchor="DESTROY AUDIO_OUTPUT_DEVICE">                  <section title="Destroying an audio output device" anchor="DESTROY AUDIO_OUTPUT_DEVICE" lscp_cmd="true">
895                      <t>Use the following command to destroy a created output device:</t>                      <t>Use the following command to destroy a created output device:</t>
896                      <t>                      <t>
897                          <list>                          <list>
# Line 958  Schoenebeck'> Line 960  Schoenebeck'>
960                      </t>                      </t>
961                  </section>                  </section>
962    
963                  <section title="Getting all created audio output device list" anchor="LIST AUDIO_OUTPUT_DEVICES">                  <section title="Getting all created audio output device list" anchor="LIST AUDIO_OUTPUT_DEVICES" lscp_cmd="true">
964                      <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>
965                      <t>                      <t>
966                          <list>                          <list>
# Line 981  Schoenebeck'> Line 983  Schoenebeck'>
983                      </t>                      </t>
984                  </section>                  </section>
985    
986                  <section title="Getting current settings of an audio output device" anchor="GET AUDIO_OUTPUT_DEVICE INFO">                  <section title="Getting current settings of an audio output device" anchor="GET AUDIO_OUTPUT_DEVICE INFO" lscp_cmd="true">
987                      <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>
988                      <t>                      <t>
989                          <list>                          <list>
# Line 1054  Schoenebeck'> Line 1056  Schoenebeck'>
1056                  </section>                  </section>
1057    
1058    
1059                  <section title="Changing settings of audio output devices" anchor="SET AUDIO_OUTPUT_DEVICE_PARAMETER">                  <section title="Changing settings of audio output devices" anchor="SET AUDIO_OUTPUT_DEVICE_PARAMETER" lscp_cmd="true">
1060                      <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>
1061                      <t>                      <t>
1062                          <list>                          <list>
# Line 1099  Schoenebeck'> Line 1101  Schoenebeck'>
1101                      </t>                      </t>
1102                  </section>                  </section>
1103    
1104                  <section title="Getting information about an audio channel" anchor="GET AUDIO_OUTPUT_CHANNEL INFO">                  <section title="Getting information about an audio channel" anchor="GET AUDIO_OUTPUT_CHANNEL INFO" lscp_cmd="true">
1105                      <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>
1106                      <t>                      <t>
1107                          <list>                          <list>
# Line 1199  Schoenebeck'> Line 1201  Schoenebeck'>
1201                      </t>                      </t>
1202                  </section>                  </section>
1203    
1204                  <section title="Getting information about specific audio channel parameter" anchor="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO">                  <section title="Getting information about specific audio channel parameter" anchor="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO" lscp_cmd="true">
1205                      <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>
1206    
1207                      <t>                      <t>
# Line 1305  Schoenebeck'> Line 1307  Schoenebeck'>
1307                      </t>                      </t>
1308                  </section>                  </section>
1309    
1310                  <section title="Changing settings of audio output channels" anchor="SET AUDIO_OUTPUT_CHANNEL_PARAMETER">                  <section title="Changing settings of audio output channels" anchor="SET AUDIO_OUTPUT_CHANNEL_PARAMETER" lscp_cmd="true">
1311                      <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>
1312                      <t>                      <t>
1313                          <list>                          <list>
# Line 1383  Schoenebeck'> Line 1385  Schoenebeck'>
1385                  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
1386                  possible values, etc.</t>                  possible values, etc.</t>
1387    
1388                  <section title="Getting amount of available MIDI input drivers" anchor="GET AVAILABLE_MIDI_INPUT_DRIVERS">                  <section title="Getting amount of available MIDI input drivers" anchor="GET AVAILABLE_MIDI_INPUT_DRIVERS" lscp_cmd="true">
1389                      <t>Use the following command to get the number of                      <t>Use the following command to get the number of
1390                      MIDI input drivers currently available for the                      MIDI input drivers currently available for the
1391                      LinuxSampler instance:</t>                      LinuxSampler instance:</t>
# Line 1408  Schoenebeck'> Line 1410  Schoenebeck'>
1410                      </t>                      </t>
1411                  </section>                  </section>
1412    
1413                  <section title="Getting all available MIDI input drivers" anchor="LIST AVAILABLE_MIDI_INPUT_DRIVERS">                  <section title="Getting all available MIDI input drivers" anchor="LIST AVAILABLE_MIDI_INPUT_DRIVERS" lscp_cmd="true">
1414                      <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
1415                      for the LinuxSampler instance:</t>                      for the LinuxSampler instance:</t>
1416                      <t>                      <t>
# Line 1432  Schoenebeck'> Line 1434  Schoenebeck'>
1434                      </t>                      </t>
1435                  </section>                  </section>
1436    
1437                  <section title="Getting information about a specific MIDI input driver" anchor="GET MIDI_INPUT_DRIVER INFO">                  <section title="Getting information about a specific MIDI input driver" anchor="GET MIDI_INPUT_DRIVER INFO" lscp_cmd="true">
1438                      <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>
1439                      <t>                      <t>
1440                          <list>                          <list>
# Line 1488  Schoenebeck'> Line 1490  Schoenebeck'>
1490                      </t>                      </t>
1491                  </section>                  </section>
1492    
1493                  <section title="Getting information about specific MIDI input driver parameter" anchor="GET MIDI_INPUT_DRIVER_PARAMETER INFO">                  <section title="Getting information about specific MIDI input driver parameter" anchor="GET MIDI_INPUT_DRIVER_PARAMETER INFO" lscp_cmd="true">
1494                      <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>
1495                      <t>                      <t>
1496                          <list>                          <list>
# Line 1643  Schoenebeck'> Line 1645  Schoenebeck'>
1645                      </t>                      </t>
1646                  </section>                  </section>
1647    
1648                  <section title="Creating a MIDI input device" anchor="CREATE MIDI_INPUT_DEVICE">                  <section title="Creating a MIDI input device" anchor="CREATE MIDI_INPUT_DEVICE" lscp_cmd="true">
1649                      <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>
1650                      <t>                      <t>
1651                          <list>                          <list>
# Line 1693  Schoenebeck'> Line 1695  Schoenebeck'>
1695                      </t>                      </t>
1696                  </section>                  </section>
1697    
1698                  <section title="Destroying a MIDI input device" anchor="DESTROY MIDI_INPUT_DEVICE">                  <section title="Destroying a MIDI input device" anchor="DESTROY MIDI_INPUT_DEVICE" lscp_cmd="true">
1699                      <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>
1700                      <t>                      <t>
1701                          <list>                          <list>
# Line 1735  Schoenebeck'> Line 1737  Schoenebeck'>
1737                      </t>                      </t>
1738                  </section>                  </section>
1739    
1740                  <section title="Getting all created MIDI input device count" anchor="GET MIDI_INPUT_DEVICES">                  <section title="Getting all created MIDI input device count" anchor="GET MIDI_INPUT_DEVICES" lscp_cmd="true">
1741                      <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>
1742                      <t>                      <t>
1743                          <list>                          <list>
# Line 1759  Schoenebeck'> Line 1761  Schoenebeck'>
1761                  </section>                  </section>
1762    
1763    
1764                  <section title="Getting all created MIDI input device list" anchor="LIST MIDI_INPUT_DEVICES">                  <section title="Getting all created MIDI input device list" anchor="LIST MIDI_INPUT_DEVICES" lscp_cmd="true">
1765                      <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>
1766                      <t>                      <t>
1767                          <list>                          <list>
# Line 1788  Schoenebeck'> Line 1790  Schoenebeck'>
1790                      </t>                      </t>
1791                  </section>                  </section>
1792    
1793                  <section title="Getting current settings of a MIDI input device" anchor="GET MIDI_INPUT_DEVICE INFO">                  <section title="Getting current settings of a MIDI input device" anchor="GET MIDI_INPUT_DEVICE INFO" lscp_cmd="true">
1794                      <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>
1795                      <t>                      <t>
1796                          <list>                          <list>
# Line 1854  Schoenebeck'> Line 1856  Schoenebeck'>
1856                      </t>                      </t>
1857                  </section>                  </section>
1858    
1859                  <section title="Changing settings of MIDI input devices" anchor="SET MIDI_INPUT_DEVICE_PARAMETER">                  <section title="Changing settings of MIDI input devices" anchor="SET MIDI_INPUT_DEVICE_PARAMETER" lscp_cmd="true">
1860                      <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>
1861                      <t>                      <t>
1862                          <list>                          <list>
# Line 1900  Schoenebeck'> Line 1902  Schoenebeck'>
1902                      </t>                      </t>
1903                  </section>                  </section>
1904    
1905                  <section title="Getting information about a MIDI port" anchor="GET MIDI_INPUT_PORT INFO">                  <section title="Getting information about a MIDI port" anchor="GET MIDI_INPUT_PORT INFO" lscp_cmd="true">
1906                      <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>
1907                      <t>                      <t>
1908                          <list>                          <list>
# Line 1944  Schoenebeck'> Line 1946  Schoenebeck'>
1946                      </t>                      </t>
1947                  </section>                  </section>
1948    
1949                  <section title="Getting information about specific MIDI port parameter" anchor="GET MIDI_INPUT_PORT_PARAMETER INFO">                  <section title="Getting information about specific MIDI port parameter" anchor="GET MIDI_INPUT_PORT_PARAMETER INFO" lscp_cmd="true">
1950                      <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>
1951                      <t>                      <t>
1952                          <list>                          <list>
# Line 2049  Schoenebeck'> Line 2051  Schoenebeck'>
2051                      </t>                      </t>
2052                  </section>                  </section>
2053    
2054                  <section title="Changing settings of MIDI input ports" anchor="SET MIDI_INPUT_PORT_PARAMETER">                  <section title="Changing settings of MIDI input ports" anchor="SET MIDI_INPUT_PORT_PARAMETER" lscp_cmd="true">
2055                      <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>
2056                      <t>                      <t>
2057                          <list>                          <list>
# Line 2109  Schoenebeck'> Line 2111  Schoenebeck'>
2111                  sampler channel with a sampler engine, load instruments and connect sampler channels to                  sampler channel with a sampler engine, load instruments and connect sampler channels to
2112                  MIDI and audio devices.</t>                  MIDI and audio devices.</t>
2113    
2114                  <section title="Loading an instrument" anchor="LOAD INSTRUMENT">                  <section title="Loading an instrument" anchor="LOAD INSTRUMENT" lscp_cmd="true">
2115                      <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>
2116                      <t>                      <t>
2117                          <list>                          <list>
# Line 2235  Schoenebeck'> Line 2237  Schoenebeck'>
2237                      </t>                      </t>
2238                  </section>                  </section>
2239    
2240                  <section title="Getting all created sampler channel count" anchor="GET CHANNELS">                  <section title="Getting all created sampler channel count" anchor="GET CHANNELS" lscp_cmd="true">
2241                      <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
2242                      current amount of sampler channels, the front-end can send the                      current amount of sampler channels, the front-end can send the
2243                      following command:</t>                      following command:</t>
# Line 2259  Schoenebeck'> Line 2261  Schoenebeck'>
2261                      </t>                      </t>
2262                  </section>                  </section>
2263    
2264                  <section title="Getting all created sampler channel list" anchor="LIST CHANNELS">                  <section title="Getting all created sampler channel list" anchor="LIST CHANNELS" lscp_cmd="true">
2265                      <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
2266                      current list of sampler channels, the front-end can send the                      current list of sampler channels, the front-end can send the
2267                      following command:</t>                      following command:</t>
# Line 2284  Schoenebeck'> Line 2286  Schoenebeck'>
2286                      </t>                      </t>
2287                  </section>                  </section>
2288    
2289                  <section title="Adding a new sampler channel" anchor="ADD CHANNEL">                  <section title="Adding a new sampler channel" anchor="ADD CHANNEL" lscp_cmd="true">
2290                      <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
2291                      channel list by sending the following command:</t>                      channel list by sending the following command:</t>
2292                      <t>                      <t>
# Line 2336  Schoenebeck'> Line 2338  Schoenebeck'>
2338                      </t>                      </t>
2339                  </section>                  </section>
2340    
2341                  <section title="Removing a sampler channel" anchor="REMOVE CHANNEL">                  <section title="Removing a sampler channel" anchor="REMOVE CHANNEL" lscp_cmd="true">
2342                      <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>
2343                      <t>                      <t>
2344                          <list>                          <list>
# Line 2382  Schoenebeck'> Line 2384  Schoenebeck'>
2384                      </t>                      </t>
2385                  </section>                  </section>
2386    
2387                  <section title="Getting amount of available engines" anchor="GET AVAILABLE_ENGINES">                  <section title="Getting amount of available engines" anchor="GET AVAILABLE_ENGINES" lscp_cmd="true">
2388                      <t>The front-end can ask for the number of 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>
2389                      <t>                      <t>
2390                          <list>                          <list>
# Line 2404  Schoenebeck'> Line 2406  Schoenebeck'>
2406                      </t>                      </t>
2407                  </section>                  </section>
2408    
2409                  <section title="Getting all available engines" anchor="LIST AVAILABLE_ENGINES">                  <section title="Getting all available engines" anchor="LIST AVAILABLE_ENGINES" lscp_cmd="true">
2410                      <t>The front-end can ask for a list of all available engines by sending the following command:</t>                      <t>The front-end can ask for a list of all available engines by sending the following command:</t>
2411                      <t>                      <t>
2412                          <list>                          <list>
# Line 2429  Schoenebeck'> Line 2431  Schoenebeck'>
2431                      </t>                      </t>
2432                  </section>                  </section>
2433    
2434                  <section title="Getting information about an engine" anchor="GET ENGINE INFO">                  <section title="Getting information about an engine" anchor="GET ENGINE INFO" lscp_cmd="true">
2435                      <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
2436                      sending the following command:</t>                      sending the following command:</t>
2437                      <t>                      <t>
# Line 2489  Schoenebeck'> Line 2491  Schoenebeck'>
2491                      </t>                      </t>
2492                  </section>                  </section>
2493    
2494                  <section title="Getting sampler channel information" anchor="GET CHANNEL INFO">                  <section title="Getting sampler channel information" anchor="GET CHANNEL INFO" lscp_cmd="true">
2495                      <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
2496                      by sending the following command:</t>                      by sending the following command:</t>
2497                      <t>                      <t>
# Line 2671  Schoenebeck'> Line 2673  Schoenebeck'>
2673                      </t>                      </t>
2674                  </section>                  </section>
2675    
2676                  <section title="Current number of active voices" anchor="GET CHANNEL VOICE_COUNT">                  <section title="Current number of active voices" anchor="GET CHANNEL VOICE_COUNT" lscp_cmd="true">
2677                      <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
2678                      sampler channel by sending the following command:</t>                      sampler channel by sending the following command:</t>
2679                      <t>                      <t>
# Line 2698  Schoenebeck'> Line 2700  Schoenebeck'>
2700                      </t>                      </t>
2701                  </section>                  </section>
2702    
2703                  <section title="Current number of active disk streams" anchor="GET CHANNEL STREAM_COUNT">                  <section title="Current number of active disk streams" anchor="GET CHANNEL STREAM_COUNT" lscp_cmd="true">
2704                      <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
2705                      on a sampler channel by sending the following command:</t>                      on a sampler channel by sending the following command:</t>
2706                      <t>                      <t>
# Line 2727  Schoenebeck'> Line 2729  Schoenebeck'>
2729                      </t>                      </t>
2730                  </section>                  </section>
2731    
2732                  <section title="Current fill state of disk stream buffers" anchor="GET CHANNEL BUFFER_FILL">                  <section title="Current fill state of disk stream buffers" anchor="GET CHANNEL BUFFER_FILL" lscp_cmd="true">
2733                      <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
2734                      on a sampler channel by sending the following command:</t>                      on a sampler channel by sending the following command:</t>
2735                      <t>                      <t>
# Line 2780  Schoenebeck'> Line 2782  Schoenebeck'>
2782                      </t>                      </t>
2783                  </section>                  </section>
2784    
2785                  <section title="Setting audio output device" anchor="SET CHANNEL AUDIO_OUTPUT_DEVICE">                  <section title="Setting audio output device" anchor="SET CHANNEL AUDIO_OUTPUT_DEVICE" lscp_cmd="true">
2786                      <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
2787                      channel by sending the following command:</t>                      channel by sending the following command:</t>
2788                      <t>                      <t>
# Line 2826  Schoenebeck'> Line 2828  Schoenebeck'>
2828                      </t>                      </t>
2829                  </section>                  </section>
2830    
2831                  <section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYPE">                  <section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYPE" lscp_cmd="true">
2832                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR!</t>                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR!</t>
2833    
2834                      <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 2876  Schoenebeck'> Line 2878  Schoenebeck'>
2878                      </t>                      </t>
2879                  </section>                  </section>
2880    
2881                  <section title="Setting audio output channel" anchor="SET CHANNEL AUDIO_OUTPUT_CHANNEL">                  <section title="Setting audio output channel" anchor="SET CHANNEL AUDIO_OUTPUT_CHANNEL" lscp_cmd="true">
2882                      <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
2883                      sampler channel by sending the following command:</t>                      sampler channel by sending the following command:</t>
2884                      <t>                      <t>
# Line 2921  Schoenebeck'> Line 2923  Schoenebeck'>
2923                      </t>                      </t>
2924                  </section>                  </section>
2925    
2926                  <section title="Add MIDI input to sampler channel" anchor="ADD CHANNEL MIDI_INPUT">                  <section title="Add MIDI input to sampler channel" anchor="ADD CHANNEL MIDI_INPUT" lscp_cmd="true">
2927                      <t>The front-end can add a MIDI input on a specific sampler                      <t>The front-end can add a MIDI input on a specific sampler
2928                      channel by sending the following command:</t>                      channel by sending the following command:</t>
2929                      <t>                      <t>
# Line 2985  Schoenebeck'> Line 2987  Schoenebeck'>
2987                      </t>                      </t>
2988                  </section>                  </section>
2989    
2990                  <section title="Remove MIDI input(s) from sampler channel" anchor="REMOVE CHANNEL MIDI_INPUT">                  <section title="Remove MIDI input(s) from sampler channel" anchor="REMOVE CHANNEL MIDI_INPUT" lscp_cmd="true">
2991                      <t>The front-end can remove one ore more MIDI input(s) on a                      <t>The front-end can remove one ore more MIDI input(s) on a
2992                      specific sampler channel by sending the following command:</t>                      specific sampler channel by sending the following command:</t>
2993                      <t>                      <t>
# Line 3056  Schoenebeck'> Line 3058  Schoenebeck'>
3058                      </t>                      </t>
3059                  </section>                  </section>
3060    
3061                  <section title="Getting all MIDI inputs of a sampler channel" anchor="LIST CHANNEL MIDI_INPUTS">                  <section title="Getting all MIDI inputs of a sampler channel" anchor="LIST CHANNEL MIDI_INPUTS" lscp_cmd="true">
3062                      <t>The front-end can query a list of all currently connected                      <t>The front-end can query a list of all currently connected
3063                      MIDI inputs of a certain sampler channel by sending the following                      MIDI inputs of a certain sampler channel by sending the following
3064                      command:</t>                      command:</t>
# Line 3100  Schoenebeck'> Line 3102  Schoenebeck'>
3102                      </t>                      </t>
3103                  </section>                  </section>
3104    
3105                  <section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE">                  <section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE" lscp_cmd="true">
3106                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR!</t>                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR!</t>
3107    
3108                      <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
# Line 3164  Schoenebeck'> Line 3166  Schoenebeck'>
3166                      </t>                      </t>
3167                  </section>                  </section>
3168    
3169                  <section title="Setting MIDI input type" anchor="SET CHANNEL MIDI_INPUT_TYPE">                  <section title="Setting MIDI input type" anchor="SET CHANNEL MIDI_INPUT_TYPE" lscp_cmd="true">
3170                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR!</t>                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR!</t>
3171    
3172                      <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 3224  Schoenebeck'> Line 3226  Schoenebeck'>
3226                      </t>                      </t>
3227                  </section>                  </section>
3228    
3229                  <section title="Setting MIDI input port" anchor="SET CHANNEL MIDI_INPUT_PORT">                  <section title="Setting MIDI input port" anchor="SET CHANNEL MIDI_INPUT_PORT" lscp_cmd="true">
3230                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR!</t>                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR!</t>
3231                                            
3232                      <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
# Line 3288  Schoenebeck'> Line 3290  Schoenebeck'>
3290                      </t>                      </t>
3291                  </section>                  </section>
3292    
3293                  <section title="Setting MIDI input channel" anchor="SET CHANNEL MIDI_INPUT_CHANNEL">                  <section title="Setting MIDI input channel" anchor="SET CHANNEL MIDI_INPUT_CHANNEL" lscp_cmd="true">
3294                      <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
3295                      listen to by sending the following command:</t>                      listen to by sending the following command:</t>
3296                      <t>                      <t>
# Line 3334  Schoenebeck'> Line 3336  Schoenebeck'>
3336                      </t>                      </t>
3337                  </section>                  </section>
3338    
3339                  <section title="Setting channel volume" anchor="SET CHANNEL VOLUME">                  <section title="Setting channel volume" anchor="SET CHANNEL VOLUME" lscp_cmd="true">
3340                      <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
3341                      the following command:</t>                      the following command:</t>
3342                      <t>                      <t>
# Line 3377  Schoenebeck'> Line 3379  Schoenebeck'>
3379                      </t>                      </t>
3380                  </section>                  </section>
3381    
3382                  <section title="Muting a sampler channel" anchor="SET CHANNEL MUTE">                  <section title="Muting a sampler channel" anchor="SET CHANNEL MUTE" lscp_cmd="true">
3383                      <t>The front-end can mute/unmute a specific sampler                      <t>The front-end can mute/unmute a specific sampler
3384                      channel by sending the following command:</t>                      channel by sending the following command:</t>
3385                      <t>                      <t>
# Line 3421  Schoenebeck'> Line 3423  Schoenebeck'>
3423                      </t>                      </t>
3424                  </section>                  </section>
3425    
3426                  <section title="Soloing a sampler channel" anchor="SET CHANNEL SOLO">                  <section title="Soloing a sampler channel" anchor="SET CHANNEL SOLO" lscp_cmd="true">
3427                      <t>The front-end can solo/unsolo a specific sampler channel                      <t>The front-end can solo/unsolo a specific sampler channel
3428                      by sending the following command:</t>                      by sending the following command:</t>
3429                      <t>                      <t>
# Line 3465  Schoenebeck'> Line 3467  Schoenebeck'>
3467                      </t>                      </t>
3468                  </section>                  </section>
3469    
3470                  <section title="Assigning a MIDI instrument map to a sampler channel" anchor="SET CHANNEL MIDI_INSTRUMENT_MAP">                  <section title="Assigning a MIDI instrument map to a sampler channel" anchor="SET CHANNEL MIDI_INSTRUMENT_MAP" lscp_cmd="true">
3471                      <t>The front-end can assign a MIDI instrument map to a specific sampler channel                      <t>The front-end can assign a MIDI instrument map to a specific sampler channel
3472                      by sending the following command:</t>                      by sending the following command:</t>
3473                      <t>                      <t>
# Line 3533  Schoenebeck'> Line 3535  Schoenebeck'>
3535                      </t>                      </t>
3536                  </section>                  </section>
3537    
3538                  <section title="Adding an effect send to a sampler channel" anchor="CREATE FX_SEND">                  <section title="Adding an effect send to a sampler channel" anchor="CREATE FX_SEND" lscp_cmd="true">
3539                      <t>The front-end can create an additional effect send on a specific sampler channel                      <t>The front-end can create an additional effect send on a specific sampler channel
3540                      by sending the following command:</t>                      by sending the following command:</t>
3541                      <t>                      <t>
# Line 3551  Schoenebeck'> Line 3553  Schoenebeck'>
3553                      encapsulated into apostrophes and supports escape sequences as described in chapter                      encapsulated into apostrophes and supports escape sequences as described in chapter
3554                      "<xref target="character_set">Character Set and Escape Sequences</xref>".</t>                      "<xref target="character_set">Character Set and Escape Sequences</xref>".</t>
3555    
3556                      <t>By default, that is as initial routing, the effect send's audio channels                      <t>Note: there are two possible approaches to apply audio effects with FX sends:
3557                      are automatically routed to the last audio channels of the sampler channel's                         you can either use a) internal effects or b) external effects.
3558                      audio output device, that way you can i.e. first increase the amount of audio                         By default, that is as initial routing, effect sends are automatically routed
3559                      channels on the audio output device for having dedicated effect send output                         directly to the sampler channel's audio output device and the effect send's
3560                      channels and when "CREATE FX_SEND" is called, those channels will automatically                         audio channels are by default automatically routed to the last audio channels
3561                      be picked. You can alter the destination channels however with                         of that audio output device (for the purpose of applying effects externally that is,
3562                      <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>.                         e.g. by using another application), that way you can i.e. first increase the
3563                           amount of audio channels on the audio output device for having dedicated effect
3564                           send output channels and when "CREATE FX_SEND" is called, those channels will
3565                           automatically be picked. You can alter the destination channels however with
3566                           <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>.
3567                           If your intention is rather to use internal effects instead of external effects,
3568                           then you first need to <xref target="effects">load those internal effects</xref>
3569                           and then assign the FX sends to the desired internal effect by sending
3570                           <xref target="SET FX_SEND EFFECT">"SET FX_SEND EFFECT"</xref>.
3571                      </t>                      </t>
3572    
3573                      <t>Note: Create effect sends on a sampler channel only when needed, because having effect                      <t>Note: Create effect sends on a sampler channel only when needed, because having effect
# Line 3603  Schoenebeck'> Line 3613  Schoenebeck'>
3613                      </t>                      </t>
3614                  </section>                  </section>
3615    
3616                  <section title="Removing an effect send from a sampler channel" anchor="DESTROY FX_SEND">                  <section title="Removing an effect send from a sampler channel" anchor="DESTROY FX_SEND" lscp_cmd="true">
3617                      <t>The front-end can remove an existing effect send on a specific sampler channel                      <t>The front-end can remove an existing effect send on a specific sampler channel
3618                      by sending the following command:</t>                      by sending the following command:</t>
3619                      <t>                      <t>
# Line 3645  Schoenebeck'> Line 3655  Schoenebeck'>
3655                      </t>                      </t>
3656                  </section>                  </section>
3657    
3658                  <section title="Getting amount of effect sends on a sampler channel" anchor="GET FX_SENDS">                  <section title="Getting amount of effect sends on a sampler channel" anchor="GET FX_SENDS" lscp_cmd="true">
3659                      <t>The front-end can ask for the amount of effect sends on a specific sampler channel                      <t>The front-end can ask for the amount of effect sends on a specific sampler channel
3660                      by sending the following command:</t>                      by sending the following command:</t>
3661                      <t>                      <t>
# Line 3674  Schoenebeck'> Line 3684  Schoenebeck'>
3684                      </t>                      </t>
3685                  </section>                  </section>
3686    
3687                  <section title="Listing all effect sends on a sampler channel" anchor="LIST FX_SENDS">                  <section title="Listing all effect sends on a sampler channel" anchor="LIST FX_SENDS" lscp_cmd="true">
3688                      <t>The front-end can ask for a list of effect sends on a specific sampler channel                      <t>The front-end can ask for a list of effect sends on a specific sampler channel
3689                      by sending the following command:</t>                      by sending the following command:</t>
3690                      <t>                      <t>
# Line 3710  Schoenebeck'> Line 3720  Schoenebeck'>
3720                      </t>                      </t>
3721                  </section>                  </section>
3722    
3723                  <section title="Getting effect send information" anchor="GET FX_SEND INFO">                  <section title="Getting effect send information" anchor="GET FX_SEND INFO" lscp_cmd="true">
3724                      <t>The front-end can ask for the current settings of an effect send entity                      <t>The front-end can ask for the current settings of an effect send entity
3725                      by sending the following command:</t>                      by sending the following command:</t>
3726                      <t>                      <t>
# Line 3815  Schoenebeck'> Line 3825  Schoenebeck'>
3825                      </t>                      </t>
3826                  </section>                  </section>
3827    
3828                  <section title="Changing effect send's name" anchor="SET FX_SEND NAME">                  <section title="Changing effect send's name" anchor="SET FX_SEND NAME" lscp_cmd="true">
3829                      <t>The front-end can alter the current name of an effect                      <t>The front-end can alter the current name of an effect
3830                      send entity by sending the following command:</t>                      send entity by sending the following command:</t>
3831                      <t>                      <t>
# Line 3859  Schoenebeck'> Line 3869  Schoenebeck'>
3869                      </t>                      </t>
3870                  </section>                  </section>
3871    
3872                  <section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL">                  <section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL" lscp_cmd="true">
3873                      <t>The front-end can alter the destination of an effect send's audio channel on a specific                      <t>The front-end can alter the destination of an effect send's audio channel on a specific
3874                      sampler channel by sending the following command:</t>                      sampler channel by sending the following command:</t>
3875                      <t>                      <t>
# Line 3875  Schoenebeck'> Line 3885  Schoenebeck'>
3885                      or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command,                      or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command,
3886                      &lt;audio-src&gt; is the numerical ID of the effect send's audio channel                      &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
3887                      which should be rerouted and &lt;audio-dst&gt; is the numerical ID of                      which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
3888                      the audio channel of the selected audio output device where &lt;audio-src&gt;                      either a) the audio output channel of the sampler channel's audio output
3889                      should be routed to. If an internal send effect is assigned                      device (i.e. if external effect shall be applied) or b) of the audio
3890                      to the effect send, then this setting defines the audio                      input channel of an internal effect assigned to the FX send where
3891                      channel routing to that effect instance respectively.</t>                      &lt;audio-src&gt; should be routed to.</t>
3892    
3893                      <t>Note that effect sends can only route audio to the same audio output                      <t>Note that effect sends can only route audio to the same audio output
3894                      device as assigned to the effect send's sampler channel. Also note that an                      device as assigned to the effect send's sampler channel. Also note that an
# Line 3921  Schoenebeck'> Line 3931  Schoenebeck'>
3931                      </t>                      </t>
3932                  </section>                  </section>
3933    
3934                  <section title="Assigning destination effect to an effect send" anchor="SET FX_SEND EFFECT">                  <section title="Assigning destination effect to an effect send" anchor="SET FX_SEND EFFECT" lscp_cmd="true">
3935                      <t>The front-end can (re-)assign a destination effect to an                      <t>The front-end can (re-)assign an internal destination effect to an
3936                      effect send by sending the following command:</t>                      effect send by sending the following command:</t>
3937                      <t>                      <t>
3938                          <list>                          <list>
# Line 3944  Schoenebeck'> Line 3954  Schoenebeck'>
3954                      chain position in the effect chain which hosts the actual                      chain position in the effect chain which hosts the actual
3955                      destination effect.</t>                      destination effect.</t>
3956    
3957                        <t>Note: This command MUST NOT be used if you want to apply
3958                           audio effects externally! By default FX sends are routed directly
3959                           to the audio output device for that purpose.
3960                           You can also revert this command later on by sending
3961                           <xref target="REMOVE FX_SEND EFFECT">"REMOVE FX_SEND EFFECT"</xref>,
3962                           which will cause the FX send to be routed directly to the sampler channel's
3963                           audio output device instead (i.e. for using external effects instead of
3964                           internal effects).
3965                        </t>
3966    
3967                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
3968                      <t>                      <t>
3969                          <list>                          <list>
# Line 3968  Schoenebeck'> Line 3988  Schoenebeck'>
3988                      </t>                      </t>
3989                  </section>                  </section>
3990    
3991                  <section title="Removing destination effect from an effect send" anchor="REMOVE FX_SEND EFFECT">                  <section title="Removing destination effect from an effect send" anchor="REMOVE FX_SEND EFFECT" lscp_cmd="true">
3992                      <t>The front-end can (re-)assign a destination effect to an                      <t>The front-end can (re-)assign a destination effect to an
3993                      effect send by sending the following command:</t>                      effect send by sending the following command:</t>
3994                      <t>                      <t>
# Line 4013  Schoenebeck'> Line 4033  Schoenebeck'>
4033                      </t>                      </t>
4034                  </section>                  </section>
4035    
4036                  <section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER">                  <section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER" lscp_cmd="true">
4037                      <t>The front-end can alter the MIDI controller of an effect                      <t>The front-end can alter the MIDI controller of an effect
4038                      send entity by sending the following command:</t>                      send entity by sending the following command:</t>
4039                      <t>                      <t>
# Line 4061  Schoenebeck'> Line 4081  Schoenebeck'>
4081                      </t>                      </t>
4082                  </section>                  </section>
4083    
4084                  <section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL">                  <section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL" lscp_cmd="true">
4085                      <t>The front-end can alter the current send level of an effect                      <t>The front-end can alter the current send level of an effect
4086                      send entity by sending the following command:</t>                      send entity by sending the following command:</t>
4087                      <t>                      <t>
# Line 4110  Schoenebeck'> Line 4130  Schoenebeck'>
4130                      </t>                      </t>
4131                  </section>                  </section>
4132    
4133                  <section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA">                  <section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA" lscp_cmd="true">
4134                      <t>The front-end can send MIDI events to a specific sampler channel                      <t>The front-end can send MIDI events to a specific sampler channel
4135                      by sending the following command:</t>                      by sending the following command:</t>
4136                      <t>                      <t>
# Line 4175  Schoenebeck'> Line 4195  Schoenebeck'>
4195                      </t>                      </t>
4196                  </section>                  </section>
4197    
4198                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL" lscp_cmd="true">
4199                      <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>
4200                      <t>                      <t>
4201                          <list>                          <list>
# Line 4223  Schoenebeck'> Line 4243  Schoenebeck'>
4243              <section title="Controlling connection">              <section title="Controlling connection">
4244                  <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>
4245    
4246                  <section title="Register front-end for receiving event messages" anchor="SUBSCRIBE">                  <section title="Register front-end for receiving event messages" anchor="SUBSCRIBE" lscp_cmd="true">
4247                      <t>The front-end can register itself to the LinuxSampler application to                      <t>The front-end can register itself to the LinuxSampler application to
4248                      be informed about noteworthy events by sending this command:</t>                      be informed about noteworthy events by sending this command:</t>
4249                      <t>                      <t>
# Line 4265  Schoenebeck'> Line 4285  Schoenebeck'>
4285                      </t>                      </t>
4286                  </section>                  </section>
4287    
4288                  <section title="Unregister front-end for not receiving event messages" anchor="UNSUBSCRIBE">                  <section title="Unregister front-end for not receiving event messages" anchor="UNSUBSCRIBE" lscp_cmd="true">
4289                      <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
4290                      messages anymore by sending the following command:</t>                      messages anymore by sending the following command:</t>
4291                      <t>                      <t>
# Line 4307  Schoenebeck'> Line 4327  Schoenebeck'>
4327                      </t>                      </t>
4328                  </section>                  </section>
4329    
4330                  <section title="Enable or disable echo of commands" anchor="SET ECHO">                  <section title="Enable or disable echo of commands" anchor="SET ECHO" lscp_cmd="true">
4331                      <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>
4332                      <t>                      <t>
4333                          <list>                          <list>
# Line 4345  Schoenebeck'> Line 4365  Schoenebeck'>
4365                      </t>                      </t>
4366                  </section>                  </section>
4367    
4368                  <section title="Close client connection" anchor="QUIT">                  <section title="Close client connection" anchor="QUIT" lscp_cmd="true">
4369                      <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>
4370                      <t>                      <t>
4371                          <list>                          <list>
# Line 4360  Schoenebeck'> Line 4380  Schoenebeck'>
4380              <section title="Global commands">              <section title="Global commands">
4381                  <t>The following commands have global impact on the sampler.</t>                  <t>The following commands have global impact on the sampler.</t>
4382    
4383                  <section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT">                  <section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT" lscp_cmd="true">
4384                      <t>The front-end can ask for the current number of active voices on                      <t>The front-end can ask for the current number of active voices on
4385                      the sampler by sending the following command:</t>                      the sampler by sending the following command:</t>
4386                      <t>                      <t>
# Line 4378  Schoenebeck'> Line 4398  Schoenebeck'>
4398                      </t>                      </t>
4399                  </section>                  </section>
4400    
4401                  <section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX">                  <section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX" lscp_cmd="true">
4402                      <t>The front-end can ask for the maximum number of active voices                      <t>The front-end can ask for the maximum number of active voices
4403                      by sending the following command:</t>                      by sending the following command:</t>
4404                      <t>                      <t>
# Line 4396  Schoenebeck'> Line 4416  Schoenebeck'>
4416                      </t>                      </t>
4417                  </section>                  </section>
4418    
4419                  <section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT">                  <section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT" lscp_cmd="true">
4420                      <t>The front-end can ask for the current number of active disk streams on                      <t>The front-end can ask for the current number of active disk streams on
4421                      the sampler by sending the following command:</t>                      the sampler by sending the following command:</t>
4422                      <t>                      <t>
# Line 4440  Schoenebeck'> Line 4460  Schoenebeck'>
4460                      </t>                      </t>
4461                  </section>                  </section>
4462    
4463                  <section title="General sampler informations" anchor="GET SERVER INFO">                  <section title="General sampler information" anchor="GET SERVER INFO" lscp_cmd="true">
4464                      <t>The client can ask for general informations about the LinuxSampler                      <t>The client can ask for general information about the LinuxSampler
4465                         instance by sending the following command:</t>                         instance by sending the following command:</t>
4466                      <t>                      <t>
4467                          <list>                          <list>
# Line 4503  Schoenebeck'> Line 4523  Schoenebeck'>
4523                      </t>                      </t>
4524                  </section>                  </section>
4525    
4526                  <section title="Getting global volume attenuation" anchor="GET VOLUME">                  <section title="Getting global volume attenuation" anchor="GET VOLUME" lscp_cmd="true">
4527                      <t>The client can ask for the current global sampler-wide volume                      <t>The client can ask for the current global sampler-wide volume
4528                      attenuation by sending the following command:</t>                      attenuation by sending the following command:</t>
4529                      <t>                      <t>
# Line 4525  Schoenebeck'> Line 4545  Schoenebeck'>
4545                      use this parameter.</t>                      use this parameter.</t>
4546                  </section>                  </section>
4547    
4548                  <section title="Setting global volume attenuation" anchor="SET VOLUME">                  <section title="Setting global volume attenuation" anchor="SET VOLUME" lscp_cmd="true">
4549                      <t>The client can alter the current global sampler-wide volume                      <t>The client can alter the current global sampler-wide volume
4550                      attenuation by sending the following command:</t>                      attenuation by sending the following command:</t>
4551                      <t>                      <t>
# Line 4562  Schoenebeck'> Line 4582  Schoenebeck'>
4582                      </t>                      </t>
4583                  </section>                  </section>
4584    
4585                  <section title="Getting global voice limit" anchor="GET VOICES">                  <section title="Getting global voice limit" anchor="GET VOICES" lscp_cmd="true">
4586                      <t>The client can ask for the current global sampler-wide limit                      <t>The client can ask for the current global sampler-wide limit
4587                         for maximum voices by sending the following command:</t>                         for maximum voices by sending the following command:</t>
4588                      <t>                      <t>
# Line 4587  Schoenebeck'> Line 4607  Schoenebeck'>
4607                         respective instrument and probably further criterias.</t>                         respective instrument and probably further criterias.</t>
4608                  </section>                  </section>
4609    
4610                  <section title="Setting global voice limit" anchor="SET VOICES">                  <section title="Setting global voice limit" anchor="SET VOICES" lscp_cmd="true">
4611                      <t>The client can alter the current global sampler-wide limit                      <t>The client can alter the current global sampler-wide limit
4612                      for maximum voices by sending the following command:</t>                      for maximum voices by sending the following command:</t>
4613                      <t>                      <t>
# Line 4631  Schoenebeck'> Line 4651  Schoenebeck'>
4651                          adjust the disk stream limit respectively and vice versa.</t>                          adjust the disk stream limit respectively and vice versa.</t>
4652                  </section>                  </section>
4653    
4654                  <section title="Getting global disk stream limit" anchor="GET STREAMS">                  <section title="Getting global disk stream limit" anchor="GET STREAMS" lscp_cmd="true">
4655                      <t>The client can ask for the current global sampler-wide limit                      <t>The client can ask for the current global sampler-wide limit
4656                         for maximum disk streams by sending the following command:</t>                         for maximum disk streams by sending the following command:</t>
4657                      <t>                      <t>
# Line 4654  Schoenebeck'> Line 4674  Schoenebeck'>
4674                         to perform its streaming operations.</t>                         to perform its streaming operations.</t>
4675                  </section>                  </section>
4676    
4677                  <section title="Setting global disk stream limit" anchor="SET STREAMS">                  <section title="Setting global disk stream limit" anchor="SET STREAMS" lscp_cmd="true">
4678                      <t>The client can alter the current global sampler-wide limit                      <t>The client can alter the current global sampler-wide limit
4679                      for maximum disk streams by sending the following command:</t>                      for maximum disk streams by sending the following command:</t>
4680                      <t>                      <t>
# Line 4728  Schoenebeck'> Line 4748  Schoenebeck'>
4748                  cause the sampler to switch to the respective instrument as                  cause the sampler to switch to the respective instrument as
4749                  reflected by the current MIDI instrument map.</t>                  reflected by the current MIDI instrument map.</t>
4750    
4751                  <section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT_MAP">                  <section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT_MAP" lscp_cmd="true">
4752                      <t>The front-end can add a new MIDI instrument map by sending                      <t>The front-end can add a new MIDI instrument map by sending
4753                      the following command:</t>                      the following command:</t>
4754                      <t>                      <t>
# Line 4784  Schoenebeck'> Line 4804  Schoenebeck'>
4804                      </t>                      </t>
4805                  </section>                  </section>
4806    
4807                  <section title="Delete one particular or all MIDI instrument maps" anchor="REMOVE MIDI_INSTRUMENT_MAP">                  <section title="Delete one particular or all MIDI instrument maps" anchor="REMOVE MIDI_INSTRUMENT_MAP" lscp_cmd="true">
4808                      <t>The front-end can delete a particular MIDI instrument map                      <t>The front-end can delete a particular MIDI instrument map
4809                      by sending the following command:</t>                      by sending the following command:</t>
4810                      <t>                      <t>
# Line 4834  Schoenebeck'> Line 4854  Schoenebeck'>
4854                      </t>                      </t>
4855                  </section>                  </section>
4856    
4857                  <section title="Get amount of existing MIDI instrument maps" anchor="GET MIDI_INSTRUMENT_MAPS">                  <section title="Get amount of existing MIDI instrument maps" anchor="GET MIDI_INSTRUMENT_MAPS" lscp_cmd="true">
4858                      <t>The front-end can retrieve the current amount of MIDI                      <t>The front-end can retrieve the current amount of MIDI
4859                      instrument maps by sending the following command:</t>                      instrument maps by sending the following command:</t>
4860                      <t>                      <t>
# Line 4860  Schoenebeck'> Line 4880  Schoenebeck'>
4880                      </t>                      </t>
4881                  </section>                  </section>
4882    
4883                  <section title="Getting all created MIDI instrument maps" anchor="LIST MIDI_INSTRUMENT_MAPS">                  <section title="Getting all created MIDI instrument maps" anchor="LIST MIDI_INSTRUMENT_MAPS" lscp_cmd="true">
4884                      <t>The number of MIDI instrument maps can change on runtime. To get the                      <t>The number of MIDI instrument maps can change on runtime. To get the
4885                      current list of MIDI instrument maps, the front-end can send the                      current list of MIDI instrument maps, the front-end can send the
4886                      following command:</t>                      following command:</t>
# Line 4885  Schoenebeck'> Line 4905  Schoenebeck'>
4905                      </t>                      </t>
4906                  </section>                  </section>
4907    
4908                  <section title="Getting MIDI instrument map information" anchor="GET MIDI_INSTRUMENT_MAP INFO">                  <section title="Getting MIDI instrument map information" anchor="GET MIDI_INSTRUMENT_MAP INFO" lscp_cmd="true">
4909                      <t>The front-end can ask for the current settings of a MIDI                      <t>The front-end can ask for the current settings of a MIDI
4910                      instrument map by sending the following command:</t>                      instrument map by sending the following command:</t>
4911                      <t>                      <t>
# Line 4940  Schoenebeck'> Line 4960  Schoenebeck'>
4960                      </t>                      </t>
4961                  </section>                  </section>
4962    
4963                  <section title="Renaming a MIDI instrument map" anchor="SET MIDI_INSTRUMENT_MAP NAME">                  <section title="Renaming a MIDI instrument map" anchor="SET MIDI_INSTRUMENT_MAP NAME" lscp_cmd="true">
4964                      <t>The front-end can alter the custom name of a MIDI                      <t>The front-end can alter the custom name of a MIDI
4965                      instrument map by sending the following command:</t>                      instrument map by sending the following command:</t>
4966                      <t>                      <t>
# Line 4980  Schoenebeck'> Line 5000  Schoenebeck'>
5000                      </t>                      </t>
5001                  </section>                  </section>
5002    
5003                  <section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT">                  <section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT" lscp_cmd="true">
5004                      <t>The front-end can create a new or replace an existing entry                      <t>The front-end can create a new or replace an existing entry
5005                      in a sampler's MIDI instrument map by sending the following                      in a sampler's MIDI instrument map by sending the following
5006                      command:</t>                      command:</t>
# Line 5153  Schoenebeck'> Line 5173  Schoenebeck'>
5173                      </t>                      </t>
5174                  </section>                  </section>
5175    
5176                  <section title="Getting amount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS">                  <section title="Getting amount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS" lscp_cmd="true">
5177                      <t>The front-end can query the amount of currently existing                      <t>The front-end can query the amount of currently existing
5178                      entries in a MIDI instrument map by sending the following                      entries in a MIDI instrument map by sending the following
5179                      command:</t>                      command:</t>
# Line 5193  Schoenebeck'> Line 5213  Schoenebeck'>
5213                      </t>                      </t>
5214                  </section>                  </section>
5215    
5216                  <section title="Getting indeces of all entries of a MIDI instrument map" anchor="LIST MIDI_INSTRUMENTS">                  <section title="Getting indeces of all entries of a MIDI instrument map" anchor="LIST MIDI_INSTRUMENTS" lscp_cmd="true">
5217                      <t>The front-end can query a list of all currently existing                      <t>The front-end can query a list of all currently existing
5218                      entries in a certain MIDI instrument map by sending the following                      entries in a certain MIDI instrument map by sending the following
5219                      command:</t>                      command:</t>
# Line 5222  Schoenebeck'> Line 5242  Schoenebeck'>
5242                              just reflects the key of the respective map entry,                              just reflects the key of the respective map entry,
5243                              thus subsequent                              thus subsequent
5244                              <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>                              <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
5245                              command(s) are necessary to retrieve detailed informations                              command(s) are necessary to retrieve detailed information
5246                              about each entry.</t>                              about each entry.</t>
5247                          </list>                          </list>
5248                      </t>                      </t>
# Line 5236  Schoenebeck'> Line 5256  Schoenebeck'>
5256                      </t>                      </t>
5257                  </section>                  </section>
5258    
5259                  <section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT">                  <section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT" lscp_cmd="true">
5260                      <t>The front-end can delete an entry from a MIDI instrument                      <t>The front-end can delete an entry from a MIDI instrument
5261                      map by sending the following command:</t>                      map by sending the following command:</t>
5262                      <t>                      <t>
# Line 5278  Schoenebeck'> Line 5298  Schoenebeck'>
5298                      </t>                      </t>
5299                  </section>                  </section>
5300    
5301                  <section title="Get current settings of MIDI instrument map entry" anchor="GET MIDI_INSTRUMENT INFO">                  <section title="Get current settings of MIDI instrument map entry" anchor="GET MIDI_INSTRUMENT INFO" lscp_cmd="true">
5302                      <t>The front-end can retrieve the current settings of a certain                      <t>The front-end can retrieve the current settings of a certain
5303                      instrument map entry by sending the following command:</t>                      instrument map entry by sending the following command:</t>
5304                      <t>                      <t>
# Line 5375  Schoenebeck'> Line 5395  Schoenebeck'>
5395                      </t>                      </t>
5396                  </section>                  </section>
5397    
5398                  <section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS">                  <section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS" lscp_cmd="true">
5399                      <t>The front-end can clear a whole MIDI instrument map, that                      <t>The front-end can clear a whole MIDI instrument map, that
5400                      is delete all its entries by sending the following command:</t>                      is delete all its entries by sending the following command:</t>
5401                      <t>                      <t>
# Line 5440  Schoenebeck'> Line 5460  Schoenebeck'>
5460                          </list>                          </list>
5461                      </t>                      </t>
5462    
5463                  <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">                  <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY" lscp_cmd="true">
5464                      <t>The front-end can add a new instrument directory to the                      <t>The front-end can add a new instrument directory to the
5465                      instruments database by sending the following command:</t>                      instruments database by sending the following command:</t>
5466                      <t>                      <t>
# Line 5478  Schoenebeck'> Line 5498  Schoenebeck'>
5498                      </t>                      </t>
5499                  </section>                  </section>
5500    
5501                  <section title="Deleting an instrument directory" anchor="REMOVE DB_INSTRUMENT_DIRECTORY">                  <section title="Deleting an instrument directory" anchor="REMOVE DB_INSTRUMENT_DIRECTORY" lscp_cmd="true">
5502                      <t>The front-end can delete a particular instrument directory                      <t>The front-end can delete a particular instrument directory
5503                      from the instruments database by sending the following command:</t>                      from the instruments database by sending the following command:</t>
5504                      <t>                      <t>
# Line 5517  Schoenebeck'> Line 5537  Schoenebeck'>
5537                      </t>                      </t>
5538                  </section>                  </section>
5539    
5540                  <section title="Getting amount of instrument directories" anchor="GET DB_INSTRUMENT_DIRECTORIES">                  <section title="Getting amount of instrument directories" anchor="GET DB_INSTRUMENT_DIRECTORIES" lscp_cmd="true">
5541                      <t>The front-end can retrieve the current amount of                      <t>The front-end can retrieve the current amount of
5542                      directories in a specific directory by sending the following command:</t>                      directories in a specific directory by sending the following command:</t>
5543                      <t>                      <t>
# Line 5552  Schoenebeck'> Line 5572  Schoenebeck'>
5572                      </t>                      </t>
5573                  </section>                  </section>
5574    
5575                  <section title="Listing all directories in specific directory" anchor="LIST DB_INSTRUMENT_DIRECTORIES">                  <section title="Listing all directories in specific directory" anchor="LIST DB_INSTRUMENT_DIRECTORIES" lscp_cmd="true">
5576                      <t>The front-end can retrieve the current list of directories                      <t>The front-end can retrieve the current list of directories
5577                      in specific directory by sending the following command:</t>                      in specific directory by sending the following command:</t>
5578                      <t>                      <t>
# Line 5592  Schoenebeck'> Line 5612  Schoenebeck'>
5612                      </t>                      </t>
5613                  </section>                  </section>
5614    
5615                  <section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO">                  <section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO" lscp_cmd="true">
5616                      <t>The front-end can ask for the current settings of an                      <t>The front-end can ask for the current settings of an
5617                      instrument directory by sending the following command:</t>                      instrument directory by sending the following command:</t>
5618                      <t>                      <t>
# Line 5651  Schoenebeck'> Line 5671  Schoenebeck'>
5671                      </t>                      </t>
5672                  </section>                  </section>
5673    
5674                  <section title="Renaming an instrument directory" anchor="SET DB_INSTRUMENT_DIRECTORY NAME">                  <section title="Renaming an instrument directory" anchor="SET DB_INSTRUMENT_DIRECTORY NAME" lscp_cmd="true">
5675                      <t>The front-end can alter the name of a specific                      <t>The front-end can alter the name of a specific
5676                      instrument directory by sending the following command:</t>                      instrument directory by sending the following command:</t>
5677                      <t>                      <t>
# Line 5689  Schoenebeck'> Line 5709  Schoenebeck'>
5709                      </t>                      </t>
5710                  </section>                  </section>
5711    
5712                  <section title="Moving an instrument directory" anchor="MOVE DB_INSTRUMENT_DIRECTORY">                  <section title="Moving an instrument directory" anchor="MOVE DB_INSTRUMENT_DIRECTORY" lscp_cmd="true">
5713                      <t>The front-end can move a specific                      <t>The front-end can move a specific
5714                      instrument directory by sending the following command:</t>                      instrument directory by sending the following command:</t>
5715                      <t>                      <t>
# Line 5731  Schoenebeck'> Line 5751  Schoenebeck'>
5751                      </t>                      </t>
5752                  </section>                  </section>
5753    
5754                  <section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY">                  <section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY" lscp_cmd="true">
5755                      <t>The front-end can copy a specific                      <t>The front-end can copy a specific
5756                      instrument directory by sending the following command:</t>                      instrument directory by sending the following command:</t>
5757                      <t>                      <t>
# Line 5773  Schoenebeck'> Line 5793  Schoenebeck'>
5793                      </t>                      </t>
5794                  </section>                  </section>
5795    
5796                  <section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">                  <section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" lscp_cmd="true">
5797                      <t>The front-end can alter the description of a specific                      <t>The front-end can alter the description of a specific
5798                      instrument directory by sending the following command:</t>                      instrument directory by sending the following command:</t>
5799                      <t>                      <t>
# Line 5811  Schoenebeck'> Line 5831  Schoenebeck'>
5831                      </t>                      </t>
5832                  </section>                  </section>
5833    
5834                  <section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES">                  <section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES" lscp_cmd="true">
5835                      <t>The front-end can search for directories                      <t>The front-end can search for directories
5836                      in specific directory by sending the following command:</t>                      in specific directory by sending the following command:</t>
5837                      <t>                      <t>
# Line 5901  Schoenebeck'> Line 5921  Schoenebeck'>
5921                      </t>                      </t>
5922                  </section>                  </section>
5923    
5924                  <section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS">                  <section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS" lscp_cmd="true">
5925                      <t>The front-end can add one or more instruments                      <t>The front-end can add one or more instruments
5926                      to the instruments database by sending the following command:</t>                      to the instruments database by sending the following command:</t>
5927                      <t>                      <t>
# Line 5994  Schoenebeck'> Line 6014  Schoenebeck'>
6014                      </t>                      </t>
6015                  </section>                  </section>
6016    
6017                  <section title="Removing an instrument" anchor="REMOVE DB_INSTRUMENT">                  <section title="Removing an instrument" anchor="REMOVE DB_INSTRUMENT" lscp_cmd="true">
6018                      <t>The front-end can remove a particular instrument                      <t>The front-end can remove a particular instrument
6019                      from the instruments database by sending the following command:</t>                      from the instruments database by sending the following command:</t>
6020                      <t>                      <t>
# Line 6031  Schoenebeck'> Line 6051  Schoenebeck'>
6051                      </t>                      </t>
6052                  </section>                  </section>
6053    
6054                  <section title="Getting amount of instruments" anchor="GET DB_INSTRUMENTS">                  <section title="Getting amount of instruments" anchor="GET DB_INSTRUMENTS" lscp_cmd="true">
6055                      <t>The front-end can retrieve the current amount of                      <t>The front-end can retrieve the current amount of
6056                      instruments in a specific directory by sending the following command:</t>                      instruments in a specific directory by sending the following command:</t>
6057                      <t>                      <t>
# Line 6066  Schoenebeck'> Line 6086  Schoenebeck'>
6086                      </t>                      </t>
6087                  </section>                  </section>
6088    
6089                  <section title="Listing all instruments in specific directory" anchor="LIST DB_INSTRUMENTS">                  <section title="Listing all instruments in specific directory" anchor="LIST DB_INSTRUMENTS" lscp_cmd="true">
6090                      <t>The front-end can retrieve the current list of instruments                      <t>The front-end can retrieve the current list of instruments
6091                      in specific directory by sending the following command:</t>                      in specific directory by sending the following command:</t>
6092                      <t>                      <t>
# Line 6106  Schoenebeck'> Line 6126  Schoenebeck'>
6126                      </t>                      </t>
6127                  </section>                  </section>
6128    
6129                  <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO">                  <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO" lscp_cmd="true">
6130                      <t>The front-end can ask for the current settings of an                      <t>The front-end can ask for the current settings of an
6131                      instrument by sending the following command:</t>                      instrument by sending the following command:</t>
6132                      <t>                      <t>
# Line 6231  Schoenebeck'> Line 6251  Schoenebeck'>
6251                      </t>                      </t>
6252                  </section>                  </section>
6253    
6254                  <section title="Renaming an instrument" anchor="SET DB_INSTRUMENT NAME">                  <section title="Renaming an instrument" anchor="SET DB_INSTRUMENT NAME" lscp_cmd="true">
6255                      <t>The front-end can alter the name of a specific                      <t>The front-end can alter the name of a specific
6256                      instrument by sending the following command:</t>                      instrument by sending the following command:</t>
6257                      <t>                      <t>
# Line 6269  Schoenebeck'> Line 6289  Schoenebeck'>
6289                      </t>                      </t>
6290                  </section>                  </section>
6291    
6292                  <section title="Moving an instrument" anchor="MOVE DB_INSTRUMENT">                  <section title="Moving an instrument" anchor="MOVE DB_INSTRUMENT" lscp_cmd="true">
6293                      <t>The front-end can move a specific instrument to another directory by                      <t>The front-end can move a specific instrument to another directory by
6294                      sending the following command:</t>                      sending the following command:</t>
6295                      <t>                      <t>
# Line 6309  Schoenebeck'> Line 6329  Schoenebeck'>
6329                      </t>                      </t>
6330                  </section>                  </section>
6331    
6332                  <section title="Copying instruments" anchor="COPY DB_INSTRUMENT">                  <section title="Copying instruments" anchor="COPY DB_INSTRUMENT" lscp_cmd="true">
6333                      <t>The front-end can copy a specific instrument to another directory by                      <t>The front-end can copy a specific instrument to another directory by
6334                      sending the following command:</t>                      sending the following command:</t>
6335                      <t>                      <t>
# Line 6349  Schoenebeck'> Line 6369  Schoenebeck'>
6369                      </t>                      </t>
6370                  </section>                  </section>
6371    
6372                  <section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION">                  <section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION" lscp_cmd="true">
6373                      <t>The front-end can alter the description of a specific                      <t>The front-end can alter the description of a specific
6374                      instrument by sending the following command:</t>                      instrument by sending the following command:</t>
6375                      <t>                      <t>
# Line 6387  Schoenebeck'> Line 6407  Schoenebeck'>
6407                      </t>                      </t>
6408                  </section>                  </section>
6409    
6410                  <section title="Finding instruments" anchor="FIND DB_INSTRUMENTS">                  <section title="Finding instruments" anchor="FIND DB_INSTRUMENTS" lscp_cmd="true">
6411                      <t>The front-end can search for instruments                      <t>The front-end can search for instruments
6412                      in specific directory by sending the following command:</t>                      in specific directory by sending the following command:</t>
6413                      <t>                      <t>
# Line 6528  Schoenebeck'> Line 6548  Schoenebeck'>
6548                      </t>                      </t>
6549                  </section>                  </section>
6550    
6551                  <section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO">                  <section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO" lscp_cmd="true">
6552                      <t>The front-end can ask for the current status of a                      <t>The front-end can ask for the current status of a
6553                      particular database instruments job by sending the following command:</t>                      particular database instruments job by sending the following command:</t>
6554                      <t>                      <t>
# Line 6592  Schoenebeck'> Line 6612  Schoenebeck'>
6612                      </t>                      </t>
6613                  </section>                  </section>
6614    
6615                  <section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB">                  <section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB" lscp_cmd="true">
6616                      <t>The front-end can remove all instruments and directories and re-create                      <t>The front-end can remove all instruments and directories and re-create
6617                      the instruments database structure (e.g., in case of a database corruption)                      the instruments database structure (e.g., in case of a database corruption)
6618                      by sending the following command:</t>                      by sending the following command:</t>
# Line 6620  Schoenebeck'> Line 6640  Schoenebeck'>
6640                      </t>                      </t>
6641                  </section>                  </section>
6642    
6643                  <section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES">                  <section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES" lscp_cmd="true">
6644                      <t>The front-end can retrieve the list of all instrument files in the instruments database                      <t>The front-end can retrieve the list of all instrument files in the instruments database
6645                      that don't exist in the filesystem by sending the following command:</t>                      that don't exist in the filesystem by sending the following command:</t>
6646                      <t>                      <t>
# Line 6650  Schoenebeck'> Line 6670  Schoenebeck'>
6670                      </t>                      </t>
6671                  </section>                  </section>
6672    
6673                  <section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH">                  <section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH" lscp_cmd="true">
6674                      <t>The front-end can substitute all occurrences of an instrument file                      <t>The front-end can substitute all occurrences of an instrument file
6675                      in the instruments database with a new one by sending the following command:</t>                      in the instruments database with a new one by sending the following command:</t>
6676                      <t>                      <t>
# Line 6701  Schoenebeck'> Line 6721  Schoenebeck'>
6721                  <t>At the moment there is only one command for this feature set,                  <t>At the moment there is only one command for this feature set,
6722                  but this will most probably change in future.</t>                  but this will most probably change in future.</t>
6723    
6724                  <section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT">                  <section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT" lscp_cmd="true">
6725                      <t>The front-end can request to open an appropriate instrument                      <t>The front-end can request to open an appropriate instrument
6726                      editor application by sending the following command:</t>                      editor application by sending the following command:</t>
6727                      <t>                      <t>
# Line 6766  Schoenebeck'> Line 6786  Schoenebeck'>
6786              </section>              </section>
6787    
6788              <section title="Managing Files" anchor="file_management">              <section title="Managing Files" anchor="file_management">
6789                  <t>You can query detailed informations about files located                  <t>You can query detailed information about files located
6790                  at the same system where the sampler instance is running on.                  at the same system where the sampler instance is running on.
6791                  Using this command set allows to retrieve file informations                  Using this command set allows to retrieve file information
6792                  even remotely from another machine.</t>                  even remotely from another machine.</t>
6793    
6794                  <section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS">                  <section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS" lscp_cmd="true">
6795                      <t>The front-end can retrieve the amount of instruments                      <t>The front-end can retrieve the amount of instruments
6796                      within a given instrument file by sending the                      within a given instrument file by sending the
6797                      following command:</t>                      following command:</t>
# Line 6814  Schoenebeck'> Line 6834  Schoenebeck'>
6834                      </t>                      </t>
6835                  </section>                  </section>
6836    
6837                  <section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS">                  <section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS" lscp_cmd="true">
6838                      <t>The front-end can retrieve a list of all instruments                      <t>The front-end can retrieve a list of all instruments
6839                      within a given instrument file by sending the                      within a given instrument file by sending the
6840                      following command:</t>                      following command:</t>
# Line 6858  Schoenebeck'> Line 6878  Schoenebeck'>
6878                      </t>                      </t>
6879                  </section>                  </section>
6880    
6881                  <section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO">                  <section title="Retrieving information about one instrument in a file" anchor="GET FILE INSTRUMENT INFO" lscp_cmd="true">
6882                      <t>The front-end can retrieve detailed informations                      <t>The front-end can retrieve detailed information
6883                      about a specific instrument within a given instrument                      about a specific instrument within a given instrument
6884                      file by sending the following command:</t>                      file by sending the following command:</t>
6885                      <t>                      <t>
# Line 6879  Schoenebeck'> Line 6899  Schoenebeck'>
6899    
6900                      <t>The sampler will try to ask all sampler engines,                      <t>The sampler will try to ask all sampler engines,
6901                      whether they support the given file and ask the first                      whether they support the given file and ask the first
6902                      engine with a positive answer for informations about the                      engine with a positive answer for information about the
6903                      specific instrument in the given file.</t>                      specific instrument in the given file.</t>
6904    
6905                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 6959  Schoenebeck'> Line 6979  Schoenebeck'>
6979                  </section>                  </section>
6980              </section>              </section>
6981              <section title="Managing Effects" anchor="effects">              <section title="Managing Effects" anchor="effects">
6982                  <t>Audio effects (e.g. reverb, delay, compression) can be                  <t>There are two possible approaches to apply audio effects
6983                  applied to the audio signals generated by the sampler. The                  (e.g. reverb, delay, compression).
6984                  sampler usually provides a set of internal audio effects for                  You can either a) load and apply internal effects or you can b) route
6985                  this task. The exact set of effects depends on the availability                  effect sends directly to dedicated output channels of your
6986                    audio device and apply effects externally (e.g. by routing
6987                    those dedicated output channels to another application).</t>
6988                    <t>This chapter describes how to load and manage internal effects.
6989                    If your intention is rather to apply effects externally, then
6990                    you can omit this chapter. For applying effects externally, you
6991                    just need to <xref target="CREATE FX_SEND">create FX sends</xref>
6992                    on the respective sampler channel(s)
6993                    and <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">adjust their destination audio channels</xref>
6994                    appropriately, because by default FX sends are automatically routed
6995                    directly to the audio output device.</t>
6996                    <t>The sampler usually provides a set of internal audio effects.
6997                    The exact set of effects depends on the availability
6998                  of third party effect plugins installed on the system where the                  of third party effect plugins installed on the system where the
6999                  sampler runs on.</t>                  sampler runs on (e.g. LADSPA plugins).</t>
7000                  <t>At the moment only "send effects" are supported. Support for                  <t>At the moment only "send effects" are supported. Support for
7001                  "insert effects" and "master effects" is planned to be added at                  "insert effects" and "master effects" is planned to be added at
7002                  a later point.</t>                  a later point.</t>
7003                  <t>The following commands allow to retrieve the set of internal                  <t>The following commands allow to retrieve the set of internal
7004                  effects available to the sampler, detailed informations about                  effects available to the sampler, detailed information about
7005                  those effects and to create and destroy instances of such                  those effects and to create and destroy instances of such
7006                  effects. After an instance of an effect is created, the effect                  effects. After an instance of an effect is created, the effect
7007                  instance can be inserted into the audio signal path of the                  instance can be inserted into the audio signal path of the
# Line 6989  Schoenebeck'> Line 7021  Schoenebeck'>
7021                  of a send effect chain, as well as directly to any other                  of a send effect chain, as well as directly to any other
7022                  position of the send effect chain.</t>                  position of the send effect chain.</t>
7023    
7024                  <section title="Retrieve amount of available effects" anchor="GET AVAILABLE_EFFECTS">                  <section title="Retrieve amount of available effects" anchor="GET AVAILABLE_EFFECTS" lscp_cmd="true">
7025                      <t>The front-end can retrieve the amount of internal                      <t>The front-end can retrieve the amount of internal
7026                      effects, available to the sampler by sending                      effects, available to the sampler by sending
7027                      the following command:</t>                      the following command:</t>
# Line 7016  Schoenebeck'> Line 7048  Schoenebeck'>
7048                      </t>                      </t>
7049                  </section>                  </section>
7050    
7051                  <section title="Get list of available effects" anchor="LIST AVAILABLE_EFFECTS">                  <section title="Get list of available effects" anchor="LIST AVAILABLE_EFFECTS" lscp_cmd="true">
7052                      <t>The set of available internal effects can change at                      <t>The set of available internal effects can change at
7053                      runtime. The front-end can retrieve the list of internal                      runtime. The front-end can retrieve the list of internal
7054                      effects, available to the sampler by sending the following                      effects, available to the sampler by sending the following
# Line 7048  Schoenebeck'> Line 7080  Schoenebeck'>
7080                      </t>                      </t>
7081                  </section>                  </section>
7082    
7083                  <section title="Retrieving general information about an effect" anchor="GET EFFECT INFO">                  <section title="Retrieving general information about an effect" anchor="GET EFFECT INFO" lscp_cmd="true">
7084                      <t>The front-end can ask for general informations about an                      <t>The front-end can ask for general information about an
7085                      effect by sending the following command:</t>                      effect by sending the following command:</t>
7086                      <t>                      <t>
7087                          <list>                          <list>
# Line 7127  Schoenebeck'> Line 7159  Schoenebeck'>
7159                      </t>                      </t>
7160                  </section>                  </section>
7161    
7162                  <section title="Creating an instance of an effect by its portable ID" anchor="CREATE EFFECT_INSTANCE">                  <section title="Creating an instance of an effect by its portable ID" anchor="CREATE EFFECT_INSTANCE" lscp_cmd="true">
7163                      <t>The front-end can spawn an instance of the desired                      <t>The front-end can spawn an instance of the desired
7164                      effect by sending the following command:</t>                      effect by sending the following command:</t>
7165                      <t>                      <t>
# Line 7258  Schoenebeck'> Line 7290  Schoenebeck'>
7290                      </t>                      </t>
7291                  </section>                  </section>
7292    
7293                  <section title="Destroy an effect instance" anchor="DESTROY EFFECT_INSTANCE">                  <section title="Destroy an effect instance" anchor="DESTROY EFFECT_INSTANCE" lscp_cmd="true">
7294                      <t>The front-end can destroy an unusued effect instance and                      <t>The front-end can destroy an unusued effect instance and
7295                      thus freeing it from memory by sending the following command:</t>                      thus freeing it from memory by sending the following command:</t>
7296                      <t>                      <t>
# Line 7304  Schoenebeck'> Line 7336  Schoenebeck'>
7336                      </t>                      </t>
7337                  </section>                  </section>
7338    
7339                  <section title="Retrieve amount of effect instances" anchor="GET EFFECT_INSTANCES">                  <section title="Retrieve amount of effect instances" anchor="GET EFFECT_INSTANCES" lscp_cmd="true">
7340                      <t>The front-end can retrieve the current amount of effect                      <t>The front-end can retrieve the current amount of effect
7341                      instances by sending the following command:</t>                      instances by sending the following command:</t>
7342                      <t>                      <t>
# Line 7331  Schoenebeck'> Line 7363  Schoenebeck'>
7363                      </t>                      </t>
7364                  </section>                  </section>
7365    
7366                  <section title="Get list of effect instances" anchor="LIST EFFECT_INSTANCES">                  <section title="Get list of effect instances" anchor="LIST EFFECT_INSTANCES" lscp_cmd="true">
7367                      <t>The front-end can retrieve the current list of effect                      <t>The front-end can retrieve the current list of effect
7368                      instances by sending the following command:</t>                      instances by sending the following command:</t>
7369                      <t>                      <t>
# Line 7358  Schoenebeck'> Line 7390  Schoenebeck'>
7390                      </t>                      </t>
7391                  </section>                  </section>
7392    
7393                  <section title="Retrieving current information about an effect instance" anchor="GET EFFECT_INSTANCE INFO">                  <section title="Retrieving current information about an effect instance" anchor="GET EFFECT_INSTANCE INFO" lscp_cmd="true">
7394                      <t>The front-end can ask for the current informations about                      <t>The front-end can ask for the current information about
7395                      a particular effect instance by sending the following command:</t>                      a particular effect instance by sending the following command:</t>
7396                      <t>                      <t>
7397                          <list>                          <list>
# Line 7449  Schoenebeck'> Line 7481  Schoenebeck'>
7481                      </t>                      </t>
7482                  </section>                  </section>
7483    
7484                  <section title="Retrieving information about an effect parameter" anchor="GET EFFECT_INSTANCE_INPUT_CONTROL INFO">                  <section title="Retrieving information about an effect parameter" anchor="GET EFFECT_INSTANCE_INPUT_CONTROL INFO" lscp_cmd="true">
7485                      <t>Effects typically provide a certain set of effect                      <t>Effects typically provide a certain set of effect
7486                      parameters which can be altered by the user in realtime                      parameters which can be altered by the user in realtime
7487                      (e.g. depth of a reverb effect, duration of a delay effect,                      (e.g. depth of a reverb effect, duration of a delay effect,
7488                      dry / wet signal ratio). Those controllable effect parameters                      dry / wet signal ratio). Those controllable effect parameters
7489                      are called "input controls". The front-end can ask for the                      are called "input controls". The front-end can ask for the
7490                      current informations of an effect instance's input control                      current information of an effect instance's input control
7491                      by sending the following command:</t>                      by sending the following command:</t>
7492                      <t>                      <t>
7493                          <list>                          <list>
# Line 7560  Schoenebeck'> Line 7592  Schoenebeck'>
7592                      </t>                      </t>
7593                  </section>                  </section>
7594    
7595                  <section title="Altering an effect parameter" anchor="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE">                  <section title="Altering an effect parameter" anchor="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE" lscp_cmd="true">
7596                      <t>The front-end can alter the current value of an effect                      <t>The front-end can alter the current value of an effect
7597                      parameter by sending the following command:</t>                      parameter by sending the following command:</t>
7598                      <t>                      <t>
# Line 7605  Schoenebeck'> Line 7637  Schoenebeck'>
7637                      </t>                      </t>
7638                  </section>                  </section>
7639    
7640                  <section title="Retrieve amount of send effect chains" anchor="GET SEND_EFFECT_CHAINS">                  <section title="Retrieve amount of send effect chains" anchor="GET SEND_EFFECT_CHAINS" lscp_cmd="true">
7641                      <t>The front-end can retrieve the current amount of send                      <t>The front-end can retrieve the current amount of send
7642                      effect chains of an audio output device by sending the                      effect chains of an audio output device by sending the
7643                      following command:</t>                      following command:</t>
# Line 7638  Schoenebeck'> Line 7670  Schoenebeck'>
7670                      </t>                      </t>
7671                  </section>                  </section>
7672    
7673                  <section title="Retrieve list of send effect chains" anchor="LIST SEND_EFFECT_CHAINS">                  <section title="Retrieve list of send effect chains" anchor="LIST SEND_EFFECT_CHAINS" lscp_cmd="true">
7674                      <t>The front-end can retrieve the current list of send                      <t>The front-end can retrieve the current list of send
7675                      effect chains of an audio output device by sending the                      effect chains of an audio output device by sending the
7676                      following command:</t>                      following command:</t>
# Line 7672  Schoenebeck'> Line 7704  Schoenebeck'>
7704                      </t>                      </t>
7705                  </section>                  </section>
7706    
7707                  <section title="Add send effect chain" anchor="ADD SEND_EFFECT_CHAIN">                  <section title="Add send effect chain" anchor="ADD SEND_EFFECT_CHAIN" lscp_cmd="true">
7708                      <t>The front-end can add a send effect chain by sending the                      <t>The front-end can add a send effect chain by sending the
7709                      following command:</t>                      following command:</t>
7710                      <t>                      <t>
# Line 7714  Schoenebeck'> Line 7746  Schoenebeck'>
7746                      </t>                      </t>
7747                  </section>                  </section>
7748    
7749                  <section title="Remove send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN">                  <section title="Remove send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN" lscp_cmd="true">
7750                      <t>The front-end can remove a send effect chain by sending                      <t>The front-end can remove a send effect chain by sending
7751                      the following command:</t>                      the following command:</t>
7752                      <t>                      <t>
# Line 7759  Schoenebeck'> Line 7791  Schoenebeck'>
7791                      </t>                      </t>
7792                  </section>                  </section>
7793    
7794                  <section title="Retrieving information about a send effect chain" anchor="GET SEND_EFFECT_CHAIN INFO">                  <section title="Retrieving information about a send effect chain" anchor="GET SEND_EFFECT_CHAIN INFO" lscp_cmd="true">
7795                      <t>The front-end can ask for informations of a send effect                      <t>The front-end can ask for information of a send effect
7796                      chain by sending the following command:</t>                      chain by sending the following command:</t>
7797                      <t>                      <t>
7798                          <list>                          <list>
# Line 7821  Schoenebeck'> Line 7853  Schoenebeck'>
7853                      </t>                      </t>
7854                  </section>                  </section>
7855    
7856                  <section title="Append effect instance to a send effect chain" anchor="APPEND SEND_EFFECT_CHAIN EFFECT">                  <section title="Append effect instance to a send effect chain" anchor="APPEND SEND_EFFECT_CHAIN EFFECT" lscp_cmd="true">
7857                      <t>The front-end can add an unused effect instance to the                      <t>The front-end can add an unused effect instance to the
7858                      end of a send effect chain by sending the following command:</t>                      end of a send effect chain by sending the following command:</t>
7859                      <t>                      <t>
# Line 7873  Schoenebeck'> Line 7905  Schoenebeck'>
7905                      </t>                      </t>
7906                  </section>                  </section>
7907    
7908                  <section title="Insert effect instance to a send effect chain" anchor="INSERT SEND_EFFECT_CHAIN EFFECT">                  <section title="Insert effect instance to a send effect chain" anchor="INSERT SEND_EFFECT_CHAIN EFFECT" lscp_cmd="true">
7909                      <t>The front-end can add an unused effect instance to a                      <t>The front-end can add an unused effect instance to a
7910                      certain position of a send effect chain by sending the                      certain position of a send effect chain by sending the
7911                      following command:</t>                      following command:</t>
# Line 7928  Schoenebeck'> Line 7960  Schoenebeck'>
7960                      </t>                      </t>
7961                  </section>                  </section>
7962    
7963                  <section title="Remove effect instance from send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN EFFECT">                  <section title="Remove effect instance from send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN EFFECT" lscp_cmd="true">
7964                      <t>The front-end can remove an effect instance from a                      <t>The front-end can remove an effect instance from a
7965                      certain position of a send effect chain by sending the                      certain position of a send effect chain by sending the
7966                      following command:</t>                      following command:</t>
# Line 7992  Schoenebeck'> Line 8024  Schoenebeck'>
8024    
8025  <t>input =  <t>input =
8026          <list>          <list>
8027                  <t>line LF                  <t>line
8028                  </t>                  </t>
8029                  <t>/ line CR LF                  <t>/ error
8030                  </t>                  </t>
8031          </list>          </list>
8032  </t>  </t>
8033  <t>line =  <t>line =
8034          <list>          <list>
8035                  <t>/* epsilon (empty line ignored) */                  <t>statement LF
8036                    </t>
8037                    <t>/ statement CR LF
8038                    </t>
8039            </list>
8040    </t>
8041    <t>statement =
8042            <list>
8043                    <t>/* epsilon (empty statement/line ignored) */
8044                  </t>                  </t>
8045                  <t>/ comment                  <t>/ comment
8046                  </t>                  </t>
8047                  <t>/ command                  <t>/ command
8048                  </t>                  </t>
                 <t>/ error  
                 </t>  
8049          </list>          </list>
8050  </t>  </t>
8051  <t>comment =  <t>comment =
# Line 8438  Schoenebeck'> Line 8476  Schoenebeck'>
8476                  </t>                  </t>
8477                  <t>/ SHELL SP AUTO_CORRECT SP boolean                  <t>/ SHELL SP AUTO_CORRECT SP boolean
8478                  </t>                  </t>
8479                    <t>/ SHELL SP DOC SP boolean
8480                    </t>
8481                  <t>/ VOLUME SP volume_value                  <t>/ VOLUME SP volume_value
8482                  </t>                  </t>
8483                  <t>/ VOICES SP number                  <t>/ VOICES SP number
# Line 9035  Schoenebeck'> Line 9075  Schoenebeck'>
9075          <section title="Events" anchor="events">          <section title="Events" anchor="events">
9076              <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>
9077    
9078              <section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">              <section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT" lscp_cmd="true">
9079                  <t>Client may want to be notified when the total number of audio output devices on the                  <t>Client may want to be notified when the total number of audio output devices on the
9080                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
9081                  <t>                  <t>
# Line 9053  Schoenebeck'> Line 9093  Schoenebeck'>
9093                  of audio output devices.</t>                  of audio output devices.</t>
9094              </section>              </section>
9095    
9096              <section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">              <section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO" lscp_cmd="true">
9097                  <t>Client may want to be notified when changes were made to audio output devices on the                  <t>Client may want to be notified when changes were made to audio output devices on the
9098                  back-end by issuing the following command:</t>                  back-end by issuing the following command:</t>
9099                  <t>                  <t>
# Line 9075  Schoenebeck'> Line 9115  Schoenebeck'>
9115                  message is sufficient here.</t>                  message is sufficient here.</t>
9116              </section>              </section>
9117    
9118              <section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">              <section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT" lscp_cmd="true">
9119                  <t>Client may want to be notified when the total number of MIDI input devices on the                  <t>Client may want to be notified when the total number of MIDI input devices on the
9120                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
9121                  <t>                  <t>
# Line 9093  Schoenebeck'> Line 9133  Schoenebeck'>
9133                  of MIDI input devices.</t>                  of MIDI input devices.</t>
9134              </section>              </section>
9135    
9136              <section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO">              <section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO" lscp_cmd="true">
9137                  <t>Client may want to be notified when changes were made to MIDI input devices on the                  <t>Client may want to be notified when changes were made to MIDI input devices on the
9138                  back-end by issuing the following command:</t>                  back-end by issuing the following command:</t>
9139                  <t>                  <t>
# Line 9115  Schoenebeck'> Line 9155  Schoenebeck'>
9155                  message is sufficient here.</t>                  message is sufficient here.</t>
9156              </section>              </section>
9157    
9158              <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT">              <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT" lscp_cmd="true">
9159                  <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
9160                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
9161                  <t>                  <t>
# Line 9133  Schoenebeck'> Line 9173  Schoenebeck'>
9173                  of sampler channels.</t>                  of sampler channels.</t>
9174              </section>              </section>
9175    
9176              <section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI">              <section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI" lscp_cmd="true">
9177                  <t>Client may want to be notified when MIDI data arrive on sampler channels on                  <t>Client may want to be notified when MIDI data arrive on sampler channels on
9178                  back-end side, by issuing the following command:</t>                  back-end side, by issuing the following command:</t>
9179                  <t>                  <t>
# Line 9158  Schoenebeck'> Line 9198  Schoenebeck'>
9198                  thread unaffected by this feature.</t>                  thread unaffected by this feature.</t>
9199              </section>              </section>
9200    
9201              <section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI">              <section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI" lscp_cmd="true">
9202                      <t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t>                      <t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t>
9203                      <t>                      <t>
9204                              <list>                              <list>
# Line 9183  Schoenebeck'> Line 9223  Schoenebeck'>
9223                         thread unaffected by this feature.</t>                         thread unaffected by this feature.</t>
9224              </section>              </section>
9225    
9226              <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">              <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT" lscp_cmd="true">
9227                  <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
9228                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
9229                  <t>                  <t>
# Line 9202  Schoenebeck'> Line 9242  Schoenebeck'>
9242                  active voices on that channel.</t>                  active voices on that channel.</t>
9243              </section>              </section>
9244    
9245              <section title="Number of active disk streams changed" anchor="SUBSCRIBE STREAM_COUNT">              <section title="Number of active disk streams changed" anchor="SUBSCRIBE STREAM_COUNT" lscp_cmd="true">
9246                  <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
9247                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t>                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t>
9248                  <t>                  <t>
# Line 9221  Schoenebeck'> Line 9261  Schoenebeck'>
9261                  active disk streams on that channel.</t>                  active disk streams on that channel.</t>
9262              </section>              </section>
9263    
9264              <section title="Disk stream buffer fill state changed" anchor="SUBSCRIBE BUFFER_FILL">              <section title="Disk stream buffer fill state changed" anchor="SUBSCRIBE BUFFER_FILL" lscp_cmd="true">
9265                  <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
9266                  on the back-end changes by issuing the following command:</t>                  on the back-end changes by issuing the following command:</t>
9267                  <t>                  <t>
# Line 9242  Schoenebeck'> Line 9282  Schoenebeck'>
9282                  "GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t>                  "GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t>
9283              </section>              </section>
9284    
9285              <section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO">              <section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO" lscp_cmd="true">
9286                  <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
9287                  back-end by issuing the following command:</t>                  back-end by issuing the following command:</t>
9288                  <t>                  <t>
# Line 9264  Schoenebeck'> Line 9304  Schoenebeck'>
9304                  message is sufficient here.</t>                  message is sufficient here.</t>
9305              </section>              </section>
9306    
9307              <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">              <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT" lscp_cmd="true">
9308                  <t>Client may want to be notified when the number of effect sends on                  <t>Client may want to be notified when the number of effect sends on
9309                  a particular sampler channel is changed by issuing the following command:</t>                  a particular sampler channel is changed by issuing the following command:</t>
9310                  <t>                  <t>
# Line 9283  Schoenebeck'> Line 9323  Schoenebeck'>
9323                  be replaced by the new number of effect sends on that channel.</t>                  be replaced by the new number of effect sends on that channel.</t>
9324              </section>              </section>
9325    
9326              <section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO">              <section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO" lscp_cmd="true">
9327                  <t>Client may want to be notified when changes were made to effect sends on a                  <t>Client may want to be notified when changes were made to effect sends on a
9328                  a particular sampler channel by issuing the following command:</t>                  a particular sampler channel by issuing the following command:</t>
9329                  <t>                  <t>
# Line 9302  Schoenebeck'> Line 9342  Schoenebeck'>
9342                  be replaced by the numerical ID of the changed effect send.</t>                  be replaced by the numerical ID of the changed effect send.</t>
9343              </section>              </section>
9344    
9345              <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT">              <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT" lscp_cmd="true">
9346                  <t>Client may want to be notified when the total number of voices on the                  <t>Client may want to be notified when the total number of voices on the
9347                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
9348                  <t>                  <t>
# Line 9320  Schoenebeck'> Line 9360  Schoenebeck'>
9360                  all currently active voices.</t>                  all currently active voices.</t>
9361              </section>              </section>
9362    
9363              <section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT">              <section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT" lscp_cmd="true">
9364                  <t>Client may want to be notified when the total number of disk streams on the                  <t>Client may want to be notified when the total number of disk streams on the
9365                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
9366                  <t>                  <t>
# Line 9338  Schoenebeck'> Line 9378  Schoenebeck'>
9378                  all currently active disk streams.</t>                  all currently active disk streams.</t>
9379              </section>              </section>
9380    
9381              <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">              <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT" lscp_cmd="true">
9382                  <t>Client may want to be notified when the number of MIDI instrument maps on the                  <t>Client may want to be notified when the number of MIDI instrument maps on the
9383                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
9384                  <t>                  <t>
# Line 9356  Schoenebeck'> Line 9396  Schoenebeck'>
9396                  of MIDI instrument maps.</t>                  of MIDI instrument maps.</t>
9397              </section>              </section>
9398    
9399              <section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">              <section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO" lscp_cmd="true">
9400                  <t>Client may want to be notified when changes were made to MIDI instrument maps on the                  <t>Client may want to be notified when changes were made to MIDI instrument maps on the
9401                  back-end by issuing the following command:</t>                  back-end by issuing the following command:</t>
9402                  <t>                  <t>
# Line 9378  Schoenebeck'> Line 9418  Schoenebeck'>
9418                  message is sufficient here.</t>                  message is sufficient here.</t>
9419              </section>              </section>
9420    
9421              <section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT">              <section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT" lscp_cmd="true">
9422                  <t>Client may want to be notified when the number of MIDI instrument maps on the                  <t>Client may want to be notified when the number of MIDI instrument maps on the
9423                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
9424                  <t>                  <t>
# Line 9397  Schoenebeck'> Line 9437  Schoenebeck'>
9437                  the new number of MIDI instruments in the specified map.</t>                  the new number of MIDI instruments in the specified map.</t>
9438              </section>              </section>
9439    
9440              <section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO">              <section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO" lscp_cmd="true">
9441                  <t>Client may want to be notified when changes were made to MIDI instruments on the                  <t>Client may want to be notified when changes were made to MIDI instruments on the
9442                  back-end by issuing the following command:</t>                  back-end by issuing the following command:</t>
9443                  <t>                  <t>
# Line 9420  Schoenebeck'> Line 9460  Schoenebeck'>
9460                  message is sufficient here.</t>                  message is sufficient here.</t>
9461              </section>              </section>
9462    
9463              <section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO">              <section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO" lscp_cmd="true">
9464                  <t>Client may want to be notified when changes to the global settings                  <t>Client may want to be notified when changes to the global settings
9465                  of the sampler were made by issuing the following command:</t>                  of the sampler were made by issuing the following command:</t>
9466                  <t>                  <t>
# Line 9451  Schoenebeck'> Line 9491  Schoenebeck'>
9491                  </t>                  </t>
9492              </section>              </section>
9493    
9494              <section title="Number of database instrument directories changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">              <section title="Number of database instrument directories changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT" lscp_cmd="true">
9495                  <t>Client may want to be notified when the number of instrument                  <t>Client may want to be notified when the number of instrument
9496                  directories in a particular directory in the instruments database                  directories in a particular directory in the instruments database
9497                  is changed by issuing the following command:</t>                  is changed by issuing the following command:</t>
# Line 9473  Schoenebeck'> Line 9513  Schoenebeck'>
9513                  is not sent for the subdirectories in that directory.</t>                  is not sent for the subdirectories in that directory.</t>
9514              </section>              </section>
9515    
9516              <section title="Database instrument directory information changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">              <section title="Database instrument directory information changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO" lscp_cmd="true">
9517                  <t>Client may want to be notified when changes were made to directories                  <t>Client may want to be notified when changes were made to directories
9518                  in the instruments database by issuing the following command:</t>                  in the instruments database by issuing the following command:</t>
9519                  <t>                  <t>
# Line 9503  Schoenebeck'> Line 9543  Schoenebeck'>
9543                  the new name of the directory, encapsulated into apostrophes.</t>                  the new name of the directory, encapsulated into apostrophes.</t>
9544              </section>              </section>
9545    
9546              <section title="Number of database instruments changed" anchor="SUBSCRIBE DB_INSTRUMENT_COUNT">              <section title="Number of database instruments changed" anchor="SUBSCRIBE DB_INSTRUMENT_COUNT" lscp_cmd="true">
9547                  <t>Client may want to be notified when the number of instruments                  <t>Client may want to be notified when the number of instruments
9548                  in a particular directory in the instruments database                  in a particular directory in the instruments database
9549                  is changed by issuing the following command:</t>                  is changed by issuing the following command:</t>
# Line 9525  Schoenebeck'> Line 9565  Schoenebeck'>
9565                  is not sent for the instruments in that directory.</t>                  is not sent for the instruments in that directory.</t>
9566              </section>              </section>
9567    
9568              <section title="Database instrument information changed" anchor="SUBSCRIBE DB_INSTRUMENT_INFO">              <section title="Database instrument information changed" anchor="SUBSCRIBE DB_INSTRUMENT_INFO" lscp_cmd="true">
9569                  <t>Client may want to be notified when changes were made to instruments                  <t>Client may want to be notified when changes were made to instruments
9570                  in the instruments database by issuing the following command:</t>                  in the instruments database by issuing the following command:</t>
9571                  <t>                  <t>
# Line 9555  Schoenebeck'> Line 9595  Schoenebeck'>
9595                  the new name of the instrument, encapsulated into apostrophes.</t>                  the new name of the instrument, encapsulated into apostrophes.</t>
9596              </section>              </section>
9597    
9598              <section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">              <section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO" lscp_cmd="true">
9599                  <t>Client may want to be notified when the status of particular database                  <t>Client may want to be notified when the status of particular database
9600                  instruments job is changed by issuing the following command:</t>                  instruments job is changed by issuing the following command:</t>
9601                  <t>                  <t>
# Line 9577  Schoenebeck'> Line 9617  Schoenebeck'>
9617                  message is sufficient here.</t>                  message is sufficient here.</t>
9618              </section>              </section>
9619    
9620              <section title="Number of effect instances changed" anchor="SUBSCRIBE EFFECT_INSTANCE_COUNT">              <section title="Number of effect instances changed" anchor="SUBSCRIBE EFFECT_INSTANCE_COUNT" lscp_cmd="true">
9621                  <t>Client may want to be notified when the number of effect instances                  <t>Client may want to be notified when the number of effect instances
9622                  is changed by issuing the following command:</t>                  is changed by issuing the following command:</t>
9623                  <t>                  <t>
# Line 9595  Schoenebeck'> Line 9635  Schoenebeck'>
9635                  of effect instances.</t>                  of effect instances.</t>
9636              </section>              </section>
9637    
9638              <section title="Effect instance information changed" anchor="SUBSCRIBE EFFECT_INSTANCE_INFO">              <section title="Effect instance information changed" anchor="SUBSCRIBE EFFECT_INSTANCE_INFO" lscp_cmd="true">
9639                  <t>Client may want to be notified when changes were made to effect instances                  <t>Client may want to be notified when changes were made to effect instances
9640                  on the back-end by issuing the following command:</t>                  on the back-end by issuing the following command:</t>
9641                  <t>                  <t>
# Line 9613  Schoenebeck'> Line 9653  Schoenebeck'>
9653                  of the effect instance.</t>                  of the effect instance.</t>
9654              </section>              </section>
9655    
9656              <section title="Number of send effect chains changed" anchor="SUBSCRIBE SEND_EFFECT_CHAIN_COUNT">              <section title="Number of send effect chains changed" anchor="SUBSCRIBE SEND_EFFECT_CHAIN_COUNT" lscp_cmd="true">
9657                  <t>Client may want to be notified when the number of send effect chains                  <t>Client may want to be notified when the number of send effect chains
9658                  is changed by issuing the following command:</t>                  is changed by issuing the following command:</t>
9659                  <t>                  <t>
# Line 9632  Schoenebeck'> Line 9672  Schoenebeck'>
9672                  &lt;chains&gt; will be replaced by the new number of send effect chains.</t>                  &lt;chains&gt; will be replaced by the new number of send effect chains.</t>
9673              </section>              </section>
9674    
9675              <section title="Send effect chain information changed" anchor="SUBSCRIBE SEND_EFFECT_CHAIN_INFO">              <section title="Send effect chain information changed" anchor="SUBSCRIBE SEND_EFFECT_CHAIN_INFO" lscp_cmd="true">
9676                  <t>Client may want to be notified when changes were made to send effect chains                  <t>Client may want to be notified when changes were made to send effect chains
9677                  on the back-end by issuing the following command:</t>                  on the back-end by issuing the following command:</t>
9678                  <t>                  <t>
# Line 9654  Schoenebeck'> Line 9694  Schoenebeck'>
9694                  </t>                  </t>
9695              </section>              </section>
9696    
9697              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS" lscp_cmd="true">
9698                  <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
9699                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
9700                  <t>                  <t>
Legend:
Removed from v.2516  
changed lines
  Added in v.3502
  ViewVC Help
Powered by ViewVC