ctlin
Output received MIDI control values
Description
Output the value from a specific controller number and MIDI channel.
Arguments
port[symbol]
optional
Specifies the port (a-z) from which to receive incoming control messages. If there is no letter present as an argument, ctlin can receive from all ports.
device[symbol]
optional
The name of a MIDI input device may be used as the first argument to specify the port. The name 'all' can be used to enable the reception of MIDI messages from any port. The name 'none' can be used to prevent the object from receiving MIDI messages from any port.
ctrllr-channel[list]
optional
Following the (optional) port argument, the next argument is a single controller number to be recognized by ctlin. If there is no controller number, or if the argument is a negative number, ctlin recognizes all 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, ctlin 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.
If a single channel number is specified as an argument, the outlet which normally sends the channel number is unnecessary, and is not created. If a port has been specified with a letter argument, channel numbers greater than 16 will be wrapped around to stay within the 1-16 range. If no port argument is present, a channel number can be used in place of a letter and number combination. The exact meaning of the channel number argument depends on the channel offset specified for each port in the MIDI Setup dialog.
Attributes
matchport[int]: 0
If the port argument doesn't match an existing port or device name, set the object's MIDI port to 'none'.
name[symbol]
Set the object's MIDI port based on a device name. The attribute will attempt to do a case-sensitive partial string match based on the attribute's value.
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]
JS Painter File
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
anything
Performs the same function as port .
- port
[list]
(mouse)
Double-clicking on a ctlin object shows a pop-up menu for choosing a MIDI port or device.
(MIDI)
ctlin receives its input from a MIDI control change message received from a MIDI input device.
port
The word port , followed by a letter a - z or the name of a MIDI input port or device, sets the port from which the object receives incoming control messages. The word port is optional and may be omitted. The name 'all' can be used to enable the reception of MIDI messages from any port. The name 'none' can be used to prevent the object from receiving MIDI messages from any port.
- port
[symbol]
set
The word set , followed by a number from 0 to 127, specifies a single controller number to be paid attention to by the ctlin object. If the ctlin object was created with no argument, set with an argument of -1 will cause the object to listen for all controller numbers (otherwise, set -1 will be ignored).
- controller
[int]
Output
int
Out left outlet: The number is the control value of an incoming MIDI control change message.
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 |
|---|---|
| bendin | Output MIDI pitch bend values |
| ctlout | Transmit MIDI controller messages |
| midiin | Output raw MIDI data |
| notein | Receive MIDI note messages |
| rtin | Receive MIDI real time messages |
| xbendin | Interpret extra precision MIDI pitch bend values |