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

hi Reference

Human Interface (gaming) device input

hi

Description

Provides input from human interface peripherals (i.e. Trackpad, Keyboard, and others).

Examples

Affect the pitch and duration of notes

Arguments

device [symbol]

Optional

An argument can be used to specify the object for focus on the hi object.

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

bang

bang message will output the current event queue.

int

Arguments

index [int]
An incoming int causes the object to focus on the device in the device list with that index.

anything

Arguments

device [list]
Sending the name of any device to the hi object will set the object to focus on the specified device.

clear

The message clear will reset all values set using the ignore and delta messages to their default values.

delta

Arguments

element [int]
The word delta, followed by an integer that represents an element of the device will cause the hi object to report an event from the specified element only if it is different then the last value that was reported.

ignore

Arguments

element [int]
The word ignore, followed by an integer that represents an element of the device, disables event reporting from the specified element.

info

The info message causes device information to be output to the Max console.
The menu message causes a device list to be output from the right outlet in a format fit for a umenu object. On Windows, Onboard and or bluetooth HID devices (keyboards, mouse) are unsupported as available devices.

poll

Arguments

output-time [float]
The word poll, followed by a number, sets the time in milliseconds between outputs of the event queue. The message poll 0 disables automatic polling.

Output

list

The object collects data from the selected device and will output all collected data when a bang or a timing trigger from to a poll message is received. Data is output as a two-element integer list; he first element represents the element of the device to which the data applies, and the second element represents the data value.

See Also

Name Description
Using Max with Hardware Using Max with Hardware
gamepad Report gamepad controller events
key Report keyboard presses
keyup Report key information on release
Max Comm Tutorial 1: Human-Interface Devices Max Comm Tutorial 1: Human-Interface Devices