asw::sound Namespace Reference

Functions
void	play (const asw::Sample &sample, float volume=1.0F, float pan=0.0F, bool loop=false)
	Play a sample.
void	playMusic (const asw::Music &sample, float volume=1.0F)
	Play a music sample.
void	stopMusic ()
	Stop the currently playing music.
void	fadeInMusic (const asw::Music &music, float volume, int durationMs)
	Fade in music over a duration.
void	fadeOutMusic (int durationMs)
	Fade out the currently playing music.
void	pauseMusic ()
	Pause the currently playing music.
void	resumeMusic ()
	Resume paused music.
bool	isMusicPlaying ()
	Check if music is currently playing.
bool	isMusicPaused ()
	Check if music is paused.
void	setMasterVolume (float volume)
	Set the master volume multiplier (affects all audio).
void	setSfxVolume (float volume)
	Set the SFX volume multiplier.
void	setMusicVolume (float volume)
	Set the music volume multiplier.
float	getMasterVolume ()
	Get the current master volume multiplier.
float	getSfxVolume ()
	Get the current SFX volume multiplier.
float	getMusicVolume ()
	Get the current music volume multiplier.

Function Documentation

fadeInMusic()

void asw::sound::fadeInMusic	(	const asw::Music &	music,
		float	volume,
		int	durationMs )

Fade in music over a duration.

Parameters

music	The music to play.
volume	Playback volume (0.0 - 1.0).
durationMs	Fade duration in milliseconds.

Definition at line 47 of file sound.cpp.

fadeOutMusic()

void asw::sound::fadeOutMusic

(

int

durationMs

)

Fade out the currently playing music.

Parameters

durationMs

Fade duration in milliseconds.

Definition at line 54 of file sound.cpp.

getMasterVolume()

float asw::sound::getMasterVolume

(

)

Get the current master volume multiplier.

Returns

The master volume (0.0 - 1.0).

Definition at line 86 of file sound.cpp.

getMusicVolume()

float asw::sound::getMusicVolume

(

)

Get the current music volume multiplier.

Returns

The music volume (0.0 - 1.0).

Definition at line 94 of file sound.cpp.

getSfxVolume()

float asw::sound::getSfxVolume

(

)

Get the current SFX volume multiplier.

Returns

The SFX volume (0.0 - 1.0).

Definition at line 90 of file sound.cpp.

isMusicPaused()

bool asw::sound::isMusicPaused

(

)

Check if music is paused.

Returns

True if music is paused.

Definition at line 70 of file sound.cpp.

isMusicPlaying()

bool asw::sound::isMusicPlaying

(

)

Check if music is currently playing.

Returns

True if music is playing.

Definition at line 66 of file sound.cpp.

pauseMusic()

void asw::sound::pauseMusic

(

)

Pause the currently playing music.

Definition at line 58 of file sound.cpp.

play()

void asw::sound::play	(	const asw::Sample &	sample,
		float	volume = 1.0F,
		float	pan = 0.0F,
		bool	loop = false )

Play a sample.

Parameters

sample	Sample to play
volume	Playback volume (0.0 - 1.0).
pan	Panning (-1.0 - 1.0), where -1.0 is full left, 0.0 is center, and 1.0 is full right.
loop	Whether to loop the sample (false = no loop, true = infinite loop).

Definition at line 23 of file sound.cpp.

playMusic()

void asw::sound::playMusic	(	const asw::Music &	sample,
		float	volume = 1.0F )

Play a music sample.

Parameters

sample	Sample to play
volume	Playback volume (0.0 - 1.0).

Definition at line 38 of file sound.cpp.

resumeMusic()

void asw::sound::resumeMusic

(

)

Resume paused music.

Definition at line 62 of file sound.cpp.

setMasterVolume()

void asw::sound::setMasterVolume

(

float

volume

)

Set the master volume multiplier (affects all audio).

Parameters

volume

Volume multiplier (0.0 - 1.0).

Definition at line 74 of file sound.cpp.

setMusicVolume()

void asw::sound::setMusicVolume

(

float

volume

)

Set the music volume multiplier.

Parameters

volume

Volume multiplier (0.0 - 1.0).

Definition at line 82 of file sound.cpp.

setSfxVolume()

void asw::sound::setSfxVolume

(

float

volume

)

Set the SFX volume multiplier.

Parameters

volume

Volume multiplier (0.0 - 1.0).

Definition at line 78 of file sound.cpp.

stopMusic()

void asw::sound::stopMusic

(

)

Stop the currently playing music.

Definition at line 43 of file sound.cpp.