| Package | org.si.sion.events |
| Class | public class SiONEvent |
| Inheritance | SiONEvent  flash.events.Event |
| Subclasses | SiONTrackEvent |
| Property | Defined By | ||
|---|---|---|---|
| data : SiONData [read-only] Sound data. | SiONEvent | ||
| driver : SiONDriver [read-only] Sound driver. | SiONEvent | ||
| streamBuffer : ByteArray [read-only] ByteArray of sound stream. | SiONEvent | ||
| Method | Defined By | ||
|---|---|---|---|
SiONEvent(type:String, driver:SiONDriver, streamBuffer:ByteArray = null, cancelable:Boolean = false) Creates an SiONEvent object to pass as a parameter to event listeners. | SiONEvent | ||
clone():Event [override] clone. | SiONEvent | ||
| Constant | Defined By | ||
|---|---|---|---|
| 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 | ||
| 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 | ||
| data | property |
| driver | property |
| streamBuffer | property |
streamBuffer:ByteArray [read-only] ByteArray of sound stream. This is available only in STREAM event.
public function get streamBuffer():ByteArray| SiONEvent | () | Constructor |
public function SiONEvent(type:String, driver:SiONDriver, streamBuffer:ByteArray = null, cancelable:Boolean = false)Creates an SiONEvent object to pass as a parameter to event listeners.
Parameterstype:String | |
driver:SiONDriver | |
streamBuffer:ByteArray (default = null) | |
cancelable:Boolean (default = false) |
| clone | () | method |
override public function clone():Eventclone.
ReturnsEvent |
| FADE_IN_COMPLETE | Constant |
public static const FADE_IN_COMPLETE:String = fadeInCompleteDispatch when fade in is finished. This event is dispatched after SiONEvent.STREAM.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | false |
| driver | SiONDriver instance to stop streaming. |
| data | SiONData instance playing now. This property is null if you call SiONDriver.play() with null of the 1st argument. |
| streamBuffer | ByteArray instance of this stream. The length is twice of SiONDriver.bufferLength in the unit of float. You can get the renderd wave data by this propertiy. |
| FADE_OUT_COMPLETE | Constant |
public static const FADE_OUT_COMPLETE:String = fadeOutCompleteDispatch when fade out is finished. This event is dispatched after SiONEvent.STREAM.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | false |
| driver | SiONDriver instance to stop streaming. |
| data | SiONData instance playing now. This property is null if you call SiONDriver.play() with null of the 1st argument. |
| streamBuffer | ByteArray instance of this stream. The length is twice of SiONDriver.bufferLength in the unit of float. You can get the renderd wave data by this propertiy. |
| FADE_PROGRESS | Constant |
public static const FADE_PROGRESS:String = fadeProgressDispatch while fading. This event is dispatched after SiONEvent.STREAM.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | true to cancel fading. |
| driver | SiONDriver instance to stop streaming. |
| data | SiONData instance playing now. This property is null if you call SiONDriver.play() with null of the 1st argument. |
| streamBuffer | null |
| FINISH_SEQUENCE | Constant |
public static const FINISH_SEQUENCE:String = finishSequenceDispatch when finish executing all sequences.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | false |
| driver | SiONDriver instance playing now. |
| data | SiONData instance playing now. |
| streamBuffer | null |
| QUEUE_CANCEL | Constant |
public static const QUEUE_CANCEL:String = queueCancelDispatch when cancel all queued jobs.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | false |
| driver | SiONDriver instance compiled/rendered. |
| driver.mmlString | null |
| data | null |
| streamBuffer | null |
| QUEUE_COMPLETE | Constant |
public static const QUEUE_COMPLETE:String = queueCompleteDispatch when finish all queued jobs.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | false |
| driver | SiONDriver instance compiled/rendered. |
| driver.mmlString | MML string compiled. null when the job is "render". |
| data | SiONData instance compiled/rendered. |
| streamBuffer | null |
| QUEUE_PROGRESS | Constant |
public static const QUEUE_PROGRESS:String = queueProgressDispatch when executing queued jobs.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | true; Cancel compiling/rendering immediately. |
| driver | SiONDriver instance compiling/rendering compiling now. |
| driver.mmlString | MML string compiling now. null when the job is "render". |
| data | SiONData instance compiling/rendering now. This data is not available when compiling. |
| streamBuffer | null |
| STREAM | Constant |
public static const STREAM:String = streamDispatch while streaming. This event is called inside SiONDriver.play() after SiONEvent.STREAM_START, and each streaming timing.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | true; Stop streaming. SiONDriver.stop() s called inside |
| 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 | ByteArray instance of this stream. The length is twice of SiONDriver.bufferLength in the unit of float. You can get the renderd wave data by this propertiy. |
| STREAM_START | Constant |
public static const STREAM_START:String = streamStartDispatch when start streaming. This event is called inside SiONDriver.play() before SiONEvent.STREAM.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | true; Cancel to start streaming. |
| driver | SiONDriver instance to start streaming. |
| data | SiONData instance to start streaming. This property is null if you call SiONDriver.play() with null of the 1st argument. |
| streamBuffer | null |
| STREAM_STOP | Constant |
public static const STREAM_STOP:String = streamStopDispatch when stop streaming. This event is dispatched inside SiONDriver.stop().
The properties of the event object have the following values:
| Property | Value |
|---|---|
| cancelable | false |
| driver | SiONDriver instance to stop streaming. |
| data | SiONData instance to stop streaming. This property is null if you call SiONDriver.play() with null of the 1st argument. |
| streamBuffer | null |