hoa_audio::private_audio::SoundData Class Reference

An internal class used to manage sound data information. More...

#include <audio_sound.h>

Collaboration diagram for hoa_audio::private_audio::SoundData:

[legend]List of all members.

Public Member Functions
void	DEBUG_PrintProperties ()
	Displays the properties of the data to standard output.
bool	IsValid ()
	Returns true if the OpenAL buffer is valid.
void	RemoveReference ()
	Removes a single reference to this buffer. If the reference count becomes zero, the class object is destroyed.
	SoundData (std::string fname)
	~SoundData ()
Public Attributes
std::string	filename
	The filename of the audio data the buffer holds.
int8	reference_count
	The number of SoundDescriptors referring to this buffer.
Mix_Chunk *	sound
	A pointer to the chunk of sound data loaded in memory.

---

Detailed Description

An internal class used to manage sound data information.

***************************************************************************

This class manages information about sound data loaded into the application. Objects of this class are managed internally by the audio engine and are never referred to by the user.

Definition at line 39 of file audio_sound.h.

---

Constructor & Destructor Documentation

hoa_audio::private_audio::SoundData::SoundData

(

std::string

fname

)

hoa_audio::private_audio::SoundData::~SoundData

(

)

Definition at line 44 of file audio_sound.cpp.

References filename, reference_count, and sound.

---

Member Function Documentation

void hoa_audio::private_audio::SoundData::DEBUG_PrintProperties

(

)

Displays the properties of the data to standard output.

Definition at line 72 of file audio_sound.cpp.

References hoa_audio::GameAudio::_audio_errors, hoa_audio::AUDIO_ERROR_NO_DATA, hoa_audio::AudioManager, filename, IsValid(), and sound.

Referenced by hoa_audio::SoundDescriptor::DEBUG_DataProperties().

Here is the call graph for this function:

bool hoa_audio::private_audio::SoundData::IsValid

(

)

Returns true if the OpenAL buffer is valid.

Definition at line 64 of file audio_sound.cpp.

References reference_count, and sound.

Referenced by DEBUG_PrintProperties().

void hoa_audio::private_audio::SoundData::RemoveReference

(

)

Removes a single reference to this buffer. If the reference count becomes zero, the class object is destroyed.

Definition at line 55 of file audio_sound.cpp.

References reference_count.

Referenced by hoa_audio::SoundDescriptor::FreeSound(), and hoa_audio::SoundDescriptor::~SoundDescriptor().

---

Member Data Documentation

std::string hoa_audio::private_audio::SoundData::filename

The filename of the audio data the buffer holds.

Definition at line 45 of file audio_sound.h.

Referenced by DEBUG_PrintProperties(), hoa_audio::SoundDescriptor::GetFilename(), and ~SoundData().

int8 hoa_audio::private_audio::SoundData::reference_count

The number of SoundDescriptors referring to this buffer.

Definition at line 47 of file audio_sound.h.

Referenced by IsValid(), RemoveReference(), and ~SoundData().

Mix_Chunk* hoa_audio::private_audio::SoundData::sound

A pointer to the chunk of sound data loaded in memory.

Definition at line 49 of file audio_sound.h.

Referenced by DEBUG_PrintProperties(), hoa_audio::SoundDescriptor::GetSoundState(), IsValid(), hoa_audio::SoundDescriptor::PlaySound(), and ~SoundData().

---

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

• audio_sound.h
• audio_sound.cpp

---