xnoteout
Format MIDI note messages with release velocity
Arguments
channel[int]
optional
Sets an initial value for the MIDI channel of the outgoing messages. Channel numbers greater than 16 will be wrapped around to stay within the 1-16 range. If there is no argument, the initial channel number is 1 .
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]: 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
Sends out a MIDI message using the numbers currently stored in xnoteout.
int
In left inlet: The number is used as the pitch value for a note-on or note-off message, and the message is sent out the outlet byte-by-byte.
In left-middle inlet: The number is stored as the velocity for either a note-on or a note-off message. If no number has been received yet, the velocity for note-ons is 64 , and the velocity for note-offs is 0 .
In right-middle inlet: The number is stored as the indicator of whether outgoing messages should be note-ons or note-offs. If the number is not 0, xnoteout will send out a note-on message. If the number is 0 , xnoteout will send out a note-off message with a release velocity. If no number has been received yet, it is initially 1 (note-on).
In right inlet: The number is stored as the channel for the MIDI message sent out by xnoteout. Channel numbers greater than 16 will be wrapped around to stay within the 1-16 range.
- input
[int]
(inlet1)
Inlet numbering starts at 0. Second inlet: Integer is stored as the velocity for either a note-on or a note-off message. If no number has been received yet, the velocity for note-ons is 64 , and the velocity for note-offs is 0 .
- velocity
[int]
(inlet2)
Inlet numbering starts at 0. Third inlet: The number is stored as the indicator of whether outgoing messages should be note-ons or note-offs. If the number is not 0, xnoteout will send out a note-on message. If the number is 0 , xnoteout will send out a note-off message with a release velocity. If no number has been received yet, it is initially 1 (note-on).
- note-flag
[int]
(inlet3)
Inlet numbering starts at 0. Fourth inlet: The number is stored as the channel for the MIDI message sent out by xnoteout. Channel numbers greater than 16 will be wrapped around to stay within the 1-16 range.
- channel
[int]
list
The first number is the pitch value, the second number is the velocity, the third number is the note-on/note-off indicator (non-zero for note-on, 0 for note-off), and the fourth number is the channel. The numbers are stored by xnoteout, and a MIDI note-on or note-off message is sent out.
- pitch
[int]
- velocity
[int]
- note-flag
[int]
- channel
[int]
Output
int
When a pitch value is received, a complete MIDI note-on or note-off message is sent out the outlet, byte-by-byte. Whereas a note-on with a velocity of 0 is most commonly used to indicate a note-off, xnoteout sends out the MIDI note-off command and uses the specified velocity as a release velocity.
See Also
| Name | Description |
|---|---|
| noteout | Transmit MIDI note messages |
| midiout | Transmit raw MIDI data |
| xnotein | Interpret MIDI note messages with release velocity |