Packageorg.si.sion.events
Classpublic class SiONMIDIEvent
InheritanceSiONMIDIEvent Inheritance SiONTrackEvent Inheritance SiONEvent Inheritance flash.events.Event

SiON MIDI Event class.



Public Properties
 PropertyDefined By
 InheritedbufferIndex : int
[read-only] Buffering index.
SiONTrackEvent
  controllerNumber : int
[read-only] controller number of CONTROL_CHANGE, same as SiONTrackEvent's note
SiONMIDIEvent
 Inheriteddata : SiONData
[read-only] Sound data.
SiONEvent
 Inheriteddriver : SiONDriver
[read-only] Sound driver.
SiONEvent
 InheritedeventTriggerID : int
[read-only] Trigger ID.
SiONTrackEvent
 InheritedframeTriggerDelay : Number
[read-only] Delay time to dispatch frame trigger event [ms].
SiONTrackEvent
  midiChannel : MIDIModuleChannel
[read-only] MIDI channel instance
SiONMIDIEvent
  midiChannelNumber : int
[read-only] MIDI channel Number, same as SiON event trigger ID.
SiONMIDIEvent
  midiModule : MIDIModule
[read-only] MIDI sound module to play
SiONMIDIEvent
 Inheritednote : int
[read-only] Note number.
SiONTrackEvent
 InheritedstreamBuffer : ByteArray
[read-only] ByteArray of sound stream.
SiONEvent
 Inheritedtrack : SiMMLTrack
[read-only] Sequencer track instance.
SiONTrackEvent
  value : int
[read-only] data(CONTROL_CHANGE), program number(PROGRAM_CHANGE), bendvalue(PITCH_BEND) or velocity(NOTE events).
SiONMIDIEvent
Public Methods
 MethodDefined By
  
clone():Event
[override] clone.
SiONMIDIEvent
Public Constants
 ConstantDefined By
 InheritedBEAT : String = beat
[static] Dispatch on beat while streaming.
SiONTrackEvent
 InheritedCHANGE_BPM : String = changeBPM
[static] Dispatch when the bpm changes.
SiONTrackEvent
  CONTROL_CHANGE : String = midiControlChange
[static] Dispatch when the control change command appears in MIDI data.
SiONMIDIEvent
 InheritedFADE_IN_COMPLETE : String = fadeInComplete
[static] Dispatch when fade in is finished.
SiONEvent
 InheritedFADE_OUT_COMPLETE : String = fadeOutComplete
[static] Dispatch when fade out is finished.
SiONEvent
 InheritedFADE_PROGRESS : String = fadeProgress
[static] Dispatch while fading.
SiONEvent
 InheritedFINISH_SEQUENCE : String = finishSequence
[static] Dispatch when finish executing all sequences.
SiONEvent
  NOTE_OFF : String = midiNoteOff
[static] Dispatch when the note off appears in MIDI data.
SiONMIDIEvent
 InheritedNOTE_OFF_FRAME : String = noteOffFrame
[static] Dispatch when the sound ends.
SiONTrackEvent
 InheritedNOTE_OFF_STREAM : String = noteOffStream
[static] Dispatch when the note off appears in the sequence with "%t" command.
SiONTrackEvent
  NOTE_ON : String = midiNoteOn
[static] Dispatch when the note on appears in MIDI data.
SiONMIDIEvent
 InheritedNOTE_ON_FRAME : String = noteOnFrame
[static] Dispatch when the sound starts.
SiONTrackEvent
 InheritedNOTE_ON_STREAM : String = noteOnStream
[static] Dispatch when the note on appears in the sequence with "%t" command.
SiONTrackEvent
  PITCH_BEND : String = midiPitchBend
[static] Dispatch when the pitch bend command appears in MIDI data.
SiONMIDIEvent
  PROGRAM_CHANGE : String = midiProgramChange
[static] Dispatch when the program change command appears in MIDI data.
SiONMIDIEvent
 InheritedQUEUE_CANCEL : String = queueCancel
[static] Dispatch when cancel all queued jobs.
SiONEvent
 InheritedQUEUE_COMPLETE : String = queueComplete
[static] Dispatch when finish all queued jobs.
SiONEvent
 InheritedQUEUE_PROGRESS : String = queueProgress
[static] Dispatch when executing queued jobs.
SiONEvent
 InheritedSTREAM : String = stream
[static] Dispatch while streaming.
SiONEvent
 InheritedSTREAM_START : String = streamStart
