xctlout Reference

Format 14-bit MIDI controller messages

xctlout

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

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
ctlout
xctlin
xbendout
xnoteout
nrpnout
rpnout