| 16 |
to an annoying "missing Normative/Informative References" error message --> |
to an annoying "missing Normative/Informative References" error message --> |
| 17 |
<?rfc strict="no" ?> |
<?rfc strict="no" ?> |
| 18 |
|
|
| 19 |
<rfc category="std" ipr="full3978" docName="LSCP 1.2"> |
<rfc category="std" ipr="full3978" docName="LSCP 1.4"> |
| 20 |
<front> |
<front> |
| 21 |
<title>LinuxSampler Control Protocol</title> |
<title>LinuxSampler Control Protocol</title> |
| 22 |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
| 34 |
<email>schoenebeck at software minus engineering dot org</email> |
<email>schoenebeck at software minus engineering dot org</email> |
| 35 |
</address> |
</address> |
| 36 |
</author> |
</author> |
| 37 |
<date month="April" year="2007"/> |
<date month="February" year="2008"/> |
| 38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
| 39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
| 40 |
<abstract> |
<abstract> |
| 61 |
(front-end) and server (LinuxSampler) respectively. Lines in |
(front-end) and server (LinuxSampler) respectively. Lines in |
| 62 |
examples must be interpreted as every line being CRLF |
examples must be interpreted as every line being CRLF |
| 63 |
terminated (carriage return character followed by line feed |
terminated (carriage return character followed by line feed |
| 64 |
character as defined in the ASCII standard), thus the following |
character as defined in the ASCII standard <xref target="RFC20"/>), |
| 65 |
example:</t> |
thus the following example:</t> |
| 66 |
|
|
| 67 |
<t> |
<t> |
| 68 |
<list> |
<list> |
| 2061 |
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
| 2062 |
command, <port> by the MIDI port number, <key> by the name of |
command, <port> by the MIDI port number, <key> by the name of |
| 2063 |
the parameter to change and <value> by the new value for this |
the parameter to change and <value> by the new value for this |
| 2064 |
parameter.</t> |
parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes) |
| 2065 |
|
for specifying no value for parameters allowing a list of values.</t> |
| 2066 |
|
|
| 2067 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 2068 |
<t> |
<t> |
| 2089 |
<t>Example:</t> |
<t>Example:</t> |
| 2090 |
<t> |
<t> |
| 2091 |
<list> |
<list> |
| 2092 |
<t></t> |
<t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"</t> |
| 2093 |
|
<t>S: "OK"</t> |
| 2094 |
|
</list> |
| 2095 |
|
</t> |
| 2096 |
|
<t> |
| 2097 |
|
<list> |
| 2098 |
|
<t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"</t> |
| 2099 |
|
<t>S: "OK"</t> |
| 2100 |
</list> |
</list> |
| 2101 |
</t> |
</t> |
| 2102 |
</section> |
</section> |
| 2121 |
number of the sampler channel the instrument should be assigned to. |
number of the sampler channel the instrument should be assigned to. |
| 2122 |
Each sampler channel can only have one instrument.</t> |
Each sampler channel can only have one instrument.</t> |
| 2123 |
|
|
| 2124 |
|
<t>Notice: since LSCP 1.2 the <filename> argument supports |
| 2125 |
|
escape characters for special characters (see chapter |
| 2126 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>" |
| 2127 |
|
for details) and accordingly backslash characters in the filename |
| 2128 |
|
MUST now be escaped as well!</t> |
| 2129 |
|
|
| 2130 |
<t>The difference between regular and NON_MODAL versions of the command |
<t>The difference between regular and NON_MODAL versions of the command |
| 2131 |
is that the regular command returns OK only after the instrument has been |
is that the regular command returns OK only after the instrument has been |
| 2132 |
fully loaded and the channel is ready to be used while NON_MODAL version |
fully loaded and the channel is ready to be used while NON_MODAL version |
| 2162 |
</t> |
</t> |
| 2163 |
</list> |
</list> |
| 2164 |
</t> |
</t> |
| 2165 |
<t>Example:</t> |
<t>Example (Unix):</t> |
| 2166 |
<t> |
<t> |
| 2167 |
<list> |
<list> |
| 2168 |
<t></t> |
<t>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0</t> |
| 2169 |
|
<t>S: OK</t> |
| 2170 |
|
</list> |
| 2171 |
|
</t> |
| 2172 |
|
<t>Example (Windows):</t> |
| 2173 |
|
<t> |
| 2174 |
|
<list> |
| 2175 |
|
<t>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0</t> |
| 2176 |
|
<t>S: OK</t> |
| 2177 |
</list> |
</list> |
| 2178 |
</t> |
</t> |
| 2179 |
</section> |
</section> |
| 2451 |
<list> |
<list> |
| 2452 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
| 2453 |
<list> |
<list> |
| 2454 |
<t>arbitrary description text about the engine</t> |
<t>arbitrary description text about the engine |
| 2455 |
|
(note that the character string may contain |
| 2456 |
|
<xref target="character_set">escape sequences</xref>)</t> |
| 2457 |
</list> |
</list> |
| 2458 |
</t> |
</t> |
| 2459 |
<t>VERSION - |
<t>VERSION - |
| 2537 |
<list> |
<list> |
| 2538 |
<t>the file name of the loaded instrument, "NONE" if |
<t>the file name of the loaded instrument, "NONE" if |
| 2539 |
there's no instrument yet loaded for this sampler |
there's no instrument yet loaded for this sampler |
| 2540 |
channel</t> |
channel (note: since LSCP 1.2 this path may contain |
| 2541 |
|
<xref target="character_set">escape sequences</xref>)</t> |
| 2542 |
</list> |
</list> |
| 2543 |
</t> |
</t> |
| 2544 |
<t>INSTRUMENT_NR - |
<t>INSTRUMENT_NR - |
| 2548 |
</t> |
</t> |
| 2549 |
<t>INSTRUMENT_NAME - |
<t>INSTRUMENT_NAME - |
| 2550 |
<list> |
<list> |
| 2551 |
<t>the instrument name of the loaded instrument</t> |
<t>the instrument name of the loaded instrument |
| 2552 |
|
(note: since LSCP 1.2 this character string may contain |
| 2553 |
|
<xref target="character_set">escape sequences</xref>)</t> |
| 2554 |
</list> |
</list> |
| 2555 |
</t> |
</t> |
| 2556 |
<t>INSTRUMENT_STATUS - |
<t>INSTRUMENT_STATUS - |
| 3268 |
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> |
| 3269 |
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 |
| 3270 |
effect send level and <name> is an optional argument defining a name |
effect send level and <name> is an optional argument defining a name |
| 3271 |
for the effect send entity. The name does not have to be unique.</t> |
for the effect send entity. The name does not have to be unique, but MUST be |
| 3272 |
|
encapsulated into apostrophes and supports escape sequences as described in chapter |
| 3273 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>".</t> |
| 3274 |
|
|
| 3275 |
<t>By default, that is as initial routing, the effect send's audio channels |
<t>By default, that is as initial routing, the effect send's audio channels |
| 3276 |
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 |
| 3460 |
<list> |
<list> |
| 3461 |
<t>NAME - |
<t>NAME - |
| 3462 |
<list> |
<list> |
| 3463 |
<t>name of the effect send entity</t> |
<t>name of the effect send entity |
| 3464 |
|
(note that this character string may contain |
| 3465 |
|
<xref target="character_set">escape sequences</xref>)</t> |
| 3466 |
</list> |
</list> |
| 3467 |
</t> |
</t> |
| 3468 |
<t>MIDI_CONTROLLER - |
<t>MIDI_CONTROLLER - |
| 3525 |
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
| 3526 |
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
| 3527 |
<name> is the new name of the effect send entity, which |
<name> is the new name of the effect send entity, which |
| 3528 |
does not have to be unique.</t> |
does not have to be unique (name MUST be encapsulated into apostrophes |
| 3529 |
|
and supports escape sequences as described in chapter |
| 3530 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"). |
| 3531 |
|
</t> |
| 3532 |
|
|
| 3533 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 3534 |
<t> |
<t> |
| 3932 |
</t> |
</t> |
| 3933 |
</section> |
</section> |
| 3934 |
|
|
| 3935 |
|
<section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT"> |
| 3936 |
|
<t>The front-end can ask for the current number of active disk streams on |
| 3937 |
|
the sampler by sending the following command:</t> |
| 3938 |
|
<t> |
| 3939 |
|
<list> |
| 3940 |
|
<t>GET TOTAL_STREAM_COUNT</t> |
| 3941 |
|
</list> |
| 3942 |
|
</t> |
| 3943 |
|
|
| 3944 |
|
<t>Possible Answers:</t> |
| 3945 |
|
<t> |
| 3946 |
|
<list> |
| 3947 |
|
<t>LinuxSampler will answer by returning the number of all active |
| 3948 |
|
disk streams on the sampler.</t> |
| 3949 |
|
</list> |
| 3950 |
|
</t> |
| 3951 |
|
</section> |
| 3952 |
|
|
| 3953 |
<section title="Reset sampler" anchor="RESET"> |
<section title="Reset sampler" anchor="RESET"> |
| 3954 |
<t>The front-end can reset the whole sampler by sending the following command:</t> |
<t>The front-end can reset the whole sampler by sending the following command:</t> |
| 3955 |
<t> |
<t> |
| 3997 |
<list> |
<list> |
| 3998 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
| 3999 |
<list> |
<list> |
| 4000 |
<t>arbitrary textual description about the sampler</t> |
<t>arbitrary textual description about the sampler |
| 4001 |
|
(note that the character string may contain |
| 4002 |
|
<xref target="character_set">escape sequences</xref>)</t> |
| 4003 |
</list> |
</list> |
| 4004 |
</t> |
</t> |
| 4005 |
<t>VERSION - |
<t>VERSION - |
| 4115 |
cause the sampler to switch to the respective instrument as |
cause the sampler to switch to the respective instrument as |
| 4116 |
reflected by the current MIDI instrument map.</t> |
reflected by the current MIDI instrument map.</t> |
| 4117 |
|
|
| 4118 |
<section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT MAP"> |
<section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT_MAP"> |
| 4119 |
<t>The front-end can add a new MIDI instrument map by sending |
<t>The front-end can add a new MIDI instrument map by sending |
| 4120 |
the following command:</t> |
the following command:</t> |
| 4121 |
<t> |
<t> |
| 4125 |
</t> |
</t> |
| 4126 |
<t>Where <name> is an optional argument allowing to |
<t>Where <name> is an optional argument allowing to |
| 4127 |
assign a custom name to the new map. MIDI instrument Map |
assign a custom name to the new map. MIDI instrument Map |
| 4128 |
names do not have to be unique.</t> |
names do not have to be unique, but MUST be encapsulated |
| 4129 |
|
into apostrophes and support escape sequences as described |
| 4130 |
|
in chapter "<xref target="character_set">Character Set and Escape Sequences</xref>". |
| 4131 |
|
</t> |
| 4132 |
|
|
| 4133 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 4134 |
<t> |
<t> |
| 4299 |
<t>NAME - |
<t>NAME - |
| 4300 |
<list> |
<list> |
| 4301 |
<t>custom name of the given map, |
<t>custom name of the given map, |
| 4302 |
which does not have to be unique</t> |
which does not have to be unique |
| 4303 |
|
(note that this character string may contain |
| 4304 |
|
<xref target="character_set">escape sequences</xref>)</t> |
| 4305 |
</list> |
</list> |
| 4306 |
</t> |
</t> |
| 4307 |
<t>DEFAULT - |
<t>DEFAULT - |
| 4337 |
</t> |
</t> |
| 4338 |
<t>Where <map> is the numerical ID of the map and |
<t>Where <map> is the numerical ID of the map and |
| 4339 |
<name> the new custom name of the map, which does not |
<name> the new custom name of the map, which does not |
| 4340 |
have to be unique.</t> |
have to be unique (name MUST be encapsulated into apostrophes |
| 4341 |
|
and supports escape sequences as described in chapter |
| 4342 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"). |
| 4343 |
|
</t> |
| 4344 |
|
|
| 4345 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 4346 |
<t> |
<t> |
| 4387 |
index, <engine_name> a sampler engine name as returned by |
index, <engine_name> a sampler engine name as returned by |
| 4388 |
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
| 4389 |
command (not encapsulated into apostrophes), <filename> the name |
command (not encapsulated into apostrophes), <filename> the name |
| 4390 |
of the instrument's file to be deployed (encapsulated into apostrophes), |
of the instrument's file to be deployed (encapsulated into apostrophes, |
| 4391 |
|
supporting escape sequences as described in chapter |
| 4392 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"), |
| 4393 |
<instrument_index> the index (integer value) of the instrument |
<instrument_index> the index (integer value) of the instrument |
| 4394 |
within the given file, <volume_value> reflects the master |
within the given file, <volume_value> reflects the master |
| 4395 |
volume of the instrument as optionally dotted number (where a |
volume of the instrument as optionally dotted number (where a |
| 4471 |
load modes of entries, the frontend should retrieve the actual |
load modes of entries, the frontend should retrieve the actual |
| 4472 |
mode by i.e. sending |
mode by i.e. sending |
| 4473 |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
| 4474 |
command(s). Finally the OPTIONAL <name> argument allows to |
command(s). Finally the OPTIONAL <name> argument allows to set a custom name |
| 4475 |
set a custom name (encapsulated into apostrophes) for the mapping |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
| 4476 |
entry, useful for frontends for displaying an appropriate name for |
"<xref target="character_set">Character Set and Escape Sequences</xref>") for the |
| 4477 |
|
mapping entry, useful for frontends for displaying an appropriate name for |
| 4478 |
mapped instruments (using |
mapped instruments (using |
| 4479 |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
| 4480 |
</t> |
</t> |
| 4698 |
name for this mapped instrument. It can be set and |
name for this mapped instrument. It can be set and |
| 4699 |
changed with the |
changed with the |
| 4700 |
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
| 4701 |
command and does not have to be unique.</t> |
command and does not have to be unique. |
| 4702 |
|
(note that this character string may contain |
| 4703 |
|
<xref target="character_set">escape sequences</xref>)</t> |
| 4704 |
</list> |
</list> |
| 4705 |
</t> |
</t> |
| 4706 |
<t>"ENGINE_NAME" - |
<t>"ENGINE_NAME" - |
| 4711 |
</t> |
</t> |
| 4712 |
<t>"INSTRUMENT_FILE" - |
<t>"INSTRUMENT_FILE" - |
| 4713 |
<list> |
<list> |
| 4714 |
<t>File name of the instrument.</t> |
<t>File name of the instrument |
| 4715 |
|
(note that this path may contain |
| 4716 |
|
<xref target="character_set">escape sequences</xref>).</t> |
| 4717 |
</list> |
</list> |
| 4718 |
</t> |
</t> |
| 4719 |
<t>"INSTRUMENT_NR" - |
<t>"INSTRUMENT_NR" - |
| 4725 |
<list> |
<list> |
| 4726 |
<t>Name of the loaded instrument as reflected by its file. |
<t>Name of the loaded instrument as reflected by its file. |
| 4727 |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
| 4728 |
cannot be changed.</t> |
cannot be changed (note that this character string may contain |
| 4729 |
|
<xref target="character_set">escape sequences</xref>).</t> |
| 4730 |
</list> |
</list> |
| 4731 |
</t> |
</t> |
| 4732 |
<t>"LOAD_MODE" - |
<t>"LOAD_MODE" - |
| 4814 |
<section title="Managing Instruments Database" anchor="Managing Instruments Database"> |
<section title="Managing Instruments Database" anchor="Managing Instruments Database"> |
| 4815 |
<t>The following commands describe how to use and manage |
<t>The following commands describe how to use and manage |
| 4816 |
the instruments database.</t> |
the instruments database.</t> |
| 4817 |
|
<t>Notice:</t> |
| 4818 |
|
<t> |
| 4819 |
|
<list> |
| 4820 |
|
<t>All command arguments representing a path or |
| 4821 |
|
instrument/directory name support escape sequences as described in chapter |
| 4822 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>". |
| 4823 |
|
</t> |
| 4824 |
|
<t>All occurrences of a forward slash in instrument and directory |
| 4825 |
|
names are escaped with its hex (\x2f) or octal (\057) escape sequence. |
| 4826 |
|
</t> |
| 4827 |
|
</list> |
| 4828 |
|
</t> |
| 4829 |
|
|
| 4830 |
<section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY"> |
<section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY"> |
| 4831 |
<t>The front-end can add a new instrument directory to the |
<t>The front-end can add a new instrument directory to the |
| 4909 |
directories in a specific directory by sending the following command:</t> |
directories in a specific directory by sending the following command:</t> |
| 4910 |
<t> |
<t> |
| 4911 |
<list> |
<list> |
| 4912 |
<t>GET DB_INSTRUMENT_DIRECTORIES <dir></t> |
<t>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir></t> |
| 4913 |
</list> |
</list> |
| 4914 |
</t> |
</t> |
| 4915 |
<t>Where <dir> should be replaced by the absolute path |
<t>Where <dir> should be replaced by the absolute path |
| 4916 |
name of the directory.</t> |
name of the directory. If RECURSIVE is specified, the number of |
| 4917 |
|
all directories, including those located in subdirectories of the |
| 4918 |
|
specified directory, will be returned.</t> |
| 4919 |
|
|
| 4920 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 4921 |
<t> |
<t> |
| 4944 |
in specific directory by sending the following command:</t> |
in specific directory by sending the following command:</t> |
| 4945 |
<t> |
<t> |
| 4946 |
<list> |
<list> |
| 4947 |
<t>LIST DB_INSTRUMENT_DIRECTORIES <dir></t> |
<t>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir></t> |
| 4948 |
</list> |
</list> |
| 4949 |
</t> |
</t> |
| 4950 |
<t>Where <dir> should be replaced by the absolute path |
<t>Where <dir> should be replaced by the absolute path |
| 4951 |
name of the directory.</t> |
name of the directory. If RECURSIVE is specified, the absolute path names |
| 4952 |
|
of all directories, including those located in subdirectories of the |
| 4953 |
|
specified directory, will be returned.</t> |
| 4954 |
|
|
| 4955 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 4956 |
<t> |
<t> |
| 4971 |
<t>S: "'Piano Collection','Percussion Collection'"</t> |
<t>S: "'Piano Collection','Percussion Collection'"</t> |
| 4972 |
</list> |
</list> |
| 4973 |
</t> |
</t> |
| 4974 |
|
<t> |
| 4975 |
|
<list> |
| 4976 |
|
<t>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"</t> |
| 4977 |
|
<t>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"</t> |
| 4978 |
|
</list> |
| 4979 |
|
</t> |
| 4980 |
</section> |
</section> |
| 4981 |
|
|
| 4982 |
<section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO"> |
<section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO"> |
| 5003 |
<list> |
<list> |
| 5004 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
| 5005 |
<list> |
<list> |
| 5006 |
<t>A brief description of the directory content</t> |
<t>A brief description of the directory content. |
| 5007 |
|
Note that the character string may contain |
| 5008 |
|
<xref target="character_set">escape sequences</xref>.</t> |
| 5009 |
</list> |
</list> |
| 5010 |
</t> |
</t> |
| 5011 |
<t>CREATED - |
<t>CREATED - |
| 5118 |
</t> |
</t> |
| 5119 |
</section> |
</section> |
| 5120 |
|
|
| 5121 |
|
<section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY"> |
| 5122 |
|
<t>The front-end can copy a specific |
| 5123 |
|
instrument directory by sending the following command:</t> |
| 5124 |
|
<t> |
| 5125 |
|
<list> |
| 5126 |
|
<t>COPY DB_INSTRUMENT_DIRECTORY <dir> <dst></t> |
| 5127 |
|
</list> |
| 5128 |
|
</t> |
| 5129 |
|
<t>Where <dir> is the absolute path name of the directory |
| 5130 |
|
to copy and <dst> is the location where the directory will |
| 5131 |
|
be copied to.</t> |
| 5132 |
|
|
| 5133 |
|
<t>Possible Answers:</t> |
| 5134 |
|
<t> |
| 5135 |
|
<list> |
| 5136 |
|
<t>"OK" - |
| 5137 |
|
<list> |
| 5138 |
|
<t>on success</t> |
| 5139 |
|
</list> |
| 5140 |
|
</t> |
| 5141 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 5142 |
|
<list> |
| 5143 |
|
<t>in case a given directory does not exists, |
| 5144 |
|
or if a directory with name equal to the name |
| 5145 |
|
of the specified directory already exists in |
| 5146 |
|
the destination directory. Error is also thrown |
| 5147 |
|
when trying to copy a directory to a subdirectory |
| 5148 |
|
of itself.</t> |
| 5149 |
|
</list> |
| 5150 |
|
</t> |
| 5151 |
|
</list> |
| 5152 |
|
</t> |
| 5153 |
|
|
| 5154 |
|
<t>Example:</t> |
| 5155 |
|
<t> |
| 5156 |
|
<list> |
| 5157 |
|
<t>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"</t> |
| 5158 |
|
<t>S: "OK"</t> |
| 5159 |
|
</list> |
| 5160 |
|
</t> |
| 5161 |
|
</section> |
| 5162 |
|
|
| 5163 |
<section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"> |
<section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"> |
| 5164 |
<t>The front-end can alter the description of a specific |
<t>The front-end can alter the description of a specific |
| 5165 |
instrument directory by sending the following command:</t> |
instrument directory by sending the following command:</t> |
| 5169 |
</list> |
</list> |
| 5170 |
</t> |
</t> |
| 5171 |
<t>Where <dir> is the absolute path name of the directory and |
<t>Where <dir> is the absolute path name of the directory and |
| 5172 |
<desc> is the new description for the directory.</t> |
<desc> is the new description for the directory |
| 5173 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
| 5174 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
| 5175 |
|
|
| 5176 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 5177 |
<t> |
<t> |
| 5198 |
</t> |
</t> |
| 5199 |
</section> |
</section> |
| 5200 |
|
|
| 5201 |
|
<section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES"> |
| 5202 |
|
<t>The front-end can search for directories |
| 5203 |
|
in specific directory by sending the following command:</t> |
| 5204 |
|
<t> |
| 5205 |
|
<list> |
| 5206 |
|
<t>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] <dir> <criteria-list></t> |
| 5207 |
|
</list> |
| 5208 |
|
</t> |
| 5209 |
|
<t>Where <dir> should be replaced by the absolute path |
| 5210 |
|
name of the directory to search in. If NON_RECURSIVE is specified, the |
| 5211 |
|
directories located in subdirectories of the specified directory will not |
| 5212 |
|
be searched. <criteria-list> is a list of search criterias |
| 5213 |
|
in form of "key1=val1 key2=val2 ...". The following criterias are |
| 5214 |
|
allowed:</t> |
| 5215 |
|
<t> |
| 5216 |
|
<t>NAME='<search-string>' |
| 5217 |
|
<list> |
| 5218 |
|
<t>Restricts the search to directories, which names |
| 5219 |
|
satisfy the supplied search string (encapsulated into apostrophes, |
| 5220 |
|
supporting escape sequences as described in chapter |
| 5221 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
| 5222 |
|
</list> |
| 5223 |
|
</t> |
| 5224 |
|
|
| 5225 |
|
<t>CREATED='[<date-after>]..[<date-before>]' |
| 5226 |
|
<list> |
| 5227 |
|
<t>Restricts the search to directories, which creation |
| 5228 |
|
date satisfies the specified period, where <date-after> |
| 5229 |
|
and <date-before> are in "YYYY-MM-DD HH:MM:SS" format. |
| 5230 |
|
If <date-after> is omitted the search is restricted to |
| 5231 |
|
directories created before <date-before>. If |
| 5232 |
|
<date-before> is omitted, the search is restricted |
| 5233 |
|
to directories created after <date-after>.</t> |
| 5234 |
|
</list> |
| 5235 |
|
</t> |
| 5236 |
|
|
| 5237 |
|
<t>MODIFIED='[<date-after>]..[<date-before>]' |
| 5238 |
|
<list> |
| 5239 |
|
<t>Restricts the search to directories, which |
| 5240 |
|
date of last modification satisfies the specified period, where |
| 5241 |
|
<date-after> and <date-before> are in "YYYY-MM-DD HH:MM:SS" |
| 5242 |
|
format. If <date-after> is omitted the search is restricted to |
| 5243 |
|
directories, which are last modified before <date-before>. If |
| 5244 |
|
<date-before> is omitted, the search is restricted to directories, |
| 5245 |
|
which are last modified after <date-after>.</t> |
| 5246 |
|
</list> |
| 5247 |
|
</t> |
| 5248 |
|
|
| 5249 |
|
<t>DESCRIPTION='<search-string>' |
| 5250 |
|
<list> |
| 5251 |
|
<t>Restricts the search to directories with description |
| 5252 |
|
that satisfies the supplied search string |
| 5253 |
|
(encapsulated into apostrophes, supporting escape |
| 5254 |
|
sequences as described in chapter |
| 5255 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
| 5256 |
|
</list> |
| 5257 |
|
</t> |
| 5258 |
|
</t> |
| 5259 |
|
|
| 5260 |
|
<t>Where <search-string> is either a regular expression, or a |
| 5261 |
|
word list separated with spaces for OR search and with '+' for AND search.</t> |
| 5262 |
|
|
| 5263 |
|
<t>Possible Answers:</t> |
| 5264 |
|
<t> |
| 5265 |
|
<list> |
| 5266 |
|
<t>A comma separated list with the absolute path names (encapsulated into |
| 5267 |
|
apostrophes) of all directories in the specified directory that satisfy |
| 5268 |
|
the supplied search criterias.</t> |
| 5269 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 5270 |
|
<list> |
| 5271 |
|
<t>if the given directory does not exist.</t> |
| 5272 |
|
</list> |
| 5273 |
|
</t> |
| 5274 |
|
</list> |
| 5275 |
|
</t> |
| 5276 |
|
<t>Example:</t> |
| 5277 |
|
<t> |
| 5278 |
|
<list> |
| 5279 |
|
<t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"</t> |
| 5280 |
|
<t>S: "'/Piano Collection'"</t> |
| 5281 |
|
</list> |
| 5282 |
|
</t> |
| 5283 |
|
<t> |
| 5284 |
|
<list> |
| 5285 |
|
<t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"</t> |
| 5286 |
|
<t>S: "'/Piano Collection','/Percussions'"</t> |
| 5287 |
|
</list> |
| 5288 |
|
</t> |
| 5289 |
|
</section> |
| 5290 |
|
|
| 5291 |
<section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS"> |
<section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS"> |
| 5292 |
<t>The front-end can add one or more instruments |
<t>The front-end can add one or more instruments |
| 5293 |
to the instruments database by sending the following command:</t> |
to the instruments database by sending the following command:</t> |
| 5294 |
<t> |
<t> |
| 5295 |
<list> |
<list> |
| 5296 |
<t>ADD DB_INSTRUMENTS [<mode>] <db_dir> <file_path> [<instr_index>]</t> |
<t>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path> [<instr_index>]</t> |
| 5297 |
</list> |
</list> |
| 5298 |
</t> |
</t> |
| 5299 |
<t>Where <db_dir> is the absolute path name of a directory |
<t>Where <db_dir> is the absolute path name of a directory |
| 5311 |
scanning will be done and has exactly the following possibilities:</t> |
scanning will be done and has exactly the following possibilities:</t> |
| 5312 |
<t> |
<t> |
| 5313 |
<list> |
<list> |
| 5314 |
|
<t>"RECURSIVE" - |
| 5315 |
|
<list> |
| 5316 |
|
<t>All instruments will be processed, including those |
| 5317 |
|
in the subdirectories, and the respective subdirectory |
| 5318 |
|
tree structure will be recreated in the instruments |
| 5319 |
|
database</t> |
| 5320 |
|
</list> |
| 5321 |
|
</t> |
| 5322 |
<t>"NON_RECURSIVE" - |
<t>"NON_RECURSIVE" - |
| 5323 |
<list> |
<list> |
| 5324 |
<t>Only the instruments in the specified directory |
<t>Only the instruments in the specified directory |
| 5335 |
the specified database directory.</t> |
the specified database directory.</t> |
| 5336 |
</list> |
</list> |
| 5337 |
</t> |
</t> |
|
<t>not supplied - |
|
|
<list> |
|
|
<t>The subdirectory tree structure will be recreated |
|
|
in the instruments database and all instruments will be |
|
|
processed and added to the respective subdirectory |
|
|
in the instruments database.</t> |
|
|
</list> |
|
|
</t> |
|
| 5338 |
</list> |
</list> |
| 5339 |
</t> |
</t> |
| 5340 |
|
|
| 5341 |
|
<t>The difference between regular and NON_MODAL versions of the command |
| 5342 |
|
is that the regular command returns when the scanning is finished |
| 5343 |
|
while NON_MODAL version returns immediately and a background process is launched. |
| 5344 |
|
The <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref> |
| 5345 |
|
command can be used to monitor the scanning progress.</t> |
| 5346 |
|
|
| 5347 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 5348 |
<t> |
<t> |
| 5349 |
<list> |
<list> |
| 5350 |
<t>"OK" - |
<t>"OK" - |
| 5351 |
<list> |
<list> |
| 5352 |
<t>on success</t> |
<t>on success when NON_MODAL is not supplied</t> |
| 5353 |
|
</list> |
| 5354 |
|
</t> |
| 5355 |
|
<t>"OK[<job-id>]" - |
| 5356 |
|
<list> |
| 5357 |
|
<t>on success when NON_MODAL is supplied, where <job-id> |
| 5358 |
|
is a numerical ID used to obtain status information about the job progress. |
| 5359 |
|
See <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref> |
| 5360 |
|
</t> |
| 5361 |
</list> |
</list> |
| 5362 |
</t> |
</t> |
| 5363 |
<t>"ERR:<error-code>:<error-message>" - |
<t>"ERR:<error-code>:<error-message>" - |
| 5419 |
instruments in a specific directory by sending the following command:</t> |
instruments in a specific directory by sending the following command:</t> |
| 5420 |
<t> |
<t> |
| 5421 |
<list> |
<list> |
| 5422 |
<t>GET DB_INSTRUMENTS <dir></t> |
<t>GET DB_INSTRUMENTS [RECURSIVE] <dir></t> |
| 5423 |
</list> |
</list> |
| 5424 |
</t> |
</t> |
| 5425 |
<t>Where <dir> should be replaced by the absolute path name |
<t>Where <dir> should be replaced by the absolute path name |
| 5426 |
of the directory.</t> |
of the directory. If RECURSIVE is specified, the number of all |
| 5427 |
|
instruments, including those located in subdirectories of the |
| 5428 |
|
specified directory, will be returned.</t> |
| 5429 |
|
|
| 5430 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 5431 |
<t> |
<t> |
| 5454 |
in specific directory by sending the following command:</t> |
in specific directory by sending the following command:</t> |
| 5455 |
<t> |
<t> |
| 5456 |
<list> |
<list> |
| 5457 |
<t>LIST DB_INSTRUMENTS <dir></t> |
<t>LIST DB_INSTRUMENTS [RECURSIVE] <dir></t> |
| 5458 |
</list> |
</list> |
| 5459 |
</t> |
</t> |
| 5460 |
<t>Where <dir> should be replaced by the absolute path |
<t>Where <dir> should be replaced by the absolute path |
| 5461 |
name of the directory.</t> |
name of the directory. If RECURSIVE is specified, the absolute path |
| 5462 |
|
names of all instruments, including those located in subdirectories |
| 5463 |
|
of the specified directory, will be returned.</t> |
| 5464 |
|
|
| 5465 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 5466 |
<t> |
<t> |
| 5481 |
<t>S: "'Bosendorfer 290','Steinway D'"</t> |
<t>S: "'Bosendorfer 290','Steinway D'"</t> |
| 5482 |
</list> |
</list> |
| 5483 |
</t> |
</t> |
| 5484 |
|
<t> |
| 5485 |
|
<list> |
| 5486 |
|
<t>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"</t> |
| 5487 |
|
<t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"</t> |
| 5488 |
|
</list> |
| 5489 |
|
</t> |
| 5490 |
</section> |
</section> |
| 5491 |
|
|
| 5492 |
<section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO"> |
<section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO"> |
| 5513 |
<list> |
<list> |
| 5514 |
<t>INSTRUMENT_FILE - |
<t>INSTRUMENT_FILE - |
| 5515 |
<list> |
<list> |
| 5516 |
<t>File name of the instrument.</t> |
<t>File name of the instrument. |
| 5517 |
|
Note that the character string may contain |
| 5518 |
|
<xref target="character_set">escape sequences</xref>.</t> |
| 5519 |
</list> |
</list> |
| 5520 |
</t> |
</t> |
| 5521 |
<t>INSTRUMENT_NR - |
<t>INSTRUMENT_NR - |
| 5554 |
</t> |
</t> |
| 5555 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
| 5556 |
<list> |
<list> |
| 5557 |
<t>A brief description of the instrument</t> |
<t>A brief description of the instrument. |
| 5558 |
|
Note that the character string may contain |
| 5559 |
|
<xref target="character_set">escape sequences</xref>.</t> |
| 5560 |
</list> |
</list> |
| 5561 |
</t> |
</t> |
| 5562 |
<t>IS_DRUM - |
<t>IS_DRUM - |
| 5567 |
</t> |
</t> |
| 5568 |
<t>PRODUCT - |
<t>PRODUCT - |
| 5569 |
<list> |
<list> |
| 5570 |
<t>The product title of the instrument</t> |
<t>The product title of the instrument. |
| 5571 |
|
Note that the character string may contain |
| 5572 |
|
<xref target="character_set">escape sequences</xref>.</t> |
| 5573 |
</list> |
</list> |
| 5574 |
</t> |
</t> |
| 5575 |
<t>ARTISTS - |
<t>ARTISTS - |
| 5576 |
<list> |
<list> |
| 5577 |
<t>Lists the artist names</t> |
<t>Lists the artist names. |
| 5578 |
|
Note that the character string may contain |
| 5579 |
|
<xref target="character_set">escape sequences</xref>.</t> |
| 5580 |
</list> |
</list> |
| 5581 |
</t> |
</t> |
| 5582 |
<t>KEYWORDS - |
<t>KEYWORDS - |
| 5583 |
<list> |
<list> |
| 5584 |
<t>Provides a list of keywords that refer to the instrument. |
<t>Provides a list of keywords that refer to the instrument. |
| 5585 |
Keywords are separated with semicolon and blank.</t> |
Keywords are separated with semicolon and blank. |
| 5586 |
|
Note that the character string may contain |
| 5587 |
|
<xref target="character_set">escape sequences</xref>.</t> |
| 5588 |
</list> |
</list> |
| 5589 |
</t> |
</t> |
| 5590 |
</list> |
</list> |
| 5692 |
</t> |
</t> |
| 5693 |
</section> |
</section> |
| 5694 |
|
|
| 5695 |
|
<section title="Copying instruments" anchor="COPY DB_INSTRUMENT"> |
| 5696 |
|
<t>The front-end can copy a specific instrument to another directory by |
| 5697 |
|
sending the following command:</t> |
| 5698 |
|
<t> |
| 5699 |
|
<list> |
| 5700 |
|
<t>COPY DB_INSTRUMENT <instr> <dst></t> |
| 5701 |
|
</list> |
| 5702 |
|
</t> |
| 5703 |
|
<t>Where <instr> is the absolute path name of the instrument |
| 5704 |
|
to copy and <dst> is the directory where the instrument will |
| 5705 |
|
be copied to.</t> |
| 5706 |
|
|
| 5707 |
|
<t>Possible Answers:</t> |
| 5708 |
|
<t> |
| 5709 |
|
<list> |
| 5710 |
|
<t>"OK" - |
| 5711 |
|
<list> |
| 5712 |
|
<t>on success</t> |
| 5713 |
|
</list> |
| 5714 |
|
</t> |
| 5715 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 5716 |
|
<list> |
| 5717 |
|
<t>in case the given instrument does not exists, |
| 5718 |
|
or if an instrument with name equal to the name of the |
| 5719 |
|
specified instrument already exists in the destination |
| 5720 |
|
directory.</t> |
| 5721 |
|
</list> |
| 5722 |
|
</t> |
| 5723 |
|
</list> |
| 5724 |
|
</t> |
| 5725 |
|
|
| 5726 |
|
<t>Example:</t> |
| 5727 |
|
<t> |
| 5728 |
|
<list> |
| 5729 |
|
<t>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"</t> |
| 5730 |
|
<t>S: "OK"</t> |
| 5731 |
|
</list> |
| 5732 |
|
</t> |
| 5733 |
|
</section> |
| 5734 |
|
|
| 5735 |
<section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION"> |
<section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION"> |
| 5736 |
<t>The front-end can alter the description of a specific |
<t>The front-end can alter the description of a specific |
| 5737 |
instrument by sending the following command:</t> |
instrument by sending the following command:</t> |
| 5741 |
</list> |
</list> |
| 5742 |
</t> |
</t> |
| 5743 |
<t>Where <instr> is the absolute path name of the instrument and |
<t>Where <instr> is the absolute path name of the instrument and |
| 5744 |
<desc> is the new description for the instrument.</t> |
<desc> is the new description for the instrument |
| 5745 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
| 5746 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
| 5747 |
|
|
| 5748 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
| 5749 |
<t> |
<t> |
| 5770 |
</t> |
</t> |
| 5771 |
</section> |
</section> |
| 5772 |
|
|
| 5773 |
|
<section title="Finding instruments" anchor="FIND DB_INSTRUMENTS"> |
| 5774 |
|
<t>The front-end can search for instruments |
| 5775 |
|
in specific directory by sending the following command:</t> |
| 5776 |
|
<t> |
| 5777 |
|
<list> |
| 5778 |
|
<t>FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list></t> |
| 5779 |
|
</list> |
| 5780 |
|
</t> |
| 5781 |
|
<t>Where <dir> should be replaced by the absolute path |
| 5782 |
|
name of the directory to search in. If NON_RECURSIVE is specified, the |
| 5783 |
|
directories located in subdirectories of the specified directory will not |
| 5784 |
|
be searched. <criteria-list> is a list of search criterias |
| 5785 |
|
in form of "key1=val1 key2=val2 ...". The following criterias are |
| 5786 |
|
allowed:</t> |
| 5787 |
|
<t> |
| 5788 |
|
<t>NAME='<search-string>' |
| 5789 |
|
<list> |
| 5790 |
|
<t>Restricts the search to instruments, which names |
| 5791 |
|
satisfy the supplied search string (encapsulated into apostrophes, |
| 5792 |
|
supporting escape sequences as described in chapter |
| 5793 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
| 5794 |
|
</list> |
| 5795 |
|
</t> |
| 5796 |
|
|
| 5797 |
|
<t>SIZE=[<min>]..[<max>] |
| 5798 |
|
<list> |
| 5799 |
|
<t>Restricts the search to instruments, which |
| 5800 |
|
size is in the specified range. If <min> is omitted, |
| 5801 |
|
the search results are restricted to instruments with size less then |
| 5802 |
|
or equal to <max>. If <max> is omitted, the |
| 5803 |
|
search is restricted to instruments with size greater then |
| 5804 |
|
or equal to <min>.</t> |
| 5805 |
|
</list> |
| 5806 |
|
</t> |
| 5807 |
|
|
| 5808 |
|
<t>CREATED='[<date-after>]..[<date-before>]' |
| 5809 |
|
<list> |
| 5810 |
|
<t>Restricts the search to instruments, which creation |
| 5811 |
|
date satisfies the specified period, where <date-after> |
| 5812 |
|
and <date-before> are in "YYYY-MM-DD HH:MM:SS" format. |
| 5813 |
|
If <date-after> is omitted the search is restricted to |
| 5814 |
|
instruments created before <date-before>. If |
| 5815 |
|
<date-before> is omitted, the search is restricted |
| 5816 |
|
to instruments created after <date-after>.</t> |
| 5817 |
|
</list> |
| 5818 |
|
</t> |
| 5819 |
|
|
| 5820 |
|
<t>MODIFIED='[<date-after>]..[<date-before>]' |
| 5821 |
|
<list> |
| 5822 |
|
<t>Restricts the search to instruments, which |
| 5823 |
|
date of last modification satisfies the specified period, where |
| 5824 |
|
<date-after> and <date-before> are in "YYYY-MM-DD HH:MM:SS" |
| 5825 |
|
format. If <date-after> is omitted the search is restricted to |
| 5826 |
|
instruments, which are last modified before <date-before>. If |
| 5827 |
|
<date-before> is omitted, the search is restricted to instruments, |
| 5828 |
|
which are last modified after <date-after>.</t> |
| 5829 |
|
</list> |
| 5830 |
|
</t> |
| 5831 |
|
|
| 5832 |
|
<t>DESCRIPTION='<search-string>' |
| 5833 |
|
<list> |
| 5834 |
|
<t>Restricts the search to instruments with description |
| 5835 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
| 5836 |
|
supporting escape sequences as described in chapter |
| 5837 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
| 5838 |
|
</list> |
| 5839 |
|
</t> |
| 5840 |
|
|
| 5841 |
|
<t>PRODUCT='<search-string>' |
| 5842 |
|
<list> |
| 5843 |
|
<t>Restricts the search to instruments with product info |
| 5844 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
| 5845 |
|
supporting escape sequences as described in chapter |
| 5846 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
| 5847 |
|
</list> |
| 5848 |
|
</t> |
| 5849 |
|
|
| 5850 |
|
<t>ARTISTS='<search-string>' |
| 5851 |
|
<list> |
| 5852 |
|
<t>Restricts the search to instruments with artists info |
| 5853 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
| 5854 |
|
supporting escape sequences as described in chapter |
| 5855 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
| 5856 |
|
</list> |
| 5857 |
|
</t> |
| 5858 |
|
|
| 5859 |
|
<t>KEYWORDS='<search-string>' |
| 5860 |
|
<list> |
| 5861 |
|
<t>Restricts the search to instruments with keyword list |
| 5862 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
| 5863 |
|
supporting escape sequences as described in chapter |
| 5864 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
| 5865 |
|
</list> |
| 5866 |
|
</t> |
| 5867 |
|
|
| 5868 |
|
<t>IS_DRUM=true | false |
| 5869 |
|
<list> |
| 5870 |
|
<t>Either true or false. Restricts the search to |
| 5871 |
|
drum kits or chromatic instruments.</t> |
| 5872 |
|
</list> |
| 5873 |
|
</t> |
| 5874 |
|
|
| 5875 |
|
<t>FORMAT_FAMILIES='<format-list>' |
| 5876 |
|
<list> |
| 5877 |
|
<t>Restricts the search to instruments of the supplied format families, |
| 5878 |
|
where <format-list> is a comma separated list of format families.</t> |
| 5879 |
|
</list> |
| 5880 |
|
</t> |
| 5881 |
|
</t> |
| 5882 |
|
|
| 5883 |
|
<t>Where <search-string> is either a regular expression, or a |
| 5884 |
|
word list separated with spaces for OR search and with '+' for AND search.</t> |
| 5885 |
|
|
| 5886 |
|
<t>Possible Answers:</t> |
| 5887 |
|
<t> |
| 5888 |
|
<list> |
| 5889 |
|
<t>A comma separated list with the absolute path names (encapsulated into |
| 5890 |
|
apostrophes) of all instruments in the specified directory that satisfy |
| 5891 |
|
the supplied search criterias.</t> |
| 5892 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 5893 |
|
<list> |
| 5894 |
|
<t>if the given directory does not exist.</t> |
| 5895 |
|
</list> |
| 5896 |
|
</t> |
| 5897 |
|
</list> |
| 5898 |
|
</t> |
| 5899 |
|
<t>Example:</t> |
| 5900 |
|
<t> |
| 5901 |
|
<list> |
| 5902 |
|
<t>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"</t> |
| 5903 |
|
<t>S: "'/Piano Collection/Bosendorfer 290'"</t> |
| 5904 |
|
</list> |
| 5905 |
|
</t> |
| 5906 |
|
<t> |
| 5907 |
|
<list> |
| 5908 |
|
<t>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"</t> |
| 5909 |
|
<t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"</t> |
| 5910 |
|
</list> |
| 5911 |
|
</t> |
| 5912 |
|
</section> |
| 5913 |
|
|
| 5914 |
|
<section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO"> |
| 5915 |
|
<t>The front-end can ask for the current status of a |
| 5916 |
|
particular database instruments job by sending the following command:</t> |
| 5917 |
|
<t> |
| 5918 |
|
<list> |
| 5919 |
|
<t>GET DB_INSTRUMENTS_JOB INFO <job-id></t> |
| 5920 |
|
</list> |
| 5921 |
|
</t> |
| 5922 |
|
<t>Where <job-id> should be replaced by the numerical ID |
| 5923 |
|
of the job the front-end is interested in.</t> |
| 5924 |
|
|
| 5925 |
|
<t>Possible Answers:</t> |
| 5926 |
|
<t> |
| 5927 |
|
<list> |
| 5928 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
| 5929 |
|
Each answer line begins with the settings category name |
| 5930 |
|
followed by a colon and then a space character <SP> and finally |
| 5931 |
|
the info character string to that setting category. At the |
| 5932 |
|
moment the following categories are defined:</t> |
| 5933 |
|
|
| 5934 |
|
<t> |
| 5935 |
|
<list> |
| 5936 |
|
<t>FILES_TOTAL - |
| 5937 |
|
<list> |
| 5938 |
|
<t>The total number of files scheduled for scanning</t> |
| 5939 |
|
</list> |
| 5940 |
|
</t> |
| 5941 |
|
<t>FILES_SCANNED - |
| 5942 |
|
<list> |
| 5943 |
|
<t>The current number of scanned files</t> |
| 5944 |
|
</list> |
| 5945 |
|
</t> |
| 5946 |
|
<t>SCANNING - |
| 5947 |
|
<list> |
| 5948 |
|
<t>The absolute path name of the file which is currently |
| 5949 |
|
being scanned</t> |
| 5950 |
|
</list> |
| 5951 |
|
</t> |
| 5952 |
|
<t>STATUS - |
| 5953 |
|
<list> |
| 5954 |
|
<t>An integer value between 0 and 100 indicating the |
| 5955 |
|
scanning progress percentage of the file which is |
| 5956 |
|
currently being scanned</t> |
| 5957 |
|
</list> |
| 5958 |
|
</t> |
| 5959 |
|
</list> |
| 5960 |
|
</t> |
| 5961 |
|
</list> |
| 5962 |
|
</t> |
| 5963 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
| 5964 |
|
|
| 5965 |
|
<t>Example:</t> |
| 5966 |
|
<t> |
| 5967 |
|
<list> |
| 5968 |
|
<t>C: "GET DB_INSTRUMENTS_JOB INFO 2"</t> |
| 5969 |
|
<t>S: "FILES_TOTAL: 12"</t> |
| 5970 |
|
<t> "FILES_SCANNED: 7"</t> |
| 5971 |
|
<t> "SCANNING: /home/me/gigs/Bosendorfer 290.gig"</t> |
| 5972 |
|
<t> "STATUS: 42"</t> |
| 5973 |
|
<t> "."</t> |
| 5974 |
|
</list> |
| 5975 |
|
</t> |
| 5976 |
|
</section> |
| 5977 |
|
|
| 5978 |
|
<section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB"> |
| 5979 |
|
<t>The front-end can remove all instruments and directories and re-create |
| 5980 |
|
the instruments database structure (e.g., in case of a database corruption) |
| 5981 |
|
by sending the following command:</t> |
| 5982 |
|
<t> |
| 5983 |
|
<list> |
| 5984 |
|
<t>FORMAT INSTRUMENTS_DB</t> |
| 5985 |
|
</list> |
| 5986 |
|
</t> |
| 5987 |
|
|
| 5988 |
|
<t>Possible Answers:</t> |
| 5989 |
|
<t> |
| 5990 |
|
<list> |
| 5991 |
|
<t>"OK" - |
| 5992 |
|
<list> |
| 5993 |
|
<t>on success</t> |
| 5994 |
|
</list> |
| 5995 |
|
</t> |
| 5996 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 5997 |
|
<list> |
| 5998 |
|
<t>If the formatting of the instruments database |
| 5999 |
|
failed.</t> |
| 6000 |
|
</list> |
| 6001 |
|
</t> |
| 6002 |
|
</list> |
| 6003 |
|
</t> |
| 6004 |
|
</section> |
| 6005 |
|
|
| 6006 |
</section> |
</section> |
| 6007 |
|
|
|
</section> |
|
| 6008 |
|
|
| 6009 |
|
|
| 6010 |
|
<section title="Editing Instruments" anchor="editing_instruments"> |
| 6011 |
|
<t>The sampler allows to edit instruments while playing with the |
| 6012 |
|
sampler by spawning an external (3rd party) instrument editor |
| 6013 |
|
application for a given instrument. The 3rd party instrument |
| 6014 |
|
editor applications have to place a respective plugin DLL file |
| 6015 |
|
into the sampler's plugins directory. The sampler will |
| 6016 |
|
automatically try to load all plugin DLLs in that directory on |
| 6017 |
|
startup and only on startup!</t> |
| 6018 |
|
<t>At the moment there is only one command for this feature set, |
| 6019 |
|
but this will most probably change in future.</t> |
| 6020 |
|
|
| 6021 |
|
<section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT"> |
| 6022 |
|
<t>The front-end can request to open an appropriate instrument |
| 6023 |
|
editor application by sending the following command:</t> |
| 6024 |
|
<t> |
| 6025 |
|
<list> |
| 6026 |
|
<t>EDIT CHANNEL INSTRUMENT <sampler-channel></t> |
| 6027 |
|
</list> |
| 6028 |
|
</t> |
| 6029 |
|
<t>Where <sampler-channel> should be replaced by the |
| 6030 |
|
number of the sampler channel as given by the |
| 6031 |
|
<xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 6032 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> |
| 6033 |
|
command.</t> |
| 6034 |
|
|
| 6035 |
|
<t>The sampler will try to ask all registered instrument |
| 6036 |
|
editors (or to be more specific: their sampler plugins) |
| 6037 |
|
whether they are capable to handle the instrument on the |
| 6038 |
|
given sampler channel. The sampler will simply use the first |
| 6039 |
|
instrument editor application which replied with a positive |
| 6040 |
|
answer and spawn that instrument editor application within |
| 6041 |
|
the sampler's process and provide that application access |
| 6042 |
|
to the instrument's data structures, so both applications |
| 6043 |
|
can share and access the same instruments data at the same |
| 6044 |
|
time, thus allowing to immediately hear changes with the |
| 6045 |
|
sampler made by the instrument editor.</t> |
| 6046 |
|
|
| 6047 |
|
<t>Note: consequently instrument editors are always spawned |
| 6048 |
|
locally on the same machine where the sampler is running |
| 6049 |
|
on!</t> |
| 6050 |
|
|
| 6051 |
|
<t>Possible Answers:</t> |
| 6052 |
|
<t> |
| 6053 |
|
<list> |
| 6054 |
|
<t>"OK" - |
| 6055 |
|
<list> |
| 6056 |
|
<t>when an appropriate instrument editor was |
| 6057 |
|
launched</t> |
| 6058 |
|
</list> |
| 6059 |
|
</t> |
| 6060 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
| 6061 |
|
<list> |
| 6062 |
|
<t>when an appropriate instrument editor was |
| 6063 |
|
launched, but there are noteworthy issues</t> |
| 6064 |
|
</list> |
| 6065 |
|
</t> |
| 6066 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 6067 |
|
<list> |
| 6068 |
|
<t>when an appropriate instrument editor |
| 6069 |
|
could not be launched</t> |
| 6070 |
|
</list> |
| 6071 |
|
</t> |
| 6072 |
|
</list> |
| 6073 |
|
</t> |
| 6074 |
|
|
| 6075 |
|
<t>Examples:</t> |
| 6076 |
|
<t> |
| 6077 |
|
<list> |
| 6078 |
|
<t>C: "EDIT CHANNEL INSTRUMENT 0"</t> |
| 6079 |
|
<t>S: "OK"</t> |
| 6080 |
|
</list> |
| 6081 |
|
</t> |
| 6082 |
|
</section> |
| 6083 |
|
</section> |
| 6084 |
|
|
| 6085 |
|
<section title="Managing Files" anchor="file_management"> |
| 6086 |
|
<t>You can query detailed informations about files located |
| 6087 |
|
at the same system where the sampler instance is running on. |
| 6088 |
|
Using this command set allows to retrieve file informations |
| 6089 |
|
even remotely from another machine.</t> |
| 6090 |
|
|
| 6091 |
|
<section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS"> |
| 6092 |
|
<t>The front-end can retrieve the amount of instruments |
| 6093 |
|
within a given instrument file by sending the |
| 6094 |
|
following command:</t> |
| 6095 |
|
<t> |
| 6096 |
|
<list> |
| 6097 |
|
<t>GET FILE INSTRUMENTS <filename></t> |
| 6098 |
|
</list> |
| 6099 |
|
</t> |
| 6100 |
|
<t>Where <filename> is the name of the instrument |
| 6101 |
|
file (encapsulated into apostrophes, supporting escape |
| 6102 |
|
sequences as described in chapter |
| 6103 |
|
"<xref target="character_set">Character Set and Escape |
| 6104 |
|
Sequences</xref>").</t> |
| 6105 |
|
|
| 6106 |
|
<t>The sampler will try to ask all sampler engines, |
| 6107 |
|
whether they support the given file and ask the first |
| 6108 |
|
engine with a positive answer for the amount of |
| 6109 |
|
instruments.</t> |
| 6110 |
|
|
| 6111 |
|
<t>Possible Answers:</t> |
| 6112 |
|
<t> |
| 6113 |
|
<list> |
| 6114 |
|
<t>On success, the sampler will answer by |
| 6115 |
|
returning the amount of instruments. |
| 6116 |
|
</t> |
| 6117 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 6118 |
|
<list> |
| 6119 |
|
<t>if the file could not be handled</t> |
| 6120 |
|
</list> |
| 6121 |
|
</t> |
| 6122 |
|
</list> |
| 6123 |
|
</t> |
| 6124 |
|
|
| 6125 |
|
<t>Examples:</t> |
| 6126 |
|
<t> |
| 6127 |
|
<list> |
| 6128 |
|
<t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
| 6129 |
|
<t>S: "10"</t> |
| 6130 |
|
</list> |
| 6131 |
|
</t> |
| 6132 |
|
</section> |
| 6133 |
|
|
| 6134 |
|
<section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS"> |
| 6135 |
|
<t>The front-end can retrieve a list of all instruments |
| 6136 |
|
within a given instrument file by sending the |
| 6137 |
|
following command:</t> |
| 6138 |
|
<t> |
| 6139 |
|
<list> |
| 6140 |
|
<t>LIST FILE INSTRUMENTS <filename></t> |
| 6141 |
|
</list> |
| 6142 |
|
</t> |
| 6143 |
|
<t>Where <filename> is the name of the instrument |
| 6144 |
|
file (encapsulated into apostrophes, supporting escape |
| 6145 |
|
sequences as described in chapter |
| 6146 |
|
"<xref target="character_set">Character Set and Escape |
| 6147 |
|
Sequences</xref>").</t> |
| 6148 |
|
|
| 6149 |
|
<t>The sampler will try to ask all sampler engines, |
| 6150 |
|
whether they support the given file and ask the first |
| 6151 |
|
engine with a positive answer for a list of IDs for the |
| 6152 |
|
instruments in the given file.</t> |
| 6153 |
|
|
| 6154 |
|
<t>Possible Answers:</t> |
| 6155 |
|
<t> |
| 6156 |
|
<list> |
| 6157 |
|
<t>On success, the sampler will answer by |
| 6158 |
|
returning a comma separated list of |
| 6159 |
|
instrument IDs. |
| 6160 |
|
</t> |
| 6161 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 6162 |
|
<list> |
| 6163 |
|
<t>if the file could not be handled</t> |
| 6164 |
|
</list> |
| 6165 |
|
</t> |
| 6166 |
|
</list> |
| 6167 |
|
</t> |
| 6168 |
|
|
| 6169 |
|
<t>Examples:</t> |
| 6170 |
|
<t> |
| 6171 |
|
<list> |
| 6172 |
|
<t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
| 6173 |
|
<t>S: "0,1,2,3,4,5,6,7,8,9"</t> |
| 6174 |
|
</list> |
| 6175 |
|
</t> |
| 6176 |
|
</section> |
| 6177 |
|
|
| 6178 |
|
<section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO"> |
| 6179 |
|
<t>The front-end can retrieve detailed informations |
| 6180 |
|
about a specific instrument within a given instrument |
| 6181 |
|
file by sending the following command:</t> |
| 6182 |
|
<t> |
| 6183 |
|
<list> |
| 6184 |
|
<t>GET FILE INSTRUMENT INFO <filename> |
| 6185 |
|
<instr-id></t> |
| 6186 |
|
</list> |
| 6187 |
|
</t> |
| 6188 |
|
<t>Where <filename> is the name of the instrument |
| 6189 |
|
file (encapsulated into apostrophes, supporting escape |
| 6190 |
|
sequences as described in chapter |
| 6191 |
|
"<xref target="character_set">Character Set and Escape |
| 6192 |
|
Sequences</xref>") and <instr-id> is the numeric |
| 6193 |
|
instrument ID as returned by the |
| 6194 |
|
<xref target="LIST FILE INSTRUMENTS"> |
| 6195 |
|
"LIST FILE INSTRUMENTS"</xref> command.</t> |
| 6196 |
|
|
| 6197 |
|
<t>The sampler will try to ask all sampler engines, |
| 6198 |
|
whether they support the given file and ask the first |
| 6199 |
|
engine with a positive answer for informations about the |
| 6200 |
|
specific instrument in the given file.</t> |
| 6201 |
|
|
| 6202 |
|
<t>Possible Answers:</t> |
| 6203 |
|
<t> |
| 6204 |
|
<list> |
| 6205 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
| 6206 |
|
Each answer line begins with the settings category name |
| 6207 |
|
followed by a colon and then a space character <SP> and finally |
| 6208 |
|
the info character string to that setting category. At the |
| 6209 |
|
moment the following categories are defined:</t> |
| 6210 |
|
|
| 6211 |
|
<t> |
| 6212 |
|
<list> |
| 6213 |
|
<t>NAME - |
| 6214 |
|
<list> |
| 6215 |
|
<t>name of the instrument as |
| 6216 |
|
stored in the instrument file</t> |
| 6217 |
|
</list> |
| 6218 |
|
</t> |
| 6219 |
|
<t>FORMAT_FAMILY - |
| 6220 |
|
<list> |
| 6221 |
|
<t>name of the sampler format |
| 6222 |
|
of the given instrument</t> |
| 6223 |
|
</list> |
| 6224 |
|
</t> |
| 6225 |
|
<t>FORMAT_VERSION - |
| 6226 |
|
<list> |
| 6227 |
|
<t>version of the sampler format |
| 6228 |
|
the instrumen is stored as</t> |
| 6229 |
|
</list> |
| 6230 |
|
</t> |
| 6231 |
|
<t>PRODUCT - |
| 6232 |
|
<list> |
| 6233 |
|
<t>official product name of the |
| 6234 |
|
instrument as stored in the file |
| 6235 |
|
</t> |
| 6236 |
|
</list> |
| 6237 |
|
</t> |
| 6238 |
|
<t>ARTISTS - |
| 6239 |
|
<list> |
| 6240 |
|
<t>artists / sample library |
| 6241 |
|
vendor of the instrument</t> |
| 6242 |
|
</list> |
| 6243 |
|
</t> |
| 6244 |
|
</list> |
| 6245 |
|
</t> |
| 6246 |
|
</list> |
| 6247 |
|
</t> |
| 6248 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
| 6249 |
|
|
| 6250 |
|
<t>Example:</t> |
| 6251 |
|
<t> |
| 6252 |
|
<list> |
| 6253 |
|
<t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t> |
| 6254 |
|
<t>S: "NAME: Lunatic Loops"</t> |
| 6255 |
|
<t> "FORMAT_FAMILY: GIG"</t> |
| 6256 |
|
<t> "FORMAT_VERSION: 3"</t> |
| 6257 |
|
<t> "PRODUCT: The Backbone Bongo Beats"</t> |
| 6258 |
|
<t> "ARTISTS: Jimmy the Fish"</t> |
| 6259 |
|
<t> "."</t> |
| 6260 |
|
</list> |
| 6261 |
|
</t> |
| 6262 |
|
</section> |
| 6263 |
|
</section> |
| 6264 |
|
</section> |
| 6265 |
|
|
| 6266 |
<section title="Command Syntax" anchor="command_syntax"> |
<section title="Command Syntax" anchor="command_syntax"> |
| 6267 |
<t>The grammar of the control protocol as descibed in <xref target="control_commands"/> |
<t>The grammar of the control protocol as descibed in <xref target="control_commands"/> |
| 6268 |
is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>) |
is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>) |
| 6339 |
</t> |
</t> |
| 6340 |
<t>/ CLEAR SP clear_instruction |
<t>/ CLEAR SP clear_instruction |
| 6341 |
</t> |
</t> |
| 6342 |
|
<t>/ FIND SP find_instruction |
| 6343 |
|
</t> |
| 6344 |
<t>/ MOVE SP move_instruction |
<t>/ MOVE SP move_instruction |
| 6345 |
</t> |
</t> |
| 6346 |
|
<t>/ COPY SP copy_instruction |
| 6347 |
|
</t> |
| 6348 |
|
<t>/ EDIT SP edit_instruction |
| 6349 |
|
</t> |
| 6350 |
|
<t>/ FORMAT SP format_instruction |
| 6351 |
|
</t> |
| 6352 |
<t>/ RESET |
<t>/ RESET |
| 6353 |
</t> |
</t> |
| 6354 |
<t>/ QUIT |
<t>/ QUIT |
| 6359 |
<list> |
<list> |
| 6360 |
<t>CHANNEL |
<t>CHANNEL |
| 6361 |
</t> |
</t> |
| 6362 |
<t>/ DB_INSTRUMENT_DIRECTORY SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
| 6363 |
</t> |
</t> |
| 6364 |
<t>/ DB_INSTRUMENTS SP FLAT SP pathname SP pathname |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
| 6365 |
</t> |
</t> |
| 6366 |
<t>/ DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname |
<t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
| 6367 |
</t> |
</t> |
| 6368 |
<t>/ DB_INSTRUMENTS SP pathname SP pathname |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
| 6369 |
</t> |
</t> |
| 6370 |
<t>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index |
| 6371 |
|
</t> |
| 6372 |
|
<t>/ DB_INSTRUMENTS SP db_path SP filename |
| 6373 |
|
</t> |
| 6374 |
|
<t>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index |
| 6375 |
</t> |
</t> |
| 6376 |
<t>/ MIDI_INSTRUMENT_MAP |
<t>/ MIDI_INSTRUMENT_MAP |
| 6377 |
</t> |
</t> |
| 6391 |
</t> |
</t> |
| 6392 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
| 6393 |
</t> |
</t> |
| 6394 |
|
<t>/ CHANNEL_MIDI |
| 6395 |
|
</t> |
| 6396 |
|
<t>/ DEVICE_MIDI |
| 6397 |
|
</t> |
| 6398 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
| 6399 |
</t> |
</t> |
| 6400 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
| 6423 |
</t> |
</t> |
| 6424 |
<t>/ DB_INSTRUMENT_INFO |
<t>/ DB_INSTRUMENT_INFO |
| 6425 |
</t> |
</t> |
| 6426 |
|
<t>/ DB_INSTRUMENTS_JOB_INFO |
| 6427 |
|
</t> |
| 6428 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
| 6429 |
</t> |
</t> |
| 6430 |
|
<t>/ TOTAL_STREAM_COUNT |
| 6431 |
|
</t> |
| 6432 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
| 6433 |
</t> |
</t> |
| 6434 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
| 6447 |
</t> |
</t> |
| 6448 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
| 6449 |
</t> |
</t> |
| 6450 |
|
<t>/ CHANNEL_MIDI |
| 6451 |
|
</t> |
| 6452 |
|
<t>/ DEVICE_MIDI |
| 6453 |
|
</t> |
| 6454 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
| 6455 |
</t> |
</t> |
| 6456 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
| 6479 |
</t> |
</t> |
| 6480 |
<t>/ DB_INSTRUMENT_INFO |
<t>/ DB_INSTRUMENT_INFO |
| 6481 |
</t> |
</t> |
| 6482 |
|
<t>/ DB_INSTRUMENTS_JOB_INFO |
| 6483 |
|
</t> |
| 6484 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
| 6485 |
</t> |
</t> |
| 6486 |
|
<t>/ TOTAL_STREAM_COUNT |
| 6487 |
|
</t> |
| 6488 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
| 6489 |
</t> |
</t> |
| 6490 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
| 6517 |
</t> |
</t> |
| 6518 |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
| 6519 |
</t> |
</t> |
| 6520 |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
| 6521 |
</t> |
</t> |
| 6522 |
<t>/ DB_INSTRUMENT_DIRECTORY SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
| 6523 |
</t> |
</t> |
| 6524 |
<t>/ DB_INSTRUMENT SP pathname |
<t>/ DB_INSTRUMENT SP db_path |
| 6525 |
</t> |
</t> |
| 6526 |
</list> |
</list> |
| 6527 |
</t> |
</t> |
| 6575 |
</t> |
</t> |
| 6576 |
<t>/ SERVER SP INFO |
<t>/ SERVER SP INFO |
| 6577 |
</t> |
</t> |
| 6578 |
|
<t>/ TOTAL_STREAM_COUNT |
| 6579 |
|
</t> |
| 6580 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
| 6581 |
</t> |
</t> |
| 6582 |
<t>/ TOTAL_VOICE_COUNT_MAX |
<t>/ TOTAL_VOICE_COUNT_MAX |
| 6595 |
</t> |
</t> |
| 6596 |
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
| 6597 |
</t> |
</t> |
| 6598 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
| 6599 |
|
</t> |
| 6600 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
| 6601 |
</t> |
</t> |
| 6602 |
<t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path |
| 6603 |
</t> |
</t> |
| 6604 |
<t>/ DB_INSTRUMENTS SP pathname |
<t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
| 6605 |
</t> |
</t> |
| 6606 |
<t>/ DB_INSTRUMENT SP INFO SP pathname |
<t>/ DB_INSTRUMENTS SP db_path |
| 6607 |
|
</t> |
| 6608 |
|
<t>/ DB_INSTRUMENT SP INFO SP db_path |
| 6609 |
|
</t> |
| 6610 |
|
<t>/ DB_INSTRUMENTS_JOB SP INFO SP number |
| 6611 |
</t> |
</t> |
| 6612 |
<t>/ VOLUME |
<t>/ VOLUME |
| 6613 |
</t> |
</t> |
| 6614 |
|
<t>/ FILE SP INSTRUMENTS SP filename |
| 6615 |
|
</t> |
| 6616 |
|
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
| 6617 |
|
</t> |
| 6618 |
</list> |
</list> |
| 6619 |
</t> |
</t> |
| 6620 |
<t>set_instruction = |
<t>set_instruction = |
| 6625 |
</t> |
</t> |
| 6626 |
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
| 6627 |
</t> |
</t> |
| 6628 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE |
| 6629 |
|
</t> |
| 6630 |
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
| 6631 |
</t> |
</t> |
| 6632 |
<t>/ CHANNEL SP set_chan_instruction |
<t>/ CHANNEL SP set_chan_instruction |
| 6641 |
</t> |
</t> |
| 6642 |
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
| 6643 |
</t> |
</t> |
| 6644 |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
| 6645 |
</t> |
</t> |
| 6646 |
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval |
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped |
| 6647 |
</t> |
</t> |
| 6648 |
<t>/ DB_INSTRUMENT SP NAME SP pathname SP dirname |
<t>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped |
| 6649 |
</t> |
</t> |
| 6650 |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
| 6651 |
</t> |
</t> |
| 6652 |
<t>/ ECHO SP boolean |
<t>/ ECHO SP boolean |
| 6653 |
</t> |
</t> |
| 6685 |
</t> |
</t> |
| 6686 |
</list> |
</list> |
| 6687 |
</t> |
</t> |
| 6688 |
|
<t>find_instruction = |
| 6689 |
|
<list> |
| 6690 |
|
<t>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list |
| 6691 |
|
</t> |
| 6692 |
|
<t>/ DB_INSTRUMENTS SP db_path SP query_val_list |
| 6693 |
|
</t> |
| 6694 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list |
| 6695 |
|
</t> |
| 6696 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
| 6697 |
|
</t> |
| 6698 |
|
</list> |
| 6699 |
|
</t> |
| 6700 |
<t>move_instruction = |
<t>move_instruction = |
| 6701 |
<list> |
<list> |
| 6702 |
<t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname |
<t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
| 6703 |
</t> |
</t> |
| 6704 |
<t>/ DB_INSTRUMENT SP pathname SP pathname |
<t>/ DB_INSTRUMENT SP db_path SP db_path |
| 6705 |
|
</t> |
| 6706 |
|
</list> |
| 6707 |
|
</t> |
| 6708 |
|
<t>copy_instruction = |
| 6709 |
|
<list> |
| 6710 |
|
<t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
| 6711 |
|
</t> |
| 6712 |
|
<t>/ DB_INSTRUMENT SP db_path SP db_path |
| 6713 |
</t> |
</t> |
| 6714 |
</list> |
</list> |
| 6715 |
</t> |
</t> |
| 6763 |
</t> |
</t> |
| 6764 |
</list> |
</list> |
| 6765 |
</t> |
</t> |
| 6766 |
|
<t>edit_instruction = |
| 6767 |
|
<list> |
| 6768 |
|
<t>CHANNEL SP INSTRUMENT SP sampler_channel |
| 6769 |
|
</t> |
| 6770 |
|
</list> |
| 6771 |
|
</t> |
| 6772 |
|
<t>format_instruction = |
| 6773 |
|
<list> |
| 6774 |
|
<t>INSTRUMENTS_DB |
| 6775 |
|
</t> |
| 6776 |
|
</list> |
| 6777 |
|
</t> |
| 6778 |
<t>modal_arg = |
<t>modal_arg = |
| 6779 |
<list> |
<list> |
| 6780 |
<t>/* epsilon (empty argument) */ |
<t>/* epsilon (empty argument) */ |
| 6821 |
</t> |
</t> |
| 6822 |
<t>/ FX_SENDS SP sampler_channel |
<t>/ FX_SENDS SP sampler_channel |
| 6823 |
</t> |
</t> |
| 6824 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
| 6825 |
|
</t> |
| 6826 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
| 6827 |
|
</t> |
| 6828 |
|
<t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
| 6829 |
|
</t> |
| 6830 |
|
<t>/ DB_INSTRUMENTS SP db_path |
| 6831 |
</t> |
</t> |
| 6832 |
<t>/ DB_INSTRUMENTS SP pathname |
<t>/ FILE SP INSTRUMENTS SP filename |
| 6833 |
</t> |
</t> |
| 6834 |
</list> |
</list> |
| 6835 |
</t> |
</t> |
| 6951 |
</t> |
</t> |
| 6952 |
</list> |
</list> |
| 6953 |
</t> |
</t> |
| 6954 |
<t>pathname = |
<t>filename = |
|
<list> |
|
|
<t>stringval |
|
|
</t> |
|
|
</list> |
|
|
</t> |
|
|
<t>dirname = |
|
| 6955 |
<list> |
<list> |
| 6956 |
<t>stringval |
<t>path |
| 6957 |
</t> |
</t> |
| 6958 |
</list> |
</list> |
| 6959 |
</t> |
</t> |
| 6960 |
<t>filename = |
<t>db_path = |
| 6961 |
<list> |
<list> |
| 6962 |
<t>stringval |
<t>path |
| 6963 |
</t> |
</t> |
| 6964 |
</list> |
</list> |
| 6965 |
</t> |
</t> |
| 6966 |
<t>map_name = |
<t>map_name = |
| 6967 |
<list> |
<list> |
| 6968 |
<t>stringval |
<t>stringval_escaped |
| 6969 |
</t> |
</t> |
| 6970 |
</list> |
</list> |
| 6971 |
</t> |
</t> |
| 6972 |
<t>entry_name = |
<t>entry_name = |
| 6973 |
<list> |
<list> |
| 6974 |
<t>stringval |
<t>stringval_escaped |
| 6975 |
</t> |
</t> |
| 6976 |
</list> |
</list> |
| 6977 |
</t> |
</t> |
| 6978 |
<t>fx_send_name = |
<t>fx_send_name = |
| 6979 |
<list> |
<list> |
| 6980 |
<t>stringval |
<t>stringval_escaped |
| 6981 |
</t> |
</t> |
| 6982 |
</list> |
</list> |
| 6983 |
</t> |
</t> |
| 6989 |
</t> |
</t> |
| 6990 |
</list> |
</list> |
| 6991 |
</t> |
</t> |
| 6992 |
|
|
| 6993 |
<t>param_val = |
<t>param_val = |
| 6994 |
<list> |
<list> |
| 6995 |
<t>string |
<t>string |
| 7002 |
</t> |
</t> |
| 7003 |
</list> |
</list> |
| 7004 |
</t> |
</t> |
| 7005 |
|
<t>query_val_list = |
| 7006 |
|
<list> |
| 7007 |
|
<t>string '=' query_val |
| 7008 |
|
</t> |
| 7009 |
|
<t>/ query_val_list SP string '=' query_val |
| 7010 |
|
</t> |
| 7011 |
|
</list> |
| 7012 |
|
</t> |
| 7013 |
|
<t>query_val = |
| 7014 |
|
<list> |
| 7015 |
|
<t>text_escaped |
| 7016 |
|
</t> |
| 7017 |
|
<t>/ stringval_escaped |
| 7018 |
|
</t> |
| 7019 |
|
</list> |
| 7020 |
|
</t> |
| 7021 |
|
<t>scan_mode = |
| 7022 |
|
<list> |
| 7023 |
|
<t>RECURSIVE |
| 7024 |
|
</t> |
| 7025 |
|
<t>/ NON_RECURSIVE |
| 7026 |
|
</t> |
| 7027 |
|
<t>/ FLAT |
| 7028 |
|
</t> |
| 7029 |
|
</list> |
| 7030 |
|
</t> |
| 7031 |
|
|
| 7032 |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
| 7033 |
|
|
| 7034 |
|
<section title="Character Set and Escape Sequences" anchor="character_set"> |
| 7035 |
|
<t>Older versions of this protocol up to and including v1.1 only |
| 7036 |
|
supported the standard ASCII character set (ASCII code 0 - 127) |
| 7037 |
|
<xref target="RFC20"/>, all younger versions of this protocol |
| 7038 |
|
however support the Extended ASCII character set (ASCII code |
| 7039 |
|
0 - 255). The same group of younger protocols also support |
| 7040 |
|
escape sequences, but only for certain, explicitly declared |
| 7041 |
|
parts of the protocol. The supported escape sequences are |
| 7042 |
|
defined as follows:</t> |
| 7043 |
|
<texttable> |
| 7044 |
|
<ttcol>ASCII Character Sequence</ttcol> |
| 7045 |
|
<ttcol>Translated into (Name)</ttcol> |
| 7046 |
|
<c>\n</c> <c>new line</c> |
| 7047 |
|
<c>\r</c> <c>carriage return</c> |
| 7048 |
|
<c>\f</c> <c>form feed</c> |
| 7049 |
|
<c>\t</c> <c>horizontal tab</c> |
| 7050 |
|
<c>\v</c> <c>vertical tab</c> |
| 7051 |
|
<c>\'</c> <c>apostrophe</c> |
| 7052 |
|
<c>\"</c> <c>quotation mark</c> |
| 7053 |
|
<c>\\</c> <c>backslash</c> |
| 7054 |
|
<c>\OOO</c> <c>three digit octal ASCII code of the character</c> |
| 7055 |
|
<c>\xHH</c> <c>two digit hex ASCII code of the character</c> |
| 7056 |
|
</texttable> |
| 7057 |
|
<t>Notice: due to the transition of certain parts of the |
| 7058 |
|
protocol which now support escape sequences, a slight backward |
| 7059 |
|
incompatibility to protocols version v1.1 and younger has been |
| 7060 |
|
introduced. The only difference is that in parts of the protocol |
| 7061 |
|
where escape characters are now supported, a backslash characters |
| 7062 |
|
MUST be escaped as well (that is as double backslash), whereas |
| 7063 |
|
in the old versions a single backslash was sufficient.</t> |
| 7064 |
|
|
| 7065 |
|
<t>The following LSCP commands support escape sequences as part |
| 7066 |
|
of their filename / path based arguments and / or may contain |
| 7067 |
|
a filename / path with escape sequences in their response: |
| 7068 |
|
<list> |
| 7069 |
|
<t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t> |
| 7070 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
| 7071 |
|
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
| 7072 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
| 7073 |
|
<t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t> |
| 7074 |
|
<t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t> |
| 7075 |
|
<t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
| 7076 |
|
<t><xref target="REMOVE DB_INSTRUMENT">"REMOVE DB_INSTRUMENT"</xref></t> |
| 7077 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORIES">"GET DB_INSTRUMENT_DIRECTORIES"</xref></t> |
| 7078 |
|
<t><xref target="LIST DB_INSTRUMENT_DIRECTORIES">"LIST DB_INSTRUMENT_DIRECTORIES"</xref></t> |
| 7079 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
| 7080 |
|
<t><xref target="GET DB_INSTRUMENTS">"GET DB_INSTRUMENTS"</xref></t> |
| 7081 |
|
<t><xref target="LIST DB_INSTRUMENTS">"LIST DB_INSTRUMENTS"</xref></t> |
| 7082 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
| 7083 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
| 7084 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
| 7085 |
|
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
| 7086 |
|
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
| 7087 |
|
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
| 7088 |
|
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
| 7089 |
|
<t><xref target="MOVE DB_INSTRUMENT">"MOVE DB_INSTRUMENT"</xref></t> |
| 7090 |
|
<t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
| 7091 |
|
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
| 7092 |
|
<t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t> |
| 7093 |
|
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
| 7094 |
|
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
| 7095 |
|
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
| 7096 |
|
</list> |
| 7097 |
|
Note that the forward slash character ('/') has a special meaning in |
| 7098 |
|
filename / path based arguments: it acts as separator of the nodes in |
| 7099 |
|
the path, thus if a directory- or filename includes a forward slash |
| 7100 |
|
(not intended as path node separator), you MUST escape that slash |
| 7101 |
|
either with the respective hex escape sequence ("\x2f") or with the |
| 7102 |
|
respective octal escape sequence ("\057"). |
| 7103 |
|
</t> |
| 7104 |
|
|
| 7105 |
|
<t> |
| 7106 |
|
Note for Windows: file path arguments in LSCP are expected |
| 7107 |
|
to use forward slashes as directory node separator similar |
| 7108 |
|
to Unix based operating systems. In contrast to Unix however |
| 7109 |
|
a Windows typical drive character is expected to be |
| 7110 |
|
prefixed to the path. That is an original Windows file path |
| 7111 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
| 7112 |
|
"D:/Sounds/My.gig". |
| 7113 |
|
</t> |
| 7114 |
|
|
| 7115 |
|
<t> |
| 7116 |
|
The following LSCP commands even support escape sequences as |
| 7117 |
|
part of at least one of their text-based arguments (i.e. entity name, |
| 7118 |
|
description) and / or may contain escape sequences in at least one of |
| 7119 |
|
their text-based fields in their response: |
| 7120 |
|
<list> |
| 7121 |
|
<t><xref target="GET SERVER INFO">"GET SERVER INFO"</xref></t> |
| 7122 |
|
<t><xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref></t> |
| 7123 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
| 7124 |
|
<t><xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref></t> |
| 7125 |
|
<t><xref target="GET FX_SEND INFO">"GET FX_SEND INFO"</xref></t> |
| 7126 |
|
<t><xref target="SET FX_SEND NAME">"SET FX_SEND NAME"</xref></t> |
| 7127 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
| 7128 |
|
<t><xref target="GET MIDI_INSTRUMENT_MAP INFO">"GET MIDI_INSTRUMENT_MAP INFO"</xref></t> |
| 7129 |
|
<t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t> |
| 7130 |
|
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
| 7131 |
|
<t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t> |
| 7132 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
| 7133 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
| 7134 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
| 7135 |
|
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
| 7136 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
| 7137 |
|
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
| 7138 |
|
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
| 7139 |
|
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
| 7140 |
|
</list> |
| 7141 |
|
Please note that these lists are manually maintained. If you |
| 7142 |
|
find a command that also supports escape sequences we forgot to |
| 7143 |
|
mention here, please report it! |
| 7144 |
|
</t> |
| 7145 |
|
</section> |
| 7146 |
</section> |
</section> |
| 7147 |
|
|
| 7148 |
<section title="Events" anchor="events"> |
<section title="Events" anchor="events"> |
| 7246 |
of sampler channels.</t> |
of sampler channels.</t> |
| 7247 |
</section> |
</section> |
| 7248 |
|
|
| 7249 |
|
<section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI"> |
| 7250 |
|
<t>Client may want to be notified when MIDI data arrive on sampler channels on |
| 7251 |
|
back-end side, by issuing the following command:</t> |
| 7252 |
|
<t> |
| 7253 |
|
<list> |
| 7254 |
|
<t>SUBSCRIBE CHANNEL_MIDI</t> |
| 7255 |
|
</list> |
| 7256 |
|
</t> |
| 7257 |
|
<t>Server will start sending one of the the following notification messages:</t> |
| 7258 |
|
<t> |
| 7259 |
|
<list> |
| 7260 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"</t> |
| 7261 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>"</t> |
| 7262 |
|
</list> |
| 7263 |
|
</t> |
| 7264 |
|
<t>where <channel-id> will be replaced by the ID of the sampler channel where the MIDI |
| 7265 |
|
data arrived. <note> and <velocity> are integer values in the range between |
| 7266 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
| 7267 |
|
</t> |
| 7268 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
| 7269 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
| 7270 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
| 7271 |
|
thread unaffected by this feature.</t> |
| 7272 |
|
</section> |
| 7273 |
|
|
| 7274 |
|
<section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI"> |
| 7275 |
|
<t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t> |
| 7276 |
|
<t> |
| 7277 |
|
<list> |
| 7278 |
|
<t>SUBSCRIBE DEVICE_MIDI</t> |
| 7279 |
|
</list> |
| 7280 |
|
</t> |
| 7281 |
|
<t>Server will start sending one of the the following notification messages:</t> |
| 7282 |
|
<t> |
| 7283 |
|
<list> |
| 7284 |
|
<t>"NOTIFY:CHANNEL_MIDI:<device-id> <port-id> NOTE_ON <note> <velocity>"</t> |
| 7285 |
|
<t>"NOTIFY:CHANNEL_MIDI:<device-id> <port-id> NOTE_OFF <note> <velocity>"</t> |
| 7286 |
|
</list> |
| 7287 |
|
</t> |
| 7288 |
|
<t>where <device-id> <port-id> will be replaced |
| 7289 |
|
by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI |
| 7290 |
|
data arrived. <note> and <velocity> are integer values in the range between |
| 7291 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
| 7292 |
|
</t> |
| 7293 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
| 7294 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
| 7295 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
| 7296 |
|
thread unaffected by this feature.</t> |
| 7297 |
|
</section> |
| 7298 |
|
|
| 7299 |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
| 7300 |
<t>Client may want to be notified when the number of voices on the |
<t>Client may want to be notified when the number of voices on the |
| 7301 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
| 7378 |
</section> |
</section> |
| 7379 |
|
|
| 7380 |
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
| 7381 |
<t>Client may want to be notified when the number of effect sends on |
<t>Client may want to be notified when the number of effect sends on |
| 7382 |
a particular sampler channel is changed by issuing the following command:</t> |
a particular sampler channel is changed by issuing the following command:</t> |
| 7383 |
<t> |
<t> |
| 7384 |
<list> |
<list> |
| 7433 |
all currently active voices.</t> |
all currently active voices.</t> |
| 7434 |
</section> |
</section> |
| 7435 |
|
|
| 7436 |
|
<section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT"> |
| 7437 |
|
<t>Client may want to be notified when the total number of disk streams on the |
| 7438 |
|
back-end changes by issuing the following command:</t> |
| 7439 |
|
<t> |
| 7440 |
|
<list> |
| 7441 |
|
<t>SUBSCRIBE TOTAL_STREAM_COUNT</t> |
| 7442 |
|
</list> |
| 7443 |
|
</t> |
| 7444 |
|
<t>Server will start sending the following notification messages:</t> |
| 7445 |
|
<t> |
| 7446 |
|
<list> |
| 7447 |
|
<t>"NOTIFY:TOTAL_STREAM_COUNT:<streams>"</t> |
| 7448 |
|
</list> |
| 7449 |
|
</t> |
| 7450 |
|
<t>where <streams> will be replaced by the new number of |
| 7451 |
|
all currently active disk streams.</t> |
| 7452 |
|
</section> |
| 7453 |
|
|
| 7454 |
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
| 7455 |
<t>Client may want to be notified when the number of MIDI instrument maps on the |
<t>Client may want to be notified when the number of MIDI instrument maps on the |
| 7456 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
| 7656 |
the new name of the instrument, encapsulated into apostrophes.</t> |
the new name of the instrument, encapsulated into apostrophes.</t> |
| 7657 |
</section> |
</section> |
| 7658 |
|
|
| 7659 |
|
<section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"> |
| 7660 |
|
<t>Client may want to be notified when the status of particular database |
| 7661 |
|
instruments job is changed by issuing the following command:</t> |
| 7662 |
|
<t> |
| 7663 |
|
<list> |
| 7664 |
|
<t>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO</t> |
| 7665 |
|
</list> |
| 7666 |
|
</t> |
| 7667 |
|
<t>Server will start sending the following notification messages:</t> |
| 7668 |
|
<t> |
| 7669 |
|
<list> |
| 7670 |
|
<t>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>"</t> |
| 7671 |
|
</list> |
| 7672 |
|
</t> |
| 7673 |
|
<t>where <job-id> will be replaced by the numerical ID of the job, |
| 7674 |
|
which status is changed. The front-end will have to send the respective |
| 7675 |
|
command to actually get the status info. Because these messages |
| 7676 |
|
will be triggered by LSCP commands issued by other clients rather than real |
| 7677 |
|
time events happening on the server, it is believed that an empty notification |
| 7678 |
|
message is sufficient here.</t> |
| 7679 |
|
</section> |
| 7680 |
|
|
| 7681 |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
| 7682 |
<t>Client may want to be notified of miscellaneous and debugging events occurring at |
<t>Client may want to be notified of miscellaneous and debugging events occurring at |
| 7683 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |
| 7756 |
</front> |
</front> |
| 7757 |
<seriesInfo name="RFC" value="2234" /> |
<seriesInfo name="RFC" value="2234" /> |
| 7758 |
</reference> |
</reference> |
| 7759 |
|
<reference anchor="RFC20"> |
| 7760 |
|
<front> |
| 7761 |
|
<title>ASCII format for Network Interchange</title> |
| 7762 |
|
<author> |
| 7763 |
|
<organization>UCLA</organization> |
| 7764 |
|
</author> |
| 7765 |
|
<date year="1969"></date> |
| 7766 |
|
</front> |
| 7767 |
|
<seriesInfo name="RFC" value="20" /> |
| 7768 |
|
</reference> |
| 7769 |
</references> |
</references> |
| 7770 |
</back> |
</back> |
| 7771 |
|
|
Parent Directory
| 
Revision Log
| 
Patch