SuperCollider CLASSES

MIDIResponder

Register multiple functions to be evaluated when MIDI events occur
Inherits from: Object

Description

NOTE: SC 3.5 added the MIDIFunc and MIDIdef classes. These are faster, and aim to have a more convenient, logical and consistent interface, which shares a common design with OSCFunc and OSCdef. They also provide support for all MIDI message types.

MIDIResponder is an abstract class. Its subclasses allow functions to be registered to respond to midi events.

Read the general help file here and then see the individual help files.

CCResponder
Respond to control messages
NoteOnResponder
Respond to note-on messages
NoteOffResponder
Respond to note-off messages
BendResponder
Respond to pitch bend messages
TouchResponder
Respond to aftertouch messages
ProgramChangeResponder
Respond to programchange messages

Creation and initialization

function
The function to execute when the incoming MIDI event matches the responder. The function takes the arguments src, chan, A, B (or for Bend, ProgramChange and Touch: src, chan, value).
src
If a number is given, the responder will fire only for messages coming in from this port. The number may be the system UID (obtained from MIDIClient.sources[index].uid) or the index itself. If nil, the responder will match any port.
chan
The MIDI channel(s) to match.
num
The control or note number(s) to match.
value
The value(s) to match.
veloc
The velocities to match.
install
If true, install the responder automatically so it is active and ready to respond. If false, then it will be inactive.
swallowEvent
If true, then if the midi event is matched, cease testing any further responders. eg. if a CCResponder matches port, chan and num, and swallowEvent is set to true, then no further CCResponders will be offered the chance to respond to the event. The event is "swallowed". By default this is false. Note that doing this will prevent any other responders of this type from responding, including ones added behind the scenes in classes. Note also that this functionality is sensitive to the order in which responders are added.

Any of the matching values may be one of the following:

Nil
Match anything. eg. if chan is nil, then respond to any MIDI channel.
Integer
Match only this specific number.
Array
Match any item in the array. Any kind of Collection will work here.
Function
Evaluate the function with the incoming value as the argument. The function should return true or false.

For instance, the following example would respond to note on messages from any port, channels 2 and 7 only, even numbered note numbers only, and only velocity values greater than 50.

NoteOnResponder({ |src, chan, num, vel| [src, chan, num, vel].postln },
    nil,    // any port
    [2, 7],    // midi channels 2 or 7 only
    (0, 2..126),    // this is an array of even numbers. could also be specified as { |num| num.even } or _.even
    { |vel| vel > 50 });    // velocities greater than 50

MIDIResponders automatically initialize the MIDIClient with 1 standard device. This means the first time you install any MIDIResponder, it will make sure that MIDI has been initialized. If you have more devices or a specific setup, simply initialize the MIDIClient yourself before using any MIDIResponders.

Removal

Just call .remove on the responder.

c = CCResponder({ ... }, num: 1);    // respond to any modwheel

c.remove;        // stop this responder

Or remove all of a specific class:

CCResponder.removeAll
NoteOnResponder.removeAll
NoteOffResponder.removeAll
BendResponder.removeAll
TouchResponder.removeAll
ProgramChange.removeAll

or remove all midi responders in all classes:

MIDIResponder.removeAll

Class Methods

Inherited class methods

Undocumented class methods

*removeAll

Instance Methods

Inherited instance methods

Undocumented instance methods

-function

-function = value

-match (src, chan, num, value)

-matchEvent

-matchEvent = value

-remove

-respond (src, chan, num, value)

-swallowEvent

-swallowEvent = value

-value (src, chan, a, b)