A newer version of Max is available. Click here to access the latest version of the Max documentation

router Reference

Route messages to multiple locations

router

Examples

Discussion

It is designed to work best with the matrixctrl user interface object, and uses a syntax equivalent to the MSP matrix~ object.

Arguments

inlets [int]

Sets the number of inlets

outlets [int]

Sets the number of outlets

Attributes

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.

jspainterfile [symbol]

JS Painter File

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

bang received in any but the leftmost inlet will be sent to all outlets that are connected to that inlet.

int

Arguments

input [int]
An integer received in any but the leftmost inlet will be sent to all outlets that are connected to that inlet.

float

Arguments

input [float]
floating-point number received in any but the leftmost inlet will be sent to all outlets that are connected to that inlet.

list

Arguments

inlet [int]
outlet [int]
state [int]
A list of three numbers received in the left inlet is interpreted as specifying an inlet number, an outlet number, and a 0 or 1 specifying the state of a connection. A list in this form changes the inlet and outlet connections of the router object.

A list received in any other inlet will be sent to all outlets that are connected to that inlet.

anything

Arguments

input [list]
Any Max message received in any but the leftmost inlet will be sent to all outlets that are connected to that inlet.

clear

Arguments

arguments [list]
Clears the state of the switching matrix, All inlets are disconnected from all outlets.

connect

Arguments

inlet [int]
outlet [int]
The word connect, followed by two numbers that specify inlet and outlet numbers, connects an inlet to an outlet. Multiple inlets can be connected to multiple outlets, and vice versa.

disconnect

Arguments

inlet [int]
outlet [int]
The word disconnect, followed by two numbers that specify inlet and outlet numbers, disconnects an inlet from an outlet.

dump

Arguments

arguments [list]
Sends the state of the object's switching matrix out the right outlet as a series of single line lists in the form inlet-number outlet-number state.

patch

Arguments

inlet [int]
outlet [int]
The word patch, followed by two numbers that specify inlet and outlet numbers, connects an inlet to an outlet and disconnects all other inlets that are currently connected to that outlet

print

Arguments

arguments [list]
Prints the state of the switching matrix in the Max Console.

Output

anything

Any message received in any but the leftmost inlet will be routed to the outlet to which the inlet is currently connected. The router objects passes messages only; it will not pass signals or Jitter matrices.

list

Out right outlet: a series of single-line lists (one for each inlet) in the form inlet-number outlet-number state is sent out the right outlet of the router object in response to a dump message.

See Also

Name Description
matrixctrl Matrix switch control
matrix Event routing matrix
Max Basic Tutorial 21: Controlling Data Flow Max Basic Tutorial 21: Controlling Data Flow
Tutorial 13: Scissors and Glue Tutorial 13: Scissors and Glue
Tutorial 26: MIDI Control of Video Tutorial 26: MIDI Control of Video