| Package | org.si.sion.events |
| Class | public class SiONTrackEvent |
| Inheritance | SiONTrackEvent  SiONEvent flash.events.Event |
| Subclasses | SiONMIDIEvent |
| Property | Defined By | ||
|---|---|---|---|
| bufferIndex : int [read-only] Buffering index. | SiONTrackEvent | ||
 | 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 | ||
| note : int [read-only] Note number. | SiONTrackEvent | ||
| streamBuffer : ByteArray [read-only] ByteArray of sound stream. | SiONEvent | |
| track : SiMMLTrack [read-only] Sequencer track instance. | SiONTrackEvent | ||
| Method | Defined By | ||
|---|---|---|---|
clone():Event [override] clone. | SiONTrackEvent | ||
| Constant | Defined By | ||
|---|---|---|---|
| BEAT : String = beat [static] Dispatch on beat while streaming. | SiONTrackEvent | ||
| CHANGE_BPM : String = changeBPM [static] Dispatch when the bpm changes. | SiONTrackEvent | ||
| 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_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_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 | ||
| 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 | ||
| bufferIndex | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesbufferIndex:int [read-only] Buffering index.
public function get bufferIndex():int| eventTriggerID | property |
eventTriggerID:int [read-only] Trigger ID.
public function get eventTriggerID():int| frameTriggerDelay | property |
frameTriggerDelay:Number [read-only] Delay time to dispatch frame trigger event [ms].
public function get frameTriggerDelay():Number| note | property |
note:int [read-only] Note number.
public function get note():int| track | property |
track:SiMMLTrack [read-only] Sequencer track instance.
public function get track():SiMMLTrack| clone | () | method |
override public function clone():Eventclone.
ReturnsEvent |
| BEAT | Constant |
public static const BEAT:String = beatDispatch on beat while streaming. This event is called in each beat timing on frame. When you want to listen this event, you have to set addEventListener() before SiONDriver.play().
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | false |
| driver | SiONDriver instance playing now. |
| data | SiONData instance playing now. This property is null if you call SiONDriver.play() with null of the 1st argument. |
| streamBuffer | null. |
| track | null |
| eventTriggerID | Counter in 16th beat. |
| note | 0 |
| bufferIndex | Buffering index |
| CHANGE_BPM | Constant |
public static const CHANGE_BPM:String = changeBPMDispatch when the bpm changes.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | false |
| driver | SiONDriver instance. |
| data | SiONData instance. This property is null if you call SiONDriver.play() with null of the 1st argument. |
| streamBuffer | null |
| track | null |
| eventTriggerID | null |
| note | 0 |
| bufferIndex | Buffering index |
| NOTE_OFF_FRAME | Constant |
public static const NOTE_OFF_FRAME:String = noteOffFrameDispatch when the sound ends.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | false |
| driver | SiONDriver instance. |
| data | SiONData instance. This property is null if you call SiONDriver.play() with null of the 1st argument. |
| streamBuffer | null |
| track | SiMMLTrack instance executing sequence. |
| eventTriggerID | Trigger ID specifyed in "%t" commands 1st argument. |
| note | Note number. |
| bufferIndex | Buffering index |
| NOTE_OFF_STREAM | Constant |
public static const NOTE_OFF_STREAM:String = noteOffStreamDispatch when the note off appears in the sequence with "%t" command.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | true; mute the note |
| driver | SiONDriver instance. |
| data | SiONData instance. This property is null if you call SiONDriver.play() with null of the 1st argument. |
| streamBuffer | null |
| track | SiMMLTrack instance executing sequence. |
| eventTriggerID | Trigger ID specifyed in "%t" commands 1st argument. |
| note | Note number. |
| bufferIndex | Buffering index |
| NOTE_ON_FRAME | Constant |
public static const NOTE_ON_FRAME:String = noteOnFrameDispatch when the sound starts.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | false |
| driver | SiONDriver instance. |
| data | SiONData instance. This property is null if you call SiONDriver.play() with null of the 1st argument. |
| streamBuffer | null |
| track | SiMMLTrack instance executing sequence. |
| eventTriggerID | Trigger ID specifyed in "%t" commands 1st argument. |
| note | Note number. |
| bufferIndex | Buffering index |
| NOTE_ON_STREAM | Constant |
public static const NOTE_ON_STREAM:String = noteOnStreamDispatch when the note on appears in the sequence with "%t" command.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | true; mute the note |
| driver | SiONDriver instance. |
| data | SiONData instance. This property is null if you call SiONDriver.play() with null of the 1st argument. |
| streamBuffer | null |
| track | SiMMLTrack instance executing sequence. |
| eventTriggerID | Trigger ID specifyed in "%t" commands 1st argument. |
| note | Note number. |
| bufferIndex | Buffering index |
| USER_DEFINED | Constant |
public static const USER_DEFINED:String = userDefinedDispatch when SiONDriver.dispatchUserDefinedTrackEvent() is called.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | false |
| driver | SiONDriver instance. |
| data | SiONData instance. This property is null if you call SiONDriver.play() with null of the 1st argument. |
| streamBuffer | null |
| track | null |
| eventTriggerID | 1st argument of SiONDriver.dispatchUserDefinedTrackEvent() |
| note | 2nd argument of SiONDriver.dispatchUserDefinedTrackEvent() |
| bufferIndex | Buffering index |