xctlout

Format 14-bit MIDI controller messages

Description

Format 14-bit MIDI continuous controller messages to be transmitted using the midiout object.

Discussion

A single 14-bit MIDI continuous controller message comprises two groups of bytes, one for the most significant byte of the value (MSB, on controller 0-31) and one for the least significant byte (LSB, on the MSB controller + 32).

Arguments

ctrllr-channel [list]

Optional

The initial argument is an initial high resolution controller number (in the range 0-31) to be used in control messages formatted by xctlout. Controller numbers are automatically limited between 0 and 31. If there is no controller number specified, the initial controller number is 1.

Following the controller number argument is an initial value for the channel number with which to format control messages. If the channel argument is not present, xctlout initially formats control messages on channel 1. In order for this argument to be used, a controller number argument must precede it. The channel number is clipped to the range 1-16.

Attributes

lsbfirst [int] (default: 0)

When enabled, the LSB group of bytes in the formatted continuous controller messages will be transmitted first, followed by the MSB group. This is required by some MIDI hardware.

running [int] (default: 0)

If running status is enabled, the status byte of the second (LSB) group of bytes in the formatted continuous controller messages will be eliminated.

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.

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 [float]

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 high resolution MIDI continuous controller message using the numbers currently stored in xctlout

int

Arguments

input [int]
The number is a 14-bit continuous controller value to be formatted into a complete high resolution MIDI continuous controller message by xctlout.

  (inlet1)

Arguments

controller [int]
In middle inlet: The number is stored as the controller number of the control change messages transmitted by xctlout. Controller numbers outside of the range 0-31 will be ignored.

  (inlet2)

Arguments

channel [int]
In right inlet: The number is stored as the MIDI channel for the continuous controller message sent out by xctlout. Channel numbers will be clipped to stay within the 1-16 range.

float

Arguments

input [float]
The number is a 14-bit continuous controller value to be formatted into a complete high resolution MIDI continuous controller message by xctlout.

list

Arguments

msb [int]
lsb [int]
A pair of two 7-bit values (most significant byte (MSB) followed by least significant byte (LSB)) will be ORd together to form a single 14-bit continuous controller value. The 14-bit value will be formatted into a complete high resolution MIDI continuous controller message by xctlout.

Output

int

When a value is received in the left inlet, the complete high resolution MIDI continuous controller message is sent out the outlet, byte-by-byte.

See Also

Name Description
midiout Transmit raw MIDI data
ctlout Transmit MIDI controller messages
xctlin Output received 14-bit MIDI control values
xbendout Format extra precision MIDI pitch bend messages
xnoteout Format MIDI note messages with release velocity
nrpnout Format 14-bit MIDI NRPN messages
rpnout Format 14-bit MIDI RPN messages