/[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 945 by schoenebeck, Sun Nov 26 16:39:49 2006 UTC revision 1110 by iliev, Thu Mar 22 21:12:10 2007 UTC
# Line 3  Line 3 
3  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
4  <meta name="description" content="LinuxSampler Control Protocol">  <meta name="description" content="LinuxSampler Control Protocol">
5  <meta name="keywords" content="LSCP">  <meta name="keywords" content="LSCP">
6  <meta name="generator" content="xml2rfc v1.30 (http://xml.resource.org/)">  <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">
7  <style type='text/css'>  <style type='text/css'><!--
8  <!--          body {
9      body {                  font-family: verdana, charcoal, helvetica, arial, sans-serif;
10          font-family: verdana, charcoal, helvetica, arial, sans-serif;                  font-size: small; color: #000; background-color: #FFF;
11          margin: 2em;                  margin: 2em;
12          font-size: small ; color: #000000 ; background-color: #ffffff ; }          }
13      .title { color: #990000; font-size: x-large ;          h1, h2, h3, h4, h5, h6 {
14          font-weight: bold; text-align: right;                  font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;
15          font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;                  font-weight: bold; font-style: normal;
16          background-color: transparent; }          }
17      .filename { color: #666666; font-size: 18px; line-height: 28px;          h1 { color: #900; background-color: transparent; text-align: right; }
18          font-weight: bold; text-align: right;          h3 { color: #333; background-color: transparent; }
19          font-family: helvetica, arial, sans-serif;  
20          background-color: transparent; }          td.RFCbug {
21      td.rfcbug { background-color: #000000 ; width: 30px ; height: 30px ;                  font-size: x-small; text-decoration: none;
22          text-align: justify; vertical-align: middle ; padding-top: 2px ; }                  width: 30px; height: 30px; padding-top: 2px;
23      td.rfcbug span.RFC { color: #666666; font-weight: bold; text-decoration: none;                  text-align: justify; vertical-align: middle;
24          background-color: #000000 ;                  background-color: #000;
25          font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;          }
26          font-size: x-small ; }          td.RFCbug span.RFC {
27      td.rfcbug span.hotText { color: #ffffff; font-weight: normal; text-decoration: none;                  font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
28          text-align: center ;                  font-weight: bold; color: #666;
29          font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;          }
30          font-size: x-small ; background-color: #000000; }          td.RFCbug span.hotText {
31      /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */                  font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
32      div#counter{margin-top: 100px}                  font-weight: normal; text-align: center; color: #FFF;
   
     a.info{  
         position:relative; /*this is the key*/  
         z-index:24;  
         text-decoration:none}  
   
     a.info:hover{z-index:25; background-color:#990000 ; color: #ffffff ;}  
   
     a.info span{display: none}  
   
     a.info:hover span.info{ /*the span will display just on :hover state*/  
         display:block;  
         position:absolute;  
         font-size: smaller ;  
         top:2em; left:2em; width:15em;  
         padding: 2px ;  
         border:1px solid #333333;  
         background-color:#eeeeee; color:#990000;  
         text-align: left ;}  
   
      A { font-weight: bold; }  
      A:link { color: #990000; background-color: transparent ; }  
      A:visited { color: #333333; background-color: transparent ; }  
      A:active { color: #333333; background-color: transparent ; }  
   
     p { margin-left: 2em; margin-right: 2em; }  
     p.copyright { font-size: x-small ; }  
     p.toc { font-size: small ; font-weight: bold ; margin-left: 3em ;}  
     table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; }  
     td.toc { font-size: small; font-weight: bold; vertical-align: text-top; }  
   
     span.emph { font-style: italic; }  
     span.strong { font-weight: bold; }  
     span.verb, span.vbare { font-family: "Courier New", Courier, monospace ; }  
   
     span.vemph { font-style: italic; font-family: "Courier New", Courier, monospace ; }  
     span.vstrong { font-weight: bold; font-family: "Courier New", Courier, monospace ; }  
     span.vdeluxe { font-weight: bold; font-style: italic; font-family: "Courier New", Courier, monospace ; }  
   
     ol.text { margin-left: 2em; margin-right: 2em; }  
     ul.text { margin-left: 2em; margin-right: 2em; }  
     li { margin-left: 3em;  }  
   
     pre { margin-left: 3em; color: #333333;  background-color: transparent;  
         font-family: "Courier New", Courier, monospace ; font-size: small ;  
         text-align: left;  
33          }          }
34    
35      h3 { color: #333333; font-size: medium ;          table.TOCbug { width: 30px; height: 15px; }
36          font-family: helvetica, arial, sans-serif ;          td.TOCbug {
37          background-color: transparent; }                  text-align: center; width: 30px; height: 15px;
38      h4 { font-size: small; font-family: helvetica, arial, sans-serif ; }                  color: #FFF; background-color: #900;
39            }
40      table.bug { width: 30px ; height: 15px ; }          td.TOCbug a {
41      td.bug { color: #ffffff ; background-color: #990000 ;                  font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;
42          text-align: center ; width: 30px ; height: 15px ;                  font-weight: bold; font-size: x-small; text-decoration: none;
43           }                  color: #FFF; background-color: transparent;
44      td.bug A.link2 { color: #ffffff ; font-weight: bold;          }
45          text-decoration: none;  
46          font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;          td.header {
47          font-size: x-small ; background-color: transparent }                  font-family: arial, helvetica, sans-serif; font-size: x-small;
48                    vertical-align: top; width: 33%;
49      td.header { color: #ffffff; font-size: x-small ;                  color: #FFF; background-color: #666;
50          font-family: arial, helvetica, sans-serif; vertical-align: top;          }
51          background-color: #666666 ; width: 33% ; }          td.author { font-weight: bold; font-size: x-small; margin-left: 4em; }
52      td.author { font-weight: bold; margin-left: 4em; font-size: x-small ; }          td.author-text { font-size: x-small; }
53      td.author-text { font-size: x-small; }  
54      table.full { vertical-align: top ; border-collapse: collapse ;          /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */
55          border-style: solid solid solid solid ;          a.info {
56          border-color: black black black black ;                  /* This is the key. */
57          font-size: small ; text-align: center ; }                  position: relative;
58      table.headers, table.none { vertical-align: top ; border-collapse: collapse ;                  z-index: 24;
59          border-style: none;                  text-decoration: none;
60          font-size: small ; text-align: center ; }          }
61      table.full th { font-weight: bold ;          a.info:hover {
62          border-style: solid ;                  z-index: 25;
63          border-color: black black black black ; }                  color: #FFF; background-color: #900;
64      table.headers th { font-weight: bold ;          }
65          border-style: none none solid none;          a.info span { display: none; }
66          border-color: black black black black ; }          a.info:hover span.info {
67      table.none th { font-weight: bold ;                  /* The span will display just on :hover state. */
68          border-style: none; }                  display: block;
69      table.full td {                  position: absolute;
70          border-style: solid solid solid solid ;                  font-size: smaller;
71          border-color: #333333 #333333 #333333 #333333 ; }                  top: 2em; left: -5em; width: 15em;
72      table.headers td, table.none td { border-style: none; }                  padding: 2px; border: 1px solid #333;
73                    color: #900; background-color: #EEE;
74      hr { height: 1px }                  text-align: left;
75  -->          }
76  </style>  
77            a { font-weight: bold; }
78            a:link    { color: #900; background-color: transparent; }
79            a:visited { color: #633; background-color: transparent; }
80            a:active  { color: #633; background-color: transparent; }
81    
82            p { margin-left: 2em; margin-right: 2em; }
83            p.copyright { font-size: x-small; }
84            p.toc { font-size: small; font-weight: bold; margin-left: 3em; }
85            table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; }
86            td.toc { font-size: small; font-weight: bold; vertical-align: text-top; }
87    
88            ol.text { margin-left: 2em; margin-right: 2em; }
89            ul.text { margin-left: 2em; margin-right: 2em; }
90            li      { margin-left: 3em; }
91    
92            /* RFC-2629 <spanx>s and <artwork>s. */
93            em     { font-style: italic; }
94            strong { font-weight: bold; }
95            dfn    { font-weight: bold; font-style: normal; }
96            cite   { font-weight: normal; font-style: normal; }
97            tt     { color: #036; }
98            tt, pre, pre dfn, pre em, pre cite, pre span {
99                    font-family: "Courier New", Courier, monospace; font-size: small;
100            }
101            pre {
102                    text-align: left; padding: 4px;
103                    color: #000; background-color: #CCC;
104            }
105            pre dfn  { color: #900; }
106            pre em   { color: #66F; background-color: #FFC; font-weight: normal; }
107            pre .key { color: #33C; font-weight: bold; }
108            pre .id  { color: #900; }
109            pre .str { color: #000; background-color: #CFF; }
110            pre .val { color: #066; }
111            pre .rep { color: #909; }
112            pre .oth { color: #000; background-color: #FCF; }
113            pre .err { background-color: #FCC; }
114    
115            /* RFC-2629 <texttable>s. */
116            table.all, table.full, table.headers, table.none {
117                    font-size: small; text-align: center; border-width: 2px;
118                    vertical-align: top; border-collapse: collapse;
119            }
120            table.all, table.full { border-style: solid; border-color: black; }
121            table.headers, table.none { border-style: none; }
122            th {
123                    font-weight: bold; border-color: black;
124                    border-width: 2px 2px 3px 2px;
125            }
126            table.all th, table.full th { border-style: solid; }
127            table.headers th { border-style: none none solid none; }
128            table.none th { border-style: none; }
129            table.all td {
130                    border-style: solid; border-color: #333;
131                    border-width: 1px 2px;
132            }
133            table.full td, table.headers td, table.none td { border-style: none; }
134    
135            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 30, 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 26, 2006</td></tr>  <tr><td class="header">Expires: September 23, 2007</td><td class="header">March 22, 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.2</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 30, 2007.</p>  This Internet-Draft will expire on September 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 IETF Trust (2007).</p>
181    
182  <h3>Abstract</h3>  <h3>Abstract</h3>
183    
# Line 278  Current number of active disk streams<br Line 298  Current number of active disk streams<br
298  Current fill state of disk stream buffers<br />  Current fill state of disk stream buffers<br />
299  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_DEVICE">6.4.14.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_DEVICE">6.4.14.</a>&nbsp;
300  Setting audio output device<br />  Setting audio output device<br />
301  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_TYP">6.4.15.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_TYPE">6.4.15.</a>&nbsp;
302  Setting audio output type<br />  Setting audio output type<br />
303  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_CHANNEL">6.4.16.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_CHANNEL">6.4.16.</a>&nbsp;
304  Setting audio output channel<br />  Setting audio output channel<br />
# Line 296  Setting channel volume<br /> Line 316  Setting channel volume<br />
316  Muting a sampler channel<br />  Muting a sampler channel<br />
317  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL SOLO">6.4.23.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL SOLO">6.4.23.</a>&nbsp;
318  Soloing a sampler channel<br />  Soloing a sampler channel<br />
319  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.24.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INSTRUMENT_MAP">6.4.24.</a>&nbsp;
320    Assigning a MIDI instrument map to a sampler channel<br />
321    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE FX_SEND">6.4.25.</a>&nbsp;
322    Adding an effect send to a sampler channel<br />
323    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY FX_SEND">6.4.26.</a>&nbsp;
324    Removing an effect send from a sampler channel<br />
325    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SENDS">6.4.27.</a>&nbsp;
326    Getting amount of effect sends on a sampler channel<br />
327    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST FX_SENDS">6.4.28.</a>&nbsp;
328    Listing all effect sends on a sampler channel<br />
329    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SEND INFO">6.4.29.</a>&nbsp;
330    Getting effect send information<br />
331    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND 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;<a href="#anchor14">6.7.</a>&nbsp;  &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 />  MIDI Instrument Mapping<br />
365  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MAP MIDI_INSTRUMENT">6.7.1.</a>&nbsp;  &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 />  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.2.</a>&nbsp;  &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 />  Getting ammount of MIDI instrument map entries<br />
381  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INSTRUMENTS">6.7.3.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INSTRUMENTS">6.7.9.</a>&nbsp;
382  Getting indeces of all MIDI instrument map entries<br />  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.4.</a>&nbsp;  &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 />  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.5.</a>&nbsp;  &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 />  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.6.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CLEAR MIDI_INSTRUMENTS">6.7.12.</a>&nbsp;
388  Clear MIDI instrument map<br />  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 FX_SEND_COUNT">8.10.</a>&nbsp;
412    Number of effect sends changed<br />
413    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_INFO">8.11.</a>&nbsp;
414    Effect send information changed<br />
415    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a>&nbsp;
416  Total number of active voices changed<br />  Total number of active voices changed<br />
417  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.7.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.13.</a>&nbsp;
418    Number of MIDI instrument maps changed<br />
419    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.14.</a>&nbsp;
420    MIDI instrument map information changed<br />
421    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.15.</a>&nbsp;
422    Number of MIDI instruments changed<br />
423    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.16.</a>&nbsp;
424    MIDI instrument information changed<br />
425    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a>&nbsp;
426    Global settings changed<br />
427    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.18.</a>&nbsp;
428  Miscellaneous and debugging events<br />  Miscellaneous and debugging events<br />
429  <a href="#anchor15">9.</a>&nbsp;  <a href="#anchor14">9.</a>&nbsp;
430  Security Considerations<br />  Security Considerations<br />
431  <a href="#anchor16">10.</a>&nbsp;  <a href="#anchor15">10.</a>&nbsp;
432  Acknowledgments<br />  Acknowledgments<br />
433  <a href="#rfc.references1">11.</a>&nbsp;  <a href="#rfc.references1">11.</a>&nbsp;
434  References<br />  References<br />
# Line 364  Intellectual Property and Copyright Stat Line 440  Intellectual Property and Copyright Stat
440  <br clear="all" />  <br clear="all" />
441    
442  <a name="anchor1"></a><br /><hr />  <a name="anchor1"></a><br /><hr />
443  <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>
444  <a name="rfc.section.1"></a><h3>1.&nbsp;Requirements notation</h3>  <a name="rfc.section.1"></a><h3>1.&nbsp;
445    Requirements notation</h3>
446    
447  <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",  <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
448              "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",              "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
449              and "OPTIONAL" in this document are to be interpreted as              and "OPTIONAL" in this document are to be interpreted as
450              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>.
451  </p>  </p>
452  <p>This protocol is always case-sensitive if not explicitly  <p>This protocol is always case-sensitive if not explicitly
453              claimed the opposite.              claimed the opposite.
# Line 446  Intellectual Property and Copyright Stat Line 523  Intellectual Property and Copyright Stat
523              return and line feed characters respectively.              return and line feed characters respectively.
524  </p>  </p>
525  <a name="LSCP versioning"></a><br /><hr />  <a name="LSCP versioning"></a><br /><hr />
526  <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>
527  <a name="rfc.section.2"></a><h3>2.&nbsp;Versioning of this specification</h3>  <a name="rfc.section.2"></a><h3>2.&nbsp;
528    Versioning of this specification</h3>
529    
530  <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
531              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 490  Intellectual Property and Copyright Stat Line 568  Intellectual Property and Copyright Stat
568  <p>  <p>
569              Compatibility can only be claimed if both rules are true.              Compatibility can only be claimed if both rules are true.
570              The frontend can use the              The frontend can use the
571              <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
572              get the version of the LSCP specification the sampler complies with.              get the version of the LSCP specification the sampler complies with.
573                            
574  </p>  </p>
575  <a name="anchor2"></a><br /><hr />  <a name="anchor2"></a><br /><hr />
576  <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>
577  <a name="rfc.section.3"></a><h3>3.&nbsp;Introduction</h3>  <a name="rfc.section.3"></a><h3>3.&nbsp;
578    Introduction</h3>
579    
580  <p>LinuxSampler is a so called software sampler application  <p>LinuxSampler is a so called software sampler application
581              capable to playback audio samples from a computer's Random              capable to playback audio samples from a computer's Random
# Line 516  Intellectual Property and Copyright Stat Line 595  Intellectual Property and Copyright Stat
595              there.              there.
596  </p>  </p>
597  <a name="anchor3"></a><br /><hr />  <a name="anchor3"></a><br /><hr />
598  <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>
599  <a name="rfc.section.4"></a><h3>4.&nbsp;Focus of this protocol</h3>  <a name="rfc.section.4"></a><h3>4.&nbsp;
600    Focus of this protocol</h3>
601    
602  <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
603              a running LinuxSampler instance and to retrieve information              a running LinuxSampler instance and to retrieve information
# Line 528  Intellectual Property and Copyright Stat Line 608  Intellectual Property and Copyright Stat
608              via MIDI System Exclusive Messages.              via MIDI System Exclusive Messages.
609  </p>  </p>
610  <a name="anchor4"></a><br /><hr />  <a name="anchor4"></a><br /><hr />
611  <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>
612  <a name="rfc.section.5"></a><h3>5.&nbsp;Communication Overview</h3>  <a name="rfc.section.5"></a><h3>5.&nbsp;
613    Communication Overview</h3>
614    
615  <p>There are two distinct methods of communication between a  <p>There are two distinct methods of communication between a
616              running instance of LinuxSampler and one or more control              running instance of LinuxSampler and one or more control
# Line 543  Intellectual Property and Copyright Stat Line 624  Intellectual Property and Copyright Stat
624              methods will be described next.              methods will be described next.
625  </p>  </p>
626  <a name="anchor5"></a><br /><hr />  <a name="anchor5"></a><br /><hr />
627  <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>
628  <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;
629    Request/response communication method</h3>
630    
631  <p>This simple communication method is based on  <p>This simple communication method is based on
632                  <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
633                  front-end application establishes a TCP connection to the                  front-end application establishes a TCP connection to the
634                  LinuxSampler instance on a certain host system. Then the                  LinuxSampler instance on a certain host system. Then the
635                  front-end application will send certain ASCII based commands                  front-end application will send certain ASCII based commands
# Line 588  Intellectual Property and Copyright Stat Line 670  Intellectual Property and Copyright Stat
670                  MUST be sent back in the same order.                  MUST be sent back in the same order.
671  </p>  </p>
672  <a name="anchor6"></a><br /><hr />  <a name="anchor6"></a><br /><hr />
673  <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>
674  <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;
675    Result format</h3>
676    
677  <p>Result set could be one of the following types:  <p>Result set could be one of the following types:
678  </p>  </p>
# Line 780  Intellectual Property and Copyright Stat Line 863  Intellectual Property and Copyright Stat
863                                            
864  </p>  </p>
865  <a name="anchor7"></a><br /><hr />  <a name="anchor7"></a><br /><hr />
866  <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>
867  <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;
868    Subscribe/notify communication method</h3>
869    
870  <p>This more sophisticated communication method is actually  <p>This more sophisticated communication method is actually
871                  only an extension of the simple request/response                  only an extension of the simple request/response
# Line 858  Intellectual Property and Copyright Stat Line 942  Intellectual Property and Copyright Stat
942  </p>  </p>
943  <p>where &lt;event-id&gt; will be replace by the respective  <p>where &lt;event-id&gt; will be replace by the respective
944                  event that client is no longer interested in receiving. For                  event that client is no longer interested in receiving. For
945                  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>.
946  </p>  </p>
947  <p>Example: the fill states of disk stream buffers have  <p>Example: the fill states of disk stream buffers have
948                  changed on sampler channel 4 and the LinuxSampler instance                  changed on sampler channel 4 and the LinuxSampler instance
# Line 904  Intellectual Property and Copyright Stat Line 988  Intellectual Property and Copyright Stat
988                  it wants to receive.                  it wants to receive.
989  </p>  </p>
990  <a name="control_commands"></a><br /><hr />  <a name="control_commands"></a><br /><hr />
991  <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>
992  <a name="rfc.section.6"></a><h3>6.&nbsp;Description for control commands</h3>  <a name="rfc.section.6"></a><h3>6.&nbsp;
993    Description for control commands</h3>
994    
995  <p>This chapter will describe the available control commands  <p>This chapter will describe the available control commands
996              that can be sent on the TCP connection in detail. Some certain              that can be sent on the TCP connection in detail. Some certain
997              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>
998              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
999              multiple-line responses. In this case LinuxSampler signals the              multiple-line responses. In this case LinuxSampler signals the
1000              end of the response by a "." (single dot) line.              end of the response by a "." (single dot) line.
1001  </p>  </p>
1002  <a name="anchor8"></a><br /><hr />  <a name="anchor8"></a><br /><hr />
1003  <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>
1004  <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;
1005    Ignored lines and comments</h3>
1006    
1007  <p>White lines, that is lines which only contain space and  <p>White lines, that is lines which only contain space and
1008                  tabulator characters, and lines that start with a "#"                  tabulator characters, and lines that start with a "#"
# Line 925  Intellectual Property and Copyright Stat Line 1011  Intellectual Property and Copyright Stat
1011                  file.                  file.
1012  </p>  </p>
1013  <a name="anchor9"></a><br /><hr />  <a name="anchor9"></a><br /><hr />
1014  <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>
1015  <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;
1016    Configuring audio drivers</h3>
1017    
1018  <p>Instances of drivers in LinuxSampler are called devices.  <p>Instances of drivers in LinuxSampler are called devices.
1019                  You can use multiple audio devices simultaneously, e.g. to                  You can use multiple audio devices simultaneously, e.g. to
# Line 960  Intellectual Property and Copyright Stat Line 1047  Intellectual Property and Copyright Stat
1047                  possible values, etc.                  possible values, etc.
1048  </p>  </p>
1049  <a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />  <a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />
1050  <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>
1051  <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;
1052    Getting amount of available audio output drivers</h3>
1053    
1054  <p>Use the following command to get the number of  <p>Use the following command to get the number of
1055                      audio output drivers currently available for the                      audio output drivers currently available for the
# Line 999  Intellectual Property and Copyright Stat Line 1087  Intellectual Property and Copyright Stat
1087                                            
1088  </p>  </p>
1089  <a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />  <a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />
1090  <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>
1091  <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;
1092    Getting all available audio output drivers</h3>
1093    
1094  <p>Use the following command to list all audio output  <p>Use the following command to list all audio output
1095                      drivers currently available for the LinuxSampler                      drivers currently available for the LinuxSampler
# Line 1039  Intellectual Property and Copyright Stat Line 1128  Intellectual Property and Copyright Stat
1128                                            
1129  </p>  </p>
1130  <a name="GET AUDIO_OUTPUT_DRIVER INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DRIVER INFO"></a><br /><hr />
1131  <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>
1132  <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;
1133    Getting information about a specific audio
1134                  output driver</h3>                  output driver</h3>
1135    
1136  <p>Use the following command to get detailed information  <p>Use the following command to get detailed information
# Line 1057  Intellectual Property and Copyright Stat Line 1147  Intellectual Property and Copyright Stat
1147  </p>  </p>
1148  <p>Where &lt;audio-output-driver&gt; is the name of the  <p>Where &lt;audio-output-driver&gt; is the name of the
1149                      audio output driver, returned by the                      audio output driver, returned by the
1150                      <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.
1151  </p>  </p>
1152  <p>Possible Answers:  <p>Possible Answers:
1153  </p>  </p>
# Line 1138  Intellectual Property and Copyright Stat Line 1228  Intellectual Property and Copyright Stat
1228                                            
1229  </p>  </p>
1230  <a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"></a><br /><hr />
1231  <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>
1232  <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;
1233    Getting information about specific audio
1234                  output driver parameter</h3>                  output driver parameter</h3>
1235    
1236  <p>Use the following command to get detailed information  <p>Use the following command to get detailed information
# Line 1154  Intellectual Property and Copyright Stat Line 1245  Intellectual Property and Copyright Stat
1245                                            
1246  </p>  </p>
1247  <p>Where &lt;audio&gt; is the name of the audio output  <p>Where &lt;audio&gt; is the name of the audio output
1248                      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,
1249                      &lt;prm&gt; a specific parameter name for which information should be                      &lt;prm&gt; a specific parameter name for which information should be
1250                      obtained (as returned by the                      obtained (as returned by the
1251                      <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
1252                      &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
1253                      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
1254                      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 1214  Intellectual Property and Copyright Stat Line 1305  Intellectual Property and Copyright Stat
1305  <blockquote class="text">  <blockquote class="text">
1306  <p>either true or false, defines if this parameter must be  <p>either true or false, defines if this parameter must be
1307                                  given when the device is to be created with the                                  given when the device is to be created with the
1308                                  <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>
1309                                  command (always returned, no matter which driver parameter)                                  command (always returned, no matter which driver parameter)
1310  </p>  </p>
1311  </blockquote>  </blockquote>
# Line 1225  Intellectual Property and Copyright Stat Line 1316  Intellectual Property and Copyright Stat
1316  <blockquote class="text">  <blockquote class="text">
1317  <p>either true or false, if false then this parameter can  <p>either true or false, if false then this parameter can
1318                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
1319                                  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>
1320                                  command (always returned, no matter which driver parameter)                                  command (always returned, no matter which driver parameter)
1321  </p>  </p>
1322  </blockquote>  </blockquote>
# Line 1264  Intellectual Property and Copyright Stat Line 1355  Intellectual Property and Copyright Stat
1355  <blockquote class="text">  <blockquote class="text">
1356  <p>reflects the default value for this parameter which is  <p>reflects the default value for this parameter which is
1357                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
1358                                  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,
1359                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
1360                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
1361                                  apostrophes (')                                  apostrophes (')
# Line 1392  Intellectual Property and Copyright Stat Line 1483  Intellectual Property and Copyright Stat
1483                                            
1484  </p>  </p>
1485  <a name="CREATE AUDIO_OUTPUT_DEVICE"></a><br /><hr />  <a name="CREATE AUDIO_OUTPUT_DEVICE"></a><br /><hr />
1486  <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>
1487  <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;
1488    Creating an audio output device</h3>
1489    
1490  <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:
1491  </p>  </p>
# Line 1407  Intellectual Property and Copyright Stat Line 1499  Intellectual Property and Copyright Stat
1499  </p>  </p>
1500  <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
1501                      output system as returned by the                      output system as returned by the
1502                      <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>
1503                      command and &lt;param-list&gt; by an optional list of driver                      command and &lt;param-list&gt; by an optional list of driver
1504                      specific parameters in form of "key1=val1 key2=val2 ...", where                      specific parameters in form of "key1=val1 key2=val2 ...", where
1505                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
# Line 1476  Intellectual Property and Copyright Stat Line 1568  Intellectual Property and Copyright Stat
1568                                            
1569  </p>  </p>
1570  <a name="DESTROY AUDIO_OUTPUT_DEVICE"></a><br /><hr />  <a name="DESTROY AUDIO_OUTPUT_DEVICE"></a><br /><hr />
1571  <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>
1572  <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;
1573    Destroying an audio output device</h3>
1574    
1575  <p>Use the following command to destroy a created output device:  <p>Use the following command to destroy a created output device:
1576  </p>  </p>
# Line 1491  Intellectual Property and Copyright Stat Line 1584  Intellectual Property and Copyright Stat
1584  </p>  </p>
1585  <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
1586                      audio output device as given by the                      audio output device as given by the
1587                      <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>
1588                      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>
1589                      command.                      command.
1590  </p>  </p>
1591  <p>Possible Answers:  <p>Possible Answers:
# Line 1545  Intellectual Property and Copyright Stat Line 1638  Intellectual Property and Copyright Stat
1638                                            
1639  </p>  </p>
1640  <a name="GET AUDIO_OUTPUT_DEVICES"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DEVICES"></a><br /><hr />
1641  <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>
1642  <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;
1643    Getting all created audio output device count</h3>
1644    
1645  <p>Use the following command to count all created audio output devices:  <p>Use the following command to count all created audio output devices:
1646  </p>  </p>
# Line 1582  Intellectual Property and Copyright Stat Line 1676  Intellectual Property and Copyright Stat
1676                                            
1677  </p>  </p>
1678  <a name="LIST AUDIO_OUTPUT_DEVICES"></a><br /><hr />  <a name="LIST AUDIO_OUTPUT_DEVICES"></a><br /><hr />
1679  <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>
1680  <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;
1681    Getting all created audio output device list</h3>
1682    
1683  <p>Use the following command to list all created audio output devices:  <p>Use the following command to list all created audio output devices:
1684  </p>  </p>
# Line 1619  Intellectual Property and Copyright Stat Line 1714  Intellectual Property and Copyright Stat
1714                                            
1715  </p>  </p>
1716  <a name="GET AUDIO_OUTPUT_DEVICE INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_DEVICE INFO"></a><br /><hr />
1717  <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>
1718  <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;
1719    Getting current settings of an audio output device</h3>
1720    
1721  <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:
1722  </p>  </p>
# Line 1634  Intellectual Property and Copyright Stat Line 1730  Intellectual Property and Copyright Stat
1730  </p>  </p>
1731  <p>Where &lt;device-id&gt; should be replaced by numerical ID  <p>Where &lt;device-id&gt; should be replaced by numerical ID
1732                      of the audio output device as e.g. returned by the                      of the audio output device as e.g. returned by the
1733                      <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.
1734  </p>  </p>
1735  <p>Possible Answers:  <p>Possible Answers:
1736  </p>  </p>
# Line 1654  Intellectual Property and Copyright Stat Line 1750  Intellectual Property and Copyright Stat
1750  <blockquote class="text">  <blockquote class="text">
1751  <p>identifier of the used audio output driver, as also  <p>identifier of the used audio output driver, as also
1752                                      returned by the                                      returned by the
1753                                      <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>
1754                                      command                                      command
1755  </p>  </p>
1756  </blockquote>  </blockquote>
# Line 1695  Intellectual Property and Copyright Stat Line 1791  Intellectual Property and Copyright Stat
1791                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
1792                      returned by all audio output devices. Every audio output driver                      returned by all audio output devices. Every audio output driver
1793                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
1794                      <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>)
1795                      which are also returned by this command.                      which are also returned by this command.
1796  </p>  </p>
1797  <p>Example:  <p>Example:
# Line 1725  Intellectual Property and Copyright Stat Line 1821  Intellectual Property and Copyright Stat
1821                                            
1822  </p>  </p>
1823  <a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER"></a><br /><hr />  <a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER"></a><br /><hr />
1824  <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>
1825  <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;
1826    Changing settings of audio output devices</h3>
1827    
1828  <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:
1829  </p>  </p>
# Line 1740  Intellectual Property and Copyright Stat Line 1837  Intellectual Property and Copyright Stat
1837  </p>  </p>
1838  <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
1839                      audio output device as given by the                      audio output device as given by the
1840                      <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>
1841                      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>
1842                      command, &lt;key&gt; by the name of the parameter to change                      command, &lt;key&gt; by the name of the parameter to change
1843                      and &lt;value&gt; by the new value for this parameter.                      and &lt;value&gt; by the new value for this parameter.
1844  </p>  </p>
# Line 1793  Intellectual Property and Copyright Stat Line 1890  Intellectual Property and Copyright Stat
1890                                            
1891  </p>  </p>
1892  <a name="GET AUDIO_OUTPUT_CHANNEL INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_CHANNEL INFO"></a><br /><hr />
1893  <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>
1894  <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;
1895    Getting information about an audio channel</h3>
1896    
1897  <p>Use the following command to get information about an audio channel:  <p>Use the following command to get information about an audio channel:
1898  </p>  </p>
# Line 1807  Intellectual Property and Copyright Stat Line 1905  Intellectual Property and Copyright Stat
1905                                            
1906  </p>  </p>
1907  <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
1908                      <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>
1909                      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>
1910                      command and &lt;audio-chan&gt; the audio channel number.                      command and &lt;audio-chan&gt; the audio channel number.
1911  </p>  </p>
1912  <p>Possible Answers:  <p>Possible Answers:
# Line 1935  Intellectual Property and Copyright Stat Line 2033  Intellectual Property and Copyright Stat
2033                                            
2034  </p>  </p>
2035  <a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"></a><br /><hr />  <a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"></a><br /><hr />
2036  <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>
2037  <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;
2038    Getting information about specific audio channel parameter</h3>
2039    
2040  <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:
2041  </p>  </p>
# Line 1949  Intellectual Property and Copyright Stat Line 2048  Intellectual Property and Copyright Stat
2048                                            
2049  </p>  </p>
2050  <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
2051                      <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>
2052                      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>
2053                      command, &lt;chan&gt; the audio channel number                      command, &lt;chan&gt; the audio channel number
2054                      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
2055                      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).
2056  </p>  </p>
2057  <p>Possible Answers:  <p>Possible Answers:
2058  </p>  </p>
# Line 2081  Intellectual Property and Copyright Stat Line 2180  Intellectual Property and Copyright Stat
2180                                            
2181  </p>  </p>
2182  <a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"></a><br /><hr />  <a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"></a><br /><hr />
2183  <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>
2184  <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;
2185    Changing settings of audio output channels</h3>
2186    
2187  <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:
2188  </p>  </p>
# Line 2095  Intellectual Property and Copyright Stat Line 2195  Intellectual Property and Copyright Stat
2195                                            
2196  </p>  </p>
2197  <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
2198                      <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>
2199                      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>
2200                      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
2201                      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.
2202  </p>  </p>
# Line 2158  Intellectual Property and Copyright Stat Line 2258  Intellectual Property and Copyright Stat
2258                                            
2259  </p>  </p>
2260  <a name="anchor10"></a><br /><hr />  <a name="anchor10"></a><br /><hr />
2261  <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>
2262  <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;
2263    Configuring MIDI input drivers</h3>
2264    
2265  <p>Instances of drivers in LinuxSampler are called devices. You can use  <p>Instances of drivers in LinuxSampler are called devices. You can use
2266                  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 2188  Intellectual Property and Copyright Stat Line 2289  Intellectual Property and Copyright Stat
2289                  possible values, etc.                  possible values, etc.
2290  </p>  </p>
2291  <a name="GET AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />  <a name="GET AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />
2292  <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>
2293  <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;
2294    Getting amount of available MIDI input drivers</h3>
2295    
2296  <p>Use the following command to get the number of  <p>Use the following command to get the number of
2297                      MIDI input drivers currently available for the                      MIDI input drivers currently available for the
# Line 2227  Intellectual Property and Copyright Stat Line 2329  Intellectual Property and Copyright Stat
2329                                            
2330  </p>  </p>
2331  <a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />  <a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />
2332  <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>
2333  <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;
2334    Getting all available MIDI input drivers</h3>
2335    
2336  <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
2337                      for the LinuxSampler instance:                      for the LinuxSampler instance:
# Line 2265  Intellectual Property and Copyright Stat Line 2368  Intellectual Property and Copyright Stat
2368                                            
2369  </p>  </p>
2370  <a name="GET MIDI_INPUT_DRIVER INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_DRIVER INFO"></a><br /><hr />
2371  <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>
2372  <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;
2373    Getting information about a specific MIDI input driver</h3>
2374    
2375  <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:
2376  </p>  </p>
# Line 2279  Intellectual Property and Copyright Stat Line 2383  Intellectual Property and Copyright Stat
2383                                            
2384  </p>  </p>
2385  <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
2386                      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.
2387  </p>  </p>
2388  <p>Possible Answers:  <p>Possible Answers:
2389  </p>  </p>
# Line 2346  Intellectual Property and Copyright Stat Line 2450  Intellectual Property and Copyright Stat
2450                                            
2451  </p>  </p>
2452  <a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO"></a><br /><hr />
2453  <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>
2454  <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;
2455    Getting information about specific MIDI input driver parameter</h3>
2456    
2457  <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:
2458  </p>  </p>
# Line 2360  Intellectual Property and Copyright Stat Line 2465  Intellectual Property and Copyright Stat
2465                                            
2466  </p>  </p>
2467  <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
2468                      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
2469                      parameter name for which information should be obtained (as returned by the                      parameter name for which information should be obtained (as returned by the
2470                      <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
2471                      of parameters on which the sought parameter &lt;param&gt; depends on,                      of parameters on which the sought parameter &lt;param&gt; depends on,
2472                      &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 ...",
2473                      where character string values are encapsulated into apostrophes ('). Arguments                      where character string values are encapsulated into apostrophes ('). Arguments
# Line 2409  Intellectual Property and Copyright Stat Line 2514  Intellectual Property and Copyright Stat
2514  <blockquote class="text">  <blockquote class="text">
2515  <p>either true or false, defines if this parameter must be  <p>either true or false, defines if this parameter must be
2516                                  given when the device is to be created with the                                  given when the device is to be created with the
2517                                  <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
2518                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2519  </p>  </p>
2520  </blockquote>  </blockquote>
# Line 2420  Intellectual Property and Copyright Stat Line 2525  Intellectual Property and Copyright Stat
2525  <blockquote class="text">  <blockquote class="text">
2526  <p>either true or false, if false then this parameter can  <p>either true or false, if false then this parameter can
2527                                  be changed at any time, once the device is created by                                  be changed at any time, once the device is created by
2528                                  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
2529                                  (always returned, no matter which driver parameter)                                  (always returned, no matter which driver parameter)
2530  </p>  </p>
2531  </blockquote>  </blockquote>
# Line 2459  Intellectual Property and Copyright Stat Line 2564  Intellectual Property and Copyright Stat
2564  <blockquote class="text">  <blockquote class="text">
2565  <p>reflects the default value for this parameter which is  <p>reflects the default value for this parameter which is
2566                                  used when the device is created and not explicitly                                  used when the device is created and not explicitly
2567                                  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,
2568                                  in case of MULTIPLCITY=true, this is a comma separated                                  in case of MULTIPLCITY=true, this is a comma separated
2569                                  list, that's why character strings are encapsulated into                                  list, that's why character strings are encapsulated into
2570                                  apostrophes (')                                  apostrophes (')
# Line 2533  Intellectual Property and Copyright Stat Line 2638  Intellectual Property and Copyright Stat
2638                                            
2639  </p>  </p>
2640  <a name="CREATE MIDI_INPUT_DEVICE"></a><br /><hr />  <a name="CREATE MIDI_INPUT_DEVICE"></a><br /><hr />
2641  <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>
2642  <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;
2643    Creating a MIDI input device</h3>
2644    
2645  <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:
2646  </p>  </p>
# Line 2547  Intellectual Property and Copyright Stat Line 2653  Intellectual Property and Copyright Stat
2653                                            
2654  </p>  </p>
2655  <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
2656                      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
2657                      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
2658                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
2659                      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 2603  Intellectual Property and Copyright Stat Line 2709  Intellectual Property and Copyright Stat
2709                                            
2710  </p>  </p>
2711  <a name="DESTROY MIDI_INPUT_DEVICE"></a><br /><hr />  <a name="DESTROY MIDI_INPUT_DEVICE"></a><br /><hr />
2712  <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>
2713  <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;
2714    Destroying a MIDI input device</h3>
2715    
2716  <p>Use the following command to destroy a created MIDI input device:  <p>Use the following command to destroy a created MIDI input device:
2717  </p>  </p>
# Line 2617  Intellectual Property and Copyright Stat Line 2724  Intellectual Property and Copyright Stat
2724                                            
2725  </p>  </p>
2726  <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
2727                      <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>
2728                      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>
2729                      command.                      command.
2730  </p>  </p>
2731  <p>Possible Answers:  <p>Possible Answers:
# Line 2668  Intellectual Property and Copyright Stat Line 2775  Intellectual Property and Copyright Stat
2775                                            
2776  </p>  </p>
2777  <a name="GET MIDI_INPUT_DEVICES"></a><br /><hr />  <a name="GET MIDI_INPUT_DEVICES"></a><br /><hr />
2778  <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>
2779  <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;
2780    Getting all created MIDI input device count</h3>
2781    
2782  <p>Use the following command to count all created MIDI input devices:  <p>Use the following command to count all created MIDI input devices:
2783  </p>  </p>
# Line 2705  Intellectual Property and Copyright Stat Line 2813  Intellectual Property and Copyright Stat
2813                                            
2814  </p>  </p>
2815  <a name="LIST MIDI_INPUT_DEVICES"></a><br /><hr />  <a name="LIST MIDI_INPUT_DEVICES"></a><br /><hr />
2816  <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>
2817  <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;
2818    Getting all created MIDI input device list</h3>
2819    
2820  <p>Use the following command to list all created MIDI input devices:  <p>Use the following command to list all created MIDI input devices:
2821  </p>  </p>
# Line 2752  Intellectual Property and Copyright Stat Line 2861  Intellectual Property and Copyright Stat
2861                                            
2862  </p>  </p>
2863  <a name="GET MIDI_INPUT_DEVICE INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_DEVICE INFO"></a><br /><hr />
2864  <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>
2865  <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;
2866    Getting current settings of a MIDI input device</h3>
2867    
2868  <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:
2869  </p>  </p>
# Line 2766  Intellectual Property and Copyright Stat Line 2876  Intellectual Property and Copyright Stat
2876                                            
2877  </p>  </p>
2878  <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
2879                      <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>
2880                      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>
2881                      command.                      command.
2882  </p>  </p>
2883  <p>Possible Answers:  <p>Possible Answers:
# Line 2790  Intellectual Property and Copyright Stat Line 2900  Intellectual Property and Copyright Stat
2900                                          </p>                                          </p>
2901  <blockquote class="text">  <blockquote class="text">
2902  <p>identifier of the used MIDI input driver, as e.g.  <p>identifier of the used MIDI input driver, as e.g.
2903                                              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>
2904                                              command                                              command
2905  </p>  </p>
2906  </blockquote>  </blockquote>
# Line 2820  Intellectual Property and Copyright Stat Line 2930  Intellectual Property and Copyright Stat
2930                      order. The fields above are only those fields which are                      order. The fields above are only those fields which are
2931                      returned by all MIDI input devices. Every MIDI input driver                      returned by all MIDI input devices. Every MIDI input driver
2932                      might have its own, additional driver specific parameters (see                      might have its own, additional driver specific parameters (see
2933                      <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
2934                      by this command.                      by this command.
2935  </p>  </p>
2936  <p>Example:  <p>Example:
# Line 2840  Intellectual Property and Copyright Stat Line 2950  Intellectual Property and Copyright Stat
2950                                            
2951  </p>  </p>
2952  <a name="SET MIDI_INPUT_DEVICE_PARAMETER"></a><br /><hr />  <a name="SET MIDI_INPUT_DEVICE_PARAMETER"></a><br /><hr />
2953  <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>
2954  <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;
2955    Changing settings of MIDI input devices</h3>
2956    
2957  <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:
2958  </p>  </p>
# Line 2855  Intellectual Property and Copyright Stat Line 2966  Intellectual Property and Copyright Stat
2966  </p>  </p>
2967  <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
2968                      MIDI input device as returned by the                      MIDI input device as returned by the
2969                      <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>
2970                      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>
2971                      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
2972                      &lt;value&gt; by the new value for this parameter.                      &lt;value&gt; by the new value for this parameter.
2973  </p>  </p>
# Line 2907  Intellectual Property and Copyright Stat Line 3018  Intellectual Property and Copyright Stat
3018                                            
3019  </p>  </p>
3020  <a name="GET MIDI_INPUT_PORT INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_PORT INFO"></a><br /><hr />
3021  <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>
3022  <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;
3023    Getting information about a MIDI port</h3>
3024    
3025  <p>Use the following command to get information about a MIDI port:  <p>Use the following command to get information about a MIDI port:
3026  </p>  </p>
# Line 2921  Intellectual Property and Copyright Stat Line 3033  Intellectual Property and Copyright Stat
3033                                            
3034  </p>  </p>
3035  <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
3036                      <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>
3037                      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>
3038                      command and &lt;midi-port&gt; the MIDI input port number.                      command and &lt;midi-port&gt; the MIDI input port number.
3039  </p>  </p>
3040  <p>Possible Answers:  <p>Possible Answers:
# Line 2969  Intellectual Property and Copyright Stat Line 3081  Intellectual Property and Copyright Stat
3081                                            
3082  </p>  </p>
3083  <a name="GET MIDI_INPUT_PORT_PARAMETER INFO"></a><br /><hr />  <a name="GET MIDI_INPUT_PORT_PARAMETER INFO"></a><br /><hr />
3084  <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>
3085  <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;
3086    Getting information about specific MIDI port parameter</h3>
3087    
3088  <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:
3089  </p>  </p>
# Line 2983  Intellectual Property and Copyright Stat Line 3096  Intellectual Property and Copyright Stat
3096                                            
3097  </p>  </p>
3098  <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
3099                      <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>
3100                      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>
3101                      command, &lt;port&gt; the MIDI port number and                      command, &lt;port&gt; the MIDI port number and
3102                      &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
3103                      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).
3104  </p>  </p>
3105  <p>Possible Answers:  <p>Possible Answers:
3106  </p>  </p>
# Line 3110  Intellectual Property and Copyright Stat Line 3223  Intellectual Property and Copyright Stat
3223                                            
3224  </p>  </p>
3225  <a name="SET MIDI_INPUT_PORT_PARAMETER"></a><br /><hr />  <a name="SET MIDI_INPUT_PORT_PARAMETER"></a><br /><hr />
3226  <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>
3227  <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;
3228    Changing settings of MIDI input ports</h3>
3229    
3230  <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:
3231  </p>  </p>
# Line 3125  Intellectual Property and Copyright Stat Line 3239  Intellectual Property and Copyright Stat
3239  </p>  </p>
3240  <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
3241                      MIDI device as returned by the                      MIDI device as returned by the
3242                      <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>
3243                      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>
3244                      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
3245                      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
3246                      parameter.                      parameter.
# Line 3176  Intellectual Property and Copyright Stat Line 3290  Intellectual Property and Copyright Stat
3290                                            
3291  </p>  </p>
3292  <a name="anchor11"></a><br /><hr />  <a name="anchor11"></a><br /><hr />
3293  <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>
3294  <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;
3295    Configuring sampler channels</h3>
3296    
3297  <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
3298                  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
3299                  MIDI and audio devices.                  MIDI and audio devices.
3300  </p>  </p>
3301  <a name="LOAD INSTRUMENT"></a><br /><hr />  <a name="LOAD INSTRUMENT"></a><br /><hr />
3302  <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>
3303  <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;
3304    Loading an instrument</h3>
3305    
3306  <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:
3307  </p>  </p>
# Line 3207  Intellectual Property and Copyright Stat Line 3323  Intellectual Property and Copyright Stat
3323                      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
3324                      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
3325                      returns immediately and a background process is launched to load the instrument                      returns immediately and a background process is launched to load the instrument
3326                      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>
3327                      command can be used to obtain loading                      command can be used to obtain loading
3328                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks                      progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks
3329                      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 3261  Intellectual Property and Copyright Stat Line 3377  Intellectual Property and Copyright Stat
3377                                            
3378  </p>  </p>
3379  <a name="LOAD ENGINE"></a><br /><hr />  <a name="LOAD ENGINE"></a><br /><hr />
3380  <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>
3381  <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;
3382    Loading a sampler engine</h3>
3383    
3384  <p>A sampler engine type can be associated to a specific sampler  <p>A sampler engine type can be associated to a specific sampler
3385                      channel by the following command:                      channel by the following command:
# Line 3276  Intellectual Property and Copyright Stat Line 3393  Intellectual Property and Copyright Stat
3393                                            
3394  </p>  </p>
3395  <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
3396                      <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;
3397                      the sampler channel as returned by the                      the sampler channel as returned by the
3398                      <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
3399                      <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
3400                      the engine type should be assigned to. This command should be issued                      the engine type should be assigned to. This command should be issued
3401                      after adding a new sampler channel and before any other control                      after adding a new sampler channel and before any other control
3402                      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 3335  Intellectual Property and Copyright Stat Line 3452  Intellectual Property and Copyright Stat
3452                                            
3453  </p>  </p>
3454  <a name="GET CHANNELS"></a><br /><hr />  <a name="GET CHANNELS"></a><br /><hr />
3455  <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>
3456  <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;
3457    Getting all created sampler channel count</h3>
3458    
3459  <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
3460                      current amount of sampler channels, the front-end can send the                      current amount of sampler channels, the front-end can send the
# Line 3373  Intellectual Property and Copyright Stat Line 3491  Intellectual Property and Copyright Stat
3491                                            
3492  </p>  </p>
3493  <a name="LIST CHANNELS"></a><br /><hr />  <a name="LIST CHANNELS"></a><br /><hr />
3494  <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>
3495  <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;
3496    Getting all created sampler channel list</h3>
3497    
3498  <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
3499                      current list of sampler channels, the front-end can send the                      current list of sampler channels, the front-end can send the
# Line 3412  Intellectual Property and Copyright Stat Line 3531  Intellectual Property and Copyright Stat
3531                                            
3532  </p>  </p>
3533  <a name="ADD CHANNEL"></a><br /><hr />  <a name="ADD CHANNEL"></a><br /><hr />
3534  <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>
3535  <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;
3536    Adding a new sampler channel</h3>
3537    
3538  <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
3539                      channel list by sending the following command:                      channel list by sending the following command:
# Line 3486  Intellectual Property and Copyright Stat Line 3606  Intellectual Property and Copyright Stat
3606                                            
3607  </p>  </p>
3608  <a name="REMOVE CHANNEL"></a><br /><hr />  <a name="REMOVE CHANNEL"></a><br /><hr />
3609  <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>
3610  <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;
3611    Removing a sampler channel</h3>
3612    
3613  <p>A sampler channel can be removed by sending the following command:  <p>A sampler channel can be removed by sending the following command:
3614  </p>  </p>
# Line 3501  Intellectual Property and Copyright Stat Line 3622  Intellectual Property and Copyright Stat
3622  </p>  </p>
3623  <p>Where &lt;sampler-channel&gt; should be replaced by the  <p>Where &lt;sampler-channel&gt; should be replaced by the
3624                      number of the sampler channel as given by the                      number of the sampler channel as given by the
3625                      <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>
3626                      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>
3627                      command. The channel numbers of all subsequent sampler channels                      command. The channel numbers of all subsequent sampler channels
3628                      remain the same.                      remain the same.
3629  </p>  </p>
# Line 3552  Intellectual Property and Copyright Stat Line 3673  Intellectual Property and Copyright Stat
3673                                            
3674  </p>  </p>
3675  <a name="GET AVAILABLE_ENGINES"></a><br /><hr />  <a name="GET AVAILABLE_ENGINES"></a><br /><hr />
3676  <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>
3677  <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;
3678    Getting amount of available engines</h3>
3679    
3680  <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:
3681  </p>  </p>
# Line 3588  Intellectual Property and Copyright Stat Line 3710  Intellectual Property and Copyright Stat
3710                                            
3711  </p>  </p>
3712  <a name="LIST AVAILABLE_ENGINES"></a><br /><hr />  <a name="LIST AVAILABLE_ENGINES"></a><br /><hr />
3713  <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>
3714  <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;
3715    Getting all available engines</h3>
3716    
3717  <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:
3718  </p>  </p>
# Line 3627  Intellectual Property and Copyright Stat Line 3750  Intellectual Property and Copyright Stat
3750                                            
3751  </p>  </p>
3752  <a name="GET ENGINE INFO"></a><br /><hr />  <a name="GET ENGINE INFO"></a><br /><hr />
3753  <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>
3754  <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;
3755    Getting information about an engine</h3>
3756    
3757  <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
3758                      sending the following command:                      sending the following command:
# Line 3642  Intellectual Property and Copyright Stat Line 3766  Intellectual Property and Copyright Stat
3766                                            
3767  </p>  </p>
3768  <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
3769                      <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.
3770  </p>  </p>
3771  <p>Possible Answers:  <p>Possible Answers:
3772  </p>  </p>
# Line 3699  Intellectual Property and Copyright Stat Line 3823  Intellectual Property and Copyright Stat
3823                                            
3824  </p>  </p>
3825  <a name="GET CHANNEL INFO"></a><br /><hr />  <a name="GET CHANNEL INFO"></a><br /><hr />
3826  <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>
3827  <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;
3828    Getting sampler channel information</h3>
3829    
3830  <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
3831                      by sending the following command:                      by sending the following command:
# Line 3714  Intellectual Property and Copyright Stat Line 3839  Intellectual Property and Copyright Stat
3839                                            
3840  </p>  </p>
3841  <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
3842                      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>
3843                      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.
3844  </p>  </p>
3845  <p>Possible Answers:  <p>Possible Answers:
3846  </p>  </p>
# Line 3843  Intellectual Property and Copyright Stat Line 3968  Intellectual Property and Copyright Stat
3968                                          </p>                                          </p>
3969  <blockquote class="text">  <blockquote class="text">
3970  <p>optionally dotted number for the channel volume factor  <p>optionally dotted number for the channel volume factor
3971                                              (where a value < 1.0 means attenuation and a value >                                              (where a value &lt; 1.0 means attenuation and a value >
3972                                              1.0 means amplification)                                              1.0 means amplification)
3973  </p>  </p>
3974  </blockquote>  </blockquote>
# Line 3870  Intellectual Property and Copyright Stat Line 3995  Intellectual Property and Copyright Stat
3995  </blockquote>  </blockquote>
3996                                                                            
3997    
3998    <p>MIDI_INSTRUMENT_MAP -
3999                                            </p>
4000    <blockquote class="text">
4001    <p>Determines to which MIDI instrument map this sampler
4002                                                channel is assigned to. Read chapter
4003                                                <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>
4004                                                for a list of possible values.
4005    </p>
4006    </blockquote>
4007                                        
4008    
4009  </blockquote>  </blockquote>
4010                                                            
4011    
# Line 3909  Intellectual Property and Copyright Stat Line 4045  Intellectual Property and Copyright Stat
4045  </p>  </p>
4046  <p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"  <p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"
4047  </p>  </p>
4048    <p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
4049    </p>
4050    <p>&nbsp;&nbsp;&nbsp;"MUTE: false"
4051    </p>
4052    <p>&nbsp;&nbsp;&nbsp;"SOLO: false"
4053    </p>
4054    <p>&nbsp;&nbsp;&nbsp;"MIDI_INSTRUMENT_MAP: NONE"
4055    </p>
4056  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
4057  </p>  </p>
4058  </blockquote><p>  </blockquote><p>
4059                                            
4060  </p>  </p>
4061  <a name="GET CHANNEL VOICE_COUNT"></a><br /><hr />  <a name="GET CHANNEL VOICE_COUNT"></a><br /><hr />
4062  <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>
4063  <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;
4064    Current number of active voices</h3>
4065    
4066  <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
4067                      sampler channel by sending the following command:                      sampler channel by sending the following command:
# Line 3930  Intellectual Property and Copyright Stat Line 4075  Intellectual Property and Copyright Stat
4075                                            
4076  </p>  </p>
4077  <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
4078                      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>
4079                      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.
4080  </p>  </p>
4081  <p>Possible Answers:  <p>Possible Answers:
4082  </p>  </p>
# Line 3955  Intellectual Property and Copyright Stat Line 4100  Intellectual Property and Copyright Stat
4100                                            
4101  </p>  </p>
4102  <a name="GET CHANNEL STREAM_COUNT"></a><br /><hr />  <a name="GET CHANNEL STREAM_COUNT"></a><br /><hr />
4103  <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>
4104  <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;
4105    Current number of active disk streams</h3>
4106    
4107  <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
4108                      on a sampler channel by sending the following command:                      on a sampler channel by sending the following command:
# Line 3970  Intellectual Property and Copyright Stat Line 4116  Intellectual Property and Copyright Stat
4116                                            
4117  </p>  </p>
4118  <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
4119                      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>
4120                      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.
4121  </p>  </p>
4122  <p>Possible Answers:  <p>Possible Answers:
4123  </p>  </p>
# Line 3997  Intellectual Property and Copyright Stat Line 4143  Intellectual Property and Copyright Stat
4143                                            
4144  </p>  </p>
4145  <a name="GET CHANNEL BUFFER_FILL"></a><br /><hr />  <a name="GET CHANNEL BUFFER_FILL"></a><br /><hr />
4146  <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>
4147  <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;
4148    Current fill state of disk stream buffers</h3>
4149    
4150  <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
4151                      on a sampler channel by sending the following command:                      on a sampler channel by sending the following command:
# Line 4023  Intellectual Property and Copyright Stat Line 4170  Intellectual Property and Copyright Stat
4170  </p>  </p>
4171  <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
4172                      sampler channel number the front-end is interested in                      sampler channel number the front-end is interested in
4173                      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>
4174                      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.
4175  </p>  </p>
4176  <p>Possible Answers:  <p>Possible Answers:
4177  </p>  </p>
# Line 4074  Intellectual Property and Copyright Stat Line 4221  Intellectual Property and Copyright Stat
4221                                            
4222  </p>  </p>
4223  <a name="SET CHANNEL AUDIO_OUTPUT_DEVICE"></a><br /><hr />  <a name="SET CHANNEL AUDIO_OUTPUT_DEVICE"></a><br /><hr />
4224  <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>
4225  <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;
4226    Setting audio output device</h3>
4227    
4228  <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
4229                      channel by sending the following command:                      channel by sending the following command:
# Line 4089  Intellectual Property and Copyright Stat Line 4237  Intellectual Property and Copyright Stat
4237                                            
4238  </p>  </p>
4239  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4240                      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>
4241                      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
4242                      &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
4243                      <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>
4244                      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>
4245                      command.                      command.
4246  </p>  </p>
4247  <p>Possible Answers:  <p>Possible Answers:
# Line 4140  Intellectual Property and Copyright Stat Line 4288  Intellectual Property and Copyright Stat
4288  </blockquote><p>  </blockquote><p>
4289                                            
4290  </p>  </p>
4291  <a name="SET CHANNEL AUDIO_OUTPUT_TYP"></a><br /><hr />  <a name="SET CHANNEL AUDIO_OUTPUT_TYPE"></a><br /><hr />
4292  <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>
4293  <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;
4294    Setting audio output type</h3>
4295    
4296  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
4297  </p>  </p>
# Line 4205  Intellectual Property and Copyright Stat Line 4354  Intellectual Property and Copyright Stat
4354                                            
4355  </p>  </p>
4356  <a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr />  <a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
4357  <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>
4358  <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;
4359    Setting audio output channel</h3>
4360    
4361  <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
4362                      sampler channel by sending the following command:                      sampler channel by sending the following command:
# Line 4220  Intellectual Property and Copyright Stat Line 4370  Intellectual Property and Copyright Stat
4370                                            
4371  </p>  </p>
4372  <p>Where &lt;sampler-chan&gt; is the sampler channel number  <p>Where &lt;sampler-chan&gt; is the sampler channel number
4373                      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>
4374                      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
4375                      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
4376                      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
4377                      output device where &lt;audio-out&gt; should be routed to.                      output device where &lt;audio-out&gt; should be routed to.
# Line 4271  Intellectual Property and Copyright Stat Line 4421  Intellectual Property and Copyright Stat
4421                                            
4422  </p>  </p>
4423  <a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr />
4424  <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>
4425  <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;
4426    Setting MIDI input device</h3>
4427    
4428  <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
4429                      channel by sending the following command:                      channel by sending the following command:
# Line 4286  Intellectual Property and Copyright Stat Line 4437  Intellectual Property and Copyright Stat
4437                                            
4438  </p>  </p>
4439  <p>Where &lt;sampler-channel&gt; is the sampler channel number  <p>Where &lt;sampler-channel&gt; is the sampler channel number
4440                      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>
4441                      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
4442                      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
4443                      <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>
4444                      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.
4445  </p>  </p>
4446  <p>Possible Answers:  <p>Possible Answers:
4447  </p>  </p>
# Line 4337  Intellectual Property and Copyright Stat Line 4488  Intellectual Property and Copyright Stat
4488                                            
4489  </p>  </p>
4490  <a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr />
4491  <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>
4492  <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;
4493    Setting MIDI input type</h3>
4494    
4495  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  <p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
4496  </p>  </p>
# Line 4401  Intellectual Property and Copyright Stat Line 4553  Intellectual Property and Copyright Stat
4553                                            
4554  </p>  </p>
4555  <a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr />
4556  <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>
4557  <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;
4558    Setting MIDI input port</h3>
4559    
4560  <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
4561                      channel by sending the following command:                      channel by sending the following command:
# Line 4464  Intellectual Property and Copyright Stat Line 4617  Intellectual Property and Copyright Stat
4617                                            
4618  </p>  </p>
4619  <a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr />  <a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr />
4620  <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>
4621  <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;
4622    Setting MIDI input channel</h3>
4623    
4624  <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
4625                      listen to by sending the following command:                      listen to by sending the following command:
# Line 4527  Intellectual Property and Copyright Stat Line 4681  Intellectual Property and Copyright Stat
4681                                            
4682  </p>  </p>
4683  <a name="SET CHANNEL VOLUME"></a><br /><hr />  <a name="SET CHANNEL VOLUME"></a><br /><hr />
4684  <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>
4685  <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;
4686    Setting channel volume</h3>
4687    
4688  <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
4689                      the following command:                      the following command:
# Line 4591  Intellectual Property and Copyright Stat Line 4746  Intellectual Property and Copyright Stat
4746                                            
4747  </p>  </p>
4748  <a name="SET CHANNEL MUTE"></a><br /><hr />  <a name="SET CHANNEL MUTE"></a><br /><hr />
4749  <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>
4750  <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;
4751    Muting a sampler channel</h3>
4752    
4753  <p>The front-end can mute/unmute a specific sampler  <p>The front-end can mute/unmute a specific sampler
4754                      channel by sending the following command:                      channel by sending the following command:
# Line 4606  Intellectual Property and Copyright Stat Line 4762  Intellectual Property and Copyright Stat
4762                                            
4763  </p>  </p>
4764  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4765                      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>
4766                      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
4767                      &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"
4768                      to unmute the channel.                      to unmute the channel.
4769  </p>  </p>
# Line 4656  Intellectual Property and Copyright Stat Line 4812  Intellectual Property and Copyright Stat
4812                                            
4813  </p>  </p>
4814  <a name="SET CHANNEL SOLO"></a><br /><hr />  <a name="SET CHANNEL SOLO"></a><br /><hr />
4815  <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>
4816  <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;
4817    Soloing a sampler channel</h3>
4818    
4819  <p>The front-end can solo/unsolo a specific sampler channel  <p>The front-end can solo/unsolo a specific sampler channel
4820                      by sending the following command:                      by sending the following command:
# Line 4671  Intellectual Property and Copyright Stat Line 4828  Intellectual Property and Copyright Stat
4828                                            
4829  </p>  </p>
4830  <p>Where &lt;sampler-channel&gt; is the respective sampler channel  <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4831                      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>
4832                      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
4833                      &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"
4834                      to unsolo the channel.                      to unsolo the channel.
4835  </p>  </p>
# Line 4720  Intellectual Property and Copyright Stat Line 4877  Intellectual Property and Copyright Stat
4877  </blockquote><p>  </blockquote><p>
4878                                            
4879  </p>  </p>
4880    <a name="SET CHANNEL MIDI_INSTRUMENT_MAP"></a><br /><hr />
4881    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4882    <a name="rfc.section.6.4.24"></a><h3>6.4.24.&nbsp;
4883    Assigning a MIDI instrument map to a sampler channel</h3>
4884    
4885    <p>The front-end can assign a MIDI instrument map to a specific sampler channel
4886                        by sending the following command:
4887    </p>
4888    <p>
4889                            </p>
4890    <blockquote class="text">
4891    <p>SET CHANNEL MIDI_INSTRUMENT_MAP &lt;sampler-channel&gt; &lt;map&gt;
4892    </p>
4893    </blockquote><p>
4894                        
4895    </p>
4896    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4897                        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>
4898                        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
4899                        &lt;map&gt; can have the following possibilites:
4900    </p>
4901    <p>
4902                            </p>
4903    <blockquote class="text">
4904    <p>"NONE" -
4905                                    </p>
4906    <blockquote class="text">
4907    <p>This is the default setting. In this case
4908                                        the sampler channel is not assigned any MIDI
4909                                        instrument map and thus will ignore all MIDI
4910                                        program change messages.
4911    </p>
4912    </blockquote>
4913                                
4914    
4915    <p>"DEFAULT" -
4916                                    </p>
4917    <blockquote class="text">
4918    <p>The sampler channel will always use the
4919                                        default MIDI instrument map to handle MIDI
4920                                        program change messages.
4921    </p>
4922    </blockquote>
4923                                
4924    
4925    <p>numeric ID -
4926                                    </p>
4927    <blockquote class="text">
4928    <p>You can assign a specific MIDI instrument map
4929                                        by replacing &lt;map&gt; with the respective numeric
4930                                        ID of the MIDI instrument map as returned by the
4931                                        <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>
4932                                        command. Once that map will be deleted, the sampler
4933                                        channel would fall back to "NONE".
4934    </p>
4935    </blockquote>
4936                                
4937    
4938    </blockquote><p>
4939                        
4940    </p>
4941    <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>
4942                        for details regarding MIDI instrument mapping.
4943    </p>
4944    <p>Possible Answers:
4945    </p>
4946    <p>
4947                            </p>
4948    <blockquote class="text">
4949    <p>"OK" -
4950                                    </p>
4951    <blockquote class="text">
4952    <p>on success
4953    </p>
4954    </blockquote>
4955                                
4956    
4957    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4958                                    </p>
4959    <blockquote class="text">
4960    <p>in case it failed, providing an appropriate error code and error message
4961    </p>
4962    </blockquote>
4963                                
4964    
4965    </blockquote><p>
4966                        
4967    </p>
4968    <p>Examples:
4969    </p>
4970    <p>
4971                            </p>
4972    <blockquote class="text">
4973    <p>
4974    </p>
4975    </blockquote><p>
4976                        
4977    </p>
4978    <a name="CREATE FX_SEND"></a><br /><hr />
4979    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
4980    <a name="rfc.section.6.4.25"></a><h3>6.4.25.&nbsp;
4981    Adding an effect send to a sampler channel</h3>
4982    
4983    <p>The front-end can create an additional effect send on a specific sampler channel
4984                        by sending the following command:
4985    </p>
4986    <p>
4987                            </p>
4988    <blockquote class="text">
4989    <p>CREATE FX_SEND &lt;sampler-channel&gt; &lt;midi-ctrl&gt; [&lt;name&gt;]
4990    </p>
4991    </blockquote><p>
4992                        
4993    </p>
4994    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
4995                        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>
4996                        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
4997                        sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
4998                        is a number between 0..127 defining the MIDI controller which can alter the
4999                        effect send level and &lt;name&gt; is an optional argument defining a name
5000                        for the effect send entity. The name does not have to be unique.
5001    </p>
5002    <p>By default, that is as initial routing, the effect send's audio channels
5003                        are automatically routed to the last audio channels of the sampler channel's
5004                        audio output device, that way you can i.e. first increase the amount of audio
5005                        channels on the audio output device for having dedicated effect send output
5006                        channels and when "CREATE FX_SEND" is called, those channels will automatically
5007                        be picked. You can alter the destination channels however with
5008                        <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>.
5009                        
5010    </p>
5011    <p>Note: Create effect sends on a sampler channel only when needed, because having effect
5012                        sends on a sampler channel will decrease runtime performance, because for implementing channel
5013                        effect sends, separate (sampler channel local) audio buffers are needed to render and mix
5014                        the voices and route the audio signal afterwards to the master outputs and effect send
5015                        outputs (along with their respective effect send levels). A sampler channel without effect
5016                        sends however can mix its voices directly into the audio output devices's audio buffers
5017                        and is thus faster.
5018                        
5019    </p>
5020    <p>Possible Answers:
5021    </p>
5022    <p>
5023                            </p>
5024    <blockquote class="text">
5025    <p>"OK[&lt;fx-send-id&gt;]" -
5026                                    </p>
5027    <blockquote class="text">
5028    <p>in case a new effect send could be added to the
5029                                        sampler channel, where &lt;fx-send-id&gt; reflects the
5030                                        unique ID of the newly created effect send entity
5031    </p>
5032    </blockquote>
5033                                
5034    
5035    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5036                                    </p>
5037    <blockquote class="text">
5038    <p>when a new effect send could not be added, i.e.
5039                                        due to invalid parameters
5040    </p>
5041    </blockquote>
5042                                
5043    
5044    </blockquote><p>
5045                        
5046    </p>
5047    <p>Examples:
5048    </p>
5049    <p>
5050                            </p>
5051    <blockquote class="text">
5052    <p>C: "CREATE FX_SEND 0 91 'Reverb Send'"
5053    </p>
5054    <p>S: "OK[0]"
5055    </p>
5056    </blockquote><p>
5057                        
5058    </p>
5059    <p>
5060                            </p>
5061    <blockquote class="text">
5062    <p>C: "CREATE FX_SEND 0 93"
5063    </p>
5064    <p>S: "OK[1]"
5065    </p>
5066    </blockquote><p>
5067                        
5068    </p>
5069    <a name="DESTROY FX_SEND"></a><br /><hr />
5070    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5071    <a name="rfc.section.6.4.26"></a><h3>6.4.26.&nbsp;
5072    Removing an effect send from a sampler channel</h3>
5073    
5074    <p>The front-end can remove an existing effect send on a specific sampler channel
5075                        by sending the following command:
5076    </p>
5077    <p>
5078                            </p>
5079    <blockquote class="text">
5080    <p>DESTROY FX_SEND &lt;sampler-channel&gt; &lt;fx-send-id&gt;
5081    </p>
5082    </blockquote><p>
5083                        
5084    </p>
5085    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5086                        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>
5087                        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
5088                        sampler channel from which the effect send should be removed from and
5089                        &lt;fx-send-id&gt; is the respective effect send number as returned by the
5090                        <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>
5091                        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.
5092    </p>
5093    <p>Possible Answers:
5094    </p>
5095    <p>
5096                            </p>
5097    <blockquote class="text">
5098    <p>"OK" -
5099                                    </p>
5100    <blockquote class="text">
5101    <p>on success
5102    </p>
5103    </blockquote>
5104                                
5105    
5106    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5107                                    </p>
5108    <blockquote class="text">
5109    <p>in case it failed, providing an appropriate error code and
5110                                        error message
5111    </p>
5112    </blockquote>
5113                                
5114    
5115    </blockquote><p>
5116                        
5117    </p>
5118    <p>Example:
5119    </p>
5120    <p>
5121                            </p>
5122    <blockquote class="text">
5123    <p>C: "DESTROY FX_SEND 0 0"
5124    </p>
5125    <p>S: "OK"
5126    </p>
5127    </blockquote><p>
5128                        
5129    </p>
5130    <a name="GET FX_SENDS"></a><br /><hr />
5131    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5132    <a name="rfc.section.6.4.27"></a><h3>6.4.27.&nbsp;
5133    Getting amount of effect sends on a sampler channel</h3>
5134    
5135    <p>The front-end can ask for the amount of effect sends on a specific sampler channel
5136                        by sending the following command:
5137    </p>
5138    <p>
5139                            </p>
5140    <blockquote class="text">
5141    <p>GET FX_SENDS &lt;sampler-channel&gt;
5142    </p>
5143    </blockquote><p>
5144                        
5145    </p>
5146    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5147                        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>
5148                        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.
5149    </p>
5150    <p>Possible Answers:
5151    </p>
5152    <p>
5153                            </p>
5154    <blockquote class="text">
5155    <p>The sampler will answer by returning the number of effect
5156                                sends on the given sampler channel.
5157    </p>
5158    </blockquote><p>
5159                        
5160    </p>
5161    <p>Example:
5162    </p>
5163    <p>
5164                            </p>
5165    <blockquote class="text">
5166    <p>C: "GET FX_SENDS 0"
5167    </p>
5168    <p>S: "2"
5169    </p>
5170    </blockquote><p>
5171                        
5172    </p>
5173    <a name="LIST FX_SENDS"></a><br /><hr />
5174    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5175    <a name="rfc.section.6.4.28"></a><h3>6.4.28.&nbsp;
5176    Listing all effect sends on a sampler channel</h3>
5177    
5178    <p>The front-end can ask for a list of effect sends on a specific sampler channel
5179                        by sending the following command:
5180    </p>
5181    <p>
5182                            </p>
5183    <blockquote class="text">
5184    <p>LIST FX_SENDS &lt;sampler-channel&gt;
5185    </p>
5186    </blockquote><p>
5187                        
5188    </p>
5189    <p>Where &lt;sampler-channel&gt; is the respective sampler channel
5190                        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>
5191                        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.
5192    </p>
5193    <p>Possible Answers:
5194    </p>
5195    <p>
5196                            </p>
5197    <blockquote class="text">
5198    <p>The sampler will answer by returning a comma separated list
5199                                with all effect sends' numerical IDs on the given sampler
5200                                channel.
5201    </p>
5202    </blockquote><p>
5203                        
5204    </p>
5205    <p>Examples:
5206    </p>
5207    <p>
5208                            </p>
5209    <blockquote class="text">
5210    <p>C: "LIST FX_SENDS 0"
5211    </p>
5212    <p>S: "0,1"
5213    </p>
5214    </blockquote><p>
5215                        
5216    </p>
5217    <p>
5218                            </p>
5219    <blockquote class="text">
5220    <p>C: "LIST FX_SENDS 1"
5221    </p>
5222    <p>S: ""
5223    </p>
5224    </blockquote><p>
5225                        
5226    </p>
5227    <a name="GET FX_SEND INFO"></a><br /><hr />
5228    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5229    <a name="rfc.section.6.4.29"></a><h3>6.4.29.&nbsp;
5230    Getting effect send information</h3>
5231    
5232    <p>The front-end can ask for the current settings of an effect send entity
5233                        by sending the following command:
5234    </p>
5235    <p>
5236                            </p>
5237    <blockquote class="text">
5238    <p>GET FX_SEND INFO &lt;sampler-channel&gt; &lt;fx-send-id&gt;
5239    </p>
5240    </blockquote><p>
5241                        
5242    </p>
5243    <p>Where &lt;sampler-channel&gt; is the sampler channel number
5244                        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>
5245                        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
5246                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5247                        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>
5248                        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.
5249                      
5250    </p>
5251    <p>Possible Answers:
5252    </p>
5253    <p>
5254                            </p>
5255    <blockquote class="text">
5256    <p>The sampler will answer by sending a &lt;CRLF&gt; separated list.
5257                                Each answer line begins with the settings category name
5258                                followed by a colon and then a space character &lt;SP&gt; and finally
5259                                the info character string to that setting category. At the
5260                                moment the following categories are defined:
5261    </p>
5262    <p>
5263                                    </p>
5264    <blockquote class="text">
5265    <p>NAME -
5266                                            </p>
5267    <blockquote class="text">
5268    <p>name of the effect send entity
5269    </p>
5270    </blockquote>
5271                                        
5272    
5273    <p>MIDI_CONTROLLER -
5274                                            </p>
5275    <blockquote class="text">
5276    <p>a value between 0 and 127 reflecting the MIDI controller
5277                                                which is able to modify the effect send's send level
5278    </p>
5279    </blockquote>
5280                                        
5281    
5282    <p>LEVEL -
5283                                            </p>
5284    <blockquote class="text">
5285    <p>optionally dotted number reflecting the effect send's
5286                                                current send level (where a value &lt; 1.0 means attenuation
5287                                                and a value > 1.0 means amplification)
5288    </p>
5289    </blockquote>
5290                                        
5291    
5292    <p>AUDIO_OUTPUT_ROUTING -
5293                                            </p>
5294    <blockquote class="text">
5295    <p>comma separated list which reflects to which audio
5296                                                channel of the selected audio output device each
5297                                                effect send output channel is routed to, e.g. "0,3" would
5298                                                mean the effect send's output channel 0 is routed to channel
5299                                                0 of the audio output device and the effect send's output
5300                                                channel 1 is routed to the channel 3 of the audio
5301                                                output device (see
5302                                                <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>
5303                                                for details)
5304    </p>
5305    </blockquote>
5306                                        
5307    
5308    </blockquote>
5309                                
5310    
5311    </blockquote><p>
5312                        
5313    </p>
5314    <p>The mentioned fields above don't have to be in particular order.
5315    </p>
5316    <p>Example:
5317    </p>
5318    <p>
5319                            </p>
5320    <blockquote class="text">
5321    <p>C: "GET FX_SEND INFO 0 0"
5322    </p>
5323    <p>S: "NAME: Reverb Send"
5324    </p>
5325    <p>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"
5326    </p>
5327    <p>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"
5328    </p>
5329    <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"
5330    </p>
5331    <p>&nbsp;&nbsp;&nbsp;"."
5332    </p>
5333    </blockquote><p>
5334                        
5335    </p>
5336    <a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
5337    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5338    <a name="rfc.section.6.4.30"></a><h3>6.4.30.&nbsp;
5339    Altering effect send's audio routing</h3>
5340    
5341    <p>The front-end can alter the destination of an effect send's audio channel on a specific
5342                        sampler channel by sending the following command:
5343    </p>
5344    <p>
5345                            </p>
5346    <blockquote class="text">
5347    <p>SET FX_SEND AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;audio-src&gt; &lt;audio-dst&gt;
5348    </p>
5349    </blockquote><p>
5350                        
5351    </p>
5352    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5353                        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>
5354                        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,
5355                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5356                        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>
5357                        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,
5358                        &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
5359                        which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
5360                        the audio channel of the selected audio output device where &lt;audio-src&gt;
5361                        should be routed to.
5362    </p>
5363    <p>Note that effect sends can only route audio to the same audio output
5364                        device as assigned to the effect send's sampler channel. Also note that an
5365                        effect send entity does always have exactly as much audio channels as its
5366                        sampler channel. So if the sampler channel is stereo, the effect send does
5367                        have two audio channels as well. Also keep in mind that the amount of audio
5368                        channels on a sampler channel might be dependant not only to the deployed
5369                        sampler engine on the sampler channel, but also dependant to the instrument
5370                        currently loaded. However you can (effectively) turn an i.e. stereo effect
5371                        send into a mono one by simply altering its audio routing appropriately.
5372    </p>
5373    <p>Possible Answers:
5374    </p>
5375    <p>
5376                            </p>
5377    <blockquote class="text">
5378    <p>"OK" -
5379                                    </p>
5380    <blockquote class="text">
5381    <p>on success
5382    </p>
5383    </blockquote>
5384                                
5385    
5386    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5387                                    </p>
5388    <blockquote class="text">
5389    <p>if audio output channel was set, but there are noteworthy
5390                                        issue(s) related, providing an appropriate warning code and
5391                                        warning message
5392    </p>
5393    </blockquote>
5394                                
5395    
5396    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5397                                    </p>
5398    <blockquote class="text">
5399    <p>in case it failed, providing an appropriate error code and error message
5400    </p>
5401    </blockquote>
5402                                
5403    
5404    </blockquote><p>
5405                        
5406    </p>
5407    <p>Example:
5408    </p>
5409    <p>
5410                            </p>
5411    <blockquote class="text">
5412    <p>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
5413    </p>
5414    <p>S: "OK"
5415    </p>
5416    </blockquote><p>
5417                        
5418    </p>
5419    <a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />
5420    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5421    <a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;
5422    Altering effect send's MIDI controller</h3>
5423    
5424    <p>The front-end can alter the MIDI controller of an effect
5425                        send entity by sending the following command:
5426    </p>
5427    <p>
5428                            </p>
5429    <blockquote class="text">
5430    <p>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;
5431    </p>
5432    </blockquote><p>
5433                        
5434    </p>
5435    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5436                        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>
5437                        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,
5438                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5439                        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>
5440                        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
5441                        &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
5442                        able to modify the effect send's send level.
5443    </p>
5444    <p>Possible Answers:
5445    </p>
5446    <p>
5447                            </p>
5448    <blockquote class="text">
5449    <p>"OK" -
5450                                    </p>
5451    <blockquote class="text">
5452    <p>on success
5453    </p>
5454    </blockquote>
5455                                
5456    
5457    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5458                                    </p>
5459    <blockquote class="text">
5460    <p>if MIDI controller was set, but there are noteworthy
5461                                        issue(s) related, providing an appropriate warning code and
5462                                        warning message
5463    </p>
5464    </blockquote>
5465                                
5466    
5467    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5468                                    </p>
5469    <blockquote class="text">
5470    <p>in case it failed, providing an appropriate error code and error message
5471    </p>
5472    </blockquote>
5473                                
5474    
5475    </blockquote><p>
5476                        
5477    </p>
5478    <p>Example:
5479    </p>
5480    <p>
5481                            </p>
5482    <blockquote class="text">
5483    <p>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
5484    </p>
5485    <p>S: "OK"
5486    </p>
5487    </blockquote><p>
5488                        
5489    </p>
5490    <a name="SET FX_SEND LEVEL"></a><br /><hr />
5491    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5492    <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;
5493    Altering effect send's send level</h3>
5494    
5495    <p>The front-end can alter the current send level of an effect
5496                        send entity by sending the following command:
5497    </p>
5498    <p>
5499                            </p>
5500    <blockquote class="text">
5501    <p>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;
5502    </p>
5503    </blockquote><p>
5504                        
5505    </p>
5506    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5507                        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>
5508                        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,
5509                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5510                        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>
5511                        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
5512                        &lt;volume&gt; is an optionally dotted positive number (a value
5513                        smaller than 1.0 means attenuation, whereas a value greater than
5514                        1.0 means amplification) reflecting the new send level.
5515    </p>
5516    <p>Possible Answers:
5517    </p>
5518    <p>
5519                            </p>
5520    <blockquote class="text">
5521    <p>"OK" -
5522                                    </p>
5523    <blockquote class="text">
5524    <p>on success
5525    </p>
5526    </blockquote>
5527                                
5528    
5529    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5530                                    </p>
5531    <blockquote class="text">
5532    <p>if new send level was set, but there are noteworthy
5533                                        issue(s) related, providing an appropriate warning code and
5534                                        warning message
5535    </p>
5536    </blockquote>
5537                                
5538    
5539    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5540                                    </p>
5541    <blockquote class="text">
5542    <p>in case it failed, providing an appropriate error code and error message
5543    </p>
5544    </blockquote>
5545                                
5546    
5547    </blockquote><p>
5548                        
5549    </p>
5550    <p>Example:
5551    </p>
5552    <p>
5553                            </p>
5554    <blockquote class="text">
5555    <p>C: "SET FX_SEND LEVEL 0 0 0.15"
5556    </p>
5557    <p>S: "OK"
5558    </p>
5559    </blockquote><p>
5560                        
5561    </p>
5562  <a name="RESET CHANNEL"></a><br /><hr />  <a name="RESET CHANNEL"></a><br /><hr />
5563  <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>
5564  <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;
5565    Resetting a sampler channel</h3>
5566    
5567  <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:
5568  </p>  </p>
# Line 4786  Intellectual Property and Copyright Stat Line 5626  Intellectual Property and Copyright Stat
5626                                            
5627  </p>  </p>
5628  <a name="anchor12"></a><br /><hr />  <a name="anchor12"></a><br /><hr />
5629  <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>
5630  <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;
5631    Controlling connection</h3>
5632    
5633  <p>The following commands are used to control the connection to LinuxSampler.  <p>The following commands are used to control the connection to LinuxSampler.
5634  </p>  </p>
5635  <a name="SUBSCRIBE"></a><br /><hr />  <a name="SUBSCRIBE"></a><br /><hr />
5636  <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>
5637  <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;
5638    Register front-end for receiving event messages</h3>
5639    
5640  <p>The front-end can register itself to the LinuxSampler application to  <p>The front-end can register itself to the LinuxSampler application to
5641                      be informed about noteworthy events by sending this command:                      be informed about noteworthy events by sending this command:
# Line 4855  Intellectual Property and Copyright Stat Line 5697  Intellectual Property and Copyright Stat
5697                                            
5698  </p>  </p>
5699  <a name="UNSUBSCRIBE"></a><br /><hr />  <a name="UNSUBSCRIBE"></a><br /><hr />
5700  <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>
5701  <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;
5702    Unregister front-end for not receiving event messages</h3>
5703    
5704  <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
5705                      messages anymore by sending the following command:                      messages anymore by sending the following command:
# Line 4918  Intellectual Property and Copyright Stat Line 5761  Intellectual Property and Copyright Stat
5761                                            
5762  </p>  </p>
5763  <a name="SET ECHO"></a><br /><hr />  <a name="SET ECHO"></a><br /><hr />
5764  <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>
5765  <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;
5766    Enable or disable echo of commands</h3>
5767    
5768  <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:
5769  </p>  </p>
# Line 4974  Intellectual Property and Copyright Stat Line 5818  Intellectual Property and Copyright Stat
5818                                            
5819  </p>  </p>
5820  <a name="QUIT"></a><br /><hr />  <a name="QUIT"></a><br /><hr />
5821  <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>
5822  <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;
5823    Close client connection</h3>
5824    
5825  <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:
5826  </p>  </p>
# Line 4991  Intellectual Property and Copyright Stat Line 5836  Intellectual Property and Copyright Stat
5836                      LinuxSampler than really useful for a front-end implementation.                      LinuxSampler than really useful for a front-end implementation.
5837  </p>  </p>
5838  <a name="anchor13"></a><br /><hr />  <a name="anchor13"></a><br /><hr />
5839  <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>
5840  <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;
5841    Global commands</h3>
5842    
5843  <p>The following commands have global impact on the sampler.  <p>The following commands have global impact on the sampler.
5844  </p>  </p>
5845  <a name="GET TOTAL_VOICE_COUNT"></a><br /><hr />  <a name="GET TOTAL_VOICE_COUNT"></a><br /><hr />
5846  <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>
5847  <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;
5848    Current number of active voices</h3>
5849    
5850  <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
5851                      the sampler by sending the following command:                      the sampler by sending the following command:
# Line 5023  Intellectual Property and Copyright Stat Line 5870  Intellectual Property and Copyright Stat
5870                                            
5871  </p>  </p>
5872  <a name="GET TOTAL_VOICE_COUNT_MAX"></a><br /><hr />  <a name="GET TOTAL_VOICE_COUNT_MAX"></a><br /><hr />
5873  <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>
5874  <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;
5875    Maximum amount of active voices</h3>
5876    
5877  <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
5878                      by sending the following command:                      by sending the following command:
# Line 5049  Intellectual Property and Copyright Stat Line 5897  Intellectual Property and Copyright Stat
5897                                            
5898  </p>  </p>
5899  <a name="RESET"></a><br /><hr />  <a name="RESET"></a><br /><hr />
5900  <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>
5901  <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;
5902    Reset sampler</h3>
5903    
5904  <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:
5905  </p>  </p>
# Line 5089  Intellectual Property and Copyright Stat Line 5938  Intellectual Property and Copyright Stat
5938                                            
5939  </p>  </p>
5940  <a name="GET SERVER INFO"></a><br /><hr />  <a name="GET SERVER INFO"></a><br /><hr />
5941  <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>
5942  <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;
5943    General sampler informations</h3>
5944    
5945  <p>The client can ask for general informations about the LinuxSampler  <p>The client can ask for general informations about the LinuxSampler
5946                         instance by sending the following command:                         instance by sending the following command:
# Line 5138  Intellectual Property and Copyright Stat Line 5988  Intellectual Property and Copyright Stat
5988                                          </p>                                          </p>
5989  <blockquote class="text">  <blockquote class="text">
5990  <p>version of the LSCP specification the sampler  <p>version of the LSCP specification the sampler
5991                                              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)
5992  </p>  </p>
5993  </blockquote>  </blockquote>
5994                                                                            
# Line 5152  Intellectual Property and Copyright Stat Line 6002  Intellectual Property and Copyright Stat
6002  <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.
6003                      Other fields might be added in future.                      Other fields might be added in future.
6004  </p>  </p>
6005  <a name="anchor14"></a><br /><hr />  <a name="GET VOLUME"></a><br /><hr />
6006  <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>
6007  <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;MIDI Instrument Mapping</h3>  <a name="rfc.section.6.6.5"></a><h3>6.6.5.&nbsp;
6008    Getting global volume attenuation</h3>
6009    
6010    <p>The client can ask for the current global sampler-wide volume
6011                        attenuation by sending the following command:
6012    </p>
6013    <p>
6014                            </p>
6015    <blockquote class="text">
6016    <p>GET VOLUME
6017    </p>
6018    </blockquote><p>
6019                        
6020    </p>
6021    <p>Possible Answers:
6022    </p>
6023    <p>
6024                            </p>
6025    <blockquote class="text">
6026    <p>The sampler will always answer by returning the optional
6027                                dotted floating point coefficient, reflecting the current
6028                                global volume attenuation.
6029                                
6030    </p>
6031    </blockquote><p>
6032                        
6033    </p>
6034    <p>Note: it is up to the respective sampler engine whether to obey
6035                        that global volume parameter or not, but in general all engines SHOULD
6036                        use this parameter.
6037    </p>
6038    <a name="SET VOLUME"></a><br /><hr />
6039    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6040    <a name="rfc.section.6.6.6"></a><h3>6.6.6.&nbsp;
6041    Setting global volume attenuation</h3>
6042    
6043    <p>The client can alter the current global sampler-wide volume
6044                        attenuation by sending the following command:
6045    </p>
6046    <p>
6047                            </p>
6048    <blockquote class="text">
6049    <p>SET VOLUME &lt;volume&gt;
6050    </p>
6051    </blockquote><p>
6052                        
6053    </p>
6054    <p>Where &lt;volume&gt; should be replaced by the optional dotted
6055                       floating point value, reflecting the new global volume parameter.
6056                       This value might usually be in the range between 0.0 and 1.0, that
6057                       is for attenuating the overall volume.
6058    </p>
6059    <p>Possible Answers:
6060    </p>
6061    <p>
6062                            </p>
6063    <blockquote class="text">
6064    <p>"OK" -
6065                                    </p>
6066    <blockquote class="text">
6067    <p>on success
6068    </p>
6069    </blockquote>
6070                                
6071    
6072    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6073                                    </p>
6074    <blockquote class="text">
6075    <p>if the global volume was set, but there are noteworthy
6076                                        issue(s) related, providing an appropriate warning code and
6077                                        warning message
6078    </p>
6079    </blockquote>
6080                                
6081    
6082    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6083                                    </p>
6084    <blockquote class="text">
6085    <p>in case it failed, providing an appropriate error code and error message
6086    </p>
6087    </blockquote>
6088                                
6089    
6090    </blockquote><p>
6091                        
6092    </p>
6093    <a name="MIDI Instrument Mapping"></a><br /><hr />
6094    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6095    <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;
6096    MIDI Instrument Mapping</h3>
6097    
6098  <p>The MIDI protocol provides a way to switch between instruments  <p>The MIDI protocol provides a way to switch between instruments
6099                  by sending so called MIDI bank select and MIDI program change                  by sending so called MIDI bank select and MIDI program change
# Line 5162  Intellectual Property and Copyright Stat Line 6101  Intellectual Property and Copyright Stat
6101                  allow to actually map arbitrary MIDI bank select / program change                  allow to actually map arbitrary MIDI bank select / program change
6102                  numbers with real instruments.                  numbers with real instruments.
6103  </p>  </p>
6104  <p>By default, that is when the sampler is launched, this map will  <p>The sampler allows to manage an arbitrary amount of MIDI
6105                  be empty, thus the sampler will simply ignore all program change                  instrument maps which define which instrument to load on
6106                  messages. The front-end has to explicitly add entries to the map                  which MIDI program change message.
6107                  so the sampler knows how to react on a given program change  </p>
6108                  message, that is by switching to the respectively defined engine  <p>By default, that is when the sampler is launched, there is no
6109                  type and loading the respective instrument.                  map, thus the sampler will simply ignore all program change
6110                    messages. The front-end has to explicitly create at least one
6111                    map, add entries to the map and tell the respective sampler
6112                    channel(s) which MIDI instrument map to use, so the sampler
6113                    knows how to react on a given program change message on the
6114                    respective sampler channel, that is by switching to the
6115                    respectively defined engine type and loading the respective
6116                    instrument. See command
6117                    <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>
6118                    for how to assign a MIDI instrument map to a sampler channel.
6119  </p>  </p>
6120  <p>Also note per MIDI specification a bank select message does not  <p>Also note per MIDI specification a bank select message does not
6121                  cause to switch to another instrument. Instead when receiving a                  cause to switch to another instrument. Instead when receiving a
# Line 5176  Intellectual Property and Copyright Stat Line 6124  Intellectual Property and Copyright Stat
6124                  cause the sampler to switch to the respective instrument as                  cause the sampler to switch to the respective instrument as
6125                  reflected by the current MIDI instrument map.                  reflected by the current MIDI instrument map.
6126  </p>  </p>
6127    <a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr />
6128    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6129    <a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;
6130    Create a new MIDI instrument map</h3>
6131    
6132    <p>The front-end can add a new MIDI instrument map by sending
6133                        the following command:
6134    </p>
6135    <p>
6136                            </p>
6137    <blockquote class="text">
6138    <p>ADD MIDI_INSTRUMENT_MAP [&lt;name&gt;]
6139    </p>
6140    </blockquote><p>
6141                        
6142    </p>
6143    <p>Where &lt;name&gt; is an optional argument allowing to
6144                        assign a custom name to the new map. MIDI instrument Map
6145                        names do not have to be unique.
6146    </p>
6147    <p>Possible Answers:
6148    </p>
6149    <p>
6150                            </p>
6151    <blockquote class="text">
6152    <p>"OK[&lt;map&gt;]" -
6153                                    </p>
6154    <blockquote class="text">
6155    <p>in case a new MIDI instrument map could
6156                                        be added, where &lt;map&gt; reflects the
6157                                        unique ID of the newly created MIDI
6158                                        instrument map
6159    </p>
6160    </blockquote>
6161                                
6162    
6163    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6164                                    </p>
6165    <blockquote class="text">
6166    <p>when a new map could not be created, which
6167                                        might never occur in practice
6168    </p>
6169    </blockquote>
6170                                
6171    
6172    </blockquote><p>
6173                        
6174    </p>
6175    <p>Examples:
6176    </p>
6177    <p>
6178                            </p>
6179    <blockquote class="text">
6180    <p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
6181    </p>
6182    <p>S: "OK[0]"
6183    </p>
6184    </blockquote><p>
6185                        
6186    </p>
6187    <p>
6188                            </p>
6189    <blockquote class="text">
6190    <p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
6191    </p>
6192    <p>S: "OK[1]"
6193    </p>
6194    </blockquote><p>
6195                        
6196    </p>
6197    <p>
6198                            </p>
6199    <blockquote class="text">
6200    <p>C: "ADD MIDI_INSTRUMENT_MAP"
6201    </p>
6202    <p>S: "OK[5]"
6203    </p>
6204    </blockquote><p>
6205                        
6206    </p>
6207    <a name="REMOVE MIDI_INSTRUMENT_MAP"></a><br /><hr />
6208    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6209    <a name="rfc.section.6.7.2"></a><h3>6.7.2.&nbsp;
6210    Delete one particular or all MIDI instrument maps</h3>
6211    
6212    <p>The front-end can delete a particular MIDI instrument map
6213                        by sending the following command:
6214    </p>
6215    <p>
6216                            </p>
6217    <blockquote class="text">
6218    <p>REMOVE MIDI_INSTRUMENT_MAP &lt;map&gt;
6219    </p>
6220    </blockquote><p>
6221                        
6222    </p>
6223    <p>Where &lt;map&gt; reflects the unique ID of the map to delete
6224                        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>
6225                        command.
6226    </p>
6227    <p>The front-end can delete all MIDI instrument maps by
6228                        sending the following command:
6229    </p>
6230    <p>
6231                            </p>
6232    <blockquote class="text">
6233    <p>REMOVE MIDI_INSTRUMENT_MAP ALL
6234    </p>
6235    </blockquote><p>
6236                        
6237    </p>
6238    <p>Possible Answers:
6239    </p>
6240    <p>
6241                            </p>
6242    <blockquote class="text">
6243    <p>"OK" -
6244                                    </p>
6245    <blockquote class="text">
6246    <p>in case the map(s) could be deleted
6247    </p>
6248    </blockquote>
6249                                
6250    
6251    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6252                                    </p>
6253    <blockquote class="text">
6254    <p>when the given map does not exist
6255    </p>
6256    </blockquote>
6257                                
6258    
6259    </blockquote><p>
6260                        
6261    </p>
6262    <p>Examples:
6263    </p>
6264    <p>
6265                            </p>
6266    <blockquote class="text">
6267    <p>C: "REMOVE MIDI_INSTRUMENT_MAP 0"
6268    </p>
6269    <p>S: "OK"
6270    </p>
6271    </blockquote><p>
6272                        
6273    </p>
6274    <p>
6275                            </p>
6276    <blockquote class="text">
6277    <p>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
6278    </p>
6279    <p>S: "OK"
6280    </p>
6281    </blockquote><p>
6282                        
6283    </p>
6284    <a name="GET MIDI_INSTRUMENT_MAPS"></a><br /><hr />
6285    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6286    <a name="rfc.section.6.7.3"></a><h3>6.7.3.&nbsp;
6287    Get amount of existing MIDI instrument maps</h3>
6288    
6289    <p>The front-end can retrieve the current amount of MIDI
6290                        instrument maps by sending the following command:
6291    </p>
6292    <p>
6293                            </p>
6294    <blockquote class="text">
6295    <p>GET MIDI_INSTRUMENT_MAPS
6296    </p>
6297    </blockquote><p>
6298                        
6299    </p>
6300    <p>Possible Answers:
6301    </p>
6302    <p>
6303                            </p>
6304    <blockquote class="text">
6305    <p>The sampler will answer by returning the current
6306                                number of MIDI instrument maps.
6307    </p>
6308    </blockquote><p>
6309                        
6310    </p>
6311    <p>Example:
6312    </p>
6313    <p>
6314                            </p>
6315    <blockquote class="text">
6316    <p>C: "GET MIDI_INSTRUMENT_MAPS"
6317    </p>
6318    <p>S: "2"
6319    </p>
6320    </blockquote><p>
6321                        
6322    </p>
6323    <a name="LIST MIDI_INSTRUMENT_MAPS"></a><br /><hr />
6324    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6325    <a name="rfc.section.6.7.4"></a><h3>6.7.4.&nbsp;
6326    Getting all created MIDI instrument maps</h3>
6327    
6328    <p>The number of MIDI instrument maps can change on runtime. To get the
6329                        current list of MIDI instrument maps, the front-end can send the
6330                        following command:
6331    </p>
6332    <p>
6333                            </p>
6334    <blockquote class="text">
6335    <p>LIST MIDI_INSTRUMENT_MAPS
6336    </p>
6337    </blockquote><p>
6338                        
6339    </p>
6340    <p>Possible Answers:
6341    </p>
6342    <p>
6343                            </p>
6344    <blockquote class="text">
6345    <p>The sampler will answer by returning a comma separated list
6346                                with all MIDI instrument maps' numerical IDs.
6347    </p>
6348    </blockquote><p>
6349                        
6350    </p>
6351    <p>Example:
6352    </p>
6353    <p>
6354                            </p>
6355    <blockquote class="text">
6356    <p>C: "LIST MIDI_INSTRUMENT_MAPS"
6357    </p>
6358    <p>S: "0,1,5,12"
6359    </p>
6360    </blockquote><p>
6361                        
6362    </p>
6363    <a name="GET MIDI_INSTRUMENT_MAP INFO"></a><br /><hr />
6364    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6365    <a name="rfc.section.6.7.5"></a><h3>6.7.5.&nbsp;
6366    Getting MIDI instrument map information</h3>
6367    
6368    <p>The front-end can ask for the current settings of a MIDI
6369                        instrument map by sending the following command:
6370    </p>
6371    <p>
6372                            </p>
6373    <blockquote class="text">
6374    <p>GET MIDI_INSTRUMENT_MAP INFO &lt;map&gt;
6375    </p>
6376    </blockquote><p>
6377                        
6378    </p>
6379    <p>Where &lt;map&gt; is the numerical ID of the map the
6380                        front-end is interested in as returned by the
6381                        <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>
6382                        command.
6383    </p>
6384    <p>Possible Answers:
6385    </p>
6386    <p>
6387                            </p>
6388    <blockquote class="text">
6389    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6390                                Each answer line begins with the settings category name
6391                                followed by a colon and then a space character &lt;SP&gt; and finally
6392                                the info character string to that setting category. At the
6393                                moment the following categories are defined:
6394    </p>
6395    <p>
6396                                    </p>
6397    <blockquote class="text">
6398    <p>NAME -
6399                                            </p>
6400    <blockquote class="text">
6401    <p>custom name of the given map,
6402                                                which does not have to be unique
6403    </p>
6404    </blockquote>
6405                                        
6406    
6407    </blockquote>
6408                                
6409    
6410    </blockquote><p>
6411                        
6412    </p>
6413    <p>The mentioned fields above don't have to be in particular order.
6414    </p>
6415    <p>Example:
6416    </p>
6417    <p>
6418                            </p>
6419    <blockquote class="text">
6420    <p>C: "GET MIDI_INSTRUMENT_MAP INFO 0"
6421    </p>
6422    <p>S: "NAME: Standard Map"
6423    </p>
6424    <p>&nbsp;&nbsp;&nbsp;"."
6425    </p>
6426    </blockquote><p>
6427                        
6428    </p>
6429    <a name="SET MIDI_INSTRUMENT_MAP NAME"></a><br /><hr />
6430    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
6431    <a name="rfc.section.6.7.6"></a><h3>6.7.6.&nbsp;
6432    Renaming a MIDI instrument map</h3>
6433    
6434    <p>The front-end can alter the custom name of a MIDI
6435                        instrument map by sending the following command:
6436    </p>
6437    <p>
6438                            </p>
6439    <blockquote class="text">
6440    <p>SET MIDI_INSTRUMENT_MAP NAME &lt;map&gt; &lt;name&gt;
6441    </p>
6442    </blockquote><p>
6443                        
6444    </p>
6445    <p>Where &lt;map&gt; is the numerical ID of the map and
6446                        &lt;name&gt; the new custom name of the map, which does not
6447                        have to be unique.
6448    </p>
6449    <p>Possible Answers:
6450    </p>
6451    <p>
6452                            </p>
6453    <blockquote class="text">
6454    <p>"OK" -
6455                                    </p>
6456    <blockquote class="text">
6457    <p>on success
6458    </p>
6459    </blockquote>
6460                                
6461    
6462    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6463                                    </p>
6464    <blockquote class="text">
6465    <p>in case the given map does not exist
6466    </p>
6467    </blockquote>
6468                                
6469    
6470    </blockquote><p>
6471                        
6472    </p>
6473    <p>Example:
6474    </p>
6475    <p>
6476                            </p>
6477    <blockquote class="text">
6478    <p>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
6479    </p>
6480    <p>S: "OK"
6481    </p>
6482    </blockquote><p>
6483                        
6484    </p>
6485  <a name="MAP MIDI_INSTRUMENT"></a><br /><hr />  <a name="MAP MIDI_INSTRUMENT"></a><br /><hr />
6486  <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>
6487  <a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;Create or replace a MIDI instrument map entry</h3>  <a name="rfc.section.6.7.7"></a><h3>6.7.7.&nbsp;
6488    Create or replace a MIDI instrument map entry</h3>
6489    
6490  <p>The front-end can create a new or replace an existing entry  <p>The front-end can create a new or replace an existing entry
6491                      in the sampler's MIDI instrument map by sending the following                      in a sampler's MIDI instrument map by sending the following
6492                      command:                      command:
6493  </p>  </p>
6494  <p>  <p>
6495                          </p>                          </p>
6496  <blockquote class="text">  <blockquote class="text">
6497  <p>MAP MIDI_INSTRUMENT &lt;midi_bank_msb&gt;  <p>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
6498                              &lt;midi_bank_lsb&gt; &lt;midi_prog&gt; &lt;engine_name&gt;                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
6499                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
6500                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]
6501  </p>  </p>
6502  </blockquote><p>  </blockquote><p>
6503                                            
6504  </p>  </p>
6505  <p>Where &lt;midi_bank_msb&gt; is an integer value between  <p>Where &lt;map&gt; is the numeric ID of the map to alter,
6506                      0..127 reflecting the MIDI bank select MSB (coarse) index,                      &lt;midi_bank&gt; is an integer value between
6507                      &lt;midi_bank_lsb&gt; an integer value between 0..127 reflecting                      0..16383 reflecting the MIDI bank select index,
6508                      the MIDI bank select LSB (fine) index, &lt;midi_prog&gt; an                      &lt;midi_prog&gt; an
6509                      integer value between 0..127 reflecting the MIDI program change                      integer value between 0..127 reflecting the MIDI program change
6510                      index, &lt;engine_name&gt; a sampler engine name as returned by                      index, &lt;engine_name&gt; a sampler engine name as returned by
6511                      the <a class="info" href="#LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"<span> (</span><span class="info">Getting all available engines</span><span>)</span></a>                      the <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a>
6512                      command (not encapsulated into apostrophes), &lt;filename&gt; the name                      command (not encapsulated into apostrophes), &lt;filename&gt; the name
6513                      of the instrument's file to be deployed (encapsulated into apostrophes), &lt;instrument_index&gt; the index (integer value) of the instrument                      of the instrument's file to be deployed (encapsulated into apostrophes),
6514                        &lt;instrument_index&gt; the index (integer value) of the instrument
6515                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
6516                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
6517                      value < 1.0 means attenuation and a value > 1.0 means                      value &lt; 1.0 means attenuation and a value > 1.0 means
6518                      amplification). This parameter easily allows to adjust the                      amplification). This parameter easily allows to adjust the
6519                      volume of all intruments within a custom instrument map                      volume of all intruments within a custom instrument map
6520                      without having to adjust their instrument files. The                      without having to adjust their instrument files. The
# Line 5250  Intellectual Property and Copyright Stat Line 6558  Intellectual Property and Copyright Stat
6558                                  </p>                                  </p>
6559  <blockquote class="text">  <blockquote class="text">
6560  <p>The instrument will immediately be loaded  <p>The instrument will immediately be loaded
6561                                      into memory in the background when this mapping                                      into memory when this mapping
6562                                      command is sent and the instrument is kept all                                      command is sent and the instrument is kept all
6563                                      the time. Instruments with this mode are                                      the time. Instruments with this mode are
6564                                      only freed when the sampler is reset or all                                      only freed when the sampler is reset or all
# Line 5298  Intellectual Property and Copyright Stat Line 6606  Intellectual Property and Copyright Stat
6606                      individually. Due to this, in case the frontend shows the                      individually. Due to this, in case the frontend shows the
6607                      load modes of entries, the frontend should retrieve the actual                      load modes of entries, the frontend should retrieve the actual
6608                      mode by i.e. sending                      mode by i.e. sending
6609                      <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>                      <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>
6610                      command(s). Finally the OPTIONAL &lt;name&gt; argument allows to                      command(s). Finally the OPTIONAL &lt;name&gt; argument allows to
6611                      set a custom name (encapsulated into apostrophes) for the mapping                      set a custom name (encapsulated into apostrophes) for the mapping
6612                      entry, useful for frontends for displaying an appropriate name for                      entry, useful for frontends for displaying an appropriate name for
6613                      mapped instruments (using                      mapped instruments (using
6614                      <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>).                      <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>).
6615                                            
6616  </p>  </p>
6617  <p>  <p>
6618                      The "MAP MIDI_INSTRUMENT" command                      By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
6619                      will immediately return, thus it will not block when an                      completely established in the sampler. The OPTIONAL "NON_MODAL" argument
6620                      instrument is to be loaded due to a "PERSISTENT" type                      however causes the respective "MAP MIDI_INSTRUMENT" command to return
6621                      entry as instruments are loaded in the background. As a                      immediately, that is to let the sampler establish the mapping in the
6622                      consequence this command may not necessarily return an error                      background. So this argument might be especially useful for mappings with
6623                      i.e. when the given instrument file does not exist or may                      a "PERSISTENT" type, because these have to load the respective instruments
6624                      turn out to be corrupt.                      immediately and might thus block for a very long time. It is recommended
6625                        however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
6626                        because it has the following drawbacks: as "NON_MODAL" instructions return
6627                        immediately, they may not necessarily return an error i.e. when the given
6628                        instrument file turns out to be corrupt, beside that subsequent commands
6629                        in a LSCP instruction sequence might fail, because mandatory mappings are
6630                        not yet completed.
6631                                            
6632  </p>  </p>
6633  <p>Possible Answers:  <p>Possible Answers:
# Line 5332  Intellectual Property and Copyright Stat Line 6646  Intellectual Property and Copyright Stat
6646  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -  <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6647                                  </p>                                  </p>
6648  <blockquote class="text">  <blockquote class="text">
6649  <p>when the given engine does not exist or a value  <p>when the given map or engine does not exist or a value
6650                                      is out of range                                      is out of range
6651  </p>  </p>
6652  </blockquote>  </blockquote>
# Line 5346  Intellectual Property and Copyright Stat Line 6660  Intellectual Property and Copyright Stat
6660  <p>  <p>
6661                          </p>                          </p>
6662  <blockquote class="text">  <blockquote class="text">
6663  <p>C: "MAP MIDI_INSTRUMENT 3 0 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"  <p>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"
6664  </p>  </p>
6665  <p>S: "OK"  <p>S: "OK"
6666  </p>  </p>
# Line 5356  Intellectual Property and Copyright Stat Line 6670  Intellectual Property and Copyright Stat
6670  <p>  <p>
6671                          </p>                          </p>
6672  <blockquote class="text">  <blockquote class="text">
6673  <p>C: "MAP MIDI_INSTRUMENT 127 4 50 gig '/home/john/foostrings.gig' 7 1.0"  <p>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"
6674  </p>  </p>
6675  <p>S: "OK"  <p>S: "OK"
6676  </p>  </p>
# Line 5370  Intellectual Property and Copyright Stat Line 6684  Intellectual Property and Copyright Stat
6684  </p>  </p>
6685  <p>S: "OK"  <p>S: "OK"
6686  </p>  </p>
6687  <p>C: "MAP MIDI_INSTRUMENT 1 0 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"  <p>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"
6688  </p>  </p>
6689  <p>S: "OK"  <p>S: "OK"
6690  </p>  </p>
# Line 5380  Intellectual Property and Copyright Stat Line 6694  Intellectual Property and Copyright Stat
6694  <p>  <p>
6695                          </p>                          </p>
6696  <blockquote class="text">  <blockquote class="text">
6697  <p>C: "MAP MIDI_INSTRUMENT 99 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"  <p>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
6698  </p>  </p>
6699  <p>S: "OK"  <p>S: "OK"
6700  </p>  </p>
# Line 5388  Intellectual Property and Copyright Stat Line 6702  Intellectual Property and Copyright Stat
6702                                            
6703  </p>  </p>
6704  <a name="GET MIDI_INSTRUMENTS"></a><br /><hr />  <a name="GET MIDI_INSTRUMENTS"></a><br /><hr />
6705  <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>
6706  <a name="rfc.section.6.7.2"></a><h3>6.7.2.&nbsp;Getting ammount of MIDI instrument map entries</h3>  <a name="rfc.section.6.7.8"></a><h3>6.7.8.&nbsp;
6707    Getting ammount of MIDI instrument map entries</h3>
6708    
6709  <p>The front-end can query the amount of currently existing MIDI  <p>The front-end can query the amount of currently existing
6710                      instrument map entries by sending the following                      entries in a MIDI instrument map by sending the following
6711                        command:
6712    </p>
6713    <p>
6714                            </p>
6715    <blockquote class="text">
6716    <p>GET MIDI_INSTRUMENTS &lt;map&gt;
6717    </p>
6718    </blockquote><p>
6719                        
6720    </p>
6721    <p>The front-end can query the amount of currently existing
6722                        entries in all MIDI instrument maps by sending the following
6723                      command:                      command:
6724  </p>  </p>
6725  <p>  <p>
6726                          </p>                          </p>
6727  <blockquote class="text">  <blockquote class="text">
6728  <p>GET MIDI_INSTRUMENTS  <p>GET MIDI_INSTRUMENTS ALL
6729  </p>  </p>
6730  </blockquote><p>  </blockquote><p>
6731                                            
# Line 5408  Intellectual Property and Copyright Stat Line 6735  Intellectual Property and Copyright Stat
6735  <p>  <p>
6736                          </p>                          </p>
6737  <blockquote class="text">  <blockquote class="text">
6738  <p>LinuxSampler will answer by sending the current number of  <p>The sampler will answer by sending the current number of
6739                              entries in the sampler's MIDI instrument map.                              entries in the MIDI instrument map(s).
6740  </p>  </p>
6741  </blockquote><p>  </blockquote><p>
6742                                            
# Line 5419  Intellectual Property and Copyright Stat Line 6746  Intellectual Property and Copyright Stat
6746  <p>  <p>
6747                          </p>                          </p>
6748  <blockquote class="text">  <blockquote class="text">
6749  <p>C: "GET MIDI_INSTRUMENTS"  <p>C: "GET MIDI_INSTRUMENTS 0"
6750    </p>
6751    <p>S: "234"
6752    </p>
6753    </blockquote><p>
6754                        
6755    </p>
6756    <p>
6757                            </p>
6758    <blockquote class="text">
6759    <p>C: "GET MIDI_INSTRUMENTS ALL"
6760  </p>  </p>
6761  <p>S: "634"  <p>S: "954"
6762  </p>  </p>
6763  </blockquote><p>  </blockquote><p>
6764                                            
6765  </p>  </p>
6766  <a name="LIST MIDI_INSTRUMENTS"></a><br /><hr />  <a name="LIST MIDI_INSTRUMENTS"></a><br /><hr />
6767  <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>
6768  <a name="rfc.section.6.7.3"></a><h3>6.7.3.&nbsp;Getting indeces of all MIDI instrument map entries</h3>  <a name="rfc.section.6.7.9"></a><h3>6.7.9.&nbsp;
6769    Getting indeces of all entries of a MIDI instrument map</h3>
6770    
6771  <p>The front-end can query a list of all currently existing MIDI  <p>The front-end can query a list of all currently existing
6772                      instrument map entries by sending the following command:                      entries in a certain MIDI instrument map by sending the following
6773                        command:
6774  </p>  </p>
6775  <p>  <p>
6776                          </p>                          </p>
6777  <blockquote class="text">  <blockquote class="text">
6778  <p>LIST MIDI_INSTRUMENTS  <p>LIST MIDI_INSTRUMENTS &lt;map&gt;
6779    </p>
6780    </blockquote><p>
6781                        
6782    </p>
6783    <p>Where &lt;map&gt; is the numeric ID of the MIDI instrument map.
6784    </p>
6785    <p>The front-end can query a list of all currently existing
6786                        entries of all MIDI instrument maps by sending the following
6787                        command:
6788    </p>
6789    <p>
6790                            </p>
6791    <blockquote class="text">
6792    <p>LIST MIDI_INSTRUMENTS ALL
6793  </p>  </p>
6794  </blockquote><p>  </blockquote><p>
6795                                            
# Line 5446  Intellectual Property and Copyright Stat Line 6799  Intellectual Property and Copyright Stat
6799  <p>  <p>
6800                          </p>                          </p>
6801  <blockquote class="text">  <blockquote class="text">
6802  <p>LinuxSampler will answer by sending a comma separated  <p>The sampler will answer by sending a comma separated
6803                              list of MIDI bank MSB (coarse) - MIDI bank LSB (fine) -                              list of map ID - MIDI bank - MIDI program triples, where
6804                              MIDI program triples, where each triple is encapsulated                              each triple is encapsulated into curly braces. The
6805                              into curly braces. The list is returned in one single                              list is returned in one single line. Each triple
6806                              line. Each triple just reflects the key of the respective                              just reflects the key of the respective map entry,
6807                              map entry, thus subsequent                              thus subsequent
6808                              <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>                              <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>
6809                              command(s) are necessary to retrieve detailed informations                              command(s) are necessary to retrieve detailed informations
6810                              about each entry.                              about each entry.
6811  </p>  </p>
# Line 5464  Intellectual Property and Copyright Stat Line 6817  Intellectual Property and Copyright Stat
6817  <p>  <p>
6818                          </p>                          </p>
6819  <blockquote class="text">  <blockquote class="text">
6820  <p>C: "LIST MIDI_INSTRUMENTS"  <p>C: "LIST MIDI_INSTRUMENTS 0"
6821  </p>  </p>
6822  <p>S: "{0,0,0},{0,0,1},{120,0,3},{120,0,4},{23,127,127}"  <p>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
6823  </p>  </p>
6824  </blockquote><p>  </blockquote><p>
6825                                            
6826  </p>  </p>
6827  <a name="UNMAP MIDI_INSTRUMENT"></a><br /><hr />  <a name="UNMAP MIDI_INSTRUMENT"></a><br /><hr />
6828  <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>
6829  <a name="rfc.section.6.7.4"></a><h3>6.7.4.&nbsp;Remove an entry from the MIDI instrument map</h3>  <a name="rfc.section.6.7.10"></a><h3>6.7.10.&nbsp;
6830    Remove an entry from the MIDI instrument map</h3>
6831    
6832  <p>The front-end can delete an entry from the MIDI instrument  <p>The front-end can delete an entry from a MIDI instrument
6833                      map by sending the following command:                      map by sending the following command:
6834  </p>  </p>
6835  <p>  <p>
6836                          </p>                          </p>
6837  <blockquote class="text">  <blockquote class="text">
6838  <p>UNMAP MIDI_INSTRUMENT &lt;midi_bank_msb&gt; &lt;midi_bank_lsb&gt; &lt;midi_prog&gt;  <p>UNMAP MIDI_INSTRUMENT &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;
6839  </p>  </p>
6840  </blockquote><p>  </blockquote><p>
6841                                            
6842  </p>  </p>
6843  <p>  <p>
6844                      Where &lt;midi_bank_msb&gt; is an integer value between 0..127                      Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
6845                      reflecting the MIDI bank MSB (coarse) value, &lt;midi_bank_lsb&gt;                      &lt;midi_bank&gt; is an integer value between 0..16383
6846                      an integer value between 0..127 reflecting the MIDI bank LSB                      reflecting the MIDI bank value and
6847                      (fine) value and &lt;midi_prog&gt; an integer value between                      &lt;midi_prog&gt; an integer value between
6848                      0..127 reflecting the MIDI program value of the map entrie's key                      0..127 reflecting the MIDI program value of the map's entrie's key
6849                      index triple.                      index triple.
6850                                            
6851  </p>  </p>
# Line 5524  Intellectual Property and Copyright Stat Line 6878  Intellectual Property and Copyright Stat
6878  <p>  <p>
6879                          </p>                          </p>
6880  <blockquote class="text">  <blockquote class="text">
6881  <p>C: "UNMAP MIDI_INSTRUMENT 2 40 127"  <p>C: "UNMAP MIDI_INSTRUMENT 0 2 127"
6882  </p>  </p>
6883  <p>S: "OK"  <p>S: "OK"
6884  </p>  </p>
# Line 5532  Intellectual Property and Copyright Stat Line 6886  Intellectual Property and Copyright Stat
6886                                            
6887  </p>  </p>
6888  <a name="GET MIDI_INSTRUMENT INFO"></a><br /><hr />  <a name="GET MIDI_INSTRUMENT INFO"></a><br /><hr />
6889  <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>
6890  <a name="rfc.section.6.7.5"></a><h3>6.7.5.&nbsp;Get current settings of MIDI instrument map entry</h3>  <a name="rfc.section.6.7.11"></a><h3>6.7.11.&nbsp;
6891    Get current settings of MIDI instrument map entry</h3>
6892    
6893  <p>The front-end can retrieve the current settings of a certain  <p>The front-end can retrieve the current settings of a certain
6894                      instrument map entry by sending the following command:                      instrument map entry by sending the following command:
# Line 5541  Intellectual Property and Copyright Stat Line 6896  Intellectual Property and Copyright Stat
6896  <p>  <p>
6897                          </p>                          </p>
6898  <blockquote class="text">  <blockquote class="text">
6899  <p>GET MIDI_INSTRUMENT INFO &lt;midi_bank_msb&gt; &lt;midi_bank_lsb&gt; &lt;midi_prog&gt;  <p>GET MIDI_INSTRUMENT INFO &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;
6900  </p>  </p>
6901  </blockquote><p>  </blockquote><p>
6902                                            
6903  </p>  </p>
6904  <p>  <p>
6905                      Where &lt;midi_bank_msb&gt; is an integer value between 0..127                      Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
6906                      reflecting the MIDI bank MSB (coarse) value, &lt;midi_bank_lsb&gt;                      &lt;midi_bank&gt; is an integer value between 0..16383
6907                      an integer value between 0..127 reflecting the MIDI bank LSB                      reflecting the MIDI bank value, &lt;midi_bank&gt;
6908                      (fine) value and &lt;midi_prog&gt; an integer value between                      and &lt;midi_prog&gt; an integer value between
6909                      0..127 reflecting the MIDI program value of the map entrie's key                      0..127 reflecting the MIDI program value of the map's entrie's key
6910                      index triple.                      index triple.
6911                                            
6912  </p>  </p>
# Line 5574  Intellectual Property and Copyright Stat Line 6929  Intellectual Property and Copyright Stat
6929                                      This name shall be used by frontends for displaying a                                      This name shall be used by frontends for displaying a
6930                                      name for this mapped instrument. It can be set and                                      name for this mapped instrument. It can be set and
6931                                      changed with the                                      changed with the
6932                                      <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>                                      <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>
6933                                      command and does not have to be unique.                                      command and does not have to be unique.
6934  </p>  </p>
6935  </blockquote>  </blockquote>
# Line 5619  Intellectual Property and Copyright Stat Line 6974  Intellectual Property and Copyright Stat
6974                                  </p>                                  </p>
6975  <blockquote class="text">  <blockquote class="text">
6976  <p>Life time of instrument  <p>Life time of instrument
6977                                      (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).                                      (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).
6978  </p>  </p>
6979  </blockquote>  </blockquote>
6980                                                            
# Line 5628  Intellectual Property and Copyright Stat Line 6983  Intellectual Property and Copyright Stat
6983                                  </p>                                  </p>
6984  <blockquote class="text">  <blockquote class="text">
6985  <p>master volume of the instrument as optionally  <p>master volume of the instrument as optionally
6986                                      dotted number (where a value < 1.0 means attenuation                                      dotted number (where a value &lt; 1.0 means attenuation
6987                                      and a value > 1.0 means amplification)                                      and a value > 1.0 means amplification)
6988  </p>  </p>
6989  </blockquote>  </blockquote>
# Line 5644  Intellectual Property and Copyright Stat Line 6999  Intellectual Property and Copyright Stat
6999  <p>  <p>
7000                          </p>                          </p>
7001  <blockquote class="text">  <blockquote class="text">
7002  <p>C: "GET MIDI_INSTRUMENT INFO 3 45 120"  <p>C: "GET MIDI_INSTRUMENT INFO 1 45 120"
7003  </p>  </p>
7004  <p>S: "NAME: Drums for Foo Song"  <p>S: "NAME: Drums for Foo Song"
7005  </p>  </p>
# Line 5666  Intellectual Property and Copyright Stat Line 7021  Intellectual Property and Copyright Stat
7021                                            
7022  </p>  </p>
7023  <a name="CLEAR MIDI_INSTRUMENTS"></a><br /><hr />  <a name="CLEAR MIDI_INSTRUMENTS"></a><br /><hr />
7024  <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>
7025  <a name="rfc.section.6.7.6"></a><h3>6.7.6.&nbsp;Clear MIDI instrument map</h3>  <a name="rfc.section.6.7.12"></a><h3>6.7.12.&nbsp;
7026    Clear MIDI instrument map</h3>
7027    
7028  <p>The front-end can clear the whole MIDI instrument map, that  <p>The front-end can clear a whole MIDI instrument map, that
7029                      is delete all entries by sending the following command:                      is delete all its entries by sending the following command:
7030    </p>
7031    <p>
7032                            </p>
7033    <blockquote class="text">
7034    <p>CLEAR MIDI_INSTRUMENTS &lt;map&gt;
7035    </p>
7036    </blockquote><p>
7037                        
7038    </p>
7039    <p>Where &lt;map&gt; is the numeric ID of the map to clear.
7040    </p>
7041    <p>The front-end can clear all MIDI instrument maps, that
7042                        is delete all entries of all maps by sending the following
7043                        command:
7044  </p>  </p>
7045  <p>  <p>
7046                          </p>                          </p>
7047  <blockquote class="text">  <blockquote class="text">
7048  <p>CLEAR MIDI_INSTRUMENTS  <p>CLEAR MIDI_INSTRUMENTS ALL
7049  </p>  </p>
7050  </blockquote><p>  </blockquote><p>
7051                                            
7052  </p>  </p>
7053    <p>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the
7054                        maps, only their entries, thus the map's settings like
7055                        custom name will be preservevd.
7056    </p>
7057  <p>Possible Answers:  <p>Possible Answers:
7058  </p>  </p>
7059  <p>  <p>
# Line 5696  Intellectual Property and Copyright Stat Line 7070  Intellectual Property and Copyright Stat
7070  </blockquote><p>  </blockquote><p>
7071                                            
7072  </p>  </p>
7073  <p>Example:  <p>Examples:
7074    </p>
7075    <p>
7076                           </p>
7077    <blockquote class="text">
7078    <p>C: "CLEAR MIDI_INSTRUMENTS 0"
7079    </p>
7080    <p>S: "OK"
7081    </p>
7082    </blockquote><p>
7083                        
7084  </p>  </p>
7085  <p>  <p>
7086                         </p>                         </p>
7087  <blockquote class="text">  <blockquote class="text">
7088  <p>C: "CLEAR MIDI_INSTRUMENTS"  <p>C: "CLEAR MIDI_INSTRUMENTS ALL"
7089  </p>  </p>
7090  <p>S: "OK"  <p>S: "OK"
7091  </p>  </p>
# Line 5709  Intellectual Property and Copyright Stat Line 7093  Intellectual Property and Copyright Stat
7093                                            
7094  </p>  </p>
7095  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
7096  <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>
7097  <a name="rfc.section.7"></a><h3>7.&nbsp;Command Syntax</h3>  <a name="rfc.section.7"></a><h3>7.&nbsp;
7098    Command Syntax</h3>
7099    
7100  <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>
7101              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>)
7102              where applicable.              where applicable.
7103                            
7104  </p>  </p>
# Line 5771  Intellectual Property and Copyright Stat Line 7156  Intellectual Property and Copyright Stat
7156  <p>command =  <p>command =
7157          </p>          </p>
7158  <blockquote class="text">  <blockquote class="text">
7159  <p>ADD SP CHANNEL  <p>ADD SP add_instruction
7160                                    
7161  </p>  </p>
7162  <p>/ MAP SP map_instruction  <p>/ MAP SP map_instruction
# Line 5796  Intellectual Property and Copyright Stat Line 7181  Intellectual Property and Copyright Stat
7181                                    
7182  </p>  </p>
7183  <p>/ REMOVE SP remove_instruction  <p>/ REMOVE SP remove_instruction
   
7184                                    
7185  </p>  </p>
7186  <p>/ SET SP set_instruction  <p>/ SET SP set_instruction
# Line 5826  Intellectual Property and Copyright Stat Line 7210  Intellectual Property and Copyright Stat
7210  </blockquote><p>  </blockquote><p>
7211    
7212  </p>  </p>
7213    <p>add_instruction =
7214            </p>
7215    <blockquote class="text">
7216    <p>CHANNEL
7217                    
7218    </p>
7219    <p>/ MIDI_INSTRUMENT_MAP
7220                    
7221    </p>
7222    <p>/ MIDI_INSTRUMENT_MAP SP map_name
7223                    
7224    </p>
7225    </blockquote><p>
7226    
7227    </p>
7228  <p>subscribe_event =  <p>subscribe_event =
7229          </p>          </p>
7230  <blockquote class="text">  <blockquote class="text">
7231  <p>CHANNEL_COUNT  <p>AUDIO_OUTPUT_DEVICE_COUNT
7232                    
7233    </p>
7234    <p>/ AUDIO_OUTPUT_DEVICE_INFO
7235                    
7236    </p>
7237    <p>/ MIDI_INPUT_DEVICE_COUNT
7238                    
7239    </p>
7240    <p>/ MIDI_INPUT_DEVICE_INFO
7241                    
7242    </p>
7243    <p>/ CHANNEL_COUNT
7244                                    
7245  </p>  </p>
7246  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
# Line 5844  Intellectual Property and Copyright Stat Line 7255  Intellectual Property and Copyright Stat
7255  <p>/ CHANNEL_INFO  <p>/ CHANNEL_INFO
7256                                    
7257  </p>  </p>
7258    <p>/ FX_SEND_COUNT
7259                    
7260    </p>
7261    <p>/ FX_SEND_INFO
7262                    
7263    </p>
7264    <p>/ MIDI_INSTRUMENT_MAP_COUNT
7265                    
7266    </p>
7267    <p>/ MIDI_INSTRUMENT_MAP_INFO
7268                    
7269    </p>
7270    <p>/ MIDI_INSTRUMENT_COUNT
7271                    
7272    </p>
7273    <p>/ MIDI_INSTRUMENT_INFO
7274                    
7275    </p>
7276  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
7277                                    
7278  </p>  </p>
7279  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
7280                                    
7281  </p>  </p>
7282    <p>/ GLOBAL_INFO
7283                    
7284    </p>
7285  </blockquote><p>  </blockquote><p>
7286    
7287  </p>  </p>
7288  <p>unsubscribe_event =  <p>unsubscribe_event =
7289          </p>          </p>
7290  <blockquote class="text">  <blockquote class="text">
7291  <p>CHANNEL_COUNT  <p>AUDIO_OUTPUT_DEVICE_COUNT
7292                    
7293    </p>
7294    <p>/ AUDIO_OUTPUT_DEVICE_INFO
7295                    
7296    </p>
7297    <p>/ MIDI_INPUT_DEVICE_COUNT
7298                    
7299    </p>
7300    <p>/ MIDI_INPUT_DEVICE_INFO
7301                    
7302    </p>
7303    <p>/ CHANNEL_COUNT
7304                                    
7305  </p>  </p>
7306  <p>/ VOICE_COUNT  <p>/ VOICE_COUNT
# Line 5871  Intellectual Property and Copyright Stat Line 7315  Intellectual Property and Copyright Stat
7315  <p>/ CHANNEL_INFO  <p>/ CHANNEL_INFO
7316                                    
7317  </p>  </p>
7318    <p>/ FX_SEND_COUNT
7319                    
7320    </p>
7321    <p>/ FX_SEND_INFO
7322                    
7323    </p>
7324    <p>/ MIDI_INSTRUMENT_MAP_COUNT
7325                    
7326    </p>
7327    <p>/ MIDI_INSTRUMENT_MAP_INFO
7328                    
7329    </p>
7330    <p>/ MIDI_INSTRUMENT_COUNT
7331                    
7332    </p>
7333    <p>/ MIDI_INSTRUMENT_INFO
7334                    
7335    </p>
7336  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
7337                                    
7338  </p>  </p>
7339  <p>/ TOTAL_VOICE_COUNT  <p>/ TOTAL_VOICE_COUNT
7340                                    
7341  </p>  </p>
7342    <p>/ GLOBAL_INFO
7343                    
7344    </p>
7345  </blockquote><p>  </blockquote><p>
7346    
7347  </p>  </p>
7348  <p>map_instruction =  <p>map_instruction =
7349          </p>          </p>
7350  <blockquote class="text">  <blockquote class="text">
7351  <p>MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value  <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
7352                                    
7353  </p>  </p>
7354  <p>/ MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode  <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
7355                                    
7356  </p>  </p>
7357  <p>/ MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name  <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
7358                                    
7359  </p>  </p>
7360  <p>/ MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name  <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
7361                                    
7362  </p>  </p>
7363  </blockquote><p>  </blockquote><p>
# Line 5901  Intellectual Property and Copyright Stat Line 7366  Intellectual Property and Copyright Stat
7366  <p>unmap_instruction =  <p>unmap_instruction =
7367          </p>          </p>
7368  <blockquote class="text">  <blockquote class="text">
7369  <p>MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog  <p>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
7370                                    
7371  </p>  </p>
7372  </blockquote><p>  </blockquote><p>
# Line 5913  Intellectual Property and Copyright Stat Line 7378  Intellectual Property and Copyright Stat
7378  <p>CHANNEL SP sampler_channel  <p>CHANNEL SP sampler_channel
7379                                    
7380  </p>  </p>
7381    <p>/ MIDI_INSTRUMENT_MAP SP midi_map
7382                    
7383    </p>
7384    <p>/ MIDI_INSTRUMENT_MAP SP ALL
7385                    
7386    </p>
7387  </blockquote><p>  </blockquote><p>
7388    
7389  </p>  </p>
# Line 5997  Intellectual Property and Copyright Stat Line 7468  Intellectual Property and Copyright Stat
7468  <p>/ TOTAL_VOICE_COUNT_MAX  <p>/ TOTAL_VOICE_COUNT_MAX
7469                                    
7470  </p>  </p>
7471  <p>/ MIDI_INSTRUMENTS  <p>/ MIDI_INSTRUMENTS SP midi_map
7472                                    
7473  </p>  </p>
7474  <p>/ MIDI_INSTRUMENT SP INFO SP midi_bank_msb SP midi_bank_lsb SP midi_prog  <p>/ MIDI_INSTRUMENTS SP ALL
7475                    
7476    </p>
7477    <p>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
7478                    
7479    </p>
7480    <p>/ MIDI_INSTRUMENT_MAPS
7481                    
7482    </p>
7483    <p>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
7484                    
7485    </p>
7486    <p>/ FX_SENDS SP sampler_channel
7487                    
7488    </p>
7489    <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
7490                    
7491    </p>
7492    <p>/ VOLUME
7493                                    
7494  </p>  </p>
7495  </blockquote><p>  </blockquote><p>
# Line 6024  Intellectual Property and Copyright Stat Line 7513  Intellectual Property and Copyright Stat
7513  <p>/ CHANNEL SP set_chan_instruction  <p>/ CHANNEL SP set_chan_instruction
7514                                    
7515  </p>  </p>
7516    <p>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
7517                    
7518    </p>
7519    <p>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
7520                    
7521    </p>
7522    <p>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
7523                    
7524    </p>
7525    <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
7526                    
7527    </p>
7528  <p>/ ECHO SP boolean  <p>/ ECHO SP boolean
7529                                    
7530  </p>  </p>
7531    <p>/ VOLUME SP volume_value
7532                    
7533    </p>
7534  </blockquote><p>  </blockquote><p>
7535    
7536  </p>  </p>
# Line 6045  Intellectual Property and Copyright Stat Line 7549  Intellectual Property and Copyright Stat
7549  <p>/ MIDI_INPUT_DEVICE SP string  <p>/ MIDI_INPUT_DEVICE SP string
7550                                    
7551  </p>  </p>
7552    <p>/ FX_SEND SP sampler_channel SP midi_ctrl
7553                    
7554    </p>
7555    <p>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
7556                    
7557    </p>
7558  </blockquote><p>  </blockquote><p>
7559    
7560  </p>  </p>
# Line 6060  Intellectual Property and Copyright Stat Line 7570  Intellectual Property and Copyright Stat
7570  <p>clear_instruction =  <p>clear_instruction =
7571          </p>          </p>
7572  <blockquote class="text">  <blockquote class="text">
7573  <p>MIDI_INSTRUMENTS  <p>MIDI_INSTRUMENTS SP midi_map
7574                    
7575    </p>
7576    <p>/ MIDI_INSTRUMENTS SP ALL
7577                                    
7578  </p>  </p>
7579  </blockquote><p>  </blockquote><p>
# Line 6075  Intellectual Property and Copyright Stat Line 7588  Intellectual Property and Copyright Stat
7588  <p>/ MIDI_INPUT_DEVICE SP number  <p>/ MIDI_INPUT_DEVICE SP number
7589                                    
7590  </p>  </p>
7591    <p>/ FX_SEND SP sampler_channel SP fx_send_id
7592                    
7593    </p>
7594  </blockquote><p>  </blockquote><p>
7595    
7596  </p>  </p>
# Line 6126  Intellectual Property and Copyright Stat Line 7642  Intellectual Property and Copyright Stat
7642  <p>/ SOLO SP sampler_channel SP boolean  <p>/ SOLO SP sampler_channel SP boolean
7643                                    
7644  </p>  </p>
7645    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
7646                    
7647    </p>
7648    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
7649                    
7650    </p>
7651    <p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
7652                    
7653    </p>
7654    </blockquote><p>
7655    
7656    </p>
7657    <p>modal_arg =
7658            </p>
7659    <blockquote class="text">
7660    <p>/* epsilon (empty argument) */
7661                    
7662    </p>
7663    <p>/ NON_MODAL SP
7664                    
7665    </p>
7666  </blockquote><p>  </blockquote><p>
7667    
7668  </p>  </p>
# Line 6174  Intellectual Property and Copyright Stat Line 7711  Intellectual Property and Copyright Stat
7711  <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS  <p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
7712                                    
7713  </p>  </p>
7714  <p>/ MIDI_INSTRUMENTS  <p>/ MIDI_INSTRUMENTS SP midi_map
7715                    
7716    </p>
7717    <p>/ MIDI_INSTRUMENTS SP ALL
7718                    
7719    </p>
7720    <p>/ MIDI_INSTRUMENT_MAPS
7721                    
7722    </p>
7723    <p>/ FX_SENDS SP sampler_channel
7724                                    
7725  </p>  </p>
7726  </blockquote><p>  </blockquote><p>
# Line 6273  Intellectual Property and Copyright Stat Line 7819  Intellectual Property and Copyright Stat
7819  </blockquote><p>  </blockquote><p>
7820    
7821  </p>  </p>
7822  <p>midi_bank_msb =  <p>midi_map =
7823          </p>          </p>
7824  <blockquote class="text">  <blockquote class="text">
7825  <p>number  <p>number
# Line 6282  Intellectual Property and Copyright Stat Line 7828  Intellectual Property and Copyright Stat
7828  </blockquote><p>  </blockquote><p>
7829    
7830  </p>  </p>
7831  <p>midi_bank_lsb =  <p>midi_bank =
7832          </p>          </p>
7833  <blockquote class="text">  <blockquote class="text">
7834  <p>number  <p>number
# Line 6300  Intellectual Property and Copyright Stat Line 7846  Intellectual Property and Copyright Stat
7846  </blockquote><p>  </blockquote><p>
7847    
7848  </p>  </p>
7849    <p>midi_ctrl =
7850            </p>
7851    <blockquote class="text">
7852    <p>number
7853                    
7854    </p>
7855    </blockquote><p>
7856    
7857    </p>
7858  <p>volume_value =  <p>volume_value =
7859          </p>          </p>
7860  <blockquote class="text">  <blockquote class="text">
# Line 6330  Intellectual Property and Copyright Stat Line 7885  Intellectual Property and Copyright Stat
7885  </blockquote><p>  </blockquote><p>
7886    
7887  </p>  </p>
7888    <p>fx_send_id =
7889            </p>
7890    <blockquote class="text">
7891    <p>number
7892                    
7893    </p>
7894    </blockquote><p>
7895    
7896    </p>
7897  <p>engine_name =  <p>engine_name =
7898          </p>          </p>
7899  <blockquote class="text">  <blockquote class="text">
# Line 6348  Intellectual Property and Copyright Stat Line 7912  Intellectual Property and Copyright Stat
7912  </blockquote><p>  </blockquote><p>
7913    
7914  </p>  </p>
7915    <p>map_name =
7916            </p>
7917    <blockquote class="text">
7918    <p>stringval
7919                    
7920    </p>
7921    </blockquote><p>
7922    
7923    </p>
7924  <p>entry_name =  <p>entry_name =
7925          </p>          </p>
7926  <blockquote class="text">  <blockquote class="text">
# Line 6357  Intellectual Property and Copyright Stat Line 7930  Intellectual Property and Copyright Stat
7930  </blockquote><p>  </blockquote><p>
7931    
7932  </p>  </p>
7933    <p>fx_send_name =
7934            </p>
7935    <blockquote class="text">
7936    <p>stringval
7937                    
7938    </p>
7939    </blockquote><p>
7940    
7941    </p>
7942  <p>param_val_list =  <p>param_val_list =
7943          </p>          </p>
7944  <blockquote class="text">  <blockquote class="text">
# Line 6388  Intellectual Property and Copyright Stat Line 7970  Intellectual Property and Copyright Stat
7970    
7971  </p>  </p>
7972  <a name="events"></a><br /><hr />  <a name="events"></a><br /><hr />
7973  <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>
7974  <a name="rfc.section.8"></a><h3>8.&nbsp;Events</h3>  <a name="rfc.section.8"></a><h3>8.&nbsp;
7975    Events</h3>
7976    
7977  <p>This chapter will describe all currently defined events supported by LinuxSampler.  <p>This chapter will describe all currently defined events supported by LinuxSampler.
7978  </p>  </p>
7979  <a name="SUBSCRIBE CHANNEL"></a><br /><hr />  <a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"></a><br /><hr />
7980  <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>
7981  <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;
7982    Number of audio output devices changed</h3>
7983    
7984    <p>Client may want to be notified when the total number of audio output devices on the
7985                    back-end changes by issuing the following command:
7986    </p>
7987    <p>
7988                        </p>
7989    <blockquote class="text">
7990    <p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
7991    </p>
7992    </blockquote><p>
7993                    
7994    </p>
7995    <p>Server will start sending the following notification messages:
7996    </p>
7997    <p>
7998                        </p>
7999    <blockquote class="text">
8000    <p>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"
8001    </p>
8002    </blockquote><p>
8003                    
8004    </p>
8005    <p>where &lt;devices&gt; will be replaced by the new number
8006                    of audio output devices.
8007    </p>
8008    <a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"></a><br /><hr />
8009    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8010    <a name="rfc.section.8.2"></a><h3>8.2.&nbsp;
8011    Audio output device's settings changed</h3>
8012    
8013    <p>Client may want to be notified when changes were made to audio output devices on the
8014                    back-end by issuing the following command:
8015    </p>
8016    <p>
8017                        </p>
8018    <blockquote class="text">
8019    <p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
8020    </p>
8021    </blockquote><p>
8022                    
8023    </p>
8024    <p>Server will start sending the following notification messages:
8025    </p>
8026    <p>
8027                        </p>
8028    <blockquote class="text">
8029    <p>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"
8030    </p>
8031    </blockquote><p>
8032                    
8033    </p>
8034    <p>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
8035                    which settings has been changed. The front-end will have to send
8036                    the respective command to actually get the audio output device info. Because these messages
8037                    will be triggered by LSCP commands issued by other clients rather than real
8038                    time events happening on the server, it is believed that an empty notification
8039                    message is sufficient here.
8040    </p>
8041    <a name="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"></a><br /><hr />
8042    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8043    <a name="rfc.section.8.3"></a><h3>8.3.&nbsp;
8044    Number of MIDI input devices changed</h3>
8045    
8046    <p>Client may want to be notified when the total number of MIDI input devices on the
8047                    back-end changes by issuing the following command:
8048    </p>
8049    <p>
8050                        </p>
8051    <blockquote class="text">
8052    <p>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
8053    </p>
8054    </blockquote><p>
8055                    
8056    </p>
8057    <p>Server will start sending the following notification messages:
8058    </p>
8059    <p>
8060                        </p>
8061    <blockquote class="text">
8062    <p>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"
8063    </p>
8064    </blockquote><p>
8065                    
8066    </p>
8067    <p>where &lt;devices&gt; will be replaced by the new number
8068                    of MIDI input devices.
8069    </p>
8070    <a name="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"></a><br /><hr />
8071    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8072    <a name="rfc.section.8.4"></a><h3>8.4.&nbsp;
8073    MIDI input device's settings changed</h3>
8074    
8075    <p>Client may want to be notified when changes were made to MIDI input devices on the
8076                    back-end by issuing the following command:
8077    </p>
8078    <p>
8079                        </p>
8080    <blockquote class="text">
8081    <p>SUBSCRIBE MIDI_INPUT_DEVICE_INFO
8082    </p>
8083    </blockquote><p>
8084                    
8085    </p>
8086    <p>Server will start sending the following notification messages:
8087    </p>
8088    <p>
8089                        </p>
8090    <blockquote class="text">
8091    <p>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"
8092    </p>
8093    </blockquote><p>
8094                    
8095    </p>
8096    <p>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
8097                    which settings has been changed. The front-end will have to send
8098                    the respective command to actually get the MIDI input device info. Because these messages
8099                    will be triggered by LSCP commands issued by other clients rather than real
8100                    time events happening on the server, it is believed that an empty notification
8101                    message is sufficient here.
8102    </p>
8103    <a name="SUBSCRIBE CHANNEL_COUNT"></a><br /><hr />
8104    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8105    <a name="rfc.section.8.5"></a><h3>8.5.&nbsp;
8106    Number of sampler channels changed</h3>
8107    
8108  <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
8109                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 6422  Intellectual Property and Copyright Stat Line 8130  Intellectual Property and Copyright Stat
8130                  of sampler channels.                  of sampler channels.
8131  </p>  </p>
8132  <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />
8133  <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>
8134  <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;
8135    Number of active voices changed</h3>
8136    
8137  <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
8138                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 6441  Intellectual Property and Copyright Stat Line 8150  Intellectual Property and Copyright Stat
8150  <p>  <p>
8151                      </p>                      </p>
8152  <blockquote class="text">  <blockquote class="text">
8153  <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;  <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"
8154  </p>  </p>
8155  </blockquote><p>  </blockquote><p>
8156                                    
# Line 6451  Intellectual Property and Copyright Stat Line 8160  Intellectual Property and Copyright Stat
8160                  active voices on that channel.                  active voices on that channel.
8161  </p>  </p>
8162  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />  <a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />
8163  <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>
8164  <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;
8165    Number of active disk streams changed</h3>
8166    
8167  <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
8168                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT                  changes by issuing the following command: SUBSCRIBE STREAM_COUNT
# Line 6480  Intellectual Property and Copyright Stat Line 8190  Intellectual Property and Copyright Stat
8190                  active disk streams on that channel.                  active disk streams on that channel.
8191  </p>  </p>
8192  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />  <a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />
8193  <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>
8194  <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;
8195    Disk stream buffer fill state changed</h3>
8196    
8197  <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
8198                  on the back-end changes by issuing the following command:                  on the back-end changes by issuing the following command:
# Line 6506  Intellectual Property and Copyright Stat Line 8217  Intellectual Property and Copyright Stat
8217  </p>  </p>
8218  <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
8219                  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
8220                  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>
8221                  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.
8222  </p>  </p>
8223  <a name="SUBSCRIBE INFO"></a><br /><hr />  <a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr />
8224  <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>
8225  <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;
8226    Channel information changed</h3>
8227    
8228  <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
8229                  back-end by issuing the following command:                  back-end by issuing the following command:
# Line 6541  Intellectual Property and Copyright Stat Line 8253  Intellectual Property and Copyright Stat
8253                  time events happening on the server, it is believed that an empty notification                  time events happening on the server, it is believed that an empty notification
8254                  message is sufficient here.                  message is sufficient here.
8255  </p>  </p>
8256    <a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr />
8257    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8258    <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
8259    Number of effect sends changed</h3>
8260    
8261    <p>Client may want to be notified when the number of effect sends on
8262                    a particular sampler channel is changed by issuing the following command:
8263    </p>
8264    <p>
8265                        </p>
8266    <blockquote class="text">
8267    <p>SUBSCRIBE FX_SEND_COUNT
8268    </p>
8269    </blockquote><p>
8270                    
8271    </p>
8272    <p>Server will start sending the following notification messages:
8273    </p>
8274    <p>
8275                        </p>
8276    <blockquote class="text">
8277    <p>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"
8278    </p>
8279    </blockquote><p>
8280                    
8281    </p>
8282    <p>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
8283                    channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
8284                    be replaced by the new number of effect sends on that channel.
8285    </p>
8286    <a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr />
8287    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8288    <a name="rfc.section.8.11"></a><h3>8.11.&nbsp;
8289    Effect send information changed</h3>
8290    
8291    <p>Client may want to be notified when changes were made to effect sends on a
8292                    a particular sampler channel by issuing the following command:
8293    </p>
8294    <p>
8295                        </p>
8296    <blockquote class="text">
8297    <p>SUBSCRIBE FX_SEND_INFO
8298    </p>
8299    </blockquote><p>
8300                    
8301    </p>
8302    <p>Server will start sending the following notification messages:
8303    </p>
8304    <p>
8305                        </p>
8306    <blockquote class="text">
8307    <p>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"
8308    </p>
8309    </blockquote><p>
8310                    
8311    </p>
8312    <p>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
8313                    channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
8314                    be replaced by the numerical ID of the changed effect send.
8315    </p>
8316  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />  <a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />
8317  <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>
8318  <a name="rfc.section.8.6"></a><h3>8.6.&nbsp;Total number of active voices changed</h3>  <a name="rfc.section.8.12"></a><h3>8.12.&nbsp;
8319    Total number of active voices changed</h3>
8320    
8321  <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
8322                  back-end changes by issuing the following command:                  back-end changes by issuing the following command:
# Line 6561  Intellectual Property and Copyright Stat Line 8334  Intellectual Property and Copyright Stat
8334  <p>  <p>
8335                      </p>                      </p>
8336  <blockquote class="text">  <blockquote class="text">
8337  <p>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;  <p>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"
8338  </p>  </p>
8339  </blockquote><p>  </blockquote><p>
8340                                    
# Line 6569  Intellectual Property and Copyright Stat Line 8342  Intellectual Property and Copyright Stat
8342  <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
8343                  all currently active voices.                  all currently active voices.
8344  </p>  </p>
8345    <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr />
8346    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8347    <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;
8348    Number of MIDI instrument maps changed</h3>
8349    
8350    <p>Client may want to be notified when the number of MIDI instrument maps on the
8351                    back-end changes by issuing the following command:
8352    </p>
8353    <p>
8354                        </p>
8355    <blockquote class="text">
8356    <p>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
8357    </p>
8358    </blockquote><p>
8359                    
8360    </p>
8361    <p>Server will start sending the following notification messages:
8362    </p>
8363    <p>
8364                        </p>
8365    <blockquote class="text">
8366    <p>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"
8367    </p>
8368    </blockquote><p>
8369                    
8370    </p>
8371    <p>where &lt;maps&gt; will be replaced by the new number
8372                    of MIDI instrument maps.
8373    </p>
8374    <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr />
8375    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8376    <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;
8377    MIDI instrument map information changed</h3>
8378    
8379    <p>Client may want to be notified when changes were made to MIDI instrument maps on the
8380                    back-end by issuing the following command:
8381    </p>
8382    <p>
8383                        </p>
8384    <blockquote class="text">
8385    <p>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
8386    </p>
8387    </blockquote><p>
8388                    
8389    </p>
8390    <p>Server will start sending the following notification messages:
8391    </p>
8392    <p>
8393                        </p>
8394    <blockquote class="text">
8395    <p>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"
8396    </p>
8397    </blockquote><p>
8398                    
8399    </p>
8400    <p>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
8401                    for which information changes occurred. The front-end will have to send
8402                    the respective command to actually get the MIDI instrument map info. Because these messages
8403                    will be triggered by LSCP commands issued by other clients rather than real
8404                    time events happening on the server, it is believed that an empty notification
8405                    message is sufficient here.
8406    </p>
8407    <a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr />
8408    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8409    <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;
8410    Number of MIDI instruments changed</h3>
8411    
8412    <p>Client may want to be notified when the number of MIDI instrument maps on the
8413                    back-end changes by issuing the following command:
8414    </p>
8415    <p>
8416                        </p>
8417    <blockquote class="text">
8418    <p>SUBSCRIBE MIDI_INSTRUMENT_COUNT
8419    </p>
8420    </blockquote><p>
8421                    
8422    </p>
8423    <p>Server will start sending the following notification messages:
8424    </p>
8425    <p>
8426                        </p>
8427    <blockquote class="text">
8428    <p>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"
8429    </p>
8430    </blockquote><p>
8431                    
8432    </p>
8433    <p>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
8434                    the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
8435                    the new number of MIDI instruments in the specified map.
8436    </p>
8437    <a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr />
8438    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8439    <a name="rfc.section.8.16"></a><h3>8.16.&nbsp;
8440    MIDI instrument information changed</h3>
8441    
8442    <p>Client may want to be notified when changes were made to MIDI instruments on the
8443                    back-end by issuing the following command:
8444    </p>
8445    <p>
8446                        </p>
8447    <blockquote class="text">
8448    <p>SUBSCRIBE MIDI_INSTRUMENT_INFO
8449    </p>
8450    </blockquote><p>
8451                    
8452    </p>
8453    <p>Server will start sending the following notification messages:
8454    </p>
8455    <p>
8456                        </p>
8457    <blockquote class="text">
8458    <p>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"
8459    </p>
8460    </blockquote><p>
8461                    
8462    </p>
8463    <p>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
8464                    in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
8465                    the location of the changed MIDI instrument in the map. The front-end will have to send
8466                    the respective command to actually get the MIDI instrument info. Because these messages
8467                    will be triggered by LSCP commands issued by other clients rather than real
8468                    time events happening on the server, it is believed that an empty notification
8469                    message is sufficient here.
8470    </p>
8471    <a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr />
8472    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
8473    <a name="rfc.section.8.17"></a><h3>8.17.&nbsp;
8474    Global settings changed</h3>
8475    
8476    <p>Client may want to be notified when changes to the global settings
8477                    of the sampler were made by issuing the following command:
8478    </p>
8479    <p>
8480                        </p>
8481    <blockquote class="text">
8482    <p>SUBSCRIBE GLOBAL_INFO
8483    </p>
8484    </blockquote><p>
8485                    
8486    </p>
8487    <p>Server will start sending the following types of notification messages:
8488    </p>
8489    <p>
8490                        </p>
8491    <blockquote class="text">
8492    <p>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
8493                            golbal volume of the sampler is changed, where &lt;volume&gt; will be
8494                            replaced by the optional dotted floating point value, reflecting the
8495                            new global volume parameter.
8496    </p>
8497    </blockquote><p>
8498                    
8499    </p>
8500  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
8501  <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>
8502  <a name="rfc.section.8.7"></a><h3>8.7.&nbsp;Miscellaneous and debugging events</h3>  <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;
8503    Miscellaneous and debugging events</h3>
8504    
8505  <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
8506                  the server by issuing the following command:                  the server by issuing the following command:
# Line 6598  Intellectual Property and Copyright Stat Line 8527  Intellectual Property and Copyright Stat
8527                  wants to send to the client. Client MAY display this data to the                  wants to send to the client. Client MAY display this data to the
8528                  user AS IS to facilitate debugging.                  user AS IS to facilitate debugging.
8529  </p>  </p>
8530  <a name="anchor15"></a><br /><hr />  <a name="anchor14"></a><br /><hr />
8531  <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>
8532  <a name="rfc.section.9"></a><h3>9.&nbsp;Security Considerations</h3>  <a name="rfc.section.9"></a><h3>9.&nbsp;
8533    Security Considerations</h3>
8534    
8535  <p>As there is so far no method of authentication and authorization  <p>As there is so far no method of authentication and authorization
8536              defined and so not required for a client applications to succeed to              defined and so not required for a client applications to succeed to
8537              connect, running LinuxSampler might be a security risk for the host              connect, running LinuxSampler might be a security risk for the host
8538              system the LinuxSampler instance is running on.              system the LinuxSampler instance is running on.
8539  </p>  </p>
8540  <a name="anchor16"></a><br /><hr />  <a name="anchor15"></a><br /><hr />
8541  <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>
8542  <a name="rfc.section.10"></a><h3>10.&nbsp;Acknowledgments</h3>  <a name="rfc.section.10"></a><h3>10.&nbsp;
8543    Acknowledgments</h3>
8544    
8545  <p>This document has benefited greatly from the comments of the  <p>This document has benefited greatly from the comments of the
8546              following people, discussed on the LinuxSampler developer's mailing              following people, discussed on the LinuxSampler developer's mailing
# Line 6630  Intellectual Property and Copyright Stat Line 8561  Intellectual Property and Copyright Stat
8561                            
8562  </p>  </p>
8563  <a name="rfc.references1"></a><br /><hr />  <a name="rfc.references1"></a><br /><hr />
8564  <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>
8565  <h3>11.&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
8566  <table width="99%" border="0">  <table width="99%" border="0">
8567  <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 6642  Intellectual Property and Copyright Stat Line 8573  Intellectual Property and Copyright Stat
8573  </table>  </table>
8574    
8575  <a name="rfc.authors"></a><br /><hr />  <a name="rfc.authors"></a><br /><hr />
8576  <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>
8577  <h3>Author's Address</h3>  <h3>Author's Address</h3>
8578  <table width="99%" border="0" cellpadding="0" cellspacing="0">  <table width="99%" border="0" cellpadding="0" cellspacing="0">
8579  <tr><td class="author-text">&nbsp;</td>  <tr><td class="author-text">&nbsp;</td>
# Line 6660  Schoenebeck</td></tr> Line 8591  Schoenebeck</td></tr>
8591  <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>
8592  </table>  </table>
8593  <a name="rfc.copyright"></a><br /><hr />  <a name="rfc.copyright"></a><br /><hr />
8594  <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>
8595  <h3>Intellectual Property Statement</h3>  <h3>Full Copyright Statement</h3>
8596  <p class='copyright'>  <p class='copyright'>
8597  The IETF takes no position regarding the validity or scope of  Copyright &copy; The IETF Trust (2007).</p>
 any intellectual property or other rights that might be claimed  
 to  pertain to the implementation or use of the technology  
 described in this document or the extent to which any license  
 under such rights might or might not be available; neither does  
 it represent that it has made any effort to identify any such  
 rights. Information on the IETF's procedures with respect to  
 rights in standards-track and standards-related documentation  
 can be found in BCP&nbsp;11. Copies of claims of rights made  
 available for publication and any assurances of licenses to  
 be made available, or the result of an attempt made  
 to obtain a general license or permission for the use of such  
 proprietary rights by implementors or users of this  
 specification can be obtained from the IETF Secretariat.</p>  
8598  <p class='copyright'>  <p class='copyright'>
8599  The IETF invites any interested party to bring to its  This document is subject to the rights,
8600  attention any copyrights, patents or patent applications, or  licenses and restrictions contained in BCP&nbsp;78,
8601  other proprietary rights which may cover technology that may be  and except as set forth therein,
8602  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>  
8603  <p class='copyright'>  <p class='copyright'>
8604  Copyright &copy; The Internet Society (2006). All Rights Reserved.</p>  This document and the information contained herein are provided
8605    on an &ldquo;AS IS&rdquo; basis and THE CONTRIBUTOR,
8606    THE ORGANIZATION HE/SHE REPRESENTS
8607    OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST
8608    AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES,
8609    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT
8610    THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY
8611    IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
8612    PURPOSE.</p>
8613    <h3>Intellectual Property</h3>
8614  <p class='copyright'>  <p class='copyright'>
8615  This document and translations of it may be copied and furnished to  The IETF takes no position regarding the validity or scope of any
8616  others, and derivative works that comment on or otherwise explain it  Intellectual Property Rights or other rights that might be claimed
8617  or assist in its implementation may be prepared, copied, published and  to pertain to the implementation or use of the technology
8618  distributed, in whole or in part, without restriction of any kind,  described in this document or the extent to which any license
8619  provided that the above copyright notice and this paragraph are  under such rights might or might not be available; nor does it
8620  included on all such copies and derivative works. However, this  represent that it has made any independent effort to identify any
8621  document itself may not be modified in any way, such as by removing  such rights.
8622  the copyright notice or references to the Internet Society or other  Information on the procedures with respect to
8623  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>  
8624  <p class='copyright'>  <p class='copyright'>
8625  The limited permissions granted above are perpetual and will not be  Copies of IPR disclosures made to the IETF Secretariat and any
8626  revoked by the Internet Society or its successors or assignees.</p>  assurances of licenses to be made available,
8627    or the result of an attempt made to obtain a general license or
8628    permission for the use of such proprietary rights by implementers or
8629    users of this specification can be obtained from the IETF on-line IPR
8630    repository at <a href='http://www.ietf.org/ipr'>http://www.ietf.org/ipr</a>.</p>
8631  <p class='copyright'>  <p class='copyright'>
8632  This document and the information contained herein is provided on an  The IETF invites any interested party to bring to its attention
8633  &ldquo;AS IS&rdquo; basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING  any copyrights,
8634  TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING  patents or patent applications,
8635  BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION  or other
8636  HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  proprietary rights that may cover technology that may be required
8637  MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.</p>  to implement this standard.
8638    Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p>
8639  <h3>Acknowledgment</h3>  <h3>Acknowledgment</h3>
8640  <p class='copyright'>  <p class='copyright'>
8641  Funding for the RFC Editor function is currently provided by the  Funding for the RFC Editor function is provided by
8642  Internet Society.</p>  the IETF Administrative Support Activity (IASA).</p>
8643  </body></html>  </body></html>
Legend:
Removed from v.945  
changed lines
  Added in v.1110
  ViewVC Help
Powered by ViewVC