fsplayer.api.ISoundController Interface

The ISoundController Interface provides the following methods for sound control.

Methods

Method

Description

addListener(listener:ISoundListener):Void

Adds an external object implementing ISoundListener interface which will receive sound controller notifications

removeListener(listener:ISoundListener):Void

Removes the previously added listener. The passed object will stop receiving sound controller notifications

getVolume():Number

Returns current sound volume.
Note: sound volume is a number between 0 and 1

setVolume(volume:Number):Void

Sets sound volume.
Note: sound volume is a number between 0 and 1

tweak(parameterName:String, parameterValue:Object):Void

Tweaks the implementation specific parameter of the sound controller.
See the list of currently supported parameters in the Remarks section

getTweakableParameter(parameterName:String):Object

Returns the value of the implementation specific parameter.
See the list of currently supported parameters in the Remarks section

Remarks

Currently supported tweakable parameters are as follows:

Parameter name

Type

Default value

Description

blinkSounds

Boolean

true

Sound blinking is a sound shutdown for a short period of time (less than 1/100 of second) during slide switching.
This technique is used only when the slide containing an embedded Flash movie is changed by some other slide.
The reason for using this trick is that embedded Flash files can play sounds by their own and there is the only way to prevent possible sound issues.
Sometimes this feature can be undesirable and can be turned off by setting the blinkSound parameter to false

See also

IPlayer Interface
ISoundListener Interface
Flash Presentation ActionScript API Reference