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

Package | com.SeiON.Extras
Class | public final class SeionExample
Inheritance | SeionExample SeionInstance Object

An example class that demarcates how to create custom seion sound objects.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | autodispose : Boolean [read-only] Whether this sound is auto-disposable. | SeionInstance
|  | isPaused : Boolean [read-only] | SeionInstance
|  | isPlaying : Boolean [read-only] | SeionInstance
|  | length : Number [read-only] | SeionInstance
|  | manager : SeionGroup [read-only] Returns the manager that holds this ISeionInstance. | SeionInstance
|  | name : String The name of the clip, non-unique. | SeionInstance
|  | pan : Number Get: The panning as affected by its parent. | SeionInstance
|  | position : Number [read-only] | SeionInstance
|  | progress : Number [read-only] | SeionInstance
|  | repeat : int How many times the SeionInstance is programmed to repeat itself. | SeionInstance
|  | repeatLeft : int [read-only] How many more times the SeionInstance has to repeat itself. | SeionInstance
|  | soundtransform : SoundTransform [read-only] Returns the predefined sound properties of the sound. | SeionInstance
|  | volume : Number Get: The volume as affected by its parent. | SeionInstance

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | SeionExample(secretKey:*) Please do not call this constructor directly; it will throw an error. | SeionExample
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void | SeionInstance
|  | createExcerpt(name:String, manager:SeionGroup, snd:Sound, manyOfYourOwnParameters:*, repeat:int, autodispose:Boolean = true, sndTransform:SoundTransform = null):SeionExample [static] | SeionExample
|  | dispatchEvent(event:Event):Boolean | SeionInstance
|  | dispose():void [override] Clears all references held. | SeionExample
|  | hasEventListener(type:String):Boolean | SeionInstance
|  | isDisposed(output:Boolean = true):Boolean Is the SeionInstance already disposed of? (ISeionInstance) | SeionInstance
|  | pause():void | SeionInstance
|  | play():void | SeionInstance
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void | SeionInstance
|  | resume():void | SeionInstance
|  | stop():void | SeionInstance
|  | willTrigger(type:String):Boolean | SeionInstance

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | soundComplete | Defines the value when a SeionInstance finishes playback and does not repeat. | SeionInstance
|  | soundRepeat | Defines the value when a SeionInstance loops itself. | SeionInstance

Constructor Detail

SeionExample | () | Constructor

`public function SeionExample(secretKey:*)`

Please do not call this constructor directly; it will throw an error. Call it through SeionPitch.create().

Parameters

| `secretKey:*`

See also

SeionExample.create()
Method Detail

createExcerpt | () | method

`public static function createExcerpt(name:String, manager:SeionGroup, snd:Sound, manyOfYourOwnParameters:*, repeat:int, autodispose:Boolean = true, sndTransform:SoundTransform = null):SeionExample`

Parameters

| `name:String` — Any name, even a non-unique one.
| `manager:SeionGroup` — The SeionGroup that manages this SeionSample. Immutable.
| `snd:Sound` — The sound data. Immutable.
| `manyOfYourOwnParameters:*` — How many times to repeat the clip.
| `repeat:int` — Whether the clip will auto-mark for GC. Immutable.
| `autodispose:Boolean` (default = `true`)`` — The fixed internal property for the sound.
| `sndTransform:SoundTransform` (default = `null`)``

Returns

| `SeionExample` — A SeionExample if allocation was successful. Null if allocation failed, or autodispose is true.

See also

SeionInstance.name
SeionInstance.manager
SeionInstance.repeat
SeionInstance.autodispose
SeionInstance.soundTransform

dispose | () | method |

`override public function dispose():void`

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

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