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.31 (http://xml.resource.org/)"> |
<meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)"> |
7 |
<style type='text/css'><!-- |
<style type='text/css'><!-- |
8 |
body { |
body { |
9 |
font-family: verdana, charcoal, helvetica, arial, sans-serif; |
font-family: verdana, charcoal, helvetica, arial, sans-serif; |
10 |
font-size: small; color: #000; background-color: #FFF; |
font-size: small; color: #000; background-color: #FFF; |
11 |
margin: 2em; |
margin: 2em; |
12 |
} |
} |
13 |
h1, h2, h3, h4, h5, h6 { |
h1, h2, h3, h4, h5, h6 { |
14 |
font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif; |
font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif; |
15 |
font-weight: bold; font-style: normal; |
font-weight: bold; font-style: normal; |
16 |
} |
} |
17 |
h1 { color: #900; background-color: transparent; text-align: right; } |
h1 { color: #900; background-color: transparent; text-align: right; } |
18 |
h3 { color: #333; background-color: transparent; } |
h3 { color: #333; background-color: transparent; } |
19 |
|
|
20 |
td.RFCbug { |
td.RFCbug { |
21 |
font-size: x-small; text-decoration: none; |
font-size: x-small; text-decoration: none; |
22 |
width: 30px; height: 30px; padding-top: 2px; |
width: 30px; height: 30px; padding-top: 2px; |
23 |
text-align: justify; vertical-align: middle; |
text-align: justify; vertical-align: middle; |
24 |
background-color: #000; |
background-color: #000; |
25 |
} |
} |
26 |
td.RFCbug span.RFC { |
td.RFCbug span.RFC { |
27 |
font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif; |
font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif; |
28 |
font-weight: bold; color: #666; |
font-weight: bold; color: #666; |
29 |
} |
} |
30 |
td.RFCbug span.hotText { |
td.RFCbug span.hotText { |
31 |
font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif; |
font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif; |
32 |
font-weight: normal; text-align: center; color: #FFF; |
font-weight: normal; text-align: center; color: #FFF; |
33 |
} |
} |
34 |
|
|
35 |
table.TOCbug { width: 30px; height: 15px; } |
table.TOCbug { width: 30px; height: 15px; } |
36 |
td.TOCbug { |
td.TOCbug { |
37 |
text-align: center; width: 30px; height: 15px; |
text-align: center; width: 30px; height: 15px; |
38 |
color: #FFF; background-color: #900; |
color: #FFF; background-color: #900; |
39 |
} |
} |
40 |
td.TOCbug a { |
td.TOCbug a { |
41 |
font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif; |
font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif; |
42 |
font-weight: bold; font-size: x-small; text-decoration: none; |
font-weight: bold; font-size: x-small; text-decoration: none; |
43 |
color: #FFF; background-color: transparent; |
color: #FFF; background-color: transparent; |
44 |
} |
} |
45 |
|
|
46 |
td.header { |
td.header { |
47 |
font-family: arial, helvetica, sans-serif; font-size: x-small; |
font-family: arial, helvetica, sans-serif; font-size: x-small; |
48 |
vertical-align: top; width: 33%; |
vertical-align: top; width: 33%; |
49 |
color: #FFF; background-color: #666; |
color: #FFF; background-color: #666; |
50 |
} |
} |
51 |
td.author { font-weight: bold; font-size: x-small; margin-left: 4em; } |
td.author { font-weight: bold; font-size: x-small; margin-left: 4em; } |
52 |
td.author-text { font-size: x-small; } |
td.author-text { font-size: x-small; } |
53 |
|
|
54 |
/* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */ |
/* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */ |
55 |
a.info { |
a.info { |
56 |
/* This is the key. */ |
/* This is the key. */ |
57 |
position: relative; |
position: relative; |
58 |
z-index: 24; |
z-index: 24; |
59 |
text-decoration: none; |
text-decoration: none; |
60 |
} |
} |
61 |
a.info:hover { |
a.info:hover { |
62 |
z-index: 25; |
z-index: 25; |
63 |
color: #FFF; background-color: #900; |
color: #FFF; background-color: #900; |
64 |
} |
} |
65 |
a.info span { display: none; } |
a.info span { display: none; } |
66 |
a.info:hover span.info { |
a.info:hover span.info { |
67 |
/* The span will display just on :hover state. */ |
/* The span will display just on :hover state. */ |
68 |
display: block; |
display: block; |
69 |
position: absolute; |
position: absolute; |
70 |
font-size: smaller; |
font-size: smaller; |
71 |
top: 2em; left: -5em; width: 15em; |
top: 2em; left: -5em; width: 15em; |
72 |
padding: 2px; border: 1px solid #333; |
padding: 2px; border: 1px solid #333; |
73 |
color: #900; background-color: #EEE; |
color: #900; background-color: #EEE; |
74 |
text-align: left; |
text-align: left; |
75 |
} |
} |
76 |
|
|
77 |
a { font-weight: bold; } |
a { font-weight: bold; } |
78 |
a:link { color: #900; background-color: transparent; } |
a:link { color: #900; background-color: transparent; } |
79 |
a:visited { color: #633; background-color: transparent; } |
a:visited { color: #633; background-color: transparent; } |
80 |
a:active { color: #633; background-color: transparent; } |
a:active { color: #633; background-color: transparent; } |
81 |
|
|
82 |
p { margin-left: 2em; margin-right: 2em; } |
p { margin-left: 2em; margin-right: 2em; } |
83 |
p.copyright { font-size: x-small; } |
p.copyright { font-size: x-small; } |
84 |
p.toc { font-size: small; font-weight: bold; margin-left: 3em; } |
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; } |
table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; } |
86 |
td.toc { font-size: small; font-weight: bold; vertical-align: text-top; } |
td.toc { font-size: small; font-weight: bold; vertical-align: text-top; } |
87 |
|
|
88 |
ol.text { margin-left: 2em; margin-right: 2em; } |
ol.text { margin-left: 2em; margin-right: 2em; } |
89 |
ul.text { margin-left: 2em; margin-right: 2em; } |
ul.text { margin-left: 2em; margin-right: 2em; } |
90 |
li { margin-left: 3em; } |
li { margin-left: 3em; } |
91 |
|
|
92 |
/* RFC-2629 <spanx>s and <artwork>s. */ |
/* RFC-2629 <spanx>s and <artwork>s. */ |
93 |
em { font-style: italic; } |
em { font-style: italic; } |
94 |
strong { font-weight: bold; } |
strong { font-weight: bold; } |
95 |
dfn { font-weight: bold; font-style: normal; } |
dfn { font-weight: bold; font-style: normal; } |
96 |
cite { font-weight: normal; font-style: normal; } |
cite { font-weight: normal; font-style: normal; } |
97 |
tt { color: #036; } |
tt { color: #036; } |
98 |
tt, pre, pre dfn, pre em, pre cite, pre span { |
tt, pre, pre dfn, pre em, pre cite, pre span { |
99 |
font-family: "Courier New", Courier, monospace; font-size: small; |
font-family: "Courier New", Courier, monospace; font-size: small; |
100 |
} |
} |
101 |
pre { |
pre { |
102 |
text-align: left; padding: 4px; |
text-align: left; padding: 4px; |
103 |
color: #000; background-color: #CCC; |
color: #000; background-color: #CCC; |
104 |
} |
} |
105 |
pre dfn { color: #900; } |
pre dfn { color: #900; } |
106 |
pre em { color: #66F; background-color: #FFC; font-weight: normal; } |
pre em { color: #66F; background-color: #FFC; font-weight: normal; } |
107 |
pre .key { color: #33C; font-weight: bold; } |
pre .key { color: #33C; font-weight: bold; } |
108 |
pre .id { color: #900; } |
pre .id { color: #900; } |
109 |
pre .str { color: #000; background-color: #CFF; } |
pre .str { color: #000; background-color: #CFF; } |
110 |
pre .val { color: #066; } |
pre .val { color: #066; } |
111 |
pre .rep { color: #909; } |
pre .rep { color: #909; } |
112 |
pre .oth { color: #000; background-color: #FCF; } |
pre .oth { color: #000; background-color: #FCF; } |
113 |
pre .err { background-color: #FCC; } |
pre .err { background-color: #FCC; } |
114 |
|
|
115 |
/* RFC-2629 <texttable>s. */ |
/* RFC-2629 <texttable>s. */ |
116 |
table.full, table.headers, table.none { |
table.all, table.full, table.headers, table.none { |
117 |
font-size: small; text-align: center; border-width: 2px; |
font-size: small; text-align: center; border-width: 2px; |
118 |
vertical-align: top; border-collapse: collapse; |
vertical-align: top; border-collapse: collapse; |
119 |
} |
} |
120 |
table.full { border-style: solid; border-color: black; } |
table.all, table.full { border-style: solid; border-color: black; } |
121 |
table.headers, table.none { border-style: none; } |
table.headers, table.none { border-style: none; } |
122 |
th { |
th { |
123 |
font-weight: bold; border-color: black; |
font-weight: bold; border-color: black; |
124 |
border-width: 2px 2px 3px 2px; |
border-width: 2px 2px 3px 2px; |
125 |
} |
} |
126 |
table.full th { border-style: solid; } |
table.all th, table.full th { border-style: solid; } |
127 |
table.headers th { border-style: none none solid none; } |
table.headers th { border-style: none none solid none; } |
128 |
table.none th { border-style: none; } |
table.none th { border-style: none; } |
129 |
table.full td { |
table.all td { |
130 |
border-style: solid; border-color: #333; |
border-style: solid; border-color: #333; |
131 |
border-width: 1px 2px; |
border-width: 1px 2px; |
132 |
} |
} |
133 |
table.headers td, table.none td { border-style: none; } |
table.full td, table.headers td, table.none td { border-style: none; } |
134 |
|
|
135 |
hr { height: 1px; } |
hr { height: 1px; } |
136 |
hr.insert { |
hr.insert { |
137 |
width: 80%; border-style: none; border-width: 0; |
width: 80%; border-style: none; border-width: 0; |
138 |
color: #CCC; background-color: #CCC; |
color: #CCC; background-color: #CCC; |
139 |
} |
} |
140 |
--></style> |
--></style> |
141 |
</head> |
</head> |
142 |
<body> |
<body> |
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">Intended status: Standards Track</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">Expires: June 18, 2007</td><td class="header">December 15, 2006</td></tr> |
<tr><td class="header">Expires: April 17, 2008</td><td class="header">October 15, 2007</td></tr> |
149 |
</table></td></tr></table> |
</table></td></tr></table> |
150 |
<h1><br />LinuxSampler Control Protocol<br />LSCP 1.2</h1> |
<h1><br />LinuxSampler Control Protocol<br />LSCP 1.2</h1> |
151 |
|
|
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 June 18, 2007.</p> |
This Internet-Draft will expire on April 17, 2008.</p> |
177 |
|
|
178 |
<h3>Copyright Notice</h3> |
<h3>Copyright Notice</h3> |
179 |
<p> |
<p> |
180 |
Copyright © The Internet Society (2006).</p> |
Copyright © The IETF Trust (2007).</p> |
181 |
|
|
182 |
<h3>Abstract</h3> |
<h3>Abstract</h3> |
183 |
|
|
318 |
Soloing a sampler channel<br /> |
Soloing a sampler channel<br /> |
319 |
<a href="#SET CHANNEL MIDI_INSTRUMENT_MAP">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 /> |
Assigning a MIDI instrument map to a sampler channel<br /> |
321 |
<a href="#RESET CHANNEL">6.4.25.</a> |
<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 NAME">6.4.30.</a> |
332 |
|
Changing effect send's name<br /> |
333 |
|
<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a> |
334 |
|
Altering effect send's audio routing<br /> |
335 |
|
<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.32.</a> |
336 |
|
Altering effect send's MIDI controller<br /> |
337 |
|
<a href="#SET FX_SEND LEVEL">6.4.33.</a> |
338 |
|
Altering effect send's send level<br /> |
339 |
|
<a href="#RESET CHANNEL">6.4.34.</a> |
340 |
Resetting a sampler channel<br /> |
Resetting a sampler channel<br /> |
341 |
<a href="#anchor12">6.5.</a> |
<a href="#anchor12">6.5.</a> |
342 |
Controlling connection<br /> |
Controlling connection<br /> |
358 |
Reset sampler<br /> |
Reset sampler<br /> |
359 |
<a href="#GET SERVER INFO">6.6.4.</a> |
<a href="#GET SERVER INFO">6.6.4.</a> |
360 |
General sampler informations<br /> |
General sampler informations<br /> |
361 |
|
<a href="#GET VOLUME">6.6.5.</a> |
362 |
|
Getting global volume attenuation<br /> |
363 |
|
<a href="#SET VOLUME">6.6.6.</a> |
364 |
|
Setting global volume attenuation<br /> |
365 |
<a href="#MIDI Instrument Mapping">6.7.</a> |
<a href="#MIDI Instrument Mapping">6.7.</a> |
366 |
MIDI Instrument Mapping<br /> |
MIDI Instrument Mapping<br /> |
367 |
<a href="#ADD MIDI_INSTRUMENT MAP">6.7.1.</a> |
<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a> |
368 |
Create a new MIDI instrument map<br /> |
Create a new MIDI instrument map<br /> |
369 |
<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a> |
<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a> |
370 |
Delete one particular or all MIDI instrument maps<br /> |
Delete one particular or all MIDI instrument maps<br /> |
388 |
Get current settings of MIDI instrument map entry<br /> |
Get current settings of MIDI instrument map entry<br /> |
389 |
<a href="#CLEAR MIDI_INSTRUMENTS">6.7.12.</a> |
<a href="#CLEAR MIDI_INSTRUMENTS">6.7.12.</a> |
390 |
Clear MIDI instrument map<br /> |
Clear MIDI instrument map<br /> |
391 |
|
<a href="#Managing Instruments Database">6.8.</a> |
392 |
|
Managing Instruments Database<br /> |
393 |
|
<a href="#ADD DB_INSTRUMENT_DIRECTORY">6.8.1.</a> |
394 |
|
Creating a new instrument directory<br /> |
395 |
|
<a href="#REMOVE DB_INSTRUMENT_DIRECTORY">6.8.2.</a> |
396 |
|
Deleting an instrument directory<br /> |
397 |
|
<a href="#GET DB_INSTRUMENT_DIRECTORIES">6.8.3.</a> |
398 |
|
Getting amount of instrument directories<br /> |
399 |
|
<a href="#LIST DB_INSTRUMENT_DIRECTORIES">6.8.4.</a> |
400 |
|
Listing all directories in specific directory<br /> |
401 |
|
<a href="#GET DB_INSTRUMENT_DIRECTORY INFO">6.8.5.</a> |
402 |
|
Getting instrument directory information<br /> |
403 |
|
<a href="#SET DB_INSTRUMENT_DIRECTORY NAME">6.8.6.</a> |
404 |
|
Renaming an instrument directory<br /> |
405 |
|
<a href="#MOVE DB_INSTRUMENT_DIRECTORY">6.8.7.</a> |
406 |
|
Moving an instrument directory<br /> |
407 |
|
<a href="#COPY DB_INSTRUMENT_DIRECTORY">6.8.8.</a> |
408 |
|
Copying instrument directories<br /> |
409 |
|
<a href="#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">6.8.9.</a> |
410 |
|
Changing the description of directory<br /> |
411 |
|
<a href="#FIND DB_INSTRUMENT_DIRECTORIES">6.8.10.</a> |
412 |
|
Finding directories<br /> |
413 |
|
<a href="#ADD DB_INSTRUMENTS">6.8.11.</a> |
414 |
|
Adding instruments to the instruments database<br /> |
415 |
|
<a href="#REMOVE DB_INSTRUMENT">6.8.12.</a> |
416 |
|
Removing an instrument<br /> |
417 |
|
<a href="#GET DB_INSTRUMENTS">6.8.13.</a> |
418 |
|
Getting amount of instruments<br /> |
419 |
|
<a href="#LIST DB_INSTRUMENTS">6.8.14.</a> |
420 |
|
Listing all instruments in specific directory<br /> |
421 |
|
<a href="#GET DB_INSTRUMENT INFO">6.8.15.</a> |
422 |
|
Getting instrument information<br /> |
423 |
|
<a href="#SET DB_INSTRUMENT NAME">6.8.16.</a> |
424 |
|
Renaming an instrument<br /> |
425 |
|
<a href="#MOVE DB_INSTRUMENT">6.8.17.</a> |
426 |
|
Moving an instrument<br /> |
427 |
|
<a href="#COPY DB_INSTRUMENT">6.8.18.</a> |
428 |
|
Copying instruments<br /> |
429 |
|
<a href="#SET DB_INSTRUMENT DESCRIPTION">6.8.19.</a> |
430 |
|
Changing the description of instrument<br /> |
431 |
|
<a href="#FIND DB_INSTRUMENTS">6.8.20.</a> |
432 |
|
Finding instruments<br /> |
433 |
|
<a href="#GET DB_INSTRUMENTS_JOB INFO">6.8.21.</a> |
434 |
|
Getting job status information<br /> |
435 |
|
<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a> |
436 |
|
Formatting the instruments database<br /> |
437 |
|
<a href="#editing_instruments">6.9.</a> |
438 |
|
Editing Instruments<br /> |
439 |
|
<a href="#EDIT INSTRUMENT">6.9.1.</a> |
440 |
|
Opening an appropriate instrument editor application<br /> |
441 |
<a href="#command_syntax">7.</a> |
<a href="#command_syntax">7.</a> |
442 |
Command Syntax<br /> |
Command Syntax<br /> |
443 |
|
<a href="#character_set">7.1.</a> |
444 |
|
Character Set and Escape Sequences<br /> |
445 |
<a href="#events">8.</a> |
<a href="#events">8.</a> |
446 |
Events<br /> |
Events<br /> |
447 |
<a href="#SUBSCRIBE CHANNEL">8.1.</a> |
<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a> |
448 |
|
Number of audio output devices changed<br /> |
449 |
|
<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">8.2.</a> |
450 |
|
Audio output device's settings changed<br /> |
451 |
|
<a href="#SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">8.3.</a> |
452 |
|
Number of MIDI input devices changed<br /> |
453 |
|
<a href="#SUBSCRIBE MIDI_INPUT_DEVICE_INFO">8.4.</a> |
454 |
|
MIDI input device's settings changed<br /> |
455 |
|
<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a> |
456 |
Number of sampler channels changed<br /> |
Number of sampler channels changed<br /> |
457 |
<a href="#SUBSCRIBE VOICE_COUNT">8.2.</a> |
<a href="#SUBSCRIBE VOICE_COUNT">8.6.</a> |
458 |
Number of active voices changed<br /> |
Number of active voices changed<br /> |
459 |
<a href="#SUBSCRIBE STREAM_COUNT">8.3.</a> |
<a href="#SUBSCRIBE STREAM_COUNT">8.7.</a> |
460 |
Number of active disk streams changed<br /> |
Number of active disk streams changed<br /> |
461 |
<a href="#SUBSCRIBE BUFFER_FILL">8.4.</a> |
<a href="#SUBSCRIBE BUFFER_FILL">8.8.</a> |
462 |
Disk stream buffer fill state changed<br /> |
Disk stream buffer fill state changed<br /> |
463 |
<a href="#SUBSCRIBE INFO">8.5.</a> |
<a href="#SUBSCRIBE CHANNEL_INFO">8.9.</a> |
464 |
Channel information changed<br /> |
Channel information changed<br /> |
465 |
<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.6.</a> |
<a href="#SUBSCRIBE FX_SEND_COUNT">8.10.</a> |
466 |
|
Number of effect sends changed<br /> |
467 |
|
<a href="#SUBSCRIBE FX_SEND_INFO">8.11.</a> |
468 |
|
Effect send information changed<br /> |
469 |
|
<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a> |
470 |
Total number of active voices changed<br /> |
Total number of active voices changed<br /> |
471 |
<a href="#SUBSCRIBE MISCELLANEOUS">8.7.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.13.</a> |
472 |
|
Number of MIDI instrument maps changed<br /> |
473 |
|
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.14.</a> |
474 |
|
MIDI instrument map information changed<br /> |
475 |
|
<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.15.</a> |
476 |
|
Number of MIDI instruments changed<br /> |
477 |
|
<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.16.</a> |
478 |
|
MIDI instrument information changed<br /> |
479 |
|
<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a> |
480 |
|
Global settings changed<br /> |
481 |
|
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.18.</a> |
482 |
|
Number of database instrument directories changed<br /> |
483 |
|
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.19.</a> |
484 |
|
Database instrument directory information changed<br /> |
485 |
|
<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.20.</a> |
486 |
|
Number of database instruments changed<br /> |
487 |
|
<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.21.</a> |
488 |
|
Database instrument information changed<br /> |
489 |
|
<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.22.</a> |
490 |
|
Database job status information changed<br /> |
491 |
|
<a href="#SUBSCRIBE MISCELLANEOUS">8.23.</a> |
492 |
Miscellaneous and debugging events<br /> |
Miscellaneous and debugging events<br /> |
493 |
<a href="#anchor14">9.</a> |
<a href="#anchor14">9.</a> |
494 |
Security Considerations<br /> |
Security Considerations<br /> |
520 |
(front-end) and server (LinuxSampler) respectively. Lines in |
(front-end) and server (LinuxSampler) respectively. Lines in |
521 |
examples must be interpreted as every line being CRLF |
examples must be interpreted as every line being CRLF |
522 |
terminated (carriage return character followed by line feed |
terminated (carriage return character followed by line feed |
523 |
character as defined in the ASCII standard), thus the following |
character as defined in the ASCII standard <a class='info' href='#RFC20'>[RFC20]<span> (</span><span class='info'>UCLA, “ASCII format for Network Interchange,” 1969.</span><span>)</span></a>), |
524 |
example: |
thus the following example: |
525 |
</p> |
</p> |
526 |
<p> |
<p> |
527 |
</p> |
</p> |
3307 |
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> |
3308 |
command, <port> by the MIDI port number, <key> by the name of |
command, <port> by the MIDI port number, <key> by the name of |
3309 |
the parameter to change and <value> by the new value for this |
the parameter to change and <value> by the new value for this |
3310 |
parameter. |
parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes) |
3311 |
|
for specifying no value for parameters allowing a list of values. |
3312 |
</p> |
</p> |
3313 |
<p>Possible Answers: |
<p>Possible Answers: |
3314 |
</p> |
</p> |
3349 |
<p> |
<p> |
3350 |
</p> |
</p> |
3351 |
<blockquote class="text"> |
<blockquote class="text"> |
3352 |
|
<p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'" |
3353 |
|
</p> |
3354 |
|
<p>S: "OK" |
3355 |
|
</p> |
3356 |
|
</blockquote><p> |
3357 |
|
|
3358 |
|
</p> |
3359 |
<p> |
<p> |
3360 |
|
</p> |
3361 |
|
<blockquote class="text"> |
3362 |
|
<p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE" |
3363 |
|
</p> |
3364 |
|
<p>S: "OK" |
3365 |
</p> |
</p> |
3366 |
</blockquote><p> |
</blockquote><p> |
3367 |
|
|
3396 |
number of the sampler channel the instrument should be assigned to. |
number of the sampler channel the instrument should be assigned to. |
3397 |
Each sampler channel can only have one instrument. |
Each sampler channel can only have one instrument. |
3398 |
</p> |
</p> |
3399 |
|
<p>Notice: since LSCP 1.2 the <filename> argument supports |
3400 |
|
escape characters for special characters (see chapter |
3401 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>" |
3402 |
|
for details) and accordingly backslash characters in the filename |
3403 |
|
MUST now be escaped as well! |
3404 |
|
</p> |
3405 |
<p>The difference between regular and NON_MODAL versions of the command |
<p>The difference between regular and NON_MODAL versions of the command |
3406 |
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 |
3407 |
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 |
3869 |
</p> |
</p> |
3870 |
<blockquote class="text"> |
<blockquote class="text"> |
3871 |
<p>arbitrary description text about the engine |
<p>arbitrary description text about the engine |
3872 |
|
(note that the character string may contain |
3873 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
3874 |
</p> |
</p> |
3875 |
</blockquote> |
</blockquote> |
3876 |
|
|
3990 |
<blockquote class="text"> |
<blockquote class="text"> |
3991 |
<p>the file name of the loaded instrument, "NONE" if |
<p>the file name of the loaded instrument, "NONE" if |
3992 |
there's no instrument yet loaded for this sampler |
there's no instrument yet loaded for this sampler |
3993 |
channel |
channel (note: since LSCP 1.2 this path may contain |
3994 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
3995 |
</p> |
</p> |
3996 |
</blockquote> |
</blockquote> |
3997 |
|
|
4008 |
</p> |
</p> |
4009 |
<blockquote class="text"> |
<blockquote class="text"> |
4010 |
<p>the instrument name of the loaded instrument |
<p>the instrument name of the loaded instrument |
4011 |
|
(note: since LSCP 1.2 this character string may contain |
4012 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
4013 |
</p> |
</p> |
4014 |
</blockquote> |
</blockquote> |
4015 |
|
|
4056 |
</p> |
</p> |
4057 |
<blockquote class="text"> |
<blockquote class="text"> |
4058 |
<p>optionally dotted number for the channel volume factor |
<p>optionally dotted number for the channel volume factor |
4059 |
(where a value < 1.0 means attenuation and a value > |
(where a value < 1.0 means attenuation and a value > |
4060 |
1.0 means amplification) |
1.0 means amplification) |
4061 |
</p> |
</p> |
4062 |
</blockquote> |
</blockquote> |
5063 |
</blockquote><p> |
</blockquote><p> |
5064 |
|
|
5065 |
</p> |
</p> |
5066 |
<a name="RESET CHANNEL"></a><br /><hr /> |
<a name="CREATE FX_SEND"></a><br /><hr /> |
5067 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> 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> |
5068 |
<a name="rfc.section.6.4.25"></a><h3>6.4.25. |
<a name="rfc.section.6.4.25"></a><h3>6.4.25. |
5069 |
|
Adding an effect send to a sampler channel</h3> |
5070 |
|
|
5071 |
|
<p>The front-end can create an additional effect send on a specific sampler channel |
5072 |
|
by sending the following command: |
5073 |
|
</p> |
5074 |
|
<p> |
5075 |
|
</p> |
5076 |
|
<blockquote class="text"> |
5077 |
|
<p>CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>] |
5078 |
|
</p> |
5079 |
|
</blockquote><p> |
5080 |
|
|
5081 |
|
</p> |
5082 |
|
<p>Where <sampler-channel> is the respective sampler channel |
5083 |
|
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> |
5084 |
|
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 |
5085 |
|
sampler channel on which the effect send should be created on, <midi-ctrl> |
5086 |
|
is a number between 0..127 defining the MIDI controller which can alter the |
5087 |
|
effect send level and <name> is an optional argument defining a name |
5088 |
|
for the effect send entity. The name does not have to be unique, but MUST be |
5089 |
|
encapsulated into apostrophes and supports escape sequences as described in chapter |
5090 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>". |
5091 |
|
</p> |
5092 |
|
<p>By default, that is as initial routing, the effect send's audio channels |
5093 |
|
are automatically routed to the last audio channels of the sampler channel's |
5094 |
|
audio output device, that way you can i.e. first increase the amount of audio |
5095 |
|
channels on the audio output device for having dedicated effect send output |
5096 |
|
channels and when "CREATE FX_SEND" is called, those channels will automatically |
5097 |
|
be picked. You can alter the destination channels however with |
5098 |
|
<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>. |
5099 |
|
|
5100 |
|
</p> |
5101 |
|
<p>Note: Create effect sends on a sampler channel only when needed, because having effect |
5102 |
|
sends on a sampler channel will decrease runtime performance, because for implementing channel |
5103 |
|
effect sends, separate (sampler channel local) audio buffers are needed to render and mix |
5104 |
|
the voices and route the audio signal afterwards to the master outputs and effect send |
5105 |
|
outputs (along with their respective effect send levels). A sampler channel without effect |
5106 |
|
sends however can mix its voices directly into the audio output devices's audio buffers |
5107 |
|
and is thus faster. |
5108 |
|
|
5109 |
|
</p> |
5110 |
|
<p>Possible Answers: |
5111 |
|
</p> |
5112 |
|
<p> |
5113 |
|
</p> |
5114 |
|
<blockquote class="text"> |
5115 |
|
<p>"OK[<fx-send-id>]" - |
5116 |
|
</p> |
5117 |
|
<blockquote class="text"> |
5118 |
|
<p>in case a new effect send could be added to the |
5119 |
|
sampler channel, where <fx-send-id> reflects the |
5120 |
|
unique ID of the newly created effect send entity |
5121 |
|
</p> |
5122 |
|
</blockquote> |
5123 |
|
|
5124 |
|
|
5125 |
|
<p>"ERR:<error-code>:<error-message>" - |
5126 |
|
</p> |
5127 |
|
<blockquote class="text"> |
5128 |
|
<p>when a new effect send could not be added, i.e. |
5129 |
|
due to invalid parameters |
5130 |
|
</p> |
5131 |
|
</blockquote> |
5132 |
|
|
5133 |
|
|
5134 |
|
</blockquote><p> |
5135 |
|
|
5136 |
|
</p> |
5137 |
|
<p>Examples: |
5138 |
|
</p> |
5139 |
|
<p> |
5140 |
|
</p> |
5141 |
|
<blockquote class="text"> |
5142 |
|
<p>C: "CREATE FX_SEND 0 91 'Reverb Send'" |
5143 |
|
</p> |
5144 |
|
<p>S: "OK[0]" |
5145 |
|
</p> |
5146 |
|
</blockquote><p> |
5147 |
|
|
5148 |
|
</p> |
5149 |
|
<p> |
5150 |
|
</p> |
5151 |
|
<blockquote class="text"> |
5152 |
|
<p>C: "CREATE FX_SEND 0 93" |
5153 |
|
</p> |
5154 |
|
<p>S: "OK[1]" |
5155 |
|
</p> |
5156 |
|
</blockquote><p> |
5157 |
|
|
5158 |
|
</p> |
5159 |
|
<a name="DESTROY FX_SEND"></a><br /><hr /> |
5160 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5161 |
|
<a name="rfc.section.6.4.26"></a><h3>6.4.26. |
5162 |
|
Removing an effect send from a sampler channel</h3> |
5163 |
|
|
5164 |
|
<p>The front-end can remove an existing effect send on a specific sampler channel |
5165 |
|
by sending the following command: |
5166 |
|
</p> |
5167 |
|
<p> |
5168 |
|
</p> |
5169 |
|
<blockquote class="text"> |
5170 |
|
<p>DESTROY FX_SEND <sampler-channel> <fx-send-id> |
5171 |
|
</p> |
5172 |
|
</blockquote><p> |
5173 |
|
|
5174 |
|
</p> |
5175 |
|
<p>Where <sampler-channel> is the respective sampler channel |
5176 |
|
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> |
5177 |
|
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 |
5178 |
|
sampler channel from which the effect send should be removed from and |
5179 |
|
<fx-send-id> is the respective effect send number as returned by the |
5180 |
|
<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> |
5181 |
|
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. |
5182 |
|
</p> |
5183 |
|
<p>Possible Answers: |
5184 |
|
</p> |
5185 |
|
<p> |
5186 |
|
</p> |
5187 |
|
<blockquote class="text"> |
5188 |
|
<p>"OK" - |
5189 |
|
</p> |
5190 |
|
<blockquote class="text"> |
5191 |
|
<p>on success |
5192 |
|
</p> |
5193 |
|
</blockquote> |
5194 |
|
|
5195 |
|
|
5196 |
|
<p>"ERR:<error-code>:<error-message>" - |
5197 |
|
</p> |
5198 |
|
<blockquote class="text"> |
5199 |
|
<p>in case it failed, providing an appropriate error code and |
5200 |
|
error message |
5201 |
|
</p> |
5202 |
|
</blockquote> |
5203 |
|
|
5204 |
|
|
5205 |
|
</blockquote><p> |
5206 |
|
|
5207 |
|
</p> |
5208 |
|
<p>Example: |
5209 |
|
</p> |
5210 |
|
<p> |
5211 |
|
</p> |
5212 |
|
<blockquote class="text"> |
5213 |
|
<p>C: "DESTROY FX_SEND 0 0" |
5214 |
|
</p> |
5215 |
|
<p>S: "OK" |
5216 |
|
</p> |
5217 |
|
</blockquote><p> |
5218 |
|
|
5219 |
|
</p> |
5220 |
|
<a name="GET FX_SENDS"></a><br /><hr /> |
5221 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5222 |
|
<a name="rfc.section.6.4.27"></a><h3>6.4.27. |
5223 |
|
Getting amount of effect sends on a sampler channel</h3> |
5224 |
|
|
5225 |
|
<p>The front-end can ask for the amount of effect sends on a specific sampler channel |
5226 |
|
by sending the following command: |
5227 |
|
</p> |
5228 |
|
<p> |
5229 |
|
</p> |
5230 |
|
<blockquote class="text"> |
5231 |
|
<p>GET FX_SENDS <sampler-channel> |
5232 |
|
</p> |
5233 |
|
</blockquote><p> |
5234 |
|
|
5235 |
|
</p> |
5236 |
|
<p>Where <sampler-channel> is the respective sampler channel |
5237 |
|
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> |
5238 |
|
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. |
5239 |
|
</p> |
5240 |
|
<p>Possible Answers: |
5241 |
|
</p> |
5242 |
|
<p> |
5243 |
|
</p> |
5244 |
|
<blockquote class="text"> |
5245 |
|
<p>The sampler will answer by returning the number of effect |
5246 |
|
sends on the given sampler channel. |
5247 |
|
</p> |
5248 |
|
</blockquote><p> |
5249 |
|
|
5250 |
|
</p> |
5251 |
|
<p>Example: |
5252 |
|
</p> |
5253 |
|
<p> |
5254 |
|
</p> |
5255 |
|
<blockquote class="text"> |
5256 |
|
<p>C: "GET FX_SENDS 0" |
5257 |
|
</p> |
5258 |
|
<p>S: "2" |
5259 |
|
</p> |
5260 |
|
</blockquote><p> |
5261 |
|
|
5262 |
|
</p> |
5263 |
|
<a name="LIST FX_SENDS"></a><br /><hr /> |
5264 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5265 |
|
<a name="rfc.section.6.4.28"></a><h3>6.4.28. |
5266 |
|
Listing all effect sends on a sampler channel</h3> |
5267 |
|
|
5268 |
|
<p>The front-end can ask for a list of effect sends on a specific sampler channel |
5269 |
|
by sending the following command: |
5270 |
|
</p> |
5271 |
|
<p> |
5272 |
|
</p> |
5273 |
|
<blockquote class="text"> |
5274 |
|
<p>LIST FX_SENDS <sampler-channel> |
5275 |
|
</p> |
5276 |
|
</blockquote><p> |
5277 |
|
|
5278 |
|
</p> |
5279 |
|
<p>Where <sampler-channel> is the respective sampler channel |
5280 |
|
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> |
5281 |
|
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. |
5282 |
|
</p> |
5283 |
|
<p>Possible Answers: |
5284 |
|
</p> |
5285 |
|
<p> |
5286 |
|
</p> |
5287 |
|
<blockquote class="text"> |
5288 |
|
<p>The sampler will answer by returning a comma separated list |
5289 |
|
with all effect sends' numerical IDs on the given sampler |
5290 |
|
channel. |
5291 |
|
</p> |
5292 |
|
</blockquote><p> |
5293 |
|
|
5294 |
|
</p> |
5295 |
|
<p>Examples: |
5296 |
|
</p> |
5297 |
|
<p> |
5298 |
|
</p> |
5299 |
|
<blockquote class="text"> |
5300 |
|
<p>C: "LIST FX_SENDS 0" |
5301 |
|
</p> |
5302 |
|
<p>S: "0,1" |
5303 |
|
</p> |
5304 |
|
</blockquote><p> |
5305 |
|
|
5306 |
|
</p> |
5307 |
|
<p> |
5308 |
|
</p> |
5309 |
|
<blockquote class="text"> |
5310 |
|
<p>C: "LIST FX_SENDS 1" |
5311 |
|
</p> |
5312 |
|
<p>S: "" |
5313 |
|
</p> |
5314 |
|
</blockquote><p> |
5315 |
|
|
5316 |
|
</p> |
5317 |
|
<a name="GET FX_SEND INFO"></a><br /><hr /> |
5318 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5319 |
|
<a name="rfc.section.6.4.29"></a><h3>6.4.29. |
5320 |
|
Getting effect send information</h3> |
5321 |
|
|
5322 |
|
<p>The front-end can ask for the current settings of an effect send entity |
5323 |
|
by sending the following command: |
5324 |
|
</p> |
5325 |
|
<p> |
5326 |
|
</p> |
5327 |
|
<blockquote class="text"> |
5328 |
|
<p>GET FX_SEND INFO <sampler-channel> <fx-send-id> |
5329 |
|
</p> |
5330 |
|
</blockquote><p> |
5331 |
|
|
5332 |
|
</p> |
5333 |
|
<p>Where <sampler-channel> is the sampler channel number |
5334 |
|
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> |
5335 |
|
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 |
5336 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
5337 |
|
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> |
5338 |
|
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. |
5339 |
|
|
5340 |
|
</p> |
5341 |
|
<p>Possible Answers: |
5342 |
|
</p> |
5343 |
|
<p> |
5344 |
|
</p> |
5345 |
|
<blockquote class="text"> |
5346 |
|
<p>The sampler will answer by sending a <CRLF> separated list. |
5347 |
|
Each answer line begins with the settings category name |
5348 |
|
followed by a colon and then a space character <SP> and finally |
5349 |
|
the info character string to that setting category. At the |
5350 |
|
moment the following categories are defined: |
5351 |
|
</p> |
5352 |
|
<p> |
5353 |
|
</p> |
5354 |
|
<blockquote class="text"> |
5355 |
|
<p>NAME - |
5356 |
|
</p> |
5357 |
|
<blockquote class="text"> |
5358 |
|
<p>name of the effect send entity |
5359 |
|
(note that this character string may contain |
5360 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
5361 |
|
</p> |
5362 |
|
</blockquote> |
5363 |
|
|
5364 |
|
|
5365 |
|
<p>MIDI_CONTROLLER - |
5366 |
|
</p> |
5367 |
|
<blockquote class="text"> |
5368 |
|
<p>a value between 0 and 127 reflecting the MIDI controller |
5369 |
|
which is able to modify the effect send's send level |
5370 |
|
</p> |
5371 |
|
</blockquote> |
5372 |
|
|
5373 |
|
|
5374 |
|
<p>LEVEL - |
5375 |
|
</p> |
5376 |
|
<blockquote class="text"> |
5377 |
|
<p>optionally dotted number reflecting the effect send's |
5378 |
|
current send level (where a value < 1.0 means attenuation |
5379 |
|
and a value > 1.0 means amplification) |
5380 |
|
</p> |
5381 |
|
</blockquote> |
5382 |
|
|
5383 |
|
|
5384 |
|
<p>AUDIO_OUTPUT_ROUTING - |
5385 |
|
</p> |
5386 |
|
<blockquote class="text"> |
5387 |
|
<p>comma separated list which reflects to which audio |
5388 |
|
channel of the selected audio output device each |
5389 |
|
effect send output channel is routed to, e.g. "0,3" would |
5390 |
|
mean the effect send's output channel 0 is routed to channel |
5391 |
|
0 of the audio output device and the effect send's output |
5392 |
|
channel 1 is routed to the channel 3 of the audio |
5393 |
|
output device (see |
5394 |
|
<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> |
5395 |
|
for details) |
5396 |
|
</p> |
5397 |
|
</blockquote> |
5398 |
|
|
5399 |
|
|
5400 |
|
</blockquote> |
5401 |
|
|
5402 |
|
|
5403 |
|
</blockquote><p> |
5404 |
|
|
5405 |
|
</p> |
5406 |
|
<p>The mentioned fields above don't have to be in particular order. |
5407 |
|
</p> |
5408 |
|
<p>Example: |
5409 |
|
</p> |
5410 |
|
<p> |
5411 |
|
</p> |
5412 |
|
<blockquote class="text"> |
5413 |
|
<p>C: "GET FX_SEND INFO 0 0" |
5414 |
|
</p> |
5415 |
|
<p>S: "NAME: Reverb Send" |
5416 |
|
</p> |
5417 |
|
<p> "MIDI_CONTROLLER: 91" |
5418 |
|
</p> |
5419 |
|
<p> "LEVEL: 0.3" |
5420 |
|
</p> |
5421 |
|
<p> "AUDIO_OUTPUT_ROUTING: 2,3" |
5422 |
|
</p> |
5423 |
|
<p> "." |
5424 |
|
</p> |
5425 |
|
</blockquote><p> |
5426 |
|
|
5427 |
|
</p> |
5428 |
|
<a name="SET FX_SEND NAME"></a><br /><hr /> |
5429 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5430 |
|
<a name="rfc.section.6.4.30"></a><h3>6.4.30. |
5431 |
|
Changing effect send's name</h3> |
5432 |
|
|
5433 |
|
<p>The front-end can alter the current name of an effect |
5434 |
|
send entity by sending the following command: |
5435 |
|
</p> |
5436 |
|
<p> |
5437 |
|
</p> |
5438 |
|
<blockquote class="text"> |
5439 |
|
<p>SET FX_SEND NAME <sampler-chan> <fx-send-id> <name> |
5440 |
|
</p> |
5441 |
|
</blockquote><p> |
5442 |
|
|
5443 |
|
</p> |
5444 |
|
<p>Where <sampler-chan> is the sampler channel number |
5445 |
|
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> |
5446 |
|
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, |
5447 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
5448 |
|
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> |
5449 |
|
or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and |
5450 |
|
<name> is the new name of the effect send entity, which |
5451 |
|
does not have to be unique (name MUST be encapsulated into apostrophes |
5452 |
|
and supports escape sequences as described in chapter |
5453 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
5454 |
|
|
5455 |
|
</p> |
5456 |
|
<p>Possible Answers: |
5457 |
|
</p> |
5458 |
|
<p> |
5459 |
|
</p> |
5460 |
|
<blockquote class="text"> |
5461 |
|
<p>"OK" - |
5462 |
|
</p> |
5463 |
|
<blockquote class="text"> |
5464 |
|
<p>on success |
5465 |
|
</p> |
5466 |
|
</blockquote> |
5467 |
|
|
5468 |
|
|
5469 |
|
<p>"ERR:<error-code>:<error-message>" - |
5470 |
|
</p> |
5471 |
|
<blockquote class="text"> |
5472 |
|
<p>in case it failed, providing an appropriate error code and error message |
5473 |
|
</p> |
5474 |
|
</blockquote> |
5475 |
|
|
5476 |
|
|
5477 |
|
</blockquote><p> |
5478 |
|
|
5479 |
|
</p> |
5480 |
|
<p>Example: |
5481 |
|
</p> |
5482 |
|
<p> |
5483 |
|
</p> |
5484 |
|
<blockquote class="text"> |
5485 |
|
<p>C: "SET FX_SEND NAME 0 0 'Fx Send 1'" |
5486 |
|
</p> |
5487 |
|
<p>S: "OK" |
5488 |
|
</p> |
5489 |
|
</blockquote><p> |
5490 |
|
|
5491 |
|
</p> |
5492 |
|
<a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr /> |
5493 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5494 |
|
<a name="rfc.section.6.4.31"></a><h3>6.4.31. |
5495 |
|
Altering effect send's audio routing</h3> |
5496 |
|
|
5497 |
|
<p>The front-end can alter the destination of an effect send's audio channel on a specific |
5498 |
|
sampler channel by sending the following command: |
5499 |
|
</p> |
5500 |
|
<p> |
5501 |
|
</p> |
5502 |
|
<blockquote class="text"> |
5503 |
|
<p>SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id> <audio-src> <audio-dst> |
5504 |
|
</p> |
5505 |
|
</blockquote><p> |
5506 |
|
|
5507 |
|
</p> |
5508 |
|
<p>Where <sampler-chan> is the sampler channel number |
5509 |
|
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> |
5510 |
|
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, |
5511 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
5512 |
|
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> |
5513 |
|
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, |
5514 |
|
<audio-src> is the numerical ID of the effect send's audio channel |
5515 |
|
which should be rerouted and <audio-dst> is the numerical ID of |
5516 |
|
the audio channel of the selected audio output device where <audio-src> |
5517 |
|
should be routed to. |
5518 |
|
</p> |
5519 |
|
<p>Note that effect sends can only route audio to the same audio output |
5520 |
|
device as assigned to the effect send's sampler channel. Also note that an |
5521 |
|
effect send entity does always have exactly as much audio channels as its |
5522 |
|
sampler channel. So if the sampler channel is stereo, the effect send does |
5523 |
|
have two audio channels as well. Also keep in mind that the amount of audio |
5524 |
|
channels on a sampler channel might be dependant not only to the deployed |
5525 |
|
sampler engine on the sampler channel, but also dependant to the instrument |
5526 |
|
currently loaded. However you can (effectively) turn an i.e. stereo effect |
5527 |
|
send into a mono one by simply altering its audio routing appropriately. |
5528 |
|
</p> |
5529 |
|
<p>Possible Answers: |
5530 |
|
</p> |
5531 |
|
<p> |
5532 |
|
</p> |
5533 |
|
<blockquote class="text"> |
5534 |
|
<p>"OK" - |
5535 |
|
</p> |
5536 |
|
<blockquote class="text"> |
5537 |
|
<p>on success |
5538 |
|
</p> |
5539 |
|
</blockquote> |
5540 |
|
|
5541 |
|
|
5542 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
5543 |
|
</p> |
5544 |
|
<blockquote class="text"> |
5545 |
|
<p>if audio output channel was set, but there are noteworthy |
5546 |
|
issue(s) related, providing an appropriate warning code and |
5547 |
|
warning message |
5548 |
|
</p> |
5549 |
|
</blockquote> |
5550 |
|
|
5551 |
|
|
5552 |
|
<p>"ERR:<error-code>:<error-message>" - |
5553 |
|
</p> |
5554 |
|
<blockquote class="text"> |
5555 |
|
<p>in case it failed, providing an appropriate error code and error message |
5556 |
|
</p> |
5557 |
|
</blockquote> |
5558 |
|
|
5559 |
|
|
5560 |
|
</blockquote><p> |
5561 |
|
|
5562 |
|
</p> |
5563 |
|
<p>Example: |
5564 |
|
</p> |
5565 |
|
<p> |
5566 |
|
</p> |
5567 |
|
<blockquote class="text"> |
5568 |
|
<p>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2" |
5569 |
|
</p> |
5570 |
|
<p>S: "OK" |
5571 |
|
</p> |
5572 |
|
</blockquote><p> |
5573 |
|
|
5574 |
|
</p> |
5575 |
|
<a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr /> |
5576 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5577 |
|
<a name="rfc.section.6.4.32"></a><h3>6.4.32. |
5578 |
|
Altering effect send's MIDI controller</h3> |
5579 |
|
|
5580 |
|
<p>The front-end can alter the MIDI controller of an effect |
5581 |
|
send entity by sending the following command: |
5582 |
|
</p> |
5583 |
|
<p> |
5584 |
|
</p> |
5585 |
|
<blockquote class="text"> |
5586 |
|
<p>SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-ctrl> |
5587 |
|
</p> |
5588 |
|
</blockquote><p> |
5589 |
|
|
5590 |
|
</p> |
5591 |
|
<p>Where <sampler-chan> is the sampler channel number |
5592 |
|
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> |
5593 |
|
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, |
5594 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
5595 |
|
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> |
5596 |
|
or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and |
5597 |
|
<midi-ctrl> reflects the MIDI controller which shall be |
5598 |
|
able to modify the effect send's send level. |
5599 |
|
</p> |
5600 |
|
<p>Possible Answers: |
5601 |
|
</p> |
5602 |
|
<p> |
5603 |
|
</p> |
5604 |
|
<blockquote class="text"> |
5605 |
|
<p>"OK" - |
5606 |
|
</p> |
5607 |
|
<blockquote class="text"> |
5608 |
|
<p>on success |
5609 |
|
</p> |
5610 |
|
</blockquote> |
5611 |
|
|
5612 |
|
|
5613 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
5614 |
|
</p> |
5615 |
|
<blockquote class="text"> |
5616 |
|
<p>if MIDI controller was set, but there are noteworthy |
5617 |
|
issue(s) related, providing an appropriate warning code and |
5618 |
|
warning message |
5619 |
|
</p> |
5620 |
|
</blockquote> |
5621 |
|
|
5622 |
|
|
5623 |
|
<p>"ERR:<error-code>:<error-message>" - |
5624 |
|
</p> |
5625 |
|
<blockquote class="text"> |
5626 |
|
<p>in case it failed, providing an appropriate error code and error message |
5627 |
|
</p> |
5628 |
|
</blockquote> |
5629 |
|
|
5630 |
|
|
5631 |
|
</blockquote><p> |
5632 |
|
|
5633 |
|
</p> |
5634 |
|
<p>Example: |
5635 |
|
</p> |
5636 |
|
<p> |
5637 |
|
</p> |
5638 |
|
<blockquote class="text"> |
5639 |
|
<p>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91" |
5640 |
|
</p> |
5641 |
|
<p>S: "OK" |
5642 |
|
</p> |
5643 |
|
</blockquote><p> |
5644 |
|
|
5645 |
|
</p> |
5646 |
|
<a name="SET FX_SEND LEVEL"></a><br /><hr /> |
5647 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5648 |
|
<a name="rfc.section.6.4.33"></a><h3>6.4.33. |
5649 |
|
Altering effect send's send level</h3> |
5650 |
|
|
5651 |
|
<p>The front-end can alter the current send level of an effect |
5652 |
|
send entity by sending the following command: |
5653 |
|
</p> |
5654 |
|
<p> |
5655 |
|
</p> |
5656 |
|
<blockquote class="text"> |
5657 |
|
<p>SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume> |
5658 |
|
</p> |
5659 |
|
</blockquote><p> |
5660 |
|
|
5661 |
|
</p> |
5662 |
|
<p>Where <sampler-chan> is the sampler channel number |
5663 |
|
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> |
5664 |
|
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, |
5665 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
5666 |
|
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> |
5667 |
|
or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and |
5668 |
|
<volume> is an optionally dotted positive number (a value |
5669 |
|
smaller than 1.0 means attenuation, whereas a value greater than |
5670 |
|
1.0 means amplification) reflecting the new send level. |
5671 |
|
</p> |
5672 |
|
<p>Possible Answers: |
5673 |
|
</p> |
5674 |
|
<p> |
5675 |
|
</p> |
5676 |
|
<blockquote class="text"> |
5677 |
|
<p>"OK" - |
5678 |
|
</p> |
5679 |
|
<blockquote class="text"> |
5680 |
|
<p>on success |
5681 |
|
</p> |
5682 |
|
</blockquote> |
5683 |
|
|
5684 |
|
|
5685 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
5686 |
|
</p> |
5687 |
|
<blockquote class="text"> |
5688 |
|
<p>if new send level was set, but there are noteworthy |
5689 |
|
issue(s) related, providing an appropriate warning code and |
5690 |
|
warning message |
5691 |
|
</p> |
5692 |
|
</blockquote> |
5693 |
|
|
5694 |
|
|
5695 |
|
<p>"ERR:<error-code>:<error-message>" - |
5696 |
|
</p> |
5697 |
|
<blockquote class="text"> |
5698 |
|
<p>in case it failed, providing an appropriate error code and error message |
5699 |
|
</p> |
5700 |
|
</blockquote> |
5701 |
|
|
5702 |
|
|
5703 |
|
</blockquote><p> |
5704 |
|
|
5705 |
|
</p> |
5706 |
|
<p>Example: |
5707 |
|
</p> |
5708 |
|
<p> |
5709 |
|
</p> |
5710 |
|
<blockquote class="text"> |
5711 |
|
<p>C: "SET FX_SEND LEVEL 0 0 0.15" |
5712 |
|
</p> |
5713 |
|
<p>S: "OK" |
5714 |
|
</p> |
5715 |
|
</blockquote><p> |
5716 |
|
|
5717 |
|
</p> |
5718 |
|
<a name="RESET CHANNEL"></a><br /><hr /> |
5719 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5720 |
|
<a name="rfc.section.6.4.34"></a><h3>6.4.34. |
5721 |
Resetting a sampler channel</h3> |
Resetting a sampler channel</h3> |
5722 |
|
|
5723 |
<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: |
6128 |
</p> |
</p> |
6129 |
<blockquote class="text"> |
<blockquote class="text"> |
6130 |
<p>arbitrary textual description about the sampler |
<p>arbitrary textual description about the sampler |
6131 |
|
(note that the character string may contain |
6132 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
6133 |
</p> |
</p> |
6134 |
</blockquote> |
</blockquote> |
6135 |
|
|
6151 |
</blockquote> |
</blockquote> |
6152 |
|
|
6153 |
|
|
6154 |
|
<p>INSTRUMENTS_DB_SUPPORT - |
6155 |
|
</p> |
6156 |
|
<blockquote class="text"> |
6157 |
|
<p>either yes or no, specifies whether the |
6158 |
|
sampler is build with instruments database support. |
6159 |
|
</p> |
6160 |
|
</blockquote> |
6161 |
|
|
6162 |
|
|
6163 |
</blockquote> |
</blockquote> |
6164 |
|
|
6165 |
|
|
6169 |
<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. |
6170 |
Other fields might be added in future. |
Other fields might be added in future. |
6171 |
</p> |
</p> |
6172 |
|
<a name="GET VOLUME"></a><br /><hr /> |
6173 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6174 |
|
<a name="rfc.section.6.6.5"></a><h3>6.6.5. |
6175 |
|
Getting global volume attenuation</h3> |
6176 |
|
|
6177 |
|
<p>The client can ask for the current global sampler-wide volume |
6178 |
|
attenuation by sending the following command: |
6179 |
|
</p> |
6180 |
|
<p> |
6181 |
|
</p> |
6182 |
|
<blockquote class="text"> |
6183 |
|
<p>GET VOLUME |
6184 |
|
</p> |
6185 |
|
</blockquote><p> |
6186 |
|
|
6187 |
|
</p> |
6188 |
|
<p>Possible Answers: |
6189 |
|
</p> |
6190 |
|
<p> |
6191 |
|
</p> |
6192 |
|
<blockquote class="text"> |
6193 |
|
<p>The sampler will always answer by returning the optional |
6194 |
|
dotted floating point coefficient, reflecting the current |
6195 |
|
global volume attenuation. |
6196 |
|
|
6197 |
|
</p> |
6198 |
|
</blockquote><p> |
6199 |
|
|
6200 |
|
</p> |
6201 |
|
<p>Note: it is up to the respective sampler engine whether to obey |
6202 |
|
that global volume parameter or not, but in general all engines SHOULD |
6203 |
|
use this parameter. |
6204 |
|
</p> |
6205 |
|
<a name="SET VOLUME"></a><br /><hr /> |
6206 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6207 |
|
<a name="rfc.section.6.6.6"></a><h3>6.6.6. |
6208 |
|
Setting global volume attenuation</h3> |
6209 |
|
|
6210 |
|
<p>The client can alter the current global sampler-wide volume |
6211 |
|
attenuation by sending the following command: |
6212 |
|
</p> |
6213 |
|
<p> |
6214 |
|
</p> |
6215 |
|
<blockquote class="text"> |
6216 |
|
<p>SET VOLUME <volume> |
6217 |
|
</p> |
6218 |
|
</blockquote><p> |
6219 |
|
|
6220 |
|
</p> |
6221 |
|
<p>Where <volume> should be replaced by the optional dotted |
6222 |
|
floating point value, reflecting the new global volume parameter. |
6223 |
|
This value might usually be in the range between 0.0 and 1.0, that |
6224 |
|
is for attenuating the overall volume. |
6225 |
|
</p> |
6226 |
|
<p>Possible Answers: |
6227 |
|
</p> |
6228 |
|
<p> |
6229 |
|
</p> |
6230 |
|
<blockquote class="text"> |
6231 |
|
<p>"OK" - |
6232 |
|
</p> |
6233 |
|
<blockquote class="text"> |
6234 |
|
<p>on success |
6235 |
|
</p> |
6236 |
|
</blockquote> |
6237 |
|
|
6238 |
|
|
6239 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
6240 |
|
</p> |
6241 |
|
<blockquote class="text"> |
6242 |
|
<p>if the global volume was set, but there are noteworthy |
6243 |
|
issue(s) related, providing an appropriate warning code and |
6244 |
|
warning message |
6245 |
|
</p> |
6246 |
|
</blockquote> |
6247 |
|
|
6248 |
|
|
6249 |
|
<p>"ERR:<error-code>:<error-message>" - |
6250 |
|
</p> |
6251 |
|
<blockquote class="text"> |
6252 |
|
<p>in case it failed, providing an appropriate error code and error message |
6253 |
|
</p> |
6254 |
|
</blockquote> |
6255 |
|
|
6256 |
|
|
6257 |
|
</blockquote><p> |
6258 |
|
|
6259 |
|
</p> |
6260 |
<a name="MIDI Instrument Mapping"></a><br /><hr /> |
<a name="MIDI Instrument Mapping"></a><br /><hr /> |
6261 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> 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> |
6262 |
<a name="rfc.section.6.7"></a><h3>6.7. |
<a name="rfc.section.6.7"></a><h3>6.7. |
6291 |
cause the sampler to switch to the respective instrument as |
cause the sampler to switch to the respective instrument as |
6292 |
reflected by the current MIDI instrument map. |
reflected by the current MIDI instrument map. |
6293 |
</p> |
</p> |
6294 |
<a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr /> |
<a name="ADD MIDI_INSTRUMENT_MAP"></a><br /><hr /> |
6295 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> 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> |
6296 |
<a name="rfc.section.6.7.1"></a><h3>6.7.1. |
<a name="rfc.section.6.7.1"></a><h3>6.7.1. |
6297 |
Create a new MIDI instrument map</h3> |
Create a new MIDI instrument map</h3> |
6309 |
</p> |
</p> |
6310 |
<p>Where <name> is an optional argument allowing to |
<p>Where <name> is an optional argument allowing to |
6311 |
assign a custom name to the new map. MIDI instrument Map |
assign a custom name to the new map. MIDI instrument Map |
6312 |
names do not have to be unique. |
names do not have to be unique, but MUST be encapsulated |
6313 |
|
into apostrophes and support escape sequences as described |
6314 |
|
in chapter "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>". |
6315 |
|
|
6316 |
</p> |
</p> |
6317 |
<p>Possible Answers: |
<p>Possible Answers: |
6318 |
</p> |
</p> |
6570 |
<blockquote class="text"> |
<blockquote class="text"> |
6571 |
<p>custom name of the given map, |
<p>custom name of the given map, |
6572 |
which does not have to be unique |
which does not have to be unique |
6573 |
|
(note that this character string may contain |
6574 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
6575 |
|
</p> |
6576 |
|
</blockquote> |
6577 |
|
|
6578 |
|
|
6579 |
|
<p>DEFAULT - |
6580 |
|
</p> |
6581 |
|
<blockquote class="text"> |
6582 |
|
<p>either true or false, |
6583 |
|
defines whether this map is the default map |
6584 |
</p> |
</p> |
6585 |
</blockquote> |
</blockquote> |
6586 |
|
|
6602 |
</p> |
</p> |
6603 |
<p>S: "NAME: Standard Map" |
<p>S: "NAME: Standard Map" |
6604 |
</p> |
</p> |
6605 |
|
<p> "DEFAULT: true" |
6606 |
|
</p> |
6607 |
<p> "." |
<p> "." |
6608 |
</p> |
</p> |
6609 |
</blockquote><p> |
</blockquote><p> |
6627 |
</p> |
</p> |
6628 |
<p>Where <map> is the numerical ID of the map and |
<p>Where <map> is the numerical ID of the map and |
6629 |
<name> the new custom name of the map, which does not |
<name> the new custom name of the map, which does not |
6630 |
have to be unique. |
have to be unique (name MUST be encapsulated into apostrophes |
6631 |
|
and supports escape sequences as described in chapter |
6632 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
6633 |
|
|
6634 |
</p> |
</p> |
6635 |
<p>Possible Answers: |
<p>Possible Answers: |
6636 |
</p> |
</p> |
6680 |
<p> |
<p> |
6681 |
</p> |
</p> |
6682 |
<blockquote class="text"> |
<blockquote class="text"> |
6683 |
<p>MAP MIDI_INSTRUMENT <map> |
<p>MAP MIDI_INSTRUMENT [NON_MODAL] <map> |
6684 |
<midi_bank> <midi_prog> <engine_name> |
<midi_bank> <midi_prog> <engine_name> |
6685 |
<filename> <instrument_index> <volume_value> |
<filename> <instrument_index> <volume_value> |
6686 |
[<instr_load_mode>] [<name>] |
[<instr_load_mode>] [<name>] |
6696 |
index, <engine_name> a sampler engine name as returned by |
index, <engine_name> a sampler engine name as returned by |
6697 |
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> |
6698 |
command (not encapsulated into apostrophes), <filename> the name |
command (not encapsulated into apostrophes), <filename> the name |
6699 |
of the instrument's file to be deployed (encapsulated into apostrophes), |
of the instrument's file to be deployed (encapsulated into apostrophes, |
6700 |
|
supporting escape sequences as described in chapter |
6701 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"), |
6702 |
<instrument_index> the index (integer value) of the instrument |
<instrument_index> the index (integer value) of the instrument |
6703 |
within the given file, <volume_value> reflects the master |
within the given file, <volume_value> reflects the master |
6704 |
volume of the instrument as optionally dotted number (where a |
volume of the instrument as optionally dotted number (where a |
6705 |
value < 1.0 means attenuation and a value > 1.0 means |
value < 1.0 means attenuation and a value > 1.0 means |
6706 |
amplification). This parameter easily allows to adjust the |
amplification). This parameter easily allows to adjust the |
6707 |
volume of all intruments within a custom instrument map |
volume of all intruments within a custom instrument map |
6708 |
without having to adjust their instrument files. The |
without having to adjust their instrument files. The |
6746 |
</p> |
</p> |
6747 |
<blockquote class="text"> |
<blockquote class="text"> |
6748 |
<p>The instrument will immediately be loaded |
<p>The instrument will immediately be loaded |
6749 |
into memory in the background when this mapping |
into memory when this mapping |
6750 |
command is sent and the instrument is kept all |
command is sent and the instrument is kept all |
6751 |
the time. Instruments with this mode are |
the time. Instruments with this mode are |
6752 |
only freed when the sampler is reset or all |
only freed when the sampler is reset or all |
6795 |
load modes of entries, the frontend should retrieve the actual |
load modes of entries, the frontend should retrieve the actual |
6796 |
mode by i.e. sending |
mode by i.e. sending |
6797 |
<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> |
6798 |
command(s). Finally the OPTIONAL <name> argument allows to |
command(s). Finally the OPTIONAL <name> argument allows to set a custom name |
6799 |
set a custom name (encapsulated into apostrophes) for the mapping |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
6800 |
entry, useful for frontends for displaying an appropriate name for |
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") for the |
6801 |
|
mapping entry, useful for frontends for displaying an appropriate name for |
6802 |
mapped instruments (using |
mapped instruments (using |
6803 |
<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>). |
6804 |
|
|
6805 |
</p> |
</p> |
6806 |
<p> |
<p> |
6807 |
The "MAP MIDI_INSTRUMENT" command |
By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is |
6808 |
will immediately return, thus it will not block when an |
completely established in the sampler. The OPTIONAL "NON_MODAL" argument |
6809 |
instrument is to be loaded due to a "PERSISTENT" type |
however causes the respective "MAP MIDI_INSTRUMENT" command to return |
6810 |
entry as instruments are loaded in the background. As a |
immediately, that is to let the sampler establish the mapping in the |
6811 |
consequence this command may not necessarily return an error |
background. So this argument might be especially useful for mappings with |
6812 |
i.e. when the given instrument file does not exist or may |
a "PERSISTENT" type, because these have to load the respective instruments |
6813 |
turn out to be corrupt. |
immediately and might thus block for a very long time. It is recommended |
6814 |
|
however to use the OPTIONAL "NON_MODAL" argument only if really necessary, |
6815 |
|
because it has the following drawbacks: as "NON_MODAL" instructions return |
6816 |
|
immediately, they may not necessarily return an error i.e. when the given |
6817 |
|
instrument file turns out to be corrupt, beside that subsequent commands |
6818 |
|
in a LSCP instruction sequence might fail, because mandatory mappings are |
6819 |
|
not yet completed. |
6820 |
|
|
6821 |
</p> |
</p> |
6822 |
<p>Possible Answers: |
<p>Possible Answers: |
6883 |
<p> |
<p> |
6884 |
</p> |
</p> |
6885 |
<blockquote class="text"> |
<blockquote class="text"> |
6886 |
<p>C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'" |
<p>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'" |
6887 |
</p> |
</p> |
6888 |
<p>S: "OK" |
<p>S: "OK" |
6889 |
</p> |
</p> |
7120 |
changed with the |
changed with the |
7121 |
<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> |
7122 |
command and does not have to be unique. |
command and does not have to be unique. |
7123 |
|
(note that this character string may contain |
7124 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
7125 |
</p> |
</p> |
7126 |
</blockquote> |
</blockquote> |
7127 |
|
|
7138 |
<p>"INSTRUMENT_FILE" - |
<p>"INSTRUMENT_FILE" - |
7139 |
</p> |
</p> |
7140 |
<blockquote class="text"> |
<blockquote class="text"> |
7141 |
<p>File name of the instrument. |
<p>File name of the instrument |
7142 |
|
(note that this path may contain |
7143 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>). |
7144 |
</p> |
</p> |
7145 |
</blockquote> |
</blockquote> |
7146 |
|
|
7158 |
<blockquote class="text"> |
<blockquote class="text"> |
7159 |
<p>Name of the loaded instrument as reflected by its file. |
<p>Name of the loaded instrument as reflected by its file. |
7160 |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
7161 |
cannot be changed. |
cannot be changed (note that this character string may contain |
7162 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>). |
7163 |
</p> |
</p> |
7164 |
</blockquote> |
</blockquote> |
7165 |
|
|
7177 |
</p> |
</p> |
7178 |
<blockquote class="text"> |
<blockquote class="text"> |
7179 |
<p>master volume of the instrument as optionally |
<p>master volume of the instrument as optionally |
7180 |
dotted number (where a value < 1.0 means attenuation |
dotted number (where a value < 1.0 means attenuation |
7181 |
and a value > 1.0 means amplification) |
and a value > 1.0 means amplification) |
7182 |
</p> |
</p> |
7183 |
</blockquote> |
</blockquote> |
7286 |
</blockquote><p> |
</blockquote><p> |
7287 |
|
|
7288 |
</p> |
</p> |
7289 |
|
<a name="Managing Instruments Database"></a><br /><hr /> |
7290 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7291 |
|
<a name="rfc.section.6.8"></a><h3>6.8. |
7292 |
|
Managing Instruments Database</h3> |
7293 |
|
|
7294 |
|
<p>The following commands describe how to use and manage |
7295 |
|
the instruments database. |
7296 |
|
</p> |
7297 |
|
<p>Notice: |
7298 |
|
</p> |
7299 |
|
<p> |
7300 |
|
</p> |
7301 |
|
<blockquote class="text"> |
7302 |
|
<p>All command arguments representing a path or |
7303 |
|
instrument/directory name support escape sequences as described in chapter |
7304 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>". |
7305 |
|
|
7306 |
|
</p> |
7307 |
|
<p>All occurrences of a forward slash in instrument and directory |
7308 |
|
names are escaped with its hex (\x2f) or octal (\057) escape sequence. |
7309 |
|
|
7310 |
|
</p> |
7311 |
|
</blockquote><p> |
7312 |
|
|
7313 |
|
</p> |
7314 |
|
<a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr /> |
7315 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7316 |
|
<a name="rfc.section.6.8.1"></a><h3>6.8.1. |
7317 |
|
Creating a new instrument directory</h3> |
7318 |
|
|
7319 |
|
<p>The front-end can add a new instrument directory to the |
7320 |
|
instruments database by sending the following command: |
7321 |
|
</p> |
7322 |
|
<p> |
7323 |
|
</p> |
7324 |
|
<blockquote class="text"> |
7325 |
|
<p>ADD DB_INSTRUMENT_DIRECTORY <dir> |
7326 |
|
</p> |
7327 |
|
</blockquote><p> |
7328 |
|
|
7329 |
|
</p> |
7330 |
|
<p>Where <dir> is the absolute path name of the directory |
7331 |
|
to be created (encapsulated into apostrophes). |
7332 |
|
</p> |
7333 |
|
<p>Possible Answers: |
7334 |
|
</p> |
7335 |
|
<p> |
7336 |
|
</p> |
7337 |
|
<blockquote class="text"> |
7338 |
|
<p>"OK" - |
7339 |
|
</p> |
7340 |
|
<blockquote class="text"> |
7341 |
|
<p>on success |
7342 |
|
</p> |
7343 |
|
</blockquote> |
7344 |
|
|
7345 |
|
|
7346 |
|
<p>"ERR:<error-code>:<error-message>" - |
7347 |
|
</p> |
7348 |
|
<blockquote class="text"> |
7349 |
|
<p>when the directory could not be created, which |
7350 |
|
can happen if the directory already exists or the |
7351 |
|
name contains not allowed symbols |
7352 |
|
</p> |
7353 |
|
</blockquote> |
7354 |
|
|
7355 |
|
|
7356 |
|
</blockquote><p> |
7357 |
|
|
7358 |
|
</p> |
7359 |
|
<p>Examples: |
7360 |
|
</p> |
7361 |
|
<p> |
7362 |
|
</p> |
7363 |
|
<blockquote class="text"> |
7364 |
|
<p>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'" |
7365 |
|
</p> |
7366 |
|
<p>S: "OK" |
7367 |
|
</p> |
7368 |
|
</blockquote><p> |
7369 |
|
|
7370 |
|
</p> |
7371 |
|
<a name="REMOVE DB_INSTRUMENT_DIRECTORY"></a><br /><hr /> |
7372 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7373 |
|
<a name="rfc.section.6.8.2"></a><h3>6.8.2. |
7374 |
|
Deleting an instrument directory</h3> |
7375 |
|
|
7376 |
|
<p>The front-end can delete a particular instrument directory |
7377 |
|
from the instruments database by sending the following command: |
7378 |
|
</p> |
7379 |
|
<p> |
7380 |
|
</p> |
7381 |
|
<blockquote class="text"> |
7382 |
|
<p>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir> |
7383 |
|
</p> |
7384 |
|
</blockquote><p> |
7385 |
|
|
7386 |
|
</p> |
7387 |
|
<p>Where <dir> is the absolute path name of the directory |
7388 |
|
to delete. The optional FORCE argument can be used to |
7389 |
|
force the deletion of a non-empty directory and all its content. |
7390 |
|
</p> |
7391 |
|
<p>Possible Answers: |
7392 |
|
</p> |
7393 |
|
<p> |
7394 |
|
</p> |
7395 |
|
<blockquote class="text"> |
7396 |
|
<p>"OK" - |
7397 |
|
</p> |
7398 |
|
<blockquote class="text"> |
7399 |
|
<p>if the directory is deleted successfully |
7400 |
|
</p> |
7401 |
|
</blockquote> |
7402 |
|
|
7403 |
|
|
7404 |
|
<p>"ERR:<error-code>:<error-message>" - |
7405 |
|
</p> |
7406 |
|
<blockquote class="text"> |
7407 |
|
<p>if the given directory does not exist, or |
7408 |
|
if trying to delete a non-empty directory, |
7409 |
|
without using the FORCE argument. |
7410 |
|
</p> |
7411 |
|
</blockquote> |
7412 |
|
|
7413 |
|
|
7414 |
|
</blockquote><p> |
7415 |
|
|
7416 |
|
</p> |
7417 |
|
<p>Examples: |
7418 |
|
</p> |
7419 |
|
<p> |
7420 |
|
</p> |
7421 |
|
<blockquote class="text"> |
7422 |
|
<p>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'" |
7423 |
|
</p> |
7424 |
|
<p>S: "OK" |
7425 |
|
</p> |
7426 |
|
</blockquote><p> |
7427 |
|
|
7428 |
|
</p> |
7429 |
|
<a name="GET DB_INSTRUMENT_DIRECTORIES"></a><br /><hr /> |
7430 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7431 |
|
<a name="rfc.section.6.8.3"></a><h3>6.8.3. |
7432 |
|
Getting amount of instrument directories</h3> |
7433 |
|
|
7434 |
|
<p>The front-end can retrieve the current amount of |
7435 |
|
directories in a specific directory by sending the following command: |
7436 |
|
</p> |
7437 |
|
<p> |
7438 |
|
</p> |
7439 |
|
<blockquote class="text"> |
7440 |
|
<p>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir> |
7441 |
|
</p> |
7442 |
|
</blockquote><p> |
7443 |
|
|
7444 |
|
</p> |
7445 |
|
<p>Where <dir> should be replaced by the absolute path |
7446 |
|
name of the directory. If RECURSIVE is specified, the number of |
7447 |
|
all directories, including those located in subdirectories of the |
7448 |
|
specified directory, will be returned. |
7449 |
|
</p> |
7450 |
|
<p>Possible Answers: |
7451 |
|
</p> |
7452 |
|
<p> |
7453 |
|
</p> |
7454 |
|
<blockquote class="text"> |
7455 |
|
<p>The current number of instrument directories |
7456 |
|
in the specified directory. |
7457 |
|
</p> |
7458 |
|
<p>"ERR:<error-code>:<error-message>" - |
7459 |
|
</p> |
7460 |
|
<blockquote class="text"> |
7461 |
|
<p>if the given directory does not exist. |
7462 |
|
</p> |
7463 |
|
</blockquote> |
7464 |
|
|
7465 |
|
|
7466 |
|
</blockquote><p> |
7467 |
|
|
7468 |
|
</p> |
7469 |
|
<p>Example: |
7470 |
|
</p> |
7471 |
|
<p> |
7472 |
|
</p> |
7473 |
|
<blockquote class="text"> |
7474 |
|
<p>C: "GET DB_INSTRUMENT_DIRECTORIES '/'" |
7475 |
|
</p> |
7476 |
|
<p>S: "2" |
7477 |
|
</p> |
7478 |
|
</blockquote><p> |
7479 |
|
|
7480 |
|
</p> |
7481 |
|
<a name="LIST DB_INSTRUMENT_DIRECTORIES"></a><br /><hr /> |
7482 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7483 |
|
<a name="rfc.section.6.8.4"></a><h3>6.8.4. |
7484 |
|
Listing all directories in specific directory</h3> |
7485 |
|
|
7486 |
|
<p>The front-end can retrieve the current list of directories |
7487 |
|
in specific directory by sending the following command: |
7488 |
|
</p> |
7489 |
|
<p> |
7490 |
|
</p> |
7491 |
|
<blockquote class="text"> |
7492 |
|
<p>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir> |
7493 |
|
</p> |
7494 |
|
</blockquote><p> |
7495 |
|
|
7496 |
|
</p> |
7497 |
|
<p>Where <dir> should be replaced by the absolute path |
7498 |
|
name of the directory. If RECURSIVE is specified, the absolute path names |
7499 |
|
of all directories, including those located in subdirectories of the |
7500 |
|
specified directory, will be returned. |
7501 |
|
</p> |
7502 |
|
<p>Possible Answers: |
7503 |
|
</p> |
7504 |
|
<p> |
7505 |
|
</p> |
7506 |
|
<blockquote class="text"> |
7507 |
|
<p>A comma separated list of all instrument directories |
7508 |
|
(encapsulated into apostrophes) in the specified directory. |
7509 |
|
</p> |
7510 |
|
<p>"ERR:<error-code>:<error-message>" - |
7511 |
|
</p> |
7512 |
|
<blockquote class="text"> |
7513 |
|
<p>if the given directory does not exist. |
7514 |
|
</p> |
7515 |
|
</blockquote> |
7516 |
|
|
7517 |
|
|
7518 |
|
</blockquote><p> |
7519 |
|
|
7520 |
|
</p> |
7521 |
|
<p>Example: |
7522 |
|
</p> |
7523 |
|
<p> |
7524 |
|
</p> |
7525 |
|
<blockquote class="text"> |
7526 |
|
<p>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'" |
7527 |
|
</p> |
7528 |
|
<p>S: "'Piano Collection','Percussion Collection'" |
7529 |
|
</p> |
7530 |
|
</blockquote><p> |
7531 |
|
|
7532 |
|
</p> |
7533 |
|
<p> |
7534 |
|
</p> |
7535 |
|
<blockquote class="text"> |
7536 |
|
<p>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'" |
7537 |
|
</p> |
7538 |
|
<p>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'" |
7539 |
|
</p> |
7540 |
|
</blockquote><p> |
7541 |
|
|
7542 |
|
</p> |
7543 |
|
<a name="GET DB_INSTRUMENT_DIRECTORY INFO"></a><br /><hr /> |
7544 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7545 |
|
<a name="rfc.section.6.8.5"></a><h3>6.8.5. |
7546 |
|
Getting instrument directory information</h3> |
7547 |
|
|
7548 |
|
<p>The front-end can ask for the current settings of an |
7549 |
|
instrument directory by sending the following command: |
7550 |
|
</p> |
7551 |
|
<p> |
7552 |
|
</p> |
7553 |
|
<blockquote class="text"> |
7554 |
|
<p>GET DB_INSTRUMENT_DIRECTORY INFO <dir> |
7555 |
|
</p> |
7556 |
|
</blockquote><p> |
7557 |
|
|
7558 |
|
</p> |
7559 |
|
<p>Where <dir> should be replaced by the absolute path |
7560 |
|
name of the directory the front-end is interested in. |
7561 |
|
</p> |
7562 |
|
<p>Possible Answers: |
7563 |
|
</p> |
7564 |
|
<p> |
7565 |
|
</p> |
7566 |
|
<blockquote class="text"> |
7567 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
7568 |
|
Each answer line begins with the settings category name |
7569 |
|
followed by a colon and then a space character <SP> and finally |
7570 |
|
the info character string to that setting category. At the |
7571 |
|
moment the following categories are defined: |
7572 |
|
</p> |
7573 |
|
<p> |
7574 |
|
</p> |
7575 |
|
<blockquote class="text"> |
7576 |
|
<p>DESCRIPTION - |
7577 |
|
</p> |
7578 |
|
<blockquote class="text"> |
7579 |
|
<p>A brief description of the directory content. |
7580 |
|
Note that the character string may contain |
7581 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
7582 |
|
</p> |
7583 |
|
</blockquote> |
7584 |
|
|
7585 |
|
|
7586 |
|
<p>CREATED - |
7587 |
|
</p> |
7588 |
|
<blockquote class="text"> |
7589 |
|
<p>The creation date and time of the directory, |
7590 |
|
represented in "YYYY-MM-DD HH:MM:SS" format |
7591 |
|
</p> |
7592 |
|
</blockquote> |
7593 |
|
|
7594 |
|
|
7595 |
|
<p>MODIFIED - |
7596 |
|
</p> |
7597 |
|
<blockquote class="text"> |
7598 |
|
<p>The date and time of the last modification of the |
7599 |
|
directory, represented in "YYYY-MM-DD HH:MM:SS" format |
7600 |
|
</p> |
7601 |
|
</blockquote> |
7602 |
|
|
7603 |
|
|
7604 |
|
</blockquote> |
7605 |
|
|
7606 |
|
|
7607 |
|
</blockquote><p> |
7608 |
|
|
7609 |
|
</p> |
7610 |
|
<p>The mentioned fields above don't have to be in particular order. |
7611 |
|
</p> |
7612 |
|
<p>Example: |
7613 |
|
</p> |
7614 |
|
<p> |
7615 |
|
</p> |
7616 |
|
<blockquote class="text"> |
7617 |
|
<p>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'" |
7618 |
|
</p> |
7619 |
|
<p>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format." |
7620 |
|
</p> |
7621 |
|
<p> "CREATED: 2007-02-05 10:23:12" |
7622 |
|
</p> |
7623 |
|
<p> "MODIFIED: 2007-04-07 12:50:21" |
7624 |
|
</p> |
7625 |
|
<p> "." |
7626 |
|
</p> |
7627 |
|
</blockquote><p> |
7628 |
|
|
7629 |
|
</p> |
7630 |
|
<a name="SET DB_INSTRUMENT_DIRECTORY NAME"></a><br /><hr /> |
7631 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7632 |
|
<a name="rfc.section.6.8.6"></a><h3>6.8.6. |
7633 |
|
Renaming an instrument directory</h3> |
7634 |
|
|
7635 |
|
<p>The front-end can alter the name of a specific |
7636 |
|
instrument directory by sending the following command: |
7637 |
|
</p> |
7638 |
|
<p> |
7639 |
|
</p> |
7640 |
|
<blockquote class="text"> |
7641 |
|
<p>SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name> |
7642 |
|
</p> |
7643 |
|
</blockquote><p> |
7644 |
|
|
7645 |
|
</p> |
7646 |
|
<p>Where <dir> is the absolute path name of the directory and |
7647 |
|
<name> is the new name for that directory. |
7648 |
|
</p> |
7649 |
|
<p>Possible Answers: |
7650 |
|
</p> |
7651 |
|
<p> |
7652 |
|
</p> |
7653 |
|
<blockquote class="text"> |
7654 |
|
<p>"OK" - |
7655 |
|
</p> |
7656 |
|
<blockquote class="text"> |
7657 |
|
<p>on success |
7658 |
|
</p> |
7659 |
|
</blockquote> |
7660 |
|
|
7661 |
|
|
7662 |
|
<p>"ERR:<error-code>:<error-message>" - |
7663 |
|
</p> |
7664 |
|
<blockquote class="text"> |
7665 |
|
<p>in case the given directory does not exists, |
7666 |
|
or if a directory with name equal to the new |
7667 |
|
name already exists. |
7668 |
|
</p> |
7669 |
|
</blockquote> |
7670 |
|
|
7671 |
|
|
7672 |
|
</blockquote><p> |
7673 |
|
|
7674 |
|
</p> |
7675 |
|
<p>Example: |
7676 |
|
</p> |
7677 |
|
<p> |
7678 |
|
</p> |
7679 |
|
<blockquote class="text"> |
7680 |
|
<p>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'" |
7681 |
|
</p> |
7682 |
|
<p>S: "OK" |
7683 |
|
</p> |
7684 |
|
</blockquote><p> |
7685 |
|
|
7686 |
|
</p> |
7687 |
|
<a name="MOVE DB_INSTRUMENT_DIRECTORY"></a><br /><hr /> |
7688 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7689 |
|
<a name="rfc.section.6.8.7"></a><h3>6.8.7. |
7690 |
|
Moving an instrument directory</h3> |
7691 |
|
|
7692 |
|
<p>The front-end can move a specific |
7693 |
|
instrument directory by sending the following command: |
7694 |
|
</p> |
7695 |
|
<p> |
7696 |
|
</p> |
7697 |
|
<blockquote class="text"> |
7698 |
|
<p>MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst> |
7699 |
|
</p> |
7700 |
|
</blockquote><p> |
7701 |
|
|
7702 |
|
</p> |
7703 |
|
<p>Where <dir> is the absolute path name of the directory |
7704 |
|
to move and <dst> is the location where the directory will |
7705 |
|
be moved to. |
7706 |
|
</p> |
7707 |
|
<p>Possible Answers: |
7708 |
|
</p> |
7709 |
|
<p> |
7710 |
|
</p> |
7711 |
|
<blockquote class="text"> |
7712 |
|
<p>"OK" - |
7713 |
|
</p> |
7714 |
|
<blockquote class="text"> |
7715 |
|
<p>on success |
7716 |
|
</p> |
7717 |
|
</blockquote> |
7718 |
|
|
7719 |
|
|
7720 |
|
<p>"ERR:<error-code>:<error-message>" - |
7721 |
|
</p> |
7722 |
|
<blockquote class="text"> |
7723 |
|
<p>in case a given directory does not exists, |
7724 |
|
or if a directory with name equal to the name |
7725 |
|
of the specified directory already exists in |
7726 |
|
the destination directory. Error is also thrown |
7727 |
|
when trying to move a directory to a subdirectory |
7728 |
|
of itself. |
7729 |
|
</p> |
7730 |
|
</blockquote> |
7731 |
|
|
7732 |
|
|
7733 |
|
</blockquote><p> |
7734 |
|
|
7735 |
|
</p> |
7736 |
|
<p>Example: |
7737 |
|
</p> |
7738 |
|
<p> |
7739 |
|
</p> |
7740 |
|
<blockquote class="text"> |
7741 |
|
<p>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'" |
7742 |
|
</p> |
7743 |
|
<p>S: "OK" |
7744 |
|
</p> |
7745 |
|
</blockquote><p> |
7746 |
|
|
7747 |
|
</p> |
7748 |
|
<a name="COPY DB_INSTRUMENT_DIRECTORY"></a><br /><hr /> |
7749 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7750 |
|
<a name="rfc.section.6.8.8"></a><h3>6.8.8. |
7751 |
|
Copying instrument directories</h3> |
7752 |
|
|
7753 |
|
<p>The front-end can copy a specific |
7754 |
|
instrument directory by sending the following command: |
7755 |
|
</p> |
7756 |
|
<p> |
7757 |
|
</p> |
7758 |
|
<blockquote class="text"> |
7759 |
|
<p>COPY DB_INSTRUMENT_DIRECTORY <dir> <dst> |
7760 |
|
</p> |
7761 |
|
</blockquote><p> |
7762 |
|
|
7763 |
|
</p> |
7764 |
|
<p>Where <dir> is the absolute path name of the directory |
7765 |
|
to copy and <dst> is the location where the directory will |
7766 |
|
be copied to. |
7767 |
|
</p> |
7768 |
|
<p>Possible Answers: |
7769 |
|
</p> |
7770 |
|
<p> |
7771 |
|
</p> |
7772 |
|
<blockquote class="text"> |
7773 |
|
<p>"OK" - |
7774 |
|
</p> |
7775 |
|
<blockquote class="text"> |
7776 |
|
<p>on success |
7777 |
|
</p> |
7778 |
|
</blockquote> |
7779 |
|
|
7780 |
|
|
7781 |
|
<p>"ERR:<error-code>:<error-message>" - |
7782 |
|
</p> |
7783 |
|
<blockquote class="text"> |
7784 |
|
<p>in case a given directory does not exists, |
7785 |
|
or if a directory with name equal to the name |
7786 |
|
of the specified directory already exists in |
7787 |
|
the destination directory. Error is also thrown |
7788 |
|
when trying to copy a directory to a subdirectory |
7789 |
|
of itself. |
7790 |
|
</p> |
7791 |
|
</blockquote> |
7792 |
|
|
7793 |
|
|
7794 |
|
</blockquote><p> |
7795 |
|
|
7796 |
|
</p> |
7797 |
|
<p>Example: |
7798 |
|
</p> |
7799 |
|
<p> |
7800 |
|
</p> |
7801 |
|
<blockquote class="text"> |
7802 |
|
<p>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'" |
7803 |
|
</p> |
7804 |
|
<p>S: "OK" |
7805 |
|
</p> |
7806 |
|
</blockquote><p> |
7807 |
|
|
7808 |
|
</p> |
7809 |
|
<a name="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"></a><br /><hr /> |
7810 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7811 |
|
<a name="rfc.section.6.8.9"></a><h3>6.8.9. |
7812 |
|
Changing the description of directory</h3> |
7813 |
|
|
7814 |
|
<p>The front-end can alter the description of a specific |
7815 |
|
instrument directory by sending the following command: |
7816 |
|
</p> |
7817 |
|
<p> |
7818 |
|
</p> |
7819 |
|
<blockquote class="text"> |
7820 |
|
<p>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc> |
7821 |
|
</p> |
7822 |
|
</blockquote><p> |
7823 |
|
|
7824 |
|
</p> |
7825 |
|
<p>Where <dir> is the absolute path name of the directory and |
7826 |
|
<desc> is the new description for the directory |
7827 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
7828 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
7829 |
|
</p> |
7830 |
|
<p>Possible Answers: |
7831 |
|
</p> |
7832 |
|
<p> |
7833 |
|
</p> |
7834 |
|
<blockquote class="text"> |
7835 |
|
<p>"OK" - |
7836 |
|
</p> |
7837 |
|
<blockquote class="text"> |
7838 |
|
<p>on success |
7839 |
|
</p> |
7840 |
|
</blockquote> |
7841 |
|
|
7842 |
|
|
7843 |
|
<p>"ERR:<error-code>:<error-message>" - |
7844 |
|
</p> |
7845 |
|
<blockquote class="text"> |
7846 |
|
<p>in case the given directory does not exists. |
7847 |
|
</p> |
7848 |
|
</blockquote> |
7849 |
|
|
7850 |
|
|
7851 |
|
</blockquote><p> |
7852 |
|
|
7853 |
|
</p> |
7854 |
|
<p>Example: |
7855 |
|
</p> |
7856 |
|
<p> |
7857 |
|
</p> |
7858 |
|
<blockquote class="text"> |
7859 |
|
<p>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'" |
7860 |
|
</p> |
7861 |
|
<p>S: "OK" |
7862 |
|
</p> |
7863 |
|
</blockquote><p> |
7864 |
|
|
7865 |
|
</p> |
7866 |
|
<a name="FIND DB_INSTRUMENT_DIRECTORIES"></a><br /><hr /> |
7867 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7868 |
|
<a name="rfc.section.6.8.10"></a><h3>6.8.10. |
7869 |
|
Finding directories</h3> |
7870 |
|
|
7871 |
|
<p>The front-end can search for directories |
7872 |
|
in specific directory by sending the following command: |
7873 |
|
</p> |
7874 |
|
<p> |
7875 |
|
</p> |
7876 |
|
<blockquote class="text"> |
7877 |
|
<p>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] <dir> <criteria-list> |
7878 |
|
</p> |
7879 |
|
</blockquote><p> |
7880 |
|
|
7881 |
|
</p> |
7882 |
|
<p>Where <dir> should be replaced by the absolute path |
7883 |
|
name of the directory to search in. If NON_RECURSIVE is specified, the |
7884 |
|
directories located in subdirectories of the specified directory will not |
7885 |
|
be searched. <criteria-list> is a list of search criterias |
7886 |
|
in form of "key1=val1 key2=val2 ...". The following criterias are |
7887 |
|
allowed: |
7888 |
|
</p> |
7889 |
|
<p> |
7890 |
|
|
7891 |
|
<p>NAME='<search-string>' |
7892 |
|
</p> |
7893 |
|
<blockquote class="text"> |
7894 |
|
<p>Restricts the search to directories, which names |
7895 |
|
satisfy the supplied search string (encapsulated into apostrophes, |
7896 |
|
supporting escape sequences as described in chapter |
7897 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
7898 |
|
</p> |
7899 |
|
</blockquote><p> |
7900 |
|
|
7901 |
|
</p> |
7902 |
|
|
7903 |
|
|
7904 |
|
<p>CREATED='[<date-after>]..[<date-before>]' |
7905 |
|
</p> |
7906 |
|
<blockquote class="text"> |
7907 |
|
<p>Restricts the search to directories, which creation |
7908 |
|
date satisfies the specified period, where <date-after> |
7909 |
|
and <date-before> are in "YYYY-MM-DD HH:MM:SS" format. |
7910 |
|
If <date-after> is omitted the search is restricted to |
7911 |
|
directories created before <date-before>. If |
7912 |
|
<date-before> is omitted, the search is restricted |
7913 |
|
to directories created after <date-after>. |
7914 |
|
</p> |
7915 |
|
</blockquote><p> |
7916 |
|
|
7917 |
|
</p> |
7918 |
|
|
7919 |
|
|
7920 |
|
<p>MODIFIED='[<date-after>]..[<date-before>]' |
7921 |
|
</p> |
7922 |
|
<blockquote class="text"> |
7923 |
|
<p>Restricts the search to directories, which |
7924 |
|
date of last modification satisfies the specified period, where |
7925 |
|
<date-after> and <date-before> are in "YYYY-MM-DD HH:MM:SS" |
7926 |
|
format. If <date-after> is omitted the search is restricted to |
7927 |
|
directories, which are last modified before <date-before>. If |
7928 |
|
<date-before> is omitted, the search is restricted to directories, |
7929 |
|
which are last modified after <date-after>. |
7930 |
|
</p> |
7931 |
|
</blockquote><p> |
7932 |
|
|
7933 |
|
</p> |
7934 |
|
|
7935 |
|
|
7936 |
|
<p>DESCRIPTION='<search-string>' |
7937 |
|
</p> |
7938 |
|
<blockquote class="text"> |
7939 |
|
<p>Restricts the search to directories with description |
7940 |
|
that satisfies the supplied search string |
7941 |
|
(encapsulated into apostrophes, supporting escape |
7942 |
|
sequences as described in chapter |
7943 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
7944 |
|
</p> |
7945 |
|
</blockquote><p> |
7946 |
|
|
7947 |
|
</p> |
7948 |
|
|
7949 |
|
|
7950 |
|
<p>Where <search-string> is either a regular expression, or a |
7951 |
|
word list separated with spaces for OR search and with '+' for AND search. |
7952 |
|
</p> |
7953 |
|
<p>Possible Answers: |
7954 |
|
</p> |
7955 |
|
<p> |
7956 |
|
</p> |
7957 |
|
<blockquote class="text"> |
7958 |
|
<p>A comma separated list with the absolute path names (encapsulated into |
7959 |
|
apostrophes) of all directories in the specified directory that satisfy |
7960 |
|
the supplied search criterias. |
7961 |
|
</p> |
7962 |
|
<p>"ERR:<error-code>:<error-message>" - |
7963 |
|
</p> |
7964 |
|
<blockquote class="text"> |
7965 |
|
<p>if the given directory does not exist. |
7966 |
|
</p> |
7967 |
|
</blockquote> |
7968 |
|
|
7969 |
|
|
7970 |
|
</blockquote><p> |
7971 |
|
|
7972 |
|
</p> |
7973 |
|
<p>Example: |
7974 |
|
</p> |
7975 |
|
<p> |
7976 |
|
</p> |
7977 |
|
<blockquote class="text"> |
7978 |
|
<p>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'" |
7979 |
|
</p> |
7980 |
|
<p>S: "'/Piano Collection'" |
7981 |
|
</p> |
7982 |
|
</blockquote><p> |
7983 |
|
|
7984 |
|
</p> |
7985 |
|
<p> |
7986 |
|
</p> |
7987 |
|
<blockquote class="text"> |
7988 |
|
<p>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'" |
7989 |
|
</p> |
7990 |
|
<p>S: "'/Piano Collection','/Percussions'" |
7991 |
|
</p> |
7992 |
|
</blockquote><p> |
7993 |
|
|
7994 |
|
</p> |
7995 |
|
<a name="ADD DB_INSTRUMENTS"></a><br /><hr /> |
7996 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
7997 |
|
<a name="rfc.section.6.8.11"></a><h3>6.8.11. |
7998 |
|
Adding instruments to the instruments database</h3> |
7999 |
|
|
8000 |
|
<p>The front-end can add one or more instruments |
8001 |
|
to the instruments database by sending the following command: |
8002 |
|
</p> |
8003 |
|
<p> |
8004 |
|
</p> |
8005 |
|
<blockquote class="text"> |
8006 |
|
<p>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path> [<instr_index>] |
8007 |
|
</p> |
8008 |
|
</blockquote><p> |
8009 |
|
|
8010 |
|
</p> |
8011 |
|
<p>Where <db_dir> is the absolute path name of a directory |
8012 |
|
(encapsulated into apostrophes) in the instruments database in which |
8013 |
|
only the new instruments (that are not already in the database) will |
8014 |
|
be added, <file_path> is the absolute path name of a file or |
8015 |
|
directory in the file system (encapsulated into apostrophes). In case |
8016 |
|
an instrument file is supplied, only the instruments in the specified |
8017 |
|
file will be added to the instruments database. If the optional |
8018 |
|
<instr_index> (the index of the instrument within the given file) |
8019 |
|
is supplied too, then only the specified instrument will be added. |
8020 |
|
In case a directory is supplied, the instruments in that directory |
8021 |
|
will be added. The OPTIONAL <mode> argument is only applied |
8022 |
|
when a directory is provided as <file_path> and specifies how the |
8023 |
|
scanning will be done and has exactly the following possibilities: |
8024 |
|
</p> |
8025 |
|
<p> |
8026 |
|
</p> |
8027 |
|
<blockquote class="text"> |
8028 |
|
<p>"RECURSIVE" - |
8029 |
|
</p> |
8030 |
|
<blockquote class="text"> |
8031 |
|
<p>All instruments will be processed, including those |
8032 |
|
in the subdirectories, and the respective subdirectory |
8033 |
|
tree structure will be recreated in the instruments |
8034 |
|
database |
8035 |
|
</p> |
8036 |
|
</blockquote> |
8037 |
|
|
8038 |
|
|
8039 |
|
<p>"NON_RECURSIVE" - |
8040 |
|
</p> |
8041 |
|
<blockquote class="text"> |
8042 |
|
<p>Only the instruments in the specified directory |
8043 |
|
will be added, the instruments in the subdirectories |
8044 |
|
will not be processed. |
8045 |
|
</p> |
8046 |
|
</blockquote> |
8047 |
|
|
8048 |
|
|
8049 |
|
<p>"FLAT" - |
8050 |
|
</p> |
8051 |
|
<blockquote class="text"> |
8052 |
|
<p>All instruments will be processed, including those |
8053 |
|
in the subdirectories, but the respective subdirectory |
8054 |
|
structure will not be recreated in the instruments |
8055 |
|
database. All instruments will be added directly in |
8056 |
|
the specified database directory. |
8057 |
|
</p> |
8058 |
|
</blockquote> |
8059 |
|
|
8060 |
|
|
8061 |
|
</blockquote><p> |
8062 |
|
|
8063 |
|
</p> |
8064 |
|
<p>The difference between regular and NON_MODAL versions of the command |
8065 |
|
is that the regular command returns when the scanning is finished |
8066 |
|
while NON_MODAL version returns immediately and a background process is launched. |
8067 |
|
The <a class='info' href='#GET DB_INSTRUMENTS_JOB INFO'>GET DB_INSTRUMENTS_JOB INFO<span> (</span><span class='info'>Getting job status information</span><span>)</span></a> |
8068 |
|
command can be used to monitor the scanning progress. |
8069 |
|
</p> |
8070 |
|
<p>Possible Answers: |
8071 |
|
</p> |
8072 |
|
<p> |
8073 |
|
</p> |
8074 |
|
<blockquote class="text"> |
8075 |
|
<p>"OK" - |
8076 |
|
</p> |
8077 |
|
<blockquote class="text"> |
8078 |
|
<p>on success when NON_MODAL is not supplied |
8079 |
|
</p> |
8080 |
|
</blockquote> |
8081 |
|
|
8082 |
|
|
8083 |
|
<p>"OK[<job-id>]" - |
8084 |
|
</p> |
8085 |
|
<blockquote class="text"> |
8086 |
|
<p>on success when NON_MODAL is supplied, where <job-id> |
8087 |
|
is a numerical ID used to obtain status information about the job progress. |
8088 |
|
See <a class='info' href='#GET DB_INSTRUMENTS_JOB INFO'>GET DB_INSTRUMENTS_JOB INFO<span> (</span><span class='info'>Getting job status information</span><span>)</span></a> |
8089 |
|
|
8090 |
|
</p> |
8091 |
|
</blockquote> |
8092 |
|
|
8093 |
|
|
8094 |
|
<p>"ERR:<error-code>:<error-message>" - |
8095 |
|
</p> |
8096 |
|
<blockquote class="text"> |
8097 |
|
<p>if an invalid path is specified. |
8098 |
|
</p> |
8099 |
|
</blockquote> |
8100 |
|
|
8101 |
|
|
8102 |
|
</blockquote><p> |
8103 |
|
|
8104 |
|
</p> |
8105 |
|
<p>Examples: |
8106 |
|
</p> |
8107 |
|
<p> |
8108 |
|
</p> |
8109 |
|
<blockquote class="text"> |
8110 |
|
<p>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0" |
8111 |
|
</p> |
8112 |
|
<p>S: "OK" |
8113 |
|
</p> |
8114 |
|
</blockquote><p> |
8115 |
|
|
8116 |
|
</p> |
8117 |
|
<a name="REMOVE DB_INSTRUMENT"></a><br /><hr /> |
8118 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8119 |
|
<a name="rfc.section.6.8.12"></a><h3>6.8.12. |
8120 |
|
Removing an instrument</h3> |
8121 |
|
|
8122 |
|
<p>The front-end can remove a particular instrument |
8123 |
|
from the instruments database by sending the following command: |
8124 |
|
</p> |
8125 |
|
<p> |
8126 |
|
</p> |
8127 |
|
<blockquote class="text"> |
8128 |
|
<p>REMOVE DB_INSTRUMENT <instr_path> |
8129 |
|
</p> |
8130 |
|
</blockquote><p> |
8131 |
|
|
8132 |
|
</p> |
8133 |
|
<p>Where <instr_path> is the absolute path name |
8134 |
|
(in the instruments database) of the instrument to remove. |
8135 |
|
</p> |
8136 |
|
<p>Possible Answers: |
8137 |
|
</p> |
8138 |
|
<p> |
8139 |
|
</p> |
8140 |
|
<blockquote class="text"> |
8141 |
|
<p>"OK" - |
8142 |
|
</p> |
8143 |
|
<blockquote class="text"> |
8144 |
|
<p>if the instrument is removed successfully |
8145 |
|
</p> |
8146 |
|
</blockquote> |
8147 |
|
|
8148 |
|
|
8149 |
|
<p>"ERR:<error-code>:<error-message>" - |
8150 |
|
</p> |
8151 |
|
<blockquote class="text"> |
8152 |
|
<p>if the given path does not exist or |
8153 |
|
is a directory. |
8154 |
|
</p> |
8155 |
|
</blockquote> |
8156 |
|
|
8157 |
|
|
8158 |
|
</blockquote><p> |
8159 |
|
|
8160 |
|
</p> |
8161 |
|
<p>Examples: |
8162 |
|
</p> |
8163 |
|
<p> |
8164 |
|
</p> |
8165 |
|
<blockquote class="text"> |
8166 |
|
<p>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'" |
8167 |
|
</p> |
8168 |
|
<p>S: "OK" |
8169 |
|
</p> |
8170 |
|
</blockquote><p> |
8171 |
|
|
8172 |
|
</p> |
8173 |
|
<a name="GET DB_INSTRUMENTS"></a><br /><hr /> |
8174 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8175 |
|
<a name="rfc.section.6.8.13"></a><h3>6.8.13. |
8176 |
|
Getting amount of instruments</h3> |
8177 |
|
|
8178 |
|
<p>The front-end can retrieve the current amount of |
8179 |
|
instruments in a specific directory by sending the following command: |
8180 |
|
</p> |
8181 |
|
<p> |
8182 |
|
</p> |
8183 |
|
<blockquote class="text"> |
8184 |
|
<p>GET DB_INSTRUMENTS [RECURSIVE] <dir> |
8185 |
|
</p> |
8186 |
|
</blockquote><p> |
8187 |
|
|
8188 |
|
</p> |
8189 |
|
<p>Where <dir> should be replaced by the absolute path name |
8190 |
|
of the directory. If RECURSIVE is specified, the number of all |
8191 |
|
instruments, including those located in subdirectories of the |
8192 |
|
specified directory, will be returned. |
8193 |
|
</p> |
8194 |
|
<p>Possible Answers: |
8195 |
|
</p> |
8196 |
|
<p> |
8197 |
|
</p> |
8198 |
|
<blockquote class="text"> |
8199 |
|
<p>The current number of instruments |
8200 |
|
in the specified directory. |
8201 |
|
</p> |
8202 |
|
<p>"ERR:<error-code>:<error-message>" - |
8203 |
|
</p> |
8204 |
|
<blockquote class="text"> |
8205 |
|
<p>if the given directory does not exist. |
8206 |
|
</p> |
8207 |
|
</blockquote> |
8208 |
|
|
8209 |
|
|
8210 |
|
</blockquote><p> |
8211 |
|
|
8212 |
|
</p> |
8213 |
|
<p>Example: |
8214 |
|
</p> |
8215 |
|
<p> |
8216 |
|
</p> |
8217 |
|
<blockquote class="text"> |
8218 |
|
<p>C: "GET DB_INSTRUMENTS '/Piano Collection'" |
8219 |
|
</p> |
8220 |
|
<p>S: "2" |
8221 |
|
</p> |
8222 |
|
</blockquote><p> |
8223 |
|
|
8224 |
|
</p> |
8225 |
|
<a name="LIST DB_INSTRUMENTS"></a><br /><hr /> |
8226 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8227 |
|
<a name="rfc.section.6.8.14"></a><h3>6.8.14. |
8228 |
|
Listing all instruments in specific directory</h3> |
8229 |
|
|
8230 |
|
<p>The front-end can retrieve the current list of instruments |
8231 |
|
in specific directory by sending the following command: |
8232 |
|
</p> |
8233 |
|
<p> |
8234 |
|
</p> |
8235 |
|
<blockquote class="text"> |
8236 |
|
<p>LIST DB_INSTRUMENTS [RECURSIVE] <dir> |
8237 |
|
</p> |
8238 |
|
</blockquote><p> |
8239 |
|
|
8240 |
|
</p> |
8241 |
|
<p>Where <dir> should be replaced by the absolute path |
8242 |
|
name of the directory. If RECURSIVE is specified, the absolute path |
8243 |
|
names of all instruments, including those located in subdirectories |
8244 |
|
of the specified directory, will be returned. |
8245 |
|
</p> |
8246 |
|
<p>Possible Answers: |
8247 |
|
</p> |
8248 |
|
<p> |
8249 |
|
</p> |
8250 |
|
<blockquote class="text"> |
8251 |
|
<p>A comma separated list of all instruments |
8252 |
|
(encapsulated into apostrophes) in the specified directory. |
8253 |
|
</p> |
8254 |
|
<p>"ERR:<error-code>:<error-message>" - |
8255 |
|
</p> |
8256 |
|
<blockquote class="text"> |
8257 |
|
<p>if the given directory does not exist. |
8258 |
|
</p> |
8259 |
|
</blockquote> |
8260 |
|
|
8261 |
|
|
8262 |
|
</blockquote><p> |
8263 |
|
|
8264 |
|
</p> |
8265 |
|
<p>Example: |
8266 |
|
</p> |
8267 |
|
<p> |
8268 |
|
</p> |
8269 |
|
<blockquote class="text"> |
8270 |
|
<p>C: "LIST DB_INSTRUMENTS '/Piano Collection'" |
8271 |
|
</p> |
8272 |
|
<p>S: "'Bosendorfer 290','Steinway D'" |
8273 |
|
</p> |
8274 |
|
</blockquote><p> |
8275 |
|
|
8276 |
|
</p> |
8277 |
|
<p> |
8278 |
|
</p> |
8279 |
|
<blockquote class="text"> |
8280 |
|
<p>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'" |
8281 |
|
</p> |
8282 |
|
<p>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'" |
8283 |
|
</p> |
8284 |
|
</blockquote><p> |
8285 |
|
|
8286 |
|
</p> |
8287 |
|
<a name="GET DB_INSTRUMENT INFO"></a><br /><hr /> |
8288 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8289 |
|
<a name="rfc.section.6.8.15"></a><h3>6.8.15. |
8290 |
|
Getting instrument information</h3> |
8291 |
|
|
8292 |
|
<p>The front-end can ask for the current settings of an |
8293 |
|
instrument by sending the following command: |
8294 |
|
</p> |
8295 |
|
<p> |
8296 |
|
</p> |
8297 |
|
<blockquote class="text"> |
8298 |
|
<p>GET DB_INSTRUMENT INFO <instr_path> |
8299 |
|
</p> |
8300 |
|
</blockquote><p> |
8301 |
|
|
8302 |
|
</p> |
8303 |
|
<p>Where <instr_path> should be replaced by the absolute path |
8304 |
|
name of the instrument the front-end is interested in. |
8305 |
|
</p> |
8306 |
|
<p>Possible Answers: |
8307 |
|
</p> |
8308 |
|
<p> |
8309 |
|
</p> |
8310 |
|
<blockquote class="text"> |
8311 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
8312 |
|
Each answer line begins with the settings category name |
8313 |
|
followed by a colon and then a space character <SP> and finally |
8314 |
|
the info character string to that setting category. At the |
8315 |
|
moment the following categories are defined: |
8316 |
|
</p> |
8317 |
|
<p> |
8318 |
|
</p> |
8319 |
|
<blockquote class="text"> |
8320 |
|
<p>INSTRUMENT_FILE - |
8321 |
|
</p> |
8322 |
|
<blockquote class="text"> |
8323 |
|
<p>File name of the instrument. |
8324 |
|
Note that the character string may contain |
8325 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
8326 |
|
</p> |
8327 |
|
</blockquote> |
8328 |
|
|
8329 |
|
|
8330 |
|
<p>INSTRUMENT_NR - |
8331 |
|
</p> |
8332 |
|
<blockquote class="text"> |
8333 |
|
<p>Index of the instrument within the file. |
8334 |
|
</p> |
8335 |
|
</blockquote> |
8336 |
|
|
8337 |
|
|
8338 |
|
<p>FORMAT_FAMILY - |
8339 |
|
</p> |
8340 |
|
<blockquote class="text"> |
8341 |
|
<p>The format family of the instrument. |
8342 |
|
</p> |
8343 |
|
</blockquote> |
8344 |
|
|
8345 |
|
|
8346 |
|
<p>FORMAT_VERSION - |
8347 |
|
</p> |
8348 |
|
<blockquote class="text"> |
8349 |
|
<p>The format version of the instrument. |
8350 |
|
</p> |
8351 |
|
</blockquote> |
8352 |
|
|
8353 |
|
|
8354 |
|
<p>SIZE - |
8355 |
|
</p> |
8356 |
|
<blockquote class="text"> |
8357 |
|
<p>The size of the instrument in bytes. |
8358 |
|
</p> |
8359 |
|
</blockquote> |
8360 |
|
|
8361 |
|
|
8362 |
|
<p>CREATED - |
8363 |
|
</p> |
8364 |
|
<blockquote class="text"> |
8365 |
|
<p>The date and time when the instrument is added |
8366 |
|
in the instruments database, represented in |
8367 |
|
"YYYY-MM-DD HH:MM:SS" format |
8368 |
|
</p> |
8369 |
|
</blockquote> |
8370 |
|
|
8371 |
|
|
8372 |
|
<p>MODIFIED - |
8373 |
|
</p> |
8374 |
|
<blockquote class="text"> |
8375 |
|
<p>The date and time of the last modification of the |
8376 |
|
instrument's database settings, represented in |
8377 |
|
"YYYY-MM-DD HH:MM:SS" format |
8378 |
|
</p> |
8379 |
|
</blockquote> |
8380 |
|
|
8381 |
|
|
8382 |
|
<p>DESCRIPTION - |
8383 |
|
</p> |
8384 |
|
<blockquote class="text"> |
8385 |
|
<p>A brief description of the instrument. |
8386 |
|
Note that the character string may contain |
8387 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
8388 |
|
</p> |
8389 |
|
</blockquote> |
8390 |
|
|
8391 |
|
|
8392 |
|
<p>IS_DRUM - |
8393 |
|
</p> |
8394 |
|
<blockquote class="text"> |
8395 |
|
<p>either true or false, determines whether the |
8396 |
|
instrument is a drumkit or a chromatic instrument |
8397 |
|
</p> |
8398 |
|
</blockquote> |
8399 |
|
|
8400 |
|
|
8401 |
|
<p>PRODUCT - |
8402 |
|
</p> |
8403 |
|
<blockquote class="text"> |
8404 |
|
<p>The product title of the instrument. |
8405 |
|
Note that the character string may contain |
8406 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
8407 |
|
</p> |
8408 |
|
</blockquote> |
8409 |
|
|
8410 |
|
|
8411 |
|
<p>ARTISTS - |
8412 |
|
</p> |
8413 |
|
<blockquote class="text"> |
8414 |
|
<p>Lists the artist names. |
8415 |
|
Note that the character string may contain |
8416 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
8417 |
|
</p> |
8418 |
|
</blockquote> |
8419 |
|
|
8420 |
|
|
8421 |
|
<p>KEYWORDS - |
8422 |
|
</p> |
8423 |
|
<blockquote class="text"> |
8424 |
|
<p>Provides a list of keywords that refer to the instrument. |
8425 |
|
Keywords are separated with semicolon and blank. |
8426 |
|
Note that the character string may contain |
8427 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
8428 |
|
</p> |
8429 |
|
</blockquote> |
8430 |
|
|
8431 |
|
|
8432 |
|
</blockquote> |
8433 |
|
|
8434 |
|
|
8435 |
|
</blockquote><p> |
8436 |
|
|
8437 |
|
</p> |
8438 |
|
<p>The mentioned fields above don't have to be in particular order. |
8439 |
|
</p> |
8440 |
|
<p>Example: |
8441 |
|
</p> |
8442 |
|
<p> |
8443 |
|
</p> |
8444 |
|
<blockquote class="text"> |
8445 |
|
<p>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'" |
8446 |
|
</p> |
8447 |
|
<p>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig" |
8448 |
|
</p> |
8449 |
|
<p> "INSTRUMENT_NR: 0" |
8450 |
|
</p> |
8451 |
|
<p> "FORMAT_FAMILY: GIG" |
8452 |
|
</p> |
8453 |
|
<p> "FORMAT_VERSION: 2" |
8454 |
|
</p> |
8455 |
|
<p> "SIZE: 2050871870" |
8456 |
|
</p> |
8457 |
|
<p> "CREATED: 2007-02-05 10:23:12" |
8458 |
|
</p> |
8459 |
|
<p> "MODIFIED: 2007-04-07 12:50:21" |
8460 |
|
</p> |
8461 |
|
<p> "DESCRIPTION: " |
8462 |
|
</p> |
8463 |
|
<p> "IS_DRUM: false" |
8464 |
|
</p> |
8465 |
|
<p> "PRODUCT: GRANDIOSO Bosendorfer 290" |
8466 |
|
</p> |
8467 |
|
<p> "ARTISTS: Post Musical Instruments" |
8468 |
|
</p> |
8469 |
|
<p> "KEYWORDS: Bosendorfer" |
8470 |
|
</p> |
8471 |
|
<p> "." |
8472 |
|
</p> |
8473 |
|
</blockquote><p> |
8474 |
|
|
8475 |
|
</p> |
8476 |
|
<a name="SET DB_INSTRUMENT NAME"></a><br /><hr /> |
8477 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8478 |
|
<a name="rfc.section.6.8.16"></a><h3>6.8.16. |
8479 |
|
Renaming an instrument</h3> |
8480 |
|
|
8481 |
|
<p>The front-end can alter the name of a specific |
8482 |
|
instrument by sending the following command: |
8483 |
|
</p> |
8484 |
|
<p> |
8485 |
|
</p> |
8486 |
|
<blockquote class="text"> |
8487 |
|
<p>SET DB_INSTRUMENT NAME <instr> <name> |
8488 |
|
</p> |
8489 |
|
</blockquote><p> |
8490 |
|
|
8491 |
|
</p> |
8492 |
|
<p>Where <instr> is the absolute path name of the instrument and |
8493 |
|
<name> is the new name for that instrument. |
8494 |
|
</p> |
8495 |
|
<p>Possible Answers: |
8496 |
|
</p> |
8497 |
|
<p> |
8498 |
|
</p> |
8499 |
|
<blockquote class="text"> |
8500 |
|
<p>"OK" - |
8501 |
|
</p> |
8502 |
|
<blockquote class="text"> |
8503 |
|
<p>on success |
8504 |
|
</p> |
8505 |
|
</blockquote> |
8506 |
|
|
8507 |
|
|
8508 |
|
<p>"ERR:<error-code>:<error-message>" - |
8509 |
|
</p> |
8510 |
|
<blockquote class="text"> |
8511 |
|
<p>in case the given instrument does not exists, |
8512 |
|
or if an instrument with name equal to the new |
8513 |
|
name already exists. |
8514 |
|
</p> |
8515 |
|
</blockquote> |
8516 |
|
|
8517 |
|
|
8518 |
|
</blockquote><p> |
8519 |
|
|
8520 |
|
</p> |
8521 |
|
<p>Example: |
8522 |
|
</p> |
8523 |
|
<p> |
8524 |
|
</p> |
8525 |
|
<blockquote class="text"> |
8526 |
|
<p>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'" |
8527 |
|
</p> |
8528 |
|
<p>S: "OK" |
8529 |
|
</p> |
8530 |
|
</blockquote><p> |
8531 |
|
|
8532 |
|
</p> |
8533 |
|
<a name="MOVE DB_INSTRUMENT"></a><br /><hr /> |
8534 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8535 |
|
<a name="rfc.section.6.8.17"></a><h3>6.8.17. |
8536 |
|
Moving an instrument</h3> |
8537 |
|
|
8538 |
|
<p>The front-end can move a specific instrument to another directory by |
8539 |
|
sending the following command: |
8540 |
|
</p> |
8541 |
|
<p> |
8542 |
|
</p> |
8543 |
|
<blockquote class="text"> |
8544 |
|
<p>MOVE DB_INSTRUMENT <instr> <dst> |
8545 |
|
</p> |
8546 |
|
</blockquote><p> |
8547 |
|
|
8548 |
|
</p> |
8549 |
|
<p>Where <instr> is the absolute path name of the instrument |
8550 |
|
to move and <dst> is the directory where the instrument will |
8551 |
|
be moved to. |
8552 |
|
</p> |
8553 |
|
<p>Possible Answers: |
8554 |
|
</p> |
8555 |
|
<p> |
8556 |
|
</p> |
8557 |
|
<blockquote class="text"> |
8558 |
|
<p>"OK" - |
8559 |
|
</p> |
8560 |
|
<blockquote class="text"> |
8561 |
|
<p>on success |
8562 |
|
</p> |
8563 |
|
</blockquote> |
8564 |
|
|
8565 |
|
|
8566 |
|
<p>"ERR:<error-code>:<error-message>" - |
8567 |
|
</p> |
8568 |
|
<blockquote class="text"> |
8569 |
|
<p>in case the given instrument does not exists, |
8570 |
|
or if an instrument with name equal to the name of the |
8571 |
|
specified instrument already exists in the destination |
8572 |
|
directory. |
8573 |
|
</p> |
8574 |
|
</blockquote> |
8575 |
|
|
8576 |
|
|
8577 |
|
</blockquote><p> |
8578 |
|
|
8579 |
|
</p> |
8580 |
|
<p>Example: |
8581 |
|
</p> |
8582 |
|
<p> |
8583 |
|
</p> |
8584 |
|
<blockquote class="text"> |
8585 |
|
<p>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'" |
8586 |
|
</p> |
8587 |
|
<p>S: "OK" |
8588 |
|
</p> |
8589 |
|
</blockquote><p> |
8590 |
|
|
8591 |
|
</p> |
8592 |
|
<a name="COPY DB_INSTRUMENT"></a><br /><hr /> |
8593 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8594 |
|
<a name="rfc.section.6.8.18"></a><h3>6.8.18. |
8595 |
|
Copying instruments</h3> |
8596 |
|
|
8597 |
|
<p>The front-end can copy a specific instrument to another directory by |
8598 |
|
sending the following command: |
8599 |
|
</p> |
8600 |
|
<p> |
8601 |
|
</p> |
8602 |
|
<blockquote class="text"> |
8603 |
|
<p>COPY DB_INSTRUMENT <instr> <dst> |
8604 |
|
</p> |
8605 |
|
</blockquote><p> |
8606 |
|
|
8607 |
|
</p> |
8608 |
|
<p>Where <instr> is the absolute path name of the instrument |
8609 |
|
to copy and <dst> is the directory where the instrument will |
8610 |
|
be copied to. |
8611 |
|
</p> |
8612 |
|
<p>Possible Answers: |
8613 |
|
</p> |
8614 |
|
<p> |
8615 |
|
</p> |
8616 |
|
<blockquote class="text"> |
8617 |
|
<p>"OK" - |
8618 |
|
</p> |
8619 |
|
<blockquote class="text"> |
8620 |
|
<p>on success |
8621 |
|
</p> |
8622 |
|
</blockquote> |
8623 |
|
|
8624 |
|
|
8625 |
|
<p>"ERR:<error-code>:<error-message>" - |
8626 |
|
</p> |
8627 |
|
<blockquote class="text"> |
8628 |
|
<p>in case the given instrument does not exists, |
8629 |
|
or if an instrument with name equal to the name of the |
8630 |
|
specified instrument already exists in the destination |
8631 |
|
directory. |
8632 |
|
</p> |
8633 |
|
</blockquote> |
8634 |
|
|
8635 |
|
|
8636 |
|
</blockquote><p> |
8637 |
|
|
8638 |
|
</p> |
8639 |
|
<p>Example: |
8640 |
|
</p> |
8641 |
|
<p> |
8642 |
|
</p> |
8643 |
|
<blockquote class="text"> |
8644 |
|
<p>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'" |
8645 |
|
</p> |
8646 |
|
<p>S: "OK" |
8647 |
|
</p> |
8648 |
|
</blockquote><p> |
8649 |
|
|
8650 |
|
</p> |
8651 |
|
<a name="SET DB_INSTRUMENT DESCRIPTION"></a><br /><hr /> |
8652 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8653 |
|
<a name="rfc.section.6.8.19"></a><h3>6.8.19. |
8654 |
|
Changing the description of instrument</h3> |
8655 |
|
|
8656 |
|
<p>The front-end can alter the description of a specific |
8657 |
|
instrument by sending the following command: |
8658 |
|
</p> |
8659 |
|
<p> |
8660 |
|
</p> |
8661 |
|
<blockquote class="text"> |
8662 |
|
<p>SET DB_INSTRUMENT DESCRIPTION <instr> <desc> |
8663 |
|
</p> |
8664 |
|
</blockquote><p> |
8665 |
|
|
8666 |
|
</p> |
8667 |
|
<p>Where <instr> is the absolute path name of the instrument and |
8668 |
|
<desc> is the new description for the instrument |
8669 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
8670 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
8671 |
|
</p> |
8672 |
|
<p>Possible Answers: |
8673 |
|
</p> |
8674 |
|
<p> |
8675 |
|
</p> |
8676 |
|
<blockquote class="text"> |
8677 |
|
<p>"OK" - |
8678 |
|
</p> |
8679 |
|
<blockquote class="text"> |
8680 |
|
<p>on success |
8681 |
|
</p> |
8682 |
|
</blockquote> |
8683 |
|
|
8684 |
|
|
8685 |
|
<p>"ERR:<error-code>:<error-message>" - |
8686 |
|
</p> |
8687 |
|
<blockquote class="text"> |
8688 |
|
<p>in case the given instrument does not exists. |
8689 |
|
</p> |
8690 |
|
</blockquote> |
8691 |
|
|
8692 |
|
|
8693 |
|
</blockquote><p> |
8694 |
|
|
8695 |
|
</p> |
8696 |
|
<p>Example: |
8697 |
|
</p> |
8698 |
|
<p> |
8699 |
|
</p> |
8700 |
|
<blockquote class="text"> |
8701 |
|
<p>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'" |
8702 |
|
</p> |
8703 |
|
<p>S: "OK" |
8704 |
|
</p> |
8705 |
|
</blockquote><p> |
8706 |
|
|
8707 |
|
</p> |
8708 |
|
<a name="FIND DB_INSTRUMENTS"></a><br /><hr /> |
8709 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8710 |
|
<a name="rfc.section.6.8.20"></a><h3>6.8.20. |
8711 |
|
Finding instruments</h3> |
8712 |
|
|
8713 |
|
<p>The front-end can search for instruments |
8714 |
|
in specific directory by sending the following command: |
8715 |
|
</p> |
8716 |
|
<p> |
8717 |
|
</p> |
8718 |
|
<blockquote class="text"> |
8719 |
|
<p>FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list> |
8720 |
|
</p> |
8721 |
|
</blockquote><p> |
8722 |
|
|
8723 |
|
</p> |
8724 |
|
<p>Where <dir> should be replaced by the absolute path |
8725 |
|
name of the directory to search in. If NON_RECURSIVE is specified, the |
8726 |
|
directories located in subdirectories of the specified directory will not |
8727 |
|
be searched. <criteria-list> is a list of search criterias |
8728 |
|
in form of "key1=val1 key2=val2 ...". The following criterias are |
8729 |
|
allowed: |
8730 |
|
</p> |
8731 |
|
<p> |
8732 |
|
|
8733 |
|
<p>NAME='<search-string>' |
8734 |
|
</p> |
8735 |
|
<blockquote class="text"> |
8736 |
|
<p>Restricts the search to instruments, which names |
8737 |
|
satisfy the supplied search string (encapsulated into apostrophes, |
8738 |
|
supporting escape sequences as described in chapter |
8739 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
8740 |
|
</p> |
8741 |
|
</blockquote><p> |
8742 |
|
|
8743 |
|
</p> |
8744 |
|
|
8745 |
|
|
8746 |
|
<p>SIZE=[<min>]..[<max>] |
8747 |
|
</p> |
8748 |
|
<blockquote class="text"> |
8749 |
|
<p>Restricts the search to instruments, which |
8750 |
|
size is in the specified range. If <min> is omitted, |
8751 |
|
the search results are restricted to instruments with size less then |
8752 |
|
or equal to <max>. If <max> is omitted, the |
8753 |
|
search is restricted to instruments with size greater then |
8754 |
|
or equal to <min>. |
8755 |
|
</p> |
8756 |
|
</blockquote><p> |
8757 |
|
|
8758 |
|
</p> |
8759 |
|
|
8760 |
|
|
8761 |
|
<p>CREATED='[<date-after>]..[<date-before>]' |
8762 |
|
</p> |
8763 |
|
<blockquote class="text"> |
8764 |
|
<p>Restricts the search to instruments, which creation |
8765 |
|
date satisfies the specified period, where <date-after> |
8766 |
|
and <date-before> are in "YYYY-MM-DD HH:MM:SS" format. |
8767 |
|
If <date-after> is omitted the search is restricted to |
8768 |
|
instruments created before <date-before>. If |
8769 |
|
<date-before> is omitted, the search is restricted |
8770 |
|
to instruments created after <date-after>. |
8771 |
|
</p> |
8772 |
|
</blockquote><p> |
8773 |
|
|
8774 |
|
</p> |
8775 |
|
|
8776 |
|
|
8777 |
|
<p>MODIFIED='[<date-after>]..[<date-before>]' |
8778 |
|
</p> |
8779 |
|
<blockquote class="text"> |
8780 |
|
<p>Restricts the search to instruments, which |
8781 |
|
date of last modification satisfies the specified period, where |
8782 |
|
<date-after> and <date-before> are in "YYYY-MM-DD HH:MM:SS" |
8783 |
|
format. If <date-after> is omitted the search is restricted to |
8784 |
|
instruments, which are last modified before <date-before>. If |
8785 |
|
<date-before> is omitted, the search is restricted to instruments, |
8786 |
|
which are last modified after <date-after>. |
8787 |
|
</p> |
8788 |
|
</blockquote><p> |
8789 |
|
|
8790 |
|
</p> |
8791 |
|
|
8792 |
|
|
8793 |
|
<p>DESCRIPTION='<search-string>' |
8794 |
|
</p> |
8795 |
|
<blockquote class="text"> |
8796 |
|
<p>Restricts the search to instruments with description |
8797 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
8798 |
|
supporting escape sequences as described in chapter |
8799 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
8800 |
|
</p> |
8801 |
|
</blockquote><p> |
8802 |
|
|
8803 |
|
</p> |
8804 |
|
|
8805 |
|
|
8806 |
|
<p>PRODUCT='<search-string>' |
8807 |
|
</p> |
8808 |
|
<blockquote class="text"> |
8809 |
|
<p>Restricts the search to instruments with product info |
8810 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
8811 |
|
supporting escape sequences as described in chapter |
8812 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
8813 |
|
</p> |
8814 |
|
</blockquote><p> |
8815 |
|
|
8816 |
|
</p> |
8817 |
|
|
8818 |
|
|
8819 |
|
<p>ARTISTS='<search-string>' |
8820 |
|
</p> |
8821 |
|
<blockquote class="text"> |
8822 |
|
<p>Restricts the search to instruments with artists info |
8823 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
8824 |
|
supporting escape sequences as described in chapter |
8825 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
8826 |
|
</p> |
8827 |
|
</blockquote><p> |
8828 |
|
|
8829 |
|
</p> |
8830 |
|
|
8831 |
|
|
8832 |
|
<p>KEYWORDS='<search-string>' |
8833 |
|
</p> |
8834 |
|
<blockquote class="text"> |
8835 |
|
<p>Restricts the search to instruments with keyword list |
8836 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
8837 |
|
supporting escape sequences as described in chapter |
8838 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
8839 |
|
</p> |
8840 |
|
</blockquote><p> |
8841 |
|
|
8842 |
|
</p> |
8843 |
|
|
8844 |
|
|
8845 |
|
<p>IS_DRUM=true | false |
8846 |
|
</p> |
8847 |
|
<blockquote class="text"> |
8848 |
|
<p>Either true or false. Restricts the search to |
8849 |
|
drum kits or chromatic instruments. |
8850 |
|
</p> |
8851 |
|
</blockquote><p> |
8852 |
|
|
8853 |
|
</p> |
8854 |
|
|
8855 |
|
|
8856 |
|
<p>FORMAT_FAMILIES='<format-list>' |
8857 |
|
</p> |
8858 |
|
<blockquote class="text"> |
8859 |
|
<p>Restricts the search to instruments of the supplied format families, |
8860 |
|
where <format-list> is a comma separated list of format families. |
8861 |
|
</p> |
8862 |
|
</blockquote><p> |
8863 |
|
|
8864 |
|
</p> |
8865 |
|
|
8866 |
|
|
8867 |
|
<p>Where <search-string> is either a regular expression, or a |
8868 |
|
word list separated with spaces for OR search and with '+' for AND search. |
8869 |
|
</p> |
8870 |
|
<p>Possible Answers: |
8871 |
|
</p> |
8872 |
|
<p> |
8873 |
|
</p> |
8874 |
|
<blockquote class="text"> |
8875 |
|
<p>A comma separated list with the absolute path names (encapsulated into |
8876 |
|
apostrophes) of all instruments in the specified directory that satisfy |
8877 |
|
the supplied search criterias. |
8878 |
|
</p> |
8879 |
|
<p>"ERR:<error-code>:<error-message>" - |
8880 |
|
</p> |
8881 |
|
<blockquote class="text"> |
8882 |
|
<p>if the given directory does not exist. |
8883 |
|
</p> |
8884 |
|
</blockquote> |
8885 |
|
|
8886 |
|
|
8887 |
|
</blockquote><p> |
8888 |
|
|
8889 |
|
</p> |
8890 |
|
<p>Example: |
8891 |
|
</p> |
8892 |
|
<p> |
8893 |
|
</p> |
8894 |
|
<blockquote class="text"> |
8895 |
|
<p>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'" |
8896 |
|
</p> |
8897 |
|
<p>S: "'/Piano Collection/Bosendorfer 290'" |
8898 |
|
</p> |
8899 |
|
</blockquote><p> |
8900 |
|
|
8901 |
|
</p> |
8902 |
|
<p> |
8903 |
|
</p> |
8904 |
|
<blockquote class="text"> |
8905 |
|
<p>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'" |
8906 |
|
</p> |
8907 |
|
<p>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'" |
8908 |
|
</p> |
8909 |
|
</blockquote><p> |
8910 |
|
|
8911 |
|
</p> |
8912 |
|
<a name="GET DB_INSTRUMENTS_JOB INFO"></a><br /><hr /> |
8913 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
8914 |
|
<a name="rfc.section.6.8.21"></a><h3>6.8.21. |
8915 |
|
Getting job status information</h3> |
8916 |
|
|
8917 |
|
<p>The front-end can ask for the current status of a |
8918 |
|
particular database instruments job by sending the following command: |
8919 |
|
</p> |
8920 |
|
<p> |
8921 |
|
</p> |
8922 |
|
<blockquote class="text"> |
8923 |
|
<p>GET DB_INSTRUMENTS_JOB INFO <job-id> |
8924 |
|
</p> |
8925 |
|
</blockquote><p> |
8926 |
|
|
8927 |
|
</p> |
8928 |
|
<p>Where <job-id> should be replaced by the numerical ID |
8929 |
|
of the job the front-end is interested in. |
8930 |
|
</p> |
8931 |
|
<p>Possible Answers: |
8932 |
|
</p> |
8933 |
|
<p> |
8934 |
|
</p> |
8935 |
|
<blockquote class="text"> |
8936 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
8937 |
|
Each answer line begins with the settings category name |
8938 |
|
followed by a colon and then a space character <SP> and finally |
8939 |
|
the info character string to that setting category. At the |
8940 |
|
moment the following categories are defined: |
8941 |
|
</p> |
8942 |
|
<p> |
8943 |
|
</p> |
8944 |
|
<blockquote class="text"> |
8945 |
|
<p>FILES_TOTAL - |
8946 |
|
</p> |
8947 |
|
<blockquote class="text"> |
8948 |
|
<p>The total number of files scheduled for scanning |
8949 |
|
</p> |
8950 |
|
</blockquote> |
8951 |
|
|
8952 |
|
|
8953 |
|
<p>FILES_SCANNED - |
8954 |
|
</p> |
8955 |
|
<blockquote class="text"> |
8956 |
|
<p>The current number of scanned files |
8957 |
|
</p> |
8958 |
|
</blockquote> |
8959 |
|
|
8960 |
|
|
8961 |
|
<p>SCANNING - |
8962 |
|
</p> |
8963 |
|
<blockquote class="text"> |
8964 |
|
<p>The absolute path name of the file which is currently |
8965 |
|
being scanned |
8966 |
|
</p> |
8967 |
|
</blockquote> |
8968 |
|
|
8969 |
|
|
8970 |
|
<p>STATUS - |
8971 |
|
</p> |
8972 |
|
<blockquote class="text"> |
8973 |
|
<p>An integer value between 0 and 100 indicating the |
8974 |
|
scanning progress percentage of the file which is |
8975 |
|
currently being scanned |
8976 |
|
</p> |
8977 |
|
</blockquote> |
8978 |
|
|
8979 |
|
|
8980 |
|
</blockquote> |
8981 |
|
|
8982 |
|
|
8983 |
|
</blockquote><p> |
8984 |
|
|
8985 |
|
</p> |
8986 |
|
<p>The mentioned fields above don't have to be in particular order. |
8987 |
|
</p> |
8988 |
|
<p>Example: |
8989 |
|
</p> |
8990 |
|
<p> |
8991 |
|
</p> |
8992 |
|
<blockquote class="text"> |
8993 |
|
<p>C: "GET DB_INSTRUMENTS_JOB INFO 2" |
8994 |
|
</p> |
8995 |
|
<p>S: "FILES_TOTAL: 12" |
8996 |
|
</p> |
8997 |
|
<p> "FILES_SCANNED: 7" |
8998 |
|
</p> |
8999 |
|
<p> "SCANNING: /home/me/gigs/Bosendorfer 290.gig" |
9000 |
|
</p> |
9001 |
|
<p> "STATUS: 42" |
9002 |
|
</p> |
9003 |
|
<p> "." |
9004 |
|
</p> |
9005 |
|
</blockquote><p> |
9006 |
|
|
9007 |
|
</p> |
9008 |
|
<a name="FORMAT INSTRUMENTS_DB"></a><br /><hr /> |
9009 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9010 |
|
<a name="rfc.section.6.8.22"></a><h3>6.8.22. |
9011 |
|
Formatting the instruments database</h3> |
9012 |
|
|
9013 |
|
<p>The front-end can remove all instruments and directories and re-create |
9014 |
|
the instruments database structure (e.g., in case of a database corruption) |
9015 |
|
by sending the following command: |
9016 |
|
</p> |
9017 |
|
<p> |
9018 |
|
</p> |
9019 |
|
<blockquote class="text"> |
9020 |
|
<p>FORMAT INSTRUMENTS_DB |
9021 |
|
</p> |
9022 |
|
</blockquote><p> |
9023 |
|
|
9024 |
|
</p> |
9025 |
|
<p>Possible Answers: |
9026 |
|
</p> |
9027 |
|
<p> |
9028 |
|
</p> |
9029 |
|
<blockquote class="text"> |
9030 |
|
<p>"OK" - |
9031 |
|
</p> |
9032 |
|
<blockquote class="text"> |
9033 |
|
<p>on success |
9034 |
|
</p> |
9035 |
|
</blockquote> |
9036 |
|
|
9037 |
|
|
9038 |
|
<p>"ERR:<error-code>:<error-message>" - |
9039 |
|
</p> |
9040 |
|
<blockquote class="text"> |
9041 |
|
<p>If the formatting of the instruments database |
9042 |
|
failed. |
9043 |
|
</p> |
9044 |
|
</blockquote> |
9045 |
|
|
9046 |
|
|
9047 |
|
</blockquote><p> |
9048 |
|
|
9049 |
|
</p> |
9050 |
|
<a name="editing_instruments"></a><br /><hr /> |
9051 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9052 |
|
<a name="rfc.section.6.9"></a><h3>6.9. |
9053 |
|
Editing Instruments</h3> |
9054 |
|
|
9055 |
|
<p>The sampler allows to edit instruments while playing with the |
9056 |
|
sampler by spawning an external (3rd party) instrument editor |
9057 |
|
application for a given instrument. The 3rd party instrument |
9058 |
|
editor applications have to place a respective plugin DLL file |
9059 |
|
into the sampler's plugins directory. The sampler will |
9060 |
|
automatically try to load all plugin DLLs in that directory on |
9061 |
|
startup and only on startup! |
9062 |
|
</p> |
9063 |
|
<p>At the moment there is only one command for this feature set, |
9064 |
|
but this will most probably change in future. |
9065 |
|
</p> |
9066 |
|
<a name="EDIT INSTRUMENT"></a><br /><hr /> |
9067 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9068 |
|
<a name="rfc.section.6.9.1"></a><h3>6.9.1. |
9069 |
|
Opening an appropriate instrument editor application</h3> |
9070 |
|
|
9071 |
|
<p>The front-end can request to open an appropriate instrument |
9072 |
|
editor application by sending the following command: |
9073 |
|
</p> |
9074 |
|
<p> |
9075 |
|
</p> |
9076 |
|
<blockquote class="text"> |
9077 |
|
<p>EDIT CHANNEL INSTRUMENT <sampler-channel> |
9078 |
|
</p> |
9079 |
|
</blockquote><p> |
9080 |
|
|
9081 |
|
</p> |
9082 |
|
<p>Where <sampler-channel> should be replaced by the |
9083 |
|
number of the sampler channel as given by the |
9084 |
|
<a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a> |
9085 |
|
or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> |
9086 |
|
command. |
9087 |
|
</p> |
9088 |
|
<p>The sampler will try to ask all registered instrument |
9089 |
|
editors (or to be more specific: their sampler plugins) |
9090 |
|
whether they are capable to handle the instrument on the |
9091 |
|
given sampler channel. The sampler will simply use the first |
9092 |
|
instrument editor application which replied with a positive |
9093 |
|
answer and spawn that instrument editor application within |
9094 |
|
the sampler's process and provide that application access |
9095 |
|
to the instrument's data structures, so both applications |
9096 |
|
can share and access the same instruments data at the same |
9097 |
|
time, thus allowing to immediately hear changes with the |
9098 |
|
sampler made by the instrument editor. |
9099 |
|
</p> |
9100 |
|
<p>Note: consequently instrument editors are always spawned |
9101 |
|
locally on the same machine where the sampler is running |
9102 |
|
on! |
9103 |
|
</p> |
9104 |
|
<p>Possible Answers: |
9105 |
|
</p> |
9106 |
|
<p> |
9107 |
|
</p> |
9108 |
|
<blockquote class="text"> |
9109 |
|
<p>"OK" - |
9110 |
|
</p> |
9111 |
|
<blockquote class="text"> |
9112 |
|
<p>when an appropriate instrument editor was |
9113 |
|
launched |
9114 |
|
</p> |
9115 |
|
</blockquote> |
9116 |
|
|
9117 |
|
|
9118 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
9119 |
|
</p> |
9120 |
|
<blockquote class="text"> |
9121 |
|
<p>when an appropriate instrument editor was |
9122 |
|
launched, but there are noteworthy issues |
9123 |
|
</p> |
9124 |
|
</blockquote> |
9125 |
|
|
9126 |
|
|
9127 |
|
<p>"ERR:<error-code>:<error-message>" - |
9128 |
|
</p> |
9129 |
|
<blockquote class="text"> |
9130 |
|
<p>when an appropriate instrument editor |
9131 |
|
could not be launched |
9132 |
|
</p> |
9133 |
|
</blockquote> |
9134 |
|
|
9135 |
|
|
9136 |
|
</blockquote><p> |
9137 |
|
|
9138 |
|
</p> |
9139 |
|
<p>Examples: |
9140 |
|
</p> |
9141 |
|
<p> |
9142 |
|
</p> |
9143 |
|
<blockquote class="text"> |
9144 |
|
<p>C: "EDIT CHANNEL INSTRUMENT 0" |
9145 |
|
</p> |
9146 |
|
<p>S: "OK" |
9147 |
|
</p> |
9148 |
|
</blockquote><p> |
9149 |
|
|
9150 |
|
</p> |
9151 |
<a name="command_syntax"></a><br /><hr /> |
<a name="command_syntax"></a><br /><hr /> |
9152 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> 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> |
9153 |
<a name="rfc.section.7"></a><h3>7. |
<a name="rfc.section.7"></a><h3>7. |
9248 |
<p>/ UNSUBSCRIBE SP unsubscribe_event |
<p>/ UNSUBSCRIBE SP unsubscribe_event |
9249 |
|
|
9250 |
</p> |
</p> |
|
<p>/ SELECT SP text |
|
|
|
|
|
</p> |
|
9251 |
<p>/ RESET SP reset_instruction |
<p>/ RESET SP reset_instruction |
9252 |
|
|
9253 |
</p> |
</p> |
9254 |
<p>/ CLEAR SP clear_instruction |
<p>/ CLEAR SP clear_instruction |
9255 |
|
|
9256 |
</p> |
</p> |
9257 |
|
<p>/ FIND SP find_instruction |
9258 |
|
|
9259 |
|
</p> |
9260 |
|
<p>/ MOVE SP move_instruction |
9261 |
|
|
9262 |
|
</p> |
9263 |
|
<p>/ COPY SP copy_instruction |
9264 |
|
|
9265 |
|
</p> |
9266 |
|
<p>/ EDIT SP edit_instruction |
9267 |
|
|
9268 |
|
</p> |
9269 |
|
<p>/ FORMAT SP format_instruction |
9270 |
|
|
9271 |
|
</p> |
9272 |
<p>/ RESET |
<p>/ RESET |
9273 |
|
|
9274 |
</p> |
</p> |
9284 |
<p>CHANNEL |
<p>CHANNEL |
9285 |
|
|
9286 |
</p> |
</p> |
9287 |
|
<p>/ DB_INSTRUMENT_DIRECTORY SP db_path |
9288 |
|
|
9289 |
|
</p> |
9290 |
|
<p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
9291 |
|
|
9292 |
|
</p> |
9293 |
|
<p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
9294 |
|
|
9295 |
|
</p> |
9296 |
|
<p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
9297 |
|
|
9298 |
|
</p> |
9299 |
|
<p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index |
9300 |
|
|
9301 |
|
</p> |
9302 |
|
<p>/ DB_INSTRUMENTS SP db_path SP filename |
9303 |
|
|
9304 |
|
</p> |
9305 |
|
<p>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index |
9306 |
|
|
9307 |
|
</p> |
9308 |
<p>/ MIDI_INSTRUMENT_MAP |
<p>/ MIDI_INSTRUMENT_MAP |
9309 |
|
|
9310 |
</p> |
</p> |
9317 |
<p>subscribe_event = |
<p>subscribe_event = |
9318 |
</p> |
</p> |
9319 |
<blockquote class="text"> |
<blockquote class="text"> |
9320 |
<p>CHANNEL_COUNT |
<p>AUDIO_OUTPUT_DEVICE_COUNT |
9321 |
|
|
9322 |
|
</p> |
9323 |
|
<p>/ AUDIO_OUTPUT_DEVICE_INFO |
9324 |
|
|
9325 |
|
</p> |
9326 |
|
<p>/ MIDI_INPUT_DEVICE_COUNT |
9327 |
|
|
9328 |
|
</p> |
9329 |
|
<p>/ MIDI_INPUT_DEVICE_INFO |
9330 |
|
|
9331 |
|
</p> |
9332 |
|
<p>/ CHANNEL_COUNT |
9333 |
|
|
9334 |
</p> |
</p> |
9335 |
<p>/ VOICE_COUNT |
<p>/ VOICE_COUNT |
9344 |
<p>/ CHANNEL_INFO |
<p>/ CHANNEL_INFO |
9345 |
|
|
9346 |
</p> |
</p> |
9347 |
|
<p>/ FX_SEND_COUNT |
9348 |
|
|
9349 |
|
</p> |
9350 |
|
<p>/ FX_SEND_INFO |
9351 |
|
|
9352 |
|
</p> |
9353 |
|
<p>/ MIDI_INSTRUMENT_MAP_COUNT |
9354 |
|
|
9355 |
|
</p> |
9356 |
|
<p>/ MIDI_INSTRUMENT_MAP_INFO |
9357 |
|
|
9358 |
|
</p> |
9359 |
|
<p>/ MIDI_INSTRUMENT_COUNT |
9360 |
|
|
9361 |
|
</p> |
9362 |
|
<p>/ MIDI_INSTRUMENT_INFO |
9363 |
|
|
9364 |
|
</p> |
9365 |
|
<p>/ DB_INSTRUMENT_DIRECTORY_COUNT |
9366 |
|
|
9367 |
|
</p> |
9368 |
|
<p>/ DB_INSTRUMENT_DIRECTORY_INFO |
9369 |
|
|
9370 |
|
</p> |
9371 |
|
<p>/ DB_INSTRUMENT_COUNT |
9372 |
|
|
9373 |
|
</p> |
9374 |
|
<p>/ DB_INSTRUMENT_INFO |
9375 |
|
|
9376 |
|
</p> |
9377 |
|
<p>/ DB_INSTRUMENTS_JOB_INFO |
9378 |
|
|
9379 |
|
</p> |
9380 |
<p>/ MISCELLANEOUS |
<p>/ MISCELLANEOUS |
9381 |
|
|
9382 |
</p> |
</p> |
9383 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
9384 |
|
|
9385 |
</p> |
</p> |
9386 |
|
<p>/ GLOBAL_INFO |
9387 |
|
|
9388 |
|
</p> |
9389 |
</blockquote><p> |
</blockquote><p> |
9390 |
|
|
9391 |
</p> |
</p> |
9392 |
<p>unsubscribe_event = |
<p>unsubscribe_event = |
9393 |
</p> |
</p> |
9394 |
<blockquote class="text"> |
<blockquote class="text"> |
9395 |
<p>CHANNEL_COUNT |
<p>AUDIO_OUTPUT_DEVICE_COUNT |
9396 |
|
|
9397 |
|
</p> |
9398 |
|
<p>/ AUDIO_OUTPUT_DEVICE_INFO |
9399 |
|
|
9400 |
|
</p> |
9401 |
|
<p>/ MIDI_INPUT_DEVICE_COUNT |
9402 |
|
|
9403 |
|
</p> |
9404 |
|
<p>/ MIDI_INPUT_DEVICE_INFO |
9405 |
|
|
9406 |
|
</p> |
9407 |
|
<p>/ CHANNEL_COUNT |
9408 |
|
|
9409 |
</p> |
</p> |
9410 |
<p>/ VOICE_COUNT |
<p>/ VOICE_COUNT |
9419 |
<p>/ CHANNEL_INFO |
<p>/ CHANNEL_INFO |
9420 |
|
|
9421 |
</p> |
</p> |
9422 |
|
<p>/ FX_SEND_COUNT |
9423 |
|
|
9424 |
|
</p> |
9425 |
|
<p>/ FX_SEND_INFO |
9426 |
|
|
9427 |
|
</p> |
9428 |
|
<p>/ MIDI_INSTRUMENT_MAP_COUNT |
9429 |
|
|
9430 |
|
</p> |
9431 |
|
<p>/ MIDI_INSTRUMENT_MAP_INFO |
9432 |
|
|
9433 |
|
</p> |
9434 |
|
<p>/ MIDI_INSTRUMENT_COUNT |
9435 |
|
|
9436 |
|
</p> |
9437 |
|
<p>/ MIDI_INSTRUMENT_INFO |
9438 |
|
|
9439 |
|
</p> |
9440 |
|
<p>/ DB_INSTRUMENT_DIRECTORY_COUNT |
9441 |
|
|
9442 |
|
</p> |
9443 |
|
<p>/ DB_INSTRUMENT_DIRECTORY_INFO |
9444 |
|
|
9445 |
|
</p> |
9446 |
|
<p>/ DB_INSTRUMENT_COUNT |
9447 |
|
|
9448 |
|
</p> |
9449 |
|
<p>/ DB_INSTRUMENT_INFO |
9450 |
|
|
9451 |
|
</p> |
9452 |
|
<p>/ DB_INSTRUMENTS_JOB_INFO |
9453 |
|
|
9454 |
|
</p> |
9455 |
<p>/ MISCELLANEOUS |
<p>/ MISCELLANEOUS |
9456 |
|
|
9457 |
</p> |
</p> |
9458 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
9459 |
|
|
9460 |
</p> |
</p> |
9461 |
|
<p>/ GLOBAL_INFO |
9462 |
|
|
9463 |
|
</p> |
9464 |
</blockquote><p> |
</blockquote><p> |
9465 |
|
|
9466 |
</p> |
</p> |
9467 |
<p>map_instruction = |
<p>map_instruction = |
9468 |
</p> |
</p> |
9469 |
<blockquote class="text"> |
<blockquote class="text"> |
9470 |
<p>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value |
<p>MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value |
9471 |
|
|
9472 |
</p> |
</p> |
9473 |
<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 |
<p>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode |
9474 |
|
|
9475 |
</p> |
</p> |
9476 |
<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 |
<p>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name |
9477 |
|
|
9478 |
</p> |
</p> |
9479 |
<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 |
<p>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name |
9480 |
|
|
9481 |
</p> |
</p> |
9482 |
</blockquote><p> |
</blockquote><p> |
9503 |
<p>/ MIDI_INSTRUMENT_MAP SP ALL |
<p>/ MIDI_INSTRUMENT_MAP SP ALL |
9504 |
|
|
9505 |
</p> |
</p> |
9506 |
|
<p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
9507 |
|
|
9508 |
|
</p> |
9509 |
|
<p>/ DB_INSTRUMENT_DIRECTORY SP db_path |
9510 |
|
|
9511 |
|
</p> |
9512 |
|
<p>/ DB_INSTRUMENT SP db_path |
9513 |
|
|
9514 |
|
</p> |
9515 |
</blockquote><p> |
</blockquote><p> |
9516 |
|
|
9517 |
</p> |
</p> |
9611 |
<p>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
<p>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
9612 |
|
|
9613 |
</p> |
</p> |
9614 |
|
<p>/ FX_SENDS SP sampler_channel |
9615 |
|
|
9616 |
|
</p> |
9617 |
|
<p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
9618 |
|
|
9619 |
|
</p> |
9620 |
|
<p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
9621 |
|
|
9622 |
|
</p> |
9623 |
|
<p>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
9624 |
|
|
9625 |
|
</p> |
9626 |
|
<p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path |
9627 |
|
|
9628 |
|
</p> |
9629 |
|
<p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
9630 |
|
|
9631 |
|
</p> |
9632 |
|
<p>/ DB_INSTRUMENTS SP db_path |
9633 |
|
|
9634 |
|
</p> |
9635 |
|
<p>/ DB_INSTRUMENT SP INFO SP db_path |
9636 |
|
|
9637 |
|
</p> |
9638 |
|
<p>/ DB_INSTRUMENTS_JOB SP INFO SP number |
9639 |
|
|
9640 |
|
</p> |
9641 |
|
<p>/ VOLUME |
9642 |
|
|
9643 |
|
</p> |
9644 |
</blockquote><p> |
</blockquote><p> |
9645 |
|
|
9646 |
</p> |
</p> |
9656 |
<p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
<p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
9657 |
|
|
9658 |
</p> |
</p> |
9659 |
|
<p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE |
9660 |
|
|
9661 |
|
</p> |
9662 |
<p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
<p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
9663 |
|
|
9664 |
</p> |
</p> |
9668 |
<p>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
<p>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
9669 |
|
|
9670 |
</p> |
</p> |
9671 |
|
<p>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name |
9672 |
|
|
9673 |
|
</p> |
9674 |
|
<p>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index |
9675 |
|
|
9676 |
|
</p> |
9677 |
|
<p>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl |
9678 |
|
|
9679 |
|
</p> |
9680 |
|
<p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
9681 |
|
|
9682 |
|
</p> |
9683 |
|
<p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
9684 |
|
|
9685 |
|
</p> |
9686 |
|
<p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped |
9687 |
|
|
9688 |
|
</p> |
9689 |
|
<p>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped |
9690 |
|
|
9691 |
|
</p> |
9692 |
|
<p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
9693 |
|
|
9694 |
|
</p> |
9695 |
<p>/ ECHO SP boolean |
<p>/ ECHO SP boolean |
9696 |
|
|
9697 |
</p> |
</p> |
9698 |
|
<p>/ VOLUME SP volume_value |
9699 |
|
|
9700 |
|
</p> |
9701 |
</blockquote><p> |
</blockquote><p> |
9702 |
|
|
9703 |
</p> |
</p> |
9716 |
<p>/ MIDI_INPUT_DEVICE SP string |
<p>/ MIDI_INPUT_DEVICE SP string |
9717 |
|
|
9718 |
</p> |
</p> |
9719 |
|
<p>/ FX_SEND SP sampler_channel SP midi_ctrl |
9720 |
|
|
9721 |
|
</p> |
9722 |
|
<p>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
9723 |
|
|
9724 |
|
</p> |
9725 |
</blockquote><p> |
</blockquote><p> |
9726 |
|
|
9727 |
</p> |
</p> |
9746 |
</blockquote><p> |
</blockquote><p> |
9747 |
|
|
9748 |
</p> |
</p> |
9749 |
|
<p>find_instruction = |
9750 |
|
</p> |
9751 |
|
<blockquote class="text"> |
9752 |
|
<p>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list |
9753 |
|
|
9754 |
|
</p> |
9755 |
|
<p>/ DB_INSTRUMENTS SP db_path SP query_val_list |
9756 |
|
|
9757 |
|
</p> |
9758 |
|
<p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list |
9759 |
|
|
9760 |
|
</p> |
9761 |
|
<p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
9762 |
|
|
9763 |
|
</p> |
9764 |
|
</blockquote><p> |
9765 |
|
|
9766 |
|
</p> |
9767 |
|
<p>move_instruction = |
9768 |
|
</p> |
9769 |
|
<blockquote class="text"> |
9770 |
|
<p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
9771 |
|
|
9772 |
|
</p> |
9773 |
|
<p>/ DB_INSTRUMENT SP db_path SP db_path |
9774 |
|
|
9775 |
|
</p> |
9776 |
|
</blockquote><p> |
9777 |
|
|
9778 |
|
</p> |
9779 |
|
<p>copy_instruction = |
9780 |
|
</p> |
9781 |
|
<blockquote class="text"> |
9782 |
|
<p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
9783 |
|
|
9784 |
|
</p> |
9785 |
|
<p>/ DB_INSTRUMENT SP db_path SP db_path |
9786 |
|
|
9787 |
|
</p> |
9788 |
|
</blockquote><p> |
9789 |
|
|
9790 |
|
</p> |
9791 |
<p>destroy_instruction = |
<p>destroy_instruction = |
9792 |
</p> |
</p> |
9793 |
<blockquote class="text"> |
<blockquote class="text"> |
9797 |
<p>/ MIDI_INPUT_DEVICE SP number |
<p>/ MIDI_INPUT_DEVICE SP number |
9798 |
|
|
9799 |
</p> |
</p> |
9800 |
|
<p>/ FX_SEND SP sampler_channel SP fx_send_id |
9801 |
|
|
9802 |
|
</p> |
9803 |
</blockquote><p> |
</blockquote><p> |
9804 |
|
|
9805 |
</p> |
</p> |
9863 |
</blockquote><p> |
</blockquote><p> |
9864 |
|
|
9865 |
</p> |
</p> |
9866 |
|
<p>edit_instruction = |
9867 |
|
</p> |
9868 |
|
<blockquote class="text"> |
9869 |
|
<p>CHANNEL SP INSTRUMENT SP sampler_channel |
9870 |
|
|
9871 |
|
</p> |
9872 |
|
</blockquote><p> |
9873 |
|
|
9874 |
|
</p> |
9875 |
|
<p>format_instruction = |
9876 |
|
</p> |
9877 |
|
<blockquote class="text"> |
9878 |
|
<p>INSTRUMENTS_DB |
9879 |
|
|
9880 |
|
</p> |
9881 |
|
</blockquote><p> |
9882 |
|
|
9883 |
|
</p> |
9884 |
|
<p>modal_arg = |
9885 |
|
</p> |
9886 |
|
<blockquote class="text"> |
9887 |
|
<p>/* epsilon (empty argument) */ |
9888 |
|
|
9889 |
|
</p> |
9890 |
|
<p>/ NON_MODAL SP |
9891 |
|
|
9892 |
|
</p> |
9893 |
|
</blockquote><p> |
9894 |
|
|
9895 |
|
</p> |
9896 |
<p>key_val_list = |
<p>key_val_list = |
9897 |
</p> |
</p> |
9898 |
<blockquote class="text"> |
<blockquote class="text"> |
9947 |
<p>/ MIDI_INSTRUMENT_MAPS |
<p>/ MIDI_INSTRUMENT_MAPS |
9948 |
|
|
9949 |
</p> |
</p> |
9950 |
|
<p>/ FX_SENDS SP sampler_channel |
9951 |
|
|
9952 |
|
</p> |
9953 |
|
<p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
9954 |
|
|
9955 |
|
</p> |
9956 |
|
<p>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
9957 |
|
|
9958 |
|
</p> |
9959 |
|
<p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
9960 |
|
|
9961 |
|
</p> |
9962 |
|
<p>/ DB_INSTRUMENTS SP db_path |
9963 |
|
|
9964 |
|
</p> |
9965 |
</blockquote><p> |
</blockquote><p> |
9966 |
|
|
9967 |
</p> |
</p> |
10085 |
</blockquote><p> |
</blockquote><p> |
10086 |
|
|
10087 |
</p> |
</p> |
10088 |
|
<p>midi_ctrl = |
10089 |
|
</p> |
10090 |
|
<blockquote class="text"> |
10091 |
|
<p>number |
10092 |
|
|
10093 |
|
</p> |
10094 |
|
</blockquote><p> |
10095 |
|
|
10096 |
|
</p> |
10097 |
<p>volume_value = |
<p>volume_value = |
10098 |
</p> |
</p> |
10099 |
<blockquote class="text"> |
<blockquote class="text"> |
10124 |
</blockquote><p> |
</blockquote><p> |
10125 |
|
|
10126 |
</p> |
</p> |
10127 |
|
<p>fx_send_id = |
10128 |
|
</p> |
10129 |
|
<blockquote class="text"> |
10130 |
|
<p>number |
10131 |
|
|
10132 |
|
</p> |
10133 |
|
</blockquote><p> |
10134 |
|
|
10135 |
|
</p> |
10136 |
<p>engine_name = |
<p>engine_name = |
10137 |
</p> |
</p> |
10138 |
<blockquote class="text"> |
<blockquote class="text"> |
10145 |
<p>filename = |
<p>filename = |
10146 |
</p> |
</p> |
10147 |
<blockquote class="text"> |
<blockquote class="text"> |
10148 |
<p>stringval |
<p>path |
10149 |
|
|
10150 |
|
</p> |
10151 |
|
</blockquote><p> |
10152 |
|
|
10153 |
|
</p> |
10154 |
|
<p>db_path = |
10155 |
|
</p> |
10156 |
|
<blockquote class="text"> |
10157 |
|
<p>path |
10158 |
|
|
10159 |
</p> |
</p> |
10160 |
</blockquote><p> |
</blockquote><p> |
10163 |
<p>map_name = |
<p>map_name = |
10164 |
</p> |
</p> |
10165 |
<blockquote class="text"> |
<blockquote class="text"> |
10166 |
<p>stringval |
<p>stringval_escaped |
10167 |
|
|
10168 |
</p> |
</p> |
10169 |
</blockquote><p> |
</blockquote><p> |
10172 |
<p>entry_name = |
<p>entry_name = |
10173 |
</p> |
</p> |
10174 |
<blockquote class="text"> |
<blockquote class="text"> |
10175 |
<p>stringval |
<p>stringval_escaped |
10176 |
|
|
10177 |
|
</p> |
10178 |
|
</blockquote><p> |
10179 |
|
|
10180 |
|
</p> |
10181 |
|
<p>fx_send_name = |
10182 |
|
</p> |
10183 |
|
<blockquote class="text"> |
10184 |
|
<p>stringval_escaped |
10185 |
|
|
10186 |
</p> |
</p> |
10187 |
</blockquote><p> |
</blockquote><p> |
10217 |
</blockquote><p> |
</blockquote><p> |
10218 |
|
|
10219 |
</p> |
</p> |
10220 |
|
<p>query_val_list = |
10221 |
|
</p> |
10222 |
|
<blockquote class="text"> |
10223 |
|
<p>string '=' query_val |
10224 |
|
|
10225 |
|
</p> |
10226 |
|
<p>/ query_val_list SP string '=' query_val |
10227 |
|
|
10228 |
|
</p> |
10229 |
|
</blockquote><p> |
10230 |
|
|
10231 |
|
</p> |
10232 |
|
<p>query_val = |
10233 |
|
</p> |
10234 |
|
<blockquote class="text"> |
10235 |
|
<p>text_escaped |
10236 |
|
|
10237 |
|
</p> |
10238 |
|
<p>/ stringval_escaped |
10239 |
|
|
10240 |
|
</p> |
10241 |
|
</blockquote><p> |
10242 |
|
|
10243 |
|
</p> |
10244 |
|
<p>scan_mode = |
10245 |
|
</p> |
10246 |
|
<blockquote class="text"> |
10247 |
|
<p>RECURSIVE |
10248 |
|
|
10249 |
|
</p> |
10250 |
|
<p>/ NON_RECURSIVE |
10251 |
|
|
10252 |
|
</p> |
10253 |
|
<p>/ FLAT |
10254 |
|
|
10255 |
|
</p> |
10256 |
|
</blockquote><p> |
10257 |
|
|
10258 |
|
</p> |
10259 |
|
<a name="character_set"></a><br /><hr /> |
10260 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10261 |
|
<a name="rfc.section.7.1"></a><h3>7.1. |
10262 |
|
Character Set and Escape Sequences</h3> |
10263 |
|
|
10264 |
|
<p>Older versions of this protocol up to and including v1.1 only |
10265 |
|
supported the standard ASCII character set (ASCII code 0 - 127) |
10266 |
|
<a class='info' href='#RFC20'>[RFC20]<span> (</span><span class='info'>UCLA, “ASCII format for Network Interchange,” 1969.</span><span>)</span></a>, all younger versions of this protocol |
10267 |
|
however support the Extended ASCII character set (ASCII code |
10268 |
|
0 - 255). The same group of younger protocols also support |
10269 |
|
escape sequences, but only for certain, explicitly declared |
10270 |
|
parts of the protocol. The supported escape sequences are |
10271 |
|
defined as follows: |
10272 |
|
</p><table class="full" align="center" border="0" cellpadding="2" cellspacing="2"> |
10273 |
|
<col align="left"><col align="left"> |
10274 |
|
<tr><th align="left">ASCII Character Sequence</th><th align="left">Translated into (Name)</th></tr> |
10275 |
|
<tr> |
10276 |
|
<td align="left">\n</td> |
10277 |
|
<td align="left">new line</td> |
10278 |
|
</tr> |
10279 |
|
<tr> |
10280 |
|
<td align="left">\r</td> |
10281 |
|
<td align="left">carriage return</td> |
10282 |
|
</tr> |
10283 |
|
<tr> |
10284 |
|
<td align="left">\f</td> |
10285 |
|
<td align="left">form feed</td> |
10286 |
|
</tr> |
10287 |
|
<tr> |
10288 |
|
<td align="left">\t</td> |
10289 |
|
<td align="left">horizontal tab</td> |
10290 |
|
</tr> |
10291 |
|
<tr> |
10292 |
|
<td align="left">\v</td> |
10293 |
|
<td align="left">vertical tab</td> |
10294 |
|
</tr> |
10295 |
|
<tr> |
10296 |
|
<td align="left">\'</td> |
10297 |
|
<td align="left">apostrophe</td> |
10298 |
|
</tr> |
10299 |
|
<tr> |
10300 |
|
<td align="left">\"</td> |
10301 |
|
<td align="left">quotation mark</td> |
10302 |
|
</tr> |
10303 |
|
<tr> |
10304 |
|
<td align="left">\\</td> |
10305 |
|
<td align="left">backslash</td> |
10306 |
|
</tr> |
10307 |
|
<tr> |
10308 |
|
<td align="left">\OOO</td> |
10309 |
|
<td align="left">three digit octal ASCII code of the character</td> |
10310 |
|
</tr> |
10311 |
|
<tr> |
10312 |
|
<td align="left">\xHH</td> |
10313 |
|
<td align="left">two digit hex ASCII code of the character</td> |
10314 |
|
</tr> |
10315 |
|
</table> |
10316 |
|
|
10317 |
|
<p>Notice: due to the transition of certain parts of the |
10318 |
|
protocol which now support escape sequences, a slight backward |
10319 |
|
incompatibility to protocols version v1.1 and younger has been |
10320 |
|
introduced. The only difference is that in parts of the protocol |
10321 |
|
where escape characters are now supported, a backslash characters |
10322 |
|
MUST be escaped as well (that is as double backslash), whereas |
10323 |
|
in the old versions a single backslash was sufficient. |
10324 |
|
</p> |
10325 |
|
<p>The following LSCP commands support escape sequences as part |
10326 |
|
of their filename / path based arguments and / or may contain |
10327 |
|
a filename / path with escape sequences in their response: |
10328 |
|
</p> |
10329 |
|
<blockquote class="text"> |
10330 |
|
<p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a> |
10331 |
|
</p> |
10332 |
|
<p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a> |
10333 |
|
</p> |
10334 |
|
<p><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> |
10335 |
|
</p> |
10336 |
|
<p><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> |
10337 |
|
</p> |
10338 |
|
<p><a class='info' href='#ADD DB_INSTRUMENT_DIRECTORY'>"ADD DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Creating a new instrument directory</span><span>)</span></a> |
10339 |
|
</p> |
10340 |
|
<p><a class='info' href='#ADD DB_INSTRUMENTS'>"ADD DB_INSTRUMENTS"<span> (</span><span class='info'>Adding instruments to the instruments database</span><span>)</span></a> |
10341 |
|
</p> |
10342 |
|
<p><a class='info' href='#REMOVE DB_INSTRUMENT_DIRECTORY'>"REMOVE DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Deleting an instrument directory</span><span>)</span></a> |
10343 |
|
</p> |
10344 |
|
<p><a class='info' href='#REMOVE DB_INSTRUMENT'>"REMOVE DB_INSTRUMENT"<span> (</span><span class='info'>Removing an instrument</span><span>)</span></a> |
10345 |
|
</p> |
10346 |
|
<p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORIES'>"GET DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Getting amount of instrument directories</span><span>)</span></a> |
10347 |
|
</p> |
10348 |
|
<p><a class='info' href='#LIST DB_INSTRUMENT_DIRECTORIES'>"LIST DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Listing all directories in specific directory</span><span>)</span></a> |
10349 |
|
</p> |
10350 |
|
<p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORY INFO'>"GET DB_INSTRUMENT_DIRECTORY INFO"<span> (</span><span class='info'>Getting instrument directory information</span><span>)</span></a> |
10351 |
|
</p> |
10352 |
|
<p><a class='info' href='#GET DB_INSTRUMENTS'>"GET DB_INSTRUMENTS"<span> (</span><span class='info'>Getting amount of instruments</span><span>)</span></a> |
10353 |
|
</p> |
10354 |
|
<p><a class='info' href='#LIST DB_INSTRUMENTS'>"LIST DB_INSTRUMENTS"<span> (</span><span class='info'>Listing all instruments in specific directory</span><span>)</span></a> |
10355 |
|
</p> |
10356 |
|
<p><a class='info' href='#GET DB_INSTRUMENT INFO'>"GET DB_INSTRUMENT INFO"<span> (</span><span class='info'>Getting instrument information</span><span>)</span></a> |
10357 |
|
</p> |
10358 |
|
<p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY NAME'>"SET DB_INSTRUMENT_DIRECTORY NAME"<span> (</span><span class='info'>Renaming an instrument directory</span><span>)</span></a> |
10359 |
|
</p> |
10360 |
|
<p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION'>"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"<span> (</span><span class='info'>Changing the description of directory</span><span>)</span></a> |
10361 |
|
</p> |
10362 |
|
<p><a class='info' href='#SET DB_INSTRUMENT NAME'>"SET DB_INSTRUMENT NAME"<span> (</span><span class='info'>Renaming an instrument</span><span>)</span></a> |
10363 |
|
</p> |
10364 |
|
<p><a class='info' href='#SET DB_INSTRUMENT DESCRIPTION'>"SET DB_INSTRUMENT DESCRIPTION"<span> (</span><span class='info'>Changing the description of instrument</span><span>)</span></a> |
10365 |
|
</p> |
10366 |
|
<p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a> |
10367 |
|
</p> |
10368 |
|
<p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a> |
10369 |
|
</p> |
10370 |
|
<p><a class='info' href='#MOVE DB_INSTRUMENT'>"MOVE DB_INSTRUMENT"<span> (</span><span class='info'>Moving an instrument</span><span>)</span></a> |
10371 |
|
</p> |
10372 |
|
<p><a class='info' href='#MOVE DB_INSTRUMENT_DIRECTORY'>"MOVE DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Moving an instrument directory</span><span>)</span></a> |
10373 |
|
</p> |
10374 |
|
<p><a class='info' href='#COPY DB_INSTRUMENT'>"COPY DB_INSTRUMENT"<span> (</span><span class='info'>Copying instruments</span><span>)</span></a> |
10375 |
|
</p> |
10376 |
|
<p><a class='info' href='#COPY DB_INSTRUMENT_DIRECTORY'>"COPY DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Copying instrument directories</span><span>)</span></a> |
10377 |
|
</p> |
10378 |
|
</blockquote><p> |
10379 |
|
Note that the forward slash character ('/') has a special meaning in |
10380 |
|
filename / path based arguments: it acts as separator of the nodes in |
10381 |
|
the path, thus if a directory- or filename includes a forward slash |
10382 |
|
(not intended as path node separator), you MUST escape that slash |
10383 |
|
either with the respective hex escape sequence ("\x2f") or with the |
10384 |
|
respective octal escape sequence ("\057"). |
10385 |
|
|
10386 |
|
</p> |
10387 |
|
<p> |
10388 |
|
The following LSCP commands even support escape sequences as |
10389 |
|
part of at least one of their text-based arguments (i.e. entity name, |
10390 |
|
description) and / or may contain escape sequences in at least one of |
10391 |
|
their text-based fields in their response: |
10392 |
|
</p> |
10393 |
|
<blockquote class="text"> |
10394 |
|
<p><a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a> |
10395 |
|
</p> |
10396 |
|
<p><a class='info' href='#GET ENGINE INFO'>"GET ENGINE INFO"<span> (</span><span class='info'>Getting information about an engine</span><span>)</span></a> |
10397 |
|
</p> |
10398 |
|
<p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a> |
10399 |
|
</p> |
10400 |
|
<p><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> |
10401 |
|
</p> |
10402 |
|
<p><a class='info' href='#GET FX_SEND INFO'>"GET FX_SEND INFO"<span> (</span><span class='info'>Getting effect send information</span><span>)</span></a> |
10403 |
|
</p> |
10404 |
|
<p><a class='info' href='#SET FX_SEND NAME'>"SET FX_SEND NAME"<span> (</span><span class='info'>Changing effect send's name</span><span>)</span></a> |
10405 |
|
</p> |
10406 |
|
<p><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> |
10407 |
|
</p> |
10408 |
|
<p><a class='info' href='#GET MIDI_INSTRUMENT_MAP INFO'>"GET MIDI_INSTRUMENT_MAP INFO"<span> (</span><span class='info'>Getting MIDI instrument map information</span><span>)</span></a> |
10409 |
|
</p> |
10410 |
|
<p><a class='info' href='#ADD MIDI_INSTRUMENT_MAP'>"ADD MIDI_INSTRUMENT_MAP"<span> (</span><span class='info'>Create a new MIDI instrument map</span><span>)</span></a> |
10411 |
|
</p> |
10412 |
|
<p><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> |
10413 |
|
</p> |
10414 |
|
<p><a class='info' href='#SET MIDI_INSTRUMENT_MAP NAME'>"SET MIDI_INSTRUMENT_MAP NAME"<span> (</span><span class='info'>Renaming a MIDI instrument map</span><span>)</span></a> |
10415 |
|
</p> |
10416 |
|
<p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORY INFO'>"GET DB_INSTRUMENT_DIRECTORY INFO"<span> (</span><span class='info'>Getting instrument directory information</span><span>)</span></a> |
10417 |
|
</p> |
10418 |
|
<p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY NAME'>"SET DB_INSTRUMENT_DIRECTORY NAME"<span> (</span><span class='info'>Renaming an instrument directory</span><span>)</span></a> |
10419 |
|
</p> |
10420 |
|
<p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION'>"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"<span> (</span><span class='info'>Changing the description of directory</span><span>)</span></a> |
10421 |
|
</p> |
10422 |
|
<p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a> |
10423 |
|
</p> |
10424 |
|
<p><a class='info' href='#GET DB_INSTRUMENT INFO'>"GET DB_INSTRUMENT INFO"<span> (</span><span class='info'>Getting instrument information</span><span>)</span></a> |
10425 |
|
</p> |
10426 |
|
<p><a class='info' href='#SET DB_INSTRUMENT NAME'>"SET DB_INSTRUMENT NAME"<span> (</span><span class='info'>Renaming an instrument</span><span>)</span></a> |
10427 |
|
</p> |
10428 |
|
<p><a class='info' href='#SET DB_INSTRUMENT DESCRIPTION'>"SET DB_INSTRUMENT DESCRIPTION"<span> (</span><span class='info'>Changing the description of instrument</span><span>)</span></a> |
10429 |
|
</p> |
10430 |
|
<p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a> |
10431 |
|
</p> |
10432 |
|
</blockquote><p> |
10433 |
|
Please note that these lists are manually maintained. If you |
10434 |
|
find a command that also supports escape sequences we forgot to |
10435 |
|
mention here, please report it! |
10436 |
|
|
10437 |
|
</p> |
10438 |
<a name="events"></a><br /><hr /> |
<a name="events"></a><br /><hr /> |
10439 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> 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> |
10440 |
<a name="rfc.section.8"></a><h3>8. |
<a name="rfc.section.8"></a><h3>8. |
10442 |
|
|
10443 |
<p>This chapter will describe all currently defined events supported by LinuxSampler. |
<p>This chapter will describe all currently defined events supported by LinuxSampler. |
10444 |
</p> |
</p> |
10445 |
<a name="SUBSCRIBE CHANNEL"></a><br /><hr /> |
<a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"></a><br /><hr /> |
10446 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> 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> |
10447 |
<a name="rfc.section.8.1"></a><h3>8.1. |
<a name="rfc.section.8.1"></a><h3>8.1. |
10448 |
|
Number of audio output devices changed</h3> |
10449 |
|
|
10450 |
|
<p>Client may want to be notified when the total number of audio output devices on the |
10451 |
|
back-end changes by issuing the following command: |
10452 |
|
</p> |
10453 |
|
<p> |
10454 |
|
</p> |
10455 |
|
<blockquote class="text"> |
10456 |
|
<p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT |
10457 |
|
</p> |
10458 |
|
</blockquote><p> |
10459 |
|
|
10460 |
|
</p> |
10461 |
|
<p>Server will start sending the following notification messages: |
10462 |
|
</p> |
10463 |
|
<p> |
10464 |
|
</p> |
10465 |
|
<blockquote class="text"> |
10466 |
|
<p>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>" |
10467 |
|
</p> |
10468 |
|
</blockquote><p> |
10469 |
|
|
10470 |
|
</p> |
10471 |
|
<p>where <devices> will be replaced by the new number |
10472 |
|
of audio output devices. |
10473 |
|
</p> |
10474 |
|
<a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"></a><br /><hr /> |
10475 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10476 |
|
<a name="rfc.section.8.2"></a><h3>8.2. |
10477 |
|
Audio output device's settings changed</h3> |
10478 |
|
|
10479 |
|
<p>Client may want to be notified when changes were made to audio output devices on the |
10480 |
|
back-end by issuing the following command: |
10481 |
|
</p> |
10482 |
|
<p> |
10483 |
|
</p> |
10484 |
|
<blockquote class="text"> |
10485 |
|
<p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO |
10486 |
|
</p> |
10487 |
|
</blockquote><p> |
10488 |
|
|
10489 |
|
</p> |
10490 |
|
<p>Server will start sending the following notification messages: |
10491 |
|
</p> |
10492 |
|
<p> |
10493 |
|
</p> |
10494 |
|
<blockquote class="text"> |
10495 |
|
<p>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>" |
10496 |
|
</p> |
10497 |
|
</blockquote><p> |
10498 |
|
|
10499 |
|
</p> |
10500 |
|
<p>where <device-id> will be replaced by the numerical ID of the audio output device, |
10501 |
|
which settings has been changed. The front-end will have to send |
10502 |
|
the respective command to actually get the audio output device info. Because these messages |
10503 |
|
will be triggered by LSCP commands issued by other clients rather than real |
10504 |
|
time events happening on the server, it is believed that an empty notification |
10505 |
|
message is sufficient here. |
10506 |
|
</p> |
10507 |
|
<a name="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"></a><br /><hr /> |
10508 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10509 |
|
<a name="rfc.section.8.3"></a><h3>8.3. |
10510 |
|
Number of MIDI input devices changed</h3> |
10511 |
|
|
10512 |
|
<p>Client may want to be notified when the total number of MIDI input devices on the |
10513 |
|
back-end changes by issuing the following command: |
10514 |
|
</p> |
10515 |
|
<p> |
10516 |
|
</p> |
10517 |
|
<blockquote class="text"> |
10518 |
|
<p>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT |
10519 |
|
</p> |
10520 |
|
</blockquote><p> |
10521 |
|
|
10522 |
|
</p> |
10523 |
|
<p>Server will start sending the following notification messages: |
10524 |
|
</p> |
10525 |
|
<p> |
10526 |
|
</p> |
10527 |
|
<blockquote class="text"> |
10528 |
|
<p>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>" |
10529 |
|
</p> |
10530 |
|
</blockquote><p> |
10531 |
|
|
10532 |
|
</p> |
10533 |
|
<p>where <devices> will be replaced by the new number |
10534 |
|
of MIDI input devices. |
10535 |
|
</p> |
10536 |
|
<a name="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"></a><br /><hr /> |
10537 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10538 |
|
<a name="rfc.section.8.4"></a><h3>8.4. |
10539 |
|
MIDI input device's settings changed</h3> |
10540 |
|
|
10541 |
|
<p>Client may want to be notified when changes were made to MIDI input devices on the |
10542 |
|
back-end by issuing the following command: |
10543 |
|
</p> |
10544 |
|
<p> |
10545 |
|
</p> |
10546 |
|
<blockquote class="text"> |
10547 |
|
<p>SUBSCRIBE MIDI_INPUT_DEVICE_INFO |
10548 |
|
</p> |
10549 |
|
</blockquote><p> |
10550 |
|
|
10551 |
|
</p> |
10552 |
|
<p>Server will start sending the following notification messages: |
10553 |
|
</p> |
10554 |
|
<p> |
10555 |
|
</p> |
10556 |
|
<blockquote class="text"> |
10557 |
|
<p>"NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>" |
10558 |
|
</p> |
10559 |
|
</blockquote><p> |
10560 |
|
|
10561 |
|
</p> |
10562 |
|
<p>where <device-id> will be replaced by the numerical ID of the MIDI input device, |
10563 |
|
which settings has been changed. The front-end will have to send |
10564 |
|
the respective command to actually get the MIDI input device info. Because these messages |
10565 |
|
will be triggered by LSCP commands issued by other clients rather than real |
10566 |
|
time events happening on the server, it is believed that an empty notification |
10567 |
|
message is sufficient here. |
10568 |
|
</p> |
10569 |
|
<a name="SUBSCRIBE CHANNEL_COUNT"></a><br /><hr /> |
10570 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10571 |
|
<a name="rfc.section.8.5"></a><h3>8.5. |
10572 |
Number of sampler channels changed</h3> |
Number of sampler channels changed</h3> |
10573 |
|
|
10574 |
<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 |
10597 |
</p> |
</p> |
10598 |
<a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr /> |
10599 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> 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> |
10600 |
<a name="rfc.section.8.2"></a><h3>8.2. |
<a name="rfc.section.8.6"></a><h3>8.6. |
10601 |
Number of active voices changed</h3> |
Number of active voices changed</h3> |
10602 |
|
|
10603 |
<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 |
10616 |
<p> |
<p> |
10617 |
</p> |
</p> |
10618 |
<blockquote class="text"> |
<blockquote class="text"> |
10619 |
<p>"NOTIFY:VOICE_COUNT:<sampler-channel> <voices> |
<p>"NOTIFY:VOICE_COUNT:<sampler-channel> <voices>" |
10620 |
</p> |
</p> |
10621 |
</blockquote><p> |
</blockquote><p> |
10622 |
|
|
10627 |
</p> |
</p> |
10628 |
<a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr /> |
10629 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> 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> |
10630 |
<a name="rfc.section.8.3"></a><h3>8.3. |
<a name="rfc.section.8.7"></a><h3>8.7. |
10631 |
Number of active disk streams changed</h3> |
Number of active disk streams changed</h3> |
10632 |
|
|
10633 |
<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 |
10657 |
</p> |
</p> |
10658 |
<a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr /> |
<a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr /> |
10659 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> 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> |
10660 |
<a name="rfc.section.8.4"></a><h3>8.4. |
<a name="rfc.section.8.8"></a><h3>8.8. |
10661 |
Disk stream buffer fill state changed</h3> |
Disk stream buffer fill state changed</h3> |
10662 |
|
|
10663 |
<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 |
10686 |
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> |
10687 |
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. |
10688 |
</p> |
</p> |
10689 |
<a name="SUBSCRIBE INFO"></a><br /><hr /> |
<a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr /> |
10690 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> 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> |
10691 |
<a name="rfc.section.8.5"></a><h3>8.5. |
<a name="rfc.section.8.9"></a><h3>8.9. |
10692 |
Channel information changed</h3> |
Channel information changed</h3> |
10693 |
|
|
10694 |
<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 |
10719 |
time events happening on the server, it is believed that an empty notification |
time events happening on the server, it is believed that an empty notification |
10720 |
message is sufficient here. |
message is sufficient here. |
10721 |
</p> |
</p> |
10722 |
|
<a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr /> |
10723 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10724 |
|
<a name="rfc.section.8.10"></a><h3>8.10. |
10725 |
|
Number of effect sends changed</h3> |
10726 |
|
|
10727 |
|
<p>Client may want to be notified when the number of effect sends on |
10728 |
|
a particular sampler channel is changed by issuing the following command: |
10729 |
|
</p> |
10730 |
|
<p> |
10731 |
|
</p> |
10732 |
|
<blockquote class="text"> |
10733 |
|
<p>SUBSCRIBE FX_SEND_COUNT |
10734 |
|
</p> |
10735 |
|
</blockquote><p> |
10736 |
|
|
10737 |
|
</p> |
10738 |
|
<p>Server will start sending the following notification messages: |
10739 |
|
</p> |
10740 |
|
<p> |
10741 |
|
</p> |
10742 |
|
<blockquote class="text"> |
10743 |
|
<p>"NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>" |
10744 |
|
</p> |
10745 |
|
</blockquote><p> |
10746 |
|
|
10747 |
|
</p> |
10748 |
|
<p>where <channel-id> will be replaced by the numerical ID of the sampler |
10749 |
|
channel, on which the effect sends number is changed and <fx-sends> will |
10750 |
|
be replaced by the new number of effect sends on that channel. |
10751 |
|
</p> |
10752 |
|
<a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr /> |
10753 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10754 |
|
<a name="rfc.section.8.11"></a><h3>8.11. |
10755 |
|
Effect send information changed</h3> |
10756 |
|
|
10757 |
|
<p>Client may want to be notified when changes were made to effect sends on a |
10758 |
|
a particular sampler channel by issuing the following command: |
10759 |
|
</p> |
10760 |
|
<p> |
10761 |
|
</p> |
10762 |
|
<blockquote class="text"> |
10763 |
|
<p>SUBSCRIBE FX_SEND_INFO |
10764 |
|
</p> |
10765 |
|
</blockquote><p> |
10766 |
|
|
10767 |
|
</p> |
10768 |
|
<p>Server will start sending the following notification messages: |
10769 |
|
</p> |
10770 |
|
<p> |
10771 |
|
</p> |
10772 |
|
<blockquote class="text"> |
10773 |
|
<p>"NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>" |
10774 |
|
</p> |
10775 |
|
</blockquote><p> |
10776 |
|
|
10777 |
|
</p> |
10778 |
|
<p>where <channel-id> will be replaced by the numerical ID of the sampler |
10779 |
|
channel, on which an effect send entity is changed and <fx-send-id> will |
10780 |
|
be replaced by the numerical ID of the changed effect send. |
10781 |
|
</p> |
10782 |
<a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr /> |
10783 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> 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> |
10784 |
<a name="rfc.section.8.6"></a><h3>8.6. |
<a name="rfc.section.8.12"></a><h3>8.12. |
10785 |
Total number of active voices changed</h3> |
Total number of active voices changed</h3> |
10786 |
|
|
10787 |
<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 |
10800 |
<p> |
<p> |
10801 |
</p> |
</p> |
10802 |
<blockquote class="text"> |
<blockquote class="text"> |
10803 |
<p>"NOTIFY:TOTAL_VOICE_COUNT:<voices> |
<p>"NOTIFY:TOTAL_VOICE_COUNT:<voices>" |
10804 |
</p> |
</p> |
10805 |
</blockquote><p> |
</blockquote><p> |
10806 |
|
|
10808 |
<p>where <voices> will be replaced by the new number of |
<p>where <voices> will be replaced by the new number of |
10809 |
all currently active voices. |
all currently active voices. |
10810 |
</p> |
</p> |
10811 |
|
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr /> |
10812 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10813 |
|
<a name="rfc.section.8.13"></a><h3>8.13. |
10814 |
|
Number of MIDI instrument maps changed</h3> |
10815 |
|
|
10816 |
|
<p>Client may want to be notified when the number of MIDI instrument maps on the |
10817 |
|
back-end changes by issuing the following command: |
10818 |
|
</p> |
10819 |
|
<p> |
10820 |
|
</p> |
10821 |
|
<blockquote class="text"> |
10822 |
|
<p>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT |
10823 |
|
</p> |
10824 |
|
</blockquote><p> |
10825 |
|
|
10826 |
|
</p> |
10827 |
|
<p>Server will start sending the following notification messages: |
10828 |
|
</p> |
10829 |
|
<p> |
10830 |
|
</p> |
10831 |
|
<blockquote class="text"> |
10832 |
|
<p>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>" |
10833 |
|
</p> |
10834 |
|
</blockquote><p> |
10835 |
|
|
10836 |
|
</p> |
10837 |
|
<p>where <maps> will be replaced by the new number |
10838 |
|
of MIDI instrument maps. |
10839 |
|
</p> |
10840 |
|
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr /> |
10841 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10842 |
|
<a name="rfc.section.8.14"></a><h3>8.14. |
10843 |
|
MIDI instrument map information changed</h3> |
10844 |
|
|
10845 |
|
<p>Client may want to be notified when changes were made to MIDI instrument maps on the |
10846 |
|
back-end by issuing the following command: |
10847 |
|
</p> |
10848 |
|
<p> |
10849 |
|
</p> |
10850 |
|
<blockquote class="text"> |
10851 |
|
<p>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO |
10852 |
|
</p> |
10853 |
|
</blockquote><p> |
10854 |
|
|
10855 |
|
</p> |
10856 |
|
<p>Server will start sending the following notification messages: |
10857 |
|
</p> |
10858 |
|
<p> |
10859 |
|
</p> |
10860 |
|
<blockquote class="text"> |
10861 |
|
<p>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>" |
10862 |
|
</p> |
10863 |
|
</blockquote><p> |
10864 |
|
|
10865 |
|
</p> |
10866 |
|
<p>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
10867 |
|
for which information changes occurred. The front-end will have to send |
10868 |
|
the respective command to actually get the MIDI instrument map info. Because these messages |
10869 |
|
will be triggered by LSCP commands issued by other clients rather than real |
10870 |
|
time events happening on the server, it is believed that an empty notification |
10871 |
|
message is sufficient here. |
10872 |
|
</p> |
10873 |
|
<a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr /> |
10874 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10875 |
|
<a name="rfc.section.8.15"></a><h3>8.15. |
10876 |
|
Number of MIDI instruments changed</h3> |
10877 |
|
|
10878 |
|
<p>Client may want to be notified when the number of MIDI instrument maps on the |
10879 |
|
back-end changes by issuing the following command: |
10880 |
|
</p> |
10881 |
|
<p> |
10882 |
|
</p> |
10883 |
|
<blockquote class="text"> |
10884 |
|
<p>SUBSCRIBE MIDI_INSTRUMENT_COUNT |
10885 |
|
</p> |
10886 |
|
</blockquote><p> |
10887 |
|
|
10888 |
|
</p> |
10889 |
|
<p>Server will start sending the following notification messages: |
10890 |
|
</p> |
10891 |
|
<p> |
10892 |
|
</p> |
10893 |
|
<blockquote class="text"> |
10894 |
|
<p>"NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>" |
10895 |
|
</p> |
10896 |
|
</blockquote><p> |
10897 |
|
|
10898 |
|
</p> |
10899 |
|
<p>where <map-id> is the numerical ID of the MIDI instrument map, in which |
10900 |
|
the nuber of instruments has changed and <instruments> will be replaced by |
10901 |
|
the new number of MIDI instruments in the specified map. |
10902 |
|
</p> |
10903 |
|
<a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr /> |
10904 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10905 |
|
<a name="rfc.section.8.16"></a><h3>8.16. |
10906 |
|
MIDI instrument information changed</h3> |
10907 |
|
|
10908 |
|
<p>Client may want to be notified when changes were made to MIDI instruments on the |
10909 |
|
back-end by issuing the following command: |
10910 |
|
</p> |
10911 |
|
<p> |
10912 |
|
</p> |
10913 |
|
<blockquote class="text"> |
10914 |
|
<p>SUBSCRIBE MIDI_INSTRUMENT_INFO |
10915 |
|
</p> |
10916 |
|
</blockquote><p> |
10917 |
|
|
10918 |
|
</p> |
10919 |
|
<p>Server will start sending the following notification messages: |
10920 |
|
</p> |
10921 |
|
<p> |
10922 |
|
</p> |
10923 |
|
<blockquote class="text"> |
10924 |
|
<p>"NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>" |
10925 |
|
</p> |
10926 |
|
</blockquote><p> |
10927 |
|
|
10928 |
|
</p> |
10929 |
|
<p>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
10930 |
|
in which a MIDI instrument is changed. <bank> and <program> specifies |
10931 |
|
the location of the changed MIDI instrument in the map. The front-end will have to send |
10932 |
|
the respective command to actually get the MIDI instrument info. Because these messages |
10933 |
|
will be triggered by LSCP commands issued by other clients rather than real |
10934 |
|
time events happening on the server, it is believed that an empty notification |
10935 |
|
message is sufficient here. |
10936 |
|
</p> |
10937 |
|
<a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr /> |
10938 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10939 |
|
<a name="rfc.section.8.17"></a><h3>8.17. |
10940 |
|
Global settings changed</h3> |
10941 |
|
|
10942 |
|
<p>Client may want to be notified when changes to the global settings |
10943 |
|
of the sampler were made by issuing the following command: |
10944 |
|
</p> |
10945 |
|
<p> |
10946 |
|
</p> |
10947 |
|
<blockquote class="text"> |
10948 |
|
<p>SUBSCRIBE GLOBAL_INFO |
10949 |
|
</p> |
10950 |
|
</blockquote><p> |
10951 |
|
|
10952 |
|
</p> |
10953 |
|
<p>Server will start sending the following types of notification messages: |
10954 |
|
</p> |
10955 |
|
<p> |
10956 |
|
</p> |
10957 |
|
<blockquote class="text"> |
10958 |
|
<p>"NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the |
10959 |
|
golbal volume of the sampler is changed, where <volume> will be |
10960 |
|
replaced by the optional dotted floating point value, reflecting the |
10961 |
|
new global volume parameter. |
10962 |
|
</p> |
10963 |
|
</blockquote><p> |
10964 |
|
|
10965 |
|
</p> |
10966 |
|
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
10967 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10968 |
|
<a name="rfc.section.8.18"></a><h3>8.18. |
10969 |
|
Number of database instrument directories changed</h3> |
10970 |
|
|
10971 |
|
<p>Client may want to be notified when the number of instrument |
10972 |
|
directories in a particular directory in the instruments database |
10973 |
|
is changed by issuing the following command: |
10974 |
|
</p> |
10975 |
|
<p> |
10976 |
|
</p> |
10977 |
|
<blockquote class="text"> |
10978 |
|
<p>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT |
10979 |
|
</p> |
10980 |
|
</blockquote><p> |
10981 |
|
|
10982 |
|
</p> |
10983 |
|
<p>Server will start sending the following notification messages: |
10984 |
|
</p> |
10985 |
|
<p> |
10986 |
|
</p> |
10987 |
|
<blockquote class="text"> |
10988 |
|
<p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>" |
10989 |
|
</p> |
10990 |
|
</blockquote><p> |
10991 |
|
|
10992 |
|
</p> |
10993 |
|
<p>where <dir-path> will be replaced by the absolute path |
10994 |
|
name of the directory in the instruments database, |
10995 |
|
in which the number of directories is changed. |
10996 |
|
</p> |
10997 |
|
<p>Note that when a non-empty directory is removed, this event |
10998 |
|
is not sent for the subdirectories in that directory. |
10999 |
|
</p> |
11000 |
|
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr /> |
11001 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11002 |
|
<a name="rfc.section.8.19"></a><h3>8.19. |
11003 |
|
Database instrument directory information changed</h3> |
11004 |
|
|
11005 |
|
<p>Client may want to be notified when changes were made to directories |
11006 |
|
in the instruments database by issuing the following command: |
11007 |
|
</p> |
11008 |
|
<p> |
11009 |
|
</p> |
11010 |
|
<blockquote class="text"> |
11011 |
|
<p>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO |
11012 |
|
</p> |
11013 |
|
</blockquote><p> |
11014 |
|
|
11015 |
|
</p> |
11016 |
|
<p>Server will start sending the following notification messages: |
11017 |
|
</p> |
11018 |
|
<p> |
11019 |
|
</p> |
11020 |
|
<blockquote class="text"> |
11021 |
|
<p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:<dir-path>" |
11022 |
|
</p> |
11023 |
|
</blockquote><p> |
11024 |
|
|
11025 |
|
</p> |
11026 |
|
<p>where <dir-path> will be replaced by the absolute path name |
11027 |
|
of the directory, for which information changes occurred. The front-end will have to send |
11028 |
|
the respective command to actually get the updated directory info. Because these messages |
11029 |
|
will be triggered by LSCP commands issued by other clients rather than real |
11030 |
|
time events happening on the server, it is believed that an empty notification |
11031 |
|
message is sufficient here. |
11032 |
|
</p> |
11033 |
|
<p> |
11034 |
|
</p> |
11035 |
|
<blockquote class="text"> |
11036 |
|
<p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME <old-dir-path> <new-name>" |
11037 |
|
</p> |
11038 |
|
</blockquote><p> |
11039 |
|
|
11040 |
|
</p> |
11041 |
|
<p>where <old-dir-path> is the old absolute path name of the directory |
11042 |
|
(encapsulated into apostrophes), which name is changes and <new-name> is |
11043 |
|
the new name of the directory, encapsulated into apostrophes. |
11044 |
|
</p> |
11045 |
|
<a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr /> |
11046 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11047 |
|
<a name="rfc.section.8.20"></a><h3>8.20. |
11048 |
|
Number of database instruments changed</h3> |
11049 |
|
|
11050 |
|
<p>Client may want to be notified when the number of instruments |
11051 |
|
in a particular directory in the instruments database |
11052 |
|
is changed by issuing the following command: |
11053 |
|
</p> |
11054 |
|
<p> |
11055 |
|
</p> |
11056 |
|
<blockquote class="text"> |
11057 |
|
<p>SUBSCRIBE DB_INSTRUMENT_COUNT |
11058 |
|
</p> |
11059 |
|
</blockquote><p> |
11060 |
|
|
11061 |
|
</p> |
11062 |
|
<p>Server will start sending the following notification messages: |
11063 |
|
</p> |
11064 |
|
<p> |
11065 |
|
</p> |
11066 |
|
<blockquote class="text"> |
11067 |
|
<p>"NOTIFY:DB_INSTRUMENT_COUNT:<dir-path>" |
11068 |
|
</p> |
11069 |
|
</blockquote><p> |
11070 |
|
|
11071 |
|
</p> |
11072 |
|
<p>where <dir-path> will be replaced by the absolute path |
11073 |
|
name of the directory in the instruments database, |
11074 |
|
in which the number of instruments is changed. |
11075 |
|
</p> |
11076 |
|
<p>Note that when a non-empty directory is removed, this event |
11077 |
|
is not sent for the instruments in that directory. |
11078 |
|
</p> |
11079 |
|
<a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr /> |
11080 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11081 |
|
<a name="rfc.section.8.21"></a><h3>8.21. |
11082 |
|
Database instrument information changed</h3> |
11083 |
|
|
11084 |
|
<p>Client may want to be notified when changes were made to instruments |
11085 |
|
in the instruments database by issuing the following command: |
11086 |
|
</p> |
11087 |
|
<p> |
11088 |
|
</p> |
11089 |
|
<blockquote class="text"> |
11090 |
|
<p>SUBSCRIBE DB_INSTRUMENT_INFO |
11091 |
|
</p> |
11092 |
|
</blockquote><p> |
11093 |
|
|
11094 |
|
</p> |
11095 |
|
<p>Server will start sending the following notification messages: |
11096 |
|
</p> |
11097 |
|
<p> |
11098 |
|
</p> |
11099 |
|
<blockquote class="text"> |
11100 |
|
<p>"NOTIFY:DB_INSTRUMENT_INFO:<instr-path>" |
11101 |
|
</p> |
11102 |
|
</blockquote><p> |
11103 |
|
|
11104 |
|
</p> |
11105 |
|
<p>where <instr-path> will be replaced by the absolute path name |
11106 |
|
of the instrument, which settings are changed. The front-end will have to send |
11107 |
|
the respective command to actually get the updated directory info. Because these messages |
11108 |
|
will be triggered by LSCP commands issued by other clients rather than real |
11109 |
|
time events happening on the server, it is believed that an empty notification |
11110 |
|
message is sufficient here. |
11111 |
|
</p> |
11112 |
|
<p> |
11113 |
|
</p> |
11114 |
|
<blockquote class="text"> |
11115 |
|
<p>"NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>" |
11116 |
|
</p> |
11117 |
|
</blockquote><p> |
11118 |
|
|
11119 |
|
</p> |
11120 |
|
<p>where <old-instr-path> is the old absolute path name of the instrument |
11121 |
|
(encapsulated into apostrophes), which name is changes and <new-name> is |
11122 |
|
the new name of the instrument, encapsulated into apostrophes. |
11123 |
|
</p> |
11124 |
|
<a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr /> |
11125 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11126 |
|
<a name="rfc.section.8.22"></a><h3>8.22. |
11127 |
|
Database job status information changed</h3> |
11128 |
|
|
11129 |
|
<p>Client may want to be notified when the status of particular database |
11130 |
|
instruments job is changed by issuing the following command: |
11131 |
|
</p> |
11132 |
|
<p> |
11133 |
|
</p> |
11134 |
|
<blockquote class="text"> |
11135 |
|
<p>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO |
11136 |
|
</p> |
11137 |
|
</blockquote><p> |
11138 |
|
|
11139 |
|
</p> |
11140 |
|
<p>Server will start sending the following notification messages: |
11141 |
|
</p> |
11142 |
|
<p> |
11143 |
|
</p> |
11144 |
|
<blockquote class="text"> |
11145 |
|
<p>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>" |
11146 |
|
</p> |
11147 |
|
</blockquote><p> |
11148 |
|
|
11149 |
|
</p> |
11150 |
|
<p>where <job-id> will be replaced by the numerical ID of the job, |
11151 |
|
which status is changed. The front-end will have to send the respective |
11152 |
|
command to actually get the status info. Because these messages |
11153 |
|
will be triggered by LSCP commands issued by other clients rather than real |
11154 |
|
time events happening on the server, it is believed that an empty notification |
11155 |
|
message is sufficient here. |
11156 |
|
</p> |
11157 |
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr /> |
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr /> |
11158 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> 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> |
11159 |
<a name="rfc.section.8.7"></a><h3>8.7. |
<a name="rfc.section.8.23"></a><h3>8.23. |
11160 |
Miscellaneous and debugging events</h3> |
Miscellaneous and debugging events</h3> |
11161 |
|
|
11162 |
<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 |
11221 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> 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> |
11222 |
<h3>11. References</h3> |
<h3>11. References</h3> |
11223 |
<table width="99%" border="0"> |
<table width="99%" border="0"> |
11224 |
|
<tr><td class="author-text" valign="top"><a name="RFC20">[RFC20]</a></td> |
11225 |
|
<td class="author-text">UCLA, “<a href="ftp://ftp.isi.edu/in-notes/rfc20.txt">ASCII format for Network Interchange</a>,” RFC 20, 1969.</td></tr> |
11226 |
<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> |
11227 |
<td class="author-text">Bradner, S., “<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">Key words for use in RFCs to Indicate Requirement Levels</a>,” RFC 2119, 1997.</td></tr> |
<td class="author-text">Bradner, S., “<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">Key words for use in RFCs to Indicate Requirement Levels</a>,” RFC 2119, 1997.</td></tr> |
11228 |
<tr><td class="author-text" valign="top"><a name="RFC2234">[RFC2234]</a></td> |
<tr><td class="author-text" valign="top"><a name="RFC2234">[RFC2234]</a></td> |
11253 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> 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> |
11254 |
<h3>Full Copyright Statement</h3> |
<h3>Full Copyright Statement</h3> |
11255 |
<p class='copyright'> |
<p class='copyright'> |
11256 |
Copyright © The Internet Society (2006).</p> |
Copyright © The IETF Trust (2007).</p> |
11257 |
<p class='copyright'> |
<p class='copyright'> |
11258 |
This document is subject to the rights, |
This document is subject to the rights, |
11259 |
licenses and restrictions contained in BCP 78, |
licenses and restrictions contained in BCP 78, |
11262 |
<p class='copyright'> |
<p class='copyright'> |
11263 |
This document and the information contained herein are provided |
This document and the information contained herein are provided |
11264 |
on an “AS IS” basis and THE CONTRIBUTOR, |
on an “AS IS” basis and THE CONTRIBUTOR, |
11265 |
THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), |
THE ORGANIZATION HE/SHE REPRESENTS |
11266 |
THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM |
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST |
11267 |
ALL WARRANTIES, |
AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, |
11268 |
EXPRESS OR IMPLIED, |
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT |
11269 |
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE |
THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY |
11270 |
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED |
IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR |
11271 |
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.</p> |
PURPOSE.</p> |
11272 |
<h3>Intellectual Property</h3> |
<h3>Intellectual Property</h3> |
11273 |
<p class='copyright'> |
<p class='copyright'> |
11274 |
The IETF takes no position regarding the validity or scope of any |
The IETF takes no position regarding the validity or scope of any |
11300 |
Funding for the RFC Editor function is provided by |
Funding for the RFC Editor function is provided by |
11301 |
the IETF Administrative Support Activity (IASA).</p> |
the IETF Administrative Support Activity (IASA).</p> |
11302 |
</body></html> |
</body></html> |
11303 |
|
|