| 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.35 (http://xml.resource.org/)"> |
| 7 |
<style type='text/css'><!-- |
<style type='text/css'><!-- |
| 8 |
body { |
body { |
| 9 |
font-family: verdana, charcoal, helvetica, arial, sans-serif; |
font-family: verdana, charcoal, helvetica, arial, sans-serif; |
| 145 |
<tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr> |
<tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr> |
| 146 |
<tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr> |
<tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr> |
| 147 |
<tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr> |
<tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr> |
| 148 |
<tr><td class="header">Expires: April 9, 2008</td><td class="header">October 7, 2007</td></tr> |
<tr><td class="header">Expires: April 8, 2011</td><td class="header">October 5, 2010</td></tr> |
| 149 |
</table></td></tr></table> |
</table></td></tr></table> |
| 150 |
<h1><br />LinuxSampler Control Protocol (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, |
| 167 |
in accordance with Section 6 of BCP 79.</p> |
in accordance with Section 6 of BCP 79.</p> |
| 168 |
<p> |
<p> |
| 169 |
Internet-Drafts are working documents of the Internet Engineering |
Internet-Drafts are working documents of the Internet Engineering |
| 170 |
Task Force (IETF), its areas, and its working groups. |
Task Force (IETF). Note that other groups may also distribute |
| 171 |
Note that other groups may also distribute working documents as |
working documents as Internet-Drafts. The list of current |
| 172 |
Internet-Drafts.</p> |
Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.</p> |
| 173 |
<p> |
<p> |
| 174 |
Internet-Drafts are draft documents valid for a maximum of six months |
Internet-Drafts are draft documents valid for a maximum of six months |
| 175 |
and may be updated, replaced, or obsoleted by other documents at any time. |
and may be updated, replaced, or obsoleted by other documents at any time. |
| 176 |
It is inappropriate to use Internet-Drafts as reference material or to cite |
It is inappropriate to use Internet-Drafts as reference material or to cite |
| 177 |
them other than as “work in progress.”</p> |
them other than as “work in progress.”</p> |
| 178 |
<p> |
<p> |
| 179 |
The list of current Internet-Drafts can be accessed at |
This Internet-Draft will expire on April 8, 2011.</p> |
| 180 |
<a href='http://www.ietf.org/ietf/1id-abstracts.txt'>http://www.ietf.org/ietf/1id-abstracts.txt</a>.</p> |
<a name="toc"></a><br /><hr /> |
|
<p> |
|
|
The list of Internet-Draft Shadow Directories can be accessed at |
|
|
<a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p> |
|
|
<p> |
|
|
This Internet-Draft will expire on April 9, 2008.</p> |
|
|
|
|
|
<h3>Copyright Notice</h3> |
|
|
<p> |
|
|
Copyright © The IETF Trust (2007).</p> |
|
|
|
|
|
<h3>Abstract</h3> |
|
|
|
|
|
<p>The LinuxSampler Control Protocol (LSCP) is an |
|
|
application-level protocol primarily intended for local and |
|
|
remote controlling the LinuxSampler backend application, which is a |
|
|
sophisticated server-like console application essentially playing |
|
|
back audio samples and manipulating the samples in real time to |
|
|
certain extent. |
|
|
</p><a name="toc"></a><br /><hr /> |
|
| 181 |
<h3>Table of Contents</h3> |
<h3>Table of Contents</h3> |
| 182 |
<p class="toc"> |
<p class="toc"> |
| 183 |
<a href="#anchor1">1.</a> |
<a href="#anchor1">1.</a> |
| 322 |
Changing effect send's name<br /> |
Changing effect send's name<br /> |
| 323 |
<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a> |
<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a> |
| 324 |
Altering effect send's audio routing<br /> |
Altering effect send's audio routing<br /> |
| 325 |
<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.32.</a> |
<a href="#SET FX_SEND EFFECT">6.4.32.</a> |
| 326 |
|
Assigning destination effect to an effect send<br /> |
| 327 |
|
<a href="#REMOVE FX_SEND EFFECT">6.4.33.</a> |
| 328 |
|
Removing destination effect from an effect send<br /> |
| 329 |
|
<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.34.</a> |
| 330 |
Altering effect send's MIDI controller<br /> |
Altering effect send's MIDI controller<br /> |
| 331 |
<a href="#SET FX_SEND LEVEL">6.4.33.</a> |
<a href="#SET FX_SEND LEVEL">6.4.35.</a> |
| 332 |
Altering effect send's send level<br /> |
Altering effect send's send level<br /> |
| 333 |
<a href="#RESET CHANNEL">6.4.34.</a> |
<a href="#SEND CHANNEL MIDI_DATA">6.4.36.</a> |
| 334 |
|
Sending MIDI messages to sampler channel<br /> |
| 335 |
|
<a href="#RESET CHANNEL">6.4.37.</a> |
| 336 |
Resetting a sampler channel<br /> |
Resetting a sampler channel<br /> |
| 337 |
<a href="#anchor12">6.5.</a> |
<a href="#anchor12">6.5.</a> |
| 338 |
Controlling connection<br /> |
Controlling connection<br /> |
| 350 |
Current number of active voices<br /> |
Current number of active voices<br /> |
| 351 |
<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a> |
<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a> |
| 352 |
Maximum amount of active voices<br /> |
Maximum amount of active voices<br /> |
| 353 |
<a href="#RESET">6.6.3.</a> |
<a href="#GET TOTAL_STREAM_COUNT">6.6.3.</a> |
| 354 |
|
Current number of active disk streams<br /> |
| 355 |
|
<a href="#RESET">6.6.4.</a> |
| 356 |
Reset sampler<br /> |
Reset sampler<br /> |
| 357 |
<a href="#GET SERVER INFO">6.6.4.</a> |
<a href="#GET SERVER INFO">6.6.5.</a> |
| 358 |
General sampler informations<br /> |
General sampler informations<br /> |
| 359 |
<a href="#GET VOLUME">6.6.5.</a> |
<a href="#GET VOLUME">6.6.6.</a> |
| 360 |
Getting global volume attenuation<br /> |
Getting global volume attenuation<br /> |
| 361 |
<a href="#SET VOLUME">6.6.6.</a> |
<a href="#SET VOLUME">6.6.7.</a> |
| 362 |
Setting global volume attenuation<br /> |
Setting global volume attenuation<br /> |
| 363 |
|
<a href="#GET VOICES">6.6.8.</a> |
| 364 |
|
Getting global voice limit<br /> |
| 365 |
|
<a href="#SET VOICES">6.6.9.</a> |
| 366 |
|
Setting global voice limit<br /> |
| 367 |
|
<a href="#GET STREAMS">6.6.10.</a> |
| 368 |
|
Getting global disk stream limit<br /> |
| 369 |
|
<a href="#SET STREAMS">6.6.11.</a> |
| 370 |
|
Setting global disk stream limit<br /> |
| 371 |
<a href="#MIDI Instrument Mapping">6.7.</a> |
<a href="#MIDI Instrument Mapping">6.7.</a> |
| 372 |
MIDI Instrument Mapping<br /> |
MIDI Instrument Mapping<br /> |
| 373 |
<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a> |
<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a> |
| 440 |
Getting job status information<br /> |
Getting job status information<br /> |
| 441 |
<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a> |
<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a> |
| 442 |
Formatting the instruments database<br /> |
Formatting the instruments database<br /> |
| 443 |
|
<a href="#FIND LOST DB_INSTRUMENT_FILES">6.8.23.</a> |
| 444 |
|
Checking for lost instrument files<br /> |
| 445 |
|
<a href="#SET DB_INSTRUMENT FILE_PATH">6.8.24.</a> |
| 446 |
|
Replacing an instrument file<br /> |
| 447 |
<a href="#editing_instruments">6.9.</a> |
<a href="#editing_instruments">6.9.</a> |
| 448 |
Editing Instruments<br /> |
Editing Instruments<br /> |
| 449 |
<a href="#EDIT INSTRUMENT">6.9.1.</a> |
<a href="#EDIT INSTRUMENT">6.9.1.</a> |
| 450 |
Opening an appropriate instrument editor application<br /> |
Opening an appropriate instrument editor application<br /> |
| 451 |
|
<a href="#file_management">6.10.</a> |
| 452 |
|
Managing Files<br /> |
| 453 |
|
<a href="#GET FILE INSTRUMENTS">6.10.1.</a> |
| 454 |
|
Retrieving amount of instruments of a file<br /> |
| 455 |
|
<a href="#LIST FILE INSTRUMENTS">6.10.2.</a> |
| 456 |
|
Retrieving all instruments of a file<br /> |
| 457 |
|
<a href="#GET FILE INSTRUMENT INFO">6.10.3.</a> |
| 458 |
|
Retrieving informations about one instrument in a file<br /> |
| 459 |
|
<a href="#effects">6.11.</a> |
| 460 |
|
Managing Effects<br /> |
| 461 |
|
<a href="#GET AVAILABLE_EFFECTS">6.11.1.</a> |
| 462 |
|
Retrieve amount of available effects<br /> |
| 463 |
|
<a href="#LIST AVAILABLE_EFFECTS">6.11.2.</a> |
| 464 |
|
Get list of available effects<br /> |
| 465 |
|
<a href="#GET EFFECT INFO">6.11.3.</a> |
| 466 |
|
Retrieving general information about an effect<br /> |
| 467 |
|
<a href="#CREATE EFFECT_INSTANCE">6.11.4.</a> |
| 468 |
|
Creating an instance of an effect by its portable ID<br /> |
| 469 |
|
<a href="#CREATE EFFECT_INSTANCE (non-portable)">6.11.5.</a> |
| 470 |
|
Creating an instance of an effect by its numerical ID<br /> |
| 471 |
|
<a href="#DESTROY EFFECT_INSTANCE">6.11.6.</a> |
| 472 |
|
Destroy an effect instance<br /> |
| 473 |
|
<a href="#GET EFFECT_INSTANCES">6.11.7.</a> |
| 474 |
|
Retrieve amount of effect instances<br /> |
| 475 |
|
<a href="#LIST EFFECT_INSTANCES">6.11.8.</a> |
| 476 |
|
Get list of effect instances<br /> |
| 477 |
|
<a href="#GET EFFECT_INSTANCE INFO">6.11.9.</a> |
| 478 |
|
Retrieving current information about an effect instance<br /> |
| 479 |
|
<a href="#GET EFFECT_INSTANCE_INPUT_CONTROL INFO">6.11.10.</a> |
| 480 |
|
Retrieving information about an effect parameter<br /> |
| 481 |
|
<a href="#SET EFFECT_INSTANCE_INPUT_CONTROL VALUE">6.11.11.</a> |
| 482 |
|
Altering an effect parameter<br /> |
| 483 |
|
<a href="#GET SEND_EFFECT_CHAINS">6.11.12.</a> |
| 484 |
|
Retrieve amount of send effect chains<br /> |
| 485 |
|
<a href="#LIST SEND_EFFECT_CHAINS">6.11.13.</a> |
| 486 |
|
Retrieve list of send effect chains<br /> |
| 487 |
|
<a href="#ADD SEND_EFFECT_CHAIN">6.11.14.</a> |
| 488 |
|
Add send effect chain<br /> |
| 489 |
|
<a href="#REMOVE SEND_EFFECT_CHAIN">6.11.15.</a> |
| 490 |
|
Remove send effect chain<br /> |
| 491 |
|
<a href="#GET SEND_EFFECT_CHAIN INFO">6.11.16.</a> |
| 492 |
|
Retrieving information about a send effect chain<br /> |
| 493 |
|
<a href="#APPEND SEND_EFFECT_CHAIN EFFECT">6.11.17.</a> |
| 494 |
|
Append effect instance to a send effect chain<br /> |
| 495 |
|
<a href="#INSERT SEND_EFFECT_CHAIN EFFECT">6.11.18.</a> |
| 496 |
|
Insert effect instance to a send effect chain<br /> |
| 497 |
|
<a href="#REMOVE SEND_EFFECT_CHAIN EFFECT">6.11.19.</a> |
| 498 |
|
Remove effect instance from send effect chain<br /> |
| 499 |
<a href="#command_syntax">7.</a> |
<a href="#command_syntax">7.</a> |
| 500 |
Command Syntax<br /> |
Command Syntax<br /> |
| 501 |
<a href="#character_set">7.1.</a> |
<a href="#character_set">7.1.</a> |
| 512 |
MIDI input device's settings changed<br /> |
MIDI input device's settings changed<br /> |
| 513 |
<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a> |
<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a> |
| 514 |
Number of sampler channels changed<br /> |
Number of sampler channels changed<br /> |
| 515 |
<a href="#SUBSCRIBE VOICE_COUNT">8.6.</a> |
<a href="#SUBSCRIBE CHANNEL_MIDI">8.6.</a> |
| 516 |
|
MIDI data on a sampler channel arrived<br /> |
| 517 |
|
<a href="#SUBSCRIBE DEVICE_MIDI">8.7.</a> |
| 518 |
|
MIDI data on a MIDI input device arrived<br /> |
| 519 |
|
<a href="#SUBSCRIBE VOICE_COUNT">8.8.</a> |
| 520 |
Number of active voices changed<br /> |
Number of active voices changed<br /> |
| 521 |
<a href="#SUBSCRIBE STREAM_COUNT">8.7.</a> |
<a href="#SUBSCRIBE STREAM_COUNT">8.9.</a> |
| 522 |
Number of active disk streams changed<br /> |
Number of active disk streams changed<br /> |
| 523 |
<a href="#SUBSCRIBE BUFFER_FILL">8.8.</a> |
<a href="#SUBSCRIBE BUFFER_FILL">8.10.</a> |
| 524 |
Disk stream buffer fill state changed<br /> |
Disk stream buffer fill state changed<br /> |
| 525 |
<a href="#SUBSCRIBE CHANNEL_INFO">8.9.</a> |
<a href="#SUBSCRIBE CHANNEL_INFO">8.11.</a> |
| 526 |
Channel information changed<br /> |
Channel information changed<br /> |
| 527 |
<a href="#SUBSCRIBE FX_SEND_COUNT">8.10.</a> |
<a href="#SUBSCRIBE FX_SEND_COUNT">8.12.</a> |
| 528 |
Number of effect sends changed<br /> |
Number of effect sends changed<br /> |
| 529 |
<a href="#SUBSCRIBE FX_SEND_INFO">8.11.</a> |
<a href="#SUBSCRIBE FX_SEND_INFO">8.13.</a> |
| 530 |
Effect send information changed<br /> |
Effect send information changed<br /> |
| 531 |
<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a> |
<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.14.</a> |
| 532 |
Total number of active voices changed<br /> |
Total number of active voices changed<br /> |
| 533 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.13.</a> |
<a href="#SUBSCRIBE TOTAL_STREAM_COUNT">8.15.</a> |
| 534 |
|
Total number of active disk streams changed<br /> |
| 535 |
|
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.16.</a> |
| 536 |
Number of MIDI instrument maps changed<br /> |
Number of MIDI instrument maps changed<br /> |
| 537 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.14.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.17.</a> |
| 538 |
MIDI instrument map information changed<br /> |
MIDI instrument map information changed<br /> |
| 539 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.15.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.18.</a> |
| 540 |
Number of MIDI instruments changed<br /> |
Number of MIDI instruments changed<br /> |
| 541 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.16.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.19.</a> |
| 542 |
MIDI instrument information changed<br /> |
MIDI instrument information changed<br /> |
| 543 |
<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a> |
<a href="#SUBSCRIBE GLOBAL_INFO">8.20.</a> |
| 544 |
Global settings changed<br /> |
Global settings changed<br /> |
| 545 |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.18.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.21.</a> |
| 546 |
Number of database instrument directories changed<br /> |
Number of database instrument directories changed<br /> |
| 547 |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.19.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.22.</a> |
| 548 |
Database instrument directory information changed<br /> |
Database instrument directory information changed<br /> |
| 549 |
<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.20.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.23.</a> |
| 550 |
Number of database instruments changed<br /> |
Number of database instruments changed<br /> |
| 551 |
<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.21.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.24.</a> |
| 552 |
Database instrument information changed<br /> |
Database instrument information changed<br /> |
| 553 |
<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.22.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.25.</a> |
| 554 |
Database job status information changed<br /> |
Database job status information changed<br /> |
| 555 |
<a href="#SUBSCRIBE MISCELLANEOUS">8.23.</a> |
<a href="#SUBSCRIBE MISCELLANEOUS">8.26.</a> |
| 556 |
Miscellaneous and debugging events<br /> |
Miscellaneous and debugging events<br /> |
| 557 |
<a href="#anchor14">9.</a> |
<a href="#anchor14">9.</a> |
| 558 |
Security Considerations<br /> |
Security Considerations<br /> |
| 3513 |
</blockquote><p> |
</blockquote><p> |
| 3514 |
|
|
| 3515 |
</p> |
</p> |
| 3516 |
<p>Example: |
<p>Example (Unix): |
| 3517 |
</p> |
</p> |
| 3518 |
<p> |
<p> |
| 3519 |
</p> |
</p> |
| 3520 |
<blockquote class="text"> |
<blockquote class="text"> |
| 3521 |
|
<p>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0 |
| 3522 |
|
</p> |
| 3523 |
|
<p>S: OK |
| 3524 |
|
</p> |
| 3525 |
|
</blockquote><p> |
| 3526 |
|
|
| 3527 |
|
</p> |
| 3528 |
|
<p>Example (Windows): |
| 3529 |
|
</p> |
| 3530 |
<p> |
<p> |
| 3531 |
|
</p> |
| 3532 |
|
<blockquote class="text"> |
| 3533 |
|
<p>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0 |
| 3534 |
|
</p> |
| 3535 |
|
<p>S: OK |
| 3536 |
</p> |
</p> |
| 3537 |
</blockquote><p> |
</blockquote><p> |
| 3538 |
|
|
| 3947 |
</p> |
</p> |
| 3948 |
<blockquote class="text"> |
<blockquote class="text"> |
| 3949 |
<p>arbitrary description text about the engine |
<p>arbitrary description text about the engine |
| 3950 |
|
(note that the character string may contain |
| 3951 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
| 3952 |
</p> |
</p> |
| 3953 |
</blockquote> |
</blockquote> |
| 3954 |
|
|
| 4034 |
<blockquote class="text"> |
<blockquote class="text"> |
| 4035 |
<p>numerical ID of the audio output device which is |
<p>numerical ID of the audio output device which is |
| 4036 |
currently connected to this sampler channel to output |
currently connected to this sampler channel to output |
| 4037 |
the audio signal, "NONE" if there's no device |
the audio signal, "-1" if there's no device |
| 4038 |
connected to this sampler channel |
connected to this sampler channel |
| 4039 |
</p> |
</p> |
| 4040 |
</blockquote> |
</blockquote> |
| 4068 |
<blockquote class="text"> |
<blockquote class="text"> |
| 4069 |
<p>the file name of the loaded instrument, "NONE" if |
<p>the file name of the loaded instrument, "NONE" if |
| 4070 |
there's no instrument yet loaded for this sampler |
there's no instrument yet loaded for this sampler |
| 4071 |
channel |
channel (note: since LSCP 1.2 this path may contain |
| 4072 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
| 4073 |
</p> |
</p> |
| 4074 |
</blockquote> |
</blockquote> |
| 4075 |
|
|
| 4077 |
<p>INSTRUMENT_NR - |
<p>INSTRUMENT_NR - |
| 4078 |
</p> |
</p> |
| 4079 |
<blockquote class="text"> |
<blockquote class="text"> |
| 4080 |
<p>the instrument index number of the loaded instrument |
<p>the instrument index number of the loaded instrument, |
| 4081 |
|
"-1" if there's no instrument loaded for this sampler |
| 4082 |
|
channel |
| 4083 |
</p> |
</p> |
| 4084 |
</blockquote> |
</blockquote> |
| 4085 |
|
|
| 4088 |
</p> |
</p> |
| 4089 |
<blockquote class="text"> |
<blockquote class="text"> |
| 4090 |
<p>the instrument name of the loaded instrument |
<p>the instrument name of the loaded instrument |
| 4091 |
|
(note: since LSCP 1.2 this character string may contain |
| 4092 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
| 4093 |
</p> |
</p> |
| 4094 |
</blockquote> |
</blockquote> |
| 4095 |
|
|
| 4097 |
<p>INSTRUMENT_STATUS - |
<p>INSTRUMENT_STATUS - |
| 4098 |
</p> |
</p> |
| 4099 |
<blockquote class="text"> |
<blockquote class="text"> |
| 4100 |
<p>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative |
<p>Integer values 0 to 100 indicating loading progress |
| 4101 |
value indicates a loading exception. Value of 100 indicates that the instrument is fully |
percentage for the instrument. Negative |
| 4102 |
|
value indicates a loading exception (also returns "-1" in case no |
| 4103 |
|
instrument was yet to be loaded on the sampler channel). |
| 4104 |
|
Value of 100 indicates that the instrument is fully |
| 4105 |
loaded. |
loaded. |
| 4106 |
</p> |
</p> |
| 4107 |
</blockquote> |
</blockquote> |
| 4112 |
<blockquote class="text"> |
<blockquote class="text"> |
| 4113 |
<p>numerical ID of the MIDI input device which is |
<p>numerical ID of the MIDI input device which is |
| 4114 |
currently connected to this sampler channel to deliver |
currently connected to this sampler channel to deliver |
| 4115 |
MIDI input commands, "NONE" if there's no device |
MIDI input commands, "-1" if there's no device |
| 4116 |
connected to this sampler channel |
connected to this sampler channel |
| 4117 |
</p> |
</p> |
| 4118 |
</blockquote> |
</blockquote> |
| 4121 |
<p>MIDI_INPUT_PORT - |
<p>MIDI_INPUT_PORT - |
| 4122 |
</p> |
</p> |
| 4123 |
<blockquote class="text"> |
<blockquote class="text"> |
| 4124 |
<p>port number of the MIDI input device |
<p>port number of the MIDI input device (in case a |
| 4125 |
|
MIDI device was already assigned to the sampler |
| 4126 |
|
channel) |
| 4127 |
</p> |
</p> |
| 4128 |
</blockquote> |
</blockquote> |
| 4129 |
|
|
| 5441 |
</p> |
</p> |
| 5442 |
<blockquote class="text"> |
<blockquote class="text"> |
| 5443 |
<p>name of the effect send entity |
<p>name of the effect send entity |
| 5444 |
|
(note that this character string may contain |
| 5445 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
| 5446 |
</p> |
</p> |
| 5447 |
</blockquote> |
</blockquote> |
| 5448 |
|
|
| 5477 |
channel 1 is routed to the channel 3 of the audio |
channel 1 is routed to the channel 3 of the audio |
| 5478 |
output device (see |
output device (see |
| 5479 |
<a class='info' href='#SET FX_SEND AUDIO_OUTPUT_CHANNEL'>"SET FX_SEND AUDIO_OUTPUT_CHANNEL"<span> (</span><span class='info'>Altering effect send's audio routing</span><span>)</span></a> |
<a class='info' href='#SET FX_SEND AUDIO_OUTPUT_CHANNEL'>"SET FX_SEND AUDIO_OUTPUT_CHANNEL"<span> (</span><span class='info'>Altering effect send's audio routing</span><span>)</span></a> |
| 5480 |
for details) |
for details), if an internal send |
| 5481 |
|
effect is assigned to the effect |
| 5482 |
|
send, then this setting defines the |
| 5483 |
|
audio channel routing to that |
| 5484 |
|
effect instance respectively |
| 5485 |
|
</p> |
| 5486 |
|
</blockquote> |
| 5487 |
|
|
| 5488 |
|
|
| 5489 |
|
<p>EFFECT - |
| 5490 |
|
</p> |
| 5491 |
|
<blockquote class="text"> |
| 5492 |
|
<p>destination send effect chain ID |
| 5493 |
|
and destination effect chain |
| 5494 |
|
position, separated by comma in the |
| 5495 |
|
form "<effect-chain>,<chain-pos>" |
| 5496 |
|
or "NONE" if there is no send effect |
| 5497 |
|
assigned to the effect send |
| 5498 |
</p> |
</p> |
| 5499 |
</blockquote> |
</blockquote> |
| 5500 |
|
|
| 5522 |
</p> |
</p> |
| 5523 |
<p> "AUDIO_OUTPUT_ROUTING: 2,3" |
<p> "AUDIO_OUTPUT_ROUTING: 2,3" |
| 5524 |
</p> |
</p> |
| 5525 |
|
<p> "EFFECT: NONE" |
| 5526 |
|
</p> |
| 5527 |
|
<p> "." |
| 5528 |
|
</p> |
| 5529 |
|
</blockquote><p> |
| 5530 |
|
|
| 5531 |
|
</p> |
| 5532 |
|
<p> |
| 5533 |
|
</p> |
| 5534 |
|
<blockquote class="text"> |
| 5535 |
|
<p>C: "GET FX_SEND INFO 0 1" |
| 5536 |
|
</p> |
| 5537 |
|
<p>S: "NAME: Delay Send (Internal)" |
| 5538 |
|
</p> |
| 5539 |
|
<p> "MIDI_CONTROLLER: 93" |
| 5540 |
|
</p> |
| 5541 |
|
<p> "LEVEL: 0.51" |
| 5542 |
|
</p> |
| 5543 |
|
<p> "AUDIO_OUTPUT_ROUTING: 1,2" |
| 5544 |
|
</p> |
| 5545 |
|
<p> "EFFECT: 2,0" |
| 5546 |
|
</p> |
| 5547 |
<p> "." |
<p> "." |
| 5548 |
</p> |
</p> |
| 5549 |
</blockquote><p> |
</blockquote><p> |
| 5638 |
<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 |
| 5639 |
which should be rerouted and <audio-dst> is the numerical ID of |
which should be rerouted and <audio-dst> is the numerical ID of |
| 5640 |
the audio channel of the selected audio output device where <audio-src> |
the audio channel of the selected audio output device where <audio-src> |
| 5641 |
should be routed to. |
should be routed to. If an internal send effect is assigned |
| 5642 |
|
to the effect send, then this setting defines the audio |
| 5643 |
|
channel routing to that effect instance respectively. |
| 5644 |
</p> |
</p> |
| 5645 |
<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 |
| 5646 |
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 |
| 5698 |
</blockquote><p> |
</blockquote><p> |
| 5699 |
|
|
| 5700 |
</p> |
</p> |
| 5701 |
<a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr /> |
<a name="SET FX_SEND EFFECT"></a><br /><hr /> |
| 5702 |
<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> |
| 5703 |
<a name="rfc.section.6.4.32"></a><h3>6.4.32. |
<a name="rfc.section.6.4.32"></a><h3>6.4.32. |
| 5704 |
|
Assigning destination effect to an effect send</h3> |
| 5705 |
|
|
| 5706 |
|
<p>The front-end can (re-)assign a destination effect to an |
| 5707 |
|
effect send by sending the following command: |
| 5708 |
|
</p> |
| 5709 |
|
<p> |
| 5710 |
|
</p> |
| 5711 |
|
<blockquote class="text"> |
| 5712 |
|
<p>SET FX_SEND EFFECT <sampler-chan> <fx-send-id> <effect-chain> <chain-pos> |
| 5713 |
|
</p> |
| 5714 |
|
</blockquote><p> |
| 5715 |
|
|
| 5716 |
|
</p> |
| 5717 |
|
<p>Where <sampler-chan> is the sampler channel number |
| 5718 |
|
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> |
| 5719 |
|
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, |
| 5720 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
| 5721 |
|
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> |
| 5722 |
|
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, |
| 5723 |
|
<effect-chain> by the numerical ID of the destination |
| 5724 |
|
effect chain as returned by the |
| 5725 |
|
<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> |
| 5726 |
|
or |
| 5727 |
|
<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> |
| 5728 |
|
command and <chain-pos> reflects the exact effect |
| 5729 |
|
chain position in the effect chain which hosts the actual |
| 5730 |
|
destination effect. |
| 5731 |
|
</p> |
| 5732 |
|
<p>Possible Answers: |
| 5733 |
|
</p> |
| 5734 |
|
<p> |
| 5735 |
|
</p> |
| 5736 |
|
<blockquote class="text"> |
| 5737 |
|
<p>"OK" - |
| 5738 |
|
</p> |
| 5739 |
|
<blockquote class="text"> |
| 5740 |
|
<p>on success |
| 5741 |
|
</p> |
| 5742 |
|
</blockquote> |
| 5743 |
|
|
| 5744 |
|
|
| 5745 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 5746 |
|
</p> |
| 5747 |
|
<blockquote class="text"> |
| 5748 |
|
<p>in case it failed, providing an appropriate error code and error message |
| 5749 |
|
</p> |
| 5750 |
|
</blockquote> |
| 5751 |
|
|
| 5752 |
|
|
| 5753 |
|
</blockquote><p> |
| 5754 |
|
|
| 5755 |
|
</p> |
| 5756 |
|
<p>Example: |
| 5757 |
|
</p> |
| 5758 |
|
<p> |
| 5759 |
|
</p> |
| 5760 |
|
<blockquote class="text"> |
| 5761 |
|
<p>C: "SET FX_SEND EFFECT 0 0 2 5" |
| 5762 |
|
</p> |
| 5763 |
|
<p>S: "OK" |
| 5764 |
|
</p> |
| 5765 |
|
</blockquote><p> |
| 5766 |
|
|
| 5767 |
|
</p> |
| 5768 |
|
<a name="REMOVE FX_SEND EFFECT"></a><br /><hr /> |
| 5769 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 5770 |
|
<a name="rfc.section.6.4.33"></a><h3>6.4.33. |
| 5771 |
|
Removing destination effect from an effect send</h3> |
| 5772 |
|
|
| 5773 |
|
<p>The front-end can (re-)assign a destination effect to an |
| 5774 |
|
effect send by sending the following command: |
| 5775 |
|
</p> |
| 5776 |
|
<p> |
| 5777 |
|
</p> |
| 5778 |
|
<blockquote class="text"> |
| 5779 |
|
<p>REMOVE FX_SEND EFFECT <sampler-chan> <fx-send-id> |
| 5780 |
|
</p> |
| 5781 |
|
</blockquote><p> |
| 5782 |
|
|
| 5783 |
|
</p> |
| 5784 |
|
<p>Where <sampler-chan> is the sampler channel number |
| 5785 |
|
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> |
| 5786 |
|
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, |
| 5787 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
| 5788 |
|
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> |
| 5789 |
|
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. |
| 5790 |
|
</p> |
| 5791 |
|
<p>After the destination effect has been removed from the |
| 5792 |
|
effect send, the audio signal of the effect send will be |
| 5793 |
|
routed directly to the audio output device, according to the |
| 5794 |
|
audio channel routing setting of the effect send. |
| 5795 |
|
|
| 5796 |
|
</p> |
| 5797 |
|
<p>Possible Answers: |
| 5798 |
|
</p> |
| 5799 |
|
<p> |
| 5800 |
|
</p> |
| 5801 |
|
<blockquote class="text"> |
| 5802 |
|
<p>"OK" - |
| 5803 |
|
</p> |
| 5804 |
|
<blockquote class="text"> |
| 5805 |
|
<p>on success |
| 5806 |
|
</p> |
| 5807 |
|
</blockquote> |
| 5808 |
|
|
| 5809 |
|
|
| 5810 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 5811 |
|
</p> |
| 5812 |
|
<blockquote class="text"> |
| 5813 |
|
<p>in case it failed, providing an appropriate error code and error message |
| 5814 |
|
</p> |
| 5815 |
|
</blockquote> |
| 5816 |
|
|
| 5817 |
|
|
| 5818 |
|
</blockquote><p> |
| 5819 |
|
|
| 5820 |
|
</p> |
| 5821 |
|
<p>Example: |
| 5822 |
|
</p> |
| 5823 |
|
<p> |
| 5824 |
|
</p> |
| 5825 |
|
<blockquote class="text"> |
| 5826 |
|
<p>C: "REMOVE FX_SEND EFFECT 0 0" |
| 5827 |
|
</p> |
| 5828 |
|
<p>S: "OK" |
| 5829 |
|
</p> |
| 5830 |
|
</blockquote><p> |
| 5831 |
|
|
| 5832 |
|
</p> |
| 5833 |
|
<a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr /> |
| 5834 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 5835 |
|
<a name="rfc.section.6.4.34"></a><h3>6.4.34. |
| 5836 |
Altering effect send's MIDI controller</h3> |
Altering effect send's MIDI controller</h3> |
| 5837 |
|
|
| 5838 |
<p>The front-end can alter the MIDI controller of an effect |
<p>The front-end can alter the MIDI controller of an effect |
| 5903 |
</p> |
</p> |
| 5904 |
<a name="SET FX_SEND LEVEL"></a><br /><hr /> |
<a name="SET FX_SEND LEVEL"></a><br /><hr /> |
| 5905 |
<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> |
| 5906 |
<a name="rfc.section.6.4.33"></a><h3>6.4.33. |
<a name="rfc.section.6.4.35"></a><h3>6.4.35. |
| 5907 |
Altering effect send's send level</h3> |
Altering effect send's send level</h3> |
| 5908 |
|
|
| 5909 |
<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 |
| 5973 |
</blockquote><p> |
</blockquote><p> |
| 5974 |
|
|
| 5975 |
</p> |
</p> |
| 5976 |
|
<a name="SEND CHANNEL MIDI_DATA"></a><br /><hr /> |
| 5977 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 5978 |
|
<a name="rfc.section.6.4.36"></a><h3>6.4.36. |
| 5979 |
|
Sending MIDI messages to sampler channel</h3> |
| 5980 |
|
|
| 5981 |
|
<p>The front-end can send MIDI events to a specific sampler channel |
| 5982 |
|
by sending the following command: |
| 5983 |
|
</p> |
| 5984 |
|
<p> |
| 5985 |
|
</p> |
| 5986 |
|
<blockquote class="text"> |
| 5987 |
|
<p>SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2> |
| 5988 |
|
</p> |
| 5989 |
|
</blockquote><p> |
| 5990 |
|
|
| 5991 |
|
</p> |
| 5992 |
|
<p>Where <sampler-chan> is the sampler channel number |
| 5993 |
|
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> |
| 5994 |
|
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, |
| 5995 |
|
<arg1> and <arg2> arguments depend on the <midi-msg> argument, which |
| 5996 |
|
specifies the MIDI message type. Currently, the following MIDI messages are supported: |
| 5997 |
|
</p> |
| 5998 |
|
<p> |
| 5999 |
|
</p> |
| 6000 |
|
<blockquote class="text"> |
| 6001 |
|
<p>"NOTE_ON" - |
| 6002 |
|
</p> |
| 6003 |
|
<blockquote class="text"> |
| 6004 |
|
<p>For turning on MIDI notes, where <arg1> |
| 6005 |
|
specifies the key number and <arg2> the velocity |
| 6006 |
|
as described in the MIDI specification. |
| 6007 |
|
</p> |
| 6008 |
|
</blockquote> |
| 6009 |
|
|
| 6010 |
|
|
| 6011 |
|
<p>"NOTE_OFF" - |
| 6012 |
|
</p> |
| 6013 |
|
<blockquote class="text"> |
| 6014 |
|
<p>For turning a currently playing MIDI note off, where <arg1> |
| 6015 |
|
specifies the key number and <arg2> the velocity |
| 6016 |
|
as described in the MIDI specification. |
| 6017 |
|
</p> |
| 6018 |
|
</blockquote> |
| 6019 |
|
|
| 6020 |
|
|
| 6021 |
|
<p>"CC" - |
| 6022 |
|
</p> |
| 6023 |
|
<blockquote class="text"> |
| 6024 |
|
<p>For changing a MIDI controller, where <arg1> |
| 6025 |
|
specifies the controller number and <arg2> the |
| 6026 |
|
new value of the controller as described in the Control |
| 6027 |
|
Change section of the MIDI specification. |
| 6028 |
|
</p> |
| 6029 |
|
</blockquote> |
| 6030 |
|
|
| 6031 |
|
|
| 6032 |
|
</blockquote><p> |
| 6033 |
|
|
| 6034 |
|
</p> |
| 6035 |
|
<p>CAUTION: This command is provided for implementations of virtual MIDI keyboards |
| 6036 |
|
and no realtime guarantee whatsoever will be made! |
| 6037 |
|
</p> |
| 6038 |
|
<p>Possible Answers: |
| 6039 |
|
</p> |
| 6040 |
|
<p> |
| 6041 |
|
</p> |
| 6042 |
|
<blockquote class="text"> |
| 6043 |
|
<p>"OK" - |
| 6044 |
|
</p> |
| 6045 |
|
<blockquote class="text"> |
| 6046 |
|
<p>on success |
| 6047 |
|
</p> |
| 6048 |
|
</blockquote> |
| 6049 |
|
|
| 6050 |
|
|
| 6051 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 6052 |
|
</p> |
| 6053 |
|
<blockquote class="text"> |
| 6054 |
|
<p>in case it failed, providing an appropriate error code and error message |
| 6055 |
|
</p> |
| 6056 |
|
</blockquote> |
| 6057 |
|
|
| 6058 |
|
|
| 6059 |
|
</blockquote><p> |
| 6060 |
|
|
| 6061 |
|
</p> |
| 6062 |
|
<p>Example: |
| 6063 |
|
</p> |
| 6064 |
|
<p> |
| 6065 |
|
</p> |
| 6066 |
|
<blockquote class="text"> |
| 6067 |
|
<p>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112" |
| 6068 |
|
</p> |
| 6069 |
|
<p>S: "OK" |
| 6070 |
|
</p> |
| 6071 |
|
</blockquote><p> |
| 6072 |
|
|
| 6073 |
|
</p> |
| 6074 |
<a name="RESET CHANNEL"></a><br /><hr /> |
<a name="RESET CHANNEL"></a><br /><hr /> |
| 6075 |
<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> |
| 6076 |
<a name="rfc.section.6.4.34"></a><h3>6.4.34. |
<a name="rfc.section.6.4.37"></a><h3>6.4.37. |
| 6077 |
Resetting a sampler channel</h3> |
Resetting a sampler channel</h3> |
| 6078 |
|
|
| 6079 |
<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: |
| 6408 |
</blockquote><p> |
</blockquote><p> |
| 6409 |
|
|
| 6410 |
</p> |
</p> |
| 6411 |
<a name="RESET"></a><br /><hr /> |
<a name="GET TOTAL_STREAM_COUNT"></a><br /><hr /> |
| 6412 |
<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> |
| 6413 |
<a name="rfc.section.6.6.3"></a><h3>6.6.3. |
<a name="rfc.section.6.6.3"></a><h3>6.6.3. |
| 6414 |
|
Current number of active disk streams</h3> |
| 6415 |
|
|
| 6416 |
|
<p>The front-end can ask for the current number of active disk streams on |
| 6417 |
|
the sampler by sending the following command: |
| 6418 |
|
</p> |
| 6419 |
|
<p> |
| 6420 |
|
</p> |
| 6421 |
|
<blockquote class="text"> |
| 6422 |
|
<p>GET TOTAL_STREAM_COUNT |
| 6423 |
|
</p> |
| 6424 |
|
</blockquote><p> |
| 6425 |
|
|
| 6426 |
|
</p> |
| 6427 |
|
<p>Possible Answers: |
| 6428 |
|
</p> |
| 6429 |
|
<p> |
| 6430 |
|
</p> |
| 6431 |
|
<blockquote class="text"> |
| 6432 |
|
<p>LinuxSampler will answer by returning the number of all active |
| 6433 |
|
disk streams on the sampler. |
| 6434 |
|
</p> |
| 6435 |
|
</blockquote><p> |
| 6436 |
|
|
| 6437 |
|
</p> |
| 6438 |
|
<a name="RESET"></a><br /><hr /> |
| 6439 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 6440 |
|
<a name="rfc.section.6.6.4"></a><h3>6.6.4. |
| 6441 |
Reset sampler</h3> |
Reset sampler</h3> |
| 6442 |
|
|
| 6443 |
<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: |
| 6478 |
</p> |
</p> |
| 6479 |
<a name="GET SERVER INFO"></a><br /><hr /> |
<a name="GET SERVER INFO"></a><br /><hr /> |
| 6480 |
<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> |
| 6481 |
<a name="rfc.section.6.6.4"></a><h3>6.6.4. |
<a name="rfc.section.6.6.5"></a><h3>6.6.5. |
| 6482 |
General sampler informations</h3> |
General sampler informations</h3> |
| 6483 |
|
|
| 6484 |
<p>The client can ask for general informations about the LinuxSampler |
<p>The client can ask for general informations about the LinuxSampler |
| 6554 |
</p> |
</p> |
| 6555 |
<a name="GET VOLUME"></a><br /><hr /> |
<a name="GET VOLUME"></a><br /><hr /> |
| 6556 |
<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> |
| 6557 |
<a name="rfc.section.6.6.5"></a><h3>6.6.5. |
<a name="rfc.section.6.6.6"></a><h3>6.6.6. |
| 6558 |
Getting global volume attenuation</h3> |
Getting global volume attenuation</h3> |
| 6559 |
|
|
| 6560 |
<p>The client can ask for the current global sampler-wide volume |
<p>The client can ask for the current global sampler-wide volume |
| 6587 |
</p> |
</p> |
| 6588 |
<a name="SET VOLUME"></a><br /><hr /> |
<a name="SET VOLUME"></a><br /><hr /> |
| 6589 |
<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> |
| 6590 |
<a name="rfc.section.6.6.6"></a><h3>6.6.6. |
<a name="rfc.section.6.6.7"></a><h3>6.6.7. |
| 6591 |
Setting global volume attenuation</h3> |
Setting global volume attenuation</h3> |
| 6592 |
|
|
| 6593 |
<p>The client can alter the current global sampler-wide volume |
<p>The client can alter the current global sampler-wide volume |
| 6640 |
</blockquote><p> |
</blockquote><p> |
| 6641 |
|
|
| 6642 |
</p> |
</p> |
| 6643 |
|
<a name="GET VOICES"></a><br /><hr /> |
| 6644 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 6645 |
|
<a name="rfc.section.6.6.8"></a><h3>6.6.8. |
| 6646 |
|
Getting global voice limit</h3> |
| 6647 |
|
|
| 6648 |
|
<p>The client can ask for the current global sampler-wide limit |
| 6649 |
|
for maximum voices by sending the following command: |
| 6650 |
|
</p> |
| 6651 |
|
<p> |
| 6652 |
|
</p> |
| 6653 |
|
<blockquote class="text"> |
| 6654 |
|
<p>GET VOICES |
| 6655 |
|
</p> |
| 6656 |
|
</blockquote><p> |
| 6657 |
|
|
| 6658 |
|
</p> |
| 6659 |
|
<p>Possible Answers: |
| 6660 |
|
</p> |
| 6661 |
|
<p> |
| 6662 |
|
</p> |
| 6663 |
|
<blockquote class="text"> |
| 6664 |
|
<p>LinuxSampler will answer by returning the number for |
| 6665 |
|
the current limit of maximum voices. |
| 6666 |
|
</p> |
| 6667 |
|
</blockquote><p> |
| 6668 |
|
|
| 6669 |
|
</p> |
| 6670 |
|
<p>The voice limit setting defines how many voices should maximum |
| 6671 |
|
be processed by the sampler at the same time. If the user |
| 6672 |
|
triggers new notes which would exceed that voice limit, the |
| 6673 |
|
sampler engine will react by stealing old voices for those |
| 6674 |
|
newly triggered notes. Note that the amount of voices triggered |
| 6675 |
|
by a new note can be larger than one and is dependent to the |
| 6676 |
|
respective instrument and probably further criterias. |
| 6677 |
|
</p> |
| 6678 |
|
<a name="SET VOICES"></a><br /><hr /> |
| 6679 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 6680 |
|
<a name="rfc.section.6.6.9"></a><h3>6.6.9. |
| 6681 |
|
Setting global voice limit</h3> |
| 6682 |
|
|
| 6683 |
|
<p>The client can alter the current global sampler-wide limit |
| 6684 |
|
for maximum voices by sending the following command: |
| 6685 |
|
</p> |
| 6686 |
|
<p> |
| 6687 |
|
</p> |
| 6688 |
|
<blockquote class="text"> |
| 6689 |
|
<p>SET VOICES <max-voices> |
| 6690 |
|
</p> |
| 6691 |
|
</blockquote><p> |
| 6692 |
|
|
| 6693 |
|
</p> |
| 6694 |
|
<p>Where <max-voices> should be replaced by the integer |
| 6695 |
|
value, reflecting the new global amount limit of maximum voices. |
| 6696 |
|
This value has to be larger than 0. |
| 6697 |
|
</p> |
| 6698 |
|
<p>Possible Answers: |
| 6699 |
|
</p> |
| 6700 |
|
<p> |
| 6701 |
|
</p> |
| 6702 |
|
<blockquote class="text"> |
| 6703 |
|
<p>"OK" - |
| 6704 |
|
</p> |
| 6705 |
|
<blockquote class="text"> |
| 6706 |
|
<p>on success |
| 6707 |
|
</p> |
| 6708 |
|
</blockquote> |
| 6709 |
|
|
| 6710 |
|
|
| 6711 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
| 6712 |
|
</p> |
| 6713 |
|
<blockquote class="text"> |
| 6714 |
|
<p>if the voice limit was set, but there are noteworthy |
| 6715 |
|
issue(s) related, providing an appropriate warning code and |
| 6716 |
|
warning message |
| 6717 |
|
</p> |
| 6718 |
|
</blockquote> |
| 6719 |
|
|
| 6720 |
|
|
| 6721 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 6722 |
|
</p> |
| 6723 |
|
<blockquote class="text"> |
| 6724 |
|
<p>in case it failed, providing an appropriate error code and error message |
| 6725 |
|
</p> |
| 6726 |
|
</blockquote> |
| 6727 |
|
|
| 6728 |
|
|
| 6729 |
|
</blockquote><p> |
| 6730 |
|
|
| 6731 |
|
</p> |
| 6732 |
|
<p>Note: the given value will be passed to all sampler engine instances. |
| 6733 |
|
The total amount of maximum voices on the running system might thus |
| 6734 |
|
be as big as the given value multiplied by the current amount of engine |
| 6735 |
|
instances. |
| 6736 |
|
</p> |
| 6737 |
|
<p>Caution: when adjusting the voice limit, you SHOULD also |
| 6738 |
|
adjust the disk stream limit respectively and vice versa. |
| 6739 |
|
</p> |
| 6740 |
|
<a name="GET STREAMS"></a><br /><hr /> |
| 6741 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 6742 |
|
<a name="rfc.section.6.6.10"></a><h3>6.6.10. |
| 6743 |
|
Getting global disk stream limit</h3> |
| 6744 |
|
|
| 6745 |
|
<p>The client can ask for the current global sampler-wide limit |
| 6746 |
|
for maximum disk streams by sending the following command: |
| 6747 |
|
</p> |
| 6748 |
|
<p> |
| 6749 |
|
</p> |
| 6750 |
|
<blockquote class="text"> |
| 6751 |
|
<p>GET STREAMS |
| 6752 |
|
</p> |
| 6753 |
|
</blockquote><p> |
| 6754 |
|
|
| 6755 |
|
</p> |
| 6756 |
|
<p>Possible Answers: |
| 6757 |
|
</p> |
| 6758 |
|
<p> |
| 6759 |
|
</p> |
| 6760 |
|
<blockquote class="text"> |
| 6761 |
|
<p>LinuxSampler will answer by returning the number for |
| 6762 |
|
the current limit of maximum disk streams. |
| 6763 |
|
</p> |
| 6764 |
|
</blockquote><p> |
| 6765 |
|
|
| 6766 |
|
</p> |
| 6767 |
|
<p>The disk stream limit setting defines how many disk streams should |
| 6768 |
|
maximum be processed by a sampler engine at the same time. The |
| 6769 |
|
higher this value, the more memory (RAM) will be occupied, since |
| 6770 |
|
every disk streams allocates a certain buffer size for being able |
| 6771 |
|
to perform its streaming operations. |
| 6772 |
|
</p> |
| 6773 |
|
<a name="SET STREAMS"></a><br /><hr /> |
| 6774 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 6775 |
|
<a name="rfc.section.6.6.11"></a><h3>6.6.11. |
| 6776 |
|
Setting global disk stream limit</h3> |
| 6777 |
|
|
| 6778 |
|
<p>The client can alter the current global sampler-wide limit |
| 6779 |
|
for maximum disk streams by sending the following command: |
| 6780 |
|
</p> |
| 6781 |
|
<p> |
| 6782 |
|
</p> |
| 6783 |
|
<blockquote class="text"> |
| 6784 |
|
<p>SET STREAMS <max-streams> |
| 6785 |
|
</p> |
| 6786 |
|
</blockquote><p> |
| 6787 |
|
|
| 6788 |
|
</p> |
| 6789 |
|
<p>Where <max-streams> should be replaced by the integer |
| 6790 |
|
value, reflecting the new global amount limit of maximum disk streams. |
| 6791 |
|
This value has to be positive. |
| 6792 |
|
</p> |
| 6793 |
|
<p>Possible Answers: |
| 6794 |
|
</p> |
| 6795 |
|
<p> |
| 6796 |
|
</p> |
| 6797 |
|
<blockquote class="text"> |
| 6798 |
|
<p>"OK" - |
| 6799 |
|
</p> |
| 6800 |
|
<blockquote class="text"> |
| 6801 |
|
<p>on success |
| 6802 |
|
</p> |
| 6803 |
|
</blockquote> |
| 6804 |
|
|
| 6805 |
|
|
| 6806 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
| 6807 |
|
</p> |
| 6808 |
|
<blockquote class="text"> |
| 6809 |
|
<p>if the disk stream limit was set, but there are noteworthy |
| 6810 |
|
issue(s) related, providing an appropriate warning code and |
| 6811 |
|
warning message |
| 6812 |
|
</p> |
| 6813 |
|
</blockquote> |
| 6814 |
|
|
| 6815 |
|
|
| 6816 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 6817 |
|
</p> |
| 6818 |
|
<blockquote class="text"> |
| 6819 |
|
<p>in case it failed, providing an appropriate error code and error message |
| 6820 |
|
</p> |
| 6821 |
|
</blockquote> |
| 6822 |
|
|
| 6823 |
|
|
| 6824 |
|
</blockquote><p> |
| 6825 |
|
|
| 6826 |
|
</p> |
| 6827 |
|
<p>Note: the given value will be passed to all sampler engine instances. |
| 6828 |
|
The total amount of maximum disk streams on the running system might |
| 6829 |
|
thus be as big as the given value multiplied by the current amount of |
| 6830 |
|
engine instances. |
| 6831 |
|
</p> |
| 6832 |
|
<p>Caution: when adjusting the disk stream limit, you SHOULD also |
| 6833 |
|
adjust the voice limit respectively and vice versa. |
| 6834 |
|
</p> |
| 6835 |
<a name="MIDI Instrument Mapping"></a><br /><hr /> |
<a name="MIDI Instrument Mapping"></a><br /><hr /> |
| 6836 |
<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> |
| 6837 |
<a name="rfc.section.6.7"></a><h3>6.7. |
<a name="rfc.section.6.7"></a><h3>6.7. |
| 7145 |
<blockquote class="text"> |
<blockquote class="text"> |
| 7146 |
<p>custom name of the given map, |
<p>custom name of the given map, |
| 7147 |
which does not have to be unique |
which does not have to be unique |
| 7148 |
|
(note that this character string may contain |
| 7149 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
| 7150 |
</p> |
</p> |
| 7151 |
</blockquote> |
</blockquote> |
| 7152 |
|
|
| 7695 |
changed with the |
changed with the |
| 7696 |
<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> |
| 7697 |
command and does not have to be unique. |
command and does not have to be unique. |
| 7698 |
|
(note that this character string may contain |
| 7699 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
| 7700 |
</p> |
</p> |
| 7701 |
</blockquote> |
</blockquote> |
| 7702 |
|
|
| 7713 |
<p>"INSTRUMENT_FILE" - |
<p>"INSTRUMENT_FILE" - |
| 7714 |
</p> |
</p> |
| 7715 |
<blockquote class="text"> |
<blockquote class="text"> |
| 7716 |
<p>File name of the instrument. |
<p>File name of the instrument |
| 7717 |
|
(note that this path may contain |
| 7718 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>). |
| 7719 |
</p> |
</p> |
| 7720 |
</blockquote> |
</blockquote> |
| 7721 |
|
|
| 7733 |
<blockquote class="text"> |
<blockquote class="text"> |
| 7734 |
<p>Name of the loaded instrument as reflected by its file. |
<p>Name of the loaded instrument as reflected by its file. |
| 7735 |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
| 7736 |
cannot be changed. |
cannot be changed (note that this character string may contain |
| 7737 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>). |
| 7738 |
</p> |
</p> |
| 7739 |
</blockquote> |
</blockquote> |
| 7740 |
|
|
| 8578 |
<p> |
<p> |
| 8579 |
</p> |
</p> |
| 8580 |
<blockquote class="text"> |
<blockquote class="text"> |
| 8581 |
<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>] |
| 8582 |
</p> |
</p> |
| 8583 |
</blockquote><p> |
</blockquote><p> |
| 8584 |
|
|
| 8636 |
</blockquote><p> |
</blockquote><p> |
| 8637 |
|
|
| 8638 |
</p> |
</p> |
| 8639 |
|
<p> If FILE_AS_DIR argument is supplied, all instruments in an instrument |
| 8640 |
|
file will be added to a separate directory in the instruments database, which |
| 8641 |
|
name will be the name of the instrument file with the file extension stripped off. |
| 8642 |
|
|
| 8643 |
|
</p> |
| 8644 |
<p>The difference between regular and NON_MODAL versions of the command |
<p>The difference between regular and NON_MODAL versions of the command |
| 8645 |
is that the regular command returns when the scanning is finished |
is that the regular command returns when the scanning is finished |
| 8646 |
while NON_MODAL version returns immediately and a background process is launched. |
while NON_MODAL version returns immediately and a background process is launched. |
| 9245 |
|
|
| 9246 |
</p> |
</p> |
| 9247 |
<p>Where <instr> is the absolute path name of the instrument and |
<p>Where <instr> is the absolute path name of the instrument and |
| 9248 |
<desc> is the new description for the instrument |
<desc> is the new description for the instrument |
| 9249 |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
| 9250 |
"<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>"). |
| 9251 |
</p> |
</p> |
| 9627 |
</blockquote><p> |
</blockquote><p> |
| 9628 |
|
|
| 9629 |
</p> |
</p> |
| 9630 |
|
<a name="FIND LOST DB_INSTRUMENT_FILES"></a><br /><hr /> |
| 9631 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 9632 |
|
<a name="rfc.section.6.8.23"></a><h3>6.8.23. |
| 9633 |
|
Checking for lost instrument files</h3> |
| 9634 |
|
|
| 9635 |
|
<p>The front-end can retrieve the list of all instrument files in the instruments database |
| 9636 |
|
that don't exist in the filesystem by sending the following command: |
| 9637 |
|
</p> |
| 9638 |
|
<p> |
| 9639 |
|
</p> |
| 9640 |
|
<blockquote class="text"> |
| 9641 |
|
<p>FIND LOST DB_INSTRUMENT_FILES |
| 9642 |
|
</p> |
| 9643 |
|
</blockquote><p> |
| 9644 |
|
|
| 9645 |
|
</p> |
| 9646 |
|
<p>Possible Answers: |
| 9647 |
|
</p> |
| 9648 |
|
<p> |
| 9649 |
|
</p> |
| 9650 |
|
<blockquote class="text"> |
| 9651 |
|
<p>A comma separated list with the absolute path names |
| 9652 |
|
(encapsulated into apostrophes) of all lost instrument files. |
| 9653 |
|
</p> |
| 9654 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 9655 |
|
</p> |
| 9656 |
|
<blockquote class="text"> |
| 9657 |
|
<p>in case it failed, providing an appropriate error code and error message. |
| 9658 |
|
</p> |
| 9659 |
|
</blockquote> |
| 9660 |
|
|
| 9661 |
|
|
| 9662 |
|
</blockquote><p> |
| 9663 |
|
|
| 9664 |
|
</p> |
| 9665 |
|
<p>Example: |
| 9666 |
|
</p> |
| 9667 |
|
<p> |
| 9668 |
|
</p> |
| 9669 |
|
<blockquote class="text"> |
| 9670 |
|
<p>C: "FIND LOST DB_INSTRUMENT_FILES" |
| 9671 |
|
</p> |
| 9672 |
|
<p>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'" |
| 9673 |
|
</p> |
| 9674 |
|
</blockquote><p> |
| 9675 |
|
|
| 9676 |
|
</p> |
| 9677 |
|
<a name="SET DB_INSTRUMENT FILE_PATH"></a><br /><hr /> |
| 9678 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 9679 |
|
<a name="rfc.section.6.8.24"></a><h3>6.8.24. |
| 9680 |
|
Replacing an instrument file</h3> |
| 9681 |
|
|
| 9682 |
|
<p>The front-end can substitute all occurrences of an instrument file |
| 9683 |
|
in the instruments database with a new one by sending the following command: |
| 9684 |
|
</p> |
| 9685 |
|
<p> |
| 9686 |
|
</p> |
| 9687 |
|
<blockquote class="text"> |
| 9688 |
|
<p>SET DB_INSTRUMENT FILE_PATH <old_path> <new_path> |
| 9689 |
|
</p> |
| 9690 |
|
</blockquote><p> |
| 9691 |
|
|
| 9692 |
|
</p> |
| 9693 |
|
<p>Where <old_path> is the absolute path name of the instrument file |
| 9694 |
|
to substitute with <new_path>. |
| 9695 |
|
</p> |
| 9696 |
|
<p>Possible Answers: |
| 9697 |
|
</p> |
| 9698 |
|
<p> |
| 9699 |
|
</p> |
| 9700 |
|
<blockquote class="text"> |
| 9701 |
|
<p>"OK" - |
| 9702 |
|
</p> |
| 9703 |
|
<blockquote class="text"> |
| 9704 |
|
<p>on success |
| 9705 |
|
</p> |
| 9706 |
|
</blockquote> |
| 9707 |
|
|
| 9708 |
|
|
| 9709 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 9710 |
|
</p> |
| 9711 |
|
<blockquote class="text"> |
| 9712 |
|
<p>in case it failed, providing an appropriate error code and error message. |
| 9713 |
|
</p> |
| 9714 |
|
</blockquote> |
| 9715 |
|
|
| 9716 |
|
|
| 9717 |
|
</blockquote><p> |
| 9718 |
|
|
| 9719 |
|
</p> |
| 9720 |
|
<p>Example: |
| 9721 |
|
</p> |
| 9722 |
|
<p> |
| 9723 |
|
</p> |
| 9724 |
|
<blockquote class="text"> |
| 9725 |
|
<p>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'" |
| 9726 |
|
</p> |
| 9727 |
|
<p>S: "OK" |
| 9728 |
|
</p> |
| 9729 |
|
</blockquote><p> |
| 9730 |
|
|
| 9731 |
|
</p> |
| 9732 |
<a name="editing_instruments"></a><br /><hr /> |
<a name="editing_instruments"></a><br /><hr /> |
| 9733 |
<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> |
| 9734 |
<a name="rfc.section.6.9"></a><h3>6.9. |
<a name="rfc.section.6.9"></a><h3>6.9. |
| 9756 |
<p> |
<p> |
| 9757 |
</p> |
</p> |
| 9758 |
<blockquote class="text"> |
<blockquote class="text"> |
| 9759 |
<p>EDIT INSTRUMENT <sampler-channel> |
<p>EDIT CHANNEL INSTRUMENT <sampler-channel> |
| 9760 |
</p> |
</p> |
| 9761 |
</blockquote><p> |
</blockquote><p> |
| 9762 |
|
|
| 9823 |
<p> |
<p> |
| 9824 |
</p> |
</p> |
| 9825 |
<blockquote class="text"> |
<blockquote class="text"> |
| 9826 |
<p>C: "EDIT INSTRUMENT 0" |
<p>C: "EDIT CHANNEL INSTRUMENT 0" |
| 9827 |
|
</p> |
| 9828 |
|
<p>S: "OK" |
| 9829 |
|
</p> |
| 9830 |
|
</blockquote><p> |
| 9831 |
|
|
| 9832 |
|
</p> |
| 9833 |
|
<a name="file_management"></a><br /><hr /> |
| 9834 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 9835 |
|
<a name="rfc.section.6.10"></a><h3>6.10. |
| 9836 |
|
Managing Files</h3> |
| 9837 |
|
|
| 9838 |
|
<p>You can query detailed informations about files located |
| 9839 |
|
at the same system where the sampler instance is running on. |
| 9840 |
|
Using this command set allows to retrieve file informations |
| 9841 |
|
even remotely from another machine. |
| 9842 |
|
</p> |
| 9843 |
|
<a name="GET FILE INSTRUMENTS"></a><br /><hr /> |
| 9844 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 9845 |
|
<a name="rfc.section.6.10.1"></a><h3>6.10.1. |
| 9846 |
|
Retrieving amount of instruments of a file</h3> |
| 9847 |
|
|
| 9848 |
|
<p>The front-end can retrieve the amount of instruments |
| 9849 |
|
within a given instrument file by sending the |
| 9850 |
|
following command: |
| 9851 |
|
</p> |
| 9852 |
|
<p> |
| 9853 |
|
</p> |
| 9854 |
|
<blockquote class="text"> |
| 9855 |
|
<p>GET FILE INSTRUMENTS <filename> |
| 9856 |
|
</p> |
| 9857 |
|
</blockquote><p> |
| 9858 |
|
|
| 9859 |
|
</p> |
| 9860 |
|
<p>Where <filename> is the name of the instrument |
| 9861 |
|
file (encapsulated into apostrophes, supporting escape |
| 9862 |
|
sequences as described in chapter |
| 9863 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
| 9864 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
| 9865 |
|
</p> |
| 9866 |
|
<p>The sampler will try to ask all sampler engines, |
| 9867 |
|
whether they support the given file and ask the first |
| 9868 |
|
engine with a positive answer for the amount of |
| 9869 |
|
instruments. |
| 9870 |
|
</p> |
| 9871 |
|
<p>Possible Answers: |
| 9872 |
|
</p> |
| 9873 |
|
<p> |
| 9874 |
|
</p> |
| 9875 |
|
<blockquote class="text"> |
| 9876 |
|
<p>On success, the sampler will answer by |
| 9877 |
|
returning the amount of instruments. |
| 9878 |
|
|
| 9879 |
|
</p> |
| 9880 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 9881 |
|
</p> |
| 9882 |
|
<blockquote class="text"> |
| 9883 |
|
<p>if the file could not be handled |
| 9884 |
|
</p> |
| 9885 |
|
</blockquote> |
| 9886 |
|
|
| 9887 |
|
|
| 9888 |
|
</blockquote><p> |
| 9889 |
|
|
| 9890 |
|
</p> |
| 9891 |
|
<p>Examples: |
| 9892 |
|
</p> |
| 9893 |
|
<p> |
| 9894 |
|
</p> |
| 9895 |
|
<blockquote class="text"> |
| 9896 |
|
<p>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'" |
| 9897 |
|
</p> |
| 9898 |
|
<p>S: "10" |
| 9899 |
|
</p> |
| 9900 |
|
</blockquote><p> |
| 9901 |
|
|
| 9902 |
|
</p> |
| 9903 |
|
<a name="LIST FILE INSTRUMENTS"></a><br /><hr /> |
| 9904 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 9905 |
|
<a name="rfc.section.6.10.2"></a><h3>6.10.2. |
| 9906 |
|
Retrieving all instruments of a file</h3> |
| 9907 |
|
|
| 9908 |
|
<p>The front-end can retrieve a list of all instruments |
| 9909 |
|
within a given instrument file by sending the |
| 9910 |
|
following command: |
| 9911 |
|
</p> |
| 9912 |
|
<p> |
| 9913 |
|
</p> |
| 9914 |
|
<blockquote class="text"> |
| 9915 |
|
<p>LIST FILE INSTRUMENTS <filename> |
| 9916 |
|
</p> |
| 9917 |
|
</blockquote><p> |
| 9918 |
|
|
| 9919 |
|
</p> |
| 9920 |
|
<p>Where <filename> is the name of the instrument |
| 9921 |
|
file (encapsulated into apostrophes, supporting escape |
| 9922 |
|
sequences as described in chapter |
| 9923 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
| 9924 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
| 9925 |
|
</p> |
| 9926 |
|
<p>The sampler will try to ask all sampler engines, |
| 9927 |
|
whether they support the given file and ask the first |
| 9928 |
|
engine with a positive answer for a list of IDs for the |
| 9929 |
|
instruments in the given file. |
| 9930 |
|
</p> |
| 9931 |
|
<p>Possible Answers: |
| 9932 |
|
</p> |
| 9933 |
|
<p> |
| 9934 |
|
</p> |
| 9935 |
|
<blockquote class="text"> |
| 9936 |
|
<p>On success, the sampler will answer by |
| 9937 |
|
returning a comma separated list of |
| 9938 |
|
instrument IDs. |
| 9939 |
|
|
| 9940 |
|
</p> |
| 9941 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 9942 |
|
</p> |
| 9943 |
|
<blockquote class="text"> |
| 9944 |
|
<p>if the file could not be handled |
| 9945 |
|
</p> |
| 9946 |
|
</blockquote> |
| 9947 |
|
|
| 9948 |
|
|
| 9949 |
|
</blockquote><p> |
| 9950 |
|
|
| 9951 |
|
</p> |
| 9952 |
|
<p>Examples: |
| 9953 |
|
</p> |
| 9954 |
|
<p> |
| 9955 |
|
</p> |
| 9956 |
|
<blockquote class="text"> |
| 9957 |
|
<p>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'" |
| 9958 |
|
</p> |
| 9959 |
|
<p>S: "0,1,2,3,4,5,6,7,8,9" |
| 9960 |
|
</p> |
| 9961 |
|
</blockquote><p> |
| 9962 |
|
|
| 9963 |
|
</p> |
| 9964 |
|
<a name="GET FILE INSTRUMENT INFO"></a><br /><hr /> |
| 9965 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 9966 |
|
<a name="rfc.section.6.10.3"></a><h3>6.10.3. |
| 9967 |
|
Retrieving informations about one instrument in a file</h3> |
| 9968 |
|
|
| 9969 |
|
<p>The front-end can retrieve detailed informations |
| 9970 |
|
about a specific instrument within a given instrument |
| 9971 |
|
file by sending the following command: |
| 9972 |
|
</p> |
| 9973 |
|
<p> |
| 9974 |
|
</p> |
| 9975 |
|
<blockquote class="text"> |
| 9976 |
|
<p>GET FILE INSTRUMENT INFO <filename> |
| 9977 |
|
<instr-id> |
| 9978 |
|
</p> |
| 9979 |
|
</blockquote><p> |
| 9980 |
|
|
| 9981 |
|
</p> |
| 9982 |
|
<p>Where <filename> is the name of the instrument |
| 9983 |
|
file (encapsulated into apostrophes, supporting escape |
| 9984 |
|
sequences as described in chapter |
| 9985 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
| 9986 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") and <instr-id> is the numeric |
| 9987 |
|
instrument ID as returned by the |
| 9988 |
|
<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. |
| 9989 |
|
</p> |
| 9990 |
|
<p>The sampler will try to ask all sampler engines, |
| 9991 |
|
whether they support the given file and ask the first |
| 9992 |
|
engine with a positive answer for informations about the |
| 9993 |
|
specific instrument in the given file. |
| 9994 |
|
</p> |
| 9995 |
|
<p>Possible Answers: |
| 9996 |
|
</p> |
| 9997 |
|
<p> |
| 9998 |
|
</p> |
| 9999 |
|
<blockquote class="text"> |
| 10000 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
| 10001 |
|
Each answer line begins with the settings category name |
| 10002 |
|
followed by a colon and then a space character <SP> and finally |
| 10003 |
|
the info character string to that setting category. At the |
| 10004 |
|
moment the following categories are defined: |
| 10005 |
|
</p> |
| 10006 |
|
<p> |
| 10007 |
|
</p> |
| 10008 |
|
<blockquote class="text"> |
| 10009 |
|
<p>NAME - |
| 10010 |
|
</p> |
| 10011 |
|
<blockquote class="text"> |
| 10012 |
|
<p>name of the instrument as |
| 10013 |
|
stored in the instrument file |
| 10014 |
|
</p> |
| 10015 |
|
</blockquote> |
| 10016 |
|
|
| 10017 |
|
|
| 10018 |
|
<p>FORMAT_FAMILY - |
| 10019 |
|
</p> |
| 10020 |
|
<blockquote class="text"> |
| 10021 |
|
<p>name of the sampler format |
| 10022 |
|
of the given instrument |
| 10023 |
|
</p> |
| 10024 |
|
</blockquote> |
| 10025 |
|
|
| 10026 |
|
|
| 10027 |
|
<p>FORMAT_VERSION - |
| 10028 |
|
</p> |
| 10029 |
|
<blockquote class="text"> |
| 10030 |
|
<p>version of the sampler format |
| 10031 |
|
the instrumen is stored as |
| 10032 |
|
</p> |
| 10033 |
|
</blockquote> |
| 10034 |
|
|
| 10035 |
|
|
| 10036 |
|
<p>PRODUCT - |
| 10037 |
|
</p> |
| 10038 |
|
<blockquote class="text"> |
| 10039 |
|
<p>official product name of the |
| 10040 |
|
instrument as stored in the file |
| 10041 |
|
|
| 10042 |
|
</p> |
| 10043 |
|
</blockquote> |
| 10044 |
|
|
| 10045 |
|
|
| 10046 |
|
<p>ARTISTS - |
| 10047 |
|
</p> |
| 10048 |
|
<blockquote class="text"> |
| 10049 |
|
<p>artists / sample library |
| 10050 |
|
vendor of the instrument |
| 10051 |
|
</p> |
| 10052 |
|
</blockquote> |
| 10053 |
|
|
| 10054 |
|
|
| 10055 |
|
<p>KEY_BINDINGS - |
| 10056 |
|
</p> |
| 10057 |
|
<blockquote class="text"> |
| 10058 |
|
<p>comma separated list of integer values representing |
| 10059 |
|
the instrument's key mapping in the range between 0 .. 127, |
| 10060 |
|
reflecting the analog meaning of the MIDI specification. |
| 10061 |
|
</p> |
| 10062 |
|
</blockquote> |
| 10063 |
|
|
| 10064 |
|
|
| 10065 |
|
<p>KEYSWITCH_BINDINGS - |
| 10066 |
|
</p> |
| 10067 |
|
<blockquote class="text"> |
| 10068 |
|
<p>comma separated list of integer values representing |
| 10069 |
|
the instrument's keyswitch mapping in the range between 0 .. 127, |
| 10070 |
|
reflecting the analog meaning of the MIDI specification. |
| 10071 |
|
</p> |
| 10072 |
|
</blockquote> |
| 10073 |
|
|
| 10074 |
|
|
| 10075 |
|
</blockquote> |
| 10076 |
|
|
| 10077 |
|
|
| 10078 |
|
</blockquote><p> |
| 10079 |
|
|
| 10080 |
|
</p> |
| 10081 |
|
<p>The mentioned fields above don't have to be in particular order. |
| 10082 |
|
</p> |
| 10083 |
|
<p>Example: |
| 10084 |
|
</p> |
| 10085 |
|
<p> |
| 10086 |
|
</p> |
| 10087 |
|
<blockquote class="text"> |
| 10088 |
|
<p>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0" |
| 10089 |
|
</p> |
| 10090 |
|
<p>S: "NAME: Lunatic Loops" |
| 10091 |
|
</p> |
| 10092 |
|
<p> "FORMAT_FAMILY: GIG" |
| 10093 |
|
</p> |
| 10094 |
|
<p> "FORMAT_VERSION: 3" |
| 10095 |
|
</p> |
| 10096 |
|
<p> "PRODUCT: The Backbone Bongo Beats" |
| 10097 |
|
</p> |
| 10098 |
|
<p> "ARTISTS: Jimmy the Fish" |
| 10099 |
|
</p> |
| 10100 |
|
<p> "." |
| 10101 |
|
</p> |
| 10102 |
|
</blockquote><p> |
| 10103 |
|
|
| 10104 |
|
</p> |
| 10105 |
|
<a name="effects"></a><br /><hr /> |
| 10106 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 10107 |
|
<a name="rfc.section.6.11"></a><h3>6.11. |
| 10108 |
|
Managing Effects</h3> |
| 10109 |
|
|
| 10110 |
|
<p>Audio effects (e.g. reverb, delay, compression) can be |
| 10111 |
|
applied to the audio signals generated by the sampler. The |
| 10112 |
|
sampler usually provides a set of internal audio effects for |
| 10113 |
|
this task. The exact set of effects depends on the availability |
| 10114 |
|
of third party effect plugins installed on the system where the |
| 10115 |
|
sampler runs on. |
| 10116 |
|
</p> |
| 10117 |
|
<p>At the moment only "send effects" are supported. Support for |
| 10118 |
|
"insert effects" and "master effects" is planned to be added at |
| 10119 |
|
a later point. |
| 10120 |
|
</p> |
| 10121 |
|
<p>The following commands allow to retrieve the set of internal |
| 10122 |
|
effects available to the sampler, detailed informations about |
| 10123 |
|
those effects and to create and destroy instances of such |
| 10124 |
|
effects. After an instance of an effect is created, the effect |
| 10125 |
|
instance can be inserted into the audio signal path of the |
| 10126 |
|
sampler, e.g. as send effect. |
| 10127 |
|
</p> |
| 10128 |
|
<p>The sampler allows to create an arbitrary amount of so called |
| 10129 |
|
send effect chains. Each effect chain can host an arbitrary |
| 10130 |
|
amount of effect instances. The output of the first effect |
| 10131 |
|
instance in an effect chain is fed to the input of the second |
| 10132 |
|
effect instance of the chain and so on. So effects in one chain |
| 10133 |
|
are processed sequentially. Send effect chains however are |
| 10134 |
|
processed in parallel to other send effect chains. Audio signals |
| 10135 |
|
of sampler channels are fed to send effects by creating FX sends |
| 10136 |
|
to the respective sampler channel and assigning a destination |
| 10137 |
|
send effect to that FX by using the |
| 10138 |
|
<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> |
| 10139 |
|
command. The latter allows to route the FX send to the beginning |
| 10140 |
|
of a send effect chain, as well as directly to any other |
| 10141 |
|
position of the send effect chain. |
| 10142 |
|
</p> |
| 10143 |
|
<a name="GET AVAILABLE_EFFECTS"></a><br /><hr /> |
| 10144 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 10145 |
|
<a name="rfc.section.6.11.1"></a><h3>6.11.1. |
| 10146 |
|
Retrieve amount of available effects</h3> |
| 10147 |
|
|
| 10148 |
|
<p>The front-end can retrieve the amount of internal |
| 10149 |
|
effects, available to the sampler by sending |
| 10150 |
|
the following command: |
| 10151 |
|
</p> |
| 10152 |
|
<p> |
| 10153 |
|
</p> |
| 10154 |
|
<blockquote class="text"> |
| 10155 |
|
<p>GET AVAILABLE_EFFECTS |
| 10156 |
|
</p> |
| 10157 |
|
</blockquote><p> |
| 10158 |
|
|
| 10159 |
|
</p> |
| 10160 |
|
<p>Possible Answers: |
| 10161 |
|
</p> |
| 10162 |
|
<p> |
| 10163 |
|
</p> |
| 10164 |
|
<blockquote class="text"> |
| 10165 |
|
<p>The sampler will answer by returning the current |
| 10166 |
|
number of effects available to the sampler. |
| 10167 |
|
</p> |
| 10168 |
|
</blockquote><p> |
| 10169 |
|
|
| 10170 |
|
</p> |
| 10171 |
|
<p>Examples: |
| 10172 |
|
</p> |
| 10173 |
|
<p> |
| 10174 |
|
</p> |
| 10175 |
|
<blockquote class="text"> |
| 10176 |
|
<p>C: "GET AVAILABLE_EFFECTS" |
| 10177 |
|
</p> |
| 10178 |
|
<p>S: "129" |
| 10179 |
|
</p> |
| 10180 |
|
</blockquote><p> |
| 10181 |
|
|
| 10182 |
|
</p> |
| 10183 |
|
<a name="LIST AVAILABLE_EFFECTS"></a><br /><hr /> |
| 10184 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 10185 |
|
<a name="rfc.section.6.11.2"></a><h3>6.11.2. |
| 10186 |
|
Get list of available effects</h3> |
| 10187 |
|
|
| 10188 |
|
<p>The set of available internal effects can change at |
| 10189 |
|
runtime. The front-end can retrieve the list of internal |
| 10190 |
|
effects, available to the sampler by sending the following |
| 10191 |
|
command: |
| 10192 |
|
</p> |
| 10193 |
|
<p> |
| 10194 |
|
</p> |
| 10195 |
|
<blockquote class="text"> |
| 10196 |
|
<p>LIST AVAILABLE_EFFECTS |
| 10197 |
|
</p> |
| 10198 |
|
</blockquote><p> |
| 10199 |
|
|
| 10200 |
|
</p> |
| 10201 |
|
<p>Possible Answers: |
| 10202 |
|
</p> |
| 10203 |
|
<p> |
| 10204 |
|
</p> |
| 10205 |
|
<blockquote class="text"> |
| 10206 |
|
<p>The sampler will answer by returning a comma |
| 10207 |
|
separated list with numerical IDs of effects. Note: |
| 10208 |
|
the numercial ID of an effect is generated by the |
| 10209 |
|
sampler for the current moment. The numerical ID of |
| 10210 |
|
the same effect can change at runtime, e.g. when the |
| 10211 |
|
user requests a rescan of available effect plugins. |
| 10212 |
|
|
| 10213 |
|
</p> |
| 10214 |
|
</blockquote><p> |
| 10215 |
|
|
| 10216 |
|
</p> |
| 10217 |
|
<p>Example: |
| 10218 |
|
</p> |
| 10219 |
|
<p> |
| 10220 |
|
</p> |
| 10221 |
|
<blockquote class="text"> |
| 10222 |
|
<p>C: "LIST AVAILABLE_EFFECTS" |
| 10223 |
|
</p> |
| 10224 |
|
<p>S: "5,6,7,120,121,122,123,124" |
| 10225 |
|
</p> |
| 10226 |
|
</blockquote><p> |
| 10227 |
|
|
| 10228 |
|
</p> |
| 10229 |
|
<a name="GET EFFECT INFO"></a><br /><hr /> |
| 10230 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 10231 |
|
<a name="rfc.section.6.11.3"></a><h3>6.11.3. |
| 10232 |
|
Retrieving general information about an effect</h3> |
| 10233 |
|
|
| 10234 |
|
<p>The front-end can ask for general informations about an |
| 10235 |
|
effect by sending the following command: |
| 10236 |
|
</p> |
| 10237 |
|
<p> |
| 10238 |
|
</p> |
| 10239 |
|
<blockquote class="text"> |
| 10240 |
|
<p>GET EFFECT INFO <effect-index> |
| 10241 |
|
</p> |
| 10242 |
|
</blockquote><p> |
| 10243 |
|
|
| 10244 |
|
</p> |
| 10245 |
|
<p>Where <effect-index> is the numerical ID of an |
| 10246 |
|
effect as returned by the |
| 10247 |
|
<a class='info' href='#LIST AVAILABLE_EFFECTS'>"LIST AVAILABLE_EFFECTS"<span> (</span><span class='info'>Get list of available effects</span><span>)</span></a> |
| 10248 |
|
command. |
| 10249 |
|
</p> |
| 10250 |
|
<p>Possible Answers: |
| 10251 |
|
</p> |
| 10252 |
|
<p> |
| 10253 |
|
</p> |
| 10254 |
|
<blockquote class="text"> |
| 10255 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
| 10256 |
|
Each answer line begins with the effect information |
| 10257 |
|
category name, followed by a colon and then a space |
| 10258 |
|
character <SP> and finally the info character |
| 10259 |
|
string to that effect information category. At the |
| 10260 |
|
moment the following categories are defined: |
| 10261 |
|
</p> |
| 10262 |
|
<p> |
| 10263 |
|
</p> |
| 10264 |
|
<blockquote class="text"> |
| 10265 |
|
<p>SYSTEM - |
| 10266 |
|
</p> |
| 10267 |
|
<blockquote class="text"> |
| 10268 |
|
<p>name of the effect plugin system |
| 10269 |
|
the effect is based on |
| 10270 |
|
(e.g. "LADSPA") |
| 10271 |
|
</p> |
| 10272 |
|
</blockquote> |
| 10273 |
|
|
| 10274 |
|
|
| 10275 |
|
<p>MODULE - |
| 10276 |
|
</p> |
| 10277 |
|
<blockquote class="text"> |
| 10278 |
|
<p>module of the effect plugin |
| 10279 |
|
system that contains this effect, |
| 10280 |
|
the module is usually the |
| 10281 |
|
dynamic-linked library (DLL) |
| 10282 |
|
filename of the effect plugin, |
| 10283 |
|
including full path (note that this |
| 10284 |
|
filename may contain |
| 10285 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
| 10286 |
|
</p> |
| 10287 |
|
</blockquote> |
| 10288 |
|
|
| 10289 |
|
|
| 10290 |
|
<p>NAME - |
| 10291 |
|
</p> |
| 10292 |
|
<blockquote class="text"> |
| 10293 |
|
<p>character string defining the |
| 10294 |
|
unique name of the effect within its |
| 10295 |
|
module (note that the character |
| 10296 |
|
string may contain |
| 10297 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
| 10298 |
|
</p> |
| 10299 |
|
</blockquote> |
| 10300 |
|
|
| 10301 |
|
|
| 10302 |
|
<p>DESCRIPTION - |
| 10303 |
|
</p> |
| 10304 |
|
<blockquote class="text"> |
| 10305 |
|
<p>human readable name of the |
| 10306 |
|
effect, intended to be displayed in |
| 10307 |
|
user interfaces (note that the |
| 10308 |
|
character string may contain |
| 10309 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
| 10310 |
|
</p> |
| 10311 |
|
</blockquote> |
| 10312 |
|
|
| 10313 |
|
|
| 10314 |
|
</blockquote> |
| 10315 |
|
|
| 10316 |
|
|
| 10317 |
|
</blockquote><p> |
| 10318 |
|
|
| 10319 |
|
</p> |
| 10320 |
|
<p>The mentioned fields above don't have to be in particular order. |
| 10321 |
|
</p> |
| 10322 |
|
<p>Example: |
| 10323 |
|
</p> |
| 10324 |
|
<p> |
| 10325 |
|
</p> |
| 10326 |
|
<blockquote class="text"> |
| 10327 |
|
<p>C: "GET EFFECT INFO 121" |
| 10328 |
|
</p> |
| 10329 |
|
<p>S: "SYSTEM: LADSPA" |
| 10330 |
|
</p> |
| 10331 |
|
<p> "MODULE: /usr/lib/ladspa/lowpass_iir_1891.so" |
| 10332 |
|
</p> |
| 10333 |
|
<p> "NAME: lowpass_iir" |
| 10334 |
|
</p> |
| 10335 |
|
<p> "DESCRIPTION: Glame Lowpass Filter" |
| 10336 |
|
</p> |
| 10337 |
|
<p> "." |
| 10338 |
|
</p> |
| 10339 |
|
</blockquote><p> |
| 10340 |
|
|
| 10341 |
|
</p> |
| 10342 |
|
<a name="CREATE EFFECT_INSTANCE"></a><br /><hr /> |
| 10343 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 10344 |
|
<a name="rfc.section.6.11.4"></a><h3>6.11.4. |
| 10345 |
|
Creating an instance of an effect by its portable ID</h3> |
| 10346 |
|
|
| 10347 |
|
<p>The front-end can spawn an instance of the desired |
| 10348 |
|
effect by sending the following command: |
| 10349 |
|
</p> |
| 10350 |
|
<p> |
| 10351 |
|
</p> |
| 10352 |
|
<blockquote class="text"> |
| 10353 |
|
<p>CREATE EFFECT_INSTANCE <effect-system> <module> <effect-name> |
| 10354 |
|
</p> |
| 10355 |
|
</blockquote><p> |
| 10356 |
|
|
| 10357 |
|
</p> |
| 10358 |
|
<p>Where <effect-system> is the "SYSTEM" field, |
| 10359 |
|
<module> the "MODULE" field and <effect-name> |
| 10360 |
|
the "NAME" field as returned by the |
| 10361 |
|
<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> |
| 10362 |
|
command. The filename of argument <module> and the |
| 10363 |
|
character string of argument <effect-name> may contain |
| 10364 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>. |
| 10365 |
|
</p> |
| 10366 |
|
<p>The sampler will try to load the requested effect and to |
| 10367 |
|
create an instance of it. To allow loading the same effect |
| 10368 |
|
on a different machine, probably even running a completely |
| 10369 |
|
different operating system (e.g. Linux vs. Windows), the |
| 10370 |
|
sampler tries to match <module> "softly". That means |
| 10371 |
|
it first tries to find an effect that exactly matches the |
| 10372 |
|
given <module> argument. If there is no exact match, |
| 10373 |
|
the sampler will try to lower the restrictions on matching |
| 10374 |
|
the <module> argument more and more, e.g. by ignoring |
| 10375 |
|
upper / lower case differences and by ignoring the path of |
| 10376 |
|
the DLL filename and file extension. If there is still no |
| 10377 |
|
match at the end, the sampler will try to ignore the |
| 10378 |
|
<module> argument completely and as a last resort |
| 10379 |
|
search for an effect that only matches the given |
| 10380 |
|
<effect-system> and <effect-name> arguments. |
| 10381 |
|
</p> |
| 10382 |
|
<p>Possible Answers: |
| 10383 |
|
</p> |
| 10384 |
|
<p> |
| 10385 |
|
</p> |
| 10386 |
|
<blockquote class="text"> |
| 10387 |
|
<p>"OK[<effect-instance>]" - |
| 10388 |
|
</p> |
| 10389 |
|
<blockquote class="text"> |
| 10390 |
|
<p>in case the effect instance was |
| 10391 |
|
successfully created, where |
| 10392 |
|
<effect-instance> is the numerical ID |
| 10393 |
|
of the new effect instance |
| 10394 |
|
</p> |
| 10395 |
|
</blockquote> |
| 10396 |
|
|
| 10397 |
|
|
| 10398 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
| 10399 |
|
</p> |
| 10400 |
|
<blockquote class="text"> |
| 10401 |
|
<p>in case the effect instance was spawned |
| 10402 |
|
successfully, but there are noteworthy |
| 10403 |
|
issue(s) related, providing an appropriate |
| 10404 |
|
warning code and warning message |
| 10405 |
|
</p> |
| 10406 |
|
</blockquote> |
| 10407 |
|
|
| 10408 |
|
|
| 10409 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 10410 |
|
</p> |
| 10411 |
|
<blockquote class="text"> |
| 10412 |
|
<p>if the effect could not be instantiated |
| 10413 |
|
</p> |
| 10414 |
|
</blockquote> |
| 10415 |
|
|
| 10416 |
|
|
| 10417 |
|
</blockquote><p> |
| 10418 |
|
|
| 10419 |
|
</p> |
| 10420 |
|
<p>Examples: |
| 10421 |
|
</p> |
| 10422 |
|
<p> |
| 10423 |
|
</p> |
| 10424 |
|
<blockquote class="text"> |
| 10425 |
|
<p>C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/mod_delay_1419.so' 'modDelay'" |
| 10426 |
|
</p> |
| 10427 |
|
<p>S: "OK[0]" |
| 10428 |
|
</p> |
| 10429 |
|
</blockquote><p> |
| 10430 |
|
|
| 10431 |
|
</p> |
| 10432 |
|
<a name="CREATE EFFECT_INSTANCE (non-portable)"></a><br /><hr /> |
| 10433 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 10434 |
|
<a name="rfc.section.6.11.5"></a><h3>6.11.5. |
| 10435 |
|
Creating an instance of an effect by its numerical ID</h3> |
| 10436 |
|
|
| 10437 |
|
<p>The front-end can spawn an instance of the desired |
| 10438 |
|
effect by sending the following command: |
| 10439 |
|
</p> |
| 10440 |
|
<p> |
| 10441 |
|
</p> |
| 10442 |
|
<blockquote class="text"> |
| 10443 |
|
<p>CREATE EFFECT_INSTANCE <effect-index> |
| 10444 |
|
</p> |
| 10445 |
|
</blockquote><p> |
| 10446 |
|
|
| 10447 |
|
</p> |
| 10448 |
|
<p>Where <effect-index> is the numerical ID of the |
| 10449 |
|
effect as returned by the |
| 10450 |
|
<a class='info' href='#LIST AVAILABLE_EFFECTS'>"LIST AVAILABLE_EFFECTS"<span> (</span><span class='info'>Get list of available effects</span><span>)</span></a> |
| 10451 |
|
command. |
| 10452 |
|
</p> |
| 10453 |
|
<p>The sampler will try to load the requested effect and to |
| 10454 |
|
create an instance of it. |
| 10455 |
|
</p> |
| 10456 |
|
<p>Note: Since the numerical ID of a certain effect can |
| 10457 |
|
change at any time, you should not use this command in |
| 10458 |
|
LSCP files to restore a certain effect at a later time! To |
| 10459 |
|
store a sampler session including all its effects, use the |
| 10460 |
|
<a class='info' href='#CREATE EFFECT_INSTANCE'>portable text-based |
| 10461 |
|
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 |
| 10462 |
|
allows to restore a sampler session with all its effects |
| 10463 |
|
also on other machines, possibly even running a completely |
| 10464 |
|
different operating system (e.g. Linux vs. Windows), with |
| 10465 |
|
different plugin directories or plugin DLL names. |
| 10466 |
|
</p> |
| 10467 |
|
<p>Possible Answers: |
| 10468 |
|
</p> |
| 10469 |
|
<p> |
| 10470 |
|
</p> |
| 10471 |
|
<blockquote class="text"> |
| 10472 |
|
<p>"OK[<effect-instance>]" - |
| 10473 |
|
</p> |
| 10474 |
|
<blockquote class="text"> |
| 10475 |
|
<p>in case the effect instance was |
| 10476 |
|
successfully created, where |
| 10477 |
|
<effect-instance> is the numerical ID |
| 10478 |
|
of the new effect instance |
| 10479 |
|
</p> |
| 10480 |
|
</blockquote> |
| 10481 |
|
|
| 10482 |
|
|
| 10483 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
| 10484 |
|
</p> |
| 10485 |
|
<blockquote class="text"> |
| 10486 |
|
<p>in case the effect instance was spawned |
| 10487 |
|
successfully, but there are noteworthy |
| 10488 |
|
issue(s) related, providing an appropriate |
| 10489 |
|
warning code and warning message |
| 10490 |
|
</p> |
| 10491 |
|
</blockquote> |
| 10492 |
|
|
| 10493 |
|
|
| 10494 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 10495 |
|
</p> |
| 10496 |
|
<blockquote class="text"> |
| 10497 |
|
<p>if the effect could not be instantiated |
| 10498 |
|
</p> |
| 10499 |
|
</blockquote> |
| 10500 |
|
|
| 10501 |
|
|
| 10502 |
|
</blockquote><p> |
| 10503 |
|
|
| 10504 |
|
</p> |
| 10505 |
|
<p>Examples: |
| 10506 |
|
</p> |
| 10507 |
|
<p> |
| 10508 |
|
</p> |
| 10509 |
|
<blockquote class="text"> |
| 10510 |
|
<p>C: "CREATE EFFECT_INSTANCE 72" |
| 10511 |
|
</p> |
| 10512 |
|
<p>S: "OK[5]" |
| 10513 |
|
</p> |
| 10514 |
|
</blockquote><p> |
| 10515 |
|
|
| 10516 |
|
</p> |
| 10517 |
|
<a name="DESTROY EFFECT_INSTANCE"></a><br /><hr /> |
| 10518 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 10519 |
|
<a name="rfc.section.6.11.6"></a><h3>6.11.6. |
| 10520 |
|
Destroy an effect instance</h3> |
| 10521 |
|
|
| 10522 |
|
<p>The front-end can destroy an unusued effect instance and |
| 10523 |
|
thus freeing it from memory by sending the following command: |
| 10524 |
|
</p> |
| 10525 |
|
<p> |
| 10526 |
|
</p> |
| 10527 |
|
<blockquote class="text"> |
| 10528 |
|
<p>DESTROY EFFECT_INSTANCE <effect-instance> |
| 10529 |
|
</p> |
| 10530 |
|
</blockquote><p> |
| 10531 |
|
|
| 10532 |
|
</p> |
| 10533 |
|
<p>Where <effect-instance> is the numerical ID of the |
| 10534 |
|
effect instance as returned by the |
| 10535 |
|
<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 |
| 10536 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
| 10537 |
|
command. |
| 10538 |
|
</p> |
| 10539 |
|
<p>The effect instance can only be destroyed if it's not |
| 10540 |
|
used in any part of the sampler's audio signal path anymore. |
| 10541 |
|
If the effect instance is still in use somewhere, trying to |
| 10542 |
|
destroy the effect instance will result in an error |
| 10543 |
|
message. |
| 10544 |
|
</p> |
| 10545 |
|
<p>Possible Answers: |
| 10546 |
|
</p> |
| 10547 |
|
<p> |
| 10548 |
|
</p> |
| 10549 |
|
<blockquote class="text"> |
| 10550 |
|
<p>"OK" - |
| 10551 |
|
</p> |
| 10552 |
|
<blockquote class="text"> |
| 10553 |
|
<p>in case the effect instance was successfully destroyed |
| 10554 |
|
</p> |
| 10555 |
|
</blockquote> |
| 10556 |
|
|
| 10557 |
|
|
| 10558 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 10559 |
|
</p> |
| 10560 |
|
<blockquote class="text"> |
| 10561 |
|
<p>in case it failed, providing an appropriate error code and |
| 10562 |
|
error message |
| 10563 |
|
</p> |
| 10564 |
|
</blockquote> |
| 10565 |
|
|
| 10566 |
|
|
| 10567 |
|
</blockquote><p> |
| 10568 |
|
|
| 10569 |
|
</p> |
| 10570 |
|
<p>Examples: |
| 10571 |
|
</p> |
| 10572 |
|
<p> |
| 10573 |
|
</p> |
| 10574 |
|
<blockquote class="text"> |
| 10575 |
|
<p>C: "DESTROY EFFECT_INSTANCE 5" |
| 10576 |
|
</p> |
| 10577 |
|
<p>S: "OK" |
| 10578 |
|
</p> |
| 10579 |
|
</blockquote><p> |
| 10580 |
|
|
| 10581 |
|
</p> |
| 10582 |
|
<a name="GET EFFECT_INSTANCES"></a><br /><hr /> |
| 10583 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 10584 |
|
<a name="rfc.section.6.11.7"></a><h3>6.11.7. |
| 10585 |
|
Retrieve amount of effect instances</h3> |
| 10586 |
|
|
| 10587 |
|
<p>The front-end can retrieve the current amount of effect |
| 10588 |
|
instances by sending the following command: |
| 10589 |
|
</p> |
| 10590 |
|
<p> |
| 10591 |
|
</p> |
| 10592 |
|
<blockquote class="text"> |
| 10593 |
|
<p>GET EFFECT_INSTANCES |
| 10594 |
|
</p> |
| 10595 |
|
</blockquote><p> |
| 10596 |
|
|
| 10597 |
|
</p> |
| 10598 |
|
<p>Possible Answers: |
| 10599 |
|
</p> |
| 10600 |
|
<p> |
| 10601 |
|
</p> |
| 10602 |
|
<blockquote class="text"> |
| 10603 |
|
<p>The sampler will answer by returning the current |
| 10604 |
|
number of effect instances created and not yet |
| 10605 |
|
destroyed in the current sampler session. |
| 10606 |
|
</p> |
| 10607 |
|
</blockquote><p> |
| 10608 |
|
|
| 10609 |
|
</p> |
| 10610 |
|
<p>Examples: |
| 10611 |
|
</p> |
| 10612 |
|
<p> |
| 10613 |
|
</p> |
| 10614 |
|
<blockquote class="text"> |
| 10615 |
|
<p>C: "GET EFFECT_INSTANCES" |
| 10616 |
|
</p> |
| 10617 |
|
<p>S: "14" |
| 10618 |
|
</p> |
| 10619 |
|
</blockquote><p> |
| 10620 |
|
|
| 10621 |
|
</p> |
| 10622 |
|
<a name="LIST EFFECT_INSTANCES"></a><br /><hr /> |
| 10623 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 10624 |
|
<a name="rfc.section.6.11.8"></a><h3>6.11.8. |
| 10625 |
|
Get list of effect instances</h3> |
| 10626 |
|
|
| 10627 |
|
<p>The front-end can retrieve the current list of effect |
| 10628 |
|
instances by sending the following command: |
| 10629 |
|
</p> |
| 10630 |
|
<p> |
| 10631 |
|
</p> |
| 10632 |
|
<blockquote class="text"> |
| 10633 |
|
<p>LIST EFFECT_INSTANCES |
| 10634 |
|
</p> |
| 10635 |
|
</blockquote><p> |
| 10636 |
|
|
| 10637 |
|
</p> |
| 10638 |
|
<p>Possible Answers: |
| 10639 |
|
</p> |
| 10640 |
|
<p> |
| 10641 |
|
</p> |
| 10642 |
|
<blockquote class="text"> |
| 10643 |
|
<p>The sampler will answer by returning a comma |
| 10644 |
|
separated list with numerical IDs of effects |
| 10645 |
|
instances. |
| 10646 |
|
|
| 10647 |
|
</p> |
| 10648 |
|
</blockquote><p> |
| 10649 |
|
|
| 10650 |
|
</p> |
| 10651 |
|
<p>Example: |
| 10652 |
|
</p> |
| 10653 |
|
<p> |
| 10654 |
|
</p> |
| 10655 |
|
<blockquote class="text"> |
| 10656 |
|
<p>C: "LIST EFFECT_INSTANCES" |
| 10657 |
|
</p> |
| 10658 |
|
<p>S: "9,11,14,15,16,17,25" |
| 10659 |
|
</p> |
| 10660 |
|
</blockquote><p> |
| 10661 |
|
|
| 10662 |
|
</p> |
| 10663 |
|
<a name="GET EFFECT_INSTANCE INFO"></a><br /><hr /> |
| 10664 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 10665 |
|
<a name="rfc.section.6.11.9"></a><h3>6.11.9. |
| 10666 |
|
Retrieving current information about an effect instance</h3> |
| 10667 |
|
|
| 10668 |
|
<p>The front-end can ask for the current informations about |
| 10669 |
|
a particular effect instance by sending the following command: |
| 10670 |
|
</p> |
| 10671 |
|
<p> |
| 10672 |
|
</p> |
| 10673 |
|
<blockquote class="text"> |
| 10674 |
|
<p>GET EFFECT_INSTANCE INFO <effect-instance> |
| 10675 |
|
</p> |
| 10676 |
|
</blockquote><p> |
| 10677 |
|
|
| 10678 |
|
</p> |
| 10679 |
|
<p>Where <effect-instance> is the numerical ID of an |
| 10680 |
|
effect instance as returned by the |
| 10681 |
|
<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> |
| 10682 |
|
or |
| 10683 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
| 10684 |
|
command. |
| 10685 |
|
</p> |
| 10686 |
|
<p>Possible Answers: |
| 10687 |
|
</p> |
| 10688 |
|
<p> |
| 10689 |
|
</p> |
| 10690 |
|
<blockquote class="text"> |
| 10691 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
| 10692 |
|
Each answer line begins with the information |
| 10693 |
|
category name, followed by a colon and then a space |
| 10694 |
|
character <SP> and finally the info character |
| 10695 |
|
string to that information category. At the |
| 10696 |
|
moment the following categories are defined: |
| 10697 |
|
</p> |
| 10698 |
|
<p> |
| 10699 |
|
</p> |
| 10700 |
|
<blockquote class="text"> |
| 10701 |
|
<p>SYSTEM - |
| 10702 |
|
</p> |
| 10703 |
|
<blockquote class="text"> |
| 10704 |
|
<p>name of the effect plugin system |
| 10705 |
|
the effect is based on |
| 10706 |
|
(e.g. "LADSPA") |
| 10707 |
|
</p> |
| 10708 |
|
</blockquote> |
| 10709 |
|
|
| 10710 |
|
|
| 10711 |
|
<p>MODULE - |
| 10712 |
|
</p> |
| 10713 |
|
<blockquote class="text"> |
| 10714 |
|
<p>module of the effect plugin |
| 10715 |
|
system that contains this effect, |
| 10716 |
|
the module is usually the |
| 10717 |
|
dynamic-linked library (DLL) |
| 10718 |
|
filename of the effect plugin, |
| 10719 |
|
including full path (note that this |
| 10720 |
|
filename may contain |
| 10721 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
| 10722 |
|
</p> |
| 10723 |
|
</blockquote> |
| 10724 |
|
|
| 10725 |
|
|
| 10726 |
|
<p>NAME - |
| 10727 |
|
</p> |
| 10728 |
|
<blockquote class="text"> |
| 10729 |
|
<p>character string defining the |
| 10730 |
|
unique name of the effect within its |
| 10731 |
|
module (note that the character |
| 10732 |
|
string may contain |
| 10733 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
| 10734 |
|
</p> |
| 10735 |
|
</blockquote> |
| 10736 |
|
|
| 10737 |
|
|
| 10738 |
|
<p>DESCRIPTION - |
| 10739 |
|
</p> |
| 10740 |
|
<blockquote class="text"> |
| 10741 |
|
<p>human readable name of the |
| 10742 |
|
effect, intended to be displayed in |
| 10743 |
|
user interfaces (note that the |
| 10744 |
|
character string may contain |
| 10745 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
| 10746 |
|
</p> |
| 10747 |
|
</blockquote> |
| 10748 |
|
|
| 10749 |
|
|
| 10750 |
|
<p>INPUT_CONTROLS - |
| 10751 |
|
</p> |
| 10752 |
|
<blockquote class="text"> |
| 10753 |
|
<p>amount of input controls the |
| 10754 |
|
effect instance provides, to allow |
| 10755 |
|
controlling the effect parameters in |
| 10756 |
|
realtime |
| 10757 |
|
</p> |
| 10758 |
|
</blockquote> |
| 10759 |
|
|
| 10760 |
|
|
| 10761 |
|
</blockquote> |
| 10762 |
|
|
| 10763 |
|
|
| 10764 |
|
</blockquote><p> |
| 10765 |
|
|
| 10766 |
|
</p> |
| 10767 |
|
<p>The mentioned fields above don't have to be in particular order. |
| 10768 |
|
</p> |
| 10769 |
|
<p>Example: |
| 10770 |
|
</p> |
| 10771 |
|
<p> |
| 10772 |
|
</p> |
| 10773 |
|
<blockquote class="text"> |
| 10774 |
|
<p>C: "GET EFFECT_INSTANCE INFO 3" |
| 10775 |
|
</p> |
| 10776 |
|
<p>S: "SYSTEM: LADSPA" |
| 10777 |
|
</p> |
| 10778 |
|
<p> "MODULE: /usr/lib/ladspa/mod_delay_1419.so" |
| 10779 |
|
</p> |
| 10780 |
|
<p> "NAME: modDelay" |
| 10781 |
|
</p> |
| 10782 |
|
<p> "DESCRIPTION: Modulatable delay" |
| 10783 |
|
</p> |
| 10784 |
|
<p> "INPUT_CONTROLS: 1" |
| 10785 |
|
</p> |
| 10786 |
|
<p> "." |
| 10787 |
|
</p> |
| 10788 |
|
</blockquote><p> |
| 10789 |
|
|
| 10790 |
|
</p> |
| 10791 |
|
<a name="GET EFFECT_INSTANCE_INPUT_CONTROL INFO"></a><br /><hr /> |
| 10792 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 10793 |
|
<a name="rfc.section.6.11.10"></a><h3>6.11.10. |
| 10794 |
|
Retrieving information about an effect parameter</h3> |
| 10795 |
|
|
| 10796 |
|
<p>Effects typically provide a certain set of effect |
| 10797 |
|
parameters which can be altered by the user in realtime |
| 10798 |
|
(e.g. depth of a reverb effect, duration of a delay effect, |
| 10799 |
|
dry / wet signal ratio). Those controllable effect parameters |
| 10800 |
|
are called "input controls". The front-end can ask for the |
| 10801 |
|
current informations of an effect instance's input control |
| 10802 |
|
by sending the following command: |
| 10803 |
|
</p> |
| 10804 |
|
<p> |
| 10805 |
|
</p> |
| 10806 |
|
<blockquote class="text"> |
| 10807 |
|
<p>GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-control> |
| 10808 |
|
</p> |
| 10809 |
|
</blockquote><p> |
| 10810 |
|
|
| 10811 |
|
</p> |
| 10812 |
|
<p>Where <effect-instance> is the numerical ID of an |
| 10813 |
|
effect instance as returned by the |
| 10814 |
|
<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> |
| 10815 |
|
or |
| 10816 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
| 10817 |
|
command and <input-control> is the index of the input |
| 10818 |
|
control within the numerical bounds as returned by the |
| 10819 |
|
"INPUT_CONTROLS" field of the |
| 10820 |
|
<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> |
| 10821 |
|
command. |
| 10822 |
|
</p> |
| 10823 |
|
<p>Possible Answers: |
| 10824 |
|
</p> |
| 10825 |
|
<p> |
| 10826 |
|
</p> |
| 10827 |
|
<blockquote class="text"> |
| 10828 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
| 10829 |
|
Each answer line begins with the information |
| 10830 |
|
category name, followed by a colon and then a space |
| 10831 |
|
character <SP> and finally the info character |
| 10832 |
|
string to that information category. There are |
| 10833 |
|
information categories which are always returned, |
| 10834 |
|
independent of the respective effect parameter and |
| 10835 |
|
there are optional information categories |
| 10836 |
|
which are only shown for certain effect parameters. |
| 10837 |
|
At the moment the following categories are defined: |
| 10838 |
|
</p> |
| 10839 |
|
<p> |
| 10840 |
|
</p> |
| 10841 |
|
<blockquote class="text"> |
| 10842 |
|
<p>DESCRIPTION - |
| 10843 |
|
</p> |
| 10844 |
|
<blockquote class="text"> |
| 10845 |
|
<p>(always returned) |
| 10846 |
|
human readable name of the |
| 10847 |
|
effect parameter, intended to be |
| 10848 |
|
displayed in user interfaces (note |
| 10849 |
|
that the character string may |
| 10850 |
|
contain <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
| 10851 |
|
</p> |
| 10852 |
|
</blockquote> |
| 10853 |
|
|
| 10854 |
|
|
| 10855 |
|
<p>VALUE - |
| 10856 |
|
</p> |
| 10857 |
|
<blockquote class="text"> |
| 10858 |
|
<p> |
| 10859 |
|
(always returned) |
| 10860 |
|
current (optional dotted) |
| 10861 |
|
floating point value of this effect |
| 10862 |
|
parameter |
| 10863 |
|
</p> |
| 10864 |
|
</blockquote> |
| 10865 |
|
|
| 10866 |
|
|
| 10867 |
|
<p>RANGE_MIN - |
| 10868 |
|
</p> |
| 10869 |
|
<blockquote class="text"> |
| 10870 |
|
<p> |
| 10871 |
|
(optionally returned) |
| 10872 |
|
minimum allowed value for this |
| 10873 |
|
effect parameter |
| 10874 |
|
</p> |
| 10875 |
|
</blockquote> |
| 10876 |
|
|
| 10877 |
|
|
| 10878 |
|
<p>RANGE_MAX - |
| 10879 |
|
</p> |
| 10880 |
|
<blockquote class="text"> |
| 10881 |
|
<p> |
| 10882 |
|
(optionally returned) |
| 10883 |
|
maximum allowed value for this |
| 10884 |
|
effect parameter |
| 10885 |
|
</p> |
| 10886 |
|
</blockquote> |
| 10887 |
|
|
| 10888 |
|
|
| 10889 |
|
<p>POSSIBILITIES - |
| 10890 |
|
</p> |
| 10891 |
|
<blockquote class="text"> |
| 10892 |
|
<p> |
| 10893 |
|
(optionally returned) |
| 10894 |
|
comma separated list of |
| 10895 |
|
(optional dotted) floating point |
| 10896 |
|
numbers, reflecting the exact set of |
| 10897 |
|
possible values for this effect |
| 10898 |
|
parameter |
| 10899 |
|
</p> |
| 10900 |
|
</blockquote> |
| 10901 |
|
|
| 10902 |
|
|
| 10903 |
|
<p>DEFAULT - |
| 10904 |
|
</p> |
| 10905 |
|
<blockquote class="text"> |
| 10906 |
|
<p> |
| 10907 |
|
(optionally returned) |
| 10908 |
|
default value of this effect |
| 10909 |
|
parameter |
| 10910 |
|
</p> |
| 10911 |
|
</blockquote> |
| 10912 |
|
|
| 10913 |
|
|
| 10914 |
|
</blockquote> |
| 10915 |
|
|
| 10916 |
|
|
| 10917 |
|
</blockquote><p> |
| 10918 |
|
|
| 10919 |
|
</p> |
| 10920 |
|
<p>The mentioned fields above don't have to be in particular order. |
| 10921 |
|
</p> |
| 10922 |
|
<p>Example: |
| 10923 |
|
</p> |
| 10924 |
|
<p> |
| 10925 |
|
</p> |
| 10926 |
|
<blockquote class="text"> |
| 10927 |
|
<p>C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0" |
| 10928 |
|
</p> |
| 10929 |
|
<p>S: "SYSTEM: LADSPA" |
| 10930 |
|
</p> |
| 10931 |
|
<p> "DESCRIPTION: Base delay (s)" |
| 10932 |
|
</p> |
| 10933 |
|
<p> "VALUE: 0.500" |
| 10934 |
|
</p> |
| 10935 |
|
<p> "RANGE_MIN: 0.000" |
| 10936 |
|
</p> |
| 10937 |
|
<p> "." |
| 10938 |
|
</p> |
| 10939 |
|
</blockquote><p> |
| 10940 |
|
|
| 10941 |
|
</p> |
| 10942 |
|
<a name="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE"></a><br /><hr /> |
| 10943 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 10944 |
|
<a name="rfc.section.6.11.11"></a><h3>6.11.11. |
| 10945 |
|
Altering an effect parameter</h3> |
| 10946 |
|
|
| 10947 |
|
<p>The front-end can alter the current value of an effect |
| 10948 |
|
parameter by sending the following command: |
| 10949 |
|
</p> |
| 10950 |
|
<p> |
| 10951 |
|
</p> |
| 10952 |
|
<blockquote class="text"> |
| 10953 |
|
<p>SET EFFECT_INSTANCE_INPUT_CONTROL VALUE <effect-instance> <input-control> <value> |
| 10954 |
|
</p> |
| 10955 |
|
</blockquote><p> |
| 10956 |
|
|
| 10957 |
|
</p> |
| 10958 |
|
<p>Where <effect-instance> is the numerical ID of the |
| 10959 |
|
effect instance as returned by the |
| 10960 |
|
<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 |
| 10961 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
| 10962 |
|
command, <input-control> is the index of the input |
| 10963 |
|
control within the numerical bounds as returned by the |
| 10964 |
|
"INPUT_CONTROLS" field of the |
| 10965 |
|
<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> |
| 10966 |
|
command and <value> is the new (optional dotted) |
| 10967 |
|
floating point value for this effect parameter. |
| 10968 |
|
</p> |
| 10969 |
|
<p>Possible Answers: |
| 10970 |
|
</p> |
| 10971 |
|
<p> |
| 10972 |
|
</p> |
| 10973 |
|
<blockquote class="text"> |
| 10974 |
|
<p>"OK" - |
| 10975 |
|
</p> |
| 10976 |
|
<blockquote class="text"> |
| 10977 |
|
<p>in case the effect was altered successfully |
| 10978 |
|
</p> |
| 10979 |
|
</blockquote> |
| 10980 |
|
|
| 10981 |
|
|
| 10982 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 10983 |
|
</p> |
| 10984 |
|
<blockquote class="text"> |
| 10985 |
|
<p>in case it failed, providing an appropriate error code and |
| 10986 |
|
error message |
| 10987 |
|
</p> |
| 10988 |
|
</blockquote> |
| 10989 |
|
|
| 10990 |
|
|
| 10991 |
|
</blockquote><p> |
| 10992 |
|
|
| 10993 |
|
</p> |
| 10994 |
|
<p>Examples: |
| 10995 |
|
</p> |
| 10996 |
|
<p> |
| 10997 |
|
</p> |
| 10998 |
|
<blockquote class="text"> |
| 10999 |
|
<p>C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5" |
| 11000 |
|
</p> |
| 11001 |
|
<p>S: "OK" |
| 11002 |
|
</p> |
| 11003 |
|
</blockquote><p> |
| 11004 |
|
|
| 11005 |
|
</p> |
| 11006 |
|
<a name="GET SEND_EFFECT_CHAINS"></a><br /><hr /> |
| 11007 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 11008 |
|
<a name="rfc.section.6.11.12"></a><h3>6.11.12. |
| 11009 |
|
Retrieve amount of send effect chains</h3> |
| 11010 |
|
|
| 11011 |
|
<p>The front-end can retrieve the current amount of send |
| 11012 |
|
effect chains of an audio output device by sending the |
| 11013 |
|
following command: |
| 11014 |
|
</p> |
| 11015 |
|
<p> |
| 11016 |
|
</p> |
| 11017 |
|
<blockquote class="text"> |
| 11018 |
|
<p>GET SEND_EFFECT_CHAINS <audio-device> |
| 11019 |
|
</p> |
| 11020 |
|
</blockquote><p> |
| 11021 |
|
|
| 11022 |
|
</p> |
| 11023 |
|
<p>Where <audio-device> should be replaced by the |
| 11024 |
|
numerical ID of the audio output device as given by the |
| 11025 |
|
<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> |
| 11026 |
|
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> |
| 11027 |
|
command. |
| 11028 |
|
</p> |
| 11029 |
|
<p>Possible Answers: |
| 11030 |
|
</p> |
| 11031 |
|
<p> |
| 11032 |
|
</p> |
| 11033 |
|
<blockquote class="text"> |
| 11034 |
|
<p>The sampler will answer by returning the current |
| 11035 |
|
number of send effect chains of the supplied audio |
| 11036 |
|
output device. |
| 11037 |
|
</p> |
| 11038 |
|
</blockquote><p> |
| 11039 |
|
|
| 11040 |
|
</p> |
| 11041 |
|
<p>Examples: |
| 11042 |
|
</p> |
| 11043 |
|
<p> |
| 11044 |
|
</p> |
| 11045 |
|
<blockquote class="text"> |
| 11046 |
|
<p>C: "GET SEND_EFFECT_CHAINS 0" |
| 11047 |
|
</p> |
| 11048 |
|
<p>S: "4" |
| 11049 |
|
</p> |
| 11050 |
|
</blockquote><p> |
| 11051 |
|
|
| 11052 |
|
</p> |
| 11053 |
|
<a name="LIST SEND_EFFECT_CHAINS"></a><br /><hr /> |
| 11054 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 11055 |
|
<a name="rfc.section.6.11.13"></a><h3>6.11.13. |
| 11056 |
|
Retrieve list of send effect chains</h3> |
| 11057 |
|
|
| 11058 |
|
<p>The front-end can retrieve the current list of send |
| 11059 |
|
effect chains of an audio output device by sending the |
| 11060 |
|
following command: |
| 11061 |
|
</p> |
| 11062 |
|
<p> |
| 11063 |
|
</p> |
| 11064 |
|
<blockquote class="text"> |
| 11065 |
|
<p>LIST SEND_EFFECT_CHAINS <audio-device> |
| 11066 |
|
</p> |
| 11067 |
|
</blockquote><p> |
| 11068 |
|
|
| 11069 |
|
</p> |
| 11070 |
|
<p>Where <audio-device> should be replaced by the |
| 11071 |
|
numerical ID of the audio output device as given by the |
| 11072 |
|
<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> |
| 11073 |
|
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> |
| 11074 |
|
command. |
| 11075 |
|
</p> |
| 11076 |
|
<p>Possible Answers: |
| 11077 |
|
</p> |
| 11078 |
|
<p> |
| 11079 |
|
</p> |
| 11080 |
|
<blockquote class="text"> |
| 11081 |
|
<p>The sampler will answer by returning a comma |
| 11082 |
|
separated list with numerical IDs of send effect |
| 11083 |
|
chains of the supplied audio output device. |
| 11084 |
|
|
| 11085 |
|
</p> |
| 11086 |
|
</blockquote><p> |
| 11087 |
|
|
| 11088 |
|
</p> |
| 11089 |
|
<p>Examples: |
| 11090 |
|
</p> |
| 11091 |
|
<p> |
| 11092 |
|
</p> |
| 11093 |
|
<blockquote class="text"> |
| 11094 |
|
<p>C: "LIST SEND_EFFECT_CHAINS 0" |
| 11095 |
|
</p> |
| 11096 |
|
<p>S: "3,4,7" |
| 11097 |
|
</p> |
| 11098 |
|
</blockquote><p> |
| 11099 |
|
|
| 11100 |
|
</p> |
| 11101 |
|
<a name="ADD SEND_EFFECT_CHAIN"></a><br /><hr /> |
| 11102 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 11103 |
|
<a name="rfc.section.6.11.14"></a><h3>6.11.14. |
| 11104 |
|
Add send effect chain</h3> |
| 11105 |
|
|
| 11106 |
|
<p>The front-end can add a send effect chain by sending the |
| 11107 |
|
following command: |
| 11108 |
|
</p> |
| 11109 |
|
<p> |
| 11110 |
|
</p> |
| 11111 |
|
<blockquote class="text"> |
| 11112 |
|
<p>ADD SEND_EFFECT_CHAIN <audio-device> |
| 11113 |
|
</p> |
| 11114 |
|
</blockquote><p> |
| 11115 |
|
|
| 11116 |
|
</p> |
| 11117 |
|
<p>Where <audio-device> should be replaced by the |
| 11118 |
|
numerical ID of the audio output device as given by the |
| 11119 |
|
<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> |
| 11120 |
|
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> |
| 11121 |
|
command. |
| 11122 |
|
</p> |
| 11123 |
|
<p>Possible Answers: |
| 11124 |
|
</p> |
| 11125 |
|
<p> |
| 11126 |
|
</p> |
| 11127 |
|
<blockquote class="text"> |
| 11128 |
|
<p>"OK[<effect-chain>]" - |
| 11129 |
|
</p> |
| 11130 |
|
<blockquote class="text"> |
| 11131 |
|
<p>in case the send effect chain was |
| 11132 |
|
added successfully, where |
| 11133 |
|
<effect-chain> is the numerical ID |
| 11134 |
|
of the new send effect chain |
| 11135 |
|
</p> |
| 11136 |
|
</blockquote> |
| 11137 |
|
|
| 11138 |
|
|
| 11139 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 11140 |
|
</p> |
| 11141 |
|
<blockquote class="text"> |
| 11142 |
|
<p>if the send effect chain could not be added |
| 11143 |
|
</p> |
| 11144 |
|
</blockquote> |
| 11145 |
|
|
| 11146 |
|
|
| 11147 |
|
</blockquote><p> |
| 11148 |
|
|
| 11149 |
|
</p> |
| 11150 |
|
<p>Examples: |
| 11151 |
|
</p> |
| 11152 |
|
<p> |
| 11153 |
|
</p> |
| 11154 |
|
<blockquote class="text"> |
| 11155 |
|
<p>C: "ADD SEND_EFFECT_CHAIN 0" |
| 11156 |
|
</p> |
| 11157 |
|
<p>S: "OK[2]" |
| 11158 |
|
</p> |
| 11159 |
|
</blockquote><p> |
| 11160 |
|
|
| 11161 |
|
</p> |
| 11162 |
|
<a name="REMOVE SEND_EFFECT_CHAIN"></a><br /><hr /> |
| 11163 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 11164 |
|
<a name="rfc.section.6.11.15"></a><h3>6.11.15. |
| 11165 |
|
Remove send effect chain</h3> |
| 11166 |
|
|
| 11167 |
|
<p>The front-end can remove a send effect chain by sending |
| 11168 |
|
the following command: |
| 11169 |
|
</p> |
| 11170 |
|
<p> |
| 11171 |
|
</p> |
| 11172 |
|
<blockquote class="text"> |
| 11173 |
|
<p>REMOVE SEND_EFFECT_CHAIN <audio-device> <effect-chain> |
| 11174 |
|
</p> |
| 11175 |
|
</blockquote><p> |
| 11176 |
|
|
| 11177 |
|
</p> |
| 11178 |
|
<p>Where <audio-device> should be replaced by the |
| 11179 |
|
numerical ID of the audio output device as given by the |
| 11180 |
|
<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> |
| 11181 |
|
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> |
| 11182 |
|
command and <effect-chain> by the numerical ID as |
| 11183 |
|
returned by the |
| 11184 |
|
<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> |
| 11185 |
|
or |
| 11186 |
|
<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> |
| 11187 |
|
command. |
| 11188 |
|
</p> |
| 11189 |
|
<p>Possible Answers: |
| 11190 |
|
</p> |
| 11191 |
|
<p> |
| 11192 |
|
</p> |
| 11193 |
|
<blockquote class="text"> |
| 11194 |
|
<p>"OK" - |
| 11195 |
|
</p> |
| 11196 |
|
<blockquote class="text"> |
| 11197 |
|
<p>in case the send effect chain was |
| 11198 |
|
removed successfully |
| 11199 |
|
</p> |
| 11200 |
|
</blockquote> |
| 11201 |
|
|
| 11202 |
|
|
| 11203 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 11204 |
|
</p> |
| 11205 |
|
<blockquote class="text"> |
| 11206 |
|
<p>if the send effect chain could not be removed |
| 11207 |
|
</p> |
| 11208 |
|
</blockquote> |
| 11209 |
|
|
| 11210 |
|
|
| 11211 |
|
</blockquote><p> |
| 11212 |
|
|
| 11213 |
|
</p> |
| 11214 |
|
<p>Examples: |
| 11215 |
|
</p> |
| 11216 |
|
<p> |
| 11217 |
|
</p> |
| 11218 |
|
<blockquote class="text"> |
| 11219 |
|
<p>C: "REMOVE SEND_EFFECT_CHAIN 0 2" |
| 11220 |
|
</p> |
| 11221 |
|
<p>S: "OK" |
| 11222 |
|
</p> |
| 11223 |
|
</blockquote><p> |
| 11224 |
|
|
| 11225 |
|
</p> |
| 11226 |
|
<a name="GET SEND_EFFECT_CHAIN INFO"></a><br /><hr /> |
| 11227 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 11228 |
|
<a name="rfc.section.6.11.16"></a><h3>6.11.16. |
| 11229 |
|
Retrieving information about a send effect chain</h3> |
| 11230 |
|
|
| 11231 |
|
<p>The front-end can ask for informations of a send effect |
| 11232 |
|
chain by sending the following command: |
| 11233 |
|
</p> |
| 11234 |
|
<p> |
| 11235 |
|
</p> |
| 11236 |
|
<blockquote class="text"> |
| 11237 |
|
<p>GET SEND_EFFECT_CHAIN INFO <audio-device> <effect-chain> |
| 11238 |
|
</p> |
| 11239 |
|
</blockquote><p> |
| 11240 |
|
|
| 11241 |
|
</p> |
| 11242 |
|
<p>Where <audio-device> should be replaced by the |
| 11243 |
|
numerical ID of the audio output device as given by the |
| 11244 |
|
<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> |
| 11245 |
|
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> |
| 11246 |
|
command and <effect-chain> by the numerical ID as |
| 11247 |
|
returned by the |
| 11248 |
|
<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> |
| 11249 |
|
or |
| 11250 |
|
<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> |
| 11251 |
|
command. |
| 11252 |
|
</p> |
| 11253 |
|
<p>Possible Answers: |
| 11254 |
|
</p> |
| 11255 |
|
<p> |
| 11256 |
|
</p> |
| 11257 |
|
<blockquote class="text"> |
| 11258 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
| 11259 |
|
Each answer line begins with the information |
| 11260 |
|
category name, followed by a colon and then a space |
| 11261 |
|
character <SP> and finally the info character |
| 11262 |
|
string to that information category. |
| 11263 |
|
At the moment the following categories are defined: |
| 11264 |
|
</p> |
| 11265 |
|
<p> |
| 11266 |
|
</p> |
| 11267 |
|
<blockquote class="text"> |
| 11268 |
|
<p>EFFECT_COUNT - |
| 11269 |
|
</p> |
| 11270 |
|
<blockquote class="text"> |
| 11271 |
|
<p>amount of effects in this send |
| 11272 |
|
effect chain |
| 11273 |
|
</p> |
| 11274 |
|
</blockquote> |
| 11275 |
|
|
| 11276 |
|
|
| 11277 |
|
<p>EFFECT_SEQUENCE - |
| 11278 |
|
</p> |
| 11279 |
|
<blockquote class="text"> |
| 11280 |
|
<p>comma separated list of the |
| 11281 |
|
numerical IDs of the effect |
| 11282 |
|
instances in this send effect chain, |
| 11283 |
|
in the order as they are procssed in |
| 11284 |
|
the effect chain |
| 11285 |
|
</p> |
| 11286 |
|
</blockquote> |
| 11287 |
|
|
| 11288 |
|
|
| 11289 |
|
</blockquote> |
| 11290 |
|
|
| 11291 |
|
|
| 11292 |
|
</blockquote><p> |
| 11293 |
|
|
| 11294 |
|
</p> |
| 11295 |
|
<p>The mentioned fields above don't have to be in particular order. |
| 11296 |
|
</p> |
| 11297 |
|
<p>Example: |
| 11298 |
|
</p> |
| 11299 |
|
<p> |
| 11300 |
|
</p> |
| 11301 |
|
<blockquote class="text"> |
| 11302 |
|
<p>C: "GET SEND_EFFECT_CHAIN INFO 0 2" |
| 11303 |
|
</p> |
| 11304 |
|
<p>S: "EFFECT_COUNT: 3" |
| 11305 |
|
</p> |
| 11306 |
|
<p> "EFFECT_SEQUENCE: 31,4,7" |
| 11307 |
|
</p> |
| 11308 |
|
<p> "." |
| 11309 |
|
</p> |
| 11310 |
|
</blockquote><p> |
| 11311 |
|
|
| 11312 |
|
</p> |
| 11313 |
|
<a name="APPEND SEND_EFFECT_CHAIN EFFECT"></a><br /><hr /> |
| 11314 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 11315 |
|
<a name="rfc.section.6.11.17"></a><h3>6.11.17. |
| 11316 |
|
Append effect instance to a send effect chain</h3> |
| 11317 |
|
|
| 11318 |
|
<p>The front-end can add an unused effect instance to the |
| 11319 |
|
end of a send effect chain by sending the following command: |
| 11320 |
|
</p> |
| 11321 |
|
<p> |
| 11322 |
|
</p> |
| 11323 |
|
<blockquote class="text"> |
| 11324 |
|
<p>APPEND SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <effect-instance> |
| 11325 |
|
</p> |
| 11326 |
|
</blockquote><p> |
| 11327 |
|
|
| 11328 |
|
</p> |
| 11329 |
|
<p>Where <audio-device> should be replaced by the |
| 11330 |
|
numerical ID of the audio output device as given by the |
| 11331 |
|
<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> |
| 11332 |
|
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> |
| 11333 |
|
command and <effect-chain> by the numerical ID as |
| 11334 |
|
returned by the |
| 11335 |
|
<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> |
| 11336 |
|
or |
| 11337 |
|
<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> |
| 11338 |
|
command and <effect-instance> as returned by the |
| 11339 |
|
<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 |
| 11340 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
| 11341 |
|
command. |
| 11342 |
|
</p> |
| 11343 |
|
<p>Only unused effect instances can be added to the effect |
| 11344 |
|
chain. Trying to add an effect instance which is already in |
| 11345 |
|
use somewhere in the audio signal path of the sampler will |
| 11346 |
|
result in an error. |
| 11347 |
|
</p> |
| 11348 |
|
<p>Possible Answers: |
| 11349 |
|
</p> |
| 11350 |
|
<p> |
| 11351 |
|
</p> |
| 11352 |
|
<blockquote class="text"> |
| 11353 |
|
<p>"OK" - |
| 11354 |
|
</p> |
| 11355 |
|
<blockquote class="text"> |
| 11356 |
|
<p>in case the effect instance was |
| 11357 |
|
added successfully to the chain |
| 11358 |
|
</p> |
| 11359 |
|
</blockquote> |
| 11360 |
|
|
| 11361 |
|
|
| 11362 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 11363 |
|
</p> |
| 11364 |
|
<blockquote class="text"> |
| 11365 |
|
<p>if the effect instance could not be added |
| 11366 |
|
</p> |
| 11367 |
|
</blockquote> |
| 11368 |
|
|
| 11369 |
|
|
| 11370 |
|
</blockquote><p> |
| 11371 |
|
|
| 11372 |
|
</p> |
| 11373 |
|
<p>Examples: |
| 11374 |
|
</p> |
| 11375 |
|
<p> |
| 11376 |
|
</p> |
| 11377 |
|
<blockquote class="text"> |
| 11378 |
|
<p>C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38" |
| 11379 |
|
</p> |
| 11380 |
|
<p>S: "OK" |
| 11381 |
|
</p> |
| 11382 |
|
</blockquote><p> |
| 11383 |
|
|
| 11384 |
|
</p> |
| 11385 |
|
<a name="INSERT SEND_EFFECT_CHAIN EFFECT"></a><br /><hr /> |
| 11386 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 11387 |
|
<a name="rfc.section.6.11.18"></a><h3>6.11.18. |
| 11388 |
|
Insert effect instance to a send effect chain</h3> |
| 11389 |
|
|
| 11390 |
|
<p>The front-end can add an unused effect instance to a |
| 11391 |
|
certain position of a send effect chain by sending the |
| 11392 |
|
following command: |
| 11393 |
|
</p> |
| 11394 |
|
<p> |
| 11395 |
|
</p> |
| 11396 |
|
<blockquote class="text"> |
| 11397 |
|
<p>INSERT SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos> <effect-instance> |
| 11398 |
|
</p> |
| 11399 |
|
</blockquote><p> |
| 11400 |
|
|
| 11401 |
|
</p> |
| 11402 |
|
<p>Where <audio-device> should be replaced by the |
| 11403 |
|
numerical ID of the audio output device as given by the |
| 11404 |
|
<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> |
| 11405 |
|
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> |
| 11406 |
|
command, <effect-chain> by the numerical ID as |
| 11407 |
|
returned by the |
| 11408 |
|
<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> |
| 11409 |
|
or |
| 11410 |
|
<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> |
| 11411 |
|
command, <effect-instance> as returned by the |
| 11412 |
|
<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 |
| 11413 |
|
<a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a> |
| 11414 |
|
command and <chain-pos> the exact position of the |
| 11415 |
|
effect chain where the supplied effect shall be inserted |
| 11416 |
|
to. |
| 11417 |
|
</p> |
| 11418 |
|
<p>Only unused effect instances can be added to the effect |
| 11419 |
|
chain. Trying to add an effect instance which is already in |
| 11420 |
|
use somewhere in the audio signal path of the sampler will |
| 11421 |
|
result in an error. |
| 11422 |
|
</p> |
| 11423 |
|
<p>Possible Answers: |
| 11424 |
|
</p> |
| 11425 |
|
<p> |
| 11426 |
|
</p> |
| 11427 |
|
<blockquote class="text"> |
| 11428 |
|
<p>"OK" - |
| 11429 |
|
</p> |
| 11430 |
|
<blockquote class="text"> |
| 11431 |
|
<p>in case the effect instance was |
| 11432 |
|
added successfully to the chain |
| 11433 |
|
</p> |
| 11434 |
|
</blockquote> |
| 11435 |
|
|
| 11436 |
|
|
| 11437 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 11438 |
|
</p> |
| 11439 |
|
<blockquote class="text"> |
| 11440 |
|
<p>if the effect instance could not be added |
| 11441 |
|
</p> |
| 11442 |
|
</blockquote> |
| 11443 |
|
|
| 11444 |
|
|
| 11445 |
|
</blockquote><p> |
| 11446 |
|
|
| 11447 |
|
</p> |
| 11448 |
|
<p>Examples: |
| 11449 |
|
</p> |
| 11450 |
|
<p> |
| 11451 |
|
</p> |
| 11452 |
|
<blockquote class="text"> |
| 11453 |
|
<p>C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38" |
| 11454 |
|
</p> |
| 11455 |
|
<p>S: "OK" |
| 11456 |
|
</p> |
| 11457 |
|
</blockquote><p> |
| 11458 |
|
|
| 11459 |
|
</p> |
| 11460 |
|
<a name="REMOVE SEND_EFFECT_CHAIN EFFECT"></a><br /><hr /> |
| 11461 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 11462 |
|
<a name="rfc.section.6.11.19"></a><h3>6.11.19. |
| 11463 |
|
Remove effect instance from send effect chain</h3> |
| 11464 |
|
|
| 11465 |
|
<p>The front-end can remove an effect instance from a |
| 11466 |
|
certain position of a send effect chain by sending the |
| 11467 |
|
following command: |
| 11468 |
|
</p> |
| 11469 |
|
<p> |
| 11470 |
|
</p> |
| 11471 |
|
<blockquote class="text"> |
| 11472 |
|
<p>REMOVE SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos> |
| 11473 |
|
</p> |
| 11474 |
|
</blockquote><p> |
| 11475 |
|
|
| 11476 |
|
</p> |
| 11477 |
|
<p>Where <audio-device> should be replaced by the |
| 11478 |
|
numerical ID of the audio output device as given by the |
| 11479 |
|
<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> |
| 11480 |
|
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> |
| 11481 |
|
command, <effect-chain> by the numerical ID as |
| 11482 |
|
returned by the |
| 11483 |
|
<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> |
| 11484 |
|
or |
| 11485 |
|
<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> |
| 11486 |
|
command and <chain-pos> the exact position of the |
| 11487 |
|
effect instance to be removed from the effect chain. |
| 11488 |
|
</p> |
| 11489 |
|
<p>Possible Answers: |
| 11490 |
|
</p> |
| 11491 |
|
<p> |
| 11492 |
|
</p> |
| 11493 |
|
<blockquote class="text"> |
| 11494 |
|
<p>"OK" - |
| 11495 |
|
</p> |
| 11496 |
|
<blockquote class="text"> |
| 11497 |
|
<p>in case the effect instance was |
| 11498 |
|
removed successfully |
| 11499 |
|
</p> |
| 11500 |
|
</blockquote> |
| 11501 |
|
|
| 11502 |
|
|
| 11503 |
|
<p>"ERR:<error-code>:<error-message>" - |
| 11504 |
|
</p> |
| 11505 |
|
<blockquote class="text"> |
| 11506 |
|
<p>if the effect instance could not be removed |
| 11507 |
|
</p> |
| 11508 |
|
</blockquote> |
| 11509 |
|
|
| 11510 |
|
|
| 11511 |
|
</blockquote><p> |
| 11512 |
|
|
| 11513 |
|
</p> |
| 11514 |
|
<p>Examples: |
| 11515 |
|
</p> |
| 11516 |
|
<p> |
| 11517 |
|
</p> |
| 11518 |
|
<blockquote class="text"> |
| 11519 |
|
<p>C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4" |
| 11520 |
</p> |
</p> |
| 11521 |
<p>S: "OK" |
<p>S: "OK" |
| 11522 |
</p> |
</p> |
| 11644 |
<p>/ FORMAT SP format_instruction |
<p>/ FORMAT SP format_instruction |
| 11645 |
|
|
| 11646 |
</p> |
</p> |
| 11647 |
|
<p>/ SEND SP send_instruction |
| 11648 |
|
|
| 11649 |
|
</p> |
| 11650 |
|
<p>/ APPEND SP append_instruction |
| 11651 |
|
|
| 11652 |
|
</p> |
| 11653 |
|
<p>/ INSERT SP insert_instruction |
| 11654 |
|
|
| 11655 |
|
</p> |
| 11656 |
<p>/ RESET |
<p>/ RESET |
| 11657 |
|
|
| 11658 |
</p> |
</p> |
| 11674 |
<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 |
| 11675 |
|
|
| 11676 |
</p> |
</p> |
| 11677 |
|
<p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
| 11678 |
|
|
| 11679 |
|
</p> |
| 11680 |
<p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
<p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
| 11681 |
|
|
| 11682 |
</p> |
</p> |
| 11683 |
|
<p>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
| 11684 |
|
|
| 11685 |
|
</p> |
| 11686 |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
| 11687 |
|
|
| 11688 |
</p> |
</p> |
| 11701 |
<p>/ MIDI_INSTRUMENT_MAP SP map_name |
<p>/ MIDI_INSTRUMENT_MAP SP map_name |
| 11702 |
|
|
| 11703 |
</p> |
</p> |
| 11704 |
|
<p>/ SEND_EFFECT_CHAIN SP device_index |
| 11705 |
|
|
| 11706 |
|
</p> |
| 11707 |
</blockquote><p> |
</blockquote><p> |
| 11708 |
|
|
| 11709 |
</p> |
</p> |
| 11725 |
<p>/ CHANNEL_COUNT |
<p>/ CHANNEL_COUNT |
| 11726 |
|
|
| 11727 |
</p> |
</p> |
| 11728 |
|
<p>/ CHANNEL_MIDI |
| 11729 |
|
|
| 11730 |
|
</p> |
| 11731 |
|
<p>/ DEVICE_MIDI |
| 11732 |
|
|
| 11733 |
|
</p> |
| 11734 |
<p>/ VOICE_COUNT |
<p>/ VOICE_COUNT |
| 11735 |
|
|
| 11736 |
</p> |
</p> |
| 11779 |
<p>/ MISCELLANEOUS |
<p>/ MISCELLANEOUS |
| 11780 |
|
|
| 11781 |
</p> |
</p> |
| 11782 |
|
<p>/ TOTAL_STREAM_COUNT |
| 11783 |
|
|
| 11784 |
|
</p> |
| 11785 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
| 11786 |
|
|
| 11787 |
</p> |
</p> |
| 11809 |
<p>/ CHANNEL_COUNT |
<p>/ CHANNEL_COUNT |
| 11810 |
|
|
| 11811 |
</p> |
</p> |
| 11812 |
|
<p>/ CHANNEL_MIDI |
| 11813 |
|
|
| 11814 |
|
</p> |
| 11815 |
|
<p>/ DEVICE_MIDI |
| 11816 |
|
|
| 11817 |
|
</p> |
| 11818 |
<p>/ VOICE_COUNT |
<p>/ VOICE_COUNT |
| 11819 |
|
|
| 11820 |
</p> |
</p> |
| 11863 |
<p>/ MISCELLANEOUS |
<p>/ MISCELLANEOUS |
| 11864 |
|
|
| 11865 |
</p> |
</p> |
| 11866 |
|
<p>/ TOTAL_STREAM_COUNT |
| 11867 |
|
|
| 11868 |
|
</p> |
| 11869 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
| 11870 |
|
|
| 11871 |
</p> |
</p> |
| 11914 |
<p>/ MIDI_INSTRUMENT_MAP SP ALL |
<p>/ MIDI_INSTRUMENT_MAP SP ALL |
| 11915 |
|
|
| 11916 |
</p> |
</p> |
| 11917 |
|
<p>/ SEND_EFFECT_CHAIN SP device_index SP effect_chain |
| 11918 |
|
|
| 11919 |
|
</p> |
| 11920 |
|
<p>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos |
| 11921 |
|
|
| 11922 |
|
</p> |
| 11923 |
|
<p>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id |
| 11924 |
|
|
| 11925 |
|
</p> |
| 11926 |
<p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
<p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
| 11927 |
|
|
| 11928 |
</p> |
</p> |
| 11941 |
<p>AVAILABLE_ENGINES |
<p>AVAILABLE_ENGINES |
| 11942 |
|
|
| 11943 |
</p> |
</p> |
| 11944 |
|
<p>/ AVAILABLE_EFFECTS |
| 11945 |
|
|
| 11946 |
|
</p> |
| 11947 |
|
<p>/ EFFECT_INSTANCES |
| 11948 |
|
|
| 11949 |
|
</p> |
| 11950 |
|
<p>/ EFFECT SP INFO SP effect_index |
| 11951 |
|
|
| 11952 |
|
</p> |
| 11953 |
|
<p>/ EFFECT_INSTANCE SP INFO SP effect_instance |
| 11954 |
|
|
| 11955 |
|
</p> |
| 11956 |
|
<p>/ EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP input_control |
| 11957 |
|
|
| 11958 |
|
</p> |
| 11959 |
|
<p>/ SEND_EFFECT_CHAINS SP device_index |
| 11960 |
|
|
| 11961 |
|
</p> |
| 11962 |
|
<p>/ SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain |
| 11963 |
|
|
| 11964 |
|
</p> |
| 11965 |
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS |
| 11966 |
|
|
| 11967 |
</p> |
</p> |
| 12031 |
<p>/ SERVER SP INFO |
<p>/ SERVER SP INFO |
| 12032 |
|
|
| 12033 |
</p> |
</p> |
| 12034 |
|
<p>/ TOTAL_STREAM_COUNT |
| 12035 |
|
|
| 12036 |
|
</p> |
| 12037 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
| 12038 |
|
|
| 12039 |
</p> |
</p> |
| 12085 |
<p>/ VOLUME |
<p>/ VOLUME |
| 12086 |
|
|
| 12087 |
</p> |
</p> |
| 12088 |
|
<p>/ VOICES |
| 12089 |
|
|
| 12090 |
|
</p> |
| 12091 |
|
<p>/ STREAMS |
| 12092 |
|
|
| 12093 |
|
</p> |
| 12094 |
|
<p>/ FILE SP INSTRUMENTS SP filename |
| 12095 |
|
|
| 12096 |
|
</p> |
| 12097 |
|
<p>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
| 12098 |
|
|
| 12099 |
|
</p> |
| 12100 |
</blockquote><p> |
</blockquote><p> |
| 12101 |
|
|
| 12102 |
</p> |
</p> |
| 12118 |
<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 |
| 12119 |
|
|
| 12120 |
</p> |
</p> |
| 12121 |
|
<p>/ EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP input_control SP control_value |
| 12122 |
|
|
| 12123 |
|
</p> |
| 12124 |
<p>/ CHANNEL SP set_chan_instruction |
<p>/ CHANNEL SP set_chan_instruction |
| 12125 |
|
|
| 12126 |
</p> |
</p> |
| 12139 |
<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 |
| 12140 |
|
|
| 12141 |
</p> |
</p> |
| 12142 |
|
<p>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos |
| 12143 |
|
|
| 12144 |
|
</p> |
| 12145 |
<p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
<p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
| 12146 |
|
|
| 12147 |
</p> |
</p> |
| 12154 |
<p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
<p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
| 12155 |
|
|
| 12156 |
</p> |
</p> |
| 12157 |
|
<p>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename |
| 12158 |
|
|
| 12159 |
|
</p> |
| 12160 |
<p>/ ECHO SP boolean |
<p>/ ECHO SP boolean |
| 12161 |
|
|
| 12162 |
</p> |
</p> |
| 12163 |
<p>/ VOLUME SP volume_value |
<p>/ VOLUME SP volume_value |
| 12164 |
|
|
| 12165 |
</p> |
</p> |
| 12166 |
|
<p>/ VOICES SP number |
| 12167 |
|
|
| 12168 |
|
</p> |
| 12169 |
|
<p>/ STREAMS SP number |
| 12170 |
|
|
| 12171 |
|
</p> |
| 12172 |
</blockquote><p> |
</blockquote><p> |
| 12173 |
|
|
| 12174 |
</p> |
</p> |
| 12193 |
<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 |
| 12194 |
|
|
| 12195 |
</p> |
</p> |
| 12196 |
|
<p>/ EFFECT_INSTANCE SP effect_index |
| 12197 |
|
|
| 12198 |
|
</p> |
| 12199 |
|
<p>/ EFFECT_INSTANCE SP effect_system SP module SP effect_name |
| 12200 |
|
|
| 12201 |
|
</p> |
| 12202 |
</blockquote><p> |
</blockquote><p> |
| 12203 |
|
|
| 12204 |
</p> |
</p> |
| 12238 |
<p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
<p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
| 12239 |
|
|
| 12240 |
</p> |
</p> |
| 12241 |
|
<p>/ LOST SP DB_INSTRUMENT_FILES |
| 12242 |
|
|
| 12243 |
|
</p> |
| 12244 |
</blockquote><p> |
</blockquote><p> |
| 12245 |
|
|
| 12246 |
</p> |
</p> |
| 12280 |
<p>/ FX_SEND SP sampler_channel SP fx_send_id |
<p>/ FX_SEND SP sampler_channel SP fx_send_id |
| 12281 |
|
|
| 12282 |
</p> |
</p> |
| 12283 |
|
<p>/ EFFECT_INSTANCE SP number |
| 12284 |
|
|
| 12285 |
|
</p> |
| 12286 |
</blockquote><p> |
</blockquote><p> |
| 12287 |
|
|
| 12288 |
</p> |
</p> |
| 12298 |
</blockquote><p> |
</blockquote><p> |
| 12299 |
|
|
| 12300 |
</p> |
</p> |
| 12301 |
|
<p>append_instruction = |
| 12302 |
|
</p> |
| 12303 |
|
<blockquote class="text"> |
| 12304 |
|
<p>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP effect_instance |
| 12305 |
|
|
| 12306 |
|
</p> |
| 12307 |
|
</blockquote><p> |
| 12308 |
|
|
| 12309 |
|
</p> |
| 12310 |
|
<p>insert_instruction = |
| 12311 |
|
</p> |
| 12312 |
|
<blockquote class="text"> |
| 12313 |
|
<p>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos SP effect_instance |
| 12314 |
|
|
| 12315 |
|
</p> |
| 12316 |
|
</blockquote><p> |
| 12317 |
|
|
| 12318 |
|
</p> |
| 12319 |
<p>set_chan_instruction = |
<p>set_chan_instruction = |
| 12320 |
</p> |
</p> |
| 12321 |
<blockquote class="text"> |
<blockquote class="text"> |
| 12367 |
<p>edit_instruction = |
<p>edit_instruction = |
| 12368 |
</p> |
</p> |
| 12369 |
<blockquote class="text"> |
<blockquote class="text"> |
| 12370 |
<p>INSTRUMENT SP sampler_channel |
<p>CHANNEL SP INSTRUMENT SP sampler_channel |
| 12371 |
|
|
| 12372 |
</p> |
</p> |
| 12373 |
</blockquote><p> |
</blockquote><p> |
| 12433 |
<p>/ AVAILABLE_ENGINES |
<p>/ AVAILABLE_ENGINES |
| 12434 |
|
|
| 12435 |
</p> |
</p> |
| 12436 |
|
<p>/ AVAILABLE_EFFECTS |
| 12437 |
|
|
| 12438 |
|
</p> |
| 12439 |
|
<p>/ EFFECT_INSTANCES |
| 12440 |
|
|
| 12441 |
|
</p> |
| 12442 |
|
<p>/ SEND_EFFECT_CHAINS SP number |
| 12443 |
|
|
| 12444 |
|
</p> |
| 12445 |
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS |
| 12446 |
|
|
| 12447 |
</p> |
</p> |
| 12472 |
<p>/ DB_INSTRUMENTS SP db_path |
<p>/ DB_INSTRUMENTS SP db_path |
| 12473 |
|
|
| 12474 |
</p> |
</p> |
| 12475 |
|
<p>/ FILE SP INSTRUMENTS SP filename |
| 12476 |
|
|
| 12477 |
|
</p> |
| 12478 |
|
</blockquote><p> |
| 12479 |
|
|
| 12480 |
|
</p> |
| 12481 |
|
<p>send_instruction = |
| 12482 |
|
</p> |
| 12483 |
|
<blockquote class="text"> |
| 12484 |
|
<p>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number |
| 12485 |
|
|
| 12486 |
|
</p> |
| 12487 |
</blockquote><p> |
</blockquote><p> |
| 12488 |
|
|
| 12489 |
</p> |
</p> |
| 12523 |
</blockquote><p> |
</blockquote><p> |
| 12524 |
|
|
| 12525 |
</p> |
</p> |
| 12526 |
|
<p>effect_instance = |
| 12527 |
|
</p> |
| 12528 |
|
<blockquote class="text"> |
| 12529 |
|
<p>number |
| 12530 |
|
|
| 12531 |
|
</p> |
| 12532 |
|
</blockquote><p> |
| 12533 |
|
|
| 12534 |
|
</p> |
| 12535 |
<p>device_index = |
<p>device_index = |
| 12536 |
</p> |
</p> |
| 12537 |
<blockquote class="text"> |
<blockquote class="text"> |
| 12637 |
</blockquote><p> |
</blockquote><p> |
| 12638 |
|
|
| 12639 |
</p> |
</p> |
| 12640 |
|
<p>control_value = |
| 12641 |
|
</p> |
| 12642 |
|
<blockquote class="text"> |
| 12643 |
|
<p>real |
| 12644 |
|
|
| 12645 |
|
</p> |
| 12646 |
|
</blockquote><p> |
| 12647 |
|
|
| 12648 |
|
</p> |
| 12649 |
<p>sampler_channel = |
<p>sampler_channel = |
| 12650 |
</p> |
</p> |
| 12651 |
<blockquote class="text"> |
<blockquote class="text"> |
| 12727 |
</blockquote><p> |
</blockquote><p> |
| 12728 |
|
|
| 12729 |
</p> |
</p> |
| 12730 |
|
<p>effect_name = |
| 12731 |
|
</p> |
| 12732 |
|
<blockquote class="text"> |
| 12733 |
|
<p>stringval_escaped |
| 12734 |
|
|
| 12735 |
|
</p> |
| 12736 |
|
</blockquote><p> |
| 12737 |
|
|
| 12738 |
|
</p> |
| 12739 |
|
<p>effect_index = |
| 12740 |
|
</p> |
| 12741 |
|
<blockquote class="text"> |
| 12742 |
|
<p>number |
| 12743 |
|
|
| 12744 |
|
</p> |
| 12745 |
|
</blockquote><p> |
| 12746 |
|
|
| 12747 |
|
</p> |
| 12748 |
|
<p>effect_chain = |
| 12749 |
|
</p> |
| 12750 |
|
<blockquote class="text"> |
| 12751 |
|
<p>number |
| 12752 |
|
|
| 12753 |
|
</p> |
| 12754 |
|
</blockquote><p> |
| 12755 |
|
|
| 12756 |
|
</p> |
| 12757 |
|
<p>chain_pos = |
| 12758 |
|
</p> |
| 12759 |
|
<blockquote class="text"> |
| 12760 |
|
<p>number |
| 12761 |
|
|
| 12762 |
|
</p> |
| 12763 |
|
</blockquote><p> |
| 12764 |
|
|
| 12765 |
|
</p> |
| 12766 |
|
<p>input_control = |
| 12767 |
|
</p> |
| 12768 |
|
<blockquote class="text"> |
| 12769 |
|
<p>number |
| 12770 |
|
|
| 12771 |
|
</p> |
| 12772 |
|
</blockquote><p> |
| 12773 |
|
|
| 12774 |
|
</p> |
| 12775 |
<p>param_val_list = |
<p>param_val_list = |
| 12776 |
</p> |
</p> |
| 12777 |
<blockquote class="text"> |
<blockquote class="text"> |
| 12841 |
</blockquote><p> |
</blockquote><p> |
| 12842 |
|
|
| 12843 |
</p> |
</p> |
| 12844 |
|
<p>effect_system = |
| 12845 |
|
</p> |
| 12846 |
|
<blockquote class="text"> |
| 12847 |
|
<p>string |
| 12848 |
|
|
| 12849 |
|
</p> |
| 12850 |
|
</blockquote><p> |
| 12851 |
|
|
| 12852 |
|
</p> |
| 12853 |
|
<p>module = |
| 12854 |
|
</p> |
| 12855 |
|
<blockquote class="text"> |
| 12856 |
|
<p>filename |
| 12857 |
|
|
| 12858 |
|
</p> |
| 12859 |
|
</blockquote><p> |
| 12860 |
|
|
| 12861 |
|
</p> |
| 12862 |
<a name="character_set"></a><br /><hr /> |
<a name="character_set"></a><br /><hr /> |
| 12863 |
<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> |
| 12864 |
<a name="rfc.section.7.1"></a><h3>7.1. |
<a name="rfc.section.7.1"></a><h3>7.1. |
| 12916 |
<td align="left">two digit hex ASCII code of the character</td> |
<td align="left">two digit hex ASCII code of the character</td> |
| 12917 |
</tr> |
</tr> |
| 12918 |
</table> |
</table> |
| 12919 |
|
<br clear="all" /> |
| 12920 |
|
|
| 12921 |
<p>Notice: due to the transition of certain parts of the |
<p>Notice: due to the transition of certain parts of the |
| 12922 |
protocol which now support escape sequences, a slight backward |
protocol which now support escape sequences, a slight backward |
| 12927 |
in the old versions a single backslash was sufficient. |
in the old versions a single backslash was sufficient. |
| 12928 |
</p> |
</p> |
| 12929 |
<p>The following LSCP commands support escape sequences as part |
<p>The following LSCP commands support escape sequences as part |
| 12930 |
of their filename / path based arguments: |
of their filename / path based arguments and / or may contain |
| 12931 |
|
a filename / path with escape sequences in their response: |
| 12932 |
</p> |
</p> |
| 12933 |
<blockquote class="text"> |
<blockquote class="text"> |
| 12934 |
<p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a> |
<p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a> |
| 12935 |
</p> |
</p> |
| 12936 |
|
<p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a> |
| 12937 |
|
</p> |
| 12938 |
<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> |
<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> |
| 12939 |
</p> |
</p> |
| 12940 |
|
<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> |
| 12941 |
|
</p> |
| 12942 |
<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> |
<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> |
| 12943 |
</p> |
</p> |
| 12944 |
<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> |
<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> |
| 12979 |
</p> |
</p> |
| 12980 |
<p><a class='info' href='#COPY DB_INSTRUMENT_DIRECTORY'>"COPY DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Copying instrument directories</span><span>)</span></a> |
<p><a class='info' href='#COPY DB_INSTRUMENT_DIRECTORY'>"COPY DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Copying instrument directories</span><span>)</span></a> |
| 12981 |
</p> |
</p> |
| 12982 |
|
<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> |
| 12983 |
|
</p> |
| 12984 |
|
<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> |
| 12985 |
|
</p> |
| 12986 |
|
<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> |
| 12987 |
|
</p> |
| 12988 |
|
<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> |
| 12989 |
|
</p> |
| 12990 |
|
<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> |
| 12991 |
|
</p> |
| 12992 |
|
<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> |
| 12993 |
|
</p> |
| 12994 |
|
<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> |
| 12995 |
|
</p> |
| 12996 |
|
<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> |
| 12997 |
|
</p> |
| 12998 |
</blockquote><p> |
</blockquote><p> |
| 12999 |
Note that the forward slash character ('/') has a special meaning in |
Note that the forward slash character ('/') has a special meaning in |
| 13000 |
filename / path based arguments: it acts as separator of the nodes in |
filename / path based arguments: it acts as separator of the nodes in |
| 13005 |
|
|
| 13006 |
</p> |
</p> |
| 13007 |
<p> |
<p> |
| 13008 |
|
Note for Windows: file path arguments in LSCP are expected |
| 13009 |
|
to use forward slashes as directory node separator similar |
| 13010 |
|
to Unix based operating systems. In contrast to Unix however |
| 13011 |
|
a Windows typical drive character is expected to be |
| 13012 |
|
prefixed to the path. That is an original Windows file path |
| 13013 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
| 13014 |
|
"D:/Sounds/My.gig". |
| 13015 |
|
|
| 13016 |
|
</p> |
| 13017 |
|
<p> |
| 13018 |
The following LSCP commands even support escape sequences as |
The following LSCP commands even support escape sequences as |
| 13019 |
part of at least one of their text-based arguments (i.e. entity name, |
part of at least one of their text-based arguments (i.e. entity name, |
| 13020 |
description): |
description) and / or may contain escape sequences in at least one of |
| 13021 |
|
their text-based fields in their response: |
| 13022 |
</p> |
</p> |
| 13023 |
<blockquote class="text"> |
<blockquote class="text"> |
| 13024 |
|
<p><a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a> |
| 13025 |
|
</p> |
| 13026 |
|
<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> |
| 13027 |
|
</p> |
| 13028 |
|
<p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a> |
| 13029 |
|
</p> |
| 13030 |
|
<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> |
| 13031 |
|
</p> |
| 13032 |
|
<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> |
| 13033 |
|
</p> |
| 13034 |
|
<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> |
| 13035 |
|
</p> |
| 13036 |
|
<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> |
| 13037 |
|
</p> |
| 13038 |
|
<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> |
| 13039 |
|
</p> |
| 13040 |
<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> |
<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> |
| 13041 |
</p> |
</p> |
| 13042 |
<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> |
<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> |
| 13043 |
</p> |
</p> |
| 13044 |
<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> |
<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> |
| 13045 |
</p> |
</p> |
| 13046 |
|
<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> |
| 13047 |
|
</p> |
| 13048 |
<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> |
<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> |
| 13049 |
</p> |
</p> |
| 13050 |
<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> |
<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> |
| 13051 |
</p> |
</p> |
| 13052 |
|
<p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a> |
| 13053 |
|
</p> |
| 13054 |
|
<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> |
| 13055 |
|
</p> |
| 13056 |
<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> |
<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> |
| 13057 |
</p> |
</p> |
| 13058 |
<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> |
<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> |
| 13059 |
</p> |
</p> |
| 13060 |
<p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a> |
<p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a> |
| 13061 |
|
</p> |
| 13062 |
|
<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> |
| 13063 |
|
</p> |
| 13064 |
|
<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> |
| 13065 |
|
</p> |
| 13066 |
|
<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> |
| 13067 |
</p> |
</p> |
| 13068 |
</blockquote><p> |
</blockquote><p> |
| 13069 |
Please note that these lists are manually maintained. If you |
Please note that these lists are manually maintained. If you |
| 13231 |
<p>where <channels> will be replaced by the new number |
<p>where <channels> will be replaced by the new number |
| 13232 |
of sampler channels. |
of sampler channels. |
| 13233 |
</p> |
</p> |
| 13234 |
<a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE CHANNEL_MIDI"></a><br /><hr /> |
| 13235 |
<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> |
| 13236 |
<a name="rfc.section.8.6"></a><h3>8.6. |
<a name="rfc.section.8.6"></a><h3>8.6. |
| 13237 |
|
MIDI data on a sampler channel arrived</h3> |
| 13238 |
|
|
| 13239 |
|
<p>Client may want to be notified when MIDI data arrive on sampler channels on |
| 13240 |
|
back-end side, by issuing the following command: |
| 13241 |
|
</p> |
| 13242 |
|
<p> |
| 13243 |
|
</p> |
| 13244 |
|
<blockquote class="text"> |
| 13245 |
|
<p>SUBSCRIBE CHANNEL_MIDI |
| 13246 |
|
</p> |
| 13247 |
|
</blockquote><p> |
| 13248 |
|
|
| 13249 |
|
</p> |
| 13250 |
|
<p>Server will start sending one of the the following notification messages: |
| 13251 |
|
</p> |
| 13252 |
|
<p> |
| 13253 |
|
</p> |
| 13254 |
|
<blockquote class="text"> |
| 13255 |
|
<p>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>" |
| 13256 |
|
</p> |
| 13257 |
|
<p>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>" |
| 13258 |
|
</p> |
| 13259 |
|
</blockquote><p> |
| 13260 |
|
|
| 13261 |
|
</p> |
| 13262 |
|
<p>where <channel-id> will be replaced by the ID of the sampler channel where the MIDI |
| 13263 |
|
data arrived. <note> and <velocity> are integer values in the range between |
| 13264 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
| 13265 |
|
|
| 13266 |
|
</p> |
| 13267 |
|
<p>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
| 13268 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
| 13269 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
| 13270 |
|
thread unaffected by this feature. |
| 13271 |
|
</p> |
| 13272 |
|
<a name="SUBSCRIBE DEVICE_MIDI"></a><br /><hr /> |
| 13273 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 13274 |
|
<a name="rfc.section.8.7"></a><h3>8.7. |
| 13275 |
|
MIDI data on a MIDI input device arrived</h3> |
| 13276 |
|
|
| 13277 |
|
<p>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command: |
| 13278 |
|
</p> |
| 13279 |
|
<p> |
| 13280 |
|
</p> |
| 13281 |
|
<blockquote class="text"> |
| 13282 |
|
<p>SUBSCRIBE DEVICE_MIDI |
| 13283 |
|
</p> |
| 13284 |
|
</blockquote><p> |
| 13285 |
|
|
| 13286 |
|
</p> |
| 13287 |
|
<p>Server will start sending one of the the following notification messages: |
| 13288 |
|
</p> |
| 13289 |
|
<p> |
| 13290 |
|
</p> |
| 13291 |
|
<blockquote class="text"> |
| 13292 |
|
<p>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note> <velocity>" |
| 13293 |
|
</p> |
| 13294 |
|
<p>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note> <velocity>" |
| 13295 |
|
</p> |
| 13296 |
|
</blockquote><p> |
| 13297 |
|
|
| 13298 |
|
</p> |
| 13299 |
|
<p>where <device-id> <port-id> will be replaced |
| 13300 |
|
by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI |
| 13301 |
|
data arrived. <note> and <velocity> are integer values in the range between |
| 13302 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
| 13303 |
|
|
| 13304 |
|
</p> |
| 13305 |
|
<p>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
| 13306 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
| 13307 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
| 13308 |
|
thread unaffected by this feature. |
| 13309 |
|
</p> |
| 13310 |
|
<a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr /> |
| 13311 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 13312 |
|
<a name="rfc.section.8.8"></a><h3>8.8. |
| 13313 |
Number of active voices changed</h3> |
Number of active voices changed</h3> |
| 13314 |
|
|
| 13315 |
<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 |
| 13339 |
</p> |
</p> |
| 13340 |
<a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr /> |
| 13341 |
<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> |
| 13342 |
<a name="rfc.section.8.7"></a><h3>8.7. |
<a name="rfc.section.8.9"></a><h3>8.9. |
| 13343 |
Number of active disk streams changed</h3> |
Number of active disk streams changed</h3> |
| 13344 |
|
|
| 13345 |
<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 |
| 13369 |
</p> |
</p> |
| 13370 |
<a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr /> |
<a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr /> |
| 13371 |
<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> |
| 13372 |
<a name="rfc.section.8.8"></a><h3>8.8. |
<a name="rfc.section.8.10"></a><h3>8.10. |
| 13373 |
Disk stream buffer fill state changed</h3> |
Disk stream buffer fill state changed</h3> |
| 13374 |
|
|
| 13375 |
<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 |
| 13400 |
</p> |
</p> |
| 13401 |
<a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr /> |
| 13402 |
<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> |
| 13403 |
<a name="rfc.section.8.9"></a><h3>8.9. |
<a name="rfc.section.8.11"></a><h3>8.11. |
| 13404 |
Channel information changed</h3> |
Channel information changed</h3> |
| 13405 |
|
|
| 13406 |
<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 |
| 13433 |
</p> |
</p> |
| 13434 |
<a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr /> |
| 13435 |
<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> |
| 13436 |
<a name="rfc.section.8.10"></a><h3>8.10. |
<a name="rfc.section.8.12"></a><h3>8.12. |
| 13437 |
Number of effect sends changed</h3> |
Number of effect sends changed</h3> |
| 13438 |
|
|
| 13439 |
<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 |
| 13463 |
</p> |
</p> |
| 13464 |
<a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr /> |
| 13465 |
<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> |
| 13466 |
<a name="rfc.section.8.11"></a><h3>8.11. |
<a name="rfc.section.8.13"></a><h3>8.13. |
| 13467 |
Effect send information changed</h3> |
Effect send information changed</h3> |
| 13468 |
|
|
| 13469 |
<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 |
| 13493 |
</p> |
</p> |
| 13494 |
<a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr /> |
| 13495 |
<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> |
| 13496 |
<a name="rfc.section.8.12"></a><h3>8.12. |
<a name="rfc.section.8.14"></a><h3>8.14. |
| 13497 |
Total number of active voices changed</h3> |
Total number of active voices changed</h3> |
| 13498 |
|
|
| 13499 |
<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 |
| 13520 |
<p>where <voices> will be replaced by the new number of |
<p>where <voices> will be replaced by the new number of |
| 13521 |
all currently active voices. |
all currently active voices. |
| 13522 |
</p> |
</p> |
| 13523 |
|
<a name="SUBSCRIBE TOTAL_STREAM_COUNT"></a><br /><hr /> |
| 13524 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
| 13525 |
|
<a name="rfc.section.8.15"></a><h3>8.15. |
| 13526 |
|
Total number of active disk streams changed</h3> |
| 13527 |
|
|
| 13528 |
|
<p>Client may want to be notified when the total number of disk streams on the |
| 13529 |
|
back-end changes by issuing the following command: |
| 13530 |
|
</p> |
| 13531 |
|
<p> |
| 13532 |
|
</p> |
| 13533 |
|
<blockquote class="text"> |
| 13534 |
|
<p>SUBSCRIBE TOTAL_STREAM_COUNT |
| 13535 |
|
</p> |
| 13536 |
|
</blockquote><p> |
| 13537 |
|
|
| 13538 |
|
</p> |
| 13539 |
|
<p>Server will start sending the following notification messages: |
| 13540 |
|
</p> |
| 13541 |
|
<p> |
| 13542 |
|
</p> |
| 13543 |
|
<blockquote class="text"> |
| 13544 |
|
<p>"NOTIFY:TOTAL_STREAM_COUNT:<streams>" |
| 13545 |
|
</p> |
| 13546 |
|
</blockquote><p> |
| 13547 |
|
|
| 13548 |
|
</p> |
| 13549 |
|
<p>where <streams> will be replaced by the new number of |
| 13550 |
|
all currently active disk streams. |
| 13551 |
|
</p> |
| 13552 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr /> |
| 13553 |
<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> |
| 13554 |
<a name="rfc.section.8.13"></a><h3>8.13. |
<a name="rfc.section.8.16"></a><h3>8.16. |
| 13555 |
Number of MIDI instrument maps changed</h3> |
Number of MIDI instrument maps changed</h3> |
| 13556 |
|
|
| 13557 |
<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 |
| 13580 |
</p> |
</p> |
| 13581 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr /> |
| 13582 |
<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> |
| 13583 |
<a name="rfc.section.8.14"></a><h3>8.14. |
<a name="rfc.section.8.17"></a><h3>8.17. |
| 13584 |
MIDI instrument map information changed</h3> |
MIDI instrument map information changed</h3> |
| 13585 |
|
|
| 13586 |
<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 |
| 13613 |
</p> |
</p> |
| 13614 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr /> |
| 13615 |
<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> |
| 13616 |
<a name="rfc.section.8.15"></a><h3>8.15. |
<a name="rfc.section.8.18"></a><h3>8.18. |
| 13617 |
Number of MIDI instruments changed</h3> |
Number of MIDI instruments changed</h3> |
| 13618 |
|
|
| 13619 |
<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 |
| 13643 |
</p> |
</p> |
| 13644 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr /> |
| 13645 |
<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> |
| 13646 |
<a name="rfc.section.8.16"></a><h3>8.16. |
<a name="rfc.section.8.19"></a><h3>8.19. |
| 13647 |
MIDI instrument information changed</h3> |
MIDI instrument information changed</h3> |
| 13648 |
|
|
| 13649 |
<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 |
| 13677 |
</p> |
</p> |
| 13678 |
<a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr /> |
| 13679 |
<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> |
| 13680 |
<a name="rfc.section.8.17"></a><h3>8.17. |
<a name="rfc.section.8.20"></a><h3>8.20. |
| 13681 |
Global settings changed</h3> |
Global settings changed</h3> |
| 13682 |
|
|
| 13683 |
<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 |
| 13702 |
new global volume parameter. |
new global volume parameter. |
| 13703 |
</p> |
</p> |
| 13704 |
</blockquote><p> |
</blockquote><p> |
| 13705 |
|
</p> |
| 13706 |
|
<blockquote class="text"> |
| 13707 |
|
<p>"NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the |
| 13708 |
|
golbal limit of the sampler for maximum voices is changed, where |
| 13709 |
|
<max-voices> will be an integer value, reflecting the |
| 13710 |
|
new global voice limit parameter. |
| 13711 |
|
</p> |
| 13712 |
|
</blockquote><p> |
| 13713 |
|
</p> |
| 13714 |
|
<blockquote class="text"> |
| 13715 |
|
<p>"NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the |
| 13716 |
|
golbal limit of the sampler for maximum disk streams is changed, where |
| 13717 |
|
<max-streams> will be an integer value, reflecting the |
| 13718 |
|
new global disk streams limit parameter. |
| 13719 |
|
</p> |
| 13720 |
|
</blockquote><p> |
| 13721 |
|
|
| 13722 |
</p> |
</p> |
| 13723 |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
| 13724 |
<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> |
| 13725 |
<a name="rfc.section.8.18"></a><h3>8.18. |
<a name="rfc.section.8.21"></a><h3>8.21. |
| 13726 |
Number of database instrument directories changed</h3> |
Number of database instrument directories changed</h3> |
| 13727 |
|
|
| 13728 |
<p>Client may want to be notified when the number of instrument |
<p>Client may want to be notified when the number of instrument |
| 13756 |
</p> |
</p> |
| 13757 |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr /> |
| 13758 |
<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> |
| 13759 |
<a name="rfc.section.8.19"></a><h3>8.19. |
<a name="rfc.section.8.22"></a><h3>8.22. |
| 13760 |
Database instrument directory information changed</h3> |
Database instrument directory information changed</h3> |
| 13761 |
|
|
| 13762 |
<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 |
| 13801 |
</p> |
</p> |
| 13802 |
<a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr /> |
| 13803 |
<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> |
| 13804 |
<a name="rfc.section.8.20"></a><h3>8.20. |
<a name="rfc.section.8.23"></a><h3>8.23. |
| 13805 |
Number of database instruments changed</h3> |
Number of database instruments changed</h3> |
| 13806 |
|
|
| 13807 |
<p>Client may want to be notified when the number of instruments |
<p>Client may want to be notified when the number of instruments |
| 13835 |
</p> |
</p> |
| 13836 |
<a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr /> |
| 13837 |
<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> |
| 13838 |
<a name="rfc.section.8.21"></a><h3>8.21. |
<a name="rfc.section.8.24"></a><h3>8.24. |
| 13839 |
Database instrument information changed</h3> |
Database instrument information changed</h3> |
| 13840 |
|
|
| 13841 |
<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 |
| 13880 |
</p> |
</p> |
| 13881 |
<a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr /> |
| 13882 |
<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> |
| 13883 |
<a name="rfc.section.8.22"></a><h3>8.22. |
<a name="rfc.section.8.25"></a><h3>8.25. |
| 13884 |
Database job status information changed</h3> |
Database job status information changed</h3> |
| 13885 |
|
|
| 13886 |
<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 |
| 13913 |
</p> |
</p> |
| 13914 |
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr /> |
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr /> |
| 13915 |
<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> |
| 13916 |
<a name="rfc.section.8.23"></a><h3>8.23. |
<a name="rfc.section.8.26"></a><h3>8.26. |
| 13917 |
Miscellaneous and debugging events</h3> |
Miscellaneous and debugging events</h3> |
| 13918 |
|
|
| 13919 |
<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 |
| 13979 |
<h3>11. References</h3> |
<h3>11. References</h3> |
| 13980 |
<table width="99%" border="0"> |
<table width="99%" border="0"> |
| 13981 |
<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> |
| 13982 |
<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> |
| 13983 |
<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> |
| 13984 |
<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> |
| 13985 |
<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> |
| 13986 |
<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> |
| 13987 |
<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> |
| 13988 |
<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> |
| 13989 |
</table> |
</table> |
| 13990 |
|
|
| 13991 |
<a name="rfc.authors"></a><br /><hr /> |
<a name="rfc.authors"></a><br /><hr /> |
| 14010 |
<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> |
| 14011 |
<h3>Full Copyright Statement</h3> |
<h3>Full Copyright Statement</h3> |
| 14012 |
<p class='copyright'> |
<p class='copyright'> |
| 14013 |
Copyright © The IETF Trust (2007).</p> |
Copyright © The IETF Trust (2010).</p> |
| 14014 |
<p class='copyright'> |
<p class='copyright'> |
| 14015 |
This document is subject to the rights, |
This document is subject to the rights, |
| 14016 |
licenses and restrictions contained in BCP 78, |
licenses and restrictions contained in BCP 78, |
| 14052 |
proprietary rights that may cover technology that may be required |
proprietary rights that may cover technology that may be required |
| 14053 |
to implement this standard. |
to implement this standard. |
| 14054 |
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> |
|
| 14055 |
</body></html> |
</body></html> |
|
|
|
Parent Directory
| 
Revision Log
| 
Patch