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

plugreceive~ Reference

Receive audio from another plug-in

plugreceive~

Description

Note: plug-in building for hosts other than Ableton Live is no longer supported. For more information to help you make the transition to creating plug-ins in Max for Live, see Max for Live for Pluggo Developers.
The use of the plugsend~ and plugreceive~ objects to pass audio between Max for Live devices is not supported.

The plugreceive~ and plugsend~ objects were used to send audio signals from one pluggo plug-in to another. They were used in the implementation of the PluggoBus feature of many of the plug-ins included with pluggo.

Examples

Arguments

object-name [symbol]

Gives the plugreceive~ object a name used for connecting with one or more plugsend~ objects.

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

set

Arguments

object-name [symbol]
The word set, followed by a symbol naming a plugsend~ object, connects the plugreceive~ object to the specified plugsend~ object(s), and the plugreceive~ object's audio output becomes the input to the plugsend~. If the symbol doesn't name a plugsend~ object, the audio output becomes zero.

signal

The input to the plugreceive~ object comes from a plugsend~ object to which it is currently connected. Initially, this will be a plugsend~ having the same name as the plugreceive~ object's argument.

Output

signal

The audio signal input to the plugsend~ objects connected to this object. If no plugsend~ objects are connected, the audio output is zero.

There may be a delay of one processing (I/O) vector size of the host mixer between the plugreceive~ output and the inputs to the plug-in which the plugreceive~ is located. This occurs when a plugsend~ occurs later in the processing chain than the plugreceive~ to which it is sending audio.

See Also

Name Description
plugsend~ Send audio to another plug-in