/[svn]/web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.html
ViewVC logotype

Diff of /web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 940 by schoenebeck, Sat Nov 25 17:18:12 2006 UTC revision 1137 by iliev, Thu Mar 29 10:06:37 2007 UTC
# Line 3  Line 3 
3  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
4  <meta name="description" content="LinuxSampler Control Protocol">  <meta name="description" content="LinuxSampler Control Protocol">
5  <meta name="keywords" content="LSCP">  <meta name="keywords" content="LSCP">
6  <meta name="generator" content="xml2rfc v1.30 (http://xml.resource.org/)">  <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">
7  <style type='text/css'>  <style type='text/css'><!--
8  <!--          body {
9      body {                  font-family: verdana, charcoal, helvetica, arial, sans-serif;
10          font-family: verdana, charcoal, helvetica, arial, sans-serif;                  font-size: small; color: #000; background-color: #FFF;
11          margin: 2em;                  margin: 2em;
12          font-size: small ; color: #000000 ; background-color: #ffffff ; }          }
13      .title { color: #990000; font-size: x-large ;          h1, h2, h3, h4, h5, h6 {
14          font-weight: bold; text-align: right;                  font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;
15          font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;                  font-weight: bold; font-style: normal;
16          background-color: transparent; }          }
17      .filename { color: #666666; font-size: 18px; line-height: 28px;          h1 { color: #900; background-color: transparent; text-align: right; }
18          font-weight: bold; text-align: right;          h3 { color: #333; background-color: transparent; }
19          font-family: helvetica, arial, sans-serif;  
20          background-color: transparent; }          td.RFCbug {
21      td.rfcbug { background-color: #000000 ; width: 30px ; height: 30px ;                  font-size: x-small; text-decoration: none;
22          text-align: justify; vertical-align: middle ; padding-top: 2px ; }                  width: 30px; height: 30px; padding-top: 2px;
23      td.rfcbug span.RFC { color: #666666; font-weight: bold; text-decoration: none;                  text-align: justify; vertical-align: middle;
24          background-color: #000000 ;                  background-color: #000;
25          font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;          }
26          font-size: x-small ; }          td.RFCbug span.RFC {
27      td.rfcbug span.hotText { color: #ffffff; font-weight: normal; text-decoration: none;                  font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
28          text-align: center ;                  font-weight: bold; color: #666;
29          font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;          }
30          font-size: x-small ; background-color: #000000; }          td.RFCbug span.hotText {
31      /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */                  font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
32      div#counter{margin-top: 100px}                  font-weight: normal; text-align: center; color: #FFF;
33            }
34      a.info{  
35          position:relative; /*this is the key*/          table.TOCbug { width: 30px; height: 15px; }
36          z-index:24;          td.TOCbug {
37          text-decoration:none}                  text-align: center; width: 30px; height: 15px;
38                    color: #FFF; background-color: #900;
39      a.info:hover{z-index:25; background-color:#990000 ; color: #ffffff ;}          }
40            td.TOCbug a {
41      a.info span{display: none}                  font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;
42                    font-weight: bold; font-size: x-small; text-decoration: none;
43      a.info:hover span.info{ /*the span will display just on :hover state*/                  color: #FFF; background-color: transparent;
44          display:block;          }
45          position:absolute;  
46          font-size: smaller ;          td.header {
47          top:2em; left:2em; width:15em;                  font-family: arial, helvetica, sans-serif; font-size: x-small;
48          padding: 2px ;                  vertical-align: top; width: 33%;
49          border:1px solid #333333;                  color: #FFF; background-color: #666;
50          background-color:#eeeeee; color:#990000;          }
51          text-align: left ;}          td.author { font-weight: bold; font-size: x-small; margin-left: 4em; }
52            td.author-text { font-size: x-small; }
53       A { font-weight: bold; }  
54       A:link { color: #990000; background-color: transparent ; }          /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */
55       A:visited { color: #333333; background-color: transparent ; }          a.info {
56       A:active { color: #333333; background-color: transparent ; }                  /* This is the key. */
57                    position: relative;
58      p { margin-left: 2em; margin-right: 2em; }                  z-index: 24;
59      p.copyright { font-size: x-small ; }                  text-decoration: none;
60      p.toc { font-size: small ; font-weight: bold ; margin-left: 3em ;}          }
61      table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; }          a.info:hover {
62      td.toc { font-size: small; font-weight: bold; vertical-align: text-top; }                  z-index: 25;
63                    color: #FFF; background-color: #900;
64      span.emph { font-style: italic; }          }
65      span.strong { font-weight: bold; }          a.info span { display: none; }
66      span.verb, span.vbare { font-family: "Courier New", Courier, monospace ; }          a.info:hover span.info {
67                    /* The span will display just on :hover state. */
68      span.vemph { font-style: italic; font-family: "Courier New", Courier, monospace ; }                  display: block;
69      span.vstrong { font-weight: bold; font-family: "Courier New", Courier, monospace ; }                  position: absolute;
70      span.vdeluxe { font-weight: bold; font-style: italic; font-family: "Courier New", Courier, monospace ; }                  font-size: smaller;
71                    top: 2em; left: -5em; width: 15em;
72      ol.text { margin-left: 2em; margin-right: 2em; }                  padding: 2px; border: 1px solid #333;
73      ul.text { margin-left: 2em; margin-right: 2em; }                  color: #900; background-color: #EEE;
74      li { margin-left: 3em;  }                  text-align: left;
   
     pre { margin-left: 3em; color: #333333;  background-color: transparent;  
         font-family: "Courier New", Courier, monospace ; font-size: small ;  
         text-align: left;  
75          }          }
76    
77      h3 { color: #333333; font-size: medium ;          a { font-weight: bold; }
78          font-family: helvetica, arial, sans-serif ;          a:link    { color: #900; background-color: transparent; }
79          background-color: transparent; }          a:visited { color: #633; background-color: transparent; }
80      h4 { font-size: small; font-family: helvetica, arial, sans-serif ; }          a:active  { color: #633; background-color: transparent; }
81    
82      table.bug { width: 30px ; height: 15px ; }          p { margin-left: 2em; margin-right: 2em; }
83      td.bug { color: #ffffff ; background-color: #990000 ;          p.copyright { font-size: x-small; }
84          text-align: center ; width: 30px ; height: 15px ;          p.toc { font-size: small; font-weight: bold; margin-left: 3em; }
85           }          table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; }
86      td.bug A.link2 { color: #ffffff ; font-weight: bold;          td.toc { font-size: small; font-weight: bold; vertical-align: text-top; }
87          text-decoration: none;  
88          font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;          ol.text { margin-left: 2em; margin-right: 2em; }
89          font-size: x-small ; background-color: transparent }          ul.text { margin-left: 2em; margin-right: 2em; }
90            li      { margin-left: 3em; }
91      td.header { color: #ffffff; font-size: x-small ;  
92          font-family: arial, helvetica, sans-serif; vertical-align: top;          /* RFC-2629 <spanx>s and <artwork>s. */
93          background-color: #666666 ; width: 33% ; }          em     { font-style: italic; }
94      td.author { font-weight: bold; margin-left: 4em; font-size: x-small ; }          strong { font-weight: bold; }
95      td.author-text { font-size: x-small; }          dfn    { font-weight: bold; font-style: normal; }
96      table.full { vertical-align: top ; border-collapse: collapse ;          cite   { font-weight: normal; font-style: normal; }
97          border-style: solid solid solid solid ;          tt     { color: #036; }
98          border-color: black black black black ;          tt, pre, pre dfn, pre em, pre cite, pre span {
99          font-size: small ; text-align: center ; }                  font-family: "Courier New", Courier, monospace; font-size: small;
100      table.headers, table.none { vertical-align: top ; border-collapse: collapse ;          }
101          border-style: none;          pre {
102          font-size: small ; text-align: center ; }                  text-align: left; padding: 4px;
103      table.full th { font-weight: bold ;                  color: #000; background-color: #CCC;
104          border-style: solid ;          }
105          border-color: black black black black ; }          pre dfn  { color: #900; }
106      table.headers th { font-weight: bold ;          pre em   { color: #66F; background-color: #FFC; font-weight: normal; }
107          border-style: none none solid none;          pre .key { color: #33C; font-weight: bold; }
108          border-color: black black black black ; }          pre .id  { color: #900; }
109      table.none th { font-weight: bold ;          pre .str { color: #000; background-color: #CFF; }
110          border-style: none; }          pre .val { color: #066; }
111      table.full td {          pre .rep { color: #909; }
112          border-style: solid solid solid solid ;          pre .oth { color: #000; background-color: #FCF; }
113          border-color: #333333 #333333 #333333 #333333 ; }          pre .err { background-color: #FCC; }
114      table.headers td, table.none td { border-style: none; }  
115            /* RFC-2629 <texttable>s. */
116      hr { height: 1px }          table.all, table.full, table.headers, table.none {
117  -->                  font-size: small; text-align: center; border-width: 2px;
118  </style>                  vertical-align: top; border-collapse: collapse;
119            }
120            table.all, table.full { border-style: solid; border-color: black; }
121            table.headers, table.none { border-style: none; }
122            th {
123                    font-weight: bold; border-color: black;
124                    border-width: 2px 2px 3px 2px;
125            }
126            table.all th, table.full th { border-style: solid; }
127            table.headers th { border-style: none none solid none; }
128            table.none th { border-style: none; }
129            table.all td {
130                    border-style: solid; border-color: #333;
131                    border-width: 1px 2px;
132            }
133            table.full td, table.headers td, table.none td { border-style: none; }
134    
135            hr { height: 1px; }
136            hr.insert {
137                    width: 80%; border-style: none; border-width: 0;
138                    color: #CCC; background-color: #CCC;
139            }
140    --></style>
141  </head>  </head>
142  <body>  <body>
143  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
144  <table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1">  <table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1">
145  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>
146  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>
147  <tr><td class="header">Expires: May 29, 2007</td><td class="header">Engineering e. V.</td></tr>  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>
148  <tr><td class="header">&nbsp;</td><td class="header">November 25, 2006</td></tr>  <tr><td class="header">Expires: September 30, 2007</td><td class="header">March 29, 2007</td></tr>
149  </table></td></tr></table>  </table></td></tr></table>
150  <div align="right"><span class="title"><br />LinuxSampler Control Protocol</span></div>  <h1><br />LinuxSampler Control Protocol<br />LSCP 1.2</h1>
 <div align="right"><span class="title"><br />LSCP 1.1</span></div>  
151    
152  <h3>Status of this Memo</h3>  <h3>Status of this Memo</h3>
153  <p>  <p>
154  This document is an Internet-Draft and is  By submitting this Internet-Draft,
155  in full conformance with all provisions of Section&nbsp;10 of RFC&nbsp;2026.</p>  each author represents that any applicable patent or other IPR claims of which
156    he or she is aware have been or will be disclosed,
157    and any of which he or she becomes aware will be disclosed,
158    in accordance with Section&nbsp;6 of BCP&nbsp;79.</p>
159  <p>  <p>
160  Internet-Drafts are working documents of the Internet Engineering  Internet-Drafts are working documents of the Internet Engineering
161  Task Force (IETF), its areas, and its working groups.  Task Force (IETF), its areas, and its working groups.
# Line 153  The list of current Internet-Drafts can Line 173  The list of current Internet-Drafts can
173  The list of Internet-Draft Shadow Directories can be accessed at  The list of Internet-Draft Shadow Directories can be accessed at
174  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>
175  <p>  <p>
176  This Internet-Draft will expire on May 29, 2007.</p>  This Internet-Draft will expire on September 30, 2007.</p>
177    
178  <h3>Copyright Notice</h3>  <h3>Copyright Notice</h3>
179  <p>  <p>
180  Copyright &copy; The Internet Society (2006). All Rights Reserved.</p>  Copyright &copy; The IETF Trust (2007).</p>
181    
182  <h3>Abstract</h3>  <h3>Abstract</h3>
183    
# Line 278  Current number of active disk streams<br Line 298  Current number of active disk streams<br
298  Current fill state of disk stream buffers<br />  Current fill state of disk stream buffers<br />
299  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_DEVICE">6.4.14.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_DEVICE">6.4.14.</a>&nbsp;
300  Setting audio output device<br />  Setting audio output device<br />
301  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_TYP">6.4.15.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_TYPE">6.4.15.</a>&nbsp;
302  Setting audio output type<br />  Setting audio output type<br />
303  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_CHANNEL">6.4.16.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_CHANNEL">6.4.16.</a>&nbsp;
304  Setting audio output channel<br />  Setting audio output channel<br />
# Line 296  Setting channel volume<br /> Line 316  Setting channel volume<br />
316  Muting a sampler channel<br />  Muting a sampler channel<br />
317  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL SOLO">6.4.23.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL SOLO">6.4.23.</a>&nbsp;
318  Soloing a sampler channel<br />  Soloing a sampler channel<br />
319  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.24.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INSTRUMENT_MAP">6.4.24.</a>&nbsp;
320    Assigning a MIDI instrument map to a sampler channel<br />
321    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE FX_SEND">6.4.25.</a>&nbsp;
322    Adding an effect send to a sampler channel<br />
323    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY FX_SEND">6.4.26.</a>&nbsp;
324    Removing an effect send from a sampler channel<br />
325    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SENDS">6.4.27.</a>&nbsp;
326    Getting amount of effect sends on a sampler channel<br />
327    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST FX_SENDS">6.4.28.</a>&nbsp;
328    Listing all effect sends on a sampler channel<br />
329    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SEND INFO">6.4.29.</a>&nbsp;
330    Getting effect send information<br />
331    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND NAME">6.4.30.</a>&nbsp;
332    Changing effect send's name<br />
333    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a>&nbsp;
334    Altering effect send's audio routing<br />
335    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.32.</a>&nbsp;
336    Altering effect send's MIDI controller<br />
337    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.33.</a>&nbsp;
338    Altering effect send's send level<br />
339    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.34.</a>&nbsp;
340  Resetting a sampler channel<br />  Resetting a sampler channel<br />
341  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;
342  Controlling connection<br />  Controlling connection<br />
# Line 318  Maximum amount of active voices<br /> Line 358  Maximum amount of active voices<br />
358  Reset sampler<br />  Reset sampler<br />
359  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.4.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.4.</a>&nbsp;
360  General sampler informations<br />  General sampler informations<br />
361    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET VOLUME">6.6.5.</a>&nbsp;
362    Getting global volume attenuation<br />
363    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOLUME">6.6.6.</a>&nbsp;
364    Setting global volume attenuation<br />
365    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#MIDI Instrument Mapping">6.7.</a>&nbsp;
366    MIDI Instrument Mapping<br />
367    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD MIDI_INSTRUMENT MAP">6.7.1.</a>&nbsp;
368    Create a new MIDI instrument map<br />
369    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a>&nbsp;
370    Delete one particular or all MIDI instrument maps<br />
371    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT_MAPS">6.7.3.</a>&nbsp;
372    Get amount of existing MIDI instrument maps<br />
373    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INSTRUMENT_MAPS">6.7.4.</a>&nbsp;
374    Getting all created MIDI instrument maps<br />
375    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT_MAP INFO">6.7.5.</a>&nbsp;
376    Getting MIDI instrument map information<br />
377    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INSTRUMENT_MAP NAME">6.7.6.</a>&nbsp;
378    Renaming a MIDI instrument map<br />
379    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MAP MIDI_INSTRUMENT">6.7.7.</a>&nbsp;
380    Create or replace a MIDI instrument map entry<br />
381    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENTS">6.7.8.</a>&nbsp;
382    Getting ammount of MIDI instrument map entries<br />
383    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INSTRUMENTS">6.7.9.</a>&nbsp;
384    Getting indeces of all entries of a MIDI instrument map<br />
385    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#UNMAP MIDI_INSTRUMENT">6.7.10.</a>&nbsp;
386    Remove an entry from the MIDI instrument map<br />
387    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT INFO">6.7.11.</a>&nbsp;
388    Get current settings of MIDI instrument map entry<br />
389    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CLEAR MIDI_INSTRUMENTS">6.7.12.</a>&nbsp;
390    Clear MIDI instrument map<br />
391  <a href="#command_syntax">7.</a>&nbsp;  <a href="#command_syntax">7.</a>&nbsp;
392  Command Syntax<br />  Command Syntax<br />
393  <a href="#events">8.</a>&nbsp;  <a href="#events">8.</a>&nbsp;
394  Events<br />  Events<br />
395  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL">8.1.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a>&nbsp;
396    Number of audio output devices changed<br />
397    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">8.2.</a>&nbsp;
398    Audio output device's settings changed<br />
399    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">8.3.</a>&nbsp;
400    Number of MIDI input devices changed<br />
401    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INPUT_DEVICE_INFO">8.4.</a>&nbsp;
402    MIDI input device's settings changed<br />
403    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a>&nbsp;
404  Number of sampler channels changed<br />  Number of sampler channels changed<br />
405  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.2.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.6.</a>&nbsp;
406  Number of active voices changed<br />  Number of active voices changed<br />
407  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">8.3.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">8.7.</a>&nbsp;
408  Number of active disk streams changed<br />  Number of active disk streams changed<br />
409  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">8.4.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">8.8.</a>&nbsp;
410  Disk stream buffer fill state changed<br />  Disk stream buffer fill state changed<br />
411  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE INFO">8.5.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_INFO">8.9.</a>&nbsp;
412  Channel information changed<br />  Channel information changed<br />
413  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.6.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_COUNT">8.10.</a>&nbsp;
414    Number of effect sends changed<br />
415    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_INFO">8.11.</a>&nbsp;
416    Effect send information changed<br />
417    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a>&nbsp;
418  Total number of active voices changed<br />  Total number of active voices changed<br />
419  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.7.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.13.</a>&nbsp;
420    Number of MIDI instrument maps changed<br />
421    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.14.</a>&nbsp;
422    MIDI instrument map information changed<br />
423    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.15.</a>&nbsp;
424    Number of MIDI instruments changed<br />
425    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.16.</a>&nbsp;
426    MIDI instrument information changed<br />
427    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a>&nbsp;
428    Global settings changed<br />
429    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.18.</a>&nbsp;
430  Miscellaneous and debugging events<br />  Miscellaneous and debugging events<br />
431  <a href="#anchor14">9.</a>&nbsp;  <a href="#anchor14">9.</a>&nbsp;
432  Security Considerations<br />  Security Considerations<br />
# Line 350  Intellectual Property and Copyright Stat Line 442  Intellectual Property and Copyright Stat
442  <br clear="all" />  <br clear="all" />
443    
444  <a name="anchor1"></a><br /><hr />  <a name="anchor1"></a><br /><hr />
445  <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>
446  <a name="rfc.section.1"></a><h3>1.&nbsp;Requirements notation</h3>  <a name="rfc.section.1"></a><h3>1.&nbsp;
447    Requirements notation</h3>
448    
449  <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",  <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
450              "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",              "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
451              and "OPTIONAL" in this document are to be interpreted as              and "OPTIONAL" in this document are to be interpreted as
452              described in <a class="info" href="#RFC2119">[RFC2119]<span> (</span><span class="info">Bradner, S., &ldquo;Key words for use in RFCs to Indicate Requirement Levels,&rdquo; 1997.</span><span>)</span></a>.              described in <a class='info' href='#RFC2119'>[RFC2119]<span> (</span><span class='info'>Bradner, S., &ldquo;Key words for use in RFCs to Indicate Requirement Levels,&rdquo; 1997.</span><span>)</span></a>.
453  </p>  </p>
454  <p>This protocol is always case-sensitive if not explicitly  <p>This protocol is always case-sensitive if not explicitly
455              claimed the opposite.              claimed the opposite.
# Line 432  Intellectual Property and Copyright Stat Line 525  Intellectual Property and Copyright Stat
525              return and line feed characters respectively.              return and line feed characters respectively.
526  </p>  </p>
527  <a name="LSCP versioning"></a><br /><hr />  <a name="LSCP versioning"></a><br /><hr />
528  <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>
529  <a name="rfc.section.2"></a><h3>2.&nbsp;Versioning of this specification</h3>  <a name="rfc.section.2"></a><h3>2.&nbsp;
530    Versioning of this specification</h3>
531    
532  <p>LSCP will certainly be extended and enhanced by-and-by. Each official  <p>LSCP will certainly be extended and enhanced by-and-by. Each official
533              release of the LSCP specification will be tagged with a unique version              release of the LSCP specification will be tagged with a unique version
# Line 476  Intellectual Property and Copyright Stat Line 570  Intellectual Property and Copyright Stat
570  <p>  <p>
571              Compatibility can only be claimed if both rules are true.              Compatibility can only be claimed if both rules are true.
572              The frontend can use the              The frontend can use the
573              <a class="info" href="#GET SERVER INFO">"GET SERVER INFO"<span> (</span><span class="info">General sampler informations</span><span>)</span></a> command to              <a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a> command to
574              get the version of the LSCP specification the sampler complies with.              get the version of the LSCP specification the sampler complies with.
575                            
576  </p>  </p>
577  <a name="anchor2"></a><br /><hr />  <a name="anchor2"></a><br /><hr />
578  <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>
579  <a name="rfc.section.3"></a><h3>3.&nbsp;Introduction</h3>  <a name="rfc.section.3"></a><h3>3.&nbsp;
580    Introduction</h3>
581    
582  <p>LinuxSampler is a so called software sampler application  <p>LinuxSampler is a so called software sampler application
583              capable to playback audio samples from a computer's Random              capable to playback audio samples from a computer's Random
# Line 502  Intellectual Property and Copyright Stat Line 597  Intellectual Property and Copyright Stat
597              there.              there.
598  </p>  </p>
599  <a name="anchor3"></a><br /><hr />  <a name="anchor3"></a><br /><hr />
600  <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>
601  <a name="rfc.section.4"></a><h3>4.&nbsp;Focus of this protocol</h3>  <a name="rfc.section.4"></a><h3>4.&nbsp;
602    Focus of this protocol</h3>
603    
604  <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
605              a running LinuxSampler instance and to retrieve information              a running LinuxSampler instance and to retrieve information
# Line 514  Intellectual Property and Copyright Stat Line 610  Intellectual Property and Copyright Stat
610              via MIDI System Exclusive Messages.              via MIDI System Exclusive Messages.
611  </p>  </p>
612  <a name="anchor4"></a><br /><hr />  <a name="anchor4"></a><br /><hr />
613  <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>
614  <a name="rfc.section.5"></a><h3>5.&nbsp;Communication Overview</h3>  <a name="rfc.section.5"></a><h3>5.&nbsp;
615    Communication Overview</h3>
616    
617  <p>There are two distinct methods of communication between a  <p>There are two distinct methods of communication between a
618              running instance of LinuxSampler and one or more control              running instance of LinuxSampler and one or more control
# Line 529  Intellectual Property and Copyright Stat Line 626  Intellectual Property and Copyright Stat
626              methods will be described next.              methods will be described next.
627  </p>  </p>
628  <a name="anchor5"></a><br /><hr />  <a name="anchor5"></a><br /><hr />
629  <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>
630  <a name="rfc.section.5.1"></a><h3>5.1.&nbsp;Request/response communication method</h3>  <a name="rfc.section.5.1"></a><h3>5.1.&nbsp;
631    Request/response communication method</h3>
632    
633  <p>This simple communication method is based on  <p>This simple communication method is based on
634                  <a class="info" href="#RFC793">TCP<span> (</span><span class="info">Defense Advanced Research Projects Agency, &ldquo;TRANSMISSION CONTROL PROTOCOL,&rdquo; 1981.</span><span>)</span></a> [RFC793]. The                  <a class='info' href='#RFC793'>TCP<span> (</span><span class='info'>Defense Advanced Research Projects Agency, &ldquo;TRANSMISSION CONTROL PROTOCOL,&rdquo; 1981.</span><span>)</span></a> [RFC793]. The
635                  front-end application establishes a TCP connection to the                  front-end application establishes a TCP connection to the
636                  LinuxSampler instance on a certain host system. Then the                  LinuxSampler instance on a certain host system. Then the
637                  front-end application will send certain ASCII based commands                  front-end application will send certain ASCII based commands
# Line 574  Intellectual Property and Copyright Stat Line 672  Intellectual Property and Copyright Stat
672                  MUST be sent back in the same order.                  MUST be sent back in the same order.
673  </p>  </p>
674  <a name="anchor6"></a><br /><hr />  <a name="anchor6"></a><br /><hr />
675  <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>
676  <a name="rfc.section.5.1.1"></a><h3>5.1.1.&nbsp;Result format</h3>  <a name="rfc.section.5.1.1"></a><h3>5.1.1.&nbsp;
677    Result format</h3>
678    
679  <p>Result set could be one of the following types:  <p>Result set could be one of the following types:
680  </p>  </p>
# Line 766  Intellectual Property and Copyright Stat Line 865  Intellectual Property and Copyright Stat
865                                            
866  </p>  </p>
867  <a name="anchor7"></a><br /><hr />  <a name="anchor7"></a><br /><hr />
868  <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>
869  <a name="rfc.section.5.2"></a><h3>5.2.&nbsp;Subscribe/notify communication method</h3>  <a name="rfc.section.5.2"></a><h3>5.2.&nbsp;
870    Subscribe/notify communication method</h3>
871    
872  <p>This more sophisticated communication method is actually  <p>This more sophisticated communication method is actually
873                  only an extension of the simple request/response                  only an extension of the simple request/response
# Line 844  Intellectual Property and Copyright Stat Line 944  Intellectual Property and Copyright Stat
944  </p>  </p>
945  <p>where &lt;event-id&gt; will be replace by the respective  <p>where &lt;event-id&gt; will be replace by the respective
946                  event that client is no longer interested in receiving. For                  event that client is no longer interested in receiving. For
947                  a list of supported events see <a class="info" href="#events">Section&nbsp;8<span> (</span><span class="info">Events</span><span>)</span></a>.                  a list of supported events see <a class='info' href='#events'>Section&nbsp;8<span> (</span><span class='info'>Events</span><span>)</span></a>.
948  </p>  </p>
949  <p>Example: the fill states of disk stream buffers have  <p>Example: the fill states of disk stream buffers have
950                  changed on sampler channel 4 and the LinuxSampler instance                  changed on sampler channel 4 and the LinuxSampler instance
# Line 890  Intellectual Property and Copyright Stat Line 990  Intellectual Property and Copyright Stat
990                  it wants to receive.                  it wants to receive.
991  </p>  </p>
992  <a name="control_commands"></a><br /><hr />  <a name="control_commands"></a><br /><hr />
993  <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>
994  <a name="rfc.section.6"></a><h3>6.&nbsp;Description for control commands</h3>  <a name="rfc.section.6"></a><h3>6.&nbsp;
995    Description for control commands</h3>
996    
997  <p>This chapter will describe the available control commands  <p>This chapter will describe the available control commands
998              that can be sent on the TCP connection in detail. Some certain              that can be sent on the TCP connection in detail. Some certain
999              commands (e.g. <a class="info" href="#GET CHANNEL INFO">"GET CHANNEL INFO"<span> (</span><span class="info">Getting sampler channel information</span><span>)</span></a>              commands (e.g. <a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
1000              or <a class="info" href="#GET ENGINE INFO">"GET ENGINE INFO"<span> (</span><span class="info">Getting information about an engine</span><span>)</span></a>) lead to              or <a class='info' href='#GET ENGINE INFO'>"GET ENGINE INFO"<span> (</span><span class='info'>Getting information about an engine</span><span>)</span></a>) lead to
1001              multiple-line responses. In this case LinuxSampler signals the              multiple-line responses. In this case LinuxSampler signals the
1002              end of the response by a "." (single dot) line.              end of the response by a "." (single dot) line.
1003  </p>  </p>
1004  <a name="anchor8"></a><br /><hr />  <a name="anchor8"></a><br /><hr />
1005  <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>
1006  <a name="rfc.section.6.1"></a><h3>6.1.&nbsp;Ignored lines and comments</h3>  <a name="rfc.section.6.1"></a><h3>6.1.&nbsp;
1007    Ignored lines and comments</h3>
1008    
1009  <p>White lines, that is lines which only contain space and  <p>White lines, that is lines which only contain space and
1010                  tabulator characters, and lines that start with a "#"                  tabulator characters, and lines that start with a "#"
# Line 911  Intellectual Property and Copyright Stat Line 1013  Intellectual Property and Copyright Stat
1013                  file.                  file.
1014  </p>  </p>
1015  <a name="anchor9"></a><br /><hr />  <a name="anchor9"></a><br /><hr />
1016  <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>
1017  <a name="rfc.section.6.2"></a><h3>6.2.&nbsp;Configuring audio drivers</h3>  <a name="rfc.section.6.2"></a><h3>6.2.&nbsp;
1018    Configuring audio drivers</h3>
1019    
1020  <p>Instances of drivers in LinuxSampler are called devices.  <p>Instances of drivers in LinuxSampler are called devices.
1021                  You can use multiple audio devices simultaneously, e.g. to                  You can use multiple audio devices simultaneously, e.g. to
# Line 946  Intellectual Property and Copyright Stat Line 1049  Intellectual Property and Copyright Stat
1049                  possible values, etc.                  possible values, etc.
1050  </p>  </p>
1051  <a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />  <a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />
1052  <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>
1053  <a name="rfc.section.6.2.1"></a><h3>6.2.1.&nbsp;Getting amount of available audio output drivers</h3>  <a name="rfc.section.6.2.1"></a><h3>6.2.1.&nbsp;
1054    Getting amount of available audio output drivers</h3>
1055    
1056  <p>Use the following command to get the number of  <p>Use the following command to get the number of
1057                      audio output drivers currently available for the                      audio output drivers currently available for the
# Line 985  Intellectual Property and Copyright Stat Line 1089  Intellectual Property and Copyright Stat
1089                                            
1090  </p>  </p>
1091  <a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />  <a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />
1092  <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>
1093  <a name="rfc.section.6.2.2"></a><h3>6.2.2.&nbsp;Getting all available audio output drivers</h3>  <a name="rfc.section.6.2.2"></a><h3>6.2.2.&nbsp;
1094    Getting all available audio output drivers</h3>
1095    
1096  <p>Use the following command to list all audio output  <p>Use the following command to list all audio output
1097                      drivers currently available for the LinuxSampler                      drivers currently available for the LinuxSampler
# Line 1025  Intellectual Property and Copyright Stat Line 1130  Intellectual Property and Copyright Stat
1130                                            
1131  </p>  </p>
1132  <a name="GET AUDIO_OUTPUT_DRIVER INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DRIVER INFO"></a><br /><hr />
1133  <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>
1134  <a name="rfc.section.6.2.3"></a><h3>6.2.3.&nbsp;Getting information about a specific audio  <a name="rfc.section.6.2.3"></a><h3>6.2.3.&nbsp;
1135    Getting information about a specific audio
1136                  output driver</h3>                  output driver</h3>
1137    
1138  <p>Use the following command to get detailed information  <p>Use the following command to get detailed information
# Line 1043  Intellectual Property and Copyright Stat Line 1149  Intellectual Property and Copyright Stat
1149  </p>  </p>
1150  <p>Where &lt;audio-output-driver&gt; is the name of the  <p>Where &lt;audio-output-driver&gt; is the name of the
1151                      audio output driver, returned by the                      audio output driver, returned by the
1152                      <a class="info" href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class="info">Getting all available audio output drivers</span><span>)</span></a> command.                      <a class='info' href='#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS'>"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class='info'>Getting all available audio output drivers</span><span>)</span></a> command.
1153  </p>  </p>
1154  <p>Possible Answers:  <p>Possible Answers:
1155  </p>  </p>
# Line 1124  Intellectual Property and Copyright Stat Line 1230  Intellectual Property and Copyright Stat
1230                                            
1231  </p>  </p>
1232  <a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"></a><br /><hr />
1233  <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>
1234  <a name="rfc.section.6.2.4"></a><h3>6.2.4.&nbsp;Getting information about specific audio  <a name="rfc.section.6.2.4"></a><h3>6.2.4.&nbsp;
1235    Getting information about specific audio
1236                  output driver parameter</h3>                  output driver parameter</h3>
1237    
1238  <p>Use the following command to get detailed information  <p>Use the following command to get detailed information
# Line 1140  Intellectual Property and Copyright Stat Line 1247  Intellectual Property and Copyright Stat
1247                                            
1248  </p>  </p>
1249  <p>Where &lt;audio&gt; is the name of the audio output  <p>Where &lt;audio&gt; is the name of the audio output
1250                      driver as returned by the <a class="info" href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class="info">Getting all available audio output drivers</span><span>)</span></a> command,                      driver as returned by the <a class='info' href='#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS'>"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class='info'>Getting all available audio output drivers</span><span>)</span></a> command,
1251                      &lt;prm&gt; a specific parameter name for which information should be                      &lt;prm&gt; a specific parameter name for which information should be
1252                      obtained (as returned by the                      obtained (as returned by the
1253                      <a class="info" href="#GET AUDIO_OUTPUT_DRIVER INFO">"GET AUDIO_OUTPUT_DRIVER INFO"<span> (</span><span class="info">Getting information about a specific audio                 output driver</span><span>)</span></a> command) and                      <a class='info' href='#GET AUDIO_OUTPUT_DRIVER INFO'>"GET AUDIO_OUTPUT_DRIVER INFO"<span> (</span><span class='info'>Getting information about a specific audio                 output driver</span><span>)</span></a> command) and
1254                      &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
1255                      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
1256                      pairs in form of "key1=val1 key2=val2 ...", where character string values                      pairs in form of "key1=val1 key2=val2 ...", where character string values
# Line 1200  Intellectual Property and Copyright Stat Line 1307  Intellectual Property and Copyright Stat
1307  <blockquote class="text">  <blockquote class="text">
1308  <p>either true or false, defines if this parameter must be  <p>either true or false, defines if this parameter must be
1309                                  given when the device is to be created with the                                  given when the device is to be created with the
1310                                  <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a>                                  <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>'CREATE AUDIO_OUTPUT_DEVICE'<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
1311                                  command (always returned, no matter which driver parameter)                                  command (always returned, no matter which driver parameter)
1312  </p>  </p>
1313  </blockquote>  </blockquote>
# Line 1211  Intellectual Property and Copyright Stat Line 1318  Intellectual Property and Copyright Stat
1318  <blockquote class="text">  <blockquote class="text">
1319  <p>either true or false, if false then this parameter can  <p>either true or false, if false then this parameter can
1320                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
1321                                  the <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a>                                  the <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>'CREATE AUDIO_OUTPUT_DEVICE'<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
1322                                  command (always returned, no matter which driver parameter)                                  command (always returned, no matter which driver parameter)
1323  </p>  </p>
1324  </blockquote>  </blockquote>
# Line 1250  Intellectual Property and Copyright Stat Line 1357  Intellectual Property and Copyright Stat
1357  <blockquote class="text">  <blockquote class="text">
1358  <p>reflects the default value for this parameter which is  <p>reflects the default value for this parameter which is
1359                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
1360                                  given with the <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a> command,                                  given with the <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>'CREATE AUDIO_OUTPUT_DEVICE'<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a> command,
1361                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
1362                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
1363                                  apostrophes (')                                  apostrophes (')
# Line 1378  Intellectual Property and Copyright Stat Line 1485  Intellectual Property and Copyright Stat
1485                                            
1486  </p>  </p>
1487  <a name="CREATE AUDIO_OUTPUT_DEVICE"></a><br /><hr />  <a name="CREATE AUDIO_OUTPUT_DEVICE"></a><br /><hr />
1488  <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>
1489  <a name="rfc.section.6.2.5"></a><h3>6.2.5.&nbsp;Creating an audio output device</h3>  <a name="rfc.section.6.2.5"></a><h3>6.2.5.&nbsp;
1490    Creating an audio output device</h3>
1491    
1492  <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:
1493  </p>  </p>
# Line 1393  Intellectual Property and Copyright Stat Line 1501  Intellectual Property and Copyright Stat
1501  </p>  </p>
1502  <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
1503                      output system as returned by the                      output system as returned by the
1504                      <a class="info" href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class="info">Getting all available audio output drivers</span><span>)</span></a>                      <a class='info' href='#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS'>"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class='info'>Getting all available audio output drivers</span><span>)</span></a>
1505                      command and &lt;param-list&gt; by an optional list of driver                      command and &lt;param-list&gt; by an optional list of driver
1506                      specific parameters in form of "key1=val1 key2=val2 ...", where                      specific parameters in form of "key1=val1 key2=val2 ...", where
1507                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
# Line 1462  Intellectual Property and Copyright Stat Line 1570  Intellectual Property and Copyright Stat
1570                                            
1571  </p>  </p>
1572  <a name="DESTROY AUDIO_OUTPUT_DEVICE"></a><br /><hr />  <a name="DESTROY AUDIO_OUTPUT_DEVICE"></a><br /><hr />
1573  <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>
1574  <a name="rfc.section.6.2.6"></a><h3>6.2.6.&nbsp;Destroying an audio output device</h3>  <a name="rfc.section.6.2.6"></a><h3>6.2.6.&nbsp;
1575    Destroying an audio output device</h3>
1576    
1577  <p>Use the following command to destroy a created output device:  <p>Use the following command to destroy a created output device:
1578  </p>  </p>
# Line 1477  Intellectual Property and Copyright Stat Line 1586  Intellectual Property and Copyright Stat
1586  </p>  </p>
1587  <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
1588                      audio output device as given by the                      audio output device as given by the
1589                      <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a>                      <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
1590                      or <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class="info">Getting all created audio output device list</span><span>)</span></a>                      or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
1591                      command.                      command.
1592  </p>  </p>
1593  <p>Possible Answers:  <p>Possible Answers:
# Line 1531  Intellectual Property and Copyright Stat Line 1640  Intellectual Property and Copyright Stat
1640                                            
1641  </p>  </p>
1642  <a name="GET AUDIO_OUTPUT_DEVICES"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DEVICES"></a><br /><hr />
1643  <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>
1644  <a name="rfc.section.6.2.7"></a><h3>6.2.7.&nbsp;Getting all created audio output device count</h3>  <a name="rfc.section.6.2.7"></a><h3>6.2.7.&nbsp;
1645    Getting all created audio output device count</h3>
1646    
1647  <p>Use the following command to count all created audio output devices:  <p>Use the following command to count all created audio output devices:
1648  </p>  </p>
# Line 1568  Intellectual Property and Copyright Stat Line 1678  Intellectual Property and Copyright Stat
1678                                            
1679  </p>  </p>
1680  <a name="LIST AUDIO_OUTPUT_DEVICES"></a><br /><hr />  <a name="LIST AUDIO_OUTPUT_DEVICES"></a><br /><hr />
1681  <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>
1682  <a name="rfc.section.6.2.8"></a><h3>6.2.8.&nbsp;Getting all created audio output device list</h3>  <a name="rfc.section.6.2.8"></a><h3>6.2.8.&nbsp;
1683    Getting all created audio output device list</h3>
1684    
1685  <p>Use the following command to list all created audio output devices:  <p>Use the following command to list all created audio output devices:
1686  </p>  </p>
# Line 1605  Intellectual Property and Copyright Stat Line 1716  Intellectual Property and Copyright Stat
1716                                            
1717  </p>  </p>
1718  <a name="GET AUDIO_OUTPUT_DEVICE INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DEVICE INFO"></a><br /><hr />
1719  <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>
1720  <a name="rfc.section.6.2.9"></a><h3>6.2.9.&nbsp;Getting current settings of an audio output device</h3>  <a name="rfc.section.6.2.9"></a><h3>6.2.9.&nbsp;
1721    Getting current settings of an audio output device</h3>
1722    
1723  <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:
1724  </p>  </p>
# Line 1620  Intellectual Property and Copyright Stat Line 1732  Intellectual Property and Copyright Stat
1732  </p>  </p>
1733  <p>Where &lt;device-id&gt; should be replaced by numerical ID  <p>Where &lt;device-id&gt; should be replaced by numerical ID
1734                      of the audio output device as e.g. returned by the                      of the audio output device as e.g. returned by the
1735                      <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class="info">Getting all created audio output device list</span><span>)</span></a> command.                      <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a> command.
1736  </p>  </p>
1737  <p>Possible Answers:  <p>Possible Answers:
1738  </p>  </p>
# Line 1640  Intellectual Property and Copyright Stat Line 1752  Intellectual Property and Copyright Stat
1752  <blockquote class="text">  <blockquote class="text">
1753  <p>identifier of the used audio output driver, as also  <p>identifier of the used audio output driver, as also
1754                                      returned by the                                      returned by the
1755                                      <a class="info" href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class="info">Getting all available audio output drivers</span><span>)</span></a>                                      <a class='info' href='#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS'>"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class='info'>Getting all available audio output drivers</span><span>)</span></a>
1756                                      command                                      command
1757  </p>  </p>
1758  </blockquote>  </blockquote>
# Line 1681  Intellectual Property and Copyright Stat Line 1793  Intellectual Property and Copyright Stat
1793                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
1794                      returned by all audio output devices. Every audio output driver                      returned by all audio output devices. Every audio output driver
1795                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
1796                      <a class="info" href="#GET AUDIO_OUTPUT_DRIVER INFO">Section&nbsp;6.2.3<span> (</span><span class="info">Getting information about a specific audio                 output driver</span><span>)</span></a>)                      <a class='info' href='#GET AUDIO_OUTPUT_DRIVER INFO'>Section&nbsp;6.2.3<span> (</span><span class='info'>Getting information about a specific audio                 output driver</span><span>)</span></a>)
1797                      which are also returned by this command.                      which are also returned by this command.
1798  </p>  </p>
1799  <p>Example:  <p>Example:
# Line 1711  Intellectual Property and Copyright Stat Line 1823  Intellectual Property and Copyright Stat
1823                                            
1824  </p>  </p>
1825  <a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER"></a><br /><hr />  <a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER"></a><br /><hr />
1826  <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>
1827  <a name="rfc.section.6.2.10"></a><h3>6.2.10.&nbsp;Changing settings of audio output devices</h3>  <a name="rfc.section.6.2.10"></a><h3>6.2.10.&nbsp;
1828    Changing settings of audio output devices</h3>
1829    
1830  <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:
1831  </p>  </p>
# Line 1726  Intellectual Property and Copyright Stat Line 1839  Intellectual Property and Copyright Stat
1839  </p>  </p>
1840  <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
1841                      audio output device as given by the                      audio output device as given by the
1842                      <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a>                      <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
1843                      or <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class="info">Getting all created audio output device list</span><span>)</span></a>                      or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
1844                      command, &lt;key&gt; by the name of the parameter to change                      command, &lt;key&gt; by the name of the parameter to change
1845                      and &lt;value&gt; by the new value for this parameter.                      and &lt;value&gt; by the new value for this parameter.
1846  </p>  </p>
# Line 1779  Intellectual Property and Copyright Stat Line 1892  Intellectual Property and Copyright Stat
1892                                            
1893  </p>  </p>
1894  <a name="GET AUDIO_OUTPUT_CHANNEL INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_CHANNEL INFO"></a><br /><hr />
1895  <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>
1896  <a name="rfc.section.6.2.11"></a><h3>6.2.11.&nbsp;Getting information about an audio channel</h3>  <a name="rfc.section.6.2.11"></a><h3>6.2.11.&nbsp;
1897    Getting information about an audio channel</h3>
1898    
1899  <p>Use the following command to get information about an audio channel:  <p>Use the following command to get information about an audio channel:
1900  </p>  </p>
# Line 1793  Intellectual Property and Copyright Stat Line 1907  Intellectual Property and Copyright Stat
1907                                            
1908  </p>  </p>
1909  <p>Where &lt;device-id&gt; is the numerical ID of the audio output device as given by the  <p>Where &lt;device-id&gt; is the numerical ID of the audio output device as given by the
1910                      <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a>                      <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
1911                      or <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class="info">Getting all created audio output device list</span><span>)</span></a>                      or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
1912                      command and &lt;audio-chan&gt; the audio channel number.                      command and &lt;audio-chan&gt; the audio channel number.
1913  </p>  </p>
1914  <p>Possible Answers:  <p>Possible Answers:
# Line 1921  Intellectual Property and Copyright Stat Line 2035  Intellectual Property and Copyright Stat
2035                                            
2036  </p>  </p>
2037  <a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"></a><br /><hr />
2038  <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>
2039  <a name="rfc.section.6.2.12"></a><h3>6.2.12.&nbsp;Getting information about specific audio channel parameter</h3>  <a name="rfc.section.6.2.12"></a><h3>6.2.12.&nbsp;
2040    Getting information about specific audio channel parameter</h3>
2041    
2042  <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:
2043  </p>  </p>
# Line 1935  Intellectual Property and Copyright Stat Line 2050  Intellectual Property and Copyright Stat
2050                                            
2051  </p>  </p>
2052  <p>Where &lt;dev-id&gt; is the numerical ID of the audio output device as returned by the  <p>Where &lt;dev-id&gt; is the numerical ID of the audio output device as returned by the
2053                      <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a>                      <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
2054                      or <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class="info">Getting all created audio output device list</span><span>)</span></a>                      or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
2055                      command, &lt;chan&gt; the audio channel number                      command, &lt;chan&gt; the audio channel number
2056                      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
2057                      be obtained (as returned by the <a class="info" href="#GET AUDIO_OUTPUT_CHANNEL INFO">"GET AUDIO_OUTPUT_CHANNEL INFO"<span> (</span><span class="info">Getting information about an audio channel</span><span>)</span></a> command).                      be obtained (as returned by the <a class='info' href='#GET AUDIO_OUTPUT_CHANNEL INFO'>"GET AUDIO_OUTPUT_CHANNEL INFO"<span> (</span><span class='info'>Getting information about an audio channel</span><span>)</span></a> command).
2058  </p>  </p>
2059  <p>Possible Answers:  <p>Possible Answers:
2060  </p>  </p>
# Line 2067  Intellectual Property and Copyright Stat Line 2182  Intellectual Property and Copyright Stat
2182                                            
2183  </p>  </p>
2184  <a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"></a><br /><hr />  <a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"></a><br /><hr />
2185  <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>
2186  <a name="rfc.section.6.2.13"></a><h3>6.2.13.&nbsp;Changing settings of audio output channels</h3>  <a name="rfc.section.6.2.13"></a><h3>6.2.13.&nbsp;
2187    Changing settings of audio output channels</h3>
2188    
2189  <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:
2190  </p>  </p>
# Line 2081  Intellectual Property and Copyright Stat Line 2197  Intellectual Property and Copyright Stat
2197                                            
2198  </p>  </p>
2199  <p>Where &lt;dev-id&gt; should be replaced by the numerical ID of the audio output device as returned by the  <p>Where &lt;dev-id&gt; should be replaced by the numerical ID of the audio output device as returned by the
2200                      <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a>                      <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
2201                      or <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class="info">Getting all created audio output device list</span><span>)</span></a>                      or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
2202                      command, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the                      command, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the
2203                      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.
2204  </p>  </p>
# Line 2144  Intellectual Property and Copyright Stat Line 2260  Intellectual Property and Copyright Stat
2260                                            
2261  </p>  </p>
2262  <a name="anchor10"></a><br /><hr />  <a name="anchor10"></a><br /><hr />
2263  <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>
2264  <a name="rfc.section.6.3"></a><h3>6.3.&nbsp;Configuring MIDI input drivers</h3>  <a name="rfc.section.6.3"></a><h3>6.3.&nbsp;
2265    Configuring MIDI input drivers</h3>
2266    
2267  <p>Instances of drivers in LinuxSampler are called devices. You can use  <p>Instances of drivers in LinuxSampler are called devices. You can use
2268                  multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as                  multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as
# Line 2174  Intellectual Property and Copyright Stat Line 2291  Intellectual Property and Copyright Stat
2291                  possible values, etc.                  possible values, etc.
2292  </p>  </p>
2293  <a name="GET AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />  <a name="GET AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />
2294  <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>
2295  <a name="rfc.section.6.3.1"></a><h3>6.3.1.&nbsp;Getting amount of available MIDI input drivers</h3>  <a name="rfc.section.6.3.1"></a><h3>6.3.1.&nbsp;
2296    Getting amount of available MIDI input drivers</h3>
2297    
2298  <p>Use the following command to get the number of  <p>Use the following command to get the number of
2299                      MIDI input drivers currently available for the                      MIDI input drivers currently available for the
# Line 2213  Intellectual Property and Copyright Stat Line 2331  Intellectual Property and Copyright Stat
2331                                            
2332  </p>  </p>
2333  <a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />  <a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />
2334  <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>
2335  <a name="rfc.section.6.3.2"></a><h3>6.3.2.&nbsp;Getting all available MIDI input drivers</h3>  <a name="rfc.section.6.3.2"></a><h3>6.3.2.&nbsp;
2336    Getting all available MIDI input drivers</h3>
2337    
2338  <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
2339                      for the LinuxSampler instance:                      for the LinuxSampler instance:
# Line 2251  Intellectual Property and Copyright Stat Line 2370  Intellectual Property and Copyright Stat
2370                                            
2371  </p>  </p>
2372  <a name="GET MIDI_INPUT_DRIVER INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_DRIVER INFO"></a><br /><hr />
2373  <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>
2374  <a name="rfc.section.6.3.3"></a><h3>6.3.3.&nbsp;Getting information about a specific MIDI input driver</h3>  <a name="rfc.section.6.3.3"></a><h3>6.3.3.&nbsp;
2375    Getting information about a specific MIDI input driver</h3>
2376    
2377  <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:
2378  </p>  </p>
# Line 2265  Intellectual Property and Copyright Stat Line 2385  Intellectual Property and Copyright Stat
2385                                            
2386  </p>  </p>
2387  <p>Where &lt;midi-input-driver&gt; is the name of the MIDI input driver as returned  <p>Where &lt;midi-input-driver&gt; is the name of the MIDI input driver as returned
2388                      by the <a class="info" href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class="info">Getting all available MIDI input drivers</span><span>)</span></a> command.                      by the <a class='info' href='#LIST AVAILABLE_MIDI_INPUT_DRIVERS'>"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class='info'>Getting all available MIDI input drivers</span><span>)</span></a> command.
2389  </p>  </p>
2390  <p>Possible Answers:  <p>Possible Answers:
2391  </p>  </p>
# Line 2332  Intellectual Property and Copyright Stat Line 2452  Intellectual Property and Copyright Stat
2452                                            
2453  </p>  </p>
2454  <a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO"></a><br /><hr />
2455  <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>
2456  <a name="rfc.section.6.3.4"></a><h3>6.3.4.&nbsp;Getting information about specific MIDI input driver parameter</h3>  <a name="rfc.section.6.3.4"></a><h3>6.3.4.&nbsp;
2457    Getting information about specific MIDI input driver parameter</h3>
2458    
2459  <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:
2460  </p>  </p>
# Line 2346  Intellectual Property and Copyright Stat Line 2467  Intellectual Property and Copyright Stat
2467                                            
2468  </p>  </p>
2469  <p>Where &lt;midit&gt; is the name of the MIDI input driver as returned  <p>Where &lt;midit&gt; is the name of the MIDI input driver as returned
2470                      by the <a class="info" href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class="info">Getting all available MIDI input drivers</span><span>)</span></a> command, &lt;param&gt; a specific                      by the <a class='info' href='#LIST AVAILABLE_MIDI_INPUT_DRIVERS'>"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class='info'>Getting all available MIDI input drivers</span><span>)</span></a> command, &lt;param&gt; a specific
2471                      parameter name for which information should be obtained (as returned by the                      parameter name for which information should be obtained (as returned by the
2472                      <a class="info" href="#GET MIDI_INPUT_DRIVER INFO">"GET MIDI_INPUT_DRIVER INFO"<span> (</span><span class="info">Getting information about a specific MIDI input driver</span><span>)</span></a> command) and &lt;deplist&gt; is an optional list                      <a class='info' href='#GET MIDI_INPUT_DRIVER INFO'>"GET MIDI_INPUT_DRIVER INFO"<span> (</span><span class='info'>Getting information about a specific MIDI input driver</span><span>)</span></a> command) and &lt;deplist&gt; is an optional list
2473                      of parameters on which the sought parameter &lt;param&gt; depends on,                      of parameters on which the sought parameter &lt;param&gt; depends on,
2474                      &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 ...",
2475                      where character string values are encapsulated into apostrophes ('). Arguments                      where character string values are encapsulated into apostrophes ('). Arguments
# Line 2395  Intellectual Property and Copyright Stat Line 2516  Intellectual Property and Copyright Stat
2516  <blockquote class="text">  <blockquote class="text">
2517  <p>either true or false, defines if this parameter must be  <p>either true or false, defines if this parameter must be
2518                                  given when the device is to be created with the                                  given when the device is to be created with the
2519                                  <a class="info" href="#CREATE MIDI_INPUT_DEVICE">'CREATE MIDI_INPUT_DEVICE'<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a> command                                  <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>'CREATE MIDI_INPUT_DEVICE'<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a> command
2520                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2521  </p>  </p>
2522  </blockquote>  </blockquote>
# Line 2406  Intellectual Property and Copyright Stat Line 2527  Intellectual Property and Copyright Stat
2527  <blockquote class="text">  <blockquote class="text">
2528  <p>either true or false, if false then this parameter can  <p>either true or false, if false then this parameter can
2529                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
2530                                  the <a class="info" href="#CREATE MIDI_INPUT_DEVICE">'CREATE MIDI_INPUT_DEVICE'<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a> command                                  the <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>'CREATE MIDI_INPUT_DEVICE'<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a> command
2531                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2532  </p>  </p>
2533  </blockquote>  </blockquote>
# Line 2445  Intellectual Property and Copyright Stat Line 2566  Intellectual Property and Copyright Stat
2566  <blockquote class="text">  <blockquote class="text">
2567  <p>reflects the default value for this parameter which is  <p>reflects the default value for this parameter which is
2568                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
2569                                  given with the <a class="info" href="#CREATE MIDI_INPUT_DEVICE">'CREATE MIDI_INPUT_DEVICE'<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a> command,                                  given with the <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>'CREATE MIDI_INPUT_DEVICE'<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a> command,
2570                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
2571                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
2572                                  apostrophes (')                                  apostrophes (')
# Line 2519  Intellectual Property and Copyright Stat Line 2640  Intellectual Property and Copyright Stat
2640                                            
2641  </p>  </p>
2642  <a name="CREATE MIDI_INPUT_DEVICE"></a><br /><hr />  <a name="CREATE MIDI_INPUT_DEVICE"></a><br /><hr />
2643  <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>
2644  <a name="rfc.section.6.3.5"></a><h3>6.3.5.&nbsp;Creating a MIDI input device</h3>  <a name="rfc.section.6.3.5"></a><h3>6.3.5.&nbsp;
2645    Creating a MIDI input device</h3>
2646    
2647  <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:
2648  </p>  </p>
# Line 2533  Intellectual Property and Copyright Stat Line 2655  Intellectual Property and Copyright Stat
2655                                            
2656  </p>  </p>
2657  <p>Where &lt;midi-input-driver&gt; should be replaced by the desired MIDI input system as returned  <p>Where &lt;midi-input-driver&gt; should be replaced by the desired MIDI input system as returned
2658                      by the <a class="info" href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class="info">Getting all available MIDI input drivers</span><span>)</span></a> command and &lt;param-list&gt; by an                      by the <a class='info' href='#LIST AVAILABLE_MIDI_INPUT_DRIVERS'>"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class='info'>Getting all available MIDI input drivers</span><span>)</span></a> command and &lt;param-list&gt; by an
2659                      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
2660                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
2661                      Note that there might be drivers which require parameter(s) to be                      Note that there might be drivers which require parameter(s) to be
# Line 2589  Intellectual Property and Copyright Stat Line 2711  Intellectual Property and Copyright Stat
2711                                            
2712  </p>  </p>
2713  <a name="DESTROY MIDI_INPUT_DEVICE"></a><br /><hr />  <a name="DESTROY MIDI_INPUT_DEVICE"></a><br /><hr />
2714  <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>
2715  <a name="rfc.section.6.3.6"></a><h3>6.3.6.&nbsp;Destroying a MIDI input device</h3>  <a name="rfc.section.6.3.6"></a><h3>6.3.6.&nbsp;
2716    Destroying a MIDI input device</h3>
2717    
2718  <p>Use the following command to destroy a created MIDI input device:  <p>Use the following command to destroy a created MIDI input device:
2719  </p>  </p>
# Line 2603  Intellectual Property and Copyright Stat Line 2726  Intellectual Property and Copyright Stat
2726                                            
2727  </p>  </p>
2728  <p>Where &lt;device-id&gt; should be replaced by the device's numerical ID as returned by the  <p>Where &lt;device-id&gt; should be replaced by the device's numerical ID as returned by the
2729                      <a class="info" href="#CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a>                      <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
2730                      or <a class="info" href="#LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"<span> (</span><span class="info">Getting all created MIDI input device list</span><span>)</span></a>                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
2731                      command.                      command.
2732  </p>  </p>
2733  <p>Possible Answers:  <p>Possible Answers:
# Line 2654  Intellectual Property and Copyright Stat Line 2777  Intellectual Property and Copyright Stat
2777                                            
2778  </p>  </p>
2779  <a name="GET MIDI_INPUT_DEVICES"></a><br /><hr />  <a name="GET MIDI_INPUT_DEVICES"></a><br /><hr />
2780  <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>
2781  <a name="rfc.section.6.3.7"></a><h3>6.3.7.&nbsp;Getting all created MIDI input device count</h3>  <a name="rfc.section.6.3.7"></a><h3>6.3.7.&nbsp;
2782    Getting all created MIDI input device count</h3>
2783    
2784  <p>Use the following command to count all created MIDI input devices:  <p>Use the following command to count all created MIDI input devices:
2785  </p>  </p>
# Line 2691  Intellectual Property and Copyright Stat Line 2815  Intellectual Property and Copyright Stat
2815                                            
2816  </p>  </p>
2817  <a name="LIST MIDI_INPUT_DEVICES"></a><br /><hr />  <a name="LIST MIDI_INPUT_DEVICES"></a><br /><hr />
2818  <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>
2819  <a name="rfc.section.6.3.8"></a><h3>6.3.8.&nbsp;Getting all created MIDI input device list</h3>  <a name="rfc.section.6.3.8"></a><h3>6.3.8.&nbsp;
2820    Getting all created MIDI input device list</h3>
2821    
2822  <p>Use the following command to list all created MIDI input devices:  <p>Use the following command to list all created MIDI input devices:
2823  </p>  </p>
# Line 2738  Intellectual Property and Copyright Stat Line 2863  Intellectual Property and Copyright Stat
2863                                            
2864  </p>  </p>
2865  <a name="GET MIDI_INPUT_DEVICE INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_DEVICE INFO"></a><br /><hr />
2866  <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>
2867  <a name="rfc.section.6.3.9"></a><h3>6.3.9.&nbsp;Getting current settings of a MIDI input device</h3>  <a name="rfc.section.6.3.9"></a><h3>6.3.9.&nbsp;
2868    Getting current settings of a MIDI input device</h3>
2869    
2870  <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:
2871  </p>  </p>
# Line 2752  Intellectual Property and Copyright Stat Line 2878  Intellectual Property and Copyright Stat
2878                                            
2879  </p>  </p>
2880  <p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the  <p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
2881                      <a class="info" href="#CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a>                      <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
2882                      or <a class="info" href="#LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"<span> (</span><span class="info">Getting all created MIDI input device list</span><span>)</span></a>                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
2883                      command.                      command.
2884  </p>  </p>
2885  <p>Possible Answers:  <p>Possible Answers:
# Line 2776  Intellectual Property and Copyright Stat Line 2902  Intellectual Property and Copyright Stat
2902                                          </p>                                          </p>
2903  <blockquote class="text">  <blockquote class="text">
2904  <p>identifier of the used MIDI input driver, as e.g.  <p>identifier of the used MIDI input driver, as e.g.
2905                                              returned by the <a class="info" href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class="info">Getting all available MIDI input drivers</span><span>)</span></a>                                              returned by the <a class='info' href='#LIST AVAILABLE_MIDI_INPUT_DRIVERS'>"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class='info'>Getting all available MIDI input drivers</span><span>)</span></a>
2906                                              command                                              command
2907  </p>  </p>
2908  </blockquote>  </blockquote>
# Line 2806  Intellectual Property and Copyright Stat Line 2932  Intellectual Property and Copyright Stat
2932                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
2933                      returned by all MIDI input devices. Every MIDI input driver                      returned by all MIDI input devices. Every MIDI input driver
2934                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
2935                      <a class="info" href="#GET MIDI_INPUT_DRIVER INFO">"GET MIDI_INPUT_DRIVER INFO"<span> (</span><span class="info">Getting information about a specific MIDI input driver</span><span>)</span></a> command) which are also returned                      <a class='info' href='#GET MIDI_INPUT_DRIVER INFO'>"GET MIDI_INPUT_DRIVER INFO"<span> (</span><span class='info'>Getting information about a specific MIDI input driver</span><span>)</span></a> command) which are also returned
2936                      by this command.                      by this command.
2937  </p>  </p>
2938  <p>Example:  <p>Example:
# Line 2826  Intellectual Property and Copyright Stat Line 2952  Intellectual Property and Copyright Stat
2952                                            
2953  </p>  </p>
2954  <a name="SET MIDI_INPUT_DEVICE_PARAMETER"></a><br /><hr />  <a name="SET MIDI_INPUT_DEVICE_PARAMETER"></a><br /><hr />
2955  <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>
2956  <a name="rfc.section.6.3.10"></a><h3>6.3.10.&nbsp;Changing settings of MIDI input devices</h3>  <a name="rfc.section.6.3.10"></a><h3>6.3.10.&nbsp;
2957    Changing settings of MIDI input devices</h3>
2958    
2959  <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:
2960  </p>  </p>
# Line 2841  Intellectual Property and Copyright Stat Line 2968  Intellectual Property and Copyright Stat
2968  </p>  </p>
2969  <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
2970                      MIDI input device as returned by the                      MIDI input device as returned by the
2971                      <a class="info" href="#CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a>                      <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
2972                      or <a class="info" href="#LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"<span> (</span><span class="info">Getting all created MIDI input device list</span><span>)</span></a>                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
2973                      command, &lt;key&gt; by the name of the parameter to change and                      command, &lt;key&gt; by the name of the parameter to change and
2974                      &lt;value&gt; by the new value for this parameter.                      &lt;value&gt; by the new value for this parameter.
2975  </p>  </p>
# Line 2893  Intellectual Property and Copyright Stat Line 3020  Intellectual Property and Copyright Stat
3020                                            
3021  </p>  </p>
3022  <a name="GET MIDI_INPUT_PORT INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_PORT INFO"></a><br /><hr />
3023  <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>
3024  <a name="rfc.section.6.3.11"></a><h3>6.3.11.&nbsp;Getting information about a MIDI port</h3>  <a name="rfc.section.6.3.11"></a><h3>6.3.11.&nbsp;
3025    Getting information about a MIDI port</h3>
3026    
3027  <p>Use the following command to get information about a MIDI port:  <p>Use the following command to get information about a MIDI port:
3028  </p>  </p>
# Line 2907  Intellectual Property and Copyright Stat Line 3035  Intellectual Property and Copyright Stat
3035                                            
3036  </p>  </p>
3037  <p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the  <p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
3038                      <a class="info" href="#CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a>                      <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
3039                      or <a class="info" href="#LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"<span> (</span><span class="info">Getting all created MIDI input device list</span><span>)</span></a>                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
3040                      command and &lt;midi-port&gt; the MIDI input port number.                      command and &lt;midi-port&gt; the MIDI input port number.
3041  </p>  </p>
3042  <p>Possible Answers:  <p>Possible Answers:
# Line 2955  Intellectual Property and Copyright Stat Line 3083  Intellectual Property and Copyright Stat
3083                                            
3084  </p>  </p>
3085  <a name="GET MIDI_INPUT_PORT_PARAMETER INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_PORT_PARAMETER INFO"></a><br /><hr />
3086  <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>
3087  <a name="rfc.section.6.3.12"></a><h3>6.3.12.&nbsp;Getting information about specific MIDI port parameter</h3>  <a name="rfc.section.6.3.12"></a><h3>6.3.12.&nbsp;
3088    Getting information about specific MIDI port parameter</h3>
3089    
3090  <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:
3091  </p>  </p>
# Line 2969  Intellectual Property and Copyright Stat Line 3098  Intellectual Property and Copyright Stat
3098                                            
3099  </p>  </p>
3100  <p>Where &lt;dev-id&gt; is the numerical ID of the MIDI input device as returned by the  <p>Where &lt;dev-id&gt; is the numerical ID of the MIDI input device as returned by the
3101                      <a class="info" href="#CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a>                      <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
3102                      or <a class="info" href="#LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"<span> (</span><span class="info">Getting all created MIDI input device list</span><span>)</span></a>                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
3103                      command, &lt;port&gt; the MIDI port number and                      command, &lt;port&gt; the MIDI port number and
3104                      &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
3105                      obtained (as returned by the <a class="info" href="#GET MIDI_INPUT_PORT INFO">"GET MIDI_INPUT_PORT INFO"<span> (</span><span class="info">Getting information about a MIDI port</span><span>)</span></a> command).                      obtained (as returned by the <a class='info' href='#GET MIDI_INPUT_PORT INFO'>"GET MIDI_INPUT_PORT INFO"<span> (</span><span class='info'>Getting information about a MIDI port</span><span>)</span></a> command).
3106  </p>  </p>
3107  <p>Possible Answers:  <p>Possible Answers:
3108  </p>  </p>
# Line 3096  Intellectual Property and Copyright Stat Line 3225  Intellectual Property and Copyright Stat
3225                                            
3226  </p>  </p>
3227  <a name="SET MIDI_INPUT_PORT_PARAMETER"></a><br /><hr />  <a name="SET MIDI_INPUT_PORT_PARAMETER"></a><br /><hr />
3228  <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>
3229  <a name="rfc.section.6.3.13"></a><h3>6.3.13.&nbsp;Changing settings of MIDI input ports</h3>  <a name="rfc.section.6.3.13"></a><h3>6.3.13.&nbsp;
3230    Changing settings of MIDI input ports</h3>
3231    
3232  <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:
3233  </p>  </p>
# Line 3111  Intellectual Property and Copyright Stat Line 3241  Intellectual Property and Copyright Stat
3241  </p>  </p>
3242  <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
3243                      MIDI device as returned by the                      MIDI device as returned by the
3244                      <a class="info" href="#CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a>                      <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
3245                      or <a class="info" href="#LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"<span> (</span><span class="info">Getting all created MIDI input device list</span><span>)</span></a>                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
3246                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
3247                      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
3248                      parameter.                      parameter.
# Line 3162  Intellectual Property and Copyright Stat Line 3292  Intellectual Property and Copyright Stat
3292                                            
3293  </p>  </p>
3294  <a name="anchor11"></a><br /><hr />  <a name="anchor11"></a><br /><hr />
3295  <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>
3296  <a name="rfc.section.6.4"></a><h3>6.4.&nbsp;Configuring sampler channels</h3>  <a name="rfc.section.6.4"></a><h3>6.4.&nbsp;
3297    Configuring sampler channels</h3>
3298    
3299  <p>The following commands describe how to add and remove sampler channels, associate a  <p>The following commands describe how to add and remove sampler channels, associate a
3300                  sampler channel with a sampler engine, load instruments and connect sampler channels to                  sampler channel with a sampler engine, load instruments and connect sampler channels to
3301                  MIDI and audio devices.                  MIDI and audio devices.
3302  </p>  </p>
3303  <a name="LOAD INSTRUMENT"></a><br /><hr />  <a name="LOAD INSTRUMENT"></a><br /><hr />
3304  <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>
3305  <a name="rfc.section.6.4.1"></a><h3>6.4.1.&nbsp;Loading an instrument</h3>  <a name="rfc.section.6.4.1"></a><h3>6.4.1.&nbsp;
3306    Loading an instrument</h3>
3307    
3308  <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:
3309  </p>  </p>
# Line 3193  Intellectual Property and Copyright Stat Line 3325  Intellectual Property and Copyright Stat
3325                      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
3326                      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
3327                      returns immediately and a background process is launched to load the instrument                      returns immediately and a background process is launched to load the instrument
3328                      on the channel. The <a class="info" href="#GET CHANNEL INFO">GET CHANNEL INFO<span> (</span><span class="info">Getting sampler channel information</span><span>)</span></a>                      on the channel. The <a class='info' href='#GET CHANNEL INFO'>GET CHANNEL INFO<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
3329                      command can be used to obtain loading                      command can be used to obtain loading
3330                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks
3331                      such as making sure that the file could be read and it is of a proper format                      such as making sure that the file could be read and it is of a proper format
# Line 3247  Intellectual Property and Copyright Stat Line 3379  Intellectual Property and Copyright Stat
3379                                            
3380  </p>  </p>
3381  <a name="LOAD ENGINE"></a><br /><hr />  <a name="LOAD ENGINE"></a><br /><hr />
3382  <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>
3383  <a name="rfc.section.6.4.2"></a><h3>6.4.2.&nbsp;Loading a sampler engine</h3>  <a name="rfc.section.6.4.2"></a><h3>6.4.2.&nbsp;
3384    Loading a sampler engine</h3>
3385    
3386  <p>A sampler engine type can be associated to a specific sampler  <p>A sampler engine type can be associated to a specific sampler
3387                      channel by the following command:                      channel by the following command:
# Line 3262  Intellectual Property and Copyright Stat Line 3395  Intellectual Property and Copyright Stat
3395                                            
3396  </p>  </p>
3397  <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
3398                      <a class="info" href="#LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"<span> (</span><span class="info">Getting all available engines</span><span>)</span></a> command and &lt;sampler-channel&gt;                      <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a> command and &lt;sampler-channel&gt;
3399                      the sampler channel as returned by the                      the sampler channel as returned by the
3400                      <a class="info" href="#ADD CHANNEL">"ADD CHANNEL"<span> (</span><span class="info">Adding a new sampler channel</span><span>)</span></a> or                      <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a> or
3401                      <a class="info" href="#LIST CHANNELS">"LIST CHANNELS"<span> (</span><span class="info">Getting all created sampler channel list</span><span>)</span></a> command where                      <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command where
3402                      the engine type should be assigned to. This command should be issued                      the engine type should be assigned to. This command should be issued
3403                      after adding a new sampler channel and before any other control                      after adding a new sampler channel and before any other control
3404                      commands on the new sampler channel. It can also be used to change                      commands on the new sampler channel. It can also be used to change
# Line 3321  Intellectual Property and Copyright Stat Line 3454  Intellectual Property and Copyright Stat
3454                                            
3455  </p>  </p>
3456  <a name="GET CHANNELS"></a><br /><hr />  <a name="GET CHANNELS"></a><br /><hr />
3457  <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>
3458  <a name="rfc.section.6.4.3"></a><h3>6.4.3.&nbsp;Getting all created sampler channel count</h3>  <a name="rfc.section.6.4.3"></a><h3>6.4.3.&nbsp;
3459    Getting all created sampler channel count</h3>
3460    
3461  <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
3462                      current amount of sampler channels, the front-end can send the                      current amount of sampler channels, the front-end can send the
# Line 3359  Intellectual Property and Copyright Stat Line 3493  Intellectual Property and Copyright Stat
3493                                            
3494  </p>  </p>
3495  <a name="LIST CHANNELS"></a><br /><hr />  <a name="LIST CHANNELS"></a><br /><hr />
3496  <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>
3497  <a name="rfc.section.6.4.4"></a><h3>6.4.4.&nbsp;Getting all created sampler channel list</h3>  <a name="rfc.section.6.4.4"></a><h3>6.4.4.&nbsp;
3498    Getting all created sampler channel list</h3>
3499    
3500  <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
3501                      current list of sampler channels, the front-end can send the                      current list of sampler channels, the front-end can send the
# Line 3398  Intellectual Property and Copyright Stat Line 3533  Intellectual Property and Copyright Stat
3533                                            
3534  </p>  </p>
3535  <a name="ADD CHANNEL"></a><br /><hr />  <a name="ADD CHANNEL"></a><br /><hr />
3536  <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>
3537  <a name="rfc.section.6.4.5"></a><h3>6.4.5.&nbsp;Adding a new sampler channel</h3>  <a name="rfc.section.6.4.5"></a><h3>6.4.5.&nbsp;
3538    Adding a new sampler channel</h3>
3539    
3540  <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
3541                      channel list by sending the following command:                      channel list by sending the following command:
# Line 3472  Intellectual Property and Copyright Stat Line 3608  Intellectual Property and Copyright Stat
3608                                            
3609  </p>  </p>
3610  <a name="REMOVE CHANNEL"></a><br /><hr />  <a name="REMOVE CHANNEL"></a><br /><hr />
3611  <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>
3612  <a name="rfc.section.6.4.6"></a><h3>6.4.6.&nbsp;Removing a sampler channel</h3>  <a name="rfc.section.6.4.6"></a><h3>6.4.6.&nbsp;
3613    Removing a sampler channel</h3>
3614    
3615  <p>A sampler channel can be removed by sending the following command:  <p>A sampler channel can be removed by sending the following command:
3616  </p>  </p>
# Line 3487  Intellectual Property and Copyright Stat Line 3624  Intellectual Property and Copyright Stat
3624  </p>  </p>
3625  <p>Where &lt;sampler-channel&gt; should be replaced by the  <p>Where &lt;sampler-channel&gt; should be replaced by the
3626                      number of the sampler channel as given by the                      number of the sampler channel as given by the
3627                      <a class="info" href="#ADD CHANNEL">"ADD CHANNEL"<span> (</span><span class="info">Adding a new sampler channel</span><span>)</span></a>                      <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
3628                      or <a class="info" href="#LIST CHANNELS">"LIST CHANNELS"<span> (</span><span class="info">Getting all created sampler channel list</span><span>)</span></a>                      or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a>
3629                      command. The channel numbers of all subsequent sampler channels                      command. The channel numbers of all subsequent sampler channels
3630                      remain the same.                      remain the same.
3631  </p>  </p>
# Line 3538  Intellectual Property and Copyright Stat Line 3675  Intellectual Property and Copyright Stat
3675                                            
3676  </p>  </p>
3677  <a name="GET AVAILABLE_ENGINES"></a><br /><hr />  <a name="GET AVAILABLE_ENGINES"></a><br /><hr />
3678  <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>
3679  <a name="rfc.section.6.4.7"></a><h3>6.4.7.&nbsp;Getting amount of available engines</h3>  <a name="rfc.section.6.4.7"></a><h3>6.4.7.&nbsp;
3680    Getting amount of available engines</h3>
3681    
3682  <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:
3683  </p>  </p>
# Line 3574  Intellectual Property and Copyright Stat Line 3712  Intellectual Property and Copyright Stat
3712                                            
3713  </p>  </p>
3714  <a name="LIST AVAILABLE_ENGINES"></a><br /><hr />  <a name="LIST AVAILABLE_ENGINES"></a><br /><hr />
3715  <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>
3716  <a name="rfc.section.6.4.8"></a><h3>6.4.8.&nbsp;Getting all available engines</h3>  <a name="rfc.section.6.4.8"></a><h3>6.4.8.&nbsp;
3717    Getting all available engines</h3>
3718    
3719  <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:
3720  </p>  </p>
# Line 3613  Intellectual Property and Copyright Stat Line 3752  Intellectual Property and Copyright Stat
3752                                            
3753  </p>  </p>
3754  <a name="GET ENGINE INFO"></a><br /><hr />  <a name="GET ENGINE INFO"></a><br /><hr />
3755  <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>
3756  <a name="rfc.section.6.4.9"></a><h3>6.4.9.&nbsp;Getting information about an engine</h3>  <a name="rfc.section.6.4.9"></a><h3>6.4.9.&nbsp;
3757    Getting information about an engine</h3>
3758    
3759  <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
3760                      sending the following command:                      sending the following command:
# Line 3628  Intellectual Property and Copyright Stat Line 3768  Intellectual Property and Copyright Stat
3768                                            
3769  </p>  </p>
3770  <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
3771                      <a class="info" href="#LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"<span> (</span><span class="info">Getting all available engines</span><span>)</span></a> command.                      <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a> command.
3772  </p>  </p>
3773  <p>Possible Answers:  <p>Possible Answers:
3774  </p>  </p>
# Line 3685  Intellectual Property and Copyright Stat Line 3825  Intellectual Property and Copyright Stat
3825                                            
3826  </p>  </p>
3827  <a name="GET CHANNEL INFO"></a><br /><hr />  <a name="GET CHANNEL INFO"></a><br /><hr />
3828  <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>
3829  <a name="rfc.section.6.4.10"></a><h3>6.4.10.&nbsp;Getting sampler channel information</h3>  <a name="rfc.section.6.4.10"></a><h3>6.4.10.&nbsp;
3830    Getting sampler channel information</h3>
3831    
3832  <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
3833                      by sending the following command:                      by sending the following command:
# Line 3700  Intellectual Property and Copyright Stat Line 3841  Intellectual Property and Copyright Stat
3841                                            
3842  </p>  </p>
3843  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
3844                      as returned by the <a class="info" href="#ADD CHANNEL">"ADD CHANNEL"<span> (</span><span class="info">Adding a new sampler channel</span><span>)</span></a>                      as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
3845                      or <a class="info" href="#LIST CHANNELS">"LIST CHANNELS"<span> (</span><span class="info">Getting all created sampler channel list</span><span>)</span></a> command.                      or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command.
3846  </p>  </p>
3847  <p>Possible Answers:  <p>Possible Answers:
3848  </p>  </p>
# Line 3829  Intellectual Property and Copyright Stat Line 3970  Intellectual Property and Copyright Stat
3970                                          </p>                                          </p>
3971  <blockquote class="text">  <blockquote class="text">
3972  <p>optionally dotted number for the channel volume factor  <p>optionally dotted number for the channel volume factor
3973                                              (where a value < 1.0 means attenuation and a value >                                              (where a value &lt; 1.0 means attenuation and a value >
3974                                              1.0 means amplification)                                              1.0 means amplification)
3975  </p>  </p>
3976  </blockquote>  </blockquote>
# Line 3856  Intellectual Property and Copyright Stat Line 3997  Intellectual Property and Copyright Stat
3997  </blockquote>  </blockquote>
3998                                                                            
3999    
4000    <p>MIDI_INSTRUMENT_MAP -
4001                                            </p>
4002    <blockquote class="text">
4003    <p>Determines to which MIDI instrument map this sampler
4004                                                channel is assigned to. Read chapter
4005                                                <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>
4006                                                for a list of possible values.
4007    </p>
4008    </blockquote>
4009                                        
4010    
4011  </blockquote>  </blockquote>
4012                                                            
4013    
# Line 3895  Intellectual Property and Copyright Stat Line 4047  Intellectual Property and Copyright Stat
4047  </p>  </p>
4048  <p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"  <p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"
4049  </p>  </p>
4050    <p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
4051    </p>
4052    <p>&nbsp;&nbsp;&nbsp;"MUTE: false"
4053    </p>
4054    <p>&nbsp;&nbsp;&nbsp;"SOLO: false"
4055    </p>
4056    <p>&nbsp;&nbsp;&nbsp;"MIDI_INSTRUMENT_MAP: NONE"
4057    </p>
4058  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
4059  </p>  </p>
4060  </blockquote><p>  </blockquote><p>
4061                                            
4062  </p>  </p>
4063  <a name="GET CHANNEL VOICE_COUNT"></a><br /><hr />  <a name="GET CHANNEL VOICE_COUNT"></a><br /><hr />
4064  <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>
4065  <a name="rfc.section.6.4.11"></a><h3>6.4.11.&nbsp;Current number of active voices</h3>  <a name="rfc.section.6.4.11"></a><h3>6.4.11.&nbsp;
4066    Current number of active voices</h3>
4067    
4068  <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
4069                      sampler channel by sending the following command:                      sampler channel by sending the following command:
# Line 3916  Intellectual Property and Copyright Stat Line 4077  Intellectual Property and Copyright Stat
4077                                            
4078  </p>  </p>
4079  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
4080                      as returned by the <a class="info" href="#ADD CHANNEL">"ADD CHANNEL"<span> (</span><span class="info">Adding a new sampler channel</span><span>)</span></a>                      as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
4081                      or <a class="info" href="#LIST CHANNELS">"LIST CHANNELS"<span> (</span><span class="info">Getting all created sampler channel list</span><span>)</span></a> command.                      or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command.
4082  </p>  </p>
4083  <p>Possible Answers:  <p>Possible Answers:
4084  </p>  </p>
# Line 3941  Intellectual Property and Copyright Stat Line 4102  Intellectual Property and Copyright Stat
4102                                            
4103  </p>  </p>
4104  <a name="GET CHANNEL STREAM_COUNT"></a><br /><hr />  <a name="GET CHANNEL STREAM_COUNT"></a><br /><hr />
4105  <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>
4106  <a name="rfc.section.6.4.12"></a><h3>6.4.12.&nbsp;Current number of active disk streams</h3>  <a name="rfc.section.6.4.12"></a><h3>6.4.12.&nbsp;
4107    Current number of active disk streams</h3>
4108    
4109  <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
4110                      on a sampler channel by sending the following command:                      on a sampler channel by sending the following command:
# Line 3956  Intellectual Property and Copyright Stat Line 4118  Intellectual Property and Copyright Stat
4118                                            
4119  </p>  </p>
4120  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in  <p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
4121                      as returned by the <a class="info" href="#ADD CHANNEL">"ADD CHANNEL"<span> (</span><span class="info">Adding a new sampler channel</span><span>)</span></a>                      as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
4122                      or <a class="info" href="#LIST CHANNELS">"LIST CHANNELS"<span> (</span><span class="info">Getting all created sampler channel list</span><span>)</span></a> command.                      or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command.
4123  </p>  </p>
4124  <p>Possible Answers:  <p>Possible Answers:
4125  </p>  </p>
# Line 3983  Intellectual Property and Copyright Stat Line 4145  Intellectual Property and Copyright Stat
4145                                            
4146  </p>  </p>
4147  <a name="GET CHANNEL BUFFER_FILL"></a><br /><hr />  <a name="GET CHANNEL BUFFER_FILL"></a><br /><hr />
4148  <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>
4149  <a name="rfc.section.6.4.13"></a><h3>6.4.13.&nbsp;Current fill state of disk stream buffers</h3>  <a name="rfc.section.6.4.13"></a><h3>6.4.13.&nbsp;
4150    Current fill state of disk stream buffers</h3>
4151    
4152  <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
4153                      on a sampler channel by sending the following command:                      on a sampler channel by sending the following command:
# Line 4009  Intellectual Property and Copyright Stat Line 4172  Intellectual Property and Copyright Stat
4172  </p>  </p>
4173  <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
4174                      sampler channel number the front-end is interested in                      sampler channel number the front-end is interested in
4175                      as returned by the <a class="info" href="#ADD CHANNEL">"ADD CHANNEL"<span> (</span><span class="info">Adding a new sampler channel</span><span>)</span></a>                      as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
4176                      or <a class="info" href="#LIST CHANNELS">"LIST CHANNELS"<span> (</span><span class="info">Getting all created sampler channel list</span><span>)</span></a> command.                      or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command.
4177  </p>  </p>
4178  <p>Possible Answers:  <p>Possible Answers:
4179  </p>  </p>
# Line 4060  Intellectual Property and Copyright Stat Line 4223  Intellectual Property and Copyright Stat
4223                                            
4224  </p>  </p>
4225  <a name="SET CHANNEL AUDIO_OUTPUT_DEVICE"></a><br /><hr />  <a name="SET CHANNEL AUDIO_OUTPUT_DEVICE"></a><br /><hr />
4226  <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>
4227  <a name="rfc.section.6.4.14"></a><h3>6.4.14.&nbsp;Setting audio output device</h3>  <a name="rfc.section.6.4.14"></a><h3>6.4.14.&nbsp;
4228    Setting audio output device</h3>
4229    
4230  <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
4231                      channel by sending the following command:                      channel by sending the following command:
# Line 4075  Intellectual Property and Copyright Stat Line 4239  Intellectual Property and Copyright Stat
4239                                            
4240  </p>  </p>
4241  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4242                      number as returned by the <a class="info" href="#ADD CHANNEL">"ADD CHANNEL"<span> (</span><span class="info">Adding a new sampler channel</span><span>)</span></a>                      number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
4243                      or <a class="info" href="#LIST CHANNELS">"LIST CHANNELS"<span> (</span><span class="info">Getting all created sampler channel list</span><span>)</span></a> command and                      or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command and
4244                      &lt;audio-device-id&gt; is the numerical ID of the audio output device as given by the                      &lt;audio-device-id&gt; is the numerical ID of the audio output device as given by the
4245                      <a class="info" href="#CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class="info">Creating an audio output device</span><span>)</span></a>                      <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
4246                      or <a class="info" href="#LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class="info">Getting all created audio output device list</span><span>)</span></a>                      or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
4247                      command.                      command.
4248  </p>  </p>
4249  <p>Possible Answers:  <p>Possible Answers:
# Line 4126  Intellectual Property and Copyright Stat Line 4290  Intellectual Property and Copyright Stat
4290  </blockquote><p>  </blockquote><p>
4291                                            
4292  </p>  </p>
4293  <a name="SET CHANNEL AUDIO_OUTPUT_TYP"></a><br /><hr />  <a name="SET CHANNEL AUDIO_OUTPUT_TYPE"></a><br /><hr />
4294  <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>
4295  <a name="rfc.section.6.4.15"></a><h3>6.4.15.&nbsp;Setting audio output type</h3>  <a name="rfc.section.6.4.15"></a><h3>6.4.15.&nbsp;
4296    Setting audio output type</h3>
4297    
4298  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
4299  </p>  </p>
# Line 4191  Intellectual Property and Copyright Stat Line 4356  Intellectual Property and Copyright Stat
4356                                            
4357  </p>  </p>
4358  <a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr />  <a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
4359  <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>
4360  <a name="rfc.section.6.4.16"></a><h3>6.4.16.&nbsp;Setting audio output channel</h3>  <a name="rfc.section.6.4.16"></a><h3>6.4.16.&nbsp;
4361    Setting audio output channel</h3>
4362    
4363  <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
4364                      sampler channel by sending the following command:                      sampler channel by sending the following command:
# Line 4206  Intellectual Property and Copyright Stat Line 4372  Intellectual Property and Copyright Stat
4372                                            
4373  </p>  </p>
4374  <p>Where &lt;sampler-chan&gt; is the sampler channel number  <p>Where &lt;sampler-chan&gt; is the sampler channel number
4375                      as returned by the <a class="info" href="#ADD CHANNEL">"ADD CHANNEL"<span> (</span><span class="info">Adding a new sampler channel</span><span>)</span></a>                      as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
4376                      or <a class="info" href="#LIST CHANNELS">"LIST CHANNELS"<span> (</span><span class="info">Getting all created sampler channel list</span><span>)</span></a> command, &lt;audio-out&gt; is the                      or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command, &lt;audio-out&gt; is the
4377                      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
4378                      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
4379                      output device where &lt;audio-out&gt; should be routed to.                      output device where &lt;audio-out&gt; should be routed to.
# Line 4257  Intellectual Property and Copyright Stat Line 4423  Intellectual Property and Copyright Stat
4423                                            
4424  </p>  </p>
4425  <a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr />
4426  <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>
4427  <a name="rfc.section.6.4.17"></a><h3>6.4.17.&nbsp;Setting MIDI input device</h3>  <a name="rfc.section.6.4.17"></a><h3>6.4.17.&nbsp;
4428    Setting MIDI input device</h3>
4429    
4430  <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
4431                      channel by sending the following command:                      channel by sending the following command:
# Line 4272  Intellectual Property and Copyright Stat Line 4439  Intellectual Property and Copyright Stat
4439                                            
4440  </p>  </p>
4441  <p>Where &lt;sampler-channel&gt; is the sampler channel number  <p>Where &lt;sampler-channel&gt; is the sampler channel number
4442                      as returned by the <a class="info" href="#ADD CHANNEL">"ADD CHANNEL"<span> (</span><span class="info">Adding a new sampler channel</span><span>)</span></a>                      as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
4443                      or <a class="info" href="#LIST CHANNELS">"LIST CHANNELS"<span> (</span><span class="info">Getting all created sampler channel list</span><span>)</span></a> command                      or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command
4444                      and &lt;midi-device-id&gt; is  the numerical ID of the MIDI input device as returned by the                      and &lt;midi-device-id&gt; is  the numerical ID of the MIDI input device as returned by the
4445                      <a class="info" href="#CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class="info">Creating a MIDI input device</span><span>)</span></a>                      <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
4446                      or <a class="info" href="#LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"<span> (</span><span class="info">Getting all created MIDI input device list</span><span>)</span></a> command.                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a> command.
4447  </p>  </p>
4448  <p>Possible Answers:  <p>Possible Answers:
4449  </p>  </p>
# Line 4323  Intellectual Property and Copyright Stat Line 4490  Intellectual Property and Copyright Stat
4490                                            
4491  </p>  </p>
4492  <a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr />
4493  <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>
4494  <a name="rfc.section.6.4.18"></a><h3>6.4.18.&nbsp;Setting MIDI input type</h3>  <a name="rfc.section.6.4.18"></a><h3>6.4.18.&nbsp;
4495    Setting MIDI input type</h3>
4496    
4497  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
4498  </p>  </p>
# Line 4387  Intellectual Property and Copyright Stat Line 4555  Intellectual Property and Copyright Stat
4555                                            
4556  </p>  </p>
4557  <a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr />
4558  <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>
4559  <a name="rfc.section.6.4.19"></a><h3>6.4.19.&nbsp;Setting MIDI input port</h3>  <a name="rfc.section.6.4.19"></a><h3>6.4.19.&nbsp;
4560    Setting MIDI input port</h3>
4561    
4562  <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
4563                      channel by sending the following command:                      channel by sending the following command:
# Line 4450  Intellectual Property and Copyright Stat Line 4619  Intellectual Property and Copyright Stat
4619                                            
4620  </p>  </p>
4621  <a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr />
4622  <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>
4623  <a name="rfc.section.6.4.20"></a><h3>6.4.20.&nbsp;Setting MIDI input channel</h3>  <a name="rfc.section.6.4.20"></a><h3>6.4.20.&nbsp;
4624    Setting MIDI input channel</h3>
4625    
4626  <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
4627                      listen to by sending the following command:                      listen to by sending the following command:
# Line 4513  Intellectual Property and Copyright Stat Line 4683  Intellectual Property and Copyright Stat
4683                                            
4684  </p>  </p>
4685  <a name="SET CHANNEL VOLUME"></a><br /><hr />  <a name="SET CHANNEL VOLUME"></a><br /><hr />
4686  <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>
4687  <a name="rfc.section.6.4.21"></a><h3>6.4.21.&nbsp;Setting channel volume</h3>  <a name="rfc.section.6.4.21"></a><h3>6.4.21.&nbsp;
4688    Setting channel volume</h3>
4689    
4690  <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
4691                      the following command:                      the following command:
# Line 4577  Intellectual Property and Copyright Stat Line 4748  Intellectual Property and Copyright Stat
4748                                            
4749  </p>  </p>
4750  <a name="SET CHANNEL MUTE"></a><br /><hr />  <a name="SET CHANNEL MUTE"></a><br /><hr />
4751  <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>
4752  <a name="rfc.section.6.4.22"></a><h3>6.4.22.&nbsp;Muting a sampler channel</h3>  <a name="rfc.section.6.4.22"></a><h3>6.4.22.&nbsp;
4753    Muting a sampler channel</h3>
4754    
4755  <p>The front-end can mute/unmute a specific sampler  <p>The front-end can mute/unmute a specific sampler
4756                      channel by sending the following command:                      channel by sending the following command:
# Line 4592  Intellectual Property and Copyright Stat Line 4764  Intellectual Property and Copyright Stat
4764                                            
4765  </p>  </p>
4766  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4767                      number as returned by the <a class="info" href="#ADD CHANNEL">"ADD CHANNEL"<span> (</span><span class="info">Adding a new sampler channel</span><span>)</span></a>                      number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
4768                      or <a class="info" href="#LIST CHANNELS">"LIST CHANNELS"<span> (</span><span class="info">Getting all created sampler channel list</span><span>)</span></a> command and                      or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command and
4769                      &lt;mute&gt; should be replaced either by "1" to mute the channel or "0"                      &lt;mute&gt; should be replaced either by "1" to mute the channel or "0"
4770                      to unmute the channel.                      to unmute the channel.
4771  </p>  </p>
# Line 4642  Intellectual Property and Copyright Stat Line 4814  Intellectual Property and Copyright Stat
4814                                            
4815  </p>  </p>
4816  <a name="SET CHANNEL SOLO"></a><br /><hr />  <a name="SET CHANNEL SOLO"></a><br /><hr />
4817  <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>
4818  <a name="rfc.section.6.4.23"></a><h3>6.4.23.&nbsp;Soloing a sampler channel</h3>  <a name="rfc.section.6.4.23"></a><h3>6.4.23.&nbsp;
4819    Soloing a sampler channel</h3>
4820    
4821  <p>The front-end can solo/unsolo a specific sampler channel  <p>The front-end can solo/unsolo a specific sampler channel
4822                      by sending the following command:                      by sending the following command:
# Line 4657  Intellectual Property and Copyright Stat Line 4830  Intellectual Property and Copyright Stat
4830                                            
4831  </p>  </p>
4832  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4833                      number as returned by the <a class="info" href="#ADD CHANNEL">"ADD CHANNEL"<span> (</span><span class="info">Adding a new sampler channel</span><span>)</span></a>                      number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
4834                      or <a class="info" href="#LIST CHANNELS">"LIST CHANNELS"<span> (</span><span class="info">Getting all created sampler channel list</span><span>)</span></a> command and                      or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command and
4835                      &lt;solo&gt; should be replaced either by "1" to solo the channel or "0"                      &lt;solo&gt; should be replaced either by "1" to solo the channel or "0"
4836                      to unsolo the channel.                      to unsolo the channel.
4837  </p>  </p>
# Line 4706  Intellectual Property and Copyright Stat Line 4879  Intellectual Property and Copyright Stat
4879  </blockquote><p>  </blockquote><p>
4880                                            
4881  </p>  </p>
4882    <a name="SET CHANNEL MIDI_INSTRUMENT_MAP"></a><br /><hr />
4883    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4884    <a name="rfc.section.6.4.24"></a><h3>6.4.24.&nbsp;
4885    Assigning a MIDI instrument map to a sampler channel</h3>
4886    
4887    <p>The front-end can assign a MIDI instrument map to a specific sampler channel
4888                        by sending the following command:
4889    </p>
4890    <p>
4891                            </p>
4892    <blockquote class="text">
4893    <p>SET CHANNEL MIDI_INSTRUMENT_MAP &lt;sampler-channel&gt; &lt;map&gt;
4894    </p>
4895    </blockquote><p>
4896                        
4897    </p>
4898    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4899                        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>
4900                        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
4901                        &lt;map&gt; can have the following possibilites:
4902    </p>
4903    <p>
4904                            </p>
4905    <blockquote class="text">
4906    <p>"NONE" -
4907                                    </p>
4908    <blockquote class="text">
4909    <p>This is the default setting. In this case
4910                                        the sampler channel is not assigned any MIDI
4911                                        instrument map and thus will ignore all MIDI
4912                                        program change messages.
4913    </p>
4914    </blockquote>
4915                                
4916    
4917    <p>"DEFAULT" -
4918                                    </p>
4919    <blockquote class="text">
4920    <p>The sampler channel will always use the
4921                                        default MIDI instrument map to handle MIDI
4922                                        program change messages.
4923    </p>
4924    </blockquote>
4925                                
4926    
4927    <p>numeric ID -
4928                                    </p>
4929    <blockquote class="text">
4930    <p>You can assign a specific MIDI instrument map
4931                                        by replacing &lt;map&gt; with the respective numeric
4932                                        ID of the MIDI instrument map as returned by the
4933                                        <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>
4934                                        command. Once that map will be deleted, the sampler
4935                                        channel would fall back to "NONE".
4936    </p>
4937    </blockquote>
4938                                
4939    
4940    </blockquote><p>
4941                        
4942    </p>
4943    <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>
4944                        for details regarding MIDI instrument mapping.
4945    </p>
4946    <p>Possible Answers:
4947    </p>
4948    <p>
4949                            </p>
4950    <blockquote class="text">
4951    <p>"OK" -
4952                                    </p>
4953    <blockquote class="text">
4954    <p>on success
4955    </p>
4956    </blockquote>
4957                                
4958    
4959    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4960                                    </p>
4961    <blockquote class="text">
4962    <p>in case it failed, providing an appropriate error code and error message
4963    </p>
4964    </blockquote>
4965                                
4966    
4967    </blockquote><p>
4968                        
4969    </p>
4970    <p>Examples:
4971    </p>
4972    <p>
4973                            </p>
4974    <blockquote class="text">
4975    <p>
4976    </p>
4977    </blockquote><p>
4978                        
4979    </p>
4980    <a name="CREATE FX_SEND"></a><br /><hr />
4981    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4982    <a name="rfc.section.6.4.25"></a><h3>6.4.25.&nbsp;
4983    Adding an effect send to a sampler channel</h3>
4984    
4985    <p>The front-end can create an additional effect send on a specific sampler channel
4986                        by sending the following command:
4987    </p>
4988    <p>
4989                            </p>
4990    <blockquote class="text">
4991    <p>CREATE FX_SEND &lt;sampler-channel&gt; &lt;midi-ctrl&gt; [&lt;name&gt;]
4992    </p>
4993    </blockquote><p>
4994                        
4995    </p>
4996    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4997                        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>
4998                        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
4999                        sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
5000                        is a number between 0..127 defining the MIDI controller which can alter the
5001                        effect send level and &lt;name&gt; is an optional argument defining a name
5002                        for the effect send entity. The name does not have to be unique.
5003    </p>
5004    <p>By default, that is as initial routing, the effect send's audio channels
5005                        are automatically routed to the last audio channels of the sampler channel's
5006                        audio output device, that way you can i.e. first increase the amount of audio
5007                        channels on the audio output device for having dedicated effect send output
5008                        channels and when "CREATE FX_SEND" is called, those channels will automatically
5009                        be picked. You can alter the destination channels however with
5010                        <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>.
5011                        
5012    </p>
5013    <p>Note: Create effect sends on a sampler channel only when needed, because having effect
5014                        sends on a sampler channel will decrease runtime performance, because for implementing channel
5015                        effect sends, separate (sampler channel local) audio buffers are needed to render and mix
5016                        the voices and route the audio signal afterwards to the master outputs and effect send
5017                        outputs (along with their respective effect send levels). A sampler channel without effect
5018                        sends however can mix its voices directly into the audio output devices's audio buffers
5019                        and is thus faster.
5020                        
5021    </p>
5022    <p>Possible Answers:
5023    </p>
5024    <p>
5025                            </p>
5026    <blockquote class="text">
5027    <p>"OK[&lt;fx-send-id&gt;]" -
5028                                    </p>
5029    <blockquote class="text">
5030    <p>in case a new effect send could be added to the
5031                                        sampler channel, where &lt;fx-send-id&gt; reflects the
5032                                        unique ID of the newly created effect send entity
5033    </p>
5034    </blockquote>
5035                                
5036    
5037    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5038                                    </p>
5039    <blockquote class="text">
5040    <p>when a new effect send could not be added, i.e.
5041                                        due to invalid parameters
5042    </p>
5043    </blockquote>
5044                                
5045    
5046    </blockquote><p>
5047                        
5048    </p>
5049    <p>Examples:
5050    </p>
5051    <p>
5052                            </p>
5053    <blockquote class="text">
5054    <p>C: "CREATE FX_SEND 0 91 'Reverb Send'"
5055    </p>
5056    <p>S: "OK[0]"
5057    </p>
5058    </blockquote><p>
5059                        
5060    </p>
5061    <p>
5062                            </p>
5063    <blockquote class="text">
5064    <p>C: "CREATE FX_SEND 0 93"
5065    </p>
5066    <p>S: "OK[1]"
5067    </p>
5068    </blockquote><p>
5069                        
5070    </p>
5071    <a name="DESTROY FX_SEND"></a><br /><hr />
5072    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5073    <a name="rfc.section.6.4.26"></a><h3>6.4.26.&nbsp;
5074    Removing an effect send from a sampler channel</h3>
5075    
5076    <p>The front-end can remove an existing effect send on a specific sampler channel
5077                        by sending the following command:
5078    </p>
5079    <p>
5080                            </p>
5081    <blockquote class="text">
5082    <p>DESTROY FX_SEND &lt;sampler-channel&gt; &lt;fx-send-id&gt;
5083    </p>
5084    </blockquote><p>
5085                        
5086    </p>
5087    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5088                        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>
5089                        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
5090                        sampler channel from which the effect send should be removed from and
5091                        &lt;fx-send-id&gt; is the respective effect send number as returned by the
5092                        <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>
5093                        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.
5094    </p>
5095    <p>Possible Answers:
5096    </p>
5097    <p>
5098                            </p>
5099    <blockquote class="text">
5100    <p>"OK" -
5101                                    </p>
5102    <blockquote class="text">
5103    <p>on success
5104    </p>
5105    </blockquote>
5106                                
5107    
5108    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5109                                    </p>
5110    <blockquote class="text">
5111    <p>in case it failed, providing an appropriate error code and
5112                                        error message
5113    </p>
5114    </blockquote>
5115                                
5116    
5117    </blockquote><p>
5118                        
5119    </p>
5120    <p>Example:
5121    </p>
5122    <p>
5123                            </p>
5124    <blockquote class="text">
5125    <p>C: "DESTROY FX_SEND 0 0"
5126    </p>
5127    <p>S: "OK"
5128    </p>
5129    </blockquote><p>
5130                        
5131    </p>
5132    <a name="GET FX_SENDS"></a><br /><hr />
5133    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5134    <a name="rfc.section.6.4.27"></a><h3>6.4.27.&nbsp;
5135    Getting amount of effect sends on a sampler channel</h3>
5136    
5137    <p>The front-end can ask for the amount of effect sends on a specific sampler channel
5138                        by sending the following command:
5139    </p>
5140    <p>
5141                            </p>
5142    <blockquote class="text">
5143    <p>GET FX_SENDS &lt;sampler-channel&gt;
5144    </p>
5145    </blockquote><p>
5146                        
5147    </p>
5148    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5149                        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>
5150                        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.
5151    </p>
5152    <p>Possible Answers:
5153    </p>
5154    <p>
5155                            </p>
5156    <blockquote class="text">
5157    <p>The sampler will answer by returning the number of effect
5158                                sends on the given sampler channel.
5159    </p>
5160    </blockquote><p>
5161                        
5162    </p>
5163    <p>Example:
5164    </p>
5165    <p>
5166                            </p>
5167    <blockquote class="text">
5168    <p>C: "GET FX_SENDS 0"
5169    </p>
5170    <p>S: "2"
5171    </p>
5172    </blockquote><p>
5173                        
5174    </p>
5175    <a name="LIST FX_SENDS"></a><br /><hr />
5176    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5177    <a name="rfc.section.6.4.28"></a><h3>6.4.28.&nbsp;
5178    Listing all effect sends on a sampler channel</h3>
5179    
5180    <p>The front-end can ask for a list of effect sends on a specific sampler channel
5181                        by sending the following command:
5182    </p>
5183    <p>
5184                            </p>
5185    <blockquote class="text">
5186    <p>LIST FX_SENDS &lt;sampler-channel&gt;
5187    </p>
5188    </blockquote><p>
5189                        
5190    </p>
5191    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5192                        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>
5193                        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.
5194    </p>
5195    <p>Possible Answers:
5196    </p>
5197    <p>
5198                            </p>
5199    <blockquote class="text">
5200    <p>The sampler will answer by returning a comma separated list
5201                                with all effect sends' numerical IDs on the given sampler
5202                                channel.
5203    </p>
5204    </blockquote><p>
5205                        
5206    </p>
5207    <p>Examples:
5208    </p>
5209    <p>
5210                            </p>
5211    <blockquote class="text">
5212    <p>C: "LIST FX_SENDS 0"
5213    </p>
5214    <p>S: "0,1"
5215    </p>
5216    </blockquote><p>
5217                        
5218    </p>
5219    <p>
5220                            </p>
5221    <blockquote class="text">
5222    <p>C: "LIST FX_SENDS 1"
5223    </p>
5224    <p>S: ""
5225    </p>
5226    </blockquote><p>
5227                        
5228    </p>
5229    <a name="GET FX_SEND INFO"></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.29"></a><h3>6.4.29.&nbsp;
5232    Getting effect send information</h3>
5233    
5234    <p>The front-end can ask for the current settings of an effect send entity
5235                        by sending the following command:
5236    </p>
5237    <p>
5238                            </p>
5239    <blockquote class="text">
5240    <p>GET FX_SEND INFO &lt;sampler-channel&gt; &lt;fx-send-id&gt;
5241    </p>
5242    </blockquote><p>
5243                        
5244    </p>
5245    <p>Where &lt;sampler-channel&gt; is the sampler channel number
5246                        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 and
5248                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5249                        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>
5250                        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.
5251                      
5252    </p>
5253    <p>Possible Answers:
5254    </p>
5255    <p>
5256                            </p>
5257    <blockquote class="text">
5258    <p>The sampler will answer by sending a &lt;CRLF&gt; separated list.
5259                                Each answer line begins with the settings category name
5260                                followed by a colon and then a space character &lt;SP&gt; and finally
5261                                the info character string to that setting category. At the
5262                                moment the following categories are defined:
5263    </p>
5264    <p>
5265                                    </p>
5266    <blockquote class="text">
5267    <p>NAME -
5268                                            </p>
5269    <blockquote class="text">
5270    <p>name of the effect send entity
5271    </p>
5272    </blockquote>
5273                                        
5274    
5275    <p>MIDI_CONTROLLER -
5276                                            </p>
5277    <blockquote class="text">
5278    <p>a value between 0 and 127 reflecting the MIDI controller
5279                                                which is able to modify the effect send's send level
5280    </p>
5281    </blockquote>
5282                                        
5283    
5284    <p>LEVEL -
5285                                            </p>
5286    <blockquote class="text">
5287    <p>optionally dotted number reflecting the effect send's
5288                                                current send level (where a value &lt; 1.0 means attenuation
5289                                                and a value > 1.0 means amplification)
5290    </p>
5291    </blockquote>
5292                                        
5293    
5294    <p>AUDIO_OUTPUT_ROUTING -
5295                                            </p>
5296    <blockquote class="text">
5297    <p>comma separated list which reflects to which audio
5298                                                channel of the selected audio output device each
5299                                                effect send output channel is routed to, e.g. "0,3" would
5300                                                mean the effect send's output channel 0 is routed to channel
5301                                                0 of the audio output device and the effect send's output
5302                                                channel 1 is routed to the channel 3 of the audio
5303                                                output device (see
5304                                                <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>
5305                                                for details)
5306    </p>
5307    </blockquote>
5308                                        
5309    
5310    </blockquote>
5311                                
5312    
5313    </blockquote><p>
5314                        
5315    </p>
5316    <p>The mentioned fields above don't have to be in particular order.
5317    </p>
5318    <p>Example:
5319    </p>
5320    <p>
5321                            </p>
5322    <blockquote class="text">
5323    <p>C: "GET FX_SEND INFO 0 0"
5324    </p>
5325    <p>S: "NAME: Reverb Send"
5326    </p>
5327    <p>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"
5328    </p>
5329    <p>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"
5330    </p>
5331    <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"
5332    </p>
5333    <p>&nbsp;&nbsp;&nbsp;"."
5334    </p>
5335    </blockquote><p>
5336                        
5337    </p>
5338    <a name="SET FX_SEND NAME"></a><br /><hr />
5339    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5340    <a name="rfc.section.6.4.30"></a><h3>6.4.30.&nbsp;
5341    Changing effect send's name</h3>
5342    
5343    <p>The front-end can alter the current name of an effect
5344                        send entity by sending the following command:
5345    </p>
5346    <p>
5347                            </p>
5348    <blockquote class="text">
5349    <p>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;
5350    </p>
5351    </blockquote><p>
5352                        
5353    </p>
5354    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5355                        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>
5356                        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,
5357                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5358                        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>
5359                        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
5360                        &lt;name&gt; is the new name of the effect send entity, which
5361                        does not have to be unique.
5362    </p>
5363    <p>Possible Answers:
5364    </p>
5365    <p>
5366                            </p>
5367    <blockquote class="text">
5368    <p>"OK" -
5369                                    </p>
5370    <blockquote class="text">
5371    <p>on success
5372    </p>
5373    </blockquote>
5374                                
5375    
5376    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5377                                    </p>
5378    <blockquote class="text">
5379    <p>in case it failed, providing an appropriate error code and error message
5380    </p>
5381    </blockquote>
5382                                
5383    
5384    </blockquote><p>
5385                        
5386    </p>
5387    <p>Example:
5388    </p>
5389    <p>
5390                            </p>
5391    <blockquote class="text">
5392    <p>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
5393    </p>
5394    <p>S: "OK"
5395    </p>
5396    </blockquote><p>
5397                        
5398    </p>
5399    <a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
5400    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5401    <a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;
5402    Altering effect send's audio routing</h3>
5403    
5404    <p>The front-end can alter the destination of an effect send's audio channel on a specific
5405                        sampler channel by sending the following command:
5406    </p>
5407    <p>
5408                            </p>
5409    <blockquote class="text">
5410    <p>SET FX_SEND AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;audio-src&gt; &lt;audio-dst&gt;
5411    </p>
5412    </blockquote><p>
5413                        
5414    </p>
5415    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5416                        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>
5417                        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,
5418                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5419                        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>
5420                        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,
5421                        &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
5422                        which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
5423                        the audio channel of the selected audio output device where &lt;audio-src&gt;
5424                        should be routed to.
5425    </p>
5426    <p>Note that effect sends can only route audio to the same audio output
5427                        device as assigned to the effect send's sampler channel. Also note that an
5428                        effect send entity does always have exactly as much audio channels as its
5429                        sampler channel. So if the sampler channel is stereo, the effect send does
5430                        have two audio channels as well. Also keep in mind that the amount of audio
5431                        channels on a sampler channel might be dependant not only to the deployed
5432                        sampler engine on the sampler channel, but also dependant to the instrument
5433                        currently loaded. However you can (effectively) turn an i.e. stereo effect
5434                        send into a mono one by simply altering its audio routing appropriately.
5435    </p>
5436    <p>Possible Answers:
5437    </p>
5438    <p>
5439                            </p>
5440    <blockquote class="text">
5441    <p>"OK" -
5442                                    </p>
5443    <blockquote class="text">
5444    <p>on success
5445    </p>
5446    </blockquote>
5447                                
5448    
5449    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5450                                    </p>
5451    <blockquote class="text">
5452    <p>if audio output channel was set, but there are noteworthy
5453                                        issue(s) related, providing an appropriate warning code and
5454                                        warning message
5455    </p>
5456    </blockquote>
5457                                
5458    
5459    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5460                                    </p>
5461    <blockquote class="text">
5462    <p>in case it failed, providing an appropriate error code and error message
5463    </p>
5464    </blockquote>
5465                                
5466    
5467    </blockquote><p>
5468                        
5469    </p>
5470    <p>Example:
5471    </p>
5472    <p>
5473                            </p>
5474    <blockquote class="text">
5475    <p>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
5476    </p>
5477    <p>S: "OK"
5478    </p>
5479    </blockquote><p>
5480                        
5481    </p>
5482    <a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />
5483    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5484    <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;
5485    Altering effect send's MIDI controller</h3>
5486    
5487    <p>The front-end can alter the MIDI controller of an effect
5488                        send entity by sending the following command:
5489    </p>
5490    <p>
5491                            </p>
5492    <blockquote class="text">
5493    <p>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;
5494    </p>
5495    </blockquote><p>
5496                        
5497    </p>
5498    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5499                        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>
5500                        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,
5501                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5502                        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>
5503                        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
5504                        &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
5505                        able to modify the effect send's send level.
5506    </p>
5507    <p>Possible Answers:
5508    </p>
5509    <p>
5510                            </p>
5511    <blockquote class="text">
5512    <p>"OK" -
5513                                    </p>
5514    <blockquote class="text">
5515    <p>on success
5516    </p>
5517    </blockquote>
5518                                
5519    
5520    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5521                                    </p>
5522    <blockquote class="text">
5523    <p>if MIDI controller was set, but there are noteworthy
5524                                        issue(s) related, providing an appropriate warning code and
5525                                        warning message
5526    </p>
5527    </blockquote>
5528                                
5529    
5530    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5531                                    </p>
5532    <blockquote class="text">
5533    <p>in case it failed, providing an appropriate error code and error message
5534    </p>
5535    </blockquote>
5536                                
5537    
5538    </blockquote><p>
5539                        
5540    </p>
5541    <p>Example:
5542    </p>
5543    <p>
5544                            </p>
5545    <blockquote class="text">
5546    <p>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
5547    </p>
5548    <p>S: "OK"
5549    </p>
5550    </blockquote><p>
5551                        
5552    </p>
5553    <a name="SET FX_SEND LEVEL"></a><br /><hr />
5554    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5555    <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;
5556    Altering effect send's send level</h3>
5557    
5558    <p>The front-end can alter the current send level of an effect
5559                        send entity by sending the following command:
5560    </p>
5561    <p>
5562                            </p>
5563    <blockquote class="text">
5564    <p>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;
5565    </p>
5566    </blockquote><p>
5567                        
5568    </p>
5569    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5570                        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>
5571                        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,
5572                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5573                        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>
5574                        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
5575                        &lt;volume&gt; is an optionally dotted positive number (a value
5576                        smaller than 1.0 means attenuation, whereas a value greater than
5577                        1.0 means amplification) reflecting the new send level.
5578    </p>
5579    <p>Possible Answers:
5580    </p>
5581    <p>
5582                            </p>
5583    <blockquote class="text">
5584    <p>"OK" -
5585                                    </p>
5586    <blockquote class="text">
5587    <p>on success
5588    </p>
5589    </blockquote>
5590                                
5591    
5592    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5593                                    </p>
5594    <blockquote class="text">
5595    <p>if new send level was set, but there are noteworthy
5596                                        issue(s) related, providing an appropriate warning code and
5597                                        warning message
5598    </p>
5599    </blockquote>
5600                                
5601    
5602    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5603                                    </p>
5604    <blockquote class="text">
5605    <p>in case it failed, providing an appropriate error code and error message
5606    </p>
5607    </blockquote>
5608                                
5609    
5610    </blockquote><p>
5611                        
5612    </p>
5613    <p>Example:
5614    </p>
5615    <p>
5616                            </p>
5617    <blockquote class="text">
5618    <p>C: "SET FX_SEND LEVEL 0 0 0.15"
5619    </p>
5620    <p>S: "OK"
5621    </p>
5622    </blockquote><p>
5623                        
5624    </p>
5625  <a name="RESET CHANNEL"></a><br /><hr />  <a name="RESET CHANNEL"></a><br /><hr />
5626  <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>
5627  <a name="rfc.section.6.4.24"></a><h3>6.4.24.&nbsp;Resetting a sampler channel</h3>  <a name="rfc.section.6.4.34"></a><h3>6.4.34.&nbsp;
5628    Resetting a sampler channel</h3>
5629    
5630  <p>The front-end can reset a particular sampler channel by sending the following command:  <p>The front-end can reset a particular sampler channel by sending the following command:
5631  </p>  </p>
# Line 4772  Intellectual Property and Copyright Stat Line 5689  Intellectual Property and Copyright Stat
5689                                            
5690  </p>  </p>
5691  <a name="anchor12"></a><br /><hr />  <a name="anchor12"></a><br /><hr />
5692  <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>
5693  <a name="rfc.section.6.5"></a><h3>6.5.&nbsp;Controlling connection</h3>  <a name="rfc.section.6.5"></a><h3>6.5.&nbsp;
5694    Controlling connection</h3>
5695    
5696  <p>The following commands are used to control the connection to LinuxSampler.  <p>The following commands are used to control the connection to LinuxSampler.
5697  </p>  </p>
5698  <a name="SUBSCRIBE"></a><br /><hr />  <a name="SUBSCRIBE"></a><br /><hr />
5699  <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>
5700  <a name="rfc.section.6.5.1"></a><h3>6.5.1.&nbsp;Register front-end for receiving event messages</h3>  <a name="rfc.section.6.5.1"></a><h3>6.5.1.&nbsp;
5701    Register front-end for receiving event messages</h3>
5702    
5703  <p>The front-end can register itself to the LinuxSampler application to  <p>The front-end can register itself to the LinuxSampler application to
5704                      be informed about noteworthy events by sending this command:                      be informed about noteworthy events by sending this command:
# Line 4841  Intellectual Property and Copyright Stat Line 5760  Intellectual Property and Copyright Stat
5760                                            
5761  </p>  </p>
5762  <a name="UNSUBSCRIBE"></a><br /><hr />  <a name="UNSUBSCRIBE"></a><br /><hr />
5763  <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>
5764  <a name="rfc.section.6.5.2"></a><h3>6.5.2.&nbsp;Unregister front-end for not receiving event messages</h3>  <a name="rfc.section.6.5.2"></a><h3>6.5.2.&nbsp;
5765    Unregister front-end for not receiving event messages</h3>
5766    
5767  <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
5768                      messages anymore by sending the following command:                      messages anymore by sending the following command:
# Line 4904  Intellectual Property and Copyright Stat Line 5824  Intellectual Property and Copyright Stat
5824                                            
5825  </p>  </p>
5826  <a name="SET ECHO"></a><br /><hr />  <a name="SET ECHO"></a><br /><hr />
5827  <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>
5828  <a name="rfc.section.6.5.3"></a><h3>6.5.3.&nbsp;Enable or disable echo of commands</h3>  <a name="rfc.section.6.5.3"></a><h3>6.5.3.&nbsp;
5829    Enable or disable echo of commands</h3>
5830    
5831  <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:
5832  </p>  </p>
# Line 4960  Intellectual Property and Copyright Stat Line 5881  Intellectual Property and Copyright Stat
5881                                            
5882  </p>  </p>
5883  <a name="QUIT"></a><br /><hr />  <a name="QUIT"></a><br /><hr />
5884  <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>
5885  <a name="rfc.section.6.5.4"></a><h3>6.5.4.&nbsp;Close client connection</h3>  <a name="rfc.section.6.5.4"></a><h3>6.5.4.&nbsp;
5886    Close client connection</h3>
5887    
5888  <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:
5889  </p>  </p>
# Line 4977  Intellectual Property and Copyright Stat Line 5899  Intellectual Property and Copyright Stat
5899                      LinuxSampler than really useful for a front-end implementation.                      LinuxSampler than really useful for a front-end implementation.
5900  </p>  </p>
5901  <a name="anchor13"></a><br /><hr />  <a name="anchor13"></a><br /><hr />
5902  <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>
5903  <a name="rfc.section.6.6"></a><h3>6.6.&nbsp;Global commands</h3>  <a name="rfc.section.6.6"></a><h3>6.6.&nbsp;
5904    Global commands</h3>
5905    
5906  <p>The following commands have global impact on the sampler.  <p>The following commands have global impact on the sampler.
5907  </p>  </p>
5908  <a name="GET TOTAL_VOICE_COUNT"></a><br /><hr />  <a name="GET TOTAL_VOICE_COUNT"></a><br /><hr />
5909  <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>
5910  <a name="rfc.section.6.6.1"></a><h3>6.6.1.&nbsp;Current number of active voices</h3>  <a name="rfc.section.6.6.1"></a><h3>6.6.1.&nbsp;
5911    Current number of active voices</h3>
5912    
5913  <p>The front-end can ask for the current number of active voices on  <p>The front-end can ask for the current number of active voices on
5914                      the sampler by sending the following command:                      the sampler by sending the following command:
# Line 5009  Intellectual Property and Copyright Stat Line 5933  Intellectual Property and Copyright Stat
5933                                            
5934  </p>  </p>
5935  <a name="GET TOTAL_VOICE_COUNT_MAX"></a><br /><hr />  <a name="GET TOTAL_VOICE_COUNT_MAX"></a><br /><hr />
5936  <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>
5937  <a name="rfc.section.6.6.2"></a><h3>6.6.2.&nbsp;Maximum amount of active voices</h3>  <a name="rfc.section.6.6.2"></a><h3>6.6.2.&nbsp;
5938    Maximum amount of active voices</h3>
5939    
5940  <p>The front-end can ask for the maximum number of active voices  <p>The front-end can ask for the maximum number of active voices
5941                      by sending the following command:                      by sending the following command:
# Line 5035  Intellectual Property and Copyright Stat Line 5960  Intellectual Property and Copyright Stat
5960                                            
5961  </p>  </p>
5962  <a name="RESET"></a><br /><hr />  <a name="RESET"></a><br /><hr />
5963  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5964  <a name="rfc.section.6.6.3"></a><h3>6.6.3.&nbsp;Reset sampler</h3>  <a name="rfc.section.6.6.3"></a><h3>6.6.3.&nbsp;
5965    Reset sampler</h3>
5966    
5967  <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:
5968  </p>  </p>
# Line 5075  Intellectual Property and Copyright Stat Line 6001  Intellectual Property and Copyright Stat
6001                                            
6002  </p>  </p>
6003  <a name="GET SERVER INFO"></a><br /><hr />  <a name="GET SERVER INFO"></a><br /><hr />
6004  <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>
6005  <a name="rfc.section.6.6.4"></a><h3>6.6.4.&nbsp;General sampler informations</h3>  <a name="rfc.section.6.6.4"></a><h3>6.6.4.&nbsp;
6006    General sampler informations</h3>
6007    
6008  <p>The client can ask for general informations about the LinuxSampler  <p>The client can ask for general informations about the LinuxSampler
6009                         instance by sending the following command:                         instance by sending the following command:
# Line 5124  Intellectual Property and Copyright Stat Line 6051  Intellectual Property and Copyright Stat
6051                                          </p>                                          </p>
6052  <blockquote class="text">  <blockquote class="text">
6053  <p>version of the LSCP specification the sampler  <p>version of the LSCP specification the sampler
6054                                              complies with (see <a class="info" href="#LSCP versioning">Section&nbsp;2<span> (</span><span class="info">Versioning of this specification</span><span>)</span></a> for details)                                              complies with (see <a class='info' href='#LSCP versioning'>Section&nbsp;2<span> (</span><span class='info'>Versioning of this specification</span><span>)</span></a> for details)
6055  </p>  </p>
6056  </blockquote>  </blockquote>
6057                                                                            
# Line 5138  Intellectual Property and Copyright Stat Line 6065  Intellectual Property and Copyright Stat
6065  <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.
6066                      Other fields might be added in future.                      Other fields might be added in future.
6067  </p>  </p>
6068    <a name="GET VOLUME"></a><br /><hr />
6069    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6070    <a name="rfc.section.6.6.5"></a><h3>6.6.5.&nbsp;
6071    Getting global volume attenuation</h3>
6072    
6073    <p>The client can ask for the current global sampler-wide volume
6074                        attenuation by sending the following command:
6075    </p>
6076    <p>
6077                            </p>
6078    <blockquote class="text">
6079    <p>GET VOLUME
6080    </p>
6081    </blockquote><p>
6082                        
6083    </p>
6084    <p>Possible Answers:
6085    </p>
6086    <p>
6087                            </p>
6088    <blockquote class="text">
6089    <p>The sampler will always answer by returning the optional
6090                                dotted floating point coefficient, reflecting the current
6091                                global volume attenuation.
6092                                
6093    </p>
6094    </blockquote><p>
6095                        
6096    </p>
6097    <p>Note: it is up to the respective sampler engine whether to obey
6098                        that global volume parameter or not, but in general all engines SHOULD
6099                        use this parameter.
6100    </p>
6101    <a name="SET VOLUME"></a><br /><hr />
6102    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6103    <a name="rfc.section.6.6.6"></a><h3>6.6.6.&nbsp;
6104    Setting global volume attenuation</h3>
6105    
6106    <p>The client can alter the current global sampler-wide volume
6107                        attenuation by sending the following command:
6108    </p>
6109    <p>
6110                            </p>
6111    <blockquote class="text">
6112    <p>SET VOLUME &lt;volume&gt;
6113    </p>
6114    </blockquote><p>
6115                        
6116    </p>
6117    <p>Where &lt;volume&gt; should be replaced by the optional dotted
6118                       floating point value, reflecting the new global volume parameter.
6119                       This value might usually be in the range between 0.0 and 1.0, that
6120                       is for attenuating the overall volume.
6121    </p>
6122    <p>Possible Answers:
6123    </p>
6124    <p>
6125                            </p>
6126    <blockquote class="text">
6127    <p>"OK" -
6128                                    </p>
6129    <blockquote class="text">
6130    <p>on success
6131    </p>
6132    </blockquote>
6133                                
6134    
6135    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6136                                    </p>
6137    <blockquote class="text">
6138    <p>if the global volume was set, but there are noteworthy
6139                                        issue(s) related, providing an appropriate warning code and
6140                                        warning message
6141    </p>
6142    </blockquote>
6143                                
6144    
6145    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6146                                    </p>
6147    <blockquote class="text">
6148    <p>in case it failed, providing an appropriate error code and error message
6149    </p>
6150    </blockquote>
6151                                
6152    
6153    </blockquote><p>
6154                        
6155    </p>
6156    <a name="MIDI Instrument Mapping"></a><br /><hr />
6157    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6158    <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;
6159    MIDI Instrument Mapping</h3>
6160    
6161    <p>The MIDI protocol provides a way to switch between instruments
6162                    by sending so called MIDI bank select and MIDI program change
6163                    messages which are essentially just numbers. The following commands
6164                    allow to actually map arbitrary MIDI bank select / program change
6165                    numbers with real instruments.
6166    </p>
6167    <p>The sampler allows to manage an arbitrary amount of MIDI
6168                    instrument maps which define which instrument to load on
6169                    which MIDI program change message.
6170    </p>
6171    <p>By default, that is when the sampler is launched, there is no
6172                    map, thus the sampler will simply ignore all program change
6173                    messages. The front-end has to explicitly create at least one
6174                    map, add entries to the map and tell the respective sampler
6175                    channel(s) which MIDI instrument map to use, so the sampler
6176                    knows how to react on a given program change message on the
6177                    respective sampler channel, that is by switching to the
6178                    respectively defined engine type and loading the respective
6179                    instrument. See command
6180                    <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>
6181                    for how to assign a MIDI instrument map to a sampler channel.
6182    </p>
6183    <p>Also note per MIDI specification a bank select message does not
6184                    cause to switch to another instrument. Instead when receiving a
6185                    bank select message the bank value will be stored and a subsequent
6186                    program change message (which may occur at any time) will finally
6187                    cause the sampler to switch to the respective instrument as
6188                    reflected by the current MIDI instrument map.
6189    </p>
6190    <a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr />
6191    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6192    <a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;
6193    Create a new MIDI instrument map</h3>
6194    
6195    <p>The front-end can add a new MIDI instrument map by sending
6196                        the following command:
6197    </p>
6198    <p>
6199                            </p>
6200    <blockquote class="text">
6201    <p>ADD MIDI_INSTRUMENT_MAP [&lt;name&gt;]
6202    </p>
6203    </blockquote><p>
6204                        
6205    </p>
6206    <p>Where &lt;name&gt; is an optional argument allowing to
6207                        assign a custom name to the new map. MIDI instrument Map
6208                        names do not have to be unique.
6209    </p>
6210    <p>Possible Answers:
6211    </p>
6212    <p>
6213                            </p>
6214    <blockquote class="text">
6215    <p>"OK[&lt;map&gt;]" -
6216                                    </p>
6217    <blockquote class="text">
6218    <p>in case a new MIDI instrument map could
6219                                        be added, where &lt;map&gt; reflects the
6220                                        unique ID of the newly created MIDI
6221                                        instrument map
6222    </p>
6223    </blockquote>
6224                                
6225    
6226    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6227                                    </p>
6228    <blockquote class="text">
6229    <p>when a new map could not be created, which
6230                                        might never occur in practice
6231    </p>
6232    </blockquote>
6233                                
6234    
6235    </blockquote><p>
6236                        
6237    </p>
6238    <p>Examples:
6239    </p>
6240    <p>
6241                            </p>
6242    <blockquote class="text">
6243    <p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
6244    </p>
6245    <p>S: "OK[0]"
6246    </p>
6247    </blockquote><p>
6248                        
6249    </p>
6250    <p>
6251                            </p>
6252    <blockquote class="text">
6253    <p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
6254    </p>
6255    <p>S: "OK[1]"
6256    </p>
6257    </blockquote><p>
6258                        
6259    </p>
6260    <p>
6261                            </p>
6262    <blockquote class="text">
6263    <p>C: "ADD MIDI_INSTRUMENT_MAP"
6264    </p>
6265    <p>S: "OK[5]"
6266    </p>
6267    </blockquote><p>
6268                        
6269    </p>
6270    <a name="REMOVE MIDI_INSTRUMENT_MAP"></a><br /><hr />
6271    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6272    <a name="rfc.section.6.7.2"></a><h3>6.7.2.&nbsp;
6273    Delete one particular or all MIDI instrument maps</h3>
6274    
6275    <p>The front-end can delete a particular MIDI instrument map
6276                        by sending the following command:
6277    </p>
6278    <p>
6279                            </p>
6280    <blockquote class="text">
6281    <p>REMOVE MIDI_INSTRUMENT_MAP &lt;map&gt;
6282    </p>
6283    </blockquote><p>
6284                        
6285    </p>
6286    <p>Where &lt;map&gt; reflects the unique ID of the map to delete
6287                        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>
6288                        command.
6289    </p>
6290    <p>The front-end can delete all MIDI instrument maps by
6291                        sending the following command:
6292    </p>
6293    <p>
6294                            </p>
6295    <blockquote class="text">
6296    <p>REMOVE MIDI_INSTRUMENT_MAP ALL
6297    </p>
6298    </blockquote><p>
6299                        
6300    </p>
6301    <p>Possible Answers:
6302    </p>
6303    <p>
6304                            </p>
6305    <blockquote class="text">
6306    <p>"OK" -
6307                                    </p>
6308    <blockquote class="text">
6309    <p>in case the map(s) could be deleted
6310    </p>
6311    </blockquote>
6312                                
6313    
6314    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6315                                    </p>
6316    <blockquote class="text">
6317    <p>when the given map does not exist
6318    </p>
6319    </blockquote>
6320                                
6321    
6322    </blockquote><p>
6323                        
6324    </p>
6325    <p>Examples:
6326    </p>
6327    <p>
6328                            </p>
6329    <blockquote class="text">
6330    <p>C: "REMOVE MIDI_INSTRUMENT_MAP 0"
6331    </p>
6332    <p>S: "OK"
6333    </p>
6334    </blockquote><p>
6335                        
6336    </p>
6337    <p>
6338                            </p>
6339    <blockquote class="text">
6340    <p>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
6341    </p>
6342    <p>S: "OK"
6343    </p>
6344    </blockquote><p>
6345                        
6346    </p>
6347    <a name="GET MIDI_INSTRUMENT_MAPS"></a><br /><hr />
6348    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6349    <a name="rfc.section.6.7.3"></a><h3>6.7.3.&nbsp;
6350    Get amount of existing MIDI instrument maps</h3>
6351    
6352    <p>The front-end can retrieve the current amount of MIDI
6353                        instrument maps by sending the following command:
6354    </p>
6355    <p>
6356                            </p>
6357    <blockquote class="text">
6358    <p>GET MIDI_INSTRUMENT_MAPS
6359    </p>
6360    </blockquote><p>
6361                        
6362    </p>
6363    <p>Possible Answers:
6364    </p>
6365    <p>
6366                            </p>
6367    <blockquote class="text">
6368    <p>The sampler will answer by returning the current
6369                                number of MIDI instrument maps.
6370    </p>
6371    </blockquote><p>
6372                        
6373    </p>
6374    <p>Example:
6375    </p>
6376    <p>
6377                            </p>
6378    <blockquote class="text">
6379    <p>C: "GET MIDI_INSTRUMENT_MAPS"
6380    </p>
6381    <p>S: "2"
6382    </p>
6383    </blockquote><p>
6384                        
6385    </p>
6386    <a name="LIST MIDI_INSTRUMENT_MAPS"></a><br /><hr />
6387    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6388    <a name="rfc.section.6.7.4"></a><h3>6.7.4.&nbsp;
6389    Getting all created MIDI instrument maps</h3>
6390    
6391    <p>The number of MIDI instrument maps can change on runtime. To get the
6392                        current list of MIDI instrument maps, the front-end can send the
6393                        following command:
6394    </p>
6395    <p>
6396                            </p>
6397    <blockquote class="text">
6398    <p>LIST MIDI_INSTRUMENT_MAPS
6399    </p>
6400    </blockquote><p>
6401                        
6402    </p>
6403    <p>Possible Answers:
6404    </p>
6405    <p>
6406                            </p>
6407    <blockquote class="text">
6408    <p>The sampler will answer by returning a comma separated list
6409                                with all MIDI instrument maps' numerical IDs.
6410    </p>
6411    </blockquote><p>
6412                        
6413    </p>
6414    <p>Example:
6415    </p>
6416    <p>
6417                            </p>
6418    <blockquote class="text">
6419    <p>C: "LIST MIDI_INSTRUMENT_MAPS"
6420    </p>
6421    <p>S: "0,1,5,12"
6422    </p>
6423    </blockquote><p>
6424                        
6425    </p>
6426    <a name="GET MIDI_INSTRUMENT_MAP INFO"></a><br /><hr />
6427    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6428    <a name="rfc.section.6.7.5"></a><h3>6.7.5.&nbsp;
6429    Getting MIDI instrument map information</h3>
6430    
6431    <p>The front-end can ask for the current settings of a MIDI
6432                        instrument map by sending the following command:
6433    </p>
6434    <p>
6435                            </p>
6436    <blockquote class="text">
6437    <p>GET MIDI_INSTRUMENT_MAP INFO &lt;map&gt;
6438    </p>
6439    </blockquote><p>
6440                        
6441    </p>
6442    <p>Where &lt;map&gt; is the numerical ID of the map the
6443                        front-end is interested in as returned by the
6444                        <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>
6445                        command.
6446    </p>
6447    <p>Possible Answers:
6448    </p>
6449    <p>
6450                            </p>
6451    <blockquote class="text">
6452    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6453                                Each answer line begins with the settings category name
6454                                followed by a colon and then a space character &lt;SP&gt; and finally
6455                                the info character string to that setting category. At the
6456                                moment the following categories are defined:
6457    </p>
6458    <p>
6459                                    </p>
6460    <blockquote class="text">
6461    <p>NAME -
6462                                            </p>
6463    <blockquote class="text">
6464    <p>custom name of the given map,
6465                                                which does not have to be unique
6466    </p>
6467    </blockquote>
6468                                        
6469    
6470    <p>DEFAULT -
6471                                            </p>
6472    <blockquote class="text">
6473    <p>either true or false,
6474                                                defines whether this map is the default map
6475    </p>
6476    </blockquote>
6477                                        
6478    
6479    </blockquote>
6480                                
6481    
6482    </blockquote><p>
6483                        
6484    </p>
6485    <p>The mentioned fields above don't have to be in particular order.
6486    </p>
6487    <p>Example:
6488    </p>
6489    <p>
6490                            </p>
6491    <blockquote class="text">
6492    <p>C: "GET MIDI_INSTRUMENT_MAP INFO 0"
6493    </p>
6494    <p>S: "NAME: Standard Map"
6495    </p>
6496    <p>&nbsp;&nbsp;&nbsp;"DEFAULT: true"
6497    </p>
6498    <p>&nbsp;&nbsp;&nbsp;"."
6499    </p>
6500    </blockquote><p>
6501                        
6502    </p>
6503    <a name="SET MIDI_INSTRUMENT_MAP NAME"></a><br /><hr />
6504    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6505    <a name="rfc.section.6.7.6"></a><h3>6.7.6.&nbsp;
6506    Renaming a MIDI instrument map</h3>
6507    
6508    <p>The front-end can alter the custom name of a MIDI
6509                        instrument map by sending the following command:
6510    </p>
6511    <p>
6512                            </p>
6513    <blockquote class="text">
6514    <p>SET MIDI_INSTRUMENT_MAP NAME &lt;map&gt; &lt;name&gt;
6515    </p>
6516    </blockquote><p>
6517                        
6518    </p>
6519    <p>Where &lt;map&gt; is the numerical ID of the map and
6520                        &lt;name&gt; the new custom name of the map, which does not
6521                        have to be unique.
6522    </p>
6523    <p>Possible Answers:
6524    </p>
6525    <p>
6526                            </p>
6527    <blockquote class="text">
6528    <p>"OK" -
6529                                    </p>
6530    <blockquote class="text">
6531    <p>on success
6532    </p>
6533    </blockquote>
6534                                
6535    
6536    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6537                                    </p>
6538    <blockquote class="text">
6539    <p>in case the given map does not exist
6540    </p>
6541    </blockquote>
6542                                
6543    
6544    </blockquote><p>
6545                        
6546    </p>
6547    <p>Example:
6548    </p>
6549    <p>
6550                            </p>
6551    <blockquote class="text">
6552    <p>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
6553    </p>
6554    <p>S: "OK"
6555    </p>
6556    </blockquote><p>
6557                        
6558    </p>
6559    <a name="MAP MIDI_INSTRUMENT"></a><br /><hr />
6560    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6561    <a name="rfc.section.6.7.7"></a><h3>6.7.7.&nbsp;
6562    Create or replace a MIDI instrument map entry</h3>
6563    
6564    <p>The front-end can create a new or replace an existing entry
6565                        in a sampler's MIDI instrument map by sending the following
6566                        command:
6567    </p>
6568    <p>
6569                            </p>
6570    <blockquote class="text">
6571    <p>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
6572                                &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
6573                                &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
6574                                [&lt;instr_load_mode&gt;] [&lt;name&gt;]
6575    </p>
6576    </blockquote><p>
6577                        
6578    </p>
6579    <p>Where &lt;map&gt; is the numeric ID of the map to alter,
6580                        &lt;midi_bank&gt; is an integer value between
6581                        0..16383 reflecting the MIDI bank select index,
6582                        &lt;midi_prog&gt; an
6583                        integer value between 0..127 reflecting the MIDI program change
6584                        index, &lt;engine_name&gt; a sampler engine name as returned by
6585                        the <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a>
6586                        command (not encapsulated into apostrophes), &lt;filename&gt; the name
6587                        of the instrument's file to be deployed (encapsulated into apostrophes),
6588                        &lt;instrument_index&gt; the index (integer value) of the instrument
6589                        within the given file, &lt;volume_value&gt; reflects the master
6590                        volume of the instrument as optionally dotted number (where a
6591                        value &lt; 1.0 means attenuation and a value > 1.0 means
6592                        amplification). This parameter easily allows to adjust the
6593                        volume of all intruments within a custom instrument map
6594                        without having to adjust their instrument files. The
6595                        OPTIONAL &lt;instr_load_mode&gt; argument defines the life
6596                        time of the instrument, that is when the instrument should
6597                        be loaded, when freed and has exactly the following
6598                        possibilities:
6599    </p>
6600    <p>
6601                            </p>
6602    <blockquote class="text">
6603    <p>"ON_DEMAND" -
6604                                    </p>
6605    <blockquote class="text">
6606    <p>The instrument will be loaded when needed,
6607                                        that is when demanded by at least one sampler
6608                                        channel. It will immediately be freed from memory
6609                                        when not needed by any sampler channel anymore.
6610    </p>
6611    </blockquote>
6612                                
6613    
6614    <p>"ON_DEMAND_HOLD" -
6615                                    </p>
6616    <blockquote class="text">
6617    <p>The instrument will be loaded when needed,
6618                                        that is when demanded by at least one sampler
6619                                        channel. It will be kept in memory even when
6620                                        not needed by any sampler channel anymore.
6621                                        Instruments with this mode are only freed
6622                                        when the sampler is reset or all mapping
6623                                        entries with this mode (and respective
6624                                        instrument) are explicitly changed to
6625                                        "ON_DEMAND" and no sampler channel is using
6626                                        the instrument anymore.
6627    </p>
6628    </blockquote>
6629                                
6630    
6631    <p>"PERSISTENT" -
6632                                    </p>
6633    <blockquote class="text">
6634    <p>The instrument will immediately be loaded
6635                                        into memory when this mapping
6636                                        command is sent and the instrument is kept all
6637                                        the time. Instruments with this mode are
6638                                        only freed when the sampler is reset or all
6639                                        mapping entries with this mode (and
6640                                        respective instrument) are explicitly
6641                                        changed to "ON_DEMAND" and no sampler
6642                                        channel is using the instrument anymore.
6643    </p>
6644    </blockquote>
6645                                
6646    
6647    <p>not supplied -
6648                                    </p>
6649    <blockquote class="text">
6650    <p>In case there is no &lt;instr_load_mode&gt;
6651                                        argument given, it will be up to the
6652                                        InstrumentManager to decide which mode to use.
6653                                        Usually it will use "ON_DEMAND" if an entry
6654                                        for the given instrument does not exist in
6655                                        the InstrumentManager's list yet, otherwise
6656                                        if an entry already exists, it will simply
6657                                        stick with the mode currently reflected by
6658                                        the already existing entry, that is it will
6659                                        not change the mode.
6660    </p>
6661    </blockquote>
6662                                
6663    
6664    </blockquote><p>
6665                        
6666    </p>
6667    <p>
6668                        The &lt;instr_load_mode&gt; argument thus allows to define an
6669                        appropriate strategy (low memory consumption vs. fast
6670                        instrument switching) for each instrument individually. Note, the
6671                        following restrictions apply to this argument: "ON_DEMAND_HOLD" and
6672                        "PERSISTENT" have to be supported by the respective sampler engine
6673                        (which is technically the case when the engine provides an
6674                        InstrumentManager for its format). If this is not the case the
6675                        argument will automatically fall back to the default value
6676                        "ON_DEMAND". Also the load mode of one instrument may
6677                        automatically change the laod mode of other instrument(s), i.e.
6678                        because the instruments are part of the same file and the
6679                        engine does not allow a way to manage load modes for them
6680                        individually. Due to this, in case the frontend shows the
6681                        load modes of entries, the frontend should retrieve the actual
6682                        mode by i.e. sending
6683                        <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>
6684                        command(s). Finally the OPTIONAL &lt;name&gt; argument allows to
6685                        set a custom name (encapsulated into apostrophes) for the mapping
6686                        entry, useful for frontends for displaying an appropriate name for
6687                        mapped instruments (using
6688                        <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>).
6689                        
6690    </p>
6691    <p>
6692                        By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
6693                        completely established in the sampler. The OPTIONAL "NON_MODAL" argument
6694                        however causes the respective "MAP MIDI_INSTRUMENT" command to return
6695                        immediately, that is to let the sampler establish the mapping in the
6696                        background. So this argument might be especially useful for mappings with
6697                        a "PERSISTENT" type, because these have to load the respective instruments
6698                        immediately and might thus block for a very long time. It is recommended
6699                        however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
6700                        because it has the following drawbacks: as "NON_MODAL" instructions return
6701                        immediately, they may not necessarily return an error i.e. when the given
6702                        instrument file turns out to be corrupt, beside that subsequent commands
6703                        in a LSCP instruction sequence might fail, because mandatory mappings are
6704                        not yet completed.
6705                        
6706    </p>
6707    <p>Possible Answers:
6708    </p>
6709    <p>
6710                            </p>
6711    <blockquote class="text">
6712    <p>"OK" -
6713                                    </p>
6714    <blockquote class="text">
6715    <p>usually
6716    </p>
6717    </blockquote>
6718                                
6719    
6720    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6721                                    </p>
6722    <blockquote class="text">
6723    <p>when the given map or engine does not exist or a value
6724                                        is out of range
6725    </p>
6726    </blockquote>
6727                                
6728    
6729    </blockquote><p>
6730                        
6731    </p>
6732    <p>Examples:
6733    </p>
6734    <p>
6735                            </p>
6736    <blockquote class="text">
6737    <p>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"
6738    </p>
6739    <p>S: "OK"
6740    </p>
6741    </blockquote><p>
6742                        
6743    </p>
6744    <p>
6745                            </p>
6746    <blockquote class="text">
6747    <p>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"
6748    </p>
6749    <p>S: "OK"
6750    </p>
6751    </blockquote><p>
6752                        
6753    </p>
6754    <p>
6755                            </p>
6756    <blockquote class="text">
6757    <p>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"
6758    </p>
6759    <p>S: "OK"
6760    </p>
6761    <p>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"
6762    </p>
6763    <p>S: "OK"
6764    </p>
6765    </blockquote><p>
6766                        
6767    </p>
6768    <p>
6769                            </p>
6770    <blockquote class="text">
6771    <p>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
6772    </p>
6773    <p>S: "OK"
6774    </p>
6775    </blockquote><p>
6776                        
6777    </p>
6778    <a name="GET MIDI_INSTRUMENTS"></a><br /><hr />
6779    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6780    <a name="rfc.section.6.7.8"></a><h3>6.7.8.&nbsp;
6781    Getting ammount of MIDI instrument map entries</h3>
6782    
6783    <p>The front-end can query the amount of currently existing
6784                        entries in a MIDI instrument map by sending the following
6785                        command:
6786    </p>
6787    <p>
6788                            </p>
6789    <blockquote class="text">
6790    <p>GET MIDI_INSTRUMENTS &lt;map&gt;
6791    </p>
6792    </blockquote><p>
6793                        
6794    </p>
6795    <p>The front-end can query the amount of currently existing
6796                        entries in all MIDI instrument maps by sending the following
6797                        command:
6798    </p>
6799    <p>
6800                            </p>
6801    <blockquote class="text">
6802    <p>GET MIDI_INSTRUMENTS ALL
6803    </p>
6804    </blockquote><p>
6805                        
6806    </p>
6807    <p>Possible Answers:
6808    </p>
6809    <p>
6810                            </p>
6811    <blockquote class="text">
6812    <p>The sampler will answer by sending the current number of
6813                                entries in the MIDI instrument map(s).
6814    </p>
6815    </blockquote><p>
6816                        
6817    </p>
6818    <p>Example:
6819    </p>
6820    <p>
6821                            </p>
6822    <blockquote class="text">
6823    <p>C: "GET MIDI_INSTRUMENTS 0"
6824    </p>
6825    <p>S: "234"
6826    </p>
6827    </blockquote><p>
6828                        
6829    </p>
6830    <p>
6831                            </p>
6832    <blockquote class="text">
6833    <p>C: "GET MIDI_INSTRUMENTS ALL"
6834    </p>
6835    <p>S: "954"
6836    </p>
6837    </blockquote><p>
6838                        
6839    </p>
6840    <a name="LIST MIDI_INSTRUMENTS"></a><br /><hr />
6841    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6842    <a name="rfc.section.6.7.9"></a><h3>6.7.9.&nbsp;
6843    Getting indeces of all entries of a MIDI instrument map</h3>
6844    
6845    <p>The front-end can query a list of all currently existing
6846                        entries in a certain MIDI instrument map by sending the following
6847                        command:
6848    </p>
6849    <p>
6850                            </p>
6851    <blockquote class="text">
6852    <p>LIST MIDI_INSTRUMENTS &lt;map&gt;
6853    </p>
6854    </blockquote><p>
6855                        
6856    </p>
6857    <p>Where &lt;map&gt; is the numeric ID of the MIDI instrument map.
6858    </p>
6859    <p>The front-end can query a list of all currently existing
6860                        entries of all MIDI instrument maps by sending the following
6861                        command:
6862    </p>
6863    <p>
6864                            </p>
6865    <blockquote class="text">
6866    <p>LIST MIDI_INSTRUMENTS ALL
6867    </p>
6868    </blockquote><p>
6869                        
6870    </p>
6871    <p>Possible Answers:
6872    </p>
6873    <p>
6874                            </p>
6875    <blockquote class="text">
6876    <p>The sampler will answer by sending a comma separated
6877                                list of map ID - MIDI bank - MIDI program triples, where
6878                                each triple is encapsulated into curly braces. The
6879                                list is returned in one single line. Each triple
6880                                just reflects the key of the respective map entry,
6881                                thus subsequent
6882                                <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>
6883                                command(s) are necessary to retrieve detailed informations
6884                                about each entry.
6885    </p>
6886    </blockquote><p>
6887                        
6888    </p>
6889    <p>Example:
6890    </p>
6891    <p>
6892                            </p>
6893    <blockquote class="text">
6894    <p>C: "LIST MIDI_INSTRUMENTS 0"
6895    </p>
6896    <p>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
6897    </p>
6898    </blockquote><p>
6899                        
6900    </p>
6901    <a name="UNMAP MIDI_INSTRUMENT"></a><br /><hr />
6902    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6903    <a name="rfc.section.6.7.10"></a><h3>6.7.10.&nbsp;
6904    Remove an entry from the MIDI instrument map</h3>
6905    
6906    <p>The front-end can delete an entry from a MIDI instrument
6907                        map by sending the following command:
6908    </p>
6909    <p>
6910                            </p>
6911    <blockquote class="text">
6912    <p>UNMAP MIDI_INSTRUMENT &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;
6913    </p>
6914    </blockquote><p>
6915                        
6916    </p>
6917    <p>
6918                        Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
6919                        &lt;midi_bank&gt; is an integer value between 0..16383
6920                        reflecting the MIDI bank value and
6921                        &lt;midi_prog&gt; an integer value between
6922                        0..127 reflecting the MIDI program value of the map's entrie's key
6923                        index triple.
6924                        
6925    </p>
6926    <p>Possible Answers:
6927    </p>
6928    <p>
6929                            </p>
6930    <blockquote class="text">
6931    <p>"OK" -
6932                                    </p>
6933    <blockquote class="text">
6934    <p>usually
6935    </p>
6936    </blockquote>
6937                                
6938    
6939    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6940                                    </p>
6941    <blockquote class="text">
6942    <p>when index out of bounds
6943    </p>
6944    </blockquote>
6945                                
6946    
6947    </blockquote><p>
6948                        
6949    </p>
6950    <p>Example:
6951    </p>
6952    <p>
6953                            </p>
6954    <blockquote class="text">
6955    <p>C: "UNMAP MIDI_INSTRUMENT 0 2 127"
6956    </p>
6957    <p>S: "OK"
6958    </p>
6959    </blockquote><p>
6960                        
6961    </p>
6962    <a name="GET MIDI_INSTRUMENT INFO"></a><br /><hr />
6963    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6964    <a name="rfc.section.6.7.11"></a><h3>6.7.11.&nbsp;
6965    Get current settings of MIDI instrument map entry</h3>
6966    
6967    <p>The front-end can retrieve the current settings of a certain
6968                        instrument map entry by sending the following command:
6969    </p>
6970    <p>
6971                            </p>
6972    <blockquote class="text">
6973    <p>GET MIDI_INSTRUMENT INFO &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;
6974    </p>
6975    </blockquote><p>
6976                        
6977    </p>
6978    <p>
6979                        Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
6980                        &lt;midi_bank&gt; is an integer value between 0..16383
6981                        reflecting the MIDI bank value, &lt;midi_bank&gt;
6982                        and &lt;midi_prog&gt; an integer value between
6983                        0..127 reflecting the MIDI program value of the map's entrie's key
6984                        index triple.
6985                        
6986    </p>
6987    <p>Possible Answers:
6988    </p>
6989    <p>
6990                            </p>
6991    <blockquote class="text">
6992    <p>LinuxSampler will answer by sending a &lt;CRLF&gt;
6993                                separated list. Each answer line begins with the
6994                                information category name followed by a colon and then
6995                                a space character &lt;SP&gt; and finally the info
6996                                character string to that info category. At the moment
6997                                the following categories are defined:
6998    </p>
6999    <p>"NAME" -
7000                                    </p>
7001    <blockquote class="text">
7002    <p>Name for this MIDI instrument map entry (if defined).
7003                                        This name shall be used by frontends for displaying a
7004                                        name for this mapped instrument. It can be set and
7005                                        changed with the
7006                                        <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>
7007                                        command and does not have to be unique.
7008    </p>
7009    </blockquote>
7010                                
7011    
7012    <p>"ENGINE_NAME" -
7013                                    </p>
7014    <blockquote class="text">
7015    <p>Name of the engine to be deployed for this
7016                                        instrument.
7017    </p>
7018    </blockquote>
7019                                
7020    
7021    <p>"INSTRUMENT_FILE" -
7022                                    </p>
7023    <blockquote class="text">
7024    <p>File name of the instrument.
7025    </p>
7026    </blockquote>
7027                                
7028    
7029    <p>"INSTRUMENT_NR" -
7030                                    </p>
7031    <blockquote class="text">
7032    <p>Index of the instrument within the file.
7033    </p>
7034    </blockquote>
7035                                
7036    
7037    <p>"INSTRUMENT_NAME" -
7038                                    </p>
7039    <blockquote class="text">
7040    <p>Name of the loaded instrument as reflected by its file.
7041                                        In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
7042                                        cannot be changed.
7043    </p>
7044    </blockquote>
7045                                
7046    
7047    <p>"LOAD_MODE" -
7048                                    </p>
7049    <blockquote class="text">
7050    <p>Life time of instrument
7051                                        (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).
7052    </p>
7053    </blockquote>
7054                                
7055    
7056    <p>"VOLUME" -
7057                                    </p>
7058    <blockquote class="text">
7059    <p>master volume of the instrument as optionally
7060                                        dotted number (where a value &lt; 1.0 means attenuation
7061                                        and a value > 1.0 means amplification)
7062    </p>
7063    </blockquote>
7064                                
7065    
7066    <p>The mentioned fields above don't have to be in particular order.
7067    </p>
7068    </blockquote><p>
7069                        
7070    </p>
7071    <p>Example:
7072    </p>
7073    <p>
7074                            </p>
7075    <blockquote class="text">
7076    <p>C: "GET MIDI_INSTRUMENT INFO 1 45 120"
7077    </p>
7078    <p>S: "NAME: Drums for Foo Song"
7079    </p>
7080    <p>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"
7081    </p>
7082    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
7083    </p>
7084    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"
7085    </p>
7086    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Joe's Drumkit"
7087    </p>
7088    <p>&nbsp;&nbsp;&nbsp;"LOAD_MODE: PERSISTENT"
7089    </p>
7090    <p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
7091    </p>
7092    <p>&nbsp;&nbsp;&nbsp;"."
7093    </p>
7094    </blockquote><p>
7095                        
7096    </p>
7097    <a name="CLEAR MIDI_INSTRUMENTS"></a><br /><hr />
7098    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7099    <a name="rfc.section.6.7.12"></a><h3>6.7.12.&nbsp;
7100    Clear MIDI instrument map</h3>
7101    
7102    <p>The front-end can clear a whole MIDI instrument map, that
7103                        is delete all its entries by sending the following command:
7104    </p>
7105    <p>
7106                            </p>
7107    <blockquote class="text">
7108    <p>CLEAR MIDI_INSTRUMENTS &lt;map&gt;
7109    </p>
7110    </blockquote><p>
7111                        
7112    </p>
7113    <p>Where &lt;map&gt; is the numeric ID of the map to clear.
7114    </p>
7115    <p>The front-end can clear all MIDI instrument maps, that
7116                        is delete all entries of all maps by sending the following
7117                        command:
7118    </p>
7119    <p>
7120                            </p>
7121    <blockquote class="text">
7122    <p>CLEAR MIDI_INSTRUMENTS ALL
7123    </p>
7124    </blockquote><p>
7125                        
7126    </p>
7127    <p>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the
7128                        maps, only their entries, thus the map's settings like
7129                        custom name will be preservevd.
7130    </p>
7131    <p>Possible Answers:
7132    </p>
7133    <p>
7134                            </p>
7135    <blockquote class="text">
7136    <p>"OK" -
7137                                    </p>
7138    <blockquote class="text">
7139    <p>always
7140    </p>
7141    </blockquote>
7142                                
7143    
7144    </blockquote><p>
7145                        
7146    </p>
7147    <p>Examples:
7148    </p>
7149    <p>
7150                           </p>
7151    <blockquote class="text">
7152    <p>C: "CLEAR MIDI_INSTRUMENTS 0"
7153    </p>
7154    <p>S: "OK"
7155    </p>
7156    </blockquote><p>
7157                        
7158    </p>
7159    <p>
7160                           </p>
7161    <blockquote class="text">
7162    <p>C: "CLEAR MIDI_INSTRUMENTS ALL"
7163    </p>
7164    <p>S: "OK"
7165    </p>
7166    </blockquote><p>
7167                        
7168    </p>
7169  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
7170  <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>
7171  <a name="rfc.section.7"></a><h3>7.&nbsp;Command Syntax</h3>  <a name="rfc.section.7"></a><h3>7.&nbsp;
7172    Command Syntax</h3>
7173    
7174  <p>The grammar of the control protocol as descibed in <a class="info" href="#control_commands">Section&nbsp;6<span> (</span><span class="info">Description for control commands</span><span>)</span></a>  <p>The grammar of the control protocol as descibed in <a class='info' href='#control_commands'>Section&nbsp;6<span> (</span><span class='info'>Description for control commands</span><span>)</span></a>
7175              is defined below using Backus-Naur Form (BNF as described in <a class="info" href="#RFC2234">[RFC2234]<span> (</span><span class="info">Crocker, D. and P. Overell, &ldquo;Augmented BNF for Syntax Specifications,&rdquo; 1997.</span><span>)</span></a>)              is defined below using Backus-Naur Form (BNF as described in <a class='info' href='#RFC2234'>[RFC2234]<span> (</span><span class='info'>Crocker, D. and P. Overell, &ldquo;Augmented BNF for Syntax Specifications,&rdquo; 1997.</span><span>)</span></a>)
7176              where applicable.              where applicable.
7177                            
7178  </p>  </p>
# Line 5201  Intellectual Property and Copyright Stat Line 7230  Intellectual Property and Copyright Stat
7230  <p>command =  <p>command =
7231          </p>          </p>
7232  <blockquote class="text">  <blockquote class="text">
7233  <p>ADD SP CHANNEL  <p>ADD SP add_instruction
7234                    
7235    </p>
7236    <p>/ MAP SP map_instruction
7237                    
7238    </p>
7239    <p>/ UNMAP SP unmap_instruction
7240                                    
7241  </p>  </p>
7242  <p>/ GET SP get_instruction  <p>/ GET SP get_instruction
# Line 5219  Intellectual Property and Copyright Stat Line 7254  Intellectual Property and Copyright Stat
7254  <p>/ LOAD SP load_instruction  <p>/ LOAD SP load_instruction
7255                                    
7256  </p>  </p>
7257  <p>/ REMOVE SP CHANNEL SP sampler_channel  <p>/ REMOVE SP remove_instruction
7258                                    
7259  </p>  </p>
7260  <p>/ SET SP set_instruction  <p>/ SET SP set_instruction
# Line 5234  Intellectual Property and Copyright Stat Line 7269  Intellectual Property and Copyright Stat
7269  <p>/ SELECT SP text  <p>/ SELECT SP text
7270                                    
7271  </p>  </p>
7272  <p>/ RESET SP CHANNEL SP sampler_channel  <p>/ RESET SP reset_instruction
7273                    
7274    </p>
7275    <p>/ CLEAR SP clear_instruction
7276                                    
7277  </p>  </p>
7278  <p>/ RESET  <p>/ RESET
# Line 5246  Intellectual Property and Copyright Stat Line 7284  Intellectual Property and Copyright Stat
7284  </blockquote><p>  </blockquote><p>
7285    
7286  </p>  </p>
7287    <p>add_instruction =
7288            </p>
7289    <blockquote class="text">
7290    <p>CHANNEL
7291                    
7292    </p>
7293    <p>/ MIDI_INSTRUMENT_MAP
7294                    
7295    </p>
7296    <p>/ MIDI_INSTRUMENT_MAP SP map_name
7297                    
7298    </p>
7299    </blockquote><p>
7300    
7301    </p>
7302  <p>subscribe_event =  <p>subscribe_event =
7303          </p>          </p>
7304  <blockquote class="text">  <blockquote class="text">
7305  <p>CHANNEL_COUNT  <p>AUDIO_OUTPUT_DEVICE_COUNT
7306                    
7307    </p>
7308    <p>/ AUDIO_OUTPUT_DEVICE_INFO
7309                    
7310    </p>
7311    <p>/ MIDI_INPUT_DEVICE_COUNT
7312                    
7313    </p>
7314    <p>/ MIDI_INPUT_DEVICE_INFO
7315                    
7316    </p>
7317    <p>/ CHANNEL_COUNT
7318                                    
7319  </p>  </p>
7320  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
# Line 5264  Intellectual Property and Copyright Stat Line 7329  Intellectual Property and Copyright Stat
7329  <p>/ CHANNEL_INFO  <p>/ CHANNEL_INFO
7330                                    
7331  </p>  </p>
7332    <p>/ FX_SEND_COUNT
7333                    
7334    </p>
7335    <p>/ FX_SEND_INFO
7336                    
7337    </p>
7338    <p>/ MIDI_INSTRUMENT_MAP_COUNT
7339                    
7340    </p>
7341    <p>/ MIDI_INSTRUMENT_MAP_INFO
7342                    
7343    </p>
7344    <p>/ MIDI_INSTRUMENT_COUNT
7345                    
7346    </p>
7347    <p>/ MIDI_INSTRUMENT_INFO
7348                    
7349    </p>
7350  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
7351                                    
7352  </p>  </p>
7353  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
7354                                    
7355  </p>  </p>
7356    <p>/ GLOBAL_INFO
7357                    
7358    </p>
7359  </blockquote><p>  </blockquote><p>
7360    
7361  </p>  </p>
7362  <p>unsubscribe_event =  <p>unsubscribe_event =
7363          </p>          </p>
7364  <blockquote class="text">  <blockquote class="text">
7365  <p>CHANNEL_COUNT  <p>AUDIO_OUTPUT_DEVICE_COUNT
7366                    
7367    </p>
7368    <p>/ AUDIO_OUTPUT_DEVICE_INFO
7369                    
7370    </p>
7371    <p>/ MIDI_INPUT_DEVICE_COUNT
7372                    
7373    </p>
7374    <p>/ MIDI_INPUT_DEVICE_INFO
7375                    
7376    </p>
7377    <p>/ CHANNEL_COUNT
7378                                    
7379  </p>  </p>
7380  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
# Line 5291  Intellectual Property and Copyright Stat Line 7389  Intellectual Property and Copyright Stat
7389  <p>/ CHANNEL_INFO  <p>/ CHANNEL_INFO
7390                                    
7391  </p>  </p>
7392    <p>/ FX_SEND_COUNT
7393                    
7394    </p>
7395    <p>/ FX_SEND_INFO
7396                    
7397    </p>
7398    <p>/ MIDI_INSTRUMENT_MAP_COUNT
7399                    
7400    </p>
7401    <p>/ MIDI_INSTRUMENT_MAP_INFO
7402                    
7403    </p>
7404    <p>/ MIDI_INSTRUMENT_COUNT
7405                    
7406    </p>
7407    <p>/ MIDI_INSTRUMENT_INFO
7408                    
7409    </p>
7410  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
7411                                    
7412  </p>  </p>
7413  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
7414                                    
7415  </p>  </p>
7416    <p>/ GLOBAL_INFO
7417                    
7418    </p>
7419    </blockquote><p>
7420    
7421    </p>
7422    <p>map_instruction =
7423            </p>
7424    <blockquote class="text">
7425    <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
7426                    
7427    </p>
7428    <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
7429                    
7430    </p>
7431    <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
7432                    
7433    </p>
7434    <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
7435                    
7436    </p>
7437    </blockquote><p>
7438    
7439    </p>
7440    <p>unmap_instruction =
7441            </p>
7442    <blockquote class="text">
7443    <p>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
7444                    
7445    </p>
7446    </blockquote><p>
7447    
7448    </p>
7449    <p>remove_instruction =
7450            </p>
7451    <blockquote class="text">
7452    <p>CHANNEL SP sampler_channel
7453                    
7454    </p>
7455    <p>/ MIDI_INSTRUMENT_MAP SP midi_map
7456                    
7457    </p>
7458    <p>/ MIDI_INSTRUMENT_MAP SP ALL
7459                    
7460    </p>
7461  </blockquote><p>  </blockquote><p>
7462    
7463  </p>  </p>
# Line 5381  Intellectual Property and Copyright Stat Line 7542  Intellectual Property and Copyright Stat
7542  <p>/ TOTAL_VOICE_COUNT_MAX  <p>/ TOTAL_VOICE_COUNT_MAX
7543                                    
7544  </p>  </p>
7545    <p>/ MIDI_INSTRUMENTS SP midi_map
7546                    
7547    </p>
7548    <p>/ MIDI_INSTRUMENTS SP ALL
7549                    
7550    </p>
7551    <p>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
7552                    
7553    </p>
7554    <p>/ MIDI_INSTRUMENT_MAPS
7555                    
7556    </p>
7557    <p>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
7558                    
7559    </p>
7560    <p>/ FX_SENDS SP sampler_channel
7561                    
7562    </p>
7563    <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
7564                    
7565    </p>
7566    <p>/ VOLUME
7567                    
7568    </p>
7569  </blockquote><p>  </blockquote><p>
7570    
7571  </p>  </p>
# Line 5402  Intellectual Property and Copyright Stat Line 7587  Intellectual Property and Copyright Stat
7587  <p>/ CHANNEL SP set_chan_instruction  <p>/ CHANNEL SP set_chan_instruction
7588                                    
7589  </p>  </p>
7590    <p>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
7591                    
7592    </p>
7593    <p>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
7594                    
7595    </p>
7596    <p>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
7597                    
7598    </p>
7599    <p>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
7600                    
7601    </p>
7602    <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
7603                    
7604    </p>
7605  <p>/ ECHO SP boolean  <p>/ ECHO SP boolean
7606                                    
7607  </p>  </p>
7608    <p>/ VOLUME SP volume_value
7609                    
7610    </p>
7611  </blockquote><p>  </blockquote><p>
7612    
7613  </p>  </p>
# Line 5423  Intellectual Property and Copyright Stat Line 7626  Intellectual Property and Copyright Stat
7626  <p>/ MIDI_INPUT_DEVICE SP string  <p>/ MIDI_INPUT_DEVICE SP string
7627                                    
7628  </p>  </p>
7629    <p>/ FX_SEND SP sampler_channel SP midi_ctrl
7630                    
7631    </p>
7632    <p>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
7633                    
7634    </p>
7635    </blockquote><p>
7636    
7637    </p>
7638    <p>reset_instruction =
7639            </p>
7640    <blockquote class="text">
7641    <p>CHANNEL SP sampler_channel
7642                    
7643    </p>
7644    </blockquote><p>
7645    
7646    </p>
7647    <p>clear_instruction =
7648            </p>
7649    <blockquote class="text">
7650    <p>MIDI_INSTRUMENTS SP midi_map
7651                    
7652    </p>
7653    <p>/ MIDI_INSTRUMENTS SP ALL
7654                    
7655    </p>
7656  </blockquote><p>  </blockquote><p>
7657    
7658  </p>  </p>
# Line 5435  Intellectual Property and Copyright Stat Line 7665  Intellectual Property and Copyright Stat
7665  <p>/ MIDI_INPUT_DEVICE SP number  <p>/ MIDI_INPUT_DEVICE SP number
7666                                    
7667  </p>  </p>
7668    <p>/ FX_SEND SP sampler_channel SP fx_send_id
7669                    
7670    </p>
7671  </blockquote><p>  </blockquote><p>
7672    
7673  </p>  </p>
# Line 5486  Intellectual Property and Copyright Stat Line 7719  Intellectual Property and Copyright Stat
7719  <p>/ SOLO SP sampler_channel SP boolean  <p>/ SOLO SP sampler_channel SP boolean
7720                                    
7721  </p>  </p>
7722    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
7723                    
7724    </p>
7725    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
7726                    
7727    </p>
7728    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
7729                    
7730    </p>
7731    </blockquote><p>
7732    
7733    </p>
7734    <p>modal_arg =
7735            </p>
7736    <blockquote class="text">
7737    <p>/* epsilon (empty argument) */
7738                    
7739    </p>
7740    <p>/ NON_MODAL SP
7741                    
7742    </p>
7743  </blockquote><p>  </blockquote><p>
7744    
7745  </p>  </p>
# Line 5534  Intellectual Property and Copyright Stat Line 7788  Intellectual Property and Copyright Stat
7788  <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS  <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
7789                                    
7790  </p>  </p>
7791    <p>/ MIDI_INSTRUMENTS SP midi_map
7792                    
7793    </p>
7794    <p>/ MIDI_INSTRUMENTS SP ALL
7795                    
7796    </p>
7797    <p>/ MIDI_INSTRUMENT_MAPS
7798                    
7799    </p>
7800    <p>/ FX_SENDS SP sampler_channel
7801                    
7802    </p>
7803  </blockquote><p>  </blockquote><p>
7804    
7805  </p>  </p>
# Line 5558  Intellectual Property and Copyright Stat Line 7824  Intellectual Property and Copyright Stat
7824  </blockquote><p>  </blockquote><p>
7825    
7826  </p>  </p>
7827    <p>instr_load_mode =
7828            </p>
7829    <blockquote class="text">
7830    <p>ON_DEMAND
7831                    
7832    </p>
7833    <p>/ ON_DEMAND_HOLD
7834                    
7835    </p>
7836    <p>/ PERSISTENT
7837                    
7838    </p>
7839    </blockquote><p>
7840    
7841    </p>
7842  <p>device_index =  <p>device_index =
7843          </p>          </p>
7844  <blockquote class="text">  <blockquote class="text">
# Line 5615  Intellectual Property and Copyright Stat Line 7896  Intellectual Property and Copyright Stat
7896  </blockquote><p>  </blockquote><p>
7897    
7898  </p>  </p>
7899    <p>midi_map =
7900            </p>
7901    <blockquote class="text">
7902    <p>number
7903                    
7904    </p>
7905    </blockquote><p>
7906    
7907    </p>
7908    <p>midi_bank =
7909            </p>
7910    <blockquote class="text">
7911    <p>number
7912                    
7913    </p>
7914    </blockquote><p>
7915    
7916    </p>
7917    <p>midi_prog =
7918            </p>
7919    <blockquote class="text">
7920    <p>number
7921                    
7922    </p>
7923    </blockquote><p>
7924    
7925    </p>
7926    <p>midi_ctrl =
7927            </p>
7928    <blockquote class="text">
7929    <p>number
7930                    
7931    </p>
7932    </blockquote><p>
7933    
7934    </p>
7935  <p>volume_value =  <p>volume_value =
7936          </p>          </p>
7937  <blockquote class="text">  <blockquote class="text">
# Line 5645  Intellectual Property and Copyright Stat Line 7962  Intellectual Property and Copyright Stat
7962  </blockquote><p>  </blockquote><p>
7963    
7964  </p>  </p>
7965    <p>fx_send_id =
7966            </p>
7967    <blockquote class="text">
7968    <p>number
7969                    
7970    </p>
7971    </blockquote><p>
7972    
7973    </p>
7974  <p>engine_name =  <p>engine_name =
7975          </p>          </p>
7976  <blockquote class="text">  <blockquote class="text">
# Line 5663  Intellectual Property and Copyright Stat Line 7989  Intellectual Property and Copyright Stat
7989  </blockquote><p>  </blockquote><p>
7990    
7991  </p>  </p>
7992    <p>map_name =
7993            </p>
7994    <blockquote class="text">
7995    <p>stringval
7996                    
7997    </p>
7998    </blockquote><p>
7999    
8000    </p>
8001    <p>entry_name =
8002            </p>
8003    <blockquote class="text">
8004    <p>stringval
8005                    
8006    </p>
8007    </blockquote><p>
8008    
8009    </p>
8010    <p>fx_send_name =
8011            </p>
8012    <blockquote class="text">
8013    <p>stringval
8014                    
8015    </p>
8016    </blockquote><p>
8017    
8018    </p>
8019  <p>param_val_list =  <p>param_val_list =
8020          </p>          </p>
8021  <blockquote class="text">  <blockquote class="text">
# Line 5694  Intellectual Property and Copyright Stat Line 8047  Intellectual Property and Copyright Stat
8047    
8048  </p>  </p>
8049  <a name="events"></a><br /><hr />  <a name="events"></a><br /><hr />
8050  <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>
8051  <a name="rfc.section.8"></a><h3>8.&nbsp;Events</h3>  <a name="rfc.section.8"></a><h3>8.&nbsp;
8052    Events</h3>
8053    
8054  <p>This chapter will describe all currently defined events supported by LinuxSampler.  <p>This chapter will describe all currently defined events supported by LinuxSampler.
8055  </p>  </p>
8056  <a name="SUBSCRIBE CHANNEL"></a><br /><hr />  <a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"></a><br /><hr />
8057  <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>
8058  <a name="rfc.section.8.1"></a><h3>8.1.&nbsp;Number of sampler channels changed</h3>  <a name="rfc.section.8.1"></a><h3>8.1.&nbsp;
8059    Number of audio output devices changed</h3>
8060    
8061    <p>Client may want to be notified when the total number of audio output devices on the
8062                    back-end changes by issuing the following command:
8063    </p>
8064    <p>
8065                        </p>
8066    <blockquote class="text">
8067    <p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
8068    </p>
8069    </blockquote><p>
8070                    
8071    </p>
8072    <p>Server will start sending the following notification messages:
8073    </p>
8074    <p>
8075                        </p>
8076    <blockquote class="text">
8077    <p>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"
8078    </p>
8079    </blockquote><p>
8080                    
8081    </p>
8082    <p>where &lt;devices&gt; will be replaced by the new number
8083                    of audio output devices.
8084    </p>
8085    <a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"></a><br /><hr />
8086    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8087    <a name="rfc.section.8.2"></a><h3>8.2.&nbsp;
8088    Audio output device's settings changed</h3>
8089    
8090    <p>Client may want to be notified when changes were made to audio output devices on the
8091                    back-end by issuing the following command:
8092    </p>
8093    <p>
8094                        </p>
8095    <blockquote class="text">
8096    <p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
8097    </p>
8098    </blockquote><p>
8099                    
8100    </p>
8101    <p>Server will start sending the following notification messages:
8102    </p>
8103    <p>
8104                        </p>
8105    <blockquote class="text">
8106    <p>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"
8107    </p>
8108    </blockquote><p>
8109                    
8110    </p>
8111    <p>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
8112                    which settings has been changed. The front-end will have to send
8113                    the respective command to actually get the audio output device info. Because these messages
8114                    will be triggered by LSCP commands issued by other clients rather than real
8115                    time events happening on the server, it is believed that an empty notification
8116                    message is sufficient here.
8117    </p>
8118    <a name="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"></a><br /><hr />
8119    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8120    <a name="rfc.section.8.3"></a><h3>8.3.&nbsp;
8121    Number of MIDI input devices changed</h3>
8122    
8123    <p>Client may want to be notified when the total number of MIDI input devices on the
8124                    back-end changes by issuing the following command:
8125    </p>
8126    <p>
8127                        </p>
8128    <blockquote class="text">
8129    <p>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
8130    </p>
8131    </blockquote><p>
8132                    
8133    </p>
8134    <p>Server will start sending the following notification messages:
8135    </p>
8136    <p>
8137                        </p>
8138    <blockquote class="text">
8139    <p>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"
8140    </p>
8141    </blockquote><p>
8142                    
8143    </p>
8144    <p>where &lt;devices&gt; will be replaced by the new number
8145                    of MIDI input devices.
8146    </p>
8147    <a name="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"></a><br /><hr />
8148    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8149    <a name="rfc.section.8.4"></a><h3>8.4.&nbsp;
8150    MIDI input device's settings changed</h3>
8151    
8152    <p>Client may want to be notified when changes were made to MIDI input devices on the
8153                    back-end by issuing the following command:
8154    </p>
8155    <p>
8156                        </p>
8157    <blockquote class="text">
8158    <p>SUBSCRIBE MIDI_INPUT_DEVICE_INFO
8159    </p>
8160    </blockquote><p>
8161                    
8162    </p>
8163    <p>Server will start sending the following notification messages:
8164    </p>
8165    <p>
8166                        </p>
8167    <blockquote class="text">
8168    <p>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"
8169    </p>
8170    </blockquote><p>
8171                    
8172    </p>
8173    <p>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
8174                    which settings has been changed. The front-end will have to send
8175                    the respective command to actually get the MIDI input device info. Because these messages
8176                    will be triggered by LSCP commands issued by other clients rather than real
8177                    time events happening on the server, it is believed that an empty notification
8178                    message is sufficient here.
8179    </p>
8180    <a name="SUBSCRIBE CHANNEL_COUNT"></a><br /><hr />
8181    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8182    <a name="rfc.section.8.5"></a><h3>8.5.&nbsp;
8183    Number of sampler channels changed</h3>
8184    
8185  <p>Client may want to be notified when the total number of channels on the  <p>Client may want to be notified when the total number of channels on the
8186                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 5728  Intellectual Property and Copyright Stat Line 8207  Intellectual Property and Copyright Stat
8207                  of sampler channels.                  of sampler channels.
8208  </p>  </p>
8209  <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />
8210  <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>
8211  <a name="rfc.section.8.2"></a><h3>8.2.&nbsp;Number of active voices changed</h3>  <a name="rfc.section.8.6"></a><h3>8.6.&nbsp;
8212    Number of active voices changed</h3>
8213    
8214  <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
8215                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 5747  Intellectual Property and Copyright Stat Line 8227  Intellectual Property and Copyright Stat
8227  <p>  <p>
8228                      </p>                      </p>
8229  <blockquote class="text">  <blockquote class="text">
8230  <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;  <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"
8231  </p>  </p>
8232  </blockquote><p>  </blockquote><p>
8233                                    
# Line 5757  Intellectual Property and Copyright Stat Line 8237  Intellectual Property and Copyright Stat
8237                  active voices on that channel.                  active voices on that channel.
8238  </p>  </p>
8239  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />
8240  <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>
8241  <a name="rfc.section.8.3"></a><h3>8.3.&nbsp;Number of active disk streams changed</h3>  <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;
8242    Number of active disk streams changed</h3>
8243    
8244  <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
8245                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT
# Line 5786  Intellectual Property and Copyright Stat Line 8267  Intellectual Property and Copyright Stat
8267                  active disk streams on that channel.                  active disk streams on that channel.
8268  </p>  </p>
8269  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />
8270  <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>
8271  <a name="rfc.section.8.4"></a><h3>8.4.&nbsp;Disk stream buffer fill state changed</h3>  <a name="rfc.section.8.8"></a><h3>8.8.&nbsp;
8272    Disk stream buffer fill state changed</h3>
8273    
8274  <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
8275                  on the back-end changes by issuing the following command:                  on the back-end changes by issuing the following command:
# Line 5812  Intellectual Property and Copyright Stat Line 8294  Intellectual Property and Copyright Stat
8294  </p>  </p>
8295  <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
8296                  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
8297                  buffer fill data for this channel as described in <a class="info" href="#GET CHANNEL BUFFER_FILL">Section&nbsp;6.4.13<span> (</span><span class="info">Current fill state of disk stream buffers</span><span>)</span></a>                  buffer fill data for this channel as described in <a class='info' href='#GET CHANNEL BUFFER_FILL'>Section&nbsp;6.4.13<span> (</span><span class='info'>Current fill state of disk stream buffers</span><span>)</span></a>
8298                  as if the <a class="info" href="#GET CHANNEL BUFFER_FILL">"GET CHANNEL BUFFER_FILL PERCENTAGE"<span> (</span><span class="info">Current fill state of disk stream buffers</span><span>)</span></a> command was issued on this channel.                  as if the <a class='info' href='#GET CHANNEL BUFFER_FILL'>"GET CHANNEL BUFFER_FILL PERCENTAGE"<span> (</span><span class='info'>Current fill state of disk stream buffers</span><span>)</span></a> command was issued on this channel.
8299  </p>  </p>
8300  <a name="SUBSCRIBE INFO"></a><br /><hr />  <a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr />
8301  <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>
8302  <a name="rfc.section.8.5"></a><h3>8.5.&nbsp;Channel information changed</h3>  <a name="rfc.section.8.9"></a><h3>8.9.&nbsp;
8303    Channel information changed</h3>
8304    
8305  <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
8306                  back-end by issuing the following command:                  back-end by issuing the following command:
# Line 5847  Intellectual Property and Copyright Stat Line 8330  Intellectual Property and Copyright Stat
8330                  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
8331                  message is sufficient here.                  message is sufficient here.
8332  </p>  </p>
8333    <a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr />
8334    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8335    <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
8336    Number of effect sends changed</h3>
8337    
8338    <p>Client may want to be notified when the number of effect sends on
8339                    a particular sampler channel is changed by issuing the following command:
8340    </p>
8341    <p>
8342                        </p>
8343    <blockquote class="text">
8344    <p>SUBSCRIBE FX_SEND_COUNT
8345    </p>
8346    </blockquote><p>
8347                    
8348    </p>
8349    <p>Server will start sending the following notification messages:
8350    </p>
8351    <p>
8352                        </p>
8353    <blockquote class="text">
8354    <p>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"
8355    </p>
8356    </blockquote><p>
8357                    
8358    </p>
8359    <p>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
8360                    channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
8361                    be replaced by the new number of effect sends on that channel.
8362    </p>
8363    <a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr />
8364    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8365    <a name="rfc.section.8.11"></a><h3>8.11.&nbsp;
8366    Effect send information changed</h3>
8367    
8368    <p>Client may want to be notified when changes were made to effect sends on a
8369                    a particular sampler channel by issuing the following command:
8370    </p>
8371    <p>
8372                        </p>
8373    <blockquote class="text">
8374    <p>SUBSCRIBE FX_SEND_INFO
8375    </p>
8376    </blockquote><p>
8377                    
8378    </p>
8379    <p>Server will start sending the following notification messages:
8380    </p>
8381    <p>
8382                        </p>
8383    <blockquote class="text">
8384    <p>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"
8385    </p>
8386    </blockquote><p>
8387                    
8388    </p>
8389    <p>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
8390                    channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
8391                    be replaced by the numerical ID of the changed effect send.
8392    </p>
8393  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />
8394  <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>
8395  <a name="rfc.section.8.6"></a><h3>8.6.&nbsp;Total number of active voices changed</h3>  <a name="rfc.section.8.12"></a><h3>8.12.&nbsp;
8396    Total number of active voices changed</h3>
8397    
8398  <p>Client may want to be notified when the total number of voices on the  <p>Client may want to be notified when the total number of voices on the
8399                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 5867  Intellectual Property and Copyright Stat Line 8411  Intellectual Property and Copyright Stat
8411  <p>  <p>
8412                      </p>                      </p>
8413  <blockquote class="text">  <blockquote class="text">
8414  <p>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;  <p>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"
8415  </p>  </p>
8416  </blockquote><p>  </blockquote><p>
8417                                    
# Line 5875  Intellectual Property and Copyright Stat Line 8419  Intellectual Property and Copyright Stat
8419  <p>where &lt;voices&gt; will be replaced by the new number of  <p>where &lt;voices&gt; will be replaced by the new number of
8420                  all currently active voices.                  all currently active voices.
8421  </p>  </p>
8422    <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr />
8423    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8424    <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;
8425    Number of MIDI instrument maps changed</h3>
8426    
8427    <p>Client may want to be notified when the number of MIDI instrument maps on the
8428                    back-end changes by issuing the following command:
8429    </p>
8430    <p>
8431                        </p>
8432    <blockquote class="text">
8433    <p>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
8434    </p>
8435    </blockquote><p>
8436                    
8437    </p>
8438    <p>Server will start sending the following notification messages:
8439    </p>
8440    <p>
8441                        </p>
8442    <blockquote class="text">
8443    <p>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"
8444    </p>
8445    </blockquote><p>
8446                    
8447    </p>
8448    <p>where &lt;maps&gt; will be replaced by the new number
8449                    of MIDI instrument maps.
8450    </p>
8451    <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr />
8452    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8453    <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;
8454    MIDI instrument map information changed</h3>
8455    
8456    <p>Client may want to be notified when changes were made to MIDI instrument maps on the
8457                    back-end by issuing the following command:
8458    </p>
8459    <p>
8460                        </p>
8461    <blockquote class="text">
8462    <p>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
8463    </p>
8464    </blockquote><p>
8465                    
8466    </p>
8467    <p>Server will start sending the following notification messages:
8468    </p>
8469    <p>
8470                        </p>
8471    <blockquote class="text">
8472    <p>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"
8473    </p>
8474    </blockquote><p>
8475                    
8476    </p>
8477    <p>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
8478                    for which information changes occurred. The front-end will have to send
8479                    the respective command to actually get the MIDI instrument map info. Because these messages
8480                    will be triggered by LSCP commands issued by other clients rather than real
8481                    time events happening on the server, it is believed that an empty notification
8482                    message is sufficient here.
8483    </p>
8484    <a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr />
8485    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8486    <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;
8487    Number of MIDI instruments changed</h3>
8488    
8489    <p>Client may want to be notified when the number of MIDI instrument maps on the
8490                    back-end changes by issuing the following command:
8491    </p>
8492    <p>
8493                        </p>
8494    <blockquote class="text">
8495    <p>SUBSCRIBE MIDI_INSTRUMENT_COUNT
8496    </p>
8497    </blockquote><p>
8498                    
8499    </p>
8500    <p>Server will start sending the following notification messages:
8501    </p>
8502    <p>
8503                        </p>
8504    <blockquote class="text">
8505    <p>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"
8506    </p>
8507    </blockquote><p>
8508                    
8509    </p>
8510    <p>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
8511                    the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
8512                    the new number of MIDI instruments in the specified map.
8513    </p>
8514    <a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr />
8515    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8516    <a name="rfc.section.8.16"></a><h3>8.16.&nbsp;
8517    MIDI instrument information changed</h3>
8518    
8519    <p>Client may want to be notified when changes were made to MIDI instruments on the
8520                    back-end by issuing the following command:
8521    </p>
8522    <p>
8523                        </p>
8524    <blockquote class="text">
8525    <p>SUBSCRIBE MIDI_INSTRUMENT_INFO
8526    </p>
8527    </blockquote><p>
8528                    
8529    </p>
8530    <p>Server will start sending the following notification messages:
8531    </p>
8532    <p>
8533                        </p>
8534    <blockquote class="text">
8535    <p>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"
8536    </p>
8537    </blockquote><p>
8538                    
8539    </p>
8540    <p>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
8541                    in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
8542                    the location of the changed MIDI instrument in the map. The front-end will have to send
8543                    the respective command to actually get the MIDI instrument info. Because these messages
8544                    will be triggered by LSCP commands issued by other clients rather than real
8545                    time events happening on the server, it is believed that an empty notification
8546                    message is sufficient here.
8547    </p>
8548    <a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr />
8549    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8550    <a name="rfc.section.8.17"></a><h3>8.17.&nbsp;
8551    Global settings changed</h3>
8552    
8553    <p>Client may want to be notified when changes to the global settings
8554                    of the sampler were made by issuing the following command:
8555    </p>
8556    <p>
8557                        </p>
8558    <blockquote class="text">
8559    <p>SUBSCRIBE GLOBAL_INFO
8560    </p>
8561    </blockquote><p>
8562                    
8563    </p>
8564    <p>Server will start sending the following types of notification messages:
8565    </p>
8566    <p>
8567                        </p>
8568    <blockquote class="text">
8569    <p>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
8570                            golbal volume of the sampler is changed, where &lt;volume&gt; will be
8571                            replaced by the optional dotted floating point value, reflecting the
8572                            new global volume parameter.
8573    </p>
8574    </blockquote><p>
8575                    
8576    </p>
8577  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
8578  <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>
8579  <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;Miscellaneous and debugging events</h3>  <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;
8580    Miscellaneous and debugging events</h3>
8581    
8582  <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
8583                  the server by issuing the following command:                  the server by issuing the following command:
# Line 5905  Intellectual Property and Copyright Stat Line 8605  Intellectual Property and Copyright Stat
8605                  user AS IS to facilitate debugging.                  user AS IS to facilitate debugging.
8606  </p>  </p>
8607  <a name="anchor14"></a><br /><hr />  <a name="anchor14"></a><br /><hr />
8608  <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>
8609  <a name="rfc.section.9"></a><h3>9.&nbsp;Security Considerations</h3>  <a name="rfc.section.9"></a><h3>9.&nbsp;
8610    Security Considerations</h3>
8611    
8612  <p>As there is so far no method of authentication and authorization  <p>As there is so far no method of authentication and authorization
8613              defined and so not required for a client applications to succeed to              defined and so not required for a client applications to succeed to
# Line 5914  Intellectual Property and Copyright Stat Line 8615  Intellectual Property and Copyright Stat
8615              system the LinuxSampler instance is running on.              system the LinuxSampler instance is running on.
8616  </p>  </p>
8617  <a name="anchor15"></a><br /><hr />  <a name="anchor15"></a><br /><hr />
8618  <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>
8619  <a name="rfc.section.10"></a><h3>10.&nbsp;Acknowledgments</h3>  <a name="rfc.section.10"></a><h3>10.&nbsp;
8620    Acknowledgments</h3>
8621    
8622  <p>This document has benefited greatly from the comments of the  <p>This document has benefited greatly from the comments of the
8623              following people, discussed on the LinuxSampler developer's mailing              following people, discussed on the LinuxSampler developer's mailing
# Line 5936  Intellectual Property and Copyright Stat Line 8638  Intellectual Property and Copyright Stat
8638                            
8639  </p>  </p>
8640  <a name="rfc.references1"></a><br /><hr />  <a name="rfc.references1"></a><br /><hr />
8641  <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>
8642  <h3>11.&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
8643  <table width="99%" border="0">  <table width="99%" border="0">
8644  <tr><td class="author-text" valign="top"><a name="RFC2119">[RFC2119]</a></td>  <tr><td class="author-text" valign="top"><a name="RFC2119">[RFC2119]</a></td>
# Line 5948  Intellectual Property and Copyright Stat Line 8650  Intellectual Property and Copyright Stat
8650  </table>  </table>
8651    
8652  <a name="rfc.authors"></a><br /><hr />  <a name="rfc.authors"></a><br /><hr />
8653  <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>
8654  <h3>Author's Address</h3>  <h3>Author's Address</h3>
8655  <table width="99%" border="0" cellpadding="0" cellspacing="0">  <table width="99%" border="0" cellpadding="0" cellspacing="0">
8656  <tr><td class="author-text">&nbsp;</td>  <tr><td class="author-text">&nbsp;</td>
# Line 5966  Schoenebeck</td></tr> Line 8668  Schoenebeck</td></tr>
8668  <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>
8669  </table>  </table>
8670  <a name="rfc.copyright"></a><br /><hr />  <a name="rfc.copyright"></a><br /><hr />
8671  <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>
8672  <h3>Intellectual Property Statement</h3>  <h3>Full Copyright Statement</h3>
8673  <p class='copyright'>  <p class='copyright'>
8674  The IETF takes no position regarding the validity or scope of  Copyright &copy; The IETF Trust (2007).</p>
 any intellectual property or other rights that might be claimed  
 to  pertain to the implementation or use of the technology  
 described in this document or the extent to which any license  
 under such rights might or might not be available; neither does  
 it represent that it has made any effort to identify any such  
 rights. Information on the IETF's procedures with respect to  
 rights in standards-track and standards-related documentation  
 can be found in BCP&nbsp;11. Copies of claims of rights made  
 available for publication and any assurances of licenses to  
 be made available, or the result of an attempt made  
 to obtain a general license or permission for the use of such  
 proprietary rights by implementors or users of this  
 specification can be obtained from the IETF Secretariat.</p>  
8675  <p class='copyright'>  <p class='copyright'>
8676  The IETF invites any interested party to bring to its  This document is subject to the rights,
8677  attention any copyrights, patents or patent applications, or  licenses and restrictions contained in BCP&nbsp;78,
8678  other proprietary rights which may cover technology that may be  and except as set forth therein,
8679  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>  
8680  <p class='copyright'>  <p class='copyright'>
8681  Copyright &copy; The Internet Society (2006). All Rights Reserved.</p>  This document and the information contained herein are provided
8682    on an &ldquo;AS IS&rdquo; basis and THE CONTRIBUTOR,
8683    THE ORGANIZATION HE/SHE REPRESENTS
8684    OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST
8685    AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES,
8686    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT
8687    THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY
8688    IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
8689    PURPOSE.</p>
8690    <h3>Intellectual Property</h3>
8691  <p class='copyright'>  <p class='copyright'>
8692  This document and translations of it may be copied and furnished to  The IETF takes no position regarding the validity or scope of any
8693  others, and derivative works that comment on or otherwise explain it  Intellectual Property Rights or other rights that might be claimed
8694  or assist in its implementation may be prepared, copied, published and  to pertain to the implementation or use of the technology
8695  distributed, in whole or in part, without restriction of any kind,  described in this document or the extent to which any license
8696  provided that the above copyright notice and this paragraph are  under such rights might or might not be available; nor does it
8697  included on all such copies and derivative works. However, this  represent that it has made any independent effort to identify any
8698  document itself may not be modified in any way, such as by removing  such rights.
8699  the copyright notice or references to the Internet Society or other  Information on the procedures with respect to
8700  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>  
8701  <p class='copyright'>  <p class='copyright'>
8702  The limited permissions granted above are perpetual and will not be  Copies of IPR disclosures made to the IETF Secretariat and any
8703  revoked by the Internet Society or its successors or assignees.</p>  assurances of licenses to be made available,
8704    or the result of an attempt made to obtain a general license or
8705    permission for the use of such proprietary rights by implementers or
8706    users of this specification can be obtained from the IETF on-line IPR
8707    repository at <a href='http://www.ietf.org/ipr'>http://www.ietf.org/ipr</a>.</p>
8708  <p class='copyright'>  <p class='copyright'>
8709  This document and the information contained herein is provided on an  The IETF invites any interested party to bring to its attention
8710  &ldquo;AS IS&rdquo; basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING  any copyrights,
8711  TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING  patents or patent applications,
8712  BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION  or other
8713  HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  proprietary rights that may cover technology that may be required
8714  MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.</p>  to implement this standard.
8715    Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p>
8716  <h3>Acknowledgment</h3>  <h3>Acknowledgment</h3>
8717  <p class='copyright'>  <p class='copyright'>
8718  Funding for the RFC Editor function is currently provided by the  Funding for the RFC Editor function is provided by
8719  Internet Society.</p>  the IETF Administrative Support Activity (IASA).</p>
8720  </body></html>  </body></html>
Legend:
Removed from v.940  
changed lines
  Added in v.1137
  ViewVC Help
Powered by ViewVC