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: April 17, 2008</td><td class="header">October 15, 2007</td></tr> |
<tr><td class="header">Expires: June 7, 2008</td><td class="header">December 5, 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.3</h1> |
151 |
|
|
152 |
<h3>Status of this Memo</h3> |
<h3>Status of this Memo</h3> |
153 |
<p> |
<p> |
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 April 17, 2008.</p> |
This Internet-Draft will expire on June 7, 2008.</p> |
177 |
|
|
178 |
<h3>Copyright Notice</h3> |
<h3>Copyright Notice</h3> |
179 |
<p> |
<p> |
354 |
Current number of active voices<br /> |
Current number of active voices<br /> |
355 |
<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a> |
<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a> |
356 |
Maximum amount of active voices<br /> |
Maximum amount of active voices<br /> |
357 |
<a href="#RESET">6.6.3.</a> |
<a href="#GET TOTAL_STREAM_COUNT">6.6.3.</a> |
358 |
|
Current number of active disk streams<br /> |
359 |
|
<a href="#RESET">6.6.4.</a> |
360 |
Reset sampler<br /> |
Reset sampler<br /> |
361 |
<a href="#GET SERVER INFO">6.6.4.</a> |
<a href="#GET SERVER INFO">6.6.5.</a> |
362 |
General sampler informations<br /> |
General sampler informations<br /> |
363 |
<a href="#GET VOLUME">6.6.5.</a> |
<a href="#GET VOLUME">6.6.6.</a> |
364 |
Getting global volume attenuation<br /> |
Getting global volume attenuation<br /> |
365 |
<a href="#SET VOLUME">6.6.6.</a> |
<a href="#SET VOLUME">6.6.7.</a> |
366 |
Setting global volume attenuation<br /> |
Setting global volume attenuation<br /> |
367 |
<a href="#MIDI Instrument Mapping">6.7.</a> |
<a href="#MIDI Instrument Mapping">6.7.</a> |
368 |
MIDI Instrument Mapping<br /> |
MIDI Instrument Mapping<br /> |
440 |
Editing Instruments<br /> |
Editing Instruments<br /> |
441 |
<a href="#EDIT INSTRUMENT">6.9.1.</a> |
<a href="#EDIT INSTRUMENT">6.9.1.</a> |
442 |
Opening an appropriate instrument editor application<br /> |
Opening an appropriate instrument editor application<br /> |
443 |
|
<a href="#file_management">6.10.</a> |
444 |
|
Managing Files<br /> |
445 |
|
<a href="#GET FILE INSTRUMENTS">6.10.1.</a> |
446 |
|
Retrieving amount of instruments of a file<br /> |
447 |
|
<a href="#LIST FILE INSTRUMENTS">6.10.2.</a> |
448 |
|
Retrieving all instruments of a file<br /> |
449 |
|
<a href="#GET FILE INSTRUMENT INFO">6.10.3.</a> |
450 |
|
Retrieving informations about one instrument in a file<br /> |
451 |
<a href="#command_syntax">7.</a> |
<a href="#command_syntax">7.</a> |
452 |
Command Syntax<br /> |
Command Syntax<br /> |
453 |
<a href="#character_set">7.1.</a> |
<a href="#character_set">7.1.</a> |
478 |
Effect send information changed<br /> |
Effect send information changed<br /> |
479 |
<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a> |
<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a> |
480 |
Total number of active voices changed<br /> |
Total number of active voices changed<br /> |
481 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.13.</a> |
<a href="#SUBSCRIBE TOTAL_STREAM_COUNT">8.13.</a> |
482 |
|
Total number of active disk streams changed<br /> |
483 |
|
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.14.</a> |
484 |
Number of MIDI instrument maps changed<br /> |
Number of MIDI instrument maps changed<br /> |
485 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.14.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.15.</a> |
486 |
MIDI instrument map information changed<br /> |
MIDI instrument map information changed<br /> |
487 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.15.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.16.</a> |
488 |
Number of MIDI instruments changed<br /> |
Number of MIDI instruments changed<br /> |
489 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.16.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.17.</a> |
490 |
MIDI instrument information changed<br /> |
MIDI instrument information changed<br /> |
491 |
<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a> |
<a href="#SUBSCRIBE GLOBAL_INFO">8.18.</a> |
492 |
Global settings changed<br /> |
Global settings changed<br /> |
493 |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.18.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.19.</a> |
494 |
Number of database instrument directories changed<br /> |
Number of database instrument directories changed<br /> |
495 |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.19.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.20.</a> |
496 |
Database instrument directory information changed<br /> |
Database instrument directory information changed<br /> |
497 |
<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.20.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.21.</a> |
498 |
Number of database instruments changed<br /> |
Number of database instruments changed<br /> |
499 |
<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.21.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.22.</a> |
500 |
Database instrument information changed<br /> |
Database instrument information changed<br /> |
501 |
<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.22.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.23.</a> |
502 |
Database job status information changed<br /> |
Database job status information changed<br /> |
503 |
<a href="#SUBSCRIBE MISCELLANEOUS">8.23.</a> |
<a href="#SUBSCRIBE MISCELLANEOUS">8.24.</a> |
504 |
Miscellaneous and debugging events<br /> |
Miscellaneous and debugging events<br /> |
505 |
<a href="#anchor14">9.</a> |
<a href="#anchor14">9.</a> |
506 |
Security Considerations<br /> |
Security Considerations<br /> |
3461 |
</blockquote><p> |
</blockquote><p> |
3462 |
|
|
3463 |
</p> |
</p> |
3464 |
<p>Example: |
<p>Example (Unix): |
3465 |
</p> |
</p> |
3466 |
<p> |
<p> |
3467 |
</p> |
</p> |
3468 |
<blockquote class="text"> |
<blockquote class="text"> |
3469 |
|
<p>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0 |
3470 |
|
</p> |
3471 |
|
<p>S: OK |
3472 |
|
</p> |
3473 |
|
</blockquote><p> |
3474 |
|
|
3475 |
|
</p> |
3476 |
|
<p>Example (Windows): |
3477 |
|
</p> |
3478 |
<p> |
<p> |
3479 |
|
</p> |
3480 |
|
<blockquote class="text"> |
3481 |
|
<p>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0 |
3482 |
|
</p> |
3483 |
|
<p>S: OK |
3484 |
</p> |
</p> |
3485 |
</blockquote><p> |
</blockquote><p> |
3486 |
|
|
6078 |
</blockquote><p> |
</blockquote><p> |
6079 |
|
|
6080 |
</p> |
</p> |
6081 |
<a name="RESET"></a><br /><hr /> |
<a name="GET TOTAL_STREAM_COUNT"></a><br /><hr /> |
6082 |
<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> |
6083 |
<a name="rfc.section.6.6.3"></a><h3>6.6.3. |
<a name="rfc.section.6.6.3"></a><h3>6.6.3. |
6084 |
|
Current number of active disk streams</h3> |
6085 |
|
|
6086 |
|
<p>The front-end can ask for the current number of active disk streams on |
6087 |
|
the sampler by sending the following command: |
6088 |
|
</p> |
6089 |
|
<p> |
6090 |
|
</p> |
6091 |
|
<blockquote class="text"> |
6092 |
|
<p>GET TOTAL_STREAM_COUNT |
6093 |
|
</p> |
6094 |
|
</blockquote><p> |
6095 |
|
|
6096 |
|
</p> |
6097 |
|
<p>Possible Answers: |
6098 |
|
</p> |
6099 |
|
<p> |
6100 |
|
</p> |
6101 |
|
<blockquote class="text"> |
6102 |
|
<p>LinuxSampler will answer by returning the number of all active |
6103 |
|
disk streams on the sampler. |
6104 |
|
</p> |
6105 |
|
</blockquote><p> |
6106 |
|
|
6107 |
|
</p> |
6108 |
|
<a name="RESET"></a><br /><hr /> |
6109 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6110 |
|
<a name="rfc.section.6.6.4"></a><h3>6.6.4. |
6111 |
Reset sampler</h3> |
Reset sampler</h3> |
6112 |
|
|
6113 |
<p>The front-end can reset the whole sampler by sending the following command: |
<p>The front-end can reset the whole sampler by sending the following command: |
6148 |
</p> |
</p> |
6149 |
<a name="GET SERVER INFO"></a><br /><hr /> |
<a name="GET SERVER INFO"></a><br /><hr /> |
6150 |
<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> |
6151 |
<a name="rfc.section.6.6.4"></a><h3>6.6.4. |
<a name="rfc.section.6.6.5"></a><h3>6.6.5. |
6152 |
General sampler informations</h3> |
General sampler informations</h3> |
6153 |
|
|
6154 |
<p>The client can ask for general informations about the LinuxSampler |
<p>The client can ask for general informations about the LinuxSampler |
6224 |
</p> |
</p> |
6225 |
<a name="GET VOLUME"></a><br /><hr /> |
<a name="GET VOLUME"></a><br /><hr /> |
6226 |
<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> |
6227 |
<a name="rfc.section.6.6.5"></a><h3>6.6.5. |
<a name="rfc.section.6.6.6"></a><h3>6.6.6. |
6228 |
Getting global volume attenuation</h3> |
Getting global volume attenuation</h3> |
6229 |
|
|
6230 |
<p>The client can ask for the current global sampler-wide volume |
<p>The client can ask for the current global sampler-wide volume |
6257 |
</p> |
</p> |
6258 |
<a name="SET VOLUME"></a><br /><hr /> |
<a name="SET VOLUME"></a><br /><hr /> |
6259 |
<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> |
6260 |
<a name="rfc.section.6.6.6"></a><h3>6.6.6. |
<a name="rfc.section.6.6.7"></a><h3>6.6.7. |
6261 |
Setting global volume attenuation</h3> |
Setting global volume attenuation</h3> |
6262 |
|
|
6263 |
<p>The client can alter the current global sampler-wide volume |
<p>The client can alter the current global sampler-wide volume |
8718 |
|
|
8719 |
</p> |
</p> |
8720 |
<p>Where <instr> is the absolute path name of the instrument and |
<p>Where <instr> is the absolute path name of the instrument and |
8721 |
<desc> is the new description for the instrument |
<desc> is the new description for the instrument |
8722 |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
8723 |
"<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>"). |
"<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>"). |
8724 |
</p> |
</p> |
9201 |
</blockquote><p> |
</blockquote><p> |
9202 |
|
|
9203 |
</p> |
</p> |
9204 |
|
<a name="file_management"></a><br /><hr /> |
9205 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9206 |
|
<a name="rfc.section.6.10"></a><h3>6.10. |
9207 |
|
Managing Files</h3> |
9208 |
|
|
9209 |
|
<p>You can query detailed informations about files located |
9210 |
|
at the same system where the sampler instance is running on. |
9211 |
|
Using this command set allows to retrieve file informations |
9212 |
|
even remotely from another machine. |
9213 |
|
</p> |
9214 |
|
<a name="GET FILE INSTRUMENTS"></a><br /><hr /> |
9215 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9216 |
|
<a name="rfc.section.6.10.1"></a><h3>6.10.1. |
9217 |
|
Retrieving amount of instruments of a file</h3> |
9218 |
|
|
9219 |
|
<p>The front-end can retrieve the amount of instruments |
9220 |
|
within a given instrument file by sending the |
9221 |
|
following command: |
9222 |
|
</p> |
9223 |
|
<p> |
9224 |
|
</p> |
9225 |
|
<blockquote class="text"> |
9226 |
|
<p>GET FILE INSTRUMENTS <filename> |
9227 |
|
</p> |
9228 |
|
</blockquote><p> |
9229 |
|
|
9230 |
|
</p> |
9231 |
|
<p>Where <filename> is the name of the instrument |
9232 |
|
file (encapsulated into apostrophes, supporting escape |
9233 |
|
sequences as described in chapter |
9234 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
9235 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
9236 |
|
</p> |
9237 |
|
<p>The sampler will try to ask all sampler engines, |
9238 |
|
whether they support the given file and ask the first |
9239 |
|
engine with a positive answer for the amount of |
9240 |
|
instruments. |
9241 |
|
</p> |
9242 |
|
<p>Possible Answers: |
9243 |
|
</p> |
9244 |
|
<p> |
9245 |
|
</p> |
9246 |
|
<blockquote class="text"> |
9247 |
|
<p>On success, the sampler will answer by |
9248 |
|
returning the amount of instruments. |
9249 |
|
|
9250 |
|
</p> |
9251 |
|
<p>"ERR:<error-code>:<error-message>" - |
9252 |
|
</p> |
9253 |
|
<blockquote class="text"> |
9254 |
|
<p>if the file could not be handled |
9255 |
|
</p> |
9256 |
|
</blockquote> |
9257 |
|
|
9258 |
|
|
9259 |
|
</blockquote><p> |
9260 |
|
|
9261 |
|
</p> |
9262 |
|
<p>Examples: |
9263 |
|
</p> |
9264 |
|
<p> |
9265 |
|
</p> |
9266 |
|
<blockquote class="text"> |
9267 |
|
<p>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'" |
9268 |
|
</p> |
9269 |
|
<p>S: "10" |
9270 |
|
</p> |
9271 |
|
</blockquote><p> |
9272 |
|
|
9273 |
|
</p> |
9274 |
|
<a name="LIST FILE INSTRUMENTS"></a><br /><hr /> |
9275 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9276 |
|
<a name="rfc.section.6.10.2"></a><h3>6.10.2. |
9277 |
|
Retrieving all instruments of a file</h3> |
9278 |
|
|
9279 |
|
<p>The front-end can retrieve a list of all instruments |
9280 |
|
within a given instrument file by sending the |
9281 |
|
following command: |
9282 |
|
</p> |
9283 |
|
<p> |
9284 |
|
</p> |
9285 |
|
<blockquote class="text"> |
9286 |
|
<p>LIST FILE INSTRUMENTS <filename> |
9287 |
|
</p> |
9288 |
|
</blockquote><p> |
9289 |
|
|
9290 |
|
</p> |
9291 |
|
<p>Where <filename> is the name of the instrument |
9292 |
|
file (encapsulated into apostrophes, supporting escape |
9293 |
|
sequences as described in chapter |
9294 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
9295 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
9296 |
|
</p> |
9297 |
|
<p>The sampler will try to ask all sampler engines, |
9298 |
|
whether they support the given file and ask the first |
9299 |
|
engine with a positive answer for a list of IDs for the |
9300 |
|
instruments in the given file. |
9301 |
|
</p> |
9302 |
|
<p>Possible Answers: |
9303 |
|
</p> |
9304 |
|
<p> |
9305 |
|
</p> |
9306 |
|
<blockquote class="text"> |
9307 |
|
<p>On success, the sampler will answer by |
9308 |
|
returning a comma separated list of |
9309 |
|
instrument IDs. |
9310 |
|
|
9311 |
|
</p> |
9312 |
|
<p>"ERR:<error-code>:<error-message>" - |
9313 |
|
</p> |
9314 |
|
<blockquote class="text"> |
9315 |
|
<p>if the file could not be handled |
9316 |
|
</p> |
9317 |
|
</blockquote> |
9318 |
|
|
9319 |
|
|
9320 |
|
</blockquote><p> |
9321 |
|
|
9322 |
|
</p> |
9323 |
|
<p>Examples: |
9324 |
|
</p> |
9325 |
|
<p> |
9326 |
|
</p> |
9327 |
|
<blockquote class="text"> |
9328 |
|
<p>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'" |
9329 |
|
</p> |
9330 |
|
<p>S: "0,1,2,3,4,5,6,7,8,9" |
9331 |
|
</p> |
9332 |
|
</blockquote><p> |
9333 |
|
|
9334 |
|
</p> |
9335 |
|
<a name="GET FILE INSTRUMENT INFO"></a><br /><hr /> |
9336 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9337 |
|
<a name="rfc.section.6.10.3"></a><h3>6.10.3. |
9338 |
|
Retrieving informations about one instrument in a file</h3> |
9339 |
|
|
9340 |
|
<p>The front-end can retrieve detailed informations |
9341 |
|
about a specific instrument within a given instrument |
9342 |
|
file by sending the following command: |
9343 |
|
</p> |
9344 |
|
<p> |
9345 |
|
</p> |
9346 |
|
<blockquote class="text"> |
9347 |
|
<p>GET FILE INSTRUMENT INFO <filename> |
9348 |
|
<instr-id> |
9349 |
|
</p> |
9350 |
|
</blockquote><p> |
9351 |
|
|
9352 |
|
</p> |
9353 |
|
<p>Where <filename> is the name of the instrument |
9354 |
|
file (encapsulated into apostrophes, supporting escape |
9355 |
|
sequences as described in chapter |
9356 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
9357 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") and <instr-id> is the numeric |
9358 |
|
instrument ID as returned by the |
9359 |
|
<a class='info' href='#LIST FILE INSTRUMENTS'>"LIST FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving all instruments of a file</span><span>)</span></a> command. |
9360 |
|
</p> |
9361 |
|
<p>The sampler will try to ask all sampler engines, |
9362 |
|
whether they support the given file and ask the first |
9363 |
|
engine with a positive answer for informations about the |
9364 |
|
specific instrument in the given file. |
9365 |
|
</p> |
9366 |
|
<p>Possible Answers: |
9367 |
|
</p> |
9368 |
|
<p> |
9369 |
|
</p> |
9370 |
|
<blockquote class="text"> |
9371 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
9372 |
|
Each answer line begins with the settings category name |
9373 |
|
followed by a colon and then a space character <SP> and finally |
9374 |
|
the info character string to that setting category. At the |
9375 |
|
moment the following categories are defined: |
9376 |
|
</p> |
9377 |
|
<p> |
9378 |
|
</p> |
9379 |
|
<blockquote class="text"> |
9380 |
|
<p>NAME - |
9381 |
|
</p> |
9382 |
|
<blockquote class="text"> |
9383 |
|
<p>name of the instrument as |
9384 |
|
stored in the instrument file |
9385 |
|
</p> |
9386 |
|
</blockquote> |
9387 |
|
|
9388 |
|
|
9389 |
|
<p>FORMAT_FAMILY - |
9390 |
|
</p> |
9391 |
|
<blockquote class="text"> |
9392 |
|
<p>name of the sampler format |
9393 |
|
of the given instrument |
9394 |
|
</p> |
9395 |
|
</blockquote> |
9396 |
|
|
9397 |
|
|
9398 |
|
<p>FORMAT_VERSION - |
9399 |
|
</p> |
9400 |
|
<blockquote class="text"> |
9401 |
|
<p>version of the sampler format |
9402 |
|
the instrumen is stored as |
9403 |
|
</p> |
9404 |
|
</blockquote> |
9405 |
|
|
9406 |
|
|
9407 |
|
<p>PRODUCT - |
9408 |
|
</p> |
9409 |
|
<blockquote class="text"> |
9410 |
|
<p>official product name of the |
9411 |
|
instrument as stored in the file |
9412 |
|
|
9413 |
|
</p> |
9414 |
|
</blockquote> |
9415 |
|
|
9416 |
|
|
9417 |
|
<p>ARTISTS - |
9418 |
|
</p> |
9419 |
|
<blockquote class="text"> |
9420 |
|
<p>artists / sample library |
9421 |
|
vendor of the instrument |
9422 |
|
</p> |
9423 |
|
</blockquote> |
9424 |
|
|
9425 |
|
|
9426 |
|
</blockquote> |
9427 |
|
|
9428 |
|
|
9429 |
|
</blockquote><p> |
9430 |
|
|
9431 |
|
</p> |
9432 |
|
<p>The mentioned fields above don't have to be in particular order. |
9433 |
|
</p> |
9434 |
|
<p>Example: |
9435 |
|
</p> |
9436 |
|
<p> |
9437 |
|
</p> |
9438 |
|
<blockquote class="text"> |
9439 |
|
<p>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0" |
9440 |
|
</p> |
9441 |
|
<p>S: "NAME: Lunatic Loops" |
9442 |
|
</p> |
9443 |
|
<p> "FORMAT_FAMILY: GIG" |
9444 |
|
</p> |
9445 |
|
<p> "FORMAT_VERSION: 3" |
9446 |
|
</p> |
9447 |
|
<p> "PRODUCT: The Backbone Bongo Beats" |
9448 |
|
</p> |
9449 |
|
<p> "ARTISTS: Jimmy the Fish" |
9450 |
|
</p> |
9451 |
|
<p> "." |
9452 |
|
</p> |
9453 |
|
</blockquote><p> |
9454 |
|
|
9455 |
|
</p> |
9456 |
<a name="command_syntax"></a><br /><hr /> |
<a name="command_syntax"></a><br /><hr /> |
9457 |
<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> |
9458 |
<a name="rfc.section.7"></a><h3>7. |
<a name="rfc.section.7"></a><h3>7. |
9685 |
<p>/ MISCELLANEOUS |
<p>/ MISCELLANEOUS |
9686 |
|
|
9687 |
</p> |
</p> |
9688 |
|
<p>/ TOTAL_STREAM_COUNT |
9689 |
|
|
9690 |
|
</p> |
9691 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
9692 |
|
|
9693 |
</p> |
</p> |
9763 |
<p>/ MISCELLANEOUS |
<p>/ MISCELLANEOUS |
9764 |
|
|
9765 |
</p> |
</p> |
9766 |
|
<p>/ TOTAL_STREAM_COUNT |
9767 |
|
|
9768 |
|
</p> |
9769 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
9770 |
|
|
9771 |
</p> |
</p> |
9901 |
<p>/ SERVER SP INFO |
<p>/ SERVER SP INFO |
9902 |
|
|
9903 |
</p> |
</p> |
9904 |
|
<p>/ TOTAL_STREAM_COUNT |
9905 |
|
|
9906 |
|
</p> |
9907 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
9908 |
|
|
9909 |
</p> |
</p> |
9955 |
<p>/ VOLUME |
<p>/ VOLUME |
9956 |
|
|
9957 |
</p> |
</p> |
9958 |
|
<p>/ FILE SP INSTRUMENTS SP filename |
9959 |
|
|
9960 |
|
</p> |
9961 |
|
<p>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
9962 |
|
|
9963 |
|
</p> |
9964 |
</blockquote><p> |
</blockquote><p> |
9965 |
|
|
9966 |
</p> |
</p> |
10282 |
<p>/ DB_INSTRUMENTS SP db_path |
<p>/ DB_INSTRUMENTS SP db_path |
10283 |
|
|
10284 |
</p> |
</p> |
10285 |
|
<p>/ FILE SP INSTRUMENTS SP filename |
10286 |
|
|
10287 |
|
</p> |
10288 |
</blockquote><p> |
</blockquote><p> |
10289 |
|
|
10290 |
</p> |
</p> |
10698 |
</p> |
</p> |
10699 |
<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> |
<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> |
10700 |
</p> |
</p> |
10701 |
|
<p><a class='info' href='#GET FILE INSTRUMENTS'>"GET FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving amount of instruments of a file</span><span>)</span></a> |
10702 |
|
</p> |
10703 |
|
<p><a class='info' href='#LIST FILE INSTRUMENTS'>"LIST FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving all instruments of a file</span><span>)</span></a> |
10704 |
|
</p> |
10705 |
|
<p><a class='info' href='#GET FILE INSTRUMENT INFO'>"GET FILE INSTRUMENT INFO"<span> (</span><span class='info'>Retrieving informations about one instrument in a file</span><span>)</span></a> |
10706 |
|
</p> |
10707 |
</blockquote><p> |
</blockquote><p> |
10708 |
Note that the forward slash character ('/') has a special meaning in |
Note that the forward slash character ('/') has a special meaning in |
10709 |
filename / path based arguments: it acts as separator of the nodes in |
filename / path based arguments: it acts as separator of the nodes in |
10714 |
|
|
10715 |
</p> |
</p> |
10716 |
<p> |
<p> |
10717 |
|
Note for Windows: file path arguments in LSCP are expected |
10718 |
|
to use forward slashes as directory node separator similar |
10719 |
|
to Unix based operating systems. In contrast to Unix however |
10720 |
|
a Windows typical drive character is expected to be |
10721 |
|
prefixed to the path. That is an original Windows file path |
10722 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
10723 |
|
"D:/Sounds/My.gig". |
10724 |
|
|
10725 |
|
</p> |
10726 |
|
<p> |
10727 |
The following LSCP commands even support escape sequences as |
The following LSCP commands even support escape sequences as |
10728 |
part of at least one of their text-based arguments (i.e. entity name, |
part of at least one of their text-based arguments (i.e. entity name, |
10729 |
description) and / or may contain escape sequences in at least one of |
description) and / or may contain escape sequences in at least one of |
11147 |
<p>where <voices> will be replaced by the new number of |
<p>where <voices> will be replaced by the new number of |
11148 |
all currently active voices. |
all currently active voices. |
11149 |
</p> |
</p> |
11150 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE TOTAL_STREAM_COUNT"></a><br /><hr /> |
11151 |
<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> |
11152 |
<a name="rfc.section.8.13"></a><h3>8.13. |
<a name="rfc.section.8.13"></a><h3>8.13. |
11153 |
|
Total number of active disk streams changed</h3> |
11154 |
|
|
11155 |
|
<p>Client may want to be notified when the total number of disk streams on the |
11156 |
|
back-end changes by issuing the following command: |
11157 |
|
</p> |
11158 |
|
<p> |
11159 |
|
</p> |
11160 |
|
<blockquote class="text"> |
11161 |
|
<p>SUBSCRIBE TOTAL_STREAM_COUNT |
11162 |
|
</p> |
11163 |
|
</blockquote><p> |
11164 |
|
|
11165 |
|
</p> |
11166 |
|
<p>Server will start sending the following notification messages: |
11167 |
|
</p> |
11168 |
|
<p> |
11169 |
|
</p> |
11170 |
|
<blockquote class="text"> |
11171 |
|
<p>"NOTIFY:TOTAL_STREAM_COUNT:<streams>" |
11172 |
|
</p> |
11173 |
|
</blockquote><p> |
11174 |
|
|
11175 |
|
</p> |
11176 |
|
<p>where <streams> will be replaced by the new number of |
11177 |
|
all currently active disk streams. |
11178 |
|
</p> |
11179 |
|
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr /> |
11180 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11181 |
|
<a name="rfc.section.8.14"></a><h3>8.14. |
11182 |
Number of MIDI instrument maps changed</h3> |
Number of MIDI instrument maps changed</h3> |
11183 |
|
|
11184 |
<p>Client may want to be notified when the number of MIDI instrument maps on the |
<p>Client may want to be notified when the number of MIDI instrument maps on the |
11207 |
</p> |
</p> |
11208 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr /> |
11209 |
<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> |
11210 |
<a name="rfc.section.8.14"></a><h3>8.14. |
<a name="rfc.section.8.15"></a><h3>8.15. |
11211 |
MIDI instrument map information changed</h3> |
MIDI instrument map information changed</h3> |
11212 |
|
|
11213 |
<p>Client may want to be notified when changes were made to MIDI instrument maps on the |
<p>Client may want to be notified when changes were made to MIDI instrument maps on the |
11240 |
</p> |
</p> |
11241 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr /> |
11242 |
<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> |
11243 |
<a name="rfc.section.8.15"></a><h3>8.15. |
<a name="rfc.section.8.16"></a><h3>8.16. |
11244 |
Number of MIDI instruments changed</h3> |
Number of MIDI instruments changed</h3> |
11245 |
|
|
11246 |
<p>Client may want to be notified when the number of MIDI instrument maps on the |
<p>Client may want to be notified when the number of MIDI instrument maps on the |
11270 |
</p> |
</p> |
11271 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr /> |
11272 |
<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> |
11273 |
<a name="rfc.section.8.16"></a><h3>8.16. |
<a name="rfc.section.8.17"></a><h3>8.17. |
11274 |
MIDI instrument information changed</h3> |
MIDI instrument information changed</h3> |
11275 |
|
|
11276 |
<p>Client may want to be notified when changes were made to MIDI instruments on the |
<p>Client may want to be notified when changes were made to MIDI instruments on the |
11304 |
</p> |
</p> |
11305 |
<a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr /> |
11306 |
<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> |
11307 |
<a name="rfc.section.8.17"></a><h3>8.17. |
<a name="rfc.section.8.18"></a><h3>8.18. |
11308 |
Global settings changed</h3> |
Global settings changed</h3> |
11309 |
|
|
11310 |
<p>Client may want to be notified when changes to the global settings |
<p>Client may want to be notified when changes to the global settings |
11333 |
</p> |
</p> |
11334 |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
11335 |
<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> |
11336 |
<a name="rfc.section.8.18"></a><h3>8.18. |
<a name="rfc.section.8.19"></a><h3>8.19. |
11337 |
Number of database instrument directories changed</h3> |
Number of database instrument directories changed</h3> |
11338 |
|
|
11339 |
<p>Client may want to be notified when the number of instrument |
<p>Client may want to be notified when the number of instrument |
11367 |
</p> |
</p> |
11368 |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr /> |
11369 |
<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> |
11370 |
<a name="rfc.section.8.19"></a><h3>8.19. |
<a name="rfc.section.8.20"></a><h3>8.20. |
11371 |
Database instrument directory information changed</h3> |
Database instrument directory information changed</h3> |
11372 |
|
|
11373 |
<p>Client may want to be notified when changes were made to directories |
<p>Client may want to be notified when changes were made to directories |
11412 |
</p> |
</p> |
11413 |
<a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr /> |
11414 |
<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> |
11415 |
<a name="rfc.section.8.20"></a><h3>8.20. |
<a name="rfc.section.8.21"></a><h3>8.21. |
11416 |
Number of database instruments changed</h3> |
Number of database instruments changed</h3> |
11417 |
|
|
11418 |
<p>Client may want to be notified when the number of instruments |
<p>Client may want to be notified when the number of instruments |
11446 |
</p> |
</p> |
11447 |
<a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr /> |
11448 |
<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> |
11449 |
<a name="rfc.section.8.21"></a><h3>8.21. |
<a name="rfc.section.8.22"></a><h3>8.22. |
11450 |
Database instrument information changed</h3> |
Database instrument information changed</h3> |
11451 |
|
|
11452 |
<p>Client may want to be notified when changes were made to instruments |
<p>Client may want to be notified when changes were made to instruments |
11491 |
</p> |
</p> |
11492 |
<a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr /> |
11493 |
<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> |
11494 |
<a name="rfc.section.8.22"></a><h3>8.22. |
<a name="rfc.section.8.23"></a><h3>8.23. |
11495 |
Database job status information changed</h3> |
Database job status information changed</h3> |
11496 |
|
|
11497 |
<p>Client may want to be notified when the status of particular database |
<p>Client may want to be notified when the status of particular database |
11524 |
</p> |
</p> |
11525 |
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr /> |
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr /> |
11526 |
<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> |
11527 |
<a name="rfc.section.8.23"></a><h3>8.23. |
<a name="rfc.section.8.24"></a><h3>8.24. |
11528 |
Miscellaneous and debugging events</h3> |
Miscellaneous and debugging events</h3> |
11529 |
|
|
11530 |
<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 |