Package Max

udpsend

Send messages over a network

Description

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

Arguments

host[symbol]
optional

Specifies the host destination to which messages will be sent over a network. Host destinations can be specified either by name (e.g., localhost) or by IP address (e.g., 127.0.0.1).

port[int]
optional

Specifies the remote port that the udpsend object will use when sending messages.

Attributes

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]

You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.

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

Sends the bang message over the network using UDP.

int

Sends an int message over the network using UDP.

Arguments:
  • message [int]

float

Sends a float message over the network using UDP.

Arguments:
  • message [float]

list

Sends a list message over the network using UDP.

Arguments:
  • message [list]

anything

Sends the given message over the network using UDP.

Arguments:
  • message [list]

FullPacket

The udpsend object and its counterpart the udpreceive 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. The FullPacket message toggles support for the 'FullPacket' message used by the CNMAT Open Sound Control externals or the Max udpreceive object--when set, the udpsend object will send UDP buffers in the form of OSC 'FullPacket' messages.

Arguments:
  • behavior [int]
  • number [int]

host

The word host , followed by a symbol, specifies the host destination to which messages will be sent. Host destinations can be specified either by name (e.g., localhost) or by IP address (e.g., 127.0.0.1).

Arguments:
  • host [symbol]

maxpacketsize

The word maxpacketsize , followed by an integer, sets the size, in bytes, of the largest UDP packet that you can send (default=5096). Since this value is related to the largest Max message you can possibly send, you may need to increase this value if you are sending very long Max messages.

Arguments:
  • maximum [int]

maxqueuesize

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.

Arguments:
  • maximum [int]

port

The word port , followed by a number, specifies the remote port that the udpsend object will use to send outgoing messages.

Arguments:
  • port [int]

Output

(UDP)

There are no outlets. Max messages received by the udpsend object are serialized and sent over the network as OSC-compatible UDP packets.

See Also

Name Description
udpreceive Receive messages over a network