Package Max

qlim

Queue-based message limiter

Description

Slows down throughput of messages. Limiting is based on a minimum amount of time between passed message.

Discussion

The qlim object is similar to a combination of the speedlim and the Jitter jit.qball object. In Jitter, most execution take places in the low priority queue to prevent drawing to the screen at interrupt. The speedlim object unfortunately places messages back in the scheduler for execution, and thus may result in a crash when used to temporally downsample streams of Jitter matrices if Overdrive is turned on. The qlim object is an interrupt safe replacement for this and other tasks.

Arguments

minimum[int]ms
optional

The minimum amount of time between successive 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[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.

threshold[Time Value]

Sets the time threshold. The threshold can be specified in the following time formats: bars.beats.units, ticks or note values.

usurp[int]: 1

When usurp is enabled and multiple messages are received that could be output, the most recently received message replaces any currently queued message. When usurp is disabled, all messages received will be sent out. The difference is subtle and it is typically appropriate to leave usurp enabled for most situations.

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

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

int

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

Arguments:
  • number [int]

float

In left inlet: Equivalent to anything .

Arguments:
  • number [float]

list

In left inlet: Equivalent to anything .

Arguments:
  • list items [list]

anything

In left inlet: Any number, bang, or 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).

Arguments:
  • anything [list]

See Also

Name Description
speedlim Limit the speed of message throughput