IzPlatformAudio Class Reference

#include <IzPlatformAudio.h>

Inheritance diagram for IzPlatformAudio:

List of all members.

Public Member Functions
bool	isInitialised () const
bool	isSoundOn () const
virtual void	setSoundOn (bool on)=0
bool	isMusicOn () const
virtual void	setMusicOn (bool on)=0
virtual int	Init ()=0
virtual void	Release ()=0
virtual void	Update ()=0
virtual bool	InitSound (void *memory_file, int memory_file_size, CzSoundData &sound_data, CzSoundSpec &sound_spec)=0
virtual CzSoundInst	PlaySound (unsigned int name_hash, CzScene *scene, float volume, float pitch, float pan, bool looped)=0
virtual CzSoundInst	PlaySound (CzSoundSpec sound_spec, float volume, float pitch, float pan, bool looped)=0
virtual void	StopSound (CzSoundInst sound_inst)=0
virtual void	PauseSound (CzSoundInst sound_inst)=0
virtual void	ResumeSound (CzSoundInst sound_inst)=0
virtual void	setSoundVolume (CzSoundInst sound_inst, float volume)=0
virtual void	setSoundPitch (CzSoundInst sound_inst, float pitch)=0
virtual void	setSoundPan (CzSoundInst sound_inst, float pan)=0
virtual void	StopAllSounds ()=0
virtual void	PauseAllSounds ()=0
virtual void	ResumeAllSounds ()=0
virtual bool	isSoundPlaying (CzSoundInst sound_inst) const =0
virtual bool	isMusicCodecSupported (eCzAudioCodec codec)=0
virtual void	setGlobalSoundVolume (float vol)=0
virtual void	setMusicVolume (float vol)=0
virtual bool	PlayMusic (const char *name, int repeat_count=0)=0
virtual bool	PlayMusic (void *buffer, uint32 buffer_length, uint32 repeat_count)=0
virtual void	StopMusic ()=0
virtual void	PauseMusic ()=0
virtual void	ResumeMusic ()=0
virtual bool	isMusicPlaying ()=0
virtual void	DeleteSoundData (CzSoundData data)=0
virtual void	DeleteSoundSpec (CzSoundSpec spec)=0
Protected Attributes
bool	Initialised
	Platform system initialised state.
bool	SoundOn
	Sound on flag (will not play sound effects if off)
bool	MusicOn
	Music flag (will not play music if off(.

---

Member Function Documentation

virtual void IzPlatformAudio::DeleteSoundData

(

CzSoundData

data

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::DeleteSoundSpec

(

CzSoundSpec

spec

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual int IzPlatformAudio::Init

(

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual bool IzPlatformAudio::InitSound	(	void *	memory_file,
		int	memory_file_size,
		CzSoundData &	sound_data,
		CzSoundSpec &	sound_spec
	)		[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

bool IzPlatformAudio::isInitialised

(

)

const [inline]

virtual bool IzPlatformAudio::isMusicCodecSupported

(

eCzAudioCodec

codec

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

bool IzPlatformAudio::isMusicOn

(

)

const [inline]

virtual bool IzPlatformAudio::isMusicPlaying

(

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

bool IzPlatformAudio::isSoundOn

(

)

const [inline]

virtual bool IzPlatformAudio::isSoundPlaying

(

CzSoundInst

sound_inst

)

const [pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::PauseAllSounds

(

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::PauseMusic

(

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::PauseSound

(

CzSoundInst

sound_inst

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual bool IzPlatformAudio::PlayMusic	(	const char *	name,
		int	repeat_count = 0
	)		[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual bool IzPlatformAudio::PlayMusic	(	void *	buffer,
		uint32	buffer_length,
		uint32	repeat_count
	)		[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual CzSoundInst IzPlatformAudio::PlaySound	(	unsigned int	name_hash,
		CzScene *	scene,
		float	volume,
		float	pitch,
		float	pan,
		bool	looped
	)		[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual CzSoundInst IzPlatformAudio::PlaySound	(	CzSoundSpec	sound_spec,
		float	volume,
		float	pitch,
		float	pan,
		bool	looped
	)		[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::Release

(

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::ResumeAllSounds

(

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::ResumeMusic

(

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::ResumeSound

(

CzSoundInst

sound_inst

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::setGlobalSoundVolume

(

float

vol

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::setMusicOn

(

bool

on

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::setMusicVolume

(

float

vol

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::setSoundOn

(

bool

on

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::setSoundPan	(	CzSoundInst	sound_inst,
		float	pan
	)		[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::setSoundPitch	(	CzSoundInst	sound_inst,
		float	pitch
	)		[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::setSoundVolume	(	CzSoundInst	sound_inst,
		float	volume
	)		[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::StopAllSounds

(

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::StopMusic

(

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::StopSound

(

CzSoundInst

sound_inst

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

virtual void IzPlatformAudio::Update

(

)

[pure virtual]

Implemented in CzPlatformAudio, and CzPlatformAudio.

---

Member Data Documentation

bool IzPlatformAudio::Initialised [protected]

Platform system initialised state.

bool IzPlatformAudio::MusicOn [protected]

Music flag (will not play music if off(.

bool IzPlatformAudio::SoundOn [protected]

Sound on flag (will not play sound effects if off)

---

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

• IzPlatformAudio.h