matrix~
Signal routing and mixing matrix
Description
matrix~ is an array of signal connectors and mixers (adders). It can have any number of inlets and outlets. Signals entering at each inlet can be routed to one or more of the outlets, with a variable amount of gain. If an outlet is connected to more than one inlet, its output signal is the sum of the signals from the inlets.
When the matrix~ object is created as mcs.matrix~ all of its signal inlets are combined into a single multichannel inlet and all of its signal outlets are combined into a single multichannel outlet. The behavior of mcs.matrix~ is otherwise identical to matrix~.
Discussion
Connections between inputs and outputs can have their own gains, and each connection can include a ramp time to avoid clicks.
Arguments
inlets[int]
optional
The first argument specifies the number of inlets.
outlets[int]
optional
The second argument specifies the number of outlets.
default-connect-gain[float]
optional
If a float value is provided as a third argument, it sets a default gain to be used for the connect message when a gain argument to connect is not supplied.
Attributes
ramp[float]
Sets the ramp time in milliseconds, switching signals without creating audible clicks.
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]: 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'
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
list
In left inlet: A list of three numbers connects inlets and outlets. The first number specifies the inlet, the second number specifies the outlet. If the third number is 0, the inlet is disconnected from the outlet. If the third number is non-zero it is interprted as a gain for the connection between the input and output.
Note: To specify the gain of individual connections, you must use three-element list messages rather than the connect message. Connections formed with the connect message always have a gain specified by the third argument initially given to the matrix~ object. However, subsequent list messages can alter the gain of connections formed with the connect message.
The addition of an optional fourth element to the list message can be used to specify a ramp time, in milliseconds, for the individual connection. Example: 1 2 .8 500 would connect the first inlet to the second outlet and specify a gain of .8 and a ramp time of .5 seconds).
- inlet-to-outlet indices
[list]
clear
In left inlet: The word clear removes all connections.
connect
In left inlet: The word connect , followed by one or more ints, will connect any inlet specified by the first int to the outlet or outlets specified by the remaining ints in the list. Inlets and outlets are numbered from left to right, starting at zero. For example, the message connect 0 0 1 would connect the first inlet from the left to the leftmost outlet and the second outlet from the left. If the last item in the list is a float, it will set the gain for all specified connections.
- inlet-to-outlet indices
[list]
dictionary
The matrix~ object can receive dictionaries to configure its state. When receiving a dictionary, all previous connections are cleared and replaced by the connections in the dictionary. You can also set some attributes with a dictionary, including the default gain and ramp time.
- dict-name
[symbol]
disconnect
In left inlet: The word disconnect , followed by one or more ints, will disconnect any inlet specified by the first int to the outlet or outlets specified by the remaining ints in the list.
- inlet-to-outlet indices
[list]
dump
In left inlet: The word dump causes the current state of all matrix~ object connections to be sent out the rightmost outlet of the object in the form of a list for each connection. The list consists of two numbers which specify the inlet and outlet, followed by a float which specifies the gain for the connection. Note that the current gains are not necessarily the same as the target gains of all matrix~ object connections, since a connection's gain can ramp to its new target over time.
dumpconnections
In left inlet: The word dumpconnections causes the current contents of the matrix~ object to be sent out the rightmost outlet of the object as a dictionary.
dumptarget
In left inlet: The word dumptarget causes the target state of all matrix~ object connections to be sent out the rightmost outlet of the object in the form of a list for each connection. The list consists of two numbers which specify the inlet and outlet, followed by a float which specifies the target gain for the connection. Note that the target gains are not necessarily the same as the current gains, which can be accessed with the dump message.
print
In left inlet: The word print causes the current state of all matrix~ object connections to be printed in the Max Console in the form of a list for each connection. The list consists of two numbers which specify the inlet and outlet, followed by a float which specifies the gain for the connection.
Output
list
Out right outlet: A set of lists describing the current or target state of all matrix~ object connections will be sent out the right outlet in response to a dump or dumptarget message.
signal
The output signals for each outlet are the sum of their connected inputs, scaled by the gain values of the connections.
See Also
| Name | Description |
|---|---|
| crosspatch | Patching Editor for Matrix Objects |
| gate~ | Route a signal to one of several outlets |
| mcs.matrix~ | Signal routing and mixing matrix (multichannel I/O) |
| matrix | Event routing matrix |
| matrixctrl | Matrix switch control |
| receive~ | Signals can be received from any loaded patcher, without patch cords |
| router | Route messages to multiple locations |
| selector~ | Assign one of several inputs to an outlet |
| send~ | Send signals without patch cords |