A newer version of Max is available. Click here to access the latest version of the Max documentation

tempo

Output numbers at a metronomic tempo

Description

Produces metronomic output controllable in beats per minute, and with specifiable whole-note divisions.

Examples

The tempo (60) defines the speed of a quarter note, division defines the pulse to be sent out

Arguments

tempo [int or float]

Optional

The first argument sets an initial tempo, from 5 to 300 beats per minute. If there is no argument, the initial tempo is 120 beats per minute. The second argument is the beat multiplier and is set to 1 by default. The third argument sets an initial rhythmic value of the output, from a whole note (1) to a 64th note triplet (96). If the argument is not present, the initial value is 16.

Attributes

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic

Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points).

Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [float]

Sets the color for the object's text in RGBA format.

textjustification [int]

Text Justification

Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

bang

In left inlet: Starts the tempo object's metronome process, or restarts it if tempo is already on.

int

Arguments

input [int]
Converted to float.

float

Arguments

input [float]
In left inlet: If the number is not 0, it has the same effect as bang. If the number is 0, it has the same effect as stop.

In 2nd inlet: The number is stored as the tempo, in beats per minute (quarter notes per minute).

In 3rd inlet: The number is a beat multiplier, which can lengthen the amount of time taken for one beat. It slows the tempo down by a factor. For example, a multiplier of 2 will make tempo send out its output half as fast.

In right inlet: The number is the rhythmic value sent out by tempo, specified as a fraction of a whole note. For example, the number 8 causes tempo to output eighth notes, relative to the specified (quarter note) tempo. The numbers sent out the outlet cycle continuously between 0 and the number 1 less than the rhythmic value. The divisions of a whole note must be between 1 and 96.

clock

Arguments

name [symbol]
The word clock, followed by the name of an existing setclock object, sets the tempo object to be controlled by that setclock object rather than by Max’s internal millisecond clock. The word clock by itself sets the tempo object back to using Max’s regular millisecond clock.

stop

In left inlet: Stops tempo.

tempo

Arguments

tempo [list]
In left inlet: The word tempo, followed by a float, sets the current tempo to the number.

Output

int

When tempo is started it outputs numbers in a continuous cycle from 0 to the number 1 less than the specified rhythmic value. The speed at which the numbers are sent out is determined by the tempo (quarter note beats per minute) and the rhythmic value of the output (fraction of a whole note).

See Also

Name Description
Timing and Sequencing Events Timing and Sequencing Events
clocker Report elapsed time, at regular intervals
metro Output a bang message at regular intervals
setclock Create and control an alternative clock
Max MIDI Tutorial 4: MIDI Basic Sequencing Max MIDI Tutorial 4: MIDI Basic Sequencing