HelpSource/Classes/TouchResponder.schelp

   1 class:: TouchResponder
   2 summary:: allow functions to be registered to respond to MIDI aftertouch events
   3 related:: Classes/MIDIFunc, Classes/MIDIdef, Classes/MIDIResponder, Classes/CCResponder
   4 categories:: External Control>MIDI
   5
   6 Description::
   7 note:: As of SC 3.5 link::Classes/MIDIFunc:: and link::Classes/MIDIdef:: are the recommended way of registering for incoming MIDI messages. They are faster, safer, and have more logical argument order than the old MIDI responder classes. The older class MIDIResponder, and its subclasses NoteOnResponder, NoteOffResponder, BendResponder, TouchResponder, CCResponder, and ProgramChangeResponder are maintained for legacy code only.::
   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, 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::value
  22 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 }
  23
  24 argument::install
  25 If true, install the responder automatically so it is active and ready to respond. If false, then it will be inactive.
  26
  27 argument::swallowEvent
  28 If true, then if the midi event is matched, cease testing any further responders.
  29
  30 InstanceMethods::
  31
  32 method::learn
  33 Wait for the next aftertouch message, reset self to match src, chan.
  34 code::
  35 (
  36 c = TouchResponder({ |src,chan,value|
  37                 [src,chan,value].postln;
  38         });
  39         c.learn; // wait for the first touch message
  40 )
  41 TouchResponder.removeAll
  42 ::
  43
  44
  45 Examples::
  46
  47 code::
  48 (
  49         c = TouchResponder({ |src,chan,val|
  50                 [src,chan,val].postln;
  51                 },
  52                 nil, // any source
  53                 nil, // any channel
  54                 nil // any value
  55         )
  56 )
  57
  58 c.remove
  59 ::
  60
  61 code::
  62 (
  63         c = TouchResponder({ |src,chan,val|
  64                 [src,chan,val].postln;
  65                 },
  66                 nil, // any source
  67                 nil, // any channel
  68                 (50..90) // values within this range
  69         )
  70 )
  71
  72 c.remove
  73 ::