Documentation Wiki rss-feed

Audio


Name

Audio:

image:audio_expanded.png

1118
audio

Description

The Audio Agent deals with producing and receiving audio in the EigenD system.

Note that audio that is connected to the Audio Agent's audio input ports will be sent by the Agent to the selected audio device. In general this will then be directed to the physical audio output channels of the audio device though some devices might do more advanced internal routing. The Audio Agent's audio output ports receive the to audio from the selected audio device and output it for use in the EigenD system.

When an Audio Agent is created is will have two audio input ports, which are typically connected to the stereo output of a system's audio device. To use additional audio input ports, create the channels you want to use in the agent, the channel number that's used by the agent corresponds to the channel number that your audio device uses. You thus only have the create ports for the audio input channels that you actually work with. If you change audio devices, only the channels that are supported by your device will send out audio but the connections to the other channels continue to exist in EigenD. This allows you to for instance have a stereo mix always go out on input channels 1 & 2, while individual instruments could be sent to other channels if your selected device support this.

The Audio Agent output ports function in a similar way as the audio input ports, but there are none created by default.

Ports

Audio Input 1

  • Name:

1118 116 11
audio input 1

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

Audio Input 1 typically receives left channel audio from upstream Agents (often the Console Mixer's left audio output).

Right Input

  • Name:

1118 116 12
audio input 2

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

Audio Input 2 typically receives right channel audio from upstream Agents (often the Console Mixer's right audio output).

Sample Rate

  • Name:

1275 1216
sample rate

  • Input, Set
  • Type: Number
  • Available values: 44100, 48000, 96000

Sample Rate defines EigenD's internal sample rate - this can be either 44.1kHz, 48kHz or 96kHz.

Buffer Size

  • Name:

8876 8877
buffer size

  • Input, Set
  • Type: Number
  • Available values: 14 - 3072

Buffer Size defines the amount of time (in samples) EigenD uses to process audio. A lower buffer size improves latency, a higher buffer size reduces any glitches, clicks or pops you may be experiencing due to high CPU usage.

Input channels

  • Name:

116 8888
input channels

  • Output
  • Type: Number

The number of input channels that are available on the selected audio device.

Output channels

  • Name:

125 8888
output channels

  • Output
  • Type: Number

The number of output channels that are available on the selected audio device.

Nouns

Port:

The Port refers to the internal representation of audio devices connected and available for use with EigenD. Ports can be selected from the Eigenbrowser - see example below.

Verbs

Mute:

244
mute

The 'mute' verb is used to mute all EigenD audio.

Un Mute:

6 244
un mute

The 'un mute' verb is used to reverse the above 'mute' verb.

Choose:

122
choose

The 'choose' verb is used to select audio devices from the EigenBrowser.

Create:

111
create

The 'create' verb is used to create audio input and output channels.

Un Create:

6 111
un create

The 'un create' verb is used to remove audio input and output channels.

Examples

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

1118 ? 1131
audio X listen

where X is the number of the desired Audio Agent.

Muting the Audio Agent

To mute all EigenD audio, use

244
mute

Un Muting the Audio Agent

To reverse the mute command, use

6 244
un mute

Browsing Audio Ports

To view audio devices in the EigenBrowser, making sure you have the EigenBrowser open, use

8777 5
eigenbrowser hey

1118 1822 413
audio port browse

Choosing Audio Ports

To select an audio device from the EigenBrowser, select the desired device and use

8777 8716 1118 ? 5
eigenbrowser , audio X hey

414 122
selection choose

where X is the number of the desired Audio Agent.

Create an Audio Input channel

To create an audio input channel to send out audio to the corresponding channel on your audio device, use

116 ? 111
input X create

where X is the number of the audio channel that your audio device uses.

Remove an Audio Input channel

To remove an audio input channel, use

116 ? 6 111
input X un create

where X is the number of the audio channel that you want to remove.

Create an Audio Output channel

To create an audio output channel to receive audio from the corresponding channel on your audio device, use

125 ? 111
output X create

where X is the number of the audio channel that your audio device uses.

Remove an Audio Output channel

To remove an audio output channel, use

125 ? 6 111
output X un create

where X is the number of the audio channel that you want to remove.

See also