SoundSample Class Reference

The SoundSample resource class. More...

#include <Sound/Font.h>

Inherits Resource<>.

List of all members.

Public Member Functions
virtual void	Destroy ()
	Destroys the resource.
virtual uint	GetDataUsageInBytes () const
	Estimates the number of bytes used by the loaded resource.
bool	IsPlaying (int channel)
	Determines if the sound is currently playing.
int	Play ()
	Plays the currently loaded sound.
void	Stop (int channel)
	Stops playing the sound.

---

Detailed Description

The SoundSample resource class.

A resource type that is used for loading and playing Sound effects. The following sound formats are supported:

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

---

Member Function Documentation

void SoundSample::Destroy

(

)

[virtual]

Destroys the resource.

Deallocates all data allocated when the resource was loaded. Must be implemented by all classes that inherit from the Resource class but should never be called outside of the ResourceMgr class.

Implements Resource<>.

bool SoundSample::IsPlaying

(

int

channel

)

Determines if the sound is currently playing.

Parameters:

[in]

channel

the channel handle returned by Play.

Returns:

True if the sound is playing, false otherwise.

int SoundSample::Play

(

)

Plays the currently loaded sound.

Returns:

an fmod splacific hanndle to the channel that the sound is being played on.

void SoundSample::Stop

(

int

channel

)

Stops playing the sound.

Parameters:

[in]

channel

the channel handle returned by Play.

---

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

• Sound.h
• Sound.cpp