udpreceive
Max Reference
Open Help

udpreceive

Receive messages over a network

Description

Receives messages transmitted over a network using the User Datagram Protocol (UDP).

Examples

Look ma! No hands!!!

Arguments

port [int]

Specifies the local port that the udpreceive object will use to listen for incoming messages.

full-packet [symbol]

Optional

The udpreceive object and its counterpart the udpsend object provide support for third-party Max objects that work with the Open Sound Control (OSC) protocol developed by the Center for New Music and Audio Technologies (CNMAT) at the University of California, Berkeley. An optional symbol argument (it can be any symbol) specifies that the udpreceive object should pass on UDP buffers as OSC 'FullPacket' messages instead of decoding them and outputting them as Max messages.

Attributes

quiet [int]

When enabled, status notifications to the Max Console are suppressed.

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

maxqueuesize

Arguments

maximum [int]
The word maxqueuesize , followed by an integer, sets the maximum number of incoming messages that can be in the queue at any given time (default=512). The work queue will grow as needed until this maximum limit is reached. In high-traffic or high-speed situations, you may need to increase the maximum queue size to avoid dropped messages.

port

Arguments

port [int]
The word port , followed by a number, sets the local port that the udpreceive object will use to listen for incoming messages.

Output

anything

All OSC-compatible UDP messages received at the port number of the host computer (designated by argument or the port message) are sent out the outlet.

See Also

Name Description
udpsend Send messages over a network
Max Comm Tutorial 3: UDP Networking Max Comm Tutorial 3: UDP Networking