3 |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
4 |
<meta name="description" content="LinuxSampler Control Protocol"> |
<meta name="description" content="LinuxSampler Control Protocol"> |
5 |
<meta name="keywords" content="LSCP"> |
<meta name="keywords" content="LSCP"> |
6 |
<meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)"> |
<meta name="generator" content="xml2rfc v1.35 (http://xml.resource.org/)"> |
7 |
<style type='text/css'><!-- |
<style type='text/css'><!-- |
8 |
body { |
body { |
9 |
font-family: verdana, charcoal, helvetica, arial, sans-serif; |
font-family: verdana, charcoal, helvetica, arial, sans-serif; |
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: April 8, 2011</td><td class="header">October 5, 2010</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.5</h1> |
151 |
|
|
152 |
|
<h3>Abstract</h3> |
153 |
|
|
154 |
|
<p>The LinuxSampler Control Protocol (LSCP) is an |
155 |
|
application-level protocol primarily intended for local and |
156 |
|
remote controlling the LinuxSampler backend application, which is a |
157 |
|
sophisticated server-like console application essentially playing |
158 |
|
back audio samples and manipulating the samples in real time to |
159 |
|
certain extent. |
160 |
|
</p> |
161 |
<h3>Status of this Memo</h3> |
<h3>Status of this Memo</h3> |
162 |
<p> |
<p> |
163 |
By submitting this Internet-Draft, |
By submitting this Internet-Draft, |
167 |
in accordance with Section 6 of BCP 79.</p> |
in accordance with Section 6 of BCP 79.</p> |
168 |
<p> |
<p> |
169 |
Internet-Drafts are working documents of the Internet Engineering |
Internet-Drafts are working documents of the Internet Engineering |
170 |
Task Force (IETF), its areas, and its working groups. |
Task Force (IETF). Note that other groups may also distribute |
171 |
Note that other groups may also distribute working documents as |
working documents as Internet-Drafts. The list of current |
172 |
Internet-Drafts.</p> |
Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.</p> |
173 |
<p> |
<p> |
174 |
Internet-Drafts are draft documents valid for a maximum of six months |
Internet-Drafts are draft documents valid for a maximum of six months |
175 |
and may be updated, replaced, or obsoleted by other documents at any time. |
and may be updated, replaced, or obsoleted by other documents at any time. |
176 |
It is inappropriate to use Internet-Drafts as reference material or to cite |
It is inappropriate to use Internet-Drafts as reference material or to cite |
177 |
them other than as “work in progress.”</p> |
them other than as “work in progress.”</p> |
178 |
<p> |
<p> |
179 |
The list of current Internet-Drafts can be accessed at |
This Internet-Draft will expire on April 8, 2011.</p> |
180 |
<a href='http://www.ietf.org/ietf/1id-abstracts.txt'>http://www.ietf.org/ietf/1id-abstracts.txt</a>.</p> |
<a name="toc"></a><br /><hr /> |
|
<p> |
|
|
The list of Internet-Draft Shadow Directories can be accessed at |
|
|
<a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p> |
|
|
<p> |
|
|
This Internet-Draft will expire on November 25, 2007.</p> |
|
|
|
|
|
<h3>Copyright Notice</h3> |
|
|
<p> |
|
|
Copyright © The IETF Trust (2007).</p> |
|
|
|
|
|
<h3>Abstract</h3> |
|
|
|
|
|
<p>The LinuxSampler Control Protocol (LSCP) is an |
|
|
application-level protocol primarily intended for local and |
|
|
remote controlling the LinuxSampler backend application, which is a |
|
|
sophisticated server-like console application essentially playing |
|
|
back audio samples and manipulating the samples in real time to |
|
|
certain extent. |
|
|
</p><a name="toc"></a><br /><hr /> |
|
181 |
<h3>Table of Contents</h3> |
<h3>Table of Contents</h3> |
182 |
<p class="toc"> |
<p class="toc"> |
183 |
<a href="#anchor1">1.</a> |
<a href="#anchor1">1.</a> |
322 |
Changing effect send's name<br /> |
Changing effect send's name<br /> |
323 |
<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a> |
<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a> |
324 |
Altering effect send's audio routing<br /> |
Altering effect send's audio routing<br /> |
325 |
<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.32.</a> |
<a href="#SET FX_SEND SEND_EFFECT">6.4.32.</a> |
326 |
|
Assigning destination effect to an effect send<br /> |
327 |
|
<a href="#REMOVE FX_SEND SEND_EFFECT">6.4.33.</a> |
328 |
|
Removing destination effect from an effect send<br /> |
329 |
|
<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.34.</a> |
330 |
Altering effect send's MIDI controller<br /> |
Altering effect send's MIDI controller<br /> |
331 |
<a href="#SET FX_SEND LEVEL">6.4.33.</a> |
<a href="#SET FX_SEND LEVEL">6.4.35.</a> |
332 |
Altering effect send's send level<br /> |
Altering effect send's send level<br /> |
333 |
<a href="#RESET CHANNEL">6.4.34.</a> |
<a href="#SEND CHANNEL MIDI_DATA">6.4.36.</a> |
334 |
|
Sending MIDI messages to sampler channel<br /> |
335 |
|
<a href="#RESET CHANNEL">6.4.37.</a> |
336 |
Resetting a sampler channel<br /> |
Resetting a sampler channel<br /> |
337 |
<a href="#anchor12">6.5.</a> |
<a href="#anchor12">6.5.</a> |
338 |
Controlling connection<br /> |
Controlling connection<br /> |
350 |
Current number of active voices<br /> |
Current number of active voices<br /> |
351 |
<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a> |
<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a> |
352 |
Maximum amount of active voices<br /> |
Maximum amount of active voices<br /> |
353 |
<a href="#RESET">6.6.3.</a> |
<a href="#GET TOTAL_STREAM_COUNT">6.6.3.</a> |
354 |
|
Current number of active disk streams<br /> |
355 |
|
<a href="#RESET">6.6.4.</a> |
356 |
Reset sampler<br /> |
Reset sampler<br /> |
357 |
<a href="#GET SERVER INFO">6.6.4.</a> |
<a href="#GET SERVER INFO">6.6.5.</a> |
358 |
General sampler informations<br /> |
General sampler informations<br /> |
359 |
<a href="#GET VOLUME">6.6.5.</a> |
<a href="#GET VOLUME">6.6.6.</a> |
360 |
Getting global volume attenuation<br /> |
Getting global volume attenuation<br /> |
361 |
<a href="#SET VOLUME">6.6.6.</a> |
<a href="#SET VOLUME">6.6.7.</a> |
362 |
Setting global volume attenuation<br /> |
Setting global volume attenuation<br /> |
363 |
|
<a href="#GET VOICES">6.6.8.</a> |
364 |
|
Getting global voice limit<br /> |
365 |
|
<a href="#SET VOICES">6.6.9.</a> |
366 |
|
Setting global voice limit<br /> |
367 |
|
<a href="#GET STREAMS">6.6.10.</a> |
368 |
|
Getting global disk stream limit<br /> |
369 |
|
<a href="#SET STREAMS">6.6.11.</a> |
370 |
|
Setting global disk stream limit<br /> |
371 |
<a href="#MIDI Instrument Mapping">6.7.</a> |
<a href="#MIDI Instrument Mapping">6.7.</a> |
372 |
MIDI Instrument Mapping<br /> |
MIDI Instrument Mapping<br /> |
373 |
<a href="#ADD MIDI_INSTRUMENT MAP">6.7.1.</a> |
<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a> |
374 |
Create a new MIDI instrument map<br /> |
Create a new MIDI instrument map<br /> |
375 |
<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a> |
<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a> |
376 |
Delete one particular or all MIDI instrument maps<br /> |
Delete one particular or all MIDI instrument maps<br /> |
438 |
Finding instruments<br /> |
Finding instruments<br /> |
439 |
<a href="#GET DB_INSTRUMENTS_JOB INFO">6.8.21.</a> |
<a href="#GET DB_INSTRUMENTS_JOB INFO">6.8.21.</a> |
440 |
Getting job status information<br /> |
Getting job status information<br /> |
441 |
|
<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a> |
442 |
|
Formatting the instruments database<br /> |
443 |
|
<a href="#FIND LOST DB_INSTRUMENT_FILES">6.8.23.</a> |
444 |
|
Checking for lost instrument files<br /> |
445 |
|
<a href="#SET DB_INSTRUMENT FILE_PATH">6.8.24.</a> |
446 |
|
Replacing an instrument file<br /> |
447 |
|
<a href="#editing_instruments">6.9.</a> |
448 |
|
Editing Instruments<br /> |
449 |
|
<a href="#EDIT INSTRUMENT">6.9.1.</a> |
450 |
|
Opening an appropriate instrument editor application<br /> |
451 |
|
<a href="#file_management">6.10.</a> |
452 |
|
Managing Files<br /> |
453 |
|
<a href="#GET FILE INSTRUMENTS">6.10.1.</a> |
454 |
|
Retrieving amount of instruments of a file<br /> |
455 |
|
<a href="#LIST FILE INSTRUMENTS">6.10.2.</a> |
456 |
|
Retrieving all instruments of a file<br /> |
457 |
|
<a href="#GET FILE INSTRUMENT INFO">6.10.3.</a> |
458 |
|
Retrieving informations about one instrument in a file<br /> |
459 |
|
<a href="#effects">6.11.</a> |
460 |
|
Managing Effects<br /> |
461 |
|
<a href="#GET AVAILABLE_EFFECTS">6.11.1.</a> |
462 |
|
Retrieve amount of available effects<br /> |
463 |
|
<a href="#LIST AVAILABLE_EFFECTS">6.11.2.</a> |
464 |
|
Get list of available effects<br /> |
465 |
|
<a href="#GET EFFECT INFO">6.11.3.</a> |
466 |
|
Retrieving general information about an effect<br /> |
467 |
|
<a href="#CREATE EFFECT_INSTANCE">6.11.4.</a> |
468 |
|
Creating an instance of an effect by its portable ID<br /> |
469 |
|
<a href="#CREATE EFFECT_INSTANCE (non-portable)">6.11.5.</a> |
470 |
|
Creating an instance of an effect by its numerical ID<br /> |
471 |
|
<a href="#DESTROY EFFECT_INSTANCE">6.11.6.</a> |
472 |
|
Destroy an effect instance<br /> |
473 |
|
<a href="#GET EFFECT_INSTANCES">6.11.7.</a> |
474 |
|
Retrieve amount of effect instances<br /> |
475 |
|
<a href="#LIST EFFECT_INSTANCES">6.11.8.</a> |
476 |
|
Get list of effect instances<br /> |
477 |
|
<a href="#GET EFFECT_INSTANCE INFO">6.11.9.</a> |
478 |
|
Retrieving current information about an effect instance<br /> |
479 |
|
<a href="#GET EFFECT_INSTANCE_INPUT_CONTROL INFO">6.11.10.</a> |
480 |
|
Retrieving information about an effect parameter<br /> |
481 |
|
<a href="#SET EFFECT_INSTANCE_INPUT_CONTROL VALUE">6.11.11.</a> |
482 |
|
Altering an effect parameter<br /> |
483 |
|
<a href="#GET SEND_EFFECT_CHAINS">6.11.12.</a> |
484 |
|
Retrieve amount of send effect chains<br /> |
485 |
|
<a href="#LIST SEND_EFFECT_CHAINS">6.11.13.</a> |
486 |
|
Retrieve list of send effect chains<br /> |
487 |
|
<a href="#ADD SEND_EFFECT_CHAIN">6.11.14.</a> |
488 |
|
Add send effect chain<br /> |
489 |
|
<a href="#REMOVE SEND_EFFECT_CHAIN">6.11.15.</a> |
490 |
|
Remove send effect chain<br /> |
491 |
|
<a href="#GET SEND_EFFECT_CHAIN INFO">6.11.16.</a> |
492 |
|
Retrieving information about a send effect chain<br /> |
493 |
|
<a href="#APPEND SEND_EFFECT_CHAIN EFFECT">6.11.17.</a> |
494 |
|
Append effect instance to a send effect chain<br /> |
495 |
|
<a href="#INSERT SEND_EFFECT_CHAIN EFFECT">6.11.18.</a> |
496 |
|
Insert effect instance to a send effect chain<br /> |
497 |
|
<a href="#REMOVE SEND_EFFECT_CHAIN EFFECT">6.11.19.</a> |
498 |
|
Remove effect instance from send effect chain<br /> |
499 |
<a href="#command_syntax">7.</a> |
<a href="#command_syntax">7.</a> |
500 |
Command Syntax<br /> |
Command Syntax<br /> |
501 |
|
<a href="#character_set">7.1.</a> |
502 |
|
Character Set and Escape Sequences<br /> |
503 |
<a href="#events">8.</a> |
<a href="#events">8.</a> |
504 |
Events<br /> |
Events<br /> |
505 |
<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a> |
<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a> |
512 |
MIDI input device's settings changed<br /> |
MIDI input device's settings changed<br /> |
513 |
<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a> |
<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a> |
514 |
Number of sampler channels changed<br /> |
Number of sampler channels changed<br /> |
515 |
<a href="#SUBSCRIBE VOICE_COUNT">8.6.</a> |
<a href="#SUBSCRIBE CHANNEL_MIDI">8.6.</a> |
516 |
|
MIDI data on a sampler channel arrived<br /> |
517 |
|
<a href="#SUBSCRIBE DEVICE_MIDI">8.7.</a> |
518 |
|
MIDI data on a MIDI input device arrived<br /> |
519 |
|
<a href="#SUBSCRIBE VOICE_COUNT">8.8.</a> |
520 |
Number of active voices changed<br /> |
Number of active voices changed<br /> |
521 |
<a href="#SUBSCRIBE STREAM_COUNT">8.7.</a> |
<a href="#SUBSCRIBE STREAM_COUNT">8.9.</a> |
522 |
Number of active disk streams changed<br /> |
Number of active disk streams changed<br /> |
523 |
<a href="#SUBSCRIBE BUFFER_FILL">8.8.</a> |
<a href="#SUBSCRIBE BUFFER_FILL">8.10.</a> |
524 |
Disk stream buffer fill state changed<br /> |
Disk stream buffer fill state changed<br /> |
525 |
<a href="#SUBSCRIBE CHANNEL_INFO">8.9.</a> |
<a href="#SUBSCRIBE CHANNEL_INFO">8.11.</a> |
526 |
Channel information changed<br /> |
Channel information changed<br /> |
527 |
<a href="#SUBSCRIBE FX_SEND_COUNT">8.10.</a> |
<a href="#SUBSCRIBE FX_SEND_COUNT">8.12.</a> |
528 |
Number of effect sends changed<br /> |
Number of effect sends changed<br /> |
529 |
<a href="#SUBSCRIBE FX_SEND_INFO">8.11.</a> |
<a href="#SUBSCRIBE FX_SEND_INFO">8.13.</a> |
530 |
Effect send information changed<br /> |
Effect send information changed<br /> |
531 |
<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a> |
<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.14.</a> |
532 |
Total number of active voices changed<br /> |
Total number of active voices changed<br /> |
533 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.13.</a> |
<a href="#SUBSCRIBE TOTAL_STREAM_COUNT">8.15.</a> |
534 |
|
Total number of active disk streams changed<br /> |
535 |
|
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.16.</a> |
536 |
Number of MIDI instrument maps changed<br /> |
Number of MIDI instrument maps changed<br /> |
537 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.14.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.17.</a> |
538 |
MIDI instrument map information changed<br /> |
MIDI instrument map information changed<br /> |
539 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.15.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.18.</a> |
540 |
Number of MIDI instruments changed<br /> |
Number of MIDI instruments changed<br /> |
541 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.16.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.19.</a> |
542 |
MIDI instrument information changed<br /> |
MIDI instrument information changed<br /> |
543 |
<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a> |
<a href="#SUBSCRIBE GLOBAL_INFO">8.20.</a> |
544 |
Global settings changed<br /> |
Global settings changed<br /> |
545 |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.18.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.21.</a> |
546 |
Number of database instrument directories changed<br /> |
Number of database instrument directories changed<br /> |
547 |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.19.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.22.</a> |
548 |
Database instrument directory information changed<br /> |
Database instrument directory information changed<br /> |
549 |
<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.20.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.23.</a> |
550 |
Number of database instruments changed<br /> |
Number of database instruments changed<br /> |
551 |
<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.21.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.24.</a> |
552 |
Database instrument information changed<br /> |
Database instrument information changed<br /> |
553 |
<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.22.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.25.</a> |
554 |
Database job status information changed<br /> |
Database job status information changed<br /> |
555 |
<a href="#SUBSCRIBE MISCELLANEOUS">8.23.</a> |
<a href="#SUBSCRIBE MISCELLANEOUS">8.26.</a> |
556 |
Miscellaneous and debugging events<br /> |
Miscellaneous and debugging events<br /> |
557 |
<a href="#anchor14">9.</a> |
<a href="#anchor14">9.</a> |
558 |
Security Considerations<br /> |
Security Considerations<br /> |
584 |
(front-end) and server (LinuxSampler) respectively. Lines in |
(front-end) and server (LinuxSampler) respectively. Lines in |
585 |
examples must be interpreted as every line being CRLF |
examples must be interpreted as every line being CRLF |
586 |
terminated (carriage return character followed by line feed |
terminated (carriage return character followed by line feed |
587 |
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>), |
588 |
example: |
thus the following example: |
589 |
</p> |
</p> |
590 |
<p> |
<p> |
591 |
</p> |
</p> |
3371 |
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> |
3372 |
command, <port> by the MIDI port number, <key> by the name of |
command, <port> by the MIDI port number, <key> by the name of |
3373 |
the parameter to change and <value> by the new value for this |
the parameter to change and <value> by the new value for this |
3374 |
parameter. |
parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes) |
3375 |
|
for specifying no value for parameters allowing a list of values. |
3376 |
</p> |
</p> |
3377 |
<p>Possible Answers: |
<p>Possible Answers: |
3378 |
</p> |
</p> |
3413 |
<p> |
<p> |
3414 |
</p> |
</p> |
3415 |
<blockquote class="text"> |
<blockquote class="text"> |
3416 |
|
<p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'" |
3417 |
|
</p> |
3418 |
|
<p>S: "OK" |
3419 |
|
</p> |
3420 |
|
</blockquote><p> |
3421 |
|
|
3422 |
|
</p> |
3423 |
<p> |
<p> |
3424 |
|
</p> |
3425 |
|
<blockquote class="text"> |
3426 |
|
<p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE" |
3427 |
|
</p> |
3428 |
|
<p>S: "OK" |
3429 |
</p> |
</p> |
3430 |
</blockquote><p> |
</blockquote><p> |
3431 |
|
|
3460 |
number of the sampler channel the instrument should be assigned to. |
number of the sampler channel the instrument should be assigned to. |
3461 |
Each sampler channel can only have one instrument. |
Each sampler channel can only have one instrument. |
3462 |
</p> |
</p> |
3463 |
|
<p>Notice: since LSCP 1.2 the <filename> argument supports |
3464 |
|
escape characters for special characters (see chapter |
3465 |
|
"<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>" |
3466 |
|
for details) and accordingly backslash characters in the filename |
3467 |
|
MUST now be escaped as well! |
3468 |
|
</p> |
3469 |
<p>The difference between regular and NON_MODAL versions of the command |
<p>The difference between regular and NON_MODAL versions of the command |
3470 |
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 |
3471 |
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 |
3513 |
</blockquote><p> |
</blockquote><p> |
3514 |
|
|
3515 |
</p> |
</p> |
3516 |
<p>Example: |
<p>Example (Unix): |
3517 |
</p> |
</p> |
3518 |
<p> |
<p> |
3519 |
</p> |
</p> |
3520 |
<blockquote class="text"> |
<blockquote class="text"> |
3521 |
|
<p>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0 |
3522 |
|
</p> |
3523 |
|
<p>S: OK |
3524 |
|
</p> |
3525 |
|
</blockquote><p> |
3526 |
|
|
3527 |
|
</p> |
3528 |
|
<p>Example (Windows): |
3529 |
|
</p> |
3530 |
<p> |
<p> |
3531 |
|
</p> |
3532 |
|
<blockquote class="text"> |
3533 |
|
<p>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0 |
3534 |
|
</p> |
3535 |
|
<p>S: OK |
3536 |
</p> |
</p> |
3537 |
</blockquote><p> |
</blockquote><p> |
3538 |
|
|
3947 |
</p> |
</p> |
3948 |
<blockquote class="text"> |
<blockquote class="text"> |
3949 |
<p>arbitrary description text about the engine |
<p>arbitrary description text about the engine |
3950 |
|
(note that the character string may contain |
3951 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
3952 |
</p> |
</p> |
3953 |
</blockquote> |
</blockquote> |
3954 |
|
|
4034 |
<blockquote class="text"> |
<blockquote class="text"> |
4035 |
<p>numerical ID of the audio output device which is |
<p>numerical ID of the audio output device which is |
4036 |
currently connected to this sampler channel to output |
currently connected to this sampler channel to output |
4037 |
the audio signal, "NONE" if there's no device |
the audio signal, "-1" if there's no device |
4038 |
connected to this sampler channel |
connected to this sampler channel |
4039 |
</p> |
</p> |
4040 |
</blockquote> |
</blockquote> |
4068 |
<blockquote class="text"> |
<blockquote class="text"> |
4069 |
<p>the file name of the loaded instrument, "NONE" if |
<p>the file name of the loaded instrument, "NONE" if |
4070 |
there's no instrument yet loaded for this sampler |
there's no instrument yet loaded for this sampler |
4071 |
channel |
channel (note: since LSCP 1.2 this path may contain |
4072 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
4073 |
</p> |
</p> |
4074 |
</blockquote> |
</blockquote> |
4075 |
|
|
4077 |
<p>INSTRUMENT_NR - |
<p>INSTRUMENT_NR - |
4078 |
</p> |
</p> |
4079 |
<blockquote class="text"> |
<blockquote class="text"> |
4080 |
<p>the instrument index number of the loaded instrument |
<p>the instrument index number of the loaded instrument, |
4081 |
|
"-1" if there's no instrument loaded for this sampler |
4082 |
|
channel |
4083 |
</p> |
</p> |
4084 |
</blockquote> |
</blockquote> |
4085 |
|
|
4088 |
</p> |
</p> |
4089 |
<blockquote class="text"> |
<blockquote class="text"> |
4090 |
<p>the instrument name of the loaded instrument |
<p>the instrument name of the loaded instrument |
4091 |
|
(note: since LSCP 1.2 this character string may contain |
4092 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
4093 |
</p> |
</p> |
4094 |
</blockquote> |
</blockquote> |
4095 |
|
|
4097 |
<p>INSTRUMENT_STATUS - |
<p>INSTRUMENT_STATUS - |
4098 |
</p> |
</p> |
4099 |
<blockquote class="text"> |
<blockquote class="text"> |
4100 |
<p>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative |
<p>Integer values 0 to 100 indicating loading progress |
4101 |
value indicates a loading exception. Value of 100 indicates that the instrument is fully |
percentage for the instrument. Negative |
4102 |
|
value indicates a loading exception (also returns "-1" in case no |
4103 |
|
instrument was yet to be loaded on the sampler channel). |
4104 |
|
Value of 100 indicates that the instrument is fully |
4105 |
loaded. |
loaded. |
4106 |
</p> |
</p> |
4107 |
</blockquote> |
</blockquote> |
4112 |
<blockquote class="text"> |
<blockquote class="text"> |
4113 |
<p>numerical ID of the MIDI input device which is |
<p>numerical ID of the MIDI input device which is |
4114 |
currently connected to this sampler channel to deliver |
currently connected to this sampler channel to deliver |
4115 |
MIDI input commands, "NONE" if there's no device |
MIDI input commands, "-1" if there's no device |
4116 |
connected to this sampler channel |
connected to this sampler channel |
4117 |
</p> |
</p> |
4118 |
</blockquote> |
</blockquote> |
4121 |
<p>MIDI_INPUT_PORT - |
<p>MIDI_INPUT_PORT - |
4122 |
</p> |
</p> |
4123 |
<blockquote class="text"> |
<blockquote class="text"> |
4124 |
<p>port number of the MIDI input device |
<p>port number of the MIDI input device (in case a |
4125 |
|
MIDI device was already assigned to the sampler |
4126 |
|
channel) |
4127 |
</p> |
</p> |
4128 |
</blockquote> |
</blockquote> |
4129 |
|
|
5170 |
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> |
5171 |
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 |
5172 |
effect send level and <name> is an optional argument defining a name |
effect send level and <name> is an optional argument defining a name |
5173 |
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 |
5174 |
|
encapsulated into apostrophes and supports escape sequences as described in chapter |
5175 |
|
"<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>". |
5176 |
</p> |
</p> |
5177 |
<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 |
5178 |
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 |
5441 |
</p> |
</p> |
5442 |
<blockquote class="text"> |
<blockquote class="text"> |
5443 |
<p>name of the effect send entity |
<p>name of the effect send entity |
5444 |
|
(note that this character string may contain |
5445 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
5446 |
</p> |
</p> |
5447 |
</blockquote> |
</blockquote> |
5448 |
|
|
5477 |
channel 1 is routed to the channel 3 of the audio |
channel 1 is routed to the channel 3 of the audio |
5478 |
output device (see |
output device (see |
5479 |
<a class='info' href='#SET FX_SEND AUDIO_OUTPUT_CHANNEL'>"SET FX_SEND AUDIO_OUTPUT_CHANNEL"<span> (</span><span class='info'>Altering effect send's audio routing</span><span>)</span></a> |
<a class='info' href='#SET FX_SEND AUDIO_OUTPUT_CHANNEL'>"SET FX_SEND AUDIO_OUTPUT_CHANNEL"<span> (</span><span class='info'>Altering effect send's audio routing</span><span>)</span></a> |
5480 |
for details) |
for details), if an internal send |
5481 |
|
effect is assigned to the effect |
5482 |
|
send, then this setting defines the |
5483 |
|
audio channel routing to that |
5484 |
|
effect instance respectively |
5485 |
|
</p> |
5486 |
|
</blockquote> |
5487 |
|
|
5488 |
|
|
5489 |
|
<p>SEND_EFFECT - |
5490 |
|
</p> |
5491 |
|
<blockquote class="text"> |
5492 |
|
<p>destination send effect chain ID |
5493 |
|
and destination effect chain |
5494 |
|
position, separated by comma in the |
5495 |
|
form "<effect-chain>,<chain-pos>" |
5496 |
|
or "NONE" if there is no send effect |
5497 |
|
assigned to the effect send |
5498 |
</p> |
</p> |
5499 |
</blockquote> |
</blockquote> |
5500 |
|
|
5550 |
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> |
5551 |
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 |
5552 |
<name> is the new name of the effect send entity, which |
<name> is the new name of the effect send entity, which |
5553 |
does not have to be unique. |
does not have to be unique (name MUST be encapsulated into apostrophes |
5554 |
|
and supports escape sequences as described in chapter |
5555 |
|
"<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>"). |
5556 |
|
|
5557 |
</p> |
</p> |
5558 |
<p>Possible Answers: |
<p>Possible Answers: |
5559 |
</p> |
</p> |
5616 |
<audio-src> is the numerical ID of the effect send's audio channel |
<audio-src> is the numerical ID of the effect send's audio channel |
5617 |
which should be rerouted and <audio-dst> is the numerical ID of |
which should be rerouted and <audio-dst> is the numerical ID of |
5618 |
the audio channel of the selected audio output device where <audio-src> |
the audio channel of the selected audio output device where <audio-src> |
5619 |
should be routed to. |
should be routed to. If an internal send effect is assigned |
5620 |
|
to the effect send, then this setting defines the audio |
5621 |
|
channel routing to that effect instance respectively. |
5622 |
</p> |
</p> |
5623 |
<p>Note that effect sends can only route audio to the same audio output |
<p>Note that effect sends can only route audio to the same audio output |
5624 |
device as assigned to the effect send's sampler channel. Also note that an |
device as assigned to the effect send's sampler channel. Also note that an |
5676 |
</blockquote><p> |
</blockquote><p> |
5677 |
|
|
5678 |
</p> |
</p> |
5679 |
<a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr /> |
<a name="SET FX_SEND SEND_EFFECT"></a><br /><hr /> |
5680 |
<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> |
5681 |
<a name="rfc.section.6.4.32"></a><h3>6.4.32. |
<a name="rfc.section.6.4.32"></a><h3>6.4.32. |
5682 |
|
Assigning destination effect to an effect send</h3> |
5683 |
|
|
5684 |
|
<p>The front-end can (re-)assign a destination effect to an |
5685 |
|
effect send by sending the following command: |
5686 |
|
</p> |
5687 |
|
<p> |
5688 |
|
</p> |
5689 |
|
<blockquote class="text"> |
5690 |
|
<p>SET FX_SEND SEND_EFFECT <sampler-chan> <fx-send-id> <effect-chain> <chain-pos> |
5691 |
|
</p> |
5692 |
|
</blockquote><p> |
5693 |
|
|
5694 |
|
</p> |
5695 |
|
<p>Where <sampler-chan> is the sampler channel number |
5696 |
|
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> |
5697 |
|
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, |
5698 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
5699 |
|
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> |
5700 |
|
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, |
5701 |
|
<effect-chain> by the numerical ID of the destination |
5702 |
|
effect chain as returned by the |
5703 |
|
<a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a> |
5704 |
|
or |
5705 |
|
<a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a> |
5706 |
|
command and <chain-pos> reflects the exact effect |
5707 |
|
chain position in the effect chain which hosts the actual |
5708 |
|
destination effect. |
5709 |
|
</p> |
5710 |
|
<p>Possible Answers: |
5711 |
|
</p> |
5712 |
|
<p> |
5713 |
|
</p> |
5714 |
|
<blockquote class="text"> |
5715 |
|
<p>"OK" - |
5716 |
|
</p> |
5717 |
|
<blockquote class="text"> |
5718 |
|
<p>on success |
5719 |
|
</p> |
5720 |
|
</blockquote> |
5721 |
|
|
5722 |
|
|
5723 |
|
<p>"ERR:<error-code>:<error-message>" - |
5724 |
|
</p> |
5725 |
|
<blockquote class="text"> |
5726 |
|
<p>in case it failed, providing an appropriate error code and error message |
5727 |
|
</p> |
5728 |
|
</blockquote> |
5729 |
|
|
5730 |
|
|
5731 |
|
</blockquote><p> |
5732 |
|
|
5733 |
|
</p> |
5734 |
|
<p>Example: |
5735 |
|
</p> |
5736 |
|
<p> |
5737 |
|
</p> |
5738 |
|
<blockquote class="text"> |
5739 |
|
<p>C: "SET FX_SEND SEND_EFFECT 0 0 2 5" |
5740 |
|
</p> |
5741 |
|
<p>S: "OK" |
5742 |
|
</p> |
5743 |
|
</blockquote><p> |
5744 |
|
|
5745 |
|
</p> |
5746 |
|
<a name="REMOVE FX_SEND SEND_EFFECT"></a><br /><hr /> |
5747 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5748 |
|
<a name="rfc.section.6.4.33"></a><h3>6.4.33. |
5749 |
|
Removing destination effect from an effect send</h3> |
5750 |
|
|
5751 |
|
<p>The front-end can (re-)assign a destination effect to an |
5752 |
|
effect send by sending the following command: |
5753 |
|
</p> |
5754 |
|
<p> |
5755 |
|
</p> |
5756 |
|
<blockquote class="text"> |
5757 |
|
<p>REMOVE FX_SEND SEND_EFFECT <sampler-chan> <fx-send-id> |
5758 |
|
</p> |
5759 |
|
</blockquote><p> |
5760 |
|
|
5761 |
|
</p> |
5762 |
|
<p>Where <sampler-chan> is the sampler channel number |
5763 |
|
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> |
5764 |
|
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, |
5765 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
5766 |
|
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> |
5767 |
|
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. |
5768 |
|
</p> |
5769 |
|
<p>After the destination effect has been removed from the |
5770 |
|
effect send, the audio signal of the effect send will be |
5771 |
|
routed directly to the audio output device, according to the |
5772 |
|
audio channel routing setting of the effect send. |
5773 |
|
|
5774 |
|
</p> |
5775 |
|
<p>Possible Answers: |
5776 |
|
</p> |
5777 |
|
<p> |
5778 |
|
</p> |
5779 |
|
<blockquote class="text"> |
5780 |
|
<p>"OK" - |
5781 |
|
</p> |
5782 |
|
<blockquote class="text"> |
5783 |
|
<p>on success |
5784 |
|
</p> |
5785 |
|
</blockquote> |
5786 |
|
|
5787 |
|
|
5788 |
|
<p>"ERR:<error-code>:<error-message>" - |
5789 |
|
</p> |
5790 |
|
<blockquote class="text"> |
5791 |
|
<p>in case it failed, providing an appropriate error code and error message |
5792 |
|
</p> |
5793 |
|
</blockquote> |
5794 |
|
|
5795 |
|
|
5796 |
|
</blockquote><p> |
5797 |
|
|
5798 |
|
</p> |
5799 |
|
<p>Example: |
5800 |
|
</p> |
5801 |
|
<p> |
5802 |
|
</p> |
5803 |
|
<blockquote class="text"> |
5804 |
|
<p>C: "REMOVE FX_SEND SEND_EFFECT 0 0" |
5805 |
|
</p> |
5806 |
|
<p>S: "OK" |
5807 |
|
</p> |
5808 |
|
</blockquote><p> |
5809 |
|
|
5810 |
|
</p> |
5811 |
|
<a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr /> |
5812 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5813 |
|
<a name="rfc.section.6.4.34"></a><h3>6.4.34. |
5814 |
Altering effect send's MIDI controller</h3> |
Altering effect send's MIDI controller</h3> |
5815 |
|
|
5816 |
<p>The front-end can alter the MIDI controller of an effect |
<p>The front-end can alter the MIDI controller of an effect |
5881 |
</p> |
</p> |
5882 |
<a name="SET FX_SEND LEVEL"></a><br /><hr /> |
<a name="SET FX_SEND LEVEL"></a><br /><hr /> |
5883 |
<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> |
5884 |
<a name="rfc.section.6.4.33"></a><h3>6.4.33. |
<a name="rfc.section.6.4.35"></a><h3>6.4.35. |
5885 |
Altering effect send's send level</h3> |
Altering effect send's send level</h3> |
5886 |
|
|
5887 |
<p>The front-end can alter the current send level of an effect |
<p>The front-end can alter the current send level of an effect |
5951 |
</blockquote><p> |
</blockquote><p> |
5952 |
|
|
5953 |
</p> |
</p> |
5954 |
|
<a name="SEND CHANNEL MIDI_DATA"></a><br /><hr /> |
5955 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5956 |
|
<a name="rfc.section.6.4.36"></a><h3>6.4.36. |
5957 |
|
Sending MIDI messages to sampler channel</h3> |
5958 |
|
|
5959 |
|
<p>The front-end can send MIDI events to a specific sampler channel |
5960 |
|
by sending the following command: |
5961 |
|
</p> |
5962 |
|
<p> |
5963 |
|
</p> |
5964 |
|
<blockquote class="text"> |
5965 |
|
<p>SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2> |
5966 |
|
</p> |
5967 |
|
</blockquote><p> |
5968 |
|
|
5969 |
|
</p> |
5970 |
|
<p>Where <sampler-chan> is the sampler channel number |
5971 |
|
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> |
5972 |
|
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, |
5973 |
|
<arg1> and <arg2> arguments depend on the <midi-msg> argument, which |
5974 |
|
specifies the MIDI message type. Currently, the following MIDI messages are supported: |
5975 |
|
</p> |
5976 |
|
<p> |
5977 |
|
</p> |
5978 |
|
<blockquote class="text"> |
5979 |
|
<p>"NOTE_ON" - |
5980 |
|
</p> |
5981 |
|
<blockquote class="text"> |
5982 |
|
<p>For turning on MIDI notes, where <arg1> |
5983 |
|
specifies the key number and <arg2> the velocity |
5984 |
|
as described in the MIDI specification. |
5985 |
|
</p> |
5986 |
|
</blockquote> |
5987 |
|
|
5988 |
|
|
5989 |
|
<p>"NOTE_OFF" - |
5990 |
|
</p> |
5991 |
|
<blockquote class="text"> |
5992 |
|
<p>For turning a currently playing MIDI note off, where <arg1> |
5993 |
|
specifies the key number and <arg2> the velocity |
5994 |
|
as described in the MIDI specification. |
5995 |
|
</p> |
5996 |
|
</blockquote> |
5997 |
|
|
5998 |
|
|
5999 |
|
<p>"CC" - |
6000 |
|
</p> |
6001 |
|
<blockquote class="text"> |
6002 |
|
<p>For changing a MIDI controller, where <arg1> |
6003 |
|
specifies the controller number and <arg2> the |
6004 |
|
new value of the controller as described in the Control |
6005 |
|
Change section of the MIDI specification. |
6006 |
|
</p> |
6007 |
|
</blockquote> |
6008 |
|
|
6009 |
|
|
6010 |
|
</blockquote><p> |
6011 |
|
|
6012 |
|
</p> |
6013 |
|
<p>CAUTION: This command is provided for implementations of virtual MIDI keyboards |
6014 |
|
and no realtime guarantee whatsoever will be made! |
6015 |
|
</p> |
6016 |
|
<p>Possible Answers: |
6017 |
|
</p> |
6018 |
|
<p> |
6019 |
|
</p> |
6020 |
|
<blockquote class="text"> |
6021 |
|
<p>"OK" - |
6022 |
|
</p> |
6023 |
|
<blockquote class="text"> |
6024 |
|
<p>on success |
6025 |
|
</p> |
6026 |
|
</blockquote> |
6027 |
|
|
6028 |
|
|
6029 |
|
<p>"ERR:<error-code>:<error-message>" - |
6030 |
|
</p> |
6031 |
|
<blockquote class="text"> |
6032 |
|
<p>in case it failed, providing an appropriate error code and error message |
6033 |
|
</p> |
6034 |
|
</blockquote> |
6035 |
|
|
6036 |
|
|
6037 |
|
</blockquote><p> |
6038 |
|
|
6039 |
|
</p> |
6040 |
|
<p>Example: |
6041 |
|
</p> |
6042 |
|
<p> |
6043 |
|
</p> |
6044 |
|
<blockquote class="text"> |
6045 |
|
<p>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112" |
6046 |
|
</p> |
6047 |
|
<p>S: "OK" |
6048 |
|
</p> |
6049 |
|
</blockquote><p> |
6050 |
|
|
6051 |
|
</p> |
6052 |
<a name="RESET CHANNEL"></a><br /><hr /> |
<a name="RESET CHANNEL"></a><br /><hr /> |
6053 |
<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> |
6054 |
<a name="rfc.section.6.4.34"></a><h3>6.4.34. |
<a name="rfc.section.6.4.37"></a><h3>6.4.37. |
6055 |
Resetting a sampler channel</h3> |
Resetting a sampler channel</h3> |
6056 |
|
|
6057 |
<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: |
6386 |
</blockquote><p> |
</blockquote><p> |
6387 |
|
|
6388 |
</p> |
</p> |
6389 |
<a name="RESET"></a><br /><hr /> |
<a name="GET TOTAL_STREAM_COUNT"></a><br /><hr /> |
6390 |
<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> |
6391 |
<a name="rfc.section.6.6.3"></a><h3>6.6.3. |
<a name="rfc.section.6.6.3"></a><h3>6.6.3. |
6392 |
|
Current number of active disk streams</h3> |
6393 |
|
|
6394 |
|
<p>The front-end can ask for the current number of active disk streams on |
6395 |
|
the sampler by sending the following command: |
6396 |
|
</p> |
6397 |
|
<p> |
6398 |
|
</p> |
6399 |
|
<blockquote class="text"> |
6400 |
|
<p>GET TOTAL_STREAM_COUNT |
6401 |
|
</p> |
6402 |
|
</blockquote><p> |
6403 |
|
|
6404 |
|
</p> |
6405 |
|
<p>Possible Answers: |
6406 |
|
</p> |
6407 |
|
<p> |
6408 |
|
</p> |
6409 |
|
<blockquote class="text"> |
6410 |
|
<p>LinuxSampler will answer by returning the number of all active |
6411 |
|
disk streams on the sampler. |
6412 |
|
</p> |
6413 |
|
</blockquote><p> |
6414 |
|
|
6415 |
|
</p> |
6416 |
|
<a name="RESET"></a><br /><hr /> |
6417 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6418 |
|
<a name="rfc.section.6.6.4"></a><h3>6.6.4. |
6419 |
Reset sampler</h3> |
Reset sampler</h3> |
6420 |
|
|
6421 |
<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: |
6456 |
</p> |
</p> |
6457 |
<a name="GET SERVER INFO"></a><br /><hr /> |
<a name="GET SERVER INFO"></a><br /><hr /> |
6458 |
<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> |
6459 |
<a name="rfc.section.6.6.4"></a><h3>6.6.4. |
<a name="rfc.section.6.6.5"></a><h3>6.6.5. |
6460 |
General sampler informations</h3> |
General sampler informations</h3> |
6461 |
|
|
6462 |
<p>The client can ask for general informations about the LinuxSampler |
<p>The client can ask for general informations about the LinuxSampler |
6489 |
</p> |
</p> |
6490 |
<blockquote class="text"> |
<blockquote class="text"> |
6491 |
<p>arbitrary textual description about the sampler |
<p>arbitrary textual description about the sampler |
6492 |
|
(note that the character string may contain |
6493 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
6494 |
</p> |
</p> |
6495 |
</blockquote> |
</blockquote> |
6496 |
|
|
6532 |
</p> |
</p> |
6533 |
<a name="GET VOLUME"></a><br /><hr /> |
<a name="GET VOLUME"></a><br /><hr /> |
6534 |
<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> |
6535 |
<a name="rfc.section.6.6.5"></a><h3>6.6.5. |
<a name="rfc.section.6.6.6"></a><h3>6.6.6. |
6536 |
Getting global volume attenuation</h3> |
Getting global volume attenuation</h3> |
6537 |
|
|
6538 |
<p>The client can ask for the current global sampler-wide volume |
<p>The client can ask for the current global sampler-wide volume |
6565 |
</p> |
</p> |
6566 |
<a name="SET VOLUME"></a><br /><hr /> |
<a name="SET VOLUME"></a><br /><hr /> |
6567 |
<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> |
6568 |
<a name="rfc.section.6.6.6"></a><h3>6.6.6. |
<a name="rfc.section.6.6.7"></a><h3>6.6.7. |
6569 |
Setting global volume attenuation</h3> |
Setting global volume attenuation</h3> |
6570 |
|
|
6571 |
<p>The client can alter the current global sampler-wide volume |
<p>The client can alter the current global sampler-wide volume |
6618 |
</blockquote><p> |
</blockquote><p> |
6619 |
|
|
6620 |
</p> |
</p> |
6621 |
|
<a name="GET VOICES"></a><br /><hr /> |
6622 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6623 |
|
<a name="rfc.section.6.6.8"></a><h3>6.6.8. |
6624 |
|
Getting global voice limit</h3> |
6625 |
|
|
6626 |
|
<p>The client can ask for the current global sampler-wide limit |
6627 |
|
for maximum voices by sending the following command: |
6628 |
|
</p> |
6629 |
|
<p> |
6630 |
|
</p> |
6631 |
|
<blockquote class="text"> |
6632 |
|
<p>GET VOICES |
6633 |
|
</p> |
6634 |
|
</blockquote><p> |
6635 |
|
|
6636 |
|
</p> |
6637 |
|
<p>Possible Answers: |
6638 |
|
</p> |
6639 |
|
<p> |
6640 |
|
</p> |
6641 |
|
<blockquote class="text"> |
6642 |
|
<p>LinuxSampler will answer by returning the number for |
6643 |
|
the current limit of maximum voices. |
6644 |
|
</p> |
6645 |
|
</blockquote><p> |
6646 |
|
|
6647 |
|
</p> |
6648 |
|
<p>The voice limit setting defines how many voices should maximum |
6649 |
|
be processed by the sampler at the same time. If the user |
6650 |
|
triggers new notes which would exceed that voice limit, the |
6651 |
|
sampler engine will react by stealing old voices for those |
6652 |
|
newly triggered notes. Note that the amount of voices triggered |
6653 |
|
by a new note can be larger than one and is dependent to the |
6654 |
|
respective instrument and probably further criterias. |
6655 |
|
</p> |
6656 |
|
<a name="SET VOICES"></a><br /><hr /> |
6657 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6658 |
|
<a name="rfc.section.6.6.9"></a><h3>6.6.9. |
6659 |
|
Setting global voice limit</h3> |
6660 |
|
|
6661 |
|
<p>The client can alter the current global sampler-wide limit |
6662 |
|
for maximum voices by sending the following command: |
6663 |
|
</p> |
6664 |
|
<p> |
6665 |
|
</p> |
6666 |
|
<blockquote class="text"> |
6667 |
|
<p>SET VOICES <max-voices> |
6668 |
|
</p> |
6669 |
|
</blockquote><p> |
6670 |
|
|
6671 |
|
</p> |
6672 |
|
<p>Where <max-voices> should be replaced by the integer |
6673 |
|
value, reflecting the new global amount limit of maximum voices. |
6674 |
|
This value has to be larger than 0. |
6675 |
|
</p> |
6676 |
|
<p>Possible Answers: |
6677 |
|
</p> |
6678 |
|
<p> |
6679 |
|
</p> |
6680 |
|
<blockquote class="text"> |
6681 |
|
<p>"OK" - |
6682 |
|
</p> |
6683 |
|
<blockquote class="text"> |
6684 |
|
<p>on success |
6685 |
|
</p> |
6686 |
|
</blockquote> |
6687 |
|
|
6688 |
|
|
6689 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
6690 |
|
</p> |
6691 |
|
<blockquote class="text"> |
6692 |
|
<p>if the voice limit was set, but there are noteworthy |
6693 |
|
issue(s) related, providing an appropriate warning code and |
6694 |
|
warning message |
6695 |
|
</p> |
6696 |
|
</blockquote> |
6697 |
|
|
6698 |
|
|
6699 |
|
<p>"ERR:<error-code>:<error-message>" - |
6700 |
|
</p> |
6701 |
|
<blockquote class="text"> |
6702 |
|
<p>in case it failed, providing an appropriate error code and error message |
6703 |
|
</p> |
6704 |
|
</blockquote> |
6705 |
|
|
6706 |
|
|
6707 |
|
</blockquote><p> |
6708 |
|
|
6709 |
|
</p> |
6710 |
|
<p>Note: the given value will be passed to all sampler engine instances. |
6711 |
|
The total amount of maximum voices on the running system might thus |
6712 |
|
be as big as the given value multiplied by the current amount of engine |
6713 |
|
instances. |
6714 |
|
</p> |
6715 |
|
<p>Caution: when adjusting the voice limit, you SHOULD also |
6716 |
|
adjust the disk stream limit respectively and vice versa. |
6717 |
|
</p> |
6718 |
|
<a name="GET STREAMS"></a><br /><hr /> |
6719 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6720 |
|
<a name="rfc.section.6.6.10"></a><h3>6.6.10. |
6721 |
|
Getting global disk stream limit</h3> |
6722 |
|
|
6723 |
|
<p>The client can ask for the current global sampler-wide limit |
6724 |
|
for maximum disk streams by sending the following command: |
6725 |
|
</p> |
6726 |
|
<p> |
6727 |
|
</p> |
6728 |
|
<blockquote class="text"> |
6729 |
|
<p>GET STREAMS |
6730 |
|
</p> |
6731 |
|
</blockquote><p> |
6732 |
|
|
6733 |
|
</p> |
6734 |
|
<p>Possible Answers: |
6735 |
|
</p> |
6736 |
|
<p> |
6737 |
|
</p> |
6738 |
|
<blockquote class="text"> |
6739 |
|
<p>LinuxSampler will answer by returning the number for |
6740 |
|
the current limit of maximum disk streams. |
6741 |
|
</p> |
6742 |
|
</blockquote><p> |
6743 |
|
|
6744 |
|
</p> |
6745 |
|
<p>The disk stream limit setting defines how many disk streams should |
6746 |
|
maximum be processed by a sampler engine at the same time. The |
6747 |
|
higher this value, the more memory (RAM) will be occupied, since |
6748 |
|
every disk streams allocates a certain buffer size for being able |
6749 |
|
to perform its streaming operations. |
6750 |
|
</p> |
6751 |
|
<a name="SET STREAMS"></a><br /><hr /> |
6752 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6753 |
|
<a name="rfc.section.6.6.11"></a><h3>6.6.11. |
6754 |
|
Setting global disk stream limit</h3> |
6755 |
|
|
6756 |
|
<p>The client can alter the current global sampler-wide limit |
6757 |
|
for maximum disk streams by sending the following command: |
6758 |
|
</p> |
6759 |
|
<p> |
6760 |
|
</p> |
6761 |
|
<blockquote class="text"> |
6762 |
|
<p>SET STREAMS <max-streams> |
6763 |
|
</p> |
6764 |
|
</blockquote><p> |
6765 |
|
|
6766 |
|
</p> |
6767 |
|
<p>Where <max-streams> should be replaced by the integer |
6768 |
|
value, reflecting the new global amount limit of maximum disk streams. |
6769 |
|
This value has to be positive. |
6770 |
|
</p> |
6771 |
|
<p>Possible Answers: |
6772 |
|
</p> |
6773 |
|
<p> |
6774 |
|
</p> |
6775 |
|
<blockquote class="text"> |
6776 |
|
<p>"OK" - |
6777 |
|
</p> |
6778 |
|
<blockquote class="text"> |
6779 |
|
<p>on success |
6780 |
|
</p> |
6781 |
|
</blockquote> |
6782 |
|
|
6783 |
|
|
6784 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
6785 |
|
</p> |
6786 |
|
<blockquote class="text"> |
6787 |
|
<p>if the disk stream limit was set, but there are noteworthy |
6788 |
|
issue(s) related, providing an appropriate warning code and |
6789 |
|
warning message |
6790 |
|
</p> |
6791 |
|
</blockquote> |
6792 |
|
|
6793 |
|
|
6794 |
|
<p>"ERR:<error-code>:<error-message>" - |
6795 |
|
</p> |
6796 |
|
<blockquote class="text"> |
6797 |
|
<p>in case it failed, providing an appropriate error code and error message |
6798 |
|
</p> |
6799 |
|
</blockquote> |
6800 |
|
|
6801 |
|
|
6802 |
|
</blockquote><p> |
6803 |
|
|
6804 |
|
</p> |
6805 |
|
<p>Note: the given value will be passed to all sampler engine instances. |
6806 |
|
The total amount of maximum disk streams on the running system might |
6807 |
|
thus be as big as the given value multiplied by the current amount of |
6808 |
|
engine instances. |
6809 |
|
</p> |
6810 |
|
<p>Caution: when adjusting the disk stream limit, you SHOULD also |
6811 |
|
adjust the voice limit respectively and vice versa. |
6812 |
|
</p> |
6813 |
<a name="MIDI Instrument Mapping"></a><br /><hr /> |
<a name="MIDI Instrument Mapping"></a><br /><hr /> |
6814 |
<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> |
6815 |
<a name="rfc.section.6.7"></a><h3>6.7. |
<a name="rfc.section.6.7"></a><h3>6.7. |
6844 |
cause the sampler to switch to the respective instrument as |
cause the sampler to switch to the respective instrument as |
6845 |
reflected by the current MIDI instrument map. |
reflected by the current MIDI instrument map. |
6846 |
</p> |
</p> |
6847 |
<a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr /> |
<a name="ADD MIDI_INSTRUMENT_MAP"></a><br /><hr /> |
6848 |
<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> |
6849 |
<a name="rfc.section.6.7.1"></a><h3>6.7.1. |
<a name="rfc.section.6.7.1"></a><h3>6.7.1. |
6850 |
Create a new MIDI instrument map</h3> |
Create a new MIDI instrument map</h3> |
6862 |
</p> |
</p> |
6863 |
<p>Where <name> is an optional argument allowing to |
<p>Where <name> is an optional argument allowing to |
6864 |
assign a custom name to the new map. MIDI instrument Map |
assign a custom name to the new map. MIDI instrument Map |
6865 |
names do not have to be unique. |
names do not have to be unique, but MUST be encapsulated |
6866 |
|
into apostrophes and support escape sequences as described |
6867 |
|
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>". |
6868 |
|
|
6869 |
</p> |
</p> |
6870 |
<p>Possible Answers: |
<p>Possible Answers: |
6871 |
</p> |
</p> |
7123 |
<blockquote class="text"> |
<blockquote class="text"> |
7124 |
<p>custom name of the given map, |
<p>custom name of the given map, |
7125 |
which does not have to be unique |
which does not have to be unique |
7126 |
|
(note that this character string may contain |
7127 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
7128 |
</p> |
</p> |
7129 |
</blockquote> |
</blockquote> |
7130 |
|
|
7180 |
</p> |
</p> |
7181 |
<p>Where <map> is the numerical ID of the map and |
<p>Where <map> is the numerical ID of the map and |
7182 |
<name> the new custom name of the map, which does not |
<name> the new custom name of the map, which does not |
7183 |
have to be unique. |
have to be unique (name MUST be encapsulated into apostrophes |
7184 |
|
and supports escape sequences as described in chapter |
7185 |
|
"<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>"). |
7186 |
|
|
7187 |
</p> |
</p> |
7188 |
<p>Possible Answers: |
<p>Possible Answers: |
7189 |
</p> |
</p> |
7249 |
index, <engine_name> a sampler engine name as returned by |
index, <engine_name> a sampler engine name as returned by |
7250 |
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> |
7251 |
command (not encapsulated into apostrophes), <filename> the name |
command (not encapsulated into apostrophes), <filename> the name |
7252 |
of the instrument's file to be deployed (encapsulated into apostrophes), |
of the instrument's file to be deployed (encapsulated into apostrophes, |
7253 |
|
supporting escape sequences as described in chapter |
7254 |
|
"<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>"), |
7255 |
<instrument_index> the index (integer value) of the instrument |
<instrument_index> the index (integer value) of the instrument |
7256 |
within the given file, <volume_value> reflects the master |
within the given file, <volume_value> reflects the master |
7257 |
volume of the instrument as optionally dotted number (where a |
volume of the instrument as optionally dotted number (where a |
7348 |
load modes of entries, the frontend should retrieve the actual |
load modes of entries, the frontend should retrieve the actual |
7349 |
mode by i.e. sending |
mode by i.e. sending |
7350 |
<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> |
7351 |
command(s). Finally the OPTIONAL <name> argument allows to |
command(s). Finally the OPTIONAL <name> argument allows to set a custom name |
7352 |
set a custom name (encapsulated into apostrophes) for the mapping |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
7353 |
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 |
7354 |
|
mapping entry, useful for frontends for displaying an appropriate name for |
7355 |
mapped instruments (using |
mapped instruments (using |
7356 |
<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>). |
7357 |
|
|
7673 |
changed with the |
changed with the |
7674 |
<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> |
7675 |
command and does not have to be unique. |
command and does not have to be unique. |
7676 |
|
(note that this character string may contain |
7677 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
7678 |
</p> |
</p> |
7679 |
</blockquote> |
</blockquote> |
7680 |
|
|
7691 |
<p>"INSTRUMENT_FILE" - |
<p>"INSTRUMENT_FILE" - |
7692 |
</p> |
</p> |
7693 |
<blockquote class="text"> |
<blockquote class="text"> |
7694 |
<p>File name of the instrument. |
<p>File name of the instrument |
7695 |
|
(note that this path may contain |
7696 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>). |
7697 |
</p> |
</p> |
7698 |
</blockquote> |
</blockquote> |
7699 |
|
|
7711 |
<blockquote class="text"> |
<blockquote class="text"> |
7712 |
<p>Name of the loaded instrument as reflected by its file. |
<p>Name of the loaded instrument as reflected by its file. |
7713 |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
7714 |
cannot be changed. |
cannot be changed (note that this character string may contain |
7715 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>). |
7716 |
</p> |
</p> |
7717 |
</blockquote> |
</blockquote> |
7718 |
|
|
7847 |
<p>The following commands describe how to use and manage |
<p>The following commands describe how to use and manage |
7848 |
the instruments database. |
the instruments database. |
7849 |
</p> |
</p> |
7850 |
|
<p>Notice: |
7851 |
|
</p> |
7852 |
|
<p> |
7853 |
|
</p> |
7854 |
|
<blockquote class="text"> |
7855 |
|
<p>All command arguments representing a path or |
7856 |
|
instrument/directory name support escape sequences as described in chapter |
7857 |
|
"<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>". |
7858 |
|
|
7859 |
|
</p> |
7860 |
|
<p>All occurrences of a forward slash in instrument and directory |
7861 |
|
names are escaped with its hex (\x2f) or octal (\057) escape sequence. |
7862 |
|
|
7863 |
|
</p> |
7864 |
|
</blockquote><p> |
7865 |
|
|
7866 |
|
</p> |
7867 |
<a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr /> |
<a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr /> |
7868 |
<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> |
7869 |
<a name="rfc.section.6.8.1"></a><h3>6.8.1. |
<a name="rfc.section.6.8.1"></a><h3>6.8.1. |
8129 |
<p>DESCRIPTION - |
<p>DESCRIPTION - |
8130 |
</p> |
</p> |
8131 |
<blockquote class="text"> |
<blockquote class="text"> |
8132 |
<p>A brief description of the directory content |
<p>A brief description of the directory content. |
8133 |
|
Note that the character string may contain |
8134 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
8135 |
</p> |
</p> |
8136 |
</blockquote> |
</blockquote> |
8137 |
|
|
8376 |
|
|
8377 |
</p> |
</p> |
8378 |
<p>Where <dir> is the absolute path name of the directory and |
<p>Where <dir> is the absolute path name of the directory and |
8379 |
<desc> is the new description for the directory. |
<desc> is the new description for the directory |
8380 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
8381 |
|
"<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>"). |
8382 |
</p> |
</p> |
8383 |
<p>Possible Answers: |
<p>Possible Answers: |
8384 |
</p> |
</p> |
8445 |
</p> |
</p> |
8446 |
<blockquote class="text"> |
<blockquote class="text"> |
8447 |
<p>Restricts the search to directories, which names |
<p>Restricts the search to directories, which names |
8448 |
satisfy the supplied search string. |
satisfy the supplied search string (encapsulated into apostrophes, |
8449 |
|
supporting escape sequences as described in chapter |
8450 |
|
"<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>"). |
8451 |
</p> |
</p> |
8452 |
</blockquote><p> |
</blockquote><p> |
8453 |
|
|
8490 |
</p> |
</p> |
8491 |
<blockquote class="text"> |
<blockquote class="text"> |
8492 |
<p>Restricts the search to directories with description |
<p>Restricts the search to directories with description |
8493 |
that satisfies the supplied search string. |
that satisfies the supplied search string |
8494 |
|
(encapsulated into apostrophes, supporting escape |
8495 |
|
sequences as described in chapter |
8496 |
|
"<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>"). |
8497 |
</p> |
</p> |
8498 |
</blockquote><p> |
</blockquote><p> |
8499 |
|
|
8556 |
<p> |
<p> |
8557 |
</p> |
</p> |
8558 |
<blockquote class="text"> |
<blockquote class="text"> |
8559 |
<p>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path> [<instr_index>] |
<p>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>[ FILE_AS_DIR]] <db_dir> <file_path> [<instr_index>] |
8560 |
</p> |
</p> |
8561 |
</blockquote><p> |
</blockquote><p> |
8562 |
|
|
8614 |
</blockquote><p> |
</blockquote><p> |
8615 |
|
|
8616 |
</p> |
</p> |
8617 |
|
<p> If FILE_AS_DIR argument is supplied, all instruments in an instrument |
8618 |
|
file will be added to a separate directory in the instruments database, which |
8619 |
|
name will be the name of the instrument file with the file extension stripped off. |
8620 |
|
|
8621 |
|
</p> |
8622 |
<p>The difference between regular and NON_MODAL versions of the command |
<p>The difference between regular and NON_MODAL versions of the command |
8623 |
is that the regular command returns when the scanning is finished |
is that the regular command returns when the scanning is finished |
8624 |
while NON_MODAL version returns immediately and a background process is launched. |
while NON_MODAL version returns immediately and a background process is launched. |
8879 |
</p> |
</p> |
8880 |
<blockquote class="text"> |
<blockquote class="text"> |
8881 |
<p>File name of the instrument. |
<p>File name of the instrument. |
8882 |
|
Note that the character string may contain |
8883 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
8884 |
</p> |
</p> |
8885 |
</blockquote> |
</blockquote> |
8886 |
|
|
8940 |
<p>DESCRIPTION - |
<p>DESCRIPTION - |
8941 |
</p> |
</p> |
8942 |
<blockquote class="text"> |
<blockquote class="text"> |
8943 |
<p>A brief description of the instrument |
<p>A brief description of the instrument. |
8944 |
|
Note that the character string may contain |
8945 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
8946 |
</p> |
</p> |
8947 |
</blockquote> |
</blockquote> |
8948 |
|
|
8959 |
<p>PRODUCT - |
<p>PRODUCT - |
8960 |
</p> |
</p> |
8961 |
<blockquote class="text"> |
<blockquote class="text"> |
8962 |
<p>The product title of the instrument |
<p>The product title of the instrument. |
8963 |
|
Note that the character string may contain |
8964 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
8965 |
</p> |
</p> |
8966 |
</blockquote> |
</blockquote> |
8967 |
|
|
8969 |
<p>ARTISTS - |
<p>ARTISTS - |
8970 |
</p> |
</p> |
8971 |
<blockquote class="text"> |
<blockquote class="text"> |
8972 |
<p>Lists the artist names |
<p>Lists the artist names. |
8973 |
|
Note that the character string may contain |
8974 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
8975 |
</p> |
</p> |
8976 |
</blockquote> |
</blockquote> |
8977 |
|
|
8981 |
<blockquote class="text"> |
<blockquote class="text"> |
8982 |
<p>Provides a list of keywords that refer to the instrument. |
<p>Provides a list of keywords that refer to the instrument. |
8983 |
Keywords are separated with semicolon and blank. |
Keywords are separated with semicolon and blank. |
8984 |
|
Note that the character string may contain |
8985 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
8986 |
</p> |
</p> |
8987 |
</blockquote> |
</blockquote> |
8988 |
|
|
9223 |
|
|
9224 |
</p> |
</p> |
9225 |
<p>Where <instr> is the absolute path name of the instrument and |
<p>Where <instr> is the absolute path name of the instrument and |
9226 |
<desc> is the new description for the instrument. |
<desc> is the new description for the instrument |
9227 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
9228 |
|
"<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>"). |
9229 |
</p> |
</p> |
9230 |
<p>Possible Answers: |
<p>Possible Answers: |
9231 |
</p> |
</p> |
9292 |
</p> |
</p> |
9293 |
<blockquote class="text"> |
<blockquote class="text"> |
9294 |
<p>Restricts the search to instruments, which names |
<p>Restricts the search to instruments, which names |
9295 |
satisfy the supplied search string. |
satisfy the supplied search string (encapsulated into apostrophes, |
9296 |
|
supporting escape sequences as described in chapter |
9297 |
|
"<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>"). |
9298 |
</p> |
</p> |
9299 |
</blockquote><p> |
</blockquote><p> |
9300 |
|
|
9304 |
<p>SIZE=[<min>]..[<max>] |
<p>SIZE=[<min>]..[<max>] |
9305 |
</p> |
</p> |
9306 |
<blockquote class="text"> |
<blockquote class="text"> |
9307 |
<p>Restricts the search to instruments, which |
<p>Restricts the search to instruments, which |
9308 |
size is in the specified range. If <min> is omitted, |
size is in the specified range. If <min> is omitted, |
9309 |
the search results are restricted to instruments with size less then |
the search results are restricted to instruments with size less then |
9310 |
or equal to <max>. If <max> is omitted, the |
or equal to <max>. If <max> is omitted, the |
9352 |
</p> |
</p> |
9353 |
<blockquote class="text"> |
<blockquote class="text"> |
9354 |
<p>Restricts the search to instruments with description |
<p>Restricts the search to instruments with description |
9355 |
that satisfies the supplied search string. |
that satisfies the supplied search string (encapsulated into apostrophes, |
9356 |
|
supporting escape sequences as described in chapter |
9357 |
|
"<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>"). |
9358 |
</p> |
</p> |
9359 |
</blockquote><p> |
</blockquote><p> |
9360 |
|
|
9365 |
</p> |
</p> |
9366 |
<blockquote class="text"> |
<blockquote class="text"> |
9367 |
<p>Restricts the search to instruments with product info |
<p>Restricts the search to instruments with product info |
9368 |
that satisfies the supplied search string. |
that satisfies the supplied search string (encapsulated into apostrophes, |
9369 |
|
supporting escape sequences as described in chapter |
9370 |
|
"<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>"). |
9371 |
</p> |
</p> |
9372 |
</blockquote><p> |
</blockquote><p> |
9373 |
|
|
9378 |
</p> |
</p> |
9379 |
<blockquote class="text"> |
<blockquote class="text"> |
9380 |
<p>Restricts the search to instruments with artists info |
<p>Restricts the search to instruments with artists info |
9381 |
that satisfies the supplied search string. |
that satisfies the supplied search string (encapsulated into apostrophes, |
9382 |
|
supporting escape sequences as described in chapter |
9383 |
|
"<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>"). |
9384 |
</p> |
</p> |
9385 |
</blockquote><p> |
</blockquote><p> |
9386 |
|
|
9391 |
</p> |
</p> |
9392 |
<blockquote class="text"> |
<blockquote class="text"> |
9393 |
<p>Restricts the search to instruments with keyword list |
<p>Restricts the search to instruments with keyword list |
9394 |
that satisfies the supplied search string. |
that satisfies the supplied search string (encapsulated into apostrophes, |
9395 |
|
supporting escape sequences as described in chapter |
9396 |
|
"<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>"). |
9397 |
</p> |
</p> |
9398 |
</blockquote><p> |
</blockquote><p> |
9399 |
|
|
9403 |
<p>IS_DRUM=true | false |
<p>IS_DRUM=true | false |
9404 |
</p> |
</p> |
9405 |
<blockquote class="text"> |
<blockquote class="text"> |
9406 |
<p>Either true or false. Restricts the search to |
<p>Either true or false. Restricts the search to |
9407 |
drum kits or chromatic instruments. |
drum kits or chromatic instruments. |
9408 |
</p> |
</p> |
9409 |
</blockquote><p> |
</blockquote><p> |
9563 |
</blockquote><p> |
</blockquote><p> |
9564 |
|
|
9565 |
</p> |
</p> |
9566 |
|
<a name="FORMAT INSTRUMENTS_DB"></a><br /><hr /> |
9567 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9568 |
|
<a name="rfc.section.6.8.22"></a><h3>6.8.22. |
9569 |
|
Formatting the instruments database</h3> |
9570 |
|
|
9571 |
|
<p>The front-end can remove all instruments and directories and re-create |
9572 |
|
the instruments database structure (e.g., in case of a database corruption) |
9573 |
|
by sending the following command: |
9574 |
|
</p> |
9575 |
|
<p> |
9576 |
|
</p> |
9577 |
|
<blockquote class="text"> |
9578 |
|
<p>FORMAT INSTRUMENTS_DB |
9579 |
|
</p> |
9580 |
|
</blockquote><p> |
9581 |
|
|
9582 |
|
</p> |
9583 |
|
<p>Possible Answers: |
9584 |
|
</p> |
9585 |
|
<p> |
9586 |
|
</p> |
9587 |
|
<blockquote class="text"> |
9588 |
|
<p>"OK" - |
9589 |
|
</p> |
9590 |
|
<blockquote class="text"> |
9591 |
|
<p>on success |
9592 |
|
</p> |
9593 |
|
</blockquote> |
9594 |
|
|
9595 |
|
|
9596 |
|
<p>"ERR:<error-code>:<error-message>" - |
9597 |
|
</p> |
9598 |
|
<blockquote class="text"> |
9599 |
|
<p>If the formatting of the instruments database |
9600 |
|
failed. |
9601 |
|
</p> |
9602 |
|
</blockquote> |
9603 |
|
|
9604 |
|
|
9605 |
|
</blockquote><p> |
9606 |
|
|
9607 |
|
</p> |
9608 |
|
<a name="FIND LOST DB_INSTRUMENT_FILES"></a><br /><hr /> |
9609 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9610 |
|
<a name="rfc.section.6.8.23"></a><h3>6.8.23. |
9611 |
|
Checking for lost instrument files</h3> |
9612 |
|
|
9613 |
|
<p>The front-end can retrieve the list of all instrument files in the instruments database |
9614 |
|
that don't exist in the filesystem by sending the following command: |
9615 |
|
</p> |
9616 |
|
<p> |
9617 |
|
</p> |
9618 |
|
<blockquote class="text"> |
9619 |
|
<p>FIND LOST DB_INSTRUMENT_FILES |
9620 |
|
</p> |
9621 |
|
</blockquote><p> |
9622 |
|
|
9623 |
|
</p> |
9624 |
|
<p>Possible Answers: |
9625 |
|
</p> |
9626 |
|
<p> |
9627 |
|
</p> |
9628 |
|
<blockquote class="text"> |
9629 |
|
<p>A comma separated list with the absolute path names |
9630 |
|
(encapsulated into apostrophes) of all lost instrument files. |
9631 |
|
</p> |
9632 |
|
<p>"ERR:<error-code>:<error-message>" - |
9633 |
|
</p> |
9634 |
|
<blockquote class="text"> |
9635 |
|
<p>in case it failed, providing an appropriate error code and error message. |
9636 |
|
</p> |
9637 |
|
</blockquote> |
9638 |
|
|
9639 |
|
|
9640 |
|
</blockquote><p> |
9641 |
|
|
9642 |
|
</p> |
9643 |
|
<p>Example: |
9644 |
|
</p> |
9645 |
|
<p> |
9646 |
|
</p> |
9647 |
|
<blockquote class="text"> |
9648 |
|
<p>C: "FIND LOST DB_INSTRUMENT_FILES" |
9649 |
|
</p> |
9650 |
|
<p>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'" |
9651 |
|
</p> |
9652 |
|
</blockquote><p> |
9653 |
|
|
9654 |
|
</p> |
9655 |
|
<a name="SET DB_INSTRUMENT FILE_PATH"></a><br /><hr /> |
9656 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9657 |
|
<a name="rfc.section.6.8.24"></a><h3>6.8.24. |
9658 |
|
Replacing an instrument file</h3> |
9659 |
|
|
9660 |
|
<p>The front-end can substitute all occurrences of an instrument file |
9661 |
|
in the instruments database with a new one by sending the following command: |
9662 |
|
</p> |
9663 |
|
<p> |
9664 |
|
</p> |
9665 |
|
<blockquote class="text"> |
9666 |
|
<p>SET DB_INSTRUMENT FILE_PATH <old_path> <new_path> |
9667 |
|
</p> |
9668 |
|
</blockquote><p> |
9669 |
|
|
9670 |
|
</p> |
9671 |
|
<p>Where <old_path> is the absolute path name of the instrument file |
9672 |
|
to substitute with <new_path>. |
9673 |
|
</p> |
9674 |
|
<p>Possible Answers: |
9675 |
|
</p> |
9676 |
|
<p> |
9677 |
|
</p> |
9678 |
|
<blockquote class="text"> |
9679 |
|
<p>"OK" - |
9680 |
|
</p> |
9681 |
|
<blockquote class="text"> |
9682 |
|
<p>on success |
9683 |
|
</p> |
9684 |
|
</blockquote> |
9685 |
|
|
9686 |
|
|
9687 |
|
<p>"ERR:<error-code>:<error-message>" - |
9688 |
|
</p> |
9689 |
|
<blockquote class="text"> |
9690 |
|
<p>in case it failed, providing an appropriate error code and error message. |
9691 |
|
</p> |
9692 |
|
</blockquote> |
9693 |
|
|
9694 |
|
|
9695 |
|
</blockquote><p> |
9696 |
|
|
9697 |
|
</p> |
9698 |
|
<p>Example: |
9699 |
|
</p> |
9700 |
|
<p> |
9701 |
|
</p> |
9702 |
|
<blockquote class="text"> |
9703 |
|
<p>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'" |
9704 |
|
</p> |
9705 |
|
<p>S: "OK" |
9706 |
|
</p> |
9707 |
|
</blockquote><p> |
9708 |
|
|
9709 |
|
</p> |
9710 |
|
<a name="editing_instruments"></a><br /><hr /> |
9711 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9712 |
|
<a name="rfc.section.6.9"></a><h3>6.9. |
9713 |
|
Editing Instruments</h3> |
9714 |
|
|
9715 |
|
<p>The sampler allows to edit instruments while playing with the |
9716 |
|
sampler by spawning an external (3rd party) instrument editor |
9717 |
|
application for a given instrument. The 3rd party instrument |
9718 |
|
editor applications have to place a respective plugin DLL file |
9719 |
|
into the sampler's plugins directory. The sampler will |
9720 |
|
automatically try to load all plugin DLLs in that directory on |
9721 |
|
startup and only on startup! |
9722 |
|
</p> |
9723 |
|
<p>At the moment there is only one command for this feature set, |
9724 |
|
but this will most probably change in future. |
9725 |
|
</p> |
9726 |
|
<a name="EDIT INSTRUMENT"></a><br /><hr /> |
9727 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9728 |
|
<a name="rfc.section.6.9.1"></a><h3>6.9.1. |
9729 |
|
Opening an appropriate instrument editor application</h3> |
9730 |
|
|
9731 |
|
<p>The front-end can request to open an appropriate instrument |
9732 |
|
editor application by sending the following command: |
9733 |
|
</p> |
9734 |
|
<p> |
9735 |
|
</p> |
9736 |
|
<blockquote class="text"> |
9737 |
|
<p>EDIT CHANNEL INSTRUMENT <sampler-channel> |
9738 |
|
</p> |
9739 |
|
</blockquote><p> |
9740 |
|
|
9741 |
|
</p> |
9742 |
|
<p>Where <sampler-channel> should be replaced by the |
9743 |
|
number of the sampler channel as given by the |
9744 |
|
<a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a> |
9745 |
|
or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> |
9746 |
|
command. |
9747 |
|
</p> |
9748 |
|
<p>The sampler will try to ask all registered instrument |
9749 |
|
editors (or to be more specific: their sampler plugins) |
9750 |
|
whether they are capable to handle the instrument on the |
9751 |
|
given sampler channel. The sampler will simply use the first |
9752 |
|
instrument editor application which replied with a positive |
9753 |
|
answer and spawn that instrument editor application within |
9754 |
|
the sampler's process and provide that application access |
9755 |
|
to the instrument's data structures, so both applications |
9756 |
|
can share and access the same instruments data at the same |
9757 |
|
time, thus allowing to immediately hear changes with the |
9758 |
|
sampler made by the instrument editor. |
9759 |
|
</p> |
9760 |
|
<p>Note: consequently instrument editors are always spawned |
9761 |
|
locally on the same machine where the sampler is running |
9762 |
|
on! |
9763 |
|
</p> |
9764 |
|
<p>Possible Answers: |
9765 |
|
</p> |
9766 |
|
<p> |
9767 |
|
</p> |
9768 |
|
<blockquote class="text"> |
9769 |
|
<p>"OK" - |
9770 |
|
</p> |
9771 |
|
<blockquote class="text"> |
9772 |
|
<p>when an appropriate instrument editor was |
9773 |
|
launched |
9774 |
|
</p> |
9775 |
|
</blockquote> |
9776 |
|
|
9777 |
|
|
9778 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
9779 |
|
</p> |
9780 |
|
<blockquote class="text"> |
9781 |
|
<p>when an appropriate instrument editor was |
9782 |
|
launched, but there are noteworthy issues |
9783 |
|
</p> |
9784 |
|
</blockquote> |
9785 |
|
|
9786 |
|
|
9787 |
|
<p>"ERR:<error-code>:<error-message>" - |
9788 |
|
</p> |
9789 |
|
<blockquote class="text"> |
9790 |
|
<p>when an appropriate instrument editor |
9791 |
|
could not be launched |
9792 |
|
</p> |
9793 |
|
</blockquote> |
9794 |
|
|
9795 |
|
|
9796 |
|
</blockquote><p> |
9797 |
|
|
9798 |
|
</p> |
9799 |
|
<p>Examples: |
9800 |
|
</p> |
9801 |
|
<p> |
9802 |
|
</p> |
9803 |
|
<blockquote class="text"> |
9804 |
|
<p>C: "EDIT CHANNEL INSTRUMENT 0" |
9805 |
|
</p> |
9806 |
|
<p>S: "OK" |
9807 |
|
</p> |
9808 |
|
</blockquote><p> |
9809 |
|
|
9810 |
|
</p> |
9811 |
|
<a name="file_management"></a><br /><hr /> |
9812 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9813 |
|
<a name="rfc.section.6.10"></a><h3>6.10. |
9814 |
|
Managing Files</h3> |
9815 |
|
|
9816 |
|
<p>You can query detailed informations about files located |
9817 |
|
at the same system where the sampler instance is running on. |
9818 |
|
Using this command set allows to retrieve file informations |
9819 |
|
even remotely from another machine. |
9820 |
|
</p> |
9821 |
|
<a name="GET FILE INSTRUMENTS"></a><br /><hr /> |
9822 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9823 |
|
<a name="rfc.section.6.10.1"></a><h3>6.10.1. |
9824 |
|
Retrieving amount of instruments of a file</h3> |
9825 |
|
|
9826 |
|
<p>The front-end can retrieve the amount of instruments |
9827 |
|
within a given instrument file by sending the |
9828 |
|
following command: |
9829 |
|
</p> |
9830 |
|
<p> |
9831 |
|
</p> |
9832 |
|
<blockquote class="text"> |
9833 |
|
<p>GET FILE INSTRUMENTS <filename> |
9834 |
|
</p> |
9835 |
|
</blockquote><p> |
9836 |
|
|
9837 |
|
</p> |
9838 |
|
<p>Where <filename> is the name of the instrument |
9839 |
|
file (encapsulated into apostrophes, supporting escape |
9840 |
|
sequences as described in chapter |
9841 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
9842 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
9843 |
|
</p> |
9844 |
|
<p>The sampler will try to ask all sampler engines, |
9845 |
|
whether they support the given file and ask the first |
9846 |
|
engine with a positive answer for the amount of |
9847 |
|
instruments. |
9848 |
|
</p> |
9849 |
|
<p>Possible Answers: |
9850 |
|
</p> |
9851 |
|
<p> |
9852 |
|
</p> |
9853 |
|
<blockquote class="text"> |
9854 |
|
<p>On success, the sampler will answer by |
9855 |
|
returning the amount of instruments. |
9856 |
|
|
9857 |
|
</p> |
9858 |
|
<p>"ERR:<error-code>:<error-message>" - |
9859 |
|
</p> |
9860 |
|
<blockquote class="text"> |
9861 |
|
<p>if the file could not be handled |
9862 |
|
</p> |
9863 |
|
</blockquote> |
9864 |
|
|
9865 |
|
|
9866 |
|
</blockquote><p> |
9867 |
|
|
9868 |
|
</p> |
9869 |
|
<p>Examples: |
9870 |
|
</p> |
9871 |
|
<p> |
9872 |
|
</p> |
9873 |
|
<blockquote class="text"> |
9874 |
|
<p>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'" |
9875 |
|
</p> |
9876 |
|
<p>S: "10" |
9877 |
|
</p> |
9878 |
|
</blockquote><p> |
9879 |
|
|
9880 |
|
</p> |
9881 |
|
<a name="LIST FILE INSTRUMENTS"></a><br /><hr /> |
9882 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9883 |
|
<a name="rfc.section.6.10.2"></a><h3>6.10.2. |
9884 |
|
Retrieving all instruments of a file</h3> |
9885 |
|
|
9886 |
|
<p>The front-end can retrieve a list of all instruments |
9887 |
|
within a given instrument file by sending the |
9888 |
|
following command: |
9889 |
|
</p> |
9890 |
|
<p> |
9891 |
|
</p> |
9892 |
|
<blockquote class="text"> |
9893 |
|
<p>LIST FILE INSTRUMENTS <filename> |
9894 |
|
</p> |
9895 |
|
</blockquote><p> |
9896 |
|
|
9897 |
|
</p> |
9898 |
|
<p>Where <filename> is the name of the instrument |
9899 |
|
file (encapsulated into apostrophes, supporting escape |
9900 |
|
sequences as described in chapter |
9901 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
9902 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
9903 |
|
</p> |
9904 |
|
<p>The sampler will try to ask all sampler engines, |
9905 |
|
whether they support the given file and ask the first |
9906 |
|
engine with a positive answer for a list of IDs for the |
9907 |
|
instruments in the given file. |
9908 |
|
</p> |
9909 |
|
<p>Possible Answers: |
9910 |
|
</p> |
9911 |
|
<p> |
9912 |
|
</p> |
9913 |
|
<blockquote class="text"> |
9914 |
|
<p>On success, the sampler will answer by |
9915 |
|
returning a comma separated list of |
9916 |
|
instrument IDs. |
9917 |
|
|
9918 |
|
</p> |
9919 |
|
<p>"ERR:<error-code>:<error-message>" - |
9920 |
|
</p> |
9921 |
|
<blockquote class="text"> |
9922 |
|
<p>if the file could not be handled |
9923 |
|
</p> |
9924 |
|
</blockquote> |
9925 |
|
|
9926 |
|
|
9927 |
|
</blockquote><p> |
9928 |
|
|
9929 |
|
</p> |
9930 |
|
<p>Examples: |
9931 |
|
</p> |
9932 |
|
<p> |
9933 |
|
</p> |
9934 |
|
<blockquote class="text"> |
9935 |
|
<p>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'" |
9936 |
|
</p> |
9937 |
|
<p>S: "0,1,2,3,4,5,6,7,8,9" |
9938 |
|
</p> |
9939 |
|
</blockquote><p> |
9940 |
|
|
9941 |
|
</p> |
9942 |
|
<a name="GET FILE INSTRUMENT INFO"></a><br /><hr /> |
9943 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9944 |
|
<a name="rfc.section.6.10.3"></a><h3>6.10.3. |
9945 |
|
Retrieving informations about one instrument in a file</h3> |
9946 |
|
|
9947 |
|
<p>The front-end can retrieve detailed informations |
9948 |
|
about a specific instrument within a given instrument |
9949 |
|
file by sending the following command: |
9950 |
|
</p> |
9951 |
|
<p> |
9952 |
|
</p> |
9953 |
|
<blockquote class="text"> |
9954 |
|
<p>GET FILE INSTRUMENT INFO <filename> |
9955 |
|
<instr-id> |
9956 |
|
</p> |
9957 |
|
</blockquote><p> |
9958 |
|
|
9959 |
|
</p> |
9960 |
|
<p>Where <filename> is the name of the instrument |
9961 |
|
file (encapsulated into apostrophes, supporting escape |
9962 |
|
sequences as described in chapter |
9963 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
9964 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") and <instr-id> is the numeric |
9965 |
|
instrument ID as returned by the |
9966 |
|
<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. |
9967 |
|
</p> |
9968 |
|
<p>The sampler will try to ask all sampler engines, |
9969 |
|
whether they support the given file and ask the first |
9970 |
|
engine with a positive answer for informations about the |
9971 |
|
specific instrument in the given file. |
9972 |
|
</p> |
9973 |
|
<p>Possible Answers: |
9974 |
|
</p> |
9975 |
|
<p> |
9976 |
|
</p> |
9977 |
|
<blockquote class="text"> |
9978 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
9979 |
|
Each answer line begins with the settings category name |
9980 |
|
followed by a colon and then a space character <SP> and finally |
9981 |
|
the info character string to that setting category. At the |
9982 |
|
moment the following categories are defined: |
9983 |
|
</p> |
9984 |
|
<p> |
9985 |
|
</p> |
9986 |
|
<blockquote class="text"> |
9987 |
|
<p>NAME - |
9988 |
|
</p> |
9989 |
|
<blockquote class="text"> |
9990 |
|
<p>name of the instrument as |
9991 |
|
stored in the instrument file |
9992 |
|
</p> |
9993 |
|
</blockquote> |
9994 |
|
|
9995 |
|
|
9996 |
|
<p>FORMAT_FAMILY - |
9997 |
|
</p> |
9998 |
|
<blockquote class="text"> |
9999 |
|
<p>name of the sampler format |
10000 |
|
of the given instrument |
10001 |
|
</p> |
10002 |
|
</blockquote> |
10003 |
|
|
10004 |
|
|
10005 |
|
<p>FORMAT_VERSION - |
10006 |
|
</p> |
10007 |
|
<blockquote class="text"> |
10008 |
|
<p>version of the sampler format |
10009 |
|
the instrumen is stored as |
10010 |
|
</p> |
10011 |
|
</blockquote> |
10012 |
|
|
10013 |
|
|
10014 |
|
<p>PRODUCT - |
10015 |
|
</p> |
10016 |
|
<blockquote class="text"> |
10017 |
|
<p>official product name of the |
10018 |
|
instrument as stored in the file |
10019 |
|
|
10020 |
|
</p> |
10021 |
|
</blockquote> |
10022 |
|
|
10023 |
|
|
10024 |
|
<p>ARTISTS - |
10025 |
|
</p> |
10026 |
|
<blockquote class="text"> |
10027 |
|
<p>artists / sample library |
10028 |
|
vendor of the instrument |
10029 |
|
</p> |
10030 |
|
</blockquote> |
10031 |
|
|
10032 |
|
|
10033 |
|
<p>KEY_BINDINGS - |
10034 |
|
</p> |
10035 |
|
<blockquote class="text"> |
10036 |
|
<p>comma separated list of integer values representing |
10037 |
|
the instrument's key mapping in the range between 0 .. 127, |
10038 |
|
reflecting the analog meaning of the MIDI specification. |
10039 |
|
</p> |
10040 |
|
</blockquote> |
10041 |
|
|
10042 |
|
|
10043 |
|
<p>KEYSWITCH_BINDINGS - |
10044 |
|
</p> |
10045 |
|
<blockquote class="text"> |
10046 |
|
<p>comma separated list of integer values representing |
10047 |
|
the instrument's keyswitch mapping in the range between 0 .. 127, |
10048 |
|
reflecting the analog meaning of the MIDI specification. |
10049 |
|
</p> |
10050 |
|
</blockquote> |
10051 |
|
|
10052 |
|
|
10053 |
|
</blockquote> |
10054 |
|
|
10055 |
|
|
10056 |
|
</blockquote><p> |
10057 |
|
|
10058 |
|
</p> |
10059 |
|
<p>The mentioned fields above don't have to be in particular order. |
10060 |
|
</p> |
10061 |
|
<p>Example: |
10062 |
|
</p> |
10063 |
|
<p> |
10064 |
|
</p> |
10065 |
|
<blockquote class="text"> |
10066 |
|
<p>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0" |
10067 |
|
</p> |
10068 |
|
<p>S: "NAME: Lunatic Loops" |
10069 |
|
</p> |
10070 |
|
<p> "FORMAT_FAMILY: GIG" |
10071 |
|
</p> |
10072 |
|
<p> "FORMAT_VERSION: 3" |
10073 |
|
</p> |
10074 |
|
<p> "PRODUCT: The Backbone Bongo Beats" |
10075 |
|
</p> |
10076 |
|
<p> "ARTISTS: Jimmy the Fish" |
10077 |
|
</p> |
10078 |
|
<p> "." |
10079 |
|
</p> |
10080 |
|
</blockquote><p> |
10081 |
|
|
10082 |
|
</p> |
10083 |
|
<a name="effects"></a><br /><hr /> |
10084 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10085 |
|
<a name="rfc.section.6.11"></a><h3>6.11. |
10086 |
|
Managing Effects</h3> |
10087 |
|
|
10088 |
|
<p>Audio effects (e.g. reverb, delay, compression) can be |
10089 |
|
applied to the audio signals generated by the sampler. The |
10090 |
|
sampler usually provides a set of internal audio effects for |
10091 |
|
this task. The exact set of effects depends on the availability |
10092 |
|
of third party effect plugins installed on the system where the |
10093 |
|
sampler runs on. |
10094 |
|
</p> |
10095 |
|
<p>At the moment only "send effects" are supported. Support for |
10096 |
|
"insert effects" and "master effects" is planned to be added at |
10097 |
|
a later point. |
10098 |
|
</p> |
10099 |
|
<p>The following commands allow to retrieve the set of internal |
10100 |
|
effects available to the sampler, detailed informations about |
10101 |
|
those effects and to create and destroy instances of such |
10102 |
|
effects. After an instance of an effect is created, the effect |
10103 |
|
instance can be inserted into the audio signal path of the |
10104 |
|
sampler, e.g. as send effect. |
10105 |
|
</p> |
10106 |
|
<p>The sampler allows to create an arbitrary amount of so called |
10107 |
|
send effect chains. Each effect chain can host an arbitrary |
10108 |
|
amount of effect instances. The output of the first effect |
10109 |
|
instance in an effect chain is fed to the input of the second |
10110 |
|
effect instance of the chain and so on. So effects in one chain |
10111 |
|
are processed sequentially. Send effect chains however are |
10112 |
|
processed in parallel to other send effect chains. Audio signals |
10113 |
|
of sampler channels are fed to send effects by creating FX sends |
10114 |
|
to the respective sampler channel and assigning a destination |
10115 |
|
send effect to that FX by using the |
10116 |
|
<a class='info' href='#SET FX_SEND SEND_EFFECT'>"SET FX_SEND SEND_EFFECT"<span> (</span><span class='info'>Assigning destination effect to an effect send</span><span>)</span></a> |
10117 |
|
command. The latter allows to route the FX send to the beginning |
10118 |
|
of a send effect chain, as well as directly to any other |
10119 |
|
position of the send effect chain. |
10120 |
|
</p> |
10121 |
|
<a name="GET AVAILABLE_EFFECTS"></a><br /><hr /> |
10122 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10123 |
|
<a name="rfc.section.6.11.1"></a><h3>6.11.1. |
10124 |
|
Retrieve amount of available effects</h3> |
10125 |
|
|
10126 |
|
<p>The front-end can retrieve the amount of internal |
10127 |
|
effects, available to the sampler by sending |
10128 |
|
the following command: |
10129 |
|
</p> |
10130 |
|
<p> |
10131 |
|
</p> |
10132 |
|
<blockquote class="text"> |
10133 |
|
<p>GET AVAILABLE_EFFECTS |
10134 |
|
</p> |
10135 |
|
</blockquote><p> |
10136 |
|
|
10137 |
|
</p> |
10138 |
|
<p>Possible Answers: |
10139 |
|
</p> |
10140 |
|
<p> |
10141 |
|
</p> |
10142 |
|
<blockquote class="text"> |
10143 |
|
<p>The sampler will answer by returning the current |
10144 |
|
number of effects available to the sampler. |
10145 |
|
</p> |
10146 |
|
</blockquote><p> |
10147 |
|
|
10148 |
|
</p> |
10149 |
|
<p>Examples: |
10150 |
|
</p> |
10151 |
|
<p> |
10152 |
|
</p> |
10153 |
|
<blockquote class="text"> |
10154 |
|
<p>C: "GET AVAILABLE_EFFECTS" |
10155 |
|
</p> |
10156 |
|
<p>S: "129" |
10157 |
|
</p> |
10158 |
|
</blockquote><p> |
10159 |
|
|
10160 |
|
</p> |
10161 |
|
<a name="LIST AVAILABLE_EFFECTS"></a><br /><hr /> |
10162 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10163 |
|
<a name="rfc.section.6.11.2"></a><h3>6.11.2. |
10164 |
|
Get list of available effects</h3> |
10165 |
|
|
10166 |
|
<p>The set of available internal effects can change at |
10167 |
|
runtime. The front-end can retrieve the list of internal |
10168 |
|
effects, available to the sampler by sending the following |
10169 |
|
command: |
10170 |
|
</p> |
10171 |
|
<p> |
10172 |
|
</p> |
10173 |
|
<blockquote class="text"> |
10174 |
|
<p>LIST AVAILABLE_EFFECTS |
10175 |
|
</p> |
10176 |
|
</blockquote><p> |
10177 |
|
|
10178 |
|
</p> |
10179 |
|
<p>Possible Answers: |
10180 |
|
</p> |
10181 |
|
<p> |
10182 |
|
</p> |
10183 |
|
<blockquote class="text"> |
10184 |
|
<p>The sampler will answer by returning a comma |
10185 |
|
separated list with numerical IDs of effects. Note: |
10186 |
|
the numercial ID of an effect is generated by the |
10187 |
|
sampler for the current moment. The numerical ID of |
10188 |
|
the same effect can change at runtime, e.g. when the |
10189 |
|
user requests a rescan of available effect plugins. |
10190 |
|
|
10191 |
|
</p> |
10192 |
|
</blockquote><p> |
10193 |
|
|
10194 |
|
</p> |
10195 |
|
<p>Example: |
10196 |
|
</p> |
10197 |
|
<p> |
10198 |
|
</p> |
10199 |
|
<blockquote class="text"> |
10200 |
|
<p>C: "LIST AVAILABLE_EFFECTS" |
10201 |
|
</p> |
10202 |
|
<p>S: "5,6,7,120,121,122,123,124" |
10203 |
|
</p> |
10204 |
|
</blockquote><p> |
10205 |
|
|
10206 |
|
</p> |
10207 |
|
<a name="GET EFFECT INFO"></a><br /><hr /> |
10208 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10209 |
|
<a name="rfc.section.6.11.3"></a><h3>6.11.3. |
10210 |
|
Retrieving general information about an effect</h3> |
10211 |
|
|
10212 |
|
<p>The front-end can ask for general informations about an |
10213 |
|
effect by sending the following command: |
10214 |
|
</p> |
10215 |
|
<p> |
10216 |
|
</p> |
10217 |
|
<blockquote class="text"> |
10218 |
|
<p>GET EFFECT INFO <effect-index> |
10219 |
|
</p> |
10220 |
|
</blockquote><p> |
10221 |
|
|
10222 |
|
</p> |
10223 |
|
<p>Where <effect-index> is the numerical ID of an |
10224 |
|
effect as returned by the |
10225 |
|
<a class='info' href='#LIST AVAILABLE_EFFECTS'>"LIST AVAILABLE_EFFECTS"<span> (</span><span class='info'>Get list of available effects</span><span>)</span></a> |
10226 |
|
command. |
10227 |
|
</p> |
10228 |
|
<p>Possible Answers: |
10229 |
|
</p> |
10230 |
|
<p> |
10231 |
|
</p> |
10232 |
|
<blockquote class="text"> |
10233 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
10234 |
|
Each answer line begins with the effect information |
10235 |
|
category name, followed by a colon and then a space |
10236 |
|
character <SP> and finally the info character |
10237 |
|
string to that effect information category. At the |
10238 |
|
moment the following categories are defined: |
10239 |
|
</p> |
10240 |
|
<p> |
10241 |
|
</p> |
10242 |
|
<blockquote class="text"> |
10243 |
|
<p>SYSTEM - |
10244 |
|
</p> |
10245 |
|
<blockquote class="text"> |
10246 |
|
<p>name of the effect plugin system |
10247 |
|
the effect is based on |
10248 |
|
(e.g. "LADSPA") |
10249 |
|
</p> |
10250 |
|
</blockquote> |
10251 |
|
|
10252 |
|
|
10253 |
|
<p>MODULE - |
10254 |
|
</p> |
10255 |
|
<blockquote class="text"> |
10256 |
|
<p>module of the effect plugin |
10257 |
|
system that contains this effect, |
10258 |
|
the module is usually the |
10259 |
|
dynamic-linked library (DLL) |
10260 |
|
filename of the effect plugin, |
10261 |
|
including full path (note that this |
10262 |
|
filename may contain |
10263 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10264 |
|
</p> |
10265 |
|
</blockquote> |
10266 |
|
|
10267 |
|
|
10268 |
|
<p>NAME - |
10269 |
|
</p> |
10270 |
|
<blockquote class="text"> |
10271 |
|
<p>character string defining the |
10272 |
|
unique name of the effect within its |
10273 |
|
module (note that the character |
10274 |
|
string may contain |
10275 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10276 |
|
</p> |
10277 |
|
</blockquote> |
10278 |
|
|
10279 |
|
|
10280 |
|
<p>DESCRIPTION - |
10281 |
|
</p> |
10282 |
|
<blockquote class="text"> |
10283 |
|
<p>human readable name of the |
10284 |
|
effect, intended to be displayed in |
10285 |
|
user interfaces (note that the |
10286 |
|
character string may contain |
10287 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10288 |
|
</p> |
10289 |
|
</blockquote> |
10290 |
|
|
10291 |
|
|
10292 |
|
</blockquote> |
10293 |
|
|
10294 |
|
|
10295 |
|
</blockquote><p> |
10296 |
|
|
10297 |
|
</p> |
10298 |
|
<p>The mentioned fields above don't have to be in particular order. |
10299 |
|
</p> |
10300 |
|
<p>Example: |
10301 |
|
</p> |
10302 |
|
<p> |
10303 |
|
</p> |
10304 |
|
<blockquote class="text"> |
10305 |
|
<p>C: "GET EFFECT INFO 121" |
10306 |
|
</p> |
10307 |
|
<p>S: "SYSTEM: LADSPA" |
10308 |
|
</p> |
10309 |
|
<p> "MODULE: /usr/lib/ladspa/lowpass_iir_1891.so" |
10310 |
|
</p> |
10311 |
|
<p> "NAME: lowpass_iir" |
10312 |
|
</p> |
10313 |
|
<p> "DESCRIPTION: Glame Lowpass Filter" |
10314 |
|
</p> |
10315 |
|
<p> "." |
10316 |
|
</p> |
10317 |
|
</blockquote><p> |
10318 |
|
|
10319 |
|
</p> |
10320 |
|
<a name="CREATE EFFECT_INSTANCE"></a><br /><hr /> |
10321 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10322 |
|
<a name="rfc.section.6.11.4"></a><h3>6.11.4. |
10323 |
|
Creating an instance of an effect by its portable ID</h3> |
10324 |
|
|
10325 |
|
<p>The front-end can spawn an instance of the desired |
10326 |
|
effect by sending the following command: |
10327 |
|
</p> |
10328 |
|
<p> |
10329 |
|
</p> |
10330 |
|
<blockquote class="text"> |
10331 |
|
<p>CREATE EFFECT_INSTANCE <effect-system> <module> <effect-name> |
10332 |
|
</p> |
10333 |
|
</blockquote><p> |
10334 |
|
|
10335 |
|
</p> |
10336 |
|
<p>Where <effect-system> is the "SYSTEM" field, |
10337 |
|
<module> the "MODULE" field and <effect-name> |
10338 |
|
the "NAME" field as returned by the |
10339 |
|
<a class='info' href='#GET EFFECT INFO'>"GET EFFECT INFO"<span> (</span><span class='info'>Retrieving general information about an effect</span><span>)</span></a> |
10340 |
|
command. The filename of argument <module> and the |
10341 |
|
character string of argument <effect-name> may contain |
10342 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
10343 |
|
</p> |
10344 |
|
<p>The sampler will try to load the requested effect and to |
10345 |
|
create an instance of it. To allow loading the same effect |
10346 |
|
on a different machine, probably even running a completely |
10347 |
|
different operating system (e.g. Linux vs. Windows), the |
10348 |
|
sampler tries to match <module> "softly". That means |
10349 |
|
it first tries to find an effect that exactly matches the |
10350 |
|
given <module> argument. If there is no exact match, |
10351 |
|
the sampler will try to lower the restrictions on matching |
10352 |
|
the <module> argument more and more, e.g. by ignoring |
10353 |
|
upper / lower case differences and by ignoring the path of |
10354 |
|
the DLL filename and file extension. If there is still no |
10355 |
|
match at the end, the sampler will try to ignore the |
10356 |
|
<module> argument completely and as a last resort |
10357 |
|
search for an effect that only matches the given |
10358 |
|
<effect-system> and <effect-name> arguments. |
10359 |
|
</p> |
10360 |
|
<p>Possible Answers: |
10361 |
|
</p> |
10362 |
|
<p> |
10363 |
|
</p> |
10364 |
|
<blockquote class="text"> |
10365 |
|
<p>"OK[<effect-instance>]" - |
10366 |
|
</p> |
10367 |
|
<blockquote class="text"> |
10368 |
|
<p>in case the effect instance was |
10369 |
|
successfully created, where |
10370 |
|
<effect-instance> is the numerical ID |
10371 |
|
of the new effect instance |
10372 |
|
</p> |
10373 |
|
</blockquote> |
10374 |
|
|
10375 |
|
|
10376 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
10377 |
|
</p> |
10378 |
|
<blockquote class="text"> |
10379 |
|
<p>in case the effect instance was spawned |
10380 |
|
successfully, but there are noteworthy |
10381 |
|
issue(s) related, providing an appropriate |
10382 |
|
warning code and warning message |
10383 |
|
</p> |
10384 |
|
</blockquote> |
10385 |
|
|
10386 |
|
|
10387 |
|
<p>"ERR:<error-code>:<error-message>" - |
10388 |
|
</p> |
10389 |
|
<blockquote class="text"> |
10390 |
|
<p>if the effect could not be instantiated |
10391 |
|
</p> |
10392 |
|
</blockquote> |
10393 |
|
|
10394 |
|
|
10395 |
|
</blockquote><p> |
10396 |
|
|
10397 |
|
</p> |
10398 |
|
<p>Examples: |
10399 |
|
</p> |
10400 |
|
<p> |
10401 |
|
</p> |
10402 |
|
<blockquote class="text"> |
10403 |
|
<p>C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/mod_delay_1419.so' 'modDelay'" |
10404 |
|
</p> |
10405 |
|
<p>S: "OK[0]" |
10406 |
|
</p> |
10407 |
|
</blockquote><p> |
10408 |
|
|
10409 |
|
</p> |
10410 |
|
<a name="CREATE EFFECT_INSTANCE (non-portable)"></a><br /><hr /> |
10411 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10412 |
|
<a name="rfc.section.6.11.5"></a><h3>6.11.5. |
10413 |
|
Creating an instance of an effect by its numerical ID</h3> |
10414 |
|
|
10415 |
|
<p>The front-end can spawn an instance of the desired |
10416 |
|
effect by sending the following command: |
10417 |
|
</p> |
10418 |
|
<p> |
10419 |
|
</p> |
10420 |
|
<blockquote class="text"> |
10421 |
|
<p>CREATE EFFECT_INSTANCE <effect-index> |
10422 |
|
</p> |
10423 |
|
</blockquote><p> |
10424 |
|
|
10425 |
|
</p> |
10426 |
|
<p>Where <effect-index> is the numerical ID of the |
10427 |
|
effect as returned by the |
10428 |
|
<a class='info' href='#LIST AVAILABLE_EFFECTS'>"LIST AVAILABLE_EFFECTS"<span> (</span><span class='info'>Get list of available effects</span><span>)</span></a> |
10429 |
|
command. |
10430 |
|
</p> |
10431 |
|
<p>The sampler will try to load the requested effect and to |
10432 |
|
create an instance of it. |
10433 |
|
</p> |
10434 |
|
<p>Note: Since the numerical ID of a certain effect can |
10435 |
|
change at any time, you should not use this command in |
10436 |
|
LSCP files to restore a certain effect at a later time! To |
10437 |
|
store a sampler session including all its effects, use the |
10438 |
|
<a class='info' href='#CREATE EFFECT_INSTANCE'>portable text-based |
10439 |
|
version of "CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> instead! This |
10440 |
|
allows to restore a sampler session with all its effects |
10441 |
|
also on other machines, possibly even running a completely |
10442 |
|
different operating system (e.g. Linux vs. Windows), with |
10443 |
|
different plugin directories or plugin DLL names. |
10444 |
|
</p> |
10445 |
|
<p>Possible Answers: |
10446 |
|
</p> |
10447 |
|
<p> |
10448 |
|
</p> |
10449 |
|
<blockquote class="text"> |
10450 |
|
<p>"OK[<effect-instance>]" - |
10451 |
|
</p> |
10452 |
|
<blockquote class="text"> |
10453 |
|
<p>in case the effect instance was |
10454 |
|
successfully created, where |
10455 |
|
<effect-instance> is the numerical ID |
10456 |
|
of the new effect instance |
10457 |
|
</p> |
10458 |
|
</blockquote> |
10459 |
|
|
10460 |
|
|
10461 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
10462 |
|
</p> |
10463 |
|
<blockquote class="text"> |
10464 |
|
<p>in case the effect instance was spawned |
10465 |
|
successfully, but there are noteworthy |
10466 |
|
issue(s) related, providing an appropriate |
10467 |
|
warning code and warning message |
10468 |
|
</p> |
10469 |
|
</blockquote> |
10470 |
|
|
10471 |
|
|
10472 |
|
<p>"ERR:<error-code>:<error-message>" - |
10473 |
|
</p> |
10474 |
|
<blockquote class="text"> |
10475 |
|
<p>if the effect could not be instantiated |
10476 |
|
</p> |
10477 |
|
</blockquote> |
10478 |
|
|
10479 |
|
|
10480 |
|
</blockquote><p> |
10481 |
|
|
10482 |
|
</p> |
10483 |
|
<p>Examples: |
10484 |
|
</p> |
10485 |
|
<p> |
10486 |
|
</p> |
10487 |
|
<blockquote class="text"> |
10488 |
|
<p>C: "CREATE EFFECT_INSTANCE 72" |
10489 |
|
</p> |
10490 |
|
<p>S: "OK[5]" |
10491 |
|
</p> |
10492 |
|
</blockquote><p> |
10493 |
|
|
10494 |
|
</p> |
10495 |
|
<a name="DESTROY EFFECT_INSTANCE"></a><br /><hr /> |
10496 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10497 |
|
<a name="rfc.section.6.11.6"></a><h3>6.11.6. |
10498 |
|
Destroy an effect instance</h3> |
10499 |
|
|
10500 |
|
<p>The front-end can destroy an unusued effect instance and |
10501 |
|
thus freeing it from memory by sending the following command: |
10502 |
|
</p> |
10503 |
|
<p> |
10504 |
|
</p> |
10505 |
|
<blockquote class="text"> |
10506 |
|
<p>DESTROY EFFECT_INSTANCE <effect-instance> |
10507 |
|
</p> |
10508 |
|
</blockquote><p> |
10509 |
|
|
10510 |
|
</p> |
10511 |
|
<p>Where <effect-instance> is the numerical ID of the |
10512 |
|
effect instance as returned by the |
10513 |
|
<a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> or |
10514 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
10515 |
|
command. |
10516 |
|
</p> |
10517 |
|
<p>The effect instance can only be destroyed if it's not |
10518 |
|
used in any part of the sampler's audio signal path anymore. |
10519 |
|
If the effect instance is still in use somewhere, trying to |
10520 |
|
destroy the effect instance will result in an error |
10521 |
|
message. |
10522 |
|
</p> |
10523 |
|
<p>Possible Answers: |
10524 |
|
</p> |
10525 |
|
<p> |
10526 |
|
</p> |
10527 |
|
<blockquote class="text"> |
10528 |
|
<p>"OK" - |
10529 |
|
</p> |
10530 |
|
<blockquote class="text"> |
10531 |
|
<p>in case the effect instance was successfully destroyed |
10532 |
|
</p> |
10533 |
|
</blockquote> |
10534 |
|
|
10535 |
|
|
10536 |
|
<p>"ERR:<error-code>:<error-message>" - |
10537 |
|
</p> |
10538 |
|
<blockquote class="text"> |
10539 |
|
<p>in case it failed, providing an appropriate error code and |
10540 |
|
error message |
10541 |
|
</p> |
10542 |
|
</blockquote> |
10543 |
|
|
10544 |
|
|
10545 |
|
</blockquote><p> |
10546 |
|
|
10547 |
|
</p> |
10548 |
|
<p>Examples: |
10549 |
|
</p> |
10550 |
|
<p> |
10551 |
|
</p> |
10552 |
|
<blockquote class="text"> |
10553 |
|
<p>C: "DESTROY EFFECT_INSTANCE 5" |
10554 |
|
</p> |
10555 |
|
<p>S: "OK" |
10556 |
|
</p> |
10557 |
|
</blockquote><p> |
10558 |
|
|
10559 |
|
</p> |
10560 |
|
<a name="GET EFFECT_INSTANCES"></a><br /><hr /> |
10561 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10562 |
|
<a name="rfc.section.6.11.7"></a><h3>6.11.7. |
10563 |
|
Retrieve amount of effect instances</h3> |
10564 |
|
|
10565 |
|
<p>The front-end can retrieve the current amount of effect |
10566 |
|
instances by sending the following command: |
10567 |
|
</p> |
10568 |
|
<p> |
10569 |
|
</p> |
10570 |
|
<blockquote class="text"> |
10571 |
|
<p>GET EFFECT_INSTANCES |
10572 |
|
</p> |
10573 |
|
</blockquote><p> |
10574 |
|
|
10575 |
|
</p> |
10576 |
|
<p>Possible Answers: |
10577 |
|
</p> |
10578 |
|
<p> |
10579 |
|
</p> |
10580 |
|
<blockquote class="text"> |
10581 |
|
<p>The sampler will answer by returning the current |
10582 |
|
number of effect instances created and not yet |
10583 |
|
destroyed in the current sampler session. |
10584 |
|
</p> |
10585 |
|
</blockquote><p> |
10586 |
|
|
10587 |
|
</p> |
10588 |
|
<p>Examples: |
10589 |
|
</p> |
10590 |
|
<p> |
10591 |
|
</p> |
10592 |
|
<blockquote class="text"> |
10593 |
|
<p>C: "GET EFFECT_INSTANCES" |
10594 |
|
</p> |
10595 |
|
<p>S: "14" |
10596 |
|
</p> |
10597 |
|
</blockquote><p> |
10598 |
|
|
10599 |
|
</p> |
10600 |
|
<a name="LIST EFFECT_INSTANCES"></a><br /><hr /> |
10601 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10602 |
|
<a name="rfc.section.6.11.8"></a><h3>6.11.8. |
10603 |
|
Get list of effect instances</h3> |
10604 |
|
|
10605 |
|
<p>The front-end can retrieve the current list of effect |
10606 |
|
instances by sending the following command: |
10607 |
|
</p> |
10608 |
|
<p> |
10609 |
|
</p> |
10610 |
|
<blockquote class="text"> |
10611 |
|
<p>LIST EFFECT_INSTANCES |
10612 |
|
</p> |
10613 |
|
</blockquote><p> |
10614 |
|
|
10615 |
|
</p> |
10616 |
|
<p>Possible Answers: |
10617 |
|
</p> |
10618 |
|
<p> |
10619 |
|
</p> |
10620 |
|
<blockquote class="text"> |
10621 |
|
<p>The sampler will answer by returning a comma |
10622 |
|
separated list with numerical IDs of effects |
10623 |
|
instances. |
10624 |
|
|
10625 |
|
</p> |
10626 |
|
</blockquote><p> |
10627 |
|
|
10628 |
|
</p> |
10629 |
|
<p>Example: |
10630 |
|
</p> |
10631 |
|
<p> |
10632 |
|
</p> |
10633 |
|
<blockquote class="text"> |
10634 |
|
<p>C: "LIST EFFECT_INSTANCES" |
10635 |
|
</p> |
10636 |
|
<p>S: "9,11,14,15,16,17,25" |
10637 |
|
</p> |
10638 |
|
</blockquote><p> |
10639 |
|
|
10640 |
|
</p> |
10641 |
|
<a name="GET EFFECT_INSTANCE INFO"></a><br /><hr /> |
10642 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10643 |
|
<a name="rfc.section.6.11.9"></a><h3>6.11.9. |
10644 |
|
Retrieving current information about an effect instance</h3> |
10645 |
|
|
10646 |
|
<p>The front-end can ask for the current informations about |
10647 |
|
a particular effect instance by sending the following command: |
10648 |
|
</p> |
10649 |
|
<p> |
10650 |
|
</p> |
10651 |
|
<blockquote class="text"> |
10652 |
|
<p>GET EFFECT_INSTANCE INFO <effect-instance> |
10653 |
|
</p> |
10654 |
|
</blockquote><p> |
10655 |
|
|
10656 |
|
</p> |
10657 |
|
<p>Where <effect-instance> is the numerical ID of an |
10658 |
|
effect instance as returned by the |
10659 |
|
<a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> |
10660 |
|
or |
10661 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
10662 |
|
command. |
10663 |
|
</p> |
10664 |
|
<p>Possible Answers: |
10665 |
|
</p> |
10666 |
|
<p> |
10667 |
|
</p> |
10668 |
|
<blockquote class="text"> |
10669 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
10670 |
|
Each answer line begins with the information |
10671 |
|
category name, followed by a colon and then a space |
10672 |
|
character <SP> and finally the info character |
10673 |
|
string to that information category. At the |
10674 |
|
moment the following categories are defined: |
10675 |
|
</p> |
10676 |
|
<p> |
10677 |
|
</p> |
10678 |
|
<blockquote class="text"> |
10679 |
|
<p>SYSTEM - |
10680 |
|
</p> |
10681 |
|
<blockquote class="text"> |
10682 |
|
<p>name of the effect plugin system |
10683 |
|
the effect is based on |
10684 |
|
(e.g. "LADSPA") |
10685 |
|
</p> |
10686 |
|
</blockquote> |
10687 |
|
|
10688 |
|
|
10689 |
|
<p>MODULE - |
10690 |
|
</p> |
10691 |
|
<blockquote class="text"> |
10692 |
|
<p>module of the effect plugin |
10693 |
|
system that contains this effect, |
10694 |
|
the module is usually the |
10695 |
|
dynamic-linked library (DLL) |
10696 |
|
filename of the effect plugin, |
10697 |
|
including full path (note that this |
10698 |
|
filename may contain |
10699 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10700 |
|
</p> |
10701 |
|
</blockquote> |
10702 |
|
|
10703 |
|
|
10704 |
|
<p>NAME - |
10705 |
|
</p> |
10706 |
|
<blockquote class="text"> |
10707 |
|
<p>character string defining the |
10708 |
|
unique name of the effect within its |
10709 |
|
module (note that the character |
10710 |
|
string may contain |
10711 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10712 |
|
</p> |
10713 |
|
</blockquote> |
10714 |
|
|
10715 |
|
|
10716 |
|
<p>DESCRIPTION - |
10717 |
|
</p> |
10718 |
|
<blockquote class="text"> |
10719 |
|
<p>human readable name of the |
10720 |
|
effect, intended to be displayed in |
10721 |
|
user interfaces (note that the |
10722 |
|
character string may contain |
10723 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10724 |
|
</p> |
10725 |
|
</blockquote> |
10726 |
|
|
10727 |
|
|
10728 |
|
<p>INPUT_CONTROLS - |
10729 |
|
</p> |
10730 |
|
<blockquote class="text"> |
10731 |
|
<p>amount of input controls the |
10732 |
|
effect instance provides, to allow |
10733 |
|
controlling the effect parameters in |
10734 |
|
realtime |
10735 |
|
</p> |
10736 |
|
</blockquote> |
10737 |
|
|
10738 |
|
|
10739 |
|
</blockquote> |
10740 |
|
|
10741 |
|
|
10742 |
|
</blockquote><p> |
10743 |
|
|
10744 |
|
</p> |
10745 |
|
<p>The mentioned fields above don't have to be in particular order. |
10746 |
|
</p> |
10747 |
|
<p>Example: |
10748 |
|
</p> |
10749 |
|
<p> |
10750 |
|
</p> |
10751 |
|
<blockquote class="text"> |
10752 |
|
<p>C: "GET EFFECT_INSTANCE INFO 3" |
10753 |
|
</p> |
10754 |
|
<p>S: "SYSTEM: LADSPA" |
10755 |
|
</p> |
10756 |
|
<p> "MODULE: /usr/lib/ladspa/mod_delay_1419.so" |
10757 |
|
</p> |
10758 |
|
<p> "NAME: modDelay" |
10759 |
|
</p> |
10760 |
|
<p> "DESCRIPTION: Modulatable delay" |
10761 |
|
</p> |
10762 |
|
<p> "INPUT_CONTROLS: 1" |
10763 |
|
</p> |
10764 |
|
<p> "." |
10765 |
|
</p> |
10766 |
|
</blockquote><p> |
10767 |
|
|
10768 |
|
</p> |
10769 |
|
<a name="GET EFFECT_INSTANCE_INPUT_CONTROL INFO"></a><br /><hr /> |
10770 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10771 |
|
<a name="rfc.section.6.11.10"></a><h3>6.11.10. |
10772 |
|
Retrieving information about an effect parameter</h3> |
10773 |
|
|
10774 |
|
<p>Effects typically provide a certain set of effect |
10775 |
|
parameters which can be altered by the user in realtime |
10776 |
|
(e.g. depth of a reverb effect, duration of a delay effect, |
10777 |
|
dry / wet signal ratio). Those controllable effect parameters |
10778 |
|
are called "input controls". The front-end can ask for the |
10779 |
|
current informations of an effect instance's input control |
10780 |
|
by sending the following command: |
10781 |
|
</p> |
10782 |
|
<p> |
10783 |
|
</p> |
10784 |
|
<blockquote class="text"> |
10785 |
|
<p>GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-control> |
10786 |
|
</p> |
10787 |
|
</blockquote><p> |
10788 |
|
|
10789 |
|
</p> |
10790 |
|
<p>Where <effect-instance> is the numerical ID of an |
10791 |
|
effect instance as returned by the |
10792 |
|
<a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> |
10793 |
|
or |
10794 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
10795 |
|
command and <input-control> is the index of the input |
10796 |
|
control within the numerical bounds as returned by the |
10797 |
|
"INPUT_CONTROLS" field of the |
10798 |
|
<a class='info' href='#GET EFFECT_INSTANCE INFO'>"GET EFFECT_INSTANCE INFO"<span> (</span><span class='info'>Retrieving current information about an effect instance</span><span>)</span></a> |
10799 |
|
command. |
10800 |
|
</p> |
10801 |
|
<p>Possible Answers: |
10802 |
|
</p> |
10803 |
|
<p> |
10804 |
|
</p> |
10805 |
|
<blockquote class="text"> |
10806 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
10807 |
|
Each answer line begins with the information |
10808 |
|
category name, followed by a colon and then a space |
10809 |
|
character <SP> and finally the info character |
10810 |
|
string to that information category. There are |
10811 |
|
information categories which are always returned, |
10812 |
|
independent of the respective effect parameter and |
10813 |
|
there are optional information categories |
10814 |
|
which are only shown for certain effect parameters. |
10815 |
|
At the moment the following categories are defined: |
10816 |
|
</p> |
10817 |
|
<p> |
10818 |
|
</p> |
10819 |
|
<blockquote class="text"> |
10820 |
|
<p>DESCRIPTION - |
10821 |
|
</p> |
10822 |
|
<blockquote class="text"> |
10823 |
|
<p>(always returned) |
10824 |
|
human readable name of the |
10825 |
|
effect parameter, intended to be |
10826 |
|
displayed in user interfaces (note |
10827 |
|
that the character string may |
10828 |
|
contain <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10829 |
|
</p> |
10830 |
|
</blockquote> |
10831 |
|
|
10832 |
|
|
10833 |
|
<p>VALUE - |
10834 |
|
</p> |
10835 |
|
<blockquote class="text"> |
10836 |
|
<p> |
10837 |
|
(always returned) |
10838 |
|
current (optional dotted) |
10839 |
|
floating point value of this effect |
10840 |
|
parameter |
10841 |
|
</p> |
10842 |
|
</blockquote> |
10843 |
|
|
10844 |
|
|
10845 |
|
<p>RANGE_MIN - |
10846 |
|
</p> |
10847 |
|
<blockquote class="text"> |
10848 |
|
<p> |
10849 |
|
(optionally returned) |
10850 |
|
minimum allowed value for this |
10851 |
|
effect parameter |
10852 |
|
</p> |
10853 |
|
</blockquote> |
10854 |
|
|
10855 |
|
|
10856 |
|
<p>RANGE_MAX - |
10857 |
|
</p> |
10858 |
|
<blockquote class="text"> |
10859 |
|
<p> |
10860 |
|
(optionally returned) |
10861 |
|
maximum allowed value for this |
10862 |
|
effect parameter |
10863 |
|
</p> |
10864 |
|
</blockquote> |
10865 |
|
|
10866 |
|
|
10867 |
|
<p>POSSIBILITIES - |
10868 |
|
</p> |
10869 |
|
<blockquote class="text"> |
10870 |
|
<p> |
10871 |
|
(optionally returned) |
10872 |
|
comma separated list of |
10873 |
|
(optional dotted) floating point |
10874 |
|
numbers, reflecting the exact set of |
10875 |
|
possible values for this effect |
10876 |
|
parameter |
10877 |
|
</p> |
10878 |
|
</blockquote> |
10879 |
|
|
10880 |
|
|
10881 |
|
<p>DEFAULT - |
10882 |
|
</p> |
10883 |
|
<blockquote class="text"> |
10884 |
|
<p> |
10885 |
|
(optionally returned) |
10886 |
|
default value of this effect |
10887 |
|
parameter |
10888 |
|
</p> |
10889 |
|
</blockquote> |
10890 |
|
|
10891 |
|
|
10892 |
|
</blockquote> |
10893 |
|
|
10894 |
|
|
10895 |
|
</blockquote><p> |
10896 |
|
|
10897 |
|
</p> |
10898 |
|
<p>The mentioned fields above don't have to be in particular order. |
10899 |
|
</p> |
10900 |
|
<p>Example: |
10901 |
|
</p> |
10902 |
|
<p> |
10903 |
|
</p> |
10904 |
|
<blockquote class="text"> |
10905 |
|
<p>C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0" |
10906 |
|
</p> |
10907 |
|
<p>S: "SYSTEM: LADSPA" |
10908 |
|
</p> |
10909 |
|
<p> "DESCRIPTION: Base delay (s)" |
10910 |
|
</p> |
10911 |
|
<p> "VALUE: 0.500" |
10912 |
|
</p> |
10913 |
|
<p> "RANGE_MIN: 0.000" |
10914 |
|
</p> |
10915 |
|
<p> "." |
10916 |
|
</p> |
10917 |
|
</blockquote><p> |
10918 |
|
|
10919 |
|
</p> |
10920 |
|
<a name="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE"></a><br /><hr /> |
10921 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10922 |
|
<a name="rfc.section.6.11.11"></a><h3>6.11.11. |
10923 |
|
Altering an effect parameter</h3> |
10924 |
|
|
10925 |
|
<p>The front-end can alter the current value of an effect |
10926 |
|
parameter by sending the following command: |
10927 |
|
</p> |
10928 |
|
<p> |
10929 |
|
</p> |
10930 |
|
<blockquote class="text"> |
10931 |
|
<p>SET EFFECT_INSTANCE_INPUT_CONTROL VALUE <effect-instance> <input-control> <value> |
10932 |
|
</p> |
10933 |
|
</blockquote><p> |
10934 |
|
|
10935 |
|
</p> |
10936 |
|
<p>Where <effect-instance> is the numerical ID of the |
10937 |
|
effect instance as returned by the |
10938 |
|
<a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> or |
10939 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
10940 |
|
command, <input-control> is the index of the input |
10941 |
|
control within the numerical bounds as returned by the |
10942 |
|
"INPUT_CONTROLS" field of the |
10943 |
|
<a class='info' href='#GET EFFECT_INSTANCE INFO'>"GET EFFECT_INSTANCE INFO"<span> (</span><span class='info'>Retrieving current information about an effect instance</span><span>)</span></a> |
10944 |
|
command and <value> is the new (optional dotted) |
10945 |
|
floating point value for this effect parameter. |
10946 |
|
</p> |
10947 |
|
<p>Possible Answers: |
10948 |
|
</p> |
10949 |
|
<p> |
10950 |
|
</p> |
10951 |
|
<blockquote class="text"> |
10952 |
|
<p>"OK" - |
10953 |
|
</p> |
10954 |
|
<blockquote class="text"> |
10955 |
|
<p>in case the effect was altered successfully |
10956 |
|
</p> |
10957 |
|
</blockquote> |
10958 |
|
|
10959 |
|
|
10960 |
|
<p>"ERR:<error-code>:<error-message>" - |
10961 |
|
</p> |
10962 |
|
<blockquote class="text"> |
10963 |
|
<p>in case it failed, providing an appropriate error code and |
10964 |
|
error message |
10965 |
|
</p> |
10966 |
|
</blockquote> |
10967 |
|
|
10968 |
|
|
10969 |
|
</blockquote><p> |
10970 |
|
|
10971 |
|
</p> |
10972 |
|
<p>Examples: |
10973 |
|
</p> |
10974 |
|
<p> |
10975 |
|
</p> |
10976 |
|
<blockquote class="text"> |
10977 |
|
<p>C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5" |
10978 |
|
</p> |
10979 |
|
<p>S: "OK" |
10980 |
|
</p> |
10981 |
|
</blockquote><p> |
10982 |
|
|
10983 |
|
</p> |
10984 |
|
<a name="GET SEND_EFFECT_CHAINS"></a><br /><hr /> |
10985 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10986 |
|
<a name="rfc.section.6.11.12"></a><h3>6.11.12. |
10987 |
|
Retrieve amount of send effect chains</h3> |
10988 |
|
|
10989 |
|
<p>The front-end can retrieve the current amount of send |
10990 |
|
effect chains of an audio output device by sending the |
10991 |
|
following command: |
10992 |
|
</p> |
10993 |
|
<p> |
10994 |
|
</p> |
10995 |
|
<blockquote class="text"> |
10996 |
|
<p>GET SEND_EFFECT_CHAINS <audio-device> |
10997 |
|
</p> |
10998 |
|
</blockquote><p> |
10999 |
|
|
11000 |
|
</p> |
11001 |
|
<p>Where <audio-device> should be replaced by the |
11002 |
|
numerical ID of the audio output device as given by the |
11003 |
|
<a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a> |
11004 |
|
or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a> |
11005 |
|
command. |
11006 |
|
</p> |
11007 |
|
<p>Possible Answers: |
11008 |
|
</p> |
11009 |
|
<p> |
11010 |
|
</p> |
11011 |
|
<blockquote class="text"> |
11012 |
|
<p>The sampler will answer by returning the current |
11013 |
|
number of send effect chains of the supplied audio |
11014 |
|
output device. |
11015 |
|
</p> |
11016 |
|
</blockquote><p> |
11017 |
|
|
11018 |
|
</p> |
11019 |
|
<p>Examples: |
11020 |
|
</p> |
11021 |
|
<p> |
11022 |
|
</p> |
11023 |
|
<blockquote class="text"> |
11024 |
|
<p>C: "GET SEND_EFFECT_CHAINS 0" |
11025 |
|
</p> |
11026 |
|
<p>S: "4" |
11027 |
|
</p> |
11028 |
|
</blockquote><p> |
11029 |
|
|
11030 |
|
</p> |
11031 |
|
<a name="LIST SEND_EFFECT_CHAINS"></a><br /><hr /> |
11032 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11033 |
|
<a name="rfc.section.6.11.13"></a><h3>6.11.13. |
11034 |
|
Retrieve list of send effect chains</h3> |
11035 |
|
|
11036 |
|
<p>The front-end can retrieve the current list of send |
11037 |
|
effect chains of an audio output device by sending the |
11038 |
|
following command: |
11039 |
|
</p> |
11040 |
|
<p> |
11041 |
|
</p> |
11042 |
|
<blockquote class="text"> |
11043 |
|
<p>LIST SEND_EFFECT_CHAINS <audio-device> |
11044 |
|
</p> |
11045 |
|
</blockquote><p> |
11046 |
|
|
11047 |
|
</p> |
11048 |
|
<p>Where <audio-device> should be replaced by the |
11049 |
|
numerical ID of the audio output device as given by the |
11050 |
|
<a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a> |
11051 |
|
or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a> |
11052 |
|
command. |
11053 |
|
</p> |
11054 |
|
<p>Possible Answers: |
11055 |
|
</p> |
11056 |
|
<p> |
11057 |
|
</p> |
11058 |
|
<blockquote class="text"> |
11059 |
|
<p>The sampler will answer by returning a comma |
11060 |
|
separated list with numerical IDs of send effect |
11061 |
|
chains of the supplied audio output device. |
11062 |
|
|
11063 |
|
</p> |
11064 |
|
</blockquote><p> |
11065 |
|
|
11066 |
|
</p> |
11067 |
|
<p>Examples: |
11068 |
|
</p> |
11069 |
|
<p> |
11070 |
|
</p> |
11071 |
|
<blockquote class="text"> |
11072 |
|
<p>C: "LIST SEND_EFFECT_CHAINS 0" |
11073 |
|
</p> |
11074 |
|
<p>S: "3,4,7" |
11075 |
|
</p> |
11076 |
|
</blockquote><p> |
11077 |
|
|
11078 |
|
</p> |
11079 |
|
<a name="ADD SEND_EFFECT_CHAIN"></a><br /><hr /> |
11080 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11081 |
|
<a name="rfc.section.6.11.14"></a><h3>6.11.14. |
11082 |
|
Add send effect chain</h3> |
11083 |
|
|
11084 |
|
<p>The front-end can add a send effect chain by sending the |
11085 |
|
following command: |
11086 |
|
</p> |
11087 |
|
<p> |
11088 |
|
</p> |
11089 |
|
<blockquote class="text"> |
11090 |
|
<p>ADD SEND_EFFECT_CHAIN <audio-device> |
11091 |
|
</p> |
11092 |
|
</blockquote><p> |
11093 |
|
|
11094 |
|
</p> |
11095 |
|
<p>Where <audio-device> should be replaced by the |
11096 |
|
numerical ID of the audio output device as given by the |
11097 |
|
<a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a> |
11098 |
|
or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a> |
11099 |
|
command. |
11100 |
|
</p> |
11101 |
|
<p>Possible Answers: |
11102 |
|
</p> |
11103 |
|
<p> |
11104 |
|
</p> |
11105 |
|
<blockquote class="text"> |
11106 |
|
<p>"OK[<effect-chain>]" - |
11107 |
|
</p> |
11108 |
|
<blockquote class="text"> |
11109 |
|
<p>in case the send effect chain was |
11110 |
|
added successfully, where |
11111 |
|
<effect-chain> is the numerical ID |
11112 |
|
of the new send effect chain |
11113 |
|
</p> |
11114 |
|
</blockquote> |
11115 |
|
|
11116 |
|
|
11117 |
|
<p>"ERR:<error-code>:<error-message>" - |
11118 |
|
</p> |
11119 |
|
<blockquote class="text"> |
11120 |
|
<p>if the send effect chain could not be added |
11121 |
|
</p> |
11122 |
|
</blockquote> |
11123 |
|
|
11124 |
|
|
11125 |
|
</blockquote><p> |
11126 |
|
|
11127 |
|
</p> |
11128 |
|
<p>Examples: |
11129 |
|
</p> |
11130 |
|
<p> |
11131 |
|
</p> |
11132 |
|
<blockquote class="text"> |
11133 |
|
<p>C: "ADD SEND_EFFECT_CHAIN 0" |
11134 |
|
</p> |
11135 |
|
<p>S: "OK[2]" |
11136 |
|
</p> |
11137 |
|
</blockquote><p> |
11138 |
|
|
11139 |
|
</p> |
11140 |
|
<a name="REMOVE SEND_EFFECT_CHAIN"></a><br /><hr /> |
11141 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11142 |
|
<a name="rfc.section.6.11.15"></a><h3>6.11.15. |
11143 |
|
Remove send effect chain</h3> |
11144 |
|
|
11145 |
|
<p>The front-end can remove a send effect chain by sending |
11146 |
|
the following command: |
11147 |
|
</p> |
11148 |
|
<p> |
11149 |
|
</p> |
11150 |
|
<blockquote class="text"> |
11151 |
|
<p>REMOVE SEND_EFFECT_CHAIN <audio-device> <effect-chain> |
11152 |
|
</p> |
11153 |
|
</blockquote><p> |
11154 |
|
|
11155 |
|
</p> |
11156 |
|
<p>Where <audio-device> should be replaced by the |
11157 |
|
numerical ID of the audio output device as given by the |
11158 |
|
<a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a> |
11159 |
|
or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a> |
11160 |
|
command and <effect-chain> by the numerical ID as |
11161 |
|
returned by the |
11162 |
|
<a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a> |
11163 |
|
or |
11164 |
|
<a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a> |
11165 |
|
command. |
11166 |
|
</p> |
11167 |
|
<p>Possible Answers: |
11168 |
|
</p> |
11169 |
|
<p> |
11170 |
|
</p> |
11171 |
|
<blockquote class="text"> |
11172 |
|
<p>"OK" - |
11173 |
|
</p> |
11174 |
|
<blockquote class="text"> |
11175 |
|
<p>in case the send effect chain was |
11176 |
|
removed successfully |
11177 |
|
</p> |
11178 |
|
</blockquote> |
11179 |
|
|
11180 |
|
|
11181 |
|
<p>"ERR:<error-code>:<error-message>" - |
11182 |
|
</p> |
11183 |
|
<blockquote class="text"> |
11184 |
|
<p>if the send effect chain could not be removed |
11185 |
|
</p> |
11186 |
|
</blockquote> |
11187 |
|
|
11188 |
|
|
11189 |
|
</blockquote><p> |
11190 |
|
|
11191 |
|
</p> |
11192 |
|
<p>Examples: |
11193 |
|
</p> |
11194 |
|
<p> |
11195 |
|
</p> |
11196 |
|
<blockquote class="text"> |
11197 |
|
<p>C: "REMOVE SEND_EFFECT_CHAIN 0 2" |
11198 |
|
</p> |
11199 |
|
<p>S: "OK" |
11200 |
|
</p> |
11201 |
|
</blockquote><p> |
11202 |
|
|
11203 |
|
</p> |
11204 |
|
<a name="GET SEND_EFFECT_CHAIN INFO"></a><br /><hr /> |
11205 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11206 |
|
<a name="rfc.section.6.11.16"></a><h3>6.11.16. |
11207 |
|
Retrieving information about a send effect chain</h3> |
11208 |
|
|
11209 |
|
<p>The front-end can ask for informations of a send effect |
11210 |
|
chain by sending the following command: |
11211 |
|
</p> |
11212 |
|
<p> |
11213 |
|
</p> |
11214 |
|
<blockquote class="text"> |
11215 |
|
<p>GET SEND_EFFECT_CHAIN INFO <audio-device> <effect-chain> |
11216 |
|
</p> |
11217 |
|
</blockquote><p> |
11218 |
|
|
11219 |
|
</p> |
11220 |
|
<p>Where <audio-device> should be replaced by the |
11221 |
|
numerical ID of the audio output device as given by the |
11222 |
|
<a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a> |
11223 |
|
or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a> |
11224 |
|
command and <effect-chain> by the numerical ID as |
11225 |
|
returned by the |
11226 |
|
<a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a> |
11227 |
|
or |
11228 |
|
<a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a> |
11229 |
|
command. |
11230 |
|
</p> |
11231 |
|
<p>Possible Answers: |
11232 |
|
</p> |
11233 |
|
<p> |
11234 |
|
</p> |
11235 |
|
<blockquote class="text"> |
11236 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
11237 |
|
Each answer line begins with the information |
11238 |
|
category name, followed by a colon and then a space |
11239 |
|
character <SP> and finally the info character |
11240 |
|
string to that information category. |
11241 |
|
At the moment the following categories are defined: |
11242 |
|
</p> |
11243 |
|
<p> |
11244 |
|
</p> |
11245 |
|
<blockquote class="text"> |
11246 |
|
<p>EFFECT_COUNT - |
11247 |
|
</p> |
11248 |
|
<blockquote class="text"> |
11249 |
|
<p>amount of effects in this send |
11250 |
|
effect chain |
11251 |
|
</p> |
11252 |
|
</blockquote> |
11253 |
|
|
11254 |
|
|
11255 |
|
<p>EFFECT_SEQUENCE - |
11256 |
|
</p> |
11257 |
|
<blockquote class="text"> |
11258 |
|
<p>comma separated list of the |
11259 |
|
numerical IDs of the effect |
11260 |
|
instances in this send effect chain, |
11261 |
|
in the order as they are procssed in |
11262 |
|
the effect chain |
11263 |
|
</p> |
11264 |
|
</blockquote> |
11265 |
|
|
11266 |
|
|
11267 |
|
</blockquote> |
11268 |
|
|
11269 |
|
|
11270 |
|
</blockquote><p> |
11271 |
|
|
11272 |
|
</p> |
11273 |
|
<p>The mentioned fields above don't have to be in particular order. |
11274 |
|
</p> |
11275 |
|
<p>Example: |
11276 |
|
</p> |
11277 |
|
<p> |
11278 |
|
</p> |
11279 |
|
<blockquote class="text"> |
11280 |
|
<p>C: "GET SEND_EFFECT_CHAIN INFO 0 2" |
11281 |
|
</p> |
11282 |
|
<p>S: "EFFECT_COUNT: 3" |
11283 |
|
</p> |
11284 |
|
<p> "EFFECT_SEQUENCE: 31,4,7" |
11285 |
|
</p> |
11286 |
|
<p> "." |
11287 |
|
</p> |
11288 |
|
</blockquote><p> |
11289 |
|
|
11290 |
|
</p> |
11291 |
|
<a name="APPEND SEND_EFFECT_CHAIN EFFECT"></a><br /><hr /> |
11292 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11293 |
|
<a name="rfc.section.6.11.17"></a><h3>6.11.17. |
11294 |
|
Append effect instance to a send effect chain</h3> |
11295 |
|
|
11296 |
|
<p>The front-end can add an unused effect instance to the |
11297 |
|
end of a send effect chain by sending the following command: |
11298 |
|
</p> |
11299 |
|
<p> |
11300 |
|
</p> |
11301 |
|
<blockquote class="text"> |
11302 |
|
<p>APPEND SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <effect-instance> |
11303 |
|
</p> |
11304 |
|
</blockquote><p> |
11305 |
|
|
11306 |
|
</p> |
11307 |
|
<p>Where <audio-device> should be replaced by the |
11308 |
|
numerical ID of the audio output device as given by the |
11309 |
|
<a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a> |
11310 |
|
or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a> |
11311 |
|
command and <effect-chain> by the numerical ID as |
11312 |
|
returned by the |
11313 |
|
<a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a> |
11314 |
|
or |
11315 |
|
<a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a> |
11316 |
|
command and <effect-instance> as returned by the |
11317 |
|
<a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> or |
11318 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
11319 |
|
command. |
11320 |
|
</p> |
11321 |
|
<p>Only unused effect instances can be added to the effect |
11322 |
|
chain. Trying to add an effect instance which is already in |
11323 |
|
use somewhere in the audio signal path of the sampler will |
11324 |
|
result in an error. |
11325 |
|
</p> |
11326 |
|
<p>Possible Answers: |
11327 |
|
</p> |
11328 |
|
<p> |
11329 |
|
</p> |
11330 |
|
<blockquote class="text"> |
11331 |
|
<p>"OK" - |
11332 |
|
</p> |
11333 |
|
<blockquote class="text"> |
11334 |
|
<p>in case the effect instance was |
11335 |
|
added successfully to the chain |
11336 |
|
</p> |
11337 |
|
</blockquote> |
11338 |
|
|
11339 |
|
|
11340 |
|
<p>"ERR:<error-code>:<error-message>" - |
11341 |
|
</p> |
11342 |
|
<blockquote class="text"> |
11343 |
|
<p>if the effect instance could not be added |
11344 |
|
</p> |
11345 |
|
</blockquote> |
11346 |
|
|
11347 |
|
|
11348 |
|
</blockquote><p> |
11349 |
|
|
11350 |
|
</p> |
11351 |
|
<p>Examples: |
11352 |
|
</p> |
11353 |
|
<p> |
11354 |
|
</p> |
11355 |
|
<blockquote class="text"> |
11356 |
|
<p>C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38" |
11357 |
|
</p> |
11358 |
|
<p>S: "OK" |
11359 |
|
</p> |
11360 |
|
</blockquote><p> |
11361 |
|
|
11362 |
|
</p> |
11363 |
|
<a name="INSERT SEND_EFFECT_CHAIN EFFECT"></a><br /><hr /> |
11364 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11365 |
|
<a name="rfc.section.6.11.18"></a><h3>6.11.18. |
11366 |
|
Insert effect instance to a send effect chain</h3> |
11367 |
|
|
11368 |
|
<p>The front-end can add an unused effect instance to a |
11369 |
|
certain position of a send effect chain by sending the |
11370 |
|
following command: |
11371 |
|
</p> |
11372 |
|
<p> |
11373 |
|
</p> |
11374 |
|
<blockquote class="text"> |
11375 |
|
<p>INSERT SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos> <effect-instance> |
11376 |
|
</p> |
11377 |
|
</blockquote><p> |
11378 |
|
|
11379 |
|
</p> |
11380 |
|
<p>Where <audio-device> should be replaced by the |
11381 |
|
numerical ID of the audio output device as given by the |
11382 |
|
<a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a> |
11383 |
|
or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a> |
11384 |
|
command, <effect-chain> by the numerical ID as |
11385 |
|
returned by the |
11386 |
|
<a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a> |
11387 |
|
or |
11388 |
|
<a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a> |
11389 |
|
command, <effect-instance> as returned by the |
11390 |
|
<a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> or |
11391 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
11392 |
|
command and <chain-pos> the exact position of the |
11393 |
|
effect chain where the supplied effect shall be inserted |
11394 |
|
to. |
11395 |
|
</p> |
11396 |
|
<p>Only unused effect instances can be added to the effect |
11397 |
|
chain. Trying to add an effect instance which is already in |
11398 |
|
use somewhere in the audio signal path of the sampler will |
11399 |
|
result in an error. |
11400 |
|
</p> |
11401 |
|
<p>Possible Answers: |
11402 |
|
</p> |
11403 |
|
<p> |
11404 |
|
</p> |
11405 |
|
<blockquote class="text"> |
11406 |
|
<p>"OK" - |
11407 |
|
</p> |
11408 |
|
<blockquote class="text"> |
11409 |
|
<p>in case the effect instance was |
11410 |
|
added successfully to the chain |
11411 |
|
</p> |
11412 |
|
</blockquote> |
11413 |
|
|
11414 |
|
|
11415 |
|
<p>"ERR:<error-code>:<error-message>" - |
11416 |
|
</p> |
11417 |
|
<blockquote class="text"> |
11418 |
|
<p>if the effect instance could not be added |
11419 |
|
</p> |
11420 |
|
</blockquote> |
11421 |
|
|
11422 |
|
|
11423 |
|
</blockquote><p> |
11424 |
|
|
11425 |
|
</p> |
11426 |
|
<p>Examples: |
11427 |
|
</p> |
11428 |
|
<p> |
11429 |
|
</p> |
11430 |
|
<blockquote class="text"> |
11431 |
|
<p>C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38" |
11432 |
|
</p> |
11433 |
|
<p>S: "OK" |
11434 |
|
</p> |
11435 |
|
</blockquote><p> |
11436 |
|
|
11437 |
|
</p> |
11438 |
|
<a name="REMOVE SEND_EFFECT_CHAIN EFFECT"></a><br /><hr /> |
11439 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11440 |
|
<a name="rfc.section.6.11.19"></a><h3>6.11.19. |
11441 |
|
Remove effect instance from send effect chain</h3> |
11442 |
|
|
11443 |
|
<p>The front-end can remove an effect instance from a |
11444 |
|
certain position of a send effect chain by sending the |
11445 |
|
following command: |
11446 |
|
</p> |
11447 |
|
<p> |
11448 |
|
</p> |
11449 |
|
<blockquote class="text"> |
11450 |
|
<p>REMOVE SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos> |
11451 |
|
</p> |
11452 |
|
</blockquote><p> |
11453 |
|
|
11454 |
|
</p> |
11455 |
|
<p>Where <audio-device> should be replaced by the |
11456 |
|
numerical ID of the audio output device as given by the |
11457 |
|
<a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a> |
11458 |
|
or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a> |
11459 |
|
command, <effect-chain> by the numerical ID as |
11460 |
|
returned by the |
11461 |
|
<a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a> |
11462 |
|
or |
11463 |
|
<a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a> |
11464 |
|
command and <chain-pos> the exact position of the |
11465 |
|
effect instance to be removed from the effect chain. |
11466 |
|
</p> |
11467 |
|
<p>Possible Answers: |
11468 |
|
</p> |
11469 |
|
<p> |
11470 |
|
</p> |
11471 |
|
<blockquote class="text"> |
11472 |
|
<p>"OK" - |
11473 |
|
</p> |
11474 |
|
<blockquote class="text"> |
11475 |
|
<p>in case the effect instance was |
11476 |
|
removed successfully |
11477 |
|
</p> |
11478 |
|
</blockquote> |
11479 |
|
|
11480 |
|
|
11481 |
|
<p>"ERR:<error-code>:<error-message>" - |
11482 |
|
</p> |
11483 |
|
<blockquote class="text"> |
11484 |
|
<p>if the effect instance could not be removed |
11485 |
|
</p> |
11486 |
|
</blockquote> |
11487 |
|
|
11488 |
|
|
11489 |
|
</blockquote><p> |
11490 |
|
|
11491 |
|
</p> |
11492 |
|
<p>Examples: |
11493 |
|
</p> |
11494 |
|
<p> |
11495 |
|
</p> |
11496 |
|
<blockquote class="text"> |
11497 |
|
<p>C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4" |
11498 |
|
</p> |
11499 |
|
<p>S: "OK" |
11500 |
|
</p> |
11501 |
|
</blockquote><p> |
11502 |
|
|
11503 |
|
</p> |
11504 |
<a name="command_syntax"></a><br /><hr /> |
<a name="command_syntax"></a><br /><hr /> |
11505 |
<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> |
11506 |
<a name="rfc.section.7"></a><h3>7. |
<a name="rfc.section.7"></a><h3>7. |
11616 |
<p>/ COPY SP copy_instruction |
<p>/ COPY SP copy_instruction |
11617 |
|
|
11618 |
</p> |
</p> |
11619 |
|
<p>/ EDIT SP edit_instruction |
11620 |
|
|
11621 |
|
</p> |
11622 |
|
<p>/ FORMAT SP format_instruction |
11623 |
|
|
11624 |
|
</p> |
11625 |
|
<p>/ SEND SP send_instruction |
11626 |
|
|
11627 |
|
</p> |
11628 |
|
<p>/ APPEND SP append_instruction |
11629 |
|
|
11630 |
|
</p> |
11631 |
|
<p>/ INSERT SP insert_instruction |
11632 |
|
|
11633 |
|
</p> |
11634 |
<p>/ RESET |
<p>/ RESET |
11635 |
|
|
11636 |
</p> |
</p> |
11646 |
<p>CHANNEL |
<p>CHANNEL |
11647 |
|
|
11648 |
</p> |
</p> |
11649 |
<p>/ DB_INSTRUMENT_DIRECTORY SP pathname |
<p>/ DB_INSTRUMENT_DIRECTORY SP db_path |
11650 |
|
|
11651 |
|
</p> |
11652 |
|
<p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
11653 |
|
|
11654 |
</p> |
</p> |
11655 |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP pathname SP pathname |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
11656 |
|
|
11657 |
</p> |
</p> |
11658 |
<p>/ DB_INSTRUMENTS SP scan_mode SP pathname SP pathname |
<p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
11659 |
|
|
11660 |
</p> |
</p> |
11661 |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname |
<p>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
11662 |
|
|
11663 |
</p> |
</p> |
11664 |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP instrument_index |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
11665 |
|
|
11666 |
</p> |
</p> |
11667 |
<p>/ DB_INSTRUMENTS SP pathname SP pathname |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index |
11668 |
|
|
11669 |
</p> |
</p> |
11670 |
<p>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index |
<p>/ DB_INSTRUMENTS SP db_path SP filename |
11671 |
|
|
11672 |
|
</p> |
11673 |
|
<p>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index |
11674 |
|
|
11675 |
</p> |
</p> |
11676 |
<p>/ MIDI_INSTRUMENT_MAP |
<p>/ MIDI_INSTRUMENT_MAP |
11679 |
<p>/ MIDI_INSTRUMENT_MAP SP map_name |
<p>/ MIDI_INSTRUMENT_MAP SP map_name |
11680 |
|
|
11681 |
</p> |
</p> |
11682 |
|
<p>/ SEND_EFFECT_CHAIN SP device_index |
11683 |
|
|
11684 |
|
</p> |
11685 |
</blockquote><p> |
</blockquote><p> |
11686 |
|
|
11687 |
</p> |
</p> |
11703 |
<p>/ CHANNEL_COUNT |
<p>/ CHANNEL_COUNT |
11704 |
|
|
11705 |
</p> |
</p> |
11706 |
|
<p>/ CHANNEL_MIDI |
11707 |
|
|
11708 |
|
</p> |
11709 |
|
<p>/ DEVICE_MIDI |
11710 |
|
|
11711 |
|
</p> |
11712 |
<p>/ VOICE_COUNT |
<p>/ VOICE_COUNT |
11713 |
|
|
11714 |
</p> |
</p> |
11757 |
<p>/ MISCELLANEOUS |
<p>/ MISCELLANEOUS |
11758 |
|
|
11759 |
</p> |
</p> |
11760 |
|
<p>/ TOTAL_STREAM_COUNT |
11761 |
|
|
11762 |
|
</p> |
11763 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
11764 |
|
|
11765 |
</p> |
</p> |
11787 |
<p>/ CHANNEL_COUNT |
<p>/ CHANNEL_COUNT |
11788 |
|
|
11789 |
</p> |
</p> |
11790 |
|
<p>/ CHANNEL_MIDI |
11791 |
|
|
11792 |
|
</p> |
11793 |
|
<p>/ DEVICE_MIDI |
11794 |
|
|
11795 |
|
</p> |
11796 |
<p>/ VOICE_COUNT |
<p>/ VOICE_COUNT |
11797 |
|
|
11798 |
</p> |
</p> |
11841 |
<p>/ MISCELLANEOUS |
<p>/ MISCELLANEOUS |
11842 |
|
|
11843 |
</p> |
</p> |
11844 |
|
<p>/ TOTAL_STREAM_COUNT |
11845 |
|
|
11846 |
|
</p> |
11847 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
11848 |
|
|
11849 |
</p> |
</p> |
11892 |
<p>/ MIDI_INSTRUMENT_MAP SP ALL |
<p>/ MIDI_INSTRUMENT_MAP SP ALL |
11893 |
|
|
11894 |
</p> |
</p> |
11895 |
<p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname |
<p>/ SEND_EFFECT_CHAIN SP device_index SP effect_chain |
11896 |
|
|
11897 |
|
</p> |
11898 |
|
<p>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos |
11899 |
|
|
11900 |
|
</p> |
11901 |
|
<p>/ FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id |
11902 |
|
|
11903 |
|
</p> |
11904 |
|
<p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
11905 |
|
|
11906 |
</p> |
</p> |
11907 |
<p>/ DB_INSTRUMENT_DIRECTORY SP pathname |
<p>/ DB_INSTRUMENT_DIRECTORY SP db_path |
11908 |
|
|
11909 |
</p> |
</p> |
11910 |
<p>/ DB_INSTRUMENT SP pathname |
<p>/ DB_INSTRUMENT SP db_path |
11911 |
|
|
11912 |
</p> |
</p> |
11913 |
</blockquote><p> |
</blockquote><p> |
11919 |
<p>AVAILABLE_ENGINES |
<p>AVAILABLE_ENGINES |
11920 |
|
|
11921 |
</p> |
</p> |
11922 |
|
<p>/ AVAILABLE_EFFECTS |
11923 |
|
|
11924 |
|
</p> |
11925 |
|
<p>/ EFFECT_INSTANCES |
11926 |
|
|
11927 |
|
</p> |
11928 |
|
<p>/ EFFECT SP INFO SP effect_index |
11929 |
|
|
11930 |
|
</p> |
11931 |
|
<p>/ EFFECT_INSTANCE SP INFO SP effect_instance |
11932 |
|
|
11933 |
|
</p> |
11934 |
|
<p>/ EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP input_control |
11935 |
|
|
11936 |
|
</p> |
11937 |
|
<p>/ SEND_EFFECT_CHAINS SP device_index |
11938 |
|
|
11939 |
|
</p> |
11940 |
|
<p>/ SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain |
11941 |
|
|
11942 |
|
</p> |
11943 |
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS |
11944 |
|
|
11945 |
</p> |
</p> |
12009 |
<p>/ SERVER SP INFO |
<p>/ SERVER SP INFO |
12010 |
|
|
12011 |
</p> |
</p> |
12012 |
|
<p>/ TOTAL_STREAM_COUNT |
12013 |
|
|
12014 |
|
</p> |
12015 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
12016 |
|
|
12017 |
</p> |
</p> |
12039 |
<p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
<p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
12040 |
|
|
12041 |
</p> |
</p> |
12042 |
<p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname |
<p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
12043 |
|
|
12044 |
</p> |
</p> |
12045 |
<p>/ DB_INSTRUMENT_DIRECTORIES SP pathname |
<p>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
12046 |
|
|
12047 |
</p> |
</p> |
12048 |
<p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname |
<p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path |
12049 |
|
|
12050 |
</p> |
</p> |
12051 |
<p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname |
<p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
12052 |
|
|
12053 |
</p> |
</p> |
12054 |
<p>/ DB_INSTRUMENTS SP pathname |
<p>/ DB_INSTRUMENTS SP db_path |
12055 |
|
|
12056 |
</p> |
</p> |
12057 |
<p>/ DB_INSTRUMENT SP INFO SP pathname |
<p>/ DB_INSTRUMENT SP INFO SP db_path |
12058 |
|
|
12059 |
</p> |
</p> |
12060 |
<p>/ DB_INSTRUMENTS_JOB SP INFO SP number |
<p>/ DB_INSTRUMENTS_JOB SP INFO SP number |
12063 |
<p>/ VOLUME |
<p>/ VOLUME |
12064 |
|
|
12065 |
</p> |
</p> |
12066 |
|
<p>/ VOICES |
12067 |
|
|
12068 |
|
</p> |
12069 |
|
<p>/ STREAMS |
12070 |
|
|
12071 |
|
</p> |
12072 |
|
<p>/ FILE SP INSTRUMENTS SP filename |
12073 |
|
|
12074 |
|
</p> |
12075 |
|
<p>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
12076 |
|
|
12077 |
|
</p> |
12078 |
</blockquote><p> |
</blockquote><p> |
12079 |
|
|
12080 |
</p> |
</p> |
12090 |
<p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
<p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
12091 |
|
|
12092 |
</p> |
</p> |
12093 |
|
<p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE |
12094 |
|
|
12095 |
|
</p> |
12096 |
<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 |
12097 |
|
|
12098 |
</p> |
</p> |
12099 |
|
<p>/ EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP input_control SP control_value |
12100 |
|
|
12101 |
|
</p> |
12102 |
<p>/ CHANNEL SP set_chan_instruction |
<p>/ CHANNEL SP set_chan_instruction |
12103 |
|
|
12104 |
</p> |
</p> |
12117 |
<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 |
12118 |
|
|
12119 |
</p> |
</p> |
12120 |
<p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname |
<p>/ FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos |
12121 |
|
|
12122 |
</p> |
</p> |
12123 |
<p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval |
<p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
12124 |
|
|
12125 |
</p> |
</p> |
12126 |
<p>/ DB_INSTRUMENT SP NAME SP pathname SP dirname |
<p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped |
12127 |
|
|
12128 |
</p> |
</p> |
12129 |
<p>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval |
<p>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped |
12130 |
|
|
12131 |
|
</p> |
12132 |
|
<p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
12133 |
|
|
12134 |
|
</p> |
12135 |
|
<p>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename |
12136 |
|
|
12137 |
</p> |
</p> |
12138 |
<p>/ ECHO SP boolean |
<p>/ ECHO SP boolean |
12141 |
<p>/ VOLUME SP volume_value |
<p>/ VOLUME SP volume_value |
12142 |
|
|
12143 |
</p> |
</p> |
12144 |
|
<p>/ VOICES SP number |
12145 |
|
|
12146 |
|
</p> |
12147 |
|
<p>/ STREAMS SP number |
12148 |
|
|
12149 |
|
</p> |
12150 |
</blockquote><p> |
</blockquote><p> |
12151 |
|
|
12152 |
</p> |
</p> |
12171 |
<p>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
<p>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
12172 |
|
|
12173 |
</p> |
</p> |
12174 |
|
<p>/ EFFECT_INSTANCE SP effect_index |
12175 |
|
|
12176 |
|
</p> |
12177 |
|
<p>/ EFFECT_INSTANCE SP effect_system SP module SP effect_name |
12178 |
|
|
12179 |
|
</p> |
12180 |
</blockquote><p> |
</blockquote><p> |
12181 |
|
|
12182 |
</p> |
</p> |
12204 |
<p>find_instruction = |
<p>find_instruction = |
12205 |
</p> |
</p> |
12206 |
<blockquote class="text"> |
<blockquote class="text"> |
12207 |
<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 |
12208 |
|
|
12209 |
</p> |
</p> |
12210 |
<p>/ DB_INSTRUMENTS SP pathname SP query_val_list |
<p>/ DB_INSTRUMENTS SP db_path SP query_val_list |
12211 |
|
|
12212 |
</p> |
</p> |
12213 |
<p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP query_val_list |
<p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list |
12214 |
|
|
12215 |
</p> |
</p> |
12216 |
<p>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list |
<p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
12217 |
|
|
12218 |
|
</p> |
12219 |
|
<p>/ LOST SP DB_INSTRUMENT_FILES |
12220 |
|
|
12221 |
</p> |
</p> |
12222 |
</blockquote><p> |
</blockquote><p> |
12225 |
<p>move_instruction = |
<p>move_instruction = |
12226 |
</p> |
</p> |
12227 |
<blockquote class="text"> |
<blockquote class="text"> |
12228 |
<p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname |
<p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
12229 |
|
|
12230 |
</p> |
</p> |
12231 |
<p>/ DB_INSTRUMENT SP pathname SP pathname |
<p>/ DB_INSTRUMENT SP db_path SP db_path |
12232 |
|
|
12233 |
</p> |
</p> |
12234 |
</blockquote><p> |
</blockquote><p> |
12237 |
<p>copy_instruction = |
<p>copy_instruction = |
12238 |
</p> |
</p> |
12239 |
<blockquote class="text"> |
<blockquote class="text"> |
12240 |
<p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname |
<p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
12241 |
|
|
12242 |
</p> |
</p> |
12243 |
<p>/ DB_INSTRUMENT SP pathname SP pathname |
<p>/ DB_INSTRUMENT SP db_path SP db_path |
12244 |
|
|
12245 |
</p> |
</p> |
12246 |
</blockquote><p> |
</blockquote><p> |
12258 |
<p>/ FX_SEND SP sampler_channel SP fx_send_id |
<p>/ FX_SEND SP sampler_channel SP fx_send_id |
12259 |
|
|
12260 |
</p> |
</p> |
12261 |
|
<p>/ EFFECT_INSTANCE SP number |
12262 |
|
|
12263 |
|
</p> |
12264 |
</blockquote><p> |
</blockquote><p> |
12265 |
|
|
12266 |
</p> |
</p> |
12276 |
</blockquote><p> |
</blockquote><p> |
12277 |
|
|
12278 |
</p> |
</p> |
12279 |
|
<p>append_instruction = |
12280 |
|
</p> |
12281 |
|
<blockquote class="text"> |
12282 |
|
<p>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP effect_instance |
12283 |
|
|
12284 |
|
</p> |
12285 |
|
</blockquote><p> |
12286 |
|
|
12287 |
|
</p> |
12288 |
|
<p>insert_instruction = |
12289 |
|
</p> |
12290 |
|
<blockquote class="text"> |
12291 |
|
<p>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos SP effect_instance |
12292 |
|
|
12293 |
|
</p> |
12294 |
|
</blockquote><p> |
12295 |
|
|
12296 |
|
</p> |
12297 |
<p>set_chan_instruction = |
<p>set_chan_instruction = |
12298 |
</p> |
</p> |
12299 |
<blockquote class="text"> |
<blockquote class="text"> |
12342 |
</blockquote><p> |
</blockquote><p> |
12343 |
|
|
12344 |
</p> |
</p> |
12345 |
|
<p>edit_instruction = |
12346 |
|
</p> |
12347 |
|
<blockquote class="text"> |
12348 |
|
<p>CHANNEL SP INSTRUMENT SP sampler_channel |
12349 |
|
|
12350 |
|
</p> |
12351 |
|
</blockquote><p> |
12352 |
|
|
12353 |
|
</p> |
12354 |
|
<p>format_instruction = |
12355 |
|
</p> |
12356 |
|
<blockquote class="text"> |
12357 |
|
<p>INSTRUMENTS_DB |
12358 |
|
|
12359 |
|
</p> |
12360 |
|
</blockquote><p> |
12361 |
|
|
12362 |
|
</p> |
12363 |
<p>modal_arg = |
<p>modal_arg = |
12364 |
</p> |
</p> |
12365 |
<blockquote class="text"> |
<blockquote class="text"> |
12411 |
<p>/ AVAILABLE_ENGINES |
<p>/ AVAILABLE_ENGINES |
12412 |
|
|
12413 |
</p> |
</p> |
12414 |
|
<p>/ AVAILABLE_EFFECTS |
12415 |
|
|
12416 |
|
</p> |
12417 |
|
<p>/ EFFECT_INSTANCES |
12418 |
|
|
12419 |
|
</p> |
12420 |
|
<p>/ SEND_EFFECT_CHAINS SP number |
12421 |
|
|
12422 |
|
</p> |
12423 |
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS |
12424 |
|
|
12425 |
</p> |
</p> |
12438 |
<p>/ FX_SENDS SP sampler_channel |
<p>/ FX_SENDS SP sampler_channel |
12439 |
|
|
12440 |
</p> |
</p> |
12441 |
<p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname |
<p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
12442 |
|
|
12443 |
</p> |
</p> |
12444 |
<p>/ DB_INSTRUMENT_DIRECTORIES SP pathname |
<p>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
12445 |
|
|
12446 |
</p> |
</p> |
12447 |
<p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname |
<p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
12448 |
|
|
12449 |
</p> |
</p> |
12450 |
<p>/ DB_INSTRUMENTS SP pathname |
<p>/ DB_INSTRUMENTS SP db_path |
12451 |
|
|
12452 |
|
</p> |
12453 |
|
<p>/ FILE SP INSTRUMENTS SP filename |
12454 |
|
|
12455 |
|
</p> |
12456 |
|
</blockquote><p> |
12457 |
|
|
12458 |
|
</p> |
12459 |
|
<p>send_instruction = |
12460 |
|
</p> |
12461 |
|
<blockquote class="text"> |
12462 |
|
<p>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number |
12463 |
|
|
12464 |
</p> |
</p> |
12465 |
</blockquote><p> |
</blockquote><p> |
12501 |
</blockquote><p> |
</blockquote><p> |
12502 |
|
|
12503 |
</p> |
</p> |
12504 |
|
<p>effect_instance = |
12505 |
|
</p> |
12506 |
|
<blockquote class="text"> |
12507 |
|
<p>number |
12508 |
|
|
12509 |
|
</p> |
12510 |
|
</blockquote><p> |
12511 |
|
|
12512 |
|
</p> |
12513 |
<p>device_index = |
<p>device_index = |
12514 |
</p> |
</p> |
12515 |
<blockquote class="text"> |
<blockquote class="text"> |
12615 |
</blockquote><p> |
</blockquote><p> |
12616 |
|
|
12617 |
</p> |
</p> |
12618 |
|
<p>control_value = |
12619 |
|
</p> |
12620 |
|
<blockquote class="text"> |
12621 |
|
<p>real |
12622 |
|
|
12623 |
|
</p> |
12624 |
|
</blockquote><p> |
12625 |
|
|
12626 |
|
</p> |
12627 |
<p>sampler_channel = |
<p>sampler_channel = |
12628 |
</p> |
</p> |
12629 |
<blockquote class="text"> |
<blockquote class="text"> |
12660 |
</blockquote><p> |
</blockquote><p> |
12661 |
|
|
12662 |
</p> |
</p> |
12663 |
<p>pathname = |
<p>filename = |
12664 |
</p> |
</p> |
12665 |
<blockquote class="text"> |
<blockquote class="text"> |
12666 |
<p>stringval |
<p>path |
12667 |
|
|
12668 |
</p> |
</p> |
12669 |
</blockquote><p> |
</blockquote><p> |
12670 |
|
|
12671 |
</p> |
</p> |
12672 |
<p>dirname = |
<p>db_path = |
12673 |
</p> |
</p> |
12674 |
<blockquote class="text"> |
<blockquote class="text"> |
12675 |
<p>stringval |
<p>path |
12676 |
|
|
12677 |
</p> |
</p> |
12678 |
</blockquote><p> |
</blockquote><p> |
12679 |
|
|
12680 |
</p> |
</p> |
12681 |
<p>filename = |
<p>map_name = |
12682 |
</p> |
</p> |
12683 |
<blockquote class="text"> |
<blockquote class="text"> |
12684 |
<p>stringval |
<p>stringval_escaped |
12685 |
|
|
12686 |
</p> |
</p> |
12687 |
</blockquote><p> |
</blockquote><p> |
12688 |
|
|
12689 |
</p> |
</p> |
12690 |
<p>map_name = |
<p>entry_name = |
12691 |
</p> |
</p> |
12692 |
<blockquote class="text"> |
<blockquote class="text"> |
12693 |
<p>stringval |
<p>stringval_escaped |
12694 |
|
|
12695 |
</p> |
</p> |
12696 |
</blockquote><p> |
</blockquote><p> |
12697 |
|
|
12698 |
</p> |
</p> |
12699 |
<p>entry_name = |
<p>fx_send_name = |
12700 |
</p> |
</p> |
12701 |
<blockquote class="text"> |
<blockquote class="text"> |
12702 |
<p>stringval |
<p>stringval_escaped |
12703 |
|
|
12704 |
</p> |
</p> |
12705 |
</blockquote><p> |
</blockquote><p> |
12706 |
|
|
12707 |
</p> |
</p> |
12708 |
<p>fx_send_name = |
<p>effect_name = |
12709 |
|
</p> |
12710 |
|
<blockquote class="text"> |
12711 |
|
<p>stringval_escaped |
12712 |
|
|
12713 |
|
</p> |
12714 |
|
</blockquote><p> |
12715 |
|
|
12716 |
|
</p> |
12717 |
|
<p>effect_index = |
12718 |
|
</p> |
12719 |
|
<blockquote class="text"> |
12720 |
|
<p>number |
12721 |
|
|
12722 |
|
</p> |
12723 |
|
</blockquote><p> |
12724 |
|
|
12725 |
|
</p> |
12726 |
|
<p>effect_chain = |
12727 |
|
</p> |
12728 |
|
<blockquote class="text"> |
12729 |
|
<p>number |
12730 |
|
|
12731 |
|
</p> |
12732 |
|
</blockquote><p> |
12733 |
|
|
12734 |
|
</p> |
12735 |
|
<p>chain_pos = |
12736 |
|
</p> |
12737 |
|
<blockquote class="text"> |
12738 |
|
<p>number |
12739 |
|
|
12740 |
|
</p> |
12741 |
|
</blockquote><p> |
12742 |
|
|
12743 |
|
</p> |
12744 |
|
<p>input_control = |
12745 |
</p> |
</p> |
12746 |
<blockquote class="text"> |
<blockquote class="text"> |
12747 |
<p>stringval |
<p>number |
12748 |
|
|
12749 |
</p> |
</p> |
12750 |
</blockquote><p> |
</blockquote><p> |
12795 |
<p>query_val = |
<p>query_val = |
12796 |
</p> |
</p> |
12797 |
<blockquote class="text"> |
<blockquote class="text"> |
12798 |
<p>string |
<p>text_escaped |
12799 |
|
|
12800 |
</p> |
</p> |
12801 |
<p>/ stringval |
<p>/ stringval_escaped |
12802 |
|
|
12803 |
</p> |
</p> |
12804 |
</blockquote><p> |
</blockquote><p> |
12819 |
</blockquote><p> |
</blockquote><p> |
12820 |
|
|
12821 |
</p> |
</p> |
12822 |
|
<p>effect_system = |
12823 |
|
</p> |
12824 |
|
<blockquote class="text"> |
12825 |
|
<p>string |
12826 |
|
|
12827 |
|
</p> |
12828 |
|
</blockquote><p> |
12829 |
|
|
12830 |
|
</p> |
12831 |
|
<p>module = |
12832 |
|
</p> |
12833 |
|
<blockquote class="text"> |
12834 |
|
<p>filename |
12835 |
|
|
12836 |
|
</p> |
12837 |
|
</blockquote><p> |
12838 |
|
|
12839 |
|
</p> |
12840 |
|
<a name="character_set"></a><br /><hr /> |
12841 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
12842 |
|
<a name="rfc.section.7.1"></a><h3>7.1. |
12843 |
|
Character Set and Escape Sequences</h3> |
12844 |
|
|
12845 |
|
<p>Older versions of this protocol up to and including v1.1 only |
12846 |
|
supported the standard ASCII character set (ASCII code 0 - 127) |
12847 |
|
<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 |
12848 |
|
however support the Extended ASCII character set (ASCII code |
12849 |
|
0 - 255). The same group of younger protocols also support |
12850 |
|
escape sequences, but only for certain, explicitly declared |
12851 |
|
parts of the protocol. The supported escape sequences are |
12852 |
|
defined as follows: |
12853 |
|
</p><table class="full" align="center" border="0" cellpadding="2" cellspacing="2"> |
12854 |
|
<col align="left"><col align="left"> |
12855 |
|
<tr><th align="left">ASCII Character Sequence</th><th align="left">Translated into (Name)</th></tr> |
12856 |
|
<tr> |
12857 |
|
<td align="left">\n</td> |
12858 |
|
<td align="left">new line</td> |
12859 |
|
</tr> |
12860 |
|
<tr> |
12861 |
|
<td align="left">\r</td> |
12862 |
|
<td align="left">carriage return</td> |
12863 |
|
</tr> |
12864 |
|
<tr> |
12865 |
|
<td align="left">\f</td> |
12866 |
|
<td align="left">form feed</td> |
12867 |
|
</tr> |
12868 |
|
<tr> |
12869 |
|
<td align="left">\t</td> |
12870 |
|
<td align="left">horizontal tab</td> |
12871 |
|
</tr> |
12872 |
|
<tr> |
12873 |
|
<td align="left">\v</td> |
12874 |
|
<td align="left">vertical tab</td> |
12875 |
|
</tr> |
12876 |
|
<tr> |
12877 |
|
<td align="left">\'</td> |
12878 |
|
<td align="left">apostrophe</td> |
12879 |
|
</tr> |
12880 |
|
<tr> |
12881 |
|
<td align="left">\"</td> |
12882 |
|
<td align="left">quotation mark</td> |
12883 |
|
</tr> |
12884 |
|
<tr> |
12885 |
|
<td align="left">\\</td> |
12886 |
|
<td align="left">backslash</td> |
12887 |
|
</tr> |
12888 |
|
<tr> |
12889 |
|
<td align="left">\OOO</td> |
12890 |
|
<td align="left">three digit octal ASCII code of the character</td> |
12891 |
|
</tr> |
12892 |
|
<tr> |
12893 |
|
<td align="left">\xHH</td> |
12894 |
|
<td align="left">two digit hex ASCII code of the character</td> |
12895 |
|
</tr> |
12896 |
|
</table> |
12897 |
|
<br clear="all" /> |
12898 |
|
|
12899 |
|
<p>Notice: due to the transition of certain parts of the |
12900 |
|
protocol which now support escape sequences, a slight backward |
12901 |
|
incompatibility to protocols version v1.1 and younger has been |
12902 |
|
introduced. The only difference is that in parts of the protocol |
12903 |
|
where escape characters are now supported, a backslash characters |
12904 |
|
MUST be escaped as well (that is as double backslash), whereas |
12905 |
|
in the old versions a single backslash was sufficient. |
12906 |
|
</p> |
12907 |
|
<p>The following LSCP commands support escape sequences as part |
12908 |
|
of their filename / path based arguments and / or may contain |
12909 |
|
a filename / path with escape sequences in their response: |
12910 |
|
</p> |
12911 |
|
<blockquote class="text"> |
12912 |
|
<p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a> |
12913 |
|
</p> |
12914 |
|
<p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a> |
12915 |
|
</p> |
12916 |
|
<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> |
12917 |
|
</p> |
12918 |
|
<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> |
12919 |
|
</p> |
12920 |
|
<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> |
12921 |
|
</p> |
12922 |
|
<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> |
12923 |
|
</p> |
12924 |
|
<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> |
12925 |
|
</p> |
12926 |
|
<p><a class='info' href='#REMOVE DB_INSTRUMENT'>"REMOVE DB_INSTRUMENT"<span> (</span><span class='info'>Removing an instrument</span><span>)</span></a> |
12927 |
|
</p> |
12928 |
|
<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> |
12929 |
|
</p> |
12930 |
|
<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> |
12931 |
|
</p> |
12932 |
|
<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> |
12933 |
|
</p> |
12934 |
|
<p><a class='info' href='#GET DB_INSTRUMENTS'>"GET DB_INSTRUMENTS"<span> (</span><span class='info'>Getting amount of instruments</span><span>)</span></a> |
12935 |
|
</p> |
12936 |
|
<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> |
12937 |
|
</p> |
12938 |
|
<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> |
12939 |
|
</p> |
12940 |
|
<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> |
12941 |
|
</p> |
12942 |
|
<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> |
12943 |
|
</p> |
12944 |
|
<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> |
12945 |
|
</p> |
12946 |
|
<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> |
12947 |
|
</p> |
12948 |
|
<p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a> |
12949 |
|
</p> |
12950 |
|
<p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a> |
12951 |
|
</p> |
12952 |
|
<p><a class='info' href='#MOVE DB_INSTRUMENT'>"MOVE DB_INSTRUMENT"<span> (</span><span class='info'>Moving an instrument</span><span>)</span></a> |
12953 |
|
</p> |
12954 |
|
<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> |
12955 |
|
</p> |
12956 |
|
<p><a class='info' href='#COPY DB_INSTRUMENT'>"COPY DB_INSTRUMENT"<span> (</span><span class='info'>Copying instruments</span><span>)</span></a> |
12957 |
|
</p> |
12958 |
|
<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> |
12959 |
|
</p> |
12960 |
|
<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> |
12961 |
|
</p> |
12962 |
|
<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> |
12963 |
|
</p> |
12964 |
|
<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> |
12965 |
|
</p> |
12966 |
|
<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> |
12967 |
|
</p> |
12968 |
|
<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> |
12969 |
|
</p> |
12970 |
|
<p><a class='info' href='#GET EFFECT INFO'>"GET EFFECT INFO"<span> (</span><span class='info'>Retrieving general information about an effect</span><span>)</span></a> |
12971 |
|
</p> |
12972 |
|
<p><a class='info' href='#GET EFFECT_INSTANCE INFO'>"GET EFFECT_INSTANCE INFO"<span> (</span><span class='info'>Retrieving current information about an effect instance</span><span>)</span></a> |
12973 |
|
</p> |
12974 |
|
<p><a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> |
12975 |
|
</p> |
12976 |
|
</blockquote><p> |
12977 |
|
Note that the forward slash character ('/') has a special meaning in |
12978 |
|
filename / path based arguments: it acts as separator of the nodes in |
12979 |
|
the path, thus if a directory- or filename includes a forward slash |
12980 |
|
(not intended as path node separator), you MUST escape that slash |
12981 |
|
either with the respective hex escape sequence ("\x2f") or with the |
12982 |
|
respective octal escape sequence ("\057"). |
12983 |
|
|
12984 |
|
</p> |
12985 |
|
<p> |
12986 |
|
Note for Windows: file path arguments in LSCP are expected |
12987 |
|
to use forward slashes as directory node separator similar |
12988 |
|
to Unix based operating systems. In contrast to Unix however |
12989 |
|
a Windows typical drive character is expected to be |
12990 |
|
prefixed to the path. That is an original Windows file path |
12991 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
12992 |
|
"D:/Sounds/My.gig". |
12993 |
|
|
12994 |
|
</p> |
12995 |
|
<p> |
12996 |
|
The following LSCP commands even support escape sequences as |
12997 |
|
part of at least one of their text-based arguments (i.e. entity name, |
12998 |
|
description) and / or may contain escape sequences in at least one of |
12999 |
|
their text-based fields in their response: |
13000 |
|
</p> |
13001 |
|
<blockquote class="text"> |
13002 |
|
<p><a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a> |
13003 |
|
</p> |
13004 |
|
<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> |
13005 |
|
</p> |
13006 |
|
<p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a> |
13007 |
|
</p> |
13008 |
|
<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> |
13009 |
|
</p> |
13010 |
|
<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> |
13011 |
|
</p> |
13012 |
|
<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> |
13013 |
|
</p> |
13014 |
|
<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> |
13015 |
|
</p> |
13016 |
|
<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> |
13017 |
|
</p> |
13018 |
|
<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> |
13019 |
|
</p> |
13020 |
|
<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> |
13021 |
|
</p> |
13022 |
|
<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> |
13023 |
|
</p> |
13024 |
|
<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> |
13025 |
|
</p> |
13026 |
|
<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> |
13027 |
|
</p> |
13028 |
|
<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> |
13029 |
|
</p> |
13030 |
|
<p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a> |
13031 |
|
</p> |
13032 |
|
<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> |
13033 |
|
</p> |
13034 |
|
<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> |
13035 |
|
</p> |
13036 |
|
<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> |
13037 |
|
</p> |
13038 |
|
<p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a> |
13039 |
|
</p> |
13040 |
|
<p><a class='info' href='#GET EFFECT INFO'>"GET EFFECT INFO"<span> (</span><span class='info'>Retrieving general information about an effect</span><span>)</span></a> |
13041 |
|
</p> |
13042 |
|
<p><a class='info' href='#GET EFFECT_INSTANCE INFO'>"GET EFFECT_INSTANCE INFO"<span> (</span><span class='info'>Retrieving current information about an effect instance</span><span>)</span></a> |
13043 |
|
</p> |
13044 |
|
<p><a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> |
13045 |
|
</p> |
13046 |
|
</blockquote><p> |
13047 |
|
Please note that these lists are manually maintained. If you |
13048 |
|
find a command that also supports escape sequences we forgot to |
13049 |
|
mention here, please report it! |
13050 |
|
|
13051 |
|
</p> |
13052 |
<a name="events"></a><br /><hr /> |
<a name="events"></a><br /><hr /> |
13053 |
<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> |
13054 |
<a name="rfc.section.8"></a><h3>8. |
<a name="rfc.section.8"></a><h3>8. |
13209 |
<p>where <channels> will be replaced by the new number |
<p>where <channels> will be replaced by the new number |
13210 |
of sampler channels. |
of sampler channels. |
13211 |
</p> |
</p> |
13212 |
<a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE CHANNEL_MIDI"></a><br /><hr /> |
13213 |
<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> |
13214 |
<a name="rfc.section.8.6"></a><h3>8.6. |
<a name="rfc.section.8.6"></a><h3>8.6. |
13215 |
|
MIDI data on a sampler channel arrived</h3> |
13216 |
|
|
13217 |
|
<p>Client may want to be notified when MIDI data arrive on sampler channels on |
13218 |
|
back-end side, by issuing the following command: |
13219 |
|
</p> |
13220 |
|
<p> |
13221 |
|
</p> |
13222 |
|
<blockquote class="text"> |
13223 |
|
<p>SUBSCRIBE CHANNEL_MIDI |
13224 |
|
</p> |
13225 |
|
</blockquote><p> |
13226 |
|
|
13227 |
|
</p> |
13228 |
|
<p>Server will start sending one of the the following notification messages: |
13229 |
|
</p> |
13230 |
|
<p> |
13231 |
|
</p> |
13232 |
|
<blockquote class="text"> |
13233 |
|
<p>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>" |
13234 |
|
</p> |
13235 |
|
<p>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>" |
13236 |
|
</p> |
13237 |
|
</blockquote><p> |
13238 |
|
|
13239 |
|
</p> |
13240 |
|
<p>where <channel-id> will be replaced by the ID of the sampler channel where the MIDI |
13241 |
|
data arrived. <note> and <velocity> are integer values in the range between |
13242 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
13243 |
|
|
13244 |
|
</p> |
13245 |
|
<p>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
13246 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
13247 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
13248 |
|
thread unaffected by this feature. |
13249 |
|
</p> |
13250 |
|
<a name="SUBSCRIBE DEVICE_MIDI"></a><br /><hr /> |
13251 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
13252 |
|
<a name="rfc.section.8.7"></a><h3>8.7. |
13253 |
|
MIDI data on a MIDI input device arrived</h3> |
13254 |
|
|
13255 |
|
<p>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command: |
13256 |
|
</p> |
13257 |
|
<p> |
13258 |
|
</p> |
13259 |
|
<blockquote class="text"> |
13260 |
|
<p>SUBSCRIBE DEVICE_MIDI |
13261 |
|
</p> |
13262 |
|
</blockquote><p> |
13263 |
|
|
13264 |
|
</p> |
13265 |
|
<p>Server will start sending one of the the following notification messages: |
13266 |
|
</p> |
13267 |
|
<p> |
13268 |
|
</p> |
13269 |
|
<blockquote class="text"> |
13270 |
|
<p>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note> <velocity>" |
13271 |
|
</p> |
13272 |
|
<p>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note> <velocity>" |
13273 |
|
</p> |
13274 |
|
</blockquote><p> |
13275 |
|
|
13276 |
|
</p> |
13277 |
|
<p>where <device-id> <port-id> will be replaced |
13278 |
|
by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI |
13279 |
|
data arrived. <note> and <velocity> are integer values in the range between |
13280 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
13281 |
|
|
13282 |
|
</p> |
13283 |
|
<p>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
13284 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
13285 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
13286 |
|
thread unaffected by this feature. |
13287 |
|
</p> |
13288 |
|
<a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr /> |
13289 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
13290 |
|
<a name="rfc.section.8.8"></a><h3>8.8. |
13291 |
Number of active voices changed</h3> |
Number of active voices changed</h3> |
13292 |
|
|
13293 |
<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 |
13317 |
</p> |
</p> |
13318 |
<a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr /> |
13319 |
<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> |
13320 |
<a name="rfc.section.8.7"></a><h3>8.7. |
<a name="rfc.section.8.9"></a><h3>8.9. |
13321 |
Number of active disk streams changed</h3> |
Number of active disk streams changed</h3> |
13322 |
|
|
13323 |
<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 |
13347 |
</p> |
</p> |
13348 |
<a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr /> |
<a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr /> |
13349 |
<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> |
13350 |
<a name="rfc.section.8.8"></a><h3>8.8. |
<a name="rfc.section.8.10"></a><h3>8.10. |
13351 |
Disk stream buffer fill state changed</h3> |
Disk stream buffer fill state changed</h3> |
13352 |
|
|
13353 |
<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 |
13378 |
</p> |
</p> |
13379 |
<a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr /> |
13380 |
<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> |
13381 |
<a name="rfc.section.8.9"></a><h3>8.9. |
<a name="rfc.section.8.11"></a><h3>8.11. |
13382 |
Channel information changed</h3> |
Channel information changed</h3> |
13383 |
|
|
13384 |
<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 |
13411 |
</p> |
</p> |
13412 |
<a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr /> |
13413 |
<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> |
13414 |
<a name="rfc.section.8.10"></a><h3>8.10. |
<a name="rfc.section.8.12"></a><h3>8.12. |
13415 |
Number of effect sends changed</h3> |
Number of effect sends changed</h3> |
13416 |
|
|
13417 |
<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 |
13418 |
a particular sampler channel is changed by issuing the following command: |
a particular sampler channel is changed by issuing the following command: |
13419 |
</p> |
</p> |
13420 |
<p> |
<p> |
13441 |
</p> |
</p> |
13442 |
<a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr /> |
13443 |
<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> |
13444 |
<a name="rfc.section.8.11"></a><h3>8.11. |
<a name="rfc.section.8.13"></a><h3>8.13. |
13445 |
Effect send information changed</h3> |
Effect send information changed</h3> |
13446 |
|
|
13447 |
<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 |
13471 |
</p> |
</p> |
13472 |
<a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr /> |
13473 |
<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> |
13474 |
<a name="rfc.section.8.12"></a><h3>8.12. |
<a name="rfc.section.8.14"></a><h3>8.14. |
13475 |
Total number of active voices changed</h3> |
Total number of active voices changed</h3> |
13476 |
|
|
13477 |
<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 |
13498 |
<p>where <voices> will be replaced by the new number of |
<p>where <voices> will be replaced by the new number of |
13499 |
all currently active voices. |
all currently active voices. |
13500 |
</p> |
</p> |
13501 |
|
<a name="SUBSCRIBE TOTAL_STREAM_COUNT"></a><br /><hr /> |
13502 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
13503 |
|
<a name="rfc.section.8.15"></a><h3>8.15. |
13504 |
|
Total number of active disk streams changed</h3> |
13505 |
|
|
13506 |
|
<p>Client may want to be notified when the total number of disk streams on the |
13507 |
|
back-end changes by issuing the following command: |
13508 |
|
</p> |
13509 |
|
<p> |
13510 |
|
</p> |
13511 |
|
<blockquote class="text"> |
13512 |
|
<p>SUBSCRIBE TOTAL_STREAM_COUNT |
13513 |
|
</p> |
13514 |
|
</blockquote><p> |
13515 |
|
|
13516 |
|
</p> |
13517 |
|
<p>Server will start sending the following notification messages: |
13518 |
|
</p> |
13519 |
|
<p> |
13520 |
|
</p> |
13521 |
|
<blockquote class="text"> |
13522 |
|
<p>"NOTIFY:TOTAL_STREAM_COUNT:<streams>" |
13523 |
|
</p> |
13524 |
|
</blockquote><p> |
13525 |
|
|
13526 |
|
</p> |
13527 |
|
<p>where <streams> will be replaced by the new number of |
13528 |
|
all currently active disk streams. |
13529 |
|
</p> |
13530 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr /> |
13531 |
<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> |
13532 |
<a name="rfc.section.8.13"></a><h3>8.13. |
<a name="rfc.section.8.16"></a><h3>8.16. |
13533 |
Number of MIDI instrument maps changed</h3> |
Number of MIDI instrument maps changed</h3> |
13534 |
|
|
13535 |
<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 |
13558 |
</p> |
</p> |
13559 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr /> |
13560 |
<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> |
13561 |
<a name="rfc.section.8.14"></a><h3>8.14. |
<a name="rfc.section.8.17"></a><h3>8.17. |
13562 |
MIDI instrument map information changed</h3> |
MIDI instrument map information changed</h3> |
13563 |
|
|
13564 |
<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 |
13591 |
</p> |
</p> |
13592 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr /> |
13593 |
<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> |
13594 |
<a name="rfc.section.8.15"></a><h3>8.15. |
<a name="rfc.section.8.18"></a><h3>8.18. |
13595 |
Number of MIDI instruments changed</h3> |
Number of MIDI instruments changed</h3> |
13596 |
|
|
13597 |
<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 |
13621 |
</p> |
</p> |
13622 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr /> |
13623 |
<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> |
13624 |
<a name="rfc.section.8.16"></a><h3>8.16. |
<a name="rfc.section.8.19"></a><h3>8.19. |
13625 |
MIDI instrument information changed</h3> |
MIDI instrument information changed</h3> |
13626 |
|
|
13627 |
<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 |
13655 |
</p> |
</p> |
13656 |
<a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr /> |
13657 |
<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> |
13658 |
<a name="rfc.section.8.17"></a><h3>8.17. |
<a name="rfc.section.8.20"></a><h3>8.20. |
13659 |
Global settings changed</h3> |
Global settings changed</h3> |
13660 |
|
|
13661 |
<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 |
13680 |
new global volume parameter. |
new global volume parameter. |
13681 |
</p> |
</p> |
13682 |
</blockquote><p> |
</blockquote><p> |
13683 |
|
</p> |
13684 |
|
<blockquote class="text"> |
13685 |
|
<p>"NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the |
13686 |
|
golbal limit of the sampler for maximum voices is changed, where |
13687 |
|
<max-voices> will be an integer value, reflecting the |
13688 |
|
new global voice limit parameter. |
13689 |
|
</p> |
13690 |
|
</blockquote><p> |
13691 |
|
</p> |
13692 |
|
<blockquote class="text"> |
13693 |
|
<p>"NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the |
13694 |
|
golbal limit of the sampler for maximum disk streams is changed, where |
13695 |
|
<max-streams> will be an integer value, reflecting the |
13696 |
|
new global disk streams limit parameter. |
13697 |
|
</p> |
13698 |
|
</blockquote><p> |
13699 |
|
|
13700 |
</p> |
</p> |
13701 |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
13702 |
<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> |
13703 |
<a name="rfc.section.8.18"></a><h3>8.18. |
<a name="rfc.section.8.21"></a><h3>8.21. |
13704 |
Number of database instrument directories changed</h3> |
Number of database instrument directories changed</h3> |
13705 |
|
|
13706 |
<p>Client may want to be notified when the number of instrument |
<p>Client may want to be notified when the number of instrument |
13734 |
</p> |
</p> |
13735 |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr /> |
13736 |
<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> |
13737 |
<a name="rfc.section.8.19"></a><h3>8.19. |
<a name="rfc.section.8.22"></a><h3>8.22. |
13738 |
Database instrument directory information changed</h3> |
Database instrument directory information changed</h3> |
13739 |
|
|
13740 |
<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 |
13779 |
</p> |
</p> |
13780 |
<a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr /> |
13781 |
<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> |
13782 |
<a name="rfc.section.8.20"></a><h3>8.20. |
<a name="rfc.section.8.23"></a><h3>8.23. |
13783 |
Number of database instruments changed</h3> |
Number of database instruments changed</h3> |
13784 |
|
|
13785 |
<p>Client may want to be notified when the number of instruments |
<p>Client may want to be notified when the number of instruments |
13813 |
</p> |
</p> |
13814 |
<a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr /> |
13815 |
<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> |
13816 |
<a name="rfc.section.8.21"></a><h3>8.21. |
<a name="rfc.section.8.24"></a><h3>8.24. |
13817 |
Database instrument information changed</h3> |
Database instrument information changed</h3> |
13818 |
|
|
13819 |
<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 |
13858 |
</p> |
</p> |
13859 |
<a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr /> |
13860 |
<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> |
13861 |
<a name="rfc.section.8.22"></a><h3>8.22. |
<a name="rfc.section.8.25"></a><h3>8.25. |
13862 |
Database job status information changed</h3> |
Database job status information changed</h3> |
13863 |
|
|
13864 |
<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 |
13891 |
</p> |
</p> |
13892 |
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr /> |
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr /> |
13893 |
<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> |
13894 |
<a name="rfc.section.8.23"></a><h3>8.23. |
<a name="rfc.section.8.26"></a><h3>8.26. |
13895 |
Miscellaneous and debugging events</h3> |
Miscellaneous and debugging events</h3> |
13896 |
|
|
13897 |
<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 |
13956 |
<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> |
13957 |
<h3>11. References</h3> |
<h3>11. References</h3> |
13958 |
<table width="99%" border="0"> |
<table width="99%" border="0"> |
13959 |
|
<tr><td class="author-text" valign="top"><a name="RFC20">[RFC20]</a></td> |
13960 |
|
<td class="author-text">UCLA, “<a href="http://tools.ietf.org/html/rfc20">ASCII format for Network Interchange</a>,” RFC 20, 1969.</td></tr> |
13961 |
<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> |
13962 |
<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="http://tools.ietf.org/html/rfc2119">Key words for use in RFCs to Indicate Requirement Levels</a>,” RFC 2119, 1997.</td></tr> |
13963 |
<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> |
13964 |
<td class="author-text">Crocker, D. and P. Overell, “<a href="ftp://ftp.isi.edu/in-notes/rfc2234.txt">Augmented BNF for Syntax Specifications</a>,” RFC 2234, 1997.</td></tr> |
<td class="author-text">Crocker, D. and P. Overell, “<a href="http://tools.ietf.org/html/rfc2234">Augmented BNF for Syntax Specifications</a>,” RFC 2234, 1997.</td></tr> |
13965 |
<tr><td class="author-text" valign="top"><a name="RFC793">[RFC793]</a></td> |
<tr><td class="author-text" valign="top"><a name="RFC793">[RFC793]</a></td> |
13966 |
<td class="author-text">Defense Advanced Research Projects Agency, “<a href="ftp://ftp.isi.edu/in-notes/rfc793.txt">TRANSMISSION CONTROL PROTOCOL</a>,” RFC 793, 1981.</td></tr> |
<td class="author-text">Defense Advanced Research Projects Agency, “<a href="http://tools.ietf.org/html/rfc793">TRANSMISSION CONTROL PROTOCOL</a>,” RFC 793, 1981.</td></tr> |
13967 |
</table> |
</table> |
13968 |
|
|
13969 |
<a name="rfc.authors"></a><br /><hr /> |
<a name="rfc.authors"></a><br /><hr /> |
13988 |
<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> |
13989 |
<h3>Full Copyright Statement</h3> |
<h3>Full Copyright Statement</h3> |
13990 |
<p class='copyright'> |
<p class='copyright'> |
13991 |
Copyright © The IETF Trust (2007).</p> |
Copyright © The IETF Trust (2010).</p> |
13992 |
<p class='copyright'> |
<p class='copyright'> |
13993 |
This document is subject to the rights, |
This document is subject to the rights, |
13994 |
licenses and restrictions contained in BCP 78, |
licenses and restrictions contained in BCP 78, |
14030 |
proprietary rights that may cover technology that may be required |
proprietary rights that may cover technology that may be required |
14031 |
to implement this standard. |
to implement this standard. |
14032 |
Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p> |
Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p> |
|
<h3>Acknowledgment</h3> |
|
|
<p class='copyright'> |
|
|
Funding for the RFC Editor function is provided by |
|
|
the IETF Administrative Support Activity (IASA).</p> |
|
14033 |
</body></html> |
</body></html> |