/[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 708 by schoenebeck, Thu Jul 21 09:18:40 2005 UTC revision 974 by schoenebeck, Fri Dec 15 21:46:48 2006 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.29 (http://xml.resource.org/)">  <meta name="generator" content="xml2rfc v1.31 (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            a.info:hover {
62      span.emph { font-style: italic; }                  z-index: 25;
63      span.strong { font-weight: bold; }                  color: #FFF; background-color: #900;
64      span.verb, span.vbare { font-family: "Courier New", Courier, monospace ; }          }
65            a.info span { display: none; }
66      span.vemph { font-style: italic; font-family: "Courier New", Courier, monospace ; }          a.info:hover span.info {
67      span.vstrong { font-weight: bold; font-family: "Courier New", Courier, monospace ; }                  /* The span will display just on :hover state. */
68      span.vdeluxe { font-weight: bold; font-style: italic; font-family: "Courier New", Courier, monospace ; }                  display: block;
69                    position: absolute;
70      ol.text { margin-left: 2em; margin-right: 2em; }                  font-size: smaller;
71      ul.text { margin-left: 2em; margin-right: 2em; }                  top: 2em; left: -5em; width: 15em;
72      li { margin-left: 3em;  }                  padding: 2px; border: 1px solid #333;
73                    color: #900; background-color: #EEE;
74      pre { margin-left: 3em; color: #333333;  background-color: transparent;                  text-align: left;
75          font-family: "Courier New", Courier, monospace ; font-size: small ;          }
76          text-align: left;  
77          }          a { font-weight: bold; }
78            a:link    { color: #900; background-color: transparent; }
79      h3 { color: #333333; font-size: medium ;          a:visited { color: #633; background-color: transparent; }
80          font-family: helvetica, arial, sans-serif ;          a:active  { color: #633; background-color: transparent; }
81          background-color: transparent; }  
82      h4 { font-size: small; font-family: helvetica, arial, sans-serif ; }          p { margin-left: 2em; margin-right: 2em; }
83            p.copyright { font-size: x-small; }
84      table.bug { width: 30px ; height: 15px ; }          p.toc { font-size: small; font-weight: bold; margin-left: 3em; }
85      td.bug { color: #ffffff ; background-color: #990000 ;          table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; }
86          text-align: center ; width: 30px ; height: 15px ;          td.toc { font-size: small; font-weight: bold; vertical-align: text-top; }
87           }  
88      td.bug A.link2 { color: #ffffff ; font-weight: bold;          ol.text { margin-left: 2em; margin-right: 2em; }
89          text-decoration: none;          ul.text { margin-left: 2em; margin-right: 2em; }
90          font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;          li      { margin-left: 3em; }
91          font-size: x-small ; background-color: transparent }  
92            /* RFC-2629 <spanx>s and <artwork>s. */
93      td.header { color: #ffffff; font-size: x-small ;          em     { font-style: italic; }
94          font-family: arial, helvetica, sans-serif; vertical-align: top;          strong { font-weight: bold; }
95          background-color: #666666 ; width: 33% ; }          dfn    { font-weight: bold; font-style: normal; }
96      td.author { font-weight: bold; margin-left: 4em; font-size: x-small ; }          cite   { font-weight: normal; font-style: normal; }
97      td.author-text { font-size: x-small; }          tt     { color: #036; }
98      table.data { vertical-align: top ; border-collapse: collapse ;          tt, pre, pre dfn, pre em, pre cite, pre span {
99          border-style: solid solid solid solid ;                  font-family: "Courier New", Courier, monospace; font-size: small;
100          border-color: black black black black ;          }
101          font-size: small ; text-align: center ; }          pre {
102      table.data th { font-weight: bold ;                  text-align: left; padding: 4px;
103          border-style: solid solid solid solid ;                  color: #000; background-color: #CCC;
104          border-color: black black black black ; }          }
105      table.data td {          pre dfn  { color: #900; }
106          border-style: solid solid solid solid ;          pre em   { color: #66F; background-color: #FFC; font-weight: normal; }
107          border-color: #333333 #333333 #333333 #333333 ; }          pre .key { color: #33C; font-weight: bold; }
108            pre .id  { color: #900; }
109      hr { height: 1px }          pre .str { color: #000; background-color: #CFF; }
110  -->          pre .val { color: #066; }
111  </style>          pre .rep { color: #909; }
112            pre .oth { color: #000; background-color: #FCF; }
113            pre .err { background-color: #FCC; }
114    
115            /* RFC-2629 <texttable>s. */
116            table.full, table.headers, table.none {
117                    font-size: small; text-align: center; border-width: 2px;
118                    vertical-align: top; border-collapse: collapse;
119            }
120            table.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.full th { border-style: solid; }
127            table.headers th { border-style: none none solid none; }
128            table.none th { border-style: none; }
129            table.full td {
130                    border-style: solid; border-color: #333;
131                    border-width: 1px 2px;
132            }
133            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: November 2, 2005</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">May 2005</td></tr>  <tr><td class="header">Expires: June 18, 2007</td><td class="header">December 15, 2006</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 142  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 November 2, 2005.</p>  This Internet-Draft will expire on June 18, 2007.</p>
177    
178  <h3>Copyright Notice</h3>  <h3>Copyright Notice</h3>
179  <p>  <p>
180  Copyright &copy; The Internet Society (2005). All Rights Reserved.</p>  Copyright &copy; The Internet Society (2006).</p>
181    
182  <h3>Abstract</h3>  <h3>Abstract</h3>
183    
# Line 169  Introduction<br /> Line 200  Introduction<br />
200  Focus of this protocol<br />  Focus of this protocol<br />
201  <a href="#anchor4">5.</a>&nbsp;  <a href="#anchor4">5.</a>&nbsp;
202  Communication Overview<br />  Communication Overview<br />
203  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor5">5.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor5">5.1.</a>&nbsp;
204  Request/response communication method<br />  Request/response communication method<br />
205  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor6">5.1.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor6">5.1.1.</a>&nbsp;
206  Result format<br />  Result format<br />
207  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor7">5.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor7">5.2.</a>&nbsp;
208  Subscribe/notify communication method<br />  Subscribe/notify communication method<br />
209  <a href="#control_commands">6.</a>&nbsp;  <a href="#control_commands">6.</a>&nbsp;
210  Description for control commands<br />  Description for control commands<br />
211  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor8">6.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor8">6.1.</a>&nbsp;
212  Ignored lines and comments<br />  Ignored lines and comments<br />
213  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor9">6.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor9">6.2.</a>&nbsp;
214  Configuring audio drivers<br />  Configuring audio drivers<br />
215  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">6.2.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">6.2.1.</a>&nbsp;
216  Getting amount of available audio output drivers<br />  Getting amount of available audio output drivers<br />
217  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">6.2.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">6.2.2.</a>&nbsp;
218  Getting all available audio output drivers<br />  Getting all available audio output drivers<br />
219  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DRIVER INFO">6.2.3</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DRIVER INFO">6.2.3.</a>&nbsp;
220  Getting information about a specific audio  Getting information about a specific audio
221                  output driver<br />                  output driver<br />
222  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">6.2.4</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">6.2.4.</a>&nbsp;
223  Getting information about specific audio  Getting information about specific audio
224                  output driver parameter<br />                  output driver parameter<br />
225  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE AUDIO_OUTPUT_DEVICE">6.2.5</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE AUDIO_OUTPUT_DEVICE">6.2.5.</a>&nbsp;
226  Creating an audio output device<br />  Creating an audio output device<br />
227  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY AUDIO_OUTPUT_DEVICE">6.2.6</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY AUDIO_OUTPUT_DEVICE">6.2.6.</a>&nbsp;
228  Destroying an audio output device<br />  Destroying an audio output device<br />
229  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DEVICES">6.2.7</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DEVICES">6.2.7.</a>&nbsp;
230  Getting all created audio output device count<br />  Getting all created audio output device count<br />
231  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AUDIO_OUTPUT_DEVICES">6.2.8</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AUDIO_OUTPUT_DEVICES">6.2.8.</a>&nbsp;
232  Getting all created audio output device list<br />  Getting all created audio output device list<br />
233  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DEVICE INFO">6.2.9</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DEVICE INFO">6.2.9.</a>&nbsp;
234  Getting current settings of an audio output device<br />  Getting current settings of an audio output device<br />
235  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET AUDIO_OUTPUT_DEVICE_PARAMETER">6.2.10</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET AUDIO_OUTPUT_DEVICE_PARAMETER">6.2.10.</a>&nbsp;
236  Changing settings of audio output devices<br />  Changing settings of audio output devices<br />
237  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_CHANNEL INFO">6.2.11</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_CHANNEL INFO">6.2.11.</a>&nbsp;
238  Getting information about an audio channel<br />  Getting information about an audio channel<br />
239  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO">6.2.12</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO">6.2.12.</a>&nbsp;
240  Getting information about specific audio channel parameter<br />  Getting information about specific audio channel parameter<br />
241  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET AUDIO_OUTPUT_CHANNEL_PARAMETER">6.2.13</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET AUDIO_OUTPUT_CHANNEL_PARAMETER">6.2.13.</a>&nbsp;
242  Changing settings of audio output channels<br />  Changing settings of audio output channels<br />
243  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor10">6.3</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor10">6.3.</a>&nbsp;
244  Configuring MIDI input drivers<br />  Configuring MIDI input drivers<br />
245  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_MIDI_INPUT_DRIVERS">6.3.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_MIDI_INPUT_DRIVERS">6.3.1.</a>&nbsp;
246  Getting amount of available MIDI input drivers<br />  Getting amount of available MIDI input drivers<br />
247  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">6.3.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">6.3.2.</a>&nbsp;
248  Getting all available MIDI input drivers<br />  Getting all available MIDI input drivers<br />
249  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DRIVER INFO">6.3.3</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DRIVER INFO">6.3.3.</a>&nbsp;
250  Getting information about a specific MIDI input driver<br />  Getting information about a specific MIDI input driver<br />
251  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DRIVER_PARAMETER INFO">6.3.4</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DRIVER_PARAMETER INFO">6.3.4.</a>&nbsp;
252  Getting information about specific MIDI input driver parameter<br />  Getting information about specific MIDI input driver parameter<br />
253  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE MIDI_INPUT_DEVICE">6.3.5</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE MIDI_INPUT_DEVICE">6.3.5.</a>&nbsp;
254  Creating a MIDI input device<br />  Creating a MIDI input device<br />
255  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY MIDI_INPUT_DEVICE">6.3.6</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY MIDI_INPUT_DEVICE">6.3.6.</a>&nbsp;
256  Destroying a MIDI input device<br />  Destroying a MIDI input device<br />
257  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DEVICES">6.3.7</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DEVICES">6.3.7.</a>&nbsp;
258  Getting all created MIDI input device count<br />  Getting all created MIDI input device count<br />
259  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INPUT_DEVICES">6.3.8</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INPUT_DEVICES">6.3.8.</a>&nbsp;
260  Getting all created MIDI input device list<br />  Getting all created MIDI input device list<br />
261  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DEVICE INFO">6.3.9</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DEVICE INFO">6.3.9.</a>&nbsp;
262  Getting current settings of a MIDI input device<br />  Getting current settings of a MIDI input device<br />
263  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INPUT_DEVICE_PARAMETER">6.3.10</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INPUT_DEVICE_PARAMETER">6.3.10.</a>&nbsp;
264  Changing settings of MIDI input devices<br />  Changing settings of MIDI input devices<br />
265  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_PORT INFO">6.3.11</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_PORT INFO">6.3.11.</a>&nbsp;
266  Getting information about a MIDI port<br />  Getting information about a MIDI port<br />
267  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_PORT_PARAMETER INFO">6.3.12</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_PORT_PARAMETER INFO">6.3.12.</a>&nbsp;
268  Getting information about specific MIDI port parameter<br />  Getting information about specific MIDI port parameter<br />
269  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INPUT_PORT_PARAMETER">6.3.13</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INPUT_PORT_PARAMETER">6.3.13.</a>&nbsp;
270  Changing settings of MIDI input ports<br />  Changing settings of MIDI input ports<br />
271  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor11">6.4</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor11">6.4.</a>&nbsp;
272  Configuring sampler channels<br />  Configuring sampler channels<br />
273  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LOAD INSTRUMENT">6.4.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LOAD INSTRUMENT">6.4.1.</a>&nbsp;
274  Loading an instrument<br />  Loading an instrument<br />
275  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LOAD ENGINE">6.4.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LOAD ENGINE">6.4.2.</a>&nbsp;
276  Loading a sampler engine<br />  Loading a sampler engine<br />
277  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNELS">6.4.3</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNELS">6.4.3.</a>&nbsp;
278  Getting all created sampler channel count<br />  Getting all created sampler channel count<br />
279  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST CHANNELS">6.4.4</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST CHANNELS">6.4.4.</a>&nbsp;
280  Getting all created sampler channel list<br />  Getting all created sampler channel list<br />
281  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD CHANNEL">6.4.5</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD CHANNEL">6.4.5.</a>&nbsp;
282  Adding a new sampler channel<br />  Adding a new sampler channel<br />
283  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE CHANNEL">6.4.6</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE CHANNEL">6.4.6.</a>&nbsp;
284  Removing a sampler channel<br />  Removing a sampler channel<br />
285  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_ENGINES">6.4.7</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_ENGINES">6.4.7.</a>&nbsp;
286  Getting amount of available engines<br />  Getting amount of available engines<br />
287  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_ENGINES">6.4.8</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_ENGINES">6.4.8.</a>&nbsp;
288  Getting all available engines<br />  Getting all available engines<br />
289  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET ENGINE INFO">6.4.9</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET ENGINE INFO">6.4.9.</a>&nbsp;
290  Getting information about an engine<br />  Getting information about an engine<br />
291  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL INFO">6.4.10</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL INFO">6.4.10.</a>&nbsp;
292  Getting sampler channel information<br />  Getting sampler channel information<br />
293  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL VOICE_COUNT">6.4.11</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL VOICE_COUNT">6.4.11.</a>&nbsp;
294  Current number of active voices<br />  Current number of active voices<br />
295  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL STREAM_COUNT">6.4.12</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL STREAM_COUNT">6.4.12.</a>&nbsp;
296  Current number of active disk streams<br />  Current number of active disk streams<br />
297  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL BUFFER_FILL">6.4.13</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL BUFFER_FILL">6.4.13.</a>&nbsp;
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 />
305  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_DEVICE">6.4.17</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_DEVICE">6.4.17.</a>&nbsp;
306  Setting MIDI input device<br />  Setting MIDI input device<br />
307  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_TYPE">6.4.18</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_TYPE">6.4.18.</a>&nbsp;
308  Setting MIDI input type<br />  Setting MIDI input type<br />
309  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_PORT">6.4.19</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_PORT">6.4.19.</a>&nbsp;
310  Setting MIDI input port<br />  Setting MIDI input port<br />
311  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_CHANNEL">6.4.20</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_CHANNEL">6.4.20.</a>&nbsp;
312  Setting MIDI input channel<br />  Setting MIDI input channel<br />
313  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL VOLUME">6.4.21</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL VOLUME">6.4.21.</a>&nbsp;
314  Setting channel volume<br />  Setting channel volume<br />
315  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MUTE">6.4.22</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MUTE">6.4.22.</a>&nbsp;
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="#RESET CHANNEL">6.4.25.</a>&nbsp;
322  Resetting a sampler channel<br />  Resetting a sampler channel<br />
323  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;
324  Controlling connection<br />  Controlling connection<br />
325  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE">6.5.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE">6.5.1.</a>&nbsp;
326  Register front-end for receiving event messages<br />  Register front-end for receiving event messages<br />
327  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#UNSUBSCRIBE">6.5.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#UNSUBSCRIBE">6.5.2.</a>&nbsp;
328  Unregister front-end for not receiving event messages<br />  Unregister front-end for not receiving event messages<br />
329  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET ECHO">6.5.3</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET ECHO">6.5.3.</a>&nbsp;
330  Enable or disable echo of commands<br />  Enable or disable echo of commands<br />
331  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#QUIT">6.5.4</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#QUIT">6.5.4.</a>&nbsp;
332  Close client connection<br />  Close client connection<br />
333  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor13">6.6</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor13">6.6.</a>&nbsp;
334  Global commands<br />  Global commands<br />
335  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET">6.6.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET TOTAL_VOICE_COUNT">6.6.1.</a>&nbsp;
336    Current number of active voices<br />
337    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a>&nbsp;
338    Maximum amount of active voices<br />
339    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET">6.6.3.</a>&nbsp;
340  Reset sampler<br />  Reset sampler<br />
341  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.4.</a>&nbsp;
342  General sampler informations<br />  General sampler informations<br />
343    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#MIDI Instrument Mapping">6.7.</a>&nbsp;
344    MIDI Instrument Mapping<br />
345    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD MIDI_INSTRUMENT MAP">6.7.1.</a>&nbsp;
346    Create a new MIDI instrument map<br />
347    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a>&nbsp;
348    Delete one particular or all MIDI instrument maps<br />
349    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT_MAPS">6.7.3.</a>&nbsp;
350    Get amount of existing MIDI instrument maps<br />
351    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INSTRUMENT_MAPS">6.7.4.</a>&nbsp;
352    Getting all created MIDI instrument maps<br />
353    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT_MAP INFO">6.7.5.</a>&nbsp;
354    Getting MIDI instrument map information<br />
355    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INSTRUMENT_MAP NAME">6.7.6.</a>&nbsp;
356    Renaming a MIDI instrument map<br />
357    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MAP MIDI_INSTRUMENT">6.7.7.</a>&nbsp;
358    Create or replace a MIDI instrument map entry<br />
359    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENTS">6.7.8.</a>&nbsp;
360    Getting ammount of MIDI instrument map entries<br />
361    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INSTRUMENTS">6.7.9.</a>&nbsp;
362    Getting indeces of all entries of a MIDI instrument map<br />
363    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#UNMAP MIDI_INSTRUMENT">6.7.10.</a>&nbsp;
364    Remove an entry from the MIDI instrument map<br />
365    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT INFO">6.7.11.</a>&nbsp;
366    Get current settings of MIDI instrument map entry<br />
367    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CLEAR MIDI_INSTRUMENTS">6.7.12.</a>&nbsp;
368    Clear MIDI instrument map<br />
369  <a href="#command_syntax">7.</a>&nbsp;  <a href="#command_syntax">7.</a>&nbsp;
370  Command Syntax<br />  Command Syntax<br />
371  <a href="#events">8.</a>&nbsp;  <a href="#events">8.</a>&nbsp;
372  Events<br />  Events<br />
373  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL">8.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL">8.1.</a>&nbsp;
374  Number of sampler channels changed<br />  Number of sampler channels changed<br />
375  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.2.</a>&nbsp;
376  Number of active voices changed<br />  Number of active voices changed<br />
377  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">8.3</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">8.3.</a>&nbsp;
378  Number of active disk streams changed<br />  Number of active disk streams changed<br />
379  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">8.4</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">8.4.</a>&nbsp;
380  Disk stream buffer fill state changed<br />  Disk stream buffer fill state changed<br />
381  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE INFO">8.5</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE INFO">8.5.</a>&nbsp;
382  Channel information changed<br />  Channel information changed<br />
383  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.6</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.6.</a>&nbsp;
384    Total number of active voices changed<br />
385    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.7.</a>&nbsp;
386  Miscellaneous and debugging events<br />  Miscellaneous and debugging events<br />
387  <a href="#anchor14">9.</a>&nbsp;  <a href="#anchor14">9.</a>&nbsp;
388  Security Considerations<br />  Security Considerations<br />
# Line 333  Intellectual Property and Copyright Stat Line 398  Intellectual Property and Copyright Stat
398  <br clear="all" />  <br clear="all" />
399    
400  <a name="anchor1"></a><br /><hr />  <a name="anchor1"></a><br /><hr />
401  <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>
402  <a name="rfc.section.1"></a><h3>1.&nbsp;Requirements notation</h3>  <a name="rfc.section.1"></a><h3>1.&nbsp;
403    Requirements notation</h3>
404    
405  <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",  <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
406              "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",              "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
407              and "OPTIONAL" in this document are to be interpreted as              and "OPTIONAL" in this document are to be interpreted as
408              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>.
409  </p>  </p>
410  <p>This protocol is always case-sensitive if not explicitly  <p>This protocol is always case-sensitive if not explicitly
411              claimed the opposite.              claimed the opposite.
# Line 359  Intellectual Property and Copyright Stat Line 425  Intellectual Property and Copyright Stat
425  <p>&nbsp;&nbsp;&nbsp;"another line"  <p>&nbsp;&nbsp;&nbsp;"another line"
426  </p>  </p>
427  </blockquote><p>  </blockquote><p>
428                
429  </p>  </p>
430  <p>must actually be interpreted as client sending the following  <p>must actually be interpreted as client sending the following
431              message:              message:
# Line 371  Intellectual Property and Copyright Stat Line 437  Intellectual Property and Copyright Stat
437                      line&lt;CR&gt;&lt;LF&gt;"                      line&lt;CR&gt;&lt;LF&gt;"
438  </p>  </p>
439  </blockquote><p>  </blockquote><p>
440                
441  </p>  </p>
442  <p>where &lt;CR&gt; symbolizes the carriage return character and  <p>where &lt;CR&gt; symbolizes the carriage return character and
443              &lt;LF&gt; the line feed character as defined in the ASCII              &lt;LF&gt; the line feed character as defined in the ASCII
# Line 386  Intellectual Property and Copyright Stat Line 452  Intellectual Property and Copyright Stat
452  <p>S: "abcd"  <p>S: "abcd"
453  </p>  </p>
454  </blockquote><p>  </blockquote><p>
455                
456  </p>  </p>
457  <p>could also happen to be sent in three messages like in the  <p>could also happen to be sent in three messages like in the
458              following sequence scenario:              following sequence scenario:
# Line 409  Intellectual Property and Copyright Stat Line 475  Intellectual Property and Copyright Stat
475                      "&lt;LF&gt;"                      "&lt;LF&gt;"
476  </li>  </li>
477  </ul><p>  </ul><p>
478                
479  </p>  </p>
480  <p>where again &lt;CR&gt; and &lt;LF&gt; symbolize the carriage  <p>where again &lt;CR&gt; and &lt;LF&gt; symbolize the carriage
481              return and line feed characters respectively.              return and line feed characters respectively.
482  </p>  </p>
483  <a name="LSCP versioning"></a><br /><hr />  <a name="LSCP versioning"></a><br /><hr />
484  <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>
485  <a name="rfc.section.2"></a><h3>2.&nbsp;Versioning of this specification</h3>  <a name="rfc.section.2"></a><h3>2.&nbsp;
486    Versioning of this specification</h3>
487    
488  <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
489              release of the LSCP specification will be tagged with a unique version              release of the LSCP specification will be tagged with a unique version
490              tuple. The version tuple consists at least of a major and minor version              tuple. The version tuple consists at least of a major and minor version
491              number like:              number like:
492                
493  </p>  </p>
494  <p>  <p>
495                  </p>                  </p>
# Line 430  Intellectual Property and Copyright Stat Line 497  Intellectual Property and Copyright Stat
497  <p>"1.2"  <p>"1.2"
498  </p>  </p>
499  </blockquote><p>  </blockquote><p>
500                
501  </p>  </p>
502  <p>  <p>
503              In this example the major version number would be "1" and the minor              In this example the major version number would be "1" and the minor
# Line 440  Intellectual Property and Copyright Stat Line 507  Intellectual Property and Copyright Stat
507              compatible to the connected sampler if and only if the LSCP versions              compatible to the connected sampler if and only if the LSCP versions
508              to which each of the two parties complies to, match both of the              to which each of the two parties complies to, match both of the
509              following rules:              following rules:
510                
511  </p>  </p>
512  <p>Compatibility:  <p>Compatibility:
513  </p>  </p>
# Line 454  Intellectual Property and Copyright Stat Line 521  Intellectual Property and Copyright Stat
521                      the sampler's LSCP minor version.                      the sampler's LSCP minor version.
522  </li>  </li>
523  </ol><p>  </ol><p>
524                
525  </p>  </p>
526  <p>  <p>
527              Compatibility can only be claimed if both rules are true.              Compatibility can only be claimed if both rules are true.
528              The frontend can use the              The frontend can use the
529              <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
530              get the version of the LSCP specification the sampler complies with.              get the version of the LSCP specification the sampler complies with.
531                
532  </p>  </p>
533  <a name="anchor2"></a><br /><hr />  <a name="anchor2"></a><br /><hr />
534  <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>
535  <a name="rfc.section.3"></a><h3>3.&nbsp;Introduction</h3>  <a name="rfc.section.3"></a><h3>3.&nbsp;
536    Introduction</h3>
537    
538  <p>LinuxSampler is a so called software sampler application  <p>LinuxSampler is a so called software sampler application
539              capable to playback audio samples from a computer's Random              capable to playback audio samples from a computer's Random
# Line 485  Intellectual Property and Copyright Stat Line 553  Intellectual Property and Copyright Stat
553              there.              there.
554  </p>  </p>
555  <a name="anchor3"></a><br /><hr />  <a name="anchor3"></a><br /><hr />
556  <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>
557  <a name="rfc.section.4"></a><h3>4.&nbsp;Focus of this protocol</h3>  <a name="rfc.section.4"></a><h3>4.&nbsp;
558    Focus of this protocol</h3>
559    
560  <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
561              a running LinuxSampler instance and to retrieve information              a running LinuxSampler instance and to retrieve information
# Line 497  Intellectual Property and Copyright Stat Line 566  Intellectual Property and Copyright Stat
566              via MIDI System Exclusive Messages.              via MIDI System Exclusive Messages.
567  </p>  </p>
568  <a name="anchor4"></a><br /><hr />  <a name="anchor4"></a><br /><hr />
569  <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>
570  <a name="rfc.section.5"></a><h3>5.&nbsp;Communication Overview</h3>  <a name="rfc.section.5"></a><h3>5.&nbsp;
571    Communication Overview</h3>
572    
573  <p>There are two distinct methods of communication between a  <p>There are two distinct methods of communication between a
574              running instance of LinuxSampler and one or more control              running instance of LinuxSampler and one or more control
# Line 511  Intellectual Property and Copyright Stat Line 581  Intellectual Property and Copyright Stat
581              implemented in the front-end application. The two communication              implemented in the front-end application. The two communication
582              methods will be described next.              methods will be described next.
583  </p>  </p>
584  <a name="rfc.section.5.1"></a><h4><a name="anchor5">5.1</a>&nbsp;Request/response communication method</h4>  <a name="anchor5"></a><br /><hr />
585    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
586    <a name="rfc.section.5.1"></a><h3>5.1.&nbsp;
587    Request/response communication method</h3>
588    
589  <p>This simple communication method is based on  <p>This simple communication method is based on
590                  <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
591                  front-end application establishes a TCP connection to the                  front-end application establishes a TCP connection to the
592                  LinuxSampler instance on a certain host system. Then the                  LinuxSampler instance on a certain host system. Then the
593                  front-end application will send certain ASCII based commands                  front-end application will send certain ASCII based commands
# Line 554  Intellectual Property and Copyright Stat Line 627  Intellectual Property and Copyright Stat
627                  processed in the order they were received and result sets                  processed in the order they were received and result sets
628                  MUST be sent back in the same order.                  MUST be sent back in the same order.
629  </p>  </p>
630  <a name="rfc.section.5.1.1"></a><h4><a name="anchor6">5.1.1</a>&nbsp;Result format</h4>  <a name="anchor6"></a><br /><hr />
631    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
632    <a name="rfc.section.5.1.1"></a><h3>5.1.1.&nbsp;
633    Result format</h3>
634    
635  <p>Result set could be one of the following types:  <p>Result set could be one of the following types:
636  </p>  </p>
# Line 568  Intellectual Property and Copyright Stat Line 644  Intellectual Property and Copyright Stat
644  <li>Error  <li>Error
645  </li>  </li>
646  </ol><p>  </ol><p>
647                        
648  </p>  </p>
649  <p>Warning and Error result sets MUST be single line and  <p>Warning and Error result sets MUST be single line and
650                      have the following format:                      have the following format:
# Line 581  Intellectual Property and Copyright Stat Line 657  Intellectual Property and Copyright Stat
657  <li>"ERR:&lt;error-code&gt;:&lt;error-message&gt;"  <li>"ERR:&lt;error-code&gt;:&lt;error-message&gt;"
658  </li>  </li>
659  </ul><p>  </ul><p>
660                        
661  </p>  </p>
662  <p>Where &lt;warning-code&gt; and &lt;error-code&gt; are  <p>Where &lt;warning-code&gt; and &lt;error-code&gt; are
663                      numeric unique identifiers of the warning or error and                      numeric unique identifiers of the warning or error and
# Line 599  Intellectual Property and Copyright Stat Line 675  Intellectual Property and Copyright Stat
675  <p>S: "WRN:32:This is a 24 bit patch which is not supported natively yet."  <p>S: "WRN:32:This is a 24 bit patch which is not supported natively yet."
676  </p>  </p>
677  </blockquote><p>  </blockquote><p>
678                        
679  </p>  </p>
680  <p>  <p>
681                          </p>                          </p>
# Line 609  Intellectual Property and Copyright Stat Line 685  Intellectual Property and Copyright Stat
685  <p>S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter 'EAR'."  <p>S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter 'EAR'."
686  </p>  </p>
687  </blockquote><p>  </blockquote><p>
688                        
689  </p>  </p>
690  <p>  <p>
691                          </p>                          </p>
# Line 619  Intellectual Property and Copyright Stat Line 695  Intellectual Property and Copyright Stat
695  <p>S: "ERR:9:There is no audio output device with index 123456."  <p>S: "ERR:9:There is no audio output device with index 123456."
696  </p>  </p>
697  </blockquote><p>  </blockquote><p>
698                        
699  </p>  </p>
700  <p>Normal result sets could be:  <p>Normal result sets could be:
701  </p>  </p>
# Line 633  Intellectual Property and Copyright Stat Line 709  Intellectual Property and Copyright Stat
709  <li>Multi-line  <li>Multi-line
710  </li>  </li>
711  </ol><p>  </ol><p>
712                        
713  </p>  </p>
714  <p> Empty result set is issued when the server only  <p> Empty result set is issued when the server only
715                      needed to acknowledge the fact that the request was                      needed to acknowledge the fact that the request was
# Line 647  Intellectual Property and Copyright Stat Line 723  Intellectual Property and Copyright Stat
723  <p>"OK"  <p>"OK"
724  </p>  </p>
725  </blockquote><p>  </blockquote><p>
726                        
727  </p>  </p>
728  <p>Example:  <p>Example:
729  </p>  </p>
# Line 659  Intellectual Property and Copyright Stat Line 735  Intellectual Property and Copyright Stat
735  <p>S: "OK"  <p>S: "OK"
736  </p>  </p>
737  </blockquote><p>  </blockquote><p>
738                        
739  </p>  </p>
740  <p>Single line result sets are command specific. One  <p>Single line result sets are command specific. One
741                      example of a single line result set is an empty line.                      example of a single line result set is an empty line.
# Line 673  Intellectual Property and Copyright Stat Line 749  Intellectual Property and Copyright Stat
749  <p>"."  <p>"."
750  </p>  </p>
751  </blockquote><p>  </blockquote><p>
752                        
753  </p>  </p>
754  <p>Example:  <p>Example:
755  </p>  </p>
# Line 699  Intellectual Property and Copyright Stat Line 775  Intellectual Property and Copyright Stat
775  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
776  </p>  </p>
777  </blockquote><p>  </blockquote><p>
778                        
779  </p>  </p>
780  <p>In addition to above mentioned formats, warnings and  <p>In addition to above mentioned formats, warnings and
781                      empty result sets MAY be indexed. In this case, they                      empty result sets MAY be indexed. In this case, they
# Line 713  Intellectual Property and Copyright Stat Line 789  Intellectual Property and Copyright Stat
789  <li>"OK[&lt;index&gt;]"  <li>"OK[&lt;index&gt;]"
790  </li>  </li>
791  </ul><p>  </ul><p>
792                        
793  </p>  </p>
794  <p>where &lt;index&gt; is command specific and is used  <p>where &lt;index&gt; is command specific and is used
795                      to indicate channel number that the result set was                      to indicate channel number that the result set was
# Line 732  Intellectual Property and Copyright Stat Line 808  Intellectual Property and Copyright Stat
808  <p>S: "OK[12]"  <p>S: "OK[12]"
809  </p>  </p>
810  </blockquote><p>  </blockquote><p>
811                        
812  </p>  </p>
813  <p>  <p>
814                          </p>                          </p>
# Line 742  Intellectual Property and Copyright Stat Line 818  Intellectual Property and Copyright Stat
818  <p>S: "WRN[0]:32:Sample rate not supported, using 44100 instead."  <p>S: "WRN[0]:32:Sample rate not supported, using 44100 instead."
819  </p>  </p>
820  </blockquote><p>  </blockquote><p>
821                        
822  </p>  </p>
823  <a name="rfc.section.5.2"></a><h4><a name="anchor7">5.2</a>&nbsp;Subscribe/notify communication method</h4>  <a name="anchor7"></a><br /><hr />
824    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
825    <a name="rfc.section.5.2"></a><h3>5.2.&nbsp;
826    Subscribe/notify communication method</h3>
827    
828  <p>This more sophisticated communication method is actually  <p>This more sophisticated communication method is actually
829                  only an extension of the simple request/response                  only an extension of the simple request/response
# Line 762  Intellectual Property and Copyright Stat Line 841  Intellectual Property and Copyright Stat
841  <p>SUBSCRIBE &lt;event-id&gt;  <p>SUBSCRIBE &lt;event-id&gt;
842  </p>  </p>
843  </blockquote><p>  </blockquote><p>
844                    
845  </p>  </p>
846  <p>where &lt;event-id&gt; will be replaced by the respective  <p>where &lt;event-id&gt; will be replaced by the respective
847                  event that client wants to subscribe to. Upon receiving such                  event that client wants to subscribe to. Upon receiving such
# Line 779  Intellectual Property and Copyright Stat Line 858  Intellectual Property and Copyright Stat
858  <p>NOTIFY:&lt;event-id&gt;:&lt;custom-event-data&gt;  <p>NOTIFY:&lt;event-id&gt;:&lt;custom-event-data&gt;
859  </p>  </p>
860  </blockquote><p>  </blockquote><p>
861                    
862  </p>  </p>
863  <p>where &lt;event-id&gt; uniquely identifies the event that  <p>where &lt;event-id&gt; uniquely identifies the event that
864                  has occurred and &lt;custom-event-data&gt; is event                  has occurred and &lt;custom-event-data&gt; is event
# Line 805  Intellectual Property and Copyright Stat Line 884  Intellectual Property and Copyright Stat
884                          response.                          response.
885  </li>  </li>
886  </ol><p>  </ol><p>
887                    
888  </p>  </p>
889  <p>If the client is not interested in a particular event  <p>If the client is not interested in a particular event
890                  anymore it MAY issue UNSUBSCRIBE command using the following                  anymore it MAY issue UNSUBSCRIBE command using the following
# Line 817  Intellectual Property and Copyright Stat Line 896  Intellectual Property and Copyright Stat
896  <p>UNSUBSCRIBE &lt;event-id&gt;  <p>UNSUBSCRIBE &lt;event-id&gt;
897  </p>  </p>
898  </blockquote><p>  </blockquote><p>
899                    
900  </p>  </p>
901  <p>where &lt;event-id&gt; will be replace by the respective  <p>where &lt;event-id&gt; will be replace by the respective
902                  event that client is no longer interested in receiving. For                  event that client is no longer interested in receiving. For
903                  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>.
904  </p>  </p>
905  <p>Example: the fill states of disk stream buffers have  <p>Example: the fill states of disk stream buffers have
906                  changed on sampler channel 4 and the LinuxSampler instance                  changed on sampler channel 4 and the LinuxSampler instance
# Line 834  Intellectual Property and Copyright Stat Line 913  Intellectual Property and Copyright Stat
913  <p>NOTIFY:CHANNEL_BUFFER_FILL:4 [35]62%,[33]80%,[37]98%  <p>NOTIFY:CHANNEL_BUFFER_FILL:4 [35]62%,[33]80%,[37]98%
914  </p>  </p>
915  </blockquote><p>  </blockquote><p>
916                    
917  </p>  </p>
918  <p>Which means there are currently three active streams on  <p>Which means there are currently three active streams on
919                  sampler channel 4, where the stream with ID "35" is filled                  sampler channel 4, where the stream with ID "35" is filled
# Line 867  Intellectual Property and Copyright Stat Line 946  Intellectual Property and Copyright Stat
946                  it wants to receive.                  it wants to receive.
947  </p>  </p>
948  <a name="control_commands"></a><br /><hr />  <a name="control_commands"></a><br /><hr />
949  <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>
950  <a name="rfc.section.6"></a><h3>6.&nbsp;Description for control commands</h3>  <a name="rfc.section.6"></a><h3>6.&nbsp;
951    Description for control commands</h3>
952    
953  <p>This chapter will describe the available control commands  <p>This chapter will describe the available control commands
954              that can be sent on the TCP connection in detail. Some certain              that can be sent on the TCP connection in detail. Some certain
955              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>
956              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
957              multiple-line responses. In this case LinuxSampler signals the              multiple-line responses. In this case LinuxSampler signals the
958              end of the response by a "." (single dot) line.              end of the response by a "." (single dot) line.
959  </p>  </p>
960  <a name="rfc.section.6.1"></a><h4><a name="anchor8">6.1</a>&nbsp;Ignored lines and comments</h4>  <a name="anchor8"></a><br /><hr />
961    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
962    <a name="rfc.section.6.1"></a><h3>6.1.&nbsp;
963    Ignored lines and comments</h3>
964    
965  <p>White lines, that is lines which only contain space and  <p>White lines, that is lines which only contain space and
966                  tabulator characters, and lines that start with a "#"                  tabulator characters, and lines that start with a "#"
# Line 885  Intellectual Property and Copyright Stat Line 968  Intellectual Property and Copyright Stat
968                  group commands and to place comments in a LSCP script                  group commands and to place comments in a LSCP script
969                  file.                  file.
970  </p>  </p>
971  <a name="rfc.section.6.2"></a><h4><a name="anchor9">6.2</a>&nbsp;Configuring audio drivers</h4>  <a name="anchor9"></a><br /><hr />
972    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
973    <a name="rfc.section.6.2"></a><h3>6.2.&nbsp;
974    Configuring audio drivers</h3>
975    
976  <p>Instances of drivers in LinuxSampler are called devices.  <p>Instances of drivers in LinuxSampler are called devices.
977                  You can use multiple audio devices simultaneously, e.g. to                  You can use multiple audio devices simultaneously, e.g. to
# Line 918  Intellectual Property and Copyright Stat Line 1004  Intellectual Property and Copyright Stat
1004                  what parameters drivers are offering, how to retrieve their                  what parameters drivers are offering, how to retrieve their
1005                  possible values, etc.                  possible values, etc.
1006  </p>  </p>
1007  <a name="rfc.section.6.2.1"></a><h4><a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">6.2.1</a>&nbsp;Getting amount of available audio output drivers</h4>  <a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />
1008    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1009    <a name="rfc.section.6.2.1"></a><h3>6.2.1.&nbsp;
1010    Getting amount of available audio output drivers</h3>
1011    
1012  <p>Use the following command to get the number of  <p>Use the following command to get the number of
1013                      audio output drivers currently available for the                      audio output drivers currently available for the
# Line 930  Intellectual Property and Copyright Stat Line 1019  Intellectual Property and Copyright Stat
1019  <p>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS  <p>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS
1020  </p>  </p>
1021  </blockquote><p>  </blockquote><p>
1022                        
1023  </p>  </p>
1024  <p>Possible Answers:  <p>Possible Answers:
1025  </p>  </p>
# Line 941  Intellectual Property and Copyright Stat Line 1030  Intellectual Property and Copyright Stat
1030                              number of audio output drivers.                              number of audio output drivers.
1031  </p>  </p>
1032  </blockquote><p>  </blockquote><p>
1033                        
1034  </p>  </p>
1035  <p>Example:  <p>Example:
1036  </p>  </p>
# Line 953  Intellectual Property and Copyright Stat Line 1042  Intellectual Property and Copyright Stat
1042  <p>S: "2"  <p>S: "2"
1043  </p>  </p>
1044  </blockquote><p>  </blockquote><p>
1045                        
1046  </p>  </p>
1047  <a name="rfc.section.6.2.2"></a><h4><a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">6.2.2</a>&nbsp;Getting all available audio output drivers</h4>  <a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />
1048    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1049    <a name="rfc.section.6.2.2"></a><h3>6.2.2.&nbsp;
1050    Getting all available audio output drivers</h3>
1051    
1052  <p>Use the following command to list all audio output  <p>Use the following command to list all audio output
1053                      drivers currently available for the LinuxSampler                      drivers currently available for the LinuxSampler
# Line 967  Intellectual Property and Copyright Stat Line 1059  Intellectual Property and Copyright Stat
1059  <p>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS  <p>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS
1060  </p>  </p>
1061  </blockquote><p>  </blockquote><p>
1062                        
1063  </p>  </p>
1064  <p>Possible Answers:  <p>Possible Answers:
1065  </p>  </p>
# Line 979  Intellectual Property and Copyright Stat Line 1071  Intellectual Property and Copyright Stat
1071                              audio output driver.                              audio output driver.
1072  </p>  </p>
1073  </blockquote><p>  </blockquote><p>
1074                        
1075  </p>  </p>
1076  <p>Example:  <p>Example:
1077  </p>  </p>
# Line 991  Intellectual Property and Copyright Stat Line 1083  Intellectual Property and Copyright Stat
1083  <p>S: "ALSA,JACK"  <p>S: "ALSA,JACK"
1084  </p>  </p>
1085  </blockquote><p>  </blockquote><p>
1086                        
1087  </p>  </p>
1088  <a name="rfc.section.6.2.3"></a><h4><a name="GET AUDIO_OUTPUT_DRIVER INFO">6.2.3</a>&nbsp;Getting information about a specific audio  <a name="GET AUDIO_OUTPUT_DRIVER INFO"></a><br /><hr />
1089                  output driver</h4>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1090    <a name="rfc.section.6.2.3"></a><h3>6.2.3.&nbsp;
1091    Getting information about a specific audio
1092                    output driver</h3>
1093    
1094  <p>Use the following command to get detailed information  <p>Use the following command to get detailed information
1095                      about a specific audio output driver:                      about a specific audio output driver:
# Line 1006  Intellectual Property and Copyright Stat Line 1101  Intellectual Property and Copyright Stat
1101                               &lt;audio-output-driver&gt;                               &lt;audio-output-driver&gt;
1102  </p>  </p>
1103  </blockquote><p>  </blockquote><p>
1104                        
1105  </p>  </p>
1106  <p>Where &lt;audio-output-driver&gt; is the name of the  <p>Where &lt;audio-output-driver&gt; is the name of the
1107                      audio output driver, returned by the                      audio output driver, returned by the
1108                      <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.
1109  </p>  </p>
1110  <p>Possible Answers:  <p>Possible Answers:
1111  </p>  </p>
# Line 1035  Intellectual Property and Copyright Stat Line 1130  Intellectual Property and Copyright Stat
1130  <p> character string describing the  <p> character string describing the
1131                                        audio output driver                                        audio output driver
1132  </p>  </p>
1133  </blockquote><p>  </blockquote>
1134                                      
1135    
 </p>  
1136  <p>VERSION -  <p>VERSION -
1137                                      </p>                                      </p>
1138  <blockquote class="text">  <blockquote class="text">
1139  <p>character string reflecting the  <p>character string reflecting the
1140                                        driver's version                                        driver's version
1141  </p>  </p>
1142  </blockquote><p>  </blockquote>
1143                                      
1144    
 </p>  
1145  <p>PARAMETERS -  <p>PARAMETERS -
1146                                      </p>                                      </p>
1147  <blockquote class="text">  <blockquote class="text">
# Line 1057  Intellectual Property and Copyright Stat Line 1152  Intellectual Property and Copyright Stat
1152                                        and 'active' are offered by all audio                                        and 'active' are offered by all audio
1153                                        output drivers                                        output drivers
1154  </p>  </p>
1155  </blockquote><p>  </blockquote>
1156                                      
1157    
1158  </p>  </blockquote>
1159  </blockquote><p>                              
1160    
 </p>  
1161  <p>The mentioned fields above don't have to be  <p>The mentioned fields above don't have to be
1162                              in particular order.                              in particular order.
1163  </p>  </p>
1164  </blockquote><p>  </blockquote><p>
1165                        
1166  </p>  </p>
1167  <p>Example:  <p>Example:
1168  </p>  </p>
# Line 1088  Intellectual Property and Copyright Stat Line 1183  Intellectual Property and Copyright Stat
1183  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1184  </p>  </p>
1185  </blockquote><p>  </blockquote><p>
1186                        
1187  </p>  </p>
1188  <a name="rfc.section.6.2.4"></a><h4><a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">6.2.4</a>&nbsp;Getting information about specific audio  <a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"></a><br /><hr />
1189                  output driver parameter</h4>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1190    <a name="rfc.section.6.2.4"></a><h3>6.2.4.&nbsp;
1191    Getting information about specific audio
1192                    output driver parameter</h3>
1193    
1194  <p>Use the following command to get detailed information  <p>Use the following command to get detailed information
1195                      about a  specific audio output driver parameter:                      about a  specific audio output driver parameter:
# Line 1102  Intellectual Property and Copyright Stat Line 1200  Intellectual Property and Copyright Stat
1200  <p>GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO &lt;audio&gt; &lt;prm&gt; [&lt;deplist&gt;]  <p>GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO &lt;audio&gt; &lt;prm&gt; [&lt;deplist&gt;]
1201  </p>  </p>
1202  </blockquote><p>  </blockquote><p>
1203                        
1204  </p>  </p>
1205  <p>Where &lt;audio&gt; is the name of the audio output  <p>Where &lt;audio&gt; is the name of the audio output
1206                      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,
1207                      &lt;prm&gt; a specific parameter name for which information should be                      &lt;prm&gt; a specific parameter name for which information should be
1208                      obtained (as returned by the                      obtained (as returned by the
1209                      <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
1210                      &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
1211                      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
1212                      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 1134  Intellectual Property and Copyright Stat Line 1232  Intellectual Property and Copyright Stat
1232                              the moment the following information categories are defined:                              the moment the following information categories are defined:
1233  </p>  </p>
1234  </blockquote><p>  </blockquote><p>
1235                        
1236  </p>  </p>
1237  <p>  <p>
1238                          </p>                          </p>
# Line 1148  Intellectual Property and Copyright Stat Line 1246  Intellectual Property and Copyright Stat
1246                                  character string(s)                                  character string(s)
1247                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
1248  </p>  </p>
1249  </blockquote><p>  </blockquote>
1250                                
1251    
 </p>  
1252  <p>DESCRIPTION -  <p>DESCRIPTION -
1253                                </p>                                </p>
1254  <blockquote class="text">  <blockquote class="text">
1255  <p>arbitrary text describing the purpose of the parameter  <p>arbitrary text describing the purpose of the parameter
1256                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
1257  </p>  </p>
1258  </blockquote><p>  </blockquote>
1259                                
1260    
 </p>  
1261  <p>MANDATORY -  <p>MANDATORY -
1262                                </p>                                </p>
1263  <blockquote class="text">  <blockquote class="text">
1264  <p>either true or false, defines if this parameter must be  <p>either true or false, defines if this parameter must be
1265                                  given when the device is to be created with the                                  given when the device is to be created with the
1266                                  <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>
1267                                  command (always returned, no matter which driver parameter)                                  command (always returned, no matter which driver parameter)
1268  </p>  </p>
1269  </blockquote><p>  </blockquote>
1270                                
1271    
 </p>  
1272  <p>FIX -  <p>FIX -
1273                                </p>                                </p>
1274  <blockquote class="text">  <blockquote class="text">
1275  <p>either true or false, if false then this parameter can  <p>either true or false, if false then this parameter can
1276                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
1277                                  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>
1278                                  command (always returned, no matter which driver parameter)                                  command (always returned, no matter which driver parameter)
1279  </p>  </p>
1280  </blockquote><p>  </blockquote>
1281                                
1282    
 </p>  
1283  <p>MULTIPLICITY -  <p>MULTIPLICITY -
1284                                </p>                                </p>
1285  <blockquote class="text">  <blockquote class="text">
# Line 1190  Intellectual Property and Copyright Stat Line 1288  Intellectual Property and Copyright Stat
1288                                  multiple values and false only a single value allowed                                  multiple values and false only a single value allowed
1289                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
1290  </p>  </p>
1291  </blockquote><p>  </blockquote>
1292                                
1293    
 </p>  
1294  <p>DEPENDS -  <p>DEPENDS -
1295                                </p>                                </p>
1296  <blockquote class="text">  <blockquote class="text">
# Line 1207  Intellectual Property and Copyright Stat Line 1305  Intellectual Property and Copyright Stat
1305                                  chosen by the 'card' parameter                                  chosen by the 'card' parameter
1306                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
1307  </p>  </p>
1308  </blockquote><p>  </blockquote>
1309                                
1310    
 </p>  
1311  <p>DEFAULT -  <p>DEFAULT -
1312                                </p>                                </p>
1313  <blockquote class="text">  <blockquote class="text">
1314  <p>reflects the default value for this parameter which is  <p>reflects the default value for this parameter which is
1315                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
1316                                  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,
1317                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
1318                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
1319                                  apostrophes (')                                  apostrophes (')
1320                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
1321  </p>  </p>
1322  </blockquote><p>  </blockquote>
1323                                
1324    
 </p>  
1325  <p>RANGE_MIN -  <p>RANGE_MIN -
1326                                </p>                                </p>
1327  <blockquote class="text">  <blockquote class="text">
# Line 1233  Intellectual Property and Copyright Stat Line 1331  Intellectual Property and Copyright Stat
1331                                  with RANGE_MAX, but may also appear without                                  with RANGE_MAX, but may also appear without
1332                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
1333  </p>  </p>
1334  </blockquote><p>  </blockquote>
1335                                
1336    
 </p>  
1337  <p>RANGE_MAX -  <p>RANGE_MAX -
1338                                </p>                                </p>
1339  <blockquote class="text">  <blockquote class="text">
# Line 1245  Intellectual Property and Copyright Stat Line 1343  Intellectual Property and Copyright Stat
1343                                  RANGE_MIN, but may also appear without                                  RANGE_MIN, but may also appear without
1344                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
1345  </p>  </p>
1346  </blockquote><p>  </blockquote>
1347                                
1348    
 </p>  
1349  <p>POSSIBILITIES -  <p>POSSIBILITIES -
1350                                </p>                                </p>
1351  <blockquote class="text">  <blockquote class="text">
# Line 1256  Intellectual Property and Copyright Stat Line 1354  Intellectual Property and Copyright Stat
1354                                  apostrophes                                  apostrophes
1355                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
1356  </p>  </p>
1357  </blockquote><p>  </blockquote>
1358                                
1359    
 </p>  
1360  </blockquote><p>  </blockquote><p>
1361                        
1362  </p>  </p>
1363  <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.
1364  </p>  </p>
# Line 1288  Intellectual Property and Copyright Stat Line 1386  Intellectual Property and Copyright Stat
1386  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1387  </p>  </p>
1388  </blockquote><p>  </blockquote><p>
1389                        
1390  </p>  </p>
1391  <p>  <p>
1392                          </p>                          </p>
# Line 1312  Intellectual Property and Copyright Stat Line 1410  Intellectual Property and Copyright Stat
1410  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1411  </p>  </p>
1412  </blockquote><p>  </blockquote><p>
1413                        
1414  </p>  </p>
1415  <p>  <p>
1416                          </p>                          </p>
# Line 1340  Intellectual Property and Copyright Stat Line 1438  Intellectual Property and Copyright Stat
1438  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1439  </p>  </p>
1440  </blockquote><p>  </blockquote><p>
1441                        
1442  </p>  </p>
1443  <a name="rfc.section.6.2.5"></a><h4><a name="CREATE AUDIO_OUTPUT_DEVICE">6.2.5</a>&nbsp;Creating an audio output device</h4>  <a name="CREATE AUDIO_OUTPUT_DEVICE"></a><br /><hr />
1444    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1445    <a name="rfc.section.6.2.5"></a><h3>6.2.5.&nbsp;
1446    Creating an audio output device</h3>
1447    
1448  <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:
1449  </p>  </p>
# Line 1352  Intellectual Property and Copyright Stat Line 1453  Intellectual Property and Copyright Stat
1453  <p>CREATE AUDIO_OUTPUT_DEVICE &lt;audio-output-driver&gt; [&lt;param-list&gt;]  <p>CREATE AUDIO_OUTPUT_DEVICE &lt;audio-output-driver&gt; [&lt;param-list&gt;]
1454  </p>  </p>
1455  </blockquote><p>  </blockquote><p>
1456                        
1457  </p>  </p>
1458  <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
1459                      output system as returned by the                      output system as returned by the
1460                      <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>
1461                      command and &lt;param-list&gt; by an optional list of driver                      command and &lt;param-list&gt; by an optional list of driver
1462                      specific parameters in form of "key1=val1 key2=val2 ...", where                      specific parameters in form of "key1=val1 key2=val2 ...", where
1463                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
# Line 1375  Intellectual Property and Copyright Stat Line 1476  Intellectual Property and Copyright Stat
1476  <p>in case the device was successfully created, where  <p>in case the device was successfully created, where
1477                                      &lt;device-id&gt; is the numerical ID of the new device                                      &lt;device-id&gt; is the numerical ID of the new device
1478  </p>  </p>
1479  </blockquote><p>  </blockquote>
1480                                
1481    
 </p>  
1482  <p>"WRN[&lt;device-id&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN[&lt;device-id&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1483                                  </p>                                  </p>
1484  <blockquote class="text">  <blockquote class="text">
# Line 1388  Intellectual Property and Copyright Stat Line 1489  Intellectual Property and Copyright Stat
1489                                      fall-back values), providing an appropriate warning code and                                      fall-back values), providing an appropriate warning code and
1490                                      warning message                                      warning message
1491  </p>  </p>
1492  </blockquote><p>  </blockquote>
1493                                
1494    
 </p>  
1495  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1496                                  </p>                                  </p>
1497  <blockquote class="text">  <blockquote class="text">
1498  <p>in case it failed, providing an appropriate error code and error message  <p>in case it failed, providing an appropriate error code and error message
1499  </p>  </p>
1500  </blockquote><p>  </blockquote>
1501                                
1502    
 </p>  
1503  </blockquote><p>  </blockquote><p>
1504                        
1505  </p>  </p>
1506  <p>Examples:  <p>Examples:
1507  </p>  </p>
# Line 1412  Intellectual Property and Copyright Stat Line 1513  Intellectual Property and Copyright Stat
1513  <p>S: "OK[0]"  <p>S: "OK[0]"
1514  </p>  </p>
1515  </blockquote><p>  </blockquote><p>
1516                        
1517  </p>  </p>
1518  <p>  <p>
1519                          </p>                          </p>
# Line 1422  Intellectual Property and Copyright Stat Line 1523  Intellectual Property and Copyright Stat
1523  <p>S: "OK[1]"  <p>S: "OK[1]"
1524  </p>  </p>
1525  </blockquote><p>  </blockquote><p>
1526                        
1527  </p>  </p>
1528  <a name="rfc.section.6.2.6"></a><h4><a name="DESTROY AUDIO_OUTPUT_DEVICE">6.2.6</a>&nbsp;Destroying an audio output device</h4>  <a name="DESTROY AUDIO_OUTPUT_DEVICE"></a><br /><hr />
1529    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1530    <a name="rfc.section.6.2.6"></a><h3>6.2.6.&nbsp;
1531    Destroying an audio output device</h3>
1532    
1533  <p>Use the following command to destroy a created output device:  <p>Use the following command to destroy a created output device:
1534  </p>  </p>
# Line 1434  Intellectual Property and Copyright Stat Line 1538  Intellectual Property and Copyright Stat
1538  <p>DESTROY AUDIO_OUTPUT_DEVICE &lt;device-id&gt;  <p>DESTROY AUDIO_OUTPUT_DEVICE &lt;device-id&gt;
1539  </p>  </p>
1540  </blockquote><p>  </blockquote><p>
1541                        
1542  </p>  </p>
1543  <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
1544                      audio output device as given by the                      audio output device as given by the
1545                      <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>
1546                      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>
1547                      command.                      command.
1548  </p>  </p>
1549  <p>Possible Answers:  <p>Possible Answers:
# Line 1452  Intellectual Property and Copyright Stat Line 1556  Intellectual Property and Copyright Stat
1556  <blockquote class="text">  <blockquote class="text">
1557  <p>in case the device was successfully destroyed  <p>in case the device was successfully destroyed
1558  </p>  </p>
1559  </blockquote><p>  </blockquote>
1560                                
1561    
 </p>  
1562  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1563                                  </p>                                  </p>
1564  <blockquote class="text">  <blockquote class="text">
# Line 1464  Intellectual Property and Copyright Stat Line 1568  Intellectual Property and Copyright Stat
1568                                      informed about this situation), providing an appropriate                                      informed about this situation), providing an appropriate
1569                                      warning code and warning message                                      warning code and warning message
1570  </p>  </p>
1571  </blockquote><p>  </blockquote>
1572                                
1573    
 </p>  
1574  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1575                                  </p>                                  </p>
1576  <blockquote class="text">  <blockquote class="text">
1577  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
1578                                      error message                                      error message
1579  </p>  </p>
1580  </blockquote><p>  </blockquote>
1581                                
1582    
 </p>  
1583  </blockquote><p>  </blockquote><p>
1584                        
1585  </p>  </p>
1586  <p>Example:  <p>Example:
1587  </p>  </p>
# Line 1489  Intellectual Property and Copyright Stat Line 1593  Intellectual Property and Copyright Stat
1593  <p>S: "OK"  <p>S: "OK"
1594  </p>  </p>
1595  </blockquote><p>  </blockquote><p>
1596                        
1597  </p>  </p>
1598  <a name="rfc.section.6.2.7"></a><h4><a name="GET AUDIO_OUTPUT_DEVICES">6.2.7</a>&nbsp;Getting all created audio output device count</h4>  <a name="GET AUDIO_OUTPUT_DEVICES"></a><br /><hr />
1599    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1600    <a name="rfc.section.6.2.7"></a><h3>6.2.7.&nbsp;
1601    Getting all created audio output device count</h3>
1602    
1603  <p>Use the following command to count all created audio output devices:  <p>Use the following command to count all created audio output devices:
1604  </p>  </p>
# Line 1501  Intellectual Property and Copyright Stat Line 1608  Intellectual Property and Copyright Stat
1608  <p>GET AUDIO_OUTPUT_DEVICES  <p>GET AUDIO_OUTPUT_DEVICES
1609  </p>  </p>
1610  </blockquote><p>  </blockquote><p>
1611                        
1612  </p>  </p>
1613  <p>Possible Answers:  <p>Possible Answers:
1614  </p>  </p>
# Line 1512  Intellectual Property and Copyright Stat Line 1619  Intellectual Property and Copyright Stat
1619                              audio output devices.                              audio output devices.
1620  </p>  </p>
1621  </blockquote><p>  </blockquote><p>
1622                        
1623  </p>  </p>
1624  <p>Example:  <p>Example:
1625  </p>  </p>
# Line 1524  Intellectual Property and Copyright Stat Line 1631  Intellectual Property and Copyright Stat
1631  <p>S: "4"  <p>S: "4"
1632  </p>  </p>
1633  </blockquote><p>  </blockquote><p>
1634                        
1635  </p>  </p>
1636  <a name="rfc.section.6.2.8"></a><h4><a name="LIST AUDIO_OUTPUT_DEVICES">6.2.8</a>&nbsp;Getting all created audio output device list</h4>  <a name="LIST AUDIO_OUTPUT_DEVICES"></a><br /><hr />
1637    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1638    <a name="rfc.section.6.2.8"></a><h3>6.2.8.&nbsp;
1639    Getting all created audio output device list</h3>
1640    
1641  <p>Use the following command to list all created audio output devices:  <p>Use the following command to list all created audio output devices:
1642  </p>  </p>
# Line 1536  Intellectual Property and Copyright Stat Line 1646  Intellectual Property and Copyright Stat
1646  <p>LIST AUDIO_OUTPUT_DEVICES  <p>LIST AUDIO_OUTPUT_DEVICES
1647  </p>  </p>
1648  </blockquote><p>  </blockquote><p>
1649                        
1650  </p>  </p>
1651  <p>Possible Answers:  <p>Possible Answers:
1652  </p>  </p>
# Line 1547  Intellectual Property and Copyright Stat Line 1657  Intellectual Property and Copyright Stat
1657                              the numerical IDs of all audio output devices.                              the numerical IDs of all audio output devices.
1658  </p>  </p>
1659  </blockquote><p>  </blockquote><p>
1660                        
1661  </p>  </p>
1662  <p>Example:  <p>Example:
1663  </p>  </p>
# Line 1559  Intellectual Property and Copyright Stat Line 1669  Intellectual Property and Copyright Stat
1669  <p>S: "0,1,4,5"  <p>S: "0,1,4,5"
1670  </p>  </p>
1671  </blockquote><p>  </blockquote><p>
1672                        
1673  </p>  </p>
1674  <a name="rfc.section.6.2.9"></a><h4><a name="GET AUDIO_OUTPUT_DEVICE INFO">6.2.9</a>&nbsp;Getting current settings of an audio output device</h4>  <a name="GET AUDIO_OUTPUT_DEVICE INFO"></a><br /><hr />
1675    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1676    <a name="rfc.section.6.2.9"></a><h3>6.2.9.&nbsp;
1677    Getting current settings of an audio output device</h3>
1678    
1679  <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:
1680  </p>  </p>
# Line 1571  Intellectual Property and Copyright Stat Line 1684  Intellectual Property and Copyright Stat
1684  <p>GET AUDIO_OUTPUT_DEVICE INFO &lt;device-id&gt;  <p>GET AUDIO_OUTPUT_DEVICE INFO &lt;device-id&gt;
1685  </p>  </p>
1686  </blockquote><p>  </blockquote><p>
1687                        
1688  </p>  </p>
1689  <p>Where &lt;device-id&gt; should be replaced by numerical ID  <p>Where &lt;device-id&gt; should be replaced by numerical ID
1690                      of the audio output device as e.g. returned by the                      of the audio output device as e.g. returned by the
1691                      <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.
1692  </p>  </p>
1693  <p>Possible Answers:  <p>Possible Answers:
1694  </p>  </p>
# Line 1595  Intellectual Property and Copyright Stat Line 1708  Intellectual Property and Copyright Stat
1708  <blockquote class="text">  <blockquote class="text">
1709  <p>identifier of the used audio output driver, as also  <p>identifier of the used audio output driver, as also
1710                                      returned by the                                      returned by the
1711                                      <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>
1712                                      command                                      command
1713  </p>  </p>
1714  </blockquote><p>  </blockquote>
1715                                
1716    
 </p>  
1717  <p>CHANNELS -  <p>CHANNELS -
1718                                  </p>                                  </p>
1719  <blockquote class="text">  <blockquote class="text">
1720  <p>amount of audio output channels this device currently  <p>amount of audio output channels this device currently
1721                                      offers                                      offers
1722  </p>  </p>
1723  </blockquote><p>  </blockquote>
1724                                
1725    
 </p>  
1726  <p>SAMPLERATE -  <p>SAMPLERATE -
1727                                  </p>                                  </p>
1728  <blockquote class="text">  <blockquote class="text">
1729  <p>playback sample rate the device uses  <p>playback sample rate the device uses
1730  </p>  </p>
1731  </blockquote><p>  </blockquote>
1732                                
1733    
 </p>  
1734  <p>ACTIVE -  <p>ACTIVE -
1735                                  </p>                                  </p>
1736  <blockquote class="text">  <blockquote class="text">
# Line 1626  Intellectual Property and Copyright Stat Line 1739  Intellectual Property and Copyright Stat
1739                                      sampler channels connected to this audio device render                                      sampler channels connected to this audio device render
1740                                      any audio                                      any audio
1741  </p>  </p>
1742  </blockquote><p>  </blockquote>
1743                                
1744    
 </p>  
1745  </blockquote><p>  </blockquote><p>
1746                        
1747  </p>  </p>
1748  <p>The mentioned fields above don't have to be in particular  <p>The mentioned fields above don't have to be in particular
1749                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
1750                      returned by all audio output devices. Every audio output driver                      returned by all audio output devices. Every audio output driver
1751                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
1752                      <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>)
1753                      which are also returned by this command.                      which are also returned by this command.
1754  </p>  </p>
1755  <p>Example:  <p>Example:
# Line 1663  Intellectual Property and Copyright Stat Line 1776  Intellectual Property and Copyright Stat
1776  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1777  </p>  </p>
1778  </blockquote><p>  </blockquote><p>
1779                        
1780  </p>  </p>
1781  <a name="rfc.section.6.2.10"></a><h4><a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER">6.2.10</a>&nbsp;Changing settings of audio output devices</h4>  <a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER"></a><br /><hr />
1782    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1783    <a name="rfc.section.6.2.10"></a><h3>6.2.10.&nbsp;
1784    Changing settings of audio output devices</h3>
1785    
1786  <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:
1787  </p>  </p>
# Line 1675  Intellectual Property and Copyright Stat Line 1791  Intellectual Property and Copyright Stat
1791  <p>SET AUDIO_OUTPUT_DEVICE_PARAMETER &lt;device-id&gt; &lt;key&gt;=&lt;value&gt;  <p>SET AUDIO_OUTPUT_DEVICE_PARAMETER &lt;device-id&gt; &lt;key&gt;=&lt;value&gt;
1792  </p>  </p>
1793  </blockquote><p>  </blockquote><p>
1794                        
1795  </p>  </p>
1796  <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
1797                      audio output device as given by the                      audio output device as given by the
1798                      <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>
1799                      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>
1800                      command, &lt;key&gt; by the name of the parameter to change                      command, &lt;key&gt; by the name of the parameter to change
1801                      and &lt;value&gt; by the new value for this parameter.                      and &lt;value&gt; by the new value for this parameter.
1802  </p>  </p>
# Line 1694  Intellectual Property and Copyright Stat Line 1810  Intellectual Property and Copyright Stat
1810  <blockquote class="text">  <blockquote class="text">
1811  <p>in case setting was successfully changed  <p>in case setting was successfully changed
1812  </p>  </p>
1813  </blockquote><p>  </blockquote>
1814                                
1815    
 </p>  
1816  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1817                                  </p>                                  </p>
1818  <blockquote class="text">  <blockquote class="text">
# Line 1704  Intellectual Property and Copyright Stat Line 1820  Intellectual Property and Copyright Stat
1820                                      noteworthy issue(s) related, providing an appropriate                                      noteworthy issue(s) related, providing an appropriate
1821                                      warning code and warning message                                      warning code and warning message
1822  </p>  </p>
1823  </blockquote><p>  </blockquote>
1824                                
1825    
 </p>  
1826  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1827                                  </p>                                  </p>
1828  <blockquote class="text">  <blockquote class="text">
1829  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
1830                                      error message                                      error message
1831  </p>  </p>
1832  </blockquote><p>  </blockquote>
1833                                
1834    
 </p>  
1835  </blockquote><p>  </blockquote><p>
1836                        
1837  </p>  </p>
1838  <p>Example:  <p>Example:
1839  </p>  </p>
# Line 1729  Intellectual Property and Copyright Stat Line 1845  Intellectual Property and Copyright Stat
1845  <p>S: "OK"  <p>S: "OK"
1846  </p>  </p>
1847  </blockquote><p>  </blockquote><p>
1848                        
1849  </p>  </p>
1850  <a name="rfc.section.6.2.11"></a><h4><a name="GET AUDIO_OUTPUT_CHANNEL INFO">6.2.11</a>&nbsp;Getting information about an audio channel</h4>  <a name="GET AUDIO_OUTPUT_CHANNEL INFO"></a><br /><hr />
1851    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1852    <a name="rfc.section.6.2.11"></a><h3>6.2.11.&nbsp;
1853    Getting information about an audio channel</h3>
1854    
1855  <p>Use the following command to get information about an audio channel:  <p>Use the following command to get information about an audio channel:
1856  </p>  </p>
# Line 1741  Intellectual Property and Copyright Stat Line 1860  Intellectual Property and Copyright Stat
1860  <p>GET AUDIO_OUTPUT_CHANNEL INFO &lt;device-id&gt; &lt;audio-chan&gt;  <p>GET AUDIO_OUTPUT_CHANNEL INFO &lt;device-id&gt; &lt;audio-chan&gt;
1861  </p>  </p>
1862  </blockquote><p>  </blockquote><p>
1863                        
1864  </p>  </p>
1865  <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
1866                      <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>
1867                      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>
1868                      command and &lt;audio-chan&gt; the audio channel number.                      command and &lt;audio-chan&gt; the audio channel number.
1869  </p>  </p>
1870  <p>Possible Answers:  <p>Possible Answers:
# Line 1768  Intellectual Property and Copyright Stat Line 1887  Intellectual Property and Copyright Stat
1887  <p>arbitrary character string naming the channel, which  <p>arbitrary character string naming the channel, which
1888                                              doesn't have to be unique (always returned by all audio channels)                                              doesn't have to be unique (always returned by all audio channels)
1889  </p>  </p>
1890  </blockquote><p>  </blockquote>
1891                                        
1892    
 </p>  
1893  <p>IS_MIX_CHANNEL -  <p>IS_MIX_CHANNEL -
1894                                          </p>                                          </p>
1895  <blockquote class="text">  <blockquote class="text">
# Line 1781  Intellectual Property and Copyright Stat Line 1900  Intellectual Property and Copyright Stat
1900                                              channels than the used audio system might be able to offer                                              channels than the used audio system might be able to offer
1901                                              (always returned by all audio channels)                                              (always returned by all audio channels)
1902  </p>  </p>
1903  </blockquote><p>  </blockquote>
1904                                        
1905    
 </p>  
1906  <p>MIX_CHANNEL_DESTINATION -  <p>MIX_CHANNEL_DESTINATION -
1907                                          </p>                                          </p>
1908  <blockquote class="text">  <blockquote class="text">
# Line 1793  Intellectual Property and Copyright Stat Line 1912  Intellectual Property and Copyright Stat
1912                                              the audio signal actually will be routed / added to                                              the audio signal actually will be routed / added to
1913                                              (only returned in case the audio channel is mix channel)                                              (only returned in case the audio channel is mix channel)
1914  </p>  </p>
1915  </blockquote><p>  </blockquote>
1916                                        
1917    
1918  </p>  </blockquote>
1919  </blockquote><p>                              
1920    
 </p>  
1921  </blockquote><p>  </blockquote><p>
1922                        
1923  </p>  </p>
1924  <p>The mentioned fields above don't have to be in particular  <p>The mentioned fields above don't have to be in particular
1925                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
# Line 1823  Intellectual Property and Copyright Stat Line 1942  Intellectual Property and Copyright Stat
1942  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1943  </p>  </p>
1944  </blockquote><p>  </blockquote><p>
1945                        
1946  </p>  </p>
1947  <p>  <p>
1948                          </p>                          </p>
# Line 1837  Intellectual Property and Copyright Stat Line 1956  Intellectual Property and Copyright Stat
1956  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1957  </p>  </p>
1958  </blockquote><p>  </blockquote><p>
1959                        
1960  </p>  </p>
1961  <p>  <p>
1962                          </p>                          </p>
# Line 1853  Intellectual Property and Copyright Stat Line 1972  Intellectual Property and Copyright Stat
1972  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1973  </p>  </p>
1974  </blockquote><p>  </blockquote><p>
1975                        
1976  </p>  </p>
1977  <p>  <p>
1978                          </p>                          </p>
# Line 1869  Intellectual Property and Copyright Stat Line 1988  Intellectual Property and Copyright Stat
1988  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1989  </p>  </p>
1990  </blockquote><p>  </blockquote><p>
1991                        
1992  </p>  </p>
1993  <a name="rfc.section.6.2.12"></a><h4><a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO">6.2.12</a>&nbsp;Getting information about specific audio channel parameter</h4>  <a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"></a><br /><hr />
1994    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1995    <a name="rfc.section.6.2.12"></a><h3>6.2.12.&nbsp;
1996    Getting information about specific audio channel parameter</h3>
1997    
1998  <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:
1999  </p>  </p>
# Line 1881  Intellectual Property and Copyright Stat Line 2003  Intellectual Property and Copyright Stat
2003  <p>GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO &lt;dev-id&gt; &lt;chan&gt; &lt;param&gt;  <p>GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO &lt;dev-id&gt; &lt;chan&gt; &lt;param&gt;
2004  </p>  </p>
2005  </blockquote><p>  </blockquote><p>
2006                        
2007  </p>  </p>
2008  <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
2009                      <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>
2010                      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>
2011                      command, &lt;chan&gt; the audio channel number                      command, &lt;chan&gt; the audio channel number
2012                      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
2013                      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).
2014  </p>  </p>
2015  <p>Possible Answers:  <p>Possible Answers:
2016  </p>  </p>
# Line 1915  Intellectual Property and Copyright Stat Line 2037  Intellectual Property and Copyright Stat
2037                                              character string(s)                                              character string(s)
2038                                              (always returned)                                              (always returned)
2039  </p>  </p>
2040  </blockquote><p>  </blockquote>
2041                                        
2042    
 </p>  
2043  <p>DESCRIPTION -  <p>DESCRIPTION -
2044                                          </p>                                          </p>
2045  <blockquote class="text">  <blockquote class="text">
2046  <p>arbitrary text describing the purpose of the parameter (always returned)  <p>arbitrary text describing the purpose of the parameter (always returned)
2047  </p>  </p>
2048  </blockquote><p>  </blockquote>
2049                                        
2050    
 </p>  
2051  <p>FIX -  <p>FIX -
2052                                          </p>                                          </p>
2053  <blockquote class="text">  <blockquote class="text">
# Line 1933  Intellectual Property and Copyright Stat Line 2055  Intellectual Property and Copyright Stat
2055                                              read only, thus cannot be altered                                              read only, thus cannot be altered
2056                                              (always returned)                                              (always returned)
2057  </p>  </p>
2058  </blockquote><p>  </blockquote>
2059                                        
2060    
 </p>  
2061  <p>MULTIPLICITY -  <p>MULTIPLICITY -
2062                                          </p>                                          </p>
2063  <blockquote class="text">  <blockquote class="text">
# Line 1944  Intellectual Property and Copyright Stat Line 2066  Intellectual Property and Copyright Stat
2066                                              multiple values and false only a single value allowed                                              multiple values and false only a single value allowed
2067                                              (always returned)                                              (always returned)
2068  </p>  </p>
2069  </blockquote><p>  </blockquote>
2070                                        
2071    
 </p>  
2072  <p>RANGE_MIN -  <p>RANGE_MIN -
2073                                          </p>                                          </p>
2074  <blockquote class="text">  <blockquote class="text">
# Line 1957  Intellectual Property and Copyright Stat Line 2079  Intellectual Property and Copyright Stat
2079                                              (optionally returned, dependent to driver and channel                                              (optionally returned, dependent to driver and channel
2080                                              parameter)                                              parameter)
2081  </p>  </p>
2082  </blockquote><p>  </blockquote>
2083                                        
2084    
 </p>  
2085  <p>RANGE_MAX -  <p>RANGE_MAX -
2086                                          </p>                                          </p>
2087  <blockquote class="text">  <blockquote class="text">
# Line 1970  Intellectual Property and Copyright Stat Line 2092  Intellectual Property and Copyright Stat
2092                                              (optionally returned, dependent to driver and channel                                              (optionally returned, dependent to driver and channel
2093                                              parameter)                                              parameter)
2094  </p>  </p>
2095  </blockquote><p>  </blockquote>
2096                                        
2097    
 </p>  
2098  <p>POSSIBILITIES -  <p>POSSIBILITIES -
2099                                          </p>                                          </p>
2100  <blockquote class="text">  <blockquote class="text">
# Line 1982  Intellectual Property and Copyright Stat Line 2104  Intellectual Property and Copyright Stat
2104                                              (optionally returned, dependent to driver and channel                                              (optionally returned, dependent to driver and channel
2105                                              parameter)                                              parameter)
2106  </p>  </p>
2107  </blockquote><p>  </blockquote>
2108                                        
2109    
2110  </p>  </blockquote>
2111  </blockquote><p>                              
2112    
 </p>  
2113  <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.
2114  </p>  </p>
2115  </blockquote><p>  </blockquote><p>
2116                        
2117  </p>  </p>
2118  <p>Example:  <p>Example:
2119  </p>  </p>
# Line 2013  Intellectual Property and Copyright Stat Line 2135  Intellectual Property and Copyright Stat
2135  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
2136  </p>  </p>
2137  </blockquote><p>  </blockquote><p>
2138                        
2139  </p>  </p>
2140  <a name="rfc.section.6.2.13"></a><h4><a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER">6.2.13</a>&nbsp;Changing settings of audio output channels</h4>  <a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"></a><br /><hr />
2141    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2142    <a name="rfc.section.6.2.13"></a><h3>6.2.13.&nbsp;
2143    Changing settings of audio output channels</h3>
2144    
2145  <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:
2146  </p>  </p>
# Line 2025  Intellectual Property and Copyright Stat Line 2150  Intellectual Property and Copyright Stat
2150  <p>SET AUDIO_OUTPUT_CHANNEL_PARAMETER &lt;dev-id&gt; &lt;chn&gt; &lt;key&gt;=&lt;value&gt;  <p>SET AUDIO_OUTPUT_CHANNEL_PARAMETER &lt;dev-id&gt; &lt;chn&gt; &lt;key&gt;=&lt;value&gt;
2151  </p>  </p>
2152  </blockquote><p>  </blockquote><p>
2153                        
2154  </p>  </p>
2155  <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
2156                      <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>
2157                      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>
2158                      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
2159                      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.
2160  </p>  </p>
# Line 2043  Intellectual Property and Copyright Stat Line 2168  Intellectual Property and Copyright Stat
2168  <blockquote class="text">  <blockquote class="text">
2169  <p>in case setting was successfully changed  <p>in case setting was successfully changed
2170  </p>  </p>
2171  </blockquote><p>  </blockquote>
2172                                
2173    
 </p>  
2174  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2175                                  </p>                                  </p>
2176  <blockquote class="text">  <blockquote class="text">
# Line 2053  Intellectual Property and Copyright Stat Line 2178  Intellectual Property and Copyright Stat
2178                                     noteworthy issue(s) related, providing an appropriate                                     noteworthy issue(s) related, providing an appropriate
2179                                     warning code and warning message                                     warning code and warning message
2180  </p>  </p>
2181  </blockquote><p>  </blockquote>
2182                                
2183    
 </p>  
2184  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2185                                  </p>                                  </p>
2186  <blockquote class="text">  <blockquote class="text">
2187  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
2188                                     error message                                     error message
2189  </p>  </p>
2190  </blockquote><p>  </blockquote>
2191                                
2192    
 </p>  
2193  </blockquote><p>  </blockquote><p>
2194                        
2195  </p>  </p>
2196  <p>Example:  <p>Example:
2197  </p>  </p>
# Line 2078  Intellectual Property and Copyright Stat Line 2203  Intellectual Property and Copyright Stat
2203  <p>S: "OK"  <p>S: "OK"
2204  </p>  </p>
2205  </blockquote><p>  </blockquote><p>
2206                        
2207  </p>  </p>
2208  <p>  <p>
2209                          </p>                          </p>
# Line 2088  Intellectual Property and Copyright Stat Line 2213  Intellectual Property and Copyright Stat
2213  <p>S: "OK"  <p>S: "OK"
2214  </p>  </p>
2215  </blockquote><p>  </blockquote><p>
2216                        
2217  </p>  </p>
2218  <a name="rfc.section.6.3"></a><h4><a name="anchor10">6.3</a>&nbsp;Configuring MIDI input drivers</h4>  <a name="anchor10"></a><br /><hr />
2219    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2220    <a name="rfc.section.6.3"></a><h3>6.3.&nbsp;
2221    Configuring MIDI input drivers</h3>
2222    
2223  <p>Instances of drivers in LinuxSampler are called devices. You can use  <p>Instances of drivers in LinuxSampler are called devices. You can use
2224                  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 2118  Intellectual Property and Copyright Stat Line 2246  Intellectual Property and Copyright Stat
2246                  showing how to retrieve what parameters drivers are offering, how to retrieve their                  showing how to retrieve what parameters drivers are offering, how to retrieve their
2247                  possible values, etc.                  possible values, etc.
2248  </p>  </p>
2249  <a name="rfc.section.6.3.1"></a><h4><a name="GET AVAILABLE_MIDI_INPUT_DRIVERS">6.3.1</a>&nbsp;Getting amount of available MIDI input drivers</h4>  <a name="GET AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />
2250    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2251    <a name="rfc.section.6.3.1"></a><h3>6.3.1.&nbsp;
2252    Getting amount of available MIDI input drivers</h3>
2253    
2254  <p>Use the following command to get the number of  <p>Use the following command to get the number of
2255                      MIDI input drivers currently available for the                      MIDI input drivers currently available for the
# Line 2130  Intellectual Property and Copyright Stat Line 2261  Intellectual Property and Copyright Stat
2261  <p>GET AVAILABLE_MIDI_INPUT_DRIVERS  <p>GET AVAILABLE_MIDI_INPUT_DRIVERS
2262  </p>  </p>
2263  </blockquote><p>  </blockquote><p>
2264                        
2265  </p>  </p>
2266  <p>Possible Answers:  <p>Possible Answers:
2267  </p>  </p>
# Line 2141  Intellectual Property and Copyright Stat Line 2272  Intellectual Property and Copyright Stat
2272                              number of available MIDI input drivers.                              number of available MIDI input drivers.
2273  </p>  </p>
2274  </blockquote><p>  </blockquote><p>
2275                        
2276  </p>  </p>
2277  <p>Example:  <p>Example:
2278  </p>  </p>
# Line 2153  Intellectual Property and Copyright Stat Line 2284  Intellectual Property and Copyright Stat
2284  <p>S: "2"  <p>S: "2"
2285  </p>  </p>
2286  </blockquote><p>  </blockquote><p>
2287                        
2288  </p>  </p>
2289  <a name="rfc.section.6.3.2"></a><h4><a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS">6.3.2</a>&nbsp;Getting all available MIDI input drivers</h4>  <a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />
2290    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2291    <a name="rfc.section.6.3.2"></a><h3>6.3.2.&nbsp;
2292    Getting all available MIDI input drivers</h3>
2293    
2294  <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
2295                      for the LinuxSampler instance:                      for the LinuxSampler instance:
# Line 2166  Intellectual Property and Copyright Stat Line 2300  Intellectual Property and Copyright Stat
2300  <p>LIST AVAILABLE_MIDI_INPUT_DRIVERS  <p>LIST AVAILABLE_MIDI_INPUT_DRIVERS
2301  </p>  </p>
2302  </blockquote><p>  </blockquote><p>
2303                        
2304  </p>  </p>
2305  <p>Possible Answers:  <p>Possible Answers:
2306  </p>  </p>
# Line 2177  Intellectual Property and Copyright Stat Line 2311  Intellectual Property and Copyright Stat
2311                              strings, each symbolizing a MIDI input driver.                              strings, each symbolizing a MIDI input driver.
2312  </p>  </p>
2313  </blockquote><p>  </blockquote><p>
2314                        
2315  </p>  </p>
2316  <p>Example:  <p>Example:
2317  </p>  </p>
# Line 2189  Intellectual Property and Copyright Stat Line 2323  Intellectual Property and Copyright Stat
2323  <p>S: "ALSA,JACK"  <p>S: "ALSA,JACK"
2324  </p>  </p>
2325  </blockquote><p>  </blockquote><p>
2326                        
2327  </p>  </p>
2328  <a name="rfc.section.6.3.3"></a><h4><a name="GET MIDI_INPUT_DRIVER INFO">6.3.3</a>&nbsp;Getting information about a specific MIDI input driver</h4>  <a name="GET MIDI_INPUT_DRIVER INFO"></a><br /><hr />
2329    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2330    <a name="rfc.section.6.3.3"></a><h3>6.3.3.&nbsp;
2331    Getting information about a specific MIDI input driver</h3>
2332    
2333  <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:
2334  </p>  </p>
# Line 2201  Intellectual Property and Copyright Stat Line 2338  Intellectual Property and Copyright Stat
2338  <p>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;  <p>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;
2339  </p>  </p>
2340  </blockquote><p>  </blockquote><p>
2341                        
2342  </p>  </p>
2343  <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
2344                      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.
2345  </p>  </p>
2346  <p>Possible Answers:  <p>Possible Answers:
2347  </p>  </p>
# Line 2225  Intellectual Property and Copyright Stat Line 2362  Intellectual Property and Copyright Stat
2362  <blockquote class="text">  <blockquote class="text">
2363  <p>arbitrary description text about the MIDI input driver  <p>arbitrary description text about the MIDI input driver
2364  </p>  </p>
2365  </blockquote><p>  </blockquote>
2366                                        
2367    
 </p>  
2368  <p>VERSION -  <p>VERSION -
2369                                          </p>                                          </p>
2370  <blockquote class="text">  <blockquote class="text">
2371  <p>arbitrary character string regarding the driver's version  <p>arbitrary character string regarding the driver's version
2372  </p>  </p>
2373  </blockquote><p>  </blockquote>
2374                                        
2375    
 </p>  
2376  <p>PARAMETERS -  <p>PARAMETERS -
2377                                          </p>                                          </p>
2378  <blockquote class="text">  <blockquote class="text">
2379  <p>comma separated list of all parameters available for the given MIDI input driver  <p>comma separated list of all parameters available for the given MIDI input driver
2380  </p>  </p>
2381  </blockquote><p>  </blockquote>
2382                                        
2383    
2384  </p>  </blockquote>
2385  </blockquote><p>                              
2386    
 </p>  
2387  <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.
2388  </p>  </p>
2389  </blockquote><p>  </blockquote><p>
2390                        
2391  </p>  </p>
2392  <p>Example:  <p>Example:
2393  </p>  </p>
# Line 2268  Intellectual Property and Copyright Stat Line 2405  Intellectual Property and Copyright Stat
2405  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
2406  </p>  </p>
2407  </blockquote><p>  </blockquote><p>
2408                        
2409  </p>  </p>
2410  <a name="rfc.section.6.3.4"></a><h4><a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO">6.3.4</a>&nbsp;Getting information about specific MIDI input driver parameter</h4>  <a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO"></a><br /><hr />
2411    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2412    <a name="rfc.section.6.3.4"></a><h3>6.3.4.&nbsp;
2413    Getting information about specific MIDI input driver parameter</h3>
2414    
2415  <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:
2416  </p>  </p>
# Line 2280  Intellectual Property and Copyright Stat Line 2420  Intellectual Property and Copyright Stat
2420  <p>GET MIDI_INPUT_DRIVER_PARAMETER INFO &lt;midit&gt; &lt;param&gt; [&lt;deplist&gt;]  <p>GET MIDI_INPUT_DRIVER_PARAMETER INFO &lt;midit&gt; &lt;param&gt; [&lt;deplist&gt;]
2421  </p>  </p>
2422  </blockquote><p>  </blockquote><p>
2423                        
2424  </p>  </p>
2425  <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
2426                      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
2427                      parameter name for which information should be obtained (as returned by the                      parameter name for which information should be obtained (as returned by the
2428                      <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
2429                      of parameters on which the sought parameter &lt;param&gt; depends on,                      of parameters on which the sought parameter &lt;param&gt; depends on,
2430                      &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 ...",
2431                      where character string values are encapsulated into apostrophes ('). Arguments                      where character string values are encapsulated into apostrophes ('). Arguments
# Line 2315  Intellectual Property and Copyright Stat Line 2455  Intellectual Property and Copyright Stat
2455                                  character string(s)                                  character string(s)
2456                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2457  </p>  </p>
2458  </blockquote><p>  </blockquote>
2459                                
2460    
 </p>  
2461  <p>DESCRIPTION -  <p>DESCRIPTION -
2462                                </p>                                </p>
2463  <blockquote class="text">  <blockquote class="text">
2464  <p>arbitrary text describing the purpose of the parameter  <p>arbitrary text describing the purpose of the parameter
2465                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2466  </p>  </p>
2467  </blockquote><p>  </blockquote>
2468                                
2469    
 </p>  
2470  <p>MANDATORY -  <p>MANDATORY -
2471                                </p>                                </p>
2472  <blockquote class="text">  <blockquote class="text">
2473  <p>either true or false, defines if this parameter must be  <p>either true or false, defines if this parameter must be
2474                                  given when the device is to be created with the                                  given when the device is to be created with the
2475                                  <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
2476                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2477  </p>  </p>
2478  </blockquote><p>  </blockquote>
2479                                
2480    
 </p>  
2481  <p>FIX -  <p>FIX -
2482                                </p>                                </p>
2483  <blockquote class="text">  <blockquote class="text">
2484  <p>either true or false, if false then this parameter can  <p>either true or false, if false then this parameter can
2485                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
2486                                  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
2487                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2488  </p>  </p>
2489  </blockquote><p>  </blockquote>
2490                                
2491    
 </p>  
2492  <p>MULTIPLICITY -  <p>MULTIPLICITY -
2493                                </p>                                </p>
2494  <blockquote class="text">  <blockquote class="text">
# Line 2357  Intellectual Property and Copyright Stat Line 2497  Intellectual Property and Copyright Stat
2497                                  multiple values and false only a single value allowed                                  multiple values and false only a single value allowed
2498                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2499  </p>  </p>
2500  </blockquote><p>  </blockquote>
2501                                
2502    
 </p>  
2503  <p>DEPENDS -  <p>DEPENDS -
2504                                </p>                                </p>
2505  <blockquote class="text">  <blockquote class="text">
# Line 2374  Intellectual Property and Copyright Stat Line 2514  Intellectual Property and Copyright Stat
2514                                  chosen by the 'card' parameter                                  chosen by the 'card' parameter
2515                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
2516  </p>  </p>
2517  </blockquote><p>  </blockquote>
2518                                
2519    
 </p>  
2520  <p>DEFAULT -  <p>DEFAULT -
2521                                </p>                                </p>
2522  <blockquote class="text">  <blockquote class="text">
2523  <p>reflects the default value for this parameter which is  <p>reflects the default value for this parameter which is
2524                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
2525                                  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,
2526                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
2527                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
2528                                  apostrophes (')                                  apostrophes (')
2529                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
2530  </p>  </p>
2531  </blockquote><p>  </blockquote>
2532                                
2533    
 </p>  
2534  <p>RANGE_MIN -  <p>RANGE_MIN -
2535                                </p>                                </p>
2536  <blockquote class="text">  <blockquote class="text">
# Line 2400  Intellectual Property and Copyright Stat Line 2540  Intellectual Property and Copyright Stat
2540                                  with RANGE_MAX, but may also appear without                                  with RANGE_MAX, but may also appear without
2541                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
2542  </p>  </p>
2543  </blockquote><p>  </blockquote>
2544                                
2545    
 </p>  
2546  <p>RANGE_MAX -  <p>RANGE_MAX -
2547                                </p>                                </p>
2548  <blockquote class="text">  <blockquote class="text">
# Line 2412  Intellectual Property and Copyright Stat Line 2552  Intellectual Property and Copyright Stat
2552                                  RANGE_MIN, but may also appear without                                  RANGE_MIN, but may also appear without
2553                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
2554  </p>  </p>
2555  </blockquote><p>  </blockquote>
2556                                
2557    
 </p>  
2558  <p>POSSIBILITIES -  <p>POSSIBILITIES -
2559                                </p>                                </p>
2560  <blockquote class="text">  <blockquote class="text">
# Line 2423  Intellectual Property and Copyright Stat Line 2563  Intellectual Property and Copyright Stat
2563                                  apostrophes                                  apostrophes
2564                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
2565  </p>  </p>
2566  </blockquote><p>  </blockquote>
2567                                
2568    
 </p>  
2569  </blockquote><p>  </blockquote><p>
2570                        
2571  </p>  </p>
2572  <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.
2573  </p>  </p>
# Line 2453  Intellectual Property and Copyright Stat Line 2593  Intellectual Property and Copyright Stat
2593  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
2594  </p>  </p>
2595  </blockquote><p>  </blockquote><p>
2596                        
2597  </p>  </p>
2598  <a name="rfc.section.6.3.5"></a><h4><a name="CREATE MIDI_INPUT_DEVICE">6.3.5</a>&nbsp;Creating a MIDI input device</h4>  <a name="CREATE MIDI_INPUT_DEVICE"></a><br /><hr />
2599    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2600    <a name="rfc.section.6.3.5"></a><h3>6.3.5.&nbsp;
2601    Creating a MIDI input device</h3>
2602    
2603  <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:
2604  </p>  </p>
# Line 2465  Intellectual Property and Copyright Stat Line 2608  Intellectual Property and Copyright Stat
2608  <p>CREATE MIDI_INPUT_DEVICE &lt;midi-input-driver&gt; [&lt;param-list&gt;]  <p>CREATE MIDI_INPUT_DEVICE &lt;midi-input-driver&gt; [&lt;param-list&gt;]
2609  </p>  </p>
2610  </blockquote><p>  </blockquote><p>
2611                        
2612  </p>  </p>
2613  <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
2614                      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
2615                      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
2616                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
2617                      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 2486  Intellectual Property and Copyright Stat Line 2629  Intellectual Property and Copyright Stat
2629  <p>in case the device was successfully created, where  <p>in case the device was successfully created, where
2630                                      &lt;device-id&gt; is the numerical ID of the new device                                      &lt;device-id&gt; is the numerical ID of the new device
2631  </p>  </p>
2632  </blockquote><p>  </blockquote>
2633                                
2634    
 </p>  
2635  <p>"WRN[&lt;device-id&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN[&lt;device-id&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2636                                  </p>                                  </p>
2637  <blockquote class="text">  <blockquote class="text">
# Line 2497  Intellectual Property and Copyright Stat Line 2640  Intellectual Property and Copyright Stat
2640                                      there are noteworthy issue(s) related, providing an                                      there are noteworthy issue(s) related, providing an
2641                                      appropriate warning code and warning message                                      appropriate warning code and warning message
2642  </p>  </p>
2643  </blockquote><p>  </blockquote>
2644                                
2645    
 </p>  
2646  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2647                                  </p>                                  </p>
2648  <blockquote class="text">  <blockquote class="text">
2649  <p>in case it failed, providing an appropriate error code and error message  <p>in case it failed, providing an appropriate error code and error message
2650  </p>  </p>
2651  </blockquote><p>  </blockquote>
2652                                
2653    
 </p>  
2654  </blockquote><p>  </blockquote><p>
2655                        
2656  </p>  </p>
2657  <p>Example:  <p>Example:
2658  </p>  </p>
# Line 2521  Intellectual Property and Copyright Stat Line 2664  Intellectual Property and Copyright Stat
2664  <p>S: "OK[0]"  <p>S: "OK[0]"
2665  </p>  </p>
2666  </blockquote><p>  </blockquote><p>
2667                        
2668  </p>  </p>
2669  <a name="rfc.section.6.3.6"></a><h4><a name="DESTROY MIDI_INPUT_DEVICE">6.3.6</a>&nbsp;Destroying a MIDI input device</h4>  <a name="DESTROY MIDI_INPUT_DEVICE"></a><br /><hr />
2670    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2671    <a name="rfc.section.6.3.6"></a><h3>6.3.6.&nbsp;
2672    Destroying a MIDI input device</h3>
2673    
2674  <p>Use the following command to destroy a created MIDI input device:  <p>Use the following command to destroy a created MIDI input device:
2675  </p>  </p>
# Line 2533  Intellectual Property and Copyright Stat Line 2679  Intellectual Property and Copyright Stat
2679  <p>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;  <p>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;
2680  </p>  </p>
2681  </blockquote><p>  </blockquote><p>
2682                        
2683  </p>  </p>
2684  <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
2685                      <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>
2686                      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>
2687                      command.                      command.
2688  </p>  </p>
2689  <p>Possible Answers:  <p>Possible Answers:
# Line 2550  Intellectual Property and Copyright Stat Line 2696  Intellectual Property and Copyright Stat
2696  <blockquote class="text">  <blockquote class="text">
2697  <p>in case the device was successfully destroyed  <p>in case the device was successfully destroyed
2698  </p>  </p>
2699  </blockquote><p>  </blockquote>
2700                                
2701    
 </p>  
2702  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2703                                  </p>                                  </p>
2704  <blockquote class="text">  <blockquote class="text">
# Line 2560  Intellectual Property and Copyright Stat Line 2706  Intellectual Property and Copyright Stat
2706                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
2707                                      warning message                                      warning message
2708  </p>  </p>
2709  </blockquote><p>  </blockquote>
2710                                
2711    
 </p>  
2712  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2713                                  </p>                                  </p>
2714  <blockquote class="text">  <blockquote class="text">
2715  <p>in case it failed, providing an appropriate error code and error message  <p>in case it failed, providing an appropriate error code and error message
2716  </p>  </p>
2717  </blockquote><p>  </blockquote>
2718                                
2719    
 </p>  
2720  </blockquote><p>  </blockquote><p>
2721                        
2722  </p>  </p>
2723  <p>Example:  <p>Example:
2724  </p>  </p>
# Line 2584  Intellectual Property and Copyright Stat Line 2730  Intellectual Property and Copyright Stat
2730  <p>S: "OK"  <p>S: "OK"
2731  </p>  </p>
2732  </blockquote><p>  </blockquote><p>
2733                        
2734  </p>  </p>
2735  <a name="rfc.section.6.3.7"></a><h4><a name="GET MIDI_INPUT_DEVICES">6.3.7</a>&nbsp;Getting all created MIDI input device count</h4>  <a name="GET MIDI_INPUT_DEVICES"></a><br /><hr />
2736    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2737    <a name="rfc.section.6.3.7"></a><h3>6.3.7.&nbsp;
2738    Getting all created MIDI input device count</h3>
2739    
2740  <p>Use the following command to count all created MIDI input devices:  <p>Use the following command to count all created MIDI input devices:
2741  </p>  </p>
# Line 2596  Intellectual Property and Copyright Stat Line 2745  Intellectual Property and Copyright Stat
2745  <p>GET MIDI_INPUT_DEVICES  <p>GET MIDI_INPUT_DEVICES
2746  </p>  </p>
2747  </blockquote><p>  </blockquote><p>
2748                        
2749  </p>  </p>
2750  <p>Possible Answers:  <p>Possible Answers:
2751  </p>  </p>
# Line 2607  Intellectual Property and Copyright Stat Line 2756  Intellectual Property and Copyright Stat
2756                              MIDI input devices.                              MIDI input devices.
2757  </p>  </p>
2758  </blockquote><p>  </blockquote><p>
2759                        
2760  </p>  </p>
2761  <p>Example:  <p>Example:
2762  </p>  </p>
# Line 2619  Intellectual Property and Copyright Stat Line 2768  Intellectual Property and Copyright Stat
2768  <p>S: "3"  <p>S: "3"
2769  </p>  </p>
2770  </blockquote><p>  </blockquote><p>
2771                        
2772  </p>  </p>
2773  <a name="rfc.section.6.3.8"></a><h4><a name="LIST MIDI_INPUT_DEVICES">6.3.8</a>&nbsp;Getting all created MIDI input device list</h4>  <a name="LIST MIDI_INPUT_DEVICES"></a><br /><hr />
2774    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2775    <a name="rfc.section.6.3.8"></a><h3>6.3.8.&nbsp;
2776    Getting all created MIDI input device list</h3>
2777    
2778  <p>Use the following command to list all created MIDI input devices:  <p>Use the following command to list all created MIDI input devices:
2779  </p>  </p>
# Line 2631  Intellectual Property and Copyright Stat Line 2783  Intellectual Property and Copyright Stat
2783  <p>LIST MIDI_INPUT_DEVICES  <p>LIST MIDI_INPUT_DEVICES
2784  </p>  </p>
2785  </blockquote><p>  </blockquote><p>
2786                        
2787  </p>  </p>
2788  <p>Possible Answers:  <p>Possible Answers:
2789  </p>  </p>
# Line 2642  Intellectual Property and Copyright Stat Line 2794  Intellectual Property and Copyright Stat
2794                              with the numerical Ids of all created MIDI input devices.                              with the numerical Ids of all created MIDI input devices.
2795  </p>  </p>
2796  </blockquote><p>  </blockquote><p>
2797                        
2798  </p>  </p>
2799  <p>Examples:  <p>Examples:
2800  </p>  </p>
# Line 2654  Intellectual Property and Copyright Stat Line 2806  Intellectual Property and Copyright Stat
2806  <p>S: "0,1,2"  <p>S: "0,1,2"
2807  </p>  </p>
2808  </blockquote><p>  </blockquote><p>
2809                        
2810  </p>  </p>
2811  <p>  <p>
2812                          </p>                          </p>
# Line 2664  Intellectual Property and Copyright Stat Line 2816  Intellectual Property and Copyright Stat
2816  <p>S: "1,3"  <p>S: "1,3"
2817  </p>  </p>
2818  </blockquote><p>  </blockquote><p>
2819                        
2820  </p>  </p>
2821  <a name="rfc.section.6.3.9"></a><h4><a name="GET MIDI_INPUT_DEVICE INFO">6.3.9</a>&nbsp;Getting current settings of a MIDI input device</h4>  <a name="GET MIDI_INPUT_DEVICE INFO"></a><br /><hr />
2822    <table 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.9"></a><h3>6.3.9.&nbsp;
2824    Getting current settings of a MIDI input device</h3>
2825    
2826  <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:
2827  </p>  </p>
# Line 2676  Intellectual Property and Copyright Stat Line 2831  Intellectual Property and Copyright Stat
2831  <p>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;  <p>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;
2832  </p>  </p>
2833  </blockquote><p>  </blockquote><p>
2834                        
2835  </p>  </p>
2836  <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
2837                      <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>
2838                      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>
2839                      command.                      command.
2840  </p>  </p>
2841  <p>Possible Answers:  <p>Possible Answers:
# Line 2703  Intellectual Property and Copyright Stat Line 2858  Intellectual Property and Copyright Stat
2858                                          </p>                                          </p>
2859  <blockquote class="text">  <blockquote class="text">
2860  <p>identifier of the used MIDI input driver, as e.g.  <p>identifier of the used MIDI input driver, as e.g.
2861                                              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>
2862                                              command                                              command
2863  </p>  </p>
2864  </blockquote><p>  </blockquote>
2865                                        
2866    
2867  </p>  </blockquote>
2868  </blockquote><p>                                  
                                 </p>  
2869  <blockquote class="text">  <blockquote class="text">
2870  <p>ACTIVE -  <p>ACTIVE -
2871                                          </p>                                          </p>
# Line 2720  Intellectual Property and Copyright Stat Line 2875  Intellectual Property and Copyright Stat
2875                                              and thus doesn't forward them to connected sampler                                              and thus doesn't forward them to connected sampler
2876                                              channels                                              channels
2877  </p>  </p>
2878  </blockquote><p>  </blockquote>
2879                                        
2880    
2881  </p>  </blockquote>
2882  </blockquote><p>                              
2883    
 </p>  
2884  </blockquote><p>  </blockquote><p>
2885                        
2886  </p>  </p>
2887  <p>The mentioned fields above don't have to be in particular  <p>The mentioned fields above don't have to be in particular
2888                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
2889                      returned by all MIDI input devices. Every MIDI input driver                      returned by all MIDI input devices. Every MIDI input driver
2890                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
2891                      <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
2892                      by this command.                      by this command.
2893  </p>  </p>
2894  <p>Example:  <p>Example:
# Line 2750  Intellectual Property and Copyright Stat Line 2905  Intellectual Property and Copyright Stat
2905  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
2906  </p>  </p>
2907  </blockquote><p>  </blockquote><p>
2908                        
2909  </p>  </p>
2910  <a name="rfc.section.6.3.10"></a><h4><a name="SET MIDI_INPUT_DEVICE_PARAMETER">6.3.10</a>&nbsp;Changing settings of MIDI input devices</h4>  <a name="SET MIDI_INPUT_DEVICE_PARAMETER"></a><br /><hr />
2911    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2912    <a name="rfc.section.6.3.10"></a><h3>6.3.10.&nbsp;
2913    Changing settings of MIDI input devices</h3>
2914    
2915  <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:
2916  </p>  </p>
# Line 2762  Intellectual Property and Copyright Stat Line 2920  Intellectual Property and Copyright Stat
2920  <p>SET MIDI_INPUT_DEVICE_PARAMETER &lt;device-id&gt; &lt;key&gt;=&lt;value&gt;  <p>SET MIDI_INPUT_DEVICE_PARAMETER &lt;device-id&gt; &lt;key&gt;=&lt;value&gt;
2921  </p>  </p>
2922  </blockquote><p>  </blockquote><p>
2923                        
2924  </p>  </p>
2925  <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
2926                      MIDI input device as returned by the                      MIDI input device as returned by the
2927                      <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>
2928                      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>
2929                      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
2930                      &lt;value&gt; by the new value for this parameter.                      &lt;value&gt; by the new value for this parameter.
2931  </p>  </p>
# Line 2781  Intellectual Property and Copyright Stat Line 2939  Intellectual Property and Copyright Stat
2939  <blockquote class="text">  <blockquote class="text">
2940  <p>in case setting was successfully changed  <p>in case setting was successfully changed
2941  </p>  </p>
2942  </blockquote><p>  </blockquote>
2943                                
2944    
 </p>  
2945  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2946                                  </p>                                  </p>
2947  <blockquote class="text">  <blockquote class="text">
# Line 2791  Intellectual Property and Copyright Stat Line 2949  Intellectual Property and Copyright Stat
2949                                      noteworthy issue(s) related, providing an appropriate                                      noteworthy issue(s) related, providing an appropriate
2950                                      warning code and warning message                                      warning code and warning message
2951  </p>  </p>
2952  </blockquote><p>  </blockquote>
2953                                
2954    
 </p>  
2955  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2956                                  </p>                                  </p>
2957  <blockquote class="text">  <blockquote class="text">
2958  <p>in case it failed, providing an appropriate error code and error message  <p>in case it failed, providing an appropriate error code and error message
2959  </p>  </p>
2960  </blockquote><p>  </blockquote>
2961                                
2962    
 </p>  
2963  </blockquote><p>  </blockquote><p>
2964                        
2965  </p>  </p>
2966  <p>Example:  <p>Example:
2967  </p>  </p>
# Line 2815  Intellectual Property and Copyright Stat Line 2973  Intellectual Property and Copyright Stat
2973  <p>S: "OK"  <p>S: "OK"
2974  </p>  </p>
2975  </blockquote><p>  </blockquote><p>
2976                        
2977  </p>  </p>
2978  <a name="rfc.section.6.3.11"></a><h4><a name="GET MIDI_INPUT_PORT INFO">6.3.11</a>&nbsp;Getting information about a MIDI port</h4>  <a name="GET MIDI_INPUT_PORT INFO"></a><br /><hr />
2979    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2980    <a name="rfc.section.6.3.11"></a><h3>6.3.11.&nbsp;
2981    Getting information about a MIDI port</h3>
2982    
2983  <p>Use the following command to get information about a MIDI port:  <p>Use the following command to get information about a MIDI port:
2984  </p>  </p>
# Line 2827  Intellectual Property and Copyright Stat Line 2988  Intellectual Property and Copyright Stat
2988  <p>GET MIDI_INPUT_PORT INFO &lt;device-id&gt; &lt;midi-port&gt;  <p>GET MIDI_INPUT_PORT INFO &lt;device-id&gt; &lt;midi-port&gt;
2989  </p>  </p>
2990  </blockquote><p>  </blockquote><p>
2991                        
2992  </p>  </p>
2993  <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
2994                      <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>
2995                      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>
2996                      command and &lt;midi-port&gt; the MIDI input port number.                      command and &lt;midi-port&gt; the MIDI input port number.
2997  </p>  </p>
2998  <p>Possible Answers:  <p>Possible Answers:
# Line 2850  Intellectual Property and Copyright Stat Line 3011  Intellectual Property and Copyright Stat
3011  <blockquote class="text">  <blockquote class="text">
3012  <p>arbitrary character string naming the port  <p>arbitrary character string naming the port
3013  </p>  </p>
3014  </blockquote><p>  </blockquote>
3015                                
3016    
 </p>  
3017  </blockquote><p>  </blockquote><p>
3018                        
3019  </p>  </p>
3020  <p>The field above is only the one which is returned by all MIDI  <p>The field above is only the one which is returned by all MIDI
3021                      ports regardless of the MIDI driver and port. Every MIDI port                      ports regardless of the MIDI driver and port. Every MIDI port
# Line 2875  Intellectual Property and Copyright Stat Line 3036  Intellectual Property and Copyright Stat
3036  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
3037  </p>  </p>
3038  </blockquote><p>  </blockquote><p>
3039                        
3040  </p>  </p>
3041  <a name="rfc.section.6.3.12"></a><h4><a name="GET MIDI_INPUT_PORT_PARAMETER INFO">6.3.12</a>&nbsp;Getting information about specific MIDI port parameter</h4>  <a name="GET MIDI_INPUT_PORT_PARAMETER INFO"></a><br /><hr />
3042    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3043    <a name="rfc.section.6.3.12"></a><h3>6.3.12.&nbsp;
3044    Getting information about specific MIDI port parameter</h3>
3045    
3046  <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:
3047  </p>  </p>
# Line 2887  Intellectual Property and Copyright Stat Line 3051  Intellectual Property and Copyright Stat
3051  <p>GET MIDI_INPUT_PORT_PARAMETER INFO &lt;dev-id&gt; &lt;port&gt; &lt;param&gt;  <p>GET MIDI_INPUT_PORT_PARAMETER INFO &lt;dev-id&gt; &lt;port&gt; &lt;param&gt;
3052  </p>  </p>
3053  </blockquote><p>  </blockquote><p>
3054                        
3055  </p>  </p>
3056  <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
3057                      <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>
3058                      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>
3059                      command, &lt;port&gt; the MIDI port number and                      command, &lt;port&gt; the MIDI port number and
3060                      &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
3061                      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).
3062  </p>  </p>
3063  <p>Possible Answers:  <p>Possible Answers:
3064  </p>  </p>
# Line 2918  Intellectual Property and Copyright Stat Line 3082  Intellectual Property and Copyright Stat
3082                                      character string(s)                                      character string(s)
3083                                      (always returned)                                      (always returned)
3084  </p>  </p>
3085  </blockquote><p>  </blockquote>
3086                                
3087    
 </p>  
3088  <p>DESCRIPTION -  <p>DESCRIPTION -
3089                                  </p>                                  </p>
3090  <blockquote class="text">  <blockquote class="text">
3091  <p>arbitrary text describing the purpose of the parameter  <p>arbitrary text describing the purpose of the parameter
3092                                      (always returned)                                      (always returned)
3093  </p>  </p>
3094  </blockquote><p>  </blockquote>
3095                                
3096    
 </p>  
3097  <p>FIX -  <p>FIX -
3098                                  </p>                                  </p>
3099  <blockquote class="text">  <blockquote class="text">
# Line 2937  Intellectual Property and Copyright Stat Line 3101  Intellectual Property and Copyright Stat
3101                                      read only, thus cannot be altered                                      read only, thus cannot be altered
3102                                      (always returned)                                      (always returned)
3103  </p>  </p>
3104  </blockquote><p>  </blockquote>
3105                                
3106    
 </p>  
3107  <p>MULTIPLICITY -  <p>MULTIPLICITY -
3108                                  </p>                                  </p>
3109  <blockquote class="text">  <blockquote class="text">
# Line 2948  Intellectual Property and Copyright Stat Line 3112  Intellectual Property and Copyright Stat
3112                                      multiple values and false only a single value allowed                                      multiple values and false only a single value allowed
3113                                      (always returned)                                      (always returned)
3114  </p>  </p>
3115  </blockquote><p>  </blockquote>
3116                                
3117    
 </p>  
3118  <p>RANGE_MIN -  <p>RANGE_MIN -
3119                                  </p>                                  </p>
3120  <blockquote class="text">  <blockquote class="text">
# Line 2961  Intellectual Property and Copyright Stat Line 3125  Intellectual Property and Copyright Stat
3125                                      (optionally returned, dependent to driver and port                                      (optionally returned, dependent to driver and port
3126                                      parameter)                                      parameter)
3127  </p>  </p>
3128  </blockquote><p>  </blockquote>
3129                                
3130    
 </p>  
3131  <p>RANGE_MAX -  <p>RANGE_MAX -
3132                                  </p>                                  </p>
3133  <blockquote class="text">  <blockquote class="text">
# Line 2974  Intellectual Property and Copyright Stat Line 3138  Intellectual Property and Copyright Stat
3138                                      (optionally returned, dependent to driver and port                                      (optionally returned, dependent to driver and port
3139                                      parameter)                                      parameter)
3140  </p>  </p>
3141  </blockquote><p>  </blockquote>
3142                                
3143    
 </p>  
3144  <p>POSSIBILITIES -  <p>POSSIBILITIES -
3145                                  </p>                                  </p>
3146  <blockquote class="text">  <blockquote class="text">
# Line 2986  Intellectual Property and Copyright Stat Line 3150  Intellectual Property and Copyright Stat
3150                                      (optionally returned, dependent to device and port                                      (optionally returned, dependent to device and port
3151                                      parameter)                                      parameter)
3152  </p>  </p>
3153  </blockquote><p>  </blockquote>
3154                                
3155    
 </p>  
3156  </blockquote><p>  </blockquote><p>
3157                        
3158  </p>  </p>
3159  <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.
3160  </p>  </p>
# Line 3014  Intellectual Property and Copyright Stat Line 3178  Intellectual Property and Copyright Stat
3178  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
3179  </p>  </p>
3180  </blockquote><p>  </blockquote><p>
3181                        
3182  </p>  </p>
3183  <a name="rfc.section.6.3.13"></a><h4><a name="SET MIDI_INPUT_PORT_PARAMETER">6.3.13</a>&nbsp;Changing settings of MIDI input ports</h4>  <a name="SET MIDI_INPUT_PORT_PARAMETER"></a><br /><hr />
3184    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3185    <a name="rfc.section.6.3.13"></a><h3>6.3.13.&nbsp;
3186    Changing settings of MIDI input ports</h3>
3187    
3188  <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:
3189  </p>  </p>
# Line 3026  Intellectual Property and Copyright Stat Line 3193  Intellectual Property and Copyright Stat
3193  <p>SET MIDI_INPUT_PORT_PARAMETER &lt;device-id&gt; &lt;port&gt; &lt;key&gt;=&lt;value&gt;  <p>SET MIDI_INPUT_PORT_PARAMETER &lt;device-id&gt; &lt;port&gt; &lt;key&gt;=&lt;value&gt;
3194  </p>  </p>
3195  </blockquote><p>  </blockquote><p>
3196                        
3197  </p>  </p>
3198  <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
3199                      MIDI device as returned by the                      MIDI device as returned by the
3200                      <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>
3201                      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>
3202                      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
3203                      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
3204                      parameter.                      parameter.
# Line 3046  Intellectual Property and Copyright Stat Line 3213  Intellectual Property and Copyright Stat
3213  <blockquote class="text">  <blockquote class="text">
3214  <p>in case setting was successfully changed  <p>in case setting was successfully changed
3215  </p>  </p>
3216  </blockquote><p>  </blockquote>
3217                                
3218    
 </p>  
3219  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3220                                  </p>                                  </p>
3221  <blockquote class="text">  <blockquote class="text">
# Line 3056  Intellectual Property and Copyright Stat Line 3223  Intellectual Property and Copyright Stat
3223                                      noteworthy issue(s) related, providing an appropriate                                      noteworthy issue(s) related, providing an appropriate
3224                                      warning code and warning message                                      warning code and warning message
3225  </p>  </p>
3226  </blockquote><p>  </blockquote>
3227                                
3228    
 </p>  
3229  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3230                                  </p>                                  </p>
3231  <blockquote class="text">  <blockquote class="text">
3232  <p>in case it failed, providing an appropriate error code and error message  <p>in case it failed, providing an appropriate error code and error message
3233  </p>  </p>
3234  </blockquote><p>  </blockquote>
3235                                
3236    
 </p>  
3237  </blockquote><p>  </blockquote><p>
3238                        
3239  </p>  </p>
3240  <p>Example:  <p>Example:
3241  </p>  </p>
# Line 3078  Intellectual Property and Copyright Stat Line 3245  Intellectual Property and Copyright Stat
3245  <p>  <p>
3246  </p>  </p>
3247  </blockquote><p>  </blockquote><p>
3248                        
3249  </p>  </p>
3250  <a name="rfc.section.6.4"></a><h4><a name="anchor11">6.4</a>&nbsp;Configuring sampler channels</h4>  <a name="anchor11"></a><br /><hr />
3251    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3252    <a name="rfc.section.6.4"></a><h3>6.4.&nbsp;
3253    Configuring sampler channels</h3>
3254    
3255  <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
3256                  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
3257                  MIDI and audio devices.                  MIDI and audio devices.
3258  </p>  </p>
3259  <a name="rfc.section.6.4.1"></a><h4><a name="LOAD INSTRUMENT">6.4.1</a>&nbsp;Loading an instrument</h4>  <a name="LOAD INSTRUMENT"></a><br /><hr />
3260    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3261    <a name="rfc.section.6.4.1"></a><h3>6.4.1.&nbsp;
3262    Loading an instrument</h3>
3263    
3264  <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:
3265  </p>  </p>
# Line 3096  Intellectual Property and Copyright Stat Line 3269  Intellectual Property and Copyright Stat
3269  <p>LOAD INSTRUMENT [NON_MODAL] '&lt;filename&gt;' &lt;instr-index&gt; &lt;sampler-channel&gt;  <p>LOAD INSTRUMENT [NON_MODAL] '&lt;filename&gt;' &lt;instr-index&gt; &lt;sampler-channel&gt;
3270  </p>  </p>
3271  </blockquote><p>  </blockquote><p>
3272                        
3273  </p>  </p>
3274  <p>Where &lt;filename&gt; is the name of the instrument file on the  <p>Where &lt;filename&gt; is the name of the instrument file on the
3275                      LinuxSampler instance's host system, &lt;instr-index&gt; the index of the                      LinuxSampler instance's host system, &lt;instr-index&gt; the index of the
# Line 3108  Intellectual Property and Copyright Stat Line 3281  Intellectual Property and Copyright Stat
3281                      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
3282                      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
3283                      returns immediately and a background process is launched to load the instrument                      returns immediately and a background process is launched to load the instrument
3284                      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>
3285                      command can be used to obtain loading                      command can be used to obtain loading
3286                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks
3287                      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 3125  Intellectual Property and Copyright Stat Line 3298  Intellectual Property and Copyright Stat
3298  <blockquote class="text">  <blockquote class="text">
3299  <p>in case the instrument was successfully loaded  <p>in case the instrument was successfully loaded
3300  </p>  </p>
3301  </blockquote><p>  </blockquote>
3302                                
3303    
 </p>  
3304  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3305                                  </p>                                  </p>
3306  <blockquote class="text">  <blockquote class="text">
# Line 3137  Intellectual Property and Copyright Stat Line 3310  Intellectual Property and Copyright Stat
3310                                      instrument file), providing an appropriate warning code and                                      instrument file), providing an appropriate warning code and
3311                                      warning message                                      warning message
3312  </p>  </p>
3313  </blockquote><p>  </blockquote>
3314                                
3315    
 </p>  
3316  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3317                                  </p>                                  </p>
3318  <blockquote class="text">  <blockquote class="text">
3319  <p>in case it failed, providing an appropriate error code and error message  <p>in case it failed, providing an appropriate error code and error message
3320  </p>  </p>
3321  </blockquote><p>  </blockquote>
3322                                
3323    
 </p>  
3324  </blockquote><p>  </blockquote><p>
3325                        
3326  </p>  </p>
3327  <p>Example:  <p>Example:
3328  </p>  </p>
# Line 3159  Intellectual Property and Copyright Stat Line 3332  Intellectual Property and Copyright Stat
3332  <p>  <p>
3333  </p>  </p>
3334  </blockquote><p>  </blockquote><p>
3335                        
3336  </p>  </p>
3337  <a name="rfc.section.6.4.2"></a><h4><a name="LOAD ENGINE">6.4.2</a>&nbsp;Loading a sampler engine</h4>  <a name="LOAD ENGINE"></a><br /><hr />
3338    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3339    <a name="rfc.section.6.4.2"></a><h3>6.4.2.&nbsp;
3340    Loading a sampler engine</h3>
3341    
3342  <p>A sampler engine type can be associated to a specific sampler  <p>A sampler engine type can be associated to a specific sampler
3343                      channel by the following command:                      channel by the following command:
# Line 3172  Intellectual Property and Copyright Stat Line 3348  Intellectual Property and Copyright Stat
3348  <p>LOAD ENGINE &lt;engine-name&gt; &lt;sampler-channel&gt;  <p>LOAD ENGINE &lt;engine-name&gt; &lt;sampler-channel&gt;
3349  </p>  </p>
3350  </blockquote><p>  </blockquote><p>
3351                        
3352  </p>  </p>
3353  <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
3354                      <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;
3355                      the sampler channel as returned by the                      the sampler channel as returned by the
3356                      <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
3357                      <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
3358                      the engine type should be assigned to. This command should be issued                      the engine type should be assigned to. This command should be issued
3359                      after adding a new sampler channel and before any other control                      after adding a new sampler channel and before any other control
3360                      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 3198  Intellectual Property and Copyright Stat Line 3374  Intellectual Property and Copyright Stat
3374  <blockquote class="text">  <blockquote class="text">
3375  <p>in case the engine was successfully deployed  <p>in case the engine was successfully deployed
3376  </p>  </p>
3377  </blockquote><p>  </blockquote>
3378                                
3379    
 </p>  
3380  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3381                                  </p>                                  </p>
3382  <blockquote class="text">  <blockquote class="text">
# Line 3208  Intellectual Property and Copyright Stat Line 3384  Intellectual Property and Copyright Stat
3384                                      are noteworthy issue(s) related, providing an appropriate                                      are noteworthy issue(s) related, providing an appropriate
3385                                      warning code and warning message                                      warning code and warning message
3386  </p>  </p>
3387  </blockquote><p>  </blockquote>
3388                                
3389    
 </p>  
3390  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3391                                  </p>                                  </p>
3392  <blockquote class="text">  <blockquote class="text">
3393  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
3394                                      error message                                      error message
3395  </p>  </p>
3396  </blockquote><p>  </blockquote>
3397                                
3398    
 </p>  
3399  </blockquote><p>  </blockquote><p>
3400                        
3401  </p>  </p>
3402  <p>Example:  <p>Example:
3403  </p>  </p>
# Line 3231  Intellectual Property and Copyright Stat Line 3407  Intellectual Property and Copyright Stat
3407  <p>  <p>
3408  </p>  </p>
3409  </blockquote><p>  </blockquote><p>
3410                        
3411  </p>  </p>
3412  <a name="rfc.section.6.4.3"></a><h4><a name="GET CHANNELS">6.4.3</a>&nbsp;Getting all created sampler channel count</h4>  <a name="GET CHANNELS"></a><br /><hr />
3413    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3414    <a name="rfc.section.6.4.3"></a><h3>6.4.3.&nbsp;
3415    Getting all created sampler channel count</h3>
3416    
3417  <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
3418                      current amount of sampler channels, the front-end can send the                      current amount of sampler channels, the front-end can send the
# Line 3245  Intellectual Property and Copyright Stat Line 3424  Intellectual Property and Copyright Stat
3424  <p>GET CHANNELS  <p>GET CHANNELS
3425  </p>  </p>
3426  </blockquote><p>  </blockquote><p>
3427                        
3428  </p>  </p>
3429  <p>Possible Answers:  <p>Possible Answers:
3430  </p>  </p>
# Line 3255  Intellectual Property and Copyright Stat Line 3434  Intellectual Property and Copyright Stat
3434  <p>LinuxSampler will answer by returning the current number of sampler channels.  <p>LinuxSampler will answer by returning the current number of sampler channels.
3435  </p>  </p>
3436  </blockquote><p>  </blockquote><p>
3437                        
3438  </p>  </p>
3439  <p>Example:  <p>Example:
3440  </p>  </p>
# Line 3267  Intellectual Property and Copyright Stat Line 3446  Intellectual Property and Copyright Stat
3446  <p>S: "12"  <p>S: "12"
3447  </p>  </p>
3448  </blockquote><p>  </blockquote><p>
3449                        
3450  </p>  </p>
3451  <a name="rfc.section.6.4.4"></a><h4><a name="LIST CHANNELS">6.4.4</a>&nbsp;Getting all created sampler channel list</h4>  <a name="LIST CHANNELS"></a><br /><hr />
3452    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3453    <a name="rfc.section.6.4.4"></a><h3>6.4.4.&nbsp;
3454    Getting all created sampler channel list</h3>
3455    
3456  <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
3457                      current list of sampler channels, the front-end can send the                      current list of sampler channels, the front-end can send the
# Line 3281  Intellectual Property and Copyright Stat Line 3463  Intellectual Property and Copyright Stat
3463  <p>LIST CHANNELS  <p>LIST CHANNELS
3464  </p>  </p>
3465  </blockquote><p>  </blockquote><p>
3466                        
3467  </p>  </p>
3468  <p>Possible Answers:  <p>Possible Answers:
3469  </p>  </p>
# Line 3292  Intellectual Property and Copyright Stat Line 3474  Intellectual Property and Copyright Stat
3474                              with all sampler channels numerical IDs.                              with all sampler channels numerical IDs.
3475  </p>  </p>
3476  </blockquote><p>  </blockquote><p>
3477                        
3478  </p>  </p>
3479  <p>Example:  <p>Example:
3480  </p>  </p>
# Line 3304  Intellectual Property and Copyright Stat Line 3486  Intellectual Property and Copyright Stat
3486  <p>S: "0,1,2,3,4,5,6,9,10,11,15,20"  <p>S: "0,1,2,3,4,5,6,9,10,11,15,20"
3487  </p>  </p>
3488  </blockquote><p>  </blockquote><p>
3489                        
3490  </p>  </p>
3491  <a name="rfc.section.6.4.5"></a><h4><a name="ADD CHANNEL">6.4.5</a>&nbsp;Adding a new sampler channel</h4>  <a name="ADD CHANNEL"></a><br /><hr />
3492    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3493    <a name="rfc.section.6.4.5"></a><h3>6.4.5.&nbsp;
3494    Adding a new sampler channel</h3>
3495    
3496  <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
3497                      channel list by sending the following command:                      channel list by sending the following command:
# Line 3317  Intellectual Property and Copyright Stat Line 3502  Intellectual Property and Copyright Stat
3502  <p>ADD CHANNEL  <p>ADD CHANNEL
3503  </p>  </p>
3504  </blockquote><p>  </blockquote><p>
3505                        
3506  </p>  </p>
3507  <p>This will increment the sampler channel count by one and the new  <p>This will increment the sampler channel count by one and the new
3508                      sampler channel will be appended to the end of the sampler channel                      sampler channel will be appended to the end of the sampler channel
# Line 3343  Intellectual Property and Copyright Stat Line 3528  Intellectual Property and Copyright Stat
3528                                      the sampler channel by sending subsequent initialization                                      the sampler channel by sending subsequent initialization
3529                                      commands                                      commands
3530  </p>  </p>
3531  </blockquote><p>  </blockquote>
3532                                
3533    
 </p>  
3534  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3535                                  </p>                                  </p>
3536  <blockquote class="text">  <blockquote class="text">
# Line 3353  Intellectual Property and Copyright Stat Line 3538  Intellectual Property and Copyright Stat
3538                                      noteworthy issue(s) related, providing an appropriate                                      noteworthy issue(s) related, providing an appropriate
3539                                      warning code and warning message                                      warning code and warning message
3540  </p>  </p>
3541  </blockquote><p>  </blockquote>
3542                                
3543    
 </p>  
3544  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3545                                  </p>                                  </p>
3546  <blockquote class="text">  <blockquote class="text">
3547  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
3548                                      error message                                      error message
3549  </p>  </p>
3550  </blockquote><p>  </blockquote>
3551                                
3552    
 </p>  
3553  </blockquote><p>  </blockquote><p>
3554                        
3555  </p>  </p>
3556  <p>Example:  <p>Example:
3557  </p>  </p>
# Line 3376  Intellectual Property and Copyright Stat Line 3561  Intellectual Property and Copyright Stat
3561  <p>  <p>
3562  </p>  </p>
3563  </blockquote><p>  </blockquote><p>
3564                        
3565  </p>  </p>
3566  <a name="rfc.section.6.4.6"></a><h4><a name="REMOVE CHANNEL">6.4.6</a>&nbsp;Removing a sampler channel</h4>  <a name="REMOVE CHANNEL"></a><br /><hr />
3567    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3568    <a name="rfc.section.6.4.6"></a><h3>6.4.6.&nbsp;
3569    Removing a sampler channel</h3>
3570    
3571  <p>A sampler channel can be removed by sending the following command:  <p>A sampler channel can be removed by sending the following command:
3572  </p>  </p>
# Line 3388  Intellectual Property and Copyright Stat Line 3576  Intellectual Property and Copyright Stat
3576  <p>REMOVE CHANNEL &lt;sampler-channel&gt;  <p>REMOVE CHANNEL &lt;sampler-channel&gt;
3577  </p>  </p>
3578  </blockquote><p>  </blockquote><p>
3579                        
3580  </p>  </p>
3581  <p>Where &lt;sampler-channel&gt; should be replaced by the  <p>Where &lt;sampler-channel&gt; should be replaced by the
3582                      number of the sampler channel as given by the                      number of the sampler channel as given by the
3583                      <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>
3584                      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>
3585                      command. The channel numbers of all subsequent sampler channels                      command. The channel numbers of all subsequent sampler channels
3586                      remain the same.                      remain the same.
3587  </p>  </p>
# Line 3407  Intellectual Property and Copyright Stat Line 3595  Intellectual Property and Copyright Stat
3595  <blockquote class="text">  <blockquote class="text">
3596  <p>in case the given sampler channel could be removed  <p>in case the given sampler channel could be removed
3597  </p>  </p>
3598  </blockquote><p>  </blockquote>
3599                                
3600    
 </p>  
3601  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3602                                  </p>                                  </p>
3603  <blockquote class="text">  <blockquote class="text">
# Line 3417  Intellectual Property and Copyright Stat Line 3605  Intellectual Property and Copyright Stat
3605                                      noteworthy issue(s) related, providing an appropriate                                      noteworthy issue(s) related, providing an appropriate
3606                                      warning code and warning message                                      warning code and warning message
3607  </p>  </p>
3608  </blockquote><p>  </blockquote>
3609                                
3610    
 </p>  
3611  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3612                                  </p>                                  </p>
3613  <blockquote class="text">  <blockquote class="text">
3614  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
3615                                      error message                                      error message
3616  </p>  </p>
3617  </blockquote><p>  </blockquote>
3618                                
3619    
 </p>  
3620  </blockquote><p>  </blockquote><p>
3621                        
3622  </p>  </p>
3623  <p>Example:  <p>Example:
3624  </p>  </p>
# Line 3440  Intellectual Property and Copyright Stat Line 3628  Intellectual Property and Copyright Stat
3628  <p>  <p>
3629  </p>  </p>
3630  </blockquote><p>  </blockquote><p>
3631                        
3632  </p>  </p>
3633  <a name="rfc.section.6.4.7"></a><h4><a name="GET AVAILABLE_ENGINES">6.4.7</a>&nbsp;Getting amount of available engines</h4>  <a name="GET AVAILABLE_ENGINES"></a><br /><hr />
3634    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3635    <a name="rfc.section.6.4.7"></a><h3>6.4.7.&nbsp;
3636    Getting amount of available engines</h3>
3637    
3638  <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:
3639  </p>  </p>
# Line 3452  Intellectual Property and Copyright Stat Line 3643  Intellectual Property and Copyright Stat
3643  <p>GET AVAILABLE_ENGINES  <p>GET AVAILABLE_ENGINES
3644  </p>  </p>
3645  </blockquote><p>  </blockquote><p>
3646                        
3647  </p>  </p>
3648  <p>Possible Answers:  <p>Possible Answers:
3649  </p>  </p>
# Line 3462  Intellectual Property and Copyright Stat Line 3653  Intellectual Property and Copyright Stat
3653  <p>LinuxSampler will answer by sending the number of available engines.  <p>LinuxSampler will answer by sending the number of available engines.
3654  </p>  </p>
3655  </blockquote><p>  </blockquote><p>
3656                        
3657  </p>  </p>
3658  <p>Example:  <p>Example:
3659  </p>  </p>
# Line 3474  Intellectual Property and Copyright Stat Line 3665  Intellectual Property and Copyright Stat
3665  <p>S: "4"  <p>S: "4"
3666  </p>  </p>
3667  </blockquote><p>  </blockquote><p>
3668                        
3669  </p>  </p>
3670  <a name="rfc.section.6.4.8"></a><h4><a name="LIST AVAILABLE_ENGINES">6.4.8</a>&nbsp;Getting all available engines</h4>  <a name="LIST AVAILABLE_ENGINES"></a><br /><hr />
3671    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3672    <a name="rfc.section.6.4.8"></a><h3>6.4.8.&nbsp;
3673    Getting all available engines</h3>
3674    
3675  <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:
3676  </p>  </p>
# Line 3486  Intellectual Property and Copyright Stat Line 3680  Intellectual Property and Copyright Stat
3680  <p>LIST AVAILABLE_ENGINES  <p>LIST AVAILABLE_ENGINES
3681  </p>  </p>
3682  </blockquote><p>  </blockquote><p>
3683                        
3684  </p>  </p>
3685  <p>Possible Answers:  <p>Possible Answers:
3686  </p>  </p>
# Line 3499  Intellectual Property and Copyright Stat Line 3693  Intellectual Property and Copyright Stat
3693                              digits and underlines ("_" character).                              digits and underlines ("_" character).
3694  </p>  </p>
3695  </blockquote><p>  </blockquote><p>
3696                        
3697  </p>  </p>
3698  <p>Example:  <p>Example:
3699  </p>  </p>
# Line 3511  Intellectual Property and Copyright Stat Line 3705  Intellectual Property and Copyright Stat
3705  <p>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"  <p>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"
3706  </p>  </p>
3707  </blockquote><p>  </blockquote><p>
3708                        
3709  </p>  </p>
3710  <a name="rfc.section.6.4.9"></a><h4><a name="GET ENGINE INFO">6.4.9</a>&nbsp;Getting information about an engine</h4>  <a name="GET ENGINE INFO"></a><br /><hr />
3711    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3712    <a name="rfc.section.6.4.9"></a><h3>6.4.9.&nbsp;
3713    Getting information about an engine</h3>
3714    
3715  <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
3716                      sending the following command:                      sending the following command:
# Line 3524  Intellectual Property and Copyright Stat Line 3721  Intellectual Property and Copyright Stat
3721  <p>GET ENGINE INFO &lt;engine-name&gt;  <p>GET ENGINE INFO &lt;engine-name&gt;
3722  </p>  </p>
3723  </blockquote><p>  </blockquote><p>
3724                        
3725  </p>  </p>
3726  <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
3727                      <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.
3728  </p>  </p>
3729  <p>Possible Answers:  <p>Possible Answers:
3730  </p>  </p>
# Line 3548  Intellectual Property and Copyright Stat Line 3745  Intellectual Property and Copyright Stat
3745  <blockquote class="text">  <blockquote class="text">
3746  <p>arbitrary description text about the engine  <p>arbitrary description text about the engine
3747  </p>  </p>
3748  </blockquote><p>  </blockquote>
3749                                        
3750    
 </p>  
3751  <p>VERSION -  <p>VERSION -
3752                                          </p>                                          </p>
3753  <blockquote class="text">  <blockquote class="text">
3754  <p>arbitrary character string regarding the engine's version  <p>arbitrary character string regarding the engine's version
3755  </p>  </p>
3756  </blockquote><p>  </blockquote>
3757                                        
3758    
3759  </p>  </blockquote>
3760  </blockquote><p>                              
3761    
 </p>  
3762  </blockquote><p>  </blockquote><p>
3763                        
3764  </p>  </p>
3765  <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.
3766  </p>  </p>
# Line 3581  Intellectual Property and Copyright Stat Line 3778  Intellectual Property and Copyright Stat
3778  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
3779  </p>  </p>
3780  </blockquote><p>  </blockquote><p>
3781                        
3782  </p>  </p>
3783  <a name="rfc.section.6.4.10"></a><h4><a name="GET CHANNEL INFO">6.4.10</a>&nbsp;Getting sampler channel information</h4>  <a name="GET CHANNEL INFO"></a><br /><hr />
3784    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3785    <a name="rfc.section.6.4.10"></a><h3>6.4.10.&nbsp;
3786    Getting sampler channel information</h3>
3787    
3788  <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
3789                      by sending the following command:                      by sending the following command:
# Line 3594  Intellectual Property and Copyright Stat Line 3794  Intellectual Property and Copyright Stat
3794  <p>GET CHANNEL INFO &lt;sampler-channel&gt;  <p>GET CHANNEL INFO &lt;sampler-channel&gt;
3795  </p>  </p>
3796  </blockquote><p>  </blockquote><p>
3797                        
3798  </p>  </p>
3799  <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
3800                      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>
3801                      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.
3802  </p>  </p>
3803  <p>Possible Answers:  <p>Possible Answers:
3804  </p>  </p>
# Line 3621  Intellectual Property and Copyright Stat Line 3821  Intellectual Property and Copyright Stat
3821                                              channel, "NONE" if there's no engine associated yet for                                              channel, "NONE" if there's no engine associated yet for
3822                                              this sampler channel                                              this sampler channel
3823  </p>  </p>
3824  </blockquote><p>  </blockquote>
3825                                        
3826    
 </p>  
3827  <p>AUDIO_OUTPUT_DEVICE -  <p>AUDIO_OUTPUT_DEVICE -
3828                                          </p>                                          </p>
3829  <blockquote class="text">  <blockquote class="text">
# Line 3632  Intellectual Property and Copyright Stat Line 3832  Intellectual Property and Copyright Stat
3832                                              the audio signal, "NONE" if there's no device                                              the audio signal, "NONE" if there's no device
3833                                              connected to this sampler channel                                              connected to this sampler channel
3834  </p>  </p>
3835  </blockquote><p>  </blockquote>
3836                                        
3837    
 </p>  
3838  <p>AUDIO_OUTPUT_CHANNELS -  <p>AUDIO_OUTPUT_CHANNELS -
3839                                          </p>                                          </p>
3840  <blockquote class="text">  <blockquote class="text">
3841  <p>number of output channels the sampler channel offers  <p>number of output channels the sampler channel offers
3842                                              (dependent to used sampler engine and loaded instrument)                                              (dependent to used sampler engine and loaded instrument)
3843  </p>  </p>
3844  </blockquote><p>  </blockquote>
3845                                        
3846    
 </p>  
3847  <p>AUDIO_OUTPUT_ROUTING -  <p>AUDIO_OUTPUT_ROUTING -
3848                                          </p>                                          </p>
3849  <blockquote class="text">  <blockquote class="text">
# Line 3655  Intellectual Property and Copyright Stat Line 3855  Intellectual Property and Copyright Stat
3855                                              channel 1 is routed to the channel 3 of the audio                                              channel 1 is routed to the channel 3 of the audio
3856                                              output device                                              output device
3857  </p>  </p>
3858  </blockquote><p>  </blockquote>
3859                                        
3860    
 </p>  
3861  <p>INSTRUMENT_FILE -  <p>INSTRUMENT_FILE -
3862                                          </p>                                          </p>
3863  <blockquote class="text">  <blockquote class="text">
# Line 3665  Intellectual Property and Copyright Stat Line 3865  Intellectual Property and Copyright Stat
3865                                              there's no instrument yet loaded for this sampler                                              there's no instrument yet loaded for this sampler
3866                                              channel                                              channel
3867  </p>  </p>
3868  </blockquote><p>  </blockquote>
3869                                        
3870    
 </p>  
3871  <p>INSTRUMENT_NR -  <p>INSTRUMENT_NR -
3872                                          </p>                                          </p>
3873  <blockquote class="text">  <blockquote class="text">
3874  <p>the instrument index number of the loaded instrument  <p>the instrument index number of the loaded instrument
3875  </p>  </p>
3876  </blockquote><p>  </blockquote>
3877                                        
3878    
 </p>  
3879  <p>INSTRUMENT_NAME -  <p>INSTRUMENT_NAME -
3880                                          </p>                                          </p>
3881  <blockquote class="text">  <blockquote class="text">
3882  <p>the instrument name of the loaded instrument  <p>the instrument name of the loaded instrument
3883  </p>  </p>
3884  </blockquote><p>  </blockquote>
3885                                        
3886    
 </p>  
3887  <p>INSTRUMENT_STATUS -  <p>INSTRUMENT_STATUS -
3888                                          </p>                                          </p>
3889  <blockquote class="text">  <blockquote class="text">
# Line 3691  Intellectual Property and Copyright Stat Line 3891  Intellectual Property and Copyright Stat
3891                                              value indicates a loading exception. Value of 100 indicates that the instrument is fully                                              value indicates a loading exception. Value of 100 indicates that the instrument is fully
3892                                              loaded.                                              loaded.
3893  </p>  </p>
3894  </blockquote><p>  </blockquote>
3895                                        
3896    
 </p>  
3897  <p>MIDI_INPUT_DEVICE -  <p>MIDI_INPUT_DEVICE -
3898                                          </p>                                          </p>
3899  <blockquote class="text">  <blockquote class="text">
# Line 3702  Intellectual Property and Copyright Stat Line 3902  Intellectual Property and Copyright Stat
3902                                              MIDI input commands, "NONE" if there's no device                                              MIDI input commands, "NONE" if there's no device
3903                                              connected to this sampler channel                                              connected to this sampler channel
3904  </p>  </p>
3905  </blockquote><p>  </blockquote>
3906                                        
3907    
 </p>  
3908  <p>MIDI_INPUT_PORT -  <p>MIDI_INPUT_PORT -
3909                                          </p>                                          </p>
3910  <blockquote class="text">  <blockquote class="text">
3911  <p>port number of the MIDI input device  <p>port number of the MIDI input device
3912  </p>  </p>
3913  </blockquote><p>  </blockquote>
3914                                        
3915    
 </p>  
3916  <p>MIDI_INPUT_CHANNEL -  <p>MIDI_INPUT_CHANNEL -
3917                                          </p>                                          </p>
3918  <blockquote class="text">  <blockquote class="text">
3919  <p>the MIDI input channel number this sampler channel  <p>the MIDI input channel number this sampler channel
3920                                              should listen to or "ALL" to listen on all MIDI channels                                              should listen to or "ALL" to listen on all MIDI channels
3921  </p>  </p>
3922  </blockquote><p>  </blockquote>
3923                                        
3924    
 </p>  
3925  <p>VOLUME -  <p>VOLUME -
3926                                          </p>                                          </p>
3927  <blockquote class="text">  <blockquote class="text">
# Line 3729  Intellectual Property and Copyright Stat Line 3929  Intellectual Property and Copyright Stat
3929                                              (where a value < 1.0 means attenuation and a value >                                              (where a value < 1.0 means attenuation and a value >
3930                                              1.0 means amplification)                                              1.0 means amplification)
3931  </p>  </p>
3932  </blockquote><p>  </blockquote>
3933                                        
3934    
 </p>  
3935  <p>MUTE -  <p>MUTE -
3936                                          </p>                                          </p>
3937  <blockquote class="text">  <blockquote class="text">
# Line 3741  Intellectual Property and Copyright Stat Line 3941  Intellectual Property and Copyright Stat
3941                                              presence of a solo channel and will be unmuted when                                              presence of a solo channel and will be unmuted when
3942                                              there are no solo channels left                                              there are no solo channels left
3943  </p>  </p>
3944  </blockquote><p>  </blockquote>
3945                                        
3946    
 </p>  
3947  <p>SOLO -  <p>SOLO -
3948                                          </p>                                          </p>
3949  <blockquote class="text">  <blockquote class="text">
3950  <p>Determines whether this is a solo channel, "true" if  <p>Determines whether this is a solo channel, "true" if
3951                                              the channel is a solo channel; "false" otherwise                                              the channel is a solo channel; "false" otherwise
3952  </p>  </p>
3953  </blockquote><p>  </blockquote>
3954                                        
3955    
3956    <p>MIDI_INSTRUMENT_MAP -
3957                                            </p>
3958    <blockquote class="text">
3959    <p>Determines to which MIDI instrument map this sampler
3960                                                channel is assigned to. Read chapter
3961                                                <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>
3962                                                for a list of possible values.
3963  </p>  </p>
3964  </blockquote><p>  </blockquote>
3965                                        
3966    
3967  </p>  </blockquote>
3968  </blockquote><p>                              
3969    
3970    </blockquote><p>
3971                        
3972  </p>  </p>
3973  <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.
3974  </p>  </p>
# Line 3792  Intellectual Property and Copyright Stat Line 4003  Intellectual Property and Copyright Stat
4003  </p>  </p>
4004  <p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"  <p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"
4005  </p>  </p>
4006    <p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
4007    </p>
4008    <p>&nbsp;&nbsp;&nbsp;"MUTE: false"
4009    </p>
4010    <p>&nbsp;&nbsp;&nbsp;"SOLO: false"
4011    </p>
4012    <p>&nbsp;&nbsp;&nbsp;"MIDI_INSTRUMENT_MAP: NONE"
4013    </p>
4014  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
4015  </p>  </p>
4016  </blockquote><p>  </blockquote><p>
4017                        
4018  </p>  </p>
4019  <a name="rfc.section.6.4.11"></a><h4><a name="GET CHANNEL VOICE_COUNT">6.4.11</a>&nbsp;Current number of active voices</h4>  <a name="GET CHANNEL VOICE_COUNT"></a><br /><hr />
4020    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4021    <a name="rfc.section.6.4.11"></a><h3>6.4.11.&nbsp;
4022    Current number of active voices</h3>
4023    
4024  <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
4025                      sampler channel by sending the following command:                      sampler channel by sending the following command:
# Line 3808  Intellectual Property and Copyright Stat Line 4030  Intellectual Property and Copyright Stat
4030  <p>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;  <p>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;
4031  </p>  </p>
4032  </blockquote><p>  </blockquote><p>
4033                        
4034  </p>  </p>
4035  <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
4036                      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>
4037                      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.
4038  </p>  </p>
4039  <p>Possible Answers:  <p>Possible Answers:
4040  </p>  </p>
# Line 3823  Intellectual Property and Copyright Stat Line 4045  Intellectual Property and Copyright Stat
4045                              voices on that channel.                              voices on that channel.
4046  </p>  </p>
4047  </blockquote><p>  </blockquote><p>
4048                        
4049  </p>  </p>
4050  <p>Example:  <p>Example:
4051  </p>  </p>
# Line 3833  Intellectual Property and Copyright Stat Line 4055  Intellectual Property and Copyright Stat
4055  <p>  <p>
4056  </p>  </p>
4057  </blockquote><p>  </blockquote><p>
4058                        
4059  </p>  </p>
4060  <a name="rfc.section.6.4.12"></a><h4><a name="GET CHANNEL STREAM_COUNT">6.4.12</a>&nbsp;Current number of active disk streams</h4>  <a name="GET CHANNEL STREAM_COUNT"></a><br /><hr />
4061    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4062    <a name="rfc.section.6.4.12"></a><h3>6.4.12.&nbsp;
4063    Current number of active disk streams</h3>
4064    
4065  <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
4066                      on a sampler channel by sending the following command:                      on a sampler channel by sending the following command:
# Line 3846  Intellectual Property and Copyright Stat Line 4071  Intellectual Property and Copyright Stat
4071  <p>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;  <p>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;
4072  </p>  </p>
4073  </blockquote><p>  </blockquote><p>
4074                        
4075  </p>  </p>
4076  <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
4077                      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>
4078                      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.
4079  </p>  </p>
4080  <p>Possible Answers:  <p>Possible Answers:
4081  </p>  </p>
# Line 3863  Intellectual Property and Copyright Stat Line 4088  Intellectual Property and Copyright Stat
4088                              return "NA" for not available.                              return "NA" for not available.
4089  </p>  </p>
4090  </blockquote><p>  </blockquote><p>
4091                        
4092  </p>  </p>
4093  <p>Example:  <p>Example:
4094  </p>  </p>
# Line 3873  Intellectual Property and Copyright Stat Line 4098  Intellectual Property and Copyright Stat
4098  <p>  <p>
4099  </p>  </p>
4100  </blockquote><p>  </blockquote><p>
4101                        
4102  </p>  </p>
4103  <a name="rfc.section.6.4.13"></a><h4><a name="GET CHANNEL BUFFER_FILL">6.4.13</a>&nbsp;Current fill state of disk stream buffers</h4>  <a name="GET CHANNEL BUFFER_FILL"></a><br /><hr />
4104    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4105    <a name="rfc.section.6.4.13"></a><h3>6.4.13.&nbsp;
4106    Current fill state of disk stream buffers</h3>
4107    
4108  <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
4109                      on a sampler channel by sending the following command:                      on a sampler channel by sending the following command:
# Line 3886  Intellectual Property and Copyright Stat Line 4114  Intellectual Property and Copyright Stat
4114  <p>GET CHANNEL BUFFER_FILL BYTES &lt;sampler-channel&gt;  <p>GET CHANNEL BUFFER_FILL BYTES &lt;sampler-channel&gt;
4115  </p>  </p>
4116  </blockquote><p>  </blockquote><p>
4117                        
4118  </p>  </p>
4119  <p>to get the fill state in bytes or  <p>to get the fill state in bytes or
4120  </p>  </p>
# Line 3896  Intellectual Property and Copyright Stat Line 4124  Intellectual Property and Copyright Stat
4124  <p>GET CHANNEL BUFFER_FILL PERCENTAGE &lt;sampler-channel&gt;  <p>GET CHANNEL BUFFER_FILL PERCENTAGE &lt;sampler-channel&gt;
4125  </p>  </p>
4126  </blockquote><p>  </blockquote><p>
4127                        
4128  </p>  </p>
4129  <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
4130                      sampler channel number the front-end is interested in                      sampler channel number the front-end is interested in
4131                      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>
4132                      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.
4133  </p>  </p>
4134  <p>Possible Answers:  <p>Possible Answers:
4135  </p>  </p>
# Line 3920  Intellectual Property and Copyright Stat Line 4148  Intellectual Property and Copyright Stat
4148                              to sort them by itself if necessary.                              to sort them by itself if necessary.
4149  </p>  </p>
4150  </blockquote><p>  </blockquote><p>
4151                        
4152  </p>  </p>
4153  <p>Examples:  <p>Examples:
4154  </p>  </p>
# Line 3948  Intellectual Property and Copyright Stat Line 4176  Intellectual Property and Copyright Stat
4176  <p>S: ""  <p>S: ""
4177  </p>  </p>
4178  </blockquote><p>  </blockquote><p>
4179                        
4180  </p>  </p>
4181  <a name="rfc.section.6.4.14"></a><h4><a name="SET CHANNEL AUDIO_OUTPUT_DEVICE">6.4.14</a>&nbsp;Setting audio output device</h4>  <a name="SET CHANNEL AUDIO_OUTPUT_DEVICE"></a><br /><hr />
4182    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4183    <a name="rfc.section.6.4.14"></a><h3>6.4.14.&nbsp;
4184    Setting audio output device</h3>
4185    
4186  <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
4187                      channel by sending the following command:                      channel by sending the following command:
# Line 3961  Intellectual Property and Copyright Stat Line 4192  Intellectual Property and Copyright Stat
4192  <p>SET CHANNEL AUDIO_OUTPUT_DEVICE &lt;sampler-channel&gt; &lt;audio-device-id&gt;  <p>SET CHANNEL AUDIO_OUTPUT_DEVICE &lt;sampler-channel&gt; &lt;audio-device-id&gt;
4193  </p>  </p>
4194  </blockquote><p>  </blockquote><p>
4195                        
4196  </p>  </p>
4197  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4198                      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>
4199                      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
4200                      &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
4201                      <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>
4202                      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>
4203                      command.                      command.
4204  </p>  </p>
4205  <p>Possible Answers:  <p>Possible Answers:
# Line 3981  Intellectual Property and Copyright Stat Line 4212  Intellectual Property and Copyright Stat
4212  <blockquote class="text">  <blockquote class="text">
4213  <p>on success  <p>on success
4214  </p>  </p>
4215  </blockquote><p>  </blockquote>
4216                                
4217    
 </p>  
4218  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4219                                  </p>                                  </p>
4220  <blockquote class="text">  <blockquote class="text">
# Line 3991  Intellectual Property and Copyright Stat Line 4222  Intellectual Property and Copyright Stat
4222                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4223                                      warning message                                      warning message
4224  </p>  </p>
4225  </blockquote><p>  </blockquote>
4226                                
4227    
 </p>  
4228  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4229                                  </p>                                  </p>
4230  <blockquote class="text">  <blockquote class="text">
4231  <p>in case it failed, providing an appropriate error code and error message  <p>in case it failed, providing an appropriate error code and error message
4232  </p>  </p>
4233  </blockquote><p>  </blockquote>
4234                                
4235    
 </p>  
4236  </blockquote><p>  </blockquote><p>
4237                        
4238  </p>  </p>
4239  <p>Examples:  <p>Examples:
4240  </p>  </p>
# Line 4013  Intellectual Property and Copyright Stat Line 4244  Intellectual Property and Copyright Stat
4244  <p>  <p>
4245  </p>  </p>
4246  </blockquote><p>  </blockquote><p>
4247                        
4248  </p>  </p>
4249  <a name="rfc.section.6.4.15"></a><h4><a name="SET CHANNEL AUDIO_OUTPUT_TYP">6.4.15</a>&nbsp;Setting audio output type</h4>  <a name="SET CHANNEL AUDIO_OUTPUT_TYPE"></a><br /><hr />
4250    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4251    <a name="rfc.section.6.4.15"></a><h3>6.4.15.&nbsp;
4252    Setting audio output type</h3>
4253    
4254  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
4255  </p>  </p>
# Line 4028  Intellectual Property and Copyright Stat Line 4262  Intellectual Property and Copyright Stat
4262  <p>SET CHANNEL AUDIO_OUTPUT_TYPE &lt;sampler-channel&gt; &lt;audio-output-type&gt;  <p>SET CHANNEL AUDIO_OUTPUT_TYPE &lt;sampler-channel&gt; &lt;audio-output-type&gt;
4263  </p>  </p>
4264  </blockquote><p>  </blockquote><p>
4265                        
4266  </p>  </p>
4267  <p>Where &lt;audio-output-type&gt; is currently either "ALSA" or "JACK" and  <p>Where &lt;audio-output-type&gt; is currently either "ALSA" or "JACK" and
4268                      &lt;sampler-channel&gt; is the respective sampler channel number.                      &lt;sampler-channel&gt; is the respective sampler channel number.
# Line 4043  Intellectual Property and Copyright Stat Line 4277  Intellectual Property and Copyright Stat
4277  <blockquote class="text">  <blockquote class="text">
4278  <p>on success  <p>on success
4279  </p>  </p>
4280  </blockquote><p>  </blockquote>
4281                                
4282    
 </p>  
4283  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4284                                  </p>                                  </p>
4285  <blockquote class="text">  <blockquote class="text">
# Line 4053  Intellectual Property and Copyright Stat Line 4287  Intellectual Property and Copyright Stat
4287                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4288                                      warning message                                      warning message
4289  </p>  </p>
4290  </blockquote><p>  </blockquote>
4291                                
4292    
 </p>  
4293  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4294                                  </p>                                  </p>
4295  <blockquote class="text">  <blockquote class="text">
4296  <p>in case it failed, providing an appropriate error code and error message  <p>in case it failed, providing an appropriate error code and error message
4297  </p>  </p>
4298  </blockquote><p>  </blockquote>
4299                                
4300    
 </p>  
4301  </blockquote><p>  </blockquote><p>
4302                        
4303  </p>  </p>
4304  <p>Examples:  <p>Examples:
4305  </p>  </p>
# Line 4075  Intellectual Property and Copyright Stat Line 4309  Intellectual Property and Copyright Stat
4309  <p>  <p>
4310  </p>  </p>
4311  </blockquote><p>  </blockquote><p>
4312                        
4313  </p>  </p>
4314  <a name="rfc.section.6.4.16"></a><h4><a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL">6.4.16</a>&nbsp;Setting audio output channel</h4>  <a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
4315    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4316    <a name="rfc.section.6.4.16"></a><h3>6.4.16.&nbsp;
4317    Setting audio output channel</h3>
4318    
4319  <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
4320                      sampler channel by sending the following command:                      sampler channel by sending the following command:
# Line 4088  Intellectual Property and Copyright Stat Line 4325  Intellectual Property and Copyright Stat
4325  <p>SET CHANNEL AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;audio-out&gt; &lt;audio-in&gt;  <p>SET CHANNEL AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;audio-out&gt; &lt;audio-in&gt;
4326  </p>  </p>
4327  </blockquote><p>  </blockquote><p>
4328                        
4329  </p>  </p>
4330  <p>Where &lt;sampler-chan&gt; is the sampler channel number  <p>Where &lt;sampler-chan&gt; is the sampler channel number
4331                      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>
4332                      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
4333                      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
4334                      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
4335                      output device where &lt;audio-out&gt; should be routed to.                      output device where &lt;audio-out&gt; should be routed to.
# Line 4107  Intellectual Property and Copyright Stat Line 4344  Intellectual Property and Copyright Stat
4344  <blockquote class="text">  <blockquote class="text">
4345  <p>on success  <p>on success
4346  </p>  </p>
4347  </blockquote><p>  </blockquote>
4348                                
4349    
 </p>  
4350  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4351                                  </p>                                  </p>
4352  <blockquote class="text">  <blockquote class="text">
# Line 4117  Intellectual Property and Copyright Stat Line 4354  Intellectual Property and Copyright Stat
4354                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4355                                      warning message                                      warning message
4356  </p>  </p>
4357  </blockquote><p>  </blockquote>
4358                                
4359    
 </p>  
4360  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4361                                  </p>                                  </p>
4362  <blockquote class="text">  <blockquote class="text">
4363  <p>in case it failed, providing an appropriate error code and error message  <p>in case it failed, providing an appropriate error code and error message
4364  </p>  </p>
4365  </blockquote><p>  </blockquote>
4366                                
4367    
 </p>  
4368  </blockquote><p>  </blockquote><p>
4369                        
4370  </p>  </p>
4371  <p>Examples:  <p>Examples:
4372  </p>  </p>
# Line 4139  Intellectual Property and Copyright Stat Line 4376  Intellectual Property and Copyright Stat
4376  <p>  <p>
4377  </p>  </p>
4378  </blockquote><p>  </blockquote><p>
4379                        
4380  </p>  </p>
4381  <a name="rfc.section.6.4.17"></a><h4><a name="SET CHANNEL MIDI_INPUT_DEVICE">6.4.17</a>&nbsp;Setting MIDI input device</h4>  <a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr />
4382    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4383    <a name="rfc.section.6.4.17"></a><h3>6.4.17.&nbsp;
4384    Setting MIDI input device</h3>
4385    
4386  <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
4387                      channel by sending the following command:                      channel by sending the following command:
# Line 4152  Intellectual Property and Copyright Stat Line 4392  Intellectual Property and Copyright Stat
4392  <p>SET CHANNEL MIDI_INPUT_DEVICE &lt;sampler-channel&gt; &lt;midi-device-id&gt;  <p>SET CHANNEL MIDI_INPUT_DEVICE &lt;sampler-channel&gt; &lt;midi-device-id&gt;
4393  </p>  </p>
4394  </blockquote><p>  </blockquote><p>
4395                        
4396  </p>  </p>
4397  <p>Where &lt;sampler-channel&gt; is the sampler channel number  <p>Where &lt;sampler-channel&gt; is the sampler channel number
4398                      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>
4399                      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
4400                      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
4401                      <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>
4402                      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.
4403  </p>  </p>
4404  <p>Possible Answers:  <p>Possible Answers:
4405  </p>  </p>
# Line 4171  Intellectual Property and Copyright Stat Line 4411  Intellectual Property and Copyright Stat
4411  <blockquote class="text">  <blockquote class="text">
4412  <p>on success  <p>on success
4413  </p>  </p>
4414  </blockquote><p>  </blockquote>
4415                                
4416    
 </p>  
4417  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4418                                  </p>                                  </p>
4419  <blockquote class="text">  <blockquote class="text">
# Line 4181  Intellectual Property and Copyright Stat Line 4421  Intellectual Property and Copyright Stat
4421                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4422                                      warning message                                      warning message
4423  </p>  </p>
4424  </blockquote><p>  </blockquote>
4425                                
4426    
 </p>  
4427  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4428                                  </p>                                  </p>
4429  <blockquote class="text">  <blockquote class="text">
4430  <p>in case it failed, providing an appropriate error code and error message  <p>in case it failed, providing an appropriate error code and error message
4431  </p>  </p>
4432  </blockquote><p>  </blockquote>
4433                                
4434    
 </p>  
4435  </blockquote><p>  </blockquote><p>
4436                        
4437  </p>  </p>
4438  <p>Examples:  <p>Examples:
4439  </p>  </p>
# Line 4203  Intellectual Property and Copyright Stat Line 4443  Intellectual Property and Copyright Stat
4443  <p>  <p>
4444  </p>  </p>
4445  </blockquote><p>  </blockquote><p>
4446                        
4447  </p>  </p>
4448  <a name="rfc.section.6.4.18"></a><h4><a name="SET CHANNEL MIDI_INPUT_TYPE">6.4.18</a>&nbsp;Setting MIDI input type</h4>  <a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr />
4449    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4450    <a name="rfc.section.6.4.18"></a><h3>6.4.18.&nbsp;
4451    Setting MIDI input type</h3>
4452    
4453  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
4454  </p>  </p>
# Line 4218  Intellectual Property and Copyright Stat Line 4461  Intellectual Property and Copyright Stat
4461  <p>SET CHANNEL MIDI_INPUT_TYPE &lt;sampler-channel&gt; &lt;midi-input-type&gt;  <p>SET CHANNEL MIDI_INPUT_TYPE &lt;sampler-channel&gt; &lt;midi-input-type&gt;
4462  </p>  </p>
4463  </blockquote><p>  </blockquote><p>
4464                        
4465  </p>  </p>
4466  <p>Where &lt;midi-input-type&gt; is currently only "ALSA" and  <p>Where &lt;midi-input-type&gt; is currently only "ALSA" and
4467                      &lt;sampler-channel&gt; is the respective sampler channel number.                      &lt;sampler-channel&gt; is the respective sampler channel number.
# Line 4233  Intellectual Property and Copyright Stat Line 4476  Intellectual Property and Copyright Stat
4476  <blockquote class="text">  <blockquote class="text">
4477  <p>on success  <p>on success
4478  </p>  </p>
4479  </blockquote><p>  </blockquote>
4480                                
4481    
 </p>  
4482  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4483                                  </p>                                  </p>
4484  <blockquote class="text">  <blockquote class="text">
# Line 4243  Intellectual Property and Copyright Stat Line 4486  Intellectual Property and Copyright Stat
4486                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4487                                      warning message                                      warning message
4488  </p>  </p>
4489  </blockquote><p>  </blockquote>
4490                                
4491    
 </p>  
4492  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4493                                  </p>                                  </p>
4494  <blockquote class="text">  <blockquote class="text">
4495  <p>in case it failed, providing an appropriate error code and error message  <p>in case it failed, providing an appropriate error code and error message
4496  </p>  </p>
4497  </blockquote><p>  </blockquote>
4498                                
4499    
 </p>  
4500  </blockquote><p>  </blockquote><p>
4501                        
4502  </p>  </p>
4503  <p>Examples:  <p>Examples:
4504  </p>  </p>
# Line 4265  Intellectual Property and Copyright Stat Line 4508  Intellectual Property and Copyright Stat
4508  <p>  <p>
4509  </p>  </p>
4510  </blockquote><p>  </blockquote><p>
4511                        
4512  </p>  </p>
4513  <a name="rfc.section.6.4.19"></a><h4><a name="SET CHANNEL MIDI_INPUT_PORT">6.4.19</a>&nbsp;Setting MIDI input port</h4>  <a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr />
4514    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4515    <a name="rfc.section.6.4.19"></a><h3>6.4.19.&nbsp;
4516    Setting MIDI input port</h3>
4517    
4518  <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
4519                      channel by sending the following command:                      channel by sending the following command:
# Line 4278  Intellectual Property and Copyright Stat Line 4524  Intellectual Property and Copyright Stat
4524  <p>SET CHANNEL MIDI_INPUT_PORT &lt;sampler-channel&gt; &lt;midi-input-port&gt;  <p>SET CHANNEL MIDI_INPUT_PORT &lt;sampler-channel&gt; &lt;midi-input-port&gt;
4525  </p>  </p>
4526  </blockquote><p>  </blockquote><p>
4527                        
4528  </p>  </p>
4529  <p>Where &lt;midi-input-port&gt; is a MIDI input port number of the  <p>Where &lt;midi-input-port&gt; is a MIDI input port number of the
4530                      MIDI input device connected to the sampler channel given by                      MIDI input device connected to the sampler channel given by
# Line 4294  Intellectual Property and Copyright Stat Line 4540  Intellectual Property and Copyright Stat
4540  <blockquote class="text">  <blockquote class="text">
4541  <p>on success  <p>on success
4542  </p>  </p>
4543  </blockquote><p>  </blockquote>
4544                                
4545    
 </p>  
4546  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4547                                  </p>                                  </p>
4548  <blockquote class="text">  <blockquote class="text">
# Line 4304  Intellectual Property and Copyright Stat Line 4550  Intellectual Property and Copyright Stat
4550                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4551                                      warning message                                      warning message
4552  </p>  </p>
4553  </blockquote><p>  </blockquote>
4554                                
4555    
 </p>  
4556  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4557                                  </p>                                  </p>
4558  <blockquote class="text">  <blockquote class="text">
4559  <p>in case it failed, providing an appropriate error code and error message  <p>in case it failed, providing an appropriate error code and error message
4560  </p>  </p>
4561  </blockquote><p>  </blockquote>
4562                                
4563    
 </p>  
4564  </blockquote><p>  </blockquote><p>
4565                        
4566  </p>  </p>
4567  <p>Examples:  <p>Examples:
4568  </p>  </p>
# Line 4326  Intellectual Property and Copyright Stat Line 4572  Intellectual Property and Copyright Stat
4572  <p>  <p>
4573  </p>  </p>
4574  </blockquote><p>  </blockquote><p>
4575                        
4576  </p>  </p>
4577  <a name="rfc.section.6.4.20"></a><h4><a name="SET CHANNEL MIDI_INPUT_CHANNEL">6.4.20</a>&nbsp;Setting MIDI input channel</h4>  <a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr />
4578    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4579    <a name="rfc.section.6.4.20"></a><h3>6.4.20.&nbsp;
4580    Setting MIDI input channel</h3>
4581    
4582  <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
4583                      listen to by sending the following command:                      listen to by sending the following command:
# Line 4339  Intellectual Property and Copyright Stat Line 4588  Intellectual Property and Copyright Stat
4588  <p>SET CHANNEL MIDI_INPUT_CHANNEL &lt;sampler-channel&gt; &lt;midi-input-chan&gt;  <p>SET CHANNEL MIDI_INPUT_CHANNEL &lt;sampler-channel&gt; &lt;midi-input-chan&gt;
4589  </p>  </p>
4590  </blockquote><p>  </blockquote><p>
4591                        
4592  </p>  </p>
4593  <p>Where &lt;midi-input-chan&gt; is the number of the new MIDI input channel where  <p>Where &lt;midi-input-chan&gt; is the number of the new MIDI input channel where
4594                      &lt;sampler-channel&gt; should listen to or "ALL" to listen on all 16 MIDI                      &lt;sampler-channel&gt; should listen to or "ALL" to listen on all 16 MIDI
# Line 4355  Intellectual Property and Copyright Stat Line 4604  Intellectual Property and Copyright Stat
4604  <blockquote class="text">  <blockquote class="text">
4605  <p>on success  <p>on success
4606  </p>  </p>
4607  </blockquote><p>  </blockquote>
4608                                
4609    
 </p>  
4610  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4611                                  </p>                                  </p>
4612  <blockquote class="text">  <blockquote class="text">
# Line 4365  Intellectual Property and Copyright Stat Line 4614  Intellectual Property and Copyright Stat
4614                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4615                                      warning message                                      warning message
4616  </p>  </p>
4617  </blockquote><p>  </blockquote>
4618                                
4619    
 </p>  
4620  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4621                                  </p>                                  </p>
4622  <blockquote class="text">  <blockquote class="text">
4623  <p>in case it failed, providing an appropriate error code and error message  <p>in case it failed, providing an appropriate error code and error message
4624  </p>  </p>
4625  </blockquote><p>  </blockquote>
4626                                
4627    
 </p>  
4628  </blockquote><p>  </blockquote><p>
4629                        
4630  </p>  </p>
4631  <p>Examples:  <p>Examples:
4632  </p>  </p>
# Line 4387  Intellectual Property and Copyright Stat Line 4636  Intellectual Property and Copyright Stat
4636  <p>  <p>
4637  </p>  </p>
4638  </blockquote><p>  </blockquote><p>
4639                        
4640  </p>  </p>
4641  <a name="rfc.section.6.4.21"></a><h4><a name="SET CHANNEL VOLUME">6.4.21</a>&nbsp;Setting channel volume</h4>  <a name="SET CHANNEL VOLUME"></a><br /><hr />
4642    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4643    <a name="rfc.section.6.4.21"></a><h3>6.4.21.&nbsp;
4644    Setting channel volume</h3>
4645    
4646  <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
4647                      the following command:                      the following command:
# Line 4400  Intellectual Property and Copyright Stat Line 4652  Intellectual Property and Copyright Stat
4652  <p>SET CHANNEL VOLUME &lt;sampler-channel&gt; &lt;volume&gt;  <p>SET CHANNEL VOLUME &lt;sampler-channel&gt; &lt;volume&gt;
4653  </p>  </p>
4654  </blockquote><p>  </blockquote><p>
4655                        
4656  </p>  </p>
4657  <p>Where &lt;volume&gt; is an optionally dotted positive number (a value  <p>Where &lt;volume&gt; is an optionally dotted positive number (a value
4658                      smaller than 1.0 means attenuation, whereas a value greater than                      smaller than 1.0 means attenuation, whereas a value greater than
# Line 4417  Intellectual Property and Copyright Stat Line 4669  Intellectual Property and Copyright Stat
4669  <blockquote class="text">  <blockquote class="text">
4670  <p>on success  <p>on success
4671  </p>  </p>
4672  </blockquote><p>  </blockquote>
4673                                
4674    
 </p>  
4675  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4676                                  </p>                                  </p>
4677  <blockquote class="text">  <blockquote class="text">
# Line 4427  Intellectual Property and Copyright Stat Line 4679  Intellectual Property and Copyright Stat
4679                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4680                                      warning message                                      warning message
4681  </p>  </p>
4682  </blockquote><p>  </blockquote>
4683                                
4684    
 </p>  
4685  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4686                                  </p>                                  </p>
4687  <blockquote class="text">  <blockquote class="text">
4688  <p>in case it failed, providing an appropriate error code and error message  <p>in case it failed, providing an appropriate error code and error message
4689  </p>  </p>
4690  </blockquote><p>  </blockquote>
4691                                
4692    
 </p>  
4693  </blockquote><p>  </blockquote><p>
4694                        
4695  </p>  </p>
4696  <p>Examples:  <p>Examples:
4697  </p>  </p>
# Line 4449  Intellectual Property and Copyright Stat Line 4701  Intellectual Property and Copyright Stat
4701  <p>  <p>
4702  </p>  </p>
4703  </blockquote><p>  </blockquote><p>
4704                        
4705  </p>  </p>
4706  <a name="rfc.section.6.4.22"></a><h4><a name="SET CHANNEL MUTE">6.4.22</a>&nbsp;Muting a sampler channel</h4>  <a name="SET CHANNEL MUTE"></a><br /><hr />
4707    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4708    <a name="rfc.section.6.4.22"></a><h3>6.4.22.&nbsp;
4709    Muting a sampler channel</h3>
4710    
4711  <p>The front-end can mute/unmute a specific sampler  <p>The front-end can mute/unmute a specific sampler
4712                      channel by sending the following command:                      channel by sending the following command:
# Line 4462  Intellectual Property and Copyright Stat Line 4717  Intellectual Property and Copyright Stat
4717  <p>SET CHANNEL MUTE &lt;sampler-channel&gt; &lt;mute&gt;  <p>SET CHANNEL MUTE &lt;sampler-channel&gt; &lt;mute&gt;
4718  </p>  </p>
4719  </blockquote><p>  </blockquote><p>
4720                        
4721  </p>  </p>
4722  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4723                      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>
4724                      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
4725                      &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"
4726                      to unmute the channel.                      to unmute the channel.
4727  </p>  </p>
# Line 4480  Intellectual Property and Copyright Stat Line 4735  Intellectual Property and Copyright Stat
4735  <blockquote class="text">  <blockquote class="text">
4736  <p>on success  <p>on success
4737  </p>  </p>
4738  </blockquote><p>  </blockquote>
4739                                
4740    
 </p>  
4741  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4742                                  </p>                                  </p>
4743  <blockquote class="text">  <blockquote class="text">
# Line 4490  Intellectual Property and Copyright Stat Line 4745  Intellectual Property and Copyright Stat
4745                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4746                                      warning message                                      warning message
4747  </p>  </p>
4748  </blockquote><p>  </blockquote>
4749                                
4750    
 </p>  
4751  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4752                                  </p>                                  </p>
4753  <blockquote class="text">  <blockquote class="text">
4754  <p>in case it failed, providing an appropriate error code and error message  <p>in case it failed, providing an appropriate error code and error message
4755  </p>  </p>
4756  </blockquote><p>  </blockquote>
4757                                
4758    
 </p>  
4759  </blockquote><p>  </blockquote><p>
4760                        
4761  </p>  </p>
4762  <p>Examples:  <p>Examples:
4763  </p>  </p>
# Line 4512  Intellectual Property and Copyright Stat Line 4767  Intellectual Property and Copyright Stat
4767  <p>  <p>
4768  </p>  </p>
4769  </blockquote><p>  </blockquote><p>
4770                        
4771  </p>  </p>
4772  <a name="rfc.section.6.4.23"></a><h4><a name="SET CHANNEL SOLO">6.4.23</a>&nbsp;Soloing a sampler channel</h4>  <a name="SET CHANNEL SOLO"></a><br /><hr />
4773    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4774    <a name="rfc.section.6.4.23"></a><h3>6.4.23.&nbsp;
4775    Soloing a sampler channel</h3>
4776    
4777  <p>The front-end can solo/unsolo a specific sampler channel  <p>The front-end can solo/unsolo a specific sampler channel
4778                      by sending the following command:                      by sending the following command:
# Line 4525  Intellectual Property and Copyright Stat Line 4783  Intellectual Property and Copyright Stat
4783  <p>SET CHANNEL SOLO &lt;sampler-channel&gt; &lt;solo&gt;  <p>SET CHANNEL SOLO &lt;sampler-channel&gt; &lt;solo&gt;
4784  </p>  </p>
4785  </blockquote><p>  </blockquote><p>
4786                        
4787  </p>  </p>
4788  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4789                      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>
4790                      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
4791                      &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"
4792                      to unsolo the channel.                      to unsolo the channel.
4793  </p>  </p>
# Line 4543  Intellectual Property and Copyright Stat Line 4801  Intellectual Property and Copyright Stat
4801  <blockquote class="text">  <blockquote class="text">
4802  <p>on success  <p>on success
4803  </p>  </p>
4804  </blockquote><p>  </blockquote>
4805                                
4806    
 </p>  
4807  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4808                                  </p>                                  </p>
4809  <blockquote class="text">  <blockquote class="text">
# Line 4553  Intellectual Property and Copyright Stat Line 4811  Intellectual Property and Copyright Stat
4811                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4812                                      warning message                                      warning message
4813  </p>  </p>
4814  </blockquote><p>  </blockquote>
4815                                
4816    
 </p>  
4817  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4818                                  </p>                                  </p>
4819  <blockquote class="text">  <blockquote class="text">
4820  <p>in case it failed, providing an appropriate error code and error message  <p>in case it failed, providing an appropriate error code and error message
4821  </p>  </p>
4822    </blockquote>
4823                                
4824    
4825  </blockquote><p>  </blockquote><p>
4826                        
4827    </p>
4828    <p>Examples:
4829    </p>
4830    <p>
4831                            </p>
4832    <blockquote class="text">
4833    <p>
4834    </p>
4835    </blockquote><p>
4836                        
4837    </p>
4838    <a name="SET CHANNEL MIDI_INSTRUMENT_MAP"></a><br /><hr />
4839    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4840    <a name="rfc.section.6.4.24"></a><h3>6.4.24.&nbsp;
4841    Assigning a MIDI instrument map to a sampler channel</h3>
4842    
4843    <p>The front-end can assign a MIDI instrument map to a specific sampler channel
4844                        by sending the following command:
4845    </p>
4846    <p>
4847                            </p>
4848    <blockquote class="text">
4849    <p>SET CHANNEL MIDI_INSTRUMENT_MAP &lt;sampler-channel&gt; &lt;map&gt;
4850    </p>
4851    </blockquote><p>
4852                        
4853    </p>
4854    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4855                        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>
4856                        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
4857                        &lt;map&gt; can have the following possibilites:
4858    </p>
4859    <p>
4860                            </p>
4861    <blockquote class="text">
4862    <p>"NONE" -
4863                                    </p>
4864    <blockquote class="text">
4865    <p>This is the default setting. In this case
4866                                        the sampler channel is not assigned any MIDI
4867                                        instrument map and thus will ignore all MIDI
4868                                        program change messages.
4869    </p>
4870    </blockquote>
4871                                
4872    
4873    <p>"DEFAULT" -
4874                                    </p>
4875    <blockquote class="text">
4876    <p>The sampler channel will always use the
4877                                        default MIDI instrument map to handle MIDI
4878                                        program change messages.
4879    </p>
4880    </blockquote>
4881                                
4882    
4883    <p>numeric ID -
4884                                    </p>
4885    <blockquote class="text">
4886    <p>You can assign a specific MIDI instrument map
4887                                        by replacing &lt;map&gt; with the respective numeric
4888                                        ID of the MIDI instrument map as returned by the
4889                                        <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>
4890                                        command. Once that map will be deleted, the sampler
4891                                        channel would fall back to "NONE".
4892  </p>  </p>
4893    </blockquote>
4894                                
4895    
4896  </blockquote><p>  </blockquote><p>
4897                        
4898    </p>
4899    <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>
4900                        for details regarding MIDI instrument mapping.
4901    </p>
4902    <p>Possible Answers:
4903    </p>
4904    <p>
4905                            </p>
4906    <blockquote class="text">
4907    <p>"OK" -
4908                                    </p>
4909    <blockquote class="text">
4910    <p>on success
4911    </p>
4912    </blockquote>
4913                                
4914    
4915    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4916                                    </p>
4917    <blockquote class="text">
4918    <p>in case it failed, providing an appropriate error code and error message
4919    </p>
4920    </blockquote>
4921                                
4922    
4923    </blockquote><p>
4924                        
4925  </p>  </p>
4926  <p>Examples:  <p>Examples:
4927  </p>  </p>
# Line 4575  Intellectual Property and Copyright Stat Line 4931  Intellectual Property and Copyright Stat
4931  <p>  <p>
4932  </p>  </p>
4933  </blockquote><p>  </blockquote><p>
4934                        
4935  </p>  </p>
4936  <a name="rfc.section.6.4.24"></a><h4><a name="RESET CHANNEL">6.4.24</a>&nbsp;Resetting a sampler channel</h4>  <a name="RESET CHANNEL"></a><br /><hr />
4937    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4938    <a name="rfc.section.6.4.25"></a><h3>6.4.25.&nbsp;
4939    Resetting a sampler channel</h3>
4940    
4941  <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:
4942  </p>  </p>
# Line 4587  Intellectual Property and Copyright Stat Line 4946  Intellectual Property and Copyright Stat
4946  <p>RESET CHANNEL &lt;sampler-channel&gt;  <p>RESET CHANNEL &lt;sampler-channel&gt;
4947  </p>  </p>
4948  </blockquote><p>  </blockquote><p>
4949                        
4950  </p>  </p>
4951  <p>  <p>
4952                      Where &lt;sampler-channel&gt; defines the sampler channel to be reset.                      Where &lt;sampler-channel&gt; defines the sampler channel to be reset.
# Line 4605  Intellectual Property and Copyright Stat Line 4964  Intellectual Property and Copyright Stat
4964  <blockquote class="text">  <blockquote class="text">
4965  <p>on success  <p>on success
4966  </p>  </p>
4967  </blockquote><p>  </blockquote>
4968                                
4969    
 </p>  
4970  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4971                                  </p>                                  </p>
4972  <blockquote class="text">  <blockquote class="text">
# Line 4615  Intellectual Property and Copyright Stat Line 4974  Intellectual Property and Copyright Stat
4974                                      related, providing an appropriate warning code and warning                                      related, providing an appropriate warning code and warning
4975                                      message                                      message
4976  </p>  </p>
4977  </blockquote><p>  </blockquote>
4978                                
4979    
 </p>  
4980  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4981                                  </p>                                  </p>
4982  <blockquote class="text">  <blockquote class="text">
4983  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
4984                                      error message                                      error message
4985  </p>  </p>
4986  </blockquote><p>  </blockquote>
4987                                
4988    
 </p>  
4989  </blockquote><p>  </blockquote><p>
4990                        
4991  </p>  </p>
4992  <p>Examples:  <p>Examples:
4993  </p>  </p>
# Line 4638  Intellectual Property and Copyright Stat Line 4997  Intellectual Property and Copyright Stat
4997  <p>  <p>
4998  </p>  </p>
4999  </blockquote><p>  </blockquote><p>
5000                        
5001  </p>  </p>
5002  <a name="rfc.section.6.5"></a><h4><a name="anchor12">6.5</a>&nbsp;Controlling connection</h4>  <a name="anchor12"></a><br /><hr />
5003    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5004    <a name="rfc.section.6.5"></a><h3>6.5.&nbsp;
5005    Controlling connection</h3>
5006    
5007  <p>The following commands are used to control the connection to LinuxSampler.  <p>The following commands are used to control the connection to LinuxSampler.
5008  </p>  </p>
5009  <a name="rfc.section.6.5.1"></a><h4><a name="SUBSCRIBE">6.5.1</a>&nbsp;Register front-end for receiving event messages</h4>  <a name="SUBSCRIBE"></a><br /><hr />
5010    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5011    <a name="rfc.section.6.5.1"></a><h3>6.5.1.&nbsp;
5012    Register front-end for receiving event messages</h3>
5013    
5014  <p>The front-end can register itself to the LinuxSampler application to  <p>The front-end can register itself to the LinuxSampler application to
5015                      be informed about noteworthy events by sending this command:                      be informed about noteworthy events by sending this command:
# Line 4655  Intellectual Property and Copyright Stat Line 5020  Intellectual Property and Copyright Stat
5020  <p>SUBSCRIBE &lt;event-id&gt;  <p>SUBSCRIBE &lt;event-id&gt;
5021  </p>  </p>
5022  </blockquote><p>  </blockquote><p>
5023                        
5024  </p>  </p>
5025  <p>where &lt;event-id&gt; will be replaced by the respective event that  <p>where &lt;event-id&gt; will be replaced by the respective event that
5026                      client wants to subscribe to.                      client wants to subscribe to.
# Line 4670  Intellectual Property and Copyright Stat Line 5035  Intellectual Property and Copyright Stat
5035  <blockquote class="text">  <blockquote class="text">
5036  <p>on success  <p>on success
5037  </p>  </p>
5038  </blockquote><p>  </blockquote>
5039                                
5040    
 </p>  
5041  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5042                                  </p>                                  </p>
5043  <blockquote class="text">  <blockquote class="text">
# Line 4680  Intellectual Property and Copyright Stat Line 5045  Intellectual Property and Copyright Stat
5045                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
5046                                      warning message                                      warning message
5047  </p>  </p>
5048  </blockquote><p>  </blockquote>
5049                                
5050    
 </p>  
5051  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5052                                  </p>                                  </p>
5053  <blockquote class="text">  <blockquote class="text">
5054  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
5055                                      error message                                      error message
5056  </p>  </p>
5057  </blockquote><p>  </blockquote>
5058                                
5059    
 </p>  
5060  </blockquote><p>  </blockquote><p>
5061                        
5062  </p>  </p>
5063  <p>Examples:  <p>Examples:
5064  </p>  </p>
# Line 4703  Intellectual Property and Copyright Stat Line 5068  Intellectual Property and Copyright Stat
5068  <p>  <p>
5069  </p>  </p>
5070  </blockquote><p>  </blockquote><p>
5071                        
5072  </p>  </p>
5073  <a name="rfc.section.6.5.2"></a><h4><a name="UNSUBSCRIBE">6.5.2</a>&nbsp;Unregister front-end for not receiving event messages</h4>  <a name="UNSUBSCRIBE"></a><br /><hr />
5074    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5075    <a name="rfc.section.6.5.2"></a><h3>6.5.2.&nbsp;
5076    Unregister front-end for not receiving event messages</h3>
5077    
5078  <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
5079                      messages anymore by sending the following command:                      messages anymore by sending the following command:
# Line 4716  Intellectual Property and Copyright Stat Line 5084  Intellectual Property and Copyright Stat
5084  <p>UNSUBSCRIBE &lt;event-id&gt;  <p>UNSUBSCRIBE &lt;event-id&gt;
5085  </p>  </p>
5086  </blockquote><p>  </blockquote><p>
5087                        
5088  </p>  </p>
5089  <p>Where &lt;event-id&gt; will be replaced by the respective event that  <p>Where &lt;event-id&gt; will be replaced by the respective event that
5090                      client doesn't want to receive anymore.                      client doesn't want to receive anymore.
# Line 4731  Intellectual Property and Copyright Stat Line 5099  Intellectual Property and Copyright Stat
5099  <blockquote class="text">  <blockquote class="text">
5100  <p>on success  <p>on success
5101  </p>  </p>
5102  </blockquote><p>  </blockquote>
5103                                
5104    
 </p>  
5105  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5106                                  </p>                                  </p>
5107  <blockquote class="text">  <blockquote class="text">
# Line 4741  Intellectual Property and Copyright Stat Line 5109  Intellectual Property and Copyright Stat
5109                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
5110                                      warning message                                      warning message
5111  </p>  </p>
5112  </blockquote><p>  </blockquote>
5113                                
5114    
 </p>  
5115  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5116                                  </p>                                  </p>
5117  <blockquote class="text">  <blockquote class="text">
5118  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
5119                                      error message                                      error message
5120  </p>  </p>
5121  </blockquote><p>  </blockquote>
5122                                
5123    
 </p>  
5124  </blockquote><p>  </blockquote><p>
5125                        
5126  </p>  </p>
5127  <p>Examples:  <p>Examples:
5128  </p>  </p>
# Line 4764  Intellectual Property and Copyright Stat Line 5132  Intellectual Property and Copyright Stat
5132  <p>  <p>
5133  </p>  </p>
5134  </blockquote><p>  </blockquote><p>
5135                        
5136  </p>  </p>
5137  <a name="rfc.section.6.5.3"></a><h4><a name="SET ECHO">6.5.3</a>&nbsp;Enable or disable echo of commands</h4>  <a name="SET ECHO"></a><br /><hr />
5138    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5139    <a name="rfc.section.6.5.3"></a><h3>6.5.3.&nbsp;
5140    Enable or disable echo of commands</h3>
5141    
5142  <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:
5143  </p>  </p>
# Line 4776  Intellectual Property and Copyright Stat Line 5147  Intellectual Property and Copyright Stat
5147  <p>SET ECHO &lt;value&gt;  <p>SET ECHO &lt;value&gt;
5148  </p>  </p>
5149  </blockquote><p>  </blockquote><p>
5150                        
5151  </p>  </p>
5152  <p>Where &lt;value&gt; should be replaced either by "1" to enable echo mode  <p>Where &lt;value&gt; should be replaced either by "1" to enable echo mode
5153                      or "0" to disable echo mode. When echo mode is enabled, all                      or "0" to disable echo mode. When echo mode is enabled, all
# Line 4796  Intellectual Property and Copyright Stat Line 5167  Intellectual Property and Copyright Stat
5167  <blockquote class="text">  <blockquote class="text">
5168  <p>usually  <p>usually
5169  </p>  </p>
5170  </blockquote><p>  </blockquote>
5171                                
5172    
 </p>  
5173  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5174                                  </p>                                  </p>
5175  <blockquote class="text">  <blockquote class="text">
5176  <p>on syntax error, e.g. non boolean value  <p>on syntax error, e.g. non boolean value
5177  </p>  </p>
5178  </blockquote><p>  </blockquote>
5179                                
5180    
 </p>  
5181  </blockquote><p>  </blockquote><p>
5182                        
5183  </p>  </p>
5184  <p>Examples:  <p>Examples:
5185  </p>  </p>
# Line 4818  Intellectual Property and Copyright Stat Line 5189  Intellectual Property and Copyright Stat
5189  <p>  <p>
5190  </p>  </p>
5191  </blockquote><p>  </blockquote><p>
5192                        
5193  </p>  </p>
5194  <a name="rfc.section.6.5.4"></a><h4><a name="QUIT">6.5.4</a>&nbsp;Close client connection</h4>  <a name="QUIT"></a><br /><hr />
5195    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5196    <a name="rfc.section.6.5.4"></a><h3>6.5.4.&nbsp;
5197    Close client connection</h3>
5198    
5199  <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:
5200  </p>  </p>
# Line 4830  Intellectual Property and Copyright Stat Line 5204  Intellectual Property and Copyright Stat
5204  <p>QUIT  <p>QUIT
5205  </p>  </p>
5206  </blockquote><p>  </blockquote><p>
5207                        
5208  </p>  </p>
5209  <p>This is probably more interesting for manual telnet connections to  <p>This is probably more interesting for manual telnet connections to
5210                      LinuxSampler than really useful for a front-end implementation.                      LinuxSampler than really useful for a front-end implementation.
5211  </p>  </p>
5212  <a name="rfc.section.6.6"></a><h4><a name="anchor13">6.6</a>&nbsp;Global commands</h4>  <a name="anchor13"></a><br /><hr />
5213    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5214    <a name="rfc.section.6.6"></a><h3>6.6.&nbsp;
5215    Global commands</h3>
5216    
5217  <p>The following commands have global impact on the sampler.  <p>The following commands have global impact on the sampler.
5218  </p>  </p>
5219  <a name="rfc.section.6.6.1"></a><h4><a name="RESET">6.6.1</a>&nbsp;Reset sampler</h4>  <a name="GET TOTAL_VOICE_COUNT"></a><br /><hr />
5220    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5221    <a name="rfc.section.6.6.1"></a><h3>6.6.1.&nbsp;
5222    Current number of active voices</h3>
5223    
5224    <p>The front-end can ask for the current number of active voices on
5225                        the sampler by sending the following command:
5226    </p>
5227    <p>
5228                            </p>
5229    <blockquote class="text">
5230    <p>GET TOTAL_VOICE_COUNT
5231    </p>
5232    </blockquote><p>
5233                        
5234    </p>
5235    <p>Possible Answers:
5236    </p>
5237    <p>
5238                            </p>
5239    <blockquote class="text">
5240    <p>LinuxSampler will answer by returning the number of all active
5241                                voices on the sampler.
5242    </p>
5243    </blockquote><p>
5244                        
5245    </p>
5246    <a name="GET TOTAL_VOICE_COUNT_MAX"></a><br /><hr />
5247    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5248    <a name="rfc.section.6.6.2"></a><h3>6.6.2.&nbsp;
5249    Maximum amount of active voices</h3>
5250    
5251    <p>The front-end can ask for the maximum number of active voices
5252                        by sending the following command:
5253    </p>
5254    <p>
5255                            </p>
5256    <blockquote class="text">
5257    <p>GET TOTAL_VOICE_COUNT_MAX
5258    </p>
5259    </blockquote><p>
5260                        
5261    </p>
5262    <p>Possible Answers:
5263    </p>
5264    <p>
5265                            </p>
5266    <blockquote class="text">
5267    <p>LinuxSampler will answer by returning the maximum number
5268                                of active voices.
5269    </p>
5270    </blockquote><p>
5271                        
5272    </p>
5273    <a name="RESET"></a><br /><hr />
5274    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5275    <a name="rfc.section.6.6.3"></a><h3>6.6.3.&nbsp;
5276    Reset sampler</h3>
5277    
5278  <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:
5279  </p>  </p>
# Line 4849  Intellectual Property and Copyright Stat Line 5283  Intellectual Property and Copyright Stat
5283  <p>RESET  <p>RESET
5284  </p>  </p>
5285  </blockquote><p>  </blockquote><p>
5286                        
5287  </p>  </p>
5288  <p>Possible Answers:  <p>Possible Answers:
5289  </p>  </p>
# Line 4861  Intellectual Property and Copyright Stat Line 5295  Intellectual Property and Copyright Stat
5295  <blockquote class="text">  <blockquote class="text">
5296  <p>always  <p>always
5297  </p>  </p>
5298  </blockquote><p>  </blockquote>
5299                                
5300    
 </p>  
5301  </blockquote><p>  </blockquote><p>
5302                        
5303  </p>  </p>
5304  <p>Examples:  <p>Examples:
5305  </p>  </p>
# Line 4875  Intellectual Property and Copyright Stat Line 5309  Intellectual Property and Copyright Stat
5309  <p>  <p>
5310  </p>  </p>
5311  </blockquote><p>  </blockquote><p>
5312                        
5313  </p>  </p>
5314  <a name="rfc.section.6.6.2"></a><h4><a name="GET SERVER INFO">6.6.2</a>&nbsp;General sampler informations</h4>  <a name="GET SERVER INFO"></a><br /><hr />
5315    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5316    <a name="rfc.section.6.6.4"></a><h3>6.6.4.&nbsp;
5317    General sampler informations</h3>
5318    
5319  <p>The client can ask for general informations about the LinuxSampler  <p>The client can ask for general informations about the LinuxSampler
5320                         instance by sending the following command:                         instance by sending the following command:
# Line 4888  Intellectual Property and Copyright Stat Line 5325  Intellectual Property and Copyright Stat
5325  <p>GET SERVER INFO  <p>GET SERVER INFO
5326  </p>  </p>
5327  </blockquote><p>  </blockquote><p>
5328                        
5329  </p>  </p>
5330  <p>Possible Answers:  <p>Possible Answers:
5331  </p>  </p>
# Line 4900  Intellectual Property and Copyright Stat Line 5337  Intellectual Property and Copyright Stat
5337                                 followed by a colon and then a space character &lt;SP&gt; and finally                                 followed by a colon and then a space character &lt;SP&gt; and finally
5338                                 the info character string to that information category. At the                                 the info character string to that information category. At the
5339                                 moment the following categories are defined:                                 moment the following categories are defined:
5340                                
5341  </p>  </p>
5342  <p>  <p>
5343                                  </p>                                  </p>
# Line 4910  Intellectual Property and Copyright Stat Line 5347  Intellectual Property and Copyright Stat
5347  <blockquote class="text">  <blockquote class="text">
5348  <p>arbitrary textual description about the sampler  <p>arbitrary textual description about the sampler
5349  </p>  </p>
5350  </blockquote><p>  </blockquote>
5351                                        
5352    
 </p>  
5353  <p>VERSION -  <p>VERSION -
5354                                          </p>                                          </p>
5355  <blockquote class="text">  <blockquote class="text">
5356  <p>version of the sampler  <p>version of the sampler
5357  </p>  </p>
5358  </blockquote><p>  </blockquote>
5359                                        
5360    
 </p>  
5361  <p>PROTOCOL_VERSION -  <p>PROTOCOL_VERSION -
5362                                          </p>                                          </p>
5363  <blockquote class="text">  <blockquote class="text">
5364  <p>version of the LSCP specification the sampler  <p>version of the LSCP specification the sampler
5365                                              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)
5366    </p>
5367    </blockquote>
5368                                        
5369    
5370    </blockquote>
5371                                
5372    
5373    </blockquote><p>
5374                        
5375    </p>
5376    <p>The mentioned fields above don't have to be in particular order.
5377                        Other fields might be added in future.
5378    </p>
5379    <a name="MIDI Instrument Mapping"></a><br /><hr />
5380    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5381    <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;
5382    MIDI Instrument Mapping</h3>
5383    
5384    <p>The MIDI protocol provides a way to switch between instruments
5385                    by sending so called MIDI bank select and MIDI program change
5386                    messages which are essentially just numbers. The following commands
5387                    allow to actually map arbitrary MIDI bank select / program change
5388                    numbers with real instruments.
5389    </p>
5390    <p>The sampler allows to manage an arbitrary amount of MIDI
5391                    instrument maps which define which instrument to load on
5392                    which MIDI program change message.
5393    </p>
5394    <p>By default, that is when the sampler is launched, there is no
5395                    map, thus the sampler will simply ignore all program change
5396                    messages. The front-end has to explicitly create at least one
5397                    map, add entries to the map and tell the respective sampler
5398                    channel(s) which MIDI instrument map to use, so the sampler
5399                    knows how to react on a given program change message on the
5400                    respective sampler channel, that is by switching to the
5401                    respectively defined engine type and loading the respective
5402                    instrument. See command
5403                    <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>
5404                    for how to assign a MIDI instrument map to a sampler channel.
5405    </p>
5406    <p>Also note per MIDI specification a bank select message does not
5407                    cause to switch to another instrument. Instead when receiving a
5408                    bank select message the bank value will be stored and a subsequent
5409                    program change message (which may occur at any time) will finally
5410                    cause the sampler to switch to the respective instrument as
5411                    reflected by the current MIDI instrument map.
5412    </p>
5413    <a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr />
5414    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5415    <a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;
5416    Create a new MIDI instrument map</h3>
5417    
5418    <p>The front-end can add a new MIDI instrument map by sending
5419                        the following command:
5420    </p>
5421    <p>
5422                            </p>
5423    <blockquote class="text">
5424    <p>ADD MIDI_INSTRUMENT_MAP [&lt;name&gt;]
5425    </p>
5426    </blockquote><p>
5427                        
5428    </p>
5429    <p>Where &lt;name&gt; is an optional argument allowing to
5430                        assign a custom name to the new map. MIDI instrument Map
5431                        names do not have to be unique.
5432    </p>
5433    <p>Possible Answers:
5434    </p>
5435    <p>
5436                            </p>
5437    <blockquote class="text">
5438    <p>"OK[&lt;map&gt;]" -
5439                                    </p>
5440    <blockquote class="text">
5441    <p>in case a new MIDI instrument map could
5442                                        be added, where &lt;map&gt; reflects the
5443                                        unique ID of the newly created MIDI
5444                                        instrument map
5445    </p>
5446    </blockquote>
5447                                
5448    
5449    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5450                                    </p>
5451    <blockquote class="text">
5452    <p>when a new map could not be created, which
5453                                        might never occur in practice
5454    </p>
5455    </blockquote>
5456                                
5457    
5458    </blockquote><p>
5459                        
5460    </p>
5461    <p>Examples:
5462    </p>
5463    <p>
5464                            </p>
5465    <blockquote class="text">
5466    <p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
5467    </p>
5468    <p>S: "OK[0]"
5469    </p>
5470    </blockquote><p>
5471                        
5472    </p>
5473    <p>
5474                            </p>
5475    <blockquote class="text">
5476    <p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
5477    </p>
5478    <p>S: "OK[1]"
5479    </p>
5480    </blockquote><p>
5481                        
5482    </p>
5483    <p>
5484                            </p>
5485    <blockquote class="text">
5486    <p>C: "ADD MIDI_INSTRUMENT_MAP"
5487    </p>
5488    <p>S: "OK[5]"
5489    </p>
5490    </blockquote><p>
5491                        
5492    </p>
5493    <a name="REMOVE MIDI_INSTRUMENT_MAP"></a><br /><hr />
5494    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5495    <a name="rfc.section.6.7.2"></a><h3>6.7.2.&nbsp;
5496    Delete one particular or all MIDI instrument maps</h3>
5497    
5498    <p>The front-end can delete a particular MIDI instrument map
5499                        by sending the following command:
5500    </p>
5501    <p>
5502                            </p>
5503    <blockquote class="text">
5504    <p>REMOVE MIDI_INSTRUMENT_MAP &lt;map&gt;
5505    </p>
5506    </blockquote><p>
5507                        
5508    </p>
5509    <p>Where &lt;map&gt; reflects the unique ID of the map to delete
5510                        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>
5511                        command.
5512    </p>
5513    <p>The front-end can delete all MIDI instrument maps by
5514                        sending the following command:
5515    </p>
5516    <p>
5517                            </p>
5518    <blockquote class="text">
5519    <p>REMOVE MIDI_INSTRUMENT_MAP ALL
5520    </p>
5521    </blockquote><p>
5522                        
5523    </p>
5524    <p>Possible Answers:
5525    </p>
5526    <p>
5527                            </p>
5528    <blockquote class="text">
5529    <p>"OK" -
5530                                    </p>
5531    <blockquote class="text">
5532    <p>in case the map(s) could be deleted
5533    </p>
5534    </blockquote>
5535                                
5536    
5537    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5538                                    </p>
5539    <blockquote class="text">
5540    <p>when the given map does not exist
5541    </p>
5542    </blockquote>
5543                                
5544    
5545    </blockquote><p>
5546                        
5547    </p>
5548    <p>Examples:
5549    </p>
5550    <p>
5551                            </p>
5552    <blockquote class="text">
5553    <p>C: "REMOVE MIDI_INSTRUMENT_MAP 0"
5554    </p>
5555    <p>S: "OK"
5556    </p>
5557    </blockquote><p>
5558                        
5559    </p>
5560    <p>
5561                            </p>
5562    <blockquote class="text">
5563    <p>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
5564    </p>
5565    <p>S: "OK"
5566    </p>
5567    </blockquote><p>
5568                        
5569    </p>
5570    <a name="GET MIDI_INSTRUMENT_MAPS"></a><br /><hr />
5571    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5572    <a name="rfc.section.6.7.3"></a><h3>6.7.3.&nbsp;
5573    Get amount of existing MIDI instrument maps</h3>
5574    
5575    <p>The front-end can retrieve the current amount of MIDI
5576                        instrument maps by sending the following command:
5577    </p>
5578    <p>
5579                            </p>
5580    <blockquote class="text">
5581    <p>GET MIDI_INSTRUMENT_MAPS
5582    </p>
5583    </blockquote><p>
5584                        
5585    </p>
5586    <p>Possible Answers:
5587    </p>
5588    <p>
5589                            </p>
5590    <blockquote class="text">
5591    <p>The sampler will answer by returning the current
5592                                number of MIDI instrument maps.
5593    </p>
5594    </blockquote><p>
5595                        
5596    </p>
5597    <p>Example:
5598    </p>
5599    <p>
5600                            </p>
5601    <blockquote class="text">
5602    <p>C: "GET MIDI_INSTRUMENT_MAPS"
5603    </p>
5604    <p>S: "2"
5605  </p>  </p>
5606  </blockquote><p>  </blockquote><p>
5607                        
5608    </p>
5609    <a name="LIST MIDI_INSTRUMENT_MAPS"></a><br /><hr />
5610    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5611    <a name="rfc.section.6.7.4"></a><h3>6.7.4.&nbsp;
5612    Getting all created MIDI instrument maps</h3>
5613    
5614    <p>The number of MIDI instrument maps can change on runtime. To get the
5615                        current list of MIDI instrument maps, the front-end can send the
5616                        following command:
5617    </p>
5618    <p>
5619                            </p>
5620    <blockquote class="text">
5621    <p>LIST MIDI_INSTRUMENT_MAPS
5622  </p>  </p>
5623  </blockquote><p>  </blockquote><p>
5624                        
5625    </p>
5626    <p>Possible Answers:
5627    </p>
5628    <p>
5629                            </p>
5630    <blockquote class="text">
5631    <p>The sampler will answer by returning a comma separated list
5632                                with all MIDI instrument maps' numerical IDs.
5633    </p>
5634    </blockquote><p>
5635                        
5636    </p>
5637    <p>Example:
5638    </p>
5639    <p>
5640                            </p>
5641    <blockquote class="text">
5642    <p>C: "LIST MIDI_INSTRUMENT_MAPS"
5643    </p>
5644    <p>S: "0,1,5,12"
5645    </p>
5646    </blockquote><p>
5647                        
5648    </p>
5649    <a name="GET MIDI_INSTRUMENT_MAP INFO"></a><br /><hr />
5650    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5651    <a name="rfc.section.6.7.5"></a><h3>6.7.5.&nbsp;
5652    Getting MIDI instrument map information</h3>
5653    
5654    <p>The front-end can ask for the current settings of a MIDI
5655                        instrument map by sending the following command:
5656    </p>
5657    <p>
5658                            </p>
5659    <blockquote class="text">
5660    <p>GET MIDI_INSTRUMENT_MAP INFO &lt;map&gt;
5661  </p>  </p>
5662  </blockquote><p>  </blockquote><p>
5663                        
5664    </p>
5665    <p>Where &lt;map&gt; is the numerical ID of the map the
5666                        front-end is interested in as returned by the
5667                        <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>
5668                        command.
5669    </p>
5670    <p>Possible Answers:
5671    </p>
5672    <p>
5673                            </p>
5674    <blockquote class="text">
5675    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5676                                Each answer line begins with the settings category name
5677                                followed by a colon and then a space character &lt;SP&gt; and finally
5678                                the info character string to that setting category. At the
5679                                moment the following categories are defined:
5680    </p>
5681    <p>
5682                                    </p>
5683    <blockquote class="text">
5684    <p>NAME -
5685                                            </p>
5686    <blockquote class="text">
5687    <p>custom name of the given map,
5688                                                which does not have to be unique
5689    </p>
5690    </blockquote>
5691                                        
5692    
5693    </blockquote>
5694                                
5695    
5696    </blockquote><p>
5697                        
5698  </p>  </p>
5699  <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.
5700                      Other fields might be added in future.  </p>
5701    <p>Example:
5702    </p>
5703    <p>
5704                            </p>
5705    <blockquote class="text">
5706    <p>C: "GET MIDI_INSTRUMENT_MAP INFO 0"
5707    </p>
5708    <p>S: "NAME: Standard Map"
5709    </p>
5710    <p>&nbsp;&nbsp;&nbsp;"."
5711    </p>
5712    </blockquote><p>
5713                        
5714    </p>
5715    <a name="SET MIDI_INSTRUMENT_MAP NAME"></a><br /><hr />
5716    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5717    <a name="rfc.section.6.7.6"></a><h3>6.7.6.&nbsp;
5718    Renaming a MIDI instrument map</h3>
5719    
5720    <p>The front-end can alter the custom name of a MIDI
5721                        instrument map by sending the following command:
5722    </p>
5723    <p>
5724                            </p>
5725    <blockquote class="text">
5726    <p>SET MIDI_INSTRUMENT_MAP NAME &lt;map&gt; &lt;name&gt;
5727    </p>
5728    </blockquote><p>
5729                        
5730    </p>
5731    <p>Where &lt;map&gt; is the numerical ID of the map and
5732                        &lt;name&gt; the new custom name of the map, which does not
5733                        have to be unique.
5734    </p>
5735    <p>Possible Answers:
5736    </p>
5737    <p>
5738                            </p>
5739    <blockquote class="text">
5740    <p>"OK" -
5741                                    </p>
5742    <blockquote class="text">
5743    <p>on success
5744    </p>
5745    </blockquote>
5746                                
5747    
5748    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5749                                    </p>
5750    <blockquote class="text">
5751    <p>in case the given map does not exist
5752    </p>
5753    </blockquote>
5754                                
5755    
5756    </blockquote><p>
5757                        
5758    </p>
5759    <p>Example:
5760    </p>
5761    <p>
5762                            </p>
5763    <blockquote class="text">
5764    <p>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
5765    </p>
5766    <p>S: "OK"
5767    </p>
5768    </blockquote><p>
5769                        
5770    </p>
5771    <a name="MAP MIDI_INSTRUMENT"></a><br /><hr />
5772    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5773    <a name="rfc.section.6.7.7"></a><h3>6.7.7.&nbsp;
5774    Create or replace a MIDI instrument map entry</h3>
5775    
5776    <p>The front-end can create a new or replace an existing entry
5777                        in a sampler's MIDI instrument map by sending the following
5778                        command:
5779    </p>
5780    <p>
5781                            </p>
5782    <blockquote class="text">
5783    <p>MAP MIDI_INSTRUMENT &lt;map&gt;
5784                                &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
5785                                &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
5786                                [&lt;instr_load_mode&gt;] [&lt;name&gt;]
5787    </p>
5788    </blockquote><p>
5789                        
5790    </p>
5791    <p>Where &lt;map&gt; is the numeric ID of the map to alter,
5792                        &lt;midi_bank&gt; is an integer value between
5793                        0..16383 reflecting the MIDI bank select index,
5794                        &lt;midi_prog&gt; an
5795                        integer value between 0..127 reflecting the MIDI program change
5796                        index, &lt;engine_name&gt; a sampler engine name as returned by
5797                        the <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a>
5798                        command (not encapsulated into apostrophes), &lt;filename&gt; the name
5799                        of the instrument's file to be deployed (encapsulated into apostrophes),
5800                        &lt;instrument_index&gt; the index (integer value) of the instrument
5801                        within the given file, &lt;volume_value&gt; reflects the master
5802                        volume of the instrument as optionally dotted number (where a
5803                        value < 1.0 means attenuation and a value > 1.0 means
5804                        amplification). This parameter easily allows to adjust the
5805                        volume of all intruments within a custom instrument map
5806                        without having to adjust their instrument files. The
5807                        OPTIONAL &lt;instr_load_mode&gt; argument defines the life
5808                        time of the instrument, that is when the instrument should
5809                        be loaded, when freed and has exactly the following
5810                        possibilities:
5811    </p>
5812    <p>
5813                            </p>
5814    <blockquote class="text">
5815    <p>"ON_DEMAND" -
5816                                    </p>
5817    <blockquote class="text">
5818    <p>The instrument will be loaded when needed,
5819                                        that is when demanded by at least one sampler
5820                                        channel. It will immediately be freed from memory
5821                                        when not needed by any sampler channel anymore.
5822    </p>
5823    </blockquote>
5824                                
5825    
5826    <p>"ON_DEMAND_HOLD" -
5827                                    </p>
5828    <blockquote class="text">
5829    <p>The instrument will be loaded when needed,
5830                                        that is when demanded by at least one sampler
5831                                        channel. It will be kept in memory even when
5832                                        not needed by any sampler channel anymore.
5833                                        Instruments with this mode are only freed
5834                                        when the sampler is reset or all mapping
5835                                        entries with this mode (and respective
5836                                        instrument) are explicitly changed to
5837                                        "ON_DEMAND" and no sampler channel is using
5838                                        the instrument anymore.
5839    </p>
5840    </blockquote>
5841                                
5842    
5843    <p>"PERSISTENT" -
5844                                    </p>
5845    <blockquote class="text">
5846    <p>The instrument will immediately be loaded
5847                                        into memory in the background when this mapping
5848                                        command is sent and the instrument is kept all
5849                                        the time. Instruments with this mode are
5850                                        only freed when the sampler is reset or all
5851                                        mapping entries with this mode (and
5852                                        respective instrument) are explicitly
5853                                        changed to "ON_DEMAND" and no sampler
5854                                        channel is using the instrument anymore.
5855    </p>
5856    </blockquote>
5857                                
5858    
5859    <p>not supplied -
5860                                    </p>
5861    <blockquote class="text">
5862    <p>In case there is no &lt;instr_load_mode&gt;
5863                                        argument given, it will be up to the
5864                                        InstrumentManager to decide which mode to use.
5865                                        Usually it will use "ON_DEMAND" if an entry
5866                                        for the given instrument does not exist in
5867                                        the InstrumentManager's list yet, otherwise
5868                                        if an entry already exists, it will simply
5869                                        stick with the mode currently reflected by
5870                                        the already existing entry, that is it will
5871                                        not change the mode.
5872    </p>
5873    </blockquote>
5874                                
5875    
5876    </blockquote><p>
5877                        
5878    </p>
5879    <p>
5880                        The &lt;instr_load_mode&gt; argument thus allows to define an
5881                        appropriate strategy (low memory consumption vs. fast
5882                        instrument switching) for each instrument individually. Note, the
5883                        following restrictions apply to this argument: "ON_DEMAND_HOLD" and
5884                        "PERSISTENT" have to be supported by the respective sampler engine
5885                        (which is technically the case when the engine provides an
5886                        InstrumentManager for its format). If this is not the case the
5887                        argument will automatically fall back to the default value
5888                        "ON_DEMAND". Also the load mode of one instrument may
5889                        automatically change the laod mode of other instrument(s), i.e.
5890                        because the instruments are part of the same file and the
5891                        engine does not allow a way to manage load modes for them
5892                        individually. Due to this, in case the frontend shows the
5893                        load modes of entries, the frontend should retrieve the actual
5894                        mode by i.e. sending
5895                        <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>
5896                        command(s). Finally the OPTIONAL &lt;name&gt; argument allows to
5897                        set a custom name (encapsulated into apostrophes) for the mapping
5898                        entry, useful for frontends for displaying an appropriate name for
5899                        mapped instruments (using
5900                        <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>).
5901                        
5902    </p>
5903    <p>
5904                        The "MAP MIDI_INSTRUMENT" command
5905                        will immediately return, thus it will not block when an
5906                        instrument is to be loaded due to a "PERSISTENT" type
5907                        entry as instruments are loaded in the background. As a
5908                        consequence this command may not necessarily return an error
5909                        i.e. when the given instrument file does not exist or may
5910                        turn out to be corrupt.
5911                        
5912    </p>
5913    <p>Possible Answers:
5914    </p>
5915    <p>
5916                            </p>
5917    <blockquote class="text">
5918    <p>"OK" -
5919                                    </p>
5920    <blockquote class="text">
5921    <p>usually
5922    </p>
5923    </blockquote>
5924                                
5925    
5926    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5927                                    </p>
5928    <blockquote class="text">
5929    <p>when the given map or engine does not exist or a value
5930                                        is out of range
5931    </p>
5932    </blockquote>
5933                                
5934    
5935    </blockquote><p>
5936                        
5937    </p>
5938    <p>Examples:
5939    </p>
5940    <p>
5941                            </p>
5942    <blockquote class="text">
5943    <p>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"
5944    </p>
5945    <p>S: "OK"
5946    </p>
5947    </blockquote><p>
5948                        
5949    </p>
5950    <p>
5951                            </p>
5952    <blockquote class="text">
5953    <p>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"
5954    </p>
5955    <p>S: "OK"
5956    </p>
5957    </blockquote><p>
5958                        
5959    </p>
5960    <p>
5961                            </p>
5962    <blockquote class="text">
5963    <p>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"
5964    </p>
5965    <p>S: "OK"
5966    </p>
5967    <p>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"
5968    </p>
5969    <p>S: "OK"
5970    </p>
5971    </blockquote><p>
5972                        
5973    </p>
5974    <p>
5975                            </p>
5976    <blockquote class="text">
5977    <p>C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
5978    </p>
5979    <p>S: "OK"
5980    </p>
5981    </blockquote><p>
5982                        
5983    </p>
5984    <a name="GET MIDI_INSTRUMENTS"></a><br /><hr />
5985    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5986    <a name="rfc.section.6.7.8"></a><h3>6.7.8.&nbsp;
5987    Getting ammount of MIDI instrument map entries</h3>
5988    
5989    <p>The front-end can query the amount of currently existing
5990                        entries in a MIDI instrument map by sending the following
5991                        command:
5992    </p>
5993    <p>
5994                            </p>
5995    <blockquote class="text">
5996    <p>GET MIDI_INSTRUMENTS &lt;map&gt;
5997    </p>
5998    </blockquote><p>
5999                        
6000    </p>
6001    <p>The front-end can query the amount of currently existing
6002                        entries in all MIDI instrument maps by sending the following
6003                        command:
6004    </p>
6005    <p>
6006                            </p>
6007    <blockquote class="text">
6008    <p>GET MIDI_INSTRUMENTS ALL
6009    </p>
6010    </blockquote><p>
6011                        
6012    </p>
6013    <p>Possible Answers:
6014    </p>
6015    <p>
6016                            </p>
6017    <blockquote class="text">
6018    <p>The sampler will answer by sending the current number of
6019                                entries in the MIDI instrument map(s).
6020    </p>
6021    </blockquote><p>
6022                        
6023    </p>
6024    <p>Example:
6025    </p>
6026    <p>
6027                            </p>
6028    <blockquote class="text">
6029    <p>C: "GET MIDI_INSTRUMENTS 0"
6030    </p>
6031    <p>S: "234"
6032    </p>
6033    </blockquote><p>
6034                        
6035    </p>
6036    <p>
6037                            </p>
6038    <blockquote class="text">
6039    <p>C: "GET MIDI_INSTRUMENTS ALL"
6040    </p>
6041    <p>S: "954"
6042    </p>
6043    </blockquote><p>
6044                        
6045    </p>
6046    <a name="LIST MIDI_INSTRUMENTS"></a><br /><hr />
6047    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6048    <a name="rfc.section.6.7.9"></a><h3>6.7.9.&nbsp;
6049    Getting indeces of all entries of a MIDI instrument map</h3>
6050    
6051    <p>The front-end can query a list of all currently existing
6052                        entries in a certain MIDI instrument map by sending the following
6053                        command:
6054    </p>
6055    <p>
6056                            </p>
6057    <blockquote class="text">
6058    <p>LIST MIDI_INSTRUMENTS &lt;map&gt;
6059    </p>
6060    </blockquote><p>
6061                        
6062    </p>
6063    <p>Where &lt;map&gt; is the numeric ID of the MIDI instrument map.
6064    </p>
6065    <p>The front-end can query a list of all currently existing
6066                        entries of all MIDI instrument maps by sending the following
6067                        command:
6068    </p>
6069    <p>
6070                            </p>
6071    <blockquote class="text">
6072    <p>LIST MIDI_INSTRUMENTS ALL
6073    </p>
6074    </blockquote><p>
6075                        
6076    </p>
6077    <p>Possible Answers:
6078    </p>
6079    <p>
6080                            </p>
6081    <blockquote class="text">
6082    <p>The sampler will answer by sending a comma separated
6083                                list of map ID - MIDI bank - MIDI program triples, where
6084                                each triple is encapsulated into curly braces. The
6085                                list is returned in one single line. Each triple
6086                                just reflects the key of the respective map entry,
6087                                thus subsequent
6088                                <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>
6089                                command(s) are necessary to retrieve detailed informations
6090                                about each entry.
6091    </p>
6092    </blockquote><p>
6093                        
6094    </p>
6095    <p>Example:
6096    </p>
6097    <p>
6098                            </p>
6099    <blockquote class="text">
6100    <p>C: "LIST MIDI_INSTRUMENTS 0"
6101    </p>
6102    <p>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
6103    </p>
6104    </blockquote><p>
6105                        
6106    </p>
6107    <a name="UNMAP MIDI_INSTRUMENT"></a><br /><hr />
6108    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6109    <a name="rfc.section.6.7.10"></a><h3>6.7.10.&nbsp;
6110    Remove an entry from the MIDI instrument map</h3>
6111    
6112    <p>The front-end can delete an entry from a MIDI instrument
6113                        map by sending the following command:
6114    </p>
6115    <p>
6116                            </p>
6117    <blockquote class="text">
6118    <p>UNMAP MIDI_INSTRUMENT &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;
6119    </p>
6120    </blockquote><p>
6121                        
6122    </p>
6123    <p>
6124                        Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
6125                        &lt;midi_bank&gt; is an integer value between 0..16383
6126                        reflecting the MIDI bank value and
6127                        &lt;midi_prog&gt; an integer value between
6128                        0..127 reflecting the MIDI program value of the map's entrie's key
6129                        index triple.
6130                        
6131    </p>
6132    <p>Possible Answers:
6133    </p>
6134    <p>
6135                            </p>
6136    <blockquote class="text">
6137    <p>"OK" -
6138                                    </p>
6139    <blockquote class="text">
6140    <p>usually
6141    </p>
6142    </blockquote>
6143                                
6144    
6145    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6146                                    </p>
6147    <blockquote class="text">
6148    <p>when index out of bounds
6149    </p>
6150    </blockquote>
6151                                
6152    
6153    </blockquote><p>
6154                        
6155    </p>
6156    <p>Example:
6157    </p>
6158    <p>
6159                            </p>
6160    <blockquote class="text">
6161    <p>C: "UNMAP MIDI_INSTRUMENT 0 2 127"
6162    </p>
6163    <p>S: "OK"
6164    </p>
6165    </blockquote><p>
6166                        
6167    </p>
6168    <a name="GET MIDI_INSTRUMENT INFO"></a><br /><hr />
6169    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6170    <a name="rfc.section.6.7.11"></a><h3>6.7.11.&nbsp;
6171    Get current settings of MIDI instrument map entry</h3>
6172    
6173    <p>The front-end can retrieve the current settings of a certain
6174                        instrument map entry by sending the following command:
6175    </p>
6176    <p>
6177                            </p>
6178    <blockquote class="text">
6179    <p>GET MIDI_INSTRUMENT INFO &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;
6180    </p>
6181    </blockquote><p>
6182                        
6183    </p>
6184    <p>
6185                        Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
6186                        &lt;midi_bank&gt; is an integer value between 0..16383
6187                        reflecting the MIDI bank value, &lt;midi_bank&gt;
6188                        and &lt;midi_prog&gt; an integer value between
6189                        0..127 reflecting the MIDI program value of the map's entrie's key
6190                        index triple.
6191                        
6192    </p>
6193    <p>Possible Answers:
6194    </p>
6195    <p>
6196                            </p>
6197    <blockquote class="text">
6198    <p>LinuxSampler will answer by sending a &lt;CRLF&gt;
6199                                separated list. Each answer line begins with the
6200                                information category name followed by a colon and then
6201                                a space character &lt;SP&gt; and finally the info
6202                                character string to that info category. At the moment
6203                                the following categories are defined:
6204    </p>
6205    <p>"NAME" -
6206                                    </p>
6207    <blockquote class="text">
6208    <p>Name for this MIDI instrument map entry (if defined).
6209                                        This name shall be used by frontends for displaying a
6210                                        name for this mapped instrument. It can be set and
6211                                        changed with the
6212                                        <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>
6213                                        command and does not have to be unique.
6214    </p>
6215    </blockquote>
6216                                
6217    
6218    <p>"ENGINE_NAME" -
6219                                    </p>
6220    <blockquote class="text">
6221    <p>Name of the engine to be deployed for this
6222                                        instrument.
6223    </p>
6224    </blockquote>
6225                                
6226    
6227    <p>"INSTRUMENT_FILE" -
6228                                    </p>
6229    <blockquote class="text">
6230    <p>File name of the instrument.
6231    </p>
6232    </blockquote>
6233                                
6234    
6235    <p>"INSTRUMENT_NR" -
6236                                    </p>
6237    <blockquote class="text">
6238    <p>Index of the instrument within the file.
6239    </p>
6240    </blockquote>
6241                                
6242    
6243    <p>"INSTRUMENT_NAME" -
6244                                    </p>
6245    <blockquote class="text">
6246    <p>Name of the loaded instrument as reflected by its file.
6247                                        In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
6248                                        cannot be changed.
6249    </p>
6250    </blockquote>
6251                                
6252    
6253    <p>"LOAD_MODE" -
6254                                    </p>
6255    <blockquote class="text">
6256    <p>Life time of instrument
6257                                        (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).
6258    </p>
6259    </blockquote>
6260                                
6261    
6262    <p>"VOLUME" -
6263                                    </p>
6264    <blockquote class="text">
6265    <p>master volume of the instrument as optionally
6266                                        dotted number (where a value < 1.0 means attenuation
6267                                        and a value > 1.0 means amplification)
6268    </p>
6269    </blockquote>
6270                                
6271    
6272    <p>The mentioned fields above don't have to be in particular order.
6273    </p>
6274    </blockquote><p>
6275                        
6276    </p>
6277    <p>Example:
6278    </p>
6279    <p>
6280                            </p>
6281    <blockquote class="text">
6282    <p>C: "GET MIDI_INSTRUMENT INFO 1 45 120"
6283    </p>
6284    <p>S: "NAME: Drums for Foo Song"
6285    </p>
6286    <p>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"
6287    </p>
6288    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
6289    </p>
6290    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"
6291    </p>
6292    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Joe's Drumkit"
6293    </p>
6294    <p>&nbsp;&nbsp;&nbsp;"LOAD_MODE: PERSISTENT"
6295    </p>
6296    <p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
6297    </p>
6298    <p>&nbsp;&nbsp;&nbsp;"."
6299    </p>
6300    </blockquote><p>
6301                        
6302    </p>
6303    <a name="CLEAR MIDI_INSTRUMENTS"></a><br /><hr />
6304    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6305    <a name="rfc.section.6.7.12"></a><h3>6.7.12.&nbsp;
6306    Clear MIDI instrument map</h3>
6307    
6308    <p>The front-end can clear a whole MIDI instrument map, that
6309                        is delete all its entries by sending the following command:
6310    </p>
6311    <p>
6312                            </p>
6313    <blockquote class="text">
6314    <p>CLEAR MIDI_INSTRUMENTS &lt;map&gt;
6315    </p>
6316    </blockquote><p>
6317                        
6318    </p>
6319    <p>Where &lt;map&gt; is the numeric ID of the map to clear.
6320    </p>
6321    <p>The front-end can clear all MIDI instrument maps, that
6322                        is delete all entries of all maps by sending the following
6323                        command:
6324    </p>
6325    <p>
6326                            </p>
6327    <blockquote class="text">
6328    <p>CLEAR MIDI_INSTRUMENTS ALL
6329    </p>
6330    </blockquote><p>
6331                        
6332    </p>
6333    <p>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the
6334                        maps, only their entries, thus the map's settings like
6335                        custom name will be preservevd.
6336    </p>
6337    <p>Possible Answers:
6338    </p>
6339    <p>
6340                            </p>
6341    <blockquote class="text">
6342    <p>"OK" -
6343                                    </p>
6344    <blockquote class="text">
6345    <p>always
6346    </p>
6347    </blockquote>
6348                                
6349    
6350    </blockquote><p>
6351                        
6352    </p>
6353    <p>Examples:
6354    </p>
6355    <p>
6356                           </p>
6357    <blockquote class="text">
6358    <p>C: "CLEAR MIDI_INSTRUMENTS 0"
6359    </p>
6360    <p>S: "OK"
6361    </p>
6362    </blockquote><p>
6363                        
6364    </p>
6365    <p>
6366                           </p>
6367    <blockquote class="text">
6368    <p>C: "CLEAR MIDI_INSTRUMENTS ALL"
6369    </p>
6370    <p>S: "OK"
6371    </p>
6372    </blockquote><p>
6373                        
6374  </p>  </p>
6375  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
6376  <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>
6377  <a name="rfc.section.7"></a><h3>7.&nbsp;Command Syntax</h3>  <a name="rfc.section.7"></a><h3>7.&nbsp;
6378    Command Syntax</h3>
6379    
6380  <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>
6381              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>)
6382              where applicable.              where applicable.
6383                
6384  </p>  </p>
6385  <p>input =  <p>input =
6386          </p>          </p>
6387  <blockquote class="text">  <blockquote class="text">
6388  <p>line LF  <p>line LF
6389                    
6390  </p>  </p>
6391  <p>/ line CR LF  <p>/ line CR LF
6392                    
6393  </p>  </p>
6394  </blockquote><p>  </blockquote><p>
6395    
# Line 4964  Intellectual Property and Copyright Stat Line 6398  Intellectual Property and Copyright Stat
6398          </p>          </p>
6399  <blockquote class="text">  <blockquote class="text">
6400  <p>/* epsilon (empty line ignored) */  <p>/* epsilon (empty line ignored) */
6401                    
6402  </p>  </p>
6403  <p>/ comment  <p>/ comment
6404                    
6405  </p>  </p>
6406  <p>/ command  <p>/ command
6407                    
6408  </p>  </p>
6409  <p>/ error  <p>/ error
6410                    
6411  </p>  </p>
6412  </blockquote><p>  </blockquote><p>
6413    
# Line 4982  Intellectual Property and Copyright Stat Line 6416  Intellectual Property and Copyright Stat
6416          </p>          </p>
6417  <blockquote class="text">  <blockquote class="text">
6418  <p>'#'  <p>'#'
6419                    
6420  </p>  </p>
6421  <p>/ comment '#'  <p>/ comment '#'
6422                    
6423  </p>  </p>
6424  <p>/ comment SP  <p>/ comment SP
6425                    
6426  </p>  </p>
6427  <p>/ comment number  <p>/ comment number
6428                    
6429  </p>  </p>
6430  <p>/ comment string  <p>/ comment string
6431                    
6432  </p>  </p>
6433  </blockquote><p>  </blockquote><p>
6434    
# Line 5002  Intellectual Property and Copyright Stat Line 6436  Intellectual Property and Copyright Stat
6436  <p>command =  <p>command =
6437          </p>          </p>
6438  <blockquote class="text">  <blockquote class="text">
6439  <p>ADD SP CHANNEL  <p>ADD SP add_instruction
6440                    
6441    </p>
6442    <p>/ MAP SP map_instruction
6443                    
6444    </p>
6445    <p>/ UNMAP SP unmap_instruction
6446                    
6447  </p>  </p>
6448  <p>/ GET SP get_instruction  <p>/ GET SP get_instruction
6449                    
6450  </p>  </p>
6451  <p>/ CREATE SP create_instruction  <p>/ CREATE SP create_instruction
6452                    
6453  </p>  </p>
6454  <p>/ DESTROY SP destroy_instruction  <p>/ DESTROY SP destroy_instruction
6455                    
6456  </p>  </p>
6457  <p>/ LIST SP list_instruction  <p>/ LIST SP list_instruction
6458                    
6459  </p>  </p>
6460  <p>/ LOAD SP load_instruction  <p>/ LOAD SP load_instruction
6461                    
6462  </p>  </p>
6463  <p>/ REMOVE SP CHANNEL SP sampler_channel  <p>/ REMOVE SP remove_instruction
6464                    
6465  </p>  </p>
6466  <p>/ SET SP set_instruction  <p>/ SET SP set_instruction
6467                    
6468  </p>  </p>
6469  <p>/ SUBSCRIBE SP subscribe_event  <p>/ SUBSCRIBE SP subscribe_event
6470                    
6471  </p>  </p>
6472  <p>/ UNSUBSCRIBE SP unsubscribe_event  <p>/ UNSUBSCRIBE SP unsubscribe_event
6473                    
6474  </p>  </p>
6475  <p>/ SELECT SP text  <p>/ SELECT SP text
6476                    
6477  </p>  </p>
6478  <p>/ RESET SP CHANNEL SP sampler_channel  <p>/ RESET SP reset_instruction
6479                    
6480    </p>
6481    <p>/ CLEAR SP clear_instruction
6482                    
6483  </p>  </p>
6484  <p>/ RESET  <p>/ RESET
6485                    
6486  </p>  </p>
6487  <p>/ QUIT  <p>/ QUIT
6488                    
6489    </p>
6490    </blockquote><p>
6491    
6492  </p>  </p>
6493    <p>add_instruction =
6494            </p>
6495    <blockquote class="text">
6496    <p>CHANNEL
6497                    
6498    </p>
6499    <p>/ MIDI_INSTRUMENT_MAP
6500                    
6501    </p>
6502    <p>/ MIDI_INSTRUMENT_MAP SP map_name
6503                    
6504    </p>
6505  </blockquote><p>  </blockquote><p>
6506    
6507  </p>  </p>
# Line 5051  Intellectual Property and Copyright Stat Line 6509  Intellectual Property and Copyright Stat
6509          </p>          </p>
6510  <blockquote class="text">  <blockquote class="text">
6511  <p>CHANNEL_COUNT  <p>CHANNEL_COUNT
6512                    
6513  </p>  </p>
6514  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
6515                    
6516  </p>  </p>
6517  <p>/ STREAM_COUNT  <p>/ STREAM_COUNT
6518                    
6519  </p>  </p>
6520  <p>/ BUFFER_FILL  <p>/ BUFFER_FILL
6521                    
6522  </p>  </p>
6523  <p>/ CHANNEL_INFO  <p>/ CHANNEL_INFO
6524                    
6525  </p>  </p>
6526  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
6527                    
6528    </p>
6529    <p>/ TOTAL_VOICE_COUNT
6530                    
6531  </p>  </p>
6532  </blockquote><p>  </blockquote><p>
6533    
# Line 5075  Intellectual Property and Copyright Stat Line 6536  Intellectual Property and Copyright Stat
6536          </p>          </p>
6537  <blockquote class="text">  <blockquote class="text">
6538  <p>CHANNEL_COUNT  <p>CHANNEL_COUNT
6539                    
6540  </p>  </p>
6541  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
6542                    
6543  </p>  </p>
6544  <p>/ STREAM_COUNT  <p>/ STREAM_COUNT
6545                    
6546  </p>  </p>
6547  <p>/ BUFFER_FILL  <p>/ BUFFER_FILL
6548                    
6549  </p>  </p>
6550  <p>/ CHANNEL_INFO  <p>/ CHANNEL_INFO
6551                    
6552  </p>  </p>
6553  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
6554                    
6555    </p>
6556    <p>/ TOTAL_VOICE_COUNT
6557                    
6558    </p>
6559    </blockquote><p>
6560    
6561    </p>
6562    <p>map_instruction =
6563            </p>
6564    <blockquote class="text">
6565    <p>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value
6566                    
6567    </p>
6568    <p>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode
6569                    
6570    </p>
6571    <p>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name
6572                    
6573    </p>
6574    <p>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name
6575                    
6576    </p>
6577    </blockquote><p>
6578    
6579  </p>  </p>
6580    <p>unmap_instruction =
6581            </p>
6582    <blockquote class="text">
6583    <p>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
6584                    
6585    </p>
6586    </blockquote><p>
6587    
6588    </p>
6589    <p>remove_instruction =
6590            </p>
6591    <blockquote class="text">
6592    <p>CHANNEL SP sampler_channel
6593                    
6594    </p>
6595    <p>/ MIDI_INSTRUMENT_MAP SP midi_map
6596                    
6597    </p>
6598    <p>/ MIDI_INSTRUMENT_MAP SP ALL
6599                    
6600    </p>
6601  </blockquote><p>  </blockquote><p>
6602    
6603  </p>  </p>
# Line 5099  Intellectual Property and Copyright Stat Line 6605  Intellectual Property and Copyright Stat
6605          </p>          </p>
6606  <blockquote class="text">  <blockquote class="text">
6607  <p>AVAILABLE_ENGINES  <p>AVAILABLE_ENGINES
6608                    
6609  </p>  </p>
6610  <p>/ AVAILABLE_MIDI_INPUT_DRIVERS  <p>/ AVAILABLE_MIDI_INPUT_DRIVERS
6611                    
6612  </p>  </p>
6613  <p>/ MIDI_INPUT_DRIVER SP INFO SP string  <p>/ MIDI_INPUT_DRIVER SP INFO SP string
6614                    
6615  </p>  </p>
6616  <p>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string  <p>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
6617                    
6618  </p>  </p>
6619  <p>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list  <p>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
6620                    
6621  </p>  </p>
6622  <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS  <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
6623                    
6624  </p>  </p>
6625  <p>/ AUDIO_OUTPUT_DRIVER SP INFO SP string  <p>/ AUDIO_OUTPUT_DRIVER SP INFO SP string
6626                    
6627  </p>  </p>
6628  <p>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string  <p>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
6629                    
6630  </p>  </p>
6631  <p>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list  <p>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
6632                    
6633  </p>  </p>
6634  <p>/ AUDIO_OUTPUT_DEVICES  <p>/ AUDIO_OUTPUT_DEVICES
6635                    
6636  </p>  </p>
6637  <p>/ MIDI_INPUT_DEVICES  <p>/ MIDI_INPUT_DEVICES
6638                    
6639  </p>  </p>
6640  <p>/ AUDIO_OUTPUT_DEVICE SP INFO SP number  <p>/ AUDIO_OUTPUT_DEVICE SP INFO SP number
6641                    
6642  </p>  </p>
6643  <p>/ MIDI_INPUT_DEVICE SP INFO SP number  <p>/ MIDI_INPUT_DEVICE SP INFO SP number
6644                    
6645  </p>  </p>
6646  <p>/ MIDI_INPUT_PORT SP INFO SP number SP number  <p>/ MIDI_INPUT_PORT SP INFO SP number SP number
6647                    
6648  </p>  </p>
6649  <p>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string  <p>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
6650                    
6651  </p>  </p>
6652  <p>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number  <p>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
6653                    
6654  </p>  </p>
6655  <p>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string  <p>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string
6656                    
6657  </p>  </p>
6658  <p>/ CHANNELS  <p>/ CHANNELS
6659                    
6660  </p>  </p>
6661  <p>/ CHANNEL SP INFO SP sampler_channel  <p>/ CHANNEL SP INFO SP sampler_channel
6662                    
6663  </p>  </p>
6664  <p>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel  <p>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
6665                    
6666  </p>  </p>
6667  <p>/ CHANNEL SP STREAM_COUNT SP sampler_channel  <p>/ CHANNEL SP STREAM_COUNT SP sampler_channel
6668                    
6669  </p>  </p>
6670  <p>/ CHANNEL SP VOICE_COUNT SP sampler_channel  <p>/ CHANNEL SP VOICE_COUNT SP sampler_channel
6671                    
6672  </p>  </p>
6673  <p>/ ENGINE SP INFO SP engine_name  <p>/ ENGINE SP INFO SP engine_name
6674                    
6675  </p>  </p>
6676  <p>/ SERVER SP INFO  <p>/ SERVER SP INFO
6677                    
6678    </p>
6679    <p>/ TOTAL_VOICE_COUNT
6680                    
6681    </p>
6682    <p>/ TOTAL_VOICE_COUNT_MAX
6683                    
6684    </p>
6685    <p>/ MIDI_INSTRUMENTS SP midi_map
6686                    
6687    </p>
6688    <p>/ MIDI_INSTRUMENTS SP ALL
6689                    
6690    </p>
6691    <p>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
6692                    
6693    </p>
6694    <p>/ MIDI_INSTRUMENT_MAPS
6695                    
6696    </p>
6697    <p>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
6698                    
6699  </p>  </p>
6700  </blockquote><p>  </blockquote><p>
6701    
# Line 5177  Intellectual Property and Copyright Stat Line 6704  Intellectual Property and Copyright Stat
6704          </p>          </p>
6705  <blockquote class="text">  <blockquote class="text">
6706  <p>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list  <p>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
6707                    
6708  </p>  </p>
6709  <p>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list  <p>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list
6710                    
6711  </p>  </p>
6712  <p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list  <p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
6713                    
6714  </p>  </p>
6715  <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list  <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
6716                    
6717  </p>  </p>
6718  <p>/ CHANNEL SP set_chan_instruction  <p>/ CHANNEL SP set_chan_instruction
6719                    
6720    </p>
6721    <p>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6722                    
6723  </p>  </p>
6724  <p>/ ECHO SP boolean  <p>/ ECHO SP boolean
6725                    
6726  </p>  </p>
6727  </blockquote><p>  </blockquote><p>
6728    
# Line 5201  Intellectual Property and Copyright Stat Line 6731  Intellectual Property and Copyright Stat
6731          </p>          </p>
6732  <blockquote class="text">  <blockquote class="text">
6733  <p>AUDIO_OUTPUT_DEVICE SP string SP key_val_list  <p>AUDIO_OUTPUT_DEVICE SP string SP key_val_list
6734                    
6735  </p>  </p>
6736  <p>/ AUDIO_OUTPUT_DEVICE SP string  <p>/ AUDIO_OUTPUT_DEVICE SP string
6737                    
6738  </p>  </p>
6739  <p>/ MIDI_INPUT_DEVICE SP string SP key_val_list  <p>/ MIDI_INPUT_DEVICE SP string SP key_val_list
6740                    
6741  </p>  </p>
6742  <p>/ MIDI_INPUT_DEVICE SP string  <p>/ MIDI_INPUT_DEVICE SP string
6743                    
6744    </p>
6745    </blockquote><p>
6746    
6747    </p>
6748    <p>reset_instruction =
6749            </p>
6750    <blockquote class="text">
6751    <p>CHANNEL SP sampler_channel
6752                    
6753    </p>
6754    </blockquote><p>
6755    
6756  </p>  </p>
6757    <p>clear_instruction =
6758            </p>
6759    <blockquote class="text">
6760    <p>MIDI_INSTRUMENTS SP midi_map
6761                    
6762    </p>
6763    <p>/ MIDI_INSTRUMENTS SP ALL
6764                    
6765    </p>
6766  </blockquote><p>  </blockquote><p>
6767    
6768  </p>  </p>
# Line 5219  Intellectual Property and Copyright Stat Line 6770  Intellectual Property and Copyright Stat
6770          </p>          </p>
6771  <blockquote class="text">  <blockquote class="text">
6772  <p>AUDIO_OUTPUT_DEVICE SP number  <p>AUDIO_OUTPUT_DEVICE SP number
6773                    
6774  </p>  </p>
6775  <p>/ MIDI_INPUT_DEVICE SP number  <p>/ MIDI_INPUT_DEVICE SP number
6776                    
6777  </p>  </p>
6778  </blockquote><p>  </blockquote><p>
6779    
# Line 5231  Intellectual Property and Copyright Stat Line 6782  Intellectual Property and Copyright Stat
6782          </p>          </p>
6783  <blockquote class="text">  <blockquote class="text">
6784  <p>INSTRUMENT SP load_instr_args  <p>INSTRUMENT SP load_instr_args
6785                    
6786  </p>  </p>
6787  <p>/ ENGINE SP load_engine_args  <p>/ ENGINE SP load_engine_args
6788                    
6789  </p>  </p>
6790  </blockquote><p>  </blockquote><p>
6791    
# Line 5243  Intellectual Property and Copyright Stat Line 6794  Intellectual Property and Copyright Stat
6794          </p>          </p>
6795  <blockquote class="text">  <blockquote class="text">
6796  <p>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index  <p>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
6797                    
6798  </p>  </p>
6799  <p>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index  <p>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index
6800                    
6801  </p>  </p>
6802  <p>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name  <p>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
6803                    
6804  </p>  </p>
6805  <p>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index  <p>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index
6806                    
6807  </p>  </p>
6808  <p>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index  <p>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index
6809                    
6810  </p>  </p>
6811  <p>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index  <p>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
6812                    
6813  </p>  </p>
6814  <p>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index  <p>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index
6815                    
6816  </p>  </p>
6817  <p>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name  <p>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
6818                    
6819  </p>  </p>
6820  <p>/ VOLUME SP sampler_channel SP volume_value  <p>/ VOLUME SP sampler_channel SP volume_value
6821                    
6822  </p>  </p>
6823  <p>/ MUTE SP sampler_channel SP boolean  <p>/ MUTE SP sampler_channel SP boolean
6824                    
6825  </p>  </p>
6826  <p>/ SOLO SP sampler_channel SP boolean  <p>/ SOLO SP sampler_channel SP boolean
6827                    
6828    </p>
6829    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
6830                    
6831    </p>
6832    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
6833                    
6834    </p>
6835    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
6836                    
6837  </p>  </p>
6838  </blockquote><p>  </blockquote><p>
6839    
# Line 5282  Intellectual Property and Copyright Stat Line 6842  Intellectual Property and Copyright Stat
6842          </p>          </p>
6843  <blockquote class="text">  <blockquote class="text">
6844  <p>string '=' param_val_list  <p>string '=' param_val_list
6845                    
6846  </p>  </p>
6847  <p>/ key_val_list SP string '=' param_val_list  <p>/ key_val_list SP string '=' param_val_list
6848                    
6849  </p>  </p>
6850  </blockquote><p>  </blockquote><p>
6851    
# Line 5294  Intellectual Property and Copyright Stat Line 6854  Intellectual Property and Copyright Stat
6854          </p>          </p>
6855  <blockquote class="text">  <blockquote class="text">
6856  <p>BYTES  <p>BYTES
6857                    
6858  </p>  </p>
6859  <p>/ PERCENTAGE  <p>/ PERCENTAGE
6860                    
6861  </p>  </p>
6862  </blockquote><p>  </blockquote><p>
6863    
# Line 5306  Intellectual Property and Copyright Stat Line 6866  Intellectual Property and Copyright Stat
6866          </p>          </p>
6867  <blockquote class="text">  <blockquote class="text">
6868  <p>AUDIO_OUTPUT_DEVICES  <p>AUDIO_OUTPUT_DEVICES
6869                    
6870  </p>  </p>
6871  <p>/ MIDI_INPUT_DEVICES  <p>/ MIDI_INPUT_DEVICES
6872                    
6873  </p>  </p>
6874  <p>/ CHANNELS  <p>/ CHANNELS
6875                    
6876  </p>  </p>
6877  <p>/ AVAILABLE_ENGINES  <p>/ AVAILABLE_ENGINES
6878                    
6879  </p>  </p>
6880  <p>/ AVAILABLE_MIDI_INPUT_DRIVERS  <p>/ AVAILABLE_MIDI_INPUT_DRIVERS
6881                    
6882  </p>  </p>
6883  <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS  <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
6884                    
6885    </p>
6886    <p>/ MIDI_INSTRUMENTS SP midi_map
6887                    
6888    </p>
6889    <p>/ MIDI_INSTRUMENTS SP ALL
6890                    
6891    </p>
6892    <p>/ MIDI_INSTRUMENT_MAPS
6893                    
6894  </p>  </p>
6895  </blockquote><p>  </blockquote><p>
6896    
# Line 5330  Intellectual Property and Copyright Stat Line 6899  Intellectual Property and Copyright Stat
6899          </p>          </p>
6900  <blockquote class="text">  <blockquote class="text">
6901  <p>filename SP instrument_index SP sampler_channel  <p>filename SP instrument_index SP sampler_channel
6902                    
6903  </p>  </p>
6904  <p>/ NON_MODAL SP filename SP instrument_index SP sampler_channel  <p>/ NON_MODAL SP filename SP instrument_index SP sampler_channel
6905                    
6906  </p>  </p>
6907  </blockquote><p>  </blockquote><p>
6908    
# Line 5342  Intellectual Property and Copyright Stat Line 6911  Intellectual Property and Copyright Stat
6911          </p>          </p>
6912  <blockquote class="text">  <blockquote class="text">
6913  <p>engine_name SP sampler_channel  <p>engine_name SP sampler_channel
6914                    
6915    </p>
6916    </blockquote><p>
6917    
6918  </p>  </p>
6919    <p>instr_load_mode =
6920            </p>
6921    <blockquote class="text">
6922    <p>ON_DEMAND
6923                    
6924    </p>
6925    <p>/ ON_DEMAND_HOLD
6926                    
6927    </p>
6928    <p>/ PERSISTENT
6929                    
6930    </p>
6931  </blockquote><p>  </blockquote><p>
6932    
6933  </p>  </p>
# Line 5351  Intellectual Property and Copyright Stat Line 6935  Intellectual Property and Copyright Stat
6935          </p>          </p>
6936  <blockquote class="text">  <blockquote class="text">
6937  <p>number  <p>number
6938                    
6939  </p>  </p>
6940  </blockquote><p>  </blockquote><p>
6941    
# Line 5360  Intellectual Property and Copyright Stat Line 6944  Intellectual Property and Copyright Stat
6944          </p>          </p>
6945  <blockquote class="text">  <blockquote class="text">
6946  <p>number  <p>number
6947                    
6948  </p>  </p>
6949  </blockquote><p>  </blockquote><p>
6950    
# Line 5369  Intellectual Property and Copyright Stat Line 6953  Intellectual Property and Copyright Stat
6953          </p>          </p>
6954  <blockquote class="text">  <blockquote class="text">
6955  <p>string  <p>string
6956                    
6957  </p>  </p>
6958  </blockquote><p>  </blockquote><p>
6959    
# Line 5378  Intellectual Property and Copyright Stat Line 6962  Intellectual Property and Copyright Stat
6962          </p>          </p>
6963  <blockquote class="text">  <blockquote class="text">
6964  <p>number  <p>number
6965                    
6966  </p>  </p>
6967  </blockquote><p>  </blockquote><p>
6968    
# Line 5387  Intellectual Property and Copyright Stat Line 6971  Intellectual Property and Copyright Stat
6971          </p>          </p>
6972  <blockquote class="text">  <blockquote class="text">
6973  <p>number  <p>number
6974                    
6975  </p>  </p>
6976  <p>/ ALL  <p>/ ALL
6977                    
6978  </p>  </p>
6979  </blockquote><p>  </blockquote><p>
6980    
# Line 5399  Intellectual Property and Copyright Stat Line 6983  Intellectual Property and Copyright Stat
6983          </p>          </p>
6984  <blockquote class="text">  <blockquote class="text">
6985  <p>string  <p>string
6986                    
6987    </p>
6988    </blockquote><p>
6989    
6990    </p>
6991    <p>midi_map =
6992            </p>
6993    <blockquote class="text">
6994    <p>number
6995                    
6996    </p>
6997    </blockquote><p>
6998    
6999  </p>  </p>
7000    <p>midi_bank =
7001            </p>
7002    <blockquote class="text">
7003    <p>number
7004                    
7005    </p>
7006    </blockquote><p>
7007    
7008    </p>
7009    <p>midi_prog =
7010            </p>
7011    <blockquote class="text">
7012    <p>number
7013                    
7014    </p>
7015  </blockquote><p>  </blockquote><p>
7016    
7017  </p>  </p>
# Line 5408  Intellectual Property and Copyright Stat Line 7019  Intellectual Property and Copyright Stat
7019          </p>          </p>
7020  <blockquote class="text">  <blockquote class="text">
7021  <p>dotnum  <p>dotnum
7022                    
7023  </p>  </p>
7024  <p>/ number  <p>/ number
7025                    
7026  </p>  </p>
7027  </blockquote><p>  </blockquote><p>
7028    
# Line 5420  Intellectual Property and Copyright Stat Line 7031  Intellectual Property and Copyright Stat
7031          </p>          </p>
7032  <blockquote class="text">  <blockquote class="text">
7033  <p>number  <p>number
7034                    
7035  </p>  </p>
7036  </blockquote><p>  </blockquote><p>
7037    
# Line 5429  Intellectual Property and Copyright Stat Line 7040  Intellectual Property and Copyright Stat
7040          </p>          </p>
7041  <blockquote class="text">  <blockquote class="text">
7042  <p>number  <p>number
7043                    
7044  </p>  </p>
7045  </blockquote><p>  </blockquote><p>
7046    
# Line 5438  Intellectual Property and Copyright Stat Line 7049  Intellectual Property and Copyright Stat
7049          </p>          </p>
7050  <blockquote class="text">  <blockquote class="text">
7051  <p>string  <p>string
7052                    
7053  </p>  </p>
7054  </blockquote><p>  </blockquote><p>
7055    
# Line 5447  Intellectual Property and Copyright Stat Line 7058  Intellectual Property and Copyright Stat
7058          </p>          </p>
7059  <blockquote class="text">  <blockquote class="text">
7060  <p>stringval  <p>stringval
7061                    
7062    </p>
7063    </blockquote><p>
7064    
7065  </p>  </p>
7066    <p>map_name =
7067            </p>
7068    <blockquote class="text">
7069    <p>stringval
7070                    
7071    </p>
7072    </blockquote><p>
7073    
7074    </p>
7075    <p>entry_name =
7076            </p>
7077    <blockquote class="text">
7078    <p>stringval
7079                    
7080    </p>
7081  </blockquote><p>  </blockquote><p>
7082    
7083  </p>  </p>
# Line 5456  Intellectual Property and Copyright Stat Line 7085  Intellectual Property and Copyright Stat
7085          </p>          </p>
7086  <blockquote class="text">  <blockquote class="text">
7087  <p>param_val  <p>param_val
7088                    
7089  </p>  </p>
7090  <p>/ param_val_list','param_val  <p>/ param_val_list','param_val
7091                    
7092  </p>  </p>
7093  </blockquote><p>  </blockquote><p>
7094    
# Line 5468  Intellectual Property and Copyright Stat Line 7097  Intellectual Property and Copyright Stat
7097          </p>          </p>
7098  <blockquote class="text">  <blockquote class="text">
7099  <p>string  <p>string
7100                    
 </p>  
 <p>/ '\'' string '\''  
   
7101  </p>  </p>
7102  <p>/ '\"' string '\"'  <p>/ stringval
7103                    
7104  </p>  </p>
7105  <p>/ number  <p>/ number
7106                    
7107  </p>  </p>
7108  <p>/ dotnum  <p>/ dotnum
7109                    
7110  </p>  </p>
7111  </blockquote><p>  </blockquote><p>
7112    
7113  </p>  </p>
7114  <a name="events"></a><br /><hr />  <a name="events"></a><br /><hr />
7115  <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>
7116  <a name="rfc.section.8"></a><h3>8.&nbsp;Events</h3>  <a name="rfc.section.8"></a><h3>8.&nbsp;
7117    Events</h3>
7118    
7119  <p>This chapter will describe all currently defined events supported by LinuxSampler.  <p>This chapter will describe all currently defined events supported by LinuxSampler.
7120  </p>  </p>
7121  <a name="rfc.section.8.1"></a><h4><a name="SUBSCRIBE CHANNEL">8.1</a>&nbsp;Number of sampler channels changed</h4>  <a name="SUBSCRIBE CHANNEL"></a><br /><hr />
7122    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7123    <a name="rfc.section.8.1"></a><h3>8.1.&nbsp;
7124    Number of sampler channels changed</h3>
7125    
7126  <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
7127                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 5502  Intellectual Property and Copyright Stat Line 7132  Intellectual Property and Copyright Stat
7132  <p>SUBSCRIBE CHANNEL_COUNT  <p>SUBSCRIBE CHANNEL_COUNT
7133  </p>  </p>
7134  </blockquote><p>  </blockquote><p>
7135                    
7136  </p>  </p>
7137  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
7138  </p>  </p>
# Line 5512  Intellectual Property and Copyright Stat Line 7142  Intellectual Property and Copyright Stat
7142  <p>"NOTIFY:CHANNEL_COUNT:&lt;channels&gt;"  <p>"NOTIFY:CHANNEL_COUNT:&lt;channels&gt;"
7143  </p>  </p>
7144  </blockquote><p>  </blockquote><p>
7145                    
7146  </p>  </p>
7147  <p>where &lt;channels&gt; will be replaced by the new number  <p>where &lt;channels&gt; will be replaced by the new number
7148                  of sampler channels.                  of sampler channels.
7149  </p>  </p>
7150  <a name="rfc.section.8.2"></a><h4><a name="SUBSCRIBE VOICE_COUNT">8.2</a>&nbsp;Number of active voices changed</h4>  <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />
7151    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7152    <a name="rfc.section.8.2"></a><h3>8.2.&nbsp;
7153    Number of active voices changed</h3>
7154    
7155  <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
7156                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 5528  Intellectual Property and Copyright Stat Line 7161  Intellectual Property and Copyright Stat
7161  <p>SUBSCRIBE VOICE_COUNT  <p>SUBSCRIBE VOICE_COUNT
7162  </p>  </p>
7163  </blockquote><p>  </blockquote><p>
7164                    
7165  </p>  </p>
7166  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
7167  </p>  </p>
# Line 5538  Intellectual Property and Copyright Stat Line 7171  Intellectual Property and Copyright Stat
7171  <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;  <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;
7172  </p>  </p>
7173  </blockquote><p>  </blockquote><p>
7174                    
7175  </p>  </p>
7176  <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
7177                  voice count change occurred and &lt;voices&gt; by the new number of                  voice count change occurred and &lt;voices&gt; by the new number of
7178                  active voices on that channel.                  active voices on that channel.
7179  </p>  </p>
7180  <a name="rfc.section.8.3"></a><h4><a name="SUBSCRIBE STREAM_COUNT">8.3</a>&nbsp;Number of active disk streams changed</h4>  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />
7181    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7182    <a name="rfc.section.8.3"></a><h3>8.3.&nbsp;
7183    Number of active disk streams changed</h3>
7184    
7185  <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
7186                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT
# Line 5555  Intellectual Property and Copyright Stat Line 7191  Intellectual Property and Copyright Stat
7191  <p>SUBSCRIBE STREAM_COUNT  <p>SUBSCRIBE STREAM_COUNT
7192  </p>  </p>
7193  </blockquote><p>  </blockquote><p>
7194                    
7195  </p>  </p>
7196  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
7197  </p>  </p>
# Line 5565  Intellectual Property and Copyright Stat Line 7201  Intellectual Property and Copyright Stat
7201  <p>"NOTIFY:STREAM_COUNT:&lt;sampler-channel&gt; &lt;streams&gt;"  <p>"NOTIFY:STREAM_COUNT:&lt;sampler-channel&gt; &lt;streams&gt;"
7202  </p>  </p>
7203  </blockquote><p>  </blockquote><p>
7204                    
7205  </p>  </p>
7206  <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
7207                  stream count change occurred and &lt;streams&gt; by the new number of                  stream count change occurred and &lt;streams&gt; by the new number of
7208                  active disk streams on that channel.                  active disk streams on that channel.
7209  </p>  </p>
7210  <a name="rfc.section.8.4"></a><h4><a name="SUBSCRIBE BUFFER_FILL">8.4</a>&nbsp;Disk stream buffer fill state changed</h4>  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />
7211    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7212    <a name="rfc.section.8.4"></a><h3>8.4.&nbsp;
7213    Disk stream buffer fill state changed</h3>
7214    
7215  <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
7216                  on the back-end changes by issuing the following command:                  on the back-end changes by issuing the following command:
# Line 5582  Intellectual Property and Copyright Stat Line 7221  Intellectual Property and Copyright Stat
7221  <p>SUBSCRIBE BUFFER_FILL  <p>SUBSCRIBE BUFFER_FILL
7222  </p>  </p>
7223  </blockquote><p>  </blockquote><p>
7224                    
7225  </p>  </p>
7226  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
7227  </p>  </p>
# Line 5592  Intellectual Property and Copyright Stat Line 7231  Intellectual Property and Copyright Stat
7231  <p>"NOTIFY:BUFFER_FILL:&lt;sampler-channel&gt; &lt;fill-data&gt;"  <p>"NOTIFY:BUFFER_FILL:&lt;sampler-channel&gt; &lt;fill-data&gt;"
7232  </p>  </p>
7233  </blockquote><p>  </blockquote><p>
7234                    
7235  </p>  </p>
7236  <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
7237                  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
7238                  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>
7239                  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.
7240  </p>  </p>
7241  <a name="rfc.section.8.5"></a><h4><a name="SUBSCRIBE INFO">8.5</a>&nbsp;Channel information changed</h4>  <a name="SUBSCRIBE INFO"></a><br /><hr />
7242    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7243    <a name="rfc.section.8.5"></a><h3>8.5.&nbsp;
7244    Channel information changed</h3>
7245    
7246  <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
7247                  back-end by issuing the following command:                  back-end by issuing the following command:
# Line 5610  Intellectual Property and Copyright Stat Line 7252  Intellectual Property and Copyright Stat
7252  <p>SUBSCRIBE CHANNEL_INFO  <p>SUBSCRIBE CHANNEL_INFO
7253  </p>  </p>
7254  </blockquote><p>  </blockquote><p>
7255                    
7256  </p>  </p>
7257  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
7258  </p>  </p>
# Line 5620  Intellectual Property and Copyright Stat Line 7262  Intellectual Property and Copyright Stat
7262  <p>"NOTIFY:CHANNEL_INFO:&lt;sampler-channel&gt;"  <p>"NOTIFY:CHANNEL_INFO:&lt;sampler-channel&gt;"
7263  </p>  </p>
7264  </blockquote><p>  </blockquote><p>
7265                    
7266  </p>  </p>
7267  <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
7268                  channel info change occurred. The front-end will have to send                  channel info change occurred. The front-end will have to send
# Line 5629  Intellectual Property and Copyright Stat Line 7271  Intellectual Property and Copyright Stat
7271                  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
7272                  message is sufficient here.                  message is sufficient here.
7273  </p>  </p>
7274  <a name="rfc.section.8.6"></a><h4><a name="SUBSCRIBE MISCELLANEOUS">8.6</a>&nbsp;Miscellaneous and debugging events</h4>  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />
7275    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7276    <a name="rfc.section.8.6"></a><h3>8.6.&nbsp;
7277    Total number of active voices changed</h3>
7278    
7279    <p>Client may want to be notified when the total number of voices on the
7280                    back-end changes by issuing the following command:
7281    </p>
7282    <p>
7283                        </p>
7284    <blockquote class="text">
7285    <p>SUBSCRIBE TOTAL_VOICE_COUNT
7286    </p>
7287    </blockquote><p>
7288                    
7289    </p>
7290    <p>Server will start sending the following notification messages:
7291    </p>
7292    <p>
7293                        </p>
7294    <blockquote class="text">
7295    <p>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;
7296    </p>
7297    </blockquote><p>
7298                    
7299    </p>
7300    <p>where &lt;voices&gt; will be replaced by the new number of
7301                    all currently active voices.
7302    </p>
7303    <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
7304    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7305    <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;
7306    Miscellaneous and debugging events</h3>
7307    
7308  <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
7309                  the server by issuing the following command:                  the server by issuing the following command:
# Line 5640  Intellectual Property and Copyright Stat Line 7314  Intellectual Property and Copyright Stat
7314  <p>SUBSCRIBE MISCELLANEOUS  <p>SUBSCRIBE MISCELLANEOUS
7315  </p>  </p>
7316  </blockquote><p>  </blockquote><p>
7317                    
7318  </p>  </p>
7319  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
7320  </p>  </p>
# Line 5650  Intellectual Property and Copyright Stat Line 7324  Intellectual Property and Copyright Stat
7324  <p>"NOTIFY:MISCELLANEOUS:&lt;string&gt;"  <p>"NOTIFY:MISCELLANEOUS:&lt;string&gt;"
7325  </p>  </p>
7326  </blockquote><p>  </blockquote><p>
7327                    
7328  </p>  </p>
7329  <p>where &lt;string&gt; will be replaced by whatever data server  <p>where &lt;string&gt; will be replaced by whatever data server
7330                  wants to send to the client. Client MAY display this data to the                  wants to send to the client. Client MAY display this data to the
7331                  user AS IS to facilitate debugging.                  user AS IS to facilitate debugging.
7332  </p>  </p>
7333  <a name="anchor14"></a><br /><hr />  <a name="anchor14"></a><br /><hr />
7334  <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>
7335  <a name="rfc.section.9"></a><h3>9.&nbsp;Security Considerations</h3>  <a name="rfc.section.9"></a><h3>9.&nbsp;
7336    Security Considerations</h3>
7337    
7338  <p>As there is so far no method of authentication and authorization  <p>As there is so far no method of authentication and authorization
7339              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 5666  Intellectual Property and Copyright Stat Line 7341  Intellectual Property and Copyright Stat
7341              system the LinuxSampler instance is running on.              system the LinuxSampler instance is running on.
7342  </p>  </p>
7343  <a name="anchor15"></a><br /><hr />  <a name="anchor15"></a><br /><hr />
7344  <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>
7345  <a name="rfc.section.10"></a><h3>10.&nbsp;Acknowledgments</h3>  <a name="rfc.section.10"></a><h3>10.&nbsp;
7346    Acknowledgments</h3>
7347    
7348  <p>This document has benefited greatly from the comments of the  <p>This document has benefited greatly from the comments of the
7349              following people, discussed on the LinuxSampler developer's mailing              following people, discussed on the LinuxSampler developer's mailing
# Line 5685  Intellectual Property and Copyright Stat Line 7361  Intellectual Property and Copyright Stat
7361  <p>Grigor Iliev  <p>Grigor Iliev
7362  </p>  </p>
7363  </blockquote><p>  </blockquote><p>
7364                
7365  </p>  </p>
7366  <a name="rfc.references1"></a><br /><hr />  <a name="rfc.references1"></a><br /><hr />
7367  <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>
7368  <h3>11.&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
7369  <table width="99%" border="0">  <table width="99%" border="0">
7370  <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 5700  Intellectual Property and Copyright Stat Line 7376  Intellectual Property and Copyright Stat
7376  </table>  </table>
7377    
7378  <a name="rfc.authors"></a><br /><hr />  <a name="rfc.authors"></a><br /><hr />
7379  <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>
7380  <h3>Author's Address</h3>  <h3>Author's Address</h3>
7381  <table width="99%" border="0" cellpadding="0" cellspacing="0">  <table width="99%" border="0" cellpadding="0" cellspacing="0">
7382  <tr><td class="author-text">&nbsp;</td>  <tr><td class="author-text">&nbsp;</td>
# Line 5718  Schoenebeck</td></tr> Line 7394  Schoenebeck</td></tr>
7394  <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>
7395  </table>  </table>
7396  <a name="rfc.copyright"></a><br /><hr />  <a name="rfc.copyright"></a><br /><hr />
7397  <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>
7398  <h3>Intellectual Property Statement</h3>  <h3>Full Copyright Statement</h3>
7399  <p class='copyright'>  <p class='copyright'>
7400  The IETF takes no position regarding the validity or scope of  Copyright &copy; The Internet Society (2006).</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>  
7401  <p class='copyright'>  <p class='copyright'>
7402  The IETF invites any interested party to bring to its  This document is subject to the rights,
7403  attention any copyrights, patents or patent applications, or  licenses and restrictions contained in BCP&nbsp;78,
7404  other proprietary rights which may cover technology that may be  and except as set forth therein,
7405  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>  
7406  <p class='copyright'>  <p class='copyright'>
7407  Copyright &copy; The Internet Society (2005). All Rights Reserved.</p>  This document and the information contained herein are provided
7408    on an &ldquo;AS IS&rdquo; basis and THE CONTRIBUTOR,
7409    THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY),
7410    THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM
7411    ALL WARRANTIES,
7412    EXPRESS OR IMPLIED,
7413    INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
7414    INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
7415    WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.</p>
7416    <h3>Intellectual Property</h3>
7417  <p class='copyright'>  <p class='copyright'>
7418  This document and translations of it may be copied and furnished to  The IETF takes no position regarding the validity or scope of any
7419  others, and derivative works that comment on or otherwise explain it  Intellectual Property Rights or other rights that might be claimed
7420  or assist in its implementation may be prepared, copied, published and  to pertain to the implementation or use of the technology
7421  distributed, in whole or in part, without restriction of any kind,  described in this document or the extent to which any license
7422  provided that the above copyright notice and this paragraph are  under such rights might or might not be available; nor does it
7423  included on all such copies and derivative works. However, this  represent that it has made any independent effort to identify any
7424  document itself may not be modified in any way, such as by removing  such rights.
7425  the copyright notice or references to the Internet Society or other  Information on the procedures with respect to
7426  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>  
7427  <p class='copyright'>  <p class='copyright'>
7428  The limited permissions granted above are perpetual and will not be  Copies of IPR disclosures made to the IETF Secretariat and any
7429  revoked by the Internet Society or its successors or assignees.</p>  assurances of licenses to be made available,
7430    or the result of an attempt made to obtain a general license or
7431    permission for the use of such proprietary rights by implementers or
7432    users of this specification can be obtained from the IETF on-line IPR
7433    repository at <a href='http://www.ietf.org/ipr'>http://www.ietf.org/ipr</a>.</p>
7434  <p class='copyright'>  <p class='copyright'>
7435  This document and the information contained herein is provided on an  The IETF invites any interested party to bring to its attention
7436  &ldquo;AS IS&rdquo; basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING  any copyrights,
7437  TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING  patents or patent applications,
7438  BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION  or other
7439  HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  proprietary rights that may cover technology that may be required
7440  MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.</p>  to implement this standard.
7441    Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p>
7442  <h3>Acknowledgment</h3>  <h3>Acknowledgment</h3>
7443  <p class='copyright'>  <p class='copyright'>
7444  Funding for the RFC Editor function is currently provided by the  Funding for the RFC Editor function is provided by
7445  Internet Society.</p>  the IETF Administrative Support Activity (IASA).</p>
7446  </body></html>  </body></html>
Legend:
Removed from v.708  
changed lines
  Added in v.974
  ViewVC Help
Powered by ViewVC