Documentation Wiki rss-feed

Metronome

Name

Metronome:

52
metronome

Description

The Metronome Agent deals with all aspects of musical tempo and time signature. It is connected to all Agents which need tempo and time signature information (e.g. the Recorder).

Ports

Tempo input

  • Name:

168 116
tempo input

  • Input, Set
  • Type: Number
  • Range: 0 to 500

The tempo input is normally a value set by the user to determine the tempo of the metronome and everything connected downstream in beats per minute (bpm).

Beat input

  • Name:

127 116
beat input

  • Input, Set
  • Type: Number
  • Range: 0 to 100; rest = 4

The beat input is normally a value set by the user to determine the number of beats per bar; the default number is 4.

Beat trigger

  • Name:

127 1143
beat trigger

  • Input
  • Type: Number
  • Range: 0 to 1; rest = 0

The beat trigger is normally used as part of the 'tap tempo' function of EigenD to adjust the metronome tempo according to the tapping of a key.

Bar trigger

  • Name:

126 1143
bar trigger

  • Input
  • Type: Number
  • Range: 0 to 1; rest = 0

The bar trigger is normally used as part of the 'tap tempo' function of EigenD to adjust the number of beats per bar according to the tapping of a key.

Beat flash persistence

  • Name:

127 8837 8838
beat flash persistence

  • Input, Set
  • Type: Integer
  • Range: 0 to 2000; default = 0

The beat flash persistence sets the period in milliseconds for which the metronome key light will flash to indicate the beats and bars visually. Setting beat flash persistence to 0 will disable the flashing.

Tempo minimum

  • Name:

168 2343
tempo minimum

  • Input, Set
  • Type: Number
  • Range: 1 to 500; default = 30

The minimum tempo is normally used as a value set by the user to set the lower bound of the range allowed when controlling the tempo via the 'tap tempo' interface.

Tempo maximum

  • Name:

168 2342
tempo maximum

  • Input, Set
  • Type: Number
  • Range: 1 to 500; default = 500

The maximum tempo is normally used as a value set by the user to set the upper bound of the range allowed when controlling the tempo via the 'tap tempo' interface.

Preroll

  • Name:

3141
preroll

  • Input, Set
  • Type: Integer
  • Range: 1 to 32; default = 4

'Preroll' is normally used as part of the 'tap tempo' functionality to allow you a number of taps on the 'beat trigger' key before any tempo adjustment is made (the number of taps corresponds with the set value of 'preroll'.

Preroll trigger

  • Name:

3141 1143
preroll trigger

  • Input, Set
  • Type: On/Off

The preroll trigger is normally used to enable or disable the use of the aforementioned 'preroll' parameter on a keypress as part of the 'tap tempo' function of EigenD.

MIDI clock input

  • Name:

1215 8771 116
midi clock input

  • Input
  • Type: Generic

The MIDI clock input is normally used to receive MIDI clock data from the MIDI input Agent. You need to connect the 'midi clock output' to this input.

MIDI clock enable

  • Name:

1215 8771 5584
midi clock enable

  • Input, Set
  • Type: On/Off

This input enables MIDI clock in.

MIDI clock latency

  • Name:

1215 8771 8818
midi clock latency

  • Input, Set
  • Type: Number
  • Range: -1000 to 1000

The MIDI clock latency input is normally used as the value set in milliseconds to adjust the latency of incoming MIDI clock data.

Bar beat output

  • Name:

126 127 125
bar beat output

  • Output
  • Type: Generic

The bar beat output is normally used to send the current beat of the bar to downstream Agents (see Recorder).

Song beat output

  • Name:

652 127 125
song beat output

  • Output
  • Type: Generic

The song beat output is normally used to send the the song beat (the number of beats since the Metronome started) to downstream Agents (see Recorder)

Running output

  • Name:

1488 125
running output

  • Output
  • Type: Generic

The running output is normally used to send whether the Metronome is running or not to downstream Agents (see Recorder)

Bar output

  • Name:

126 125
bar output

  • Output
  • Type: Generic

The bar output is normally used to send the bar number to downstream Agents (see Scheduler).

Tempo output

  • Name:

168 125
tempo output

  • Output
  • Type: Generic

The tempo output is normally used to send the Metronome tempo to downstream Agents (see Delay)

Nouns

None

Verbs

Start:

56
start

The 'start' verb is used to start the Metronome running.

Stop:

57
stop

The 'stop' verb is used to stop the Metronome running.

Toggle Start:

441 56
toggle start

'Toggle start' is used to toggle the metronome on and off.

Examples

Before using the commands below, make sure you have the metronome in the conversation using:

52 1131
metronome listen

Starting the Metronome

To start the metronome running, use:

56
start

Stopping the Metronome

To stop the metronome running, use:

57
stop

Setting the Metronome tempo

You can adjust the tempo of the metronome (in beats per minute/bpm) using:

168 23 ? 67
tempo to X set

where X is the desired tempo in bpm, e.g:

168 23 11 12 22 67
tempo to 1 2 0 set

Setting the number of beats per bar

You can change the number of beats per bar using:

127 116 23 ? 67
beat input to X set

where X is the desired number of beats per bar, e.g.

127 116 23 13 67
beat input to 3 set

Setting the minimum tempo

To set the minimum tempo, use:

2343 168 23 ? 67
minimum tempo to X set

where x is the desired minimum.

Setting the maximum tempo

To set the maximum tempo, use:

2342 168 23 ? 67
maximum tempo to X set

where x is the desired maximum.

Setting preroll

To the set the value of 'preroll', use

3141 23 ? 67
preroll to X set

where X is the number of taps required before any tempo adjustment is made.

Enabling MIDI clock

To set the MIDI clock enable within the metronome, use:

1215 8771 5584 67
midi clock enable set

Setting the MIDI clock latency

You can set the MIDI clock latency using:

1215 8771 8818 23 ? 67
midi clock latency to X set

where X is the desired latency in milliseconds.

See also