Sound Class Reference

The Sound class. More...

#include <Sound/Font.h>

List of all members.

Public Member Functions
void	Load (const char *file, bool useResourcePath=true)
	Loads the specified sound.
bool	IsPlaying ()
	Determines if the sound is currently playing.
void	Play ()
	Plays the currently loaded sound.
void	Stop ()
	Stops playing the sound.
void	SetVolume (byte newVol)
	Sets the volume of the music.
byte	GetVolume () const
	Gets the volume of the music.

---

Detailed Description

The Sound class.

A class loads and plays Sound effects. The following sound formats are supported:

1. WAV
2. MP2
3. MP3
4. OGG
5. RAW

---

Member Function Documentation

byte Sound::GetVolume

(

)

const

Gets the volume of the music.

Returns:

The new sound value between 0 (silent) and 255 (unnecessarily loud).

bool Sound::IsPlaying

(

)

Determines if the sound is currently playing.

Returns:

True if the sound is playing, false otherwise.

void Sound::Load	(	const char *	file,
		bool	useResourcePath = true
	)

Loads the specified sound.

Parameters:

[in]	file	the filename of the sound to load.
[in]	useResourcePath	set to true to use the currently set resource path. Defaults to true.

void Sound::SetVolume

(

byte

newVol

)

Sets the volume of the music.

Parameters:

[in]

newVol

the new volume between 0 (silent) and 255 (unnecessarily load).

---

The documentation for this class was generated from the following files:

• Sound.h
• Sound.cpp