sxformat
Prepare MIDI system exclusive messages
Description
Accepts, as arguments, a list of numbers which are sent out sequentially. In addition, you may use one or more "expr"-style statements, which start with the word "is", which will be evaluated with the result being sent out. "is" statements need to be separated by slashes.
Discussion
The format of sxformat arguments is similar to statements in a "lib" object script.
Arguments
SysEx[list]
optional
Obligatory. The arguments are a list of numbers which represent the values of individual bytes of a MIDI system exclusive message. The first number should be 240 (or 0xF0 ), the system exclusive status byte and the last number should be 247 (or 0xF7 ), the end byte. There can be any number of values for data bytes in between.
Arguments for data bytes can also be in the form of a mathematical expression (like the expressions in expr and if objects) to be evaluated before numbers are sent out the outlet. The expressions can contain changeable arguments in the form $i , followed immediately by an inlet number (for example, $i2 ). The changeable arguments are replaced by numbers received in the specified inlet. Expressions used in place of numbers should be preceded by the word is , and should be separated from other arguments with a slash (/) on either side of the expression (see example).
If the value of an evaluated expression is less than 0, no number is sent out in place of that expression. This allows you to send variable-length system exclusive messages.
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
In left inlet: Sends out the bytes of the formatted message, using the most recently received numbers.
int
In left inlet: The number replaces any $ i1 arguments in the object box, and the entire list of arguments is evaluated and sent out the outlet, one-by-one.
- input
[int]
(inlet1)
In any other inlet besides left: The number is stored in place of the $i argument that corresponds to that inlet, until a number is received in the left inlet.
- input
[int]
(inlet2)
In any other inlet besides left: The number is stored in place of the $i argument that corresponds to that inlet, until a number is received in the left inlet.
- input
[int]
(inlet3)
In any other inlet besides left: The number is stored in place of the $i argument that corresponds to that inlet, until a number is received in the left inlet.
- input
[int]
(inlet4)
In any other inlet besides left: The number is stored in place of the $i argument that corresponds to that inlet, until a number is received in the left inlet.
- input
[int]
(inlet5)
In any other inlet besides left: The number is stored in place of the $i argument that corresponds to that inlet, until a number is received in the left inlet.
- input
[int]
(inlet6)
In any other inlet besides left: The number is stored in place of the $i argument that corresponds to that inlet, until a number is received in the left inlet.
- input
[int]
(inlet7)
In any other inlet besides left: The number is stored in place of the $i argument that corresponds to that inlet, until a number is received in the left inlet.
- input
[int]
(inlet8)
In any other inlet besides left: The number is stored in place of the $i argument that corresponds to that inlet, until a number is received in the left inlet.
- input
[int]
(inlet9)
In any other inlet besides left: The number is stored in place of the $i argument that corresponds to that inlet, until a number is received in the left inlet.
- input
[int]
list
In left inlet: The numbers in the list are used to replace the corresponding $i arguments in the object box, then the list of arguments is evaluated and the numbers are sent out one-by-one.
- input
[list]
Output
int
When a number is received in the left inlet, any expressions in the argument are evaluated and the numbers in the list are sent out one at a time, as bytes of a MIDI system exclusive message, for transmission by midiout.
See Also
| Name | Description |
|---|---|
| expr | Evaluate a mathematical expression |
| midiout | Transmit raw MIDI data |
| sysexin | Receive MIDI system exclusive messages |