HelpSource/Classes/BendResponder.schelp

   1 class:: BendResponder
   2 summary:: allow functions to be registered to respond to MIDI pitchbend 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
   9 ClassMethods::
  10
  11 method::new
  12
  13 argument::function
  14 A link::Classes/Function:: to be evaluated. Arguments passed to the function are: src, chan, value.
  15
  16 argument::src
  17 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.
  18
  19 argument::chan
  20 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 }
  21
  22 argument::value
  23 An link::Classes/Integer:: between 0 and 16383 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 }
  24
  25 argument::install
  26 If true, install the responder automatically so it is active and ready to respond. If false, then it will be inactive.
  27
  28 argument::swallowEvent
  29 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.
  30
  31 InstanceMethods::
  32
  33 method::learn
  34 Wait for the next pitch bend message, reset self to match src, chan.
  35 code::
  36 (
  37 c = BendResponder({ |src,chan,value|
  38                 [src,chan,value].postln;
  39         });
  40         c.learn; // wait for the first bend message
  41 )
  42 BendResponder.removeAll
  43 ::
  44
  45
  46 Examples::
  47
  48 code::
  49 (
  50         c = BendResponder({ |src,chan,val|
  51                 [src,chan,val].postln;
  52                 },
  53                 nil, // any source
  54                 nil, // any channel
  55                 nil // any value
  56         )
  57 )
  58
  59 c.remove
  60 ::
  61
  62 code::
  63 (
  64         c = BendResponder({ |src,chan,val|
  65                 [src,chan,val].postln;
  66                 },
  67                 nil, // any source
  68                 (3..6), // only channels 3 - 6
  69                 nil // any value
  70         )
  71 )
  72
  73 c.remove
  74 ::