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

rtin Reference

Receive MIDI real time messages

rtin

Description

Receives and outputs MIDI real time messages transmitted from a specified MIDI input device.

Examples

MIDI real time messages can be used to synchronize Max with external events

Arguments

port [symbol]

Optional

Specifies the port (a-z) from which to receive incoming MIDI real time messages. If there is no argument, rtin receives from port a (or the first input port listed in the MIDI Setup dialog.)

device [symbol]

Optional

The name of a MIDI input device may be used as the first argument to specify the port. The name 'all' can be used to enable the reception of MIDI messages from any port. The name 'none' can be used to prevent the object from receiving MIDI messages from any port.

Attributes

matchport [int] (default: 0)

If the port argument doesn't match an existing port or device name, set the object's MIDI port to 'none'.

name [symbol]

Set the object's MIDI port based on a device name. The attribute will attempt to do a case-sensitive partial string match based on the attribute's value.

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

anything

Arguments

port [list]
Performs the same function as port but without need for the word, "port".

(mouse)

Double-clicking on an rtin object shows a pop-up menu for choosing a MIDI port or device.

(MIDI)

The rtin object receives its input from a MIDI real-time message received from a MIDI input device.

port

Arguments

MIDI-port [symbol]
The word port, followed by a letter a-z or the name of a MIDI input port or device, sets the port from which the object receives incoming MIDI messages. The word port is optional and may be omitted. The name 'all' can be used to enable the reception of MIDI messages from any port. The name 'none' can be used to prevent the object from receiving MIDI messages from any port.

Output

int

MIDI real time messages (MIDI clock, start, stop, and continue) received from the specified port are sent out the outlet.

See Also

Name Description
MIDI MIDI
clocker Report elapsed time, at regular intervals
metro Output a bang message at regular intervals
midiin Output raw MIDI data
seq Sequencer for recording and playing MIDI data