/[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 1137 by iliev, Thu Mar 29 10:06:37 2007 UTC revision 1201 by iliev, Thu May 24 14:22:39 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: September 30, 2007</td><td class="header">March 29, 2007</td></tr>  <tr><td class="header">Expires: November 25, 2007</td><td class="header">May 24, 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 September 30, 2007.</p>  This Internet-Draft will expire on November 25, 2007.</p>
177    
178  <h3>Copyright Notice</h3>  <h3>Copyright Notice</h3>
179  <p>  <p>
# Line 388  Remove an entry from the MIDI instrument Line 388  Remove an entry from the MIDI instrument
388  Get current settings of MIDI instrument map entry<br />  Get current settings of MIDI instrument map entry<br />
389  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CLEAR MIDI_INSTRUMENTS">6.7.12.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CLEAR MIDI_INSTRUMENTS">6.7.12.</a>&nbsp;
390  Clear MIDI instrument map<br />  Clear MIDI instrument map<br />
391    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Managing Instruments Database">6.8.</a>&nbsp;
392    Managing Instruments Database<br />
393    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD DB_INSTRUMENT_DIRECTORY">6.8.1.</a>&nbsp;
394    Creating a new instrument directory<br />
395    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE DB_INSTRUMENT_DIRECTORY">6.8.2.</a>&nbsp;
396    Deleting an instrument directory<br />
397    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT_DIRECTORIES">6.8.3.</a>&nbsp;
398    Getting amount of instrument directories<br />
399    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST DB_INSTRUMENT_DIRECTORIES">6.8.4.</a>&nbsp;
400    Listing all directories in specific directory<br />
401    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT_DIRECTORY INFO">6.8.5.</a>&nbsp;
402    Getting instrument directory information<br />
403    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT_DIRECTORY NAME">6.8.6.</a>&nbsp;
404    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;
406    Moving an instrument directory<br />
407    &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 />
411    &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 />
415    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE DB_INSTRUMENT">6.8.12.</a>&nbsp;
416    Removing an instrument<br />
417    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENTS">6.8.13.</a>&nbsp;
418    Getting amount of instruments<br />
419    &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 />
421    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT INFO">6.8.15.</a>&nbsp;
422    Getting instrument information<br />
423    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT NAME">6.8.16.</a>&nbsp;
424    Renaming an instrument<br />
425    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MOVE DB_INSTRUMENT">6.8.17.</a>&nbsp;
426    Moving an instrument<br />
427    &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 />
431    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FIND DB_INSTRUMENTS">6.8.20.</a>&nbsp;
432    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  <a href="#command_syntax">7.</a>&nbsp;  <a href="#command_syntax">7.</a>&nbsp;
436  Command Syntax<br />  Command Syntax<br />
437  <a href="#events">8.</a>&nbsp;  <a href="#events">8.</a>&nbsp;
# Line 426  Number of MIDI instruments changed<br /> Line 470  Number of MIDI instruments changed<br />
470  MIDI instrument information changed<br />  MIDI instrument information changed<br />
471  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a>&nbsp;
472  Global settings changed<br />  Global settings changed<br />
473  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.18.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.18.</a>&nbsp;
474    Number of database instrument directories changed<br />
475    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.19.</a>&nbsp;
476    Database instrument directory information changed<br />
477    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.20.</a>&nbsp;
478    Number of database instruments changed<br />
479    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.21.</a>&nbsp;
480    Database instrument information changed<br />
481    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.22.</a>&nbsp;
482    Database job status information changed<br />
483    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.23.</a>&nbsp;
484  Miscellaneous and debugging events<br />  Miscellaneous and debugging events<br />
485  <a href="#anchor14">9.</a>&nbsp;  <a href="#anchor14">9.</a>&nbsp;
486  Security Considerations<br />  Security Considerations<br />
# Line 6056  General sampler informations</h3> Line 6110  General sampler informations</h3>
6110  </blockquote>  </blockquote>
6111                                                                            
6112    
6113    <p>INSTRUMENTS_DB_SUPPORT -
6114                                            </p>
6115    <blockquote class="text">
6116    <p>either yes or no, specifies whether the
6117                                                sampler is build with instruments database support.
6118    </p>
6119    </blockquote>
6120                                        
6121    
6122  </blockquote>  </blockquote>
6123                                                            
6124    
# Line 7166  Clear MIDI instrument map</h3> Line 7229  Clear MIDI instrument map</h3>
7229  </blockquote><p>  </blockquote><p>
7230                                            
7231  </p>  </p>
7232    <a name="Managing Instruments Database"></a><br /><hr />
7233    <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>
7234    <a name="rfc.section.6.8"></a><h3>6.8.&nbsp;
7235    Managing Instruments Database</h3>
7236    
7237    <p>The following commands describe how to use and manage
7238                    the instruments database.
7239    </p>
7240    <a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7241    <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>
7242    <a name="rfc.section.6.8.1"></a><h3>6.8.1.&nbsp;
7243    Creating a new instrument directory</h3>
7244    
7245    <p>The front-end can add a new instrument directory to the
7246                        instruments database by sending the following command:
7247    </p>
7248    <p>
7249                            </p>
7250    <blockquote class="text">
7251    <p>ADD DB_INSTRUMENT_DIRECTORY &lt;dir&gt;
7252    </p>
7253    </blockquote><p>
7254                        
7255    </p>
7256    <p>Where &lt;dir&gt; is the absolute path name of the directory
7257                        to be created (encapsulated into apostrophes).
7258    </p>
7259    <p>Possible Answers:
7260    </p>
7261    <p>
7262                            </p>
7263    <blockquote class="text">
7264    <p>"OK" -
7265                                    </p>
7266    <blockquote class="text">
7267    <p>on success
7268    </p>
7269    </blockquote>
7270                                
7271    
7272    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7273                                    </p>
7274    <blockquote class="text">
7275    <p>when the directory could not be created, which
7276                                        can happen if the directory already exists or the
7277                                        name contains not allowed symbols
7278    </p>
7279    </blockquote>
7280                                
7281    
7282    </blockquote><p>
7283                        
7284    </p>
7285    <p>Examples:
7286    </p>
7287    <p>
7288                            </p>
7289    <blockquote class="text">
7290    <p>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
7291    </p>
7292    <p>S: "OK"
7293    </p>
7294    </blockquote><p>
7295                        
7296    </p>
7297    <a name="REMOVE DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7298    <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>
7299    <a name="rfc.section.6.8.2"></a><h3>6.8.2.&nbsp;
7300    Deleting an instrument directory</h3>
7301    
7302    <p>The front-end can delete a particular instrument directory
7303                        from the instruments database by sending the following command:
7304    </p>
7305    <p>
7306                            </p>
7307    <blockquote class="text">
7308    <p>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] &lt;dir&gt;
7309    </p>
7310    </blockquote><p>
7311                        
7312    </p>
7313    <p>Where &lt;dir&gt; is the absolute path name of the directory
7314                        to delete. The optional FORCE argument can be used to
7315                        force the deletion of a non-empty directory and all its content.
7316    </p>
7317    <p>Possible Answers:
7318    </p>
7319    <p>
7320                            </p>
7321    <blockquote class="text">
7322    <p>"OK" -
7323                                    </p>
7324    <blockquote class="text">
7325    <p>if the directory is deleted successfully
7326    </p>
7327    </blockquote>
7328                                
7329    
7330    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7331                                    </p>
7332    <blockquote class="text">
7333    <p>if the given directory does not exist, or
7334                                        if trying to delete a non-empty directory,
7335                                        without using the FORCE argument.
7336    </p>
7337    </blockquote>
7338                                
7339    
7340    </blockquote><p>
7341                        
7342    </p>
7343    <p>Examples:
7344    </p>
7345    <p>
7346                            </p>
7347    <blockquote class="text">
7348    <p>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"
7349    </p>
7350    <p>S: "OK"
7351    </p>
7352    </blockquote><p>
7353                        
7354    </p>
7355    <a name="GET DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
7356    <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>
7357    <a name="rfc.section.6.8.3"></a><h3>6.8.3.&nbsp;
7358    Getting amount of instrument directories</h3>
7359    
7360    <p>The front-end can retrieve the current amount of
7361                        directories in a specific directory by sending the following command:
7362    </p>
7363    <p>
7364                            </p>
7365    <blockquote class="text">
7366    <p>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;
7367    </p>
7368    </blockquote><p>
7369                        
7370    </p>
7371    <p>Where &lt;dir&gt; should be replaced by the absolute path
7372                        name of the directory. If RECURSIVE is specified, the number of
7373                        all directories, including those located in subdirectories of the
7374                        specified directory, will be returned.
7375    </p>
7376    <p>Possible Answers:
7377    </p>
7378    <p>
7379                            </p>
7380    <blockquote class="text">
7381    <p>The current number of instrument directories
7382                                in the specified directory.
7383    </p>
7384    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7385                                    </p>
7386    <blockquote class="text">
7387    <p>if the given directory does not exist.
7388    </p>
7389    </blockquote>
7390                                
7391    
7392    </blockquote><p>
7393                        
7394    </p>
7395    <p>Example:
7396    </p>
7397    <p>
7398                            </p>
7399    <blockquote class="text">
7400    <p>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
7401    </p>
7402    <p>S: "2"
7403    </p>
7404    </blockquote><p>
7405                        
7406    </p>
7407    <a name="LIST DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
7408    <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>
7409    <a name="rfc.section.6.8.4"></a><h3>6.8.4.&nbsp;
7410    Listing all directories in specific directory</h3>
7411    
7412    <p>The front-end can retrieve the current list of directories
7413                        in specific directory by sending the following command:
7414    </p>
7415    <p>
7416                            </p>
7417    <blockquote class="text">
7418    <p>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;
7419    </p>
7420    </blockquote><p>
7421                        
7422    </p>
7423    <p>Where &lt;dir&gt; should be replaced by the absolute path
7424                        name of the directory. If RECURSIVE is specified, the absolute path names
7425                        of all directories, including those located in subdirectories of the
7426                        specified directory, will be returned.
7427    </p>
7428    <p>Possible Answers:
7429    </p>
7430    <p>
7431                            </p>
7432    <blockquote class="text">
7433    <p>A comma separated list of all instrument directories
7434                                (encapsulated into apostrophes) in the specified directory.
7435    </p>
7436    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7437                                    </p>
7438    <blockquote class="text">
7439    <p>if the given directory does not exist.
7440    </p>
7441    </blockquote>
7442                                
7443    
7444    </blockquote><p>
7445                        
7446    </p>
7447    <p>Example:
7448    </p>
7449    <p>
7450                            </p>
7451    <blockquote class="text">
7452    <p>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
7453    </p>
7454    <p>S: "'Piano Collection','Percussion Collection'"
7455    </p>
7456    </blockquote><p>
7457                        
7458    </p>
7459    <p>
7460                            </p>
7461    <blockquote class="text">
7462    <p>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"
7463    </p>
7464    <p>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"
7465    </p>
7466    </blockquote><p>
7467                        
7468    </p>
7469    <a name="GET DB_INSTRUMENT_DIRECTORY INFO"></a><br /><hr />
7470    <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>
7471    <a name="rfc.section.6.8.5"></a><h3>6.8.5.&nbsp;
7472    Getting instrument directory information</h3>
7473    
7474    <p>The front-end can ask for the current settings of an
7475                        instrument directory by sending the following command:
7476    </p>
7477    <p>
7478                            </p>
7479    <blockquote class="text">
7480    <p>GET DB_INSTRUMENT_DIRECTORY INFO &lt;dir&gt;
7481    </p>
7482    </blockquote><p>
7483                        
7484    </p>
7485    <p>Where &lt;dir&gt; should be replaced by the absolute path
7486                        name of the directory the front-end is interested in.
7487    </p>
7488    <p>Possible Answers:
7489    </p>
7490    <p>
7491                            </p>
7492    <blockquote class="text">
7493    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
7494                                Each answer line begins with the settings category name
7495                                followed by a colon and then a space character &lt;SP&gt; and finally
7496                                the info character string to that setting category. At the
7497                                moment the following categories are defined:
7498    </p>
7499    <p>
7500                                    </p>
7501    <blockquote class="text">
7502    <p>DESCRIPTION -
7503                                            </p>
7504    <blockquote class="text">
7505    <p>A brief description of the directory content
7506    </p>
7507    </blockquote>
7508                                        
7509    
7510    <p>CREATED -
7511                                            </p>
7512    <blockquote class="text">
7513    <p>The creation date and time of the directory,
7514                                                represented in "YYYY-MM-DD HH:MM:SS" format
7515    </p>
7516    </blockquote>
7517                                        
7518    
7519    <p>MODIFIED -
7520                                            </p>
7521    <blockquote class="text">
7522    <p>The date and time of the last modification of the
7523                                                directory, represented in "YYYY-MM-DD HH:MM:SS" format
7524    </p>
7525    </blockquote>
7526                                        
7527    
7528    </blockquote>
7529                                
7530    
7531    </blockquote><p>
7532                        
7533    </p>
7534    <p>The mentioned fields above don't have to be in particular order.
7535    </p>
7536    <p>Example:
7537    </p>
7538    <p>
7539                            </p>
7540    <blockquote class="text">
7541    <p>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
7542    </p>
7543    <p>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."
7544    </p>
7545    <p>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"
7546    </p>
7547    <p>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"
7548    </p>
7549    <p>&nbsp;&nbsp;&nbsp;"."
7550    </p>
7551    </blockquote><p>
7552                        
7553    </p>
7554    <a name="SET DB_INSTRUMENT_DIRECTORY NAME"></a><br /><hr />
7555    <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>
7556    <a name="rfc.section.6.8.6"></a><h3>6.8.6.&nbsp;
7557    Renaming an instrument directory</h3>
7558    
7559    <p>The front-end can alter the name of a specific
7560                        instrument directory by sending the following command:
7561    </p>
7562    <p>
7563                            </p>
7564    <blockquote class="text">
7565    <p>SET DB_INSTRUMENT_DIRECTORY NAME &lt;dir&gt; &lt;name&gt;
7566    </p>
7567    </blockquote><p>
7568                        
7569    </p>
7570    <p>Where &lt;dir&gt; is the absolute path name of the directory and
7571                        &lt;name&gt; is the new name for that directory.
7572    </p>
7573    <p>Possible Answers:
7574    </p>
7575    <p>
7576                            </p>
7577    <blockquote class="text">
7578    <p>"OK" -
7579                                    </p>
7580    <blockquote class="text">
7581    <p>on success
7582    </p>
7583    </blockquote>
7584                                
7585    
7586    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7587                                    </p>
7588    <blockquote class="text">
7589    <p>in case the given directory does not exists,
7590                                        or if a directory with name equal to the new
7591                                        name already exists.
7592    </p>
7593    </blockquote>
7594                                
7595    
7596    </blockquote><p>
7597                        
7598    </p>
7599    <p>Example:
7600    </p>
7601    <p>
7602                            </p>
7603    <blockquote class="text">
7604    <p>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"
7605    </p>
7606    <p>S: "OK"
7607    </p>
7608    </blockquote><p>
7609                        
7610    </p>
7611    <a name="MOVE DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7612    <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>
7613    <a name="rfc.section.6.8.7"></a><h3>6.8.7.&nbsp;
7614    Moving an instrument directory</h3>
7615    
7616    <p>The front-end can move a specific
7617                        instrument directory by sending the following command:
7618    </p>
7619    <p>
7620                            </p>
7621    <blockquote class="text">
7622    <p>MOVE DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;
7623    </p>
7624    </blockquote><p>
7625                        
7626    </p>
7627    <p>Where &lt;dir&gt; is the absolute path name of the directory
7628                        to move and &lt;dst&gt; is the location where the directory will
7629                        be moved to.
7630    </p>
7631    <p>Possible Answers:
7632    </p>
7633    <p>
7634                            </p>
7635    <blockquote class="text">
7636    <p>"OK" -
7637                                    </p>
7638    <blockquote class="text">
7639    <p>on success
7640    </p>
7641    </blockquote>
7642                                
7643    
7644    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7645                                    </p>
7646    <blockquote class="text">
7647    <p>in case a given directory does not exists,
7648                                        or if a directory with name equal to the name
7649                                        of the specified directory already exists in
7650                                        the destination directory. Error is also thrown
7651                                        when trying to move a directory to a subdirectory
7652                                        of itself.
7653    </p>
7654    </blockquote>
7655                                
7656    
7657    </blockquote><p>
7658                        
7659    </p>
7660    <p>Example:
7661    </p>
7662    <p>
7663                            </p>
7664    <blockquote class="text">
7665    <p>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"
7666    </p>
7667    <p>S: "OK"
7668    </p>
7669    </blockquote><p>
7670                        
7671    </p>
7672    <a name="COPY DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7673    <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>
7674    <a name="rfc.section.6.8.8"></a><h3>6.8.8.&nbsp;
7675    Copying instrument directories</h3>
7676    
7677    <p>The front-end can copy a specific
7678                        instrument directory by sending the following command:
7679    </p>
7680    <p>
7681                            </p>
7682    <blockquote class="text">
7683    <p>COPY DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;
7684    </p>
7685    </blockquote><p>
7686                        
7687    </p>
7688    <p>Where &lt;dir&gt; is the absolute path name of the directory
7689                        to copy and &lt;dst&gt; is the location where the directory will
7690                        be copied to.
7691    </p>
7692    <p>Possible Answers:
7693    </p>
7694    <p>
7695                            </p>
7696    <blockquote class="text">
7697    <p>"OK" -
7698                                    </p>
7699    <blockquote class="text">
7700    <p>on success
7701    </p>
7702    </blockquote>
7703                                
7704    
7705    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7706                                    </p>
7707    <blockquote class="text">
7708    <p>in case a given directory does not exists,
7709                                        or if a directory with name equal to the name
7710                                        of the specified directory already exists in
7711                                        the destination directory. Error is also thrown
7712                                        when trying to copy a directory to a subdirectory
7713                                        of itself.
7714    </p>
7715    </blockquote>
7716                                
7717    
7718    </blockquote><p>
7719                        
7720    </p>
7721    <p>Example:
7722    </p>
7723    <p>
7724                            </p>
7725    <blockquote class="text">
7726    <p>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"
7727    </p>
7728    <p>S: "OK"
7729    </p>
7730    </blockquote><p>
7731                        
7732    </p>
7733    <a name="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"></a><br /><hr />
7734    <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>
7735    <a name="rfc.section.6.8.9"></a><h3>6.8.9.&nbsp;
7736    Changing the description of directory</h3>
7737    
7738    <p>The front-end can alter the description of a specific
7739                        instrument directory by sending the following command:
7740    </p>
7741    <p>
7742                            </p>
7743    <blockquote class="text">
7744    <p>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION &lt;dir&gt; &lt;desc&gt;
7745    </p>
7746    </blockquote><p>
7747                        
7748    </p>
7749    <p>Where &lt;dir&gt; is the absolute path name of the directory and
7750                        &lt;desc&gt; is the new description for the directory.
7751    </p>
7752    <p>Possible Answers:
7753    </p>
7754    <p>
7755                            </p>
7756    <blockquote class="text">
7757    <p>"OK" -
7758                                    </p>
7759    <blockquote class="text">
7760    <p>on success
7761    </p>
7762    </blockquote>
7763                                
7764    
7765    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7766                                    </p>
7767    <blockquote class="text">
7768    <p>in case the given directory does not exists.
7769    </p>
7770    </blockquote>
7771                                
7772    
7773    </blockquote><p>
7774                        
7775    </p>
7776    <p>Example:
7777    </p>
7778    <p>
7779                            </p>
7780    <blockquote class="text">
7781    <p>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"
7782    </p>
7783    <p>S: "OK"
7784    </p>
7785    </blockquote><p>
7786                        
7787    </p>
7788    <a name="FIND DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
7789    <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>
7790    <a name="rfc.section.6.8.10"></a><h3>6.8.10.&nbsp;
7791    Finding directories</h3>
7792    
7793    <p>The front-end can search for directories
7794                        in specific directory by sending the following command:
7795    </p>
7796    <p>
7797                            </p>
7798    <blockquote class="text">
7799    <p>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;
7800    </p>
7801    </blockquote><p>
7802                        
7803    </p>
7804    <p>Where &lt;dir&gt; should be replaced by the absolute path
7805                        name of the directory to search in. If NON_RECURSIVE is specified, the
7806                        directories located in subdirectories of the specified directory will not
7807                        be searched. &lt;criteria-list&gt; is a list of search criterias
7808                        in form of "key1=val1 key2=val2 ...". The following criterias are
7809                        allowed:
7810    </p>
7811    <p>
7812                          
7813    <p>NAME='&lt;search-string&gt;'
7814                              </p>
7815    <blockquote class="text">
7816    <p>Restricts the search to directories, which names
7817                                  satisfy the supplied search string.
7818    </p>
7819    </blockquote><p>
7820                          
7821    </p>
7822    
7823                          
7824    <p>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
7825                              </p>
7826    <blockquote class="text">
7827    <p>Restricts the search to directories, which creation
7828                                  date satisfies the specified period, where &lt;date-after&gt;
7829                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
7830                                  If &lt;date-after&gt; is omitted the search is restricted to
7831                                  directories created before &lt;date-before&gt;. If
7832                                  &lt;date-before&gt; is omitted, the search is restricted
7833                                  to directories created after &lt;date-after&gt;.
7834    </p>
7835    </blockquote><p>
7836                          
7837    </p>
7838    
7839                          
7840    <p>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
7841                              </p>
7842    <blockquote class="text">
7843    <p>Restricts the search to directories, which
7844                                  date of last modification satisfies the specified period, where
7845                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
7846                                  format. If &lt;date-after&gt; is omitted the search is restricted to
7847                                  directories, which are last modified before &lt;date-before&gt;. If
7848                                  &lt;date-before&gt; is omitted, the search is restricted to directories,
7849                                  which are last modified after &lt;date-after&gt;.
7850    </p>
7851    </blockquote><p>
7852                          
7853    </p>
7854    
7855                          
7856    <p>DESCRIPTION='&lt;search-string&gt;'
7857                              </p>
7858    <blockquote class="text">
7859    <p>Restricts the search to directories with description
7860                                  that satisfies the supplied search string.
7861    </p>
7862    </blockquote><p>
7863                          
7864    </p>
7865                        
7866    
7867    <p>Where &lt;search-string&gt; is either a regular expression, or a
7868                        word list separated with spaces for OR search and with '+' for AND search.
7869    </p>
7870    <p>Possible Answers:
7871    </p>
7872    <p>
7873                            </p>
7874    <blockquote class="text">
7875    <p>A comma separated list with the absolute path names (encapsulated into
7876                                apostrophes) of all directories in the specified directory that satisfy
7877                                the supplied search criterias.
7878    </p>
7879    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7880                                    </p>
7881    <blockquote class="text">
7882    <p>if the given directory does not exist.
7883    </p>
7884    </blockquote>
7885                                
7886    
7887    </blockquote><p>
7888                        
7889    </p>
7890    <p>Example:
7891    </p>
7892    <p>
7893                            </p>
7894    <blockquote class="text">
7895    <p>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"
7896    </p>
7897    <p>S: "'/Piano Collection'"
7898    </p>
7899    </blockquote><p>
7900                        
7901    </p>
7902    <p>
7903                            </p>
7904    <blockquote class="text">
7905    <p>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"
7906    </p>
7907    <p>S: "'/Piano Collection','/Percussions'"
7908    </p>
7909    </blockquote><p>
7910                        
7911    </p>
7912    <a name="ADD DB_INSTRUMENTS"></a><br /><hr />
7913    <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>
7914    <a name="rfc.section.6.8.11"></a><h3>6.8.11.&nbsp;
7915    Adding instruments to the instruments database</h3>
7916    
7917    <p>The front-end can add one or more instruments
7918                        to the instruments database by sending the following command:
7919    </p>
7920    <p>
7921                            </p>
7922    <blockquote class="text">
7923    <p>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]
7924    </p>
7925    </blockquote><p>
7926                        
7927    </p>
7928    <p>Where &lt;db_dir&gt; is the absolute path name of a directory
7929                        (encapsulated into apostrophes) in the instruments database in which
7930                        only the new instruments (that are not already in the database) will
7931                        be added, &lt;file_path&gt; is the absolute path name of a file or
7932                        directory in the file system (encapsulated into apostrophes). In case
7933                        an instrument file is supplied, only the instruments in the specified
7934                        file will be added to the instruments database. If the optional
7935                        &lt;instr_index&gt; (the index of the instrument within the given file)
7936                        is supplied too, then only the specified instrument will be added.
7937                        In case a directory is supplied, the instruments in that directory
7938                        will be added. The OPTIONAL &lt;mode&gt; argument is only applied
7939                        when a directory is provided as &lt;file_path&gt; and specifies how the
7940                        scanning will be done and has exactly the following possibilities:
7941    </p>
7942    <p>
7943                            </p>
7944    <blockquote class="text">
7945    <p>"RECURSIVE" -
7946                                    </p>
7947    <blockquote class="text">
7948    <p>All instruments will be processed, including those
7949                                        in the subdirectories, and the respective subdirectory
7950                                        tree structure will be recreated in the instruments
7951                                        database
7952    </p>
7953    </blockquote>
7954                                
7955    
7956    <p>"NON_RECURSIVE" -
7957                                    </p>
7958    <blockquote class="text">
7959    <p>Only the instruments in the specified directory
7960                                        will be added, the instruments in the subdirectories
7961                                        will not be processed.
7962    </p>
7963    </blockquote>
7964                                
7965    
7966    <p>"FLAT" -
7967                                    </p>
7968    <blockquote class="text">
7969    <p>All instruments will be processed, including those
7970                                        in the subdirectories, but the respective subdirectory
7971                                        structure will not be recreated in the instruments
7972                                        database. All instruments will be added directly in
7973                                        the specified database directory.
7974    </p>
7975    </blockquote>
7976                                
7977    
7978    </blockquote><p>
7979                        
7980    </p>
7981    <p>The difference between regular and NON_MODAL versions of the command
7982                        is that the regular command returns when the scanning is finished
7983                        while NON_MODAL version returns immediately and a background process is launched.
7984                        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>
7985                        command can be used to monitor the scanning progress.
7986    </p>
7987    <p>Possible Answers:
7988    </p>
7989    <p>
7990                            </p>
7991    <blockquote class="text">
7992    <p>"OK" -
7993                                    </p>
7994    <blockquote class="text">
7995    <p>on success when NON_MODAL is not supplied
7996    </p>
7997    </blockquote>
7998                                
7999    
8000    <p>"OK[&lt;job-id&gt;]" -
8001                                    </p>
8002    <blockquote class="text">
8003    <p>on success when NON_MODAL is supplied, where &lt;job-id&gt;
8004                                        is a numerical ID used to obtain status information about the job progress.
8005                                        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>
8006                                        
8007    </p>
8008    </blockquote>
8009                                
8010    
8011    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8012                                    </p>
8013    <blockquote class="text">
8014    <p>if an invalid path is specified.
8015    </p>
8016    </blockquote>
8017                                
8018    
8019    </blockquote><p>
8020                        
8021    </p>
8022    <p>Examples:
8023    </p>
8024    <p>
8025                            </p>
8026    <blockquote class="text">
8027    <p>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"
8028    </p>
8029    <p>S: "OK"
8030    </p>
8031    </blockquote><p>
8032                        
8033    </p>
8034    <a name="REMOVE DB_INSTRUMENT"></a><br /><hr />
8035    <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>
8036    <a name="rfc.section.6.8.12"></a><h3>6.8.12.&nbsp;
8037    Removing an instrument</h3>
8038    
8039    <p>The front-end can remove a particular instrument
8040                        from the instruments database by sending the following command:
8041    </p>
8042    <p>
8043                            </p>
8044    <blockquote class="text">
8045    <p>REMOVE DB_INSTRUMENT &lt;instr_path&gt;
8046    </p>
8047    </blockquote><p>
8048                        
8049    </p>
8050    <p>Where &lt;instr_path&gt; is the absolute path name
8051                        (in the instruments database) of the instrument to remove.
8052    </p>
8053    <p>Possible Answers:
8054    </p>
8055    <p>
8056                            </p>
8057    <blockquote class="text">
8058    <p>"OK" -
8059                                    </p>
8060    <blockquote class="text">
8061    <p>if the instrument is removed successfully
8062    </p>
8063    </blockquote>
8064                                
8065    
8066    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8067                                    </p>
8068    <blockquote class="text">
8069    <p>if the given path does not exist or
8070                                        is a directory.
8071    </p>
8072    </blockquote>
8073                                
8074    
8075    </blockquote><p>
8076                        
8077    </p>
8078    <p>Examples:
8079    </p>
8080    <p>
8081                            </p>
8082    <blockquote class="text">
8083    <p>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"
8084    </p>
8085    <p>S: "OK"
8086    </p>
8087    </blockquote><p>
8088                        
8089    </p>
8090    <a name="GET DB_INSTRUMENTS"></a><br /><hr />
8091    <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>
8092    <a name="rfc.section.6.8.13"></a><h3>6.8.13.&nbsp;
8093    Getting amount of instruments</h3>
8094    
8095    <p>The front-end can retrieve the current amount of
8096                        instruments in a specific directory by sending the following command:
8097    </p>
8098    <p>
8099                            </p>
8100    <blockquote class="text">
8101    <p>GET DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;
8102    </p>
8103    </blockquote><p>
8104                        
8105    </p>
8106    <p>Where &lt;dir&gt; should be replaced by the absolute path name
8107                        of the directory. If RECURSIVE is specified, the number of all
8108                        instruments, including those located in subdirectories of the
8109                        specified directory, will be returned.
8110    </p>
8111    <p>Possible Answers:
8112    </p>
8113    <p>
8114                            </p>
8115    <blockquote class="text">
8116    <p>The current number of instruments
8117                                in the specified directory.
8118    </p>
8119    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8120                                    </p>
8121    <blockquote class="text">
8122    <p>if the given directory does not exist.
8123    </p>
8124    </blockquote>
8125                                
8126    
8127    </blockquote><p>
8128                        
8129    </p>
8130    <p>Example:
8131    </p>
8132    <p>
8133                            </p>
8134    <blockquote class="text">
8135    <p>C: "GET DB_INSTRUMENTS '/Piano Collection'"
8136    </p>
8137    <p>S: "2"
8138    </p>
8139    </blockquote><p>
8140                        
8141    </p>
8142    <a name="LIST DB_INSTRUMENTS"></a><br /><hr />
8143    <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>
8144    <a name="rfc.section.6.8.14"></a><h3>6.8.14.&nbsp;
8145    Listing all instruments in specific directory</h3>
8146    
8147    <p>The front-end can retrieve the current list of instruments
8148                        in specific directory by sending the following command:
8149    </p>
8150    <p>
8151                            </p>
8152    <blockquote class="text">
8153    <p>LIST DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;
8154    </p>
8155    </blockquote><p>
8156                        
8157    </p>
8158    <p>Where &lt;dir&gt; should be replaced by the absolute path
8159                        name of the directory. If RECURSIVE is specified, the absolute path
8160                        names of all instruments, including those located in subdirectories
8161                        of the specified directory, will be returned.
8162    </p>
8163    <p>Possible Answers:
8164    </p>
8165    <p>
8166                            </p>
8167    <blockquote class="text">
8168    <p>A comma separated list of all instruments
8169                                (encapsulated into apostrophes) in the specified directory.
8170    </p>
8171    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8172                                    </p>
8173    <blockquote class="text">
8174    <p>if the given directory does not exist.
8175    </p>
8176    </blockquote>
8177                                
8178    
8179    </blockquote><p>
8180                        
8181    </p>
8182    <p>Example:
8183    </p>
8184    <p>
8185                            </p>
8186    <blockquote class="text">
8187    <p>C: "LIST DB_INSTRUMENTS '/Piano Collection'"
8188    </p>
8189    <p>S: "'Bosendorfer 290','Steinway D'"
8190    </p>
8191    </blockquote><p>
8192                        
8193    </p>
8194    <p>
8195                            </p>
8196    <blockquote class="text">
8197    <p>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"
8198    </p>
8199    <p>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"
8200    </p>
8201    </blockquote><p>
8202                        
8203    </p>
8204    <a name="GET DB_INSTRUMENT INFO"></a><br /><hr />
8205    <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>
8206    <a name="rfc.section.6.8.15"></a><h3>6.8.15.&nbsp;
8207    Getting instrument information</h3>
8208    
8209    <p>The front-end can ask for the current settings of an
8210                        instrument by sending the following command:
8211    </p>
8212    <p>
8213                            </p>
8214    <blockquote class="text">
8215    <p>GET DB_INSTRUMENT INFO &lt;instr_path&gt;
8216    </p>
8217    </blockquote><p>
8218                        
8219    </p>
8220    <p>Where &lt;instr_path&gt; should be replaced by the absolute path
8221                        name of the instrument the front-end is interested in.
8222    </p>
8223    <p>Possible Answers:
8224    </p>
8225    <p>
8226                            </p>
8227    <blockquote class="text">
8228    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
8229                                Each answer line begins with the settings category name
8230                                followed by a colon and then a space character &lt;SP&gt; and finally
8231                                the info character string to that setting category. At the
8232                                moment the following categories are defined:
8233    </p>
8234    <p>
8235                                    </p>
8236    <blockquote class="text">
8237    <p>INSTRUMENT_FILE -
8238                                            </p>
8239    <blockquote class="text">
8240    <p>File name of the instrument.
8241    </p>
8242    </blockquote>
8243                                        
8244    
8245    <p>INSTRUMENT_NR -
8246                                            </p>
8247    <blockquote class="text">
8248    <p>Index of the instrument within the file.
8249    </p>
8250    </blockquote>
8251                                        
8252    
8253    <p>FORMAT_FAMILY -
8254                                            </p>
8255    <blockquote class="text">
8256    <p>The format family of the instrument.
8257    </p>
8258    </blockquote>
8259                                        
8260    
8261    <p>FORMAT_VERSION -
8262                                            </p>
8263    <blockquote class="text">
8264    <p>The format version of the instrument.
8265    </p>
8266    </blockquote>
8267                                        
8268    
8269    <p>SIZE -
8270                                            </p>
8271    <blockquote class="text">
8272    <p>The size of the instrument in bytes.
8273    </p>
8274    </blockquote>
8275                                        
8276    
8277    <p>CREATED -
8278                                            </p>
8279    <blockquote class="text">
8280    <p>The date and time when the instrument is added
8281                                                in the instruments database, represented in
8282                                               "YYYY-MM-DD HH:MM:SS" format
8283    </p>
8284    </blockquote>
8285                                        
8286    
8287    <p>MODIFIED -
8288                                            </p>
8289    <blockquote class="text">
8290    <p>The date and time of the last modification of the
8291                                                instrument's database settings, represented in
8292                                                "YYYY-MM-DD HH:MM:SS" format
8293    </p>
8294    </blockquote>
8295                                        
8296    
8297    <p>DESCRIPTION -
8298                                            </p>
8299    <blockquote class="text">
8300    <p>A brief description of the instrument
8301    </p>
8302    </blockquote>
8303                                        
8304    
8305    <p>IS_DRUM -
8306                                            </p>
8307    <blockquote class="text">
8308    <p>either true or false, determines whether the
8309                                                instrument is a drumkit or a chromatic instrument
8310    </p>
8311    </blockquote>
8312                                        
8313    
8314    <p>PRODUCT -
8315                                            </p>
8316    <blockquote class="text">
8317    <p>The product title of the instrument
8318    </p>
8319    </blockquote>
8320                                        
8321    
8322    <p>ARTISTS -
8323                                            </p>
8324    <blockquote class="text">
8325    <p>Lists the artist names
8326    </p>
8327    </blockquote>
8328                                        
8329    
8330    <p>KEYWORDS -
8331                                            </p>
8332    <blockquote class="text">
8333    <p>Provides a list of keywords that refer to the instrument.
8334                                                Keywords are separated with semicolon and blank.
8335    </p>
8336    </blockquote>
8337                                        
8338    
8339    </blockquote>
8340                                
8341    
8342    </blockquote><p>
8343                        
8344    </p>
8345    <p>The mentioned fields above don't have to be in particular order.
8346    </p>
8347    <p>Example:
8348    </p>
8349    <p>
8350                            </p>
8351    <blockquote class="text">
8352    <p>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"
8353    </p>
8354    <p>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"
8355    </p>
8356    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"
8357    </p>
8358    <p>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"
8359    </p>
8360    <p>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 2"
8361    </p>
8362    <p>&nbsp;&nbsp;&nbsp;"SIZE: 2050871870"
8363    </p>
8364    <p>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"
8365    </p>
8366    <p>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"
8367    </p>
8368    <p>&nbsp;&nbsp;&nbsp;"DESCRIPTION: "
8369    </p>
8370    <p>&nbsp;&nbsp;&nbsp;"IS_DRUM: false"
8371    </p>
8372    <p>&nbsp;&nbsp;&nbsp;"PRODUCT: GRANDIOSO Bosendorfer 290"
8373    </p>
8374    <p>&nbsp;&nbsp;&nbsp;"ARTISTS: Post Musical Instruments"
8375    </p>
8376    <p>&nbsp;&nbsp;&nbsp;"KEYWORDS: Bosendorfer"
8377    </p>
8378    <p>&nbsp;&nbsp;&nbsp;"."
8379    </p>
8380    </blockquote><p>
8381                        
8382    </p>
8383    <a name="SET DB_INSTRUMENT NAME"></a><br /><hr />
8384    <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>
8385    <a name="rfc.section.6.8.16"></a><h3>6.8.16.&nbsp;
8386    Renaming an instrument</h3>
8387    
8388    <p>The front-end can alter the name of a specific
8389                        instrument by sending the following command:
8390    </p>
8391    <p>
8392                            </p>
8393    <blockquote class="text">
8394    <p>SET DB_INSTRUMENT NAME &lt;instr&gt; &lt;name&gt;
8395    </p>
8396    </blockquote><p>
8397                        
8398    </p>
8399    <p>Where &lt;instr&gt; is the absolute path name of the instrument and
8400                        &lt;name&gt; is the new name for that instrument.
8401    </p>
8402    <p>Possible Answers:
8403    </p>
8404    <p>
8405                            </p>
8406    <blockquote class="text">
8407    <p>"OK" -
8408                                    </p>
8409    <blockquote class="text">
8410    <p>on success
8411    </p>
8412    </blockquote>
8413                                
8414    
8415    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8416                                    </p>
8417    <blockquote class="text">
8418    <p>in case the given instrument does not exists,
8419                                        or if an instrument with name equal to the new
8420                                        name already exists.
8421    </p>
8422    </blockquote>
8423                                
8424    
8425    </blockquote><p>
8426                        
8427    </p>
8428    <p>Example:
8429    </p>
8430    <p>
8431                            </p>
8432    <blockquote class="text">
8433    <p>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"
8434    </p>
8435    <p>S: "OK"
8436    </p>
8437    </blockquote><p>
8438                        
8439    </p>
8440    <a name="MOVE DB_INSTRUMENT"></a><br /><hr />
8441    <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>
8442    <a name="rfc.section.6.8.17"></a><h3>6.8.17.&nbsp;
8443    Moving an instrument</h3>
8444    
8445    <p>The front-end can move a specific instrument to another directory by
8446                        sending the following command:
8447    </p>
8448    <p>
8449                            </p>
8450    <blockquote class="text">
8451    <p>MOVE DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;
8452    </p>
8453    </blockquote><p>
8454                        
8455    </p>
8456    <p>Where &lt;instr&gt; is the absolute path name of the instrument
8457                        to move and &lt;dst&gt; is the directory where the instrument will
8458                        be moved to.
8459    </p>
8460    <p>Possible Answers:
8461    </p>
8462    <p>
8463                            </p>
8464    <blockquote class="text">
8465    <p>"OK" -
8466                                    </p>
8467    <blockquote class="text">
8468    <p>on success
8469    </p>
8470    </blockquote>
8471                                
8472    
8473    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8474                                    </p>
8475    <blockquote class="text">
8476    <p>in case the given instrument does not exists,
8477                                        or if an instrument with name equal to the name of the
8478                                        specified instrument already exists in the destination
8479                                        directory.
8480    </p>
8481    </blockquote>
8482                                
8483    
8484    </blockquote><p>
8485                        
8486    </p>
8487    <p>Example:
8488    </p>
8489    <p>
8490                            </p>
8491    <blockquote class="text">
8492    <p>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"
8493    </p>
8494    <p>S: "OK"
8495    </p>
8496    </blockquote><p>
8497                        
8498    </p>
8499    <a name="COPY DB_INSTRUMENT"></a><br /><hr />
8500    <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>
8501    <a name="rfc.section.6.8.18"></a><h3>6.8.18.&nbsp;
8502    Copying instruments</h3>
8503    
8504    <p>The front-end can copy a specific instrument to another directory by
8505                        sending the following command:
8506    </p>
8507    <p>
8508                            </p>
8509    <blockquote class="text">
8510    <p>COPY DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;
8511    </p>
8512    </blockquote><p>
8513                        
8514    </p>
8515    <p>Where &lt;instr&gt; is the absolute path name of the instrument
8516                        to copy and &lt;dst&gt; is the directory where the instrument will
8517                        be copied to.
8518    </p>
8519    <p>Possible Answers:
8520    </p>
8521    <p>
8522                            </p>
8523    <blockquote class="text">
8524    <p>"OK" -
8525                                    </p>
8526    <blockquote class="text">
8527    <p>on success
8528    </p>
8529    </blockquote>
8530                                
8531    
8532    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8533                                    </p>
8534    <blockquote class="text">
8535    <p>in case the given instrument does not exists,
8536                                        or if an instrument with name equal to the name of the
8537                                        specified instrument already exists in the destination
8538                                        directory.
8539    </p>
8540    </blockquote>
8541                                
8542    
8543    </blockquote><p>
8544                        
8545    </p>
8546    <p>Example:
8547    </p>
8548    <p>
8549                            </p>
8550    <blockquote class="text">
8551    <p>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"
8552    </p>
8553    <p>S: "OK"
8554    </p>
8555    </blockquote><p>
8556                        
8557    </p>
8558    <a name="SET DB_INSTRUMENT DESCRIPTION"></a><br /><hr />
8559    <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>
8560    <a name="rfc.section.6.8.19"></a><h3>6.8.19.&nbsp;
8561    Changing the description of instrument</h3>
8562    
8563    <p>The front-end can alter the description of a specific
8564                        instrument by sending the following command:
8565    </p>
8566    <p>
8567                            </p>
8568    <blockquote class="text">
8569    <p>SET DB_INSTRUMENT DESCRIPTION &lt;instr&gt; &lt;desc&gt;
8570    </p>
8571    </blockquote><p>
8572                        
8573    </p>
8574    <p>Where &lt;instr&gt; is the absolute path name of the instrument and
8575                        &lt;desc&gt; is the new description for the instrument.
8576    </p>
8577    <p>Possible Answers:
8578    </p>
8579    <p>
8580                            </p>
8581    <blockquote class="text">
8582    <p>"OK" -
8583                                    </p>
8584    <blockquote class="text">
8585    <p>on success
8586    </p>
8587    </blockquote>
8588                                
8589    
8590    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8591                                    </p>
8592    <blockquote class="text">
8593    <p>in case the given instrument does not exists.
8594    </p>
8595    </blockquote>
8596                                
8597    
8598    </blockquote><p>
8599                        
8600    </p>
8601    <p>Example:
8602    </p>
8603    <p>
8604                            </p>
8605    <blockquote class="text">
8606    <p>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"
8607    </p>
8608    <p>S: "OK"
8609    </p>
8610    </blockquote><p>
8611                        
8612    </p>
8613    <a name="FIND DB_INSTRUMENTS"></a><br /><hr />
8614    <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>
8615    <a name="rfc.section.6.8.20"></a><h3>6.8.20.&nbsp;
8616    Finding instruments</h3>
8617    
8618    <p>The front-end can search for instruments
8619                        in specific directory by sending the following command:
8620    </p>
8621    <p>
8622                            </p>
8623    <blockquote class="text">
8624    <p>FIND DB_INSTRUMENTS [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;
8625    </p>
8626    </blockquote><p>
8627                        
8628    </p>
8629    <p>Where &lt;dir&gt; should be replaced by the absolute path
8630                        name of the directory to search in. If NON_RECURSIVE is specified, the
8631                        directories located in subdirectories of the specified directory will not
8632                        be searched. &lt;criteria-list&gt; is a list of search criterias
8633                        in form of "key1=val1 key2=val2 ...". The following criterias are
8634                        allowed:
8635    </p>
8636    <p>
8637                          
8638    <p>NAME='&lt;search-string&gt;'
8639                              </p>
8640    <blockquote class="text">
8641    <p>Restricts the search to instruments, which names
8642                                  satisfy the supplied search string.
8643    </p>
8644    </blockquote><p>
8645                          
8646    </p>
8647    
8648                          
8649    <p>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
8650                              </p>
8651    <blockquote class="text">
8652    <p>Restricts the search to instruments, which
8653                                  size is in the specified range. If &lt;min&gt; is omitted,
8654                                  the search results are restricted to instruments with size less then
8655                                  or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
8656                                  search is restricted to instruments with size greater then
8657                                  or equal to &lt;min&gt;.
8658    </p>
8659    </blockquote><p>
8660                          
8661    </p>
8662    
8663                          
8664    <p>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
8665                              </p>
8666    <blockquote class="text">
8667    <p>Restricts the search to instruments, which creation
8668                                  date satisfies the specified period, where &lt;date-after&gt;
8669                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
8670                                  If &lt;date-after&gt; is omitted the search is restricted to
8671                                  instruments created before &lt;date-before&gt;. If
8672                                  &lt;date-before&gt; is omitted, the search is restricted
8673                                  to instruments created after &lt;date-after&gt;.
8674    </p>
8675    </blockquote><p>
8676                          
8677    </p>
8678    
8679                          
8680    <p>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
8681                              </p>
8682    <blockquote class="text">
8683    <p>Restricts the search to instruments, which
8684                                  date of last modification satisfies the specified period, where
8685                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
8686                                  format. If &lt;date-after&gt; is omitted the search is restricted to
8687                                  instruments, which are last modified before &lt;date-before&gt;. If
8688                                  &lt;date-before&gt; is omitted, the search is restricted to instruments,
8689                                  which are last modified after &lt;date-after&gt;.
8690    </p>
8691    </blockquote><p>
8692                          
8693    </p>
8694    
8695                          
8696    <p>DESCRIPTION='&lt;search-string&gt;'
8697                              </p>
8698    <blockquote class="text">
8699    <p>Restricts the search to instruments with description
8700                                  that satisfies the supplied search string.
8701    </p>
8702    </blockquote><p>
8703                          
8704    </p>
8705    
8706                          
8707    <p>PRODUCT='&lt;search-string&gt;'
8708                              </p>
8709    <blockquote class="text">
8710    <p>Restricts the search to instruments with product info
8711                                  that satisfies the supplied search string.
8712    </p>
8713    </blockquote><p>
8714                          
8715    </p>
8716    
8717                          
8718    <p>ARTISTS='&lt;search-string&gt;'
8719                              </p>
8720    <blockquote class="text">
8721    <p>Restricts the search to instruments with artists info
8722                                  that satisfies the supplied search string.
8723    </p>
8724    </blockquote><p>
8725                          
8726    </p>
8727    
8728                          
8729    <p>KEYWORDS='&lt;search-string&gt;'
8730                              </p>
8731    <blockquote class="text">
8732    <p>Restricts the search to instruments with keyword list
8733                                  that satisfies the supplied search string.
8734    </p>
8735    </blockquote><p>
8736                          
8737    </p>
8738    
8739                          
8740    <p>IS_DRUM=true | false
8741                              </p>
8742    <blockquote class="text">
8743    <p>Either true or false. Restricts the search to
8744                                  drum kits or chromatic instruments.
8745    </p>
8746    </blockquote><p>
8747                          
8748    </p>
8749    
8750                          
8751    <p>FORMAT_FAMILIES='&lt;format-list&gt;'
8752                              </p>
8753    <blockquote class="text">
8754    <p>Restricts the search to instruments of the supplied format families,
8755                                  where &lt;format-list&gt; is a comma separated list of format families.
8756    </p>
8757    </blockquote><p>
8758                          
8759    </p>
8760                        
8761    
8762    <p>Where &lt;search-string&gt; is either a regular expression, or a
8763                        word list separated with spaces for OR search and with '+' for AND search.
8764    </p>
8765    <p>Possible Answers:
8766    </p>
8767    <p>
8768                            </p>
8769    <blockquote class="text">
8770    <p>A comma separated list with the absolute path names (encapsulated into
8771                                apostrophes) of all instruments in the specified directory that satisfy
8772                                the supplied search criterias.
8773    </p>
8774    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8775                                    </p>
8776    <blockquote class="text">
8777    <p>if the given directory does not exist.
8778    </p>
8779    </blockquote>
8780                                
8781    
8782    </blockquote><p>
8783                        
8784    </p>
8785    <p>Example:
8786    </p>
8787    <p>
8788                            </p>
8789    <blockquote class="text">
8790    <p>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"
8791    </p>
8792    <p>S: "'/Piano Collection/Bosendorfer 290'"
8793    </p>
8794    </blockquote><p>
8795                        
8796    </p>
8797    <p>
8798                            </p>
8799    <blockquote class="text">
8800    <p>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"
8801    </p>
8802    <p>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"
8803    </p>
8804    </blockquote><p>
8805                        
8806    </p>
8807    <a name="GET DB_INSTRUMENTS_JOB INFO"></a><br /><hr />
8808    <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>
8809    <a name="rfc.section.6.8.21"></a><h3>6.8.21.&nbsp;
8810    Getting job status information</h3>
8811    
8812    <p>The front-end can ask for the current status of a
8813                        particular database instruments job by sending the following command:
8814    </p>
8815    <p>
8816                            </p>
8817    <blockquote class="text">
8818    <p>GET DB_INSTRUMENTS_JOB INFO &lt;job-id&gt;
8819    </p>
8820    </blockquote><p>
8821                        
8822    </p>
8823    <p>Where &lt;job-id&gt; should be replaced by the numerical ID
8824                        of the job the front-end is interested in.
8825    </p>
8826    <p>Possible Answers:
8827    </p>
8828    <p>
8829                            </p>
8830    <blockquote class="text">
8831    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
8832                                Each answer line begins with the settings category name
8833                                followed by a colon and then a space character &lt;SP&gt; and finally
8834                                the info character string to that setting category. At the
8835                                moment the following categories are defined:
8836    </p>
8837    <p>
8838                                    </p>
8839    <blockquote class="text">
8840    <p>FILES_TOTAL -
8841                                            </p>
8842    <blockquote class="text">
8843    <p>The total number of files scheduled for scanning
8844    </p>
8845    </blockquote>
8846                                        
8847    
8848    <p>FILES_SCANNED -
8849                                            </p>
8850    <blockquote class="text">
8851    <p>The current number of scanned files
8852    </p>
8853    </blockquote>
8854                                        
8855    
8856    <p>SCANNING -
8857                                            </p>
8858    <blockquote class="text">
8859    <p>The absolute path name of the file which is currently
8860                                                being scanned
8861    </p>
8862    </blockquote>
8863                                        
8864    
8865    <p>STATUS -
8866                                            </p>
8867    <blockquote class="text">
8868    <p>An integer value between 0 and 100 indicating the
8869                                                scanning progress percentage of the file which is
8870                                                currently being scanned
8871    </p>
8872    </blockquote>
8873                                        
8874    
8875    </blockquote>
8876                                
8877    
8878    </blockquote><p>
8879                        
8880    </p>
8881    <p>The mentioned fields above don't have to be in particular order.
8882    </p>
8883    <p>Example:
8884    </p>
8885    <p>
8886                            </p>
8887    <blockquote class="text">
8888    <p>C: "GET DB_INSTRUMENTS_JOB INFO 2"
8889    </p>
8890    <p>S: "FILES_TOTAL: 12"
8891    </p>
8892    <p>&nbsp;&nbsp;&nbsp;"FILES_SCANNED: 7"
8893    </p>
8894    <p>&nbsp;&nbsp;&nbsp;"SCANNING: /home/me/gigs/Bosendorfer 290.gig"
8895    </p>
8896    <p>&nbsp;&nbsp;&nbsp;"STATUS: 42"
8897    </p>
8898    <p>&nbsp;&nbsp;&nbsp;"."
8899    </p>
8900    </blockquote><p>
8901                        
8902    </p>
8903  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
8904  <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>
8905  <a name="rfc.section.7"></a><h3>7.&nbsp;  <a name="rfc.section.7"></a><h3>7.&nbsp;
# Line 7266  Command Syntax</h3> Line 9000  Command Syntax</h3>
9000  <p>/ UNSUBSCRIBE SP unsubscribe_event  <p>/ UNSUBSCRIBE SP unsubscribe_event
9001                                    
9002  </p>  </p>
 <p>/ SELECT SP text  
                   
 </p>  
9003  <p>/ RESET SP reset_instruction  <p>/ RESET SP reset_instruction
9004                                    
9005  </p>  </p>
9006  <p>/ CLEAR SP clear_instruction  <p>/ CLEAR SP clear_instruction
9007                                    
9008  </p>  </p>
9009    <p>/ FIND SP find_instruction
9010                    
9011    </p>
9012    <p>/ MOVE SP move_instruction
9013                    
9014    </p>
9015    <p>/ COPY SP copy_instruction
9016                    
9017    </p>
9018  <p>/ RESET  <p>/ RESET
9019                                    
9020  </p>  </p>
# Line 7290  Command Syntax</h3> Line 9030  Command Syntax</h3>
9030  <p>CHANNEL  <p>CHANNEL
9031                                    
9032  </p>  </p>
9033    <p>/ DB_INSTRUMENT_DIRECTORY SP pathname
9034                    
9035    </p>
9036    <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP pathname SP pathname
9037                    
9038    </p>
9039    <p>/ DB_INSTRUMENTS SP scan_mode SP pathname SP pathname
9040                    
9041    </p>
9042    <p>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname
9043                    
9044    </p>
9045    <p>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP instrument_index
9046                    
9047    </p>
9048    <p>/ DB_INSTRUMENTS SP pathname SP pathname
9049                    
9050    </p>
9051    <p>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index
9052                    
9053    </p>
9054  <p>/ MIDI_INSTRUMENT_MAP  <p>/ MIDI_INSTRUMENT_MAP
9055                                    
9056  </p>  </p>
# Line 7347  Command Syntax</h3> Line 9108  Command Syntax</h3>
9108  <p>/ MIDI_INSTRUMENT_INFO  <p>/ MIDI_INSTRUMENT_INFO
9109                                    
9110  </p>  </p>
9111    <p>/ DB_INSTRUMENT_DIRECTORY_COUNT
9112                    
9113    </p>
9114    <p>/ DB_INSTRUMENT_DIRECTORY_INFO
9115                    
9116    </p>
9117    <p>/ DB_INSTRUMENT_COUNT
9118                    
9119    </p>
9120    <p>/ DB_INSTRUMENT_INFO
9121                    
9122    </p>
9123    <p>/ DB_INSTRUMENTS_JOB_INFO
9124                    
9125    </p>
9126  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
9127                                    
9128  </p>  </p>
# Line 7407  Command Syntax</h3> Line 9183  Command Syntax</h3>
9183  <p>/ MIDI_INSTRUMENT_INFO  <p>/ MIDI_INSTRUMENT_INFO
9184                                    
9185  </p>  </p>
9186    <p>/ DB_INSTRUMENT_DIRECTORY_COUNT
9187                    
9188    </p>
9189    <p>/ DB_INSTRUMENT_DIRECTORY_INFO
9190                    
9191    </p>
9192    <p>/ DB_INSTRUMENT_COUNT
9193                    
9194    </p>
9195    <p>/ DB_INSTRUMENT_INFO
9196                    
9197    </p>
9198    <p>/ DB_INSTRUMENTS_JOB_INFO
9199                    
9200    </p>
9201  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
9202                                    
9203  </p>  </p>
# Line 7458  Command Syntax</h3> Line 9249  Command Syntax</h3>
9249  <p>/ MIDI_INSTRUMENT_MAP SP ALL  <p>/ MIDI_INSTRUMENT_MAP SP ALL
9250                                    
9251  </p>  </p>
9252    <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname
9253                    
9254    </p>
9255    <p>/ DB_INSTRUMENT_DIRECTORY SP pathname
9256                    
9257    </p>
9258    <p>/ DB_INSTRUMENT SP pathname
9259                    
9260    </p>
9261  </blockquote><p>  </blockquote><p>
9262    
9263  </p>  </p>
# Line 7563  Command Syntax</h3> Line 9363  Command Syntax</h3>
9363  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
9364                                    
9365  </p>  </p>
9366    <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
9367                    
9368    </p>
9369    <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname
9370                    
9371    </p>
9372    <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
9373                    
9374    </p>
9375    <p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname
9376                    
9377    </p>
9378    <p>/ DB_INSTRUMENTS SP pathname
9379                    
9380    </p>
9381    <p>/ DB_INSTRUMENT SP INFO SP pathname
9382                    
9383    </p>
9384    <p>/ DB_INSTRUMENTS_JOB SP INFO SP number
9385                    
9386    </p>
9387  <p>/ VOLUME  <p>/ VOLUME
9388                                    
9389  </p>  </p>
# Line 7602  Command Syntax</h3> Line 9423  Command Syntax</h3>
9423  <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
9424                                    
9425  </p>  </p>
9426    <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname
9427                    
9428    </p>
9429    <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval
9430                    
9431    </p>
9432    <p>/ DB_INSTRUMENT SP NAME SP pathname SP dirname
9433                    
9434    </p>
9435    <p>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval
9436                    
9437    </p>
9438  <p>/ ECHO SP boolean  <p>/ ECHO SP boolean
9439                                    
9440  </p>  </p>
# Line 7656  Command Syntax</h3> Line 9489  Command Syntax</h3>
9489  </blockquote><p>  </blockquote><p>
9490    
9491  </p>  </p>
9492    <p>find_instruction =
9493            </p>
9494    <blockquote class="text">
9495    <p>DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list
9496                    
9497    </p>
9498    <p>/ DB_INSTRUMENTS SP pathname SP query_val_list
9499                    
9500    </p>
9501    <p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP query_val_list
9502                    
9503    </p>
9504    <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list
9505                    
9506    </p>
9507    </blockquote><p>
9508    
9509    </p>
9510    <p>move_instruction =
9511            </p>
9512    <blockquote class="text">
9513    <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
9514                    
9515    </p>
9516    <p>/ DB_INSTRUMENT SP pathname SP pathname
9517                    
9518    </p>
9519    </blockquote><p>
9520    
9521    </p>
9522    <p>copy_instruction =
9523            </p>
9524    <blockquote class="text">
9525    <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
9526                    
9527    </p>
9528    <p>/ DB_INSTRUMENT SP pathname SP pathname
9529                    
9530    </p>
9531    </blockquote><p>
9532    
9533    </p>
9534  <p>destroy_instruction =  <p>destroy_instruction =
9535          </p>          </p>
9536  <blockquote class="text">  <blockquote class="text">
# Line 7800  Command Syntax</h3> Line 9675  Command Syntax</h3>
9675  <p>/ FX_SENDS SP sampler_channel  <p>/ FX_SENDS SP sampler_channel
9676                                    
9677  </p>  </p>
9678    <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
9679                    
9680    </p>
9681    <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname
9682                    
9683    </p>
9684    <p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname
9685                    
9686    </p>
9687    <p>/ DB_INSTRUMENTS SP pathname
9688                    
9689    </p>
9690  </blockquote><p>  </blockquote><p>
9691    
9692  </p>  </p>
# Line 7980  Command Syntax</h3> Line 9867  Command Syntax</h3>
9867  </blockquote><p>  </blockquote><p>
9868    
9869  </p>  </p>
9870    <p>pathname =
9871            </p>
9872    <blockquote class="text">
9873    <p>stringval
9874                    
9875    </p>
9876    </blockquote><p>
9877    
9878    </p>
9879    <p>dirname =
9880            </p>
9881    <blockquote class="text">
9882    <p>stringval
9883                    
9884    </p>
9885    </blockquote><p>
9886    
9887    </p>
9888  <p>filename =  <p>filename =
9889          </p>          </p>
9890  <blockquote class="text">  <blockquote class="text">
# Line 8046  Command Syntax</h3> Line 9951  Command Syntax</h3>
9951  </blockquote><p>  </blockquote><p>
9952    
9953  </p>  </p>
9954    <p>query_val_list =
9955            </p>
9956    <blockquote class="text">
9957    <p>string '=' query_val
9958                    
9959    </p>
9960    <p>/ query_val_list SP string '=' query_val
9961                    
9962    </p>
9963    </blockquote><p>
9964    
9965    </p>
9966    <p>query_val =
9967            </p>
9968    <blockquote class="text">
9969    <p>string
9970                    
9971    </p>
9972    <p>/ stringval
9973                    
9974    </p>
9975    </blockquote><p>
9976    
9977    </p>
9978    <p>scan_mode =
9979            </p>
9980    <blockquote class="text">
9981    <p>RECURSIVE
9982                    
9983    </p>
9984    <p>/ NON_RECURSIVE
9985                    
9986    </p>
9987    <p>/ FLAT
9988                    
9989    </p>
9990    </blockquote><p>
9991    
9992    </p>
9993  <a name="events"></a><br /><hr />  <a name="events"></a><br /><hr />
9994  <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>
9995  <a name="rfc.section.8"></a><h3>8.&nbsp;  <a name="rfc.section.8"></a><h3>8.&nbsp;
# Line 8574  Global settings changed</h3> Line 10518  Global settings changed</h3>
10518  </blockquote><p>  </blockquote><p>
10519                                    
10520  </p>  </p>
10521  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />
10522  <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>
10523  <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;  <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;
10524    Number of database instrument directories changed</h3>
10525    
10526    <p>Client may want to be notified when the number of instrument
10527                    directories in a particular directory in the instruments database
10528                    is changed by issuing the following command:
10529    </p>
10530    <p>
10531                        </p>
10532    <blockquote class="text">
10533    <p>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT
10534    </p>
10535    </blockquote><p>
10536                    
10537    </p>
10538    <p>Server will start sending the following notification messages:
10539    </p>
10540    <p>
10541                        </p>
10542    <blockquote class="text">
10543    <p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:&lt;dir-path&gt;"
10544    </p>
10545    </blockquote><p>
10546                    
10547    </p>
10548    <p>where &lt;dir-path&gt; will be replaced by the absolute path
10549                    name of the directory in the instruments database,
10550                    in which the number of directories is changed.
10551    </p>
10552    <p>Note that when a non-empty directory is removed, this event
10553                    is not sent for the subdirectories in that directory.
10554    </p>
10555    <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr />
10556    <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>
10557    <a name="rfc.section.8.19"></a><h3>8.19.&nbsp;
10558    Database instrument directory information changed</h3>
10559    
10560    <p>Client may want to be notified when changes were made to directories
10561                    in the instruments database by issuing the following command:
10562    </p>
10563    <p>
10564                        </p>
10565    <blockquote class="text">
10566    <p>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
10567    </p>
10568    </blockquote><p>
10569                    
10570    </p>
10571    <p>Server will start sending the following notification messages:
10572    </p>
10573    <p>
10574                        </p>
10575    <blockquote class="text">
10576    <p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:&lt;dir-path&gt;"
10577    </p>
10578    </blockquote><p>
10579                    
10580    </p>
10581    <p>where &lt;dir-path&gt; will be replaced by the absolute path name
10582                    of the directory, for which information changes occurred. The front-end will have to send
10583                    the respective command to actually get the updated directory info. Because these messages
10584                    will be triggered by LSCP commands issued by other clients rather than real
10585                    time events happening on the server, it is believed that an empty notification
10586                    message is sufficient here.
10587    </p>
10588    <p>
10589                        </p>
10590    <blockquote class="text">
10591    <p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME &lt;old-dir-path&gt; &lt;new-name&gt;"
10592    </p>
10593    </blockquote><p>
10594                    
10595    </p>
10596    <p>where &lt;old-dir-path&gt; is the old absolute path name of the directory
10597                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
10598                    the new name of the directory, encapsulated into apostrophes.
10599    </p>
10600    <a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr />
10601    <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>
10602    <a name="rfc.section.8.20"></a><h3>8.20.&nbsp;
10603    Number of database instruments changed</h3>
10604    
10605    <p>Client may want to be notified when the number of instruments
10606                    in a particular directory in the instruments database
10607                    is changed by issuing the following command:
10608    </p>
10609    <p>
10610                        </p>
10611    <blockquote class="text">
10612    <p>SUBSCRIBE DB_INSTRUMENT_COUNT
10613    </p>
10614    </blockquote><p>
10615                    
10616    </p>
10617    <p>Server will start sending the following notification messages:
10618    </p>
10619    <p>
10620                        </p>
10621    <blockquote class="text">
10622    <p>"NOTIFY:DB_INSTRUMENT_COUNT:&lt;dir-path&gt;"
10623    </p>
10624    </blockquote><p>
10625                    
10626    </p>
10627    <p>where &lt;dir-path&gt; will be replaced by the absolute path
10628                    name of the directory in the instruments database,
10629                    in which the number of instruments is changed.
10630    </p>
10631    <p>Note that when a non-empty directory is removed, this event
10632                    is not sent for the instruments in that directory.
10633    </p>
10634    <a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr />
10635    <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>
10636    <a name="rfc.section.8.21"></a><h3>8.21.&nbsp;
10637    Database instrument information changed</h3>
10638    
10639    <p>Client may want to be notified when changes were made to instruments
10640                    in the instruments database by issuing the following command:
10641    </p>
10642    <p>
10643                        </p>
10644    <blockquote class="text">
10645    <p>SUBSCRIBE DB_INSTRUMENT_INFO
10646    </p>
10647    </blockquote><p>
10648                    
10649    </p>
10650    <p>Server will start sending the following notification messages:
10651    </p>
10652    <p>
10653                        </p>
10654    <blockquote class="text">
10655    <p>"NOTIFY:DB_INSTRUMENT_INFO:&lt;instr-path&gt;"
10656    </p>
10657    </blockquote><p>
10658                    
10659    </p>
10660    <p>where &lt;instr-path&gt; will be replaced by the absolute path name
10661                    of the instrument, which settings are changed. The front-end will have to send
10662                    the respective command to actually get the updated directory info. Because these messages
10663                    will be triggered by LSCP commands issued by other clients rather than real
10664                    time events happening on the server, it is believed that an empty notification
10665                    message is sufficient here.
10666    </p>
10667    <p>
10668                        </p>
10669    <blockquote class="text">
10670    <p>"NOTIFY:DB_INSTRUMENT_INFO:NAME &lt;old-instr-path&gt; &lt;new-name&gt;"
10671    </p>
10672    </blockquote><p>
10673                    
10674    </p>
10675    <p>where &lt;old-instr-path&gt; is the old absolute path name of the instrument
10676                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
10677                    the new name of the instrument, encapsulated into apostrophes.
10678    </p>
10679    <a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr />
10680    <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>
10681    <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;
10682    Database job status information changed</h3>
10683    
10684    <p>Client may want to be notified when the status of particular database
10685                    instruments job is changed by issuing the following command:
10686    </p>
10687    <p>
10688                        </p>
10689    <blockquote class="text">
10690    <p>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO
10691    </p>
10692    </blockquote><p>
10693                    
10694    </p>
10695    <p>Server will start sending the following notification messages:
10696    </p>
10697    <p>
10698                        </p>
10699    <blockquote class="text">
10700    <p>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:&lt;job-id&gt;"
10701    </p>
10702    </blockquote><p>
10703                    
10704    </p>
10705    <p>where &lt;job-id&gt; will be replaced by the numerical ID of the job,
10706                    which status is changed. The front-end will have to send the respective
10707                    command to actually get the status info. Because these messages
10708                    will be triggered by LSCP commands issued by other clients rather than real
10709                    time events happening on the server, it is believed that an empty notification
10710                    message is sufficient here.
10711    </p>
10712    <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
10713    <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>
10714    <a name="rfc.section.8.23"></a><h3>8.23.&nbsp;
10715  Miscellaneous and debugging events</h3>  Miscellaneous and debugging events</h3>
10716    
10717  <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
Legend:
Removed from v.1137  
changed lines
  Added in v.1201
  ViewVC Help
Powered by ViewVC