timer
Max Reference
Open Help

timer

Report elapsed time between two events

Description

timer starts keeping time when a bang is sent to the left inlet. The right outlet can report elapsed time in milliseconds or one of the Max time format options, with the exception of notevalues.

Examples

Report time between bang messages... A single event can report time, then restart timer

Arguments

None.

Attributes

format [symbol]

Set the time format to use for output (defult = milliseconds). Output may also be specified in one of the Max time format options with the exception of notevalues.

Possible values:

'ticks'
'ms'
'bars.beats.units'
'samples'
'hz'
'notevalues'
'hh:mm:ss'

transport [symbol]

The name of a transport object with which to associate. By default, the global transport is used. This is used in the output format conversion. The transport does not need to be running for the conversion.

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 or restarts the timer.

In right inlet: Sends out the time elapsed since the timer was started.

clock

Arguments

setclock-name [symbol]
Use the clock message to specify a named setclock object for timing rather than by Max’s internal millisecond clock. The word clock by itself sets the timer object back to using Max’s regular millisecond clock.

Output

float

Out left outlet: When a bang is received in the right inlet, the time elapsed (in milliseconds) since the timer was started is sent out the outlet.

Out right outlet: When a bang is received in the right inlet, the time elapsed (in the time format specified by the format attribute) since the timer was started is sent out the outlet.

See Also

Name Description
clocker Report elapsed time, at regular intervals
cpuclock Retrieve the CPU time
delay Delay a bang
pipe Delay numbers, lists or symbols
setclock Create and control an alternative clock
transport Control a master clock
Max Basic Tutorial 19: Timing Max Basic Tutorial 19: Timing