Packagecom.SeiON.Extras
Classpublic final class SeionExample
InheritanceSeionExample Inheritance SeionInstance Inheritance Object

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



Public Properties
 PropertyDefined By
 Inheritedautodispose : Boolean
[read-only] Whether this sound is auto-disposable.
SeionInstance
 InheritedisPaused : Boolean
[read-only]
SeionInstance
 InheritedisPlaying : Boolean
[read-only]
SeionInstance
 Inheritedlength : Number
[read-only]
SeionInstance
 Inheritedmanager : SeionGroup
[read-only] Returns the manager that holds this ISeionInstance.
SeionInstance
 Inheritedname : String
The name of the clip, non-unique.
SeionInstance
 Inheritedpan : Number
Get: The panning as affected by its parent.
SeionInstance
 Inheritedposition : Number
[read-only]
SeionInstance
 Inheritedprogress : Number
[read-only]
SeionInstance
 Inheritedrepeat : int
How many times the SeionInstance is programmed to repeat itself.
SeionInstance
 InheritedrepeatLeft : int
[read-only] How many more times the SeionInstance has to repeat itself.
SeionInstance
 Inheritedsoundtransform : SoundTransform
[read-only] Returns the predefined sound properties of the sound.
SeionInstance
 Inheritedvolume : Number
Get: The volume as affected by its parent.
SeionInstance
Public Methods
 MethodDefined By
  
SeionExample(secretKey:*)
Please do not call this constructor directly; it will throw an error.
SeionExample
 Inherited
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
 Inherited
dispatchEvent(event:Event):Boolean
SeionInstance
  
dispose():void
[override] Clears all references held.
SeionExample
 Inherited
hasEventListener(type:String):Boolean
SeionInstance
 Inherited
isDisposed(output:Boolean = true):Boolean
Is the SeionInstance already disposed of? (ISeionInstance)
SeionInstance
 Inherited
pause():void
SeionInstance
 Inherited
play():void
SeionInstance
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
SeionInstance
 Inherited
resume():void
SeionInstance
 Inherited
stop():void
SeionInstance
 Inherited
willTrigger(type:String):Boolean
SeionInstance
Events
 Event Summary Defined By
 InheritedDefines the value when a SeionInstance finishes playback and does not repeat.SeionInstance
 InheritedDefines 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

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)