CzSound Class Reference

CzSound - A sound effect. More...

#include <CzAudio.h>

Inheritance diagram for CzSound:

List of all members.

Public Types
enum	eState { State_Invalid, State_Loaded }
	Values that sound loaded states. More...
Public Member Functions
eState	getState () const
CzSoundSpec	getSoundSpec ()
	CzSound ()
virtual	~CzSound ()
bool	Init (void *memory_file, int memory_file_size)
void	Init (const char *filename)
bool	Load (bool blocking=true)
CzSoundInst	Play (float volume=1.0f, float pitch=1.0f, float pan=0, bool looped=false)
int	LoadFromXoml (IzXomlResource *parent, bool load_children, CzXmlNode *node)
void	FinishLoad ()
Protected Attributes
eState	State
	State of sound.
CzSoundInst	SoundInstance
	Sound instance.
CzSoundData	SoundData
	Sound data.
CzSoundSpec	SoundSpec
	Sound info.
CzFile *	File
	File object (if sound is file based)

---

Detailed Description

CzSound - A sound effect.

---

Member Enumeration Documentation

enum CzSound::eState

Values that sound loaded states.

Enumerator:

State_Invalid	Sound effect is invalid.
State_Loaded	Sound effect jas been loaded.

---

Constructor & Destructor Documentation

CzSound::CzSound

(

)

[inline]

CzSound::~CzSound

(

)

[virtual]

---

Member Function Documentation

void CzSound::FinishLoad

(

)

CzSoundSpec CzSound::getSoundSpec

(

)

[inline]

eState CzSound::getState

(

)

const [inline]

bool CzSound::Init	(	void *	memory_file,
		int	memory_file_size
	)

void CzSound::Init

(

const char *

filename

)

bool CzSound::Load

(

bool

blocking = true

)

int CzSound::LoadFromXoml	(	IzXomlResource *	parent,
		bool	load_children,
		CzXmlNode *	node
	)		[virtual]

Implements IzXomlResource.

CzSoundInst CzSound::Play	(	float	volume = 1.0f,
		float	pitch = 1.0f,
		float	pan = 0,
		bool	looped = false
	)

---

Member Data Documentation

CzFile* CzSound::File [protected]

File object (if sound is file based)

CzSoundData CzSound::SoundData [protected]

Sound data.

CzSoundInst CzSound::SoundInstance [protected]

Sound instance.

CzSoundSpec CzSound::SoundSpec [protected]

Sound info.

eState CzSound::State [protected]

State of sound.

---

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

• CzAudio.h
• CzAudio.cpp