/[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 1162 by iliev, Mon Apr 16 16:02:19 2007 UTC revision 1189 by iliev, Wed May 16 14:42:04 2007 UTC
# 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: October 18, 2007</td><td class="header">April 16, 2007</td></tr>  <tr><td class="header">Expires: November 17, 2007</td><td class="header">May 16, 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<br />LSCP 1.2</h1>
151    
# 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 October 18, 2007.</p>  This Internet-Draft will expire on November 17, 2007.</p>
177    
178  <h3>Copyright Notice</h3>  <h3>Copyright Notice</h3>
179  <p>  <p>
# Line 404  Getting instrument directory information Line 404  Getting instrument directory information
404  Renaming an instrument directory<br />  Renaming an instrument directory<br />
405  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MOVE DB_INSTRUMENT_DIRECTORY">6.8.7.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MOVE DB_INSTRUMENT_DIRECTORY">6.8.7.</a>&nbsp;
406  Moving an instrument directory<br />  Moving an instrument directory<br />
407  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">6.8.8.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#COPY DB_INSTRUMENT_DIRECTORY">6.8.8.</a>&nbsp;
408    Copying instrument directories<br />
409    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">6.8.9.</a>&nbsp;
410  Changing the description of directory<br />  Changing the description of directory<br />
411  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD DB_INSTRUMENTS">6.8.9.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FIND DB_INSTRUMENT_DIRECTORIES">6.8.10.</a>&nbsp;
412    Finding directories<br />
413    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD DB_INSTRUMENTS">6.8.11.</a>&nbsp;
414  Adding instruments to the instruments database<br />  Adding instruments to the instruments database<br />
415  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE DB_INSTRUMENT">6.8.10.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE DB_INSTRUMENT">6.8.12.</a>&nbsp;
416  Removing an instrument<br />  Removing an instrument<br />
417  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENTS">6.8.11.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENTS">6.8.13.</a>&nbsp;
418  Getting amount of instruments<br />  Getting amount of instruments<br />
419  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST DB_INSTRUMENTS">6.8.12.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST DB_INSTRUMENTS">6.8.14.</a>&nbsp;
420  Listing all instruments in specific directory<br />  Listing all instruments in specific directory<br />
421  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT INFO">6.8.13.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT INFO">6.8.15.</a>&nbsp;
422  Getting instrument information<br />  Getting instrument information<br />
423  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT NAME">6.8.14.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT NAME">6.8.16.</a>&nbsp;
424  Renaming an instrument<br />  Renaming an instrument<br />
425  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MOVE DB_INSTRUMENT">6.8.15.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MOVE DB_INSTRUMENT">6.8.17.</a>&nbsp;
426  Moving an instrument<br />  Moving an instrument<br />
427  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT DESCRIPTION">6.8.16.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#COPY DB_INSTRUMENT">6.8.18.</a>&nbsp;
428    Copying instruments<br />
429    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT DESCRIPTION">6.8.19.</a>&nbsp;
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;
432    Finding instruments<br />
433  <a href="#command_syntax">7.</a>&nbsp;  <a href="#command_syntax">7.</a>&nbsp;
434  Command Syntax<br />  Command Syntax<br />
435  <a href="#events">8.</a>&nbsp;  <a href="#events">8.</a>&nbsp;
# Line 7351  Getting amount of instrument directories Line 7359  Getting amount of instrument directories
7359  <p>  <p>
7360                          </p>                          </p>
7361  <blockquote class="text">  <blockquote class="text">
7362  <p>GET DB_INSTRUMENT_DIRECTORIES &lt;dir&gt;  <p>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;
7363  </p>  </p>
7364  </blockquote><p>  </blockquote><p>
7365                                            
7366  </p>  </p>
7367  <p>Where &lt;dir&gt; should be replaced by the absolute path  <p>Where &lt;dir&gt; should be replaced by the absolute path
7368                      name of the directory.                      name of the directory. If RECURSIVE is specified, the number of
7369                        all directories, including those located in subdirectories of the
7370                        specified directory, will be returned.
7371  </p>  </p>
7372  <p>Possible Answers:  <p>Possible Answers:
7373  </p>  </p>
# Line 7401  Listing all directories in specific dire Line 7411  Listing all directories in specific dire
7411  <p>  <p>
7412                          </p>                          </p>
7413  <blockquote class="text">  <blockquote class="text">
7414  <p>LIST DB_INSTRUMENT_DIRECTORIES &lt;dir&gt;  <p>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;
7415  </p>  </p>
7416  </blockquote><p>  </blockquote><p>
7417                                            
7418  </p>  </p>
7419  <p>Where &lt;dir&gt; should be replaced by the absolute path  <p>Where &lt;dir&gt; should be replaced by the absolute path
7420                      name of the directory.                      name of the directory. If RECURSIVE is specified, the absolute path names
7421                        of all directories, including those located in subdirectories of the
7422                        specified directory, will be returned.
7423  </p>  </p>
7424  <p>Possible Answers:  <p>Possible Answers:
7425  </p>  </p>
# Line 7440  Listing all directories in specific dire Line 7452  Listing all directories in specific dire
7452  </blockquote><p>  </blockquote><p>
7453                                            
7454  </p>  </p>
7455    <p>
7456                            </p>
7457    <blockquote class="text">
7458    <p>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"
7459    </p>
7460    <p>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"
7461    </p>
7462    </blockquote><p>
7463                        
7464    </p>
7465  <a name="GET DB_INSTRUMENT_DIRECTORY INFO"></a><br /><hr />  <a name="GET DB_INSTRUMENT_DIRECTORY INFO"></a><br /><hr />
7466  <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>
7467  <a name="rfc.section.6.8.5"></a><h3>6.8.5.&nbsp;  <a name="rfc.section.6.8.5"></a><h3>6.8.5.&nbsp;
# Line 7643  Moving an instrument directory</h3> Line 7665  Moving an instrument directory</h3>
7665  </blockquote><p>  </blockquote><p>
7666                                            
7667  </p>  </p>
7668  <a name="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"></a><br /><hr />  <a name="COPY DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7669  <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>
7670  <a name="rfc.section.6.8.8"></a><h3>6.8.8.&nbsp;  <a name="rfc.section.6.8.8"></a><h3>6.8.8.&nbsp;
7671    Copying instrument directories</h3>
7672    
7673    <p>The front-end can copy a specific
7674                        instrument directory by sending the following command:
7675    </p>
7676    <p>
7677                            </p>
7678    <blockquote class="text">
7679    <p>COPY DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;
7680    </p>
7681    </blockquote><p>
7682                        
7683    </p>
7684    <p>Where &lt;dir&gt; is the absolute path name of the directory
7685                        to copy and &lt;dst&gt; is the location where the directory will
7686                        be copied to.
7687    </p>
7688    <p>Possible Answers:
7689    </p>
7690    <p>
7691                            </p>
7692    <blockquote class="text">
7693    <p>"OK" -
7694                                    </p>
7695    <blockquote class="text">
7696    <p>on success
7697    </p>
7698    </blockquote>
7699                                
7700    
7701    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7702                                    </p>
7703    <blockquote class="text">
7704    <p>in case a given directory does not exists,
7705                                        or if a directory with name equal to the name
7706                                        of the specified directory already exists in
7707                                        the destination directory. Error is also thrown
7708                                        when trying to copy a directory to a subdirectory
7709                                        of itself.
7710    </p>
7711    </blockquote>
7712                                
7713    
7714    </blockquote><p>
7715                        
7716    </p>
7717    <p>Example:
7718    </p>
7719    <p>
7720                            </p>
7721    <blockquote class="text">
7722    <p>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"
7723    </p>
7724    <p>S: "OK"
7725    </p>
7726    </blockquote><p>
7727                        
7728    </p>
7729    <a name="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"></a><br /><hr />
7730    <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>
7731    <a name="rfc.section.6.8.9"></a><h3>6.8.9.&nbsp;
7732  Changing the description of directory</h3>  Changing the description of directory</h3>
7733    
7734  <p>The front-end can alter the description of a specific  <p>The front-end can alter the description of a specific
# Line 7698  Changing the description of directory</h Line 7781  Changing the description of directory</h
7781  </blockquote><p>  </blockquote><p>
7782                                            
7783  </p>  </p>
7784    <a name="FIND DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
7785    <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>
7786    <a name="rfc.section.6.8.10"></a><h3>6.8.10.&nbsp;
7787    Finding directories</h3>
7788    
7789    <p>The front-end can search for directories
7790                        in specific directory by sending the following command:
7791    </p>
7792    <p>
7793                            </p>
7794    <blockquote class="text">
7795    <p>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;
7796    </p>
7797    </blockquote><p>
7798                        
7799    </p>
7800    <p>Where &lt;dir&gt; should be replaced by the absolute path
7801                        name of the directory to search in. If NON_RECURSIVE is specified, the
7802                        directories located in subdirectories of the specified directory will not
7803                        be searched. &lt;criteria-list&gt; is a list of search criterias
7804                        in form of "key1=val1 key2=val2 ...". The following criterias are
7805                        allowed:
7806    </p>
7807    <p>
7808                          
7809    <p>NAME='&lt;search-string&gt;'
7810                              </p>
7811    <blockquote class="text">
7812    <p>Restricts the search to directories, which names
7813                                  satisfy the supplied search string.
7814    </p>
7815    </blockquote><p>
7816                          
7817    </p>
7818    
7819                          
7820    <p>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
7821                              </p>
7822    <blockquote class="text">
7823    <p>Restricts the search to directories, which creation
7824                                  date satisfies the specified period, where &lt;date-after&gt;
7825                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
7826                                  If &lt;date-after&gt; is omitted the search is restricted to
7827                                  directories created before &lt;date-before&gt;. If
7828                                  &lt;date-before&gt; is omitted, the search is restricted
7829                                  to directories created after &lt;date-after&gt;.
7830    </p>
7831    </blockquote><p>
7832                          
7833    </p>
7834    
7835                          
7836    <p>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
7837                              </p>
7838    <blockquote class="text">
7839    <p>Restricts the search to directories, which
7840                                  date of last modification satisfies the specified period, where
7841                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
7842                                  format. If &lt;date-after&gt; is omitted the search is restricted to
7843                                  directories, which are last modified before &lt;date-before&gt;. If
7844                                  &lt;date-before&gt; is omitted, the search is restricted to directories,
7845                                  which are last modified after &lt;date-after&gt;.
7846    </p>
7847    </blockquote><p>
7848                          
7849    </p>
7850    
7851                          
7852    <p>DESCRIPTION='&lt;search-string&gt;'
7853                              </p>
7854    <blockquote class="text">
7855    <p>Restricts the search to directories with description
7856                                  that satisfies the supplied search string.
7857    </p>
7858    </blockquote><p>
7859                          
7860    </p>
7861                        
7862    
7863    <p>Where &lt;search-string&gt; is either a regular expression, or a
7864                        word list separated with spaces for OR search and with '+' for AND search.
7865    </p>
7866    <p>Possible Answers:
7867    </p>
7868    <p>
7869                            </p>
7870    <blockquote class="text">
7871    <p>A comma separated list with the absolute path names (encapsulated into
7872                                apostrophes) of all directories in the specified directory that satisfy
7873                                the supplied search criterias.
7874    </p>
7875    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7876                                    </p>
7877    <blockquote class="text">
7878    <p>if the given directory does not exist.
7879    </p>
7880    </blockquote>
7881                                
7882    
7883    </blockquote><p>
7884                        
7885    </p>
7886    <p>Example:
7887    </p>
7888    <p>
7889                            </p>
7890    <blockquote class="text">
7891    <p>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"
7892    </p>
7893    <p>S: "'/Piano Collection'"
7894    </p>
7895    </blockquote><p>
7896                        
7897    </p>
7898    <p>
7899                            </p>
7900    <blockquote class="text">
7901    <p>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"
7902    </p>
7903    <p>S: "'/Piano Collection','/Percussions'"
7904    </p>
7905    </blockquote><p>
7906                        
7907    </p>
7908  <a name="ADD DB_INSTRUMENTS"></a><br /><hr />  <a name="ADD DB_INSTRUMENTS"></a><br /><hr />
7909  <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>
7910  <a name="rfc.section.6.8.9"></a><h3>6.8.9.&nbsp;  <a name="rfc.section.6.8.11"></a><h3>6.8.11.&nbsp;
7911  Adding instruments to the instruments database</h3>  Adding instruments to the instruments database</h3>
7912    
7913  <p>The front-end can add one or more instruments  <p>The front-end can add one or more instruments
# Line 7805  Adding instruments to the instruments da Line 8012  Adding instruments to the instruments da
8012  </p>  </p>
8013  <a name="REMOVE DB_INSTRUMENT"></a><br /><hr />  <a name="REMOVE DB_INSTRUMENT"></a><br /><hr />
8014  <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>
8015  <a name="rfc.section.6.8.10"></a><h3>6.8.10.&nbsp;  <a name="rfc.section.6.8.12"></a><h3>6.8.12.&nbsp;
8016  Removing an instrument</h3>  Removing an instrument</h3>
8017    
8018  <p>The front-end can remove a particular instrument  <p>The front-end can remove a particular instrument
# Line 7861  Removing an instrument</h3> Line 8068  Removing an instrument</h3>
8068  </p>  </p>
8069  <a name="GET DB_INSTRUMENTS"></a><br /><hr />  <a name="GET DB_INSTRUMENTS"></a><br /><hr />
8070  <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>
8071  <a name="rfc.section.6.8.11"></a><h3>6.8.11.&nbsp;  <a name="rfc.section.6.8.13"></a><h3>6.8.13.&nbsp;
8072  Getting amount of instruments</h3>  Getting amount of instruments</h3>
8073    
8074  <p>The front-end can retrieve the current amount of  <p>The front-end can retrieve the current amount of
# Line 7870  Getting amount of instruments</h3> Line 8077  Getting amount of instruments</h3>
8077  <p>  <p>
8078                          </p>                          </p>
8079  <blockquote class="text">  <blockquote class="text">
8080  <p>GET DB_INSTRUMENTS &lt;dir&gt;  <p>GET DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;
8081  </p>  </p>
8082  </blockquote><p>  </blockquote><p>
8083                                            
8084  </p>  </p>
8085  <p>Where &lt;dir&gt; should be replaced by the absolute path name  <p>Where &lt;dir&gt; should be replaced by the absolute path name
8086                      of the directory.                      of the directory. If RECURSIVE is specified, the number of all
8087                        instruments, including those located in subdirectories of the
8088                        specified directory, will be returned.
8089  </p>  </p>
8090  <p>Possible Answers:  <p>Possible Answers:
8091  </p>  </p>
# Line 7911  Getting amount of instruments</h3> Line 8120  Getting amount of instruments</h3>
8120  </p>  </p>
8121  <a name="LIST DB_INSTRUMENTS"></a><br /><hr />  <a name="LIST DB_INSTRUMENTS"></a><br /><hr />
8122  <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>
8123  <a name="rfc.section.6.8.12"></a><h3>6.8.12.&nbsp;  <a name="rfc.section.6.8.14"></a><h3>6.8.14.&nbsp;
8124  Listing all instruments in specific directory</h3>  Listing all instruments in specific directory</h3>
8125    
8126  <p>The front-end can retrieve the current list of instruments  <p>The front-end can retrieve the current list of instruments
# Line 7920  Listing all instruments in specific dire Line 8129  Listing all instruments in specific dire
8129  <p>  <p>
8130                          </p>                          </p>
8131  <blockquote class="text">  <blockquote class="text">
8132  <p>LIST DB_INSTRUMENTS &lt;dir&gt;  <p>LIST DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;
8133  </p>  </p>
8134  </blockquote><p>  </blockquote><p>
8135                                            
8136  </p>  </p>
8137  <p>Where &lt;dir&gt; should be replaced by the absolute path  <p>Where &lt;dir&gt; should be replaced by the absolute path
8138                      name of the directory.                      name of the directory. If RECURSIVE is specified, the absolute path
8139                        names of all instruments, including those located in subdirectories
8140                        of the specified directory, will be returned.
8141  </p>  </p>
8142  <p>Possible Answers:  <p>Possible Answers:
8143  </p>  </p>
# Line 7959  Listing all instruments in specific dire Line 8170  Listing all instruments in specific dire
8170  </blockquote><p>  </blockquote><p>
8171                                            
8172  </p>  </p>
8173    <p>
8174                            </p>
8175    <blockquote class="text">
8176    <p>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"
8177    </p>
8178    <p>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"
8179    </p>
8180    </blockquote><p>
8181                        
8182    </p>
8183  <a name="GET DB_INSTRUMENT INFO"></a><br /><hr />  <a name="GET DB_INSTRUMENT INFO"></a><br /><hr />
8184  <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>
8185  <a name="rfc.section.6.8.13"></a><h3>6.8.13.&nbsp;  <a name="rfc.section.6.8.15"></a><h3>6.8.15.&nbsp;
8186  Getting instrument information</h3>  Getting instrument information</h3>
8187    
8188  <p>The front-end can ask for the current settings of an  <p>The front-end can ask for the current settings of an
# Line 8140  Getting instrument information</h3> Line 8361  Getting instrument information</h3>
8361  </p>  </p>
8362  <a name="SET DB_INSTRUMENT NAME"></a><br /><hr />  <a name="SET DB_INSTRUMENT NAME"></a><br /><hr />
8363  <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>
8364  <a name="rfc.section.6.8.14"></a><h3>6.8.14.&nbsp;  <a name="rfc.section.6.8.16"></a><h3>6.8.16.&nbsp;
8365  Renaming an instrument</h3>  Renaming an instrument</h3>
8366    
8367  <p>The front-end can alter the name of a specific  <p>The front-end can alter the name of a specific
# Line 8197  Renaming an instrument</h3> Line 8418  Renaming an instrument</h3>
8418  </p>  </p>
8419  <a name="MOVE DB_INSTRUMENT"></a><br /><hr />  <a name="MOVE DB_INSTRUMENT"></a><br /><hr />
8420  <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>
8421  <a name="rfc.section.6.8.15"></a><h3>6.8.15.&nbsp;  <a name="rfc.section.6.8.17"></a><h3>6.8.17.&nbsp;
8422  Moving an instrument</h3>  Moving an instrument</h3>
8423    
8424  <p>The front-end can move a specific instrument to another directory by  <p>The front-end can move a specific instrument to another directory by
# Line 8254  Moving an instrument</h3> Line 8475  Moving an instrument</h3>
8475  </blockquote><p>  </blockquote><p>
8476                                            
8477  </p>  </p>
8478    <a name="COPY DB_INSTRUMENT"></a><br /><hr />
8479    <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>
8480    <a name="rfc.section.6.8.18"></a><h3>6.8.18.&nbsp;
8481    Copying instruments</h3>
8482    
8483    <p>The front-end can copy a specific instrument to another directory by
8484                        sending the following command:
8485    </p>
8486    <p>
8487                            </p>
8488    <blockquote class="text">
8489    <p>COPY DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;
8490    </p>
8491    </blockquote><p>
8492                        
8493    </p>
8494    <p>Where &lt;instr&gt; is the absolute path name of the instrument
8495                        to copy and &lt;dst&gt; is the directory where the instrument will
8496                        be copied to.
8497    </p>
8498    <p>Possible Answers:
8499    </p>
8500    <p>
8501                            </p>
8502    <blockquote class="text">
8503    <p>"OK" -
8504                                    </p>
8505    <blockquote class="text">
8506    <p>on success
8507    </p>
8508    </blockquote>
8509                                
8510    
8511    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8512                                    </p>
8513    <blockquote class="text">
8514    <p>in case the given instrument does not exists,
8515                                        or if an instrument with name equal to the name of the
8516                                        specified instrument already exists in the destination
8517                                        directory.
8518    </p>
8519    </blockquote>
8520                                
8521    
8522    </blockquote><p>
8523                        
8524    </p>
8525    <p>Example:
8526    </p>
8527    <p>
8528                            </p>
8529    <blockquote class="text">
8530    <p>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"
8531    </p>
8532    <p>S: "OK"
8533    </p>
8534    </blockquote><p>
8535                        
8536    </p>
8537  <a name="SET DB_INSTRUMENT DESCRIPTION"></a><br /><hr />  <a name="SET DB_INSTRUMENT DESCRIPTION"></a><br /><hr />
8538  <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>
8539  <a name="rfc.section.6.8.16"></a><h3>6.8.16.&nbsp;  <a name="rfc.section.6.8.19"></a><h3>6.8.19.&nbsp;
8540  Changing the description of instrument</h3>  Changing the description of instrument</h3>
8541    
8542  <p>The front-end can alter the description of a specific  <p>The front-end can alter the description of a specific
# Line 8309  Changing the description of instrument</ Line 8589  Changing the description of instrument</
8589  </blockquote><p>  </blockquote><p>
8590                                            
8591  </p>  </p>
8592    <a name="FIND DB_INSTRUMENTS"></a><br /><hr />
8593    <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>
8594    <a name="rfc.section.6.8.20"></a><h3>6.8.20.&nbsp;
8595    Finding instruments</h3>
8596    
8597    <p>The front-end can search for instruments
8598                        in specific directory by sending the following command:
8599    </p>
8600    <p>
8601                            </p>
8602    <blockquote class="text">
8603    <p>FIND DB_INSTRUMENTS [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;
8604    </p>
8605    </blockquote><p>
8606                        
8607    </p>
8608    <p>Where &lt;dir&gt; should be replaced by the absolute path
8609                        name of the directory to search in. If NON_RECURSIVE is specified, the
8610                        directories located in subdirectories of the specified directory will not
8611                        be searched. &lt;criteria-list&gt; is a list of search criterias
8612                        in form of "key1=val1 key2=val2 ...". The following criterias are
8613                        allowed:
8614    </p>
8615    <p>
8616                          
8617    <p>NAME='&lt;search-string&gt;'
8618                              </p>
8619    <blockquote class="text">
8620    <p>Restricts the search to instruments, which names
8621                                  satisfy the supplied search string.
8622    </p>
8623    </blockquote><p>
8624                          
8625    </p>
8626    
8627                          
8628    <p>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
8629                              </p>
8630    <blockquote class="text">
8631    <p>Restricts the search to instruments, which
8632                                  size is in the specified range. If &lt;min&gt; is omitted,
8633                                  the search results are restricted to instruments with size less then
8634                                  or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
8635                                  search is restricted to instruments with size greater then
8636                                  or equal to &lt;min&gt;.
8637    </p>
8638    </blockquote><p>
8639                          
8640    </p>
8641    
8642                          
8643    <p>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
8644                              </p>
8645    <blockquote class="text">
8646    <p>Restricts the search to instruments, which creation
8647                                  date satisfies the specified period, where &lt;date-after&gt;
8648                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
8649                                  If &lt;date-after&gt; is omitted the search is restricted to
8650                                  instruments created before &lt;date-before&gt;. If
8651                                  &lt;date-before&gt; is omitted, the search is restricted
8652                                  to instruments created after &lt;date-after&gt;.
8653    </p>
8654    </blockquote><p>
8655                          
8656    </p>
8657    
8658                          
8659    <p>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
8660                              </p>
8661    <blockquote class="text">
8662    <p>Restricts the search to instruments, which
8663                                  date of last modification satisfies the specified period, where
8664                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
8665                                  format. If &lt;date-after&gt; is omitted the search is restricted to
8666                                  instruments, which are last modified before &lt;date-before&gt;. If
8667                                  &lt;date-before&gt; is omitted, the search is restricted to instruments,
8668                                  which are last modified after &lt;date-after&gt;.
8669    </p>
8670    </blockquote><p>
8671                          
8672    </p>
8673    
8674                          
8675    <p>DESCRIPTION='&lt;search-string&gt;'
8676                              </p>
8677    <blockquote class="text">
8678    <p>Restricts the search to instruments with description
8679                                  that satisfies the supplied search string.
8680    </p>
8681    </blockquote><p>
8682                          
8683    </p>
8684    
8685                          
8686    <p>PRODUCT='&lt;search-string&gt;'
8687                              </p>
8688    <blockquote class="text">
8689    <p>Restricts the search to instruments with product info
8690                                  that satisfies the supplied search string.
8691    </p>
8692    </blockquote><p>
8693                          
8694    </p>
8695    
8696                          
8697    <p>ARTISTS='&lt;search-string&gt;'
8698                              </p>
8699    <blockquote class="text">
8700    <p>Restricts the search to instruments with artists info
8701                                  that satisfies the supplied search string.
8702    </p>
8703    </blockquote><p>
8704                          
8705    </p>
8706    
8707                          
8708    <p>KEYWORDS='&lt;search-string&gt;'
8709                              </p>
8710    <blockquote class="text">
8711    <p>Restricts the search to instruments with keyword list
8712                                  that satisfies the supplied search string.
8713    </p>
8714    </blockquote><p>
8715                          
8716    </p>
8717    
8718                          
8719    <p>IS_DRUM=true | false
8720                              </p>
8721    <blockquote class="text">
8722    <p>Either true or false. Restricts the search to
8723                                  drum kits or chromatic instruments.
8724    </p>
8725    </blockquote><p>
8726                          
8727    </p>
8728    
8729                          
8730    <p>FORMAT_FAMILIES='&lt;format-list&gt;'
8731                              </p>
8732    <blockquote class="text">
8733    <p>Restricts the search to instruments of the supplied format families,
8734                                  where &lt;format-list&gt; is a comma separated list of format families.
8735    </p>
8736    </blockquote><p>
8737                          
8738    </p>
8739                        
8740    
8741    <p>Where &lt;search-string&gt; is either a regular expression, or a
8742                        word list separated with spaces for OR search and with '+' for AND search.
8743    </p>
8744    <p>Possible Answers:
8745    </p>
8746    <p>
8747                            </p>
8748    <blockquote class="text">
8749    <p>A comma separated list with the absolute path names (encapsulated into
8750                                apostrophes) of all instruments in the specified directory that satisfy
8751                                the supplied search criterias.
8752    </p>
8753    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8754                                    </p>
8755    <blockquote class="text">
8756    <p>if the given directory does not exist.
8757    </p>
8758    </blockquote>
8759                                
8760    
8761    </blockquote><p>
8762                        
8763    </p>
8764    <p>Example:
8765    </p>
8766    <p>
8767                            </p>
8768    <blockquote class="text">
8769    <p>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"
8770    </p>
8771    <p>S: "'/Piano Collection/Bosendorfer 290'"
8772    </p>
8773    </blockquote><p>
8774                        
8775    </p>
8776    <p>
8777                            </p>
8778    <blockquote class="text">
8779    <p>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"
8780    </p>
8781    <p>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"
8782    </p>
8783    </blockquote><p>
8784                        
8785    </p>
8786  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
8787  <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>
8788  <a name="rfc.section.7"></a><h3>7.&nbsp;  <a name="rfc.section.7"></a><h3>7.&nbsp;
# Line 8415  Command Syntax</h3> Line 8889  Command Syntax</h3>
8889  <p>/ CLEAR SP clear_instruction  <p>/ CLEAR SP clear_instruction
8890                                    
8891  </p>  </p>
8892    <p>/ FIND SP find_instruction
8893                    
8894    </p>
8895  <p>/ MOVE SP move_instruction  <p>/ MOVE SP move_instruction
8896                                    
8897  </p>  </p>
8898    <p>/ COPY SP copy_instruction
8899                    
8900    </p>
8901  <p>/ RESET  <p>/ RESET
8902                                    
8903  </p>  </p>
# Line 8754  Command Syntax</h3> Line 9234  Command Syntax</h3>
9234  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
9235                                    
9236  </p>  </p>
9237    <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
9238                    
9239    </p>
9240  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname
9241                                    
9242  </p>  </p>
9243  <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
9244                                    
9245  </p>  </p>
9246    <p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname
9247                    
9248    </p>
9249  <p>/ DB_INSTRUMENTS SP pathname  <p>/ DB_INSTRUMENTS SP pathname
9250                                    
9251  </p>  </p>
# Line 8871  Command Syntax</h3> Line 9357  Command Syntax</h3>
9357  </blockquote><p>  </blockquote><p>
9358    
9359  </p>  </p>
9360    <p>find_instruction =
9361            </p>
9362    <blockquote class="text">
9363    <p>DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list
9364                    
9365    </p>
9366    <p>/ DB_INSTRUMENTS SP pathname SP query_val_list
9367                    
9368    </p>
9369    <p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP query_val_list
9370                    
9371    </p>
9372    <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list
9373                    
9374    </p>
9375    </blockquote><p>
9376    
9377    </p>
9378  <p>move_instruction =  <p>move_instruction =
9379          </p>          </p>
9380  <blockquote class="text">  <blockquote class="text">
# Line 8883  Command Syntax</h3> Line 9387  Command Syntax</h3>
9387  </blockquote><p>  </blockquote><p>
9388    
9389  </p>  </p>
9390    <p>copy_instruction =
9391            </p>
9392    <blockquote class="text">
9393    <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
9394                    
9395    </p>
9396    <p>/ DB_INSTRUMENT SP pathname SP pathname
9397                    
9398    </p>
9399    </blockquote><p>
9400    
9401    </p>
9402  <p>destroy_instruction =  <p>destroy_instruction =
9403          </p>          </p>
9404  <blockquote class="text">  <blockquote class="text">
# Line 9027  Command Syntax</h3> Line 9543  Command Syntax</h3>
9543  <p>/ FX_SENDS SP sampler_channel  <p>/ FX_SENDS SP sampler_channel
9544                                    
9545  </p>  </p>
9546    <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
9547                    
9548    </p>
9549  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname
9550                                    
9551  </p>  </p>
9552    <p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname
9553                    
9554    </p>
9555  <p>/ DB_INSTRUMENTS SP pathname  <p>/ DB_INSTRUMENTS SP pathname
9556                                    
9557  </p>  </p>
# Line 9295  Command Syntax</h3> Line 9817  Command Syntax</h3>
9817                                    
9818  </p>  </p>
9819  </blockquote><p>  </blockquote><p>
9820    
9821    </p>
9822    <p>query_val_list =
9823            </p>
9824    <blockquote class="text">
9825    <p>string '=' query_val
9826                    
9827    </p>
9828    <p>/ query_val_list SP string '=' query_val
9829                    
9830    </p>
9831    </blockquote><p>
9832    
9833    </p>
9834    <p>query_val =
9835            </p>
9836    <blockquote class="text">
9837    <p>string
9838                    
9839    </p>
9840    <p>/ stringval
9841                    
9842    </p>
9843    </blockquote><p>
9844    
9845  </p>  </p>
9846  <a name="events"></a><br /><hr />  <a name="events"></a><br /><hr />
Legend:
Removed from v.1162  
changed lines
  Added in v.1189
  ViewVC Help
Powered by ViewVC