speedlim
Max Reference
Open Help

speedlim

Limit the speed of message throughput

Description

Limit the throughput speed of incoming messages to a fixed time limit. The time can be specified in milliseconds or using a tempo-relative interval.

Examples

Used to reduce a heavy flow of numbers, or to turn a continuous flow into discrete steps

Discussion

speedlim takes one optional argument which is a speedlimiting time. This object uses the Max time format syntax, and the interval that the speedlim object uses can be either fixed or tempo-relative. Its output can be also be quantized using tempo-relative syntax.
The left inlet takes any message and outputs it according to the argument value. The right inlet takes int to change the speedlimiting time.

Arguments

delta-time [int, float, symbol]

Optional

Sets an initial minimum time between outputs. Time can be specified in any of the time formats used in Max. If there is no argument, the minimum time is 0 milliseconds.

Attributes

defer [float]

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

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.

threshold [10 atoms]

Time threshold under which only one message may pass. Time can be specified in any of the time formats used in Max.

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

Performs the same function as an anything message applied to the passing of bang messages.

int

Arguments

input [int]
In left inlet: Performs the same function as an anything message applied to the passing of integers.

In right inlet: The number is stored as the minimum amount of time, in milliseconds, between successive outputs.

float

Arguments

input [float]
Performs the same function as an anything message applied to the passing of floats..

list

Arguments

input [list]
In left inlet: Performs the same function as an anything message applied to the passing of lists.
In right inlet: A list may be used to specify time in one of the Max time formats.

anything

Arguments

input [list]
In left inlet: The message is passed out the outlet, provided that a certain minimum time has elapsed since the previous output. Otherwise, the message is held until that amount of time has passed (or until it is overwritten by another incoming message).

Output

anything

A message received in the left inlet is sent out the outlet, provided the specified minimum amount of time has elapsed since the previous output. Otherwise, speedlim waits until that amount of time has passed, then sends out the last message it has received since the previous output.

See Also

Name Description
delay Delay a bang
mousefilter Gate messages with the mouse
thresh Combine numbers and lists when received close together
timer Report elapsed time between two events
transport Control a master clock
Max MIDI Tutorial 3: MIDI Parsing Max MIDI Tutorial 3: MIDI Parsing