/[svn]/web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.html
ViewVC logotype

Diff of /web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1189 by iliev, Wed May 16 14:42:04 2007 UTC revision 1390 by schoenebeck, Sun Oct 7 14:07:48 2007 UTC
# Line 1  Line 1 
1  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2  <html lang="en"><head><title>LinuxSampler Control Protocol</title>  <html lang="en"><head><title>LinuxSampler Control Protocol (draft)</title>
3  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
4  <meta name="description" content="LinuxSampler Control Protocol">  <meta name="description" content="LinuxSampler Control Protocol (draft)">
5  <meta name="keywords" content="LSCP">  <meta name="keywords" content="LSCP">
6  <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">  <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">
7  <style type='text/css'><!--  <style type='text/css'><!--
# Line 145  Line 145 
145  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>
146  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>
147  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>
148  <tr><td class="header">Expires: November 17, 2007</td><td class="header">May 16, 2007</td></tr>  <tr><td class="header">Expires: April 9, 2008</td><td class="header">October 7, 2007</td></tr>
149  </table></td></tr></table>  </table></td></tr></table>
150  <h1><br />LinuxSampler Control Protocol<br />LSCP 1.2</h1>  <h1><br />LinuxSampler Control Protocol (draft)<br />LSCP 1.2cvs</h1>
151    
152  <h3>Status of this Memo</h3>  <h3>Status of this Memo</h3>
153  <p>  <p>
# Line 173  The list of current Internet-Drafts can Line 173  The list of current Internet-Drafts can
173  The list of Internet-Draft Shadow Directories can be accessed at  The list of Internet-Draft Shadow Directories can be accessed at
174  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>
175  <p>  <p>
176  This Internet-Draft will expire on November 17, 2007.</p>  This Internet-Draft will expire on April 9, 2008.</p>
177    
178  <h3>Copyright Notice</h3>  <h3>Copyright Notice</h3>
179  <p>  <p>
# Line 364  Getting global volume attenuation<br /> Line 364  Getting global volume attenuation<br />
364  Setting global volume attenuation<br />  Setting global volume attenuation<br />
365  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#MIDI Instrument Mapping">6.7.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#MIDI Instrument Mapping">6.7.</a>&nbsp;
366  MIDI Instrument Mapping<br />  MIDI Instrument Mapping<br />
367  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD MIDI_INSTRUMENT MAP">6.7.1.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a>&nbsp;
368  Create a new MIDI instrument map<br />  Create a new MIDI instrument map<br />
369  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a>&nbsp;
370  Delete one particular or all MIDI instrument maps<br />  Delete one particular or all MIDI instrument maps<br />
# Line 430  Copying instruments<br /> Line 430  Copying instruments<br />
430  Changing the description of instrument<br />  Changing the description of instrument<br />
431  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FIND DB_INSTRUMENTS">6.8.20.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FIND DB_INSTRUMENTS">6.8.20.</a>&nbsp;
432  Finding instruments<br />  Finding instruments<br />
433    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENTS_JOB INFO">6.8.21.</a>&nbsp;
434    Getting job status information<br />
435    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a>&nbsp;
436    Formatting the instruments database<br />
437    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#editing_instruments">6.9.</a>&nbsp;
438    Editing Instruments<br />
439    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#EDIT INSTRUMENT">6.9.1.</a>&nbsp;
440    Opening an appropriate instrument editor application<br />
441  <a href="#command_syntax">7.</a>&nbsp;  <a href="#command_syntax">7.</a>&nbsp;
442  Command Syntax<br />  Command Syntax<br />
443    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#character_set">7.1.</a>&nbsp;
444    Character Set and Escape Sequences<br />
445  <a href="#events">8.</a>&nbsp;  <a href="#events">8.</a>&nbsp;
446  Events<br />  Events<br />
447  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a>&nbsp;
# Line 476  Database instrument directory informatio Line 486  Database instrument directory informatio
486  Number of database instruments changed<br />  Number of database instruments changed<br />
487  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.21.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.21.</a>&nbsp;
488  Database instrument information changed<br />  Database instrument information changed<br />
489  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.22.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.22.</a>&nbsp;
490    Database job status information changed<br />
491    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.23.</a>&nbsp;
492  Miscellaneous and debugging events<br />  Miscellaneous and debugging events<br />
493  <a href="#anchor14">9.</a>&nbsp;  <a href="#anchor14">9.</a>&nbsp;
494  Security Considerations<br />  Security Considerations<br />
# Line 508  Requirements notation</h3> Line 520  Requirements notation</h3>
520              (front-end) and server (LinuxSampler) respectively. Lines in              (front-end) and server (LinuxSampler) respectively. Lines in
521              examples must be interpreted as every line being CRLF              examples must be interpreted as every line being CRLF
522              terminated (carriage return character followed by line feed              terminated (carriage return character followed by line feed
523              character as defined in the ASCII standard), thus the following              character as defined in the ASCII standard <a class='info' href='#RFC20'>[RFC20]<span> (</span><span class='info'>UCLA, &ldquo;ASCII format for Network Interchange,&rdquo; 1969.</span><span>)</span></a>),
524              example:              thus the following example:
525  </p>  </p>
526  <p>  <p>
527                  </p>                  </p>
# Line 3295  Changing settings of MIDI input ports</h Line 3307  Changing settings of MIDI input ports</h
3307                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
3308                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
3309                      the parameter to change and &lt;value&gt; by the new value for this                      the parameter to change and &lt;value&gt; by the new value for this
3310                      parameter.                      parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes)
3311                        for specifying no value for parameters allowing a list of values.
3312  </p>  </p>
3313  <p>Possible Answers:  <p>Possible Answers:
3314  </p>  </p>
# Line 3336  Changing settings of MIDI input ports</h Line 3349  Changing settings of MIDI input ports</h
3349  <p>  <p>
3350                          </p>                          </p>
3351  <blockquote class="text">  <blockquote class="text">
3352    <p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"
3353    </p>
3354    <p>S: "OK"
3355    </p>
3356    </blockquote><p>
3357                        
3358    </p>
3359  <p>  <p>
3360                            </p>
3361    <blockquote class="text">
3362    <p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"
3363    </p>
3364    <p>S: "OK"
3365  </p>  </p>
3366  </blockquote><p>  </blockquote><p>
3367                                            
# Line 3371  Loading an instrument</h3> Line 3396  Loading an instrument</h3>
3396                      number of the sampler channel the instrument should be assigned to.                      number of the sampler channel the instrument should be assigned to.
3397                      Each sampler channel can only have one instrument.                      Each sampler channel can only have one instrument.
3398  </p>  </p>
3399    <p>Notice: since LSCP 1.2 the &lt;filename&gt; argument supports
3400                        escape characters for special characters (see chapter
3401                        "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"
3402                        for details) and accordingly backslash characters in the filename
3403                        MUST now be escaped as well!
3404    </p>
3405  <p>The difference between regular and NON_MODAL versions of the command  <p>The difference between regular and NON_MODAL versions of the command
3406                      is that the regular command returns OK only after the instrument has been                      is that the regular command returns OK only after the instrument has been
3407                      fully loaded and the channel is ready to be used while NON_MODAL version                      fully loaded and the channel is ready to be used while NON_MODAL version
# Line 5049  Adding an effect send to a sampler chann Line 5080  Adding an effect send to a sampler chann
5080                      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;
5081                      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
5082                      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
5083                      for the effect send entity. The name does not have to be unique.                      for the effect send entity. The name does not have to be unique, but MUST be
5084                        encapsulated into apostrophes and supports escape sequences as described in chapter
5085                        "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>".
5086  </p>  </p>
5087  <p>By default, that is as initial routing, the effect send's audio channels  <p>By default, that is as initial routing, the effect send's audio channels
5088                      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 5408  Changing effect send's name</h3> Line 5441  Changing effect send's name</h3>
5441                      as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>                      as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
5442                      or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and                      or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and
5443                      &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
5444                      does not have to be unique.                      does not have to be unique (name MUST be encapsulated into apostrophes
5445                        and supports escape sequences as described in chapter
5446                        "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
5447                        
5448  </p>  </p>
5449  <p>Possible Answers:  <p>Possible Answers:
5450  </p>  </p>
# Line 6085  General sampler informations</h3> Line 6121  General sampler informations</h3>
6121                                          </p>                                          </p>
6122  <blockquote class="text">  <blockquote class="text">
6123  <p>arbitrary textual description about the sampler  <p>arbitrary textual description about the sampler
6124                                                (note that the character string may contain
6125                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
6126  </p>  </p>
6127  </blockquote>  </blockquote>
6128                                                                            
# Line 6246  MIDI Instrument Mapping</h3> Line 6284  MIDI Instrument Mapping</h3>
6284                  cause the sampler to switch to the respective instrument as                  cause the sampler to switch to the respective instrument as
6285                  reflected by the current MIDI instrument map.                  reflected by the current MIDI instrument map.
6286  </p>  </p>
6287  <a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr />  <a name="ADD MIDI_INSTRUMENT_MAP"></a><br /><hr />
6288  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6289  <a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;  <a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;
6290  Create a new MIDI instrument map</h3>  Create a new MIDI instrument map</h3>
# Line 6264  Create a new MIDI instrument map</h3> Line 6302  Create a new MIDI instrument map</h3>
6302  </p>  </p>
6303  <p>Where &lt;name&gt; is an optional argument allowing to  <p>Where &lt;name&gt; is an optional argument allowing to
6304                      assign a custom name to the new map. MIDI instrument Map                      assign a custom name to the new map. MIDI instrument Map
6305                      names do not have to be unique.                      names do not have to be unique, but MUST be encapsulated
6306                        into apostrophes and support escape sequences as described
6307                        in chapter "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>".
6308                        
6309  </p>  </p>
6310  <p>Possible Answers:  <p>Possible Answers:
6311  </p>  </p>
# Line 6577  Renaming a MIDI instrument map</h3> Line 6618  Renaming a MIDI instrument map</h3>
6618  </p>  </p>
6619  <p>Where &lt;map&gt; is the numerical ID of the map and  <p>Where &lt;map&gt; is the numerical ID of the map and
6620                      &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
6621                      have to be unique.                      have to be unique (name MUST be encapsulated into apostrophes
6622                        and supports escape sequences as described in chapter
6623                        "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
6624                        
6625  </p>  </p>
6626  <p>Possible Answers:  <p>Possible Answers:
6627  </p>  </p>
# Line 6643  Create or replace a MIDI instrument map Line 6687  Create or replace a MIDI instrument map
6687                      index, &lt;engine_name&gt; a sampler engine name as returned by                      index, &lt;engine_name&gt; a sampler engine name as returned by
6688                      the <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a>                      the <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a>
6689                      command (not encapsulated into apostrophes), &lt;filename&gt; the name                      command (not encapsulated into apostrophes), &lt;filename&gt; the name
6690                      of the instrument's file to be deployed (encapsulated into apostrophes),                      of the instrument's file to be deployed (encapsulated into apostrophes,
6691                        supporting escape sequences as described in chapter
6692                        "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"),
6693                      &lt;instrument_index&gt; the index (integer value) of the instrument                      &lt;instrument_index&gt; the index (integer value) of the instrument
6694                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
6695                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
# Line 6740  Create or replace a MIDI instrument map Line 6786  Create or replace a MIDI instrument map
6786                      load modes of entries, the frontend should retrieve the actual                      load modes of entries, the frontend should retrieve the actual
6787                      mode by i.e. sending                      mode by i.e. sending
6788                      <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>                      <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>
6789                      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
6790                      set a custom name (encapsulated into apostrophes) for the mapping                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
6791                      entry, useful for frontends for displaying an appropriate name for                      "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") for the
6792                        mapping entry, useful for frontends for displaying an appropriate name for
6793                      mapped instruments (using                      mapped instruments (using
6794                      <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>).                      <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>).
6795                                            
# Line 7233  Managing Instruments Database</h3> Line 7280  Managing Instruments Database</h3>
7280  <p>The following commands describe how to use and manage  <p>The following commands describe how to use and manage
7281                  the instruments database.                  the instruments database.
7282  </p>  </p>
7283    <p>Notice:
7284    </p>
7285    <p>
7286                            </p>
7287    <blockquote class="text">
7288    <p>All command arguments representing a path or
7289                                instrument/directory name support escape sequences as described in chapter
7290                                "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>".
7291                                
7292    </p>
7293    <p>All occurrences of a forward slash in instrument and directory
7294                                   names are escaped with its hex (\x2f) or octal (\057) escape sequence.
7295                                
7296    </p>
7297    </blockquote><p>
7298                        
7299    </p>
7300  <a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr />  <a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7301  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7302  <a name="rfc.section.6.8.1"></a><h3>6.8.1.&nbsp;  <a name="rfc.section.6.8.1"></a><h3>6.8.1.&nbsp;
# Line 7498  Getting instrument directory information Line 7562  Getting instrument directory information
7562  <p>DESCRIPTION -  <p>DESCRIPTION -
7563                                          </p>                                          </p>
7564  <blockquote class="text">  <blockquote class="text">
7565  <p>A brief description of the directory content  <p>A brief description of the directory content.
7566                                                Note that the character string may contain
7567                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
7568  </p>  </p>
7569  </blockquote>  </blockquote>
7570                                                                            
# Line 7743  Changing the description of directory</h Line 7809  Changing the description of directory</h
7809                                            
7810  </p>  </p>
7811  <p>Where &lt;dir&gt; is the absolute path name of the directory and  <p>Where &lt;dir&gt; is the absolute path name of the directory and
7812                      &lt;desc&gt; is the new description for the directory.                      &lt;desc&gt; is the new description for the directory
7813                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
7814                        "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
7815  </p>  </p>
7816  <p>Possible Answers:  <p>Possible Answers:
7817  </p>  </p>
# Line 7810  Finding directories</h3> Line 7878  Finding directories</h3>
7878                            </p>                            </p>
7879  <blockquote class="text">  <blockquote class="text">
7880  <p>Restricts the search to directories, which names  <p>Restricts the search to directories, which names
7881                                satisfy the supplied search string.                                satisfy the supplied search string (encapsulated into apostrophes,
7882                                  supporting escape sequences as described in chapter
7883                                  "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
7884  </p>  </p>
7885  </blockquote><p>  </blockquote><p>
7886                                                
# Line 7853  Finding directories</h3> Line 7923  Finding directories</h3>
7923                            </p>                            </p>
7924  <blockquote class="text">  <blockquote class="text">
7925  <p>Restricts the search to directories with description  <p>Restricts the search to directories with description
7926                                that satisfies the supplied search string.                                that satisfies the supplied search string
7927                                  (encapsulated into apostrophes, supporting escape
7928                                  sequences as described in chapter
7929                                  "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
7930  </p>  </p>
7931  </blockquote><p>  </blockquote><p>
7932                                                
# Line 7916  Adding instruments to the instruments da Line 7989  Adding instruments to the instruments da
7989  <p>  <p>
7990                          </p>                          </p>
7991  <blockquote class="text">  <blockquote class="text">
7992  <p>ADD DB_INSTRUMENTS [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]  <p>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]
7993  </p>  </p>
7994  </blockquote><p>  </blockquote><p>
7995                                            
# Line 7938  Adding instruments to the instruments da Line 8011  Adding instruments to the instruments da
8011  <p>  <p>
8012                          </p>                          </p>
8013  <blockquote class="text">  <blockquote class="text">
8014    <p>"RECURSIVE" -
8015                                    </p>
8016    <blockquote class="text">
8017    <p>All instruments will be processed, including those
8018                                        in the subdirectories, and the respective subdirectory
8019                                        tree structure will be recreated in the instruments
8020                                        database
8021    </p>
8022    </blockquote>
8023                                
8024    
8025  <p>"NON_RECURSIVE" -  <p>"NON_RECURSIVE" -
8026                                  </p>                                  </p>
8027  <blockquote class="text">  <blockquote class="text">
# Line 7960  Adding instruments to the instruments da Line 8044  Adding instruments to the instruments da
8044  </blockquote>  </blockquote>
8045                                                            
8046    
 <p>not supplied -  
                                 </p>  
 <blockquote class="text">  
 <p>The subdirectory tree structure will be recreated  
                                     in the instruments database and all instruments will be  
                                     processed and added to the respective subdirectory  
                                     in the instruments database.  
 </p>  
 </blockquote>  
                               
   
8047  </blockquote><p>  </blockquote><p>
8048                                            
8049  </p>  </p>
8050    <p>The difference between regular and NON_MODAL versions of the command
8051                        is that the regular command returns when the scanning is finished
8052                        while NON_MODAL version returns immediately and a background process is launched.
8053                        The <a class='info' href='#GET DB_INSTRUMENTS_JOB INFO'>GET DB_INSTRUMENTS_JOB INFO<span> (</span><span class='info'>Getting job status information</span><span>)</span></a>
8054                        command can be used to monitor the scanning progress.
8055    </p>
8056  <p>Possible Answers:  <p>Possible Answers:
8057  </p>  </p>
8058  <p>  <p>
# Line 7982  Adding instruments to the instruments da Line 8061  Adding instruments to the instruments da
8061  <p>"OK" -  <p>"OK" -
8062                                  </p>                                  </p>
8063  <blockquote class="text">  <blockquote class="text">
8064  <p>on success  <p>on success when NON_MODAL is not supplied
8065    </p>
8066    </blockquote>
8067                                
8068    
8069    <p>"OK[&lt;job-id&gt;]" -
8070                                    </p>
8071    <blockquote class="text">
8072    <p>on success when NON_MODAL is supplied, where &lt;job-id&gt;
8073                                        is a numerical ID used to obtain status information about the job progress.
8074                                        See <a class='info' href='#GET DB_INSTRUMENTS_JOB INFO'>GET DB_INSTRUMENTS_JOB INFO<span> (</span><span class='info'>Getting job status information</span><span>)</span></a>
8075                                        
8076  </p>  </p>
8077  </blockquote>  </blockquote>
8078                                                            
# Line 8217  Getting instrument information</h3> Line 8307  Getting instrument information</h3>
8307                                          </p>                                          </p>
8308  <blockquote class="text">  <blockquote class="text">
8309  <p>File name of the instrument.  <p>File name of the instrument.
8310                                                Note that the character string may contain
8311                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8312  </p>  </p>
8313  </blockquote>  </blockquote>
8314                                                                            
# Line 8276  Getting instrument information</h3> Line 8368  Getting instrument information</h3>
8368  <p>DESCRIPTION -  <p>DESCRIPTION -
8369                                          </p>                                          </p>
8370  <blockquote class="text">  <blockquote class="text">
8371  <p>A brief description of the instrument  <p>A brief description of the instrument.
8372                                                Note that the character string may contain
8373                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8374  </p>  </p>
8375  </blockquote>  </blockquote>
8376                                                                            
# Line 8293  Getting instrument information</h3> Line 8387  Getting instrument information</h3>
8387  <p>PRODUCT -  <p>PRODUCT -
8388                                          </p>                                          </p>
8389  <blockquote class="text">  <blockquote class="text">
8390  <p>The product title of the instrument  <p>The product title of the instrument.
8391                                                Note that the character string may contain
8392                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8393  </p>  </p>
8394  </blockquote>  </blockquote>
8395                                                                            
# Line 8301  Getting instrument information</h3> Line 8397  Getting instrument information</h3>
8397  <p>ARTISTS -  <p>ARTISTS -
8398                                          </p>                                          </p>
8399  <blockquote class="text">  <blockquote class="text">
8400  <p>Lists the artist names  <p>Lists the artist names.
8401                                                Note that the character string may contain
8402                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8403  </p>  </p>
8404  </blockquote>  </blockquote>
8405                                                                            
# Line 8311  Getting instrument information</h3> Line 8409  Getting instrument information</h3>
8409  <blockquote class="text">  <blockquote class="text">
8410  <p>Provides a list of keywords that refer to the instrument.  <p>Provides a list of keywords that refer to the instrument.
8411                                              Keywords are separated with semicolon and blank.                                              Keywords are separated with semicolon and blank.
8412                                                Note that the character string may contain
8413                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8414  </p>  </p>
8415  </blockquote>  </blockquote>
8416                                                                            
# Line 8551  Changing the description of instrument</ Line 8651  Changing the description of instrument</
8651                                            
8652  </p>  </p>
8653  <p>Where &lt;instr&gt; is the absolute path name of the instrument and  <p>Where &lt;instr&gt; is the absolute path name of the instrument and
8654                      &lt;desc&gt; is the new description for the instrument.                      &lt;desc&gt; is the new description for the instrument
8655                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
8656                        "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
8657  </p>  </p>
8658  <p>Possible Answers:  <p>Possible Answers:
8659  </p>  </p>
# Line 8618  Finding instruments</h3> Line 8720  Finding instruments</h3>
8720                            </p>                            </p>
8721  <blockquote class="text">  <blockquote class="text">
8722  <p>Restricts the search to instruments, which names  <p>Restricts the search to instruments, which names
8723                                satisfy the supplied search string.                                satisfy the supplied search string (encapsulated into apostrophes,
8724                                  supporting escape sequences as described in chapter
8725                                  "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
8726  </p>  </p>
8727  </blockquote><p>  </blockquote><p>
8728                                                
# Line 8628  Finding instruments</h3> Line 8732  Finding instruments</h3>
8732  <p>SIZE=[&lt;min&gt;]..[&lt;max&gt;]  <p>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
8733                            </p>                            </p>
8734  <blockquote class="text">  <blockquote class="text">
8735  <p>Restricts the search to instruments, which  <p>Restricts the search to instruments, which
8736                                size is in the specified range. If &lt;min&gt; is omitted,                                size is in the specified range. If &lt;min&gt; is omitted,
8737                                the search results are restricted to instruments with size less then                                the search results are restricted to instruments with size less then
8738                                or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the                                or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
# Line 8676  Finding instruments</h3> Line 8780  Finding instruments</h3>
8780                            </p>                            </p>
8781  <blockquote class="text">  <blockquote class="text">
8782  <p>Restricts the search to instruments with description  <p>Restricts the search to instruments with description
8783                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
8784                                  supporting escape sequences as described in chapter
8785                                  "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
8786  </p>  </p>
8787  </blockquote><p>  </blockquote><p>
8788                                                
# Line 8687  Finding instruments</h3> Line 8793  Finding instruments</h3>
8793                            </p>                            </p>
8794  <blockquote class="text">  <blockquote class="text">
8795  <p>Restricts the search to instruments with product info  <p>Restricts the search to instruments with product info
8796                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
8797                                  supporting escape sequences as described in chapter
8798                                  "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
8799  </p>  </p>
8800  </blockquote><p>  </blockquote><p>
8801                                                
# Line 8698  Finding instruments</h3> Line 8806  Finding instruments</h3>
8806                            </p>                            </p>
8807  <blockquote class="text">  <blockquote class="text">
8808  <p>Restricts the search to instruments with artists info  <p>Restricts the search to instruments with artists info
8809                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
8810                                  supporting escape sequences as described in chapter
8811                                  "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
8812  </p>  </p>
8813  </blockquote><p>  </blockquote><p>
8814                                                
# Line 8709  Finding instruments</h3> Line 8819  Finding instruments</h3>
8819                            </p>                            </p>
8820  <blockquote class="text">  <blockquote class="text">
8821  <p>Restricts the search to instruments with keyword list  <p>Restricts the search to instruments with keyword list
8822                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
8823                                  supporting escape sequences as described in chapter
8824                                  "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
8825  </p>  </p>
8826  </blockquote><p>  </blockquote><p>
8827                                                
# Line 8719  Finding instruments</h3> Line 8831  Finding instruments</h3>
8831  <p>IS_DRUM=true | false  <p>IS_DRUM=true | false
8832                            </p>                            </p>
8833  <blockquote class="text">  <blockquote class="text">
8834  <p>Either true or false. Restricts the search to  <p>Either true or false. Restricts the search to
8835                                drum kits or chromatic instruments.                                drum kits or chromatic instruments.
8836  </p>  </p>
8837  </blockquote><p>  </blockquote><p>
# Line 8783  Finding instruments</h3> Line 8895  Finding instruments</h3>
8895  </blockquote><p>  </blockquote><p>
8896                                            
8897  </p>  </p>
8898    <a name="GET DB_INSTRUMENTS_JOB INFO"></a><br /><hr />
8899    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8900    <a name="rfc.section.6.8.21"></a><h3>6.8.21.&nbsp;
8901    Getting job status information</h3>
8902    
8903    <p>The front-end can ask for the current status of a
8904                        particular database instruments job by sending the following command:
8905    </p>
8906    <p>
8907                            </p>
8908    <blockquote class="text">
8909    <p>GET DB_INSTRUMENTS_JOB INFO &lt;job-id&gt;
8910    </p>
8911    </blockquote><p>
8912                        
8913    </p>
8914    <p>Where &lt;job-id&gt; should be replaced by the numerical ID
8915                        of the job the front-end is interested in.
8916    </p>
8917    <p>Possible Answers:
8918    </p>
8919    <p>
8920                            </p>
8921    <blockquote class="text">
8922    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
8923                                Each answer line begins with the settings category name
8924                                followed by a colon and then a space character &lt;SP&gt; and finally
8925                                the info character string to that setting category. At the
8926                                moment the following categories are defined:
8927    </p>
8928    <p>
8929                                    </p>
8930    <blockquote class="text">
8931    <p>FILES_TOTAL -
8932                                            </p>
8933    <blockquote class="text">
8934    <p>The total number of files scheduled for scanning
8935    </p>
8936    </blockquote>
8937                                        
8938    
8939    <p>FILES_SCANNED -
8940                                            </p>
8941    <blockquote class="text">
8942    <p>The current number of scanned files
8943    </p>
8944    </blockquote>
8945                                        
8946    
8947    <p>SCANNING -
8948                                            </p>
8949    <blockquote class="text">
8950    <p>The absolute path name of the file which is currently
8951                                                being scanned
8952    </p>
8953    </blockquote>
8954                                        
8955    
8956    <p>STATUS -
8957                                            </p>
8958    <blockquote class="text">
8959    <p>An integer value between 0 and 100 indicating the
8960                                                scanning progress percentage of the file which is
8961                                                currently being scanned
8962    </p>
8963    </blockquote>
8964                                        
8965    
8966    </blockquote>
8967                                
8968    
8969    </blockquote><p>
8970                        
8971    </p>
8972    <p>The mentioned fields above don't have to be in particular order.
8973    </p>
8974    <p>Example:
8975    </p>
8976    <p>
8977                            </p>
8978    <blockquote class="text">
8979    <p>C: "GET DB_INSTRUMENTS_JOB INFO 2"
8980    </p>
8981    <p>S: "FILES_TOTAL: 12"
8982    </p>
8983    <p>&nbsp;&nbsp;&nbsp;"FILES_SCANNED: 7"
8984    </p>
8985    <p>&nbsp;&nbsp;&nbsp;"SCANNING: /home/me/gigs/Bosendorfer 290.gig"
8986    </p>
8987    <p>&nbsp;&nbsp;&nbsp;"STATUS: 42"
8988    </p>
8989    <p>&nbsp;&nbsp;&nbsp;"."
8990    </p>
8991    </blockquote><p>
8992                        
8993    </p>
8994    <a name="FORMAT INSTRUMENTS_DB"></a><br /><hr />
8995    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8996    <a name="rfc.section.6.8.22"></a><h3>6.8.22.&nbsp;
8997    Formatting the instruments database</h3>
8998    
8999    <p>The front-end can remove all instruments and directories and re-create
9000                        the instruments database structure (e.g., in case of a database corruption)
9001                        by sending the following command:
9002    </p>
9003    <p>
9004                            </p>
9005    <blockquote class="text">
9006    <p>FORMAT INSTRUMENTS_DB
9007    </p>
9008    </blockquote><p>
9009                        
9010    </p>
9011    <p>Possible Answers:
9012    </p>
9013    <p>
9014                            </p>
9015    <blockquote class="text">
9016    <p>"OK" -
9017                                    </p>
9018    <blockquote class="text">
9019    <p>on success
9020    </p>
9021    </blockquote>
9022                                
9023    
9024    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9025                                    </p>
9026    <blockquote class="text">
9027    <p>If the formatting of the instruments database
9028                                        failed.
9029    </p>
9030    </blockquote>
9031                                
9032    
9033    </blockquote><p>
9034                        
9035    </p>
9036    <a name="editing_instruments"></a><br /><hr />
9037    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9038    <a name="rfc.section.6.9"></a><h3>6.9.&nbsp;
9039    Editing Instruments</h3>
9040    
9041    <p>The sampler allows to edit instruments while playing with the
9042                    sampler by spawning an external (3rd party) instrument editor
9043                    application for a given instrument. The 3rd party instrument
9044                    editor applications have to place a respective plugin DLL file
9045                    into the sampler's plugins directory. The sampler will
9046                    automatically try to load all plugin DLLs in that directory on
9047                    startup and only on startup!
9048    </p>
9049    <p>At the moment there is only one command for this feature set,
9050                    but this will most probably change in future.
9051    </p>
9052    <a name="EDIT INSTRUMENT"></a><br /><hr />
9053    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9054    <a name="rfc.section.6.9.1"></a><h3>6.9.1.&nbsp;
9055    Opening an appropriate instrument editor application</h3>
9056    
9057    <p>The front-end can request to open an appropriate instrument
9058                        editor application by sending the following command:
9059    </p>
9060    <p>
9061                            </p>
9062    <blockquote class="text">
9063    <p>EDIT INSTRUMENT &lt;sampler-channel&gt;
9064    </p>
9065    </blockquote><p>
9066                        
9067    </p>
9068    <p>Where &lt;sampler-channel&gt; should be replaced by the
9069                        number of the sampler channel as given by the
9070                        <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
9071                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a>
9072                        command.
9073    </p>
9074    <p>The sampler will try to ask all registered instrument
9075                        editors (or to be more specific: their sampler plugins)
9076                        whether they are capable to handle the instrument on the
9077                        given sampler channel. The sampler will simply use the first
9078                        instrument editor application which replied with a positive
9079                        answer and spawn that instrument editor application within
9080                        the sampler's process and provide that application access
9081                        to the instrument's data structures, so both applications
9082                        can share and access the same instruments data at the same
9083                        time, thus allowing to immediately hear changes with the
9084                        sampler made by the instrument editor.
9085    </p>
9086    <p>Note: consequently instrument editors are always spawned
9087                        locally on the same machine where the sampler is running
9088                        on!
9089    </p>
9090    <p>Possible Answers:
9091    </p>
9092    <p>
9093                            </p>
9094    <blockquote class="text">
9095    <p>"OK" -
9096                                    </p>
9097    <blockquote class="text">
9098    <p>when an appropriate instrument editor was
9099                                        launched
9100    </p>
9101    </blockquote>
9102                                
9103    
9104    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
9105                                    </p>
9106    <blockquote class="text">
9107    <p>when an appropriate instrument editor was
9108                                        launched, but there are noteworthy issues
9109    </p>
9110    </blockquote>
9111                                
9112    
9113    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9114                                    </p>
9115    <blockquote class="text">
9116    <p>when an appropriate instrument editor
9117                                        could not be launched
9118    </p>
9119    </blockquote>
9120                                
9121    
9122    </blockquote><p>
9123                        
9124    </p>
9125    <p>Examples:
9126    </p>
9127    <p>
9128                            </p>
9129    <blockquote class="text">
9130    <p>C: "EDIT INSTRUMENT 0"
9131    </p>
9132    <p>S: "OK"
9133    </p>
9134    </blockquote><p>
9135                        
9136    </p>
9137  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
9138  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9139  <a name="rfc.section.7"></a><h3>7.&nbsp;  <a name="rfc.section.7"></a><h3>7.&nbsp;
# Line 8898  Command Syntax</h3> Line 9249  Command Syntax</h3>
9249  <p>/ COPY SP copy_instruction  <p>/ COPY SP copy_instruction
9250                                    
9251  </p>  </p>
9252    <p>/ EDIT SP edit_instruction
9253                    
9254    </p>
9255    <p>/ FORMAT SP format_instruction
9256                    
9257    </p>
9258  <p>/ RESET  <p>/ RESET
9259                                    
9260  </p>  </p>
# Line 8913  Command Syntax</h3> Line 9270  Command Syntax</h3>
9270  <p>CHANNEL  <p>CHANNEL
9271                                    
9272  </p>  </p>
9273  <p>/ DB_INSTRUMENT_DIRECTORY SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP db_path
9274                    
9275    </p>
9276    <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
9277                    
9278    </p>
9279    <p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
9280                                    
9281  </p>  </p>
9282  <p>/ DB_INSTRUMENTS SP FLAT SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
9283                                    
9284  </p>  </p>
9285  <p>/ DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index
9286                                    
9287  </p>  </p>
9288  <p>/ DB_INSTRUMENTS SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP db_path SP filename
9289                                    
9290  </p>  </p>
9291  <p>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index  <p>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index
9292                                    
9293  </p>  </p>
9294  <p>/ MIDI_INSTRUMENT_MAP  <p>/ MIDI_INSTRUMENT_MAP
# Line 8997  Command Syntax</h3> Line 9360  Command Syntax</h3>
9360  <p>/ DB_INSTRUMENT_INFO  <p>/ DB_INSTRUMENT_INFO
9361                                    
9362  </p>  </p>
9363    <p>/ DB_INSTRUMENTS_JOB_INFO
9364                    
9365    </p>
9366  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
9367                                    
9368  </p>  </p>
# Line 9069  Command Syntax</h3> Line 9435  Command Syntax</h3>
9435  <p>/ DB_INSTRUMENT_INFO  <p>/ DB_INSTRUMENT_INFO
9436                                    
9437  </p>  </p>
9438    <p>/ DB_INSTRUMENTS_JOB_INFO
9439                    
9440    </p>
9441  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
9442                                    
9443  </p>  </p>
# Line 9120  Command Syntax</h3> Line 9489  Command Syntax</h3>
9489  <p>/ MIDI_INSTRUMENT_MAP SP ALL  <p>/ MIDI_INSTRUMENT_MAP SP ALL
9490                                    
9491  </p>  </p>
9492  <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
9493                                    
9494  </p>  </p>
9495  <p>/ DB_INSTRUMENT_DIRECTORY SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP db_path
9496                                    
9497  </p>  </p>
9498  <p>/ DB_INSTRUMENT SP pathname  <p>/ DB_INSTRUMENT SP db_path
9499                                    
9500  </p>  </p>
9501  </blockquote><p>  </blockquote><p>
# Line 9234  Command Syntax</h3> Line 9603  Command Syntax</h3>
9603  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
9604                                    
9605  </p>  </p>
9606  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
9607                                    
9608  </p>  </p>
9609  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path
9610                                    
9611  </p>  </p>
9612  <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
9613                                    
9614  </p>  </p>
9615  <p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
9616                                    
9617  </p>  </p>
9618  <p>/ DB_INSTRUMENTS SP pathname  <p>/ DB_INSTRUMENTS SP db_path
9619                                    
9620  </p>  </p>
9621  <p>/ DB_INSTRUMENT SP INFO SP pathname  <p>/ DB_INSTRUMENT SP INFO SP db_path
9622                    
9623    </p>
9624    <p>/ DB_INSTRUMENTS_JOB SP INFO SP number
9625                                    
9626  </p>  </p>
9627  <p>/ VOLUME  <p>/ VOLUME
# Line 9270  Command Syntax</h3> Line 9642  Command Syntax</h3>
9642  <p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list  <p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
9643                                    
9644  </p>  </p>
9645    <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
9646                    
9647    </p>
9648  <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list  <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
9649                                    
9650  </p>  </p>
# Line 9291  Command Syntax</h3> Line 9666  Command Syntax</h3>
9666  <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value  <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
9667                                    
9668  </p>  </p>
9669  <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname  <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
9670                                    
9671  </p>  </p>
9672  <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval  <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
9673                                    
9674  </p>  </p>
9675  <p>/ DB_INSTRUMENT SP NAME SP pathname SP dirname  <p>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
9676                                    
9677  </p>  </p>
9678  <p>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval  <p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
9679                                    
9680  </p>  </p>
9681  <p>/ ECHO SP boolean  <p>/ ECHO SP boolean
# Line 9360  Command Syntax</h3> Line 9735  Command Syntax</h3>
9735  <p>find_instruction =  <p>find_instruction =
9736          </p>          </p>
9737  <blockquote class="text">  <blockquote class="text">
9738  <p>DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list  <p>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
9739                                    
9740  </p>  </p>
9741  <p>/ DB_INSTRUMENTS SP pathname SP query_val_list  <p>/ DB_INSTRUMENTS SP db_path SP query_val_list
9742                                    
9743  </p>  </p>
9744  <p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP query_val_list  <p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list
9745                                    
9746  </p>  </p>
9747  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
9748                                    
9749  </p>  </p>
9750  </blockquote><p>  </blockquote><p>
# Line 9378  Command Syntax</h3> Line 9753  Command Syntax</h3>
9753  <p>move_instruction =  <p>move_instruction =
9754          </p>          </p>
9755  <blockquote class="text">  <blockquote class="text">
9756  <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname  <p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
9757                                    
9758  </p>  </p>
9759  <p>/ DB_INSTRUMENT SP pathname SP pathname  <p>/ DB_INSTRUMENT SP db_path SP db_path
9760                                    
9761  </p>  </p>
9762  </blockquote><p>  </blockquote><p>
# Line 9390  Command Syntax</h3> Line 9765  Command Syntax</h3>
9765  <p>copy_instruction =  <p>copy_instruction =
9766          </p>          </p>
9767  <blockquote class="text">  <blockquote class="text">
9768  <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname  <p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
9769                                    
9770  </p>  </p>
9771  <p>/ DB_INSTRUMENT SP pathname SP pathname  <p>/ DB_INSTRUMENT SP db_path SP db_path
9772                                    
9773  </p>  </p>
9774  </blockquote><p>  </blockquote><p>
# Line 9474  Command Syntax</h3> Line 9849  Command Syntax</h3>
9849  </blockquote><p>  </blockquote><p>
9850    
9851  </p>  </p>
9852    <p>edit_instruction =
9853            </p>
9854    <blockquote class="text">
9855    <p>INSTRUMENT SP sampler_channel
9856                    
9857    </p>
9858    </blockquote><p>
9859    
9860    </p>
9861    <p>format_instruction =
9862            </p>
9863    <blockquote class="text">
9864    <p>INSTRUMENTS_DB
9865                    
9866    </p>
9867    </blockquote><p>
9868    
9869    </p>
9870  <p>modal_arg =  <p>modal_arg =
9871          </p>          </p>
9872  <blockquote class="text">  <blockquote class="text">
# Line 9543  Command Syntax</h3> Line 9936  Command Syntax</h3>
9936  <p>/ FX_SENDS SP sampler_channel  <p>/ FX_SENDS SP sampler_channel
9937                                    
9938  </p>  </p>
9939  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
9940                                    
9941  </p>  </p>
9942  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path
9943                                    
9944  </p>  </p>
9945  <p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
9946                                    
9947  </p>  </p>
9948  <p>/ DB_INSTRUMENTS SP pathname  <p>/ DB_INSTRUMENTS SP db_path
9949                                    
9950  </p>  </p>
9951  </blockquote><p>  </blockquote><p>
# Line 9735  Command Syntax</h3> Line 10128  Command Syntax</h3>
10128  </blockquote><p>  </blockquote><p>
10129    
10130  </p>  </p>
10131  <p>pathname =  <p>filename =
         </p>  
 <blockquote class="text">  
 <p>stringval  
                   
 </p>  
 </blockquote><p>  
   
 </p>  
 <p>dirname =  
10132          </p>          </p>
10133  <blockquote class="text">  <blockquote class="text">
10134  <p>stringval  <p>path
10135                                    
10136  </p>  </p>
10137  </blockquote><p>  </blockquote><p>
10138    
10139  </p>  </p>
10140  <p>filename =  <p>db_path =
10141          </p>          </p>
10142  <blockquote class="text">  <blockquote class="text">
10143  <p>stringval  <p>path
10144                                    
10145  </p>  </p>
10146  </blockquote><p>  </blockquote><p>
# Line 9765  Command Syntax</h3> Line 10149  Command Syntax</h3>
10149  <p>map_name =  <p>map_name =
10150          </p>          </p>
10151  <blockquote class="text">  <blockquote class="text">
10152  <p>stringval  <p>stringval_escaped
10153                                    
10154  </p>  </p>
10155  </blockquote><p>  </blockquote><p>
# Line 9774  Command Syntax</h3> Line 10158  Command Syntax</h3>
10158  <p>entry_name =  <p>entry_name =
10159          </p>          </p>
10160  <blockquote class="text">  <blockquote class="text">
10161  <p>stringval  <p>stringval_escaped
10162                                    
10163  </p>  </p>
10164  </blockquote><p>  </blockquote><p>
# Line 9783  Command Syntax</h3> Line 10167  Command Syntax</h3>
10167  <p>fx_send_name =  <p>fx_send_name =
10168          </p>          </p>
10169  <blockquote class="text">  <blockquote class="text">
10170  <p>stringval  <p>stringval_escaped
10171                                    
10172  </p>  </p>
10173  </blockquote><p>  </blockquote><p>
# Line 9834  Command Syntax</h3> Line 10218  Command Syntax</h3>
10218  <p>query_val =  <p>query_val =
10219          </p>          </p>
10220  <blockquote class="text">  <blockquote class="text">
10221  <p>string  <p>text_escaped
10222                                    
10223  </p>  </p>
10224  <p>/ stringval  <p>/ stringval_escaped
10225                                    
10226  </p>  </p>
10227  </blockquote><p>  </blockquote><p>
10228    
10229  </p>  </p>
10230    <p>scan_mode =
10231            </p>
10232    <blockquote class="text">
10233    <p>RECURSIVE
10234                    
10235    </p>
10236    <p>/ NON_RECURSIVE
10237                    
10238    </p>
10239    <p>/ FLAT
10240                    
10241    </p>
10242    </blockquote><p>
10243    
10244    </p>
10245    <a name="character_set"></a><br /><hr />
10246    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10247    <a name="rfc.section.7.1"></a><h3>7.1.&nbsp;
10248    Character Set and Escape Sequences</h3>
10249    
10250    <p>Older versions of this protocol up to and including v1.1 only
10251                    supported the standard ASCII character set (ASCII code 0 - 127)
10252                    <a class='info' href='#RFC20'>[RFC20]<span> (</span><span class='info'>UCLA, &ldquo;ASCII format for Network Interchange,&rdquo; 1969.</span><span>)</span></a>, all younger versions of this protocol
10253                    however support the Extended ASCII character set (ASCII code
10254                    0 - 255). The same group of younger protocols also support
10255                    escape sequences, but only for certain, explicitly declared
10256                    parts of the protocol. The supported escape sequences are
10257                    defined as follows:
10258    </p><table class="full" align="center" border="0" cellpadding="2" cellspacing="2">
10259    <col align="left"><col align="left">
10260    <tr><th align="left">ASCII Character Sequence</th><th align="left">Translated into (Name)</th></tr>
10261    <tr>
10262    <td align="left">\n</td>
10263    <td align="left">new line</td>
10264    </tr>
10265    <tr>
10266    <td align="left">\r</td>
10267    <td align="left">carriage return</td>
10268    </tr>
10269    <tr>
10270    <td align="left">\f</td>
10271    <td align="left">form feed</td>
10272    </tr>
10273    <tr>
10274    <td align="left">\t</td>
10275    <td align="left">horizontal tab</td>
10276    </tr>
10277    <tr>
10278    <td align="left">\v</td>
10279    <td align="left">vertical tab</td>
10280    </tr>
10281    <tr>
10282    <td align="left">\'</td>
10283    <td align="left">apostrophe</td>
10284    </tr>
10285    <tr>
10286    <td align="left">\"</td>
10287    <td align="left">quotation mark</td>
10288    </tr>
10289    <tr>
10290    <td align="left">\\</td>
10291    <td align="left">backslash</td>
10292    </tr>
10293    <tr>
10294    <td align="left">\OOO</td>
10295    <td align="left">three digit octal ASCII code of the character</td>
10296    </tr>
10297    <tr>
10298    <td align="left">\xHH</td>
10299    <td align="left">two digit hex ASCII code of the character</td>
10300    </tr>
10301    </table>
10302    
10303    <p>Notice: due to the transition of certain parts of the
10304                    protocol which now support escape sequences, a slight backward
10305                    incompatibility to protocols version v1.1 and younger has been
10306                    introduced. The only difference is that in parts of the protocol
10307                    where escape characters are now supported, a backslash characters
10308                    MUST be escaped as well (that is as double backslash), whereas
10309                    in the old versions a single backslash was sufficient.
10310    </p>
10311    <p>The following LSCP commands support escape sequences as part
10312                    of their filename / path based arguments:
10313                    </p>
10314    <blockquote class="text">
10315    <p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a>
10316    </p>
10317    <p><a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a>
10318    </p>
10319    <p><a class='info' href='#ADD DB_INSTRUMENT_DIRECTORY'>"ADD DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Creating a new instrument directory</span><span>)</span></a>
10320    </p>
10321    <p><a class='info' href='#ADD DB_INSTRUMENTS'>"ADD DB_INSTRUMENTS"<span> (</span><span class='info'>Adding instruments to the instruments database</span><span>)</span></a>
10322    </p>
10323    <p><a class='info' href='#REMOVE DB_INSTRUMENT_DIRECTORY'>"REMOVE DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Deleting an instrument directory</span><span>)</span></a>
10324    </p>
10325    <p><a class='info' href='#REMOVE DB_INSTRUMENT'>"REMOVE DB_INSTRUMENT"<span> (</span><span class='info'>Removing an instrument</span><span>)</span></a>
10326    </p>
10327    <p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORIES'>"GET DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Getting amount of instrument directories</span><span>)</span></a>
10328    </p>
10329    <p><a class='info' href='#LIST DB_INSTRUMENT_DIRECTORIES'>"LIST DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Listing all directories in specific directory</span><span>)</span></a>
10330    </p>
10331    <p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORY INFO'>"GET DB_INSTRUMENT_DIRECTORY INFO"<span> (</span><span class='info'>Getting instrument directory information</span><span>)</span></a>
10332    </p>
10333    <p><a class='info' href='#GET DB_INSTRUMENTS'>"GET DB_INSTRUMENTS"<span> (</span><span class='info'>Getting amount of instruments</span><span>)</span></a>
10334    </p>
10335    <p><a class='info' href='#LIST DB_INSTRUMENTS'>"LIST DB_INSTRUMENTS"<span> (</span><span class='info'>Listing all instruments in specific directory</span><span>)</span></a>
10336    </p>
10337    <p><a class='info' href='#GET DB_INSTRUMENT INFO'>"GET DB_INSTRUMENT INFO"<span> (</span><span class='info'>Getting instrument information</span><span>)</span></a>
10338    </p>
10339    <p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY NAME'>"SET DB_INSTRUMENT_DIRECTORY NAME"<span> (</span><span class='info'>Renaming an instrument directory</span><span>)</span></a>
10340    </p>
10341    <p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION'>"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"<span> (</span><span class='info'>Changing the description of directory</span><span>)</span></a>
10342    </p>
10343    <p><a class='info' href='#SET DB_INSTRUMENT NAME'>"SET DB_INSTRUMENT NAME"<span> (</span><span class='info'>Renaming an instrument</span><span>)</span></a>
10344    </p>
10345    <p><a class='info' href='#SET DB_INSTRUMENT DESCRIPTION'>"SET DB_INSTRUMENT DESCRIPTION"<span> (</span><span class='info'>Changing the description of instrument</span><span>)</span></a>
10346    </p>
10347    <p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a>
10348    </p>
10349    <p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a>
10350    </p>
10351    <p><a class='info' href='#MOVE DB_INSTRUMENT'>"MOVE DB_INSTRUMENT"<span> (</span><span class='info'>Moving an instrument</span><span>)</span></a>
10352    </p>
10353    <p><a class='info' href='#MOVE DB_INSTRUMENT_DIRECTORY'>"MOVE DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Moving an instrument directory</span><span>)</span></a>
10354    </p>
10355    <p><a class='info' href='#COPY DB_INSTRUMENT'>"COPY DB_INSTRUMENT"<span> (</span><span class='info'>Copying instruments</span><span>)</span></a>
10356    </p>
10357    <p><a class='info' href='#COPY DB_INSTRUMENT_DIRECTORY'>"COPY DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Copying instrument directories</span><span>)</span></a>
10358    </p>
10359    </blockquote><p>
10360                    Note that the forward slash character ('/') has a special meaning in
10361                    filename / path based arguments: it acts as separator of the nodes in
10362                    the path, thus if a directory- or filename includes a forward slash
10363                    (not intended as path node separator), you MUST escape that slash
10364                    either with the respective hex escape sequence ("\x2f") or with the
10365                    respective octal escape sequence ("\057").
10366                    
10367    </p>
10368    <p>
10369                    The following LSCP commands even support escape sequences as
10370                    part of at least one of their text-based arguments (i.e. entity name,
10371                    description):
10372                    </p>
10373    <blockquote class="text">
10374    <p><a class='info' href='#ADD MIDI_INSTRUMENT_MAP'>"ADD MIDI_INSTRUMENT_MAP"<span> (</span><span class='info'>Create a new MIDI instrument map</span><span>)</span></a>
10375    </p>
10376    <p><a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a>
10377    </p>
10378    <p><a class='info' href='#SET MIDI_INSTRUMENT_MAP NAME'>"SET MIDI_INSTRUMENT_MAP NAME"<span> (</span><span class='info'>Renaming a MIDI instrument map</span><span>)</span></a>
10379    </p>
10380    <p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY NAME'>"SET DB_INSTRUMENT_DIRECTORY NAME"<span> (</span><span class='info'>Renaming an instrument directory</span><span>)</span></a>
10381    </p>
10382    <p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION'>"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"<span> (</span><span class='info'>Changing the description of directory</span><span>)</span></a>
10383    </p>
10384    <p><a class='info' href='#SET DB_INSTRUMENT NAME'>"SET DB_INSTRUMENT NAME"<span> (</span><span class='info'>Renaming an instrument</span><span>)</span></a>
10385    </p>
10386    <p><a class='info' href='#SET DB_INSTRUMENT DESCRIPTION'>"SET DB_INSTRUMENT DESCRIPTION"<span> (</span><span class='info'>Changing the description of instrument</span><span>)</span></a>
10387    </p>
10388    <p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a>
10389    </p>
10390    </blockquote><p>
10391                    Please note that these lists are manually maintained. If you
10392                    find a command that also supports escape sequences we forgot to
10393                    mention here, please report it!
10394                    
10395    </p>
10396  <a name="events"></a><br /><hr />  <a name="events"></a><br /><hr />
10397  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10398  <a name="rfc.section.8"></a><h3>8.&nbsp;  <a name="rfc.section.8"></a><h3>8.&nbsp;
# Line 10132  Channel information changed</h3> Line 10682  Channel information changed</h3>
10682  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
10683  Number of effect sends changed</h3>  Number of effect sends changed</h3>
10684    
10685  <p>Client may want to be notified when the number of effect sends on  <p>Client may want to be notified when the number of effect sends on
10686                  a particular sampler channel is changed by issuing the following command:                  a particular sampler channel is changed by issuing the following command:
10687  </p>  </p>
10688  <p>  <p>
# Line 10529  Database instrument information changed< Line 11079  Database instrument information changed<
11079                  (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is                  (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
11080                  the new name of the instrument, encapsulated into apostrophes.                  the new name of the instrument, encapsulated into apostrophes.
11081  </p>  </p>
11082  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr />
11083  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11084  <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;  <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;
11085    Database job status information changed</h3>
11086    
11087    <p>Client may want to be notified when the status of particular database
11088                    instruments job is changed by issuing the following command:
11089    </p>
11090    <p>
11091                        </p>
11092    <blockquote class="text">
11093    <p>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO
11094    </p>
11095    </blockquote><p>
11096                    
11097    </p>
11098    <p>Server will start sending the following notification messages:
11099    </p>
11100    <p>
11101                        </p>
11102    <blockquote class="text">
11103    <p>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:&lt;job-id&gt;"
11104    </p>
11105    </blockquote><p>
11106                    
11107    </p>
11108    <p>where &lt;job-id&gt; will be replaced by the numerical ID of the job,
11109                    which status is changed. The front-end will have to send the respective
11110                    command to actually get the status info. Because these messages
11111                    will be triggered by LSCP commands issued by other clients rather than real
11112                    time events happening on the server, it is believed that an empty notification
11113                    message is sufficient here.
11114    </p>
11115    <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
11116    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11117    <a name="rfc.section.8.23"></a><h3>8.23.&nbsp;
11118  Miscellaneous and debugging events</h3>  Miscellaneous and debugging events</h3>
11119    
11120  <p>Client may want to be notified of miscellaneous and debugging events occurring at  <p>Client may want to be notified of miscellaneous and debugging events occurring at
# Line 10596  Acknowledgments</h3> Line 11179  Acknowledgments</h3>
11179  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
11180  <h3>11.&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
11181  <table width="99%" border="0">  <table width="99%" border="0">
11182    <tr><td class="author-text" valign="top"><a name="RFC20">[RFC20]</a></td>
11183    <td class="author-text">UCLA, &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc20.txt">ASCII format for Network Interchange</a>,&rdquo; RFC&nbsp;20, 1969.</td></tr>
11184  <tr><td class="author-text" valign="top"><a name="RFC2119">[RFC2119]</a></td>  <tr><td class="author-text" valign="top"><a name="RFC2119">[RFC2119]</a></td>
11185  <td class="author-text">Bradner, S., &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">Key words for use in RFCs to Indicate Requirement Levels</a>,&rdquo; RFC&nbsp;2119, 1997.</td></tr>  <td class="author-text">Bradner, S., &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">Key words for use in RFCs to Indicate Requirement Levels</a>,&rdquo; RFC&nbsp;2119, 1997.</td></tr>
11186  <tr><td class="author-text" valign="top"><a name="RFC2234">[RFC2234]</a></td>  <tr><td class="author-text" valign="top"><a name="RFC2234">[RFC2234]</a></td>
# Line 10673  Please address the information to the IE Line 11258  Please address the information to the IE
11258  Funding for the RFC Editor function is provided by  Funding for the RFC Editor function is provided by
11259  the IETF Administrative Support Activity (IASA).</p>  the IETF Administrative Support Activity (IASA).</p>
11260  </body></html>  </body></html>
11261    
Legend:
Removed from v.1189  
changed lines
  Added in v.1390
  ViewVC Help
Powered by ViewVC