Reference

From Eigenzone

Scripting

As of EigenD 1.1.0-unstable it's possible to write scripts with textual Belcanto commands that can be executed into your user setup and even to input them manually through the Commander tool. For more information about these features or to download ready-made scripts, please visit the Scripts page.

Sending commands

To send commands to an agent you have several options:

You send one command and use hey
You send multiple commands and use listen and stop the commands with un listen, the latter isn't required

Single command example:

scaler 3 hey relative octave to - 3 set

Multiple command example:

scaler 3 listen
relative octave to - 3 set
all k range to 2 set
scaler 3 un listen

Scalers

Scalers are agents that provides tuning/frequency information for the instruments, they listen to commands that are relevant to that.

To send a Belcanto command to a scaler, you start your line with:

scaler 1 hey

To send a Belcanto command to all scalers, you start your line with:

all scaler hey

Here are the known scaler commands:

relative octave to - 3 set
set to relative octave of an instrument to the number specified (the minus has to be separated from the number by a space)
relative octave un set
set to relative octave of an instrument to the default
relative octave up
set the relative octave of an instrument upwards by 1
relative octave down
set the relative octave of an instrument downwards by 1
all k range to 2 set
set the pitch bend range of an instrument by the number of specified semi-tones
all k range un set
set the pitch bend range of an instrument to the default

This in an example of a full scaler command:

scaler 9 hey relative octave to - 3 set

These are the scalers on the various Eigenharps:

Pico Scalers

scaler 1 = Sampler 1
scaler 2 = Sampler 2
scaler 3 = Sampler 3
scaler 4 = Audio unit 1
scaler 5 = Audio unit 2
scaler 9 = Cello
scaler 7 = Clarinet
scaler 8 = MIDI out

Audio Units

The 'audio unit' command gives access to agents that allow the hosting of standard Audio Unit plugins.

To send a Belcanto command to a scaler, you start your script commands with:

audio unit 1 hey

This is an example of a full audio unit command:

audio unit 1 hey tail time to 60 set

Here are the known audio unit commands:

tail time to 60 set
set the tail time of the audio unit to the specified number of seconds (100000 being the maximum)
tail time un set
set the tail time of the audio unit to the default
show
shows the audio unit GUI
un show
hides the audio unit GUI

These are the scalers on the various Eigenharps:

Pico Audio Units

audio unit 1 = Audio Unit 1 Instrument
audio unit 2 = Audio Unit 2 Instrument
audio unit 4 = FX Send 1 Audio Unit
audio unit 3 = FX Send 2 Audio Unit
audio unit 6 = AU Inline FX 1 (for Sampler 1)
audio unit 7 = AU Inline FX 2 (for Sampler 2)
audio unit 8 = AU Inline FX 3 (for Sampler 3)
audio unit 9 = AU Inline FX 4 (for Audio Unit 1)
audio unit 10 = AU Inline FX 5 (for Audio Unit 2)
audio unit 11 = AU Inline FX 6 (for Cello)
audio unit 12 = AU Inline FX 7 (for Clarinet)

Saving setups

In order to save a setup using Belcanto in the Commander (in the unstable releases) but still ensure that it will get upgraded by subsequent releases, you need to make sure that you setup name is of the format "user 'n'" where 'n' is a number or a sequence of numbers. This is the best way to guarantee that there is Belcanto support for your new setup name (as 'user 1' is a belcanto noun phrase) and that it will therefore get upgraded.

The syntax for saving setups in the Commander is as follows:

eigend hey user n save

This is an example of a full save command to use more than the 10 default user setups:

eigend hey user 12 save

Opening the scripts browser

The script browser can be opened through Belcanto by typing the following command in the Commander. To be able to see the scripts, the EigenBrowser window should be open first.

eigenbrowser , interpreter hey script browse