/[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 2137 by schoenebeck, Mon Oct 4 12:20:23 2010 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.5">  <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                  Interessengemeinschaft Software Engineering e. V.                  LinuxSampler.org
28              </organization>              </organization>
29              <address>              <address>
30                  <postal>                  <postal>
31                      <street>Max-Planck-Str. 39</street>                      <street>Crudebyte Engineering</street>
32                        <street>Hofgartenstr. 3</street>
33  <!--                    <code>74081</code> -->  <!--                    <code>74081</code> -->
34                      <city>74081 Heilbronn</city>                      <city>74189 Weinsberg</city>
35                      <country>Germany</country>                      <country>Germany</country>
36                  </postal>                  </postal>
37                  <email>schoenebeck at software minus engineering dot org</email>                  <phone>+49 7134 911614</phone>
38                    <email>cuse@users.sf.net</email>
39              </address>              </address>
40          </author>          </author>
41          <date month="November" year="2009"/>          <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 514  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 539  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 566  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 639  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 827  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 887  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 956  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 979  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 1052  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 1097  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 1197  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 1303  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 1381  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 1406  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 1430  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 1486  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 1641  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 1691  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 1733  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 1757  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 1786  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 1852  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 1898  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 1942  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 2047  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 2107  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 2233  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 2257  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 2282  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 2334  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 2380  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 2402  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 2422  Schoenebeck'> Line 2426  Schoenebeck'>
2426                      <t>                      <t>
2427                          <list>                          <list>
2428                              <t>C: "LIST AVAILABLE_ENGINES"</t>                              <t>C: "LIST AVAILABLE_ENGINES"</t>
2429                              <t>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"</t>                              <t>S: "'gig','sfz','sf2'"</t>
2430                          </list>                          </list>
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 2468  Schoenebeck'> Line 2472  Schoenebeck'>
2472    
2473                      <t>The mentioned fields above don't have to be in particular order.</t>                      <t>The mentioned fields above don't have to be in particular order.</t>
2474    
2475                      <t>Example:</t>                      <t>Examples:</t>
2476                      <t>                      <t>
2477                          <list>                          <list>
2478                              <t>C: "GET ENGINE INFO JoesCustomEngine"</t>                              <t>C: "GET ENGINE INFO gig"</t>
2479                              <t>S: "DESCRIPTION: this is Joe's custom sampler engine"</t>                              <t>S: "DESCRIPTION: GigaSampler Format Engine"</t>
2480                              <t>&nbsp;&nbsp;&nbsp;"VERSION: testing-1.0"</t>                              <t>&nbsp;&nbsp;&nbsp;"VERSION: 1.110"</t>
2481                                <t>&nbsp;&nbsp;&nbsp;"."</t>
2482                                <t>C: "GET ENGINE INFO sf2"</t>
2483                                <t>S: "DESCRIPTION: SoundFont Format Engine"</t>
2484                                <t>&nbsp;&nbsp;&nbsp;"VERSION: 1.4"</t>
2485                                <t>&nbsp;&nbsp;&nbsp;"."</t>
2486                                <t>C: "GET ENGINE INFO sfz"</t>
2487                                <t>S: "DESCRIPTION: SFZ Format Engine"</t>
2488                                <t>&nbsp;&nbsp;&nbsp;"VERSION: 1.11"</t>
2489                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
2490                          </list>                          </list>
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 2567  Schoenebeck'> Line 2579  Schoenebeck'>
2579                                      </t>                                      </t>
2580                                      <t>MIDI_INPUT_DEVICE -                                      <t>MIDI_INPUT_DEVICE -
2581                                          <list>                                          <list>
2582                                                <t>DEPRECATED: THIS FIELD WILL DISAPPEAR!</t>
2583                                              <t>numerical ID of the MIDI input device which is                                              <t>numerical ID of the MIDI input device which is
2584                                              currently connected to this sampler channel to deliver                                              currently connected to this sampler channel to deliver
2585                                              MIDI input commands, "-1" if there's no device                                              MIDI input commands, "-1" if there's no device
2586                                              connected to this sampler channel</t>                                              connected to this sampler channel</t>
2587                                                <t>Should not be used anymore as of LSCP v1.6 and younger.
2588                                                This field is currently only preserved for backward compatibility.
2589                                                </t>
2590                                                <t>This field a relict from times where only one MIDI input per
2591                                                sampler channel was allowed. Use <xref target="LIST CHANNEL MIDI_INPUTS">"GET CHANNEL MIDI_INPUTS"</xref>
2592                                                instead.</t>
2593                                          </list>                                          </list>
2594                                      </t>                                      </t>
2595                                      <t>MIDI_INPUT_PORT -                                      <t>MIDI_INPUT_PORT -
2596                                          <list>                                          <list>
2597                                                <t>DEPRECATED: THIS FIELD WILL DISAPPEAR!</t>
2598                                              <t>port number of the MIDI input device (in case a                                              <t>port number of the MIDI input device (in case a
2599                                              MIDI device was already assigned to the sampler                                              MIDI device was already assigned to the sampler
2600                                              channel)</t>                                              channel)</t>
2601                                                <t>Should not be used anymore as of LSCP v1.6 and younger.
2602                                                This field is currently only preserved for backward compatibility.
2603                                                </t>
2604                                                <t>This field a relict from times where only one MIDI input per
2605                                                sampler channel was allowed. Use <xref target="LIST CHANNEL MIDI_INPUTS">"GET CHANNEL MIDI_INPUTS"</xref>
2606                                                instead.</t>
2607                                          </list>                                          </list>
2608                                      </t>                                      </t>
2609                                      <t>MIDI_INPUT_CHANNEL -                                      <t>MIDI_INPUT_CHANNEL -
# Line 2626  Schoenebeck'> Line 2652  Schoenebeck'>
2652                      <t>                      <t>
2653                          <list>                          <list>
2654                              <t>C: "GET CHANNEL INFO 34"</t>                              <t>C: "GET CHANNEL INFO 34"</t>
2655                              <t>S: "ENGINE_NAME: GigEngine"</t>                              <t>S: "ENGINE_NAME: gig"</t>
2656                              <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>                              <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
2657                              <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_DEVICE: 0"</t>                              <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_DEVICE: 0"</t>
2658                              <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_CHANNELS: 2"</t>                              <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_CHANNELS: 2"</t>
# Line 2647  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 2674  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 2703  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 2756  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 2802  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 SOON!</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
2835                      channel by sending the following command:</t>                      channel by sending the following command:</t>
# Line 2843  Schoenebeck'> Line 2869  Schoenebeck'>
2869                              <t></t>                              <t></t>
2870                          </list>                          </list>
2871                      </t>                      </t>
2872                        <t>Deprecated:</t>
2873                        <t>
2874                            <list>
2875                                <t>Should not be used anymore. This command is currently only preserved for backward compatibility.</t>
2876                                <t>This command is a relict from times where there was no sophisticated driver management yet. Use <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> and <xref target="SET CHANNEL AUDIO_OUTPUT_DEVICE">"SET CHANNEL AUDIO_OUTPUT_DEVICE"</xref> instead.</t>
2877                            </list>
2878                        </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 2890  Schoenebeck'> Line 2923  Schoenebeck'>
2923                      </t>                      </t>
2924                  </section>                  </section>
2925    
2926                  <section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE">                  <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
2928                        channel by sending the following command:</t>
2929                        <t>
2930                            <list>
2931                                <t>ADD CHANNEL MIDI_INPUT &lt;sampler-channel&gt; &lt;midi-device-id&gt; [&lt;midi-input-port&gt;]</t>
2932                            </list>
2933                        </t>
2934                        <t>Where &lt;sampler-channel&gt; is the sampler channel number
2935                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2936                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command
2937                        and &lt;midi-device-id&gt; is the numerical ID of the MIDI input
2938                        device as returned by the
2939                        <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
2940                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command,
2941                        and &lt;midi-input-port&gt; is an optional MIDI input port number of that
2942                        MIDI input device. If &lt;midi-input-port&gt; is omitted,
2943                        then the MIDI input device's first port (port number 0) is
2944                        used.
2945                        </t>
2946    
2947                        <t>Possible Answers:</t>
2948                        <t>
2949                            <list>
2950                                <t>"OK" -
2951                                    <list>
2952                                        <t>on success</t>
2953                                    </list>
2954                                </t>
2955                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2956                                    <list>
2957                                        <t>if MIDI input port was connected, but there are noteworthy
2958                                        issue(s) related, providing an appropriate warning code and
2959                                        warning message</t>
2960                                    </list>
2961                                </t>
2962                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2963                                    <list>
2964                                        <t>in case it failed, providing an appropriate error code and error message</t>
2965                                    </list>
2966                                </t>
2967                            </list>
2968                        </t>
2969                        <t>Examples:</t>
2970                        <t>
2971                            <list>
2972                                <t>C: "ADD CHANNEL MIDI_INPUT 0 0"</t>
2973                                <t>S: "OK"</t>
2974                                <t>C: "ADD CHANNEL MIDI_INPUT 1 0"</t>
2975                                <t>S: "OK"</t>
2976                                <t>C: "ADD CHANNEL MIDI_INPUT 1 1 1"</t>
2977                                <t>S: "OK"</t>
2978                                <t>C: "ADD CHANNEL MIDI_INPUT 1 2 0"</t>
2979                                <t>S: "OK"</t>
2980                            </list>
2981                        </t>
2982                        <t>Since:</t>
2983                        <t>
2984                            <list>
2985                                <t>Introduced with LSCP v1.6</t>
2986                            </list>
2987                        </t>
2988                    </section>
2989    
2990                    <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
2992                        specific sampler channel by sending the following command:</t>
2993                        <t>
2994                            <list>
2995                                <t>REMOVE CHANNEL MIDI_INPUT &lt;sampler-channel&gt; [&lt;midi-device-id&gt; [&lt;midi-input-port&gt;]]</t>
2996                            </list>
2997                        </t>
2998                        <t>Where &lt;sampler-channel&gt; is the sampler channel number
2999                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3000                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command
3001                        and &lt;midi-device-id&gt; and &lt;midi-input-port&gt; are
3002                        optional numerical IDs defining the MIDI input device and
3003                        one of its MIDI ports as returned by the
3004                        <xref target="LIST CHANNEL MIDI_INPUTS">"LIST CHANNEL MIDI_INPUTS"</xref> command.
3005                        </t>
3006    
3007                        <t>
3008                        If &lt;midi-input-port&gt; is omitted, then all MIDI input
3009                        ports of &lt;midi-device-id&gt; are disconnected from this
3010                        sampler channel.
3011                        </t>
3012    
3013                        <t>
3014                        If both, &lt;midi-device-id&gt; and &lt;midi-input-port&gt;
3015                        are omitted, then all MIDI input ports currently connected
3016                        to this sampler channel are disconnected from this sampler
3017                        channel.
3018                        </t>
3019    
3020                        <t>Possible Answers:</t>
3021                        <t>
3022                            <list>
3023                                <t>"OK" -
3024                                    <list>
3025                                        <t>on success</t>
3026                                    </list>
3027                                </t>
3028                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3029                                    <list>
3030                                        <t>if MIDI input porst were disconnected, but there are noteworthy
3031                                        issue(s) related, providing an appropriate warning code and
3032                                        warning message</t>
3033                                    </list>
3034                                </t>
3035                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3036                                    <list>
3037                                        <t>in case it failed, providing an appropriate error code and error message</t>
3038                                    </list>
3039                                </t>
3040                            </list>
3041                        </t>
3042                        <t>Examples:</t>
3043                        <t>
3044                            <list>
3045                                <t>C: "REMOVE CHANNEL MIDI_INPUT 0"</t>
3046                                <t>S: "OK"</t>
3047                                <t>C: "REMOVE CHANNEL MIDI_INPUT 1"</t>
3048                                <t>S: "OK"</t>
3049                                <t>C: "REMOVE CHANNEL MIDI_INPUT 1 2 0"</t>
3050                                <t>S: "OK"</t>
3051                            </list>
3052                        </t>
3053                        <t>Since:</t>
3054                        <t>
3055                            <list>
3056                                <t>Introduced with LSCP v1.6</t>
3057                            </list>
3058                        </t>
3059                    </section>
3060    
3061                    <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
3063                        MIDI inputs of a certain sampler channel by sending the following
3064                        command:</t>
3065                        <t>
3066                            <list>
3067                                <t>LIST CHANNEL MIDI_INPUTS &lt;sampler-channel&gt;</t>
3068                            </list>
3069                        </t>
3070                        <t>Where &lt;sampler-channel&gt; is the sampler channel number
3071                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3072                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.
3073                        </t>
3074    
3075                        <t>Possible Answers:</t>
3076                        <t>
3077                            <list>
3078                                <t>The sampler will answer by sending a comma separated
3079                                list of MIDI input device ID - MIDI input port number pairs, where
3080                                each pair is encapsulated into curly braces. The
3081                                list is returned in one single line. The MIDI input
3082                                device ID corresponds to the number returned by
3083                                <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
3084                                and the port number is the index of the respective MIDI
3085                                port of that MIDI input device.</t>
3086                            </list>
3087                        </t>
3088    
3089                        <t>Example:</t>
3090                        <t>
3091                            <list>
3092                                <t>C: "LIST CHANNEL MIDI_INPUTS 0"</t>
3093                                <t>S: "{0,0},{1,3},{2,0}"</t>
3094                            </list>
3095                        </t>
3096    
3097                        <t>Since:</t>
3098                        <t>
3099                            <list>
3100                                <t>Introduced with LSCP v1.6</t>
3101                            </list>
3102                        </t>
3103                    </section>
3104    
3105                    <section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE" lscp_cmd="true">
3106                        <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
3109                      channel by sending the following command:</t>                      channel by sending the following command:</t>
3110                      <t>                      <t>
# Line 2905  Schoenebeck'> Line 3119  Schoenebeck'>
3119                      <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>                      <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
3120                      or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command.</t>                      or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command.</t>
3121    
3122                        <t>
3123                        If more than 1 MIDI inputs are currently connected to this
3124                        sampler channel: Sending this command will disconnect ALL
3125                        currently connected MIDI input ports connected to this
3126                        sampler channel before establishing the new MIDI input
3127                        connection. So this command does NOT add the connection,
3128                        it replaces all existing ones instead. This behavior is due
3129                        to preserving full behavior backward compatibility.
3130                        </t>
3131    
3132                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
3133                      <t>                      <t>
3134                          <list>                          <list>
# Line 2933  Schoenebeck'> Line 3157  Schoenebeck'>
3157                              <t></t>                              <t></t>
3158                          </list>                          </list>
3159                      </t>                      </t>
3160                        <t>Deprecated:</t>
3161                        <t>
3162                            <list>
3163                                <t>Should not be used anymore as of LSCP v1.6 and younger. This command is currently only preserved for backward compatibility.</t>
3164                                <t>This command is a relict from times where only one MIDI input per sampler channel was allowed. Use <xref target="ADD CHANNEL MIDI_INPUT">"ADD CHANNEL MIDI_INPUT"</xref> and <xref target="REMOVE CHANNEL MIDI_INPUT">"REMOVE CHANNEL MIDI_INPUT"</xref> instead.</t>
3165                            </list>
3166                        </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 SOON!</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
3173                      channel by sending the following command:</t>                      channel by sending the following command:</t>
# Line 2948  Schoenebeck'> Line 3179  Schoenebeck'>
3179                      <t>Where &lt;midi-input-type&gt; is currently only "ALSA" and                      <t>Where &lt;midi-input-type&gt; is currently only "ALSA" and
3180                      &lt;sampler-channel&gt; is the respective sampler channel number.</t>                      &lt;sampler-channel&gt; is the respective sampler channel number.</t>
3181    
3182                        <t>
3183                        If more than 1 MIDI inputs are currently connected to this
3184                        sampler channel: Sending this command will disconnect ALL
3185                        currently connected MIDI input ports connected to this
3186                        sampler channel before establishing the new MIDI input
3187                        connection. So this command does NOT add the connection,
3188                        it replaces all existing ones instead. This behavior is due
3189                        to preserving full behavior backward compatibility.
3190                        </t>
3191    
3192                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
3193                      <t>                      <t>
3194                          <list>                          <list>
# Line 2976  Schoenebeck'> Line 3217  Schoenebeck'>
3217                              <t></t>                              <t></t>
3218                          </list>                          </list>
3219                      </t>                      </t>
3220                        <t>Deprecated:</t>
3221                        <t>
3222                            <list>
3223                                <t>Should not be used anymore. This command is currently only preserved for backward compatibility.</t>
3224                                <t>This command is a relict from times where only 1 MIDI input per sampler channels was allowed and where no sophisticated driver management existed yet. Use <xref target="ADD CHANNEL MIDI_INPUT">"ADD CHANNEL MIDI_INPUT"</xref> and <xref target="REMOVE CHANNEL MIDI_INPUT">"REMOVE CHANNEL MIDI_INPUT"</xref> instead.</t>
3225                            </list>
3226                        </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>
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
3233                      channel by sending the following command:</t>                      channel by sending the following command:</t>
3234                      <t>                      <t>
# Line 2989  Schoenebeck'> Line 3239  Schoenebeck'>
3239                      <t>Where &lt;midi-input-port&gt; is a MIDI input port number of the                      <t>Where &lt;midi-input-port&gt; is a MIDI input port number of the
3240                      MIDI input device connected to the sampler channel given by                      MIDI input device connected to the sampler channel given by
3241                      &lt;sampler-channel&gt;.</t>                      &lt;sampler-channel&gt;.</t>
3242                        
3243                        <t>
3244                        If more than 1 MIDI inputs are currently connected to this
3245                        sampler channel: Sending this command will switch the
3246                        connection of the first (and only the first) MIDI input port
3247                        currently being connected to this sampler channel, to
3248                        another port of the same MIDI input device. Or in other
3249                        words: the first MIDI input port currently connected to
3250                        this sampler channel will be disconnected, and the requested
3251                        other port of its MIDI input device will be connected to
3252                        this sampler channel instead. This behavior is due
3253                        to preserving full behavior backward compatibility.
3254                        </t>
3255    
3256                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
3257                      <t>                      <t>
# Line 3018  Schoenebeck'> Line 3281  Schoenebeck'>
3281                              <t></t>                              <t></t>
3282                          </list>                          </list>
3283                      </t>                      </t>
3284                        <t>Deprecated:</t>
3285                        <t>
3286                            <list>
3287                                <t>Should not be used anymore. This command is currently only preserved for backward compatibility.</t>
3288                                <t>This command is a relict from times where only one MIDI input per sampler channel was allowed. Use <xref target="ADD CHANNEL MIDI_INPUT">"ADD CHANNEL MIDI_INPUT"</xref> and <xref target="REMOVE CHANNEL MIDI_INPUT">"REMOVE CHANNEL MIDI_INPUT"</xref> instead.</t>
3289                            </list>
3290                        </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 3028  Schoenebeck'> Line 3298  Schoenebeck'>
3298                              <t>SET CHANNEL MIDI_INPUT_CHANNEL &lt;sampler-channel&gt; &lt;midi-input-chan&gt;</t>                              <t>SET CHANNEL MIDI_INPUT_CHANNEL &lt;sampler-channel&gt; &lt;midi-input-chan&gt;</t>
3299                          </list>                          </list>
3300                      </t>                      </t>
3301                      <t>Where &lt;midi-input-chan&gt; is the number of the new MIDI input channel where                      <t>Where &lt;midi-input-chan&gt; is the number
3302                      &lt;sampler-channel&gt; should listen to or "ALL" to listen on all 16 MIDI                      of the new MIDI input channel (zero indexed!) where
3303                        &lt;sampler-channel&gt; should listen to, or "ALL" to listen on all 16 MIDI
3304                      channels.</t>                      channels.</t>
3305    
3306                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 3057  Schoenebeck'> Line 3328  Schoenebeck'>
3328                      <t>Examples:</t>                      <t>Examples:</t>
3329                      <t>                      <t>
3330                          <list>                          <list>
3331                              <t></t>                              <t>C: "SET CHANNEL MIDI_INPUT_CHANNEL 0 0"</t>
3332                                <t>S: "OK"</t>
3333                                <t>C: "SET CHANNEL MIDI_INPUT_CHANNEL 1 ALL"</t>
3334                                <t>S: "OK"</t>
3335                          </list>                          </list>
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 3105  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 3149  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 3193  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 3261  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 3279  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 3331  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 3373  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 3402  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 3438  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 3495  Schoenebeck'> Line 3777  Schoenebeck'>
3777                                              channel 1 is routed to the channel 3 of the audio                                              channel 1 is routed to the channel 3 of the audio
3778                                              output device (see                                              output device (see
3779                                              <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>                                              <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>
3780                                              for details)</t>                                              for details), if an internal send
3781                                                effect is assigned to the effect
3782                                                send, then this setting defines the
3783                                                audio channel routing to that
3784                                                effect instance respectively</t>
3785                                            </list>
3786                                        </t>
3787                                        <t>EFFECT -
3788                                            <list>
3789                                                <t>destination send effect chain ID
3790                                                and destination effect chain
3791                                                position, separated by comma in the
3792                                                form "&lt;effect-chain&gt;,&lt;chain-pos&gt;"
3793                                                or "NONE" if there is no send effect
3794                                                assigned to the effect send</t>
3795                                          </list>                                          </list>
3796                                      </t>                                      </t>
3797                                  </list>                                  </list>
# Line 3512  Schoenebeck'> Line 3808  Schoenebeck'>
3808                              <t>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"</t>                              <t>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"</t>
3809                              <t>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"</t>                              <t>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"</t>
3810                              <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"</t>                              <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"</t>
3811                                <t>&nbsp;&nbsp;&nbsp;"EFFECT: NONE"</t>
3812                                <t>&nbsp;&nbsp;&nbsp;"."</t>
3813                            </list>
3814                        </t>
3815                        <t>
3816                            <list>
3817                                <t>C: "GET FX_SEND INFO 0 1"</t>
3818                                <t>S: "NAME: Delay Send (Internal)"</t>
3819                                <t>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 93"</t>
3820                                <t>&nbsp;&nbsp;&nbsp;"LEVEL: 0.51"</t>
3821                                <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 1,2"</t>
3822                                <t>&nbsp;&nbsp;&nbsp;"EFFECT: 2,0"</t>
3823                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
3824                          </list>                          </list>
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 3561  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 3577  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.</t>                      device (i.e. if external effect shall be applied) or b) of the audio
3890                        input channel of an internal effect assigned to the FX send where
3891                        &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 3621  Schoenebeck'> Line 3931  Schoenebeck'>
3931                      </t>                      </t>
3932                  </section>                  </section>
3933    
3934                  <section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER">                  <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 an internal destination effect to an
3936                        effect send by sending the following command:</t>
3937                        <t>
3938                            <list>
3939                                <t>SET FX_SEND EFFECT &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;effect-chain&gt; &lt;chain-pos&gt;</t>
3940                            </list>
3941                        </t>
3942                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3943                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3944                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3945                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3946                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3947                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command,
3948                        &lt;effect-chain&gt; by the numerical ID of the destination
3949                        effect chain as returned by the
3950                        <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
3951                        or
3952                        <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
3953                        command and &lt;chain-pos&gt; reflects the exact effect
3954                        chain position in the effect chain which hosts the actual
3955                        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>
3968                        <t>
3969                            <list>
3970                                <t>"OK" -
3971                                    <list>
3972                                        <t>on success</t>
3973                                    </list>
3974                                </t>
3975                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3976                                    <list>
3977                                        <t>in case it failed, providing an appropriate error code and error message</t>
3978                                    </list>
3979                                </t>
3980                            </list>
3981                        </t>
3982                        <t>Example:</t>
3983                        <t>
3984                            <list>
3985                                <t>C: "SET FX_SEND EFFECT 0 0 2 5"</t>
3986                                <t>S: "OK"</t>
3987                            </list>
3988                        </t>
3989                    </section>
3990    
3991                    <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
3993                        effect send by sending the following command:</t>
3994                        <t>
3995                            <list>
3996                                <t>REMOVE FX_SEND EFFECT &lt;sampler-chan&gt; &lt;fx-send-id&gt;</t>
3997                            </list>
3998                        </t>
3999                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
4000                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
4001                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
4002                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
4003                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
4004                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t>
4005    
4006                        <t>After the destination effect has been removed from the
4007                        effect send, the audio signal of the effect send will be
4008                        routed directly to the audio output device, according to the
4009                        audio channel routing setting of the effect send.
4010                        </t>
4011    
4012                        <t>Possible Answers:</t>
4013                        <t>
4014                            <list>
4015                                <t>"OK" -
4016                                    <list>
4017                                        <t>on success</t>
4018                                    </list>
4019                                </t>
4020                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4021                                    <list>
4022                                        <t>in case it failed, providing an appropriate error code and error message</t>
4023                                    </list>
4024                                </t>
4025                            </list>
4026                        </t>
4027                        <t>Example:</t>
4028                        <t>
4029                            <list>
4030                                <t>C: "REMOVE FX_SEND EFFECT 0 0"</t>
4031                                <t>S: "OK"</t>
4032                            </list>
4033                        </t>
4034                    </section>
4035    
4036                    <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 3669  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 3718  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 3783  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 3831  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 3873  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 3915  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 3953  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 3968  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 3986  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 4004  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 4048  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 4097  Schoenebeck'> Line 4509  Schoenebeck'>
4509                      </t>                      </t>
4510                      <t>The mentioned fields above don't have to be in particular order.                      <t>The mentioned fields above don't have to be in particular order.
4511                      Other fields might be added in future.</t>                      Other fields might be added in future.</t>
4512                        
4513                        <t>Example:</t>
4514                        <t>
4515                            <list>
4516                                <t>C: "GET SERVER INFO"</t>
4517                                <t>S: "DESCRIPTION: LinuxSampler - modular, streaming capable sampler"</t>
4518                                <t>&nbsp;&nbsp;&nbsp;"VERSION: 1.0.0.svn23"</t>
4519                                <t>&nbsp;&nbsp;&nbsp;"PROTOCOL_VERSION: 1.5"</t>
4520                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENTS_DB_SUPPORT: no"</t>
4521                                <t>&nbsp;&nbsp;&nbsp;"."</t>
4522                            </list>
4523                        </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 4121  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 4158  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 4183  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 4227  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 4250  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 4324  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 4380  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 4430  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 4456  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 4481  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 4536  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 4576  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 4749  Schoenebeck'> Line 5173  Schoenebeck'>
5173                      </t>                      </t>
5174                  </section>                  </section>
5175    
5176                  <section title="Getting ammount 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 4789  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 4818  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 4832  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 4874  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 4971  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 5036  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 5074  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 5113  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 5148  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 5188  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 5247  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 5285  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 5327  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 5369  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 5407  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 5497  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 5590  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 5627  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 5662  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 5702  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 5827  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 5865  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 5905  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 5945  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 5983  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 6124  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 6188  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 6216  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 6246  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 6297  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 6362  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 6410  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 6454  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 6475  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 6554  Schoenebeck'> Line 6978  Schoenebeck'>
6978                      </t>                      </t>
6979                  </section>                  </section>
6980              </section>              </section>
6981                <section title="Managing Effects" anchor="effects">
6982                    <t>There are two possible approaches to apply audio effects
6983                    (e.g. reverb, delay, compression).
6984                    You can either a) load and apply internal effects or you can b) route
6985                    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
6999                    sampler runs on (e.g. LADSPA plugins).</t>
7000                    <t>At the moment only "send effects" are supported. Support for
7001                    "insert effects" and "master effects" is planned to be added at
7002                    a later point.</t>
7003                    <t>The following commands allow to retrieve the set of internal
7004                    effects available to the sampler, detailed information about
7005                    those effects and to create and destroy instances of such
7006                    effects. After an instance of an effect is created, the effect
7007                    instance can be inserted into the audio signal path of the
7008                    sampler, e.g. as send effect.</t>
7009                    <t>The sampler allows to create an arbitrary amount of so called
7010                    send effect chains. Each effect chain can host an arbitrary
7011                    amount of effect instances. The output of the first effect
7012                    instance in an effect chain is fed to the input of the second
7013                    effect instance of the chain and so on. So effects in one chain
7014                    are processed sequentially. Send effect chains however are
7015                    processed in parallel to other send effect chains. Audio signals
7016                    of sampler channels are fed to send effects by creating FX sends
7017                    to the respective sampler channel and assigning a destination
7018                    send effect to that FX by using the
7019                    <xref target="SET FX_SEND EFFECT">"SET FX_SEND EFFECT"</xref>
7020                    command. The latter allows to route the FX send to the beginning
7021                    of a send effect chain, as well as directly to any other
7022                    position of the send effect chain.</t>
7023    
7024                    <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
7026                        effects, available to the sampler by sending
7027                        the following command:</t>
7028                        <t>
7029                            <list>
7030                                <t>GET AVAILABLE_EFFECTS</t>
7031                            </list>
7032                        </t>
7033    
7034                        <t>Possible Answers:</t>
7035                        <t>
7036                            <list>
7037                                <t>The sampler will answer by returning the current
7038                                number of effects available to the sampler.</t>
7039                            </list>
7040                        </t>
7041    
7042                        <t>Examples:</t>
7043                        <t>
7044                            <list>
7045                                <t>C: "GET AVAILABLE_EFFECTS"</t>
7046                                <t>S: "129"</t>
7047                            </list>
7048                        </t>
7049                    </section>
7050    
7051                    <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
7053                        runtime. The front-end can retrieve the list of internal
7054                        effects, available to the sampler by sending the following
7055                        command:</t>
7056                        <t>
7057                            <list>
7058                                <t>LIST AVAILABLE_EFFECTS</t>
7059                            </list>
7060                        </t>
7061    
7062                        <t>Possible Answers:</t>
7063                        <t>
7064                            <list>
7065                                <t>The sampler will answer by returning a comma
7066                                separated list with numerical IDs of effects. Note:
7067                                the numercial ID of an effect is generated by the
7068                                sampler for the current moment. The numerical ID of
7069                                the same effect can change at runtime, e.g. when the
7070                                user requests a rescan of available effect plugins.
7071                                </t>
7072                            </list>
7073                        </t>
7074                        <t>Example:</t>
7075                        <t>
7076                            <list>
7077                                <t>C: "LIST AVAILABLE_EFFECTS"</t>
7078                                <t>S: "5,6,7,120,121,122,123,124"</t>
7079                            </list>
7080                        </t>
7081                    </section>
7082    
7083                    <section title="Retrieving general information about an effect" anchor="GET EFFECT INFO" lscp_cmd="true">
7084                        <t>The front-end can ask for general information about an
7085                        effect by sending the following command:</t>
7086                        <t>
7087                            <list>
7088                                <t>GET EFFECT INFO &lt;effect-index&gt;</t>
7089                            </list>
7090                        </t>
7091                        <t>Where &lt;effect-index&gt; is the numerical ID of an
7092                        effect as returned by the
7093                        <xref target="LIST AVAILABLE_EFFECTS">"LIST AVAILABLE_EFFECTS"</xref>
7094                        command.</t>
7095                        <t>Possible Answers:</t>
7096                        <t>
7097                            <list>
7098                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
7099                                Each answer line begins with the effect information
7100                                category name, followed by a colon and then a space
7101                                character &lt;SP&gt; and finally the info character
7102                                string to that effect information category. At the
7103                                moment the following categories are defined:</t>
7104                                <t>
7105                                    <list>
7106                                        <t>SYSTEM -
7107                                            <list>
7108                                                <t>name of the effect plugin system
7109                                                the effect is based on
7110                                                (e.g. "LADSPA")</t>
7111                                            </list>
7112                                        </t>
7113                                        <t>MODULE -
7114                                            <list>
7115                                                <t>module of the effect plugin
7116                                                system that contains this effect,
7117                                                the module is usually the
7118                                                dynamic-linked library (DLL)
7119                                                filename of the effect plugin,
7120                                                including full path (note that this
7121                                                filename may contain
7122                                                <xref target="character_set">escape sequences</xref>)</t>
7123                                            </list>
7124                                        </t>
7125                                        <t>NAME -
7126                                            <list>
7127                                                <t>character string defining the
7128                                                unique name of the effect within its
7129                                                module (note that the character
7130                                                string may contain
7131                                                <xref target="character_set">escape sequences</xref>)</t>
7132                                            </list>
7133                                        </t>
7134                                        <t>DESCRIPTION -
7135                                            <list>
7136                                                <t>human readable name of the
7137                                                effect, intended to be displayed in
7138                                                user interfaces (note that the
7139                                                character string may contain
7140                                                <xref target="character_set">escape sequences</xref>)</t>
7141                                            </list>
7142                                        </t>
7143                                    </list>
7144                                </t>
7145                            </list>
7146                        </t>
7147                        <t>The mentioned fields above don't have to be in particular order.</t>
7148    
7149                        <t>Example:</t>
7150                        <t>
7151                            <list>
7152                                <t>C: "GET EFFECT INFO 121"</t>
7153                                <t>S: "SYSTEM: LADSPA"</t>
7154                                <t>&nbsp;&nbsp;&nbsp;"MODULE: /usr/lib/ladspa/lowpass_iir_1891.so"</t>
7155                                <t>&nbsp;&nbsp;&nbsp;"NAME: lowpass_iir"</t>
7156                                <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: Glame Lowpass Filter"</t>
7157                                <t>&nbsp;&nbsp;&nbsp;"."</t>
7158                            </list>
7159                        </t>
7160                    </section>
7161    
7162                    <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
7164                        effect by sending the following command:</t>
7165                        <t>
7166                            <list>
7167                                <t>CREATE EFFECT_INSTANCE &lt;effect-system&gt; &lt;module&gt; &lt;effect-name&gt;</t>
7168                            </list>
7169                        </t>
7170                        <t>Where &lt;effect-system&gt; is the "SYSTEM" field,
7171                        &lt;module&gt; the "MODULE" field and &lt;effect-name&gt;
7172                        the "NAME" field as returned by the
7173                        <xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref>
7174                        command. The filename of argument &lt;module&gt; and the
7175                        character string of argument &lt;effect-name&gt; may contain
7176                        <xref target="character_set">escape sequences</xref>.</t>
7177    
7178                        <t>The sampler will try to load the requested effect and to
7179                        create an instance of it. To allow loading the same effect
7180                        on a different machine, probably even running a completely
7181                        different operating system (e.g. Linux vs. Windows), the
7182                        sampler tries to match &lt;module&gt; "softly". That means
7183                        it first tries to find an effect that exactly matches the
7184                        given &lt;module&gt; argument. If there is no exact match,
7185                        the sampler will try to lower the restrictions on matching
7186                        the &lt;module&gt; argument more and more, e.g. by ignoring
7187                        upper / lower case differences and by ignoring the path of
7188                        the DLL filename and file extension. If there is still no
7189                        match at the end, the sampler will try to ignore the
7190                        &lt;module&gt; argument completely and as a last resort
7191                        search for an effect that only matches the given
7192                        &lt;effect-system&gt; and &lt;effect-name&gt; arguments.</t>
7193    
7194                        <t>Possible Answers:</t>
7195                        <t>
7196                            <list>
7197                                <t>"OK[&lt;effect-instance&gt;]" -
7198                                    <list>
7199                                        <t>in case the effect instance was
7200                                        successfully created, where
7201                                        &lt;effect-instance&gt; is the numerical ID
7202                                        of the new effect instance</t>
7203                                    </list>
7204                                </t>
7205                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
7206                                    <list>
7207                                        <t>in case the effect instance was spawned
7208                                        successfully, but there are noteworthy
7209                                        issue(s) related, providing an appropriate
7210                                        warning code and warning message</t>
7211                                    </list>
7212                                </t>
7213                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7214                                    <list>
7215                                        <t>if the effect could not be instantiated</t>
7216                                    </list>
7217                                </t>
7218                            </list>
7219                        </t>
7220    
7221                        <t>Examples:</t>
7222                        <t>
7223                            <list>
7224                                <t>C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/mod_delay_1419.so' 'modDelay'"</t>
7225                                <t>S: "OK[0]"</t>
7226                            </list>
7227                        </t>
7228                    </section>
7229    
7230                    <section title="Creating an instance of an effect by its numerical ID" anchor="CREATE EFFECT_INSTANCE (non-portable)">
7231                        <t>The front-end can spawn an instance of the desired
7232                        effect by sending the following command:</t>
7233                        <t>
7234                            <list>
7235                                <t>CREATE EFFECT_INSTANCE &lt;effect-index&gt;</t>
7236                            </list>
7237                        </t>
7238                        <t>Where &lt;effect-index&gt; is the numerical ID of the
7239                        effect as returned by the
7240                        <xref target="LIST AVAILABLE_EFFECTS">"LIST AVAILABLE_EFFECTS"</xref>
7241                        command.</t>
7242    
7243                        <t>The sampler will try to load the requested effect and to
7244                        create an instance of it.</t>
7245    
7246                        <t>Note: Since the numerical ID of a certain effect can
7247                        change at any time, you should not use this command in
7248                        LSCP files to restore a certain effect at a later time! To
7249                        store a sampler session including all its effects, use the
7250                        <xref target="CREATE EFFECT_INSTANCE">portable text-based
7251                        version of "CREATE EFFECT_INSTANCE"</xref> instead! This
7252                        allows to restore a sampler session with all its effects
7253                        also on other machines, possibly even running a completely
7254                        different operating system (e.g. Linux vs. Windows), with
7255                        different plugin directories or plugin DLL names.</t>
7256    
7257                        <t>Possible Answers:</t>
7258                        <t>
7259                            <list>
7260                                <t>"OK[&lt;effect-instance&gt;]" -
7261                                    <list>
7262                                        <t>in case the effect instance was
7263                                        successfully created, where
7264                                        &lt;effect-instance&gt; is the numerical ID
7265                                        of the new effect instance</t>
7266                                    </list>
7267                                </t>
7268                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
7269                                    <list>
7270                                        <t>in case the effect instance was spawned
7271                                        successfully, but there are noteworthy
7272                                        issue(s) related, providing an appropriate
7273                                        warning code and warning message</t>
7274                                    </list>
7275                                </t>
7276                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7277                                    <list>
7278                                        <t>if the effect could not be instantiated</t>
7279                                    </list>
7280                                </t>
7281                            </list>
7282                        </t>
7283    
7284                        <t>Examples:</t>
7285                        <t>
7286                            <list>
7287                                <t>C: "CREATE EFFECT_INSTANCE 72"</t>
7288                                <t>S: "OK[5]"</t>
7289                            </list>
7290                        </t>
7291                    </section>
7292    
7293                    <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
7295                        thus freeing it from memory by sending the following command:</t>
7296                        <t>
7297                            <list>
7298                                <t>DESTROY EFFECT_INSTANCE &lt;effect-instance&gt;</t>
7299                            </list>
7300                        </t>
7301                        <t>Where &lt;effect-instance&gt; is the numerical ID of the
7302                        effect instance as returned by the
7303                        <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or
7304                        <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
7305                        command.</t>
7306    
7307                        <t>The effect instance can only be destroyed if it's not
7308                        used in any part of the sampler's audio signal path anymore.
7309                        If the effect instance is still in use somewhere, trying to
7310                        destroy the effect instance will result in an error
7311                        message.</t>
7312    
7313                        <t>Possible Answers:</t>
7314                        <t>
7315                            <list>
7316                                <t>"OK" -
7317                                    <list>
7318                                        <t>in case the effect instance was successfully destroyed</t>
7319                                    </list>
7320                                </t>
7321                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7322                                    <list>
7323                                        <t>in case it failed, providing an appropriate error code and
7324                                        error message</t>
7325                                    </list>
7326                                </t>
7327                            </list>
7328                        </t>
7329    
7330                        <t>Examples:</t>
7331                        <t>
7332                            <list>
7333                                <t>C: "DESTROY EFFECT_INSTANCE 5"</t>
7334                                <t>S: "OK"</t>
7335                            </list>
7336                        </t>
7337                    </section>
7338    
7339                    <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
7341                        instances by sending the following command:</t>
7342                        <t>
7343                            <list>
7344                                <t>GET EFFECT_INSTANCES</t>
7345                            </list>
7346                        </t>
7347    
7348                        <t>Possible Answers:</t>
7349                        <t>
7350                            <list>
7351                                <t>The sampler will answer by returning the current
7352                                number of effect instances created and not yet
7353                                destroyed in the current sampler session.</t>
7354                            </list>
7355                        </t>
7356    
7357                        <t>Examples:</t>
7358                        <t>
7359                            <list>
7360                                <t>C: "GET EFFECT_INSTANCES"</t>
7361                                <t>S: "14"</t>
7362                            </list>
7363                        </t>
7364                    </section>
7365    
7366                    <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
7368                        instances by sending the following command:</t>
7369                        <t>
7370                            <list>
7371                                <t>LIST EFFECT_INSTANCES</t>
7372                            </list>
7373                        </t>
7374    
7375                        <t>Possible Answers:</t>
7376                        <t>
7377                            <list>
7378                                <t>The sampler will answer by returning a comma
7379                                separated list with numerical IDs of effects
7380                                instances.
7381                                </t>
7382                            </list>
7383                        </t>
7384                        <t>Example:</t>
7385                        <t>
7386                            <list>
7387                                <t>C: "LIST EFFECT_INSTANCES"</t>
7388                                <t>S: "9,11,14,15,16,17,25"</t>
7389                            </list>
7390                        </t>
7391                    </section>
7392    
7393                    <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 information about
7395                        a particular effect instance by sending the following command:</t>
7396                        <t>
7397                            <list>
7398                                <t>GET EFFECT_INSTANCE INFO &lt;effect-instance&gt;</t>
7399                            </list>
7400                        </t>
7401                        <t>Where &lt;effect-instance&gt; is the numerical ID of an
7402                        effect instance as returned by the
7403                        <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref>
7404                        or
7405                        <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
7406                        command.</t>
7407    
7408                        <t>Possible Answers:</t>
7409                        <t>
7410                            <list>
7411                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
7412                                Each answer line begins with the information
7413                                category name, followed by a colon and then a space
7414                                character &lt;SP&gt; and finally the info character
7415                                string to that information category. At the
7416                                moment the following categories are defined:</t>
7417                                <t>
7418                                    <list>
7419                                        <t>SYSTEM -
7420                                            <list>
7421                                                <t>name of the effect plugin system
7422                                                the effect is based on
7423                                                (e.g. "LADSPA")</t>
7424                                            </list>
7425                                        </t>
7426                                        <t>MODULE -
7427                                            <list>
7428                                                <t>module of the effect plugin
7429                                                system that contains this effect,
7430                                                the module is usually the
7431                                                dynamic-linked library (DLL)
7432                                                filename of the effect plugin,
7433                                                including full path (note that this
7434                                                filename may contain
7435                                                <xref target="character_set">escape sequences</xref>)</t>
7436                                            </list>
7437                                        </t>
7438                                        <t>NAME -
7439                                            <list>
7440                                                <t>character string defining the
7441                                                unique name of the effect within its
7442                                                module (note that the character
7443                                                string may contain
7444                                                <xref target="character_set">escape sequences</xref>)</t>
7445                                            </list>
7446                                        </t>
7447                                        <t>DESCRIPTION -
7448                                            <list>
7449                                                <t>human readable name of the
7450                                                effect, intended to be displayed in
7451                                                user interfaces (note that the
7452                                                character string may contain
7453                                                <xref target="character_set">escape sequences</xref>)</t>
7454                                            </list>
7455                                        </t>
7456                                        <t>INPUT_CONTROLS -
7457                                            <list>
7458                                                <t>amount of input controls the
7459                                                effect instance provides, to allow
7460                                                controlling the effect parameters in
7461                                                realtime</t>
7462                                            </list>
7463                                        </t>
7464                                    </list>
7465                                </t>
7466                            </list>
7467                        </t>
7468                        <t>The mentioned fields above don't have to be in particular order.</t>
7469    
7470                        <t>Example:</t>
7471                        <t>
7472                            <list>
7473                                <t>C: "GET EFFECT_INSTANCE INFO 3"</t>
7474                                <t>S: "SYSTEM: LADSPA"</t>
7475                                <t>&nbsp;&nbsp;&nbsp;"MODULE: /usr/lib/ladspa/mod_delay_1419.so"</t>
7476                                <t>&nbsp;&nbsp;&nbsp;"NAME: modDelay"</t>
7477                                <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: Modulatable delay"</t>
7478                                <t>&nbsp;&nbsp;&nbsp;"INPUT_CONTROLS: 1"</t>
7479                                <t>&nbsp;&nbsp;&nbsp;"."</t>
7480                            </list>
7481                        </t>
7482                    </section>
7483    
7484                    <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
7486                        parameters which can be altered by the user in realtime
7487                        (e.g. depth of a reverb effect, duration of a delay effect,
7488                        dry / wet signal ratio). Those controllable effect parameters
7489                        are called "input controls". The front-end can ask for the
7490                        current information of an effect instance's input control
7491                        by sending the following command:</t>
7492                        <t>
7493                            <list>
7494                                <t>GET EFFECT_INSTANCE_INPUT_CONTROL INFO &lt;effect-instance&gt; &lt;input-control&gt;</t>
7495                            </list>
7496                        </t>
7497                        <t>Where &lt;effect-instance&gt; is the numerical ID of an
7498                        effect instance as returned by the
7499                        <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref>
7500                        or
7501                        <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
7502                        command and &lt;input-control&gt; is the index of the input
7503                        control within the numerical bounds as returned by the
7504                        "INPUT_CONTROLS" field of the
7505                        <xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref>
7506                        command.</t>
7507    
7508                        <t>Possible Answers:</t>
7509                        <t>
7510                            <list>
7511                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
7512                                Each answer line begins with the information
7513                                category name, followed by a colon and then a space
7514                                character &lt;SP&gt; and finally the info character
7515                                string to that information category. There are
7516                                information categories which are always returned,
7517                                independent of the respective effect parameter and
7518                                there are optional information categories
7519                                which are only shown for certain effect parameters.
7520                                At the moment the following categories are defined:</t>
7521                                <t>
7522                                    <list>
7523                                        <t>DESCRIPTION -
7524                                            <list>
7525                                                <t>(always returned)
7526                                                human readable name of the
7527                                                effect parameter, intended to be
7528                                                displayed in user interfaces (note
7529                                                that the character string may
7530                                                contain <xref target="character_set">escape sequences</xref>)</t>
7531                                            </list>
7532                                        </t>
7533                                        <t>VALUE -
7534                                            <list>
7535                                                <t>
7536                                                (always returned)
7537                                                current (optional dotted)
7538                                                floating point value of this effect
7539                                                parameter</t>
7540                                            </list>
7541                                        </t>
7542                                        <t>RANGE_MIN -
7543                                            <list>
7544                                                <t>
7545                                                (optionally returned)
7546                                                minimum allowed value for this
7547                                                effect parameter</t>
7548                                            </list>
7549                                        </t>
7550                                        <t>RANGE_MAX -
7551                                            <list>
7552                                                <t>
7553                                                (optionally returned)
7554                                                maximum allowed value for this
7555                                                effect parameter</t>
7556                                            </list>
7557                                        </t>
7558                                        <t>POSSIBILITIES -
7559                                            <list>
7560                                                <t>
7561                                                (optionally returned)
7562                                                comma separated list of
7563                                                (optional dotted) floating point
7564                                                numbers, reflecting the exact set of
7565                                                possible values for this effect
7566                                                parameter</t>
7567                                            </list>
7568                                        </t>
7569                                        <t>DEFAULT -
7570                                            <list>
7571                                                <t>
7572                                                (optionally returned)
7573                                                default value of this effect
7574                                                parameter</t>
7575                                            </list>
7576                                        </t>
7577                                    </list>
7578                                </t>
7579                            </list>
7580                        </t>
7581                        <t>The mentioned fields above don't have to be in particular order.</t>
7582    
7583                        <t>Example:</t>
7584                        <t>
7585                            <list>
7586                                <t>C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0"</t>
7587                                <t>S: "DESCRIPTION: Base delay (s)"</t>
7588                                <t>&nbsp;&nbsp;&nbsp;"VALUE: 0.500"</t>
7589                                <t>&nbsp;&nbsp;&nbsp;"RANGE_MIN: 0.000"</t>
7590                                <t>&nbsp;&nbsp;&nbsp;"."</t>
7591                            </list>
7592                        </t>
7593                    </section>
7594    
7595                    <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
7597                        parameter by sending the following command:</t>
7598                        <t>
7599                            <list>
7600                                <t>SET EFFECT_INSTANCE_INPUT_CONTROL VALUE &lt;effect-instance&gt; &lt;input-control&gt; &lt;value&gt;</t>
7601                            </list>
7602                        </t>
7603                        <t>Where &lt;effect-instance&gt; is the numerical ID of the
7604                        effect instance as returned by the
7605                        <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or
7606                        <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
7607                        command, &lt;input-control&gt; is the index of the input
7608                        control within the numerical bounds as returned by the
7609                        "INPUT_CONTROLS" field of the
7610                        <xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref>
7611                        command and &lt;value&gt; is the new (optional dotted)
7612                        floating point value for this effect parameter.</t>
7613    
7614                        <t>Possible Answers:</t>
7615                        <t>
7616                            <list>
7617                                <t>"OK" -
7618                                    <list>
7619                                        <t>in case the effect was altered successfully</t>
7620                                    </list>
7621                                </t>
7622                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7623                                    <list>
7624                                        <t>in case it failed, providing an appropriate error code and
7625                                        error message</t>
7626                                    </list>
7627                                </t>
7628                            </list>
7629                        </t>
7630    
7631                        <t>Examples:</t>
7632                        <t>
7633                            <list>
7634                                <t>C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5"</t>
7635                                <t>S: "OK"</t>
7636                            </list>
7637                        </t>
7638                    </section>
7639    
7640                    <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
7642                        effect chains of an audio output device by sending the
7643                        following command:</t>
7644                        <t>
7645                            <list>
7646                                <t>GET SEND_EFFECT_CHAINS &lt;audio-device&gt;</t>
7647                            </list>
7648                        </t>
7649                        <t>Where &lt;audio-device&gt; should be replaced by the
7650                        numerical ID of the audio output device as given by the
7651                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7652                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7653                        command.</t>
7654    
7655                        <t>Possible Answers:</t>
7656                        <t>
7657                            <list>
7658                                <t>The sampler will answer by returning the current
7659                                number of send effect chains of the supplied audio
7660                                output device.</t>
7661                            </list>
7662                        </t>
7663    
7664                        <t>Examples:</t>
7665                        <t>
7666                            <list>
7667                                <t>C: "GET SEND_EFFECT_CHAINS 0"</t>
7668                                <t>S: "4"</t>
7669                            </list>
7670                        </t>
7671                    </section>
7672    
7673                    <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
7675                        effect chains of an audio output device by sending the
7676                        following command:</t>
7677                        <t>
7678                            <list>
7679                                <t>LIST SEND_EFFECT_CHAINS &lt;audio-device&gt;</t>
7680                            </list>
7681                        </t>
7682                        <t>Where &lt;audio-device&gt; should be replaced by the
7683                        numerical ID of the audio output device as given by the
7684                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7685                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7686                        command.</t>
7687    
7688                        <t>Possible Answers:</t>
7689                        <t>
7690                            <list>
7691                                <t>The sampler will answer by returning a comma
7692                                separated list with numerical IDs of send effect
7693                                chains of the supplied audio output device.
7694                                </t>
7695                            </list>
7696                        </t>
7697    
7698                        <t>Examples:</t>
7699                        <t>
7700                            <list>
7701                                <t>C: "LIST SEND_EFFECT_CHAINS 0"</t>
7702                                <t>S: "3,4,7"</t>
7703                            </list>
7704                        </t>
7705                    </section>
7706    
7707                    <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
7709                        following command:</t>
7710                        <t>
7711                            <list>
7712                                <t>ADD SEND_EFFECT_CHAIN &lt;audio-device&gt;</t>
7713                            </list>
7714                        </t>
7715                        <t>Where &lt;audio-device&gt; should be replaced by the
7716                        numerical ID of the audio output device as given by the
7717                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7718                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7719                        command.</t>
7720    
7721                        <t>Possible Answers:</t>
7722                        <t>
7723                            <list>
7724                                <t>"OK[&lt;effect-chain&gt;]" -
7725                                    <list>
7726                                        <t>in case the send effect chain was
7727                                        added successfully, where
7728                                        &lt;effect-chain&gt; is the numerical ID
7729                                        of the new send effect chain</t>
7730                                    </list>
7731                                </t>
7732                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7733                                    <list>
7734                                        <t>if the send effect chain could not be added</t>
7735                                    </list>
7736                                </t>
7737                            </list>
7738                        </t>
7739    
7740                        <t>Examples:</t>
7741                        <t>
7742                            <list>
7743                                <t>C: "ADD SEND_EFFECT_CHAIN 0"</t>
7744                                <t>S: "OK[2]"</t>
7745                            </list>
7746                        </t>
7747                    </section>
7748    
7749                    <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
7751                        the following command:</t>
7752                        <t>
7753                            <list>
7754                                <t>REMOVE SEND_EFFECT_CHAIN &lt;audio-device&gt; &lt;effect-chain&gt;</t>
7755                            </list>
7756                        </t>
7757                        <t>Where &lt;audio-device&gt; should be replaced by the
7758                        numerical ID of the audio output device as given by the
7759                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7760                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7761                        command and &lt;effect-chain&gt; by the numerical ID as
7762                        returned by the
7763                        <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
7764                        or
7765                        <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
7766                        command.</t>
7767    
7768                        <t>Possible Answers:</t>
7769                        <t>
7770                            <list>
7771                                <t>"OK" -
7772                                    <list>
7773                                        <t>in case the send effect chain was
7774                                        removed successfully</t>
7775                                    </list>
7776                                </t>
7777                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7778                                    <list>
7779                                        <t>if the send effect chain could not be removed</t>
7780                                    </list>
7781                                </t>
7782                            </list>
7783                        </t>
7784    
7785                        <t>Examples:</t>
7786                        <t>
7787                            <list>
7788                                <t>C: "REMOVE SEND_EFFECT_CHAIN 0 2"</t>
7789                                <t>S: "OK"</t>
7790                            </list>
7791                        </t>
7792                    </section>
7793    
7794                    <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 information of a send effect
7796                        chain by sending the following command:</t>
7797                        <t>
7798                            <list>
7799                                <t>GET SEND_EFFECT_CHAIN INFO &lt;audio-device&gt; &lt;effect-chain&gt;</t>
7800                            </list>
7801                        </t>
7802                        <t>Where &lt;audio-device&gt; should be replaced by the
7803                        numerical ID of the audio output device as given by the
7804                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7805                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7806                        command and &lt;effect-chain&gt; by the numerical ID as
7807                        returned by the
7808                        <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
7809                        or
7810                        <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
7811                        command.</t>
7812    
7813                        <t>Possible Answers:</t>
7814                        <t>
7815                            <list>
7816                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
7817                                Each answer line begins with the information
7818                                category name, followed by a colon and then a space
7819                                character &lt;SP&gt; and finally the info character
7820                                string to that information category.
7821                                At the moment the following categories are defined:</t>
7822                                <t>
7823                                    <list>
7824                                        <t>EFFECT_COUNT -
7825                                            <list>
7826                                                <t>amount of effects in this send
7827                                                effect chain</t>
7828                                            </list>
7829                                        </t>
7830                                        <t>EFFECT_SEQUENCE -
7831                                            <list>
7832                                                <t>comma separated list of the
7833                                                numerical IDs of the effect
7834                                                instances in this send effect chain,
7835                                                in the order as they are procssed in
7836                                                the effect chain</t>
7837                                            </list>
7838                                        </t>
7839                                    </list>
7840                                </t>
7841                            </list>
7842                        </t>
7843                        <t>The mentioned fields above don't have to be in particular order.</t>
7844    
7845                        <t>Example:</t>
7846                        <t>
7847                            <list>
7848                                <t>C: "GET SEND_EFFECT_CHAIN INFO 0 2"</t>
7849                                <t>S: "EFFECT_COUNT: 3"</t>
7850                                <t>&nbsp;&nbsp;&nbsp;"EFFECT_SEQUENCE: 31,4,7"</t>
7851                                <t>&nbsp;&nbsp;&nbsp;"."</t>
7852                            </list>
7853                        </t>
7854                    </section>
7855    
7856                    <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
7858                        end of a send effect chain by sending the following command:</t>
7859                        <t>
7860                            <list>
7861                                <t>APPEND SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;effect-instance&gt;</t>
7862                            </list>
7863                        </t>
7864                        <t>Where &lt;audio-device&gt; should be replaced by the
7865                        numerical ID of the audio output device as given by the
7866                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7867                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7868                        command and &lt;effect-chain&gt; by the numerical ID as
7869                        returned by the
7870                        <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
7871                        or
7872                        <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
7873                        command and &lt;effect-instance&gt; as returned by the
7874                        <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or
7875                        <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
7876                        command.</t>
7877                        <t>Only unused effect instances can be added to the effect
7878                        chain. Trying to add an effect instance which is already in
7879                        use somewhere in the audio signal path of the sampler will
7880                        result in an error.</t>
7881    
7882                        <t>Possible Answers:</t>
7883                        <t>
7884                            <list>
7885                                <t>"OK" -
7886                                    <list>
7887                                        <t>in case the effect instance was
7888                                        added successfully to the chain</t>
7889                                    </list>
7890                                </t>
7891                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7892                                    <list>
7893                                        <t>if the effect instance could not be added</t>
7894                                    </list>
7895                                </t>
7896                            </list>
7897                        </t>
7898    
7899                        <t>Examples:</t>
7900                        <t>
7901                            <list>
7902                                <t>C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38"</t>
7903                                <t>S: "OK"</t>
7904                            </list>
7905                        </t>
7906                    </section>
7907    
7908                    <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
7910                        certain position of a send effect chain by sending the
7911                        following command:</t>
7912                        <t>
7913                            <list>
7914                                <t>INSERT SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;chain-pos&gt; &lt;effect-instance&gt;</t>
7915                            </list>
7916                        </t>
7917                        <t>Where &lt;audio-device&gt; should be replaced by the
7918                        numerical ID of the audio output device as given by the
7919                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7920                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7921                        command, &lt;effect-chain&gt; by the numerical ID as
7922                        returned by the
7923                        <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
7924                        or
7925                        <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
7926                        command, &lt;effect-instance&gt; as returned by the
7927                        <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or
7928                        <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
7929                        command and &lt;chain-pos&gt; the exact position of the
7930                        effect chain where the supplied effect shall be inserted
7931                        to.</t>
7932                        <t>Only unused effect instances can be added to the effect
7933                        chain. Trying to add an effect instance which is already in
7934                        use somewhere in the audio signal path of the sampler will
7935                        result in an error.</t>
7936    
7937                        <t>Possible Answers:</t>
7938                        <t>
7939                            <list>
7940                                <t>"OK" -
7941                                    <list>
7942                                        <t>in case the effect instance was
7943                                        added successfully to the chain</t>
7944                                    </list>
7945                                </t>
7946                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7947                                    <list>
7948                                        <t>if the effect instance could not be added</t>
7949                                    </list>
7950                                </t>
7951                            </list>
7952                        </t>
7953    
7954                        <t>Examples:</t>
7955                        <t>
7956                            <list>
7957                                <t>C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38"</t>
7958                                <t>S: "OK"</t>
7959                            </list>
7960                        </t>
7961                    </section>
7962    
7963                    <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
7965                        certain position of a send effect chain by sending the
7966                        following command:</t>
7967                        <t>
7968                            <list>
7969                                <t>REMOVE SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;chain-pos&gt;</t>
7970                            </list>
7971                        </t>
7972                        <t>Where &lt;audio-device&gt; should be replaced by the
7973                        numerical ID of the audio output device as given by the
7974                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7975                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7976                        command, &lt;effect-chain&gt; by the numerical ID as
7977                        returned by the
7978                        <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
7979                        or
7980                        <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
7981                        command and &lt;chain-pos&gt; the exact position of the
7982                        effect instance to be removed from the effect chain.</t>
7983    
7984                        <t>Possible Answers:</t>
7985                        <t>
7986                            <list>
7987                                <t>"OK" -
7988                                    <list>
7989                                        <t>in case the effect instance was
7990                                        removed successfully</t>
7991                                    </list>
7992                                </t>
7993                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7994                                    <list>
7995                                        <t>if the effect instance could not be removed</t>
7996                                    </list>
7997                                </t>
7998                            </list>
7999                        </t>
8000    
8001                        <t>Examples:</t>
8002                        <t>
8003                            <list>
8004                                <t>C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4"</t>
8005                                <t>S: "OK"</t>
8006                            </list>
8007                        </t>
8008                    </section>
8009    
8010                </section>
8011          </section>          </section>
8012    
8013          <section title="Command Syntax" anchor="command_syntax">          <section title="Command Syntax" anchor="command_syntax">
# Line 6570  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 6658  Schoenebeck'> Line 8118  Schoenebeck'>
8118          <list>          <list>
8119                  <t>CHANNEL                  <t>CHANNEL
8120                  </t>                  </t>
8121                    <t>/ CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index
8122                    </t>
8123                    <t>/ CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index
8124                    </t>
8125                  <t>/ DB_INSTRUMENT_DIRECTORY SP db_path                  <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
8126                  </t>                  </t>
8127                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
# Line 6738  Schoenebeck'> Line 8202  Schoenebeck'>
8202                  </t>                  </t>
8203                  <t>/ GLOBAL_INFO                  <t>/ GLOBAL_INFO
8204                  </t>                  </t>
8205                    <t>/ EFFECT_INSTANCE_COUNT
8206                    </t>
8207                    <t>/ EFFECT_INSTANCE_INFO
8208                    </t>
8209                    <t>/ SEND_EFFECT_CHAIN_COUNT
8210                    </t>
8211                    <t>/ SEND_EFFECT_CHAIN_INFO
8212                    </t>
8213          </list>          </list>
8214  </t>  </t>
8215  <t>unsubscribe_event =  <t>unsubscribe_event =
# Line 6794  Schoenebeck'> Line 8266  Schoenebeck'>
8266                  </t>                  </t>
8267                  <t>/ GLOBAL_INFO                  <t>/ GLOBAL_INFO
8268                  </t>                  </t>
8269                    <t>/ EFFECT_INSTANCE_COUNT
8270                    </t>
8271                    <t>/ EFFECT_INSTANCE_INFO
8272                    </t>
8273                    <t>/ SEND_EFFECT_CHAIN_COUNT
8274                    </t>
8275                    <t>/ SEND_EFFECT_CHAIN_INFO
8276                    </t>
8277          </list>          </list>
8278  </t>  </t>
8279  <t>map_instruction =  <t>map_instruction =
# Line 6818  Schoenebeck'> Line 8298  Schoenebeck'>
8298          <list>          <list>
8299                  <t>CHANNEL SP sampler_channel                  <t>CHANNEL SP sampler_channel
8300                  </t>                  </t>
8301                    <t>/ CHANNEL SP MIDI_INPUT SP sampler_channel
8302                    </t>
8303                    <t>/ CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index
8304                    </t>
8305                    <t>/ CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index
8306                    </t>
8307                  <t>/ MIDI_INSTRUMENT_MAP SP midi_map                  <t>/ MIDI_INSTRUMENT_MAP SP midi_map
8308                  </t>                  </t>
8309                  <t>/ MIDI_INSTRUMENT_MAP SP ALL                  <t>/ MIDI_INSTRUMENT_MAP SP ALL
# Line 6826  Schoenebeck'> Line 8312  Schoenebeck'>
8312                  </t>                  </t>
8313                  <t>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos                  <t>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos
8314                  </t>                  </t>
8315                  <t>/ FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id                  <t>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id
8316                  </t>                  </t>
8317                  <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path                  <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
8318                  </t>                  </t>
# Line 6972  Schoenebeck'> Line 8458  Schoenebeck'>
8458                  </t>                  </t>
8459                  <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value                  <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
8460                  </t>                  </t>
8461                  <t>/ FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos                  <t>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos
8462                  </t>                  </t>
8463                  <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped                  <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
8464                  </t>                  </t>
# Line 6986  Schoenebeck'> Line 8472  Schoenebeck'>
8472                  </t>                  </t>
8473                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
8474                  </t>                  </t>
8475                    <t>/ SHELL SP INTERACT SP boolean
8476                    </t>
8477                    <t>/ SHELL SP AUTO_CORRECT SP boolean
8478                    </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 7166  Schoenebeck'> Line 8658  Schoenebeck'>
8658                  </t>                  </t>
8659                  <t>/ CHANNELS                  <t>/ CHANNELS
8660                  </t>                  </t>
8661                    <t>/ CHANNEL SP MIDI_INPUTS SP sampler_channel
8662                    </t>
8663                  <t>/ AVAILABLE_ENGINES                  <t>/ AVAILABLE_ENGINES
8664                  </t>                  </t>
8665                  <t>/ AVAILABLE_EFFECTS                  <t>/ AVAILABLE_EFFECTS
# Line 7520  Schoenebeck'> Line 9014  Schoenebeck'>
9014                      <t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t>                      <t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t>
9015                      <t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t>                      <t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t>
9016                      <t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t>                      <t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t>
9017                        <t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t>
9018                        <t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t>
9019                        <t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t>
9020                  </list>                  </list>
9021                  Note that the forward slash character ('/') has a special meaning in                  Note that the forward slash character ('/') has a special meaning in
9022                  filename / path based arguments: it acts as separator of the nodes in                  filename / path based arguments: it acts as separator of the nodes in
# Line 7564  Schoenebeck'> Line 9061  Schoenebeck'>
9061                      <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>                      <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
9062                      <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>                      <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
9063                      <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>                      <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
9064                        <t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t>
9065                        <t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t>
9066                        <t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t>
9067                  </list>                  </list>
9068                  Please note that these lists are manually maintained. If you                  Please note that these lists are manually maintained. If you
9069                  find a command that also supports escape sequences we forgot to                  find a command that also supports escape sequences we forgot to
# Line 7575  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 7593  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 7615  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 7633  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 7655  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 7673  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 7698  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 7723  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 7742  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 7761  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 7782  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 7804  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 7823  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 7842  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 7860  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 7878  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 7896  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 7918  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 7937  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 7960  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 7991  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 8013  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 8043  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 8065  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 8095  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 8117  Schoenebeck'> Line 9617  Schoenebeck'>
9617                  message is sufficient here.</t>                  message is sufficient here.</t>
9618              </section>              </section>
9619    
9620              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <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
9622                    is changed by issuing the following command:</t>
9623                    <t>
9624                        <list>
9625                            <t>SUBSCRIBE EFFECT_INSTANCE_COUNT</t>
9626                        </list>
9627                    </t>
9628                    <t>Server will start sending the following notification messages:</t>
9629                    <t>
9630                        <list>
9631                            <t>"EFFECT_INSTANCE_COUNT:&lt;instances&gt;"</t>
9632                        </list>
9633                    </t>
9634                    <t>where &lt;instances&gt; will be replaced by the new number
9635                    of effect instances.</t>
9636                </section>
9637    
9638                <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
9640                    on the back-end by issuing the following command:</t>
9641                    <t>
9642                        <list>
9643                            <t>SUBSCRIBE EFFECT_INSTANCE_INFO</t>
9644                        </list>
9645                    </t>
9646                    <t>Server will start sending the following notification messages:</t>
9647                    <t>
9648                       <list>
9649                            <t>"EFFECT_INSTANCE_INFO:&lt;instance-id&gt;"</t>
9650                        </list>
9651                    </t>
9652                    <t>where &lt;instance-id&gt; will be replaced by the numerical ID
9653                    of the effect instance.</t>
9654                </section>
9655    
9656                <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
9658                    is changed by issuing the following command:</t>
9659                    <t>
9660                        <list>
9661                            <t>SUBSCRIBE SEND_EFFECT_CHAIN_COUNT</t>
9662                        </list>
9663                    </t>
9664                    <t>Server will start sending the following notification messages:</t>
9665                    <t>
9666                        <list>
9667                            <t>"NOTIFY:SEND_EFFECT_CHAIN_COUNT:&lt;device-id&gt; &lt;chains&gt;"</t>
9668                        </list>
9669                    </t>
9670                    <t>where &lt;device-id&gt; will be replaced by the numerical ID of the audio
9671                    output device, in which the number of send effect chains is changed and
9672                    &lt;chains&gt; will be replaced by the new number of send effect chains.</t>
9673                </section>
9674    
9675                <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
9677                    on the back-end by issuing the following command:</t>
9678                    <t>
9679                        <list>
9680                            <t>SUBSCRIBE SEND_EFFECT_CHAIN_INFO</t>
9681                        </list>
9682                    </t>
9683                    <t>Server will start sending the following notification messages:</t>
9684                    <t>
9685                       <list>
9686                            <t>"SEND_EFFECT_CHAIN_INFO:&lt;device-id&gt; &lt;chain-id&gt; &lt;instances&gt;" -
9687                            Notifies that the number of effect instances in a particular send effect chain
9688                            is changed, where &lt;device-id&gt; will be replaced by the numerical ID of the audio
9689                            output device the send effect chain belongs to, &lt;chain-id&gt; will be replaced
9690                            by the numerical ID of the send effect chain in which the number of effect instances
9691                            has changed and &lt;instances&gt; will be replaced by the new number
9692                            of effect instances in the specified send effect chain.</t>
9693                        </list>
9694                    </t>
9695                </section>
9696    
9697                <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.2137  
changed lines
  Added in v.3502
  ViewVC Help
Powered by ViewVC