/[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 1048 by schoenebeck, Mon Feb 19 19:46:20 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.31 (http://xml.resource.org/)">
7  <style type='text/css'>  <style type='text/css'><!--
8  <!--          body {
9      body {                  font-family: verdana, charcoal, helvetica, arial, sans-serif;
10          font-family: verdana, charcoal, helvetica, arial, sans-serif;                  font-size: small; color: #000; background-color: #FFF;
11          margin: 2em;                  margin: 2em;
12          font-size: small ; color: #000000 ; background-color: #ffffff ; }          }
13      .title { color: #990000; font-size: x-large ;          h1, h2, h3, h4, h5, h6 {
14          font-weight: bold; text-align: right;                  font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;
15          font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;                  font-weight: bold; font-style: normal;
16          background-color: transparent; }          }
17      .filename { color: #666666; font-size: 18px; line-height: 28px;          h1 { color: #900; background-color: transparent; text-align: right; }
18          font-weight: bold; text-align: right;          h3 { color: #333; background-color: transparent; }
19          font-family: helvetica, arial, sans-serif;  
20          background-color: transparent; }          td.RFCbug {
21      td.rfcbug { background-color: #000000 ; width: 30px ; height: 30px ;                  font-size: x-small; text-decoration: none;
22          text-align: justify; vertical-align: middle ; padding-top: 2px ; }                  width: 30px; height: 30px; padding-top: 2px;
23      td.rfcbug span.RFC { color: #666666; font-weight: bold; text-decoration: none;                  text-align: justify; vertical-align: middle;
24          background-color: #000000 ;                  background-color: #000;
25          font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;          }
26          font-size: x-small ; }          td.RFCbug span.RFC {
27      td.rfcbug span.hotText { color: #ffffff; font-weight: normal; text-decoration: none;                  font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
28          text-align: center ;                  font-weight: bold; color: #666;
29          font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;          }
30          font-size: x-small ; background-color: #000000; }          td.RFCbug span.hotText {
31      /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */                  font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
32      div#counter{margin-top: 100px}                  font-weight: normal; text-align: center; color: #FFF;
33            }
34      a.info{  
35          position:relative; /*this is the key*/          table.TOCbug { width: 30px; height: 15px; }
36          z-index:24;          td.TOCbug {
37          text-decoration:none}                  text-align: center; width: 30px; height: 15px;
38                    color: #FFF; background-color: #900;
39      a.info:hover{z-index:25; background-color:#990000 ; color: #ffffff ;}          }
40            td.TOCbug a {
41      a.info span{display: none}                  font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;
42                    font-weight: bold; font-size: x-small; text-decoration: none;
43      a.info:hover span.info{ /*the span will display just on :hover state*/                  color: #FFF; background-color: transparent;
44          display:block;          }
45          position:absolute;  
46          font-size: smaller ;          td.header {
47          top:2em; left:2em; width:15em;                  font-family: arial, helvetica, sans-serif; font-size: x-small;
48          padding: 2px ;                  vertical-align: top; width: 33%;
49          border:1px solid #333333;                  color: #FFF; background-color: #666;
50          background-color:#eeeeee; color:#990000;          }
51          text-align: left ;}          td.author { font-weight: bold; font-size: x-small; margin-left: 4em; }
52            td.author-text { font-size: x-small; }
53       A { font-weight: bold; }  
54       A:link { color: #990000; background-color: transparent ; }          /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */
55       A:visited { color: #333333; background-color: transparent ; }          a.info {
56       A:active { color: #333333; background-color: transparent ; }                  /* This is the key. */
57                    position: relative;
58      p { margin-left: 2em; margin-right: 2em; }                  z-index: 24;
59      p.copyright { font-size: x-small ; }                  text-decoration: none;
60      p.toc { font-size: small ; font-weight: bold ; margin-left: 3em ;}          }
61      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;
75            }
76      pre { margin-left: 3em; color: #333333;  background-color: transparent;  
77          font-family: "Courier New", Courier, monospace ; font-size: small ;          a { font-weight: bold; }
78          text-align: left;          a:link    { color: #900; background-color: transparent; }
79          }          a:visited { color: #633; background-color: transparent; }
80            a:active  { color: #633; background-color: transparent; }
81      h3 { color: #333333; font-size: medium ;  
82          font-family: helvetica, arial, sans-serif ;          p { margin-left: 2em; margin-right: 2em; }
83          background-color: transparent; }          p.copyright { font-size: x-small; }
84      h4 { font-size: small; font-family: helvetica, arial, sans-serif ; }          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      table.bug { width: 30px ; height: 15px ; }          td.toc { font-size: small; font-weight: bold; vertical-align: text-top; }
87      td.bug { color: #ffffff ; background-color: #990000 ;  
88          text-align: center ; width: 30px ; height: 15px ;          ol.text { margin-left: 2em; margin-right: 2em; }
89           }          ul.text { margin-left: 2em; margin-right: 2em; }
90      td.bug A.link2 { color: #ffffff ; font-weight: bold;          li      { margin-left: 3em; }
91          text-decoration: none;  
92          font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;          /* RFC-2629 <spanx>s and <artwork>s. */
93          font-size: x-small ; background-color: transparent }          em     { font-style: italic; }
94            strong { font-weight: bold; }
95      td.header { color: #ffffff; font-size: x-small ;          dfn    { font-weight: bold; font-style: normal; }
96          font-family: arial, helvetica, sans-serif; vertical-align: top;          cite   { font-weight: normal; font-style: normal; }
97          background-color: #666666 ; width: 33% ; }          tt     { color: #036; }
98      td.author { font-weight: bold; margin-left: 4em; font-size: x-small ; }          tt, pre, pre dfn, pre em, pre cite, pre span {
99      td.author-text { font-size: x-small; }                  font-family: "Courier New", Courier, monospace; font-size: small;
100      table.full { vertical-align: top ; border-collapse: collapse ;          }
101          border-style: solid solid solid solid ;          pre {
102          border-color: black black black black ;                  text-align: left; padding: 4px;
103          font-size: small ; text-align: center ; }                  color: #000; background-color: #CCC;
104      table.headers, table.none { vertical-align: top ; border-collapse: collapse ;          }
105          border-style: none;          pre dfn  { color: #900; }
106          font-size: small ; text-align: center ; }          pre em   { color: #66F; background-color: #FFC; font-weight: normal; }
107      table.full th { font-weight: bold ;          pre .key { color: #33C; font-weight: bold; }
108          border-style: solid ;          pre .id  { color: #900; }
109          border-color: black black black black ; }          pre .str { color: #000; background-color: #CFF; }
110      table.headers th { font-weight: bold ;          pre .val { color: #066; }
111          border-style: none none solid none;          pre .rep { color: #909; }
112          border-color: black black black black ; }          pre .oth { color: #000; background-color: #FCF; }
113      table.none th { font-weight: bold ;          pre .err { background-color: #FCC; }
114          border-style: none; }  
115      table.full td {          /* RFC-2629 <texttable>s. */
116          border-style: solid solid solid solid ;          table.full, table.headers, table.none {
117          border-color: #333333 #333333 #333333 #333333 ; }                  font-size: small; text-align: center; border-width: 2px;
118      table.headers td, table.none td { border-style: none; }                  vertical-align: top; border-collapse: collapse;
119            }
120      hr { height: 1px }          table.full { border-style: solid; border-color: black; }
121  -->          table.headers, table.none { border-style: none; }
122  </style>          th {
123                    font-weight: bold; border-color: black;
124                    border-width: 2px 2px 3px 2px;
125            }
126            table.full th { border-style: solid; }
127            table.headers th { border-style: none none solid none; }
128            table.none th { border-style: none; }
129            table.full td {
130                    border-style: solid; border-color: #333;
131                    border-width: 1px 2px;
132            }
133            table.headers td, table.none td { border-style: none; }
134    
135            hr { height: 1px; }
136            hr.insert {
137                    width: 80%; border-style: none; border-width: 0;
138                    color: #CCC; background-color: #CCC;
139            }
140    --></style>
141  </head>  </head>
142  <body>  <body>
143  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
144  <table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1">  <table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1">
145  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>
146  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>
147  <tr><td class="header">Expires: 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: August 23, 2007</td><td class="header">February 19, 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 August 23, 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 Internet Society (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 AUDIO_OUTPUT_CHANNEL">6.4.30.</a>&nbsp;
332    Altering effect send's audio routing<br />
333    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.31.</a>&nbsp;
334    Altering effect send's MIDI controller<br />
335    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.32.</a>&nbsp;
336    Altering effect send's send level<br />
337    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.33.</a>&nbsp;
338  Resetting a sampler channel<br />  Resetting a sampler channel<br />
339  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;
340  Controlling connection<br />  Controlling connection<br />
# Line 318  Maximum amount of active voices<br /> Line 356  Maximum amount of active voices<br />
356  Reset sampler<br />  Reset sampler<br />
357  &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;
358  General sampler informations<br />  General sampler informations<br />
359    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET VOLUME">6.6.5.</a>&nbsp;
360    Getting global volume attenuation<br />
361    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOLUME">6.6.6.</a>&nbsp;
362    Setting global volume attenuation<br />
363    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#MIDI Instrument Mapping">6.7.</a>&nbsp;
364    MIDI Instrument Mapping<br />
365    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD MIDI_INSTRUMENT MAP">6.7.1.</a>&nbsp;
366    Create a new MIDI instrument map<br />
367    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a>&nbsp;
368    Delete one particular or all MIDI instrument maps<br />
369    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT_MAPS">6.7.3.</a>&nbsp;
370    Get amount of existing MIDI instrument maps<br />
371    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INSTRUMENT_MAPS">6.7.4.</a>&nbsp;
372    Getting all created MIDI instrument maps<br />
373    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT_MAP INFO">6.7.5.</a>&nbsp;
374    Getting MIDI instrument map information<br />
375    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INSTRUMENT_MAP NAME">6.7.6.</a>&nbsp;
376    Renaming a MIDI instrument map<br />
377    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MAP MIDI_INSTRUMENT">6.7.7.</a>&nbsp;
378    Create or replace a MIDI instrument map entry<br />
379    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENTS">6.7.8.</a>&nbsp;
380    Getting ammount of MIDI instrument map entries<br />
381    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INSTRUMENTS">6.7.9.</a>&nbsp;
382    Getting indeces of all entries of a MIDI instrument map<br />
383    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#UNMAP MIDI_INSTRUMENT">6.7.10.</a>&nbsp;
384    Remove an entry from the MIDI instrument map<br />
385    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT INFO">6.7.11.</a>&nbsp;
386    Get current settings of MIDI instrument map entry<br />
387    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CLEAR MIDI_INSTRUMENTS">6.7.12.</a>&nbsp;
388    Clear MIDI instrument map<br />
389  <a href="#command_syntax">7.</a>&nbsp;  <a href="#command_syntax">7.</a>&nbsp;
390  Command Syntax<br />  Command Syntax<br />
391  <a href="#events">8.</a>&nbsp;  <a href="#events">8.</a>&nbsp;
392  Events<br />  Events<br />
393  &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;
394    Number of audio output devices changed<br />
395    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">8.2.</a>&nbsp;
396    Audio output device's settings changed<br />
397    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">8.3.</a>&nbsp;
398    Number of MIDI input devices changed<br />
399    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INPUT_DEVICE_INFO">8.4.</a>&nbsp;
400    MIDI input device's settings changed<br />
401    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a>&nbsp;
402  Number of sampler channels changed<br />  Number of sampler channels changed<br />
403  &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;
404  Number of active voices changed<br />  Number of active voices changed<br />
405  &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;
406  Number of active disk streams changed<br />  Number of active disk streams changed<br />
407  &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;
408  Disk stream buffer fill state changed<br />  Disk stream buffer fill state changed<br />
409  &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;
410  Channel information changed<br />  Channel information changed<br />
411  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.6.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.10.</a>&nbsp;
412  Total number of active voices changed<br />  Total number of active voices changed<br />
413  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.7.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.11.</a>&nbsp;
414    Number of MIDI instrument maps changed<br />
415    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.12.</a>&nbsp;
416    MIDI instrument map information changed<br />
417    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.13.</a>&nbsp;
418    Number of MIDI instruments changed<br />
419    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.14.</a>&nbsp;
420    MIDI instrument information changed<br />
421    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.15.</a>&nbsp;
422  Miscellaneous and debugging events<br />  Miscellaneous and debugging events<br />
423  <a href="#anchor14">9.</a>&nbsp;  <a href="#anchor14">9.</a>&nbsp;
424  Security Considerations<br />  Security Considerations<br />
# Line 350  Intellectual Property and Copyright Stat Line 434  Intellectual Property and Copyright Stat
434  <br clear="all" />  <br clear="all" />
435    
436  <a name="anchor1"></a><br /><hr />  <a name="anchor1"></a><br /><hr />
437  <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>
438  <a name="rfc.section.1"></a><h3>1.&nbsp;Requirements notation</h3>  <a name="rfc.section.1"></a><h3>1.&nbsp;
439    Requirements notation</h3>
440    
441  <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",  <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
442              "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",              "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
443              and "OPTIONAL" in this document are to be interpreted as              and "OPTIONAL" in this document are to be interpreted as
444              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>.
445  </p>  </p>
446  <p>This protocol is always case-sensitive if not explicitly  <p>This protocol is always case-sensitive if not explicitly
447              claimed the opposite.              claimed the opposite.
# Line 432  Intellectual Property and Copyright Stat Line 517  Intellectual Property and Copyright Stat
517              return and line feed characters respectively.              return and line feed characters respectively.
518  </p>  </p>
519  <a name="LSCP versioning"></a><br /><hr />  <a name="LSCP versioning"></a><br /><hr />
520  <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>
521  <a name="rfc.section.2"></a><h3>2.&nbsp;Versioning of this specification</h3>  <a name="rfc.section.2"></a><h3>2.&nbsp;
522    Versioning of this specification</h3>
523    
524  <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
525              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 562  Intellectual Property and Copyright Stat
562  <p>  <p>
563              Compatibility can only be claimed if both rules are true.              Compatibility can only be claimed if both rules are true.
564              The frontend can use the              The frontend can use the
565              <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
566              get the version of the LSCP specification the sampler complies with.              get the version of the LSCP specification the sampler complies with.
567                            
568  </p>  </p>
569  <a name="anchor2"></a><br /><hr />  <a name="anchor2"></a><br /><hr />
570  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
571  <a name="rfc.section.3"></a><h3>3.&nbsp;Introduction</h3>  <a name="rfc.section.3"></a><h3>3.&nbsp;
572    Introduction</h3>
573    
574  <p>LinuxSampler is a so called software sampler application  <p>LinuxSampler is a so called software sampler application
575              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 589  Intellectual Property and Copyright Stat
589              there.              there.
590  </p>  </p>
591  <a name="anchor3"></a><br /><hr />  <a name="anchor3"></a><br /><hr />
592  <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>
593  <a name="rfc.section.4"></a><h3>4.&nbsp;Focus of this protocol</h3>  <a name="rfc.section.4"></a><h3>4.&nbsp;
594    Focus of this protocol</h3>
595    
596  <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
597              a running LinuxSampler instance and to retrieve information              a running LinuxSampler instance and to retrieve information
# Line 514  Intellectual Property and Copyright Stat Line 602  Intellectual Property and Copyright Stat
602              via MIDI System Exclusive Messages.              via MIDI System Exclusive Messages.
603  </p>  </p>
604  <a name="anchor4"></a><br /><hr />  <a name="anchor4"></a><br /><hr />
605  <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>
606  <a name="rfc.section.5"></a><h3>5.&nbsp;Communication Overview</h3>  <a name="rfc.section.5"></a><h3>5.&nbsp;
607    Communication Overview</h3>
608    
609  <p>There are two distinct methods of communication between a  <p>There are two distinct methods of communication between a
610              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 618  Intellectual Property and Copyright Stat
618              methods will be described next.              methods will be described next.
619  </p>  </p>
620  <a name="anchor5"></a><br /><hr />  <a name="anchor5"></a><br /><hr />
621  <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>
622  <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;
623    Request/response communication method</h3>
624    
625  <p>This simple communication method is based on  <p>This simple communication method is based on
626                  <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
627                  front-end application establishes a TCP connection to the                  front-end application establishes a TCP connection to the
628                  LinuxSampler instance on a certain host system. Then the                  LinuxSampler instance on a certain host system. Then the
629                  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 664  Intellectual Property and Copyright Stat
664                  MUST be sent back in the same order.                  MUST be sent back in the same order.
665  </p>  </p>
666  <a name="anchor6"></a><br /><hr />  <a name="anchor6"></a><br /><hr />
667  <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
668  <a name="rfc.section.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;
669    Result format</h3>
670    
671  <p>Result set could be one of the following types:  <p>Result set could be one of the following types:
672  </p>  </p>
# Line 766  Intellectual Property and Copyright Stat Line 857  Intellectual Property and Copyright Stat
857                                            
858  </p>  </p>
859  <a name="anchor7"></a><br /><hr />  <a name="anchor7"></a><br /><hr />
860  <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>
861  <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;
862    Subscribe/notify communication method</h3>
863    
864  <p>This more sophisticated communication method is actually  <p>This more sophisticated communication method is actually
865                  only an extension of the simple request/response                  only an extension of the simple request/response
# Line 844  Intellectual Property and Copyright Stat Line 936  Intellectual Property and Copyright Stat
936  </p>  </p>
937  <p>where &lt;event-id&gt; will be replace by the respective  <p>where &lt;event-id&gt; will be replace by the respective
938                  event that client is no longer interested in receiving. For                  event that client is no longer interested in receiving. For
939                  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>.
940  </p>  </p>
941  <p>Example: the fill states of disk stream buffers have  <p>Example: the fill states of disk stream buffers have
942                  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 982  Intellectual Property and Copyright Stat
982                  it wants to receive.                  it wants to receive.
983  </p>  </p>
984  <a name="control_commands"></a><br /><hr />  <a name="control_commands"></a><br /><hr />
985  <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>
986  <a name="rfc.section.6"></a><h3>6.&nbsp;Description for control commands</h3>  <a name="rfc.section.6"></a><h3>6.&nbsp;
987    Description for control commands</h3>
988    
989  <p>This chapter will describe the available control commands  <p>This chapter will describe the available control commands
990              that can be sent on the TCP connection in detail. Some certain              that can be sent on the TCP connection in detail. Some certain
991              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>
992              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
993              multiple-line responses. In this case LinuxSampler signals the              multiple-line responses. In this case LinuxSampler signals the
994              end of the response by a "." (single dot) line.              end of the response by a "." (single dot) line.
995  </p>  </p>
996  <a name="anchor8"></a><br /><hr />  <a name="anchor8"></a><br /><hr />
997  <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>
998  <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;
999    Ignored lines and comments</h3>
1000    
1001  <p>White lines, that is lines which only contain space and  <p>White lines, that is lines which only contain space and
1002                  tabulator characters, and lines that start with a "#"                  tabulator characters, and lines that start with a "#"
# Line 911  Intellectual Property and Copyright Stat Line 1005  Intellectual Property and Copyright Stat
1005                  file.                  file.
1006  </p>  </p>
1007  <a name="anchor9"></a><br /><hr />  <a name="anchor9"></a><br /><hr />
1008  <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>
1009  <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;
1010    Configuring audio drivers</h3>
1011    
1012  <p>Instances of drivers in LinuxSampler are called devices.  <p>Instances of drivers in LinuxSampler are called devices.
1013                  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 1041  Intellectual Property and Copyright Stat
1041                  possible values, etc.                  possible values, etc.
1042  </p>  </p>
1043  <a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />  <a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />
1044  <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>
1045  <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;
1046    Getting amount of available audio output drivers</h3>
1047    
1048  <p>Use the following command to get the number of  <p>Use the following command to get the number of
1049                      audio output drivers currently available for the                      audio output drivers currently available for the
# Line 985  Intellectual Property and Copyright Stat Line 1081  Intellectual Property and Copyright Stat
1081                                            
1082  </p>  </p>
1083  <a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />  <a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />
1084  <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>
1085  <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;
1086    Getting all available audio output drivers</h3>
1087    
1088  <p>Use the following command to list all audio output  <p>Use the following command to list all audio output
1089                      drivers currently available for the LinuxSampler                      drivers currently available for the LinuxSampler
# Line 1025  Intellectual Property and Copyright Stat Line 1122  Intellectual Property and Copyright Stat
1122                                            
1123  </p>  </p>
1124  <a name="GET AUDIO_OUTPUT_DRIVER INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DRIVER INFO"></a><br /><hr />
1125  <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>
1126  <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;
1127    Getting information about a specific audio
1128                  output driver</h3>                  output driver</h3>
1129    
1130  <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 1141  Intellectual Property and Copyright Stat
1141  </p>  </p>
1142  <p>Where &lt;audio-output-driver&gt; is the name of the  <p>Where &lt;audio-output-driver&gt; is the name of the
1143                      audio output driver, returned by the                      audio output driver, returned by the
1144                      <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.
1145  </p>  </p>
1146  <p>Possible Answers:  <p>Possible Answers:
1147  </p>  </p>
# Line 1124  Intellectual Property and Copyright Stat Line 1222  Intellectual Property and Copyright Stat
1222                                            
1223  </p>  </p>
1224  <a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"></a><br /><hr />
1225  <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>
1226  <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;
1227    Getting information about specific audio
1228                  output driver parameter</h3>                  output driver parameter</h3>
1229    
1230  <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 1239  Intellectual Property and Copyright Stat
1239                                            
1240  </p>  </p>
1241  <p>Where &lt;audio&gt; is the name of the audio output  <p>Where &lt;audio&gt; is the name of the audio output
1242                      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,
1243                      &lt;prm&gt; a specific parameter name for which information should be                      &lt;prm&gt; a specific parameter name for which information should be
1244                      obtained (as returned by the                      obtained (as returned by the
1245                      <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
1246                      &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
1247                      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
1248                      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 1299  Intellectual Property and Copyright Stat
1299  <blockquote class="text">  <blockquote class="text">
1300  <p>either true or false, defines if this parameter must be  <p>either true or false, defines if this parameter must be
1301                                  given when the device is to be created with the                                  given when the device is to be created with the
1302                                  <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>
1303                                  command (always returned, no matter which driver parameter)                                  command (always returned, no matter which driver parameter)
1304  </p>  </p>
1305  </blockquote>  </blockquote>
# Line 1211  Intellectual Property and Copyright Stat Line 1310  Intellectual Property and Copyright Stat
1310  <blockquote class="text">  <blockquote class="text">
1311  <p>either true or false, if false then this parameter can  <p>either true or false, if false then this parameter can
1312                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
1313                                  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>
1314                                  command (always returned, no matter which driver parameter)                                  command (always returned, no matter which driver parameter)
1315  </p>  </p>
1316  </blockquote>  </blockquote>
# Line 1250  Intellectual Property and Copyright Stat Line 1349  Intellectual Property and Copyright Stat
1349  <blockquote class="text">  <blockquote class="text">
1350  <p>reflects the default value for this parameter which is  <p>reflects the default value for this parameter which is
1351                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
1352                                  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,
1353                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
1354                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
1355                                  apostrophes (')                                  apostrophes (')
# Line 1378  Intellectual Property and Copyright Stat Line 1477  Intellectual Property and Copyright Stat
1477                                            
1478  </p>  </p>
1479  <a name="CREATE AUDIO_OUTPUT_DEVICE"></a><br /><hr />  <a name="CREATE AUDIO_OUTPUT_DEVICE"></a><br /><hr />
1480  <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>
1481  <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;
1482    Creating an audio output device</h3>
1483    
1484  <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:
1485  </p>  </p>
# Line 1393  Intellectual Property and Copyright Stat Line 1493  Intellectual Property and Copyright Stat
1493  </p>  </p>
1494  <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
1495                      output system as returned by the                      output system as returned by the
1496                      <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>
1497                      command and &lt;param-list&gt; by an optional list of driver                      command and &lt;param-list&gt; by an optional list of driver
1498                      specific parameters in form of "key1=val1 key2=val2 ...", where                      specific parameters in form of "key1=val1 key2=val2 ...", where
1499                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
# Line 1462  Intellectual Property and Copyright Stat Line 1562  Intellectual Property and Copyright Stat
1562                                            
1563  </p>  </p>
1564  <a name="DESTROY AUDIO_OUTPUT_DEVICE"></a><br /><hr />  <a name="DESTROY AUDIO_OUTPUT_DEVICE"></a><br /><hr />
1565  <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>
1566  <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;
1567    Destroying an audio output device</h3>
1568    
1569  <p>Use the following command to destroy a created output device:  <p>Use the following command to destroy a created output device:
1570  </p>  </p>
# Line 1477  Intellectual Property and Copyright Stat Line 1578  Intellectual Property and Copyright Stat
1578  </p>  </p>
1579  <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
1580                      audio output device as given by the                      audio output device as given by the
1581                      <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>
1582                      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>
1583                      command.                      command.
1584  </p>  </p>
1585  <p>Possible Answers:  <p>Possible Answers:
# Line 1531  Intellectual Property and Copyright Stat Line 1632  Intellectual Property and Copyright Stat
1632                                            
1633  </p>  </p>
1634  <a name="GET AUDIO_OUTPUT_DEVICES"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DEVICES"></a><br /><hr />
1635  <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>
1636  <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;
1637    Getting all created audio output device count</h3>
1638    
1639  <p>Use the following command to count all created audio output devices:  <p>Use the following command to count all created audio output devices:
1640  </p>  </p>
# Line 1568  Intellectual Property and Copyright Stat Line 1670  Intellectual Property and Copyright Stat
1670                                            
1671  </p>  </p>
1672  <a name="LIST AUDIO_OUTPUT_DEVICES"></a><br /><hr />  <a name="LIST AUDIO_OUTPUT_DEVICES"></a><br /><hr />
1673  <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>
1674  <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;
1675    Getting all created audio output device list</h3>
1676    
1677  <p>Use the following command to list all created audio output devices:  <p>Use the following command to list all created audio output devices:
1678  </p>  </p>
# Line 1605  Intellectual Property and Copyright Stat Line 1708  Intellectual Property and Copyright Stat
1708                                            
1709  </p>  </p>
1710  <a name="GET AUDIO_OUTPUT_DEVICE INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DEVICE INFO"></a><br /><hr />
1711  <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>
1712  <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;
1713    Getting current settings of an audio output device</h3>
1714    
1715  <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:
1716  </p>  </p>
# Line 1620  Intellectual Property and Copyright Stat Line 1724  Intellectual Property and Copyright Stat
1724  </p>  </p>
1725  <p>Where &lt;device-id&gt; should be replaced by numerical ID  <p>Where &lt;device-id&gt; should be replaced by numerical ID
1726                      of the audio output device as e.g. returned by the                      of the audio output device as e.g. returned by the
1727                      <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.
1728  </p>  </p>
1729  <p>Possible Answers:  <p>Possible Answers:
1730  </p>  </p>
# Line 1640  Intellectual Property and Copyright Stat Line 1744  Intellectual Property and Copyright Stat
1744  <blockquote class="text">  <blockquote class="text">
1745  <p>identifier of the used audio output driver, as also  <p>identifier of the used audio output driver, as also
1746                                      returned by the                                      returned by the
1747                                      <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>
1748                                      command                                      command
1749  </p>  </p>
1750  </blockquote>  </blockquote>
# Line 1681  Intellectual Property and Copyright Stat Line 1785  Intellectual Property and Copyright Stat
1785                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
1786                      returned by all audio output devices. Every audio output driver                      returned by all audio output devices. Every audio output driver
1787                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
1788                      <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>)
1789                      which are also returned by this command.                      which are also returned by this command.
1790  </p>  </p>
1791  <p>Example:  <p>Example:
# Line 1711  Intellectual Property and Copyright Stat Line 1815  Intellectual Property and Copyright Stat
1815                                            
1816  </p>  </p>
1817  <a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER"></a><br /><hr />  <a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER"></a><br /><hr />
1818  <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>
1819  <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;
1820    Changing settings of audio output devices</h3>
1821    
1822  <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:
1823  </p>  </p>
# Line 1726  Intellectual Property and Copyright Stat Line 1831  Intellectual Property and Copyright Stat
1831  </p>  </p>
1832  <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
1833                      audio output device as given by the                      audio output device as given by the
1834                      <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>
1835                      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>
1836                      command, &lt;key&gt; by the name of the parameter to change                      command, &lt;key&gt; by the name of the parameter to change
1837                      and &lt;value&gt; by the new value for this parameter.                      and &lt;value&gt; by the new value for this parameter.
1838  </p>  </p>
# Line 1779  Intellectual Property and Copyright Stat Line 1884  Intellectual Property and Copyright Stat
1884                                            
1885  </p>  </p>
1886  <a name="GET AUDIO_OUTPUT_CHANNEL INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_CHANNEL INFO"></a><br /><hr />
1887  <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>
1888  <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;
1889    Getting information about an audio channel</h3>
1890    
1891  <p>Use the following command to get information about an audio channel:  <p>Use the following command to get information about an audio channel:
1892  </p>  </p>
# Line 1793  Intellectual Property and Copyright Stat Line 1899  Intellectual Property and Copyright Stat
1899                                            
1900  </p>  </p>
1901  <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
1902                      <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>
1903                      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>
1904                      command and &lt;audio-chan&gt; the audio channel number.                      command and &lt;audio-chan&gt; the audio channel number.
1905  </p>  </p>
1906  <p>Possible Answers:  <p>Possible Answers:
# Line 1921  Intellectual Property and Copyright Stat Line 2027  Intellectual Property and Copyright Stat
2027                                            
2028  </p>  </p>
2029  <a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"></a><br /><hr />
2030  <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>
2031  <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;
2032    Getting information about specific audio channel parameter</h3>
2033    
2034  <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:
2035  </p>  </p>
# Line 1935  Intellectual Property and Copyright Stat Line 2042  Intellectual Property and Copyright Stat
2042                                            
2043  </p>  </p>
2044  <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
2045                      <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>
2046                      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>
2047                      command, &lt;chan&gt; the audio channel number                      command, &lt;chan&gt; the audio channel number
2048                      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
2049                      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).
2050  </p>  </p>
2051  <p>Possible Answers:  <p>Possible Answers:
2052  </p>  </p>
# Line 2067  Intellectual Property and Copyright Stat Line 2174  Intellectual Property and Copyright Stat
2174                                            
2175  </p>  </p>
2176  <a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"></a><br /><hr />  <a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"></a><br /><hr />
2177  <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>
2178  <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;
2179    Changing settings of audio output channels</h3>
2180    
2181  <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:
2182  </p>  </p>
# Line 2081  Intellectual Property and Copyright Stat Line 2189  Intellectual Property and Copyright Stat
2189                                            
2190  </p>  </p>
2191  <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
2192                      <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>
2193                      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>
2194                      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
2195                      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.
2196  </p>  </p>
# Line 2144  Intellectual Property and Copyright Stat Line 2252  Intellectual Property and Copyright Stat
2252                                            
2253  </p>  </p>
2254  <a name="anchor10"></a><br /><hr />  <a name="anchor10"></a><br /><hr />
2255  <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>
2256  <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;
2257    Configuring MIDI input drivers</h3>
2258    
2259  <p>Instances of drivers in LinuxSampler are called devices. You can use  <p>Instances of drivers in LinuxSampler are called devices. You can use
2260                  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 2283  Intellectual Property and Copyright Stat
2283                  possible values, etc.                  possible values, etc.
2284  </p>  </p>
2285  <a name="GET AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />  <a name="GET AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />
2286  <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>
2287  <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;
2288    Getting amount of available MIDI input drivers</h3>
2289    
2290  <p>Use the following command to get the number of  <p>Use the following command to get the number of
2291                      MIDI input drivers currently available for the                      MIDI input drivers currently available for the
# Line 2213  Intellectual Property and Copyright Stat Line 2323  Intellectual Property and Copyright Stat
2323                                            
2324  </p>  </p>
2325  <a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />  <a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />
2326  <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>
2327  <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;
2328    Getting all available MIDI input drivers</h3>
2329    
2330  <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
2331                      for the LinuxSampler instance:                      for the LinuxSampler instance:
# Line 2251  Intellectual Property and Copyright Stat Line 2362  Intellectual Property and Copyright Stat
2362                                            
2363  </p>  </p>
2364  <a name="GET MIDI_INPUT_DRIVER INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_DRIVER INFO"></a><br /><hr />
2365  <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>
2366  <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;
2367    Getting information about a specific MIDI input driver</h3>
2368    
2369  <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:
2370  </p>  </p>
# Line 2265  Intellectual Property and Copyright Stat Line 2377  Intellectual Property and Copyright Stat
2377                                            
2378  </p>  </p>
2379  <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
2380                      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.
2381  </p>  </p>
2382  <p>Possible Answers:  <p>Possible Answers:
2383  </p>  </p>
# Line 2332  Intellectual Property and Copyright Stat Line 2444  Intellectual Property and Copyright Stat
2444                                            
2445  </p>  </p>
2446  <a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO"></a><br /><hr />
2447  <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>
2448  <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;
2449    Getting information about specific MIDI input driver parameter</h3>
2450    
2451  <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:
2452  </p>  </p>
# Line 2346  Intellectual Property and Copyright Stat Line 2459  Intellectual Property and Copyright Stat
2459                                            
2460  </p>  </p>
2461  <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
2462                      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
2463                      parameter name for which information should be obtained (as returned by the                      parameter name for which information should be obtained (as returned by the
2464                      <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
2465                      of parameters on which the sought parameter &lt;param&gt; depends on,                      of parameters on which the sought parameter &lt;param&gt; depends on,
2466                      &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 ...",
2467                      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 2508  Intellectual Property and Copyright Stat
2508  <blockquote class="text">  <blockquote class="text">
2509  <p>either true or false, defines if this parameter must be  <p>either true or false, defines if this parameter must be
2510                                  given when the device is to be created with the                                  given when the device is to be created with the
2511                                  <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
2512                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2513  </p>  </p>
2514  </blockquote>  </blockquote>
# Line 2406  Intellectual Property and Copyright Stat Line 2519  Intellectual Property and Copyright Stat
2519  <blockquote class="text">  <blockquote class="text">
2520  <p>either true or false, if false then this parameter can  <p>either true or false, if false then this parameter can
2521                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
2522                                  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
2523                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2524  </p>  </p>
2525  </blockquote>  </blockquote>
# Line 2445  Intellectual Property and Copyright Stat Line 2558  Intellectual Property and Copyright Stat
2558  <blockquote class="text">  <blockquote class="text">
2559  <p>reflects the default value for this parameter which is  <p>reflects the default value for this parameter which is
2560                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
2561                                  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,
2562                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
2563                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
2564                                  apostrophes (')                                  apostrophes (')
# Line 2519  Intellectual Property and Copyright Stat Line 2632  Intellectual Property and Copyright Stat
2632                                            
2633  </p>  </p>
2634  <a name="CREATE MIDI_INPUT_DEVICE"></a><br /><hr />  <a name="CREATE MIDI_INPUT_DEVICE"></a><br /><hr />
2635  <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>
2636  <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;
2637    Creating a MIDI input device</h3>
2638    
2639  <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:
2640  </p>  </p>
# Line 2533  Intellectual Property and Copyright Stat Line 2647  Intellectual Property and Copyright Stat
2647                                            
2648  </p>  </p>
2649  <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
2650                      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
2651                      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
2652                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
2653                      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 2703  Intellectual Property and Copyright Stat
2703                                            
2704  </p>  </p>
2705  <a name="DESTROY MIDI_INPUT_DEVICE"></a><br /><hr />  <a name="DESTROY MIDI_INPUT_DEVICE"></a><br /><hr />
2706  <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>
2707  <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;
2708    Destroying a MIDI input device</h3>
2709    
2710  <p>Use the following command to destroy a created MIDI input device:  <p>Use the following command to destroy a created MIDI input device:
2711  </p>  </p>
# Line 2603  Intellectual Property and Copyright Stat Line 2718  Intellectual Property and Copyright Stat
2718                                            
2719  </p>  </p>
2720  <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
2721                      <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>
2722                      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>
2723                      command.                      command.
2724  </p>  </p>
2725  <p>Possible Answers:  <p>Possible Answers:
# Line 2654  Intellectual Property and Copyright Stat Line 2769  Intellectual Property and Copyright Stat
2769                                            
2770  </p>  </p>
2771  <a name="GET MIDI_INPUT_DEVICES"></a><br /><hr />  <a name="GET MIDI_INPUT_DEVICES"></a><br /><hr />
2772  <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>
2773  <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;
2774    Getting all created MIDI input device count</h3>
2775    
2776  <p>Use the following command to count all created MIDI input devices:  <p>Use the following command to count all created MIDI input devices:
2777  </p>  </p>
# Line 2691  Intellectual Property and Copyright Stat Line 2807  Intellectual Property and Copyright Stat
2807                                            
2808  </p>  </p>
2809  <a name="LIST MIDI_INPUT_DEVICES"></a><br /><hr />  <a name="LIST MIDI_INPUT_DEVICES"></a><br /><hr />
2810  <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>
2811  <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;
2812    Getting all created MIDI input device list</h3>
2813    
2814  <p>Use the following command to list all created MIDI input devices:  <p>Use the following command to list all created MIDI input devices:
2815  </p>  </p>
# Line 2738  Intellectual Property and Copyright Stat Line 2855  Intellectual Property and Copyright Stat
2855                                            
2856  </p>  </p>
2857  <a name="GET MIDI_INPUT_DEVICE INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_DEVICE INFO"></a><br /><hr />
2858  <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>
2859  <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;
2860    Getting current settings of a MIDI input device</h3>
2861    
2862  <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:
2863  </p>  </p>
# Line 2752  Intellectual Property and Copyright Stat Line 2870  Intellectual Property and Copyright Stat
2870                                            
2871  </p>  </p>
2872  <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
2873                      <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>
2874                      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>
2875                      command.                      command.
2876  </p>  </p>
2877  <p>Possible Answers:  <p>Possible Answers:
# Line 2776  Intellectual Property and Copyright Stat Line 2894  Intellectual Property and Copyright Stat
2894                                          </p>                                          </p>
2895  <blockquote class="text">  <blockquote class="text">
2896  <p>identifier of the used MIDI input driver, as e.g.  <p>identifier of the used MIDI input driver, as e.g.
2897                                              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>
2898                                              command                                              command
2899  </p>  </p>
2900  </blockquote>  </blockquote>
# Line 2806  Intellectual Property and Copyright Stat Line 2924  Intellectual Property and Copyright Stat
2924                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
2925                      returned by all MIDI input devices. Every MIDI input driver                      returned by all MIDI input devices. Every MIDI input driver
2926                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
2927                      <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
2928                      by this command.                      by this command.
2929  </p>  </p>
2930  <p>Example:  <p>Example:
# Line 2826  Intellectual Property and Copyright Stat Line 2944  Intellectual Property and Copyright Stat
2944                                            
2945  </p>  </p>
2946  <a name="SET MIDI_INPUT_DEVICE_PARAMETER"></a><br /><hr />  <a name="SET MIDI_INPUT_DEVICE_PARAMETER"></a><br /><hr />
2947  <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>
2948  <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;
2949    Changing settings of MIDI input devices</h3>
2950    
2951  <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:
2952  </p>  </p>
# Line 2841  Intellectual Property and Copyright Stat Line 2960  Intellectual Property and Copyright Stat
2960  </p>  </p>
2961  <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
2962                      MIDI input device as returned by the                      MIDI input device as returned by the
2963                      <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>
2964                      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>
2965                      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
2966                      &lt;value&gt; by the new value for this parameter.                      &lt;value&gt; by the new value for this parameter.
2967  </p>  </p>
# Line 2893  Intellectual Property and Copyright Stat Line 3012  Intellectual Property and Copyright Stat
3012                                            
3013  </p>  </p>
3014  <a name="GET MIDI_INPUT_PORT INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_PORT INFO"></a><br /><hr />
3015  <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>
3016  <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;
3017    Getting information about a MIDI port</h3>
3018    
3019  <p>Use the following command to get information about a MIDI port:  <p>Use the following command to get information about a MIDI port:
3020  </p>  </p>
# Line 2907  Intellectual Property and Copyright Stat Line 3027  Intellectual Property and Copyright Stat
3027                                            
3028  </p>  </p>
3029  <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
3030                      <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>
3031                      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>
3032                      command and &lt;midi-port&gt; the MIDI input port number.                      command and &lt;midi-port&gt; the MIDI input port number.
3033  </p>  </p>
3034  <p>Possible Answers:  <p>Possible Answers:
# Line 2955  Intellectual Property and Copyright Stat Line 3075  Intellectual Property and Copyright Stat
3075                                            
3076  </p>  </p>
3077  <a name="GET MIDI_INPUT_PORT_PARAMETER INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_PORT_PARAMETER INFO"></a><br /><hr />
3078  <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>
3079  <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;
3080    Getting information about specific MIDI port parameter</h3>
3081    
3082  <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:
3083  </p>  </p>
# Line 2969  Intellectual Property and Copyright Stat Line 3090  Intellectual Property and Copyright Stat
3090                                            
3091  </p>  </p>
3092  <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
3093                      <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>
3094                      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>
3095                      command, &lt;port&gt; the MIDI port number and                      command, &lt;port&gt; the MIDI port number and
3096                      &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
3097                      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).
3098  </p>  </p>
3099  <p>Possible Answers:  <p>Possible Answers:
3100  </p>  </p>
# Line 3096  Intellectual Property and Copyright Stat Line 3217  Intellectual Property and Copyright Stat
3217                                            
3218  </p>  </p>
3219  <a name="SET MIDI_INPUT_PORT_PARAMETER"></a><br /><hr />  <a name="SET MIDI_INPUT_PORT_PARAMETER"></a><br /><hr />
3220  <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>
3221  <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;
3222    Changing settings of MIDI input ports</h3>
3223    
3224  <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:
3225  </p>  </p>
# Line 3111  Intellectual Property and Copyright Stat Line 3233  Intellectual Property and Copyright Stat
3233  </p>  </p>
3234  <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
3235                      MIDI device as returned by the                      MIDI device as returned by the
3236                      <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>
3237                      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>
3238                      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
3239                      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
3240                      parameter.                      parameter.
# Line 3162  Intellectual Property and Copyright Stat Line 3284  Intellectual Property and Copyright Stat
3284                                            
3285  </p>  </p>
3286  <a name="anchor11"></a><br /><hr />  <a name="anchor11"></a><br /><hr />
3287  <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>
3288  <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;
3289    Configuring sampler channels</h3>
3290    
3291  <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
3292                  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
3293                  MIDI and audio devices.                  MIDI and audio devices.
3294  </p>  </p>
3295  <a name="LOAD INSTRUMENT"></a><br /><hr />  <a name="LOAD INSTRUMENT"></a><br /><hr />
3296  <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>
3297  <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;
3298    Loading an instrument</h3>
3299    
3300  <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:
3301  </p>  </p>
# Line 3193  Intellectual Property and Copyright Stat Line 3317  Intellectual Property and Copyright Stat
3317                      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
3318                      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
3319                      returns immediately and a background process is launched to load the instrument                      returns immediately and a background process is launched to load the instrument
3320                      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>
3321                      command can be used to obtain loading                      command can be used to obtain loading
3322                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks
3323                      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 3371  Intellectual Property and Copyright Stat
3371                                            
3372  </p>  </p>
3373  <a name="LOAD ENGINE"></a><br /><hr />  <a name="LOAD ENGINE"></a><br /><hr />
3374  <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>
3375  <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;
3376    Loading a sampler engine</h3>
3377    
3378  <p>A sampler engine type can be associated to a specific sampler  <p>A sampler engine type can be associated to a specific sampler
3379                      channel by the following command:                      channel by the following command:
# Line 3262  Intellectual Property and Copyright Stat Line 3387  Intellectual Property and Copyright Stat
3387                                            
3388  </p>  </p>
3389  <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
3390                      <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;
3391                      the sampler channel as returned by the                      the sampler channel as returned by the
3392                      <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
3393                      <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
3394                      the engine type should be assigned to. This command should be issued                      the engine type should be assigned to. This command should be issued
3395                      after adding a new sampler channel and before any other control                      after adding a new sampler channel and before any other control
3396                      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 3446  Intellectual Property and Copyright Stat
3446                                            
3447  </p>  </p>
3448  <a name="GET CHANNELS"></a><br /><hr />  <a name="GET CHANNELS"></a><br /><hr />
3449  <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>
3450  <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;
3451    Getting all created sampler channel count</h3>
3452    
3453  <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
3454                      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 3485  Intellectual Property and Copyright Stat
3485                                            
3486  </p>  </p>
3487  <a name="LIST CHANNELS"></a><br /><hr />  <a name="LIST CHANNELS"></a><br /><hr />
3488  <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>
3489  <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;
3490    Getting all created sampler channel list</h3>
3491    
3492  <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
3493                      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 3525  Intellectual Property and Copyright Stat
3525                                            
3526  </p>  </p>
3527  <a name="ADD CHANNEL"></a><br /><hr />  <a name="ADD CHANNEL"></a><br /><hr />
3528  <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>
3529  <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;
3530    Adding a new sampler channel</h3>
3531    
3532  <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
3533                      channel list by sending the following command:                      channel list by sending the following command:
# Line 3472  Intellectual Property and Copyright Stat Line 3600  Intellectual Property and Copyright Stat
3600                                            
3601  </p>  </p>
3602  <a name="REMOVE CHANNEL"></a><br /><hr />  <a name="REMOVE CHANNEL"></a><br /><hr />
3603  <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>
3604  <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;
3605    Removing a sampler channel</h3>
3606    
3607  <p>A sampler channel can be removed by sending the following command:  <p>A sampler channel can be removed by sending the following command:
3608  </p>  </p>
# Line 3487  Intellectual Property and Copyright Stat Line 3616  Intellectual Property and Copyright Stat
3616  </p>  </p>
3617  <p>Where &lt;sampler-channel&gt; should be replaced by the  <p>Where &lt;sampler-channel&gt; should be replaced by the
3618                      number of the sampler channel as given by the                      number of the sampler channel as given by the
3619                      <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>
3620                      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>
3621                      command. The channel numbers of all subsequent sampler channels                      command. The channel numbers of all subsequent sampler channels
3622                      remain the same.                      remain the same.
3623  </p>  </p>
# Line 3538  Intellectual Property and Copyright Stat Line 3667  Intellectual Property and Copyright Stat
3667                                            
3668  </p>  </p>
3669  <a name="GET AVAILABLE_ENGINES"></a><br /><hr />  <a name="GET AVAILABLE_ENGINES"></a><br /><hr />
3670  <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>
3671  <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;
3672    Getting amount of available engines</h3>
3673    
3674  <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:
3675  </p>  </p>
# Line 3574  Intellectual Property and Copyright Stat Line 3704  Intellectual Property and Copyright Stat
3704                                            
3705  </p>  </p>
3706  <a name="LIST AVAILABLE_ENGINES"></a><br /><hr />  <a name="LIST AVAILABLE_ENGINES"></a><br /><hr />
3707  <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>
3708  <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;
3709    Getting all available engines</h3>
3710    
3711  <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:
3712  </p>  </p>
# Line 3613  Intellectual Property and Copyright Stat Line 3744  Intellectual Property and Copyright Stat
3744                                            
3745  </p>  </p>
3746  <a name="GET ENGINE INFO"></a><br /><hr />  <a name="GET ENGINE INFO"></a><br /><hr />
3747  <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>
3748  <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;
3749    Getting information about an engine</h3>
3750    
3751  <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
3752                      sending the following command:                      sending the following command:
# Line 3628  Intellectual Property and Copyright Stat Line 3760  Intellectual Property and Copyright Stat
3760                                            
3761  </p>  </p>
3762  <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
3763                      <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.
3764  </p>  </p>
3765  <p>Possible Answers:  <p>Possible Answers:
3766  </p>  </p>
# Line 3685  Intellectual Property and Copyright Stat Line 3817  Intellectual Property and Copyright Stat
3817                                            
3818  </p>  </p>
3819  <a name="GET CHANNEL INFO"></a><br /><hr />  <a name="GET CHANNEL INFO"></a><br /><hr />
3820  <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>
3821  <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;
3822    Getting sampler channel information</h3>
3823    
3824  <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
3825                      by sending the following command:                      by sending the following command:
# Line 3700  Intellectual Property and Copyright Stat Line 3833  Intellectual Property and Copyright Stat
3833                                            
3834  </p>  </p>
3835  <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
3836                      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>
3837                      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.
3838  </p>  </p>
3839  <p>Possible Answers:  <p>Possible Answers:
3840  </p>  </p>
# Line 3829  Intellectual Property and Copyright Stat Line 3962  Intellectual Property and Copyright Stat
3962                                          </p>                                          </p>
3963  <blockquote class="text">  <blockquote class="text">
3964  <p>optionally dotted number for the channel volume factor  <p>optionally dotted number for the channel volume factor
3965                                              (where a value < 1.0 means attenuation and a value >                                              (where a value &lt; 1.0 means attenuation and a value >
3966                                              1.0 means amplification)                                              1.0 means amplification)
3967  </p>  </p>
3968  </blockquote>  </blockquote>
# Line 3856  Intellectual Property and Copyright Stat Line 3989  Intellectual Property and Copyright Stat
3989  </blockquote>  </blockquote>
3990                                                                            
3991    
3992    <p>MIDI_INSTRUMENT_MAP -
3993                                            </p>
3994    <blockquote class="text">
3995    <p>Determines to which MIDI instrument map this sampler
3996                                                channel is assigned to. Read chapter
3997                                                <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>
3998                                                for a list of possible values.
3999    </p>
4000    </blockquote>
4001                                        
4002    
4003  </blockquote>  </blockquote>
4004                                                            
4005    
# Line 3895  Intellectual Property and Copyright Stat Line 4039  Intellectual Property and Copyright Stat
4039  </p>  </p>
4040  <p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"  <p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"
4041  </p>  </p>
4042    <p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
4043    </p>
4044    <p>&nbsp;&nbsp;&nbsp;"MUTE: false"
4045    </p>
4046    <p>&nbsp;&nbsp;&nbsp;"SOLO: false"
4047    </p>
4048    <p>&nbsp;&nbsp;&nbsp;"MIDI_INSTRUMENT_MAP: NONE"
4049    </p>
4050  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
4051  </p>  </p>
4052  </blockquote><p>  </blockquote><p>
4053                                            
4054  </p>  </p>
4055  <a name="GET CHANNEL VOICE_COUNT"></a><br /><hr />  <a name="GET CHANNEL VOICE_COUNT"></a><br /><hr />
4056  <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>
4057  <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;
4058    Current number of active voices</h3>
4059    
4060  <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
4061                      sampler channel by sending the following command:                      sampler channel by sending the following command:
# Line 3916  Intellectual Property and Copyright Stat Line 4069  Intellectual Property and Copyright Stat
4069                                            
4070  </p>  </p>
4071  <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
4072                      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>
4073                      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.
4074  </p>  </p>
4075  <p>Possible Answers:  <p>Possible Answers:
4076  </p>  </p>
# Line 3941  Intellectual Property and Copyright Stat Line 4094  Intellectual Property and Copyright Stat
4094                                            
4095  </p>  </p>
4096  <a name="GET CHANNEL STREAM_COUNT"></a><br /><hr />  <a name="GET CHANNEL STREAM_COUNT"></a><br /><hr />
4097  <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>
4098  <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;
4099    Current number of active disk streams</h3>
4100    
4101  <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
4102                      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 4110  Intellectual Property and Copyright Stat
4110                                            
4111  </p>  </p>
4112  <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
4113                      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>
4114                      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.
4115  </p>  </p>
4116  <p>Possible Answers:  <p>Possible Answers:
4117  </p>  </p>
# Line 3983  Intellectual Property and Copyright Stat Line 4137  Intellectual Property and Copyright Stat
4137                                            
4138  </p>  </p>
4139  <a name="GET CHANNEL BUFFER_FILL"></a><br /><hr />  <a name="GET CHANNEL BUFFER_FILL"></a><br /><hr />
4140  <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>
4141  <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;
4142    Current fill state of disk stream buffers</h3>
4143    
4144  <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
4145                      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 4164  Intellectual Property and Copyright Stat
4164  </p>  </p>
4165  <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
4166                      sampler channel number the front-end is interested in                      sampler channel number the front-end is interested in
4167                      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>
4168                      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.
4169  </p>  </p>
4170  <p>Possible Answers:  <p>Possible Answers:
4171  </p>  </p>
# Line 4060  Intellectual Property and Copyright Stat Line 4215  Intellectual Property and Copyright Stat
4215                                            
4216  </p>  </p>
4217  <a name="SET CHANNEL AUDIO_OUTPUT_DEVICE"></a><br /><hr />  <a name="SET CHANNEL AUDIO_OUTPUT_DEVICE"></a><br /><hr />
4218  <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>
4219  <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;
4220    Setting audio output device</h3>
4221    
4222  <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
4223                      channel by sending the following command:                      channel by sending the following command:
# Line 4075  Intellectual Property and Copyright Stat Line 4231  Intellectual Property and Copyright Stat
4231                                            
4232  </p>  </p>
4233  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4234                      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>
4235                      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
4236                      &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
4237                      <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>
4238                      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>
4239                      command.                      command.
4240  </p>  </p>
4241  <p>Possible Answers:  <p>Possible Answers:
# Line 4126  Intellectual Property and Copyright Stat Line 4282  Intellectual Property and Copyright Stat
4282  </blockquote><p>  </blockquote><p>
4283                                            
4284  </p>  </p>
4285  <a name="SET CHANNEL AUDIO_OUTPUT_TYP"></a><br /><hr />  <a name="SET CHANNEL AUDIO_OUTPUT_TYPE"></a><br /><hr />
4286  <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>
4287  <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;
4288    Setting audio output type</h3>
4289    
4290  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
4291  </p>  </p>
# Line 4191  Intellectual Property and Copyright Stat Line 4348  Intellectual Property and Copyright Stat
4348                                            
4349  </p>  </p>
4350  <a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr />  <a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
4351  <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>
4352  <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;
4353    Setting audio output channel</h3>
4354    
4355  <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
4356                      sampler channel by sending the following command:                      sampler channel by sending the following command:
# Line 4206  Intellectual Property and Copyright Stat Line 4364  Intellectual Property and Copyright Stat
4364                                            
4365  </p>  </p>
4366  <p>Where &lt;sampler-chan&gt; is the sampler channel number  <p>Where &lt;sampler-chan&gt; is the sampler channel number
4367                      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>
4368                      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
4369                      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
4370                      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
4371                      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 4415  Intellectual Property and Copyright Stat
4415                                            
4416  </p>  </p>
4417  <a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr />
4418  <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>
4419  <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;
4420    Setting MIDI input device</h3>
4421    
4422  <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
4423                      channel by sending the following command:                      channel by sending the following command:
# Line 4272  Intellectual Property and Copyright Stat Line 4431  Intellectual Property and Copyright Stat
4431                                            
4432  </p>  </p>
4433  <p>Where &lt;sampler-channel&gt; is the sampler channel number  <p>Where &lt;sampler-channel&gt; is the sampler channel number
4434                      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>
4435                      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
4436                      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
4437                      <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>
4438                      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.
4439  </p>  </p>
4440  <p>Possible Answers:  <p>Possible Answers:
4441  </p>  </p>
# Line 4323  Intellectual Property and Copyright Stat Line 4482  Intellectual Property and Copyright Stat
4482                                            
4483  </p>  </p>
4484  <a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr />
4485  <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>
4486  <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;
4487    Setting MIDI input type</h3>
4488    
4489  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
4490  </p>  </p>
# Line 4387  Intellectual Property and Copyright Stat Line 4547  Intellectual Property and Copyright Stat
4547                                            
4548  </p>  </p>
4549  <a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr />
4550  <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>
4551  <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;
4552    Setting MIDI input port</h3>
4553    
4554  <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
4555                      channel by sending the following command:                      channel by sending the following command:
# Line 4450  Intellectual Property and Copyright Stat Line 4611  Intellectual Property and Copyright Stat
4611                                            
4612  </p>  </p>
4613  <a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr />
4614  <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>
4615  <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;
4616    Setting MIDI input channel</h3>
4617    
4618  <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
4619                      listen to by sending the following command:                      listen to by sending the following command:
# Line 4513  Intellectual Property and Copyright Stat Line 4675  Intellectual Property and Copyright Stat
4675                                            
4676  </p>  </p>
4677  <a name="SET CHANNEL VOLUME"></a><br /><hr />  <a name="SET CHANNEL VOLUME"></a><br /><hr />
4678  <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>
4679  <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;
4680    Setting channel volume</h3>
4681    
4682  <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
4683                      the following command:                      the following command:
# Line 4577  Intellectual Property and Copyright Stat Line 4740  Intellectual Property and Copyright Stat
4740                                            
4741  </p>  </p>
4742  <a name="SET CHANNEL MUTE"></a><br /><hr />  <a name="SET CHANNEL MUTE"></a><br /><hr />
4743  <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>
4744  <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;
4745    Muting a sampler channel</h3>
4746    
4747  <p>The front-end can mute/unmute a specific sampler  <p>The front-end can mute/unmute a specific sampler
4748                      channel by sending the following command:                      channel by sending the following command:
# Line 4592  Intellectual Property and Copyright Stat Line 4756  Intellectual Property and Copyright Stat
4756                                            
4757  </p>  </p>
4758  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4759                      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>
4760                      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
4761                      &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"
4762                      to unmute the channel.                      to unmute the channel.
4763  </p>  </p>
# Line 4642  Intellectual Property and Copyright Stat Line 4806  Intellectual Property and Copyright Stat
4806                                            
4807  </p>  </p>
4808  <a name="SET CHANNEL SOLO"></a><br /><hr />  <a name="SET CHANNEL SOLO"></a><br /><hr />
4809  <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>
4810  <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;
4811    Soloing a sampler channel</h3>
4812    
4813  <p>The front-end can solo/unsolo a specific sampler channel  <p>The front-end can solo/unsolo a specific sampler channel
4814                      by sending the following command:                      by sending the following command:
# Line 4657  Intellectual Property and Copyright Stat Line 4822  Intellectual Property and Copyright Stat
4822                                            
4823  </p>  </p>
4824  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4825                      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>
4826                      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
4827                      &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"
4828                      to unsolo the channel.                      to unsolo the channel.
4829  </p>  </p>
# Line 4706  Intellectual Property and Copyright Stat Line 4871  Intellectual Property and Copyright Stat
4871  </blockquote><p>  </blockquote><p>
4872                                            
4873  </p>  </p>
4874    <a name="SET CHANNEL MIDI_INSTRUMENT_MAP"></a><br /><hr />
4875    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4876    <a name="rfc.section.6.4.24"></a><h3>6.4.24.&nbsp;
4877    Assigning a MIDI instrument map to a sampler channel</h3>
4878    
4879    <p>The front-end can assign a MIDI instrument map to a specific sampler channel
4880                        by sending the following command:
4881    </p>
4882    <p>
4883                            </p>
4884    <blockquote class="text">
4885    <p>SET CHANNEL MIDI_INSTRUMENT_MAP &lt;sampler-channel&gt; &lt;map&gt;
4886    </p>
4887    </blockquote><p>
4888                        
4889    </p>
4890    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4891                        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>
4892                        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
4893                        &lt;map&gt; can have the following possibilites:
4894    </p>
4895    <p>
4896                            </p>
4897    <blockquote class="text">
4898    <p>"NONE" -
4899                                    </p>
4900    <blockquote class="text">
4901    <p>This is the default setting. In this case
4902                                        the sampler channel is not assigned any MIDI
4903                                        instrument map and thus will ignore all MIDI
4904                                        program change messages.
4905    </p>
4906    </blockquote>
4907                                
4908    
4909    <p>"DEFAULT" -
4910                                    </p>
4911    <blockquote class="text">
4912    <p>The sampler channel will always use the
4913                                        default MIDI instrument map to handle MIDI
4914                                        program change messages.
4915    </p>
4916    </blockquote>
4917                                
4918    
4919    <p>numeric ID -
4920                                    </p>
4921    <blockquote class="text">
4922    <p>You can assign a specific MIDI instrument map
4923                                        by replacing &lt;map&gt; with the respective numeric
4924                                        ID of the MIDI instrument map as returned by the
4925                                        <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>
4926                                        command. Once that map will be deleted, the sampler
4927                                        channel would fall back to "NONE".
4928    </p>
4929    </blockquote>
4930                                
4931    
4932    </blockquote><p>
4933                        
4934    </p>
4935    <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>
4936                        for details regarding MIDI instrument mapping.
4937    </p>
4938    <p>Possible Answers:
4939    </p>
4940    <p>
4941                            </p>
4942    <blockquote class="text">
4943    <p>"OK" -
4944                                    </p>
4945    <blockquote class="text">
4946    <p>on success
4947    </p>
4948    </blockquote>
4949                                
4950    
4951    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4952                                    </p>
4953    <blockquote class="text">
4954    <p>in case it failed, providing an appropriate error code and error message
4955    </p>
4956    </blockquote>
4957                                
4958    
4959    </blockquote><p>
4960                        
4961    </p>
4962    <p>Examples:
4963    </p>
4964    <p>
4965                            </p>
4966    <blockquote class="text">
4967    <p>
4968    </p>
4969    </blockquote><p>
4970                        
4971    </p>
4972    <a name="CREATE FX_SEND"></a><br /><hr />
4973    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4974    <a name="rfc.section.6.4.25"></a><h3>6.4.25.&nbsp;
4975    Adding an effect send to a sampler channel</h3>
4976    
4977    <p>The front-end can create an additional effect send on a specific sampler channel
4978                        by sending the following command:
4979    </p>
4980    <p>
4981                            </p>
4982    <blockquote class="text">
4983    <p>CREATE FX_SEND &lt;sampler-channel&gt; &lt;midi-ctrl&gt; [&lt;name&gt;]
4984    </p>
4985    </blockquote><p>
4986                        
4987    </p>
4988    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4989                        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>
4990                        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
4991                        sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
4992                        is a number between 0..127 defining the MIDI controller which can alter the
4993                        effect send level and &lt;name&gt; is an optional argument defining a name
4994                        for the effect send entity. The name does not have to be unique.
4995    </p>
4996    <p>By default, that is as initial routing, the effect send's audio channels
4997                        are automatically routed to the last audio channels of the sampler channel's
4998                        audio output device, that way you can i.e. first increase the amount of audio
4999                        channels on the audio output device for having dedicated effect send output
5000                        channels and when "CREATE FX_SEND" is called, those channels will automatically
5001                        be picked. You can alter the destination channels however with
5002                        <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>.
5003                        
5004    </p>
5005    <p>Note: Create effect sends on a sampler channel only when needed, because having effect
5006                        sends on a sampler channel will decrease runtime performance, because for implementing channel
5007                        effect sends, separate (sampler channel local) audio buffers are needed to render and mix
5008                        the voices and route the audio signal afterwards to the master outputs and effect send
5009                        outputs (along with their respective effect send levels). A sampler channel without effect
5010                        sends however can mix its voices directly into the audio output devices's audio buffers
5011                        and is thus faster.
5012                        
5013    </p>
5014    <p>Possible Answers:
5015    </p>
5016    <p>
5017                            </p>
5018    <blockquote class="text">
5019    <p>"OK[&lt;fx-send-id&gt;]" -
5020                                    </p>
5021    <blockquote class="text">
5022    <p>in case a new effect send could be added to the
5023                                        sampler channel, where &lt;fx-send-id&gt; reflects the
5024                                        unique ID of the newly created effect send entity
5025    </p>
5026    </blockquote>
5027                                
5028    
5029    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5030                                    </p>
5031    <blockquote class="text">
5032    <p>when a new effect send could not be added, i.e.
5033                                        due to invalid parameters
5034    </p>
5035    </blockquote>
5036                                
5037    
5038    </blockquote><p>
5039                        
5040    </p>
5041    <p>Examples:
5042    </p>
5043    <p>
5044                            </p>
5045    <blockquote class="text">
5046    <p>C: "CREATE FX_SEND 0 91 'Reverb Send'"
5047    </p>
5048    <p>S: "OK[0]"
5049    </p>
5050    </blockquote><p>
5051                        
5052    </p>
5053    <p>
5054                            </p>
5055    <blockquote class="text">
5056    <p>C: "CREATE FX_SEND 0 93"
5057    </p>
5058    <p>S: "OK[1]"
5059    </p>
5060    </blockquote><p>
5061                        
5062    </p>
5063    <a name="DESTROY FX_SEND"></a><br /><hr />
5064    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5065    <a name="rfc.section.6.4.26"></a><h3>6.4.26.&nbsp;
5066    Removing an effect send from a sampler channel</h3>
5067    
5068    <p>The front-end can remove an existing effect send on a specific sampler channel
5069                        by sending the following command:
5070    </p>
5071    <p>
5072                            </p>
5073    <blockquote class="text">
5074    <p>DESTROY FX_SEND &lt;sampler-channel&gt; &lt;fx-send-id&gt;
5075    </p>
5076    </blockquote><p>
5077                        
5078    </p>
5079    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5080                        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>
5081                        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
5082                        sampler channel from which the effect send should be removed from and
5083                        &lt;fx-send-id&gt; is the respective effect send number as returned by the
5084                        <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>
5085                        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.
5086    </p>
5087    <p>Possible Answers:
5088    </p>
5089    <p>
5090                            </p>
5091    <blockquote class="text">
5092    <p>"OK" -
5093                                    </p>
5094    <blockquote class="text">
5095    <p>on success
5096    </p>
5097    </blockquote>
5098                                
5099    
5100    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5101                                    </p>
5102    <blockquote class="text">
5103    <p>in case it failed, providing an appropriate error code and
5104                                        error message
5105    </p>
5106    </blockquote>
5107                                
5108    
5109    </blockquote><p>
5110                        
5111    </p>
5112    <p>Example:
5113    </p>
5114    <p>
5115                            </p>
5116    <blockquote class="text">
5117    <p>C: "DESTROY FX_SEND 0 0"
5118    </p>
5119    <p>S: "OK"
5120    </p>
5121    </blockquote><p>
5122                        
5123    </p>
5124    <a name="GET FX_SENDS"></a><br /><hr />
5125    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5126    <a name="rfc.section.6.4.27"></a><h3>6.4.27.&nbsp;
5127    Getting amount of effect sends on a sampler channel</h3>
5128    
5129    <p>The front-end can ask for the amount of effect sends on a specific sampler channel
5130                        by sending the following command:
5131    </p>
5132    <p>
5133                            </p>
5134    <blockquote class="text">
5135    <p>GET FX_SENDS &lt;sampler-channel&gt;
5136    </p>
5137    </blockquote><p>
5138                        
5139    </p>
5140    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5141                        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>
5142                        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.
5143    </p>
5144    <p>Possible Answers:
5145    </p>
5146    <p>
5147                            </p>
5148    <blockquote class="text">
5149    <p>The sampler will answer by returning the number of effect
5150                                sends on the given sampler channel.
5151    </p>
5152    </blockquote><p>
5153                        
5154    </p>
5155    <p>Example:
5156    </p>
5157    <p>
5158                            </p>
5159    <blockquote class="text">
5160    <p>C: "GET FX_SENDS 0"
5161    </p>
5162    <p>S: "2"
5163    </p>
5164    </blockquote><p>
5165                        
5166    </p>
5167    <a name="LIST FX_SENDS"></a><br /><hr />
5168    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5169    <a name="rfc.section.6.4.28"></a><h3>6.4.28.&nbsp;
5170    Listing all effect sends on a sampler channel</h3>
5171    
5172    <p>The front-end can ask for a list of effect sends on a specific sampler channel
5173                        by sending the following command:
5174    </p>
5175    <p>
5176                            </p>
5177    <blockquote class="text">
5178    <p>LIST FX_SENDS &lt;sampler-channel&gt;
5179    </p>
5180    </blockquote><p>
5181                        
5182    </p>
5183    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5184                        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>
5185                        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.
5186    </p>
5187    <p>Possible Answers:
5188    </p>
5189    <p>
5190                            </p>
5191    <blockquote class="text">
5192    <p>The sampler will answer by returning a comma separated list
5193                                with all effect sends' numerical IDs on the given sampler
5194                                channel.
5195    </p>
5196    </blockquote><p>
5197                        
5198    </p>
5199    <p>Examples:
5200    </p>
5201    <p>
5202                            </p>
5203    <blockquote class="text">
5204    <p>C: "LIST FX_SENDS 0"
5205    </p>
5206    <p>S: "0,1"
5207    </p>
5208    </blockquote><p>
5209                        
5210    </p>
5211    <p>
5212                            </p>
5213    <blockquote class="text">
5214    <p>C: "LIST FX_SENDS 1"
5215    </p>
5216    <p>S: ""
5217    </p>
5218    </blockquote><p>
5219                        
5220    </p>
5221    <a name="GET FX_SEND INFO"></a><br /><hr />
5222    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5223    <a name="rfc.section.6.4.29"></a><h3>6.4.29.&nbsp;
5224    Getting effect send information</h3>
5225    
5226    <p>The front-end can ask for the current settings of an effect send entity
5227                        by sending the following command:
5228    </p>
5229    <p>
5230                            </p>
5231    <blockquote class="text">
5232    <p>GET FX_SEND INFO &lt;sampler-channel&gt; &lt;fx-send-id&gt;
5233    </p>
5234    </blockquote><p>
5235                        
5236    </p>
5237    <p>Where &lt;sampler-channel&gt; is the sampler channel number
5238                        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>
5239                        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
5240                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5241                        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>
5242                        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.
5243                      
5244    </p>
5245    <p>Possible Answers:
5246    </p>
5247    <p>
5248                            </p>
5249    <blockquote class="text">
5250    <p>The sampler will answer by sending a &lt;CRLF&gt; separated list.
5251                                Each answer line begins with the settings category name
5252                                followed by a colon and then a space character &lt;SP&gt; and finally
5253                                the info character string to that setting category. At the
5254                                moment the following categories are defined:
5255    </p>
5256    <p>
5257                                    </p>
5258    <blockquote class="text">
5259    <p>NAME -
5260                                            </p>
5261    <blockquote class="text">
5262    <p>name of the effect send entity
5263    </p>
5264    </blockquote>
5265                                        
5266    
5267    <p>MIDI_CONTROLLER -
5268                                            </p>
5269    <blockquote class="text">
5270    <p>a value between 0 and 127 reflecting the MIDI controller
5271                                                which is able to modify the effect send's send level
5272    </p>
5273    </blockquote>
5274                                        
5275    
5276    <p>LEVEL -
5277                                            </p>
5278    <blockquote class="text">
5279    <p>optionally dotted number reflecting the effect send's
5280                                                current send level (where a value &lt; 1.0 means attenuation
5281                                                and a value > 1.0 means amplification)
5282    </p>
5283    </blockquote>
5284                                        
5285    
5286    <p>AUDIO_OUTPUT_ROUTING -
5287                                            </p>
5288    <blockquote class="text">
5289    <p>comma separated list which reflects to which audio
5290                                                channel of the selected audio output device each
5291                                                effect send output channel is routed to, e.g. "0,3" would
5292                                                mean the effect send's output channel 0 is routed to channel
5293                                                0 of the audio output device and the effect send's output
5294                                                channel 1 is routed to the channel 3 of the audio
5295                                                output device (see
5296                                                <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>
5297                                                for details)
5298    </p>
5299    </blockquote>
5300                                        
5301    
5302    </blockquote>
5303                                
5304    
5305    </blockquote><p>
5306                        
5307    </p>
5308    <p>The mentioned fields above don't have to be in particular order.
5309    </p>
5310    <p>Example:
5311    </p>
5312    <p>
5313                            </p>
5314    <blockquote class="text">
5315    <p>C: "GET FX_SEND INFO 0 0"
5316    </p>
5317    <p>S: "NAME: Reverb Send"
5318    </p>
5319    <p>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"
5320    </p>
5321    <p>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"
5322    </p>
5323    <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"
5324    </p>
5325    <p>&nbsp;&nbsp;&nbsp;"."
5326    </p>
5327    </blockquote><p>
5328                        
5329    </p>
5330    <a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
5331    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5332    <a name="rfc.section.6.4.30"></a><h3>6.4.30.&nbsp;
5333    Altering effect send's audio routing</h3>
5334    
5335    <p>The front-end can alter the destination of an effect send's audio channel on a specific
5336                        sampler channel by sending the following command:
5337    </p>
5338    <p>
5339                            </p>
5340    <blockquote class="text">
5341    <p>SET FX_SEND AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;audio-src&gt; &lt;audio-dst&gt;
5342    </p>
5343    </blockquote><p>
5344                        
5345    </p>
5346    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5347                        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>
5348                        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,
5349                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5350                        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>
5351                        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,
5352                        &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
5353                        which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
5354                        the audio channel of the selected audio output device where &lt;audio-src&gt;
5355                        should be routed to.
5356    </p>
5357    <p>Note that effect sends can only route audio to the same audio output
5358                        device as assigned to the effect send's sampler channel. Also note that an
5359                        effect send entity does always have exactly as much audio channels as its
5360                        sampler channel. So if the sampler channel is stereo, the effect send does
5361                        have two audio channels as well. Also keep in mind that the amount of audio
5362                        channels on a sampler channel might be dependant not only to the deployed
5363                        sampler engine on the sampler channel, but also dependant to the instrument
5364                        currently loaded. However you can (effectively) turn an i.e. stereo effect
5365                        send into a mono one by simply altering its audio routing appropriately.
5366    </p>
5367    <p>Possible Answers:
5368    </p>
5369    <p>
5370                            </p>
5371    <blockquote class="text">
5372    <p>"OK" -
5373                                    </p>
5374    <blockquote class="text">
5375    <p>on success
5376    </p>
5377    </blockquote>
5378                                
5379    
5380    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5381                                    </p>
5382    <blockquote class="text">
5383    <p>if audio output channel was set, but there are noteworthy
5384                                        issue(s) related, providing an appropriate warning code and
5385                                        warning message
5386    </p>
5387    </blockquote>
5388                                
5389    
5390    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5391                                    </p>
5392    <blockquote class="text">
5393    <p>in case it failed, providing an appropriate error code and error message
5394    </p>
5395    </blockquote>
5396                                
5397    
5398    </blockquote><p>
5399                        
5400    </p>
5401    <p>Example:
5402    </p>
5403    <p>
5404                            </p>
5405    <blockquote class="text">
5406    <p>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
5407    </p>
5408    <p>S: "OK"
5409    </p>
5410    </blockquote><p>
5411                        
5412    </p>
5413    <a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />
5414    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5415    <a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;
5416    Altering effect send's MIDI controller</h3>
5417    
5418    <p>The front-end can alter the MIDI controller of an effect
5419                        send entity by sending the following command:
5420    </p>
5421    <p>
5422                            </p>
5423    <blockquote class="text">
5424    <p>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;
5425    </p>
5426    </blockquote><p>
5427                        
5428    </p>
5429    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5430                        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>
5431                        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,
5432                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5433                        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>
5434                        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
5435                        &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
5436                        able to modify the effect send's send level.
5437    </p>
5438    <p>Possible Answers:
5439    </p>
5440    <p>
5441                            </p>
5442    <blockquote class="text">
5443    <p>"OK" -
5444                                    </p>
5445    <blockquote class="text">
5446    <p>on success
5447    </p>
5448    </blockquote>
5449                                
5450    
5451    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5452                                    </p>
5453    <blockquote class="text">
5454    <p>if MIDI controller was set, but there are noteworthy
5455                                        issue(s) related, providing an appropriate warning code and
5456                                        warning message
5457    </p>
5458    </blockquote>
5459                                
5460    
5461    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5462                                    </p>
5463    <blockquote class="text">
5464    <p>in case it failed, providing an appropriate error code and error message
5465    </p>
5466    </blockquote>
5467                                
5468    
5469    </blockquote><p>
5470                        
5471    </p>
5472    <p>Example:
5473    </p>
5474    <p>
5475                            </p>
5476    <blockquote class="text">
5477    <p>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
5478    </p>
5479    <p>S: "OK"
5480    </p>
5481    </blockquote><p>
5482                        
5483    </p>
5484    <a name="SET FX_SEND LEVEL"></a><br /><hr />
5485    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5486    <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;
5487    Altering effect send's send level</h3>
5488    
5489    <p>The front-end can alter the current send level of an effect
5490                        send entity by sending the following command:
5491    </p>
5492    <p>
5493                            </p>
5494    <blockquote class="text">
5495    <p>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;
5496    </p>
5497    </blockquote><p>
5498                        
5499    </p>
5500    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5501                        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>
5502                        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,
5503                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5504                        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>
5505                        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
5506                        &lt;volume&gt; is an optionally dotted positive number (a value
5507                        smaller than 1.0 means attenuation, whereas a value greater than
5508                        1.0 means amplification) reflecting the new send level.
5509    </p>
5510    <p>Possible Answers:
5511    </p>
5512    <p>
5513                            </p>
5514    <blockquote class="text">
5515    <p>"OK" -
5516                                    </p>
5517    <blockquote class="text">
5518    <p>on success
5519    </p>
5520    </blockquote>
5521                                
5522    
5523    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5524                                    </p>
5525    <blockquote class="text">
5526    <p>if new send level was set, but there are noteworthy
5527                                        issue(s) related, providing an appropriate warning code and
5528                                        warning message
5529    </p>
5530    </blockquote>
5531                                
5532    
5533    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5534                                    </p>
5535    <blockquote class="text">
5536    <p>in case it failed, providing an appropriate error code and error message
5537    </p>
5538    </blockquote>
5539                                
5540    
5541    </blockquote><p>
5542                        
5543    </p>
5544    <p>Example:
5545    </p>
5546    <p>
5547                            </p>
5548    <blockquote class="text">
5549    <p>C: "SET FX_SEND LEVEL 0 0 0.15"
5550    </p>
5551    <p>S: "OK"
5552    </p>
5553    </blockquote><p>
5554                        
5555    </p>
5556  <a name="RESET CHANNEL"></a><br /><hr />  <a name="RESET CHANNEL"></a><br /><hr />
5557  <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>
5558  <a name="rfc.section.6.4.24"></a><h3>6.4.24.&nbsp;Resetting a sampler channel</h3>  <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;
5559    Resetting a sampler channel</h3>
5560    
5561  <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:
5562  </p>  </p>
# Line 4772  Intellectual Property and Copyright Stat Line 5620  Intellectual Property and Copyright Stat
5620                                            
5621  </p>  </p>
5622  <a name="anchor12"></a><br /><hr />  <a name="anchor12"></a><br /><hr />
5623  <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>
5624  <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;
5625    Controlling connection</h3>
5626    
5627  <p>The following commands are used to control the connection to LinuxSampler.  <p>The following commands are used to control the connection to LinuxSampler.
5628  </p>  </p>
5629  <a name="SUBSCRIBE"></a><br /><hr />  <a name="SUBSCRIBE"></a><br /><hr />
5630  <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>
5631  <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;
5632    Register front-end for receiving event messages</h3>
5633    
5634  <p>The front-end can register itself to the LinuxSampler application to  <p>The front-end can register itself to the LinuxSampler application to
5635                      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 5691  Intellectual Property and Copyright Stat
5691                                            
5692  </p>  </p>
5693  <a name="UNSUBSCRIBE"></a><br /><hr />  <a name="UNSUBSCRIBE"></a><br /><hr />
5694  <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>
5695  <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;
5696    Unregister front-end for not receiving event messages</h3>
5697    
5698  <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
5699                      messages anymore by sending the following command:                      messages anymore by sending the following command:
# Line 4904  Intellectual Property and Copyright Stat Line 5755  Intellectual Property and Copyright Stat
5755                                            
5756  </p>  </p>
5757  <a name="SET ECHO"></a><br /><hr />  <a name="SET ECHO"></a><br /><hr />
5758  <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>
5759  <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;
5760    Enable or disable echo of commands</h3>
5761    
5762  <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:
5763  </p>  </p>
# Line 4960  Intellectual Property and Copyright Stat Line 5812  Intellectual Property and Copyright Stat
5812                                            
5813  </p>  </p>
5814  <a name="QUIT"></a><br /><hr />  <a name="QUIT"></a><br /><hr />
5815  <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>
5816  <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;
5817    Close client connection</h3>
5818    
5819  <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:
5820  </p>  </p>
# Line 4977  Intellectual Property and Copyright Stat Line 5830  Intellectual Property and Copyright Stat
5830                      LinuxSampler than really useful for a front-end implementation.                      LinuxSampler than really useful for a front-end implementation.
5831  </p>  </p>
5832  <a name="anchor13"></a><br /><hr />  <a name="anchor13"></a><br /><hr />
5833  <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>
5834  <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;
5835    Global commands</h3>
5836    
5837  <p>The following commands have global impact on the sampler.  <p>The following commands have global impact on the sampler.
5838  </p>  </p>
5839  <a name="GET TOTAL_VOICE_COUNT"></a><br /><hr />  <a name="GET TOTAL_VOICE_COUNT"></a><br /><hr />
5840  <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>
5841  <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;
5842    Current number of active voices</h3>
5843    
5844  <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
5845                      the sampler by sending the following command:                      the sampler by sending the following command:
# Line 5009  Intellectual Property and Copyright Stat Line 5864  Intellectual Property and Copyright Stat
5864                                            
5865  </p>  </p>
5866  <a name="GET TOTAL_VOICE_COUNT_MAX"></a><br /><hr />  <a name="GET TOTAL_VOICE_COUNT_MAX"></a><br /><hr />
5867  <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>
5868  <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;
5869    Maximum amount of active voices</h3>
5870    
5871  <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
5872                      by sending the following command:                      by sending the following command:
# Line 5035  Intellectual Property and Copyright Stat Line 5891  Intellectual Property and Copyright Stat
5891                                            
5892  </p>  </p>
5893  <a name="RESET"></a><br /><hr />  <a name="RESET"></a><br /><hr />
5894  <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>
5895  <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;
5896    Reset sampler</h3>
5897    
5898  <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:
5899  </p>  </p>
# Line 5075  Intellectual Property and Copyright Stat Line 5932  Intellectual Property and Copyright Stat
5932                                            
5933  </p>  </p>
5934  <a name="GET SERVER INFO"></a><br /><hr />  <a name="GET SERVER INFO"></a><br /><hr />
5935  <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>
5936  <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;
5937    General sampler informations</h3>
5938    
5939  <p>The client can ask for general informations about the LinuxSampler  <p>The client can ask for general informations about the LinuxSampler
5940                         instance by sending the following command:                         instance by sending the following command:
# Line 5124  Intellectual Property and Copyright Stat Line 5982  Intellectual Property and Copyright Stat
5982                                          </p>                                          </p>
5983  <blockquote class="text">  <blockquote class="text">
5984  <p>version of the LSCP specification the sampler  <p>version of the LSCP specification the sampler
5985                                              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)
5986  </p>  </p>
5987  </blockquote>  </blockquote>
5988                                                                            
# Line 5138  Intellectual Property and Copyright Stat Line 5996  Intellectual Property and Copyright Stat
5996  <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.
5997                      Other fields might be added in future.                      Other fields might be added in future.
5998  </p>  </p>
5999    <a name="GET VOLUME"></a><br /><hr />
6000    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6001    <a name="rfc.section.6.6.5"></a><h3>6.6.5.&nbsp;
6002    Getting global volume attenuation</h3>
6003    
6004    <p>The client can ask for the current global sampler-wide volume
6005                        attenuation by sending the following command:
6006    </p>
6007    <p>
6008                            </p>
6009    <blockquote class="text">
6010    <p>GET VOLUME
6011    </p>
6012    </blockquote><p>
6013                        
6014    </p>
6015    <p>Possible Answers:
6016    </p>
6017    <p>
6018                            </p>
6019    <blockquote class="text">
6020    <p>The sampler will always answer by returning the optional
6021                                dotted floating point coefficient, reflecting the current
6022                                global volume attenuation.
6023                                
6024    </p>
6025    </blockquote><p>
6026                        
6027    </p>
6028    <p>Note: it is up to the respective sampler engine whether to obey
6029                        that global volume parameter or not, but in general all engines SHOULD
6030                        use this parameter.
6031    </p>
6032    <a name="SET VOLUME"></a><br /><hr />
6033    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6034    <a name="rfc.section.6.6.6"></a><h3>6.6.6.&nbsp;
6035    Setting global volume attenuation</h3>
6036    
6037    <p>The client can alter the current global sampler-wide volume
6038                        attenuation by sending the following command:
6039    </p>
6040    <p>
6041                            </p>
6042    <blockquote class="text">
6043    <p>SET VOLUME &lt;volume&gt;
6044    </p>
6045    </blockquote><p>
6046                        
6047    </p>
6048    <p>Where &lt;volume&gt; should be replaced by the optional dotted
6049                       floating point value, reflecting the new global volume parameter.
6050                       This value might usually be in the range between 0.0 and 1.0, that
6051                       is for attenuating the overall volume.
6052    </p>
6053    <p>Possible Answers:
6054    </p>
6055    <p>
6056                            </p>
6057    <blockquote class="text">
6058    <p>"OK" -
6059                                    </p>
6060    <blockquote class="text">
6061    <p>on success
6062    </p>
6063    </blockquote>
6064                                
6065    
6066    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6067                                    </p>
6068    <blockquote class="text">
6069    <p>if the global volume was set, but there are noteworthy
6070                                        issue(s) related, providing an appropriate warning code and
6071                                        warning message
6072    </p>
6073    </blockquote>
6074                                
6075    
6076    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6077                                    </p>
6078    <blockquote class="text">
6079    <p>in case it failed, providing an appropriate error code and error message
6080    </p>
6081    </blockquote>
6082                                
6083    
6084    </blockquote><p>
6085                        
6086    </p>
6087    <a name="MIDI Instrument Mapping"></a><br /><hr />
6088    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6089    <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;
6090    MIDI Instrument Mapping</h3>
6091    
6092    <p>The MIDI protocol provides a way to switch between instruments
6093                    by sending so called MIDI bank select and MIDI program change
6094                    messages which are essentially just numbers. The following commands
6095                    allow to actually map arbitrary MIDI bank select / program change
6096                    numbers with real instruments.
6097    </p>
6098    <p>The sampler allows to manage an arbitrary amount of MIDI
6099                    instrument maps which define which instrument to load on
6100                    which MIDI program change message.
6101    </p>
6102    <p>By default, that is when the sampler is launched, there is no
6103                    map, thus the sampler will simply ignore all program change
6104                    messages. The front-end has to explicitly create at least one
6105                    map, add entries to the map and tell the respective sampler
6106                    channel(s) which MIDI instrument map to use, so the sampler
6107                    knows how to react on a given program change message on the
6108                    respective sampler channel, that is by switching to the
6109                    respectively defined engine type and loading the respective
6110                    instrument. See command
6111                    <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>
6112                    for how to assign a MIDI instrument map to a sampler channel.
6113    </p>
6114    <p>Also note per MIDI specification a bank select message does not
6115                    cause to switch to another instrument. Instead when receiving a
6116                    bank select message the bank value will be stored and a subsequent
6117                    program change message (which may occur at any time) will finally
6118                    cause the sampler to switch to the respective instrument as
6119                    reflected by the current MIDI instrument map.
6120    </p>
6121    <a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr />
6122    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6123    <a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;
6124    Create a new MIDI instrument map</h3>
6125    
6126    <p>The front-end can add a new MIDI instrument map by sending
6127                        the following command:
6128    </p>
6129    <p>
6130                            </p>
6131    <blockquote class="text">
6132    <p>ADD MIDI_INSTRUMENT_MAP [&lt;name&gt;]
6133    </p>
6134    </blockquote><p>
6135                        
6136    </p>
6137    <p>Where &lt;name&gt; is an optional argument allowing to
6138                        assign a custom name to the new map. MIDI instrument Map
6139                        names do not have to be unique.
6140    </p>
6141    <p>Possible Answers:
6142    </p>
6143    <p>
6144                            </p>
6145    <blockquote class="text">
6146    <p>"OK[&lt;map&gt;]" -
6147                                    </p>
6148    <blockquote class="text">
6149    <p>in case a new MIDI instrument map could
6150                                        be added, where &lt;map&gt; reflects the
6151                                        unique ID of the newly created MIDI
6152                                        instrument map
6153    </p>
6154    </blockquote>
6155                                
6156    
6157    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6158                                    </p>
6159    <blockquote class="text">
6160    <p>when a new map could not be created, which
6161                                        might never occur in practice
6162    </p>
6163    </blockquote>
6164                                
6165    
6166    </blockquote><p>
6167                        
6168    </p>
6169    <p>Examples:
6170    </p>
6171    <p>
6172                            </p>
6173    <blockquote class="text">
6174    <p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
6175    </p>
6176    <p>S: "OK[0]"
6177    </p>
6178    </blockquote><p>
6179                        
6180    </p>
6181    <p>
6182                            </p>
6183    <blockquote class="text">
6184    <p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
6185    </p>
6186    <p>S: "OK[1]"
6187    </p>
6188    </blockquote><p>
6189                        
6190    </p>
6191    <p>
6192                            </p>
6193    <blockquote class="text">
6194    <p>C: "ADD MIDI_INSTRUMENT_MAP"
6195    </p>
6196    <p>S: "OK[5]"
6197    </p>
6198    </blockquote><p>
6199                        
6200    </p>
6201    <a name="REMOVE MIDI_INSTRUMENT_MAP"></a><br /><hr />
6202    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6203    <a name="rfc.section.6.7.2"></a><h3>6.7.2.&nbsp;
6204    Delete one particular or all MIDI instrument maps</h3>
6205    
6206    <p>The front-end can delete a particular MIDI instrument map
6207                        by sending the following command:
6208    </p>
6209    <p>
6210                            </p>
6211    <blockquote class="text">
6212    <p>REMOVE MIDI_INSTRUMENT_MAP &lt;map&gt;
6213    </p>
6214    </blockquote><p>
6215                        
6216    </p>
6217    <p>Where &lt;map&gt; reflects the unique ID of the map to delete
6218                        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>
6219                        command.
6220    </p>
6221    <p>The front-end can delete all MIDI instrument maps by
6222                        sending the following command:
6223    </p>
6224    <p>
6225                            </p>
6226    <blockquote class="text">
6227    <p>REMOVE MIDI_INSTRUMENT_MAP ALL
6228    </p>
6229    </blockquote><p>
6230                        
6231    </p>
6232    <p>Possible Answers:
6233    </p>
6234    <p>
6235                            </p>
6236    <blockquote class="text">
6237    <p>"OK" -
6238                                    </p>
6239    <blockquote class="text">
6240    <p>in case the map(s) could be deleted
6241    </p>
6242    </blockquote>
6243                                
6244    
6245    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6246                                    </p>
6247    <blockquote class="text">
6248    <p>when the given map does not exist
6249    </p>
6250    </blockquote>
6251                                
6252    
6253    </blockquote><p>
6254                        
6255    </p>
6256    <p>Examples:
6257    </p>
6258    <p>
6259                            </p>
6260    <blockquote class="text">
6261    <p>C: "REMOVE MIDI_INSTRUMENT_MAP 0"
6262    </p>
6263    <p>S: "OK"
6264    </p>
6265    </blockquote><p>
6266                        
6267    </p>
6268    <p>
6269                            </p>
6270    <blockquote class="text">
6271    <p>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
6272    </p>
6273    <p>S: "OK"
6274    </p>
6275    </blockquote><p>
6276                        
6277    </p>
6278    <a name="GET MIDI_INSTRUMENT_MAPS"></a><br /><hr />
6279    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6280    <a name="rfc.section.6.7.3"></a><h3>6.7.3.&nbsp;
6281    Get amount of existing MIDI instrument maps</h3>
6282    
6283    <p>The front-end can retrieve the current amount of MIDI
6284                        instrument maps by sending the following command:
6285    </p>
6286    <p>
6287                            </p>
6288    <blockquote class="text">
6289    <p>GET MIDI_INSTRUMENT_MAPS
6290    </p>
6291    </blockquote><p>
6292                        
6293    </p>
6294    <p>Possible Answers:
6295    </p>
6296    <p>
6297                            </p>
6298    <blockquote class="text">
6299    <p>The sampler will answer by returning the current
6300                                number of MIDI instrument maps.
6301    </p>
6302    </blockquote><p>
6303                        
6304    </p>
6305    <p>Example:
6306    </p>
6307    <p>
6308                            </p>
6309    <blockquote class="text">
6310    <p>C: "GET MIDI_INSTRUMENT_MAPS"
6311    </p>
6312    <p>S: "2"
6313    </p>
6314    </blockquote><p>
6315                        
6316    </p>
6317    <a name="LIST MIDI_INSTRUMENT_MAPS"></a><br /><hr />
6318    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6319    <a name="rfc.section.6.7.4"></a><h3>6.7.4.&nbsp;
6320    Getting all created MIDI instrument maps</h3>
6321    
6322    <p>The number of MIDI instrument maps can change on runtime. To get the
6323                        current list of MIDI instrument maps, the front-end can send the
6324                        following command:
6325    </p>
6326    <p>
6327                            </p>
6328    <blockquote class="text">
6329    <p>LIST MIDI_INSTRUMENT_MAPS
6330    </p>
6331    </blockquote><p>
6332                        
6333    </p>
6334    <p>Possible Answers:
6335    </p>
6336    <p>
6337                            </p>
6338    <blockquote class="text">
6339    <p>The sampler will answer by returning a comma separated list
6340                                with all MIDI instrument maps' numerical IDs.
6341    </p>
6342    </blockquote><p>
6343                        
6344    </p>
6345    <p>Example:
6346    </p>
6347    <p>
6348                            </p>
6349    <blockquote class="text">
6350    <p>C: "LIST MIDI_INSTRUMENT_MAPS"
6351    </p>
6352    <p>S: "0,1,5,12"
6353    </p>
6354    </blockquote><p>
6355                        
6356    </p>
6357    <a name="GET MIDI_INSTRUMENT_MAP INFO"></a><br /><hr />
6358    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6359    <a name="rfc.section.6.7.5"></a><h3>6.7.5.&nbsp;
6360    Getting MIDI instrument map information</h3>
6361    
6362    <p>The front-end can ask for the current settings of a MIDI
6363                        instrument map by sending the following command:
6364    </p>
6365    <p>
6366                            </p>
6367    <blockquote class="text">
6368    <p>GET MIDI_INSTRUMENT_MAP INFO &lt;map&gt;
6369    </p>
6370    </blockquote><p>
6371                        
6372    </p>
6373    <p>Where &lt;map&gt; is the numerical ID of the map the
6374                        front-end is interested in as returned by the
6375                        <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>
6376                        command.
6377    </p>
6378    <p>Possible Answers:
6379    </p>
6380    <p>
6381                            </p>
6382    <blockquote class="text">
6383    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6384                                Each answer line begins with the settings category name
6385                                followed by a colon and then a space character &lt;SP&gt; and finally
6386                                the info character string to that setting category. At the
6387                                moment the following categories are defined:
6388    </p>
6389    <p>
6390                                    </p>
6391    <blockquote class="text">
6392    <p>NAME -
6393                                            </p>
6394    <blockquote class="text">
6395    <p>custom name of the given map,
6396                                                which does not have to be unique
6397    </p>
6398    </blockquote>
6399                                        
6400    
6401    </blockquote>
6402                                
6403    
6404    </blockquote><p>
6405                        
6406    </p>
6407    <p>The mentioned fields above don't have to be in particular order.
6408    </p>
6409    <p>Example:
6410    </p>
6411    <p>
6412                            </p>
6413    <blockquote class="text">
6414    <p>C: "GET MIDI_INSTRUMENT_MAP INFO 0"
6415    </p>
6416    <p>S: "NAME: Standard Map"
6417    </p>
6418    <p>&nbsp;&nbsp;&nbsp;"."
6419    </p>
6420    </blockquote><p>
6421                        
6422    </p>
6423    <a name="SET MIDI_INSTRUMENT_MAP NAME"></a><br /><hr />
6424    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6425    <a name="rfc.section.6.7.6"></a><h3>6.7.6.&nbsp;
6426    Renaming a MIDI instrument map</h3>
6427    
6428    <p>The front-end can alter the custom name of a MIDI
6429                        instrument map by sending the following command:
6430    </p>
6431    <p>
6432                            </p>
6433    <blockquote class="text">
6434    <p>SET MIDI_INSTRUMENT_MAP NAME &lt;map&gt; &lt;name&gt;
6435    </p>
6436    </blockquote><p>
6437                        
6438    </p>
6439    <p>Where &lt;map&gt; is the numerical ID of the map and
6440                        &lt;name&gt; the new custom name of the map, which does not
6441                        have to be unique.
6442    </p>
6443    <p>Possible Answers:
6444    </p>
6445    <p>
6446                            </p>
6447    <blockquote class="text">
6448    <p>"OK" -
6449                                    </p>
6450    <blockquote class="text">
6451    <p>on success
6452    </p>
6453    </blockquote>
6454                                
6455    
6456    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6457                                    </p>
6458    <blockquote class="text">
6459    <p>in case the given map does not exist
6460    </p>
6461    </blockquote>
6462                                
6463    
6464    </blockquote><p>
6465                        
6466    </p>
6467    <p>Example:
6468    </p>
6469    <p>
6470                            </p>
6471    <blockquote class="text">
6472    <p>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
6473    </p>
6474    <p>S: "OK"
6475    </p>
6476    </blockquote><p>
6477                        
6478    </p>
6479    <a name="MAP MIDI_INSTRUMENT"></a><br /><hr />
6480    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6481    <a name="rfc.section.6.7.7"></a><h3>6.7.7.&nbsp;
6482    Create or replace a MIDI instrument map entry</h3>
6483    
6484    <p>The front-end can create a new or replace an existing entry
6485                        in a sampler's MIDI instrument map by sending the following
6486                        command:
6487    </p>
6488    <p>
6489                            </p>
6490    <blockquote class="text">
6491    <p>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
6492                                &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
6493                                &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
6494                                [&lt;instr_load_mode&gt;] [&lt;name&gt;]
6495    </p>
6496    </blockquote><p>
6497                        
6498    </p>
6499    <p>Where &lt;map&gt; is the numeric ID of the map to alter,
6500                        &lt;midi_bank&gt; is an integer value between
6501                        0..16383 reflecting the MIDI bank select index,
6502                        &lt;midi_prog&gt; an
6503                        integer value between 0..127 reflecting the MIDI program change
6504                        index, &lt;engine_name&gt; a sampler engine name as returned by
6505                        the <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a>
6506                        command (not encapsulated into apostrophes), &lt;filename&gt; the name
6507                        of the instrument's file to be deployed (encapsulated into apostrophes),
6508                        &lt;instrument_index&gt; the index (integer value) of the instrument
6509                        within the given file, &lt;volume_value&gt; reflects the master
6510                        volume of the instrument as optionally dotted number (where a
6511                        value &lt; 1.0 means attenuation and a value > 1.0 means
6512                        amplification). This parameter easily allows to adjust the
6513                        volume of all intruments within a custom instrument map
6514                        without having to adjust their instrument files. The
6515                        OPTIONAL &lt;instr_load_mode&gt; argument defines the life
6516                        time of the instrument, that is when the instrument should
6517                        be loaded, when freed and has exactly the following
6518                        possibilities:
6519    </p>
6520    <p>
6521                            </p>
6522    <blockquote class="text">
6523    <p>"ON_DEMAND" -
6524                                    </p>
6525    <blockquote class="text">
6526    <p>The instrument will be loaded when needed,
6527                                        that is when demanded by at least one sampler
6528                                        channel. It will immediately be freed from memory
6529                                        when not needed by any sampler channel anymore.
6530    </p>
6531    </blockquote>
6532                                
6533    
6534    <p>"ON_DEMAND_HOLD" -
6535                                    </p>
6536    <blockquote class="text">
6537    <p>The instrument will be loaded when needed,
6538                                        that is when demanded by at least one sampler
6539                                        channel. It will be kept in memory even when
6540                                        not needed by any sampler channel anymore.
6541                                        Instruments with this mode are only freed
6542                                        when the sampler is reset or all mapping
6543                                        entries with this mode (and respective
6544                                        instrument) are explicitly changed to
6545                                        "ON_DEMAND" and no sampler channel is using
6546                                        the instrument anymore.
6547    </p>
6548    </blockquote>
6549                                
6550    
6551    <p>"PERSISTENT" -
6552                                    </p>
6553    <blockquote class="text">
6554    <p>The instrument will immediately be loaded
6555                                        into memory when this mapping
6556                                        command is sent and the instrument is kept all
6557                                        the time. Instruments with this mode are
6558                                        only freed when the sampler is reset or all
6559                                        mapping entries with this mode (and
6560                                        respective instrument) are explicitly
6561                                        changed to "ON_DEMAND" and no sampler
6562                                        channel is using the instrument anymore.
6563    </p>
6564    </blockquote>
6565                                
6566    
6567    <p>not supplied -
6568                                    </p>
6569    <blockquote class="text">
6570    <p>In case there is no &lt;instr_load_mode&gt;
6571                                        argument given, it will be up to the
6572                                        InstrumentManager to decide which mode to use.
6573                                        Usually it will use "ON_DEMAND" if an entry
6574                                        for the given instrument does not exist in
6575                                        the InstrumentManager's list yet, otherwise
6576                                        if an entry already exists, it will simply
6577                                        stick with the mode currently reflected by
6578                                        the already existing entry, that is it will
6579                                        not change the mode.
6580    </p>
6581    </blockquote>
6582                                
6583    
6584    </blockquote><p>
6585                        
6586    </p>
6587    <p>
6588                        The &lt;instr_load_mode&gt; argument thus allows to define an
6589                        appropriate strategy (low memory consumption vs. fast
6590                        instrument switching) for each instrument individually. Note, the
6591                        following restrictions apply to this argument: "ON_DEMAND_HOLD" and
6592                        "PERSISTENT" have to be supported by the respective sampler engine
6593                        (which is technically the case when the engine provides an
6594                        InstrumentManager for its format). If this is not the case the
6595                        argument will automatically fall back to the default value
6596                        "ON_DEMAND". Also the load mode of one instrument may
6597                        automatically change the laod mode of other instrument(s), i.e.
6598                        because the instruments are part of the same file and the
6599                        engine does not allow a way to manage load modes for them
6600                        individually. Due to this, in case the frontend shows the
6601                        load modes of entries, the frontend should retrieve the actual
6602                        mode by i.e. sending
6603                        <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>
6604                        command(s). Finally the OPTIONAL &lt;name&gt; argument allows to
6605                        set a custom name (encapsulated into apostrophes) for the mapping
6606                        entry, useful for frontends for displaying an appropriate name for
6607                        mapped instruments (using
6608                        <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>).
6609                        
6610    </p>
6611    <p>
6612                        By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
6613                        completely established in the sampler. The OPTIONAL "NON_MODAL" argument
6614                        however causes the respective "MAP MIDI_INSTRUMENT" command to return
6615                        immediately, that is to let the sampler establish the mapping in the
6616                        background. So this argument might be especially useful for mappings with
6617                        a "PERSISTENT" type, because these have to load the respective instruments
6618                        immediately and might thus block for a very long time. It is recommended
6619                        however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
6620                        because it has the following drawbacks: as "NON_MODAL" instructions return
6621                        immediately, they may not necessarily return an error i.e. when the given
6622                        instrument file turns out to be corrupt, beside that subsequent commands
6623                        in a LSCP instruction sequence might fail, because mandatory mappings are
6624                        not yet completed.
6625                        
6626    </p>
6627    <p>Possible Answers:
6628    </p>
6629    <p>
6630                            </p>
6631    <blockquote class="text">
6632    <p>"OK" -
6633                                    </p>
6634    <blockquote class="text">
6635    <p>usually
6636    </p>
6637    </blockquote>
6638                                
6639    
6640    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6641                                    </p>
6642    <blockquote class="text">
6643    <p>when the given map or engine does not exist or a value
6644                                        is out of range
6645    </p>
6646    </blockquote>
6647                                
6648    
6649    </blockquote><p>
6650                        
6651    </p>
6652    <p>Examples:
6653    </p>
6654    <p>
6655                            </p>
6656    <blockquote class="text">
6657    <p>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"
6658    </p>
6659    <p>S: "OK"
6660    </p>
6661    </blockquote><p>
6662                        
6663    </p>
6664    <p>
6665                            </p>
6666    <blockquote class="text">
6667    <p>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"
6668    </p>
6669    <p>S: "OK"
6670    </p>
6671    </blockquote><p>
6672                        
6673    </p>
6674    <p>
6675                            </p>
6676    <blockquote class="text">
6677    <p>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"
6678    </p>
6679    <p>S: "OK"
6680    </p>
6681    <p>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"
6682    </p>
6683    <p>S: "OK"
6684    </p>
6685    </blockquote><p>
6686                        
6687    </p>
6688    <p>
6689                            </p>
6690    <blockquote class="text">
6691    <p>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
6692    </p>
6693    <p>S: "OK"
6694    </p>
6695    </blockquote><p>
6696                        
6697    </p>
6698    <a name="GET MIDI_INSTRUMENTS"></a><br /><hr />
6699    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6700    <a name="rfc.section.6.7.8"></a><h3>6.7.8.&nbsp;
6701    Getting ammount of MIDI instrument map entries</h3>
6702    
6703    <p>The front-end can query the amount of currently existing
6704                        entries in a MIDI instrument map by sending the following
6705                        command:
6706    </p>
6707    <p>
6708                            </p>
6709    <blockquote class="text">
6710    <p>GET MIDI_INSTRUMENTS &lt;map&gt;
6711    </p>
6712    </blockquote><p>
6713                        
6714    </p>
6715    <p>The front-end can query the amount of currently existing
6716                        entries in all MIDI instrument maps by sending the following
6717                        command:
6718    </p>
6719    <p>
6720                            </p>
6721    <blockquote class="text">
6722    <p>GET MIDI_INSTRUMENTS ALL
6723    </p>
6724    </blockquote><p>
6725                        
6726    </p>
6727    <p>Possible Answers:
6728    </p>
6729    <p>
6730                            </p>
6731    <blockquote class="text">
6732    <p>The sampler will answer by sending the current number of
6733                                entries in the MIDI instrument map(s).
6734    </p>
6735    </blockquote><p>
6736                        
6737    </p>
6738    <p>Example:
6739    </p>
6740    <p>
6741                            </p>
6742    <blockquote class="text">
6743    <p>C: "GET MIDI_INSTRUMENTS 0"
6744    </p>
6745    <p>S: "234"
6746    </p>
6747    </blockquote><p>
6748                        
6749    </p>
6750    <p>
6751                            </p>
6752    <blockquote class="text">
6753    <p>C: "GET MIDI_INSTRUMENTS ALL"
6754    </p>
6755    <p>S: "954"
6756    </p>
6757    </blockquote><p>
6758                        
6759    </p>
6760    <a name="LIST MIDI_INSTRUMENTS"></a><br /><hr />
6761    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6762    <a name="rfc.section.6.7.9"></a><h3>6.7.9.&nbsp;
6763    Getting indeces of all entries of a MIDI instrument map</h3>
6764    
6765    <p>The front-end can query a list of all currently existing
6766                        entries in a certain MIDI instrument map by sending the following
6767                        command:
6768    </p>
6769    <p>
6770                            </p>
6771    <blockquote class="text">
6772    <p>LIST MIDI_INSTRUMENTS &lt;map&gt;
6773    </p>
6774    </blockquote><p>
6775                        
6776    </p>
6777    <p>Where &lt;map&gt; is the numeric ID of the MIDI instrument map.
6778    </p>
6779    <p>The front-end can query a list of all currently existing
6780                        entries of all MIDI instrument maps by sending the following
6781                        command:
6782    </p>
6783    <p>
6784                            </p>
6785    <blockquote class="text">
6786    <p>LIST MIDI_INSTRUMENTS ALL
6787    </p>
6788    </blockquote><p>
6789                        
6790    </p>
6791    <p>Possible Answers:
6792    </p>
6793    <p>
6794                            </p>
6795    <blockquote class="text">
6796    <p>The sampler will answer by sending a comma separated
6797                                list of map ID - MIDI bank - MIDI program triples, where
6798                                each triple is encapsulated into curly braces. The
6799                                list is returned in one single line. Each triple
6800                                just reflects the key of the respective map entry,
6801                                thus subsequent
6802                                <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>
6803                                command(s) are necessary to retrieve detailed informations
6804                                about each entry.
6805    </p>
6806    </blockquote><p>
6807                        
6808    </p>
6809    <p>Example:
6810    </p>
6811    <p>
6812                            </p>
6813    <blockquote class="text">
6814    <p>C: "LIST MIDI_INSTRUMENTS 0"
6815    </p>
6816    <p>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
6817    </p>
6818    </blockquote><p>
6819                        
6820    </p>
6821    <a name="UNMAP MIDI_INSTRUMENT"></a><br /><hr />
6822    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6823    <a name="rfc.section.6.7.10"></a><h3>6.7.10.&nbsp;
6824    Remove an entry from the MIDI instrument map</h3>
6825    
6826    <p>The front-end can delete an entry from a MIDI instrument
6827                        map by sending the following command:
6828    </p>
6829    <p>
6830                            </p>
6831    <blockquote class="text">
6832    <p>UNMAP MIDI_INSTRUMENT &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;
6833    </p>
6834    </blockquote><p>
6835                        
6836    </p>
6837    <p>
6838                        Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
6839                        &lt;midi_bank&gt; is an integer value between 0..16383
6840                        reflecting the MIDI bank value and
6841                        &lt;midi_prog&gt; an integer value between
6842                        0..127 reflecting the MIDI program value of the map's entrie's key
6843                        index triple.
6844                        
6845    </p>
6846    <p>Possible Answers:
6847    </p>
6848    <p>
6849                            </p>
6850    <blockquote class="text">
6851    <p>"OK" -
6852                                    </p>
6853    <blockquote class="text">
6854    <p>usually
6855    </p>
6856    </blockquote>
6857                                
6858    
6859    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6860                                    </p>
6861    <blockquote class="text">
6862    <p>when index out of bounds
6863    </p>
6864    </blockquote>
6865                                
6866    
6867    </blockquote><p>
6868                        
6869    </p>
6870    <p>Example:
6871    </p>
6872    <p>
6873                            </p>
6874    <blockquote class="text">
6875    <p>C: "UNMAP MIDI_INSTRUMENT 0 2 127"
6876    </p>
6877    <p>S: "OK"
6878    </p>
6879    </blockquote><p>
6880                        
6881    </p>
6882    <a name="GET MIDI_INSTRUMENT INFO"></a><br /><hr />
6883    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6884    <a name="rfc.section.6.7.11"></a><h3>6.7.11.&nbsp;
6885    Get current settings of MIDI instrument map entry</h3>
6886    
6887    <p>The front-end can retrieve the current settings of a certain
6888                        instrument map entry by sending the following command:
6889    </p>
6890    <p>
6891                            </p>
6892    <blockquote class="text">
6893    <p>GET MIDI_INSTRUMENT INFO &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;
6894    </p>
6895    </blockquote><p>
6896                        
6897    </p>
6898    <p>
6899                        Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
6900                        &lt;midi_bank&gt; is an integer value between 0..16383
6901                        reflecting the MIDI bank value, &lt;midi_bank&gt;
6902                        and &lt;midi_prog&gt; an integer value between
6903                        0..127 reflecting the MIDI program value of the map's entrie's key
6904                        index triple.
6905                        
6906    </p>
6907    <p>Possible Answers:
6908    </p>
6909    <p>
6910                            </p>
6911    <blockquote class="text">
6912    <p>LinuxSampler will answer by sending a &lt;CRLF&gt;
6913                                separated list. Each answer line begins with the
6914                                information category name followed by a colon and then
6915                                a space character &lt;SP&gt; and finally the info
6916                                character string to that info category. At the moment
6917                                the following categories are defined:
6918    </p>
6919    <p>"NAME" -
6920                                    </p>
6921    <blockquote class="text">
6922    <p>Name for this MIDI instrument map entry (if defined).
6923                                        This name shall be used by frontends for displaying a
6924                                        name for this mapped instrument. It can be set and
6925                                        changed with the
6926                                        <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>
6927                                        command and does not have to be unique.
6928    </p>
6929    </blockquote>
6930                                
6931    
6932    <p>"ENGINE_NAME" -
6933                                    </p>
6934    <blockquote class="text">
6935    <p>Name of the engine to be deployed for this
6936                                        instrument.
6937    </p>
6938    </blockquote>
6939                                
6940    
6941    <p>"INSTRUMENT_FILE" -
6942                                    </p>
6943    <blockquote class="text">
6944    <p>File name of the instrument.
6945    </p>
6946    </blockquote>
6947                                
6948    
6949    <p>"INSTRUMENT_NR" -
6950                                    </p>
6951    <blockquote class="text">
6952    <p>Index of the instrument within the file.
6953    </p>
6954    </blockquote>
6955                                
6956    
6957    <p>"INSTRUMENT_NAME" -
6958                                    </p>
6959    <blockquote class="text">
6960    <p>Name of the loaded instrument as reflected by its file.
6961                                        In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
6962                                        cannot be changed.
6963    </p>
6964    </blockquote>
6965                                
6966    
6967    <p>"LOAD_MODE" -
6968                                    </p>
6969    <blockquote class="text">
6970    <p>Life time of instrument
6971                                        (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).
6972    </p>
6973    </blockquote>
6974                                
6975    
6976    <p>"VOLUME" -
6977                                    </p>
6978    <blockquote class="text">
6979    <p>master volume of the instrument as optionally
6980                                        dotted number (where a value &lt; 1.0 means attenuation
6981                                        and a value > 1.0 means amplification)
6982    </p>
6983    </blockquote>
6984                                
6985    
6986    <p>The mentioned fields above don't have to be in particular order.
6987    </p>
6988    </blockquote><p>
6989                        
6990    </p>
6991    <p>Example:
6992    </p>
6993    <p>
6994                            </p>
6995    <blockquote class="text">
6996    <p>C: "GET MIDI_INSTRUMENT INFO 1 45 120"
6997    </p>
6998    <p>S: "NAME: Drums for Foo Song"
6999    </p>
7000    <p>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"
7001    </p>
7002    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
7003    </p>
7004    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"
7005    </p>
7006    <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Joe's Drumkit"
7007    </p>
7008    <p>&nbsp;&nbsp;&nbsp;"LOAD_MODE: PERSISTENT"
7009    </p>
7010    <p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
7011    </p>
7012    <p>&nbsp;&nbsp;&nbsp;"."
7013    </p>
7014    </blockquote><p>
7015                        
7016    </p>
7017    <a name="CLEAR MIDI_INSTRUMENTS"></a><br /><hr />
7018    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7019    <a name="rfc.section.6.7.12"></a><h3>6.7.12.&nbsp;
7020    Clear MIDI instrument map</h3>
7021    
7022    <p>The front-end can clear a whole MIDI instrument map, that
7023                        is delete all its entries by sending the following command:
7024    </p>
7025    <p>
7026                            </p>
7027    <blockquote class="text">
7028    <p>CLEAR MIDI_INSTRUMENTS &lt;map&gt;
7029    </p>
7030    </blockquote><p>
7031                        
7032    </p>
7033    <p>Where &lt;map&gt; is the numeric ID of the map to clear.
7034    </p>
7035    <p>The front-end can clear all MIDI instrument maps, that
7036                        is delete all entries of all maps by sending the following
7037                        command:
7038    </p>
7039    <p>
7040                            </p>
7041    <blockquote class="text">
7042    <p>CLEAR MIDI_INSTRUMENTS ALL
7043    </p>
7044    </blockquote><p>
7045                        
7046    </p>
7047    <p>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the
7048                        maps, only their entries, thus the map's settings like
7049                        custom name will be preservevd.
7050    </p>
7051    <p>Possible Answers:
7052    </p>
7053    <p>
7054                            </p>
7055    <blockquote class="text">
7056    <p>"OK" -
7057                                    </p>
7058    <blockquote class="text">
7059    <p>always
7060    </p>
7061    </blockquote>
7062                                
7063    
7064    </blockquote><p>
7065                        
7066    </p>
7067    <p>Examples:
7068    </p>
7069    <p>
7070                           </p>
7071    <blockquote class="text">
7072    <p>C: "CLEAR MIDI_INSTRUMENTS 0"
7073    </p>
7074    <p>S: "OK"
7075    </p>
7076    </blockquote><p>
7077                        
7078    </p>
7079    <p>
7080                           </p>
7081    <blockquote class="text">
7082    <p>C: "CLEAR MIDI_INSTRUMENTS ALL"
7083    </p>
7084    <p>S: "OK"
7085    </p>
7086    </blockquote><p>
7087                        
7088    </p>
7089  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
7090  <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>
7091  <a name="rfc.section.7"></a><h3>7.&nbsp;Command Syntax</h3>  <a name="rfc.section.7"></a><h3>7.&nbsp;
7092    Command Syntax</h3>
7093    
7094  <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>
7095              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>)
7096              where applicable.              where applicable.
7097                            
7098  </p>  </p>
# Line 5201  Intellectual Property and Copyright Stat Line 7150  Intellectual Property and Copyright Stat
7150  <p>command =  <p>command =
7151          </p>          </p>
7152  <blockquote class="text">  <blockquote class="text">
7153  <p>ADD SP CHANNEL  <p>ADD SP add_instruction
7154                    
7155    </p>
7156    <p>/ MAP SP map_instruction
7157                    
7158    </p>
7159    <p>/ UNMAP SP unmap_instruction
7160                                    
7161  </p>  </p>
7162  <p>/ GET SP get_instruction  <p>/ GET SP get_instruction
# Line 5219  Intellectual Property and Copyright Stat Line 7174  Intellectual Property and Copyright Stat
7174  <p>/ LOAD SP load_instruction  <p>/ LOAD SP load_instruction
7175                                    
7176  </p>  </p>
7177  <p>/ REMOVE SP CHANNEL SP sampler_channel  <p>/ REMOVE SP remove_instruction
7178                                    
7179  </p>  </p>
7180  <p>/ SET SP set_instruction  <p>/ SET SP set_instruction
# Line 5234  Intellectual Property and Copyright Stat Line 7189  Intellectual Property and Copyright Stat
7189  <p>/ SELECT SP text  <p>/ SELECT SP text
7190                                    
7191  </p>  </p>
7192  <p>/ RESET SP CHANNEL SP sampler_channel  <p>/ RESET SP reset_instruction
7193                    
7194    </p>
7195    <p>/ CLEAR SP clear_instruction
7196                                    
7197  </p>  </p>
7198  <p>/ RESET  <p>/ RESET
# Line 5246  Intellectual Property and Copyright Stat Line 7204  Intellectual Property and Copyright Stat
7204  </blockquote><p>  </blockquote><p>
7205    
7206  </p>  </p>
7207    <p>add_instruction =
7208            </p>
7209    <blockquote class="text">
7210    <p>CHANNEL
7211                    
7212    </p>
7213    <p>/ MIDI_INSTRUMENT_MAP
7214                    
7215    </p>
7216    <p>/ MIDI_INSTRUMENT_MAP SP map_name
7217                    
7218    </p>
7219    </blockquote><p>
7220    
7221    </p>
7222  <p>subscribe_event =  <p>subscribe_event =
7223          </p>          </p>
7224  <blockquote class="text">  <blockquote class="text">
7225  <p>CHANNEL_COUNT  <p>AUDIO_OUTPUT_DEVICE_COUNT
7226                    
7227    </p>
7228    <p>/ AUDIO_OUTPUT_DEVICE_INFO
7229                    
7230    </p>
7231    <p>/ MIDI_INPUT_DEVICE_COUNT
7232                    
7233    </p>
7234    <p>/ MIDI_INPUT_DEVICE_INFO
7235                    
7236    </p>
7237    <p>/ CHANNEL_COUNT
7238                                    
7239  </p>  </p>
7240  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
# Line 5264  Intellectual Property and Copyright Stat Line 7249  Intellectual Property and Copyright Stat
7249  <p>/ CHANNEL_INFO  <p>/ CHANNEL_INFO
7250                                    
7251  </p>  </p>
7252    <p>/ MIDI_INSTRUMENT_MAP_COUNT
7253                    
7254    </p>
7255    <p>/ MIDI_INSTRUMENT_MAP_INFO
7256                    
7257    </p>
7258    <p>/ MIDI_INSTRUMENT_COUNT
7259                    
7260    </p>
7261    <p>/ MIDI_INSTRUMENT_INFO
7262                    
7263    </p>
7264  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
7265                                    
7266  </p>  </p>
# Line 5276  Intellectual Property and Copyright Stat Line 7273  Intellectual Property and Copyright Stat
7273  <p>unsubscribe_event =  <p>unsubscribe_event =
7274          </p>          </p>
7275  <blockquote class="text">  <blockquote class="text">
7276  <p>CHANNEL_COUNT  <p>AUDIO_OUTPUT_DEVICE_COUNT
7277                    
7278    </p>
7279    <p>/ AUDIO_OUTPUT_DEVICE_INFO
7280                    
7281    </p>
7282    <p>/ MIDI_INPUT_DEVICE_COUNT
7283                    
7284    </p>
7285    <p>/ MIDI_INPUT_DEVICE_INFO
7286                    
7287    </p>
7288    <p>/ CHANNEL_COUNT
7289                                    
7290  </p>  </p>
7291  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
# Line 5291  Intellectual Property and Copyright Stat Line 7300  Intellectual Property and Copyright Stat
7300  <p>/ CHANNEL_INFO  <p>/ CHANNEL_INFO
7301                                    
7302  </p>  </p>
7303    <p>/ MIDI_INSTRUMENT_MAP_COUNT
7304                    
7305    </p>
7306    <p>/ MIDI_INSTRUMENT_MAP_INFO
7307                    
7308    </p>
7309    <p>/ MIDI_INSTRUMENT_COUNT
7310                    
7311    </p>
7312    <p>/ MIDI_INSTRUMENT_INFO
7313                    
7314    </p>
7315  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
7316                                    
7317  </p>  </p>
# Line 5300  Intellectual Property and Copyright Stat Line 7321  Intellectual Property and Copyright Stat
7321  </blockquote><p>  </blockquote><p>
7322    
7323  </p>  </p>
7324    <p>map_instruction =
7325            </p>
7326    <blockquote class="text">
7327    <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
7328                    
7329    </p>
7330    <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
7331                    
7332    </p>
7333    <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
7334                    
7335    </p>
7336    <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
7337                    
7338    </p>
7339    </blockquote><p>
7340    
7341    </p>
7342    <p>unmap_instruction =
7343            </p>
7344    <blockquote class="text">
7345    <p>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
7346                    
7347    </p>
7348    </blockquote><p>
7349    
7350    </p>
7351    <p>remove_instruction =
7352            </p>
7353    <blockquote class="text">
7354    <p>CHANNEL SP sampler_channel
7355                    
7356    </p>
7357    <p>/ MIDI_INSTRUMENT_MAP SP midi_map
7358                    
7359    </p>
7360    <p>/ MIDI_INSTRUMENT_MAP SP ALL
7361                    
7362    </p>
7363    </blockquote><p>
7364    
7365    </p>
7366  <p>get_instruction =  <p>get_instruction =
7367          </p>          </p>
7368  <blockquote class="text">  <blockquote class="text">
# Line 5381  Intellectual Property and Copyright Stat Line 7444  Intellectual Property and Copyright Stat
7444  <p>/ TOTAL_VOICE_COUNT_MAX  <p>/ TOTAL_VOICE_COUNT_MAX
7445                                    
7446  </p>  </p>
7447    <p>/ MIDI_INSTRUMENTS SP midi_map
7448                    
7449    </p>
7450    <p>/ MIDI_INSTRUMENTS SP ALL
7451                    
7452    </p>
7453    <p>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
7454                    
7455    </p>
7456    <p>/ MIDI_INSTRUMENT_MAPS
7457                    
7458    </p>
7459    <p>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
7460                    
7461    </p>
7462    <p>/ FX_SENDS SP sampler_channel
7463                    
7464    </p>
7465    <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
7466                    
7467    </p>
7468    <p>/ VOLUME
7469                    
7470    </p>
7471  </blockquote><p>  </blockquote><p>
7472    
7473  </p>  </p>
# Line 5402  Intellectual Property and Copyright Stat Line 7489  Intellectual Property and Copyright Stat
7489  <p>/ CHANNEL SP set_chan_instruction  <p>/ CHANNEL SP set_chan_instruction
7490                                    
7491  </p>  </p>
7492    <p>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
7493                    
7494    </p>
7495    <p>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
7496                    
7497    </p>
7498    <p>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
7499                    
7500    </p>
7501    <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
7502                    
7503    </p>
7504  <p>/ ECHO SP boolean  <p>/ ECHO SP boolean
7505                                    
7506  </p>  </p>
7507    <p>/ VOLUME SP volume_value
7508                    
7509    </p>
7510  </blockquote><p>  </blockquote><p>
7511    
7512  </p>  </p>
# Line 5423  Intellectual Property and Copyright Stat Line 7525  Intellectual Property and Copyright Stat
7525  <p>/ MIDI_INPUT_DEVICE SP string  <p>/ MIDI_INPUT_DEVICE SP string
7526                                    
7527  </p>  </p>
7528    <p>/ FX_SEND SP sampler_channel SP midi_ctrl
7529                    
7530    </p>
7531    <p>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
7532                    
7533    </p>
7534    </blockquote><p>
7535    
7536    </p>
7537    <p>reset_instruction =
7538            </p>
7539    <blockquote class="text">
7540    <p>CHANNEL SP sampler_channel
7541                    
7542    </p>
7543    </blockquote><p>
7544    
7545    </p>
7546    <p>clear_instruction =
7547            </p>
7548    <blockquote class="text">
7549    <p>MIDI_INSTRUMENTS SP midi_map
7550                    
7551    </p>
7552    <p>/ MIDI_INSTRUMENTS SP ALL
7553                    
7554    </p>
7555  </blockquote><p>  </blockquote><p>
7556    
7557  </p>  </p>
# Line 5435  Intellectual Property and Copyright Stat Line 7564  Intellectual Property and Copyright Stat
7564  <p>/ MIDI_INPUT_DEVICE SP number  <p>/ MIDI_INPUT_DEVICE SP number
7565                                    
7566  </p>  </p>
7567    <p>/ FX_SEND SP sampler_channel SP fx_send_id
7568                    
7569    </p>
7570  </blockquote><p>  </blockquote><p>
7571    
7572  </p>  </p>
# Line 5486  Intellectual Property and Copyright Stat Line 7618  Intellectual Property and Copyright Stat
7618  <p>/ SOLO SP sampler_channel SP boolean  <p>/ SOLO SP sampler_channel SP boolean
7619                                    
7620  </p>  </p>
7621    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
7622                    
7623    </p>
7624    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
7625                    
7626    </p>
7627    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
7628                    
7629    </p>
7630    </blockquote><p>
7631    
7632    </p>
7633    <p>modal_arg =
7634            </p>
7635    <blockquote class="text">
7636    <p>/* epsilon (empty argument) */
7637                    
7638    </p>
7639    <p>/ NON_MODAL SP
7640                    
7641    </p>
7642  </blockquote><p>  </blockquote><p>
7643    
7644  </p>  </p>
# Line 5534  Intellectual Property and Copyright Stat Line 7687  Intellectual Property and Copyright Stat
7687  <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS  <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
7688                                    
7689  </p>  </p>
7690    <p>/ MIDI_INSTRUMENTS SP midi_map
7691                    
7692    </p>
7693    <p>/ MIDI_INSTRUMENTS SP ALL
7694                    
7695    </p>
7696    <p>/ MIDI_INSTRUMENT_MAPS
7697                    
7698    </p>
7699    <p>/ FX_SENDS SP sampler_channel
7700                    
7701    </p>
7702  </blockquote><p>  </blockquote><p>
7703    
7704  </p>  </p>
# Line 5558  Intellectual Property and Copyright Stat Line 7723  Intellectual Property and Copyright Stat
7723  </blockquote><p>  </blockquote><p>
7724    
7725  </p>  </p>
7726    <p>instr_load_mode =
7727            </p>
7728    <blockquote class="text">
7729    <p>ON_DEMAND
7730                    
7731    </p>
7732    <p>/ ON_DEMAND_HOLD
7733                    
7734    </p>
7735    <p>/ PERSISTENT
7736                    
7737    </p>
7738    </blockquote><p>
7739    
7740    </p>
7741  <p>device_index =  <p>device_index =
7742          </p>          </p>
7743  <blockquote class="text">  <blockquote class="text">
# Line 5615  Intellectual Property and Copyright Stat Line 7795  Intellectual Property and Copyright Stat
7795  </blockquote><p>  </blockquote><p>
7796    
7797  </p>  </p>
7798    <p>midi_map =
7799            </p>
7800    <blockquote class="text">
7801    <p>number
7802                    
7803    </p>
7804    </blockquote><p>
7805    
7806    </p>
7807    <p>midi_bank =
7808            </p>
7809    <blockquote class="text">
7810    <p>number
7811                    
7812    </p>
7813    </blockquote><p>
7814    
7815    </p>
7816    <p>midi_prog =
7817            </p>
7818    <blockquote class="text">
7819    <p>number
7820                    
7821    </p>
7822    </blockquote><p>
7823    
7824    </p>
7825    <p>midi_ctrl =
7826            </p>
7827    <blockquote class="text">
7828    <p>number
7829                    
7830    </p>
7831    </blockquote><p>
7832    
7833    </p>
7834  <p>volume_value =  <p>volume_value =
7835          </p>          </p>
7836  <blockquote class="text">  <blockquote class="text">
# Line 5645  Intellectual Property and Copyright Stat Line 7861  Intellectual Property and Copyright Stat
7861  </blockquote><p>  </blockquote><p>
7862    
7863  </p>  </p>
7864    <p>fx_send_id =
7865            </p>
7866    <blockquote class="text">
7867    <p>number
7868                    
7869    </p>
7870    </blockquote><p>
7871    
7872    </p>
7873  <p>engine_name =  <p>engine_name =
7874          </p>          </p>
7875  <blockquote class="text">  <blockquote class="text">
# Line 5663  Intellectual Property and Copyright Stat Line 7888  Intellectual Property and Copyright Stat
7888  </blockquote><p>  </blockquote><p>
7889    
7890  </p>  </p>
7891    <p>map_name =
7892            </p>
7893    <blockquote class="text">
7894    <p>stringval
7895                    
7896    </p>
7897    </blockquote><p>
7898    
7899    </p>
7900    <p>entry_name =
7901            </p>
7902    <blockquote class="text">
7903    <p>stringval
7904                    
7905    </p>
7906    </blockquote><p>
7907    
7908    </p>
7909    <p>fx_send_name =
7910            </p>
7911    <blockquote class="text">
7912    <p>stringval
7913                    
7914    </p>
7915    </blockquote><p>
7916    
7917    </p>
7918  <p>param_val_list =  <p>param_val_list =
7919          </p>          </p>
7920  <blockquote class="text">  <blockquote class="text">
# Line 5694  Intellectual Property and Copyright Stat Line 7946  Intellectual Property and Copyright Stat
7946    
7947  </p>  </p>
7948  <a name="events"></a><br /><hr />  <a name="events"></a><br /><hr />
7949  <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>
7950  <a name="rfc.section.8"></a><h3>8.&nbsp;Events</h3>  <a name="rfc.section.8"></a><h3>8.&nbsp;
7951    Events</h3>
7952    
7953  <p>This chapter will describe all currently defined events supported by LinuxSampler.  <p>This chapter will describe all currently defined events supported by LinuxSampler.
7954  </p>  </p>
7955  <a name="SUBSCRIBE CHANNEL"></a><br /><hr />  <a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"></a><br /><hr />
7956  <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>
7957  <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;
7958    Number of audio output devices changed</h3>
7959    
7960    <p>Client may want to be notified when the total number of audio output devices on the
7961                    back-end changes by issuing the following command:
7962    </p>
7963    <p>
7964                        </p>
7965    <blockquote class="text">
7966    <p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
7967    </p>
7968    </blockquote><p>
7969                    
7970    </p>
7971    <p>Server will start sending the following notification messages:
7972    </p>
7973    <p>
7974                        </p>
7975    <blockquote class="text">
7976    <p>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"
7977    </p>
7978    </blockquote><p>
7979                    
7980    </p>
7981    <p>where &lt;devices&gt; will be replaced by the new number
7982                    of audio output devices.
7983    </p>
7984    <a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"></a><br /><hr />
7985    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
7986    <a name="rfc.section.8.2"></a><h3>8.2.&nbsp;
7987    Audio output device's settings changed</h3>
7988    
7989    <p>Client may want to be notified when changes were made to audio output devices on the
7990                    back-end by issuing the following command:
7991    </p>
7992    <p>
7993                        </p>
7994    <blockquote class="text">
7995    <p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
7996    </p>
7997    </blockquote><p>
7998                    
7999    </p>
8000    <p>Server will start sending the following notification messages:
8001    </p>
8002    <p>
8003                        </p>
8004    <blockquote class="text">
8005    <p>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"
8006    </p>
8007    </blockquote><p>
8008                    
8009    </p>
8010    <p>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
8011                    which settings has been changed. The front-end will have to send
8012                    the respective command to actually get the audio output device info. Because these messages
8013                    will be triggered by LSCP commands issued by other clients rather than real
8014                    time events happening on the server, it is believed that an empty notification
8015                    message is sufficient here.
8016    </p>
8017    <a name="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"></a><br /><hr />
8018    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8019    <a name="rfc.section.8.3"></a><h3>8.3.&nbsp;
8020    Number of MIDI input devices changed</h3>
8021    
8022    <p>Client may want to be notified when the total number of MIDI input devices on the
8023                    back-end changes by issuing the following command:
8024    </p>
8025    <p>
8026                        </p>
8027    <blockquote class="text">
8028    <p>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
8029    </p>
8030    </blockquote><p>
8031                    
8032    </p>
8033    <p>Server will start sending the following notification messages:
8034    </p>
8035    <p>
8036                        </p>
8037    <blockquote class="text">
8038    <p>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"
8039    </p>
8040    </blockquote><p>
8041                    
8042    </p>
8043    <p>where &lt;devices&gt; will be replaced by the new number
8044                    of MIDI input devices.
8045    </p>
8046    <a name="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"></a><br /><hr />
8047    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8048    <a name="rfc.section.8.4"></a><h3>8.4.&nbsp;
8049    MIDI input device's settings changed</h3>
8050    
8051    <p>Client may want to be notified when changes were made to MIDI input devices on the
8052                    back-end by issuing the following command:
8053    </p>
8054    <p>
8055                        </p>
8056    <blockquote class="text">
8057    <p>SUBSCRIBE MIDI_INPUT_DEVICE_INFO
8058    </p>
8059    </blockquote><p>
8060                    
8061    </p>
8062    <p>Server will start sending the following notification messages:
8063    </p>
8064    <p>
8065                        </p>
8066    <blockquote class="text">
8067    <p>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"
8068    </p>
8069    </blockquote><p>
8070                    
8071    </p>
8072    <p>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
8073                    which settings has been changed. The front-end will have to send
8074                    the respective command to actually get the MIDI input device info. Because these messages
8075                    will be triggered by LSCP commands issued by other clients rather than real
8076                    time events happening on the server, it is believed that an empty notification
8077                    message is sufficient here.
8078    </p>
8079    <a name="SUBSCRIBE CHANNEL_COUNT"></a><br /><hr />
8080    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8081    <a name="rfc.section.8.5"></a><h3>8.5.&nbsp;
8082    Number of sampler channels changed</h3>
8083    
8084  <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
8085                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 5728  Intellectual Property and Copyright Stat Line 8106  Intellectual Property and Copyright Stat
8106                  of sampler channels.                  of sampler channels.
8107  </p>  </p>
8108  <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />
8109  <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>
8110  <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;
8111    Number of active voices changed</h3>
8112    
8113  <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
8114                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 5757  Intellectual Property and Copyright Stat Line 8136  Intellectual Property and Copyright Stat
8136                  active voices on that channel.                  active voices on that channel.
8137  </p>  </p>
8138  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />
8139  <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>
8140  <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;
8141    Number of active disk streams changed</h3>
8142    
8143  <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
8144                  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 8166  Intellectual Property and Copyright Stat
8166                  active disk streams on that channel.                  active disk streams on that channel.
8167  </p>  </p>
8168  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />
8169  <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>
8170  <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;
8171    Disk stream buffer fill state changed</h3>
8172    
8173  <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
8174                  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 8193  Intellectual Property and Copyright Stat
8193  </p>  </p>
8194  <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
8195                  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
8196                  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>
8197                  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.
8198  </p>  </p>
8199  <a name="SUBSCRIBE INFO"></a><br /><hr />  <a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr />
8200  <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>
8201  <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;
8202    Channel information changed</h3>
8203    
8204  <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
8205                  back-end by issuing the following command:                  back-end by issuing the following command:
# Line 5848  Intellectual Property and Copyright Stat Line 8230  Intellectual Property and Copyright Stat
8230                  message is sufficient here.                  message is sufficient here.
8231  </p>  </p>
8232  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />
8233  <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>
8234  <a name="rfc.section.8.6"></a><h3>8.6.&nbsp;Total number of active voices changed</h3>  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
8235    Total number of active voices changed</h3>
8236    
8237  <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
8238                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 5875  Intellectual Property and Copyright Stat Line 8258  Intellectual Property and Copyright Stat
8258  <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
8259                  all currently active voices.                  all currently active voices.
8260  </p>  </p>
8261    <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr />
8262    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8263    <a name="rfc.section.8.11"></a><h3>8.11.&nbsp;
8264    Number of MIDI instrument maps changed</h3>
8265    
8266    <p>Client may want to be notified when the number of MIDI instrument maps on the
8267                    back-end changes by issuing the following command:
8268    </p>
8269    <p>
8270                        </p>
8271    <blockquote class="text">
8272    <p>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
8273    </p>
8274    </blockquote><p>
8275                    
8276    </p>
8277    <p>Server will start sending the following notification messages:
8278    </p>
8279    <p>
8280                        </p>
8281    <blockquote class="text">
8282    <p>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"
8283    </p>
8284    </blockquote><p>
8285                    
8286    </p>
8287    <p>where &lt;maps&gt; will be replaced by the new number
8288                    of MIDI instrument maps.
8289    </p>
8290    <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr />
8291    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8292    <a name="rfc.section.8.12"></a><h3>8.12.&nbsp;
8293    MIDI instrument map information changed</h3>
8294    
8295    <p>Client may want to be notified when changes were made to MIDI instrument maps on the
8296                    back-end by issuing the following command:
8297    </p>
8298    <p>
8299                        </p>
8300    <blockquote class="text">
8301    <p>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
8302    </p>
8303    </blockquote><p>
8304                    
8305    </p>
8306    <p>Server will start sending the following notification messages:
8307    </p>
8308    <p>
8309                        </p>
8310    <blockquote class="text">
8311    <p>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"
8312    </p>
8313    </blockquote><p>
8314                    
8315    </p>
8316    <p>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
8317                    for which information changes occurred. The front-end will have to send
8318                    the respective command to actually get the MIDI instrument map info. Because these messages
8319                    will be triggered by LSCP commands issued by other clients rather than real
8320                    time events happening on the server, it is believed that an empty notification
8321                    message is sufficient here.
8322    </p>
8323    <a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr />
8324    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8325    <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;
8326    Number of MIDI instruments changed</h3>
8327    
8328    <p>Client may want to be notified when the number of MIDI instrument maps on the
8329                    back-end changes by issuing the following command:
8330    </p>
8331    <p>
8332                        </p>
8333    <blockquote class="text">
8334    <p>SUBSCRIBE MIDI_INSTRUMENT_COUNT
8335    </p>
8336    </blockquote><p>
8337                    
8338    </p>
8339    <p>Server will start sending the following notification messages:
8340    </p>
8341    <p>
8342                        </p>
8343    <blockquote class="text">
8344    <p>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"
8345    </p>
8346    </blockquote><p>
8347                    
8348    </p>
8349    <p>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
8350                    the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
8351                    the new number of MIDI instruments in the specified map.
8352    </p>
8353    <a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr />
8354    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8355    <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;
8356    MIDI instrument information changed</h3>
8357    
8358    <p>Client may want to be notified when changes were made to MIDI instruments on the
8359                    back-end by issuing the following command:
8360    </p>
8361    <p>
8362                        </p>
8363    <blockquote class="text">
8364    <p>SUBSCRIBE MIDI_INSTRUMENT_INFO
8365    </p>
8366    </blockquote><p>
8367                    
8368    </p>
8369    <p>Server will start sending the following notification messages:
8370    </p>
8371    <p>
8372                        </p>
8373    <blockquote class="text">
8374    <p>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"
8375    </p>
8376    </blockquote><p>
8377                    
8378    </p>
8379    <p>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
8380                    in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
8381                    the location of the changed MIDI instrument in the map. The front-end will have to send
8382                    the respective command to actually get the MIDI instrument info. Because these messages
8383                    will be triggered by LSCP commands issued by other clients rather than real
8384                    time events happening on the server, it is believed that an empty notification
8385                    message is sufficient here.
8386    </p>
8387  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
8388  <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>
8389  <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;Miscellaneous and debugging events</h3>  <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;
8390    Miscellaneous and debugging events</h3>
8391    
8392  <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
8393                  the server by issuing the following command:                  the server by issuing the following command:
# Line 5905  Intellectual Property and Copyright Stat Line 8415  Intellectual Property and Copyright Stat
8415                  user AS IS to facilitate debugging.                  user AS IS to facilitate debugging.
8416  </p>  </p>
8417  <a name="anchor14"></a><br /><hr />  <a name="anchor14"></a><br /><hr />
8418  <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>
8419  <a name="rfc.section.9"></a><h3>9.&nbsp;Security Considerations</h3>  <a name="rfc.section.9"></a><h3>9.&nbsp;
8420    Security Considerations</h3>
8421    
8422  <p>As there is so far no method of authentication and authorization  <p>As there is so far no method of authentication and authorization
8423              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 8425  Intellectual Property and Copyright Stat
8425              system the LinuxSampler instance is running on.              system the LinuxSampler instance is running on.
8426  </p>  </p>
8427  <a name="anchor15"></a><br /><hr />  <a name="anchor15"></a><br /><hr />
8428  <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>
8429  <a name="rfc.section.10"></a><h3>10.&nbsp;Acknowledgments</h3>  <a name="rfc.section.10"></a><h3>10.&nbsp;
8430    Acknowledgments</h3>
8431    
8432  <p>This document has benefited greatly from the comments of the  <p>This document has benefited greatly from the comments of the
8433              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 8448  Intellectual Property and Copyright Stat
8448                            
8449  </p>  </p>
8450  <a name="rfc.references1"></a><br /><hr />  <a name="rfc.references1"></a><br /><hr />
8451  <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>
8452  <h3>11.&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
8453  <table width="99%" border="0">  <table width="99%" border="0">
8454  <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 8460  Intellectual Property and Copyright Stat
8460  </table>  </table>
8461    
8462  <a name="rfc.authors"></a><br /><hr />  <a name="rfc.authors"></a><br /><hr />
8463  <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>
8464  <h3>Author's Address</h3>  <h3>Author's Address</h3>
8465  <table width="99%" border="0" cellpadding="0" cellspacing="0">  <table width="99%" border="0" cellpadding="0" cellspacing="0">
8466  <tr><td class="author-text">&nbsp;</td>  <tr><td class="author-text">&nbsp;</td>
# Line 5966  Schoenebeck</td></tr> Line 8478  Schoenebeck</td></tr>
8478  <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>
8479  </table>  </table>
8480  <a name="rfc.copyright"></a><br /><hr />  <a name="rfc.copyright"></a><br /><hr />
8481  <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>
8482  <h3>Intellectual Property Statement</h3>  <h3>Full Copyright Statement</h3>
8483  <p class='copyright'>  <p class='copyright'>
8484  The IETF takes no position regarding the validity or scope of  Copyright &copy; The Internet Society (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>  
8485  <p class='copyright'>  <p class='copyright'>
8486  The IETF invites any interested party to bring to its  This document is subject to the rights,
8487  attention any copyrights, patents or patent applications, or  licenses and restrictions contained in BCP&nbsp;78,
8488  other proprietary rights which may cover technology that may be  and except as set forth therein,
8489  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>  
8490  <p class='copyright'>  <p class='copyright'>
8491  Copyright &copy; The Internet Society (2006). All Rights Reserved.</p>  This document and the information contained herein are provided
8492    on an &ldquo;AS IS&rdquo; basis and THE CONTRIBUTOR,
8493    THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY),
8494    THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM
8495    ALL WARRANTIES,
8496    EXPRESS OR IMPLIED,
8497    INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
8498    INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
8499    WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.</p>
8500    <h3>Intellectual Property</h3>
8501  <p class='copyright'>  <p class='copyright'>
8502  This document and translations of it may be copied and furnished to  The IETF takes no position regarding the validity or scope of any
8503  others, and derivative works that comment on or otherwise explain it  Intellectual Property Rights or other rights that might be claimed
8504  or assist in its implementation may be prepared, copied, published and  to pertain to the implementation or use of the technology
8505  distributed, in whole or in part, without restriction of any kind,  described in this document or the extent to which any license
8506  provided that the above copyright notice and this paragraph are  under such rights might or might not be available; nor does it
8507  included on all such copies and derivative works. However, this  represent that it has made any independent effort to identify any
8508  document itself may not be modified in any way, such as by removing  such rights.
8509  the copyright notice or references to the Internet Society or other  Information on the procedures with respect to
8510  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>  
8511  <p class='copyright'>  <p class='copyright'>
8512  The limited permissions granted above are perpetual and will not be  Copies of IPR disclosures made to the IETF Secretariat and any
8513  revoked by the Internet Society or its successors or assignees.</p>  assurances of licenses to be made available,
8514    or the result of an attempt made to obtain a general license or
8515    permission for the use of such proprietary rights by implementers or
8516    users of this specification can be obtained from the IETF on-line IPR
8517    repository at <a href='http://www.ietf.org/ipr'>http://www.ietf.org/ipr</a>.</p>
8518  <p class='copyright'>  <p class='copyright'>
8519  This document and the information contained herein is provided on an  The IETF invites any interested party to bring to its attention
8520  &ldquo;AS IS&rdquo; basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING  any copyrights,
8521  TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING  patents or patent applications,
8522  BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION  or other
8523  HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  proprietary rights that may cover technology that may be required
8524  MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.</p>  to implement this standard.
8525    Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p>
8526  <h3>Acknowledgment</h3>  <h3>Acknowledgment</h3>
8527  <p class='copyright'>  <p class='copyright'>
8528  Funding for the RFC Editor function is currently provided by the  Funding for the RFC Editor function is provided by
8529  Internet Society.</p>  the IETF Administrative Support Activity (IASA).</p>
8530  </body></html>  </body></html>

Legend:
Removed from v.940  
changed lines
  Added in v.1048

  ViewVC Help
Powered by ViewVC