rsc3/doc-schelp/HelpSource/Classes/NoteOnResponder.scrbl

108 lines
2.9 KiB
Racket

#lang scribble/manual
@(require (for-label racket))
@title{NoteOnResponder}
allow functions to be registered to respond to MIDI noteOn events@section{related}
Classes/MIDIFunc, Classes/MIDIdef, Classes/MIDIResponder, Classes/CCResponder
@section{categories}
External Control>MIDI
@section{description}
@section{note}
SC 3.5 added the link::Classes/MIDIFunc:: and link::Classes/MIDIdef:: classes. These are faster, and aim to have a more convenient, logical and consistent interface, which shares a common design with link::Classes/OSCFunc:: and link::Classes/OSCdef::. They also provide support for all MIDI message types.::
@section{ClassMethods}
@section{method}
new
@section{argument}
function
A link::Classes/Function:: to be evaluated. Arguments passed to the function are: src, chan, num, value.
@section{argument}
src
The src number may be the system UID (obtained from
@racketblock[ MIDIClient.sources[index].uid ::) or the index of the source in the ]
@racketblock[ MIDIClient.sources :: array. nil matches all.
]
@section{argument}
chan
An link::Classes/Integer:: between 0 and 15 that selects which MIDI channel to match. nil matches all. May also be a link::Classes/Function:: which will be evaluated to determine the match. eg: { |val| val < 2 }
@section{argument}
num
An link::Classes/Integer:: between 0 and 127 that selects which note number to match. nil matches all. May also be a link::Classes/Function:: which will be evaluated to determine the match. eg: { |val| val >= 4 }
@section{argument}
veloc
An link::Classes/Integer:: between 0 and 127 to filter values. nil matches all. May also be a link::Classes/Function:: which will be evaluated to determine the match. eg: { |val| val < 50 }
@section{argument}
install
If true, install the responder automatically so it is active and ready to respond. If false, then it will be inactive.
@section{argument}
swallowEvent
If true, then if the midi event is matched, cease testing any further responders. 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.
@section{InstanceMethods}
@section{method}
learn
Wait for the next noteOn message, reset self to match src, chan.
@racketblock[
(
c = NoteOnResponder({ |src,chan,note,vel|
[src,chan,note,vel].postln;
});
c.learn; // wait for the first note
)
NoteOnResponder.removeAll
::
]
@section{Examples}
@racketblock[
(
c = NoteOnResponder({ |src,chan,note,vel|
[src,chan,note,vel].postln;
},
nil, // any source
nil, // any channel
nil, // any note
nil // any vel
)
)
c.remove
::
]
@racketblock[
(
c = NoteOnResponder({ |src,chan,note,vel|
[src,chan,note,vel].postln;
},
nil, // any source
nil, // any channel
(50..60), // within this note range
nil // any vel
)
)
c.remove
::
]