out
MSP Reference
Open Help

out

Message output for a patcher loaded by poly~ or pfft~

Description

out defines a message outlet for a patcher loaded by poly~ or pfft~.

Examples

Message outlets of the poly~ object correspond to the out objects inside the loaded patcher

Arguments

None.

Attributes

attr_comment [symbol]

Comment to be displayed on poly object outlet mouseover

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

Sends bangs out the corresponding outlet of the pfft~ or poly~ object in which it is embedded.

int

Arguments

output [int]
Sends integer values out the corresponding outlet of the pfft~ or poly~ object in which it is embedded.

float

Arguments

output [float]
Sends floating-point values out the corresponding outlet of the pfft~ or poly~ object in which it is embedded.

list

Arguments

output [list]
Sends lists out the corresponding outlet of the pfft~ or poly~ object in which it is embedded.

anything

Arguments

output [list]
Sends input out the corresponding outlet of the pfft~ or poly~ object in which it is embedded.

comment

Arguments

outlet-description [list]
Sets a comment for display on poly object outlet mouseover

Output

(patcher)

Any messages received by an out object in a loaded patcher appear at the signal outlet of the poly~ or pfft~ object which corresponds to the number argument of the out object. The signal outputs in a poly~ or pfft~ object are a mix of the outputs of all instances of the patcher's outputs which correspond to that number.

See Also

Name Description
in Message input for a patcher loaded by poly~ or pfft~
in~ Signal input for a patcher loaded by poly~
Message output for a patcher loaded by poly~ or pfft~
out~ Signal output for a patcher loaded by poly~
pfft~ Spectral processing manager for patchers
poly~ Manage polyphony/DSP for patchers
thispoly~ Control poly~ voice allocation and muting
MSP Polyphony Tutorial 1: Using the poly~ Object MSP Polyphony Tutorial 1: Using the poly~ Object