Documentation Wiki rss-feed

Audio Unit


Name

Audio Unit:

image:audio_unit_expanded.png

1118 8728
audio unit

Description

The Audio Unit agent acts as plug-in host for Audio Unit or VST Instruments and Effects.

See also - Routing Matrix and Configuring AudioUnit and VST plugins.

Ports

Tempo Input

  • Name:

168 116
tempo input

  • Input
  • Type: Generic

The Tempo Input usually receives tempo information from the Metronome agent in order to synchronise tempo-based audio unit or VST plugins with EigenD's internal clock - however it can also be a value provided by the user.

Running Input

  • Name:

1488 116
running input

  • Input
  • Type: Generic

The running input is used to indicate that the Metronome agent is running - you need to connect the 'running output' of the Metronome to this input in order to synchronise tempo-based audio unit or VST plugins with EigenD's internal clock.

Song Beat Input

  • Name:

652 127 116
song beat input

  • Input
  • Type: Generic

The Song Beat Input is used to indicate the current position of the song when the Metronome agent is running - you need to connect the 'song beat output' of the Metronome to this input in order to synchronise tempo-based audio unit or VST plugins with EigenD's internal clock.

Bar Beat Input

  • Name

126 127 116
bar beat input

  • Input
  • Type: Generic

The Bar Beat Input is used to indicate the current beat of the bar when the Metronome is running - you need to connect the 'bar beat output' of the Metronome to this input in order to synchronise tempo-based audio unit or VST plugins with EigenD's internal clock.

Pressure input

  • Name:

128 116
pressure input

  • Input
  • Type: Number
  • Range: 0 to 1

The Pressure Input receives key pressure information from upstream agents.

Frequency Input

  • Name:

1128 116
frequency input

  • Input
  • Type: Number
  • Range: 0 to 96000

The Frequency Input receives note frequency information from upstream agents (often the Scaler).

MIDI Channel

  • Name:

1215 1122
midi channel

  • Input, Set
  • Type: Integer
  • Range: 0 to 16
  • Default: 0

MIDI Channel determines the MIDI channel used for input to the Audio Unit agent - values of 1 to 16 refer to the corresponding MIDI channel, a value of 0 indicates poly mode (or MIDI channel cycling - see Maximum Channel and Minimum Channel below).

Minimum Channel

  • Name:

2343 1122
minimum channel

  • Input, Set
  • Type: Integer
  • Range: 1 to 16
  • Default: 1

In poly mode (or when the MIDI channel is set to 0) the Audio Unit agent cycles through MIDI channels - Minimum Channel determines the lowest MIDI channel to use.

Maximum Channel

  • Name:

2342 1122
maximum channel

  • Input, Set
  • Type: Integer
  • Range: 1 to 16
  • Default: 16

In poly mode (or when the MIDI channel is set to 0) the Audio Unit agent cycles through MIDI channels - Maximum Channel determines the highest MIDI channel to use.

Velocity Sample

  • Name:

1417 1275
velocity sample

  • Input, Set
  • Type: Integer
  • Range: 1 to 1000
  • Default: 4

Velocity Sample determines the number of samples used to calculate the velocity of a note.

Velocity Curve

  • Name:

1417 1512
velocity curve

  • Input, Set
  • Type: Number
  • Range: 0.1 to 10
  • Default: 4

Velocity Curve determines the curve applied to the input velocity values to calculate an output velocity: 1 is linear, values below 1 produce a concave curve (attenuating the velocity) and values above 1 produce a convex curve (boosting the velocity). The default value is 4.

Velocity Scale

  • Name:

1417 135
velocity scale

  • Input, Set
  • Type: Number
  • Range: 0.1 to 10
  • Default: 4

Velocity Scale multiplies the raw values for velocity detection with a constant multiplier. The default multiplier is 4.

Tail Time

  • Name:

8773 1147
tail time

  • Input, Set
  • Type: Number
  • Range: 0 to 100000
  • Default: 10

Tail time determines the time (in seconds) before a plugin will become idle once the Audio Unit agent has stopped making any sound.

Tail Time Enable

  • Name:

8773 1147 5584
tail time enable

  • Input, Set
  • Type: On/Off
  • Default: On

Enables or disables the tail time expiration to make an Audio Unit plugin idle. When disabled, an Audio Unit will never be automatically put on idle.

Parameters 1 - 32

  • Name:

8731
parameter

  • Input
  • Type: Generic

Audio Units in the EigenD software have a set of generic parameter inputs, Parameter 1 through Parameter 32. Usually these are receiving information from the various Eigenharp controllers e.g. strip controller, breath controller, key movement. Using the Routing Matrix these can then be routed to the audio unit or VST plugin's parameters. To access the Routing Matrix click on 'Configure' in the top left corner of the plugin's window.

Nouns

Plugin:

A plugin refers to the internal representation of a plugin within the Audio Unit Agent (as opposed to a reference to a particular Audio Unit or VST) - these can be browsed using the EigenBrowser.

Verbs

Show:

136
show

The 'show' verb is used to show the GUI (Graphical User Interface) of the plug-in currently loaded into the Audio Unit Agent.

Un Show:

6 136
un show

