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

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

Parent Directory | Revision Log | View Patch Patch

-revision 1028 by schoenebeck,
Sun Jan 14 17:33:03 2007 UTC
+revision 1162 by iliev,
Mon Apr 16 16:02:19 2007 UTC
 Line 3
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  <meta name="description" content="LinuxSampler Control Protocol">
  <meta name="keywords" content="LSCP">
- <meta name="generator" content="xml2rfc v1.31 (http://xml.resource.org/)">
+ <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">
  <style type='text/css'><!--
          body {
                  font-family: verdana, charcoal, helvetica, arial, sans-serif;
                  font-size: small; color: #000; background-color: #FFF;
                  margin: 2em;
          }
          h1, h2, h3, h4, h5, h6 {
                  font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;
                  font-weight: bold; font-style: normal;
          }
          h1 { color: #900; background-color: transparent; text-align: right; }
          h3 { color: #333; background-color: transparent; }
          td.RFCbug {
                  font-size: x-small; text-decoration: none;
                  width: 30px; height: 30px; padding-top: 2px;
                  text-align: justify; vertical-align: middle;
                  background-color: #000;
          }
          td.RFCbug span.RFC {
                  font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
                  font-weight: bold; color: #666;
          }
          td.RFCbug span.hotText {
                  font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
                  font-weight: normal; text-align: center; color: #FFF;
          }
          table.TOCbug { width: 30px; height: 15px; }
          td.TOCbug {
                  text-align: center; width: 30px; height: 15px;
                  color: #FFF; background-color: #900;
          }
          td.TOCbug a {
                  font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;
                  font-weight: bold; font-size: x-small; text-decoration: none;
                  color: #FFF; background-color: transparent;
          }
          td.header {
                  font-family: arial, helvetica, sans-serif; font-size: x-small;
                  vertical-align: top; width: 33%;
                  color: #FFF; background-color: #666;
          }
          td.author { font-weight: bold; font-size: x-small; margin-left: 4em; }
          td.author-text { font-size: x-small; }
          /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */
          a.info {
                  /* This is the key. */
                  position: relative;
                  z-index: 24;
                  text-decoration: none;
          }
          a.info:hover {
                  z-index: 25;
                  color: #FFF; background-color: #900;
          }
          a.info span { display: none; }
          a.info:hover span.info {
                  /* The span will display just on :hover state. */
                  display: block;
                  position: absolute;
                  font-size: smaller;
                  top: 2em; left: -5em; width: 15em;
                  padding: 2px; border: 1px solid #333;
                  color: #900; background-color: #EEE;
                  text-align: left;
          }
          a { font-weight: bold; }
          a:link    { color: #900; background-color: transparent; }
          a:visited { color: #633; background-color: transparent; }
          a:active  { color: #633; background-color: transparent; }
          p { margin-left: 2em; margin-right: 2em; }
          p.copyright { font-size: x-small; }
          p.toc { font-size: small; font-weight: bold; margin-left: 3em; }
          table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; }
          td.toc { font-size: small; font-weight: bold; vertical-align: text-top; }
          ol.text { margin-left: 2em; margin-right: 2em; }
          ul.text { margin-left: 2em; margin-right: 2em; }
          li      { margin-left: 3em; }
          /* RFC-2629 <spanx>s and <artwork>s. */
          em     { font-style: italic; }
          strong { font-weight: bold; }
          dfn    { font-weight: bold; font-style: normal; }
          cite   { font-weight: normal; font-style: normal; }
          tt     { color: #036; }
          tt, pre, pre dfn, pre em, pre cite, pre span {
                  font-family: "Courier New", Courier, monospace; font-size: small;
          }
          pre {
                  text-align: left; padding: 4px;
                  color: #000; background-color: #CCC;
          }
          pre dfn  { color: #900; }
          pre em   { color: #66F; background-color: #FFC; font-weight: normal; }
          pre .key { color: #33C; font-weight: bold; }
          pre .id  { color: #900; }
          pre .str { color: #000; background-color: #CFF; }
          pre .val { color: #066; }
          pre .rep { color: #909; }
          pre .oth { color: #000; background-color: #FCF; }
          pre .err { background-color: #FCC; }
          /* RFC-2629 <texttable>s. */
-         table.full, table.headers, table.none {
+         table.all, table.full, table.headers, table.none {
                  font-size: small; text-align: center; border-width: 2px;
                  vertical-align: top; border-collapse: collapse;
          }
-         table.full { border-style: solid; border-color: black; }
+         table.all, table.full { border-style: solid; border-color: black; }
          table.headers, table.none { border-style: none; }
          th {
                  font-weight: bold; border-color: black;
                  border-width: 2px 2px 3px 2px;
          }
-         table.full th { border-style: solid; }
+         table.all th, table.full th { border-style: solid; }
          table.headers th { border-style: none none solid none; }
          table.none th { border-style: none; }
-         table.full td {
+         table.all td {
                  border-style: solid; border-color: #333;
                  border-width: 1px 2px;
          }
-         table.headers td, table.none td { border-style: none; }
+         table.full td, table.headers td, table.none td { border-style: none; }
          hr { height: 1px; }
          hr.insert {
                  width: 80%; border-style: none; border-width: 0;
                  color: #CCC; background-color: #CCC;
          }
  --></style>
  </head>
  <body>
 Line 145
  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>
  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>
  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>
- <tr><td class="header">Expires: July 18, 2007</td><td class="header">January 14, 2007</td></tr>
+ <tr><td class="header">Expires: October 18, 2007</td><td class="header">April 16, 2007</td></tr>
  </table></td></tr></table>
  <h1><br />LinuxSampler Control Protocol<br />LSCP 1.2</h1>
 Line 173 
 The list of current Internet-Drafts can
  The list of Internet-Draft Shadow Directories can be accessed at
  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>
  <p>
- This Internet-Draft will expire on July 18, 2007.</p>
+ This Internet-Draft will expire on October 18, 2007.</p>
  <h3>Copyright Notice</h3>
  <p>
- Copyright &copy; The Internet Society (2007).</p>
+ Copyright &copy; The IETF Trust (2007).</p>
  <h3>Abstract</h3>
 Line 328 
 Getting amount of effect sends on a samp
  Listing all effect sends on a sampler channel<br />
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SEND INFO">6.4.29.</a>&nbsp;
  Getting effect send information<br />
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.30.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND NAME">6.4.30.</a>&nbsp;
+ Changing effect send's name<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a>&nbsp;
  Altering effect send's audio routing<br />
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.31.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.32.</a>&nbsp;
  Altering effect send's MIDI controller<br />
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.32.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.33.</a>&nbsp;
  Altering effect send's send level<br />
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.33.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.34.</a>&nbsp;
  Resetting a sampler channel<br />
  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;
  Controlling connection<br />
-Line 386 
 Remove an entry from the MIDI instrument
+Line 388 
 Remove an entry from the MIDI instrument
  Get current settings of MIDI instrument map entry<br />
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CLEAR MIDI_INSTRUMENTS">6.7.12.</a>&nbsp;
  Clear MIDI instrument map<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Managing Instruments Database">6.8.</a>&nbsp;
+ Managing Instruments Database<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD DB_INSTRUMENT_DIRECTORY">6.8.1.</a>&nbsp;
+ Creating a new instrument directory<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE DB_INSTRUMENT_DIRECTORY">6.8.2.</a>&nbsp;
+ Deleting an instrument directory<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT_DIRECTORIES">6.8.3.</a>&nbsp;
+ Getting amount of instrument directories<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST DB_INSTRUMENT_DIRECTORIES">6.8.4.</a>&nbsp;
+ Listing all directories in specific directory<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT_DIRECTORY INFO">6.8.5.</a>&nbsp;
+ Getting instrument directory information<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT_DIRECTORY NAME">6.8.6.</a>&nbsp;
+ Renaming an instrument directory<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MOVE DB_INSTRUMENT_DIRECTORY">6.8.7.</a>&nbsp;
+ Moving an instrument directory<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">6.8.8.</a>&nbsp;
+ Changing the description of directory<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD DB_INSTRUMENTS">6.8.9.</a>&nbsp;
+ Adding instruments to the instruments database<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE DB_INSTRUMENT">6.8.10.</a>&nbsp;
+ Removing an instrument<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENTS">6.8.11.</a>&nbsp;
+ Getting amount of instruments<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST DB_INSTRUMENTS">6.8.12.</a>&nbsp;
+ Listing all instruments in specific directory<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT INFO">6.8.13.</a>&nbsp;
+ Getting instrument information<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT NAME">6.8.14.</a>&nbsp;
+ Renaming an instrument<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MOVE DB_INSTRUMENT">6.8.15.</a>&nbsp;
+ Moving an instrument<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT DESCRIPTION">6.8.16.</a>&nbsp;
+ Changing the description of instrument<br />
  <a href="#command_syntax">7.</a>&nbsp;
  Command Syntax<br />
  <a href="#events">8.</a>&nbsp;
-Line 408 
 Number of active disk streams changed<br
+Line 444 
 Number of active disk streams changed<br
  Disk stream buffer fill state changed<br />
  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_INFO">8.9.</a>&nbsp;
  Channel information changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.10.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_COUNT">8.10.</a>&nbsp;
+ Number of effect sends changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_INFO">8.11.</a>&nbsp;
+ Effect send information changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a>&nbsp;
  Total number of active voices changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.11.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.13.</a>&nbsp;
  Number of MIDI instrument maps changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.12.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.14.</a>&nbsp;
  MIDI instrument map information changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.13.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.15.</a>&nbsp;
  Number of MIDI instruments changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.14.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.16.</a>&nbsp;
  MIDI instrument information changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.15.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a>&nbsp;
+ Global settings changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.18.</a>&nbsp;
+ Number of database instrument directories changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.19.</a>&nbsp;
+ Database instrument directory information changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.20.</a>&nbsp;
+ Number of database instruments changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.21.</a>&nbsp;
+ Database instrument information changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.22.</a>&nbsp;
  Miscellaneous and debugging events<br />
  <a href="#anchor14">9.</a>&nbsp;
  Security Considerations<br />
-Line 5327 
 Getting effect send information</h3>
+Line 5377 
 Getting effect send information</h3>
  </blockquote><p>
  </p>
- <a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
+ <a name="SET FX_SEND NAME"></a><br /><hr />
  <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>
  <a name="rfc.section.6.4.30"></a><h3>6.4.30.&nbsp;
+ Changing effect send's name</h3>
+ <p>The front-end can alter the current name of an effect
+                     send entity by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;sampler-chan&gt; is the sampler channel number
+                     as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
+                     or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command,
+                     &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
+                     as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
+                     or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and
+                     &lt;name&gt; is the new name of the effect send entity, which
+                     does not have to be unique.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case it failed, providing an appropriate error code and error message
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;
  Altering effect send's audio routing</h3>
  <p>The front-end can alter the destination of an effect send's audio channel on a specific
-Line 5412 
 Altering effect send's audio routing</h3
+Line 5523 
 Altering effect send's audio routing</h3
  </p>
  <a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />
  <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>
- <a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;
+ <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;
  Altering effect send's MIDI controller</h3>
  <p>The front-end can alter the MIDI controller of an effect
-Line 5483 
 Altering effect send's MIDI controller</
+Line 5594 
 Altering effect send's MIDI controller</
  </p>
  <a name="SET FX_SEND LEVEL"></a><br /><hr />
  <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>
- <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;
+ <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;
  Altering effect send's send level</h3>
  <p>The front-end can alter the current send level of an effect
-Line 5555 
 Altering effect send's send level</h3>
+Line 5666 
 Altering effect send's send level</h3>
  </p>
  <a name="RESET CHANNEL"></a><br /><hr />
  <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>
- <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;
+ <a name="rfc.section.6.4.34"></a><h3>6.4.34.&nbsp;
  Resetting a sampler channel</h3>
  <p>The front-end can reset a particular sampler channel by sending the following command:
-Line 5987 
 General sampler informations</h3>
+Line 6098 
 General sampler informations</h3>
  </blockquote>
+ <p>INSTRUMENTS_DB_SUPPORT -
+                                         </p>
+ <blockquote class="text">
+ <p>either yes or no, specifies whether the
+                                             sampler is build with instruments database support.
+ </p>
+ </blockquote>
  </blockquote>
-Line 6398 
 Getting MIDI instrument map information<
+Line 6518 
 Getting MIDI instrument map information<
  </blockquote>
+ <p>DEFAULT -
+                                         </p>
+ <blockquote class="text">
+ <p>either true or false,
+                                             defines whether this map is the default map
+ </p>
+ </blockquote>
  </blockquote>
-Line 6415 
 Getting MIDI instrument map information<
+Line 6544 
 Getting MIDI instrument map information<
  </p>
  <p>S: "NAME: Standard Map"
  </p>
+ <p>&nbsp;&nbsp;&nbsp;"DEFAULT: true"
+ </p>
  <p>&nbsp;&nbsp;&nbsp;"."
  </p>
  </blockquote><p>
-Line 6488 
 Create or replace a MIDI instrument map
+Line 6619 
 Create or replace a MIDI instrument map
  <p>
                          </p>
  <blockquote class="text">
- <p>MAP MIDI_INSTRUMENT &lt;map&gt;
+ <p>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]
-Line 6552 
 Create or replace a MIDI instrument map
+Line 6683 
 Create or replace a MIDI instrument map
                                  </p>
  <blockquote class="text">
  <p>The instrument will immediately be loaded
-                                     into memory in the background when this mapping
+                                     into memory when this mapping
                                      command is sent and the instrument is kept all
                                      the time. Instruments with this mode are
                                      only freed when the sampler is reset or all
-Line 6609 
 Create or replace a MIDI instrument map
+Line 6740 
 Create or replace a MIDI instrument map
  </p>
  <p>
-                     The "MAP MIDI_INSTRUMENT" command
+                     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
-                     will immediately return, thus it will not block when an
+                     completely established in the sampler. The OPTIONAL "NON_MODAL" argument
-                     instrument is to be loaded due to a "PERSISTENT" type
+                     however causes the respective "MAP MIDI_INSTRUMENT" command to return
-                     entry as instruments are loaded in the background. As a
+                     immediately, that is to let the sampler establish the mapping in the
-                     consequence this command may not necessarily return an error
+                     background. So this argument might be especially useful for mappings with
-                     i.e. when the given instrument file does not exist or may
+                     a "PERSISTENT" type, because these have to load the respective instruments
-                     turn out to be corrupt.
+                     immediately and might thus block for a very long time. It is recommended
+                     however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
+                     because it has the following drawbacks: as "NON_MODAL" instructions return
+                     immediately, they may not necessarily return an error i.e. when the given
+                     instrument file turns out to be corrupt, beside that subsequent commands
+                     in a LSCP instruction sequence might fail, because mandatory mappings are
+                     not yet completed.
  </p>
  <p>Possible Answers:
-Line 6682 
 Create or replace a MIDI instrument map
+Line 6819 
 Create or replace a MIDI instrument map
  <p>
                          </p>
  <blockquote class="text">
- <p>C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
+ <p>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
  </p>
  <p>S: "OK"
  </p>
-Line 7080 
 Clear MIDI instrument map</h3>
+Line 7217 
 Clear MIDI instrument map</h3>
  </blockquote><p>
  </p>
+ <a name="Managing Instruments Database"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8"></a><h3>6.8.&nbsp;
+ Managing Instruments Database</h3>
+ <p>The following commands describe how to use and manage
+                 the instruments database.
+ </p>
+ <a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8.1"></a><h3>6.8.1.&nbsp;
+ Creating a new instrument directory</h3>
+ <p>The front-end can add a new instrument directory to the
+                     instruments database by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>ADD DB_INSTRUMENT_DIRECTORY &lt;dir&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; is the absolute path name of the directory
+                     to be created (encapsulated into apostrophes).
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>when the directory could not be created, which
+                                     can happen if the directory already exists or the
+                                     name contains not allowed symbols
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="REMOVE DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8.2"></a><h3>6.8.2.&nbsp;
+ Deleting an instrument directory</h3>
+ <p>The front-end can delete a particular instrument directory
+                     from the instruments database by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] &lt;dir&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; is the absolute path name of the directory
+                     to delete. The optional FORCE argument can be used to
+                     force the deletion of a non-empty directory and all its content.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the directory is deleted successfully
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the given directory does not exist, or
+                                     if trying to delete a non-empty directory,
+                                     without using the FORCE argument.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="GET DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8.3"></a><h3>6.8.3.&nbsp;
+ Getting amount of instrument directories</h3>
+ <p>The front-end can retrieve the current amount of
+                     directories in a specific directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET DB_INSTRUMENT_DIRECTORIES &lt;dir&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; should be replaced by the absolute path
+                     name of the directory.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>The current number of instrument directories
+                             in the specified directory.
+ </p>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the given directory does not exist.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
+ </p>
+ <p>S: "2"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="LIST DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8.4"></a><h3>6.8.4.&nbsp;
+ Listing all directories in specific directory</h3>
+ <p>The front-end can retrieve the current list of directories
+                     in specific directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LIST DB_INSTRUMENT_DIRECTORIES &lt;dir&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; should be replaced by the absolute path
+                     name of the directory.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>A comma separated list of all instrument directories
+                             (encapsulated into apostrophes) in the specified directory.
+ </p>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the given directory does not exist.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
+ </p>
+ <p>S: "'Piano Collection','Percussion Collection'"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="GET DB_INSTRUMENT_DIRECTORY INFO"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8.5"></a><h3>6.8.5.&nbsp;
+ Getting instrument directory information</h3>
+ <p>The front-end can ask for the current settings of an
+                     instrument directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET DB_INSTRUMENT_DIRECTORY INFO &lt;dir&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; should be replaced by the absolute path
+                     name of the directory the front-end is interested in.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
+                             Each answer line begins with the settings category name
+                             followed by a colon and then a space character &lt;SP&gt; and finally
+                             the info character string to that setting category. At the
+                             moment the following categories are defined:
+ </p>
+ <p>
+                                 </p>
+ <blockquote class="text">
+ <p>DESCRIPTION -
+                                         </p>
+ <blockquote class="text">
+ <p>A brief description of the directory content
+ </p>
+ </blockquote>
+ <p>CREATED -
+                                         </p>
+ <blockquote class="text">
+ <p>The creation date and time of the directory,
+                                             represented in "YYYY-MM-DD HH:MM:SS" format
+ </p>
+ </blockquote>
+ <p>MODIFIED -
+                                         </p>
+ <blockquote class="text">
+ <p>The date and time of the last modification of the
+                                             directory, represented in "YYYY-MM-DD HH:MM:SS" format
+ </p>
+ </blockquote>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>The mentioned fields above don't have to be in particular order.
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
+ </p>
+ <p>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"."
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="SET DB_INSTRUMENT_DIRECTORY NAME"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8.6"></a><h3>6.8.6.&nbsp;
+ Renaming an instrument directory</h3>
+ <p>The front-end can alter the name of a specific
+                     instrument directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET DB_INSTRUMENT_DIRECTORY NAME &lt;dir&gt; &lt;name&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; is the absolute path name of the directory and
+                     &lt;name&gt; is the new name for that directory.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the given directory does not exists,
+                                     or if a directory with name equal to the new
+                                     name already exists.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="MOVE DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8.7"></a><h3>6.8.7.&nbsp;
+ Moving an instrument directory</h3>
+ <p>The front-end can move a specific
+                     instrument directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>MOVE DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; is the absolute path name of the directory
+                     to move and &lt;dst&gt; is the location where the directory will
+                     be moved to.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case a given directory does not exists,
+                                     or if a directory with name equal to the name
+                                     of the specified directory already exists in
+                                     the destination directory. Error is also thrown
+                                     when trying to move a directory to a subdirectory
+                                     of itself.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8.8"></a><h3>6.8.8.&nbsp;
+ Changing the description of directory</h3>
+ <p>The front-end can alter the description of a specific
+                     instrument directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION &lt;dir&gt; &lt;desc&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; is the absolute path name of the directory and
+                     &lt;desc&gt; is the new description for the directory.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the given directory does not exists.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="ADD DB_INSTRUMENTS"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8.9"></a><h3>6.8.9.&nbsp;
+ Adding instruments to the instruments database</h3>
+ <p>The front-end can add one or more instruments
+                     to the instruments database by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>ADD DB_INSTRUMENTS [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;db_dir&gt; is the absolute path name of a directory
+                     (encapsulated into apostrophes) in the instruments database in which
+                     only the new instruments (that are not already in the database) will
+                     be added, &lt;file_path&gt; is the absolute path name of a file or
+                     directory in the file system (encapsulated into apostrophes). In case
+                     an instrument file is supplied, only the instruments in the specified
+                     file will be added to the instruments database. If the optional
+                     &lt;instr_index&gt; (the index of the instrument within the given file)
+                     is supplied too, then only the specified instrument will be added.
+                     In case a directory is supplied, the instruments in that directory
+                     will be added. The OPTIONAL &lt;mode&gt; argument is only applied
+                     when a directory is provided as &lt;file_path&gt; and specifies how the
+                     scanning will be done and has exactly the following possibilities:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"NON_RECURSIVE" -
+                                 </p>
+ <blockquote class="text">
+ <p>Only the instruments in the specified directory
+                                     will be added, the instruments in the subdirectories
+                                     will not be processed.
+ </p>
+ </blockquote>
+ <p>"FLAT" -
+                                 </p>
+ <blockquote class="text">
+ <p>All instruments will be processed, including those
+                                     in the subdirectories, but the respective subdirectory
+                                     structure will not be recreated in the instruments
+                                     database. All instruments will be added directly in
+                                     the specified database directory.
+ </p>
+ </blockquote>
+ <p>not supplied -
+                                 </p>
+ <blockquote class="text">
+ <p>The subdirectory tree structure will be recreated
+                                     in the instruments database and all instruments will be
+                                     processed and added to the respective subdirectory
+                                     in the instruments database.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if an invalid path is specified.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="REMOVE DB_INSTRUMENT"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8.10"></a><h3>6.8.10.&nbsp;
+ Removing an instrument</h3>
+ <p>The front-end can remove a particular instrument
+                     from the instruments database by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>REMOVE DB_INSTRUMENT &lt;instr_path&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;instr_path&gt; is the absolute path name
+                     (in the instruments database) of the instrument to remove.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the instrument is removed successfully
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the given path does not exist or
+                                     is a directory.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="GET DB_INSTRUMENTS"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8.11"></a><h3>6.8.11.&nbsp;
+ Getting amount of instruments</h3>
+ <p>The front-end can retrieve the current amount of
+                     instruments in a specific directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET DB_INSTRUMENTS &lt;dir&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; should be replaced by the absolute path name
+                     of the directory.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>The current number of instruments
+                             in the specified directory.
+ </p>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the given directory does not exist.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "GET DB_INSTRUMENTS '/Piano Collection'"
+ </p>
+ <p>S: "2"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="LIST DB_INSTRUMENTS"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8.12"></a><h3>6.8.12.&nbsp;
+ Listing all instruments in specific directory</h3>
+ <p>The front-end can retrieve the current list of instruments
+                     in specific directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LIST DB_INSTRUMENTS &lt;dir&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; should be replaced by the absolute path
+                     name of the directory.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>A comma separated list of all instruments
+                             (encapsulated into apostrophes) in the specified directory.
+ </p>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the given directory does not exist.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "LIST DB_INSTRUMENTS '/Piano Collection'"
+ </p>
+ <p>S: "'Bosendorfer 290','Steinway D'"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="GET DB_INSTRUMENT INFO"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8.13"></a><h3>6.8.13.&nbsp;
+ Getting instrument information</h3>
+ <p>The front-end can ask for the current settings of an
+                     instrument by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET DB_INSTRUMENT INFO &lt;instr_path&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;instr_path&gt; should be replaced by the absolute path
+                     name of the instrument the front-end is interested in.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
+                             Each answer line begins with the settings category name
+                             followed by a colon and then a space character &lt;SP&gt; and finally
+                             the info character string to that setting category. At the
+                             moment the following categories are defined:
+ </p>
+ <p>
+                                 </p>
+ <blockquote class="text">
+ <p>INSTRUMENT_FILE -
+                                         </p>
+ <blockquote class="text">
+ <p>File name of the instrument.
+ </p>
+ </blockquote>
+ <p>INSTRUMENT_NR -
+                                         </p>
+ <blockquote class="text">
+ <p>Index of the instrument within the file.
+ </p>
+ </blockquote>
+ <p>FORMAT_FAMILY -
+                                         </p>
+ <blockquote class="text">
+ <p>The format family of the instrument.
+ </p>
+ </blockquote>
+ <p>FORMAT_VERSION -
+                                         </p>
+ <blockquote class="text">
+ <p>The format version of the instrument.
+ </p>
+ </blockquote>
+ <p>SIZE -
+                                         </p>
+ <blockquote class="text">
+ <p>The size of the instrument in bytes.
+ </p>
+ </blockquote>
+ <p>CREATED -
+                                         </p>
+ <blockquote class="text">
+ <p>The date and time when the instrument is added
+                                             in the instruments database, represented in
+                                            "YYYY-MM-DD HH:MM:SS" format
+ </p>
+ </blockquote>
+ <p>MODIFIED -
+                                         </p>
+ <blockquote class="text">
+ <p>The date and time of the last modification of the
+                                             instrument's database settings, represented in
+                                             "YYYY-MM-DD HH:MM:SS" format
+ </p>
+ </blockquote>
+ <p>DESCRIPTION -
+                                         </p>
+ <blockquote class="text">
+ <p>A brief description of the instrument
+ </p>
+ </blockquote>
+ <p>IS_DRUM -
+                                         </p>
+ <blockquote class="text">
+ <p>either true or false, determines whether the
+                                             instrument is a drumkit or a chromatic instrument
+ </p>
+ </blockquote>
+ <p>PRODUCT -
+                                         </p>
+ <blockquote class="text">
+ <p>The product title of the instrument
+ </p>
+ </blockquote>
+ <p>ARTISTS -
+                                         </p>
+ <blockquote class="text">
+ <p>Lists the artist names
+ </p>
+ </blockquote>
+ <p>KEYWORDS -
+                                         </p>
+ <blockquote class="text">
+ <p>Provides a list of keywords that refer to the instrument.
+                                             Keywords are separated with semicolon and blank.
+ </p>
+ </blockquote>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>The mentioned fields above don't have to be in particular order.
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"
+ </p>
+ <p>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 2"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"SIZE: 2050871870"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"DESCRIPTION: "
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"IS_DRUM: false"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"PRODUCT: GRANDIOSO Bosendorfer 290"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"ARTISTS: Post Musical Instruments"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"KEYWORDS: Bosendorfer"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"."
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="SET DB_INSTRUMENT NAME"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8.14"></a><h3>6.8.14.&nbsp;
+ Renaming an instrument</h3>
+ <p>The front-end can alter the name of a specific
+                     instrument by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET DB_INSTRUMENT NAME &lt;instr&gt; &lt;name&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;instr&gt; is the absolute path name of the instrument and
+                     &lt;name&gt; is the new name for that instrument.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the given instrument does not exists,
+                                     or if an instrument with name equal to the new
+                                     name already exists.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="MOVE DB_INSTRUMENT"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8.15"></a><h3>6.8.15.&nbsp;
+ Moving an instrument</h3>
+ <p>The front-end can move a specific instrument to another directory by
+                     sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>MOVE DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;instr&gt; is the absolute path name of the instrument
+                     to move and &lt;dst&gt; is the directory where the instrument will
+                     be moved to.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the given instrument does not exists,
+                                     or if an instrument with name equal to the name of the
+                                     specified instrument already exists in the destination
+                                     directory.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="SET DB_INSTRUMENT DESCRIPTION"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.8.16"></a><h3>6.8.16.&nbsp;
+ Changing the description of instrument</h3>
+ <p>The front-end can alter the description of a specific
+                     instrument by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET DB_INSTRUMENT DESCRIPTION &lt;instr&gt; &lt;desc&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;instr&gt; is the absolute path name of the instrument and
+                     &lt;desc&gt; is the new description for the instrument.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the given instrument does not exists.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
  <a name="command_syntax"></a><br /><hr />
  <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>
  <a name="rfc.section.7"></a><h3>7.&nbsp;
-Line 7180 
 Command Syntax</h3>
+Line 8409 
 Command Syntax</h3>
  <p>/ UNSUBSCRIBE SP unsubscribe_event
  </p>
- <p>/ SELECT SP text
- </p>
  <p>/ RESET SP reset_instruction
  </p>
  <p>/ CLEAR SP clear_instruction
  </p>
+ <p>/ MOVE SP move_instruction
+ </p>
  <p>/ RESET
  </p>
-Line 7204 
 Command Syntax</h3>
+Line 8433 
 Command Syntax</h3>
  <p>CHANNEL
  </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY SP pathname
+ </p>
+ <p>/ DB_INSTRUMENTS SP FLAT SP pathname SP pathname
+ </p>
+ <p>/ DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname
+ </p>
+ <p>/ DB_INSTRUMENTS SP pathname SP pathname
+ </p>
+ <p>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index
+ </p>
  <p>/ MIDI_INSTRUMENT_MAP
  </p>
-Line 7243 
 Command Syntax</h3>
+Line 8487 
 Command Syntax</h3>
  <p>/ CHANNEL_INFO
  </p>
+ <p>/ FX_SEND_COUNT
+ </p>
+ <p>/ FX_SEND_INFO
+ </p>
  <p>/ MIDI_INSTRUMENT_MAP_COUNT
  </p>
-Line 7255 
 Command Syntax</h3>
+Line 8505 
 Command Syntax</h3>
  <p>/ MIDI_INSTRUMENT_INFO
  </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY_COUNT
+ </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY_INFO
+ </p>
+ <p>/ DB_INSTRUMENT_COUNT
+ </p>
+ <p>/ DB_INSTRUMENT_INFO
+ </p>
  <p>/ MISCELLANEOUS
  </p>
  <p>/ TOTAL_VOICE_COUNT
  </p>
+ <p>/ GLOBAL_INFO
+ </p>
  </blockquote><p>
  </p>
-Line 7294 
 Command Syntax</h3>
+Line 8559 
 Command Syntax</h3>
  <p>/ CHANNEL_INFO
  </p>
+ <p>/ FX_SEND_COUNT
+ </p>
+ <p>/ FX_SEND_INFO
+ </p>
  <p>/ MIDI_INSTRUMENT_MAP_COUNT
  </p>
-Line 7306 
 Command Syntax</h3>
+Line 8577 
 Command Syntax</h3>
  <p>/ MIDI_INSTRUMENT_INFO
  </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY_COUNT
+ </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY_INFO
+ </p>
+ <p>/ DB_INSTRUMENT_COUNT
+ </p>
+ <p>/ DB_INSTRUMENT_INFO
+ </p>
  <p>/ MISCELLANEOUS
  </p>
  <p>/ TOTAL_VOICE_COUNT
  </p>
+ <p>/ GLOBAL_INFO
+ </p>
  </blockquote><p>
  </p>
  <p>map_instruction =
          </p>
  <blockquote class="text">
- <p>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value
+ <p>MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value
  </p>
- <p>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode
+ <p>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode
  </p>
- <p>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name
+ <p>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name
  </p>
- <p>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name
+ <p>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name
  </p>
  </blockquote><p>
-Line 7354 
 Command Syntax</h3>
+Line 8640 
 Command Syntax</h3>
  <p>/ MIDI_INSTRUMENT_MAP SP ALL
  </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname
+ </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY SP pathname
+ </p>
+ <p>/ DB_INSTRUMENT SP pathname
+ </p>
  </blockquote><p>
  </p>
-Line 7459 
 Command Syntax</h3>
+Line 8754 
 Command Syntax</h3>
  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
  </p>
+ <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname
+ </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
+ </p>
+ <p>/ DB_INSTRUMENTS SP pathname
+ </p>
+ <p>/ DB_INSTRUMENT SP INFO SP pathname
+ </p>
  <p>/ VOLUME
  </p>
-Line 7486 
 Command Syntax</h3>
+Line 8793 
 Command Syntax</h3>
  <p>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
  </p>
+ <p>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
+ </p>
  <p>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
  </p>
-Line 7495 
 Command Syntax</h3>
+Line 8805 
 Command Syntax</h3>
  <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
  </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname
+ </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval
+ </p>
+ <p>/ DB_INSTRUMENT SP NAME SP pathname SP dirname
+ </p>
+ <p>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval
+ </p>
  <p>/ ECHO SP boolean
  </p>
-Line 7549 
 Command Syntax</h3>
+Line 8871 
 Command Syntax</h3>
  </blockquote><p>
  </p>
+ <p>move_instruction =
+         </p>
+ <blockquote class="text">
+ <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
+ </p>
+ <p>/ DB_INSTRUMENT SP pathname SP pathname
+ </p>
+ </blockquote><p>
+ </p>
  <p>destroy_instruction =
          </p>
  <blockquote class="text">
-Line 7624 
 Command Syntax</h3>
+Line 8958 
 Command Syntax</h3>
  </blockquote><p>
  </p>
+ <p>modal_arg =
+         </p>
+ <blockquote class="text">
+ <p>/* epsilon (empty argument) */
+ </p>
+ <p>/ NON_MODAL SP
+ </p>
+ </blockquote><p>
+ </p>
  <p>key_val_list =
          </p>
  <blockquote class="text">
-Line 7681 
 Command Syntax</h3>
+Line 9027 
 Command Syntax</h3>
  <p>/ FX_SENDS SP sampler_channel
  </p>
+ <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname
+ </p>
+ <p>/ DB_INSTRUMENTS SP pathname
+ </p>
  </blockquote><p>
  </p>
-Line 7861 
 Command Syntax</h3>
+Line 9213 
 Command Syntax</h3>
  </blockquote><p>
  </p>
+ <p>pathname =
+         </p>
+ <blockquote class="text">
+ <p>stringval
+ </p>
+ </blockquote><p>
+ </p>
+ <p>dirname =
+         </p>
+ <blockquote class="text">
+ <p>stringval
+ </p>
+ </blockquote><p>
+ </p>
  <p>filename =
          </p>
  <blockquote class="text">
-Line 8108 
 Number of active voices changed</h3>
+Line 9478 
 Number of active voices changed</h3>
  <p>
                      </p>
  <blockquote class="text">
- <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;
+ <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"
  </p>
  </blockquote><p>
-Line 8211 
 Channel information changed</h3>
+Line 9581 
 Channel information changed</h3>
                  time events happening on the server, it is believed that an empty notification
                  message is sufficient here.
  </p>
- <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />
+ <a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr />
  <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>
  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
+ Number of effect sends changed</h3>
+ <p>Client may want to be notified when the number of effect sends on
+                 a particular sampler channel is changed by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE FX_SEND_COUNT
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
+                 channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
+                 be replaced by the new number of effect sends on that channel.
+ </p>
+ <a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr />
+ <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>
+ <a name="rfc.section.8.11"></a><h3>8.11.&nbsp;
+ Effect send information changed</h3>
+ <p>Client may want to be notified when changes were made to effect sends on a
+                 a particular sampler channel by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE FX_SEND_INFO
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
+                 channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
+                 be replaced by the numerical ID of the changed effect send.
+ </p>
+ <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />
+ <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>
+ <a name="rfc.section.8.12"></a><h3>8.12.&nbsp;
  Total number of active voices changed</h3>
  <p>Client may want to be notified when the total number of voices on the
-Line 8232 
 Total number of active voices changed</h
+Line 9662 
 Total number of active voices changed</h
  <p>
                      </p>
  <blockquote class="text">
- <p>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;
+ <p>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"
  </p>
  </blockquote><p>
-Line 8242 
 Total number of active voices changed</h
+Line 9672 
 Total number of active voices changed</h
  </p>
  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr />
  <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>
- <a name="rfc.section.8.11"></a><h3>8.11.&nbsp;
+ <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;
  Number of MIDI instrument maps changed</h3>
  <p>Client may want to be notified when the number of MIDI instrument maps on the
-Line 8271 
 Number of MIDI instrument maps changed</
+Line 9701 
 Number of MIDI instrument maps changed</
  </p>
  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr />
  <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>
- <a name="rfc.section.8.12"></a><h3>8.12.&nbsp;
+ <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;
  MIDI instrument map information changed</h3>
  <p>Client may want to be notified when changes were made to MIDI instrument maps on the
-Line 8304 
 MIDI instrument map information changed<
+Line 9734 
 MIDI instrument map information changed<
  </p>
  <a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr />
  <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>
- <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;
+ <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;
  Number of MIDI instruments changed</h3>
  <p>Client may want to be notified when the number of MIDI instrument maps on the
-Line 8334 
 Number of MIDI instruments changed</h3>
+Line 9764 
 Number of MIDI instruments changed</h3>
  </p>
  <a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr />
  <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>
- <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;
+ <a name="rfc.section.8.16"></a><h3>8.16.&nbsp;
  MIDI instrument information changed</h3>
  <p>Client may want to be notified when changes were made to MIDI instruments on the
-Line 8366 
 MIDI instrument information changed</h3>
+Line 9796 
 MIDI instrument information changed</h3>
                  time events happening on the server, it is believed that an empty notification
                  message is sufficient here.
  </p>
+ <a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr />
+ <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>
+ <a name="rfc.section.8.17"></a><h3>8.17.&nbsp;
+ Global settings changed</h3>
+ <p>Client may want to be notified when changes to the global settings
+                 of the sampler were made by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE GLOBAL_INFO
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following types of notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
+                         golbal volume of the sampler is changed, where &lt;volume&gt; will be
+                         replaced by the optional dotted floating point value, reflecting the
+                         new global volume parameter.
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />
+ <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>
+ <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;
+ Number of database instrument directories changed</h3>
+ <p>Client may want to be notified when the number of instrument
+                 directories in a particular directory in the instruments database
+                 is changed by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:&lt;dir-path&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;dir-path&gt; will be replaced by the absolute path
+                 name of the directory in the instruments database,
+                 in which the number of directories is changed.
+ </p>
+ <p>Note that when a non-empty directory is removed, this event
+                 is not sent for the subdirectories in that directory.
+ </p>
+ <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr />
+ <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>
+ <a name="rfc.section.8.19"></a><h3>8.19.&nbsp;
+ Database instrument directory information changed</h3>
+ <p>Client may want to be notified when changes were made to directories
+                 in the instruments database by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:&lt;dir-path&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;dir-path&gt; will be replaced by the absolute path name
+                 of the directory, for which information changes occurred. The front-end will have to send
+                 the respective command to actually get the updated directory info. Because these messages
+                 will be triggered by LSCP commands issued by other clients rather than real
+                 time events happening on the server, it is believed that an empty notification
+                 message is sufficient here.
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME &lt;old-dir-path&gt; &lt;new-name&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;old-dir-path&gt; is the old absolute path name of the directory
+                 (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
+                 the new name of the directory, encapsulated into apostrophes.
+ </p>
+ <a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr />
+ <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>
+ <a name="rfc.section.8.20"></a><h3>8.20.&nbsp;
+ Number of database instruments changed</h3>
+ <p>Client may want to be notified when the number of instruments
+                 in a particular directory in the instruments database
+                 is changed by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE DB_INSTRUMENT_COUNT
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:DB_INSTRUMENT_COUNT:&lt;dir-path&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;dir-path&gt; will be replaced by the absolute path
+                 name of the directory in the instruments database,
+                 in which the number of instruments is changed.
+ </p>
+ <p>Note that when a non-empty directory is removed, this event
+                 is not sent for the instruments in that directory.
+ </p>
+ <a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr />
+ <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>
+ <a name="rfc.section.8.21"></a><h3>8.21.&nbsp;
+ Database instrument information changed</h3>
+ <p>Client may want to be notified when changes were made to instruments
+                 in the instruments database by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE DB_INSTRUMENT_INFO
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:DB_INSTRUMENT_INFO:&lt;instr-path&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;instr-path&gt; will be replaced by the absolute path name
+                 of the instrument, which settings are changed. The front-end will have to send
+                 the respective command to actually get the updated directory info. Because these messages
+                 will be triggered by LSCP commands issued by other clients rather than real
+                 time events happening on the server, it is believed that an empty notification
+                 message is sufficient here.
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:DB_INSTRUMENT_INFO:NAME &lt;old-instr-path&gt; &lt;new-name&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;old-instr-path&gt; is the old absolute path name of the instrument
+                 (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
+                 the new name of the instrument, encapsulated into apostrophes.
+ </p>
  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
  <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>
- <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;
+ <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;
  Miscellaneous and debugging events</h3>
  <p>Client may want to be notified of miscellaneous and debugging events occurring at
-Line 8463 
 Schoenebeck</td></tr>
+Line 10080 
 Schoenebeck</td></tr>
  <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>
  <h3>Full Copyright Statement</h3>
  <p class='copyright'>
- Copyright &copy; The Internet Society (2007).</p>
+ Copyright &copy; The IETF Trust (2007).</p>
  <p class='copyright'>
  This document is subject to the rights,
  licenses and restrictions contained in BCP&nbsp;78,
-Line 8472 
 the authors retain all their rights.</p>
+Line 10089 
 the authors retain all their rights.</p>
  <p class='copyright'>
  This document and the information contained herein are provided
  on an &ldquo;AS IS&rdquo; basis and THE CONTRIBUTOR,
- THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY),
+ THE ORGANIZATION HE/SHE REPRESENTS
- THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM
+ OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST
- ALL WARRANTIES,
+ AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES,
- EXPRESS OR IMPLIED,
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT
- INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
+ THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY
- INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
+ IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
- WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.</p>
+ PURPOSE.</p>
  <h3>Intellectual Property</h3>
  <p class='copyright'>
  The IETF takes no position regarding the validity or scope of any

 Legend:



Removed from v.1028
 


changed lines


 
Added in v.1162
 Legend:



Removed from v.1028
 


changed lines


 
Added in v.1162
-Removed from v.1028
+Added in v.1162

	ViewVC Help
Powered by ViewVC