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: November 25, 2007</td><td class="header">May 24, 2007</td></tr> |
<tr><td class="header">Expires: March 14, 2009</td><td class="header">September 10, 2008</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.4</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 November 25, 2007.</p> |
This Internet-Draft will expire on March 14, 2009.</p> |
177 |
|
|
178 |
<h3>Copyright Notice</h3> |
<h3>Copyright Notice</h3> |
179 |
<p> |
<p> |
180 |
Copyright © The IETF Trust (2007).</p> |
Copyright © The IETF Trust (2008).</p> |
181 |
|
|
182 |
<h3>Abstract</h3> |
<h3>Abstract</h3> |
183 |
|
|
336 |
Altering effect send's MIDI controller<br /> |
Altering effect send's MIDI controller<br /> |
337 |
<a href="#SET FX_SEND LEVEL">6.4.33.</a> |
<a href="#SET FX_SEND LEVEL">6.4.33.</a> |
338 |
Altering effect send's send level<br /> |
Altering effect send's send level<br /> |
339 |
<a href="#RESET CHANNEL">6.4.34.</a> |
<a href="#SEND CHANNEL MIDI_DATA">6.4.34.</a> |
340 |
|
Sending MIDI messages to sampler channel<br /> |
341 |
|
<a href="#RESET CHANNEL">6.4.35.</a> |
342 |
Resetting a sampler channel<br /> |
Resetting a sampler channel<br /> |
343 |
<a href="#anchor12">6.5.</a> |
<a href="#anchor12">6.5.</a> |
344 |
Controlling connection<br /> |
Controlling connection<br /> |
356 |
Current number of active voices<br /> |
Current number of active voices<br /> |
357 |
<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a> |
<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a> |
358 |
Maximum amount of active voices<br /> |
Maximum amount of active voices<br /> |
359 |
<a href="#RESET">6.6.3.</a> |
<a href="#GET TOTAL_STREAM_COUNT">6.6.3.</a> |
360 |
|
Current number of active disk streams<br /> |
361 |
|
<a href="#RESET">6.6.4.</a> |
362 |
Reset sampler<br /> |
Reset sampler<br /> |
363 |
<a href="#GET SERVER INFO">6.6.4.</a> |
<a href="#GET SERVER INFO">6.6.5.</a> |
364 |
General sampler informations<br /> |
General sampler informations<br /> |
365 |
<a href="#GET VOLUME">6.6.5.</a> |
<a href="#GET VOLUME">6.6.6.</a> |
366 |
Getting global volume attenuation<br /> |
Getting global volume attenuation<br /> |
367 |
<a href="#SET VOLUME">6.6.6.</a> |
<a href="#SET VOLUME">6.6.7.</a> |
368 |
Setting global volume attenuation<br /> |
Setting global volume attenuation<br /> |
369 |
<a href="#MIDI Instrument Mapping">6.7.</a> |
<a href="#MIDI Instrument Mapping">6.7.</a> |
370 |
MIDI Instrument Mapping<br /> |
MIDI Instrument Mapping<br /> |
371 |
<a href="#ADD MIDI_INSTRUMENT MAP">6.7.1.</a> |
<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a> |
372 |
Create a new MIDI instrument map<br /> |
Create a new MIDI instrument map<br /> |
373 |
<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a> |
<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a> |
374 |
Delete one particular or all MIDI instrument maps<br /> |
Delete one particular or all MIDI instrument maps<br /> |
436 |
Finding instruments<br /> |
Finding instruments<br /> |
437 |
<a href="#GET DB_INSTRUMENTS_JOB INFO">6.8.21.</a> |
<a href="#GET DB_INSTRUMENTS_JOB INFO">6.8.21.</a> |
438 |
Getting job status information<br /> |
Getting job status information<br /> |
439 |
|
<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a> |
440 |
|
Formatting the instruments database<br /> |
441 |
|
<a href="#FIND LOST DB_INSTRUMENT_FILES">6.8.23.</a> |
442 |
|
Checking for lost instrument files<br /> |
443 |
|
<a href="#SET DB_INSTRUMENT FILE_PATH">6.8.24.</a> |
444 |
|
Replacing an instrument file<br /> |
445 |
|
<a href="#editing_instruments">6.9.</a> |
446 |
|
Editing Instruments<br /> |
447 |
|
<a href="#EDIT INSTRUMENT">6.9.1.</a> |
448 |
|
Opening an appropriate instrument editor application<br /> |
449 |
|
<a href="#file_management">6.10.</a> |
450 |
|
Managing Files<br /> |
451 |
|
<a href="#GET FILE INSTRUMENTS">6.10.1.</a> |
452 |
|
Retrieving amount of instruments of a file<br /> |
453 |
|
<a href="#LIST FILE INSTRUMENTS">6.10.2.</a> |
454 |
|
Retrieving all instruments of a file<br /> |
455 |
|
<a href="#GET FILE INSTRUMENT INFO">6.10.3.</a> |
456 |
|
Retrieving informations about one instrument in a file<br /> |
457 |
<a href="#command_syntax">7.</a> |
<a href="#command_syntax">7.</a> |
458 |
Command Syntax<br /> |
Command Syntax<br /> |
459 |
|
<a href="#character_set">7.1.</a> |
460 |
|
Character Set and Escape Sequences<br /> |
461 |
<a href="#events">8.</a> |
<a href="#events">8.</a> |
462 |
Events<br /> |
Events<br /> |
463 |
<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a> |
<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a> |
470 |
MIDI input device's settings changed<br /> |
MIDI input device's settings changed<br /> |
471 |
<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a> |
<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a> |
472 |
Number of sampler channels changed<br /> |
Number of sampler channels changed<br /> |
473 |
<a href="#SUBSCRIBE VOICE_COUNT">8.6.</a> |
<a href="#SUBSCRIBE CHANNEL_MIDI">8.6.</a> |
474 |
|
MIDI data on a sampler channel arrived<br /> |
475 |
|
<a href="#SUBSCRIBE DEVICE_MIDI">8.7.</a> |
476 |
|
MIDI data on a MIDI input device arrived<br /> |
477 |
|
<a href="#SUBSCRIBE VOICE_COUNT">8.8.</a> |
478 |
Number of active voices changed<br /> |
Number of active voices changed<br /> |
479 |
<a href="#SUBSCRIBE STREAM_COUNT">8.7.</a> |
<a href="#SUBSCRIBE STREAM_COUNT">8.9.</a> |
480 |
Number of active disk streams changed<br /> |
Number of active disk streams changed<br /> |
481 |
<a href="#SUBSCRIBE BUFFER_FILL">8.8.</a> |
<a href="#SUBSCRIBE BUFFER_FILL">8.10.</a> |
482 |
Disk stream buffer fill state changed<br /> |
Disk stream buffer fill state changed<br /> |
483 |
<a href="#SUBSCRIBE CHANNEL_INFO">8.9.</a> |
<a href="#SUBSCRIBE CHANNEL_INFO">8.11.</a> |
484 |
Channel information changed<br /> |
Channel information changed<br /> |
485 |
<a href="#SUBSCRIBE FX_SEND_COUNT">8.10.</a> |
<a href="#SUBSCRIBE FX_SEND_COUNT">8.12.</a> |
486 |
Number of effect sends changed<br /> |
Number of effect sends changed<br /> |
487 |
<a href="#SUBSCRIBE FX_SEND_INFO">8.11.</a> |
<a href="#SUBSCRIBE FX_SEND_INFO">8.13.</a> |
488 |
Effect send information changed<br /> |
Effect send information changed<br /> |
489 |
<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a> |
<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.14.</a> |
490 |
Total number of active voices changed<br /> |
Total number of active voices changed<br /> |
491 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.13.</a> |
<a href="#SUBSCRIBE TOTAL_STREAM_COUNT">8.15.</a> |
492 |
|
Total number of active disk streams changed<br /> |
493 |
|
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.16.</a> |
494 |
Number of MIDI instrument maps changed<br /> |
Number of MIDI instrument maps changed<br /> |
495 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.14.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.17.</a> |
496 |
MIDI instrument map information changed<br /> |
MIDI instrument map information changed<br /> |
497 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.15.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.18.</a> |
498 |
Number of MIDI instruments changed<br /> |
Number of MIDI instruments changed<br /> |
499 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.16.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.19.</a> |
500 |
MIDI instrument information changed<br /> |
MIDI instrument information changed<br /> |
501 |
<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a> |
<a href="#SUBSCRIBE GLOBAL_INFO">8.20.</a> |
502 |
Global settings changed<br /> |
Global settings changed<br /> |
503 |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.18.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.21.</a> |
504 |
Number of database instrument directories changed<br /> |
Number of database instrument directories changed<br /> |
505 |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.19.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.22.</a> |
506 |
Database instrument directory information changed<br /> |
Database instrument directory information changed<br /> |
507 |
<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.20.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.23.</a> |
508 |
Number of database instruments changed<br /> |
Number of database instruments changed<br /> |
509 |
<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.21.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.24.</a> |
510 |
Database instrument information changed<br /> |
Database instrument information changed<br /> |
511 |
<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.22.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.25.</a> |
512 |
Database job status information changed<br /> |
Database job status information changed<br /> |
513 |
<a href="#SUBSCRIBE MISCELLANEOUS">8.23.</a> |
<a href="#SUBSCRIBE MISCELLANEOUS">8.26.</a> |
514 |
Miscellaneous and debugging events<br /> |
Miscellaneous and debugging events<br /> |
515 |
<a href="#anchor14">9.</a> |
<a href="#anchor14">9.</a> |
516 |
Security Considerations<br /> |
Security Considerations<br /> |
542 |
(front-end) and server (LinuxSampler) respectively. Lines in |
(front-end) and server (LinuxSampler) respectively. Lines in |
543 |
examples must be interpreted as every line being CRLF |
examples must be interpreted as every line being CRLF |
544 |
terminated (carriage return character followed by line feed |
terminated (carriage return character followed by line feed |
545 |
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>), |
546 |
example: |
thus the following example: |
547 |
</p> |
</p> |
548 |
<p> |
<p> |
549 |
</p> |
</p> |
3329 |
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> |
3330 |
command, <port> by the MIDI port number, <key> by the name of |
command, <port> by the MIDI port number, <key> by the name of |
3331 |
the parameter to change and <value> by the new value for this |
the parameter to change and <value> by the new value for this |
3332 |
parameter. |
parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes) |
3333 |
|
for specifying no value for parameters allowing a list of values. |
3334 |
</p> |
</p> |
3335 |
<p>Possible Answers: |
<p>Possible Answers: |
3336 |
</p> |
</p> |
3371 |
<p> |
<p> |
3372 |
</p> |
</p> |
3373 |
<blockquote class="text"> |
<blockquote class="text"> |
3374 |
|
<p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'" |
3375 |
|
</p> |
3376 |
|
<p>S: "OK" |
3377 |
|
</p> |
3378 |
|
</blockquote><p> |
3379 |
|
|
3380 |
|
</p> |
3381 |
<p> |
<p> |
3382 |
|
</p> |
3383 |
|
<blockquote class="text"> |
3384 |
|
<p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE" |
3385 |
|
</p> |
3386 |
|
<p>S: "OK" |
3387 |
</p> |
</p> |
3388 |
</blockquote><p> |
</blockquote><p> |
3389 |
|
|
3418 |
number of the sampler channel the instrument should be assigned to. |
number of the sampler channel the instrument should be assigned to. |
3419 |
Each sampler channel can only have one instrument. |
Each sampler channel can only have one instrument. |
3420 |
</p> |
</p> |
3421 |
|
<p>Notice: since LSCP 1.2 the <filename> argument supports |
3422 |
|
escape characters for special characters (see chapter |
3423 |
|
"<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>" |
3424 |
|
for details) and accordingly backslash characters in the filename |
3425 |
|
MUST now be escaped as well! |
3426 |
|
</p> |
3427 |
<p>The difference between regular and NON_MODAL versions of the command |
<p>The difference between regular and NON_MODAL versions of the command |
3428 |
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 |
3429 |
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 |
3471 |
</blockquote><p> |
</blockquote><p> |
3472 |
|
|
3473 |
</p> |
</p> |
3474 |
<p>Example: |
<p>Example (Unix): |
3475 |
</p> |
</p> |
3476 |
<p> |
<p> |
3477 |
</p> |
</p> |
3478 |
<blockquote class="text"> |
<blockquote class="text"> |
3479 |
|
<p>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0 |
3480 |
|
</p> |
3481 |
|
<p>S: OK |
3482 |
|
</p> |
3483 |
|
</blockquote><p> |
3484 |
|
|
3485 |
|
</p> |
3486 |
|
<p>Example (Windows): |
3487 |
|
</p> |
3488 |
<p> |
<p> |
3489 |
|
</p> |
3490 |
|
<blockquote class="text"> |
3491 |
|
<p>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0 |
3492 |
|
</p> |
3493 |
|
<p>S: OK |
3494 |
</p> |
</p> |
3495 |
</blockquote><p> |
</blockquote><p> |
3496 |
|
|
3905 |
</p> |
</p> |
3906 |
<blockquote class="text"> |
<blockquote class="text"> |
3907 |
<p>arbitrary description text about the engine |
<p>arbitrary description text about the engine |
3908 |
|
(note that the character string may contain |
3909 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
3910 |
</p> |
</p> |
3911 |
</blockquote> |
</blockquote> |
3912 |
|
|
4026 |
<blockquote class="text"> |
<blockquote class="text"> |
4027 |
<p>the file name of the loaded instrument, "NONE" if |
<p>the file name of the loaded instrument, "NONE" if |
4028 |
there's no instrument yet loaded for this sampler |
there's no instrument yet loaded for this sampler |
4029 |
channel |
channel (note: since LSCP 1.2 this path may contain |
4030 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
4031 |
</p> |
</p> |
4032 |
</blockquote> |
</blockquote> |
4033 |
|
|
4044 |
</p> |
</p> |
4045 |
<blockquote class="text"> |
<blockquote class="text"> |
4046 |
<p>the instrument name of the loaded instrument |
<p>the instrument name of the loaded instrument |
4047 |
|
(note: since LSCP 1.2 this character string may contain |
4048 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
4049 |
</p> |
</p> |
4050 |
</blockquote> |
</blockquote> |
4051 |
|
|
5121 |
sampler channel on which the effect send should be created on, <midi-ctrl> |
sampler channel on which the effect send should be created on, <midi-ctrl> |
5122 |
is a number between 0..127 defining the MIDI controller which can alter the |
is a number between 0..127 defining the MIDI controller which can alter the |
5123 |
effect send level and <name> is an optional argument defining a name |
effect send level and <name> is an optional argument defining a name |
5124 |
for the effect send entity. The name does not have to be unique. |
for the effect send entity. The name does not have to be unique, but MUST be |
5125 |
|
encapsulated into apostrophes and supports escape sequences as described in chapter |
5126 |
|
"<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>". |
5127 |
</p> |
</p> |
5128 |
<p>By default, that is as initial routing, the effect send's audio channels |
<p>By default, that is as initial routing, the effect send's audio channels |
5129 |
are automatically routed to the last audio channels of the sampler channel's |
are automatically routed to the last audio channels of the sampler channel's |
5392 |
</p> |
</p> |
5393 |
<blockquote class="text"> |
<blockquote class="text"> |
5394 |
<p>name of the effect send entity |
<p>name of the effect send entity |
5395 |
|
(note that this character string may contain |
5396 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
5397 |
</p> |
</p> |
5398 |
</blockquote> |
</blockquote> |
5399 |
|
|
5484 |
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> |
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> |
5485 |
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 |
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 |
5486 |
<name> is the new name of the effect send entity, which |
<name> is the new name of the effect send entity, which |
5487 |
does not have to be unique. |
does not have to be unique (name MUST be encapsulated into apostrophes |
5488 |
|
and supports escape sequences as described in chapter |
5489 |
|
"<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>"). |
5490 |
|
|
5491 |
</p> |
</p> |
5492 |
<p>Possible Answers: |
<p>Possible Answers: |
5493 |
</p> |
</p> |
5751 |
</blockquote><p> |
</blockquote><p> |
5752 |
|
|
5753 |
</p> |
</p> |
5754 |
<a name="RESET CHANNEL"></a><br /><hr /> |
<a name="SEND CHANNEL MIDI_DATA"></a><br /><hr /> |
5755 |
<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> |
5756 |
<a name="rfc.section.6.4.34"></a><h3>6.4.34. |
<a name="rfc.section.6.4.34"></a><h3>6.4.34. |
5757 |
|
Sending MIDI messages to sampler channel</h3> |
5758 |
|
|
5759 |
|
<p>The front-end can send MIDI events to specific sampler channel |
5760 |
|
by sending the following command: |
5761 |
|
</p> |
5762 |
|
<p> |
5763 |
|
</p> |
5764 |
|
<blockquote class="text"> |
5765 |
|
<p>SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2> |
5766 |
|
</p> |
5767 |
|
</blockquote><p> |
5768 |
|
|
5769 |
|
</p> |
5770 |
|
<p>Where <sampler-chan> is the sampler channel number |
5771 |
|
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> |
5772 |
|
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, |
5773 |
|
<arg1> and <arg2> arguments depend on the <midi-msg> argument, which |
5774 |
|
specifies the MIDI message type. Currently, the following MIDI messages are supported: |
5775 |
|
</p> |
5776 |
|
<p> |
5777 |
|
</p> |
5778 |
|
<blockquote class="text"> |
5779 |
|
<p>"NOTE_ON" - |
5780 |
|
</p> |
5781 |
|
<blockquote class="text"> |
5782 |
|
<p>For turning on MIDI notes, where <arg1> |
5783 |
|
specifies the key number and <arg2> the velocity |
5784 |
|
as described in the MIDI specification. |
5785 |
|
</p> |
5786 |
|
</blockquote> |
5787 |
|
|
5788 |
|
|
5789 |
|
<p>"NOTE_OFF" - |
5790 |
|
</p> |
5791 |
|
<blockquote class="text"> |
5792 |
|
<p>For turning a currently playing MIDI note off, where <arg1> |
5793 |
|
specifies the key number and <arg2> the velocity |
5794 |
|
as described in the MIDI specification. |
5795 |
|
</p> |
5796 |
|
</blockquote> |
5797 |
|
|
5798 |
|
|
5799 |
|
</blockquote><p> |
5800 |
|
|
5801 |
|
</p> |
5802 |
|
<p>CAUTION: This command is provided for implementations of virtual MIDI keyboards |
5803 |
|
and no realtime guarantee whatsoever will be made! |
5804 |
|
</p> |
5805 |
|
<p>Possible Answers: |
5806 |
|
</p> |
5807 |
|
<p> |
5808 |
|
</p> |
5809 |
|
<blockquote class="text"> |
5810 |
|
<p>"OK" - |
5811 |
|
</p> |
5812 |
|
<blockquote class="text"> |
5813 |
|
<p>on success |
5814 |
|
</p> |
5815 |
|
</blockquote> |
5816 |
|
|
5817 |
|
|
5818 |
|
<p>"ERR:<error-code>:<error-message>" - |
5819 |
|
</p> |
5820 |
|
<blockquote class="text"> |
5821 |
|
<p>in case it failed, providing an appropriate error code and error message |
5822 |
|
</p> |
5823 |
|
</blockquote> |
5824 |
|
|
5825 |
|
|
5826 |
|
</blockquote><p> |
5827 |
|
|
5828 |
|
</p> |
5829 |
|
<p>Example: |
5830 |
|
</p> |
5831 |
|
<p> |
5832 |
|
</p> |
5833 |
|
<blockquote class="text"> |
5834 |
|
<p>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112" |
5835 |
|
</p> |
5836 |
|
<p>S: "OK" |
5837 |
|
</p> |
5838 |
|
</blockquote><p> |
5839 |
|
|
5840 |
|
</p> |
5841 |
|
<a name="RESET CHANNEL"></a><br /><hr /> |
5842 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5843 |
|
<a name="rfc.section.6.4.35"></a><h3>6.4.35. |
5844 |
Resetting a sampler channel</h3> |
Resetting a sampler channel</h3> |
5845 |
|
|
5846 |
<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: |
6175 |
</blockquote><p> |
</blockquote><p> |
6176 |
|
|
6177 |
</p> |
</p> |
6178 |
<a name="RESET"></a><br /><hr /> |
<a name="GET TOTAL_STREAM_COUNT"></a><br /><hr /> |
6179 |
<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> |
6180 |
<a name="rfc.section.6.6.3"></a><h3>6.6.3. |
<a name="rfc.section.6.6.3"></a><h3>6.6.3. |
6181 |
|
Current number of active disk streams</h3> |
6182 |
|
|
6183 |
|
<p>The front-end can ask for the current number of active disk streams on |
6184 |
|
the sampler by sending the following command: |
6185 |
|
</p> |
6186 |
|
<p> |
6187 |
|
</p> |
6188 |
|
<blockquote class="text"> |
6189 |
|
<p>GET TOTAL_STREAM_COUNT |
6190 |
|
</p> |
6191 |
|
</blockquote><p> |
6192 |
|
|
6193 |
|
</p> |
6194 |
|
<p>Possible Answers: |
6195 |
|
</p> |
6196 |
|
<p> |
6197 |
|
</p> |
6198 |
|
<blockquote class="text"> |
6199 |
|
<p>LinuxSampler will answer by returning the number of all active |
6200 |
|
disk streams on the sampler. |
6201 |
|
</p> |
6202 |
|
</blockquote><p> |
6203 |
|
|
6204 |
|
</p> |
6205 |
|
<a name="RESET"></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.4"></a><h3>6.6.4. |
6208 |
Reset sampler</h3> |
Reset sampler</h3> |
6209 |
|
|
6210 |
<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: |
6245 |
</p> |
</p> |
6246 |
<a name="GET SERVER INFO"></a><br /><hr /> |
<a name="GET SERVER INFO"></a><br /><hr /> |
6247 |
<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> |
6248 |
<a name="rfc.section.6.6.4"></a><h3>6.6.4. |
<a name="rfc.section.6.6.5"></a><h3>6.6.5. |
6249 |
General sampler informations</h3> |
General sampler informations</h3> |
6250 |
|
|
6251 |
<p>The client can ask for general informations about the LinuxSampler |
<p>The client can ask for general informations about the LinuxSampler |
6278 |
</p> |
</p> |
6279 |
<blockquote class="text"> |
<blockquote class="text"> |
6280 |
<p>arbitrary textual description about the sampler |
<p>arbitrary textual description about the sampler |
6281 |
|
(note that the character string may contain |
6282 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
6283 |
</p> |
</p> |
6284 |
</blockquote> |
</blockquote> |
6285 |
|
|
6321 |
</p> |
</p> |
6322 |
<a name="GET VOLUME"></a><br /><hr /> |
<a name="GET VOLUME"></a><br /><hr /> |
6323 |
<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> |
6324 |
<a name="rfc.section.6.6.5"></a><h3>6.6.5. |
<a name="rfc.section.6.6.6"></a><h3>6.6.6. |
6325 |
Getting global volume attenuation</h3> |
Getting global volume attenuation</h3> |
6326 |
|
|
6327 |
<p>The client can ask for the current global sampler-wide volume |
<p>The client can ask for the current global sampler-wide volume |
6354 |
</p> |
</p> |
6355 |
<a name="SET VOLUME"></a><br /><hr /> |
<a name="SET VOLUME"></a><br /><hr /> |
6356 |
<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> |
6357 |
<a name="rfc.section.6.6.6"></a><h3>6.6.6. |
<a name="rfc.section.6.6.7"></a><h3>6.6.7. |
6358 |
Setting global volume attenuation</h3> |
Setting global volume attenuation</h3> |
6359 |
|
|
6360 |
<p>The client can alter the current global sampler-wide volume |
<p>The client can alter the current global sampler-wide volume |
6441 |
cause the sampler to switch to the respective instrument as |
cause the sampler to switch to the respective instrument as |
6442 |
reflected by the current MIDI instrument map. |
reflected by the current MIDI instrument map. |
6443 |
</p> |
</p> |
6444 |
<a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr /> |
<a name="ADD MIDI_INSTRUMENT_MAP"></a><br /><hr /> |
6445 |
<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> |
6446 |
<a name="rfc.section.6.7.1"></a><h3>6.7.1. |
<a name="rfc.section.6.7.1"></a><h3>6.7.1. |
6447 |
Create a new MIDI instrument map</h3> |
Create a new MIDI instrument map</h3> |
6459 |
</p> |
</p> |
6460 |
<p>Where <name> is an optional argument allowing to |
<p>Where <name> is an optional argument allowing to |
6461 |
assign a custom name to the new map. MIDI instrument Map |
assign a custom name to the new map. MIDI instrument Map |
6462 |
names do not have to be unique. |
names do not have to be unique, but MUST be encapsulated |
6463 |
|
into apostrophes and support escape sequences as described |
6464 |
|
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>". |
6465 |
|
|
6466 |
</p> |
</p> |
6467 |
<p>Possible Answers: |
<p>Possible Answers: |
6468 |
</p> |
</p> |
6720 |
<blockquote class="text"> |
<blockquote class="text"> |
6721 |
<p>custom name of the given map, |
<p>custom name of the given map, |
6722 |
which does not have to be unique |
which does not have to be unique |
6723 |
|
(note that this character string may contain |
6724 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
6725 |
</p> |
</p> |
6726 |
</blockquote> |
</blockquote> |
6727 |
|
|
6777 |
</p> |
</p> |
6778 |
<p>Where <map> is the numerical ID of the map and |
<p>Where <map> is the numerical ID of the map and |
6779 |
<name> the new custom name of the map, which does not |
<name> the new custom name of the map, which does not |
6780 |
have to be unique. |
have to be unique (name MUST be encapsulated into apostrophes |
6781 |
|
and supports escape sequences as described in chapter |
6782 |
|
"<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>"). |
6783 |
|
|
6784 |
</p> |
</p> |
6785 |
<p>Possible Answers: |
<p>Possible Answers: |
6786 |
</p> |
</p> |
6846 |
index, <engine_name> a sampler engine name as returned by |
index, <engine_name> a sampler engine name as returned by |
6847 |
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> |
6848 |
command (not encapsulated into apostrophes), <filename> the name |
command (not encapsulated into apostrophes), <filename> the name |
6849 |
of the instrument's file to be deployed (encapsulated into apostrophes), |
of the instrument's file to be deployed (encapsulated into apostrophes, |
6850 |
|
supporting escape sequences as described in chapter |
6851 |
|
"<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>"), |
6852 |
<instrument_index> the index (integer value) of the instrument |
<instrument_index> the index (integer value) of the instrument |
6853 |
within the given file, <volume_value> reflects the master |
within the given file, <volume_value> reflects the master |
6854 |
volume of the instrument as optionally dotted number (where a |
volume of the instrument as optionally dotted number (where a |
6945 |
load modes of entries, the frontend should retrieve the actual |
load modes of entries, the frontend should retrieve the actual |
6946 |
mode by i.e. sending |
mode by i.e. sending |
6947 |
<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> |
6948 |
command(s). Finally the OPTIONAL <name> argument allows to |
command(s). Finally the OPTIONAL <name> argument allows to set a custom name |
6949 |
set a custom name (encapsulated into apostrophes) for the mapping |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
6950 |
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 |
6951 |
|
mapping entry, useful for frontends for displaying an appropriate name for |
6952 |
mapped instruments (using |
mapped instruments (using |
6953 |
<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>). |
6954 |
|
|
7270 |
changed with the |
changed with the |
7271 |
<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> |
7272 |
command and does not have to be unique. |
command and does not have to be unique. |
7273 |
|
(note that this character string may contain |
7274 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
7275 |
</p> |
</p> |
7276 |
</blockquote> |
</blockquote> |
7277 |
|
|
7288 |
<p>"INSTRUMENT_FILE" - |
<p>"INSTRUMENT_FILE" - |
7289 |
</p> |
</p> |
7290 |
<blockquote class="text"> |
<blockquote class="text"> |
7291 |
<p>File name of the instrument. |
<p>File name of the instrument |
7292 |
|
(note that this path may contain |
7293 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>). |
7294 |
</p> |
</p> |
7295 |
</blockquote> |
</blockquote> |
7296 |
|
|
7308 |
<blockquote class="text"> |
<blockquote class="text"> |
7309 |
<p>Name of the loaded instrument as reflected by its file. |
<p>Name of the loaded instrument as reflected by its file. |
7310 |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
7311 |
cannot be changed. |
cannot be changed (note that this character string may contain |
7312 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>). |
7313 |
</p> |
</p> |
7314 |
</blockquote> |
</blockquote> |
7315 |
|
|
7444 |
<p>The following commands describe how to use and manage |
<p>The following commands describe how to use and manage |
7445 |
the instruments database. |
the instruments database. |
7446 |
</p> |
</p> |
7447 |
|
<p>Notice: |
7448 |
|
</p> |
7449 |
|
<p> |
7450 |
|
</p> |
7451 |
|
<blockquote class="text"> |
7452 |
|
<p>All command arguments representing a path or |
7453 |
|
instrument/directory name support escape sequences as described in chapter |
7454 |
|
"<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>". |
7455 |
|
|
7456 |
|
</p> |
7457 |
|
<p>All occurrences of a forward slash in instrument and directory |
7458 |
|
names are escaped with its hex (\x2f) or octal (\057) escape sequence. |
7459 |
|
|
7460 |
|
</p> |
7461 |
|
</blockquote><p> |
7462 |
|
|
7463 |
|
</p> |
7464 |
<a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr /> |
<a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr /> |
7465 |
<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> |
7466 |
<a name="rfc.section.6.8.1"></a><h3>6.8.1. |
<a name="rfc.section.6.8.1"></a><h3>6.8.1. |
7726 |
<p>DESCRIPTION - |
<p>DESCRIPTION - |
7727 |
</p> |
</p> |
7728 |
<blockquote class="text"> |
<blockquote class="text"> |
7729 |
<p>A brief description of the directory content |
<p>A brief description of the directory content. |
7730 |
|
Note that the character string may contain |
7731 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
7732 |
</p> |
</p> |
7733 |
</blockquote> |
</blockquote> |
7734 |
|
|
7973 |
|
|
7974 |
</p> |
</p> |
7975 |
<p>Where <dir> is the absolute path name of the directory and |
<p>Where <dir> is the absolute path name of the directory and |
7976 |
<desc> is the new description for the directory. |
<desc> is the new description for the directory |
7977 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
7978 |
|
"<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>"). |
7979 |
</p> |
</p> |
7980 |
<p>Possible Answers: |
<p>Possible Answers: |
7981 |
</p> |
</p> |
8042 |
</p> |
</p> |
8043 |
<blockquote class="text"> |
<blockquote class="text"> |
8044 |
<p>Restricts the search to directories, which names |
<p>Restricts the search to directories, which names |
8045 |
satisfy the supplied search string. |
satisfy the supplied search string (encapsulated into apostrophes, |
8046 |
|
supporting escape sequences as described in chapter |
8047 |
|
"<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>"). |
8048 |
</p> |
</p> |
8049 |
</blockquote><p> |
</blockquote><p> |
8050 |
|
|
8087 |
</p> |
</p> |
8088 |
<blockquote class="text"> |
<blockquote class="text"> |
8089 |
<p>Restricts the search to directories with description |
<p>Restricts the search to directories with description |
8090 |
that satisfies the supplied search string. |
that satisfies the supplied search string |
8091 |
|
(encapsulated into apostrophes, supporting escape |
8092 |
|
sequences as described in chapter |
8093 |
|
"<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>"). |
8094 |
</p> |
</p> |
8095 |
</blockquote><p> |
</blockquote><p> |
8096 |
|
|
8471 |
</p> |
</p> |
8472 |
<blockquote class="text"> |
<blockquote class="text"> |
8473 |
<p>File name of the instrument. |
<p>File name of the instrument. |
8474 |
|
Note that the character string may contain |
8475 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
8476 |
</p> |
</p> |
8477 |
</blockquote> |
</blockquote> |
8478 |
|
|
8532 |
<p>DESCRIPTION - |
<p>DESCRIPTION - |
8533 |
</p> |
</p> |
8534 |
<blockquote class="text"> |
<blockquote class="text"> |
8535 |
<p>A brief description of the instrument |
<p>A brief description of the instrument. |
8536 |
|
Note that the character string may contain |
8537 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
8538 |
</p> |
</p> |
8539 |
</blockquote> |
</blockquote> |
8540 |
|
|
8551 |
<p>PRODUCT - |
<p>PRODUCT - |
8552 |
</p> |
</p> |
8553 |
<blockquote class="text"> |
<blockquote class="text"> |
8554 |
<p>The product title of the instrument |
<p>The product title of the instrument. |
8555 |
|
Note that the character string may contain |
8556 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
8557 |
</p> |
</p> |
8558 |
</blockquote> |
</blockquote> |
8559 |
|
|
8561 |
<p>ARTISTS - |
<p>ARTISTS - |
8562 |
</p> |
</p> |
8563 |
<blockquote class="text"> |
<blockquote class="text"> |
8564 |
<p>Lists the artist names |
<p>Lists the artist names. |
8565 |
|
Note that the character string may contain |
8566 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
8567 |
</p> |
</p> |
8568 |
</blockquote> |
</blockquote> |
8569 |
|
|
8573 |
<blockquote class="text"> |
<blockquote class="text"> |
8574 |
<p>Provides a list of keywords that refer to the instrument. |
<p>Provides a list of keywords that refer to the instrument. |
8575 |
Keywords are separated with semicolon and blank. |
Keywords are separated with semicolon and blank. |
8576 |
|
Note that the character string may contain |
8577 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
8578 |
</p> |
</p> |
8579 |
</blockquote> |
</blockquote> |
8580 |
|
|
8815 |
|
|
8816 |
</p> |
</p> |
8817 |
<p>Where <instr> is the absolute path name of the instrument and |
<p>Where <instr> is the absolute path name of the instrument and |
8818 |
<desc> is the new description for the instrument. |
<desc> is the new description for the instrument |
8819 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
8820 |
|
"<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>"). |
8821 |
</p> |
</p> |
8822 |
<p>Possible Answers: |
<p>Possible Answers: |
8823 |
</p> |
</p> |
8884 |
</p> |
</p> |
8885 |
<blockquote class="text"> |
<blockquote class="text"> |
8886 |
<p>Restricts the search to instruments, which names |
<p>Restricts the search to instruments, which names |
8887 |
satisfy the supplied search string. |
satisfy the supplied search string (encapsulated into apostrophes, |
8888 |
|
supporting escape sequences as described in chapter |
8889 |
|
"<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>"). |
8890 |
</p> |
</p> |
8891 |
</blockquote><p> |
</blockquote><p> |
8892 |
|
|
8896 |
<p>SIZE=[<min>]..[<max>] |
<p>SIZE=[<min>]..[<max>] |
8897 |
</p> |
</p> |
8898 |
<blockquote class="text"> |
<blockquote class="text"> |
8899 |
<p>Restricts the search to instruments, which |
<p>Restricts the search to instruments, which |
8900 |
size is in the specified range. If <min> is omitted, |
size is in the specified range. If <min> is omitted, |
8901 |
the search results are restricted to instruments with size less then |
the search results are restricted to instruments with size less then |
8902 |
or equal to <max>. If <max> is omitted, the |
or equal to <max>. If <max> is omitted, the |
8944 |
</p> |
</p> |
8945 |
<blockquote class="text"> |
<blockquote class="text"> |
8946 |
<p>Restricts the search to instruments with description |
<p>Restricts the search to instruments with description |
8947 |
that satisfies the supplied search string. |
that satisfies the supplied search string (encapsulated into apostrophes, |
8948 |
|
supporting escape sequences as described in chapter |
8949 |
|
"<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>"). |
8950 |
</p> |
</p> |
8951 |
</blockquote><p> |
</blockquote><p> |
8952 |
|
|
8957 |
</p> |
</p> |
8958 |
<blockquote class="text"> |
<blockquote class="text"> |
8959 |
<p>Restricts the search to instruments with product info |
<p>Restricts the search to instruments with product info |
8960 |
that satisfies the supplied search string. |
that satisfies the supplied search string (encapsulated into apostrophes, |
8961 |
|
supporting escape sequences as described in chapter |
8962 |
|
"<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>"). |
8963 |
</p> |
</p> |
8964 |
</blockquote><p> |
</blockquote><p> |
8965 |
|
|
8970 |
</p> |
</p> |
8971 |
<blockquote class="text"> |
<blockquote class="text"> |
8972 |
<p>Restricts the search to instruments with artists info |
<p>Restricts the search to instruments with artists info |
8973 |
that satisfies the supplied search string. |
that satisfies the supplied search string (encapsulated into apostrophes, |
8974 |
|
supporting escape sequences as described in chapter |
8975 |
|
"<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>"). |
8976 |
</p> |
</p> |
8977 |
</blockquote><p> |
</blockquote><p> |
8978 |
|
|
8983 |
</p> |
</p> |
8984 |
<blockquote class="text"> |
<blockquote class="text"> |
8985 |
<p>Restricts the search to instruments with keyword list |
<p>Restricts the search to instruments with keyword list |
8986 |
that satisfies the supplied search string. |
that satisfies the supplied search string (encapsulated into apostrophes, |
8987 |
|
supporting escape sequences as described in chapter |
8988 |
|
"<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>"). |
8989 |
</p> |
</p> |
8990 |
</blockquote><p> |
</blockquote><p> |
8991 |
|
|
8995 |
<p>IS_DRUM=true | false |
<p>IS_DRUM=true | false |
8996 |
</p> |
</p> |
8997 |
<blockquote class="text"> |
<blockquote class="text"> |
8998 |
<p>Either true or false. Restricts the search to |
<p>Either true or false. Restricts the search to |
8999 |
drum kits or chromatic instruments. |
drum kits or chromatic instruments. |
9000 |
</p> |
</p> |
9001 |
</blockquote><p> |
</blockquote><p> |
9155 |
</blockquote><p> |
</blockquote><p> |
9156 |
|
|
9157 |
</p> |
</p> |
9158 |
|
<a name="FORMAT INSTRUMENTS_DB"></a><br /><hr /> |
9159 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9160 |
|
<a name="rfc.section.6.8.22"></a><h3>6.8.22. |
9161 |
|
Formatting the instruments database</h3> |
9162 |
|
|
9163 |
|
<p>The front-end can remove all instruments and directories and re-create |
9164 |
|
the instruments database structure (e.g., in case of a database corruption) |
9165 |
|
by sending the following command: |
9166 |
|
</p> |
9167 |
|
<p> |
9168 |
|
</p> |
9169 |
|
<blockquote class="text"> |
9170 |
|
<p>FORMAT INSTRUMENTS_DB |
9171 |
|
</p> |
9172 |
|
</blockquote><p> |
9173 |
|
|
9174 |
|
</p> |
9175 |
|
<p>Possible Answers: |
9176 |
|
</p> |
9177 |
|
<p> |
9178 |
|
</p> |
9179 |
|
<blockquote class="text"> |
9180 |
|
<p>"OK" - |
9181 |
|
</p> |
9182 |
|
<blockquote class="text"> |
9183 |
|
<p>on success |
9184 |
|
</p> |
9185 |
|
</blockquote> |
9186 |
|
|
9187 |
|
|
9188 |
|
<p>"ERR:<error-code>:<error-message>" - |
9189 |
|
</p> |
9190 |
|
<blockquote class="text"> |
9191 |
|
<p>If the formatting of the instruments database |
9192 |
|
failed. |
9193 |
|
</p> |
9194 |
|
</blockquote> |
9195 |
|
|
9196 |
|
|
9197 |
|
</blockquote><p> |
9198 |
|
|
9199 |
|
</p> |
9200 |
|
<a name="FIND LOST DB_INSTRUMENT_FILES"></a><br /><hr /> |
9201 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9202 |
|
<a name="rfc.section.6.8.23"></a><h3>6.8.23. |
9203 |
|
Checking for lost instrument files</h3> |
9204 |
|
|
9205 |
|
<p>The front-end can retrieve the list of all instrument files in the instruments database |
9206 |
|
that don't exist in the filesystem by sending the following command: |
9207 |
|
</p> |
9208 |
|
<p> |
9209 |
|
</p> |
9210 |
|
<blockquote class="text"> |
9211 |
|
<p>FIND LOST DB_INSTRUMENT_FILES |
9212 |
|
</p> |
9213 |
|
</blockquote><p> |
9214 |
|
|
9215 |
|
</p> |
9216 |
|
<p>Possible Answers: |
9217 |
|
</p> |
9218 |
|
<p> |
9219 |
|
</p> |
9220 |
|
<blockquote class="text"> |
9221 |
|
<p>A comma separated list with the absolute path names |
9222 |
|
(encapsulated into apostrophes) of all lost instrument files. |
9223 |
|
</p> |
9224 |
|
<p>"ERR:<error-code>:<error-message>" - |
9225 |
|
</p> |
9226 |
|
<blockquote class="text"> |
9227 |
|
<p>in case it failed, providing an appropriate error code and error message. |
9228 |
|
</p> |
9229 |
|
</blockquote> |
9230 |
|
|
9231 |
|
|
9232 |
|
</blockquote><p> |
9233 |
|
|
9234 |
|
</p> |
9235 |
|
<p>Example: |
9236 |
|
</p> |
9237 |
|
<p> |
9238 |
|
</p> |
9239 |
|
<blockquote class="text"> |
9240 |
|
<p>C: "FIND LOST DB_INSTRUMENT_FILES" |
9241 |
|
</p> |
9242 |
|
<p>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'" |
9243 |
|
</p> |
9244 |
|
</blockquote><p> |
9245 |
|
|
9246 |
|
</p> |
9247 |
|
<a name="SET DB_INSTRUMENT FILE_PATH"></a><br /><hr /> |
9248 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9249 |
|
<a name="rfc.section.6.8.24"></a><h3>6.8.24. |
9250 |
|
Replacing an instrument file</h3> |
9251 |
|
|
9252 |
|
<p>The front-end can substitute all occurrences of an instrument file |
9253 |
|
in the instruments database with a new one by sending the following command: |
9254 |
|
</p> |
9255 |
|
<p> |
9256 |
|
</p> |
9257 |
|
<blockquote class="text"> |
9258 |
|
<p>SET DB_INSTRUMENT FILE_PATH <old_path> <new_path> |
9259 |
|
</p> |
9260 |
|
</blockquote><p> |
9261 |
|
|
9262 |
|
</p> |
9263 |
|
<p>Where <old_path> is the absolute path name of the instrument file |
9264 |
|
to substitute with <new_path>. |
9265 |
|
</p> |
9266 |
|
<p>Possible Answers: |
9267 |
|
</p> |
9268 |
|
<p> |
9269 |
|
</p> |
9270 |
|
<blockquote class="text"> |
9271 |
|
<p>"OK" - |
9272 |
|
</p> |
9273 |
|
<blockquote class="text"> |
9274 |
|
<p>on success |
9275 |
|
</p> |
9276 |
|
</blockquote> |
9277 |
|
|
9278 |
|
|
9279 |
|
<p>"ERR:<error-code>:<error-message>" - |
9280 |
|
</p> |
9281 |
|
<blockquote class="text"> |
9282 |
|
<p>in case it failed, providing an appropriate error code and error message. |
9283 |
|
</p> |
9284 |
|
</blockquote> |
9285 |
|
|
9286 |
|
|
9287 |
|
</blockquote><p> |
9288 |
|
|
9289 |
|
</p> |
9290 |
|
<p>Example: |
9291 |
|
</p> |
9292 |
|
<p> |
9293 |
|
</p> |
9294 |
|
<blockquote class="text"> |
9295 |
|
<p>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'" |
9296 |
|
</p> |
9297 |
|
<p>S: "OK" |
9298 |
|
</p> |
9299 |
|
</blockquote><p> |
9300 |
|
|
9301 |
|
</p> |
9302 |
|
<a name="editing_instruments"></a><br /><hr /> |
9303 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9304 |
|
<a name="rfc.section.6.9"></a><h3>6.9. |
9305 |
|
Editing Instruments</h3> |
9306 |
|
|
9307 |
|
<p>The sampler allows to edit instruments while playing with the |
9308 |
|
sampler by spawning an external (3rd party) instrument editor |
9309 |
|
application for a given instrument. The 3rd party instrument |
9310 |
|
editor applications have to place a respective plugin DLL file |
9311 |
|
into the sampler's plugins directory. The sampler will |
9312 |
|
automatically try to load all plugin DLLs in that directory on |
9313 |
|
startup and only on startup! |
9314 |
|
</p> |
9315 |
|
<p>At the moment there is only one command for this feature set, |
9316 |
|
but this will most probably change in future. |
9317 |
|
</p> |
9318 |
|
<a name="EDIT INSTRUMENT"></a><br /><hr /> |
9319 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9320 |
|
<a name="rfc.section.6.9.1"></a><h3>6.9.1. |
9321 |
|
Opening an appropriate instrument editor application</h3> |
9322 |
|
|
9323 |
|
<p>The front-end can request to open an appropriate instrument |
9324 |
|
editor application by sending the following command: |
9325 |
|
</p> |
9326 |
|
<p> |
9327 |
|
</p> |
9328 |
|
<blockquote class="text"> |
9329 |
|
<p>EDIT CHANNEL INSTRUMENT <sampler-channel> |
9330 |
|
</p> |
9331 |
|
</blockquote><p> |
9332 |
|
|
9333 |
|
</p> |
9334 |
|
<p>Where <sampler-channel> should be replaced by the |
9335 |
|
number of the sampler channel as given by the |
9336 |
|
<a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a> |
9337 |
|
or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> |
9338 |
|
command. |
9339 |
|
</p> |
9340 |
|
<p>The sampler will try to ask all registered instrument |
9341 |
|
editors (or to be more specific: their sampler plugins) |
9342 |
|
whether they are capable to handle the instrument on the |
9343 |
|
given sampler channel. The sampler will simply use the first |
9344 |
|
instrument editor application which replied with a positive |
9345 |
|
answer and spawn that instrument editor application within |
9346 |
|
the sampler's process and provide that application access |
9347 |
|
to the instrument's data structures, so both applications |
9348 |
|
can share and access the same instruments data at the same |
9349 |
|
time, thus allowing to immediately hear changes with the |
9350 |
|
sampler made by the instrument editor. |
9351 |
|
</p> |
9352 |
|
<p>Note: consequently instrument editors are always spawned |
9353 |
|
locally on the same machine where the sampler is running |
9354 |
|
on! |
9355 |
|
</p> |
9356 |
|
<p>Possible Answers: |
9357 |
|
</p> |
9358 |
|
<p> |
9359 |
|
</p> |
9360 |
|
<blockquote class="text"> |
9361 |
|
<p>"OK" - |
9362 |
|
</p> |
9363 |
|
<blockquote class="text"> |
9364 |
|
<p>when an appropriate instrument editor was |
9365 |
|
launched |
9366 |
|
</p> |
9367 |
|
</blockquote> |
9368 |
|
|
9369 |
|
|
9370 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
9371 |
|
</p> |
9372 |
|
<blockquote class="text"> |
9373 |
|
<p>when an appropriate instrument editor was |
9374 |
|
launched, but there are noteworthy issues |
9375 |
|
</p> |
9376 |
|
</blockquote> |
9377 |
|
|
9378 |
|
|
9379 |
|
<p>"ERR:<error-code>:<error-message>" - |
9380 |
|
</p> |
9381 |
|
<blockquote class="text"> |
9382 |
|
<p>when an appropriate instrument editor |
9383 |
|
could not be launched |
9384 |
|
</p> |
9385 |
|
</blockquote> |
9386 |
|
|
9387 |
|
|
9388 |
|
</blockquote><p> |
9389 |
|
|
9390 |
|
</p> |
9391 |
|
<p>Examples: |
9392 |
|
</p> |
9393 |
|
<p> |
9394 |
|
</p> |
9395 |
|
<blockquote class="text"> |
9396 |
|
<p>C: "EDIT CHANNEL INSTRUMENT 0" |
9397 |
|
</p> |
9398 |
|
<p>S: "OK" |
9399 |
|
</p> |
9400 |
|
</blockquote><p> |
9401 |
|
|
9402 |
|
</p> |
9403 |
|
<a name="file_management"></a><br /><hr /> |
9404 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9405 |
|
<a name="rfc.section.6.10"></a><h3>6.10. |
9406 |
|
Managing Files</h3> |
9407 |
|
|
9408 |
|
<p>You can query detailed informations about files located |
9409 |
|
at the same system where the sampler instance is running on. |
9410 |
|
Using this command set allows to retrieve file informations |
9411 |
|
even remotely from another machine. |
9412 |
|
</p> |
9413 |
|
<a name="GET FILE INSTRUMENTS"></a><br /><hr /> |
9414 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9415 |
|
<a name="rfc.section.6.10.1"></a><h3>6.10.1. |
9416 |
|
Retrieving amount of instruments of a file</h3> |
9417 |
|
|
9418 |
|
<p>The front-end can retrieve the amount of instruments |
9419 |
|
within a given instrument file by sending the |
9420 |
|
following command: |
9421 |
|
</p> |
9422 |
|
<p> |
9423 |
|
</p> |
9424 |
|
<blockquote class="text"> |
9425 |
|
<p>GET FILE INSTRUMENTS <filename> |
9426 |
|
</p> |
9427 |
|
</blockquote><p> |
9428 |
|
|
9429 |
|
</p> |
9430 |
|
<p>Where <filename> is the name of the instrument |
9431 |
|
file (encapsulated into apostrophes, supporting escape |
9432 |
|
sequences as described in chapter |
9433 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
9434 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
9435 |
|
</p> |
9436 |
|
<p>The sampler will try to ask all sampler engines, |
9437 |
|
whether they support the given file and ask the first |
9438 |
|
engine with a positive answer for the amount of |
9439 |
|
instruments. |
9440 |
|
</p> |
9441 |
|
<p>Possible Answers: |
9442 |
|
</p> |
9443 |
|
<p> |
9444 |
|
</p> |
9445 |
|
<blockquote class="text"> |
9446 |
|
<p>On success, the sampler will answer by |
9447 |
|
returning the amount of instruments. |
9448 |
|
|
9449 |
|
</p> |
9450 |
|
<p>"ERR:<error-code>:<error-message>" - |
9451 |
|
</p> |
9452 |
|
<blockquote class="text"> |
9453 |
|
<p>if the file could not be handled |
9454 |
|
</p> |
9455 |
|
</blockquote> |
9456 |
|
|
9457 |
|
|
9458 |
|
</blockquote><p> |
9459 |
|
|
9460 |
|
</p> |
9461 |
|
<p>Examples: |
9462 |
|
</p> |
9463 |
|
<p> |
9464 |
|
</p> |
9465 |
|
<blockquote class="text"> |
9466 |
|
<p>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'" |
9467 |
|
</p> |
9468 |
|
<p>S: "10" |
9469 |
|
</p> |
9470 |
|
</blockquote><p> |
9471 |
|
|
9472 |
|
</p> |
9473 |
|
<a name="LIST FILE INSTRUMENTS"></a><br /><hr /> |
9474 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9475 |
|
<a name="rfc.section.6.10.2"></a><h3>6.10.2. |
9476 |
|
Retrieving all instruments of a file</h3> |
9477 |
|
|
9478 |
|
<p>The front-end can retrieve a list of all instruments |
9479 |
|
within a given instrument file by sending the |
9480 |
|
following command: |
9481 |
|
</p> |
9482 |
|
<p> |
9483 |
|
</p> |
9484 |
|
<blockquote class="text"> |
9485 |
|
<p>LIST FILE INSTRUMENTS <filename> |
9486 |
|
</p> |
9487 |
|
</blockquote><p> |
9488 |
|
|
9489 |
|
</p> |
9490 |
|
<p>Where <filename> is the name of the instrument |
9491 |
|
file (encapsulated into apostrophes, supporting escape |
9492 |
|
sequences as described in chapter |
9493 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
9494 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
9495 |
|
</p> |
9496 |
|
<p>The sampler will try to ask all sampler engines, |
9497 |
|
whether they support the given file and ask the first |
9498 |
|
engine with a positive answer for a list of IDs for the |
9499 |
|
instruments in the given file. |
9500 |
|
</p> |
9501 |
|
<p>Possible Answers: |
9502 |
|
</p> |
9503 |
|
<p> |
9504 |
|
</p> |
9505 |
|
<blockquote class="text"> |
9506 |
|
<p>On success, the sampler will answer by |
9507 |
|
returning a comma separated list of |
9508 |
|
instrument IDs. |
9509 |
|
|
9510 |
|
</p> |
9511 |
|
<p>"ERR:<error-code>:<error-message>" - |
9512 |
|
</p> |
9513 |
|
<blockquote class="text"> |
9514 |
|
<p>if the file could not be handled |
9515 |
|
</p> |
9516 |
|
</blockquote> |
9517 |
|
|
9518 |
|
|
9519 |
|
</blockquote><p> |
9520 |
|
|
9521 |
|
</p> |
9522 |
|
<p>Examples: |
9523 |
|
</p> |
9524 |
|
<p> |
9525 |
|
</p> |
9526 |
|
<blockquote class="text"> |
9527 |
|
<p>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'" |
9528 |
|
</p> |
9529 |
|
<p>S: "0,1,2,3,4,5,6,7,8,9" |
9530 |
|
</p> |
9531 |
|
</blockquote><p> |
9532 |
|
|
9533 |
|
</p> |
9534 |
|
<a name="GET FILE INSTRUMENT INFO"></a><br /><hr /> |
9535 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9536 |
|
<a name="rfc.section.6.10.3"></a><h3>6.10.3. |
9537 |
|
Retrieving informations about one instrument in a file</h3> |
9538 |
|
|
9539 |
|
<p>The front-end can retrieve detailed informations |
9540 |
|
about a specific instrument within a given instrument |
9541 |
|
file by sending the following command: |
9542 |
|
</p> |
9543 |
|
<p> |
9544 |
|
</p> |
9545 |
|
<blockquote class="text"> |
9546 |
|
<p>GET FILE INSTRUMENT INFO <filename> |
9547 |
|
<instr-id> |
9548 |
|
</p> |
9549 |
|
</blockquote><p> |
9550 |
|
|
9551 |
|
</p> |
9552 |
|
<p>Where <filename> is the name of the instrument |
9553 |
|
file (encapsulated into apostrophes, supporting escape |
9554 |
|
sequences as described in chapter |
9555 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
9556 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") and <instr-id> is the numeric |
9557 |
|
instrument ID as returned by the |
9558 |
|
<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. |
9559 |
|
</p> |
9560 |
|
<p>The sampler will try to ask all sampler engines, |
9561 |
|
whether they support the given file and ask the first |
9562 |
|
engine with a positive answer for informations about the |
9563 |
|
specific instrument in the given file. |
9564 |
|
</p> |
9565 |
|
<p>Possible Answers: |
9566 |
|
</p> |
9567 |
|
<p> |
9568 |
|
</p> |
9569 |
|
<blockquote class="text"> |
9570 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
9571 |
|
Each answer line begins with the settings category name |
9572 |
|
followed by a colon and then a space character <SP> and finally |
9573 |
|
the info character string to that setting category. At the |
9574 |
|
moment the following categories are defined: |
9575 |
|
</p> |
9576 |
|
<p> |
9577 |
|
</p> |
9578 |
|
<blockquote class="text"> |
9579 |
|
<p>NAME - |
9580 |
|
</p> |
9581 |
|
<blockquote class="text"> |
9582 |
|
<p>name of the instrument as |
9583 |
|
stored in the instrument file |
9584 |
|
</p> |
9585 |
|
</blockquote> |
9586 |
|
|
9587 |
|
|
9588 |
|
<p>FORMAT_FAMILY - |
9589 |
|
</p> |
9590 |
|
<blockquote class="text"> |
9591 |
|
<p>name of the sampler format |
9592 |
|
of the given instrument |
9593 |
|
</p> |
9594 |
|
</blockquote> |
9595 |
|
|
9596 |
|
|
9597 |
|
<p>FORMAT_VERSION - |
9598 |
|
</p> |
9599 |
|
<blockquote class="text"> |
9600 |
|
<p>version of the sampler format |
9601 |
|
the instrumen is stored as |
9602 |
|
</p> |
9603 |
|
</blockquote> |
9604 |
|
|
9605 |
|
|
9606 |
|
<p>PRODUCT - |
9607 |
|
</p> |
9608 |
|
<blockquote class="text"> |
9609 |
|
<p>official product name of the |
9610 |
|
instrument as stored in the file |
9611 |
|
|
9612 |
|
</p> |
9613 |
|
</blockquote> |
9614 |
|
|
9615 |
|
|
9616 |
|
<p>ARTISTS - |
9617 |
|
</p> |
9618 |
|
<blockquote class="text"> |
9619 |
|
<p>artists / sample library |
9620 |
|
vendor of the instrument |
9621 |
|
</p> |
9622 |
|
</blockquote> |
9623 |
|
|
9624 |
|
|
9625 |
|
<p>KEY_BINDINGS - |
9626 |
|
</p> |
9627 |
|
<blockquote class="text"> |
9628 |
|
<p>comma separated list of integer values representing |
9629 |
|
the instrument's key mapping in the range between 0 .. 127, |
9630 |
|
reflecting the analog meaning of the MIDI specification. |
9631 |
|
</p> |
9632 |
|
</blockquote> |
9633 |
|
|
9634 |
|
|
9635 |
|
<p>KEYSWITCH_BINDINGS - |
9636 |
|
</p> |
9637 |
|
<blockquote class="text"> |
9638 |
|
<p>comma separated list of integer values representing |
9639 |
|
the instrument's keyswitch mapping in the range between 0 .. 127, |
9640 |
|
reflecting the analog meaning of the MIDI specification. |
9641 |
|
</p> |
9642 |
|
</blockquote> |
9643 |
|
|
9644 |
|
|
9645 |
|
</blockquote> |
9646 |
|
|
9647 |
|
|
9648 |
|
</blockquote><p> |
9649 |
|
|
9650 |
|
</p> |
9651 |
|
<p>The mentioned fields above don't have to be in particular order. |
9652 |
|
</p> |
9653 |
|
<p>Example: |
9654 |
|
</p> |
9655 |
|
<p> |
9656 |
|
</p> |
9657 |
|
<blockquote class="text"> |
9658 |
|
<p>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0" |
9659 |
|
</p> |
9660 |
|
<p>S: "NAME: Lunatic Loops" |
9661 |
|
</p> |
9662 |
|
<p> "FORMAT_FAMILY: GIG" |
9663 |
|
</p> |
9664 |
|
<p> "FORMAT_VERSION: 3" |
9665 |
|
</p> |
9666 |
|
<p> "PRODUCT: The Backbone Bongo Beats" |
9667 |
|
</p> |
9668 |
|
<p> "ARTISTS: Jimmy the Fish" |
9669 |
|
</p> |
9670 |
|
<p> "." |
9671 |
|
</p> |
9672 |
|
</blockquote><p> |
9673 |
|
|
9674 |
|
</p> |
9675 |
<a name="command_syntax"></a><br /><hr /> |
<a name="command_syntax"></a><br /><hr /> |
9676 |
<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> |
9677 |
<a name="rfc.section.7"></a><h3>7. |
<a name="rfc.section.7"></a><h3>7. |
9787 |
<p>/ COPY SP copy_instruction |
<p>/ COPY SP copy_instruction |
9788 |
|
|
9789 |
</p> |
</p> |
9790 |
|
<p>/ EDIT SP edit_instruction |
9791 |
|
|
9792 |
|
</p> |
9793 |
|
<p>/ FORMAT SP format_instruction |
9794 |
|
|
9795 |
|
</p> |
9796 |
|
<p>SEND SP send_instruction |
9797 |
|
|
9798 |
|
</p> |
9799 |
<p>/ RESET |
<p>/ RESET |
9800 |
|
|
9801 |
</p> |
</p> |
9811 |
<p>CHANNEL |
<p>CHANNEL |
9812 |
|
|
9813 |
</p> |
</p> |
9814 |
<p>/ DB_INSTRUMENT_DIRECTORY SP pathname |
<p>/ DB_INSTRUMENT_DIRECTORY SP db_path |
9815 |
|
|
9816 |
</p> |
</p> |
9817 |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP pathname SP pathname |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
9818 |
|
|
9819 |
</p> |
</p> |
9820 |
<p>/ DB_INSTRUMENTS SP scan_mode SP pathname SP pathname |
<p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
9821 |
|
|
9822 |
</p> |
</p> |
9823 |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
9824 |
|
|
9825 |
</p> |
</p> |
9826 |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP instrument_index |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index |
9827 |
|
|
9828 |
</p> |
</p> |
9829 |
<p>/ DB_INSTRUMENTS SP pathname SP pathname |
<p>/ DB_INSTRUMENTS SP db_path SP filename |
9830 |
|
|
9831 |
</p> |
</p> |
9832 |
<p>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index |
<p>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index |
9833 |
|
|
9834 |
</p> |
</p> |
9835 |
<p>/ MIDI_INSTRUMENT_MAP |
<p>/ MIDI_INSTRUMENT_MAP |
9859 |
<p>/ CHANNEL_COUNT |
<p>/ CHANNEL_COUNT |
9860 |
|
|
9861 |
</p> |
</p> |
9862 |
|
<p>/ CHANNEL_MIDI |
9863 |
|
|
9864 |
|
</p> |
9865 |
|
<p>/ DEVICE_MIDI |
9866 |
|
|
9867 |
|
</p> |
9868 |
<p>/ VOICE_COUNT |
<p>/ VOICE_COUNT |
9869 |
|
|
9870 |
</p> |
</p> |
9913 |
<p>/ MISCELLANEOUS |
<p>/ MISCELLANEOUS |
9914 |
|
|
9915 |
</p> |
</p> |
9916 |
|
<p>/ TOTAL_STREAM_COUNT |
9917 |
|
|
9918 |
|
</p> |
9919 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
9920 |
|
|
9921 |
</p> |
</p> |
9943 |
<p>/ CHANNEL_COUNT |
<p>/ CHANNEL_COUNT |
9944 |
|
|
9945 |
</p> |
</p> |
9946 |
|
<p>/ CHANNEL_MIDI |
9947 |
|
|
9948 |
|
</p> |
9949 |
|
<p>/ DEVICE_MIDI |
9950 |
|
|
9951 |
|
</p> |
9952 |
<p>/ VOICE_COUNT |
<p>/ VOICE_COUNT |
9953 |
|
|
9954 |
</p> |
</p> |
9997 |
<p>/ MISCELLANEOUS |
<p>/ MISCELLANEOUS |
9998 |
|
|
9999 |
</p> |
</p> |
10000 |
|
<p>/ TOTAL_STREAM_COUNT |
10001 |
|
|
10002 |
|
</p> |
10003 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
10004 |
|
|
10005 |
</p> |
</p> |
10048 |
<p>/ MIDI_INSTRUMENT_MAP SP ALL |
<p>/ MIDI_INSTRUMENT_MAP SP ALL |
10049 |
|
|
10050 |
</p> |
</p> |
10051 |
<p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname |
<p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
10052 |
|
|
10053 |
</p> |
</p> |
10054 |
<p>/ DB_INSTRUMENT_DIRECTORY SP pathname |
<p>/ DB_INSTRUMENT_DIRECTORY SP db_path |
10055 |
|
|
10056 |
</p> |
</p> |
10057 |
<p>/ DB_INSTRUMENT SP pathname |
<p>/ DB_INSTRUMENT SP db_path |
10058 |
|
|
10059 |
</p> |
</p> |
10060 |
</blockquote><p> |
</blockquote><p> |
10135 |
<p>/ SERVER SP INFO |
<p>/ SERVER SP INFO |
10136 |
|
|
10137 |
</p> |
</p> |
10138 |
|
<p>/ TOTAL_STREAM_COUNT |
10139 |
|
|
10140 |
|
</p> |
10141 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
10142 |
|
|
10143 |
</p> |
</p> |
10165 |
<p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
<p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
10166 |
|
|
10167 |
</p> |
</p> |
10168 |
<p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname |
<p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
10169 |
|
|
10170 |
</p> |
</p> |
10171 |
<p>/ DB_INSTRUMENT_DIRECTORIES SP pathname |
<p>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
10172 |
|
|
10173 |
</p> |
</p> |
10174 |
<p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname |
<p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path |
10175 |
|
|
10176 |
</p> |
</p> |
10177 |
<p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname |
<p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
10178 |
|
|
10179 |
</p> |
</p> |
10180 |
<p>/ DB_INSTRUMENTS SP pathname |
<p>/ DB_INSTRUMENTS SP db_path |
10181 |
|
|
10182 |
</p> |
</p> |
10183 |
<p>/ DB_INSTRUMENT SP INFO SP pathname |
<p>/ DB_INSTRUMENT SP INFO SP db_path |
10184 |
|
|
10185 |
</p> |
</p> |
10186 |
<p>/ DB_INSTRUMENTS_JOB SP INFO SP number |
<p>/ DB_INSTRUMENTS_JOB SP INFO SP number |
10189 |
<p>/ VOLUME |
<p>/ VOLUME |
10190 |
|
|
10191 |
</p> |
</p> |
10192 |
|
<p>/ FILE SP INSTRUMENTS SP filename |
10193 |
|
|
10194 |
|
</p> |
10195 |
|
<p>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
10196 |
|
|
10197 |
|
</p> |
10198 |
</blockquote><p> |
</blockquote><p> |
10199 |
|
|
10200 |
</p> |
</p> |
10210 |
<p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
<p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
10211 |
|
|
10212 |
</p> |
</p> |
10213 |
|
<p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE |
10214 |
|
|
10215 |
|
</p> |
10216 |
<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 |
10217 |
|
|
10218 |
</p> |
</p> |
10234 |
<p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
<p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
10235 |
|
|
10236 |
</p> |
</p> |
10237 |
<p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname |
<p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
10238 |
|
|
10239 |
|
</p> |
10240 |
|
<p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped |
10241 |
|
|
10242 |
</p> |
</p> |
10243 |
<p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval |
<p>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped |
10244 |
|
|
10245 |
</p> |
</p> |
10246 |
<p>/ DB_INSTRUMENT SP NAME SP pathname SP dirname |
<p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
10247 |
|
|
10248 |
</p> |
</p> |
10249 |
<p>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval |
<p>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename |
10250 |
|
|
10251 |
</p> |
</p> |
10252 |
<p>/ ECHO SP boolean |
<p>/ ECHO SP boolean |
10306 |
<p>find_instruction = |
<p>find_instruction = |
10307 |
</p> |
</p> |
10308 |
<blockquote class="text"> |
<blockquote class="text"> |
10309 |
<p>DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list |
<p>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list |
10310 |
|
|
10311 |
|
</p> |
10312 |
|
<p>/ DB_INSTRUMENTS SP db_path SP query_val_list |
10313 |
|
|
10314 |
</p> |
</p> |
10315 |
<p>/ DB_INSTRUMENTS SP pathname SP query_val_list |
<p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list |
10316 |
|
|
10317 |
</p> |
</p> |
10318 |
<p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP query_val_list |
<p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
10319 |
|
|
10320 |
</p> |
</p> |
10321 |
<p>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list |
<p>/ LOST SP DB_INSTRUMENT_FILES |
10322 |
|
|
10323 |
</p> |
</p> |
10324 |
</blockquote><p> |
</blockquote><p> |
10327 |
<p>move_instruction = |
<p>move_instruction = |
10328 |
</p> |
</p> |
10329 |
<blockquote class="text"> |
<blockquote class="text"> |
10330 |
<p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname |
<p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
10331 |
|
|
10332 |
</p> |
</p> |
10333 |
<p>/ DB_INSTRUMENT SP pathname SP pathname |
<p>/ DB_INSTRUMENT SP db_path SP db_path |
10334 |
|
|
10335 |
</p> |
</p> |
10336 |
</blockquote><p> |
</blockquote><p> |
10339 |
<p>copy_instruction = |
<p>copy_instruction = |
10340 |
</p> |
</p> |
10341 |
<blockquote class="text"> |
<blockquote class="text"> |
10342 |
<p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname |
<p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
10343 |
|
|
10344 |
</p> |
</p> |
10345 |
<p>/ DB_INSTRUMENT SP pathname SP pathname |
<p>/ DB_INSTRUMENT SP db_path SP db_path |
10346 |
|
|
10347 |
</p> |
</p> |
10348 |
</blockquote><p> |
</blockquote><p> |
10423 |
</blockquote><p> |
</blockquote><p> |
10424 |
|
|
10425 |
</p> |
</p> |
10426 |
|
<p>edit_instruction = |
10427 |
|
</p> |
10428 |
|
<blockquote class="text"> |
10429 |
|
<p>CHANNEL SP INSTRUMENT SP sampler_channel |
10430 |
|
|
10431 |
|
</p> |
10432 |
|
</blockquote><p> |
10433 |
|
|
10434 |
|
</p> |
10435 |
|
<p>format_instruction = |
10436 |
|
</p> |
10437 |
|
<blockquote class="text"> |
10438 |
|
<p>INSTRUMENTS_DB |
10439 |
|
|
10440 |
|
</p> |
10441 |
|
</blockquote><p> |
10442 |
|
|
10443 |
|
</p> |
10444 |
<p>modal_arg = |
<p>modal_arg = |
10445 |
</p> |
</p> |
10446 |
<blockquote class="text"> |
<blockquote class="text"> |
10510 |
<p>/ FX_SENDS SP sampler_channel |
<p>/ FX_SENDS SP sampler_channel |
10511 |
|
|
10512 |
</p> |
</p> |
10513 |
<p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname |
<p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
10514 |
|
|
10515 |
|
</p> |
10516 |
|
<p>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
10517 |
|
|
10518 |
</p> |
</p> |
10519 |
<p>/ DB_INSTRUMENT_DIRECTORIES SP pathname |
<p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
10520 |
|
|
10521 |
</p> |
</p> |
10522 |
<p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname |
<p>/ DB_INSTRUMENTS SP db_path |
10523 |
|
|
10524 |
</p> |
</p> |
10525 |
<p>/ DB_INSTRUMENTS SP pathname |
<p>/ FILE SP INSTRUMENTS SP filename |
10526 |
|
|
10527 |
|
</p> |
10528 |
|
</blockquote><p> |
10529 |
|
|
10530 |
|
</p> |
10531 |
|
<p>send_instruction = |
10532 |
|
</p> |
10533 |
|
<blockquote class="text"> |
10534 |
|
<p>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number |
10535 |
|
|
10536 |
</p> |
</p> |
10537 |
</blockquote><p> |
</blockquote><p> |
10714 |
</blockquote><p> |
</blockquote><p> |
10715 |
|
|
10716 |
</p> |
</p> |
10717 |
<p>pathname = |
<p>filename = |
|
</p> |
|
|
<blockquote class="text"> |
|
|
<p>stringval |
|
|
|
|
|
</p> |
|
|
</blockquote><p> |
|
|
|
|
|
</p> |
|
|
<p>dirname = |
|
10718 |
</p> |
</p> |
10719 |
<blockquote class="text"> |
<blockquote class="text"> |
10720 |
<p>stringval |
<p>path |
10721 |
|
|
10722 |
</p> |
</p> |
10723 |
</blockquote><p> |
</blockquote><p> |
10724 |
|
|
10725 |
</p> |
</p> |
10726 |
<p>filename = |
<p>db_path = |
10727 |
</p> |
</p> |
10728 |
<blockquote class="text"> |
<blockquote class="text"> |
10729 |
<p>stringval |
<p>path |
10730 |
|
|
10731 |
</p> |
</p> |
10732 |
</blockquote><p> |
</blockquote><p> |
10735 |
<p>map_name = |
<p>map_name = |
10736 |
</p> |
</p> |
10737 |
<blockquote class="text"> |
<blockquote class="text"> |
10738 |
<p>stringval |
<p>stringval_escaped |
10739 |
|
|
10740 |
</p> |
</p> |
10741 |
</blockquote><p> |
</blockquote><p> |
10744 |
<p>entry_name = |
<p>entry_name = |
10745 |
</p> |
</p> |
10746 |
<blockquote class="text"> |
<blockquote class="text"> |
10747 |
<p>stringval |
<p>stringval_escaped |
10748 |
|
|
10749 |
</p> |
</p> |
10750 |
</blockquote><p> |
</blockquote><p> |
10753 |
<p>fx_send_name = |
<p>fx_send_name = |
10754 |
</p> |
</p> |
10755 |
<blockquote class="text"> |
<blockquote class="text"> |
10756 |
<p>stringval |
<p>stringval_escaped |
10757 |
|
|
10758 |
</p> |
</p> |
10759 |
</blockquote><p> |
</blockquote><p> |
10804 |
<p>query_val = |
<p>query_val = |
10805 |
</p> |
</p> |
10806 |
<blockquote class="text"> |
<blockquote class="text"> |
10807 |
<p>string |
<p>text_escaped |
10808 |
|
|
10809 |
</p> |
</p> |
10810 |
<p>/ stringval |
<p>/ stringval_escaped |
10811 |
|
|
10812 |
</p> |
</p> |
10813 |
</blockquote><p> |
</blockquote><p> |
10828 |
</blockquote><p> |
</blockquote><p> |
10829 |
|
|
10830 |
</p> |
</p> |
10831 |
|
<a name="character_set"></a><br /><hr /> |
10832 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10833 |
|
<a name="rfc.section.7.1"></a><h3>7.1. |
10834 |
|
Character Set and Escape Sequences</h3> |
10835 |
|
|
10836 |
|
<p>Older versions of this protocol up to and including v1.1 only |
10837 |
|
supported the standard ASCII character set (ASCII code 0 - 127) |
10838 |
|
<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 |
10839 |
|
however support the Extended ASCII character set (ASCII code |
10840 |
|
0 - 255). The same group of younger protocols also support |
10841 |
|
escape sequences, but only for certain, explicitly declared |
10842 |
|
parts of the protocol. The supported escape sequences are |
10843 |
|
defined as follows: |
10844 |
|
</p><table class="full" align="center" border="0" cellpadding="2" cellspacing="2"> |
10845 |
|
<col align="left"><col align="left"> |
10846 |
|
<tr><th align="left">ASCII Character Sequence</th><th align="left">Translated into (Name)</th></tr> |
10847 |
|
<tr> |
10848 |
|
<td align="left">\n</td> |
10849 |
|
<td align="left">new line</td> |
10850 |
|
</tr> |
10851 |
|
<tr> |
10852 |
|
<td align="left">\r</td> |
10853 |
|
<td align="left">carriage return</td> |
10854 |
|
</tr> |
10855 |
|
<tr> |
10856 |
|
<td align="left">\f</td> |
10857 |
|
<td align="left">form feed</td> |
10858 |
|
</tr> |
10859 |
|
<tr> |
10860 |
|
<td align="left">\t</td> |
10861 |
|
<td align="left">horizontal tab</td> |
10862 |
|
</tr> |
10863 |
|
<tr> |
10864 |
|
<td align="left">\v</td> |
10865 |
|
<td align="left">vertical tab</td> |
10866 |
|
</tr> |
10867 |
|
<tr> |
10868 |
|
<td align="left">\'</td> |
10869 |
|
<td align="left">apostrophe</td> |
10870 |
|
</tr> |
10871 |
|
<tr> |
10872 |
|
<td align="left">\"</td> |
10873 |
|
<td align="left">quotation mark</td> |
10874 |
|
</tr> |
10875 |
|
<tr> |
10876 |
|
<td align="left">\\</td> |
10877 |
|
<td align="left">backslash</td> |
10878 |
|
</tr> |
10879 |
|
<tr> |
10880 |
|
<td align="left">\OOO</td> |
10881 |
|
<td align="left">three digit octal ASCII code of the character</td> |
10882 |
|
</tr> |
10883 |
|
<tr> |
10884 |
|
<td align="left">\xHH</td> |
10885 |
|
<td align="left">two digit hex ASCII code of the character</td> |
10886 |
|
</tr> |
10887 |
|
</table> |
10888 |
|
|
10889 |
|
<p>Notice: due to the transition of certain parts of the |
10890 |
|
protocol which now support escape sequences, a slight backward |
10891 |
|
incompatibility to protocols version v1.1 and younger has been |
10892 |
|
introduced. The only difference is that in parts of the protocol |
10893 |
|
where escape characters are now supported, a backslash characters |
10894 |
|
MUST be escaped as well (that is as double backslash), whereas |
10895 |
|
in the old versions a single backslash was sufficient. |
10896 |
|
</p> |
10897 |
|
<p>The following LSCP commands support escape sequences as part |
10898 |
|
of their filename / path based arguments and / or may contain |
10899 |
|
a filename / path with escape sequences in their response: |
10900 |
|
</p> |
10901 |
|
<blockquote class="text"> |
10902 |
|
<p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a> |
10903 |
|
</p> |
10904 |
|
<p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a> |
10905 |
|
</p> |
10906 |
|
<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> |
10907 |
|
</p> |
10908 |
|
<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> |
10909 |
|
</p> |
10910 |
|
<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> |
10911 |
|
</p> |
10912 |
|
<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> |
10913 |
|
</p> |
10914 |
|
<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> |
10915 |
|
</p> |
10916 |
|
<p><a class='info' href='#REMOVE DB_INSTRUMENT'>"REMOVE DB_INSTRUMENT"<span> (</span><span class='info'>Removing an instrument</span><span>)</span></a> |
10917 |
|
</p> |
10918 |
|
<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> |
10919 |
|
</p> |
10920 |
|
<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> |
10921 |
|
</p> |
10922 |
|
<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> |
10923 |
|
</p> |
10924 |
|
<p><a class='info' href='#GET DB_INSTRUMENTS'>"GET DB_INSTRUMENTS"<span> (</span><span class='info'>Getting amount of instruments</span><span>)</span></a> |
10925 |
|
</p> |
10926 |
|
<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> |
10927 |
|
</p> |
10928 |
|
<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> |
10929 |
|
</p> |
10930 |
|
<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> |
10931 |
|
</p> |
10932 |
|
<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> |
10933 |
|
</p> |
10934 |
|
<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> |
10935 |
|
</p> |
10936 |
|
<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> |
10937 |
|
</p> |
10938 |
|
<p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a> |
10939 |
|
</p> |
10940 |
|
<p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a> |
10941 |
|
</p> |
10942 |
|
<p><a class='info' href='#MOVE DB_INSTRUMENT'>"MOVE DB_INSTRUMENT"<span> (</span><span class='info'>Moving an instrument</span><span>)</span></a> |
10943 |
|
</p> |
10944 |
|
<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> |
10945 |
|
</p> |
10946 |
|
<p><a class='info' href='#COPY DB_INSTRUMENT'>"COPY DB_INSTRUMENT"<span> (</span><span class='info'>Copying instruments</span><span>)</span></a> |
10947 |
|
</p> |
10948 |
|
<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> |
10949 |
|
</p> |
10950 |
|
<p><a class='info' href='#FIND LOST DB_INSTRUMENT_FILES'>"FIND LOST DB_INSTRUMENT_FILES"<span> (</span><span class='info'>Checking for lost instrument files</span><span>)</span></a> |
10951 |
|
</p> |
10952 |
|
<p><a class='info' href='#SET DB_INSTRUMENT FILE_PATH'>"SET DB_INSTRUMENT FILE_PATH"<span> (</span><span class='info'>Replacing an instrument file</span><span>)</span></a> |
10953 |
|
</p> |
10954 |
|
<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> |
10955 |
|
</p> |
10956 |
|
<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> |
10957 |
|
</p> |
10958 |
|
<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> |
10959 |
|
</p> |
10960 |
|
</blockquote><p> |
10961 |
|
Note that the forward slash character ('/') has a special meaning in |
10962 |
|
filename / path based arguments: it acts as separator of the nodes in |
10963 |
|
the path, thus if a directory- or filename includes a forward slash |
10964 |
|
(not intended as path node separator), you MUST escape that slash |
10965 |
|
either with the respective hex escape sequence ("\x2f") or with the |
10966 |
|
respective octal escape sequence ("\057"). |
10967 |
|
|
10968 |
|
</p> |
10969 |
|
<p> |
10970 |
|
Note for Windows: file path arguments in LSCP are expected |
10971 |
|
to use forward slashes as directory node separator similar |
10972 |
|
to Unix based operating systems. In contrast to Unix however |
10973 |
|
a Windows typical drive character is expected to be |
10974 |
|
prefixed to the path. That is an original Windows file path |
10975 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
10976 |
|
"D:/Sounds/My.gig". |
10977 |
|
|
10978 |
|
</p> |
10979 |
|
<p> |
10980 |
|
The following LSCP commands even support escape sequences as |
10981 |
|
part of at least one of their text-based arguments (i.e. entity name, |
10982 |
|
description) and / or may contain escape sequences in at least one of |
10983 |
|
their text-based fields in their response: |
10984 |
|
</p> |
10985 |
|
<blockquote class="text"> |
10986 |
|
<p><a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a> |
10987 |
|
</p> |
10988 |
|
<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> |
10989 |
|
</p> |
10990 |
|
<p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a> |
10991 |
|
</p> |
10992 |
|
<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> |
10993 |
|
</p> |
10994 |
|
<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> |
10995 |
|
</p> |
10996 |
|
<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> |
10997 |
|
</p> |
10998 |
|
<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> |
10999 |
|
</p> |
11000 |
|
<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> |
11001 |
|
</p> |
11002 |
|
<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> |
11003 |
|
</p> |
11004 |
|
<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> |
11005 |
|
</p> |
11006 |
|
<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> |
11007 |
|
</p> |
11008 |
|
<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> |
11009 |
|
</p> |
11010 |
|
<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> |
11011 |
|
</p> |
11012 |
|
<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> |
11013 |
|
</p> |
11014 |
|
<p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a> |
11015 |
|
</p> |
11016 |
|
<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> |
11017 |
|
</p> |
11018 |
|
<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> |
11019 |
|
</p> |
11020 |
|
<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> |
11021 |
|
</p> |
11022 |
|
<p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a> |
11023 |
|
</p> |
11024 |
|
</blockquote><p> |
11025 |
|
Please note that these lists are manually maintained. If you |
11026 |
|
find a command that also supports escape sequences we forgot to |
11027 |
|
mention here, please report it! |
11028 |
|
|
11029 |
|
</p> |
11030 |
<a name="events"></a><br /><hr /> |
<a name="events"></a><br /><hr /> |
11031 |
<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> |
11032 |
<a name="rfc.section.8"></a><h3>8. |
<a name="rfc.section.8"></a><h3>8. |
11187 |
<p>where <channels> will be replaced by the new number |
<p>where <channels> will be replaced by the new number |
11188 |
of sampler channels. |
of sampler channels. |
11189 |
</p> |
</p> |
11190 |
<a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE CHANNEL_MIDI"></a><br /><hr /> |
11191 |
<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> |
11192 |
<a name="rfc.section.8.6"></a><h3>8.6. |
<a name="rfc.section.8.6"></a><h3>8.6. |
11193 |
|
MIDI data on a sampler channel arrived</h3> |
11194 |
|
|
11195 |
|
<p>Client may want to be notified when MIDI data arrive on sampler channels on |
11196 |
|
back-end side, by issuing the following command: |
11197 |
|
</p> |
11198 |
|
<p> |
11199 |
|
</p> |
11200 |
|
<blockquote class="text"> |
11201 |
|
<p>SUBSCRIBE CHANNEL_MIDI |
11202 |
|
</p> |
11203 |
|
</blockquote><p> |
11204 |
|
|
11205 |
|
</p> |
11206 |
|
<p>Server will start sending one of the the following notification messages: |
11207 |
|
</p> |
11208 |
|
<p> |
11209 |
|
</p> |
11210 |
|
<blockquote class="text"> |
11211 |
|
<p>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>" |
11212 |
|
</p> |
11213 |
|
<p>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>" |
11214 |
|
</p> |
11215 |
|
</blockquote><p> |
11216 |
|
|
11217 |
|
</p> |
11218 |
|
<p>where <channel-id> will be replaced by the ID of the sampler channel where the MIDI |
11219 |
|
data arrived. <note> and <velocity> are integer values in the range between |
11220 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
11221 |
|
|
11222 |
|
</p> |
11223 |
|
<p>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
11224 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
11225 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
11226 |
|
thread unaffected by this feature. |
11227 |
|
</p> |
11228 |
|
<a name="SUBSCRIBE DEVICE_MIDI"></a><br /><hr /> |
11229 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11230 |
|
<a name="rfc.section.8.7"></a><h3>8.7. |
11231 |
|
MIDI data on a MIDI input device arrived</h3> |
11232 |
|
|
11233 |
|
<p>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command: |
11234 |
|
</p> |
11235 |
|
<p> |
11236 |
|
</p> |
11237 |
|
<blockquote class="text"> |
11238 |
|
<p>SUBSCRIBE DEVICE_MIDI |
11239 |
|
</p> |
11240 |
|
</blockquote><p> |
11241 |
|
|
11242 |
|
</p> |
11243 |
|
<p>Server will start sending one of the the following notification messages: |
11244 |
|
</p> |
11245 |
|
<p> |
11246 |
|
</p> |
11247 |
|
<blockquote class="text"> |
11248 |
|
<p>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note> <velocity>" |
11249 |
|
</p> |
11250 |
|
<p>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note> <velocity>" |
11251 |
|
</p> |
11252 |
|
</blockquote><p> |
11253 |
|
|
11254 |
|
</p> |
11255 |
|
<p>where <device-id> <port-id> will be replaced |
11256 |
|
by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI |
11257 |
|
data arrived. <note> and <velocity> are integer values in the range between |
11258 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
11259 |
|
|
11260 |
|
</p> |
11261 |
|
<p>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
11262 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
11263 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
11264 |
|
thread unaffected by this feature. |
11265 |
|
</p> |
11266 |
|
<a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr /> |
11267 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11268 |
|
<a name="rfc.section.8.8"></a><h3>8.8. |
11269 |
Number of active voices changed</h3> |
Number of active voices changed</h3> |
11270 |
|
|
11271 |
<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 |
11295 |
</p> |
</p> |
11296 |
<a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr /> |
11297 |
<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> |
11298 |
<a name="rfc.section.8.7"></a><h3>8.7. |
<a name="rfc.section.8.9"></a><h3>8.9. |
11299 |
Number of active disk streams changed</h3> |
Number of active disk streams changed</h3> |
11300 |
|
|
11301 |
<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 |
11325 |
</p> |
</p> |
11326 |
<a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr /> |
<a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr /> |
11327 |
<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> |
11328 |
<a name="rfc.section.8.8"></a><h3>8.8. |
<a name="rfc.section.8.10"></a><h3>8.10. |
11329 |
Disk stream buffer fill state changed</h3> |
Disk stream buffer fill state changed</h3> |
11330 |
|
|
11331 |
<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 |
11356 |
</p> |
</p> |
11357 |
<a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr /> |
11358 |
<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> |
11359 |
<a name="rfc.section.8.9"></a><h3>8.9. |
<a name="rfc.section.8.11"></a><h3>8.11. |
11360 |
Channel information changed</h3> |
Channel information changed</h3> |
11361 |
|
|
11362 |
<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 |
11389 |
</p> |
</p> |
11390 |
<a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr /> |
11391 |
<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> |
11392 |
<a name="rfc.section.8.10"></a><h3>8.10. |
<a name="rfc.section.8.12"></a><h3>8.12. |
11393 |
Number of effect sends changed</h3> |
Number of effect sends changed</h3> |
11394 |
|
|
11395 |
<p>Client may want to be notified when the number of effect sends on |
<p>Client may want to be notified when the number of effect sends on |
11396 |
a particular sampler channel is changed by issuing the following command: |
a particular sampler channel is changed by issuing the following command: |
11397 |
</p> |
</p> |
11398 |
<p> |
<p> |
11419 |
</p> |
</p> |
11420 |
<a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr /> |
11421 |
<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> |
11422 |
<a name="rfc.section.8.11"></a><h3>8.11. |
<a name="rfc.section.8.13"></a><h3>8.13. |
11423 |
Effect send information changed</h3> |
Effect send information changed</h3> |
11424 |
|
|
11425 |
<p>Client may want to be notified when changes were made to effect sends on a |
<p>Client may want to be notified when changes were made to effect sends on a |
11449 |
</p> |
</p> |
11450 |
<a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr /> |
11451 |
<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> |
11452 |
<a name="rfc.section.8.12"></a><h3>8.12. |
<a name="rfc.section.8.14"></a><h3>8.14. |
11453 |
Total number of active voices changed</h3> |
Total number of active voices changed</h3> |
11454 |
|
|
11455 |
<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 |
11476 |
<p>where <voices> will be replaced by the new number of |
<p>where <voices> will be replaced by the new number of |
11477 |
all currently active voices. |
all currently active voices. |
11478 |
</p> |
</p> |
11479 |
|
<a name="SUBSCRIBE TOTAL_STREAM_COUNT"></a><br /><hr /> |
11480 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11481 |
|
<a name="rfc.section.8.15"></a><h3>8.15. |
11482 |
|
Total number of active disk streams changed</h3> |
11483 |
|
|
11484 |
|
<p>Client may want to be notified when the total number of disk streams on the |
11485 |
|
back-end changes by issuing the following command: |
11486 |
|
</p> |
11487 |
|
<p> |
11488 |
|
</p> |
11489 |
|
<blockquote class="text"> |
11490 |
|
<p>SUBSCRIBE TOTAL_STREAM_COUNT |
11491 |
|
</p> |
11492 |
|
</blockquote><p> |
11493 |
|
|
11494 |
|
</p> |
11495 |
|
<p>Server will start sending the following notification messages: |
11496 |
|
</p> |
11497 |
|
<p> |
11498 |
|
</p> |
11499 |
|
<blockquote class="text"> |
11500 |
|
<p>"NOTIFY:TOTAL_STREAM_COUNT:<streams>" |
11501 |
|
</p> |
11502 |
|
</blockquote><p> |
11503 |
|
|
11504 |
|
</p> |
11505 |
|
<p>where <streams> will be replaced by the new number of |
11506 |
|
all currently active disk streams. |
11507 |
|
</p> |
11508 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr /> |
11509 |
<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> |
11510 |
<a name="rfc.section.8.13"></a><h3>8.13. |
<a name="rfc.section.8.16"></a><h3>8.16. |
11511 |
Number of MIDI instrument maps changed</h3> |
Number of MIDI instrument maps changed</h3> |
11512 |
|
|
11513 |
<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 |
11536 |
</p> |
</p> |
11537 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr /> |
11538 |
<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> |
11539 |
<a name="rfc.section.8.14"></a><h3>8.14. |
<a name="rfc.section.8.17"></a><h3>8.17. |
11540 |
MIDI instrument map information changed</h3> |
MIDI instrument map information changed</h3> |
11541 |
|
|
11542 |
<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 |
11569 |
</p> |
</p> |
11570 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr /> |
11571 |
<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> |
11572 |
<a name="rfc.section.8.15"></a><h3>8.15. |
<a name="rfc.section.8.18"></a><h3>8.18. |
11573 |
Number of MIDI instruments changed</h3> |
Number of MIDI instruments changed</h3> |
11574 |
|
|
11575 |
<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 |
11599 |
</p> |
</p> |
11600 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr /> |
11601 |
<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> |
11602 |
<a name="rfc.section.8.16"></a><h3>8.16. |
<a name="rfc.section.8.19"></a><h3>8.19. |
11603 |
MIDI instrument information changed</h3> |
MIDI instrument information changed</h3> |
11604 |
|
|
11605 |
<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 |
11633 |
</p> |
</p> |
11634 |
<a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr /> |
11635 |
<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> |
11636 |
<a name="rfc.section.8.17"></a><h3>8.17. |
<a name="rfc.section.8.20"></a><h3>8.20. |
11637 |
Global settings changed</h3> |
Global settings changed</h3> |
11638 |
|
|
11639 |
<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 |
11662 |
</p> |
</p> |
11663 |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
11664 |
<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> |
11665 |
<a name="rfc.section.8.18"></a><h3>8.18. |
<a name="rfc.section.8.21"></a><h3>8.21. |
11666 |
Number of database instrument directories changed</h3> |
Number of database instrument directories changed</h3> |
11667 |
|
|
11668 |
<p>Client may want to be notified when the number of instrument |
<p>Client may want to be notified when the number of instrument |
11696 |
</p> |
</p> |
11697 |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr /> |
11698 |
<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> |
11699 |
<a name="rfc.section.8.19"></a><h3>8.19. |
<a name="rfc.section.8.22"></a><h3>8.22. |
11700 |
Database instrument directory information changed</h3> |
Database instrument directory information changed</h3> |
11701 |
|
|
11702 |
<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 |
11741 |
</p> |
</p> |
11742 |
<a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr /> |
11743 |
<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> |
11744 |
<a name="rfc.section.8.20"></a><h3>8.20. |
<a name="rfc.section.8.23"></a><h3>8.23. |
11745 |
Number of database instruments changed</h3> |
Number of database instruments changed</h3> |
11746 |
|
|
11747 |
<p>Client may want to be notified when the number of instruments |
<p>Client may want to be notified when the number of instruments |
11775 |
</p> |
</p> |
11776 |
<a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr /> |
11777 |
<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> |
11778 |
<a name="rfc.section.8.21"></a><h3>8.21. |
<a name="rfc.section.8.24"></a><h3>8.24. |
11779 |
Database instrument information changed</h3> |
Database instrument information changed</h3> |
11780 |
|
|
11781 |
<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 |
11820 |
</p> |
</p> |
11821 |
<a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr /> |
11822 |
<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> |
11823 |
<a name="rfc.section.8.22"></a><h3>8.22. |
<a name="rfc.section.8.25"></a><h3>8.25. |
11824 |
Database job status information changed</h3> |
Database job status information changed</h3> |
11825 |
|
|
11826 |
<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 |
11853 |
</p> |
</p> |
11854 |
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr /> |
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr /> |
11855 |
<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> |
11856 |
<a name="rfc.section.8.23"></a><h3>8.23. |
<a name="rfc.section.8.26"></a><h3>8.26. |
11857 |
Miscellaneous and debugging events</h3> |
Miscellaneous and debugging events</h3> |
11858 |
|
|
11859 |
<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 |
11918 |
<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> |
11919 |
<h3>11. References</h3> |
<h3>11. References</h3> |
11920 |
<table width="99%" border="0"> |
<table width="99%" border="0"> |
11921 |
|
<tr><td class="author-text" valign="top"><a name="RFC20">[RFC20]</a></td> |
11922 |
|
<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> |
11923 |
<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> |
11924 |
<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> |
11925 |
<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> |
11950 |
<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> |
11951 |
<h3>Full Copyright Statement</h3> |
<h3>Full Copyright Statement</h3> |
11952 |
<p class='copyright'> |
<p class='copyright'> |
11953 |
Copyright © The IETF Trust (2007).</p> |
Copyright © The IETF Trust (2008).</p> |
11954 |
<p class='copyright'> |
<p class='copyright'> |
11955 |
This document is subject to the rights, |
This document is subject to the rights, |
11956 |
licenses and restrictions contained in BCP 78, |
licenses and restrictions contained in BCP 78, |