HelpSource/Classes/CCResponder.schelp

   1 class:: CCResponder
   2 summary:: allow functions to be registered to respond to MIDI control change events
   3 related:: Classes/MIDIFunc, Classes/MIDIdef, Classes/MIDIResponder, Classes/NoteOnResponder
   4 categories:: 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, 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 controller 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::value
  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.
  32
  33 InstanceMethods::
  34
  35 method::learn
  36 Wait for the next CC message, reset to match src, chan, cc num.
  37 code::
  38 (
  39
  40 c = CCResponder({ |src,chan,num,value|
  41                 [src,chan,num,value].postln;
  42         });
  43         c.learn; // wait for the first controller
  44 )
  45 CCResponder.removeAll
  46 ::
  47
  48
  49 Examples::
  50
  51 code::
  52 (
  53         c = CCResponder({ |src,chan,num,value|
  54                 [src,chan,num,value].postln;
  55                 },
  56                 nil, // any source
  57                 nil, // any channel
  58                 nil, // any CC number
  59                 nil // any value
  60         )
  61 )
  62
  63 c.remove
  64 ::
  65
  66 code::
  67 (
  68         c = CCResponder({ |src,chan,num,value|
  69                 [src,chan,num,value].postln;
  70                 },
  71                 nil, // any source
  72                 nil, // any channel
  73                 80, // CC number 80
  74                 { |val| val < 50 } // any value less than 50
  75         )
  76 )
  77
  78 c.remove
  79 ::