SoundManager Class Reference

used for application wide sound settings and options (GUI Only) More...

Public Member Functions
	setMute (boolean muted)
	mutes all sounds from the game More...
	setVolume (number level)
	sets the overall volume level More...

Related Functions
(Note that these are not member functions.)
	getSoundManager
	get the singleton instance of the SoundManager used by the pdg framework More...
	snd
	the singleton instance of the SoundManager More...

Detailed Description

used for application wide sound settings and options (GUI Only)

used for application wide sound settings and options

Warning

API Stability: 1 - Experimental. This API was introduced recently and gotten little or no real use. It may change or be removed in future versions. It may not be completely implemented and may be missing important pieces of functionality. Please try it out and provide feedback.

Member Function Documentation

setMute

(

boolean

muted

)

mutes all sounds from the game

When muted, sounds will all play at volume level 0, including any new sounds, until un-muted, at which point the previous master volume and all individual sound volumes will be restored.

Parameters

muted

true to mute, false to unmute

Todo:

NOT IMPLEMENTED

setVolume

(

number

level

)

sets the overall volume level

Parameters

level

the desired level (0.0 - silent to 1.0 - full volume)

Sets the max volume level for all sounds. Individual sounds can still be played at separate volume levels, but they are scaled to be within the level set by the Sound Manager

Todo:

NOT IMPLEMENTED

Friends And Related Function Documentation

getSoundManager

related

get the singleton instance of the SoundManager used by the pdg framework

Returns

SoundManager singleton object