| Package | org.si.sion.events |
| Class | public class SiONMIDIEvent |
| Inheritance | SiONMIDIEvent SiONTrackEvent SiONEvent flash.events.Event |
| Property | Defined By | ||
|---|---|---|---|
![]() | bufferIndex : int [read-only] Buffering index. | SiONTrackEvent | |
| controllerNumber : int [read-only] controller number of CONTROL_CHANGE, same as SiONTrackEvent's note | SiONMIDIEvent | ||
![]() | data : SiONData [read-only] Sound data. | SiONEvent | |
![]() | driver : SiONDriver [read-only] Sound driver. | SiONEvent | |
![]() | eventTriggerID : int [read-only] Trigger ID. | SiONTrackEvent | |
![]() | frameTriggerDelay : 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 | ||
![]() | note : int [read-only] Note number. | SiONTrackEvent | |
![]() | streamBuffer : ByteArray [read-only] ByteArray of sound stream. | SiONEvent | |
![]() | track : 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 | ||
| Method | Defined By | ||
|---|---|---|---|
clone():Event [override] clone. | SiONMIDIEvent | ||
| Constant | Defined By | ||
|---|---|---|---|
![]() | BEAT : String = beat [static] Dispatch on beat while streaming. | SiONTrackEvent | |
![]() | CHANGE_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 | ||
![]() | FADE_IN_COMPLETE : String = fadeInComplete [static] Dispatch when fade in is finished. | SiONEvent | |
![]() | FADE_OUT_COMPLETE : String = fadeOutComplete [static] Dispatch when fade out is finished. | SiONEvent | |
![]() | FADE_PROGRESS : String = fadeProgress [static] Dispatch while fading. | SiONEvent | |
![]() | FINISH_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 | ||
![]() | NOTE_OFF_FRAME : String = noteOffFrame [static] Dispatch when the sound ends. | SiONTrackEvent | |
![]() | NOTE_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 | ||
![]() | NOTE_ON_FRAME : String = noteOnFrame [static] Dispatch when the sound starts. | SiONTrackEvent | |
![]() | NOTE_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 | ||
![]() | QUEUE_CANCEL : String = queueCancel [static] Dispatch when cancel all queued jobs. | SiONEvent | |
![]() | QUEUE_COMPLETE : String = queueComplete [static] Dispatch when finish all queued jobs. | SiONEvent | |
![]() | QUEUE_PROGRESS : String = queueProgress [static] Dispatch when executing queued jobs. | SiONEvent | |
![]() | STREAM : String = stream [static] Dispatch while streaming. | SiONEvent | |
![]() | STREAM_START : String = streamStart [static] Dispatch when start streaming. | SiONEvent | |
![]() | STREAM_STOP : String = streamStop [static] Dispatch when stop streaming. | SiONEvent | |
![]() | USER_DEFINED : String = userDefined [static] Dispatch when SiONDriver.dispatchUserDefinedTrackEvent() is called. | SiONTrackEvent | |
| controllerNumber | property |
controllerNumber:int [read-only] controller number of CONTROL_CHANGE, same as SiONTrackEvent's note
public function get controllerNumber():int| midiChannel | property |
midiChannel:MIDIModuleChannel [read-only] MIDI channel instance
public function get midiChannel():MIDIModuleChannel| midiChannelNumber | property |
midiChannelNumber:int [read-only] MIDI channel Number, same as SiON event trigger ID.
public function get midiChannelNumber():int| midiModule | property |
midiModule:MIDIModule [read-only] MIDI sound module to play
public function get midiModule():MIDIModule| value | property |
value:int [read-only] data(CONTROL_CHANGE), program number(PROGRAM_CHANGE), bendvalue(PITCH_BEND) or velocity(NOTE events).
public function get value():int| clone | () | method |
override public function clone():Eventclone.
ReturnsEvent |
| CONTROL_CHANGE | Constant |
public static const CONTROL_CHANGE:String = midiControlChangeDispatch when the control change command appears in MIDI data.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | false |
| driver | SiONDriver instance. |
| data | SiONDataConverterSMF instance. |
| streamBuffer | null |
| bufferIndex | Buffering index |
| eventTriggerID | MIDI channel Number |
| track | null |
| midiModule | MIDIModule instance to play |
| midiChannel | MIDIModuleChannel instance to play |
| midiChannelNumber | MIDI channel Number |
| note | same as controllerNumber prop. |
| value | data value for the controller |
| controllerNumber | Controller number |
| NOTE_OFF | Constant |
public static const NOTE_OFF:String = midiNoteOffDispatch when the note off appears in MIDI data.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | false |
| driver | SiONDriver instance. |
| data | SiONDataConverterSMF instance. |
| streamBuffer | null |
| bufferIndex | Buffering index |
| eventTriggerID | MIDI channel Number |
| track | SiMMLTrack instance to play |
| midiModule | MIDIModule instance to play |
| midiChannel | MIDIModuleChannel instance to play |
| midiChannelNumber | MIDI channel Number |
| note | Note number. |
| value | always 0. |
| controllerNumber | same as note prop. |
| NOTE_ON | Constant |
public static const NOTE_ON:String = midiNoteOnDispatch when the note on appears in MIDI data.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | false |
| driver | SiONDriver instance. |
| data | SiONDataConverterSMF instance. |
| streamBuffer | null |
| bufferIndex | Buffering index |
| eventTriggerID | MIDI channel Number |
| track | SiMMLTrack instance to play |
| midiModule | MIDIModule instance to play |
| midiChannel | MIDIModuleChannel instance to play |
| midiChannelNumber | MIDI channel Number |
| note | Note number. |
| value | velocity. |
| controllerNumber | same as note prop. |
| PITCH_BEND | Constant |
public static const PITCH_BEND:String = midiPitchBendDispatch when the pitch bend command appears in MIDI data.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | false |
| driver | SiONDriver instance. |
| data | SiONDataConverterSMF instance. |
| streamBuffer | null |
| bufferIndex | Buffering index |
| eventTriggerID | MIDI channel Number |
| track | null |
| midiModule | MIDIModule instance to play |
| midiChannel | MIDIModuleChannel instance to play |
| midiChannelNumber | MIDI channel Number |
| note | always 0 |
| value | bend value |
| controllerNumber | always 0 |
| PROGRAM_CHANGE | Constant |
public static const PROGRAM_CHANGE:String = midiProgramChangeDispatch when the program change command appears in MIDI data.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | false |
| driver | SiONDriver instance. |
| data | SiONDataConverterSMF instance. |
| streamBuffer | null |
| bufferIndex | Buffering index |
| eventTriggerID | MIDI channel Number |
| track | null |
| midiModule | MIDIModule instance to play |
| midiChannel | MIDIModuleChannel instance to play |
| midiChannelNumber | MIDI channel Number |
| note | always 0 |
| value | program number |
| controllerNumber | always 0 |