Documentation Wiki rss-feed

Gain


Name

Gain:

image:gain_expanded.png

775
gain

Description

The Gain Agent is the plug-in used to adjust the gain of a signal within EigenD.

Ports

Volume input

  • Name:

212 116
volume input

  • Input, Set
  • Type: Number
  • Range: 0 to 1
  • Default: 0

The volume input can be used to receive volume information from upstream Agents, or as a value set by the user to adjust the power of incoming signal.

Audio input

  • Name:

1118 116
audio input

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

The audio input is used to receive audio data from upstream Agents. If the channel count is set to 2, then there are two audio input ports, labelled 'left audio input 1' and 'right audio input 2' (see 'Channel Count' below).

Audio output

  • Name:

1118 125
audio output

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

The audio input is used to send audio data to downstream Agents. If the channel count is set to 2, then there are two audio output ports, labelled 'left audio input 1' and 'right audio output 2' (see 'Channel Count' below).

Nouns

Channel Count:

The channel count is a value set by the user to determine the number of audio input and output channels that the Gain Agent requires. This depends on whether the Agent upstream produces a mono or stereo output - it is mono by default (therefore one audio input and one audio output).

Verbs

None

Examples

Before using the Belcanto examples below, please make sure you have the desired Gain in the conversation using

775 ? 1131
gain X listen

where X is the number of the desired Gain Agent.

Setting the channel count

To set the channel count, use

1122 458 23 ? 67
channel count to X set

where X is the desired channel count.

Setting the volume input

To set the value of the volume input, use

212 116 23 ? 67
volume input to X set

where X is the desired value of the volume input.

See also