com.bourre.media.sound.SoundInfo

	Property	Defined by
		DEBUG : Boolean = false	SoundInfo

	Property	Defined by
		_aChannel : TypedArray A list of `ChannelSoundInfo` that use this sound	SoundInfo
		_oEB : EventBroadcaster	SoundInfo
		_oSound : Sound The occurence of the sound for playing the sound	SoundInfo
		_oSTI : SoundTransformInfo the global setting for the id	SoundInfo
		TICKBEACON : TickBeacon [static] TickBeacon to manage the time to fire onSoundProgress event	SoundInfo

	Method	Defined by
		SoundInfo(oSound:Sound, oSTI:SoundTransformInfo = null)	SoundInfo
		addEventListener(type:String, listener:Object, ... rest):Boolean Event	SoundInfo
		addListener(listener:SoundInfoListener):Boolean	SoundInfo
		getChannel():TypedArray	SoundInfo
		getSound():Sound	SoundInfo
		getSoundTransformInfo():SoundTransformInfo	SoundInfo
		getState():String	SoundInfo
		isBuffering():Boolean	SoundInfo
		isPause():Boolean	SoundInfo
		isPlaying():Boolean	SoundInfo
		isRunning():Boolean	SoundInfo
		isStop():Boolean	SoundInfo
		onTick(e:Event = null):void	SoundInfo
		pauseSound():void	SoundInfo
		playSound(loop:Number = 1, soundTransformInfo:SoundTransformInfo = null):void	SoundInfo
		playSoundLoop():void	SoundInfo
		removeEventListener(type:String, listener:Object):Boolean	SoundInfo
		removeListener(listener:SoundInfoListener):Boolean	SoundInfo
		reset():void	SoundInfo
		resumeSound():void	SoundInfo
		run():void	SoundInfo
		setSoundTransform(o:SoundTransformInfo):void	SoundInfo
		setTickBeacon(beacon:TickBeacon):void [static]	SoundInfo
		start():void Implements Suspendable	SoundInfo
		stop():void	SoundInfo
		stopSound():void	SoundInfo

	Method	Defined by
		_onPlayLoopFinish(e:Event, channelSoundInfo:ChannelSoundInfo):void	SoundInfo
		_playLoopSound(channelSoundInfo:ChannelSoundInfo):void	SoundInfo
		addChannel(channelSoundInfo:ChannelSoundInfo):void	SoundInfo
		fireEvent(e:Event):void	SoundInfo
		fireSoundEvent(type:String, soundInfoChannel:SoundInfoChannel):void	SoundInfo
		getCurrentState():String Return state in force order : PLAY PAUSE STOP ( in decrease ) If we have three channel with at least one playing , it return SoundInfo.PLAY If no play channel but at least one pause , it return SoundInfo.PAUSE If no channel it return SoundInfo.STOP	SoundInfo
		initTickBeacon():void	SoundInfo
		resetChannel():void	SoundInfo

	Constant	Defined by
		PAUSE : String = "PAUSE" [static]	SoundInfo
		PLAY : String = "PLAY" [static]	SoundInfo
		STOP : String = "STOP" [static]	SoundInfo

Property detail

_aChannel

property

protected var _aChannel:TypedArray

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

A list of ChannelSoundInfo that use this sound

DEBUG

property

public var DEBUG:Boolean = false

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

_oEB

property

protected var _oEB:EventBroadcaster

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

_oSound

property

protected var _oSound:Sound

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

The occurence of the sound for playing the sound

_oSTI

property

protected var _oSTI:SoundTransformInfo

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

the global setting for the id

TICKBEACON

property

protected static var TICKBEACON:TickBeacon

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

TickBeacon to manage the time to fire onSoundProgress event

Constructor detail

SoundInfo

()

constructor

public function SoundInfo(oSound:Sound, oSTI:SoundTransformInfo = null)

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Parameters

	`oSound:Sound`

	`oSTI:SoundTransformInfo` (default = `null`)

Method detail

_onPlayLoopFinish

()

method

