3 |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
4 |
<meta name="description" content="LinuxSampler Control Protocol"> |
<meta name="description" content="LinuxSampler Control Protocol"> |
5 |
<meta name="keywords" content="LSCP"> |
<meta name="keywords" content="LSCP"> |
6 |
<meta name="generator" content="xml2rfc v1.30 (http://xml.resource.org/)"> |
<meta name="generator" content="xml2rfc v1.31 (http://xml.resource.org/)"> |
7 |
<style type='text/css'> |
<style type='text/css'><!-- |
8 |
<!-- |
body { |
9 |
body { |
font-family: verdana, charcoal, helvetica, arial, sans-serif; |
10 |
font-family: verdana, charcoal, helvetica, arial, sans-serif; |
font-size: small; color: #000; background-color: #FFF; |
11 |
margin: 2em; |
margin: 2em; |
12 |
font-size: small ; color: #000000 ; background-color: #ffffff ; } |
} |
13 |
.title { color: #990000; font-size: x-large ; |
h1, h2, h3, h4, h5, h6 { |
14 |
font-weight: bold; text-align: right; |
font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif; |
15 |
font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif; |
font-weight: bold; font-style: normal; |
16 |
background-color: transparent; } |
} |
17 |
.filename { color: #666666; font-size: 18px; line-height: 28px; |
h1 { color: #900; background-color: transparent; text-align: right; } |
18 |
font-weight: bold; text-align: right; |
h3 { color: #333; background-color: transparent; } |
19 |
font-family: helvetica, arial, sans-serif; |
|
20 |
background-color: transparent; } |
td.RFCbug { |
21 |
td.rfcbug { background-color: #000000 ; width: 30px ; height: 30px ; |
font-size: x-small; text-decoration: none; |
22 |
text-align: justify; vertical-align: middle ; padding-top: 2px ; } |
width: 30px; height: 30px; padding-top: 2px; |
23 |
td.rfcbug span.RFC { color: #666666; font-weight: bold; text-decoration: none; |
text-align: justify; vertical-align: middle; |
24 |
background-color: #000000 ; |
background-color: #000; |
25 |
font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif; |
} |
26 |
font-size: x-small ; } |
td.RFCbug span.RFC { |
27 |
td.rfcbug span.hotText { color: #ffffff; font-weight: normal; text-decoration: none; |
font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif; |
28 |
text-align: center ; |
font-weight: bold; color: #666; |
29 |
font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif; |
} |
30 |
font-size: x-small ; background-color: #000000; } |
td.RFCbug span.hotText { |
31 |
/* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */ |
font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif; |
32 |
div#counter{margin-top: 100px} |
font-weight: normal; text-align: center; color: #FFF; |
33 |
|
} |
34 |
a.info{ |
|
35 |
position:relative; /*this is the key*/ |
table.TOCbug { width: 30px; height: 15px; } |
36 |
z-index:24; |
td.TOCbug { |
37 |
text-decoration:none} |
text-align: center; width: 30px; height: 15px; |
38 |
|
color: #FFF; background-color: #900; |
39 |
a.info:hover{z-index:25; background-color:#990000 ; color: #ffffff ;} |
} |
40 |
|
td.TOCbug a { |
41 |
a.info span{display: none} |
font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif; |
42 |
|
font-weight: bold; font-size: x-small; text-decoration: none; |
43 |
a.info:hover span.info{ /*the span will display just on :hover state*/ |
color: #FFF; background-color: transparent; |
44 |
display:block; |
} |
45 |
position:absolute; |
|
46 |
font-size: smaller ; |
td.header { |
47 |
top:2em; left:2em; width:15em; |
font-family: arial, helvetica, sans-serif; font-size: x-small; |
48 |
padding: 2px ; |
vertical-align: top; width: 33%; |
49 |
border:1px solid #333333; |
color: #FFF; background-color: #666; |
50 |
background-color:#eeeeee; color:#990000; |
} |
51 |
text-align: left ;} |
td.author { font-weight: bold; font-size: x-small; margin-left: 4em; } |
52 |
|
td.author-text { font-size: x-small; } |
53 |
A { font-weight: bold; } |
|
54 |
A:link { color: #990000; background-color: transparent ; } |
/* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */ |
55 |
A:visited { color: #333333; background-color: transparent ; } |
a.info { |
56 |
A:active { color: #333333; background-color: transparent ; } |
/* This is the key. */ |
57 |
|
position: relative; |
58 |
p { margin-left: 2em; margin-right: 2em; } |
z-index: 24; |
59 |
p.copyright { font-size: x-small ; } |
text-decoration: none; |
60 |
p.toc { font-size: small ; font-weight: bold ; margin-left: 3em ;} |
} |
61 |
table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; } |
a.info:hover { |
62 |
td.toc { font-size: small; font-weight: bold; vertical-align: text-top; } |
z-index: 25; |
63 |
|
color: #FFF; background-color: #900; |
64 |
span.emph { font-style: italic; } |
} |
65 |
span.strong { font-weight: bold; } |
a.info span { display: none; } |
66 |
span.verb, span.vbare { font-family: "Courier New", Courier, monospace ; } |
a.info:hover span.info { |
67 |
|
/* The span will display just on :hover state. */ |
68 |
span.vemph { font-style: italic; font-family: "Courier New", Courier, monospace ; } |
display: block; |
69 |
span.vstrong { font-weight: bold; font-family: "Courier New", Courier, monospace ; } |
position: absolute; |
70 |
span.vdeluxe { font-weight: bold; font-style: italic; font-family: "Courier New", Courier, monospace ; } |
font-size: smaller; |
71 |
|
top: 2em; left: -5em; width: 15em; |
72 |
ol.text { margin-left: 2em; margin-right: 2em; } |
padding: 2px; border: 1px solid #333; |
73 |
ul.text { margin-left: 2em; margin-right: 2em; } |
color: #900; background-color: #EEE; |
74 |
li { margin-left: 3em; } |
text-align: left; |
75 |
|
} |
76 |
pre { margin-left: 3em; color: #333333; background-color: transparent; |
|
77 |
font-family: "Courier New", Courier, monospace ; font-size: small ; |
a { font-weight: bold; } |
78 |
text-align: left; |
a:link { color: #900; background-color: transparent; } |
79 |
} |
a:visited { color: #633; background-color: transparent; } |
80 |
|
a:active { color: #633; background-color: transparent; } |
81 |
h3 { color: #333333; font-size: medium ; |
|
82 |
font-family: helvetica, arial, sans-serif ; |
p { margin-left: 2em; margin-right: 2em; } |
83 |
background-color: transparent; } |
p.copyright { font-size: x-small; } |
84 |
h4 { font-size: small; font-family: helvetica, arial, sans-serif ; } |
p.toc { font-size: small; font-weight: bold; margin-left: 3em; } |
85 |
|
table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; } |
86 |
table.bug { width: 30px ; height: 15px ; } |
td.toc { font-size: small; font-weight: bold; vertical-align: text-top; } |
87 |
td.bug { color: #ffffff ; background-color: #990000 ; |
|
88 |
text-align: center ; width: 30px ; height: 15px ; |
ol.text { margin-left: 2em; margin-right: 2em; } |
89 |
} |
ul.text { margin-left: 2em; margin-right: 2em; } |
90 |
td.bug A.link2 { color: #ffffff ; font-weight: bold; |
li { margin-left: 3em; } |
91 |
text-decoration: none; |
|
92 |
font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif; |
/* RFC-2629 <spanx>s and <artwork>s. */ |
93 |
font-size: x-small ; background-color: transparent } |
em { font-style: italic; } |
94 |
|
strong { font-weight: bold; } |
95 |
td.header { color: #ffffff; font-size: x-small ; |
dfn { font-weight: bold; font-style: normal; } |
96 |
font-family: arial, helvetica, sans-serif; vertical-align: top; |
cite { font-weight: normal; font-style: normal; } |
97 |
background-color: #666666 ; width: 33% ; } |
tt { color: #036; } |
98 |
td.author { font-weight: bold; margin-left: 4em; font-size: x-small ; } |
tt, pre, pre dfn, pre em, pre cite, pre span { |
99 |
td.author-text { font-size: x-small; } |
font-family: "Courier New", Courier, monospace; font-size: small; |
100 |
table.full { vertical-align: top ; border-collapse: collapse ; |
} |
101 |
border-style: solid solid solid solid ; |
pre { |
102 |
border-color: black black black black ; |
text-align: left; padding: 4px; |
103 |
font-size: small ; text-align: center ; } |
color: #000; background-color: #CCC; |
104 |
table.headers, table.none { vertical-align: top ; border-collapse: collapse ; |
} |
105 |
border-style: none; |
pre dfn { color: #900; } |
106 |
font-size: small ; text-align: center ; } |
pre em { color: #66F; background-color: #FFC; font-weight: normal; } |
107 |
table.full th { font-weight: bold ; |
pre .key { color: #33C; font-weight: bold; } |
108 |
border-style: solid ; |
pre .id { color: #900; } |
109 |
border-color: black black black black ; } |
pre .str { color: #000; background-color: #CFF; } |
110 |
table.headers th { font-weight: bold ; |
pre .val { color: #066; } |
111 |
border-style: none none solid none; |
pre .rep { color: #909; } |
112 |
border-color: black black black black ; } |
pre .oth { color: #000; background-color: #FCF; } |
113 |
table.none th { font-weight: bold ; |
pre .err { background-color: #FCC; } |
114 |
border-style: none; } |
|
115 |
table.full td { |
/* RFC-2629 <texttable>s. */ |
116 |
border-style: solid solid solid solid ; |
table.full, table.headers, table.none { |
117 |
border-color: #333333 #333333 #333333 #333333 ; } |
font-size: small; text-align: center; border-width: 2px; |
118 |
table.headers td, table.none td { border-style: none; } |
vertical-align: top; border-collapse: collapse; |
119 |
|
} |
120 |
hr { height: 1px } |
table.full { border-style: solid; border-color: black; } |
121 |
--> |
table.headers, table.none { border-style: none; } |
122 |
</style> |
th { |
123 |
|
font-weight: bold; border-color: black; |
124 |
|
border-width: 2px 2px 3px 2px; |
125 |
|
} |
126 |
|
table.full th { border-style: solid; } |
127 |
|
table.headers th { border-style: none none solid none; } |
128 |
|
table.none th { border-style: none; } |
129 |
|
table.full td { |
130 |
|
border-style: solid; border-color: #333; |
131 |
|
border-width: 1px 2px; |
132 |
|
} |
133 |
|
table.headers td, table.none td { border-style: none; } |
134 |
|
|
135 |
|
hr { height: 1px; } |
136 |
|
hr.insert { |
137 |
|
width: 80%; border-style: none; border-width: 0; |
138 |
|
color: #CCC; background-color: #CCC; |
139 |
|
} |
140 |
|
--></style> |
141 |
</head> |
</head> |
142 |
<body> |
<body> |
143 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </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"> </td><td class="header">November 26, 2006</td></tr> |
<tr><td class="header">Expires: July 2, 2007</td><td class="header">December 29, 2006</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 10 of RFC 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 6 of BCP 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. |
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 July 2, 2007.</p> |
177 |
|
|
178 |
<h3>Copyright Notice</h3> |
<h3>Copyright Notice</h3> |
179 |
<p> |
<p> |
180 |
Copyright © The Internet Society (2006). All Rights Reserved.</p> |
Copyright © The Internet Society (2006).</p> |
181 |
|
|
182 |
<h3>Abstract</h3> |
<h3>Abstract</h3> |
183 |
|
|
298 |
Current fill state of disk stream buffers<br /> |
Current fill state of disk stream buffers<br /> |
299 |
<a href="#SET CHANNEL AUDIO_OUTPUT_DEVICE">6.4.14.</a> |
<a href="#SET CHANNEL AUDIO_OUTPUT_DEVICE">6.4.14.</a> |
300 |
Setting audio output device<br /> |
Setting audio output device<br /> |
301 |
<a href="#SET CHANNEL AUDIO_OUTPUT_TYP">6.4.15.</a> |
<a href="#SET CHANNEL AUDIO_OUTPUT_TYPE">6.4.15.</a> |
302 |
Setting audio output type<br /> |
Setting audio output type<br /> |
303 |
<a href="#SET CHANNEL AUDIO_OUTPUT_CHANNEL">6.4.16.</a> |
<a href="#SET CHANNEL AUDIO_OUTPUT_CHANNEL">6.4.16.</a> |
304 |
Setting audio output channel<br /> |
Setting audio output channel<br /> |
316 |
Muting a sampler channel<br /> |
Muting a sampler channel<br /> |
317 |
<a href="#SET CHANNEL SOLO">6.4.23.</a> |
<a href="#SET CHANNEL SOLO">6.4.23.</a> |
318 |
Soloing a sampler channel<br /> |
Soloing a sampler channel<br /> |
319 |
<a href="#RESET CHANNEL">6.4.24.</a> |
<a href="#SET CHANNEL MIDI_INSTRUMENT_MAP">6.4.24.</a> |
320 |
|
Assigning a MIDI instrument map to a sampler channel<br /> |
321 |
|
<a href="#CREATE FX_SEND">6.4.25.</a> |
322 |
|
Adding an effect send to a sampler channel<br /> |
323 |
|
<a href="#DESTROY FX_SEND">6.4.26.</a> |
324 |
|
Removing an effect send from a sampler channel<br /> |
325 |
|
<a href="#GET FX_SENDS">6.4.27.</a> |
326 |
|
Getting amount of effect sends on a sampler channel<br /> |
327 |
|
<a href="#LIST FX_SENDS">6.4.28.</a> |
328 |
|
Listing all effect sends on a sampler channel<br /> |
329 |
|
<a href="#GET FX_SEND INFO">6.4.29.</a> |
330 |
|
Getting effect send information<br /> |
331 |
|
<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.30.</a> |
332 |
|
Altering effect send's audio routing<br /> |
333 |
|
<a href="#RESET CHANNEL">6.4.31.</a> |
334 |
Resetting a sampler channel<br /> |
Resetting a sampler channel<br /> |
335 |
<a href="#anchor12">6.5.</a> |
<a href="#anchor12">6.5.</a> |
336 |
Controlling connection<br /> |
Controlling connection<br /> |
352 |
Reset sampler<br /> |
Reset sampler<br /> |
353 |
<a href="#GET SERVER INFO">6.6.4.</a> |
<a href="#GET SERVER INFO">6.6.4.</a> |
354 |
General sampler informations<br /> |
General sampler informations<br /> |
355 |
<a href="#anchor14">6.7.</a> |
<a href="#GET VOLUME">6.6.5.</a> |
356 |
|
Getting global volume attenuation<br /> |
357 |
|
<a href="#SET VOLUME">6.6.6.</a> |
358 |
|
Setting global volume attenuation<br /> |
359 |
|
<a href="#MIDI Instrument Mapping">6.7.</a> |
360 |
MIDI Instrument Mapping<br /> |
MIDI Instrument Mapping<br /> |
361 |
<a href="#MAP MIDI_INSTRUMENT">6.7.1.</a> |
<a href="#ADD MIDI_INSTRUMENT MAP">6.7.1.</a> |
362 |
|
Create a new MIDI instrument map<br /> |
363 |
|
<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a> |
364 |
|
Delete one particular or all MIDI instrument maps<br /> |
365 |
|
<a href="#GET MIDI_INSTRUMENT_MAPS">6.7.3.</a> |
366 |
|
Get amount of existing MIDI instrument maps<br /> |
367 |
|
<a href="#LIST MIDI_INSTRUMENT_MAPS">6.7.4.</a> |
368 |
|
Getting all created MIDI instrument maps<br /> |
369 |
|
<a href="#GET MIDI_INSTRUMENT_MAP INFO">6.7.5.</a> |
370 |
|
Getting MIDI instrument map information<br /> |
371 |
|
<a href="#SET MIDI_INSTRUMENT_MAP NAME">6.7.6.</a> |
372 |
|
Renaming a MIDI instrument map<br /> |
373 |
|
<a href="#MAP MIDI_INSTRUMENT">6.7.7.</a> |
374 |
Create or replace a MIDI instrument map entry<br /> |
Create or replace a MIDI instrument map entry<br /> |
375 |
<a href="#GET MIDI_INSTRUMENTS">6.7.2.</a> |
<a href="#GET MIDI_INSTRUMENTS">6.7.8.</a> |
376 |
Getting ammount of MIDI instrument map entries<br /> |
Getting ammount of MIDI instrument map entries<br /> |
377 |
<a href="#LIST MIDI_INSTRUMENTS">6.7.3.</a> |
<a href="#LIST MIDI_INSTRUMENTS">6.7.9.</a> |
378 |
Getting indeces of all MIDI instrument map entries<br /> |
Getting indeces of all entries of a MIDI instrument map<br /> |
379 |
<a href="#UNMAP MIDI_INSTRUMENT">6.7.4.</a> |
<a href="#UNMAP MIDI_INSTRUMENT">6.7.10.</a> |
380 |
Remove an entry from the MIDI instrument map<br /> |
Remove an entry from the MIDI instrument map<br /> |
381 |
<a href="#GET MIDI_INSTRUMENT INFO">6.7.5.</a> |
<a href="#GET MIDI_INSTRUMENT INFO">6.7.11.</a> |
382 |
Get current settings of MIDI instrument map entry<br /> |
Get current settings of MIDI instrument map entry<br /> |
383 |
<a href="#CLEAR MIDI_INSTRUMENTS">6.7.6.</a> |
<a href="#CLEAR MIDI_INSTRUMENTS">6.7.12.</a> |
384 |
Clear MIDI instrument map<br /> |
Clear MIDI instrument map<br /> |
385 |
<a href="#command_syntax">7.</a> |
<a href="#command_syntax">7.</a> |
386 |
Command Syntax<br /> |
Command Syntax<br /> |
387 |
<a href="#events">8.</a> |
<a href="#events">8.</a> |
388 |
Events<br /> |
Events<br /> |
389 |
<a href="#SUBSCRIBE CHANNEL">8.1.</a> |
<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a> |
390 |
|
Number of audio output devices changed<br /> |
391 |
|
<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">8.2.</a> |
392 |
|
Audio output device's settings changed<br /> |
393 |
|
<a href="#SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">8.3.</a> |
394 |
|
Number of MIDI input devices changed<br /> |
395 |
|
<a href="#SUBSCRIBE MIDI_INPUT_DEVICE_INFO">8.4.</a> |
396 |
|
MIDI input device's settings changed<br /> |
397 |
|
<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a> |
398 |
Number of sampler channels changed<br /> |
Number of sampler channels changed<br /> |
399 |
<a href="#SUBSCRIBE VOICE_COUNT">8.2.</a> |
<a href="#SUBSCRIBE VOICE_COUNT">8.6.</a> |
400 |
Number of active voices changed<br /> |
Number of active voices changed<br /> |
401 |
<a href="#SUBSCRIBE STREAM_COUNT">8.3.</a> |
<a href="#SUBSCRIBE STREAM_COUNT">8.7.</a> |
402 |
Number of active disk streams changed<br /> |
Number of active disk streams changed<br /> |
403 |
<a href="#SUBSCRIBE BUFFER_FILL">8.4.</a> |
<a href="#SUBSCRIBE BUFFER_FILL">8.8.</a> |
404 |
Disk stream buffer fill state changed<br /> |
Disk stream buffer fill state changed<br /> |
405 |
<a href="#SUBSCRIBE INFO">8.5.</a> |
<a href="#SUBSCRIBE CHANNEL_INFO">8.9.</a> |
406 |
Channel information changed<br /> |
Channel information changed<br /> |
407 |
<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.6.</a> |
<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.10.</a> |
408 |
Total number of active voices changed<br /> |
Total number of active voices changed<br /> |
409 |
<a href="#SUBSCRIBE MISCELLANEOUS">8.7.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.11.</a> |
410 |
|
Number of MIDI instrument maps changed<br /> |
411 |
|
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.12.</a> |
412 |
|
MIDI instrument map information changed<br /> |
413 |
|
<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.13.</a> |
414 |
|
Number of MIDI instruments changed<br /> |
415 |
|
<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.14.</a> |
416 |
|
MIDI instrument information changed<br /> |
417 |
|
<a href="#SUBSCRIBE MISCELLANEOUS">8.15.</a> |
418 |
Miscellaneous and debugging events<br /> |
Miscellaneous and debugging events<br /> |
419 |
<a href="#anchor15">9.</a> |
<a href="#anchor14">9.</a> |
420 |
Security Considerations<br /> |
Security Considerations<br /> |
421 |
<a href="#anchor16">10.</a> |
<a href="#anchor15">10.</a> |
422 |
Acknowledgments<br /> |
Acknowledgments<br /> |
423 |
<a href="#rfc.references1">11.</a> |
<a href="#rfc.references1">11.</a> |
424 |
References<br /> |
References<br /> |
430 |
<br clear="all" /> |
<br clear="all" /> |
431 |
|
|
432 |
<a name="anchor1"></a><br /><hr /> |
<a name="anchor1"></a><br /><hr /> |
433 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
434 |
<a name="rfc.section.1"></a><h3>1. Requirements notation</h3> |
<a name="rfc.section.1"></a><h3>1. |
435 |
|
Requirements notation</h3> |
436 |
|
|
437 |
<p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", |
<p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", |
438 |
"SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", |
"SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", |
439 |
and "OPTIONAL" in this document are to be interpreted as |
and "OPTIONAL" in this document are to be interpreted as |
440 |
described in <a class="info" href="#RFC2119">[RFC2119]<span> (</span><span class="info">Bradner, S., “Key words for use in RFCs to Indicate Requirement Levels,” 1997.</span><span>)</span></a>. |
described in <a class='info' href='#RFC2119'>[RFC2119]<span> (</span><span class='info'>Bradner, S., “Key words for use in RFCs to Indicate Requirement Levels,” 1997.</span><span>)</span></a>. |
441 |
</p> |
</p> |
442 |
<p>This protocol is always case-sensitive if not explicitly |
<p>This protocol is always case-sensitive if not explicitly |
443 |
claimed the opposite. |
claimed the opposite. |
513 |
return and line feed characters respectively. |
return and line feed characters respectively. |
514 |
</p> |
</p> |
515 |
<a name="LSCP versioning"></a><br /><hr /> |
<a name="LSCP versioning"></a><br /><hr /> |
516 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
517 |
<a name="rfc.section.2"></a><h3>2. Versioning of this specification</h3> |
<a name="rfc.section.2"></a><h3>2. |
518 |
|
Versioning of this specification</h3> |
519 |
|
|
520 |
<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 |
521 |
release of the LSCP specification will be tagged with a unique version |
release of the LSCP specification will be tagged with a unique version |
558 |
<p> |
<p> |
559 |
Compatibility can only be claimed if both rules are true. |
Compatibility can only be claimed if both rules are true. |
560 |
The frontend can use the |
The frontend can use the |
561 |
<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 |
562 |
get the version of the LSCP specification the sampler complies with. |
get the version of the LSCP specification the sampler complies with. |
563 |
|
|
564 |
</p> |
</p> |
565 |
<a name="anchor2"></a><br /><hr /> |
<a name="anchor2"></a><br /><hr /> |
566 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
567 |
<a name="rfc.section.3"></a><h3>3. Introduction</h3> |
<a name="rfc.section.3"></a><h3>3. |
568 |
|
Introduction</h3> |
569 |
|
|
570 |
<p>LinuxSampler is a so called software sampler application |
<p>LinuxSampler is a so called software sampler application |
571 |
capable to playback audio samples from a computer's Random |
capable to playback audio samples from a computer's Random |
585 |
there. |
there. |
586 |
</p> |
</p> |
587 |
<a name="anchor3"></a><br /><hr /> |
<a name="anchor3"></a><br /><hr /> |
588 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
589 |
<a name="rfc.section.4"></a><h3>4. Focus of this protocol</h3> |
<a name="rfc.section.4"></a><h3>4. |
590 |
|
Focus of this protocol</h3> |
591 |
|
|
592 |
<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 |
593 |
a running LinuxSampler instance and to retrieve information |
a running LinuxSampler instance and to retrieve information |
598 |
via MIDI System Exclusive Messages. |
via MIDI System Exclusive Messages. |
599 |
</p> |
</p> |
600 |
<a name="anchor4"></a><br /><hr /> |
<a name="anchor4"></a><br /><hr /> |
601 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
602 |
<a name="rfc.section.5"></a><h3>5. Communication Overview</h3> |
<a name="rfc.section.5"></a><h3>5. |
603 |
|
Communication Overview</h3> |
604 |
|
|
605 |
<p>There are two distinct methods of communication between a |
<p>There are two distinct methods of communication between a |
606 |
running instance of LinuxSampler and one or more control |
running instance of LinuxSampler and one or more control |
614 |
methods will be described next. |
methods will be described next. |
615 |
</p> |
</p> |
616 |
<a name="anchor5"></a><br /><hr /> |
<a name="anchor5"></a><br /><hr /> |
617 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
618 |
<a name="rfc.section.5.1"></a><h3>5.1. Request/response communication method</h3> |
<a name="rfc.section.5.1"></a><h3>5.1. |
619 |
|
Request/response communication method</h3> |
620 |
|
|
621 |
<p>This simple communication method is based on |
<p>This simple communication method is based on |
622 |
<a class="info" href="#RFC793">TCP<span> (</span><span class="info">Defense Advanced Research Projects Agency, “TRANSMISSION CONTROL PROTOCOL,” 1981.</span><span>)</span></a> [RFC793]. The |
<a class='info' href='#RFC793'>TCP<span> (</span><span class='info'>Defense Advanced Research Projects Agency, “TRANSMISSION CONTROL PROTOCOL,” 1981.</span><span>)</span></a> [RFC793]. The |
623 |
front-end application establishes a TCP connection to the |
front-end application establishes a TCP connection to the |
624 |
LinuxSampler instance on a certain host system. Then the |
LinuxSampler instance on a certain host system. Then the |
625 |
front-end application will send certain ASCII based commands |
front-end application will send certain ASCII based commands |
660 |
MUST be sent back in the same order. |
MUST be sent back in the same order. |
661 |
</p> |
</p> |
662 |
<a name="anchor6"></a><br /><hr /> |
<a name="anchor6"></a><br /><hr /> |
663 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
664 |
<a name="rfc.section.5.1.1"></a><h3>5.1.1. Result format</h3> |
<a name="rfc.section.5.1.1"></a><h3>5.1.1. |
665 |
|
Result format</h3> |
666 |
|
|
667 |
<p>Result set could be one of the following types: |
<p>Result set could be one of the following types: |
668 |
</p> |
</p> |
853 |
|
|
854 |
</p> |
</p> |
855 |
<a name="anchor7"></a><br /><hr /> |
<a name="anchor7"></a><br /><hr /> |
856 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
857 |
<a name="rfc.section.5.2"></a><h3>5.2. Subscribe/notify communication method</h3> |
<a name="rfc.section.5.2"></a><h3>5.2. |
858 |
|
Subscribe/notify communication method</h3> |
859 |
|
|
860 |
<p>This more sophisticated communication method is actually |
<p>This more sophisticated communication method is actually |
861 |
only an extension of the simple request/response |
only an extension of the simple request/response |
932 |
</p> |
</p> |
933 |
<p>where <event-id> will be replace by the respective |
<p>where <event-id> will be replace by the respective |
934 |
event that client is no longer interested in receiving. For |
event that client is no longer interested in receiving. For |
935 |
a list of supported events see <a class="info" href="#events">Section 8<span> (</span><span class="info">Events</span><span>)</span></a>. |
a list of supported events see <a class='info' href='#events'>Section 8<span> (</span><span class='info'>Events</span><span>)</span></a>. |
936 |
</p> |
</p> |
937 |
<p>Example: the fill states of disk stream buffers have |
<p>Example: the fill states of disk stream buffers have |
938 |
changed on sampler channel 4 and the LinuxSampler instance |
changed on sampler channel 4 and the LinuxSampler instance |
978 |
it wants to receive. |
it wants to receive. |
979 |
</p> |
</p> |
980 |
<a name="control_commands"></a><br /><hr /> |
<a name="control_commands"></a><br /><hr /> |
981 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
982 |
<a name="rfc.section.6"></a><h3>6. Description for control commands</h3> |
<a name="rfc.section.6"></a><h3>6. |
983 |
|
Description for control commands</h3> |
984 |
|
|
985 |
<p>This chapter will describe the available control commands |
<p>This chapter will describe the available control commands |
986 |
that can be sent on the TCP connection in detail. Some certain |
that can be sent on the TCP connection in detail. Some certain |
987 |
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> |
988 |
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 |
989 |
multiple-line responses. In this case LinuxSampler signals the |
multiple-line responses. In this case LinuxSampler signals the |
990 |
end of the response by a "." (single dot) line. |
end of the response by a "." (single dot) line. |
991 |
</p> |
</p> |
992 |
<a name="anchor8"></a><br /><hr /> |
<a name="anchor8"></a><br /><hr /> |
993 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
994 |
<a name="rfc.section.6.1"></a><h3>6.1. Ignored lines and comments</h3> |
<a name="rfc.section.6.1"></a><h3>6.1. |
995 |
|
Ignored lines and comments</h3> |
996 |
|
|
997 |
<p>White lines, that is lines which only contain space and |
<p>White lines, that is lines which only contain space and |
998 |
tabulator characters, and lines that start with a "#" |
tabulator characters, and lines that start with a "#" |
1001 |
file. |
file. |
1002 |
</p> |
</p> |
1003 |
<a name="anchor9"></a><br /><hr /> |
<a name="anchor9"></a><br /><hr /> |
1004 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
1005 |
<a name="rfc.section.6.2"></a><h3>6.2. Configuring audio drivers</h3> |
<a name="rfc.section.6.2"></a><h3>6.2. |
1006 |
|
Configuring audio drivers</h3> |
1007 |
|
|
1008 |
<p>Instances of drivers in LinuxSampler are called devices. |
<p>Instances of drivers in LinuxSampler are called devices. |
1009 |
You can use multiple audio devices simultaneously, e.g. to |
You can use multiple audio devices simultaneously, e.g. to |
1037 |
possible values, etc. |
possible values, etc. |
1038 |
</p> |
</p> |
1039 |
<a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr /> |
<a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr /> |
1040 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
1041 |
<a name="rfc.section.6.2.1"></a><h3>6.2.1. Getting amount of available audio output drivers</h3> |
<a name="rfc.section.6.2.1"></a><h3>6.2.1. |
1042 |
|
Getting amount of available audio output drivers</h3> |
1043 |
|
|
1044 |
<p>Use the following command to get the number of |
<p>Use the following command to get the number of |
1045 |
audio output drivers currently available for the |
audio output drivers currently available for the |
1077 |
|
|
1078 |
</p> |
</p> |
1079 |
<a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr /> |
<a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr /> |
1080 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
1081 |
<a name="rfc.section.6.2.2"></a><h3>6.2.2. Getting all available audio output drivers</h3> |
<a name="rfc.section.6.2.2"></a><h3>6.2.2. |
1082 |
|
Getting all available audio output drivers</h3> |
1083 |
|
|
1084 |
<p>Use the following command to list all audio output |
<p>Use the following command to list all audio output |
1085 |
drivers currently available for the LinuxSampler |
drivers currently available for the LinuxSampler |
1118 |
|
|
1119 |
</p> |
</p> |
1120 |
<a name="GET AUDIO_OUTPUT_DRIVER INFO"></a><br /><hr /> |
<a name="GET AUDIO_OUTPUT_DRIVER INFO"></a><br /><hr /> |
1121 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
1122 |
<a name="rfc.section.6.2.3"></a><h3>6.2.3. Getting information about a specific audio |
<a name="rfc.section.6.2.3"></a><h3>6.2.3. |
1123 |
|
Getting information about a specific audio |
1124 |
output driver</h3> |
output driver</h3> |
1125 |
|
|
1126 |
<p>Use the following command to get detailed information |
<p>Use the following command to get detailed information |
1137 |
</p> |
</p> |
1138 |
<p>Where <audio-output-driver> is the name of the |
<p>Where <audio-output-driver> is the name of the |
1139 |
audio output driver, returned by the |
audio output driver, returned by the |
1140 |
<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. |
1141 |
</p> |
</p> |
1142 |
<p>Possible Answers: |
<p>Possible Answers: |
1143 |
</p> |
</p> |
1218 |
|
|
1219 |
</p> |
</p> |
1220 |
<a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"></a><br /><hr /> |
<a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"></a><br /><hr /> |
1221 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
1222 |
<a name="rfc.section.6.2.4"></a><h3>6.2.4. Getting information about specific audio |
<a name="rfc.section.6.2.4"></a><h3>6.2.4. |
1223 |
|
Getting information about specific audio |
1224 |
output driver parameter</h3> |
output driver parameter</h3> |
1225 |
|
|
1226 |
<p>Use the following command to get detailed information |
<p>Use the following command to get detailed information |
1235 |
|
|
1236 |
</p> |
</p> |
1237 |
<p>Where <audio> is the name of the audio output |
<p>Where <audio> is the name of the audio output |
1238 |
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, |
1239 |
<prm> a specific parameter name for which information should be |
<prm> a specific parameter name for which information should be |
1240 |
obtained (as returned by the |
obtained (as returned by the |
1241 |
<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 |
1242 |
<deplist> is an optional list of parameters on which the sought |
<deplist> is an optional list of parameters on which the sought |
1243 |
parameter <prm> depends on, <deplist> is a list of key-value |
parameter <prm> depends on, <deplist> is a list of key-value |
1244 |
pairs in form of "key1=val1 key2=val2 ...", where character string values |
pairs in form of "key1=val1 key2=val2 ...", where character string values |
1295 |
<blockquote class="text"> |
<blockquote class="text"> |
1296 |
<p>either true or false, defines if this parameter must be |
<p>either true or false, defines if this parameter must be |
1297 |
given when the device is to be created with the |
given when the device is to be created with the |
1298 |
<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> |
1299 |
command (always returned, no matter which driver parameter) |
command (always returned, no matter which driver parameter) |
1300 |
</p> |
</p> |
1301 |
</blockquote> |
</blockquote> |
1306 |
<blockquote class="text"> |
<blockquote class="text"> |
1307 |
<p>either true or false, if false then this parameter can |
<p>either true or false, if false then this parameter can |
1308 |
be changed at any time, once the device is created by |
be changed at any time, once the device is created by |
1309 |
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> |
1310 |
command (always returned, no matter which driver parameter) |
command (always returned, no matter which driver parameter) |
1311 |
</p> |
</p> |
1312 |
</blockquote> |
</blockquote> |
1345 |
<blockquote class="text"> |
<blockquote class="text"> |
1346 |
<p>reflects the default value for this parameter which is |
<p>reflects the default value for this parameter which is |
1347 |
used when the device is created and not explicitly |
used when the device is created and not explicitly |
1348 |
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, |
1349 |
in case of MULTIPLCITY=true, this is a comma separated |
in case of MULTIPLCITY=true, this is a comma separated |
1350 |
list, that's why character strings are encapsulated into |
list, that's why character strings are encapsulated into |
1351 |
apostrophes (') |
apostrophes (') |
1473 |
|
|
1474 |
</p> |
</p> |
1475 |
<a name="CREATE AUDIO_OUTPUT_DEVICE"></a><br /><hr /> |
<a name="CREATE AUDIO_OUTPUT_DEVICE"></a><br /><hr /> |
1476 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
1477 |
<a name="rfc.section.6.2.5"></a><h3>6.2.5. Creating an audio output device</h3> |
<a name="rfc.section.6.2.5"></a><h3>6.2.5. |
1478 |
|
Creating an audio output device</h3> |
1479 |
|
|
1480 |
<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: |
1481 |
</p> |
</p> |
1489 |
</p> |
</p> |
1490 |
<p>Where <audio-output-driver> should be replaced by the desired audio |
<p>Where <audio-output-driver> should be replaced by the desired audio |
1491 |
output system as returned by the |
output system as returned by the |
1492 |
<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> |
1493 |
command and <param-list> by an optional list of driver |
command and <param-list> by an optional list of driver |
1494 |
specific parameters in form of "key1=val1 key2=val2 ...", where |
specific parameters in form of "key1=val1 key2=val2 ...", where |
1495 |
character string values should be encapsulated into apostrophes ('). |
character string values should be encapsulated into apostrophes ('). |
1558 |
|
|
1559 |
</p> |
</p> |
1560 |
<a name="DESTROY AUDIO_OUTPUT_DEVICE"></a><br /><hr /> |
<a name="DESTROY AUDIO_OUTPUT_DEVICE"></a><br /><hr /> |
1561 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
1562 |
<a name="rfc.section.6.2.6"></a><h3>6.2.6. Destroying an audio output device</h3> |
<a name="rfc.section.6.2.6"></a><h3>6.2.6. |
1563 |
|
Destroying an audio output device</h3> |
1564 |
|
|
1565 |
<p>Use the following command to destroy a created output device: |
<p>Use the following command to destroy a created output device: |
1566 |
</p> |
</p> |
1574 |
</p> |
</p> |
1575 |
<p>Where <device-id> should be replaced by the numerical ID of the |
<p>Where <device-id> should be replaced by the numerical ID of the |
1576 |
audio output device as given by the |
audio output device as given by the |
1577 |
<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> |
1578 |
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> |
1579 |
command. |
command. |
1580 |
</p> |
</p> |
1581 |
<p>Possible Answers: |
<p>Possible Answers: |
1628 |
|
|
1629 |
</p> |
</p> |
1630 |
<a name="GET AUDIO_OUTPUT_DEVICES"></a><br /><hr /> |
<a name="GET AUDIO_OUTPUT_DEVICES"></a><br /><hr /> |
1631 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
1632 |
<a name="rfc.section.6.2.7"></a><h3>6.2.7. Getting all created audio output device count</h3> |
<a name="rfc.section.6.2.7"></a><h3>6.2.7. |
1633 |
|
Getting all created audio output device count</h3> |
1634 |
|
|
1635 |
<p>Use the following command to count all created audio output devices: |
<p>Use the following command to count all created audio output devices: |
1636 |
</p> |
</p> |
1666 |
|
|
1667 |
</p> |
</p> |
1668 |
<a name="LIST AUDIO_OUTPUT_DEVICES"></a><br /><hr /> |
<a name="LIST AUDIO_OUTPUT_DEVICES"></a><br /><hr /> |
1669 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
1670 |
<a name="rfc.section.6.2.8"></a><h3>6.2.8. Getting all created audio output device list</h3> |
<a name="rfc.section.6.2.8"></a><h3>6.2.8. |
1671 |
|
Getting all created audio output device list</h3> |
1672 |
|
|
1673 |
<p>Use the following command to list all created audio output devices: |
<p>Use the following command to list all created audio output devices: |
1674 |
</p> |
</p> |
1704 |
|
|
1705 |
</p> |
</p> |
1706 |
<a name="GET AUDIO_OUTPUT_DEVICE INFO"></a><br /><hr /> |
<a name="GET AUDIO_OUTPUT_DEVICE INFO"></a><br /><hr /> |
1707 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
1708 |
<a name="rfc.section.6.2.9"></a><h3>6.2.9. Getting current settings of an audio output device</h3> |
<a name="rfc.section.6.2.9"></a><h3>6.2.9. |
1709 |
|
Getting current settings of an audio output device</h3> |
1710 |
|
|
1711 |
<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: |
1712 |
</p> |
</p> |
1720 |
</p> |
</p> |
1721 |
<p>Where <device-id> should be replaced by numerical ID |
<p>Where <device-id> should be replaced by numerical ID |
1722 |
of the audio output device as e.g. returned by the |
of the audio output device as e.g. returned by the |
1723 |
<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. |
1724 |
</p> |
</p> |
1725 |
<p>Possible Answers: |
<p>Possible Answers: |
1726 |
</p> |
</p> |
1740 |
<blockquote class="text"> |
<blockquote class="text"> |
1741 |
<p>identifier of the used audio output driver, as also |
<p>identifier of the used audio output driver, as also |
1742 |
returned by the |
returned by the |
1743 |
<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> |
1744 |
command |
command |
1745 |
</p> |
</p> |
1746 |
</blockquote> |
</blockquote> |
1781 |
order. The fields above are only those fields which are |
order. The fields above are only those fields which are |
1782 |
returned by all audio output devices. Every audio output driver |
returned by all audio output devices. Every audio output driver |
1783 |
might have its own, additional driver specific parameters (see |
might have its own, additional driver specific parameters (see |
1784 |
<a class="info" href="#GET AUDIO_OUTPUT_DRIVER INFO">Section 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 6.2.3<span> (</span><span class='info'>Getting information about a specific audio output driver</span><span>)</span></a>) |
1785 |
which are also returned by this command. |
which are also returned by this command. |
1786 |
</p> |
</p> |
1787 |
<p>Example: |
<p>Example: |
1811 |
|
|
1812 |
</p> |
</p> |
1813 |
<a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER"></a><br /><hr /> |
<a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER"></a><br /><hr /> |
1814 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
1815 |
<a name="rfc.section.6.2.10"></a><h3>6.2.10. Changing settings of audio output devices</h3> |
<a name="rfc.section.6.2.10"></a><h3>6.2.10. |
1816 |
|
Changing settings of audio output devices</h3> |
1817 |
|
|
1818 |
<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: |
1819 |
</p> |
</p> |
1827 |
</p> |
</p> |
1828 |
<p>Where <device-id> should be replaced by the numerical ID of the |
<p>Where <device-id> should be replaced by the numerical ID of the |
1829 |
audio output device as given by the |
audio output device as given by the |
1830 |
<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> |
1831 |
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> |
1832 |
command, <key> by the name of the parameter to change |
command, <key> by the name of the parameter to change |
1833 |
and <value> by the new value for this parameter. |
and <value> by the new value for this parameter. |
1834 |
</p> |
</p> |
1880 |
|
|
1881 |
</p> |
</p> |
1882 |
<a name="GET AUDIO_OUTPUT_CHANNEL INFO"></a><br /><hr /> |
<a name="GET AUDIO_OUTPUT_CHANNEL INFO"></a><br /><hr /> |
1883 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
1884 |
<a name="rfc.section.6.2.11"></a><h3>6.2.11. Getting information about an audio channel</h3> |
<a name="rfc.section.6.2.11"></a><h3>6.2.11. |
1885 |
|
Getting information about an audio channel</h3> |
1886 |
|
|
1887 |
<p>Use the following command to get information about an audio channel: |
<p>Use the following command to get information about an audio channel: |
1888 |
</p> |
</p> |
1895 |
|
|
1896 |
</p> |
</p> |
1897 |
<p>Where <device-id> is the numerical ID of the audio output device as given by the |
<p>Where <device-id> is the numerical ID of the audio output device as given by the |
1898 |
<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> |
1899 |
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> |
1900 |
command and <audio-chan> the audio channel number. |
command and <audio-chan> the audio channel number. |
1901 |
</p> |
</p> |
1902 |
<p>Possible Answers: |
<p>Possible Answers: |
2023 |
|
|
2024 |
</p> |
</p> |
2025 |
<a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"></a><br /><hr /> |
<a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"></a><br /><hr /> |
2026 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
2027 |
<a name="rfc.section.6.2.12"></a><h3>6.2.12. Getting information about specific audio channel parameter</h3> |
<a name="rfc.section.6.2.12"></a><h3>6.2.12. |
2028 |
|
Getting information about specific audio channel parameter</h3> |
2029 |
|
|
2030 |
<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: |
2031 |
</p> |
</p> |
2038 |
|
|
2039 |
</p> |
</p> |
2040 |
<p>Where <dev-id> is the numerical ID of the audio output device as returned by the |
<p>Where <dev-id> is the numerical ID of the audio output device as returned by the |
2041 |
<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> |
2042 |
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> |
2043 |
command, <chan> the audio channel number |
command, <chan> the audio channel number |
2044 |
and <param> a specific channel parameter name for which information should |
and <param> a specific channel parameter name for which information should |
2045 |
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). |
2046 |
</p> |
</p> |
2047 |
<p>Possible Answers: |
<p>Possible Answers: |
2048 |
</p> |
</p> |
2170 |
|
|
2171 |
</p> |
</p> |
2172 |
<a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"></a><br /><hr /> |
<a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"></a><br /><hr /> |
2173 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
2174 |
<a name="rfc.section.6.2.13"></a><h3>6.2.13. Changing settings of audio output channels</h3> |
<a name="rfc.section.6.2.13"></a><h3>6.2.13. |
2175 |
|
Changing settings of audio output channels</h3> |
2176 |
|
|
2177 |
<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: |
2178 |
</p> |
</p> |
2185 |
|
|
2186 |
</p> |
</p> |
2187 |
<p>Where <dev-id> should be replaced by the numerical ID of the audio output device as returned by the |
<p>Where <dev-id> should be replaced by the numerical ID of the audio output device as returned by the |
2188 |
<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> |
2189 |
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> |
2190 |
command, <chn> by the audio channel number, <key> by the name of the |
command, <chn> by the audio channel number, <key> by the name of the |
2191 |
parameter to change and <value> by the new value for this parameter. |
parameter to change and <value> by the new value for this parameter. |
2192 |
</p> |
</p> |
2248 |
|
|
2249 |
</p> |
</p> |
2250 |
<a name="anchor10"></a><br /><hr /> |
<a name="anchor10"></a><br /><hr /> |
2251 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
2252 |
<a name="rfc.section.6.3"></a><h3>6.3. Configuring MIDI input drivers</h3> |
<a name="rfc.section.6.3"></a><h3>6.3. |
2253 |
|
Configuring MIDI input drivers</h3> |
2254 |
|
|
2255 |
<p>Instances of drivers in LinuxSampler are called devices. You can use |
<p>Instances of drivers in LinuxSampler are called devices. You can use |
2256 |
multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as |
multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as |
2279 |
possible values, etc. |
possible values, etc. |
2280 |
</p> |
</p> |
2281 |
<a name="GET AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr /> |
<a name="GET AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr /> |
2282 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
2283 |
<a name="rfc.section.6.3.1"></a><h3>6.3.1. Getting amount of available MIDI input drivers</h3> |
<a name="rfc.section.6.3.1"></a><h3>6.3.1. |
2284 |
|
Getting amount of available MIDI input drivers</h3> |
2285 |
|
|
2286 |
<p>Use the following command to get the number of |
<p>Use the following command to get the number of |
2287 |
MIDI input drivers currently available for the |
MIDI input drivers currently available for the |
2319 |
|
|
2320 |
</p> |
</p> |
2321 |
<a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr /> |
<a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr /> |
2322 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
2323 |
<a name="rfc.section.6.3.2"></a><h3>6.3.2. Getting all available MIDI input drivers</h3> |
<a name="rfc.section.6.3.2"></a><h3>6.3.2. |
2324 |
|
Getting all available MIDI input drivers</h3> |
2325 |
|
|
2326 |
<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 |
2327 |
for the LinuxSampler instance: |
for the LinuxSampler instance: |
2358 |
|
|
2359 |
</p> |
</p> |
2360 |
<a name="GET MIDI_INPUT_DRIVER INFO"></a><br /><hr /> |
<a name="GET MIDI_INPUT_DRIVER INFO"></a><br /><hr /> |
2361 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
2362 |
<a name="rfc.section.6.3.3"></a><h3>6.3.3. Getting information about a specific MIDI input driver</h3> |
<a name="rfc.section.6.3.3"></a><h3>6.3.3. |
2363 |
|
Getting information about a specific MIDI input driver</h3> |
2364 |
|
|
2365 |
<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: |
2366 |
</p> |
</p> |
2373 |
|
|
2374 |
</p> |
</p> |
2375 |
<p>Where <midi-input-driver> is the name of the MIDI input driver as returned |
<p>Where <midi-input-driver> is the name of the MIDI input driver as returned |
2376 |
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. |
2377 |
</p> |
</p> |
2378 |
<p>Possible Answers: |
<p>Possible Answers: |
2379 |
</p> |
</p> |
2440 |
|
|
2441 |
</p> |
</p> |
2442 |
<a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO"></a><br /><hr /> |
<a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO"></a><br /><hr /> |
2443 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
2444 |
<a name="rfc.section.6.3.4"></a><h3>6.3.4. Getting information about specific MIDI input driver parameter</h3> |
<a name="rfc.section.6.3.4"></a><h3>6.3.4. |
2445 |
|
Getting information about specific MIDI input driver parameter</h3> |
2446 |
|
|
2447 |
<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: |
2448 |
</p> |
</p> |
2455 |
|
|
2456 |
</p> |
</p> |
2457 |
<p>Where <midit> is the name of the MIDI input driver as returned |
<p>Where <midit> is the name of the MIDI input driver as returned |
2458 |
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, <param> 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, <param> a specific |
2459 |
parameter name for which information should be obtained (as returned by the |
parameter name for which information should be obtained (as returned by the |
2460 |
<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 <deplist> 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 <deplist> is an optional list |
2461 |
of parameters on which the sought parameter <param> depends on, |
of parameters on which the sought parameter <param> depends on, |
2462 |
<deplist> is a key-value pair list in form of "key1=val1 key2=val2 ...", |
<deplist> is a key-value pair list in form of "key1=val1 key2=val2 ...", |
2463 |
where character string values are encapsulated into apostrophes ('). Arguments |
where character string values are encapsulated into apostrophes ('). Arguments |
2504 |
<blockquote class="text"> |
<blockquote class="text"> |
2505 |
<p>either true or false, defines if this parameter must be |
<p>either true or false, defines if this parameter must be |
2506 |
given when the device is to be created with the |
given when the device is to be created with the |
2507 |
<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 |
2508 |
(always returned, no matter which driver parameter) |
(always returned, no matter which driver parameter) |
2509 |
</p> |
</p> |
2510 |
</blockquote> |
</blockquote> |
2515 |
<blockquote class="text"> |
<blockquote class="text"> |
2516 |
<p>either true or false, if false then this parameter can |
<p>either true or false, if false then this parameter can |
2517 |
be changed at any time, once the device is created by |
be changed at any time, once the device is created by |
2518 |
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 |
2519 |
(always returned, no matter which driver parameter) |
(always returned, no matter which driver parameter) |
2520 |
</p> |
</p> |
2521 |
</blockquote> |
</blockquote> |
2554 |
<blockquote class="text"> |
<blockquote class="text"> |
2555 |
<p>reflects the default value for this parameter which is |
<p>reflects the default value for this parameter which is |
2556 |
used when the device is created and not explicitly |
used when the device is created and not explicitly |
2557 |
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, |
2558 |
in case of MULTIPLCITY=true, this is a comma separated |
in case of MULTIPLCITY=true, this is a comma separated |
2559 |
list, that's why character strings are encapsulated into |
list, that's why character strings are encapsulated into |
2560 |
apostrophes (') |
apostrophes (') |
2628 |
|
|
2629 |
</p> |
</p> |
2630 |
<a name="CREATE MIDI_INPUT_DEVICE"></a><br /><hr /> |
<a name="CREATE MIDI_INPUT_DEVICE"></a><br /><hr /> |
2631 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
2632 |
<a name="rfc.section.6.3.5"></a><h3>6.3.5. Creating a MIDI input device</h3> |
<a name="rfc.section.6.3.5"></a><h3>6.3.5. |
2633 |
|
Creating a MIDI input device</h3> |
2634 |
|
|
2635 |
<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: |
2636 |
</p> |
</p> |
2643 |
|
|
2644 |
</p> |
</p> |
2645 |
<p>Where <midi-input-driver> should be replaced by the desired MIDI input system as returned |
<p>Where <midi-input-driver> should be replaced by the desired MIDI input system as returned |
2646 |
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 <param-list> 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 <param-list> by an |
2647 |
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 |
2648 |
character string values should be encapsulated into apostrophes ('). |
character string values should be encapsulated into apostrophes ('). |
2649 |
Note that there might be drivers which require parameter(s) to be |
Note that there might be drivers which require parameter(s) to be |
2699 |
|
|
2700 |
</p> |
</p> |
2701 |
<a name="DESTROY MIDI_INPUT_DEVICE"></a><br /><hr /> |
<a name="DESTROY MIDI_INPUT_DEVICE"></a><br /><hr /> |
2702 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
2703 |
<a name="rfc.section.6.3.6"></a><h3>6.3.6. Destroying a MIDI input device</h3> |
<a name="rfc.section.6.3.6"></a><h3>6.3.6. |
2704 |
|
Destroying a MIDI input device</h3> |
2705 |
|
|
2706 |
<p>Use the following command to destroy a created MIDI input device: |
<p>Use the following command to destroy a created MIDI input device: |
2707 |
</p> |
</p> |
2714 |
|
|
2715 |
</p> |
</p> |
2716 |
<p>Where <device-id> should be replaced by the device's numerical ID as returned by the |
<p>Where <device-id> should be replaced by the device's numerical ID as returned by the |
2717 |
<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> |
2718 |
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> |
2719 |
command. |
command. |
2720 |
</p> |
</p> |
2721 |
<p>Possible Answers: |
<p>Possible Answers: |
2765 |
|
|
2766 |
</p> |
</p> |
2767 |
<a name="GET MIDI_INPUT_DEVICES"></a><br /><hr /> |
<a name="GET MIDI_INPUT_DEVICES"></a><br /><hr /> |
2768 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
2769 |
<a name="rfc.section.6.3.7"></a><h3>6.3.7. Getting all created MIDI input device count</h3> |
<a name="rfc.section.6.3.7"></a><h3>6.3.7. |
2770 |
|
Getting all created MIDI input device count</h3> |
2771 |
|
|
2772 |
<p>Use the following command to count all created MIDI input devices: |
<p>Use the following command to count all created MIDI input devices: |
2773 |
</p> |
</p> |
2803 |
|
|
2804 |
</p> |
</p> |
2805 |
<a name="LIST MIDI_INPUT_DEVICES"></a><br /><hr /> |
<a name="LIST MIDI_INPUT_DEVICES"></a><br /><hr /> |
2806 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
2807 |
<a name="rfc.section.6.3.8"></a><h3>6.3.8. Getting all created MIDI input device list</h3> |
<a name="rfc.section.6.3.8"></a><h3>6.3.8. |
2808 |
|
Getting all created MIDI input device list</h3> |
2809 |
|
|
2810 |
<p>Use the following command to list all created MIDI input devices: |
<p>Use the following command to list all created MIDI input devices: |
2811 |
</p> |
</p> |
2851 |
|
|
2852 |
</p> |
</p> |
2853 |
<a name="GET MIDI_INPUT_DEVICE INFO"></a><br /><hr /> |
<a name="GET MIDI_INPUT_DEVICE INFO"></a><br /><hr /> |
2854 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
2855 |
<a name="rfc.section.6.3.9"></a><h3>6.3.9. Getting current settings of a MIDI input device</h3> |
<a name="rfc.section.6.3.9"></a><h3>6.3.9. |
2856 |
|
Getting current settings of a MIDI input device</h3> |
2857 |
|
|
2858 |
<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: |
2859 |
</p> |
</p> |
2866 |
|
|
2867 |
</p> |
</p> |
2868 |
<p>Where <device-id> is the numerical ID of the MIDI input device as returned by the |
<p>Where <device-id> is the numerical ID of the MIDI input device as returned by the |
2869 |
<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> |
2870 |
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> |
2871 |
command. |
command. |
2872 |
</p> |
</p> |
2873 |
<p>Possible Answers: |
<p>Possible Answers: |
2890 |
</p> |
</p> |
2891 |
<blockquote class="text"> |
<blockquote class="text"> |
2892 |
<p>identifier of the used MIDI input driver, as e.g. |
<p>identifier of the used MIDI input driver, as e.g. |
2893 |
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> |
2894 |
command |
command |
2895 |
</p> |
</p> |
2896 |
</blockquote> |
</blockquote> |
2920 |
order. The fields above are only those fields which are |
order. The fields above are only those fields which are |
2921 |
returned by all MIDI input devices. Every MIDI input driver |
returned by all MIDI input devices. Every MIDI input driver |
2922 |
might have its own, additional driver specific parameters (see |
might have its own, additional driver specific parameters (see |
2923 |
<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 |
2924 |
by this command. |
by this command. |
2925 |
</p> |
</p> |
2926 |
<p>Example: |
<p>Example: |
2940 |
|
|
2941 |
</p> |
</p> |
2942 |
<a name="SET MIDI_INPUT_DEVICE_PARAMETER"></a><br /><hr /> |
<a name="SET MIDI_INPUT_DEVICE_PARAMETER"></a><br /><hr /> |
2943 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
2944 |
<a name="rfc.section.6.3.10"></a><h3>6.3.10. Changing settings of MIDI input devices</h3> |
<a name="rfc.section.6.3.10"></a><h3>6.3.10. |
2945 |
|
Changing settings of MIDI input devices</h3> |
2946 |
|
|
2947 |
<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: |
2948 |
</p> |
</p> |
2956 |
</p> |
</p> |
2957 |
<p>Where <device-id> should be replaced by the numerical ID of the |
<p>Where <device-id> should be replaced by the numerical ID of the |
2958 |
MIDI input device as returned by the |
MIDI input device as returned by the |
2959 |
<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> |
2960 |
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> |
2961 |
command, <key> by the name of the parameter to change and |
command, <key> by the name of the parameter to change and |
2962 |
<value> by the new value for this parameter. |
<value> by the new value for this parameter. |
2963 |
</p> |
</p> |
3008 |
|
|
3009 |
</p> |
</p> |
3010 |
<a name="GET MIDI_INPUT_PORT INFO"></a><br /><hr /> |
<a name="GET MIDI_INPUT_PORT INFO"></a><br /><hr /> |
3011 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
3012 |
<a name="rfc.section.6.3.11"></a><h3>6.3.11. Getting information about a MIDI port</h3> |
<a name="rfc.section.6.3.11"></a><h3>6.3.11. |
3013 |
|
Getting information about a MIDI port</h3> |
3014 |
|
|
3015 |
<p>Use the following command to get information about a MIDI port: |
<p>Use the following command to get information about a MIDI port: |
3016 |
</p> |
</p> |
3023 |
|
|
3024 |
</p> |
</p> |
3025 |
<p>Where <device-id> is the numerical ID of the MIDI input device as returned by the |
<p>Where <device-id> is the numerical ID of the MIDI input device as returned by the |
3026 |
<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> |
3027 |
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> |
3028 |
command and <midi-port> the MIDI input port number. |
command and <midi-port> the MIDI input port number. |
3029 |
</p> |
</p> |
3030 |
<p>Possible Answers: |
<p>Possible Answers: |
3071 |
|
|
3072 |
</p> |
</p> |
3073 |
<a name="GET MIDI_INPUT_PORT_PARAMETER INFO"></a><br /><hr /> |
<a name="GET MIDI_INPUT_PORT_PARAMETER INFO"></a><br /><hr /> |
3074 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
3075 |
<a name="rfc.section.6.3.12"></a><h3>6.3.12. Getting information about specific MIDI port parameter</h3> |
<a name="rfc.section.6.3.12"></a><h3>6.3.12. |
3076 |
|
Getting information about specific MIDI port parameter</h3> |
3077 |
|
|
3078 |
<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: |
3079 |
</p> |
</p> |
3086 |
|
|
3087 |
</p> |
</p> |
3088 |
<p>Where <dev-id> is the numerical ID of the MIDI input device as returned by the |
<p>Where <dev-id> is the numerical ID of the MIDI input device as returned by the |
3089 |
<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> |
3090 |
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> |
3091 |
command, <port> the MIDI port number and |
command, <port> the MIDI port number and |
3092 |
<param> a specific port parameter name for which information should be |
<param> a specific port parameter name for which information should be |
3093 |
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). |
3094 |
</p> |
</p> |
3095 |
<p>Possible Answers: |
<p>Possible Answers: |
3096 |
</p> |
</p> |
3213 |
|
|
3214 |
</p> |
</p> |
3215 |
<a name="SET MIDI_INPUT_PORT_PARAMETER"></a><br /><hr /> |
<a name="SET MIDI_INPUT_PORT_PARAMETER"></a><br /><hr /> |
3216 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
3217 |
<a name="rfc.section.6.3.13"></a><h3>6.3.13. Changing settings of MIDI input ports</h3> |
<a name="rfc.section.6.3.13"></a><h3>6.3.13. |
3218 |
|
Changing settings of MIDI input ports</h3> |
3219 |
|
|
3220 |
<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: |
3221 |
</p> |
</p> |
3229 |
</p> |
</p> |
3230 |
<p>Where <device-id> should be replaced by the numerical ID of the |
<p>Where <device-id> should be replaced by the numerical ID of the |
3231 |
MIDI device as returned by the |
MIDI device as returned by the |
3232 |
<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> |
3233 |
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> |
3234 |
command, <port> by the MIDI port number, <key> by the name of |
command, <port> by the MIDI port number, <key> by the name of |
3235 |
the parameter to change and <value> by the new value for this |
the parameter to change and <value> by the new value for this |
3236 |
parameter. |
parameter. |
3280 |
|
|
3281 |
</p> |
</p> |
3282 |
<a name="anchor11"></a><br /><hr /> |
<a name="anchor11"></a><br /><hr /> |
3283 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
3284 |
<a name="rfc.section.6.4"></a><h3>6.4. Configuring sampler channels</h3> |
<a name="rfc.section.6.4"></a><h3>6.4. |
3285 |
|
Configuring sampler channels</h3> |
3286 |
|
|
3287 |
<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 |
3288 |
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 |
3289 |
MIDI and audio devices. |
MIDI and audio devices. |
3290 |
</p> |
</p> |
3291 |
<a name="LOAD INSTRUMENT"></a><br /><hr /> |
<a name="LOAD INSTRUMENT"></a><br /><hr /> |
3292 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
3293 |
<a name="rfc.section.6.4.1"></a><h3>6.4.1. Loading an instrument</h3> |
<a name="rfc.section.6.4.1"></a><h3>6.4.1. |
3294 |
|
Loading an instrument</h3> |
3295 |
|
|
3296 |
<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: |
3297 |
</p> |
</p> |
3313 |
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 |
3314 |
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 |
3315 |
returns immediately and a background process is launched to load the instrument |
returns immediately and a background process is launched to load the instrument |
3316 |
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> |
3317 |
command can be used to obtain loading |
command can be used to obtain loading |
3318 |
progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks |
progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks |
3319 |
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 |
3367 |
|
|
3368 |
</p> |
</p> |
3369 |
<a name="LOAD ENGINE"></a><br /><hr /> |
<a name="LOAD ENGINE"></a><br /><hr /> |
3370 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
3371 |
<a name="rfc.section.6.4.2"></a><h3>6.4.2. Loading a sampler engine</h3> |
<a name="rfc.section.6.4.2"></a><h3>6.4.2. |
3372 |
|
Loading a sampler engine</h3> |
3373 |
|
|
3374 |
<p>A sampler engine type can be associated to a specific sampler |
<p>A sampler engine type can be associated to a specific sampler |
3375 |
channel by the following command: |
channel by the following command: |
3383 |
|
|
3384 |
</p> |
</p> |
3385 |
<p>Where <engine-name> is an engine name as obtained by the |
<p>Where <engine-name> is an engine name as obtained by the |
3386 |
<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 <sampler-channel> |
<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 <sampler-channel> |
3387 |
the sampler channel as returned by the |
the sampler channel as returned by the |
3388 |
<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 |
3389 |
<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 |
3390 |
the engine type should be assigned to. This command should be issued |
the engine type should be assigned to. This command should be issued |
3391 |
after adding a new sampler channel and before any other control |
after adding a new sampler channel and before any other control |
3392 |
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 |
3442 |
|
|
3443 |
</p> |
</p> |
3444 |
<a name="GET CHANNELS"></a><br /><hr /> |
<a name="GET CHANNELS"></a><br /><hr /> |
3445 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
3446 |
<a name="rfc.section.6.4.3"></a><h3>6.4.3. Getting all created sampler channel count</h3> |
<a name="rfc.section.6.4.3"></a><h3>6.4.3. |
3447 |
|
Getting all created sampler channel count</h3> |
3448 |
|
|
3449 |
<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 |
3450 |
current amount of sampler channels, the front-end can send the |
current amount of sampler channels, the front-end can send the |
3481 |
|
|
3482 |
</p> |
</p> |
3483 |
<a name="LIST CHANNELS"></a><br /><hr /> |
<a name="LIST CHANNELS"></a><br /><hr /> |
3484 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
3485 |
<a name="rfc.section.6.4.4"></a><h3>6.4.4. Getting all created sampler channel list</h3> |
<a name="rfc.section.6.4.4"></a><h3>6.4.4. |
3486 |
|
Getting all created sampler channel list</h3> |
3487 |
|
|
3488 |
<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 |
3489 |
current list of sampler channels, the front-end can send the |
current list of sampler channels, the front-end can send the |
3521 |
|
|
3522 |
</p> |
</p> |
3523 |
<a name="ADD CHANNEL"></a><br /><hr /> |
<a name="ADD CHANNEL"></a><br /><hr /> |
3524 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
3525 |
<a name="rfc.section.6.4.5"></a><h3>6.4.5. Adding a new sampler channel</h3> |
<a name="rfc.section.6.4.5"></a><h3>6.4.5. |
3526 |
|
Adding a new sampler channel</h3> |
3527 |
|
|
3528 |
<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 |
3529 |
channel list by sending the following command: |
channel list by sending the following command: |
3596 |
|
|
3597 |
</p> |
</p> |
3598 |
<a name="REMOVE CHANNEL"></a><br /><hr /> |
<a name="REMOVE CHANNEL"></a><br /><hr /> |
3599 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
3600 |
<a name="rfc.section.6.4.6"></a><h3>6.4.6. Removing a sampler channel</h3> |
<a name="rfc.section.6.4.6"></a><h3>6.4.6. |
3601 |
|
Removing a sampler channel</h3> |
3602 |
|
|
3603 |
<p>A sampler channel can be removed by sending the following command: |
<p>A sampler channel can be removed by sending the following command: |
3604 |
</p> |
</p> |
3612 |
</p> |
</p> |
3613 |
<p>Where <sampler-channel> should be replaced by the |
<p>Where <sampler-channel> should be replaced by the |
3614 |
number of the sampler channel as given by the |
number of the sampler channel as given by the |
3615 |
<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> |
3616 |
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> |
3617 |
command. The channel numbers of all subsequent sampler channels |
command. The channel numbers of all subsequent sampler channels |
3618 |
remain the same. |
remain the same. |
3619 |
</p> |
</p> |
3663 |
|
|
3664 |
</p> |
</p> |
3665 |
<a name="GET AVAILABLE_ENGINES"></a><br /><hr /> |
<a name="GET AVAILABLE_ENGINES"></a><br /><hr /> |
3666 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
3667 |
<a name="rfc.section.6.4.7"></a><h3>6.4.7. Getting amount of available engines</h3> |
<a name="rfc.section.6.4.7"></a><h3>6.4.7. |
3668 |
|
Getting amount of available engines</h3> |
3669 |
|
|
3670 |
<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: |
3671 |
</p> |
</p> |
3700 |
|
|
3701 |
</p> |
</p> |
3702 |
<a name="LIST AVAILABLE_ENGINES"></a><br /><hr /> |
<a name="LIST AVAILABLE_ENGINES"></a><br /><hr /> |
3703 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
3704 |
<a name="rfc.section.6.4.8"></a><h3>6.4.8. Getting all available engines</h3> |
<a name="rfc.section.6.4.8"></a><h3>6.4.8. |
3705 |
|
Getting all available engines</h3> |
3706 |
|
|
3707 |
<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: |
3708 |
</p> |
</p> |
3740 |
|
|
3741 |
</p> |
</p> |
3742 |
<a name="GET ENGINE INFO"></a><br /><hr /> |
<a name="GET ENGINE INFO"></a><br /><hr /> |
3743 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
3744 |
<a name="rfc.section.6.4.9"></a><h3>6.4.9. Getting information about an engine</h3> |
<a name="rfc.section.6.4.9"></a><h3>6.4.9. |
3745 |
|
Getting information about an engine</h3> |
3746 |
|
|
3747 |
<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 |
3748 |
sending the following command: |
sending the following command: |
3756 |
|
|
3757 |
</p> |
</p> |
3758 |
<p>Where <engine-name> is an engine name as obtained by the |
<p>Where <engine-name> is an engine name as obtained by the |
3759 |
<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. |
3760 |
</p> |
</p> |
3761 |
<p>Possible Answers: |
<p>Possible Answers: |
3762 |
</p> |
</p> |
3813 |
|
|
3814 |
</p> |
</p> |
3815 |
<a name="GET CHANNEL INFO"></a><br /><hr /> |
<a name="GET CHANNEL INFO"></a><br /><hr /> |
3816 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
3817 |
<a name="rfc.section.6.4.10"></a><h3>6.4.10. Getting sampler channel information</h3> |
<a name="rfc.section.6.4.10"></a><h3>6.4.10. |
3818 |
|
Getting sampler channel information</h3> |
3819 |
|
|
3820 |
<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 |
3821 |
by sending the following command: |
by sending the following command: |
3829 |
|
|
3830 |
</p> |
</p> |
3831 |
<p>Where <sampler-channel> is the sampler channel number the front-end is interested in |
<p>Where <sampler-channel> is the sampler channel number the front-end is interested in |
3832 |
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> |
3833 |
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. |
3834 |
</p> |
</p> |
3835 |
<p>Possible Answers: |
<p>Possible Answers: |
3836 |
</p> |
</p> |
3985 |
</blockquote> |
</blockquote> |
3986 |
|
|
3987 |
|
|
3988 |
|
<p>MIDI_INSTRUMENT_MAP - |
3989 |
|
</p> |
3990 |
|
<blockquote class="text"> |
3991 |
|
<p>Determines to which MIDI instrument map this sampler |
3992 |
|
channel is assigned to. Read chapter |
3993 |
|
<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> |
3994 |
|
for a list of possible values. |
3995 |
|
</p> |
3996 |
|
</blockquote> |
3997 |
|
|
3998 |
|
|
3999 |
</blockquote> |
</blockquote> |
4000 |
|
|
4001 |
|
|
4035 |
</p> |
</p> |
4036 |
<p> "MIDI_INPUT_CHANNEL: 5" |
<p> "MIDI_INPUT_CHANNEL: 5" |
4037 |
</p> |
</p> |
4038 |
|
<p> "VOLUME: 1.0" |
4039 |
|
</p> |
4040 |
|
<p> "MUTE: false" |
4041 |
|
</p> |
4042 |
|
<p> "SOLO: false" |
4043 |
|
</p> |
4044 |
|
<p> "MIDI_INSTRUMENT_MAP: NONE" |
4045 |
|
</p> |
4046 |
<p> "." |
<p> "." |
4047 |
</p> |
</p> |
4048 |
</blockquote><p> |
</blockquote><p> |
4049 |
|
|
4050 |
</p> |
</p> |
4051 |
<a name="GET CHANNEL VOICE_COUNT"></a><br /><hr /> |
<a name="GET CHANNEL VOICE_COUNT"></a><br /><hr /> |
4052 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
4053 |
<a name="rfc.section.6.4.11"></a><h3>6.4.11. Current number of active voices</h3> |
<a name="rfc.section.6.4.11"></a><h3>6.4.11. |
4054 |
|
Current number of active voices</h3> |
4055 |
|
|
4056 |
<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 |
4057 |
sampler channel by sending the following command: |
sampler channel by sending the following command: |
4065 |
|
|
4066 |
</p> |
</p> |
4067 |
<p>Where <sampler-channel> is the sampler channel number the front-end is interested in |
<p>Where <sampler-channel> is the sampler channel number the front-end is interested in |
4068 |
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> |
4069 |
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. |
4070 |
</p> |
</p> |
4071 |
<p>Possible Answers: |
<p>Possible Answers: |
4072 |
</p> |
</p> |
4090 |
|
|
4091 |
</p> |
</p> |
4092 |
<a name="GET CHANNEL STREAM_COUNT"></a><br /><hr /> |
<a name="GET CHANNEL STREAM_COUNT"></a><br /><hr /> |
4093 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
4094 |
<a name="rfc.section.6.4.12"></a><h3>6.4.12. Current number of active disk streams</h3> |
<a name="rfc.section.6.4.12"></a><h3>6.4.12. |
4095 |
|
Current number of active disk streams</h3> |
4096 |
|
|
4097 |
<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 |
4098 |
on a sampler channel by sending the following command: |
on a sampler channel by sending the following command: |
4106 |
|
|
4107 |
</p> |
</p> |
4108 |
<p>Where <sampler-channel> is the sampler channel number the front-end is interested in |
<p>Where <sampler-channel> is the sampler channel number the front-end is interested in |
4109 |
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> |
4110 |
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. |
4111 |
</p> |
</p> |
4112 |
<p>Possible Answers: |
<p>Possible Answers: |
4113 |
</p> |
</p> |
4133 |
|
|
4134 |
</p> |
</p> |
4135 |
<a name="GET CHANNEL BUFFER_FILL"></a><br /><hr /> |
<a name="GET CHANNEL BUFFER_FILL"></a><br /><hr /> |
4136 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
4137 |
<a name="rfc.section.6.4.13"></a><h3>6.4.13. Current fill state of disk stream buffers</h3> |
<a name="rfc.section.6.4.13"></a><h3>6.4.13. |
4138 |
|
Current fill state of disk stream buffers</h3> |
4139 |
|
|
4140 |
<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 |
4141 |
on a sampler channel by sending the following command: |
on a sampler channel by sending the following command: |
4160 |
</p> |
</p> |
4161 |
<p>to get the fill state in percent, where <sampler-channel> is the |
<p>to get the fill state in percent, where <sampler-channel> is the |
4162 |
sampler channel number the front-end is interested in |
sampler channel number the front-end is interested in |
4163 |
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> |
4164 |
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. |
4165 |
</p> |
</p> |
4166 |
<p>Possible Answers: |
<p>Possible Answers: |
4167 |
</p> |
</p> |
4211 |
|
|
4212 |
</p> |
</p> |
4213 |
<a name="SET CHANNEL AUDIO_OUTPUT_DEVICE"></a><br /><hr /> |
<a name="SET CHANNEL AUDIO_OUTPUT_DEVICE"></a><br /><hr /> |
4214 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
4215 |
<a name="rfc.section.6.4.14"></a><h3>6.4.14. Setting audio output device</h3> |
<a name="rfc.section.6.4.14"></a><h3>6.4.14. |
4216 |
|
Setting audio output device</h3> |
4217 |
|
|
4218 |
<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 |
4219 |
channel by sending the following command: |
channel by sending the following command: |
4227 |
|
|
4228 |
</p> |
</p> |
4229 |
<p>Where <sampler-channel> is the respective sampler channel |
<p>Where <sampler-channel> is the respective sampler channel |
4230 |
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> |
4231 |
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 |
4232 |
<audio-device-id> is the numerical ID of the audio output device as given by the |
<audio-device-id> is the numerical ID of the audio output device as given by the |
4233 |
<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> |
4234 |
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> |
4235 |
command. |
command. |
4236 |
</p> |
</p> |
4237 |
<p>Possible Answers: |
<p>Possible Answers: |
4278 |
</blockquote><p> |
</blockquote><p> |
4279 |
|
|
4280 |
</p> |
</p> |
4281 |
<a name="SET CHANNEL AUDIO_OUTPUT_TYP"></a><br /><hr /> |
<a name="SET CHANNEL AUDIO_OUTPUT_TYPE"></a><br /><hr /> |
4282 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
4283 |
<a name="rfc.section.6.4.15"></a><h3>6.4.15. Setting audio output type</h3> |
<a name="rfc.section.6.4.15"></a><h3>6.4.15. |
4284 |
|
Setting audio output type</h3> |
4285 |
|
|
4286 |
<p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON! |
<p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON! |
4287 |
</p> |
</p> |
4344 |
|
|
4345 |
</p> |
</p> |
4346 |
<a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr /> |
<a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr /> |
4347 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
4348 |
<a name="rfc.section.6.4.16"></a><h3>6.4.16. Setting audio output channel</h3> |
<a name="rfc.section.6.4.16"></a><h3>6.4.16. |
4349 |
|
Setting audio output channel</h3> |
4350 |
|
|
4351 |
<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 |
4352 |
sampler channel by sending the following command: |
sampler channel by sending the following command: |
4360 |
|
|
4361 |
</p> |
</p> |
4362 |
<p>Where <sampler-chan> is the sampler channel number |
<p>Where <sampler-chan> is the sampler channel number |
4363 |
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> |
4364 |
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, <audio-out> 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, <audio-out> is the |
4365 |
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 |
4366 |
rerouted and <audio-in> is the numerical ID of the audio channel of the selected audio |
rerouted and <audio-in> is the numerical ID of the audio channel of the selected audio |
4367 |
output device where <audio-out> should be routed to. |
output device where <audio-out> should be routed to. |
4411 |
|
|
4412 |
</p> |
</p> |
4413 |
<a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr /> |
<a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr /> |
4414 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
4415 |
<a name="rfc.section.6.4.17"></a><h3>6.4.17. Setting MIDI input device</h3> |
<a name="rfc.section.6.4.17"></a><h3>6.4.17. |
4416 |
|
Setting MIDI input device</h3> |
4417 |
|
|
4418 |
<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 |
4419 |
channel by sending the following command: |
channel by sending the following command: |
4427 |
|
|
4428 |
</p> |
</p> |
4429 |
<p>Where <sampler-channel> is the sampler channel number |
<p>Where <sampler-channel> is the sampler channel number |
4430 |
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> |
4431 |
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 |
4432 |
and <midi-device-id> is the numerical ID of the MIDI input device as returned by the |
and <midi-device-id> is the numerical ID of the MIDI input device as returned by the |
4433 |
<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> |
4434 |
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. |
4435 |
</p> |
</p> |
4436 |
<p>Possible Answers: |
<p>Possible Answers: |
4437 |
</p> |
</p> |
4478 |
|
|
4479 |
</p> |
</p> |
4480 |
<a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr /> |
<a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr /> |
4481 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
4482 |
<a name="rfc.section.6.4.18"></a><h3>6.4.18. Setting MIDI input type</h3> |
<a name="rfc.section.6.4.18"></a><h3>6.4.18. |
4483 |
|
Setting MIDI input type</h3> |
4484 |
|
|
4485 |
<p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON! |
<p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON! |
4486 |
</p> |
</p> |
4543 |
|
|
4544 |
</p> |
</p> |
4545 |
<a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr /> |
<a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr /> |
4546 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
4547 |
<a name="rfc.section.6.4.19"></a><h3>6.4.19. Setting MIDI input port</h3> |
<a name="rfc.section.6.4.19"></a><h3>6.4.19. |
4548 |
|
Setting MIDI input port</h3> |
4549 |
|
|
4550 |
<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 |
4551 |
channel by sending the following command: |
channel by sending the following command: |
4607 |
|
|
4608 |
</p> |
</p> |
4609 |
<a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr /> |
<a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr /> |
4610 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
4611 |
<a name="rfc.section.6.4.20"></a><h3>6.4.20. Setting MIDI input channel</h3> |
<a name="rfc.section.6.4.20"></a><h3>6.4.20. |
4612 |
|
Setting MIDI input channel</h3> |
4613 |
|
|
4614 |
<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 |
4615 |
listen to by sending the following command: |
listen to by sending the following command: |
4671 |
|
|
4672 |
</p> |
</p> |
4673 |
<a name="SET CHANNEL VOLUME"></a><br /><hr /> |
<a name="SET CHANNEL VOLUME"></a><br /><hr /> |
4674 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
4675 |
<a name="rfc.section.6.4.21"></a><h3>6.4.21. Setting channel volume</h3> |
<a name="rfc.section.6.4.21"></a><h3>6.4.21. |
4676 |
|
Setting channel volume</h3> |
4677 |
|
|
4678 |
<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 |
4679 |
the following command: |
the following command: |
4736 |
|
|
4737 |
</p> |
</p> |
4738 |
<a name="SET CHANNEL MUTE"></a><br /><hr /> |
<a name="SET CHANNEL MUTE"></a><br /><hr /> |
4739 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
4740 |
<a name="rfc.section.6.4.22"></a><h3>6.4.22. Muting a sampler channel</h3> |
<a name="rfc.section.6.4.22"></a><h3>6.4.22. |
4741 |
|
Muting a sampler channel</h3> |
4742 |
|
|
4743 |
<p>The front-end can mute/unmute a specific sampler |
<p>The front-end can mute/unmute a specific sampler |
4744 |
channel by sending the following command: |
channel by sending the following command: |
4752 |
|
|
4753 |
</p> |
</p> |
4754 |
<p>Where <sampler-channel> is the respective sampler channel |
<p>Where <sampler-channel> is the respective sampler channel |
4755 |
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> |
4756 |
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 |
4757 |
<mute> should be replaced either by "1" to mute the channel or "0" |
<mute> should be replaced either by "1" to mute the channel or "0" |
4758 |
to unmute the channel. |
to unmute the channel. |
4759 |
</p> |
</p> |
4802 |
|
|
4803 |
</p> |
</p> |
4804 |
<a name="SET CHANNEL SOLO"></a><br /><hr /> |
<a name="SET CHANNEL SOLO"></a><br /><hr /> |
4805 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
4806 |
<a name="rfc.section.6.4.23"></a><h3>6.4.23. Soloing a sampler channel</h3> |
<a name="rfc.section.6.4.23"></a><h3>6.4.23. |
4807 |
|
Soloing a sampler channel</h3> |
4808 |
|
|
4809 |
<p>The front-end can solo/unsolo a specific sampler channel |
<p>The front-end can solo/unsolo a specific sampler channel |
4810 |
by sending the following command: |
by sending the following command: |
4818 |
|
|
4819 |
</p> |
</p> |
4820 |
<p>Where <sampler-channel> is the respective sampler channel |
<p>Where <sampler-channel> is the respective sampler channel |
4821 |
number as returned by the <a class="info" href="#ADD CHANNEL">"ADD CHANNEL"<span> (</span><span class="info">Adding a new sampler channel</span><span>)</span></a> |
number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a> |
4822 |
or <a class="info" href="#LIST CHANNELS">"LIST CHANNELS"<span> (</span><span class="info">Getting all created sampler channel list</span><span>)</span></a> command and |
or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command and |
4823 |
<solo> should be replaced either by "1" to solo the channel or "0" |
<solo> should be replaced either by "1" to solo the channel or "0" |
4824 |
to unsolo the channel. |
to unsolo the channel. |
4825 |
</p> |
</p> |
4867 |
</blockquote><p> |
</blockquote><p> |
4868 |
|
|
4869 |
</p> |
</p> |
4870 |
|
<a name="SET CHANNEL MIDI_INSTRUMENT_MAP"></a><br /><hr /> |
4871 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
4872 |
|
<a name="rfc.section.6.4.24"></a><h3>6.4.24. |
4873 |
|
Assigning a MIDI instrument map to a sampler channel</h3> |
4874 |
|
|
4875 |
|
<p>The front-end can assign a MIDI instrument map to a specific sampler channel |
4876 |
|
by sending the following command: |
4877 |
|
</p> |
4878 |
|
<p> |
4879 |
|
</p> |
4880 |
|
<blockquote class="text"> |
4881 |
|
<p>SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <map> |
4882 |
|
</p> |
4883 |
|
</blockquote><p> |
4884 |
|
|
4885 |
|
</p> |
4886 |
|
<p>Where <sampler-channel> is the respective sampler channel |
4887 |
|
number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a> |
4888 |
|
or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command and |
4889 |
|
<map> can have the following possibilites: |
4890 |
|
</p> |
4891 |
|
<p> |
4892 |
|
</p> |
4893 |
|
<blockquote class="text"> |
4894 |
|
<p>"NONE" - |
4895 |
|
</p> |
4896 |
|
<blockquote class="text"> |
4897 |
|
<p>This is the default setting. In this case |
4898 |
|
the sampler channel is not assigned any MIDI |
4899 |
|
instrument map and thus will ignore all MIDI |
4900 |
|
program change messages. |
4901 |
|
</p> |
4902 |
|
</blockquote> |
4903 |
|
|
4904 |
|
|
4905 |
|
<p>"DEFAULT" - |
4906 |
|
</p> |
4907 |
|
<blockquote class="text"> |
4908 |
|
<p>The sampler channel will always use the |
4909 |
|
default MIDI instrument map to handle MIDI |
4910 |
|
program change messages. |
4911 |
|
</p> |
4912 |
|
</blockquote> |
4913 |
|
|
4914 |
|
|
4915 |
|
<p>numeric ID - |
4916 |
|
</p> |
4917 |
|
<blockquote class="text"> |
4918 |
|
<p>You can assign a specific MIDI instrument map |
4919 |
|
by replacing <map> with the respective numeric |
4920 |
|
ID of the MIDI instrument map as returned by the |
4921 |
|
<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> |
4922 |
|
command. Once that map will be deleted, the sampler |
4923 |
|
channel would fall back to "NONE". |
4924 |
|
</p> |
4925 |
|
</blockquote> |
4926 |
|
|
4927 |
|
|
4928 |
|
</blockquote><p> |
4929 |
|
|
4930 |
|
</p> |
4931 |
|
<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> |
4932 |
|
for details regarding MIDI instrument mapping. |
4933 |
|
</p> |
4934 |
|
<p>Possible Answers: |
4935 |
|
</p> |
4936 |
|
<p> |
4937 |
|
</p> |
4938 |
|
<blockquote class="text"> |
4939 |
|
<p>"OK" - |
4940 |
|
</p> |
4941 |
|
<blockquote class="text"> |
4942 |
|
<p>on success |
4943 |
|
</p> |
4944 |
|
</blockquote> |
4945 |
|
|
4946 |
|
|
4947 |
|
<p>"ERR:<error-code>:<error-message>" - |
4948 |
|
</p> |
4949 |
|
<blockquote class="text"> |
4950 |
|
<p>in case it failed, providing an appropriate error code and error message |
4951 |
|
</p> |
4952 |
|
</blockquote> |
4953 |
|
|
4954 |
|
|
4955 |
|
</blockquote><p> |
4956 |
|
|
4957 |
|
</p> |
4958 |
|
<p>Examples: |
4959 |
|
</p> |
4960 |
|
<p> |
4961 |
|
</p> |
4962 |
|
<blockquote class="text"> |
4963 |
|
<p> |
4964 |
|
</p> |
4965 |
|
</blockquote><p> |
4966 |
|
|
4967 |
|
</p> |
4968 |
|
<a name="CREATE FX_SEND"></a><br /><hr /> |
4969 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
4970 |
|
<a name="rfc.section.6.4.25"></a><h3>6.4.25. |
4971 |
|
Adding an effect send to a sampler channel</h3> |
4972 |
|
|
4973 |
|
<p>The front-end can create an additional effect send on a specific sampler channel |
4974 |
|
by sending the following command: |
4975 |
|
</p> |
4976 |
|
<p> |
4977 |
|
</p> |
4978 |
|
<blockquote class="text"> |
4979 |
|
<p>CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>] |
4980 |
|
</p> |
4981 |
|
</blockquote><p> |
4982 |
|
|
4983 |
|
</p> |
4984 |
|
<p>Where <sampler-channel> is the respective sampler channel |
4985 |
|
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> |
4986 |
|
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 |
4987 |
|
sampler channel on which the effect send should be created on, <midi-ctrl> |
4988 |
|
is a number between 0..127 defining the MIDI controller which can alter the |
4989 |
|
effect send level and <name> is an optional argument defining a name |
4990 |
|
for the effect send entity. The name does not have to be unique. |
4991 |
|
</p> |
4992 |
|
<p>By default, that is as initial routing, the effect send's audio channels |
4993 |
|
are automatically routed to the last audio channels of the sampler channel's |
4994 |
|
audio output device, that way you can i.e. first increase the amount of audio |
4995 |
|
channels on the audio output device for having dedicated effect send output |
4996 |
|
channels and when "CREATE FX_SEND" is called, those channels will automatically |
4997 |
|
be picked. You can alter the destination channels however with |
4998 |
|
<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>. |
4999 |
|
|
5000 |
|
</p> |
5001 |
|
<p>Note: Create effect sends on a sampler channel only when needed, because having effect |
5002 |
|
sends on a sampler channel will decrease runtime performance, because for implementing channel |
5003 |
|
effect sends, separate (sampler channel local) audio buffers are needed to render and mix |
5004 |
|
the voices and route the audio signal afterwards to the master outputs and effect send |
5005 |
|
outputs (along with their respective effect send levels). A sampler channel without effect |
5006 |
|
sends however can mix its voices directly into the audio output devices's audio buffers |
5007 |
|
and is thus faster. |
5008 |
|
|
5009 |
|
</p> |
5010 |
|
<p>Possible Answers: |
5011 |
|
</p> |
5012 |
|
<p> |
5013 |
|
</p> |
5014 |
|
<blockquote class="text"> |
5015 |
|
<p>"OK[<fx-send-id>]" - |
5016 |
|
</p> |
5017 |
|
<blockquote class="text"> |
5018 |
|
<p>in case a new effect send could be added to the |
5019 |
|
sampler channel, where <fx-send-id> reflects the |
5020 |
|
unique ID of the newly created effect send entity |
5021 |
|
</p> |
5022 |
|
</blockquote> |
5023 |
|
|
5024 |
|
|
5025 |
|
<p>"ERR:<error-code>:<error-message>" - |
5026 |
|
</p> |
5027 |
|
<blockquote class="text"> |
5028 |
|
<p>when a new effect send could not be added, i.e. |
5029 |
|
due to invalid parameters |
5030 |
|
</p> |
5031 |
|
</blockquote> |
5032 |
|
|
5033 |
|
|
5034 |
|
</blockquote><p> |
5035 |
|
|
5036 |
|
</p> |
5037 |
|
<p>Examples: |
5038 |
|
</p> |
5039 |
|
<p> |
5040 |
|
</p> |
5041 |
|
<blockquote class="text"> |
5042 |
|
<p>C: "CREATE FX_SEND 0 91 'Reverb Send'" |
5043 |
|
</p> |
5044 |
|
<p>S: "OK[0]" |
5045 |
|
</p> |
5046 |
|
</blockquote><p> |
5047 |
|
|
5048 |
|
</p> |
5049 |
|
<p> |
5050 |
|
</p> |
5051 |
|
<blockquote class="text"> |
5052 |
|
<p>C: "CREATE FX_SEND 0 93" |
5053 |
|
</p> |
5054 |
|
<p>S: "OK[1]" |
5055 |
|
</p> |
5056 |
|
</blockquote><p> |
5057 |
|
|
5058 |
|
</p> |
5059 |
|
<a name="DESTROY FX_SEND"></a><br /><hr /> |
5060 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5061 |
|
<a name="rfc.section.6.4.26"></a><h3>6.4.26. |
5062 |
|
Removing an effect send from a sampler channel</h3> |
5063 |
|
|
5064 |
|
<p>The front-end can remove an existing effect send on a specific sampler channel |
5065 |
|
by sending the following command: |
5066 |
|
</p> |
5067 |
|
<p> |
5068 |
|
</p> |
5069 |
|
<blockquote class="text"> |
5070 |
|
<p>DESTROY FX_SEND <sampler-channel> <fx-send-id> |
5071 |
|
</p> |
5072 |
|
</blockquote><p> |
5073 |
|
|
5074 |
|
</p> |
5075 |
|
<p>Where <sampler-channel> is the respective sampler channel |
5076 |
|
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> |
5077 |
|
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 |
5078 |
|
sampler channel from which the effect send should be removed from and |
5079 |
|
<fx-send-id> is the respective effect send number as returned by the |
5080 |
|
<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> |
5081 |
|
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. |
5082 |
|
</p> |
5083 |
|
<p>Possible Answers: |
5084 |
|
</p> |
5085 |
|
<p> |
5086 |
|
</p> |
5087 |
|
<blockquote class="text"> |
5088 |
|
<p>"OK" - |
5089 |
|
</p> |
5090 |
|
<blockquote class="text"> |
5091 |
|
<p>on success |
5092 |
|
</p> |
5093 |
|
</blockquote> |
5094 |
|
|
5095 |
|
|
5096 |
|
<p>"ERR:<error-code>:<error-message>" - |
5097 |
|
</p> |
5098 |
|
<blockquote class="text"> |
5099 |
|
<p>in case it failed, providing an appropriate error code and |
5100 |
|
error message |
5101 |
|
</p> |
5102 |
|
</blockquote> |
5103 |
|
|
5104 |
|
|
5105 |
|
</blockquote><p> |
5106 |
|
|
5107 |
|
</p> |
5108 |
|
<p>Example: |
5109 |
|
</p> |
5110 |
|
<p> |
5111 |
|
</p> |
5112 |
|
<blockquote class="text"> |
5113 |
|
<p>C: "DESTROY FX_SEND 0 0" |
5114 |
|
</p> |
5115 |
|
<p>S: "OK" |
5116 |
|
</p> |
5117 |
|
</blockquote><p> |
5118 |
|
|
5119 |
|
</p> |
5120 |
|
<a name="GET FX_SENDS"></a><br /><hr /> |
5121 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5122 |
|
<a name="rfc.section.6.4.27"></a><h3>6.4.27. |
5123 |
|
Getting amount of effect sends on a sampler channel</h3> |
5124 |
|
|
5125 |
|
<p>The front-end can ask for the amount of effect sends on a specific sampler channel |
5126 |
|
by sending the following command: |
5127 |
|
</p> |
5128 |
|
<p> |
5129 |
|
</p> |
5130 |
|
<blockquote class="text"> |
5131 |
|
<p>GET FX_SENDS <sampler-channel> |
5132 |
|
</p> |
5133 |
|
</blockquote><p> |
5134 |
|
|
5135 |
|
</p> |
5136 |
|
<p>Where <sampler-channel> is the respective sampler channel |
5137 |
|
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> |
5138 |
|
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. |
5139 |
|
</p> |
5140 |
|
<p>Possible Answers: |
5141 |
|
</p> |
5142 |
|
<p> |
5143 |
|
</p> |
5144 |
|
<blockquote class="text"> |
5145 |
|
<p>The sampler will answer by returning the number of effect |
5146 |
|
sends on the given sampler channel. |
5147 |
|
</p> |
5148 |
|
</blockquote><p> |
5149 |
|
|
5150 |
|
</p> |
5151 |
|
<p>Example: |
5152 |
|
</p> |
5153 |
|
<p> |
5154 |
|
</p> |
5155 |
|
<blockquote class="text"> |
5156 |
|
<p>C: "GET FX_SENDS 0" |
5157 |
|
</p> |
5158 |
|
<p>S: "2" |
5159 |
|
</p> |
5160 |
|
</blockquote><p> |
5161 |
|
|
5162 |
|
</p> |
5163 |
|
<a name="LIST FX_SENDS"></a><br /><hr /> |
5164 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5165 |
|
<a name="rfc.section.6.4.28"></a><h3>6.4.28. |
5166 |
|
Listing all effect sends on a sampler channel</h3> |
5167 |
|
|
5168 |
|
<p>The front-end can ask for a list of effect sends on a specific sampler channel |
5169 |
|
by sending the following command: |
5170 |
|
</p> |
5171 |
|
<p> |
5172 |
|
</p> |
5173 |
|
<blockquote class="text"> |
5174 |
|
<p>LIST FX_SENDS <sampler-channel> |
5175 |
|
</p> |
5176 |
|
</blockquote><p> |
5177 |
|
|
5178 |
|
</p> |
5179 |
|
<p>Where <sampler-channel> is the respective sampler channel |
5180 |
|
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> |
5181 |
|
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. |
5182 |
|
</p> |
5183 |
|
<p>Possible Answers: |
5184 |
|
</p> |
5185 |
|
<p> |
5186 |
|
</p> |
5187 |
|
<blockquote class="text"> |
5188 |
|
<p>The sampler will answer by returning a comma separated list |
5189 |
|
with all effect sends' numerical IDs on the given sampler |
5190 |
|
channel. |
5191 |
|
</p> |
5192 |
|
</blockquote><p> |
5193 |
|
|
5194 |
|
</p> |
5195 |
|
<p>Examples: |
5196 |
|
</p> |
5197 |
|
<p> |
5198 |
|
</p> |
5199 |
|
<blockquote class="text"> |
5200 |
|
<p>C: "LIST FX_SENDS 0" |
5201 |
|
</p> |
5202 |
|
<p>S: "0,1" |
5203 |
|
</p> |
5204 |
|
</blockquote><p> |
5205 |
|
|
5206 |
|
</p> |
5207 |
|
<p> |
5208 |
|
</p> |
5209 |
|
<blockquote class="text"> |
5210 |
|
<p>C: "LIST FX_SENDS 1" |
5211 |
|
</p> |
5212 |
|
<p>S: "" |
5213 |
|
</p> |
5214 |
|
</blockquote><p> |
5215 |
|
|
5216 |
|
</p> |
5217 |
|
<a name="GET FX_SEND INFO"></a><br /><hr /> |
5218 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5219 |
|
<a name="rfc.section.6.4.29"></a><h3>6.4.29. |
5220 |
|
Getting effect send information</h3> |
5221 |
|
|
5222 |
|
<p>The front-end can ask for the current settings of an effect send entity |
5223 |
|
by sending the following command: |
5224 |
|
</p> |
5225 |
|
<p> |
5226 |
|
</p> |
5227 |
|
<blockquote class="text"> |
5228 |
|
<p>GET FX_SEND INFO <sampler-channel> <fx-send-id> |
5229 |
|
</p> |
5230 |
|
</blockquote><p> |
5231 |
|
|
5232 |
|
</p> |
5233 |
|
<p>Where <sampler-channel> is the sampler channel number |
5234 |
|
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> |
5235 |
|
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 |
5236 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
5237 |
|
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> |
5238 |
|
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. |
5239 |
|
|
5240 |
|
</p> |
5241 |
|
<p>Possible Answers: |
5242 |
|
</p> |
5243 |
|
<p> |
5244 |
|
</p> |
5245 |
|
<blockquote class="text"> |
5246 |
|
<p>The sampler will answer by sending a <CRLF> separated list. |
5247 |
|
Each answer line begins with the settings category name |
5248 |
|
followed by a colon and then a space character <SP> and finally |
5249 |
|
the info character string to that setting category. At the |
5250 |
|
moment the following categories are defined: |
5251 |
|
</p> |
5252 |
|
<p> |
5253 |
|
</p> |
5254 |
|
<blockquote class="text"> |
5255 |
|
<p>NAME - |
5256 |
|
</p> |
5257 |
|
<blockquote class="text"> |
5258 |
|
<p>name of the effect send entity |
5259 |
|
</p> |
5260 |
|
</blockquote> |
5261 |
|
|
5262 |
|
|
5263 |
|
<p>AUDIO_OUTPUT_ROUTING - |
5264 |
|
</p> |
5265 |
|
<blockquote class="text"> |
5266 |
|
<p>comma separated list which reflects to which audio |
5267 |
|
channel of the selected audio output device each |
5268 |
|
effect send output channel is routed to, e.g. "0,3" would |
5269 |
|
mean the effect send's output channel 0 is routed to channel |
5270 |
|
0 of the audio output device and the effect send's output |
5271 |
|
channel 1 is routed to the channel 3 of the audio |
5272 |
|
output device (see |
5273 |
|
<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> |
5274 |
|
for details) |
5275 |
|
</p> |
5276 |
|
</blockquote> |
5277 |
|
|
5278 |
|
|
5279 |
|
</blockquote> |
5280 |
|
|
5281 |
|
|
5282 |
|
</blockquote><p> |
5283 |
|
|
5284 |
|
</p> |
5285 |
|
<p>The mentioned fields above don't have to be in particular order. |
5286 |
|
</p> |
5287 |
|
<p>Example: |
5288 |
|
</p> |
5289 |
|
<p> |
5290 |
|
</p> |
5291 |
|
<blockquote class="text"> |
5292 |
|
<p>C: "GET FX_SEND INFO 0 0" |
5293 |
|
</p> |
5294 |
|
<p>S: "NAME: Reverb Send" |
5295 |
|
</p> |
5296 |
|
<p> "AUDIO_OUTPUT_ROUTING: 2,3" |
5297 |
|
</p> |
5298 |
|
<p> "." |
5299 |
|
</p> |
5300 |
|
</blockquote><p> |
5301 |
|
|
5302 |
|
</p> |
5303 |
|
<a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr /> |
5304 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5305 |
|
<a name="rfc.section.6.4.30"></a><h3>6.4.30. |
5306 |
|
Altering effect send's audio routing</h3> |
5307 |
|
|
5308 |
|
<p>The front-end can alter the destination of an effect send's audio channel on a specific |
5309 |
|
sampler channel by sending the following command: |
5310 |
|
</p> |
5311 |
|
<p> |
5312 |
|
</p> |
5313 |
|
<blockquote class="text"> |
5314 |
|
<p>SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id> <audio-src> <audio-dst> |
5315 |
|
</p> |
5316 |
|
</blockquote><p> |
5317 |
|
|
5318 |
|
</p> |
5319 |
|
<p>Where <sampler-chan> is the sampler channel number |
5320 |
|
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> |
5321 |
|
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, |
5322 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
5323 |
|
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> |
5324 |
|
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, |
5325 |
|
<audio-src> is the numerical ID of the effect send's audio channel |
5326 |
|
which should be rerouted and <audio-dst> is the numerical ID of |
5327 |
|
the audio channel of the selected audio output device where <audio-src> |
5328 |
|
should be routed to. |
5329 |
|
</p> |
5330 |
|
<p>Note that effect sends can only route audio to the same audio output |
5331 |
|
device as assigned to the effect send's sampler channel. Also note that an |
5332 |
|
effect send entity does always have exactly as much audio channels as its |
5333 |
|
sampler channel. So if the sampler channel is stereo, the effect send does |
5334 |
|
have two audio channels as well. Also keep in mind that the amount of audio |
5335 |
|
channels on a sampler channel might be dependant not only to the deployed |
5336 |
|
sampler engine on the sampler channel, but also dependant to the instrument |
5337 |
|
currently loaded. However you can (effectively) turn an i.e. stereo effect |
5338 |
|
send into a mono one by simply altering its audio routing appropriately. |
5339 |
|
</p> |
5340 |
|
<p>Possible Answers: |
5341 |
|
</p> |
5342 |
|
<p> |
5343 |
|
</p> |
5344 |
|
<blockquote class="text"> |
5345 |
|
<p>"OK" - |
5346 |
|
</p> |
5347 |
|
<blockquote class="text"> |
5348 |
|
<p>on success |
5349 |
|
</p> |
5350 |
|
</blockquote> |
5351 |
|
|
5352 |
|
|
5353 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
5354 |
|
</p> |
5355 |
|
<blockquote class="text"> |
5356 |
|
<p>if audio output channel was set, but there are noteworthy |
5357 |
|
issue(s) related, providing an appropriate warning code and |
5358 |
|
warning message |
5359 |
|
</p> |
5360 |
|
</blockquote> |
5361 |
|
|
5362 |
|
|
5363 |
|
<p>"ERR:<error-code>:<error-message>" - |
5364 |
|
</p> |
5365 |
|
<blockquote class="text"> |
5366 |
|
<p>in case it failed, providing an appropriate error code and error message |
5367 |
|
</p> |
5368 |
|
</blockquote> |
5369 |
|
|
5370 |
|
|
5371 |
|
</blockquote><p> |
5372 |
|
|
5373 |
|
</p> |
5374 |
|
<p>Example: |
5375 |
|
</p> |
5376 |
|
<p> |
5377 |
|
</p> |
5378 |
|
<blockquote class="text"> |
5379 |
|
<p>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2" |
5380 |
|
</p> |
5381 |
|
<p>S: "OK" |
5382 |
|
</p> |
5383 |
|
</blockquote><p> |
5384 |
|
|
5385 |
|
</p> |
5386 |
<a name="RESET CHANNEL"></a><br /><hr /> |
<a name="RESET CHANNEL"></a><br /><hr /> |
5387 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5388 |
<a name="rfc.section.6.4.24"></a><h3>6.4.24. Resetting a sampler channel</h3> |
<a name="rfc.section.6.4.31"></a><h3>6.4.31. |
5389 |
|
Resetting a sampler channel</h3> |
5390 |
|
|
5391 |
<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: |
5392 |
</p> |
</p> |
5450 |
|
|
5451 |
</p> |
</p> |
5452 |
<a name="anchor12"></a><br /><hr /> |
<a name="anchor12"></a><br /><hr /> |
5453 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5454 |
<a name="rfc.section.6.5"></a><h3>6.5. Controlling connection</h3> |
<a name="rfc.section.6.5"></a><h3>6.5. |
5455 |
|
Controlling connection</h3> |
5456 |
|
|
5457 |
<p>The following commands are used to control the connection to LinuxSampler. |
<p>The following commands are used to control the connection to LinuxSampler. |
5458 |
</p> |
</p> |
5459 |
<a name="SUBSCRIBE"></a><br /><hr /> |
<a name="SUBSCRIBE"></a><br /><hr /> |
5460 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5461 |
<a name="rfc.section.6.5.1"></a><h3>6.5.1. Register front-end for receiving event messages</h3> |
<a name="rfc.section.6.5.1"></a><h3>6.5.1. |
5462 |
|
Register front-end for receiving event messages</h3> |
5463 |
|
|
5464 |
<p>The front-end can register itself to the LinuxSampler application to |
<p>The front-end can register itself to the LinuxSampler application to |
5465 |
be informed about noteworthy events by sending this command: |
be informed about noteworthy events by sending this command: |
5521 |
|
|
5522 |
</p> |
</p> |
5523 |
<a name="UNSUBSCRIBE"></a><br /><hr /> |
<a name="UNSUBSCRIBE"></a><br /><hr /> |
5524 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5525 |
<a name="rfc.section.6.5.2"></a><h3>6.5.2. Unregister front-end for not receiving event messages</h3> |
<a name="rfc.section.6.5.2"></a><h3>6.5.2. |
5526 |
|
Unregister front-end for not receiving event messages</h3> |
5527 |
|
|
5528 |
<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 |
5529 |
messages anymore by sending the following command: |
messages anymore by sending the following command: |
5585 |
|
|
5586 |
</p> |
</p> |
5587 |
<a name="SET ECHO"></a><br /><hr /> |
<a name="SET ECHO"></a><br /><hr /> |
5588 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5589 |
<a name="rfc.section.6.5.3"></a><h3>6.5.3. Enable or disable echo of commands</h3> |
<a name="rfc.section.6.5.3"></a><h3>6.5.3. |
5590 |
|
Enable or disable echo of commands</h3> |
5591 |
|
|
5592 |
<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: |
5593 |
</p> |
</p> |
5642 |
|
|
5643 |
</p> |
</p> |
5644 |
<a name="QUIT"></a><br /><hr /> |
<a name="QUIT"></a><br /><hr /> |
5645 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5646 |
<a name="rfc.section.6.5.4"></a><h3>6.5.4. Close client connection</h3> |
<a name="rfc.section.6.5.4"></a><h3>6.5.4. |
5647 |
|
Close client connection</h3> |
5648 |
|
|
5649 |
<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: |
5650 |
</p> |
</p> |
5660 |
LinuxSampler than really useful for a front-end implementation. |
LinuxSampler than really useful for a front-end implementation. |
5661 |
</p> |
</p> |
5662 |
<a name="anchor13"></a><br /><hr /> |
<a name="anchor13"></a><br /><hr /> |
5663 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5664 |
<a name="rfc.section.6.6"></a><h3>6.6. Global commands</h3> |
<a name="rfc.section.6.6"></a><h3>6.6. |
5665 |
|
Global commands</h3> |
5666 |
|
|
5667 |
<p>The following commands have global impact on the sampler. |
<p>The following commands have global impact on the sampler. |
5668 |
</p> |
</p> |
5669 |
<a name="GET TOTAL_VOICE_COUNT"></a><br /><hr /> |
<a name="GET TOTAL_VOICE_COUNT"></a><br /><hr /> |
5670 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5671 |
<a name="rfc.section.6.6.1"></a><h3>6.6.1. Current number of active voices</h3> |
<a name="rfc.section.6.6.1"></a><h3>6.6.1. |
5672 |
|
Current number of active voices</h3> |
5673 |
|
|
5674 |
<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 |
5675 |
the sampler by sending the following command: |
the sampler by sending the following command: |
5694 |
|
|
5695 |
</p> |
</p> |
5696 |
<a name="GET TOTAL_VOICE_COUNT_MAX"></a><br /><hr /> |
<a name="GET TOTAL_VOICE_COUNT_MAX"></a><br /><hr /> |
5697 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5698 |
<a name="rfc.section.6.6.2"></a><h3>6.6.2. Maximum amount of active voices</h3> |
<a name="rfc.section.6.6.2"></a><h3>6.6.2. |
5699 |
|
Maximum amount of active voices</h3> |
5700 |
|
|
5701 |
<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 |
5702 |
by sending the following command: |
by sending the following command: |
5721 |
|
|
5722 |
</p> |
</p> |
5723 |
<a name="RESET"></a><br /><hr /> |
<a name="RESET"></a><br /><hr /> |
5724 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5725 |
<a name="rfc.section.6.6.3"></a><h3>6.6.3. Reset sampler</h3> |
<a name="rfc.section.6.6.3"></a><h3>6.6.3. |
5726 |
|
Reset sampler</h3> |
5727 |
|
|
5728 |
<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: |
5729 |
</p> |
</p> |
5762 |
|
|
5763 |
</p> |
</p> |
5764 |
<a name="GET SERVER INFO"></a><br /><hr /> |
<a name="GET SERVER INFO"></a><br /><hr /> |
5765 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5766 |
<a name="rfc.section.6.6.4"></a><h3>6.6.4. General sampler informations</h3> |
<a name="rfc.section.6.6.4"></a><h3>6.6.4. |
5767 |
|
General sampler informations</h3> |
5768 |
|
|
5769 |
<p>The client can ask for general informations about the LinuxSampler |
<p>The client can ask for general informations about the LinuxSampler |
5770 |
instance by sending the following command: |
instance by sending the following command: |
5812 |
</p> |
</p> |
5813 |
<blockquote class="text"> |
<blockquote class="text"> |
5814 |
<p>version of the LSCP specification the sampler |
<p>version of the LSCP specification the sampler |
5815 |
complies with (see <a class="info" href="#LSCP versioning">Section 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 2<span> (</span><span class='info'>Versioning of this specification</span><span>)</span></a> for details) |
5816 |
</p> |
</p> |
5817 |
</blockquote> |
</blockquote> |
5818 |
|
|
5826 |
<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. |
5827 |
Other fields might be added in future. |
Other fields might be added in future. |
5828 |
</p> |
</p> |
5829 |
<a name="anchor14"></a><br /><hr /> |
<a name="GET VOLUME"></a><br /><hr /> |
5830 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5831 |
<a name="rfc.section.6.7"></a><h3>6.7. MIDI Instrument Mapping</h3> |
<a name="rfc.section.6.6.5"></a><h3>6.6.5. |
5832 |
|
Getting global volume attenuation</h3> |
5833 |
|
|
5834 |
|
<p>The client can ask for the current global sampler-wide volume |
5835 |
|
attenuation by sending the following command: |
5836 |
|
</p> |
5837 |
|
<p> |
5838 |
|
</p> |
5839 |
|
<blockquote class="text"> |
5840 |
|
<p>GET VOLUME |
5841 |
|
</p> |
5842 |
|
</blockquote><p> |
5843 |
|
|
5844 |
|
</p> |
5845 |
|
<p>Possible Answers: |
5846 |
|
</p> |
5847 |
|
<p> |
5848 |
|
</p> |
5849 |
|
<blockquote class="text"> |
5850 |
|
<p>The sampler will always answer by returning the optional |
5851 |
|
dotted floating point coefficient, reflecting the current |
5852 |
|
global volume attenuation. |
5853 |
|
|
5854 |
|
</p> |
5855 |
|
</blockquote><p> |
5856 |
|
|
5857 |
|
</p> |
5858 |
|
<p>Note: it is up to the respective sampler engine whether to obey |
5859 |
|
that global volume parameter or not, but in general all engines SHOULD |
5860 |
|
use this parameter. |
5861 |
|
</p> |
5862 |
|
<a name="SET VOLUME"></a><br /><hr /> |
5863 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5864 |
|
<a name="rfc.section.6.6.6"></a><h3>6.6.6. |
5865 |
|
Setting global volume attenuation</h3> |
5866 |
|
|
5867 |
|
<p>The client can alter the current global sampler-wide volume |
5868 |
|
attenuation by sending the following command: |
5869 |
|
</p> |
5870 |
|
<p> |
5871 |
|
</p> |
5872 |
|
<blockquote class="text"> |
5873 |
|
<p>SET VOLUME <volume> |
5874 |
|
</p> |
5875 |
|
</blockquote><p> |
5876 |
|
|
5877 |
|
</p> |
5878 |
|
<p>Where <volume> should be replaced by the optional dotted |
5879 |
|
floating point value, reflecting the new global volume parameter. |
5880 |
|
This value might usually be in the range between 0.0 and 1.0, that |
5881 |
|
is for attenuating the overall volume. |
5882 |
|
</p> |
5883 |
|
<p>Possible Answers: |
5884 |
|
</p> |
5885 |
|
<p> |
5886 |
|
</p> |
5887 |
|
<blockquote class="text"> |
5888 |
|
<p>"OK" - |
5889 |
|
</p> |
5890 |
|
<blockquote class="text"> |
5891 |
|
<p>on success |
5892 |
|
</p> |
5893 |
|
</blockquote> |
5894 |
|
|
5895 |
|
|
5896 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
5897 |
|
</p> |
5898 |
|
<blockquote class="text"> |
5899 |
|
<p>if the global volume was set, but there are noteworthy |
5900 |
|
issue(s) related, providing an appropriate warning code and |
5901 |
|
warning message |
5902 |
|
</p> |
5903 |
|
</blockquote> |
5904 |
|
|
5905 |
|
|
5906 |
|
<p>"ERR:<error-code>:<error-message>" - |
5907 |
|
</p> |
5908 |
|
<blockquote class="text"> |
5909 |
|
<p>in case it failed, providing an appropriate error code and error message |
5910 |
|
</p> |
5911 |
|
</blockquote> |
5912 |
|
|
5913 |
|
|
5914 |
|
</blockquote><p> |
5915 |
|
|
5916 |
|
</p> |
5917 |
|
<a name="MIDI Instrument Mapping"></a><br /><hr /> |
5918 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5919 |
|
<a name="rfc.section.6.7"></a><h3>6.7. |
5920 |
|
MIDI Instrument Mapping</h3> |
5921 |
|
|
5922 |
<p>The MIDI protocol provides a way to switch between instruments |
<p>The MIDI protocol provides a way to switch between instruments |
5923 |
by sending so called MIDI bank select and MIDI program change |
by sending so called MIDI bank select and MIDI program change |
5925 |
allow to actually map arbitrary MIDI bank select / program change |
allow to actually map arbitrary MIDI bank select / program change |
5926 |
numbers with real instruments. |
numbers with real instruments. |
5927 |
</p> |
</p> |
5928 |
<p>By default, that is when the sampler is launched, this map will |
<p>The sampler allows to manage an arbitrary amount of MIDI |
5929 |
be empty, thus the sampler will simply ignore all program change |
instrument maps which define which instrument to load on |
5930 |
messages. The front-end has to explicitly add entries to the map |
which MIDI program change message. |
5931 |
so the sampler knows how to react on a given program change |
</p> |
5932 |
message, that is by switching to the respectively defined engine |
<p>By default, that is when the sampler is launched, there is no |
5933 |
type and loading the respective instrument. |
map, thus the sampler will simply ignore all program change |
5934 |
|
messages. The front-end has to explicitly create at least one |
5935 |
|
map, add entries to the map and tell the respective sampler |
5936 |
|
channel(s) which MIDI instrument map to use, so the sampler |
5937 |
|
knows how to react on a given program change message on the |
5938 |
|
respective sampler channel, that is by switching to the |
5939 |
|
respectively defined engine type and loading the respective |
5940 |
|
instrument. See command |
5941 |
|
<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> |
5942 |
|
for how to assign a MIDI instrument map to a sampler channel. |
5943 |
</p> |
</p> |
5944 |
<p>Also note per MIDI specification a bank select message does not |
<p>Also note per MIDI specification a bank select message does not |
5945 |
cause to switch to another instrument. Instead when receiving a |
cause to switch to another instrument. Instead when receiving a |
5948 |
cause the sampler to switch to the respective instrument as |
cause the sampler to switch to the respective instrument as |
5949 |
reflected by the current MIDI instrument map. |
reflected by the current MIDI instrument map. |
5950 |
</p> |
</p> |
5951 |
|
<a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr /> |
5952 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5953 |
|
<a name="rfc.section.6.7.1"></a><h3>6.7.1. |
5954 |
|
Create a new MIDI instrument map</h3> |
5955 |
|
|
5956 |
|
<p>The front-end can add a new MIDI instrument map by sending |
5957 |
|
the following command: |
5958 |
|
</p> |
5959 |
|
<p> |
5960 |
|
</p> |
5961 |
|
<blockquote class="text"> |
5962 |
|
<p>ADD MIDI_INSTRUMENT_MAP [<name>] |
5963 |
|
</p> |
5964 |
|
</blockquote><p> |
5965 |
|
|
5966 |
|
</p> |
5967 |
|
<p>Where <name> is an optional argument allowing to |
5968 |
|
assign a custom name to the new map. MIDI instrument Map |
5969 |
|
names do not have to be unique. |
5970 |
|
</p> |
5971 |
|
<p>Possible Answers: |
5972 |
|
</p> |
5973 |
|
<p> |
5974 |
|
</p> |
5975 |
|
<blockquote class="text"> |
5976 |
|
<p>"OK[<map>]" - |
5977 |
|
</p> |
5978 |
|
<blockquote class="text"> |
5979 |
|
<p>in case a new MIDI instrument map could |
5980 |
|
be added, where <map> reflects the |
5981 |
|
unique ID of the newly created MIDI |
5982 |
|
instrument map |
5983 |
|
</p> |
5984 |
|
</blockquote> |
5985 |
|
|
5986 |
|
|
5987 |
|
<p>"ERR:<error-code>:<error-message>" - |
5988 |
|
</p> |
5989 |
|
<blockquote class="text"> |
5990 |
|
<p>when a new map could not be created, which |
5991 |
|
might never occur in practice |
5992 |
|
</p> |
5993 |
|
</blockquote> |
5994 |
|
|
5995 |
|
|
5996 |
|
</blockquote><p> |
5997 |
|
|
5998 |
|
</p> |
5999 |
|
<p>Examples: |
6000 |
|
</p> |
6001 |
|
<p> |
6002 |
|
</p> |
6003 |
|
<blockquote class="text"> |
6004 |
|
<p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'" |
6005 |
|
</p> |
6006 |
|
<p>S: "OK[0]" |
6007 |
|
</p> |
6008 |
|
</blockquote><p> |
6009 |
|
|
6010 |
|
</p> |
6011 |
|
<p> |
6012 |
|
</p> |
6013 |
|
<blockquote class="text"> |
6014 |
|
<p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'" |
6015 |
|
</p> |
6016 |
|
<p>S: "OK[1]" |
6017 |
|
</p> |
6018 |
|
</blockquote><p> |
6019 |
|
|
6020 |
|
</p> |
6021 |
|
<p> |
6022 |
|
</p> |
6023 |
|
<blockquote class="text"> |
6024 |
|
<p>C: "ADD MIDI_INSTRUMENT_MAP" |
6025 |
|
</p> |
6026 |
|
<p>S: "OK[5]" |
6027 |
|
</p> |
6028 |
|
</blockquote><p> |
6029 |
|
|
6030 |
|
</p> |
6031 |
|
<a name="REMOVE MIDI_INSTRUMENT_MAP"></a><br /><hr /> |
6032 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6033 |
|
<a name="rfc.section.6.7.2"></a><h3>6.7.2. |
6034 |
|
Delete one particular or all MIDI instrument maps</h3> |
6035 |
|
|
6036 |
|
<p>The front-end can delete a particular MIDI instrument map |
6037 |
|
by sending the following command: |
6038 |
|
</p> |
6039 |
|
<p> |
6040 |
|
</p> |
6041 |
|
<blockquote class="text"> |
6042 |
|
<p>REMOVE MIDI_INSTRUMENT_MAP <map> |
6043 |
|
</p> |
6044 |
|
</blockquote><p> |
6045 |
|
|
6046 |
|
</p> |
6047 |
|
<p>Where <map> reflects the unique ID of the map to delete |
6048 |
|
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> |
6049 |
|
command. |
6050 |
|
</p> |
6051 |
|
<p>The front-end can delete all MIDI instrument maps by |
6052 |
|
sending the following command: |
6053 |
|
</p> |
6054 |
|
<p> |
6055 |
|
</p> |
6056 |
|
<blockquote class="text"> |
6057 |
|
<p>REMOVE MIDI_INSTRUMENT_MAP ALL |
6058 |
|
</p> |
6059 |
|
</blockquote><p> |
6060 |
|
|
6061 |
|
</p> |
6062 |
|
<p>Possible Answers: |
6063 |
|
</p> |
6064 |
|
<p> |
6065 |
|
</p> |
6066 |
|
<blockquote class="text"> |
6067 |
|
<p>"OK" - |
6068 |
|
</p> |
6069 |
|
<blockquote class="text"> |
6070 |
|
<p>in case the map(s) could be deleted |
6071 |
|
</p> |
6072 |
|
</blockquote> |
6073 |
|
|
6074 |
|
|
6075 |
|
<p>"ERR:<error-code>:<error-message>" - |
6076 |
|
</p> |
6077 |
|
<blockquote class="text"> |
6078 |
|
<p>when the given map does not exist |
6079 |
|
</p> |
6080 |
|
</blockquote> |
6081 |
|
|
6082 |
|
|
6083 |
|
</blockquote><p> |
6084 |
|
|
6085 |
|
</p> |
6086 |
|
<p>Examples: |
6087 |
|
</p> |
6088 |
|
<p> |
6089 |
|
</p> |
6090 |
|
<blockquote class="text"> |
6091 |
|
<p>C: "REMOVE MIDI_INSTRUMENT_MAP 0" |
6092 |
|
</p> |
6093 |
|
<p>S: "OK" |
6094 |
|
</p> |
6095 |
|
</blockquote><p> |
6096 |
|
|
6097 |
|
</p> |
6098 |
|
<p> |
6099 |
|
</p> |
6100 |
|
<blockquote class="text"> |
6101 |
|
<p>C: "REMOVE MIDI_INSTRUMENT_MAP ALL" |
6102 |
|
</p> |
6103 |
|
<p>S: "OK" |
6104 |
|
</p> |
6105 |
|
</blockquote><p> |
6106 |
|
|
6107 |
|
</p> |
6108 |
|
<a name="GET MIDI_INSTRUMENT_MAPS"></a><br /><hr /> |
6109 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6110 |
|
<a name="rfc.section.6.7.3"></a><h3>6.7.3. |
6111 |
|
Get amount of existing MIDI instrument maps</h3> |
6112 |
|
|
6113 |
|
<p>The front-end can retrieve the current amount of MIDI |
6114 |
|
instrument maps by sending the following command: |
6115 |
|
</p> |
6116 |
|
<p> |
6117 |
|
</p> |
6118 |
|
<blockquote class="text"> |
6119 |
|
<p>GET MIDI_INSTRUMENT_MAPS |
6120 |
|
</p> |
6121 |
|
</blockquote><p> |
6122 |
|
|
6123 |
|
</p> |
6124 |
|
<p>Possible Answers: |
6125 |
|
</p> |
6126 |
|
<p> |
6127 |
|
</p> |
6128 |
|
<blockquote class="text"> |
6129 |
|
<p>The sampler will answer by returning the current |
6130 |
|
number of MIDI instrument maps. |
6131 |
|
</p> |
6132 |
|
</blockquote><p> |
6133 |
|
|
6134 |
|
</p> |
6135 |
|
<p>Example: |
6136 |
|
</p> |
6137 |
|
<p> |
6138 |
|
</p> |
6139 |
|
<blockquote class="text"> |
6140 |
|
<p>C: "GET MIDI_INSTRUMENT_MAPS" |
6141 |
|
</p> |
6142 |
|
<p>S: "2" |
6143 |
|
</p> |
6144 |
|
</blockquote><p> |
6145 |
|
|
6146 |
|
</p> |
6147 |
|
<a name="LIST MIDI_INSTRUMENT_MAPS"></a><br /><hr /> |
6148 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6149 |
|
<a name="rfc.section.6.7.4"></a><h3>6.7.4. |
6150 |
|
Getting all created MIDI instrument maps</h3> |
6151 |
|
|
6152 |
|
<p>The number of MIDI instrument maps can change on runtime. To get the |
6153 |
|
current list of MIDI instrument maps, the front-end can send the |
6154 |
|
following command: |
6155 |
|
</p> |
6156 |
|
<p> |
6157 |
|
</p> |
6158 |
|
<blockquote class="text"> |
6159 |
|
<p>LIST MIDI_INSTRUMENT_MAPS |
6160 |
|
</p> |
6161 |
|
</blockquote><p> |
6162 |
|
|
6163 |
|
</p> |
6164 |
|
<p>Possible Answers: |
6165 |
|
</p> |
6166 |
|
<p> |
6167 |
|
</p> |
6168 |
|
<blockquote class="text"> |
6169 |
|
<p>The sampler will answer by returning a comma separated list |
6170 |
|
with all MIDI instrument maps' numerical IDs. |
6171 |
|
</p> |
6172 |
|
</blockquote><p> |
6173 |
|
|
6174 |
|
</p> |
6175 |
|
<p>Example: |
6176 |
|
</p> |
6177 |
|
<p> |
6178 |
|
</p> |
6179 |
|
<blockquote class="text"> |
6180 |
|
<p>C: "LIST MIDI_INSTRUMENT_MAPS" |
6181 |
|
</p> |
6182 |
|
<p>S: "0,1,5,12" |
6183 |
|
</p> |
6184 |
|
</blockquote><p> |
6185 |
|
|
6186 |
|
</p> |
6187 |
|
<a name="GET MIDI_INSTRUMENT_MAP INFO"></a><br /><hr /> |
6188 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6189 |
|
<a name="rfc.section.6.7.5"></a><h3>6.7.5. |
6190 |
|
Getting MIDI instrument map information</h3> |
6191 |
|
|
6192 |
|
<p>The front-end can ask for the current settings of a MIDI |
6193 |
|
instrument map by sending the following command: |
6194 |
|
</p> |
6195 |
|
<p> |
6196 |
|
</p> |
6197 |
|
<blockquote class="text"> |
6198 |
|
<p>GET MIDI_INSTRUMENT_MAP INFO <map> |
6199 |
|
</p> |
6200 |
|
</blockquote><p> |
6201 |
|
|
6202 |
|
</p> |
6203 |
|
<p>Where <map> is the numerical ID of the map the |
6204 |
|
front-end is interested in as returned by the |
6205 |
|
<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> |
6206 |
|
command. |
6207 |
|
</p> |
6208 |
|
<p>Possible Answers: |
6209 |
|
</p> |
6210 |
|
<p> |
6211 |
|
</p> |
6212 |
|
<blockquote class="text"> |
6213 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
6214 |
|
Each answer line begins with the settings category name |
6215 |
|
followed by a colon and then a space character <SP> and finally |
6216 |
|
the info character string to that setting category. At the |
6217 |
|
moment the following categories are defined: |
6218 |
|
</p> |
6219 |
|
<p> |
6220 |
|
</p> |
6221 |
|
<blockquote class="text"> |
6222 |
|
<p>NAME - |
6223 |
|
</p> |
6224 |
|
<blockquote class="text"> |
6225 |
|
<p>custom name of the given map, |
6226 |
|
which does not have to be unique |
6227 |
|
</p> |
6228 |
|
</blockquote> |
6229 |
|
|
6230 |
|
|
6231 |
|
</blockquote> |
6232 |
|
|
6233 |
|
|
6234 |
|
</blockquote><p> |
6235 |
|
|
6236 |
|
</p> |
6237 |
|
<p>The mentioned fields above don't have to be in particular order. |
6238 |
|
</p> |
6239 |
|
<p>Example: |
6240 |
|
</p> |
6241 |
|
<p> |
6242 |
|
</p> |
6243 |
|
<blockquote class="text"> |
6244 |
|
<p>C: "GET MIDI_INSTRUMENT_MAP INFO 0" |
6245 |
|
</p> |
6246 |
|
<p>S: "NAME: Standard Map" |
6247 |
|
</p> |
6248 |
|
<p> "." |
6249 |
|
</p> |
6250 |
|
</blockquote><p> |
6251 |
|
|
6252 |
|
</p> |
6253 |
|
<a name="SET MIDI_INSTRUMENT_MAP NAME"></a><br /><hr /> |
6254 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6255 |
|
<a name="rfc.section.6.7.6"></a><h3>6.7.6. |
6256 |
|
Renaming a MIDI instrument map</h3> |
6257 |
|
|
6258 |
|
<p>The front-end can alter the custom name of a MIDI |
6259 |
|
instrument map by sending the following command: |
6260 |
|
</p> |
6261 |
|
<p> |
6262 |
|
</p> |
6263 |
|
<blockquote class="text"> |
6264 |
|
<p>SET MIDI_INSTRUMENT_MAP NAME <map> <name> |
6265 |
|
</p> |
6266 |
|
</blockquote><p> |
6267 |
|
|
6268 |
|
</p> |
6269 |
|
<p>Where <map> is the numerical ID of the map and |
6270 |
|
<name> the new custom name of the map, which does not |
6271 |
|
have to be unique. |
6272 |
|
</p> |
6273 |
|
<p>Possible Answers: |
6274 |
|
</p> |
6275 |
|
<p> |
6276 |
|
</p> |
6277 |
|
<blockquote class="text"> |
6278 |
|
<p>"OK" - |
6279 |
|
</p> |
6280 |
|
<blockquote class="text"> |
6281 |
|
<p>on success |
6282 |
|
</p> |
6283 |
|
</blockquote> |
6284 |
|
|
6285 |
|
|
6286 |
|
<p>"ERR:<error-code>:<error-message>" - |
6287 |
|
</p> |
6288 |
|
<blockquote class="text"> |
6289 |
|
<p>in case the given map does not exist |
6290 |
|
</p> |
6291 |
|
</blockquote> |
6292 |
|
|
6293 |
|
|
6294 |
|
</blockquote><p> |
6295 |
|
|
6296 |
|
</p> |
6297 |
|
<p>Example: |
6298 |
|
</p> |
6299 |
|
<p> |
6300 |
|
</p> |
6301 |
|
<blockquote class="text"> |
6302 |
|
<p>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'" |
6303 |
|
</p> |
6304 |
|
<p>S: "OK" |
6305 |
|
</p> |
6306 |
|
</blockquote><p> |
6307 |
|
|
6308 |
|
</p> |
6309 |
<a name="MAP MIDI_INSTRUMENT"></a><br /><hr /> |
<a name="MAP MIDI_INSTRUMENT"></a><br /><hr /> |
6310 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6311 |
<a name="rfc.section.6.7.1"></a><h3>6.7.1. Create or replace a MIDI instrument map entry</h3> |
<a name="rfc.section.6.7.7"></a><h3>6.7.7. |
6312 |
|
Create or replace a MIDI instrument map entry</h3> |
6313 |
|
|
6314 |
<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 |
6315 |
in the sampler's MIDI instrument map by sending the following |
in a sampler's MIDI instrument map by sending the following |
6316 |
command: |
command: |
6317 |
</p> |
</p> |
6318 |
<p> |
<p> |
6319 |
</p> |
</p> |
6320 |
<blockquote class="text"> |
<blockquote class="text"> |
6321 |
<p>MAP MIDI_INSTRUMENT <midi_bank_msb> |
<p>MAP MIDI_INSTRUMENT <map> |
6322 |
<midi_bank_lsb> <midi_prog> <engine_name> |
<midi_bank> <midi_prog> <engine_name> |
6323 |
<filename> <instrument_index> <volume_value> |
<filename> <instrument_index> <volume_value> |
6324 |
[<instr_load_mode>] [<name>] |
[<instr_load_mode>] [<name>] |
6325 |
</p> |
</p> |
6326 |
</blockquote><p> |
</blockquote><p> |
6327 |
|
|
6328 |
</p> |
</p> |
6329 |
<p>Where <midi_bank_msb> is an integer value between |
<p>Where <map> is the numeric ID of the map to alter, |
6330 |
0..127 reflecting the MIDI bank select MSB (coarse) index, |
<midi_bank> is an integer value between |
6331 |
<midi_bank_lsb> an integer value between 0..127 reflecting |
0..16383 reflecting the MIDI bank select index, |
6332 |
the MIDI bank select LSB (fine) index, <midi_prog> an |
<midi_prog> an |
6333 |
integer value between 0..127 reflecting the MIDI program change |
integer value between 0..127 reflecting the MIDI program change |
6334 |
index, <engine_name> a sampler engine name as returned by |
index, <engine_name> a sampler engine name as returned by |
6335 |
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> |
6336 |
command (not encapsulated into apostrophes), <filename> the name |
command (not encapsulated into apostrophes), <filename> the name |
6337 |
of the instrument's file to be deployed (encapsulated into apostrophes), <instrument_index> the index (integer value) of the instrument |
of the instrument's file to be deployed (encapsulated into apostrophes), |
6338 |
|
<instrument_index> the index (integer value) of the instrument |
6339 |
within the given file, <volume_value> reflects the master |
within the given file, <volume_value> reflects the master |
6340 |
volume of the instrument as optionally dotted number (where a |
volume of the instrument as optionally dotted number (where a |
6341 |
value < 1.0 means attenuation and a value > 1.0 means |
value < 1.0 means attenuation and a value > 1.0 means |
6430 |
individually. Due to this, in case the frontend shows the |
individually. Due to this, in case the frontend shows the |
6431 |
load modes of entries, the frontend should retrieve the actual |
load modes of entries, the frontend should retrieve the actual |
6432 |
mode by i.e. sending |
mode by i.e. sending |
6433 |
<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> |
6434 |
command(s). Finally the OPTIONAL <name> argument allows to |
command(s). Finally the OPTIONAL <name> argument allows to |
6435 |
set a custom name (encapsulated into apostrophes) for the mapping |
set a custom name (encapsulated into apostrophes) for the mapping |
6436 |
entry, useful for frontends for displaying an appropriate name for |
entry, useful for frontends for displaying an appropriate name for |
6437 |
mapped instruments (using |
mapped instruments (using |
6438 |
<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>). |
6439 |
|
|
6440 |
</p> |
</p> |
6441 |
<p> |
<p> |
6464 |
<p>"ERR:<error-code>:<error-message>" - |
<p>"ERR:<error-code>:<error-message>" - |
6465 |
</p> |
</p> |
6466 |
<blockquote class="text"> |
<blockquote class="text"> |
6467 |
<p>when the given engine does not exist or a value |
<p>when the given map or engine does not exist or a value |
6468 |
is out of range |
is out of range |
6469 |
</p> |
</p> |
6470 |
</blockquote> |
</blockquote> |
6478 |
<p> |
<p> |
6479 |
</p> |
</p> |
6480 |
<blockquote class="text"> |
<blockquote class="text"> |
6481 |
<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" |
6482 |
</p> |
</p> |
6483 |
<p>S: "OK" |
<p>S: "OK" |
6484 |
</p> |
</p> |
6488 |
<p> |
<p> |
6489 |
</p> |
</p> |
6490 |
<blockquote class="text"> |
<blockquote class="text"> |
6491 |
<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" |
6492 |
</p> |
</p> |
6493 |
<p>S: "OK" |
<p>S: "OK" |
6494 |
</p> |
</p> |
6502 |
</p> |
</p> |
6503 |
<p>S: "OK" |
<p>S: "OK" |
6504 |
</p> |
</p> |
6505 |
<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'" |
6506 |
</p> |
</p> |
6507 |
<p>S: "OK" |
<p>S: "OK" |
6508 |
</p> |
</p> |
6512 |
<p> |
<p> |
6513 |
</p> |
</p> |
6514 |
<blockquote class="text"> |
<blockquote class="text"> |
6515 |
<p>C: "MAP MIDI_INSTRUMENT 99 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'" |
<p>C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'" |
6516 |
</p> |
</p> |
6517 |
<p>S: "OK" |
<p>S: "OK" |
6518 |
</p> |
</p> |
6520 |
|
|
6521 |
</p> |
</p> |
6522 |
<a name="GET MIDI_INSTRUMENTS"></a><br /><hr /> |
<a name="GET MIDI_INSTRUMENTS"></a><br /><hr /> |
6523 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6524 |
<a name="rfc.section.6.7.2"></a><h3>6.7.2. Getting ammount of MIDI instrument map entries</h3> |
<a name="rfc.section.6.7.8"></a><h3>6.7.8. |
6525 |
|
Getting ammount of MIDI instrument map entries</h3> |
6526 |
|
|
6527 |
<p>The front-end can query the amount of currently existing MIDI |
<p>The front-end can query the amount of currently existing |
6528 |
instrument map entries by sending the following |
entries in a MIDI instrument map by sending the following |
6529 |
|
command: |
6530 |
|
</p> |
6531 |
|
<p> |
6532 |
|
</p> |
6533 |
|
<blockquote class="text"> |
6534 |
|
<p>GET MIDI_INSTRUMENTS <map> |
6535 |
|
</p> |
6536 |
|
</blockquote><p> |
6537 |
|
|
6538 |
|
</p> |
6539 |
|
<p>The front-end can query the amount of currently existing |
6540 |
|
entries in all MIDI instrument maps by sending the following |
6541 |
command: |
command: |
6542 |
</p> |
</p> |
6543 |
<p> |
<p> |
6544 |
</p> |
</p> |
6545 |
<blockquote class="text"> |
<blockquote class="text"> |
6546 |
<p>GET MIDI_INSTRUMENTS |
<p>GET MIDI_INSTRUMENTS ALL |
6547 |
</p> |
</p> |
6548 |
</blockquote><p> |
</blockquote><p> |
6549 |
|
|
6553 |
<p> |
<p> |
6554 |
</p> |
</p> |
6555 |
<blockquote class="text"> |
<blockquote class="text"> |
6556 |
<p>LinuxSampler will answer by sending the current number of |
<p>The sampler will answer by sending the current number of |
6557 |
entries in the sampler's MIDI instrument map. |
entries in the MIDI instrument map(s). |
6558 |
</p> |
</p> |
6559 |
</blockquote><p> |
</blockquote><p> |
6560 |
|
|
6564 |
<p> |
<p> |
6565 |
</p> |
</p> |
6566 |
<blockquote class="text"> |
<blockquote class="text"> |
6567 |
<p>C: "GET MIDI_INSTRUMENTS" |
<p>C: "GET MIDI_INSTRUMENTS 0" |
6568 |
</p> |
</p> |
6569 |
<p>S: "634" |
<p>S: "234" |
6570 |
|
</p> |
6571 |
|
</blockquote><p> |
6572 |
|
|
6573 |
|
</p> |
6574 |
|
<p> |
6575 |
|
</p> |
6576 |
|
<blockquote class="text"> |
6577 |
|
<p>C: "GET MIDI_INSTRUMENTS ALL" |
6578 |
|
</p> |
6579 |
|
<p>S: "954" |
6580 |
</p> |
</p> |
6581 |
</blockquote><p> |
</blockquote><p> |
6582 |
|
|
6583 |
</p> |
</p> |
6584 |
<a name="LIST MIDI_INSTRUMENTS"></a><br /><hr /> |
<a name="LIST MIDI_INSTRUMENTS"></a><br /><hr /> |
6585 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6586 |
<a name="rfc.section.6.7.3"></a><h3>6.7.3. Getting indeces of all MIDI instrument map entries</h3> |
<a name="rfc.section.6.7.9"></a><h3>6.7.9. |
6587 |
|
Getting indeces of all entries of a MIDI instrument map</h3> |
6588 |
|
|
6589 |
<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 |
6590 |
instrument map entries by sending the following command: |
entries in a certain MIDI instrument map by sending the following |
6591 |
|
command: |
6592 |
</p> |
</p> |
6593 |
<p> |
<p> |
6594 |
</p> |
</p> |
6595 |
<blockquote class="text"> |
<blockquote class="text"> |
6596 |
<p>LIST MIDI_INSTRUMENTS |
<p>LIST MIDI_INSTRUMENTS <map> |
6597 |
|
</p> |
6598 |
|
</blockquote><p> |
6599 |
|
|
6600 |
|
</p> |
6601 |
|
<p>Where <map> is the numeric ID of the MIDI instrument map. |
6602 |
|
</p> |
6603 |
|
<p>The front-end can query a list of all currently existing |
6604 |
|
entries of all MIDI instrument maps by sending the following |
6605 |
|
command: |
6606 |
|
</p> |
6607 |
|
<p> |
6608 |
|
</p> |
6609 |
|
<blockquote class="text"> |
6610 |
|
<p>LIST MIDI_INSTRUMENTS ALL |
6611 |
</p> |
</p> |
6612 |
</blockquote><p> |
</blockquote><p> |
6613 |
|
|
6617 |
<p> |
<p> |
6618 |
</p> |
</p> |
6619 |
<blockquote class="text"> |
<blockquote class="text"> |
6620 |
<p>LinuxSampler will answer by sending a comma separated |
<p>The sampler will answer by sending a comma separated |
6621 |
list of MIDI bank MSB (coarse) - MIDI bank LSB (fine) - |
list of map ID - MIDI bank - MIDI program triples, where |
6622 |
MIDI program triples, where each triple is encapsulated |
each triple is encapsulated into curly braces. The |
6623 |
into curly braces. The list is returned in one single |
list is returned in one single line. Each triple |
6624 |
line. Each triple just reflects the key of the respective |
just reflects the key of the respective map entry, |
6625 |
map entry, thus subsequent |
thus subsequent |
6626 |
<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> |
6627 |
command(s) are necessary to retrieve detailed informations |
command(s) are necessary to retrieve detailed informations |
6628 |
about each entry. |
about each entry. |
6629 |
</p> |
</p> |
6635 |
<p> |
<p> |
6636 |
</p> |
</p> |
6637 |
<blockquote class="text"> |
<blockquote class="text"> |
6638 |
<p>C: "LIST MIDI_INSTRUMENTS" |
<p>C: "LIST MIDI_INSTRUMENTS 0" |
6639 |
</p> |
</p> |
6640 |
<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}" |
6641 |
</p> |
</p> |
6642 |
</blockquote><p> |
</blockquote><p> |
6643 |
|
|
6644 |
</p> |
</p> |
6645 |
<a name="UNMAP MIDI_INSTRUMENT"></a><br /><hr /> |
<a name="UNMAP MIDI_INSTRUMENT"></a><br /><hr /> |
6646 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6647 |
<a name="rfc.section.6.7.4"></a><h3>6.7.4. Remove an entry from the MIDI instrument map</h3> |
<a name="rfc.section.6.7.10"></a><h3>6.7.10. |
6648 |
|
Remove an entry from the MIDI instrument map</h3> |
6649 |
|
|
6650 |
<p>The front-end can delete an entry from the MIDI instrument |
<p>The front-end can delete an entry from a MIDI instrument |
6651 |
map by sending the following command: |
map by sending the following command: |
6652 |
</p> |
</p> |
6653 |
<p> |
<p> |
6654 |
</p> |
</p> |
6655 |
<blockquote class="text"> |
<blockquote class="text"> |
6656 |
<p>UNMAP MIDI_INSTRUMENT <midi_bank_msb> <midi_bank_lsb> <midi_prog> |
<p>UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog> |
6657 |
</p> |
</p> |
6658 |
</blockquote><p> |
</blockquote><p> |
6659 |
|
|
6660 |
</p> |
</p> |
6661 |
<p> |
<p> |
6662 |
Where <midi_bank_msb> is an integer value between 0..127 |
Where <map> is the numeric ID of the MIDI instrument map, |
6663 |
reflecting the MIDI bank MSB (coarse) value, <midi_bank_lsb> |
<midi_bank> is an integer value between 0..16383 |
6664 |
an integer value between 0..127 reflecting the MIDI bank LSB |
reflecting the MIDI bank value and |
6665 |
(fine) value and <midi_prog> an integer value between |
<midi_prog> an integer value between |
6666 |
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 |
6667 |
index triple. |
index triple. |
6668 |
|
|
6669 |
</p> |
</p> |
6696 |
<p> |
<p> |
6697 |
</p> |
</p> |
6698 |
<blockquote class="text"> |
<blockquote class="text"> |
6699 |
<p>C: "UNMAP MIDI_INSTRUMENT 2 40 127" |
<p>C: "UNMAP MIDI_INSTRUMENT 0 2 127" |
6700 |
</p> |
</p> |
6701 |
<p>S: "OK" |
<p>S: "OK" |
6702 |
</p> |
</p> |
6704 |
|
|
6705 |
</p> |
</p> |
6706 |
<a name="GET MIDI_INSTRUMENT INFO"></a><br /><hr /> |
<a name="GET MIDI_INSTRUMENT INFO"></a><br /><hr /> |
6707 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6708 |
<a name="rfc.section.6.7.5"></a><h3>6.7.5. Get current settings of MIDI instrument map entry</h3> |
<a name="rfc.section.6.7.11"></a><h3>6.7.11. |
6709 |
|
Get current settings of MIDI instrument map entry</h3> |
6710 |
|
|
6711 |
<p>The front-end can retrieve the current settings of a certain |
<p>The front-end can retrieve the current settings of a certain |
6712 |
instrument map entry by sending the following command: |
instrument map entry by sending the following command: |
6714 |
<p> |
<p> |
6715 |
</p> |
</p> |
6716 |
<blockquote class="text"> |
<blockquote class="text"> |
6717 |
<p>GET MIDI_INSTRUMENT INFO <midi_bank_msb> <midi_bank_lsb> <midi_prog> |
<p>GET MIDI_INSTRUMENT INFO <map> <midi_bank> <midi_prog> |
6718 |
</p> |
</p> |
6719 |
</blockquote><p> |
</blockquote><p> |
6720 |
|
|
6721 |
</p> |
</p> |
6722 |
<p> |
<p> |
6723 |
Where <midi_bank_msb> is an integer value between 0..127 |
Where <map> is the numeric ID of the MIDI instrument map, |
6724 |
reflecting the MIDI bank MSB (coarse) value, <midi_bank_lsb> |
<midi_bank> is an integer value between 0..16383 |
6725 |
an integer value between 0..127 reflecting the MIDI bank LSB |
reflecting the MIDI bank value, <midi_bank> |
6726 |
(fine) value and <midi_prog> an integer value between |
and <midi_prog> an integer value between |
6727 |
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 |
6728 |
index triple. |
index triple. |
6729 |
|
|
6730 |
</p> |
</p> |
6747 |
This name shall be used by frontends for displaying a |
This name shall be used by frontends for displaying a |
6748 |
name for this mapped instrument. It can be set and |
name for this mapped instrument. It can be set and |
6749 |
changed with the |
changed with the |
6750 |
<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> |
6751 |
command and does not have to be unique. |
command and does not have to be unique. |
6752 |
</p> |
</p> |
6753 |
</blockquote> |
</blockquote> |
6792 |
</p> |
</p> |
6793 |
<blockquote class="text"> |
<blockquote class="text"> |
6794 |
<p>Life time of instrument |
<p>Life time of instrument |
6795 |
(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). |
6796 |
</p> |
</p> |
6797 |
</blockquote> |
</blockquote> |
6798 |
|
|
6817 |
<p> |
<p> |
6818 |
</p> |
</p> |
6819 |
<blockquote class="text"> |
<blockquote class="text"> |
6820 |
<p>C: "GET MIDI_INSTRUMENT INFO 3 45 120" |
<p>C: "GET MIDI_INSTRUMENT INFO 1 45 120" |
6821 |
</p> |
</p> |
6822 |
<p>S: "NAME: Drums for Foo Song" |
<p>S: "NAME: Drums for Foo Song" |
6823 |
</p> |
</p> |
6839 |
|
|
6840 |
</p> |
</p> |
6841 |
<a name="CLEAR MIDI_INSTRUMENTS"></a><br /><hr /> |
<a name="CLEAR MIDI_INSTRUMENTS"></a><br /><hr /> |
6842 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6843 |
<a name="rfc.section.6.7.6"></a><h3>6.7.6. Clear MIDI instrument map</h3> |
<a name="rfc.section.6.7.12"></a><h3>6.7.12. |
6844 |
|
Clear MIDI instrument map</h3> |
6845 |
|
|
6846 |
<p>The front-end can clear the whole MIDI instrument map, that |
<p>The front-end can clear a whole MIDI instrument map, that |
6847 |
is delete all entries by sending the following command: |
is delete all its entries by sending the following command: |
6848 |
</p> |
</p> |
6849 |
<p> |
<p> |
6850 |
</p> |
</p> |
6851 |
<blockquote class="text"> |
<blockquote class="text"> |
6852 |
<p>CLEAR MIDI_INSTRUMENTS |
<p>CLEAR MIDI_INSTRUMENTS <map> |
6853 |
</p> |
</p> |
6854 |
</blockquote><p> |
</blockquote><p> |
6855 |
|
|
6856 |
</p> |
</p> |
6857 |
|
<p>Where <map> is the numeric ID of the map to clear. |
6858 |
|
</p> |
6859 |
|
<p>The front-end can clear all MIDI instrument maps, that |
6860 |
|
is delete all entries of all maps by sending the following |
6861 |
|
command: |
6862 |
|
</p> |
6863 |
|
<p> |
6864 |
|
</p> |
6865 |
|
<blockquote class="text"> |
6866 |
|
<p>CLEAR MIDI_INSTRUMENTS ALL |
6867 |
|
</p> |
6868 |
|
</blockquote><p> |
6869 |
|
|
6870 |
|
</p> |
6871 |
|
<p>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the |
6872 |
|
maps, only their entries, thus the map's settings like |
6873 |
|
custom name will be preservevd. |
6874 |
|
</p> |
6875 |
<p>Possible Answers: |
<p>Possible Answers: |
6876 |
</p> |
</p> |
6877 |
<p> |
<p> |
6888 |
</blockquote><p> |
</blockquote><p> |
6889 |
|
|
6890 |
</p> |
</p> |
6891 |
<p>Example: |
<p>Examples: |
6892 |
|
</p> |
6893 |
|
<p> |
6894 |
|
</p> |
6895 |
|
<blockquote class="text"> |
6896 |
|
<p>C: "CLEAR MIDI_INSTRUMENTS 0" |
6897 |
|
</p> |
6898 |
|
<p>S: "OK" |
6899 |
|
</p> |
6900 |
|
</blockquote><p> |
6901 |
|
|
6902 |
</p> |
</p> |
6903 |
<p> |
<p> |
6904 |
</p> |
</p> |
6905 |
<blockquote class="text"> |
<blockquote class="text"> |
6906 |
<p>C: "CLEAR MIDI_INSTRUMENTS" |
<p>C: "CLEAR MIDI_INSTRUMENTS ALL" |
6907 |
</p> |
</p> |
6908 |
<p>S: "OK" |
<p>S: "OK" |
6909 |
</p> |
</p> |
6911 |
|
|
6912 |
</p> |
</p> |
6913 |
<a name="command_syntax"></a><br /><hr /> |
<a name="command_syntax"></a><br /><hr /> |
6914 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6915 |
<a name="rfc.section.7"></a><h3>7. Command Syntax</h3> |
<a name="rfc.section.7"></a><h3>7. |
6916 |
|
Command Syntax</h3> |
6917 |
|
|
6918 |
<p>The grammar of the control protocol as descibed in <a class="info" href="#control_commands">Section 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 6<span> (</span><span class='info'>Description for control commands</span><span>)</span></a> |
6919 |
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, “Augmented BNF for Syntax Specifications,” 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, “Augmented BNF for Syntax Specifications,” 1997.</span><span>)</span></a>) |
6920 |
where applicable. |
where applicable. |
6921 |
|
|
6922 |
</p> |
</p> |
6974 |
<p>command = |
<p>command = |
6975 |
</p> |
</p> |
6976 |
<blockquote class="text"> |
<blockquote class="text"> |
6977 |
<p>ADD SP CHANNEL |
<p>ADD SP add_instruction |
6978 |
|
|
6979 |
</p> |
</p> |
6980 |
<p>/ MAP SP map_instruction |
<p>/ MAP SP map_instruction |
6999 |
|
|
7000 |
</p> |
</p> |
7001 |
<p>/ REMOVE SP remove_instruction |
<p>/ REMOVE SP remove_instruction |
|
|
|
7002 |
|
|
7003 |
</p> |
</p> |
7004 |
<p>/ SET SP set_instruction |
<p>/ SET SP set_instruction |
7028 |
</blockquote><p> |
</blockquote><p> |
7029 |
|
|
7030 |
</p> |
</p> |
7031 |
|
<p>add_instruction = |
7032 |
|
</p> |
7033 |
|
<blockquote class="text"> |
7034 |
|
<p>CHANNEL |
7035 |
|
|
7036 |
|
</p> |
7037 |
|
<p>/ MIDI_INSTRUMENT_MAP |
7038 |
|
|
7039 |
|
</p> |
7040 |
|
<p>/ MIDI_INSTRUMENT_MAP SP map_name |
7041 |
|
|
7042 |
|
</p> |
7043 |
|
</blockquote><p> |
7044 |
|
|
7045 |
|
</p> |
7046 |
<p>subscribe_event = |
<p>subscribe_event = |
7047 |
</p> |
</p> |
7048 |
<blockquote class="text"> |
<blockquote class="text"> |
7049 |
<p>CHANNEL_COUNT |
<p>AUDIO_OUTPUT_DEVICE_COUNT |
7050 |
|
|
7051 |
|
</p> |
7052 |
|
<p>/ AUDIO_OUTPUT_DEVICE_INFO |
7053 |
|
|
7054 |
|
</p> |
7055 |
|
<p>/ MIDI_INPUT_DEVICE_COUNT |
7056 |
|
|
7057 |
|
</p> |
7058 |
|
<p>/ MIDI_INPUT_DEVICE_INFO |
7059 |
|
|
7060 |
|
</p> |
7061 |
|
<p>/ CHANNEL_COUNT |
7062 |
|
|
7063 |
</p> |
</p> |
7064 |
<p>/ VOICE_COUNT |
<p>/ VOICE_COUNT |
7073 |
<p>/ CHANNEL_INFO |
<p>/ CHANNEL_INFO |
7074 |
|
|
7075 |
</p> |
</p> |
7076 |
|
<p>/ MIDI_INSTRUMENT_MAP_COUNT |
7077 |
|
|
7078 |
|
</p> |
7079 |
|
<p>/ MIDI_INSTRUMENT_MAP_INFO |
7080 |
|
|
7081 |
|
</p> |
7082 |
|
<p>/ MIDI_INSTRUMENT_COUNT |
7083 |
|
|
7084 |
|
</p> |
7085 |
|
<p>/ MIDI_INSTRUMENT_INFO |
7086 |
|
|
7087 |
|
</p> |
7088 |
<p>/ MISCELLANEOUS |
<p>/ MISCELLANEOUS |
7089 |
|
|
7090 |
</p> |
</p> |
7097 |
<p>unsubscribe_event = |
<p>unsubscribe_event = |
7098 |
</p> |
</p> |
7099 |
<blockquote class="text"> |
<blockquote class="text"> |
7100 |
<p>CHANNEL_COUNT |
<p>AUDIO_OUTPUT_DEVICE_COUNT |
7101 |
|
|
7102 |
|
</p> |
7103 |
|
<p>/ AUDIO_OUTPUT_DEVICE_INFO |
7104 |
|
|
7105 |
|
</p> |
7106 |
|
<p>/ MIDI_INPUT_DEVICE_COUNT |
7107 |
|
|
7108 |
|
</p> |
7109 |
|
<p>/ MIDI_INPUT_DEVICE_INFO |
7110 |
|
|
7111 |
|
</p> |
7112 |
|
<p>/ CHANNEL_COUNT |
7113 |
|
|
7114 |
</p> |
</p> |
7115 |
<p>/ VOICE_COUNT |
<p>/ VOICE_COUNT |
7124 |
<p>/ CHANNEL_INFO |
<p>/ CHANNEL_INFO |
7125 |
|
|
7126 |
</p> |
</p> |
7127 |
|
<p>/ MIDI_INSTRUMENT_MAP_COUNT |
7128 |
|
|
7129 |
|
</p> |
7130 |
|
<p>/ MIDI_INSTRUMENT_MAP_INFO |
7131 |
|
|
7132 |
|
</p> |
7133 |
|
<p>/ MIDI_INSTRUMENT_COUNT |
7134 |
|
|
7135 |
|
</p> |
7136 |
|
<p>/ MIDI_INSTRUMENT_INFO |
7137 |
|
|
7138 |
|
</p> |
7139 |
<p>/ MISCELLANEOUS |
<p>/ MISCELLANEOUS |
7140 |
|
|
7141 |
</p> |
</p> |
7148 |
<p>map_instruction = |
<p>map_instruction = |
7149 |
</p> |
</p> |
7150 |
<blockquote class="text"> |
<blockquote class="text"> |
7151 |
<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 midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value |
7152 |
|
|
7153 |
</p> |
</p> |
7154 |
<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 midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode |
7155 |
|
|
7156 |
</p> |
</p> |
7157 |
<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 midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name |
7158 |
|
|
7159 |
</p> |
</p> |
7160 |
<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 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 |
7161 |
|
|
7162 |
</p> |
</p> |
7163 |
</blockquote><p> |
</blockquote><p> |
7166 |
<p>unmap_instruction = |
<p>unmap_instruction = |
7167 |
</p> |
</p> |
7168 |
<blockquote class="text"> |
<blockquote class="text"> |
7169 |
<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 |
7170 |
|
|
7171 |
</p> |
</p> |
7172 |
</blockquote><p> |
</blockquote><p> |
7178 |
<p>CHANNEL SP sampler_channel |
<p>CHANNEL SP sampler_channel |
7179 |
|
|
7180 |
</p> |
</p> |
7181 |
|
<p>/ MIDI_INSTRUMENT_MAP SP midi_map |
7182 |
|
|
7183 |
|
</p> |
7184 |
|
<p>/ MIDI_INSTRUMENT_MAP SP ALL |
7185 |
|
|
7186 |
|
</p> |
7187 |
</blockquote><p> |
</blockquote><p> |
7188 |
|
|
7189 |
</p> |
</p> |
7268 |
<p>/ TOTAL_VOICE_COUNT_MAX |
<p>/ TOTAL_VOICE_COUNT_MAX |
7269 |
|
|
7270 |
</p> |
</p> |
7271 |
<p>/ MIDI_INSTRUMENTS |
<p>/ MIDI_INSTRUMENTS SP midi_map |
7272 |
|
|
7273 |
</p> |
</p> |
7274 |
<p>/ MIDI_INSTRUMENT SP INFO SP midi_bank_msb SP midi_bank_lsb SP midi_prog |
<p>/ MIDI_INSTRUMENTS SP ALL |
7275 |
|
|
7276 |
|
</p> |
7277 |
|
<p>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog |
7278 |
|
|
7279 |
|
</p> |
7280 |
|
<p>/ MIDI_INSTRUMENT_MAPS |
7281 |
|
|
7282 |
|
</p> |
7283 |
|
<p>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
7284 |
|
|
7285 |
|
</p> |
7286 |
|
<p>/ FX_SENDS SP sampler_channel |
7287 |
|
|
7288 |
|
</p> |
7289 |
|
<p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
7290 |
|
|
7291 |
|
</p> |
7292 |
|
<p>/ VOLUME |
7293 |
|
|
7294 |
</p> |
</p> |
7295 |
</blockquote><p> |
</blockquote><p> |
7313 |
<p>/ CHANNEL SP set_chan_instruction |
<p>/ CHANNEL SP set_chan_instruction |
7314 |
|
|
7315 |
</p> |
</p> |
7316 |
|
<p>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
7317 |
|
|
7318 |
|
</p> |
7319 |
|
<p>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index |
7320 |
|
|
7321 |
|
</p> |
7322 |
<p>/ ECHO SP boolean |
<p>/ ECHO SP boolean |
7323 |
|
|
7324 |
</p> |
</p> |
7325 |
|
<p>/ VOLUME SP volume_value |
7326 |
|
|
7327 |
|
</p> |
7328 |
</blockquote><p> |
</blockquote><p> |
7329 |
|
|
7330 |
</p> |
</p> |
7343 |
<p>/ MIDI_INPUT_DEVICE SP string |
<p>/ MIDI_INPUT_DEVICE SP string |
7344 |
|
|
7345 |
</p> |
</p> |
7346 |
|
<p>/ FX_SEND SP sampler_channel SP midi_ctrl |
7347 |
|
|
7348 |
|
</p> |
7349 |
|
<p>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
7350 |
|
|
7351 |
|
</p> |
7352 |
</blockquote><p> |
</blockquote><p> |
7353 |
|
|
7354 |
</p> |
</p> |
7364 |
<p>clear_instruction = |
<p>clear_instruction = |
7365 |
</p> |
</p> |
7366 |
<blockquote class="text"> |
<blockquote class="text"> |
7367 |
<p>MIDI_INSTRUMENTS |
<p>MIDI_INSTRUMENTS SP midi_map |
7368 |
|
|
7369 |
|
</p> |
7370 |
|
<p>/ MIDI_INSTRUMENTS SP ALL |
7371 |
|
|
7372 |
</p> |
</p> |
7373 |
</blockquote><p> |
</blockquote><p> |
7382 |
<p>/ MIDI_INPUT_DEVICE SP number |
<p>/ MIDI_INPUT_DEVICE SP number |
7383 |
|
|
7384 |
</p> |
</p> |
7385 |
|
<p>/ FX_SEND SP sampler_channel SP fx_send_id |
7386 |
|
|
7387 |
|
</p> |
7388 |
</blockquote><p> |
</blockquote><p> |
7389 |
|
|
7390 |
</p> |
</p> |
7436 |
<p>/ SOLO SP sampler_channel SP boolean |
<p>/ SOLO SP sampler_channel SP boolean |
7437 |
|
|
7438 |
</p> |
</p> |
7439 |
|
<p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map |
7440 |
|
|
7441 |
|
</p> |
7442 |
|
<p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE |
7443 |
|
|
7444 |
|
</p> |
7445 |
|
<p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT |
7446 |
|
|
7447 |
|
</p> |
7448 |
</blockquote><p> |
</blockquote><p> |
7449 |
|
|
7450 |
</p> |
</p> |
7493 |
<p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
<p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
7494 |
|
|
7495 |
</p> |
</p> |
7496 |
<p>/ MIDI_INSTRUMENTS |
<p>/ MIDI_INSTRUMENTS SP midi_map |
7497 |
|
|
7498 |
|
</p> |
7499 |
|
<p>/ MIDI_INSTRUMENTS SP ALL |
7500 |
|
|
7501 |
|
</p> |
7502 |
|
<p>/ MIDI_INSTRUMENT_MAPS |
7503 |
|
|
7504 |
|
</p> |
7505 |
|
<p>/ FX_SENDS SP sampler_channel |
7506 |
|
|
7507 |
</p> |
</p> |
7508 |
</blockquote><p> |
</blockquote><p> |
7601 |
</blockquote><p> |
</blockquote><p> |
7602 |
|
|
7603 |
</p> |
</p> |
7604 |
<p>midi_bank_msb = |
<p>midi_map = |
7605 |
</p> |
</p> |
7606 |
<blockquote class="text"> |
<blockquote class="text"> |
7607 |
<p>number |
<p>number |
7610 |
</blockquote><p> |
</blockquote><p> |
7611 |
|
|
7612 |
</p> |
</p> |
7613 |
<p>midi_bank_lsb = |
<p>midi_bank = |
7614 |
</p> |
</p> |
7615 |
<blockquote class="text"> |
<blockquote class="text"> |
7616 |
<p>number |
<p>number |
7628 |
</blockquote><p> |
</blockquote><p> |
7629 |
|
|
7630 |
</p> |
</p> |
7631 |
|
<p>midi_ctrl = |
7632 |
|
</p> |
7633 |
|
<blockquote class="text"> |
7634 |
|
<p>number |
7635 |
|
|
7636 |
|
</p> |
7637 |
|
</blockquote><p> |
7638 |
|
|
7639 |
|
</p> |
7640 |
<p>volume_value = |
<p>volume_value = |
7641 |
</p> |
</p> |
7642 |
<blockquote class="text"> |
<blockquote class="text"> |
7667 |
</blockquote><p> |
</blockquote><p> |
7668 |
|
|
7669 |
</p> |
</p> |
7670 |
|
<p>fx_send_id = |
7671 |
|
</p> |
7672 |
|
<blockquote class="text"> |
7673 |
|
<p>number |
7674 |
|
|
7675 |
|
</p> |
7676 |
|
</blockquote><p> |
7677 |
|
|
7678 |
|
</p> |
7679 |
<p>engine_name = |
<p>engine_name = |
7680 |
</p> |
</p> |
7681 |
<blockquote class="text"> |
<blockquote class="text"> |
7694 |
</blockquote><p> |
</blockquote><p> |
7695 |
|
|
7696 |
</p> |
</p> |
7697 |
|
<p>map_name = |
7698 |
|
</p> |
7699 |
|
<blockquote class="text"> |
7700 |
|
<p>stringval |
7701 |
|
|
7702 |
|
</p> |
7703 |
|
</blockquote><p> |
7704 |
|
|
7705 |
|
</p> |
7706 |
<p>entry_name = |
<p>entry_name = |
7707 |
</p> |
</p> |
7708 |
<blockquote class="text"> |
<blockquote class="text"> |
7712 |
</blockquote><p> |
</blockquote><p> |
7713 |
|
|
7714 |
</p> |
</p> |
7715 |
|
<p>fx_send_name = |
7716 |
|
</p> |
7717 |
|
<blockquote class="text"> |
7718 |
|
<p>stringval |
7719 |
|
|
7720 |
|
</p> |
7721 |
|
</blockquote><p> |
7722 |
|
|
7723 |
|
</p> |
7724 |
<p>param_val_list = |
<p>param_val_list = |
7725 |
</p> |
</p> |
7726 |
<blockquote class="text"> |
<blockquote class="text"> |
7752 |
|
|
7753 |
</p> |
</p> |
7754 |
<a name="events"></a><br /><hr /> |
<a name="events"></a><br /><hr /> |
7755 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7756 |
<a name="rfc.section.8"></a><h3>8. Events</h3> |
<a name="rfc.section.8"></a><h3>8. |
7757 |
|
Events</h3> |
7758 |
|
|
7759 |
<p>This chapter will describe all currently defined events supported by LinuxSampler. |
<p>This chapter will describe all currently defined events supported by LinuxSampler. |
7760 |
</p> |
</p> |
7761 |
<a name="SUBSCRIBE CHANNEL"></a><br /><hr /> |
<a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"></a><br /><hr /> |
7762 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7763 |
<a name="rfc.section.8.1"></a><h3>8.1. Number of sampler channels changed</h3> |
<a name="rfc.section.8.1"></a><h3>8.1. |
7764 |
|
Number of audio output devices changed</h3> |
7765 |
|
|
7766 |
|
<p>Client may want to be notified when the total number of audio output devices on the |
7767 |
|
back-end changes by issuing the following command: |
7768 |
|
</p> |
7769 |
|
<p> |
7770 |
|
</p> |
7771 |
|
<blockquote class="text"> |
7772 |
|
<p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT |
7773 |
|
</p> |
7774 |
|
</blockquote><p> |
7775 |
|
|
7776 |
|
</p> |
7777 |
|
<p>Server will start sending the following notification messages: |
7778 |
|
</p> |
7779 |
|
<p> |
7780 |
|
</p> |
7781 |
|
<blockquote class="text"> |
7782 |
|
<p>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>" |
7783 |
|
</p> |
7784 |
|
</blockquote><p> |
7785 |
|
|
7786 |
|
</p> |
7787 |
|
<p>where <devices> will be replaced by the new number |
7788 |
|
of audio output devices. |
7789 |
|
</p> |
7790 |
|
<a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"></a><br /><hr /> |
7791 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7792 |
|
<a name="rfc.section.8.2"></a><h3>8.2. |
7793 |
|
Audio output device's settings changed</h3> |
7794 |
|
|
7795 |
|
<p>Client may want to be notified when changes were made to audio output devices on the |
7796 |
|
back-end by issuing the following command: |
7797 |
|
</p> |
7798 |
|
<p> |
7799 |
|
</p> |
7800 |
|
<blockquote class="text"> |
7801 |
|
<p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO |
7802 |
|
</p> |
7803 |
|
</blockquote><p> |
7804 |
|
|
7805 |
|
</p> |
7806 |
|
<p>Server will start sending the following notification messages: |
7807 |
|
</p> |
7808 |
|
<p> |
7809 |
|
</p> |
7810 |
|
<blockquote class="text"> |
7811 |
|
<p>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>" |
7812 |
|
</p> |
7813 |
|
</blockquote><p> |
7814 |
|
|
7815 |
|
</p> |
7816 |
|
<p>where <device-id> will be replaced by the numerical ID of the audio output device, |
7817 |
|
which settings has been changed. The front-end will have to send |
7818 |
|
the respective command to actually get the audio output device info. Because these messages |
7819 |
|
will be triggered by LSCP commands issued by other clients rather than real |
7820 |
|
time events happening on the server, it is believed that an empty notification |
7821 |
|
message is sufficient here. |
7822 |
|
</p> |
7823 |
|
<a name="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"></a><br /><hr /> |
7824 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7825 |
|
<a name="rfc.section.8.3"></a><h3>8.3. |
7826 |
|
Number of MIDI input devices changed</h3> |
7827 |
|
|
7828 |
|
<p>Client may want to be notified when the total number of MIDI input devices on the |
7829 |
|
back-end changes by issuing the following command: |
7830 |
|
</p> |
7831 |
|
<p> |
7832 |
|
</p> |
7833 |
|
<blockquote class="text"> |
7834 |
|
<p>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT |
7835 |
|
</p> |
7836 |
|
</blockquote><p> |
7837 |
|
|
7838 |
|
</p> |
7839 |
|
<p>Server will start sending the following notification messages: |
7840 |
|
</p> |
7841 |
|
<p> |
7842 |
|
</p> |
7843 |
|
<blockquote class="text"> |
7844 |
|
<p>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>" |
7845 |
|
</p> |
7846 |
|
</blockquote><p> |
7847 |
|
|
7848 |
|
</p> |
7849 |
|
<p>where <devices> will be replaced by the new number |
7850 |
|
of MIDI input devices. |
7851 |
|
</p> |
7852 |
|
<a name="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"></a><br /><hr /> |
7853 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7854 |
|
<a name="rfc.section.8.4"></a><h3>8.4. |
7855 |
|
MIDI input device's settings changed</h3> |
7856 |
|
|
7857 |
|
<p>Client may want to be notified when changes were made to MIDI input devices on the |
7858 |
|
back-end by issuing the following command: |
7859 |
|
</p> |
7860 |
|
<p> |
7861 |
|
</p> |
7862 |
|
<blockquote class="text"> |
7863 |
|
<p>SUBSCRIBE MIDI_INPUT_DEVICE_INFO |
7864 |
|
</p> |
7865 |
|
</blockquote><p> |
7866 |
|
|
7867 |
|
</p> |
7868 |
|
<p>Server will start sending the following notification messages: |
7869 |
|
</p> |
7870 |
|
<p> |
7871 |
|
</p> |
7872 |
|
<blockquote class="text"> |
7873 |
|
<p>"NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>" |
7874 |
|
</p> |
7875 |
|
</blockquote><p> |
7876 |
|
|
7877 |
|
</p> |
7878 |
|
<p>where <device-id> will be replaced by the numerical ID of the MIDI input device, |
7879 |
|
which settings has been changed. The front-end will have to send |
7880 |
|
the respective command to actually get the MIDI input device info. Because these messages |
7881 |
|
will be triggered by LSCP commands issued by other clients rather than real |
7882 |
|
time events happening on the server, it is believed that an empty notification |
7883 |
|
message is sufficient here. |
7884 |
|
</p> |
7885 |
|
<a name="SUBSCRIBE CHANNEL_COUNT"></a><br /><hr /> |
7886 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7887 |
|
<a name="rfc.section.8.5"></a><h3>8.5. |
7888 |
|
Number of sampler channels changed</h3> |
7889 |
|
|
7890 |
<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 |
7891 |
back-end changes by issuing the following command: |
back-end changes by issuing the following command: |
7912 |
of sampler channels. |
of sampler channels. |
7913 |
</p> |
</p> |
7914 |
<a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr /> |
7915 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7916 |
<a name="rfc.section.8.2"></a><h3>8.2. Number of active voices changed</h3> |
<a name="rfc.section.8.6"></a><h3>8.6. |
7917 |
|
Number of active voices changed</h3> |
7918 |
|
|
7919 |
<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 |
7920 |
back-end changes by issuing the following command: |
back-end changes by issuing the following command: |
7942 |
active voices on that channel. |
active voices on that channel. |
7943 |
</p> |
</p> |
7944 |
<a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr /> |
7945 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7946 |
<a name="rfc.section.8.3"></a><h3>8.3. Number of active disk streams changed</h3> |
<a name="rfc.section.8.7"></a><h3>8.7. |
7947 |
|
Number of active disk streams changed</h3> |
7948 |
|
|
7949 |
<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 |
7950 |
changes by issuing the following command: SUBSCRIBE STREAM_COUNT |
changes by issuing the following command: SUBSCRIBE STREAM_COUNT |
7972 |
active disk streams on that channel. |
active disk streams on that channel. |
7973 |
</p> |
</p> |
7974 |
<a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr /> |
<a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr /> |
7975 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7976 |
<a name="rfc.section.8.4"></a><h3>8.4. Disk stream buffer fill state changed</h3> |
<a name="rfc.section.8.8"></a><h3>8.8. |
7977 |
|
Disk stream buffer fill state changed</h3> |
7978 |
|
|
7979 |
<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 |
7980 |
on the back-end changes by issuing the following command: |
on the back-end changes by issuing the following command: |
7999 |
</p> |
</p> |
8000 |
<p>where <sampler-channel> will be replaced by the sampler channel the |
<p>where <sampler-channel> will be replaced by the sampler channel the |
8001 |
buffer fill state change occurred on and <fill-data> will be replaced by the |
buffer fill state change occurred on and <fill-data> will be replaced by the |
8002 |
buffer fill data for this channel as described in <a class="info" href="#GET CHANNEL BUFFER_FILL">Section 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 6.4.13<span> (</span><span class='info'>Current fill state of disk stream buffers</span><span>)</span></a> |
8003 |
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. |
8004 |
</p> |
</p> |
8005 |
<a name="SUBSCRIBE INFO"></a><br /><hr /> |
<a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr /> |
8006 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8007 |
<a name="rfc.section.8.5"></a><h3>8.5. Channel information changed</h3> |
<a name="rfc.section.8.9"></a><h3>8.9. |
8008 |
|
Channel information changed</h3> |
8009 |
|
|
8010 |
<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 |
8011 |
back-end by issuing the following command: |
back-end by issuing the following command: |
8036 |
message is sufficient here. |
message is sufficient here. |
8037 |
</p> |
</p> |
8038 |
<a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr /> |
8039 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8040 |
<a name="rfc.section.8.6"></a><h3>8.6. Total number of active voices changed</h3> |
<a name="rfc.section.8.10"></a><h3>8.10. |
8041 |
|
Total number of active voices changed</h3> |
8042 |
|
|
8043 |
<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 |
8044 |
back-end changes by issuing the following command: |
back-end changes by issuing the following command: |
8064 |
<p>where <voices> will be replaced by the new number of |
<p>where <voices> will be replaced by the new number of |
8065 |
all currently active voices. |
all currently active voices. |
8066 |
</p> |
</p> |
8067 |
|
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr /> |
8068 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8069 |
|
<a name="rfc.section.8.11"></a><h3>8.11. |
8070 |
|
Number of MIDI instrument maps changed</h3> |
8071 |
|
|
8072 |
|
<p>Client may want to be notified when the number of MIDI instrument maps on the |
8073 |
|
back-end changes by issuing the following command: |
8074 |
|
</p> |
8075 |
|
<p> |
8076 |
|
</p> |
8077 |
|
<blockquote class="text"> |
8078 |
|
<p>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT |
8079 |
|
</p> |
8080 |
|
</blockquote><p> |
8081 |
|
|
8082 |
|
</p> |
8083 |
|
<p>Server will start sending the following notification messages: |
8084 |
|
</p> |
8085 |
|
<p> |
8086 |
|
</p> |
8087 |
|
<blockquote class="text"> |
8088 |
|
<p>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>" |
8089 |
|
</p> |
8090 |
|
</blockquote><p> |
8091 |
|
|
8092 |
|
</p> |
8093 |
|
<p>where <maps> will be replaced by the new number |
8094 |
|
of MIDI instrument maps. |
8095 |
|
</p> |
8096 |
|
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr /> |
8097 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8098 |
|
<a name="rfc.section.8.12"></a><h3>8.12. |
8099 |
|
MIDI instrument map information changed</h3> |
8100 |
|
|
8101 |
|
<p>Client may want to be notified when changes were made to MIDI instrument maps on the |
8102 |
|
back-end by issuing the following command: |
8103 |
|
</p> |
8104 |
|
<p> |
8105 |
|
</p> |
8106 |
|
<blockquote class="text"> |
8107 |
|
<p>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO |
8108 |
|
</p> |
8109 |
|
</blockquote><p> |
8110 |
|
|
8111 |
|
</p> |
8112 |
|
<p>Server will start sending the following notification messages: |
8113 |
|
</p> |
8114 |
|
<p> |
8115 |
|
</p> |
8116 |
|
<blockquote class="text"> |
8117 |
|
<p>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>" |
8118 |
|
</p> |
8119 |
|
</blockquote><p> |
8120 |
|
|
8121 |
|
</p> |
8122 |
|
<p>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
8123 |
|
for which information changes occurred. The front-end will have to send |
8124 |
|
the respective command to actually get the MIDI instrument map info. Because these messages |
8125 |
|
will be triggered by LSCP commands issued by other clients rather than real |
8126 |
|
time events happening on the server, it is believed that an empty notification |
8127 |
|
message is sufficient here. |
8128 |
|
</p> |
8129 |
|
<a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr /> |
8130 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8131 |
|
<a name="rfc.section.8.13"></a><h3>8.13. |
8132 |
|
Number of MIDI instruments changed</h3> |
8133 |
|
|
8134 |
|
<p>Client may want to be notified when the number of MIDI instrument maps on the |
8135 |
|
back-end changes by issuing the following command: |
8136 |
|
</p> |
8137 |
|
<p> |
8138 |
|
</p> |
8139 |
|
<blockquote class="text"> |
8140 |
|
<p>SUBSCRIBE MIDI_INSTRUMENT_COUNT |
8141 |
|
</p> |
8142 |
|
</blockquote><p> |
8143 |
|
|
8144 |
|
</p> |
8145 |
|
<p>Server will start sending the following notification messages: |
8146 |
|
</p> |
8147 |
|
<p> |
8148 |
|
</p> |
8149 |
|
<blockquote class="text"> |
8150 |
|
<p>"NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>" |
8151 |
|
</p> |
8152 |
|
</blockquote><p> |
8153 |
|
|
8154 |
|
</p> |
8155 |
|
<p>where <map-id> is the numerical ID of the MIDI instrument map, in which |
8156 |
|
the nuber of instruments has changed and <instruments> will be replaced by |
8157 |
|
the new number of MIDI instruments in the specified map. |
8158 |
|
</p> |
8159 |
|
<a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr /> |
8160 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8161 |
|
<a name="rfc.section.8.14"></a><h3>8.14. |
8162 |
|
MIDI instrument information changed</h3> |
8163 |
|
|
8164 |
|
<p>Client may want to be notified when changes were made to MIDI instruments on the |
8165 |
|
back-end by issuing the following command: |
8166 |
|
</p> |
8167 |
|
<p> |
8168 |
|
</p> |
8169 |
|
<blockquote class="text"> |
8170 |
|
<p>SUBSCRIBE MIDI_INSTRUMENT_INFO |
8171 |
|
</p> |
8172 |
|
</blockquote><p> |
8173 |
|
|
8174 |
|
</p> |
8175 |
|
<p>Server will start sending the following notification messages: |
8176 |
|
</p> |
8177 |
|
<p> |
8178 |
|
</p> |
8179 |
|
<blockquote class="text"> |
8180 |
|
<p>"NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>" |
8181 |
|
</p> |
8182 |
|
</blockquote><p> |
8183 |
|
|
8184 |
|
</p> |
8185 |
|
<p>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
8186 |
|
in which a MIDI instrument is changed. <bank> and <program> specifies |
8187 |
|
the location of the changed MIDI instrument in the map. The front-end will have to send |
8188 |
|
the respective command to actually get the MIDI instrument info. Because these messages |
8189 |
|
will be triggered by LSCP commands issued by other clients rather than real |
8190 |
|
time events happening on the server, it is believed that an empty notification |
8191 |
|
message is sufficient here. |
8192 |
|
</p> |
8193 |
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr /> |
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr /> |
8194 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8195 |
<a name="rfc.section.8.7"></a><h3>8.7. Miscellaneous and debugging events</h3> |
<a name="rfc.section.8.15"></a><h3>8.15. |
8196 |
|
Miscellaneous and debugging events</h3> |
8197 |
|
|
8198 |
<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 |
8199 |
the server by issuing the following command: |
the server by issuing the following command: |
8220 |
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 |
8221 |
user AS IS to facilitate debugging. |
user AS IS to facilitate debugging. |
8222 |
</p> |
</p> |
8223 |
<a name="anchor15"></a><br /><hr /> |
<a name="anchor14"></a><br /><hr /> |
8224 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8225 |
<a name="rfc.section.9"></a><h3>9. Security Considerations</h3> |
<a name="rfc.section.9"></a><h3>9. |
8226 |
|
Security Considerations</h3> |
8227 |
|
|
8228 |
<p>As there is so far no method of authentication and authorization |
<p>As there is so far no method of authentication and authorization |
8229 |
defined and so not required for a client applications to succeed to |
defined and so not required for a client applications to succeed to |
8230 |
connect, running LinuxSampler might be a security risk for the host |
connect, running LinuxSampler might be a security risk for the host |
8231 |
system the LinuxSampler instance is running on. |
system the LinuxSampler instance is running on. |
8232 |
</p> |
</p> |
8233 |
<a name="anchor16"></a><br /><hr /> |
<a name="anchor15"></a><br /><hr /> |
8234 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8235 |
<a name="rfc.section.10"></a><h3>10. Acknowledgments</h3> |
<a name="rfc.section.10"></a><h3>10. |
8236 |
|
Acknowledgments</h3> |
8237 |
|
|
8238 |
<p>This document has benefited greatly from the comments of the |
<p>This document has benefited greatly from the comments of the |
8239 |
following people, discussed on the LinuxSampler developer's mailing |
following people, discussed on the LinuxSampler developer's mailing |
8254 |
|
|
8255 |
</p> |
</p> |
8256 |
<a name="rfc.references1"></a><br /><hr /> |
<a name="rfc.references1"></a><br /><hr /> |
8257 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8258 |
<h3>11. References</h3> |
<h3>11. References</h3> |
8259 |
<table width="99%" border="0"> |
<table width="99%" border="0"> |
8260 |
<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> |
8266 |
</table> |
</table> |
8267 |
|
|
8268 |
<a name="rfc.authors"></a><br /><hr /> |
<a name="rfc.authors"></a><br /><hr /> |
8269 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8270 |
<h3>Author's Address</h3> |
<h3>Author's Address</h3> |
8271 |
<table width="99%" border="0" cellpadding="0" cellspacing="0"> |
<table width="99%" border="0" cellpadding="0" cellspacing="0"> |
8272 |
<tr><td class="author-text"> </td> |
<tr><td class="author-text"> </td> |
8284 |
<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> |
8285 |
</table> |
</table> |
8286 |
<a name="rfc.copyright"></a><br /><hr /> |
<a name="rfc.copyright"></a><br /><hr /> |
8287 |
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8288 |
<h3>Intellectual Property Statement</h3> |
<h3>Full Copyright Statement</h3> |
8289 |
<p class='copyright'> |
<p class='copyright'> |
8290 |
The IETF takes no position regarding the validity or scope of |
Copyright © The Internet Society (2006).</p> |
|
any intellectual property or other rights that might be claimed |
|
|
to pertain to the implementation or use of the technology |
|
|
described in this document or the extent to which any license |
|
|
under such rights might or might not be available; neither does |
|
|
it represent that it has made any effort to identify any such |
|
|
rights. Information on the IETF's procedures with respect to |
|
|
rights in standards-track and standards-related documentation |
|
|
can be found in BCP 11. Copies of claims of rights made |
|
|
available for publication and any assurances of licenses to |
|
|
be made available, or the result of an attempt made |
|
|
to obtain a general license or permission for the use of such |
|
|
proprietary rights by implementors or users of this |
|
|
specification can be obtained from the IETF Secretariat.</p> |
|
8291 |
<p class='copyright'> |
<p class='copyright'> |
8292 |
The IETF invites any interested party to bring to its |
This document is subject to the rights, |
8293 |
attention any copyrights, patents or patent applications, or |
licenses and restrictions contained in BCP 78, |
8294 |
other proprietary rights which may cover technology that may be |
and except as set forth therein, |
8295 |
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> |
|
8296 |
<p class='copyright'> |
<p class='copyright'> |
8297 |
Copyright © The Internet Society (2006). All Rights Reserved.</p> |
This document and the information contained herein are provided |
8298 |
|
on an “AS IS” basis and THE CONTRIBUTOR, |
8299 |
|
THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), |
8300 |
|
THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM |
8301 |
|
ALL WARRANTIES, |
8302 |
|
EXPRESS OR IMPLIED, |
8303 |
|
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE |
8304 |
|
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED |
8305 |
|
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.</p> |
8306 |
|
<h3>Intellectual Property</h3> |
8307 |
<p class='copyright'> |
<p class='copyright'> |
8308 |
This document and translations of it may be copied and furnished to |
The IETF takes no position regarding the validity or scope of any |
8309 |
others, and derivative works that comment on or otherwise explain it |
Intellectual Property Rights or other rights that might be claimed |
8310 |
or assist in its implementation may be prepared, copied, published and |
to pertain to the implementation or use of the technology |
8311 |
distributed, in whole or in part, without restriction of any kind, |
described in this document or the extent to which any license |
8312 |
provided that the above copyright notice and this paragraph are |
under such rights might or might not be available; nor does it |
8313 |
included on all such copies and derivative works. However, this |
represent that it has made any independent effort to identify any |
8314 |
document itself may not be modified in any way, such as by removing |
such rights. |
8315 |
the copyright notice or references to the Internet Society or other |
Information on the procedures with respect to |
8316 |
Internet organizations, except as needed for the purpose of |
rights in RFC documents can be found in BCP 78 and BCP 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> |
|
8317 |
<p class='copyright'> |
<p class='copyright'> |
8318 |
The limited permissions granted above are perpetual and will not be |
Copies of IPR disclosures made to the IETF Secretariat and any |
8319 |
revoked by the Internet Society or its successors or assignees.</p> |
assurances of licenses to be made available, |
8320 |
|
or the result of an attempt made to obtain a general license or |
8321 |
|
permission for the use of such proprietary rights by implementers or |
8322 |
|
users of this specification can be obtained from the IETF on-line IPR |
8323 |
|
repository at <a href='http://www.ietf.org/ipr'>http://www.ietf.org/ipr</a>.</p> |
8324 |
<p class='copyright'> |
<p class='copyright'> |
8325 |
This document and the information contained herein is provided on an |
The IETF invites any interested party to bring to its attention |
8326 |
“AS IS” basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING |
any copyrights, |
8327 |
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING |
patents or patent applications, |
8328 |
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION |
or other |
8329 |
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF |
proprietary rights that may cover technology that may be required |
8330 |
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.</p> |
to implement this standard. |
8331 |
|
Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p> |
8332 |
<h3>Acknowledgment</h3> |
<h3>Acknowledgment</h3> |
8333 |
<p class='copyright'> |
<p class='copyright'> |
8334 |
Funding for the RFC Editor function is currently provided by the |
Funding for the RFC Editor function is provided by |
8335 |
Internet Society.</p> |
the IETF Administrative Support Activity (IASA).</p> |
8336 |
</body></html> |
</body></html> |