Documentation Wiki rss-feed

Clicker


Name

Clicker:

image:clicker_expanded.png

444
clicker

Description

The Clicker is the EigenD Agent which provides the 'click' sound on each Metronome beat, with an accent on the first beat of each bar.

Ports

Running input

  • Name:

1488 116
running input

  • Input
  • Type: Generic

The running input is used to indicate to the Clicker that the Metronome is running - as a consequence you have to connect the 'running output' of the Metronome to this input for the Clicker to work correctly.

Bar Beat input

  • Name:

126 127 116
bar beat input

  • Input
  • Type: Generic

The bar beat input is used to indicate to the Clicker the current beat of the bar when the Metronome is running - as a consequence you have to connect the 'bar beat output' of the Metronome to this input for the Clicker to work correctly.

Audio output

  • Name:

1118 125
audio output

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

The audio output is used to send the Clicker's audio data to downstream Agents (normally a Console Mixer channel in this case).

Nouns

None

Verbs

Play:

187
play

The 'play' verb is used to play the Metronome 'click' sound (please note: will only sound when Metronome is running).

Un Play:

6 187
un play

The 'un play' verb is used to stop Metronome 'click' sound.

Toggle Play:

441 187
toggle play

The 'toggle play' verb is used to toggle the playing state of the Clicker on and off.

Examples

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

444 ? 1131
clicker X listen

where X is the number of the desired Clicker.

Using the Clicker's 'Play' verb

To play the Metronome click sound, use

187
play

Using the Clicker's 'Un Play' verb

To stop the Metronome click sound, use

6 187
un play

Using the Clicker's 'Toggle Play' verb

To toggle the Metronome click sound on and off, use

441 187
toggle play

See also: