nge::audio::IAudioDevice Class Reference

#include <IAudioDevice.hpp>

Inheritance diagram for nge::audio::IAudioDevice:

List of all members.

Public Member Functions
virtual ISoundObj *	addSoundObjFromFile (const c8 *fileName, bool preload=false)=0
virtual ISoundObj *	addSoundObjFromMemory (void *memory, s32 sizeInBytes, const c8 *soundName, bool copyMemory=true)=0
virtual array< IPlayedSound * > &	getAllPlayedSounds ()
virtual array< ISoundObj * > &	getAllSoundObjs ()
virtual E_AUDIO_DEVICE	getAudioDeviceType ()=0
virtual f32	getDefault3DSoundMaxDistance ()=0
virtual f32	getDefault3DSoundMinDistance ()=0
virtual const char *	getDriverName ()=0
	Returns the name of the audio driver used by the device.
virtual ISoundObj *	getSoundObj (s32 index)=0
virtual ISoundObj *	getSoundObj (const c8 *soundName, bool addIfNotFound=true)=0
	Returns an ISoundObj interface for the requested sound.
virtual s32	getSoundObjCount ()=0
virtual f32	getSoundVolume ()=0
virtual const char *	getVersion ()=0
	Returns the version of the audio device.
virtual bool	isCurrentlyPlaying (ISoundObj *source)=0
virtual bool	isCurrentlyPlaying (const c8 *soundName)=0
virtual IPlayedSound *	play2D (ISoundObj *source, bool playLooped=false, bool startPaused=false, bool enableSoundEffects=false)=0
virtual IPlayedSound *	play2D (const c8 *soundFileName, bool playLooped=false, bool startPaused=false, bool enableSoundEffects=false)=0
virtual IPlayedSound *	play3D (ISoundObj *source, vector3df pos, bool playLooped=false, bool startPaused=false, bool enableSoundEffects=false)=0
virtual IPlayedSound *	play3D (const c8 *soundFileName, vector3df pos, bool playLooped=false, bool startPaused=false, bool enableSoundEffects=false)=0
virtual void	removeAllSoundObjs ()=0
virtual void	removeSoundObj (const c8 *name)=0
virtual void	removeSoundObj (ISoundObj *source)=0
virtual void	setAllSoundsPaused (bool bPaused=true)=0
	Pause all sounds.
virtual void	setDefault3DSoundMaxDistance (f32 maxDistance)=0
virtual void	setDefault3DSoundMinDistance (f32 minDistance)=0
virtual void	setListenerPosition (const vector3df &pos, const vector3df &lookdir, const vector3df &velPerSecond=vector3df(0, 0, 0), const vector3df &upVector=vector3df(0, 1, 0))=0
virtual void	setRolloffFactor (f32 rolloff)=0
virtual void	setSoundVolume (f32 volume)=0
virtual void	stopAllSounds ()=0
	Stop all playing sounds.
virtual void	update ()=0
virtual	~IAudioDevice ()
	Every derived class should call removeAllSoundObjs() in its destructor!!
Protected Attributes
array< IPlayedSound * >	m_aPlayedSounds
array< ISoundObj * >	m_aSoundObjs

---

Detailed Description

Definition at line 22 of file IAudioDevice.hpp.

---

Constructor & Destructor Documentation

virtual nge::audio::IAudioDevice::~IAudioDevice

(

)

[virtual]

Every derived class should call removeAllSoundObjs() in its destructor!!

---

Member Function Documentation

virtual ISoundObj* nge::audio::IAudioDevice::addSoundObjFromFile	(	const c8 *	fileName,
		bool	preload = false
	)			[pure virtual]

virtual ISoundObj* nge::audio::IAudioDevice::addSoundObjFromMemory	(	void *	memory,
		s32	sizeInBytes,
		const c8 *	soundName,
		bool	copyMemory = true
	)			[pure virtual]

virtual array<IPlayedSound*>& nge::audio::IAudioDevice::getAllPlayedSounds

(

)

[inline, virtual]

Definition at line 113 of file IAudioDevice.hpp.

References m_aPlayedSounds.

virtual array<ISoundObj*>& nge::audio::IAudioDevice::getAllSoundObjs

(

)

[inline, virtual]

Definition at line 118 of file IAudioDevice.hpp.

References m_aSoundObjs.

virtual E_AUDIO_DEVICE nge::audio::IAudioDevice::getAudioDeviceType

(

)

[pure virtual]

virtual f32 nge::audio::IAudioDevice::getDefault3DSoundMaxDistance

(

)

[pure virtual]

virtual f32 nge::audio::IAudioDevice::getDefault3DSoundMinDistance

(

)

[pure virtual]

virtual const char* nge::audio::IAudioDevice::getDriverName

(

)

[pure virtual]

Returns the name of the audio driver used by the device.

virtual ISoundObj* nge::audio::IAudioDevice::getSoundObj

(

s32

index

)

[pure virtual]

virtual ISoundObj* nge::audio::IAudioDevice::getSoundObj	(	const c8 *	soundName,
		bool	addIfNotFound = true
	)			[pure virtual]

Returns an ISoundObj interface for the requested sound.

virtual s32 nge::audio::IAudioDevice::getSoundObjCount

(

)

[pure virtual]

virtual f32 nge::audio::IAudioDevice::getSoundVolume

(

)

[pure virtual]

virtual const char* nge::audio::IAudioDevice::getVersion

(

)

[pure virtual]

Returns the version of the audio device.

virtual bool nge::audio::IAudioDevice::isCurrentlyPlaying

(

ISoundObj *

source

)

[pure virtual]

virtual bool nge::audio::IAudioDevice::isCurrentlyPlaying

(

const c8 *

soundName

)

[pure virtual]

virtual IPlayedSound* nge::audio::IAudioDevice::play2D	(	ISoundObj *	source,
		bool	playLooped = false,
		bool	startPaused = false,
		bool	enableSoundEffects = false
	)			[pure virtual]

The returned object must be dropped when no longer needed.

See also:

irr::IReferenceCounted::drop()

virtual IPlayedSound* nge::audio::IAudioDevice::play2D	(	const c8 *	soundFileName,
		bool	playLooped = false,
		bool	startPaused = false,
		bool	enableSoundEffects = false
	)			[pure virtual]

The returned object must be dropped when no longer needed.

See also:

irr::IReferenceCounted::drop()

virtual IPlayedSound* nge::audio::IAudioDevice::play3D	(	ISoundObj *	source,
		vector3df	pos,
		bool	playLooped = false,
		bool	startPaused = false,
		bool	enableSoundEffects = false
	)			[pure virtual]

The returned object must be dropped when no longer needed.

See also:

irr::IReferenceCounted::drop()

virtual IPlayedSound* nge::audio::IAudioDevice::play3D	(	const c8 *	soundFileName,
		vector3df	pos,
		bool	playLooped = false,
		bool	startPaused = false,
		bool	enableSoundEffects = false
	)			[pure virtual]

The returned object must be dropped when no longer needed.

See also:

irr::IReferenceCounted::drop()

virtual void nge::audio::IAudioDevice::removeAllSoundObjs

(

)

[pure virtual]

virtual void nge::audio::IAudioDevice::removeSoundObj

(

const c8 *

name

)

[pure virtual]

virtual void nge::audio::IAudioDevice::removeSoundObj

(

ISoundObj *

source

)

[pure virtual]

virtual void nge::audio::IAudioDevice::setAllSoundsPaused

(

bool

bPaused = true

)

[pure virtual]

Pause all sounds.

virtual void nge::audio::IAudioDevice::setDefault3DSoundMaxDistance

(

f32

maxDistance

)

[pure virtual]

virtual void nge::audio::IAudioDevice::setDefault3DSoundMinDistance

(

f32

minDistance

)

[pure virtual]

virtual void nge::audio::IAudioDevice::setListenerPosition	(	const vector3df &	pos,
		const vector3df &	lookdir,
		const vector3df &	velPerSecond = vector3df(0, 0, 0),
		const vector3df &	upVector = vector3df(0, 1, 0)
	)			[pure virtual]

virtual void nge::audio::IAudioDevice::setRolloffFactor

(

f32

rolloff

)

[pure virtual]

virtual void nge::audio::IAudioDevice::setSoundVolume

(

f32

volume

)

[pure virtual]

virtual void nge::audio::IAudioDevice::stopAllSounds

(

)

[pure virtual]

Stop all playing sounds.

virtual void nge::audio::IAudioDevice::update

(

)

[pure virtual]

---

Member Data Documentation

array<IPlayedSound*> nge::audio::IAudioDevice::m_aPlayedSounds [protected]

Definition at line 124 of file IAudioDevice.hpp.

Referenced by getAllPlayedSounds().

array<ISoundObj*> nge::audio::IAudioDevice::m_aSoundObjs [protected]

Definition at line 125 of file IAudioDevice.hpp.

Referenced by getAllSoundObjs().

---

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

• IAudioDevice.hpp