HelpSource/Classes/NoteOnResponder.schelp

   1 class:: NoteOnResponder
   2 summary:: allow functions to be registered to respond to MIDI noteOn events
   3 related:: Classes/MIDIFunc, Classes/MIDIdef, Classes/MIDIResponder, Classes/CCResponder
   4 categories:: External Control>MIDI
   5
   6 Description::
   7 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 still lack some features of the MIDIresponder classes.::
   8 ClassMethods::
   9
  10 method::new
  11
  12 argument::function
  13 A link::Classes/Function:: to be evaluated. Arguments passed to the function are: src, chan, num, value.
  14
  15 argument::src
  16 The src number may be the system UID (obtained from code:: MIDIClient.sources[index].uid ::) or the index of the source in the code:: MIDIClient.sources :: array. nil matches all.
  17
  18 argument::chan
  19 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 }
  20
  21 argument::num
  22 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 }
  23
  24 argument::veloc
  25 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 }
  26
  27 argument::install
  28 If true, install the responder automatically so it is active and ready to respond. If false, then it will be inactive.
  29
  30 argument::swallowEvent
  31 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.
  32
  33 InstanceMethods::
  34
  35 method::learn
  36 Wait for the next noteOn message, reset self to match src, chan.
  37 code::
  38 (
  39 c = NoteOnResponder({ |src,chan,note,vel|
  40                 [src,chan,note,vel].postln;
  41         });
  42         c.learn; // wait for the first note
  43 )
  44 NoteOnResponder.removeAll
  45 ::
  46
  47
  48 Examples::
  49
  50 code::
  51 (
  52         c = NoteOnResponder({ |src,chan,note,vel|
  53                 [src,chan,note,vel].postln;
  54                 },
  55                 nil, // any source
  56                 nil, // any channel
  57                 nil, // any note
  58                 nil // any vel
  59         )
  60 )
  61
  62 c.remove
  63 ::
  64
  65 code::
  66 (
  67         c = NoteOnResponder({ |src,chan,note,vel|
  68                 [src,chan,note,vel].postln;
  69                 },
  70                 nil, // any source
  71                 nil, // any channel
  72                 (50..60), // within this note range
  73                 nil // any vel
  74         )
  75 )
  76
  77 c.remove
  78 ::