HelpSource/Classes/MIDIFuncChanArrayMessageMatcher.schelp

   1 CLASS:: MIDIFuncChanArrayMessageMatcher
   2 summary:: Matches incoming MIDI messages to responder funcs based on message channel
   3 categories:: MIDI
   4 related:: Classes/AbstractMessageMatcher, Classes/MIDIFuncSrcMessageMatcher, Classes/MIDIFuncChanMessageMatcher, Classes/MIDIFuncSrcMessageMatcherNV, Classes/MIDIFuncBothMessageMatcher, Classes/MIDIFuncBothCAMessageMatcher
   5
   6 DESCRIPTION::
   7 This is used by link::Classes/MIDIMessageDispatcher:: to match incoming MIDI messages to instances of link::Classes/MIDIFunc:: or link::Classes/MIDIdef:: using MIDI channel (when the MIDIFunc specifies an array of channels). This class is private, and generally users should not need to address instances directly.
   8
   9
  10 CLASSMETHODS::
  11
  12 METHOD:: new
  13 Make a new instance.
  14
  15 argument:: chanArray
  16 (describe argument here)
  17
  18 argument:: func
  19 The link::Classes/Function:: to evaluate if a match is found.
  20
  21 returns:: An MIDIFuncChanArrayMessageMatcher.
  22
  23
  24 INSTANCEMETHODS::
  25 private:: init
  26
  27 METHOD:: value
  28 Check to see if a message matches, and evaulate func if it does.
  29
  30 argument:: value
  31 The message value (e.g. velocity, etc.) of the MIDI message as an link::Classes/Integer::. Note this should be in the range 0-127.
  32
  33 argument:: num
  34 The message number (e.g. note number, etc.) of the MIDI message as an link::Classes/Integer::. Note this should be in the range 0-127.
  35
  36 argument:: testChan
  37 The channel number of the MIDI message as an link::Classes/Integer::. Note this should be in the range 0-15.
  38
  39 argument:: srcID
  40 The UID of the source of the MIDI message as an link::Classes/Integer::.