SeiON: Actionscript 3 Sound Engine | All Packages | All Classes | Index | Frames No Frames |
ISeionInstance

Package | com.SeiON.Core.Interface
Interface | public interface ISeionInstance extends ISeionControl, flash.events.IEventDispatcher
Implementors | SeionInstance

Additional playback features for SeionInstance and its derivatives.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | autodispose : Boolean [read-only] Whether this sound is auto-disposable. | ISeionInstance
|  | isPaused : Boolean [read-only] Is the playback paused? (ISeionControl) | ISeionControl
|  | isPlaying : Boolean [read-only] Is the sound active? (ISeionInstance) | ISeionInstance
|  | length : Number [read-only] The total length of the clip, excluding repeats. | ISeionInstance
|  | manager : SeionGroup [read-only] Returns the manager that holds this SeionInstance. | ISeionInstance
|  | name : String The name of the SeionInstance, non-unique. | ISeionInstance
|  | pan : Number Get: The panning as affected by its parent. | ISeionControl
|  | position : Number [read-only] How far into the clip we are. | ISeionInstance
|  | progress : Number [read-only] How far into the clip we are, from 0.0 to 1.0. | ISeionInstance
|  | repeat : int How many times the SeionInstance is programmed to repeat itself. | ISeionInstance
|  | repeatLeft : int [read-only] How many more times the SeionInstance has to repeat itself. | ISeionInstance
|  | soundtransform : SoundTransform [read-only] Returns the predefined sound properties of the sound. | ISeionInstance
|  | volume : Number Get: The volume as affected by its parent. | ISeionControl

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | dispose():void Clears all references held. | ISeionInstance
|  | isDisposed(output:Boolean = true):Boolean Is the SeionInstance already disposed of? (ISeionInstance) | ISeionInstance
|  | pause():void Pauses playback of sound. | ISeionControl
|  | play():void Plays the sound from the beginning again. | ISeionInstance
|  | resume():void Resumes playback of sound. | ISeionControl
|  | stop():void Stops the sound and resets it to Zero. | ISeionInstance

Property Detail

autodispose | property

`autodispose:Boolean` [read-only]

Whether this sound is auto-disposable. (ISeionInstance)

Implementation
`public function get autodispose():Boolean`

isPlaying | property |

`isPlaying:Boolean` [read-only]

Is the sound active? (ISeionInstance)

Implementation
`public function get isPlaying():Boolean`

length | property |

`length:Number` [read-only]

The total length of the clip, excluding repeats. In absolute terms. (ISeionInstance)

Implementation
`public function get length():Number`

manager | property |

`manager:SeionGroup` [read-only]

Returns the manager that holds this SeionInstance. (ISeionInstance)

Implementation
`public function get manager():SeionGroup`

name | property |

`name:String`

The name of the SeionInstance, non-unique. (ISeionInstance)

Implementation
`public function get name():String`
`public function set name(value:String):void`

position | property |

`position:Number` [read-only]

How far into the clip we are. In absolute terms. (ISeionInstance)

Implementation
`public function get position():Number`

progress | property |

`progress:Number` [read-only]

How far into the clip we are, from 0.0 to 1.0. (ISeionInstance)

Implementation
`public function get progress():Number`

repeat | property |

`repeat:int`

How many times the SeionInstance is programmed to repeat itself. 0 means no repeats. -1 means infinite repeats.

ISeionInstance
Implementation
`public function get repeat():int`
`public function set repeat(value:int):void`

repeatLeft | property |

`repeatLeft:int` [read-only]

How many more times the SeionInstance has to repeat itself. To reset repeatLeft, set repeat. 0 means no repeats. -1 means infinite repeats.

ISeionInstance
Implementation
`public function get repeatLeft():int`

soundtransform | property |

`soundtransform:SoundTransform` [read-only]

Returns the predefined sound properties of the sound. (ISeionInstance)

Implementation
`public function get soundtransform():SoundTransform`
Method Detail

dispose | () | method

`public function dispose():void`

Clears all references held. This object is now invalid. (ISeionInstance)

isDisposed | () | method |

`public function isDisposed(output:Boolean = true):Boolean`

Is the SeionInstance already disposed of? (ISeionInstance)

Parameters

| `output:Boolean` (default = `true`)`` — If true, a trace() message is given as well.

Returns

| `Boolean`

play | () | method |

`public function play():void`

Plays the sound from the beginning again. (ISeionInstance)

stop | () | method |

`public function stop():void`

Stops the sound and resets it to Zero. (ISeionInstance)

Tue Jun 21 2011, 10:05 PM +08:00