clocker

Report elapsed time, at regular intervals

Description

The clocker object is a metronome that reports the time elapsed since it was started. This object uses the Max time format syntax, so the interval that the clocker object uses can be either fixed or tempo-relative. Its output can be quantized using tempo-relative syntax, and if the autostarttime attribute is set, the object can also start at a tempo-relative point.

Examples

Arguments

time-interval [int, float, symbol]

The first argument sets an initial value for the time interval at which clocker sends out its output. This time interval can be either a number which specifies time in milliseconds (e.g. clocker 200) or a notevalue (e.g. clocker 4nd).

Note: While the clocker object lets you specify time in any of Max's standard time formats, the Interval attribute argument should be used when specifying time in any other time unit besides milliseconds or notevalues.

If there is no argument, the initial time interval is set to 5 milliseconds. If notevalue, ticks, or bars.beats.units are specified for the delay interval, the clocker object will not operate unless the transport is running.

Attributes

active [int]

Turns the clocker object on and off.

autostart [int]

If turned on (non-zero) the clocker object will begin running automatically at the time specified with the autostarttime attribute.

autostarttime [10 atoms]

If the autostart attribute is enabled (non-zero) the clocker object will begin running automatically at the time specified with the this attribute. The autostart operates as a timepoint object that is internal to the clocker object.

defer [float]

Turn this on to send output in the low-priority queue.

interval [10 atoms]

Sets the The time interval at which the clocker object sends out a bang. Time can be specified in any of the time formats used in Max.

quantize [10 atoms]

Send output only on the specified time-boundary if appropriate. This is achieved by making internal adjustments to the times used for sending output. The quantization can be specified in the following time formats: bars.beats.units, ticks or note values.

transport [symbol]

This attribute names a master time transport. If the time is specified using a 'relative' unit (for example: ticks, bars.beats.units, or notevalues), then the named transport is used to determine delay times based on tempo, time-signature, and other related information.

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 [4 floats]

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

textjustification [int]

Sets the justification for the object's text.

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 clocker object. If the clocker object is not running, a bang message will start the count. If the clocker object is running, a bang message will reset the count.

int

Arguments

non-zero-to-start [int]
In left inlet: Any non-zero number starts the clocker object. The time elapsed since clocker was started is sent out the outlet at regular intervals. 0 stops the clocker object.

float

Arguments

non-zero-to-start [float]
Same as int.

list

Arguments

input [list]
In right inlet: A list may be used to specify time in one of the Max time formats.

anything

Arguments

interval [list]
Same as list.

clock

Arguments

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

reset

In left inlet: Resets the elapsed time to 0 without stopping or restarting the clock; clocker continues to report the new elapsed time at the same regular interval. This message is meaningless when the clocker is not running, since it always resets to 0 anyway when stopped.

stop

In left inlet: Stops the clocker object.

See Also

Name Description
Timing and Sequencing Events Timing and Sequencing Events
counter Keep count based on bang messages
cpuclock Retrieve the CPU time
delay Delay a bang
setclock Create and control an alternative clock
tempo Output numbers at a metronomic tempo
transport Control a master clock
uzi Send many bang messages