[static] Dispatch when start streaming.
SiONEvent
 InheritedSTREAM_STOP : String = streamStop
[static] Dispatch when stop streaming.
SiONEvent
 InheritedUSER_DEFINED : String = userDefined
[static] Dispatch when SiONDriver.dispatchUserDefinedTrackEvent() is called.
SiONTrackEvent
Property Detail
controllerNumberproperty
controllerNumber:int  [read-only]

controller number of CONTROL_CHANGE, same as SiONTrackEvent's note


Implementation
    public function get controllerNumber():int
midiChannelproperty 
midiChannel:MIDIModuleChannel  [read-only]

MIDI channel instance


Implementation
    public function get midiChannel():MIDIModuleChannel
midiChannelNumberproperty 
midiChannelNumber:int  [read-only]

MIDI channel Number, same as SiON event trigger ID.


Implementation
    public function get midiChannelNumber():int
midiModuleproperty 
midiModule:MIDIModule  [read-only]

MIDI sound module to play


Implementation
    public function get midiModule():MIDIModule
valueproperty 
value:int  [read-only]

data(CONTROL_CHANGE), program number(PROGRAM_CHANGE), bendvalue(PITCH_BEND) or velocity(NOTE events).


Implementation
    public function get value():int
Method Detail
clone()method
override public function clone():Event

clone.

Returns
Event
Constant Detail
CONTROL_CHANGEConstant
public static const CONTROL_CHANGE:String = midiControlChange

Dispatch when the control change command appears in MIDI data.

The properties of the event object have the following values:

PropertyValue
cancelablefalse
driverSiONDriver instance.
dataSiONDataConverterSMF instance.
streamBuffernull
bufferIndexBuffering index
eventTriggerIDMIDI channel Number
tracknull
midiModuleMIDIModule instance to play
midiChannelMIDIModuleChannel instance to play
midiChannelNumberMIDI channel Number
notesame as controllerNumber prop.
valuedata value for the controller
controllerNumberController number

NOTE_OFFConstant 
public static const NOTE_OFF:String = midiNoteOff

Dispatch when the note off appears in MIDI data.

The properties of the event object have the following values:

PropertyValue
cancelablefalse
driverSiONDriver instance.
dataSiONDataConverterSMF instance.
streamBuffernull
bufferIndexBuffering index
eventTriggerIDMIDI channel Number
trackSiMMLTrack instance to play
midiModuleMIDIModule instance to play
midiChannelMIDIModuleChannel instance to play
midiChannelNumberMIDI channel Number
noteNote number.
valuealways 0.
controllerNumbersame as note prop.

NOTE_ONConstant 
public static const NOTE_ON:String = midiNoteOn

Dispatch when the note on appears in MIDI data.

The properties of the event object have the following values:

PropertyValue
cancelablefalse
driverSiONDriver instance.
dataSiONDataConverterSMF instance.
streamBuffernull
bufferIndexBuffering index
eventTriggerIDMIDI channel Number
trackSiMMLTrack instance to play
midiModuleMIDIModule instance to play
midiChannelMIDIModuleChannel instance to play
midiChannelNumberMIDI channel Number
noteNote number.
valuevelocity.
controllerNumbersame as note prop.

PITCH_BENDConstant 
public static const PITCH_BEND:String = midiPitchBend

Dispatch when the pitch bend command appears in MIDI data.

The properties of the event object have the following values:

PropertyValue
cancelablefalse
driverSiONDriver instance.
dataSiONDataConverterSMF instance.
streamBuffernull
bufferIndexBuffering index
eventTriggerIDMIDI channel Number
tracknull
midiModuleMIDIModule instance to play
midiChannelMIDIModuleChannel instance to play
midiChannelNumberMIDI channel Number
notealways 0
valuebend value
controllerNumberalways 0

PROGRAM_CHANGEConstant 
public static const PROGRAM_CHANGE:String = midiProgramChange

Dispatch when the program change command appears in MIDI data.

The properties of the event object have the following values:

PropertyValue
cancelablefalse
driverSiONDriver instance.
dataSiONDataConverterSMF instance.
streamBuffernull
bufferIndexBuffering index
eventTriggerIDMIDI channel Number
tracknull
midiModuleMIDIModule instance to play
midiChannelMIDIModuleChannel instance to play
midiChannelNumberMIDI channel Number
notealways 0
valueprogram number
controllerNumberalways 0