Packagecom.SeiON
Classpublic final class Seion
InheritanceSeion Inheritance Object
Implements ISeionControl

Global sound control over whole of SeiON.
  1. Controls all sounds in the program.
  2. Tracks and rations sound allocation in the Flash Player.


Public Properties
 PropertyDefined By
  availAllocation : uint
[static] [read-only] Discovers how many allocations are left available.
Seion
  completeAllocation : uint
[static] [read-only] Discovers the total allocation for sounds in the Flash Player.
Seion
  isPaused : Boolean
[read-only] Is playback paused? (ISeionControl)
Seion
  pan : Number
The adjustable panning of playback (ISeionControl)
Seion
  volume : Number
The adjustable volume of playback (ISeionControl)
Seion
Public Methods
 MethodDefined By
  
Seion()
Seion is a static singleton, do not instantiate it!
Seion
  
createSeionGroup(name:String, allocatedAmt:uint):SeionGroup
[static] Allocates for a SeionGroup and keeps track of it internally.
Seion
  
pause():void
Pauses playback of all sounds.
Seion
  
resume():void
Resumes playback of all sounds.
Seion
  
statReport():String
[static] Gives a formatted text string showing the internal progress of SeiON.
Seion
Public Constants
 ConstantDefined By
  fullAllocation : uint = 32
[static] The complete available number of instances possible
Seion
  _this : Seion
[static] Static handler to itself
Seion
Property Detail
availAllocationproperty
availAllocation:uint  [read-only]

Discovers how many allocations are left available.


Implementation
    public static function get availAllocation():uint
completeAllocationproperty 
completeAllocation:uint  [read-only]

Discovers the total allocation for sounds in the Flash Player.


Implementation
    public static function get completeAllocation():uint
isPausedproperty 
isPaused:Boolean  [read-only]

Is playback paused? (ISeionControl)


Implementation
    public function get isPaused():Boolean
panproperty 
pan:Number

The adjustable panning of playback (ISeionControl)


Implementation
    public function get pan():Number
    public function set pan(value:Number):void
volumeproperty 
volume:Number

The adjustable volume of playback (ISeionControl)


Implementation
    public function get volume():Number
    public function set volume(value:Number):void
Constructor Detail
Seion()Constructor
public function Seion()

Seion is a static singleton, do not instantiate it!

Method Detail
createSeionGroup()method
public static function createSeionGroup(name:String, allocatedAmt:uint):SeionGroup

Allocates for a SeionGroup and keeps track of it internally.

Parameters

name:String — Name of the SeionGroup. Doesn't have to be unique; for your own convenience only.
 
allocatedAmt:uint — The number sound instances the SeionGroup is permitted. If there isn't enough allocation available in Seion, we will not create any SeionGroup at all.

Returns
SeionGroup — Returns null if we do not have that many allocations. NOTES: Drastic approach of not giving any SeionGroup at all is warranted, because SeionGroups are meant to be permanent long-term objects. We will not settle for less when creating such a long-term object.
pause()method 
public function pause():void

Pauses playback of all sounds. (ISeionControl)

resume()method 
public function resume():void

Resumes playback of all sounds. (ISeionControl)

statReport()method 
public static function statReport():String

Gives a formatted text string showing the internal progress of SeiON.

Returns
String
Constant Detail
_thisConstant
public static const _this:Seion

Static handler to itself

fullAllocationConstant 
public static const fullAllocation:uint = 32

The complete available number of instances possible





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