/[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 1362 by schoenebeck, Sun Sep 30 21:33:26 2007 UTC revision 1389 by schoenebeck, Sun Oct 7 14:05:04 2007 UTC
# Line 34  Schoenebeck'> Line 34  Schoenebeck'>
34                  <email>schoenebeck at software minus engineering dot org</email>                  <email>schoenebeck at software minus engineering dot org</email>
35              </address>              </address>
36          </author>          </author>
37          <date month="September" year="2007"/>          <date month="October" year="2007"/>
38          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
39          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
40          <abstract>          <abstract>
# Line 3255  Schoenebeck'> Line 3255  Schoenebeck'>
3255                      sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;                      sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
3256                      is a number between 0..127 defining the MIDI controller which can alter the                      is a number between 0..127 defining the MIDI controller which can alter the
3257                      effect send level and &lt;name&gt; is an optional argument defining a name                      effect send level and &lt;name&gt; is an optional argument defining a name
3258                      for the effect send entity. The name does not have to be unique.</t>                      for the effect send entity. The name does not have to be unique, but MUST be
3259                        encapsulated into apostrophes and supports escape sequences as described in chapter
3260                        "<xref target="character_set">Character Set and Escape Sequences</xref>".</t>
3261    
3262                      <t>By default, that is as initial routing, the effect send's audio channels                      <t>By default, that is as initial routing, the effect send's audio channels
3263                      are automatically routed to the last audio channels of the sampler channel's                      are automatically routed to the last audio channels of the sampler channel's
# Line 3508  Schoenebeck'> Line 3510  Schoenebeck'>
3510                      as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>                      as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3511                      or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and                      or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3512                      &lt;name&gt; is the new name of the effect send entity, which                      &lt;name&gt; is the new name of the effect send entity, which
3513                      does not have to be unique.</t>                      does not have to be unique (name MUST be encapsulated into apostrophes
3514                        and supports escape sequences as described in chapter
3515                        "<xref target="character_set">Character Set and Escape Sequences</xref>").
3516                        </t>
3517    
3518                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
3519                      <t>                      <t>
# Line 3959  Schoenebeck'> Line 3964  Schoenebeck'>
3964                                  <list>                                  <list>
3965                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
3966                                          <list>                                          <list>
3967                                              <t>arbitrary textual description about the sampler</t>                                              <t>arbitrary textual description about the sampler
3968                                                (note that the character string may contain
3969                                                <xref target="character_set">escape sequences</xref>)</t>
3970                                          </list>                                          </list>
3971                                      </t>                                      </t>
3972                                      <t>VERSION -                                      <t>VERSION -
# Line 4075  Schoenebeck'> Line 4082  Schoenebeck'>
4082                  cause the sampler to switch to the respective instrument as                  cause the sampler to switch to the respective instrument as
4083                  reflected by the current MIDI instrument map.</t>                  reflected by the current MIDI instrument map.</t>
4084    
4085                  <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">
4086                      <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
4087                      the following command:</t>                      the following command:</t>
4088                      <t>                      <t>
# Line 4085  Schoenebeck'> Line 4092  Schoenebeck'>
4092                      </t>                      </t>
4093                      <t>Where &lt;name&gt; is an optional argument allowing to                      <t>Where &lt;name&gt; is an optional argument allowing to
4094                      assign a custom name to the new map. MIDI instrument Map                      assign a custom name to the new map. MIDI instrument Map
4095                      names do not have to be unique.</t>                      names do not have to be unique, but MUST be encapsulated
4096                        into apostrophes and support escape sequences as described
4097                        in chapter "<xref target="character_set">Character Set and Escape Sequences</xref>".
4098                        </t>
4099    
4100                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
4101                      <t>                      <t>
# Line 4292  Schoenebeck'> Line 4302  Schoenebeck'>
4302                      </t>                      </t>
4303                      <t>Where &lt;map&gt; is the numerical ID of the map and                      <t>Where &lt;map&gt; is the numerical ID of the map and
4304                      &lt;name&gt; the new custom name of the map, which does not                      &lt;name&gt; the new custom name of the map, which does not
4305                      have to be unique.</t>                      have to be unique (name MUST be encapsulated into apostrophes
4306                        and supports escape sequences as described in chapter
4307                        "<xref target="character_set">Character Set and Escape Sequences</xref>").
4308                        </t>
4309    
4310                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
4311                      <t>                      <t>
# Line 4423  Schoenebeck'> Line 4436  Schoenebeck'>
4436                      load modes of entries, the frontend should retrieve the actual                      load modes of entries, the frontend should retrieve the actual
4437                      mode by i.e. sending                      mode by i.e. sending
4438                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
4439                      command(s). Finally the OPTIONAL &lt;name&gt; argument allows to                      command(s). Finally the OPTIONAL &lt;name&gt; argument allows to set a custom name
4440                      set a custom name (encapsulated into apostrophes) for the mapping                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
4441                      entry, useful for frontends for displaying an appropriate name for                      "<xref target="character_set">Character Set and Escape Sequences</xref>") for the
4442                        mapping entry, useful for frontends for displaying an appropriate name for
4443                      mapped instruments (using                      mapped instruments (using
4444                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
4445                      </t>                      </t>
# Line 6712  Schoenebeck'> Line 6726  Schoenebeck'>
6726  </t>  </t>
6727  <t>map_name =  <t>map_name =
6728          <list>          <list>
6729                  <t>stringval                  <t>stringval_escaped
6730                  </t>                  </t>
6731          </list>          </list>
6732  </t>  </t>
6733  <t>entry_name =  <t>entry_name =
6734          <list>          <list>
6735                  <t>stringval                  <t>stringval_escaped
6736                  </t>                  </t>
6737          </list>          </list>
6738  </t>  </t>
6739  <t>fx_send_name =  <t>fx_send_name =
6740          <list>          <list>
6741                  <t>stringval                  <t>stringval_escaped
6742                  </t>                  </t>
6743          </list>          </list>
6744  </t>  </t>
# Line 6736  Schoenebeck'> Line 6750  Schoenebeck'>
6750                  </t>                  </t>
6751          </list>          </list>
6752  </t>  </t>
6753    
6754  <t>param_val =  <t>param_val =
6755          <list>          <list>
6756                  <t>string                  <t>string
# Line 6758  Schoenebeck'> Line 6773  Schoenebeck'>
6773  </t>  </t>
6774  <t>query_val =  <t>query_val =
6775          <list>          <list>
6776                  <t>textval_escaped                  <t>text_escaped
6777                  </t>                  </t>
6778                  <t>/ stringval_escaped                  <t>/ stringval_escaped
6779                  </t>                  </t>
# Line 6807  Schoenebeck'> Line 6822  Schoenebeck'>
6822                  where escape characters are now supported, a backslash characters                  where escape characters are now supported, a backslash characters
6823                  MUST be escaped as well (that is as double backslash), whereas                  MUST be escaped as well (that is as double backslash), whereas
6824                  in the old versions a single backslash was sufficient.</t>                  in the old versions a single backslash was sufficient.</t>
6825    
6826                    <t>The following LSCP commands support escape sequences as part
6827                    of their filename / path based arguments:
6828                    <list>
6829                        <t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t>
6830                        <t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t>
6831                        <t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t>
6832                        <t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t>
6833                        <t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
6834                        <t><xref target="REMOVE DB_INSTRUMENT">"REMOVE DB_INSTRUMENT"</xref></t>
6835                        <t><xref target="GET DB_INSTRUMENT_DIRECTORIES">"GET DB_INSTRUMENT_DIRECTORIES"</xref></t>
6836                        <t><xref target="LIST DB_INSTRUMENT_DIRECTORIES">"LIST DB_INSTRUMENT_DIRECTORIES"</xref></t>
6837                        <t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t>
6838                        <t><xref target="GET DB_INSTRUMENTS">"GET DB_INSTRUMENTS"</xref></t>
6839                        <t><xref target="LIST DB_INSTRUMENTS">"LIST DB_INSTRUMENTS"</xref></t>
6840                        <t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t>
6841                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t>
6842                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t>
6843                        <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
6844                        <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
6845                        <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
6846                        <t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t>
6847                        <t><xref target="MOVE DB_INSTRUMENT">"MOVE DB_INSTRUMENT"</xref></t>
6848                        <t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
6849                        <t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t>
6850                        <t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t>
6851                    </list>
6852                    Note that the forward slash character ('/') has a special meaning in
6853                    filename / path based arguments: it acts as separator of the nodes in
6854                    the path, thus if a directory- or filename includes a forward slash
6855                    (not intended as path node separator), you MUST escape that slash
6856                    either with the respective hex escape sequence ("\x2f") or with the
6857                    respective octal escape sequence ("\057").
6858                    </t>
6859    
6860                    <t>
6861                    The following LSCP commands even support escape sequences as
6862                    part of at least one of their text-based arguments (i.e. entity name,
6863                    description):
6864                    <list>
6865                        <t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t>
6866                        <t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t>
6867                        <t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t>
6868                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t>
6869                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t>
6870                        <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
6871                        <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
6872                        <t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t>
6873                    </list>
6874                    Please note that these lists are manually maintained. If you
6875                    find a command that also supports escape sequences we forgot to
6876                    mention here, please report it!
6877                    </t>
6878              </section>              </section>
6879          </section>          </section>
6880    
Legend:
Removed from v.1362  
changed lines
  Added in v.1389
  ViewVC Help
Powered by ViewVC