protected function _onPlayLoopFinish(e:Event, channelSoundInfo:ChannelSoundInfo):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Parameters

	`e:Event`

	`channelSoundInfo:ChannelSoundInfo`

_playLoopSound

()

method

protected function _playLoopSound(channelSoundInfo:ChannelSoundInfo):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Parameters

channelSoundInfo:ChannelSoundInfo

addChannel

()

method

protected function addChannel(channelSoundInfo:ChannelSoundInfo):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Parameters

channelSoundInfo:ChannelSoundInfo

addEventListener

()

method

public function addEventListener(type:String, listener:Object, ... rest):Boolean

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Event

Parameters

	`type:String`

	`listener:Object`

	`... rest`

Returns

Boolean

addListener

()

method

public function addListener(listener:SoundInfoListener):Boolean

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Parameters

listener:SoundInfoListener

Returns

Boolean

fireEvent

()

method

protected function fireEvent(e:Event):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Parameters

e:Event

fireSoundEvent

()

method

protected function fireSoundEvent(type:String, soundInfoChannel:SoundInfoChannel):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Parameters

	`type:String`

	`soundInfoChannel:SoundInfoChannel`

getChannel

()

method

public function getChannel():TypedArray

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns

TypedArray

getCurrentState

()

method

protected function getCurrentState():String

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Return state in force order : PLAY PAUSE STOP ( in decrease ) If we have three channel with at least one playing , it return SoundInfo.PLAY If no play channel but at least one pause , it return SoundInfo.PAUSE If no channel it return SoundInfo.STOP

Returns

String

getSound

()

method

public function getSound():Sound

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns

Sound

getSoundTransformInfo

()

method

public function getSoundTransformInfo():SoundTransformInfo

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns

SoundTransformInfo

getState

()

method

public function getState():String

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns

String

initTickBeacon

()

method

protected function initTickBeacon():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

isBuffering

()

method

public function isBuffering():Boolean

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns

Boolean

isPause

()

method

public function isPause():Boolean

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns

Boolean

isPlaying

()

method

public function isPlaying():Boolean

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns

Boolean

isRunning

()

method

public function isRunning():Boolean

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns

Boolean

isStop

()

method

public function isStop():Boolean

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns

Boolean

onTick

()

method

public function onTick(e:Event = null):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Parameters

e:Event (default = null)

pauseSound

()

method

public function pauseSound():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

playSound

()

method

public function playSound(loop:Number = 1, soundTransformInfo:SoundTransformInfo = null):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Parameters

	`loop:Number` (default = `1`)

	`soundTransformInfo:SoundTransformInfo` (default = `null`)

playSoundLoop

()

method

public function playSoundLoop():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

removeEventListener

()

method

public function removeEventListener(type:String, listener:Object):Boolean

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Parameters

	`type:String`

	`listener:Object`

Returns

Boolean

removeListener

()

method

public function removeListener(listener:SoundInfoListener):Boolean

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Parameters

listener:SoundInfoListener

Returns

Boolean

reset

()

method

public function reset():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

resetChannel

()

method

protected function resetChannel():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

resumeSound

()

method

public function resumeSound():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

run

()

method

public function run():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

setSoundTransform

()

method

public function setSoundTransform(o:SoundTransformInfo):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Parameters

o:SoundTransformInfo

setTickBeacon

()

method

public static function setTickBeacon(beacon:TickBeacon):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Parameters

beacon:TickBeacon

start

()

method

public function start():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Implements Suspendable

stop

()

method

public function stop():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

stopSound

()

method

public function stopSound():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Constant detail

PAUSE

constant

public static const PAUSE:String = "PAUSE"

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

PLAY

constant

public static const PLAY:String = "PLAY"

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

STOP

constant

public static const STOP:String = "STOP"

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Submit Feedback

LowRA API documentation 2008- 2009
Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1
mer. févr. 25 2009, 9:22 AM GMT+01:00

LowRA API Documentation	Annexes \| All Packages \| All Classes \| Index \| Frames No Frames
Class SoundInfo	Properties \| Methods \| Constants

Package	com.bourre.media.sound
Class	public class SoundInfo
Implements	Suspendable, TickListener