The 'un show' verb is used to hide the GUI (Graphical User Interface) of the plug-in currently loaded into the Audio Unit Agent.

Toggle Show:

441 136
toggle show

The 'toggle show' verb is used to toggle the GUI (Graphical User Interface) of the plug-in currently loaded into the Audio Unit Agent.

Close:

8743
close

The 'close' verb is used to remove the instance of the plug-in currently loaded into the Audio Unit Agent.

Bypass:

8742
bypass

The 'bypass' verb is used to pass the data through the Audio Unit Agent without affecting the currently loaded plug-in.

Un Bypass:

6 8742
un bypass

The 'un bypass' verb is used to reverse the 'bypass' verb mentioned above.

Toggle Bypass:

441 8742
toggle bypass

The 'toggle bypass' verb is used to toggle the 'bypass' verb on/off.

Open:

8825
open

The 'open' verb is used to open an instance of a specific plug-in within the Audio Unit Agent.

Scan:

171
scan

The 'scan' verb is used to perform a full validation scan of all your plug-ins installed on your computer for use within EigenD.

Map:

8826
map

The 'map' verb is used to map Audio Unit Agent parameters to plug-in parameters (as with the Configuration Window).

Un Map:

6 8826
un map

The 'un map' verb is used to disconnect Audio Unit Agent parameters from plug-in parameters (as with the Configuration Window).

Set:

67
set

The 'set' verb is used to send program change, band change and continuous control MIDI messages to the Audio Unit plugin.

Examples

Before using the Belcanto commands below, make sure you have the desired Audio Unit Agent in the conversation using

1118 8728 ? 1131
audio unit X listen

where X is the number of the desired Audio Unit Agent.

Showing an Audio Unit GUI

To show an Audio Unit GUI, use

136
show

Hiding an Audio Unit GUI

To hide an Audio Unit GUI, use

6 136
un show

Toggling an Audio Unit GUI

To toggle and Audio Unit GUI, use

441 136
toggle show

Closing a plug-in

To close a plug-in, use

8743
close

Bypassing an Audio Unit

To bypass an Audio Unit, use

8742
bypass

Un Bypassing an Audio Unit

To un bypass an Audio Unit, use

6 8742
un bypass

Toggling the bypass state of an Audio Unit

To toggle the bypass state of an Audio Unit, use

441 8742
toggle bypass

Opening a new plug-in instance

To open a new plug-in instance, use

? 8825
X open

where X is the name of your plug-in (please see separate page regarding Audio Unit and VST Plug-ins).

Perform a full plug-in scan

To perform a full plug-in scan, use

171
scan

Mapping plug-in parameters to Audio Unit Agent parameters

To map a plug-in parameter to an Audio Unit Agent parameter, use

8731 ? 23 ? 24 ? 8826
parameter X to Y with Z map

where X is the Audio Unit Agent parameter number, Y is the plug-in's parameter number and Z is the scaling factor you wish to associate with the current parameter mapping. Please refer to Audio Unit Parameters for more configuration help.

Setting the MIDI channel

To set the Audio Unit Agent's MIDI channel, use

1215 1122 23 ? 67
midi channel to X set

where X is the desired MIDI channel.

Setting the maximum MIDI channel

To set the Audio Unit Agent's maximum (polyphonic) MIDI channel, use

2342 1122 23 ? 67
maximum channel to X set

where X is the desired maximum channel.

Setting the minimum MIDI channel

To set the Audio Unit Agent's minimum (polyphonic) MIDI channel, use

2343 1122 23 ? 67
minimum channel to X set

where X is the desired minimum channel.

Setting the Audio Unit tail time

To set the tail time parameter, use

8773 1147 23 ? 67
tail time to X set

where X is the desired tail time (in seconds).

Un setting the Audio Unit tail time

To turn off the tail time parameter (i.e. set the tail time to infinity) use

8773 1147 6 67
tail time un set

Setting the velocity sample

To set the velocity sample of an Audio Unit Agent, use

1417 1275 23 ? 67
velocity sample to X set

where X is the desired velocity sample.

Setting the velocity curve

To set the velocity curve of an Audio Unit Agent, use

1417 1512 23 ? 67
velocity curve to X set

where X is the desired velocity curve.

Browsing Audio Unit plug-ins using the EigenBrowser

To browse Audio Unit plug-ins, make sure you have the EigenBrowser open, then use

8777 5
eigenbrowser hey

1118 8728 ? 8741 413
audio unit X plugin browse

where X is the number of your desired Audio Unit Agent.

Setting a MIDI bank to one particular value

To set a MIDI bank to one particular value and send a corresponding MIDI bank change message, use

1215 8757 23 ? 67
midi bank to X set

where X is the MIDI bank value.

Setting a MIDI program to one particular value

To set a MIDI program to one particular value and send a corresponding MIDI program change message, use

1215 8756 23 ? 67
midi program to X set

where X is the MIDI program value.

Setting a MIDI control to one particular value

To set a MIDI control to one particular value and send a corresponding MIDI CC message, use

1215 1775 ? 23 ? 67
midi controller X to Y set

where X is the MIDI control index, and Y is the value it will be set to.