/[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 1201 by iliev, Thu May 24 14:22:39 2007 UTC
# Line 3  Line 3 
3  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
4  <meta name="description" content="LinuxSampler Control Protocol">  <meta name="description" content="LinuxSampler Control Protocol">
5  <meta name="keywords" content="LSCP">  <meta name="keywords" content="LSCP">
6  <meta name="generator" content="xml2rfc v1.25 (http://xml.resource.org/)">  <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">
7  <style type='text/css'>  <style type='text/css'><!--
8  <!--          body {
9      body {                  font-family: verdana, charcoal, helvetica, arial, sans-serif;
10          font-family: verdana, charcoal, helvetica, arial, sans-serif;                  font-size: small; color: #000; background-color: #FFF;
11          margin: 2em;                  margin: 2em;
12          font-size: small ; color: #000000 ; background-color: #ffffff ; }          }
13      .title { color: #990000; font-size: x-large ;          h1, h2, h3, h4, h5, h6 {
14          font-weight: bold; text-align: right;                  font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;
15          font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;                  font-weight: bold; font-style: normal;
16          background-color: transparent; }          }
17      .filename { color: #666666; font-size: 18px; line-height: 28px;          h1 { color: #900; background-color: transparent; text-align: right; }
18          font-weight: bold; text-align: right;          h3 { color: #333; background-color: transparent; }
19          font-family: helvetica, arial, sans-serif;  
20          background-color: transparent; }          td.RFCbug {
21      td.rfcbug { background-color: #000000 ; width: 30px ; height: 30px ;                  font-size: x-small; text-decoration: none;
22          text-align: justify; vertical-align: middle ; padding-top: 2px ; }                  width: 30px; height: 30px; padding-top: 2px;
23      td.rfcbug span.RFC { color: #666666; font-weight: bold; text-decoration: none;                  text-align: justify; vertical-align: middle;
24          background-color: #000000 ;                  background-color: #000;
25          font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;          }
26          font-size: x-small ; }          td.RFCbug span.RFC {
27      td.rfcbug span.hotText { color: #ffffff; font-weight: normal; text-decoration: none;                  font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
28          text-align: center ;                  font-weight: bold; color: #666;
29          font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;          }
30          font-size: x-small ; background-color: #000000; }          td.RFCbug span.hotText {
31  /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */                  font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
32      div#counter{margin-top: 100px}                  font-weight: normal; text-align: center; color: #FFF;
33            }
34      a.info{  
35          position:relative; /*this is the key*/          table.TOCbug { width: 30px; height: 15px; }
36          z-index:24;          td.TOCbug {
37          text-decoration:none}                  text-align: center; width: 30px; height: 15px;
38                    color: #FFF; background-color: #900;
39      a.info:hover{z-index:25; background-color:#990000 ; color: #ffffff ;}          }
40            td.TOCbug a {
41      a.info span{display: none}                  font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;
42                    font-weight: bold; font-size: x-small; text-decoration: none;
43      a.info:hover span{ /*the span will display just on :hover state*/                  color: #FFF; background-color: transparent;
44          display:block;          }
45          position:absolute;  
46          font-size: smaller ;          td.header {
47          top:2em; left:2em; width:15em;                  font-family: arial, helvetica, sans-serif; font-size: x-small;
48          padding: 2px ;                  vertical-align: top; width: 33%;
49          border:1px solid #333333;                  color: #FFF; background-color: #666;
50          background-color:#eeeeee; color:#990000;          }
51          text-align: left ;}          td.author { font-weight: bold; font-size: x-small; margin-left: 4em; }
52            td.author-text { font-size: x-small; }
53       A { font-weight: bold; }  
54       A:link { color: #990000; background-color: transparent ; }          /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */
55       A:visited { color: #333333; background-color: transparent ; }          a.info {
56       A:active { color: #333333; background-color: transparent ; }                  /* This is the key. */
57                    position: relative;
58      p { margin-left: 2em; margin-right: 2em; }                  z-index: 24;
59      p.copyright { font-size: x-small ; }                  text-decoration: none;
60      p.toc { font-size: small ; font-weight: bold ; margin-left: 3em ;}          }
61            a.info:hover {
62      span.emph { font-style: italic; }                  z-index: 25;
63      span.strong { font-weight: bold; }                  color: #FFF; background-color: #900;
64      span.verb { font-family: "Courier New", Courier, monospace ; }          }
65            a.info span { display: none; }
66      ol.text { margin-left: 2em; margin-right: 2em; }          a.info:hover span.info {
67      ul.text { margin-left: 2em; margin-right: 2em; }                  /* The span will display just on :hover state. */
68      li { margin-left: 3em;  }                  display: block;
69                    position: absolute;
70                    font-size: smaller;
71                    top: 2em; left: -5em; width: 15em;
72                    padding: 2px; border: 1px solid #333;
73                    color: #900; background-color: #EEE;
74                    text-align: left;
75            }
76    
77      pre { margin-left: 3em; color: #333333;  background-color: transparent;          a { font-weight: bold; }
78          font-family: "Courier New", Courier, monospace ; font-size: small ;          a:link    { color: #900; background-color: transparent; }
79            a:visited { color: #633; background-color: transparent; }
80            a:active  { color: #633; background-color: transparent; }
81    
82            p { margin-left: 2em; margin-right: 2em; }
83            p.copyright { font-size: x-small; }
84            p.toc { font-size: small; font-weight: bold; margin-left: 3em; }
85            table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; }
86            td.toc { font-size: small; font-weight: bold; vertical-align: text-top; }
87    
88            ol.text { margin-left: 2em; margin-right: 2em; }
89            ul.text { margin-left: 2em; margin-right: 2em; }
90            li      { margin-left: 3em; }
91    
92            /* RFC-2629 <spanx>s and <artwork>s. */
93            em     { font-style: italic; }
94            strong { font-weight: bold; }
95            dfn    { font-weight: bold; font-style: normal; }
96            cite   { font-weight: normal; font-style: normal; }
97            tt     { color: #036; }
98            tt, pre, pre dfn, pre em, pre cite, pre span {
99                    font-family: "Courier New", Courier, monospace; font-size: small;
100            }
101            pre {
102                    text-align: left; padding: 4px;
103                    color: #000; background-color: #CCC;
104            }
105            pre dfn  { color: #900; }
106            pre em   { color: #66F; background-color: #FFC; font-weight: normal; }
107            pre .key { color: #33C; font-weight: bold; }
108            pre .id  { color: #900; }
109            pre .str { color: #000; background-color: #CFF; }
110            pre .val { color: #066; }
111            pre .rep { color: #909; }
112            pre .oth { color: #000; background-color: #FCF; }
113            pre .err { background-color: #FCC; }
114    
115            /* RFC-2629 <texttable>s. */
116            table.all, table.full, table.headers, table.none {
117                    font-size: small; text-align: center; border-width: 2px;
118                    vertical-align: top; border-collapse: collapse;
119            }
120            table.all, table.full { border-style: solid; border-color: black; }
121            table.headers, table.none { border-style: none; }
122            th {
123                    font-weight: bold; border-color: black;
124                    border-width: 2px 2px 3px 2px;
125          }          }
126            table.all th, table.full th { border-style: solid; }
127            table.headers th { border-style: none none solid none; }
128            table.none th { border-style: none; }
129            table.all td {
130                    border-style: solid; border-color: #333;
131                    border-width: 1px 2px;
132            }
133            table.full td, table.headers td, table.none td { border-style: none; }
134    
135      h3 { color: #333333; font-size: medium ;          hr { height: 1px; }
136          font-family: helvetica, arial, sans-serif ;          hr.insert {
137          background-color: transparent; }                  width: 80%; border-style: none; border-width: 0;
138      h4 { font-size: small; font-family: helvetica, arial, sans-serif ; }                  color: #CCC; background-color: #CCC;
139            }
140      table.bug { width: 30px ; height: 15px ; }  --></style>
     td.bug { color: #ffffff ; background-color: #990000 ;  
         text-align: center ; width: 30px ; height: 15px ;  
          }  
     td.bug A.link2 { color: #ffffff ; font-weight: bold;  
         text-decoration: none;  
         font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;  
         font-size: x-small ; background-color: transparent }  
   
     td.header { color: #ffffff; font-size: x-small ;  
         font-family: arial, helvetica, sans-serif; vertical-align: top;  
         background-color: #666666 ; width: 33% ; }  
     td.author { font-weight: bold; margin-left: 4em; font-size: x-small ; }  
     td.author-text { font-size: x-small; }  
     table.data { vertical-align: top ; border-collapse: collapse ;  
         border-style: solid solid solid solid ;  
         border-color: black black black black ;  
         font-size: small ; text-align: center ; }  
     table.data th { font-weight: bold ;  
         border-style: solid solid solid solid ;  
         border-color: black black black black ; }  
     table.data td {  
         border-style: solid solid solid solid ;  
         border-color: #333333 #333333 #333333 #333333 ; }  
   
     hr { height: 1px }  
 -->  
 </style>  
141  </head>  </head>
142  <body>  <body>
143  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
144  <table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1">  <table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1">
145  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>
146  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>
147  <tr><td class="header">Expires: November 7, 2005</td><td class="header">Engineering e. V.</td></tr>  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>
148  <tr><td class="header">&nbsp;</td><td class="header">May 9, 2005</td></tr>  <tr><td class="header">Expires: November 25, 2007</td><td class="header">May 24, 2007</td></tr>
149  </table></td></tr></table>  </table></td></tr></table>
150  <div align="right"><span class="title"><br />LinuxSampler Control Protocol</span></div>  <h1><br />LinuxSampler Control Protocol<br />LSCP 1.2</h1>
 <div align="right"><span class="title"><br />lscp.txt</span></div>  
151    
152  <h3>Status of this Memo</h3>  <h3>Status of this Memo</h3>
153  <p>  <p>
154  This document is an Internet-Draft and is  By submitting this Internet-Draft,
155  in full conformance with all provisions of Section 10 of RFC2026.</p>  each author represents that any applicable patent or other IPR claims of which
156    he or she is aware have been or will be disclosed,
157    and any of which he or she becomes aware will be disclosed,
158    in accordance with Section&nbsp;6 of BCP&nbsp;79.</p>
159  <p>  <p>
160  Internet-Drafts are working documents of the Internet Engineering  Internet-Drafts are working documents of the Internet Engineering
161  Task Force (IETF), its areas, and its working groups.  Task Force (IETF), its areas, and its working groups.
# Line 129  Internet-Drafts.</p> Line 165  Internet-Drafts.</p>
165  Internet-Drafts are draft documents valid for a maximum of six months  Internet-Drafts are draft documents valid for a maximum of six months
166  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.
167  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
168  them other than as "work in progress."</p>  them other than as &ldquo;work in progress.&rdquo;</p>
169  <p>  <p>
170  The list of current Internet-Drafts can be accessed at  The list of current Internet-Drafts can be accessed at
171  <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 173  The list of current Internet-Drafts can
173  The list of Internet-Draft Shadow Directories can be accessed at  The list of Internet-Draft Shadow Directories can be accessed at
174  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>
175  <p>  <p>
176  This Internet-Draft will expire on November 7, 2005.</p>  This Internet-Draft will expire on November 25, 2007.</p>
177    
178  <h3>Copyright Notice</h3>  <h3>Copyright Notice</h3>
179  <p>  <p>
180  Copyright (C) The Internet Society (2005). All Rights Reserved.</p>  Copyright &copy; The IETF Trust (2007).</p>
181    
182  <h3>Abstract</h3>  <h3>Abstract</h3>
183    
184  <p>The LinuxSampler Control Protocol (LSCP) is an  <p>The LinuxSampler Control Protocol (LSCP) is an
185              application-level protocol primarily intended for local and              application-level protocol primarily intended for local and
186              remote controlling the LinuxSampler main application, which is a              remote controlling the LinuxSampler backend application, which is a
187              sophisticated console application essentially playing back audio              sophisticated server-like console application essentially playing
188              samples and manipulating the samples in real time to certain              back audio samples and manipulating the samples in real time to
189              extent.              certain extent.
190  </p><a name="toc"></a><br /><hr />  </p><a name="toc"></a><br /><hr />
191  <h3>Table of Contents</h3>  <h3>Table of Contents</h3>
192  <p class="toc">  <p class="toc">
193  <a href="#anchor1">1.</a>&nbsp;  <a href="#anchor1">1.</a>&nbsp;
194  Requirements notation<br />  Requirements notation<br />
195  <a href="#anchor2">2.</a>&nbsp;  <a href="#LSCP versioning">2.</a>&nbsp;
196    Versioning of this specification<br />
197    <a href="#anchor2">3.</a>&nbsp;
198  Introduction<br />  Introduction<br />
199  <a href="#anchor3">3.</a>&nbsp;  <a href="#anchor3">4.</a>&nbsp;
200  Focus of this protocol<br />  Focus of this protocol<br />
201  <a href="#anchor4">4.</a>&nbsp;  <a href="#anchor4">5.</a>&nbsp;
202  Communication Overview<br />  Communication Overview<br />
203  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor5">4.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor5">5.1.</a>&nbsp;
204  Request/response communication method<br />  Request/response communication method<br />
205  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor6">4.1.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor6">5.1.1.</a>&nbsp;
206  Result format<br />  Result format<br />
207  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor7">4.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor7">5.2.</a>&nbsp;
208  Subscribe/notify communication method<br />  Subscribe/notify communication method<br />
209  <a href="#anchor8">5.</a>&nbsp;  <a href="#control_commands">6.</a>&nbsp;
210  Description for control commands<br />  Description for control commands<br />
211  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor9">5.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor8">6.1.</a>&nbsp;
212  Ignored lines and comments<br />  Ignored lines and comments<br />
213  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor10">5.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor9">6.2.</a>&nbsp;
214  Configuring audio drivers<br />  Configuring audio drivers<br />
215  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">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;
216  Getting amount of available audio output drivers<br />  Getting amount of available audio output drivers<br />
217  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">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;
218  Getting all available audio output drivers<br />  Getting all available audio output drivers<br />
219  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DRIVER INFO">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;
220  Getting information about a specific audio  Getting information about a specific audio
221                  output driver<br />                  output driver<br />
222  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">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;
223  Getting information about specific audio  Getting information about specific audio
224                  output driver parameter<br />                  output driver parameter<br />
225  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE AUDIO_OUTPUT_DEVICE">5.2.5</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE AUDIO_OUTPUT_DEVICE">6.2.5.</a>&nbsp;
226  Creating an audio output device<br />  Creating an audio output device<br />
227  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY AUDIO_OUTPUT_DEVICE">5.2.6</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY AUDIO_OUTPUT_DEVICE">6.2.6.</a>&nbsp;
228  Destroying an audio output device<br />  Destroying an audio output device<br />
229  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DEVICES">5.2.7</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DEVICES">6.2.7.</a>&nbsp;
230  Getting all created audio output device count<br />  Getting all created audio output device count<br />
231  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AUDIO_OUTPUT_DEVICES">5.2.8</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AUDIO_OUTPUT_DEVICES">6.2.8.</a>&nbsp;
232  Getting all created audio output device list<br />  Getting all created audio output device list<br />
233  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DEVICE INFO">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;
234  Getting current settings of an audio output device<br />  Getting current settings of an audio output device<br />
235  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET AUDIO_OUTPUT_DEVICE_PARAMETER">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;
236  Changing settings of audio output devices<br />  Changing settings of audio output devices<br />
237  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_CHANNEL INFO">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;
238  Getting information about an audio channel<br />  Getting information about an audio channel<br />
239  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO">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;
240  Getting information about specific audio channel parameter<br />  Getting information about specific audio channel parameter<br />
241  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET AUDIO_OUTPUT_CHANNEL_PARAMETER">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;
242  Changing settings of audio output channels<br />  Changing settings of audio output channels<br />
243  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor11">5.3</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor10">6.3.</a>&nbsp;
244  Configuring MIDI input drivers<br />  Configuring MIDI input drivers<br />
245  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_MIDI_INPUT_DRIVERS">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;
246  Getting amount of available MIDI input drivers<br />  Getting amount of available MIDI input drivers<br />
247  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">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;
248  Getting all available MIDI input drivers<br />  Getting all available MIDI input drivers<br />
249  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DRIVER INFO">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;
250  Getting information about a specific MIDI input driver<br />  Getting information about a specific MIDI input driver<br />
251  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DRIVER_PARAMETER INFO">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;
252  Getting information about specific MIDI input driver parameter<br />  Getting information about specific MIDI input driver parameter<br />
253  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE MIDI_INPUT_DEVICE">5.3.5</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE MIDI_INPUT_DEVICE">6.3.5.</a>&nbsp;
254  Creating a MIDI input device<br />  Creating a MIDI input device<br />
255  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY MIDI_INPUT_DEVICE">5.3.6</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY MIDI_INPUT_DEVICE">6.3.6.</a>&nbsp;
256  Destroying a MIDI input device<br />  Destroying a MIDI input device<br />
257  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DEVICES">5.3.7</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DEVICES">6.3.7.</a>&nbsp;
258  Getting all created MIDI input device count<br />  Getting all created MIDI input device count<br />
259  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INPUT_DEVICES">5.3.8</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INPUT_DEVICES">6.3.8.</a>&nbsp;
260  Getting all created MIDI input device list<br />  Getting all created MIDI input device list<br />
261  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DEVICE INFO">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;
262  Getting current settings of a MIDI input device<br />  Getting current settings of a MIDI input device<br />
263  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INPUT_DEVICE_PARAMETER">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;
264  Changing settings of MIDI input devices<br />  Changing settings of MIDI input devices<br />
265  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_PORT INFO">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;
266  Getting information about a MIDI port<br />  Getting information about a MIDI port<br />
267  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_PORT_PARAMETER INFO">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;
268  Getting information about specific MIDI port parameter<br />  Getting information about specific MIDI port parameter<br />
269  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INPUT_PORT_PARAMETER">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;
270  Changing settings of MIDI input ports<br />  Changing settings of MIDI input ports<br />
271  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">5.4</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor11">6.4.</a>&nbsp;
272  Configuring sampler channels<br />  Configuring sampler channels<br />
273  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LOAD INSTRUMENT">5.4.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LOAD INSTRUMENT">6.4.1.</a>&nbsp;
274  Loading an instrument<br />  Loading an instrument<br />
275  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LOAD ENGINE">5.4.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LOAD ENGINE">6.4.2.</a>&nbsp;
276  Loading a sampler engine<br />  Loading a sampler engine<br />
277  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNELS">5.4.3</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNELS">6.4.3.</a>&nbsp;
278  Getting all created sampler channel count<br />  Getting all created sampler channel count<br />
279  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST CHANNELS">5.4.4</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST CHANNELS">6.4.4.</a>&nbsp;
280  Getting all created sampler channel list<br />  Getting all created sampler channel list<br />
281  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD CHANNEL">5.4.5</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD CHANNEL">6.4.5.</a>&nbsp;
282  Adding a new sampler channel<br />  Adding a new sampler channel<br />
283  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE CHANNEL">5.4.6</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE CHANNEL">6.4.6.</a>&nbsp;
284  Removing a sampler channel<br />  Removing a sampler channel<br />
285  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_ENGINES">5.4.7</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_ENGINES">6.4.7.</a>&nbsp;
286  Getting amount of available engines<br />  Getting amount of available engines<br />
287  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_ENGINES">5.4.8</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_ENGINES">6.4.8.</a>&nbsp;
288  Getting all available engines<br />  Getting all available engines<br />
289  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET ENGINE INFO">5.4.9</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET ENGINE INFO">6.4.9.</a>&nbsp;
290  Getting information about an engine<br />  Getting information about an engine<br />
291  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL INFO">5.4.10</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL INFO">6.4.10.</a>&nbsp;
292  Getting sampler channel information<br />  Getting sampler channel information<br />
293  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL VOICE_COUNT">5.4.11</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL VOICE_COUNT">6.4.11.</a>&nbsp;
294  Current number of active voices<br />  Current number of active voices<br />
295  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL STREAM_COUNT">5.4.12</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL STREAM_COUNT">6.4.12.</a>&nbsp;
296  Current number of active disk streams<br />  Current number of active disk streams<br />
297  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL BUFFER_FILL">5.4.13</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL BUFFER_FILL">6.4.13.</a>&nbsp;
298  Current fill state of disk stream buffers<br />  Current fill state of disk stream buffers<br />
299  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_DEVICE">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;
300  Setting audio output device<br />  Setting audio output device<br />
301  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_TYP">5.4.15</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_TYPE">6.4.15.</a>&nbsp;
302  Setting audio output type<br />  Setting audio output type<br />
303  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_CHANNEL">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;
304  Setting audio output channel<br />  Setting audio output channel<br />
305  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_DEVICE">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;
306  Setting MIDI input device<br />  Setting MIDI input device<br />
307  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_TYPE">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;
308  Setting MIDI input type<br />  Setting MIDI input type<br />
309  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_PORT">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;
310  Setting MIDI input port<br />  Setting MIDI input port<br />
311  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_CHANNEL">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;
312  Setting MIDI input channel<br />  Setting MIDI input channel<br />
313  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL VOLUME">5.4.21</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL VOLUME">6.4.21.</a>&nbsp;
314  Setting channel volume<br />  Setting channel volume<br />
315  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#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;
316    Muting a sampler channel<br />
317    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL SOLO">6.4.23.</a>&nbsp;
318    Soloing a sampler channel<br />
319    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INSTRUMENT_MAP">6.4.24.</a>&nbsp;
320    Assigning a MIDI instrument map to a sampler channel<br />
321    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE FX_SEND">6.4.25.</a>&nbsp;
322    Adding an effect send to a sampler channel<br />
323    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY FX_SEND">6.4.26.</a>&nbsp;
324    Removing an effect send from a sampler channel<br />
325    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SENDS">6.4.27.</a>&nbsp;
326    Getting amount of effect sends on a sampler channel<br />
327    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST FX_SENDS">6.4.28.</a>&nbsp;
328    Listing all effect sends on a sampler channel<br />
329    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SEND INFO">6.4.29.</a>&nbsp;
330    Getting effect send information<br />
331    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND NAME">6.4.30.</a>&nbsp;
332    Changing effect send's name<br />
333    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a>&nbsp;
334    Altering effect send's audio routing<br />
335    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.32.</a>&nbsp;
336    Altering effect send's MIDI controller<br />
337    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.33.</a>&nbsp;
338    Altering effect send's send level<br />
339    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.34.</a>&nbsp;
340  Resetting a sampler channel<br />  Resetting a sampler channel<br />
341  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor13">5.5</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;
342  Controlling connection<br />  Controlling connection<br />
343  &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;
344  Register front-end for receiving event messages<br />  Register front-end for receiving event messages<br />
345  &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;
346  Unregister front-end for not receiving event messages<br />  Unregister front-end for not receiving event messages<br />
347  &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;
348  Enable or disable echo of commands<br />  Enable or disable echo of commands<br />
349  &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;
350  Close client connection<br />  Close client connection<br />
351  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor14">5.6</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor13">6.6.</a>&nbsp;
352  Global commands<br />  Global commands<br />
353  &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="#GET TOTAL_VOICE_COUNT">6.6.1.</a>&nbsp;
354    Current number of active voices<br />
355    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a>&nbsp;
356    Maximum amount of active voices<br />
357    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET">6.6.3.</a>&nbsp;
358  Reset sampler<br />  Reset sampler<br />
359  <a href="#command_syntax">6.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.4.</a>&nbsp;
360    General sampler informations<br />
361    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET VOLUME">6.6.5.</a>&nbsp;
362    Getting global volume attenuation<br />
363    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOLUME">6.6.6.</a>&nbsp;
364    Setting global volume attenuation<br />
365    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#MIDI Instrument Mapping">6.7.</a>&nbsp;
366    MIDI Instrument Mapping<br />
367    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD MIDI_INSTRUMENT MAP">6.7.1.</a>&nbsp;
368    Create a new MIDI instrument map<br />
369    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a>&nbsp;
370    Delete one particular or all MIDI instrument maps<br />
371    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT_MAPS">6.7.3.</a>&nbsp;
372    Get amount of existing MIDI instrument maps<br />
373    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INSTRUMENT_MAPS">6.7.4.</a>&nbsp;
374    Getting all created MIDI instrument maps<br />
375    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT_MAP INFO">6.7.5.</a>&nbsp;
376    Getting MIDI instrument map information<br />
377    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INSTRUMENT_MAP NAME">6.7.6.</a>&nbsp;
378    Renaming a MIDI instrument map<br />
379    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MAP MIDI_INSTRUMENT">6.7.7.</a>&nbsp;
380    Create or replace a MIDI instrument map entry<br />
381    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENTS">6.7.8.</a>&nbsp;
382    Getting ammount of MIDI instrument map entries<br />
383    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INSTRUMENTS">6.7.9.</a>&nbsp;
384    Getting indeces of all entries of a MIDI instrument map<br />
385    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#UNMAP MIDI_INSTRUMENT">6.7.10.</a>&nbsp;
386    Remove an entry from the MIDI instrument map<br />
387    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT INFO">6.7.11.</a>&nbsp;
388    Get current settings of MIDI instrument map entry<br />
389    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CLEAR MIDI_INSTRUMENTS">6.7.12.</a>&nbsp;
390    Clear MIDI instrument map<br />
391    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Managing Instruments Database">6.8.</a>&nbsp;
392    Managing Instruments Database<br />
393    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD DB_INSTRUMENT_DIRECTORY">6.8.1.</a>&nbsp;
394    Creating a new instrument directory<br />
395    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE DB_INSTRUMENT_DIRECTORY">6.8.2.</a>&nbsp;
396    Deleting an instrument directory<br />
397    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT_DIRECTORIES">6.8.3.</a>&nbsp;
398    Getting amount of instrument directories<br />
399    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST DB_INSTRUMENT_DIRECTORIES">6.8.4.</a>&nbsp;
400    Listing all directories in specific directory<br />
401    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT_DIRECTORY INFO">6.8.5.</a>&nbsp;
402    Getting instrument directory information<br />
403    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT_DIRECTORY NAME">6.8.6.</a>&nbsp;
404    Renaming an instrument directory<br />
405    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MOVE DB_INSTRUMENT_DIRECTORY">6.8.7.</a>&nbsp;
406    Moving an instrument directory<br />
407    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#COPY DB_INSTRUMENT_DIRECTORY">6.8.8.</a>&nbsp;
408    Copying instrument directories<br />
409    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">6.8.9.</a>&nbsp;
410    Changing the description of directory<br />
411    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FIND DB_INSTRUMENT_DIRECTORIES">6.8.10.</a>&nbsp;
412    Finding directories<br />
413    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD DB_INSTRUMENTS">6.8.11.</a>&nbsp;
414    Adding instruments to the instruments database<br />
415    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE DB_INSTRUMENT">6.8.12.</a>&nbsp;
416    Removing an instrument<br />
417    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENTS">6.8.13.</a>&nbsp;
418    Getting amount of instruments<br />
419    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST DB_INSTRUMENTS">6.8.14.</a>&nbsp;
420    Listing all instruments in specific directory<br />
421    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT INFO">6.8.15.</a>&nbsp;
422    Getting instrument information<br />
423    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT NAME">6.8.16.</a>&nbsp;
424    Renaming an instrument<br />
425    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MOVE DB_INSTRUMENT">6.8.17.</a>&nbsp;
426    Moving an instrument<br />
427    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#COPY DB_INSTRUMENT">6.8.18.</a>&nbsp;
428    Copying instruments<br />
429    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT DESCRIPTION">6.8.19.</a>&nbsp;
430    Changing the description of instrument<br />
431    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FIND DB_INSTRUMENTS">6.8.20.</a>&nbsp;
432    Finding instruments<br />
433    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENTS_JOB INFO">6.8.21.</a>&nbsp;
434    Getting job status information<br />
435    <a href="#command_syntax">7.</a>&nbsp;
436  Command Syntax<br />  Command Syntax<br />
437  <a href="#events">7.</a>&nbsp;  <a href="#events">8.</a>&nbsp;
438  Events<br />  Events<br />
439  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL">7.1</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a>&nbsp;
440    Number of audio output devices changed<br />
441    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">8.2.</a>&nbsp;
442    Audio output device's settings changed<br />
443    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">8.3.</a>&nbsp;
444    Number of MIDI input devices changed<br />
445    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INPUT_DEVICE_INFO">8.4.</a>&nbsp;
446    MIDI input device's settings changed<br />
447    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a>&nbsp;
448  Number of sampler channels changed<br />  Number of sampler channels changed<br />
449  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">7.2</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.6.</a>&nbsp;
450  Number of active voices changed<br />  Number of active voices changed<br />
451  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">7.3</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">8.7.</a>&nbsp;
452  Number of active disk streams changed<br />  Number of active disk streams changed<br />
453  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">7.4</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">8.8.</a>&nbsp;
454  Disk stream buffer fill state changed<br />  Disk stream buffer fill state changed<br />
455  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE INFO">7.5</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_INFO">8.9.</a>&nbsp;
456  Channel information changed<br />  Channel information changed<br />
457  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">7.6</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_COUNT">8.10.</a>&nbsp;
458    Number of effect sends changed<br />
459    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_INFO">8.11.</a>&nbsp;
460    Effect send information changed<br />
461    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a>&nbsp;
462    Total number of active voices changed<br />
463    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.13.</a>&nbsp;
464    Number of MIDI instrument maps changed<br />
465    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.14.</a>&nbsp;
466    MIDI instrument map information changed<br />
467    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.15.</a>&nbsp;
468    Number of MIDI instruments changed<br />
469    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.16.</a>&nbsp;
470    MIDI instrument information changed<br />
471    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a>&nbsp;
472    Global settings changed<br />
473    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.18.</a>&nbsp;
474    Number of database instrument directories changed<br />
475    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.19.</a>&nbsp;
476    Database instrument directory information changed<br />
477    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.20.</a>&nbsp;
478    Number of database instruments changed<br />
479    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.21.</a>&nbsp;
480    Database instrument information changed<br />
481    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.22.</a>&nbsp;
482    Database job status information changed<br />
483    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.23.</a>&nbsp;
484  Miscellaneous and debugging events<br />  Miscellaneous and debugging events<br />
485  <a href="#anchor15">8.</a>&nbsp;  <a href="#anchor14">9.</a>&nbsp;
486  Security Considerations<br />  Security Considerations<br />
487  <a href="#anchor16">9.</a>&nbsp;  <a href="#anchor15">10.</a>&nbsp;
488  Acknowledgments<br />  Acknowledgments<br />
489  <a href="#rfc.references1">10.</a>&nbsp;  <a href="#rfc.references1">11.</a>&nbsp;
490  References<br />  References<br />
491  <a href="#rfc.authors">&#167;</a>&nbsp;  <a href="#rfc.authors">&#167;</a>&nbsp;
492  Author's Address<br />  Author's Address<br />
# Line 320  Intellectual Property and Copyright Stat Line 496  Intellectual Property and Copyright Stat
496  <br clear="all" />  <br clear="all" />
497    
498  <a name="anchor1"></a><br /><hr />  <a name="anchor1"></a><br /><hr />
499  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
500  <a name="rfc.section.1"></a><h3>1.&nbsp;Requirements notation</h3>  <a name="rfc.section.1"></a><h3>1.&nbsp;
501    Requirements notation</h3>
502    
503  <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",  <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
504              "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",              "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
505              and "OPTIONAL" in this document are to be interpreted as              and "OPTIONAL" in this document are to be interpreted as
506              described in <a class="info" href="#RFC2119">[RFC2119]<span>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>.
507  </p>  </p>
508  <p>This protocol is always case-sensitive if not explicitly  <p>This protocol is always case-sensitive if not explicitly
509              claimed the opposite.              claimed the opposite.
# Line 338  Intellectual Property and Copyright Stat Line 515  Intellectual Property and Copyright Stat
515              character as defined in the ASCII standard), thus the following              character as defined in the ASCII standard), thus the following
516              example:              example:
517  </p>  </p>
518  <p></p>  <p>
519                    </p>
520  <blockquote class="text">  <blockquote class="text">
521  <p>C: "some line"  <p>C: "some line"
522  </p>  </p>
523  <p>&nbsp;&nbsp;&nbsp;"another line"  <p>&nbsp;&nbsp;&nbsp;"another line"
524  </p>  </p>
525  </blockquote>  </blockquote><p>
526                
527    </p>
528  <p>must actually be interpreted as client sending the following  <p>must actually be interpreted as client sending the following
529              message:              message:
530  </p>  </p>
531  <p></p>  <p>
532                    </p>
533  <blockquote class="text">  <blockquote class="text">
534  <p>"some line&lt;CR&gt;&lt;LF&gt;another  <p>"some line&lt;CR&gt;&lt;LF&gt;another
535                      line&lt;CR&gt;&lt;LF&gt;"                      line&lt;CR&gt;&lt;LF&gt;"
536  </p>  </p>
537  </blockquote>  </blockquote><p>
538                
539    </p>
540  <p>where &lt;CR&gt; symbolizes the carriage return character and  <p>where &lt;CR&gt; symbolizes the carriage return character and
541              &lt;LF&gt; the line feed character as defined in the ASCII              &lt;LF&gt; the line feed character as defined in the ASCII
542              standard.              standard.
# Line 363  Intellectual Property and Copyright Stat Line 544  Intellectual Property and Copyright Stat
544  <p>Due to technical reasons, messages can arbitrary be  <p>Due to technical reasons, messages can arbitrary be
545              fragmented, means the following example:              fragmented, means the following example:
546  </p>  </p>
547  <p></p>  <p>
548                    </p>
549  <blockquote class="text">  <blockquote class="text">
550  <p>S: "abcd"  <p>S: "abcd"
551  </p>  </p>
552  </blockquote>  </blockquote><p>
553                
554    </p>
555  <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
556              following sequence scenario:              following sequence scenario:
557  </p>  </p>
558  <p></p>  <p>
559                    </p>
560  <ul class="text">  <ul class="text">
561  <li>server sending message "a"  <li>server sending message "a"
562  </li>  </li>
# Line 388  Intellectual Property and Copyright Stat Line 572  Intellectual Property and Copyright Stat
572  <li>followed by server sending the message  <li>followed by server sending the message
573                      "&lt;LF&gt;"                      "&lt;LF&gt;"
574  </li>  </li>
575  </ul>  </ul><p>
576                
577    </p>
578  <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
579              return and line feed characters respectively.              return and line feed characters respectively.
580  </p>  </p>
581    <a name="LSCP versioning"></a><br /><hr />
582    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
583    <a name="rfc.section.2"></a><h3>2.&nbsp;
584    Versioning of this specification</h3>
585    
586    <p>LSCP will certainly be extended and enhanced by-and-by. Each official
587                release of the LSCP specification will be tagged with a unique version
588                tuple. The version tuple consists at least of a major and minor version
589                number like:
590                
591    </p>
592    <p>
593                    </p>
594    <blockquote class="text">
595    <p>"1.2"
596    </p>
597    </blockquote><p>
598                
599    </p>
600    <p>
601                In this example the major version number would be "1" and the minor
602                version number would be "2". Note that the version tuple might also
603                have more than two elements. The major version number defines a
604                group of backward compatible versions. That means a frontend is
605                compatible to the connected sampler if and only if the LSCP versions
606                to which each of the two parties complies to, match both of the
607                following rules:
608                
609    </p>
610    <p>Compatibility:
611    </p>
612    <p>
613                    </p>
614    <ol class="text">
615    <li>The frontend's LSCP major version and the sampler's LSCP
616                        major version are exactly equal.
617    </li>
618    <li>The frontend's LSCP minor version is less or equal than
619                        the sampler's LSCP minor version.
620    </li>
621    </ol><p>
622                
623    </p>
624    <p>
625                Compatibility can only be claimed if both rules are true.
626                The frontend can use the
627                <a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a> command to
628                get the version of the LSCP specification the sampler complies with.
629                
630    </p>
631  <a name="anchor2"></a><br /><hr />  <a name="anchor2"></a><br /><hr />
632  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
633  <a name="rfc.section.2"></a><h3>2.&nbsp;Introduction</h3>  <a name="rfc.section.3"></a><h3>3.&nbsp;
634    Introduction</h3>
635    
636  <p>LinuxSampler is a so called software sampler application  <p>LinuxSampler is a so called software sampler application
637              capable to playback audio samples from a computer's Random              capable to playback audio samples from a computer's Random
# Line 408  Intellectual Property and Copyright Stat Line 644  Intellectual Property and Copyright Stat
644              arbitrary MIDI input method and arbitrary MIDI channel (e.g.              arbitrary MIDI input method and arbitrary MIDI channel (e.g.
645              sampler channel 17 could be connected to an ALSA sequencer              sampler channel 17 could be connected to an ALSA sequencer
646              device 64:0 and listening to MIDI channel 1 there). Each sampler              device 64:0 and listening to MIDI channel 1 there). Each sampler
647              engine will be assigned an own instance of one of the available              channel will be associated with an instance of one of the available
648              sampler engines (e.g. GigEngine, DLSEngine). The audio output of              sampler engines (e.g. GigEngine, DLSEngine). The audio output of
649              each sampler channel can be routed to an arbitrary audio output              each sampler channel can be routed to an arbitrary audio output
650              method (ALSA / JACK) and an arbitrary audio output channel              method (ALSA / JACK) and an arbitrary audio output channel
651              there.              there.
652  </p>  </p>
653  <a name="anchor3"></a><br /><hr />  <a name="anchor3"></a><br /><hr />
654  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
655  <a name="rfc.section.3"></a><h3>3.&nbsp;Focus of this protocol</h3>  <a name="rfc.section.4"></a><h3>4.&nbsp;
656    Focus of this protocol</h3>
657    
658  <p>Main focus of this protocol is to provide a way to configure  <p>Main focus of this protocol is to provide a way to configure
659              a running LinuxSampler instance and to retrieve information              a running LinuxSampler instance and to retrieve information
# Line 427  Intellectual Property and Copyright Stat Line 664  Intellectual Property and Copyright Stat
664              via MIDI System Exclusive Messages.              via MIDI System Exclusive Messages.
665  </p>  </p>
666  <a name="anchor4"></a><br /><hr />  <a name="anchor4"></a><br /><hr />
667  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
668  <a name="rfc.section.4"></a><h3>4.&nbsp;Communication Overview</h3>  <a name="rfc.section.5"></a><h3>5.&nbsp;
669    Communication Overview</h3>
670    
671  <p>There are two distinct methods of communication between a  <p>There are two distinct methods of communication between a
672              running instance of LinuxSampler and one or more control              running instance of LinuxSampler and one or more control
# Line 441  Intellectual Property and Copyright Stat Line 679  Intellectual Property and Copyright Stat
679              implemented in the front-end application. The two communication              implemented in the front-end application. The two communication
680              methods will be described next.              methods will be described next.
681  </p>  </p>
682  <a name="rfc.section.4.1"></a><h4><a name="anchor5">4.1</a>&nbsp;Request/response communication method</h4>  <a name="anchor5"></a><br /><hr />
683    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
684    <a name="rfc.section.5.1"></a><h3>5.1.&nbsp;
685    Request/response communication method</h3>
686    
687  <p>This simple communication method is based on TCP. The  <p>This simple communication method is based on
688                    <a class='info' href='#RFC793'>TCP<span> (</span><span class='info'>Defense Advanced Research Projects Agency, &ldquo;TRANSMISSION CONTROL PROTOCOL,&rdquo; 1981.</span><span>)</span></a> [RFC793]. The
689                  front-end application establishes a TCP connection to the                  front-end application establishes a TCP connection to the
690                  LinuxSampler instance on a certain host system. Then the                  LinuxSampler instance on a certain host system. Then the
691                  front-end application will send certain ASCII based commands                  front-end application will send certain ASCII based commands
# Line 483  Intellectual Property and Copyright Stat Line 725  Intellectual Property and Copyright Stat
725                  processed in the order they were received and result sets                  processed in the order they were received and result sets
726                  MUST be sent back in the same order.                  MUST be sent back in the same order.
727  </p>  </p>
728  <a name="rfc.section.4.1.1"></a><h4><a name="anchor6">4.1.1</a>&nbsp;Result format</h4>  <a name="anchor6"></a><br /><hr />
729    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
730    <a name="rfc.section.5.1.1"></a><h3>5.1.1.&nbsp;
731    Result format</h3>
732    
733  <p>Result set could be one of the following types:  <p>Result set could be one of the following types:
734  </p>  </p>
735  <p></p>  <p>
736                            </p>
737  <ol class="text">  <ol class="text">
738  <li>Normal  <li>Normal
739  </li>  </li>
# Line 495  Intellectual Property and Copyright Stat Line 741  Intellectual Property and Copyright Stat
741  </li>  </li>
742  <li>Error  <li>Error
743  </li>  </li>
744  </ol>  </ol><p>
745                        
746    </p>
747  <p>Warning and Error result sets MUST be single line and  <p>Warning and Error result sets MUST be single line and
748                      have the following format:                      have the following format:
749  </p>  </p>
750  <p></p>  <p>
751                            </p>
752  <ul class="text">  <ul class="text">
753  <li>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;"  <li>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;"
754  </li>  </li>
755  <li>"ERR:&lt;error-code&gt;:&lt;error-message&gt;"  <li>"ERR:&lt;error-code&gt;:&lt;error-message&gt;"
756  </li>  </li>
757  </ul>  </ul><p>
758                        
759    </p>
760  <p>Where &lt;warning-code&gt; and &lt;error-code&gt; are  <p>Where &lt;warning-code&gt; and &lt;error-code&gt; are
761                      numeric unique identifiers of the warning or error and                      numeric unique identifiers of the warning or error and
762                      &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 765  Intellectual Property and Copyright Stat
765  </p>  </p>
766  <p>Examples:  <p>Examples:
767  </p>  </p>
768  <p></p>  <p>
769                            </p>
770  <blockquote class="text">  <blockquote class="text">
771  <p>C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0  <p>C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0
772  </p>  </p>
773  <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."
774  </p>  </p>
775  </blockquote>  </blockquote><p>
776                        
777  <p></p>  </p>
778    <p>
779                            </p>
780  <blockquote class="text">  <blockquote class="text">
781  <p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"  <p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"
782  </p>  </p>
783  <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'."
784  </p>  </p>
785  </blockquote>  </blockquote><p>
786                        
787  <p></p>  </p>
788    <p>
789                            </p>
790  <blockquote class="text">  <blockquote class="text">
791  <p>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"  <p>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"
792  </p>  </p>
793  <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."
794  </p>  </p>
795  </blockquote>  </blockquote><p>
796                        
797    </p>
798  <p>Normal result sets could be:  <p>Normal result sets could be:
799  </p>  </p>
800  <p></p>  <p>
801                            </p>
802  <ol class="text">  <ol class="text">
803  <li>Empty  <li>Empty
804  </li>  </li>
# Line 550  Intellectual Property and Copyright Stat Line 806  Intellectual Property and Copyright Stat
806  </li>  </li>
807  <li>Multi-line  <li>Multi-line
808  </li>  </li>
809  </ol>  </ol><p>
810                        
811    </p>
812  <p> Empty result set is issued when the server only  <p> Empty result set is issued when the server only
813                      needed to acknowledge the fact that the request was                      needed to acknowledge the fact that the request was
814                      received and it was processed successfully and no                      received and it was processed successfully and no
815                      additional information is available. This result set has                      additional information is available. This result set has
816                      the following format:                      the following format:
817  </p>  </p>
818  <p></p>  <p>
819                            </p>
820  <blockquote class="text">  <blockquote class="text">
821  <p>"OK"  <p>"OK"
822  </p>  </p>
823  </blockquote>  </blockquote><p>
824                        
825    </p>
826  <p>Example:  <p>Example:
827  </p>  </p>
828  <p></p>  <p>
829                            </p>
830  <blockquote class="text">  <blockquote class="text">
831  <p>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"  <p>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"
832  </p>  </p>
833  <p>S: "OK"  <p>S: "OK"
834  </p>  </p>
835  </blockquote>  </blockquote><p>
836                        
837    </p>
838  <p>Single line result sets are command specific. One  <p>Single line result sets are command specific. One
839                      example of a single line result set is an empty line.                      example of a single line result set is an empty line.
840                      Multi-line result sets are command specific and may                      Multi-line result sets are command specific and may
841                      include one or more lines of information. They MUST                      include one or more lines of information. They MUST
842                      always end with the following line:                      always end with the following line:
843  </p>  </p>
844  <p></p>  <p>
845                            </p>
846  <blockquote class="text">  <blockquote class="text">
847  <p>"."  <p>"."
848  </p>  </p>
849  </blockquote>  </blockquote><p>
850                        
851    </p>
852  <p>Example:  <p>Example:
853  </p>  </p>
854  <p></p>  <p>
855                            </p>
856  <blockquote class="text">  <blockquote class="text">
857  <p>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"  <p>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
858  </p>  </p>
# Line 608  Intellectual Property and Copyright Stat Line 872  Intellectual Property and Copyright Stat
872  </p>  </p>
873  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
874  </p>  </p>
875  </blockquote>  </blockquote><p>
876                        
877    </p>
878  <p>In addition to above mentioned formats, warnings and  <p>In addition to above mentioned formats, warnings and
879                      empty result sets MAY be indexed. In this case, they                      empty result sets MAY be indexed. In this case, they
880                      have the following formats respectively:                      have the following formats respectively:
881  </p>  </p>
882  <p></p>  <p>
883                            </p>
884  <ul class="text">  <ul class="text">
885  <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;"
886  </li>  </li>
887  <li>"OK[&lt;index&gt;]"  <li>"OK[&lt;index&gt;]"
888  </li>  </li>
889  </ul>  </ul><p>
890                        
891    </p>
892  <p>where &lt;index&gt; is command specific and is used  <p>where &lt;index&gt; is command specific and is used
893                      to indicate channel number that the result set was                      to indicate channel number that the result set was
894                      related to or other integer value.                      related to or other integer value.
# Line 631  Intellectual Property and Copyright Stat Line 898  Intellectual Property and Copyright Stat
898  </p>  </p>
899  <p>Examples:  <p>Examples:
900  </p>  </p>
901  <p></p>  <p>
902                            </p>
903  <blockquote class="text">  <blockquote class="text">
904  <p>C: "ADD CHANNEL"  <p>C: "ADD CHANNEL"
905  </p>  </p>
906  <p>S: "OK[12]"  <p>S: "OK[12]"
907  </p>  </p>
908  </blockquote>  </blockquote><p>
909                        
910  <p></p>  </p>
911    <p>
912                            </p>
913  <blockquote class="text">  <blockquote class="text">
914  <p>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"  <p>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"
915  </p>  </p>
916  <p>S: "WRN[0]:32:Sample rate not supported, using 44100 instead."  <p>S: "WRN[0]:32:Sample rate not supported, using 44100 instead."
917  </p>  </p>
918  </blockquote>  </blockquote><p>
919                        
920  <a name="rfc.section.4.2"></a><h4><a name="anchor7">4.2</a>&nbsp;Subscribe/notify communication method</h4>  </p>
921    <a name="anchor7"></a><br /><hr />
922    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
923    <a name="rfc.section.5.2"></a><h3>5.2.&nbsp;
924    Subscribe/notify communication method</h3>
925    
926  <p>This more sophisticated communication method is actually  <p>This more sophisticated communication method is actually
927                  only an extension of the simple request/response                  only an extension of the simple request/response
# Line 659  Intellectual Property and Copyright Stat Line 933  Intellectual Property and Copyright Stat
933                  as they happen on the server. The SUBSCRIBE command has the                  as they happen on the server. The SUBSCRIBE command has the
934                  following syntax:                  following syntax:
935  </p>  </p>
936  <p></p>  <p>
937                        </p>
938  <blockquote class="text">  <blockquote class="text">
939  <p>SUBSCRIBE &lt;event-id&gt;  <p>SUBSCRIBE &lt;event-id&gt;
940  </p>  </p>
941  </blockquote>  </blockquote><p>
942                    
943    </p>
944  <p>where &lt;event-id&gt; will be replaced by the respective  <p>where &lt;event-id&gt; will be replaced by the respective
945                  event that client wants to subscribe to. Upon receiving such                  event that client wants to subscribe to. Upon receiving such
946                  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 950  Intellectual Property and Copyright Stat
950                  time nature of their generation. Event messages have the                  time nature of their generation. Event messages have the
951                  following format:                  following format:
952  </p>  </p>
953  <p></p>  <p>
954                        </p>
955  <blockquote class="text">  <blockquote class="text">
956  <p>NOTIFY:&lt;event-id&gt;:&lt;custom-event-data&gt;  <p>NOTIFY:&lt;event-id&gt;:&lt;custom-event-data&gt;
957  </p>  </p>
958  </blockquote>  </blockquote><p>
959                    
960    </p>
961  <p>where &lt;event-id&gt; uniquely identifies the event that  <p>where &lt;event-id&gt; uniquely identifies the event that
962                  has occurred and &lt;custom-event-data&gt; is event                  has occurred and &lt;custom-event-data&gt; is event
963                  specific.                  specific.
# Line 687  Intellectual Property and Copyright Stat Line 965  Intellectual Property and Copyright Stat
965  <p>Several rules must be followed by the server when  <p>Several rules must be followed by the server when
966                  generating events:                  generating events:
967  </p>  </p>
968  <p></p>  <p>
969                        </p>
970  <ol class="text">  <ol class="text">
971  <li>Events MUST NOT be sent to any client who has not  <li>Events MUST NOT be sent to any client who has not
972                          issued an appropriate SUBSCRIBE command.                          issued an appropriate SUBSCRIBE command.
# Line 702  Intellectual Property and Copyright Stat Line 981  Intellectual Property and Copyright Stat
981                          middle of the event message as well as any other                          middle of the event message as well as any other
982                          response.                          response.
983  </li>  </li>
984  </ol>  </ol><p>
985                    
986    </p>
987  <p>If the client is not interested in a particular event  <p>If the client is not interested in a particular event
988                  anymore it MAY issue UNSUBSCRIBE command using the following                  anymore it MAY issue UNSUBSCRIBE command using the following
989                  syntax:                  syntax:
990  </p>  </p>
991  <p></p>  <p>
992                        </p>
993  <blockquote class="text">  <blockquote class="text">
994  <p>UNSUBSCRIBE &lt;event-id&gt;  <p>UNSUBSCRIBE &lt;event-id&gt;
995  </p>  </p>
996  </blockquote>  </blockquote><p>
997                    
998    </p>
999  <p>where &lt;event-id&gt; will be replace by the respective  <p>where &lt;event-id&gt; will be replace by the respective
1000                  event that client is no longer interested in receiving. For                  event that client is no longer interested in receiving. For
1001                  a list of supported events see <a class="info" href="#events">Section 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>.
1002  </p>  </p>
1003  <p>Example: the fill states of disk stream buffers have  <p>Example: the fill states of disk stream buffers have
1004                  changed on sampler channel 4 and the LinuxSampler instance                  changed on sampler channel 4 and the LinuxSampler instance
1005                  will react by sending the following message to all clients                  will react by sending the following message to all clients
1006                  who subscribed to this event:                  who subscribed to this event:
1007  </p>  </p>
1008  <p></p>  <p>
1009                        </p>
1010  <blockquote class="text">  <blockquote class="text">
1011  <p>NOTIFY:CHANNEL_BUFFER_FILL:4 [35]62%,[33]80%,[37]98%  <p>NOTIFY:CHANNEL_BUFFER_FILL:4 [35]62%,[33]80%,[37]98%
1012  </p>  </p>
1013  </blockquote>  </blockquote><p>
1014                    
1015    </p>
1016  <p>Which means there are currently three active streams on  <p>Which means there are currently three active streams on
1017                  sampler channel 4, where the stream with ID "35" is filled                  sampler channel 4, where the stream with ID "35" is filled
1018                  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 1043  Intellectual Property and Copyright Stat
1043                  If client reconnects it MUST resubscribe to all events that                  If client reconnects it MUST resubscribe to all events that
1044                  it wants to receive.                  it wants to receive.
1045  </p>  </p>
1046  <a name="anchor8"></a><br /><hr />  <a name="control_commands"></a><br /><hr />
1047  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1048  <a name="rfc.section.5"></a><h3>5.&nbsp;Description for control commands</h3>  <a name="rfc.section.6"></a><h3>6.&nbsp;
1049    Description for control commands</h3>
1050    
1051  <p>This chapter will describe the available control commands  <p>This chapter will describe the available control commands
1052              that can be sent on the TCP connection in detail. Some certain              that can be sent on the TCP connection in detail. Some certain
1053              commands (e.g. <a class="info" href="#GET CHANNEL INFO">"GET CHANNEL INFO"<span>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>
1054              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
1055              multiple-line responses. In this case LinuxSampler signals the              multiple-line responses. In this case LinuxSampler signals the
1056              end of the response by a "." (single dot) line.              end of the response by a "." (single dot) line.
1057  </p>  </p>
1058  <a name="rfc.section.5.1"></a><h4><a name="anchor9">5.1</a>&nbsp;Ignored lines and comments</h4>  <a name="anchor8"></a><br /><hr />
1059    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1060    <a name="rfc.section.6.1"></a><h3>6.1.&nbsp;
1061    Ignored lines and comments</h3>
1062    
1063  <p>White lines, that is lines which only contain space and  <p>White lines, that is lines which only contain space and
1064                  tabulator characters, and lines that start with a "#"                  tabulator characters, and lines that start with a "#"
# Line 778  Intellectual Property and Copyright Stat Line 1066  Intellectual Property and Copyright Stat
1066                  group commands and to place comments in a LSCP script                  group commands and to place comments in a LSCP script
1067                  file.                  file.
1068  </p>  </p>
1069  <a name="rfc.section.5.2"></a><h4><a name="anchor10">5.2</a>&nbsp;Configuring audio drivers</h4>  <a name="anchor9"></a><br /><hr />
1070    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1071    <a name="rfc.section.6.2"></a><h3>6.2.&nbsp;
1072    Configuring audio drivers</h3>
1073    
1074  <p>Instances of drivers in LinuxSampler are called devices.  <p>Instances of drivers in LinuxSampler are called devices.
1075                  You can use multiple audio devices simultaneously, e.g. to                  You can use multiple audio devices simultaneously, e.g. to
# Line 811  Intellectual Property and Copyright Stat Line 1102  Intellectual Property and Copyright Stat
1102                  what parameters drivers are offering, how to retrieve their                  what parameters drivers are offering, how to retrieve their
1103                  possible values, etc.                  possible values, etc.
1104  </p>  </p>
1105  <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="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />
1106    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1107    <a name="rfc.section.6.2.1"></a><h3>6.2.1.&nbsp;
1108    Getting amount of available audio output drivers</h3>
1109    
1110  <p>Use the following command to get the number of  <p>Use the following command to get the number of
1111                      audio output drivers currently available for the                      audio output drivers currently available for the
1112                      LinuxSampler instance:                      LinuxSampler instance:
1113  </p>  </p>
1114  <p></p>  <p>
1115                            </p>
1116  <blockquote class="text">  <blockquote class="text">
1117  <p>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS  <p>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS
1118  </p>  </p>
1119  </blockquote>  </blockquote><p>
1120                        
1121    </p>
1122  <p>Possible Answers:  <p>Possible Answers:
1123  </p>  </p>
1124  <p></p>  <p>
1125                            </p>
1126  <blockquote class="text">  <blockquote class="text">
1127  <p>LinuxSampler will answer by sending the  <p>LinuxSampler will answer by sending the
1128                              number of audio output drivers.                              number of audio output drivers.
1129  </p>  </p>
1130  </blockquote>  </blockquote><p>
1131                        
1132    </p>
1133  <p>Example:  <p>Example:
1134  </p>  </p>
1135  <p></p>  <p>
1136                            </p>
1137  <blockquote class="text">  <blockquote class="text">
1138  <p>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"  <p>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"
1139  </p>  </p>
1140  <p>S: "2"  <p>S: "2"
1141  </p>  </p>
1142  </blockquote>  </blockquote><p>
1143                        
1144  <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>
1145    <a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />
1146    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1147    <a name="rfc.section.6.2.2"></a><h3>6.2.2.&nbsp;
1148    Getting all available audio output drivers</h3>
1149    
1150  <p>Use the following command to list all audio output  <p>Use the following command to list all audio output
1151                      drivers currently available for the LinuxSampler                      drivers currently available for the LinuxSampler
1152                      instance:                      instance:
1153  </p>  </p>
1154  <p></p>  <p>
1155                            </p>
1156  <blockquote class="text">  <blockquote class="text">
1157  <p>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS  <p>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS
1158  </p>  </p>
1159  </blockquote>  </blockquote><p>
1160                        
1161    </p>
1162  <p>Possible Answers:  <p>Possible Answers:
1163  </p>  </p>
1164  <p></p>  <p>
1165                            </p>
1166  <blockquote class="text">  <blockquote class="text">
1167  <p>LinuxSampler will answer by sending comma  <p>LinuxSampler will answer by sending comma
1168                              separated character strings, each symbolizing an                              separated character strings, each symbolizing an
1169                              audio output driver.                              audio output driver.
1170  </p>  </p>
1171  </blockquote>  </blockquote><p>
1172                        
1173    </p>
1174  <p>Example:  <p>Example:
1175  </p>  </p>
1176  <p></p>  <p>
1177                            </p>
1178  <blockquote class="text">  <blockquote class="text">
1179  <p>C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"  <p>C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"
1180  </p>  </p>
1181  <p>S: "ALSA,JACK"  <p>S: "ALSA,JACK"
1182  </p>  </p>
1183  </blockquote>  </blockquote><p>
1184                        
1185  <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>
1186                  output driver</h4>  <a name="GET AUDIO_OUTPUT_DRIVER INFO"></a><br /><hr />
1187    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1188    <a name="rfc.section.6.2.3"></a><h3>6.2.3.&nbsp;
1189    Getting information about a specific audio
1190                    output driver</h3>
1191    
1192  <p>Use the following command to get detailed information  <p>Use the following command to get detailed information
1193                      about a specific audio output driver:                      about a specific audio output driver:
1194  </p>  </p>
1195  <p></p>  <p>
1196                            </p>
1197  <blockquote class="text">  <blockquote class="text">
1198  <p>GET AUDIO_OUTPUT_DRIVER INFO  <p>GET AUDIO_OUTPUT_DRIVER INFO
1199                               &lt;audio-output-driver&gt;                               &lt;audio-output-driver&gt;
1200  </p>  </p>
1201  </blockquote>  </blockquote><p>
1202                        
1203    </p>
1204  <p>Where &lt;audio-output-driver&gt; is the name of the  <p>Where &lt;audio-output-driver&gt; is the name of the
1205                      audio output driver, returned by the                      audio output driver, returned by the
1206                      <a class="info" href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span>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.
1207  </p>  </p>
1208  <p>Possible Answers:  <p>Possible Answers:
1209  </p>  </p>
1210  <p></p>  <p>
1211                            </p>
1212  <blockquote class="text">  <blockquote class="text">
1213  <p>LinuxSampler will answer by sending a  <p>LinuxSampler will answer by sending a
1214                              &lt;CRLF&gt; separated list. Each answer line                              &lt;CRLF&gt; separated list. Each answer line
# Line 904  Intellectual Property and Copyright Stat Line 1219  Intellectual Property and Copyright Stat
1219                              following information categories are                              following information categories are
1220                              defined:                              defined:
1221  </p>  </p>
1222  <p></p>  <p>
1223                                  </p>
1224  <blockquote class="text">  <blockquote class="text">
1225  <p>DESCRIPTION -  <p>DESCRIPTION -
1226                                      </p>                                      </p>
# Line 913  Intellectual Property and Copyright Stat Line 1229  Intellectual Property and Copyright Stat
1229                                        audio output driver                                        audio output driver
1230  </p>  </p>
1231  </blockquote>  </blockquote>
1232                                      
1233    
1234  <p>VERSION -  <p>VERSION -
1235                                      </p>                                      </p>
# Line 921  Intellectual Property and Copyright Stat Line 1238  Intellectual Property and Copyright Stat
1238                                        driver's version                                        driver's version
1239  </p>  </p>
1240  </blockquote>  </blockquote>
1241                                      
1242    
1243  <p>PARAMETERS -  <p>PARAMETERS -
1244                                      </p>                                      </p>
# Line 933  Intellectual Property and Copyright Stat Line 1251  Intellectual Property and Copyright Stat
1251                                        output drivers                                        output drivers
1252  </p>  </p>
1253  </blockquote>  </blockquote>
1254                                      
1255    
1256  </blockquote>  </blockquote>
1257                                
1258    
1259  <p>The mentioned fields above don't have to be  <p>The mentioned fields above don't have to be
1260                              in particular order.                              in particular order.
1261  </p>  </p>
1262  </blockquote>  </blockquote><p>
1263                        
1264    </p>
1265  <p>Example:  <p>Example:
1266  </p>  </p>
1267  <p></p>  <p>
1268                          </p>
1269  <blockquote class="text">  <blockquote class="text">
1270  <p>C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"  <p>C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"
1271  </p>  </p>
# Line 958  Intellectual Property and Copyright Stat Line 1280  Intellectual Property and Copyright Stat
1280  </p>  </p>
1281  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1282  </p>  </p>
1283  </blockquote>  </blockquote><p>
1284                        
1285  <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>
1286                  output driver parameter</h4>  <a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"></a><br /><hr />
1287    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1288    <a name="rfc.section.6.2.4"></a><h3>6.2.4.&nbsp;
1289    Getting information about specific audio
1290                    output driver parameter</h3>
1291    
1292  <p>Use the following command to get detailed information  <p>Use the following command to get detailed information
1293                      about a  specific audio output driver parameter:                      about a  specific audio output driver parameter:
1294  </p>  </p>
1295  <p></p>  <p>
1296                            </p>
1297  <blockquote class="text">  <blockquote class="text">
1298  <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;]
1299  </p>  </p>
1300  </blockquote>  </blockquote><p>
1301                        
1302    </p>
1303  <p>Where &lt;audio&gt; is the name of the audio output  <p>Where &lt;audio&gt; is the name of the audio output
1304                      driver as returned by the <a class="info" href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span>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,
1305                      &lt;prm&gt; a specific parameter name for which information should be                      &lt;prm&gt; a specific parameter name for which information should be
1306                      obtained (as returned by the                      obtained (as returned by the
1307                      <a class="info" href="#GET AUDIO_OUTPUT_DRIVER INFO">"GET AUDIO_OUTPUT_DRIVER INFO"<span>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
1308                      &lt;deplist&gt; is an optional list of parameters on which the sought                      &lt;deplist&gt; is an optional list of parameters on which the sought
1309                      parameter &lt;prm&gt; depends on, &lt;deplist&gt; is a list of key-value                      parameter &lt;prm&gt; depends on, &lt;deplist&gt; is a list of key-value
1310                      pairs in form of "key1=val1 key2=val2 ...", where character string values                      pairs in form of "key1=val1 key2=val2 ...", where character string values
# Line 987  Intellectual Property and Copyright Stat Line 1315  Intellectual Property and Copyright Stat
1315  </p>  </p>
1316  <p>Possible Answers:  <p>Possible Answers:
1317  </p>  </p>
1318  <p></p>  <p>
1319                            </p>
1320  <blockquote class="text">  <blockquote class="text">
1321  <p>LinuxSampler will answer by sending a  <p>LinuxSampler will answer by sending a
1322                              &lt;CRLF&gt; separated list.                              &lt;CRLF&gt; separated list.
# Line 1000  Intellectual Property and Copyright Stat Line 1329  Intellectual Property and Copyright Stat
1329                              which is only shown dependently to given driver parameter. At                              which is only shown dependently to given driver parameter. At
1330                              the moment the following information categories are defined:                              the moment the following information categories are defined:
1331  </p>  </p>
1332  </blockquote>  </blockquote><p>
1333                        
1334  <p></p>  </p>
1335    <p>
1336                            </p>
1337  <blockquote class="text">  <blockquote class="text">
1338  <p>TYPE -  <p>TYPE -
1339                                </p>                                </p>
# Line 1014  Intellectual Property and Copyright Stat Line 1345  Intellectual Property and Copyright Stat
1345                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
1346  </p>  </p>
1347  </blockquote>  </blockquote>
1348                                
1349    
1350  <p>DESCRIPTION -  <p>DESCRIPTION -
1351                                </p>                                </p>
# Line 1022  Intellectual Property and Copyright Stat Line 1354  Intellectual Property and Copyright Stat
1354                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
1355  </p>  </p>
1356  </blockquote>  </blockquote>
1357                                
1358    
1359  <p>MANDATORY -  <p>MANDATORY -
1360                                </p>                                </p>
1361  <blockquote class="text">  <blockquote class="text">
1362  <p>either true or false, defines if this parameter must be  <p>either true or false, defines if this parameter must be
1363                                  given when the device is to be created with the                                  given when the device is to be created with the
1364                                  <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'<span>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>
1365                                  command (always returned, no matter which driver parameter)                                  command (always returned, no matter which driver parameter)
1366  </p>  </p>
1367  </blockquote>  </blockquote>
1368                                
1369    
1370  <p>FIX -  <p>FIX -
1371                                </p>                                </p>
1372  <blockquote class="text">  <blockquote class="text">
1373  <p>either true or false, if false then this parameter can  <p>either true or false, if false then this parameter can
1374                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
1375                                  the <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'<span>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>
1376                                  command (always returned, no matter which driver parameter)                                  command (always returned, no matter which driver parameter)
1377  </p>  </p>
1378  </blockquote>  </blockquote>
1379                                
1380    
1381  <p>MULTIPLICITY -  <p>MULTIPLICITY -
1382                                </p>                                </p>
# Line 1052  Intellectual Property and Copyright Stat Line 1387  Intellectual Property and Copyright Stat
1387                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
1388  </p>  </p>
1389  </blockquote>  </blockquote>
1390                                
1391    
1392  <p>DEPENDS -  <p>DEPENDS -
1393                                </p>                                </p>
1394  <blockquote class="text">  <blockquote class="text">
1395  <p>comma separated list of paramters this parameter depends  <p>comma separated list of parameters this parameter depends
1396                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',
1397                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these
1398                                  listed parameters, for example assuming that an audio                                  listed parameters, for example assuming that an audio
# Line 1068  Intellectual Property and Copyright Stat Line 1404  Intellectual Property and Copyright Stat
1404                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
1405  </p>  </p>
1406  </blockquote>  </blockquote>
1407                                
1408    
1409  <p>DEFAULT -  <p>DEFAULT -
1410                                </p>                                </p>
1411  <blockquote class="text">  <blockquote class="text">
1412  <p>reflects the default value for this parameter which is  <p>reflects the default value for this parameter which is
1413                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
1414                                  given with the <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'<span>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,
1415                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
1416                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
1417                                  apostrophes (')                                  apostrophes (')
1418                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
1419  </p>  </p>
1420  </blockquote>  </blockquote>
1421                                
1422    
1423  <p>RANGE_MIN -  <p>RANGE_MIN -
1424                                </p>                                </p>
# Line 1092  Intellectual Property and Copyright Stat Line 1430  Intellectual Property and Copyright Stat
1430                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
1431  </p>  </p>
1432  </blockquote>  </blockquote>
1433                                
1434    
1435  <p>RANGE_MAX -  <p>RANGE_MAX -
1436                                </p>                                </p>
# Line 1103  Intellectual Property and Copyright Stat Line 1442  Intellectual Property and Copyright Stat
1442                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
1443  </p>  </p>
1444  </blockquote>  </blockquote>
1445                                
1446    
1447  <p>POSSIBILITIES -  <p>POSSIBILITIES -
1448                                </p>                                </p>
# Line 1113  Intellectual Property and Copyright Stat Line 1453  Intellectual Property and Copyright Stat
1453                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
1454  </p>  </p>
1455  </blockquote>  </blockquote>
1456                                
1457    
1458  </blockquote>  </blockquote><p>
1459                        
1460    </p>
1461  <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.
1462  </p>  </p>
1463  <p>Examples:  <p>Examples:
1464  </p>  </p>
1465  <p></p>  <p>
1466                            </p>
1467  <blockquote class="text">  <blockquote class="text">
1468  <p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"  <p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"
1469  </p>  </p>
# Line 1140  Intellectual Property and Copyright Stat Line 1483  Intellectual Property and Copyright Stat
1483  </p>  </p>
1484  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1485  </p>  </p>
1486  </blockquote>  </blockquote><p>
1487                        
1488  <p></p>  </p>
1489    <p>
1490                            </p>
1491  <blockquote class="text">  <blockquote class="text">
1492  <p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"  <p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"
1493  </p>  </p>
# Line 1162  Intellectual Property and Copyright Stat Line 1507  Intellectual Property and Copyright Stat
1507  </p>  </p>
1508  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1509  </p>  </p>
1510  </blockquote>  </blockquote><p>
1511                        
1512  <p></p>  </p>
1513    <p>
1514                            </p>
1515  <blockquote class="text">  <blockquote class="text">
1516  <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'"
1517  </p>  </p>
# Line 1188  Intellectual Property and Copyright Stat Line 1535  Intellectual Property and Copyright Stat
1535  </p>  </p>
1536  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1537  </p>  </p>
1538  </blockquote>  </blockquote><p>
1539                        
1540  <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>
1541    <a name="CREATE AUDIO_OUTPUT_DEVICE"></a><br /><hr />
1542    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1543    <a name="rfc.section.6.2.5"></a><h3>6.2.5.&nbsp;
1544    Creating an audio output device</h3>
1545    
1546  <p>Use the following command to create a new audio output device for  the desired audio output system:  <p>Use the following command to create a new audio output device for  the desired audio output system:
1547  </p>  </p>
1548  <p></p>  <p>
1549                            </p>
1550  <blockquote class="text">  <blockquote class="text">
1551  <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;]
1552  </p>  </p>
1553  </blockquote>  </blockquote><p>
1554                        
1555    </p>
1556  <p>Where &lt;audio-output-driver&gt; should be replaced by the desired audio  <p>Where &lt;audio-output-driver&gt; should be replaced by the desired audio
1557                      output system and &lt;param-list&gt; by an optional list of driver                      output system as returned by the
1558                        <a class='info' href='#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS'>"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class='info'>Getting all available audio output drivers</span><span>)</span></a>
1559                        command and &lt;param-list&gt; by an optional list of driver
1560                      specific parameters in form of "key1=val1 key2=val2 ...", where                      specific parameters in form of "key1=val1 key2=val2 ...", where
1561                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
1562                      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 1565  Intellectual Property and Copyright Stat
1565  </p>  </p>
1566  <p>Possible Answers:  <p>Possible Answers:
1567  </p>  </p>
1568  <p></p>  <p>
1569                            </p>
1570  <blockquote class="text">  <blockquote class="text">
1571  <p>"OK[&lt;device-id&gt;]" -  <p>"OK[&lt;device-id&gt;]" -
1572                                  </p>                                  </p>
# Line 1219  Intellectual Property and Copyright Stat Line 1575  Intellectual Property and Copyright Stat
1575                                      &lt;device-id&gt; is the numerical ID of the new device                                      &lt;device-id&gt; is the numerical ID of the new device
1576  </p>  </p>
1577  </blockquote>  </blockquote>
1578                                
1579    
1580  <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;" -
1581                                  </p>                                  </p>
# Line 1231  Intellectual Property and Copyright Stat Line 1588  Intellectual Property and Copyright Stat
1588                                      warning message                                      warning message
1589  </p>  </p>
1590  </blockquote>  </blockquote>
1591                                
1592    
1593  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1594                                  </p>                                  </p>
# Line 1238  Intellectual Property and Copyright Stat Line 1596  Intellectual Property and Copyright Stat
1596  <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
1597  </p>  </p>
1598  </blockquote>  </blockquote>
1599                                
1600    
1601  </blockquote>  </blockquote><p>
1602                        
1603    </p>
1604  <p>Examples:  <p>Examples:
1605  </p>  </p>
1606  <p></p>  <p>
1607                            </p>
1608  <blockquote class="text">  <blockquote class="text">
1609  <p>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"  <p>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"
1610  </p>  </p>
1611  <p>S: "OK[0]"  <p>S: "OK[0]"
1612  </p>  </p>
1613  </blockquote>  </blockquote><p>
1614                        
1615  <p></p>  </p>
1616    <p>
1617                            </p>
1618  <blockquote class="text">  <blockquote class="text">
1619  <p>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"  <p>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"
1620  </p>  </p>
1621  <p>S: "OK[1]"  <p>S: "OK[1]"
1622  </p>  </p>
1623  </blockquote>  </blockquote><p>
1624                        
1625  <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>
1626    <a name="DESTROY AUDIO_OUTPUT_DEVICE"></a><br /><hr />
1627    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1628    <a name="rfc.section.6.2.6"></a><h3>6.2.6.&nbsp;
1629    Destroying an audio output device</h3>
1630    
1631  <p>Use the following command to destroy a created output device:  <p>Use the following command to destroy a created output device:
1632  </p>  </p>
1633  <p></p>  <p>
1634                            </p>
1635  <blockquote class="text">  <blockquote class="text">
1636  <p>DESTROY AUDIO_OUTPUT_DEVICE &lt;device-id&gt;  <p>DESTROY AUDIO_OUTPUT_DEVICE &lt;device-id&gt;
1637  </p>  </p>
1638  </blockquote>  </blockquote><p>
1639                        
1640    </p>
1641  <p>Where &lt;device-id&gt; should be replaced by the numerical ID of the  <p>Where &lt;device-id&gt; should be replaced by the numerical ID of the
1642                      audio output device as given by the                      audio output device as given by the
1643                      <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"<span>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>
1644                      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>
1645                      command.                      command.
1646  </p>  </p>
1647  <p>Possible Answers:  <p>Possible Answers:
1648  </p>  </p>
1649  <p></p>  <p>
1650                            </p>
1651  <blockquote class="text">  <blockquote class="text">
1652  <p>"OK" -  <p>"OK" -
1653                                  </p>                                  </p>
# Line 1285  Intellectual Property and Copyright Stat Line 1655  Intellectual Property and Copyright Stat
1655  <p>in case the device was successfully destroyed  <p>in case the device was successfully destroyed
1656  </p>  </p>
1657  </blockquote>  </blockquote>
1658                                
1659    
1660  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1661                                  </p>                                  </p>
# Line 1296  Intellectual Property and Copyright Stat Line 1667  Intellectual Property and Copyright Stat
1667                                      warning code and warning message                                      warning code and warning message
1668  </p>  </p>
1669  </blockquote>  </blockquote>
1670                                
1671    
1672  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1673                                  </p>                                  </p>
# Line 1304  Intellectual Property and Copyright Stat Line 1676  Intellectual Property and Copyright Stat
1676                                      error message                                      error message
1677  </p>  </p>
1678  </blockquote>  </blockquote>
1679                                
1680    
1681  </blockquote>  </blockquote><p>
1682                        
1683    </p>
1684  <p>Example:  <p>Example:
1685  </p>  </p>
1686  <p></p>  <p>
1687                            </p>
1688  <blockquote class="text">  <blockquote class="text">
1689  <p>C: "DESTROY AUDIO_OUTPUT_DEVICE 0"  <p>C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
1690  </p>  </p>
1691  <p>S: "OK"  <p>S: "OK"
1692  </p>  </p>
1693  </blockquote>  </blockquote><p>
1694                        
1695  <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>
1696    <a name="GET AUDIO_OUTPUT_DEVICES"></a><br /><hr />
1697    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1698    <a name="rfc.section.6.2.7"></a><h3>6.2.7.&nbsp;
1699    Getting all created audio output device count</h3>
1700    
1701  <p>Use the following command to count all created audio output devices:  <p>Use the following command to count all created audio output devices:
1702  </p>  </p>
1703  <p></p>  <p>
1704                            </p>
1705  <blockquote class="text">  <blockquote class="text">
1706  <p>GET AUDIO_OUTPUT_DEVICES  <p>GET AUDIO_OUTPUT_DEVICES
1707  </p>  </p>
1708  </blockquote>  </blockquote><p>
1709                        
1710    </p>
1711  <p>Possible Answers:  <p>Possible Answers:
1712  </p>  </p>
1713  <p></p>  <p>
1714                            </p>
1715  <blockquote class="text">  <blockquote class="text">
1716  <p>LinuxSampler will answer by sending the current number of all  <p>LinuxSampler will answer by sending the current number of all
1717                              audio output devices.                              audio output devices.
1718  </p>  </p>
1719  </blockquote>  </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: "GET AUDIO_OUTPUT_DEVICES"  <p>C: "GET AUDIO_OUTPUT_DEVICES"
1728  </p>  </p>
1729  <p>S: "4"  <p>S: "4"
1730  </p>  </p>
1731  </blockquote>  </blockquote><p>
1732                        
1733  <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>
1734    <a name="LIST AUDIO_OUTPUT_DEVICES"></a><br /><hr />
1735    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1736    <a name="rfc.section.6.2.8"></a><h3>6.2.8.&nbsp;
1737    Getting all created audio output device list</h3>
1738    
1739  <p>Use the following command to list all created audio output devices:  <p>Use the following command to list all created audio output devices:
1740  </p>  </p>
1741  <p></p>  <p>
1742                            </p>
1743  <blockquote class="text">  <blockquote class="text">
1744  <p>LIST AUDIO_OUTPUT_DEVICES  <p>LIST AUDIO_OUTPUT_DEVICES
1745  </p>  </p>
1746  </blockquote>  </blockquote><p>
1747                        
1748    </p>
1749  <p>Possible Answers:  <p>Possible Answers:
1750  </p>  </p>
1751  <p></p>  <p>
1752                            </p>
1753  <blockquote class="text">  <blockquote class="text">
1754  <p>LinuxSampler will answer by sending a comma separated list with  <p>LinuxSampler will answer by sending a comma separated list with
1755                              the numerical IDs of all audio output devices.                              the numerical IDs of all audio output devices.
1756  </p>  </p>
1757  </blockquote>  </blockquote><p>
1758                        
1759    </p>
1760  <p>Example:  <p>Example:
1761  </p>  </p>
1762  <p></p>  <p>
1763                            </p>
1764  <blockquote class="text">  <blockquote class="text">
1765  <p>C: "LIST AUDIO_OUTPUT_DEVICES"  <p>C: "LIST AUDIO_OUTPUT_DEVICES"
1766  </p>  </p>
1767  <p>S: "0,1,4,5"  <p>S: "0,1,4,5"
1768  </p>  </p>
1769  </blockquote>  </blockquote><p>
1770                        
1771  <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>
1772    <a name="GET AUDIO_OUTPUT_DEVICE INFO"></a><br /><hr />
1773    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1774    <a name="rfc.section.6.2.9"></a><h3>6.2.9.&nbsp;
1775    Getting current settings of an audio output device</h3>
1776    
1777  <p>Use the following command to get current settings of a specific, created audio output device:  <p>Use the following command to get current settings of a specific, created audio output device:
1778  </p>  </p>
1779  <p></p>  <p>
1780                            </p>
1781  <blockquote class="text">  <blockquote class="text">
1782  <p>GET AUDIO_OUTPUT_DEVICE INFO &lt;device-id&gt;  <p>GET AUDIO_OUTPUT_DEVICE INFO &lt;device-id&gt;
1783  </p>  </p>
1784  </blockquote>  </blockquote><p>
1785                        
1786    </p>
1787  <p>Where &lt;device-id&gt; should be replaced by numerical ID  <p>Where &lt;device-id&gt; should be replaced by numerical ID
1788                      of the audio output device as e.g. returned by the                      of the audio output device as e.g. returned by the
1789                      <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span>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.
1790  </p>  </p>
1791  <p>Possible Answers:  <p>Possible Answers:
1792  </p>  </p>
# Line 1399  Intellectual Property and Copyright Stat Line 1798  Intellectual Property and Copyright Stat
1798                      encapsulated into apostrophes ('). At the moment the following                      encapsulated into apostrophes ('). At the moment the following
1799                      information categories are defined (independently of device):                      information categories are defined (independently of device):
1800  </p>  </p>
1801  <p></p>  <p>
1802                            </p>
1803  <blockquote class="text">  <blockquote class="text">
1804  <p>DRIVER -  <p>DRIVER -
1805                                  </p>                                  </p>
1806  <blockquote class="text">  <blockquote class="text">
1807  <p>identifier of the used audio output driver, as also  <p>identifier of the used audio output driver, as also
1808                                      returned by the                                      returned by the
1809                                      <a class="info" href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span>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>
1810                                      command                                      command
1811  </p>  </p>
1812  </blockquote>  </blockquote>
1813                                
1814    
1815  <p>CHANNELS -  <p>CHANNELS -
1816                                  </p>                                  </p>
# Line 1418  Intellectual Property and Copyright Stat Line 1819  Intellectual Property and Copyright Stat
1819                                      offers                                      offers
1820  </p>  </p>
1821  </blockquote>  </blockquote>
1822                                
1823    
1824  <p>SAMPLERATE -  <p>SAMPLERATE -
1825                                  </p>                                  </p>
# Line 1425  Intellectual Property and Copyright Stat Line 1827  Intellectual Property and Copyright Stat
1827  <p>playback sample rate the device uses  <p>playback sample rate the device uses
1828  </p>  </p>
1829  </blockquote>  </blockquote>
1830                                
1831    
1832  <p>ACTIVE -  <p>ACTIVE -
1833                                  </p>                                  </p>
# Line 1435  Intellectual Property and Copyright Stat Line 1838  Intellectual Property and Copyright Stat
1838                                      any audio                                      any audio
1839  </p>  </p>
1840  </blockquote>  </blockquote>
1841                                
1842    
1843  </blockquote>  </blockquote><p>
1844                        
1845    </p>
1846  <p>The mentioned fields above don't have to be in particular  <p>The mentioned fields above don't have to be in particular
1847                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
1848                      returned by all audio output devices. Every audio output driver                      returned by all audio output devices. Every audio output driver
1849                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
1850                      <a class="info" href="#GET AUDIO_OUTPUT_DRIVER INFO">Section 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>)
1851                      which are also returned by this command.                      which are also returned by this command.
1852  </p>  </p>
1853  <p>Example:  <p>Example:
1854  </p>  </p>
1855  <p></p>  <p>
1856                            </p>
1857  <blockquote class="text">  <blockquote class="text">
1858  <p>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"  <p>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
1859  </p>  </p>
# Line 1467  Intellectual Property and Copyright Stat Line 1873  Intellectual Property and Copyright Stat
1873  </p>  </p>
1874  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
1875  </p>  </p>
1876  </blockquote>  </blockquote><p>
1877                        
1878  <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>
1879    <a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER"></a><br /><hr />
1880    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1881    <a name="rfc.section.6.2.10"></a><h3>6.2.10.&nbsp;
1882    Changing settings of audio output devices</h3>
1883    
1884  <p>Use the following command to alter a specific setting of a created audio output device:  <p>Use the following command to alter a specific setting of a created audio output device:
1885  </p>  </p>
1886  <p></p>  <p>
1887                            </p>
1888  <blockquote class="text">  <blockquote class="text">
1889  <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;
1890  </p>  </p>
1891  </blockquote>  </blockquote><p>
1892                        
1893    </p>
1894  <p>Where &lt;device-id&gt; should be replaced by the numerical ID of the  <p>Where &lt;device-id&gt; should be replaced by the numerical ID of the
1895                      audio output device, &lt;key&gt; by the name of the parameter to change                      audio output device as given by the
1896                        <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
1897                        or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
1898                        command, &lt;key&gt; by the name of the parameter to change
1899                      and &lt;value&gt; by the new value for this parameter.                      and &lt;value&gt; by the new value for this parameter.
1900  </p>  </p>
1901  <p>Possible Answers:  <p>Possible Answers:
1902  </p>  </p>
1903  <p></p>  <p>
1904                            </p>
1905  <blockquote class="text">  <blockquote class="text">
1906  <p>"OK" -  <p>"OK" -
1907                                  </p>                                  </p>
# Line 1493  Intellectual Property and Copyright Stat Line 1909  Intellectual Property and Copyright Stat
1909  <p>in case setting was successfully changed  <p>in case setting was successfully changed
1910  </p>  </p>
1911  </blockquote>  </blockquote>
1912                                
1913    
1914  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1915                                  </p>                                  </p>
# Line 1502  Intellectual Property and Copyright Stat Line 1919  Intellectual Property and Copyright Stat
1919                                      warning code and warning message                                      warning code and warning message
1920  </p>  </p>
1921  </blockquote>  </blockquote>
1922                                
1923    
1924  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1925                                  </p>                                  </p>
# Line 1510  Intellectual Property and Copyright Stat Line 1928  Intellectual Property and Copyright Stat
1928                                      error message                                      error message
1929  </p>  </p>
1930  </blockquote>  </blockquote>
1931                                
1932    
1933  </blockquote>  </blockquote><p>
1934                        
1935    </p>
1936  <p>Example:  <p>Example:
1937  </p>  </p>
1938  <p></p>  <p>
1939                            </p>
1940  <blockquote class="text">  <blockquote class="text">
1941  <p>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"  <p>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"
1942  </p>  </p>
1943  <p>S: "OK"  <p>S: "OK"
1944  </p>  </p>
1945  </blockquote>  </blockquote><p>
1946                        
1947  <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>
1948    <a name="GET AUDIO_OUTPUT_CHANNEL INFO"></a><br /><hr />
1949    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
1950    <a name="rfc.section.6.2.11"></a><h3>6.2.11.&nbsp;
1951    Getting information about an audio channel</h3>
1952    
1953  <p>Use the following command to get information about an audio channel:  <p>Use the following command to get information about an audio channel:
1954  </p>  </p>
1955  <p></p>  <p>
1956                            </p>
1957  <blockquote class="text">  <blockquote class="text">
1958  <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;
1959  </p>  </p>
1960  </blockquote>  </blockquote><p>
1961                        
1962  <p>Where &lt;device-id&gt; is the numerical ID of the audio output device  </p>
1963                      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
1964                        <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
1965                        or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
1966                        command and &lt;audio-chan&gt; the audio channel number.
1967  </p>  </p>
1968  <p>Possible Answers:  <p>Possible Answers:
1969  </p>  </p>
1970  <p></p>  <p>
1971                            </p>
1972  <blockquote class="text">  <blockquote class="text">
1973  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1974                              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 1976  Intellectual Property and Copyright Stat
1976                              the info character string to that info category. At the moment                              the info character string to that info category. At the moment
1977                              the following information categories are defined:                              the following information categories are defined:
1978  </p>  </p>
1979  <p></p>  <p>
1980                                    </p>
1981  <blockquote class="text">  <blockquote class="text">
1982  <p>NAME -  <p>NAME -
1983                                          </p>                                          </p>
# Line 1555  Intellectual Property and Copyright Stat Line 1986  Intellectual Property and Copyright Stat
1986                                              doesn't have to be unique (always returned by all audio channels)                                              doesn't have to be unique (always returned by all audio channels)
1987  </p>  </p>
1988  </blockquote>  </blockquote>
1989                                        
1990    
1991  <p>IS_MIX_CHANNEL -  <p>IS_MIX_CHANNEL -
1992                                          </p>                                          </p>
# Line 1567  Intellectual Property and Copyright Stat Line 1999  Intellectual Property and Copyright Stat
1999                                              (always returned by all audio channels)                                              (always returned by all audio channels)
2000  </p>  </p>
2001  </blockquote>  </blockquote>
2002                                        
2003    
2004  <p>MIX_CHANNEL_DESTINATION -  <p>MIX_CHANNEL_DESTINATION -
2005                                          </p>                                          </p>
# Line 1578  Intellectual Property and Copyright Stat Line 2011  Intellectual Property and Copyright Stat
2011                                              (only returned in case the audio channel is mix channel)                                              (only returned in case the audio channel is mix channel)
2012  </p>  </p>
2013  </blockquote>  </blockquote>
2014                                        
2015    
2016  </blockquote>  </blockquote>
2017                                
2018    
2019  </blockquote>  </blockquote><p>
2020                        
2021    </p>
2022  <p>The mentioned fields above don't have to be in particular  <p>The mentioned fields above don't have to be in particular
2023                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
2024                      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 2028  Intellectual Property and Copyright Stat
2028  </p>  </p>
2029  <p>Examples:  <p>Examples:
2030  </p>  </p>
2031  <p></p>  <p>
2032                            </p>
2033  <blockquote class="text">  <blockquote class="text">
2034  <p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"  <p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"
2035  </p>  </p>
# Line 1602  Intellectual Property and Copyright Stat Line 2039  Intellectual Property and Copyright Stat
2039  </p>  </p>
2040  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
2041  </p>  </p>
2042  </blockquote>  </blockquote><p>
2043                        
2044  <p></p>  </p>
2045    <p>
2046                            </p>
2047  <blockquote class="text">  <blockquote class="text">
2048  <p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 1"  <p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 1"
2049  </p>  </p>
# Line 1614  Intellectual Property and Copyright Stat Line 2053  Intellectual Property and Copyright Stat
2053  </p>  </p>
2054  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
2055  </p>  </p>
2056  </blockquote>  </blockquote><p>
2057                        
2058  <p></p>  </p>
2059    <p>
2060                            </p>
2061  <blockquote class="text">  <blockquote class="text">
2062  <p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 2"  <p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 2"
2063  </p>  </p>
# Line 1628  Intellectual Property and Copyright Stat Line 2069  Intellectual Property and Copyright Stat
2069  </p>  </p>
2070  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
2071  </p>  </p>
2072  </blockquote>  </blockquote><p>
2073                        
2074  <p></p>  </p>
2075    <p>
2076                            </p>
2077  <blockquote class="text">  <blockquote class="text">
2078  <p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"  <p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"
2079  </p>  </p>
# Line 1642  Intellectual Property and Copyright Stat Line 2085  Intellectual Property and Copyright Stat
2085  </p>  </p>
2086  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
2087  </p>  </p>
2088  </blockquote>  </blockquote><p>
2089                        
2090  <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>
2091    <a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"></a><br /><hr />
2092    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2093    <a name="rfc.section.6.2.12"></a><h3>6.2.12.&nbsp;
2094    Getting information about specific audio channel parameter</h3>
2095    
2096  <p>Use the following command to get detailed information about specific audio channel parameter:  <p>Use the following command to get detailed information about specific audio channel parameter:
2097  </p>  </p>
2098  <p></p>  <p>
2099                            </p>
2100  <blockquote class="text">  <blockquote class="text">
2101  <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;
2102  </p>  </p>
2103  </blockquote>  </blockquote><p>
2104                        
2105  <p>Where &lt;dev-id&gt; is the numerical ID of the audio output device as returned  </p>
2106                      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
2107                        <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
2108                        or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
2109                      command, &lt;chan&gt; the audio channel number                      command, &lt;chan&gt; the audio channel number
2110                      and &lt;param&gt; a specific channel parameter name for which information should                      and &lt;param&gt; a specific channel parameter name for which information should
2111                      be obtained (as returned by the <a class="info" href="#GET AUDIO_OUTPUT_CHANNEL INFO">"GET AUDIO_OUTPUT_CHANNEL INFO"<span>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).
2112  </p>  </p>
2113  <p>Possible Answers:  <p>Possible Answers:
2114  </p>  </p>
2115  <p></p>  <p>
2116                            </p>
2117  <blockquote class="text">  <blockquote class="text">
2118  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
2119                              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 2124  Intellectual Property and Copyright Stat
2124                              which is only shown dependently to the given audio channel. At                              which is only shown dependently to the given audio channel. At
2125                              the moment the following information categories are defined:                              the moment the following information categories are defined:
2126  </p>  </p>
2127  <p></p>  <p>
2128                                    </p>
2129  <blockquote class="text">  <blockquote class="text">
2130  <p>TYPE -  <p>TYPE -
2131                                          </p>                                          </p>
# Line 1684  Intellectual Property and Copyright Stat Line 2136  Intellectual Property and Copyright Stat
2136                                              (always returned)                                              (always returned)
2137  </p>  </p>
2138  </blockquote>  </blockquote>
2139                                        
2140    
2141  <p>DESCRIPTION -  <p>DESCRIPTION -
2142                                          </p>                                          </p>
# Line 1691  Intellectual Property and Copyright Stat Line 2144  Intellectual Property and Copyright Stat
2144  <p>arbitrary text describing the purpose of the parameter (always returned)  <p>arbitrary text describing the purpose of the parameter (always returned)
2145  </p>  </p>
2146  </blockquote>  </blockquote>
2147                                        
2148    
2149  <p>FIX -  <p>FIX -
2150                                          </p>                                          </p>
# Line 1700  Intellectual Property and Copyright Stat Line 2154  Intellectual Property and Copyright Stat
2154                                              (always returned)                                              (always returned)
2155  </p>  </p>
2156  </blockquote>  </blockquote>
2157                                        
2158    
2159  <p>MULTIPLICITY -  <p>MULTIPLICITY -
2160                                          </p>                                          </p>
# Line 1710  Intellectual Property and Copyright Stat Line 2165  Intellectual Property and Copyright Stat
2165                                              (always returned)                                              (always returned)
2166  </p>  </p>
2167  </blockquote>  </blockquote>
2168                                        
2169    
2170  <p>RANGE_MIN -  <p>RANGE_MIN -
2171                                          </p>                                          </p>
# Line 1722  Intellectual Property and Copyright Stat Line 2178  Intellectual Property and Copyright Stat
2178                                              parameter)                                              parameter)
2179  </p>  </p>
2180  </blockquote>  </blockquote>
2181                                        
2182    
2183  <p>RANGE_MAX -  <p>RANGE_MAX -
2184                                          </p>                                          </p>
# Line 1734  Intellectual Property and Copyright Stat Line 2191  Intellectual Property and Copyright Stat
2191                                              parameter)                                              parameter)
2192  </p>  </p>
2193  </blockquote>  </blockquote>
2194                                        
2195    
2196  <p>POSSIBILITIES -  <p>POSSIBILITIES -
2197                                          </p>                                          </p>
# Line 1745  Intellectual Property and Copyright Stat Line 2203  Intellectual Property and Copyright Stat
2203                                              parameter)                                              parameter)
2204  </p>  </p>
2205  </blockquote>  </blockquote>
2206                                        
2207    
2208  </blockquote>  </blockquote>
2209                                
2210    
2211  <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.
2212  </p>  </p>
2213  </blockquote>  </blockquote><p>
2214                        
2215    </p>
2216  <p>Example:  <p>Example:
2217  </p>  </p>
2218  <p></p>  <p>
2219                            </p>
2220  <blockquote class="text">  <blockquote class="text">
2221  <p>C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"  <p>C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"
2222  </p>  </p>
# Line 1770  Intellectual Property and Copyright Stat Line 2232  Intellectual Property and Copyright Stat
2232  </p>  </p>
2233  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
2234  </p>  </p>
2235  </blockquote>  </blockquote><p>
2236                        
2237  <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>
2238    <a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"></a><br /><hr />
2239    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2240    <a name="rfc.section.6.2.13"></a><h3>6.2.13.&nbsp;
2241    Changing settings of audio output channels</h3>
2242    
2243  <p>Use the following command to alter a specific setting of an audio output channel:  <p>Use the following command to alter a specific setting of an audio output channel:
2244  </p>  </p>
2245  <p></p>  <p>
2246                            </p>
2247  <blockquote class="text">  <blockquote class="text">
2248  <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;
2249  </p>  </p>
2250  </blockquote>  </blockquote><p>
2251                        
2252  <p>Where &lt;dev-id&gt; should be replaced by the numerical ID of the audio  </p>
2253                      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
2254                        <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
2255                        or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
2256                        command, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the
2257                      parameter to change and &lt;value&gt; by the new value for this parameter.                      parameter to change and &lt;value&gt; by the new value for this parameter.
2258  </p>  </p>
2259  <p>Possible Answers:  <p>Possible Answers:
2260  </p>  </p>
2261  <p></p>  <p>
2262                            </p>
2263  <blockquote class="text">  <blockquote class="text">
2264  <p>"OK" -  <p>"OK" -
2265                                  </p>                                  </p>
# Line 1796  Intellectual Property and Copyright Stat Line 2267  Intellectual Property and Copyright Stat
2267  <p>in case setting was successfully changed  <p>in case setting was successfully changed
2268  </p>  </p>
2269  </blockquote>  </blockquote>
2270                                
2271    
2272  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2273                                  </p>                                  </p>
# Line 1805  Intellectual Property and Copyright Stat Line 2277  Intellectual Property and Copyright Stat
2277                                     warning code and warning message                                     warning code and warning message
2278  </p>  </p>
2279  </blockquote>  </blockquote>
2280                                
2281    
2282  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2283                                  </p>                                  </p>
# Line 1813  Intellectual Property and Copyright Stat Line 2286  Intellectual Property and Copyright Stat
2286                                     error message                                     error message
2287  </p>  </p>
2288  </blockquote>  </blockquote>
2289                                
2290    
2291  </blockquote>  </blockquote><p>
2292                        
2293    </p>
2294  <p>Example:  <p>Example:
2295  </p>  </p>
2296  <p></p>  <p>
2297                            </p>
2298  <blockquote class="text">  <blockquote class="text">
2299  <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'"
2300  </p>  </p>
2301  <p>S: "OK"  <p>S: "OK"
2302  </p>  </p>
2303  </blockquote>  </blockquote><p>
2304                        
2305  <p></p>  </p>
2306    <p>
2307                            </p>
2308  <blockquote class="text">  <blockquote class="text">
2309  <p>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 NAME='monitor left'"  <p>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 NAME='monitor left'"
2310  </p>  </p>
2311  <p>S: "OK"  <p>S: "OK"
2312  </p>  </p>
2313  </blockquote>  </blockquote><p>
2314                        
2315  <a name="rfc.section.5.3"></a><h4><a name="anchor11">5.3</a>&nbsp;Configuring MIDI input drivers</h4>  </p>
2316    <a name="anchor10"></a><br /><hr />
2317    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2318    <a name="rfc.section.6.3"></a><h3>6.3.&nbsp;
2319    Configuring MIDI input drivers</h3>
2320    
2321  <p>Instances of drivers in LinuxSampler are called devices. You can use  <p>Instances of drivers in LinuxSampler are called devices. You can use
2322                  multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as                  multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as
# Line 1862  Intellectual Property and Copyright Stat Line 2344  Intellectual Property and Copyright Stat
2344                  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
2345                  possible values, etc.                  possible values, etc.
2346  </p>  </p>
2347  <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="GET AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />
2348    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2349    <a name="rfc.section.6.3.1"></a><h3>6.3.1.&nbsp;
2350    Getting amount of available MIDI input drivers</h3>
2351    
2352  <p>Use the following command to get the number of  <p>Use the following command to get the number of
2353                      MIDI input drivers currently available for the                      MIDI input drivers currently available for the
2354                      LinuxSampler instance:                      LinuxSampler instance:
2355  </p>  </p>
2356  <p></p>  <p>
2357                            </p>
2358  <blockquote class="text">  <blockquote class="text">
2359  <p>GET AVAILABLE_MIDI_INPUT_DRIVERS  <p>GET AVAILABLE_MIDI_INPUT_DRIVERS
2360  </p>  </p>
2361  </blockquote>  </blockquote><p>
2362                        
2363    </p>
2364  <p>Possible Answers:  <p>Possible Answers:
2365  </p>  </p>
2366  <p></p>  <p>
2367                            </p>
2368  <blockquote class="text">  <blockquote class="text">
2369  <p>LinuxSampler will answer by sending the  <p>LinuxSampler will answer by sending the
2370                              number of available MIDI input drivers.                              number of available MIDI input drivers.
2371  </p>  </p>
2372  </blockquote>  </blockquote><p>
2373                        
2374    </p>
2375  <p>Example:  <p>Example:
2376  </p>  </p>
2377  <p></p>  <p>
2378                            </p>
2379  <blockquote class="text">  <blockquote class="text">
2380  <p>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"  <p>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"
2381  </p>  </p>
2382  <p>S: "2"  <p>S: "2"
2383  </p>  </p>
2384  </blockquote>  </blockquote><p>
2385                        
2386  <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>
2387    <a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />
2388    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2389    <a name="rfc.section.6.3.2"></a><h3>6.3.2.&nbsp;
2390    Getting all available MIDI input drivers</h3>
2391    
2392  <p>Use the following command to list all MIDI input drivers currently available  <p>Use the following command to list all MIDI input drivers currently available
2393                      for the LinuxSampler instance:                      for the LinuxSampler instance:
2394  </p>  </p>
2395  <p></p>  <p>
2396                            </p>
2397  <blockquote class="text">  <blockquote class="text">
2398  <p>LIST AVAILABLE_MIDI_INPUT_DRIVERS  <p>LIST AVAILABLE_MIDI_INPUT_DRIVERS
2399  </p>  </p>
2400  </blockquote>  </blockquote><p>
2401                        
2402    </p>
2403  <p>Possible Answers:  <p>Possible Answers:
2404  </p>  </p>
2405  <p></p>  <p>
2406                            </p>
2407  <blockquote class="text">  <blockquote class="text">
2408  <p>LinuxSampler will answer by sending comma separated character  <p>LinuxSampler will answer by sending comma separated character
2409                              strings, each symbolizing a MIDI input driver.                              strings, each symbolizing a MIDI input driver.
2410  </p>  </p>
2411  </blockquote>  </blockquote><p>
2412                        
2413    </p>
2414  <p>Example:  <p>Example:
2415  </p>  </p>
2416  <p></p>  <p>
2417                            </p>
2418  <blockquote class="text">  <blockquote class="text">
2419  <p>C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"  <p>C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"
2420  </p>  </p>
2421  <p>S: "ALSA,JACK"  <p>S: "ALSA,JACK"
2422  </p>  </p>
2423  </blockquote>  </blockquote><p>
2424                        
2425  <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>
2426    <a name="GET MIDI_INPUT_DRIVER INFO"></a><br /><hr />
2427    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2428    <a name="rfc.section.6.3.3"></a><h3>6.3.3.&nbsp;
2429    Getting information about a specific MIDI input driver</h3>
2430    
2431  <p>Use the following command to get detailed information about a specific MIDI input driver:  <p>Use the following command to get detailed information about a specific MIDI input driver:
2432  </p>  </p>
2433  <p></p>  <p>
2434                            </p>
2435  <blockquote class="text">  <blockquote class="text">
2436  <p>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;  <p>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;
2437  </p>  </p>
2438  </blockquote>  </blockquote><p>
2439                        
2440  <p>Where &lt;midi-input-driver&gt; is the name of the MIDI input driver.  </p>
2441    <p>Where &lt;midi-input-driver&gt; is the name of the MIDI input driver as returned
2442                        by the <a class='info' href='#LIST AVAILABLE_MIDI_INPUT_DRIVERS'>"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class='info'>Getting all available MIDI input drivers</span><span>)</span></a> command.
2443  </p>  </p>
2444  <p>Possible Answers:  <p>Possible Answers:
2445  </p>  </p>
2446  <p></p>  <p>
2447                            </p>
2448  <blockquote class="text">  <blockquote class="text">
2449  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
2450                              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 2452  Intellectual Property and Copyright Stat
2452                              the info character string to that info category. At the moment                              the info character string to that info category. At the moment
2453                              the following information categories are defined:                              the following information categories are defined:
2454  </p>  </p>
2455  <p></p>  <p>
2456                                    </p>
2457  <blockquote class="text">  <blockquote class="text">
2458  <p>DESCRIPTION -  <p>DESCRIPTION -
2459                                          </p>                                          </p>
# Line 1953  Intellectual Property and Copyright Stat Line 2461  Intellectual Property and Copyright Stat
2461  <p>arbitrary description text about the MIDI input driver  <p>arbitrary description text about the MIDI input driver
2462  </p>  </p>
2463  </blockquote>  </blockquote>
2464                                        
2465    
2466  <p>VERSION -  <p>VERSION -
2467                                          </p>                                          </p>
# Line 1960  Intellectual Property and Copyright Stat Line 2469  Intellectual Property and Copyright Stat
2469  <p>arbitrary character string regarding the driver's version  <p>arbitrary character string regarding the driver's version
2470  </p>  </p>
2471  </blockquote>  </blockquote>
2472                                        
2473    
2474  <p>PARAMETERS -  <p>PARAMETERS -
2475                                          </p>                                          </p>
# Line 1967  Intellectual Property and Copyright Stat Line 2477  Intellectual Property and Copyright Stat
2477  <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
2478  </p>  </p>
2479  </blockquote>  </blockquote>
2480                                        
2481    
2482  </blockquote>  </blockquote>
2483                                
2484    
2485  <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.
2486  </p>  </p>
2487  </blockquote>  </blockquote><p>
2488                        
2489    </p>
2490  <p>Example:  <p>Example:
2491  </p>  </p>
2492  <p></p>  <p>
2493                            </p>
2494  <blockquote class="text">  <blockquote class="text">
2495  <p>C: "GET MIDI_INPUT_DRIVER INFO ALSA"  <p>C: "GET MIDI_INPUT_DRIVER INFO ALSA"
2496  </p>  </p>
# Line 1988  Intellectual Property and Copyright Stat Line 2502  Intellectual Property and Copyright Stat
2502  </p>  </p>
2503  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
2504  </p>  </p>
2505  </blockquote>  </blockquote><p>
2506                        
2507  <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>
2508    <a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO"></a><br /><hr />
2509    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2510    <a name="rfc.section.6.3.4"></a><h3>6.3.4.&nbsp;
2511    Getting information about specific MIDI input driver parameter</h3>
2512    
2513  <p>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:  <p>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:
2514  </p>  </p>
2515  <p></p>  <p>
2516                            </p>
2517  <blockquote class="text">  <blockquote class="text">
2518  <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;]
2519  </p>  </p>
2520  </blockquote>  </blockquote><p>
2521                        
2522  <p>Where &lt;midi-t&gt; is the name of the MIDI input driver as returned  </p>
2523                      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
2524                        by the <a class='info' href='#LIST AVAILABLE_MIDI_INPUT_DRIVERS'>"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class='info'>Getting all available MIDI input drivers</span><span>)</span></a> command, &lt;param&gt; a specific
2525                      parameter name for which information should be obtained (as returned by the                      parameter name for which information should be obtained (as returned by the
2526                      <a class="info" href="#GET MIDI_INPUT_DRIVER INFO">"GET MIDI_INPUT_DRIVER INFO"<span>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
2527                      of parameters on which the sought parameter &lt;param&gt; depends on,                      of parameters on which the sought parameter &lt;param&gt; depends on,
2528                      &lt;deplist&gt; is a key-value pair list in form of "key1=val1 key2=val2 ...",                      &lt;deplist&gt; is a key-value pair list in form of "key1=val1 key2=val2 ...",
2529                      where character string values are encapsulated into apostrophes ('). Arguments                      where character string values are encapsulated into apostrophes ('). Arguments
# Line 2022  Intellectual Property and Copyright Stat Line 2542  Intellectual Property and Copyright Stat
2542                      which is only shown dependent to given driver parameter. At                      which is only shown dependent to given driver parameter. At
2543                      the moment the following information categories are defined:                      the moment the following information categories are defined:
2544  </p>  </p>
2545  <p></p>  <p>
2546                            </p>
2547  <blockquote class="text">  <blockquote class="text">
2548  <p>TYPE -  <p>TYPE -
2549                                </p>                                </p>
# Line 2033  Intellectual Property and Copyright Stat Line 2554  Intellectual Property and Copyright Stat
2554                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2555  </p>  </p>
2556  </blockquote>  </blockquote>
2557                                
2558    
2559  <p>DESCRIPTION -  <p>DESCRIPTION -
2560                                </p>                                </p>
# Line 2041  Intellectual Property and Copyright Stat Line 2563  Intellectual Property and Copyright Stat
2563                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2564  </p>  </p>
2565  </blockquote>  </blockquote>
2566                                
2567    
2568  <p>MANDATORY -  <p>MANDATORY -
2569                                </p>                                </p>
2570  <blockquote class="text">  <blockquote class="text">
2571  <p>either true or false, defines if this parameter must be  <p>either true or false, defines if this parameter must be
2572                                  given when the device is to be created with the                                  given when the device is to be created with the
2573                                  <a class="info" href="#CREATE MIDI_INPUT_DEVICE">'CREATE MIDI_INPUT_DEVICE'<span>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
2574                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2575  </p>  </p>
2576  </blockquote>  </blockquote>
2577                                
2578    
2579  <p>FIX -  <p>FIX -
2580                                </p>                                </p>
2581  <blockquote class="text">  <blockquote class="text">
2582  <p>either true or false, if false then this parameter can  <p>either true or false, if false then this parameter can
2583                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
2584                                  the <a class="info" href="#CREATE MIDI_INPUT_DEVICE">'CREATE MIDI_INPUT_DEVICE'<span>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
2585                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2586  </p>  </p>
2587  </blockquote>  </blockquote>
2588                                
2589    
2590  <p>MULTIPLICITY -  <p>MULTIPLICITY -
2591                                </p>                                </p>
# Line 2071  Intellectual Property and Copyright Stat Line 2596  Intellectual Property and Copyright Stat
2596                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2597  </p>  </p>
2598  </blockquote>  </blockquote>
2599                                
2600    
2601  <p>DEPENDS -  <p>DEPENDS -
2602                                </p>                                </p>
2603  <blockquote class="text">  <blockquote class="text">
2604  <p>comma separated list of paramters this parameter depends  <p>comma separated list of parameters this parameter depends
2605                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',
2606                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these
2607                                  listed parameters, for example assuming that an audio                                  listed parameters, for example assuming that an audio
# Line 2087  Intellectual Property and Copyright Stat Line 2613  Intellectual Property and Copyright Stat
2613                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
2614  </p>  </p>
2615  </blockquote>  </blockquote>
2616                                
2617    
2618  <p>DEFAULT -  <p>DEFAULT -
2619                                </p>                                </p>
2620  <blockquote class="text">  <blockquote class="text">
2621  <p>reflects the default value for this parameter which is  <p>reflects the default value for this parameter which is
2622                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
2623                                  given with the <a class="info" href="#CREATE MIDI_INPUT_DEVICE">'CREATE MIDI_INPUT_DEVICE'<span>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,
2624                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
2625                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
2626                                  apostrophes (')                                  apostrophes (')
2627                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
2628  </p>  </p>
2629  </blockquote>  </blockquote>
2630                                
2631    
2632  <p>RANGE_MIN -  <p>RANGE_MIN -
2633                                </p>                                </p>
# Line 2111  Intellectual Property and Copyright Stat Line 2639  Intellectual Property and Copyright Stat
2639                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
2640  </p>  </p>
2641  </blockquote>  </blockquote>
2642                                
2643    
2644  <p>RANGE_MAX -  <p>RANGE_MAX -
2645                                </p>                                </p>
# Line 2122  Intellectual Property and Copyright Stat Line 2651  Intellectual Property and Copyright Stat
2651                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
2652  </p>  </p>
2653  </blockquote>  </blockquote>
2654                                
2655    
2656  <p>POSSIBILITIES -  <p>POSSIBILITIES -
2657                                </p>                                </p>
# Line 2132  Intellectual Property and Copyright Stat Line 2662  Intellectual Property and Copyright Stat
2662                                  (optionally returned, dependent to driver parameter)                                  (optionally returned, dependent to driver parameter)
2663  </p>  </p>
2664  </blockquote>  </blockquote>
2665                                
2666    
2667  </blockquote>  </blockquote><p>
2668                        
2669    </p>
2670  <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.
2671  </p>  </p>
2672  <p>Example:  <p>Example:
2673  </p>  </p>
2674  <p></p>  <p>
2675                            </p>
2676  <blockquote class="text">  <blockquote class="text">
2677  <p>C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"  <p>C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"
2678  </p>  </p>
# Line 2157  Intellectual Property and Copyright Stat Line 2690  Intellectual Property and Copyright Stat
2690  </p>  </p>
2691  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
2692  </p>  </p>
2693  </blockquote>  </blockquote><p>
2694                        
2695  <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>
2696    <a name="CREATE MIDI_INPUT_DEVICE"></a><br /><hr />
2697    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2698    <a name="rfc.section.6.3.5"></a><h3>6.3.5.&nbsp;
2699    Creating a MIDI input device</h3>
2700    
2701  <p>Use the following command to create a new MIDI input device for  the desired MIDI input system:  <p>Use the following command to create a new MIDI input device for  the desired MIDI input system:
2702  </p>  </p>
2703  <p></p>  <p>
2704                            </p>
2705  <blockquote class="text">  <blockquote class="text">
2706  <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;]
2707  </p>  </p>
2708  </blockquote>  </blockquote><p>
2709                        
2710  <p>Where &lt;midi-input-driver&gt; should be replaced by the desired MIDI input system and &lt;param-list&gt; by an  </p>
2711    <p>Where &lt;midi-input-driver&gt; should be replaced by the desired MIDI input system as returned
2712                        by the <a class='info' href='#LIST AVAILABLE_MIDI_INPUT_DRIVERS'>"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class='info'>Getting all available MIDI input drivers</span><span>)</span></a> command and &lt;param-list&gt; by an
2713                      optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where                      optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where
2714                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
2715                      Note that there might be drivers which require parameter(s) to be                      Note that there might be drivers which require parameter(s) to be
# Line 2178  Intellectual Property and Copyright Stat Line 2718  Intellectual Property and Copyright Stat
2718  </p>  </p>
2719  <p>Possible Answers:  <p>Possible Answers:
2720  </p>  </p>
2721  <p></p>  <p>
2722                            </p>
2723  <blockquote class="text">  <blockquote class="text">
2724  <p>"OK[&lt;device-id&gt;]" -  <p>"OK[&lt;device-id&gt;]" -
2725                                  </p>                                  </p>
# Line 2187  Intellectual Property and Copyright Stat Line 2728  Intellectual Property and Copyright Stat
2728                                      &lt;device-id&gt; is the numerical ID of the new device                                      &lt;device-id&gt; is the numerical ID of the new device
2729  </p>  </p>
2730  </blockquote>  </blockquote>
2731                                
2732    
2733  <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;" -
2734                                  </p>                                  </p>
# Line 2197  Intellectual Property and Copyright Stat Line 2739  Intellectual Property and Copyright Stat
2739                                      appropriate warning code and warning message                                      appropriate warning code and warning message
2740  </p>  </p>
2741  </blockquote>  </blockquote>
2742                                
2743    
2744  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2745                                  </p>                                  </p>
# Line 2204  Intellectual Property and Copyright Stat Line 2747  Intellectual Property and Copyright Stat
2747  <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
2748  </p>  </p>
2749  </blockquote>  </blockquote>
2750                                
2751    
2752  </blockquote>  </blockquote><p>
2753                        
2754    </p>
2755  <p>Example:  <p>Example:
2756  </p>  </p>
2757  <p></p>  <p>
2758                            </p>
2759  <blockquote class="text">  <blockquote class="text">
2760  <p>C: "CREATE MIDI_INPUT_DEVICE ALSA"  <p>C: "CREATE MIDI_INPUT_DEVICE ALSA"
2761  </p>  </p>
2762  <p>S: "OK[0]"  <p>S: "OK[0]"
2763  </p>  </p>
2764  </blockquote>  </blockquote><p>
2765                        
2766  <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>
2767    <a name="DESTROY MIDI_INPUT_DEVICE"></a><br /><hr />
2768    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2769    <a name="rfc.section.6.3.6"></a><h3>6.3.6.&nbsp;
2770    Destroying a MIDI input device</h3>
2771    
2772  <p>Use the following command to destroy a created MIDI input device:  <p>Use the following command to destroy a created MIDI input device:
2773  </p>  </p>
2774  <p></p>  <p>
2775                            </p>
2776  <blockquote class="text">  <blockquote class="text">
2777  <p>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;  <p>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;
2778  </p>  </p>
2779  </blockquote>  </blockquote><p>
2780                        
2781  <p>Where &lt;device-id&gt; should be replaced by the device's numerical ID.  </p>
2782    <p>Where &lt;device-id&gt; should be replaced by the device's numerical ID as returned by the
2783                        <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
2784                        or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
2785                        command.
2786  </p>  </p>
2787  <p>Possible Answers:  <p>Possible Answers:
2788  </p>  </p>
2789  <p></p>  <p>
2790                            </p>
2791  <blockquote class="text">  <blockquote class="text">
2792  <p>"OK" -  <p>"OK" -
2793                                  </p>                                  </p>
# Line 2239  Intellectual Property and Copyright Stat Line 2795  Intellectual Property and Copyright Stat
2795  <p>in case the device was successfully destroyed  <p>in case the device was successfully destroyed
2796  </p>  </p>
2797  </blockquote>  </blockquote>
2798                                
2799    
2800  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2801                                  </p>                                  </p>
# Line 2248  Intellectual Property and Copyright Stat Line 2805  Intellectual Property and Copyright Stat
2805                                      warning message                                      warning message
2806  </p>  </p>
2807  </blockquote>  </blockquote>
2808                                
2809    
2810  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2811                                  </p>                                  </p>
# Line 2255  Intellectual Property and Copyright Stat Line 2813  Intellectual Property and Copyright Stat
2813  <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
2814  </p>  </p>
2815  </blockquote>  </blockquote>
2816                                
2817    
2818  </blockquote>  </blockquote><p>
2819                        
2820    </p>
2821  <p>Example:  <p>Example:
2822  </p>  </p>
2823  <p></p>  <p>
2824                            </p>
2825  <blockquote class="text">  <blockquote class="text">
2826  <p>C: "DESTROY MIDI_INPUT_DEVICE 0"  <p>C: "DESTROY MIDI_INPUT_DEVICE 0"
2827  </p>  </p>
2828  <p>S: "OK"  <p>S: "OK"
2829  </p>  </p>
2830  </blockquote>  </blockquote><p>
2831                        
2832  <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>
2833    <a name="GET MIDI_INPUT_DEVICES"></a><br /><hr />
2834    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2835    <a name="rfc.section.6.3.7"></a><h3>6.3.7.&nbsp;
2836    Getting all created MIDI input device count</h3>
2837    
2838  <p>Use the following command to count all created MIDI input devices:  <p>Use the following command to count all created MIDI input devices:
2839  </p>  </p>
2840  <p></p>  <p>
2841                            </p>
2842  <blockquote class="text">  <blockquote class="text">
2843  <p>GET MIDI_INPUT_DEVICES  <p>GET MIDI_INPUT_DEVICES
2844  </p>  </p>
2845  </blockquote>  </blockquote><p>
2846                        
2847    </p>
2848  <p>Possible Answers:  <p>Possible Answers:
2849  </p>  </p>
2850  <p></p>  <p>
2851                            </p>
2852  <blockquote class="text">  <blockquote class="text">
2853  <p>LinuxSampler will answer by sending the current number of all  <p>LinuxSampler will answer by sending the current number of all
2854                              MIDI input devices.                              MIDI input devices.
2855  </p>  </p>
2856  </blockquote>  </blockquote><p>
2857                        
2858    </p>
2859  <p>Example:  <p>Example:
2860  </p>  </p>
2861  <p></p>  <p>
2862                            </p>
2863  <blockquote class="text">  <blockquote class="text">
2864  <p>C: "GET MIDI_INPUT_DEVICES"  <p>C: "GET MIDI_INPUT_DEVICES"
2865  </p>  </p>
2866  <p>S: "3"  <p>S: "3"
2867  </p>  </p>
2868  </blockquote>  </blockquote><p>
2869                        
2870  <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>
2871    <a name="LIST MIDI_INPUT_DEVICES"></a><br /><hr />
2872    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2873    <a name="rfc.section.6.3.8"></a><h3>6.3.8.&nbsp;
2874    Getting all created MIDI input device list</h3>
2875    
2876  <p>Use the following command to list all created MIDI input devices:  <p>Use the following command to list all created MIDI input devices:
2877  </p>  </p>
2878  <p></p>  <p>
2879                            </p>
2880  <blockquote class="text">  <blockquote class="text">
2881  <p>LIST MIDI_INPUT_DEVICES  <p>LIST MIDI_INPUT_DEVICES
2882  </p>  </p>
2883  </blockquote>  </blockquote><p>
2884                        
2885    </p>
2886  <p>Possible Answers:  <p>Possible Answers:
2887  </p>  </p>
2888  <p></p>  <p>
2889                            </p>
2890  <blockquote class="text">  <blockquote class="text">
2891  <p>LinuxSampler will answer by sending a comma separated list  <p>LinuxSampler will answer by sending a comma separated list
2892                              with the numerical Ids of all created MIDI input devices.                              with the numerical Ids of all created MIDI input devices.
2893  </p>  </p>
2894  </blockquote>  </blockquote><p>
2895                        
2896    </p>
2897  <p>Examples:  <p>Examples:
2898  </p>  </p>
2899  <p></p>  <p>
2900                            </p>
2901  <blockquote class="text">  <blockquote class="text">
2902  <p>C: "LIST MIDI_INPUT_DEVICES"  <p>C: "LIST MIDI_INPUT_DEVICES"
2903  </p>  </p>
2904  <p>S: "0,1,2"  <p>S: "0,1,2"
2905  </p>  </p>
2906  </blockquote>  </blockquote><p>
2907                        
2908  <p></p>  </p>
2909    <p>
2910                            </p>
2911  <blockquote class="text">  <blockquote class="text">
2912  <p>C: "LIST MIDI_INPUT_DEVICES"  <p>C: "LIST MIDI_INPUT_DEVICES"
2913  </p>  </p>
2914  <p>S: "1,3"  <p>S: "1,3"
2915  </p>  </p>
2916  </blockquote>  </blockquote><p>
2917                        
2918  <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>
2919    <a name="GET MIDI_INPUT_DEVICE INFO"></a><br /><hr />
2920    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
2921    <a name="rfc.section.6.3.9"></a><h3>6.3.9.&nbsp;
2922    Getting current settings of a MIDI input device</h3>
2923    
2924  <p>Use the following command to get current settings of a specific, created MIDI input device:  <p>Use the following command to get current settings of a specific, created MIDI input device:
2925  </p>  </p>
2926  <p></p>  <p>
2927                            </p>
2928  <blockquote class="text">  <blockquote class="text">
2929  <p>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;  <p>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;
2930  </p>  </p>
2931  </blockquote>  </blockquote><p>
2932                        
2933  <p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device.  </p>
2934    <p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
2935                        <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
2936                        or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
2937                        command.
2938  </p>  </p>
2939  <p>Possible Answers:  <p>Possible Answers:
2940  </p>  </p>
2941  <p></p>  <p>
2942                            </p>
2943  <blockquote class="text">  <blockquote class="text">
2944  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
2945                              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 2949  Intellectual Property and Copyright Stat
2949                              encapsulated into apostrophes ('). At the moment the following                              encapsulated into apostrophes ('). At the moment the following
2950                              information categories are defined (independent of driver):                              information categories are defined (independent of driver):
2951  </p>  </p>
2952  <p></p>  <p>
2953                                    </p>
2954  <blockquote class="text">  <blockquote class="text">
2955  <p>DRIVER -  <p>DRIVER -
2956                                          </p>                                          </p>
2957  <blockquote class="text">  <blockquote class="text">
2958  <p>identifier of the used MIDI input driver, as e.g.  <p>identifier of the used MIDI input driver, as e.g.
2959                                              returned by the <a class="info" href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span>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>
2960                                              command                                              command
2961  </p>  </p>
2962  </blockquote>  </blockquote>
2963                                        
2964    
2965  </blockquote>  </blockquote>
2966                                    
2967  <blockquote class="text">  <blockquote class="text">
2968  <p><p>ACTIVE -  <p>ACTIVE -
2969                                          </p>                                          </p>
2970  <blockquote class="text">  <blockquote class="text">
2971  <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 2380  Intellectual Property and Copyright Stat Line 2974  Intellectual Property and Copyright Stat
2974                                              channels                                              channels
2975  </p>  </p>
2976  </blockquote>  </blockquote>
2977                                        
2978    
2979  </blockquote>  </blockquote>
2980                                
2981    
2982  </blockquote>  </blockquote><p>
2983                        
2984    </p>
2985  <p>The mentioned fields above don't have to be in particular  <p>The mentioned fields above don't have to be in particular
2986                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
2987                      returned by all MIDI input devices. Every MIDI input driver                      returned by all MIDI input devices. Every MIDI input driver
2988                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
2989                      <a class="info" href="#GET MIDI_INPUT_DRIVER INFO">"GET MIDI_INPUT_DRIVER INFO"<span>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
2990                      by this command.                      by this command.
2991  </p>  </p>
2992  <p>Example:  <p>Example:
2993  </p>  </p>
2994  <p></p>  <p>
2995                            </p>
2996  <blockquote class="text">  <blockquote class="text">
2997  <p>C: "GET MIDI_INPUT_DEVICE INFO 0"  <p>C: "GET MIDI_INPUT_DEVICE INFO 0"
2998  </p>  </p>
# Line 2404  Intellectual Property and Copyright Stat Line 3002  Intellectual Property and Copyright Stat
3002  </p>  </p>
3003  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
3004  </p>  </p>
3005  </blockquote>  </blockquote><p>
3006                        
3007  <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>
3008    <a name="SET MIDI_INPUT_DEVICE_PARAMETER"></a><br /><hr />
3009    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3010    <a name="rfc.section.6.3.10"></a><h3>6.3.10.&nbsp;
3011    Changing settings of MIDI input devices</h3>
3012    
3013  <p>Use the following command to alter a specific setting of a created MIDI input device:  <p>Use the following command to alter a specific setting of a created MIDI input device:
3014  </p>  </p>
3015  <p></p>  <p>
3016                            </p>
3017  <blockquote class="text">  <blockquote class="text">
3018  <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;
3019  </p>  </p>
3020  </blockquote>  </blockquote><p>
3021                        
3022    </p>
3023  <p>Where &lt;device-id&gt; should be replaced by the numerical ID of the  <p>Where &lt;device-id&gt; should be replaced by the numerical ID of the
3024                      MIDI input device, &lt;key&gt; by the name of the parameter to change and                      MIDI input device as returned by the
3025                        <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
3026                        or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
3027                        command, &lt;key&gt; by the name of the parameter to change and
3028                      &lt;value&gt; by the new value for this parameter.                      &lt;value&gt; by the new value for this parameter.
3029  </p>  </p>
3030  <p>Possible Answers:  <p>Possible Answers:
3031  </p>  </p>
3032  <p></p>  <p>
3033                            </p>
3034  <blockquote class="text">  <blockquote class="text">
3035  <p>"OK" -  <p>"OK" -
3036                                  </p>                                  </p>
# Line 2430  Intellectual Property and Copyright Stat Line 3038  Intellectual Property and Copyright Stat
3038  <p>in case setting was successfully changed  <p>in case setting was successfully changed
3039  </p>  </p>
3040  </blockquote>  </blockquote>
3041                                
3042    
3043  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3044                                  </p>                                  </p>
# Line 2439  Intellectual Property and Copyright Stat Line 3048  Intellectual Property and Copyright Stat
3048                                      warning code and warning message                                      warning code and warning message
3049  </p>  </p>
3050  </blockquote>  </blockquote>
3051                                
3052    
3053  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3054                                  </p>                                  </p>
# Line 2446  Intellectual Property and Copyright Stat Line 3056  Intellectual Property and Copyright Stat
3056  <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
3057  </p>  </p>
3058  </blockquote>  </blockquote>
3059                                
3060    
3061  </blockquote>  </blockquote><p>
3062                        
3063    </p>
3064  <p>Example:  <p>Example:
3065  </p>  </p>
3066  <p></p>  <p>
3067                            </p>
3068  <blockquote class="text">  <blockquote class="text">
3069  <p>C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"  <p>C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"
3070  </p>  </p>
3071  <p>S: "OK"  <p>S: "OK"
3072  </p>  </p>
3073  </blockquote>  </blockquote><p>
3074                        
3075  <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>
3076    <a name="GET MIDI_INPUT_PORT INFO"></a><br /><hr />
3077    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3078    <a name="rfc.section.6.3.11"></a><h3>6.3.11.&nbsp;
3079    Getting information about a MIDI port</h3>
3080    
3081  <p>Use the following command to get information about a MIDI port:  <p>Use the following command to get information about a MIDI port:
3082  </p>  </p>
3083  <p></p>  <p>
3084                            </p>
3085  <blockquote class="text">  <blockquote class="text">
3086  <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;
3087  </p>  </p>
3088  </blockquote>  </blockquote><p>
3089                        
3090  <p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device  </p>
3091                      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
3092                        <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
3093                        or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
3094                        command and &lt;midi-port&gt; the MIDI input port number.
3095  </p>  </p>
3096  <p>Possible Answers:  <p>Possible Answers:
3097  </p>  </p>
3098  <p></p>  <p>
3099                            </p>
3100  <blockquote class="text">  <blockquote class="text">
3101  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
3102                              Each answer line begins with the information category name                              Each answer line begins with the information category name
# Line 2488  Intellectual Property and Copyright Stat Line 3110  Intellectual Property and Copyright Stat
3110  <p>arbitrary character string naming the port  <p>arbitrary character string naming the port
3111  </p>  </p>
3112  </blockquote>  </blockquote>
3113                                
3114    
3115  </blockquote>  </blockquote><p>
3116                        
3117    </p>
3118  <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
3119                      ports regardless of the MIDI driver and port. Every MIDI port                      ports regardless of the MIDI driver and port. Every MIDI port
3120                      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 3122  Intellectual Property and Copyright Stat
3122  </p>  </p>
3123  <p>Example:  <p>Example:
3124  </p>  </p>
3125  <p></p>  <p>
3126                            </p>
3127  <blockquote class="text">  <blockquote class="text">
3128  <p>C: "GET MIDI_INPUT_PORT INFO 0 0"  <p>C: "GET MIDI_INPUT_PORT INFO 0 0"
3129  </p>  </p>
# Line 2508  Intellectual Property and Copyright Stat Line 3133  Intellectual Property and Copyright Stat
3133  </p>  </p>
3134  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
3135  </p>  </p>
3136  </blockquote>  </blockquote><p>
3137                        
3138  <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>
3139    <a name="GET MIDI_INPUT_PORT_PARAMETER INFO"></a><br /><hr />
3140    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3141    <a name="rfc.section.6.3.12"></a><h3>6.3.12.&nbsp;
3142    Getting information about specific MIDI port parameter</h3>
3143    
3144  <p>Use the following command to get detailed information about specific MIDI port parameter:  <p>Use the following command to get detailed information about specific MIDI port parameter:
3145  </p>  </p>
3146  <p></p>  <p>
3147                            </p>
3148  <blockquote class="text">  <blockquote class="text">
3149  <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;
3150  </p>  </p>
3151  </blockquote>  </blockquote><p>
3152                        
3153  <p>Where &lt;dev-id&gt; is the numerical ID of the MIDI input device as returned  </p>
3154                      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
3155                        <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
3156                        or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
3157                        command, &lt;port&gt; the MIDI port number and
3158                      &lt;param&gt; a specific port parameter name for which information should be                      &lt;param&gt; a specific port parameter name for which information should be
3159                      obtained (as returned by the <a class="info" href="#GET MIDI_INPUT_PORT INFO">"GET MIDI_INPUT_PORT INFO"<span>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).
3160  </p>  </p>
3161  <p>Possible Answers:  <p>Possible Answers:
3162  </p>  </p>
3163  <p></p>  <p>
3164                            </p>
3165  <blockquote class="text">  <blockquote class="text">
3166  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
3167                              Each answer line begins with the information category name                              Each answer line begins with the information category name
# Line 2547  Intellectual Property and Copyright Stat Line 3181  Intellectual Property and Copyright Stat
3181                                      (always returned)                                      (always returned)
3182  </p>  </p>
3183  </blockquote>  </blockquote>
3184                                
3185    
3186  <p>DESCRIPTION -  <p>DESCRIPTION -
3187                                  </p>                                  </p>
# Line 2555  Intellectual Property and Copyright Stat Line 3190  Intellectual Property and Copyright Stat
3190                                      (always returned)                                      (always returned)
3191  </p>  </p>
3192  </blockquote>  </blockquote>
3193                                
3194    
3195  <p>FIX -  <p>FIX -
3196                                  </p>                                  </p>
# Line 2564  Intellectual Property and Copyright Stat Line 3200  Intellectual Property and Copyright Stat
3200                                      (always returned)                                      (always returned)
3201  </p>  </p>
3202  </blockquote>  </blockquote>
3203                                
3204    
3205  <p>MULTIPLICITY -  <p>MULTIPLICITY -
3206                                  </p>                                  </p>
# Line 2574  Intellectual Property and Copyright Stat Line 3211  Intellectual Property and Copyright Stat
3211                                      (always returned)                                      (always returned)
3212  </p>  </p>
3213  </blockquote>  </blockquote>
3214                                
3215    
3216  <p>RANGE_MIN -  <p>RANGE_MIN -
3217                                  </p>                                  </p>
# Line 2586  Intellectual Property and Copyright Stat Line 3224  Intellectual Property and Copyright Stat
3224                                      parameter)                                      parameter)
3225  </p>  </p>
3226  </blockquote>  </blockquote>
3227                                
3228    
3229  <p>RANGE_MAX -  <p>RANGE_MAX -
3230                                  </p>                                  </p>
# Line 2598  Intellectual Property and Copyright Stat Line 3237  Intellectual Property and Copyright Stat
3237                                      parameter)                                      parameter)
3238  </p>  </p>
3239  </blockquote>  </blockquote>
3240                                
3241    
3242  <p>POSSIBILITIES -  <p>POSSIBILITIES -
3243                                  </p>                                  </p>
# Line 2609  Intellectual Property and Copyright Stat Line 3249  Intellectual Property and Copyright Stat
3249                                      parameter)                                      parameter)
3250  </p>  </p>
3251  </blockquote>  </blockquote>
3252                                
3253    
3254  </blockquote>  </blockquote><p>
3255                        
3256    </p>
3257  <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.
3258  </p>  </p>
3259  <p>Example:  <p>Example:
3260  </p>  </p>
3261  <p></p>  <p>
3262                            </p>
3263  <blockquote class="text">  <blockquote class="text">
3264  <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"
3265  </p>  </p>
# Line 2632  Intellectual Property and Copyright Stat Line 3275  Intellectual Property and Copyright Stat
3275  </p>  </p>
3276  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
3277  </p>  </p>
3278  </blockquote>  </blockquote><p>
3279                        
3280  <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>
3281    <a name="SET MIDI_INPUT_PORT_PARAMETER"></a><br /><hr />
3282    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3283    <a name="rfc.section.6.3.13"></a><h3>6.3.13.&nbsp;
3284    Changing settings of MIDI input ports</h3>
3285    
3286  <p>Use the following command to alter a specific setting of a MIDI input port:  <p>Use the following command to alter a specific setting of a MIDI input port:
3287  </p>  </p>
3288  <p></p>  <p>
3289                            </p>
3290  <blockquote class="text">  <blockquote class="text">
3291  <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;
3292  </p>  </p>
3293  </blockquote>  </blockquote><p>
3294                        
3295    </p>
3296  <p>Where &lt;device-id&gt; should be replaced by the numerical ID of the  <p>Where &lt;device-id&gt; should be replaced by the numerical ID of the
3297                      MIDI device, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of                      MIDI device as returned by the
3298                        <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
3299                        or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
3300                        command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
3301                      the parameter to change and &lt;value&gt; by the new value for this                      the parameter to change and &lt;value&gt; by the new value for this
3302                      parameter.                      parameter.
3303  </p>  </p>
3304  <p>Possible Answers:  <p>Possible Answers:
3305  </p>  </p>
3306  <p></p>  <p>
3307                            </p>
3308  <blockquote class="text">  <blockquote class="text">
3309  <p>"OK" -  <p>"OK" -
3310                                  </p>                                  </p>
# Line 2659  Intellectual Property and Copyright Stat Line 3312  Intellectual Property and Copyright Stat
3312  <p>in case setting was successfully changed  <p>in case setting was successfully changed
3313  </p>  </p>
3314  </blockquote>  </blockquote>
3315                                
3316    
3317  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3318                                  </p>                                  </p>
# Line 2668  Intellectual Property and Copyright Stat Line 3322  Intellectual Property and Copyright Stat
3322                                      warning code and warning message                                      warning code and warning message
3323  </p>  </p>
3324  </blockquote>  </blockquote>
3325                                
3326    
3327  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3328                                  </p>                                  </p>
# Line 2675  Intellectual Property and Copyright Stat Line 3330  Intellectual Property and Copyright Stat
3330  <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
3331  </p>  </p>
3332  </blockquote>  </blockquote>
3333                                
3334    
3335  </blockquote>  </blockquote><p>
3336                        
3337    </p>
3338  <p>Example:  <p>Example:
3339  </p>  </p>
3340  <p></p>  <p>
3341                            </p>
3342  <blockquote class="text">  <blockquote class="text">
3343  <p>  <p>
3344  </p>  </p>
3345  </blockquote>  </blockquote><p>
3346                        
 <a name="rfc.section.5.4"></a><h4><a name="anchor12">5.4</a>&nbsp;Configuring sampler channels</h4>  
   
 <p>The following commands describe how to add and remove sampler channels, deploy  
                 sampler engines, load instruments and connect sampler channels to MIDI and audio devices.  
3347  </p>  </p>
3348  <a name="rfc.section.5.4.1"></a><h4><a name="LOAD INSTRUMENT">5.4.1</a>&nbsp;Loading an instrument</h4>  <a name="anchor11"></a><br /><hr />
3349    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3350    <a name="rfc.section.6.4"></a><h3>6.4.&nbsp;
3351    Configuring sampler channels</h3>
3352    
3353    <p>The following commands describe how to add and remove sampler channels, associate a
3354                    sampler channel with a sampler engine, load instruments and connect sampler channels to
3355                    MIDI and audio devices.
3356    </p>
3357    <a name="LOAD INSTRUMENT"></a><br /><hr />
3358    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3359    <a name="rfc.section.6.4.1"></a><h3>6.4.1.&nbsp;
3360    Loading an instrument</h3>
3361    
3362  <p>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:  <p>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:
3363  </p>  </p>
3364  <p></p>  <p>
3365                            </p>
3366  <blockquote class="text">  <blockquote class="text">
3367  <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;
3368  </p>  </p>
3369  </blockquote>  </blockquote><p>
3370                        
3371    </p>
3372  <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
3373                      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
3374                      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 3379  Intellectual Property and Copyright Stat
3379                      is that the regular command returns OK only after the instrument has been                      is that the regular command returns OK only after the instrument has been
3380                      fully loaded and the channel is ready to be used while NON_MODAL version                      fully loaded and the channel is ready to be used while NON_MODAL version
3381                      returns immediately and a background process is launched to load the instrument                      returns immediately and a background process is launched to load the instrument
3382                      on the channel. The <a class="info" href="#GET CHANNEL INFO">GET CHANNEL INFO<span>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>
3383                      command can be used to obtain loading                      command can be used to obtain loading
3384                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks
3385                      such as making sure that the file could be read and it is of a proper format                      such as making sure that the file could be read and it is of a proper format
# Line 2720  Intellectual Property and Copyright Stat Line 3388  Intellectual Property and Copyright Stat
3388  </p>  </p>
3389  <p>Possible Answers:  <p>Possible Answers:
3390  </p>  </p>
3391  <p></p>  <p>
3392                            </p>
3393  <blockquote class="text">  <blockquote class="text">
3394  <p>"OK" -  <p>"OK" -
3395                                  </p>                                  </p>
# Line 2728  Intellectual Property and Copyright Stat Line 3397  Intellectual Property and Copyright Stat
3397  <p>in case the instrument was successfully loaded  <p>in case the instrument was successfully loaded
3398  </p>  </p>
3399  </blockquote>  </blockquote>
3400                                
3401    
3402  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3403                                  </p>                                  </p>
# Line 2739  Intellectual Property and Copyright Stat Line 3409  Intellectual Property and Copyright Stat
3409                                      warning message                                      warning message
3410  </p>  </p>
3411  </blockquote>  </blockquote>
3412                                
3413    
3414  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3415                                  </p>                                  </p>
# Line 2746  Intellectual Property and Copyright Stat Line 3417  Intellectual Property and Copyright Stat
3417  <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
3418  </p>  </p>
3419  </blockquote>  </blockquote>
3420                                
3421    
3422  </blockquote>  </blockquote><p>
3423                        
3424    </p>
3425  <p>Example:  <p>Example:
3426  </p>  </p>
3427  <p></p>  <p>
3428                            </p>
3429  <blockquote class="text">  <blockquote class="text">
3430  <p>  <p>
3431  </p>  </p>
3432  </blockquote>  </blockquote><p>
3433                        
3434  <a name="rfc.section.5.4.2"></a><h4><a name="LOAD ENGINE">5.4.2</a>&nbsp;Loading a sampler engine</h4>  </p>
3435    <a name="LOAD ENGINE"></a><br /><hr />
3436    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3437    <a name="rfc.section.6.4.2"></a><h3>6.4.2.&nbsp;
3438    Loading a sampler engine</h3>
3439    
3440  <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
3441                      channel by the following command:                      channel by the following command:
3442  </p>  </p>
3443  <p></p>  <p>
3444                            </p>
3445  <blockquote class="text">  <blockquote class="text">
3446  <p>LOAD ENGINE &lt;engine-name&gt; &lt;sampler-channel&gt;  <p>LOAD ENGINE &lt;engine-name&gt; &lt;sampler-channel&gt;
3447  </p>  </p>
3448  </blockquote>  </blockquote><p>
3449                        
3450    </p>
3451  <p>Where &lt;engine-name&gt; is an engine name as obtained by the  <p>Where &lt;engine-name&gt; is an engine name as obtained by the
3452                      <a class="info" href="#LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"<span>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;
3453                      deployed engine should be assigned to. Even if the respective                      the sampler channel as returned by the
3454                      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
3455                      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
3456                        the engine type should be assigned to. This command should be issued
3457                        after adding a new sampler channel and before any other control
3458                        commands on the new sampler channel. It can also be used to change
3459                        the engine type of a sampler channel. This command has (currently) no
3460                        way to define or force if a new engine instance should be created and
3461                        assigned to the given sampler channel or if an already existing
3462                        instance of that engine type, shared with other sampler channels,
3463                        should be used.
3464  </p>  </p>
3465  <p>Possible Answers:  <p>Possible Answers:
3466  </p>  </p>
3467  <p></p>  <p>
3468                            </p>
3469  <blockquote class="text">  <blockquote class="text">
3470  <p>"OK" -  <p>"OK" -
3471                                  </p>                                  </p>
# Line 2784  Intellectual Property and Copyright Stat Line 3473  Intellectual Property and Copyright Stat
3473  <p>in case the engine was successfully deployed  <p>in case the engine was successfully deployed
3474  </p>  </p>
3475  </blockquote>  </blockquote>
3476                                
3477    
3478  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3479                                  </p>                                  </p>
# Line 2793  Intellectual Property and Copyright Stat Line 3483  Intellectual Property and Copyright Stat
3483                                      warning code and warning message                                      warning code and warning message
3484  </p>  </p>
3485  </blockquote>  </blockquote>
3486                                
3487    
3488  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3489                                  </p>                                  </p>
# Line 2801  Intellectual Property and Copyright Stat Line 3492  Intellectual Property and Copyright Stat
3492                                      error message                                      error message
3493  </p>  </p>
3494  </blockquote>  </blockquote>
3495                                
3496    
3497  </blockquote>  </blockquote><p>
3498                        
3499    </p>
3500  <p>Example:  <p>Example:
3501  </p>  </p>
3502  <p></p>  <p>
3503                            </p>
3504  <blockquote class="text">  <blockquote class="text">
3505  <p>  <p>
3506  </p>  </p>
3507  </blockquote>  </blockquote><p>
3508                        
3509  <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>
3510    <a name="GET CHANNELS"></a><br /><hr />
3511    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3512    <a name="rfc.section.6.4.3"></a><h3>6.4.3.&nbsp;
3513    Getting all created sampler channel count</h3>
3514    
3515  <p>The number of sampler channels can change on runtime. To get the  <p>The number of sampler channels can change on runtime. To get the
3516                      current amount of sampler channels, the front-end can send the                      current amount of sampler channels, the front-end can send the
3517                      following command:                      following command:
3518  </p>  </p>
3519  <p></p>  <p>
3520                            </p>
3521  <blockquote class="text">  <blockquote class="text">
3522  <p>GET CHANNELS  <p>GET CHANNELS
3523  </p>  </p>
3524  </blockquote>  </blockquote><p>
3525                        
3526    </p>
3527  <p>Possible Answers:  <p>Possible Answers:
3528  </p>  </p>
3529  <p></p>  <p>
3530                            </p>
3531  <blockquote class="text">  <blockquote class="text">
3532  <p>LinuxSampler will answer by returning the current number of sampler channels.  <p>LinuxSampler will answer by returning the current number of sampler channels.
3533  </p>  </p>
3534  </blockquote>  </blockquote><p>
3535                        
3536    </p>
3537  <p>Example:  <p>Example:
3538  </p>  </p>
3539  <p></p>  <p>
3540                            </p>
3541  <blockquote class="text">  <blockquote class="text">
3542  <p>C: "GET CHANNELS"  <p>C: "GET CHANNELS"
3543  </p>  </p>
3544  <p>S: "12"  <p>S: "12"
3545  </p>  </p>
3546  </blockquote>  </blockquote><p>
3547                        
3548  <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>
3549    <a name="LIST CHANNELS"></a><br /><hr />
3550    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3551    <a name="rfc.section.6.4.4"></a><h3>6.4.4.&nbsp;
3552    Getting all created sampler channel list</h3>
3553    
3554  <p>The number of sampler channels can change on runtime. To get the  <p>The number of sampler channels can change on runtime. To get the
3555                      current list of sampler channels, the front-end can send the                      current list of sampler channels, the front-end can send the
3556                      following command:                      following command:
3557  </p>  </p>
3558  <p></p>  <p>
3559                            </p>
3560  <blockquote class="text">  <blockquote class="text">
3561  <p>LIST CHANNELS  <p>LIST CHANNELS
3562  </p>  </p>
3563  </blockquote>  </blockquote><p>
3564                        
3565    </p>
3566  <p>Possible Answers:  <p>Possible Answers:
3567  </p>  </p>
3568  <p></p>  <p>
3569                            </p>
3570  <blockquote class="text">  <blockquote class="text">
3571  <p>LinuxSampler will answer by returning a comma separated list  <p>LinuxSampler will answer by returning a comma separated list
3572                              with all sampler channels numerical IDs.                              with all sampler channels numerical IDs.
3573  </p>  </p>
3574  </blockquote>  </blockquote><p>
3575                        
3576    </p>
3577  <p>Example:  <p>Example:
3578  </p>  </p>
3579  <p></p>  <p>
3580                            </p>
3581  <blockquote class="text">  <blockquote class="text">
3582  <p>C: "LIST CHANNELS"  <p>C: "LIST CHANNELS"
3583  </p>  </p>
3584  <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"
3585  </p>  </p>
3586  </blockquote>  </blockquote><p>
3587                        
3588  <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>
3589    <a name="ADD CHANNEL"></a><br /><hr />
3590    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3591    <a name="rfc.section.6.4.5"></a><h3>6.4.5.&nbsp;
3592    Adding a new sampler channel</h3>
3593    
3594  <p>A new sampler channel can be added to the end of the sampler  <p>A new sampler channel can be added to the end of the sampler
3595                      channel list by sending the following command:                      channel list by sending the following command:
3596  </p>  </p>
3597  <p></p>  <p>
3598                            </p>
3599  <blockquote class="text">  <blockquote class="text">
3600  <p>ADD CHANNEL  <p>ADD CHANNEL
3601  </p>  </p>
3602  </blockquote>  </blockquote><p>
3603                        
3604    </p>
3605  <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
3606                      sampler channel will be appended to the end of the sampler channel                      sampler channel will be appended to the end of the sampler channel
3607                      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 3614  Intellectual Property and Copyright Stat
3614  </p>  </p>
3615  <p>Possible Answers:  <p>Possible Answers:
3616  </p>  </p>
3617  <p></p>  <p>
3618                            </p>
3619  <blockquote class="text">  <blockquote class="text">
3620  <p>"OK[&lt;sampler-channel&gt;]" -  <p>"OK[&lt;sampler-channel&gt;]" -
3621                                  </p>                                  </p>
3622  <blockquote class="text">  <blockquote class="text">
3623  <p>in case a new sampler channel could be added, where  <p>in case a new sampler channel could be added, where
3624                                      &lt;sampler-channel&gt; reflects the channel number of the new                                      &lt;sampler-channel&gt; reflects the channel number of the new
3625                                      created sampler channel which should the be used to set up                                      created sampler channel which should be used to set up
3626                                      the sampler channel by sending subsequent intialization                                      the sampler channel by sending subsequent initialization
3627                                      commands                                      commands
3628  </p>  </p>
3629  </blockquote>  </blockquote>
3630                                
3631    
3632  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3633                                  </p>                                  </p>
# Line 2917  Intellectual Property and Copyright Stat Line 3637  Intellectual Property and Copyright Stat
3637                                      warning code and warning message                                      warning code and warning message
3638  </p>  </p>
3639  </blockquote>  </blockquote>
3640                                
3641    
3642  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3643                                  </p>                                  </p>
# Line 2925  Intellectual Property and Copyright Stat Line 3646  Intellectual Property and Copyright Stat
3646                                      error message                                      error message
3647  </p>  </p>
3648  </blockquote>  </blockquote>
3649                                
3650    
3651  </blockquote>  </blockquote><p>
3652                        
3653    </p>
3654  <p>Example:  <p>Example:
3655  </p>  </p>
3656  <p></p>  <p>
3657                            </p>
3658  <blockquote class="text">  <blockquote class="text">
3659  <p>  <p>
3660  </p>  </p>
3661  </blockquote>  </blockquote><p>
3662                        
3663  <a name="rfc.section.5.4.6"></a><h4><a name="REMOVE CHANNEL">5.4.6</a>&nbsp;Removing a sampler channel</h4>  </p>
3664    <a name="REMOVE CHANNEL"></a><br /><hr />
3665    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3666    <a name="rfc.section.6.4.6"></a><h3>6.4.6.&nbsp;
3667    Removing a sampler channel</h3>
3668    
3669  <p>A sampler channel can be removed by sending the following command:  <p>A sampler channel can be removed by sending the following command:
3670  </p>  </p>
3671  <p></p>  <p>
3672                            </p>
3673  <blockquote class="text">  <blockquote class="text">
3674  <p>REMOVE CHANNEL &lt;sampler-channel&gt;  <p>REMOVE CHANNEL &lt;sampler-channel&gt;
3675  </p>  </p>
3676  </blockquote>  </blockquote><p>
3677                        
3678  <p>This will decrement the sampler channel count by one and also  </p>
3679                      decrement the channel numbers of all subsequent sampler channels by  <p>Where &lt;sampler-channel&gt; should be replaced by the
3680                      one.                      number of the sampler channel as given by the
3681                        <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
3682                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a>
3683                        command. The channel numbers of all subsequent sampler channels
3684                        remain the same.
3685  </p>  </p>
3686  <p>Possible Answers:  <p>Possible Answers:
3687  </p>  </p>
3688  <p></p>  <p>
3689                            </p>
3690  <blockquote class="text">  <blockquote class="text">
3691  <p>"OK" -  <p>"OK" -
3692                                  </p>                                  </p>
# Line 2960  Intellectual Property and Copyright Stat Line 3694  Intellectual Property and Copyright Stat
3694  <p>in case the given sampler channel could be removed  <p>in case the given sampler channel could be removed
3695  </p>  </p>
3696  </blockquote>  </blockquote>
3697                                
3698    
3699  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3700                                  </p>                                  </p>
# Line 2969  Intellectual Property and Copyright Stat Line 3704  Intellectual Property and Copyright Stat
3704                                      warning code and warning message                                      warning code and warning message
3705  </p>  </p>
3706  </blockquote>  </blockquote>
3707                                
3708    
3709  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3710                                  </p>                                  </p>
# Line 2977  Intellectual Property and Copyright Stat Line 3713  Intellectual Property and Copyright Stat
3713                                      error message                                      error message
3714  </p>  </p>
3715  </blockquote>  </blockquote>
3716                                
3717    
3718  </blockquote>  </blockquote><p>
3719                        
3720    </p>
3721  <p>Example:  <p>Example:
3722  </p>  </p>
3723  <p></p>  <p>
3724                            </p>
3725  <blockquote class="text">  <blockquote class="text">
3726  <p>  <p>
3727  </p>  </p>
3728  </blockquote>  </blockquote><p>
3729                        
3730  <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>
3731    <a name="GET AVAILABLE_ENGINES"></a><br /><hr />
3732    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3733    <a name="rfc.section.6.4.7"></a><h3>6.4.7.&nbsp;
3734    Getting amount of available engines</h3>
3735    
3736  <p>The front-end can ask for the number of available engines by sending the following command:  <p>The front-end can ask for the number of available engines by sending the following command:
3737  </p>  </p>
3738  <p></p>  <p>
3739                            </p>
3740  <blockquote class="text">  <blockquote class="text">
3741  <p>GET AVAILABLE_ENGINES  <p>GET AVAILABLE_ENGINES
3742  </p>  </p>
3743  </blockquote>  </blockquote><p>
3744                        
3745    </p>
3746  <p>Possible Answers:  <p>Possible Answers:
3747  </p>  </p>
3748  <p></p>  <p>
3749                            </p>
3750  <blockquote class="text">  <blockquote class="text">
3751  <p>LinuxSampler will answer by sending the number of available engines.  <p>LinuxSampler will answer by sending the number of available engines.
3752  </p>  </p>
3753  </blockquote>  </blockquote><p>
3754                        
3755    </p>
3756  <p>Example:  <p>Example:
3757  </p>  </p>
3758  <p></p>  <p>
3759                            </p>
3760  <blockquote class="text">  <blockquote class="text">
3761  <p>C: "GET AVAILABLE_ENGINES"  <p>C: "GET AVAILABLE_ENGINES"
3762  </p>  </p>
3763  <p>S: "4"  <p>S: "4"
3764  </p>  </p>
3765  </blockquote>  </blockquote><p>
3766                        
3767  <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>
3768    <a name="LIST AVAILABLE_ENGINES"></a><br /><hr />
3769    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3770    <a name="rfc.section.6.4.8"></a><h3>6.4.8.&nbsp;
3771    Getting all available engines</h3>
3772    
3773  <p>The front-end can ask for a list of all available engines by sending the following command:  <p>The front-end can ask for a list of all available engines by sending the following command:
3774  </p>  </p>
3775  <p></p>  <p>
3776                            </p>
3777  <blockquote class="text">  <blockquote class="text">
3778  <p>LIST AVAILABLE_ENGINES  <p>LIST AVAILABLE_ENGINES
3779  </p>  </p>
3780  </blockquote>  </blockquote><p>
3781                        
3782    </p>
3783  <p>Possible Answers:  <p>Possible Answers:
3784  </p>  </p>
3785  <p></p>  <p>
3786                            </p>
3787  <blockquote class="text">  <blockquote class="text">
3788  <p>LinuxSampler will answer by sending a comma separated character  <p>LinuxSampler will answer by sending a comma separated list
3789                              string of the engines' names. Engine names can consist of lower and                              of the engines' names encapsulated into apostrophes (').
3790                              upper cases, digits and underlines ("_" character).                              Engine names can consist of lower and upper cases,
3791                                digits and underlines ("_" character).
3792    </p>
3793    </blockquote><p>
3794                        
3795  </p>  </p>
 </blockquote>  
   
3796  <p>Example:  <p>Example:
3797  </p>  </p>
3798  <p></p>  <p>
3799                            </p>
3800  <blockquote class="text">  <blockquote class="text">
3801  <p>C: "LIST AVAILABLE_ENGINES"  <p>C: "LIST AVAILABLE_ENGINES"
3802  </p>  </p>
3803  <p>S: "GigEngine,AkaiEngine,DLSEngine,JoesCustomEngine"  <p>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"
3804  </p>  </p>
3805  </blockquote>  </blockquote><p>
3806                        
3807  <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>
3808    <a name="GET ENGINE INFO"></a><br /><hr />
3809    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3810    <a name="rfc.section.6.4.9"></a><h3>6.4.9.&nbsp;
3811    Getting information about an engine</h3>
3812    
3813  <p>The front-end can ask for information about a specific engine by  <p>The front-end can ask for information about a specific engine by
3814                      sending the following command:                      sending the following command:
3815  </p>  </p>
3816  <p></p>  <p>
3817                            </p>
3818  <blockquote class="text">  <blockquote class="text">
3819  <p>GET ENGINE INFO &lt;engine-name&gt;  <p>GET ENGINE INFO &lt;engine-name&gt;
3820  </p>  </p>
3821  </blockquote>  </blockquote><p>
3822                        
3823    </p>
3824  <p>Where &lt;engine-name&gt; is an engine name as obtained by the  <p>Where &lt;engine-name&gt; is an engine name as obtained by the
3825                      <a class="info" href="#LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"<span>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.
3826  </p>  </p>
3827  <p>Possible Answers:  <p>Possible Answers:
3828  </p>  </p>
3829  <p></p>  <p>
3830                            </p>
3831  <blockquote class="text">  <blockquote class="text">
3832  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
3833                              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 3835  Intellectual Property and Copyright Stat
3835                              the info character string to that info category. At the moment                              the info character string to that info category. At the moment
3836                              the following categories are defined:                              the following categories are defined:
3837  </p>  </p>
3838  <p></p>  <p>
3839                                    </p>
3840  <blockquote class="text">  <blockquote class="text">
3841  <p>DESCRIPTION -  <p>DESCRIPTION -
3842                                          </p>                                          </p>
# Line 3078  Intellectual Property and Copyright Stat Line 3844  Intellectual Property and Copyright Stat
3844  <p>arbitrary description text about the engine  <p>arbitrary description text about the engine
3845  </p>  </p>
3846  </blockquote>  </blockquote>
3847                                        
3848    
3849  <p>VERSION -  <p>VERSION -
3850                                          </p>                                          </p>
# Line 3085  Intellectual Property and Copyright Stat Line 3852  Intellectual Property and Copyright Stat
3852  <p>arbitrary character string regarding the engine's version  <p>arbitrary character string regarding the engine's version
3853  </p>  </p>
3854  </blockquote>  </blockquote>
3855                                        
3856    
3857  </blockquote>  </blockquote>
3858                                
3859    
3860  </blockquote>  </blockquote><p>
3861                        
3862    </p>
3863  <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.
3864  </p>  </p>
3865  <p>Example:  <p>Example:
3866  </p>  </p>
3867  <p></p>  <p>
3868                            </p>
3869  <blockquote class="text">  <blockquote class="text">
3870  <p>C: "GET ENGINE INFO JoesCustomEngine"  <p>C: "GET ENGINE INFO JoesCustomEngine"
3871  </p>  </p>
# Line 3104  Intellectual Property and Copyright Stat Line 3875  Intellectual Property and Copyright Stat
3875  </p>  </p>
3876  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
3877  </p>  </p>
3878  </blockquote>  </blockquote><p>
3879                        
3880  <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>
3881    <a name="GET CHANNEL INFO"></a><br /><hr />
3882    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
3883    <a name="rfc.section.6.4.10"></a><h3>6.4.10.&nbsp;
3884    Getting sampler channel information</h3>
3885    
3886  <p>The front-end can ask for the current settings of a sampler channel  <p>The front-end can ask for the current settings of a sampler channel
3887                      by sending the following command:                      by sending the following command:
3888  </p>  </p>
3889  <p></p>  <p>
3890                            </p>
3891  <blockquote class="text">  <blockquote class="text">
3892  <p>GET CHANNEL INFO &lt;sampler-channel&gt;  <p>GET CHANNEL INFO &lt;sampler-channel&gt;
3893  </p>  </p>
3894  </blockquote>  </blockquote><p>
3895                        
3896  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in.  </p>
3897    <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
3898                        as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
3899                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command.
3900  </p>  </p>
3901  <p>Possible Answers:  <p>Possible Answers:
3902  </p>  </p>
3903  <p></p>  <p>
3904                            </p>
3905  <blockquote class="text">  <blockquote class="text">
3906  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.  <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
3907                              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 3909  Intellectual Property and Copyright Stat
3909                              the info character string to that setting category. At the                              the info character string to that setting category. At the
3910                              moment the following categories are defined:                              moment the following categories are defined:
3911  </p>  </p>
3912  <p></p>  <p>
3913                                    </p>
3914  <blockquote class="text">  <blockquote class="text">
3915  <p>ENGINE_NAME -  <p>ENGINE_NAME -
3916                                          </p>                                          </p>
3917  <blockquote class="text">  <blockquote class="text">
3918  <p>name of the engine that is deployed on the sampler  <p>name of the engine that is associated with the sampler
3919                                              channel, "NONE" if there's no engine deployed yet for                                              channel, "NONE" if there's no engine associated yet for
3920                                              this sampler channel                                              this sampler channel
3921  </p>  </p>
3922  </blockquote>  </blockquote>
3923                                        
3924    
3925  <p>AUDIO_OUTPUT_DEVICE -  <p>AUDIO_OUTPUT_DEVICE -
3926                                          </p>                                          </p>
# Line 3149  Intellectual Property and Copyright Stat Line 3931  Intellectual Property and Copyright Stat
3931                                              connected to this sampler channel                                              connected to this sampler channel
3932  </p>  </p>
3933  </blockquote>  </blockquote>
3934                                        
3935    
3936  <p>AUDIO_OUTPUT_CHANNELS -  <p>AUDIO_OUTPUT_CHANNELS -
3937                                          </p>                                          </p>
# Line 3157  Intellectual Property and Copyright Stat Line 3940  Intellectual Property and Copyright Stat
3940                                              (dependent to used sampler engine and loaded instrument)                                              (dependent to used sampler engine and loaded instrument)
3941  </p>  </p>
3942  </blockquote>  </blockquote>
3943                                        
3944    
3945  <p>AUDIO_OUTPUT_ROUTING -  <p>AUDIO_OUTPUT_ROUTING -
3946                                          </p>                                          </p>
# Line 3170  Intellectual Property and Copyright Stat Line 3954  Intellectual Property and Copyright Stat
3954                                              output device                                              output device
3955  </p>  </p>
3956  </blockquote>  </blockquote>
3957                                        
3958    
3959  <p>INSTRUMENT_FILE -  <p>INSTRUMENT_FILE -
3960                                          </p>                                          </p>
# Line 3179  Intellectual Property and Copyright Stat Line 3964  Intellectual Property and Copyright Stat
3964                                              channel                                              channel
3965  </p>  </p>
3966  </blockquote>  </blockquote>
3967                                        
3968    
3969  <p>INSTRUMENT_NR -  <p>INSTRUMENT_NR -
3970                                          </p>                                          </p>
# Line 3186  Intellectual Property and Copyright Stat Line 3972  Intellectual Property and Copyright Stat
3972  <p>the instrument index number of the loaded instrument  <p>the instrument index number of the loaded instrument
3973  </p>  </p>
3974  </blockquote>  </blockquote>
3975                                        
3976    
3977  <p>INSTRUMENT_NAME -  <p>INSTRUMENT_NAME -
3978                                          </p>                                          </p>
# Line 3193  Intellectual Property and Copyright Stat Line 3980  Intellectual Property and Copyright Stat
3980  <p>the instrument name of the loaded instrument  <p>the instrument name of the loaded instrument
3981  </p>  </p>
3982  </blockquote>  </blockquote>
3983                                        
3984    
3985  <p>INSTRUMENT_STATUS -  <p>INSTRUMENT_STATUS -
3986                                          </p>                                          </p>
# Line 3202  Intellectual Property and Copyright Stat Line 3990  Intellectual Property and Copyright Stat
3990                                              loaded.                                              loaded.
3991  </p>  </p>
3992  </blockquote>  </blockquote>
3993                                        
3994    
3995  <p>MIDI_INPUT_DEVICE -  <p>MIDI_INPUT_DEVICE -
3996                                          </p>                                          </p>
# Line 3212  Intellectual Property and Copyright Stat Line 4001  Intellectual Property and Copyright Stat
4001                                              connected to this sampler channel                                              connected to this sampler channel
4002  </p>  </p>
4003  </blockquote>  </blockquote>
4004                                        
4005    
4006  <p>MIDI_INPUT_PORT -  <p>MIDI_INPUT_PORT -
4007                                          </p>                                          </p>
# Line 3219  Intellectual Property and Copyright Stat Line 4009  Intellectual Property and Copyright Stat
4009  <p>port number of the MIDI input device  <p>port number of the MIDI input device
4010  </p>  </p>
4011  </blockquote>  </blockquote>
4012                                        
4013    
4014  <p>MIDI_INPUT_CHANNEL -  <p>MIDI_INPUT_CHANNEL -
4015                                          </p>                                          </p>
# Line 3227  Intellectual Property and Copyright Stat Line 4018  Intellectual Property and Copyright Stat
4018                                              should listen to or "ALL" to listen on all MIDI channels                                              should listen to or "ALL" to listen on all MIDI channels
4019  </p>  </p>
4020  </blockquote>  </blockquote>
4021                                        
4022    
4023  <p>VOLUME -  <p>VOLUME -
4024                                          </p>                                          </p>
4025  <blockquote class="text">  <blockquote class="text">
4026  <p>optionally dotted number for the channel volume factor  <p>optionally dotted number for the channel volume factor
4027                                              (where a value < 1.0 means attenuation and a value >                                              (where a value &lt; 1.0 means attenuation and a value >
4028                                              1.0 means amplification)                                              1.0 means amplification)
4029  </p>  </p>
4030  </blockquote>  </blockquote>
4031                                        
4032    
4033    <p>MUTE -
4034                                            </p>
4035    <blockquote class="text">
4036    <p>Determines whether the channel is muted, "true" if the
4037                                                channel is muted, "false" if the channel is not muted, and
4038                                                "MUTED_BY_SOLO" if the channel is muted because of the
4039                                                presence of a solo channel and will be unmuted when
4040                                                there are no solo channels left
4041    </p>
4042    </blockquote>
4043                                        
4044    
4045    <p>SOLO -
4046                                            </p>
4047    <blockquote class="text">
4048    <p>Determines whether this is a solo channel, "true" if
4049                                                the channel is a solo channel; "false" otherwise
4050    </p>
4051  </blockquote>  </blockquote>
4052                                        
4053    
4054    <p>MIDI_INSTRUMENT_MAP -
4055                                            </p>
4056    <blockquote class="text">
4057    <p>Determines to which MIDI instrument map this sampler
4058                                                channel is assigned to. Read chapter
4059                                                <a class='info' href='#SET CHANNEL MIDI_INSTRUMENT_MAP'>"SET CHANNEL MIDI_INSTRUMENT_MAP"<span> (</span><span class='info'>Assigning a MIDI instrument map to a sampler channel</span><span>)</span></a>
4060                                                for a list of possible values.
4061    </p>
4062  </blockquote>  </blockquote>
4063                                        
4064    
4065    </blockquote>
4066                                
4067    
4068    </blockquote><p>
4069                        
4070    </p>
4071  <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.
4072  </p>  </p>
4073  <p>Example:  <p>Example:
4074  </p>  </p>
4075  <p></p>  <p>
4076                            </p>
4077  <blockquote class="text">  <blockquote class="text">
4078  <p>C: "GET CHANNEL INFO 34"  <p>C: "GET CHANNEL INFO 34"
4079  </p>  </p>
# Line 3273  Intellectual Property and Copyright Stat Line 4101  Intellectual Property and Copyright Stat
4101  </p>  </p>
4102  <p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"  <p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"
4103  </p>  </p>
4104    <p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
4105    </p>
4106    <p>&nbsp;&nbsp;&nbsp;"MUTE: false"
4107    </p>
4108    <p>&nbsp;&nbsp;&nbsp;"SOLO: false"
4109    </p>
4110    <p>&nbsp;&nbsp;&nbsp;"MIDI_INSTRUMENT_MAP: NONE"
4111    </p>
4112  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
4113  </p>  </p>
4114  </blockquote>  </blockquote><p>
4115                        
4116  <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>
4117    <a name="GET CHANNEL VOICE_COUNT"></a><br /><hr />
4118    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4119    <a name="rfc.section.6.4.11"></a><h3>6.4.11.&nbsp;
4120    Current number of active voices</h3>
4121    
4122  <p>The front-end can ask for the current number of active voices on a  <p>The front-end can ask for the current number of active voices on a
4123                      sampler channel by sending the following command:                      sampler channel by sending the following command:
4124  </p>  </p>
4125  <p></p>  <p>
4126                            </p>
4127  <blockquote class="text">  <blockquote class="text">
4128  <p>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;  <p>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;
4129  </p>  </p>
4130  </blockquote>  </blockquote><p>
4131                        
4132  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in.  </p>
4133    <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
4134                        as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
4135                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command.
4136  </p>  </p>
4137  <p>Possible Answers:  <p>Possible Answers:
4138  </p>  </p>
4139  <p></p>  <p>
4140                            </p>
4141  <blockquote class="text">  <blockquote class="text">
4142  <p>LinuxSampler will answer by returning the number of active  <p>LinuxSampler will answer by returning the number of active
4143                              voices on that channel.                              voices on that channel.
4144  </p>  </p>
4145  </blockquote>  </blockquote><p>
4146                        
4147    </p>
4148  <p>Example:  <p>Example:
4149  </p>  </p>
4150  <p></p>  <p>
4151                            </p>
4152  <blockquote class="text">  <blockquote class="text">
4153  <p>  <p>
4154  </p>  </p>
4155  </blockquote>  </blockquote><p>
4156                        
4157  <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>
4158    <a name="GET CHANNEL STREAM_COUNT"></a><br /><hr />
4159    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4160    <a name="rfc.section.6.4.12"></a><h3>6.4.12.&nbsp;
4161    Current number of active disk streams</h3>
4162    
4163  <p>The front-end can ask for the current number of active disk streams  <p>The front-end can ask for the current number of active disk streams
4164                      on a sampler channel by sending the following command:                      on a sampler channel by sending the following command:
4165  </p>  </p>
4166  <p></p>  <p>
4167                            </p>
4168  <blockquote class="text">  <blockquote class="text">
4169  <p>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;  <p>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;
4170  </p>  </p>
4171  </blockquote>  </blockquote><p>
4172                        
4173  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in.  </p>
4174    <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
4175                        as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
4176                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command.
4177  </p>  </p>
4178  <p>Possible Answers:  <p>Possible Answers:
4179  </p>  </p>
4180  <p></p>  <p>
4181                            </p>
4182  <blockquote class="text">  <blockquote class="text">
4183  <p>LinuxSampler will answer by returning the number of active  <p>LinuxSampler will answer by returning the number of active
4184                              disk streams on that channel in case the engine supports disk                              disk streams on that channel in case the engine supports disk
4185                              streaming, if the engine doesn't support disk streaming it will                              streaming, if the engine doesn't support disk streaming it will
4186                              return "NA" for not available.                              return "NA" for not available.
4187  </p>  </p>
4188  </blockquote>  </blockquote><p>
4189                        
4190    </p>
4191  <p>Example:  <p>Example:
4192  </p>  </p>
4193  <p></p>  <p>
4194                            </p>
4195  <blockquote class="text">  <blockquote class="text">
4196  <p>  <p>
4197  </p>  </p>
4198  </blockquote>  </blockquote><p>
4199                        
4200  <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>
4201    <a name="GET CHANNEL BUFFER_FILL"></a><br /><hr />
4202    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4203    <a name="rfc.section.6.4.13"></a><h3>6.4.13.&nbsp;
4204    Current fill state of disk stream buffers</h3>
4205    
4206  <p>The front-end can ask for the current fill state of all disk streams  <p>The front-end can ask for the current fill state of all disk streams
4207                      on a sampler channel by sending the following command:                      on a sampler channel by sending the following command:
4208  </p>  </p>
4209  <p></p>  <p>
4210                            </p>
4211  <blockquote class="text">  <blockquote class="text">
4212  <p>GET CHANNEL BUFFER_FILL BYTES &lt;sampler-channel&gt;  <p>GET CHANNEL BUFFER_FILL BYTES &lt;sampler-channel&gt;
4213  </p>  </p>
4214  </blockquote>  </blockquote><p>
4215                        
4216    </p>
4217  <p>to get the fill state in bytes or  <p>to get the fill state in bytes or
4218  </p>  </p>
4219  <p></p>  <p>
4220                            </p>
4221  <blockquote class="text">  <blockquote class="text">
4222  <p>GET CHANNEL BUFFER_FILL PERCENTAGE &lt;sampler-channel&gt;  <p>GET CHANNEL BUFFER_FILL PERCENTAGE &lt;sampler-channel&gt;
4223  </p>  </p>
4224  </blockquote>  </blockquote><p>
4225                        
4226    </p>
4227  <p>to get the fill state in percent, where &lt;sampler-channel&gt; is the  <p>to get the fill state in percent, where &lt;sampler-channel&gt; is the
4228                      sampler channel number the front-end is interested in.                      sampler channel number the front-end is interested in
4229                        as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
4230                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command.
4231  </p>  </p>
4232  <p>Possible Answers:  <p>Possible Answers:
4233  </p>  </p>
4234  <p></p>  <p>
4235                            </p>
4236  <blockquote class="text">  <blockquote class="text">
4237  <p>LinuxSampler will either answer by returning a comma separated  <p>LinuxSampler will either answer by returning a comma separated
4238                              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 4245  Intellectual Property and Copyright Stat
4245                              the response are not in particular order, thus the front-end has                              the response are not in particular order, thus the front-end has
4246                              to sort them by itself if necessary.                              to sort them by itself if necessary.
4247  </p>  </p>
4248  </blockquote>  </blockquote><p>
4249                        
4250    </p>
4251  <p>Examples:  <p>Examples:
4252  </p>  </p>
4253  <p></p>  <p>
4254                            </p>
4255  <blockquote class="text">  <blockquote class="text">
4256  <p>C: "GET CHANNEL BUFFER_FILL BYTES 4"  <p>C: "GET CHANNEL BUFFER_FILL BYTES 4"
4257  </p>  </p>
4258  <p>S: "[115]420500,[116]510300,[75]110000,[120]230700"  <p>S: "[115]420500,[116]510300,[75]110000,[120]230700"
4259  </p>  </p>
4260  </blockquote>  </blockquote><p>
4261    
4262                            </p>
4263  <blockquote class="text">  <blockquote class="text">
4264  <p><p>C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"  <p>C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
4265  </p>  </p>
4266  <p>S: "[115]90%,[116]98%,[75]40%,[120]62%"  <p>S: "[115]90%,[116]98%,[75]40%,[120]62%"
4267  </p>  </p>
4268  </blockquote>  </blockquote><p>
4269    
4270                            </p>
4271  <blockquote class="text">  <blockquote class="text">
4272  <p><p>C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"  <p>C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
4273  </p>  </p>
4274  <p>S: ""  <p>S: ""
4275  </p>  </p>
4276  </blockquote>  </blockquote><p>
4277                        
4278  <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>
4279    <a name="SET CHANNEL AUDIO_OUTPUT_DEVICE"></a><br /><hr />
4280    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4281    <a name="rfc.section.6.4.14"></a><h3>6.4.14.&nbsp;
4282    Setting audio output device</h3>
4283    
4284  <p>The front-end can set the audio output device on a specific sampler  <p>The front-end can set the audio output device on a specific sampler
4285                      channel by sending the following command:                      channel by sending the following command:
4286  </p>  </p>
4287  <p></p>  <p>
4288                            </p>
4289  <blockquote class="text">  <blockquote class="text">
4290  <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;
4291  </p>  </p>
4292  </blockquote>  </blockquote><p>
4293                        
4294  <p>Where &lt;audio-device-id&gt; is the numerical ID of the audio output  </p>
4295                      device and &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4296                      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>
4297                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command and
4298                        &lt;audio-device-id&gt; is the numerical ID of the audio output device as given by the
4299                        <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
4300                        or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
4301                        command.
4302  </p>  </p>
4303  <p>Possible Answers:  <p>Possible Answers:
4304  </p>  </p>
4305  <p></p>  <p>
4306                            </p>
4307  <blockquote class="text">  <blockquote class="text">
4308  <p>"OK" -  <p>"OK" -
4309                                  </p>                                  </p>
# Line 3425  Intellectual Property and Copyright Stat Line 4311  Intellectual Property and Copyright Stat
4311  <p>on success  <p>on success
4312  </p>  </p>
4313  </blockquote>  </blockquote>
4314                                
4315    
4316  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4317                                  </p>                                  </p>
# Line 3434  Intellectual Property and Copyright Stat Line 4321  Intellectual Property and Copyright Stat
4321                                      warning message                                      warning message
4322  </p>  </p>
4323  </blockquote>  </blockquote>
4324                                
4325    
4326  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4327                                  </p>                                  </p>
# Line 3441  Intellectual Property and Copyright Stat Line 4329  Intellectual Property and Copyright Stat
4329  <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
4330  </p>  </p>
4331  </blockquote>  </blockquote>
4332                                
4333    
4334  </blockquote>  </blockquote><p>
4335                        
4336    </p>
4337  <p>Examples:  <p>Examples:
4338  </p>  </p>
4339  <p></p>  <p>
4340                            </p>
4341  <blockquote class="text">  <blockquote class="text">
4342  <p>  <p>
4343  </p>  </p>
4344  </blockquote>  </blockquote><p>
4345                        
4346  <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>
4347    <a name="SET CHANNEL AUDIO_OUTPUT_TYPE"></a><br /><hr />
4348    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4349    <a name="rfc.section.6.4.15"></a><h3>6.4.15.&nbsp;
4350    Setting audio output type</h3>
4351    
4352  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
4353  </p>  </p>
4354  <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
4355                      channel by sending the following command:                      channel by sending the following command:
4356  </p>  </p>
4357  <p></p>  <p>
4358                            </p>
4359  <blockquote class="text">  <blockquote class="text">
4360  <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;
4361  </p>  </p>
4362  </blockquote>  </blockquote><p>
4363                        
4364    </p>
4365  <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
4366                      &lt;sampler-channel&gt; is the respective sampler channel number.                      &lt;sampler-channel&gt; is the respective sampler channel number.
4367  </p>  </p>
4368  <p>Possible Answers:  <p>Possible Answers:
4369  </p>  </p>
4370  <p></p>  <p>
4371                            </p>
4372  <blockquote class="text">  <blockquote class="text">
4373  <p>"OK" -  <p>"OK" -
4374                                  </p>                                  </p>
# Line 3478  Intellectual Property and Copyright Stat Line 4376  Intellectual Property and Copyright Stat
4376  <p>on success  <p>on success
4377  </p>  </p>
4378  </blockquote>  </blockquote>
4379                                
4380    
4381  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4382                                  </p>                                  </p>
# Line 3487  Intellectual Property and Copyright Stat Line 4386  Intellectual Property and Copyright Stat
4386                                      warning message                                      warning message
4387  </p>  </p>
4388  </blockquote>  </blockquote>
4389                                
4390    
4391  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4392                                  </p>                                  </p>
# Line 3494  Intellectual Property and Copyright Stat Line 4394  Intellectual Property and Copyright Stat
4394  <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
4395  </p>  </p>
4396  </blockquote>  </blockquote>
4397                                
4398    
4399  </blockquote>  </blockquote><p>
4400                        
4401    </p>
4402  <p>Examples:  <p>Examples:
4403  </p>  </p>
4404  <p></p>  <p>
4405                            </p>
4406  <blockquote class="text">  <blockquote class="text">
4407  <p>  <p>
4408  </p>  </p>
4409  </blockquote>  </blockquote><p>
4410                        
4411  <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>
4412    <a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
4413    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4414    <a name="rfc.section.6.4.16"></a><h3>6.4.16.&nbsp;
4415    Setting audio output channel</h3>
4416    
4417  <p>The front-end can alter the audio output channel on a specific  <p>The front-end can alter the audio output channel on a specific
4418                      sampler channel by sending the following command:                      sampler channel by sending the following command:
4419  </p>  </p>
4420  <p></p>  <p>
4421                            </p>
4422  <blockquote class="text">  <blockquote class="text">
4423  <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;
4424  </p>  </p>
4425  </blockquote>  </blockquote><p>
4426                        
4427  <p>Where &lt;sampler-chan&gt; is the sampler channel number, &lt;audio-out&gt; is the  </p>
4428    <p>Where &lt;sampler-chan&gt; is the sampler channel number
4429                        as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
4430                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command, &lt;audio-out&gt; is the
4431                      numerical ID of the sampler channel's audio output channel which should be                      numerical ID of the sampler channel's audio output channel which should be
4432                      rerouted and &lt;audio-in&gt; is the numerical ID of the audio channel of the selected audio                      rerouted and &lt;audio-in&gt; is the numerical ID of the audio channel of the selected audio
4433                      output device where &lt;audio-out&gt; should be routed to.                      output device where &lt;audio-out&gt; should be routed to.
4434  </p>  </p>
4435  <p>Possible Answers:  <p>Possible Answers:
4436  </p>  </p>
4437  <p></p>  <p>
4438                            </p>
4439  <blockquote class="text">  <blockquote class="text">
4440  <p>"OK" -  <p>"OK" -
4441                                  </p>                                  </p>
# Line 3531  Intellectual Property and Copyright Stat Line 4443  Intellectual Property and Copyright Stat
4443  <p>on success  <p>on success
4444  </p>  </p>
4445  </blockquote>  </blockquote>
4446                                
4447    
4448  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4449                                  </p>                                  </p>
# Line 3540  Intellectual Property and Copyright Stat Line 4453  Intellectual Property and Copyright Stat
4453                                      warning message                                      warning message
4454  </p>  </p>
4455  </blockquote>  </blockquote>
4456                                
4457    
4458  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4459                                  </p>                                  </p>
# Line 3547  Intellectual Property and Copyright Stat Line 4461  Intellectual Property and Copyright Stat
4461  <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
4462  </p>  </p>
4463  </blockquote>  </blockquote>
4464                                
4465    
4466  </blockquote>  </blockquote><p>
4467                        
4468    </p>
4469  <p>Examples:  <p>Examples:
4470  </p>  </p>
4471  <p></p>  <p>
4472                            </p>
4473  <blockquote class="text">  <blockquote class="text">
4474  <p>  <p>
4475  </p>  </p>
4476  </blockquote>  </blockquote><p>
4477                        
4478  <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>
4479    <a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr />
4480    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4481    <a name="rfc.section.6.4.17"></a><h3>6.4.17.&nbsp;
4482    Setting MIDI input device</h3>
4483    
4484  <p>The front-end can set the MIDI input device on a specific sampler  <p>The front-end can set the MIDI input device on a specific sampler
4485                      channel by sending the following command:                      channel by sending the following command:
4486  </p>  </p>
4487  <p></p>  <p>
4488                            </p>
4489  <blockquote class="text">  <blockquote class="text">
4490  <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;
4491  </p>  </p>
4492  </blockquote>  </blockquote><p>
4493                        
4494  <p>Where &lt;sampler-channel&gt; is the sampler channel number and &lt;midi-device-id&gt; is the  </p>
4495                      the numerical ID of the MIDI input device.  <p>Where &lt;sampler-channel&gt; is the sampler channel number
4496                        as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
4497                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command
4498                        and &lt;midi-device-id&gt; is  the numerical ID of the MIDI input device as returned by the
4499                        <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
4500                        or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a> command.
4501  </p>  </p>
4502  <p>Possible Answers:  <p>Possible Answers:
4503  </p>  </p>
4504  <p></p>  <p>
4505                            </p>
4506  <blockquote class="text">  <blockquote class="text">
4507  <p>"OK" -  <p>"OK" -
4508                                  </p>                                  </p>
# Line 3582  Intellectual Property and Copyright Stat Line 4510  Intellectual Property and Copyright Stat
4510  <p>on success  <p>on success
4511  </p>  </p>
4512  </blockquote>  </blockquote>
4513                                
4514    
4515  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4516                                  </p>                                  </p>
# Line 3591  Intellectual Property and Copyright Stat Line 4520  Intellectual Property and Copyright Stat
4520                                      warning message                                      warning message
4521  </p>  </p>
4522  </blockquote>  </blockquote>
4523                                
4524    
4525  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4526                                  </p>                                  </p>
# Line 3598  Intellectual Property and Copyright Stat Line 4528  Intellectual Property and Copyright Stat
4528  <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
4529  </p>  </p>
4530  </blockquote>  </blockquote>
4531                                
4532    
4533  </blockquote>  </blockquote><p>
4534                        
4535    </p>
4536  <p>Examples:  <p>Examples:
4537  </p>  </p>
4538  <p></p>  <p>
4539                            </p>
4540  <blockquote class="text">  <blockquote class="text">
4541  <p>  <p>
4542  </p>  </p>
4543  </blockquote>  </blockquote><p>
4544                        
4545  <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>
4546    <a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr />
4547    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4548    <a name="rfc.section.6.4.18"></a><h3>6.4.18.&nbsp;
4549    Setting MIDI input type</h3>
4550    
4551  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
4552  </p>  </p>
4553  <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
4554                      channel by sending the following command:                      channel by sending the following command:
4555  </p>  </p>
4556  <p></p>  <p>
4557                            </p>
4558  <blockquote class="text">  <blockquote class="text">
4559  <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;
4560  </p>  </p>
4561  </blockquote>  </blockquote><p>
4562                        
4563    </p>
4564  <p>Where &lt;midi-input-type&gt; is currently only "ALSA" and  <p>Where &lt;midi-input-type&gt; is currently only "ALSA" and
4565                      &lt;sampler-channel&gt; is the respective sampler channel number.                      &lt;sampler-channel&gt; is the respective sampler channel number.
4566  </p>  </p>
4567  <p>Possible Answers:  <p>Possible Answers:
4568  </p>  </p>
4569  <p></p>  <p>
4570                            </p>
4571  <blockquote class="text">  <blockquote class="text">
4572  <p>"OK" -  <p>"OK" -
4573                                  </p>                                  </p>
# Line 3635  Intellectual Property and Copyright Stat Line 4575  Intellectual Property and Copyright Stat
4575  <p>on success  <p>on success
4576  </p>  </p>
4577  </blockquote>  </blockquote>
4578                                
4579    
4580  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4581                                  </p>                                  </p>
# Line 3644  Intellectual Property and Copyright Stat Line 4585  Intellectual Property and Copyright Stat
4585                                      warning message                                      warning message
4586  </p>  </p>
4587  </blockquote>  </blockquote>
4588                                
4589    
4590  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4591                                  </p>                                  </p>
# Line 3651  Intellectual Property and Copyright Stat Line 4593  Intellectual Property and Copyright Stat
4593  <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
4594  </p>  </p>
4595  </blockquote>  </blockquote>
4596                                
4597    
4598  </blockquote>  </blockquote><p>
4599                        
4600    </p>
4601  <p>Examples:  <p>Examples:
4602  </p>  </p>
4603  <p></p>  <p>
4604                            </p>
4605  <blockquote class="text">  <blockquote class="text">
4606  <p>  <p>
4607  </p>  </p>
4608  </blockquote>  </blockquote><p>
4609                        
4610  <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>
4611    <a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr />
4612    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4613    <a name="rfc.section.6.4.19"></a><h3>6.4.19.&nbsp;
4614    Setting MIDI input port</h3>
4615    
4616  <p>The front-end can alter the MIDI input port on a specific sampler  <p>The front-end can alter the MIDI input port on a specific sampler
4617                      channel by sending the following command:                      channel by sending the following command:
4618  </p>  </p>
4619  <p></p>  <p>
4620                            </p>
4621  <blockquote class="text">  <blockquote class="text">
4622  <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;
4623  </p>  </p>
4624  </blockquote>  </blockquote><p>
4625                        
4626    </p>
4627  <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
4628                      MIDI input device connected to the sampler channel given by                      MIDI input device connected to the sampler channel given by
4629                      &lt;sampler-channel&gt;.                      &lt;sampler-channel&gt;.
4630  </p>  </p>
4631  <p>Possible Answers:  <p>Possible Answers:
4632  </p>  </p>
4633  <p></p>  <p>
4634                            </p>
4635  <blockquote class="text">  <blockquote class="text">
4636  <p>"OK" -  <p>"OK" -
4637                                  </p>                                  </p>
# Line 3687  Intellectual Property and Copyright Stat Line 4639  Intellectual Property and Copyright Stat
4639  <p>on success  <p>on success
4640  </p>  </p>
4641  </blockquote>  </blockquote>
4642                                
4643    
4644  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4645                                  </p>                                  </p>
# Line 3696  Intellectual Property and Copyright Stat Line 4649  Intellectual Property and Copyright Stat
4649                                      warning message                                      warning message
4650  </p>  </p>
4651  </blockquote>  </blockquote>
4652                                
4653    
4654  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4655                                  </p>                                  </p>
4656  <blockquote class="text">  <blockquote class="text">
4657  <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
4658  </p>  </p>
4659  </blockquote>  </blockquote>
4660                                
4661    
4662  </blockquote>  </blockquote><p>
4663                        
4664    </p>
4665  <p>Examples:  <p>Examples:
4666  </p>  </p>
4667  <p></p>  <p>
4668                            </p>
4669  <blockquote class="text">  <blockquote class="text">
4670  <p>  <p>
4671  </p>  </p>
4672  </blockquote>  </blockquote><p>
4673                        
4674  <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>
4675    <a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr />
4676    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4677    <a name="rfc.section.6.4.20"></a><h3>6.4.20.&nbsp;
4678    Setting MIDI input channel</h3>
4679    
4680  <p>The front-end can alter the MIDI channel a sampler channel should  <p>The front-end can alter the MIDI channel a sampler channel should
4681                      listen to by sending the following command:                      listen to by sending the following command:
4682  </p>  </p>
4683  <p></p>  <p>
4684                            </p>
4685  <blockquote class="text">  <blockquote class="text">
4686  <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;
4687  </p>  </p>
4688  </blockquote>  </blockquote><p>
4689                        
4690    </p>
4691  <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
4692                      &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
4693                      channels.                      channels.
4694  </p>  </p>
4695  <p>Possible Answers:  <p>Possible Answers:
4696  </p>  </p>
4697  <p></p>  <p>
4698                            </p>
4699  <blockquote class="text">  <blockquote class="text">
4700  <p>"OK" -  <p>"OK" -
4701                                  </p>                                  </p>
# Line 3739  Intellectual Property and Copyright Stat Line 4703  Intellectual Property and Copyright Stat
4703  <p>on success  <p>on success
4704  </p>  </p>
4705  </blockquote>  </blockquote>
4706                                
4707    
4708  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4709                                  </p>                                  </p>
# Line 3748  Intellectual Property and Copyright Stat Line 4713  Intellectual Property and Copyright Stat
4713                                      warning message                                      warning message
4714  </p>  </p>
4715  </blockquote>  </blockquote>
4716                                
4717    
4718  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4719                                  </p>                                  </p>
# Line 3755  Intellectual Property and Copyright Stat Line 4721  Intellectual Property and Copyright Stat
4721  <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
4722  </p>  </p>
4723  </blockquote>  </blockquote>
4724                                
4725    
4726  </blockquote>  </blockquote><p>
4727                        
4728    </p>
4729  <p>Examples:  <p>Examples:
4730  </p>  </p>
4731  <p></p>  <p>
4732                            </p>
4733  <blockquote class="text">  <blockquote class="text">
4734  <p>  <p>
4735  </p>  </p>
4736  </blockquote>  </blockquote><p>
4737                        
4738  <a name="rfc.section.5.4.21"></a><h4><a name="SET CHANNEL VOLUME">5.4.21</a>&nbsp;Setting channel volume</h4>  </p>
4739    <a name="SET CHANNEL VOLUME"></a><br /><hr />
4740    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4741    <a name="rfc.section.6.4.21"></a><h3>6.4.21.&nbsp;
4742    Setting channel volume</h3>
4743    
4744  <p>The front-end can alter the volume of a sampler channel by sending  <p>The front-end can alter the volume of a sampler channel by sending
4745                      the following command:                      the following command:
4746  </p>  </p>
4747  <p></p>  <p>
4748                            </p>
4749  <blockquote class="text">  <blockquote class="text">
4750  <p>SET CHANNEL VOLUME &lt;sampler-channel&gt; &lt;volume&gt;  <p>SET CHANNEL VOLUME &lt;sampler-channel&gt; &lt;volume&gt;
4751  </p>  </p>
4752  </blockquote>  </blockquote><p>
4753                        
4754    </p>
4755  <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
4756                      smaller than 1.0 means attenuation, whereas a value greater than                      smaller than 1.0 means attenuation, whereas a value greater than
4757                      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 4759  Intellectual Property and Copyright Stat
4759  </p>  </p>
4760  <p>Possible Answers:  <p>Possible Answers:
4761  </p>  </p>
4762  <p></p>  <p>
4763                            </p>
4764  <blockquote class="text">  <blockquote class="text">
4765  <p>"OK" -  <p>"OK" -
4766                                  </p>                                  </p>
# Line 3792  Intellectual Property and Copyright Stat Line 4768  Intellectual Property and Copyright Stat
4768  <p>on success  <p>on success
4769  </p>  </p>
4770  </blockquote>  </blockquote>
4771                                
4772    
4773  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4774                                  </p>                                  </p>
# Line 3801  Intellectual Property and Copyright Stat Line 4778  Intellectual Property and Copyright Stat
4778                                      warning message                                      warning message
4779  </p>  </p>
4780  </blockquote>  </blockquote>
4781                                
4782    
4783  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4784                                  </p>                                  </p>
# Line 3808  Intellectual Property and Copyright Stat Line 4786  Intellectual Property and Copyright Stat
4786  <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
4787  </p>  </p>
4788  </blockquote>  </blockquote>
4789                                
4790    
4791    </blockquote><p>
4792                        
4793    </p>
4794    <p>Examples:
4795    </p>
4796    <p>
4797                            </p>
4798    <blockquote class="text">
4799    <p>
4800    </p>
4801    </blockquote><p>
4802                        
4803    </p>
4804    <a name="SET CHANNEL MUTE"></a><br /><hr />
4805    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4806    <a name="rfc.section.6.4.22"></a><h3>6.4.22.&nbsp;
4807    Muting a sampler channel</h3>
4808    
4809    <p>The front-end can mute/unmute a specific sampler
4810                        channel by sending the following command:
4811    </p>
4812    <p>
4813                            </p>
4814    <blockquote class="text">
4815    <p>SET CHANNEL MUTE &lt;sampler-channel&gt; &lt;mute&gt;
4816    </p>
4817    </blockquote><p>
4818                        
4819    </p>
4820    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4821                        number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
4822                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command and
4823                        &lt;mute&gt; should be replaced either by "1" to mute the channel or "0"
4824                        to unmute the channel.
4825    </p>
4826    <p>Possible Answers:
4827    </p>
4828    <p>
4829                            </p>
4830    <blockquote class="text">
4831    <p>"OK" -
4832                                    </p>
4833    <blockquote class="text">
4834    <p>on success
4835    </p>
4836    </blockquote>
4837                                
4838    
4839    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4840                                    </p>
4841    <blockquote class="text">
4842    <p>if the channel was muted/unmuted, but there are noteworthy
4843                                        issue(s) related, providing an appropriate warning code and
4844                                        warning message
4845    </p>
4846  </blockquote>  </blockquote>
4847                                
4848    
4849    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4850                                    </p>
4851    <blockquote class="text">
4852    <p>in case it failed, providing an appropriate error code and error message
4853    </p>
4854    </blockquote>
4855                                
4856    
4857    </blockquote><p>
4858                        
4859    </p>
4860  <p>Examples:  <p>Examples:
4861  </p>  </p>
4862  <p></p>  <p>
4863                            </p>
4864  <blockquote class="text">  <blockquote class="text">
4865  <p>  <p>
4866  </p>  </p>
4867    </blockquote><p>
4868                        
4869    </p>
4870    <a name="SET CHANNEL SOLO"></a><br /><hr />
4871    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4872    <a name="rfc.section.6.4.23"></a><h3>6.4.23.&nbsp;
4873    Soloing a sampler channel</h3>
4874    
4875    <p>The front-end can solo/unsolo a specific sampler channel
4876                        by sending the following command:
4877    </p>
4878    <p>
4879                            </p>
4880    <blockquote class="text">
4881    <p>SET CHANNEL SOLO &lt;sampler-channel&gt; &lt;solo&gt;
4882    </p>
4883    </blockquote><p>
4884                        
4885    </p>
4886    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4887                        number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
4888                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command and
4889                        &lt;solo&gt; should be replaced either by "1" to solo the channel or "0"
4890                        to unsolo the channel.
4891    </p>
4892    <p>Possible Answers:
4893    </p>
4894    <p>
4895                            </p>
4896    <blockquote class="text">
4897    <p>"OK" -
4898                                    </p>
4899    <blockquote class="text">
4900    <p>on success
4901    </p>
4902  </blockquote>  </blockquote>
4903                                
4904    
4905  <a name="rfc.section.5.4.22"></a><h4><a name="RESET CHANNEL">5.4.22</a>&nbsp;Resetting a sampler channel</h4>  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4906                                    </p>
4907    <blockquote class="text">
4908    <p>if the channel was soloed/unsoloed, but there are noteworthy
4909                                        issue(s) related, providing an appropriate warning code and
4910                                        warning message
4911    </p>
4912    </blockquote>
4913                                
4914    
4915  <p>The front-end can reset a particular sampler channel by sending the following command:  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4916                                    </p>
4917    <blockquote class="text">
4918    <p>in case it failed, providing an appropriate error code and error message
4919  </p>  </p>
4920  <p></p>  </blockquote>
4921                                
4922    
4923    </blockquote><p>
4924                        
4925    </p>
4926    <p>Examples:
4927    </p>
4928    <p>
4929                            </p>
4930  <blockquote class="text">  <blockquote class="text">
4931  <p>RESET CHANNEL &lt;sampler-channel&gt;  <p>
4932    </p>
4933    </blockquote><p>
4934                        
4935    </p>
4936    <a name="SET CHANNEL MIDI_INSTRUMENT_MAP"></a><br /><hr />
4937    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4938    <a name="rfc.section.6.4.24"></a><h3>6.4.24.&nbsp;
4939    Assigning a MIDI instrument map to a sampler channel</h3>
4940    
4941    <p>The front-end can assign a MIDI instrument map to a specific sampler channel
4942                        by sending the following command:
4943    </p>
4944    <p>
4945                            </p>
4946    <blockquote class="text">
4947    <p>SET CHANNEL MIDI_INSTRUMENT_MAP &lt;sampler-channel&gt; &lt;map&gt;
4948    </p>
4949    </blockquote><p>
4950                        
4951    </p>
4952    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4953                        number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
4954                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command and
4955                        &lt;map&gt; can have the following possibilites:
4956    </p>
4957    <p>
4958                            </p>
4959    <blockquote class="text">
4960    <p>"NONE" -
4961                                    </p>
4962    <blockquote class="text">
4963    <p>This is the default setting. In this case
4964                                        the sampler channel is not assigned any MIDI
4965                                        instrument map and thus will ignore all MIDI
4966                                        program change messages.
4967  </p>  </p>
4968  </blockquote>  </blockquote>
4969                                
4970    
4971    <p>"DEFAULT" -
4972                                    </p>
4973    <blockquote class="text">
4974    <p>The sampler channel will always use the
4975                                        default MIDI instrument map to handle MIDI
4976                                        program change messages.
4977    </p>
4978    </blockquote>
4979                                
4980    
4981    <p>numeric ID -
4982                                    </p>
4983    <blockquote class="text">
4984    <p>You can assign a specific MIDI instrument map
4985                                        by replacing &lt;map&gt; with the respective numeric
4986                                        ID of the MIDI instrument map as returned by the
4987                                        <a class='info' href='#LIST MIDI_INSTRUMENT_MAPS'>"LIST MIDI_INSTRUMENT_MAPS"<span> (</span><span class='info'>Getting all created MIDI instrument maps</span><span>)</span></a>
4988                                        command. Once that map will be deleted, the sampler
4989                                        channel would fall back to "NONE".
4990    </p>
4991    </blockquote>
4992                                
4993    
4994    </blockquote><p>
4995                        
4996    </p>
4997    <p>Read chapter <a class='info' href='#MIDI Instrument Mapping'>"MIDI Instrument Mapping"<span> (</span><span class='info'>MIDI Instrument Mapping</span><span>)</span></a>
4998                        for details regarding MIDI instrument mapping.
4999    </p>
5000    <p>Possible Answers:
5001    </p>
5002    <p>
5003                            </p>
5004    <blockquote class="text">
5005    <p>"OK" -
5006                                    </p>
5007    <blockquote class="text">
5008    <p>on success
5009    </p>
5010    </blockquote>
5011                                
5012    
5013    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5014                                    </p>
5015    <blockquote class="text">
5016    <p>in case it failed, providing an appropriate error code and error message
5017    </p>
5018    </blockquote>
5019                                
5020    
5021    </blockquote><p>
5022                        
5023    </p>
5024    <p>Examples:
5025    </p>
5026    <p>
5027                            </p>
5028    <blockquote class="text">
5029    <p>
5030    </p>
5031    </blockquote><p>
5032                        
5033    </p>
5034    <a name="CREATE FX_SEND"></a><br /><hr />
5035    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5036    <a name="rfc.section.6.4.25"></a><h3>6.4.25.&nbsp;
5037    Adding an effect send to a sampler channel</h3>
5038    
5039    <p>The front-end can create an additional effect send on a specific sampler channel
5040                        by sending the following command:
5041    </p>
5042    <p>
5043                            </p>
5044    <blockquote class="text">
5045    <p>CREATE FX_SEND &lt;sampler-channel&gt; &lt;midi-ctrl&gt; [&lt;name&gt;]
5046    </p>
5047    </blockquote><p>
5048                        
5049    </p>
5050    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5051                        number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
5052                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command, that is the
5053                        sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
5054                        is a number between 0..127 defining the MIDI controller which can alter the
5055                        effect send level and &lt;name&gt; is an optional argument defining a name
5056                        for the effect send entity. The name does not have to be unique.
5057    </p>
5058    <p>By default, that is as initial routing, the effect send's audio channels
5059                        are automatically routed to the last audio channels of the sampler channel's
5060                        audio output device, that way you can i.e. first increase the amount of audio
5061                        channels on the audio output device for having dedicated effect send output
5062                        channels and when "CREATE FX_SEND" is called, those channels will automatically
5063                        be picked. You can alter the destination channels however with
5064                        <a class='info' href='#SET FX_SEND AUDIO_OUTPUT_CHANNEL'>"SET FX_SEND AUDIO_OUTPUT_CHANNEL"<span> (</span><span class='info'>Altering effect send's audio routing</span><span>)</span></a>.
5065                        
5066    </p>
5067    <p>Note: Create effect sends on a sampler channel only when needed, because having effect
5068                        sends on a sampler channel will decrease runtime performance, because for implementing channel
5069                        effect sends, separate (sampler channel local) audio buffers are needed to render and mix
5070                        the voices and route the audio signal afterwards to the master outputs and effect send
5071                        outputs (along with their respective effect send levels). A sampler channel without effect
5072                        sends however can mix its voices directly into the audio output devices's audio buffers
5073                        and is thus faster.
5074                        
5075    </p>
5076    <p>Possible Answers:
5077    </p>
5078    <p>
5079                            </p>
5080    <blockquote class="text">
5081    <p>"OK[&lt;fx-send-id&gt;]" -
5082                                    </p>
5083    <blockquote class="text">
5084    <p>in case a new effect send could be added to the
5085                                        sampler channel, where &lt;fx-send-id&gt; reflects the
5086                                        unique ID of the newly created effect send entity
5087    </p>
5088    </blockquote>
5089                                
5090    
5091    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5092                                    </p>
5093    <blockquote class="text">
5094    <p>when a new effect send could not be added, i.e.
5095                                        due to invalid parameters
5096    </p>
5097    </blockquote>
5098                                
5099    
5100    </blockquote><p>
5101                        
5102    </p>
5103    <p>Examples:
5104    </p>
5105    <p>
5106                            </p>
5107    <blockquote class="text">
5108    <p>C: "CREATE FX_SEND 0 91 'Reverb Send'"
5109    </p>
5110    <p>S: "OK[0]"
5111    </p>
5112    </blockquote><p>
5113                        
5114    </p>
5115    <p>
5116                            </p>
5117    <blockquote class="text">
5118    <p>C: "CREATE FX_SEND 0 93"
5119    </p>
5120    <p>S: "OK[1]"
5121    </p>
5122    </blockquote><p>
5123                        
5124    </p>
5125    <a name="DESTROY FX_SEND"></a><br /><hr />
5126    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5127    <a name="rfc.section.6.4.26"></a><h3>6.4.26.&nbsp;
5128    Removing an effect send from a sampler channel</h3>
5129    
5130    <p>The front-end can remove an existing effect send on a specific sampler channel
5131                        by sending the following command:
5132    </p>
5133    <p>
5134                            </p>
5135    <blockquote class="text">
5136    <p>DESTROY FX_SEND &lt;sampler-channel&gt; &lt;fx-send-id&gt;
5137    </p>
5138    </blockquote><p>
5139                        
5140    </p>
5141    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5142                        number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
5143                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command, that is the
5144                        sampler channel from which the effect send should be removed from and
5145                        &lt;fx-send-id&gt; is the respective effect send number as returned by the
5146                        <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
5147                        or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command.
5148    </p>
5149    <p>Possible Answers:
5150    </p>
5151    <p>
5152                            </p>
5153    <blockquote class="text">
5154    <p>"OK" -
5155                                    </p>
5156    <blockquote class="text">
5157    <p>on success
5158    </p>
5159    </blockquote>
5160                                
5161    
5162    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5163                                    </p>
5164    <blockquote class="text">
5165    <p>in case it failed, providing an appropriate error code and
5166                                        error message
5167    </p>
5168    </blockquote>
5169                                
5170    
5171    </blockquote><p>
5172                        
5173    </p>
5174    <p>Example:
5175    </p>
5176    <p>
5177                            </p>
5178    <blockquote class="text">
5179    <p>C: "DESTROY FX_SEND 0 0"
5180    </p>
5181    <p>S: "OK"
5182    </p>
5183    </blockquote><p>
5184                        
5185    </p>
5186    <a name="GET FX_SENDS"></a><br /><hr />
5187    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5188    <a name="rfc.section.6.4.27"></a><h3>6.4.27.&nbsp;
5189    Getting amount of effect sends on a sampler channel</h3>
5190    
5191    <p>The front-end can ask for the amount of effect sends on a specific sampler channel
5192                        by sending the following command:
5193    </p>
5194    <p>
5195                            </p>
5196    <blockquote class="text">
5197    <p>GET FX_SENDS &lt;sampler-channel&gt;
5198    </p>
5199    </blockquote><p>
5200                        
5201    </p>
5202    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5203                        number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
5204                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command.
5205    </p>
5206    <p>Possible Answers:
5207    </p>
5208    <p>
5209                            </p>
5210    <blockquote class="text">
5211    <p>The sampler will answer by returning the number of effect
5212                                sends on the given sampler channel.
5213    </p>
5214    </blockquote><p>
5215                        
5216    </p>
5217    <p>Example:
5218    </p>
5219    <p>
5220                            </p>
5221    <blockquote class="text">
5222    <p>C: "GET FX_SENDS 0"
5223    </p>
5224    <p>S: "2"
5225    </p>
5226    </blockquote><p>
5227                        
5228    </p>
5229    <a name="LIST FX_SENDS"></a><br /><hr />
5230    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5231    <a name="rfc.section.6.4.28"></a><h3>6.4.28.&nbsp;
5232    Listing all effect sends on a sampler channel</h3>
5233    
5234    <p>The front-end can ask for a list of effect sends on a specific sampler channel
5235                        by sending the following command:
5236    </p>
5237    <p>
5238                            </p>
5239    <blockquote class="text">
5240    <p>LIST FX_SENDS &lt;sampler-channel&gt;
5241    </p>
5242    </blockquote><p>
5243                        
5244    </p>
5245    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5246                        number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
5247                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command.
5248    </p>
5249    <p>Possible Answers:
5250    </p>
5251    <p>
5252                            </p>
5253    <blockquote class="text">
5254    <p>The sampler will answer by returning a comma separated list
5255                                with all effect sends' numerical IDs on the given sampler
5256                                channel.
5257    </p>
5258    </blockquote><p>
5259                        
5260    </p>
5261    <p>Examples:
5262    </p>
5263    <p>
5264                            </p>
5265    <blockquote class="text">
5266    <p>C: "LIST FX_SENDS 0"
5267    </p>
5268    <p>S: "0,1"
5269    </p>
5270    </blockquote><p>
5271                        
5272    </p>
5273    <p>
5274                            </p>
5275    <blockquote class="text">
5276    <p>C: "LIST FX_SENDS 1"
5277    </p>
5278    <p>S: ""
5279    </p>
5280    </blockquote><p>
5281                        
5282    </p>
5283    <a name="GET FX_SEND INFO"></a><br /><hr />
5284    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5285    <a name="rfc.section.6.4.29"></a><h3>6.4.29.&nbsp;
5286    Getting effect send information</h3>
5287    
5288    <p>The front-end can ask for the current settings of an effect send entity
5289                        by sending the following command:
5290    </p>
5291    <p>
5292                            </p>
5293    <blockquote class="text">
5294    <p>GET FX_SEND INFO &lt;sampler-channel&gt; &lt;fx-send-id&gt;
5295    </p>
5296    </blockquote><p>
5297                        
5298    </p>
5299    <p>Where &lt;sampler-channel&gt; is the sampler channel number
5300                        as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
5301                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command and
5302                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5303                        as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
5304                        or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command.
5305                      
5306    </p>
5307    <p>Possible Answers:
5308    </p>
5309    <p>
5310                            </p>
5311    <blockquote class="text">
5312    <p>The sampler will answer by sending a &lt;CRLF&gt; separated list.
5313                                Each answer line begins with the settings category name
5314                                followed by a colon and then a space character &lt;SP&gt; and finally
5315                                the info character string to that setting category. At the
5316                                moment the following categories are defined:
5317    </p>
5318    <p>
5319                                    </p>
5320    <blockquote class="text">
5321    <p>NAME -
5322                                            </p>
5323    <blockquote class="text">
5324    <p>name of the effect send entity
5325    </p>
5326    </blockquote>
5327                                        
5328    
5329    <p>MIDI_CONTROLLER -
5330                                            </p>
5331    <blockquote class="text">
5332    <p>a value between 0 and 127 reflecting the MIDI controller
5333                                                which is able to modify the effect send's send level
5334    </p>
5335    </blockquote>
5336                                        
5337    
5338    <p>LEVEL -
5339                                            </p>
5340    <blockquote class="text">
5341    <p>optionally dotted number reflecting the effect send's
5342                                                current send level (where a value &lt; 1.0 means attenuation
5343                                                and a value > 1.0 means amplification)
5344    </p>
5345    </blockquote>
5346                                        
5347    
5348    <p>AUDIO_OUTPUT_ROUTING -
5349                                            </p>
5350    <blockquote class="text">
5351    <p>comma separated list which reflects to which audio
5352                                                channel of the selected audio output device each
5353                                                effect send output channel is routed to, e.g. "0,3" would
5354                                                mean the effect send's output channel 0 is routed to channel
5355                                                0 of the audio output device and the effect send's output
5356                                                channel 1 is routed to the channel 3 of the audio
5357                                                output device (see
5358                                                <a class='info' href='#SET FX_SEND AUDIO_OUTPUT_CHANNEL'>"SET FX_SEND AUDIO_OUTPUT_CHANNEL"<span> (</span><span class='info'>Altering effect send's audio routing</span><span>)</span></a>
5359                                                for details)
5360    </p>
5361    </blockquote>
5362                                        
5363    
5364    </blockquote>
5365                                
5366    
5367    </blockquote><p>
5368                        
5369    </p>
5370    <p>The mentioned fields above don't have to be in particular order.
5371    </p>
5372    <p>Example:
5373    </p>
5374    <p>
5375                            </p>
5376    <blockquote class="text">
5377    <p>C: "GET FX_SEND INFO 0 0"
5378    </p>
5379    <p>S: "NAME: Reverb Send"
5380    </p>
5381    <p>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"
5382    </p>
5383    <p>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"
5384    </p>
5385    <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"
5386    </p>
5387    <p>&nbsp;&nbsp;&nbsp;"."
5388    </p>
5389    </blockquote><p>
5390                        
5391    </p>
5392    <a name="SET FX_SEND NAME"></a><br /><hr />
5393    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5394    <a name="rfc.section.6.4.30"></a><h3>6.4.30.&nbsp;
5395    Changing effect send's name</h3>
5396    
5397    <p>The front-end can alter the current name of an effect
5398                        send entity by sending the following command:
5399    </p>
5400    <p>
5401                            </p>
5402    <blockquote class="text">
5403    <p>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;
5404    </p>
5405    </blockquote><p>
5406                        
5407    </p>
5408    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5409                        as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
5410                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command,
5411                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5412                        as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
5413                        or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and
5414                        &lt;name&gt; is the new name of the effect send entity, which
5415                        does not have to be unique.
5416    </p>
5417    <p>Possible Answers:
5418    </p>
5419    <p>
5420                            </p>
5421    <blockquote class="text">
5422    <p>"OK" -
5423                                    </p>
5424    <blockquote class="text">
5425    <p>on success
5426    </p>
5427    </blockquote>
5428                                
5429    
5430    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5431                                    </p>
5432    <blockquote class="text">
5433    <p>in case it failed, providing an appropriate error code and error message
5434    </p>
5435    </blockquote>
5436                                
5437    
5438    </blockquote><p>
5439                        
5440    </p>
5441    <p>Example:
5442    </p>
5443    <p>
5444                            </p>
5445    <blockquote class="text">
5446    <p>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
5447    </p>
5448    <p>S: "OK"
5449    </p>
5450    </blockquote><p>
5451                        
5452    </p>
5453    <a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
5454    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5455    <a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;
5456    Altering effect send's audio routing</h3>
5457    
5458    <p>The front-end can alter the destination of an effect send's audio channel on a specific
5459                        sampler channel by sending the following command:
5460    </p>
5461    <p>
5462                            </p>
5463    <blockquote class="text">
5464    <p>SET FX_SEND AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;audio-src&gt; &lt;audio-dst&gt;
5465    </p>
5466    </blockquote><p>
5467                        
5468    </p>
5469    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5470                        as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
5471                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command,
5472                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5473                        as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
5474                        or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command,
5475                        &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
5476                        which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
5477                        the audio channel of the selected audio output device where &lt;audio-src&gt;
5478                        should be routed to.
5479    </p>
5480    <p>Note that effect sends can only route audio to the same audio output
5481                        device as assigned to the effect send's sampler channel. Also note that an
5482                        effect send entity does always have exactly as much audio channels as its
5483                        sampler channel. So if the sampler channel is stereo, the effect send does
5484                        have two audio channels as well. Also keep in mind that the amount of audio
5485                        channels on a sampler channel might be dependant not only to the deployed
5486                        sampler engine on the sampler channel, but also dependant to the instrument
5487                        currently loaded. However you can (effectively) turn an i.e. stereo effect
5488                        send into a mono one by simply altering its audio routing appropriately.
5489    </p>
5490    <p>Possible Answers:
5491    </p>
5492    <p>
5493                            </p>
5494    <blockquote class="text">
5495    <p>"OK" -
5496                                    </p>
5497    <blockquote class="text">
5498    <p>on success
5499    </p>
5500    </blockquote>
5501                                
5502    
5503    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5504                                    </p>
5505    <blockquote class="text">
5506    <p>if audio output channel was set, but there are noteworthy
5507                                        issue(s) related, providing an appropriate warning code and
5508                                        warning message
5509    </p>
5510    </blockquote>
5511                                
5512    
5513    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5514                                    </p>
5515    <blockquote class="text">
5516    <p>in case it failed, providing an appropriate error code and error message
5517    </p>
5518    </blockquote>
5519                                
5520    
5521    </blockquote><p>
5522                        
5523    </p>
5524    <p>Example:
5525    </p>
5526    <p>
5527                            </p>
5528    <blockquote class="text">
5529    <p>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
5530    </p>
5531    <p>S: "OK"
5532    </p>
5533    </blockquote><p>
5534                        
5535    </p>
5536    <a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />
5537    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5538    <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;
5539    Altering effect send's MIDI controller</h3>
5540    
5541    <p>The front-end can alter the MIDI controller of an effect
5542                        send entity by sending the following command:
5543    </p>
5544    <p>
5545                            </p>
5546    <blockquote class="text">
5547    <p>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;
5548    </p>
5549    </blockquote><p>
5550                        
5551    </p>
5552    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5553                        as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
5554                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command,
5555                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5556                        as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
5557                        or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and
5558                        &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
5559                        able to modify the effect send's send level.
5560    </p>
5561    <p>Possible Answers:
5562    </p>
5563    <p>
5564                            </p>
5565    <blockquote class="text">
5566    <p>"OK" -
5567                                    </p>
5568    <blockquote class="text">
5569    <p>on success
5570    </p>
5571    </blockquote>
5572                                
5573    
5574    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5575                                    </p>
5576    <blockquote class="text">
5577    <p>if MIDI controller was set, but there are noteworthy
5578                                        issue(s) related, providing an appropriate warning code and
5579                                        warning message
5580    </p>
5581    </blockquote>
5582                                
5583    
5584    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5585                                    </p>
5586    <blockquote class="text">
5587    <p>in case it failed, providing an appropriate error code and error message
5588    </p>
5589    </blockquote>
5590                                
5591    
5592    </blockquote><p>
5593                        
5594    </p>
5595    <p>Example:
5596    </p>
5597    <p>
5598                            </p>
5599    <blockquote class="text">
5600    <p>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
5601    </p>
5602    <p>S: "OK"
5603    </p>
5604    </blockquote><p>
5605                        
5606    </p>
5607    <a name="SET FX_SEND LEVEL"></a><br /><hr />
5608    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5609    <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;
5610    Altering effect send's send level</h3>
5611    
5612    <p>The front-end can alter the current send level of an effect
5613                        send entity by sending the following command:
5614    </p>
5615    <p>
5616                            </p>
5617    <blockquote class="text">
5618    <p>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;
5619    </p>
5620    </blockquote><p>
5621                        
5622    </p>
5623    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5624                        as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
5625                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command,
5626                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5627                        as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
5628                        or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and
5629                        &lt;volume&gt; is an optionally dotted positive number (a value
5630                        smaller than 1.0 means attenuation, whereas a value greater than
5631                        1.0 means amplification) reflecting the new send level.
5632    </p>
5633    <p>Possible Answers:
5634    </p>
5635    <p>
5636                            </p>
5637    <blockquote class="text">
5638    <p>"OK" -
5639                                    </p>
5640    <blockquote class="text">
5641    <p>on success
5642    </p>
5643    </blockquote>
5644                                
5645    
5646    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5647                                    </p>
5648    <blockquote class="text">
5649    <p>if new send level was set, but there are noteworthy
5650                                        issue(s) related, providing an appropriate warning code and
5651                                        warning message
5652    </p>
5653    </blockquote>
5654                                
5655    
5656    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5657                                    </p>
5658    <blockquote class="text">
5659    <p>in case it failed, providing an appropriate error code and error message
5660    </p>
5661    </blockquote>
5662                                
5663    
5664    </blockquote><p>
5665                        
5666    </p>
5667    <p>Example:
5668    </p>
5669    <p>
5670                            </p>
5671    <blockquote class="text">
5672    <p>C: "SET FX_SEND LEVEL 0 0 0.15"
5673    </p>
5674    <p>S: "OK"
5675    </p>
5676    </blockquote><p>
5677                        
5678    </p>
5679    <a name="RESET CHANNEL"></a><br /><hr />
5680    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5681    <a name="rfc.section.6.4.34"></a><h3>6.4.34.&nbsp;
5682    Resetting a sampler channel</h3>
5683    
5684    <p>The front-end can reset a particular sampler channel by sending the following command:
5685    </p>
5686    <p>
5687                            </p>
5688    <blockquote class="text">
5689    <p>RESET CHANNEL &lt;sampler-channel&gt;
5690    </p>
5691    </blockquote><p>
5692                        
5693    </p>
5694  <p>  <p>
5695                      Where &lt;sampler-channel&gt; defines the sampler channel to be reset.                      Where &lt;sampler-channel&gt; defines the sampler channel to be reset.
5696                      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 5699  Intellectual Property and Copyright Stat
5699  </p>  </p>
5700  <p>Possible Answers:  <p>Possible Answers:
5701  </p>  </p>
5702  <p></p>  <p>
5703                            </p>
5704  <blockquote class="text">  <blockquote class="text">
5705  <p>"OK" -  <p>"OK" -
5706                                  </p>                                  </p>
# Line 3845  Intellectual Property and Copyright Stat Line 5708  Intellectual Property and Copyright Stat
5708  <p>on success  <p>on success
5709  </p>  </p>
5710  </blockquote>  </blockquote>
5711                                
5712    
5713  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5714                                  </p>                                  </p>
# Line 3854  Intellectual Property and Copyright Stat Line 5718  Intellectual Property and Copyright Stat
5718                                      message                                      message
5719  </p>  </p>
5720  </blockquote>  </blockquote>
5721                                
5722    
5723  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5724                                  </p>                                  </p>
# Line 3862  Intellectual Property and Copyright Stat Line 5727  Intellectual Property and Copyright Stat
5727                                      error message                                      error message
5728  </p>  </p>
5729  </blockquote>  </blockquote>
5730                                
5731    
5732  </blockquote>  </blockquote><p>
5733                        
5734    </p>
5735  <p>Examples:  <p>Examples:
5736  </p>  </p>
5737  <p></p>  <p>
5738                            </p>
5739  <blockquote class="text">  <blockquote class="text">
5740  <p>  <p>
5741  </p>  </p>
5742  </blockquote>  </blockquote><p>
5743                        
5744  <a name="rfc.section.5.5"></a><h4><a name="anchor13">5.5</a>&nbsp;Controlling connection</h4>  </p>
5745    <a name="anchor12"></a><br /><hr />
5746    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5747    <a name="rfc.section.6.5"></a><h3>6.5.&nbsp;
5748    Controlling connection</h3>
5749    
5750  <p>The following commands are used to control the connection to LinuxSampler.  <p>The following commands are used to control the connection to LinuxSampler.
5751  </p>  </p>
5752  <a name="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="SUBSCRIBE"></a><br /><hr />
5753    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5754    <a name="rfc.section.6.5.1"></a><h3>6.5.1.&nbsp;
5755    Register front-end for receiving event messages</h3>
5756    
5757  <p>The front-end can register itself to the LinuxSampler application to  <p>The front-end can register itself to the LinuxSampler application to
5758                      be informed about noteworthy events by sending this command:                      be informed about noteworthy events by sending this command:
5759  </p>  </p>
5760  <p></p>  <p>
5761                            </p>
5762  <blockquote class="text">  <blockquote class="text">
5763  <p>SUBSCRIBE &lt;event-id&gt;  <p>SUBSCRIBE &lt;event-id&gt;
5764  </p>  </p>
5765  </blockquote>  </blockquote><p>
5766                        
5767    </p>
5768  <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
5769                      client wants to subscribe to.                      client wants to subscribe to.
5770  </p>  </p>
5771  <p>Possible Answers:  <p>Possible Answers:
5772  </p>  </p>
5773  <p></p>  <p>
5774                            </p>
5775  <blockquote class="text">  <blockquote class="text">
5776  <p>"OK" -  <p>"OK" -
5777                                  </p>                                  </p>
# Line 3901  Intellectual Property and Copyright Stat Line 5779  Intellectual Property and Copyright Stat
5779  <p>on success  <p>on success
5780  </p>  </p>
5781  </blockquote>  </blockquote>
5782                                
5783    
5784  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5785                                  </p>                                  </p>
# Line 3910  Intellectual Property and Copyright Stat Line 5789  Intellectual Property and Copyright Stat
5789                                      warning message                                      warning message
5790  </p>  </p>
5791  </blockquote>  </blockquote>
5792                                
5793    
5794  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5795                                  </p>                                  </p>
# Line 3918  Intellectual Property and Copyright Stat Line 5798  Intellectual Property and Copyright Stat
5798                                      error message                                      error message
5799  </p>  </p>
5800  </blockquote>  </blockquote>
5801                                
5802    
5803  </blockquote>  </blockquote><p>
5804                        
5805    </p>
5806  <p>Examples:  <p>Examples:
5807  </p>  </p>
5808  <p></p>  <p>
5809                            </p>
5810  <blockquote class="text">  <blockquote class="text">
5811  <p>  <p>
5812  </p>  </p>
5813  </blockquote>  </blockquote><p>
5814                        
5815  <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>
5816    <a name="UNSUBSCRIBE"></a><br /><hr />
5817    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5818    <a name="rfc.section.6.5.2"></a><h3>6.5.2.&nbsp;
5819    Unregister front-end for not receiving event messages</h3>
5820    
5821  <p>The front-end can unregister itself if it doesn't want to receive event  <p>The front-end can unregister itself if it doesn't want to receive event
5822                      messages anymore by sending the following command:                      messages anymore by sending the following command:
5823  </p>  </p>
5824  <p></p>  <p>
5825                            </p>
5826  <blockquote class="text">  <blockquote class="text">
5827  <p>UNSUBSCRIBE &lt;event-id&gt;  <p>UNSUBSCRIBE &lt;event-id&gt;
5828  </p>  </p>
5829  </blockquote>  </blockquote><p>
5830                        
5831    </p>
5832  <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
5833                      client doesn't want to receive anymore.                      client doesn't want to receive anymore.
5834  </p>  </p>
5835  <p>Possible Answers:  <p>Possible Answers:
5836  </p>  </p>
5837  <p></p>  <p>
5838                            </p>
5839  <blockquote class="text">  <blockquote class="text">
5840  <p>"OK" -  <p>"OK" -
5841                                  </p>                                  </p>
# Line 3953  Intellectual Property and Copyright Stat Line 5843  Intellectual Property and Copyright Stat
5843  <p>on success  <p>on success
5844  </p>  </p>
5845  </blockquote>  </blockquote>
5846                                
5847    
5848  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -  <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5849                                  </p>                                  </p>
# Line 3962  Intellectual Property and Copyright Stat Line 5853  Intellectual Property and Copyright Stat
5853                                      warning message                                      warning message
5854  </p>  </p>
5855  </blockquote>  </blockquote>
5856                                
5857    
5858  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5859                                  </p>                                  </p>
# Line 3970  Intellectual Property and Copyright Stat Line 5862  Intellectual Property and Copyright Stat
5862                                      error message                                      error message
5863  </p>  </p>
5864  </blockquote>  </blockquote>
5865                                
5866    
5867  </blockquote>  </blockquote><p>
5868                        
5869    </p>
5870  <p>Examples:  <p>Examples:
5871  </p>  </p>
5872  <p></p>  <p>
5873                            </p>
5874  <blockquote class="text">  <blockquote class="text">
5875  <p>  <p>
5876  </p>  </p>
5877  </blockquote>  </blockquote><p>
5878                        
5879  <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>
5880    <a name="SET ECHO"></a><br /><hr />
5881    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5882    <a name="rfc.section.6.5.3"></a><h3>6.5.3.&nbsp;
5883    Enable or disable echo of commands</h3>
5884    
5885  <p>To enable or disable back sending of commands to the client the following command can be used:  <p>To enable or disable back sending of commands to the client the following command can be used:
5886  </p>  </p>
5887  <p></p>  <p>
5888                            </p>
5889  <blockquote class="text">  <blockquote class="text">
5890  <p>SET ECHO &lt;value&gt;  <p>SET ECHO &lt;value&gt;
5891  </p>  </p>
5892  </blockquote>  </blockquote><p>
5893                        
5894    </p>
5895  <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
5896                      or "0" to disable echo mode. When echo mode is enabled, all                      or "0" to disable echo mode. When echo mode is enabled, all
5897                      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 5902  Intellectual Property and Copyright Stat
5902  </p>  </p>
5903  <p>Possible Answers:  <p>Possible Answers:
5904  </p>  </p>
5905  <p></p>  <p>
5906                            </p>
5907  <blockquote class="text">  <blockquote class="text">
5908  <p>"OK" -  <p>"OK" -
5909                                  </p>                                  </p>
# Line 4009  Intellectual Property and Copyright Stat Line 5911  Intellectual Property and Copyright Stat
5911  <p>usually  <p>usually
5912  </p>  </p>
5913  </blockquote>  </blockquote>
5914                                
5915    
5916  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5917                                  </p>                                  </p>
# Line 4016  Intellectual Property and Copyright Stat Line 5919  Intellectual Property and Copyright Stat
5919  <p>on syntax error, e.g. non boolean value  <p>on syntax error, e.g. non boolean value
5920  </p>  </p>
5921  </blockquote>  </blockquote>
5922                                
5923    
5924  </blockquote>  </blockquote><p>
5925                        
5926    </p>
5927  <p>Examples:  <p>Examples:
5928  </p>  </p>
5929  <p></p>  <p>
5930                            </p>
5931  <blockquote class="text">  <blockquote class="text">
5932  <p>  <p>
5933  </p>  </p>
5934  </blockquote>  </blockquote><p>
5935                        
5936  <a name="rfc.section.5.5.4"></a><h4><a name="QUIT">5.5.4</a>&nbsp;Close client connection</h4>  </p>
5937    <a name="QUIT"></a><br /><hr />
5938    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5939    <a name="rfc.section.6.5.4"></a><h3>6.5.4.&nbsp;
5940    Close client connection</h3>
5941    
5942  <p>The client can close its network connection to LinuxSampler by sending the following command:  <p>The client can close its network connection to LinuxSampler by sending the following command:
5943  </p>  </p>
5944  <p></p>  <p>
5945                            </p>
5946  <blockquote class="text">  <blockquote class="text">
5947  <p>QUIT  <p>QUIT
5948  </p>  </p>
5949  </blockquote>  </blockquote><p>
5950                        
5951    </p>
5952  <p>This is probably more interesting for manual telnet connections to  <p>This is probably more interesting for manual telnet connections to
5953                      LinuxSampler than really useful for a front-end implementation.                      LinuxSampler than really useful for a front-end implementation.
5954  </p>  </p>
5955  <a name="rfc.section.5.6"></a><h4><a name="anchor14">5.6</a>&nbsp;Global commands</h4>  <a name="anchor13"></a><br /><hr />
5956    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5957    <a name="rfc.section.6.6"></a><h3>6.6.&nbsp;
5958    Global commands</h3>
5959    
5960  <p>The following commands have global impact on the sampler.  <p>The following commands have global impact on the sampler.
5961  </p>  </p>
5962  <a name="rfc.section.5.6.1"></a><h4><a name="RESET">5.6.1</a>&nbsp;Reset sampler</h4>  <a name="GET TOTAL_VOICE_COUNT"></a><br /><hr />
5963    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5964    <a name="rfc.section.6.6.1"></a><h3>6.6.1.&nbsp;
5965    Current number of active voices</h3>
5966    
5967    <p>The front-end can ask for the current number of active voices on
5968                        the sampler by sending the following command:
5969    </p>
5970    <p>
5971                            </p>
5972    <blockquote class="text">
5973    <p>GET TOTAL_VOICE_COUNT
5974    </p>
5975    </blockquote><p>
5976                        
5977    </p>
5978    <p>Possible Answers:
5979    </p>
5980    <p>
5981                            </p>
5982    <blockquote class="text">
5983    <p>LinuxSampler will answer by returning the number of all active
5984                                voices on the sampler.
5985    </p>
5986    </blockquote><p>
5987                        
5988    </p>
5989    <a name="GET TOTAL_VOICE_COUNT_MAX"></a><br /><hr />
5990    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5991    <a name="rfc.section.6.6.2"></a><h3>6.6.2.&nbsp;
5992    Maximum amount of active voices</h3>
5993    
5994    <p>The front-end can ask for the maximum number of active voices
5995                        by sending the following command:
5996    </p>
5997    <p>
5998                            </p>
5999    <blockquote class="text">
6000    <p>GET TOTAL_VOICE_COUNT_MAX
6001    </p>
6002    </blockquote><p>
6003                        
6004    </p>
6005    <p>Possible Answers:
6006    </p>
6007    <p>
6008                            </p>
6009    <blockquote class="text">
6010    <p>LinuxSampler will answer by returning the maximum number
6011                                of active voices.
6012    </p>
6013    </blockquote><p>
6014                        
6015    </p>
6016    <a name="RESET"></a><br /><hr />
6017    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6018    <a name="rfc.section.6.6.3"></a><h3>6.6.3.&nbsp;
6019    Reset sampler</h3>
6020    
6021  <p>The front-end can reset the whole sampler by sending the following command:  <p>The front-end can reset the whole sampler by sending the following command:
6022  </p>  </p>
6023  <p></p>  <p>
6024                            </p>
6025  <blockquote class="text">  <blockquote class="text">
6026  <p>RESET  <p>RESET
6027  </p>  </p>
6028    </blockquote><p>
6029                        
6030    </p>
6031    <p>Possible Answers:
6032    </p>
6033    <p>
6034                            </p>
6035    <blockquote class="text">
6036    <p>"OK" -
6037                                    </p>
6038    <blockquote class="text">
6039    <p>always
6040    </p>
6041    </blockquote>
6042                                
6043    
6044    </blockquote><p>
6045                        
6046    </p>
6047    <p>Examples:
6048    </p>
6049    <p>
6050                            </p>
6051    <blockquote class="text">
6052    <p>
6053    </p>
6054    </blockquote><p>
6055                        
6056    </p>
6057    <a name="GET SERVER INFO"></a><br /><hr />
6058    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6059    <a name="rfc.section.6.6.4"></a><h3>6.6.4.&nbsp;
6060    General sampler informations</h3>
6061    
6062    <p>The client can ask for general informations about the LinuxSampler
6063                           instance by sending the following command:
6064    </p>
6065    <p>
6066                            </p>
6067    <blockquote class="text">
6068    <p>GET SERVER INFO
6069    </p>
6070    </blockquote><p>
6071                        
6072    </p>
6073    <p>Possible Answers:
6074    </p>
6075    <p>
6076                            </p>
6077    <blockquote class="text">
6078    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6079                                   Each answer line begins with the information category name
6080                                   followed by a colon and then a space character &lt;SP&gt; and finally
6081                                   the info character string to that information category. At the
6082                                   moment the following categories are defined:
6083                                
6084    </p>
6085    <p>
6086                                    </p>
6087    <blockquote class="text">
6088    <p>DESCRIPTION -
6089                                            </p>
6090    <blockquote class="text">
6091    <p>arbitrary textual description about the sampler
6092    </p>
6093    </blockquote>
6094                                        
6095    
6096    <p>VERSION -
6097                                            </p>
6098    <blockquote class="text">
6099    <p>version of the sampler
6100    </p>
6101    </blockquote>
6102                                        
6103    
6104    <p>PROTOCOL_VERSION -
6105                                            </p>
6106    <blockquote class="text">
6107    <p>version of the LSCP specification the sampler
6108                                                complies with (see <a class='info' href='#LSCP versioning'>Section&nbsp;2<span> (</span><span class='info'>Versioning of this specification</span><span>)</span></a> for details)
6109    </p>
6110    </blockquote>
6111                                        
6112    
6113    <p>INSTRUMENTS_DB_SUPPORT -
6114                                            </p>
6115    <blockquote class="text">
6116    <p>either yes or no, specifies whether the
6117                                                sampler is build with instruments database support.
6118    </p>
6119    </blockquote>
6120                                        
6121    
6122    </blockquote>
6123                                
6124    
6125    </blockquote><p>
6126                        
6127    </p>
6128    <p>The mentioned fields above don't have to be in particular order.
6129                        Other fields might be added in future.
6130    </p>
6131    <a name="GET VOLUME"></a><br /><hr />
6132    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6133    <a name="rfc.section.6.6.5"></a><h3>6.6.5.&nbsp;
6134    Getting global volume attenuation</h3>
6135    
6136    <p>The client can ask for the current global sampler-wide volume
6137                        attenuation by sending the following command:
6138    </p>
6139    <p>
6140                            </p>
6141    <blockquote class="text">
6142    <p>GET VOLUME
6143    </p>
6144    </blockquote><p>
6145                        
6146    </p>
6147    <p>Possible Answers:
6148    </p>
6149    <p>
6150                            </p>
6151    <blockquote class="text">
6152    <p>The sampler will always answer by returning the optional
6153                                dotted floating point coefficient, reflecting the current
6154                                global volume attenuation.
6155                                
6156    </p>
6157    </blockquote><p>
6158                        
6159    </p>
6160    <p>Note: it is up to the respective sampler engine whether to obey
6161                        that global volume parameter or not, but in general all engines SHOULD
6162                        use this parameter.
6163    </p>
6164    <a name="SET VOLUME"></a><br /><hr />
6165    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6166    <a name="rfc.section.6.6.6"></a><h3>6.6.6.&nbsp;
6167    Setting global volume attenuation</h3>
6168    
6169    <p>The client can alter the current global sampler-wide volume
6170                        attenuation by sending the following command:
6171    </p>
6172    <p>
6173                            </p>
6174    <blockquote class="text">
6175    <p>SET VOLUME &lt;volume&gt;
6176    </p>
6177    </blockquote><p>
6178                        
6179    </p>
6180    <p>Where &lt;volume&gt; should be replaced by the optional dotted
6181                       floating point value, reflecting the new global volume parameter.
6182                       This value might usually be in the range between 0.0 and 1.0, that
6183                       is for attenuating the overall volume.
6184    </p>
6185    <p>Possible Answers:
6186    </p>
6187    <p>
6188                            </p>
6189    <blockquote class="text">
6190    <p>"OK" -
6191                                    </p>
6192    <blockquote class="text">
6193    <p>on success
6194    </p>
6195    </blockquote>
6196                                
6197    
6198    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6199                                    </p>
6200    <blockquote class="text">
6201    <p>if the global volume was set, but there are noteworthy
6202                                        issue(s) related, providing an appropriate warning code and
6203                                        warning message
6204    </p>
6205    </blockquote>
6206                                
6207    
6208    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6209                                    </p>
6210    <blockquote class="text">
6211    <p>in case it failed, providing an appropriate error code and error message
6212    </p>
6213    </blockquote>
6214                                
6215    
6216    </blockquote><p>
6217                        
6218    </p>
6219    <a name="MIDI Instrument Mapping"></a><br /><hr />
6220    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6221    <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;
6222    MIDI Instrument Mapping</h3>
6223    
6224    <p>The MIDI protocol provides a way to switch between instruments
6225                    by sending so called MIDI bank select and MIDI program change
6226                    messages which are essentially just numbers. The following commands
6227                    allow to actually map arbitrary MIDI bank select / program change
6228                    numbers with real instruments.
6229    </p>
6230    <p>The sampler allows to manage an arbitrary amount of MIDI
6231                    instrument maps which define which instrument to load on
6232                    which MIDI program change message.
6233    </p>
6234    <p>By default, that is when the sampler is launched, there is no
6235                    map, thus the sampler will simply ignore all program change
6236                    messages. The front-end has to explicitly create at least one
6237                    map, add entries to the map and tell the respective sampler
6238                    channel(s) which MIDI instrument map to use, so the sampler
6239                    knows how to react on a given program change message on the
6240                    respective sampler channel, that is by switching to the
6241                    respectively defined engine type and loading the respective
6242                    instrument. See command
6243                    <a class='info' href='#SET CHANNEL MIDI_INSTRUMENT_MAP'>"SET CHANNEL MIDI_INSTRUMENT_MAP"<span> (</span><span class='info'>Assigning a MIDI instrument map to a sampler channel</span><span>)</span></a>
6244                    for how to assign a MIDI instrument map to a sampler channel.
6245    </p>
6246    <p>Also note per MIDI specification a bank select message does not
6247                    cause to switch to another instrument. Instead when receiving a
6248                    bank select message the bank value will be stored and a subsequent
6249                    program change message (which may occur at any time) will finally
6250                    cause the sampler to switch to the respective instrument as
6251                    reflected by the current MIDI instrument map.
6252    </p>
6253    <a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr />
6254    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6255    <a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;
6256    Create a new MIDI instrument map</h3>
6257    
6258    <p>The front-end can add a new MIDI instrument map by sending
6259                        the following command:
6260    </p>
6261    <p>
6262                            </p>
6263    <blockquote class="text">
6264    <p>ADD MIDI_INSTRUMENT_MAP [&lt;name&gt;]
6265    </p>
6266    </blockquote><p>
6267                        
6268    </p>
6269    <p>Where &lt;name&gt; is an optional argument allowing to
6270                        assign a custom name to the new map. MIDI instrument Map
6271                        names do not have to be unique.
6272    </p>
6273    <p>Possible Answers:
6274    </p>
6275    <p>
6276                            </p>
6277    <blockquote class="text">
6278    <p>"OK[&lt;map&gt;]" -
6279                                    </p>
6280    <blockquote class="text">
6281    <p>in case a new MIDI instrument map could
6282                                        be added, where &lt;map&gt; reflects the
6283                                        unique ID of the newly created MIDI
6284                                        instrument map
6285    </p>
6286    </blockquote>
6287                                
6288    
6289    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6290                                    </p>
6291    <blockquote class="text">
6292    <p>when a new map could not be created, which
6293                                        might never occur in practice
6294    </p>
6295    </blockquote>
6296                                
6297    
6298    </blockquote><p>
6299                        
6300    </p>
6301    <p>Examples:
6302    </p>
6303    <p>
6304                            </p>
6305    <blockquote class="text">
6306    <p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
6307    </p>
6308    <p>S: "OK[0]"
6309    </p>
6310    </blockquote><p>
6311                        
6312    </p>
6313    <p>
6314                            </p>
6315    <blockquote class="text">
6316    <p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
6317    </p>
6318    <p>S: "OK[1]"
6319    </p>
6320    </blockquote><p>
6321                        
6322    </p>
6323    <p>
6324                            </p>
6325    <blockquote class="text">
6326    <p>C: "ADD MIDI_INSTRUMENT_MAP"
6327    </p>
6328    <p>S: "OK[5]"
6329    </p>
6330    </blockquote><p>
6331                        
6332    </p>
6333    <a name="REMOVE MIDI_INSTRUMENT_MAP"></a><br /><hr />
6334    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6335    <a name="rfc.section.6.7.2"></a><h3>6.7.2.&nbsp;
6336    Delete one particular or all MIDI instrument maps</h3>
6337    
6338    <p>The front-end can delete a particular MIDI instrument map
6339                        by sending the following command:
6340    </p>
6341    <p>
6342                            </p>
6343    <blockquote class="text">
6344    <p>REMOVE MIDI_INSTRUMENT_MAP &lt;map&gt;
6345    </p>
6346    </blockquote><p>
6347                        
6348    </p>
6349    <p>Where &lt;map&gt; reflects the unique ID of the map to delete
6350                        as returned by the <a class='info' href='#LIST MIDI_INSTRUMENT_MAPS'>"LIST MIDI_INSTRUMENT_MAPS"<span> (</span><span class='info'>Getting all created MIDI instrument maps</span><span>)</span></a>
6351                        command.
6352    </p>
6353    <p>The front-end can delete all MIDI instrument maps by
6354                        sending the following command:
6355    </p>
6356    <p>
6357                            </p>
6358    <blockquote class="text">
6359    <p>REMOVE MIDI_INSTRUMENT_MAP ALL
6360    </p>
6361    </blockquote><p>
6362                        
6363    </p>
6364    <p>Possible Answers:
6365    </p>
6366    <p>
6367                            </p>
6368    <blockquote class="text">
6369    <p>"OK" -
6370                                    </p>
6371    <blockquote class="text">
6372    <p>in case the map(s) could be deleted
6373    </p>
6374    </blockquote>
6375                                
6376    
6377    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6378                                    </p>
6379    <blockquote class="text">
6380    <p>when the given map does not exist
6381    </p>
6382    </blockquote>
6383                                
6384    
6385    </blockquote><p>
6386                        
6387    </p>
6388    <p>Examples:
6389    </p>
6390    <p>
6391                            </p>
6392    <blockquote class="text">
6393    <p>C: "REMOVE MIDI_INSTRUMENT_MAP 0"
6394    </p>
6395    <p>S: "OK"
6396    </p>
6397    </blockquote><p>
6398                        
6399    </p>
6400    <p>
6401                            </p>
6402    <blockquote class="text">
6403    <p>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
6404    </p>
6405    <p>S: "OK"
6406    </p>
6407    </blockquote><p>
6408                        
6409    </p>
6410    <a name="GET MIDI_INSTRUMENT_MAPS"></a><br /><hr />
6411    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6412    <a name="rfc.section.6.7.3"></a><h3>6.7.3.&nbsp;
6413    Get amount of existing MIDI instrument maps</h3>
6414    
6415    <p>The front-end can retrieve the current amount of MIDI
6416                        instrument maps by sending the following command:
6417    </p>
6418    <p>
6419                            </p>
6420    <blockquote class="text">
6421    <p>GET MIDI_INSTRUMENT_MAPS
6422    </p>
6423    </blockquote><p>
6424                        
6425    </p>
6426    <p>Possible Answers:
6427    </p>
6428    <p>
6429                            </p>
6430    <blockquote class="text">
6431    <p>The sampler will answer by returning the current
6432                                number of MIDI instrument maps.
6433    </p>
6434    </blockquote><p>
6435                        
6436    </p>
6437    <p>Example:
6438    </p>
6439    <p>
6440                            </p>
6441    <blockquote class="text">
6442    <p>C: "GET MIDI_INSTRUMENT_MAPS"
6443    </p>
6444    <p>S: "2"
6445    </p>
6446    </blockquote><p>
6447                        
6448    </p>
6449    <a name="LIST MIDI_INSTRUMENT_MAPS"></a><br /><hr />
6450    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6451    <a name="rfc.section.6.7.4"></a><h3>6.7.4.&nbsp;
6452    Getting all created MIDI instrument maps</h3>
6453    
6454    <p>The number of MIDI instrument maps can change on runtime. To get the
6455                        current list of MIDI instrument maps, the front-end can send the
6456                        following command:
6457    </p>
6458    <p>
6459                            </p>
6460    <blockquote class="text">
6461    <p>LIST MIDI_INSTRUMENT_MAPS
6462    </p>
6463    </blockquote><p>
6464                        
6465    </p>
6466    <p>Possible Answers:
6467    </p>
6468    <p>
6469                            </p>
6470    <blockquote class="text">
6471    <p>The sampler will answer by returning a comma separated list
6472                                with all MIDI instrument maps' numerical IDs.
6473    </p>
6474    </blockquote><p>
6475                        
6476    </p>
6477    <p>Example:
6478    </p>
6479    <p>
6480                            </p>
6481    <blockquote class="text">
6482    <p>C: "LIST MIDI_INSTRUMENT_MAPS"
6483    </p>
6484    <p>S: "0,1,5,12"
6485    </p>
6486    </blockquote><p>
6487                        
6488    </p>
6489    <a name="GET MIDI_INSTRUMENT_MAP INFO"></a><br /><hr />
6490    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6491    <a name="rfc.section.6.7.5"></a><h3>6.7.5.&nbsp;
6492    Getting MIDI instrument map information</h3>
6493    
6494    <p>The front-end can ask for the current settings of a MIDI
6495                        instrument map by sending the following command:
6496    </p>
6497    <p>
6498                            </p>
6499    <blockquote class="text">
6500    <p>GET MIDI_INSTRUMENT_MAP INFO &lt;map&gt;
6501    </p>
6502    </blockquote><p>
6503                        
6504    </p>
6505    <p>Where &lt;map&gt; is the numerical ID of the map the
6506                        front-end is interested in as returned by the
6507                        <a class='info' href='#LIST MIDI_INSTRUMENT_MAPS'>"LIST MIDI_INSTRUMENT_MAPS"<span> (</span><span class='info'>Getting all created MIDI instrument maps</span><span>)</span></a>
6508                        command.
6509    </p>
6510    <p>Possible Answers:
6511    </p>
6512    <p>
6513                            </p>
6514    <blockquote class="text">
6515    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6516                                Each answer line begins with the settings category name
6517                                followed by a colon and then a space character &lt;SP&gt; and finally
6518                                the info character string to that setting category. At the
6519                                moment the following categories are defined:
6520    </p>
6521    <p>
6522                                    </p>
6523    <blockquote class="text">
6524    <p>NAME -
6525                                            </p>
6526    <blockquote class="text">
6527    <p>custom name of the given map,
6528                                                which does not have to be unique
6529    </p>
6530    </blockquote>
6531                                        
6532    
6533    <p>DEFAULT -
6534                                            </p>
6535    <blockquote class="text">
6536    <p>either true or false,
6537                                                defines whether this map is the default map
6538    </p>
6539    </blockquote>
6540                                        
6541    
6542    </blockquote>
6543                                
6544    
6545    </blockquote><p>
6546                        
6547    </p>
6548    <p>The mentioned fields above don't have to be in particular order.
6549    </p>
6550    <p>Example:
6551    </p>
6552    <p>
6553                            </p>
6554    <blockquote class="text">
6555    <p>C: "GET MIDI_INSTRUMENT_MAP INFO 0"
6556    </p>
6557    <p>S: "NAME: Standard Map"
6558    </p>
6559    <p>&nbsp;&nbsp;&nbsp;"DEFAULT: true"
6560    </p>
6561    <p>&nbsp;&nbsp;&nbsp;"."
6562    </p>
6563    </blockquote><p>
6564                        
6565    </p>
6566    <a name="SET MIDI_INSTRUMENT_MAP NAME"></a><br /><hr />
6567    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6568    <a name="rfc.section.6.7.6"></a><h3>6.7.6.&nbsp;
6569    Renaming a MIDI instrument map</h3>
6570    
6571    <p>The front-end can alter the custom name of a MIDI
6572                        instrument map by sending the following command:
6573    </p>
6574    <p>
6575                            </p>
6576    <blockquote class="text">
6577    <p>SET MIDI_INSTRUMENT_MAP NAME &lt;map&gt; &lt;name&gt;
6578    </p>
6579    </blockquote><p>
6580                        
6581    </p>
6582    <p>Where &lt;map&gt; is the numerical ID of the map and
6583                        &lt;name&gt; the new custom name of the map, which does not
6584                        have to be unique.
6585    </p>
6586    <p>Possible Answers:
6587    </p>
6588    <p>
6589                            </p>
6590    <blockquote class="text">
6591    <p>"OK" -
6592                                    </p>
6593    <blockquote class="text">
6594    <p>on success
6595    </p>
6596    </blockquote>
6597                                
6598    
6599    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6600                                    </p>
6601    <blockquote class="text">
6602    <p>in case the given map does not exist
6603    </p>
6604    </blockquote>
6605                                
6606    
6607    </blockquote><p>
6608                        
6609    </p>
6610    <p>Example:
6611    </p>
6612    <p>
6613                            </p>
6614    <blockquote class="text">
6615    <p>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
6616    </p>
6617    <p>S: "OK"
6618    </p>
6619    </blockquote><p>
6620                        
6621    </p>
6622    <a name="MAP MIDI_INSTRUMENT"></a><br /><hr />
6623    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6624    <a name="rfc.section.6.7.7"></a><h3>6.7.7.&nbsp;
6625    Create or replace a MIDI instrument map entry</h3>
6626    
6627    <p>The front-end can create a new or replace an existing entry
6628                        in a sampler's MIDI instrument map by sending the following
6629                        command:
6630    </p>
6631    <p>
6632                            </p>
6633    <blockquote class="text">
6634    <p>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
6635                                &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
6636                                &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
6637                                [&lt;instr_load_mode&gt;] [&lt;name&gt;]
6638    </p>
6639    </blockquote><p>
6640                        
6641    </p>
6642    <p>Where &lt;map&gt; is the numeric ID of the map to alter,
6643                        &lt;midi_bank&gt; is an integer value between
6644                        0..16383 reflecting the MIDI bank select index,
6645                        &lt;midi_prog&gt; an
6646                        integer value between 0..127 reflecting the MIDI program change
6647                        index, &lt;engine_name&gt; a sampler engine name as returned by
6648                        the <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a>
6649                        command (not encapsulated into apostrophes), &lt;filename&gt; the name
6650                        of the instrument's file to be deployed (encapsulated into apostrophes),
6651                        &lt;instrument_index&gt; the index (integer value) of the instrument
6652                        within the given file, &lt;volume_value&gt; reflects the master
6653                        volume of the instrument as optionally dotted number (where a
6654                        value &lt; 1.0 means attenuation and a value > 1.0 means
6655                        amplification). This parameter easily allows to adjust the
6656                        volume of all intruments within a custom instrument map
6657                        without having to adjust their instrument files. The
6658                        OPTIONAL &lt;instr_load_mode&gt; argument defines the life
6659                        time of the instrument, that is when the instrument should
6660                        be loaded, when freed and has exactly the following
6661                        possibilities:
6662    </p>
6663    <p>
6664                            </p>
6665    <blockquote class="text">
6666    <p>"ON_DEMAND" -
6667                                    </p>
6668    <blockquote class="text">
6669    <p>The instrument will be loaded when needed,
6670                                        that is when demanded by at least one sampler
6671                                        channel. It will immediately be freed from memory
6672                                        when not needed by any sampler channel anymore.
6673    </p>
6674    </blockquote>
6675                                
6676    
6677    <p>"ON_DEMAND_HOLD" -
6678                                    </p>
6679    <blockquote class="text">
6680    <p>The instrument will be loaded when needed,
6681                                        that is when demanded by at least one sampler
6682                                        channel. It will be kept in memory even when
6683                                        not needed by any sampler channel anymore.
6684                                        Instruments with this mode are only freed
6685                                        when the sampler is reset or all mapping
6686                                        entries with this mode (and respective
6687                                        instrument) are explicitly changed to
6688                                        "ON_DEMAND" and no sampler channel is using
6689                                        the instrument anymore.
6690    </p>
6691    </blockquote>
6692                                
6693    
6694    <p>"PERSISTENT" -
6695                                    </p>
6696    <blockquote class="text">
6697    <p>The instrument will immediately be loaded
6698                                        into memory when this mapping
6699                                        command is sent and the instrument is kept all
6700                                        the time. Instruments with this mode are
6701                                        only freed when the sampler is reset or all
6702                                        mapping entries with this mode (and
6703                                        respective instrument) are explicitly
6704                                        changed to "ON_DEMAND" and no sampler
6705                                        channel is using the instrument anymore.
6706    </p>
6707    </blockquote>
6708                                
6709    
6710    <p>not supplied -
6711                                    </p>
6712    <blockquote class="text">
6713    <p>In case there is no &lt;instr_load_mode&gt;
6714                                        argument given, it will be up to the
6715                                        InstrumentManager to decide which mode to use.
6716                                        Usually it will use "ON_DEMAND" if an entry
6717                                        for the given instrument does not exist in
6718                                        the InstrumentManager's list yet, otherwise
6719                                        if an entry already exists, it will simply
6720                                        stick with the mode currently reflected by
6721                                        the already existing entry, that is it will
6722                                        not change the mode.
6723    </p>
6724  </blockquote>  </blockquote>
6725                                
6726    
6727    </blockquote><p>
6728                        
6729    </p>
6730    <p>
6731                        The &lt;instr_load_mode&gt; argument thus allows to define an
6732                        appropriate strategy (low memory consumption vs. fast
6733                        instrument switching) for each instrument individually. Note, the
6734                        following restrictions apply to this argument: "ON_DEMAND_HOLD" and
6735                        "PERSISTENT" have to be supported by the respective sampler engine
6736                        (which is technically the case when the engine provides an
6737                        InstrumentManager for its format). If this is not the case the
6738                        argument will automatically fall back to the default value
6739                        "ON_DEMAND". Also the load mode of one instrument may
6740                        automatically change the laod mode of other instrument(s), i.e.
6741                        because the instruments are part of the same file and the
6742                        engine does not allow a way to manage load modes for them
6743                        individually. Due to this, in case the frontend shows the
6744                        load modes of entries, the frontend should retrieve the actual
6745                        mode by i.e. sending
6746                        <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>
6747                        command(s). Finally the OPTIONAL &lt;name&gt; argument allows to
6748                        set a custom name (encapsulated into apostrophes) for the mapping
6749                        entry, useful for frontends for displaying an appropriate name for
6750                        mapped instruments (using
6751                        <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>).
6752                        
6753    </p>
6754    <p>
6755                        By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
6756                        completely established in the sampler. The OPTIONAL "NON_MODAL" argument
6757                        however causes the respective "MAP MIDI_INSTRUMENT" command to return
6758                        immediately, that is to let the sampler establish the mapping in the
6759                        background. So this argument might be especially useful for mappings with
6760                        a "PERSISTENT" type, because these have to load the respective instruments
6761                        immediately and might thus block for a very long time. It is recommended
6762                        however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
6763                        because it has the following drawbacks: as "NON_MODAL" instructions return
6764                        immediately, they may not necessarily return an error i.e. when the given
6765                        instrument file turns out to be corrupt, beside that subsequent commands
6766                        in a LSCP instruction sequence might fail, because mandatory mappings are
6767                        not yet completed.
6768                        
6769    </p>
6770  <p>Possible Answers:  <p>Possible Answers:
6771  </p>  </p>
6772  <p></p>  <p>
6773                            </p>
6774    <blockquote class="text">
6775    <p>"OK" -
6776                                    </p>
6777    <blockquote class="text">
6778    <p>usually
6779    </p>
6780    </blockquote>
6781                                
6782    
6783    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6784                                    </p>
6785    <blockquote class="text">
6786    <p>when the given map or engine does not exist or a value
6787                                        is out of range
6788    </p>
6789    </blockquote>
6790                                
6791    
6792    </blockquote><p>
6793                        
6794    </p>
6795    <p>Examples:
6796    </p>
6797    <p>
6798                            </p>
6799    <blockquote class="text">
6800    <p>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"
6801    </p>
6802    <p>S: "OK"
6803    </p>
6804    </blockquote><p>
6805                        
6806    </p>
6807    <p>
6808                            </p>
6809    <blockquote class="text">
6810    <p>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"
6811    </p>
6812    <p>S: "OK"
6813    </p>
6814    </blockquote><p>
6815                        
6816    </p>
6817    <p>
6818                            </p>
6819    <blockquote class="text">
6820    <p>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"
6821    </p>
6822    <p>S: "OK"
6823    </p>
6824    <p>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"
6825    </p>
6826    <p>S: "OK"
6827    </p>
6828    </blockquote><p>
6829                        
6830    </p>
6831    <p>
6832                            </p>
6833    <blockquote class="text">
6834    <p>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
6835    </p>
6836    <p>S: "OK"
6837    </p>
6838    </blockquote><p>
6839                        
6840    </p>
6841    <a name="GET MIDI_INSTRUMENTS"></a><br /><hr />
6842    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6843    <a name="rfc.section.6.7.8"></a><h3>6.7.8.&nbsp;
6844    Getting ammount of MIDI instrument map entries</h3>
6845    
6846    <p>The front-end can query the amount of currently existing
6847                        entries in a MIDI instrument map by sending the following
6848                        command:
6849    </p>
6850    <p>
6851                            </p>
6852    <blockquote class="text">
6853    <p>GET MIDI_INSTRUMENTS &lt;map&gt;
6854    </p>
6855    </blockquote><p>
6856                        
6857    </p>
6858    <p>The front-end can query the amount of currently existing
6859                        entries in all MIDI instrument maps by sending the following
6860                        command:
6861    </p>
6862    <p>
6863                            </p>
6864    <blockquote class="text">
6865    <p>GET MIDI_INSTRUMENTS ALL
6866    </p>
6867    </blockquote><p>
6868                        
6869    </p>
6870    <p>Possible Answers:
6871    </p>
6872    <p>
6873                            </p>
6874    <blockquote class="text">
6875    <p>The sampler will answer by sending the current number of
6876                                entries in the MIDI instrument map(s).
6877    </p>
6878    </blockquote><p>
6879                        
6880    </p>
6881    <p>Example:
6882    </p>
6883    <p>
6884                            </p>
6885    <blockquote class="text">
6886    <p>C: "GET MIDI_INSTRUMENTS 0"
6887    </p>
6888    <p>S: "234"
6889    </p>
6890    </blockquote><p>
6891                        
6892    </p>
6893    <p>
6894                            </p>
6895    <blockquote class="text">
6896    <p>C: "GET MIDI_INSTRUMENTS ALL"
6897    </p>
6898    <p>S: "954"
6899    </p>
6900    </blockquote><p>
6901                        
6902    </p>
6903    <a name="LIST MIDI_INSTRUMENTS"></a><br /><hr />
6904    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6905    <a name="rfc.section.6.7.9"></a><h3>6.7.9.&nbsp;
6906    Getting indeces of all entries of a MIDI instrument map</h3>
6907    
6908    <p>The front-end can query a list of all currently existing
6909                        entries in a certain MIDI instrument map by sending the following
6910                        command:
6911    </p>
6912    <p>
6913                            </p>
6914    <blockquote class="text">
6915    <p>LIST MIDI_INSTRUMENTS &lt;map&gt;
6916    </p>
6917    </blockquote><p>
6918                        
6919    </p>
6920    <p>Where &lt;map&gt; is the numeric ID of the MIDI instrument map.
6921    </p>
6922    <p>The front-end can query a list of all currently existing
6923                        entries of all MIDI instrument maps by sending the following
6924                        command:
6925    </p>
6926    <p>
6927                            </p>
6928    <blockquote class="text">
6929    <p>LIST MIDI_INSTRUMENTS ALL
6930    </p>
6931    </blockquote><p>
6932                        
6933    </p>
6934    <p>Possible Answers:
6935    </p>
6936    <p>
6937                            </p>
6938    <blockquote class="text">
6939    <p>The sampler will answer by sending a comma separated
6940                                list of map ID - MIDI bank - MIDI program triples, where
6941                                each triple is encapsulated into curly braces. The
6942                                list is returned in one single line. Each triple
6943                                just reflects the key of the respective map entry,
6944                                thus subsequent
6945                                <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>
6946                                command(s) are necessary to retrieve detailed informations
6947                                about each entry.
6948    </p>
6949    </blockquote><p>
6950                        
6951    </p>
6952    <p>Example:
6953    </p>
6954    <p>
6955                            </p>
6956    <blockquote class="text">
6957    <p>C: "LIST MIDI_INSTRUMENTS 0"
6958    </p>
6959    <p>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
6960    </p>
6961    </blockquote><p>
6962                        
6963    </p>
6964    <a name="UNMAP MIDI_INSTRUMENT"></a><br /><hr />
6965    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6966    <a name="rfc.section.6.7.10"></a><h3>6.7.10.&nbsp;
6967    Remove an entry from the MIDI instrument map</h3>
6968    
6969    <p>The front-end can delete an entry from a MIDI instrument
6970                        map by sending the following command:
6971    </p>
6972    <p>
6973                            </p>
6974    <blockquote class="text">
6975    <p>UNMAP MIDI_INSTRUMENT &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;
6976    </p>
6977    </blockquote><p>
6978                        
6979    </p>
6980    <p>
6981                        Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
6982                        &lt;midi_bank&gt; is an integer value between 0..16383
6983                        reflecting the MIDI bank value and
6984                        &lt;midi_prog&gt; an integer value between
6985                        0..127 reflecting the MIDI program value of the map's entrie's key
6986                        index triple.
6987                        
6988    </p>
6989    <p>Possible Answers:
6990    </p>
6991    <p>
6992                            </p>
6993    <blockquote class="text">
6994    <p>"OK" -
6995                                    </p>
6996    <blockquote class="text">
6997    <p>usually
6998    </p>
6999    </blockquote>
7000                                
7001    
7002    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7003                                    </p>
7004    <blockquote class="text">
7005    <p>when index out of bounds
7006    </p>
7007    </blockquote>
7008                                
7009    
7010    </blockquote><p>
7011                        
7012    </p>
7013    <p>Example:
7014    </p>
7015    <p>
7016                            </p>
7017    <blockquote class="text">
7018    <p>C: "UNMAP MIDI_INSTRUMENT 0 2 127"
7019    </p>
7020    <p>S: "OK"
7021    </p>
7022    </blockquote><p>
7023                        
7024    </p>
7025    <a name="GET MIDI_INSTRUMENT INFO"></a><br /><hr />
7026    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7027    <a name="rfc.section.6.7.11"></a><h3>6.7.11.&nbsp;
7028    Get current settings of MIDI instrument map entry</h3>
7029    
7030    <p>The front-end can retrieve the current settings of a certain
7031                        instrument map entry by sending the following command:
7032    </p>
7033    <p>
7034                            </p>
7035    <blockquote class="text">
7036    <p>GET MIDI_INSTRUMENT INFO &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;
7037    </p>
7038    </blockquote><p>
7039                        
7040    </p>
7041    <p>
7042                        Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
7043                        &lt;midi_bank&gt; is an integer value between 0..16383
7044                        reflecting the MIDI bank value, &lt;midi_bank&gt;
7045                        and &lt;midi_prog&gt; an integer value between
7046                        0..127 reflecting the MIDI program value of the map's entrie's key
7047                        index triple.
7048                        
7049    </p>
7050    <p>Possible Answers:
7051    </p>
7052    <p>
7053                            </p>
7054    <blockquote class="text">
7055    <p>LinuxSampler will answer by sending a &lt;CRLF&gt;
7056                                separated list. Each answer line begins with the
7057                                information category name followed by a colon and then
7058                                a space character &lt;SP&gt; and finally the info
7059                                character string to that info category. At the moment
7060                                the following categories are defined:
7061    </p>
7062    <p>"NAME" -
7063                                    </p>
7064    <blockquote class="text">
7065    <p>Name for this MIDI instrument map entry (if defined).
7066                                        This name shall be used by frontends for displaying a
7067                                        name for this mapped instrument. It can be set and
7068                                        changed with the
7069                                        <a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a>
7070                                        command and does not have to be unique.
7071    </p>
7072    </blockquote>
7073                                
7074    
7075    <p>"ENGINE_NAME" -
7076                                    </p>
7077    <blockquote class="text">
7078    <p>Name of the engine to be deployed for this
7079                                        instrument.
7080    </p>
7081    </blockquote>
7082                                
7083    
7084    <p>"INSTRUMENT_FILE" -
7085                                    </p>
7086    <blockquote class="text">
7087    <p>File name of the instrument.
7088    </p>
7089    </blockquote>
7090                                
7091    
7092    <p>"INSTRUMENT_NR" -
7093                                    </p>
7094    <blockquote class="text">
7095    <p>Index of the instrument within the file.
7096    </p>
7097    </blockquote>
7098                                
7099    
7100    <p>"INSTRUMENT_NAME" -
7101                                    </p>
7102    <blockquote class="text">
7103    <p>Name of the loaded instrument as reflected by its file.
7104                                        In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
7105                                        cannot be changed.
7106    </p>
7107    </blockquote>
7108                                
7109    
7110    <p>"LOAD_MODE" -
7111                                    </p>
7112    <blockquote class="text">
7113    <p>Life time of instrument
7114                                        (see <a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a> for details about this setting).
7115    </p>
7116    </blockquote>
7117                                
7118    
7119    <p>"VOLUME" -
7120                                    </p>
7121    <blockquote class="text">
7122    <p>master volume of the instrument as optionally
7123                                        dotted number (where a value &lt; 1.0 means attenuation
7124                                        and a value > 1.0 means amplification)
7125    </p>
7126    </blockquote>
7127                                
7128    
7129    <p>The mentioned fields above don't have to be in particular order.
7130    </p>
7131    </blockquote><p>
7132                        
7133    </p>
7134    <p>Example:
7135    </p>
7136    <p>
7137                            </p>
7138    <blockquote class="text">
7139    <p>C: "GET MIDI_INSTRUMENT INFO 1 45 120"
7140    </p>
7141    <p>S: "NAME: Drums for Foo Song"
7142    </p>
7143    <p>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"
7144    </p>
7145    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
7146    </p>
7147    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"
7148    </p>
7149    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Joe's Drumkit"
7150    </p>
7151    <p>&nbsp;&nbsp;&nbsp;"LOAD_MODE: PERSISTENT"
7152    </p>
7153    <p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
7154    </p>
7155    <p>&nbsp;&nbsp;&nbsp;"."
7156    </p>
7157    </blockquote><p>
7158                        
7159    </p>
7160    <a name="CLEAR MIDI_INSTRUMENTS"></a><br /><hr />
7161    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7162    <a name="rfc.section.6.7.12"></a><h3>6.7.12.&nbsp;
7163    Clear MIDI instrument map</h3>
7164    
7165    <p>The front-end can clear a whole MIDI instrument map, that
7166                        is delete all its entries by sending the following command:
7167    </p>
7168    <p>
7169                            </p>
7170    <blockquote class="text">
7171    <p>CLEAR MIDI_INSTRUMENTS &lt;map&gt;
7172    </p>
7173    </blockquote><p>
7174                        
7175    </p>
7176    <p>Where &lt;map&gt; is the numeric ID of the map to clear.
7177    </p>
7178    <p>The front-end can clear all MIDI instrument maps, that
7179                        is delete all entries of all maps by sending the following
7180                        command:
7181    </p>
7182    <p>
7183                            </p>
7184    <blockquote class="text">
7185    <p>CLEAR MIDI_INSTRUMENTS ALL
7186    </p>
7187    </blockquote><p>
7188                        
7189    </p>
7190    <p>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the
7191                        maps, only their entries, thus the map's settings like
7192                        custom name will be preservevd.
7193    </p>
7194    <p>Possible Answers:
7195    </p>
7196    <p>
7197                            </p>
7198  <blockquote class="text">  <blockquote class="text">
7199  <p>"OK" -  <p>"OK" -
7200                                  </p>                                  </p>
# Line 4064  Intellectual Property and Copyright Stat Line 7202  Intellectual Property and Copyright Stat
7202  <p>always  <p>always
7203  </p>  </p>
7204  </blockquote>  </blockquote>
7205                                
7206    
7207    </blockquote><p>
7208                        
7209    </p>
7210    <p>Examples:
7211    </p>
7212    <p>
7213                           </p>
7214    <blockquote class="text">
7215    <p>C: "CLEAR MIDI_INSTRUMENTS 0"
7216    </p>
7217    <p>S: "OK"
7218    </p>
7219    </blockquote><p>
7220                        
7221    </p>
7222    <p>
7223                           </p>
7224    <blockquote class="text">
7225    <p>C: "CLEAR MIDI_INSTRUMENTS ALL"
7226    </p>
7227    <p>S: "OK"
7228    </p>
7229    </blockquote><p>
7230                        
7231    </p>
7232    <a name="Managing Instruments Database"></a><br /><hr />
7233    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7234    <a name="rfc.section.6.8"></a><h3>6.8.&nbsp;
7235    Managing Instruments Database</h3>
7236    
7237    <p>The following commands describe how to use and manage
7238                    the instruments database.
7239    </p>
7240    <a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7241    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7242    <a name="rfc.section.6.8.1"></a><h3>6.8.1.&nbsp;
7243    Creating a new instrument directory</h3>
7244    
7245    <p>The front-end can add a new instrument directory to the
7246                        instruments database by sending the following command:
7247    </p>
7248    <p>
7249                            </p>
7250    <blockquote class="text">
7251    <p>ADD DB_INSTRUMENT_DIRECTORY &lt;dir&gt;
7252    </p>
7253    </blockquote><p>
7254                        
7255    </p>
7256    <p>Where &lt;dir&gt; is the absolute path name of the directory
7257                        to be created (encapsulated into apostrophes).
7258    </p>
7259    <p>Possible Answers:
7260    </p>
7261    <p>
7262                            </p>
7263    <blockquote class="text">
7264    <p>"OK" -
7265                                    </p>
7266    <blockquote class="text">
7267    <p>on success
7268    </p>
7269    </blockquote>
7270                                
7271    
7272    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7273                                    </p>
7274    <blockquote class="text">
7275    <p>when the directory could not be created, which
7276                                        can happen if the directory already exists or the
7277                                        name contains not allowed symbols
7278    </p>
7279    </blockquote>
7280                                
7281    
7282    </blockquote><p>
7283                        
7284    </p>
7285    <p>Examples:
7286    </p>
7287    <p>
7288                            </p>
7289    <blockquote class="text">
7290    <p>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
7291    </p>
7292    <p>S: "OK"
7293    </p>
7294    </blockquote><p>
7295                        
7296    </p>
7297    <a name="REMOVE DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7298    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7299    <a name="rfc.section.6.8.2"></a><h3>6.8.2.&nbsp;
7300    Deleting an instrument directory</h3>
7301    
7302    <p>The front-end can delete a particular instrument directory
7303                        from the instruments database by sending the following command:
7304    </p>
7305    <p>
7306                            </p>
7307    <blockquote class="text">
7308    <p>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] &lt;dir&gt;
7309    </p>
7310    </blockquote><p>
7311                        
7312    </p>
7313    <p>Where &lt;dir&gt; is the absolute path name of the directory
7314                        to delete. The optional FORCE argument can be used to
7315                        force the deletion of a non-empty directory and all its content.
7316    </p>
7317    <p>Possible Answers:
7318    </p>
7319    <p>
7320                            </p>
7321    <blockquote class="text">
7322    <p>"OK" -
7323                                    </p>
7324    <blockquote class="text">
7325    <p>if the directory is deleted successfully
7326    </p>
7327  </blockquote>  </blockquote>
7328                                
7329    
7330    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7331                                    </p>
7332    <blockquote class="text">
7333    <p>if the given directory does not exist, or
7334                                        if trying to delete a non-empty directory,
7335                                        without using the FORCE argument.
7336    </p>
7337    </blockquote>
7338                                
7339    
7340    </blockquote><p>
7341                        
7342    </p>
7343  <p>Examples:  <p>Examples:
7344  </p>  </p>
7345  <p></p>  <p>
7346                            </p>
7347    <blockquote class="text">
7348    <p>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"
7349    </p>
7350    <p>S: "OK"
7351    </p>
7352    </blockquote><p>
7353                        
7354    </p>
7355    <a name="GET DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
7356    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7357    <a name="rfc.section.6.8.3"></a><h3>6.8.3.&nbsp;
7358    Getting amount of instrument directories</h3>
7359    
7360    <p>The front-end can retrieve the current amount of
7361                        directories in a specific directory by sending the following command:
7362    </p>
7363    <p>
7364                            </p>
7365    <blockquote class="text">
7366    <p>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;
7367    </p>
7368    </blockquote><p>
7369                        
7370    </p>
7371    <p>Where &lt;dir&gt; should be replaced by the absolute path
7372                        name of the directory. If RECURSIVE is specified, the number of
7373                        all directories, including those located in subdirectories of the
7374                        specified directory, will be returned.
7375    </p>
7376    <p>Possible Answers:
7377    </p>
7378    <p>
7379                            </p>
7380    <blockquote class="text">
7381    <p>The current number of instrument directories
7382                                in the specified directory.
7383    </p>
7384    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7385                                    </p>
7386    <blockquote class="text">
7387    <p>if the given directory does not exist.
7388    </p>
7389    </blockquote>
7390                                
7391    
7392    </blockquote><p>
7393                        
7394    </p>
7395    <p>Example:
7396    </p>
7397    <p>
7398                            </p>
7399    <blockquote class="text">
7400    <p>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
7401    </p>
7402    <p>S: "2"
7403    </p>
7404    </blockquote><p>
7405                        
7406    </p>
7407    <a name="LIST DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
7408    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7409    <a name="rfc.section.6.8.4"></a><h3>6.8.4.&nbsp;
7410    Listing all directories in specific directory</h3>
7411    
7412    <p>The front-end can retrieve the current list of directories
7413                        in specific directory by sending the following command:
7414    </p>
7415    <p>
7416                            </p>
7417    <blockquote class="text">
7418    <p>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;
7419    </p>
7420    </blockquote><p>
7421                        
7422    </p>
7423    <p>Where &lt;dir&gt; should be replaced by the absolute path
7424                        name of the directory. If RECURSIVE is specified, the absolute path names
7425                        of all directories, including those located in subdirectories of the
7426                        specified directory, will be returned.
7427    </p>
7428    <p>Possible Answers:
7429    </p>
7430    <p>
7431                            </p>
7432    <blockquote class="text">
7433    <p>A comma separated list of all instrument directories
7434                                (encapsulated into apostrophes) in the specified directory.
7435    </p>
7436    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7437                                    </p>
7438    <blockquote class="text">
7439    <p>if the given directory does not exist.
7440    </p>
7441    </blockquote>
7442                                
7443    
7444    </blockquote><p>
7445                        
7446    </p>
7447    <p>Example:
7448    </p>
7449    <p>
7450                            </p>
7451    <blockquote class="text">
7452    <p>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
7453    </p>
7454    <p>S: "'Piano Collection','Percussion Collection'"
7455    </p>
7456    </blockquote><p>
7457                        
7458    </p>
7459    <p>
7460                            </p>
7461    <blockquote class="text">
7462    <p>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"
7463    </p>
7464    <p>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"
7465    </p>
7466    </blockquote><p>
7467                        
7468    </p>
7469    <a name="GET DB_INSTRUMENT_DIRECTORY INFO"></a><br /><hr />
7470    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7471    <a name="rfc.section.6.8.5"></a><h3>6.8.5.&nbsp;
7472    Getting instrument directory information</h3>
7473    
7474    <p>The front-end can ask for the current settings of an
7475                        instrument directory by sending the following command:
7476    </p>
7477    <p>
7478                            </p>
7479    <blockquote class="text">
7480    <p>GET DB_INSTRUMENT_DIRECTORY INFO &lt;dir&gt;
7481    </p>
7482    </blockquote><p>
7483                        
7484    </p>
7485    <p>Where &lt;dir&gt; should be replaced by the absolute path
7486                        name of the directory the front-end is interested in.
7487    </p>
7488    <p>Possible Answers:
7489    </p>
7490    <p>
7491                            </p>
7492    <blockquote class="text">
7493    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
7494                                Each answer line begins with the settings category name
7495                                followed by a colon and then a space character &lt;SP&gt; and finally
7496                                the info character string to that setting category. At the
7497                                moment the following categories are defined:
7498    </p>
7499    <p>
7500                                    </p>
7501    <blockquote class="text">
7502    <p>DESCRIPTION -
7503                                            </p>
7504    <blockquote class="text">
7505    <p>A brief description of the directory content
7506    </p>
7507    </blockquote>
7508                                        
7509    
7510    <p>CREATED -
7511                                            </p>
7512    <blockquote class="text">
7513    <p>The creation date and time of the directory,
7514                                                represented in "YYYY-MM-DD HH:MM:SS" format
7515    </p>
7516    </blockquote>
7517                                        
7518    
7519    <p>MODIFIED -
7520                                            </p>
7521    <blockquote class="text">
7522    <p>The date and time of the last modification of the
7523                                                directory, represented in "YYYY-MM-DD HH:MM:SS" format
7524    </p>
7525    </blockquote>
7526                                        
7527    
7528    </blockquote>
7529                                
7530    
7531    </blockquote><p>
7532                        
7533    </p>
7534    <p>The mentioned fields above don't have to be in particular order.
7535    </p>
7536    <p>Example:
7537    </p>
7538    <p>
7539                            </p>
7540    <blockquote class="text">
7541    <p>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
7542    </p>
7543    <p>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."
7544    </p>
7545    <p>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"
7546    </p>
7547    <p>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"
7548    </p>
7549    <p>&nbsp;&nbsp;&nbsp;"."
7550    </p>
7551    </blockquote><p>
7552                        
7553    </p>
7554    <a name="SET DB_INSTRUMENT_DIRECTORY NAME"></a><br /><hr />
7555    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7556    <a name="rfc.section.6.8.6"></a><h3>6.8.6.&nbsp;
7557    Renaming an instrument directory</h3>
7558    
7559    <p>The front-end can alter the name of a specific
7560                        instrument directory by sending the following command:
7561    </p>
7562    <p>
7563                            </p>
7564    <blockquote class="text">
7565    <p>SET DB_INSTRUMENT_DIRECTORY NAME &lt;dir&gt; &lt;name&gt;
7566    </p>
7567    </blockquote><p>
7568                        
7569    </p>
7570    <p>Where &lt;dir&gt; is the absolute path name of the directory and
7571                        &lt;name&gt; is the new name for that directory.
7572    </p>
7573    <p>Possible Answers:
7574    </p>
7575    <p>
7576                            </p>
7577    <blockquote class="text">
7578    <p>"OK" -
7579                                    </p>
7580    <blockquote class="text">
7581    <p>on success
7582    </p>
7583    </blockquote>
7584                                
7585    
7586    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7587                                    </p>
7588    <blockquote class="text">
7589    <p>in case the given directory does not exists,
7590                                        or if a directory with name equal to the new
7591                                        name already exists.
7592    </p>
7593    </blockquote>
7594                                
7595    
7596    </blockquote><p>
7597                        
7598    </p>
7599    <p>Example:
7600    </p>
7601    <p>
7602                            </p>
7603    <blockquote class="text">
7604    <p>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"
7605    </p>
7606    <p>S: "OK"
7607    </p>
7608    </blockquote><p>
7609                        
7610    </p>
7611    <a name="MOVE DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7612    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7613    <a name="rfc.section.6.8.7"></a><h3>6.8.7.&nbsp;
7614    Moving an instrument directory</h3>
7615    
7616    <p>The front-end can move a specific
7617                        instrument directory by sending the following command:
7618    </p>
7619    <p>
7620                            </p>
7621    <blockquote class="text">
7622    <p>MOVE DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;
7623    </p>
7624    </blockquote><p>
7625                        
7626    </p>
7627    <p>Where &lt;dir&gt; is the absolute path name of the directory
7628                        to move and &lt;dst&gt; is the location where the directory will
7629                        be moved to.
7630    </p>
7631    <p>Possible Answers:
7632    </p>
7633    <p>
7634                            </p>
7635    <blockquote class="text">
7636    <p>"OK" -
7637                                    </p>
7638    <blockquote class="text">
7639    <p>on success
7640    </p>
7641    </blockquote>
7642                                
7643    
7644    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7645                                    </p>
7646    <blockquote class="text">
7647    <p>in case a given directory does not exists,
7648                                        or if a directory with name equal to the name
7649                                        of the specified directory already exists in
7650                                        the destination directory. Error is also thrown
7651                                        when trying to move a directory to a subdirectory
7652                                        of itself.
7653    </p>
7654    </blockquote>
7655                                
7656    
7657    </blockquote><p>
7658                        
7659    </p>
7660    <p>Example:
7661    </p>
7662    <p>
7663                            </p>
7664    <blockquote class="text">
7665    <p>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"
7666    </p>
7667    <p>S: "OK"
7668    </p>
7669    </blockquote><p>
7670                        
7671    </p>
7672    <a name="COPY DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7673    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7674    <a name="rfc.section.6.8.8"></a><h3>6.8.8.&nbsp;
7675    Copying instrument directories</h3>
7676    
7677    <p>The front-end can copy a specific
7678                        instrument directory by sending the following command:
7679    </p>
7680    <p>
7681                            </p>
7682    <blockquote class="text">
7683    <p>COPY DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;
7684    </p>
7685    </blockquote><p>
7686                        
7687    </p>
7688    <p>Where &lt;dir&gt; is the absolute path name of the directory
7689                        to copy and &lt;dst&gt; is the location where the directory will
7690                        be copied to.
7691    </p>
7692    <p>Possible Answers:
7693    </p>
7694    <p>
7695                            </p>
7696    <blockquote class="text">
7697    <p>"OK" -
7698                                    </p>
7699    <blockquote class="text">
7700    <p>on success
7701    </p>
7702    </blockquote>
7703                                
7704    
7705    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7706                                    </p>
7707    <blockquote class="text">
7708    <p>in case a given directory does not exists,
7709                                        or if a directory with name equal to the name
7710                                        of the specified directory already exists in
7711                                        the destination directory. Error is also thrown
7712                                        when trying to copy a directory to a subdirectory
7713                                        of itself.
7714    </p>
7715    </blockquote>
7716                                
7717    
7718    </blockquote><p>
7719                        
7720    </p>
7721    <p>Example:
7722    </p>
7723    <p>
7724                            </p>
7725    <blockquote class="text">
7726    <p>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"
7727    </p>
7728    <p>S: "OK"
7729    </p>
7730    </blockquote><p>
7731                        
7732    </p>
7733    <a name="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"></a><br /><hr />
7734    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7735    <a name="rfc.section.6.8.9"></a><h3>6.8.9.&nbsp;
7736    Changing the description of directory</h3>
7737    
7738    <p>The front-end can alter the description of a specific
7739                        instrument directory by sending the following command:
7740    </p>
7741    <p>
7742                            </p>
7743    <blockquote class="text">
7744    <p>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION &lt;dir&gt; &lt;desc&gt;
7745    </p>
7746    </blockquote><p>
7747                        
7748    </p>
7749    <p>Where &lt;dir&gt; is the absolute path name of the directory and
7750                        &lt;desc&gt; is the new description for the directory.
7751    </p>
7752    <p>Possible Answers:
7753    </p>
7754    <p>
7755                            </p>
7756    <blockquote class="text">
7757    <p>"OK" -
7758                                    </p>
7759    <blockquote class="text">
7760    <p>on success
7761    </p>
7762    </blockquote>
7763                                
7764    
7765    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7766                                    </p>
7767    <blockquote class="text">
7768    <p>in case the given directory does not exists.
7769    </p>
7770    </blockquote>
7771                                
7772    
7773    </blockquote><p>
7774                        
7775    </p>
7776    <p>Example:
7777    </p>
7778    <p>
7779                            </p>
7780    <blockquote class="text">
7781    <p>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"
7782    </p>
7783    <p>S: "OK"
7784    </p>
7785    </blockquote><p>
7786                        
7787    </p>
7788    <a name="FIND DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
7789    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7790    <a name="rfc.section.6.8.10"></a><h3>6.8.10.&nbsp;
7791    Finding directories</h3>
7792    
7793    <p>The front-end can search for directories
7794                        in specific directory by sending the following command:
7795    </p>
7796    <p>
7797                            </p>
7798    <blockquote class="text">
7799    <p>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;
7800    </p>
7801    </blockquote><p>
7802                        
7803    </p>
7804    <p>Where &lt;dir&gt; should be replaced by the absolute path
7805                        name of the directory to search in. If NON_RECURSIVE is specified, the
7806                        directories located in subdirectories of the specified directory will not
7807                        be searched. &lt;criteria-list&gt; is a list of search criterias
7808                        in form of "key1=val1 key2=val2 ...". The following criterias are
7809                        allowed:
7810    </p>
7811    <p>
7812                          
7813    <p>NAME='&lt;search-string&gt;'
7814                              </p>
7815    <blockquote class="text">
7816    <p>Restricts the search to directories, which names
7817                                  satisfy the supplied search string.
7818    </p>
7819    </blockquote><p>
7820                          
7821    </p>
7822    
7823                          
7824    <p>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
7825                              </p>
7826    <blockquote class="text">
7827    <p>Restricts the search to directories, which creation
7828                                  date satisfies the specified period, where &lt;date-after&gt;
7829                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
7830                                  If &lt;date-after&gt; is omitted the search is restricted to
7831                                  directories created before &lt;date-before&gt;. If
7832                                  &lt;date-before&gt; is omitted, the search is restricted
7833                                  to directories created after &lt;date-after&gt;.
7834    </p>
7835    </blockquote><p>
7836                          
7837    </p>
7838    
7839                          
7840    <p>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
7841                              </p>
7842    <blockquote class="text">
7843    <p>Restricts the search to directories, which
7844                                  date of last modification satisfies the specified period, where
7845                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
7846                                  format. If &lt;date-after&gt; is omitted the search is restricted to
7847                                  directories, which are last modified before &lt;date-before&gt;. If
7848                                  &lt;date-before&gt; is omitted, the search is restricted to directories,
7849                                  which are last modified after &lt;date-after&gt;.
7850    </p>
7851    </blockquote><p>
7852                          
7853    </p>
7854    
7855                          
7856    <p>DESCRIPTION='&lt;search-string&gt;'
7857                              </p>
7858    <blockquote class="text">
7859    <p>Restricts the search to directories with description
7860                                  that satisfies the supplied search string.
7861    </p>
7862    </blockquote><p>
7863                          
7864    </p>
7865                        
7866    
7867    <p>Where &lt;search-string&gt; is either a regular expression, or a
7868                        word list separated with spaces for OR search and with '+' for AND search.
7869    </p>
7870    <p>Possible Answers:
7871    </p>
7872    <p>
7873                            </p>
7874    <blockquote class="text">
7875    <p>A comma separated list with the absolute path names (encapsulated into
7876                                apostrophes) of all directories in the specified directory that satisfy
7877                                the supplied search criterias.
7878    </p>
7879    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7880                                    </p>
7881    <blockquote class="text">
7882    <p>if the given directory does not exist.
7883    </p>
7884    </blockquote>
7885                                
7886    
7887    </blockquote><p>
7888                        
7889    </p>
7890    <p>Example:
7891    </p>
7892    <p>
7893                            </p>
7894    <blockquote class="text">
7895    <p>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"
7896    </p>
7897    <p>S: "'/Piano Collection'"
7898    </p>
7899    </blockquote><p>
7900                        
7901    </p>
7902    <p>
7903                            </p>
7904    <blockquote class="text">
7905    <p>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"
7906    </p>
7907    <p>S: "'/Piano Collection','/Percussions'"
7908    </p>
7909    </blockquote><p>
7910                        
7911    </p>
7912    <a name="ADD DB_INSTRUMENTS"></a><br /><hr />
7913    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7914    <a name="rfc.section.6.8.11"></a><h3>6.8.11.&nbsp;
7915    Adding instruments to the instruments database</h3>
7916    
7917    <p>The front-end can add one or more instruments
7918                        to the instruments database by sending the following command:
7919    </p>
7920    <p>
7921                            </p>
7922    <blockquote class="text">
7923    <p>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]
7924    </p>
7925    </blockquote><p>
7926                        
7927    </p>
7928    <p>Where &lt;db_dir&gt; is the absolute path name of a directory
7929                        (encapsulated into apostrophes) in the instruments database in which
7930                        only the new instruments (that are not already in the database) will
7931                        be added, &lt;file_path&gt; is the absolute path name of a file or
7932                        directory in the file system (encapsulated into apostrophes). In case
7933                        an instrument file is supplied, only the instruments in the specified
7934                        file will be added to the instruments database. If the optional
7935                        &lt;instr_index&gt; (the index of the instrument within the given file)
7936                        is supplied too, then only the specified instrument will be added.
7937                        In case a directory is supplied, the instruments in that directory
7938                        will be added. The OPTIONAL &lt;mode&gt; argument is only applied
7939                        when a directory is provided as &lt;file_path&gt; and specifies how the
7940                        scanning will be done and has exactly the following possibilities:
7941    </p>
7942    <p>
7943                            </p>
7944    <blockquote class="text">
7945    <p>"RECURSIVE" -
7946                                    </p>
7947    <blockquote class="text">
7948    <p>All instruments will be processed, including those
7949                                        in the subdirectories, and the respective subdirectory
7950                                        tree structure will be recreated in the instruments
7951                                        database
7952    </p>
7953    </blockquote>
7954                                
7955    
7956    <p>"NON_RECURSIVE" -
7957                                    </p>
7958    <blockquote class="text">
7959    <p>Only the instruments in the specified directory
7960                                        will be added, the instruments in the subdirectories
7961                                        will not be processed.
7962    </p>
7963    </blockquote>
7964                                
7965    
7966    <p>"FLAT" -
7967                                    </p>
7968    <blockquote class="text">
7969    <p>All instruments will be processed, including those
7970                                        in the subdirectories, but the respective subdirectory
7971                                        structure will not be recreated in the instruments
7972                                        database. All instruments will be added directly in
7973                                        the specified database directory.
7974    </p>
7975    </blockquote>
7976                                
7977    
7978    </blockquote><p>
7979                        
7980    </p>
7981    <p>The difference between regular and NON_MODAL versions of the command
7982                        is that the regular command returns when the scanning is finished
7983                        while NON_MODAL version returns immediately and a background process is launched.
7984                        The <a class='info' href='#GET DB_INSTRUMENTS_JOB INFO'>GET DB_INSTRUMENTS_JOB INFO<span> (</span><span class='info'>Getting job status information</span><span>)</span></a>
7985                        command can be used to monitor the scanning progress.
7986    </p>
7987    <p>Possible Answers:
7988    </p>
7989    <p>
7990                            </p>
7991    <blockquote class="text">
7992    <p>"OK" -
7993                                    </p>
7994    <blockquote class="text">
7995    <p>on success when NON_MODAL is not supplied
7996    </p>
7997    </blockquote>
7998                                
7999    
8000    <p>"OK[&lt;job-id&gt;]" -
8001                                    </p>
8002    <blockquote class="text">
8003    <p>on success when NON_MODAL is supplied, where &lt;job-id&gt;
8004                                        is a numerical ID used to obtain status information about the job progress.
8005                                        See <a class='info' href='#GET DB_INSTRUMENTS_JOB INFO'>GET DB_INSTRUMENTS_JOB INFO<span> (</span><span class='info'>Getting job status information</span><span>)</span></a>
8006                                        
8007    </p>
8008    </blockquote>
8009                                
8010    
8011    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8012                                    </p>
8013    <blockquote class="text">
8014    <p>if an invalid path is specified.
8015    </p>
8016    </blockquote>
8017                                
8018    
8019    </blockquote><p>
8020                        
8021    </p>
8022    <p>Examples:
8023    </p>
8024    <p>
8025                            </p>
8026    <blockquote class="text">
8027    <p>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"
8028    </p>
8029    <p>S: "OK"
8030    </p>
8031    </blockquote><p>
8032                        
8033    </p>
8034    <a name="REMOVE DB_INSTRUMENT"></a><br /><hr />
8035    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8036    <a name="rfc.section.6.8.12"></a><h3>6.8.12.&nbsp;
8037    Removing an instrument</h3>
8038    
8039    <p>The front-end can remove a particular instrument
8040                        from the instruments database by sending the following command:
8041    </p>
8042    <p>
8043                            </p>
8044    <blockquote class="text">
8045    <p>REMOVE DB_INSTRUMENT &lt;instr_path&gt;
8046    </p>
8047    </blockquote><p>
8048                        
8049    </p>
8050    <p>Where &lt;instr_path&gt; is the absolute path name
8051                        (in the instruments database) of the instrument to remove.
8052    </p>
8053    <p>Possible Answers:
8054    </p>
8055    <p>
8056                            </p>
8057    <blockquote class="text">
8058    <p>"OK" -
8059                                    </p>
8060    <blockquote class="text">
8061    <p>if the instrument is removed successfully
8062    </p>
8063    </blockquote>
8064                                
8065    
8066    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8067                                    </p>
8068    <blockquote class="text">
8069    <p>if the given path does not exist or
8070                                        is a directory.
8071    </p>
8072    </blockquote>
8073                                
8074    
8075    </blockquote><p>
8076                        
8077    </p>
8078    <p>Examples:
8079    </p>
8080    <p>
8081                            </p>
8082    <blockquote class="text">
8083    <p>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"
8084    </p>
8085    <p>S: "OK"
8086    </p>
8087    </blockquote><p>
8088                        
8089    </p>
8090    <a name="GET DB_INSTRUMENTS"></a><br /><hr />
8091    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8092    <a name="rfc.section.6.8.13"></a><h3>6.8.13.&nbsp;
8093    Getting amount of instruments</h3>
8094    
8095    <p>The front-end can retrieve the current amount of
8096                        instruments in a specific directory by sending the following command:
8097    </p>
8098    <p>
8099                            </p>
8100    <blockquote class="text">
8101    <p>GET DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;
8102    </p>
8103    </blockquote><p>
8104                        
8105    </p>
8106    <p>Where &lt;dir&gt; should be replaced by the absolute path name
8107                        of the directory. If RECURSIVE is specified, the number of all
8108                        instruments, including those located in subdirectories of the
8109                        specified directory, will be returned.
8110    </p>
8111    <p>Possible Answers:
8112    </p>
8113    <p>
8114                            </p>
8115    <blockquote class="text">
8116    <p>The current number of instruments
8117                                in the specified directory.
8118    </p>
8119    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8120                                    </p>
8121    <blockquote class="text">
8122    <p>if the given directory does not exist.
8123    </p>
8124    </blockquote>
8125                                
8126    
8127    </blockquote><p>
8128                        
8129    </p>
8130    <p>Example:
8131    </p>
8132    <p>
8133                            </p>
8134    <blockquote class="text">
8135    <p>C: "GET DB_INSTRUMENTS '/Piano Collection'"
8136    </p>
8137    <p>S: "2"
8138    </p>
8139    </blockquote><p>
8140                        
8141    </p>
8142    <a name="LIST DB_INSTRUMENTS"></a><br /><hr />
8143    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8144    <a name="rfc.section.6.8.14"></a><h3>6.8.14.&nbsp;
8145    Listing all instruments in specific directory</h3>
8146    
8147    <p>The front-end can retrieve the current list of instruments
8148                        in specific directory by sending the following command:
8149    </p>
8150    <p>
8151                            </p>
8152    <blockquote class="text">
8153    <p>LIST DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;
8154    </p>
8155    </blockquote><p>
8156                        
8157    </p>
8158    <p>Where &lt;dir&gt; should be replaced by the absolute path
8159                        name of the directory. If RECURSIVE is specified, the absolute path
8160                        names of all instruments, including those located in subdirectories
8161                        of the specified directory, will be returned.
8162    </p>
8163    <p>Possible Answers:
8164    </p>
8165    <p>
8166                            </p>
8167    <blockquote class="text">
8168    <p>A comma separated list of all instruments
8169                                (encapsulated into apostrophes) in the specified directory.
8170    </p>
8171    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8172                                    </p>
8173    <blockquote class="text">
8174    <p>if the given directory does not exist.
8175    </p>
8176    </blockquote>
8177                                
8178    
8179    </blockquote><p>
8180                        
8181    </p>
8182    <p>Example:
8183    </p>
8184    <p>
8185                            </p>
8186    <blockquote class="text">
8187    <p>C: "LIST DB_INSTRUMENTS '/Piano Collection'"
8188    </p>
8189    <p>S: "'Bosendorfer 290','Steinway D'"
8190    </p>
8191    </blockquote><p>
8192                        
8193    </p>
8194    <p>
8195                            </p>
8196    <blockquote class="text">
8197    <p>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"
8198    </p>
8199    <p>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"
8200    </p>
8201    </blockquote><p>
8202                        
8203    </p>
8204    <a name="GET DB_INSTRUMENT INFO"></a><br /><hr />
8205    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8206    <a name="rfc.section.6.8.15"></a><h3>6.8.15.&nbsp;
8207    Getting instrument information</h3>
8208    
8209    <p>The front-end can ask for the current settings of an
8210                        instrument by sending the following command:
8211    </p>
8212    <p>
8213                            </p>
8214    <blockquote class="text">
8215    <p>GET DB_INSTRUMENT INFO &lt;instr_path&gt;
8216    </p>
8217    </blockquote><p>
8218                        
8219    </p>
8220    <p>Where &lt;instr_path&gt; should be replaced by the absolute path
8221                        name of the instrument the front-end is interested in.
8222    </p>
8223    <p>Possible Answers:
8224    </p>
8225    <p>
8226                            </p>
8227    <blockquote class="text">
8228    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
8229                                Each answer line begins with the settings category name
8230                                followed by a colon and then a space character &lt;SP&gt; and finally
8231                                the info character string to that setting category. At the
8232                                moment the following categories are defined:
8233    </p>
8234    <p>
8235                                    </p>
8236    <blockquote class="text">
8237    <p>INSTRUMENT_FILE -
8238                                            </p>
8239    <blockquote class="text">
8240    <p>File name of the instrument.
8241    </p>
8242    </blockquote>
8243                                        
8244    
8245    <p>INSTRUMENT_NR -
8246                                            </p>
8247    <blockquote class="text">
8248    <p>Index of the instrument within the file.
8249    </p>
8250    </blockquote>
8251                                        
8252    
8253    <p>FORMAT_FAMILY -
8254                                            </p>
8255    <blockquote class="text">
8256    <p>The format family of the instrument.
8257    </p>
8258    </blockquote>
8259                                        
8260    
8261    <p>FORMAT_VERSION -
8262                                            </p>
8263    <blockquote class="text">
8264    <p>The format version of the instrument.
8265    </p>
8266    </blockquote>
8267                                        
8268    
8269    <p>SIZE -
8270                                            </p>
8271    <blockquote class="text">
8272    <p>The size of the instrument in bytes.
8273    </p>
8274    </blockquote>
8275                                        
8276    
8277    <p>CREATED -
8278                                            </p>
8279    <blockquote class="text">
8280    <p>The date and time when the instrument is added
8281                                                in the instruments database, represented in
8282                                               "YYYY-MM-DD HH:MM:SS" format
8283    </p>
8284    </blockquote>
8285                                        
8286    
8287    <p>MODIFIED -
8288                                            </p>
8289    <blockquote class="text">
8290    <p>The date and time of the last modification of the
8291                                                instrument's database settings, represented in
8292                                                "YYYY-MM-DD HH:MM:SS" format
8293    </p>
8294    </blockquote>
8295                                        
8296    
8297    <p>DESCRIPTION -
8298                                            </p>
8299    <blockquote class="text">
8300    <p>A brief description of the instrument
8301    </p>
8302    </blockquote>
8303                                        
8304    
8305    <p>IS_DRUM -
8306                                            </p>
8307    <blockquote class="text">
8308    <p>either true or false, determines whether the
8309                                                instrument is a drumkit or a chromatic instrument
8310    </p>
8311    </blockquote>
8312                                        
8313    
8314    <p>PRODUCT -
8315                                            </p>
8316    <blockquote class="text">
8317    <p>The product title of the instrument
8318    </p>
8319    </blockquote>
8320                                        
8321    
8322    <p>ARTISTS -
8323                                            </p>
8324    <blockquote class="text">
8325    <p>Lists the artist names
8326    </p>
8327    </blockquote>
8328                                        
8329    
8330    <p>KEYWORDS -
8331                                            </p>
8332    <blockquote class="text">
8333    <p>Provides a list of keywords that refer to the instrument.
8334                                                Keywords are separated with semicolon and blank.
8335    </p>
8336    </blockquote>
8337                                        
8338    
8339    </blockquote>
8340                                
8341    
8342    </blockquote><p>
8343                        
8344    </p>
8345    <p>The mentioned fields above don't have to be in particular order.
8346    </p>
8347    <p>Example:
8348    </p>
8349    <p>
8350                            </p>
8351    <blockquote class="text">
8352    <p>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"
8353    </p>
8354    <p>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"
8355    </p>
8356    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"
8357    </p>
8358    <p>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"
8359    </p>
8360    <p>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 2"
8361    </p>
8362    <p>&nbsp;&nbsp;&nbsp;"SIZE: 2050871870"
8363    </p>
8364    <p>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"
8365    </p>
8366    <p>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"
8367    </p>
8368    <p>&nbsp;&nbsp;&nbsp;"DESCRIPTION: "
8369    </p>
8370    <p>&nbsp;&nbsp;&nbsp;"IS_DRUM: false"
8371    </p>
8372    <p>&nbsp;&nbsp;&nbsp;"PRODUCT: GRANDIOSO Bosendorfer 290"
8373    </p>
8374    <p>&nbsp;&nbsp;&nbsp;"ARTISTS: Post Musical Instruments"
8375    </p>
8376    <p>&nbsp;&nbsp;&nbsp;"KEYWORDS: Bosendorfer"
8377    </p>
8378    <p>&nbsp;&nbsp;&nbsp;"."
8379    </p>
8380    </blockquote><p>
8381                        
8382    </p>
8383    <a name="SET DB_INSTRUMENT NAME"></a><br /><hr />
8384    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8385    <a name="rfc.section.6.8.16"></a><h3>6.8.16.&nbsp;
8386    Renaming an instrument</h3>
8387    
8388    <p>The front-end can alter the name of a specific
8389                        instrument by sending the following command:
8390    </p>
8391    <p>
8392                            </p>
8393    <blockquote class="text">
8394    <p>SET DB_INSTRUMENT NAME &lt;instr&gt; &lt;name&gt;
8395    </p>
8396    </blockquote><p>
8397                        
8398    </p>
8399    <p>Where &lt;instr&gt; is the absolute path name of the instrument and
8400                        &lt;name&gt; is the new name for that instrument.
8401    </p>
8402    <p>Possible Answers:
8403    </p>
8404    <p>
8405                            </p>
8406    <blockquote class="text">
8407    <p>"OK" -
8408                                    </p>
8409    <blockquote class="text">
8410    <p>on success
8411    </p>
8412    </blockquote>
8413                                
8414    
8415    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8416                                    </p>
8417    <blockquote class="text">
8418    <p>in case the given instrument does not exists,
8419                                        or if an instrument with name equal to the new
8420                                        name already exists.
8421    </p>
8422    </blockquote>
8423                                
8424    
8425    </blockquote><p>
8426                        
8427    </p>
8428    <p>Example:
8429    </p>
8430    <p>
8431                            </p>
8432    <blockquote class="text">
8433    <p>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"
8434    </p>
8435    <p>S: "OK"
8436    </p>
8437    </blockquote><p>
8438                        
8439    </p>
8440    <a name="MOVE DB_INSTRUMENT"></a><br /><hr />
8441    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8442    <a name="rfc.section.6.8.17"></a><h3>6.8.17.&nbsp;
8443    Moving an instrument</h3>
8444    
8445    <p>The front-end can move a specific instrument to another directory by
8446                        sending the following command:
8447    </p>
8448    <p>
8449                            </p>
8450    <blockquote class="text">
8451    <p>MOVE DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;
8452    </p>
8453    </blockquote><p>
8454                        
8455    </p>
8456    <p>Where &lt;instr&gt; is the absolute path name of the instrument
8457                        to move and &lt;dst&gt; is the directory where the instrument will
8458                        be moved to.
8459    </p>
8460    <p>Possible Answers:
8461    </p>
8462    <p>
8463                            </p>
8464    <blockquote class="text">
8465    <p>"OK" -
8466                                    </p>
8467    <blockquote class="text">
8468    <p>on success
8469    </p>
8470    </blockquote>
8471                                
8472    
8473    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8474                                    </p>
8475    <blockquote class="text">
8476    <p>in case the given instrument does not exists,
8477                                        or if an instrument with name equal to the name of the
8478                                        specified instrument already exists in the destination
8479                                        directory.
8480    </p>
8481    </blockquote>
8482                                
8483    
8484    </blockquote><p>
8485                        
8486    </p>
8487    <p>Example:
8488    </p>
8489    <p>
8490                            </p>
8491    <blockquote class="text">
8492    <p>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"
8493    </p>
8494    <p>S: "OK"
8495    </p>
8496    </blockquote><p>
8497                        
8498    </p>
8499    <a name="COPY DB_INSTRUMENT"></a><br /><hr />
8500    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8501    <a name="rfc.section.6.8.18"></a><h3>6.8.18.&nbsp;
8502    Copying instruments</h3>
8503    
8504    <p>The front-end can copy a specific instrument to another directory by
8505                        sending the following command:
8506    </p>
8507    <p>
8508                            </p>
8509    <blockquote class="text">
8510    <p>COPY DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;
8511    </p>
8512    </blockquote><p>
8513                        
8514    </p>
8515    <p>Where &lt;instr&gt; is the absolute path name of the instrument
8516                        to copy and &lt;dst&gt; is the directory where the instrument will
8517                        be copied to.
8518    </p>
8519    <p>Possible Answers:
8520    </p>
8521    <p>
8522                            </p>
8523    <blockquote class="text">
8524    <p>"OK" -
8525                                    </p>
8526    <blockquote class="text">
8527    <p>on success
8528    </p>
8529    </blockquote>
8530                                
8531    
8532    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8533                                    </p>
8534    <blockquote class="text">
8535    <p>in case the given instrument does not exists,
8536                                        or if an instrument with name equal to the name of the
8537                                        specified instrument already exists in the destination
8538                                        directory.
8539    </p>
8540    </blockquote>
8541                                
8542    
8543    </blockquote><p>
8544                        
8545    </p>
8546    <p>Example:
8547    </p>
8548    <p>
8549                            </p>
8550    <blockquote class="text">
8551    <p>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"
8552    </p>
8553    <p>S: "OK"
8554    </p>
8555    </blockquote><p>
8556                        
8557    </p>
8558    <a name="SET DB_INSTRUMENT DESCRIPTION"></a><br /><hr />
8559    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8560    <a name="rfc.section.6.8.19"></a><h3>6.8.19.&nbsp;
8561    Changing the description of instrument</h3>
8562    
8563    <p>The front-end can alter the description of a specific
8564                        instrument by sending the following command:
8565    </p>
8566    <p>
8567                            </p>
8568    <blockquote class="text">
8569    <p>SET DB_INSTRUMENT DESCRIPTION &lt;instr&gt; &lt;desc&gt;
8570    </p>
8571    </blockquote><p>
8572                        
8573    </p>
8574    <p>Where &lt;instr&gt; is the absolute path name of the instrument and
8575                        &lt;desc&gt; is the new description for the instrument.
8576    </p>
8577    <p>Possible Answers:
8578    </p>
8579    <p>
8580                            </p>
8581    <blockquote class="text">
8582    <p>"OK" -
8583                                    </p>
8584    <blockquote class="text">
8585    <p>on success
8586    </p>
8587    </blockquote>
8588                                
8589    
8590    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8591                                    </p>
8592    <blockquote class="text">
8593    <p>in case the given instrument does not exists.
8594    </p>
8595    </blockquote>
8596                                
8597    
8598    </blockquote><p>
8599                        
8600    </p>
8601    <p>Example:
8602    </p>
8603    <p>
8604                            </p>
8605    <blockquote class="text">
8606    <p>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"
8607    </p>
8608    <p>S: "OK"
8609    </p>
8610    </blockquote><p>
8611                        
8612    </p>
8613    <a name="FIND DB_INSTRUMENTS"></a><br /><hr />
8614    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8615    <a name="rfc.section.6.8.20"></a><h3>6.8.20.&nbsp;
8616    Finding instruments</h3>
8617    
8618    <p>The front-end can search for instruments
8619                        in specific directory by sending the following command:
8620    </p>
8621    <p>
8622                            </p>
8623    <blockquote class="text">
8624    <p>FIND DB_INSTRUMENTS [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;
8625    </p>
8626    </blockquote><p>
8627                        
8628    </p>
8629    <p>Where &lt;dir&gt; should be replaced by the absolute path
8630                        name of the directory to search in. If NON_RECURSIVE is specified, the
8631                        directories located in subdirectories of the specified directory will not
8632                        be searched. &lt;criteria-list&gt; is a list of search criterias
8633                        in form of "key1=val1 key2=val2 ...". The following criterias are
8634                        allowed:
8635    </p>
8636    <p>
8637                          
8638    <p>NAME='&lt;search-string&gt;'
8639                              </p>
8640    <blockquote class="text">
8641    <p>Restricts the search to instruments, which names
8642                                  satisfy the supplied search string.
8643    </p>
8644    </blockquote><p>
8645                          
8646    </p>
8647    
8648                          
8649    <p>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
8650                              </p>
8651    <blockquote class="text">
8652    <p>Restricts the search to instruments, which
8653                                  size is in the specified range. If &lt;min&gt; is omitted,
8654                                  the search results are restricted to instruments with size less then
8655                                  or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
8656                                  search is restricted to instruments with size greater then
8657                                  or equal to &lt;min&gt;.
8658    </p>
8659    </blockquote><p>
8660                          
8661    </p>
8662    
8663                          
8664    <p>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
8665                              </p>
8666    <blockquote class="text">
8667    <p>Restricts the search to instruments, which creation
8668                                  date satisfies the specified period, where &lt;date-after&gt;
8669                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
8670                                  If &lt;date-after&gt; is omitted the search is restricted to
8671                                  instruments created before &lt;date-before&gt;. If
8672                                  &lt;date-before&gt; is omitted, the search is restricted
8673                                  to instruments created after &lt;date-after&gt;.
8674    </p>
8675    </blockquote><p>
8676                          
8677    </p>
8678    
8679                          
8680    <p>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
8681                              </p>
8682    <blockquote class="text">
8683    <p>Restricts the search to instruments, which
8684                                  date of last modification satisfies the specified period, where
8685                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
8686                                  format. If &lt;date-after&gt; is omitted the search is restricted to
8687                                  instruments, which are last modified before &lt;date-before&gt;. If
8688                                  &lt;date-before&gt; is omitted, the search is restricted to instruments,
8689                                  which are last modified after &lt;date-after&gt;.
8690    </p>
8691    </blockquote><p>
8692                          
8693    </p>
8694    
8695                          
8696    <p>DESCRIPTION='&lt;search-string&gt;'
8697                              </p>
8698    <blockquote class="text">
8699    <p>Restricts the search to instruments with description
8700                                  that satisfies the supplied search string.
8701    </p>
8702    </blockquote><p>
8703                          
8704    </p>
8705    
8706                          
8707    <p>PRODUCT='&lt;search-string&gt;'
8708                              </p>
8709    <blockquote class="text">
8710    <p>Restricts the search to instruments with product info
8711                                  that satisfies the supplied search string.
8712    </p>
8713    </blockquote><p>
8714                          
8715    </p>
8716    
8717                          
8718    <p>ARTISTS='&lt;search-string&gt;'
8719                              </p>
8720    <blockquote class="text">
8721    <p>Restricts the search to instruments with artists info
8722                                  that satisfies the supplied search string.
8723    </p>
8724    </blockquote><p>
8725                          
8726    </p>
8727    
8728                          
8729    <p>KEYWORDS='&lt;search-string&gt;'
8730                              </p>
8731    <blockquote class="text">
8732    <p>Restricts the search to instruments with keyword list
8733                                  that satisfies the supplied search string.
8734    </p>
8735    </blockquote><p>
8736                          
8737    </p>
8738    
8739                          
8740    <p>IS_DRUM=true | false
8741                              </p>
8742    <blockquote class="text">
8743    <p>Either true or false. Restricts the search to
8744                                  drum kits or chromatic instruments.
8745    </p>
8746    </blockquote><p>
8747                          
8748    </p>
8749    
8750                          
8751    <p>FORMAT_FAMILIES='&lt;format-list&gt;'
8752                              </p>
8753  <blockquote class="text">  <blockquote class="text">
8754    <p>Restricts the search to instruments of the supplied format families,
8755                                  where &lt;format-list&gt; is a comma separated list of format families.
8756    </p>
8757    </blockquote><p>
8758                          
8759    </p>
8760                        
8761    
8762    <p>Where &lt;search-string&gt; is either a regular expression, or a
8763                        word list separated with spaces for OR search and with '+' for AND search.
8764    </p>
8765    <p>Possible Answers:
8766    </p>
8767  <p>  <p>
8768                            </p>
8769    <blockquote class="text">
8770    <p>A comma separated list with the absolute path names (encapsulated into
8771                                apostrophes) of all instruments in the specified directory that satisfy
8772                                the supplied search criterias.
8773    </p>
8774    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
8775                                    </p>
8776    <blockquote class="text">
8777    <p>if the given directory does not exist.
8778  </p>  </p>
8779  </blockquote>  </blockquote>
8780                                
8781    
8782    </blockquote><p>
8783                        
8784    </p>
8785    <p>Example:
8786    </p>
8787    <p>
8788                            </p>
8789    <blockquote class="text">
8790    <p>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"
8791    </p>
8792    <p>S: "'/Piano Collection/Bosendorfer 290'"
8793    </p>
8794    </blockquote><p>
8795                        
8796    </p>
8797    <p>
8798                            </p>
8799    <blockquote class="text">
8800    <p>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"
8801    </p>
8802    <p>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"
8803    </p>
8804    </blockquote><p>
8805                        
8806    </p>
8807    <a name="GET DB_INSTRUMENTS_JOB INFO"></a><br /><hr />
8808    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8809    <a name="rfc.section.6.8.21"></a><h3>6.8.21.&nbsp;
8810    Getting job status information</h3>
8811    
8812    <p>The front-end can ask for the current status of a
8813                        particular database instruments job by sending the following command:
8814    </p>
8815    <p>
8816                            </p>
8817    <blockquote class="text">
8818    <p>GET DB_INSTRUMENTS_JOB INFO &lt;job-id&gt;
8819    </p>
8820    </blockquote><p>
8821                        
8822    </p>
8823    <p>Where &lt;job-id&gt; should be replaced by the numerical ID
8824                        of the job the front-end is interested in.
8825    </p>
8826    <p>Possible Answers:
8827    </p>
8828    <p>
8829                            </p>
8830    <blockquote class="text">
8831    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
8832                                Each answer line begins with the settings category name
8833                                followed by a colon and then a space character &lt;SP&gt; and finally
8834                                the info character string to that setting category. At the
8835                                moment the following categories are defined:
8836    </p>
8837    <p>
8838                                    </p>
8839    <blockquote class="text">
8840    <p>FILES_TOTAL -
8841                                            </p>
8842    <blockquote class="text">
8843    <p>The total number of files scheduled for scanning
8844    </p>
8845    </blockquote>
8846                                        
8847    
8848    <p>FILES_SCANNED -
8849                                            </p>
8850    <blockquote class="text">
8851    <p>The current number of scanned files
8852    </p>
8853    </blockquote>
8854                                        
8855    
8856    <p>SCANNING -
8857                                            </p>
8858    <blockquote class="text">
8859    <p>The absolute path name of the file which is currently
8860                                                being scanned
8861    </p>
8862    </blockquote>
8863                                        
8864    
8865    <p>STATUS -
8866                                            </p>
8867    <blockquote class="text">
8868    <p>An integer value between 0 and 100 indicating the
8869                                                scanning progress percentage of the file which is
8870                                                currently being scanned
8871    </p>
8872    </blockquote>
8873                                        
8874    
8875    </blockquote>
8876                                
8877    
8878    </blockquote><p>
8879                        
8880    </p>
8881    <p>The mentioned fields above don't have to be in particular order.
8882    </p>
8883    <p>Example:
8884    </p>
8885    <p>
8886                            </p>
8887    <blockquote class="text">
8888    <p>C: "GET DB_INSTRUMENTS_JOB INFO 2"
8889    </p>
8890    <p>S: "FILES_TOTAL: 12"
8891    </p>
8892    <p>&nbsp;&nbsp;&nbsp;"FILES_SCANNED: 7"
8893    </p>
8894    <p>&nbsp;&nbsp;&nbsp;"SCANNING: /home/me/gigs/Bosendorfer 290.gig"
8895    </p>
8896    <p>&nbsp;&nbsp;&nbsp;"STATUS: 42"
8897    </p>
8898    <p>&nbsp;&nbsp;&nbsp;"."
8899    </p>
8900    </blockquote><p>
8901                        
8902    </p>
8903  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
8904  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8905  <a name="rfc.section.6"></a><h3>6.&nbsp;Command Syntax</h3>  <a name="rfc.section.7"></a><h3>7.&nbsp;
8906    Command Syntax</h3>
8907    
8908    <p>The grammar of the control protocol as descibed in <a class='info' href='#control_commands'>Section&nbsp;6<span> (</span><span class='info'>Description for control commands</span><span>)</span></a>
8909                is defined below using Backus-Naur Form (BNF as described in <a class='info' href='#RFC2234'>[RFC2234]<span> (</span><span class='info'>Crocker, D. and P. Overell, &ldquo;Augmented BNF for Syntax Specifications,&rdquo; 1997.</span><span>)</span></a>)
8910                where applicable.
8911                
8912    </p>
8913    <p>input =
8914            </p>
8915    <blockquote class="text">
8916    <p>line LF
8917                    
8918    </p>
8919    <p>/ line CR LF
8920                    
8921    </p>
8922    </blockquote><p>
8923    
8924    </p>
8925    <p>line =
8926            </p>
8927    <blockquote class="text">
8928    <p>/* epsilon (empty line ignored) */
8929                    
8930    </p>
8931    <p>/ comment
8932                    
8933    </p>
8934    <p>/ command
8935                    
8936    </p>
8937    <p>/ error
8938                    
8939    </p>
8940    </blockquote><p>
8941    
8942    </p>
8943    <p>comment =
8944            </p>
8945    <blockquote class="text">
8946    <p>'#'
8947                    
8948    </p>
8949    <p>/ comment '#'
8950                    
8951    </p>
8952    <p>/ comment SP
8953                    
8954    </p>
8955    <p>/ comment number
8956                    
8957    </p>
8958    <p>/ comment string
8959                    
8960    </p>
8961    </blockquote><p>
8962    
8963    </p>
8964    <p>command =
8965            </p>
8966    <blockquote class="text">
8967    <p>ADD SP add_instruction
8968                    
8969    </p>
8970    <p>/ MAP SP map_instruction
8971                    
8972    </p>
8973    <p>/ UNMAP SP unmap_instruction
8974                    
8975    </p>
8976    <p>/ GET SP get_instruction
8977                    
8978    </p>
8979    <p>/ CREATE SP create_instruction
8980                    
8981    </p>
8982    <p>/ DESTROY SP destroy_instruction
8983                    
8984    </p>
8985    <p>/ LIST SP list_instruction
8986                    
8987    </p>
8988    <p>/ LOAD SP load_instruction
8989                    
8990    </p>
8991    <p>/ REMOVE SP remove_instruction
8992                    
8993    </p>
8994    <p>/ SET SP set_instruction
8995                    
8996    </p>
8997    <p>/ SUBSCRIBE SP subscribe_event
8998                    
8999    </p>
9000    <p>/ UNSUBSCRIBE SP unsubscribe_event
9001                    
9002    </p>
9003    <p>/ RESET SP reset_instruction
9004                    
9005    </p>
9006    <p>/ CLEAR SP clear_instruction
9007                    
9008    </p>
9009    <p>/ FIND SP find_instruction
9010                    
9011    </p>
9012    <p>/ MOVE SP move_instruction
9013                    
9014    </p>
9015    <p>/ COPY SP copy_instruction
9016                    
9017    </p>
9018    <p>/ RESET
9019                    
9020    </p>
9021    <p>/ QUIT
9022                    
9023    </p>
9024    </blockquote><p>
9025    
9026    </p>
9027    <p>add_instruction =
9028            </p>
9029    <blockquote class="text">
9030    <p>CHANNEL
9031                    
9032    </p>
9033    <p>/ DB_INSTRUMENT_DIRECTORY SP pathname
9034                    
9035    </p>
9036    <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP pathname SP pathname
9037                    
9038    </p>
9039    <p>/ DB_INSTRUMENTS SP scan_mode SP pathname SP pathname
9040                    
9041    </p>
9042    <p>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname
9043                    
9044    </p>
9045    <p>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP instrument_index
9046                    
9047    </p>
9048    <p>/ DB_INSTRUMENTS SP pathname SP pathname
9049                    
9050    </p>
9051    <p>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index
9052                    
9053    </p>
9054    <p>/ MIDI_INSTRUMENT_MAP
9055                    
9056    </p>
9057    <p>/ MIDI_INSTRUMENT_MAP SP map_name
9058                    
9059    </p>
9060    </blockquote><p>
9061    
9062    </p>
9063    <p>subscribe_event =
9064            </p>
9065    <blockquote class="text">
9066    <p>AUDIO_OUTPUT_DEVICE_COUNT
9067                    
9068    </p>
9069    <p>/ AUDIO_OUTPUT_DEVICE_INFO
9070                    
9071    </p>
9072    <p>/ MIDI_INPUT_DEVICE_COUNT
9073                    
9074    </p>
9075    <p>/ MIDI_INPUT_DEVICE_INFO
9076                    
9077    </p>
9078    <p>/ CHANNEL_COUNT
9079                    
9080    </p>
9081    <p>/ VOICE_COUNT
9082                    
9083    </p>
9084    <p>/ STREAM_COUNT
9085                    
9086    </p>
9087    <p>/ BUFFER_FILL
9088                    
9089    </p>
9090    <p>/ CHANNEL_INFO
9091                    
9092    </p>
9093    <p>/ FX_SEND_COUNT
9094                    
9095    </p>
9096    <p>/ FX_SEND_INFO
9097                    
9098    </p>
9099    <p>/ MIDI_INSTRUMENT_MAP_COUNT
9100                    
9101    </p>
9102    <p>/ MIDI_INSTRUMENT_MAP_INFO
9103                    
9104    </p>
9105    <p>/ MIDI_INSTRUMENT_COUNT
9106                    
9107    </p>
9108    <p>/ MIDI_INSTRUMENT_INFO
9109                    
9110    </p>
9111    <p>/ DB_INSTRUMENT_DIRECTORY_COUNT
9112                    
9113    </p>
9114    <p>/ DB_INSTRUMENT_DIRECTORY_INFO
9115                    
9116    </p>
9117    <p>/ DB_INSTRUMENT_COUNT
9118                    
9119    </p>
9120    <p>/ DB_INSTRUMENT_INFO
9121                    
9122    </p>
9123    <p>/ DB_INSTRUMENTS_JOB_INFO
9124                    
9125    </p>
9126    <p>/ MISCELLANEOUS
9127                    
9128    </p>
9129    <p>/ TOTAL_VOICE_COUNT
9130                    
9131    </p>
9132    <p>/ GLOBAL_INFO
9133                    
9134    </p>
9135    </blockquote><p>
9136    
9137    </p>
9138    <p>unsubscribe_event =
9139            </p>
9140    <blockquote class="text">
9141    <p>AUDIO_OUTPUT_DEVICE_COUNT
9142                    
9143    </p>
9144    <p>/ AUDIO_OUTPUT_DEVICE_INFO
9145                    
9146    </p>
9147    <p>/ MIDI_INPUT_DEVICE_COUNT
9148                    
9149    </p>
9150    <p>/ MIDI_INPUT_DEVICE_INFO
9151                    
9152    </p>
9153    <p>/ CHANNEL_COUNT
9154                    
9155    </p>
9156    <p>/ VOICE_COUNT
9157                    
9158    </p>
9159    <p>/ STREAM_COUNT
9160                    
9161    </p>
9162    <p>/ BUFFER_FILL
9163                    
9164    </p>
9165    <p>/ CHANNEL_INFO
9166                    
9167    </p>
9168    <p>/ FX_SEND_COUNT
9169                    
9170    </p>
9171    <p>/ FX_SEND_INFO
9172                    
9173    </p>
9174    <p>/ MIDI_INSTRUMENT_MAP_COUNT
9175                    
9176    </p>
9177    <p>/ MIDI_INSTRUMENT_MAP_INFO
9178                    
9179    </p>
9180    <p>/ MIDI_INSTRUMENT_COUNT
9181                    
9182    </p>
9183    <p>/ MIDI_INSTRUMENT_INFO
9184                    
9185    </p>
9186    <p>/ DB_INSTRUMENT_DIRECTORY_COUNT
9187                    
9188    </p>
9189    <p>/ DB_INSTRUMENT_DIRECTORY_INFO
9190                    
9191    </p>
9192    <p>/ DB_INSTRUMENT_COUNT
9193                    
9194    </p>
9195    <p>/ DB_INSTRUMENT_INFO
9196                    
9197    </p>
9198    <p>/ DB_INSTRUMENTS_JOB_INFO
9199                    
9200    </p>
9201    <p>/ MISCELLANEOUS
9202                    
9203    </p>
9204    <p>/ TOTAL_VOICE_COUNT
9205                    
9206    </p>
9207    <p>/ GLOBAL_INFO
9208                    
9209    </p>
9210    </blockquote><p>
9211    
9212    </p>
9213    <p>map_instruction =
9214            </p>
9215    <blockquote class="text">
9216    <p>MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value
9217                    
9218    </p>
9219    <p>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode
9220                    
9221    </p>
9222    <p>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name
9223                    
9224    </p>
9225    <p>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name
9226                    
9227    </p>
9228    </blockquote><p>
9229    
9230    </p>
9231    <p>unmap_instruction =
9232            </p>
9233    <blockquote class="text">
9234    <p>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
9235                    
9236    </p>
9237    </blockquote><p>
9238    
9239    </p>
9240    <p>remove_instruction =
9241            </p>
9242    <blockquote class="text">
9243    <p>CHANNEL SP sampler_channel
9244                    
9245    </p>
9246    <p>/ MIDI_INSTRUMENT_MAP SP midi_map
9247                    
9248    </p>
9249    <p>/ MIDI_INSTRUMENT_MAP SP ALL
9250                    
9251    </p>
9252    <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname
9253                    
9254    </p>
9255    <p>/ DB_INSTRUMENT_DIRECTORY SP pathname
9256                    
9257    </p>
9258    <p>/ DB_INSTRUMENT SP pathname
9259                    
9260    </p>
9261    </blockquote><p>
9262    
9263    </p>
9264    <p>get_instruction =
9265            </p>
9266    <blockquote class="text">
9267    <p>AVAILABLE_ENGINES
9268                    
9269    </p>
9270    <p>/ AVAILABLE_MIDI_INPUT_DRIVERS
9271                    
9272    </p>
9273    <p>/ MIDI_INPUT_DRIVER SP INFO SP string
9274                    
9275    </p>
9276    <p>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
9277                    
9278    </p>
9279    <p>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
9280                    
9281    </p>
9282    <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
9283                    
9284    </p>
9285    <p>/ AUDIO_OUTPUT_DRIVER SP INFO SP string
9286                    
9287    </p>
9288    <p>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
9289                    
9290    </p>
9291    <p>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
9292                    
9293    </p>
9294    <p>/ AUDIO_OUTPUT_DEVICES
9295                    
9296    </p>
9297    <p>/ MIDI_INPUT_DEVICES
9298                    
9299    </p>
9300    <p>/ AUDIO_OUTPUT_DEVICE SP INFO SP number
9301                    
9302    </p>
9303    <p>/ MIDI_INPUT_DEVICE SP INFO SP number
9304                    
9305    </p>
9306    <p>/ MIDI_INPUT_PORT SP INFO SP number SP number
9307                    
9308    </p>
9309    <p>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
9310                    
9311    </p>
9312    <p>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
9313                    
9314    </p>
9315    <p>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string
9316                    
9317    </p>
9318    <p>/ CHANNELS
9319                    
9320    </p>
9321    <p>/ CHANNEL SP INFO SP sampler_channel
9322                    
9323    </p>
9324    <p>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
9325                    
9326    </p>
9327    <p>/ CHANNEL SP STREAM_COUNT SP sampler_channel
9328                    
9329    </p>
9330    <p>/ CHANNEL SP VOICE_COUNT SP sampler_channel
9331                    
9332    </p>
9333    <p>/ ENGINE SP INFO SP engine_name
9334                    
9335    </p>
9336    <p>/ SERVER SP INFO
9337                    
9338    </p>
9339    <p>/ TOTAL_VOICE_COUNT
9340                    
9341    </p>
9342    <p>/ TOTAL_VOICE_COUNT_MAX
9343                    
9344    </p>
9345    <p>/ MIDI_INSTRUMENTS SP midi_map
9346                    
9347    </p>
9348    <p>/ MIDI_INSTRUMENTS SP ALL
9349                    
9350    </p>
9351    <p>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
9352                    
9353    </p>
9354    <p>/ MIDI_INSTRUMENT_MAPS
9355                    
9356    </p>
9357    <p>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
9358                    
9359    </p>
9360    <p>/ FX_SENDS SP sampler_channel
9361                    
9362    </p>
9363    <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
9364                    
9365    </p>
9366    <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
9367                    
9368    </p>
9369    <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname
9370                    
9371    </p>
9372    <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
9373                    
9374    </p>
9375    <p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname
9376                    
9377    </p>
9378    <p>/ DB_INSTRUMENTS SP pathname
9379                    
9380    </p>
9381    <p>/ DB_INSTRUMENT SP INFO SP pathname
9382                    
9383    </p>
9384    <p>/ DB_INSTRUMENTS_JOB SP INFO SP number
9385                    
9386    </p>
9387    <p>/ VOLUME
9388                    
9389    </p>
9390    </blockquote><p>
9391    
9392    </p>
9393    <p>set_instruction =
9394            </p>
9395    <blockquote class="text">
9396    <p>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
9397                    
9398    </p>
9399    <p>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list
9400                    
9401    </p>
9402    <p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
9403                    
9404    </p>
9405    <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
9406                    
9407    </p>
9408    <p>/ CHANNEL SP set_chan_instruction
9409                    
9410    </p>
9411    <p>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
9412                    
9413    </p>
9414    <p>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
9415                    
9416    </p>
9417    <p>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
9418                    
9419    </p>
9420    <p>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
9421                    
9422    </p>
9423    <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
9424                    
9425    </p>
9426    <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname
9427                    
9428    </p>
9429    <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval
9430                    
9431    </p>
9432    <p>/ DB_INSTRUMENT SP NAME SP pathname SP dirname
9433                    
9434    </p>
9435    <p>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval
9436                    
9437    </p>
9438    <p>/ ECHO SP boolean
9439                    
9440    </p>
9441    <p>/ VOLUME SP volume_value
9442                    
9443    </p>
9444    </blockquote><p>
9445    
9446    </p>
9447    <p>create_instruction =
9448            </p>
9449    <blockquote class="text">
9450    <p>AUDIO_OUTPUT_DEVICE SP string SP key_val_list
9451                    
9452    </p>
9453    <p>/ AUDIO_OUTPUT_DEVICE SP string
9454                    
9455    </p>
9456    <p>/ MIDI_INPUT_DEVICE SP string SP key_val_list
9457                    
9458    </p>
9459    <p>/ MIDI_INPUT_DEVICE SP string
9460                    
9461    </p>
9462    <p>/ FX_SEND SP sampler_channel SP midi_ctrl
9463                    
9464    </p>
9465    <p>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
9466                    
9467    </p>
9468    </blockquote><p>
9469    
9470    </p>
9471    <p>reset_instruction =
9472            </p>
9473    <blockquote class="text">
9474    <p>CHANNEL SP sampler_channel
9475                    
9476    </p>
9477    </blockquote><p>
9478    
9479    </p>
9480    <p>clear_instruction =
9481            </p>
9482    <blockquote class="text">
9483    <p>MIDI_INSTRUMENTS SP midi_map
9484                    
9485    </p>
9486    <p>/ MIDI_INSTRUMENTS SP ALL
9487                    
9488    </p>
9489    </blockquote><p>
9490    
9491    </p>
9492    <p>find_instruction =
9493            </p>
9494    <blockquote class="text">
9495    <p>DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list
9496                    
9497    </p>
9498    <p>/ DB_INSTRUMENTS SP pathname SP query_val_list
9499                    
9500    </p>
9501    <p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP query_val_list
9502                    
9503    </p>
9504    <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list
9505                    
9506    </p>
9507    </blockquote><p>
9508    
9509    </p>
9510    <p>move_instruction =
9511            </p>
9512    <blockquote class="text">
9513    <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
9514                    
9515    </p>
9516    <p>/ DB_INSTRUMENT SP pathname SP pathname
9517                    
9518    </p>
9519    </blockquote><p>
9520    
9521    </p>
9522    <p>copy_instruction =
9523            </p>
9524    <blockquote class="text">
9525    <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
9526                    
9527    </p>
9528    <p>/ DB_INSTRUMENT SP pathname SP pathname
9529                    
9530    </p>
9531    </blockquote><p>
9532    
9533    </p>
9534    <p>destroy_instruction =
9535            </p>
9536    <blockquote class="text">
9537    <p>AUDIO_OUTPUT_DEVICE SP number
9538                    
9539    </p>
9540    <p>/ MIDI_INPUT_DEVICE SP number
9541                    
9542    </p>
9543    <p>/ FX_SEND SP sampler_channel SP fx_send_id
9544                    
9545    </p>
9546    </blockquote><p>
9547    
9548    </p>
9549    <p>load_instruction =
9550            </p>
9551    <blockquote class="text">
9552    <p>INSTRUMENT SP load_instr_args
9553                    
9554    </p>
9555    <p>/ ENGINE SP load_engine_args
9556                    
9557    </p>
9558    </blockquote><p>
9559    
9560    </p>
9561    <p>set_chan_instruction =
9562            </p>
9563    <blockquote class="text">
9564    <p>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
9565                    
9566    </p>
9567    <p>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index
9568                    
9569    </p>
9570    <p>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
9571                    
9572    </p>
9573    <p>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index
9574                    
9575    </p>
9576    <p>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index
9577                    
9578    </p>
9579    <p>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
9580                    
9581    </p>
9582    <p>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index
9583                    
9584    </p>
9585    <p>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
9586                    
9587    </p>
9588    <p>/ VOLUME SP sampler_channel SP volume_value
9589                    
9590    </p>
9591    <p>/ MUTE SP sampler_channel SP boolean
9592                    
9593    </p>
9594    <p>/ SOLO SP sampler_channel SP boolean
9595                    
9596    </p>
9597    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
9598                    
9599    </p>
9600    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
9601                    
9602    </p>
9603    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
9604                    
9605    </p>
9606    </blockquote><p>
9607    
9608    </p>
9609    <p>modal_arg =
9610            </p>
9611    <blockquote class="text">
9612    <p>/* epsilon (empty argument) */
9613                    
9614    </p>
9615    <p>/ NON_MODAL SP
9616                    
9617    </p>
9618    </blockquote><p>
9619    
9620    </p>
9621    <p>key_val_list =
9622            </p>
9623    <blockquote class="text">
9624    <p>string '=' param_val_list
9625                    
9626    </p>
9627    <p>/ key_val_list SP string '=' param_val_list
9628                    
9629    </p>
9630    </blockquote><p>
9631    
9632    </p>
9633    <p>buffer_size_type =
9634            </p>
9635    <blockquote class="text">
9636    <p>BYTES
9637                    
9638    </p>
9639    <p>/ PERCENTAGE
9640                    
9641    </p>
9642    </blockquote><p>
9643    
9644    </p>
9645    <p>list_instruction =
9646            </p>
9647    <blockquote class="text">
9648    <p>AUDIO_OUTPUT_DEVICES
9649                    
9650    </p>
9651    <p>/ MIDI_INPUT_DEVICES
9652                    
9653    </p>
9654    <p>/ CHANNELS
9655                    
9656    </p>
9657    <p>/ AVAILABLE_ENGINES
9658                    
9659    </p>
9660    <p>/ AVAILABLE_MIDI_INPUT_DRIVERS
9661                    
9662    </p>
9663    <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
9664                    
9665    </p>
9666    <p>/ MIDI_INSTRUMENTS SP midi_map
9667                    
9668    </p>
9669    <p>/ MIDI_INSTRUMENTS SP ALL
9670                    
9671    </p>
9672    <p>/ MIDI_INSTRUMENT_MAPS
9673                    
9674    </p>
9675    <p>/ FX_SENDS SP sampler_channel
9676                    
9677    </p>
9678    <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
9679                    
9680    </p>
9681    <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname
9682                    
9683    </p>
9684    <p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname
9685                    
9686    </p>
9687    <p>/ DB_INSTRUMENTS SP pathname
9688                    
9689    </p>
9690    </blockquote><p>
9691    
9692    </p>
9693    <p>load_instr_args =
9694            </p>
9695    <blockquote class="text">
9696    <p>filename SP instrument_index SP sampler_channel
9697                    
9698    </p>
9699    <p>/ NON_MODAL SP filename SP instrument_index SP sampler_channel
9700                    
9701    </p>
9702    </blockquote><p>
9703    
9704    </p>
9705    <p>load_engine_args =
9706            </p>
9707    <blockquote class="text">
9708    <p>engine_name SP sampler_channel
9709                    
9710    </p>
9711    </blockquote><p>
9712    
9713    </p>
9714    <p>instr_load_mode =
9715            </p>
9716    <blockquote class="text">
9717    <p>ON_DEMAND
9718                    
9719    </p>
9720    <p>/ ON_DEMAND_HOLD
9721                    
9722    </p>
9723    <p>/ PERSISTENT
9724                    
9725    </p>
9726    </blockquote><p>
9727    
9728    </p>
9729    <p>device_index =
9730            </p>
9731    <blockquote class="text">
9732    <p>number
9733                    
9734    </p>
9735    </blockquote><p>
9736    
9737    </p>
9738    <p>audio_channel_index =
9739            </p>
9740    <blockquote class="text">
9741    <p>number
9742                    
9743    </p>
9744    </blockquote><p>
9745    
9746    </p>
9747    <p>audio_output_type_name =
9748            </p>
9749    <blockquote class="text">
9750    <p>string
9751                    
9752    </p>
9753    </blockquote><p>
9754    
9755    </p>
9756    <p>midi_input_port_index =
9757            </p>
9758    <blockquote class="text">
9759    <p>number
9760                    
9761    </p>
9762    </blockquote><p>
9763    
9764    </p>
9765    <p>midi_input_channel_index =
9766            </p>
9767    <blockquote class="text">
9768    <p>number
9769                    
9770    </p>
9771    <p>/ ALL
9772                    
9773    </p>
9774    </blockquote><p>
9775    
9776    </p>
9777    <p>midi_input_type_name =
9778            </p>
9779    <blockquote class="text">
9780    <p>string
9781                    
9782    </p>
9783    </blockquote><p>
9784    
9785    </p>
9786    <p>midi_map =
9787            </p>
9788    <blockquote class="text">
9789    <p>number
9790                    
9791    </p>
9792    </blockquote><p>
9793    
9794    </p>
9795    <p>midi_bank =
9796            </p>
9797    <blockquote class="text">
9798    <p>number
9799                    
9800    </p>
9801    </blockquote><p>
9802    
9803    </p>
9804    <p>midi_prog =
9805            </p>
9806    <blockquote class="text">
9807    <p>number
9808                    
9809    </p>
9810    </blockquote><p>
9811    
9812    </p>
9813    <p>midi_ctrl =
9814            </p>
9815    <blockquote class="text">
9816    <p>number
9817                    
9818    </p>
9819    </blockquote><p>
9820    
9821    </p>
9822    <p>volume_value =
9823            </p>
9824    <blockquote class="text">
9825    <p>dotnum
9826                    
9827    </p>
9828    <p>/ number
9829                    
9830    </p>
9831    </blockquote><p>
9832    
9833    </p>
9834    <p>sampler_channel =
9835            </p>
9836    <blockquote class="text">
9837    <p>number
9838                    
9839    </p>
9840    </blockquote><p>
9841    
9842    </p>
9843    <p>instrument_index =
9844            </p>
9845    <blockquote class="text">
9846    <p>number
9847                    
9848    </p>
9849    </blockquote><p>
9850    
9851    </p>
9852    <p>fx_send_id =
9853            </p>
9854    <blockquote class="text">
9855    <p>number
9856                    
9857    </p>
9858    </blockquote><p>
9859    
9860    </p>
9861    <p>engine_name =
9862            </p>
9863    <blockquote class="text">
9864    <p>string
9865                    
9866    </p>
9867    </blockquote><p>
9868    
9869    </p>
9870    <p>pathname =
9871            </p>
9872    <blockquote class="text">
9873    <p>stringval
9874                    
9875    </p>
9876    </blockquote><p>
9877    
9878    </p>
9879    <p>dirname =
9880            </p>
9881    <blockquote class="text">
9882    <p>stringval
9883                    
9884    </p>
9885    </blockquote><p>
9886    
9887    </p>
9888    <p>filename =
9889            </p>
9890    <blockquote class="text">
9891    <p>stringval
9892                    
9893    </p>
9894    </blockquote><p>
9895    
9896    </p>
9897    <p>map_name =
9898            </p>
9899    <blockquote class="text">
9900    <p>stringval
9901                    
9902    </p>
9903    </blockquote><p>
9904    
9905    </p>
9906    <p>entry_name =
9907            </p>
9908    <blockquote class="text">
9909    <p>stringval
9910                    
9911    </p>
9912    </blockquote><p>
9913    
9914    </p>
9915    <p>fx_send_name =
9916            </p>
9917    <blockquote class="text">
9918    <p>stringval
9919                    
9920    </p>
9921    </blockquote><p>
9922    
9923    </p>
9924    <p>param_val_list =
9925            </p>
9926    <blockquote class="text">
9927    <p>param_val
9928                    
9929    </p>
9930    <p>/ param_val_list','param_val
9931                    
9932    </p>
9933    </blockquote><p>
9934    
9935    </p>
9936    <p>param_val =
9937            </p>
9938    <blockquote class="text">
9939    <p>string
9940                    
9941    </p>
9942    <p>/ stringval
9943                    
9944    </p>
9945    <p>/ number
9946                    
9947    </p>
9948    <p>/ dotnum
9949                    
9950    </p>
9951    </blockquote><p>
9952    
9953    </p>
9954    <p>query_val_list =
9955            </p>
9956    <blockquote class="text">
9957    <p>string '=' query_val
9958                    
9959    </p>
9960    <p>/ query_val_list SP string '=' query_val
9961                    
9962    </p>
9963    </blockquote><p>
9964    
9965    </p>
9966    <p>query_val =
9967            </p>
9968    <blockquote class="text">
9969    <p>string
9970                    
9971    </p>
9972    <p>/ stringval
9973                    
9974    </p>
9975    </blockquote><p>
9976    
9977    </p>
9978    <p>scan_mode =
9979            </p>
9980    <blockquote class="text">
9981    <p>RECURSIVE
9982                    
9983    </p>
9984    <p>/ NON_RECURSIVE
9985                    
9986    </p>
9987    <p>/ FLAT
9988                    
9989    </p>
9990    </blockquote><p>
9991    
 <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.  
9992  </p>  </p>
9993  <a name="events"></a><br /><hr />  <a name="events"></a><br /><hr />
9994  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
9995  <a name="rfc.section.7"></a><h3>7.&nbsp;Events</h3>  <a name="rfc.section.8"></a><h3>8.&nbsp;
9996    Events</h3>
9997    
9998  <p>This chapter will describe all currently defined events supported by LinuxSampler.  <p>This chapter will describe all currently defined events supported by LinuxSampler.
9999  </p>  </p>
10000  <a name="rfc.section.7.1"></a><h4><a name="SUBSCRIBE CHANNEL">7.1</a>&nbsp;Number of sampler channels changed</h4>  <a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"></a><br /><hr />
10001    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10002    <a name="rfc.section.8.1"></a><h3>8.1.&nbsp;
10003    Number of audio output devices changed</h3>
10004    
10005  <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 audio output devices on the
10006                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
10007  </p>  </p>
10008  <p></p>  <p>
10009                        </p>
10010  <blockquote class="text">  <blockquote class="text">
10011  <p>SUBSCRIBE CHANNELS  <p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
10012  </p>  </p>
10013  </blockquote>  </blockquote><p>
10014                    
10015    </p>
10016    <p>Server will start sending the following notification messages:
10017    </p>
10018    <p>
10019                        </p>
10020    <blockquote class="text">
10021    <p>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"
10022    </p>
10023    </blockquote><p>
10024                    
10025    </p>
10026    <p>where &lt;devices&gt; will be replaced by the new number
10027                    of audio output devices.
10028    </p>
10029    <a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"></a><br /><hr />
10030    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10031    <a name="rfc.section.8.2"></a><h3>8.2.&nbsp;
10032    Audio output device's settings changed</h3>
10033    
10034    <p>Client may want to be notified when changes were made to audio output devices on the
10035                    back-end by issuing the following command:
10036    </p>
10037    <p>
10038                        </p>
10039    <blockquote class="text">
10040    <p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
10041    </p>
10042    </blockquote><p>
10043                    
10044    </p>
10045  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
10046  </p>  </p>
10047  <p></p>  <p>
10048                        </p>
10049  <blockquote class="text">  <blockquote class="text">
10050  <p>"NOTIFY:CHANNELS:&lt;channels&gt;"  <p>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"
10051  </p>  </p>
10052  </blockquote>  </blockquote><p>
10053                    
10054    </p>
10055    <p>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
10056                    which settings has been changed. The front-end will have to send
10057                    the respective command to actually get the audio output device info. Because these messages
10058                    will be triggered by LSCP commands issued by other clients rather than real
10059                    time events happening on the server, it is believed that an empty notification
10060                    message is sufficient here.
10061    </p>
10062    <a name="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"></a><br /><hr />
10063    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10064    <a name="rfc.section.8.3"></a><h3>8.3.&nbsp;
10065    Number of MIDI input devices changed</h3>
10066    
10067    <p>Client may want to be notified when the total number of MIDI input devices on the
10068                    back-end changes by issuing the following command:
10069    </p>
10070    <p>
10071                        </p>
10072    <blockquote class="text">
10073    <p>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
10074    </p>
10075    </blockquote><p>
10076                    
10077    </p>
10078    <p>Server will start sending the following notification messages:
10079    </p>
10080    <p>
10081                        </p>
10082    <blockquote class="text">
10083    <p>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"
10084    </p>
10085    </blockquote><p>
10086                    
10087    </p>
10088    <p>where &lt;devices&gt; will be replaced by the new number
10089                    of MIDI input devices.
10090    </p>
10091    <a name="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"></a><br /><hr />
10092    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10093    <a name="rfc.section.8.4"></a><h3>8.4.&nbsp;
10094    MIDI input device's settings changed</h3>
10095    
10096    <p>Client may want to be notified when changes were made to MIDI input devices on the
10097                    back-end by issuing the following command:
10098    </p>
10099    <p>
10100                        </p>
10101    <blockquote class="text">
10102    <p>SUBSCRIBE MIDI_INPUT_DEVICE_INFO
10103    </p>
10104    </blockquote><p>
10105                    
10106    </p>
10107    <p>Server will start sending the following notification messages:
10108    </p>
10109    <p>
10110                        </p>
10111    <blockquote class="text">
10112    <p>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"
10113    </p>
10114    </blockquote><p>
10115                    
10116    </p>
10117    <p>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
10118                    which settings has been changed. The front-end will have to send
10119                    the respective command to actually get the MIDI input device info. Because these messages
10120                    will be triggered by LSCP commands issued by other clients rather than real
10121                    time events happening on the server, it is believed that an empty notification
10122                    message is sufficient here.
10123    </p>
10124    <a name="SUBSCRIBE CHANNEL_COUNT"></a><br /><hr />
10125    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10126    <a name="rfc.section.8.5"></a><h3>8.5.&nbsp;
10127    Number of sampler channels changed</h3>
10128    
10129    <p>Client may want to be notified when the total number of channels on the
10130                    back-end changes by issuing the following command:
10131    </p>
10132    <p>
10133                        </p>
10134    <blockquote class="text">
10135    <p>SUBSCRIBE CHANNEL_COUNT
10136    </p>
10137    </blockquote><p>
10138                    
10139    </p>
10140    <p>Server will start sending the following notification messages:
10141    </p>
10142    <p>
10143                        </p>
10144    <blockquote class="text">
10145    <p>"NOTIFY:CHANNEL_COUNT:&lt;channels&gt;"
10146    </p>
10147    </blockquote><p>
10148                    
10149    </p>
10150  <p>where &lt;channels&gt; will be replaced by the new number  <p>where &lt;channels&gt; will be replaced by the new number
10151                  of sampler channels.                  of sampler channels.
10152  </p>  </p>
10153  <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="SUBSCRIBE VOICE_COUNT"></a><br /><hr />
10154    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10155    <a name="rfc.section.8.6"></a><h3>8.6.&nbsp;
10156    Number of active voices changed</h3>
10157    
10158  <p>Client may want to be notified when the number of voices on the  <p>Client may want to be notified when the number of voices on the
10159                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
10160  </p>  </p>
10161  <p></p>  <p>
10162                        </p>
10163  <blockquote class="text">  <blockquote class="text">
10164  <p>SUBSCRIBE VOICE_COUNT  <p>SUBSCRIBE VOICE_COUNT
10165  </p>  </p>
10166  </blockquote>  </blockquote><p>
10167                    
10168    </p>
10169  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
10170  </p>  </p>
10171  <p></p>  <p>
10172                        </p>
10173  <blockquote class="text">  <blockquote class="text">
10174  <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;  <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"
10175    </p>
10176    </blockquote><p>
10177                    
10178  </p>  </p>
 </blockquote>  
   
10179  <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
10180                  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
10181                  active voices on that channel.                  active voices on that channel.
10182  </p>  </p>
10183  <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="SUBSCRIBE STREAM_COUNT"></a><br /><hr />
10184    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10185    <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;
10186    Number of active disk streams changed</h3>
10187    
10188  <p>Client may want to be notified when the number of streams on the back-end  <p>Client may want to be notified when the number of streams on the back-end
10189                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT
10190  </p>  </p>
10191  <p></p>  <p>
10192                        </p>
10193  <blockquote class="text">  <blockquote class="text">
10194  <p>SUBSCRIBE STREAM_COUNT  <p>SUBSCRIBE STREAM_COUNT
10195  </p>  </p>
10196  </blockquote>  </blockquote><p>
10197                    
10198    </p>
10199  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
10200  </p>  </p>
10201  <p></p>  <p>
10202                        </p>
10203  <blockquote class="text">  <blockquote class="text">
10204  <p>"NOTIFY:STREAM_COUNT:&lt;sampler-channel&gt; &lt;streams&gt;"  <p>"NOTIFY:STREAM_COUNT:&lt;sampler-channel&gt; &lt;streams&gt;"
10205  </p>  </p>
10206  </blockquote>  </blockquote><p>
10207                    
10208    </p>
10209  <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
10210                  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
10211                  active disk streams on that channel.                  active disk streams on that channel.
10212  </p>  </p>
10213  <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="SUBSCRIBE BUFFER_FILL"></a><br /><hr />
10214    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10215    <a name="rfc.section.8.8"></a><h3>8.8.&nbsp;
10216    Disk stream buffer fill state changed</h3>
10217    
10218  <p>Client may want to be notified when the buffer fill state of a disk stream  <p>Client may want to be notified when the buffer fill state of a disk stream
10219                  on the back-end changes by issuing the following command:                  on the back-end changes by issuing the following command:
10220  </p>  </p>
10221  <p></p>  <p>
10222                        </p>
10223  <blockquote class="text">  <blockquote class="text">
10224  <p>SUBSCRIBE BUFFER_FILL  <p>SUBSCRIBE BUFFER_FILL
10225  </p>  </p>
10226  </blockquote>  </blockquote><p>
10227                    
10228    </p>
10229  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
10230  </p>  </p>
10231  <p></p>  <p>
10232                        </p>
10233  <blockquote class="text">  <blockquote class="text">
10234  <p>"NOTIFY:BUFFER_FILL:&lt;sampler-channel&gt; &lt;fill-data&gt;"  <p>"NOTIFY:BUFFER_FILL:&lt;sampler-channel&gt; &lt;fill-data&gt;"
10235  </p>  </p>
10236  </blockquote>  </blockquote><p>
10237                    
10238    </p>
10239  <p>where &lt;sampler-channel&gt; will be replaced by the sampler channel the  <p>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
10240                  buffer fill state change occurred on and &lt;fill-data&gt; will be replaced by the                  buffer fill state change occurred on and &lt;fill-data&gt; will be replaced by the
10241                  buffer fill data for this channel as described in <a class="info" href="#GET CHANNEL BUFFER_FILL">Section 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>
10242                  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.
10243  </p>  </p>
10244  <a name="rfc.section.7.5"></a><h4><a name="SUBSCRIBE INFO">7.5</a>&nbsp;Channel information changed</h4>  <a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr />
10245    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10246    <a name="rfc.section.8.9"></a><h3>8.9.&nbsp;
10247    Channel information changed</h3>
10248    
10249  <p>Client may want to be notified when changes were made to sampler channels on the  <p>Client may want to be notified when changes were made to sampler channels on the
10250                  back-end changes by issuing the following command:                  back-end by issuing the following command:
10251  </p>  </p>
10252  <p></p>  <p>
10253                        </p>
10254  <blockquote class="text">  <blockquote class="text">
10255  <p>SUBSCRIBE INFO  <p>SUBSCRIBE CHANNEL_INFO
10256    </p>
10257    </blockquote><p>
10258                    
10259  </p>  </p>
 </blockquote>  
   
10260  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
10261  </p>  </p>
10262  <p></p>  <p>
10263                        </p>
10264  <blockquote class="text">  <blockquote class="text">
10265  <p>"NOTIFY:INFO:&lt;sampler-channel&gt;"  <p>"NOTIFY:CHANNEL_INFO:&lt;sampler-channel&gt;"
10266    </p>
10267    </blockquote><p>
10268                    
10269  </p>  </p>
 </blockquote>  
   
10270  <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
10271                  channel info change occurred. The front-end will have to send                  channel info change occurred. The front-end will have to send
10272                  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 10274  Intellectual Property and Copyright Stat
10274                  time events happening on the server, it is believed that an empty notification                  time events happening on the server, it is believed that an empty notification
10275                  message is sufficient here.                  message is sufficient here.
10276  </p>  </p>
10277  <a name="rfc.section.7.6"></a><h4><a name="SUBSCRIBE MISCELLANEOUS">7.6</a>&nbsp;Miscellaneous and debugging events</h4>  <a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr />
10278    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10279    <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
10280    Number of effect sends changed</h3>
10281    
10282    <p>Client may want to be notified when the number of effect sends on
10283                    a particular sampler channel is changed by issuing the following command:
10284    </p>
10285    <p>
10286                        </p>
10287    <blockquote class="text">
10288    <p>SUBSCRIBE FX_SEND_COUNT
10289    </p>
10290    </blockquote><p>
10291                    
10292    </p>
10293    <p>Server will start sending the following notification messages:
10294    </p>
10295    <p>
10296                        </p>
10297    <blockquote class="text">
10298    <p>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"
10299    </p>
10300    </blockquote><p>
10301                    
10302    </p>
10303    <p>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
10304                    channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
10305                    be replaced by the new number of effect sends on that channel.
10306    </p>
10307    <a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr />
10308    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10309    <a name="rfc.section.8.11"></a><h3>8.11.&nbsp;
10310    Effect send information changed</h3>
10311    
10312    <p>Client may want to be notified when changes were made to effect sends on a
10313                    a particular sampler channel by issuing the following command:
10314    </p>
10315    <p>
10316                        </p>
10317    <blockquote class="text">
10318    <p>SUBSCRIBE FX_SEND_INFO
10319    </p>
10320    </blockquote><p>
10321                    
10322    </p>
10323    <p>Server will start sending the following notification messages:
10324    </p>
10325    <p>
10326                        </p>
10327    <blockquote class="text">
10328    <p>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"
10329    </p>
10330    </blockquote><p>
10331                    
10332    </p>
10333    <p>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
10334                    channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
10335                    be replaced by the numerical ID of the changed effect send.
10336    </p>
10337    <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />
10338    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10339    <a name="rfc.section.8.12"></a><h3>8.12.&nbsp;
10340    Total number of active voices changed</h3>
10341    
10342    <p>Client may want to be notified when the total number of voices on the
10343                    back-end changes by issuing the following command:
10344    </p>
10345    <p>
10346                        </p>
10347    <blockquote class="text">
10348    <p>SUBSCRIBE TOTAL_VOICE_COUNT
10349    </p>
10350    </blockquote><p>
10351                    
10352    </p>
10353    <p>Server will start sending the following notification messages:
10354    </p>
10355    <p>
10356                        </p>
10357    <blockquote class="text">
10358    <p>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"
10359    </p>
10360    </blockquote><p>
10361                    
10362    </p>
10363    <p>where &lt;voices&gt; will be replaced by the new number of
10364                    all currently active voices.
10365    </p>
10366    <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr />
10367    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10368    <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;
10369    Number of MIDI instrument maps changed</h3>
10370    
10371    <p>Client may want to be notified when the number of MIDI instrument maps on the
10372                    back-end changes by issuing the following command:
10373    </p>
10374    <p>
10375                        </p>
10376    <blockquote class="text">
10377    <p>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
10378    </p>
10379    </blockquote><p>
10380                    
10381    </p>
10382    <p>Server will start sending the following notification messages:
10383    </p>
10384    <p>
10385                        </p>
10386    <blockquote class="text">
10387    <p>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"
10388    </p>
10389    </blockquote><p>
10390                    
10391    </p>
10392    <p>where &lt;maps&gt; will be replaced by the new number
10393                    of MIDI instrument maps.
10394    </p>
10395    <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr />
10396    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10397    <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;
10398    MIDI instrument map information changed</h3>
10399    
10400    <p>Client may want to be notified when changes were made to MIDI instrument maps on the
10401                    back-end by issuing the following command:
10402    </p>
10403    <p>
10404                        </p>
10405    <blockquote class="text">
10406    <p>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
10407    </p>
10408    </blockquote><p>
10409                    
10410    </p>
10411    <p>Server will start sending the following notification messages:
10412    </p>
10413    <p>
10414                        </p>
10415    <blockquote class="text">
10416    <p>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"
10417    </p>
10418    </blockquote><p>
10419                    
10420    </p>
10421    <p>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
10422                    for which information changes occurred. The front-end will have to send
10423                    the respective command to actually get the MIDI instrument map info. Because these messages
10424                    will be triggered by LSCP commands issued by other clients rather than real
10425                    time events happening on the server, it is believed that an empty notification
10426                    message is sufficient here.
10427    </p>
10428    <a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr />
10429    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10430    <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;
10431    Number of MIDI instruments changed</h3>
10432    
10433    <p>Client may want to be notified when the number of MIDI instrument maps on the
10434                    back-end changes by issuing the following command:
10435    </p>
10436    <p>
10437                        </p>
10438    <blockquote class="text">
10439    <p>SUBSCRIBE MIDI_INSTRUMENT_COUNT
10440    </p>
10441    </blockquote><p>
10442                    
10443    </p>
10444    <p>Server will start sending the following notification messages:
10445    </p>
10446    <p>
10447                        </p>
10448    <blockquote class="text">
10449    <p>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"
10450    </p>
10451    </blockquote><p>
10452                    
10453    </p>
10454    <p>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
10455                    the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
10456                    the new number of MIDI instruments in the specified map.
10457    </p>
10458    <a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr />
10459    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10460    <a name="rfc.section.8.16"></a><h3>8.16.&nbsp;
10461    MIDI instrument information changed</h3>
10462    
10463    <p>Client may want to be notified when changes were made to MIDI instruments on the
10464                    back-end by issuing the following command:
10465    </p>
10466    <p>
10467                        </p>
10468    <blockquote class="text">
10469    <p>SUBSCRIBE MIDI_INSTRUMENT_INFO
10470    </p>
10471    </blockquote><p>
10472                    
10473    </p>
10474    <p>Server will start sending the following notification messages:
10475    </p>
10476    <p>
10477                        </p>
10478    <blockquote class="text">
10479    <p>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"
10480    </p>
10481    </blockquote><p>
10482                    
10483    </p>
10484    <p>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
10485                    in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
10486                    the location of the changed MIDI instrument in the map. The front-end will have to send
10487                    the respective command to actually get the MIDI instrument info. Because these messages
10488                    will be triggered by LSCP commands issued by other clients rather than real
10489                    time events happening on the server, it is believed that an empty notification
10490                    message is sufficient here.
10491    </p>
10492    <a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr />
10493    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10494    <a name="rfc.section.8.17"></a><h3>8.17.&nbsp;
10495    Global settings changed</h3>
10496    
10497    <p>Client may want to be notified when changes to the global settings
10498                    of the sampler were made by issuing the following command:
10499    </p>
10500    <p>
10501                        </p>
10502    <blockquote class="text">
10503    <p>SUBSCRIBE GLOBAL_INFO
10504    </p>
10505    </blockquote><p>
10506                    
10507    </p>
10508    <p>Server will start sending the following types of notification messages:
10509    </p>
10510    <p>
10511                        </p>
10512    <blockquote class="text">
10513    <p>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
10514                            golbal volume of the sampler is changed, where &lt;volume&gt; will be
10515                            replaced by the optional dotted floating point value, reflecting the
10516                            new global volume parameter.
10517    </p>
10518    </blockquote><p>
10519                    
10520    </p>
10521    <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />
10522    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10523    <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;
10524    Number of database instrument directories changed</h3>
10525    
10526    <p>Client may want to be notified when the number of instrument
10527                    directories in a particular directory in the instruments database
10528                    is changed by issuing the following command:
10529    </p>
10530    <p>
10531                        </p>
10532    <blockquote class="text">
10533    <p>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT
10534    </p>
10535    </blockquote><p>
10536                    
10537    </p>
10538    <p>Server will start sending the following notification messages:
10539    </p>
10540    <p>
10541                        </p>
10542    <blockquote class="text">
10543    <p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:&lt;dir-path&gt;"
10544    </p>
10545    </blockquote><p>
10546                    
10547    </p>
10548    <p>where &lt;dir-path&gt; will be replaced by the absolute path
10549                    name of the directory in the instruments database,
10550                    in which the number of directories is changed.
10551    </p>
10552    <p>Note that when a non-empty directory is removed, this event
10553                    is not sent for the subdirectories in that directory.
10554    </p>
10555    <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr />
10556    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10557    <a name="rfc.section.8.19"></a><h3>8.19.&nbsp;
10558    Database instrument directory information changed</h3>
10559    
10560    <p>Client may want to be notified when changes were made to directories
10561                    in the instruments database by issuing the following command:
10562    </p>
10563    <p>
10564                        </p>
10565    <blockquote class="text">
10566    <p>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
10567    </p>
10568    </blockquote><p>
10569                    
10570    </p>
10571    <p>Server will start sending the following notification messages:
10572    </p>
10573    <p>
10574                        </p>
10575    <blockquote class="text">
10576    <p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:&lt;dir-path&gt;"
10577    </p>
10578    </blockquote><p>
10579                    
10580    </p>
10581    <p>where &lt;dir-path&gt; will be replaced by the absolute path name
10582                    of the directory, for which information changes occurred. The front-end will have to send
10583                    the respective command to actually get the updated directory info. Because these messages
10584                    will be triggered by LSCP commands issued by other clients rather than real
10585                    time events happening on the server, it is believed that an empty notification
10586                    message is sufficient here.
10587    </p>
10588    <p>
10589                        </p>
10590    <blockquote class="text">
10591    <p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME &lt;old-dir-path&gt; &lt;new-name&gt;"
10592    </p>
10593    </blockquote><p>
10594                    
10595    </p>
10596    <p>where &lt;old-dir-path&gt; is the old absolute path name of the directory
10597                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
10598                    the new name of the directory, encapsulated into apostrophes.
10599    </p>
10600    <a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr />
10601    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10602    <a name="rfc.section.8.20"></a><h3>8.20.&nbsp;
10603    Number of database instruments changed</h3>
10604    
10605    <p>Client may want to be notified when the number of instruments
10606                    in a particular directory in the instruments database
10607                    is changed by issuing the following command:
10608    </p>
10609    <p>
10610                        </p>
10611    <blockquote class="text">
10612    <p>SUBSCRIBE DB_INSTRUMENT_COUNT
10613    </p>
10614    </blockquote><p>
10615                    
10616    </p>
10617    <p>Server will start sending the following notification messages:
10618    </p>
10619    <p>
10620                        </p>
10621    <blockquote class="text">
10622    <p>"NOTIFY:DB_INSTRUMENT_COUNT:&lt;dir-path&gt;"
10623    </p>
10624    </blockquote><p>
10625                    
10626    </p>
10627    <p>where &lt;dir-path&gt; will be replaced by the absolute path
10628                    name of the directory in the instruments database,
10629                    in which the number of instruments is changed.
10630    </p>
10631    <p>Note that when a non-empty directory is removed, this event
10632                    is not sent for the instruments in that directory.
10633    </p>
10634    <a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr />
10635    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10636    <a name="rfc.section.8.21"></a><h3>8.21.&nbsp;
10637    Database instrument information changed</h3>
10638    
10639    <p>Client may want to be notified when changes were made to instruments
10640                    in the instruments database by issuing the following command:
10641    </p>
10642    <p>
10643                        </p>
10644    <blockquote class="text">
10645    <p>SUBSCRIBE DB_INSTRUMENT_INFO
10646    </p>
10647    </blockquote><p>
10648                    
10649    </p>
10650    <p>Server will start sending the following notification messages:
10651    </p>
10652    <p>
10653                        </p>
10654    <blockquote class="text">
10655    <p>"NOTIFY:DB_INSTRUMENT_INFO:&lt;instr-path&gt;"
10656    </p>
10657    </blockquote><p>
10658                    
10659    </p>
10660    <p>where &lt;instr-path&gt; will be replaced by the absolute path name
10661                    of the instrument, which settings are changed. The front-end will have to send
10662                    the respective command to actually get the updated directory info. Because these messages
10663                    will be triggered by LSCP commands issued by other clients rather than real
10664                    time events happening on the server, it is believed that an empty notification
10665                    message is sufficient here.
10666    </p>
10667    <p>
10668                        </p>
10669    <blockquote class="text">
10670    <p>"NOTIFY:DB_INSTRUMENT_INFO:NAME &lt;old-instr-path&gt; &lt;new-name&gt;"
10671    </p>
10672    </blockquote><p>
10673                    
10674    </p>
10675    <p>where &lt;old-instr-path&gt; is the old absolute path name of the instrument
10676                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
10677                    the new name of the instrument, encapsulated into apostrophes.
10678    </p>
10679    <a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr />
10680    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10681    <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;
10682    Database job status information changed</h3>
10683    
10684    <p>Client may want to be notified when the status of particular database
10685                    instruments job is changed by issuing the following command:
10686    </p>
10687    <p>
10688                        </p>
10689    <blockquote class="text">
10690    <p>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO
10691    </p>
10692    </blockquote><p>
10693                    
10694    </p>
10695    <p>Server will start sending the following notification messages:
10696    </p>
10697    <p>
10698                        </p>
10699    <blockquote class="text">
10700    <p>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:&lt;job-id&gt;"
10701    </p>
10702    </blockquote><p>
10703                    
10704    </p>
10705    <p>where &lt;job-id&gt; will be replaced by the numerical ID of the job,
10706                    which status is changed. The front-end will have to send the respective
10707                    command to actually get the status info. Because these messages
10708                    will be triggered by LSCP commands issued by other clients rather than real
10709                    time events happening on the server, it is believed that an empty notification
10710                    message is sufficient here.
10711    </p>
10712    <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
10713    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10714    <a name="rfc.section.8.23"></a><h3>8.23.&nbsp;
10715    Miscellaneous and debugging events</h3>
10716    
10717  <p>Client may want to be notified of miscellaneous and debugging events occurring at  <p>Client may want to be notified of miscellaneous and debugging events occurring at
10718                  the server by issuing the following command:                  the server by issuing the following command:
10719  </p>  </p>
10720  <p></p>  <p>
10721                        </p>
10722  <blockquote class="text">  <blockquote class="text">
10723  <p>SUBSCRIBE MISCELLANEOUS  <p>SUBSCRIBE MISCELLANEOUS
10724  </p>  </p>
10725  </blockquote>  </blockquote><p>
10726                    
10727    </p>
10728  <p>Server will start sending the following notification messages:  <p>Server will start sending the following notification messages:
10729  </p>  </p>
10730  <p></p>  <p>
10731                        </p>
10732  <blockquote class="text">  <blockquote class="text">
10733  <p>"NOTIFY:MISCELLANEOUS:&lt;string&gt;"  <p>"NOTIFY:MISCELLANEOUS:&lt;string&gt;"
10734  </p>  </p>
10735  </blockquote>  </blockquote><p>
10736                    
10737    </p>
10738  <p>where &lt;string&gt; will be replaced by whatever data server  <p>where &lt;string&gt; will be replaced by whatever data server
10739                  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
10740                  user AS IS to facilitate debugging.                  user AS IS to facilitate debugging.
10741  </p>  </p>
10742  <a name="anchor15"></a><br /><hr />  <a name="anchor14"></a><br /><hr />
10743  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10744  <a name="rfc.section.8"></a><h3>8.&nbsp;Security Considerations</h3>  <a name="rfc.section.9"></a><h3>9.&nbsp;
10745    Security Considerations</h3>
10746    
10747  <p>As there is so far no method of authentication and authorization  <p>As there is so far no method of authentication and authorization
10748              defined and so not required for a client applications to succeed to              defined and so not required for a client applications to succeed to
10749              connect, running LinuxSampler might be a security risk for the host              connect, running LinuxSampler might be a security risk for the host
10750              system the LinuxSampler instance is running on.              system the LinuxSampler instance is running on.
10751  </p>  </p>
10752  <a name="anchor16"></a><br /><hr />  <a name="anchor15"></a><br /><hr />
10753  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10754  <a name="rfc.section.9"></a><h3>9.&nbsp;Acknowledgments</h3>  <a name="rfc.section.10"></a><h3>10.&nbsp;
10755    Acknowledgments</h3>
10756    
10757  <p>This document has benefited greatly from the comments of the  <p>This document has benefited greatly from the comments of the
10758              following people, discussed on the LinuxSampler developer's mailing              following people, discussed on the LinuxSampler developer's mailing
10759              list:              list:
10760  </p>  </p>
10761  <p></p>  <p>
10762                    </p>
10763  <blockquote class="text">  <blockquote class="text">
10764  <p>Rui Nuno Capela  <p>Rui Nuno Capela
10765  </p>  </p>
# Line 4255  Intellectual Property and Copyright Stat Line 10767  Intellectual Property and Copyright Stat
10767  </p>  </p>
10768  <p>Mark Knecht  <p>Mark Knecht
10769  </p>  </p>
10770  </blockquote>  <p>Grigor Iliev
10771    </p>
10772    </blockquote><p>
10773                
10774    </p>
10775  <a name="rfc.references1"></a><br /><hr />  <a name="rfc.references1"></a><br /><hr />
10776  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10777  <h3>10&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
10778  <table width="99%" border="0">  <table width="99%" border="0">
10779  <tr><td class="author-text" valign="top"><a name="RFC2119">[RFC2119]</a></td>  <tr><td class="author-text" valign="top"><a name="RFC2119">[RFC2119]</a></td>
10780  <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>
10781    <tr><td class="author-text" valign="top"><a name="RFC2234">[RFC2234]</a></td>
10782    <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>
10783    <tr><td class="author-text" valign="top"><a name="RFC793">[RFC793]</a></td>
10784    <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>
10785  </table>  </table>
10786    
10787  <a name="rfc.authors"></a><br /><hr />  <a name="rfc.authors"></a><br /><hr />
10788  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10789  <h3>Author's Address</h3>  <h3>Author's Address</h3>
10790  <table width="99%" border="0" cellpadding="0" cellspacing="0">  <table width="99%" border="0" cellpadding="0" cellspacing="0">
10791  <tr><td class="author-text">&nbsp;</td>  <tr><td class="author-text">&nbsp;</td>
# Line 4280  Schoenebeck</td></tr> Line 10799  Schoenebeck</td></tr>
10799  <td class="author-text">74081 Heilbronn</td></tr>  <td class="author-text">74081 Heilbronn</td></tr>
10800  <tr><td class="author-text">&nbsp;</td>  <tr><td class="author-text">&nbsp;</td>
10801  <td class="author-text">Germany</td></tr>  <td class="author-text">Germany</td></tr>
10802  <tr><td class="author" align="right">EMail:&nbsp;</td>  <tr><td class="author" align="right">Email:&nbsp;</td>
10803  <td class="author-text"><a href="mailto:schoenebeck at software minus engineering dot org">schoenebeck at software minus engineering dot org</a></td></tr>  <td class="author-text"><a href="mailto:schoenebeck at software minus engineering dot org">schoenebeck at software minus engineering dot org</a></td></tr>
10804  </table>  </table>
10805  <a name="rfc.copyright"></a><br /><hr />  <a name="rfc.copyright"></a><br /><hr />
10806  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
10807  <h3>Intellectual Property Statement</h3>  <h3>Full Copyright Statement</h3>
10808  <p class='copyright'>  <p class='copyright'>
10809  The IETF takes no position regarding the validity or scope of  Copyright &copy; The IETF Trust (2007).</p>
 any intellectual property or other rights that might be claimed  
 to  pertain to the implementation or use of the technology  
 described in this document or the extent to which any license  
 under such rights might or might not be available; neither does  
 it represent that it has made any effort to identify any such  
 rights. Information on the IETF's procedures with respect to  
 rights in standards-track and standards-related documentation  
 can be found in BCP-11. Copies of claims of rights made  
 available for publication and any assurances of licenses to  
 be made available, or the result of an attempt made  
 to obtain a general license or permission for the use of such  
 proprietary rights by implementors or users of this  
 specification can be obtained from the IETF Secretariat.</p>  
10810  <p class='copyright'>  <p class='copyright'>
10811  The IETF invites any interested party to bring to its  This document is subject to the rights,
10812  attention any copyrights, patents or patent applications, or  licenses and restrictions contained in BCP&nbsp;78,
10813  other proprietary rights which may cover technology that may be  and except as set forth therein,
10814  required to practice this standard. Please address the  the authors retain all their rights.</p>
 information to the IETF Executive Director.</p>  
 <h3>Full Copyright Statement</h3>  
10815  <p class='copyright'>  <p class='copyright'>
10816  Copyright (C) The Internet Society (2005). All Rights Reserved.</p>  This document and the information contained herein are provided
10817    on an &ldquo;AS IS&rdquo; basis and THE CONTRIBUTOR,
10818    THE ORGANIZATION HE/SHE REPRESENTS
10819    OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST
10820    AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES,
10821    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT
10822    THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY
10823    IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
10824    PURPOSE.</p>
10825    <h3>Intellectual Property</h3>
10826  <p class='copyright'>  <p class='copyright'>
10827  This document and translations of it may be copied and furnished to  The IETF takes no position regarding the validity or scope of any
10828  others, and derivative works that comment on or otherwise explain it  Intellectual Property Rights or other rights that might be claimed
10829  or assist in its implementation may be prepared, copied, published and  to pertain to the implementation or use of the technology
10830  distributed, in whole or in part, without restriction of any kind,  described in this document or the extent to which any license
10831  provided that the above copyright notice and this paragraph are  under such rights might or might not be available; nor does it
10832  included on all such copies and derivative works. However, this  represent that it has made any independent effort to identify any
10833  document itself may not be modified in any way, such as by removing  such rights.
10834  the copyright notice or references to the Internet Society or other  Information on the procedures with respect to
10835  Internet organizations, except as needed for the purpose of  rights in RFC documents can be found in BCP&nbsp;78 and BCP&nbsp;79.</p>
 developing Internet standards in which case the procedures for  
 copyrights defined in the Internet Standards process must be  
 followed, or as required to translate it into languages other than  
 English.</p>  
10836  <p class='copyright'>  <p class='copyright'>
10837  The limited permissions granted above are perpetual and will not be  Copies of IPR disclosures made to the IETF Secretariat and any
10838  revoked by the Internet Society or its successors or assignees.</p>  assurances of licenses to be made available,
10839    or the result of an attempt made to obtain a general license or
10840    permission for the use of such proprietary rights by implementers or
10841    users of this specification can be obtained from the IETF on-line IPR
10842    repository at <a href='http://www.ietf.org/ipr'>http://www.ietf.org/ipr</a>.</p>
10843  <p class='copyright'>  <p class='copyright'>
10844  This document and the information contained herein is provided on an  The IETF invites any interested party to bring to its attention
10845  &quot;AS IS&quot; basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING  any copyrights,
10846  TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING  patents or patent applications,
10847  BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION  or other
10848  HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  proprietary rights that may cover technology that may be required
10849  MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.</p>  to implement this standard.
10850    Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p>
10851  <h3>Acknowledgment</h3>  <h3>Acknowledgment</h3>
10852  <p class='copyright'>  <p class='copyright'>
10853  Funding for the RFC Editor function is currently provided by the  Funding for the RFC Editor function is provided by
10854  Internet Society.</p>  the IETF Administrative Support Activity (IASA).</p>
10855  </body></html>  </body></html>

Legend:
Removed from v.542  
changed lines
  Added in v.1201

  ViewVC Help
Powered by ViewVC