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>AUDIO_OUTPUT_ROUTING - |
3438 |
|
<list> |
3439 |
|
<t>comma separated list which reflects to which audio |
3440 |
|
channel of the selected audio output device each |
3441 |
|
effect send output channel is routed to, e.g. "0,3" would |
3442 |
|
mean the effect send's output channel 0 is routed to channel |
3443 |
|
0 of the audio output device and the effect send's output |
3444 |
|
channel 1 is routed to the channel 3 of the audio |
3445 |
|
output device (see |
3446 |
|
<xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref> |
3447 |
|
for details)</t> |
3448 |
|
</list> |
3449 |
|
</t> |
3450 |
|
</list> |
3451 |
|
</t> |
3452 |
|
</list> |
3453 |
|
</t> |
3454 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
3455 |
|
|
3456 |
|
<t>Example:</t> |
3457 |
|
<t> |
3458 |
|
<list> |
3459 |
|
<t>C: "GET FX_SEND INFO 0 0"</t> |
3460 |
|
<t>S: "NAME: Reverb Send"</t> |
3461 |
|
<t> "AUDIO_OUTPUT_ROUTING: 2,3"</t> |
3462 |
|
<t> "."</t> |
3463 |
|
</list> |
3464 |
|
</t> |
3465 |
|
</section> |
3466 |
|
|
3467 |
|
<section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL"> |
3468 |
|
<t>The front-end can alter the destination of an effect send's audio channel on a specific |
3469 |
|
sampler channel by sending the following command:</t> |
3470 |
|
<t> |
3471 |
|
<list> |
3472 |
|
<t>SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id> <audio-src> <audio-dst></t> |
3473 |
|
</list> |
3474 |
|
</t> |
3475 |
|
<t>Where <sampler-chan> is the sampler channel number |
3476 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3477 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3478 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3479 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3480 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command, |
3481 |
|
<audio-src> is the numerical ID of the effect send's audio channel |
3482 |
|
which should be rerouted and <audio-dst> is the numerical ID of |
3483 |
|
the audio channel of the selected audio output device where <audio-src> |
3484 |
|
should be routed to.</t> |
3485 |
|
|
3486 |
|
<t>Note that effect sends can only route audio to the same audio output |
3487 |
|
device as assigned to the effect send's sampler channel. Also note that an |
3488 |
|
effect send entity does always have exactly as much audio channels as its |
3489 |
|
sampler channel. So if the sampler channel is stereo, the effect send does |
3490 |
|
have two audio channels as well. Also keep in mind that the amount of audio |
3491 |
|
channels on a sampler channel might be dependant not only to the deployed |
3492 |
|
sampler engine on the sampler channel, but also dependant to the instrument |
3493 |
|
currently loaded. However you can (effectively) turn an i.e. stereo effect |
3494 |
|
send into a mono one by simply altering its audio routing appropriately.</t> |
3495 |
|
|
3496 |
|
<t>Possible Answers:</t> |
3497 |
|
<t> |
3498 |
|
<list> |
3499 |
|
<t>"OK" - |
3500 |
|
<list> |
3501 |
|
<t>on success</t> |
3502 |
|
</list> |
3503 |
|
</t> |
3504 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3505 |
|
<list> |
3506 |
|
<t>if audio output channel was set, but there are noteworthy |
3507 |
|
issue(s) related, providing an appropriate warning code and |
3508 |
|
warning message</t> |
3509 |
|
</list> |
3510 |
|
</t> |
3511 |
|
<t>"ERR:<error-code>:<error-message>" - |
3512 |
|
<list> |
3513 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3514 |
|
</list> |
3515 |
|
</t> |
3516 |
|
</list> |
3517 |
|
</t> |
3518 |
|
<t>Example:</t> |
3519 |
|
<t> |
3520 |
|
<list> |
3521 |
|
<t>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"</t> |
3522 |
|
<t>S: "OK"</t> |
3523 |
|
</list> |
3524 |
|
</t> |
3525 |
|
</section> |
3526 |
|
|
3527 |
|
|
3528 |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
3529 |
<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> |
3530 |
<t> |
<t> |
4767 |
</t> |
</t> |
4768 |
<t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
<t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
4769 |
</t> |
</t> |
4770 |
|
<t>/ FX_SENDS SP sampler_channel |
4771 |
|
</t> |
4772 |
|
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
4773 |
|
</t> |
4774 |
</list> |
</list> |
4775 |
</t> |
</t> |
4776 |
<t>set_instruction = |
<t>set_instruction = |
4787 |
</t> |
</t> |
4788 |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
4789 |
</t> |
</t> |
4790 |
|
<t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index |
4791 |
|
</t> |
4792 |
<t>/ ECHO SP boolean |
<t>/ ECHO SP boolean |
4793 |
</t> |
</t> |
4794 |
</list> |
</list> |
4803 |
</t> |
</t> |
4804 |
<t>/ MIDI_INPUT_DEVICE SP string |
<t>/ MIDI_INPUT_DEVICE SP string |
4805 |
</t> |
</t> |
4806 |
|
<t>/ FX_SEND SP sampler_channel SP midi_ctrl |
4807 |
|
</t> |
4808 |
|
<t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
4809 |
|
</t> |
4810 |
</list> |
</list> |
4811 |
</t> |
</t> |
4812 |
<t>reset_instruction = |
<t>reset_instruction = |
4829 |
</t> |
</t> |
4830 |
<t>/ MIDI_INPUT_DEVICE SP number |
<t>/ MIDI_INPUT_DEVICE SP number |
4831 |
</t> |
</t> |
4832 |
|
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
4833 |
|
</t> |
4834 |
</list> |
</list> |
4835 |
</t> |
</t> |
4836 |
<t>load_instruction = |
<t>load_instruction = |
4909 |
</t> |
</t> |
4910 |
<t>/ MIDI_INSTRUMENT_MAPS |
<t>/ MIDI_INSTRUMENT_MAPS |
4911 |
</t> |
</t> |
4912 |
|
<t>/ FX_SENDS SP sampler_channel |
4913 |
|
</t> |
4914 |
</list> |
</list> |
4915 |
</t> |
</t> |
4916 |
<t>load_instr_args = |
<t>load_instr_args = |
4993 |
</t> |
</t> |
4994 |
</list> |
</list> |
4995 |
</t> |
</t> |
4996 |
|
<t>midi_ctrl = |
4997 |
|
<list> |
4998 |
|
<t>number |
4999 |
|
</t> |
5000 |
|
</list> |
5001 |
|
</t> |
5002 |
<t>volume_value = |
<t>volume_value = |
5003 |
<list> |
<list> |
5004 |
<t>dotnum |
<t>dotnum |
5019 |
</t> |
</t> |
5020 |
</list> |
</list> |
5021 |
</t> |
</t> |
5022 |
|
<t>fx_send_id = |
5023 |
|
<list> |
5024 |
|
<t>number |
5025 |
|
</t> |
5026 |
|
</list> |
5027 |
|
</t> |
5028 |
<t>engine_name = |
<t>engine_name = |
5029 |
<list> |
<list> |
5030 |
<t>string |
<t>string |
5047 |
<list> |
<list> |
5048 |
<t>stringval |
<t>stringval |
5049 |
</t> |
</t> |
5050 |
|
</list> |
5051 |
|
</t> |
5052 |
|
<t>fx_send_name = |
5053 |
|
<list> |
5054 |
|
<t>stringval |
5055 |
|
</t> |
5056 |
</list> |
</list> |
5057 |
</t> |
</t> |
5058 |
<t>param_val_list = |
<t>param_val_list = |