/[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 940 by schoenebeck, Sat Nov 25 17:18:12 2006 UTC revision 1201 by iliev, Thu May 24 14:22:39 2007 UTC
# Line 3  Line 3 
3  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
4  <meta name="description" content="LinuxSampler Control Protocol">  <meta name="description" content="LinuxSampler Control Protocol">
5  <meta name="keywords" content="LSCP">  <meta name="keywords" content="LSCP">
6  <meta name="generator" content="xml2rfc v1.30 (http://xml.resource.org/)">  <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">
7  <style type='text/css'>  <style type='text/css'><!--
8  <!--          body {
9      body {                  font-family: verdana, charcoal, helvetica, arial, sans-serif;
10          font-family: verdana, charcoal, helvetica, arial, sans-serif;                  font-size: small; color: #000; background-color: #FFF;
11          margin: 2em;                  margin: 2em;
         font-size: small ; color: #000000 ; background-color: #ffffff ; }  
     .title { color: #990000; font-size: x-large ;  
         font-weight: bold; text-align: right;  
         font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;  
         background-color: transparent; }  
     .filename { color: #666666; font-size: 18px; line-height: 28px;  
         font-weight: bold; text-align: right;  
         font-family: helvetica, arial, sans-serif;  
         background-color: transparent; }  
     td.rfcbug { background-color: #000000 ; width: 30px ; height: 30px ;  
         text-align: justify; vertical-align: middle ; padding-top: 2px ; }  
     td.rfcbug span.RFC { color: #666666; font-weight: bold; text-decoration: none;  
         background-color: #000000 ;  
         font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;  
         font-size: x-small ; }  
     td.rfcbug span.hotText { color: #ffffff; font-weight: normal; text-decoration: none;  
         text-align: center ;  
         font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;  
         font-size: x-small ; background-color: #000000; }  
     /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */  
     div#counter{margin-top: 100px}  
   
     a.info{  
         position:relative; /*this is the key*/  
         z-index:24;  
         text-decoration:none}  
   
     a.info:hover{z-index:25; background-color:#990000 ; color: #ffffff ;}  
   
     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:2em; width:15em;  
         padding: 2px ;  
         border:1px solid #333333;  
         background-color:#eeeeee; color:#990000;  
         text-align: left ;}  
   
      A { font-weight: bold; }  
      A:link { color: #990000; background-color: transparent ; }  
      A:visited { color: #333333; background-color: transparent ; }  
      A:active { color: #333333; 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; }  
   
     span.emph { font-style: italic; }  
     span.strong { font-weight: bold; }  
     span.verb, span.vbare { font-family: "Courier New", Courier, monospace ; }  
   
     span.vemph { font-style: italic; font-family: "Courier New", Courier, monospace ; }  
     span.vstrong { font-weight: bold; font-family: "Courier New", Courier, monospace ; }  
     span.vdeluxe { font-weight: bold; font-style: italic; font-family: "Courier New", Courier, monospace ; }  
   
     ol.text { margin-left: 2em; margin-right: 2em; }  
     ul.text { margin-left: 2em; margin-right: 2em; }  
     li { margin-left: 3em;  }  
   
     pre { margin-left: 3em; color: #333333;  background-color: transparent;  
         font-family: "Courier New", Courier, monospace ; font-size: small ;  
         text-align: left;  
12          }          }
13            h1, h2, h3, h4, h5, h6 {
14                    font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;
15                    font-weight: bold; font-style: normal;
16            }
17            h1 { color: #900; background-color: transparent; text-align: right; }
18            h3 { color: #333; background-color: transparent; }
19    
20      h3 { color: #333333; font-size: medium ;          td.RFCbug {
21          font-family: helvetica, arial, sans-serif ;                  font-size: x-small; text-decoration: none;
22          background-color: transparent; }                  width: 30px; height: 30px; padding-top: 2px;
23      h4 { font-size: small; font-family: helvetica, arial, sans-serif ; }                  text-align: justify; vertical-align: middle;
24                    background-color: #000;
25      table.bug { width: 30px ; height: 15px ; }          }
26      td.bug { color: #ffffff ; background-color: #990000 ;          td.RFCbug span.RFC {
27          text-align: center ; width: 30px ; height: 15px ;                  font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
28           }                  font-weight: bold; color: #666;
29      td.bug A.link2 { color: #ffffff ; font-weight: bold;          }
30          text-decoration: none;          td.RFCbug span.hotText {
31          font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;                  font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
32          font-size: x-small ; background-color: transparent }                  font-weight: normal; text-align: center; color: #FFF;
33            }
34      td.header { color: #ffffff; font-size: x-small ;  
35          font-family: arial, helvetica, sans-serif; vertical-align: top;          table.TOCbug { width: 30px; height: 15px; }
36          background-color: #666666 ; width: 33% ; }          td.TOCbug {
37      td.author { font-weight: bold; margin-left: 4em; font-size: x-small ; }                  text-align: center; width: 30px; height: 15px;
38      td.author-text { font-size: x-small; }                  color: #FFF; background-color: #900;
39      table.full { vertical-align: top ; border-collapse: collapse ;          }
40          border-style: solid solid solid solid ;          td.TOCbug a {
41          border-color: black black black black ;                  font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;
42          font-size: small ; text-align: center ; }                  font-weight: bold; font-size: x-small; text-decoration: none;
43      table.headers, table.none { vertical-align: top ; border-collapse: collapse ;                  color: #FFF; background-color: transparent;
44          border-style: none;          }
45          font-size: small ; text-align: center ; }  
46      table.full th { font-weight: bold ;          td.header {
47          border-style: solid ;                  font-family: arial, helvetica, sans-serif; font-size: x-small;
48          border-color: black black black black ; }                  vertical-align: top; width: 33%;
49      table.headers th { font-weight: bold ;                  color: #FFF; background-color: #666;
50          border-style: none none solid none;          }
51          border-color: black black black black ; }          td.author { font-weight: bold; font-size: x-small; margin-left: 4em; }
52      table.none th { font-weight: bold ;          td.author-text { font-size: x-small; }
53          border-style: none; }  
54      table.full td {          /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */
55          border-style: solid solid solid solid ;          a.info {
56          border-color: #333333 #333333 #333333 #333333 ; }                  /* This is the key. */
57      table.headers td, table.none td { border-style: none; }                  position: relative;
58                    z-index: 24;
59      hr { height: 1px }                  text-decoration: none;
60  -->          }
61  </style>          a.info:hover {
62                    z-index: 25;
63                    color: #FFF; background-color: #900;
64            }
65            a.info span { display: none; }
66            a.info:hover span.info {
67                    /* The span will display just on :hover state. */
68                    display: block;
69                    position: absolute;
70                    font-size: smaller;
71                    top: 2em; left: -5em; width: 15em;
72                    padding: 2px; border: 1px solid #333;
73                    color: #900; background-color: #EEE;
74                    text-align: left;
75            }
76    
77            a { font-weight: bold; }
78            a:link    { color: #900; background-color: transparent; }
79            a:visited { color: #633; background-color: transparent; }
80            a:active  { color: #633; background-color: transparent; }
81    
82            p { margin-left: 2em; margin-right: 2em; }
83            p.copyright { font-size: x-small; }
84            p.toc { font-size: small; font-weight: bold; margin-left: 3em; }
85            table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; }
86            td.toc { font-size: small; font-weight: bold; vertical-align: text-top; }
87    
88            ol.text { margin-left: 2em; margin-right: 2em; }
89            ul.text { margin-left: 2em; margin-right: 2em; }
90            li      { margin-left: 3em; }
91    
92            /* RFC-2629 <spanx>s and <artwork>s. */
93            em     { font-style: italic; }
94            strong { font-weight: bold; }
95            dfn    { font-weight: bold; font-style: normal; }
96            cite   { font-weight: normal; font-style: normal; }
97            tt     { color: #036; }
98            tt, pre, pre dfn, pre em, pre cite, pre span {
99                    font-family: "Courier New", Courier, monospace; font-size: small;
100            }
101            pre {
102                    text-align: left; padding: 4px;
103                    color: #000; background-color: #CCC;
104            }
105            pre dfn  { color: #900; }
106            pre em   { color: #66F; background-color: #FFC; font-weight: normal; }
107            pre .key { color: #33C; font-weight: bold; }
108            pre .id  { color: #900; }
109            pre .str { color: #000; background-color: #CFF; }
110            pre .val { color: #066; }
111            pre .rep { color: #909; }
112            pre .oth { color: #000; background-color: #FCF; }
113            pre .err { background-color: #FCC; }
114    
115            /* RFC-2629 <texttable>s. */
116            table.all, table.full, table.headers, table.none {
117                    font-size: small; text-align: center; border-width: 2px;
118                    vertical-align: top; border-collapse: collapse;
119            }
120            table.all, table.full { border-style: solid; border-color: black; }
121            table.headers, table.none { border-style: none; }
122            th {
123                    font-weight: bold; border-color: black;
124                    border-width: 2px 2px 3px 2px;
125            }
126            table.all th, table.full th { border-style: solid; }
127            table.headers th { border-style: none none solid none; }
128            table.none th { border-style: none; }
129            table.all td {
130                    border-style: solid; border-color: #333;
131                    border-width: 1px 2px;
132            }
133            table.full td, table.headers td, table.none td { border-style: none; }
134    
135            hr { height: 1px; }
136            hr.insert {
137                    width: 80%; border-style: none; border-width: 0;
138                    color: #CCC; background-color: #CCC;
139            }
140    --></style>
141  </head>  </head>
142  <body>  <body>
143  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
144  <table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1">  <table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1">
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">Expires: May 29, 2007</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">&nbsp;</td><td class="header">November 25, 2006</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  <div align="right"><span class="title"><br />LinuxSampler Control Protocol</span></div>  <h1><br />LinuxSampler Control Protocol<br />LSCP 1.2</h1>
 <div align="right"><span class="title"><br />LSCP 1.1</span></div>  
151    
152  <h3>Status of this Memo</h3>  <h3>Status of this Memo</h3>
153  <p>  <p>
154  This document is an Internet-Draft and is  By submitting this Internet-Draft,
155  in full conformance with all provisions of Section&nbsp;10 of RFC&nbsp;2026.</p>  each author represents that any applicable patent or other IPR claims of which
156    he or she is aware have been or will be disclosed,
157    and any of which he or she becomes aware will be disclosed,
158    in accordance with Section&nbsp;6 of BCP&nbsp;79.</p>
159  <p>  <p>
160  Internet-Drafts are working documents of the Internet Engineering  Internet-Drafts are working documents of the Internet Engineering
161  Task Force (IETF), its areas, and its working groups.  Task Force (IETF), its areas, and its working groups.
# Line 153  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 May 29, 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>
180  Copyright &copy; The Internet Society (2006). All Rights Reserved.</p>  Copyright &copy; The IETF Trust (2007).</p>
181    
182  <h3>Abstract</h3>  <h3>Abstract</h3>
183    
# Line 278  Current number of active disk streams<br Line 298  Current number of active disk streams<br
298  Current fill state of disk stream buffers<br />  Current fill state of disk stream buffers<br />
299  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_DEVICE">6.4.14.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_DEVICE">6.4.14.</a>&nbsp;
300  Setting audio output device<br />  Setting audio output device<br />
301  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_TYP">6.4.15.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_TYPE">6.4.15.</a>&nbsp;
302  Setting audio output type<br />  Setting audio output type<br />
303  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_CHANNEL">6.4.16.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_CHANNEL">6.4.16.</a>&nbsp;
304  Setting audio output channel<br />  Setting audio output channel<br />
# Line 296  Setting channel volume<br /> Line 316  Setting channel volume<br />
316  Muting a sampler channel<br />  Muting a sampler channel<br />
317  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL SOLO">6.4.23.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL SOLO">6.4.23.</a>&nbsp;
318  Soloing a sampler channel<br />  Soloing a sampler channel<br />
319  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.24.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INSTRUMENT_MAP">6.4.24.</a>&nbsp;
320    Assigning a MIDI instrument map to a sampler channel<br />
321    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE FX_SEND">6.4.25.</a>&nbsp;
322    Adding an effect send to a sampler channel<br />
323    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY FX_SEND">6.4.26.</a>&nbsp;
324    Removing an effect send from a sampler channel<br />
325    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SENDS">6.4.27.</a>&nbsp;
326    Getting amount of effect sends on a sampler channel<br />
327    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST FX_SENDS">6.4.28.</a>&nbsp;
328    Listing all effect sends on a sampler channel<br />
329    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SEND INFO">6.4.29.</a>&nbsp;
330    Getting effect send information<br />
331    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND NAME">6.4.30.</a>&nbsp;
332    Changing effect send's name<br />
333    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a>&nbsp;
334    Altering effect send's audio routing<br />
335    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.32.</a>&nbsp;
336    Altering effect send's MIDI controller<br />
337    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.33.</a>&nbsp;
338    Altering effect send's send level<br />
339    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.34.</a>&nbsp;
340  Resetting a sampler channel<br />  Resetting a sampler channel<br />
341  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;
342  Controlling connection<br />  Controlling connection<br />
# Line 318  Maximum amount of active voices<br /> Line 358  Maximum amount of active voices<br />
358  Reset sampler<br />  Reset sampler<br />
359  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.4.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.4.</a>&nbsp;
360  General sampler informations<br />  General sampler informations<br />
361    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET VOLUME">6.6.5.</a>&nbsp;
362    Getting global volume attenuation<br />
363    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOLUME">6.6.6.</a>&nbsp;
364    Setting global volume attenuation<br />
365    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#MIDI Instrument Mapping">6.7.</a>&nbsp;
366    MIDI Instrument Mapping<br />
367    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD MIDI_INSTRUMENT MAP">6.7.1.</a>&nbsp;
368    Create a new MIDI instrument map<br />
369    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a>&nbsp;
370    Delete one particular or all MIDI instrument maps<br />
371    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT_MAPS">6.7.3.</a>&nbsp;
372    Get amount of existing MIDI instrument maps<br />
373    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INSTRUMENT_MAPS">6.7.4.</a>&nbsp;
374    Getting all created MIDI instrument maps<br />
375    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT_MAP INFO">6.7.5.</a>&nbsp;
376    Getting MIDI instrument map information<br />
377    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INSTRUMENT_MAP NAME">6.7.6.</a>&nbsp;
378    Renaming a MIDI instrument map<br />
379    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MAP MIDI_INSTRUMENT">6.7.7.</a>&nbsp;
380    Create or replace a MIDI instrument map entry<br />
381    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENTS">6.7.8.</a>&nbsp;
382    Getting ammount of MIDI instrument map entries<br />
383    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INSTRUMENTS">6.7.9.</a>&nbsp;
384    Getting indeces of all entries of a MIDI instrument map<br />
385    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#UNMAP MIDI_INSTRUMENT">6.7.10.</a>&nbsp;
386    Remove an entry from the MIDI instrument map<br />
387    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT INFO">6.7.11.</a>&nbsp;
388    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;
390    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;
438  Events<br />  Events<br />
439  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL">8.1.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a>&nbsp;
440    Number of audio output devices changed<br />
441    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">8.2.</a>&nbsp;
442    Audio output device's settings changed<br />
443    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">8.3.</a>&nbsp;
444    Number of MIDI input devices changed<br />
445    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INPUT_DEVICE_INFO">8.4.</a>&nbsp;
446    MIDI input device's settings changed<br />
447    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a>&nbsp;
448  Number of sampler channels changed<br />  Number of sampler channels changed<br />
449  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.2.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.6.</a>&nbsp;
450  Number of active voices changed<br />  Number of active voices changed<br />
451  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">8.3.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">8.7.</a>&nbsp;
452  Number of active disk streams changed<br />  Number of active disk streams changed<br />
453  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">8.4.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">8.8.</a>&nbsp;
454  Disk stream buffer fill state changed<br />  Disk stream buffer fill state changed<br />
455  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE INFO">8.5.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_INFO">8.9.</a>&nbsp;
456  Channel information changed<br />  Channel information changed<br />
457  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.6.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_COUNT">8.10.</a>&nbsp;
458    Number of effect sends changed<br />
459    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_INFO">8.11.</a>&nbsp;
460    Effect send information changed<br />
461    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a>&nbsp;
462  Total number of active voices changed<br />  Total number of active voices changed<br />
463  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.7.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.13.</a>&nbsp;
464    Number of MIDI instrument maps changed<br />
465    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.14.</a>&nbsp;
466    MIDI instrument map information changed<br />
467    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.15.</a>&nbsp;
468    Number of MIDI instruments changed<br />
469    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.16.</a>&nbsp;
470    MIDI instrument information changed<br />
471    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a>&nbsp;
472    Global settings changed<br />
473    &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 350  Intellectual Property and Copyright Stat Line 496  Intellectual Property and Copyright Stat
496  <br clear="all" />  <br clear="all" />
497    
498  <a name="anchor1"></a><br /><hr />  <a name="anchor1"></a><br /><hr />
499  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
500  <a name="rfc.section.1"></a><h3>1.&nbsp;Requirements notation</h3>  <a name="rfc.section.1"></a><h3>1.&nbsp;
501    Requirements notation</h3>
502    
503  <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",  <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
504              "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",              "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
505              and "OPTIONAL" in this document are to be interpreted as              and "OPTIONAL" in this document are to be interpreted as
506              described in <a class="info" href="#RFC2119">[RFC2119]<span> (</span><span class="info">Bradner, S., &ldquo;Key words for use in RFCs to Indicate Requirement Levels,&rdquo; 1997.</span><span>)</span></a>.              described in <a class='info' href='#RFC2119'>[RFC2119]<span> (</span><span class='info'>Bradner, S., &ldquo;Key words for use in RFCs to Indicate Requirement Levels,&rdquo; 1997.</span><span>)</span></a>.
507  </p>  </p>
508  <p>This protocol is always case-sensitive if not explicitly  <p>This protocol is always case-sensitive if not explicitly
509              claimed the opposite.              claimed the opposite.
# Line 432  Intellectual Property and Copyright Stat Line 579  Intellectual Property and Copyright Stat
579              return and line feed characters respectively.              return and line feed characters respectively.
580  </p>  </p>
581  <a name="LSCP versioning"></a><br /><hr />  <a name="LSCP versioning"></a><br /><hr />
582  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
583  <a name="rfc.section.2"></a><h3>2.&nbsp;Versioning of this specification</h3>  <a name="rfc.section.2"></a><h3>2.&nbsp;
584    Versioning of this specification</h3>
585    
586  <p>LSCP will certainly be extended and enhanced by-and-by. Each official  <p>LSCP will certainly be extended and enhanced by-and-by. Each official
587              release of the LSCP specification will be tagged with a unique version              release of the LSCP specification will be tagged with a unique version
# Line 476  Intellectual Property and Copyright Stat Line 624  Intellectual Property and Copyright Stat
624  <p>  <p>
625              Compatibility can only be claimed if both rules are true.              Compatibility can only be claimed if both rules are true.
626              The frontend can use the              The frontend can use the
627              <a class="info" href="#GET SERVER INFO">"GET SERVER INFO"<span> (</span><span class="info">General sampler informations</span><span>)</span></a> command to              <a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a> command to
628              get the version of the LSCP specification the sampler complies with.              get the version of the LSCP specification the sampler complies with.
629                            
630  </p>  </p>
631  <a name="anchor2"></a><br /><hr />  <a name="anchor2"></a><br /><hr />
632  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
633  <a name="rfc.section.3"></a><h3>3.&nbsp;Introduction</h3>  <a name="rfc.section.3"></a><h3>3.&nbsp;
634    Introduction</h3>
635    
636  <p>LinuxSampler is a so called software sampler application  <p>LinuxSampler is a so called software sampler application
637              capable to playback audio samples from a computer's Random              capable to playback audio samples from a computer's Random
# Line 502  Intellectual Property and Copyright Stat Line 651  Intellectual Property and Copyright Stat
651              there.              there.
652  </p>  </p>
653  <a name="anchor3"></a><br /><hr />  <a name="anchor3"></a><br /><hr />
654  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
655  <a name="rfc.section.4"></a><h3>4.&nbsp;Focus of this protocol</h3>  <a name="rfc.section.4"></a><h3>4.&nbsp;
656    Focus of this protocol</h3>
657    
658  <p>Main focus of this protocol is to provide a way to configure  <p>Main focus of this protocol is to provide a way to configure
659              a running LinuxSampler instance and to retrieve information              a running LinuxSampler instance and to retrieve information
# Line 514  Intellectual Property and Copyright Stat Line 664  Intellectual Property and Copyright Stat
664              via MIDI System Exclusive Messages.              via MIDI System Exclusive Messages.
665  </p>  </p>
666  <a name="anchor4"></a><br /><hr />  <a name="anchor4"></a><br /><hr />
667  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
668  <a name="rfc.section.5"></a><h3>5.&nbsp;Communication Overview</h3>  <a name="rfc.section.5"></a><h3>5.&nbsp;
669    Communication Overview</h3>
670    
671  <p>There are two distinct methods of communication between a  <p>There are two distinct methods of communication between a
672              running instance of LinuxSampler and one or more control              running instance of LinuxSampler and one or more control
# Line 529  Intellectual Property and Copyright Stat Line 680  Intellectual Property and Copyright Stat
680              methods will be described next.              methods will be described next.
681  </p>  </p>
682  <a name="anchor5"></a><br /><hr />  <a name="anchor5"></a><br /><hr />
683  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
684  <a name="rfc.section.5.1"></a><h3>5.1.&nbsp;Request/response communication method</h3>  <a name="rfc.section.5.1"></a><h3>5.1.&nbsp;
685    Request/response communication method</h3>
686    
687  <p>This simple communication method is based on  <p>This simple communication method is based on
688                  <a class="info" href="#RFC793">TCP<span> (</span><span class="info">Defense Advanced Research Projects Agency, &ldquo;TRANSMISSION CONTROL PROTOCOL,&rdquo; 1981.</span><span>)</span></a> [RFC793]. The                  <a class='info' href='#RFC793'>TCP<span> (</span><span class='info'>Defense Advanced Research Projects Agency, &ldquo;TRANSMISSION CONTROL PROTOCOL,&rdquo; 1981.</span><span>)</span></a> [RFC793]. The
689                  front-end application establishes a TCP connection to the                  front-end application establishes a TCP connection to the
690                  LinuxSampler instance on a certain host system. Then the                  LinuxSampler instance on a certain host system. Then the
691                  front-end application will send certain ASCII based commands                  front-end application will send certain ASCII based commands
# Line 574  Intellectual Property and Copyright Stat Line 726  Intellectual Property and Copyright Stat
726                  MUST be sent back in the same order.                  MUST be sent back in the same order.
727  </p>  </p>
728  <a name="anchor6"></a><br /><hr />  <a name="anchor6"></a><br /><hr />
729  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
730  <a name="rfc.section.5.1.1"></a><h3>5.1.1.&nbsp;Result format</h3>  <a name="rfc.section.5.1.1"></a><h3>5.1.1.&nbsp;
731    Result format</h3>
732    
733  <p>Result set could be one of the following types:  <p>Result set could be one of the following types:
734  </p>  </p>
# Line 766  Intellectual Property and Copyright Stat Line 919  Intellectual Property and Copyright Stat
919                                            
920  </p>  </p>
921  <a name="anchor7"></a><br /><hr />  <a name="anchor7"></a><br /><hr />
922  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
923  <a name="rfc.section.5.2"></a><h3>5.2.&nbsp;Subscribe/notify communication method</h3>  <a name="rfc.section.5.2"></a><h3>5.2.&nbsp;
924    Subscribe/notify communication method</h3>
925    
926  <p>This more sophisticated communication method is actually  <p>This more sophisticated communication method is actually
927                  only an extension of the simple request/response                  only an extension of the simple request/response
# Line 844  Intellectual Property and Copyright Stat Line 998  Intellectual Property and Copyright Stat
998  </p>  </p>
999  <p>where &lt;event-id&gt; will be replace by the respective  <p>where &lt;event-id&gt; will be replace by the respective
1000                  event that client is no longer interested in receiving. For                  event that client is no longer interested in receiving. For
1001                  a list of supported events see <a class="info" href="#events">Section&nbsp;8<span> (</span><span class="info">Events</span><span>)</span></a>.                  a list of supported events see <a class='info' href='#events'>Section&nbsp;8<span> (</span><span class='info'>Events</span><span>)</span></a>.
1002  </p>  </p>
1003  <p>Example: the fill states of disk stream buffers have  <p>Example: the fill states of disk stream buffers have
1004                  changed on sampler channel 4 and the LinuxSampler instance                  changed on sampler channel 4 and the LinuxSampler instance
# Line 890  Intellectual Property and Copyright Stat Line 1044  Intellectual Property and Copyright Stat
1044                  it wants to receive.                  it wants to receive.
1045  </p>  </p>
1046  <a name="control_commands"></a><br /><hr />  <a name="control_commands"></a><br /><hr />
1047  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
1048  <a name="rfc.section.6"></a><h3>6.&nbsp;Description for control commands</h3>  <a name="rfc.section.6"></a><h3>6.&nbsp;
1049    Description for control commands</h3>
1050    
1051  <p>This chapter will describe the available control commands  <p>This chapter will describe the available control commands
1052              that can be sent on the TCP connection in detail. Some certain              that can be sent on the TCP connection in detail. Some certain
1053              commands (e.g. <a class="info" href="#GET CHANNEL INFO">"GET CHANNEL INFO"<span> (</span><span class="info">Getting sampler channel information</span><span>)</span></a>              commands (e.g. <a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
1054              or <a class="info" href="#GET ENGINE INFO">"GET ENGINE INFO"<span> (</span><span class="info">Getting information about an engine</span><span>)</span></a>) lead to              or <a class='info' href='#GET ENGINE INFO'>"GET ENGINE INFO"<span> (</span><span class='info'>Getting information about an engine</span><span>)</span></a>) lead to
1055              multiple-line responses. In this case LinuxSampler signals the              multiple-line responses. In this case LinuxSampler signals the
1056              end of the response by a "." (single dot) line.              end of the response by a "." (single dot) line.
1057  </p>  </p>
1058  <a name="anchor8"></a><br /><hr />  <a name="anchor8"></a><br /><hr />
1059  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
1060  <a name="rfc.section.6.1"></a><h3>6.1.&nbsp;Ignored lines and comments</h3>  <a name="rfc.section.6.1"></a><h3>6.1.&nbsp;
1061    Ignored lines and comments</h3>
1062    
1063  <p>White lines, that is lines which only contain space and  <p>White lines, that is lines which only contain space and
1064                  tabulator characters, and lines that start with a "#"                  tabulator characters, and lines that start with a "#"
# Line 911  Intellectual Property and Copyright Stat Line 1067  Intellectual Property and Copyright Stat
1067                  file.                  file.
1068  </p>  </p>
1069  <a name="anchor9"></a><br /><hr />  <a name="anchor9"></a><br /><hr />
1070  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
1071  <a name="rfc.section.6.2"></a><h3>6.2.&nbsp;Configuring audio drivers</h3>  <a name="rfc.section.6.2"></a><h3>6.2.&nbsp;
1072    Configuring audio drivers</h3>
1073    
1074  <p>Instances of drivers in LinuxSampler are called devices.  <p>Instances of drivers in LinuxSampler are called devices.
1075                  You can use multiple audio devices simultaneously, e.g. to                  You can use multiple audio devices simultaneously, e.g. to
# Line 946  Intellectual Property and Copyright Stat Line 1103  Intellectual Property and Copyright Stat
1103                  possible values, etc.                  possible values, etc.
1104  </p>  </p>
1105  <a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />  <a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />
1106  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
1107  <a name="rfc.section.6.2.1"></a><h3>6.2.1.&nbsp;Getting amount of available audio output drivers</h3>  <a name="rfc.section.6.2.1"></a><h3>6.2.1.&nbsp;
1108    Getting amount of available audio output drivers</h3>
1109    
1110  <p>Use the following command to get the number of  <p>Use the following command to get the number of
1111                      audio output drivers currently available for the                      audio output drivers currently available for the
# Line 985  Intellectual Property and Copyright Stat Line 1143  Intellectual Property and Copyright Stat
1143                                            
1144  </p>  </p>
1145  <a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />  <a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />
1146  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
1147  <a name="rfc.section.6.2.2"></a><h3>6.2.2.&nbsp;Getting all available audio output drivers</h3>  <a name="rfc.section.6.2.2"></a><h3>6.2.2.&nbsp;
1148    Getting all available audio output drivers</h3>
1149    
1150  <p>Use the following command to list all audio output  <p>Use the following command to list all audio output
1151                      drivers currently available for the LinuxSampler                      drivers currently available for the LinuxSampler
# Line 1025  Intellectual Property and Copyright Stat Line 1184  Intellectual Property and Copyright Stat
1184                                            
1185  </p>  </p>
1186  <a name="GET AUDIO_OUTPUT_DRIVER INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DRIVER INFO"></a><br /><hr />
1187  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
1188  <a name="rfc.section.6.2.3"></a><h3>6.2.3.&nbsp;Getting information about a specific audio  <a name="rfc.section.6.2.3"></a><h3>6.2.3.&nbsp;
1189    Getting information about a specific audio
1190                  output driver</h3>                  output driver</h3>
1191    
1192  <p>Use the following command to get detailed information  <p>Use the following command to get detailed information
# Line 1043  Intellectual Property and Copyright Stat Line 1203  Intellectual Property and Copyright Stat
1203  </p>  </p>
1204  <p>Where &lt;audio-output-driver&gt; is the name of the  <p>Where &lt;audio-output-driver&gt; is the name of the
1205                      audio output driver, returned by the                      audio output driver, returned by the
1206                      <a class="info" href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class="info">Getting all available audio output drivers</span><span>)</span></a> command.                      <a class='info' href='#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS'>"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class='info'>Getting all available audio output drivers</span><span>)</span></a> command.
1207  </p>  </p>
1208  <p>Possible Answers:  <p>Possible Answers:
1209  </p>  </p>
# Line 1124  Intellectual Property and Copyright Stat Line 1284  Intellectual Property and Copyright Stat
1284                                            
1285  </p>  </p>
1286  <a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"></a><br /><hr />
1287  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
1288  <a name="rfc.section.6.2.4"></a><h3>6.2.4.&nbsp;Getting information about specific audio  <a name="rfc.section.6.2.4"></a><h3>6.2.4.&nbsp;
1289    Getting information about specific audio
1290                  output driver parameter</h3>                  output driver parameter</h3>
1291    
1292  <p>Use the following command to get detailed information  <p>Use the following command to get detailed information
# Line 1140  Intellectual Property and Copyright Stat Line 1301  Intellectual Property and Copyright Stat
1301                                            
1302  </p>  </p>
1303  <p>Where &lt;audio&gt; is the name of the audio output  <p>Where &lt;audio&gt; is the name of the audio output
1304                      driver as returned by the <a class="info" href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class="info">Getting all available audio output drivers</span><span>)</span></a> command,                      driver as returned by the <a class='info' href='#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS'>"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class='info'>Getting all available audio output drivers</span><span>)</span></a> command,
1305                      &lt;prm&gt; a specific parameter name for which information should be                      &lt;prm&gt; a specific parameter name for which information should be
1306                      obtained (as returned by the                      obtained (as returned by the
1307                      <a class="info" href="#GET AUDIO_OUTPUT_DRIVER INFO">"GET AUDIO_OUTPUT_DRIVER INFO"<span> (</span><span class="info">Getting information about a specific audio                 output driver</span><span>)</span></a> command) and                      <a class='info' href='#GET AUDIO_OUTPUT_DRIVER INFO'>"GET AUDIO_OUTPUT_DRIVER INFO"<span> (</span><span class='info'>Getting information about a specific audio                 output driver</span><span>)</span></a> command) and
1308                      &lt;deplist&gt; is an optional list of parameters on which the sought                      &lt;deplist&gt; is an optional list of parameters on which the sought
1309                      parameter &lt;prm&gt; depends on, &lt;deplist&gt; is a list of key-value                      parameter &lt;prm&gt; depends on, &lt;deplist&gt; is a list of key-value
1310                      pairs in form of "key1=val1 key2=val2 ...", where character string values                      pairs in form of "key1=val1 key2=val2 ...", where character string values
# Line 1200  Intellectual Property and Copyright Stat Line 1361  Intellectual Property and Copyright Stat
1361  <blockquote class="text">  <blockquote class="text">
1362  <p>either true or false, defines if this parameter must be  <p>either true or false, defines if this parameter must be
1363                                  given when the device is to be created with the                                  given when the device is to be created with the
1364                                  <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a>                                  <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>'CREATE AUDIO_OUTPUT_DEVICE'<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
1365                                  command (always returned, no matter which driver parameter)                                  command (always returned, no matter which driver parameter)
1366  </p>  </p>
1367  </blockquote>  </blockquote>
# Line 1211  Intellectual Property and Copyright Stat Line 1372  Intellectual Property and Copyright Stat
1372  <blockquote class="text">  <blockquote class="text">
1373  <p>either true or false, if false then this parameter can  <p>either true or false, if false then this parameter can
1374                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
1375                                  the <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a>                                  the <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>'CREATE AUDIO_OUTPUT_DEVICE'<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
1376                                  command (always returned, no matter which driver parameter)                                  command (always returned, no matter which driver parameter)
1377  </p>  </p>
1378  </blockquote>  </blockquote>
# Line 1250  Intellectual Property and Copyright Stat Line 1411  Intellectual Property and Copyright Stat
1411  <blockquote class="text">  <blockquote class="text">
1412  <p>reflects the default value for this parameter which is  <p>reflects the default value for this parameter which is
1413                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
1414                                  given with the <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a> command,                                  given with the <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>'CREATE AUDIO_OUTPUT_DEVICE'<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a> command,
1415                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
1416                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
1417                                  apostrophes (')                                  apostrophes (')
# Line 1378  Intellectual Property and Copyright Stat Line 1539  Intellectual Property and Copyright Stat
1539                                            
1540  </p>  </p>
1541  <a name="CREATE AUDIO_OUTPUT_DEVICE"></a><br /><hr />  <a name="CREATE AUDIO_OUTPUT_DEVICE"></a><br /><hr />
1542  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
1543  <a name="rfc.section.6.2.5"></a><h3>6.2.5.&nbsp;Creating an audio output device</h3>  <a name="rfc.section.6.2.5"></a><h3>6.2.5.&nbsp;
1544    Creating an audio output device</h3>
1545    
1546  <p>Use the following command to create a new audio output device for  the desired audio output system:  <p>Use the following command to create a new audio output device for  the desired audio output system:
1547  </p>  </p>
# Line 1393  Intellectual Property and Copyright Stat Line 1555  Intellectual Property and Copyright Stat
1555  </p>  </p>
1556  <p>Where &lt;audio-output-driver&gt; should be replaced by the desired audio  <p>Where &lt;audio-output-driver&gt; should be replaced by the desired audio
1557                      output system as returned by the                      output system as returned by the
1558                      <a class="info" href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class="info">Getting all available audio output drivers</span><span>)</span></a>                      <a class='info' href='#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS'>"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class='info'>Getting all available audio output drivers</span><span>)</span></a>
1559                      command and &lt;param-list&gt; by an optional list of driver                      command and &lt;param-list&gt; by an optional list of driver
1560                      specific parameters in form of "key1=val1 key2=val2 ...", where                      specific parameters in form of "key1=val1 key2=val2 ...", where
1561                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
# Line 1462  Intellectual Property and Copyright Stat Line 1624  Intellectual Property and Copyright Stat
1624                                            
1625  </p>  </p>
1626  <a name="DESTROY AUDIO_OUTPUT_DEVICE"></a><br /><hr />  <a name="DESTROY AUDIO_OUTPUT_DEVICE"></a><br /><hr />
1627  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
1628  <a name="rfc.section.6.2.6"></a><h3>6.2.6.&nbsp;Destroying an audio output device</h3>  <a name="rfc.section.6.2.6"></a><h3>6.2.6.&nbsp;
1629    Destroying an audio output device</h3>
1630    
1631  <p>Use the following command to destroy a created output device:  <p>Use the following command to destroy a created output device:
1632  </p>  </p>
# Line 1477  Intellectual Property and Copyright Stat Line 1640  Intellectual Property and Copyright Stat
1640  </p>  </p>
1641  <p>Where &lt;device-id&gt; should be replaced by the numerical ID of the  <p>Where &lt;device-id&gt; should be replaced by the numerical ID of the
1642                      audio output device as given by the                      audio output device as given by the
1643                      <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a>                      <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
1644                      or <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class="info">Getting all created audio output device list</span><span>)</span></a>                      or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
1645                      command.                      command.
1646  </p>  </p>
1647  <p>Possible Answers:  <p>Possible Answers:
# Line 1531  Intellectual Property and Copyright Stat Line 1694  Intellectual Property and Copyright Stat
1694                                            
1695  </p>  </p>
1696  <a name="GET AUDIO_OUTPUT_DEVICES"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DEVICES"></a><br /><hr />
1697  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
1698  <a name="rfc.section.6.2.7"></a><h3>6.2.7.&nbsp;Getting all created audio output device count</h3>  <a name="rfc.section.6.2.7"></a><h3>6.2.7.&nbsp;
1699    Getting all created audio output device count</h3>
1700    
1701  <p>Use the following command to count all created audio output devices:  <p>Use the following command to count all created audio output devices:
1702  </p>  </p>
# Line 1568  Intellectual Property and Copyright Stat Line 1732  Intellectual Property and Copyright Stat
1732                                            
1733  </p>  </p>
1734  <a name="LIST AUDIO_OUTPUT_DEVICES"></a><br /><hr />  <a name="LIST AUDIO_OUTPUT_DEVICES"></a><br /><hr />
1735  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
1736  <a name="rfc.section.6.2.8"></a><h3>6.2.8.&nbsp;Getting all created audio output device list</h3>  <a name="rfc.section.6.2.8"></a><h3>6.2.8.&nbsp;
1737    Getting all created audio output device list</h3>
1738    
1739  <p>Use the following command to list all created audio output devices:  <p>Use the following command to list all created audio output devices:
1740  </p>  </p>
# Line 1605  Intellectual Property and Copyright Stat Line 1770  Intellectual Property and Copyright Stat
1770                                            
1771  </p>  </p>
1772  <a name="GET AUDIO_OUTPUT_DEVICE INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DEVICE INFO"></a><br /><hr />
1773  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
1774  <a name="rfc.section.6.2.9"></a><h3>6.2.9.&nbsp;Getting current settings of an audio output device</h3>  <a name="rfc.section.6.2.9"></a><h3>6.2.9.&nbsp;
1775    Getting current settings of an audio output device</h3>
1776    
1777  <p>Use the following command to get current settings of a specific, created audio output device:  <p>Use the following command to get current settings of a specific, created audio output device:
1778  </p>  </p>
# Line 1620  Intellectual Property and Copyright Stat Line 1786  Intellectual Property and Copyright Stat
1786  </p>  </p>
1787  <p>Where &lt;device-id&gt; should be replaced by numerical ID  <p>Where &lt;device-id&gt; should be replaced by numerical ID
1788                      of the audio output device as e.g. returned by the                      of the audio output device as e.g. returned by the
1789                      <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class="info">Getting all created audio output device list</span><span>)</span></a> command.                      <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a> command.
1790  </p>  </p>
1791  <p>Possible Answers:  <p>Possible Answers:
1792  </p>  </p>
# Line 1640  Intellectual Property and Copyright Stat Line 1806  Intellectual Property and Copyright Stat
1806  <blockquote class="text">  <blockquote class="text">
1807  <p>identifier of the used audio output driver, as also  <p>identifier of the used audio output driver, as also
1808                                      returned by the                                      returned by the
1809                                      <a class="info" href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class="info">Getting all available audio output drivers</span><span>)</span></a>                                      <a class='info' href='#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS'>"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class='info'>Getting all available audio output drivers</span><span>)</span></a>
1810                                      command                                      command
1811  </p>  </p>
1812  </blockquote>  </blockquote>
# Line 1681  Intellectual Property and Copyright Stat Line 1847  Intellectual Property and Copyright Stat
1847                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
1848                      returned by all audio output devices. Every audio output driver                      returned by all audio output devices. Every audio output driver
1849                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
1850                      <a class="info" href="#GET AUDIO_OUTPUT_DRIVER INFO">Section&nbsp;6.2.3<span> (</span><span class="info">Getting information about a specific audio                 output driver</span><span>)</span></a>)                      <a class='info' href='#GET AUDIO_OUTPUT_DRIVER INFO'>Section&nbsp;6.2.3<span> (</span><span class='info'>Getting information about a specific audio                 output driver</span><span>)</span></a>)
1851                      which are also returned by this command.                      which are also returned by this command.
1852  </p>  </p>
1853  <p>Example:  <p>Example:
# Line 1711  Intellectual Property and Copyright Stat Line 1877  Intellectual Property and Copyright Stat
1877                                            
1878  </p>  </p>
1879  <a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER"></a><br /><hr />  <a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER"></a><br /><hr />
1880  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
1881  <a name="rfc.section.6.2.10"></a><h3>6.2.10.&nbsp;Changing settings of audio output devices</h3>  <a name="rfc.section.6.2.10"></a><h3>6.2.10.&nbsp;
1882    Changing settings of audio output devices</h3>
1883    
1884  <p>Use the following command to alter a specific setting of a created audio output device:  <p>Use the following command to alter a specific setting of a created audio output device:
1885  </p>  </p>
# Line 1726  Intellectual Property and Copyright Stat Line 1893  Intellectual Property and Copyright Stat
1893  </p>  </p>
1894  <p>Where &lt;device-id&gt; should be replaced by the numerical ID of the  <p>Where &lt;device-id&gt; should be replaced by the numerical ID of the
1895                      audio output device as given by the                      audio output device as given by the
1896                      <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a>                      <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
1897                      or <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class="info">Getting all created audio output device list</span><span>)</span></a>                      or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
1898                      command, &lt;key&gt; by the name of the parameter to change                      command, &lt;key&gt; by the name of the parameter to change
1899                      and &lt;value&gt; by the new value for this parameter.                      and &lt;value&gt; by the new value for this parameter.
1900  </p>  </p>
# Line 1779  Intellectual Property and Copyright Stat Line 1946  Intellectual Property and Copyright Stat
1946                                            
1947  </p>  </p>
1948  <a name="GET AUDIO_OUTPUT_CHANNEL INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_CHANNEL INFO"></a><br /><hr />
1949  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
1950  <a name="rfc.section.6.2.11"></a><h3>6.2.11.&nbsp;Getting information about an audio channel</h3>  <a name="rfc.section.6.2.11"></a><h3>6.2.11.&nbsp;
1951    Getting information about an audio channel</h3>
1952    
1953  <p>Use the following command to get information about an audio channel:  <p>Use the following command to get information about an audio channel:
1954  </p>  </p>
# Line 1793  Intellectual Property and Copyright Stat Line 1961  Intellectual Property and Copyright Stat
1961                                            
1962  </p>  </p>
1963  <p>Where &lt;device-id&gt; is the numerical ID of the audio output device as given by the  <p>Where &lt;device-id&gt; is the numerical ID of the audio output device as given by the
1964                      <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a>                      <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
1965                      or <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class="info">Getting all created audio output device list</span><span>)</span></a>                      or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
1966                      command and &lt;audio-chan&gt; the audio channel number.                      command and &lt;audio-chan&gt; the audio channel number.
1967  </p>  </p>
1968  <p>Possible Answers:  <p>Possible Answers:
# Line 1921  Intellectual Property and Copyright Stat Line 2089  Intellectual Property and Copyright Stat
2089                                            
2090  </p>  </p>
2091  <a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"></a><br /><hr />
2092  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
2093  <a name="rfc.section.6.2.12"></a><h3>6.2.12.&nbsp;Getting information about specific audio channel parameter</h3>  <a name="rfc.section.6.2.12"></a><h3>6.2.12.&nbsp;
2094    Getting information about specific audio channel parameter</h3>
2095    
2096  <p>Use the following command to get detailed information about specific audio channel parameter:  <p>Use the following command to get detailed information about specific audio channel parameter:
2097  </p>  </p>
# Line 1935  Intellectual Property and Copyright Stat Line 2104  Intellectual Property and Copyright Stat
2104                                            
2105  </p>  </p>
2106  <p>Where &lt;dev-id&gt; is the numerical ID of the audio output device as returned by the  <p>Where &lt;dev-id&gt; is the numerical ID of the audio output device as returned by the
2107                      <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a>                      <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
2108                      or <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class="info">Getting all created audio output device list</span><span>)</span></a>                      or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
2109                      command, &lt;chan&gt; the audio channel number                      command, &lt;chan&gt; the audio channel number
2110                      and &lt;param&gt; a specific channel parameter name for which information should                      and &lt;param&gt; a specific channel parameter name for which information should
2111                      be obtained (as returned by the <a class="info" href="#GET AUDIO_OUTPUT_CHANNEL INFO">"GET AUDIO_OUTPUT_CHANNEL INFO"<span> (</span><span class="info">Getting information about an audio channel</span><span>)</span></a> command).                      be obtained (as returned by the <a class='info' href='#GET AUDIO_OUTPUT_CHANNEL INFO'>"GET AUDIO_OUTPUT_CHANNEL INFO"<span> (</span><span class='info'>Getting information about an audio channel</span><span>)</span></a> command).
2112  </p>  </p>
2113  <p>Possible Answers:  <p>Possible Answers:
2114  </p>  </p>
# Line 2067  Intellectual Property and Copyright Stat Line 2236  Intellectual Property and Copyright Stat
2236                                            
2237  </p>  </p>
2238  <a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"></a><br /><hr />  <a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"></a><br /><hr />
2239  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
2240  <a name="rfc.section.6.2.13"></a><h3>6.2.13.&nbsp;Changing settings of audio output channels</h3>  <a name="rfc.section.6.2.13"></a><h3>6.2.13.&nbsp;
2241    Changing settings of audio output channels</h3>
2242    
2243  <p>Use the following command to alter a specific setting of an audio output channel:  <p>Use the following command to alter a specific setting of an audio output channel:
2244  </p>  </p>
# Line 2081  Intellectual Property and Copyright Stat Line 2251  Intellectual Property and Copyright Stat
2251                                            
2252  </p>  </p>
2253  <p>Where &lt;dev-id&gt; should be replaced by the numerical ID of the audio output device as returned by the  <p>Where &lt;dev-id&gt; should be replaced by the numerical ID of the audio output device as returned by the
2254                      <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a>                      <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
2255                      or <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class="info">Getting all created audio output device list</span><span>)</span></a>                      or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
2256                      command, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the                      command, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the
2257                      parameter to change and &lt;value&gt; by the new value for this parameter.                      parameter to change and &lt;value&gt; by the new value for this parameter.
2258  </p>  </p>
# Line 2144  Intellectual Property and Copyright Stat Line 2314  Intellectual Property and Copyright Stat
2314                                            
2315  </p>  </p>
2316  <a name="anchor10"></a><br /><hr />  <a name="anchor10"></a><br /><hr />
2317  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
2318  <a name="rfc.section.6.3"></a><h3>6.3.&nbsp;Configuring MIDI input drivers</h3>  <a name="rfc.section.6.3"></a><h3>6.3.&nbsp;
2319    Configuring MIDI input drivers</h3>
2320    
2321  <p>Instances of drivers in LinuxSampler are called devices. You can use  <p>Instances of drivers in LinuxSampler are called devices. You can use
2322                  multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as                  multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as
# Line 2174  Intellectual Property and Copyright Stat Line 2345  Intellectual Property and Copyright Stat
2345                  possible values, etc.                  possible values, etc.
2346  </p>  </p>
2347  <a name="GET AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />  <a name="GET AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />
2348  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
2349  <a name="rfc.section.6.3.1"></a><h3>6.3.1.&nbsp;Getting amount of available MIDI input drivers</h3>  <a name="rfc.section.6.3.1"></a><h3>6.3.1.&nbsp;
2350    Getting amount of available MIDI input drivers</h3>
2351    
2352  <p>Use the following command to get the number of  <p>Use the following command to get the number of
2353                      MIDI input drivers currently available for the                      MIDI input drivers currently available for the
# Line 2213  Intellectual Property and Copyright Stat Line 2385  Intellectual Property and Copyright Stat
2385                                            
2386  </p>  </p>
2387  <a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />  <a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />
2388  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
2389  <a name="rfc.section.6.3.2"></a><h3>6.3.2.&nbsp;Getting all available MIDI input drivers</h3>  <a name="rfc.section.6.3.2"></a><h3>6.3.2.&nbsp;
2390    Getting all available MIDI input drivers</h3>
2391    
2392  <p>Use the following command to list all MIDI input drivers currently available  <p>Use the following command to list all MIDI input drivers currently available
2393                      for the LinuxSampler instance:                      for the LinuxSampler instance:
# Line 2251  Intellectual Property and Copyright Stat Line 2424  Intellectual Property and Copyright Stat
2424                                            
2425  </p>  </p>
2426  <a name="GET MIDI_INPUT_DRIVER INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_DRIVER INFO"></a><br /><hr />
2427  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
2428  <a name="rfc.section.6.3.3"></a><h3>6.3.3.&nbsp;Getting information about a specific MIDI input driver</h3>  <a name="rfc.section.6.3.3"></a><h3>6.3.3.&nbsp;
2429    Getting information about a specific MIDI input driver</h3>
2430    
2431  <p>Use the following command to get detailed information about a specific MIDI input driver:  <p>Use the following command to get detailed information about a specific MIDI input driver:
2432  </p>  </p>
# Line 2265  Intellectual Property and Copyright Stat Line 2439  Intellectual Property and Copyright Stat
2439                                            
2440  </p>  </p>
2441  <p>Where &lt;midi-input-driver&gt; is the name of the MIDI input driver as returned  <p>Where &lt;midi-input-driver&gt; is the name of the MIDI input driver as returned
2442                      by the <a class="info" href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class="info">Getting all available MIDI input drivers</span><span>)</span></a> command.                      by the <a class='info' href='#LIST AVAILABLE_MIDI_INPUT_DRIVERS'>"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class='info'>Getting all available MIDI input drivers</span><span>)</span></a> command.
2443  </p>  </p>
2444  <p>Possible Answers:  <p>Possible Answers:
2445  </p>  </p>
# Line 2332  Intellectual Property and Copyright Stat Line 2506  Intellectual Property and Copyright Stat
2506                                            
2507  </p>  </p>
2508  <a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO"></a><br /><hr />
2509  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
2510  <a name="rfc.section.6.3.4"></a><h3>6.3.4.&nbsp;Getting information about specific MIDI input driver parameter</h3>  <a name="rfc.section.6.3.4"></a><h3>6.3.4.&nbsp;
2511    Getting information about specific MIDI input driver parameter</h3>
2512    
2513  <p>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:  <p>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:
2514  </p>  </p>
# Line 2346  Intellectual Property and Copyright Stat Line 2521  Intellectual Property and Copyright Stat
2521                                            
2522  </p>  </p>
2523  <p>Where &lt;midit&gt; is the name of the MIDI input driver as returned  <p>Where &lt;midit&gt; is the name of the MIDI input driver as returned
2524                      by the <a class="info" href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class="info">Getting all available MIDI input drivers</span><span>)</span></a> command, &lt;param&gt; a specific                      by the <a class='info' href='#LIST AVAILABLE_MIDI_INPUT_DRIVERS'>"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class='info'>Getting all available MIDI input drivers</span><span>)</span></a> command, &lt;param&gt; a specific
2525                      parameter name for which information should be obtained (as returned by the                      parameter name for which information should be obtained (as returned by the
2526                      <a class="info" href="#GET MIDI_INPUT_DRIVER INFO">"GET MIDI_INPUT_DRIVER INFO"<span> (</span><span class="info">Getting information about a specific MIDI input driver</span><span>)</span></a> command) and &lt;deplist&gt; is an optional list                      <a class='info' href='#GET MIDI_INPUT_DRIVER INFO'>"GET MIDI_INPUT_DRIVER INFO"<span> (</span><span class='info'>Getting information about a specific MIDI input driver</span><span>)</span></a> command) and &lt;deplist&gt; is an optional list
2527                      of parameters on which the sought parameter &lt;param&gt; depends on,                      of parameters on which the sought parameter &lt;param&gt; depends on,
2528                      &lt;deplist&gt; is a key-value pair list in form of "key1=val1 key2=val2 ...",                      &lt;deplist&gt; is a key-value pair list in form of "key1=val1 key2=val2 ...",
2529                      where character string values are encapsulated into apostrophes ('). Arguments                      where character string values are encapsulated into apostrophes ('). Arguments
# Line 2395  Intellectual Property and Copyright Stat Line 2570  Intellectual Property and Copyright Stat
2570  <blockquote class="text">  <blockquote class="text">
2571  <p>either true or false, defines if this parameter must be  <p>either true or false, defines if this parameter must be
2572                                  given when the device is to be created with the                                  given when the device is to be created with the
2573                                  <a class="info" href="#CREATE MIDI_INPUT_DEVICE">'CREATE MIDI_INPUT_DEVICE'<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a> command                                  <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>'CREATE MIDI_INPUT_DEVICE'<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a> command
2574                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2575  </p>  </p>
2576  </blockquote>  </blockquote>
# Line 2406  Intellectual Property and Copyright Stat Line 2581  Intellectual Property and Copyright Stat
2581  <blockquote class="text">  <blockquote class="text">
2582  <p>either true or false, if false then this parameter can  <p>either true or false, if false then this parameter can
2583                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
2584                                  the <a class="info" href="#CREATE MIDI_INPUT_DEVICE">'CREATE MIDI_INPUT_DEVICE'<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a> command                                  the <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>'CREATE MIDI_INPUT_DEVICE'<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a> command
2585                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2586  </p>  </p>
2587  </blockquote>  </blockquote>
# Line 2445  Intellectual Property and Copyright Stat Line 2620  Intellectual Property and Copyright Stat
2620  <blockquote class="text">  <blockquote class="text">
2621  <p>reflects the default value for this parameter which is  <p>reflects the default value for this parameter which is
2622                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
2623                                  given with the <a class="info" href="#CREATE MIDI_INPUT_DEVICE">'CREATE MIDI_INPUT_DEVICE'<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a> command,                                  given with the <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>'CREATE MIDI_INPUT_DEVICE'<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a> command,
2624                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
2625                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
2626                                  apostrophes (')                                  apostrophes (')
# Line 2519  Intellectual Property and Copyright Stat Line 2694  Intellectual Property and Copyright Stat
2694                                            
2695  </p>  </p>
2696  <a name="CREATE MIDI_INPUT_DEVICE"></a><br /><hr />  <a name="CREATE MIDI_INPUT_DEVICE"></a><br /><hr />
2697  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
2698  <a name="rfc.section.6.3.5"></a><h3>6.3.5.&nbsp;Creating a MIDI input device</h3>  <a name="rfc.section.6.3.5"></a><h3>6.3.5.&nbsp;
2699    Creating a MIDI input device</h3>
2700    
2701  <p>Use the following command to create a new MIDI input device for  the desired MIDI input system:  <p>Use the following command to create a new MIDI input device for  the desired MIDI input system:
2702  </p>  </p>
# Line 2533  Intellectual Property and Copyright Stat Line 2709  Intellectual Property and Copyright Stat
2709                                            
2710  </p>  </p>
2711  <p>Where &lt;midi-input-driver&gt; should be replaced by the desired MIDI input system as returned  <p>Where &lt;midi-input-driver&gt; should be replaced by the desired MIDI input system as returned
2712                      by the <a class="info" href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class="info">Getting all available MIDI input drivers</span><span>)</span></a> command and &lt;param-list&gt; by an                      by the <a class='info' href='#LIST AVAILABLE_MIDI_INPUT_DRIVERS'>"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class='info'>Getting all available MIDI input drivers</span><span>)</span></a> command and &lt;param-list&gt; by an
2713                      optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where                      optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where
2714                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
2715                      Note that there might be drivers which require parameter(s) to be                      Note that there might be drivers which require parameter(s) to be
# Line 2589  Intellectual Property and Copyright Stat Line 2765  Intellectual Property and Copyright Stat
2765                                            
2766  </p>  </p>
2767  <a name="DESTROY MIDI_INPUT_DEVICE"></a><br /><hr />  <a name="DESTROY MIDI_INPUT_DEVICE"></a><br /><hr />
2768  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
2769  <a name="rfc.section.6.3.6"></a><h3>6.3.6.&nbsp;Destroying a MIDI input device</h3>  <a name="rfc.section.6.3.6"></a><h3>6.3.6.&nbsp;
2770    Destroying a MIDI input device</h3>
2771    
2772  <p>Use the following command to destroy a created MIDI input device:  <p>Use the following command to destroy a created MIDI input device:
2773  </p>  </p>
# Line 2603  Intellectual Property and Copyright Stat Line 2780  Intellectual Property and Copyright Stat
2780                                            
2781  </p>  </p>
2782  <p>Where &lt;device-id&gt; should be replaced by the device's numerical ID as returned by the  <p>Where &lt;device-id&gt; should be replaced by the device's numerical ID as returned by the
2783                      <a class="info" href="#CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a>                      <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
2784                      or <a class="info" href="#LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"<span> (</span><span class="info">Getting all created MIDI input device list</span><span>)</span></a>                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
2785                      command.                      command.
2786  </p>  </p>
2787  <p>Possible Answers:  <p>Possible Answers:
# Line 2654  Intellectual Property and Copyright Stat Line 2831  Intellectual Property and Copyright Stat
2831                                            
2832  </p>  </p>
2833  <a name="GET MIDI_INPUT_DEVICES"></a><br /><hr />  <a name="GET MIDI_INPUT_DEVICES"></a><br /><hr />
2834  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
2835  <a name="rfc.section.6.3.7"></a><h3>6.3.7.&nbsp;Getting all created MIDI input device count</h3>  <a name="rfc.section.6.3.7"></a><h3>6.3.7.&nbsp;
2836    Getting all created MIDI input device count</h3>
2837    
2838  <p>Use the following command to count all created MIDI input devices:  <p>Use the following command to count all created MIDI input devices:
2839  </p>  </p>
# Line 2691  Intellectual Property and Copyright Stat Line 2869  Intellectual Property and Copyright Stat
2869                                            
2870  </p>  </p>
2871  <a name="LIST MIDI_INPUT_DEVICES"></a><br /><hr />  <a name="LIST MIDI_INPUT_DEVICES"></a><br /><hr />
2872  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
2873  <a name="rfc.section.6.3.8"></a><h3>6.3.8.&nbsp;Getting all created MIDI input device list</h3>  <a name="rfc.section.6.3.8"></a><h3>6.3.8.&nbsp;
2874    Getting all created MIDI input device list</h3>
2875    
2876  <p>Use the following command to list all created MIDI input devices:  <p>Use the following command to list all created MIDI input devices:
2877  </p>  </p>
# Line 2738  Intellectual Property and Copyright Stat Line 2917  Intellectual Property and Copyright Stat
2917                                            
2918  </p>  </p>
2919  <a name="GET MIDI_INPUT_DEVICE INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_DEVICE INFO"></a><br /><hr />
2920  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
2921  <a name="rfc.section.6.3.9"></a><h3>6.3.9.&nbsp;Getting current settings of a MIDI input device</h3>  <a name="rfc.section.6.3.9"></a><h3>6.3.9.&nbsp;
2922    Getting current settings of a MIDI input device</h3>
2923    
2924  <p>Use the following command to get current settings of a specific, created MIDI input device:  <p>Use the following command to get current settings of a specific, created MIDI input device:
2925  </p>  </p>
# Line 2752  Intellectual Property and Copyright Stat Line 2932  Intellectual Property and Copyright Stat
2932                                            
2933  </p>  </p>
2934  <p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the  <p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
2935                      <a class="info" href="#CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a>                      <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
2936                      or <a class="info" href="#LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"<span> (</span><span class="info">Getting all created MIDI input device list</span><span>)</span></a>                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
2937                      command.                      command.
2938  </p>  </p>
2939  <p>Possible Answers:  <p>Possible Answers:
# Line 2776  Intellectual Property and Copyright Stat Line 2956  Intellectual Property and Copyright Stat
2956                                          </p>                                          </p>
2957  <blockquote class="text">  <blockquote class="text">
2958  <p>identifier of the used MIDI input driver, as e.g.  <p>identifier of the used MIDI input driver, as e.g.
2959                                              returned by the <a class="info" href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class="info">Getting all available MIDI input drivers</span><span>)</span></a>                                              returned by the <a class='info' href='#LIST AVAILABLE_MIDI_INPUT_DRIVERS'>"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class='info'>Getting all available MIDI input drivers</span><span>)</span></a>
2960                                              command                                              command
2961  </p>  </p>
2962  </blockquote>  </blockquote>
# Line 2806  Intellectual Property and Copyright Stat Line 2986  Intellectual Property and Copyright Stat
2986                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
2987                      returned by all MIDI input devices. Every MIDI input driver                      returned by all MIDI input devices. Every MIDI input driver
2988                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
2989                      <a class="info" href="#GET MIDI_INPUT_DRIVER INFO">"GET MIDI_INPUT_DRIVER INFO"<span> (</span><span class="info">Getting information about a specific MIDI input driver</span><span>)</span></a> command) which are also returned                      <a class='info' href='#GET MIDI_INPUT_DRIVER INFO'>"GET MIDI_INPUT_DRIVER INFO"<span> (</span><span class='info'>Getting information about a specific MIDI input driver</span><span>)</span></a> command) which are also returned
2990                      by this command.                      by this command.
2991  </p>  </p>
2992  <p>Example:  <p>Example:
# Line 2826  Intellectual Property and Copyright Stat Line 3006  Intellectual Property and Copyright Stat
3006                                            
3007  </p>  </p>
3008  <a name="SET MIDI_INPUT_DEVICE_PARAMETER"></a><br /><hr />  <a name="SET MIDI_INPUT_DEVICE_PARAMETER"></a><br /><hr />
3009  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
3010  <a name="rfc.section.6.3.10"></a><h3>6.3.10.&nbsp;Changing settings of MIDI input devices</h3>  <a name="rfc.section.6.3.10"></a><h3>6.3.10.&nbsp;
3011    Changing settings of MIDI input devices</h3>
3012    
3013  <p>Use the following command to alter a specific setting of a created MIDI input device:  <p>Use the following command to alter a specific setting of a created MIDI input device:
3014  </p>  </p>
# Line 2841  Intellectual Property and Copyright Stat Line 3022  Intellectual Property and Copyright Stat
3022  </p>  </p>
3023  <p>Where &lt;device-id&gt; should be replaced by the numerical ID of the  <p>Where &lt;device-id&gt; should be replaced by the numerical ID of the
3024                      MIDI input device as returned by the                      MIDI input device as returned by the
3025                      <a class="info" href="#CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a>                      <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
3026                      or <a class="info" href="#LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"<span> (</span><span class="info">Getting all created MIDI input device list</span><span>)</span></a>                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
3027                      command, &lt;key&gt; by the name of the parameter to change and                      command, &lt;key&gt; by the name of the parameter to change and
3028                      &lt;value&gt; by the new value for this parameter.                      &lt;value&gt; by the new value for this parameter.
3029  </p>  </p>
# Line 2893  Intellectual Property and Copyright Stat Line 3074  Intellectual Property and Copyright Stat
3074                                            
3075  </p>  </p>
3076  <a name="GET MIDI_INPUT_PORT INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_PORT INFO"></a><br /><hr />
3077  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
3078  <a name="rfc.section.6.3.11"></a><h3>6.3.11.&nbsp;Getting information about a MIDI port</h3>  <a name="rfc.section.6.3.11"></a><h3>6.3.11.&nbsp;
3079    Getting information about a MIDI port</h3>
3080    
3081  <p>Use the following command to get information about a MIDI port:  <p>Use the following command to get information about a MIDI port:
3082  </p>  </p>
# Line 2907  Intellectual Property and Copyright Stat Line 3089  Intellectual Property and Copyright Stat
3089                                            
3090  </p>  </p>
3091  <p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the  <p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
3092                      <a class="info" href="#CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a>                      <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
3093                      or <a class="info" href="#LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"<span> (</span><span class="info">Getting all created MIDI input device list</span><span>)</span></a>                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
3094                      command and &lt;midi-port&gt; the MIDI input port number.                      command and &lt;midi-port&gt; the MIDI input port number.
3095  </p>  </p>
3096  <p>Possible Answers:  <p>Possible Answers:
# Line 2955  Intellectual Property and Copyright Stat Line 3137  Intellectual Property and Copyright Stat
3137                                            
3138  </p>  </p>
3139  <a name="GET MIDI_INPUT_PORT_PARAMETER INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_PORT_PARAMETER INFO"></a><br /><hr />
3140  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
3141  <a name="rfc.section.6.3.12"></a><h3>6.3.12.&nbsp;Getting information about specific MIDI port parameter</h3>  <a name="rfc.section.6.3.12"></a><h3>6.3.12.&nbsp;
3142    Getting information about specific MIDI port parameter</h3>
3143    
3144  <p>Use the following command to get detailed information about specific MIDI port parameter:  <p>Use the following command to get detailed information about specific MIDI port parameter:
3145  </p>  </p>
# Line 2969  Intellectual Property and Copyright Stat Line 3152  Intellectual Property and Copyright Stat
3152                                            
3153  </p>  </p>
3154  <p>Where &lt;dev-id&gt; is the numerical ID of the MIDI input device as returned by the  <p>Where &lt;dev-id&gt; is the numerical ID of the MIDI input device as returned by the
3155                      <a class="info" href="#CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a>                      <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
3156                      or <a class="info" href="#LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"<span> (</span><span class="info">Getting all created MIDI input device list</span><span>)</span></a>                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
3157                      command, &lt;port&gt; the MIDI port number and                      command, &lt;port&gt; the MIDI port number and
3158                      &lt;param&gt; a specific port parameter name for which information should be                      &lt;param&gt; a specific port parameter name for which information should be
3159                      obtained (as returned by the <a class="info" href="#GET MIDI_INPUT_PORT INFO">"GET MIDI_INPUT_PORT INFO"<span> (</span><span class="info">Getting information about a MIDI port</span><span>)</span></a> command).                      obtained (as returned by the <a class='info' href='#GET MIDI_INPUT_PORT INFO'>"GET MIDI_INPUT_PORT INFO"<span> (</span><span class='info'>Getting information about a MIDI port</span><span>)</span></a> command).
3160  </p>  </p>
3161  <p>Possible Answers:  <p>Possible Answers:
3162  </p>  </p>
# Line 3096  Intellectual Property and Copyright Stat Line 3279  Intellectual Property and Copyright Stat
3279                                            
3280  </p>  </p>
3281  <a name="SET MIDI_INPUT_PORT_PARAMETER"></a><br /><hr />  <a name="SET MIDI_INPUT_PORT_PARAMETER"></a><br /><hr />
3282  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
3283  <a name="rfc.section.6.3.13"></a><h3>6.3.13.&nbsp;Changing settings of MIDI input ports</h3>  <a name="rfc.section.6.3.13"></a><h3>6.3.13.&nbsp;
3284    Changing settings of MIDI input ports</h3>
3285    
3286  <p>Use the following command to alter a specific setting of a MIDI input port:  <p>Use the following command to alter a specific setting of a MIDI input port:
3287  </p>  </p>
# Line 3111  Intellectual Property and Copyright Stat Line 3295  Intellectual Property and Copyright Stat
3295  </p>  </p>
3296  <p>Where &lt;device-id&gt; should be replaced by the numerical ID of the  <p>Where &lt;device-id&gt; should be replaced by the numerical ID of the
3297                      MIDI device as returned by the                      MIDI device as returned by the
3298                      <a class="info" href="#CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a>                      <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
3299                      or <a class="info" href="#LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"<span> (</span><span class="info">Getting all created MIDI input device list</span><span>)</span></a>                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
3300                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
3301                      the parameter to change and &lt;value&gt; by the new value for this                      the parameter to change and &lt;value&gt; by the new value for this
3302                      parameter.                      parameter.
# Line 3162  Intellectual Property and Copyright Stat Line 3346  Intellectual Property and Copyright Stat
3346                                            
3347  </p>  </p>
3348  <a name="anchor11"></a><br /><hr />  <a name="anchor11"></a><br /><hr />
3349  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
3350  <a name="rfc.section.6.4"></a><h3>6.4.&nbsp;Configuring sampler channels</h3>  <a name="rfc.section.6.4"></a><h3>6.4.&nbsp;
3351    Configuring sampler channels</h3>
3352    
3353  <p>The following commands describe how to add and remove sampler channels, associate a  <p>The following commands describe how to add and remove sampler channels, associate a
3354                  sampler channel with a sampler engine, load instruments and connect sampler channels to                  sampler channel with a sampler engine, load instruments and connect sampler channels to
3355                  MIDI and audio devices.                  MIDI and audio devices.
3356  </p>  </p>
3357  <a name="LOAD INSTRUMENT"></a><br /><hr />  <a name="LOAD INSTRUMENT"></a><br /><hr />
3358  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
3359  <a name="rfc.section.6.4.1"></a><h3>6.4.1.&nbsp;Loading an instrument</h3>  <a name="rfc.section.6.4.1"></a><h3>6.4.1.&nbsp;
3360    Loading an instrument</h3>
3361    
3362  <p>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:  <p>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:
3363  </p>  </p>
# Line 3193  Intellectual Property and Copyright Stat Line 3379  Intellectual Property and Copyright Stat
3379                      is that the regular command returns OK only after the instrument has been                      is that the regular command returns OK only after the instrument has been
3380                      fully loaded and the channel is ready to be used while NON_MODAL version                      fully loaded and the channel is ready to be used while NON_MODAL version
3381                      returns immediately and a background process is launched to load the instrument                      returns immediately and a background process is launched to load the instrument
3382                      on the channel. The <a class="info" href="#GET CHANNEL INFO">GET CHANNEL INFO<span> (</span><span class="info">Getting sampler channel information</span><span>)</span></a>                      on the channel. The <a class='info' href='#GET CHANNEL INFO'>GET CHANNEL INFO<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
3383                      command can be used to obtain loading                      command can be used to obtain loading
3384                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks
3385                      such as making sure that the file could be read and it is of a proper format                      such as making sure that the file could be read and it is of a proper format
# Line 3247  Intellectual Property and Copyright Stat Line 3433  Intellectual Property and Copyright Stat
3433                                            
3434  </p>  </p>
3435  <a name="LOAD ENGINE"></a><br /><hr />  <a name="LOAD ENGINE"></a><br /><hr />
3436  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
3437  <a name="rfc.section.6.4.2"></a><h3>6.4.2.&nbsp;Loading a sampler engine</h3>  <a name="rfc.section.6.4.2"></a><h3>6.4.2.&nbsp;
3438    Loading a sampler engine</h3>
3439    
3440  <p>A sampler engine type can be associated to a specific sampler  <p>A sampler engine type can be associated to a specific sampler
3441                      channel by the following command:                      channel by the following command:
# Line 3262  Intellectual Property and Copyright Stat Line 3449  Intellectual Property and Copyright Stat
3449                                            
3450  </p>  </p>
3451  <p>Where &lt;engine-name&gt; is an engine name as obtained by the  <p>Where &lt;engine-name&gt; is an engine name as obtained by the
3452                      <a class="info" href="#LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"<span> (</span><span class="info">Getting all available engines</span><span>)</span></a> command and &lt;sampler-channel&gt;                      <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a> command and &lt;sampler-channel&gt;
3453                      the sampler channel as returned by the                      the sampler channel as returned by the
3454                      <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='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a> or
3455                      <a class="info" href="#LIST CHANNELS">"LIST CHANNELS"<span> (</span><span class="info">Getting all created sampler channel list</span><span>)</span></a> command where                      <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command where
3456                      the engine type should be assigned to. This command should be issued                      the engine type should be assigned to. This command should be issued
3457                      after adding a new sampler channel and before any other control                      after adding a new sampler channel and before any other control
3458                      commands on the new sampler channel. It can also be used to change                      commands on the new sampler channel. It can also be used to change
# Line 3321  Intellectual Property and Copyright Stat Line 3508  Intellectual Property and Copyright Stat
3508                                            
3509  </p>  </p>
3510  <a name="GET CHANNELS"></a><br /><hr />  <a name="GET CHANNELS"></a><br /><hr />
3511  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
3512  <a name="rfc.section.6.4.3"></a><h3>6.4.3.&nbsp;Getting all created sampler channel count</h3>  <a name="rfc.section.6.4.3"></a><h3>6.4.3.&nbsp;
3513    Getting all created sampler channel count</h3>
3514    
3515  <p>The number of sampler channels can change on runtime. To get the  <p>The number of sampler channels can change on runtime. To get the
3516                      current amount of sampler channels, the front-end can send the                      current amount of sampler channels, the front-end can send the
# Line 3359  Intellectual Property and Copyright Stat Line 3547  Intellectual Property and Copyright Stat
3547                                            
3548  </p>  </p>
3549  <a name="LIST CHANNELS"></a><br /><hr />  <a name="LIST CHANNELS"></a><br /><hr />
3550  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
3551  <a name="rfc.section.6.4.4"></a><h3>6.4.4.&nbsp;Getting all created sampler channel list</h3>  <a name="rfc.section.6.4.4"></a><h3>6.4.4.&nbsp;
3552    Getting all created sampler channel list</h3>
3553    
3554  <p>The number of sampler channels can change on runtime. To get the  <p>The number of sampler channels can change on runtime. To get the
3555                      current list of sampler channels, the front-end can send the                      current list of sampler channels, the front-end can send the
# Line 3398  Intellectual Property and Copyright Stat Line 3587  Intellectual Property and Copyright Stat
3587                                            
3588  </p>  </p>
3589  <a name="ADD CHANNEL"></a><br /><hr />  <a name="ADD CHANNEL"></a><br /><hr />
3590  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
3591  <a name="rfc.section.6.4.5"></a><h3>6.4.5.&nbsp;Adding a new sampler channel</h3>  <a name="rfc.section.6.4.5"></a><h3>6.4.5.&nbsp;
3592    Adding a new sampler channel</h3>
3593    
3594  <p>A new sampler channel can be added to the end of the sampler  <p>A new sampler channel can be added to the end of the sampler
3595                      channel list by sending the following command:                      channel list by sending the following command:
# Line 3472  Intellectual Property and Copyright Stat Line 3662  Intellectual Property and Copyright Stat
3662                                            
3663  </p>  </p>
3664  <a name="REMOVE CHANNEL"></a><br /><hr />  <a name="REMOVE CHANNEL"></a><br /><hr />
3665  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
3666  <a name="rfc.section.6.4.6"></a><h3>6.4.6.&nbsp;Removing a sampler channel</h3>  <a name="rfc.section.6.4.6"></a><h3>6.4.6.&nbsp;
3667    Removing a sampler channel</h3>
3668    
3669  <p>A sampler channel can be removed by sending the following command:  <p>A sampler channel can be removed by sending the following command:
3670  </p>  </p>
# Line 3487  Intellectual Property and Copyright Stat Line 3678  Intellectual Property and Copyright Stat
3678  </p>  </p>
3679  <p>Where &lt;sampler-channel&gt; should be replaced by the  <p>Where &lt;sampler-channel&gt; should be replaced by the
3680                      number of the sampler channel as given by the                      number of the sampler channel as given by the
3681                      <a class="info" href="#ADD CHANNEL">"ADD CHANNEL"<span> (</span><span class="info">Adding a new sampler channel</span><span>)</span></a>                      <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
3682                      or <a class="info" href="#LIST CHANNELS">"LIST CHANNELS"<span> (</span><span class="info">Getting all created sampler channel list</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>
3683                      command. The channel numbers of all subsequent sampler channels                      command. The channel numbers of all subsequent sampler channels
3684                      remain the same.                      remain the same.
3685  </p>  </p>
# Line 3538  Intellectual Property and Copyright Stat Line 3729  Intellectual Property and Copyright Stat
3729                                            
3730  </p>  </p>
3731  <a name="GET AVAILABLE_ENGINES"></a><br /><hr />  <a name="GET AVAILABLE_ENGINES"></a><br /><hr />
3732  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
3733  <a name="rfc.section.6.4.7"></a><h3>6.4.7.&nbsp;Getting amount of available engines</h3>  <a name="rfc.section.6.4.7"></a><h3>6.4.7.&nbsp;
3734    Getting amount of available engines</h3>
3735    
3736  <p>The front-end can ask for the number of available engines by sending the following command:  <p>The front-end can ask for the number of available engines by sending the following command:
3737  </p>  </p>
# Line 3574  Intellectual Property and Copyright Stat Line 3766  Intellectual Property and Copyright Stat
3766                                            
3767  </p>  </p>
3768  <a name="LIST AVAILABLE_ENGINES"></a><br /><hr />  <a name="LIST AVAILABLE_ENGINES"></a><br /><hr />
3769  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
3770  <a name="rfc.section.6.4.8"></a><h3>6.4.8.&nbsp;Getting all available engines</h3>  <a name="rfc.section.6.4.8"></a><h3>6.4.8.&nbsp;
3771    Getting all available engines</h3>
3772    
3773  <p>The front-end can ask for a list of all available engines by sending the following command:  <p>The front-end can ask for a list of all available engines by sending the following command:
3774  </p>  </p>
# Line 3613  Intellectual Property and Copyright Stat Line 3806  Intellectual Property and Copyright Stat
3806                                            
3807  </p>  </p>
3808  <a name="GET ENGINE INFO"></a><br /><hr />  <a name="GET ENGINE INFO"></a><br /><hr />
3809  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
3810  <a name="rfc.section.6.4.9"></a><h3>6.4.9.&nbsp;Getting information about an engine</h3>  <a name="rfc.section.6.4.9"></a><h3>6.4.9.&nbsp;
3811    Getting information about an engine</h3>
3812    
3813  <p>The front-end can ask for information about a specific engine by  <p>The front-end can ask for information about a specific engine by
3814                      sending the following command:                      sending the following command:
# Line 3628  Intellectual Property and Copyright Stat Line 3822  Intellectual Property and Copyright Stat
3822                                            
3823  </p>  </p>
3824  <p>Where &lt;engine-name&gt; is an engine name as obtained by the  <p>Where &lt;engine-name&gt; is an engine name as obtained by the
3825                      <a class="info" href="#LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"<span> (</span><span class="info">Getting all available engines</span><span>)</span></a> command.                      <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a> command.
3826  </p>  </p>
3827  <p>Possible Answers:  <p>Possible Answers:
3828  </p>  </p>
# Line 3685  Intellectual Property and Copyright Stat Line 3879  Intellectual Property and Copyright Stat
3879                                            
3880  </p>  </p>
3881  <a name="GET CHANNEL INFO"></a><br /><hr />  <a name="GET CHANNEL INFO"></a><br /><hr />
3882  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
3883  <a name="rfc.section.6.4.10"></a><h3>6.4.10.&nbsp;Getting sampler channel information</h3>  <a name="rfc.section.6.4.10"></a><h3>6.4.10.&nbsp;
3884    Getting sampler channel information</h3>
3885    
3886  <p>The front-end can ask for the current settings of a sampler channel  <p>The front-end can ask for the current settings of a sampler channel
3887                      by sending the following command:                      by sending the following command:
# Line 3700  Intellectual Property and Copyright Stat Line 3895  Intellectual Property and Copyright Stat
3895                                            
3896  </p>  </p>
3897  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
3898                      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>                      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>
3899                      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.                      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.
3900  </p>  </p>
3901  <p>Possible Answers:  <p>Possible Answers:
3902  </p>  </p>
# Line 3829  Intellectual Property and Copyright Stat Line 4024  Intellectual Property and Copyright Stat
4024                                          </p>                                          </p>
4025  <blockquote class="text">  <blockquote class="text">
4026  <p>optionally dotted number for the channel volume factor  <p>optionally dotted number for the channel volume factor
4027                                              (where a value < 1.0 means attenuation and a value >                                              (where a value &lt; 1.0 means attenuation and a value >
4028                                              1.0 means amplification)                                              1.0 means amplification)
4029  </p>  </p>
4030  </blockquote>  </blockquote>
# Line 3856  Intellectual Property and Copyright Stat Line 4051  Intellectual Property and Copyright Stat
4051  </blockquote>  </blockquote>
4052                                                                            
4053    
4054    <p>MIDI_INSTRUMENT_MAP -
4055                                            </p>
4056    <blockquote class="text">
4057    <p>Determines to which MIDI instrument map this sampler
4058                                                channel is assigned to. Read chapter
4059                                                <a class='info' href='#SET CHANNEL MIDI_INSTRUMENT_MAP'>"SET CHANNEL MIDI_INSTRUMENT_MAP"<span> (</span><span class='info'>Assigning a MIDI instrument map to a sampler channel</span><span>)</span></a>
4060                                                for a list of possible values.
4061    </p>
4062    </blockquote>
4063                                        
4064    
4065  </blockquote>  </blockquote>
4066                                                            
4067    
# Line 3895  Intellectual Property and Copyright Stat Line 4101  Intellectual Property and Copyright Stat
4101  </p>  </p>
4102  <p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"  <p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"
4103  </p>  </p>
4104    <p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
4105    </p>
4106    <p>&nbsp;&nbsp;&nbsp;"MUTE: false"
4107    </p>
4108    <p>&nbsp;&nbsp;&nbsp;"SOLO: false"
4109    </p>
4110    <p>&nbsp;&nbsp;&nbsp;"MIDI_INSTRUMENT_MAP: NONE"
4111    </p>
4112  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
4113  </p>  </p>
4114  </blockquote><p>  </blockquote><p>
4115                                            
4116  </p>  </p>
4117  <a name="GET CHANNEL VOICE_COUNT"></a><br /><hr />  <a name="GET CHANNEL VOICE_COUNT"></a><br /><hr />
4118  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
4119  <a name="rfc.section.6.4.11"></a><h3>6.4.11.&nbsp;Current number of active voices</h3>  <a name="rfc.section.6.4.11"></a><h3>6.4.11.&nbsp;
4120    Current number of active voices</h3>
4121    
4122  <p>The front-end can ask for the current number of active voices on a  <p>The front-end can ask for the current number of active voices on a
4123                      sampler channel by sending the following command:                      sampler channel by sending the following command:
# Line 3916  Intellectual Property and Copyright Stat Line 4131  Intellectual Property and Copyright Stat
4131                                            
4132  </p>  </p>
4133  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
4134                      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>                      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>
4135                      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.                      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.
4136  </p>  </p>
4137  <p>Possible Answers:  <p>Possible Answers:
4138  </p>  </p>
# Line 3941  Intellectual Property and Copyright Stat Line 4156  Intellectual Property and Copyright Stat
4156                                            
4157  </p>  </p>
4158  <a name="GET CHANNEL STREAM_COUNT"></a><br /><hr />  <a name="GET CHANNEL STREAM_COUNT"></a><br /><hr />
4159  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
4160  <a name="rfc.section.6.4.12"></a><h3>6.4.12.&nbsp;Current number of active disk streams</h3>  <a name="rfc.section.6.4.12"></a><h3>6.4.12.&nbsp;
4161    Current number of active disk streams</h3>
4162    
4163  <p>The front-end can ask for the current number of active disk streams  <p>The front-end can ask for the current number of active disk streams
4164                      on a sampler channel by sending the following command:                      on a sampler channel by sending the following command:
# Line 3956  Intellectual Property and Copyright Stat Line 4172  Intellectual Property and Copyright Stat
4172                                            
4173  </p>  </p>
4174  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
4175                      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>                      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>
4176                      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.                      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.
4177  </p>  </p>
4178  <p>Possible Answers:  <p>Possible Answers:
4179  </p>  </p>
# Line 3983  Intellectual Property and Copyright Stat Line 4199  Intellectual Property and Copyright Stat
4199                                            
4200  </p>  </p>
4201  <a name="GET CHANNEL BUFFER_FILL"></a><br /><hr />  <a name="GET CHANNEL BUFFER_FILL"></a><br /><hr />
4202  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
4203  <a name="rfc.section.6.4.13"></a><h3>6.4.13.&nbsp;Current fill state of disk stream buffers</h3>  <a name="rfc.section.6.4.13"></a><h3>6.4.13.&nbsp;
4204    Current fill state of disk stream buffers</h3>
4205    
4206  <p>The front-end can ask for the current fill state of all disk streams  <p>The front-end can ask for the current fill state of all disk streams
4207                      on a sampler channel by sending the following command:                      on a sampler channel by sending the following command:
# Line 4009  Intellectual Property and Copyright Stat Line 4226  Intellectual Property and Copyright Stat
4226  </p>  </p>
4227  <p>to get the fill state in percent, where &lt;sampler-channel&gt; is the  <p>to get the fill state in percent, where &lt;sampler-channel&gt; is the
4228                      sampler channel number the front-end is interested in                      sampler channel number the front-end is interested in
4229                      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>                      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>
4230                      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.                      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.
4231  </p>  </p>
4232  <p>Possible Answers:  <p>Possible Answers:
4233  </p>  </p>
# Line 4060  Intellectual Property and Copyright Stat Line 4277  Intellectual Property and Copyright Stat
4277                                            
4278  </p>  </p>
4279  <a name="SET CHANNEL AUDIO_OUTPUT_DEVICE"></a><br /><hr />  <a name="SET CHANNEL AUDIO_OUTPUT_DEVICE"></a><br /><hr />
4280  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
4281  <a name="rfc.section.6.4.14"></a><h3>6.4.14.&nbsp;Setting audio output device</h3>  <a name="rfc.section.6.4.14"></a><h3>6.4.14.&nbsp;
4282    Setting audio output device</h3>
4283    
4284  <p>The front-end can set the audio output device on a specific sampler  <p>The front-end can set the audio output device on a specific sampler
4285                      channel by sending the following command:                      channel by sending the following command:
# Line 4075  Intellectual Property and Copyright Stat Line 4293  Intellectual Property and Copyright Stat
4293                                            
4294  </p>  </p>
4295  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4296                      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>                      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>
4297                      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 and                      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 and
4298                      &lt;audio-device-id&gt; is the numerical ID of the audio output device as given by the                      &lt;audio-device-id&gt; is the numerical ID of the audio output device as given by the
4299                      <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a>                      <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
4300                      or <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class="info">Getting all created audio output device list</span><span>)</span></a>                      or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
4301                      command.                      command.
4302  </p>  </p>
4303  <p>Possible Answers:  <p>Possible Answers:
# Line 4126  Intellectual Property and Copyright Stat Line 4344  Intellectual Property and Copyright Stat
4344  </blockquote><p>  </blockquote><p>
4345                                            
4346  </p>  </p>
4347  <a name="SET CHANNEL AUDIO_OUTPUT_TYP"></a><br /><hr />  <a name="SET CHANNEL AUDIO_OUTPUT_TYPE"></a><br /><hr />
4348  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
4349  <a name="rfc.section.6.4.15"></a><h3>6.4.15.&nbsp;Setting audio output type</h3>  <a name="rfc.section.6.4.15"></a><h3>6.4.15.&nbsp;
4350    Setting audio output type</h3>
4351    
4352  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
4353  </p>  </p>
# Line 4191  Intellectual Property and Copyright Stat Line 4410  Intellectual Property and Copyright Stat
4410                                            
4411  </p>  </p>
4412  <a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr />  <a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
4413  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
4414  <a name="rfc.section.6.4.16"></a><h3>6.4.16.&nbsp;Setting audio output channel</h3>  <a name="rfc.section.6.4.16"></a><h3>6.4.16.&nbsp;
4415    Setting audio output channel</h3>
4416    
4417  <p>The front-end can alter the audio output channel on a specific  <p>The front-end can alter the audio output channel on a specific
4418                      sampler channel by sending the following command:                      sampler channel by sending the following command:
# Line 4206  Intellectual Property and Copyright Stat Line 4426  Intellectual Property and Copyright Stat
4426                                            
4427  </p>  </p>
4428  <p>Where &lt;sampler-chan&gt; is the sampler channel number  <p>Where &lt;sampler-chan&gt; is the sampler channel number
4429                      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>                      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>
4430                      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;audio-out&gt; is the                      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;audio-out&gt; is the
4431                      numerical ID of the sampler channel's audio output channel which should be                      numerical ID of the sampler channel's audio output channel which should be
4432                      rerouted and &lt;audio-in&gt; is the numerical ID of the audio channel of the selected audio                      rerouted and &lt;audio-in&gt; is the numerical ID of the audio channel of the selected audio
4433                      output device where &lt;audio-out&gt; should be routed to.                      output device where &lt;audio-out&gt; should be routed to.
# Line 4257  Intellectual Property and Copyright Stat Line 4477  Intellectual Property and Copyright Stat
4477                                            
4478  </p>  </p>
4479  <a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr />
4480  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
4481  <a name="rfc.section.6.4.17"></a><h3>6.4.17.&nbsp;Setting MIDI input device</h3>  <a name="rfc.section.6.4.17"></a><h3>6.4.17.&nbsp;
4482    Setting MIDI input device</h3>
4483    
4484  <p>The front-end can set the MIDI input device on a specific sampler  <p>The front-end can set the MIDI input device on a specific sampler
4485                      channel by sending the following command:                      channel by sending the following command:
# Line 4272  Intellectual Property and Copyright Stat Line 4493  Intellectual Property and Copyright Stat
4493                                            
4494  </p>  </p>
4495  <p>Where &lt;sampler-channel&gt; is the sampler channel number  <p>Where &lt;sampler-channel&gt; is the sampler channel number
4496                      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>                      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>
4497                      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                      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
4498                      and &lt;midi-device-id&gt; is  the numerical ID of the MIDI input device as returned by the                      and &lt;midi-device-id&gt; is  the numerical ID of the MIDI input device as returned by the
4499                      <a class="info" href="#CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a>                      <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
4500                      or <a class="info" href="#LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"<span> (</span><span class="info">Getting all created MIDI input device list</span><span>)</span></a> command.                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a> command.
4501  </p>  </p>
4502  <p>Possible Answers:  <p>Possible Answers:
4503  </p>  </p>
# Line 4323  Intellectual Property and Copyright Stat Line 4544  Intellectual Property and Copyright Stat
4544                                            
4545  </p>  </p>
4546  <a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr />
4547  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
4548  <a name="rfc.section.6.4.18"></a><h3>6.4.18.&nbsp;Setting MIDI input type</h3>  <a name="rfc.section.6.4.18"></a><h3>6.4.18.&nbsp;
4549    Setting MIDI input type</h3>
4550    
4551  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
4552  </p>  </p>
# Line 4387  Intellectual Property and Copyright Stat Line 4609  Intellectual Property and Copyright Stat
4609                                            
4610  </p>  </p>
4611  <a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr />
4612  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
4613  <a name="rfc.section.6.4.19"></a><h3>6.4.19.&nbsp;Setting MIDI input port</h3>  <a name="rfc.section.6.4.19"></a><h3>6.4.19.&nbsp;
4614    Setting MIDI input port</h3>
4615    
4616  <p>The front-end can alter the MIDI input port on a specific sampler  <p>The front-end can alter the MIDI input port on a specific sampler
4617                      channel by sending the following command:                      channel by sending the following command:
# Line 4450  Intellectual Property and Copyright Stat Line 4673  Intellectual Property and Copyright Stat
4673                                            
4674  </p>  </p>
4675  <a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr />
4676  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
4677  <a name="rfc.section.6.4.20"></a><h3>6.4.20.&nbsp;Setting MIDI input channel</h3>  <a name="rfc.section.6.4.20"></a><h3>6.4.20.&nbsp;
4678    Setting MIDI input channel</h3>
4679    
4680  <p>The front-end can alter the MIDI channel a sampler channel should  <p>The front-end can alter the MIDI channel a sampler channel should
4681                      listen to by sending the following command:                      listen to by sending the following command:
# Line 4513  Intellectual Property and Copyright Stat Line 4737  Intellectual Property and Copyright Stat
4737                                            
4738  </p>  </p>
4739  <a name="SET CHANNEL VOLUME"></a><br /><hr />  <a name="SET CHANNEL VOLUME"></a><br /><hr />
4740  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
4741  <a name="rfc.section.6.4.21"></a><h3>6.4.21.&nbsp;Setting channel volume</h3>  <a name="rfc.section.6.4.21"></a><h3>6.4.21.&nbsp;
4742    Setting channel volume</h3>
4743    
4744  <p>The front-end can alter the volume of a sampler channel by sending  <p>The front-end can alter the volume of a sampler channel by sending
4745                      the following command:                      the following command:
# Line 4577  Intellectual Property and Copyright Stat Line 4802  Intellectual Property and Copyright Stat
4802                                            
4803  </p>  </p>
4804  <a name="SET CHANNEL MUTE"></a><br /><hr />  <a name="SET CHANNEL MUTE"></a><br /><hr />
4805  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
4806  <a name="rfc.section.6.4.22"></a><h3>6.4.22.&nbsp;Muting a sampler channel</h3>  <a name="rfc.section.6.4.22"></a><h3>6.4.22.&nbsp;
4807    Muting a sampler channel</h3>
4808    
4809  <p>The front-end can mute/unmute a specific sampler  <p>The front-end can mute/unmute a specific sampler
4810                      channel by sending the following command:                      channel by sending the following command:
# Line 4592  Intellectual Property and Copyright Stat Line 4818  Intellectual Property and Copyright Stat
4818                                            
4819  </p>  </p>
4820  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4821                      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>                      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>
4822                      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 and                      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 and
4823                      &lt;mute&gt; should be replaced either by "1" to mute the channel or "0"                      &lt;mute&gt; should be replaced either by "1" to mute the channel or "0"
4824                      to unmute the channel.                      to unmute the channel.
4825  </p>  </p>
# Line 4642  Intellectual Property and Copyright Stat Line 4868  Intellectual Property and Copyright Stat
4868                                            
4869  </p>  </p>
4870  <a name="SET CHANNEL SOLO"></a><br /><hr />  <a name="SET CHANNEL SOLO"></a><br /><hr />
4871  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
4872  <a name="rfc.section.6.4.23"></a><h3>6.4.23.&nbsp;Soloing a sampler channel</h3>  <a name="rfc.section.6.4.23"></a><h3>6.4.23.&nbsp;
4873    Soloing a sampler channel</h3>
4874    
4875  <p>The front-end can solo/unsolo a specific sampler channel  <p>The front-end can solo/unsolo a specific sampler channel
4876                      by sending the following command:                      by sending the following command:
# Line 4657  Intellectual Property and Copyright Stat Line 4884  Intellectual Property and Copyright Stat
4884                                            
4885  </p>  </p>
4886  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4887                      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>                      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>
4888                      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 and                      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 and
4889                      &lt;solo&gt; should be replaced either by "1" to solo the channel or "0"                      &lt;solo&gt; should be replaced either by "1" to solo the channel or "0"
4890                      to unsolo the channel.                      to unsolo the channel.
4891  </p>  </p>
# Line 4706  Intellectual Property and Copyright Stat Line 4933  Intellectual Property and Copyright Stat
4933  </blockquote><p>  </blockquote><p>
4934                                            
4935  </p>  </p>
4936    <a name="SET CHANNEL MIDI_INSTRUMENT_MAP"></a><br /><hr />
4937    <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>
4938    <a name="rfc.section.6.4.24"></a><h3>6.4.24.&nbsp;
4939    Assigning a MIDI instrument map to a sampler channel</h3>
4940    
4941    <p>The front-end can assign a MIDI instrument map to a specific sampler channel
4942                        by sending the following command:
4943    </p>
4944    <p>
4945                            </p>
4946    <blockquote class="text">
4947    <p>SET CHANNEL MIDI_INSTRUMENT_MAP &lt;sampler-channel&gt; &lt;map&gt;
4948    </p>
4949    </blockquote><p>
4950                        
4951    </p>
4952    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4953                        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>
4954                        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 and
4955                        &lt;map&gt; can have the following possibilites:
4956    </p>
4957    <p>
4958                            </p>
4959    <blockquote class="text">
4960    <p>"NONE" -
4961                                    </p>
4962    <blockquote class="text">
4963    <p>This is the default setting. In this case
4964                                        the sampler channel is not assigned any MIDI
4965                                        instrument map and thus will ignore all MIDI
4966                                        program change messages.
4967    </p>
4968    </blockquote>
4969                                
4970    
4971    <p>"DEFAULT" -
4972                                    </p>
4973    <blockquote class="text">
4974    <p>The sampler channel will always use the
4975                                        default MIDI instrument map to handle MIDI
4976                                        program change messages.
4977    </p>
4978    </blockquote>
4979                                
4980    
4981    <p>numeric ID -
4982                                    </p>
4983    <blockquote class="text">
4984    <p>You can assign a specific MIDI instrument map
4985                                        by replacing &lt;map&gt; with the respective numeric
4986                                        ID of the MIDI instrument map as returned by the
4987                                        <a class='info' href='#LIST MIDI_INSTRUMENT_MAPS'>"LIST MIDI_INSTRUMENT_MAPS"<span> (</span><span class='info'>Getting all created MIDI instrument maps</span><span>)</span></a>
4988                                        command. Once that map will be deleted, the sampler
4989                                        channel would fall back to "NONE".
4990    </p>
4991    </blockquote>
4992                                
4993    
4994    </blockquote><p>
4995                        
4996    </p>
4997    <p>Read chapter <a class='info' href='#MIDI Instrument Mapping'>"MIDI Instrument Mapping"<span> (</span><span class='info'>MIDI Instrument Mapping</span><span>)</span></a>
4998                        for details regarding MIDI instrument mapping.
4999    </p>
5000    <p>Possible Answers:
5001    </p>
5002    <p>
5003                            </p>
5004    <blockquote class="text">
5005    <p>"OK" -
5006                                    </p>
5007    <blockquote class="text">
5008    <p>on success
5009    </p>
5010    </blockquote>
5011                                
5012    
5013    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5014                                    </p>
5015    <blockquote class="text">
5016    <p>in case it failed, providing an appropriate error code and error message
5017    </p>
5018    </blockquote>
5019                                
5020    
5021    </blockquote><p>
5022                        
5023    </p>
5024    <p>Examples:
5025    </p>
5026    <p>
5027                            </p>
5028    <blockquote class="text">
5029    <p>
5030    </p>
5031    </blockquote><p>
5032                        
5033    </p>
5034    <a name="CREATE FX_SEND"></a><br /><hr />
5035    <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>
5036    <a name="rfc.section.6.4.25"></a><h3>6.4.25.&nbsp;
5037    Adding an effect send to a sampler channel</h3>
5038    
5039    <p>The front-end can create an additional effect send on a specific sampler channel
5040                        by sending the following command:
5041    </p>
5042    <p>
5043                            </p>
5044    <blockquote class="text">
5045    <p>CREATE FX_SEND &lt;sampler-channel&gt; &lt;midi-ctrl&gt; [&lt;name&gt;]
5046    </p>
5047    </blockquote><p>
5048                        
5049    </p>
5050    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5051                        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>
5052                        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, that is the
5053                        sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
5054                        is a number between 0..127 defining the MIDI controller which can alter the
5055                        effect send level and &lt;name&gt; is an optional argument defining a name
5056                        for the effect send entity. The name does not have to be unique.
5057    </p>
5058    <p>By default, that is as initial routing, the effect send's audio channels
5059                        are automatically routed to the last audio channels of the sampler channel's
5060                        audio output device, that way you can i.e. first increase the amount of audio
5061                        channels on the audio output device for having dedicated effect send output
5062                        channels and when "CREATE FX_SEND" is called, those channels will automatically
5063                        be picked. You can alter the destination channels however with
5064                        <a class='info' href='#SET FX_SEND AUDIO_OUTPUT_CHANNEL'>"SET FX_SEND AUDIO_OUTPUT_CHANNEL"<span> (</span><span class='info'>Altering effect send's audio routing</span><span>)</span></a>.
5065                        
5066    </p>
5067    <p>Note: Create effect sends on a sampler channel only when needed, because having effect
5068                        sends on a sampler channel will decrease runtime performance, because for implementing channel
5069                        effect sends, separate (sampler channel local) audio buffers are needed to render and mix
5070                        the voices and route the audio signal afterwards to the master outputs and effect send
5071                        outputs (along with their respective effect send levels). A sampler channel without effect
5072                        sends however can mix its voices directly into the audio output devices's audio buffers
5073                        and is thus faster.
5074                        
5075    </p>
5076    <p>Possible Answers:
5077    </p>
5078    <p>
5079                            </p>
5080    <blockquote class="text">
5081    <p>"OK[&lt;fx-send-id&gt;]" -
5082                                    </p>
5083    <blockquote class="text">
5084    <p>in case a new effect send could be added to the
5085                                        sampler channel, where &lt;fx-send-id&gt; reflects the
5086                                        unique ID of the newly created effect send entity
5087    </p>
5088    </blockquote>
5089                                
5090    
5091    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5092                                    </p>
5093    <blockquote class="text">
5094    <p>when a new effect send could not be added, i.e.
5095                                        due to invalid parameters
5096    </p>
5097    </blockquote>
5098                                
5099    
5100    </blockquote><p>
5101                        
5102    </p>
5103    <p>Examples:
5104    </p>
5105    <p>
5106                            </p>
5107    <blockquote class="text">
5108    <p>C: "CREATE FX_SEND 0 91 'Reverb Send'"
5109    </p>
5110    <p>S: "OK[0]"
5111    </p>
5112    </blockquote><p>
5113                        
5114    </p>
5115    <p>
5116                            </p>
5117    <blockquote class="text">
5118    <p>C: "CREATE FX_SEND 0 93"
5119    </p>
5120    <p>S: "OK[1]"
5121    </p>
5122    </blockquote><p>
5123                        
5124    </p>
5125    <a name="DESTROY FX_SEND"></a><br /><hr />
5126    <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>
5127    <a name="rfc.section.6.4.26"></a><h3>6.4.26.&nbsp;
5128    Removing an effect send from a sampler channel</h3>
5129    
5130    <p>The front-end can remove an existing effect send on a specific sampler channel
5131                        by sending the following command:
5132    </p>
5133    <p>
5134                            </p>
5135    <blockquote class="text">
5136    <p>DESTROY FX_SEND &lt;sampler-channel&gt; &lt;fx-send-id&gt;
5137    </p>
5138    </blockquote><p>
5139                        
5140    </p>
5141    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5142                        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>
5143                        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, that is the
5144                        sampler channel from which the effect send should be removed from and
5145                        &lt;fx-send-id&gt; is the respective effect send number as returned by the
5146                        <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>
5147                        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.
5148    </p>
5149    <p>Possible Answers:
5150    </p>
5151    <p>
5152                            </p>
5153    <blockquote class="text">
5154    <p>"OK" -
5155                                    </p>
5156    <blockquote class="text">
5157    <p>on success
5158    </p>
5159    </blockquote>
5160                                
5161    
5162    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5163                                    </p>
5164    <blockquote class="text">
5165    <p>in case it failed, providing an appropriate error code and
5166                                        error message
5167    </p>
5168    </blockquote>
5169                                
5170    
5171    </blockquote><p>
5172                        
5173    </p>
5174    <p>Example:
5175    </p>
5176    <p>
5177                            </p>
5178    <blockquote class="text">
5179    <p>C: "DESTROY FX_SEND 0 0"
5180    </p>
5181    <p>S: "OK"
5182    </p>
5183    </blockquote><p>
5184                        
5185    </p>
5186    <a name="GET FX_SENDS"></a><br /><hr />
5187    <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>
5188    <a name="rfc.section.6.4.27"></a><h3>6.4.27.&nbsp;
5189    Getting amount of effect sends on a sampler channel</h3>
5190    
5191    <p>The front-end can ask for the amount of effect sends on a specific sampler channel
5192                        by sending the following command:
5193    </p>
5194    <p>
5195                            </p>
5196    <blockquote class="text">
5197    <p>GET FX_SENDS &lt;sampler-channel&gt;
5198    </p>
5199    </blockquote><p>
5200                        
5201    </p>
5202    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5203                        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>
5204                        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.
5205    </p>
5206    <p>Possible Answers:
5207    </p>
5208    <p>
5209                            </p>
5210    <blockquote class="text">
5211    <p>The sampler will answer by returning the number of effect
5212                                sends on the given sampler channel.
5213    </p>
5214    </blockquote><p>
5215                        
5216    </p>
5217    <p>Example:
5218    </p>
5219    <p>
5220                            </p>
5221    <blockquote class="text">
5222    <p>C: "GET FX_SENDS 0"
5223    </p>
5224    <p>S: "2"
5225    </p>
5226    </blockquote><p>
5227                        
5228    </p>
5229    <a name="LIST FX_SENDS"></a><br /><hr />
5230    <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>
5231    <a name="rfc.section.6.4.28"></a><h3>6.4.28.&nbsp;
5232    Listing all effect sends on a sampler channel</h3>
5233    
5234    <p>The front-end can ask for a list of effect sends on a specific sampler channel
5235                        by sending the following command:
5236    </p>
5237    <p>
5238                            </p>
5239    <blockquote class="text">
5240    <p>LIST FX_SENDS &lt;sampler-channel&gt;
5241    </p>
5242    </blockquote><p>
5243                        
5244    </p>
5245    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5246                        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>
5247                        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.
5248    </p>
5249    <p>Possible Answers:
5250    </p>
5251    <p>
5252                            </p>
5253    <blockquote class="text">
5254    <p>The sampler will answer by returning a comma separated list
5255                                with all effect sends' numerical IDs on the given sampler
5256                                channel.
5257    </p>
5258    </blockquote><p>
5259                        
5260    </p>
5261    <p>Examples:
5262    </p>
5263    <p>
5264                            </p>
5265    <blockquote class="text">
5266    <p>C: "LIST FX_SENDS 0"
5267    </p>
5268    <p>S: "0,1"
5269    </p>
5270    </blockquote><p>
5271                        
5272    </p>
5273    <p>
5274                            </p>
5275    <blockquote class="text">
5276    <p>C: "LIST FX_SENDS 1"
5277    </p>
5278    <p>S: ""
5279    </p>
5280    </blockquote><p>
5281                        
5282    </p>
5283    <a name="GET FX_SEND INFO"></a><br /><hr />
5284    <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>
5285    <a name="rfc.section.6.4.29"></a><h3>6.4.29.&nbsp;
5286    Getting effect send information</h3>
5287    
5288    <p>The front-end can ask for the current settings of an effect send entity
5289                        by sending the following command:
5290    </p>
5291    <p>
5292                            </p>
5293    <blockquote class="text">
5294    <p>GET FX_SEND INFO &lt;sampler-channel&gt; &lt;fx-send-id&gt;
5295    </p>
5296    </blockquote><p>
5297                        
5298    </p>
5299    <p>Where &lt;sampler-channel&gt; is the sampler channel number
5300                        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>
5301                        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 and
5302                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5303                        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>
5304                        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.
5305                      
5306    </p>
5307    <p>Possible Answers:
5308    </p>
5309    <p>
5310                            </p>
5311    <blockquote class="text">
5312    <p>The sampler will answer by sending a &lt;CRLF&gt; separated list.
5313                                Each answer line begins with the settings category name
5314                                followed by a colon and then a space character &lt;SP&gt; and finally
5315                                the info character string to that setting category. At the
5316                                moment the following categories are defined:
5317    </p>
5318    <p>
5319                                    </p>
5320    <blockquote class="text">
5321    <p>NAME -
5322                                            </p>
5323    <blockquote class="text">
5324    <p>name of the effect send entity
5325    </p>
5326    </blockquote>
5327                                        
5328    
5329    <p>MIDI_CONTROLLER -
5330                                            </p>
5331    <blockquote class="text">
5332    <p>a value between 0 and 127 reflecting the MIDI controller
5333                                                which is able to modify the effect send's send level
5334    </p>
5335    </blockquote>
5336                                        
5337    
5338    <p>LEVEL -
5339                                            </p>
5340    <blockquote class="text">
5341    <p>optionally dotted number reflecting the effect send's
5342                                                current send level (where a value &lt; 1.0 means attenuation
5343                                                and a value > 1.0 means amplification)
5344    </p>
5345    </blockquote>
5346                                        
5347    
5348    <p>AUDIO_OUTPUT_ROUTING -
5349                                            </p>
5350    <blockquote class="text">
5351    <p>comma separated list which reflects to which audio
5352                                                channel of the selected audio output device each
5353                                                effect send output channel is routed to, e.g. "0,3" would
5354                                                mean the effect send's output channel 0 is routed to channel
5355                                                0 of the audio output device and the effect send's output
5356                                                channel 1 is routed to the channel 3 of the audio
5357                                                output device (see
5358                                                <a class='info' href='#SET FX_SEND AUDIO_OUTPUT_CHANNEL'>"SET FX_SEND AUDIO_OUTPUT_CHANNEL"<span> (</span><span class='info'>Altering effect send's audio routing</span><span>)</span></a>
5359                                                for details)
5360    </p>
5361    </blockquote>
5362                                        
5363    
5364    </blockquote>
5365                                
5366    
5367    </blockquote><p>
5368                        
5369    </p>
5370    <p>The mentioned fields above don't have to be in particular order.
5371    </p>
5372    <p>Example:
5373    </p>
5374    <p>
5375                            </p>
5376    <blockquote class="text">
5377    <p>C: "GET FX_SEND INFO 0 0"
5378    </p>
5379    <p>S: "NAME: Reverb Send"
5380    </p>
5381    <p>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"
5382    </p>
5383    <p>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"
5384    </p>
5385    <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"
5386    </p>
5387    <p>&nbsp;&nbsp;&nbsp;"."
5388    </p>
5389    </blockquote><p>
5390                        
5391    </p>
5392    <a name="SET FX_SEND NAME"></a><br /><hr />
5393    <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>
5394    <a name="rfc.section.6.4.30"></a><h3>6.4.30.&nbsp;
5395    Changing effect send's name</h3>
5396    
5397    <p>The front-end can alter the current name of an effect
5398                        send entity by sending the following command:
5399    </p>
5400    <p>
5401                            </p>
5402    <blockquote class="text">
5403    <p>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;
5404    </p>
5405    </blockquote><p>
5406                        
5407    </p>
5408    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5409                        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>
5410                        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,
5411                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5412                        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>
5413                        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
5414                        &lt;name&gt; is the new name of the effect send entity, which
5415                        does not have to be unique.
5416    </p>
5417    <p>Possible Answers:
5418    </p>
5419    <p>
5420                            </p>
5421    <blockquote class="text">
5422    <p>"OK" -
5423                                    </p>
5424    <blockquote class="text">
5425    <p>on success
5426    </p>
5427    </blockquote>
5428                                
5429    
5430    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5431                                    </p>
5432    <blockquote class="text">
5433    <p>in case it failed, providing an appropriate error code and error message
5434    </p>
5435    </blockquote>
5436                                
5437    
5438    </blockquote><p>
5439                        
5440    </p>
5441    <p>Example:
5442    </p>
5443    <p>
5444                            </p>
5445    <blockquote class="text">
5446    <p>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
5447    </p>
5448    <p>S: "OK"
5449    </p>
5450    </blockquote><p>
5451                        
5452    </p>
5453    <a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
5454    <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>
5455    <a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;
5456    Altering effect send's audio routing</h3>
5457    
5458    <p>The front-end can alter the destination of an effect send's audio channel on a specific
5459                        sampler channel by sending the following command:
5460    </p>
5461    <p>
5462                            </p>
5463    <blockquote class="text">
5464    <p>SET FX_SEND AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;audio-src&gt; &lt;audio-dst&gt;
5465    </p>
5466    </blockquote><p>
5467                        
5468    </p>
5469    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5470                        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>
5471                        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,
5472                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5473                        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>
5474                        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,
5475                        &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
5476                        which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
5477                        the audio channel of the selected audio output device where &lt;audio-src&gt;
5478                        should be routed to.
5479    </p>
5480    <p>Note that effect sends can only route audio to the same audio output
5481                        device as assigned to the effect send's sampler channel. Also note that an
5482                        effect send entity does always have exactly as much audio channels as its
5483                        sampler channel. So if the sampler channel is stereo, the effect send does
5484                        have two audio channels as well. Also keep in mind that the amount of audio
5485                        channels on a sampler channel might be dependant not only to the deployed
5486                        sampler engine on the sampler channel, but also dependant to the instrument
5487                        currently loaded. However you can (effectively) turn an i.e. stereo effect
5488                        send into a mono one by simply altering its audio routing appropriately.
5489    </p>
5490    <p>Possible Answers:
5491    </p>
5492    <p>
5493                            </p>
5494    <blockquote class="text">
5495    <p>"OK" -
5496                                    </p>
5497    <blockquote class="text">
5498    <p>on success
5499    </p>
5500    </blockquote>
5501                                
5502    
5503    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5504                                    </p>
5505    <blockquote class="text">
5506    <p>if audio output channel was set, but there are noteworthy
5507                                        issue(s) related, providing an appropriate warning code and
5508                                        warning message
5509    </p>
5510    </blockquote>
5511                                
5512    
5513    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5514                                    </p>
5515    <blockquote class="text">
5516    <p>in case it failed, providing an appropriate error code and error message
5517    </p>
5518    </blockquote>
5519                                
5520    
5521    </blockquote><p>
5522                        
5523    </p>
5524    <p>Example:
5525    </p>
5526    <p>
5527                            </p>
5528    <blockquote class="text">
5529    <p>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
5530    </p>
5531    <p>S: "OK"
5532    </p>
5533    </blockquote><p>
5534                        
5535    </p>
5536    <a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />
5537    <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>
5538    <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;
5539    Altering effect send's MIDI controller</h3>
5540    
5541    <p>The front-end can alter the MIDI controller of an effect
5542                        send entity by sending the following command:
5543    </p>
5544    <p>
5545                            </p>
5546    <blockquote class="text">
5547    <p>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;
5548    </p>
5549    </blockquote><p>
5550                        
5551    </p>
5552    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5553                        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>
5554                        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,
5555                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5556                        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>
5557                        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
5558                        &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
5559                        able to modify the effect send's send level.
5560    </p>
5561    <p>Possible Answers:
5562    </p>
5563    <p>
5564                            </p>
5565    <blockquote class="text">
5566    <p>"OK" -
5567                                    </p>
5568    <blockquote class="text">
5569    <p>on success
5570    </p>
5571    </blockquote>
5572                                
5573    
5574    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5575                                    </p>
5576    <blockquote class="text">
5577    <p>if MIDI controller was set, but there are noteworthy
5578                                        issue(s) related, providing an appropriate warning code and
5579                                        warning message
5580    </p>
5581    </blockquote>
5582                                
5583    
5584    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5585                                    </p>
5586    <blockquote class="text">
5587    <p>in case it failed, providing an appropriate error code and error message
5588    </p>
5589    </blockquote>
5590                                
5591    
5592    </blockquote><p>
5593                        
5594    </p>
5595    <p>Example:
5596    </p>
5597    <p>
5598                            </p>
5599    <blockquote class="text">
5600    <p>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
5601    </p>
5602    <p>S: "OK"
5603    </p>
5604    </blockquote><p>
5605                        
5606    </p>
5607    <a name="SET FX_SEND LEVEL"></a><br /><hr />
5608    <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>
5609    <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;
5610    Altering effect send's send level</h3>
5611    
5612    <p>The front-end can alter the current send level of an effect
5613                        send entity by sending the following command:
5614    </p>
5615    <p>
5616                            </p>
5617    <blockquote class="text">
5618    <p>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;
5619    </p>
5620    </blockquote><p>
5621                        
5622    </p>
5623    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5624                        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>
5625                        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,
5626                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5627                        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>
5628                        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
5629                        &lt;volume&gt; is an optionally dotted positive number (a value
5630                        smaller than 1.0 means attenuation, whereas a value greater than
5631                        1.0 means amplification) reflecting the new send level.
5632    </p>
5633    <p>Possible Answers:
5634    </p>
5635    <p>
5636                            </p>
5637    <blockquote class="text">
5638    <p>"OK" -
5639                                    </p>
5640    <blockquote class="text">
5641    <p>on success
5642    </p>
5643    </blockquote>
5644                                
5645    
5646    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5647                                    </p>
5648    <blockquote class="text">
5649    <p>if new send level was set, but there are noteworthy
5650                                        issue(s) related, providing an appropriate warning code and
5651                                        warning message
5652    </p>
5653    </blockquote>
5654                                
5655    
5656    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5657                                    </p>
5658    <blockquote class="text">
5659    <p>in case it failed, providing an appropriate error code and error message
5660    </p>
5661    </blockquote>
5662                                
5663    
5664    </blockquote><p>
5665                        
5666    </p>
5667    <p>Example:
5668    </p>
5669    <p>
5670                            </p>
5671    <blockquote class="text">
5672    <p>C: "SET FX_SEND LEVEL 0 0 0.15"
5673    </p>
5674    <p>S: "OK"
5675    </p>
5676    </blockquote><p>
5677                        
5678    </p>
5679  <a name="RESET CHANNEL"></a><br /><hr />  <a name="RESET CHANNEL"></a><br /><hr />
5680  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
5681  <a name="rfc.section.6.4.24"></a><h3>6.4.24.&nbsp;Resetting a sampler channel</h3>  <a name="rfc.section.6.4.34"></a><h3>6.4.34.&nbsp;
5682    Resetting a sampler channel</h3>
5683    
5684  <p>The front-end can reset a particular sampler channel by sending the following command:  <p>The front-end can reset a particular sampler channel by sending the following command:
5685  </p>  </p>
# Line 4772  Intellectual Property and Copyright Stat Line 5743  Intellectual Property and Copyright Stat
5743                                            
5744  </p>  </p>
5745  <a name="anchor12"></a><br /><hr />  <a name="anchor12"></a><br /><hr />
5746  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
5747  <a name="rfc.section.6.5"></a><h3>6.5.&nbsp;Controlling connection</h3>  <a name="rfc.section.6.5"></a><h3>6.5.&nbsp;
5748    Controlling connection</h3>
5749    
5750  <p>The following commands are used to control the connection to LinuxSampler.  <p>The following commands are used to control the connection to LinuxSampler.
5751  </p>  </p>
5752  <a name="SUBSCRIBE"></a><br /><hr />  <a name="SUBSCRIBE"></a><br /><hr />
5753  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
5754  <a name="rfc.section.6.5.1"></a><h3>6.5.1.&nbsp;Register front-end for receiving event messages</h3>  <a name="rfc.section.6.5.1"></a><h3>6.5.1.&nbsp;
5755    Register front-end for receiving event messages</h3>
5756    
5757  <p>The front-end can register itself to the LinuxSampler application to  <p>The front-end can register itself to the LinuxSampler application to
5758                      be informed about noteworthy events by sending this command:                      be informed about noteworthy events by sending this command:
# Line 4841  Intellectual Property and Copyright Stat Line 5814  Intellectual Property and Copyright Stat
5814                                            
5815  </p>  </p>
5816  <a name="UNSUBSCRIBE"></a><br /><hr />  <a name="UNSUBSCRIBE"></a><br /><hr />
5817  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
5818  <a name="rfc.section.6.5.2"></a><h3>6.5.2.&nbsp;Unregister front-end for not receiving event messages</h3>  <a name="rfc.section.6.5.2"></a><h3>6.5.2.&nbsp;
5819    Unregister front-end for not receiving event messages</h3>
5820    
5821  <p>The front-end can unregister itself if it doesn't want to receive event  <p>The front-end can unregister itself if it doesn't want to receive event
5822                      messages anymore by sending the following command:                      messages anymore by sending the following command:
# Line 4904  Intellectual Property and Copyright Stat Line 5878  Intellectual Property and Copyright Stat
5878                                            
5879  </p>  </p>
5880  <a name="SET ECHO"></a><br /><hr />  <a name="SET ECHO"></a><br /><hr />
5881  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
5882  <a name="rfc.section.6.5.3"></a><h3>6.5.3.&nbsp;Enable or disable echo of commands</h3>  <a name="rfc.section.6.5.3"></a><h3>6.5.3.&nbsp;
5883    Enable or disable echo of commands</h3>
5884    
5885  <p>To enable or disable back sending of commands to the client the following command can be used:  <p>To enable or disable back sending of commands to the client the following command can be used:
5886  </p>  </p>
# Line 4960  Intellectual Property and Copyright Stat Line 5935  Intellectual Property and Copyright Stat
5935                                            
5936  </p>  </p>
5937  <a name="QUIT"></a><br /><hr />  <a name="QUIT"></a><br /><hr />
5938  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
5939  <a name="rfc.section.6.5.4"></a><h3>6.5.4.&nbsp;Close client connection</h3>  <a name="rfc.section.6.5.4"></a><h3>6.5.4.&nbsp;
5940    Close client connection</h3>
5941    
5942  <p>The client can close its network connection to LinuxSampler by sending the following command:  <p>The client can close its network connection to LinuxSampler by sending the following command:
5943  </p>  </p>
# Line 4977  Intellectual Property and Copyright Stat Line 5953  Intellectual Property and Copyright Stat
5953                      LinuxSampler than really useful for a front-end implementation.                      LinuxSampler than really useful for a front-end implementation.
5954  </p>  </p>
5955  <a name="anchor13"></a><br /><hr />  <a name="anchor13"></a><br /><hr />
5956  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
5957  <a name="rfc.section.6.6"></a><h3>6.6.&nbsp;Global commands</h3>  <a name="rfc.section.6.6"></a><h3>6.6.&nbsp;
5958    Global commands</h3>
5959    
5960  <p>The following commands have global impact on the sampler.  <p>The following commands have global impact on the sampler.
5961  </p>  </p>
5962  <a name="GET TOTAL_VOICE_COUNT"></a><br /><hr />  <a name="GET TOTAL_VOICE_COUNT"></a><br /><hr />
5963  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
5964  <a name="rfc.section.6.6.1"></a><h3>6.6.1.&nbsp;Current number of active voices</h3>  <a name="rfc.section.6.6.1"></a><h3>6.6.1.&nbsp;
5965    Current number of active voices</h3>
5966    
5967  <p>The front-end can ask for the current number of active voices on  <p>The front-end can ask for the current number of active voices on
5968                      the sampler by sending the following command:                      the sampler by sending the following command:
# Line 5009  Intellectual Property and Copyright Stat Line 5987  Intellectual Property and Copyright Stat
5987                                            
5988  </p>  </p>
5989  <a name="GET TOTAL_VOICE_COUNT_MAX"></a><br /><hr />  <a name="GET TOTAL_VOICE_COUNT_MAX"></a><br /><hr />
5990  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
5991  <a name="rfc.section.6.6.2"></a><h3>6.6.2.&nbsp;Maximum amount of active voices</h3>  <a name="rfc.section.6.6.2"></a><h3>6.6.2.&nbsp;
5992    Maximum amount of active voices</h3>
5993    
5994  <p>The front-end can ask for the maximum number of active voices  <p>The front-end can ask for the maximum number of active voices
5995                      by sending the following command:                      by sending the following command:
# Line 5035  Intellectual Property and Copyright Stat Line 6014  Intellectual Property and Copyright Stat
6014                                            
6015  </p>  </p>
6016  <a name="RESET"></a><br /><hr />  <a name="RESET"></a><br /><hr />
6017  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
6018  <a name="rfc.section.6.6.3"></a><h3>6.6.3.&nbsp;Reset sampler</h3>  <a name="rfc.section.6.6.3"></a><h3>6.6.3.&nbsp;
6019    Reset sampler</h3>
6020    
6021  <p>The front-end can reset the whole sampler by sending the following command:  <p>The front-end can reset the whole sampler by sending the following command:
6022  </p>  </p>
# Line 5075  Intellectual Property and Copyright Stat Line 6055  Intellectual Property and Copyright Stat
6055                                            
6056  </p>  </p>
6057  <a name="GET SERVER INFO"></a><br /><hr />  <a name="GET SERVER INFO"></a><br /><hr />
6058  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
6059  <a name="rfc.section.6.6.4"></a><h3>6.6.4.&nbsp;General sampler informations</h3>  <a name="rfc.section.6.6.4"></a><h3>6.6.4.&nbsp;
6060    General sampler informations</h3>
6061    
6062  <p>The client can ask for general informations about the LinuxSampler  <p>The client can ask for general informations about the LinuxSampler
6063                         instance by sending the following command:                         instance by sending the following command:
# Line 5124  Intellectual Property and Copyright Stat Line 6105  Intellectual Property and Copyright Stat
6105                                          </p>                                          </p>
6106  <blockquote class="text">  <blockquote class="text">
6107  <p>version of the LSCP specification the sampler  <p>version of the LSCP specification the sampler
6108                                              complies with (see <a class="info" href="#LSCP versioning">Section&nbsp;2<span> (</span><span class="info">Versioning of this specification</span><span>)</span></a> for details)                                              complies with (see <a class='info' href='#LSCP versioning'>Section&nbsp;2<span> (</span><span class='info'>Versioning of this specification</span><span>)</span></a> for details)
6109    </p>
6110    </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>  </p>
6119  </blockquote>  </blockquote>
6120                                                                            
# Line 5138  Intellectual Property and Copyright Stat Line 6128  Intellectual Property and Copyright Stat
6128  <p>The mentioned fields above don't have to be in particular order.  <p>The mentioned fields above don't have to be in particular order.
6129                      Other fields might be added in future.                      Other fields might be added in future.
6130  </p>  </p>
6131    <a name="GET VOLUME"></a><br /><hr />
6132    <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>
6133    <a name="rfc.section.6.6.5"></a><h3>6.6.5.&nbsp;
6134    Getting global volume attenuation</h3>
6135    
6136    <p>The client can ask for the current global sampler-wide volume
6137                        attenuation by sending the following command:
6138    </p>
6139    <p>
6140                            </p>
6141    <blockquote class="text">
6142    <p>GET VOLUME
6143    </p>
6144    </blockquote><p>
6145                        
6146    </p>
6147    <p>Possible Answers:
6148    </p>
6149    <p>
6150                            </p>
6151    <blockquote class="text">
6152    <p>The sampler will always answer by returning the optional
6153                                dotted floating point coefficient, reflecting the current
6154                                global volume attenuation.
6155                                
6156    </p>
6157    </blockquote><p>
6158                        
6159    </p>
6160    <p>Note: it is up to the respective sampler engine whether to obey
6161                        that global volume parameter or not, but in general all engines SHOULD
6162                        use this parameter.
6163    </p>
6164    <a name="SET VOLUME"></a><br /><hr />
6165    <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>
6166    <a name="rfc.section.6.6.6"></a><h3>6.6.6.&nbsp;
6167    Setting global volume attenuation</h3>
6168    
6169    <p>The client can alter the current global sampler-wide volume
6170                        attenuation by sending the following command:
6171    </p>
6172    <p>
6173                            </p>
6174    <blockquote class="text">
6175    <p>SET VOLUME &lt;volume&gt;
6176    </p>
6177    </blockquote><p>
6178                        
6179    </p>
6180    <p>Where &lt;volume&gt; should be replaced by the optional dotted
6181                       floating point value, reflecting the new global volume parameter.
6182                       This value might usually be in the range between 0.0 and 1.0, that
6183                       is for attenuating the overall volume.
6184    </p>
6185    <p>Possible Answers:
6186    </p>
6187    <p>
6188                            </p>
6189    <blockquote class="text">
6190    <p>"OK" -
6191                                    </p>
6192    <blockquote class="text">
6193    <p>on success
6194    </p>
6195    </blockquote>
6196                                
6197    
6198    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6199                                    </p>
6200    <blockquote class="text">
6201    <p>if the global volume was set, but there are noteworthy
6202                                        issue(s) related, providing an appropriate warning code and
6203                                        warning message
6204    </p>
6205    </blockquote>
6206                                
6207    
6208    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6209                                    </p>
6210    <blockquote class="text">
6211    <p>in case it failed, providing an appropriate error code and error message
6212    </p>
6213    </blockquote>
6214                                
6215    
6216    </blockquote><p>
6217                        
6218    </p>
6219    <a name="MIDI Instrument Mapping"></a><br /><hr />
6220    <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>
6221    <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;
6222    MIDI Instrument Mapping</h3>
6223    
6224    <p>The MIDI protocol provides a way to switch between instruments
6225                    by sending so called MIDI bank select and MIDI program change
6226                    messages which are essentially just numbers. The following commands
6227                    allow to actually map arbitrary MIDI bank select / program change
6228                    numbers with real instruments.
6229    </p>
6230    <p>The sampler allows to manage an arbitrary amount of MIDI
6231                    instrument maps which define which instrument to load on
6232                    which MIDI program change message.
6233    </p>
6234    <p>By default, that is when the sampler is launched, there is no
6235                    map, thus the sampler will simply ignore all program change
6236                    messages. The front-end has to explicitly create at least one
6237                    map, add entries to the map and tell the respective sampler
6238                    channel(s) which MIDI instrument map to use, so the sampler
6239                    knows how to react on a given program change message on the
6240                    respective sampler channel, that is by switching to the
6241                    respectively defined engine type and loading the respective
6242                    instrument. See command
6243                    <a class='info' href='#SET CHANNEL MIDI_INSTRUMENT_MAP'>"SET CHANNEL MIDI_INSTRUMENT_MAP"<span> (</span><span class='info'>Assigning a MIDI instrument map to a sampler channel</span><span>)</span></a>
6244                    for how to assign a MIDI instrument map to a sampler channel.
6245    </p>
6246    <p>Also note per MIDI specification a bank select message does not
6247                    cause to switch to another instrument. Instead when receiving a
6248                    bank select message the bank value will be stored and a subsequent
6249                    program change message (which may occur at any time) will finally
6250                    cause the sampler to switch to the respective instrument as
6251                    reflected by the current MIDI instrument map.
6252    </p>
6253    <a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr />
6254    <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>
6255    <a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;
6256    Create a new MIDI instrument map</h3>
6257    
6258    <p>The front-end can add a new MIDI instrument map by sending
6259                        the following command:
6260    </p>
6261    <p>
6262                            </p>
6263    <blockquote class="text">
6264    <p>ADD MIDI_INSTRUMENT_MAP [&lt;name&gt;]
6265    </p>
6266    </blockquote><p>
6267                        
6268    </p>
6269    <p>Where &lt;name&gt; is an optional argument allowing to
6270                        assign a custom name to the new map. MIDI instrument Map
6271                        names do not have to be unique.
6272    </p>
6273    <p>Possible Answers:
6274    </p>
6275    <p>
6276                            </p>
6277    <blockquote class="text">
6278    <p>"OK[&lt;map&gt;]" -
6279                                    </p>
6280    <blockquote class="text">
6281    <p>in case a new MIDI instrument map could
6282                                        be added, where &lt;map&gt; reflects the
6283                                        unique ID of the newly created MIDI
6284                                        instrument map
6285    </p>
6286    </blockquote>
6287                                
6288    
6289    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6290                                    </p>
6291    <blockquote class="text">
6292    <p>when a new map could not be created, which
6293                                        might never occur in practice
6294    </p>
6295    </blockquote>
6296                                
6297    
6298    </blockquote><p>
6299                        
6300    </p>
6301    <p>Examples:
6302    </p>
6303    <p>
6304                            </p>
6305    <blockquote class="text">
6306    <p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
6307    </p>
6308    <p>S: "OK[0]"
6309    </p>
6310    </blockquote><p>
6311                        
6312    </p>
6313    <p>
6314                            </p>
6315    <blockquote class="text">
6316    <p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
6317    </p>
6318    <p>S: "OK[1]"
6319    </p>
6320    </blockquote><p>
6321                        
6322    </p>
6323    <p>
6324                            </p>
6325    <blockquote class="text">
6326    <p>C: "ADD MIDI_INSTRUMENT_MAP"
6327    </p>
6328    <p>S: "OK[5]"
6329    </p>
6330    </blockquote><p>
6331                        
6332    </p>
6333    <a name="REMOVE MIDI_INSTRUMENT_MAP"></a><br /><hr />
6334    <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>
6335    <a name="rfc.section.6.7.2"></a><h3>6.7.2.&nbsp;
6336    Delete one particular or all MIDI instrument maps</h3>
6337    
6338    <p>The front-end can delete a particular MIDI instrument map
6339                        by sending the following command:
6340    </p>
6341    <p>
6342                            </p>
6343    <blockquote class="text">
6344    <p>REMOVE MIDI_INSTRUMENT_MAP &lt;map&gt;
6345    </p>
6346    </blockquote><p>
6347                        
6348    </p>
6349    <p>Where &lt;map&gt; reflects the unique ID of the map to delete
6350                        as returned by the <a class='info' href='#LIST MIDI_INSTRUMENT_MAPS'>"LIST MIDI_INSTRUMENT_MAPS"<span> (</span><span class='info'>Getting all created MIDI instrument maps</span><span>)</span></a>
6351                        command.
6352    </p>
6353    <p>The front-end can delete all MIDI instrument maps by
6354                        sending the following command:
6355    </p>
6356    <p>
6357                            </p>
6358    <blockquote class="text">
6359    <p>REMOVE MIDI_INSTRUMENT_MAP ALL
6360    </p>
6361    </blockquote><p>
6362                        
6363    </p>
6364    <p>Possible Answers:
6365    </p>
6366    <p>
6367                            </p>
6368    <blockquote class="text">
6369    <p>"OK" -
6370                                    </p>
6371    <blockquote class="text">
6372    <p>in case the map(s) could be deleted
6373    </p>
6374    </blockquote>
6375                                
6376    
6377    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6378                                    </p>
6379    <blockquote class="text">
6380    <p>when the given map does not exist
6381    </p>
6382    </blockquote>
6383                                
6384    
6385    </blockquote><p>
6386                        
6387    </p>
6388    <p>Examples:
6389    </p>
6390    <p>
6391                            </p>
6392    <blockquote class="text">
6393    <p>C: "REMOVE MIDI_INSTRUMENT_MAP 0"
6394    </p>
6395    <p>S: "OK"
6396    </p>
6397    </blockquote><p>
6398                        
6399    </p>
6400    <p>
6401                            </p>
6402    <blockquote class="text">
6403    <p>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
6404    </p>
6405    <p>S: "OK"
6406    </p>
6407    </blockquote><p>
6408                        
6409    </p>
6410    <a name="GET MIDI_INSTRUMENT_MAPS"></a><br /><hr />
6411    <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>
6412    <a name="rfc.section.6.7.3"></a><h3>6.7.3.&nbsp;
6413    Get amount of existing MIDI instrument maps</h3>
6414    
6415    <p>The front-end can retrieve the current amount of MIDI
6416                        instrument maps by sending the following command:
6417    </p>
6418    <p>
6419                            </p>
6420    <blockquote class="text">
6421    <p>GET MIDI_INSTRUMENT_MAPS
6422    </p>
6423    </blockquote><p>
6424                        
6425    </p>
6426    <p>Possible Answers:
6427    </p>
6428    <p>
6429                            </p>
6430    <blockquote class="text">
6431    <p>The sampler will answer by returning the current
6432                                number of MIDI instrument maps.
6433    </p>
6434    </blockquote><p>
6435                        
6436    </p>
6437    <p>Example:
6438    </p>
6439    <p>
6440                            </p>
6441    <blockquote class="text">
6442    <p>C: "GET MIDI_INSTRUMENT_MAPS"
6443    </p>
6444    <p>S: "2"
6445    </p>
6446    </blockquote><p>
6447                        
6448    </p>
6449    <a name="LIST MIDI_INSTRUMENT_MAPS"></a><br /><hr />
6450    <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>
6451    <a name="rfc.section.6.7.4"></a><h3>6.7.4.&nbsp;
6452    Getting all created MIDI instrument maps</h3>
6453    
6454    <p>The number of MIDI instrument maps can change on runtime. To get the
6455                        current list of MIDI instrument maps, the front-end can send the
6456                        following command:
6457    </p>
6458    <p>
6459                            </p>
6460    <blockquote class="text">
6461    <p>LIST MIDI_INSTRUMENT_MAPS
6462    </p>
6463    </blockquote><p>
6464                        
6465    </p>
6466    <p>Possible Answers:
6467    </p>
6468    <p>
6469                            </p>
6470    <blockquote class="text">
6471    <p>The sampler will answer by returning a comma separated list
6472                                with all MIDI instrument maps' numerical IDs.
6473    </p>
6474    </blockquote><p>
6475                        
6476    </p>
6477    <p>Example:
6478    </p>
6479    <p>
6480                            </p>
6481    <blockquote class="text">
6482    <p>C: "LIST MIDI_INSTRUMENT_MAPS"
6483    </p>
6484    <p>S: "0,1,5,12"
6485    </p>
6486    </blockquote><p>
6487                        
6488    </p>
6489    <a name="GET MIDI_INSTRUMENT_MAP INFO"></a><br /><hr />
6490    <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>
6491    <a name="rfc.section.6.7.5"></a><h3>6.7.5.&nbsp;
6492    Getting MIDI instrument map information</h3>
6493    
6494    <p>The front-end can ask for the current settings of a MIDI
6495                        instrument map by sending the following command:
6496    </p>
6497    <p>
6498                            </p>
6499    <blockquote class="text">
6500    <p>GET MIDI_INSTRUMENT_MAP INFO &lt;map&gt;
6501    </p>
6502    </blockquote><p>
6503                        
6504    </p>
6505    <p>Where &lt;map&gt; is the numerical ID of the map the
6506                        front-end is interested in as returned by the
6507                        <a class='info' href='#LIST MIDI_INSTRUMENT_MAPS'>"LIST MIDI_INSTRUMENT_MAPS"<span> (</span><span class='info'>Getting all created MIDI instrument maps</span><span>)</span></a>
6508                        command.
6509    </p>
6510    <p>Possible Answers:
6511    </p>
6512    <p>
6513                            </p>
6514    <blockquote class="text">
6515    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6516                                Each answer line begins with the settings category name
6517                                followed by a colon and then a space character &lt;SP&gt; and finally
6518                                the info character string to that setting category. At the
6519                                moment the following categories are defined:
6520    </p>
6521    <p>
6522                                    </p>
6523    <blockquote class="text">
6524    <p>NAME -
6525                                            </p>
6526    <blockquote class="text">
6527    <p>custom name of the given map,
6528                                                which does not have to be unique
6529    </p>
6530    </blockquote>
6531                                        
6532    
6533    <p>DEFAULT -
6534                                            </p>
6535    <blockquote class="text">
6536    <p>either true or false,
6537                                                defines whether this map is the default map
6538    </p>
6539    </blockquote>
6540                                        
6541    
6542    </blockquote>
6543                                
6544    
6545    </blockquote><p>
6546                        
6547    </p>
6548    <p>The mentioned fields above don't have to be in particular order.
6549    </p>
6550    <p>Example:
6551    </p>
6552    <p>
6553                            </p>
6554    <blockquote class="text">
6555    <p>C: "GET MIDI_INSTRUMENT_MAP INFO 0"
6556    </p>
6557    <p>S: "NAME: Standard Map"
6558    </p>
6559    <p>&nbsp;&nbsp;&nbsp;"DEFAULT: true"
6560    </p>
6561    <p>&nbsp;&nbsp;&nbsp;"."
6562    </p>
6563    </blockquote><p>
6564                        
6565    </p>
6566    <a name="SET MIDI_INSTRUMENT_MAP NAME"></a><br /><hr />
6567    <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>
6568    <a name="rfc.section.6.7.6"></a><h3>6.7.6.&nbsp;
6569    Renaming a MIDI instrument map</h3>
6570    
6571    <p>The front-end can alter the custom name of a MIDI
6572                        instrument map by sending the following command:
6573    </p>
6574    <p>
6575                            </p>
6576    <blockquote class="text">
6577    <p>SET MIDI_INSTRUMENT_MAP NAME &lt;map&gt; &lt;name&gt;
6578    </p>
6579    </blockquote><p>
6580                        
6581    </p>
6582    <p>Where &lt;map&gt; is the numerical ID of the map and
6583                        &lt;name&gt; the new custom name of the map, which does not
6584                        have to be unique.
6585    </p>
6586    <p>Possible Answers:
6587    </p>
6588    <p>
6589                            </p>
6590    <blockquote class="text">
6591    <p>"OK" -
6592                                    </p>
6593    <blockquote class="text">
6594    <p>on success
6595    </p>
6596    </blockquote>
6597                                
6598    
6599    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6600                                    </p>
6601    <blockquote class="text">
6602    <p>in case the given map does not exist
6603    </p>
6604    </blockquote>
6605                                
6606    
6607    </blockquote><p>
6608                        
6609    </p>
6610    <p>Example:
6611    </p>
6612    <p>
6613                            </p>
6614    <blockquote class="text">
6615    <p>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
6616    </p>
6617    <p>S: "OK"
6618    </p>
6619    </blockquote><p>
6620                        
6621    </p>
6622    <a name="MAP MIDI_INSTRUMENT"></a><br /><hr />
6623    <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>
6624    <a name="rfc.section.6.7.7"></a><h3>6.7.7.&nbsp;
6625    Create or replace a MIDI instrument map entry</h3>
6626    
6627    <p>The front-end can create a new or replace an existing entry
6628                        in a sampler's MIDI instrument map by sending the following
6629                        command:
6630    </p>
6631    <p>
6632                            </p>
6633    <blockquote class="text">
6634    <p>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
6635                                &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
6636                                &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
6637                                [&lt;instr_load_mode&gt;] [&lt;name&gt;]
6638    </p>
6639    </blockquote><p>
6640                        
6641    </p>
6642    <p>Where &lt;map&gt; is the numeric ID of the map to alter,
6643                        &lt;midi_bank&gt; is an integer value between
6644                        0..16383 reflecting the MIDI bank select index,
6645                        &lt;midi_prog&gt; an
6646                        integer value between 0..127 reflecting the MIDI program change
6647                        index, &lt;engine_name&gt; a sampler engine name as returned by
6648                        the <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a>
6649                        command (not encapsulated into apostrophes), &lt;filename&gt; the name
6650                        of the instrument's file to be deployed (encapsulated into apostrophes),
6651                        &lt;instrument_index&gt; the index (integer value) of the instrument
6652                        within the given file, &lt;volume_value&gt; reflects the master
6653                        volume of the instrument as optionally dotted number (where a
6654                        value &lt; 1.0 means attenuation and a value > 1.0 means
6655                        amplification). This parameter easily allows to adjust the
6656                        volume of all intruments within a custom instrument map
6657                        without having to adjust their instrument files. The
6658                        OPTIONAL &lt;instr_load_mode&gt; argument defines the life
6659                        time of the instrument, that is when the instrument should
6660                        be loaded, when freed and has exactly the following
6661                        possibilities:
6662    </p>
6663    <p>
6664                            </p>
6665    <blockquote class="text">
6666    <p>"ON_DEMAND" -
6667                                    </p>
6668    <blockquote class="text">
6669    <p>The instrument will be loaded when needed,
6670                                        that is when demanded by at least one sampler
6671                                        channel. It will immediately be freed from memory
6672                                        when not needed by any sampler channel anymore.
6673    </p>
6674    </blockquote>
6675                                
6676    
6677    <p>"ON_DEMAND_HOLD" -
6678                                    </p>
6679    <blockquote class="text">
6680    <p>The instrument will be loaded when needed,
6681                                        that is when demanded by at least one sampler
6682                                        channel. It will be kept in memory even when
6683                                        not needed by any sampler channel anymore.
6684                                        Instruments with this mode are only freed
6685                                        when the sampler is reset or all mapping
6686                                        entries with this mode (and respective
6687                                        instrument) are explicitly changed to
6688                                        "ON_DEMAND" and no sampler channel is using
6689                                        the instrument anymore.
6690    </p>
6691    </blockquote>
6692                                
6693    
6694    <p>"PERSISTENT" -
6695                                    </p>
6696    <blockquote class="text">
6697    <p>The instrument will immediately be loaded
6698                                        into memory when this mapping
6699                                        command is sent and the instrument is kept all
6700                                        the time. Instruments with this mode are
6701                                        only freed when the sampler is reset or all
6702                                        mapping entries with this mode (and
6703                                        respective instrument) are explicitly
6704                                        changed to "ON_DEMAND" and no sampler
6705                                        channel is using the instrument anymore.
6706    </p>
6707    </blockquote>
6708                                
6709    
6710    <p>not supplied -
6711                                    </p>
6712    <blockquote class="text">
6713    <p>In case there is no &lt;instr_load_mode&gt;
6714                                        argument given, it will be up to the
6715                                        InstrumentManager to decide which mode to use.
6716                                        Usually it will use "ON_DEMAND" if an entry
6717                                        for the given instrument does not exist in
6718                                        the InstrumentManager's list yet, otherwise
6719                                        if an entry already exists, it will simply
6720                                        stick with the mode currently reflected by
6721                                        the already existing entry, that is it will
6722                                        not change the mode.
6723    </p>
6724    </blockquote>
6725                                
6726    
6727    </blockquote><p>
6728                        
6729    </p>
6730    <p>
6731                        The &lt;instr_load_mode&gt; argument thus allows to define an
6732                        appropriate strategy (low memory consumption vs. fast
6733                        instrument switching) for each instrument individually. Note, the
6734                        following restrictions apply to this argument: "ON_DEMAND_HOLD" and
6735                        "PERSISTENT" have to be supported by the respective sampler engine
6736                        (which is technically the case when the engine provides an
6737                        InstrumentManager for its format). If this is not the case the
6738                        argument will automatically fall back to the default value
6739                        "ON_DEMAND". Also the load mode of one instrument may
6740                        automatically change the laod mode of other instrument(s), i.e.
6741                        because the instruments are part of the same file and the
6742                        engine does not allow a way to manage load modes for them
6743                        individually. Due to this, in case the frontend shows the
6744                        load modes of entries, the frontend should retrieve the actual
6745                        mode by i.e. sending
6746                        <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>
6747                        command(s). Finally the OPTIONAL &lt;name&gt; argument allows to
6748                        set a custom name (encapsulated into apostrophes) for the mapping
6749                        entry, useful for frontends for displaying an appropriate name for
6750                        mapped instruments (using
6751                        <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>).
6752                        
6753    </p>
6754    <p>
6755                        By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
6756                        completely established in the sampler. The OPTIONAL "NON_MODAL" argument
6757                        however causes the respective "MAP MIDI_INSTRUMENT" command to return
6758                        immediately, that is to let the sampler establish the mapping in the
6759                        background. So this argument might be especially useful for mappings with
6760                        a "PERSISTENT" type, because these have to load the respective instruments
6761                        immediately and might thus block for a very long time. It is recommended
6762                        however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
6763                        because it has the following drawbacks: as "NON_MODAL" instructions return
6764                        immediately, they may not necessarily return an error i.e. when the given
6765                        instrument file turns out to be corrupt, beside that subsequent commands
6766                        in a LSCP instruction sequence might fail, because mandatory mappings are
6767                        not yet completed.
6768                        
6769    </p>
6770    <p>Possible Answers:
6771    </p>
6772    <p>
6773                            </p>
6774    <blockquote class="text">
6775    <p>"OK" -
6776                                    </p>
6777    <blockquote class="text">
6778    <p>usually
6779    </p>
6780    </blockquote>
6781                                
6782    
6783    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6784                                    </p>
6785    <blockquote class="text">
6786    <p>when the given map or engine does not exist or a value
6787                                        is out of range
6788    </p>
6789    </blockquote>
6790                                
6791    
6792    </blockquote><p>
6793                        
6794    </p>
6795    <p>Examples:
6796    </p>
6797    <p>
6798                            </p>
6799    <blockquote class="text">
6800    <p>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"
6801    </p>
6802    <p>S: "OK"
6803    </p>
6804    </blockquote><p>
6805                        
6806    </p>
6807    <p>
6808                            </p>
6809    <blockquote class="text">
6810    <p>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"
6811    </p>
6812    <p>S: "OK"
6813    </p>
6814    </blockquote><p>
6815                        
6816    </p>
6817    <p>
6818                            </p>
6819    <blockquote class="text">
6820    <p>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"
6821    </p>
6822    <p>S: "OK"
6823    </p>
6824    <p>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"
6825    </p>
6826    <p>S: "OK"
6827    </p>
6828    </blockquote><p>
6829                        
6830    </p>
6831    <p>
6832                            </p>
6833    <blockquote class="text">
6834    <p>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
6835    </p>
6836    <p>S: "OK"
6837    </p>
6838    </blockquote><p>
6839                        
6840    </p>
6841    <a name="GET MIDI_INSTRUMENTS"></a><br /><hr />
6842    <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>
6843    <a name="rfc.section.6.7.8"></a><h3>6.7.8.&nbsp;
6844    Getting ammount of MIDI instrument map entries</h3>
6845    
6846    <p>The front-end can query the amount of currently existing
6847                        entries in a MIDI instrument map by sending the following
6848                        command:
6849    </p>
6850    <p>
6851                            </p>
6852    <blockquote class="text">
6853    <p>GET MIDI_INSTRUMENTS &lt;map&gt;
6854    </p>
6855    </blockquote><p>
6856                        
6857    </p>
6858    <p>The front-end can query the amount of currently existing
6859                        entries in all MIDI instrument maps by sending the following
6860                        command:
6861    </p>
6862    <p>
6863                            </p>
6864    <blockquote class="text">
6865    <p>GET MIDI_INSTRUMENTS ALL
6866    </p>
6867    </blockquote><p>
6868                        
6869    </p>
6870    <p>Possible Answers:
6871    </p>
6872    <p>
6873                            </p>
6874    <blockquote class="text">
6875    <p>The sampler will answer by sending the current number of
6876                                entries in the MIDI instrument map(s).
6877    </p>
6878    </blockquote><p>
6879                        
6880    </p>
6881    <p>Example:
6882    </p>
6883    <p>
6884                            </p>
6885    <blockquote class="text">
6886    <p>C: "GET MIDI_INSTRUMENTS 0"
6887    </p>
6888    <p>S: "234"
6889    </p>
6890    </blockquote><p>
6891                        
6892    </p>
6893    <p>
6894                            </p>
6895    <blockquote class="text">
6896    <p>C: "GET MIDI_INSTRUMENTS ALL"
6897    </p>
6898    <p>S: "954"
6899    </p>
6900    </blockquote><p>
6901                        
6902    </p>
6903    <a name="LIST MIDI_INSTRUMENTS"></a><br /><hr />
6904    <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>
6905    <a name="rfc.section.6.7.9"></a><h3>6.7.9.&nbsp;
6906    Getting indeces of all entries of a MIDI instrument map</h3>
6907    
6908    <p>The front-end can query a list of all currently existing
6909                        entries in a certain MIDI instrument map by sending the following
6910                        command:
6911    </p>
6912    <p>
6913                            </p>
6914    <blockquote class="text">
6915    <p>LIST MIDI_INSTRUMENTS &lt;map&gt;
6916    </p>
6917    </blockquote><p>
6918                        
6919    </p>
6920    <p>Where &lt;map&gt; is the numeric ID of the MIDI instrument map.
6921    </p>
6922    <p>The front-end can query a list of all currently existing
6923                        entries of all MIDI instrument maps by sending the following
6924                        command:
6925    </p>
6926    <p>
6927                            </p>
6928    <blockquote class="text">
6929    <p>LIST MIDI_INSTRUMENTS ALL
6930    </p>
6931    </blockquote><p>
6932                        
6933    </p>
6934    <p>Possible Answers:
6935    </p>
6936    <p>
6937                            </p>
6938    <blockquote class="text">
6939    <p>The sampler will answer by sending a comma separated
6940                                list of map ID - MIDI bank - MIDI program triples, where
6941                                each triple is encapsulated into curly braces. The
6942                                list is returned in one single line. Each triple
6943                                just reflects the key of the respective map entry,
6944                                thus subsequent
6945                                <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>
6946                                command(s) are necessary to retrieve detailed informations
6947                                about each entry.
6948    </p>
6949    </blockquote><p>
6950                        
6951    </p>
6952    <p>Example:
6953    </p>
6954    <p>
6955                            </p>
6956    <blockquote class="text">
6957    <p>C: "LIST MIDI_INSTRUMENTS 0"
6958    </p>
6959    <p>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
6960    </p>
6961    </blockquote><p>
6962                        
6963    </p>
6964    <a name="UNMAP MIDI_INSTRUMENT"></a><br /><hr />
6965    <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>
6966    <a name="rfc.section.6.7.10"></a><h3>6.7.10.&nbsp;
6967    Remove an entry from the MIDI instrument map</h3>
6968    
6969    <p>The front-end can delete an entry from a MIDI instrument
6970                        map by sending the following command:
6971    </p>
6972    <p>
6973                            </p>
6974    <blockquote class="text">
6975    <p>UNMAP MIDI_INSTRUMENT &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;
6976    </p>
6977    </blockquote><p>
6978                        
6979    </p>
6980    <p>
6981                        Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
6982                        &lt;midi_bank&gt; is an integer value between 0..16383
6983                        reflecting the MIDI bank value and
6984                        &lt;midi_prog&gt; an integer value between
6985                        0..127 reflecting the MIDI program value of the map's entrie's key
6986                        index triple.
6987                        
6988    </p>
6989    <p>Possible Answers:
6990    </p>
6991    <p>
6992                            </p>
6993    <blockquote class="text">
6994    <p>"OK" -
6995                                    </p>
6996    <blockquote class="text">
6997    <p>usually
6998    </p>
6999    </blockquote>
7000                                
7001    
7002    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7003                                    </p>
7004    <blockquote class="text">
7005    <p>when index out of bounds
7006    </p>
7007    </blockquote>
7008                                
7009    
7010    </blockquote><p>
7011                        
7012    </p>
7013    <p>Example:
7014    </p>
7015    <p>
7016                            </p>
7017    <blockquote class="text">
7018    <p>C: "UNMAP MIDI_INSTRUMENT 0 2 127"
7019    </p>
7020    <p>S: "OK"
7021    </p>
7022    </blockquote><p>
7023                        
7024    </p>
7025    <a name="GET MIDI_INSTRUMENT INFO"></a><br /><hr />
7026    <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>
7027    <a name="rfc.section.6.7.11"></a><h3>6.7.11.&nbsp;
7028    Get current settings of MIDI instrument map entry</h3>
7029    
7030    <p>The front-end can retrieve the current settings of a certain
7031                        instrument map entry by sending the following command:
7032    </p>
7033    <p>
7034                            </p>
7035    <blockquote class="text">
7036    <p>GET MIDI_INSTRUMENT INFO &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;
7037    </p>
7038    </blockquote><p>
7039                        
7040    </p>
7041    <p>
7042                        Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
7043                        &lt;midi_bank&gt; is an integer value between 0..16383
7044                        reflecting the MIDI bank value, &lt;midi_bank&gt;
7045                        and &lt;midi_prog&gt; an integer value between
7046                        0..127 reflecting the MIDI program value of the map's entrie's key
7047                        index triple.
7048                        
7049    </p>
7050    <p>Possible Answers:
7051    </p>
7052    <p>
7053                            </p>
7054    <blockquote class="text">
7055    <p>LinuxSampler will answer by sending a &lt;CRLF&gt;
7056                                separated list. Each answer line begins with the
7057                                information category name followed by a colon and then
7058                                a space character &lt;SP&gt; and finally the info
7059                                character string to that info category. At the moment
7060                                the following categories are defined:
7061    </p>
7062    <p>"NAME" -
7063                                    </p>
7064    <blockquote class="text">
7065    <p>Name for this MIDI instrument map entry (if defined).
7066                                        This name shall be used by frontends for displaying a
7067                                        name for this mapped instrument. It can be set and
7068                                        changed with the
7069                                        <a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a>
7070                                        command and does not have to be unique.
7071    </p>
7072    </blockquote>
7073                                
7074    
7075    <p>"ENGINE_NAME" -
7076                                    </p>
7077    <blockquote class="text">
7078    <p>Name of the engine to be deployed for this
7079                                        instrument.
7080    </p>
7081    </blockquote>
7082                                
7083    
7084    <p>"INSTRUMENT_FILE" -
7085                                    </p>
7086    <blockquote class="text">
7087    <p>File name of the instrument.
7088    </p>
7089    </blockquote>
7090                                
7091    
7092    <p>"INSTRUMENT_NR" -
7093                                    </p>
7094    <blockquote class="text">
7095    <p>Index of the instrument within the file.
7096    </p>
7097    </blockquote>
7098                                
7099    
7100    <p>"INSTRUMENT_NAME" -
7101                                    </p>
7102    <blockquote class="text">
7103    <p>Name of the loaded instrument as reflected by its file.
7104                                        In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
7105                                        cannot be changed.
7106    </p>
7107    </blockquote>
7108                                
7109    
7110    <p>"LOAD_MODE" -
7111                                    </p>
7112    <blockquote class="text">
7113    <p>Life time of instrument
7114                                        (see <a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a> for details about this setting).
7115    </p>
7116    </blockquote>
7117                                
7118    
7119    <p>"VOLUME" -
7120                                    </p>
7121    <blockquote class="text">
7122    <p>master volume of the instrument as optionally
7123                                        dotted number (where a value &lt; 1.0 means attenuation
7124                                        and a value > 1.0 means amplification)
7125    </p>
7126    </blockquote>
7127                                
7128    
7129    <p>The mentioned fields above don't have to be in particular order.
7130    </p>
7131    </blockquote><p>
7132                        
7133    </p>
7134    <p>Example:
7135    </p>
7136    <p>
7137                            </p>
7138    <blockquote class="text">
7139    <p>C: "GET MIDI_INSTRUMENT INFO 1 45 120"
7140    </p>
7141    <p>S: "NAME: Drums for Foo Song"
7142    </p>
7143    <p>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"
7144    </p>
7145    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
7146    </p>
7147    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"
7148    </p>
7149    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Joe's Drumkit"
7150    </p>
7151    <p>&nbsp;&nbsp;&nbsp;"LOAD_MODE: PERSISTENT"
7152    </p>
7153    <p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
7154    </p>
7155    <p>&nbsp;&nbsp;&nbsp;"."
7156    </p>
7157    </blockquote><p>
7158                        
7159    </p>
7160    <a name="CLEAR MIDI_INSTRUMENTS"></a><br /><hr />
7161    <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>
7162    <a name="rfc.section.6.7.12"></a><h3>6.7.12.&nbsp;
7163    Clear MIDI instrument map</h3>
7164    
7165    <p>The front-end can clear a whole MIDI instrument map, that
7166                        is delete all its entries by sending the following command:
7167    </p>
7168    <p>
7169                            </p>
7170    <blockquote class="text">
7171    <p>CLEAR MIDI_INSTRUMENTS &lt;map&gt;
7172    </p>
7173    </blockquote><p>
7174                        
7175    </p>
7176    <p>Where &lt;map&gt; is the numeric ID of the map to clear.
7177    </p>
7178    <p>The front-end can clear all MIDI instrument maps, that
7179                        is delete all entries of all maps by sending the following
7180                        command:
7181    </p>
7182    <p>
7183                            </p>
7184    <blockquote class="text">
7185    <p>CLEAR MIDI_INSTRUMENTS ALL
7186    </p>
7187    </blockquote><p>
7188                        
7189    </p>
7190    <p>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the
7191                        maps, only their entries, thus the map's settings like
7192                        custom name will be preservevd.
7193    </p>
7194    <p>Possible Answers:
7195    </p>
7196    <p>
7197                            </p>
7198    <blockquote class="text">
7199    <p>"OK" -
7200                                    </p>
7201    <blockquote class="text">
7202    <p>always
7203    </p>
7204    </blockquote>
7205                                
7206    
7207    </blockquote><p>
7208                        
7209    </p>
7210    <p>Examples:
7211    </p>
7212    <p>
7213                           </p>
7214    <blockquote class="text">
7215    <p>C: "CLEAR MIDI_INSTRUMENTS 0"
7216    </p>
7217    <p>S: "OK"
7218    </p>
7219    </blockquote><p>
7220                        
7221    </p>
7222    <p>
7223                           </p>
7224    <blockquote class="text">
7225    <p>C: "CLEAR MIDI_INSTRUMENTS ALL"
7226    </p>
7227    <p>S: "OK"
7228    </p>
7229    </blockquote><p>
7230                        
7231    </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="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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;Command Syntax</h3>  <a name="rfc.section.7"></a><h3>7.&nbsp;
8906    Command Syntax</h3>
8907    
8908  <p>The grammar of the control protocol as descibed in <a class="info" href="#control_commands">Section&nbsp;6<span> (</span><span class="info">Description for control commands</span><span>)</span></a>  <p>The grammar of the control protocol as descibed in <a class='info' href='#control_commands'>Section&nbsp;6<span> (</span><span class='info'>Description for control commands</span><span>)</span></a>
8909              is defined below using Backus-Naur Form (BNF as described in <a class="info" href="#RFC2234">[RFC2234]<span> (</span><span class="info">Crocker, D. and P. Overell, &ldquo;Augmented BNF for Syntax Specifications,&rdquo; 1997.</span><span>)</span></a>)              is defined below using Backus-Naur Form (BNF as described in <a class='info' href='#RFC2234'>[RFC2234]<span> (</span><span class='info'>Crocker, D. and P. Overell, &ldquo;Augmented BNF for Syntax Specifications,&rdquo; 1997.</span><span>)</span></a>)
8910              where applicable.              where applicable.
8911                            
8912  </p>  </p>
# Line 5201  Intellectual Property and Copyright Stat Line 8964  Intellectual Property and Copyright Stat
8964  <p>command =  <p>command =
8965          </p>          </p>
8966  <blockquote class="text">  <blockquote class="text">
8967  <p>ADD SP CHANNEL  <p>ADD SP add_instruction
8968                    
8969    </p>
8970    <p>/ MAP SP map_instruction
8971                    
8972    </p>
8973    <p>/ UNMAP SP unmap_instruction
8974                                    
8975  </p>  </p>
8976  <p>/ GET SP get_instruction  <p>/ GET SP get_instruction
# Line 5219  Intellectual Property and Copyright Stat Line 8988  Intellectual Property and Copyright Stat
8988  <p>/ LOAD SP load_instruction  <p>/ LOAD SP load_instruction
8989                                    
8990  </p>  </p>
8991  <p>/ REMOVE SP CHANNEL SP sampler_channel  <p>/ REMOVE SP remove_instruction
8992                                    
8993  </p>  </p>
8994  <p>/ SET SP set_instruction  <p>/ SET SP set_instruction
# Line 5231  Intellectual Property and Copyright Stat Line 9000  Intellectual Property and Copyright Stat
9000  <p>/ UNSUBSCRIBE SP unsubscribe_event  <p>/ UNSUBSCRIBE SP unsubscribe_event
9001                                    
9002  </p>  </p>
9003  <p>/ SELECT SP text  <p>/ RESET SP reset_instruction
9004                    
9005    </p>
9006    <p>/ CLEAR SP clear_instruction
9007                                    
9008  </p>  </p>
9009  <p>/ RESET SP CHANNEL SP sampler_channel  <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>  </p>
9018  <p>/ RESET  <p>/ RESET
# Line 5246  Intellectual Property and Copyright Stat Line 9024  Intellectual Property and Copyright Stat
9024  </blockquote><p>  </blockquote><p>
9025    
9026  </p>  </p>
9027    <p>add_instruction =
9028            </p>
9029    <blockquote class="text">
9030    <p>CHANNEL
9031                    
9032    </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
9055                    
9056    </p>
9057    <p>/ MIDI_INSTRUMENT_MAP SP map_name
9058                    
9059    </p>
9060    </blockquote><p>
9061    
9062    </p>
9063  <p>subscribe_event =  <p>subscribe_event =
9064          </p>          </p>
9065  <blockquote class="text">  <blockquote class="text">
9066  <p>CHANNEL_COUNT  <p>AUDIO_OUTPUT_DEVICE_COUNT
9067                    
9068    </p>
9069    <p>/ AUDIO_OUTPUT_DEVICE_INFO
9070                    
9071    </p>
9072    <p>/ MIDI_INPUT_DEVICE_COUNT
9073                    
9074    </p>
9075    <p>/ MIDI_INPUT_DEVICE_INFO
9076                    
9077    </p>
9078    <p>/ CHANNEL_COUNT
9079                                    
9080  </p>  </p>
9081  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
# Line 5264  Intellectual Property and Copyright Stat Line 9090  Intellectual Property and Copyright Stat
9090  <p>/ CHANNEL_INFO  <p>/ CHANNEL_INFO
9091                                    
9092  </p>  </p>
9093    <p>/ FX_SEND_COUNT
9094                    
9095    </p>
9096    <p>/ FX_SEND_INFO
9097                    
9098    </p>
9099    <p>/ MIDI_INSTRUMENT_MAP_COUNT
9100                    
9101    </p>
9102    <p>/ MIDI_INSTRUMENT_MAP_INFO
9103                    
9104    </p>
9105    <p>/ MIDI_INSTRUMENT_COUNT
9106                    
9107    </p>
9108    <p>/ MIDI_INSTRUMENT_INFO
9109                    
9110    </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>
9129  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
9130                                    
9131  </p>  </p>
9132    <p>/ GLOBAL_INFO
9133                    
9134    </p>
9135  </blockquote><p>  </blockquote><p>
9136    
9137  </p>  </p>
9138  <p>unsubscribe_event =  <p>unsubscribe_event =
9139          </p>          </p>
9140  <blockquote class="text">  <blockquote class="text">
9141  <p>CHANNEL_COUNT  <p>AUDIO_OUTPUT_DEVICE_COUNT
9142                    
9143    </p>
9144    <p>/ AUDIO_OUTPUT_DEVICE_INFO
9145                    
9146    </p>
9147    <p>/ MIDI_INPUT_DEVICE_COUNT
9148                    
9149    </p>
9150    <p>/ MIDI_INPUT_DEVICE_INFO
9151                    
9152    </p>
9153    <p>/ CHANNEL_COUNT
9154                                    
9155  </p>  </p>
9156  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
# Line 5291  Intellectual Property and Copyright Stat Line 9165  Intellectual Property and Copyright Stat
9165  <p>/ CHANNEL_INFO  <p>/ CHANNEL_INFO
9166                                    
9167  </p>  </p>
9168    <p>/ FX_SEND_COUNT
9169                    
9170    </p>
9171    <p>/ FX_SEND_INFO
9172                    
9173    </p>
9174    <p>/ MIDI_INSTRUMENT_MAP_COUNT
9175                    
9176    </p>
9177    <p>/ MIDI_INSTRUMENT_MAP_INFO
9178                    
9179    </p>
9180    <p>/ MIDI_INSTRUMENT_COUNT
9181                    
9182    </p>
9183    <p>/ MIDI_INSTRUMENT_INFO
9184                    
9185    </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>
9204  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
9205                                    
9206  </p>  </p>
9207    <p>/ GLOBAL_INFO
9208                    
9209    </p>
9210    </blockquote><p>
9211    
9212    </p>
9213    <p>map_instruction =
9214            </p>
9215    <blockquote class="text">
9216    <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
9217                    
9218    </p>
9219    <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
9220                    
9221    </p>
9222    <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
9223                    
9224    </p>
9225    <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
9226                    
9227    </p>
9228    </blockquote><p>
9229    
9230    </p>
9231    <p>unmap_instruction =
9232            </p>
9233    <blockquote class="text">
9234    <p>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
9235                    
9236    </p>
9237    </blockquote><p>
9238    
9239    </p>
9240    <p>remove_instruction =
9241            </p>
9242    <blockquote class="text">
9243    <p>CHANNEL SP sampler_channel
9244                    
9245    </p>
9246    <p>/ MIDI_INSTRUMENT_MAP SP midi_map
9247                    
9248    </p>
9249    <p>/ MIDI_INSTRUMENT_MAP SP ALL
9250                    
9251    </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 5381  Intellectual Property and Copyright Stat Line 9342  Intellectual Property and Copyright Stat
9342  <p>/ TOTAL_VOICE_COUNT_MAX  <p>/ TOTAL_VOICE_COUNT_MAX
9343                                    
9344  </p>  </p>
9345    <p>/ MIDI_INSTRUMENTS SP midi_map
9346                    
9347    </p>
9348    <p>/ MIDI_INSTRUMENTS SP ALL
9349                    
9350    </p>
9351    <p>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
9352                    
9353    </p>
9354    <p>/ MIDI_INSTRUMENT_MAPS
9355                    
9356    </p>
9357    <p>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
9358                    
9359    </p>
9360    <p>/ FX_SENDS SP sampler_channel
9361                    
9362    </p>
9363    <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
9364                    
9365    </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
9388                    
9389    </p>
9390  </blockquote><p>  </blockquote><p>
9391    
9392  </p>  </p>
# Line 5402  Intellectual Property and Copyright Stat Line 9408  Intellectual Property and Copyright Stat
9408  <p>/ CHANNEL SP set_chan_instruction  <p>/ CHANNEL SP set_chan_instruction
9409                                    
9410  </p>  </p>
9411    <p>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
9412                    
9413    </p>
9414    <p>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
9415                    
9416    </p>
9417    <p>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
9418                    
9419    </p>
9420    <p>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
9421                    
9422    </p>
9423    <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
9424                    
9425    </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>
9441    <p>/ VOLUME SP volume_value
9442                    
9443    </p>
9444  </blockquote><p>  </blockquote><p>
9445    
9446  </p>  </p>
# Line 5423  Intellectual Property and Copyright Stat Line 9459  Intellectual Property and Copyright Stat
9459  <p>/ MIDI_INPUT_DEVICE SP string  <p>/ MIDI_INPUT_DEVICE SP string
9460                                    
9461  </p>  </p>
9462    <p>/ FX_SEND SP sampler_channel SP midi_ctrl
9463                    
9464    </p>
9465    <p>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
9466                    
9467    </p>
9468    </blockquote><p>
9469    
9470    </p>
9471    <p>reset_instruction =
9472            </p>
9473    <blockquote class="text">
9474    <p>CHANNEL SP sampler_channel
9475                    
9476    </p>
9477    </blockquote><p>
9478    
9479    </p>
9480    <p>clear_instruction =
9481            </p>
9482    <blockquote class="text">
9483    <p>MIDI_INSTRUMENTS SP midi_map
9484                    
9485    </p>
9486    <p>/ MIDI_INSTRUMENTS SP ALL
9487                    
9488    </p>
9489    </blockquote><p>
9490    
9491    </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>  </blockquote><p>
9532    
9533  </p>  </p>
# Line 5435  Intellectual Property and Copyright Stat Line 9540  Intellectual Property and Copyright Stat
9540  <p>/ MIDI_INPUT_DEVICE SP number  <p>/ MIDI_INPUT_DEVICE SP number
9541                                    
9542  </p>  </p>
9543    <p>/ FX_SEND SP sampler_channel SP fx_send_id
9544                    
9545    </p>
9546  </blockquote><p>  </blockquote><p>
9547    
9548  </p>  </p>
# Line 5486  Intellectual Property and Copyright Stat Line 9594  Intellectual Property and Copyright Stat
9594  <p>/ SOLO SP sampler_channel SP boolean  <p>/ SOLO SP sampler_channel SP boolean
9595                                    
9596  </p>  </p>
9597    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
9598                    
9599    </p>
9600    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
9601                    
9602    </p>
9603    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
9604                    
9605    </p>
9606    </blockquote><p>
9607    
9608    </p>
9609    <p>modal_arg =
9610            </p>
9611    <blockquote class="text">
9612    <p>/* epsilon (empty argument) */
9613                    
9614    </p>
9615    <p>/ NON_MODAL SP
9616                    
9617    </p>
9618  </blockquote><p>  </blockquote><p>
9619    
9620  </p>  </p>
# Line 5534  Intellectual Property and Copyright Stat Line 9663  Intellectual Property and Copyright Stat
9663  <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS  <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
9664                                    
9665  </p>  </p>
9666    <p>/ MIDI_INSTRUMENTS SP midi_map
9667                    
9668    </p>
9669    <p>/ MIDI_INSTRUMENTS SP ALL
9670                    
9671    </p>
9672    <p>/ MIDI_INSTRUMENT_MAPS
9673                    
9674    </p>
9675    <p>/ FX_SENDS SP sampler_channel
9676                    
9677    </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 5558  Intellectual Property and Copyright Stat Line 9711  Intellectual Property and Copyright Stat
9711  </blockquote><p>  </blockquote><p>
9712    
9713  </p>  </p>
9714    <p>instr_load_mode =
9715            </p>
9716    <blockquote class="text">
9717    <p>ON_DEMAND
9718                    
9719    </p>
9720    <p>/ ON_DEMAND_HOLD
9721                    
9722    </p>
9723    <p>/ PERSISTENT
9724                    
9725    </p>
9726    </blockquote><p>
9727    
9728    </p>
9729  <p>device_index =  <p>device_index =
9730          </p>          </p>
9731  <blockquote class="text">  <blockquote class="text">
# Line 5615  Intellectual Property and Copyright Stat Line 9783  Intellectual Property and Copyright Stat
9783  </blockquote><p>  </blockquote><p>
9784    
9785  </p>  </p>
9786    <p>midi_map =
9787            </p>
9788    <blockquote class="text">
9789    <p>number
9790                    
9791    </p>
9792    </blockquote><p>
9793    
9794    </p>
9795    <p>midi_bank =
9796            </p>
9797    <blockquote class="text">
9798    <p>number
9799                    
9800    </p>
9801    </blockquote><p>
9802    
9803    </p>
9804    <p>midi_prog =
9805            </p>
9806    <blockquote class="text">
9807    <p>number
9808                    
9809    </p>
9810    </blockquote><p>
9811    
9812    </p>
9813    <p>midi_ctrl =
9814            </p>
9815    <blockquote class="text">
9816    <p>number
9817                    
9818    </p>
9819    </blockquote><p>
9820    
9821    </p>
9822  <p>volume_value =  <p>volume_value =
9823          </p>          </p>
9824  <blockquote class="text">  <blockquote class="text">
# Line 5645  Intellectual Property and Copyright Stat Line 9849  Intellectual Property and Copyright Stat
9849  </blockquote><p>  </blockquote><p>
9850    
9851  </p>  </p>
9852    <p>fx_send_id =
9853            </p>
9854    <blockquote class="text">
9855    <p>number
9856                    
9857    </p>
9858    </blockquote><p>
9859    
9860    </p>
9861  <p>engine_name =  <p>engine_name =
9862          </p>          </p>
9863  <blockquote class="text">  <blockquote class="text">
# Line 5654  Intellectual Property and Copyright Stat Line 9867  Intellectual Property and Copyright Stat
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 5663  Intellectual Property and Copyright Stat Line 9894  Intellectual Property and Copyright Stat
9894  </blockquote><p>  </blockquote><p>
9895    
9896  </p>  </p>
9897    <p>map_name =
9898            </p>
9899    <blockquote class="text">
9900    <p>stringval
9901                    
9902    </p>
9903    </blockquote><p>
9904    
9905    </p>
9906    <p>entry_name =
9907            </p>
9908    <blockquote class="text">
9909    <p>stringval
9910                    
9911    </p>
9912    </blockquote><p>
9913    
9914    </p>
9915    <p>fx_send_name =
9916            </p>
9917    <blockquote class="text">
9918    <p>stringval
9919                    
9920    </p>
9921    </blockquote><p>
9922    
9923    </p>
9924  <p>param_val_list =  <p>param_val_list =
9925          </p>          </p>
9926  <blockquote class="text">  <blockquote class="text">
# Line 5693  Intellectual Property and Copyright Stat Line 9951  Intellectual Property and Copyright Stat
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="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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;Events</h3>  <a name="rfc.section.8"></a><h3>8.&nbsp;
9996    Events</h3>
9997    
9998  <p>This chapter will describe all currently defined events supported by LinuxSampler.  <p>This chapter will describe all currently defined events supported by LinuxSampler.
9999  </p>  </p>
10000  <a name="SUBSCRIBE CHANNEL"></a><br /><hr />  <a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"></a><br /><hr />
10001  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
10002  <a name="rfc.section.8.1"></a><h3>8.1.&nbsp;Number of sampler channels changed</h3>  <a name="rfc.section.8.1"></a><h3>8.1.&nbsp;
10003    Number of audio output devices changed</h3>
10004    
10005    <p>Client may want to be notified when the total number of audio output devices on the
10006                    back-end changes by issuing the following command:
10007    </p>
10008    <p>
10009                        </p>
10010    <blockquote class="text">
10011    <p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
10012    </p>
10013    </blockquote><p>
10014                    
10015    </p>
10016    <p>Server will start sending the following notification messages:
10017    </p>
10018    <p>
10019                        </p>
10020    <blockquote class="text">
10021    <p>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"
10022    </p>
10023    </blockquote><p>
10024                    
10025    </p>
10026    <p>where &lt;devices&gt; will be replaced by the new number
10027                    of audio output devices.
10028    </p>
10029    <a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"></a><br /><hr />
10030    <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>
10031    <a name="rfc.section.8.2"></a><h3>8.2.&nbsp;
10032    Audio output device's settings changed</h3>
10033    
10034    <p>Client may want to be notified when changes were made to audio output devices on the
10035                    back-end by issuing the following command:
10036    </p>
10037    <p>
10038                        </p>
10039    <blockquote class="text">
10040    <p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
10041    </p>
10042    </blockquote><p>
10043                    
10044    </p>
10045    <p>Server will start sending the following notification messages:
10046    </p>
10047    <p>
10048                        </p>
10049    <blockquote class="text">
10050    <p>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"
10051    </p>
10052    </blockquote><p>
10053                    
10054    </p>
10055    <p>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
10056                    which settings has been changed. The front-end will have to send
10057                    the respective command to actually get the audio output device info. Because these messages
10058                    will be triggered by LSCP commands issued by other clients rather than real
10059                    time events happening on the server, it is believed that an empty notification
10060                    message is sufficient here.
10061    </p>
10062    <a name="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"></a><br /><hr />
10063    <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>
10064    <a name="rfc.section.8.3"></a><h3>8.3.&nbsp;
10065    Number of MIDI input devices changed</h3>
10066    
10067    <p>Client may want to be notified when the total number of MIDI input devices on the
10068                    back-end changes by issuing the following command:
10069    </p>
10070    <p>
10071                        </p>
10072    <blockquote class="text">
10073    <p>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
10074    </p>
10075    </blockquote><p>
10076                    
10077    </p>
10078    <p>Server will start sending the following notification messages:
10079    </p>
10080    <p>
10081                        </p>
10082    <blockquote class="text">
10083    <p>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"
10084    </p>
10085    </blockquote><p>
10086                    
10087    </p>
10088    <p>where &lt;devices&gt; will be replaced by the new number
10089                    of MIDI input devices.
10090    </p>
10091    <a name="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"></a><br /><hr />
10092    <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>
10093    <a name="rfc.section.8.4"></a><h3>8.4.&nbsp;
10094    MIDI input device's settings changed</h3>
10095    
10096    <p>Client may want to be notified when changes were made to MIDI input devices on the
10097                    back-end by issuing the following command:
10098    </p>
10099    <p>
10100                        </p>
10101    <blockquote class="text">
10102    <p>SUBSCRIBE MIDI_INPUT_DEVICE_INFO
10103    </p>
10104    </blockquote><p>
10105                    
10106    </p>
10107    <p>Server will start sending the following notification messages:
10108    </p>
10109    <p>
10110                        </p>
10111    <blockquote class="text">
10112    <p>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"
10113    </p>
10114    </blockquote><p>
10115                    
10116    </p>
10117    <p>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
10118                    which settings has been changed. The front-end will have to send
10119                    the respective command to actually get the MIDI input device info. Because these messages
10120                    will be triggered by LSCP commands issued by other clients rather than real
10121                    time events happening on the server, it is believed that an empty notification
10122                    message is sufficient here.
10123    </p>
10124    <a name="SUBSCRIBE CHANNEL_COUNT"></a><br /><hr />
10125    <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>
10126    <a name="rfc.section.8.5"></a><h3>8.5.&nbsp;
10127    Number of sampler channels changed</h3>
10128    
10129  <p>Client may want to be notified when the total number of channels on the  <p>Client may want to be notified when the total number of channels on the
10130                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 5728  Intellectual Property and Copyright Stat Line 10151  Intellectual Property and Copyright Stat
10151                  of sampler channels.                  of sampler channels.
10152  </p>  </p>
10153  <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />
10154  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
10155  <a name="rfc.section.8.2"></a><h3>8.2.&nbsp;Number of active voices changed</h3>  <a name="rfc.section.8.6"></a><h3>8.6.&nbsp;
10156    Number of active voices changed</h3>
10157    
10158  <p>Client may want to be notified when the number of voices on the  <p>Client may want to be notified when the number of voices on the
10159                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 5747  Intellectual Property and Copyright Stat Line 10171  Intellectual Property and Copyright Stat
10171  <p>  <p>
10172                      </p>                      </p>
10173  <blockquote class="text">  <blockquote class="text">
10174  <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;  <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"
10175  </p>  </p>
10176  </blockquote><p>  </blockquote><p>
10177                                    
# Line 5757  Intellectual Property and Copyright Stat Line 10181  Intellectual Property and Copyright Stat
10181                  active voices on that channel.                  active voices on that channel.
10182  </p>  </p>
10183  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />
10184  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
10185  <a name="rfc.section.8.3"></a><h3>8.3.&nbsp;Number of active disk streams changed</h3>  <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;
10186    Number of active disk streams changed</h3>
10187    
10188  <p>Client may want to be notified when the number of streams on the back-end  <p>Client may want to be notified when the number of streams on the back-end
10189                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT
# Line 5786  Intellectual Property and Copyright Stat Line 10211  Intellectual Property and Copyright Stat
10211                  active disk streams on that channel.                  active disk streams on that channel.
10212  </p>  </p>
10213  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />
10214  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
10215  <a name="rfc.section.8.4"></a><h3>8.4.&nbsp;Disk stream buffer fill state changed</h3>  <a name="rfc.section.8.8"></a><h3>8.8.&nbsp;
10216    Disk stream buffer fill state changed</h3>
10217    
10218  <p>Client may want to be notified when the buffer fill state of a disk stream  <p>Client may want to be notified when the buffer fill state of a disk stream
10219                  on the back-end changes by issuing the following command:                  on the back-end changes by issuing the following command:
# Line 5812  Intellectual Property and Copyright Stat Line 10238  Intellectual Property and Copyright Stat
10238  </p>  </p>
10239  <p>where &lt;sampler-channel&gt; will be replaced by the sampler channel the  <p>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
10240                  buffer fill state change occurred on and &lt;fill-data&gt; will be replaced by the                  buffer fill state change occurred on and &lt;fill-data&gt; will be replaced by the
10241                  buffer fill data for this channel as described in <a class="info" href="#GET CHANNEL BUFFER_FILL">Section&nbsp;6.4.13<span> (</span><span class="info">Current fill state of disk stream buffers</span><span>)</span></a>                  buffer fill data for this channel as described in <a class='info' href='#GET CHANNEL BUFFER_FILL'>Section&nbsp;6.4.13<span> (</span><span class='info'>Current fill state of disk stream buffers</span><span>)</span></a>
10242                  as if the <a class="info" href="#GET CHANNEL BUFFER_FILL">"GET CHANNEL BUFFER_FILL PERCENTAGE"<span> (</span><span class="info">Current fill state of disk stream buffers</span><span>)</span></a> command was issued on this channel.                  as if the <a class='info' href='#GET CHANNEL BUFFER_FILL'>"GET CHANNEL BUFFER_FILL PERCENTAGE"<span> (</span><span class='info'>Current fill state of disk stream buffers</span><span>)</span></a> command was issued on this channel.
10243  </p>  </p>
10244  <a name="SUBSCRIBE INFO"></a><br /><hr />  <a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr />
10245  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
10246  <a name="rfc.section.8.5"></a><h3>8.5.&nbsp;Channel information changed</h3>  <a name="rfc.section.8.9"></a><h3>8.9.&nbsp;
10247    Channel information changed</h3>
10248    
10249  <p>Client may want to be notified when changes were made to sampler channels on the  <p>Client may want to be notified when changes were made to sampler channels on the
10250                  back-end by issuing the following command:                  back-end by issuing the following command:
# Line 5847  Intellectual Property and Copyright Stat Line 10274  Intellectual Property and Copyright Stat
10274                  time events happening on the server, it is believed that an empty notification                  time events happening on the server, it is believed that an empty notification
10275                  message is sufficient here.                  message is sufficient here.
10276  </p>  </p>
10277    <a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr />
10278    <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>
10279    <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
10280    Number of effect sends changed</h3>
10281    
10282    <p>Client may want to be notified when the number of effect sends on
10283                    a particular sampler channel is changed by issuing the following command:
10284    </p>
10285    <p>
10286                        </p>
10287    <blockquote class="text">
10288    <p>SUBSCRIBE FX_SEND_COUNT
10289    </p>
10290    </blockquote><p>
10291                    
10292    </p>
10293    <p>Server will start sending the following notification messages:
10294    </p>
10295    <p>
10296                        </p>
10297    <blockquote class="text">
10298    <p>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"
10299    </p>
10300    </blockquote><p>
10301                    
10302    </p>
10303    <p>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
10304                    channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
10305                    be replaced by the new number of effect sends on that channel.
10306    </p>
10307    <a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr />
10308    <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>
10309    <a name="rfc.section.8.11"></a><h3>8.11.&nbsp;
10310    Effect send information changed</h3>
10311    
10312    <p>Client may want to be notified when changes were made to effect sends on a
10313                    a particular sampler channel by issuing the following command:
10314    </p>
10315    <p>
10316                        </p>
10317    <blockquote class="text">
10318    <p>SUBSCRIBE FX_SEND_INFO
10319    </p>
10320    </blockquote><p>
10321                    
10322    </p>
10323    <p>Server will start sending the following notification messages:
10324    </p>
10325    <p>
10326                        </p>
10327    <blockquote class="text">
10328    <p>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"
10329    </p>
10330    </blockquote><p>
10331                    
10332    </p>
10333    <p>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
10334                    channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
10335                    be replaced by the numerical ID of the changed effect send.
10336    </p>
10337  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />
10338  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
10339  <a name="rfc.section.8.6"></a><h3>8.6.&nbsp;Total number of active voices changed</h3>  <a name="rfc.section.8.12"></a><h3>8.12.&nbsp;
10340    Total number of active voices changed</h3>
10341    
10342  <p>Client may want to be notified when the total number of voices on the  <p>Client may want to be notified when the total number of voices on the
10343                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 5867  Intellectual Property and Copyright Stat Line 10355  Intellectual Property and Copyright Stat
10355  <p>  <p>
10356                      </p>                      </p>
10357  <blockquote class="text">  <blockquote class="text">
10358  <p>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;  <p>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"
10359  </p>  </p>
10360  </blockquote><p>  </blockquote><p>
10361                                    
# Line 5875  Intellectual Property and Copyright Stat Line 10363  Intellectual Property and Copyright Stat
10363  <p>where &lt;voices&gt; will be replaced by the new number of  <p>where &lt;voices&gt; will be replaced by the new number of
10364                  all currently active voices.                  all currently active voices.
10365  </p>  </p>
10366    <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr />
10367    <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>
10368    <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;
10369    Number of MIDI instrument maps changed</h3>
10370    
10371    <p>Client may want to be notified when the number of MIDI instrument maps on the
10372                    back-end changes by issuing the following command:
10373    </p>
10374    <p>
10375                        </p>
10376    <blockquote class="text">
10377    <p>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
10378    </p>
10379    </blockquote><p>
10380                    
10381    </p>
10382    <p>Server will start sending the following notification messages:
10383    </p>
10384    <p>
10385                        </p>
10386    <blockquote class="text">
10387    <p>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"
10388    </p>
10389    </blockquote><p>
10390                    
10391    </p>
10392    <p>where &lt;maps&gt; will be replaced by the new number
10393                    of MIDI instrument maps.
10394    </p>
10395    <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr />
10396    <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>
10397    <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;
10398    MIDI instrument map information changed</h3>
10399    
10400    <p>Client may want to be notified when changes were made to MIDI instrument maps on the
10401                    back-end by issuing the following command:
10402    </p>
10403    <p>
10404                        </p>
10405    <blockquote class="text">
10406    <p>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
10407    </p>
10408    </blockquote><p>
10409                    
10410    </p>
10411    <p>Server will start sending the following notification messages:
10412    </p>
10413    <p>
10414                        </p>
10415    <blockquote class="text">
10416    <p>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"
10417    </p>
10418    </blockquote><p>
10419                    
10420    </p>
10421    <p>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
10422                    for which information changes occurred. The front-end will have to send
10423                    the respective command to actually get the MIDI instrument map info. Because these messages
10424                    will be triggered by LSCP commands issued by other clients rather than real
10425                    time events happening on the server, it is believed that an empty notification
10426                    message is sufficient here.
10427    </p>
10428    <a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr />
10429    <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>
10430    <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;
10431    Number of MIDI instruments changed</h3>
10432    
10433    <p>Client may want to be notified when the number of MIDI instrument maps on the
10434                    back-end changes by issuing the following command:
10435    </p>
10436    <p>
10437                        </p>
10438    <blockquote class="text">
10439    <p>SUBSCRIBE MIDI_INSTRUMENT_COUNT
10440    </p>
10441    </blockquote><p>
10442                    
10443    </p>
10444    <p>Server will start sending the following notification messages:
10445    </p>
10446    <p>
10447                        </p>
10448    <blockquote class="text">
10449    <p>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"
10450    </p>
10451    </blockquote><p>
10452                    
10453    </p>
10454    <p>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
10455                    the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
10456                    the new number of MIDI instruments in the specified map.
10457    </p>
10458    <a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr />
10459    <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>
10460    <a name="rfc.section.8.16"></a><h3>8.16.&nbsp;
10461    MIDI instrument information changed</h3>
10462    
10463    <p>Client may want to be notified when changes were made to MIDI instruments on the
10464                    back-end by issuing the following command:
10465    </p>
10466    <p>
10467                        </p>
10468    <blockquote class="text">
10469    <p>SUBSCRIBE MIDI_INSTRUMENT_INFO
10470    </p>
10471    </blockquote><p>
10472                    
10473    </p>
10474    <p>Server will start sending the following notification messages:
10475    </p>
10476    <p>
10477                        </p>
10478    <blockquote class="text">
10479    <p>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"
10480    </p>
10481    </blockquote><p>
10482                    
10483    </p>
10484    <p>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
10485                    in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
10486                    the location of the changed MIDI instrument in the map. The front-end will have to send
10487                    the respective command to actually get the MIDI instrument info. Because these messages
10488                    will be triggered by LSCP commands issued by other clients rather than real
10489                    time events happening on the server, it is believed that an empty notification
10490                    message is sufficient here.
10491    </p>
10492    <a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr />
10493    <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>
10494    <a name="rfc.section.8.17"></a><h3>8.17.&nbsp;
10495    Global settings changed</h3>
10496    
10497    <p>Client may want to be notified when changes to the global settings
10498                    of the sampler were made by issuing the following command:
10499    </p>
10500    <p>
10501                        </p>
10502    <blockquote class="text">
10503    <p>SUBSCRIBE GLOBAL_INFO
10504    </p>
10505    </blockquote><p>
10506                    
10507    </p>
10508    <p>Server will start sending the following types of notification messages:
10509    </p>
10510    <p>
10511                        </p>
10512    <blockquote class="text">
10513    <p>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
10514                            golbal volume of the sampler is changed, where &lt;volume&gt; will be
10515                            replaced by the optional dotted floating point value, reflecting the
10516                            new global volume parameter.
10517    </p>
10518    </blockquote><p>
10519                    
10520    </p>
10521    <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>
10523    <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 />  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
10713  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
10714  <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;Miscellaneous and debugging events</h3>  <a name="rfc.section.8.23"></a><h3>8.23.&nbsp;
10715    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
10718                  the server by issuing the following command:                  the server by issuing the following command:
# Line 5905  Intellectual Property and Copyright Stat Line 10740  Intellectual Property and Copyright Stat
10740                  user AS IS to facilitate debugging.                  user AS IS to facilitate debugging.
10741  </p>  </p>
10742  <a name="anchor14"></a><br /><hr />  <a name="anchor14"></a><br /><hr />
10743  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
10744  <a name="rfc.section.9"></a><h3>9.&nbsp;Security Considerations</h3>  <a name="rfc.section.9"></a><h3>9.&nbsp;
10745    Security Considerations</h3>
10746    
10747  <p>As there is so far no method of authentication and authorization  <p>As there is so far no method of authentication and authorization
10748              defined and so not required for a client applications to succeed to              defined and so not required for a client applications to succeed to
# Line 5914  Intellectual Property and Copyright Stat Line 10750  Intellectual Property and Copyright Stat
10750              system the LinuxSampler instance is running on.              system the LinuxSampler instance is running on.
10751  </p>  </p>
10752  <a name="anchor15"></a><br /><hr />  <a name="anchor15"></a><br /><hr />
10753  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
10754  <a name="rfc.section.10"></a><h3>10.&nbsp;Acknowledgments</h3>  <a name="rfc.section.10"></a><h3>10.&nbsp;
10755    Acknowledgments</h3>
10756    
10757  <p>This document has benefited greatly from the comments of the  <p>This document has benefited greatly from the comments of the
10758              following people, discussed on the LinuxSampler developer's mailing              following people, discussed on the LinuxSampler developer's mailing
# Line 5936  Intellectual Property and Copyright Stat Line 10773  Intellectual Property and Copyright Stat
10773                            
10774  </p>  </p>
10775  <a name="rfc.references1"></a><br /><hr />  <a name="rfc.references1"></a><br /><hr />
10776  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
10777  <h3>11.&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
10778  <table width="99%" border="0">  <table width="99%" border="0">
10779  <tr><td class="author-text" valign="top"><a name="RFC2119">[RFC2119]</a></td>  <tr><td class="author-text" valign="top"><a name="RFC2119">[RFC2119]</a></td>
# Line 5948  Intellectual Property and Copyright Stat Line 10785  Intellectual Property and Copyright Stat
10785  </table>  </table>
10786    
10787  <a name="rfc.authors"></a><br /><hr />  <a name="rfc.authors"></a><br /><hr />
10788  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
10789  <h3>Author's Address</h3>  <h3>Author's Address</h3>
10790  <table width="99%" border="0" cellpadding="0" cellspacing="0">  <table width="99%" border="0" cellpadding="0" cellspacing="0">
10791  <tr><td class="author-text">&nbsp;</td>  <tr><td class="author-text">&nbsp;</td>
# Line 5966  Schoenebeck</td></tr> Line 10803  Schoenebeck</td></tr>
10803  <td class="author-text"><a href="mailto:schoenebeck at software minus engineering dot org">schoenebeck at software minus engineering dot org</a></td></tr>  <td class="author-text"><a href="mailto:schoenebeck at software minus engineering dot org">schoenebeck at software minus engineering dot org</a></td></tr>
10804  </table>  </table>
10805  <a name="rfc.copyright"></a><br /><hr />  <a name="rfc.copyright"></a><br /><hr />
10806  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&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>
10807  <h3>Intellectual Property Statement</h3>  <h3>Full Copyright Statement</h3>
10808  <p class='copyright'>  <p class='copyright'>
10809  The IETF takes no position regarding the validity or scope of  Copyright &copy; The IETF Trust (2007).</p>
 any intellectual property or other rights that might be claimed  
 to  pertain to the implementation or use of the technology  
 described in this document or the extent to which any license  
 under such rights might or might not be available; neither does  
 it represent that it has made any effort to identify any such  
 rights. Information on the IETF's procedures with respect to  
 rights in standards-track and standards-related documentation  
 can be found in BCP&nbsp;11. Copies of claims of rights made  
 available for publication and any assurances of licenses to  
 be made available, or the result of an attempt made  
 to obtain a general license or permission for the use of such  
 proprietary rights by implementors or users of this  
 specification can be obtained from the IETF Secretariat.</p>  
10810  <p class='copyright'>  <p class='copyright'>
10811  The IETF invites any interested party to bring to its  This document is subject to the rights,
10812  attention any copyrights, patents or patent applications, or  licenses and restrictions contained in BCP&nbsp;78,
10813  other proprietary rights which may cover technology that may be  and except as set forth therein,
10814  required to practice this standard. Please address the  the authors retain all their rights.</p>
 information to the IETF Executive Director.</p>  
 <h3>Full Copyright Statement</h3>  
10815  <p class='copyright'>  <p class='copyright'>
10816  Copyright &copy; The Internet Society (2006). All Rights Reserved.</p>  This document and the information contained herein are provided
10817    on an &ldquo;AS IS&rdquo; basis and THE CONTRIBUTOR,
10818    THE ORGANIZATION HE/SHE REPRESENTS
10819    OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST
10820    AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES,
10821    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT
10822    THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY
10823    IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
10824    PURPOSE.</p>
10825    <h3>Intellectual Property</h3>
10826  <p class='copyright'>  <p class='copyright'>
10827  This document and translations of it may be copied and furnished to  The IETF takes no position regarding the validity or scope of any
10828  others, and derivative works that comment on or otherwise explain it  Intellectual Property Rights or other rights that might be claimed
10829  or assist in its implementation may be prepared, copied, published and  to pertain to the implementation or use of the technology
10830  distributed, in whole or in part, without restriction of any kind,  described in this document or the extent to which any license
10831  provided that the above copyright notice and this paragraph are  under such rights might or might not be available; nor does it
10832  included on all such copies and derivative works. However, this  represent that it has made any independent effort to identify any
10833  document itself may not be modified in any way, such as by removing  such rights.
10834  the copyright notice or references to the Internet Society or other  Information on the procedures with respect to
10835  Internet organizations, except as needed for the purpose of  rights in RFC documents can be found in BCP&nbsp;78 and BCP&nbsp;79.</p>
 developing Internet standards in which case the procedures for  
 copyrights defined in the Internet Standards process must be  
 followed, or as required to translate it into languages other than  
 English.</p>  
10836  <p class='copyright'>  <p class='copyright'>
10837  The limited permissions granted above are perpetual and will not be  Copies of IPR disclosures made to the IETF Secretariat and any
10838  revoked by the Internet Society or its successors or assignees.</p>  assurances of licenses to be made available,
10839    or the result of an attempt made to obtain a general license or
10840    permission for the use of such proprietary rights by implementers or
10841    users of this specification can be obtained from the IETF on-line IPR
10842    repository at <a href='http://www.ietf.org/ipr'>http://www.ietf.org/ipr</a>.</p>
10843  <p class='copyright'>  <p class='copyright'>
10844  This document and the information contained herein is provided on an  The IETF invites any interested party to bring to its attention
10845  &ldquo;AS IS&rdquo; basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING  any copyrights,
10846  TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING  patents or patent applications,
10847  BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION  or other
10848  HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  proprietary rights that may cover technology that may be required
10849  MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.</p>  to implement this standard.
10850    Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p>
10851  <h3>Acknowledgment</h3>  <h3>Acknowledgment</h3>
10852  <p class='copyright'>  <p class='copyright'>
10853  Funding for the RFC Editor function is currently provided by the  Funding for the RFC Editor function is provided by
10854  Internet Society.</p>  the IETF Administrative Support Activity (IASA).</p>
10855  </body></html>  </body></html>
Legend:
Removed from v.940  
changed lines
  Added in v.1201
  ViewVC Help
Powered by ViewVC