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.32 (http://xml.resource.org/)"> |
7 |
<style type='text/css'><!-- |
<style type='text/css'><!-- |
145 |
<tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr> |
<tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr> |
146 |
<tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr> |
<tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr> |
147 |
<tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr> |
<tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr> |
148 |
<tr><td class="header">Expires: March 4, 2008</td><td class="header">September 2007</td></tr> |
<tr><td class="header">Expires: June 7, 2008</td><td class="header">December 5, 2007</td></tr> |
149 |
</table></td></tr></table> |
</table></td></tr></table> |
150 |
<h1><br />LinuxSampler Control Protocol (draft)<br />LSCP 1.2cvs</h1> |
<h1><br />LinuxSampler Control Protocol<br />LSCP 1.3</h1> |
151 |
|
|
152 |
<h3>Status of this Memo</h3> |
<h3>Status of this Memo</h3> |
153 |
<p> |
<p> |
173 |
The list of Internet-Draft Shadow Directories can be accessed at |
The list of Internet-Draft Shadow Directories can be accessed at |
174 |
<a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p> |
<a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p> |
175 |
<p> |
<p> |
176 |
This Internet-Draft will expire on March 4, 2008.</p> |
This Internet-Draft will expire on June 7, 2008.</p> |
177 |
|
|
178 |
<h3>Copyright Notice</h3> |
<h3>Copyright Notice</h3> |
179 |
<p> |
<p> |
354 |
Current number of active voices<br /> |
Current number of active voices<br /> |
355 |
<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a> |
<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a> |
356 |
Maximum amount of active voices<br /> |
Maximum amount of active voices<br /> |
357 |
<a href="#RESET">6.6.3.</a> |
<a href="#GET TOTAL_STREAM_COUNT">6.6.3.</a> |
358 |
|
Current number of active disk streams<br /> |
359 |
|
<a href="#RESET">6.6.4.</a> |
360 |
Reset sampler<br /> |
Reset sampler<br /> |
361 |
<a href="#GET SERVER INFO">6.6.4.</a> |
<a href="#GET SERVER INFO">6.6.5.</a> |
362 |
General sampler informations<br /> |
General sampler informations<br /> |
363 |
<a href="#GET VOLUME">6.6.5.</a> |
<a href="#GET VOLUME">6.6.6.</a> |
364 |
Getting global volume attenuation<br /> |
Getting global volume attenuation<br /> |
365 |
<a href="#SET VOLUME">6.6.6.</a> |
<a href="#SET VOLUME">6.6.7.</a> |
366 |
Setting global volume attenuation<br /> |
Setting global volume attenuation<br /> |
367 |
<a href="#MIDI Instrument Mapping">6.7.</a> |
<a href="#MIDI Instrument Mapping">6.7.</a> |
368 |
MIDI Instrument Mapping<br /> |
MIDI Instrument Mapping<br /> |
369 |
<a href="#ADD MIDI_INSTRUMENT MAP">6.7.1.</a> |
<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a> |
370 |
Create a new MIDI instrument map<br /> |
Create a new MIDI instrument map<br /> |
371 |
<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a> |
<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a> |
372 |
Delete one particular or all MIDI instrument maps<br /> |
Delete one particular or all MIDI instrument maps<br /> |
440 |
Editing Instruments<br /> |
Editing Instruments<br /> |
441 |
<a href="#EDIT INSTRUMENT">6.9.1.</a> |
<a href="#EDIT INSTRUMENT">6.9.1.</a> |
442 |
Opening an appropriate instrument editor application<br /> |
Opening an appropriate instrument editor application<br /> |
443 |
|
<a href="#file_management">6.10.</a> |
444 |
|
Managing Files<br /> |
445 |
|
<a href="#GET FILE INSTRUMENTS">6.10.1.</a> |
446 |
|
Retrieving amount of instruments of a file<br /> |
447 |
|
<a href="#LIST FILE INSTRUMENTS">6.10.2.</a> |
448 |
|
Retrieving all instruments of a file<br /> |
449 |
|
<a href="#GET FILE INSTRUMENT INFO">6.10.3.</a> |
450 |
|
Retrieving informations about one instrument in a file<br /> |
451 |
<a href="#command_syntax">7.</a> |
<a href="#command_syntax">7.</a> |
452 |
Command Syntax<br /> |
Command Syntax<br /> |
453 |
<a href="#character_set">7.1.</a> |
<a href="#character_set">7.1.</a> |
478 |
Effect send information changed<br /> |
Effect send information changed<br /> |
479 |
<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a> |
<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a> |
480 |
Total number of active voices changed<br /> |
Total number of active voices changed<br /> |
481 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.13.</a> |
<a href="#SUBSCRIBE TOTAL_STREAM_COUNT">8.13.</a> |
482 |
|
Total number of active disk streams changed<br /> |
483 |
|
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.14.</a> |
484 |
Number of MIDI instrument maps changed<br /> |
Number of MIDI instrument maps changed<br /> |
485 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.14.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.15.</a> |
486 |
MIDI instrument map information changed<br /> |
MIDI instrument map information changed<br /> |
487 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.15.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.16.</a> |
488 |
Number of MIDI instruments changed<br /> |
Number of MIDI instruments changed<br /> |
489 |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.16.</a> |
<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.17.</a> |
490 |
MIDI instrument information changed<br /> |
MIDI instrument information changed<br /> |
491 |
<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a> |
<a href="#SUBSCRIBE GLOBAL_INFO">8.18.</a> |
492 |
Global settings changed<br /> |
Global settings changed<br /> |
493 |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.18.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.19.</a> |
494 |
Number of database instrument directories changed<br /> |
Number of database instrument directories changed<br /> |
495 |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.19.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.20.</a> |
496 |
Database instrument directory information changed<br /> |
Database instrument directory information changed<br /> |
497 |
<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.20.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.21.</a> |
498 |
Number of database instruments changed<br /> |
Number of database instruments changed<br /> |
499 |
<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.21.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.22.</a> |
500 |
Database instrument information changed<br /> |
Database instrument information changed<br /> |
501 |
<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.22.</a> |
<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.23.</a> |
502 |
Database job status information changed<br /> |
Database job status information changed<br /> |
503 |
<a href="#SUBSCRIBE MISCELLANEOUS">8.23.</a> |
<a href="#SUBSCRIBE MISCELLANEOUS">8.24.</a> |
504 |
Miscellaneous and debugging events<br /> |
Miscellaneous and debugging events<br /> |
505 |
<a href="#anchor14">9.</a> |
<a href="#anchor14">9.</a> |
506 |
Security Considerations<br /> |
Security Considerations<br /> |
3461 |
</blockquote><p> |
</blockquote><p> |
3462 |
|
|
3463 |
</p> |
</p> |
3464 |
<p>Example: |
<p>Example (Unix): |
3465 |
</p> |
</p> |
3466 |
<p> |
<p> |
3467 |
</p> |
</p> |
3468 |
<blockquote class="text"> |
<blockquote class="text"> |
3469 |
|
<p>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0 |
3470 |
|
</p> |
3471 |
|
<p>S: OK |
3472 |
|
</p> |
3473 |
|
</blockquote><p> |
3474 |
|
|
3475 |
|
</p> |
3476 |
|
<p>Example (Windows): |
3477 |
|
</p> |
3478 |
<p> |
<p> |
3479 |
|
</p> |
3480 |
|
<blockquote class="text"> |
3481 |
|
<p>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0 |
3482 |
|
</p> |
3483 |
|
<p>S: OK |
3484 |
</p> |
</p> |
3485 |
</blockquote><p> |
</blockquote><p> |
3486 |
|
|
3895 |
</p> |
</p> |
3896 |
<blockquote class="text"> |
<blockquote class="text"> |
3897 |
<p>arbitrary description text about the engine |
<p>arbitrary description text about the engine |
3898 |
|
(note that the character string may contain |
3899 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
3900 |
</p> |
</p> |
3901 |
</blockquote> |
</blockquote> |
3902 |
|
|
4016 |
<blockquote class="text"> |
<blockquote class="text"> |
4017 |
<p>the file name of the loaded instrument, "NONE" if |
<p>the file name of the loaded instrument, "NONE" if |
4018 |
there's no instrument yet loaded for this sampler |
there's no instrument yet loaded for this sampler |
4019 |
channel |
channel (note: since LSCP 1.2 this path may contain |
4020 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
4021 |
</p> |
</p> |
4022 |
</blockquote> |
</blockquote> |
4023 |
|
|
4034 |
</p> |
</p> |
4035 |
<blockquote class="text"> |
<blockquote class="text"> |
4036 |
<p>the instrument name of the loaded instrument |
<p>the instrument name of the loaded instrument |
4037 |
|
(note: since LSCP 1.2 this character string may contain |
4038 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
4039 |
</p> |
</p> |
4040 |
</blockquote> |
</blockquote> |
4041 |
|
|
5111 |
sampler channel on which the effect send should be created on, <midi-ctrl> |
sampler channel on which the effect send should be created on, <midi-ctrl> |
5112 |
is a number between 0..127 defining the MIDI controller which can alter the |
is a number between 0..127 defining the MIDI controller which can alter the |
5113 |
effect send level and <name> is an optional argument defining a name |
effect send level and <name> is an optional argument defining a name |
5114 |
for the effect send entity. The name does not have to be unique. |
for the effect send entity. The name does not have to be unique, but MUST be |
5115 |
|
encapsulated into apostrophes and supports escape sequences as described in chapter |
5116 |
|
"<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>". |
5117 |
</p> |
</p> |
5118 |
<p>By default, that is as initial routing, the effect send's audio channels |
<p>By default, that is as initial routing, the effect send's audio channels |
5119 |
are automatically routed to the last audio channels of the sampler channel's |
are automatically routed to the last audio channels of the sampler channel's |
5382 |
</p> |
</p> |
5383 |
<blockquote class="text"> |
<blockquote class="text"> |
5384 |
<p>name of the effect send entity |
<p>name of the effect send entity |
5385 |
|
(note that this character string may contain |
5386 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
5387 |
</p> |
</p> |
5388 |
</blockquote> |
</blockquote> |
5389 |
|
|
5474 |
as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a> |
as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a> |
5475 |
or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and |
or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and |
5476 |
<name> is the new name of the effect send entity, which |
<name> is the new name of the effect send entity, which |
5477 |
does not have to be unique. |
does not have to be unique (name MUST be encapsulated into apostrophes |
5478 |
|
and supports escape sequences as described in chapter |
5479 |
|
"<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>"). |
5480 |
|
|
5481 |
</p> |
</p> |
5482 |
<p>Possible Answers: |
<p>Possible Answers: |
5483 |
</p> |
</p> |
6078 |
</blockquote><p> |
</blockquote><p> |
6079 |
|
|
6080 |
</p> |
</p> |
6081 |
<a name="RESET"></a><br /><hr /> |
<a name="GET TOTAL_STREAM_COUNT"></a><br /><hr /> |
6082 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6083 |
<a name="rfc.section.6.6.3"></a><h3>6.6.3. |
<a name="rfc.section.6.6.3"></a><h3>6.6.3. |
6084 |
|
Current number of active disk streams</h3> |
6085 |
|
|
6086 |
|
<p>The front-end can ask for the current number of active disk streams on |
6087 |
|
the sampler by sending the following command: |
6088 |
|
</p> |
6089 |
|
<p> |
6090 |
|
</p> |
6091 |
|
<blockquote class="text"> |
6092 |
|
<p>GET TOTAL_STREAM_COUNT |
6093 |
|
</p> |
6094 |
|
</blockquote><p> |
6095 |
|
|
6096 |
|
</p> |
6097 |
|
<p>Possible Answers: |
6098 |
|
</p> |
6099 |
|
<p> |
6100 |
|
</p> |
6101 |
|
<blockquote class="text"> |
6102 |
|
<p>LinuxSampler will answer by returning the number of all active |
6103 |
|
disk streams on the sampler. |
6104 |
|
</p> |
6105 |
|
</blockquote><p> |
6106 |
|
|
6107 |
|
</p> |
6108 |
|
<a name="RESET"></a><br /><hr /> |
6109 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6110 |
|
<a name="rfc.section.6.6.4"></a><h3>6.6.4. |
6111 |
Reset sampler</h3> |
Reset sampler</h3> |
6112 |
|
|
6113 |
<p>The front-end can reset the whole sampler by sending the following command: |
<p>The front-end can reset the whole sampler by sending the following command: |
6148 |
</p> |
</p> |
6149 |
<a name="GET SERVER INFO"></a><br /><hr /> |
<a name="GET SERVER INFO"></a><br /><hr /> |
6150 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6151 |
<a name="rfc.section.6.6.4"></a><h3>6.6.4. |
<a name="rfc.section.6.6.5"></a><h3>6.6.5. |
6152 |
General sampler informations</h3> |
General sampler informations</h3> |
6153 |
|
|
6154 |
<p>The client can ask for general informations about the LinuxSampler |
<p>The client can ask for general informations about the LinuxSampler |
6181 |
</p> |
</p> |
6182 |
<blockquote class="text"> |
<blockquote class="text"> |
6183 |
<p>arbitrary textual description about the sampler |
<p>arbitrary textual description about the sampler |
6184 |
|
(note that the character string may contain |
6185 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
6186 |
</p> |
</p> |
6187 |
</blockquote> |
</blockquote> |
6188 |
|
|
6224 |
</p> |
</p> |
6225 |
<a name="GET VOLUME"></a><br /><hr /> |
<a name="GET VOLUME"></a><br /><hr /> |
6226 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6227 |
<a name="rfc.section.6.6.5"></a><h3>6.6.5. |
<a name="rfc.section.6.6.6"></a><h3>6.6.6. |
6228 |
Getting global volume attenuation</h3> |
Getting global volume attenuation</h3> |
6229 |
|
|
6230 |
<p>The client can ask for the current global sampler-wide volume |
<p>The client can ask for the current global sampler-wide volume |
6257 |
</p> |
</p> |
6258 |
<a name="SET VOLUME"></a><br /><hr /> |
<a name="SET VOLUME"></a><br /><hr /> |
6259 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6260 |
<a name="rfc.section.6.6.6"></a><h3>6.6.6. |
<a name="rfc.section.6.6.7"></a><h3>6.6.7. |
6261 |
Setting global volume attenuation</h3> |
Setting global volume attenuation</h3> |
6262 |
|
|
6263 |
<p>The client can alter the current global sampler-wide volume |
<p>The client can alter the current global sampler-wide volume |
6344 |
cause the sampler to switch to the respective instrument as |
cause the sampler to switch to the respective instrument as |
6345 |
reflected by the current MIDI instrument map. |
reflected by the current MIDI instrument map. |
6346 |
</p> |
</p> |
6347 |
<a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr /> |
<a name="ADD MIDI_INSTRUMENT_MAP"></a><br /><hr /> |
6348 |
<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> |
6349 |
<a name="rfc.section.6.7.1"></a><h3>6.7.1. |
<a name="rfc.section.6.7.1"></a><h3>6.7.1. |
6350 |
Create a new MIDI instrument map</h3> |
Create a new MIDI instrument map</h3> |
6362 |
</p> |
</p> |
6363 |
<p>Where <name> is an optional argument allowing to |
<p>Where <name> is an optional argument allowing to |
6364 |
assign a custom name to the new map. MIDI instrument Map |
assign a custom name to the new map. MIDI instrument Map |
6365 |
names do not have to be unique. |
names do not have to be unique, but MUST be encapsulated |
6366 |
|
into apostrophes and support escape sequences as described |
6367 |
|
in chapter "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>". |
6368 |
|
|
6369 |
</p> |
</p> |
6370 |
<p>Possible Answers: |
<p>Possible Answers: |
6371 |
</p> |
</p> |
6623 |
<blockquote class="text"> |
<blockquote class="text"> |
6624 |
<p>custom name of the given map, |
<p>custom name of the given map, |
6625 |
which does not have to be unique |
which does not have to be unique |
6626 |
|
(note that this character string may contain |
6627 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
6628 |
</p> |
</p> |
6629 |
</blockquote> |
</blockquote> |
6630 |
|
|
6680 |
</p> |
</p> |
6681 |
<p>Where <map> is the numerical ID of the map and |
<p>Where <map> is the numerical ID of the map and |
6682 |
<name> the new custom name of the map, which does not |
<name> the new custom name of the map, which does not |
6683 |
have to be unique. |
have to be unique (name MUST be encapsulated into apostrophes |
6684 |
|
and supports escape sequences as described in chapter |
6685 |
|
"<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>"). |
6686 |
|
|
6687 |
</p> |
</p> |
6688 |
<p>Possible Answers: |
<p>Possible Answers: |
6689 |
</p> |
</p> |
6848 |
load modes of entries, the frontend should retrieve the actual |
load modes of entries, the frontend should retrieve the actual |
6849 |
mode by i.e. sending |
mode by i.e. sending |
6850 |
<a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a> |
<a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a> |
6851 |
command(s). Finally the OPTIONAL <name> argument allows to |
command(s). Finally the OPTIONAL <name> argument allows to set a custom name |
6852 |
set a custom name (encapsulated into apostrophes) for the mapping |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
6853 |
entry, useful for frontends for displaying an appropriate name for |
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") for the |
6854 |
|
mapping entry, useful for frontends for displaying an appropriate name for |
6855 |
mapped instruments (using |
mapped instruments (using |
6856 |
<a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>). |
<a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>). |
6857 |
|
|
7173 |
changed with the |
changed with the |
7174 |
<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> |
7175 |
command and does not have to be unique. |
command and does not have to be unique. |
7176 |
|
(note that this character string may contain |
7177 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
7178 |
</p> |
</p> |
7179 |
</blockquote> |
</blockquote> |
7180 |
|
|
7191 |
<p>"INSTRUMENT_FILE" - |
<p>"INSTRUMENT_FILE" - |
7192 |
</p> |
</p> |
7193 |
<blockquote class="text"> |
<blockquote class="text"> |
7194 |
<p>File name of the instrument. |
<p>File name of the instrument |
7195 |
|
(note that this path may contain |
7196 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>). |
7197 |
</p> |
</p> |
7198 |
</blockquote> |
</blockquote> |
7199 |
|
|
7211 |
<blockquote class="text"> |
<blockquote class="text"> |
7212 |
<p>Name of the loaded instrument as reflected by its file. |
<p>Name of the loaded instrument as reflected by its file. |
7213 |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
7214 |
cannot be changed. |
cannot be changed (note that this character string may contain |
7215 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>). |
7216 |
</p> |
</p> |
7217 |
</blockquote> |
</blockquote> |
7218 |
|
|
8718 |
|
|
8719 |
</p> |
</p> |
8720 |
<p>Where <instr> is the absolute path name of the instrument and |
<p>Where <instr> is the absolute path name of the instrument and |
8721 |
<desc> is the new description for the instrument |
<desc> is the new description for the instrument |
8722 |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
8723 |
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
8724 |
</p> |
</p> |
9127 |
<p> |
<p> |
9128 |
</p> |
</p> |
9129 |
<blockquote class="text"> |
<blockquote class="text"> |
9130 |
<p>EDIT INSTRUMENT <sampler-channel> |
<p>EDIT CHANNEL INSTRUMENT <sampler-channel> |
9131 |
</p> |
</p> |
9132 |
</blockquote><p> |
</blockquote><p> |
9133 |
|
|
9194 |
<p> |
<p> |
9195 |
</p> |
</p> |
9196 |
<blockquote class="text"> |
<blockquote class="text"> |
9197 |
<p>C: "EDIT INSTRUMENT 0" |
<p>C: "EDIT CHANNEL INSTRUMENT 0" |
9198 |
</p> |
</p> |
9199 |
<p>S: "OK" |
<p>S: "OK" |
9200 |
</p> |
</p> |
9201 |
</blockquote><p> |
</blockquote><p> |
9202 |
|
|
9203 |
</p> |
</p> |
9204 |
|
<a name="file_management"></a><br /><hr /> |
9205 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9206 |
|
<a name="rfc.section.6.10"></a><h3>6.10. |
9207 |
|
Managing Files</h3> |
9208 |
|
|
9209 |
|
<p>You can query detailed informations about files located |
9210 |
|
at the same system where the sampler instance is running on. |
9211 |
|
Using this command set allows to retrieve file informations |
9212 |
|
even remotely from another machine. |
9213 |
|
</p> |
9214 |
|
<a name="GET FILE INSTRUMENTS"></a><br /><hr /> |
9215 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9216 |
|
<a name="rfc.section.6.10.1"></a><h3>6.10.1. |
9217 |
|
Retrieving amount of instruments of a file</h3> |
9218 |
|
|
9219 |
|
<p>The front-end can retrieve the amount of instruments |
9220 |
|
within a given instrument file by sending the |
9221 |
|
following command: |
9222 |
|
</p> |
9223 |
|
<p> |
9224 |
|
</p> |
9225 |
|
<blockquote class="text"> |
9226 |
|
<p>GET FILE INSTRUMENTS <filename> |
9227 |
|
</p> |
9228 |
|
</blockquote><p> |
9229 |
|
|
9230 |
|
</p> |
9231 |
|
<p>Where <filename> is the name of the instrument |
9232 |
|
file (encapsulated into apostrophes, supporting escape |
9233 |
|
sequences as described in chapter |
9234 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
9235 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
9236 |
|
</p> |
9237 |
|
<p>The sampler will try to ask all sampler engines, |
9238 |
|
whether they support the given file and ask the first |
9239 |
|
engine with a positive answer for the amount of |
9240 |
|
instruments. |
9241 |
|
</p> |
9242 |
|
<p>Possible Answers: |
9243 |
|
</p> |
9244 |
|
<p> |
9245 |
|
</p> |
9246 |
|
<blockquote class="text"> |
9247 |
|
<p>On success, the sampler will answer by |
9248 |
|
returning the amount of instruments. |
9249 |
|
|
9250 |
|
</p> |
9251 |
|
<p>"ERR:<error-code>:<error-message>" - |
9252 |
|
</p> |
9253 |
|
<blockquote class="text"> |
9254 |
|
<p>if the file could not be handled |
9255 |
|
</p> |
9256 |
|
</blockquote> |
9257 |
|
|
9258 |
|
|
9259 |
|
</blockquote><p> |
9260 |
|
|
9261 |
|
</p> |
9262 |
|
<p>Examples: |
9263 |
|
</p> |
9264 |
|
<p> |
9265 |
|
</p> |
9266 |
|
<blockquote class="text"> |
9267 |
|
<p>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'" |
9268 |
|
</p> |
9269 |
|
<p>S: "10" |
9270 |
|
</p> |
9271 |
|
</blockquote><p> |
9272 |
|
|
9273 |
|
</p> |
9274 |
|
<a name="LIST FILE INSTRUMENTS"></a><br /><hr /> |
9275 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9276 |
|
<a name="rfc.section.6.10.2"></a><h3>6.10.2. |
9277 |
|
Retrieving all instruments of a file</h3> |
9278 |
|
|
9279 |
|
<p>The front-end can retrieve a list of all instruments |
9280 |
|
within a given instrument file by sending the |
9281 |
|
following command: |
9282 |
|
</p> |
9283 |
|
<p> |
9284 |
|
</p> |
9285 |
|
<blockquote class="text"> |
9286 |
|
<p>LIST FILE INSTRUMENTS <filename> |
9287 |
|
</p> |
9288 |
|
</blockquote><p> |
9289 |
|
|
9290 |
|
</p> |
9291 |
|
<p>Where <filename> is the name of the instrument |
9292 |
|
file (encapsulated into apostrophes, supporting escape |
9293 |
|
sequences as described in chapter |
9294 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
9295 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
9296 |
|
</p> |
9297 |
|
<p>The sampler will try to ask all sampler engines, |
9298 |
|
whether they support the given file and ask the first |
9299 |
|
engine with a positive answer for a list of IDs for the |
9300 |
|
instruments in the given file. |
9301 |
|
</p> |
9302 |
|
<p>Possible Answers: |
9303 |
|
</p> |
9304 |
|
<p> |
9305 |
|
</p> |
9306 |
|
<blockquote class="text"> |
9307 |
|
<p>On success, the sampler will answer by |
9308 |
|
returning a comma separated list of |
9309 |
|
instrument IDs. |
9310 |
|
|
9311 |
|
</p> |
9312 |
|
<p>"ERR:<error-code>:<error-message>" - |
9313 |
|
</p> |
9314 |
|
<blockquote class="text"> |
9315 |
|
<p>if the file could not be handled |
9316 |
|
</p> |
9317 |
|
</blockquote> |
9318 |
|
|
9319 |
|
|
9320 |
|
</blockquote><p> |
9321 |
|
|
9322 |
|
</p> |
9323 |
|
<p>Examples: |
9324 |
|
</p> |
9325 |
|
<p> |
9326 |
|
</p> |
9327 |
|
<blockquote class="text"> |
9328 |
|
<p>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'" |
9329 |
|
</p> |
9330 |
|
<p>S: "0,1,2,3,4,5,6,7,8,9" |
9331 |
|
</p> |
9332 |
|
</blockquote><p> |
9333 |
|
|
9334 |
|
</p> |
9335 |
|
<a name="GET FILE INSTRUMENT INFO"></a><br /><hr /> |
9336 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9337 |
|
<a name="rfc.section.6.10.3"></a><h3>6.10.3. |
9338 |
|
Retrieving informations about one instrument in a file</h3> |
9339 |
|
|
9340 |
|
<p>The front-end can retrieve detailed informations |
9341 |
|
about a specific instrument within a given instrument |
9342 |
|
file by sending the following command: |
9343 |
|
</p> |
9344 |
|
<p> |
9345 |
|
</p> |
9346 |
|
<blockquote class="text"> |
9347 |
|
<p>GET FILE INSTRUMENT INFO <filename> |
9348 |
|
<instr-id> |
9349 |
|
</p> |
9350 |
|
</blockquote><p> |
9351 |
|
|
9352 |
|
</p> |
9353 |
|
<p>Where <filename> is the name of the instrument |
9354 |
|
file (encapsulated into apostrophes, supporting escape |
9355 |
|
sequences as described in chapter |
9356 |
|
"<a class='info' href='#character_set'>Character Set and Escape |
9357 |
|
Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") and <instr-id> is the numeric |
9358 |
|
instrument ID as returned by the |
9359 |
|
<a class='info' href='#LIST FILE INSTRUMENTS'>"LIST FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving all instruments of a file</span><span>)</span></a> command. |
9360 |
|
</p> |
9361 |
|
<p>The sampler will try to ask all sampler engines, |
9362 |
|
whether they support the given file and ask the first |
9363 |
|
engine with a positive answer for informations about the |
9364 |
|
specific instrument in the given file. |
9365 |
|
</p> |
9366 |
|
<p>Possible Answers: |
9367 |
|
</p> |
9368 |
|
<p> |
9369 |
|
</p> |
9370 |
|
<blockquote class="text"> |
9371 |
|
<p>LinuxSampler will answer by sending a <CRLF> separated list. |
9372 |
|
Each answer line begins with the settings category name |
9373 |
|
followed by a colon and then a space character <SP> and finally |
9374 |
|
the info character string to that setting category. At the |
9375 |
|
moment the following categories are defined: |
9376 |
|
</p> |
9377 |
|
<p> |
9378 |
|
</p> |
9379 |
|
<blockquote class="text"> |
9380 |
|
<p>NAME - |
9381 |
|
</p> |
9382 |
|
<blockquote class="text"> |
9383 |
|
<p>name of the instrument as |
9384 |
|
stored in the instrument file |
9385 |
|
</p> |
9386 |
|
</blockquote> |
9387 |
|
|
9388 |
|
|
9389 |
|
<p>FORMAT_FAMILY - |
9390 |
|
</p> |
9391 |
|
<blockquote class="text"> |
9392 |
|
<p>name of the sampler format |
9393 |
|
of the given instrument |
9394 |
|
</p> |
9395 |
|
</blockquote> |
9396 |
|
|
9397 |
|
|
9398 |
|
<p>FORMAT_VERSION - |
9399 |
|
</p> |
9400 |
|
<blockquote class="text"> |
9401 |
|
<p>version of the sampler format |
9402 |
|
the instrumen is stored as |
9403 |
|
</p> |
9404 |
|
</blockquote> |
9405 |
|
|
9406 |
|
|
9407 |
|
<p>PRODUCT - |
9408 |
|
</p> |
9409 |
|
<blockquote class="text"> |
9410 |
|
<p>official product name of the |
9411 |
|
instrument as stored in the file |
9412 |
|
|
9413 |
|
</p> |
9414 |
|
</blockquote> |
9415 |
|
|
9416 |
|
|
9417 |
|
<p>ARTISTS - |
9418 |
|
</p> |
9419 |
|
<blockquote class="text"> |
9420 |
|
<p>artists / sample library |
9421 |
|
vendor of the instrument |
9422 |
|
</p> |
9423 |
|
</blockquote> |
9424 |
|
|
9425 |
|
|
9426 |
|
</blockquote> |
9427 |
|
|
9428 |
|
|
9429 |
|
</blockquote><p> |
9430 |
|
|
9431 |
|
</p> |
9432 |
|
<p>The mentioned fields above don't have to be in particular order. |
9433 |
|
</p> |
9434 |
|
<p>Example: |
9435 |
|
</p> |
9436 |
|
<p> |
9437 |
|
</p> |
9438 |
|
<blockquote class="text"> |
9439 |
|
<p>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0" |
9440 |
|
</p> |
9441 |
|
<p>S: "NAME: Lunatic Loops" |
9442 |
|
</p> |
9443 |
|
<p> "FORMAT_FAMILY: GIG" |
9444 |
|
</p> |
9445 |
|
<p> "FORMAT_VERSION: 3" |
9446 |
|
</p> |
9447 |
|
<p> "PRODUCT: The Backbone Bongo Beats" |
9448 |
|
</p> |
9449 |
|
<p> "ARTISTS: Jimmy the Fish" |
9450 |
|
</p> |
9451 |
|
<p> "." |
9452 |
|
</p> |
9453 |
|
</blockquote><p> |
9454 |
|
|
9455 |
|
</p> |
9456 |
<a name="command_syntax"></a><br /><hr /> |
<a name="command_syntax"></a><br /><hr /> |
9457 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
9458 |
<a name="rfc.section.7"></a><h3>7. |
<a name="rfc.section.7"></a><h3>7. |
9685 |
<p>/ MISCELLANEOUS |
<p>/ MISCELLANEOUS |
9686 |
|
|
9687 |
</p> |
</p> |
9688 |
|
<p>/ TOTAL_STREAM_COUNT |
9689 |
|
|
9690 |
|
</p> |
9691 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
9692 |
|
|
9693 |
</p> |
</p> |
9763 |
<p>/ MISCELLANEOUS |
<p>/ MISCELLANEOUS |
9764 |
|
|
9765 |
</p> |
</p> |
9766 |
|
<p>/ TOTAL_STREAM_COUNT |
9767 |
|
|
9768 |
|
</p> |
9769 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
9770 |
|
|
9771 |
</p> |
</p> |
9901 |
<p>/ SERVER SP INFO |
<p>/ SERVER SP INFO |
9902 |
|
|
9903 |
</p> |
</p> |
9904 |
|
<p>/ TOTAL_STREAM_COUNT |
9905 |
|
|
9906 |
|
</p> |
9907 |
<p>/ TOTAL_VOICE_COUNT |
<p>/ TOTAL_VOICE_COUNT |
9908 |
|
|
9909 |
</p> |
</p> |
9955 |
<p>/ VOLUME |
<p>/ VOLUME |
9956 |
|
|
9957 |
</p> |
</p> |
9958 |
|
<p>/ FILE SP INSTRUMENTS SP filename |
9959 |
|
|
9960 |
|
</p> |
9961 |
|
<p>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
9962 |
|
|
9963 |
|
</p> |
9964 |
</blockquote><p> |
</blockquote><p> |
9965 |
|
|
9966 |
</p> |
</p> |
10186 |
<p>edit_instruction = |
<p>edit_instruction = |
10187 |
</p> |
</p> |
10188 |
<blockquote class="text"> |
<blockquote class="text"> |
10189 |
<p>INSTRUMENT SP sampler_channel |
<p>CHANNEL SP INSTRUMENT SP sampler_channel |
10190 |
|
|
10191 |
</p> |
</p> |
10192 |
</blockquote><p> |
</blockquote><p> |
10282 |
<p>/ DB_INSTRUMENTS SP db_path |
<p>/ DB_INSTRUMENTS SP db_path |
10283 |
|
|
10284 |
</p> |
</p> |
10285 |
|
<p>/ FILE SP INSTRUMENTS SP filename |
10286 |
|
|
10287 |
|
</p> |
10288 |
</blockquote><p> |
</blockquote><p> |
10289 |
|
|
10290 |
</p> |
</p> |
10486 |
<p>map_name = |
<p>map_name = |
10487 |
</p> |
</p> |
10488 |
<blockquote class="text"> |
<blockquote class="text"> |
10489 |
<p>stringval |
<p>stringval_escaped |
10490 |
|
|
10491 |
</p> |
</p> |
10492 |
</blockquote><p> |
</blockquote><p> |
10495 |
<p>entry_name = |
<p>entry_name = |
10496 |
</p> |
</p> |
10497 |
<blockquote class="text"> |
<blockquote class="text"> |
10498 |
<p>stringval |
<p>stringval_escaped |
10499 |
|
|
10500 |
</p> |
</p> |
10501 |
</blockquote><p> |
</blockquote><p> |
10504 |
<p>fx_send_name = |
<p>fx_send_name = |
10505 |
</p> |
</p> |
10506 |
<blockquote class="text"> |
<blockquote class="text"> |
10507 |
<p>stringval |
<p>stringval_escaped |
10508 |
|
|
10509 |
</p> |
</p> |
10510 |
</blockquote><p> |
</blockquote><p> |
10555 |
<p>query_val = |
<p>query_val = |
10556 |
</p> |
</p> |
10557 |
<blockquote class="text"> |
<blockquote class="text"> |
10558 |
<p>textval_escaped |
<p>text_escaped |
10559 |
|
|
10560 |
</p> |
</p> |
10561 |
<p>/ stringval_escaped |
<p>/ stringval_escaped |
10645 |
MUST be escaped as well (that is as double backslash), whereas |
MUST be escaped as well (that is as double backslash), whereas |
10646 |
in the old versions a single backslash was sufficient. |
in the old versions a single backslash was sufficient. |
10647 |
</p> |
</p> |
10648 |
|
<p>The following LSCP commands support escape sequences as part |
10649 |
|
of their filename / path based arguments and / or may contain |
10650 |
|
a filename / path with escape sequences in their response: |
10651 |
|
</p> |
10652 |
|
<blockquote class="text"> |
10653 |
|
<p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a> |
10654 |
|
</p> |
10655 |
|
<p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a> |
10656 |
|
</p> |
10657 |
|
<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> |
10658 |
|
</p> |
10659 |
|
<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> |
10660 |
|
</p> |
10661 |
|
<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> |
10662 |
|
</p> |
10663 |
|
<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> |
10664 |
|
</p> |
10665 |
|
<p><a class='info' href='#REMOVE DB_INSTRUMENT_DIRECTORY'>"REMOVE DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Deleting an instrument directory</span><span>)</span></a> |
10666 |
|
</p> |
10667 |
|
<p><a class='info' href='#REMOVE DB_INSTRUMENT'>"REMOVE DB_INSTRUMENT"<span> (</span><span class='info'>Removing an instrument</span><span>)</span></a> |
10668 |
|
</p> |
10669 |
|
<p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORIES'>"GET DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Getting amount of instrument directories</span><span>)</span></a> |
10670 |
|
</p> |
10671 |
|
<p><a class='info' href='#LIST DB_INSTRUMENT_DIRECTORIES'>"LIST DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Listing all directories in specific directory</span><span>)</span></a> |
10672 |
|
</p> |
10673 |
|
<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> |
10674 |
|
</p> |
10675 |
|
<p><a class='info' href='#GET DB_INSTRUMENTS'>"GET DB_INSTRUMENTS"<span> (</span><span class='info'>Getting amount of instruments</span><span>)</span></a> |
10676 |
|
</p> |
10677 |
|
<p><a class='info' href='#LIST DB_INSTRUMENTS'>"LIST DB_INSTRUMENTS"<span> (</span><span class='info'>Listing all instruments in specific directory</span><span>)</span></a> |
10678 |
|
</p> |
10679 |
|
<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> |
10680 |
|
</p> |
10681 |
|
<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> |
10682 |
|
</p> |
10683 |
|
<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> |
10684 |
|
</p> |
10685 |
|
<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> |
10686 |
|
</p> |
10687 |
|
<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> |
10688 |
|
</p> |
10689 |
|
<p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a> |
10690 |
|
</p> |
10691 |
|
<p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a> |
10692 |
|
</p> |
10693 |
|
<p><a class='info' href='#MOVE DB_INSTRUMENT'>"MOVE DB_INSTRUMENT"<span> (</span><span class='info'>Moving an instrument</span><span>)</span></a> |
10694 |
|
</p> |
10695 |
|
<p><a class='info' href='#MOVE DB_INSTRUMENT_DIRECTORY'>"MOVE DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Moving an instrument directory</span><span>)</span></a> |
10696 |
|
</p> |
10697 |
|
<p><a class='info' href='#COPY DB_INSTRUMENT'>"COPY DB_INSTRUMENT"<span> (</span><span class='info'>Copying instruments</span><span>)</span></a> |
10698 |
|
</p> |
10699 |
|
<p><a class='info' href='#COPY DB_INSTRUMENT_DIRECTORY'>"COPY DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Copying instrument directories</span><span>)</span></a> |
10700 |
|
</p> |
10701 |
|
<p><a class='info' href='#GET FILE INSTRUMENTS'>"GET FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving amount of instruments of a file</span><span>)</span></a> |
10702 |
|
</p> |
10703 |
|
<p><a class='info' href='#LIST FILE INSTRUMENTS'>"LIST FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving all instruments of a file</span><span>)</span></a> |
10704 |
|
</p> |
10705 |
|
<p><a class='info' href='#GET FILE INSTRUMENT INFO'>"GET FILE INSTRUMENT INFO"<span> (</span><span class='info'>Retrieving informations about one instrument in a file</span><span>)</span></a> |
10706 |
|
</p> |
10707 |
|
</blockquote><p> |
10708 |
|
Note that the forward slash character ('/') has a special meaning in |
10709 |
|
filename / path based arguments: it acts as separator of the nodes in |
10710 |
|
the path, thus if a directory- or filename includes a forward slash |
10711 |
|
(not intended as path node separator), you MUST escape that slash |
10712 |
|
either with the respective hex escape sequence ("\x2f") or with the |
10713 |
|
respective octal escape sequence ("\057"). |
10714 |
|
|
10715 |
|
</p> |
10716 |
|
<p> |
10717 |
|
Note for Windows: file path arguments in LSCP are expected |
10718 |
|
to use forward slashes as directory node separator similar |
10719 |
|
to Unix based operating systems. In contrast to Unix however |
10720 |
|
a Windows typical drive character is expected to be |
10721 |
|
prefixed to the path. That is an original Windows file path |
10722 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
10723 |
|
"D:/Sounds/My.gig". |
10724 |
|
|
10725 |
|
</p> |
10726 |
|
<p> |
10727 |
|
The following LSCP commands even support escape sequences as |
10728 |
|
part of at least one of their text-based arguments (i.e. entity name, |
10729 |
|
description) and / or may contain escape sequences in at least one of |
10730 |
|
their text-based fields in their response: |
10731 |
|
</p> |
10732 |
|
<blockquote class="text"> |
10733 |
|
<p><a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a> |
10734 |
|
</p> |
10735 |
|
<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> |
10736 |
|
</p> |
10737 |
|
<p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a> |
10738 |
|
</p> |
10739 |
|
<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> |
10740 |
|
</p> |
10741 |
|
<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> |
10742 |
|
</p> |
10743 |
|
<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> |
10744 |
|
</p> |
10745 |
|
<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> |
10746 |
|
</p> |
10747 |
|
<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> |
10748 |
|
</p> |
10749 |
|
<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> |
10750 |
|
</p> |
10751 |
|
<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> |
10752 |
|
</p> |
10753 |
|
<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> |
10754 |
|
</p> |
10755 |
|
<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> |
10756 |
|
</p> |
10757 |
|
<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> |
10758 |
|
</p> |
10759 |
|
<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> |
10760 |
|
</p> |
10761 |
|
<p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a> |
10762 |
|
</p> |
10763 |
|
<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> |
10764 |
|
</p> |
10765 |
|
<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> |
10766 |
|
</p> |
10767 |
|
<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> |
10768 |
|
</p> |
10769 |
|
<p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a> |
10770 |
|
</p> |
10771 |
|
</blockquote><p> |
10772 |
|
Please note that these lists are manually maintained. If you |
10773 |
|
find a command that also supports escape sequences we forgot to |
10774 |
|
mention here, please report it! |
10775 |
|
|
10776 |
|
</p> |
10777 |
<a name="events"></a><br /><hr /> |
<a name="events"></a><br /><hr /> |
10778 |
<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> |
10779 |
<a name="rfc.section.8"></a><h3>8. |
<a name="rfc.section.8"></a><h3>8. |
11147 |
<p>where <voices> will be replaced by the new number of |
<p>where <voices> will be replaced by the new number of |
11148 |
all currently active voices. |
all currently active voices. |
11149 |
</p> |
</p> |
11150 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE TOTAL_STREAM_COUNT"></a><br /><hr /> |
11151 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11152 |
<a name="rfc.section.8.13"></a><h3>8.13. |
<a name="rfc.section.8.13"></a><h3>8.13. |
11153 |
|
Total number of active disk streams changed</h3> |
11154 |
|
|
11155 |
|
<p>Client may want to be notified when the total number of disk streams on the |
11156 |
|
back-end changes by issuing the following command: |
11157 |
|
</p> |
11158 |
|
<p> |
11159 |
|
</p> |
11160 |
|
<blockquote class="text"> |
11161 |
|
<p>SUBSCRIBE TOTAL_STREAM_COUNT |
11162 |
|
</p> |
11163 |
|
</blockquote><p> |
11164 |
|
|
11165 |
|
</p> |
11166 |
|
<p>Server will start sending the following notification messages: |
11167 |
|
</p> |
11168 |
|
<p> |
11169 |
|
</p> |
11170 |
|
<blockquote class="text"> |
11171 |
|
<p>"NOTIFY:TOTAL_STREAM_COUNT:<streams>" |
11172 |
|
</p> |
11173 |
|
</blockquote><p> |
11174 |
|
|
11175 |
|
</p> |
11176 |
|
<p>where <streams> will be replaced by the new number of |
11177 |
|
all currently active disk streams. |
11178 |
|
</p> |
11179 |
|
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr /> |
11180 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11181 |
|
<a name="rfc.section.8.14"></a><h3>8.14. |
11182 |
Number of MIDI instrument maps changed</h3> |
Number of MIDI instrument maps changed</h3> |
11183 |
|
|
11184 |
<p>Client may want to be notified when the number of MIDI instrument maps on the |
<p>Client may want to be notified when the number of MIDI instrument maps on the |
11207 |
</p> |
</p> |
11208 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr /> |
11209 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11210 |
<a name="rfc.section.8.14"></a><h3>8.14. |
<a name="rfc.section.8.15"></a><h3>8.15. |
11211 |
MIDI instrument map information changed</h3> |
MIDI instrument map information changed</h3> |
11212 |
|
|
11213 |
<p>Client may want to be notified when changes were made to MIDI instrument maps on the |
<p>Client may want to be notified when changes were made to MIDI instrument maps on the |
11240 |
</p> |
</p> |
11241 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr /> |
11242 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11243 |
<a name="rfc.section.8.15"></a><h3>8.15. |
<a name="rfc.section.8.16"></a><h3>8.16. |
11244 |
Number of MIDI instruments changed</h3> |
Number of MIDI instruments changed</h3> |
11245 |
|
|
11246 |
<p>Client may want to be notified when the number of MIDI instrument maps on the |
<p>Client may want to be notified when the number of MIDI instrument maps on the |
11270 |
</p> |
</p> |
11271 |
<a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr /> |
11272 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11273 |
<a name="rfc.section.8.16"></a><h3>8.16. |
<a name="rfc.section.8.17"></a><h3>8.17. |
11274 |
MIDI instrument information changed</h3> |
MIDI instrument information changed</h3> |
11275 |
|
|
11276 |
<p>Client may want to be notified when changes were made to MIDI instruments on the |
<p>Client may want to be notified when changes were made to MIDI instruments on the |
11304 |
</p> |
</p> |
11305 |
<a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr /> |
11306 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11307 |
<a name="rfc.section.8.17"></a><h3>8.17. |
<a name="rfc.section.8.18"></a><h3>8.18. |
11308 |
Global settings changed</h3> |
Global settings changed</h3> |
11309 |
|
|
11310 |
<p>Client may want to be notified when changes to the global settings |
<p>Client may want to be notified when changes to the global settings |
11333 |
</p> |
</p> |
11334 |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
11335 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11336 |
<a name="rfc.section.8.18"></a><h3>8.18. |
<a name="rfc.section.8.19"></a><h3>8.19. |
11337 |
Number of database instrument directories changed</h3> |
Number of database instrument directories changed</h3> |
11338 |
|
|
11339 |
<p>Client may want to be notified when the number of instrument |
<p>Client may want to be notified when the number of instrument |
11367 |
</p> |
</p> |
11368 |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr /> |
11369 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11370 |
<a name="rfc.section.8.19"></a><h3>8.19. |
<a name="rfc.section.8.20"></a><h3>8.20. |
11371 |
Database instrument directory information changed</h3> |
Database instrument directory information changed</h3> |
11372 |
|
|
11373 |
<p>Client may want to be notified when changes were made to directories |
<p>Client may want to be notified when changes were made to directories |
11412 |
</p> |
</p> |
11413 |
<a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr /> |
11414 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11415 |
<a name="rfc.section.8.20"></a><h3>8.20. |
<a name="rfc.section.8.21"></a><h3>8.21. |
11416 |
Number of database instruments changed</h3> |
Number of database instruments changed</h3> |
11417 |
|
|
11418 |
<p>Client may want to be notified when the number of instruments |
<p>Client may want to be notified when the number of instruments |
11446 |
</p> |
</p> |
11447 |
<a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr /> |
11448 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11449 |
<a name="rfc.section.8.21"></a><h3>8.21. |
<a name="rfc.section.8.22"></a><h3>8.22. |
11450 |
Database instrument information changed</h3> |
Database instrument information changed</h3> |
11451 |
|
|
11452 |
<p>Client may want to be notified when changes were made to instruments |
<p>Client may want to be notified when changes were made to instruments |
11491 |
</p> |
</p> |
11492 |
<a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr /> |
11493 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11494 |
<a name="rfc.section.8.22"></a><h3>8.22. |
<a name="rfc.section.8.23"></a><h3>8.23. |
11495 |
Database job status information changed</h3> |
Database job status information changed</h3> |
11496 |
|
|
11497 |
<p>Client may want to be notified when the status of particular database |
<p>Client may want to be notified when the status of particular database |
11524 |
</p> |
</p> |
11525 |
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr /> |
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr /> |
11526 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
11527 |
<a name="rfc.section.8.23"></a><h3>8.23. |
<a name="rfc.section.8.24"></a><h3>8.24. |
11528 |
Miscellaneous and debugging events</h3> |
Miscellaneous and debugging events</h3> |
11529 |
|
|
11530 |
<p>Client may want to be notified of miscellaneous and debugging events occurring at |
<p>Client may want to be notified of miscellaneous and debugging events occurring at |