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

Package | com.SeiON
Class | public final class SeionGroup
Inheritance | SeionGroup Object
Implements | ISeionControl

In charge of organising SeionClips, their playback and properties. On instantiation, the no. of sound channels that each SeionGroup is allowed is set individually.

Design Recommendation: SeionGroup is designed to be objects which stay long in memory. Try to create SeionGroups that encompasses large groups of sound and which represent a relevant sound category. Eg. background sounds category, menu sounds category and in-game dialog category.

See also

Seion

Public Properties

| Property | Defined By
--- | --- | ---
|  | availAllocation : uint [read-only] Discovers how many allocations are left available. | SeionGroup
|  | borrowedAllocation : uint [read-only] Discovers the no. | SeionGroup
|  | fullAllocation : uint [read-only] Discovers the total allocation that had been given to it. | SeionGroup
|  | isPaused : Boolean [read-only] Is the playback paused? (ISeionControl) | SeionGroup
|  | name : String Name of the SeionGroup. | SeionGroup
|  | pan : Number Get: The panning as affected by Seion (parent). | SeionGroup
|  | usedAllocation : uint [read-only] The total amount of used allocation slots, included assigned and borrowed. | SeionGroup
|  | volume : Number Get: The volume as affected by Seion (parent). | SeionGroup

Public Methods

| Method | Defined By
--- | --- | ---
|  | SeionGroup(name:String, availAmt:uint, secretKey:*) Please do not call this constructor directly; it will throw an error. | SeionGroup
|  | dispose():void Clears all references held. | SeionGroup
|  | killAllAutoSounds():void Kills all AUTO-DISPOSABLE sounds of this SeionGroup. | SeionGroup
|  | killAllSounds():void Kills all sounds of this SeionGroup. | SeionGroup
|  | pause():void Pauses playback of all sounds held. | SeionGroup
|  | resume():void Resumes playback of all sounds held. | SeionGroup

Property Detail

availAllocation | property

`availAllocation:uint` [read-only]

Discovers how many allocations are left available.

Implementation
`public function get availAllocation():uint`

borrowedAllocation | property |

`borrowedAllocation:uint` [read-only]

Discovers the no. of allocations borrowed from Seion.

Implementation
`public function get borrowedAllocation():uint`

fullAllocation | property |

`fullAllocation:uint` [read-only]

Discovers the total allocation that had been given to it.

Implementation
`public function get fullAllocation():uint`

isPaused | property |

`isPaused:Boolean` [read-only]

Is the playback paused? (ISeionControl)

Implementation
`public function get isPaused():Boolean`

name | property |

`public var name:String`

Name of the SeionGroup. Doesn't have to be unique.

pan | property |

`pan:Number`

Get: The panning as affected by Seion (parent).

Set: The personal adjustable panning unaffected by anything. ISeionControl
Implementation
`public function get pan():Number`
`public function set pan(value:Number):void`

usedAllocation | property |

`usedAllocation:uint` [read-only]

The total amount of used allocation slots, included assigned and borrowed.

Implementation
`public function get usedAllocation():uint`

volume | property |

`volume:Number`

Get: The volume as affected by Seion (parent).

Set: The personal adjustable volume unaffected by anything.

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

SeionGroup | () | Constructor

`public function SeionGroup(name:String, availAmt:uint, secretKey:*)`

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

Parameters

| `name:String` — The quota for the children this SeionGroup is allowed to have.
| `availAmt:uint` — Does nothing, just forces a reminder not to use constructor...
| `secretKey:*`

Throws

| `IllegalOperationError` — When you try to directly instantiate SeionGroup without using Seion.createSeionGroup().

See also

Seion.createSeionGroup()
Method Detail

alloc | () | method

`seion_ns function alloc(snd:ISeionInstance, autodispose:Boolean):Boolean`

Queries for additional allocation.

Parameters

| `snd:ISeionInstance`
| `autodispose:Boolean`

Returns

| `Boolean` — True if allocation is possible.

dispose | () | method |

`public function dispose():void`

Clears all references held. This object is now invalid.

killAllAutoSounds | () | method |

`public function killAllAutoSounds():void`

Kills all AUTO-DISPOSABLE sounds of this SeionGroup. Useful when you want to "clean the slate".

killAllSounds | () | method |

`public function killAllSounds():void`

Kills all sounds of this SeionGroup. Useful when you want to "clean the slate".

pause | () | method |

`public function pause():void`

Pauses playback of all sounds held. (ISeionControl)

resume | () | method |

`public function resume():void`

Resumes playback of all sounds held. (ISeionControl)

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