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="December" year="2006"/> |
<date month="January" 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> |
3227 |
</t> |
</t> |
3228 |
</section> |
</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="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL"> |
3483 |
|
<t>The front-end can alter the destination of an effect send's audio channel on a specific |
3484 |
|
sampler channel by sending the following command:</t> |
3485 |
|
<t> |
3486 |
|
<list> |
3487 |
|
<t>SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id> <audio-src> <audio-dst></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, |
3496 |
|
<audio-src> is the numerical ID of the effect send's audio channel |
3497 |
|
which should be rerouted and <audio-dst> is the numerical ID of |
3498 |
|
the audio channel of the selected audio output device where <audio-src> |
3499 |
|
should be routed to.</t> |
3500 |
|
|
3501 |
|
<t>Note that effect sends can only route audio to the same audio output |
3502 |
|
device as assigned to the effect send's sampler channel. Also note that an |
3503 |
|
effect send entity does always have exactly as much audio channels as its |
3504 |
|
sampler channel. So if the sampler channel is stereo, the effect send does |
3505 |
|
have two audio channels as well. Also keep in mind that the amount of audio |
3506 |
|
channels on a sampler channel might be dependant not only to the deployed |
3507 |
|
sampler engine on the sampler channel, but also dependant to the instrument |
3508 |
|
currently loaded. However you can (effectively) turn an i.e. stereo effect |
3509 |
|
send into a mono one by simply altering its audio routing appropriately.</t> |
3510 |
|
|
3511 |
|
<t>Possible Answers:</t> |
3512 |
|
<t> |
3513 |
|
<list> |
3514 |
|
<t>"OK" - |
3515 |
|
<list> |
3516 |
|
<t>on success</t> |
3517 |
|
</list> |
3518 |
|
</t> |
3519 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3520 |
|
<list> |
3521 |
|
<t>if audio output channel was set, but there are noteworthy |
3522 |
|
issue(s) related, providing an appropriate warning code and |
3523 |
|
warning message</t> |
3524 |
|
</list> |
3525 |
|
</t> |
3526 |
|
<t>"ERR:<error-code>:<error-message>" - |
3527 |
|
<list> |
3528 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3529 |
|
</list> |
3530 |
|
</t> |
3531 |
|
</list> |
3532 |
|
</t> |
3533 |
|
<t>Example:</t> |
3534 |
|
<t> |
3535 |
|
<list> |
3536 |
|
<t>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"</t> |
3537 |
|
<t>S: "OK"</t> |
3538 |
|
</list> |
3539 |
|
</t> |
3540 |
|
</section> |
3541 |
|
|
3542 |
|
<section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER"> |
3543 |
|
<t>The front-end can alter the MIDI controller of an effect |
3544 |
|
send entity by sending the following command:</t> |
3545 |
|
<t> |
3546 |
|
<list> |
3547 |
|
<t>SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-ctrl></t> |
3548 |
|
</list> |
3549 |
|
</t> |
3550 |
|
<t>Where <sampler-chan> is the sampler channel number |
3551 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3552 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3553 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3554 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3555 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
3556 |
|
<midi-ctrl> reflects the MIDI controller which shall be |
3557 |
|
able to modify the effect send's send level.</t> |
3558 |
|
|
3559 |
|
<t>Possible Answers:</t> |
3560 |
|
<t> |
3561 |
|
<list> |
3562 |
|
<t>"OK" - |
3563 |
|
<list> |
3564 |
|
<t>on success</t> |
3565 |
|
</list> |
3566 |
|
</t> |
3567 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3568 |
|
<list> |
3569 |
|
<t>if MIDI controller was set, but there are noteworthy |
3570 |
|
issue(s) related, providing an appropriate warning code and |
3571 |
|
warning message</t> |
3572 |
|
</list> |
3573 |
|
</t> |
3574 |
|
<t>"ERR:<error-code>:<error-message>" - |
3575 |
|
<list> |
3576 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3577 |
|
</list> |
3578 |
|
</t> |
3579 |
|
</list> |
3580 |
|
</t> |
3581 |
|
<t>Example:</t> |
3582 |
|
<t> |
3583 |
|
<list> |
3584 |
|
<t>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"</t> |
3585 |
|
<t>S: "OK"</t> |
3586 |
|
</list> |
3587 |
|
</t> |
3588 |
|
</section> |
3589 |
|
|
3590 |
|
<section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL"> |
3591 |
|
<t>The front-end can alter the current send level of an effect |
3592 |
|
send entity by sending the following command:</t> |
3593 |
|
<t> |
3594 |
|
<list> |
3595 |
|
<t>SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume></t> |
3596 |
|
</list> |
3597 |
|
</t> |
3598 |
|
<t>Where <sampler-chan> is the sampler channel number |
3599 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3600 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3601 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3602 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3603 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
3604 |
|
<volume> is an optionally dotted positive number (a value |
3605 |
|
smaller than 1.0 means attenuation, whereas a value greater than |
3606 |
|
1.0 means amplification) reflecting the new send level.</t> |
3607 |
|
|
3608 |
|
<t>Possible Answers:</t> |
3609 |
|
<t> |
3610 |
|
<list> |
3611 |
|
<t>"OK" - |
3612 |
|
<list> |
3613 |
|
<t>on success</t> |
3614 |
|
</list> |
3615 |
|
</t> |
3616 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3617 |
|
<list> |
3618 |
|
<t>if new send level was set, but there are noteworthy |
3619 |
|
issue(s) related, providing an appropriate warning code and |
3620 |
|
warning message</t> |
3621 |
|
</list> |
3622 |
|
</t> |
3623 |
|
<t>"ERR:<error-code>:<error-message>" - |
3624 |
|
<list> |
3625 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3626 |
|
</list> |
3627 |
|
</t> |
3628 |
|
</list> |
3629 |
|
</t> |
3630 |
|
<t>Example:</t> |
3631 |
|
<t> |
3632 |
|
<list> |
3633 |
|
<t>C: "SET FX_SEND LEVEL 0 0 0.15"</t> |
3634 |
|
<t>S: "OK"</t> |
3635 |
|
</list> |
3636 |
|
</t> |
3637 |
|
</section> |
3638 |
|
|
3639 |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
3640 |
<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> |
3641 |
<t> |
<t> |
3925 |
<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. |
3926 |
Other fields might be added in future.</t> |
Other fields might be added in future.</t> |
3927 |
</section> |
</section> |
3928 |
|
|
3929 |
|
<section title="Getting global volume attenuation" anchor="GET VOLUME"> |
3930 |
|
<t>The client can ask for the current global sampler-wide volume |
3931 |
|
attenuation by sending the following command:</t> |
3932 |
|
<t> |
3933 |
|
<list> |
3934 |
|
<t>GET VOLUME</t> |
3935 |
|
</list> |
3936 |
|
</t> |
3937 |
|
<t>Possible Answers:</t> |
3938 |
|
<t> |
3939 |
|
<list> |
3940 |
|
<t>The sampler will always answer by returning the optional |
3941 |
|
dotted floating point coefficient, reflecting the current |
3942 |
|
global volume attenuation. |
3943 |
|
</t> |
3944 |
|
</list> |
3945 |
|
</t> |
3946 |
|
<t>Note: it is up to the respective sampler engine whether to obey |
3947 |
|
that global volume parameter or not, but in general all engines SHOULD |
3948 |
|
use this parameter.</t> |
3949 |
|
</section> |
3950 |
|
|
3951 |
|
<section title="Setting global volume attenuation" anchor="SET VOLUME"> |
3952 |
|
<t>The client can alter the current global sampler-wide volume |
3953 |
|
attenuation by sending the following command:</t> |
3954 |
|
<t> |
3955 |
|
<list> |
3956 |
|
<t>SET VOLUME <volume></t> |
3957 |
|
</list> |
3958 |
|
</t> |
3959 |
|
<t>Where <volume> should be replaced by the optional dotted |
3960 |
|
floating point value, reflecting the new global volume parameter. |
3961 |
|
This value might usually be in the range between 0.0 and 1.0, that |
3962 |
|
is for attenuating the overall volume.</t> |
3963 |
|
|
3964 |
|
<t>Possible Answers:</t> |
3965 |
|
<t> |
3966 |
|
<list> |
3967 |
|
<t>"OK" - |
3968 |
|
<list> |
3969 |
|
<t>on success</t> |
3970 |
|
</list> |
3971 |
|
</t> |
3972 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3973 |
|
<list> |
3974 |
|
<t>if the global volume was set, but there are noteworthy |
3975 |
|
issue(s) related, providing an appropriate warning code and |
3976 |
|
warning message</t> |
3977 |
|
</list> |
3978 |
|
</t> |
3979 |
|
<t>"ERR:<error-code>:<error-message>" - |
3980 |
|
<list> |
3981 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3982 |
|
</list> |
3983 |
|
</t> |
3984 |
|
</list> |
3985 |
|
</t> |
3986 |
|
</section> |
3987 |
</section> |
</section> |
3988 |
|
|
3989 |
|
|
4275 |
<instrument_index> the index (integer value) of the instrument |
<instrument_index> the index (integer value) of the instrument |
4276 |
within the given file, <volume_value> reflects the master |
within the given file, <volume_value> reflects the master |
4277 |
volume of the instrument as optionally dotted number (where a |
volume of the instrument as optionally dotted number (where a |
4278 |
value < 1.0 means attenuation and a value > 1.0 means |
value < 1.0 means attenuation and a value > 1.0 means |
4279 |
amplification). This parameter easily allows to adjust the |
amplification). This parameter easily allows to adjust the |
4280 |
volume of all intruments within a custom instrument map |
volume of all intruments within a custom instrument map |
4281 |
without having to adjust their instrument files. The |
without having to adjust their instrument files. The |
4608 |
<t>"VOLUME" - |
<t>"VOLUME" - |
4609 |
<list> |
<list> |
4610 |
<t>master volume of the instrument as optionally |
<t>master volume of the instrument as optionally |
4611 |
dotted number (where a value < 1.0 means attenuation |
dotted number (where a value < 1.0 means attenuation |
4612 |
and a value > 1.0 means amplification)</t> |
and a value > 1.0 means amplification)</t> |
4613 |
</list> |
</list> |
4614 |
</t> |
</t> |
4779 |
</t> |
</t> |
4780 |
<t>subscribe_event = |
<t>subscribe_event = |
4781 |
<list> |
<list> |
4782 |
<t>CHANNEL_COUNT |
<t>AUDIO_OUTPUT_DEVICE_COUNT |
4783 |
|
</t> |
4784 |
|
<t>/ AUDIO_OUTPUT_DEVICE_INFO |
4785 |
|
</t> |
4786 |
|
<t>/ MIDI_INPUT_DEVICE_COUNT |
4787 |
|
</t> |
4788 |
|
<t>/ MIDI_INPUT_DEVICE_INFO |
4789 |
|
</t> |
4790 |
|
<t>/ CHANNEL_COUNT |
4791 |
</t> |
</t> |
4792 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
4793 |
</t> |
</t> |
4797 |
</t> |
</t> |
4798 |
<t>/ CHANNEL_INFO |
<t>/ CHANNEL_INFO |
4799 |
</t> |
</t> |
4800 |
|
<t>/ MIDI_INSTRUMENT_MAP_COUNT |
4801 |
|
</t> |
4802 |
|
<t>/ MIDI_INSTRUMENT_MAP_INFO |
4803 |
|
</t> |
4804 |
|
<t>/ MIDI_INSTRUMENT_COUNT |
4805 |
|
</t> |
4806 |
|
<t>/ MIDI_INSTRUMENT_INFO |
4807 |
|
</t> |
4808 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
4809 |
</t> |
</t> |
4810 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
4813 |
</t> |
</t> |
4814 |
<t>unsubscribe_event = |
<t>unsubscribe_event = |
4815 |
<list> |
<list> |
4816 |
<t>CHANNEL_COUNT |
<t>AUDIO_OUTPUT_DEVICE_COUNT |
4817 |
|
</t> |
4818 |
|
<t>/ AUDIO_OUTPUT_DEVICE_INFO |
4819 |
|
</t> |
4820 |
|
<t>/ MIDI_INPUT_DEVICE_COUNT |
4821 |
|
</t> |
4822 |
|
<t>/ MIDI_INPUT_DEVICE_INFO |
4823 |
|
</t> |
4824 |
|
<t>/ CHANNEL_COUNT |
4825 |
</t> |
</t> |
4826 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
4827 |
</t> |
</t> |
4831 |
</t> |
</t> |
4832 |
<t>/ CHANNEL_INFO |
<t>/ CHANNEL_INFO |
4833 |
</t> |
</t> |
4834 |
|
<t>/ MIDI_INSTRUMENT_MAP_COUNT |
4835 |
|
</t> |
4836 |
|
<t>/ MIDI_INSTRUMENT_MAP_INFO |
4837 |
|
</t> |
4838 |
|
<t>/ MIDI_INSTRUMENT_COUNT |
4839 |
|
</t> |
4840 |
|
<t>/ MIDI_INSTRUMENT_INFO |
4841 |
|
</t> |
4842 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
4843 |
</t> |
</t> |
4844 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
4937 |
</t> |
</t> |
4938 |
<t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
<t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
4939 |
</t> |
</t> |
4940 |
|
<t>/ FX_SENDS SP sampler_channel |
4941 |
|
</t> |
4942 |
|
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
4943 |
|
</t> |
4944 |
|
<t>/ VOLUME |
4945 |
|
</t> |
4946 |
</list> |
</list> |
4947 |
</t> |
</t> |
4948 |
<t>set_instruction = |
<t>set_instruction = |
4959 |
</t> |
</t> |
4960 |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
4961 |
</t> |
</t> |
4962 |
|
<t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index |
4963 |
|
</t> |
4964 |
|
<t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl |
4965 |
|
</t> |
4966 |
|
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
4967 |
|
</t> |
4968 |
<t>/ ECHO SP boolean |
<t>/ ECHO SP boolean |
4969 |
</t> |
</t> |
4970 |
|
<t>/ VOLUME SP volume_value |
4971 |
|
</t> |
4972 |
</list> |
</list> |
4973 |
</t> |
</t> |
4974 |
<t>create_instruction = |
<t>create_instruction = |
4981 |
</t> |
</t> |
4982 |
<t>/ MIDI_INPUT_DEVICE SP string |
<t>/ MIDI_INPUT_DEVICE SP string |
4983 |
</t> |
</t> |
4984 |
|
<t>/ FX_SEND SP sampler_channel SP midi_ctrl |
4985 |
|
</t> |
4986 |
|
<t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
4987 |
|
</t> |
4988 |
</list> |
</list> |
4989 |
</t> |
</t> |
4990 |
<t>reset_instruction = |
<t>reset_instruction = |
5007 |
</t> |
</t> |
5008 |
<t>/ MIDI_INPUT_DEVICE SP number |
<t>/ MIDI_INPUT_DEVICE SP number |
5009 |
</t> |
</t> |
5010 |
|
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
5011 |
|
</t> |
5012 |
</list> |
</list> |
5013 |
</t> |
</t> |
5014 |
<t>load_instruction = |
<t>load_instruction = |
5087 |
</t> |
</t> |
5088 |
<t>/ MIDI_INSTRUMENT_MAPS |
<t>/ MIDI_INSTRUMENT_MAPS |
5089 |
</t> |
</t> |
5090 |
|
<t>/ FX_SENDS SP sampler_channel |
5091 |
|
</t> |
5092 |
</list> |
</list> |
5093 |
</t> |
</t> |
5094 |
<t>load_instr_args = |
<t>load_instr_args = |
5171 |
</t> |
</t> |
5172 |
</list> |
</list> |
5173 |
</t> |
</t> |
5174 |
|
<t>midi_ctrl = |
5175 |
|
<list> |
5176 |
|
<t>number |
5177 |
|
</t> |
5178 |
|
</list> |
5179 |
|
</t> |
5180 |
<t>volume_value = |
<t>volume_value = |
5181 |
<list> |
<list> |
5182 |
<t>dotnum |
<t>dotnum |
5197 |
</t> |
</t> |
5198 |
</list> |
</list> |
5199 |
</t> |
</t> |
5200 |
|
<t>fx_send_id = |
5201 |
|
<list> |
5202 |
|
<t>number |
5203 |
|
</t> |
5204 |
|
</list> |
5205 |
|
</t> |
5206 |
<t>engine_name = |
<t>engine_name = |
5207 |
<list> |
<list> |
5208 |
<t>string |
<t>string |
5227 |
</t> |
</t> |
5228 |
</list> |
</list> |
5229 |
</t> |
</t> |
5230 |
|
<t>fx_send_name = |
5231 |
|
<list> |
5232 |
|
<t>stringval |
5233 |
|
</t> |
5234 |
|
</list> |
5235 |
|
</t> |
5236 |
<t>param_val_list = |
<t>param_val_list = |
5237 |
<list> |
<list> |
5238 |
<t>param_val |
<t>param_val |
5260 |
<section title="Events" anchor="events"> |
<section title="Events" anchor="events"> |
5261 |
<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> |
5262 |
|
|
5263 |
<section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL"> |
<section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"> |
5264 |
|
<t>Client may want to be notified when the total number of audio output devices on the |
5265 |
|
back-end changes by issuing the following command:</t> |
5266 |
|
<t> |
5267 |
|
<list> |
5268 |
|
<t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t> |
5269 |
|
</list> |
5270 |
|
</t> |
5271 |
|
<t>Server will start sending the following notification messages:</t> |
5272 |
|
<t> |
5273 |
|
<list> |
5274 |
|
<t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"</t> |
5275 |
|
</list> |
5276 |
|
</t> |
5277 |
|
<t>where <devices> will be replaced by the new number |
5278 |
|
of audio output devices.</t> |
5279 |
|
</section> |
5280 |
|
|
5281 |
|
<section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"> |
5282 |
|
<t>Client may want to be notified when changes were made to audio output devices on the |
5283 |
|
back-end by issuing the following command:</t> |
5284 |
|
<t> |
5285 |
|
<list> |
5286 |
|
<t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t> |
5287 |
|
</list> |
5288 |
|
</t> |
5289 |
|
<t>Server will start sending the following notification messages:</t> |
5290 |
|
<t> |
5291 |
|
<list> |
5292 |
|
<t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"</t> |
5293 |
|
</list> |
5294 |
|
</t> |
5295 |
|
<t>where <device-id> will be replaced by the numerical ID of the audio output device, |
5296 |
|
which settings has been changed. The front-end will have to send |
5297 |
|
the respective command to actually get the audio output device info. Because these messages |
5298 |
|
will be triggered by LSCP commands issued by other clients rather than real |
5299 |
|
time events happening on the server, it is believed that an empty notification |
5300 |
|
message is sufficient here.</t> |
5301 |
|
</section> |
5302 |
|
|
5303 |
|
<section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"> |
5304 |
|
<t>Client may want to be notified when the total number of MIDI input devices on the |
5305 |
|
back-end changes by issuing the following command:</t> |
5306 |
|
<t> |
5307 |
|
<list> |
5308 |
|
<t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t> |
5309 |
|
</list> |
5310 |
|
</t> |
5311 |
|
<t>Server will start sending the following notification messages:</t> |
5312 |
|
<t> |
5313 |
|
<list> |
5314 |
|
<t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"</t> |
5315 |
|
</list> |
5316 |
|
</t> |
5317 |
|
<t>where <devices> will be replaced by the new number |
5318 |
|
of MIDI input devices.</t> |
5319 |
|
</section> |
5320 |
|
|
5321 |
|
<section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"> |
5322 |
|
<t>Client may want to be notified when changes were made to MIDI input devices on the |
5323 |
|
back-end by issuing the following command:</t> |
5324 |
|
<t> |
5325 |
|
<list> |
5326 |
|
<t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t> |
5327 |
|
</list> |
5328 |
|
</t> |
5329 |
|
<t>Server will start sending the following notification messages:</t> |
5330 |
|
<t> |
5331 |
|
<list> |
5332 |
|
<t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"</t> |
5333 |
|
</list> |
5334 |
|
</t> |
5335 |
|
<t>where <device-id> will be replaced by the numerical ID of the MIDI input device, |
5336 |
|
which settings has been changed. The front-end will have to send |
5337 |
|
the respective command to actually get the MIDI input device info. Because these messages |
5338 |
|
will be triggered by LSCP commands issued by other clients rather than real |
5339 |
|
time events happening on the server, it is believed that an empty notification |
5340 |
|
message is sufficient here.</t> |
5341 |
|
</section> |
5342 |
|
|
5343 |
|
<section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT"> |
5344 |
<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 |
5345 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
5346 |
<t> |
<t> |
5417 |
"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> |
5418 |
</section> |
</section> |
5419 |
|
|
5420 |
<section title="Channel information changed" anchor="SUBSCRIBE INFO"> |
<section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO"> |
5421 |
<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 |
5422 |
back-end by issuing the following command:</t> |
back-end by issuing the following command:</t> |
5423 |
<t> |
<t> |
5457 |
all currently active voices.</t> |
all currently active voices.</t> |
5458 |
</section> |
</section> |
5459 |
|
|
5460 |
|
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
5461 |
|
<t>Client may want to be notified when the number of MIDI instrument maps on the |
5462 |
|
back-end changes by issuing the following command:</t> |
5463 |
|
<t> |
5464 |
|
<list> |
5465 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t> |
5466 |
|
</list> |
5467 |
|
</t> |
5468 |
|
<t>Server will start sending the following notification messages:</t> |
5469 |
|
<t> |
5470 |
|
<list> |
5471 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"</t> |
5472 |
|
</list> |
5473 |
|
</t> |
5474 |
|
<t>where <maps> will be replaced by the new number |
5475 |
|
of MIDI instrument maps.</t> |
5476 |
|
</section> |
5477 |
|
|
5478 |
|
<section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"> |
5479 |
|
<t>Client may want to be notified when changes were made to MIDI instrument maps on the |
5480 |
|
back-end by issuing the following command:</t> |
5481 |
|
<t> |
5482 |
|
<list> |
5483 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t> |
5484 |
|
</list> |
5485 |
|
</t> |
5486 |
|
<t>Server will start sending the following notification messages:</t> |
5487 |
|
<t> |
5488 |
|
<list> |
5489 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"</t> |
5490 |
|
</list> |
5491 |
|
</t> |
5492 |
|
<t>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
5493 |
|
for which information changes occurred. The front-end will have to send |
5494 |
|
the respective command to actually get the MIDI instrument map info. Because these messages |
5495 |
|
will be triggered by LSCP commands issued by other clients rather than real |
5496 |
|
time events happening on the server, it is believed that an empty notification |
5497 |
|
message is sufficient here.</t> |
5498 |
|
</section> |
5499 |
|
|
5500 |
|
<section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT"> |
5501 |
|
<t>Client may want to be notified when the number of MIDI instrument maps on the |
5502 |
|
back-end changes by issuing the following command:</t> |
5503 |
|
<t> |
5504 |
|
<list> |
5505 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t> |
5506 |
|
</list> |
5507 |
|
</t> |
5508 |
|
<t>Server will start sending the following notification messages:</t> |
5509 |
|
<t> |
5510 |
|
<list> |
5511 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"</t> |
5512 |
|
</list> |
5513 |
|
</t> |
5514 |
|
<t>where <map-id> is the numerical ID of the MIDI instrument map, in which |
5515 |
|
the nuber of instruments has changed and <instruments> will be replaced by |
5516 |
|
the new number of MIDI instruments in the specified map.</t> |
5517 |
|
</section> |
5518 |
|
|
5519 |
|
<section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO"> |
5520 |
|
<t>Client may want to be notified when changes were made to MIDI instruments on the |
5521 |
|
back-end by issuing the following command:</t> |
5522 |
|
<t> |
5523 |
|
<list> |
5524 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t> |
5525 |
|
</list> |
5526 |
|
</t> |
5527 |
|
<t>Server will start sending the following notification messages:</t> |
5528 |
|
<t> |
5529 |
|
<list> |
5530 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"</t> |
5531 |
|
</list> |
5532 |
|
</t> |
5533 |
|
<t>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
5534 |
|
in which a MIDI instrument is changed. <bank> and <program> specifies |
5535 |
|
the location of the changed MIDI instrument in the map. The front-end will have to send |
5536 |
|
the respective command to actually get the MIDI instrument info. Because these messages |
5537 |
|
will be triggered by LSCP commands issued by other clients rather than real |
5538 |
|
time events happening on the server, it is believed that an empty notification |
5539 |
|
message is sufficient here.</t> |
5540 |
|
</section> |
5541 |
|
|
5542 |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
5543 |
<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 |
5544 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |