in
MSP Reference
Open Help

in

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

Description

in defines a message inlet for a patcher loaded by poly~ or pfft~.

Examples

Message inlets of the poly~ object correspond to the in objects inside the loaded patcher

Arguments

inlet-number/positioning [int]

Obligatory. Each in object is identified by a unique index number which specifies which message inlet in a poly~ or pfft~ object it corresponds to. The first outlet is 1.

Attributes

attr_comment [symbol]

Defines the comment displayed whenever the mouse is rolled over the inlet which corresponds to the in of the actual poly~ or pfft~ object.

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

comment

Arguments

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

Output

message

Each in object in a patcher loaded by the poly~ or pfft~ objects appears as an inlet at the top of the object. Messages received at the first message inlet of the poly~ or pfft~ object are sent to the first in object (i.e., the in 1 object) in the loaded patcher, and so on. The number of total inlets in a poly~ or pfft~ object is determined by whether there are a greater number of in~ or in objects in the loaded patch (e.g., if your loaded poly~ patcher has three in~ objects and only two in objects, the poly~ object will have three inlets, two of which will accept both signals and anything else, and a third inlet which only takes signal input).

See Also

Name Description
in~ Signal input for a patcher loaded by poly~
inlet Receive messages from outside a patcher
out Message output for a patcher loaded by poly~ or pfft~
out~ Signal output for a patcher loaded by poly~
outlet Send messages out of a patcher
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