/[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 542 by senoner, Sun May 15 15:31:45 2005 UTC revision 708 by schoenebeck, Thu Jul 21 09:18:40 2005 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.25 (http://xml.resource.org/)">  <meta name="generator" content="xml2rfc v1.29 (http://xml.resource.org/)">
7  <style type='text/css'>  <style type='text/css'>
8  <!--  <!--
9      body {      body {
# Line 18  Line 18 
18          font-weight: bold; text-align: right;          font-weight: bold; text-align: right;
19          font-family: helvetica, arial, sans-serif;          font-family: helvetica, arial, sans-serif;
20          background-color: transparent; }          background-color: transparent; }
21      td.rfcbug { background-color: #000000 ; width: 30px ; height: 30px ;      td.rfcbug { background-color: #000000 ; width: 30px ; height: 30px ;
22          text-align: justify; vertical-align: middle ; padding-top: 2px ; }          text-align: justify; vertical-align: middle ; padding-top: 2px ; }
23      td.rfcbug span.RFC { color: #666666; font-weight: bold; text-decoration: none;      td.rfcbug span.RFC { color: #666666; font-weight: bold; text-decoration: none;
24          background-color: #000000 ;          background-color: #000000 ;
# Line 40  Line 40 
40    
41      a.info span{display: none}      a.info span{display: none}
42    
43      a.info:hover span{ /*the span will display just on :hover state*/      a.info:hover span.info{ /*the span will display just on :hover state*/
44          display:block;          display:block;
45          position:absolute;          position:absolute;
46          font-size: smaller ;          font-size: smaller ;
# Line 61  Line 61 
61    
62      span.emph { font-style: italic; }      span.emph { font-style: italic; }
63      span.strong { font-weight: bold; }      span.strong { font-weight: bold; }
64      span.verb { font-family: "Courier New", Courier, monospace ; }      span.verb, span.vbare { font-family: "Courier New", Courier, monospace ; }
65    
66        span.vemph { font-style: italic; font-family: "Courier New", Courier, monospace ; }
67        span.vstrong { font-weight: bold; font-family: "Courier New", Courier, monospace ; }
68        span.vdeluxe { font-weight: bold; font-style: italic; font-family: "Courier New", Courier, monospace ; }
69    
70      ol.text { margin-left: 2em; margin-right: 2em; }      ol.text { margin-left: 2em; margin-right: 2em; }
71      ul.text { margin-left: 2em; margin-right: 2em; }      ul.text { margin-left: 2em; margin-right: 2em; }
# Line 69  Line 73 
73    
74      pre { margin-left: 3em; color: #333333;  background-color: transparent;      pre { margin-left: 3em; color: #333333;  background-color: transparent;
75          font-family: "Courier New", Courier, monospace ; font-size: small ;          font-family: "Courier New", Courier, monospace ; font-size: small ;
76            text-align: left;
77          }          }
78    
79      h3 { color: #333333; font-size: medium ;      h3 { color: #333333; font-size: medium ;
# Line 110  Line 115 
115  <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">
116  <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>
117  <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>
118  <tr><td class="header">Expires: November 7, 2005</td><td class="header">Engineering e. V.</td></tr>  <tr><td class="header">Expires: November 2, 2005</td><td class="header">Engineering e. V.</td></tr>
119  <tr><td class="header">&nbsp;</td><td class="header">May 9, 2005</td></tr>  <tr><td class="header">&nbsp;</td><td class="header">May 2005</td></tr>
120  </table></td></tr></table>  </table></td></tr></table>
121  <div align="right"><span class="title"><br />LinuxSampler Control Protocol</span></div>  <div align="right"><span class="title"><br />LinuxSampler Control Protocol</span></div>
122  <div align="right"><span class="title"><br />lscp.txt</span></div>  <div align="right"><span class="title"><br />LSCP 1.1</span></div>
123    
124  <h3>Status of this Memo</h3>  <h3>Status of this Memo</h3>
125  <p>  <p>
126  This document is an Internet-Draft and is  This document is an Internet-Draft and is
127  in full conformance with all provisions of Section 10 of RFC2026.</p>  in full conformance with all provisions of Section&nbsp;10 of RFC&nbsp;2026.</p>
128  <p>  <p>
129  Internet-Drafts are working documents of the Internet Engineering  Internet-Drafts are working documents of the Internet Engineering
130  Task Force (IETF), its areas, and its working groups.  Task Force (IETF), its areas, and its working groups.
# Line 129  Internet-Drafts.</p> Line 134  Internet-Drafts.</p>
134  Internet-Drafts are draft documents valid for a maximum of six months  Internet-Drafts are draft documents valid for a maximum of six months
135  and may be updated, replaced, or obsoleted by other documents at any time.  and may be updated, replaced, or obsoleted by other documents at any time.
136  It is inappropriate to use Internet-Drafts as reference material or to cite  It is inappropriate to use Internet-Drafts as reference material or to cite
137  them other than as "work in progress."</p>  them other than as &ldquo;work in progress.&rdquo;</p>
138  <p>  <p>
139  The list of current Internet-Drafts can be accessed at  The list of current Internet-Drafts can be accessed at
140  <a href='http://www.ietf.org/ietf/1id-abstracts.txt'>http://www.ietf.org/ietf/1id-abstracts.txt</a>.</p>  <a href='http://www.ietf.org/ietf/1id-abstracts.txt'>http://www.ietf.org/ietf/1id-abstracts.txt</a>.</p>
# Line 137  The list of current Internet-Drafts can Line 142  The list of current Internet-Drafts can
142  The list of Internet-Draft Shadow Directories can be accessed at  The list of Internet-Draft Shadow Directories can be accessed at
143  <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>
144  <p>  <p>
145  This Internet-Draft will expire on November 7, 2005.</p>  This Internet-Draft will expire on November 2, 2005.</p>
146    
147  <h3>Copyright Notice</h3>  <h3>Copyright Notice</h3>
148  <p>  <p>
149  Copyright (C) The Internet Society (2005). All Rights Reserved.</p>  Copyright &copy; The Internet Society (2005). All Rights Reserved.</p>
150    
151  <h3>Abstract</h3>  <h3>Abstract</h3>
152    
153  <p>The LinuxSampler Control Protocol (LSCP) is an  <p>The LinuxSampler Control Protocol (LSCP) is an
154              application-level protocol primarily intended for local and              application-level protocol primarily intended for local and
155              remote controlling the LinuxSampler main application, which is a              remote controlling the LinuxSampler backend application, which is a
156              sophisticated console application essentially playing back audio              sophisticated server-like console application essentially playing
157              samples and manipulating the samples in real time to certain              back audio samples and manipulating the samples in real time to
158              extent.              certain extent.
159  </p><a name="toc"></a><br /><hr />  </p><a name="toc"></a><br /><hr />
160  <h3>Table of Contents</h3>  <h3>Table of Contents</h3>
161  <p class="toc">  <p class="toc">
162  <a href="#anchor1">1.</a>&nbsp;  <a href="#anchor1">1.</a>&nbsp;
163  Requirements notation<br />  Requirements notation<br />
164  <a href="#anchor2">2.</a>&nbsp;  <a href="#LSCP versioning">2.</a>&nbsp;
165    Versioning of this specification<br />
166    <a href="#anchor2">3.</a>&nbsp;
167  Introduction<br />  Introduction<br />
168  <a href="#anchor3">3.</a>&nbsp;  <a href="#anchor3">4.</a>&nbsp;
169  Focus of this protocol<br />  Focus of this protocol<br />
170  <a href="#anchor4">4.</a>&nbsp;  <a href="#anchor4">5.</a>&nbsp;
171  Communication Overview<br />  Communication Overview<br />
172  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor5">4.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor5">5.1</a>&nbsp;
173  Request/response communication method<br />  Request/response communication method<br />
174  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor6">4.1.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor6">5.1.1</a>&nbsp;
175  Result format<br />  Result format<br />
176  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor7">4.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor7">5.2</a>&nbsp;
177  Subscribe/notify communication method<br />  Subscribe/notify communication method<br />
178  <a href="#anchor8">5.</a>&nbsp;  <a href="#control_commands">6.</a>&nbsp;
179  Description for control commands<br />  Description for control commands<br />
180  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor9">5.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor8">6.1</a>&nbsp;
181  Ignored lines and comments<br />  Ignored lines and comments<br />
182  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor10">5.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor9">6.2</a>&nbsp;
183  Configuring audio drivers<br />  Configuring audio drivers<br />
184  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">5.2.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">6.2.1</a>&nbsp;
185  Getting amount of available audio output drivers<br />  Getting amount of available audio output drivers<br />
186  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">5.2.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">6.2.2</a>&nbsp;
187  Getting all available audio output drivers<br />  Getting all available audio output drivers<br />
188  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DRIVER INFO">5.2.3</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DRIVER INFO">6.2.3</a>&nbsp;
189  Getting information about a specific audio  Getting information about a specific audio
190                  output driver<br />                  output driver<br />
191  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">5.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;
192  Getting information about specific audio  Getting information about specific audio
193                  output driver parameter<br />                  output driver parameter<br />
194  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE AUDIO_OUTPUT_DEVICE">5.2.5</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE AUDIO_OUTPUT_DEVICE">6.2.5</a>&nbsp;
195  Creating an audio output device<br />  Creating an audio output device<br />
196  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY AUDIO_OUTPUT_DEVICE">5.2.6</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY AUDIO_OUTPUT_DEVICE">6.2.6</a>&nbsp;
197  Destroying an audio output device<br />  Destroying an audio output device<br />
198  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DEVICES">5.2.7</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DEVICES">6.2.7</a>&nbsp;
199  Getting all created audio output device count<br />  Getting all created audio output device count<br />
200  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AUDIO_OUTPUT_DEVICES">5.2.8</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AUDIO_OUTPUT_DEVICES">6.2.8</a>&nbsp;
201  Getting all created audio output device list<br />  Getting all created audio output device list<br />
202  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DEVICE INFO">5.2.9</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DEVICE INFO">6.2.9</a>&nbsp;
203  Getting current settings of an audio output device<br />  Getting current settings of an audio output device<br />
204  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET AUDIO_OUTPUT_DEVICE_PARAMETER">5.2.10</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET AUDIO_OUTPUT_DEVICE_PARAMETER">6.2.10</a>&nbsp;
205  Changing settings of audio output devices<br />  Changing settings of audio output devices<br />
206  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_CHANNEL INFO">5.2.11</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_CHANNEL INFO">6.2.11</a>&nbsp;
207  Getting information about an audio channel<br />  Getting information about an audio channel<br />
208  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO">5.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;
209  Getting information about specific audio channel parameter<br />  Getting information about specific audio channel parameter<br />
210  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET AUDIO_OUTPUT_CHANNEL_PARAMETER">5.2.13</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET AUDIO_OUTPUT_CHANNEL_PARAMETER">6.2.13</a>&nbsp;
211  Changing settings of audio output channels<br />  Changing settings of audio output channels<br />
212  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor11">5.3</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor10">6.3</a>&nbsp;
213  Configuring MIDI input drivers<br />  Configuring MIDI input drivers<br />
214  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_MIDI_INPUT_DRIVERS">5.3.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_MIDI_INPUT_DRIVERS">6.3.1</a>&nbsp;
215  Getting amount of available MIDI input drivers<br />  Getting amount of available MIDI input drivers<br />
216  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">5.3.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">6.3.2</a>&nbsp;
217  Getting all available MIDI input drivers<br />  Getting all available MIDI input drivers<br />
218  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DRIVER INFO">5.3.3</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DRIVER INFO">6.3.3</a>&nbsp;
219  Getting information about a specific MIDI input driver<br />  Getting information about a specific MIDI input driver<br />
220  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DRIVER_PARAMETER INFO">5.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;
221  Getting information about specific MIDI input driver parameter<br />  Getting information about specific MIDI input driver parameter<br />
222  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE MIDI_INPUT_DEVICE">5.3.5</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE MIDI_INPUT_DEVICE">6.3.5</a>&nbsp;
223  Creating a MIDI input device<br />  Creating a MIDI input device<br />
224  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY MIDI_INPUT_DEVICE">5.3.6</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY MIDI_INPUT_DEVICE">6.3.6</a>&nbsp;
225  Destroying a MIDI input device<br />  Destroying a MIDI input device<br />
226  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DEVICES">5.3.7</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DEVICES">6.3.7</a>&nbsp;
227  Getting all created MIDI input device count<br />  Getting all created MIDI input device count<br />
228  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INPUT_DEVICES">5.3.8</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INPUT_DEVICES">6.3.8</a>&nbsp;
229  Getting all created MIDI input device list<br />  Getting all created MIDI input device list<br />
230  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DEVICE INFO">5.3.9</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DEVICE INFO">6.3.9</a>&nbsp;
231  Getting current settings of a MIDI input device<br />  Getting current settings of a MIDI input device<br />
232  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INPUT_DEVICE_PARAMETER">5.3.10</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INPUT_DEVICE_PARAMETER">6.3.10</a>&nbsp;
233  Changing settings of MIDI input devices<br />  Changing settings of MIDI input devices<br />
234  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_PORT INFO">5.3.11</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_PORT INFO">6.3.11</a>&nbsp;
235  Getting information about a MIDI port<br />  Getting information about a MIDI port<br />
236  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_PORT_PARAMETER INFO">5.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;
237  Getting information about specific MIDI port parameter<br />  Getting information about specific MIDI port parameter<br />
238  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INPUT_PORT_PARAMETER">5.3.13</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INPUT_PORT_PARAMETER">6.3.13</a>&nbsp;
239  Changing settings of MIDI input ports<br />  Changing settings of MIDI input ports<br />
240  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">5.4</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor11">6.4</a>&nbsp;
241  Configuring sampler channels<br />  Configuring sampler channels<br />
242  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LOAD INSTRUMENT">5.4.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LOAD INSTRUMENT">6.4.1</a>&nbsp;
243  Loading an instrument<br />  Loading an instrument<br />
244  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LOAD ENGINE">5.4.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LOAD ENGINE">6.4.2</a>&nbsp;
245  Loading a sampler engine<br />  Loading a sampler engine<br />
246  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNELS">5.4.3</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNELS">6.4.3</a>&nbsp;
247  Getting all created sampler channel count<br />  Getting all created sampler channel count<br />
248  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST CHANNELS">5.4.4</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST CHANNELS">6.4.4</a>&nbsp;
249  Getting all created sampler channel list<br />  Getting all created sampler channel list<br />
250  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD CHANNEL">5.4.5</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD CHANNEL">6.4.5</a>&nbsp;
251  Adding a new sampler channel<br />  Adding a new sampler channel<br />
252  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE CHANNEL">5.4.6</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE CHANNEL">6.4.6</a>&nbsp;
253  Removing a sampler channel<br />  Removing a sampler channel<br />
254  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_ENGINES">5.4.7</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_ENGINES">6.4.7</a>&nbsp;
255  Getting amount of available engines<br />  Getting amount of available engines<br />
256  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_ENGINES">5.4.8</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_ENGINES">6.4.8</a>&nbsp;
257  Getting all available engines<br />  Getting all available engines<br />
258  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET ENGINE INFO">5.4.9</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET ENGINE INFO">6.4.9</a>&nbsp;
259  Getting information about an engine<br />  Getting information about an engine<br />
260  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL INFO">5.4.10</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL INFO">6.4.10</a>&nbsp;
261  Getting sampler channel information<br />  Getting sampler channel information<br />
262  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL VOICE_COUNT">5.4.11</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL VOICE_COUNT">6.4.11</a>&nbsp;
263  Current number of active voices<br />  Current number of active voices<br />
264  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL STREAM_COUNT">5.4.12</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL STREAM_COUNT">6.4.12</a>&nbsp;
265  Current number of active disk streams<br />  Current number of active disk streams<br />
266  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL BUFFER_FILL">5.4.13</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL BUFFER_FILL">6.4.13</a>&nbsp;
267  Current fill state of disk stream buffers<br />  Current fill state of disk stream buffers<br />
268  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_DEVICE">5.4.14</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_DEVICE">6.4.14</a>&nbsp;
269  Setting audio output device<br />  Setting audio output device<br />
270  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_TYP">5.4.15</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_TYP">6.4.15</a>&nbsp;
271  Setting audio output type<br />  Setting audio output type<br />
272  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_CHANNEL">5.4.16</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_CHANNEL">6.4.16</a>&nbsp;
273  Setting audio output channel<br />  Setting audio output channel<br />
274  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_DEVICE">5.4.17</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_DEVICE">6.4.17</a>&nbsp;
275  Setting MIDI input device<br />  Setting MIDI input device<br />
276  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_TYPE">5.4.18</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_TYPE">6.4.18</a>&nbsp;
277  Setting MIDI input type<br />  Setting MIDI input type<br />
278  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_PORT">5.4.19</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_PORT">6.4.19</a>&nbsp;
279  Setting MIDI input port<br />  Setting MIDI input port<br />
280  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_CHANNEL">5.4.20</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_CHANNEL">6.4.20</a>&nbsp;
281  Setting MIDI input channel<br />  Setting MIDI input channel<br />
282  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL VOLUME">5.4.21</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL VOLUME">6.4.21</a>&nbsp;
283  Setting channel volume<br />  Setting channel volume<br />
284  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">5.4.22</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MUTE">6.4.22</a>&nbsp;
285    Muting a sampler channel<br />
286    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL SOLO">6.4.23</a>&nbsp;
287    Soloing a sampler channel<br />
288    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.24</a>&nbsp;
289  Resetting a sampler channel<br />  Resetting a sampler channel<br />
290  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor13">5.5</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5</a>&nbsp;
291  Controlling connection<br />  Controlling connection<br />
292  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE">5.5.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE">6.5.1</a>&nbsp;
293  Register front-end for receiving event messages<br />  Register front-end for receiving event messages<br />
294  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#UNSUBSCRIBE">5.5.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#UNSUBSCRIBE">6.5.2</a>&nbsp;
295  Unregister front-end for not receiving event messages<br />  Unregister front-end for not receiving event messages<br />
296  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET ECHO">5.5.3</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET ECHO">6.5.3</a>&nbsp;
297  Enable or disable echo of commands<br />  Enable or disable echo of commands<br />
298  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#QUIT">5.5.4</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#QUIT">6.5.4</a>&nbsp;
299  Close client connection<br />  Close client connection<br />
300  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor14">5.6</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor13">6.6</a>&nbsp;
301  Global commands<br />  Global commands<br />
302  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET">5.6.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET">6.6.1</a>&nbsp;
303  Reset sampler<br />  Reset sampler<br />
304  <a href="#command_syntax">6.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.2</a>&nbsp;
305    General sampler informations<br />
306    <a href="#command_syntax">7.</a>&nbsp;
307  Command Syntax<br />  Command Syntax<br />
308  <a href="#events">7.</a>&nbsp;  <a href="#events">8.</a>&nbsp;
309  Events<br />  Events<br />
310  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL">7.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL">8.1</a>&nbsp;
311  Number of sampler channels changed<br />  Number of sampler channels changed<br />
312  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">7.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.2</a>&nbsp;
313  Number of active voices changed<br />  Number of active voices changed<br />
314  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">7.3</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">8.3</a>&nbsp;
315  Number of active disk streams changed<br />  Number of active disk streams changed<br />
316  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">7.4</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">8.4</a>&nbsp;
317  Disk stream buffer fill state changed<br />  Disk stream buffer fill state changed<br />
318  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE INFO">7.5</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE INFO">8.5</a>&nbsp;
319  Channel information changed<br />  Channel information changed<br />
320  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">7.6</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.6</a>&nbsp;
321  Miscellaneous and debugging events<br />  Miscellaneous and debugging events<br />
322  <a href="#anchor15">8.</a>&nbsp;  <a href="#anchor14">9.</a>&nbsp;
323  Security Considerations<br />  Security Considerations<br />
324  <a href="#anchor16">9.</a>&nbsp;  <a href="#anchor15">10.</a>&nbsp;
325  Acknowledgments<br />  Acknowledgments<br />
326  <a href="#rfc.references1">10.</a>&nbsp;  <a href="#rfc.references1">11.</a>&nbsp;
327  References<br />  References<br />
328  <a href="#rfc.authors">&#167;</a>&nbsp;  <a href="#rfc.authors">&#167;</a>&nbsp;
329  Author's Address<br />  Author's Address<br />
# Line 326  Intellectual Property and Copyright Stat Line 339  Intellectual Property and Copyright Stat
339  <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",  <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
340              "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",              "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
341              and "OPTIONAL" in this document are to be interpreted as              and "OPTIONAL" in this document are to be interpreted as
342              described in <a class="info" href="#RFC2119">[RFC2119]<span>Bradner, S., Key words for use in RFCs to Indicate Requirement Levels, March 1997.</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>.
343  </p>  </p>
344  <p>This protocol is always case-sensitive if not explicitly  <p>This protocol is always case-sensitive if not explicitly
345              claimed the opposite.              claimed the opposite.
# Line 338  Intellectual Property and Copyright Stat Line 351  Intellectual Property and Copyright Stat
351              character as defined in the ASCII standard), thus the following              character as defined in the ASCII standard), thus the following
352              example:              example:
353  </p>  </p>
354  <p></p>  <p>
355                    </p>
356  <blockquote class="text">  <blockquote class="text">
357  <p>C: "some line"  <p>C: "some line"
358  </p>  </p>
359  <p>&nbsp;&nbsp;&nbsp;"another line"  <p>&nbsp;&nbsp;&nbsp;"another line"
360  </p>  </p>
361  </blockquote>  </blockquote><p>
362    
363    </p>
364  <p>must actually be interpreted as client sending the following  <p>must actually be interpreted as client sending the following
365              message:              message:
366  </p>  </p>
367  <p></p>  <p>
368                    </p>
369  <blockquote class="text">  <blockquote class="text">
370  <p>"some line&lt;CR&gt;&lt;LF&gt;another  <p>"some line&lt;CR&gt;&lt;LF&gt;another
371                      line&lt;CR&gt;&lt;LF&gt;"                      line&lt;CR&gt;&lt;LF&gt;"
372  </p>  </p>
373  </blockquote>  </blockquote><p>
374    
375    </p>
376  <p>where &lt;CR&gt; symbolizes the carriage return character and  <p>where &lt;CR&gt; symbolizes the carriage return character and
377              &lt;LF&gt; the line feed character as defined in the ASCII              &lt;LF&gt; the line feed character as defined in the ASCII
378              standard.              standard.
# Line 363  Intellectual Property and Copyright Stat Line 380  Intellectual Property and Copyright Stat
380  <p>Due to technical reasons, messages can arbitrary be  <p>Due to technical reasons, messages can arbitrary be
381              fragmented, means the following example:              fragmented, means the following example:
382  </p>  </p>
383  <p></p>  <p>
384                    </p>
385  <blockquote class="text">  <blockquote class="text">
386  <p>S: "abcd"  <p>S: "abcd"
387  </p>  </p>
388  </blockquote>  </blockquote><p>
389    
390    </p>
391  <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
392              following sequence scenario:              following sequence scenario:
393  </p>  </p>
394  <p></p>  <p>
395                    </p>
396  <ul class="text">  <ul class="text">
397  <li>server sending message "a"  <li>server sending message "a"
398  </li>  </li>
# Line 388  Intellectual Property and Copyright Stat Line 408  Intellectual Property and Copyright Stat
408  <li>followed by server sending the message  <li>followed by server sending the message
409                      "&lt;LF&gt;"                      "&lt;LF&gt;"
410  </li>  </li>
411  </ul>  </ul><p>
412    
413    </p>
414  <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
415              return and line feed characters respectively.              return and line feed characters respectively.
416  </p>  </p>
417    <a name="LSCP versioning"></a><br /><hr />
418    <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>
419    <a name="rfc.section.2"></a><h3>2.&nbsp;Versioning of this specification</h3>
420    
421    <p>LSCP will certainly be extended and enhanced by-and-by. Each official
422                release of the LSCP specification will be tagged with a unique version
423                tuple. The version tuple consists at least of a major and minor version
424                number like:
425    
426    </p>
427    <p>
428                    </p>
429    <blockquote class="text">
430    <p>"1.2"
431    </p>
432    </blockquote><p>
433    
434    </p>
435    <p>
436                In this example the major version number would be "1" and the minor
437                version number would be "2". Note that the version tuple might also
438                have more than two elements. The major version number defines a
439                group of backward compatible versions. That means a frontend is
440                compatible to the connected sampler if and only if the LSCP versions
441                to which each of the two parties complies to, match both of the
442                following rules:
443    
444    </p>
445    <p>Compatibility:
446    </p>
447    <p>
448                    </p>
449    <ol class="text">
450    <li>The frontend's LSCP major version and the sampler's LSCP
451                        major version are exactly equal.
452    </li>
453    <li>The frontend's LSCP minor version is less or equal than
454                        the sampler's LSCP minor version.
455    </li>
456    </ol><p>
457    
458    </p>
459    <p>
460                Compatibility can only be claimed if both rules are true.
461                The frontend can use the
462                <a class="info" href="#GET SERVER INFO">"GET SERVER INFO"<span> (</span><span class="info">General sampler informations</span><span>)</span></a> command to
463                get the version of the LSCP specification the sampler complies with.
464    
465    </p>
466  <a name="anchor2"></a><br /><hr />  <a name="anchor2"></a><br /><hr />
467  <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="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
468  <a name="rfc.section.2"></a><h3>2.&nbsp;Introduction</h3>  <a name="rfc.section.3"></a><h3>3.&nbsp;Introduction</h3>
469    
470  <p>LinuxSampler is a so called software sampler application  <p>LinuxSampler is a so called software sampler application
471              capable to playback audio samples from a computer's Random              capable to playback audio samples from a computer's Random
# Line 408  Intellectual Property and Copyright Stat Line 478  Intellectual Property and Copyright Stat
478              arbitrary MIDI input method and arbitrary MIDI channel (e.g.              arbitrary MIDI input method and arbitrary MIDI channel (e.g.
479              sampler channel 17 could be connected to an ALSA sequencer              sampler channel 17 could be connected to an ALSA sequencer
480              device 64:0 and listening to MIDI channel 1 there). Each sampler              device 64:0 and listening to MIDI channel 1 there). Each sampler
481              engine will be assigned an own instance of one of the available              channel will be associated with an instance of one of the available
482              sampler engines (e.g. GigEngine, DLSEngine). The audio output of              sampler engines (e.g. GigEngine, DLSEngine). The audio output of
483              each sampler channel can be routed to an arbitrary audio output              each sampler channel can be routed to an arbitrary audio output
484              method (ALSA / JACK) and an arbitrary audio output channel              method (ALSA / JACK) and an arbitrary audio output channel
# Line 416  Intellectual Property and Copyright Stat Line 486  Intellectual Property and Copyright Stat
486  </p>  </p>
487  <a name="anchor3"></a><br /><hr />  <a name="anchor3"></a><br /><hr />
488  <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="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
489  <a name="rfc.section.3"></a><h3>3.&nbsp;Focus of this protocol</h3>  <a name="rfc.section.4"></a><h3>4.&nbsp;Focus of this protocol</h3>
490    
491  <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
492              a running LinuxSampler instance and to retrieve information              a running LinuxSampler instance and to retrieve information
# Line 428  Intellectual Property and Copyright Stat Line 498  Intellectual Property and Copyright Stat
498  </p>  </p>
499  <a name="anchor4"></a><br /><hr />  <a name="anchor4"></a><br /><hr />
500  <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="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
501  <a name="rfc.section.4"></a><h3>4.&nbsp;Communication Overview</h3>  <a name="rfc.section.5"></a><h3>5.&nbsp;Communication Overview</h3>
502    
503  <p>There are two distinct methods of communication between a  <p>There are two distinct methods of communication between a
504              running instance of LinuxSampler and one or more control              running instance of LinuxSampler and one or more control
# Line 441  Intellectual Property and Copyright Stat Line 511  Intellectual Property and Copyright Stat
511              implemented in the front-end application. The two communication              implemented in the front-end application. The two communication
512              methods will be described next.              methods will be described next.
513  </p>  </p>
514  <a name="rfc.section.4.1"></a><h4><a name="anchor5">4.1</a>&nbsp;Request/response communication method</h4>  <a name="rfc.section.5.1"></a><h4><a name="anchor5">5.1</a>&nbsp;Request/response communication method</h4>
515    
516  <p>This simple communication method is based on TCP. The  <p>This simple communication method is based on
517                    <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
518                  front-end application establishes a TCP connection to the                  front-end application establishes a TCP connection to the
519                  LinuxSampler instance on a certain host system. Then the                  LinuxSampler instance on a certain host system. Then the
520                  front-end application will send certain ASCII based commands                  front-end application will send certain ASCII based commands
# Line 483  Intellectual Property and Copyright Stat Line 554  Intellectual Property and Copyright Stat
554                  processed in the order they were received and result sets                  processed in the order they were received and result sets
555                  MUST be sent back in the same order.                  MUST be sent back in the same order.
556  </p>  </p>
557  <a name="rfc.section.4.1.1"></a><h4><a name="anchor6">4.1.1</a>&nbsp;Result format</h4>  <a name="rfc.section.5.1.1"></a><h4><a name="anchor6">5.1.1</a>&nbsp;Result format</h4>
558    
559  <p>Result set could be one of the following types:  <p>Result set could be one of the following types:
560  </p>  </p>
561  <p></p>  <p>
562                            </p>
563  <ol class="text">  <ol class="text">
564  <li>Normal  <li>Normal
565  </li>  </li>
# Line 495  Intellectual Property and Copyright Stat Line 567  Intellectual Property and Copyright Stat
567  </li>  </li>
568  <li>Error  <li>Error
569  </li>  </li>
570  </ol>  </ol><p>
571    
572    </p>
573  <p>Warning and Error result sets MUST be single line and  <p>Warning and Error result sets MUST be single line and
574                      have the following format:                      have the following format:
575  </p>  </p>
576  <p></p>  <p>
577                            </p>
578  <ul class="text">  <ul class="text">
579  <li>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;"  <li>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;"
580  </li>  </li>
581  <li>"ERR:&lt;error-code&gt;:&lt;error-message&gt;"  <li>"ERR:&lt;error-code&gt;:&lt;error-message&gt;"
582  </li>  </li>
583  </ul>  </ul><p>
584    
585    </p>
586  <p>Where &lt;warning-code&gt; and &lt;error-code&gt; are  <p>Where &lt;warning-code&gt; and &lt;error-code&gt; are
587                      numeric unique identifiers of the warning or error and                      numeric unique identifiers of the warning or error and
588                      &lt;warning-message&gt; and &lt;error-message&gt; are                      &lt;warning-message&gt; and &lt;error-message&gt; are
# Line 516  Intellectual Property and Copyright Stat Line 591  Intellectual Property and Copyright Stat
591  </p>  </p>
592  <p>Examples:  <p>Examples:
593  </p>  </p>
594  <p></p>  <p>
595                            </p>
596  <blockquote class="text">  <blockquote class="text">
597  <p>C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0  <p>C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0
598  </p>  </p>
599  <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."
600  </p>  </p>
601  </blockquote>  </blockquote><p>
602    
603  <p></p>  </p>
604    <p>
605                            </p>
606  <blockquote class="text">  <blockquote class="text">
607  <p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"  <p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"
608  </p>  </p>
609  <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'."
610  </p>  </p>
611  </blockquote>  </blockquote><p>
612    
613  <p></p>  </p>
614    <p>
615                            </p>
616  <blockquote class="text">  <blockquote class="text">
617  <p>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"  <p>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"
618  </p>  </p>
619  <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."
620  </p>  </p>
621  </blockquote>  </blockquote><p>
622    
623    </p>
624  <p>Normal result sets could be:  <p>Normal result sets could be:
625  </p>  </p>
626  <p></p>  <p>
627                            </p>
628  <ol class="text">  <ol class="text">
629  <li>Empty  <li>Empty
630  </li>  </li>
# Line 550  Intellectual Property and Copyright Stat Line 632  Intellectual Property and Copyright Stat
632  </li>  </li>
633  <li>Multi-line  <li>Multi-line
634  </li>  </li>
635  </ol>  </ol><p>
636    
637    </p>
638  <p> Empty result set is issued when the server only  <p> Empty result set is issued when the server only
639                      needed to acknowledge the fact that the request was                      needed to acknowledge the fact that the request was
640                      received and it was processed successfully and no                      received and it was processed successfully and no
641                      additional information is available. This result set has                      additional information is available. This result set has
642                      the following format:                      the following format:
643  </p>  </p>
644  <p></p>  <p>
645                            </p>
646  <blockquote class="text">  <blockquote class="text">
647  <p>"OK"  <p>"OK"
648  </p>  </p>
649  </blockquote>  </blockquote><p>
650    
651    </p>
652  <p>Example:  <p>Example:
653  </p>  </p>
654  <p></p>  <p>
655                            </p>
656  <blockquote class="text">  <blockquote class="text">
657  <p>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"  <p>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"
658  </p>  </p>
659  <p>S: "OK"  <p>S: "OK"
660  </p>  </p>
661  </blockquote>  </blockquote><p>
662    
663    </p>
664  <p>Single line result sets are command specific. One  <p>Single line result sets are command specific. One
665                      example of a single line result set is an empty line.                      example of a single line result set is an empty line.
666                      Multi-line result sets are command specific and may                      Multi-line result sets are command specific and may
667                      include one or more lines of information. They MUST                      include one or more lines of information. They MUST
668                      always end with the following line:                      always end with the following line:
669  </p>  </p>
670  <p></p>  <p>
671                            </p>
672  <blockquote class="text">  <blockquote class="text">
673  <p>"."  <p>"."
674  </p>  </p>
675  </blockquote>  </blockquote><p>
676    
677    </p>
678  <p>Example:  <p>Example:
679  </p>  </p>
680  <p></p>  <p>
681                            </p>
682  <blockquote class="text">  <blockquote class="text">
683  <p>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"  <p>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
684  </p>  </p>
# Line 608  Intellectual Property and Copyright Stat Line 698  Intellectual Property and Copyright Stat
698  </p>  </p>
699  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
700  </p>  </p>
701  </blockquote>  </blockquote><p>
702    
703    </p>
704  <p>In addition to above mentioned formats, warnings and  <p>In addition to above mentioned formats, warnings and
705                      empty result sets MAY be indexed. In this case, they                      empty result sets MAY be indexed. In this case, they
706                      have the following formats respectively:                      have the following formats respectively:
707  </p>  </p>
708  <p></p>  <p>
709                            </p>
710  <ul class="text">  <ul class="text">
711  <li>"WRN[&lt;index&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;"  <li>"WRN[&lt;index&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;"
712  </li>  </li>
713  <li>"OK[&lt;index&gt;]"  <li>"OK[&lt;index&gt;]"
714  </li>  </li>
715  </ul>  </ul><p>
716    
717    </p>
718  <p>where &lt;index&gt; is command specific and is used  <p>where &lt;index&gt; is command specific and is used
719                      to indicate channel number that the result set was                      to indicate channel number that the result set was
720                      related to or other integer value.                      related to or other integer value.
# Line 631  Intellectual Property and Copyright Stat Line 724  Intellectual Property and Copyright Stat
724  </p>  </p>
725  <p>Examples:  <p>Examples:
726  </p>  </p>
727  <p></p>  <p>
728                            </p>
729  <blockquote class="text">  <blockquote class="text">
730  <p>C: "ADD CHANNEL"  <p>C: "ADD CHANNEL"
731  </p>  </p>
732  <p>S: "OK[12]"  <p>S: "OK[12]"
733  </p>  </p>
734  </blockquote>  </blockquote><p>
735    
736  <p></p>  </p>
737    <p>
738                            </p>
739  <blockquote class="text">  <blockquote class="text">
740  <p>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"  <p>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"
741  </p>  </p>
742  <p>S: "WRN[0]:32:Sample rate not supported, using 44100 instead."  <p>S: "WRN[0]:32:Sample rate not supported, using 44100 instead."
743  </p>  </p>
744  </blockquote>  </blockquote><p>
745    
746  <a name="rfc.section.4.2"></a><h4><a name="anchor7">4.2</a>&nbsp;Subscribe/notify communication method</h4>  </p>
747    <a name="rfc.section.5.2"></a><h4><a name="anchor7">5.2</a>&nbsp;Subscribe/notify communication method</h4>
748    
749  <p>This more sophisticated communication method is actually  <p>This more sophisticated communication method is actually
750                  only an extension of the simple request/response                  only an extension of the simple request/response
# Line 659  Intellectual Property and Copyright Stat Line 756  Intellectual Property and Copyright Stat
756                  as they happen on the server. The SUBSCRIBE command has the                  as they happen on the server. The SUBSCRIBE command has the
757                  following syntax:                  following syntax:
758  </p>  </p>
759  <p></p>  <p>
760                        </p>
761  <blockquote class="text">  <blockquote class="text">
762  <p>SUBSCRIBE &lt;event-id&gt;  <p>SUBSCRIBE &lt;event-id&gt;
763  </p>  </p>
764  </blockquote>  </blockquote><p>
765    
766    </p>
767  <p>where &lt;event-id&gt; will be replaced by the respective  <p>where &lt;event-id&gt; will be replaced by the respective
768                  event that client wants to subscribe to. Upon receiving such                  event that client wants to subscribe to. Upon receiving such
769                  request, server SHOULD respond with OK and start sending                  request, server SHOULD respond with OK and start sending
# Line 674  Intellectual Property and Copyright Stat Line 773  Intellectual Property and Copyright Stat
773                  time nature of their generation. Event messages have the                  time nature of their generation. Event messages have the
774                  following format:                  following format:
775  </p>  </p>
776  <p></p>  <p>
777                        </p>
778  <blockquote class="text">  <blockquote class="text">
779  <p>NOTIFY:&lt;event-id&gt;:&lt;custom-event-data&gt;  <p>NOTIFY:&lt;event-id&gt;:&lt;custom-event-data&gt;
780  </p>  </p>
781  </blockquote>  </blockquote><p>
782    
783    </p>
784  <p>where &lt;event-id&gt; uniquely identifies the event that  <p>where &lt;event-id&gt; uniquely identifies the event that
785                  has occurred and &lt;custom-event-data&gt; is event                  has occurred and &lt;custom-event-data&gt; is event
786                  specific.                  specific.
# Line 687  Intellectual Property and Copyright Stat Line 788  Intellectual Property and Copyright Stat
788  <p>Several rules must be followed by the server when  <p>Several rules must be followed by the server when
789                  generating events:                  generating events:
790  </p>  </p>
791  <p></p>  <p>
792                        </p>
793  <ol class="text">  <ol class="text">
794  <li>Events MUST NOT be sent to any client who has not  <li>Events MUST NOT be sent to any client who has not
795                          issued an appropriate SUBSCRIBE command.                          issued an appropriate SUBSCRIBE command.
# Line 702  Intellectual Property and Copyright Stat Line 804  Intellectual Property and Copyright Stat
804                          middle of the event message as well as any other                          middle of the event message as well as any other
805                          response.                          response.
806  </li>  </li>
807  </ol>  </ol><p>
808    
809    </p>
810  <p>If the client is not interested in a particular event  <p>If the client is not interested in a particular event
811                  anymore it MAY issue UNSUBSCRIBE command using the following                  anymore it MAY issue UNSUBSCRIBE command using the following
812                  syntax:                  syntax:
813  </p>  </p>
814  <p></p>  <p>
815                        </p>
816  <blockquote class="text">  <blockquote class="text">
817  <p>UNSUBSCRIBE &lt;event-id&gt;  <p>UNSUBSCRIBE &lt;event-id&gt;
818  </p>  </p>
819  </blockquote>  </blockquote><p>
820    
821    </p>
822  <p>where &lt;event-id&gt; will be replace by the respective  <p>where &lt;event-id&gt; will be replace by the respective
823                  event that client is no longer interested in receiving. For                  event that client is no longer interested in receiving. For
824                  a list of supported events see <a class="info" href="#events">Section 7<span>Events</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>.
825  </p>  </p>
826  <p>Example: the fill states of disk stream buffers have  <p>Example: the fill states of disk stream buffers have
827                  changed on sampler channel 4 and the LinuxSampler instance                  changed on sampler channel 4 and the LinuxSampler instance
828                  will react by sending the following message to all clients                  will react by sending the following message to all clients
829                  who subscribed to this event:                  who subscribed to this event:
830  </p>  </p>
831  <p></p>  <p>
832                        </p>
833  <blockquote class="text">  <blockquote class="text">
834  <p>NOTIFY:CHANNEL_BUFFER_FILL:4 [35]62%,[33]80%,[37]98%  <p>NOTIFY:CHANNEL_BUFFER_FILL:4 [35]62%,[33]80%,[37]98%
835  </p>  </p>
836  </blockquote>  </blockquote><p>
837    
838    </p>
839  <p>Which means there are currently three active streams on  <p>Which means there are currently three active streams on
840                  sampler channel 4, where the stream with ID "35" is filled                  sampler channel 4, where the stream with ID "35" is filled
841                  by 62%, stream with ID 33 is filled by 80% and stream with                  by 62%, stream with ID 33 is filled by 80% and stream with
# Line 759  Intellectual Property and Copyright Stat Line 866  Intellectual Property and Copyright Stat
866                  If client reconnects it MUST resubscribe to all events that                  If client reconnects it MUST resubscribe to all events that
867                  it wants to receive.                  it wants to receive.
868  </p>  </p>
869  <a name="anchor8"></a><br /><hr />  <a name="control_commands"></a><br /><hr />
870  <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="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
871  <a name="rfc.section.5"></a><h3>5.&nbsp;Description for control commands</h3>  <a name="rfc.section.6"></a><h3>6.&nbsp;Description for control commands</h3>
872    
873  <p>This chapter will describe the available control commands  <p>This chapter will describe the available control commands
874              that can be sent on the TCP connection in detail. Some certain              that can be sent on the TCP connection in detail. Some certain
875              commands (e.g. <a class="info" href="#GET CHANNEL INFO">"GET CHANNEL INFO"<span>Getting sampler channel information</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>
876              or <a class="info" href="#GET ENGINE INFO">"GET ENGINE INFO"<span>Getting information about an engine</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
877              multiple-line responses. In this case LinuxSampler signals the              multiple-line responses. In this case LinuxSampler signals the
878              end of the response by a "." (single dot) line.              end of the response by a "." (single dot) line.
879  </p>  </p>
880  <a name="rfc.section.5.1"></a><h4><a name="anchor9">5.1</a>&nbsp;Ignored lines and comments</h4>  <a name="rfc.section.6.1"></a><h4><a name="anchor8">6.1</a>&nbsp;Ignored lines and comments</h4>
881    
882  <p>White lines, that is lines which only contain space and  <p>White lines, that is lines which only contain space and
883                  tabulator characters, and lines that start with a "#"                  tabulator characters, and lines that start with a "#"
# Line 778  Intellectual Property and Copyright Stat Line 885  Intellectual Property and Copyright Stat
885                  group commands and to place comments in a LSCP script                  group commands and to place comments in a LSCP script
886                  file.                  file.
887  </p>  </p>
888  <a name="rfc.section.5.2"></a><h4><a name="anchor10">5.2</a>&nbsp;Configuring audio drivers</h4>  <a name="rfc.section.6.2"></a><h4><a name="anchor9">6.2</a>&nbsp;Configuring audio drivers</h4>
889    
890  <p>Instances of drivers in LinuxSampler are called devices.  <p>Instances of drivers in LinuxSampler are called devices.
891                  You can use multiple audio devices simultaneously, e.g. to                  You can use multiple audio devices simultaneously, e.g. to
# Line 811  Intellectual Property and Copyright Stat Line 918  Intellectual Property and Copyright Stat
918                  what parameters drivers are offering, how to retrieve their                  what parameters drivers are offering, how to retrieve their
919                  possible values, etc.                  possible values, etc.
920  </p>  </p>
921  <a name="rfc.section.5.2.1"></a><h4><a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">5.2.1</a>&nbsp;Getting amount of available audio output drivers</h4>  <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>
922    
923  <p>Use the following command to get the number of  <p>Use the following command to get the number of
924                      audio output drivers currently available for the                      audio output drivers currently available for the
925                      LinuxSampler instance:                      LinuxSampler instance:
926  </p>  </p>
927  <p></p>  <p>
928                            </p>
929  <blockquote class="text">  <blockquote class="text">
930  <p>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS  <p>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS
931  </p>  </p>
932  </blockquote>  </blockquote><p>
933    
934    </p>
935  <p>Possible Answers:  <p>Possible Answers:
936  </p>  </p>
937  <p></p>  <p>
938                            </p>
939  <blockquote class="text">  <blockquote class="text">
940  <p>LinuxSampler will answer by sending the  <p>LinuxSampler will answer by sending the
941                              number of audio output drivers.                              number of audio output drivers.
942  </p>  </p>
943  </blockquote>  </blockquote><p>
944    
945    </p>
946  <p>Example:  <p>Example:
947  </p>  </p>
948  <p></p>  <p>
949                            </p>
950  <blockquote class="text">  <blockquote class="text">
951  <p>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"  <p>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"
952  </p>  </p>
953  <p>S: "2"  <p>S: "2"
954  </p>  </p>
955  </blockquote>  </blockquote><p>
956    
957  <a name="rfc.section.5.2.2"></a><h4><a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">5.2.2</a>&nbsp;Getting all available audio output drivers</h4>  </p>
958    <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>
959    
960  <p>Use the following command to list all audio output  <p>Use the following command to list all audio output
961                      drivers currently available for the LinuxSampler                      drivers currently available for the LinuxSampler
962                      instance:                      instance:
963  </p>  </p>
964  <p></p>  <p>
965                            </p>
966  <blockquote class="text">  <blockquote class="text">
967  <p>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS  <p>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS
968  </p>  </p>
969  </blockquote>  </blockquote><p>
970    
971    </p>
972  <p>Possible Answers:  <p>Possible Answers:
973  </p>  </p>
974  <p></p>  <p>
975                            </p>
976  <blockquote class="text">  <blockquote class="text">
977  <p>LinuxSampler will answer by sending comma  <p>LinuxSampler will answer by sending comma
978                              separated character strings, each symbolizing an                              separated character strings, each symbolizing an
979                              audio output driver.                              audio output driver.
980  </p>  </p>
981  </blockquote>  </blockquote><p>
982    
983    </p>
984  <p>Example:  <p>Example:
985  </p>  </p>
986  <p></p>  <p>
987                            </p>
988  <blockquote class="text">  <blockquote class="text">
989  <p>C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"  <p>C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"
990  </p>  </p>
991  <p>S: "ALSA,JACK"  <p>S: "ALSA,JACK"
992  </p>  </p>
993  </blockquote>  </blockquote><p>
994    
995  <a name="rfc.section.5.2.3"></a><h4><a name="GET AUDIO_OUTPUT_DRIVER INFO">5.2.3</a>&nbsp;Getting information about a specific audio  </p>
996    <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
997                  output driver</h4>                  output driver</h4>
998    
999  <p>Use the following command to get detailed information  <p>Use the following command to get detailed information
1000                      about a specific audio output driver:                      about a specific audio output driver:
1001  </p>  </p>
1002  <p></p>  <p>
1003                            </p>
1004  <blockquote class="text">  <blockquote class="text">
1005  <p>GET AUDIO_OUTPUT_DRIVER INFO  <p>GET AUDIO_OUTPUT_DRIVER INFO
1006                               &lt;audio-output-driver&gt;                               &lt;audio-output-driver&gt;
1007  </p>  </p>
1008  </blockquote>  </blockquote><p>
1009    
1010    </p>
1011  <p>Where &lt;audio-output-driver&gt; is the name of the  <p>Where &lt;audio-output-driver&gt; is the name of the
1012                      audio output driver, returned by the                      audio output driver, returned by the
1013                      <a class="info" href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span>Getting all available audio output drivers</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.
1014  </p>  </p>
1015  <p>Possible Answers:  <p>Possible Answers:
1016  </p>  </p>
1017  <p></p>  <p>
1018                            </p>
1019  <blockquote class="text">  <blockquote class="text">
1020  <p>LinuxSampler will answer by sending a  <p>LinuxSampler will answer by sending a
1021                              &lt;CRLF&gt; separated list. Each answer line                              &lt;CRLF&gt; separated list. Each answer line
# Line 904  Intellectual Property and Copyright Stat Line 1026  Intellectual Property and Copyright Stat
1026                              following information categories are                              following information categories are
1027                              defined:                              defined:
1028  </p>  </p>
1029  <p></p>  <p>
1030                                  </p>
1031  <blockquote class="text">  <blockquote class="text">
1032  <p>DESCRIPTION -  <p>DESCRIPTION -
1033                                      </p>                                      </p>
# Line 912  Intellectual Property and Copyright Stat Line 1035  Intellectual Property and Copyright Stat
1035  <p> character string describing the  <p> character string describing the
1036                                        audio output driver                                        audio output driver
1037  </p>  </p>
1038  </blockquote>  </blockquote><p>
1039    
1040    </p>
1041  <p>VERSION -  <p>VERSION -
1042                                      </p>                                      </p>
1043  <blockquote class="text">  <blockquote class="text">
1044  <p>character string reflecting the  <p>character string reflecting the
1045                                        driver's version                                        driver's version
1046  </p>  </p>
1047  </blockquote>  </blockquote><p>
1048    
1049    </p>
1050  <p>PARAMETERS -  <p>PARAMETERS -
1051                                      </p>                                      </p>
1052  <blockquote class="text">  <blockquote class="text">
# Line 932  Intellectual Property and Copyright Stat Line 1057  Intellectual Property and Copyright Stat
1057                                        and 'active' are offered by all audio                                        and 'active' are offered by all audio
1058                                        output drivers                                        output drivers
1059  </p>  </p>
1060  </blockquote>  </blockquote><p>
1061    
1062  </blockquote>  </p>
1063    </blockquote><p>
1064    
1065    </p>
1066  <p>The mentioned fields above don't have to be  <p>The mentioned fields above don't have to be
1067                              in particular order.                              in particular order.
1068  </p>  </p>
1069  </blockquote>  </blockquote><p>
1070    
1071    </p>
1072  <p>Example:  <p>Example:
1073  </p>  </p>
1074  <p></p>  <p>
1075                          </p>
1076  <blockquote class="text">  <blockquote class="text">
1077  <p>C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"  <p>C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"
1078  </p>  </p>
# Line 958  Intellectual Property and Copyright Stat Line 1087  Intellectual Property and Copyright Stat
1087  </p>  </p>
1088  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1089  </p>  </p>
1090  </blockquote>  </blockquote><p>
1091    
1092  <a name="rfc.section.5.2.4"></a><h4><a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">5.2.4</a>&nbsp;Getting information about specific audio  </p>
1093    <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
1094                  output driver parameter</h4>                  output driver parameter</h4>
1095    
1096  <p>Use the following command to get detailed information  <p>Use the following command to get detailed information
1097                      about a  specific audio output driver parameter:                      about a  specific audio output driver parameter:
1098  </p>  </p>
1099  <p></p>  <p>
1100                            </p>
1101  <blockquote class="text">  <blockquote class="text">
1102  <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;]
1103  </p>  </p>
1104  </blockquote>  </blockquote><p>
1105    
1106    </p>
1107  <p>Where &lt;audio&gt; is the name of the audio output  <p>Where &lt;audio&gt; is the name of the audio output
1108                      driver as returned by the <a class="info" href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span>Getting all available audio output drivers</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,
1109                      &lt;prm&gt; a specific parameter name for which information should be                      &lt;prm&gt; a specific parameter name for which information should be
1110                      obtained (as returned by the                      obtained (as returned by the
1111                      <a class="info" href="#GET AUDIO_OUTPUT_DRIVER INFO">"GET AUDIO_OUTPUT_DRIVER INFO"<span>Getting information about a specific audio                 output driver</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
1112                      &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
1113                      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
1114                      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 987  Intellectual Property and Copyright Stat Line 1119  Intellectual Property and Copyright Stat
1119  </p>  </p>
1120  <p>Possible Answers:  <p>Possible Answers:
1121  </p>  </p>
1122  <p></p>  <p>
1123                            </p>
1124  <blockquote class="text">  <blockquote class="text">
1125  <p>LinuxSampler will answer by sending a  <p>LinuxSampler will answer by sending a
1126                              &lt;CRLF&gt; separated list.                              &lt;CRLF&gt; separated list.
# Line 1000  Intellectual Property and Copyright Stat Line 1133  Intellectual Property and Copyright Stat
1133                              which is only shown dependently to given driver parameter. At                              which is only shown dependently to given driver parameter. At
1134                              the moment the following information categories are defined:                              the moment the following information categories are defined:
1135  </p>  </p>
1136  </blockquote>  </blockquote><p>
1137    
1138  <p></p>  </p>
1139    <p>
1140                            </p>
1141  <blockquote class="text">  <blockquote class="text">
1142  <p>TYPE -  <p>TYPE -
1143                                </p>                                </p>
# Line 1013  Intellectual Property and Copyright Stat Line 1148  Intellectual Property and Copyright Stat
1148                                  character string(s)                                  character string(s)
1149                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
1150  </p>  </p>
1151  </blockquote>  </blockquote><p>
1152    
1153    </p>
1154  <p>DESCRIPTION -  <p>DESCRIPTION -
1155                                </p>                                </p>
1156  <blockquote class="text">  <blockquote class="text">
1157  <p>arbitrary text describing the purpose of the parameter  <p>arbitrary text describing the purpose of the parameter
1158                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
1159  </p>  </p>
1160  </blockquote>  </blockquote><p>
1161    
1162    </p>
1163  <p>MANDATORY -  <p>MANDATORY -
1164                                </p>                                </p>
1165  <blockquote class="text">  <blockquote class="text">
1166  <p>either true or false, defines if this parameter must be  <p>either true or false, defines if this parameter must be
1167                                  given when the device is to be created with the                                  given when the device is to be created with the
1168                                  <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'<span>Creating an audio output device</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>
1169                                  command (always returned, no matter which driver parameter)                                  command (always returned, no matter which driver parameter)
1170  </p>  </p>
1171  </blockquote>  </blockquote><p>
1172    
1173    </p>
1174  <p>FIX -  <p>FIX -
1175                                </p>                                </p>
1176  <blockquote class="text">  <blockquote class="text">
1177  <p>either true or false, if false then this parameter can  <p>either true or false, if false then this parameter can
1178                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
1179                                  the <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'<span>Creating an audio output device</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>
1180                                  command (always returned, no matter which driver parameter)                                  command (always returned, no matter which driver parameter)
1181  </p>  </p>
1182  </blockquote>  </blockquote><p>
1183    
1184    </p>
1185  <p>MULTIPLICITY -  <p>MULTIPLICITY -
1186                                </p>                                </p>
1187  <blockquote class="text">  <blockquote class="text">
# Line 1051  Intellectual Property and Copyright Stat Line 1190  Intellectual Property and Copyright Stat
1190                                  multiple values and false only a single value allowed                                  multiple values and false only a single value allowed
1191                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
1192  </p>  </p>
1193  </blockquote>  </blockquote><p>
1194    
1195    </p>
1196  <p>DEPENDS -  <p>DEPENDS -
1197                                </p>                                </p>
1198  <blockquote class="text">  <blockquote class="text">
1199  <p>comma separated list of paramters this parameter depends  <p>comma separated list of parameters this parameter depends
1200                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',
1201                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these
1202                                  listed parameters, for example assuming that an audio                                  listed parameters, for example assuming that an audio
# Line 1067  Intellectual Property and Copyright Stat Line 1207  Intellectual Property and Copyright Stat
1207                                  chosen by the 'card' parameter                                  chosen by the 'card' parameter
1208                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
1209  </p>  </p>
1210  </blockquote>  </blockquote><p>
1211    
1212    </p>
1213  <p>DEFAULT -  <p>DEFAULT -
1214                                </p>                                </p>
1215  <blockquote class="text">  <blockquote class="text">
1216  <p>reflects the default value for this parameter which is  <p>reflects the default value for this parameter which is
1217                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
1218                                  given with the <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'<span>Creating an audio output device</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,
1219                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
1220                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
1221                                  apostrophes (')                                  apostrophes (')
1222                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
1223  </p>  </p>
1224  </blockquote>  </blockquote><p>
1225    
1226    </p>
1227  <p>RANGE_MIN -  <p>RANGE_MIN -
1228                                </p>                                </p>
1229  <blockquote class="text">  <blockquote class="text">
# Line 1091  Intellectual Property and Copyright Stat Line 1233  Intellectual Property and Copyright Stat
1233                                  with RANGE_MAX, but may also appear without                                  with RANGE_MAX, but may also appear without
1234                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
1235  </p>  </p>
1236  </blockquote>  </blockquote><p>
1237    
1238    </p>
1239  <p>RANGE_MAX -  <p>RANGE_MAX -
1240                                </p>                                </p>
1241  <blockquote class="text">  <blockquote class="text">
# Line 1102  Intellectual Property and Copyright Stat Line 1245  Intellectual Property and Copyright Stat
1245                                  RANGE_MIN, but may also appear without                                  RANGE_MIN, but may also appear without
1246                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
1247  </p>  </p>
1248  </blockquote>  </blockquote><p>
1249    
1250    </p>
1251  <p>POSSIBILITIES -  <p>POSSIBILITIES -
1252                                </p>                                </p>
1253  <blockquote class="text">  <blockquote class="text">
# Line 1112  Intellectual Property and Copyright Stat Line 1256  Intellectual Property and Copyright Stat
1256                                  apostrophes                                  apostrophes
1257                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
1258  </p>  </p>
1259  </blockquote>  </blockquote><p>
1260    
1261  </blockquote>  </p>
1262    </blockquote><p>
1263    
1264    </p>
1265  <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.
1266  </p>  </p>
1267  <p>Examples:  <p>Examples:
1268  </p>  </p>
1269  <p></p>  <p>
1270                            </p>
1271  <blockquote class="text">  <blockquote class="text">
1272  <p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"  <p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"
1273  </p>  </p>
# Line 1140  Intellectual Property and Copyright Stat Line 1287  Intellectual Property and Copyright Stat
1287  </p>  </p>
1288  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1289  </p>  </p>
1290  </blockquote>  </blockquote><p>
1291    
1292  <p></p>  </p>
1293    <p>
1294                            </p>
1295  <blockquote class="text">  <blockquote class="text">
1296  <p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"  <p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"
1297  </p>  </p>
# Line 1162  Intellectual Property and Copyright Stat Line 1311  Intellectual Property and Copyright Stat
1311  </p>  </p>
1312  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1313  </p>  </p>
1314  </blockquote>  </blockquote><p>
1315    
1316  <p></p>  </p>
1317    <p>
1318                            </p>
1319  <blockquote class="text">  <blockquote class="text">
1320  <p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE CARD='0,0'"  <p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE CARD='0,0'"
1321  </p>  </p>
# Line 1188  Intellectual Property and Copyright Stat Line 1339  Intellectual Property and Copyright Stat
1339  </p>  </p>
1340  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1341  </p>  </p>
1342  </blockquote>  </blockquote><p>
1343    
1344  <a name="rfc.section.5.2.5"></a><h4><a name="CREATE AUDIO_OUTPUT_DEVICE">5.2.5</a>&nbsp;Creating an audio output device</h4>  </p>
1345    <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>
1346    
1347  <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:
1348  </p>  </p>
1349  <p></p>  <p>
1350                            </p>
1351  <blockquote class="text">  <blockquote class="text">
1352  <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;]
1353  </p>  </p>
1354  </blockquote>  </blockquote><p>
1355    
1356    </p>
1357  <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
1358                      output system and &lt;param-list&gt; by an optional list of driver                      output system as returned by the
1359                        <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>
1360                        command and &lt;param-list&gt; by an optional list of driver
1361                      specific parameters in form of "key1=val1 key2=val2 ...", where                      specific parameters in form of "key1=val1 key2=val2 ...", where
1362                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
1363                      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 1210  Intellectual Property and Copyright Stat Line 1366  Intellectual Property and Copyright Stat
1366  </p>  </p>
1367  <p>Possible Answers:  <p>Possible Answers:
1368  </p>  </p>
1369  <p></p>  <p>
1370                            </p>
1371  <blockquote class="text">  <blockquote class="text">
1372  <p>"OK[&lt;device-id&gt;]" -  <p>"OK[&lt;device-id&gt;]" -
1373                                  </p>                                  </p>
# Line 1218  Intellectual Property and Copyright Stat Line 1375  Intellectual Property and Copyright Stat
1375  <p>in case the device was successfully created, where  <p>in case the device was successfully created, where
1376                                      &lt;device-id&gt; is the numerical ID of the new device                                      &lt;device-id&gt; is the numerical ID of the new device
1377  </p>  </p>
1378  </blockquote>  </blockquote><p>
1379    
1380    </p>
1381  <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;" -
1382                                  </p>                                  </p>
1383  <blockquote class="text">  <blockquote class="text">
# Line 1230  Intellectual Property and Copyright Stat Line 1388  Intellectual Property and Copyright Stat
1388                                      fall-back values), providing an appropriate warning code and                                      fall-back values), providing an appropriate warning code and
1389                                      warning message                                      warning message
1390  </p>  </p>
1391  </blockquote>  </blockquote><p>
1392    
1393    </p>
1394  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1395                                  </p>                                  </p>
1396  <blockquote class="text">  <blockquote class="text">
1397  <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
1398  </p>  </p>
1399  </blockquote>  </blockquote><p>
1400    
1401  </blockquote>  </p>
1402    </blockquote><p>
1403    
1404    </p>
1405  <p>Examples:  <p>Examples:
1406  </p>  </p>
1407  <p></p>  <p>
1408                            </p>
1409  <blockquote class="text">  <blockquote class="text">
1410  <p>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"  <p>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"
1411  </p>  </p>
1412  <p>S: "OK[0]"  <p>S: "OK[0]"
1413  </p>  </p>
1414  </blockquote>  </blockquote><p>
1415    
1416  <p></p>  </p>
1417    <p>
1418                            </p>
1419  <blockquote class="text">  <blockquote class="text">
1420  <p>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"  <p>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"
1421  </p>  </p>
1422  <p>S: "OK[1]"  <p>S: "OK[1]"
1423  </p>  </p>
1424  </blockquote>  </blockquote><p>
1425    
1426  <a name="rfc.section.5.2.6"></a><h4><a name="DESTROY AUDIO_OUTPUT_DEVICE">5.2.6</a>&nbsp;Destroying an audio output device</h4>  </p>
1427    <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>
1428    
1429  <p>Use the following command to destroy a created output device:  <p>Use the following command to destroy a created output device:
1430  </p>  </p>
1431  <p></p>  <p>
1432                            </p>
1433  <blockquote class="text">  <blockquote class="text">
1434  <p>DESTROY AUDIO_OUTPUT_DEVICE &lt;device-id&gt;  <p>DESTROY AUDIO_OUTPUT_DEVICE &lt;device-id&gt;
1435  </p>  </p>
1436  </blockquote>  </blockquote><p>
1437    
1438    </p>
1439  <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
1440                      audio output device as given by the                      audio output device as given by the
1441                      <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"<span>Creating an audio output device</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>
1442                      or <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span>Getting all created audio output device list</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>
1443                      command.                      command.
1444  </p>  </p>
1445  <p>Possible Answers:  <p>Possible Answers:
1446  </p>  </p>
1447  <p></p>  <p>
1448                            </p>
1449  <blockquote class="text">  <blockquote class="text">
1450  <p>"OK" -  <p>"OK" -
1451                                  </p>                                  </p>
1452  <blockquote class="text">  <blockquote class="text">
1453  <p>in case the device was successfully destroyed  <p>in case the device was successfully destroyed
1454  </p>  </p>
1455  </blockquote>  </blockquote><p>
1456    
1457    </p>
1458  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1459                                  </p>                                  </p>
1460  <blockquote class="text">  <blockquote class="text">
# Line 1295  Intellectual Property and Copyright Stat Line 1464  Intellectual Property and Copyright Stat
1464                                      informed about this situation), providing an appropriate                                      informed about this situation), providing an appropriate
1465                                      warning code and warning message                                      warning code and warning message
1466  </p>  </p>
1467  </blockquote>  </blockquote><p>
1468    
1469    </p>
1470  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1471                                  </p>                                  </p>
1472  <blockquote class="text">  <blockquote class="text">
1473  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
1474                                      error message                                      error message
1475  </p>  </p>
1476  </blockquote>  </blockquote><p>
1477    
1478  </blockquote>  </p>
1479    </blockquote><p>
1480    
1481    </p>
1482  <p>Example:  <p>Example:
1483  </p>  </p>
1484  <p></p>  <p>
1485                            </p>
1486  <blockquote class="text">  <blockquote class="text">
1487  <p>C: "DESTROY AUDIO_OUTPUT_DEVICE 0"  <p>C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
1488  </p>  </p>
1489  <p>S: "OK"  <p>S: "OK"
1490  </p>  </p>
1491  </blockquote>  </blockquote><p>
1492    
1493  <a name="rfc.section.5.2.7"></a><h4><a name="GET AUDIO_OUTPUT_DEVICES">5.2.7</a>&nbsp;Getting all created audio output device count</h4>  </p>
1494    <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>
1495    
1496  <p>Use the following command to count all created audio output devices:  <p>Use the following command to count all created audio output devices:
1497  </p>  </p>
1498  <p></p>  <p>
1499                            </p>
1500  <blockquote class="text">  <blockquote class="text">
1501  <p>GET AUDIO_OUTPUT_DEVICES  <p>GET AUDIO_OUTPUT_DEVICES
1502  </p>  </p>
1503  </blockquote>  </blockquote><p>
1504    
1505    </p>
1506  <p>Possible Answers:  <p>Possible Answers:
1507  </p>  </p>
1508  <p></p>  <p>
1509                            </p>
1510  <blockquote class="text">  <blockquote class="text">
1511  <p>LinuxSampler will answer by sending the current number of all  <p>LinuxSampler will answer by sending the current number of all
1512                              audio output devices.                              audio output devices.
1513  </p>  </p>
1514  </blockquote>  </blockquote><p>
1515    
1516    </p>
1517  <p>Example:  <p>Example:
1518  </p>  </p>
1519  <p></p>  <p>
1520                            </p>
1521  <blockquote class="text">  <blockquote class="text">
1522  <p>C: "GET AUDIO_OUTPUT_DEVICES"  <p>C: "GET AUDIO_OUTPUT_DEVICES"
1523  </p>  </p>
1524  <p>S: "4"  <p>S: "4"
1525  </p>  </p>
1526  </blockquote>  </blockquote><p>
1527    
1528  <a name="rfc.section.5.2.8"></a><h4><a name="LIST AUDIO_OUTPUT_DEVICES">5.2.8</a>&nbsp;Getting all created audio output device list</h4>  </p>
1529    <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>
1530    
1531  <p>Use the following command to list all created audio output devices:  <p>Use the following command to list all created audio output devices:
1532  </p>  </p>
1533  <p></p>  <p>
1534                            </p>
1535  <blockquote class="text">  <blockquote class="text">
1536  <p>LIST AUDIO_OUTPUT_DEVICES  <p>LIST AUDIO_OUTPUT_DEVICES
1537  </p>  </p>
1538  </blockquote>  </blockquote><p>
1539    
1540    </p>
1541  <p>Possible Answers:  <p>Possible Answers:
1542  </p>  </p>
1543  <p></p>  <p>
1544                            </p>
1545  <blockquote class="text">  <blockquote class="text">
1546  <p>LinuxSampler will answer by sending a comma separated list with  <p>LinuxSampler will answer by sending a comma separated list with
1547                              the numerical IDs of all audio output devices.                              the numerical IDs of all audio output devices.
1548  </p>  </p>
1549  </blockquote>  </blockquote><p>
1550    
1551    </p>
1552  <p>Example:  <p>Example:
1553  </p>  </p>
1554  <p></p>  <p>
1555                            </p>
1556  <blockquote class="text">  <blockquote class="text">
1557  <p>C: "LIST AUDIO_OUTPUT_DEVICES"  <p>C: "LIST AUDIO_OUTPUT_DEVICES"
1558  </p>  </p>
1559  <p>S: "0,1,4,5"  <p>S: "0,1,4,5"
1560  </p>  </p>
1561  </blockquote>  </blockquote><p>
1562    
1563  <a name="rfc.section.5.2.9"></a><h4><a name="GET AUDIO_OUTPUT_DEVICE INFO">5.2.9</a>&nbsp;Getting current settings of an audio output device</h4>  </p>
1564    <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>
1565    
1566  <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:
1567  </p>  </p>
1568  <p></p>  <p>
1569                            </p>
1570  <blockquote class="text">  <blockquote class="text">
1571  <p>GET AUDIO_OUTPUT_DEVICE INFO &lt;device-id&gt;  <p>GET AUDIO_OUTPUT_DEVICE INFO &lt;device-id&gt;
1572  </p>  </p>
1573  </blockquote>  </blockquote><p>
1574    
1575    </p>
1576  <p>Where &lt;device-id&gt; should be replaced by numerical ID  <p>Where &lt;device-id&gt; should be replaced by numerical ID
1577                      of the audio output device as e.g. returned by the                      of the audio output device as e.g. returned by the
1578                      <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span>Getting all created audio output device list</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.
1579  </p>  </p>
1580  <p>Possible Answers:  <p>Possible Answers:
1581  </p>  </p>
# Line 1399  Intellectual Property and Copyright Stat Line 1587  Intellectual Property and Copyright Stat
1587                      encapsulated into apostrophes ('). At the moment the following                      encapsulated into apostrophes ('). At the moment the following
1588                      information categories are defined (independently of device):                      information categories are defined (independently of device):
1589  </p>  </p>
1590  <p></p>  <p>
1591                            </p>
1592  <blockquote class="text">  <blockquote class="text">
1593  <p>DRIVER -  <p>DRIVER -
1594                                  </p>                                  </p>
1595  <blockquote class="text">  <blockquote class="text">
1596  <p>identifier of the used audio output driver, as also  <p>identifier of the used audio output driver, as also
1597                                      returned by the                                      returned by the
1598                                      <a class="info" href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span>Getting all available audio output drivers</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>
1599                                      command                                      command
1600  </p>  </p>
1601  </blockquote>  </blockquote><p>
1602    
1603    </p>
1604  <p>CHANNELS -  <p>CHANNELS -
1605                                  </p>                                  </p>
1606  <blockquote class="text">  <blockquote class="text">
1607  <p>amount of audio output channels this device currently  <p>amount of audio output channels this device currently
1608                                      offers                                      offers
1609  </p>  </p>
1610  </blockquote>  </blockquote><p>
1611    
1612    </p>
1613  <p>SAMPLERATE -  <p>SAMPLERATE -
1614                                  </p>                                  </p>
1615  <blockquote class="text">  <blockquote class="text">
1616  <p>playback sample rate the device uses  <p>playback sample rate the device uses
1617  </p>  </p>
1618  </blockquote>  </blockquote><p>
1619    
1620    </p>
1621  <p>ACTIVE -  <p>ACTIVE -
1622                                  </p>                                  </p>
1623  <blockquote class="text">  <blockquote class="text">
# Line 1434  Intellectual Property and Copyright Stat Line 1626  Intellectual Property and Copyright Stat
1626                                      sampler channels connected to this audio device render                                      sampler channels connected to this audio device render
1627                                      any audio                                      any audio
1628  </p>  </p>
1629  </blockquote>  </blockquote><p>
1630    
1631  </blockquote>  </p>
1632    </blockquote><p>
1633    
1634    </p>
1635  <p>The mentioned fields above don't have to be in particular  <p>The mentioned fields above don't have to be in particular
1636                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
1637                      returned by all audio output devices. Every audio output driver                      returned by all audio output devices. Every audio output driver
1638                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
1639                      <a class="info" href="#GET AUDIO_OUTPUT_DRIVER INFO">Section 5.2.3<span>Getting information about a specific audio                 output driver</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>)
1640                      which are also returned by this command.                      which are also returned by this command.
1641  </p>  </p>
1642  <p>Example:  <p>Example:
1643  </p>  </p>
1644  <p></p>  <p>
1645                            </p>
1646  <blockquote class="text">  <blockquote class="text">
1647  <p>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"  <p>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
1648  </p>  </p>
# Line 1467  Intellectual Property and Copyright Stat Line 1662  Intellectual Property and Copyright Stat
1662  </p>  </p>
1663  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1664  </p>  </p>
1665  </blockquote>  </blockquote><p>
1666    
1667  <a name="rfc.section.5.2.10"></a><h4><a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER">5.2.10</a>&nbsp;Changing settings of audio output devices</h4>  </p>
1668    <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>
1669    
1670  <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:
1671  </p>  </p>
1672  <p></p>  <p>
1673                            </p>
1674  <blockquote class="text">  <blockquote class="text">
1675  <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;
1676  </p>  </p>
1677  </blockquote>  </blockquote><p>
1678    
1679    </p>
1680  <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
1681                      audio output device, &lt;key&gt; by the name of the parameter to change                      audio output device as given by the
1682                        <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>
1683                        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>
1684                        command, &lt;key&gt; by the name of the parameter to change
1685                      and &lt;value&gt; by the new value for this parameter.                      and &lt;value&gt; by the new value for this parameter.
1686  </p>  </p>
1687  <p>Possible Answers:  <p>Possible Answers:
1688  </p>  </p>
1689  <p></p>  <p>
1690                            </p>
1691  <blockquote class="text">  <blockquote class="text">
1692  <p>"OK" -  <p>"OK" -
1693                                  </p>                                  </p>
1694  <blockquote class="text">  <blockquote class="text">
1695  <p>in case setting was successfully changed  <p>in case setting was successfully changed
1696  </p>  </p>
1697  </blockquote>  </blockquote><p>
1698    
1699    </p>
1700  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1701                                  </p>                                  </p>
1702  <blockquote class="text">  <blockquote class="text">
# Line 1501  Intellectual Property and Copyright Stat Line 1704  Intellectual Property and Copyright Stat
1704                                      noteworthy issue(s) related, providing an appropriate                                      noteworthy issue(s) related, providing an appropriate
1705                                      warning code and warning message                                      warning code and warning message
1706  </p>  </p>
1707  </blockquote>  </blockquote><p>
1708    
1709    </p>
1710  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1711                                  </p>                                  </p>
1712  <blockquote class="text">  <blockquote class="text">
1713  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
1714                                      error message                                      error message
1715  </p>  </p>
1716  </blockquote>  </blockquote><p>
1717    
1718  </blockquote>  </p>
1719    </blockquote><p>
1720    
1721    </p>
1722  <p>Example:  <p>Example:
1723  </p>  </p>
1724  <p></p>  <p>
1725                            </p>
1726  <blockquote class="text">  <blockquote class="text">
1727  <p>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"  <p>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"
1728  </p>  </p>
1729  <p>S: "OK"  <p>S: "OK"
1730  </p>  </p>
1731  </blockquote>  </blockquote><p>
1732    
1733  <a name="rfc.section.5.2.11"></a><h4><a name="GET AUDIO_OUTPUT_CHANNEL INFO">5.2.11</a>&nbsp;Getting information about an audio channel</h4>  </p>
1734    <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>
1735    
1736  <p>Use the following command to get information about an audio channel:  <p>Use the following command to get information about an audio channel:
1737  </p>  </p>
1738  <p></p>  <p>
1739                            </p>
1740  <blockquote class="text">  <blockquote class="text">
1741  <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;
1742  </p>  </p>
1743  </blockquote>  </blockquote><p>
1744    
1745  <p>Where &lt;device-id&gt; is the numerical ID of the audio output device  </p>
1746                      and &lt;audio-chan&gt; the audio channel number.  <p>Where &lt;device-id&gt; is the numerical ID of the audio output device as given by the
1747                        <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>
1748                        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>
1749                        command and &lt;audio-chan&gt; the audio channel number.
1750  </p>  </p>
1751  <p>Possible Answers:  <p>Possible Answers:
1752  </p>  </p>
1753  <p></p>  <p>
1754                            </p>
1755  <blockquote class="text">  <blockquote class="text">
1756  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1757                              Each answer line begins with the information category name                              Each answer line begins with the information category name
# Line 1546  Intellectual Property and Copyright Stat Line 1759  Intellectual Property and Copyright Stat
1759                              the info character string to that info category. At the moment                              the info character string to that info category. At the moment
1760                              the following information categories are defined:                              the following information categories are defined:
1761  </p>  </p>
1762  <p></p>  <p>
1763                                    </p>
1764  <blockquote class="text">  <blockquote class="text">
1765  <p>NAME -  <p>NAME -
1766                                          </p>                                          </p>
# Line 1554  Intellectual Property and Copyright Stat Line 1768  Intellectual Property and Copyright Stat
1768  <p>arbitrary character string naming the channel, which  <p>arbitrary character string naming the channel, which
1769                                              doesn't have to be unique (always returned by all audio channels)                                              doesn't have to be unique (always returned by all audio channels)
1770  </p>  </p>
1771  </blockquote>  </blockquote><p>
1772    
1773    </p>
1774  <p>IS_MIX_CHANNEL -  <p>IS_MIX_CHANNEL -
1775                                          </p>                                          </p>
1776  <blockquote class="text">  <blockquote class="text">
# Line 1566  Intellectual Property and Copyright Stat Line 1781  Intellectual Property and Copyright Stat
1781                                              channels than the used audio system might be able to offer                                              channels than the used audio system might be able to offer
1782                                              (always returned by all audio channels)                                              (always returned by all audio channels)
1783  </p>  </p>
1784  </blockquote>  </blockquote><p>
1785    
1786    </p>
1787  <p>MIX_CHANNEL_DESTINATION -  <p>MIX_CHANNEL_DESTINATION -
1788                                          </p>                                          </p>
1789  <blockquote class="text">  <blockquote class="text">
# Line 1577  Intellectual Property and Copyright Stat Line 1793  Intellectual Property and Copyright Stat
1793                                              the audio signal actually will be routed / added to                                              the audio signal actually will be routed / added to
1794                                              (only returned in case the audio channel is mix channel)                                              (only returned in case the audio channel is mix channel)
1795  </p>  </p>
1796  </blockquote>  </blockquote><p>
1797    
1798  </blockquote>  </p>
1799    </blockquote><p>
1800    
1801  </blockquote>  </p>
1802    </blockquote><p>
1803    
1804    </p>
1805  <p>The mentioned fields above don't have to be in particular  <p>The mentioned fields above don't have to be in particular
1806                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
1807                      generally returned for the described cases by all audio                      generally returned for the described cases by all audio
# Line 1592  Intellectual Property and Copyright Stat Line 1811  Intellectual Property and Copyright Stat
1811  </p>  </p>
1812  <p>Examples:  <p>Examples:
1813  </p>  </p>
1814  <p></p>  <p>
1815                            </p>
1816  <blockquote class="text">  <blockquote class="text">
1817  <p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"  <p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"
1818  </p>  </p>
# Line 1602  Intellectual Property and Copyright Stat Line 1822  Intellectual Property and Copyright Stat
1822  </p>  </p>
1823  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1824  </p>  </p>
1825  </blockquote>  </blockquote><p>
1826    
1827  <p></p>  </p>
1828    <p>
1829                            </p>
1830  <blockquote class="text">  <blockquote class="text">
1831  <p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 1"  <p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 1"
1832  </p>  </p>
# Line 1614  Intellectual Property and Copyright Stat Line 1836  Intellectual Property and Copyright Stat
1836  </p>  </p>
1837  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1838  </p>  </p>
1839  </blockquote>  </blockquote><p>
1840    
1841  <p></p>  </p>
1842    <p>
1843                            </p>
1844  <blockquote class="text">  <blockquote class="text">
1845  <p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 2"  <p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 2"
1846  </p>  </p>
# Line 1628  Intellectual Property and Copyright Stat Line 1852  Intellectual Property and Copyright Stat
1852  </p>  </p>
1853  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1854  </p>  </p>
1855  </blockquote>  </blockquote><p>
1856    
1857  <p></p>  </p>
1858    <p>
1859                            </p>
1860  <blockquote class="text">  <blockquote class="text">
1861  <p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"  <p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"
1862  </p>  </p>
# Line 1642  Intellectual Property and Copyright Stat Line 1868  Intellectual Property and Copyright Stat
1868  </p>  </p>
1869  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1870  </p>  </p>
1871  </blockquote>  </blockquote><p>
1872    
1873  <a name="rfc.section.5.2.12"></a><h4><a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO">5.2.12</a>&nbsp;Getting information about specific audio channel parameter</h4>  </p>
1874    <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>
1875    
1876  <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:
1877  </p>  </p>
1878  <p></p>  <p>
1879                            </p>
1880  <blockquote class="text">  <blockquote class="text">
1881  <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;
1882  </p>  </p>
1883  </blockquote>  </blockquote><p>
1884    
1885  <p>Where &lt;dev-id&gt; is the numerical ID of the audio output device as returned  </p>
1886                      by the <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span>Getting all created audio output device list</span></a>  <p>Where &lt;dev-id&gt; is the numerical ID of the audio output device as returned by the
1887                        <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>
1888                        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>
1889                      command, &lt;chan&gt; the audio channel number                      command, &lt;chan&gt; the audio channel number
1890                      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
1891                      be obtained (as returned by the <a class="info" href="#GET AUDIO_OUTPUT_CHANNEL INFO">"GET AUDIO_OUTPUT_CHANNEL INFO"<span>Getting information about an audio channel</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).
1892  </p>  </p>
1893  <p>Possible Answers:  <p>Possible Answers:
1894  </p>  </p>
1895  <p></p>  <p>
1896                            </p>
1897  <blockquote class="text">  <blockquote class="text">
1898  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1899                              Each answer line begins with the information category name                              Each answer line begins with the information category name
# Line 1673  Intellectual Property and Copyright Stat Line 1904  Intellectual Property and Copyright Stat
1904                              which is only shown dependently to the given audio channel. At                              which is only shown dependently to the given audio channel. At
1905                              the moment the following information categories are defined:                              the moment the following information categories are defined:
1906  </p>  </p>
1907  <p></p>  <p>
1908                                    </p>
1909  <blockquote class="text">  <blockquote class="text">
1910  <p>TYPE -  <p>TYPE -
1911                                          </p>                                          </p>
# Line 1683  Intellectual Property and Copyright Stat Line 1915  Intellectual Property and Copyright Stat
1915                                              character string(s)                                              character string(s)
1916                                              (always returned)                                              (always returned)
1917  </p>  </p>
1918  </blockquote>  </blockquote><p>
1919    
1920    </p>
1921  <p>DESCRIPTION -  <p>DESCRIPTION -
1922                                          </p>                                          </p>
1923  <blockquote class="text">  <blockquote class="text">
1924  <p>arbitrary text describing the purpose of the parameter (always returned)  <p>arbitrary text describing the purpose of the parameter (always returned)
1925  </p>  </p>
1926  </blockquote>  </blockquote><p>
1927    
1928    </p>
1929  <p>FIX -  <p>FIX -
1930                                          </p>                                          </p>
1931  <blockquote class="text">  <blockquote class="text">
# Line 1699  Intellectual Property and Copyright Stat Line 1933  Intellectual Property and Copyright Stat
1933                                              read only, thus cannot be altered                                              read only, thus cannot be altered
1934                                              (always returned)                                              (always returned)
1935  </p>  </p>
1936  </blockquote>  </blockquote><p>
1937    
1938    </p>
1939  <p>MULTIPLICITY -  <p>MULTIPLICITY -
1940                                          </p>                                          </p>
1941  <blockquote class="text">  <blockquote class="text">
# Line 1709  Intellectual Property and Copyright Stat Line 1944  Intellectual Property and Copyright Stat
1944                                              multiple values and false only a single value allowed                                              multiple values and false only a single value allowed
1945                                              (always returned)                                              (always returned)
1946  </p>  </p>
1947  </blockquote>  </blockquote><p>
1948    
1949    </p>
1950  <p>RANGE_MIN -  <p>RANGE_MIN -
1951                                          </p>                                          </p>
1952  <blockquote class="text">  <blockquote class="text">
# Line 1721  Intellectual Property and Copyright Stat Line 1957  Intellectual Property and Copyright Stat
1957                                              (optionally returned, dependent to driver and channel                                              (optionally returned, dependent to driver and channel
1958                                              parameter)                                              parameter)
1959  </p>  </p>
1960  </blockquote>  </blockquote><p>
1961    
1962    </p>
1963  <p>RANGE_MAX -  <p>RANGE_MAX -
1964                                          </p>                                          </p>
1965  <blockquote class="text">  <blockquote class="text">
# Line 1733  Intellectual Property and Copyright Stat Line 1970  Intellectual Property and Copyright Stat
1970                                              (optionally returned, dependent to driver and channel                                              (optionally returned, dependent to driver and channel
1971                                              parameter)                                              parameter)
1972  </p>  </p>
1973  </blockquote>  </blockquote><p>
1974    
1975    </p>
1976  <p>POSSIBILITIES -  <p>POSSIBILITIES -
1977                                          </p>                                          </p>
1978  <blockquote class="text">  <blockquote class="text">
# Line 1744  Intellectual Property and Copyright Stat Line 1982  Intellectual Property and Copyright Stat
1982                                              (optionally returned, dependent to driver and channel                                              (optionally returned, dependent to driver and channel
1983                                              parameter)                                              parameter)
1984  </p>  </p>
1985  </blockquote>  </blockquote><p>
1986    
1987  </blockquote>  </p>
1988    </blockquote><p>
1989    
1990    </p>
1991  <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.
1992  </p>  </p>
1993  </blockquote>  </blockquote><p>
1994    
1995    </p>
1996  <p>Example:  <p>Example:
1997  </p>  </p>
1998  <p></p>  <p>
1999                            </p>
2000  <blockquote class="text">  <blockquote class="text">
2001  <p>C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"  <p>C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"
2002  </p>  </p>
# Line 1770  Intellectual Property and Copyright Stat Line 2012  Intellectual Property and Copyright Stat
2012  </p>  </p>
2013  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
2014  </p>  </p>
2015  </blockquote>  </blockquote><p>
2016    
2017  <a name="rfc.section.5.2.13"></a><h4><a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER">5.2.13</a>&nbsp;Changing settings of audio output channels</h4>  </p>
2018    <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>
2019    
2020  <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:
2021  </p>  </p>
2022  <p></p>  <p>
2023                            </p>
2024  <blockquote class="text">  <blockquote class="text">
2025  <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;
2026  </p>  </p>
2027  </blockquote>  </blockquote><p>
2028    
2029  <p>Where &lt;dev-id&gt; should be replaced by the numerical ID of the audio  </p>
2030                      device, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the  <p>Where &lt;dev-id&gt; should be replaced by the numerical ID of the audio output device as returned by the
2031                        <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>
2032                        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>
2033                        command, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the
2034                      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.
2035  </p>  </p>
2036  <p>Possible Answers:  <p>Possible Answers:
2037  </p>  </p>
2038  <p></p>  <p>
2039                            </p>
2040  <blockquote class="text">  <blockquote class="text">
2041  <p>"OK" -  <p>"OK" -
2042                                  </p>                                  </p>
2043  <blockquote class="text">  <blockquote class="text">
2044  <p>in case setting was successfully changed  <p>in case setting was successfully changed
2045  </p>  </p>
2046  </blockquote>  </blockquote><p>
2047    
2048    </p>
2049  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2050                                  </p>                                  </p>
2051  <blockquote class="text">  <blockquote class="text">
# Line 1804  Intellectual Property and Copyright Stat Line 2053  Intellectual Property and Copyright Stat
2053                                     noteworthy issue(s) related, providing an appropriate                                     noteworthy issue(s) related, providing an appropriate
2054                                     warning code and warning message                                     warning code and warning message
2055  </p>  </p>
2056  </blockquote>  </blockquote><p>
2057    
2058    </p>
2059  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2060                                  </p>                                  </p>
2061  <blockquote class="text">  <blockquote class="text">
2062  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
2063                                     error message                                     error message
2064  </p>  </p>
2065  </blockquote>  </blockquote><p>
2066    
2067  </blockquote>  </p>
2068    </blockquote><p>
2069    
2070    </p>
2071  <p>Example:  <p>Example:
2072  </p>  </p>
2073  <p></p>  <p>
2074                            </p>
2075  <blockquote class="text">  <blockquote class="text">
2076  <p>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:0'"  <p>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:0'"
2077  </p>  </p>
2078  <p>S: "OK"  <p>S: "OK"
2079  </p>  </p>
2080  </blockquote>  </blockquote><p>
2081    
2082  <p></p>  </p>
2083    <p>
2084                            </p>
2085  <blockquote class="text">  <blockquote class="text">
2086  <p>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 NAME='monitor left'"  <p>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 NAME='monitor left'"
2087  </p>  </p>
2088  <p>S: "OK"  <p>S: "OK"
2089  </p>  </p>
2090  </blockquote>  </blockquote><p>
2091    
2092  <a name="rfc.section.5.3"></a><h4><a name="anchor11">5.3</a>&nbsp;Configuring MIDI input drivers</h4>  </p>
2093    <a name="rfc.section.6.3"></a><h4><a name="anchor10">6.3</a>&nbsp;Configuring MIDI input drivers</h4>
2094    
2095  <p>Instances of drivers in LinuxSampler are called devices. You can use  <p>Instances of drivers in LinuxSampler are called devices. You can use
2096                  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 1862  Intellectual Property and Copyright Stat Line 2118  Intellectual Property and Copyright Stat
2118                  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
2119                  possible values, etc.                  possible values, etc.
2120  </p>  </p>
2121  <a name="rfc.section.5.3.1"></a><h4><a name="GET AVAILABLE_MIDI_INPUT_DRIVERS">5.3.1</a>&nbsp;Getting amount of available MIDI input drivers</h4>  <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>
2122    
2123  <p>Use the following command to get the number of  <p>Use the following command to get the number of
2124                      MIDI input drivers currently available for the                      MIDI input drivers currently available for the
2125                      LinuxSampler instance:                      LinuxSampler instance:
2126  </p>  </p>
2127  <p></p>  <p>
2128                            </p>
2129  <blockquote class="text">  <blockquote class="text">
2130  <p>GET AVAILABLE_MIDI_INPUT_DRIVERS  <p>GET AVAILABLE_MIDI_INPUT_DRIVERS
2131  </p>  </p>
2132  </blockquote>  </blockquote><p>
2133    
2134    </p>
2135  <p>Possible Answers:  <p>Possible Answers:
2136  </p>  </p>
2137  <p></p>  <p>
2138                            </p>
2139  <blockquote class="text">  <blockquote class="text">
2140  <p>LinuxSampler will answer by sending the  <p>LinuxSampler will answer by sending the
2141                              number of available MIDI input drivers.                              number of available MIDI input drivers.
2142  </p>  </p>
2143  </blockquote>  </blockquote><p>
2144    
2145    </p>
2146  <p>Example:  <p>Example:
2147  </p>  </p>
2148  <p></p>  <p>
2149                            </p>
2150  <blockquote class="text">  <blockquote class="text">
2151  <p>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"  <p>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"
2152  </p>  </p>
2153  <p>S: "2"  <p>S: "2"
2154  </p>  </p>
2155  </blockquote>  </blockquote><p>
2156    
2157  <a name="rfc.section.5.3.2"></a><h4><a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS">5.3.2</a>&nbsp;Getting all available MIDI input drivers</h4>  </p>
2158    <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>
2159    
2160  <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
2161                      for the LinuxSampler instance:                      for the LinuxSampler instance:
2162  </p>  </p>
2163  <p></p>  <p>
2164                            </p>
2165  <blockquote class="text">  <blockquote class="text">
2166  <p>LIST AVAILABLE_MIDI_INPUT_DRIVERS  <p>LIST AVAILABLE_MIDI_INPUT_DRIVERS
2167  </p>  </p>
2168  </blockquote>  </blockquote><p>
2169    
2170    </p>
2171  <p>Possible Answers:  <p>Possible Answers:
2172  </p>  </p>
2173  <p></p>  <p>
2174                            </p>
2175  <blockquote class="text">  <blockquote class="text">
2176  <p>LinuxSampler will answer by sending comma separated character  <p>LinuxSampler will answer by sending comma separated character
2177                              strings, each symbolizing a MIDI input driver.                              strings, each symbolizing a MIDI input driver.
2178  </p>  </p>
2179  </blockquote>  </blockquote><p>
2180    
2181    </p>
2182  <p>Example:  <p>Example:
2183  </p>  </p>
2184  <p></p>  <p>
2185                            </p>
2186  <blockquote class="text">  <blockquote class="text">
2187  <p>C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"  <p>C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"
2188  </p>  </p>
2189  <p>S: "ALSA,JACK"  <p>S: "ALSA,JACK"
2190  </p>  </p>
2191  </blockquote>  </blockquote><p>
2192    
2193  <a name="rfc.section.5.3.3"></a><h4><a name="GET MIDI_INPUT_DRIVER INFO">5.3.3</a>&nbsp;Getting information about a specific MIDI input driver</h4>  </p>
2194    <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>
2195    
2196  <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:
2197  </p>  </p>
2198  <p></p>  <p>
2199                            </p>
2200  <blockquote class="text">  <blockquote class="text">
2201  <p>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;  <p>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;
2202  </p>  </p>
2203  </blockquote>  </blockquote><p>
2204    
2205  <p>Where &lt;midi-input-driver&gt; is the name of the MIDI input driver.  </p>
2206    <p>Where &lt;midi-input-driver&gt; is the name of the MIDI input driver as returned
2207                        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.
2208  </p>  </p>
2209  <p>Possible Answers:  <p>Possible Answers:
2210  </p>  </p>
2211  <p></p>  <p>
2212                            </p>
2213  <blockquote class="text">  <blockquote class="text">
2214  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
2215                              Each answer line begins with the information category name                              Each answer line begins with the information category name
# Line 1945  Intellectual Property and Copyright Stat Line 2217  Intellectual Property and Copyright Stat
2217                              the info character string to that info category. At the moment                              the info character string to that info category. At the moment
2218                              the following information categories are defined:                              the following information categories are defined:
2219  </p>  </p>
2220  <p></p>  <p>
2221                                    </p>
2222  <blockquote class="text">  <blockquote class="text">
2223  <p>DESCRIPTION -  <p>DESCRIPTION -
2224                                          </p>                                          </p>
2225  <blockquote class="text">  <blockquote class="text">
2226  <p>arbitrary description text about the MIDI input driver  <p>arbitrary description text about the MIDI input driver
2227  </p>  </p>
2228  </blockquote>  </blockquote><p>
2229    
2230    </p>
2231  <p>VERSION -  <p>VERSION -
2232                                          </p>                                          </p>
2233  <blockquote class="text">  <blockquote class="text">
2234  <p>arbitrary character string regarding the driver's version  <p>arbitrary character string regarding the driver's version
2235  </p>  </p>
2236  </blockquote>  </blockquote><p>
2237    
2238    </p>
2239  <p>PARAMETERS -  <p>PARAMETERS -
2240                                          </p>                                          </p>
2241  <blockquote class="text">  <blockquote class="text">
2242  <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
2243  </p>  </p>
2244  </blockquote>  </blockquote><p>
2245    
2246  </blockquote>  </p>
2247    </blockquote><p>
2248    
2249    </p>
2250  <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.
2251  </p>  </p>
2252  </blockquote>  </blockquote><p>
2253    
2254    </p>
2255  <p>Example:  <p>Example:
2256  </p>  </p>
2257  <p></p>  <p>
2258                            </p>
2259  <blockquote class="text">  <blockquote class="text">
2260  <p>C: "GET MIDI_INPUT_DRIVER INFO ALSA"  <p>C: "GET MIDI_INPUT_DRIVER INFO ALSA"
2261  </p>  </p>
# Line 1988  Intellectual Property and Copyright Stat Line 2267  Intellectual Property and Copyright Stat
2267  </p>  </p>
2268  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
2269  </p>  </p>
2270  </blockquote>  </blockquote><p>
2271    
2272  <a name="rfc.section.5.3.4"></a><h4><a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO">5.3.4</a>&nbsp;Getting information about specific MIDI input driver parameter</h4>  </p>
2273    <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>
2274    
2275  <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:
2276  </p>  </p>
2277  <p></p>  <p>
2278                            </p>
2279  <blockquote class="text">  <blockquote class="text">
2280  <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;]
2281  </p>  </p>
2282  </blockquote>  </blockquote><p>
2283    
2284  <p>Where &lt;midi-t&gt; is the name of the MIDI input driver as returned  </p>
2285                      by the <a class="info" href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span>Getting all available MIDI input drivers</span></a> command, &lt;param&gt; a specific  <p>Where &lt;midit&gt; is the name of the MIDI input driver as returned
2286                        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
2287                      parameter name for which information should be obtained (as returned by the                      parameter name for which information should be obtained (as returned by the
2288                      <a class="info" href="#GET MIDI_INPUT_DRIVER INFO">"GET MIDI_INPUT_DRIVER INFO"<span>Getting information about a specific MIDI input driver</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
2289                      of parameters on which the sought parameter &lt;param&gt; depends on,                      of parameters on which the sought parameter &lt;param&gt; depends on,
2290                      &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 ...",
2291                      where character string values are encapsulated into apostrophes ('). Arguments                      where character string values are encapsulated into apostrophes ('). Arguments
# Line 2022  Intellectual Property and Copyright Stat Line 2304  Intellectual Property and Copyright Stat
2304                      which is only shown dependent to given driver parameter. At                      which is only shown dependent to given driver parameter. At
2305                      the moment the following information categories are defined:                      the moment the following information categories are defined:
2306  </p>  </p>
2307  <p></p>  <p>
2308                            </p>
2309  <blockquote class="text">  <blockquote class="text">
2310  <p>TYPE -  <p>TYPE -
2311                                </p>                                </p>
# Line 2032  Intellectual Property and Copyright Stat Line 2315  Intellectual Property and Copyright Stat
2315                                  character string(s)                                  character string(s)
2316                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2317  </p>  </p>
2318  </blockquote>  </blockquote><p>
2319    
2320    </p>
2321  <p>DESCRIPTION -  <p>DESCRIPTION -
2322                                </p>                                </p>
2323  <blockquote class="text">  <blockquote class="text">
2324  <p>arbitrary text describing the purpose of the parameter  <p>arbitrary text describing the purpose of the parameter
2325                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2326  </p>  </p>
2327  </blockquote>  </blockquote><p>
2328    
2329    </p>
2330  <p>MANDATORY -  <p>MANDATORY -
2331                                </p>                                </p>
2332  <blockquote class="text">  <blockquote class="text">
2333  <p>either true or false, defines if this parameter must be  <p>either true or false, defines if this parameter must be
2334                                  given when the device is to be created with the                                  given when the device is to be created with the
2335                                  <a class="info" href="#CREATE MIDI_INPUT_DEVICE">'CREATE MIDI_INPUT_DEVICE'<span>Creating a MIDI input device</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
2336                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2337  </p>  </p>
2338  </blockquote>  </blockquote><p>
2339    
2340    </p>
2341  <p>FIX -  <p>FIX -
2342                                </p>                                </p>
2343  <blockquote class="text">  <blockquote class="text">
2344  <p>either true or false, if false then this parameter can  <p>either true or false, if false then this parameter can
2345                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
2346                                  the <a class="info" href="#CREATE MIDI_INPUT_DEVICE">'CREATE MIDI_INPUT_DEVICE'<span>Creating a MIDI input device</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
2347                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2348  </p>  </p>
2349  </blockquote>  </blockquote><p>
2350    
2351    </p>
2352  <p>MULTIPLICITY -  <p>MULTIPLICITY -
2353                                </p>                                </p>
2354  <blockquote class="text">  <blockquote class="text">
# Line 2070  Intellectual Property and Copyright Stat Line 2357  Intellectual Property and Copyright Stat
2357                                  multiple values and false only a single value allowed                                  multiple values and false only a single value allowed
2358                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2359  </p>  </p>
2360  </blockquote>  </blockquote><p>
2361    
2362    </p>
2363  <p>DEPENDS -  <p>DEPENDS -
2364                                </p>                                </p>
2365  <blockquote class="text">  <blockquote class="text">
2366  <p>comma separated list of paramters this parameter depends  <p>comma separated list of parameters this parameter depends
2367                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',
2368                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these
2369                                  listed parameters, for example assuming that an audio                                  listed parameters, for example assuming that an audio
# Line 2086  Intellectual Property and Copyright Stat Line 2374  Intellectual Property and Copyright Stat
2374                                  chosen by the 'card' parameter                                  chosen by the 'card' parameter
2375                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
2376  </p>  </p>
2377  </blockquote>  </blockquote><p>
2378    
2379    </p>
2380  <p>DEFAULT -  <p>DEFAULT -
2381                                </p>                                </p>
2382  <blockquote class="text">  <blockquote class="text">
2383  <p>reflects the default value for this parameter which is  <p>reflects the default value for this parameter which is
2384                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
2385                                  given with the <a class="info" href="#CREATE MIDI_INPUT_DEVICE">'CREATE MIDI_INPUT_DEVICE'<span>Creating a MIDI input device</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,
2386                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
2387                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
2388                                  apostrophes (')                                  apostrophes (')
2389                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
2390  </p>  </p>
2391  </blockquote>  </blockquote><p>
2392    
2393    </p>
2394  <p>RANGE_MIN -  <p>RANGE_MIN -
2395                                </p>                                </p>
2396  <blockquote class="text">  <blockquote class="text">
# Line 2110  Intellectual Property and Copyright Stat Line 2400  Intellectual Property and Copyright Stat
2400                                  with RANGE_MAX, but may also appear without                                  with RANGE_MAX, but may also appear without
2401                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
2402  </p>  </p>
2403  </blockquote>  </blockquote><p>
2404    
2405    </p>
2406  <p>RANGE_MAX -  <p>RANGE_MAX -
2407                                </p>                                </p>
2408  <blockquote class="text">  <blockquote class="text">
# Line 2121  Intellectual Property and Copyright Stat Line 2412  Intellectual Property and Copyright Stat
2412                                  RANGE_MIN, but may also appear without                                  RANGE_MIN, but may also appear without
2413                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
2414  </p>  </p>
2415  </blockquote>  </blockquote><p>
2416    
2417    </p>
2418  <p>POSSIBILITIES -  <p>POSSIBILITIES -
2419                                </p>                                </p>
2420  <blockquote class="text">  <blockquote class="text">
# Line 2131  Intellectual Property and Copyright Stat Line 2423  Intellectual Property and Copyright Stat
2423                                  apostrophes                                  apostrophes
2424                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
2425  </p>  </p>
2426  </blockquote>  </blockquote><p>
2427    
2428  </blockquote>  </p>
2429    </blockquote><p>
2430    
2431    </p>
2432  <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.
2433  </p>  </p>
2434  <p>Example:  <p>Example:
2435  </p>  </p>
2436  <p></p>  <p>
2437                            </p>
2438  <blockquote class="text">  <blockquote class="text">
2439  <p>C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"  <p>C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"
2440  </p>  </p>
# Line 2157  Intellectual Property and Copyright Stat Line 2452  Intellectual Property and Copyright Stat
2452  </p>  </p>
2453  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
2454  </p>  </p>
2455  </blockquote>  </blockquote><p>
2456    
2457  <a name="rfc.section.5.3.5"></a><h4><a name="CREATE MIDI_INPUT_DEVICE">5.3.5</a>&nbsp;Creating a MIDI input device</h4>  </p>
2458    <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>
2459    
2460  <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:
2461  </p>  </p>
2462  <p></p>  <p>
2463                            </p>
2464  <blockquote class="text">  <blockquote class="text">
2465  <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;]
2466  </p>  </p>
2467  </blockquote>  </blockquote><p>
2468    
2469  <p>Where &lt;midi-input-driver&gt; should be replaced by the desired MIDI input system and &lt;param-list&gt; by an  </p>
2470    <p>Where &lt;midi-input-driver&gt; should be replaced by the desired MIDI input system as returned
2471                        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
2472                      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
2473                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
2474                      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 2178  Intellectual Property and Copyright Stat Line 2477  Intellectual Property and Copyright Stat
2477  </p>  </p>
2478  <p>Possible Answers:  <p>Possible Answers:
2479  </p>  </p>
2480  <p></p>  <p>
2481                            </p>
2482  <blockquote class="text">  <blockquote class="text">
2483  <p>"OK[&lt;device-id&gt;]" -  <p>"OK[&lt;device-id&gt;]" -
2484                                  </p>                                  </p>
# Line 2186  Intellectual Property and Copyright Stat Line 2486  Intellectual Property and Copyright Stat
2486  <p>in case the device was successfully created, where  <p>in case the device was successfully created, where
2487                                      &lt;device-id&gt; is the numerical ID of the new device                                      &lt;device-id&gt; is the numerical ID of the new device
2488  </p>  </p>
2489  </blockquote>  </blockquote><p>
2490    
2491    </p>
2492  <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;" -
2493                                  </p>                                  </p>
2494  <blockquote class="text">  <blockquote class="text">
# Line 2196  Intellectual Property and Copyright Stat Line 2497  Intellectual Property and Copyright Stat
2497                                      there are noteworthy issue(s) related, providing an                                      there are noteworthy issue(s) related, providing an
2498                                      appropriate warning code and warning message                                      appropriate warning code and warning message
2499  </p>  </p>
2500  </blockquote>  </blockquote><p>
2501    
2502    </p>
2503  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2504                                  </p>                                  </p>
2505  <blockquote class="text">  <blockquote class="text">
2506  <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
2507  </p>  </p>
2508  </blockquote>  </blockquote><p>
2509    
2510  </blockquote>  </p>
2511    </blockquote><p>
2512    
2513    </p>
2514  <p>Example:  <p>Example:
2515  </p>  </p>
2516  <p></p>  <p>
2517                            </p>
2518  <blockquote class="text">  <blockquote class="text">
2519  <p>C: "CREATE MIDI_INPUT_DEVICE ALSA"  <p>C: "CREATE MIDI_INPUT_DEVICE ALSA"
2520  </p>  </p>
2521  <p>S: "OK[0]"  <p>S: "OK[0]"
2522  </p>  </p>
2523  </blockquote>  </blockquote><p>
2524    
2525  <a name="rfc.section.5.3.6"></a><h4><a name="DESTROY MIDI_INPUT_DEVICE">5.3.6</a>&nbsp;Destroying a MIDI input device</h4>  </p>
2526    <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>
2527    
2528  <p>Use the following command to destroy a created MIDI input device:  <p>Use the following command to destroy a created MIDI input device:
2529  </p>  </p>
2530  <p></p>  <p>
2531                            </p>
2532  <blockquote class="text">  <blockquote class="text">
2533  <p>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;  <p>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;
2534  </p>  </p>
2535  </blockquote>  </blockquote><p>
2536    
2537  <p>Where &lt;device-id&gt; should be replaced by the device's numerical ID.  </p>
2538    <p>Where &lt;device-id&gt; should be replaced by the device's numerical ID as returned by the
2539                        <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>
2540                        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>
2541                        command.
2542  </p>  </p>
2543  <p>Possible Answers:  <p>Possible Answers:
2544  </p>  </p>
2545  <p></p>  <p>
2546                            </p>
2547  <blockquote class="text">  <blockquote class="text">
2548  <p>"OK" -  <p>"OK" -
2549                                  </p>                                  </p>
2550  <blockquote class="text">  <blockquote class="text">
2551  <p>in case the device was successfully destroyed  <p>in case the device was successfully destroyed
2552  </p>  </p>
2553  </blockquote>  </blockquote><p>
2554    
2555    </p>
2556  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2557                                  </p>                                  </p>
2558  <blockquote class="text">  <blockquote class="text">
# Line 2247  Intellectual Property and Copyright Stat Line 2560  Intellectual Property and Copyright Stat
2560                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
2561                                      warning message                                      warning message
2562  </p>  </p>
2563  </blockquote>  </blockquote><p>
2564    
2565    </p>
2566  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2567                                  </p>                                  </p>
2568  <blockquote class="text">  <blockquote class="text">
2569  <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
2570  </p>  </p>
2571  </blockquote>  </blockquote><p>
2572    
2573  </blockquote>  </p>
2574    </blockquote><p>
2575    
2576    </p>
2577  <p>Example:  <p>Example:
2578  </p>  </p>
2579  <p></p>  <p>
2580                            </p>
2581  <blockquote class="text">  <blockquote class="text">
2582  <p>C: "DESTROY MIDI_INPUT_DEVICE 0"  <p>C: "DESTROY MIDI_INPUT_DEVICE 0"
2583  </p>  </p>
2584  <p>S: "OK"  <p>S: "OK"
2585  </p>  </p>
2586  </blockquote>  </blockquote><p>
2587    
2588  <a name="rfc.section.5.3.7"></a><h4><a name="GET MIDI_INPUT_DEVICES">5.3.7</a>&nbsp;Getting all created MIDI input device count</h4>  </p>
2589    <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>
2590    
2591  <p>Use the following command to count all created MIDI input devices:  <p>Use the following command to count all created MIDI input devices:
2592  </p>  </p>
2593  <p></p>  <p>
2594                            </p>
2595  <blockquote class="text">  <blockquote class="text">
2596  <p>GET MIDI_INPUT_DEVICES  <p>GET MIDI_INPUT_DEVICES
2597  </p>  </p>
2598  </blockquote>  </blockquote><p>
2599    
2600    </p>
2601  <p>Possible Answers:  <p>Possible Answers:
2602  </p>  </p>
2603  <p></p>  <p>
2604                            </p>
2605  <blockquote class="text">  <blockquote class="text">
2606  <p>LinuxSampler will answer by sending the current number of all  <p>LinuxSampler will answer by sending the current number of all
2607                              MIDI input devices.                              MIDI input devices.
2608  </p>  </p>
2609  </blockquote>  </blockquote><p>
2610    
2611    </p>
2612  <p>Example:  <p>Example:
2613  </p>  </p>
2614  <p></p>  <p>
2615                            </p>
2616  <blockquote class="text">  <blockquote class="text">
2617  <p>C: "GET MIDI_INPUT_DEVICES"  <p>C: "GET MIDI_INPUT_DEVICES"
2618  </p>  </p>
2619  <p>S: "3"  <p>S: "3"
2620  </p>  </p>
2621  </blockquote>  </blockquote><p>
2622    
2623  <a name="rfc.section.5.3.8"></a><h4><a name="LIST MIDI_INPUT_DEVICES">5.3.8</a>&nbsp;Getting all created MIDI input device list</h4>  </p>
2624    <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>
2625    
2626  <p>Use the following command to list all created MIDI input devices:  <p>Use the following command to list all created MIDI input devices:
2627  </p>  </p>
2628  <p></p>  <p>
2629                            </p>
2630  <blockquote class="text">  <blockquote class="text">
2631  <p>LIST MIDI_INPUT_DEVICES  <p>LIST MIDI_INPUT_DEVICES
2632  </p>  </p>
2633  </blockquote>  </blockquote><p>
2634    
2635    </p>
2636  <p>Possible Answers:  <p>Possible Answers:
2637  </p>  </p>
2638  <p></p>  <p>
2639                            </p>
2640  <blockquote class="text">  <blockquote class="text">
2641  <p>LinuxSampler will answer by sending a comma separated list  <p>LinuxSampler will answer by sending a comma separated list
2642                              with the numerical Ids of all created MIDI input devices.                              with the numerical Ids of all created MIDI input devices.
2643  </p>  </p>
2644  </blockquote>  </blockquote><p>
2645    
2646    </p>
2647  <p>Examples:  <p>Examples:
2648  </p>  </p>
2649  <p></p>  <p>
2650                            </p>
2651  <blockquote class="text">  <blockquote class="text">
2652  <p>C: "LIST MIDI_INPUT_DEVICES"  <p>C: "LIST MIDI_INPUT_DEVICES"
2653  </p>  </p>
2654  <p>S: "0,1,2"  <p>S: "0,1,2"
2655  </p>  </p>
2656  </blockquote>  </blockquote><p>
2657    
2658  <p></p>  </p>
2659    <p>
2660                            </p>
2661  <blockquote class="text">  <blockquote class="text">
2662  <p>C: "LIST MIDI_INPUT_DEVICES"  <p>C: "LIST MIDI_INPUT_DEVICES"
2663  </p>  </p>
2664  <p>S: "1,3"  <p>S: "1,3"
2665  </p>  </p>
2666  </blockquote>  </blockquote><p>
2667    
2668  <a name="rfc.section.5.3.9"></a><h4><a name="GET MIDI_INPUT_DEVICE INFO">5.3.9</a>&nbsp;Getting current settings of a MIDI input device</h4>  </p>
2669    <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>
2670    
2671  <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:
2672  </p>  </p>
2673  <p></p>  <p>
2674                            </p>
2675  <blockquote class="text">  <blockquote class="text">
2676  <p>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;  <p>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;
2677  </p>  </p>
2678  </blockquote>  </blockquote><p>
2679    
2680  <p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device.  </p>
2681    <p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
2682                        <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>
2683                        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>
2684                        command.
2685  </p>  </p>
2686  <p>Possible Answers:  <p>Possible Answers:
2687  </p>  </p>
2688  <p></p>  <p>
2689                            </p>
2690  <blockquote class="text">  <blockquote class="text">
2691  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
2692                              Each answer line begins with the information category name                              Each answer line begins with the information category name
# Line 2358  Intellectual Property and Copyright Stat Line 2696  Intellectual Property and Copyright Stat
2696                              encapsulated into apostrophes ('). At the moment the following                              encapsulated into apostrophes ('). At the moment the following
2697                              information categories are defined (independent of driver):                              information categories are defined (independent of driver):
2698  </p>  </p>
2699  <p></p>  <p>
2700                                    </p>
2701  <blockquote class="text">  <blockquote class="text">
2702  <p>DRIVER -  <p>DRIVER -
2703                                          </p>                                          </p>
2704  <blockquote class="text">  <blockquote class="text">
2705  <p>identifier of the used MIDI input driver, as e.g.  <p>identifier of the used MIDI input driver, as e.g.
2706                                              returned by the <a class="info" href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span>Getting all available MIDI input drivers</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>
2707                                              command                                              command
2708  </p>  </p>
2709  </blockquote>  </blockquote><p>
2710    
2711  </blockquote>  </p>
2712    </blockquote><p>
2713                                    </p>
2714  <blockquote class="text">  <blockquote class="text">
2715  <p><p>ACTIVE -  <p>ACTIVE -
2716                                          </p>                                          </p>
2717  <blockquote class="text">  <blockquote class="text">
2718  <p>either true or false, if false then the MIDI device is  <p>either true or false, if false then the MIDI device is
# Line 2379  Intellectual Property and Copyright Stat Line 2720  Intellectual Property and Copyright Stat
2720                                              and thus doesn't forward them to connected sampler                                              and thus doesn't forward them to connected sampler
2721                                              channels                                              channels
2722  </p>  </p>
2723  </blockquote>  </blockquote><p>
2724    
2725  </blockquote>  </p>
2726    </blockquote><p>
2727    
2728  </blockquote>  </p>
2729    </blockquote><p>
2730    
2731    </p>
2732  <p>The mentioned fields above don't have to be in particular  <p>The mentioned fields above don't have to be in particular
2733                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
2734                      returned by all MIDI input devices. Every MIDI input driver                      returned by all MIDI input devices. Every MIDI input driver
2735                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
2736                      <a class="info" href="#GET MIDI_INPUT_DRIVER INFO">"GET MIDI_INPUT_DRIVER INFO"<span>Getting information about a specific MIDI input driver</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
2737                      by this command.                      by this command.
2738  </p>  </p>
2739  <p>Example:  <p>Example:
2740  </p>  </p>
2741  <p></p>  <p>
2742                            </p>
2743  <blockquote class="text">  <blockquote class="text">
2744  <p>C: "GET MIDI_INPUT_DEVICE INFO 0"  <p>C: "GET MIDI_INPUT_DEVICE INFO 0"
2745  </p>  </p>
# Line 2404  Intellectual Property and Copyright Stat Line 2749  Intellectual Property and Copyright Stat
2749  </p>  </p>
2750  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
2751  </p>  </p>
2752  </blockquote>  </blockquote><p>
2753    
2754  <a name="rfc.section.5.3.10"></a><h4><a name="SET MIDI_INPUT_DEVICE_PARAMETER">5.3.10</a>&nbsp;Changing settings of MIDI input devices</h4>  </p>
2755    <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>
2756    
2757  <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:
2758  </p>  </p>
2759  <p></p>  <p>
2760                            </p>
2761  <blockquote class="text">  <blockquote class="text">
2762  <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;
2763  </p>  </p>
2764  </blockquote>  </blockquote><p>
2765    
2766    </p>
2767  <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
2768                      MIDI input device, &lt;key&gt; by the name of the parameter to change and                      MIDI input device as returned by the
2769                        <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>
2770                        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>
2771                        command, &lt;key&gt; by the name of the parameter to change and
2772                      &lt;value&gt; by the new value for this parameter.                      &lt;value&gt; by the new value for this parameter.
2773  </p>  </p>
2774  <p>Possible Answers:  <p>Possible Answers:
2775  </p>  </p>
2776  <p></p>  <p>
2777                            </p>
2778  <blockquote class="text">  <blockquote class="text">
2779  <p>"OK" -  <p>"OK" -
2780                                  </p>                                  </p>
2781  <blockquote class="text">  <blockquote class="text">
2782  <p>in case setting was successfully changed  <p>in case setting was successfully changed
2783  </p>  </p>
2784  </blockquote>  </blockquote><p>
2785    
2786    </p>
2787  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2788                                  </p>                                  </p>
2789  <blockquote class="text">  <blockquote class="text">
# Line 2438  Intellectual Property and Copyright Stat Line 2791  Intellectual Property and Copyright Stat
2791                                      noteworthy issue(s) related, providing an appropriate                                      noteworthy issue(s) related, providing an appropriate
2792                                      warning code and warning message                                      warning code and warning message
2793  </p>  </p>
2794  </blockquote>  </blockquote><p>
2795    
2796    </p>
2797  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2798                                  </p>                                  </p>
2799  <blockquote class="text">  <blockquote class="text">
2800  <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
2801  </p>  </p>
2802  </blockquote>  </blockquote><p>
2803    
2804  </blockquote>  </p>
2805    </blockquote><p>
2806    
2807    </p>
2808  <p>Example:  <p>Example:
2809  </p>  </p>
2810  <p></p>  <p>
2811                            </p>
2812  <blockquote class="text">  <blockquote class="text">
2813  <p>C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"  <p>C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"
2814  </p>  </p>
2815  <p>S: "OK"  <p>S: "OK"
2816  </p>  </p>
2817  </blockquote>  </blockquote><p>
2818    
2819  <a name="rfc.section.5.3.11"></a><h4><a name="GET MIDI_INPUT_PORT INFO">5.3.11</a>&nbsp;Getting information about a MIDI port</h4>  </p>
2820    <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>
2821    
2822  <p>Use the following command to get information about a MIDI port:  <p>Use the following command to get information about a MIDI port:
2823  </p>  </p>
2824  <p></p>  <p>
2825                            </p>
2826  <blockquote class="text">  <blockquote class="text">
2827  <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;
2828  </p>  </p>
2829  </blockquote>  </blockquote><p>
2830    
2831  <p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device  </p>
2832                      and &lt;midi-port&gt; the MIDI input port number.  <p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
2833                        <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>
2834                        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>
2835                        command and &lt;midi-port&gt; the MIDI input port number.
2836  </p>  </p>
2837  <p>Possible Answers:  <p>Possible Answers:
2838  </p>  </p>
2839  <p></p>  <p>
2840                            </p>
2841  <blockquote class="text">  <blockquote class="text">
2842  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
2843                              Each answer line begins with the information category name                              Each answer line begins with the information category name
# Line 2487  Intellectual Property and Copyright Stat Line 2850  Intellectual Property and Copyright Stat
2850  <blockquote class="text">  <blockquote class="text">
2851  <p>arbitrary character string naming the port  <p>arbitrary character string naming the port
2852  </p>  </p>
2853  </blockquote>  </blockquote><p>
2854    
2855  </blockquote>  </p>
2856    </blockquote><p>
2857    
2858    </p>
2859  <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
2860                      ports regardless of the MIDI driver and port. Every MIDI port                      ports regardless of the MIDI driver and port. Every MIDI port
2861                      might have its own, additional driver and port specific                      might have its own, additional driver and port specific
# Line 2498  Intellectual Property and Copyright Stat Line 2863  Intellectual Property and Copyright Stat
2863  </p>  </p>
2864  <p>Example:  <p>Example:
2865  </p>  </p>
2866  <p></p>  <p>
2867                            </p>
2868  <blockquote class="text">  <blockquote class="text">
2869  <p>C: "GET MIDI_INPUT_PORT INFO 0 0"  <p>C: "GET MIDI_INPUT_PORT INFO 0 0"
2870  </p>  </p>
# Line 2508  Intellectual Property and Copyright Stat Line 2874  Intellectual Property and Copyright Stat
2874  </p>  </p>
2875  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
2876  </p>  </p>
2877  </blockquote>  </blockquote><p>
2878    
2879  <a name="rfc.section.5.3.12"></a><h4><a name="GET MIDI_INPUT_PORT_PARAMETER INFO">5.3.12</a>&nbsp;Getting information about specific MIDI port parameter</h4>  </p>
2880    <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>
2881    
2882  <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:
2883  </p>  </p>
2884  <p></p>  <p>
2885                            </p>
2886  <blockquote class="text">  <blockquote class="text">
2887  <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;
2888  </p>  </p>
2889  </blockquote>  </blockquote><p>
2890    
2891  <p>Where &lt;dev-id&gt; is the numerical ID of the MIDI input device as returned  </p>
2892                      by the <a class="info" href="#LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"<span>Getting all created MIDI input device list</span></a> command, &lt;port&gt; the MIDI port number and  <p>Where &lt;dev-id&gt; is the numerical ID of the MIDI input device as returned by the
2893                        <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>
2894                        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>
2895                        command, &lt;port&gt; the MIDI port number and
2896                      &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
2897                      obtained (as returned by the <a class="info" href="#GET MIDI_INPUT_PORT INFO">"GET MIDI_INPUT_PORT INFO"<span>Getting information about a MIDI port</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).
2898  </p>  </p>
2899  <p>Possible Answers:  <p>Possible Answers:
2900  </p>  </p>
2901  <p></p>  <p>
2902                            </p>
2903  <blockquote class="text">  <blockquote class="text">
2904  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
2905                              Each answer line begins with the information category name                              Each answer line begins with the information category name
# Line 2546  Intellectual Property and Copyright Stat Line 2918  Intellectual Property and Copyright Stat
2918                                      character string(s)                                      character string(s)
2919                                      (always returned)                                      (always returned)
2920  </p>  </p>
2921  </blockquote>  </blockquote><p>
2922    
2923    </p>
2924  <p>DESCRIPTION -  <p>DESCRIPTION -
2925                                  </p>                                  </p>
2926  <blockquote class="text">  <blockquote class="text">
2927  <p>arbitrary text describing the purpose of the parameter  <p>arbitrary text describing the purpose of the parameter
2928                                      (always returned)                                      (always returned)
2929  </p>  </p>
2930  </blockquote>  </blockquote><p>
2931    
2932    </p>
2933  <p>FIX -  <p>FIX -
2934                                  </p>                                  </p>
2935  <blockquote class="text">  <blockquote class="text">
# Line 2563  Intellectual Property and Copyright Stat Line 2937  Intellectual Property and Copyright Stat
2937                                      read only, thus cannot be altered                                      read only, thus cannot be altered
2938                                      (always returned)                                      (always returned)
2939  </p>  </p>
2940  </blockquote>  </blockquote><p>
2941    
2942    </p>
2943  <p>MULTIPLICITY -  <p>MULTIPLICITY -
2944                                  </p>                                  </p>
2945  <blockquote class="text">  <blockquote class="text">
# Line 2573  Intellectual Property and Copyright Stat Line 2948  Intellectual Property and Copyright Stat
2948                                      multiple values and false only a single value allowed                                      multiple values and false only a single value allowed
2949                                      (always returned)                                      (always returned)
2950  </p>  </p>
2951  </blockquote>  </blockquote><p>
2952    
2953    </p>
2954  <p>RANGE_MIN -  <p>RANGE_MIN -
2955                                  </p>                                  </p>
2956  <blockquote class="text">  <blockquote class="text">
# Line 2585  Intellectual Property and Copyright Stat Line 2961  Intellectual Property and Copyright Stat
2961                                      (optionally returned, dependent to driver and port                                      (optionally returned, dependent to driver and port
2962                                      parameter)                                      parameter)
2963  </p>  </p>
2964  </blockquote>  </blockquote><p>
2965    
2966    </p>
2967  <p>RANGE_MAX -  <p>RANGE_MAX -
2968                                  </p>                                  </p>
2969  <blockquote class="text">  <blockquote class="text">
# Line 2597  Intellectual Property and Copyright Stat Line 2974  Intellectual Property and Copyright Stat
2974                                      (optionally returned, dependent to driver and port                                      (optionally returned, dependent to driver and port
2975                                      parameter)                                      parameter)
2976  </p>  </p>
2977  </blockquote>  </blockquote><p>
2978    
2979    </p>
2980  <p>POSSIBILITIES -  <p>POSSIBILITIES -
2981                                  </p>                                  </p>
2982  <blockquote class="text">  <blockquote class="text">
# Line 2608  Intellectual Property and Copyright Stat Line 2986  Intellectual Property and Copyright Stat
2986                                      (optionally returned, dependent to device and port                                      (optionally returned, dependent to device and port
2987                                      parameter)                                      parameter)
2988  </p>  </p>
2989  </blockquote>  </blockquote><p>
2990    
2991  </blockquote>  </p>
2992    </blockquote><p>
2993    
2994    </p>
2995  <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.
2996  </p>  </p>
2997  <p>Example:  <p>Example:
2998  </p>  </p>
2999  <p></p>  <p>
3000                            </p>
3001  <blockquote class="text">  <blockquote class="text">
3002  <p>C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"  <p>C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"
3003  </p>  </p>
# Line 2632  Intellectual Property and Copyright Stat Line 3013  Intellectual Property and Copyright Stat
3013  </p>  </p>
3014  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
3015  </p>  </p>
3016  </blockquote>  </blockquote><p>
3017    
3018  <a name="rfc.section.5.3.13"></a><h4><a name="SET MIDI_INPUT_PORT_PARAMETER">5.3.13</a>&nbsp;Changing settings of MIDI input ports</h4>  </p>
3019    <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>
3020    
3021  <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:
3022  </p>  </p>
3023  <p></p>  <p>
3024                            </p>
3025  <blockquote class="text">  <blockquote class="text">
3026  <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;
3027  </p>  </p>
3028  </blockquote>  </blockquote><p>
3029    
3030    </p>
3031  <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
3032                      MIDI device, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of                      MIDI device as returned by the
3033                        <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>
3034                        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>
3035                        command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
3036                      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
3037                      parameter.                      parameter.
3038  </p>  </p>
3039  <p>Possible Answers:  <p>Possible Answers:
3040  </p>  </p>
3041  <p></p>  <p>
3042                            </p>
3043  <blockquote class="text">  <blockquote class="text">
3044  <p>"OK" -  <p>"OK" -
3045                                  </p>                                  </p>
3046  <blockquote class="text">  <blockquote class="text">
3047  <p>in case setting was successfully changed  <p>in case setting was successfully changed
3048  </p>  </p>
3049  </blockquote>  </blockquote><p>
3050    
3051    </p>
3052  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3053                                  </p>                                  </p>
3054  <blockquote class="text">  <blockquote class="text">
# Line 2667  Intellectual Property and Copyright Stat Line 3056  Intellectual Property and Copyright Stat
3056                                      noteworthy issue(s) related, providing an appropriate                                      noteworthy issue(s) related, providing an appropriate
3057                                      warning code and warning message                                      warning code and warning message
3058  </p>  </p>
3059  </blockquote>  </blockquote><p>
3060    
3061    </p>
3062  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3063                                  </p>                                  </p>
3064  <blockquote class="text">  <blockquote class="text">
3065  <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
3066  </p>  </p>
3067  </blockquote>  </blockquote><p>
3068    
3069  </blockquote>  </p>
3070    </blockquote><p>
3071    
3072    </p>
3073  <p>Example:  <p>Example:
3074  </p>  </p>
3075  <p></p>  <p>
3076                            </p>
3077  <blockquote class="text">  <blockquote class="text">
3078  <p>  <p>
3079  </p>  </p>
3080  </blockquote>  </blockquote><p>
3081    
3082  <a name="rfc.section.5.4"></a><h4><a name="anchor12">5.4</a>&nbsp;Configuring sampler channels</h4>  </p>
3083    <a name="rfc.section.6.4"></a><h4><a name="anchor11">6.4</a>&nbsp;Configuring sampler channels</h4>
3084    
3085  <p>The following commands describe how to add and remove sampler channels, deploy  <p>The following commands describe how to add and remove sampler channels, associate a
3086                  sampler engines, load instruments and connect sampler channels to MIDI and audio devices.                  sampler channel with a sampler engine, load instruments and connect sampler channels to
3087                    MIDI and audio devices.
3088  </p>  </p>
3089  <a name="rfc.section.5.4.1"></a><h4><a name="LOAD INSTRUMENT">5.4.1</a>&nbsp;Loading an instrument</h4>  <a name="rfc.section.6.4.1"></a><h4><a name="LOAD INSTRUMENT">6.4.1</a>&nbsp;Loading an instrument</h4>
3090    
3091  <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:
3092  </p>  </p>
3093  <p></p>  <p>
3094                            </p>
3095  <blockquote class="text">  <blockquote class="text">
3096  <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;
3097  </p>  </p>
3098  </blockquote>  </blockquote><p>
3099    
3100    </p>
3101  <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
3102                      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
3103                      instrument in the instrument file and &lt;sampler-channel> is the                      instrument in the instrument file and &lt;sampler-channel> is the
# Line 2711  Intellectual Property and Copyright Stat Line 3108  Intellectual Property and Copyright Stat
3108                      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
3109                      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
3110                      returns immediately and a background process is launched to load the instrument                      returns immediately and a background process is launched to load the instrument
3111                      on the channel. The <a class="info" href="#GET CHANNEL INFO">GET CHANNEL INFO<span>Getting sampler channel information</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>
3112                      command can be used to obtain loading                      command can be used to obtain loading
3113                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks
3114                      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 2720  Intellectual Property and Copyright Stat Line 3117  Intellectual Property and Copyright Stat
3117  </p>  </p>
3118  <p>Possible Answers:  <p>Possible Answers:
3119  </p>  </p>
3120  <p></p>  <p>
3121                            </p>
3122  <blockquote class="text">  <blockquote class="text">
3123  <p>"OK" -  <p>"OK" -
3124                                  </p>                                  </p>
3125  <blockquote class="text">  <blockquote class="text">
3126  <p>in case the instrument was successfully loaded  <p>in case the instrument was successfully loaded
3127  </p>  </p>
3128  </blockquote>  </blockquote><p>
3129    
3130    </p>
3131  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3132                                  </p>                                  </p>
3133  <blockquote class="text">  <blockquote class="text">
# Line 2738  Intellectual Property and Copyright Stat Line 3137  Intellectual Property and Copyright Stat
3137                                      instrument file), providing an appropriate warning code and                                      instrument file), providing an appropriate warning code and
3138                                      warning message                                      warning message
3139  </p>  </p>
3140  </blockquote>  </blockquote><p>
3141    
3142    </p>
3143  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3144                                  </p>                                  </p>
3145  <blockquote class="text">  <blockquote class="text">
3146  <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
3147  </p>  </p>
3148  </blockquote>  </blockquote><p>
3149    
3150  </blockquote>  </p>
3151    </blockquote><p>
3152    
3153    </p>
3154  <p>Example:  <p>Example:
3155  </p>  </p>
3156  <p></p>  <p>
3157                            </p>
3158  <blockquote class="text">  <blockquote class="text">
3159  <p>  <p>
3160  </p>  </p>
3161  </blockquote>  </blockquote><p>
3162    
3163  <a name="rfc.section.5.4.2"></a><h4><a name="LOAD ENGINE">5.4.2</a>&nbsp;Loading a sampler engine</h4>  </p>
3164    <a name="rfc.section.6.4.2"></a><h4><a name="LOAD ENGINE">6.4.2</a>&nbsp;Loading a sampler engine</h4>
3165    
3166  <p>A sample engine can be deployed and assigned to a specific sampler  <p>A sampler engine type can be associated to a specific sampler
3167                      channel by the following command:                      channel by the following command:
3168  </p>  </p>
3169  <p></p>  <p>
3170                            </p>
3171  <blockquote class="text">  <blockquote class="text">
3172  <p>LOAD ENGINE &lt;engine-name&gt; &lt;sampler-channel&gt;  <p>LOAD ENGINE &lt;engine-name&gt; &lt;sampler-channel&gt;
3173  </p>  </p>
3174  </blockquote>  </blockquote><p>
3175    
3176    </p>
3177  <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
3178                      <a class="info" href="#LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"<span>Getting all available engines</span></a> command and &lt;sampler-channel&gt; the sampler channel the                      <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;
3179                      deployed engine should be assigned to. Even if the respective                      the sampler channel as returned by the
3180                      sampler channel has already a deployed engine with that engine                      <a class="info" href="#ADD CHANNEL">"ADD CHANNEL"<span> (</span><span class="info">Adding a new sampler channel</span><span>)</span></a> or
3181                      name, a new engine instance will be assigned to the sampler channel.                      <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
3182                        the engine type should be assigned to. This command should be issued
3183                        after adding a new sampler channel and before any other control
3184                        commands on the new sampler channel. It can also be used to change
3185                        the engine type of a sampler channel. This command has (currently) no
3186                        way to define or force if a new engine instance should be created and
3187                        assigned to the given sampler channel or if an already existing
3188                        instance of that engine type, shared with other sampler channels,
3189                        should be used.
3190  </p>  </p>
3191  <p>Possible Answers:  <p>Possible Answers:
3192  </p>  </p>
3193  <p></p>  <p>
3194                            </p>
3195  <blockquote class="text">  <blockquote class="text">
3196  <p>"OK" -  <p>"OK" -
3197                                  </p>                                  </p>
3198  <blockquote class="text">  <blockquote class="text">
3199  <p>in case the engine was successfully deployed  <p>in case the engine was successfully deployed
3200  </p>  </p>
3201  </blockquote>  </blockquote><p>
3202    
3203    </p>
3204  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3205                                  </p>                                  </p>
3206  <blockquote class="text">  <blockquote class="text">
# Line 2792  Intellectual Property and Copyright Stat Line 3208  Intellectual Property and Copyright Stat
3208                                      are noteworthy issue(s) related, providing an appropriate                                      are noteworthy issue(s) related, providing an appropriate
3209                                      warning code and warning message                                      warning code and warning message
3210  </p>  </p>
3211  </blockquote>  </blockquote><p>
3212    
3213    </p>
3214  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3215                                  </p>                                  </p>
3216  <blockquote class="text">  <blockquote class="text">
3217  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
3218                                      error message                                      error message
3219  </p>  </p>
3220  </blockquote>  </blockquote><p>
3221    
3222  </blockquote>  </p>
3223    </blockquote><p>
3224    
3225    </p>
3226  <p>Example:  <p>Example:
3227  </p>  </p>
3228  <p></p>  <p>
3229                            </p>
3230  <blockquote class="text">  <blockquote class="text">
3231  <p>  <p>
3232  </p>  </p>
3233  </blockquote>  </blockquote><p>
3234    
3235  <a name="rfc.section.5.4.3"></a><h4><a name="GET CHANNELS">5.4.3</a>&nbsp;Getting all created sampler channel count</h4>  </p>
3236    <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>
3237    
3238  <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
3239                      current amount of sampler channels, the front-end can send the                      current amount of sampler channels, the front-end can send the
3240                      following command:                      following command:
3241  </p>  </p>
3242  <p></p>  <p>
3243                            </p>
3244  <blockquote class="text">  <blockquote class="text">
3245  <p>GET CHANNELS  <p>GET CHANNELS
3246  </p>  </p>
3247  </blockquote>  </blockquote><p>
3248    
3249    </p>
3250  <p>Possible Answers:  <p>Possible Answers:
3251  </p>  </p>
3252  <p></p>  <p>
3253                            </p>
3254  <blockquote class="text">  <blockquote class="text">
3255  <p>LinuxSampler will answer by returning the current number of sampler channels.  <p>LinuxSampler will answer by returning the current number of sampler channels.
3256  </p>  </p>
3257  </blockquote>  </blockquote><p>
3258    
3259    </p>
3260  <p>Example:  <p>Example:
3261  </p>  </p>
3262  <p></p>  <p>
3263                            </p>
3264  <blockquote class="text">  <blockquote class="text">
3265  <p>C: "GET CHANNELS"  <p>C: "GET CHANNELS"
3266  </p>  </p>
3267  <p>S: "12"  <p>S: "12"
3268  </p>  </p>
3269  </blockquote>  </blockquote><p>
3270    
3271  <a name="rfc.section.5.4.4"></a><h4><a name="LIST CHANNELS">5.4.4</a>&nbsp;Getting all created sampler channel list</h4>  </p>
3272    <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>
3273    
3274  <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
3275                      current list of sampler channels, the front-end can send the                      current list of sampler channels, the front-end can send the
3276                      following command:                      following command:
3277  </p>  </p>
3278  <p></p>  <p>
3279                            </p>
3280  <blockquote class="text">  <blockquote class="text">
3281  <p>LIST CHANNELS  <p>LIST CHANNELS
3282  </p>  </p>
3283  </blockquote>  </blockquote><p>
3284    
3285    </p>
3286  <p>Possible Answers:  <p>Possible Answers:
3287  </p>  </p>
3288  <p></p>  <p>
3289                            </p>
3290  <blockquote class="text">  <blockquote class="text">
3291  <p>LinuxSampler will answer by returning a comma separated list  <p>LinuxSampler will answer by returning a comma separated list
3292                              with all sampler channels numerical IDs.                              with all sampler channels numerical IDs.
3293  </p>  </p>
3294  </blockquote>  </blockquote><p>
3295    
3296    </p>
3297  <p>Example:  <p>Example:
3298  </p>  </p>
3299  <p></p>  <p>
3300                            </p>
3301  <blockquote class="text">  <blockquote class="text">
3302  <p>C: "LIST CHANNELS"  <p>C: "LIST CHANNELS"
3303  </p>  </p>
3304  <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"
3305  </p>  </p>
3306  </blockquote>  </blockquote><p>
3307    
3308  <a name="rfc.section.5.4.5"></a><h4><a name="ADD CHANNEL">5.4.5</a>&nbsp;Adding a new sampler channel</h4>  </p>
3309    <a name="rfc.section.6.4.5"></a><h4><a name="ADD CHANNEL">6.4.5</a>&nbsp;Adding a new sampler channel</h4>
3310    
3311  <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
3312                      channel list by sending the following command:                      channel list by sending the following command:
3313  </p>  </p>
3314  <p></p>  <p>
3315                            </p>
3316  <blockquote class="text">  <blockquote class="text">
3317  <p>ADD CHANNEL  <p>ADD CHANNEL
3318  </p>  </p>
3319  </blockquote>  </blockquote><p>
3320    
3321    </p>
3322  <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
3323                      sampler channel will be appended to the end of the sampler channel                      sampler channel will be appended to the end of the sampler channel
3324                      list. The front-end should send the respective, related commands                      list. The front-end should send the respective, related commands
# Line 2896  Intellectual Property and Copyright Stat Line 3331  Intellectual Property and Copyright Stat
3331  </p>  </p>
3332  <p>Possible Answers:  <p>Possible Answers:
3333  </p>  </p>
3334  <p></p>  <p>
3335                            </p>
3336  <blockquote class="text">  <blockquote class="text">
3337  <p>"OK[&lt;sampler-channel&gt;]" -  <p>"OK[&lt;sampler-channel&gt;]" -
3338                                  </p>                                  </p>
3339  <blockquote class="text">  <blockquote class="text">
3340  <p>in case a new sampler channel could be added, where  <p>in case a new sampler channel could be added, where
3341                                      &lt;sampler-channel&gt; reflects the channel number of the new                                      &lt;sampler-channel&gt; reflects the channel number of the new
3342                                      created sampler channel which should the be used to set up                                      created sampler channel which should be used to set up
3343                                      the sampler channel by sending subsequent intialization                                      the sampler channel by sending subsequent initialization
3344                                      commands                                      commands
3345  </p>  </p>
3346  </blockquote>  </blockquote><p>
3347    
3348    </p>
3349  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3350                                  </p>                                  </p>
3351  <blockquote class="text">  <blockquote class="text">
# Line 2916  Intellectual Property and Copyright Stat Line 3353  Intellectual Property and Copyright Stat
3353                                      noteworthy issue(s) related, providing an appropriate                                      noteworthy issue(s) related, providing an appropriate
3354                                      warning code and warning message                                      warning code and warning message
3355  </p>  </p>
3356  </blockquote>  </blockquote><p>
3357    
3358    </p>
3359  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3360                                  </p>                                  </p>
3361  <blockquote class="text">  <blockquote class="text">
3362  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
3363                                      error message                                      error message
3364  </p>  </p>
3365  </blockquote>  </blockquote><p>
3366    
3367  </blockquote>  </p>
3368    </blockquote><p>
3369    
3370    </p>
3371  <p>Example:  <p>Example:
3372  </p>  </p>
3373  <p></p>  <p>
3374                            </p>
3375  <blockquote class="text">  <blockquote class="text">
3376  <p>  <p>
3377  </p>  </p>
3378  </blockquote>  </blockquote><p>
3379    
3380  <a name="rfc.section.5.4.6"></a><h4><a name="REMOVE CHANNEL">5.4.6</a>&nbsp;Removing a sampler channel</h4>  </p>
3381    <a name="rfc.section.6.4.6"></a><h4><a name="REMOVE CHANNEL">6.4.6</a>&nbsp;Removing a sampler channel</h4>
3382    
3383  <p>A sampler channel can be removed by sending the following command:  <p>A sampler channel can be removed by sending the following command:
3384  </p>  </p>
3385  <p></p>  <p>
3386                            </p>
3387  <blockquote class="text">  <blockquote class="text">
3388  <p>REMOVE CHANNEL &lt;sampler-channel&gt;  <p>REMOVE CHANNEL &lt;sampler-channel&gt;
3389  </p>  </p>
3390  </blockquote>  </blockquote><p>
3391    
3392  <p>This will decrement the sampler channel count by one and also  </p>
3393                      decrement the channel numbers of all subsequent sampler channels by  <p>Where &lt;sampler-channel&gt; should be replaced by the
3394                      one.                      number of the sampler channel as given by the
3395                        <a class="info" href="#ADD CHANNEL">"ADD CHANNEL"<span> (</span><span class="info">Adding a new sampler channel</span><span>)</span></a>
3396                        or <a class="info" href="#LIST CHANNELS">"LIST CHANNELS"<span> (</span><span class="info">Getting all created sampler channel list</span><span>)</span></a>
3397                        command. The channel numbers of all subsequent sampler channels
3398                        remain the same.
3399  </p>  </p>
3400  <p>Possible Answers:  <p>Possible Answers:
3401  </p>  </p>
3402  <p></p>  <p>
3403                            </p>
3404  <blockquote class="text">  <blockquote class="text">
3405  <p>"OK" -  <p>"OK" -
3406                                  </p>                                  </p>
3407  <blockquote class="text">  <blockquote class="text">
3408  <p>in case the given sampler channel could be removed  <p>in case the given sampler channel could be removed
3409  </p>  </p>
3410  </blockquote>  </blockquote><p>
3411    
3412    </p>
3413  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3414                                  </p>                                  </p>
3415  <blockquote class="text">  <blockquote class="text">
# Line 2968  Intellectual Property and Copyright Stat Line 3417  Intellectual Property and Copyright Stat
3417                                      noteworthy issue(s) related, providing an appropriate                                      noteworthy issue(s) related, providing an appropriate
3418                                      warning code and warning message                                      warning code and warning message
3419  </p>  </p>
3420  </blockquote>  </blockquote><p>
3421    
3422    </p>
3423  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3424                                  </p>                                  </p>
3425  <blockquote class="text">  <blockquote class="text">
3426  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
3427                                      error message                                      error message
3428  </p>  </p>
3429  </blockquote>  </blockquote><p>
3430    
3431  </blockquote>  </p>
3432    </blockquote><p>
3433    
3434    </p>
3435  <p>Example:  <p>Example:
3436  </p>  </p>
3437  <p></p>  <p>
3438                            </p>
3439  <blockquote class="text">  <blockquote class="text">
3440  <p>  <p>
3441  </p>  </p>
3442  </blockquote>  </blockquote><p>
3443    
3444  <a name="rfc.section.5.4.7"></a><h4><a name="GET AVAILABLE_ENGINES">5.4.7</a>&nbsp;Getting amount of available engines</h4>  </p>
3445    <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>
3446    
3447  <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:
3448  </p>  </p>
3449  <p></p>  <p>
3450                            </p>
3451  <blockquote class="text">  <blockquote class="text">
3452  <p>GET AVAILABLE_ENGINES  <p>GET AVAILABLE_ENGINES
3453  </p>  </p>
3454  </blockquote>  </blockquote><p>
3455    
3456    </p>
3457  <p>Possible Answers:  <p>Possible Answers:
3458  </p>  </p>
3459  <p></p>  <p>
3460                            </p>
3461  <blockquote class="text">  <blockquote class="text">
3462  <p>LinuxSampler will answer by sending the number of available engines.  <p>LinuxSampler will answer by sending the number of available engines.
3463  </p>  </p>
3464  </blockquote>  </blockquote><p>
3465    
3466    </p>
3467  <p>Example:  <p>Example:
3468  </p>  </p>
3469  <p></p>  <p>
3470                            </p>
3471  <blockquote class="text">  <blockquote class="text">
3472  <p>C: "GET AVAILABLE_ENGINES"  <p>C: "GET AVAILABLE_ENGINES"
3473  </p>  </p>
3474  <p>S: "4"  <p>S: "4"
3475  </p>  </p>
3476  </blockquote>  </blockquote><p>
3477    
3478  <a name="rfc.section.5.4.8"></a><h4><a name="LIST AVAILABLE_ENGINES">5.4.8</a>&nbsp;Getting all available engines</h4>  </p>
3479    <a name="rfc.section.6.4.8"></a><h4><a name="LIST AVAILABLE_ENGINES">6.4.8</a>&nbsp;Getting all available engines</h4>
3480    
3481  <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:
3482  </p>  </p>
3483  <p></p>  <p>
3484                            </p>
3485  <blockquote class="text">  <blockquote class="text">
3486  <p>LIST AVAILABLE_ENGINES  <p>LIST AVAILABLE_ENGINES
3487  </p>  </p>
3488  </blockquote>  </blockquote><p>
3489    
3490    </p>
3491  <p>Possible Answers:  <p>Possible Answers:
3492  </p>  </p>
3493  <p></p>  <p>
3494                            </p>
3495  <blockquote class="text">  <blockquote class="text">
3496  <p>LinuxSampler will answer by sending a comma separated character  <p>LinuxSampler will answer by sending a comma separated list
3497                              string of the engines' names. Engine names can consist of lower and                              of the engines' names encapsulated into apostrophes (').
3498                              upper cases, digits and underlines ("_" character).                              Engine names can consist of lower and upper cases,
3499                                digits and underlines ("_" character).
3500  </p>  </p>
3501  </blockquote>  </blockquote><p>
3502    
3503    </p>
3504  <p>Example:  <p>Example:
3505  </p>  </p>
3506  <p></p>  <p>
3507                            </p>
3508  <blockquote class="text">  <blockquote class="text">
3509  <p>C: "LIST AVAILABLE_ENGINES"  <p>C: "LIST AVAILABLE_ENGINES"
3510  </p>  </p>
3511  <p>S: "GigEngine,AkaiEngine,DLSEngine,JoesCustomEngine"  <p>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"
3512  </p>  </p>
3513  </blockquote>  </blockquote><p>
3514    
3515  <a name="rfc.section.5.4.9"></a><h4><a name="GET ENGINE INFO">5.4.9</a>&nbsp;Getting information about an engine</h4>  </p>
3516    <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>
3517    
3518  <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
3519                      sending the following command:                      sending the following command:
3520  </p>  </p>
3521  <p></p>  <p>
3522                            </p>
3523  <blockquote class="text">  <blockquote class="text">
3524  <p>GET ENGINE INFO &lt;engine-name&gt;  <p>GET ENGINE INFO &lt;engine-name&gt;
3525  </p>  </p>
3526  </blockquote>  </blockquote><p>
3527    
3528    </p>
3529  <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
3530                      <a class="info" href="#LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"<span>Getting all available engines</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.
3531  </p>  </p>
3532  <p>Possible Answers:  <p>Possible Answers:
3533  </p>  </p>
3534  <p></p>  <p>
3535                            </p>
3536  <blockquote class="text">  <blockquote class="text">
3537  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
3538                              Each answer line begins with the information category name                              Each answer line begins with the information category name
# Line 3070  Intellectual Property and Copyright Stat Line 3540  Intellectual Property and Copyright Stat
3540                              the info character string to that info category. At the moment                              the info character string to that info category. At the moment
3541                              the following categories are defined:                              the following categories are defined:
3542  </p>  </p>
3543  <p></p>  <p>
3544                                    </p>
3545  <blockquote class="text">  <blockquote class="text">
3546  <p>DESCRIPTION -  <p>DESCRIPTION -
3547                                          </p>                                          </p>
3548  <blockquote class="text">  <blockquote class="text">
3549  <p>arbitrary description text about the engine  <p>arbitrary description text about the engine
3550  </p>  </p>
3551  </blockquote>  </blockquote><p>
3552    
3553    </p>
3554  <p>VERSION -  <p>VERSION -
3555                                          </p>                                          </p>
3556  <blockquote class="text">  <blockquote class="text">
3557  <p>arbitrary character string regarding the engine's version  <p>arbitrary character string regarding the engine's version
3558  </p>  </p>
3559  </blockquote>  </blockquote><p>
3560    
3561  </blockquote>  </p>
3562    </blockquote><p>
3563    
3564  </blockquote>  </p>
3565    </blockquote><p>
3566    
3567    </p>
3568  <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.
3569  </p>  </p>
3570  <p>Example:  <p>Example:
3571  </p>  </p>
3572  <p></p>  <p>
3573                            </p>
3574  <blockquote class="text">  <blockquote class="text">
3575  <p>C: "GET ENGINE INFO JoesCustomEngine"  <p>C: "GET ENGINE INFO JoesCustomEngine"
3576  </p>  </p>
# Line 3104  Intellectual Property and Copyright Stat Line 3580  Intellectual Property and Copyright Stat
3580  </p>  </p>
3581  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
3582  </p>  </p>
3583  </blockquote>  </blockquote><p>
3584    
3585  <a name="rfc.section.5.4.10"></a><h4><a name="GET CHANNEL INFO">5.4.10</a>&nbsp;Getting sampler channel information</h4>  </p>
3586    <a name="rfc.section.6.4.10"></a><h4><a name="GET CHANNEL INFO">6.4.10</a>&nbsp;Getting sampler channel information</h4>
3587    
3588  <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
3589                      by sending the following command:                      by sending the following command:
3590  </p>  </p>
3591  <p></p>  <p>
3592                            </p>
3593  <blockquote class="text">  <blockquote class="text">
3594  <p>GET CHANNEL INFO &lt;sampler-channel&gt;  <p>GET CHANNEL INFO &lt;sampler-channel&gt;
3595  </p>  </p>
3596  </blockquote>  </blockquote><p>
3597    
3598  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in.  </p>
3599    <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
3600                        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>
3601                        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.
3602  </p>  </p>
3603  <p>Possible Answers:  <p>Possible Answers:
3604  </p>  </p>
3605  <p></p>  <p>
3606                            </p>
3607  <blockquote class="text">  <blockquote class="text">
3608  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
3609                              Each answer line begins with the settings category name                              Each answer line begins with the settings category name
# Line 3129  Intellectual Property and Copyright Stat Line 3611  Intellectual Property and Copyright Stat
3611                              the info character string to that setting category. At the                              the info character string to that setting category. At the
3612                              moment the following categories are defined:                              moment the following categories are defined:
3613  </p>  </p>
3614  <p></p>  <p>
3615                                    </p>
3616  <blockquote class="text">  <blockquote class="text">
3617  <p>ENGINE_NAME -  <p>ENGINE_NAME -
3618                                          </p>                                          </p>
3619  <blockquote class="text">  <blockquote class="text">
3620  <p>name of the engine that is deployed on the sampler  <p>name of the engine that is associated with the sampler
3621                                              channel, "NONE" if there's no engine deployed yet for                                              channel, "NONE" if there's no engine associated yet for
3622                                              this sampler channel                                              this sampler channel
3623  </p>  </p>
3624  </blockquote>  </blockquote><p>
3625    
3626    </p>
3627  <p>AUDIO_OUTPUT_DEVICE -  <p>AUDIO_OUTPUT_DEVICE -
3628                                          </p>                                          </p>
3629  <blockquote class="text">  <blockquote class="text">
# Line 3148  Intellectual Property and Copyright Stat Line 3632  Intellectual Property and Copyright Stat
3632                                              the audio signal, "NONE" if there's no device                                              the audio signal, "NONE" if there's no device
3633                                              connected to this sampler channel                                              connected to this sampler channel
3634  </p>  </p>
3635  </blockquote>  </blockquote><p>
3636    
3637    </p>
3638  <p>AUDIO_OUTPUT_CHANNELS -  <p>AUDIO_OUTPUT_CHANNELS -
3639                                          </p>                                          </p>
3640  <blockquote class="text">  <blockquote class="text">
3641  <p>number of output channels the sampler channel offers  <p>number of output channels the sampler channel offers
3642                                              (dependent to used sampler engine and loaded instrument)                                              (dependent to used sampler engine and loaded instrument)
3643  </p>  </p>
3644  </blockquote>  </blockquote><p>
3645    
3646    </p>
3647  <p>AUDIO_OUTPUT_ROUTING -  <p>AUDIO_OUTPUT_ROUTING -
3648                                          </p>                                          </p>
3649  <blockquote class="text">  <blockquote class="text">
# Line 3169  Intellectual Property and Copyright Stat Line 3655  Intellectual Property and Copyright Stat
3655                                              channel 1 is routed to the channel 3 of the audio                                              channel 1 is routed to the channel 3 of the audio
3656                                              output device                                              output device
3657  </p>  </p>
3658  </blockquote>  </blockquote><p>
3659    
3660    </p>
3661  <p>INSTRUMENT_FILE -  <p>INSTRUMENT_FILE -
3662                                          </p>                                          </p>
3663  <blockquote class="text">  <blockquote class="text">
# Line 3178  Intellectual Property and Copyright Stat Line 3665  Intellectual Property and Copyright Stat
3665                                              there's no instrument yet loaded for this sampler                                              there's no instrument yet loaded for this sampler
3666                                              channel                                              channel
3667  </p>  </p>
3668  </blockquote>  </blockquote><p>
3669    
3670    </p>
3671  <p>INSTRUMENT_NR -  <p>INSTRUMENT_NR -
3672                                          </p>                                          </p>
3673  <blockquote class="text">  <blockquote class="text">
3674  <p>the instrument index number of the loaded instrument  <p>the instrument index number of the loaded instrument
3675  </p>  </p>
3676  </blockquote>  </blockquote><p>
3677    
3678    </p>
3679  <p>INSTRUMENT_NAME -  <p>INSTRUMENT_NAME -
3680                                          </p>                                          </p>
3681  <blockquote class="text">  <blockquote class="text">
3682  <p>the instrument name of the loaded instrument  <p>the instrument name of the loaded instrument
3683  </p>  </p>
3684  </blockquote>  </blockquote><p>
3685    
3686    </p>
3687  <p>INSTRUMENT_STATUS -  <p>INSTRUMENT_STATUS -
3688                                          </p>                                          </p>
3689  <blockquote class="text">  <blockquote class="text">
# Line 3201  Intellectual Property and Copyright Stat Line 3691  Intellectual Property and Copyright Stat
3691                                              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
3692                                              loaded.                                              loaded.
3693  </p>  </p>
3694  </blockquote>  </blockquote><p>
3695    
3696    </p>
3697  <p>MIDI_INPUT_DEVICE -  <p>MIDI_INPUT_DEVICE -
3698                                          </p>                                          </p>
3699  <blockquote class="text">  <blockquote class="text">
# Line 3211  Intellectual Property and Copyright Stat Line 3702  Intellectual Property and Copyright Stat
3702                                              MIDI input commands, "NONE" if there's no device                                              MIDI input commands, "NONE" if there's no device
3703                                              connected to this sampler channel                                              connected to this sampler channel
3704  </p>  </p>
3705  </blockquote>  </blockquote><p>
3706    
3707    </p>
3708  <p>MIDI_INPUT_PORT -  <p>MIDI_INPUT_PORT -
3709                                          </p>                                          </p>
3710  <blockquote class="text">  <blockquote class="text">
3711  <p>port number of the MIDI input device  <p>port number of the MIDI input device
3712  </p>  </p>
3713  </blockquote>  </blockquote><p>
3714    
3715    </p>
3716  <p>MIDI_INPUT_CHANNEL -  <p>MIDI_INPUT_CHANNEL -
3717                                          </p>                                          </p>
3718  <blockquote class="text">  <blockquote class="text">
3719  <p>the MIDI input channel number this sampler channel  <p>the MIDI input channel number this sampler channel
3720                                              should listen to or "ALL" to listen on all MIDI channels                                              should listen to or "ALL" to listen on all MIDI channels
3721  </p>  </p>
3722  </blockquote>  </blockquote><p>
3723    
3724    </p>
3725  <p>VOLUME -  <p>VOLUME -
3726                                          </p>                                          </p>
3727  <blockquote class="text">  <blockquote class="text">
# Line 3235  Intellectual Property and Copyright Stat Line 3729  Intellectual Property and Copyright Stat
3729                                              (where a value < 1.0 means attenuation and a value >                                              (where a value < 1.0 means attenuation and a value >
3730                                              1.0 means amplification)                                              1.0 means amplification)
3731  </p>  </p>
3732  </blockquote>  </blockquote><p>
3733    
3734  </blockquote>  </p>
3735    <p>MUTE -
3736                                            </p>
3737    <blockquote class="text">
3738    <p>Determines whether the channel is muted, "true" if the
3739                                                channel is muted, "false" if the channel is not muted, and
3740                                                "MUTED_BY_SOLO" if the channel is muted because of the
3741                                                presence of a solo channel and will be unmuted when
3742                                                there are no solo channels left
3743    </p>
3744    </blockquote><p>
3745    
3746  </blockquote>  </p>
3747    <p>SOLO -
3748                                            </p>
3749    <blockquote class="text">
3750    <p>Determines whether this is a solo channel, "true" if
3751                                                the channel is a solo channel; "false" otherwise
3752    </p>
3753    </blockquote><p>
3754    
3755    </p>
3756    </blockquote><p>
3757    
3758    </p>
3759    </blockquote><p>
3760    
3761    </p>
3762  <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.
3763  </p>  </p>
3764  <p>Example:  <p>Example:
3765  </p>  </p>
3766  <p></p>  <p>
3767                            </p>
3768  <blockquote class="text">  <blockquote class="text">
3769  <p>C: "GET CHANNEL INFO 34"  <p>C: "GET CHANNEL INFO 34"
3770  </p>  </p>
# Line 3275  Intellectual Property and Copyright Stat Line 3794  Intellectual Property and Copyright Stat
3794  </p>  </p>
3795  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
3796  </p>  </p>
3797  </blockquote>  </blockquote><p>
3798    
3799  <a name="rfc.section.5.4.11"></a><h4><a name="GET CHANNEL VOICE_COUNT">5.4.11</a>&nbsp;Current number of active voices</h4>  </p>
3800    <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>
3801    
3802  <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
3803                      sampler channel by sending the following command:                      sampler channel by sending the following command:
3804  </p>  </p>
3805  <p></p>  <p>
3806                            </p>
3807  <blockquote class="text">  <blockquote class="text">
3808  <p>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;  <p>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;
3809  </p>  </p>
3810  </blockquote>  </blockquote><p>
3811    
3812  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in.  </p>
3813    <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
3814                        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>
3815                        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.
3816  </p>  </p>
3817  <p>Possible Answers:  <p>Possible Answers:
3818  </p>  </p>
3819  <p></p>  <p>
3820                            </p>
3821  <blockquote class="text">  <blockquote class="text">
3822  <p>LinuxSampler will answer by returning the number of active  <p>LinuxSampler will answer by returning the number of active
3823                              voices on that channel.                              voices on that channel.
3824  </p>  </p>
3825  </blockquote>  </blockquote><p>
3826    
3827    </p>
3828  <p>Example:  <p>Example:
3829  </p>  </p>
3830  <p></p>  <p>
3831                            </p>
3832  <blockquote class="text">  <blockquote class="text">
3833  <p>  <p>
3834  </p>  </p>
3835  </blockquote>  </blockquote><p>
3836    
3837  <a name="rfc.section.5.4.12"></a><h4><a name="GET CHANNEL STREAM_COUNT">5.4.12</a>&nbsp;Current number of active disk streams</h4>  </p>
3838    <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>
3839    
3840  <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
3841                      on a sampler channel by sending the following command:                      on a sampler channel by sending the following command:
3842  </p>  </p>
3843  <p></p>  <p>
3844                            </p>
3845  <blockquote class="text">  <blockquote class="text">
3846  <p>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;  <p>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;
3847  </p>  </p>
3848  </blockquote>  </blockquote><p>
3849    
3850  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in.  </p>
3851    <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
3852                        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>
3853                        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.
3854  </p>  </p>
3855  <p>Possible Answers:  <p>Possible Answers:
3856  </p>  </p>
3857  <p></p>  <p>
3858                            </p>
3859  <blockquote class="text">  <blockquote class="text">
3860  <p>LinuxSampler will answer by returning the number of active  <p>LinuxSampler will answer by returning the number of active
3861                              disk streams on that channel in case the engine supports disk                              disk streams on that channel in case the engine supports disk
3862                              streaming, if the engine doesn't support disk streaming it will                              streaming, if the engine doesn't support disk streaming it will
3863                              return "NA" for not available.                              return "NA" for not available.
3864  </p>  </p>
3865  </blockquote>  </blockquote><p>
3866    
3867    </p>
3868  <p>Example:  <p>Example:
3869  </p>  </p>
3870  <p></p>  <p>
3871                            </p>
3872  <blockquote class="text">  <blockquote class="text">
3873  <p>  <p>
3874  </p>  </p>
3875  </blockquote>  </blockquote><p>
3876    
3877  <a name="rfc.section.5.4.13"></a><h4><a name="GET CHANNEL BUFFER_FILL">5.4.13</a>&nbsp;Current fill state of disk stream buffers</h4>  </p>
3878    <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>
3879    
3880  <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
3881                      on a sampler channel by sending the following command:                      on a sampler channel by sending the following command:
3882  </p>  </p>
3883  <p></p>  <p>
3884                            </p>
3885  <blockquote class="text">  <blockquote class="text">
3886  <p>GET CHANNEL BUFFER_FILL BYTES &lt;sampler-channel&gt;  <p>GET CHANNEL BUFFER_FILL BYTES &lt;sampler-channel&gt;
3887  </p>  </p>
3888  </blockquote>  </blockquote><p>
3889    
3890    </p>
3891  <p>to get the fill state in bytes or  <p>to get the fill state in bytes or
3892  </p>  </p>
3893  <p></p>  <p>
3894                            </p>
3895  <blockquote class="text">  <blockquote class="text">
3896  <p>GET CHANNEL BUFFER_FILL PERCENTAGE &lt;sampler-channel&gt;  <p>GET CHANNEL BUFFER_FILL PERCENTAGE &lt;sampler-channel&gt;
3897  </p>  </p>
3898  </blockquote>  </blockquote><p>
3899    
3900    </p>
3901  <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
3902                      sampler channel number the front-end is interested in.                      sampler channel number the front-end is interested in
3903                        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>
3904                        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.
3905  </p>  </p>
3906  <p>Possible Answers:  <p>Possible Answers:
3907  </p>  </p>
3908  <p></p>  <p>
3909                            </p>
3910  <blockquote class="text">  <blockquote class="text">
3911  <p>LinuxSampler will either answer by returning a comma separated  <p>LinuxSampler will either answer by returning a comma separated
3912                              string with the fill state of all disk stream buffers on that                              string with the fill state of all disk stream buffers on that
# Line 3376  Intellectual Property and Copyright Stat Line 3919  Intellectual Property and Copyright Stat
3919                              the response are not in particular order, thus the front-end has                              the response are not in particular order, thus the front-end has
3920                              to sort them by itself if necessary.                              to sort them by itself if necessary.
3921  </p>  </p>
3922  </blockquote>  </blockquote><p>
3923    
3924    </p>
3925  <p>Examples:  <p>Examples:
3926  </p>  </p>
3927  <p></p>  <p>
3928                            </p>
3929  <blockquote class="text">  <blockquote class="text">
3930  <p>C: "GET CHANNEL BUFFER_FILL BYTES 4"  <p>C: "GET CHANNEL BUFFER_FILL BYTES 4"
3931  </p>  </p>
3932  <p>S: "[115]420500,[116]510300,[75]110000,[120]230700"  <p>S: "[115]420500,[116]510300,[75]110000,[120]230700"
3933  </p>  </p>
3934  </blockquote>  </blockquote><p>
3935    
3936                            </p>
3937  <blockquote class="text">  <blockquote class="text">
3938  <p><p>C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"  <p>C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
3939  </p>  </p>
3940  <p>S: "[115]90%,[116]98%,[75]40%,[120]62%"  <p>S: "[115]90%,[116]98%,[75]40%,[120]62%"
3941  </p>  </p>
3942  </blockquote>  </blockquote><p>
3943    
3944                            </p>
3945  <blockquote class="text">  <blockquote class="text">
3946  <p><p>C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"  <p>C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
3947  </p>  </p>
3948  <p>S: ""  <p>S: ""
3949  </p>  </p>
3950  </blockquote>  </blockquote><p>
3951    
3952  <a name="rfc.section.5.4.14"></a><h4><a name="SET CHANNEL AUDIO_OUTPUT_DEVICE">5.4.14</a>&nbsp;Setting audio output device</h4>  </p>
3953    <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>
3954    
3955  <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
3956                      channel by sending the following command:                      channel by sending the following command:
3957  </p>  </p>
3958  <p></p>  <p>
3959                            </p>
3960  <blockquote class="text">  <blockquote class="text">
3961  <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;
3962  </p>  </p>
3963  </blockquote>  </blockquote><p>
3964    
3965  <p>Where &lt;audio-device-id&gt; is the numerical ID of the audio output  </p>
3966                      device and &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
3967                      number.                      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>
3968                        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
3969                        &lt;audio-device-id&gt; is the numerical ID of the audio output device as given by the
3970                        <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>
3971                        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>
3972                        command.
3973  </p>  </p>
3974  <p>Possible Answers:  <p>Possible Answers:
3975  </p>  </p>
3976  <p></p>  <p>
3977                            </p>
3978  <blockquote class="text">  <blockquote class="text">
3979  <p>"OK" -  <p>"OK" -
3980                                  </p>                                  </p>
3981  <blockquote class="text">  <blockquote class="text">
3982  <p>on success  <p>on success
3983  </p>  </p>
3984  </blockquote>  </blockquote><p>
3985    
3986    </p>
3987  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3988                                  </p>                                  </p>
3989  <blockquote class="text">  <blockquote class="text">
# Line 3433  Intellectual Property and Copyright Stat Line 3991  Intellectual Property and Copyright Stat
3991                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
3992                                      warning message                                      warning message
3993  </p>  </p>
3994  </blockquote>  </blockquote><p>
3995    
3996    </p>
3997  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3998                                  </p>                                  </p>
3999  <blockquote class="text">  <blockquote class="text">
4000  <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
4001  </p>  </p>
4002  </blockquote>  </blockquote><p>
4003    
4004  </blockquote>  </p>
4005    </blockquote><p>
4006    
4007    </p>
4008  <p>Examples:  <p>Examples:
4009  </p>  </p>
4010  <p></p>  <p>
4011                            </p>
4012  <blockquote class="text">  <blockquote class="text">
4013  <p>  <p>
4014  </p>  </p>
4015  </blockquote>  </blockquote><p>
4016    
4017  <a name="rfc.section.5.4.15"></a><h4><a name="SET CHANNEL AUDIO_OUTPUT_TYP">5.4.15</a>&nbsp;Setting audio output type</h4>  </p>
4018    <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>
4019    
4020  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
4021  </p>  </p>
4022  <p>The front-end can alter the audio output type on a specific sampler  <p>The front-end can alter the audio output type on a specific sampler
4023                      channel by sending the following command:                      channel by sending the following command:
4024  </p>  </p>
4025  <p></p>  <p>
4026                            </p>
4027  <blockquote class="text">  <blockquote class="text">
4028  <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;
4029  </p>  </p>
4030  </blockquote>  </blockquote><p>
4031    
4032    </p>
4033  <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
4034                      &lt;sampler-channel&gt; is the respective sampler channel number.                      &lt;sampler-channel&gt; is the respective sampler channel number.
4035  </p>  </p>
4036  <p>Possible Answers:  <p>Possible Answers:
4037  </p>  </p>
4038  <p></p>  <p>
4039                            </p>
4040  <blockquote class="text">  <blockquote class="text">
4041  <p>"OK" -  <p>"OK" -
4042                                  </p>                                  </p>
4043  <blockquote class="text">  <blockquote class="text">
4044  <p>on success  <p>on success
4045  </p>  </p>
4046  </blockquote>  </blockquote><p>
4047    
4048    </p>
4049  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4050                                  </p>                                  </p>
4051  <blockquote class="text">  <blockquote class="text">
# Line 3486  Intellectual Property and Copyright Stat Line 4053  Intellectual Property and Copyright Stat
4053                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4054                                      warning message                                      warning message
4055  </p>  </p>
4056  </blockquote>  </blockquote><p>
4057    
4058    </p>
4059  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4060                                  </p>                                  </p>
4061  <blockquote class="text">  <blockquote class="text">
4062  <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
4063  </p>  </p>
4064  </blockquote>  </blockquote><p>
4065    
4066  </blockquote>  </p>
4067    </blockquote><p>
4068    
4069    </p>
4070  <p>Examples:  <p>Examples:
4071  </p>  </p>
4072  <p></p>  <p>
4073                            </p>
4074  <blockquote class="text">  <blockquote class="text">
4075  <p>  <p>
4076  </p>  </p>
4077  </blockquote>  </blockquote><p>
4078    
4079  <a name="rfc.section.5.4.16"></a><h4><a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL">5.4.16</a>&nbsp;Setting audio output channel</h4>  </p>
4080    <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>
4081    
4082  <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
4083                      sampler channel by sending the following command:                      sampler channel by sending the following command:
4084  </p>  </p>
4085  <p></p>  <p>
4086                            </p>
4087  <blockquote class="text">  <blockquote class="text">
4088  <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;
4089  </p>  </p>
4090  </blockquote>  </blockquote><p>
4091    
4092  <p>Where &lt;sampler-chan&gt; is the sampler channel number, &lt;audio-out&gt; is the  </p>
4093    <p>Where &lt;sampler-chan&gt; is the sampler channel number
4094                        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>
4095                        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
4096                      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
4097                      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
4098                      output device where &lt;audio-out&gt; should be routed to.                      output device where &lt;audio-out&gt; should be routed to.
4099  </p>  </p>
4100  <p>Possible Answers:  <p>Possible Answers:
4101  </p>  </p>
4102  <p></p>  <p>
4103                            </p>
4104  <blockquote class="text">  <blockquote class="text">
4105  <p>"OK" -  <p>"OK" -
4106                                  </p>                                  </p>
4107  <blockquote class="text">  <blockquote class="text">
4108  <p>on success  <p>on success
4109  </p>  </p>
4110  </blockquote>  </blockquote><p>
4111    
4112    </p>
4113  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4114                                  </p>                                  </p>
4115  <blockquote class="text">  <blockquote class="text">
# Line 3539  Intellectual Property and Copyright Stat Line 4117  Intellectual Property and Copyright Stat
4117                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4118                                      warning message                                      warning message
4119  </p>  </p>
4120  </blockquote>  </blockquote><p>
4121    
4122    </p>
4123  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4124                                  </p>                                  </p>
4125  <blockquote class="text">  <blockquote class="text">
4126  <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
4127  </p>  </p>
4128  </blockquote>  </blockquote><p>
4129    
4130  </blockquote>  </p>
4131    </blockquote><p>
4132    
4133    </p>
4134  <p>Examples:  <p>Examples:
4135  </p>  </p>
4136  <p></p>  <p>
4137                            </p>
4138  <blockquote class="text">  <blockquote class="text">
4139  <p>  <p>
4140  </p>  </p>
4141  </blockquote>  </blockquote><p>
4142    
4143  <a name="rfc.section.5.4.17"></a><h4><a name="SET CHANNEL MIDI_INPUT_DEVICE">5.4.17</a>&nbsp;Setting MIDI input device</h4>  </p>
4144    <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>
4145    
4146  <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
4147                      channel by sending the following command:                      channel by sending the following command:
4148  </p>  </p>
4149  <p></p>  <p>
4150                            </p>
4151  <blockquote class="text">  <blockquote class="text">
4152  <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;
4153  </p>  </p>
4154  </blockquote>  </blockquote><p>
4155    
4156  <p>Where &lt;sampler-channel&gt; is the sampler channel number and &lt;midi-device-id&gt; is the  </p>
4157                      the numerical ID of the MIDI input device.  <p>Where &lt;sampler-channel&gt; is the sampler channel number
4158                        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>
4159                        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
4160                        and &lt;midi-device-id&gt; is  the numerical ID of the MIDI input device as returned by the
4161                        <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>
4162                        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.
4163  </p>  </p>
4164  <p>Possible Answers:  <p>Possible Answers:
4165  </p>  </p>
4166  <p></p>  <p>
4167                            </p>
4168  <blockquote class="text">  <blockquote class="text">
4169  <p>"OK" -  <p>"OK" -
4170                                  </p>                                  </p>
4171  <blockquote class="text">  <blockquote class="text">
4172  <p>on success  <p>on success
4173  </p>  </p>
4174  </blockquote>  </blockquote><p>
4175    
4176    </p>
4177  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4178                                  </p>                                  </p>
4179  <blockquote class="text">  <blockquote class="text">
# Line 3590  Intellectual Property and Copyright Stat Line 4181  Intellectual Property and Copyright Stat
4181                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4182                                      warning message                                      warning message
4183  </p>  </p>
4184  </blockquote>  </blockquote><p>
4185    
4186    </p>
4187  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4188                                  </p>                                  </p>
4189  <blockquote class="text">  <blockquote class="text">
4190  <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
4191  </p>  </p>
4192  </blockquote>  </blockquote><p>
4193    
4194  </blockquote>  </p>
4195    </blockquote><p>
4196    
4197    </p>
4198  <p>Examples:  <p>Examples:
4199  </p>  </p>
4200  <p></p>  <p>
4201                            </p>
4202  <blockquote class="text">  <blockquote class="text">
4203  <p>  <p>
4204  </p>  </p>
4205  </blockquote>  </blockquote><p>
4206    
4207  <a name="rfc.section.5.4.18"></a><h4><a name="SET CHANNEL MIDI_INPUT_TYPE">5.4.18</a>&nbsp;Setting MIDI input type</h4>  </p>
4208    <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>
4209    
4210  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
4211  </p>  </p>
4212  <p>The front-end can alter the MIDI input type on a specific sampler  <p>The front-end can alter the MIDI input type on a specific sampler
4213                      channel by sending the following command:                      channel by sending the following command:
4214  </p>  </p>
4215  <p></p>  <p>
4216                            </p>
4217  <blockquote class="text">  <blockquote class="text">
4218  <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;
4219  </p>  </p>
4220  </blockquote>  </blockquote><p>
4221    
4222    </p>
4223  <p>Where &lt;midi-input-type&gt; is currently only "ALSA" and  <p>Where &lt;midi-input-type&gt; is currently only "ALSA" and
4224                      &lt;sampler-channel&gt; is the respective sampler channel number.                      &lt;sampler-channel&gt; is the respective sampler channel number.
4225  </p>  </p>
4226  <p>Possible Answers:  <p>Possible Answers:
4227  </p>  </p>
4228  <p></p>  <p>
4229                            </p>
4230  <blockquote class="text">  <blockquote class="text">
4231  <p>"OK" -  <p>"OK" -
4232                                  </p>                                  </p>
4233  <blockquote class="text">  <blockquote class="text">
4234  <p>on success  <p>on success
4235  </p>  </p>
4236  </blockquote>  </blockquote><p>
4237    
4238    </p>
4239  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4240                                  </p>                                  </p>
4241  <blockquote class="text">  <blockquote class="text">
# Line 3643  Intellectual Property and Copyright Stat Line 4243  Intellectual Property and Copyright Stat
4243                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4244                                      warning message                                      warning message
4245  </p>  </p>
4246  </blockquote>  </blockquote><p>
4247    
4248    </p>
4249  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4250                                  </p>                                  </p>
4251  <blockquote class="text">  <blockquote class="text">
4252  <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
4253  </p>  </p>
4254  </blockquote>  </blockquote><p>
4255    
4256  </blockquote>  </p>
4257    </blockquote><p>
4258    
4259    </p>
4260  <p>Examples:  <p>Examples:
4261  </p>  </p>
4262  <p></p>  <p>
4263                            </p>
4264  <blockquote class="text">  <blockquote class="text">
4265  <p>  <p>
4266  </p>  </p>
4267  </blockquote>  </blockquote><p>
4268    
4269  <a name="rfc.section.5.4.19"></a><h4><a name="SET CHANNEL MIDI_INPUT_PORT">5.4.19</a>&nbsp;Setting MIDI input port</h4>  </p>
4270    <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>
4271    
4272  <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
4273                      channel by sending the following command:                      channel by sending the following command:
4274  </p>  </p>
4275  <p></p>  <p>
4276                            </p>
4277  <blockquote class="text">  <blockquote class="text">
4278  <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;
4279  </p>  </p>
4280  </blockquote>  </blockquote><p>
4281    
4282    </p>
4283  <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
4284                      MIDI input device connected to the sampler channel given by                      MIDI input device connected to the sampler channel given by
4285                      &lt;sampler-channel&gt;.                      &lt;sampler-channel&gt;.
4286  </p>  </p>
4287  <p>Possible Answers:  <p>Possible Answers:
4288  </p>  </p>
4289  <p></p>  <p>
4290                            </p>
4291  <blockquote class="text">  <blockquote class="text">
4292  <p>"OK" -  <p>"OK" -
4293                                  </p>                                  </p>
4294  <blockquote class="text">  <blockquote class="text">
4295  <p>on success  <p>on success
4296  </p>  </p>
4297  </blockquote>  </blockquote><p>
4298    
4299    </p>
4300  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4301                                  </p>                                  </p>
4302  <blockquote class="text">  <blockquote class="text">
# Line 3695  Intellectual Property and Copyright Stat Line 4304  Intellectual Property and Copyright Stat
4304                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4305                                      warning message                                      warning message
4306  </p>  </p>
4307  </blockquote>  </blockquote><p>
4308    
4309    </p>
4310  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4311                                  </p>                                  </p>
4312  <blockquote class="text">  <blockquote class="text">
4313  <p>in case it failed, providing an appropriate error code and error messag  <p>in case it failed, providing an appropriate error code and error message
4314  </p>  </p>
4315  </blockquote>  </blockquote><p>
4316    
4317  </blockquote>  </p>
4318    </blockquote><p>
4319    
4320    </p>
4321  <p>Examples:  <p>Examples:
4322  </p>  </p>
4323  <p></p>  <p>
4324                            </p>
4325  <blockquote class="text">  <blockquote class="text">
4326  <p>  <p>
4327  </p>  </p>
4328  </blockquote>  </blockquote><p>
4329    
4330  <a name="rfc.section.5.4.20"></a><h4><a name="SET CHANNEL MIDI_INPUT_CHANNEL">5.4.20</a>&nbsp;Setting MIDI input channel</h4>  </p>
4331    <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>
4332    
4333  <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
4334                      listen to by sending the following command:                      listen to by sending the following command:
4335  </p>  </p>
4336  <p></p>  <p>
4337                            </p>
4338  <blockquote class="text">  <blockquote class="text">
4339  <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;
4340  </p>  </p>
4341  </blockquote>  </blockquote><p>
4342    
4343    </p>
4344  <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
4345                      &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
4346                      channels.                      channels.
4347  </p>  </p>
4348  <p>Possible Answers:  <p>Possible Answers:
4349  </p>  </p>
4350  <p></p>  <p>
4351                            </p>
4352  <blockquote class="text">  <blockquote class="text">
4353  <p>"OK" -  <p>"OK" -
4354                                  </p>                                  </p>
4355  <blockquote class="text">  <blockquote class="text">
4356  <p>on success  <p>on success
4357  </p>  </p>
4358  </blockquote>  </blockquote><p>
4359    
4360    </p>
4361  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4362                                  </p>                                  </p>
4363  <blockquote class="text">  <blockquote class="text">
# Line 3747  Intellectual Property and Copyright Stat Line 4365  Intellectual Property and Copyright Stat
4365                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4366                                      warning message                                      warning message
4367  </p>  </p>
4368  </blockquote>  </blockquote><p>
4369    
4370    </p>
4371  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4372                                  </p>                                  </p>
4373  <blockquote class="text">  <blockquote class="text">
4374  <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
4375  </p>  </p>
4376  </blockquote>  </blockquote><p>
4377    
4378  </blockquote>  </p>
4379    </blockquote><p>
4380    
4381    </p>
4382  <p>Examples:  <p>Examples:
4383  </p>  </p>
4384  <p></p>  <p>
4385                            </p>
4386  <blockquote class="text">  <blockquote class="text">
4387  <p>  <p>
4388  </p>  </p>
4389  </blockquote>  </blockquote><p>
4390    
4391  <a name="rfc.section.5.4.21"></a><h4><a name="SET CHANNEL VOLUME">5.4.21</a>&nbsp;Setting channel volume</h4>  </p>
4392    <a name="rfc.section.6.4.21"></a><h4><a name="SET CHANNEL VOLUME">6.4.21</a>&nbsp;Setting channel volume</h4>
4393    
4394  <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
4395                      the following command:                      the following command:
4396  </p>  </p>
4397  <p></p>  <p>
4398                            </p>
4399  <blockquote class="text">  <blockquote class="text">
4400  <p>SET CHANNEL VOLUME &lt;sampler-channel&gt; &lt;volume&gt;  <p>SET CHANNEL VOLUME &lt;sampler-channel&gt; &lt;volume&gt;
4401  </p>  </p>
4402  </blockquote>  </blockquote><p>
4403    
4404    </p>
4405  <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
4406                      smaller than 1.0 means attenuation, whereas a value greater than                      smaller than 1.0 means attenuation, whereas a value greater than
4407                      1.0 means amplification) and &lt;sampler-channel&gt; defines the sampler                      1.0 means amplification) and &lt;sampler-channel&gt; defines the sampler
# Line 3784  Intellectual Property and Copyright Stat Line 4409  Intellectual Property and Copyright Stat
4409  </p>  </p>
4410  <p>Possible Answers:  <p>Possible Answers:
4411  </p>  </p>
4412  <p></p>  <p>
4413                            </p>
4414  <blockquote class="text">  <blockquote class="text">
4415  <p>"OK" -  <p>"OK" -
4416                                  </p>                                  </p>
4417  <blockquote class="text">  <blockquote class="text">
4418  <p>on success  <p>on success
4419  </p>  </p>
4420  </blockquote>  </blockquote><p>
4421    
4422    </p>
4423  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4424                                  </p>                                  </p>
4425  <blockquote class="text">  <blockquote class="text">
# Line 3800  Intellectual Property and Copyright Stat Line 4427  Intellectual Property and Copyright Stat
4427                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4428                                      warning message                                      warning message
4429  </p>  </p>
4430  </blockquote>  </blockquote><p>
4431    
4432    </p>
4433  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4434                                  </p>                                  </p>
4435  <blockquote class="text">  <blockquote class="text">
4436  <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
4437  </p>  </p>
4438  </blockquote>  </blockquote><p>
4439    
4440  </blockquote>  </p>
4441    </blockquote><p>
4442    
4443    </p>
4444  <p>Examples:  <p>Examples:
4445  </p>  </p>
4446  <p></p>  <p>
4447                            </p>
4448  <blockquote class="text">  <blockquote class="text">
4449  <p>  <p>
4450  </p>  </p>
4451  </blockquote>  </blockquote><p>
4452    
4453  <a name="rfc.section.5.4.22"></a><h4><a name="RESET CHANNEL">5.4.22</a>&nbsp;Resetting a sampler channel</h4>  </p>
4454    <a name="rfc.section.6.4.22"></a><h4><a name="SET CHANNEL MUTE">6.4.22</a>&nbsp;Muting a sampler channel</h4>
4455    
4456    <p>The front-end can mute/unmute a specific sampler
4457                        channel by sending the following command:
4458    </p>
4459    <p>
4460                            </p>
4461    <blockquote class="text">
4462    <p>SET CHANNEL MUTE &lt;sampler-channel&gt; &lt;mute&gt;
4463    </p>
4464    </blockquote><p>
4465    
4466    </p>
4467    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4468                        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>
4469                        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
4470                        &lt;mute&gt; should be replaced either by "1" to mute the channel or "0"
4471                        to unmute the channel.
4472    </p>
4473    <p>Possible Answers:
4474    </p>
4475    <p>
4476                            </p>
4477    <blockquote class="text">
4478    <p>"OK" -
4479                                    </p>
4480    <blockquote class="text">
4481    <p>on success
4482    </p>
4483    </blockquote><p>
4484    
4485    </p>
4486    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4487                                    </p>
4488    <blockquote class="text">
4489    <p>if the channel was muted/unmuted, but there are noteworthy
4490                                        issue(s) related, providing an appropriate warning code and
4491                                        warning message
4492    </p>
4493    </blockquote><p>
4494    
4495    </p>
4496    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4497                                    </p>
4498    <blockquote class="text">
4499    <p>in case it failed, providing an appropriate error code and error message
4500    </p>
4501    </blockquote><p>
4502    
4503    </p>
4504    </blockquote><p>
4505    
4506    </p>
4507    <p>Examples:
4508    </p>
4509    <p>
4510                            </p>
4511    <blockquote class="text">
4512    <p>
4513    </p>
4514    </blockquote><p>
4515    
4516    </p>
4517    <a name="rfc.section.6.4.23"></a><h4><a name="SET CHANNEL SOLO">6.4.23</a>&nbsp;Soloing a sampler channel</h4>
4518    
4519    <p>The front-end can solo/unsolo a specific sampler channel
4520                        by sending the following command:
4521    </p>
4522    <p>
4523                            </p>
4524    <blockquote class="text">
4525    <p>SET CHANNEL SOLO &lt;sampler-channel&gt; &lt;solo&gt;
4526    </p>
4527    </blockquote><p>
4528    
4529    </p>
4530    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4531                        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>
4532                        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
4533                        &lt;solo&gt; should be replaced either by "1" to solo the channel or "0"
4534                        to unsolo the channel.
4535    </p>
4536    <p>Possible Answers:
4537    </p>
4538    <p>
4539                            </p>
4540    <blockquote class="text">
4541    <p>"OK" -
4542                                    </p>
4543    <blockquote class="text">
4544    <p>on success
4545    </p>
4546    </blockquote><p>
4547    
4548    </p>
4549    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4550                                    </p>
4551    <blockquote class="text">
4552    <p>if the channel was soloed/unsoloed, but there are noteworthy
4553                                        issue(s) related, providing an appropriate warning code and
4554                                        warning message
4555    </p>
4556    </blockquote><p>
4557    
4558    </p>
4559    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4560                                    </p>
4561    <blockquote class="text">
4562    <p>in case it failed, providing an appropriate error code and error message
4563    </p>
4564    </blockquote><p>
4565    
4566    </p>
4567    </blockquote><p>
4568    
4569    </p>
4570    <p>Examples:
4571    </p>
4572    <p>
4573                            </p>
4574    <blockquote class="text">
4575    <p>
4576    </p>
4577    </blockquote><p>
4578    
4579    </p>
4580    <a name="rfc.section.6.4.24"></a><h4><a name="RESET CHANNEL">6.4.24</a>&nbsp;Resetting a sampler channel</h4>
4581    
4582  <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:
4583  </p>  </p>
4584  <p></p>  <p>
4585                            </p>
4586  <blockquote class="text">  <blockquote class="text">
4587  <p>RESET CHANNEL &lt;sampler-channel&gt;  <p>RESET CHANNEL &lt;sampler-channel&gt;
4588  </p>  </p>
4589  </blockquote>  </blockquote><p>
4590    
4591    </p>
4592  <p>  <p>
4593                      Where &lt;sampler-channel&gt; defines the sampler channel to be reset.                      Where &lt;sampler-channel&gt; defines the sampler channel to be reset.
4594                      This will cause the engine on that sampler channel, its voices and                      This will cause the engine on that sampler channel, its voices and
# Line 3837  Intellectual Property and Copyright Stat Line 4597  Intellectual Property and Copyright Stat
4597  </p>  </p>
4598  <p>Possible Answers:  <p>Possible Answers:
4599  </p>  </p>
4600  <p></p>  <p>
4601                            </p>
4602  <blockquote class="text">  <blockquote class="text">
4603  <p>"OK" -  <p>"OK" -
4604                                  </p>                                  </p>
4605  <blockquote class="text">  <blockquote class="text">
4606  <p>on success  <p>on success
4607  </p>  </p>
4608  </blockquote>  </blockquote><p>
4609    
4610    </p>
4611  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4612                                  </p>                                  </p>
4613  <blockquote class="text">  <blockquote class="text">
# Line 3853  Intellectual Property and Copyright Stat Line 4615  Intellectual Property and Copyright Stat
4615                                      related, providing an appropriate warning code and warning                                      related, providing an appropriate warning code and warning
4616                                      message                                      message
4617  </p>  </p>
4618  </blockquote>  </blockquote><p>
4619    
4620    </p>
4621  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4622                                  </p>                                  </p>
4623  <blockquote class="text">  <blockquote class="text">
4624  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
4625                                      error message                                      error message
4626  </p>  </p>
4627  </blockquote>  </blockquote><p>
4628    
4629  </blockquote>  </p>
4630    </blockquote><p>
4631    
4632    </p>
4633  <p>Examples:  <p>Examples:
4634  </p>  </p>
4635  <p></p>  <p>
4636                            </p>
4637  <blockquote class="text">  <blockquote class="text">
4638  <p>  <p>
4639  </p>  </p>
4640  </blockquote>  </blockquote><p>
4641    
4642  <a name="rfc.section.5.5"></a><h4><a name="anchor13">5.5</a>&nbsp;Controlling connection</h4>  </p>
4643    <a name="rfc.section.6.5"></a><h4><a name="anchor12">6.5</a>&nbsp;Controlling connection</h4>
4644    
4645  <p>The following commands are used to control the connection to LinuxSampler.  <p>The following commands are used to control the connection to LinuxSampler.
4646  </p>  </p>
4647  <a name="rfc.section.5.5.1"></a><h4><a name="SUBSCRIBE">5.5.1</a>&nbsp;Register front-end for receiving event messages</h4>  <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>
4648    
4649  <p>The front-end can register itself to the LinuxSampler application to  <p>The front-end can register itself to the LinuxSampler application to
4650                      be informed about noteworthy events by sending this command:                      be informed about noteworthy events by sending this command:
4651  </p>  </p>
4652  <p></p>  <p>
4653                            </p>
4654  <blockquote class="text">  <blockquote class="text">
4655  <p>SUBSCRIBE &lt;event-id&gt;  <p>SUBSCRIBE &lt;event-id&gt;
4656  </p>  </p>
4657  </blockquote>  </blockquote><p>
4658    
4659    </p>
4660  <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
4661                      client wants to subscribe to.                      client wants to subscribe to.
4662  </p>  </p>
4663  <p>Possible Answers:  <p>Possible Answers:
4664  </p>  </p>
4665  <p></p>  <p>
4666                            </p>
4667  <blockquote class="text">  <blockquote class="text">
4668  <p>"OK" -  <p>"OK" -
4669                                  </p>                                  </p>
4670  <blockquote class="text">  <blockquote class="text">
4671  <p>on success  <p>on success
4672  </p>  </p>
4673  </blockquote>  </blockquote><p>
4674    
4675    </p>
4676  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4677                                  </p>                                  </p>
4678  <blockquote class="text">  <blockquote class="text">
# Line 3909  Intellectual Property and Copyright Stat Line 4680  Intellectual Property and Copyright Stat
4680                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4681                                      warning message                                      warning message
4682  </p>  </p>
4683  </blockquote>  </blockquote><p>
4684    
4685    </p>
4686  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4687                                  </p>                                  </p>
4688  <blockquote class="text">  <blockquote class="text">
4689  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
4690                                      error message                                      error message
4691  </p>  </p>
4692  </blockquote>  </blockquote><p>
4693    
4694  </blockquote>  </p>
4695    </blockquote><p>
4696    
4697    </p>
4698  <p>Examples:  <p>Examples:
4699  </p>  </p>
4700  <p></p>  <p>
4701                            </p>
4702  <blockquote class="text">  <blockquote class="text">
4703  <p>  <p>
4704  </p>  </p>
4705  </blockquote>  </blockquote><p>
4706    
4707  <a name="rfc.section.5.5.2"></a><h4><a name="UNSUBSCRIBE">5.5.2</a>&nbsp;Unregister front-end for not receiving event messages</h4>  </p>
4708    <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>
4709    
4710  <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
4711                      messages anymore by sending the following command:                      messages anymore by sending the following command:
4712  </p>  </p>
4713  <p></p>  <p>
4714                            </p>
4715  <blockquote class="text">  <blockquote class="text">
4716  <p>UNSUBSCRIBE &lt;event-id&gt;  <p>UNSUBSCRIBE &lt;event-id&gt;
4717  </p>  </p>
4718  </blockquote>  </blockquote><p>
4719    
4720    </p>
4721  <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
4722                      client doesn't want to receive anymore.                      client doesn't want to receive anymore.
4723  </p>  </p>
4724  <p>Possible Answers:  <p>Possible Answers:
4725  </p>  </p>
4726  <p></p>  <p>
4727                            </p>
4728  <blockquote class="text">  <blockquote class="text">
4729  <p>"OK" -  <p>"OK" -
4730                                  </p>                                  </p>
4731  <blockquote class="text">  <blockquote class="text">
4732  <p>on success  <p>on success
4733  </p>  </p>
4734  </blockquote>  </blockquote><p>
4735    
4736    </p>
4737  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4738                                  </p>                                  </p>
4739  <blockquote class="text">  <blockquote class="text">
# Line 3961  Intellectual Property and Copyright Stat Line 4741  Intellectual Property and Copyright Stat
4741                                      issue(s) related, providing an appropriate warning code and                                      issue(s) related, providing an appropriate warning code and
4742                                      warning message                                      warning message
4743  </p>  </p>
4744  </blockquote>  </blockquote><p>
4745    
4746    </p>
4747  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4748                                  </p>                                  </p>
4749  <blockquote class="text">  <blockquote class="text">
4750  <p>in case it failed, providing an appropriate error code and  <p>in case it failed, providing an appropriate error code and
4751                                      error message                                      error message
4752  </p>  </p>
4753  </blockquote>  </blockquote><p>
4754    
4755  </blockquote>  </p>
4756    </blockquote><p>
4757    
4758    </p>
4759  <p>Examples:  <p>Examples:
4760  </p>  </p>
4761  <p></p>  <p>
4762                            </p>
4763  <blockquote class="text">  <blockquote class="text">
4764  <p>  <p>
4765  </p>  </p>
4766  </blockquote>  </blockquote><p>
4767    
4768  <a name="rfc.section.5.5.3"></a><h4><a name="SET ECHO">5.5.3</a>&nbsp;Enable or disable echo of commands</h4>  </p>
4769    <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>
4770    
4771  <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:
4772  </p>  </p>
4773  <p></p>  <p>
4774                            </p>
4775  <blockquote class="text">  <blockquote class="text">
4776  <p>SET ECHO &lt;value&gt;  <p>SET ECHO &lt;value&gt;
4777  </p>  </p>
4778  </blockquote>  </blockquote><p>
4779    
4780    </p>
4781  <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
4782                      or "0" to disable echo mode. When echo mode is enabled, all                      or "0" to disable echo mode. When echo mode is enabled, all
4783                      commands send to LinuxSampler will be immediately send back and                      commands send to LinuxSampler will be immediately send back and
# Line 4001  Intellectual Property and Copyright Stat Line 4788  Intellectual Property and Copyright Stat
4788  </p>  </p>
4789  <p>Possible Answers:  <p>Possible Answers:
4790  </p>  </p>
4791  <p></p>  <p>
4792                            </p>
4793  <blockquote class="text">  <blockquote class="text">
4794  <p>"OK" -  <p>"OK" -
4795                                  </p>                                  </p>
4796  <blockquote class="text">  <blockquote class="text">
4797  <p>usually  <p>usually
4798  </p>  </p>
4799  </blockquote>  </blockquote><p>
4800    
4801    </p>
4802  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4803                                  </p>                                  </p>
4804  <blockquote class="text">  <blockquote class="text">
4805  <p>on syntax error, e.g. non boolean value  <p>on syntax error, e.g. non boolean value
4806  </p>  </p>
4807  </blockquote>  </blockquote><p>
4808    
4809  </blockquote>  </p>
4810    </blockquote><p>
4811    
4812    </p>
4813  <p>Examples:  <p>Examples:
4814  </p>  </p>
4815  <p></p>  <p>
4816                            </p>
4817  <blockquote class="text">  <blockquote class="text">
4818  <p>  <p>
4819  </p>  </p>
4820  </blockquote>  </blockquote><p>
4821    
4822  <a name="rfc.section.5.5.4"></a><h4><a name="QUIT">5.5.4</a>&nbsp;Close client connection</h4>  </p>
4823    <a name="rfc.section.6.5.4"></a><h4><a name="QUIT">6.5.4</a>&nbsp;Close client connection</h4>
4824    
4825  <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:
4826  </p>  </p>
4827  <p></p>  <p>
4828                            </p>
4829  <blockquote class="text">  <blockquote class="text">
4830  <p>QUIT  <p>QUIT
4831  </p>  </p>
4832  </blockquote>  </blockquote><p>
4833    
4834    </p>
4835  <p>This is probably more interesting for manual telnet connections to  <p>This is probably more interesting for manual telnet connections to
4836                      LinuxSampler than really useful for a front-end implementation.                      LinuxSampler than really useful for a front-end implementation.
4837  </p>  </p>
4838  <a name="rfc.section.5.6"></a><h4><a name="anchor14">5.6</a>&nbsp;Global commands</h4>  <a name="rfc.section.6.6"></a><h4><a name="anchor13">6.6</a>&nbsp;Global commands</h4>
4839    
4840  <p>The following commands have global impact on the sampler.  <p>The following commands have global impact on the sampler.
4841  </p>  </p>
4842  <a name="rfc.section.5.6.1"></a><h4><a name="RESET">5.6.1</a>&nbsp;Reset sampler</h4>  <a name="rfc.section.6.6.1"></a><h4><a name="RESET">6.6.1</a>&nbsp;Reset sampler</h4>
4843    
4844  <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:
4845  </p>  </p>
4846  <p></p>  <p>
4847                            </p>
4848  <blockquote class="text">  <blockquote class="text">
4849  <p>RESET  <p>RESET
4850  </p>  </p>
4851  </blockquote>  </blockquote><p>
4852    
4853    </p>
4854  <p>Possible Answers:  <p>Possible Answers:
4855  </p>  </p>
4856  <p></p>  <p>
4857                            </p>
4858  <blockquote class="text">  <blockquote class="text">
4859  <p>"OK" -  <p>"OK" -
4860                                  </p>                                  </p>
4861  <blockquote class="text">  <blockquote class="text">
4862  <p>always  <p>always
4863  </p>  </p>
4864  </blockquote>  </blockquote><p>
4865    
4866  </blockquote>  </p>
4867    </blockquote><p>
4868    
4869    </p>
4870  <p>Examples:  <p>Examples:
4871  </p>  </p>
4872  <p></p>  <p>
4873                            </p>
4874  <blockquote class="text">  <blockquote class="text">
4875  <p>  <p>
4876  </p>  </p>
4877  </blockquote>  </blockquote><p>
4878    
4879    </p>
4880    <a name="rfc.section.6.6.2"></a><h4><a name="GET SERVER INFO">6.6.2</a>&nbsp;General sampler informations</h4>
4881    
4882    <p>The client can ask for general informations about the LinuxSampler
4883                           instance by sending the following command:
4884    </p>
4885    <p>
4886                            </p>
4887    <blockquote class="text">
4888    <p>GET SERVER INFO
4889    </p>
4890    </blockquote><p>
4891    
4892    </p>
4893    <p>Possible Answers:
4894    </p>
4895    <p>
4896                            </p>
4897    <blockquote class="text">
4898    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
4899                                   Each answer line begins with the information category name
4900                                   followed by a colon and then a space character &lt;SP&gt; and finally
4901                                   the info character string to that information category. At the
4902                                   moment the following categories are defined:
4903    
4904    </p>
4905    <p>
4906                                    </p>
4907    <blockquote class="text">
4908    <p>DESCRIPTION -
4909                                            </p>
4910    <blockquote class="text">
4911    <p>arbitrary textual description about the sampler
4912    </p>
4913    </blockquote><p>
4914    
4915    </p>
4916    <p>VERSION -
4917                                            </p>
4918    <blockquote class="text">
4919    <p>version of the sampler
4920    </p>
4921    </blockquote><p>
4922    
4923    </p>
4924    <p>PROTOCOL_VERSION -
4925                                            </p>
4926    <blockquote class="text">
4927    <p>version of the LSCP specification the sampler
4928                                                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)
4929    </p>
4930    </blockquote><p>
4931    
4932    </p>
4933    </blockquote><p>
4934    
4935    </p>
4936    </blockquote><p>
4937    
4938    </p>
4939    <p>The mentioned fields above don't have to be in particular order.
4940                        Other fields might be added in future.
4941    </p>
4942  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
4943  <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="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
4944  <a name="rfc.section.6"></a><h3>6.&nbsp;Command Syntax</h3>  <a name="rfc.section.7"></a><h3>7.&nbsp;Command Syntax</h3>
4945    
4946    <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>
4947                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>)
4948                where applicable.
4949    
4950    </p>
4951    <p>input =
4952            </p>
4953    <blockquote class="text">
4954    <p>line LF
4955    
4956    </p>
4957    <p>/ line CR LF
4958    
4959    </p>
4960    </blockquote><p>
4961    
4962    </p>
4963    <p>line =
4964            </p>
4965    <blockquote class="text">
4966    <p>/* epsilon (empty line ignored) */
4967    
4968    </p>
4969    <p>/ comment
4970    
4971    </p>
4972    <p>/ command
4973    
4974    </p>
4975    <p>/ error
4976    
4977    </p>
4978    </blockquote><p>
4979    
4980    </p>
4981    <p>comment =
4982            </p>
4983    <blockquote class="text">
4984    <p>'#'
4985    
4986    </p>
4987    <p>/ comment '#'
4988    
4989    </p>
4990    <p>/ comment SP
4991    
4992    </p>
4993    <p>/ comment number
4994    
4995    </p>
4996    <p>/ comment string
4997    
4998    </p>
4999    </blockquote><p>
5000    
5001    </p>
5002    <p>command =
5003            </p>
5004    <blockquote class="text">
5005    <p>ADD SP CHANNEL
5006    
5007    </p>
5008    <p>/ GET SP get_instruction
5009    
5010    </p>
5011    <p>/ CREATE SP create_instruction
5012    
5013    </p>
5014    <p>/ DESTROY SP destroy_instruction
5015    
5016    </p>
5017    <p>/ LIST SP list_instruction
5018    
5019    </p>
5020    <p>/ LOAD SP load_instruction
5021    
5022    </p>
5023    <p>/ REMOVE SP CHANNEL SP sampler_channel
5024    
5025    </p>
5026    <p>/ SET SP set_instruction
5027    
5028    </p>
5029    <p>/ SUBSCRIBE SP subscribe_event
5030    
5031    </p>
5032    <p>/ UNSUBSCRIBE SP unsubscribe_event
5033    
5034    </p>
5035    <p>/ SELECT SP text
5036    
5037    </p>
5038    <p>/ RESET SP CHANNEL SP sampler_channel
5039    
5040    </p>
5041    <p>/ RESET
5042    
5043    </p>
5044    <p>/ QUIT
5045    
5046    </p>
5047    </blockquote><p>
5048    
5049    </p>
5050    <p>subscribe_event =
5051            </p>
5052    <blockquote class="text">
5053    <p>CHANNEL_COUNT
5054    
5055    </p>
5056    <p>/ VOICE_COUNT
5057    
5058    </p>
5059    <p>/ STREAM_COUNT
5060    
5061    </p>
5062    <p>/ BUFFER_FILL
5063    
5064    </p>
5065    <p>/ CHANNEL_INFO
5066    
5067    </p>
5068    <p>/ MISCELLANEOUS
5069    
5070    </p>
5071    </blockquote><p>
5072    
5073    </p>
5074    <p>unsubscribe_event =
5075            </p>
5076    <blockquote class="text">
5077    <p>CHANNEL_COUNT
5078    
5079    </p>
5080    <p>/ VOICE_COUNT
5081    
5082    </p>
5083    <p>/ STREAM_COUNT
5084    
5085    </p>
5086    <p>/ BUFFER_FILL
5087    
5088    </p>
5089    <p>/ CHANNEL_INFO
5090    
5091    </p>
5092    <p>/ MISCELLANEOUS
5093    
5094    </p>
5095    </blockquote><p>
5096    
5097    </p>
5098    <p>get_instruction =
5099            </p>
5100    <blockquote class="text">
5101    <p>AVAILABLE_ENGINES
5102    
5103    </p>
5104    <p>/ AVAILABLE_MIDI_INPUT_DRIVERS
5105    
5106    </p>
5107    <p>/ MIDI_INPUT_DRIVER SP INFO SP string
5108    
5109    </p>
5110    <p>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
5111    
5112    </p>
5113    <p>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
5114    
5115    </p>
5116    <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
5117    
5118    </p>
5119    <p>/ AUDIO_OUTPUT_DRIVER SP INFO SP string
5120    
5121    </p>
5122    <p>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
5123    
5124    </p>
5125    <p>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
5126    
5127    </p>
5128    <p>/ AUDIO_OUTPUT_DEVICES
5129    
5130    </p>
5131    <p>/ MIDI_INPUT_DEVICES
5132    
5133    </p>
5134    <p>/ AUDIO_OUTPUT_DEVICE SP INFO SP number
5135    
5136    </p>
5137    <p>/ MIDI_INPUT_DEVICE SP INFO SP number
5138    
5139    </p>
5140    <p>/ MIDI_INPUT_PORT SP INFO SP number SP number
5141    
5142    </p>
5143    <p>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
5144    
5145    </p>
5146    <p>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
5147    
5148    </p>
5149    <p>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string
5150    
5151    </p>
5152    <p>/ CHANNELS
5153    
5154    </p>
5155    <p>/ CHANNEL SP INFO SP sampler_channel
5156    
5157    </p>
5158    <p>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
5159    
5160    </p>
5161    <p>/ CHANNEL SP STREAM_COUNT SP sampler_channel
5162    
5163    </p>
5164    <p>/ CHANNEL SP VOICE_COUNT SP sampler_channel
5165    
5166    </p>
5167    <p>/ ENGINE SP INFO SP engine_name
5168    
5169    </p>
5170    <p>/ SERVER SP INFO
5171    
5172    </p>
5173    </blockquote><p>
5174    
5175    </p>
5176    <p>set_instruction =
5177            </p>
5178    <blockquote class="text">
5179    <p>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
5180    
5181    </p>
5182    <p>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list
5183    
5184    </p>
5185    <p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
5186    
5187    </p>
5188    <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
5189    
5190    </p>
5191    <p>/ CHANNEL SP set_chan_instruction
5192    
5193    </p>
5194    <p>/ ECHO SP boolean
5195    
5196    </p>
5197    </blockquote><p>
5198    
5199    </p>
5200    <p>create_instruction =
5201            </p>
5202    <blockquote class="text">
5203    <p>AUDIO_OUTPUT_DEVICE SP string SP key_val_list
5204    
5205    </p>
5206    <p>/ AUDIO_OUTPUT_DEVICE SP string
5207    
5208    </p>
5209    <p>/ MIDI_INPUT_DEVICE SP string SP key_val_list
5210    
5211    </p>
5212    <p>/ MIDI_INPUT_DEVICE SP string
5213    
5214    </p>
5215    </blockquote><p>
5216    
5217    </p>
5218    <p>destroy_instruction =
5219            </p>
5220    <blockquote class="text">
5221    <p>AUDIO_OUTPUT_DEVICE SP number
5222    
5223    </p>
5224    <p>/ MIDI_INPUT_DEVICE SP number
5225    
5226    </p>
5227    </blockquote><p>
5228    
5229    </p>
5230    <p>load_instruction =
5231            </p>
5232    <blockquote class="text">
5233    <p>INSTRUMENT SP load_instr_args
5234    
5235    </p>
5236    <p>/ ENGINE SP load_engine_args
5237    
5238    </p>
5239    </blockquote><p>
5240    
5241    </p>
5242    <p>set_chan_instruction =
5243            </p>
5244    <blockquote class="text">
5245    <p>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
5246    
5247    </p>
5248    <p>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index
5249    
5250    </p>
5251    <p>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
5252    
5253    </p>
5254    <p>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index
5255    
5256    </p>
5257    <p>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index
5258    
5259    </p>
5260    <p>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
5261    
5262    </p>
5263    <p>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index
5264    
5265    </p>
5266    <p>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
5267    
5268    </p>
5269    <p>/ VOLUME SP sampler_channel SP volume_value
5270    
5271    </p>
5272    <p>/ MUTE SP sampler_channel SP boolean
5273    
5274    </p>
5275    <p>/ SOLO SP sampler_channel SP boolean
5276    
5277    </p>
5278    </blockquote><p>
5279    
5280    </p>
5281    <p>key_val_list =
5282            </p>
5283    <blockquote class="text">
5284    <p>string '=' param_val_list
5285    
5286    </p>
5287    <p>/ key_val_list SP string '=' param_val_list
5288    
5289    </p>
5290    </blockquote><p>
5291    
5292    </p>
5293    <p>buffer_size_type =
5294            </p>
5295    <blockquote class="text">
5296    <p>BYTES
5297    
5298    </p>
5299    <p>/ PERCENTAGE
5300    
5301    </p>
5302    </blockquote><p>
5303    
5304    </p>
5305    <p>list_instruction =
5306            </p>
5307    <blockquote class="text">
5308    <p>AUDIO_OUTPUT_DEVICES
5309    
5310    </p>
5311    <p>/ MIDI_INPUT_DEVICES
5312    
5313    </p>
5314    <p>/ CHANNELS
5315    
5316    </p>
5317    <p>/ AVAILABLE_ENGINES
5318    
5319    </p>
5320    <p>/ AVAILABLE_MIDI_INPUT_DRIVERS
5321    
5322    </p>
5323    <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
5324    
5325    </p>
5326    </blockquote><p>
5327    
5328    </p>
5329    <p>load_instr_args =
5330            </p>
5331    <blockquote class="text">
5332    <p>filename SP instrument_index SP sampler_channel
5333    
5334    </p>
5335    <p>/ NON_MODAL SP filename SP instrument_index SP sampler_channel
5336    
5337    </p>
5338    </blockquote><p>
5339    
5340    </p>
5341    <p>load_engine_args =
5342            </p>
5343    <blockquote class="text">
5344    <p>engine_name SP sampler_channel
5345    
5346    </p>
5347    </blockquote><p>
5348    
5349    </p>
5350    <p>device_index =
5351            </p>
5352    <blockquote class="text">
5353    <p>number
5354    
5355    </p>
5356    </blockquote><p>
5357    
5358    </p>
5359    <p>audio_channel_index =
5360            </p>
5361    <blockquote class="text">
5362    <p>number
5363    
5364    </p>
5365    </blockquote><p>
5366    
5367    </p>
5368    <p>audio_output_type_name =
5369            </p>
5370    <blockquote class="text">
5371    <p>string
5372    
5373    </p>
5374    </blockquote><p>
5375    
5376    </p>
5377    <p>midi_input_port_index =
5378            </p>
5379    <blockquote class="text">
5380    <p>number
5381    
5382    </p>
5383    </blockquote><p>
5384    
5385    </p>
5386    <p>midi_input_channel_index =
5387            </p>
5388    <blockquote class="text">
5389    <p>number
5390    
5391    </p>
5392    <p>/ ALL
5393    
5394    </p>
5395    </blockquote><p>
5396    
5397    </p>
5398    <p>midi_input_type_name =
5399            </p>
5400    <blockquote class="text">
5401    <p>string
5402    
5403    </p>
5404    </blockquote><p>
5405    
5406    </p>
5407    <p>volume_value =
5408            </p>
5409    <blockquote class="text">
5410    <p>dotnum
5411    
5412    </p>
5413    <p>/ number
5414    
5415    </p>
5416    </blockquote><p>
5417    
5418    </p>
5419    <p>sampler_channel =
5420            </p>
5421    <blockquote class="text">
5422    <p>number
5423    
5424    </p>
5425    </blockquote><p>
5426    
5427    </p>
5428    <p>instrument_index =
5429            </p>
5430    <blockquote class="text">
5431    <p>number
5432    
5433    </p>
5434    </blockquote><p>
5435    
5436    </p>
5437    <p>engine_name =
5438            </p>
5439    <blockquote class="text">
5440    <p>string
5441    
5442    </p>
5443    </blockquote><p>
5444    
5445    </p>
5446    <p>filename =
5447            </p>
5448    <blockquote class="text">
5449    <p>stringval
5450    
5451    </p>
5452    </blockquote><p>
5453    
5454    </p>
5455    <p>param_val_list =
5456            </p>
5457    <blockquote class="text">
5458    <p>param_val
5459    
5460    </p>
5461    <p>/ param_val_list','param_val
5462    
5463    </p>
5464    </blockquote><p>
5465    
5466    </p>
5467    <p>param_val =
5468            </p>
5469    <blockquote class="text">
5470    <p>string
5471    
5472    </p>
5473    <p>/ '\'' string '\''
5474    
5475    </p>
5476    <p>/ '\"' string '\"'
5477    
5478    </p>
5479    <p>/ number
5480    
5481    </p>
5482    <p>/ dotnum
5483    
5484    </p>
5485    </blockquote><p>
5486    
 <p>TODO: will soon automatically included from src/network/lscp.y,  
             meanwhile have a look at that file to get the exact definition of  
             the command syntax.  
