hid
Human Interface Device input (modern)
Description
Provides input from human interface peripherals (i.e. Trackpad, Keyboard, and others). The hid object is similar to the legacy hi object but is cross platform with more information and capabilities. This includes providing usage pages, usages, types, and ranges for the information received. (see https://www.usb.org/hid for more information)
Arguments
device[symbol]
optional
An argument can be used to specify the object for focus on the hid object.
Attributes
exclusive[int]
On Mac OS, the exclusive enables to use devices such as mice, keyboards, graphics tablets, etc. exclusively. This is useful when one wishes the input to only be sent to Max and not control the online mouse cursor or trigger system key events, etc. Be careful when using that you will not prevent yourself from using you rmouse or keyboard to disable or close your patch.
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]: 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'
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
bang message will output the current event queue.
int
An incoming int causes the object to focus on the device in the device list with that index.
- index
[int]
anything
Sending the name of any device to the hid object will set the object to focus on the specified device.
- device
[list]
close
Close the currently open device
info
The info message causes device information to be output to the Max console.
poll
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-time
[float]
See Also
| Name | Description |
|---|---|
| hi | Human Interface device input (legacy) |
| gamepad | Report gamepad controller events |
| key | Report keyboard presses |
| keyup | Report key information on release |