translate

Convert between different units of time.

Description

Converts from any of the fixed or relative Max time values to any other fixed or relative time value.

Examples

Arguments

input-format [symbol]

Optional

The first argument sets the input format to expect. These arguments are a shortcut for setting the attributes of this object which do the same thing. Time can be specified in any of the time formats used in Max.

output-format [symbol]

Optional

The second argument sets the format to output. These arguments are a shortcut for setting the attributes of this object which do the same thing. Time can be specified in any of the time formats used in Max.

Attributes

in [symbol]

The input format is used to determine the value sent to this object when the value alone is not enough. For example, a simple number could represent milliseconds, hertz, ticks, seconds, etc. This attribute is used to disambiguate such cases.

Possible values:

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

listen [int]

Toggles the output of new values for the current input to the translation when the transport tempo changes. The default is 1 (on).

mode [symbol]

Sets the mode for time values. The translate object can output time values in either position relative to the system start value of 1.1.0 or interval , where a value of 1.1.0 would indicate one bar, one beat, and no units (2400 ticks at 4/4 in the default resolution).
Note: this attribute may not apply, depending on the type of unit conversion.

Possible values:

'interval'
'position'

out [symbol]

Set the time format to use for output.

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 master transport is used.

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

The last time passed in is converted into the output type specified. Where appropriate, the input type of the last time passed in will be re-assessed by checking the in attribute.

int

Arguments

time [int]
The time value passed-in is converted into the output type specified. Where appropriate, the input type will be assessed by checking the in attribute.

float

Arguments

time [float]
The time value passed-in is converted into the output type specified. Where appropriate, the input type will be assessed by checking the in attribute.

list

Arguments

time [list]
The time value passed-in is converted into the output type specified. Where appropriate, the input type will be assessed by checking the in attribute.

anything

Arguments

time [list]
The time value passed-in is converted into the output type specified. Where appropriate, the input type will be assessed by checking the in attribute.

See Also

Name Description
Timing and Sequencing Events Timing and Sequencing Events
metro Output a bang message at regular intervals
timepoint Bang at a specific time
transport Control a master clock
when Report the current transport time