5487  </p>  </p>
5488  <a name="events"></a><br /><hr />  <a name="events"></a><br /><hr />
5489  <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="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
5490  <a name="rfc.section.7"></a><h3>7.&nbsp;Events</h3>  <a name="rfc.section.8"></a><h3>8.&nbsp;Events</h3>
5491    
5492  <p>This chapter will describe all currently defined events supported by LinuxSampler.  <p>This chapter will describe all currently defined events supported by LinuxSampler.
5493  </p>  </p>
5494  <a name="rfc.section.7.1"></a><h4><a name="SUBSCRIBE CHANNEL">7.1</a>&nbsp;Number of sampler channels changed</h4>  <a name="rfc.section.8.1"></a><h4><a name="SUBSCRIBE CHANNEL">8.1</a>&nbsp;Number of sampler channels changed</h4>
5495    
5496  <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
5497                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
5498  </p>  </p>
5499  <p></p>  <p>
5500                        </p>
5501  <blockquote class="text">  <blockquote class="text">
5502  <p>SUBSCRIBE CHANNELS  <p>SUBSCRIBE CHANNEL_COUNT
5503  </p>  </p>
5504  </blockquote>  </blockquote><p>
5505    
5506    </p>
5507  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
5508  </p>  </p>
5509  <p></p>  <p>
5510                        </p>
5511  <blockquote class="text">  <blockquote class="text">
5512  <p>"NOTIFY:CHANNELS:&lt;channels&gt;"  <p>"NOTIFY:CHANNEL_COUNT:&lt;channels&gt;"
5513  </p>  </p>
5514  </blockquote>  </blockquote><p>
5515    
5516    </p>
5517  <p>where &lt;channels&gt; will be replaced by the new number  <p>where &lt;channels&gt; will be replaced by the new number
5518                  of sampler channels.                  of sampler channels.
5519  </p>  </p>
5520  <a name="rfc.section.7.2"></a><h4><a name="SUBSCRIBE VOICE_COUNT">7.2</a>&nbsp;Number of active voices changed</h4>  <a name="rfc.section.8.2"></a><h4><a name="SUBSCRIBE VOICE_COUNT">8.2</a>&nbsp;Number of active voices changed</h4>
5521    
5522  <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
5523                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
5524  </p>  </p>
5525  <p></p>  <p>
5526                        </p>
5527  <blockquote class="text">  <blockquote class="text">
5528  <p>SUBSCRIBE VOICE_COUNT  <p>SUBSCRIBE VOICE_COUNT
5529  </p>  </p>
5530  </blockquote>  </blockquote><p>
5531    
5532    </p>
5533  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
5534  </p>  </p>
5535  <p></p>  <p>
5536                        </p>
5537  <blockquote class="text">  <blockquote class="text">
5538  <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;  <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;
5539  </p>  </p>
5540  </blockquote>  </blockquote><p>
5541    
5542    </p>
5543  <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
5544                  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
5545                  active voices on that channel.                  active voices on that channel.
5546  </p>  </p>
5547  <a name="rfc.section.7.3"></a><h4><a name="SUBSCRIBE STREAM_COUNT">7.3</a>&nbsp;Number of active disk streams changed</h4>  <a name="rfc.section.8.3"></a><h4><a name="SUBSCRIBE STREAM_COUNT">8.3</a>&nbsp;Number of active disk streams changed</h4>
5548    
5549  <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
5550                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT
5551  </p>  </p>
5552  <p></p>  <p>
5553                        </p>
5554  <blockquote class="text">  <blockquote class="text">
5555  <p>SUBSCRIBE STREAM_COUNT  <p>SUBSCRIBE STREAM_COUNT
5556  </p>  </p>
5557  </blockquote>  </blockquote><p>
5558    
5559    </p>
5560  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
5561  </p>  </p>
5562  <p></p>  <p>
5563                        </p>
5564  <blockquote class="text">  <blockquote class="text">
5565  <p>"NOTIFY:STREAM_COUNT:&lt;sampler-channel&gt; &lt;streams&gt;"  <p>"NOTIFY:STREAM_COUNT:&lt;sampler-channel&gt; &lt;streams&gt;"
5566  </p>  </p>
5567  </blockquote>  </blockquote><p>
5568    
5569    </p>
5570  <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
5571                  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
5572                  active disk streams on that channel.                  active disk streams on that channel.
5573  </p>  </p>
5574  <a name="rfc.section.7.4"></a><h4><a name="SUBSCRIBE BUFFER_FILL">7.4</a>&nbsp;Disk stream buffer fill state changed</h4>  <a name="rfc.section.8.4"></a><h4><a name="SUBSCRIBE BUFFER_FILL">8.4</a>&nbsp;Disk stream buffer fill state changed</h4>
5575    
5576  <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
5577                  on the back-end changes by issuing the following command:                  on the back-end changes by issuing the following command:
5578  </p>  </p>
5579  <p></p>  <p>
5580                        </p>
5581  <blockquote class="text">  <blockquote class="text">
5582  <p>SUBSCRIBE BUFFER_FILL  <p>SUBSCRIBE BUFFER_FILL
5583  </p>  </p>
5584  </blockquote>  </blockquote><p>
5585    
5586    </p>
5587  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
5588  </p>  </p>
5589  <p></p>  <p>
5590                        </p>
5591  <blockquote class="text">  <blockquote class="text">
5592  <p>"NOTIFY:BUFFER_FILL:&lt;sampler-channel&gt; &lt;fill-data&gt;"  <p>"NOTIFY:BUFFER_FILL:&lt;sampler-channel&gt; &lt;fill-data&gt;"
5593  </p>  </p>
5594  </blockquote>  </blockquote><p>
5595    
5596    </p>
5597  <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
5598                  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
5599                  buffer fill data for this channel as described in <a class="info" href="#GET CHANNEL BUFFER_FILL">Section 5.4.13<span>Current fill state of disk stream buffers</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>
5600                  as if the <a class="info" href="#GET CHANNEL BUFFER_FILL">"GET CHANNEL BUFFER_FILL PERCENTAGE"<span>Current fill state of disk stream buffers</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.
5601  </p>  </p>
5602  <a name="rfc.section.7.5"></a><h4><a name="SUBSCRIBE INFO">7.5</a>&nbsp;Channel information changed</h4>  <a name="rfc.section.8.5"></a><h4><a name="SUBSCRIBE INFO">8.5</a>&nbsp;Channel information changed</h4>
5603    
5604  <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
5605                  back-end changes by issuing the following command:                  back-end by issuing the following command:
5606  </p>  </p>
5607  <p></p>  <p>
5608                        </p>
5609  <blockquote class="text">  <blockquote class="text">
5610  <p>SUBSCRIBE INFO  <p>SUBSCRIBE CHANNEL_INFO
5611  </p>  </p>
5612  </blockquote>  </blockquote><p>
5613    
5614    </p>
5615  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
5616  </p>  </p>
5617  <p></p>  <p>
5618                        </p>
5619  <blockquote class="text">  <blockquote class="text">
5620  <p>"NOTIFY:INFO:&lt;sampler-channel&gt;"  <p>"NOTIFY:CHANNEL_INFO:&lt;sampler-channel&gt;"
5621  </p>  </p>
5622  </blockquote>  </blockquote><p>
5623    
5624    </p>
5625  <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
5626                  channel info change occurred. The front-end will have to send                  channel info change occurred. The front-end will have to send
5627                  the respective command to actually get the channel info. Because these messages                  the respective command to actually get the channel info. Because these messages
# Line 4207  Intellectual Property and Copyright Stat Line 5629  Intellectual Property and Copyright Stat
5629                  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
5630                  message is sufficient here.                  message is sufficient here.
5631  </p>  </p>
5632  <a name="rfc.section.7.6"></a><h4><a name="SUBSCRIBE MISCELLANEOUS">7.6</a>&nbsp;Miscellaneous and debugging events</h4>  <a name="rfc.section.8.6"></a><h4><a name="SUBSCRIBE MISCELLANEOUS">8.6</a>&nbsp;Miscellaneous and debugging events</h4>
5633    
5634  <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
5635                  the server by issuing the following command:                  the server by issuing the following command:
5636  </p>  </p>
5637  <p></p>  <p>
5638                        </p>
5639  <blockquote class="text">  <blockquote class="text">
5640  <p>SUBSCRIBE MISCELLANEOUS  <p>SUBSCRIBE MISCELLANEOUS
5641  </p>  </p>
5642  </blockquote>  </blockquote><p>
5643    
5644    </p>
5645  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
5646  </p>  </p>
5647  <p></p>  <p>
5648                        </p>
5649  <blockquote class="text">  <blockquote class="text">
5650  <p>"NOTIFY:MISCELLANEOUS:&lt;string&gt;"  <p>"NOTIFY:MISCELLANEOUS:&lt;string&gt;"
5651  </p>  </p>
5652  </blockquote>  </blockquote><p>
5653    
5654    </p>
5655  <p>where &lt;string&gt; will be replaced by whatever data server  <p>where &lt;string&gt; will be replaced by whatever data server
5656                  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
5657                  user AS IS to facilitate debugging.                  user AS IS to facilitate debugging.
5658  </p>  </p>
5659  <a name="anchor15"></a><br /><hr />  <a name="anchor14"></a><br /><hr />
5660  <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="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
5661  <a name="rfc.section.8"></a><h3>8.&nbsp;Security Considerations</h3>  <a name="rfc.section.9"></a><h3>9.&nbsp;Security Considerations</h3>
5662    
5663  <p>As there is so far no method of authentication and authorization  <p>As there is so far no method of authentication and authorization
5664              defined and so not required for a client applications to succeed to              defined and so not required for a client applications to succeed to
5665              connect, running LinuxSampler might be a security risk for the host              connect, running LinuxSampler might be a security risk for the host
5666              system the LinuxSampler instance is running on.              system the LinuxSampler instance is running on.
5667  </p>  </p>
5668  <a name="anchor16"></a><br /><hr />  <a name="anchor15"></a><br /><hr />
5669  <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="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
5670  <a name="rfc.section.9"></a><h3>9.&nbsp;Acknowledgments</h3>  <a name="rfc.section.10"></a><h3>10.&nbsp;Acknowledgments</h3>
5671    
5672  <p>This document has benefited greatly from the comments of the  <p>This document has benefited greatly from the comments of the
5673              following people, discussed on the LinuxSampler developer's mailing              following people, discussed on the LinuxSampler developer's mailing
5674              list:              list:
5675  </p>  </p>
5676  <p></p>  <p>
5677                    </p>
5678  <blockquote class="text">  <blockquote class="text">
5679  <p>Rui Nuno Capela  <p>Rui Nuno Capela
5680  </p>  </p>
# Line 4255  Intellectual Property and Copyright Stat Line 5682  Intellectual Property and Copyright Stat
5682  </p>  </p>
5683  <p>Mark Knecht  <p>Mark Knecht
5684  </p>  </p>
5685  </blockquote>  <p>Grigor Iliev
5686    </p>
5687    </blockquote><p>
5688    
5689    </p>
5690  <a name="rfc.references1"></a><br /><hr />  <a name="rfc.references1"></a><br /><hr />
5691  <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="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
5692  <h3>10&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
5693  <table width="99%" border="0">  <table width="99%" border="0">
5694  <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>
5695  <td class="author-text"><a href="mailto:sob@harvard.edu">Bradner, S.</a>, "<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">Key words for use in RFCs to Indicate Requirement Levels</a>", BCP 14, RFC 2119, March 1997 (<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">TXT</a>, <a href="http://xml.resource.org/public/rfc/html/rfc2119.html">HTML</a>, <a href="http://xml.resource.org/public/rfc/xml/rfc2119.xml">XML</a>).</td></tr>  <td class="author-text">Bradner, S., &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">Key words for use in RFCs to Indicate Requirement Levels</a>,&rdquo; RFC&nbsp;2119, 1997.</td></tr>
5696    <tr><td class="author-text" valign="top"><a name="RFC2234">[RFC2234]</a></td>
5697    <td class="author-text">Crocker, D. and P. Overell, &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc2234.txt">Augmented BNF for Syntax Specifications</a>,&rdquo; RFC&nbsp;2234, 1997.</td></tr>
5698    <tr><td class="author-text" valign="top"><a name="RFC793">[RFC793]</a></td>
5699    <td class="author-text">Defense Advanced Research Projects Agency, &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc793.txt">TRANSMISSION CONTROL PROTOCOL</a>,&rdquo; RFC&nbsp;793, 1981.</td></tr>
5700  </table>  </table>
5701    
5702  <a name="rfc.authors"></a><br /><hr />  <a name="rfc.authors"></a><br /><hr />
# Line 4280  Schoenebeck</td></tr> Line 5714  Schoenebeck</td></tr>
5714  <td class="author-text">74081 Heilbronn</td></tr>  <td class="author-text">74081 Heilbronn</td></tr>
5715  <tr><td class="author-text">&nbsp;</td>  <tr><td class="author-text">&nbsp;</td>
5716  <td class="author-text">Germany</td></tr>  <td class="author-text">Germany</td></tr>
5717  <tr><td class="author" align="right">EMail:&nbsp;</td>  <tr><td class="author" align="right">Email:&nbsp;</td>
5718  <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>
5719  </table>  </table>
5720  <a name="rfc.copyright"></a><br /><hr />  <a name="rfc.copyright"></a><br /><hr />
# Line 4295  under such rights might or might not be Line 5729  under such rights might or might not be
5729  it represent that it has made any effort to identify any such  it represent that it has made any effort to identify any such
5730  rights. Information on the IETF's procedures with respect to  rights. Information on the IETF's procedures with respect to
5731  rights in standards-track and standards-related documentation  rights in standards-track and standards-related documentation
5732  can be found in BCP-11. Copies of claims of rights made  can be found in BCP&nbsp;11. Copies of claims of rights made
5733  available for publication and any assurances of licenses to  available for publication and any assurances of licenses to
5734  be made available, or the result of an attempt made  be made available, or the result of an attempt made
5735  to obtain a general license or permission for the use of such  to obtain a general license or permission for the use of such
# Line 4309  required to practice this standard. Plea Line 5743  required to practice this standard. Plea
5743  information to the IETF Executive Director.</p>  information to the IETF Executive Director.</p>
5744  <h3>Full Copyright Statement</h3>  <h3>Full Copyright Statement</h3>
5745  <p class='copyright'>  <p class='copyright'>
5746  Copyright (C) The Internet Society (2005). All Rights Reserved.</p>  Copyright &copy; The Internet Society (2005). All Rights Reserved.</p>
5747  <p class='copyright'>  <p class='copyright'>
5748  This document and translations of it may be copied and furnished to  This document and translations of it may be copied and furnished to
5749  others, and derivative works that comment on or otherwise explain it  others, and derivative works that comment on or otherwise explain it
# Line 4329  The limited permissions granted above ar Line 5763  The limited permissions granted above ar
5763  revoked by the Internet Society or its successors or assignees.</p>  revoked by the Internet Society or its successors or assignees.</p>
5764  <p class='copyright'>  <p class='copyright'>
5765  This document and the information contained herein is provided on an  This document and the information contained herein is provided on an
5766  &quot;AS IS&quot; basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING  &ldquo;AS IS&rdquo; basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
5767  TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING  TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
5768  BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION  BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
5769  HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
Legend:
Removed from v.542  
changed lines
  Added in v.708
  ViewVC Help
Powered by ViewVC