xctlin

Output received 14-bit MIDI control values

Description

Output the value from a specific 14-bit controller pair and MIDI channel.

Arguments

ctrllr-channel [list]

Optional

The initial argument is a single high resolution controller number (in the range 0-31) to be recognized by xctlin. If there is no controller number, or if the argument is a negative number, xctlin recognizes all high resolution controller numbers. If a single controller number is specified in the argument, the outlet which normally sends the controller number is unnecessary, and is not created.

Following the controller number argument is a single channel number on which to receive control messages. If the channel argument is not present, xctlin receives control messages on all channels. In order for this argument to be used, a controller number argument must precede it. To specify a channel number without specifying a controller number, use -1 for the controller number. The channel number is clipped to the range 1-16.

Attributes

lsbfirst [int] (default: 0)

When enabled, the LSB group of bytes in the incoming continuous controller messages will be parsed first, followed by the MSB group. This ordering is unusual, but is required by some MIDI hardware.

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]

Text Justification

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

int

Arguments

input [int]
The numbers are individual bytes of a MIDI message stream, received from an object such as midiin.

list

Arguments

input [list]
The numbers are bytes of a MIDI message stream, received from an object such as midiin.

set

Arguments

controller [int]
The message set without any arguments, or with an argument of -1, will cause xctlin to output incoming 14-bit MIDI continuous controller messages from any high resolution controller. An argument between 0 and 31 (the MIDI high resolution controller numbers) will cause xctlin to only output incoming 14-bit MIDI continuous controller messages from the controller specified.

Output

int

Out left outlet: The number is the value of an incoming MIDI control change message as a single 14-bit value.

If a specific controller number is not specified as an argument, the controller number is sent out the 2nd outlet.

If a specific channel number is not included in the argument, the channel number is sent out an additional, right, outlet.

See Also

Name Description
midiin Output raw MIDI data
ctlin Output received MIDI control values
xctlout Format 14-bit MIDI controller messages
xbendin Interpret extra precision MIDI pitch bend values
xnotein Interpret MIDI note messages with release velocity
nrpnin Output received NRPN values
rpnin Output received RPN values