1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
2 |
<html lang="en"><head><title>LinuxSampler Control Protocol (draft)</title> |
<html lang="en"><head><title>LinuxSampler Control Protocol</title> |
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 (draft)"> |
<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.34 (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: March 4, 2008</td><td class="header">September 2007</td></tr> |
<tr><td class="header">Expires: December 26, 2011</td><td class="header">June 24, 2011</td></tr> |
149 |
</table></td></tr></table> |
</table></td></tr></table> |
150 |
<h1><br />LinuxSampler Control Protocol (draft)<br />LSCP 1.2cvs</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, |
182 |
The list of Internet-Draft Shadow Directories can be accessed at |
The list of Internet-Draft Shadow Directories can be accessed at |
183 |
<a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p> |
<a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p> |
184 |
<p> |
<p> |
185 |
This Internet-Draft will expire on March 4, 2008.</p> |
This Internet-Draft will expire on December 26, 2011.</p> |
186 |
|
<a name="toc"></a><br /><hr /> |
|
<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 /> |
|
187 |
<h3>Table of Contents</h3> |
<h3>Table of Contents</h3> |
188 |
<p class="toc"> |
<p class="toc"> |
189 |
<a href="#anchor1">1.</a> |
<a href="#anchor1">1.</a> |
328 |
Changing effect send's name<br /> |
Changing effect send's name<br /> |
329 |
<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a> |
<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a> |
330 |
Altering effect send's audio routing<br /> |
Altering effect send's audio routing<br /> |
331 |
<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.32.</a> |
<a href="#SET FX_SEND EFFECT">6.4.32.</a> |
332 |
|
Assigning destination effect to an effect send<br /> |
333 |
|
<a href="#REMOVE FX_SEND EFFECT">6.4.33.</a> |
334 |
|
Removing destination effect from an effect send<br /> |
335 |
|
<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.34.</a> |
336 |
Altering effect send's MIDI controller<br /> |
Altering effect send's MIDI controller<br /> |
337 |
<a href="#SET FX_SEND LEVEL">6.4.33.</a> |
<a href="#SET FX_SEND LEVEL">6.4.35.</a> |
338 |
Altering effect send's send level<br /> |
Altering effect send's send level<br /> |
339 |
<a href="#RESET CHANNEL">6.4.34.</a> |
<a href="#SEND CHANNEL MIDI_DATA">6.4.36.</a> |
340 |
|
Sending MIDI messages to sampler channel<br /> |
341 |
|
<a href="#RESET CHANNEL">6.4.37.</a> |
342 |
Resetting a sampler channel<br /> |
Resetting a sampler channel<br /> |
343 |
<a href="#anchor12">6.5.</a> |
<a href="#anchor12">6.5.</a> |
344 |
Controlling connection<br /> |
Controlling connection<br /> |
356 |
Current number of active voices<br /> |
Current number of active voices<br /> |
357 |
<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a> |
<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a> |
358 |
Maximum amount of active voices<br /> |
Maximum amount of active voices<br /> |
359 |
<a href="#RESET">6.6.3.</a> |
<a href="#GET TOTAL_STREAM_COUNT">6.6.3.</a> |
360 |
|
Current number of active disk streams<br /> |
361 |
|
<a href="#RESET">6.6.4.</a> |
362 |
Reset sampler<br /> |
Reset sampler<br /> |
363 |
<a href="#GET SERVER INFO">6.6.4.</a> |
<a href="#GET SERVER INFO">6.6.5.</a> |
364 |
General sampler informations<br /> |
General sampler informations<br /> |
365 |
<a href="#GET VOLUME">6.6.5.</a> |
<a href="#GET VOLUME">6.6.6.</a> |
366 |
Getting global volume attenuation<br /> |
Getting global volume attenuation<br /> |
367 |
<a href="#SET VOLUME">6.6.6.</a> |
<a href="#SET VOLUME">6.6.7.</a> |
368 |
Setting global volume attenuation<br /> |
Setting global volume attenuation<br /> |
369 |
|
<a href="#GET VOICES">6.6.8.</a> |
370 |
|
Getting global voice limit<br /> |
371 |
|
<a href="#SET VOICES">6.6.9.</a> |
372 |
|
Setting global voice limit<br /> |
373 |
|
<a href="#GET STREAMS">6.6.10.</a> |
374 |
|
Getting global disk stream limit<br /> |
375 |
|
<a href="#SET STREAMS">6.6.11.</a> |
376 |
|
Setting global disk stream limit<br /> |
377 |
<a href="#MIDI Instrument Mapping">6.7.</a> |
<a href="#MIDI Instrument Mapping">6.7.</a> |
378 |
MIDI Instrument Mapping<br /> |
MIDI Instrument Mapping<br /> |
379 |
<a href="#ADD MIDI_INSTRUMENT MAP">6.7.1.</a> |
<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a> |
380 |
Create a new MIDI instrument map<br /> |
Create a new MIDI instrument map<br /> |
381 |
<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a> |
<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a> |
382 |
Delete one particular or all MIDI instrument maps<br /> |
Delete one particular or all MIDI instrument maps<br /> |
446 |
Getting job status information<br /> |
Getting job status information<br /> |
447 |
<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a> |
<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a> |
448 |
Formatting the instruments database<br /> |
Formatting the instruments database<br /> |
449 |
|
<a href="#FIND LOST DB_INSTRUMENT_FILES">6.8.23.</a> |
450 |
|
Checking for lost instrument files<br /> |
451 |
|
<a href="#SET DB_INSTRUMENT FILE_PATH">6.8.24.</a> |
452 |
|
Replacing an instrument file<br /> |
453 |
<a href="#editing_instruments">6.9.</a> |
<a href="#editing_instruments">6.9.</a> |
454 |
Editing Instruments<br /> |
Editing Instruments<br /> |
455 |
<a href="#EDIT INSTRUMENT">6.9.1.</a> |
<a href="#EDIT INSTRUMENT">6.9.1.</a> |
456 |
Opening an appropriate instrument editor application<br /> |
Opening an appropriate instrument editor application<br /> |
457 |
|
<a href="#file_management">6.10.</a> |
458 |
|
Managing Files<br /> |
459 |
|
<a href="#GET FILE INSTRUMENTS">6.10.1.</a> |
460 |
|
Retrieving amount of instruments of a file<br /> |
461 |
|
<a href="#LIST FILE INSTRUMENTS">6.10.2.</a> |
462 |
|
Retrieving all instruments of a file<br /> |
463 |
|
<a href="#GET FILE INSTRUMENT INFO">6.10.3.</a> |
464 |
|
Retrieving informations about one instrument in a file<br /> |
465 |
|
<a href="#effects">6.11.</a> |
466 |
|
Managing Effects<br /> |
467 |
|
<a href="#GET AVAILABLE_EFFECTS">6.11.1.</a> |
468 |
|
Retrieve amount of available effects<br /> |
469 |
|
<a href="#LIST AVAILABLE_EFFECTS">6.11.2.</a> |
470 |
|
Get list of available effects<br /> |
471 |
|
<a href="#GET EFFECT INFO">6.11.3.</a> |
472 |
|
Retrieving general information about an effect<br /> |
473 |
|
<a href="#CREATE EFFECT_INSTANCE">6.11.4.</a> |
474 |
|
Creating an instance of an effect by its portable ID<br /> |
475 |
|
<a href="#CREATE EFFECT_INSTANCE (non-portable)">6.11.5.</a> |
476 |
|
Creating an instance of an effect by its numerical ID<br /> |
477 |
|
<a href="#DESTROY EFFECT_INSTANCE">6.11.6.</a> |
478 |
|
Destroy an effect instance<br /> |
479 |
|
<a href="#GET EFFECT_INSTANCES">6.11.7.</a> |
480 |
|
Retrieve amount of effect instances<br /> |
481 |
|
<a href="#LIST EFFECT_INSTANCES">6.11.8.</a> |
482 |
|
Get list of effect instances<br /> |
483 |
|
<a href="#GET EFFECT_INSTANCE INFO">6.11.9.</a> |
484 |
|
Retrieving current information about an effect instance<br /> |
485 |
|
<a href="#GET EFFECT_INSTANCE_INPUT_CONTROL INFO">6.11.10.</a> |
486 |
|
Retrieving information about an effect parameter<br /> |
487 |
|
<a href="#SET EFFECT_INSTANCE_INPUT_CONTROL VALUE">6.11.11.</a> |
488 |
|
Altering an effect parameter<br /> |
489 |
|
<a href="#GET SEND_EFFECT_CHAINS">6.11.12.</a> |
490 |
|
Retrieve amount of send effect chains<br /> |
491 |
|
<a href="#LIST SEND_EFFECT_CHAINS">6.11.13.</a> |
492 |
|
Retrieve list of send effect chains<br /> |
493 |
|
<a href="#ADD SEND_EFFECT_CHAIN">6.11.14.</a> |
494 |
|
Add send effect chain<br /> |
495 |
|
<a href="#REMOVE SEND_EFFECT_CHAIN">6.11.15.</a> |
496 |
|
Remove send effect chain<br /> |
497 |
|
<a href="#GET SEND_EFFECT_CHAIN INFO">6.11.16.</a> |
498 |
|
Retrieving information about a send effect chain<br /> |
499 |
|
<a href="#APPEND SEND_EFFECT_CHAIN EFFECT">6.11.17.</a> |
500 |
|
Append effect instance to a send effect chain<br /> |
501 |
|
<a href="#INSERT SEND_EFFECT_CHAIN EFFECT">6.11.18.</a> |
502 |
|
Insert effect instance to a send effect chain<br /> |
503 |
|
<a href="#REMOVE SEND_EFFECT_CHAIN EFFECT">6.11.19.</a> |
504 |
|
Remove effect instance from send effect chain<br /> |
505 |
<a href="#command_syntax">7.</a> |
<a href="#command_syntax">7.</a> |
506 |
Command Syntax<br /> |
Command Syntax<br /> |
507 |
<a href="#character_set">7.1.</a> |
<a href="#character_set">7.1.</a> |
518 |
MIDI input device's settings changed<br /> |
MIDI input device's settings changed<br /> |
519 |
<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a> |
<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a> |
520 |
Number of sampler channels changed<br /> |
Number of sampler channels changed<br /> |
521 |
<a href="#SUBSCRIBE VOICE_COUNT">8.6.</a> |
<a href="#SUBSCRIBE CHANNEL_MIDI">8.6.</a> |
522 |
|
MIDI data on a sampler channel arrived<br /> |
523 |
|
<a href="#SUBSCRIBE DEVICE_MIDI">8.7.</a> |
524 |
|
MIDI data on a MIDI input device arrived<br /> |
525 |
|
<a href="#SUBSCRIBE VOICE_COUNT">8.8.</a> |
526 |
Number of active voices changed<br /> |
Number of active voices changed<br /> |
527 |
<a href="#SUBSCRIBE STREAM_COUNT">8.7.</a> |
<a href="#SUBSCRIBE STREAM_COUNT">8.9.</a> |
528 |
Number of active disk streams changed<br /> |
Number of active disk streams changed<br /> |
529 |
<a href="#SUBSCRIBE BUFFER_FILL">8.8.</a> |
<a href="#SUBSCRIBE BUFFER_FILL">8.10.</a> |
530 |
Disk stream buffer fill state changed<br /> |
Disk stream buffer fill state changed<br /> |
531 |
<a href="#SUBSCRIBE CHANNEL_INFO">8.9.</a> |
<a href="#SUBSCRIBE CHANNEL_INFO">8.11.</a> |
532 |
Channel information changed<br /> |
Channel information changed<br /> |
533 |
<a href="#SUBSCRIBE FX_SEND_COUNT">8.10.</a> |
<a href="#SUBSCRIBE FX_SEND_COUNT">8.12.</a> |
534 |
Number of effect sends changed<br /> |
Number of effect sends changed<br /> |
535 |
<a href="#SUBSCRIBE FX_SEND_INFO">8.11.</a> |
<a href="#SUBSCRIBE FX_SEND_INFO">8.13.</a> |
536 |
Effect send information changed<br /> |
Effect send information changed<br /> |
537 |
<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a> |
<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.14.</a> |
538 |
Total number of active voices changed<br /> |
Total number of active voices changed<br /> |
539 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.13.</a> |
<a href="#SUBSCRIBE TOTAL_STREAM_COUNT">8.15.</a> |
540 |
|
Total number of active disk streams changed<br /> |
541 |
|
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.16.</a> |
542 |
Number of MIDI instrument maps changed<br /> |
Number of MIDI instrument maps changed<br /> |
543 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.14.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.17.</a> |
544 |
MIDI instrument map information changed<br /> |
MIDI instrument map information changed<br /> |
545 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.15.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.18.</a> |
546 |
Number of MIDI instruments changed<br /> |
Number of MIDI instruments changed<br /> |
547 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.16.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.19.</a> |
548 |
MIDI instrument information changed<br /> |
MIDI instrument information changed<br /> |
549 |
<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a> |
<a href="#SUBSCRIBE GLOBAL_INFO">8.20.</a> |
550 |
Global settings changed<br /> |
Global settings changed<br /> |
551 |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.18.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.21.</a> |
552 |
Number of database instrument directories changed<br /> |
Number of database instrument directories changed<br /> |
553 |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.19.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.22.</a> |
554 |
Database instrument directory information changed<br /> |
Database instrument directory information changed<br /> |
555 |
<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.20.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.23.</a> |
556 |
Number of database instruments changed<br /> |
Number of database instruments changed<br /> |
557 |
<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.21.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.24.</a> |
558 |
Database instrument information changed<br /> |
Database instrument information changed<br /> |
559 |
<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.22.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.25.</a> |
560 |
Database job status information changed<br /> |
Database job status information changed<br /> |
561 |
<a href="#SUBSCRIBE MISCELLANEOUS">8.23.</a> |
<a href="#SUBSCRIBE EFFECT_INSTANCE_COUNT">8.26.</a> |
562 |
|
Number of effect instances changed<br /> |
563 |
|
<a href="#SUBSCRIBE EFFECT_INSTANCE_INFO">8.27.</a> |
564 |
|
Effect instance information changed<br /> |
565 |
|
<a href="#SUBSCRIBE SEND_EFFECT_CHAIN_COUNT">8.28.</a> |
566 |
|
Number of send effect chains changed<br /> |
567 |
|
<a href="#SUBSCRIBE SEND_EFFECT_CHAIN_INFO">8.29.</a> |
568 |
|
Send effect chain information changed<br /> |
569 |
|
<a href="#SUBSCRIBE MISCELLANEOUS">8.30.</a> |
570 |
Miscellaneous and debugging events<br /> |
Miscellaneous and debugging events<br /> |
571 |
<a href="#anchor14">9.</a> |
<a href="#anchor14">9.</a> |
572 |
Security Considerations<br /> |
Security Considerations<br /> |
3527 |
</blockquote><p> |
</blockquote><p> |
3528 |
|
|
3529 |
</p> |
</p> |
3530 |
<p>Example: |
<p>Example (Unix): |
3531 |
</p> |
</p> |
3532 |
<p> |
<p> |
3533 |
</p> |
</p> |
3534 |
<blockquote class="text"> |
<blockquote class="text"> |
3535 |
|
<p>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0 |
3536 |
|
</p> |
3537 |
|
<p>S: OK |
3538 |
|
</p> |
3539 |
|
</blockquote><p> |
3540 |
|
|
3541 |
|
</p> |
3542 |
|
<p>Example (Windows): |
3543 |
|
</p> |
3544 |
<p> |
<p> |
3545 |
|
</p> |
3546 |
|
<blockquote class="text"> |
3547 |
|
<p>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0 |
3548 |
|
</p> |
3549 |
|
<p>S: OK |
3550 |
</p> |
</p> |
3551 |
</blockquote><p> |
</blockquote><p> |
3552 |
|
|
3961 |
</p> |
</p> |
3962 |
<blockquote class="text"> |
<blockquote class="text"> |
3963 |
<p>arbitrary description text about the engine |
<p>arbitrary description text about the engine |
3964 |
|
(note that the character string may contain |
3965 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
3966 |
</p> |
</p> |
3967 |
</blockquote> |
</blockquote> |
3968 |
|
|
4048 |
<blockquote class="text"> |
<blockquote class="text"> |
4049 |
<p>numerical ID of the audio output device which is |
<p>numerical ID of the audio output device which is |
4050 |
currently connected to this sampler channel to output |
currently connected to this sampler channel to output |
4051 |
the audio signal, "NONE" if there's no device |
the audio signal, "-1" if there's no device |
4052 |
connected to this sampler channel |
connected to this sampler channel |
4053 |
</p> |
</p> |
4054 |
</blockquote> |
</blockquote> |
4082 |
<blockquote class="text"> |
<blockquote class="text"> |
4083 |
<p>the file name of the loaded instrument, "NONE" if |
<p>the file name of the loaded instrument, "NONE" if |
4084 |
there's no instrument yet loaded for this sampler |
there's no instrument yet loaded for this sampler |
4085 |
channel |
channel (note: since LSCP 1.2 this path may contain |
4086 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
4087 |
</p> |
</p> |
4088 |
</blockquote> |
</blockquote> |
4089 |
|
|
4091 |
<p>INSTRUMENT_NR - |
<p>INSTRUMENT_NR - |
4092 |
</p> |
</p> |
4093 |
<blockquote class="text"> |
<blockquote class="text"> |
4094 |
<p>the instrument index number of the loaded instrument |
<p>the instrument index number of the loaded instrument, |
4095 |
|
"-1" if there's no instrument loaded for this sampler |
4096 |
|
channel |
4097 |
</p> |
</p> |
4098 |
</blockquote> |
</blockquote> |
4099 |
|
|
4102 |
</p> |
</p> |
4103 |
<blockquote class="text"> |
<blockquote class="text"> |
4104 |
<p>the instrument name of the loaded instrument |
<p>the instrument name of the loaded instrument |
4105 |
|
(note: since LSCP 1.2 this character string may contain |
4106 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
4107 |
</p> |
</p> |
4108 |
</blockquote> |
</blockquote> |
4109 |
|
|
4111 |
<p>INSTRUMENT_STATUS - |
<p>INSTRUMENT_STATUS - |
4112 |
</p> |
</p> |
4113 |
<blockquote class="text"> |
<blockquote class="text"> |
4114 |
<p>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative |
<p>Integer values 0 to 100 indicating loading progress |
4115 |
value indicates a loading exception. Value of 100 indicates that the instrument is fully |
percentage for the instrument. Negative |
4116 |
|
value indicates a loading exception (also returns "-1" in case no |
4117 |
|
instrument was yet to be loaded on the sampler channel). |
4118 |
|
Value of 100 indicates that the instrument is fully |
4119 |
loaded. |
loaded. |
4120 |
</p> |
</p> |
4121 |
</blockquote> |
</blockquote> |
4126 |
<blockquote class="text"> |
<blockquote class="text"> |
4127 |
<p>numerical ID of the MIDI input device which is |
<p>numerical ID of the MIDI input device which is |
4128 |
currently connected to this sampler channel to deliver |
currently connected to this sampler channel to deliver |
4129 |
MIDI input commands, "NONE" if there's no device |
MIDI input commands, "-1" if there's no device |
4130 |
connected to this sampler channel |
connected to this sampler channel |
4131 |
</p> |
</p> |
4132 |
</blockquote> |
</blockquote> |
4135 |
<p>MIDI_INPUT_PORT - |
<p>MIDI_INPUT_PORT - |
4136 |
</p> |
</p> |
4137 |
<blockquote class="text"> |
<blockquote class="text"> |
4138 |
<p>port number of the MIDI input device |
<p>port number of the MIDI input device (in case a |
4139 |
|
MIDI device was already assigned to the sampler |
4140 |
|
channel) |
4141 |
</p> |
</p> |
4142 |
</blockquote> |
</blockquote> |
4143 |
|
|
5184 |
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> |
5185 |
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 |
5186 |
effect send level and <name> is an optional argument defining a name |
effect send level and <name> is an optional argument defining a name |
5187 |
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 |
5188 |
|
encapsulated into apostrophes and supports escape sequences as described in chapter |
5189 |
|
"<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>". |
5190 |
</p> |
</p> |
5191 |
<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 |
5192 |
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 |
5455 |
</p> |
</p> |
5456 |
<blockquote class="text"> |
<blockquote class="text"> |
5457 |
<p>name of the effect send entity |
<p>name of the effect send entity |
5458 |
|
(note that this character string may contain |
5459 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
5460 |
</p> |
</p> |
5461 |
</blockquote> |
</blockquote> |
5462 |
|
|
5491 |
channel 1 is routed to the channel 3 of the audio |
channel 1 is routed to the channel 3 of the audio |
5492 |
output device (see |
output device (see |
5493 |
<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> |
5494 |
for details) |
for details), if an internal send |
5495 |
|
effect is assigned to the effect |
5496 |
|
send, then this setting defines the |
5497 |
|
audio channel routing to that |
5498 |
|
effect instance respectively |
5499 |
|
</p> |
5500 |
|
</blockquote> |
5501 |
|
|
5502 |
|
|
5503 |
|
<p>EFFECT - |
5504 |
|
</p> |
5505 |
|
<blockquote class="text"> |
5506 |
|
<p>destination send effect chain ID |
5507 |
|
and destination effect chain |
5508 |
|
position, separated by comma in the |
5509 |
|
form "<effect-chain>,<chain-pos>" |
5510 |
|
or "NONE" if there is no send effect |
5511 |
|
assigned to the effect send |
5512 |
</p> |
</p> |
5513 |
</blockquote> |
</blockquote> |
5514 |
|
|
5536 |
</p> |
</p> |
5537 |
<p> "AUDIO_OUTPUT_ROUTING: 2,3" |
<p> "AUDIO_OUTPUT_ROUTING: 2,3" |
5538 |
</p> |
</p> |
5539 |
|
<p> "EFFECT: NONE" |
5540 |
|
</p> |
5541 |
|
<p> "." |
5542 |
|
</p> |
5543 |
|
</blockquote><p> |
5544 |
|
|
5545 |
|
</p> |
5546 |
|
<p> |
5547 |
|
</p> |
5548 |
|
<blockquote class="text"> |
5549 |
|
<p>C: "GET FX_SEND INFO 0 1" |
5550 |
|
</p> |
5551 |
|
<p>S: "NAME: Delay Send (Internal)" |
5552 |
|
</p> |
5553 |
|
<p> "MIDI_CONTROLLER: 93" |
5554 |
|
</p> |
5555 |
|
<p> "LEVEL: 0.51" |
5556 |
|
</p> |
5557 |
|
<p> "AUDIO_OUTPUT_ROUTING: 1,2" |
5558 |
|
</p> |
5559 |
|
<p> "EFFECT: 2,0" |
5560 |
|
</p> |
5561 |
<p> "." |
<p> "." |
5562 |
</p> |
</p> |
5563 |
</blockquote><p> |
</blockquote><p> |
5586 |
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> |
5587 |
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 |
5588 |
<name> is the new name of the effect send entity, which |
<name> is the new name of the effect send entity, which |
5589 |
does not have to be unique. |
does not have to be unique (name MUST be encapsulated into apostrophes |
5590 |
|
and supports escape sequences as described in chapter |
5591 |
|
"<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>"). |
5592 |
|
|
5593 |
</p> |
</p> |
5594 |
<p>Possible Answers: |
<p>Possible Answers: |
5595 |
</p> |
</p> |
5652 |
<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 |
5653 |
which should be rerouted and <audio-dst> is the numerical ID of |
which should be rerouted and <audio-dst> is the numerical ID of |
5654 |
the audio channel of the selected audio output device where <audio-src> |
the audio channel of the selected audio output device where <audio-src> |
5655 |
should be routed to. |
should be routed to. If an internal send effect is assigned |
5656 |
|
to the effect send, then this setting defines the audio |
5657 |
|
channel routing to that effect instance respectively. |
5658 |
</p> |
</p> |
5659 |
<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 |
5660 |
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 |
5712 |
</blockquote><p> |
</blockquote><p> |
5713 |
|
|
5714 |
</p> |
</p> |
5715 |
<a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr /> |
<a name="SET FX_SEND EFFECT"></a><br /><hr /> |
5716 |
<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> |
5717 |
<a name="rfc.section.6.4.32"></a><h3>6.4.32. |
<a name="rfc.section.6.4.32"></a><h3>6.4.32. |
5718 |
|
Assigning destination effect to an effect send</h3> |
5719 |
|
|
5720 |
|
<p>The front-end can (re-)assign a destination effect to an |
5721 |
|
effect send by sending the following command: |
5722 |
|
</p> |
5723 |
|
<p> |
5724 |
|
</p> |
5725 |
|
<blockquote class="text"> |
5726 |
|
<p>SET FX_SEND EFFECT <sampler-chan> <fx-send-id> <effect-chain> <chain-pos> |
5727 |
|
</p> |
5728 |
|
</blockquote><p> |
5729 |
|
|
5730 |
|
</p> |
5731 |
|
<p>Where <sampler-chan> is the sampler channel number |
5732 |
|
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> |
5733 |
|
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, |
5734 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
5735 |
|
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> |
5736 |
|
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, |
5737 |
|
<effect-chain> by the numerical ID of the destination |
5738 |
|
effect chain as returned by the |
5739 |
|
<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> |
5740 |
|
or |
5741 |
|
<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> |
5742 |
|
command and <chain-pos> reflects the exact effect |
5743 |
|
chain position in the effect chain which hosts the actual |
5744 |
|
destination effect. |
5745 |
|
</p> |
5746 |
|
<p>Possible Answers: |
5747 |
|
</p> |
5748 |
|
<p> |
5749 |
|
</p> |
5750 |
|
<blockquote class="text"> |
5751 |
|
<p>"OK" - |
5752 |
|
</p> |
5753 |
|
<blockquote class="text"> |
5754 |
|
<p>on success |
5755 |
|
</p> |
5756 |
|
</blockquote> |
5757 |
|
|
5758 |
|
|
5759 |
|
<p>"ERR:<error-code>:<error-message>" - |
5760 |
|
</p> |
5761 |
|
<blockquote class="text"> |
5762 |
|
<p>in case it failed, providing an appropriate error code and error message |
5763 |
|
</p> |
5764 |
|
</blockquote> |
5765 |
|
|
5766 |
|
|
5767 |
|
</blockquote><p> |
5768 |
|
|
5769 |
|
</p> |
5770 |
|
<p>Example: |
5771 |
|
</p> |
5772 |
|
<p> |
5773 |
|
</p> |
5774 |
|
<blockquote class="text"> |
5775 |
|
<p>C: "SET FX_SEND EFFECT 0 0 2 5" |
5776 |
|
</p> |
5777 |
|
<p>S: "OK" |
5778 |
|
</p> |
5779 |
|
</blockquote><p> |
5780 |
|
|
5781 |
|
</p> |
5782 |
|
<a name="REMOVE FX_SEND EFFECT"></a><br /><hr /> |
5783 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5784 |
|
<a name="rfc.section.6.4.33"></a><h3>6.4.33. |
5785 |
|
Removing destination effect from an effect send</h3> |
5786 |
|
|
5787 |
|
<p>The front-end can (re-)assign a destination effect to an |
5788 |
|
effect send by sending the following command: |
5789 |
|
</p> |
5790 |
|
<p> |
5791 |
|
</p> |
5792 |
|
<blockquote class="text"> |
5793 |
|
<p>REMOVE FX_SEND EFFECT <sampler-chan> <fx-send-id> |
5794 |
|
</p> |
5795 |
|
</blockquote><p> |
5796 |
|
|
5797 |
|
</p> |
5798 |
|
<p>Where <sampler-chan> is the sampler channel number |
5799 |
|
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> |
5800 |
|
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, |
5801 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
5802 |
|
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> |
5803 |
|
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. |
5804 |
|
</p> |
5805 |
|
<p>After the destination effect has been removed from the |
5806 |
|
effect send, the audio signal of the effect send will be |
5807 |
|
routed directly to the audio output device, according to the |
5808 |
|
audio channel routing setting of the effect send. |
5809 |
|
|
5810 |
|
</p> |
5811 |
|
<p>Possible Answers: |
5812 |
|
</p> |
5813 |
|
<p> |
5814 |
|
</p> |
5815 |
|
<blockquote class="text"> |
5816 |
|
<p>"OK" - |
5817 |
|
</p> |
5818 |
|
<blockquote class="text"> |
5819 |
|
<p>on success |
5820 |
|
</p> |
5821 |
|
</blockquote> |
5822 |
|
|
5823 |
|
|
5824 |
|
<p>"ERR:<error-code>:<error-message>" - |
5825 |
|
</p> |
5826 |
|
<blockquote class="text"> |
5827 |
|
<p>in case it failed, providing an appropriate error code and error message |
5828 |
|
</p> |
5829 |
|
</blockquote> |
5830 |
|
|
5831 |
|
|
5832 |
|
</blockquote><p> |
5833 |
|
|
5834 |
|
</p> |
5835 |
|
<p>Example: |
5836 |
|
</p> |
5837 |
|
<p> |
5838 |
|
</p> |
5839 |
|
<blockquote class="text"> |
5840 |
|
<p>C: "REMOVE FX_SEND EFFECT 0 0" |
5841 |
|
</p> |
5842 |
|
<p>S: "OK" |
5843 |
|
</p> |
5844 |
|
</blockquote><p> |
5845 |
|
|
5846 |
|
</p> |
5847 |
|
<a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr /> |
5848 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5849 |
|
<a name="rfc.section.6.4.34"></a><h3>6.4.34. |
5850 |
Altering effect send's MIDI controller</h3> |
Altering effect send's MIDI controller</h3> |
5851 |
|
|
5852 |
<p>The front-end can alter the MIDI controller of an effect |
<p>The front-end can alter the MIDI controller of an effect |
5917 |
</p> |
</p> |
5918 |
<a name="SET FX_SEND LEVEL"></a><br /><hr /> |
<a name="SET FX_SEND LEVEL"></a><br /><hr /> |
5919 |
<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> |
5920 |
<a name="rfc.section.6.4.33"></a><h3>6.4.33. |
<a name="rfc.section.6.4.35"></a><h3>6.4.35. |
5921 |
Altering effect send's send level</h3> |
Altering effect send's send level</h3> |
5922 |
|
|
5923 |
<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 |
5987 |
</blockquote><p> |
</blockquote><p> |
5988 |
|
|
5989 |
</p> |
</p> |
5990 |
|
<a name="SEND CHANNEL MIDI_DATA"></a><br /><hr /> |
5991 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
5992 |
|
<a name="rfc.section.6.4.36"></a><h3>6.4.36. |
5993 |
|
Sending MIDI messages to sampler channel</h3> |
5994 |
|
|
5995 |
|
<p>The front-end can send MIDI events to a specific sampler channel |
5996 |
|
by sending the following command: |
5997 |
|
</p> |
5998 |
|
<p> |
5999 |
|
</p> |
6000 |
|
<blockquote class="text"> |
6001 |
|
<p>SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2> |
6002 |
|
</p> |
6003 |
|
</blockquote><p> |
6004 |
|
|
6005 |
|
</p> |
6006 |
|
<p>Where <sampler-chan> is the sampler channel number |
6007 |
|
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> |
6008 |
|
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, |
6009 |
|
<arg1> and <arg2> arguments depend on the <midi-msg> argument, which |
6010 |
|
specifies the MIDI message type. Currently, the following MIDI messages are supported: |
6011 |
|
</p> |
6012 |
|
<p> |
6013 |
|
</p> |
6014 |
|
<blockquote class="text"> |
6015 |
|
<p>"NOTE_ON" - |
6016 |
|
</p> |
6017 |
|
<blockquote class="text"> |
6018 |
|
<p>For turning on MIDI notes, where <arg1> |
6019 |
|
specifies the key number and <arg2> the velocity |
6020 |
|
as described in the MIDI specification. |
6021 |
|
</p> |
6022 |
|
</blockquote> |
6023 |
|
|
6024 |
|
|
6025 |
|
<p>"NOTE_OFF" - |
6026 |
|
</p> |
6027 |
|
<blockquote class="text"> |
6028 |
|
<p>For turning a currently playing MIDI note off, where <arg1> |
6029 |
|
specifies the key number and <arg2> the velocity |
6030 |
|
as described in the MIDI specification. |
6031 |
|
</p> |
6032 |
|
</blockquote> |
6033 |
|
|
6034 |
|
|
6035 |
|
<p>"CC" - |
6036 |
|
</p> |
6037 |
|
<blockquote class="text"> |
6038 |
|
<p>For changing a MIDI controller, where <arg1> |
6039 |
|
specifies the controller number and <arg2> the |
6040 |
|
new value of the controller as described in the Control |
6041 |
|
Change section of the MIDI specification. |
6042 |
|
</p> |
6043 |
|
</blockquote> |
6044 |
|
|
6045 |
|
|
6046 |
|
</blockquote><p> |
6047 |
|
|
6048 |
|
</p> |
6049 |
|
<p>CAUTION: This command is provided for implementations of virtual MIDI keyboards |
6050 |
|
and no realtime guarantee whatsoever will be made! |
6051 |
|
</p> |
6052 |
|
<p>Possible Answers: |
6053 |
|
</p> |
6054 |
|
<p> |
6055 |
|
</p> |
6056 |
|
<blockquote class="text"> |
6057 |
|
<p>"OK" - |
6058 |
|
</p> |
6059 |
|
<blockquote class="text"> |
6060 |
|
<p>on success |
6061 |
|
</p> |
6062 |
|
</blockquote> |
6063 |
|
|
6064 |
|
|
6065 |
|
<p>"ERR:<error-code>:<error-message>" - |
6066 |
|
</p> |
6067 |
|
<blockquote class="text"> |
6068 |
|
<p>in case it failed, providing an appropriate error code and error message |
6069 |
|
</p> |
6070 |
|
</blockquote> |
6071 |
|
|
6072 |
|
|
6073 |
|
</blockquote><p> |
6074 |
|
|
6075 |
|
</p> |
6076 |
|
<p>Example: |
6077 |
|
</p> |
6078 |
|
<p> |
6079 |
|
</p> |
6080 |
|
<blockquote class="text"> |
6081 |
|
<p>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112" |
6082 |
|
</p> |
6083 |
|
<p>S: "OK" |
6084 |
|
</p> |
6085 |
|
</blockquote><p> |
6086 |
|
|
6087 |
|
</p> |
6088 |
<a name="RESET CHANNEL"></a><br /><hr /> |
<a name="RESET CHANNEL"></a><br /><hr /> |
6089 |
<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> |
6090 |
<a name="rfc.section.6.4.34"></a><h3>6.4.34. |
<a name="rfc.section.6.4.37"></a><h3>6.4.37. |
6091 |
Resetting a sampler channel</h3> |
Resetting a sampler channel</h3> |
6092 |
|
|
6093 |
<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: |
6422 |
</blockquote><p> |
</blockquote><p> |
6423 |
|
|
6424 |
</p> |
</p> |
6425 |
<a name="RESET"></a><br /><hr /> |
<a name="GET TOTAL_STREAM_COUNT"></a><br /><hr /> |
6426 |
<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> |
6427 |
<a name="rfc.section.6.6.3"></a><h3>6.6.3. |
<a name="rfc.section.6.6.3"></a><h3>6.6.3. |
6428 |
|
Current number of active disk streams</h3> |
6429 |
|
|
6430 |
|
<p>The front-end can ask for the current number of active disk streams on |
6431 |
|
the sampler by sending the following command: |
6432 |
|
</p> |
6433 |
|
<p> |
6434 |
|
</p> |
6435 |
|
<blockquote class="text"> |
6436 |
|
<p>GET TOTAL_STREAM_COUNT |
6437 |
|
</p> |
6438 |
|
</blockquote><p> |
6439 |
|
|
6440 |
|
</p> |
6441 |
|
<p>Possible Answers: |
6442 |
|
</p> |
6443 |
|
<p> |
6444 |
|
</p> |
6445 |
|
<blockquote class="text"> |
6446 |
|
<p>LinuxSampler will answer by returning the number of all active |
6447 |
|
disk streams on the sampler. |
6448 |
|
</p> |
6449 |
|
</blockquote><p> |
6450 |
|
|
6451 |
|
</p> |
6452 |
|
<a name="RESET"></a><br /><hr /> |
6453 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6454 |
|
<a name="rfc.section.6.6.4"></a><h3>6.6.4. |
6455 |
Reset sampler</h3> |
Reset sampler</h3> |
6456 |
|
|
6457 |
<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: |
6492 |
</p> |
</p> |
6493 |
<a name="GET SERVER INFO"></a><br /><hr /> |
<a name="GET SERVER INFO"></a><br /><hr /> |
6494 |
<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> |
6495 |
<a name="rfc.section.6.6.4"></a><h3>6.6.4. |
<a name="rfc.section.6.6.5"></a><h3>6.6.5. |
6496 |
General sampler informations</h3> |
General sampler informations</h3> |
6497 |
|
|
6498 |
<p>The client can ask for general informations about the LinuxSampler |
<p>The client can ask for general informations about the LinuxSampler |
6525 |
</p> |
</p> |
6526 |
<blockquote class="text"> |
<blockquote class="text"> |
6527 |
<p>arbitrary textual description about the sampler |
<p>arbitrary textual description about the sampler |
6528 |
|
(note that the character string may contain |
6529 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
6530 |
</p> |
</p> |
6531 |
</blockquote> |
</blockquote> |
6532 |
|
|
6568 |
</p> |
</p> |
6569 |
<a name="GET VOLUME"></a><br /><hr /> |
<a name="GET VOLUME"></a><br /><hr /> |
6570 |
<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> |
6571 |
<a name="rfc.section.6.6.5"></a><h3>6.6.5. |
<a name="rfc.section.6.6.6"></a><h3>6.6.6. |
6572 |
Getting global volume attenuation</h3> |
Getting global volume attenuation</h3> |
6573 |
|
|
6574 |
<p>The client can ask for the current global sampler-wide volume |
<p>The client can ask for the current global sampler-wide volume |
6601 |
</p> |
</p> |
6602 |
<a name="SET VOLUME"></a><br /><hr /> |
<a name="SET VOLUME"></a><br /><hr /> |
6603 |
<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> |
6604 |
<a name="rfc.section.6.6.6"></a><h3>6.6.6. |
<a name="rfc.section.6.6.7"></a><h3>6.6.7. |
6605 |
Setting global volume attenuation</h3> |
Setting global volume attenuation</h3> |
6606 |
|
|
6607 |
<p>The client can alter the current global sampler-wide volume |
<p>The client can alter the current global sampler-wide volume |
6654 |
</blockquote><p> |
</blockquote><p> |
6655 |
|
|
6656 |
</p> |
</p> |
6657 |
|
<a name="GET VOICES"></a><br /><hr /> |
6658 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6659 |
|
<a name="rfc.section.6.6.8"></a><h3>6.6.8. |
6660 |
|
Getting global voice limit</h3> |
6661 |
|
|
6662 |
|
<p>The client can ask for the current global sampler-wide limit |
6663 |
|
for maximum voices by sending the following command: |
6664 |
|
</p> |
6665 |
|
<p> |
6666 |
|
</p> |
6667 |
|
<blockquote class="text"> |
6668 |
|
<p>GET VOICES |
6669 |
|
</p> |
6670 |
|
</blockquote><p> |
6671 |
|
|
6672 |
|
</p> |
6673 |
|
<p>Possible Answers: |
6674 |
|
</p> |
6675 |
|
<p> |
6676 |
|
</p> |
6677 |
|
<blockquote class="text"> |
6678 |
|
<p>LinuxSampler will answer by returning the number for |
6679 |
|
the current limit of maximum voices. |
6680 |
|
</p> |
6681 |
|
</blockquote><p> |
6682 |
|
|
6683 |
|
</p> |
6684 |
|
<p>The voice limit setting defines how many voices should maximum |
6685 |
|
be processed by the sampler at the same time. If the user |
6686 |
|
triggers new notes which would exceed that voice limit, the |
6687 |
|
sampler engine will react by stealing old voices for those |
6688 |
|
newly triggered notes. Note that the amount of voices triggered |
6689 |
|
by a new note can be larger than one and is dependent to the |
6690 |
|
respective instrument and probably further criterias. |
6691 |
|
</p> |
6692 |
|
<a name="SET VOICES"></a><br /><hr /> |
6693 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6694 |
|
<a name="rfc.section.6.6.9"></a><h3>6.6.9. |
6695 |
|
Setting global voice limit</h3> |
6696 |
|
|
6697 |
|
<p>The client can alter the current global sampler-wide limit |
6698 |
|
for maximum voices by sending the following command: |
6699 |
|
</p> |
6700 |
|
<p> |
6701 |
|
</p> |
6702 |
|
<blockquote class="text"> |
6703 |
|
<p>SET VOICES <max-voices> |
6704 |
|
</p> |
6705 |
|
</blockquote><p> |
6706 |
|
|
6707 |
|
</p> |
6708 |
|
<p>Where <max-voices> should be replaced by the integer |
6709 |
|
value, reflecting the new global amount limit of maximum voices. |
6710 |
|
This value has to be larger than 0. |
6711 |
|
</p> |
6712 |
|
<p>Possible Answers: |
6713 |
|
</p> |
6714 |
|
<p> |
6715 |
|
</p> |
6716 |
|
<blockquote class="text"> |
6717 |
|
<p>"OK" - |
6718 |
|
</p> |
6719 |
|
<blockquote class="text"> |
6720 |
|
<p>on success |
6721 |
|
</p> |
6722 |
|
</blockquote> |
6723 |
|
|
6724 |
|
|
6725 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
6726 |
|
</p> |
6727 |
|
<blockquote class="text"> |
6728 |
|
<p>if the voice limit was set, but there are noteworthy |
6729 |
|
issue(s) related, providing an appropriate warning code and |
6730 |
|
warning message |
6731 |
|
</p> |
6732 |
|
</blockquote> |
6733 |
|
|
6734 |
|
|
6735 |
|
<p>"ERR:<error-code>:<error-message>" - |
6736 |
|
</p> |
6737 |
|
<blockquote class="text"> |
6738 |
|
<p>in case it failed, providing an appropriate error code and error message |
6739 |
|
</p> |
6740 |
|
</blockquote> |
6741 |
|
|
6742 |
|
|
6743 |
|
</blockquote><p> |
6744 |
|
|
6745 |
|
</p> |
6746 |
|
<p>Note: the given value will be passed to all sampler engine instances. |
6747 |
|
The total amount of maximum voices on the running system might thus |
6748 |
|
be as big as the given value multiplied by the current amount of engine |
6749 |
|
instances. |
6750 |
|
</p> |
6751 |
|
<p>Caution: when adjusting the voice limit, you SHOULD also |
6752 |
|
adjust the disk stream limit respectively and vice versa. |
6753 |
|
</p> |
6754 |
|
<a name="GET STREAMS"></a><br /><hr /> |
6755 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6756 |
|
<a name="rfc.section.6.6.10"></a><h3>6.6.10. |
6757 |
|
Getting global disk stream limit</h3> |
6758 |
|
|
6759 |
|
<p>The client can ask for the current global sampler-wide limit |
6760 |
|
for maximum disk streams by sending the following command: |
6761 |
|
</p> |
6762 |
|
<p> |
6763 |
|
</p> |
6764 |
|
<blockquote class="text"> |
6765 |
|
<p>GET STREAMS |
6766 |
|
</p> |
6767 |
|
</blockquote><p> |
6768 |
|
|
6769 |
|
</p> |
6770 |
|
<p>Possible Answers: |
6771 |
|
</p> |
6772 |
|
<p> |
6773 |
|
</p> |
6774 |
|
<blockquote class="text"> |
6775 |
|
<p>LinuxSampler will answer by returning the number for |
6776 |
|
the current limit of maximum disk streams. |
6777 |
|
</p> |
6778 |
|
</blockquote><p> |
6779 |
|
|
6780 |
|
</p> |
6781 |
|
<p>The disk stream limit setting defines how many disk streams should |
6782 |
|
maximum be processed by a sampler engine at the same time. The |
6783 |
|
higher this value, the more memory (RAM) will be occupied, since |
6784 |
|
every disk streams allocates a certain buffer size for being able |
6785 |
|
to perform its streaming operations. |
6786 |
|
</p> |
6787 |
|
<a name="SET STREAMS"></a><br /><hr /> |
6788 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6789 |
|
<a name="rfc.section.6.6.11"></a><h3>6.6.11. |
6790 |
|
Setting global disk stream limit</h3> |
6791 |
|
|
6792 |
|
<p>The client can alter the current global sampler-wide limit |
6793 |
|
for maximum disk streams by sending the following command: |
6794 |
|
</p> |
6795 |
|
<p> |
6796 |
|
</p> |
6797 |
|
<blockquote class="text"> |
6798 |
|
<p>SET STREAMS <max-streams> |
6799 |
|
</p> |
6800 |
|
</blockquote><p> |
6801 |
|
|
6802 |
|
</p> |
6803 |
|
<p>Where <max-streams> should be replaced by the integer |
6804 |
|
value, reflecting the new global amount limit of maximum disk streams. |
6805 |
|
This value has to be positive. |
6806 |
|
</p> |
6807 |
|
<p>Possible Answers: |
6808 |
|
</p> |
6809 |
|
<p> |
6810 |
|
</p> |
6811 |
|
<blockquote class="text"> |
6812 |
|
<p>"OK" - |
6813 |
|
</p> |
6814 |
|
<blockquote class="text"> |
6815 |
|
<p>on success |
6816 |
|
</p> |
6817 |
|
</blockquote> |
6818 |
|
|
6819 |
|
|
6820 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
6821 |
|
</p> |
6822 |
|
<blockquote class="text"> |
6823 |
|
<p>if the disk stream limit was set, but there are noteworthy |
6824 |
|
issue(s) related, providing an appropriate warning code and |
6825 |
|
warning message |
6826 |
|
</p> |
6827 |
|
</blockquote> |
6828 |
|
|
6829 |
|
|
6830 |
|
<p>"ERR:<error-code>:<error-message>" - |
6831 |
|
</p> |
6832 |
|
<blockquote class="text"> |
6833 |
|
<p>in case it failed, providing an appropriate error code and error message |
6834 |
|
</p> |
6835 |
|
</blockquote> |
6836 |
|
|
6837 |
|
|
6838 |
|
</blockquote><p> |
6839 |
|
|
6840 |
|
</p> |
6841 |
|
<p>Note: the given value will be passed to all sampler engine instances. |
6842 |
|
The total amount of maximum disk streams on the running system might |
6843 |
|
thus be as big as the given value multiplied by the current amount of |
6844 |
|
engine instances. |
6845 |
|
</p> |
6846 |
|
<p>Caution: when adjusting the disk stream limit, you SHOULD also |
6847 |
|
adjust the voice limit respectively and vice versa. |
6848 |
|
</p> |
6849 |
<a name="MIDI Instrument Mapping"></a><br /><hr /> |
<a name="MIDI Instrument Mapping"></a><br /><hr /> |
6850 |
<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> |
6851 |
<a name="rfc.section.6.7"></a><h3>6.7. |
<a name="rfc.section.6.7"></a><h3>6.7. |
6880 |
cause the sampler to switch to the respective instrument as |
cause the sampler to switch to the respective instrument as |
6881 |
reflected by the current MIDI instrument map. |
reflected by the current MIDI instrument map. |
6882 |
</p> |
</p> |
6883 |
<a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr /> |
<a name="ADD MIDI_INSTRUMENT_MAP"></a><br /><hr /> |
6884 |
<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> |
6885 |
<a name="rfc.section.6.7.1"></a><h3>6.7.1. |
<a name="rfc.section.6.7.1"></a><h3>6.7.1. |
6886 |
Create a new MIDI instrument map</h3> |
Create a new MIDI instrument map</h3> |
6898 |
</p> |
</p> |
6899 |
<p>Where <name> is an optional argument allowing to |
<p>Where <name> is an optional argument allowing to |
6900 |
assign a custom name to the new map. MIDI instrument Map |
assign a custom name to the new map. MIDI instrument Map |
6901 |
names do not have to be unique. |
names do not have to be unique, but MUST be encapsulated |
6902 |
|
into apostrophes and support escape sequences as described |
6903 |
|
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>". |
6904 |
|
|
6905 |
</p> |
</p> |
6906 |
<p>Possible Answers: |
<p>Possible Answers: |
6907 |
</p> |
</p> |
7159 |
<blockquote class="text"> |
<blockquote class="text"> |
7160 |
<p>custom name of the given map, |
<p>custom name of the given map, |
7161 |
which does not have to be unique |
which does not have to be unique |
7162 |
|
(note that this character string may contain |
7163 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
7164 |
</p> |
</p> |
7165 |
</blockquote> |
</blockquote> |
7166 |
|
|
7216 |
</p> |
</p> |
7217 |
<p>Where <map> is the numerical ID of the map and |
<p>Where <map> is the numerical ID of the map and |
7218 |
<name> the new custom name of the map, which does not |
<name> the new custom name of the map, which does not |
7219 |
have to be unique. |
have to be unique (name MUST be encapsulated into apostrophes |
7220 |
|
and supports escape sequences as described in chapter |
7221 |
|
"<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>"). |
7222 |
|
|
7223 |
</p> |
</p> |
7224 |
<p>Possible Answers: |
<p>Possible Answers: |
7225 |
</p> |
</p> |
7384 |
load modes of entries, the frontend should retrieve the actual |
load modes of entries, the frontend should retrieve the actual |
7385 |
mode by i.e. sending |
mode by i.e. sending |
7386 |
<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> |
7387 |
command(s). Finally the OPTIONAL <name> argument allows to |
command(s). Finally the OPTIONAL <name> argument allows to set a custom name |
7388 |
set a custom name (encapsulated into apostrophes) for the mapping |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
7389 |
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 |
7390 |
|
mapping entry, useful for frontends for displaying an appropriate name for |
7391 |
mapped instruments (using |
mapped instruments (using |
7392 |
<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>). |
7393 |
|
|
7709 |
changed with the |
changed with the |
7710 |
<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> |
7711 |
command and does not have to be unique. |
command and does not have to be unique. |
7712 |
|
(note that this character string may contain |
7713 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
7714 |
</p> |
</p> |
7715 |
</blockquote> |
</blockquote> |
7716 |
|
|
7727 |
<p>"INSTRUMENT_FILE" - |
<p>"INSTRUMENT_FILE" - |
7728 |
</p> |
</p> |
7729 |
<blockquote class="text"> |
<blockquote class="text"> |
7730 |
<p>File name of the instrument. |
<p>File name of the instrument |
7731 |
|
(note that this path may contain |
7732 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>). |
7733 |
</p> |
</p> |
7734 |
</blockquote> |
</blockquote> |
7735 |
|
|
7747 |
<blockquote class="text"> |
<blockquote class="text"> |
7748 |
<p>Name of the loaded instrument as reflected by its file. |
<p>Name of the loaded instrument as reflected by its file. |
7749 |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
7750 |
cannot be changed. |
cannot be changed (note that this character string may contain |
7751 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>). |
7752 |
</p> |
</p> |
7753 |
</blockquote> |
</blockquote> |
7754 |
|
|
8592 |
<p> |
<p> |
8593 |
</p> |
</p> |
8594 |
<blockquote class="text"> |
<blockquote class="text"> |
8595 |
<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>] |
8596 |
</p> |
</p> |
8597 |
</blockquote><p> |
</blockquote><p> |
8598 |
|
|
8650 |
</blockquote><p> |
</blockquote><p> |
8651 |
|
|
8652 |
</p> |
</p> |
8653 |
|
<p> If FILE_AS_DIR argument is supplied, all instruments in an instrument |
8654 |
|
file will be added to a separate directory in the instruments database, which |
8655 |
|
name will be the name of the instrument file with the file extension stripped off. |
8656 |
|
|
8657 |
|
</p> |
8658 |
<p>The difference between regular and NON_MODAL versions of the command |
<p>The difference between regular and NON_MODAL versions of the command |
8659 |
is that the regular command returns when the scanning is finished |
is that the regular command returns when the scanning is finished |
8660 |
while NON_MODAL version returns immediately and a background process is launched. |
while NON_MODAL version returns immediately and a background process is launched. |
9259 |
|
|
9260 |
</p> |
</p> |
9261 |
<p>Where <instr> is the absolute path name of the instrument and |
<p>Where <instr> is the absolute path name of the instrument and |
9262 |
<desc> is the new description for the instrument |
<desc> is the new description for the instrument |
9263 |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
9264 |
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
9265 |
</p> |
</p> |
9641 |
</blockquote><p> |
</blockquote><p> |
9642 |
|
|
9643 |
</p> |
</p> |
9644 |
|
<a name="FIND LOST DB_INSTRUMENT_FILES"></a><br /><hr /> |
9645 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9646 |
|
<a name="rfc.section.6.8.23"></a><h3>6.8.23. |
9647 |
|
Checking for lost instrument files</h3> |
9648 |
|
|
9649 |
|
<p>The front-end can retrieve the list of all instrument files in the instruments database |
9650 |
|
that don't exist in the filesystem by sending the following command: |
9651 |
|
</p> |
9652 |
|
<p> |
9653 |
|
</p> |
9654 |
|
<blockquote class="text"> |
9655 |
|
<p>FIND LOST DB_INSTRUMENT_FILES |
9656 |
|
</p> |
9657 |
|
</blockquote><p> |
9658 |
|
|
9659 |
|
</p> |
9660 |
|
<p>Possible Answers: |
9661 |
|
</p> |
9662 |
|
<p> |
9663 |
|
</p> |
9664 |
|
<blockquote class="text"> |
9665 |
|
<p>A comma separated list with the absolute path names |
9666 |
|
(encapsulated into apostrophes) of all lost instrument files. |
9667 |
|
</p> |
9668 |
|
<p>"ERR:<error-code>:<error-message>" - |
9669 |
|
</p> |
9670 |
|
<blockquote class="text"> |
9671 |
|
<p>in case it failed, providing an appropriate error code and error message. |
9672 |
|
</p> |
9673 |
|
</blockquote> |
9674 |
|
|
9675 |
|
|
9676 |
|
</blockquote><p> |
9677 |
|
|
9678 |
|
</p> |
9679 |
|
<p>Example: |
9680 |
|
</p> |
9681 |
|
<p> |
9682 |
|
</p> |
9683 |
|
<blockquote class="text"> |
9684 |
|
<p>C: "FIND LOST DB_INSTRUMENT_FILES" |
9685 |
|
</p> |
9686 |
|
<p>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'" |
9687 |
|
</p> |
9688 |
|
</blockquote><p> |
9689 |
|
|
9690 |
|
</p> |
9691 |
|
<a name="SET DB_INSTRUMENT FILE_PATH"></a><br /><hr /> |
9692 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9693 |
|
<a name="rfc.section.6.8.24"></a><h3>6.8.24. |
9694 |
|
Replacing an instrument file</h3> |
9695 |
|
|
9696 |
|
<p>The front-end can substitute all occurrences of an instrument file |
9697 |
|
in the instruments database with a new one by sending the following command: |
9698 |
|
</p> |
9699 |
|
<p> |
9700 |
|
</p> |
9701 |
|
<blockquote class="text"> |
9702 |
|
<p>SET DB_INSTRUMENT FILE_PATH <old_path> <new_path> |
9703 |
|
</p> |
9704 |
|
</blockquote><p> |
9705 |
|
|
9706 |
|
</p> |
9707 |
|
<p>Where <old_path> is the absolute path name of the instrument file |
9708 |
|
to substitute with <new_path>. |
9709 |
|
</p> |
9710 |
|
<p>Possible Answers: |
9711 |
|
</p> |
9712 |
|
<p> |
9713 |
|
</p> |
9714 |
|
<blockquote class="text"> |
9715 |
|
<p>"OK" - |
9716 |
|
</p> |
9717 |
|
<blockquote class="text"> |
9718 |
|
<p>on success |
9719 |
|
</p> |
9720 |
|
</blockquote> |
9721 |
|
|
9722 |
|
|
9723 |
|
<p>"ERR:<error-code>:<error-message>" - |
9724 |
|
</p> |
9725 |
|
<blockquote class="text"> |
9726 |
|
<p>in case it failed, providing an appropriate error code and error message. |
9727 |
|
</p> |
9728 |
|
</blockquote> |
9729 |
|
|
9730 |
|
|
9731 |
|
</blockquote><p> |
9732 |
|
|
9733 |
|
</p> |
9734 |
|
<p>Example: |
9735 |
|
</p> |
9736 |
|
<p> |
9737 |
|
</p> |
9738 |
|
<blockquote class="text"> |
9739 |
|
<p>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'" |
9740 |
|
</p> |
9741 |
|
<p>S: "OK" |
9742 |
|
</p> |
9743 |
|
</blockquote><p> |
9744 |
|
|
9745 |
|
</p> |
9746 |
<a name="editing_instruments"></a><br /><hr /> |
<a name="editing_instruments"></a><br /><hr /> |
9747 |
<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> |
9748 |
<a name="rfc.section.6.9"></a><h3>6.9. |
<a name="rfc.section.6.9"></a><h3>6.9. |
9770 |
<p> |
<p> |
9771 |
</p> |
</p> |
9772 |
<blockquote class="text"> |
<blockquote class="text"> |
9773 |
<p>EDIT INSTRUMENT <sampler-channel> |
<p>EDIT CHANNEL INSTRUMENT <sampler-channel> |
9774 |
</p> |
</p> |
9775 |
</blockquote><p> |
</blockquote><p> |
9776 |
|
|
9837 |
<p> |
<p> |
9838 |
</p> |
</p> |
9839 |
<blockquote class="text"> |
<blockquote class="text"> |
9840 |
<p>C: "EDIT INSTRUMENT 0" |
<p>C: "EDIT CHANNEL INSTRUMENT 0" |
9841 |
|
</p> |
9842 |
|
<p>S: "OK" |
9843 |
|
</p> |
9844 |
|
</blockquote><p> |
9845 |
|
|
9846 |
|
</p> |
9847 |
|
<a name="file_management"></a><br /><hr /> |
9848 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9849 |
|
<a name="rfc.section.6.10"></a><h3>6.10. |
9850 |
|
Managing Files</h3> |
9851 |
|
|
9852 |
|
<p>You can query detailed informations about files located |
9853 |
|
at the same system where the sampler instance is running on. |
9854 |
|
Using this command set allows to retrieve file informations |
9855 |
|
even remotely from another machine. |
9856 |
|
</p> |
9857 |
|
<a name="GET FILE INSTRUMENTS"></a><br /><hr /> |
9858 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9859 |
|
<a name="rfc.section.6.10.1"></a><h3>6.10.1. |
9860 |
|
Retrieving amount of instruments of a file</h3> |
9861 |
|
|
9862 |
|
<p>The front-end can retrieve the amount of instruments |
9863 |
|
within a given instrument file by sending the |
9864 |
|
following command: |
9865 |
|
</p> |
9866 |
|
<p> |
9867 |
|
</p> |
9868 |
|
<blockquote class="text"> |
9869 |
|
<p>GET FILE INSTRUMENTS <filename> |
9870 |
|
</p> |
9871 |
|
</blockquote><p> |
9872 |
|
|
9873 |
|
</p> |
9874 |
|
<p>Where <filename> is the name of the instrument |
9875 |
|
file (encapsulated into apostrophes, supporting escape |
9876 |
|
sequences as described in chapter |
9877 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
9878 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
9879 |
|
</p> |
9880 |
|
<p>The sampler will try to ask all sampler engines, |
9881 |
|
whether they support the given file and ask the first |
9882 |
|
engine with a positive answer for the amount of |
9883 |
|
instruments. |
9884 |
|
</p> |
9885 |
|
<p>Possible Answers: |
9886 |
|
</p> |
9887 |
|
<p> |
9888 |
|
</p> |
9889 |
|
<blockquote class="text"> |
9890 |
|
<p>On success, the sampler will answer by |
9891 |
|
returning the amount of instruments. |
9892 |
|
|
9893 |
|
</p> |
9894 |
|
<p>"ERR:<error-code>:<error-message>" - |
9895 |
|
</p> |
9896 |
|
<blockquote class="text"> |
9897 |
|
<p>if the file could not be handled |
9898 |
|
</p> |
9899 |
|
</blockquote> |
9900 |
|
|
9901 |
|
|
9902 |
|
</blockquote><p> |
9903 |
|
|
9904 |
|
</p> |
9905 |
|
<p>Examples: |
9906 |
|
</p> |
9907 |
|
<p> |
9908 |
|
</p> |
9909 |
|
<blockquote class="text"> |
9910 |
|
<p>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'" |
9911 |
|
</p> |
9912 |
|
<p>S: "10" |
9913 |
|
</p> |
9914 |
|
</blockquote><p> |
9915 |
|
|
9916 |
|
</p> |
9917 |
|
<a name="LIST FILE INSTRUMENTS"></a><br /><hr /> |
9918 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9919 |
|
<a name="rfc.section.6.10.2"></a><h3>6.10.2. |
9920 |
|
Retrieving all instruments of a file</h3> |
9921 |
|
|
9922 |
|
<p>The front-end can retrieve a list of all instruments |
9923 |
|
within a given instrument file by sending the |
9924 |
|
following command: |
9925 |
|
</p> |
9926 |
|
<p> |
9927 |
|
</p> |
9928 |
|
<blockquote class="text"> |
9929 |
|
<p>LIST FILE INSTRUMENTS <filename> |
9930 |
|
</p> |
9931 |
|
</blockquote><p> |
9932 |
|
|
9933 |
|
</p> |
9934 |
|
<p>Where <filename> is the name of the instrument |
9935 |
|
file (encapsulated into apostrophes, supporting escape |
9936 |
|
sequences as described in chapter |
9937 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
9938 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
9939 |
|
</p> |
9940 |
|
<p>The sampler will try to ask all sampler engines, |
9941 |
|
whether they support the given file and ask the first |
9942 |
|
engine with a positive answer for a list of IDs for the |
9943 |
|
instruments in the given file. |
9944 |
|
</p> |
9945 |
|
<p>Possible Answers: |
9946 |
|
</p> |
9947 |
|
<p> |
9948 |
|
</p> |
9949 |
|
<blockquote class="text"> |
9950 |
|
<p>On success, the sampler will answer by |
9951 |
|
returning a comma separated list of |
9952 |
|
instrument IDs. |
9953 |
|
|
9954 |
|
</p> |
9955 |
|
<p>"ERR:<error-code>:<error-message>" - |
9956 |
|
</p> |
9957 |
|
<blockquote class="text"> |
9958 |
|
<p>if the file could not be handled |
9959 |
|
</p> |
9960 |
|
</blockquote> |
9961 |
|
|
9962 |
|
|
9963 |
|
</blockquote><p> |
9964 |
|
|
9965 |
|
</p> |
9966 |
|
<p>Examples: |
9967 |
|
</p> |
9968 |
|
<p> |
9969 |
|
</p> |
9970 |
|
<blockquote class="text"> |
9971 |
|
<p>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'" |
9972 |
|
</p> |
9973 |
|
<p>S: "0,1,2,3,4,5,6,7,8,9" |
9974 |
|
</p> |
9975 |
|
</blockquote><p> |
9976 |
|
|
9977 |
|
</p> |
9978 |
|
<a name="GET FILE INSTRUMENT INFO"></a><br /><hr /> |
9979 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9980 |
|
<a name="rfc.section.6.10.3"></a><h3>6.10.3. |
9981 |
|
Retrieving informations about one instrument in a file</h3> |
9982 |
|
|
9983 |
|
<p>The front-end can retrieve detailed informations |
9984 |
|
about a specific instrument within a given instrument |
9985 |
|
file by sending the following command: |
9986 |
|
</p> |
9987 |
|
<p> |
9988 |
|
</p> |
9989 |
|
<blockquote class="text"> |
9990 |
|
<p>GET FILE INSTRUMENT INFO <filename> |
9991 |
|
<instr-id> |
9992 |
|
</p> |
9993 |
|
</blockquote><p> |
9994 |
|
|
9995 |
|
</p> |
9996 |
|
<p>Where <filename> is the name of the instrument |
9997 |
|
file (encapsulated into apostrophes, supporting escape |
9998 |
|
sequences as described in chapter |
9999 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
10000 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") and <instr-id> is the numeric |
10001 |
|
instrument ID as returned by the |
10002 |
|
<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. |
10003 |
|
</p> |
10004 |
|
<p>The sampler will try to ask all sampler engines, |
10005 |
|
whether they support the given file and ask the first |
10006 |
|
engine with a positive answer for informations about the |
10007 |
|
specific instrument in the given file. |
10008 |
|
</p> |
10009 |
|
<p>Possible Answers: |
10010 |
|
</p> |
10011 |
|
<p> |
10012 |
|
</p> |
10013 |
|
<blockquote class="text"> |
10014 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
10015 |
|
Each answer line begins with the settings category name |
10016 |
|
followed by a colon and then a space character <SP> and finally |
10017 |
|
the info character string to that setting category. At the |
10018 |
|
moment the following categories are defined: |
10019 |
|
</p> |
10020 |
|
<p> |
10021 |
|
</p> |
10022 |
|
<blockquote class="text"> |
10023 |
|
<p>NAME - |
10024 |
|
</p> |
10025 |
|
<blockquote class="text"> |
10026 |
|
<p>name of the instrument as |
10027 |
|
stored in the instrument file |
10028 |
|
</p> |
10029 |
|
</blockquote> |
10030 |
|
|
10031 |
|
|
10032 |
|
<p>FORMAT_FAMILY - |
10033 |
|
</p> |
10034 |
|
<blockquote class="text"> |
10035 |
|
<p>name of the sampler format |
10036 |
|
of the given instrument |
10037 |
|
</p> |
10038 |
|
</blockquote> |
10039 |
|
|
10040 |
|
|
10041 |
|
<p>FORMAT_VERSION - |
10042 |
|
</p> |
10043 |
|
<blockquote class="text"> |
10044 |
|
<p>version of the sampler format |
10045 |
|
the instrumen is stored as |
10046 |
|
</p> |
10047 |
|
</blockquote> |
10048 |
|
|
10049 |
|
|
10050 |
|
<p>PRODUCT - |
10051 |
|
</p> |
10052 |
|
<blockquote class="text"> |
10053 |
|
<p>official product name of the |
10054 |
|
instrument as stored in the file |
10055 |
|
|
10056 |
|
</p> |
10057 |
|
</blockquote> |
10058 |
|
|
10059 |
|
|
10060 |
|
<p>ARTISTS - |
10061 |
|
</p> |
10062 |
|
<blockquote class="text"> |
10063 |
|
<p>artists / sample library |
10064 |
|
vendor of the instrument |
10065 |
|
</p> |
10066 |
|
</blockquote> |
10067 |
|
|
10068 |
|
|
10069 |
|
<p>KEY_BINDINGS - |
10070 |
|
</p> |
10071 |
|
<blockquote class="text"> |
10072 |
|
<p>comma separated list of integer values representing |
10073 |
|
the instrument's key mapping in the range between 0 .. 127, |
10074 |
|
reflecting the analog meaning of the MIDI specification. |
10075 |
|
</p> |
10076 |
|
</blockquote> |
10077 |
|
|
10078 |
|
|
10079 |
|
<p>KEYSWITCH_BINDINGS - |
10080 |
|
</p> |
10081 |
|
<blockquote class="text"> |
10082 |
|
<p>comma separated list of integer values representing |
10083 |
|
the instrument's keyswitch mapping in the range between 0 .. 127, |
10084 |
|
reflecting the analog meaning of the MIDI specification. |
10085 |
|
</p> |
10086 |
|
</blockquote> |
10087 |
|
|
10088 |
|
|
10089 |
|
</blockquote> |
10090 |
|
|
10091 |
|
|
10092 |
|
</blockquote><p> |
10093 |
|
|
10094 |
|
</p> |
10095 |
|
<p>The mentioned fields above don't have to be in particular order. |
10096 |
|
</p> |
10097 |
|
<p>Example: |
10098 |
|
</p> |
10099 |
|
<p> |
10100 |
|
</p> |
10101 |
|
<blockquote class="text"> |
10102 |
|
<p>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0" |
10103 |
|
</p> |
10104 |
|
<p>S: "NAME: Lunatic Loops" |
10105 |
|
</p> |
10106 |
|
<p> "FORMAT_FAMILY: GIG" |
10107 |
|
</p> |
10108 |
|
<p> "FORMAT_VERSION: 3" |
10109 |
|
</p> |
10110 |
|
<p> "PRODUCT: The Backbone Bongo Beats" |
10111 |
|
</p> |
10112 |
|
<p> "ARTISTS: Jimmy the Fish" |
10113 |
|
</p> |
10114 |
|
<p> "." |
10115 |
|
</p> |
10116 |
|
</blockquote><p> |
10117 |
|
|
10118 |
|
</p> |
10119 |
|
<a name="effects"></a><br /><hr /> |
10120 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10121 |
|
<a name="rfc.section.6.11"></a><h3>6.11. |
10122 |
|
Managing Effects</h3> |
10123 |
|
|
10124 |
|
<p>Audio effects (e.g. reverb, delay, compression) can be |
10125 |
|
applied to the audio signals generated by the sampler. The |
10126 |
|
sampler usually provides a set of internal audio effects for |
10127 |
|
this task. The exact set of effects depends on the availability |
10128 |
|
of third party effect plugins installed on the system where the |
10129 |
|
sampler runs on. |
10130 |
|
</p> |
10131 |
|
<p>At the moment only "send effects" are supported. Support for |
10132 |
|
"insert effects" and "master effects" is planned to be added at |
10133 |
|
a later point. |
10134 |
|
</p> |
10135 |
|
<p>The following commands allow to retrieve the set of internal |
10136 |
|
effects available to the sampler, detailed informations about |
10137 |
|
those effects and to create and destroy instances of such |
10138 |
|
effects. After an instance of an effect is created, the effect |
10139 |
|
instance can be inserted into the audio signal path of the |
10140 |
|
sampler, e.g. as send effect. |
10141 |
|
</p> |
10142 |
|
<p>The sampler allows to create an arbitrary amount of so called |
10143 |
|
send effect chains. Each effect chain can host an arbitrary |
10144 |
|
amount of effect instances. The output of the first effect |
10145 |
|
instance in an effect chain is fed to the input of the second |
10146 |
|
effect instance of the chain and so on. So effects in one chain |
10147 |
|
are processed sequentially. Send effect chains however are |
10148 |
|
processed in parallel to other send effect chains. Audio signals |
10149 |
|
of sampler channels are fed to send effects by creating FX sends |
10150 |
|
to the respective sampler channel and assigning a destination |
10151 |
|
send effect to that FX by using the |
10152 |
|
<a class='info' href='#SET FX_SEND EFFECT'>"SET FX_SEND EFFECT"<span> (</span><span class='info'>Assigning destination effect to an effect send</span><span>)</span></a> |
10153 |
|
command. The latter allows to route the FX send to the beginning |
10154 |
|
of a send effect chain, as well as directly to any other |
10155 |
|
position of the send effect chain. |
10156 |
|
</p> |
10157 |
|
<a name="GET AVAILABLE_EFFECTS"></a><br /><hr /> |
10158 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10159 |
|
<a name="rfc.section.6.11.1"></a><h3>6.11.1. |
10160 |
|
Retrieve amount of available effects</h3> |
10161 |
|
|
10162 |
|
<p>The front-end can retrieve the amount of internal |
10163 |
|
effects, available to the sampler by sending |
10164 |
|
the following command: |
10165 |
|
</p> |
10166 |
|
<p> |
10167 |
|
</p> |
10168 |
|
<blockquote class="text"> |
10169 |
|
<p>GET AVAILABLE_EFFECTS |
10170 |
|
</p> |
10171 |
|
</blockquote><p> |
10172 |
|
|
10173 |
|
</p> |
10174 |
|
<p>Possible Answers: |
10175 |
|
</p> |
10176 |
|
<p> |
10177 |
|
</p> |
10178 |
|
<blockquote class="text"> |
10179 |
|
<p>The sampler will answer by returning the current |
10180 |
|
number of effects available to the sampler. |
10181 |
|
</p> |
10182 |
|
</blockquote><p> |
10183 |
|
|
10184 |
|
</p> |
10185 |
|
<p>Examples: |
10186 |
|
</p> |
10187 |
|
<p> |
10188 |
|
</p> |
10189 |
|
<blockquote class="text"> |
10190 |
|
<p>C: "GET AVAILABLE_EFFECTS" |
10191 |
|
</p> |
10192 |
|
<p>S: "129" |
10193 |
|
</p> |
10194 |
|
</blockquote><p> |
10195 |
|
|
10196 |
|
</p> |
10197 |
|
<a name="LIST AVAILABLE_EFFECTS"></a><br /><hr /> |
10198 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10199 |
|
<a name="rfc.section.6.11.2"></a><h3>6.11.2. |
10200 |
|
Get list of available effects</h3> |
10201 |
|
|
10202 |
|
<p>The set of available internal effects can change at |
10203 |
|
runtime. The front-end can retrieve the list of internal |
10204 |
|
effects, available to the sampler by sending the following |
10205 |
|
command: |
10206 |
|
</p> |
10207 |
|
<p> |
10208 |
|
</p> |
10209 |
|
<blockquote class="text"> |
10210 |
|
<p>LIST AVAILABLE_EFFECTS |
10211 |
|
</p> |
10212 |
|
</blockquote><p> |
10213 |
|
|
10214 |
|
</p> |
10215 |
|
<p>Possible Answers: |
10216 |
|
</p> |
10217 |
|
<p> |
10218 |
|
</p> |
10219 |
|
<blockquote class="text"> |
10220 |
|
<p>The sampler will answer by returning a comma |
10221 |
|
separated list with numerical IDs of effects. Note: |
10222 |
|
the numercial ID of an effect is generated by the |
10223 |
|
sampler for the current moment. The numerical ID of |
10224 |
|
the same effect can change at runtime, e.g. when the |
10225 |
|
user requests a rescan of available effect plugins. |
10226 |
|
|
10227 |
|
</p> |
10228 |
|
</blockquote><p> |
10229 |
|
|
10230 |
|
</p> |
10231 |
|
<p>Example: |
10232 |
|
</p> |
10233 |
|
<p> |
10234 |
|
</p> |
10235 |
|
<blockquote class="text"> |
10236 |
|
<p>C: "LIST AVAILABLE_EFFECTS" |
10237 |
|
</p> |
10238 |
|
<p>S: "5,6,7,120,121,122,123,124" |
10239 |
|
</p> |
10240 |
|
</blockquote><p> |
10241 |
|
|
10242 |
|
</p> |
10243 |
|
<a name="GET EFFECT INFO"></a><br /><hr /> |
10244 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10245 |
|
<a name="rfc.section.6.11.3"></a><h3>6.11.3. |
10246 |
|
Retrieving general information about an effect</h3> |
10247 |
|
|
10248 |
|
<p>The front-end can ask for general informations about an |
10249 |
|
effect by sending the following command: |
10250 |
|
</p> |
10251 |
|
<p> |
10252 |
|
</p> |
10253 |
|
<blockquote class="text"> |
10254 |
|
<p>GET EFFECT INFO <effect-index> |
10255 |
|
</p> |
10256 |
|
</blockquote><p> |
10257 |
|
|
10258 |
|
</p> |
10259 |
|
<p>Where <effect-index> is the numerical ID of an |
10260 |
|
effect as returned by the |
10261 |
|
<a class='info' href='#LIST AVAILABLE_EFFECTS'>"LIST AVAILABLE_EFFECTS"<span> (</span><span class='info'>Get list of available effects</span><span>)</span></a> |
10262 |
|
command. |
10263 |
|
</p> |
10264 |
|
<p>Possible Answers: |
10265 |
|
</p> |
10266 |
|
<p> |
10267 |
|
</p> |
10268 |
|
<blockquote class="text"> |
10269 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
10270 |
|
Each answer line begins with the effect information |
10271 |
|
category name, followed by a colon and then a space |
10272 |
|
character <SP> and finally the info character |
10273 |
|
string to that effect information category. At the |
10274 |
|
moment the following categories are defined: |
10275 |
|
</p> |
10276 |
|
<p> |
10277 |
|
</p> |
10278 |
|
<blockquote class="text"> |
10279 |
|
<p>SYSTEM - |
10280 |
|
</p> |
10281 |
|
<blockquote class="text"> |
10282 |
|
<p>name of the effect plugin system |
10283 |
|
the effect is based on |
10284 |
|
(e.g. "LADSPA") |
10285 |
|
</p> |
10286 |
|
</blockquote> |
10287 |
|
|
10288 |
|
|
10289 |
|
<p>MODULE - |
10290 |
|
</p> |
10291 |
|
<blockquote class="text"> |
10292 |
|
<p>module of the effect plugin |
10293 |
|
system that contains this effect, |
10294 |
|
the module is usually the |
10295 |
|
dynamic-linked library (DLL) |
10296 |
|
filename of the effect plugin, |
10297 |
|
including full path (note that this |
10298 |
|
filename may contain |
10299 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10300 |
|
</p> |
10301 |
|
</blockquote> |
10302 |
|
|
10303 |
|
|
10304 |
|
<p>NAME - |
10305 |
|
</p> |
10306 |
|
<blockquote class="text"> |
10307 |
|
<p>character string defining the |
10308 |
|
unique name of the effect within its |
10309 |
|
module (note that the character |
10310 |
|
string may contain |
10311 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10312 |
|
</p> |
10313 |
|
</blockquote> |
10314 |
|
|
10315 |
|
|
10316 |
|
<p>DESCRIPTION - |
10317 |
|
</p> |
10318 |
|
<blockquote class="text"> |
10319 |
|
<p>human readable name of the |
10320 |
|
effect, intended to be displayed in |
10321 |
|
user interfaces (note that the |
10322 |
|
character string may contain |
10323 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10324 |
|
</p> |
10325 |
|
</blockquote> |
10326 |
|
|
10327 |
|
|
10328 |
|
</blockquote> |
10329 |
|
|
10330 |
|
|
10331 |
|
</blockquote><p> |
10332 |
|
|
10333 |
|
</p> |
10334 |
|
<p>The mentioned fields above don't have to be in particular order. |
10335 |
|
</p> |
10336 |
|
<p>Example: |
10337 |
|
</p> |
10338 |
|
<p> |
10339 |
|
</p> |
10340 |
|
<blockquote class="text"> |
10341 |
|
<p>C: "GET EFFECT INFO 121" |
10342 |
|
</p> |
10343 |
|
<p>S: "SYSTEM: LADSPA" |
10344 |
|
</p> |
10345 |
|
<p> "MODULE: /usr/lib/ladspa/lowpass_iir_1891.so" |
10346 |
|
</p> |
10347 |
|
<p> "NAME: lowpass_iir" |
10348 |
|
</p> |
10349 |
|
<p> "DESCRIPTION: Glame Lowpass Filter" |
10350 |
|
</p> |
10351 |
|
<p> "." |
10352 |
|
</p> |
10353 |
|
</blockquote><p> |
10354 |
|
|
10355 |
|
</p> |
10356 |
|
<a name="CREATE EFFECT_INSTANCE"></a><br /><hr /> |
10357 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10358 |
|
<a name="rfc.section.6.11.4"></a><h3>6.11.4. |
10359 |
|
Creating an instance of an effect by its portable ID</h3> |
10360 |
|
|
10361 |
|
<p>The front-end can spawn an instance of the desired |
10362 |
|
effect by sending the following command: |
10363 |
|
</p> |
10364 |
|
<p> |
10365 |
|
</p> |
10366 |
|
<blockquote class="text"> |
10367 |
|
<p>CREATE EFFECT_INSTANCE <effect-system> <module> <effect-name> |
10368 |
|
</p> |
10369 |
|
</blockquote><p> |
10370 |
|
|
10371 |
|
</p> |
10372 |
|
<p>Where <effect-system> is the "SYSTEM" field, |
10373 |
|
<module> the "MODULE" field and <effect-name> |
10374 |
|
the "NAME" field as returned by the |
10375 |
|
<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> |
10376 |
|
command. The filename of argument <module> and the |
10377 |
|
character string of argument <effect-name> may contain |
10378 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
10379 |
|
</p> |
10380 |
|
<p>The sampler will try to load the requested effect and to |
10381 |
|
create an instance of it. To allow loading the same effect |
10382 |
|
on a different machine, probably even running a completely |
10383 |
|
different operating system (e.g. Linux vs. Windows), the |
10384 |
|
sampler tries to match <module> "softly". That means |
10385 |
|
it first tries to find an effect that exactly matches the |
10386 |
|
given <module> argument. If there is no exact match, |
10387 |
|
the sampler will try to lower the restrictions on matching |
10388 |
|
the <module> argument more and more, e.g. by ignoring |
10389 |
|
upper / lower case differences and by ignoring the path of |
10390 |
|
the DLL filename and file extension. If there is still no |
10391 |
|
match at the end, the sampler will try to ignore the |
10392 |
|
<module> argument completely and as a last resort |
10393 |
|
search for an effect that only matches the given |
10394 |
|
<effect-system> and <effect-name> arguments. |
10395 |
|
</p> |
10396 |
|
<p>Possible Answers: |
10397 |
|
</p> |
10398 |
|
<p> |
10399 |
|
</p> |
10400 |
|
<blockquote class="text"> |
10401 |
|
<p>"OK[<effect-instance>]" - |
10402 |
|
</p> |
10403 |
|
<blockquote class="text"> |
10404 |
|
<p>in case the effect instance was |
10405 |
|
successfully created, where |
10406 |
|
<effect-instance> is the numerical ID |
10407 |
|
of the new effect instance |
10408 |
|
</p> |
10409 |
|
</blockquote> |
10410 |
|
|
10411 |
|
|
10412 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
10413 |
|
</p> |
10414 |
|
<blockquote class="text"> |
10415 |
|
<p>in case the effect instance was spawned |
10416 |
|
successfully, but there are noteworthy |
10417 |
|
issue(s) related, providing an appropriate |
10418 |
|
warning code and warning message |
10419 |
|
</p> |
10420 |
|
</blockquote> |
10421 |
|
|
10422 |
|
|
10423 |
|
<p>"ERR:<error-code>:<error-message>" - |
10424 |
|
</p> |
10425 |
|
<blockquote class="text"> |
10426 |
|
<p>if the effect could not be instantiated |
10427 |
|
</p> |
10428 |
|
</blockquote> |
10429 |
|
|
10430 |
|
|
10431 |
|
</blockquote><p> |
10432 |
|
|
10433 |
|
</p> |
10434 |
|
<p>Examples: |
10435 |
|
</p> |
10436 |
|
<p> |
10437 |
|
</p> |
10438 |
|
<blockquote class="text"> |
10439 |
|
<p>C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/mod_delay_1419.so' 'modDelay'" |
10440 |
|
</p> |
10441 |
|
<p>S: "OK[0]" |
10442 |
|
</p> |
10443 |
|
</blockquote><p> |
10444 |
|
|
10445 |
|
</p> |
10446 |
|
<a name="CREATE EFFECT_INSTANCE (non-portable)"></a><br /><hr /> |
10447 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10448 |
|
<a name="rfc.section.6.11.5"></a><h3>6.11.5. |
10449 |
|
Creating an instance of an effect by its numerical ID</h3> |
10450 |
|
|
10451 |
|
<p>The front-end can spawn an instance of the desired |
10452 |
|
effect by sending the following command: |
10453 |
|
</p> |
10454 |
|
<p> |
10455 |
|
</p> |
10456 |
|
<blockquote class="text"> |
10457 |
|
<p>CREATE EFFECT_INSTANCE <effect-index> |
10458 |
|
</p> |
10459 |
|
</blockquote><p> |
10460 |
|
|
10461 |
|
</p> |
10462 |
|
<p>Where <effect-index> is the numerical ID of the |
10463 |
|
effect as returned by the |
10464 |
|
<a class='info' href='#LIST AVAILABLE_EFFECTS'>"LIST AVAILABLE_EFFECTS"<span> (</span><span class='info'>Get list of available effects</span><span>)</span></a> |
10465 |
|
command. |
10466 |
|
</p> |
10467 |
|
<p>The sampler will try to load the requested effect and to |
10468 |
|
create an instance of it. |
10469 |
|
</p> |
10470 |
|
<p>Note: Since the numerical ID of a certain effect can |
10471 |
|
change at any time, you should not use this command in |
10472 |
|
LSCP files to restore a certain effect at a later time! To |
10473 |
|
store a sampler session including all its effects, use the |
10474 |
|
<a class='info' href='#CREATE EFFECT_INSTANCE'>portable text-based |
10475 |
|
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 |
10476 |
|
allows to restore a sampler session with all its effects |
10477 |
|
also on other machines, possibly even running a completely |
10478 |
|
different operating system (e.g. Linux vs. Windows), with |
10479 |
|
different plugin directories or plugin DLL names. |
10480 |
|
</p> |
10481 |
|
<p>Possible Answers: |
10482 |
|
</p> |
10483 |
|
<p> |
10484 |
|
</p> |
10485 |
|
<blockquote class="text"> |
10486 |
|
<p>"OK[<effect-instance>]" - |
10487 |
|
</p> |
10488 |
|
<blockquote class="text"> |
10489 |
|
<p>in case the effect instance was |
10490 |
|
successfully created, where |
10491 |
|
<effect-instance> is the numerical ID |
10492 |
|
of the new effect instance |
10493 |
|
</p> |
10494 |
|
</blockquote> |
10495 |
|
|
10496 |
|
|
10497 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
10498 |
|
</p> |
10499 |
|
<blockquote class="text"> |
10500 |
|
<p>in case the effect instance was spawned |
10501 |
|
successfully, but there are noteworthy |
10502 |
|
issue(s) related, providing an appropriate |
10503 |
|
warning code and warning message |
10504 |
|
</p> |
10505 |
|
</blockquote> |
10506 |
|
|
10507 |
|
|
10508 |
|
<p>"ERR:<error-code>:<error-message>" - |
10509 |
|
</p> |
10510 |
|
<blockquote class="text"> |
10511 |
|
<p>if the effect could not be instantiated |
10512 |
|
</p> |
10513 |
|
</blockquote> |
10514 |
|
|
10515 |
|
|
10516 |
|
</blockquote><p> |
10517 |
|
|
10518 |
|
</p> |
10519 |
|
<p>Examples: |
10520 |
|
</p> |
10521 |
|
<p> |
10522 |
|
</p> |
10523 |
|
<blockquote class="text"> |
10524 |
|
<p>C: "CREATE EFFECT_INSTANCE 72" |
10525 |
|
</p> |
10526 |
|
<p>S: "OK[5]" |
10527 |
|
</p> |
10528 |
|
</blockquote><p> |
10529 |
|
|
10530 |
|
</p> |
10531 |
|
<a name="DESTROY EFFECT_INSTANCE"></a><br /><hr /> |
10532 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10533 |
|
<a name="rfc.section.6.11.6"></a><h3>6.11.6. |
10534 |
|
Destroy an effect instance</h3> |
10535 |
|
|
10536 |
|
<p>The front-end can destroy an unusued effect instance and |
10537 |
|
thus freeing it from memory by sending the following command: |
10538 |
|
</p> |
10539 |
|
<p> |
10540 |
|
</p> |
10541 |
|
<blockquote class="text"> |
10542 |
|
<p>DESTROY EFFECT_INSTANCE <effect-instance> |
10543 |
|
</p> |
10544 |
|
</blockquote><p> |
10545 |
|
|
10546 |
|
</p> |
10547 |
|
<p>Where <effect-instance> is the numerical ID of the |
10548 |
|
effect instance as returned by the |
10549 |
|
<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 |
10550 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
10551 |
|
command. |
10552 |
|
</p> |
10553 |
|
<p>The effect instance can only be destroyed if it's not |
10554 |
|
used in any part of the sampler's audio signal path anymore. |
10555 |
|
If the effect instance is still in use somewhere, trying to |
10556 |
|
destroy the effect instance will result in an error |
10557 |
|
message. |
10558 |
|
</p> |
10559 |
|
<p>Possible Answers: |
10560 |
|
</p> |
10561 |
|
<p> |
10562 |
|
</p> |
10563 |
|
<blockquote class="text"> |
10564 |
|
<p>"OK" - |
10565 |
|
</p> |
10566 |
|
<blockquote class="text"> |
10567 |
|
<p>in case the effect instance was successfully destroyed |
10568 |
|
</p> |
10569 |
|
</blockquote> |
10570 |
|
|
10571 |
|
|
10572 |
|
<p>"ERR:<error-code>:<error-message>" - |
10573 |
|
</p> |
10574 |
|
<blockquote class="text"> |
10575 |
|
<p>in case it failed, providing an appropriate error code and |
10576 |
|
error message |
10577 |
|
</p> |
10578 |
|
</blockquote> |
10579 |
|
|
10580 |
|
|
10581 |
|
</blockquote><p> |
10582 |
|
|
10583 |
|
</p> |
10584 |
|
<p>Examples: |
10585 |
|
</p> |
10586 |
|
<p> |
10587 |
|
</p> |
10588 |
|
<blockquote class="text"> |
10589 |
|
<p>C: "DESTROY EFFECT_INSTANCE 5" |
10590 |
|
</p> |
10591 |
|
<p>S: "OK" |
10592 |
|
</p> |
10593 |
|
</blockquote><p> |
10594 |
|
|
10595 |
|
</p> |
10596 |
|
<a name="GET EFFECT_INSTANCES"></a><br /><hr /> |
10597 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10598 |
|
<a name="rfc.section.6.11.7"></a><h3>6.11.7. |
10599 |
|
Retrieve amount of effect instances</h3> |
10600 |
|
|
10601 |
|
<p>The front-end can retrieve the current amount of effect |
10602 |
|
instances by sending the following command: |
10603 |
|
</p> |
10604 |
|
<p> |
10605 |
|
</p> |
10606 |
|
<blockquote class="text"> |
10607 |
|
<p>GET EFFECT_INSTANCES |
10608 |
|
</p> |
10609 |
|
</blockquote><p> |
10610 |
|
|
10611 |
|
</p> |
10612 |
|
<p>Possible Answers: |
10613 |
|
</p> |
10614 |
|
<p> |
10615 |
|
</p> |
10616 |
|
<blockquote class="text"> |
10617 |
|
<p>The sampler will answer by returning the current |
10618 |
|
number of effect instances created and not yet |
10619 |
|
destroyed in the current sampler session. |
10620 |
|
</p> |
10621 |
|
</blockquote><p> |
10622 |
|
|
10623 |
|
</p> |
10624 |
|
<p>Examples: |
10625 |
|
</p> |
10626 |
|
<p> |
10627 |
|
</p> |
10628 |
|
<blockquote class="text"> |
10629 |
|
<p>C: "GET EFFECT_INSTANCES" |
10630 |
|
</p> |
10631 |
|
<p>S: "14" |
10632 |
|
</p> |
10633 |
|
</blockquote><p> |
10634 |
|
|
10635 |
|
</p> |
10636 |
|
<a name="LIST EFFECT_INSTANCES"></a><br /><hr /> |
10637 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10638 |
|
<a name="rfc.section.6.11.8"></a><h3>6.11.8. |
10639 |
|
Get list of effect instances</h3> |
10640 |
|
|
10641 |
|
<p>The front-end can retrieve the current list of effect |
10642 |
|
instances by sending the following command: |
10643 |
|
</p> |
10644 |
|
<p> |
10645 |
|
</p> |
10646 |
|
<blockquote class="text"> |
10647 |
|
<p>LIST EFFECT_INSTANCES |
10648 |
|
</p> |
10649 |
|
</blockquote><p> |
10650 |
|
|
10651 |
|
</p> |
10652 |
|
<p>Possible Answers: |
10653 |
|
</p> |
10654 |
|
<p> |
10655 |
|
</p> |
10656 |
|
<blockquote class="text"> |
10657 |
|
<p>The sampler will answer by returning a comma |
10658 |
|
separated list with numerical IDs of effects |
10659 |
|
instances. |
10660 |
|
|
10661 |
|
</p> |
10662 |
|
</blockquote><p> |
10663 |
|
|
10664 |
|
</p> |
10665 |
|
<p>Example: |
10666 |
|
</p> |
10667 |
|
<p> |
10668 |
|
</p> |
10669 |
|
<blockquote class="text"> |
10670 |
|
<p>C: "LIST EFFECT_INSTANCES" |
10671 |
|
</p> |
10672 |
|
<p>S: "9,11,14,15,16,17,25" |
10673 |
|
</p> |
10674 |
|
</blockquote><p> |
10675 |
|
|
10676 |
|
</p> |
10677 |
|
<a name="GET EFFECT_INSTANCE INFO"></a><br /><hr /> |
10678 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10679 |
|
<a name="rfc.section.6.11.9"></a><h3>6.11.9. |
10680 |
|
Retrieving current information about an effect instance</h3> |
10681 |
|
|
10682 |
|
<p>The front-end can ask for the current informations about |
10683 |
|
a particular effect instance by sending the following command: |
10684 |
|
</p> |
10685 |
|
<p> |
10686 |
|
</p> |
10687 |
|
<blockquote class="text"> |
10688 |
|
<p>GET EFFECT_INSTANCE INFO <effect-instance> |
10689 |
|
</p> |
10690 |
|
</blockquote><p> |
10691 |
|
|
10692 |
|
</p> |
10693 |
|
<p>Where <effect-instance> is the numerical ID of an |
10694 |
|
effect instance as returned by the |
10695 |
|
<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> |
10696 |
|
or |
10697 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
10698 |
|
command. |
10699 |
|
</p> |
10700 |
|
<p>Possible Answers: |
10701 |
|
</p> |
10702 |
|
<p> |
10703 |
|
</p> |
10704 |
|
<blockquote class="text"> |
10705 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
10706 |
|
Each answer line begins with the information |
10707 |
|
category name, followed by a colon and then a space |
10708 |
|
character <SP> and finally the info character |
10709 |
|
string to that information category. At the |
10710 |
|
moment the following categories are defined: |
10711 |
|
</p> |
10712 |
|
<p> |
10713 |
|
</p> |
10714 |
|
<blockquote class="text"> |
10715 |
|
<p>SYSTEM - |
10716 |
|
</p> |
10717 |
|
<blockquote class="text"> |
10718 |
|
<p>name of the effect plugin system |
10719 |
|
the effect is based on |
10720 |
|
(e.g. "LADSPA") |
10721 |
|
</p> |
10722 |
|
</blockquote> |
10723 |
|
|
10724 |
|
|
10725 |
|
<p>MODULE - |
10726 |
|
</p> |
10727 |
|
<blockquote class="text"> |
10728 |
|
<p>module of the effect plugin |
10729 |
|
system that contains this effect, |
10730 |
|
the module is usually the |
10731 |
|
dynamic-linked library (DLL) |
10732 |
|
filename of the effect plugin, |
10733 |
|
including full path (note that this |
10734 |
|
filename may contain |
10735 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10736 |
|
</p> |
10737 |
|
</blockquote> |
10738 |
|
|
10739 |
|
|
10740 |
|
<p>NAME - |
10741 |
|
</p> |
10742 |
|
<blockquote class="text"> |
10743 |
|
<p>character string defining the |
10744 |
|
unique name of the effect within its |
10745 |
|
module (note that the character |
10746 |
|
string may contain |
10747 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10748 |
|
</p> |
10749 |
|
</blockquote> |
10750 |
|
|
10751 |
|
|
10752 |
|
<p>DESCRIPTION - |
10753 |
|
</p> |
10754 |
|
<blockquote class="text"> |
10755 |
|
<p>human readable name of the |
10756 |
|
effect, intended to be displayed in |
10757 |
|
user interfaces (note that the |
10758 |
|
character string may contain |
10759 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10760 |
|
</p> |
10761 |
|
</blockquote> |
10762 |
|
|
10763 |
|
|
10764 |
|
<p>INPUT_CONTROLS - |
10765 |
|
</p> |
10766 |
|
<blockquote class="text"> |
10767 |
|
<p>amount of input controls the |
10768 |
|
effect instance provides, to allow |
10769 |
|
controlling the effect parameters in |
10770 |
|
realtime |
10771 |
|
</p> |
10772 |
|
</blockquote> |
10773 |
|
|
10774 |
|
|
10775 |
|
</blockquote> |
10776 |
|
|
10777 |
|
|
10778 |
|
</blockquote><p> |
10779 |
|
|
10780 |
|
</p> |
10781 |
|
<p>The mentioned fields above don't have to be in particular order. |
10782 |
|
</p> |
10783 |
|
<p>Example: |
10784 |
|
</p> |
10785 |
|
<p> |
10786 |
|
</p> |
10787 |
|
<blockquote class="text"> |
10788 |
|
<p>C: "GET EFFECT_INSTANCE INFO 3" |
10789 |
|
</p> |
10790 |
|
<p>S: "SYSTEM: LADSPA" |
10791 |
|
</p> |
10792 |
|
<p> "MODULE: /usr/lib/ladspa/mod_delay_1419.so" |
10793 |
|
</p> |
10794 |
|
<p> "NAME: modDelay" |
10795 |
|
</p> |
10796 |
|
<p> "DESCRIPTION: Modulatable delay" |
10797 |
|
</p> |
10798 |
|
<p> "INPUT_CONTROLS: 1" |
10799 |
|
</p> |
10800 |
|
<p> "." |
10801 |
|
</p> |
10802 |
|
</blockquote><p> |
10803 |
|
|
10804 |
|
</p> |
10805 |
|
<a name="GET EFFECT_INSTANCE_INPUT_CONTROL INFO"></a><br /><hr /> |
10806 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10807 |
|
<a name="rfc.section.6.11.10"></a><h3>6.11.10. |
10808 |
|
Retrieving information about an effect parameter</h3> |
10809 |
|
|
10810 |
|
<p>Effects typically provide a certain set of effect |
10811 |
|
parameters which can be altered by the user in realtime |
10812 |
|
(e.g. depth of a reverb effect, duration of a delay effect, |
10813 |
|
dry / wet signal ratio). Those controllable effect parameters |
10814 |
|
are called "input controls". The front-end can ask for the |
10815 |
|
current informations of an effect instance's input control |
10816 |
|
by sending the following command: |
10817 |
|
</p> |
10818 |
|
<p> |
10819 |
|
</p> |
10820 |
|
<blockquote class="text"> |
10821 |
|
<p>GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-control> |
10822 |
|
</p> |
10823 |
|
</blockquote><p> |
10824 |
|
|
10825 |
|
</p> |
10826 |
|
<p>Where <effect-instance> is the numerical ID of an |
10827 |
|
effect instance as returned by the |
10828 |
|
<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> |
10829 |
|
or |
10830 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
10831 |
|
command and <input-control> is the index of the input |
10832 |
|
control within the numerical bounds as returned by the |
10833 |
|
"INPUT_CONTROLS" field of the |
10834 |
|
<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> |
10835 |
|
command. |
10836 |
|
</p> |
10837 |
|
<p>Possible Answers: |
10838 |
|
</p> |
10839 |
|
<p> |
10840 |
|
</p> |
10841 |
|
<blockquote class="text"> |
10842 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
10843 |
|
Each answer line begins with the information |
10844 |
|
category name, followed by a colon and then a space |
10845 |
|
character <SP> and finally the info character |
10846 |
|
string to that information category. There are |
10847 |
|
information categories which are always returned, |
10848 |
|
independent of the respective effect parameter and |
10849 |
|
there are optional information categories |
10850 |
|
which are only shown for certain effect parameters. |
10851 |
|
At the moment the following categories are defined: |
10852 |
|
</p> |
10853 |
|
<p> |
10854 |
|
</p> |
10855 |
|
<blockquote class="text"> |
10856 |
|
<p>DESCRIPTION - |
10857 |
|
</p> |
10858 |
|
<blockquote class="text"> |
10859 |
|
<p>(always returned) |
10860 |
|
human readable name of the |
10861 |
|
effect parameter, intended to be |
10862 |
|
displayed in user interfaces (note |
10863 |
|
that the character string may |
10864 |
|
contain <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
10865 |
|
</p> |
10866 |
|
</blockquote> |
10867 |
|
|
10868 |
|
|
10869 |
|
<p>VALUE - |
10870 |
|
</p> |
10871 |
|
<blockquote class="text"> |
10872 |
|
<p> |
10873 |
|
(always returned) |
10874 |
|
current (optional dotted) |
10875 |
|
floating point value of this effect |
10876 |
|
parameter |
10877 |
|
</p> |
10878 |
|
</blockquote> |
10879 |
|
|
10880 |
|
|
10881 |
|
<p>RANGE_MIN - |
10882 |
|
</p> |
10883 |
|
<blockquote class="text"> |
10884 |
|
<p> |
10885 |
|
(optionally returned) |
10886 |
|
minimum allowed value for this |
10887 |
|
effect parameter |
10888 |
|
</p> |
10889 |
|
</blockquote> |
10890 |
|
|
10891 |
|
|
10892 |
|
<p>RANGE_MAX - |
10893 |
|
</p> |
10894 |
|
<blockquote class="text"> |
10895 |
|
<p> |
10896 |
|
(optionally returned) |
10897 |
|
maximum allowed value for this |
10898 |
|
effect parameter |
10899 |
|
</p> |
10900 |
|
</blockquote> |
10901 |
|
|
10902 |
|
|
10903 |
|
<p>POSSIBILITIES - |
10904 |
|
</p> |
10905 |
|
<blockquote class="text"> |
10906 |
|
<p> |
10907 |
|
(optionally returned) |
10908 |
|
comma separated list of |
10909 |
|
(optional dotted) floating point |
10910 |
|
numbers, reflecting the exact set of |
10911 |
|
possible values for this effect |
10912 |
|
parameter |
10913 |
|
</p> |
10914 |
|
</blockquote> |
10915 |
|
|
10916 |
|
|
10917 |
|
<p>DEFAULT - |
10918 |
|
</p> |
10919 |
|
<blockquote class="text"> |
10920 |
|
<p> |
10921 |
|
(optionally returned) |
10922 |
|
default value of this effect |
10923 |
|
parameter |
10924 |
|
</p> |
10925 |
|
</blockquote> |
10926 |
|
|
10927 |
|
|
10928 |
|
</blockquote> |
10929 |
|
|
10930 |
|
|
10931 |
|
</blockquote><p> |
10932 |
|
|
10933 |
|
</p> |
10934 |
|
<p>The mentioned fields above don't have to be in particular order. |
10935 |
|
</p> |
10936 |
|
<p>Example: |
10937 |
|
</p> |
10938 |
|
<p> |
10939 |
|
</p> |
10940 |
|
<blockquote class="text"> |
10941 |
|
<p>C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0" |
10942 |
|
</p> |
10943 |
|
<p>S: "DESCRIPTION: Base delay (s)" |
10944 |
|
</p> |
10945 |
|
<p> "VALUE: 0.500" |
10946 |
|
</p> |
10947 |
|
<p> "RANGE_MIN: 0.000" |
10948 |
|
</p> |
10949 |
|
<p> "." |
10950 |
|
</p> |
10951 |
|
</blockquote><p> |
10952 |
|
|
10953 |
|
</p> |
10954 |
|
<a name="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE"></a><br /><hr /> |
10955 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10956 |
|
<a name="rfc.section.6.11.11"></a><h3>6.11.11. |
10957 |
|
Altering an effect parameter</h3> |
10958 |
|
|
10959 |
|
<p>The front-end can alter the current value of an effect |
10960 |
|
parameter by sending the following command: |
10961 |
|
</p> |
10962 |
|
<p> |
10963 |
|
</p> |
10964 |
|
<blockquote class="text"> |
10965 |
|
<p>SET EFFECT_INSTANCE_INPUT_CONTROL VALUE <effect-instance> <input-control> <value> |
10966 |
|
</p> |
10967 |
|
</blockquote><p> |
10968 |
|
|
10969 |
|
</p> |
10970 |
|
<p>Where <effect-instance> is the numerical ID of the |
10971 |
|
effect instance as returned by the |
10972 |
|
<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 |
10973 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
10974 |
|
command, <input-control> is the index of the input |
10975 |
|
control within the numerical bounds as returned by the |
10976 |
|
"INPUT_CONTROLS" field of the |
10977 |
|
<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> |
10978 |
|
command and <value> is the new (optional dotted) |
10979 |
|
floating point value for this effect parameter. |
10980 |
|
</p> |
10981 |
|
<p>Possible Answers: |
10982 |
|
</p> |
10983 |
|
<p> |
10984 |
|
</p> |
10985 |
|
<blockquote class="text"> |
10986 |
|
<p>"OK" - |
10987 |
|
</p> |
10988 |
|
<blockquote class="text"> |
10989 |
|
<p>in case the effect was altered successfully |
10990 |
|
</p> |
10991 |
|
</blockquote> |
10992 |
|
|
10993 |
|
|
10994 |
|
<p>"ERR:<error-code>:<error-message>" - |
10995 |
|
</p> |
10996 |
|
<blockquote class="text"> |
10997 |
|
<p>in case it failed, providing an appropriate error code and |
10998 |
|
error message |
10999 |
|
</p> |
11000 |
|
</blockquote> |
11001 |
|
|
11002 |
|
|
11003 |
|
</blockquote><p> |
11004 |
|
|
11005 |
|
</p> |
11006 |
|
<p>Examples: |
11007 |
|
</p> |
11008 |
|
<p> |
11009 |
|
</p> |
11010 |
|
<blockquote class="text"> |
11011 |
|
<p>C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5" |
11012 |
|
</p> |
11013 |
|
<p>S: "OK" |
11014 |
|
</p> |
11015 |
|
</blockquote><p> |
11016 |
|
|
11017 |
|
</p> |
11018 |
|
<a name="GET SEND_EFFECT_CHAINS"></a><br /><hr /> |
11019 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11020 |
|
<a name="rfc.section.6.11.12"></a><h3>6.11.12. |
11021 |
|
Retrieve amount of send effect chains</h3> |
11022 |
|
|
11023 |
|
<p>The front-end can retrieve the current amount of send |
11024 |
|
effect chains of an audio output device by sending the |
11025 |
|
following command: |
11026 |
|
</p> |
11027 |
|
<p> |
11028 |
|
</p> |
11029 |
|
<blockquote class="text"> |
11030 |
|
<p>GET SEND_EFFECT_CHAINS <audio-device> |
11031 |
|
</p> |
11032 |
|
</blockquote><p> |
11033 |
|
|
11034 |
|
</p> |
11035 |
|
<p>Where <audio-device> should be replaced by the |
11036 |
|
numerical ID of the audio output device as given by the |
11037 |
|
<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> |
11038 |
|
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> |
11039 |
|
command. |
11040 |
|
</p> |
11041 |
|
<p>Possible Answers: |
11042 |
|
</p> |
11043 |
|
<p> |
11044 |
|
</p> |
11045 |
|
<blockquote class="text"> |
11046 |
|
<p>The sampler will answer by returning the current |
11047 |
|
number of send effect chains of the supplied audio |
11048 |
|
output device. |
11049 |
|
</p> |
11050 |
|
</blockquote><p> |
11051 |
|
|
11052 |
|
</p> |
11053 |
|
<p>Examples: |
11054 |
|
</p> |
11055 |
|
<p> |
11056 |
|
</p> |
11057 |
|
<blockquote class="text"> |
11058 |
|
<p>C: "GET SEND_EFFECT_CHAINS 0" |
11059 |
|
</p> |
11060 |
|
<p>S: "4" |
11061 |
|
</p> |
11062 |
|
</blockquote><p> |
11063 |
|
|
11064 |
|
</p> |
11065 |
|
<a name="LIST SEND_EFFECT_CHAINS"></a><br /><hr /> |
11066 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11067 |
|
<a name="rfc.section.6.11.13"></a><h3>6.11.13. |
11068 |
|
Retrieve list of send effect chains</h3> |
11069 |
|
|
11070 |
|
<p>The front-end can retrieve the current list of send |
11071 |
|
effect chains of an audio output device by sending the |
11072 |
|
following command: |
11073 |
|
</p> |
11074 |
|
<p> |
11075 |
|
</p> |
11076 |
|
<blockquote class="text"> |
11077 |
|
<p>LIST SEND_EFFECT_CHAINS <audio-device> |
11078 |
|
</p> |
11079 |
|
</blockquote><p> |
11080 |
|
|
11081 |
|
</p> |
11082 |
|
<p>Where <audio-device> should be replaced by the |
11083 |
|
numerical ID of the audio output device as given by the |
11084 |
|
<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> |
11085 |
|
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> |
11086 |
|
command. |
11087 |
|
</p> |
11088 |
|
<p>Possible Answers: |
11089 |
|
</p> |
11090 |
|
<p> |
11091 |
|
</p> |
11092 |
|
<blockquote class="text"> |
11093 |
|
<p>The sampler will answer by returning a comma |
11094 |
|
separated list with numerical IDs of send effect |
11095 |
|
chains of the supplied audio output device. |
11096 |
|
|
11097 |
|
</p> |
11098 |
|
</blockquote><p> |
11099 |
|
|
11100 |
|
</p> |
11101 |
|
<p>Examples: |
11102 |
|
</p> |
11103 |
|
<p> |
11104 |
|
</p> |
11105 |
|
<blockquote class="text"> |
11106 |
|
<p>C: "LIST SEND_EFFECT_CHAINS 0" |
11107 |
|
</p> |
11108 |
|
<p>S: "3,4,7" |
11109 |
|
</p> |
11110 |
|
</blockquote><p> |
11111 |
|
|
11112 |
|
</p> |
11113 |
|
<a name="ADD SEND_EFFECT_CHAIN"></a><br /><hr /> |
11114 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11115 |
|
<a name="rfc.section.6.11.14"></a><h3>6.11.14. |
11116 |
|
Add send effect chain</h3> |
11117 |
|
|
11118 |
|
<p>The front-end can add a send effect chain by sending the |
11119 |
|
following command: |
11120 |
|
</p> |
11121 |
|
<p> |
11122 |
|
</p> |
11123 |
|
<blockquote class="text"> |
11124 |
|
<p>ADD SEND_EFFECT_CHAIN <audio-device> |
11125 |
|
</p> |
11126 |
|
</blockquote><p> |
11127 |
|
|
11128 |
|
</p> |
11129 |
|
<p>Where <audio-device> should be replaced by the |
11130 |
|
numerical ID of the audio output device as given by the |
11131 |
|
<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> |
11132 |
|
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> |
11133 |
|
command. |
11134 |
|
</p> |
11135 |
|
<p>Possible Answers: |
11136 |
|
</p> |
11137 |
|
<p> |
11138 |
|
</p> |
11139 |
|
<blockquote class="text"> |
11140 |
|
<p>"OK[<effect-chain>]" - |
11141 |
|
</p> |
11142 |
|
<blockquote class="text"> |
11143 |
|
<p>in case the send effect chain was |
11144 |
|
added successfully, where |
11145 |
|
<effect-chain> is the numerical ID |
11146 |
|
of the new send effect chain |
11147 |
|
</p> |
11148 |
|
</blockquote> |
11149 |
|
|
11150 |
|
|
11151 |
|
<p>"ERR:<error-code>:<error-message>" - |
11152 |
|
</p> |
11153 |
|
<blockquote class="text"> |
11154 |
|
<p>if the send effect chain could not be added |
11155 |
|
</p> |
11156 |
|
</blockquote> |
11157 |
|
|
11158 |
|
|
11159 |
|
</blockquote><p> |
11160 |
|
|
11161 |
|
</p> |
11162 |
|
<p>Examples: |
11163 |
|
</p> |
11164 |
|
<p> |
11165 |
|
</p> |
11166 |
|
<blockquote class="text"> |
11167 |
|
<p>C: "ADD SEND_EFFECT_CHAIN 0" |
11168 |
|
</p> |
11169 |
|
<p>S: "OK[2]" |
11170 |
|
</p> |
11171 |
|
</blockquote><p> |
11172 |
|
|
11173 |
|
</p> |
11174 |
|
<a name="REMOVE SEND_EFFECT_CHAIN"></a><br /><hr /> |
11175 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11176 |
|
<a name="rfc.section.6.11.15"></a><h3>6.11.15. |
11177 |
|
Remove send effect chain</h3> |
11178 |
|
|
11179 |
|
<p>The front-end can remove a send effect chain by sending |
11180 |
|
the following command: |
11181 |
|
</p> |
11182 |
|
<p> |
11183 |
|
</p> |
11184 |
|
<blockquote class="text"> |
11185 |
|
<p>REMOVE SEND_EFFECT_CHAIN <audio-device> <effect-chain> |
11186 |
|
</p> |
11187 |
|
</blockquote><p> |
11188 |
|
|
11189 |
|
</p> |
11190 |
|
<p>Where <audio-device> should be replaced by the |
11191 |
|
numerical ID of the audio output device as given by the |
11192 |
|
<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> |
11193 |
|
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> |
11194 |
|
command and <effect-chain> by the numerical ID as |
11195 |
|
returned by the |
11196 |
|
<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> |
11197 |
|
or |
11198 |
|
<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> |
11199 |
|
command. |
11200 |
|
</p> |
11201 |
|
<p>Possible Answers: |
11202 |
|
</p> |
11203 |
|
<p> |
11204 |
|
</p> |
11205 |
|
<blockquote class="text"> |
11206 |
|
<p>"OK" - |
11207 |
|
</p> |
11208 |
|
<blockquote class="text"> |
11209 |
|
<p>in case the send effect chain was |
11210 |
|
removed successfully |
11211 |
|
</p> |
11212 |
|
</blockquote> |
11213 |
|
|
11214 |
|
|
11215 |
|
<p>"ERR:<error-code>:<error-message>" - |
11216 |
|
</p> |
11217 |
|
<blockquote class="text"> |
11218 |
|
<p>if the send effect chain could not be removed |
11219 |
|
</p> |
11220 |
|
</blockquote> |
11221 |
|
|
11222 |
|
|
11223 |
|
</blockquote><p> |
11224 |
|
|
11225 |
|
</p> |
11226 |
|
<p>Examples: |
11227 |
|
</p> |
11228 |
|
<p> |
11229 |
|
</p> |
11230 |
|
<blockquote class="text"> |
11231 |
|
<p>C: "REMOVE SEND_EFFECT_CHAIN 0 2" |
11232 |
|
</p> |
11233 |
|
<p>S: "OK" |
11234 |
|
</p> |
11235 |
|
</blockquote><p> |
11236 |
|
|
11237 |
|
</p> |
11238 |
|
<a name="GET SEND_EFFECT_CHAIN INFO"></a><br /><hr /> |
11239 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11240 |
|
<a name="rfc.section.6.11.16"></a><h3>6.11.16. |
11241 |
|
Retrieving information about a send effect chain</h3> |
11242 |
|
|
11243 |
|
<p>The front-end can ask for informations of a send effect |
11244 |
|
chain by sending the following command: |
11245 |
|
</p> |
11246 |
|
<p> |
11247 |
|
</p> |
11248 |
|
<blockquote class="text"> |
11249 |
|
<p>GET SEND_EFFECT_CHAIN INFO <audio-device> <effect-chain> |
11250 |
|
</p> |
11251 |
|
</blockquote><p> |
11252 |
|
|
11253 |
|
</p> |
11254 |
|
<p>Where <audio-device> should be replaced by the |
11255 |
|
numerical ID of the audio output device as given by the |
11256 |
|
<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> |
11257 |
|
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> |
11258 |
|
command and <effect-chain> by the numerical ID as |
11259 |
|
returned by the |
11260 |
|
<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> |
11261 |
|
or |
11262 |
|
<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> |
11263 |
|
command. |
11264 |
|
</p> |
11265 |
|
<p>Possible Answers: |
11266 |
|
</p> |
11267 |
|
<p> |
11268 |
|
</p> |
11269 |
|
<blockquote class="text"> |
11270 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
11271 |
|
Each answer line begins with the information |
11272 |
|
category name, followed by a colon and then a space |
11273 |
|
character <SP> and finally the info character |
11274 |
|
string to that information category. |
11275 |
|
At the moment the following categories are defined: |
11276 |
|
</p> |
11277 |
|
<p> |
11278 |
|
</p> |
11279 |
|
<blockquote class="text"> |
11280 |
|
<p>EFFECT_COUNT - |
11281 |
|
</p> |
11282 |
|
<blockquote class="text"> |
11283 |
|
<p>amount of effects in this send |
11284 |
|
effect chain |
11285 |
|
</p> |
11286 |
|
</blockquote> |
11287 |
|
|
11288 |
|
|
11289 |
|
<p>EFFECT_SEQUENCE - |
11290 |
|
</p> |
11291 |
|
<blockquote class="text"> |
11292 |
|
<p>comma separated list of the |
11293 |
|
numerical IDs of the effect |
11294 |
|
instances in this send effect chain, |
11295 |
|
in the order as they are procssed in |
11296 |
|
the effect chain |
11297 |
|
</p> |
11298 |
|
</blockquote> |
11299 |
|
|
11300 |
|
|
11301 |
|
</blockquote> |
11302 |
|
|
11303 |
|
|
11304 |
|
</blockquote><p> |
11305 |
|
|
11306 |
|
</p> |
11307 |
|
<p>The mentioned fields above don't have to be in particular order. |
11308 |
|
</p> |
11309 |
|
<p>Example: |
11310 |
|
</p> |
11311 |
|
<p> |
11312 |
|
</p> |
11313 |
|
<blockquote class="text"> |
11314 |
|
<p>C: "GET SEND_EFFECT_CHAIN INFO 0 2" |
11315 |
|
</p> |
11316 |
|
<p>S: "EFFECT_COUNT: 3" |
11317 |
|
</p> |
11318 |
|
<p> "EFFECT_SEQUENCE: 31,4,7" |
11319 |
|
</p> |
11320 |
|
<p> "." |
11321 |
|
</p> |
11322 |
|
</blockquote><p> |
11323 |
|
|
11324 |
|
</p> |
11325 |
|
<a name="APPEND SEND_EFFECT_CHAIN EFFECT"></a><br /><hr /> |
11326 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11327 |
|
<a name="rfc.section.6.11.17"></a><h3>6.11.17. |
11328 |
|
Append effect instance to a send effect chain</h3> |
11329 |
|
|
11330 |
|
<p>The front-end can add an unused effect instance to the |
11331 |
|
end of a send effect chain by sending the following command: |
11332 |
|
</p> |
11333 |
|
<p> |
11334 |
|
</p> |
11335 |
|
<blockquote class="text"> |
11336 |
|
<p>APPEND SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <effect-instance> |
11337 |
|
</p> |
11338 |
|
</blockquote><p> |
11339 |
|
|
11340 |
|
</p> |
11341 |
|
<p>Where <audio-device> should be replaced by the |
11342 |
|
numerical ID of the audio output device as given by the |
11343 |
|
<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> |
11344 |
|
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> |
11345 |
|
command and <effect-chain> by the numerical ID as |
11346 |
|
returned by the |
11347 |
|
<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> |
11348 |
|
or |
11349 |
|
<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> |
11350 |
|
command and <effect-instance> as returned by the |
11351 |
|
<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 |
11352 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
11353 |
|
command. |
11354 |
|
</p> |
11355 |
|
<p>Only unused effect instances can be added to the effect |
11356 |
|
chain. Trying to add an effect instance which is already in |
11357 |
|
use somewhere in the audio signal path of the sampler will |
11358 |
|
result in an error. |
11359 |
|
</p> |
11360 |
|
<p>Possible Answers: |
11361 |
|
</p> |
11362 |
|
<p> |
11363 |
|
</p> |
11364 |
|
<blockquote class="text"> |
11365 |
|
<p>"OK" - |
11366 |
|
</p> |
11367 |
|
<blockquote class="text"> |
11368 |
|
<p>in case the effect instance was |
11369 |
|
added successfully to the chain |
11370 |
|
</p> |
11371 |
|
</blockquote> |
11372 |
|
|
11373 |
|
|
11374 |
|
<p>"ERR:<error-code>:<error-message>" - |
11375 |
|
</p> |
11376 |
|
<blockquote class="text"> |
11377 |
|
<p>if the effect instance could not be added |
11378 |
|
</p> |
11379 |
|
</blockquote> |
11380 |
|
|
11381 |
|
|
11382 |
|
</blockquote><p> |
11383 |
|
|
11384 |
|
</p> |
11385 |
|
<p>Examples: |
11386 |
|
</p> |
11387 |
|
<p> |
11388 |
|
</p> |
11389 |
|
<blockquote class="text"> |
11390 |
|
<p>C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38" |
11391 |
|
</p> |
11392 |
|
<p>S: "OK" |
11393 |
|
</p> |
11394 |
|
</blockquote><p> |
11395 |
|
|
11396 |
|
</p> |
11397 |
|
<a name="INSERT SEND_EFFECT_CHAIN EFFECT"></a><br /><hr /> |
11398 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11399 |
|
<a name="rfc.section.6.11.18"></a><h3>6.11.18. |
11400 |
|
Insert effect instance to a send effect chain</h3> |
11401 |
|
|
11402 |
|
<p>The front-end can add an unused effect instance to a |
11403 |
|
certain position of a send effect chain by sending the |
11404 |
|
following command: |
11405 |
|
</p> |
11406 |
|
<p> |
11407 |
|
</p> |
11408 |
|
<blockquote class="text"> |
11409 |
|
<p>INSERT SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos> <effect-instance> |
11410 |
|
</p> |
11411 |
|
</blockquote><p> |
11412 |
|
|
11413 |
|
</p> |
11414 |
|
<p>Where <audio-device> should be replaced by the |
11415 |
|
numerical ID of the audio output device as given by the |
11416 |
|
<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> |
11417 |
|
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> |
11418 |
|
command, <effect-chain> by the numerical ID as |
11419 |
|
returned by the |
11420 |
|
<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> |
11421 |
|
or |
11422 |
|
<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> |
11423 |
|
command, <effect-instance> as returned by the |
11424 |
|
<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 |
11425 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
11426 |
|
command and <chain-pos> the exact position of the |
11427 |
|
effect chain where the supplied effect shall be inserted |
11428 |
|
to. |
11429 |
|
</p> |
11430 |
|
<p>Only unused effect instances can be added to the effect |
11431 |
|
chain. Trying to add an effect instance which is already in |
11432 |
|
use somewhere in the audio signal path of the sampler will |
11433 |
|
result in an error. |
11434 |
|
</p> |
11435 |
|
<p>Possible Answers: |
11436 |
|
</p> |
11437 |
|
<p> |
11438 |
|
</p> |
11439 |
|
<blockquote class="text"> |
11440 |
|
<p>"OK" - |
11441 |
|
</p> |
11442 |
|
<blockquote class="text"> |
11443 |
|
<p>in case the effect instance was |
11444 |
|
added successfully to the chain |
11445 |
|
</p> |
11446 |
|
</blockquote> |
11447 |
|
|
11448 |
|
|
11449 |
|
<p>"ERR:<error-code>:<error-message>" - |
11450 |
|
</p> |
11451 |
|
<blockquote class="text"> |
11452 |
|
<p>if the effect instance could not be added |
11453 |
|
</p> |
11454 |
|
</blockquote> |
11455 |
|
|
11456 |
|
|
11457 |
|
</blockquote><p> |
11458 |
|
|
11459 |
|
</p> |
11460 |
|
<p>Examples: |
11461 |
|
</p> |
11462 |
|
<p> |
11463 |
|
</p> |
11464 |
|
<blockquote class="text"> |
11465 |
|
<p>C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38" |
11466 |
|
</p> |
11467 |
|
<p>S: "OK" |
11468 |
|
</p> |
11469 |
|
</blockquote><p> |
11470 |
|
|
11471 |
|
</p> |
11472 |
|
<a name="REMOVE SEND_EFFECT_CHAIN EFFECT"></a><br /><hr /> |
11473 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11474 |
|
<a name="rfc.section.6.11.19"></a><h3>6.11.19. |
11475 |
|
Remove effect instance from send effect chain</h3> |
11476 |
|
|
11477 |
|
<p>The front-end can remove an effect instance from a |
11478 |
|
certain position of a send effect chain by sending the |
11479 |
|
following command: |
11480 |
|
</p> |
11481 |
|
<p> |
11482 |
|
</p> |
11483 |
|
<blockquote class="text"> |
11484 |
|
<p>REMOVE SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos> |
11485 |
|
</p> |
11486 |
|
</blockquote><p> |
11487 |
|
|
11488 |
|
</p> |
11489 |
|
<p>Where <audio-device> should be replaced by the |
11490 |
|
numerical ID of the audio output device as given by the |
11491 |
|
<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> |
11492 |
|
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> |
11493 |
|
command, <effect-chain> by the numerical ID as |
11494 |
|
returned by the |
11495 |
|
<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> |
11496 |
|
or |
11497 |
|
<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> |
11498 |
|
command and <chain-pos> the exact position of the |
11499 |
|
effect instance to be removed from the effect chain. |
11500 |
|
</p> |
11501 |
|
<p>Possible Answers: |
11502 |
|
</p> |
11503 |
|
<p> |
11504 |
|
</p> |
11505 |
|
<blockquote class="text"> |
11506 |
|
<p>"OK" - |
11507 |
|
</p> |
11508 |
|
<blockquote class="text"> |
11509 |
|
<p>in case the effect instance was |
11510 |
|
removed successfully |
11511 |
|
</p> |
11512 |
|
</blockquote> |
11513 |
|
|
11514 |
|
|
11515 |
|
<p>"ERR:<error-code>:<error-message>" - |
11516 |
|
</p> |
11517 |
|
<blockquote class="text"> |
11518 |
|
<p>if the effect instance could not be removed |
11519 |
|
</p> |
11520 |
|
</blockquote> |
11521 |
|
|
11522 |
|
|
11523 |
|
</blockquote><p> |
11524 |
|
|
11525 |
|
</p> |
11526 |
|
<p>Examples: |
11527 |
|
</p> |
11528 |
|
<p> |
11529 |
|
</p> |
11530 |
|
<blockquote class="text"> |
11531 |
|
<p>C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4" |
11532 |
</p> |
</p> |
11533 |
<p>S: "OK" |
<p>S: "OK" |
11534 |
</p> |
</p> |
11656 |
<p>/ FORMAT SP format_instruction |
<p>/ FORMAT SP format_instruction |
11657 |
|
|
11658 |
</p> |
</p> |
11659 |
|
<p>/ SEND SP send_instruction |
11660 |
|
|
11661 |
|
</p> |
11662 |
|
<p>/ APPEND SP append_instruction |
11663 |
|
|
11664 |
|
</p> |
11665 |
|
<p>/ INSERT SP insert_instruction |
11666 |
|
|
11667 |
|
</p> |
11668 |
<p>/ RESET |
<p>/ RESET |
11669 |
|
|
11670 |
</p> |
</p> |
11686 |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
11687 |
|
|
11688 |
</p> |
</p> |
11689 |
|
<p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
11690 |
|
|
11691 |
|
</p> |
11692 |
<p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
<p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
11693 |
|
|
11694 |
</p> |
</p> |
11695 |
|
<p>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
11696 |
|
|
11697 |
|
</p> |
11698 |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
11699 |
|
|
11700 |
</p> |
</p> |
11713 |
<p>/ MIDI_INSTRUMENT_MAP SP map_name |
<p>/ MIDI_INSTRUMENT_MAP SP map_name |
11714 |
|
|
11715 |
</p> |
</p> |
11716 |
|
<p>/ SEND_EFFECT_CHAIN SP device_index |
11717 |
|
|
11718 |
|
</p> |
11719 |
</blockquote><p> |
</blockquote><p> |
11720 |
|
|
11721 |
</p> |
</p> |
11737 |
<p>/ CHANNEL_COUNT |
<p>/ CHANNEL_COUNT |
11738 |
|
|
11739 |
</p> |
</p> |
11740 |
|
<p>/ CHANNEL_MIDI |
11741 |
|
|
11742 |
|
</p> |
11743 |
|
<p>/ DEVICE_MIDI |
11744 |
|
|
11745 |
|
</p> |
11746 |
<p>/ VOICE_COUNT |
<p>/ VOICE_COUNT |
11747 |
|
|
11748 |
</p> |
</p> |
11791 |
<p>/ MISCELLANEOUS |
<p>/ MISCELLANEOUS |
11792 |
|
|
11793 |
</p> |
</p> |
11794 |
|
<p>/ TOTAL_STREAM_COUNT |
11795 |
|
|
11796 |
|
</p> |
11797 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
11798 |
|
|
11799 |
</p> |
</p> |
11800 |
<p>/ GLOBAL_INFO |
<p>/ GLOBAL_INFO |
11801 |
|
|
11802 |
</p> |
</p> |
11803 |
|
<p>/ EFFECT_INSTANCE_COUNT |
11804 |
|
|
11805 |
|
</p> |
11806 |
|
<p>/ EFFECT_INSTANCE_INFO |
11807 |
|
|
11808 |
|
</p> |
11809 |
|
<p>/ SEND_EFFECT_CHAIN_COUNT |
11810 |
|
|
11811 |
|
</p> |
11812 |
|
<p>/ SEND_EFFECT_CHAIN_INFO |
11813 |
|
|
11814 |
|
</p> |
11815 |
</blockquote><p> |
</blockquote><p> |
11816 |
|
|
11817 |
</p> |
</p> |
11833 |
<p>/ CHANNEL_COUNT |
<p>/ CHANNEL_COUNT |
11834 |
|
|
11835 |
</p> |
</p> |
11836 |
|
<p>/ CHANNEL_MIDI |
11837 |
|
|
11838 |
|
</p> |
11839 |
|
<p>/ DEVICE_MIDI |
11840 |
|
|
11841 |
|
</p> |
11842 |
<p>/ VOICE_COUNT |
<p>/ VOICE_COUNT |
11843 |
|
|
11844 |
</p> |
</p> |
11887 |
<p>/ MISCELLANEOUS |
<p>/ MISCELLANEOUS |
11888 |
|
|
11889 |
</p> |
</p> |
11890 |
|
<p>/ TOTAL_STREAM_COUNT |
11891 |
|
|
11892 |
|
</p> |
11893 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
11894 |
|
|
11895 |
</p> |
</p> |
11896 |
<p>/ GLOBAL_INFO |
<p>/ GLOBAL_INFO |
11897 |
|
|
11898 |
</p> |
</p> |
11899 |
|
<p>/ EFFECT_INSTANCE_COUNT |
11900 |
|
|
11901 |
|
</p> |
11902 |
|
<p>/ EFFECT_INSTANCE_INFO |
11903 |
|
|
11904 |
|
</p> |
11905 |
|
<p>/ SEND_EFFECT_CHAIN_COUNT |
11906 |
|
|
11907 |
|
</p> |
11908 |
|
<p>/ SEND_EFFECT_CHAIN_INFO |
11909 |
|
|
11910 |
|
</p> |
11911 |
</blockquote><p> |
</blockquote><p> |
11912 |
|
|
11913 |
</p> |
</p> |
11950 |
<p>/ MIDI_INSTRUMENT_MAP SP ALL |
<p>/ MIDI_INSTRUMENT_MAP SP ALL |
11951 |
|
|
11952 |
</p> |
</p> |
11953 |
|
<p>/ SEND_EFFECT_CHAIN SP device_index SP effect_chain |
11954 |
|
|
11955 |
|
</p> |
11956 |
|
<p>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos |
11957 |
|
|
11958 |
|
</p> |
11959 |
|
<p>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id |
11960 |
|
|
11961 |
|
</p> |
11962 |
<p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
<p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
11963 |
|
|
11964 |
</p> |
</p> |
11977 |
<p>AVAILABLE_ENGINES |
<p>AVAILABLE_ENGINES |
11978 |
|
|
11979 |
</p> |
</p> |
11980 |
|
<p>/ AVAILABLE_EFFECTS |
11981 |
|
|
11982 |
|
</p> |
11983 |
|
<p>/ EFFECT_INSTANCES |
11984 |
|
|
11985 |
|
</p> |
11986 |
|
<p>/ EFFECT SP INFO SP effect_index |
11987 |
|
|
11988 |
|
</p> |
11989 |
|
<p>/ EFFECT_INSTANCE SP INFO SP effect_instance |
11990 |
|
|
11991 |
|
</p> |
11992 |
|
<p>/ EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP input_control |
11993 |
|
|
11994 |
|
</p> |
11995 |
|
<p>/ SEND_EFFECT_CHAINS SP device_index |
11996 |
|
|
11997 |
|
</p> |
11998 |
|
<p>/ SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain |
11999 |
|
|
12000 |
|
</p> |
12001 |
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS |
12002 |
|
|
12003 |
</p> |
</p> |
12067 |
<p>/ SERVER SP INFO |
<p>/ SERVER SP INFO |
12068 |
|
|
12069 |
</p> |
</p> |
12070 |
|
<p>/ TOTAL_STREAM_COUNT |
12071 |
|
|
12072 |
|
</p> |
12073 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
12074 |
|
|
12075 |
</p> |
</p> |
12121 |
<p>/ VOLUME |
<p>/ VOLUME |
12122 |
|
|
12123 |
</p> |
</p> |
12124 |
|
<p>/ VOICES |
12125 |
|
|
12126 |
|
</p> |
12127 |
|
<p>/ STREAMS |
12128 |
|
|
12129 |
|
</p> |
12130 |
|
<p>/ FILE SP INSTRUMENTS SP filename |
12131 |
|
|
12132 |
|
</p> |
12133 |
|
<p>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
12134 |
|
|
12135 |
|
</p> |
12136 |
</blockquote><p> |
</blockquote><p> |
12137 |
|
|
12138 |
</p> |
</p> |
12154 |
<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 |
12155 |
|
|
12156 |
</p> |
</p> |
12157 |
|
<p>/ EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP input_control SP control_value |
12158 |
|
|
12159 |
|
</p> |
12160 |
<p>/ CHANNEL SP set_chan_instruction |
<p>/ CHANNEL SP set_chan_instruction |
12161 |
|
|
12162 |
</p> |
</p> |
12175 |
<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 |
12176 |
|
|
12177 |
</p> |
</p> |
12178 |
|
<p>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos |
12179 |
|
|
12180 |
|
</p> |
12181 |
<p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
<p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
12182 |
|
|
12183 |
</p> |
</p> |
12190 |
<p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
<p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
12191 |
|
|
12192 |
</p> |
</p> |
12193 |
|
<p>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename |
12194 |
|
|
12195 |
|
</p> |
12196 |
<p>/ ECHO SP boolean |
<p>/ ECHO SP boolean |
12197 |
|
|
12198 |
</p> |
</p> |
12199 |
<p>/ VOLUME SP volume_value |
<p>/ VOLUME SP volume_value |
12200 |
|
|
12201 |
</p> |
</p> |
12202 |
|
<p>/ VOICES SP number |
12203 |
|
|
12204 |
|
</p> |
12205 |
|
<p>/ STREAMS SP number |
12206 |
|
|
12207 |
|
</p> |
12208 |
</blockquote><p> |
</blockquote><p> |
12209 |
|
|
12210 |
</p> |
</p> |
12229 |
<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 |
12230 |
|
|
12231 |
</p> |
</p> |
12232 |
|
<p>/ EFFECT_INSTANCE SP effect_index |
12233 |
|
|
12234 |
|
</p> |
12235 |
|
<p>/ EFFECT_INSTANCE SP effect_system SP module SP effect_name |
12236 |
|
|
12237 |
|
</p> |
12238 |
</blockquote><p> |
</blockquote><p> |
12239 |
|
|
12240 |
</p> |
</p> |
12274 |
<p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
<p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
12275 |
|
|
12276 |
</p> |
</p> |
12277 |
|
<p>/ LOST SP DB_INSTRUMENT_FILES |
12278 |
|
|
12279 |
|
</p> |
12280 |
</blockquote><p> |
</blockquote><p> |
12281 |
|
|
12282 |
</p> |
</p> |
12316 |
<p>/ FX_SEND SP sampler_channel SP fx_send_id |
<p>/ FX_SEND SP sampler_channel SP fx_send_id |
12317 |
|
|
12318 |
</p> |
</p> |
12319 |
|
<p>/ EFFECT_INSTANCE SP number |
12320 |
|
|
12321 |
|
</p> |
12322 |
</blockquote><p> |
</blockquote><p> |
12323 |
|
|
12324 |
</p> |
</p> |
12334 |
</blockquote><p> |
</blockquote><p> |
12335 |
|
|
12336 |
</p> |
</p> |
12337 |
|
<p>append_instruction = |
12338 |
|
</p> |
12339 |
|
<blockquote class="text"> |
12340 |
|
<p>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP effect_instance |
12341 |
|
|
12342 |
|
</p> |
12343 |
|
</blockquote><p> |
12344 |
|
|
12345 |
|
</p> |
12346 |
|
<p>insert_instruction = |
12347 |
|
</p> |
12348 |
|
<blockquote class="text"> |
12349 |
|
<p>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos SP effect_instance |
12350 |
|
|
12351 |
|
</p> |
12352 |
|
</blockquote><p> |
12353 |
|
|
12354 |
|
</p> |
12355 |
<p>set_chan_instruction = |
<p>set_chan_instruction = |
12356 |
</p> |
</p> |
12357 |
<blockquote class="text"> |
<blockquote class="text"> |
12403 |
<p>edit_instruction = |
<p>edit_instruction = |
12404 |
</p> |
</p> |
12405 |
<blockquote class="text"> |
<blockquote class="text"> |
12406 |
<p>INSTRUMENT SP sampler_channel |
<p>CHANNEL SP INSTRUMENT SP sampler_channel |
12407 |
|
|
12408 |
</p> |
</p> |
12409 |
</blockquote><p> |
</blockquote><p> |
12469 |
<p>/ AVAILABLE_ENGINES |
<p>/ AVAILABLE_ENGINES |
12470 |
|
|
12471 |
</p> |
</p> |
12472 |
|
<p>/ AVAILABLE_EFFECTS |
12473 |
|
|
12474 |
|
</p> |
12475 |
|
<p>/ EFFECT_INSTANCES |
12476 |
|
|
12477 |
|
</p> |
12478 |
|
<p>/ SEND_EFFECT_CHAINS SP number |
12479 |
|
|
12480 |
|
</p> |
12481 |
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS |
12482 |
|
|
12483 |
</p> |
</p> |
12508 |
<p>/ DB_INSTRUMENTS SP db_path |
<p>/ DB_INSTRUMENTS SP db_path |
12509 |
|
|
12510 |
</p> |
</p> |
12511 |
|
<p>/ FILE SP INSTRUMENTS SP filename |
12512 |
|
|
12513 |
|
</p> |
12514 |
|
</blockquote><p> |
12515 |
|
|
12516 |
|
</p> |
12517 |
|
<p>send_instruction = |
12518 |
|
</p> |
12519 |
|
<blockquote class="text"> |
12520 |
|
<p>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number |
12521 |
|
|
12522 |
|
</p> |
12523 |
</blockquote><p> |
</blockquote><p> |
12524 |
|
|
12525 |
</p> |
</p> |
12559 |
</blockquote><p> |
</blockquote><p> |
12560 |
|
|
12561 |
</p> |
</p> |
12562 |
|
<p>effect_instance = |
12563 |
|
</p> |
12564 |
|
<blockquote class="text"> |
12565 |
|
<p>number |
12566 |
|
|
12567 |
|
</p> |
12568 |
|
</blockquote><p> |
12569 |
|
|
12570 |
|
</p> |
12571 |
<p>device_index = |
<p>device_index = |
12572 |
</p> |
</p> |
12573 |
<blockquote class="text"> |
<blockquote class="text"> |
12673 |
</blockquote><p> |
</blockquote><p> |
12674 |
|
|
12675 |
</p> |
</p> |
12676 |
|
<p>control_value = |
12677 |
|
</p> |
12678 |
|
<blockquote class="text"> |
12679 |
|
<p>real |
12680 |
|
|
12681 |
|
</p> |
12682 |
|
</blockquote><p> |
12683 |
|
|
12684 |
|
</p> |
12685 |
<p>sampler_channel = |
<p>sampler_channel = |
12686 |
</p> |
</p> |
12687 |
<blockquote class="text"> |
<blockquote class="text"> |
12739 |
<p>map_name = |
<p>map_name = |
12740 |
</p> |
</p> |
12741 |
<blockquote class="text"> |
<blockquote class="text"> |
12742 |
<p>stringval |
<p>stringval_escaped |
12743 |
|
|
12744 |
</p> |
</p> |
12745 |
</blockquote><p> |
</blockquote><p> |
12748 |
<p>entry_name = |
<p>entry_name = |
12749 |
</p> |
</p> |
12750 |
<blockquote class="text"> |
<blockquote class="text"> |
12751 |
<p>stringval |
<p>stringval_escaped |
12752 |
|
|
12753 |
</p> |
</p> |
12754 |
</blockquote><p> |
</blockquote><p> |
12757 |
<p>fx_send_name = |
<p>fx_send_name = |
12758 |
</p> |
</p> |
12759 |
<blockquote class="text"> |
<blockquote class="text"> |
12760 |
<p>stringval |
<p>stringval_escaped |
12761 |
|
|
12762 |
|
</p> |
12763 |
|
</blockquote><p> |
12764 |
|
|
12765 |
|
</p> |
12766 |
|
<p>effect_name = |
12767 |
|
</p> |
12768 |
|
<blockquote class="text"> |
12769 |
|
<p>stringval_escaped |
12770 |
|
|
12771 |
|
</p> |
12772 |
|
</blockquote><p> |
12773 |
|
|
12774 |
|
</p> |
12775 |
|
<p>effect_index = |
12776 |
|
</p> |
12777 |
|
<blockquote class="text"> |
12778 |
|
<p>number |
12779 |
|
|
12780 |
|
</p> |
12781 |
|
</blockquote><p> |
12782 |
|
|
12783 |
|
</p> |
12784 |
|
<p>effect_chain = |
12785 |
|
</p> |
12786 |
|
<blockquote class="text"> |
12787 |
|
<p>number |
12788 |
|
|
12789 |
|
</p> |
12790 |
|
</blockquote><p> |
12791 |
|
|
12792 |
|
</p> |
12793 |
|
<p>chain_pos = |
12794 |
|
</p> |
12795 |
|
<blockquote class="text"> |
12796 |
|
<p>number |
12797 |
|
|
12798 |
|
</p> |
12799 |
|
</blockquote><p> |
12800 |
|
|
12801 |
|
</p> |
12802 |
|
<p>input_control = |
12803 |
|
</p> |
12804 |
|
<blockquote class="text"> |
12805 |
|
<p>number |
12806 |
|
|
12807 |
</p> |
</p> |
12808 |
</blockquote><p> |
</blockquote><p> |
12853 |
<p>query_val = |
<p>query_val = |
12854 |
</p> |
</p> |
12855 |
<blockquote class="text"> |
<blockquote class="text"> |
12856 |
<p>textval_escaped |
<p>text_escaped |
12857 |
|
|
12858 |
</p> |
</p> |
12859 |
<p>/ stringval_escaped |
<p>/ stringval_escaped |
12877 |
</blockquote><p> |
</blockquote><p> |
12878 |
|
|
12879 |
</p> |
</p> |
12880 |
|
<p>effect_system = |
12881 |
|
</p> |
12882 |
|
<blockquote class="text"> |
12883 |
|
<p>string |
12884 |
|
|
12885 |
|
</p> |
12886 |
|
</blockquote><p> |
12887 |
|
|
12888 |
|
</p> |
12889 |
|
<p>module = |
12890 |
|
</p> |
12891 |
|
<blockquote class="text"> |
12892 |
|
<p>filename |
12893 |
|
|
12894 |
|
</p> |
12895 |
|
</blockquote><p> |
12896 |
|
|
12897 |
|
</p> |
12898 |
<a name="character_set"></a><br /><hr /> |
<a name="character_set"></a><br /><hr /> |
12899 |
<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> |
12900 |
<a name="rfc.section.7.1"></a><h3>7.1. |
<a name="rfc.section.7.1"></a><h3>7.1. |
12952 |
<td align="left">two digit hex ASCII code of the character</td> |
<td align="left">two digit hex ASCII code of the character</td> |
12953 |
</tr> |
</tr> |
12954 |
</table> |
</table> |
12955 |
|
<br clear="all" /> |
12956 |
|
|
12957 |
<p>Notice: due to the transition of certain parts of the |
<p>Notice: due to the transition of certain parts of the |
12958 |
protocol which now support escape sequences, a slight backward |
protocol which now support escape sequences, a slight backward |
12962 |
MUST be escaped as well (that is as double backslash), whereas |
MUST be escaped as well (that is as double backslash), whereas |
12963 |
in the old versions a single backslash was sufficient. |
in the old versions a single backslash was sufficient. |
12964 |
</p> |
</p> |
12965 |
|
<p>The following LSCP commands support escape sequences as part |
12966 |
|
of their filename / path based arguments and / or may contain |
12967 |
|
a filename / path with escape sequences in their response: |
12968 |
|
</p> |
12969 |
|
<blockquote class="text"> |
12970 |
|
<p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a> |
12971 |
|
</p> |
12972 |
|
<p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a> |
12973 |
|
</p> |
12974 |
|
<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> |
12975 |
|
</p> |
12976 |
|
<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> |
12977 |
|
</p> |
12978 |
|
<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> |
12979 |
|
</p> |
12980 |
|
<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> |
12981 |
|
</p> |
12982 |
|
<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> |
12983 |
|
</p> |
12984 |
|
<p><a class='info' href='#REMOVE DB_INSTRUMENT'>"REMOVE DB_INSTRUMENT"<span> (</span><span class='info'>Removing an instrument</span><span>)</span></a> |
12985 |
|
</p> |
12986 |
|
<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> |
12987 |
|
</p> |
12988 |
|
<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> |
12989 |
|
</p> |
12990 |
|
<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> |
12991 |
|
</p> |
12992 |
|
<p><a class='info' href='#GET DB_INSTRUMENTS'>"GET DB_INSTRUMENTS"<span> (</span><span class='info'>Getting amount of instruments</span><span>)</span></a> |
12993 |
|
</p> |
12994 |
|
<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> |
12995 |
|
</p> |
12996 |
|
<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> |
12997 |
|
</p> |
12998 |
|
<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> |
12999 |
|
</p> |
13000 |
|
<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> |
13001 |
|
</p> |
13002 |
|
<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> |
13003 |
|
</p> |
13004 |
|
<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> |
13005 |
|
</p> |
13006 |
|
<p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a> |
13007 |
|
</p> |
13008 |
|
<p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a> |
13009 |
|
</p> |
13010 |
|
<p><a class='info' href='#MOVE DB_INSTRUMENT'>"MOVE DB_INSTRUMENT"<span> (</span><span class='info'>Moving an instrument</span><span>)</span></a> |
13011 |
|
</p> |
13012 |
|
<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> |
13013 |
|
</p> |
13014 |
|
<p><a class='info' href='#COPY DB_INSTRUMENT'>"COPY DB_INSTRUMENT"<span> (</span><span class='info'>Copying instruments</span><span>)</span></a> |
13015 |
|
</p> |
13016 |
|
<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> |
13017 |
|
</p> |
13018 |
|
<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> |
13019 |
|
</p> |
13020 |
|
<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> |
13021 |
|
</p> |
13022 |
|
<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> |
13023 |
|
</p> |
13024 |
|
<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> |
13025 |
|
</p> |
13026 |
|
<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> |
13027 |
|
</p> |
13028 |
|
<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> |
13029 |
|
</p> |
13030 |
|
<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> |
13031 |
|
</p> |
13032 |
|
<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> |
13033 |
|
</p> |
13034 |
|
</blockquote><p> |
13035 |
|
Note that the forward slash character ('/') has a special meaning in |
13036 |
|
filename / path based arguments: it acts as separator of the nodes in |
13037 |
|
the path, thus if a directory- or filename includes a forward slash |
13038 |
|
(not intended as path node separator), you MUST escape that slash |
13039 |
|
either with the respective hex escape sequence ("\x2f") or with the |
13040 |
|
respective octal escape sequence ("\057"). |
13041 |
|
|
13042 |
|
</p> |
13043 |
|
<p> |
13044 |
|
Note for Windows: file path arguments in LSCP are expected |
13045 |
|
to use forward slashes as directory node separator similar |
13046 |
|
to Unix based operating systems. In contrast to Unix however |
13047 |
|
a Windows typical drive character is expected to be |
13048 |
|
prefixed to the path. That is an original Windows file path |
13049 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
13050 |
|
"D:/Sounds/My.gig". |
13051 |
|
|
13052 |
|
</p> |
13053 |
|
<p> |
13054 |
|
The following LSCP commands even support escape sequences as |
13055 |
|
part of at least one of their text-based arguments (i.e. entity name, |
13056 |
|
description) and / or may contain escape sequences in at least one of |
13057 |
|
their text-based fields in their response: |
13058 |
|
</p> |
13059 |
|
<blockquote class="text"> |
13060 |
|
<p><a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a> |
13061 |
|
</p> |
13062 |
|
<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> |
13063 |
|
</p> |
13064 |
|
<p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a> |
13065 |
|
</p> |
13066 |
|
<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> |
13067 |
|
</p> |
13068 |
|
<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> |
13069 |
|
</p> |
13070 |
|
<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> |
13071 |
|
</p> |
13072 |
|
<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> |
13073 |
|
</p> |
13074 |
|
<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> |
13075 |
|
</p> |
13076 |
|
<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> |
13077 |
|
</p> |
13078 |
|
<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> |
13079 |
|
</p> |
13080 |
|
<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> |
13081 |
|
</p> |
13082 |
|
<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> |
13083 |
|
</p> |
13084 |
|
<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> |
13085 |
|
</p> |
13086 |
|
<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> |
13087 |
|
</p> |
13088 |
|
<p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a> |
13089 |
|
</p> |
13090 |
|
<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> |
13091 |
|
</p> |
13092 |
|
<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> |
13093 |
|
</p> |
13094 |
|
<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> |
13095 |
|
</p> |
13096 |
|
<p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a> |
13097 |
|
</p> |
13098 |
|
<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> |
13099 |
|
</p> |
13100 |
|
<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> |
13101 |
|
</p> |
13102 |
|
<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> |
13103 |
|
</p> |
13104 |
|
</blockquote><p> |
13105 |
|
Please note that these lists are manually maintained. If you |
13106 |
|
find a command that also supports escape sequences we forgot to |
13107 |
|
mention here, please report it! |
13108 |
|
|
13109 |
|
</p> |
13110 |
<a name="events"></a><br /><hr /> |
<a name="events"></a><br /><hr /> |
13111 |
<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> |
13112 |
<a name="rfc.section.8"></a><h3>8. |
<a name="rfc.section.8"></a><h3>8. |
13267 |
<p>where <channels> will be replaced by the new number |
<p>where <channels> will be replaced by the new number |
13268 |
of sampler channels. |
of sampler channels. |
13269 |
</p> |
</p> |
13270 |
<a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE CHANNEL_MIDI"></a><br /><hr /> |
13271 |
<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> |
13272 |
<a name="rfc.section.8.6"></a><h3>8.6. |
<a name="rfc.section.8.6"></a><h3>8.6. |
13273 |
|
MIDI data on a sampler channel arrived</h3> |
13274 |
|
|
13275 |
|
<p>Client may want to be notified when MIDI data arrive on sampler channels on |
13276 |
|
back-end side, by issuing the following command: |
13277 |
|
</p> |
13278 |
|
<p> |
13279 |
|
</p> |
13280 |
|
<blockquote class="text"> |
13281 |
|
<p>SUBSCRIBE CHANNEL_MIDI |
13282 |
|
</p> |
13283 |
|
</blockquote><p> |
13284 |
|
|
13285 |
|
</p> |
13286 |
|
<p>Server will start sending one of the the following notification messages: |
13287 |
|
</p> |
13288 |
|
<p> |
13289 |
|
</p> |
13290 |
|
<blockquote class="text"> |
13291 |
|
<p>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>" |
13292 |
|
</p> |
13293 |
|
<p>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>" |
13294 |
|
</p> |
13295 |
|
</blockquote><p> |
13296 |
|
|
13297 |
|
</p> |
13298 |
|
<p>where <channel-id> will be replaced by the ID of the sampler channel where the MIDI |
13299 |
|
data arrived. <note> and <velocity> are integer values in the range between |
13300 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
13301 |
|
|
13302 |
|
</p> |
13303 |
|
<p>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
13304 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
13305 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
13306 |
|
thread unaffected by this feature. |
13307 |
|
</p> |
13308 |
|
<a name="SUBSCRIBE DEVICE_MIDI"></a><br /><hr /> |
13309 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
13310 |
|
<a name="rfc.section.8.7"></a><h3>8.7. |
13311 |
|
MIDI data on a MIDI input device arrived</h3> |
13312 |
|
|
13313 |
|
<p>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command: |
13314 |
|
</p> |
13315 |
|
<p> |
13316 |
|
</p> |
13317 |
|
<blockquote class="text"> |
13318 |
|
<p>SUBSCRIBE DEVICE_MIDI |
13319 |
|
</p> |
13320 |
|
</blockquote><p> |
13321 |
|
|
13322 |
|
</p> |
13323 |
|
<p>Server will start sending one of the the following notification messages: |
13324 |
|
</p> |
13325 |
|
<p> |
13326 |
|
</p> |
13327 |
|
<blockquote class="text"> |
13328 |
|
<p>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note> <velocity>" |
13329 |
|
</p> |
13330 |
|
<p>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note> <velocity>" |
13331 |
|
</p> |
13332 |
|
</blockquote><p> |
13333 |
|
|
13334 |
|
</p> |
13335 |
|
<p>where <device-id> <port-id> will be replaced |
13336 |
|
by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI |
13337 |
|
data arrived. <note> and <velocity> are integer values in the range between |
13338 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
13339 |
|
|
13340 |
|
</p> |
13341 |
|
<p>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
13342 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
13343 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
13344 |
|
thread unaffected by this feature. |
13345 |
|
</p> |
13346 |
|
<a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr /> |
13347 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
13348 |
|
<a name="rfc.section.8.8"></a><h3>8.8. |
13349 |
Number of active voices changed</h3> |
Number of active voices changed</h3> |
13350 |
|
|
13351 |
<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 |
13375 |
</p> |
</p> |
13376 |
<a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr /> |
13377 |
<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> |
13378 |
<a name="rfc.section.8.7"></a><h3>8.7. |
<a name="rfc.section.8.9"></a><h3>8.9. |
13379 |
Number of active disk streams changed</h3> |
Number of active disk streams changed</h3> |
13380 |
|
|
13381 |
<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 |
13405 |
</p> |
</p> |
13406 |
<a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr /> |
<a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr /> |
13407 |
<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> |
13408 |
<a name="rfc.section.8.8"></a><h3>8.8. |
<a name="rfc.section.8.10"></a><h3>8.10. |
13409 |
Disk stream buffer fill state changed</h3> |
Disk stream buffer fill state changed</h3> |
13410 |
|
|
13411 |
<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 |
13436 |
</p> |
</p> |
13437 |
<a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr /> |
13438 |
<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> |
13439 |
<a name="rfc.section.8.9"></a><h3>8.9. |
<a name="rfc.section.8.11"></a><h3>8.11. |
13440 |
Channel information changed</h3> |
Channel information changed</h3> |
13441 |
|
|
13442 |
<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 |
13469 |
</p> |
</p> |
13470 |
<a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr /> |
13471 |
<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> |
13472 |
<a name="rfc.section.8.10"></a><h3>8.10. |
<a name="rfc.section.8.12"></a><h3>8.12. |
13473 |
Number of effect sends changed</h3> |
Number of effect sends changed</h3> |
13474 |
|
|
13475 |
<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 |
13499 |
</p> |
</p> |
13500 |
<a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr /> |
13501 |
<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> |
13502 |
<a name="rfc.section.8.11"></a><h3>8.11. |
<a name="rfc.section.8.13"></a><h3>8.13. |
13503 |
Effect send information changed</h3> |
Effect send information changed</h3> |
13504 |
|
|
13505 |
<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 |
13529 |
</p> |
</p> |
13530 |
<a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE TOTAL_VOICE_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.12"></a><h3>8.12. |
<a name="rfc.section.8.14"></a><h3>8.14. |
13533 |
Total number of active voices changed</h3> |
Total number of active voices changed</h3> |
13534 |
|
|
13535 |
<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 |
13556 |
<p>where <voices> will be replaced by the new number of |
<p>where <voices> will be replaced by the new number of |
13557 |
all currently active voices. |
all currently active voices. |
13558 |
</p> |
</p> |
13559 |
|
<a name="SUBSCRIBE TOTAL_STREAM_COUNT"></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> |
13561 |
|
<a name="rfc.section.8.15"></a><h3>8.15. |
13562 |
|
Total number of active disk streams changed</h3> |
13563 |
|
|
13564 |
|
<p>Client may want to be notified when the total number of disk streams on the |
13565 |
|
back-end changes by issuing the following command: |
13566 |
|
</p> |
13567 |
|
<p> |
13568 |
|
</p> |
13569 |
|
<blockquote class="text"> |
13570 |
|
<p>SUBSCRIBE TOTAL_STREAM_COUNT |
13571 |
|
</p> |
13572 |
|
</blockquote><p> |
13573 |
|
|
13574 |
|
</p> |
13575 |
|
<p>Server will start sending the following notification messages: |
13576 |
|
</p> |
13577 |
|
<p> |
13578 |
|
</p> |
13579 |
|
<blockquote class="text"> |
13580 |
|
<p>"NOTIFY:TOTAL_STREAM_COUNT:<streams>" |
13581 |
|
</p> |
13582 |
|
</blockquote><p> |
13583 |
|
|
13584 |
|
</p> |
13585 |
|
<p>where <streams> will be replaced by the new number of |
13586 |
|
all currently active disk streams. |
13587 |
|
</p> |
13588 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr /> |
13589 |
<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> |
13590 |
<a name="rfc.section.8.13"></a><h3>8.13. |
<a name="rfc.section.8.16"></a><h3>8.16. |
13591 |
Number of MIDI instrument maps changed</h3> |
Number of MIDI instrument maps changed</h3> |
13592 |
|
|
13593 |
<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 |
13616 |
</p> |
</p> |
13617 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr /> |
13618 |
<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> |
13619 |
<a name="rfc.section.8.14"></a><h3>8.14. |
<a name="rfc.section.8.17"></a><h3>8.17. |
13620 |
MIDI instrument map information changed</h3> |
MIDI instrument map information changed</h3> |
13621 |
|
|
13622 |
<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 |
13649 |
</p> |
</p> |
13650 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr /> |
13651 |
<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> |
13652 |
<a name="rfc.section.8.15"></a><h3>8.15. |
<a name="rfc.section.8.18"></a><h3>8.18. |
13653 |
Number of MIDI instruments changed</h3> |
Number of MIDI instruments changed</h3> |
13654 |
|
|
13655 |
<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 |
13679 |
</p> |
</p> |
13680 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr /> |
13681 |
<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> |
13682 |
<a name="rfc.section.8.16"></a><h3>8.16. |
<a name="rfc.section.8.19"></a><h3>8.19. |
13683 |
MIDI instrument information changed</h3> |
MIDI instrument information changed</h3> |
13684 |
|
|
13685 |
<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 |
13713 |
</p> |
</p> |
13714 |
<a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr /> |
13715 |
<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> |
13716 |
<a name="rfc.section.8.17"></a><h3>8.17. |
<a name="rfc.section.8.20"></a><h3>8.20. |
13717 |
Global settings changed</h3> |
Global settings changed</h3> |
13718 |
|
|
13719 |
<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 |
13738 |
new global volume parameter. |
new global volume parameter. |
13739 |
</p> |
</p> |
13740 |
</blockquote><p> |
</blockquote><p> |
13741 |
|
</p> |
13742 |
|
<blockquote class="text"> |
13743 |
|
<p>"NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the |
13744 |
|
golbal limit of the sampler for maximum voices is changed, where |
13745 |
|
<max-voices> will be an integer value, reflecting the |
13746 |
|
new global voice limit parameter. |
13747 |
|
</p> |
13748 |
|
</blockquote><p> |
13749 |
|
</p> |
13750 |
|
<blockquote class="text"> |
13751 |
|
<p>"NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the |
13752 |
|
golbal limit of the sampler for maximum disk streams is changed, where |
13753 |
|
<max-streams> will be an integer value, reflecting the |
13754 |
|
new global disk streams limit parameter. |
13755 |
|
</p> |
13756 |
|
</blockquote><p> |
13757 |
|
|
13758 |
</p> |
</p> |
13759 |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
13760 |
<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> |
13761 |
<a name="rfc.section.8.18"></a><h3>8.18. |
<a name="rfc.section.8.21"></a><h3>8.21. |
13762 |
Number of database instrument directories changed</h3> |
Number of database instrument directories changed</h3> |
13763 |
|
|
13764 |
<p>Client may want to be notified when the number of instrument |
<p>Client may want to be notified when the number of instrument |
13792 |
</p> |
</p> |
13793 |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr /> |
13794 |
<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> |
13795 |
<a name="rfc.section.8.19"></a><h3>8.19. |
<a name="rfc.section.8.22"></a><h3>8.22. |
13796 |
Database instrument directory information changed</h3> |
Database instrument directory information changed</h3> |
13797 |
|
|
13798 |
<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 |
13837 |
</p> |
</p> |
13838 |
<a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr /> |
13839 |
<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> |
13840 |
<a name="rfc.section.8.20"></a><h3>8.20. |
<a name="rfc.section.8.23"></a><h3>8.23. |
13841 |
Number of database instruments changed</h3> |
Number of database instruments changed</h3> |
13842 |
|
|
13843 |
<p>Client may want to be notified when the number of instruments |
<p>Client may want to be notified when the number of instruments |
13871 |
</p> |
</p> |
13872 |
<a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr /> |
13873 |
<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> |
13874 |
<a name="rfc.section.8.21"></a><h3>8.21. |
<a name="rfc.section.8.24"></a><h3>8.24. |
13875 |
Database instrument information changed</h3> |
Database instrument information changed</h3> |
13876 |
|
|
13877 |
<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 |
13916 |
</p> |
</p> |
13917 |
<a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr /> |
13918 |
<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> |
13919 |
<a name="rfc.section.8.22"></a><h3>8.22. |
<a name="rfc.section.8.25"></a><h3>8.25. |
13920 |
Database job status information changed</h3> |
Database job status information changed</h3> |
13921 |
|
|
13922 |
<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 |
13947 |
time events happening on the server, it is believed that an empty notification |
time events happening on the server, it is believed that an empty notification |
13948 |
message is sufficient here. |
message is sufficient here. |
13949 |
</p> |
</p> |
13950 |
|
<a name="SUBSCRIBE EFFECT_INSTANCE_COUNT"></a><br /><hr /> |
13951 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
13952 |
|
<a name="rfc.section.8.26"></a><h3>8.26. |
13953 |
|
Number of effect instances changed</h3> |
13954 |
|
|
13955 |
|
<p>Client may want to be notified when the number of effect instances |
13956 |
|
is changed by issuing the following command: |
13957 |
|
</p> |
13958 |
|
<p> |
13959 |
|
</p> |
13960 |
|
<blockquote class="text"> |
13961 |
|
<p>SUBSCRIBE EFFECT_INSTANCE_COUNT |
13962 |
|
</p> |
13963 |
|
</blockquote><p> |
13964 |
|
|
13965 |
|
</p> |
13966 |
|
<p>Server will start sending the following notification messages: |
13967 |
|
</p> |
13968 |
|
<p> |
13969 |
|
</p> |
13970 |
|
<blockquote class="text"> |
13971 |
|
<p>"EFFECT_INSTANCE_COUNT:<instances>" |
13972 |
|
</p> |
13973 |
|
</blockquote><p> |
13974 |
|
|
13975 |
|
</p> |
13976 |
|
<p>where <instances> will be replaced by the new number |
13977 |
|
of effect instances. |
13978 |
|
</p> |
13979 |
|
<a name="SUBSCRIBE EFFECT_INSTANCE_INFO"></a><br /><hr /> |
13980 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
13981 |
|
<a name="rfc.section.8.27"></a><h3>8.27. |
13982 |
|
Effect instance information changed</h3> |
13983 |
|
|
13984 |
|
<p>Client may want to be notified when changes were made to effect instances |
13985 |
|
on the back-end by issuing the following command: |
13986 |
|
</p> |
13987 |
|
<p> |
13988 |
|
</p> |
13989 |
|
<blockquote class="text"> |
13990 |
|
<p>SUBSCRIBE EFFECT_INSTANCE_INFO |
13991 |
|
</p> |
13992 |
|
</blockquote><p> |
13993 |
|
|
13994 |
|
</p> |
13995 |
|
<p>Server will start sending the following notification messages: |
13996 |
|
</p> |
13997 |
|
<p> |
13998 |
|
</p> |
13999 |
|
<blockquote class="text"> |
14000 |
|
<p>"EFFECT_INSTANCE_INFO:<instance-id>" |
14001 |
|
</p> |
14002 |
|
</blockquote><p> |
14003 |
|
|
14004 |
|
</p> |
14005 |
|
<p>where <instance-id> will be replaced by the numerical ID |
14006 |
|
of the effect instance. |
14007 |
|
</p> |
14008 |
|
<a name="SUBSCRIBE SEND_EFFECT_CHAIN_COUNT"></a><br /><hr /> |
14009 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
14010 |
|
<a name="rfc.section.8.28"></a><h3>8.28. |
14011 |
|
Number of send effect chains changed</h3> |
14012 |
|
|
14013 |
|
<p>Client may want to be notified when the number of send effect chains |
14014 |
|
is changed by issuing the following command: |
14015 |
|
</p> |
14016 |
|
<p> |
14017 |
|
</p> |
14018 |
|
<blockquote class="text"> |
14019 |
|
<p>SUBSCRIBE SEND_EFFECT_CHAIN_COUNT |
14020 |
|
</p> |
14021 |
|
</blockquote><p> |
14022 |
|
|
14023 |
|
</p> |
14024 |
|
<p>Server will start sending the following notification messages: |
14025 |
|
</p> |
14026 |
|
<p> |
14027 |
|
</p> |
14028 |
|
<blockquote class="text"> |
14029 |
|
<p>"NOTIFY:SEND_EFFECT_CHAIN_COUNT:<device-id> <chains>" |
14030 |
|
</p> |
14031 |
|
</blockquote><p> |
14032 |
|
|
14033 |
|
</p> |
14034 |
|
<p>where <device-id> will be replaced by the numerical ID of the audio |
14035 |
|
output device, in which the number of send effect chains is changed and |
14036 |
|
<chains> will be replaced by the new number of send effect chains. |
14037 |
|
</p> |
14038 |
|
<a name="SUBSCRIBE SEND_EFFECT_CHAIN_INFO"></a><br /><hr /> |
14039 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
14040 |
|
<a name="rfc.section.8.29"></a><h3>8.29. |
14041 |
|
Send effect chain information changed</h3> |
14042 |
|
|
14043 |
|
<p>Client may want to be notified when changes were made to send effect chains |
14044 |
|
on the back-end by issuing the following command: |
14045 |
|
</p> |
14046 |
|
<p> |
14047 |
|
</p> |
14048 |
|
<blockquote class="text"> |
14049 |
|
<p>SUBSCRIBE SEND_EFFECT_CHAIN_INFO |
14050 |
|
</p> |
14051 |
|
</blockquote><p> |
14052 |
|
|
14053 |
|
</p> |
14054 |
|
<p>Server will start sending the following notification messages: |
14055 |
|
</p> |
14056 |
|
<p> |
14057 |
|
</p> |
14058 |
|
<blockquote class="text"> |
14059 |
|
<p>"SEND_EFFECT_CHAIN_INFO:<device-id> <chain-id> <instances>" - |
14060 |
|
Notifies that the number of effect instances in a particular send effect chain |
14061 |
|
is changed, where <device-id> will be replaced by the numerical ID of the audio |
14062 |
|
output device the send effect chain belongs to, <chain-id> will be replaced |
14063 |
|
by the numerical ID of the send effect chain in which the number of effect instances |
14064 |
|
has changed and <instances> will be replaced by the new number |
14065 |
|
of effect instances in the specified send effect chain. |
14066 |
|
</p> |
14067 |
|
</blockquote><p> |
14068 |
|
|
14069 |
|
</p> |
14070 |
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr /> |
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr /> |
14071 |
<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> |
14072 |
<a name="rfc.section.8.23"></a><h3>8.23. |
<a name="rfc.section.8.30"></a><h3>8.30. |
14073 |
Miscellaneous and debugging events</h3> |
Miscellaneous and debugging events</h3> |
14074 |
|
|
14075 |
<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 |
14135 |
<h3>11. References</h3> |
<h3>11. References</h3> |
14136 |
<table width="99%" border="0"> |
<table width="99%" border="0"> |
14137 |
<tr><td class="author-text" valign="top"><a name="RFC20">[RFC20]</a></td> |
<tr><td class="author-text" valign="top"><a name="RFC20">[RFC20]</a></td> |
14138 |
<td class="author-text">UCLA, “<a href="ftp://ftp.isi.edu/in-notes/rfc20.txt">ASCII format for Network Interchange</a>,” RFC 20, 1969.</td></tr> |
<td class="author-text">UCLA, “<a href="http://tools.ietf.org/html/rfc20">ASCII format for Network Interchange</a>,” RFC 20, 1969.</td></tr> |
14139 |
<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> |
14140 |
<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> |
14141 |
<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> |
14142 |
<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> |
14143 |
<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> |
14144 |
<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> |
14145 |
</table> |
</table> |
14146 |
|
|
14147 |
<a name="rfc.authors"></a><br /><hr /> |
<a name="rfc.authors"></a><br /><hr /> |
14166 |
<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> |
14167 |
<h3>Full Copyright Statement</h3> |
<h3>Full Copyright Statement</h3> |
14168 |
<p class='copyright'> |
<p class='copyright'> |
14169 |
Copyright © The IETF Trust (2007).</p> |
Copyright © The IETF Trust (2011).</p> |
14170 |
<p class='copyright'> |
<p class='copyright'> |
14171 |
This document is subject to the rights, |
This document is subject to the rights, |
14172 |
licenses and restrictions contained in BCP 78, |
licenses and restrictions contained in BCP 78, |
14208 |
proprietary rights that may cover technology that may be required |
proprietary rights that may cover technology that may be required |
14209 |
to implement this standard. |
to implement this standard. |
14210 |
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> |
|
14211 |
</body></html> |
</body></html> |
|
|
|