Packageartcustomer.maxima.engine
Classpublic class SFXEngine
InheritanceSFXEngine Inheritance AbstractCoreEngine Inheritance flash.events.EventDispatcher

SFXEngine



Protected Properties
 PropertyDefined By
 Inherited_injector : EngineObjectInjector
AbstractCoreEngine
Public Methods
 MethodDefined By
  
Constructor
SFXEngine
  
Add new channel at highest index.
SFXEngine
  
Remove all channels stored in the pool.
SFXEngine
  
destroy():void
[override] Destructor
SFXEngine
  
disposeChannelAt(index:int):Boolean
Remove channel at index.
SFXEngine
  
Get channel at index.
SFXEngine
  
[static] Instantiate SFXEngine.
SFXEngine
  
hasChannelAt(index:int):Boolean
Test channel at index.
SFXEngine
  
muteAll():void
Mute all channels.
SFXEngine
  
pauseChannel(index:int = 0):void
Pause channel.
SFXEngine
  
playSoundOnChannel(sound:Sound, index:int = 0, begin:int = 0, loops:int = 0):void
Play sound on channel.
SFXEngine
  
playStreamOnChannel(stream:String, index:int = 0, begin:int = 0, loops:int = 0):void
Play sound by stream on channel.
SFXEngine
  
resumeChannel(index:int = 0):void
Resume channel.
SFXEngine
  
setPan(pan:Number):void
Set pan on sound.
SFXEngine
  
setup():void
[override] Entry point.
SFXEngine
  
setVolume(volume:Number):void
Set volume on sound.
SFXEngine
  
stopChannel(index:int = 0):void
Stop channel.
SFXEngine
  
unMuteAll():void
Unmute all channels.
SFXEngine
Constructor Detail
SFXEngine()Constructor
public function SFXEngine()

Constructor

Method Detail
addChannel()method
public function addChannel():SingleChannel

Add new channel at highest index.

Returns
SingleChannel
clearChannelsPool()method 
public function clearChannelsPool():void

Remove all channels stored in the pool.

destroy()method 
override public function destroy():void

Destructor

disposeChannelAt()method 
public function disposeChannelAt(index:int):Boolean

Remove channel at index.

Parameters

index:int

Returns
Boolean
getChannelAt()method 
public function getChannelAt(index:int):SingleChannel

Get channel at index.

Parameters

index:int

Returns
SingleChannel
getInstance()method 
public static function getInstance():SFXEngine

Instantiate SFXEngine.

Returns
SFXEngine
hasChannelAt()method 
public function hasChannelAt(index:int):Boolean

Test channel at index.

Parameters

index:int

Returns
Boolean
muteAll()method 
public function muteAll():void

Mute all channels.

pauseChannel()method 
public function pauseChannel(index:int = 0):void

Pause channel.

Parameters

index:int (default = 0)

playSoundOnChannel()method 
public function playSoundOnChannel(sound:Sound, index:int = 0, begin:int = 0, loops:int = 0):void

Play sound on channel.

Parameters

sound:Sound
 
index:int (default = 0) — : 0 is the master channel.
 
begin:int (default = 0)
 
loops:int (default = 0)

playStreamOnChannel()method 
public function playStreamOnChannel(stream:String, index:int = 0, begin:int = 0, loops:int = 0):void

Play sound by stream on channel.

Parameters

stream:String
 
index:int (default = 0) — : 0 is the master channel.
 
begin:int (default = 0)
 
loops:int (default = 0)

resumeChannel()method 
public function resumeChannel(index:int = 0):void

Resume channel.

Parameters

index:int (default = 0)

setPan()method 
public function setPan(pan:Number):void

Set pan on sound.

Parameters

pan:Number

setup()method 
override public function setup():void

Entry point.

setVolume()method 
public function setVolume(volume:Number):void

Set volume on sound.

Parameters

volume:Number — : 0, volume, 1

stopChannel()method 
public function stopChannel(index:int = 0):void

Stop channel.

Parameters

index:int (default = 0)

unMuteAll()method 
public function unMuteAll():void

Unmute all channels.