notein
Receive MIDI note messages
Description
Receives its input from a MIDI note-on or note-off message sent by a MIDI input device.
Arguments
port[symbol]
optional
Specifies the port (a-z) from which to receive incoming note messages. If there is no argument, notein receives from all channels on all ports.
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.
port-channel[list]
optional
A letter and number combination (separated by a space) indicates a port and a specific MIDI channel on which to receive note messages. Channel numbers greater than 16 will be wrapped around to stay within the 1-16 range.
channel[int]
optional
A number alone can be used in place of a letter and number combination. The exact meaning of the channel number argument depends on the channel offset specified for each port in the MIDI Setup dialog.
Attributes
matchport[int]: 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]: 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
anything
Performs the same function as port without the word, "port".
- port
[list]
(mouse)
Double-clicking on a notein object shows a pop-up menu for choosing a MIDI port or device.
(MIDI)
The notein object receives its input from a MIDI note-on or note-off message received from a MIDI input device.
port
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 note 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.
- port
[symbol]
Output
int
Out left outlet: The number is the pitch value of the incoming note message.
Out 2nd outlet: The number is the velocity of the incoming note-on message if non-zero, 0 for a note-off message. To receive release velocity, use xnotein.
If a specific channel number is included in the argument, there are only two outlets. If there is no channel number specified by the argument, notein will have a third outlet, on the right, which will output the channel number of the incoming note message.
See Also
| Name | Description |
|---|---|
| ctlin | Output received MIDI control values |
| midiin | Output raw MIDI data |
| noteout | Transmit MIDI note messages |
| nslider | Output numbers from a notation display |
| rtin | Receive MIDI real time messages |
| xbendin | Interpret extra precision MIDI pitch bend values |
| xnotein | Interpret MIDI note messages with release velocity |