| 11 |
<?rfc symrefs="yes" ?> |
<?rfc symrefs="yes" ?> |
| 12 |
<?rfc sortrefs="yes"?> |
<?rfc sortrefs="yes"?> |
| 13 |
<?rfc iprnotified="no" ?> |
<?rfc iprnotified="no" ?> |
|
<?rfc strict="yes" ?> |
|
| 14 |
|
|
| 15 |
<rfc category="std" ipr="full2026" docName="LSCP 1.1"> |
<!-- FIXME: next attribute should actually be "yes", temporarily disbled due |
| 16 |
|
to an annoying "missing Normative/Informative References" error message --> |
| 17 |
|
<?rfc strict="no" ?> |
| 18 |
|
|
| 19 |
|
<rfc category="std" ipr="full3978" docName="LSCP 1.2"> |
| 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="July" year="2005"/> |
<date month="March" year="2007"/> |
| 38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
| 39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
| 40 |
<abstract> |
<abstract> |
| 2555 |
<t>VOLUME - |
<t>VOLUME - |
| 2556 |
<list> |
<list> |
| 2557 |
<t>optionally dotted number for the channel volume factor |
<t>optionally dotted number for the channel volume factor |
| 2558 |
(where a value < 1.0 means attenuation and a value > |
(where a value < 1.0 means attenuation and a value > |
| 2559 |
1.0 means amplification)</t> |
1.0 means amplification)</t> |
| 2560 |
</list> |
</list> |
| 2561 |
</t> |
</t> |
| 2574 |
the channel is a solo channel; "false" otherwise</t> |
the channel is a solo channel; "false" otherwise</t> |
| 2575 |
</list> |
</list> |
| 2576 |
</t> |
</t> |
| 2577 |
|
<t>MIDI_INSTRUMENT_MAP - |
| 2578 |
|
<list> |
| 2579 |
|
<t>Determines to which MIDI instrument map this sampler |
| 2580 |
|
channel is assigned to. Read chapter |
| 2581 |
|
<xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref> |
| 2582 |
|
for a list of possible values.</t> |
| 2583 |
|
</list> |
| 2584 |
|
</t> |
| 2585 |
</list> |
</list> |
| 2586 |
</t> |
</t> |
| 2587 |
</list> |
</list> |
| 2604 |
<t> "MIDI_INPUT_DEVICE: 0"</t> |
<t> "MIDI_INPUT_DEVICE: 0"</t> |
| 2605 |
<t> "MIDI_INPUT_PORT: 0"</t> |
<t> "MIDI_INPUT_PORT: 0"</t> |
| 2606 |
<t> "MIDI_INPUT_CHANNEL: 5"</t> |
<t> "MIDI_INPUT_CHANNEL: 5"</t> |
| 2607 |
|
<t> "VOLUME: 1.0"</t> |
| 2608 |
|
<t> "MUTE: false"</t> |
| 2609 |
|
<t> "SOLO: false"</t> |
| 2610 |
|
<t> "MIDI_INSTRUMENT_MAP: NONE"</t> |
| 2611 |
<t> "."</t> |
<t> "."</t> |
| 2612 |
</list> |
</list> |
| 2613 |
</t> |
</t> |
| 2768 |
</t> |
</t> |
| 2769 |
</section> |
</section> |
| 2770 |
|
|
| 2771 |
<section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYP"> |
<section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYPE"> |
| 2772 |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
| 2773 |
|
|
| 2774 |
<t>The front-end can alter the audio output type on a specific sampler |
<t>The front-end can alter the audio output type on a specific sampler |
| 3159 |
</t> |
</t> |
| 3160 |
</section> |
</section> |
| 3161 |
|
|
| 3162 |
|
<section title="Assigning a MIDI instrument map to a sampler channel" anchor="SET CHANNEL MIDI_INSTRUMENT_MAP"> |
| 3163 |
|
<t>The front-end can assign a MIDI instrument map to a specific sampler channel |
| 3164 |
|
by sending the following command:</t> |
| 3165 |
|
<t> |
| 3166 |
|
<list> |
| 3167 |
|
<t>SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <map></t> |
| 3168 |
|
</list> |
| 3169 |
|
</t> |
| 3170 |
|
<t>Where <sampler-channel> is the respective sampler channel |
| 3171 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3172 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
| 3173 |
|
<map> can have the following possibilites:</t> |
| 3174 |
|
<t> |
| 3175 |
|
<list> |
| 3176 |
|
<t>"NONE" - |
| 3177 |
|
<list> |
| 3178 |
|
<t>This is the default setting. In this case |
| 3179 |
|
the sampler channel is not assigned any MIDI |
| 3180 |
|
instrument map and thus will ignore all MIDI |
| 3181 |
|
program change messages.</t> |
| 3182 |
|
</list> |
| 3183 |
|
</t> |
| 3184 |
|
<t>"DEFAULT" - |
| 3185 |
|
<list> |
| 3186 |
|
<t>The sampler channel will always use the |
| 3187 |
|
default MIDI instrument map to handle MIDI |
| 3188 |
|
program change messages.</t> |
| 3189 |
|
</list> |
| 3190 |
|
</t> |
| 3191 |
|
<t>numeric ID - |
| 3192 |
|
<list> |
| 3193 |
|
<t>You can assign a specific MIDI instrument map |
| 3194 |
|
by replacing <map> with the respective numeric |
| 3195 |
|
ID of the MIDI instrument map as returned by the |
| 3196 |
|
<xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref> |
| 3197 |
|
command. Once that map will be deleted, the sampler |
| 3198 |
|
channel would fall back to "NONE".</t> |
| 3199 |
|
</list> |
| 3200 |
|
</t> |
| 3201 |
|
</list> |
| 3202 |
|
</t> |
| 3203 |
|
<t>Read chapter <xref target="MIDI Instrument Mapping">"MIDI Instrument Mapping"</xref> |
| 3204 |
|
for details regarding MIDI instrument mapping.</t> |
| 3205 |
|
|
| 3206 |
|
<t>Possible Answers:</t> |
| 3207 |
|
<t> |
| 3208 |
|
<list> |
| 3209 |
|
<t>"OK" - |
| 3210 |
|
<list> |
| 3211 |
|
<t>on success</t> |
| 3212 |
|
</list> |
| 3213 |
|
</t> |
| 3214 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3215 |
|
<list> |
| 3216 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 3217 |
|
</list> |
| 3218 |
|
</t> |
| 3219 |
|
</list> |
| 3220 |
|
</t> |
| 3221 |
|
|
| 3222 |
|
<t>Examples:</t> |
| 3223 |
|
<t> |
| 3224 |
|
<list> |
| 3225 |
|
<t></t> |
| 3226 |
|
</list> |
| 3227 |
|
</t> |
| 3228 |
|
</section> |
| 3229 |
|
|
| 3230 |
|
<section title="Adding an effect send to a sampler channel" anchor="CREATE FX_SEND"> |
| 3231 |
|
<t>The front-end can create an additional effect send on a specific sampler channel |
| 3232 |
|
by sending the following command:</t> |
| 3233 |
|
<t> |
| 3234 |
|
<list> |
| 3235 |
|
<t>CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>]</t> |
| 3236 |
|
</list> |
| 3237 |
|
</t> |
| 3238 |
|
<t>Where <sampler-channel> is the respective sampler channel |
| 3239 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3240 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the |
| 3241 |
|
sampler channel on which the effect send should be created on, <midi-ctrl> |
| 3242 |
|
is a number between 0..127 defining the MIDI controller which can alter the |
| 3243 |
|
effect send level and <name> is an optional argument defining a name |
| 3244 |
|
for the effect send entity. The name does not have to be unique.</t> |
| 3245 |
|
|
| 3246 |
|
<t>By default, that is as initial routing, the effect send's audio channels |
| 3247 |
|
are automatically routed to the last audio channels of the sampler channel's |
| 3248 |
|
audio output device, that way you can i.e. first increase the amount of audio |
| 3249 |
|
channels on the audio output device for having dedicated effect send output |
| 3250 |
|
channels and when "CREATE FX_SEND" is called, those channels will automatically |
| 3251 |
|
be picked. You can alter the destination channels however with |
| 3252 |
|
<xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>. |
| 3253 |
|
</t> |
| 3254 |
|
|
| 3255 |
|
<t>Note: Create effect sends on a sampler channel only when needed, because having effect |
| 3256 |
|
sends on a sampler channel will decrease runtime performance, because for implementing channel |
| 3257 |
|
effect sends, separate (sampler channel local) audio buffers are needed to render and mix |
| 3258 |
|
the voices and route the audio signal afterwards to the master outputs and effect send |
| 3259 |
|
outputs (along with their respective effect send levels). A sampler channel without effect |
| 3260 |
|
sends however can mix its voices directly into the audio output devices's audio buffers |
| 3261 |
|
and is thus faster. |
| 3262 |
|
</t> |
| 3263 |
|
|
| 3264 |
|
<t>Possible Answers:</t> |
| 3265 |
|
<t> |
| 3266 |
|
<list> |
| 3267 |
|
<t>"OK[<fx-send-id>]" - |
| 3268 |
|
<list> |
| 3269 |
|
<t>in case a new effect send could be added to the |
| 3270 |
|
sampler channel, where <fx-send-id> reflects the |
| 3271 |
|
unique ID of the newly created effect send entity</t> |
| 3272 |
|
</list> |
| 3273 |
|
</t> |
| 3274 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3275 |
|
<list> |
| 3276 |
|
<t>when a new effect send could not be added, i.e. |
| 3277 |
|
due to invalid parameters</t> |
| 3278 |
|
</list> |
| 3279 |
|
</t> |
| 3280 |
|
</list> |
| 3281 |
|
</t> |
| 3282 |
|
|
| 3283 |
|
<t>Examples:</t> |
| 3284 |
|
<t> |
| 3285 |
|
<list> |
| 3286 |
|
<t>C: "CREATE FX_SEND 0 91 'Reverb Send'"</t> |
| 3287 |
|
<t>S: "OK[0]"</t> |
| 3288 |
|
</list> |
| 3289 |
|
</t> |
| 3290 |
|
<t> |
| 3291 |
|
<list> |
| 3292 |
|
<t>C: "CREATE FX_SEND 0 93"</t> |
| 3293 |
|
<t>S: "OK[1]"</t> |
| 3294 |
|
</list> |
| 3295 |
|
</t> |
| 3296 |
|
</section> |
| 3297 |
|
|
| 3298 |
|
<section title="Removing an effect send from a sampler channel" anchor="DESTROY FX_SEND"> |
| 3299 |
|
<t>The front-end can remove an existing effect send on a specific sampler channel |
| 3300 |
|
by sending the following command:</t> |
| 3301 |
|
<t> |
| 3302 |
|
<list> |
| 3303 |
|
<t>DESTROY FX_SEND <sampler-channel> <fx-send-id></t> |
| 3304 |
|
</list> |
| 3305 |
|
</t> |
| 3306 |
|
<t>Where <sampler-channel> is the respective sampler channel |
| 3307 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3308 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the |
| 3309 |
|
sampler channel from which the effect send should be removed from and |
| 3310 |
|
<fx-send-id> is the respective effect send number as returned by the |
| 3311 |
|
<xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
| 3312 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t> |
| 3313 |
|
|
| 3314 |
|
<t>Possible Answers:</t> |
| 3315 |
|
<t> |
| 3316 |
|
<list> |
| 3317 |
|
<t>"OK" - |
| 3318 |
|
<list> |
| 3319 |
|
<t>on success</t> |
| 3320 |
|
</list> |
| 3321 |
|
</t> |
| 3322 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3323 |
|
<list> |
| 3324 |
|
<t>in case it failed, providing an appropriate error code and |
| 3325 |
|
error message</t> |
| 3326 |
|
</list> |
| 3327 |
|
</t> |
| 3328 |
|
</list> |
| 3329 |
|
</t> |
| 3330 |
|
|
| 3331 |
|
<t>Example:</t> |
| 3332 |
|
<t> |
| 3333 |
|
<list> |
| 3334 |
|
<t>C: "DESTROY FX_SEND 0 0"</t> |
| 3335 |
|
<t>S: "OK"</t> |
| 3336 |
|
</list> |
| 3337 |
|
</t> |
| 3338 |
|
</section> |
| 3339 |
|
|
| 3340 |
|
<section title="Getting amount of effect sends on a sampler channel" anchor="GET FX_SENDS"> |
| 3341 |
|
<t>The front-end can ask for the amount of effect sends on a specific sampler channel |
| 3342 |
|
by sending the following command:</t> |
| 3343 |
|
<t> |
| 3344 |
|
<list> |
| 3345 |
|
<t>GET FX_SENDS <sampler-channel></t> |
| 3346 |
|
</list> |
| 3347 |
|
</t> |
| 3348 |
|
<t>Where <sampler-channel> is the respective sampler channel |
| 3349 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3350 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
| 3351 |
|
|
| 3352 |
|
<t>Possible Answers:</t> |
| 3353 |
|
<t> |
| 3354 |
|
<list> |
| 3355 |
|
<t>The sampler will answer by returning the number of effect |
| 3356 |
|
sends on the given sampler channel.</t> |
| 3357 |
|
</list> |
| 3358 |
|
</t> |
| 3359 |
|
|
| 3360 |
|
<t>Example:</t> |
| 3361 |
|
<t> |
| 3362 |
|
<list> |
| 3363 |
|
<t>C: "GET FX_SENDS 0"</t> |
| 3364 |
|
<t>S: "2"</t> |
| 3365 |
|
</list> |
| 3366 |
|
</t> |
| 3367 |
|
</section> |
| 3368 |
|
|
| 3369 |
|
<section title="Listing all effect sends on a sampler channel" anchor="LIST FX_SENDS"> |
| 3370 |
|
<t>The front-end can ask for a list of effect sends on a specific sampler channel |
| 3371 |
|
by sending the following command:</t> |
| 3372 |
|
<t> |
| 3373 |
|
<list> |
| 3374 |
|
<t>LIST FX_SENDS <sampler-channel></t> |
| 3375 |
|
</list> |
| 3376 |
|
</t> |
| 3377 |
|
<t>Where <sampler-channel> is the respective sampler channel |
| 3378 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3379 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
| 3380 |
|
|
| 3381 |
|
<t>Possible Answers:</t> |
| 3382 |
|
<t> |
| 3383 |
|
<list> |
| 3384 |
|
<t>The sampler will answer by returning a comma separated list |
| 3385 |
|
with all effect sends' numerical IDs on the given sampler |
| 3386 |
|
channel.</t> |
| 3387 |
|
</list> |
| 3388 |
|
</t> |
| 3389 |
|
|
| 3390 |
|
<t>Examples:</t> |
| 3391 |
|
<t> |
| 3392 |
|
<list> |
| 3393 |
|
<t>C: "LIST FX_SENDS 0"</t> |
| 3394 |
|
<t>S: "0,1"</t> |
| 3395 |
|
</list> |
| 3396 |
|
</t> |
| 3397 |
|
<t> |
| 3398 |
|
<list> |
| 3399 |
|
<t>C: "LIST FX_SENDS 1"</t> |
| 3400 |
|
<t>S: ""</t> |
| 3401 |
|
</list> |
| 3402 |
|
</t> |
| 3403 |
|
</section> |
| 3404 |
|
|
| 3405 |
|
<section title="Getting effect send information" anchor="GET FX_SEND INFO"> |
| 3406 |
|
<t>The front-end can ask for the current settings of an effect send entity |
| 3407 |
|
by sending the following command:</t> |
| 3408 |
|
<t> |
| 3409 |
|
<list> |
| 3410 |
|
<t>GET FX_SEND INFO <sampler-channel> <fx-send-id></t> |
| 3411 |
|
</list> |
| 3412 |
|
</t> |
| 3413 |
|
<t>Where <sampler-channel> is the sampler channel number |
| 3414 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3415 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
| 3416 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
| 3417 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
| 3418 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command. |
| 3419 |
|
</t> |
| 3420 |
|
|
| 3421 |
|
<t>Possible Answers:</t> |
| 3422 |
|
<t> |
| 3423 |
|
<list> |
| 3424 |
|
<t>The sampler will answer by sending a <CRLF> separated list. |
| 3425 |
|
Each answer line begins with the settings category name |
| 3426 |
|
followed by a colon and then a space character <SP> and finally |
| 3427 |
|
the info character string to that setting category. At the |
| 3428 |
|
moment the following categories are defined:</t> |
| 3429 |
|
|
| 3430 |
|
<t> |
| 3431 |
|
<list> |
| 3432 |
|
<t>NAME - |
| 3433 |
|
<list> |
| 3434 |
|
<t>name of the effect send entity</t> |
| 3435 |
|
</list> |
| 3436 |
|
</t> |
| 3437 |
|
<t>MIDI_CONTROLLER - |
| 3438 |
|
<list> |
| 3439 |
|
<t>a value between 0 and 127 reflecting the MIDI controller |
| 3440 |
|
which is able to modify the effect send's send level</t> |
| 3441 |
|
</list> |
| 3442 |
|
</t> |
| 3443 |
|
<t>LEVEL - |
| 3444 |
|
<list> |
| 3445 |
|
<t>optionally dotted number reflecting the effect send's |
| 3446 |
|
current send level (where a value < 1.0 means attenuation |
| 3447 |
|
and a value > 1.0 means amplification)</t> |
| 3448 |
|
</list> |
| 3449 |
|
</t> |
| 3450 |
|
<t>AUDIO_OUTPUT_ROUTING - |
| 3451 |
|
<list> |
| 3452 |
|
<t>comma separated list which reflects to which audio |
| 3453 |
|
channel of the selected audio output device each |
| 3454 |
|
effect send output channel is routed to, e.g. "0,3" would |
| 3455 |
|
mean the effect send's output channel 0 is routed to channel |
| 3456 |
|
0 of the audio output device and the effect send's output |
| 3457 |
|
channel 1 is routed to the channel 3 of the audio |
| 3458 |
|
output device (see |
| 3459 |
|
<xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref> |
| 3460 |
|
for details)</t> |
| 3461 |
|
</list> |
| 3462 |
|
</t> |
| 3463 |
|
</list> |
| 3464 |
|
</t> |
| 3465 |
|
</list> |
| 3466 |
|
</t> |
| 3467 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
| 3468 |
|
|
| 3469 |
|
<t>Example:</t> |
| 3470 |
|
<t> |
| 3471 |
|
<list> |
| 3472 |
|
<t>C: "GET FX_SEND INFO 0 0"</t> |
| 3473 |
|
<t>S: "NAME: Reverb Send"</t> |
| 3474 |
|
<t> "MIDI_CONTROLLER: 91"</t> |
| 3475 |
|
<t> "LEVEL: 0.3"</t> |
| 3476 |
|
<t> "AUDIO_OUTPUT_ROUTING: 2,3"</t> |
| 3477 |
|
<t> "."</t> |
| 3478 |
|
</list> |
| 3479 |
|
</t> |
| 3480 |
|
</section> |
| 3481 |
|
|
| 3482 |
|
<section title="Changing effect send's name" anchor="SET FX_SEND NAME"> |
| 3483 |
|
<t>The front-end can alter the current name of an effect |
| 3484 |
|
send entity by sending the following command:</t> |
| 3485 |
|
<t> |
| 3486 |
|
<list> |
| 3487 |
|
<t>SET FX_SEND NAME <sampler-chan> <fx-send-id> <name></t> |
| 3488 |
|
</list> |
| 3489 |
|
</t> |
| 3490 |
|
<t>Where <sampler-chan> is the sampler channel number |
| 3491 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3492 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
| 3493 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
| 3494 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
| 3495 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
| 3496 |
|
<name> is the new name of the effect send entity, which |
| 3497 |
|
does not have to be unique.</t> |
| 3498 |
|
|
| 3499 |
|
<t>Possible Answers:</t> |
| 3500 |
|
<t> |
| 3501 |
|
<list> |
| 3502 |
|
<t>"OK" - |
| 3503 |
|
<list> |
| 3504 |
|
<t>on success</t> |
| 3505 |
|
</list> |
| 3506 |
|
</t> |
| 3507 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3508 |
|
<list> |
| 3509 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 3510 |
|
</list> |
| 3511 |
|
</t> |
| 3512 |
|
</list> |
| 3513 |
|
</t> |
| 3514 |
|
<t>Example:</t> |
| 3515 |
|
<t> |
| 3516 |
|
<list> |
| 3517 |
|
<t>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"</t> |
| 3518 |
|
<t>S: "OK"</t> |
| 3519 |
|
</list> |
| 3520 |
|
</t> |
| 3521 |
|
</section> |
| 3522 |
|
|
| 3523 |
|
<section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL"> |
| 3524 |
|
<t>The front-end can alter the destination of an effect send's audio channel on a specific |
| 3525 |
|
sampler channel by sending the following command:</t> |
| 3526 |
|
<t> |
| 3527 |
|
<list> |
| 3528 |
|
<t>SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id> <audio-src> <audio-dst></t> |
| 3529 |
|
</list> |
| 3530 |
|
</t> |
| 3531 |
|
<t>Where <sampler-chan> is the sampler channel number |
| 3532 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3533 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
| 3534 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
| 3535 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
| 3536 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command, |
| 3537 |
|
<audio-src> is the numerical ID of the effect send's audio channel |
| 3538 |
|
which should be rerouted and <audio-dst> is the numerical ID of |
| 3539 |
|
the audio channel of the selected audio output device where <audio-src> |
| 3540 |
|
should be routed to.</t> |
| 3541 |
|
|
| 3542 |
|
<t>Note that effect sends can only route audio to the same audio output |
| 3543 |
|
device as assigned to the effect send's sampler channel. Also note that an |
| 3544 |
|
effect send entity does always have exactly as much audio channels as its |
| 3545 |
|
sampler channel. So if the sampler channel is stereo, the effect send does |
| 3546 |
|
have two audio channels as well. Also keep in mind that the amount of audio |
| 3547 |
|
channels on a sampler channel might be dependant not only to the deployed |
| 3548 |
|
sampler engine on the sampler channel, but also dependant to the instrument |
| 3549 |
|
currently loaded. However you can (effectively) turn an i.e. stereo effect |
| 3550 |
|
send into a mono one by simply altering its audio routing appropriately.</t> |
| 3551 |
|
|
| 3552 |
|
<t>Possible Answers:</t> |
| 3553 |
|
<t> |
| 3554 |
|
<list> |
| 3555 |
|
<t>"OK" - |
| 3556 |
|
<list> |
| 3557 |
|
<t>on success</t> |
| 3558 |
|
</list> |
| 3559 |
|
</t> |
| 3560 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
| 3561 |
|
<list> |
| 3562 |
|
<t>if audio output channel was set, but there are noteworthy |
| 3563 |
|
issue(s) related, providing an appropriate warning code and |
| 3564 |
|
warning message</t> |
| 3565 |
|
</list> |
| 3566 |
|
</t> |
| 3567 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3568 |
|
<list> |
| 3569 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 3570 |
|
</list> |
| 3571 |
|
</t> |
| 3572 |
|
</list> |
| 3573 |
|
</t> |
| 3574 |
|
<t>Example:</t> |
| 3575 |
|
<t> |
| 3576 |
|
<list> |
| 3577 |
|
<t>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"</t> |
| 3578 |
|
<t>S: "OK"</t> |
| 3579 |
|
</list> |
| 3580 |
|
</t> |
| 3581 |
|
</section> |
| 3582 |
|
|
| 3583 |
|
<section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER"> |
| 3584 |
|
<t>The front-end can alter the MIDI controller of an effect |
| 3585 |
|
send entity by sending the following command:</t> |
| 3586 |
|
<t> |
| 3587 |
|
<list> |
| 3588 |
|
<t>SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-ctrl></t> |
| 3589 |
|
</list> |
| 3590 |
|
</t> |
| 3591 |
|
<t>Where <sampler-chan> is the sampler channel number |
| 3592 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3593 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
| 3594 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
| 3595 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
| 3596 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
| 3597 |
|
<midi-ctrl> reflects the MIDI controller which shall be |
| 3598 |
|
able to modify the effect send's send level.</t> |
| 3599 |
|
|
| 3600 |
|
<t>Possible Answers:</t> |
| 3601 |
|
<t> |
| 3602 |
|
<list> |
| 3603 |
|
<t>"OK" - |
| 3604 |
|
<list> |
| 3605 |
|
<t>on success</t> |
| 3606 |
|
</list> |
| 3607 |
|
</t> |
| 3608 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
| 3609 |
|
<list> |
| 3610 |
|
<t>if MIDI controller was set, but there are noteworthy |
| 3611 |
|
issue(s) related, providing an appropriate warning code and |
| 3612 |
|
warning message</t> |
| 3613 |
|
</list> |
| 3614 |
|
</t> |
| 3615 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3616 |
|
<list> |
| 3617 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 3618 |
|
</list> |
| 3619 |
|
</t> |
| 3620 |
|
</list> |
| 3621 |
|
</t> |
| 3622 |
|
<t>Example:</t> |
| 3623 |
|
<t> |
| 3624 |
|
<list> |
| 3625 |
|
<t>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"</t> |
| 3626 |
|
<t>S: "OK"</t> |
| 3627 |
|
</list> |
| 3628 |
|
</t> |
| 3629 |
|
</section> |
| 3630 |
|
|
| 3631 |
|
<section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL"> |
| 3632 |
|
<t>The front-end can alter the current send level of an effect |
| 3633 |
|
send entity by sending the following command:</t> |
| 3634 |
|
<t> |
| 3635 |
|
<list> |
| 3636 |
|
<t>SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume></t> |
| 3637 |
|
</list> |
| 3638 |
|
</t> |
| 3639 |
|
<t>Where <sampler-chan> is the sampler channel number |
| 3640 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
| 3641 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
| 3642 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
| 3643 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
| 3644 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
| 3645 |
|
<volume> is an optionally dotted positive number (a value |
| 3646 |
|
smaller than 1.0 means attenuation, whereas a value greater than |
| 3647 |
|
1.0 means amplification) reflecting the new send level.</t> |
| 3648 |
|
|
| 3649 |
|
<t>Possible Answers:</t> |
| 3650 |
|
<t> |
| 3651 |
|
<list> |
| 3652 |
|
<t>"OK" - |
| 3653 |
|
<list> |
| 3654 |
|
<t>on success</t> |
| 3655 |
|
</list> |
| 3656 |
|
</t> |
| 3657 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
| 3658 |
|
<list> |
| 3659 |
|
<t>if new send level was set, but there are noteworthy |
| 3660 |
|
issue(s) related, providing an appropriate warning code and |
| 3661 |
|
warning message</t> |
| 3662 |
|
</list> |
| 3663 |
|
</t> |
| 3664 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 3665 |
|
<list> |
| 3666 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 3667 |
|
</list> |
| 3668 |
|
</t> |
| 3669 |
|
</list> |
| 3670 |
|
</t> |
| 3671 |
|
<t>Example:</t> |
| 3672 |
|
<t> |
| 3673 |
|
<list> |
| 3674 |
|
<t>C: "SET FX_SEND LEVEL 0 0 0.15"</t> |
| 3675 |
|
<t>S: "OK"</t> |
| 3676 |
|
</list> |
| 3677 |
|
</t> |
| 3678 |
|
</section> |
| 3679 |
|
|
| 3680 |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
| 3681 |
<t>The front-end can reset a particular sampler channel by sending the following command:</t> |
<t>The front-end can reset a particular sampler channel by sending the following command:</t> |
| 3682 |
<t> |
<t> |
| 3862 |
<section title="Global commands"> |
<section title="Global commands"> |
| 3863 |
<t>The following commands have global impact on the sampler.</t> |
<t>The following commands have global impact on the sampler.</t> |
| 3864 |
|
|
| 3865 |
|
<section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT"> |
| 3866 |
|
<t>The front-end can ask for the current number of active voices on |
| 3867 |
|
the sampler by sending the following command:</t> |
| 3868 |
|
<t> |
| 3869 |
|
<list> |
| 3870 |
|
<t>GET TOTAL_VOICE_COUNT</t> |
| 3871 |
|
</list> |
| 3872 |
|
</t> |
| 3873 |
|
|
| 3874 |
|
<t>Possible Answers:</t> |
| 3875 |
|
<t> |
| 3876 |
|
<list> |
| 3877 |
|
<t>LinuxSampler will answer by returning the number of all active |
| 3878 |
|
voices on the sampler.</t> |
| 3879 |
|
</list> |
| 3880 |
|
</t> |
| 3881 |
|
</section> |
| 3882 |
|
|
| 3883 |
|
<section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX"> |
| 3884 |
|
<t>The front-end can ask for the maximum number of active voices |
| 3885 |
|
by sending the following command:</t> |
| 3886 |
|
<t> |
| 3887 |
|
<list> |
| 3888 |
|
<t>GET TOTAL_VOICE_COUNT_MAX</t> |
| 3889 |
|
</list> |
| 3890 |
|
</t> |
| 3891 |
|
|
| 3892 |
|
<t>Possible Answers:</t> |
| 3893 |
|
<t> |
| 3894 |
|
<list> |
| 3895 |
|
<t>LinuxSampler will answer by returning the maximum number |
| 3896 |
|
of active voices.</t> |
| 3897 |
|
</list> |
| 3898 |
|
</t> |
| 3899 |
|
</section> |
| 3900 |
|
|
| 3901 |
<section title="Reset sampler" anchor="RESET"> |
<section title="Reset sampler" anchor="RESET"> |
| 3902 |
<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> |
| 3903 |
<t> |
<t> |
| 3966 |
<t>The mentioned fields above don't have to be in particular order. |
<t>The mentioned fields above don't have to be in particular order. |
| 3967 |
Other fields might be added in future.</t> |
Other fields might be added in future.</t> |
| 3968 |
</section> |
</section> |
| 3969 |
|
|
| 3970 |
|
<section title="Getting global volume attenuation" anchor="GET VOLUME"> |
| 3971 |
|
<t>The client can ask for the current global sampler-wide volume |
| 3972 |
|
attenuation by sending the following command:</t> |
| 3973 |
|
<t> |
| 3974 |
|
<list> |
| 3975 |
|
<t>GET VOLUME</t> |
| 3976 |
|
</list> |
| 3977 |
|
</t> |
| 3978 |
|
<t>Possible Answers:</t> |
| 3979 |
|
<t> |
| 3980 |
|
<list> |
| 3981 |
|
<t>The sampler will always answer by returning the optional |
| 3982 |
|
dotted floating point coefficient, reflecting the current |
| 3983 |
|
global volume attenuation. |
| 3984 |
|
</t> |
| 3985 |
|
</list> |
| 3986 |
|
</t> |
| 3987 |
|
<t>Note: it is up to the respective sampler engine whether to obey |
| 3988 |
|
that global volume parameter or not, but in general all engines SHOULD |
| 3989 |
|
use this parameter.</t> |
| 3990 |
|
</section> |
| 3991 |
|
|
| 3992 |
|
<section title="Setting global volume attenuation" anchor="SET VOLUME"> |
| 3993 |
|
<t>The client can alter the current global sampler-wide volume |
| 3994 |
|
attenuation by sending the following command:</t> |
| 3995 |
|
<t> |
| 3996 |
|
<list> |
| 3997 |
|
<t>SET VOLUME <volume></t> |
| 3998 |
|
</list> |
| 3999 |
|
</t> |
| 4000 |
|
<t>Where <volume> should be replaced by the optional dotted |
| 4001 |
|
floating point value, reflecting the new global volume parameter. |
| 4002 |
|
This value might usually be in the range between 0.0 and 1.0, that |
| 4003 |
|
is for attenuating the overall volume.</t> |
| 4004 |
|
|
| 4005 |
|
<t>Possible Answers:</t> |
| 4006 |
|
<t> |
| 4007 |
|
<list> |
| 4008 |
|
<t>"OK" - |
| 4009 |
|
<list> |
| 4010 |
|
<t>on success</t> |
| 4011 |
|
</list> |
| 4012 |
|
</t> |
| 4013 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
| 4014 |
|
<list> |
| 4015 |
|
<t>if the global volume was set, but there are noteworthy |
| 4016 |
|
issue(s) related, providing an appropriate warning code and |
| 4017 |
|
warning message</t> |
| 4018 |
|
</list> |
| 4019 |
|
</t> |
| 4020 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 4021 |
|
<list> |
| 4022 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
| 4023 |
|
</list> |
| 4024 |
|
</t> |
| 4025 |
|
</list> |
| 4026 |
|
</t> |
| 4027 |
|
</section> |
| 4028 |
</section> |
</section> |
| 4029 |
|
|
| 4030 |
|
|
| 4031 |
|
<section title="MIDI Instrument Mapping" anchor="MIDI Instrument Mapping"> |
| 4032 |
|
<t>The MIDI protocol provides a way to switch between instruments |
| 4033 |
|
by sending so called MIDI bank select and MIDI program change |
| 4034 |
|
messages which are essentially just numbers. The following commands |
| 4035 |
|
allow to actually map arbitrary MIDI bank select / program change |
| 4036 |
|
numbers with real instruments.</t> |
| 4037 |
|
<t>The sampler allows to manage an arbitrary amount of MIDI |
| 4038 |
|
instrument maps which define which instrument to load on |
| 4039 |
|
which MIDI program change message.</t> |
| 4040 |
|
<t>By default, that is when the sampler is launched, there is no |
| 4041 |
|
map, thus the sampler will simply ignore all program change |
| 4042 |
|
messages. The front-end has to explicitly create at least one |
| 4043 |
|
map, add entries to the map and tell the respective sampler |
| 4044 |
|
channel(s) which MIDI instrument map to use, so the sampler |
| 4045 |
|
knows how to react on a given program change message on the |
| 4046 |
|
respective sampler channel, that is by switching to the |
| 4047 |
|
respectively defined engine type and loading the respective |
| 4048 |
|
instrument. See command |
| 4049 |
|
<xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref> |
| 4050 |
|
for how to assign a MIDI instrument map to a sampler channel.</t> |
| 4051 |
|
<t>Also note per MIDI specification a bank select message does not |
| 4052 |
|
cause to switch to another instrument. Instead when receiving a |
| 4053 |
|
bank select message the bank value will be stored and a subsequent |
| 4054 |
|
program change message (which may occur at any time) will finally |
| 4055 |
|
cause the sampler to switch to the respective instrument as |
| 4056 |
|
reflected by the current MIDI instrument map.</t> |
| 4057 |
|
|
| 4058 |
|
<section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT MAP"> |
| 4059 |
|
<t>The front-end can add a new MIDI instrument map by sending |
| 4060 |
|
the following command:</t> |
| 4061 |
|
<t> |
| 4062 |
|
<list> |
| 4063 |
|
<t>ADD MIDI_INSTRUMENT_MAP [<name>]</t> |
| 4064 |
|
</list> |
| 4065 |
|
</t> |
| 4066 |
|
<t>Where <name> is an optional argument allowing to |
| 4067 |
|
assign a custom name to the new map. MIDI instrument Map |
| 4068 |
|
names do not have to be unique.</t> |
| 4069 |
|
|
| 4070 |
|
<t>Possible Answers:</t> |
| 4071 |
|
<t> |
| 4072 |
|
<list> |
| 4073 |
|
<t>"OK[<map>]" - |
| 4074 |
|
<list> |
| 4075 |
|
<t>in case a new MIDI instrument map could |
| 4076 |
|
be added, where <map> reflects the |
| 4077 |
|
unique ID of the newly created MIDI |
| 4078 |
|
instrument map</t> |
| 4079 |
|
</list> |
| 4080 |
|
</t> |
| 4081 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 4082 |
|
<list> |
| 4083 |
|
<t>when a new map could not be created, which |
| 4084 |
|
might never occur in practice</t> |
| 4085 |
|
</list> |
| 4086 |
|
</t> |
| 4087 |
|
</list> |
| 4088 |
|
</t> |
| 4089 |
|
|
| 4090 |
|
<t>Examples:</t> |
| 4091 |
|
<t> |
| 4092 |
|
<list> |
| 4093 |
|
<t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"</t> |
| 4094 |
|
<t>S: "OK[0]"</t> |
| 4095 |
|
</list> |
| 4096 |
|
</t> |
| 4097 |
|
<t> |
| 4098 |
|
<list> |
| 4099 |
|
<t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"</t> |
| 4100 |
|
<t>S: "OK[1]"</t> |
| 4101 |
|
</list> |
| 4102 |
|
</t> |
| 4103 |
|
<t> |
| 4104 |
|
<list> |
| 4105 |
|
<t>C: "ADD MIDI_INSTRUMENT_MAP"</t> |
| 4106 |
|
<t>S: "OK[5]"</t> |
| 4107 |
|
</list> |
| 4108 |
|
</t> |
| 4109 |
|
</section> |
| 4110 |
|
|
| 4111 |
|
<section title="Delete one particular or all MIDI instrument maps" anchor="REMOVE MIDI_INSTRUMENT_MAP"> |
| 4112 |
|
<t>The front-end can delete a particular MIDI instrument map |
| 4113 |
|
by sending the following command:</t> |
| 4114 |
|
<t> |
| 4115 |
|
<list> |
| 4116 |
|
<t>REMOVE MIDI_INSTRUMENT_MAP <map></t> |
| 4117 |
|
</list> |
| 4118 |
|
</t> |
| 4119 |
|
<t>Where <map> reflects the unique ID of the map to delete |
| 4120 |
|
as returned by the <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref> |
| 4121 |
|
command.</t> |
| 4122 |
|
<t>The front-end can delete all MIDI instrument maps by |
| 4123 |
|
sending the following command:</t> |
| 4124 |
|
<t> |
| 4125 |
|
<list> |
| 4126 |
|
<t>REMOVE MIDI_INSTRUMENT_MAP ALL</t> |
| 4127 |
|
</list> |
| 4128 |
|
</t> |
| 4129 |
|
|
| 4130 |
|
<t>Possible Answers:</t> |
| 4131 |
|
<t> |
| 4132 |
|
<list> |
| 4133 |
|
<t>"OK" - |
| 4134 |
|
<list> |
| 4135 |
|
<t>in case the map(s) could be deleted</t> |
| 4136 |
|
</list> |
| 4137 |
|
</t> |
| 4138 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 4139 |
|
<list> |
| 4140 |
|
<t>when the given map does not exist</t> |
| 4141 |
|
</list> |
| 4142 |
|
</t> |
| 4143 |
|
</list> |
| 4144 |
|
</t> |
| 4145 |
|
|
| 4146 |
|
<t>Examples:</t> |
| 4147 |
|
<t> |
| 4148 |
|
<list> |
| 4149 |
|
<t>C: "REMOVE MIDI_INSTRUMENT_MAP 0"</t> |
| 4150 |
|
<t>S: "OK"</t> |
| 4151 |
|
</list> |
| 4152 |
|
</t> |
| 4153 |
|
<t> |
| 4154 |
|
<list> |
| 4155 |
|
<t>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"</t> |
| 4156 |
|
<t>S: "OK"</t> |
| 4157 |
|
</list> |
| 4158 |
|
</t> |
| 4159 |
|
</section> |
| 4160 |
|
|
| 4161 |
|
<section title="Get amount of existing MIDI instrument maps" anchor="GET MIDI_INSTRUMENT_MAPS"> |
| 4162 |
|
<t>The front-end can retrieve the current amount of MIDI |
| 4163 |
|
instrument maps by sending the following command:</t> |
| 4164 |
|
<t> |
| 4165 |
|
<list> |
| 4166 |
|
<t>GET MIDI_INSTRUMENT_MAPS</t> |
| 4167 |
|
</list> |
| 4168 |
|
</t> |
| 4169 |
|
|
| 4170 |
|
<t>Possible Answers:</t> |
| 4171 |
|
<t> |
| 4172 |
|
<list> |
| 4173 |
|
<t>The sampler will answer by returning the current |
| 4174 |
|
number of MIDI instrument maps.</t> |
| 4175 |
|
</list> |
| 4176 |
|
</t> |
| 4177 |
|
|
| 4178 |
|
<t>Example:</t> |
| 4179 |
|
<t> |
| 4180 |
|
<list> |
| 4181 |
|
<t>C: "GET MIDI_INSTRUMENT_MAPS"</t> |
| 4182 |
|
<t>S: "2"</t> |
| 4183 |
|
</list> |
| 4184 |
|
</t> |
| 4185 |
|
</section> |
| 4186 |
|
|
| 4187 |
|
<section title="Getting all created MIDI instrument maps" anchor="LIST MIDI_INSTRUMENT_MAPS"> |
| 4188 |
|
<t>The number of MIDI instrument maps can change on runtime. To get the |
| 4189 |
|
current list of MIDI instrument maps, the front-end can send the |
| 4190 |
|
following command:</t> |
| 4191 |
|
<t> |
| 4192 |
|
<list> |
| 4193 |
|
<t>LIST MIDI_INSTRUMENT_MAPS</t> |
| 4194 |
|
</list> |
| 4195 |
|
</t> |
| 4196 |
|
<t>Possible Answers:</t> |
| 4197 |
|
<t> |
| 4198 |
|
<list> |
| 4199 |
|
<t>The sampler will answer by returning a comma separated list |
| 4200 |
|
with all MIDI instrument maps' numerical IDs.</t> |
| 4201 |
|
</list> |
| 4202 |
|
</t> |
| 4203 |
|
<t>Example:</t> |
| 4204 |
|
<t> |
| 4205 |
|
<list> |
| 4206 |
|
<t>C: "LIST MIDI_INSTRUMENT_MAPS"</t> |
| 4207 |
|
<t>S: "0,1,5,12"</t> |
| 4208 |
|
</list> |
| 4209 |
|
</t> |
| 4210 |
|
</section> |
| 4211 |
|
|
| 4212 |
|
<section title="Getting MIDI instrument map information" anchor="GET MIDI_INSTRUMENT_MAP INFO"> |
| 4213 |
|
<t>The front-end can ask for the current settings of a MIDI |
| 4214 |
|
instrument map by sending the following command:</t> |
| 4215 |
|
<t> |
| 4216 |
|
<list> |
| 4217 |
|
<t>GET MIDI_INSTRUMENT_MAP INFO <map></t> |
| 4218 |
|
</list> |
| 4219 |
|
</t> |
| 4220 |
|
<t>Where <map> is the numerical ID of the map the |
| 4221 |
|
front-end is interested in as returned by the |
| 4222 |
|
<xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref> |
| 4223 |
|
command.</t> |
| 4224 |
|
|
| 4225 |
|
<t>Possible Answers:</t> |
| 4226 |
|
<t> |
| 4227 |
|
<list> |
| 4228 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
| 4229 |
|
Each answer line begins with the settings category name |
| 4230 |
|
followed by a colon and then a space character <SP> and finally |
| 4231 |
|
the info character string to that setting category. At the |
| 4232 |
|
moment the following categories are defined:</t> |
| 4233 |
|
|
| 4234 |
|
<t> |
| 4235 |
|
<list> |
| 4236 |
|
<t>NAME - |
| 4237 |
|
<list> |
| 4238 |
|
<t>custom name of the given map, |
| 4239 |
|
which does not have to be unique</t> |
| 4240 |
|
</list> |
| 4241 |
|
</t> |
| 4242 |
|
<t>DEFAULT - |
| 4243 |
|
<list> |
| 4244 |
|
<t>either true or false, |
| 4245 |
|
defines whether this map is the default map</t> |
| 4246 |
|
</list> |
| 4247 |
|
</t> |
| 4248 |
|
</list> |
| 4249 |
|
</t> |
| 4250 |
|
</list> |
| 4251 |
|
</t> |
| 4252 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
| 4253 |
|
|
| 4254 |
|
<t>Example:</t> |
| 4255 |
|
<t> |
| 4256 |
|
<list> |
| 4257 |
|
<t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t> |
| 4258 |
|
<t>S: "NAME: Standard Map"</t> |
| 4259 |
|
<t> "DEFAULT: true"</t> |
| 4260 |
|
<t> "."</t> |
| 4261 |
|
</list> |
| 4262 |
|
</t> |
| 4263 |
|
</section> |
| 4264 |
|
|
| 4265 |
|
<section title="Renaming a MIDI instrument map" anchor="SET MIDI_INSTRUMENT_MAP NAME"> |
| 4266 |
|
<t>The front-end can alter the custom name of a MIDI |
| 4267 |
|
instrument map by sending the following command:</t> |
| 4268 |
|
<t> |
| 4269 |
|
<list> |
| 4270 |
|
<t>SET MIDI_INSTRUMENT_MAP NAME <map> <name></t> |
| 4271 |
|
</list> |
| 4272 |
|
</t> |
| 4273 |
|
<t>Where <map> is the numerical ID of the map and |
| 4274 |
|
<name> the new custom name of the map, which does not |
| 4275 |
|
have to be unique.</t> |
| 4276 |
|
|
| 4277 |
|
<t>Possible Answers:</t> |
| 4278 |
|
<t> |
| 4279 |
|
<list> |
| 4280 |
|
<t>"OK" - |
| 4281 |
|
<list> |
| 4282 |
|
<t>on success</t> |
| 4283 |
|
</list> |
| 4284 |
|
</t> |
| 4285 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 4286 |
|
<list> |
| 4287 |
|
<t>in case the given map does not exist</t> |
| 4288 |
|
</list> |
| 4289 |
|
</t> |
| 4290 |
|
</list> |
| 4291 |
|
</t> |
| 4292 |
|
|
| 4293 |
|
<t>Example:</t> |
| 4294 |
|
<t> |
| 4295 |
|
<list> |
| 4296 |
|
<t>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"</t> |
| 4297 |
|
<t>S: "OK"</t> |
| 4298 |
|
</list> |
| 4299 |
|
</t> |
| 4300 |
|
</section> |
| 4301 |
|
|
| 4302 |
|
<section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT"> |
| 4303 |
|
<t>The front-end can create a new or replace an existing entry |
| 4304 |
|
in a sampler's MIDI instrument map by sending the following |
| 4305 |
|
command:</t> |
| 4306 |
|
<t> |
| 4307 |
|
<list> |
| 4308 |
|
<t>MAP MIDI_INSTRUMENT [NON_MODAL] <map> |
| 4309 |
|
<midi_bank> <midi_prog> <engine_name> |
| 4310 |
|
<filename> <instrument_index> <volume_value> |
| 4311 |
|
[<instr_load_mode>] [<name>]</t> |
| 4312 |
|
</list> |
| 4313 |
|
</t> |
| 4314 |
|
<t>Where <map> is the numeric ID of the map to alter, |
| 4315 |
|
<midi_bank> is an integer value between |
| 4316 |
|
0..16383 reflecting the MIDI bank select index, |
| 4317 |
|
<midi_prog> an |
| 4318 |
|
integer value between 0..127 reflecting the MIDI program change |
| 4319 |
|
index, <engine_name> a sampler engine name as returned by |
| 4320 |
|
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
| 4321 |
|
command (not encapsulated into apostrophes), <filename> the name |
| 4322 |
|
of the instrument's file to be deployed (encapsulated into apostrophes), |
| 4323 |
|
<instrument_index> the index (integer value) of the instrument |
| 4324 |
|
within the given file, <volume_value> reflects the master |
| 4325 |
|
volume of the instrument as optionally dotted number (where a |
| 4326 |
|
value < 1.0 means attenuation and a value > 1.0 means |
| 4327 |
|
amplification). This parameter easily allows to adjust the |
| 4328 |
|
volume of all intruments within a custom instrument map |
| 4329 |
|
without having to adjust their instrument files. The |
| 4330 |
|
OPTIONAL <instr_load_mode> argument defines the life |
| 4331 |
|
time of the instrument, that is when the instrument should |
| 4332 |
|
be loaded, when freed and has exactly the following |
| 4333 |
|
possibilities:</t> |
| 4334 |
|
<t> |
| 4335 |
|
<list> |
| 4336 |
|
<t>"ON_DEMAND" - |
| 4337 |
|
<list> |
| 4338 |
|
<t>The instrument will be loaded when needed, |
| 4339 |
|
that is when demanded by at least one sampler |
| 4340 |
|
channel. It will immediately be freed from memory |
| 4341 |
|
when not needed by any sampler channel anymore.</t> |
| 4342 |
|
</list> |
| 4343 |
|
</t> |
| 4344 |
|
<t>"ON_DEMAND_HOLD" - |
| 4345 |
|
<list> |
| 4346 |
|
<t>The instrument will be loaded when needed, |
| 4347 |
|
that is when demanded by at least one sampler |
| 4348 |
|
channel. It will be kept in memory even when |
| 4349 |
|
not needed by any sampler channel anymore. |
| 4350 |
|
Instruments with this mode are only freed |
| 4351 |
|
when the sampler is reset or all mapping |
| 4352 |
|
entries with this mode (and respective |
| 4353 |
|
instrument) are explicitly changed to |
| 4354 |
|
"ON_DEMAND" and no sampler channel is using |
| 4355 |
|
the instrument anymore.</t> |
| 4356 |
|
</list> |
| 4357 |
|
</t> |
| 4358 |
|
<t>"PERSISTENT" - |
| 4359 |
|
<list> |
| 4360 |
|
<t>The instrument will immediately be loaded |
| 4361 |
|
into memory when this mapping |
| 4362 |
|
command is sent and the instrument is kept all |
| 4363 |
|
the time. Instruments with this mode are |
| 4364 |
|
only freed when the sampler is reset or all |
| 4365 |
|
mapping entries with this mode (and |
| 4366 |
|
respective instrument) are explicitly |
| 4367 |
|
changed to "ON_DEMAND" and no sampler |
| 4368 |
|
channel is using the instrument anymore.</t> |
| 4369 |
|
</list> |
| 4370 |
|
</t> |
| 4371 |
|
<t>not supplied - |
| 4372 |
|
<list> |
| 4373 |
|
<t>In case there is no <instr_load_mode> |
| 4374 |
|
argument given, it will be up to the |
| 4375 |
|
InstrumentManager to decide which mode to use. |
| 4376 |
|
Usually it will use "ON_DEMAND" if an entry |
| 4377 |
|
for the given instrument does not exist in |
| 4378 |
|
the InstrumentManager's list yet, otherwise |
| 4379 |
|
if an entry already exists, it will simply |
| 4380 |
|
stick with the mode currently reflected by |
| 4381 |
|
the already existing entry, that is it will |
| 4382 |
|
not change the mode.</t> |
| 4383 |
|
</list> |
| 4384 |
|
</t> |
| 4385 |
|
</list> |
| 4386 |
|
</t> |
| 4387 |
|
<t> |
| 4388 |
|
The <instr_load_mode> argument thus allows to define an |
| 4389 |
|
appropriate strategy (low memory consumption vs. fast |
| 4390 |
|
instrument switching) for each instrument individually. Note, the |
| 4391 |
|
following restrictions apply to this argument: "ON_DEMAND_HOLD" and |
| 4392 |
|
"PERSISTENT" have to be supported by the respective sampler engine |
| 4393 |
|
(which is technically the case when the engine provides an |
| 4394 |
|
InstrumentManager for its format). If this is not the case the |
| 4395 |
|
argument will automatically fall back to the default value |
| 4396 |
|
"ON_DEMAND". Also the load mode of one instrument may |
| 4397 |
|
automatically change the laod mode of other instrument(s), i.e. |
| 4398 |
|
because the instruments are part of the same file and the |
| 4399 |
|
engine does not allow a way to manage load modes for them |
| 4400 |
|
individually. Due to this, in case the frontend shows the |
| 4401 |
|
load modes of entries, the frontend should retrieve the actual |
| 4402 |
|
mode by i.e. sending |
| 4403 |
|
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
| 4404 |
|
command(s). Finally the OPTIONAL <name> argument allows to |
| 4405 |
|
set a custom name (encapsulated into apostrophes) for the mapping |
| 4406 |
|
entry, useful for frontends for displaying an appropriate name for |
| 4407 |
|
mapped instruments (using |
| 4408 |
|
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
| 4409 |
|
</t> |
| 4410 |
|
<t> |
| 4411 |
|
By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is |
| 4412 |
|
completely established in the sampler. The OPTIONAL "NON_MODAL" argument |
| 4413 |
|
however causes the respective "MAP MIDI_INSTRUMENT" command to return |
| 4414 |
|
immediately, that is to let the sampler establish the mapping in the |
| 4415 |
|
background. So this argument might be especially useful for mappings with |
| 4416 |
|
a "PERSISTENT" type, because these have to load the respective instruments |
| 4417 |
|
immediately and might thus block for a very long time. It is recommended |
| 4418 |
|
however to use the OPTIONAL "NON_MODAL" argument only if really necessary, |
| 4419 |
|
because it has the following drawbacks: as "NON_MODAL" instructions return |
| 4420 |
|
immediately, they may not necessarily return an error i.e. when the given |
| 4421 |
|
instrument file turns out to be corrupt, beside that subsequent commands |
| 4422 |
|
in a LSCP instruction sequence might fail, because mandatory mappings are |
| 4423 |
|
not yet completed. |
| 4424 |
|
</t> |
| 4425 |
|
|
| 4426 |
|
<t>Possible Answers:</t> |
| 4427 |
|
<t> |
| 4428 |
|
<list> |
| 4429 |
|
<t>"OK" - |
| 4430 |
|
<list> |
| 4431 |
|
<t>usually</t> |
| 4432 |
|
</list> |
| 4433 |
|
</t> |
| 4434 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 4435 |
|
<list> |
| 4436 |
|
<t>when the given map or engine does not exist or a value |
| 4437 |
|
is out of range</t> |
| 4438 |
|
</list> |
| 4439 |
|
</t> |
| 4440 |
|
</list> |
| 4441 |
|
</t> |
| 4442 |
|
|
| 4443 |
|
<t>Examples:</t> |
| 4444 |
|
<t> |
| 4445 |
|
<list> |
| 4446 |
|
<t>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"</t> |
| 4447 |
|
<t>S: "OK"</t> |
| 4448 |
|
</list> |
| 4449 |
|
</t> |
| 4450 |
|
<t> |
| 4451 |
|
<list> |
| 4452 |
|
<t>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"</t> |
| 4453 |
|
<t>S: "OK"</t> |
| 4454 |
|
</list> |
| 4455 |
|
</t> |
| 4456 |
|
<t> |
| 4457 |
|
<list> |
| 4458 |
|
<t>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"</t> |
| 4459 |
|
<t>S: "OK"</t> |
| 4460 |
|
<t>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"</t> |
| 4461 |
|
<t>S: "OK"</t> |
| 4462 |
|
</list> |
| 4463 |
|
</t> |
| 4464 |
|
<t> |
| 4465 |
|
<list> |
| 4466 |
|
<t>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t> |
| 4467 |
|
<t>S: "OK"</t> |
| 4468 |
|
</list> |
| 4469 |
|
</t> |
| 4470 |
|
</section> |
| 4471 |
|
|
| 4472 |
|
<section title="Getting ammount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS"> |
| 4473 |
|
<t>The front-end can query the amount of currently existing |
| 4474 |
|
entries in a MIDI instrument map by sending the following |
| 4475 |
|
command:</t> |
| 4476 |
|
<t> |
| 4477 |
|
<list> |
| 4478 |
|
<t>GET MIDI_INSTRUMENTS <map></t> |
| 4479 |
|
</list> |
| 4480 |
|
</t> |
| 4481 |
|
<t>The front-end can query the amount of currently existing |
| 4482 |
|
entries in all MIDI instrument maps by sending the following |
| 4483 |
|
command:</t> |
| 4484 |
|
<t> |
| 4485 |
|
<list> |
| 4486 |
|
<t>GET MIDI_INSTRUMENTS ALL</t> |
| 4487 |
|
</list> |
| 4488 |
|
</t> |
| 4489 |
|
<t>Possible Answers:</t> |
| 4490 |
|
<t> |
| 4491 |
|
<list> |
| 4492 |
|
<t>The sampler will answer by sending the current number of |
| 4493 |
|
entries in the MIDI instrument map(s).</t> |
| 4494 |
|
</list> |
| 4495 |
|
</t> |
| 4496 |
|
|
| 4497 |
|
<t>Example:</t> |
| 4498 |
|
<t> |
| 4499 |
|
<list> |
| 4500 |
|
<t>C: "GET MIDI_INSTRUMENTS 0"</t> |
| 4501 |
|
<t>S: "234"</t> |
| 4502 |
|
</list> |
| 4503 |
|
</t> |
| 4504 |
|
<t> |
| 4505 |
|
<list> |
| 4506 |
|
<t>C: "GET MIDI_INSTRUMENTS ALL"</t> |
| 4507 |
|
<t>S: "954"</t> |
| 4508 |
|
</list> |
| 4509 |
|
</t> |
| 4510 |
|
</section> |
| 4511 |
|
|
| 4512 |
|
<section title="Getting indeces of all entries of a MIDI instrument map" anchor="LIST MIDI_INSTRUMENTS"> |
| 4513 |
|
<t>The front-end can query a list of all currently existing |
| 4514 |
|
entries in a certain MIDI instrument map by sending the following |
| 4515 |
|
command:</t> |
| 4516 |
|
<t> |
| 4517 |
|
<list> |
| 4518 |
|
<t>LIST MIDI_INSTRUMENTS <map></t> |
| 4519 |
|
</list> |
| 4520 |
|
</t> |
| 4521 |
|
<t>Where <map> is the numeric ID of the MIDI instrument map.</t> |
| 4522 |
|
<t>The front-end can query a list of all currently existing |
| 4523 |
|
entries of all MIDI instrument maps by sending the following |
| 4524 |
|
command:</t> |
| 4525 |
|
<t> |
| 4526 |
|
<list> |
| 4527 |
|
<t>LIST MIDI_INSTRUMENTS ALL</t> |
| 4528 |
|
</list> |
| 4529 |
|
</t> |
| 4530 |
|
|
| 4531 |
|
<t>Possible Answers:</t> |
| 4532 |
|
<t> |
| 4533 |
|
<list> |
| 4534 |
|
<t>The sampler will answer by sending a comma separated |
| 4535 |
|
list of map ID - MIDI bank - MIDI program triples, where |
| 4536 |
|
each triple is encapsulated into curly braces. The |
| 4537 |
|
list is returned in one single line. Each triple |
| 4538 |
|
just reflects the key of the respective map entry, |
| 4539 |
|
thus subsequent |
| 4540 |
|
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
| 4541 |
|
command(s) are necessary to retrieve detailed informations |
| 4542 |
|
about each entry.</t> |
| 4543 |
|
</list> |
| 4544 |
|
</t> |
| 4545 |
|
|
| 4546 |
|
<t>Example:</t> |
| 4547 |
|
<t> |
| 4548 |
|
<list> |
| 4549 |
|
<t>C: "LIST MIDI_INSTRUMENTS 0"</t> |
| 4550 |
|
<t>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"</t> |
| 4551 |
|
</list> |
| 4552 |
|
</t> |
| 4553 |
|
</section> |
| 4554 |
|
|
| 4555 |
|
<section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT"> |
| 4556 |
|
<t>The front-end can delete an entry from a MIDI instrument |
| 4557 |
|
map by sending the following command:</t> |
| 4558 |
|
<t> |
| 4559 |
|
<list> |
| 4560 |
|
<t>UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog></t> |
| 4561 |
|
</list> |
| 4562 |
|
</t> |
| 4563 |
|
<t> |
| 4564 |
|
Where <map> is the numeric ID of the MIDI instrument map, |
| 4565 |
|
<midi_bank> is an integer value between 0..16383 |
| 4566 |
|
reflecting the MIDI bank value and |
| 4567 |
|
<midi_prog> an integer value between |
| 4568 |
|
0..127 reflecting the MIDI program value of the map's entrie's key |
| 4569 |
|
index triple. |
| 4570 |
|
</t> |
| 4571 |
|
|
| 4572 |
|
<t>Possible Answers:</t> |
| 4573 |
|
<t> |
| 4574 |
|
<list> |
| 4575 |
|
<t>"OK" - |
| 4576 |
|
<list> |
| 4577 |
|
<t>usually</t> |
| 4578 |
|
</list> |
| 4579 |
|
</t> |
| 4580 |
|
<t>"ERR:<error-code>:<error-message>" - |
| 4581 |
|
<list> |
| 4582 |
|
<t>when index out of bounds</t> |
| 4583 |
|
</list> |
| 4584 |
|
</t> |
| 4585 |
|
</list> |
| 4586 |
|
</t> |
| 4587 |
|
|
| 4588 |
|
<t>Example:</t> |
| 4589 |
|
<t> |
| 4590 |
|
<list> |
| 4591 |
|
<t>C: "UNMAP MIDI_INSTRUMENT 0 2 127"</t> |
| 4592 |
|
<t>S: "OK"</t> |
| 4593 |
|
</list> |
| 4594 |
|
</t> |
| 4595 |
|
</section> |
| 4596 |
|
|
| 4597 |
|
<section title="Get current settings of MIDI instrument map entry" anchor="GET MIDI_INSTRUMENT INFO"> |
| 4598 |
|
<t>The front-end can retrieve the current settings of a certain |
| 4599 |
|
instrument map entry by sending the following command:</t> |
| 4600 |
|
<t> |
| 4601 |
|
<list> |
| 4602 |
|
<t>GET MIDI_INSTRUMENT INFO <map> <midi_bank> <midi_prog></t> |
| 4603 |
|
</list> |
| 4604 |
|
</t> |
| 4605 |
|
<t> |
| 4606 |
|
Where <map> is the numeric ID of the MIDI instrument map, |
| 4607 |
|
<midi_bank> is an integer value between 0..16383 |
| 4608 |
|
reflecting the MIDI bank value, <midi_bank> |
| 4609 |
|
and <midi_prog> an integer value between |
| 4610 |
|
0..127 reflecting the MIDI program value of the map's entrie's key |
| 4611 |
|
index triple. |
| 4612 |
|
</t> |
| 4613 |
|
|
| 4614 |
|
<t>Possible Answers:</t> |
| 4615 |
|
<t> |
| 4616 |
|
<list> |
| 4617 |
|
<t>LinuxSampler will answer by sending a <CRLF> |
| 4618 |
|
separated list. Each answer line begins with the |
| 4619 |
|
information category name followed by a colon and then |
| 4620 |
|
a space character <SP> and finally the info |
| 4621 |
|
character string to that info category. At the moment |
| 4622 |
|
the following categories are defined:</t> |
| 4623 |
|
<t>"NAME" - |
| 4624 |
|
<list> |
| 4625 |
|
<t>Name for this MIDI instrument map entry (if defined). |
| 4626 |
|
This name shall be used by frontends for displaying a |
| 4627 |
|
name for this mapped instrument. It can be set and |
| 4628 |
|
changed with the |
| 4629 |
|
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
| 4630 |
|
command and does not have to be unique.</t> |
| 4631 |
|
</list> |
| 4632 |
|
</t> |
| 4633 |
|
<t>"ENGINE_NAME" - |
| 4634 |
|
<list> |
| 4635 |
|
<t>Name of the engine to be deployed for this |
| 4636 |
|
instrument.</t> |
| 4637 |
|
</list> |
| 4638 |
|
</t> |
| 4639 |
|
<t>"INSTRUMENT_FILE" - |
| 4640 |
|
<list> |
| 4641 |
|
<t>File name of the instrument.</t> |
| 4642 |
|
</list> |
| 4643 |
|
</t> |
| 4644 |
|
<t>"INSTRUMENT_NR" - |
| 4645 |
|
<list> |
| 4646 |
|
<t>Index of the instrument within the file.</t> |
| 4647 |
|
</list> |
| 4648 |
|
</t> |
| 4649 |
|
<t>"INSTRUMENT_NAME" - |
| 4650 |
|
<list> |
| 4651 |
|
<t>Name of the loaded instrument as reflected by its file. |
| 4652 |
|
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
| 4653 |
|
cannot be changed.</t> |
| 4654 |
|
</list> |
| 4655 |
|
</t> |
| 4656 |
|
<t>"LOAD_MODE" - |
| 4657 |
|
<list> |
| 4658 |
|
<t>Life time of instrument |
| 4659 |
|
(see <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> for details about this setting).</t> |
| 4660 |
|
</list> |
| 4661 |
|
</t> |
| 4662 |
|
<t>"VOLUME" - |
| 4663 |
|
<list> |
| 4664 |
|
<t>master volume of the instrument as optionally |
| 4665 |
|
dotted number (where a value < 1.0 means attenuation |
| 4666 |
|
and a value > 1.0 means amplification)</t> |
| 4667 |
|
</list> |
| 4668 |
|
</t> |
| 4669 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
| 4670 |
|
</list> |
| 4671 |
|
</t> |
| 4672 |
|
|
| 4673 |
|
<t>Example:</t> |
| 4674 |
|
<t> |
| 4675 |
|
<list> |
| 4676 |
|
<t>C: "GET MIDI_INSTRUMENT INFO 1 45 120"</t> |
| 4677 |
|
<t>S: "NAME: Drums for Foo Song"</t> |
| 4678 |
|
<t> "ENGINE_NAME: GigEngine"</t> |
| 4679 |
|
<t> "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t> |
| 4680 |
|
<t> "INSTRUMENT_NR: 0"</t> |
| 4681 |
|
<t> "INSTRUMENT_NAME: Joe's Drumkit"</t> |
| 4682 |
|
<t> "LOAD_MODE: PERSISTENT"</t> |
| 4683 |
|
<t> "VOLUME: 1.0"</t> |
| 4684 |
|
<t> "."</t> |
| 4685 |
|
</list> |
| 4686 |
|
</t> |
| 4687 |
|
</section> |
| 4688 |
|
|
| 4689 |
|
<section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS"> |
| 4690 |
|
<t>The front-end can clear a whole MIDI instrument map, that |
| 4691 |
|
is delete all its entries by sending the following command:</t> |
| 4692 |
|
<t> |
| 4693 |
|
<list> |
| 4694 |
|
<t>CLEAR MIDI_INSTRUMENTS <map></t> |
| 4695 |
|
</list> |
| 4696 |
|
</t> |
| 4697 |
|
<t>Where <map> is the numeric ID of the map to clear.</t> |
| 4698 |
|
<t>The front-end can clear all MIDI instrument maps, that |
| 4699 |
|
is delete all entries of all maps by sending the following |
| 4700 |
|
command:</t> |
| 4701 |
|
<t> |
| 4702 |
|
<list> |
| 4703 |
|
<t>CLEAR MIDI_INSTRUMENTS ALL</t> |
| 4704 |
|
</list> |
| 4705 |
|
</t> |
| 4706 |
|
<t>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the |
| 4707 |
|
maps, only their entries, thus the map's settings like |
| 4708 |
|
custom name will be preservevd.</t> |
| 4709 |
|
|
| 4710 |
|
<t>Possible Answers:</t> |
| 4711 |
|
<t> |
| 4712 |
|
<list> |
| 4713 |
|
<t>"OK" - |
| 4714 |
|
<list> |
| 4715 |
|
<t>always</t> |
| 4716 |
|
</list> |
| 4717 |
|
</t> |
| 4718 |
|
</list> |
| 4719 |
|
</t> |
| 4720 |
|
|
| 4721 |
|
<t>Examples:</t> |
| 4722 |
|
<t> |
| 4723 |
|
<list> |
| 4724 |
|
<t>C: "CLEAR MIDI_INSTRUMENTS 0"</t> |
| 4725 |
|
<t>S: "OK"</t> |
| 4726 |
|
</list> |
| 4727 |
|
</t> |
| 4728 |
|
<t> |
| 4729 |
|
<list> |
| 4730 |
|
<t>C: "CLEAR MIDI_INSTRUMENTS ALL"</t> |
| 4731 |
|
<t>S: "OK"</t> |
| 4732 |
|
</list> |
| 4733 |
|
</t> |
| 4734 |
|
</section> |
| 4735 |
|
</section> |
| 4736 |
|
|
| 4737 |
</section> |
</section> |
| 4738 |
|
|
| 4739 |
|
|
| 4740 |
<section title="Command Syntax" anchor="command_syntax"> |
<section title="Command Syntax" anchor="command_syntax"> |
| 4741 |
<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"/> |
| 4742 |
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"/>) |
| 4785 |
</t> |
</t> |
| 4786 |
<t>command = |
<t>command = |
| 4787 |
<list> |
<list> |
| 4788 |
<t>ADD SP CHANNEL |
<t>ADD SP add_instruction |
| 4789 |
|
</t> |
| 4790 |
|
<t>/ MAP SP map_instruction |
| 4791 |
|
</t> |
| 4792 |
|
<t>/ UNMAP SP unmap_instruction |
| 4793 |
</t> |
</t> |
| 4794 |
<t>/ GET SP get_instruction |
<t>/ GET SP get_instruction |
| 4795 |
</t> |
</t> |
| 4801 |
</t> |
</t> |
| 4802 |
<t>/ LOAD SP load_instruction |
<t>/ LOAD SP load_instruction |
| 4803 |
</t> |
</t> |
| 4804 |
<t>/ REMOVE SP CHANNEL SP sampler_channel |
<t>/ REMOVE SP remove_instruction |
| 4805 |
</t> |
</t> |
| 4806 |
<t>/ SET SP set_instruction |
<t>/ SET SP set_instruction |
| 4807 |
</t> |
</t> |
| 4811 |
</t> |
</t> |
| 4812 |
<t>/ SELECT SP text |
<t>/ SELECT SP text |
| 4813 |
</t> |
</t> |
| 4814 |
<t>/ RESET SP CHANNEL SP sampler_channel |
<t>/ RESET SP reset_instruction |
| 4815 |
|
</t> |
| 4816 |
|
<t>/ CLEAR SP clear_instruction |
| 4817 |
</t> |
</t> |
| 4818 |
<t>/ RESET |
<t>/ RESET |
| 4819 |
</t> |
</t> |
| 4821 |
</t> |
</t> |
| 4822 |
</list> |
</list> |
| 4823 |
</t> |
</t> |
| 4824 |
|
<t>add_instruction = |
| 4825 |
|
<list> |
| 4826 |
|
<t>CHANNEL |
| 4827 |
|
</t> |
| 4828 |
|
<t>/ MIDI_INSTRUMENT_MAP |
| 4829 |
|
</t> |
| 4830 |
|
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
| 4831 |
|
</t> |
| 4832 |
|
</list> |
| 4833 |
|
</t> |
| 4834 |
<t>subscribe_event = |
<t>subscribe_event = |
| 4835 |
<list> |
<list> |
| 4836 |
<t>CHANNEL_COUNT |
<t>AUDIO_OUTPUT_DEVICE_COUNT |
| 4837 |
|
</t> |
| 4838 |
|
<t>/ AUDIO_OUTPUT_DEVICE_INFO |
| 4839 |
|
</t> |
| 4840 |
|
<t>/ MIDI_INPUT_DEVICE_COUNT |
| 4841 |
|
</t> |
| 4842 |
|
<t>/ MIDI_INPUT_DEVICE_INFO |
| 4843 |
|
</t> |
| 4844 |
|
<t>/ CHANNEL_COUNT |
| 4845 |
</t> |
</t> |
| 4846 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
| 4847 |
</t> |
</t> |
| 4851 |
</t> |
</t> |
| 4852 |
<t>/ CHANNEL_INFO |
<t>/ CHANNEL_INFO |
| 4853 |
</t> |
</t> |
| 4854 |
|
<t>/ FX_SEND_COUNT |
| 4855 |
|
</t> |
| 4856 |
|
<t>/ FX_SEND_INFO |
| 4857 |
|
</t> |
| 4858 |
|
<t>/ MIDI_INSTRUMENT_MAP_COUNT |
| 4859 |
|
</t> |
| 4860 |
|
<t>/ MIDI_INSTRUMENT_MAP_INFO |
| 4861 |
|
</t> |
| 4862 |
|
<t>/ MIDI_INSTRUMENT_COUNT |
| 4863 |
|
</t> |
| 4864 |
|
<t>/ MIDI_INSTRUMENT_INFO |
| 4865 |
|
</t> |
| 4866 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
| 4867 |
</t> |
</t> |
| 4868 |
|
<t>/ TOTAL_VOICE_COUNT |
| 4869 |
|
</t> |
| 4870 |
|
<t>/ GLOBAL_INFO |
| 4871 |
|
</t> |
| 4872 |
</list> |
</list> |
| 4873 |
</t> |
</t> |
| 4874 |
<t>unsubscribe_event = |
<t>unsubscribe_event = |
| 4875 |
<list> |
<list> |
| 4876 |
<t>CHANNEL_COUNT |
<t>AUDIO_OUTPUT_DEVICE_COUNT |
| 4877 |
|
</t> |
| 4878 |
|
<t>/ AUDIO_OUTPUT_DEVICE_INFO |
| 4879 |
|
</t> |
| 4880 |
|
<t>/ MIDI_INPUT_DEVICE_COUNT |
| 4881 |
|
</t> |
| 4882 |
|
<t>/ MIDI_INPUT_DEVICE_INFO |
| 4883 |
|
</t> |
| 4884 |
|
<t>/ CHANNEL_COUNT |
| 4885 |
</t> |
</t> |
| 4886 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
| 4887 |
</t> |
</t> |
| 4891 |
</t> |
</t> |
| 4892 |
<t>/ CHANNEL_INFO |
<t>/ CHANNEL_INFO |
| 4893 |
</t> |
</t> |
| 4894 |
|
<t>/ FX_SEND_COUNT |
| 4895 |
|
</t> |
| 4896 |
|
<t>/ FX_SEND_INFO |
| 4897 |
|
</t> |
| 4898 |
|
<t>/ MIDI_INSTRUMENT_MAP_COUNT |
| 4899 |
|
</t> |
| 4900 |
|
<t>/ MIDI_INSTRUMENT_MAP_INFO |
| 4901 |
|
</t> |
| 4902 |
|
<t>/ MIDI_INSTRUMENT_COUNT |
| 4903 |
|
</t> |
| 4904 |
|
<t>/ MIDI_INSTRUMENT_INFO |
| 4905 |
|
</t> |
| 4906 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
| 4907 |
</t> |
</t> |
| 4908 |
|
<t>/ TOTAL_VOICE_COUNT |
| 4909 |
|
</t> |
| 4910 |
|
<t>/ GLOBAL_INFO |
| 4911 |
|
</t> |
| 4912 |
|
</list> |
| 4913 |
|
</t> |
| 4914 |
|
<t>map_instruction = |
| 4915 |
|
<list> |
| 4916 |
|
<t>MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value |
| 4917 |
|
</t> |
| 4918 |
|
<t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode |
| 4919 |
|
</t> |
| 4920 |
|
<t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name |
| 4921 |
|
</t> |
| 4922 |
|
<t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name |
| 4923 |
|
</t> |
| 4924 |
|
</list> |
| 4925 |
|
</t> |
| 4926 |
|
<t>unmap_instruction = |
| 4927 |
|
<list> |
| 4928 |
|
<t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog |
| 4929 |
|
</t> |
| 4930 |
|
</list> |
| 4931 |
|
</t> |
| 4932 |
|
<t>remove_instruction = |
| 4933 |
|
<list> |
| 4934 |
|
<t>CHANNEL SP sampler_channel |
| 4935 |
|
</t> |
| 4936 |
|
<t>/ MIDI_INSTRUMENT_MAP SP midi_map |
| 4937 |
|
</t> |
| 4938 |
|
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
| 4939 |
|
</t> |
| 4940 |
</list> |
</list> |
| 4941 |
</t> |
</t> |
| 4942 |
<t>get_instruction = |
<t>get_instruction = |
| 4989 |
</t> |
</t> |
| 4990 |
<t>/ SERVER SP INFO |
<t>/ SERVER SP INFO |
| 4991 |
</t> |
</t> |
| 4992 |
|
<t>/ TOTAL_VOICE_COUNT |
| 4993 |
|
</t> |
| 4994 |
|
<t>/ TOTAL_VOICE_COUNT_MAX |
| 4995 |
|
</t> |
| 4996 |
|
<t>/ MIDI_INSTRUMENTS SP midi_map |
| 4997 |
|
</t> |
| 4998 |
|
<t>/ MIDI_INSTRUMENTS SP ALL |
| 4999 |
|
</t> |
| 5000 |
|
<t>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog |
| 5001 |
|
</t> |
| 5002 |
|
<t>/ MIDI_INSTRUMENT_MAPS |
| 5003 |
|
</t> |
| 5004 |
|
<t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
| 5005 |
|
</t> |
| 5006 |
|
<t>/ FX_SENDS SP sampler_channel |
| 5007 |
|
</t> |
| 5008 |
|
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
| 5009 |
|
</t> |
| 5010 |
|
<t>/ VOLUME |
| 5011 |
|
</t> |
| 5012 |
</list> |
</list> |
| 5013 |
</t> |
</t> |
| 5014 |
<t>set_instruction = |
<t>set_instruction = |
| 5023 |
</t> |
</t> |
| 5024 |
<t>/ CHANNEL SP set_chan_instruction |
<t>/ CHANNEL SP set_chan_instruction |
| 5025 |
</t> |
</t> |
| 5026 |
|
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
| 5027 |
|
</t> |
| 5028 |
|
<t>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name |
| 5029 |
|
</t> |
| 5030 |
|
<t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index |
| 5031 |
|
</t> |
| 5032 |
|
<t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl |
| 5033 |
|
</t> |
| 5034 |
|
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
| 5035 |
|
</t> |
| 5036 |
<t>/ ECHO SP boolean |
<t>/ ECHO SP boolean |
| 5037 |
</t> |
</t> |
| 5038 |
|
<t>/ VOLUME SP volume_value |
| 5039 |
|
</t> |
| 5040 |
</list> |
</list> |
| 5041 |
</t> |
</t> |
| 5042 |
<t>create_instruction = |
<t>create_instruction = |
| 5049 |
</t> |
</t> |
| 5050 |
<t>/ MIDI_INPUT_DEVICE SP string |
<t>/ MIDI_INPUT_DEVICE SP string |
| 5051 |
</t> |
</t> |
| 5052 |
|
<t>/ FX_SEND SP sampler_channel SP midi_ctrl |
| 5053 |
|
</t> |
| 5054 |
|
<t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
| 5055 |
|
</t> |
| 5056 |
|
</list> |
| 5057 |
|
</t> |
| 5058 |
|
<t>reset_instruction = |
| 5059 |
|
<list> |
| 5060 |
|
<t>CHANNEL SP sampler_channel |
| 5061 |
|
</t> |
| 5062 |
|
</list> |
| 5063 |
|
</t> |
| 5064 |
|
<t>clear_instruction = |
| 5065 |
|
<list> |
| 5066 |
|
<t>MIDI_INSTRUMENTS SP midi_map |
| 5067 |
|
</t> |
| 5068 |
|
<t>/ MIDI_INSTRUMENTS SP ALL |
| 5069 |
|
</t> |
| 5070 |
</list> |
</list> |
| 5071 |
</t> |
</t> |
| 5072 |
<t>destroy_instruction = |
<t>destroy_instruction = |
| 5075 |
</t> |
</t> |
| 5076 |
<t>/ MIDI_INPUT_DEVICE SP number |
<t>/ MIDI_INPUT_DEVICE SP number |
| 5077 |
</t> |
</t> |
| 5078 |
|
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
| 5079 |
|
</t> |
| 5080 |
</list> |
</list> |
| 5081 |
</t> |
</t> |
| 5082 |
<t>load_instruction = |
<t>load_instruction = |
| 5111 |
</t> |
</t> |
| 5112 |
<t>/ SOLO SP sampler_channel SP boolean |
<t>/ SOLO SP sampler_channel SP boolean |
| 5113 |
</t> |
</t> |
| 5114 |
|
<t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map |
| 5115 |
|
</t> |
| 5116 |
|
<t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE |
| 5117 |
|
</t> |
| 5118 |
|
<t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT |
| 5119 |
|
</t> |
| 5120 |
|
</list> |
| 5121 |
|
</t> |
| 5122 |
|
<t>modal_arg = |
| 5123 |
|
<list> |
| 5124 |
|
<t>/* epsilon (empty argument) */ |
| 5125 |
|
</t> |
| 5126 |
|
<t>/ NON_MODAL SP |
| 5127 |
|
</t> |
| 5128 |
</list> |
</list> |
| 5129 |
</t> |
</t> |
| 5130 |
<t>key_val_list = |
<t>key_val_list = |
| 5157 |
</t> |
</t> |
| 5158 |
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
| 5159 |
</t> |
</t> |
| 5160 |
|
<t>/ MIDI_INSTRUMENTS SP midi_map |
| 5161 |
|
</t> |
| 5162 |
|
<t>/ MIDI_INSTRUMENTS SP ALL |
| 5163 |
|
</t> |
| 5164 |
|
<t>/ MIDI_INSTRUMENT_MAPS |
| 5165 |
|
</t> |
| 5166 |
|
<t>/ FX_SENDS SP sampler_channel |
| 5167 |
|
</t> |
| 5168 |
</list> |
</list> |
| 5169 |
</t> |
</t> |
| 5170 |
<t>load_instr_args = |
<t>load_instr_args = |
| 5181 |
</t> |
</t> |
| 5182 |
</list> |
</list> |
| 5183 |
</t> |
</t> |
| 5184 |
|
<t>instr_load_mode = |
| 5185 |
|
<list> |
| 5186 |
|
<t>ON_DEMAND |
| 5187 |
|
</t> |
| 5188 |
|
<t>/ ON_DEMAND_HOLD |
| 5189 |
|
</t> |
| 5190 |
|
<t>/ PERSISTENT |
| 5191 |
|
</t> |
| 5192 |
|
</list> |
| 5193 |
|
</t> |
| 5194 |
<t>device_index = |
<t>device_index = |
| 5195 |
<list> |
<list> |
| 5196 |
<t>number |
<t>number |
| 5229 |
</t> |
</t> |
| 5230 |
</list> |
</list> |
| 5231 |
</t> |
</t> |
| 5232 |
|
<t>midi_map = |
| 5233 |
|
<list> |
| 5234 |
|
<t>number |
| 5235 |
|
</t> |
| 5236 |
|
</list> |
| 5237 |
|
</t> |
| 5238 |
|
<t>midi_bank = |
| 5239 |
|
<list> |
| 5240 |
|
<t>number |
| 5241 |
|
</t> |
| 5242 |
|
</list> |
| 5243 |
|
</t> |
| 5244 |
|
<t>midi_prog = |
| 5245 |
|
<list> |
| 5246 |
|
<t>number |
| 5247 |
|
</t> |
| 5248 |
|
</list> |
| 5249 |
|
</t> |
| 5250 |
|
<t>midi_ctrl = |
| 5251 |
|
<list> |
| 5252 |
|
<t>number |
| 5253 |
|
</t> |
| 5254 |
|
</list> |
| 5255 |
|
</t> |
| 5256 |
<t>volume_value = |
<t>volume_value = |
| 5257 |
<list> |
<list> |
| 5258 |
<t>dotnum |
<t>dotnum |
| 5273 |
</t> |
</t> |
| 5274 |
</list> |
</list> |
| 5275 |
</t> |
</t> |
| 5276 |
|
<t>fx_send_id = |
| 5277 |
|
<list> |
| 5278 |
|
<t>number |
| 5279 |
|
</t> |
| 5280 |
|
</list> |
| 5281 |
|
</t> |
| 5282 |
<t>engine_name = |
<t>engine_name = |
| 5283 |
<list> |
<list> |
| 5284 |
<t>string |
<t>string |
| 5291 |
</t> |
</t> |
| 5292 |
</list> |
</list> |
| 5293 |
</t> |
</t> |
| 5294 |
|
<t>map_name = |
| 5295 |
|
<list> |
| 5296 |
|
<t>stringval |
| 5297 |
|
</t> |
| 5298 |
|
</list> |
| 5299 |
|
</t> |
| 5300 |
|
<t>entry_name = |
| 5301 |
|
<list> |
| 5302 |
|
<t>stringval |
| 5303 |
|
</t> |
| 5304 |
|
</list> |
| 5305 |
|
</t> |
| 5306 |
|
<t>fx_send_name = |
| 5307 |
|
<list> |
| 5308 |
|
<t>stringval |
| 5309 |
|
</t> |
| 5310 |
|
</list> |
| 5311 |
|
</t> |
| 5312 |
<t>param_val_list = |
<t>param_val_list = |
| 5313 |
<list> |
<list> |
| 5314 |
<t>param_val |
<t>param_val |
| 5321 |
<list> |
<list> |
| 5322 |
<t>string |
<t>string |
| 5323 |
</t> |
</t> |
| 5324 |
<t>/ '\'' string '\'' |
<t>/ stringval |
|
</t> |
|
|
<t>/ '\"' string '\"' |
|
| 5325 |
</t> |
</t> |
| 5326 |
<t>/ number |
<t>/ number |
| 5327 |
</t> |
</t> |
| 5336 |
<section title="Events" anchor="events"> |
<section title="Events" anchor="events"> |
| 5337 |
<t>This chapter will describe all currently defined events supported by LinuxSampler.</t> |
<t>This chapter will describe all currently defined events supported by LinuxSampler.</t> |
| 5338 |
|
|
| 5339 |
<section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL"> |
<section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"> |
| 5340 |
|
<t>Client may want to be notified when the total number of audio output devices on the |
| 5341 |
|
back-end changes by issuing the following command:</t> |
| 5342 |
|
<t> |
| 5343 |
|
<list> |
| 5344 |
|
<t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t> |
| 5345 |
|
</list> |
| 5346 |
|
</t> |
| 5347 |
|
<t>Server will start sending the following notification messages:</t> |
| 5348 |
|
<t> |
| 5349 |
|
<list> |
| 5350 |
|
<t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"</t> |
| 5351 |
|
</list> |
| 5352 |
|
</t> |
| 5353 |
|
<t>where <devices> will be replaced by the new number |
| 5354 |
|
of audio output devices.</t> |
| 5355 |
|
</section> |
| 5356 |
|
|
| 5357 |
|
<section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"> |
| 5358 |
|
<t>Client may want to be notified when changes were made to audio output devices on the |
| 5359 |
|
back-end by issuing the following command:</t> |
| 5360 |
|
<t> |
| 5361 |
|
<list> |
| 5362 |
|
<t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t> |
| 5363 |
|
</list> |
| 5364 |
|
</t> |
| 5365 |
|
<t>Server will start sending the following notification messages:</t> |
| 5366 |
|
<t> |
| 5367 |
|
<list> |
| 5368 |
|
<t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"</t> |
| 5369 |
|
</list> |
| 5370 |
|
</t> |
| 5371 |
|
<t>where <device-id> will be replaced by the numerical ID of the audio output device, |
| 5372 |
|
which settings has been changed. The front-end will have to send |
| 5373 |
|
the respective command to actually get the audio output device info. Because these messages |
| 5374 |
|
will be triggered by LSCP commands issued by other clients rather than real |
| 5375 |
|
time events happening on the server, it is believed that an empty notification |
| 5376 |
|
message is sufficient here.</t> |
| 5377 |
|
</section> |
| 5378 |
|
|
| 5379 |
|
<section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"> |
| 5380 |
|
<t>Client may want to be notified when the total number of MIDI input devices on the |
| 5381 |
|
back-end changes by issuing the following command:</t> |
| 5382 |
|
<t> |
| 5383 |
|
<list> |
| 5384 |
|
<t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t> |
| 5385 |
|
</list> |
| 5386 |
|
</t> |
| 5387 |
|
<t>Server will start sending the following notification messages:</t> |
| 5388 |
|
<t> |
| 5389 |
|
<list> |
| 5390 |
|
<t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"</t> |
| 5391 |
|
</list> |
| 5392 |
|
</t> |
| 5393 |
|
<t>where <devices> will be replaced by the new number |
| 5394 |
|
of MIDI input devices.</t> |
| 5395 |
|
</section> |
| 5396 |
|
|
| 5397 |
|
<section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"> |
| 5398 |
|
<t>Client may want to be notified when changes were made to MIDI input devices on the |
| 5399 |
|
back-end by issuing the following command:</t> |
| 5400 |
|
<t> |
| 5401 |
|
<list> |
| 5402 |
|
<t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t> |
| 5403 |
|
</list> |
| 5404 |
|
</t> |
| 5405 |
|
<t>Server will start sending the following notification messages:</t> |
| 5406 |
|
<t> |
| 5407 |
|
<list> |
| 5408 |
|
<t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"</t> |
| 5409 |
|
</list> |
| 5410 |
|
</t> |
| 5411 |
|
<t>where <device-id> will be replaced by the numerical ID of the MIDI input device, |
| 5412 |
|
which settings has been changed. The front-end will have to send |
| 5413 |
|
the respective command to actually get the MIDI input device info. Because these messages |
| 5414 |
|
will be triggered by LSCP commands issued by other clients rather than real |
| 5415 |
|
time events happening on the server, it is believed that an empty notification |
| 5416 |
|
message is sufficient here.</t> |
| 5417 |
|
</section> |
| 5418 |
|
|
| 5419 |
|
<section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT"> |
| 5420 |
<t>Client may want to be notified when the total number of channels on the |
<t>Client may want to be notified when the total number of channels on the |
| 5421 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
| 5422 |
<t> |
<t> |
| 5445 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
| 5446 |
<t> |
<t> |
| 5447 |
<list> |
<list> |
| 5448 |
<t>"NOTIFY:VOICE_COUNT:<sampler-channel> <voices></t> |
<t>"NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"</t> |
| 5449 |
</list> |
</list> |
| 5450 |
</t> |
</t> |
| 5451 |
<t>where <sampler-channel> will be replaced by the sampler channel the |
<t>where <sampler-channel> will be replaced by the sampler channel the |
| 5493 |
"GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t> |
"GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t> |
| 5494 |
</section> |
</section> |
| 5495 |
|
|
| 5496 |
<section title="Channel information changed" anchor="SUBSCRIBE INFO"> |
<section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO"> |
| 5497 |
<t>Client may want to be notified when changes were made to sampler channels on the |
<t>Client may want to be notified when changes were made to sampler channels on the |
| 5498 |
back-end by issuing the following command:</t> |
back-end by issuing the following command:</t> |
| 5499 |
<t> |
<t> |
| 5515 |
message is sufficient here.</t> |
message is sufficient here.</t> |
| 5516 |
</section> |
</section> |
| 5517 |
|
|
| 5518 |
|
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
| 5519 |
|
<t>Client may want to be notified when the number of effect sends on |
| 5520 |
|
a particular sampler channel is changed by issuing the following command:</t> |
| 5521 |
|
<t> |
| 5522 |
|
<list> |
| 5523 |
|
<t>SUBSCRIBE FX_SEND_COUNT</t> |
| 5524 |
|
</list> |
| 5525 |
|
</t> |
| 5526 |
|
<t>Server will start sending the following notification messages:</t> |
| 5527 |
|
<t> |
| 5528 |
|
<list> |
| 5529 |
|
<t>"NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"</t> |
| 5530 |
|
</list> |
| 5531 |
|
</t> |
| 5532 |
|
<t>where <channel-id> will be replaced by the numerical ID of the sampler |
| 5533 |
|
channel, on which the effect sends number is changed and <fx-sends> will |
| 5534 |
|
be replaced by the new number of effect sends on that channel.</t> |
| 5535 |
|
</section> |
| 5536 |
|
|
| 5537 |
|
<section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO"> |
| 5538 |
|
<t>Client may want to be notified when changes were made to effect sends on a |
| 5539 |
|
a particular sampler channel by issuing the following command:</t> |
| 5540 |
|
<t> |
| 5541 |
|
<list> |
| 5542 |
|
<t>SUBSCRIBE FX_SEND_INFO</t> |
| 5543 |
|
</list> |
| 5544 |
|
</t> |
| 5545 |
|
<t>Server will start sending the following notification messages:</t> |
| 5546 |
|
<t> |
| 5547 |
|
<list> |
| 5548 |
|
<t>"NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"</t> |
| 5549 |
|
</list> |
| 5550 |
|
</t> |
| 5551 |
|
<t>where <channel-id> will be replaced by the numerical ID of the sampler |
| 5552 |
|
channel, on which an effect send entity is changed and <fx-send-id> will |
| 5553 |
|
be replaced by the numerical ID of the changed effect send.</t> |
| 5554 |
|
</section> |
| 5555 |
|
|
| 5556 |
|
<section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT"> |
| 5557 |
|
<t>Client may want to be notified when the total number of voices on the |
| 5558 |
|
back-end changes by issuing the following command:</t> |
| 5559 |
|
<t> |
| 5560 |
|
<list> |
| 5561 |
|
<t>SUBSCRIBE TOTAL_VOICE_COUNT</t> |
| 5562 |
|
</list> |
| 5563 |
|
</t> |
| 5564 |
|
<t>Server will start sending the following notification messages:</t> |
| 5565 |
|
<t> |
| 5566 |
|
<list> |
| 5567 |
|
<t>"NOTIFY:TOTAL_VOICE_COUNT:<voices>"</t> |
| 5568 |
|
</list> |
| 5569 |
|
</t> |
| 5570 |
|
<t>where <voices> will be replaced by the new number of |
| 5571 |
|
all currently active voices.</t> |
| 5572 |
|
</section> |
| 5573 |
|
|
| 5574 |
|
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
| 5575 |
|
<t>Client may want to be notified when the number of MIDI instrument maps on the |
| 5576 |
|
back-end changes by issuing the following command:</t> |
| 5577 |
|
<t> |
| 5578 |
|
<list> |
| 5579 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t> |
| 5580 |
|
</list> |
| 5581 |
|
</t> |
| 5582 |
|
<t>Server will start sending the following notification messages:</t> |
| 5583 |
|
<t> |
| 5584 |
|
<list> |
| 5585 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"</t> |
| 5586 |
|
</list> |
| 5587 |
|
</t> |
| 5588 |
|
<t>where <maps> will be replaced by the new number |
| 5589 |
|
of MIDI instrument maps.</t> |
| 5590 |
|
</section> |
| 5591 |
|
|
| 5592 |
|
<section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"> |
| 5593 |
|
<t>Client may want to be notified when changes were made to MIDI instrument maps on the |
| 5594 |
|
back-end by issuing the following command:</t> |
| 5595 |
|
<t> |
| 5596 |
|
<list> |
| 5597 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t> |
| 5598 |
|
</list> |
| 5599 |
|
</t> |
| 5600 |
|
<t>Server will start sending the following notification messages:</t> |
| 5601 |
|
<t> |
| 5602 |
|
<list> |
| 5603 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"</t> |
| 5604 |
|
</list> |
| 5605 |
|
</t> |
| 5606 |
|
<t>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
| 5607 |
|
for which information changes occurred. The front-end will have to send |
| 5608 |
|
the respective command to actually get the MIDI instrument map info. Because these messages |
| 5609 |
|
will be triggered by LSCP commands issued by other clients rather than real |
| 5610 |
|
time events happening on the server, it is believed that an empty notification |
| 5611 |
|
message is sufficient here.</t> |
| 5612 |
|
</section> |
| 5613 |
|
|
| 5614 |
|
<section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT"> |
| 5615 |
|
<t>Client may want to be notified when the number of MIDI instrument maps on the |
| 5616 |
|
back-end changes by issuing the following command:</t> |
| 5617 |
|
<t> |
| 5618 |
|
<list> |
| 5619 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t> |
| 5620 |
|
</list> |
| 5621 |
|
</t> |
| 5622 |
|
<t>Server will start sending the following notification messages:</t> |
| 5623 |
|
<t> |
| 5624 |
|
<list> |
| 5625 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"</t> |
| 5626 |
|
</list> |
| 5627 |
|
</t> |
| 5628 |
|
<t>where <map-id> is the numerical ID of the MIDI instrument map, in which |
| 5629 |
|
the nuber of instruments has changed and <instruments> will be replaced by |
| 5630 |
|
the new number of MIDI instruments in the specified map.</t> |
| 5631 |
|
</section> |
| 5632 |
|
|
| 5633 |
|
<section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO"> |
| 5634 |
|
<t>Client may want to be notified when changes were made to MIDI instruments on the |
| 5635 |
|
back-end by issuing the following command:</t> |
| 5636 |
|
<t> |
| 5637 |
|
<list> |
| 5638 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t> |
| 5639 |
|
</list> |
| 5640 |
|
</t> |
| 5641 |
|
<t>Server will start sending the following notification messages:</t> |
| 5642 |
|
<t> |
| 5643 |
|
<list> |
| 5644 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"</t> |
| 5645 |
|
</list> |
| 5646 |
|
</t> |
| 5647 |
|
<t>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
| 5648 |
|
in which a MIDI instrument is changed. <bank> and <program> specifies |
| 5649 |
|
the location of the changed MIDI instrument in the map. The front-end will have to send |
| 5650 |
|
the respective command to actually get the MIDI instrument info. Because these messages |
| 5651 |
|
will be triggered by LSCP commands issued by other clients rather than real |
| 5652 |
|
time events happening on the server, it is believed that an empty notification |
| 5653 |
|
message is sufficient here.</t> |
| 5654 |
|
</section> |
| 5655 |
|
|
| 5656 |
|
<section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO"> |
| 5657 |
|
<t>Client may want to be notified when changes to the global settings |
| 5658 |
|
of the sampler were made by issuing the following command:</t> |
| 5659 |
|
<t> |
| 5660 |
|
<list> |
| 5661 |
|
<t>SUBSCRIBE GLOBAL_INFO</t> |
| 5662 |
|
</list> |
| 5663 |
|
</t> |
| 5664 |
|
<t>Server will start sending the following types of notification messages:</t> |
| 5665 |
|
<t> |
| 5666 |
|
<list> |
| 5667 |
|
<t>"NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the |
| 5668 |
|
golbal volume of the sampler is changed, where <volume> will be |
| 5669 |
|
replaced by the optional dotted floating point value, reflecting the |
| 5670 |
|
new global volume parameter.</t> |
| 5671 |
|
</list> |
| 5672 |
|
</t> |
| 5673 |
|
</section> |
| 5674 |
|
|
| 5675 |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
| 5676 |
<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 |
| 5677 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |
Parent Directory
| 
Revision Log
| 
Patch