/[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 1162 by iliev, Mon Apr 16 16:02:19 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;
12          font-size: small ; color: #000000 ; background-color: #ffffff ; }          }
13      .title { color: #990000; font-size: x-large ;          h1, h2, h3, h4, h5, h6 {
14          font-weight: bold; text-align: right;                  font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;
15          font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;                  font-weight: bold; font-style: normal;
16          background-color: transparent; }          }
17      .filename { color: #666666; font-size: 18px; line-height: 28px;          h1 { color: #900; background-color: transparent; text-align: right; }
18          font-weight: bold; text-align: right;          h3 { color: #333; background-color: transparent; }
19          font-family: helvetica, arial, sans-serif;  
20          background-color: transparent; }          td.RFCbug {
21      td.rfcbug { background-color: #000000 ; width: 30px ; height: 30px ;                  font-size: x-small; text-decoration: none;
22          text-align: justify; vertical-align: middle ; padding-top: 2px ; }                  width: 30px; height: 30px; padding-top: 2px;
23      td.rfcbug span.RFC { color: #666666; font-weight: bold; text-decoration: none;                  text-align: justify; vertical-align: middle;
24          background-color: #000000 ;                  background-color: #000;
25          font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;          }
26          font-size: x-small ; }          td.RFCbug span.RFC {
27      td.rfcbug span.hotText { color: #ffffff; font-weight: normal; text-decoration: none;                  font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
28          text-align: center ;                  font-weight: bold; color: #666;
29          font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;          }
30          font-size: x-small ; background-color: #000000; }          td.RFCbug span.hotText {
31      /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */                  font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
32      div#counter{margin-top: 100px}                  font-weight: normal; text-align: center; color: #FFF;
33            }
34      a.info{  
35          position:relative; /*this is the key*/          table.TOCbug { width: 30px; height: 15px; }
36          z-index:24;          td.TOCbug {
37          text-decoration:none}                  text-align: center; width: 30px; height: 15px;
38                    color: #FFF; background-color: #900;
39      a.info:hover{z-index:25; background-color:#990000 ; color: #ffffff ;}          }
40            td.TOCbug a {
41      a.info span{display: none}                  font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;
42                    font-weight: bold; font-size: x-small; text-decoration: none;
43      a.info:hover span.info{ /*the span will display just on :hover state*/                  color: #FFF; background-color: transparent;
44          display:block;          }
45          position:absolute;  
46          font-size: smaller ;          td.header {
47          top:2em; left:2em; width:15em;                  font-family: arial, helvetica, sans-serif; font-size: x-small;
48          padding: 2px ;                  vertical-align: top; width: 33%;
49          border:1px solid #333333;                  color: #FFF; background-color: #666;
50          background-color:#eeeeee; color:#990000;          }
51          text-align: left ;}          td.author { font-weight: bold; font-size: x-small; margin-left: 4em; }
52            td.author-text { font-size: x-small; }
53       A { font-weight: bold; }  
54       A:link { color: #990000; background-color: transparent ; }          /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */
55       A:visited { color: #333333; background-color: transparent ; }          a.info {
56       A:active { color: #333333; background-color: transparent ; }                  /* This is the key. */
57                    position: relative;
58      p { margin-left: 2em; margin-right: 2em; }                  z-index: 24;
59      p.copyright { font-size: x-small ; }                  text-decoration: none;
60      p.toc { font-size: small ; font-weight: bold ; margin-left: 3em ;}          }
61      table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; }          a.info:hover {
62      td.toc { font-size: small; font-weight: bold; vertical-align: text-top; }                  z-index: 25;
63                    color: #FFF; background-color: #900;
64      span.emph { font-style: italic; }          }
65      span.strong { font-weight: bold; }          a.info span { display: none; }
66      span.verb, span.vbare { font-family: "Courier New", Courier, monospace ; }          a.info:hover span.info {
67                    /* The span will display just on :hover state. */
68      span.vemph { font-style: italic; font-family: "Courier New", Courier, monospace ; }                  display: block;
69      span.vstrong { font-weight: bold; font-family: "Courier New", Courier, monospace ; }                  position: absolute;
70      span.vdeluxe { font-weight: bold; font-style: italic; font-family: "Courier New", Courier, monospace ; }                  font-size: smaller;
71                    top: 2em; left: -5em; width: 15em;
72      ol.text { margin-left: 2em; margin-right: 2em; }                  padding: 2px; border: 1px solid #333;
73      ul.text { margin-left: 2em; margin-right: 2em; }                  color: #900; background-color: #EEE;
74      li { margin-left: 3em;  }                  text-align: left;
   
     pre { margin-left: 3em; color: #333333;  background-color: transparent;  
         font-family: "Courier New", Courier, monospace ; font-size: small ;  
         text-align: left;  
75          }          }
76    
77      h3 { color: #333333; font-size: medium ;          a { font-weight: bold; }
78          font-family: helvetica, arial, sans-serif ;          a:link    { color: #900; background-color: transparent; }
79          background-color: transparent; }          a:visited { color: #633; background-color: transparent; }
80      h4 { font-size: small; font-family: helvetica, arial, sans-serif ; }          a:active  { color: #633; background-color: transparent; }
81    
82      table.bug { width: 30px ; height: 15px ; }          p { margin-left: 2em; margin-right: 2em; }
83      td.bug { color: #ffffff ; background-color: #990000 ;          p.copyright { font-size: x-small; }
84          text-align: center ; width: 30px ; height: 15px ;          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.bug A.link2 { color: #ffffff ; font-weight: bold;          td.toc { font-size: small; font-weight: bold; vertical-align: text-top; }
87          text-decoration: none;  
88          font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;          ol.text { margin-left: 2em; margin-right: 2em; }
89          font-size: x-small ; background-color: transparent }          ul.text { margin-left: 2em; margin-right: 2em; }
90            li      { margin-left: 3em; }
91      td.header { color: #ffffff; font-size: x-small ;  
92          font-family: arial, helvetica, sans-serif; vertical-align: top;          /* RFC-2629 <spanx>s and <artwork>s. */
93          background-color: #666666 ; width: 33% ; }          em     { font-style: italic; }
94      td.author { font-weight: bold; margin-left: 4em; font-size: x-small ; }          strong { font-weight: bold; }
95      td.author-text { font-size: x-small; }          dfn    { font-weight: bold; font-style: normal; }
96      table.full { vertical-align: top ; border-collapse: collapse ;          cite   { font-weight: normal; font-style: normal; }
97          border-style: solid solid solid solid ;          tt     { color: #036; }
98          border-color: black black black black ;          tt, pre, pre dfn, pre em, pre cite, pre span {
99          font-size: small ; text-align: center ; }                  font-family: "Courier New", Courier, monospace; font-size: small;
100      table.headers, table.none { vertical-align: top ; border-collapse: collapse ;          }
101          border-style: none;          pre {
102          font-size: small ; text-align: center ; }                  text-align: left; padding: 4px;
103      table.full th { font-weight: bold ;                  color: #000; background-color: #CCC;
104          border-style: solid ;          }
105          border-color: black black black black ; }          pre dfn  { color: #900; }
106      table.headers th { font-weight: bold ;          pre em   { color: #66F; background-color: #FFC; font-weight: normal; }
107          border-style: none none solid none;          pre .key { color: #33C; font-weight: bold; }
108          border-color: black black black black ; }          pre .id  { color: #900; }
109      table.none th { font-weight: bold ;          pre .str { color: #000; background-color: #CFF; }
110          border-style: none; }          pre .val { color: #066; }
111      table.full td {          pre .rep { color: #909; }
112          border-style: solid solid solid solid ;          pre .oth { color: #000; background-color: #FCF; }
113          border-color: #333333 #333333 #333333 #333333 ; }          pre .err { background-color: #FCC; }
114      table.headers td, table.none td { border-style: none; }  
115            /* RFC-2629 <texttable>s. */
116      hr { height: 1px }          table.all, table.full, table.headers, table.none {
117  -->                  font-size: small; text-align: center; border-width: 2px;
118  </style>                  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: October 18, 2007</td><td class="header">April 16, 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 October 18, 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="#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">6.8.8.</a>&nbsp;
408    Changing the description of directory<br />
409    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD DB_INSTRUMENTS">6.8.9.</a>&nbsp;
410    Adding instruments to the instruments database<br />
411    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE DB_INSTRUMENT">6.8.10.</a>&nbsp;
412    Removing an instrument<br />
413    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENTS">6.8.11.</a>&nbsp;
414    Getting amount of instruments<br />
415    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST DB_INSTRUMENTS">6.8.12.</a>&nbsp;
416    Listing all instruments in specific directory<br />
417    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT INFO">6.8.13.</a>&nbsp;
418    Getting instrument information<br />
419    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT NAME">6.8.14.</a>&nbsp;
420    Renaming an instrument<br />
421    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MOVE DB_INSTRUMENT">6.8.15.</a>&nbsp;
422    Moving an instrument<br />
423    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT DESCRIPTION">6.8.16.</a>&nbsp;
424    Changing the description of instrument<br />
425  <a href="#command_syntax">7.</a>&nbsp;  <a href="#command_syntax">7.</a>&nbsp;
426  Command Syntax<br />  Command Syntax<br />
427  <a href="#events">8.</a>&nbsp;  <a href="#events">8.</a>&nbsp;
428  Events<br />  Events<br />
429  &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;
430    Number of audio output devices changed<br />
431    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">8.2.</a>&nbsp;
432    Audio output device's settings changed<br />
433    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">8.3.</a>&nbsp;
434    Number of MIDI input devices changed<br />
435    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INPUT_DEVICE_INFO">8.4.</a>&nbsp;
436    MIDI input device's settings changed<br />
437    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a>&nbsp;
438  Number of sampler channels changed<br />  Number of sampler channels changed<br />
439  &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;
440  Number of active voices changed<br />  Number of active voices changed<br />
441  &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;
442  Number of active disk streams changed<br />  Number of active disk streams changed<br />
443  &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;
444  Disk stream buffer fill state changed<br />  Disk stream buffer fill state changed<br />
445  &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;
446  Channel information changed<br />  Channel information changed<br />
447  &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;
448    Number of effect sends changed<br />
449    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_INFO">8.11.</a>&nbsp;
450    Effect send information changed<br />
451    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a>&nbsp;
452  Total number of active voices changed<br />  Total number of active voices changed<br />
453  &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;
454    Number of MIDI instrument maps changed<br />
455    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.14.</a>&nbsp;
456    MIDI instrument map information changed<br />
457    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.15.</a>&nbsp;
458    Number of MIDI instruments changed<br />
459    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.16.</a>&nbsp;
460    MIDI instrument information changed<br />
461    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a>&nbsp;
462    Global settings changed<br />
463    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.18.</a>&nbsp;
464    Number of database instrument directories changed<br />
465    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.19.</a>&nbsp;
466    Database instrument directory information changed<br />
467    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.20.</a>&nbsp;
468    Number of database instruments changed<br />
469    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.21.</a>&nbsp;
470    Database instrument information changed<br />
471    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.22.</a>&nbsp;
472  Miscellaneous and debugging events<br />  Miscellaneous and debugging events<br />
473  <a href="#anchor14">9.</a>&nbsp;  <a href="#anchor14">9.</a>&nbsp;
474  Security Considerations<br />  Security Considerations<br />
# Line 350  Intellectual Property and Copyright Stat Line 484  Intellectual Property and Copyright Stat
484  <br clear="all" />  <br clear="all" />
485    
486  <a name="anchor1"></a><br /><hr />  <a name="anchor1"></a><br /><hr />
487  <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>
488  <a name="rfc.section.1"></a><h3>1.&nbsp;Requirements notation</h3>  <a name="rfc.section.1"></a><h3>1.&nbsp;
489    Requirements notation</h3>
490    
491  <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",  <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
492              "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",              "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
493              and "OPTIONAL" in this document are to be interpreted as              and "OPTIONAL" in this document are to be interpreted as
494              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>.
495  </p>  </p>
496  <p>This protocol is always case-sensitive if not explicitly  <p>This protocol is always case-sensitive if not explicitly
497              claimed the opposite.              claimed the opposite.
# Line 432  Intellectual Property and Copyright Stat Line 567  Intellectual Property and Copyright Stat
567              return and line feed characters respectively.              return and line feed characters respectively.
568  </p>  </p>
569  <a name="LSCP versioning"></a><br /><hr />  <a name="LSCP versioning"></a><br /><hr />
570  <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>
571  <a name="rfc.section.2"></a><h3>2.&nbsp;Versioning of this specification</h3>  <a name="rfc.section.2"></a><h3>2.&nbsp;
572    Versioning of this specification</h3>
573    
574  <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
575              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 612  Intellectual Property and Copyright Stat
612  <p>  <p>
613              Compatibility can only be claimed if both rules are true.              Compatibility can only be claimed if both rules are true.
614              The frontend can use the              The frontend can use the
615              <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
616              get the version of the LSCP specification the sampler complies with.              get the version of the LSCP specification the sampler complies with.
617                            
618  </p>  </p>
619  <a name="anchor2"></a><br /><hr />  <a name="anchor2"></a><br /><hr />
620  <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>
621  <a name="rfc.section.3"></a><h3>3.&nbsp;Introduction</h3>  <a name="rfc.section.3"></a><h3>3.&nbsp;
622    Introduction</h3>
623    
624  <p>LinuxSampler is a so called software sampler application  <p>LinuxSampler is a so called software sampler application
625              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 639  Intellectual Property and Copyright Stat
639              there.              there.
640  </p>  </p>
641  <a name="anchor3"></a><br /><hr />  <a name="anchor3"></a><br /><hr />
642  <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>
643  <a name="rfc.section.4"></a><h3>4.&nbsp;Focus of this protocol</h3>  <a name="rfc.section.4"></a><h3>4.&nbsp;
644    Focus of this protocol</h3>
645    
646  <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
647              a running LinuxSampler instance and to retrieve information              a running LinuxSampler instance and to retrieve information
# Line 514  Intellectual Property and Copyright Stat Line 652  Intellectual Property and Copyright Stat
652              via MIDI System Exclusive Messages.              via MIDI System Exclusive Messages.
653  </p>  </p>
654  <a name="anchor4"></a><br /><hr />  <a name="anchor4"></a><br /><hr />
655  <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>
656  <a name="rfc.section.5"></a><h3>5.&nbsp;Communication Overview</h3>  <a name="rfc.section.5"></a><h3>5.&nbsp;
657    Communication Overview</h3>
658    
659  <p>There are two distinct methods of communication between a  <p>There are two distinct methods of communication between a
660              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 668  Intellectual Property and Copyright Stat
668              methods will be described next.              methods will be described next.
669  </p>  </p>
670  <a name="anchor5"></a><br /><hr />  <a name="anchor5"></a><br /><hr />
671  <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>
672  <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;
673    Request/response communication method</h3>
674    
675  <p>This simple communication method is based on  <p>This simple communication method is based on
676                  <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
677                  front-end application establishes a TCP connection to the                  front-end application establishes a TCP connection to the
678                  LinuxSampler instance on a certain host system. Then the                  LinuxSampler instance on a certain host system. Then the
679                  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 714  Intellectual Property and Copyright Stat
714                  MUST be sent back in the same order.                  MUST be sent back in the same order.
715  </p>  </p>
716  <a name="anchor6"></a><br /><hr />  <a name="anchor6"></a><br /><hr />
717  <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>
718  <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;
719    Result format</h3>
720    
721  <p>Result set could be one of the following types:  <p>Result set could be one of the following types:
722  </p>  </p>
# Line 766  Intellectual Property and Copyright Stat Line 907  Intellectual Property and Copyright Stat
907                                            
908  </p>  </p>
909  <a name="anchor7"></a><br /><hr />  <a name="anchor7"></a><br /><hr />
910  <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>
911  <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;
912    Subscribe/notify communication method</h3>
913    
914  <p>This more sophisticated communication method is actually  <p>This more sophisticated communication method is actually
915                  only an extension of the simple request/response                  only an extension of the simple request/response
# Line 844  Intellectual Property and Copyright Stat Line 986  Intellectual Property and Copyright Stat
986  </p>  </p>
987  <p>where &lt;event-id&gt; will be replace by the respective  <p>where &lt;event-id&gt; will be replace by the respective
988                  event that client is no longer interested in receiving. For                  event that client is no longer interested in receiving. For
989                  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>.
990  </p>  </p>
991  <p>Example: the fill states of disk stream buffers have  <p>Example: the fill states of disk stream buffers have
992                  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 1032  Intellectual Property and Copyright Stat
1032                  it wants to receive.                  it wants to receive.
1033  </p>  </p>
1034  <a name="control_commands"></a><br /><hr />  <a name="control_commands"></a><br /><hr />
1035  <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>
1036  <a name="rfc.section.6"></a><h3>6.&nbsp;Description for control commands</h3>  <a name="rfc.section.6"></a><h3>6.&nbsp;
1037    Description for control commands</h3>
1038    
1039  <p>This chapter will describe the available control commands  <p>This chapter will describe the available control commands
1040              that can be sent on the TCP connection in detail. Some certain              that can be sent on the TCP connection in detail. Some certain
1041              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>
1042              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
1043              multiple-line responses. In this case LinuxSampler signals the              multiple-line responses. In this case LinuxSampler signals the
1044              end of the response by a "." (single dot) line.              end of the response by a "." (single dot) line.
1045  </p>  </p>
1046  <a name="anchor8"></a><br /><hr />  <a name="anchor8"></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.1"></a><h3>6.1.&nbsp;Ignored lines and comments</h3>  <a name="rfc.section.6.1"></a><h3>6.1.&nbsp;
1049    Ignored lines and comments</h3>
1050    
1051  <p>White lines, that is lines which only contain space and  <p>White lines, that is lines which only contain space and
1052                  tabulator characters, and lines that start with a "#"                  tabulator characters, and lines that start with a "#"
# Line 911  Intellectual Property and Copyright Stat Line 1055  Intellectual Property and Copyright Stat
1055                  file.                  file.
1056  </p>  </p>
1057  <a name="anchor9"></a><br /><hr />  <a name="anchor9"></a><br /><hr />
1058  <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>
1059  <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;
1060    Configuring audio drivers</h3>
1061    
1062  <p>Instances of drivers in LinuxSampler are called devices.  <p>Instances of drivers in LinuxSampler are called devices.
1063                  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 1091  Intellectual Property and Copyright Stat
1091                  possible values, etc.                  possible values, etc.
1092  </p>  </p>
1093  <a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />  <a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />
1094  <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>
1095  <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;
1096    Getting amount of available audio output drivers</h3>
1097    
1098  <p>Use the following command to get the number of  <p>Use the following command to get the number of
1099                      audio output drivers currently available for the                      audio output drivers currently available for the
# Line 985  Intellectual Property and Copyright Stat Line 1131  Intellectual Property and Copyright Stat
1131                                            
1132  </p>  </p>
1133  <a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />  <a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />
1134  <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>
1135  <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;
1136    Getting all available audio output drivers</h3>
1137    
1138  <p>Use the following command to list all audio output  <p>Use the following command to list all audio output
1139                      drivers currently available for the LinuxSampler                      drivers currently available for the LinuxSampler
# Line 1025  Intellectual Property and Copyright Stat Line 1172  Intellectual Property and Copyright Stat
1172                                            
1173  </p>  </p>
1174  <a name="GET AUDIO_OUTPUT_DRIVER INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DRIVER INFO"></a><br /><hr />
1175  <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>
1176  <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;
1177    Getting information about a specific audio
1178                  output driver</h3>                  output driver</h3>
1179    
1180  <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 1191  Intellectual Property and Copyright Stat
1191  </p>  </p>
1192  <p>Where &lt;audio-output-driver&gt; is the name of the  <p>Where &lt;audio-output-driver&gt; is the name of the
1193                      audio output driver, returned by the                      audio output driver, returned by the
1194                      <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.
1195  </p>  </p>
1196  <p>Possible Answers:  <p>Possible Answers:
1197  </p>  </p>
# Line 1124  Intellectual Property and Copyright Stat Line 1272  Intellectual Property and Copyright Stat
1272                                            
1273  </p>  </p>
1274  <a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"></a><br /><hr />
1275  <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>
1276  <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;
1277    Getting information about specific audio
1278                  output driver parameter</h3>                  output driver parameter</h3>
1279    
1280  <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 1289  Intellectual Property and Copyright Stat
1289                                            
1290  </p>  </p>
1291  <p>Where &lt;audio&gt; is the name of the audio output  <p>Where &lt;audio&gt; is the name of the audio output
1292                      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,
1293                      &lt;prm&gt; a specific parameter name for which information should be                      &lt;prm&gt; a specific parameter name for which information should be
1294                      obtained (as returned by the                      obtained (as returned by the
1295                      <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
1296                      &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
1297                      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
1298                      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 1349  Intellectual Property and Copyright Stat
1349  <blockquote class="text">  <blockquote class="text">
1350  <p>either true or false, defines if this parameter must be  <p>either true or false, defines if this parameter must be
1351                                  given when the device is to be created with the                                  given when the device is to be created with the
1352                                  <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>
1353                                  command (always returned, no matter which driver parameter)                                  command (always returned, no matter which driver parameter)
1354  </p>  </p>
1355  </blockquote>  </blockquote>
# Line 1211  Intellectual Property and Copyright Stat Line 1360  Intellectual Property and Copyright Stat
1360  <blockquote class="text">  <blockquote class="text">
1361  <p>either true or false, if false then this parameter can  <p>either true or false, if false then this parameter can
1362                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
1363                                  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>
1364                                  command (always returned, no matter which driver parameter)                                  command (always returned, no matter which driver parameter)
1365  </p>  </p>
1366  </blockquote>  </blockquote>
# Line 1250  Intellectual Property and Copyright Stat Line 1399  Intellectual Property and Copyright Stat
1399  <blockquote class="text">  <blockquote class="text">
1400  <p>reflects the default value for this parameter which is  <p>reflects the default value for this parameter which is
1401                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
1402                                  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,
1403                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
1404                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
1405                                  apostrophes (')                                  apostrophes (')
# Line 1378  Intellectual Property and Copyright Stat Line 1527  Intellectual Property and Copyright Stat
1527                                            
1528  </p>  </p>
1529  <a name="CREATE AUDIO_OUTPUT_DEVICE"></a><br /><hr />  <a name="CREATE AUDIO_OUTPUT_DEVICE"></a><br /><hr />
1530  <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>
1531  <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;
1532    Creating an audio output device</h3>
1533    
1534  <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:
1535  </p>  </p>
# Line 1393  Intellectual Property and Copyright Stat Line 1543  Intellectual Property and Copyright Stat
1543  </p>  </p>
1544  <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
1545                      output system as returned by the                      output system as returned by the
1546                      <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>
1547                      command and &lt;param-list&gt; by an optional list of driver                      command and &lt;param-list&gt; by an optional list of driver
1548                      specific parameters in form of "key1=val1 key2=val2 ...", where                      specific parameters in form of "key1=val1 key2=val2 ...", where
1549                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
# Line 1462  Intellectual Property and Copyright Stat Line 1612  Intellectual Property and Copyright Stat
1612                                            
1613  </p>  </p>
1614  <a name="DESTROY AUDIO_OUTPUT_DEVICE"></a><br /><hr />  <a name="DESTROY AUDIO_OUTPUT_DEVICE"></a><br /><hr />
1615  <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>
1616  <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;
1617    Destroying an audio output device</h3>
1618    
1619  <p>Use the following command to destroy a created output device:  <p>Use the following command to destroy a created output device:
1620  </p>  </p>
# Line 1477  Intellectual Property and Copyright Stat Line 1628  Intellectual Property and Copyright Stat
1628  </p>  </p>
1629  <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
1630                      audio output device as given by the                      audio output device as given by the
1631                      <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>
1632                      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>
1633                      command.                      command.
1634  </p>  </p>
1635  <p>Possible Answers:  <p>Possible Answers:
# Line 1531  Intellectual Property and Copyright Stat Line 1682  Intellectual Property and Copyright Stat
1682                                            
1683  </p>  </p>
1684  <a name="GET AUDIO_OUTPUT_DEVICES"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DEVICES"></a><br /><hr />
1685  <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>
1686  <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;
1687    Getting all created audio output device count</h3>
1688    
1689  <p>Use the following command to count all created audio output devices:  <p>Use the following command to count all created audio output devices:
1690  </p>  </p>
# Line 1568  Intellectual Property and Copyright Stat Line 1720  Intellectual Property and Copyright Stat
1720                                            
1721  </p>  </p>
1722  <a name="LIST AUDIO_OUTPUT_DEVICES"></a><br /><hr />  <a name="LIST AUDIO_OUTPUT_DEVICES"></a><br /><hr />
1723  <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>
1724  <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;
1725    Getting all created audio output device list</h3>
1726    
1727  <p>Use the following command to list all created audio output devices:  <p>Use the following command to list all created audio output devices:
1728  </p>  </p>
# Line 1605  Intellectual Property and Copyright Stat Line 1758  Intellectual Property and Copyright Stat
1758                                            
1759  </p>  </p>
1760  <a name="GET AUDIO_OUTPUT_DEVICE INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DEVICE INFO"></a><br /><hr />
1761  <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>
1762  <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;
1763    Getting current settings of an audio output device</h3>
1764    
1765  <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:
1766  </p>  </p>
# Line 1620  Intellectual Property and Copyright Stat Line 1774  Intellectual Property and Copyright Stat
1774  </p>  </p>
1775  <p>Where &lt;device-id&gt; should be replaced by numerical ID  <p>Where &lt;device-id&gt; should be replaced by numerical ID
1776                      of the audio output device as e.g. returned by the                      of the audio output device as e.g. returned by the
1777                      <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.
1778  </p>  </p>
1779  <p>Possible Answers:  <p>Possible Answers:
1780  </p>  </p>
# Line 1640  Intellectual Property and Copyright Stat Line 1794  Intellectual Property and Copyright Stat
1794  <blockquote class="text">  <blockquote class="text">
1795  <p>identifier of the used audio output driver, as also  <p>identifier of the used audio output driver, as also
1796                                      returned by the                                      returned by the
1797                                      <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>
1798                                      command                                      command
1799  </p>  </p>
1800  </blockquote>  </blockquote>
# Line 1681  Intellectual Property and Copyright Stat Line 1835  Intellectual Property and Copyright Stat
1835                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
1836                      returned by all audio output devices. Every audio output driver                      returned by all audio output devices. Every audio output driver
1837                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
1838                      <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>)
1839                      which are also returned by this command.                      which are also returned by this command.
1840  </p>  </p>
1841  <p>Example:  <p>Example:
# Line 1711  Intellectual Property and Copyright Stat Line 1865  Intellectual Property and Copyright Stat
1865                                            
1866  </p>  </p>
1867  <a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER"></a><br /><hr />  <a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER"></a><br /><hr />
1868  <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>
1869  <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;
1870    Changing settings of audio output devices</h3>
1871    
1872  <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:
1873  </p>  </p>
# Line 1726  Intellectual Property and Copyright Stat Line 1881  Intellectual Property and Copyright Stat
1881  </p>  </p>
1882  <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
1883                      audio output device as given by the                      audio output device as given by the
1884                      <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>
1885                      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>
1886                      command, &lt;key&gt; by the name of the parameter to change                      command, &lt;key&gt; by the name of the parameter to change
1887                      and &lt;value&gt; by the new value for this parameter.                      and &lt;value&gt; by the new value for this parameter.
1888  </p>  </p>
# Line 1779  Intellectual Property and Copyright Stat Line 1934  Intellectual Property and Copyright Stat
1934                                            
1935  </p>  </p>
1936  <a name="GET AUDIO_OUTPUT_CHANNEL INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_CHANNEL INFO"></a><br /><hr />
1937  <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>
1938  <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;
1939    Getting information about an audio channel</h3>
1940    
1941  <p>Use the following command to get information about an audio channel:  <p>Use the following command to get information about an audio channel:
1942  </p>  </p>
# Line 1793  Intellectual Property and Copyright Stat Line 1949  Intellectual Property and Copyright Stat
1949                                            
1950  </p>  </p>
1951  <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
1952                      <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>
1953                      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>
1954                      command and &lt;audio-chan&gt; the audio channel number.                      command and &lt;audio-chan&gt; the audio channel number.
1955  </p>  </p>
1956  <p>Possible Answers:  <p>Possible Answers:
# Line 1921  Intellectual Property and Copyright Stat Line 2077  Intellectual Property and Copyright Stat
2077                                            
2078  </p>  </p>
2079  <a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"></a><br /><hr />
2080  <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>
2081  <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;
2082    Getting information about specific audio channel parameter</h3>
2083    
2084  <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:
2085  </p>  </p>
# Line 1935  Intellectual Property and Copyright Stat Line 2092  Intellectual Property and Copyright Stat
2092                                            
2093  </p>  </p>
2094  <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
2095                      <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>
2096                      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>
2097                      command, &lt;chan&gt; the audio channel number                      command, &lt;chan&gt; the audio channel number
2098                      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
2099                      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).
2100  </p>  </p>
2101  <p>Possible Answers:  <p>Possible Answers:
2102  </p>  </p>
# Line 2067  Intellectual Property and Copyright Stat Line 2224  Intellectual Property and Copyright Stat
2224                                            
2225  </p>  </p>
2226  <a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"></a><br /><hr />  <a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"></a><br /><hr />
2227  <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>
2228  <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;
2229    Changing settings of audio output channels</h3>
2230    
2231  <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:
2232  </p>  </p>
# Line 2081  Intellectual Property and Copyright Stat Line 2239  Intellectual Property and Copyright Stat
2239                                            
2240  </p>  </p>
2241  <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
2242                      <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>
2243                      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>
2244                      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
2245                      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.
2246  </p>  </p>
# Line 2144  Intellectual Property and Copyright Stat Line 2302  Intellectual Property and Copyright Stat
2302                                            
2303  </p>  </p>
2304  <a name="anchor10"></a><br /><hr />  <a name="anchor10"></a><br /><hr />
2305  <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>
2306  <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;
2307    Configuring MIDI input drivers</h3>
2308    
2309  <p>Instances of drivers in LinuxSampler are called devices. You can use  <p>Instances of drivers in LinuxSampler are called devices. You can use
2310                  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 2333  Intellectual Property and Copyright Stat
2333                  possible values, etc.                  possible values, etc.
2334  </p>  </p>
2335  <a name="GET AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />  <a name="GET AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />
2336  <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>
2337  <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;
2338    Getting amount of available MIDI input drivers</h3>
2339    
2340  <p>Use the following command to get the number of  <p>Use the following command to get the number of
2341                      MIDI input drivers currently available for the                      MIDI input drivers currently available for the
# Line 2213  Intellectual Property and Copyright Stat Line 2373  Intellectual Property and Copyright Stat
2373                                            
2374  </p>  </p>
2375  <a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />  <a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />
2376  <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>
2377  <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;
2378    Getting all available MIDI input drivers</h3>
2379    
2380  <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
2381                      for the LinuxSampler instance:                      for the LinuxSampler instance:
# Line 2251  Intellectual Property and Copyright Stat Line 2412  Intellectual Property and Copyright Stat
2412                                            
2413  </p>  </p>
2414  <a name="GET MIDI_INPUT_DRIVER INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_DRIVER INFO"></a><br /><hr />
2415  <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>
2416  <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;
2417    Getting information about a specific MIDI input driver</h3>
2418    
2419  <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:
2420  </p>  </p>
# Line 2265  Intellectual Property and Copyright Stat Line 2427  Intellectual Property and Copyright Stat
2427                                            
2428  </p>  </p>
2429  <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
2430                      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.
2431  </p>  </p>
2432  <p>Possible Answers:  <p>Possible Answers:
2433  </p>  </p>
# Line 2332  Intellectual Property and Copyright Stat Line 2494  Intellectual Property and Copyright Stat
2494                                            
2495  </p>  </p>
2496  <a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO"></a><br /><hr />
2497  <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>
2498  <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;
2499    Getting information about specific MIDI input driver parameter</h3>
2500    
2501  <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:
2502  </p>  </p>
# Line 2346  Intellectual Property and Copyright Stat Line 2509  Intellectual Property and Copyright Stat
2509                                            
2510  </p>  </p>
2511  <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
2512                      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
2513                      parameter name for which information should be obtained (as returned by the                      parameter name for which information should be obtained (as returned by the
2514                      <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
2515                      of parameters on which the sought parameter &lt;param&gt; depends on,                      of parameters on which the sought parameter &lt;param&gt; depends on,
2516                      &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 ...",
2517                      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 2558  Intellectual Property and Copyright Stat
2558  <blockquote class="text">  <blockquote class="text">
2559  <p>either true or false, defines if this parameter must be  <p>either true or false, defines if this parameter must be
2560                                  given when the device is to be created with the                                  given when the device is to be created with the
2561                                  <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
2562                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2563  </p>  </p>
2564  </blockquote>  </blockquote>
# Line 2406  Intellectual Property and Copyright Stat Line 2569  Intellectual Property and Copyright Stat
2569  <blockquote class="text">  <blockquote class="text">
2570  <p>either true or false, if false then this parameter can  <p>either true or false, if false then this parameter can
2571                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
2572                                  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
2573                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2574  </p>  </p>
2575  </blockquote>  </blockquote>
# Line 2445  Intellectual Property and Copyright Stat Line 2608  Intellectual Property and Copyright Stat
2608  <blockquote class="text">  <blockquote class="text">
2609  <p>reflects the default value for this parameter which is  <p>reflects the default value for this parameter which is
2610                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
2611                                  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,
2612                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
2613                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
2614                                  apostrophes (')                                  apostrophes (')
# Line 2519  Intellectual Property and Copyright Stat Line 2682  Intellectual Property and Copyright Stat
2682                                            
2683  </p>  </p>
2684  <a name="CREATE MIDI_INPUT_DEVICE"></a><br /><hr />  <a name="CREATE MIDI_INPUT_DEVICE"></a><br /><hr />
2685  <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>
2686  <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;
2687    Creating a MIDI input device</h3>
2688    
2689  <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:
2690  </p>  </p>
# Line 2533  Intellectual Property and Copyright Stat Line 2697  Intellectual Property and Copyright Stat
2697                                            
2698  </p>  </p>
2699  <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
2700                      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
2701                      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
2702                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
2703                      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 2753  Intellectual Property and Copyright Stat
2753                                            
2754  </p>  </p>
2755  <a name="DESTROY MIDI_INPUT_DEVICE"></a><br /><hr />  <a name="DESTROY MIDI_INPUT_DEVICE"></a><br /><hr />
2756  <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>
2757  <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;
2758    Destroying a MIDI input device</h3>
2759    
2760  <p>Use the following command to destroy a created MIDI input device:  <p>Use the following command to destroy a created MIDI input device:
2761  </p>  </p>
# Line 2603  Intellectual Property and Copyright Stat Line 2768  Intellectual Property and Copyright Stat
2768                                            
2769  </p>  </p>
2770  <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
2771                      <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>
2772                      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>
2773                      command.                      command.
2774  </p>  </p>
2775  <p>Possible Answers:  <p>Possible Answers:
# Line 2654  Intellectual Property and Copyright Stat Line 2819  Intellectual Property and Copyright Stat
2819                                            
2820  </p>  </p>
2821  <a name="GET MIDI_INPUT_DEVICES"></a><br /><hr />  <a name="GET MIDI_INPUT_DEVICES"></a><br /><hr />
2822  <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>
2823  <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;
2824    Getting all created MIDI input device count</h3>
2825    
2826  <p>Use the following command to count all created MIDI input devices:  <p>Use the following command to count all created MIDI input devices:
2827  </p>  </p>
# Line 2691  Intellectual Property and Copyright Stat Line 2857  Intellectual Property and Copyright Stat
2857                                            
2858  </p>  </p>
2859  <a name="LIST MIDI_INPUT_DEVICES"></a><br /><hr />  <a name="LIST MIDI_INPUT_DEVICES"></a><br /><hr />
2860  <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>
2861  <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;
2862    Getting all created MIDI input device list</h3>
2863    
2864  <p>Use the following command to list all created MIDI input devices:  <p>Use the following command to list all created MIDI input devices:
2865  </p>  </p>
# Line 2738  Intellectual Property and Copyright Stat Line 2905  Intellectual Property and Copyright Stat
2905                                            
2906  </p>  </p>
2907  <a name="GET MIDI_INPUT_DEVICE INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_DEVICE INFO"></a><br /><hr />
2908  <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>
2909  <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;
2910    Getting current settings of a MIDI input device</h3>
2911    
2912  <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:
2913  </p>  </p>
# Line 2752  Intellectual Property and Copyright Stat Line 2920  Intellectual Property and Copyright Stat
2920                                            
2921  </p>  </p>
2922  <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
2923                      <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>
2924                      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>
2925                      command.                      command.
2926  </p>  </p>
2927  <p>Possible Answers:  <p>Possible Answers:
# Line 2776  Intellectual Property and Copyright Stat Line 2944  Intellectual Property and Copyright Stat
2944                                          </p>                                          </p>
2945  <blockquote class="text">  <blockquote class="text">
2946  <p>identifier of the used MIDI input driver, as e.g.  <p>identifier of the used MIDI input driver, as e.g.
2947                                              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>
2948                                              command                                              command
2949  </p>  </p>
2950  </blockquote>  </blockquote>
# Line 2806  Intellectual Property and Copyright Stat Line 2974  Intellectual Property and Copyright Stat
2974                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
2975                      returned by all MIDI input devices. Every MIDI input driver                      returned by all MIDI input devices. Every MIDI input driver
2976                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
2977                      <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
2978                      by this command.                      by this command.
2979  </p>  </p>
2980  <p>Example:  <p>Example:
# Line 2826  Intellectual Property and Copyright Stat Line 2994  Intellectual Property and Copyright Stat
2994                                            
2995  </p>  </p>
2996  <a name="SET MIDI_INPUT_DEVICE_PARAMETER"></a><br /><hr />  <a name="SET MIDI_INPUT_DEVICE_PARAMETER"></a><br /><hr />
2997  <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>
2998  <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;
2999    Changing settings of MIDI input devices</h3>
3000    
3001  <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:
3002  </p>  </p>
# Line 2841  Intellectual Property and Copyright Stat Line 3010  Intellectual Property and Copyright Stat
3010  </p>  </p>
3011  <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
3012                      MIDI input device as returned by the                      MIDI input device as returned by the
3013                      <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>
3014                      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>
3015                      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
3016                      &lt;value&gt; by the new value for this parameter.                      &lt;value&gt; by the new value for this parameter.
3017  </p>  </p>
# Line 2893  Intellectual Property and Copyright Stat Line 3062  Intellectual Property and Copyright Stat
3062                                            
3063  </p>  </p>
3064  <a name="GET MIDI_INPUT_PORT INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_PORT INFO"></a><br /><hr />
3065  <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>
3066  <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;
3067    Getting information about a MIDI port</h3>
3068    
3069  <p>Use the following command to get information about a MIDI port:  <p>Use the following command to get information about a MIDI port:
3070  </p>  </p>
# Line 2907  Intellectual Property and Copyright Stat Line 3077  Intellectual Property and Copyright Stat
3077                                            
3078  </p>  </p>
3079  <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
3080                      <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>
3081                      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>
3082                      command and &lt;midi-port&gt; the MIDI input port number.                      command and &lt;midi-port&gt; the MIDI input port number.
3083  </p>  </p>
3084  <p>Possible Answers:  <p>Possible Answers:
# Line 2955  Intellectual Property and Copyright Stat Line 3125  Intellectual Property and Copyright Stat
3125                                            
3126  </p>  </p>
3127  <a name="GET MIDI_INPUT_PORT_PARAMETER INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_PORT_PARAMETER INFO"></a><br /><hr />
3128  <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>
3129  <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;
3130    Getting information about specific MIDI port parameter</h3>
3131    
3132  <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:
3133  </p>  </p>
# Line 2969  Intellectual Property and Copyright Stat Line 3140  Intellectual Property and Copyright Stat
3140                                            
3141  </p>  </p>
3142  <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
3143                      <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>
3144                      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>
3145                      command, &lt;port&gt; the MIDI port number and                      command, &lt;port&gt; the MIDI port number and
3146                      &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
3147                      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).
3148  </p>  </p>
3149  <p>Possible Answers:  <p>Possible Answers:
3150  </p>  </p>
# Line 3096  Intellectual Property and Copyright Stat Line 3267  Intellectual Property and Copyright Stat
3267                                            
3268  </p>  </p>
3269  <a name="SET MIDI_INPUT_PORT_PARAMETER"></a><br /><hr />  <a name="SET MIDI_INPUT_PORT_PARAMETER"></a><br /><hr />
3270  <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>
3271  <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;
3272    Changing settings of MIDI input ports</h3>
3273    
3274  <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:
3275  </p>  </p>
# Line 3111  Intellectual Property and Copyright Stat Line 3283  Intellectual Property and Copyright Stat
3283  </p>  </p>
3284  <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
3285                      MIDI device as returned by the                      MIDI device as returned by the
3286                      <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>
3287                      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>
3288                      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
3289                      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
3290                      parameter.                      parameter.
# Line 3162  Intellectual Property and Copyright Stat Line 3334  Intellectual Property and Copyright Stat
3334                                            
3335  </p>  </p>
3336  <a name="anchor11"></a><br /><hr />  <a name="anchor11"></a><br /><hr />
3337  <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>
3338  <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;
3339    Configuring sampler channels</h3>
3340    
3341  <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
3342                  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
3343                  MIDI and audio devices.                  MIDI and audio devices.
3344  </p>  </p>
3345  <a name="LOAD INSTRUMENT"></a><br /><hr />  <a name="LOAD INSTRUMENT"></a><br /><hr />
3346  <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>
3347  <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;
3348    Loading an instrument</h3>
3349    
3350  <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:
3351  </p>  </p>
# Line 3193  Intellectual Property and Copyright Stat Line 3367  Intellectual Property and Copyright Stat
3367                      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
3368                      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
3369                      returns immediately and a background process is launched to load the instrument                      returns immediately and a background process is launched to load the instrument
3370                      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>
3371                      command can be used to obtain loading                      command can be used to obtain loading
3372                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks
3373                      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 3421  Intellectual Property and Copyright Stat
3421                                            
3422  </p>  </p>
3423  <a name="LOAD ENGINE"></a><br /><hr />  <a name="LOAD ENGINE"></a><br /><hr />
3424  <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>
3425  <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;
3426    Loading a sampler engine</h3>
3427    
3428  <p>A sampler engine type can be associated to a specific sampler  <p>A sampler engine type can be associated to a specific sampler
3429                      channel by the following command:                      channel by the following command:
# Line 3262  Intellectual Property and Copyright Stat Line 3437  Intellectual Property and Copyright Stat
3437                                            
3438  </p>  </p>
3439  <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
3440                      <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;
3441                      the sampler channel as returned by the                      the sampler channel as returned by the
3442                      <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
3443                      <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
3444                      the engine type should be assigned to. This command should be issued                      the engine type should be assigned to. This command should be issued
3445                      after adding a new sampler channel and before any other control                      after adding a new sampler channel and before any other control
3446                      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 3496  Intellectual Property and Copyright Stat
3496                                            
3497  </p>  </p>
3498  <a name="GET CHANNELS"></a><br /><hr />  <a name="GET CHANNELS"></a><br /><hr />
3499  <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>
3500  <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;
3501    Getting all created sampler channel count</h3>
3502    
3503  <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
3504                      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 3535  Intellectual Property and Copyright Stat
3535                                            
3536  </p>  </p>
3537  <a name="LIST CHANNELS"></a><br /><hr />  <a name="LIST CHANNELS"></a><br /><hr />
3538  <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>
3539  <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;
3540    Getting all created sampler channel list</h3>
3541    
3542  <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
3543                      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 3575  Intellectual Property and Copyright Stat
3575                                            
3576  </p>  </p>
3577  <a name="ADD CHANNEL"></a><br /><hr />  <a name="ADD CHANNEL"></a><br /><hr />
3578  <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>
3579  <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;
3580    Adding a new sampler channel</h3>
3581    
3582  <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
3583                      channel list by sending the following command:                      channel list by sending the following command:
# Line 3472  Intellectual Property and Copyright Stat Line 3650  Intellectual Property and Copyright Stat
3650                                            
3651  </p>  </p>
3652  <a name="REMOVE CHANNEL"></a><br /><hr />  <a name="REMOVE CHANNEL"></a><br /><hr />
3653  <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>
3654  <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;
3655    Removing a sampler channel</h3>
3656    
3657  <p>A sampler channel can be removed by sending the following command:  <p>A sampler channel can be removed by sending the following command:
3658  </p>  </p>
# Line 3487  Intellectual Property and Copyright Stat Line 3666  Intellectual Property and Copyright Stat
3666  </p>  </p>
3667  <p>Where &lt;sampler-channel&gt; should be replaced by the  <p>Where &lt;sampler-channel&gt; should be replaced by the
3668                      number of the sampler channel as given by the                      number of the sampler channel as given by the
3669                      <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>
3670                      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>
3671                      command. The channel numbers of all subsequent sampler channels                      command. The channel numbers of all subsequent sampler channels
3672                      remain the same.                      remain the same.
3673  </p>  </p>
# Line 3538  Intellectual Property and Copyright Stat Line 3717  Intellectual Property and Copyright Stat
3717                                            
3718  </p>  </p>
3719  <a name="GET AVAILABLE_ENGINES"></a><br /><hr />  <a name="GET AVAILABLE_ENGINES"></a><br /><hr />
3720  <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>
3721  <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;
3722    Getting amount of available engines</h3>
3723    
3724  <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:
3725  </p>  </p>
# Line 3574  Intellectual Property and Copyright Stat Line 3754  Intellectual Property and Copyright Stat
3754                                            
3755  </p>  </p>
3756  <a name="LIST AVAILABLE_ENGINES"></a><br /><hr />  <a name="LIST AVAILABLE_ENGINES"></a><br /><hr />
3757  <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>
3758  <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;
3759    Getting all available engines</h3>
3760    
3761  <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:
3762  </p>  </p>
# Line 3613  Intellectual Property and Copyright Stat Line 3794  Intellectual Property and Copyright Stat
3794                                            
3795  </p>  </p>
3796  <a name="GET ENGINE INFO"></a><br /><hr />  <a name="GET ENGINE INFO"></a><br /><hr />
3797  <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>
3798  <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;
3799    Getting information about an engine</h3>
3800    
3801  <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
3802                      sending the following command:                      sending the following command:
# Line 3628  Intellectual Property and Copyright Stat Line 3810  Intellectual Property and Copyright Stat
3810                                            
3811  </p>  </p>
3812  <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
3813                      <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.
3814  </p>  </p>
3815  <p>Possible Answers:  <p>Possible Answers:
3816  </p>  </p>
# Line 3685  Intellectual Property and Copyright Stat Line 3867  Intellectual Property and Copyright Stat
3867                                            
3868  </p>  </p>
3869  <a name="GET CHANNEL INFO"></a><br /><hr />  <a name="GET CHANNEL INFO"></a><br /><hr />
3870  <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>
3871  <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;
3872    Getting sampler channel information</h3>
3873    
3874  <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
3875                      by sending the following command:                      by sending the following command:
# Line 3700  Intellectual Property and Copyright Stat Line 3883  Intellectual Property and Copyright Stat
3883                                            
3884  </p>  </p>
3885  <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
3886                      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>
3887                      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.
3888  </p>  </p>
3889  <p>Possible Answers:  <p>Possible Answers:
3890  </p>  </p>
# Line 3829  Intellectual Property and Copyright Stat Line 4012  Intellectual Property and Copyright Stat
4012                                          </p>                                          </p>
4013  <blockquote class="text">  <blockquote class="text">
4014  <p>optionally dotted number for the channel volume factor  <p>optionally dotted number for the channel volume factor
4015                                              (where a value < 1.0 means attenuation and a value >                                              (where a value &lt; 1.0 means attenuation and a value >
4016                                              1.0 means amplification)                                              1.0 means amplification)
4017  </p>  </p>
4018  </blockquote>  </blockquote>
# Line 3856  Intellectual Property and Copyright Stat Line 4039  Intellectual Property and Copyright Stat
4039  </blockquote>  </blockquote>
4040                                                                            
4041    
4042    <p>MIDI_INSTRUMENT_MAP -
4043                                            </p>
4044    <blockquote class="text">
4045    <p>Determines to which MIDI instrument map this sampler
4046                                                channel is assigned to. Read chapter
4047                                                <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>
4048                                                for a list of possible values.
4049    </p>
4050    </blockquote>
4051                                        
4052    
4053  </blockquote>  </blockquote>
4054                                                            
4055    
# Line 3895  Intellectual Property and Copyright Stat Line 4089  Intellectual Property and Copyright Stat
4089  </p>  </p>
4090  <p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"  <p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"
4091  </p>  </p>
4092    <p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
4093    </p>
4094    <p>&nbsp;&nbsp;&nbsp;"MUTE: false"
4095    </p>
4096    <p>&nbsp;&nbsp;&nbsp;"SOLO: false"
4097    </p>
4098    <p>&nbsp;&nbsp;&nbsp;"MIDI_INSTRUMENT_MAP: NONE"
4099    </p>
4100  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
4101  </p>  </p>
4102  </blockquote><p>  </blockquote><p>
4103                                            
4104  </p>  </p>
4105  <a name="GET CHANNEL VOICE_COUNT"></a><br /><hr />  <a name="GET CHANNEL VOICE_COUNT"></a><br /><hr />
4106  <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>
4107  <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;
4108    Current number of active voices</h3>
4109    
4110  <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
4111                      sampler channel by sending the following command:                      sampler channel by sending the following command:
# Line 3916  Intellectual Property and Copyright Stat Line 4119  Intellectual Property and Copyright Stat
4119                                            
4120  </p>  </p>
4121  <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
4122                      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>
4123                      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.
4124  </p>  </p>
4125  <p>Possible Answers:  <p>Possible Answers:
4126  </p>  </p>
# Line 3941  Intellectual Property and Copyright Stat Line 4144  Intellectual Property and Copyright Stat
4144                                            
4145  </p>  </p>
4146  <a name="GET CHANNEL STREAM_COUNT"></a><br /><hr />  <a name="GET CHANNEL STREAM_COUNT"></a><br /><hr />
4147  <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>
4148  <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;
4149    Current number of active disk streams</h3>
4150    
4151  <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
4152                      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 4160  Intellectual Property and Copyright Stat
4160                                            
4161  </p>  </p>
4162  <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
4163                      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>
4164                      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.
4165  </p>  </p>
4166  <p>Possible Answers:  <p>Possible Answers:
4167  </p>  </p>
# Line 3983  Intellectual Property and Copyright Stat Line 4187  Intellectual Property and Copyright Stat
4187                                            
4188  </p>  </p>
4189  <a name="GET CHANNEL BUFFER_FILL"></a><br /><hr />  <a name="GET CHANNEL BUFFER_FILL"></a><br /><hr />
4190  <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>
4191  <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;
4192    Current fill state of disk stream buffers</h3>
4193    
4194  <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
4195                      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 4214  Intellectual Property and Copyright Stat
4214  </p>  </p>
4215  <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
4216                      sampler channel number the front-end is interested in                      sampler channel number the front-end is interested in
4217                      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>
4218                      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.
4219  </p>  </p>
4220  <p>Possible Answers:  <p>Possible Answers:
4221  </p>  </p>
# Line 4060  Intellectual Property and Copyright Stat Line 4265  Intellectual Property and Copyright Stat
4265                                            
4266  </p>  </p>
4267  <a name="SET CHANNEL AUDIO_OUTPUT_DEVICE"></a><br /><hr />  <a name="SET CHANNEL AUDIO_OUTPUT_DEVICE"></a><br /><hr />
4268  <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>
4269  <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;
4270    Setting audio output device</h3>
4271    
4272  <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
4273                      channel by sending the following command:                      channel by sending the following command:
# Line 4075  Intellectual Property and Copyright Stat Line 4281  Intellectual Property and Copyright Stat
4281                                            
4282  </p>  </p>
4283  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4284                      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>
4285                      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
4286                      &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
4287                      <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>
4288                      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>
4289                      command.                      command.
4290  </p>  </p>
4291  <p>Possible Answers:  <p>Possible Answers:
# Line 4126  Intellectual Property and Copyright Stat Line 4332  Intellectual Property and Copyright Stat
4332  </blockquote><p>  </blockquote><p>
4333                                            
4334  </p>  </p>
4335  <a name="SET CHANNEL AUDIO_OUTPUT_TYP"></a><br /><hr />  <a name="SET CHANNEL AUDIO_OUTPUT_TYPE"></a><br /><hr />
4336  <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>
4337  <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;
4338    Setting audio output type</h3>
4339    
4340  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
4341  </p>  </p>
# Line 4191  Intellectual Property and Copyright Stat Line 4398  Intellectual Property and Copyright Stat
4398                                            
4399  </p>  </p>
4400  <a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr />  <a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
4401  <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>
4402  <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;
4403    Setting audio output channel</h3>
4404    
4405  <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
4406                      sampler channel by sending the following command:                      sampler channel by sending the following command:
# Line 4206  Intellectual Property and Copyright Stat Line 4414  Intellectual Property and Copyright Stat
4414                                            
4415  </p>  </p>
4416  <p>Where &lt;sampler-chan&gt; is the sampler channel number  <p>Where &lt;sampler-chan&gt; is the sampler channel number
4417                      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>
4418                      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
4419                      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
4420                      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
4421                      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 4465  Intellectual Property and Copyright Stat
4465                                            
4466  </p>  </p>
4467  <a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr />
4468  <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>
4469  <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;
4470    Setting MIDI input device</h3>
4471    
4472  <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
4473                      channel by sending the following command:                      channel by sending the following command:
# Line 4272  Intellectual Property and Copyright Stat Line 4481  Intellectual Property and Copyright Stat
4481                                            
4482  </p>  </p>
4483  <p>Where &lt;sampler-channel&gt; is the sampler channel number  <p>Where &lt;sampler-channel&gt; is the sampler channel number
4484                      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>
4485                      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
4486                      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
4487                      <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>
4488                      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.
4489  </p>  </p>
4490  <p>Possible Answers:  <p>Possible Answers:
4491  </p>  </p>
# Line 4323  Intellectual Property and Copyright Stat Line 4532  Intellectual Property and Copyright Stat
4532                                            
4533  </p>  </p>
4534  <a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr />
4535  <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>
4536  <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;
4537    Setting MIDI input type</h3>
4538    
4539  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
4540  </p>  </p>
# Line 4387  Intellectual Property and Copyright Stat Line 4597  Intellectual Property and Copyright Stat
4597                                            
4598  </p>  </p>
4599  <a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr />
4600  <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>
4601  <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;
4602    Setting MIDI input port</h3>
4603    
4604  <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
4605                      channel by sending the following command:                      channel by sending the following command:
# Line 4450  Intellectual Property and Copyright Stat Line 4661  Intellectual Property and Copyright Stat
4661                                            
4662  </p>  </p>
4663  <a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr />
4664  <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>
4665  <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;
4666    Setting MIDI input channel</h3>
4667    
4668  <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
4669                      listen to by sending the following command:                      listen to by sending the following command:
# Line 4513  Intellectual Property and Copyright Stat Line 4725  Intellectual Property and Copyright Stat
4725                                            
4726  </p>  </p>
4727  <a name="SET CHANNEL VOLUME"></a><br /><hr />  <a name="SET CHANNEL VOLUME"></a><br /><hr />
4728  <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>
4729  <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;
4730    Setting channel volume</h3>
4731    
4732  <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
4733                      the following command:                      the following command:
# Line 4577  Intellectual Property and Copyright Stat Line 4790  Intellectual Property and Copyright Stat
4790                                            
4791  </p>  </p>
4792  <a name="SET CHANNEL MUTE"></a><br /><hr />  <a name="SET CHANNEL MUTE"></a><br /><hr />
4793  <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>
4794  <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;
4795    Muting a sampler channel</h3>
4796    
4797  <p>The front-end can mute/unmute a specific sampler  <p>The front-end can mute/unmute a specific sampler
4798                      channel by sending the following command:                      channel by sending the following command:
# Line 4592  Intellectual Property and Copyright Stat Line 4806  Intellectual Property and Copyright Stat
4806                                            
4807  </p>  </p>
4808  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4809                      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>
4810                      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
4811                      &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"
4812                      to unmute the channel.                      to unmute the channel.
4813  </p>  </p>
# Line 4642  Intellectual Property and Copyright Stat Line 4856  Intellectual Property and Copyright Stat
4856                                            
4857  </p>  </p>
4858  <a name="SET CHANNEL SOLO"></a><br /><hr />  <a name="SET CHANNEL SOLO"></a><br /><hr />
4859  <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>
4860  <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;
4861    Soloing a sampler channel</h3>
4862    
4863  <p>The front-end can solo/unsolo a specific sampler channel  <p>The front-end can solo/unsolo a specific sampler channel
4864                      by sending the following command:                      by sending the following command:
# Line 4657  Intellectual Property and Copyright Stat Line 4872  Intellectual Property and Copyright Stat
4872                                            
4873  </p>  </p>
4874  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4875                      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>
4876                      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
4877                      &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"
4878                      to unsolo the channel.                      to unsolo the channel.
4879  </p>  </p>
# Line 4706  Intellectual Property and Copyright Stat Line 4921  Intellectual Property and Copyright Stat
4921  </blockquote><p>  </blockquote><p>
4922                                            
4923  </p>  </p>
4924    <a name="SET CHANNEL MIDI_INSTRUMENT_MAP"></a><br /><hr />
4925    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4926    <a name="rfc.section.6.4.24"></a><h3>6.4.24.&nbsp;
4927    Assigning a MIDI instrument map to a sampler channel</h3>
4928    
4929    <p>The front-end can assign a MIDI instrument map to a specific sampler channel
4930                        by sending the following command:
4931    </p>
4932    <p>
4933                            </p>
4934    <blockquote class="text">
4935    <p>SET CHANNEL MIDI_INSTRUMENT_MAP &lt;sampler-channel&gt; &lt;map&gt;
4936    </p>
4937    </blockquote><p>
4938                        
4939    </p>
4940    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4941                        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>
4942                        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
4943                        &lt;map&gt; can have the following possibilites:
4944    </p>
4945    <p>
4946                            </p>
4947    <blockquote class="text">
4948    <p>"NONE" -
4949                                    </p>
4950    <blockquote class="text">
4951    <p>This is the default setting. In this case
4952                                        the sampler channel is not assigned any MIDI
4953                                        instrument map and thus will ignore all MIDI
4954                                        program change messages.
4955    </p>
4956    </blockquote>
4957                                
4958    
4959    <p>"DEFAULT" -
4960                                    </p>
4961    <blockquote class="text">
4962    <p>The sampler channel will always use the
4963                                        default MIDI instrument map to handle MIDI
4964                                        program change messages.
4965    </p>
4966    </blockquote>
4967                                
4968    
4969    <p>numeric ID -
4970                                    </p>
4971    <blockquote class="text">
4972    <p>You can assign a specific MIDI instrument map
4973                                        by replacing &lt;map&gt; with the respective numeric
4974                                        ID of the MIDI instrument map as returned by the
4975                                        <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>
4976                                        command. Once that map will be deleted, the sampler
4977                                        channel would fall back to "NONE".
4978    </p>
4979    </blockquote>
4980                                
4981    
4982    </blockquote><p>
4983                        
4984    </p>
4985    <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>
4986                        for details regarding MIDI instrument mapping.
4987    </p>
4988    <p>Possible Answers:
4989    </p>
4990    <p>
4991                            </p>
4992    <blockquote class="text">
4993    <p>"OK" -
4994                                    </p>
4995    <blockquote class="text">
4996    <p>on success
4997    </p>
4998    </blockquote>
4999                                
5000    
5001    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5002                                    </p>
5003    <blockquote class="text">
5004    <p>in case it failed, providing an appropriate error code and error message
5005    </p>
5006    </blockquote>
5007                                
5008    
5009    </blockquote><p>
5010                        
5011    </p>
5012    <p>Examples:
5013    </p>
5014    <p>
5015                            </p>
5016    <blockquote class="text">
5017    <p>
5018    </p>
5019    </blockquote><p>
5020                        
5021    </p>
5022    <a name="CREATE FX_SEND"></a><br /><hr />
5023    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5024    <a name="rfc.section.6.4.25"></a><h3>6.4.25.&nbsp;
5025    Adding an effect send to a sampler channel</h3>
5026    
5027    <p>The front-end can create an additional effect send on a specific sampler channel
5028                        by sending the following command:
5029    </p>
5030    <p>
5031                            </p>
5032    <blockquote class="text">
5033    <p>CREATE FX_SEND &lt;sampler-channel&gt; &lt;midi-ctrl&gt; [&lt;name&gt;]
5034    </p>
5035    </blockquote><p>
5036                        
5037    </p>
5038    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5039                        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>
5040                        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
5041                        sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
5042                        is a number between 0..127 defining the MIDI controller which can alter the
5043                        effect send level and &lt;name&gt; is an optional argument defining a name
5044                        for the effect send entity. The name does not have to be unique.
5045    </p>
5046    <p>By default, that is as initial routing, the effect send's audio channels
5047                        are automatically routed to the last audio channels of the sampler channel's
5048                        audio output device, that way you can i.e. first increase the amount of audio
5049                        channels on the audio output device for having dedicated effect send output
5050                        channels and when "CREATE FX_SEND" is called, those channels will automatically
5051                        be picked. You can alter the destination channels however with
5052                        <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>.
5053                        
5054    </p>
5055    <p>Note: Create effect sends on a sampler channel only when needed, because having effect
5056                        sends on a sampler channel will decrease runtime performance, because for implementing channel
5057                        effect sends, separate (sampler channel local) audio buffers are needed to render and mix
5058                        the voices and route the audio signal afterwards to the master outputs and effect send
5059                        outputs (along with their respective effect send levels). A sampler channel without effect
5060                        sends however can mix its voices directly into the audio output devices's audio buffers
5061                        and is thus faster.
5062                        
5063    </p>
5064    <p>Possible Answers:
5065    </p>
5066    <p>
5067                            </p>
5068    <blockquote class="text">
5069    <p>"OK[&lt;fx-send-id&gt;]" -
5070                                    </p>
5071    <blockquote class="text">
5072    <p>in case a new effect send could be added to the
5073                                        sampler channel, where &lt;fx-send-id&gt; reflects the
5074                                        unique ID of the newly created effect send entity
5075    </p>
5076    </blockquote>
5077                                
5078    
5079    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5080                                    </p>
5081    <blockquote class="text">
5082    <p>when a new effect send could not be added, i.e.
5083                                        due to invalid parameters
5084    </p>
5085    </blockquote>
5086                                
5087    
5088    </blockquote><p>
5089                        
5090    </p>
5091    <p>Examples:
5092    </p>
5093    <p>
5094                            </p>
5095    <blockquote class="text">
5096    <p>C: "CREATE FX_SEND 0 91 'Reverb Send'"
5097    </p>
5098    <p>S: "OK[0]"
5099    </p>
5100    </blockquote><p>
5101                        
5102    </p>
5103    <p>
5104                            </p>
5105    <blockquote class="text">
5106    <p>C: "CREATE FX_SEND 0 93"
5107    </p>
5108    <p>S: "OK[1]"
5109    </p>
5110    </blockquote><p>
5111                        
5112    </p>
5113    <a name="DESTROY FX_SEND"></a><br /><hr />
5114    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5115    <a name="rfc.section.6.4.26"></a><h3>6.4.26.&nbsp;
5116    Removing an effect send from a sampler channel</h3>
5117    
5118    <p>The front-end can remove an existing effect send on a specific sampler channel
5119                        by sending the following command:
5120    </p>
5121    <p>
5122                            </p>
5123    <blockquote class="text">
5124    <p>DESTROY FX_SEND &lt;sampler-channel&gt; &lt;fx-send-id&gt;
5125    </p>
5126    </blockquote><p>
5127                        
5128    </p>
5129    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5130                        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>
5131                        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
5132                        sampler channel from which the effect send should be removed from and
5133                        &lt;fx-send-id&gt; is the respective effect send number as returned by the
5134                        <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>
5135                        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.
5136    </p>
5137    <p>Possible Answers:
5138    </p>
5139    <p>
5140                            </p>
5141    <blockquote class="text">
5142    <p>"OK" -
5143                                    </p>
5144    <blockquote class="text">
5145    <p>on success
5146    </p>
5147    </blockquote>
5148                                
5149    
5150    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5151                                    </p>
5152    <blockquote class="text">
5153    <p>in case it failed, providing an appropriate error code and
5154                                        error message
5155    </p>
5156    </blockquote>
5157                                
5158    
5159    </blockquote><p>
5160                        
5161    </p>
5162    <p>Example:
5163    </p>
5164    <p>
5165                            </p>
5166    <blockquote class="text">
5167    <p>C: "DESTROY FX_SEND 0 0"
5168    </p>
5169    <p>S: "OK"
5170    </p>
5171    </blockquote><p>
5172                        
5173    </p>
5174    <a name="GET FX_SENDS"></a><br /><hr />
5175    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5176    <a name="rfc.section.6.4.27"></a><h3>6.4.27.&nbsp;
5177    Getting amount of effect sends on a sampler channel</h3>
5178    
5179    <p>The front-end can ask for the amount of effect sends on a specific sampler channel
5180                        by sending the following command:
5181    </p>
5182    <p>
5183                            </p>
5184    <blockquote class="text">
5185    <p>GET FX_SENDS &lt;sampler-channel&gt;
5186    </p>
5187    </blockquote><p>
5188                        
5189    </p>
5190    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5191                        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>
5192                        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.
5193    </p>
5194    <p>Possible Answers:
5195    </p>
5196    <p>
5197                            </p>
5198    <blockquote class="text">
5199    <p>The sampler will answer by returning the number of effect
5200                                sends on the given sampler channel.
5201    </p>
5202    </blockquote><p>
5203                        
5204    </p>
5205    <p>Example:
5206    </p>
5207    <p>
5208                            </p>
5209    <blockquote class="text">
5210    <p>C: "GET FX_SENDS 0"
5211    </p>
5212    <p>S: "2"
5213    </p>
5214    </blockquote><p>
5215                        
5216    </p>
5217    <a name="LIST FX_SENDS"></a><br /><hr />
5218    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5219    <a name="rfc.section.6.4.28"></a><h3>6.4.28.&nbsp;
5220    Listing all effect sends on a sampler channel</h3>
5221    
5222    <p>The front-end can ask for a list of effect sends on a specific sampler channel
5223                        by sending the following command:
5224    </p>
5225    <p>
5226                            </p>
5227    <blockquote class="text">
5228    <p>LIST FX_SENDS &lt;sampler-channel&gt;
5229    </p>
5230    </blockquote><p>
5231                        
5232    </p>
5233    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5234                        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>
5235                        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.
5236    </p>
5237    <p>Possible Answers:
5238    </p>
5239    <p>
5240                            </p>
5241    <blockquote class="text">
5242    <p>The sampler will answer by returning a comma separated list
5243                                with all effect sends' numerical IDs on the given sampler
5244                                channel.
5245    </p>
5246    </blockquote><p>
5247                        
5248    </p>
5249    <p>Examples:
5250    </p>
5251    <p>
5252                            </p>
5253    <blockquote class="text">
5254    <p>C: "LIST FX_SENDS 0"
5255    </p>
5256    <p>S: "0,1"
5257    </p>
5258    </blockquote><p>
5259                        
5260    </p>
5261    <p>
5262                            </p>
5263    <blockquote class="text">
5264    <p>C: "LIST FX_SENDS 1"
5265    </p>
5266    <p>S: ""
5267    </p>
5268    </blockquote><p>
5269                        
5270    </p>
5271    <a name="GET FX_SEND INFO"></a><br /><hr />
5272    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5273    <a name="rfc.section.6.4.29"></a><h3>6.4.29.&nbsp;
5274    Getting effect send information</h3>
5275    
5276    <p>The front-end can ask for the current settings of an effect send entity
5277                        by sending the following command:
5278    </p>
5279    <p>
5280                            </p>
5281    <blockquote class="text">
5282    <p>GET FX_SEND INFO &lt;sampler-channel&gt; &lt;fx-send-id&gt;
5283    </p>
5284    </blockquote><p>
5285                        
5286    </p>
5287    <p>Where &lt;sampler-channel&gt; is the sampler channel number
5288                        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>
5289                        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
5290                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5291                        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>
5292                        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.
5293                      
5294    </p>
5295    <p>Possible Answers:
5296    </p>
5297    <p>
5298                            </p>
5299    <blockquote class="text">
5300    <p>The sampler will answer by sending a &lt;CRLF&gt; separated list.
5301                                Each answer line begins with the settings category name
5302                                followed by a colon and then a space character &lt;SP&gt; and finally
5303                                the info character string to that setting category. At the
5304                                moment the following categories are defined:
5305    </p>
5306    <p>
5307                                    </p>
5308    <blockquote class="text">
5309    <p>NAME -
5310                                            </p>
5311    <blockquote class="text">
5312    <p>name of the effect send entity
5313    </p>
5314    </blockquote>
5315                                        
5316    
5317    <p>MIDI_CONTROLLER -
5318                                            </p>
5319    <blockquote class="text">
5320    <p>a value between 0 and 127 reflecting the MIDI controller
5321                                                which is able to modify the effect send's send level
5322    </p>
5323    </blockquote>
5324                                        
5325    
5326    <p>LEVEL -
5327                                            </p>
5328    <blockquote class="text">
5329    <p>optionally dotted number reflecting the effect send's
5330                                                current send level (where a value &lt; 1.0 means attenuation
5331                                                and a value > 1.0 means amplification)
5332    </p>
5333    </blockquote>
5334                                        
5335    
5336    <p>AUDIO_OUTPUT_ROUTING -
5337                                            </p>
5338    <blockquote class="text">
5339    <p>comma separated list which reflects to which audio
5340                                                channel of the selected audio output device each
5341                                                effect send output channel is routed to, e.g. "0,3" would
5342                                                mean the effect send's output channel 0 is routed to channel
5343                                                0 of the audio output device and the effect send's output
5344                                                channel 1 is routed to the channel 3 of the audio
5345                                                output device (see
5346                                                <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>
5347                                                for details)
5348    </p>
5349    </blockquote>
5350                                        
5351    
5352    </blockquote>
5353                                
5354    
5355    </blockquote><p>
5356                        
5357    </p>
5358    <p>The mentioned fields above don't have to be in particular order.
5359    </p>
5360    <p>Example:
5361    </p>
5362    <p>
5363                            </p>
5364    <blockquote class="text">
5365    <p>C: "GET FX_SEND INFO 0 0"
5366    </p>
5367    <p>S: "NAME: Reverb Send"
5368    </p>
5369    <p>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"
5370    </p>
5371    <p>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"
5372    </p>
5373    <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"
5374    </p>
5375    <p>&nbsp;&nbsp;&nbsp;"."
5376    </p>
5377    </blockquote><p>
5378                        
5379    </p>
5380    <a name="SET FX_SEND NAME"></a><br /><hr />
5381    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5382    <a name="rfc.section.6.4.30"></a><h3>6.4.30.&nbsp;
5383    Changing effect send's name</h3>
5384    
5385    <p>The front-end can alter the current name of an effect
5386                        send entity by sending the following command:
5387    </p>
5388    <p>
5389                            </p>
5390    <blockquote class="text">
5391    <p>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;
5392    </p>
5393    </blockquote><p>
5394                        
5395    </p>
5396    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5397                        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>
5398                        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,
5399                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5400                        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>
5401                        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
5402                        &lt;name&gt; is the new name of the effect send entity, which
5403                        does not have to be unique.
5404    </p>
5405    <p>Possible Answers:
5406    </p>
5407    <p>
5408                            </p>
5409    <blockquote class="text">
5410    <p>"OK" -
5411                                    </p>
5412    <blockquote class="text">
5413    <p>on success
5414    </p>
5415    </blockquote>
5416                                
5417    
5418    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5419                                    </p>
5420    <blockquote class="text">
5421    <p>in case it failed, providing an appropriate error code and error message
5422    </p>
5423    </blockquote>
5424                                
5425    
5426    </blockquote><p>
5427                        
5428    </p>
5429    <p>Example:
5430    </p>
5431    <p>
5432                            </p>
5433    <blockquote class="text">
5434    <p>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
5435    </p>
5436    <p>S: "OK"
5437    </p>
5438    </blockquote><p>
5439                        
5440    </p>
5441    <a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
5442    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5443    <a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;
5444    Altering effect send's audio routing</h3>
5445    
5446    <p>The front-end can alter the destination of an effect send's audio channel on a specific
5447                        sampler channel by sending the following command:
5448    </p>
5449    <p>
5450                            </p>
5451    <blockquote class="text">
5452    <p>SET FX_SEND AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;audio-src&gt; &lt;audio-dst&gt;
5453    </p>
5454    </blockquote><p>
5455                        
5456    </p>
5457    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5458                        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>
5459                        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,
5460                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5461                        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>
5462                        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,
5463                        &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
5464                        which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
5465                        the audio channel of the selected audio output device where &lt;audio-src&gt;
5466                        should be routed to.
5467    </p>
5468    <p>Note that effect sends can only route audio to the same audio output
5469                        device as assigned to the effect send's sampler channel. Also note that an
5470                        effect send entity does always have exactly as much audio channels as its
5471                        sampler channel. So if the sampler channel is stereo, the effect send does
5472                        have two audio channels as well. Also keep in mind that the amount of audio
5473                        channels on a sampler channel might be dependant not only to the deployed
5474                        sampler engine on the sampler channel, but also dependant to the instrument
5475                        currently loaded. However you can (effectively) turn an i.e. stereo effect
5476                        send into a mono one by simply altering its audio routing appropriately.
5477    </p>
5478    <p>Possible Answers:
5479    </p>
5480    <p>
5481                            </p>
5482    <blockquote class="text">
5483    <p>"OK" -
5484                                    </p>
5485    <blockquote class="text">
5486    <p>on success
5487    </p>
5488    </blockquote>
5489                                
5490    
5491    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5492                                    </p>
5493    <blockquote class="text">
5494    <p>if audio output channel was set, but there are noteworthy
5495                                        issue(s) related, providing an appropriate warning code and
5496                                        warning message
5497    </p>
5498    </blockquote>
5499                                
5500    
5501    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5502                                    </p>
5503    <blockquote class="text">
5504    <p>in case it failed, providing an appropriate error code and error message
5505    </p>
5506    </blockquote>
5507                                
5508    
5509    </blockquote><p>
5510                        
5511    </p>
5512    <p>Example:
5513    </p>
5514    <p>
5515                            </p>
5516    <blockquote class="text">
5517    <p>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
5518    </p>
5519    <p>S: "OK"
5520    </p>
5521    </blockquote><p>
5522                        
5523    </p>
5524    <a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />
5525    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5526    <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;
5527    Altering effect send's MIDI controller</h3>
5528    
5529    <p>The front-end can alter the MIDI controller of an effect
5530                        send entity by sending the following command:
5531    </p>
5532    <p>
5533                            </p>
5534    <blockquote class="text">
5535    <p>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;
5536    </p>
5537    </blockquote><p>
5538                        
5539    </p>
5540    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5541                        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>
5542                        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,
5543                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5544                        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>
5545                        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
5546                        &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
5547                        able to modify the effect send's send level.
5548    </p>
5549    <p>Possible Answers:
5550    </p>
5551    <p>
5552                            </p>
5553    <blockquote class="text">
5554    <p>"OK" -
5555                                    </p>
5556    <blockquote class="text">
5557    <p>on success
5558    </p>
5559    </blockquote>
5560                                
5561    
5562    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5563                                    </p>
5564    <blockquote class="text">
5565    <p>if MIDI controller was set, but there are noteworthy
5566                                        issue(s) related, providing an appropriate warning code and
5567                                        warning message
5568    </p>
5569    </blockquote>
5570                                
5571    
5572    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5573                                    </p>
5574    <blockquote class="text">
5575    <p>in case it failed, providing an appropriate error code and error message
5576    </p>
5577    </blockquote>
5578                                
5579    
5580    </blockquote><p>
5581                        
5582    </p>
5583    <p>Example:
5584    </p>
5585    <p>
5586                            </p>
5587    <blockquote class="text">
5588    <p>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
5589    </p>
5590    <p>S: "OK"
5591    </p>
5592    </blockquote><p>
5593                        
5594    </p>
5595    <a name="SET FX_SEND LEVEL"></a><br /><hr />
5596    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5597    <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;
5598    Altering effect send's send level</h3>
5599    
5600    <p>The front-end can alter the current send level of an effect
5601                        send entity by sending the following command:
5602    </p>
5603    <p>
5604                            </p>
5605    <blockquote class="text">
5606    <p>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;
5607    </p>
5608    </blockquote><p>
5609                        
5610    </p>
5611    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5612                        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>
5613                        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,
5614                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5615                        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>
5616                        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
5617                        &lt;volume&gt; is an optionally dotted positive number (a value
5618                        smaller than 1.0 means attenuation, whereas a value greater than
5619                        1.0 means amplification) reflecting the new send level.
5620    </p>
5621    <p>Possible Answers:
5622    </p>
5623    <p>
5624                            </p>
5625    <blockquote class="text">
5626    <p>"OK" -
5627                                    </p>
5628    <blockquote class="text">
5629    <p>on success
5630    </p>
5631    </blockquote>
5632                                
5633    
5634    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5635                                    </p>
5636    <blockquote class="text">
5637    <p>if new send level was set, but there are noteworthy
5638                                        issue(s) related, providing an appropriate warning code and
5639                                        warning message
5640    </p>
5641    </blockquote>
5642                                
5643    
5644    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5645                                    </p>
5646    <blockquote class="text">
5647    <p>in case it failed, providing an appropriate error code and error message
5648    </p>
5649    </blockquote>
5650                                
5651    
5652    </blockquote><p>
5653                        
5654    </p>
5655    <p>Example:
5656    </p>
5657    <p>
5658                            </p>
5659    <blockquote class="text">
5660    <p>C: "SET FX_SEND LEVEL 0 0 0.15"
5661    </p>
5662    <p>S: "OK"
5663    </p>
5664    </blockquote><p>
5665                        
5666    </p>
5667  <a name="RESET CHANNEL"></a><br /><hr />  <a name="RESET CHANNEL"></a><br /><hr />
5668  <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>
5669  <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;
5670    Resetting a sampler channel</h3>
5671    
5672  <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:
5673  </p>  </p>
# Line 4772  Intellectual Property and Copyright Stat Line 5731  Intellectual Property and Copyright Stat
5731                                            
5732  </p>  </p>
5733  <a name="anchor12"></a><br /><hr />  <a name="anchor12"></a><br /><hr />
5734  <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>
5735  <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;
5736    Controlling connection</h3>
5737    
5738  <p>The following commands are used to control the connection to LinuxSampler.  <p>The following commands are used to control the connection to LinuxSampler.
5739  </p>  </p>
5740  <a name="SUBSCRIBE"></a><br /><hr />  <a name="SUBSCRIBE"></a><br /><hr />
5741  <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>
5742  <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;
5743    Register front-end for receiving event messages</h3>
5744    
5745  <p>The front-end can register itself to the LinuxSampler application to  <p>The front-end can register itself to the LinuxSampler application to
5746                      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 5802  Intellectual Property and Copyright Stat
5802                                            
5803  </p>  </p>
5804  <a name="UNSUBSCRIBE"></a><br /><hr />  <a name="UNSUBSCRIBE"></a><br /><hr />
5805  <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>
5806  <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;
5807    Unregister front-end for not receiving event messages</h3>
5808    
5809  <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
5810                      messages anymore by sending the following command:                      messages anymore by sending the following command:
# Line 4904  Intellectual Property and Copyright Stat Line 5866  Intellectual Property and Copyright Stat
5866                                            
5867  </p>  </p>
5868  <a name="SET ECHO"></a><br /><hr />  <a name="SET ECHO"></a><br /><hr />
5869  <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>
5870  <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;
5871    Enable or disable echo of commands</h3>
5872    
5873  <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:
5874  </p>  </p>
# Line 4960  Intellectual Property and Copyright Stat Line 5923  Intellectual Property and Copyright Stat
5923                                            
5924  </p>  </p>
5925  <a name="QUIT"></a><br /><hr />  <a name="QUIT"></a><br /><hr />
5926  <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>
5927  <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;
5928    Close client connection</h3>
5929    
5930  <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:
5931  </p>  </p>
# Line 4977  Intellectual Property and Copyright Stat Line 5941  Intellectual Property and Copyright Stat
5941                      LinuxSampler than really useful for a front-end implementation.                      LinuxSampler than really useful for a front-end implementation.
5942  </p>  </p>
5943  <a name="anchor13"></a><br /><hr />  <a name="anchor13"></a><br /><hr />
5944  <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>
5945  <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;
5946    Global commands</h3>
5947    
5948  <p>The following commands have global impact on the sampler.  <p>The following commands have global impact on the sampler.
5949  </p>  </p>
5950  <a name="GET TOTAL_VOICE_COUNT"></a><br /><hr />  <a name="GET TOTAL_VOICE_COUNT"></a><br /><hr />
5951  <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>
5952  <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;
5953    Current number of active voices</h3>
5954    
5955  <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
5956                      the sampler by sending the following command:                      the sampler by sending the following command:
# Line 5009  Intellectual Property and Copyright Stat Line 5975  Intellectual Property and Copyright Stat
5975                                            
5976  </p>  </p>
5977  <a name="GET TOTAL_VOICE_COUNT_MAX"></a><br /><hr />  <a name="GET TOTAL_VOICE_COUNT_MAX"></a><br /><hr />
5978  <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>
5979  <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;
5980    Maximum amount of active voices</h3>
5981    
5982  <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
5983                      by sending the following command:                      by sending the following command:
# Line 5035  Intellectual Property and Copyright Stat Line 6002  Intellectual Property and Copyright Stat
6002                                            
6003  </p>  </p>
6004  <a name="RESET"></a><br /><hr />  <a name="RESET"></a><br /><hr />
6005  <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>
6006  <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;
6007    Reset sampler</h3>
6008    
6009  <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:
6010  </p>  </p>
# Line 5075  Intellectual Property and Copyright Stat Line 6043  Intellectual Property and Copyright Stat
6043                                            
6044  </p>  </p>
6045  <a name="GET SERVER INFO"></a><br /><hr />  <a name="GET SERVER INFO"></a><br /><hr />
6046  <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>
6047  <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;
6048    General sampler informations</h3>
6049    
6050  <p>The client can ask for general informations about the LinuxSampler  <p>The client can ask for general informations about the LinuxSampler
6051                         instance by sending the following command:                         instance by sending the following command:
# Line 5124  Intellectual Property and Copyright Stat Line 6093  Intellectual Property and Copyright Stat
6093                                          </p>                                          </p>
6094  <blockquote class="text">  <blockquote class="text">
6095  <p>version of the LSCP specification the sampler  <p>version of the LSCP specification the sampler
6096                                              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)
6097    </p>
6098    </blockquote>
6099                                        
6100    
6101    <p>INSTRUMENTS_DB_SUPPORT -
6102                                            </p>
6103    <blockquote class="text">
6104    <p>either yes or no, specifies whether the
6105                                                sampler is build with instruments database support.
6106  </p>  </p>
6107  </blockquote>  </blockquote>
6108                                                                            
# Line 5138  Intellectual Property and Copyright Stat Line 6116  Intellectual Property and Copyright Stat
6116  <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.
6117                      Other fields might be added in future.                      Other fields might be added in future.
6118  </p>  </p>
6119    <a name="GET VOLUME"></a><br /><hr />
6120    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6121    <a name="rfc.section.6.6.5"></a><h3>6.6.5.&nbsp;
6122    Getting global volume attenuation</h3>
6123    
6124    <p>The client can ask for the current global sampler-wide volume
6125                        attenuation by sending the following command:
6126    </p>
6127    <p>
6128                            </p>
6129    <blockquote class="text">
6130    <p>GET VOLUME
6131    </p>
6132    </blockquote><p>
6133                        
6134    </p>
6135    <p>Possible Answers:
6136    </p>
6137    <p>
6138                            </p>
6139    <blockquote class="text">
6140    <p>The sampler will always answer by returning the optional
6141                                dotted floating point coefficient, reflecting the current
6142                                global volume attenuation.
6143                                
6144    </p>
6145    </blockquote><p>
6146                        
6147    </p>
6148    <p>Note: it is up to the respective sampler engine whether to obey
6149                        that global volume parameter or not, but in general all engines SHOULD
6150                        use this parameter.
6151    </p>
6152    <a name="SET VOLUME"></a><br /><hr />
6153    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6154    <a name="rfc.section.6.6.6"></a><h3>6.6.6.&nbsp;
6155    Setting global volume attenuation</h3>
6156    
6157    <p>The client can alter the current global sampler-wide volume
6158                        attenuation by sending the following command:
6159    </p>
6160    <p>
6161                            </p>
6162    <blockquote class="text">
6163    <p>SET VOLUME &lt;volume&gt;
6164    </p>
6165    </blockquote><p>
6166                        
6167    </p>
6168    <p>Where &lt;volume&gt; should be replaced by the optional dotted
6169                       floating point value, reflecting the new global volume parameter.
6170                       This value might usually be in the range between 0.0 and 1.0, that
6171                       is for attenuating the overall volume.
6172    </p>
6173    <p>Possible Answers:
6174    </p>
6175    <p>
6176                            </p>
6177    <blockquote class="text">
6178    <p>"OK" -
6179                                    </p>
6180    <blockquote class="text">
6181    <p>on success
6182    </p>
6183    </blockquote>
6184                                
6185    
6186    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6187                                    </p>
6188    <blockquote class="text">
6189    <p>if the global volume was set, but there are noteworthy
6190                                        issue(s) related, providing an appropriate warning code and
6191                                        warning message
6192    </p>
6193    </blockquote>
6194                                
6195    
6196    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6197                                    </p>
6198    <blockquote class="text">
6199    <p>in case it failed, providing an appropriate error code and error message
6200    </p>
6201    </blockquote>
6202                                
6203    
6204    </blockquote><p>
6205                        
6206    </p>
6207    <a name="MIDI Instrument Mapping"></a><br /><hr />
6208    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6209    <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;
6210    MIDI Instrument Mapping</h3>
6211    
6212    <p>The MIDI protocol provides a way to switch between instruments
6213                    by sending so called MIDI bank select and MIDI program change
6214                    messages which are essentially just numbers. The following commands
6215                    allow to actually map arbitrary MIDI bank select / program change
6216                    numbers with real instruments.
6217    </p>
6218    <p>The sampler allows to manage an arbitrary amount of MIDI
6219                    instrument maps which define which instrument to load on
6220                    which MIDI program change message.
6221    </p>
6222    <p>By default, that is when the sampler is launched, there is no
6223                    map, thus the sampler will simply ignore all program change
6224                    messages. The front-end has to explicitly create at least one
6225                    map, add entries to the map and tell the respective sampler
6226                    channel(s) which MIDI instrument map to use, so the sampler
6227                    knows how to react on a given program change message on the
6228                    respective sampler channel, that is by switching to the
6229                    respectively defined engine type and loading the respective
6230                    instrument. See command
6231                    <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>
6232                    for how to assign a MIDI instrument map to a sampler channel.
6233    </p>
6234    <p>Also note per MIDI specification a bank select message does not
6235                    cause to switch to another instrument. Instead when receiving a
6236                    bank select message the bank value will be stored and a subsequent
6237                    program change message (which may occur at any time) will finally
6238                    cause the sampler to switch to the respective instrument as
6239                    reflected by the current MIDI instrument map.
6240    </p>
6241    <a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr />
6242    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6243    <a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;
6244    Create a new MIDI instrument map</h3>
6245    
6246    <p>The front-end can add a new MIDI instrument map by sending
6247                        the following command:
6248    </p>
6249    <p>
6250                            </p>
6251    <blockquote class="text">
6252    <p>ADD MIDI_INSTRUMENT_MAP [&lt;name&gt;]
6253    </p>
6254    </blockquote><p>
6255                        
6256    </p>
6257    <p>Where &lt;name&gt; is an optional argument allowing to
6258                        assign a custom name to the new map. MIDI instrument Map
6259                        names do not have to be unique.
6260    </p>
6261    <p>Possible Answers:
6262    </p>
6263    <p>
6264                            </p>
6265    <blockquote class="text">
6266    <p>"OK[&lt;map&gt;]" -
6267                                    </p>
6268    <blockquote class="text">
6269    <p>in case a new MIDI instrument map could
6270                                        be added, where &lt;map&gt; reflects the
6271                                        unique ID of the newly created MIDI
6272                                        instrument map
6273    </p>
6274    </blockquote>
6275                                
6276    
6277    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6278                                    </p>
6279    <blockquote class="text">
6280    <p>when a new map could not be created, which
6281                                        might never occur in practice
6282    </p>
6283    </blockquote>
6284                                
6285    
6286    </blockquote><p>
6287                        
6288    </p>
6289    <p>Examples:
6290    </p>
6291    <p>
6292                            </p>
6293    <blockquote class="text">
6294    <p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
6295    </p>
6296    <p>S: "OK[0]"
6297    </p>
6298    </blockquote><p>
6299                        
6300    </p>
6301    <p>
6302                            </p>
6303    <blockquote class="text">
6304    <p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
6305    </p>
6306    <p>S: "OK[1]"
6307    </p>
6308    </blockquote><p>
6309                        
6310    </p>
6311    <p>
6312                            </p>
6313    <blockquote class="text">
6314    <p>C: "ADD MIDI_INSTRUMENT_MAP"
6315    </p>
6316    <p>S: "OK[5]"
6317    </p>
6318    </blockquote><p>
6319                        
6320    </p>
6321    <a name="REMOVE MIDI_INSTRUMENT_MAP"></a><br /><hr />
6322    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6323    <a name="rfc.section.6.7.2"></a><h3>6.7.2.&nbsp;
6324    Delete one particular or all MIDI instrument maps</h3>
6325    
6326    <p>The front-end can delete a particular MIDI instrument map
6327                        by sending the following command:
6328    </p>
6329    <p>
6330                            </p>
6331    <blockquote class="text">
6332    <p>REMOVE MIDI_INSTRUMENT_MAP &lt;map&gt;
6333    </p>
6334    </blockquote><p>
6335                        
6336    </p>
6337    <p>Where &lt;map&gt; reflects the unique ID of the map to delete
6338                        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>
6339                        command.
6340    </p>
6341    <p>The front-end can delete all MIDI instrument maps by
6342                        sending the following command:
6343    </p>
6344    <p>
6345                            </p>
6346    <blockquote class="text">
6347    <p>REMOVE MIDI_INSTRUMENT_MAP ALL
6348    </p>
6349    </blockquote><p>
6350                        
6351    </p>
6352    <p>Possible Answers:
6353    </p>
6354    <p>
6355                            </p>
6356    <blockquote class="text">
6357    <p>"OK" -
6358                                    </p>
6359    <blockquote class="text">
6360    <p>in case the map(s) could be deleted
6361    </p>
6362    </blockquote>
6363                                
6364    
6365    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6366                                    </p>
6367    <blockquote class="text">
6368    <p>when the given map does not exist
6369    </p>
6370    </blockquote>
6371                                
6372    
6373    </blockquote><p>
6374                        
6375    </p>
6376    <p>Examples:
6377    </p>
6378    <p>
6379                            </p>
6380    <blockquote class="text">
6381    <p>C: "REMOVE MIDI_INSTRUMENT_MAP 0"
6382    </p>
6383    <p>S: "OK"
6384    </p>
6385    </blockquote><p>
6386                        
6387    </p>
6388    <p>
6389                            </p>
6390    <blockquote class="text">
6391    <p>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
6392    </p>
6393    <p>S: "OK"
6394    </p>
6395    </blockquote><p>
6396                        
6397    </p>
6398    <a name="GET MIDI_INSTRUMENT_MAPS"></a><br /><hr />
6399    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6400    <a name="rfc.section.6.7.3"></a><h3>6.7.3.&nbsp;
6401    Get amount of existing MIDI instrument maps</h3>
6402    
6403    <p>The front-end can retrieve the current amount of MIDI
6404                        instrument maps by sending the following command:
6405    </p>
6406    <p>
6407                            </p>
6408    <blockquote class="text">
6409    <p>GET MIDI_INSTRUMENT_MAPS
6410    </p>
6411    </blockquote><p>
6412                        
6413    </p>
6414    <p>Possible Answers:
6415    </p>
6416    <p>
6417                            </p>
6418    <blockquote class="text">
6419    <p>The sampler will answer by returning the current
6420                                number of MIDI instrument maps.
6421    </p>
6422    </blockquote><p>
6423                        
6424    </p>
6425    <p>Example:
6426    </p>
6427    <p>
6428                            </p>
6429    <blockquote class="text">
6430    <p>C: "GET MIDI_INSTRUMENT_MAPS"
6431    </p>
6432    <p>S: "2"
6433    </p>
6434    </blockquote><p>
6435                        
6436    </p>
6437    <a name="LIST MIDI_INSTRUMENT_MAPS"></a><br /><hr />
6438    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6439    <a name="rfc.section.6.7.4"></a><h3>6.7.4.&nbsp;
6440    Getting all created MIDI instrument maps</h3>
6441    
6442    <p>The number of MIDI instrument maps can change on runtime. To get the
6443                        current list of MIDI instrument maps, the front-end can send the
6444                        following command:
6445    </p>
6446    <p>
6447                            </p>
6448    <blockquote class="text">
6449    <p>LIST MIDI_INSTRUMENT_MAPS
6450    </p>
6451    </blockquote><p>
6452                        
6453    </p>
6454    <p>Possible Answers:
6455    </p>
6456    <p>
6457                            </p>
6458    <blockquote class="text">
6459    <p>The sampler will answer by returning a comma separated list
6460                                with all MIDI instrument maps' numerical IDs.
6461    </p>
6462    </blockquote><p>
6463                        
6464    </p>
6465    <p>Example:
6466    </p>
6467    <p>
6468                            </p>
6469    <blockquote class="text">
6470    <p>C: "LIST MIDI_INSTRUMENT_MAPS"
6471    </p>
6472    <p>S: "0,1,5,12"
6473    </p>
6474    </blockquote><p>
6475                        
6476    </p>
6477    <a name="GET MIDI_INSTRUMENT_MAP INFO"></a><br /><hr />
6478    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6479    <a name="rfc.section.6.7.5"></a><h3>6.7.5.&nbsp;
6480    Getting MIDI instrument map information</h3>
6481    
6482    <p>The front-end can ask for the current settings of a MIDI
6483                        instrument map by sending the following command:
6484    </p>
6485    <p>
6486                            </p>
6487    <blockquote class="text">
6488    <p>GET MIDI_INSTRUMENT_MAP INFO &lt;map&gt;
6489    </p>
6490    </blockquote><p>
6491                        
6492    </p>
6493    <p>Where &lt;map&gt; is the numerical ID of the map the
6494                        front-end is interested in as returned by the
6495                        <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>
6496                        command.
6497    </p>
6498    <p>Possible Answers:
6499    </p>
6500    <p>
6501                            </p>
6502    <blockquote class="text">
6503    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6504                                Each answer line begins with the settings category name
6505                                followed by a colon and then a space character &lt;SP&gt; and finally
6506                                the info character string to that setting category. At the
6507                                moment the following categories are defined:
6508    </p>
6509    <p>
6510                                    </p>
6511    <blockquote class="text">
6512    <p>NAME -
6513                                            </p>
6514    <blockquote class="text">
6515    <p>custom name of the given map,
6516                                                which does not have to be unique
6517    </p>
6518    </blockquote>
6519                                        
6520    
6521    <p>DEFAULT -
6522                                            </p>
6523    <blockquote class="text">
6524    <p>either true or false,
6525                                                defines whether this map is the default map
6526    </p>
6527    </blockquote>
6528                                        
6529    
6530    </blockquote>
6531                                
6532    
6533    </blockquote><p>
6534                        
6535    </p>
6536    <p>The mentioned fields above don't have to be in particular order.
6537    </p>
6538    <p>Example:
6539    </p>
6540    <p>
6541                            </p>
6542    <blockquote class="text">
6543    <p>C: "GET MIDI_INSTRUMENT_MAP INFO 0"
6544    </p>
6545    <p>S: "NAME: Standard Map"
6546    </p>
6547    <p>&nbsp;&nbsp;&nbsp;"DEFAULT: true"
6548    </p>
6549    <p>&nbsp;&nbsp;&nbsp;"."
6550    </p>
6551    </blockquote><p>
6552                        
6553    </p>
6554    <a name="SET MIDI_INSTRUMENT_MAP NAME"></a><br /><hr />
6555    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6556    <a name="rfc.section.6.7.6"></a><h3>6.7.6.&nbsp;
6557    Renaming a MIDI instrument map</h3>
6558    
6559    <p>The front-end can alter the custom name of a MIDI
6560                        instrument map by sending the following command:
6561    </p>
6562    <p>
6563                            </p>
6564    <blockquote class="text">
6565    <p>SET MIDI_INSTRUMENT_MAP NAME &lt;map&gt; &lt;name&gt;
6566    </p>
6567    </blockquote><p>
6568                        
6569    </p>
6570    <p>Where &lt;map&gt; is the numerical ID of the map and
6571                        &lt;name&gt; the new custom name of the map, which does not
6572                        have to be unique.
6573    </p>
6574    <p>Possible Answers:
6575    </p>
6576    <p>
6577                            </p>
6578    <blockquote class="text">
6579    <p>"OK" -
6580                                    </p>
6581    <blockquote class="text">
6582    <p>on success
6583    </p>
6584    </blockquote>
6585                                
6586    
6587    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6588                                    </p>
6589    <blockquote class="text">
6590    <p>in case the given map does not exist
6591    </p>
6592    </blockquote>
6593                                
6594    
6595    </blockquote><p>
6596                        
6597    </p>
6598    <p>Example:
6599    </p>
6600    <p>
6601                            </p>
6602    <blockquote class="text">
6603    <p>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
6604    </p>
6605    <p>S: "OK"
6606    </p>
6607    </blockquote><p>
6608                        
6609    </p>
6610    <a name="MAP MIDI_INSTRUMENT"></a><br /><hr />
6611    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6612    <a name="rfc.section.6.7.7"></a><h3>6.7.7.&nbsp;
6613    Create or replace a MIDI instrument map entry</h3>
6614    
6615    <p>The front-end can create a new or replace an existing entry
6616                        in a sampler's MIDI instrument map by sending the following
6617                        command:
6618    </p>
6619    <p>
6620                            </p>
6621    <blockquote class="text">
6622    <p>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
6623                                &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
6624                                &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
6625                                [&lt;instr_load_mode&gt;] [&lt;name&gt;]
6626    </p>
6627    </blockquote><p>
6628                        
6629    </p>
6630    <p>Where &lt;map&gt; is the numeric ID of the map to alter,
6631                        &lt;midi_bank&gt; is an integer value between
6632                        0..16383 reflecting the MIDI bank select index,
6633                        &lt;midi_prog&gt; an
6634                        integer value between 0..127 reflecting the MIDI program change
6635                        index, &lt;engine_name&gt; a sampler engine name as returned by
6636                        the <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a>
6637                        command (not encapsulated into apostrophes), &lt;filename&gt; the name
6638                        of the instrument's file to be deployed (encapsulated into apostrophes),
6639                        &lt;instrument_index&gt; the index (integer value) of the instrument
6640                        within the given file, &lt;volume_value&gt; reflects the master
6641                        volume of the instrument as optionally dotted number (where a
6642                        value &lt; 1.0 means attenuation and a value > 1.0 means
6643                        amplification). This parameter easily allows to adjust the
6644                        volume of all intruments within a custom instrument map
6645                        without having to adjust their instrument files. The
6646                        OPTIONAL &lt;instr_load_mode&gt; argument defines the life
6647                        time of the instrument, that is when the instrument should
6648                        be loaded, when freed and has exactly the following
6649                        possibilities:
6650    </p>
6651    <p>
6652                            </p>
6653    <blockquote class="text">
6654    <p>"ON_DEMAND" -
6655                                    </p>
6656    <blockquote class="text">
6657    <p>The instrument will be loaded when needed,
6658                                        that is when demanded by at least one sampler
6659                                        channel. It will immediately be freed from memory
6660                                        when not needed by any sampler channel anymore.
6661    </p>
6662    </blockquote>
6663                                
6664    
6665    <p>"ON_DEMAND_HOLD" -
6666                                    </p>
6667    <blockquote class="text">
6668    <p>The instrument will be loaded when needed,
6669                                        that is when demanded by at least one sampler
6670                                        channel. It will be kept in memory even when
6671                                        not needed by any sampler channel anymore.
6672                                        Instruments with this mode are only freed
6673                                        when the sampler is reset or all mapping
6674                                        entries with this mode (and respective
6675                                        instrument) are explicitly changed to
6676                                        "ON_DEMAND" and no sampler channel is using
6677                                        the instrument anymore.
6678    </p>
6679    </blockquote>
6680                                
6681    
6682    <p>"PERSISTENT" -
6683                                    </p>
6684    <blockquote class="text">
6685    <p>The instrument will immediately be loaded
6686                                        into memory when this mapping
6687                                        command is sent and the instrument is kept all
6688                                        the time. Instruments with this mode are
6689                                        only freed when the sampler is reset or all
6690                                        mapping entries with this mode (and
6691                                        respective instrument) are explicitly
6692                                        changed to "ON_DEMAND" and no sampler
6693                                        channel is using the instrument anymore.
6694    </p>
6695    </blockquote>
6696                                
6697    
6698    <p>not supplied -
6699                                    </p>
6700    <blockquote class="text">
6701    <p>In case there is no &lt;instr_load_mode&gt;
6702                                        argument given, it will be up to the
6703                                        InstrumentManager to decide which mode to use.
6704                                        Usually it will use "ON_DEMAND" if an entry
6705                                        for the given instrument does not exist in
6706                                        the InstrumentManager's list yet, otherwise
6707                                        if an entry already exists, it will simply
6708                                        stick with the mode currently reflected by
6709                                        the already existing entry, that is it will
6710                                        not change the mode.
6711    </p>
6712    </blockquote>
6713                                
6714    
6715    </blockquote><p>
6716                        
6717    </p>
6718    <p>
6719                        The &lt;instr_load_mode&gt; argument thus allows to define an
6720                        appropriate strategy (low memory consumption vs. fast
6721                        instrument switching) for each instrument individually. Note, the
6722                        following restrictions apply to this argument: "ON_DEMAND_HOLD" and
6723                        "PERSISTENT" have to be supported by the respective sampler engine
6724                        (which is technically the case when the engine provides an
6725                        InstrumentManager for its format). If this is not the case the
6726                        argument will automatically fall back to the default value
6727                        "ON_DEMAND". Also the load mode of one instrument may
6728                        automatically change the laod mode of other instrument(s), i.e.
6729                        because the instruments are part of the same file and the
6730                        engine does not allow a way to manage load modes for them
6731                        individually. Due to this, in case the frontend shows the
6732                        load modes of entries, the frontend should retrieve the actual
6733                        mode by i.e. sending
6734                        <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>
6735                        command(s). Finally the OPTIONAL &lt;name&gt; argument allows to
6736                        set a custom name (encapsulated into apostrophes) for the mapping
6737                        entry, useful for frontends for displaying an appropriate name for
6738                        mapped instruments (using
6739                        <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>).
6740                        
6741    </p>
6742    <p>
6743                        By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
6744                        completely established in the sampler. The OPTIONAL "NON_MODAL" argument
6745                        however causes the respective "MAP MIDI_INSTRUMENT" command to return
6746                        immediately, that is to let the sampler establish the mapping in the
6747                        background. So this argument might be especially useful for mappings with
6748                        a "PERSISTENT" type, because these have to load the respective instruments
6749                        immediately and might thus block for a very long time. It is recommended
6750                        however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
6751                        because it has the following drawbacks: as "NON_MODAL" instructions return
6752                        immediately, they may not necessarily return an error i.e. when the given
6753                        instrument file turns out to be corrupt, beside that subsequent commands
6754                        in a LSCP instruction sequence might fail, because mandatory mappings are
6755                        not yet completed.
6756                        
6757    </p>
6758    <p>Possible Answers:
6759    </p>
6760    <p>
6761                            </p>
6762    <blockquote class="text">
6763    <p>"OK" -
6764                                    </p>
6765    <blockquote class="text">
6766    <p>usually
6767    </p>
6768    </blockquote>
6769                                
6770    
6771    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6772                                    </p>
6773    <blockquote class="text">
6774    <p>when the given map or engine does not exist or a value
6775                                        is out of range
6776    </p>
6777    </blockquote>
6778                                
6779    
6780    </blockquote><p>
6781                        
6782    </p>
6783    <p>Examples:
6784    </p>
6785    <p>
6786                            </p>
6787    <blockquote class="text">
6788    <p>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"
6789    </p>
6790    <p>S: "OK"
6791    </p>
6792    </blockquote><p>
6793                        
6794    </p>
6795    <p>
6796                            </p>
6797    <blockquote class="text">
6798    <p>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"
6799    </p>
6800    <p>S: "OK"
6801    </p>
6802    </blockquote><p>
6803                        
6804    </p>
6805    <p>
6806                            </p>
6807    <blockquote class="text">
6808    <p>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"
6809    </p>
6810    <p>S: "OK"
6811    </p>
6812    <p>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"
6813    </p>
6814    <p>S: "OK"
6815    </p>
6816    </blockquote><p>
6817                        
6818    </p>
6819    <p>
6820                            </p>
6821    <blockquote class="text">
6822    <p>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
6823    </p>
6824    <p>S: "OK"
6825    </p>
6826    </blockquote><p>
6827                        
6828    </p>
6829    <a name="GET MIDI_INSTRUMENTS"></a><br /><hr />
6830    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6831    <a name="rfc.section.6.7.8"></a><h3>6.7.8.&nbsp;
6832    Getting ammount of MIDI instrument map entries</h3>
6833    
6834    <p>The front-end can query the amount of currently existing
6835                        entries in a MIDI instrument map by sending the following
6836                        command:
6837    </p>
6838    <p>
6839                            </p>
6840    <blockquote class="text">
6841    <p>GET MIDI_INSTRUMENTS &lt;map&gt;
6842    </p>
6843    </blockquote><p>
6844                        
6845    </p>
6846    <p>The front-end can query the amount of currently existing
6847                        entries in all MIDI instrument maps by sending the following
6848                        command:
6849    </p>
6850    <p>
6851                            </p>
6852    <blockquote class="text">
6853    <p>GET MIDI_INSTRUMENTS ALL
6854    </p>
6855    </blockquote><p>
6856                        
6857    </p>
6858    <p>Possible Answers:
6859    </p>
6860    <p>
6861                            </p>
6862    <blockquote class="text">
6863    <p>The sampler will answer by sending the current number of
6864                                entries in the MIDI instrument map(s).
6865    </p>
6866    </blockquote><p>
6867                        
6868    </p>
6869    <p>Example:
6870    </p>
6871    <p>
6872                            </p>
6873    <blockquote class="text">
6874    <p>C: "GET MIDI_INSTRUMENTS 0"
6875    </p>
6876    <p>S: "234"
6877    </p>
6878    </blockquote><p>
6879                        
6880    </p>
6881    <p>
6882                            </p>
6883    <blockquote class="text">
6884    <p>C: "GET MIDI_INSTRUMENTS ALL"
6885    </p>
6886    <p>S: "954"
6887    </p>
6888    </blockquote><p>
6889                        
6890    </p>
6891    <a name="LIST MIDI_INSTRUMENTS"></a><br /><hr />
6892    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6893    <a name="rfc.section.6.7.9"></a><h3>6.7.9.&nbsp;
6894    Getting indeces of all entries of a MIDI instrument map</h3>
6895    
6896    <p>The front-end can query a list of all currently existing
6897                        entries in a certain MIDI instrument map by sending the following
6898                        command:
6899    </p>
6900    <p>
6901                            </p>
6902    <blockquote class="text">
6903    <p>LIST MIDI_INSTRUMENTS &lt;map&gt;
6904    </p>
6905    </blockquote><p>
6906                        
6907    </p>
6908    <p>Where &lt;map&gt; is the numeric ID of the MIDI instrument map.
6909    </p>
6910    <p>The front-end can query a list of all currently existing
6911                        entries of all MIDI instrument maps by sending the following
6912                        command:
6913    </p>
6914    <p>
6915                            </p>
6916    <blockquote class="text">
6917    <p>LIST MIDI_INSTRUMENTS ALL
6918    </p>
6919    </blockquote><p>
6920                        
6921    </p>
6922    <p>Possible Answers:
6923    </p>
6924    <p>
6925                            </p>
6926    <blockquote class="text">
6927    <p>The sampler will answer by sending a comma separated
6928                                list of map ID - MIDI bank - MIDI program triples, where
6929                                each triple is encapsulated into curly braces. The
6930                                list is returned in one single line. Each triple
6931                                just reflects the key of the respective map entry,
6932                                thus subsequent
6933                                <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>
6934                                command(s) are necessary to retrieve detailed informations
6935                                about each entry.
6936    </p>
6937    </blockquote><p>
6938                        
6939    </p>
6940    <p>Example:
6941    </p>
6942    <p>
6943                            </p>
6944    <blockquote class="text">
6945    <p>C: "LIST MIDI_INSTRUMENTS 0"
6946    </p>
6947    <p>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
6948    </p>
6949    </blockquote><p>
6950                        
6951    </p>
6952    <a name="UNMAP MIDI_INSTRUMENT"></a><br /><hr />
6953    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6954    <a name="rfc.section.6.7.10"></a><h3>6.7.10.&nbsp;
6955    Remove an entry from the MIDI instrument map</h3>
6956    
6957    <p>The front-end can delete an entry from a MIDI instrument
6958                        map by sending the following command:
6959    </p>
6960    <p>
6961                            </p>
6962    <blockquote class="text">
6963    <p>UNMAP MIDI_INSTRUMENT &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;
6964    </p>
6965    </blockquote><p>
6966                        
6967    </p>
6968    <p>
6969                        Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
6970                        &lt;midi_bank&gt; is an integer value between 0..16383
6971                        reflecting the MIDI bank value and
6972                        &lt;midi_prog&gt; an integer value between
6973                        0..127 reflecting the MIDI program value of the map's entrie's key
6974                        index triple.
6975                        
6976    </p>
6977    <p>Possible Answers:
6978    </p>
6979    <p>
6980                            </p>
6981    <blockquote class="text">
6982    <p>"OK" -
6983                                    </p>
6984    <blockquote class="text">
6985    <p>usually
6986    </p>
6987    </blockquote>
6988                                
6989    
6990    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6991                                    </p>
6992    <blockquote class="text">
6993    <p>when index out of bounds
6994    </p>
6995    </blockquote>
6996                                
6997    
6998    </blockquote><p>
6999                        
7000    </p>
7001    <p>Example:
7002    </p>
7003    <p>
7004                            </p>
7005    <blockquote class="text">
7006    <p>C: "UNMAP MIDI_INSTRUMENT 0 2 127"
7007    </p>
7008    <p>S: "OK"
7009    </p>
7010    </blockquote><p>
7011                        
7012    </p>
7013    <a name="GET MIDI_INSTRUMENT INFO"></a><br /><hr />
7014    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7015    <a name="rfc.section.6.7.11"></a><h3>6.7.11.&nbsp;
7016    Get current settings of MIDI instrument map entry</h3>
7017    
7018    <p>The front-end can retrieve the current settings of a certain
7019                        instrument map entry by sending the following command:
7020    </p>
7021    <p>
7022                            </p>
7023    <blockquote class="text">
7024    <p>GET MIDI_INSTRUMENT INFO &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;
7025    </p>
7026    </blockquote><p>
7027                        
7028    </p>
7029    <p>
7030                        Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
7031                        &lt;midi_bank&gt; is an integer value between 0..16383
7032                        reflecting the MIDI bank value, &lt;midi_bank&gt;
7033                        and &lt;midi_prog&gt; an integer value between
7034                        0..127 reflecting the MIDI program value of the map's entrie's key
7035                        index triple.
7036                        
7037    </p>
7038    <p>Possible Answers:
7039    </p>
7040    <p>
7041                            </p>
7042    <blockquote class="text">
7043    <p>LinuxSampler will answer by sending a &lt;CRLF&gt;
7044                                separated list. Each answer line begins with the
7045                                information category name followed by a colon and then
7046                                a space character &lt;SP&gt; and finally the info
7047                                character string to that info category. At the moment
7048                                the following categories are defined:
7049    </p>
7050    <p>"NAME" -
7051                                    </p>
7052    <blockquote class="text">
7053    <p>Name for this MIDI instrument map entry (if defined).
7054                                        This name shall be used by frontends for displaying a
7055                                        name for this mapped instrument. It can be set and
7056                                        changed with the
7057                                        <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>
7058                                        command and does not have to be unique.
7059    </p>
7060    </blockquote>
7061                                
7062    
7063    <p>"ENGINE_NAME" -
7064                                    </p>
7065    <blockquote class="text">
7066    <p>Name of the engine to be deployed for this
7067                                        instrument.
7068    </p>
7069    </blockquote>
7070                                
7071    
7072    <p>"INSTRUMENT_FILE" -
7073                                    </p>
7074    <blockquote class="text">
7075    <p>File name of the instrument.
7076    </p>
7077    </blockquote>
7078                                
7079    
7080    <p>"INSTRUMENT_NR" -
7081                                    </p>
7082    <blockquote class="text">
7083    <p>Index of the instrument within the file.
7084    </p>
7085    </blockquote>
7086                                
7087    
7088    <p>"INSTRUMENT_NAME" -
7089                                    </p>
7090    <blockquote class="text">
7091    <p>Name of the loaded instrument as reflected by its file.
7092                                        In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
7093                                        cannot be changed.
7094    </p>
7095    </blockquote>
7096                                
7097    
7098    <p>"LOAD_MODE" -
7099                                    </p>
7100    <blockquote class="text">
7101    <p>Life time of instrument
7102                                        (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).
7103    </p>
7104    </blockquote>
7105                                
7106    
7107    <p>"VOLUME" -
7108                                    </p>
7109    <blockquote class="text">
7110    <p>master volume of the instrument as optionally
7111                                        dotted number (where a value &lt; 1.0 means attenuation
7112                                        and a value > 1.0 means amplification)
7113    </p>
7114    </blockquote>
7115                                
7116    
7117    <p>The mentioned fields above don't have to be in particular order.
7118    </p>
7119    </blockquote><p>
7120                        
7121    </p>
7122    <p>Example:
7123    </p>
7124    <p>
7125                            </p>
7126    <blockquote class="text">
7127    <p>C: "GET MIDI_INSTRUMENT INFO 1 45 120"
7128    </p>
7129    <p>S: "NAME: Drums for Foo Song"
7130    </p>
7131    <p>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"
7132    </p>
7133    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
7134    </p>
7135    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"
7136    </p>
7137    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Joe's Drumkit"
7138    </p>
7139    <p>&nbsp;&nbsp;&nbsp;"LOAD_MODE: PERSISTENT"
7140    </p>
7141    <p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
7142    </p>
7143    <p>&nbsp;&nbsp;&nbsp;"."
7144    </p>
7145    </blockquote><p>
7146                        
7147    </p>
7148    <a name="CLEAR MIDI_INSTRUMENTS"></a><br /><hr />
7149    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7150    <a name="rfc.section.6.7.12"></a><h3>6.7.12.&nbsp;
7151    Clear MIDI instrument map</h3>
7152    
7153    <p>The front-end can clear a whole MIDI instrument map, that
7154                        is delete all its entries by sending the following command:
7155    </p>
7156    <p>
7157                            </p>
7158    <blockquote class="text">
7159    <p>CLEAR MIDI_INSTRUMENTS &lt;map&gt;
7160    </p>
7161    </blockquote><p>
7162                        
7163    </p>
7164    <p>Where &lt;map&gt; is the numeric ID of the map to clear.
7165    </p>
7166    <p>The front-end can clear all MIDI instrument maps, that
7167                        is delete all entries of all maps by sending the following
7168                        command:
7169    </p>
7170    <p>
7171                            </p>
7172    <blockquote class="text">
7173    <p>CLEAR MIDI_INSTRUMENTS ALL
7174    </p>
7175    </blockquote><p>
7176                        
7177    </p>
7178    <p>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the
7179                        maps, only their entries, thus the map's settings like
7180                        custom name will be preservevd.
7181    </p>
7182    <p>Possible Answers:
7183    </p>
7184    <p>
7185                            </p>
7186    <blockquote class="text">
7187    <p>"OK" -
7188                                    </p>
7189    <blockquote class="text">
7190    <p>always
7191    </p>
7192    </blockquote>
7193                                
7194    
7195    </blockquote><p>
7196                        
7197    </p>
7198    <p>Examples:
7199    </p>
7200    <p>
7201                           </p>
7202    <blockquote class="text">
7203    <p>C: "CLEAR MIDI_INSTRUMENTS 0"
7204    </p>
7205    <p>S: "OK"
7206    </p>
7207    </blockquote><p>
7208                        
7209    </p>
7210    <p>
7211                           </p>
7212    <blockquote class="text">
7213    <p>C: "CLEAR MIDI_INSTRUMENTS ALL"
7214    </p>
7215    <p>S: "OK"
7216    </p>
7217    </blockquote><p>
7218                        
7219    </p>
7220    <a name="Managing Instruments Database"></a><br /><hr />
7221    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7222    <a name="rfc.section.6.8"></a><h3>6.8.&nbsp;
7223    Managing Instruments Database</h3>
7224    
7225    <p>The following commands describe how to use and manage
7226                    the instruments database.
7227    </p>
7228    <a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7229    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7230    <a name="rfc.section.6.8.1"></a><h3>6.8.1.&nbsp;
7231    Creating a new instrument directory</h3>
7232    
7233    <p>The front-end can add a new instrument directory to the
7234                        instruments database by sending the following command:
7235    </p>
7236    <p>
7237                            </p>
7238    <blockquote class="text">
7239    <p>ADD DB_INSTRUMENT_DIRECTORY &lt;dir&gt;
7240    </p>
7241    </blockquote><p>
7242                        
7243    </p>
7244    <p>Where &lt;dir&gt; is the absolute path name of the directory
7245                        to be created (encapsulated into apostrophes).
7246    </p>
7247    <p>Possible Answers:
7248    </p>
7249    <p>
7250                            </p>
7251    <blockquote class="text">
7252    <p>"OK" -
7253                                    </p>
7254    <blockquote class="text">
7255    <p>on success
7256    </p>
7257    </blockquote>
7258                                
7259    
7260    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7261                                    </p>
7262    <blockquote class="text">
7263    <p>when the directory could not be created, which
7264                                        can happen if the directory already exists or the
7265                                        name contains not allowed symbols
7266    </p>
7267    </blockquote>
7268                                
7269    
7270    </blockquote><p>
7271                        
7272    </p>
7273    <p>Examples:
7274    </p>
7275    <p>
7276                            </p>
7277    <blockquote class="text">
7278    <p>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
7279    </p>
7280    <p>S: "OK"
7281    </p>
7282    </blockquote><p>
7283                        
7284    </p>
7285    <a name="REMOVE DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7286    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7287    <a name="rfc.section.6.8.2"></a><h3>6.8.2.&nbsp;
7288    Deleting an instrument directory</h3>
7289    
7290    <p>The front-end can delete a particular instrument directory
7291                        from the instruments database by sending the following command:
7292    </p>
7293    <p>
7294                            </p>
7295    <blockquote class="text">
7296    <p>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] &lt;dir&gt;
7297    </p>
7298    </blockquote><p>
7299                        
7300    </p>
7301    <p>Where &lt;dir&gt; is the absolute path name of the directory
7302                        to delete. The optional FORCE argument can be used to
7303                        force the deletion of a non-empty directory and all its content.
7304    </p>
7305    <p>Possible Answers:
7306    </p>
7307    <p>
7308                            </p>
7309    <blockquote class="text">
7310    <p>"OK" -
7311                                    </p>
7312    <blockquote class="text">
7313    <p>if the directory is deleted successfully
7314    </p>
7315    </blockquote>
7316                                
7317    
7318    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7319                                    </p>
7320    <blockquote class="text">
7321    <p>if the given directory does not exist, or
7322                                        if trying to delete a non-empty directory,
7323                                        without using the FORCE argument.
7324    </p>
7325    </blockquote>
7326                                
7327    
7328    </blockquote><p>
7329                        
7330    </p>
7331    <p>Examples:
7332    </p>
7333    <p>
7334                            </p>
7335    <blockquote class="text">
7336    <p>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"
7337    </p>
7338    <p>S: "OK"
7339    </p>
7340    </blockquote><p>
7341                        
7342    </p>
7343    <a name="GET DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
7344    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7345    <a name="rfc.section.6.8.3"></a><h3>6.8.3.&nbsp;
7346    Getting amount of instrument directories</h3>
7347    
7348    <p>The front-end can retrieve the current amount of
7349                        directories in a specific directory by sending the following command:
7350    </p>
7351    <p>
7352                            </p>
7353    <blockquote class="text">
7354    <p>GET DB_INSTRUMENT_DIRECTORIES &lt;dir&gt;
7355    </p>
7356    </blockquote><p>
7357                        
7358    </p>
7359    <p>Where &lt;dir&gt; should be replaced by the absolute path
7360                        name of the directory.
7361    </p>
7362    <p>Possible Answers:
7363    </p>
7364    <p>
7365                            </p>
7366    <blockquote class="text">
7367    <p>The current number of instrument directories
7368                                in the specified directory.
7369    </p>
7370    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7371                                    </p>
7372    <blockquote class="text">
7373    <p>if the given directory does not exist.
7374    </p>
7375    </blockquote>
7376                                
7377    
7378    </blockquote><p>
7379                        
7380    </p>
7381    <p>Example:
7382    </p>
7383    <p>
7384                            </p>
7385    <blockquote class="text">
7386    <p>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
7387    </p>
7388    <p>S: "2"
7389    </p>
7390    </blockquote><p>
7391                        
7392    </p>
7393    <a name="LIST DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
7394    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7395    <a name="rfc.section.6.8.4"></a><h3>6.8.4.&nbsp;
7396    Listing all directories in specific directory</h3>
7397    
7398    <p>The front-end can retrieve the current list of directories
7399                        in specific directory by sending the following command:
7400    </p>
7401    <p>
7402                            </p>
7403    <blockquote class="text">
7404    <p>LIST DB_INSTRUMENT_DIRECTORIES &lt;dir&gt;
7405    </p>
7406    </blockquote><p>
7407                        
7408    </p>
7409    <p>Where &lt;dir&gt; should be replaced by the absolute path
7410                        name of the directory.
7411    </p>
7412    <p>Possible Answers:
7413    </p>
7414    <p>
7415                            </p>
7416    <blockquote class="text">
7417    <p>A comma separated list of all instrument directories
7418                                (encapsulated into apostrophes) in the specified directory.
7419    </p>
7420    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7421                                    </p>
7422    <blockquote class="text">
7423    <p>if the given directory does not exist.
7424    </p>
7425    </blockquote>
7426                                
7427    
7428    </blockquote><p>
7429                        
7430    </p>
7431    <p>Example:
7432    </p>
7433    <p>
7434                            </p>
7435    <blockquote class="text">
7436    <p>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
7437    </p>
7438    <p>S: "'Piano Collection','Percussion Collection'"
7439    </p>
7440    </blockquote><p>
7441                        
7442    </p>
7443    <a name="GET DB_INSTRUMENT_DIRECTORY INFO"></a><br /><hr />
7444    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7445    <a name="rfc.section.6.8.5"></a><h3>6.8.5.&nbsp;
7446    Getting instrument directory information</h3>
7447    
7448    <p>The front-end can ask for the current settings of an
7449                        instrument directory by sending the following command:
7450    </p>
7451    <p>
7452                            </p>
7453    <blockquote class="text">
7454    <p>GET DB_INSTRUMENT_DIRECTORY INFO &lt;dir&gt;
7455    </p>
7456    </blockquote><p>
7457                        
7458    </p>
7459    <p>Where &lt;dir&gt; should be replaced by the absolute path
7460                        name of the directory the front-end is interested in.
7461    </p>
7462    <p>Possible Answers:
7463    </p>
7464    <p>
7465                            </p>
7466    <blockquote class="text">
7467    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
7468                                Each answer line begins with the settings category name
7469                                followed by a colon and then a space character &lt;SP&gt; and finally
7470                                the info character string to that setting category. At the
7471                                moment the following categories are defined:
7472    </p>
7473    <p>
7474                                    </p>
7475    <blockquote class="text">
7476    <p>DESCRIPTION -
7477                                            </p>
7478    <blockquote class="text">
7479    <p>A brief description of the directory content
7480    </p>
7481    </blockquote>
7482                                        
7483    
7484    <p>CREATED -
7485                                            </p>
7486    <blockquote class="text">
7487    <p>The creation date and time of the directory,
7488                                                represented in "YYYY-MM-DD HH:MM:SS" format
7489    </p>
7490    </blockquote>
7491                                        
7492    
7493    <p>MODIFIED -
7494                                            </p>
7495    <blockquote class="text">
7496    <p>The date and time of the last modification of the
7497                                                directory, represented in "YYYY-MM-DD HH:MM:SS" format
7498    </p>
7499    </blockquote>
7500                                        
7501    
7502    </blockquote>
7503                                
7504    
7505    </blockquote><p>
7506                        
7507    </p>
7508    <p>The mentioned fields above don't have to be in particular order.
7509    </p>
7510    <p>Example:
7511    </p>
7512    <p>
7513                            </p>
7514    <blockquote class="text">
7515    <p>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
7516    </p>
7517    <p>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."
7518    </p>
7519    <p>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"
7520    </p>
7521    <p>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"
7522    </p>
7523    <p>&nbsp;&nbsp;&nbsp;"."
7524    </p>
7525    </blockquote><p>
7526                        
7527    </p>
7528    <a name="SET DB_INSTRUMENT_DIRECTORY NAME"></a><br /><hr />
7529    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7530    <a name="rfc.section.6.8.6"></a><h3>6.8.6.&nbsp;
7531    Renaming an instrument directory</h3>
7532    
7533    <p>The front-end can alter the name of a specific
7534                        instrument directory by sending the following command:
7535    </p>
7536    <p>
7537                            </p>
7538    <blockquote class="text">
7539    <p>SET DB_INSTRUMENT_DIRECTORY NAME &lt;dir&gt; &lt;name&gt;
7540    </p>
7541    </blockquote><p>
7542                        
7543    </p>
7544    <p>Where &lt;dir&gt; is the absolute path name of the directory and
7545                        &lt;name&gt; is the new name for that directory.
7546    </p>
7547    <p>Possible Answers:
7548    </p>
7549    <p>
7550                            </p>
7551    <blockquote class="text">
7552    <p>"OK" -
7553                                    </p>
7554    <blockquote class="text">
7555    <p>on success
7556    </p>
7557    </blockquote>
7558                                
7559    
7560    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7561                                    </p>
7562    <blockquote class="text">
7563    <p>in case the given directory does not exists,
7564                                        or if a directory with name equal to the new
7565                                        name already exists.
7566    </p>
7567    </blockquote>
7568                                
7569    
7570    </blockquote><p>
7571                        
7572    </p>
7573    <p>Example:
7574    </p>
7575    <p>
7576                            </p>
7577    <blockquote class="text">
7578    <p>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"
7579    </p>
7580    <p>S: "OK"
7581    </p>
7582    </blockquote><p>
7583                        
7584    </p>
7585    <a name="MOVE DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7586    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7587    <a name="rfc.section.6.8.7"></a><h3>6.8.7.&nbsp;
7588    Moving an instrument directory</h3>
7589    
7590    <p>The front-end can move a specific
7591                        instrument directory by sending the following command:
7592    </p>
7593    <p>
7594                            </p>
7595    <blockquote class="text">
7596    <p>MOVE DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;
7597    </p>
7598    </blockquote><p>
7599                        
7600    </p>
7601    <p>Where &lt;dir&gt; is the absolute path name of the directory
7602                        to move and &lt;dst&gt; is the location where the directory will
7603                        be moved to.
7604    </p>
7605    <p>Possible Answers:
7606    </p>
7607    <p>
7608                            </p>
7609    <blockquote class="text">
7610    <p>"OK" -
7611                                    </p>
7612    <blockquote class="text">
7613    <p>on success
7614    </p>
7615    </blockquote>
7616                                
7617    
7618    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7619                                    </p>
7620    <blockquote class="text">
7621    <p>in case a given directory does not exists,
7622                                        or if a directory with name equal to the name
7623                                        of the specified directory already exists in
7624                                        the destination directory. Error is also thrown
7625                                        when trying to move a directory to a subdirectory
7626                                        of itself.
7627    </p>
7628    </blockquote>
7629                                
7630    
7631    </blockquote><p>
7632                        
7633    </p>
7634    <p>Example:
7635    </p>
7636    <p>
7637                            </p>
7638    <blockquote class="text">
7639    <p>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"
7640    </p>
7641    <p>S: "OK"
7642    </p>
7643    </blockquote><p>
7644                        
7645    </p>
7646    <a name="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"></a><br /><hr />
7647    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7648    <a name="rfc.section.6.8.8"></a><h3>6.8.8.&nbsp;
7649    Changing the description of directory</h3>
7650    
7651    <p>The front-end can alter the description of a specific
7652                        instrument directory by sending the following command:
7653    </p>
7654    <p>
7655                            </p>
7656    <blockquote class="text">
7657    <p>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION &lt;dir&gt; &lt;desc&gt;
7658    </p>
7659    </blockquote><p>
7660                        
7661    </p>
7662    <p>Where &lt;dir&gt; is the absolute path name of the directory and
7663                        &lt;desc&gt; is the new description for the directory.
7664    </p>
7665    <p>Possible Answers:
7666    </p>
7667    <p>
7668                            </p>
7669    <blockquote class="text">
7670    <p>"OK" -
7671                                    </p>
7672    <blockquote class="text">
7673    <p>on success
7674    </p>
7675    </blockquote>
7676                                
7677    
7678    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7679                                    </p>
7680    <blockquote class="text">
7681    <p>in case the given directory does not exists.
7682    </p>
7683    </blockquote>
7684                                
7685    
7686    </blockquote><p>
7687                        
7688    </p>
7689    <p>Example:
7690    </p>
7691    <p>
7692                            </p>
7693    <blockquote class="text">
7694    <p>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"
7695    </p>
7696    <p>S: "OK"
7697    </p>
7698    </blockquote><p>
7699                        
7700    </p>
7701    <a name="ADD DB_INSTRUMENTS"></a><br /><hr />
7702    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7703    <a name="rfc.section.6.8.9"></a><h3>6.8.9.&nbsp;
7704    Adding instruments to the instruments database</h3>
7705    
7706    <p>The front-end can add one or more instruments
7707                        to the instruments database by sending the following command:
7708    </p>
7709    <p>
7710                            </p>
7711    <blockquote class="text">
7712    <p>ADD DB_INSTRUMENTS [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]
7713    </p>
7714    </blockquote><p>
7715                        
7716    </p>
7717    <p>Where &lt;db_dir&gt; is the absolute path name of a directory
7718                        (encapsulated into apostrophes) in the instruments database in which
7719                        only the new instruments (that are not already in the database) will
7720                        be added, &lt;file_path&gt; is the absolute path name of a file or
7721                        directory in the file system (encapsulated into apostrophes). In case
7722                        an instrument file is supplied, only the instruments in the specified
7723                        file will be added to the instruments database. If the optional
7724                        &lt;instr_index&gt; (the index of the instrument within the given file)
7725                        is supplied too, then only the specified instrument will be added.
7726                        In case a directory is supplied, the instruments in that directory
7727                        will be added. The OPTIONAL &lt;mode&gt; argument is only applied
7728                        when a directory is provided as &lt;file_path&gt; and specifies how the
7729                        scanning will be done and has exactly the following possibilities:
7730    </p>
7731    <p>
7732                            </p>
7733    <blockquote class="text">
7734    <p>"NON_RECURSIVE" -
7735                                    </p>
7736    <blockquote class="text">
7737    <p>Only the instruments in the specified directory
7738                                        will be added, the instruments in the subdirectories
7739                                        will not be processed.
7740    </p>
7741    </blockquote>
7742                                
7743    
7744    <p>"FLAT" -
7745                                    </p>
7746    <blockquote class="text">
7747    <p>All instruments will be processed, including those
7748                                        in the subdirectories, but the respective subdirectory
7749                                        structure will not be recreated in the instruments
7750                                        database. All instruments will be added directly in
7751                                        the specified database directory.
7752    </p>
7753    </blockquote>
7754                                
7755    
7756    <p>not supplied -
7757                                    </p>
7758    <blockquote class="text">
7759    <p>The subdirectory tree structure will be recreated
7760                                        in the instruments database and all instruments will be
7761                                        processed and added to the respective subdirectory
7762                                        in the instruments database.
7763    </p>
7764    </blockquote>
7765                                
7766    
7767    </blockquote><p>
7768                        
7769    </p>
7770    <p>Possible Answers:
7771    </p>
7772    <p>
7773                            </p>
7774    <blockquote class="text">
7775    <p>"OK" -
7776                                    </p>
7777    <blockquote class="text">
7778    <p>on success
7779    </p>
7780    </blockquote>
7781                                
7782    
7783    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7784                                    </p>
7785    <blockquote class="text">
7786    <p>if an invalid path is specified.
7787    </p>
7788    </blockquote>
7789                                
7790    
7791    </blockquote><p>
7792                        
7793    </p>
7794    <p>Examples:
7795    </p>
7796    <p>
7797                            </p>
7798    <blockquote class="text">
7799    <p>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"
7800    </p>
7801    <p>S: "OK"
7802    </p>
7803    </blockquote><p>
7804                        
7805    </p>
7806    <a name="REMOVE DB_INSTRUMENT"></a><br /><hr />
7807    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7808    <a name="rfc.section.6.8.10"></a><h3>6.8.10.&nbsp;
7809    Removing an instrument</h3>
7810    
7811    <p>The front-end can remove a particular instrument
7812                        from the instruments database by sending the following command:
7813    </p>
7814    <p>
7815                            </p>
7816    <blockquote class="text">
7817    <p>REMOVE DB_INSTRUMENT &lt;instr_path&gt;
7818    </p>
7819    </blockquote><p>
7820                        
7821    </p>
7822    <p>Where &lt;instr_path&gt; is the absolute path name
7823                        (in the instruments database) of the instrument to remove.
7824    </p>
7825    <p>Possible Answers:
7826    </p>
7827    <p>
7828                            </p>
7829    <blockquote class="text">
7830    <p>"OK" -
7831                                    </p>
7832    <blockquote class="text">
7833    <p>if the instrument is removed successfully
7834    </p>
7835    </blockquote>
7836                                
7837    
7838    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7839                                    </p>
7840    <blockquote class="text">
7841    <p>if the given path does not exist or
7842                                        is a directory.
7843    </p>
7844    </blockquote>
7845                                
7846    
7847    </blockquote><p>
7848                        
7849    </p>
7850    <p>Examples:
7851    </p>
7852    <p>
7853                            </p>
7854    <blockquote class="text">
7855    <p>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"
7856    </p>
7857    <p>S: "OK"
7858    </p>
7859    </blockquote><p>
7860                        
7861    </p>
7862    <a name="GET DB_INSTRUMENTS"></a><br /><hr />
7863    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7864    <a name="rfc.section.6.8.11"></a><h3>6.8.11.&nbsp;
7865    Getting amount of instruments</h3>
7866    
7867    <p>The front-end can retrieve the current amount of
7868                        instruments in a specific directory by sending the following command:
7869    </p>
7870    <p>
7871                            </p>
7872    <blockquote class="text">
7873    <p>GET DB_INSTRUMENTS &lt;dir&gt;
7874    </p>
7875    </blockquote><p>
7876                        
7877    </p>
7878    <p>Where &lt;dir&gt; should be replaced by the absolute path name
7879                        of the directory.
7880    </p>
7881    <p>Possible Answers:
7882    </p>
7883    <p>
7884                            </p>
7885    <blockquote class="text">
7886    <p>The current number of instruments
7887                                in the specified directory.
7888    </p>
7889    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7890                                    </p>
7891    <blockquote class="text">
7892    <p>if the given directory does not exist.
7893    </p>
7894    </blockquote>
7895                                
7896    
7897    </blockquote><p>
7898                        
7899    </p>
7900    <p>Example:
7901    </p>
7902    <p>
7903                            </p>
7904    <blockquote class="text">
7905    <p>C: "GET DB_INSTRUMENTS '/Piano Collection'"
7906    </p>
7907    <p>S: "2"
7908    </p>
7909    </blockquote><p>
7910                        
7911    </p>
7912    <a name="LIST 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.12"></a><h3>6.8.12.&nbsp;
7915    Listing all instruments in specific directory</h3>
7916    
7917    <p>The front-end can retrieve the current list of instruments
7918                        in specific directory by sending the following command:
7919    </p>
7920    <p>
7921                            </p>
7922    <blockquote class="text">
7923    <p>LIST DB_INSTRUMENTS &lt;dir&gt;
7924    </p>
7925    </blockquote><p>
7926                        
7927    </p>
7928    <p>Where &lt;dir&gt; should be replaced by the absolute path
7929                        name of the directory.
7930    </p>
7931    <p>Possible Answers:
7932    </p>
7933    <p>
7934                            </p>
7935    <blockquote class="text">
7936    <p>A comma separated list of all instruments
7937                                (encapsulated into apostrophes) in the specified directory.
7938    </p>
7939    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7940                                    </p>
7941    <blockquote class="text">
7942    <p>if the given directory does not exist.
7943    </p>
7944    </blockquote>
7945                                
7946    
7947    </blockquote><p>
7948                        
7949    </p>
7950    <p>Example:
7951    </p>
7952    <p>
7953                            </p>
7954    <blockquote class="text">
7955    <p>C: "LIST DB_INSTRUMENTS '/Piano Collection'"
7956    </p>
7957    <p>S: "'Bosendorfer 290','Steinway D'"
7958    </p>
7959    </blockquote><p>
7960                        
7961    </p>
7962    <a name="GET DB_INSTRUMENT INFO"></a><br /><hr />
7963    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7964    <a name="rfc.section.6.8.13"></a><h3>6.8.13.&nbsp;
7965    Getting instrument information</h3>
7966    
7967    <p>The front-end can ask for the current settings of an
7968                        instrument by sending the following command:
7969    </p>
7970    <p>
7971                            </p>
7972    <blockquote class="text">
7973    <p>GET DB_INSTRUMENT INFO &lt;instr_path&gt;
7974    </p>
7975    </blockquote><p>
7976                        
7977    </p>
7978    <p>Where &lt;instr_path&gt; should be replaced by the absolute path
7979                        name of the instrument the front-end is interested in.
7980    </p>
7981    <p>Possible Answers:
7982    </p>
7983    <p>
7984                            </p>
7985    <blockquote class="text">
7986    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
7987                                Each answer line begins with the settings category name
7988                                followed by a colon and then a space character &lt;SP&gt; and finally
7989                                the info character string to that setting category. At the
7990                                moment the following categories are defined:
7991    </p>
7992    <p>
7993                                    </p>
7994    <blockquote class="text">
7995    <p>INSTRUMENT_FILE -
7996                                            </p>
7997    <blockquote class="text">
7998    <p>File name of the instrument.
7999    </p>
8000    </blockquote>
8001                                        
8002    
8003    <p>INSTRUMENT_NR -
8004                                            </p>
8005    <blockquote class="text">
8006    <p>Index of the instrument within the file.
8007    </p>
8008    </blockquote>
8009                                        
8010    
8011    <p>FORMAT_FAMILY -
8012                                            </p>
8013    <blockquote class="text">
8014    <p>The format family of the instrument.
8015    </p>
8016    </blockquote>
8017                                        
8018    
8019    <p>FORMAT_VERSION -
8020                                            </p>
8021    <blockquote class="text">
8022    <p>The format version of the instrument.
8023    </p>
8024    </blockquote>
8025                                        
8026    
8027    <p>SIZE -
8028                                            </p>
8029    <blockquote class="text">
8030    <p>The size of the instrument in bytes.
8031    </p>
8032    </blockquote>
8033                                        
8034    
8035    <p>CREATED -
8036                                            </p>
8037    <blockquote class="text">
8038    <p>The date and time when the instrument is added
8039                                                in the instruments database, represented in
8040                                               "YYYY-MM-DD HH:MM:SS" format
8041    </p>
8042    </blockquote>
8043                                        
8044    
8045    <p>MODIFIED -
8046                                            </p>
8047    <blockquote class="text">
8048    <p>The date and time of the last modification of the
8049                                                instrument's database settings, represented in
8050                                                "YYYY-MM-DD HH:MM:SS" format
8051    </p>
8052    </blockquote>
8053                                        
8054    
8055    <p>DESCRIPTION -
8056                                            </p>
8057    <blockquote class="text">
8058    <p>A brief description of the instrument
8059    </p>
8060    </blockquote>
8061                                        
8062    
8063    <p>IS_DRUM -
8064                                            </p>
8065    <blockquote class="text">
8066    <p>either true or false, determines whether the
8067                                                instrument is a drumkit or a chromatic instrument
8068    </p>
8069    </blockquote>
8070                                        
8071    
8072    <p>PRODUCT -
8073                                            </p>
8074    <blockquote class="text">
8075    <p>The product title of the instrument
8076    </p>
8077    </blockquote>
8078                                        
8079    
8080    <p>ARTISTS -
8081                                            </p>
8082    <blockquote class="text">
8083    <p>Lists the artist names
8084    </p>
8085    </blockquote>
8086                                        
8087    
8088    <p>KEYWORDS -
8089                                            </p>
8090    <blockquote class="text">
8091    <p>Provides a list of keywords that refer to the instrument.
8092                                                Keywords are separated with semicolon and blank.
8093    </p>
8094    </blockquote>
8095                                        
8096    
8097    </blockquote>
8098                                
8099    
8100    </blockquote><p>
8101                        
8102    </p>
8103    <p>The mentioned fields above don't have to be in particular order.
8104    </p>
8105    <p>Example:
8106    </p>
8107    <p>
8108                            </p>
8109    <blockquote class="text">
8110    <p>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"
8111    </p>
8112    <p>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"
8113    </p>
8114    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"
8115    </p>
8116    <p>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"
8117    </p>
8118    <p>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 2"
8119    </p>
8120    <p>&nbsp;&nbsp;&nbsp;"SIZE: 2050871870"
8121    </p>
8122    <p>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"
8123    </p>
8124    <p>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"
8125    </p>
8126    <p>&nbsp;&nbsp;&nbsp;"DESCRIPTION: "
8127    </p>
8128    <p>&nbsp;&nbsp;&nbsp;"IS_DRUM: false"
8129    </p>
8130    <p>&nbsp;&nbsp;&nbsp;"PRODUCT: GRANDIOSO Bosendorfer 290"
8131    </p>
8132    <p>&nbsp;&nbsp;&nbsp;"ARTISTS: Post Musical Instruments"
8133    </p>
8134    <p>&nbsp;&nbsp;&nbsp;"KEYWORDS: Bosendorfer"
8135    </p>
8136    <p>&nbsp;&nbsp;&nbsp;"."
8137    </p>
8138    </blockquote><p>
8139                        
8140    </p>
8141    <a name="SET DB_INSTRUMENT NAME"></a><br /><hr />
8142    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8143    <a name="rfc.section.6.8.14"></a><h3>6.8.14.&nbsp;
8144    Renaming an instrument</h3>
8145    
8146    <p>The front-end can alter the name of a specific
8147                        instrument by sending the following command:
8148    </p>
8149    <p>
8150                            </p>
8151    <blockquote class="text">
8152    <p>SET DB_INSTRUMENT NAME &lt;instr&gt; &lt;name&gt;
8153    </p>
8154    </blockquote><p>
8155                        
8156    </p>
8157    <p>Where &lt;instr&gt; is the absolute path name of the instrument and
8158                        &lt;name&gt; is the new name for that instrument.
8159    </p>
8160    <p>Possible Answers:
8161    </p>
8162    <p>
8163                            </p>
8164    <blockquote class="text">
8165    <p>"OK" -
8166                                    </p>
8167    <blockquote class="text">
8168    <p>on success
8169    </p>
8170    </blockquote>
8171                                
8172    
8173    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8174                                    </p>
8175    <blockquote class="text">
8176    <p>in case the given instrument does not exists,
8177                                        or if an instrument with name equal to the new
8178                                        name already exists.
8179    </p>
8180    </blockquote>
8181                                
8182    
8183    </blockquote><p>
8184                        
8185    </p>
8186    <p>Example:
8187    </p>
8188    <p>
8189                            </p>
8190    <blockquote class="text">
8191    <p>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"
8192    </p>
8193    <p>S: "OK"
8194    </p>
8195    </blockquote><p>
8196                        
8197    </p>
8198    <a name="MOVE DB_INSTRUMENT"></a><br /><hr />
8199    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8200    <a name="rfc.section.6.8.15"></a><h3>6.8.15.&nbsp;
8201    Moving an instrument</h3>
8202    
8203    <p>The front-end can move a specific instrument to another directory by
8204                        sending the following command:
8205    </p>
8206    <p>
8207                            </p>
8208    <blockquote class="text">
8209    <p>MOVE DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;
8210    </p>
8211    </blockquote><p>
8212                        
8213    </p>
8214    <p>Where &lt;instr&gt; is the absolute path name of the instrument
8215                        to move and &lt;dst&gt; is the directory where the instrument will
8216                        be moved to.
8217    </p>
8218    <p>Possible Answers:
8219    </p>
8220    <p>
8221                            </p>
8222    <blockquote class="text">
8223    <p>"OK" -
8224                                    </p>
8225    <blockquote class="text">
8226    <p>on success
8227    </p>
8228    </blockquote>
8229                                
8230    
8231    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8232                                    </p>
8233    <blockquote class="text">
8234    <p>in case the given instrument does not exists,
8235                                        or if an instrument with name equal to the name of the
8236                                        specified instrument already exists in the destination
8237                                        directory.
8238    </p>
8239    </blockquote>
8240                                
8241    
8242    </blockquote><p>
8243                        
8244    </p>
8245    <p>Example:
8246    </p>
8247    <p>
8248                            </p>
8249    <blockquote class="text">
8250    <p>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"
8251    </p>
8252    <p>S: "OK"
8253    </p>
8254    </blockquote><p>
8255                        
8256    </p>
8257    <a name="SET DB_INSTRUMENT DESCRIPTION"></a><br /><hr />
8258    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8259    <a name="rfc.section.6.8.16"></a><h3>6.8.16.&nbsp;
8260    Changing the description of instrument</h3>
8261    
8262    <p>The front-end can alter the description of a specific
8263                        instrument by sending the following command:
8264    </p>
8265    <p>
8266                            </p>
8267    <blockquote class="text">
8268    <p>SET DB_INSTRUMENT DESCRIPTION &lt;instr&gt; &lt;desc&gt;
8269    </p>
8270    </blockquote><p>
8271                        
8272    </p>
8273    <p>Where &lt;instr&gt; is the absolute path name of the instrument and
8274                        &lt;desc&gt; is the new description for the instrument.
8275    </p>
8276    <p>Possible Answers:
8277    </p>
8278    <p>
8279                            </p>
8280    <blockquote class="text">
8281    <p>"OK" -
8282                                    </p>
8283    <blockquote class="text">
8284    <p>on success
8285    </p>
8286    </blockquote>
8287                                
8288    
8289    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8290                                    </p>
8291    <blockquote class="text">
8292    <p>in case the given instrument does not exists.
8293    </p>
8294    </blockquote>
8295                                
8296    
8297    </blockquote><p>
8298                        
8299    </p>
8300    <p>Example:
8301    </p>
8302    <p>
8303                            </p>
8304    <blockquote class="text">
8305    <p>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"
8306    </p>
8307    <p>S: "OK"
8308    </p>
8309    </blockquote><p>
8310                        
8311    </p>
8312  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
8313  <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>
8314  <a name="rfc.section.7"></a><h3>7.&nbsp;Command Syntax</h3>  <a name="rfc.section.7"></a><h3>7.&nbsp;
8315    Command Syntax</h3>
8316    
8317  <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>
8318              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>)
8319              where applicable.              where applicable.
8320                            
8321  </p>  </p>
# Line 5201  Intellectual Property and Copyright Stat Line 8373  Intellectual Property and Copyright Stat
8373  <p>command =  <p>command =
8374          </p>          </p>
8375  <blockquote class="text">  <blockquote class="text">
8376  <p>ADD SP CHANNEL  <p>ADD SP add_instruction
8377                    
8378    </p>
8379    <p>/ MAP SP map_instruction
8380                    
8381    </p>
8382    <p>/ UNMAP SP unmap_instruction
8383                                    
8384  </p>  </p>
8385  <p>/ GET SP get_instruction  <p>/ GET SP get_instruction
# Line 5219  Intellectual Property and Copyright Stat Line 8397  Intellectual Property and Copyright Stat
8397  <p>/ LOAD SP load_instruction  <p>/ LOAD SP load_instruction
8398                                    
8399  </p>  </p>
8400  <p>/ REMOVE SP CHANNEL SP sampler_channel  <p>/ REMOVE SP remove_instruction
8401                                    
8402  </p>  </p>
8403  <p>/ SET SP set_instruction  <p>/ SET SP set_instruction
# Line 5231  Intellectual Property and Copyright Stat Line 8409  Intellectual Property and Copyright Stat
8409  <p>/ UNSUBSCRIBE SP unsubscribe_event  <p>/ UNSUBSCRIBE SP unsubscribe_event
8410                                    
8411  </p>  </p>
8412  <p>/ SELECT SP text  <p>/ RESET SP reset_instruction
8413                    
8414    </p>
8415    <p>/ CLEAR SP clear_instruction
8416                                    
8417  </p>  </p>
8418  <p>/ RESET SP CHANNEL SP sampler_channel  <p>/ MOVE SP move_instruction
8419                                    
8420  </p>  </p>
8421  <p>/ RESET  <p>/ RESET
# Line 5246  Intellectual Property and Copyright Stat Line 8427  Intellectual Property and Copyright Stat
8427  </blockquote><p>  </blockquote><p>
8428    
8429  </p>  </p>
8430    <p>add_instruction =
8431            </p>
8432    <blockquote class="text">
8433    <p>CHANNEL
8434                    
8435    </p>
8436    <p>/ DB_INSTRUMENT_DIRECTORY SP pathname
8437                    
8438    </p>
8439    <p>/ DB_INSTRUMENTS SP FLAT SP pathname SP pathname
8440                    
8441    </p>
8442    <p>/ DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname
8443                    
8444    </p>
8445    <p>/ DB_INSTRUMENTS SP pathname SP pathname
8446                    
8447    </p>
8448    <p>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index
8449                    
8450    </p>
8451    <p>/ MIDI_INSTRUMENT_MAP
8452                    
8453    </p>
8454    <p>/ MIDI_INSTRUMENT_MAP SP map_name
8455                    
8456    </p>
8457    </blockquote><p>
8458    
8459    </p>
8460  <p>subscribe_event =  <p>subscribe_event =
8461          </p>          </p>
8462  <blockquote class="text">  <blockquote class="text">
8463  <p>CHANNEL_COUNT  <p>AUDIO_OUTPUT_DEVICE_COUNT
8464                    
8465    </p>
8466    <p>/ AUDIO_OUTPUT_DEVICE_INFO
8467                    
8468    </p>
8469    <p>/ MIDI_INPUT_DEVICE_COUNT
8470                    
8471    </p>
8472    <p>/ MIDI_INPUT_DEVICE_INFO
8473                    
8474    </p>
8475    <p>/ CHANNEL_COUNT
8476                                    
8477  </p>  </p>
8478  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
# Line 5264  Intellectual Property and Copyright Stat Line 8487  Intellectual Property and Copyright Stat
8487  <p>/ CHANNEL_INFO  <p>/ CHANNEL_INFO
8488                                    
8489  </p>  </p>
8490    <p>/ FX_SEND_COUNT
8491                    
8492    </p>
8493    <p>/ FX_SEND_INFO
8494                    
8495    </p>
8496    <p>/ MIDI_INSTRUMENT_MAP_COUNT
8497                    
8498    </p>
8499    <p>/ MIDI_INSTRUMENT_MAP_INFO
8500                    
8501    </p>
8502    <p>/ MIDI_INSTRUMENT_COUNT
8503                    
8504    </p>
8505    <p>/ MIDI_INSTRUMENT_INFO
8506                    
8507    </p>
8508    <p>/ DB_INSTRUMENT_DIRECTORY_COUNT
8509                    
8510    </p>
8511    <p>/ DB_INSTRUMENT_DIRECTORY_INFO
8512                    
8513    </p>
8514    <p>/ DB_INSTRUMENT_COUNT
8515                    
8516    </p>
8517    <p>/ DB_INSTRUMENT_INFO
8518                    
8519    </p>
8520  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
8521                                    
8522  </p>  </p>
8523  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
8524                                    
8525  </p>  </p>
8526    <p>/ GLOBAL_INFO
8527                    
8528    </p>
8529  </blockquote><p>  </blockquote><p>
8530    
8531  </p>  </p>
8532  <p>unsubscribe_event =  <p>unsubscribe_event =
8533          </p>          </p>
8534  <blockquote class="text">  <blockquote class="text">
8535  <p>CHANNEL_COUNT  <p>AUDIO_OUTPUT_DEVICE_COUNT
8536                    
8537    </p>
8538    <p>/ AUDIO_OUTPUT_DEVICE_INFO
8539                    
8540    </p>
8541    <p>/ MIDI_INPUT_DEVICE_COUNT
8542                    
8543    </p>
8544    <p>/ MIDI_INPUT_DEVICE_INFO
8545                    
8546    </p>
8547    <p>/ CHANNEL_COUNT
8548                                    
8549  </p>  </p>
8550  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
# Line 5291  Intellectual Property and Copyright Stat Line 8559  Intellectual Property and Copyright Stat
8559  <p>/ CHANNEL_INFO  <p>/ CHANNEL_INFO
8560                                    
8561  </p>  </p>
8562    <p>/ FX_SEND_COUNT
8563                    
8564    </p>
8565    <p>/ FX_SEND_INFO
8566                    
8567    </p>
8568    <p>/ MIDI_INSTRUMENT_MAP_COUNT
8569                    
8570    </p>
8571    <p>/ MIDI_INSTRUMENT_MAP_INFO
8572                    
8573    </p>
8574    <p>/ MIDI_INSTRUMENT_COUNT
8575                    
8576    </p>
8577    <p>/ MIDI_INSTRUMENT_INFO
8578                    
8579    </p>
8580    <p>/ DB_INSTRUMENT_DIRECTORY_COUNT
8581                    
8582    </p>
8583    <p>/ DB_INSTRUMENT_DIRECTORY_INFO
8584                    
8585    </p>
8586    <p>/ DB_INSTRUMENT_COUNT
8587                    
8588    </p>
8589    <p>/ DB_INSTRUMENT_INFO
8590                    
8591    </p>
8592  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
8593                                    
8594  </p>  </p>
8595  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
8596                                    
8597  </p>  </p>
8598    <p>/ GLOBAL_INFO
8599                    
8600    </p>
8601    </blockquote><p>
8602    
8603    </p>
8604    <p>map_instruction =
8605            </p>
8606    <blockquote class="text">
8607    <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
8608                    
8609    </p>
8610    <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
8611                    
8612    </p>
8613    <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
8614                    
8615    </p>
8616    <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
8617                    
8618    </p>
8619    </blockquote><p>
8620    
8621    </p>
8622    <p>unmap_instruction =
8623            </p>
8624    <blockquote class="text">
8625    <p>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
8626                    
8627    </p>
8628    </blockquote><p>
8629    
8630    </p>
8631    <p>remove_instruction =
8632            </p>
8633    <blockquote class="text">
8634    <p>CHANNEL SP sampler_channel
8635                    
8636    </p>
8637    <p>/ MIDI_INSTRUMENT_MAP SP midi_map
8638                    
8639    </p>
8640    <p>/ MIDI_INSTRUMENT_MAP SP ALL
8641                    
8642    </p>
8643    <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname
8644                    
8645    </p>
8646    <p>/ DB_INSTRUMENT_DIRECTORY SP pathname
8647                    
8648    </p>
8649    <p>/ DB_INSTRUMENT SP pathname
8650                    
8651    </p>
8652  </blockquote><p>  </blockquote><p>
8653    
8654  </p>  </p>
# Line 5381  Intellectual Property and Copyright Stat Line 8733  Intellectual Property and Copyright Stat
8733  <p>/ TOTAL_VOICE_COUNT_MAX  <p>/ TOTAL_VOICE_COUNT_MAX
8734                                    
8735  </p>  </p>
8736    <p>/ MIDI_INSTRUMENTS SP midi_map
8737                    
8738    </p>
8739    <p>/ MIDI_INSTRUMENTS SP ALL
8740                    
8741    </p>
8742    <p>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
8743                    
8744    </p>
8745    <p>/ MIDI_INSTRUMENT_MAPS
8746                    
8747    </p>
8748    <p>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
8749                    
8750    </p>
8751    <p>/ FX_SENDS SP sampler_channel
8752                    
8753    </p>
8754    <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
8755                    
8756    </p>
8757    <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname
8758                    
8759    </p>
8760    <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
8761                    
8762    </p>
8763    <p>/ DB_INSTRUMENTS SP pathname
8764                    
8765    </p>
8766    <p>/ DB_INSTRUMENT SP INFO SP pathname
8767                    
8768    </p>
8769    <p>/ VOLUME
8770                    
8771    </p>
8772  </blockquote><p>  </blockquote><p>
8773    
8774  </p>  </p>
# Line 5402  Intellectual Property and Copyright Stat Line 8790  Intellectual Property and Copyright Stat
8790  <p>/ CHANNEL SP set_chan_instruction  <p>/ CHANNEL SP set_chan_instruction
8791                                    
8792  </p>  </p>
8793    <p>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
8794                    
8795    </p>
8796    <p>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
8797                    
8798    </p>
8799    <p>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
8800                    
8801    </p>
8802    <p>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
8803                    
8804    </p>
8805    <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
8806                    
8807    </p>
8808    <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname
8809                    
8810    </p>
8811    <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval
8812                    
8813    </p>
8814    <p>/ DB_INSTRUMENT SP NAME SP pathname SP dirname
8815                    
8816    </p>
8817    <p>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval
8818                    
8819    </p>
8820  <p>/ ECHO SP boolean  <p>/ ECHO SP boolean
8821                                    
8822  </p>  </p>
8823    <p>/ VOLUME SP volume_value
8824                    
8825    </p>
8826  </blockquote><p>  </blockquote><p>
8827    
8828  </p>  </p>
# Line 5423  Intellectual Property and Copyright Stat Line 8841  Intellectual Property and Copyright Stat
8841  <p>/ MIDI_INPUT_DEVICE SP string  <p>/ MIDI_INPUT_DEVICE SP string
8842                                    
8843  </p>  </p>
8844    <p>/ FX_SEND SP sampler_channel SP midi_ctrl
8845                    
8846    </p>
8847    <p>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
8848                    
8849    </p>
8850    </blockquote><p>
8851    
8852    </p>
8853    <p>reset_instruction =
8854            </p>
8855    <blockquote class="text">
8856    <p>CHANNEL SP sampler_channel
8857                    
8858    </p>
8859    </blockquote><p>
8860    
8861    </p>
8862    <p>clear_instruction =
8863            </p>
8864    <blockquote class="text">
8865    <p>MIDI_INSTRUMENTS SP midi_map
8866                    
8867    </p>
8868    <p>/ MIDI_INSTRUMENTS SP ALL
8869                    
8870    </p>
8871    </blockquote><p>
8872    
8873    </p>
8874    <p>move_instruction =
8875            </p>
8876    <blockquote class="text">
8877    <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
8878                    
8879    </p>
8880    <p>/ DB_INSTRUMENT SP pathname SP pathname
8881                    
8882    </p>
8883  </blockquote><p>  </blockquote><p>
8884    
8885  </p>  </p>
# Line 5435  Intellectual Property and Copyright Stat Line 8892  Intellectual Property and Copyright Stat
8892  <p>/ MIDI_INPUT_DEVICE SP number  <p>/ MIDI_INPUT_DEVICE SP number
8893                                    
8894  </p>  </p>
8895    <p>/ FX_SEND SP sampler_channel SP fx_send_id
8896                    
8897    </p>
8898  </blockquote><p>  </blockquote><p>
8899    
8900  </p>  </p>
# Line 5486  Intellectual Property and Copyright Stat Line 8946  Intellectual Property and Copyright Stat
8946  <p>/ SOLO SP sampler_channel SP boolean  <p>/ SOLO SP sampler_channel SP boolean
8947                                    
8948  </p>  </p>
8949    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
8950                    
8951    </p>
8952    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
8953                    
8954    </p>
8955    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
8956                    
8957    </p>
8958    </blockquote><p>
8959    
8960    </p>
8961    <p>modal_arg =
8962            </p>
8963    <blockquote class="text">
8964    <p>/* epsilon (empty argument) */
8965                    
8966    </p>
8967    <p>/ NON_MODAL SP
8968                    
8969    </p>
8970  </blockquote><p>  </blockquote><p>
8971    
8972  </p>  </p>
# Line 5534  Intellectual Property and Copyright Stat Line 9015  Intellectual Property and Copyright Stat
9015  <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS  <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
9016                                    
9017  </p>  </p>
9018    <p>/ MIDI_INSTRUMENTS SP midi_map
9019                    
9020    </p>
9021    <p>/ MIDI_INSTRUMENTS SP ALL
9022                    
9023    </p>
9024    <p>/ MIDI_INSTRUMENT_MAPS
9025                    
9026    </p>
9027    <p>/ FX_SENDS SP sampler_channel
9028                    
9029    </p>
9030    <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname
9031                    
9032    </p>
9033    <p>/ DB_INSTRUMENTS SP pathname
9034                    
9035    </p>
9036  </blockquote><p>  </blockquote><p>
9037    
9038  </p>  </p>
# Line 5558  Intellectual Property and Copyright Stat Line 9057  Intellectual Property and Copyright Stat
9057  </blockquote><p>  </blockquote><p>
9058    
9059  </p>  </p>
9060    <p>instr_load_mode =
9061            </p>
9062    <blockquote class="text">
9063    <p>ON_DEMAND
9064                    
9065    </p>
9066    <p>/ ON_DEMAND_HOLD
9067                    
9068    </p>
9069    <p>/ PERSISTENT
9070                    
9071    </p>
9072    </blockquote><p>
9073    
9074    </p>
9075  <p>device_index =  <p>device_index =
9076          </p>          </p>
9077  <blockquote class="text">  <blockquote class="text">
# Line 5615  Intellectual Property and Copyright Stat Line 9129  Intellectual Property and Copyright Stat
9129  </blockquote><p>  </blockquote><p>
9130    
9131  </p>  </p>
9132    <p>midi_map =
9133            </p>
9134    <blockquote class="text">
9135    <p>number
9136                    
9137    </p>
9138    </blockquote><p>
9139    
9140    </p>
9141    <p>midi_bank =
9142            </p>
9143    <blockquote class="text">
9144    <p>number
9145                    
9146    </p>
9147    </blockquote><p>
9148    
9149    </p>
9150    <p>midi_prog =
9151            </p>
9152    <blockquote class="text">
9153    <p>number
9154                    
9155    </p>
9156    </blockquote><p>
9157    
9158    </p>
9159    <p>midi_ctrl =
9160            </p>
9161    <blockquote class="text">
9162    <p>number
9163                    
9164    </p>
9165    </blockquote><p>
9166    
9167    </p>
9168  <p>volume_value =  <p>volume_value =
9169          </p>          </p>
9170  <blockquote class="text">  <blockquote class="text">
# Line 5645  Intellectual Property and Copyright Stat Line 9195  Intellectual Property and Copyright Stat
9195  </blockquote><p>  </blockquote><p>
9196    
9197  </p>  </p>
9198    <p>fx_send_id =
9199            </p>
9200    <blockquote class="text">
9201    <p>number
9202                    
9203    </p>
9204    </blockquote><p>
9205    
9206    </p>
9207  <p>engine_name =  <p>engine_name =
9208          </p>          </p>
9209  <blockquote class="text">  <blockquote class="text">
# Line 5654  Intellectual Property and Copyright Stat Line 9213  Intellectual Property and Copyright Stat
9213  </blockquote><p>  </blockquote><p>
9214    
9215  </p>  </p>
9216    <p>pathname =
9217            </p>
9218    <blockquote class="text">
9219    <p>stringval
9220                    
9221    </p>
9222    </blockquote><p>
9223    
9224    </p>
9225    <p>dirname =
9226            </p>
9227    <blockquote class="text">
9228    <p>stringval
9229                    
9230    </p>
9231    </blockquote><p>
9232    
9233    </p>
9234  <p>filename =  <p>filename =
9235          </p>          </p>
9236  <blockquote class="text">  <blockquote class="text">
# Line 5663  Intellectual Property and Copyright Stat Line 9240  Intellectual Property and Copyright Stat
9240  </blockquote><p>  </blockquote><p>
9241    
9242  </p>  </p>
9243    <p>map_name =
9244            </p>
9245    <blockquote class="text">
9246    <p>stringval
9247                    
9248    </p>
9249    </blockquote><p>
9250    
9251    </p>
9252    <p>entry_name =
9253            </p>
9254    <blockquote class="text">
9255    <p>stringval
9256                    
9257    </p>
9258    </blockquote><p>
9259    
9260    </p>
9261    <p>fx_send_name =
9262            </p>
9263    <blockquote class="text">
9264    <p>stringval
9265                    
9266    </p>
9267    </blockquote><p>
9268    
9269    </p>
9270  <p>param_val_list =  <p>param_val_list =
9271          </p>          </p>
9272  <blockquote class="text">  <blockquote class="text">
# Line 5694  Intellectual Property and Copyright Stat Line 9298  Intellectual Property and Copyright Stat
9298    
9299  </p>  </p>
9300  <a name="events"></a><br /><hr />  <a name="events"></a><br /><hr />
9301  <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>
9302  <a name="rfc.section.8"></a><h3>8.&nbsp;Events</h3>  <a name="rfc.section.8"></a><h3>8.&nbsp;
9303    Events</h3>
9304    
9305  <p>This chapter will describe all currently defined events supported by LinuxSampler.  <p>This chapter will describe all currently defined events supported by LinuxSampler.
9306  </p>  </p>
9307  <a name="SUBSCRIBE CHANNEL"></a><br /><hr />  <a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"></a><br /><hr />
9308  <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>
9309  <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;
9310    Number of audio output devices changed</h3>
9311    
9312    <p>Client may want to be notified when the total number of audio output devices on the
9313                    back-end changes by issuing the following command:
9314    </p>
9315    <p>
9316                        </p>
9317    <blockquote class="text">
9318    <p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
9319    </p>
9320    </blockquote><p>
9321                    
9322    </p>
9323    <p>Server will start sending the following notification messages:
9324    </p>
9325    <p>
9326                        </p>
9327    <blockquote class="text">
9328    <p>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"
9329    </p>
9330    </blockquote><p>
9331                    
9332    </p>
9333    <p>where &lt;devices&gt; will be replaced by the new number
9334                    of audio output devices.
9335    </p>
9336    <a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"></a><br /><hr />
9337    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9338    <a name="rfc.section.8.2"></a><h3>8.2.&nbsp;
9339    Audio output device's settings changed</h3>
9340    
9341    <p>Client may want to be notified when changes were made to audio output devices on the
9342                    back-end by issuing the following command:
9343    </p>
9344    <p>
9345                        </p>
9346    <blockquote class="text">
9347    <p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
9348    </p>
9349    </blockquote><p>
9350                    
9351    </p>
9352    <p>Server will start sending the following notification messages:
9353    </p>
9354    <p>
9355                        </p>
9356    <blockquote class="text">
9357    <p>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"
9358    </p>
9359    </blockquote><p>
9360                    
9361    </p>
9362    <p>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
9363                    which settings has been changed. The front-end will have to send
9364                    the respective command to actually get the audio output device info. Because these messages
9365                    will be triggered by LSCP commands issued by other clients rather than real
9366                    time events happening on the server, it is believed that an empty notification
9367                    message is sufficient here.
9368    </p>
9369    <a name="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"></a><br /><hr />
9370    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9371    <a name="rfc.section.8.3"></a><h3>8.3.&nbsp;
9372    Number of MIDI input devices changed</h3>
9373    
9374    <p>Client may want to be notified when the total number of MIDI input devices on the
9375                    back-end changes by issuing the following command:
9376    </p>
9377    <p>
9378                        </p>
9379    <blockquote class="text">
9380    <p>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
9381    </p>
9382    </blockquote><p>
9383                    
9384    </p>
9385    <p>Server will start sending the following notification messages:
9386    </p>
9387    <p>
9388                        </p>
9389    <blockquote class="text">
9390    <p>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"
9391    </p>
9392    </blockquote><p>
9393                    
9394    </p>
9395    <p>where &lt;devices&gt; will be replaced by the new number
9396                    of MIDI input devices.
9397    </p>
9398    <a name="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"></a><br /><hr />
9399    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9400    <a name="rfc.section.8.4"></a><h3>8.4.&nbsp;
9401    MIDI input device's settings changed</h3>
9402    
9403    <p>Client may want to be notified when changes were made to MIDI input devices on the
9404                    back-end by issuing the following command:
9405    </p>
9406    <p>
9407                        </p>
9408    <blockquote class="text">
9409    <p>SUBSCRIBE MIDI_INPUT_DEVICE_INFO
9410    </p>
9411    </blockquote><p>
9412                    
9413    </p>
9414    <p>Server will start sending the following notification messages:
9415    </p>
9416    <p>
9417                        </p>
9418    <blockquote class="text">
9419    <p>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"
9420    </p>
9421    </blockquote><p>
9422                    
9423    </p>
9424    <p>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
9425                    which settings has been changed. The front-end will have to send
9426                    the respective command to actually get the MIDI input device info. Because these messages
9427                    will be triggered by LSCP commands issued by other clients rather than real
9428                    time events happening on the server, it is believed that an empty notification
9429                    message is sufficient here.
9430    </p>
9431    <a name="SUBSCRIBE CHANNEL_COUNT"></a><br /><hr />
9432    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9433    <a name="rfc.section.8.5"></a><h3>8.5.&nbsp;
9434    Number of sampler channels changed</h3>
9435    
9436  <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
9437                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 5728  Intellectual Property and Copyright Stat Line 9458  Intellectual Property and Copyright Stat
9458                  of sampler channels.                  of sampler channels.
9459  </p>  </p>
9460  <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />
9461  <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>
9462  <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;
9463    Number of active voices changed</h3>
9464    
9465  <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
9466                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 5747  Intellectual Property and Copyright Stat Line 9478  Intellectual Property and Copyright Stat
9478  <p>  <p>
9479                      </p>                      </p>
9480  <blockquote class="text">  <blockquote class="text">
9481  <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;  <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"
9482  </p>  </p>
9483  </blockquote><p>  </blockquote><p>
9484                                    
# Line 5757  Intellectual Property and Copyright Stat Line 9488  Intellectual Property and Copyright Stat
9488                  active voices on that channel.                  active voices on that channel.
9489  </p>  </p>
9490  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />
9491  <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>
9492  <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;
9493    Number of active disk streams changed</h3>
9494    
9495  <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
9496                  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 9518  Intellectual Property and Copyright Stat
9518                  active disk streams on that channel.                  active disk streams on that channel.
9519  </p>  </p>
9520  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />
9521  <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>
9522  <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;
9523    Disk stream buffer fill state changed</h3>
9524    
9525  <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
9526                  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 9545  Intellectual Property and Copyright Stat
9545  </p>  </p>
9546  <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
9547                  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
9548                  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>
9549                  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.
9550  </p>  </p>
9551  <a name="SUBSCRIBE INFO"></a><br /><hr />  <a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr />
9552  <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>
9553  <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;
9554    Channel information changed</h3>
9555    
9556  <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
9557                  back-end by issuing the following command:                  back-end by issuing the following command:
# Line 5847  Intellectual Property and Copyright Stat Line 9581  Intellectual Property and Copyright Stat
9581                  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
9582                  message is sufficient here.                  message is sufficient here.
9583  </p>  </p>
9584    <a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr />
9585    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9586    <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
9587    Number of effect sends changed</h3>
9588    
9589    <p>Client may want to be notified when the number of effect sends on
9590                    a particular sampler channel is changed by issuing the following command:
9591    </p>
9592    <p>
9593                        </p>
9594    <blockquote class="text">
9595    <p>SUBSCRIBE FX_SEND_COUNT
9596    </p>
9597    </blockquote><p>
9598                    
9599    </p>
9600    <p>Server will start sending the following notification messages:
9601    </p>
9602    <p>
9603                        </p>
9604    <blockquote class="text">
9605    <p>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"
9606    </p>
9607    </blockquote><p>
9608                    
9609    </p>
9610    <p>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
9611                    channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
9612                    be replaced by the new number of effect sends on that channel.
9613    </p>
9614    <a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr />
9615    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9616    <a name="rfc.section.8.11"></a><h3>8.11.&nbsp;
9617    Effect send information changed</h3>
9618    
9619    <p>Client may want to be notified when changes were made to effect sends on a
9620                    a particular sampler channel by issuing the following command:
9621    </p>
9622    <p>
9623                        </p>
9624    <blockquote class="text">
9625    <p>SUBSCRIBE FX_SEND_INFO
9626    </p>
9627    </blockquote><p>
9628                    
9629    </p>
9630    <p>Server will start sending the following notification messages:
9631    </p>
9632    <p>
9633                        </p>
9634    <blockquote class="text">
9635    <p>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"
9636    </p>
9637    </blockquote><p>
9638                    
9639    </p>
9640    <p>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
9641                    channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
9642                    be replaced by the numerical ID of the changed effect send.
9643    </p>
9644  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />
9645  <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>
9646  <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;
9647    Total number of active voices changed</h3>
9648    
9649  <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
9650                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 5867  Intellectual Property and Copyright Stat Line 9662  Intellectual Property and Copyright Stat
9662  <p>  <p>
9663                      </p>                      </p>
9664  <blockquote class="text">  <blockquote class="text">
9665  <p>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;  <p>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"
9666  </p>  </p>
9667  </blockquote><p>  </blockquote><p>
9668                                    
# Line 5875  Intellectual Property and Copyright Stat Line 9670  Intellectual Property and Copyright Stat
9670  <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
9671                  all currently active voices.                  all currently active voices.
9672  </p>  </p>
9673    <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr />
9674    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9675    <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;
9676    Number of MIDI instrument maps changed</h3>
9677    
9678    <p>Client may want to be notified when the number of MIDI instrument maps on the
9679                    back-end changes by issuing the following command:
9680    </p>
9681    <p>
9682                        </p>
9683    <blockquote class="text">
9684    <p>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
9685    </p>
9686    </blockquote><p>
9687                    
9688    </p>
9689    <p>Server will start sending the following notification messages:
9690    </p>
9691    <p>
9692                        </p>
9693    <blockquote class="text">
9694    <p>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"
9695    </p>
9696    </blockquote><p>
9697                    
9698    </p>
9699    <p>where &lt;maps&gt; will be replaced by the new number
9700                    of MIDI instrument maps.
9701    </p>
9702    <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr />
9703    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9704    <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;
9705    MIDI instrument map information changed</h3>
9706    
9707    <p>Client may want to be notified when changes were made to MIDI instrument maps on the
9708                    back-end by issuing the following command:
9709    </p>
9710    <p>
9711                        </p>
9712    <blockquote class="text">
9713    <p>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
9714    </p>
9715    </blockquote><p>
9716                    
9717    </p>
9718    <p>Server will start sending the following notification messages:
9719    </p>
9720    <p>
9721                        </p>
9722    <blockquote class="text">
9723    <p>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"
9724    </p>
9725    </blockquote><p>
9726                    
9727    </p>
9728    <p>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
9729                    for which information changes occurred. The front-end will have to send
9730                    the respective command to actually get the MIDI instrument map info. Because these messages
9731                    will be triggered by LSCP commands issued by other clients rather than real
9732                    time events happening on the server, it is believed that an empty notification
9733                    message is sufficient here.
9734    </p>
9735    <a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr />
9736    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9737    <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;
9738    Number of MIDI instruments changed</h3>
9739    
9740    <p>Client may want to be notified when the number of MIDI instrument maps on the
9741                    back-end changes by issuing the following command:
9742    </p>
9743    <p>
9744                        </p>
9745    <blockquote class="text">
9746    <p>SUBSCRIBE MIDI_INSTRUMENT_COUNT
9747    </p>
9748    </blockquote><p>
9749                    
9750    </p>
9751    <p>Server will start sending the following notification messages:
9752    </p>
9753    <p>
9754                        </p>
9755    <blockquote class="text">
9756    <p>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"
9757    </p>
9758    </blockquote><p>
9759                    
9760    </p>
9761    <p>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
9762                    the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
9763                    the new number of MIDI instruments in the specified map.
9764    </p>
9765    <a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr />
9766    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9767    <a name="rfc.section.8.16"></a><h3>8.16.&nbsp;
9768    MIDI instrument information changed</h3>
9769    
9770    <p>Client may want to be notified when changes were made to MIDI instruments on the
9771                    back-end by issuing the following command:
9772    </p>
9773    <p>
9774                        </p>
9775    <blockquote class="text">
9776    <p>SUBSCRIBE MIDI_INSTRUMENT_INFO
9777    </p>
9778    </blockquote><p>
9779                    
9780    </p>
9781    <p>Server will start sending the following notification messages:
9782    </p>
9783    <p>
9784                        </p>
9785    <blockquote class="text">
9786    <p>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"
9787    </p>
9788    </blockquote><p>
9789                    
9790    </p>
9791    <p>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
9792                    in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
9793                    the location of the changed MIDI instrument in the map. The front-end will have to send
9794                    the respective command to actually get the MIDI instrument info. Because these messages
9795                    will be triggered by LSCP commands issued by other clients rather than real
9796                    time events happening on the server, it is believed that an empty notification
9797                    message is sufficient here.
9798    </p>
9799    <a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr />
9800    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9801    <a name="rfc.section.8.17"></a><h3>8.17.&nbsp;
9802    Global settings changed</h3>
9803    
9804    <p>Client may want to be notified when changes to the global settings
9805                    of the sampler were made by issuing the following command:
9806    </p>
9807    <p>
9808                        </p>
9809    <blockquote class="text">
9810    <p>SUBSCRIBE GLOBAL_INFO
9811    </p>
9812    </blockquote><p>
9813                    
9814    </p>
9815    <p>Server will start sending the following types of notification messages:
9816    </p>
9817    <p>
9818                        </p>
9819    <blockquote class="text">
9820    <p>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
9821                            golbal volume of the sampler is changed, where &lt;volume&gt; will be
9822                            replaced by the optional dotted floating point value, reflecting the
9823                            new global volume parameter.
9824    </p>
9825    </blockquote><p>
9826                    
9827    </p>
9828    <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />
9829    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9830    <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;
9831    Number of database instrument directories changed</h3>
9832    
9833    <p>Client may want to be notified when the number of instrument
9834                    directories in a particular directory in the instruments database
9835                    is changed by issuing the following command:
9836    </p>
9837    <p>
9838                        </p>
9839    <blockquote class="text">
9840    <p>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT
9841    </p>
9842    </blockquote><p>
9843                    
9844    </p>
9845    <p>Server will start sending the following notification messages:
9846    </p>
9847    <p>
9848                        </p>
9849    <blockquote class="text">
9850    <p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:&lt;dir-path&gt;"
9851    </p>
9852    </blockquote><p>
9853                    
9854    </p>
9855    <p>where &lt;dir-path&gt; will be replaced by the absolute path
9856                    name of the directory in the instruments database,
9857                    in which the number of directories is changed.
9858    </p>
9859    <p>Note that when a non-empty directory is removed, this event
9860                    is not sent for the subdirectories in that directory.
9861    </p>
9862    <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr />
9863    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9864    <a name="rfc.section.8.19"></a><h3>8.19.&nbsp;
9865    Database instrument directory information changed</h3>
9866    
9867    <p>Client may want to be notified when changes were made to directories
9868                    in the instruments database by issuing the following command:
9869    </p>
9870    <p>
9871                        </p>
9872    <blockquote class="text">
9873    <p>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
9874    </p>
9875    </blockquote><p>
9876                    
9877    </p>
9878    <p>Server will start sending the following notification messages:
9879    </p>
9880    <p>
9881                        </p>
9882    <blockquote class="text">
9883    <p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:&lt;dir-path&gt;"
9884    </p>
9885    </blockquote><p>
9886                    
9887    </p>
9888    <p>where &lt;dir-path&gt; will be replaced by the absolute path name
9889                    of the directory, for which information changes occurred. The front-end will have to send
9890                    the respective command to actually get the updated directory info. Because these messages
9891                    will be triggered by LSCP commands issued by other clients rather than real
9892                    time events happening on the server, it is believed that an empty notification
9893                    message is sufficient here.
9894    </p>
9895    <p>
9896                        </p>
9897    <blockquote class="text">
9898    <p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME &lt;old-dir-path&gt; &lt;new-name&gt;"
9899    </p>
9900    </blockquote><p>
9901                    
9902    </p>
9903    <p>where &lt;old-dir-path&gt; is the old absolute path name of the directory
9904                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
9905                    the new name of the directory, encapsulated into apostrophes.
9906    </p>
9907    <a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr />
9908    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9909    <a name="rfc.section.8.20"></a><h3>8.20.&nbsp;
9910    Number of database instruments changed</h3>
9911    
9912    <p>Client may want to be notified when the number of instruments
9913                    in a particular directory in the instruments database
9914                    is changed by issuing the following command:
9915    </p>
9916    <p>
9917                        </p>
9918    <blockquote class="text">
9919    <p>SUBSCRIBE DB_INSTRUMENT_COUNT
9920    </p>
9921    </blockquote><p>
9922                    
9923    </p>
9924    <p>Server will start sending the following notification messages:
9925    </p>
9926    <p>
9927                        </p>
9928    <blockquote class="text">
9929    <p>"NOTIFY:DB_INSTRUMENT_COUNT:&lt;dir-path&gt;"
9930    </p>
9931    </blockquote><p>
9932                    
9933    </p>
9934    <p>where &lt;dir-path&gt; will be replaced by the absolute path
9935                    name of the directory in the instruments database,
9936                    in which the number of instruments is changed.
9937    </p>
9938    <p>Note that when a non-empty directory is removed, this event
9939                    is not sent for the instruments in that directory.
9940    </p>
9941    <a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr />
9942    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9943    <a name="rfc.section.8.21"></a><h3>8.21.&nbsp;
9944    Database instrument information changed</h3>
9945    
9946    <p>Client may want to be notified when changes were made to instruments
9947                    in the instruments database by issuing the following command:
9948    </p>
9949    <p>
9950                        </p>
9951    <blockquote class="text">
9952    <p>SUBSCRIBE DB_INSTRUMENT_INFO
9953    </p>
9954    </blockquote><p>
9955                    
9956    </p>
9957    <p>Server will start sending the following notification messages:
9958    </p>
9959    <p>
9960                        </p>
9961    <blockquote class="text">
9962    <p>"NOTIFY:DB_INSTRUMENT_INFO:&lt;instr-path&gt;"
9963    </p>
9964    </blockquote><p>
9965                    
9966    </p>
9967    <p>where &lt;instr-path&gt; will be replaced by the absolute path name
9968                    of the instrument, which settings are changed. The front-end will have to send
9969                    the respective command to actually get the updated directory info. Because these messages
9970                    will be triggered by LSCP commands issued by other clients rather than real
9971                    time events happening on the server, it is believed that an empty notification
9972                    message is sufficient here.
9973    </p>
9974    <p>
9975                        </p>
9976    <blockquote class="text">
9977    <p>"NOTIFY:DB_INSTRUMENT_INFO:NAME &lt;old-instr-path&gt; &lt;new-name&gt;"
9978    </p>
9979    </blockquote><p>
9980                    
9981    </p>
9982    <p>where &lt;old-instr-path&gt; is the old absolute path name of the instrument
9983                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
9984                    the new name of the instrument, encapsulated into apostrophes.
9985    </p>
9986  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
9987  <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>
9988  <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;Miscellaneous and debugging events</h3>  <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;
9989    Miscellaneous and debugging events</h3>
9990    
9991  <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
9992                  the server by issuing the following command:                  the server by issuing the following command:
# Line 5905  Intellectual Property and Copyright Stat Line 10014  Intellectual Property and Copyright Stat
10014                  user AS IS to facilitate debugging.                  user AS IS to facilitate debugging.
10015  </p>  </p>
10016  <a name="anchor14"></a><br /><hr />  <a name="anchor14"></a><br /><hr />
10017  <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>
10018  <a name="rfc.section.9"></a><h3>9.&nbsp;Security Considerations</h3>  <a name="rfc.section.9"></a><h3>9.&nbsp;
10019    Security Considerations</h3>
10020    
10021  <p>As there is so far no method of authentication and authorization  <p>As there is so far no method of authentication and authorization
10022              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 10024  Intellectual Property and Copyright Stat
10024              system the LinuxSampler instance is running on.              system the LinuxSampler instance is running on.
10025  </p>  </p>
10026  <a name="anchor15"></a><br /><hr />  <a name="anchor15"></a><br /><hr />
10027  <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>
10028  <a name="rfc.section.10"></a><h3>10.&nbsp;Acknowledgments</h3>  <a name="rfc.section.10"></a><h3>10.&nbsp;
10029    Acknowledgments</h3>
10030    
10031  <p>This document has benefited greatly from the comments of the  <p>This document has benefited greatly from the comments of the
10032              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 10047  Intellectual Property and Copyright Stat
10047                            
10048  </p>  </p>
10049  <a name="rfc.references1"></a><br /><hr />  <a name="rfc.references1"></a><br /><hr />
10050  <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>
10051  <h3>11.&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
10052  <table width="99%" border="0">  <table width="99%" border="0">
10053  <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 10059  Intellectual Property and Copyright Stat
10059  </table>  </table>
10060    
10061  <a name="rfc.authors"></a><br /><hr />  <a name="rfc.authors"></a><br /><hr />
10062  <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>
10063  <h3>Author's Address</h3>  <h3>Author's Address</h3>
10064  <table width="99%" border="0" cellpadding="0" cellspacing="0">  <table width="99%" border="0" cellpadding="0" cellspacing="0">
10065  <tr><td class="author-text">&nbsp;</td>  <tr><td class="author-text">&nbsp;</td>
# Line 5966  Schoenebeck</td></tr> Line 10077  Schoenebeck</td></tr>
10077  <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>
10078  </table>  </table>
10079  <a name="rfc.copyright"></a><br /><hr />  <a name="rfc.copyright"></a><br /><hr />
10080  <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>
10081  <h3>Intellectual Property Statement</h3>  <h3>Full Copyright Statement</h3>
10082  <p class='copyright'>  <p class='copyright'>
10083  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>  
10084  <p class='copyright'>  <p class='copyright'>
10085  The IETF invites any interested party to bring to its  This document is subject to the rights,
10086  attention any copyrights, patents or patent applications, or  licenses and restrictions contained in BCP&nbsp;78,
10087  other proprietary rights which may cover technology that may be  and except as set forth therein,
10088  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>  
10089  <p class='copyright'>  <p class='copyright'>
10090  Copyright &copy; The Internet Society (2006). All Rights Reserved.</p>  This document and the information contained herein are provided
10091    on an &ldquo;AS IS&rdquo; basis and THE CONTRIBUTOR,
10092    THE ORGANIZATION HE/SHE REPRESENTS
10093    OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST
10094    AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES,
10095    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT
10096    THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY
10097    IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
10098    PURPOSE.</p>
10099    <h3>Intellectual Property</h3>
10100  <p class='copyright'>  <p class='copyright'>
10101  This document and translations of it may be copied and furnished to  The IETF takes no position regarding the validity or scope of any
10102  others, and derivative works that comment on or otherwise explain it  Intellectual Property Rights or other rights that might be claimed
10103  or assist in its implementation may be prepared, copied, published and  to pertain to the implementation or use of the technology
10104  distributed, in whole or in part, without restriction of any kind,  described in this document or the extent to which any license
10105  provided that the above copyright notice and this paragraph are  under such rights might or might not be available; nor does it
10106  included on all such copies and derivative works. However, this  represent that it has made any independent effort to identify any
10107  document itself may not be modified in any way, such as by removing  such rights.
10108  the copyright notice or references to the Internet Society or other  Information on the procedures with respect to
10109  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>  
10110  <p class='copyright'>  <p class='copyright'>
10111  The limited permissions granted above are perpetual and will not be  Copies of IPR disclosures made to the IETF Secretariat and any
10112  revoked by the Internet Society or its successors or assignees.</p>  assurances of licenses to be made available,
10113    or the result of an attempt made to obtain a general license or
10114    permission for the use of such proprietary rights by implementers or
10115    users of this specification can be obtained from the IETF on-line IPR
10116    repository at <a href='http://www.ietf.org/ipr'>http://www.ietf.org/ipr</a>.</p>
10117  <p class='copyright'>  <p class='copyright'>
10118  This document and the information contained herein is provided on an  The IETF invites any interested party to bring to its attention
10119  &ldquo;AS IS&rdquo; basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING  any copyrights,
10120  TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING  patents or patent applications,
10121  BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION  or other
10122  HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  proprietary rights that may cover technology that may be required
10123  MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.</p>  to implement this standard.
10124    Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p>
10125  <h3>Acknowledgment</h3>  <h3>Acknowledgment</h3>
10126  <p class='copyright'>  <p class='copyright'>
10127  Funding for the RFC Editor function is currently provided by the  Funding for the RFC Editor function is provided by
10128  Internet Society.</p>  the IETF Administrative Support Activity (IASA).</p>
10129  </body></html>  </body></html>
Legend:
Removed from v.940  
changed lines
  Added in v.1162
  ViewVC Help
Powered by ViewVC