Package Max

param.osc

Control and report info about parameters using OSC.

Description

Controls and reports info about parameters using OpenSoundControl (OSC).

Arguments

None.

Attributes

auto[int]

Automatically report changes to the parameters of a patch.

outputmode[symbol]

The type of output to produce in response to changes if auto is set to 1. This attribute also controls the behavior of bang . Possible values:

'param' ( The most recently updated parameter only )
Output a bundle containing only the value(s) of the most recently updated parameter. See param .

'allparams' ( The values of all parameters )
Output a bundle containing the values of all parameters in a patch. See allparams .

'info' ( Comprehensive info about all parameters. )
Output a bundle containing comprehensive info about all parameters in a patch. See info .

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

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'

hidden[int]: 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]: 0

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile[symbol]

JS Painter File

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

bang

Then bang message will cause param.osc to output OSC according to the outputmode.

anything

param.osc accepts normal Max messages that represent OSC, for example: /param/live.gain~ -18.

FullPacket

An OSC packet containing messages to be dispatched to parameters in the patch.

allparams

Generate an OSC bundle containing the values of every parameter in a patch.

info

Generate an OSC bundle containing comprehensive info about every parameter in the patch, for example the long name, short name, minimum, maximum, etc.

param

Generate an OSC bundle containing the value of the most recently changed parameter.

set

Dispatches OSC to parameters without triggering output from param.osc or UDP if enabled.