sound::SoundAbstract Class Reference

Abstract Sound class (also used as a NOP class). More...

#include <src_sound_sound.hh>

Inheritance diagram for sound::SoundAbstract:

List of all members.

Public Types
enum	{ PLAY_ONCE = false, PLAY_LOOP = true }
Public Member Functions
CLASS_METHOD SoundAbstract &	GetInstance (void)
CLASS_METHOD void	Disable (void)
virtual bool	IfPlaying (const string &filename)
virtual bool	IfPlaying (const string &filename, const fp volume)
virtual bool	Play (const string &filename, const bool loop, const fp volume=DEFAULT_VOLUME)
virtual void	Stop (const string &filename)
virtual void	StopAll (void)
virtual void	SetVolume (const string &filename, const fp volume)
Protected Member Functions
	SoundAbstract (void)
virtual	~SoundAbstract (void)

---

Detailed Description

Abstract Sound class (also used as a NOP class).

Sounds are identified/keyed by filename.

Sound class: ------------ Sound class is a Facade over a sound libary. If sound library isn't available, Sound class will be compiled as NOPs.

Disabling Sound: ---------------- Sound can only be disabled at program startup (before Sound::GetInstance()). Once disabled, it stays disabled.

Changing volume of a sample: ---------------------------- Changing the volume of a sample should be considered a slow operation.

Anti-redundancy and tracking of playing: ---------------------------------------- Play() will become a NOP if redundantly passed the same args while it is still playing. So clients can rely on this Sound class to keep track of which samples are playing.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

PLAY_ONCE
PLAY_LOOP

---

Constructor & Destructor Documentation

sound::SoundAbstract::SoundAbstract

(

void

)

[inline, protected]

virtual sound::SoundAbstract::~SoundAbstract

(

void

)

[inline, protected, virtual]

---

Member Function Documentation

CLASS_METHOD SoundAbstract& sound::SoundAbstract::GetInstance

(

void

)

[inline]

Reimplemented in sound::SoundPlib.

CLASS_METHOD void sound::SoundAbstract::Disable

(

void

)

[inline]

Reimplemented in sound::SoundPlib.

virtual bool sound::SoundAbstract::IfPlaying

(

const string &

filename

)

[inline, virtual]

Reimplemented in sound::SoundPlib.

virtual bool sound::SoundAbstract::IfPlaying	(	const string &	filename,
		const fp	volume
	)			[inline, virtual]

Reimplemented in sound::SoundPlib.

virtual bool sound::SoundAbstract::Play	(	const string &	filename,
		const bool	loop,
		const fp	volume = DEFAULT_VOLUME
	)			[inline, virtual]

Reimplemented in sound::SoundPlib.

virtual void sound::SoundAbstract::Stop

(

const string &

filename

)

[inline, virtual]

Reimplemented in sound::SoundPlib.

virtual void sound::SoundAbstract::StopAll

(

void

)

[inline, virtual]

Reimplemented in sound::SoundPlib.

virtual void sound::SoundAbstract::SetVolume	(	const string &	filename,
		const fp	volume
	)			[inline, virtual]

Reimplemented in sound::SoundPlib.

---

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

• src_sound_sound.hh