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~.
The matrix~ object has two modes of operation: "binary" and non-binary. In binary mode, connections act like simple switches, and always have unity gain. This mode is faster, but audible clicks will occur if you're listening to the outputs of this object when connections are made and broken. In non-binary mode, connections are gain stages, i.e. they can scale the signal by some amount other than zero and one. They also provide an adjustable ramping time over which the gain values are changed. This allows signals to be switched without creating audible clicks.
The first argument specifies the number of inlets.
The second argument specifies the number of outlets.
If a float value is provided as a third argument, matrix~ operates in its non-binary mode. The argument sets the gain value that will be used when connections are created.
Ramp Time (ms)
Common Box Attributes
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.adds the object to the background layer, 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.
Sets the type style used by the object. The options are:
0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'
Sets the object's font.
Sets the object's font size (in points).
hidden [int] (default: 0)
Toggles whether an object is hidden when the patcher is locked.
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]
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]
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]
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.
Sets the justification for the object's text.
0 = 'left'
1 = 'center'
2 = 'right'
If the matrix~ object is operating in non-binary mode, A list of two ints followed by a float sets the gain of the connection between inlet i and outlet o to the value specified by the float.
Note: To specify the gain of individual connections, you must use three-element list messages rather than the message. Connections formed with the 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 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 (e.g., would connect the first inlet to the second outlet and specify a gain of .8 and a ramp time of .5 seconds).
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 or message.
The output signals for each outlet are the sum of their connected inputs, scaled by the gain values of the connections.
|gate~||Route a signal to one of several outlets|
|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|