Package Max

delay

Delay a bang

Description

Holds a bang for a specified amount of time before sending it to the next object. This object uses the Max time format syntax, so the delay time (which is normally specified in milliseconds) can also be set to other fixed or tempo-relative values.

Arguments

time[any]
optional

Sets an initial amount of time to delay a bang received in the left inlet. This time interval can be either a number which specifies time in milliseconds (e.g. delay 200) or a notevalue (e.g. delay 4nd).

Note: While the delay object lets you specify time in any of Max's standard time formats, the delaytime attribute argument should be used when specifying time in any other time unit besides milliseconds or notevalues (e.g. delay @delaytime 11025 samples ).

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

Attributes

delaytime[Time Value]

Sets the delay time for the object. Delay time can be specified in any of the time formats used in Max.

quantize[Time Value]

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.

If the applicable time is a 'fixed' unit (for example: ms, seconds, hz, samples, etc.) then this attribute will have no effect.

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

annotation[symbol]

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

background[int]: 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]: 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]: 0

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

jspainterfile[symbol]

You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.

patching_rect[4 floats]: 0. 0. 100. 0.

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

position[2 floats]
write-only

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]: 0

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

presentation_rect[4 floats]: 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]
write-only

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]
write-only

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: A bang is delayed a certain number of milliseconds before being sent out the outlet.

int

In right inlet: The number is stored as the number of milliseconds to delay a bang received in the left inlet. A number received in the right inlet changes the delay time of the next bang received -- it does not modify the time of a bang currently being delayed. In left inlet: The number is stored as the number of milliseconds to delay a bang received in the left inlet. It then automatically sends a bang message to itself to start the delay.

Arguments:
  • time [int]

float

In right inlet: The number is stored as the number of milliseconds to delay a bang received in the left inlet. A number received in the right inlet changes the delay time of the next bang received -- it does not modify the time of a bang currently being delayed. In left inlet: The number is stored as the number of milliseconds to delay a bang received in the left inlet. It then automatically sends a bang message to itself to start the delay.

Arguments:
  • time [float]

list

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

Arguments:
  • input [list]

anything

Same as list .

Arguments:
  • time [list]

clock

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

Arguments:
  • setclock-object-name [symbol]

stop

In left inlet: Stops delay from outputting the bang it is currently delaying.

Output

bang

bang received in the left inlet is delayed by the number of milliseconds specified by the right inlet, then is sent out the outlet. Only one bang at a time can be delayed by delay. If a bang is already in delay when a new bang is received in the left inlet, the first bang is forgotten.

See Also

Name Description
deferlow Defer the execution of a message (always)
pipe Delay numbers, lists or symbols
setclock Create and control an alternative clock
transport Control a clock