iAudioSubSystem Class Reference

Audio interface with dummy implementation of silent mode. More...

#include <Audio.h>

List of all members.

Public Member Functions
	iAudioSubSystem ()
	Basic 'MUTE' soundsystem.
virtual	~iAudioSubSystem ()
virtual void	AfterConstruction ()
virtual iAudioSource *	Announce (const LString &FileName)
virtual iAudioSource *	Announce3D (iAudioSource *Source)
virtual iWaveform *	CreateWaveform () const
virtual iAudioSource *	CreateSourceFromFile (const LString &FileName) const
virtual iAudioSource *	CreateSource () const
virtual iAudioSource *	GetModule () const
virtual void	SetListenerPosition (const LVector3 &Position)
virtual void	SetListenerVelocity (const LVector3 &Velocity)
virtual void	SetListenerOrientation (const LVector3 &Forward, const LVector3 &Up)
virtual void	SetListenerVolume (float Volume)
virtual void	StopAll ()
virtual void	PauseAll ()
virtual void	ResumeAll ()
virtual void	ToggleAll ()
virtual bool	IsActive () const
virtual bool	IsInitialized () volatileconst
virtual int	GetBufferSize () const
	FWD_EVENT_HANDLER (Event_TIMER)
Protected Member Functions
virtual void	PlayModuleC (const LString &Param)
virtual void	StopModuleC (const LString &Param)
virtual void	ModuleVolumeC (const LString &Param)
virtual void	ModuleFadeOutC (const LString &Param)
virtual void	ModuleFadeInC (const LString &Param)
virtual void	AnnounceC (const LString &Param)
virtual void	StopAllC (const LString &Param)
Protected Attributes
clAnnouncersList	FAnnouncers
iAudioSource *	FModule
clCVar *	FModuleVolume
Private Types
typedef std::list< clAnnouncer * >	clAnnouncersList

---

Detailed Description

Audio interface with dummy implementation of silent mode.

---

Member Typedef Documentation

typedef std::list<clAnnouncer*> iAudioSubSystem::clAnnouncersList [private]

---

Constructor & Destructor Documentation

iAudioSubSystem::iAudioSubSystem

(

)

Basic 'MUTE' soundsystem.

iAudioSubSystem::~iAudioSubSystem

(

)

[virtual]

---

Member Function Documentation

void iAudioSubSystem::AfterConstruction

(

)

[virtual]

Reimplemented from iObject.

Reimplemented in clAudioSubSystem_FMOD, and clAudioSubSystem_OpenAL.

iAudioSource * iAudioSubSystem::Announce

(

const LString &

FileName

)

[virtual]

iAudioSource * iAudioSubSystem::Announce3D

(

iAudioSource *

Source

)

[virtual]

void iAudioSubSystem::AnnounceC

(

const LString &

Param

)

[protected, virtual]

iAudioSource * iAudioSubSystem::CreateSource

(

)

const [virtual]

Reimplemented in clAudioSubSystem_FMOD, and clAudioSubSystem_OpenAL.

iAudioSource * iAudioSubSystem::CreateSourceFromFile

(

const LString &

FileName

)

const [virtual]

Reimplemented in clAudioSubSystem_FMOD, and clAudioSubSystem_OpenAL.

iWaveform * iAudioSubSystem::CreateWaveform

(

)

const [virtual]

iAudioSubSystem::FWD_EVENT_HANDLER

(

Event_TIMER

)

virtual int iAudioSubSystem::GetBufferSize

(

)

const [inline, virtual]

Reimplemented in clAudioSubSystem_OpenAL.

virtual iAudioSource* iAudioSubSystem::GetModule

(

)

const [inline, virtual]

virtual bool iAudioSubSystem::IsActive

(

)

const [inline, virtual]

Reimplemented in clAudioSubSystem_OpenAL.

virtual bool iAudioSubSystem::IsInitialized

(

)

const volatile [inline, virtual]

Reimplemented in clAudioSubSystem_OpenAL.

void iAudioSubSystem::ModuleFadeInC

(

const LString &

Param

)

[protected, virtual]

void iAudioSubSystem::ModuleFadeOutC

(

const LString &

Param

)

[protected, virtual]

void iAudioSubSystem::ModuleVolumeC

(

const LString &

Param

)

[protected, virtual]

virtual void iAudioSubSystem::PauseAll

(

)

[inline, virtual]

Reimplemented in clAudioSubSystem_OpenAL.

void iAudioSubSystem::PlayModuleC

(

const LString &

Param

)

[protected, virtual]

virtual void iAudioSubSystem::ResumeAll

(

)

[inline, virtual]

Reimplemented in clAudioSubSystem_OpenAL.

virtual void iAudioSubSystem::SetListenerOrientation	(	const LVector3 &	Forward,
		const LVector3 &	Up
	)		[inline, virtual]

Reimplemented in clAudioSubSystem_OpenAL.

virtual void iAudioSubSystem::SetListenerPosition

(

const LVector3 &

Position

)

[inline, virtual]

Reimplemented in clAudioSubSystem_OpenAL.

virtual void iAudioSubSystem::SetListenerVelocity

(

const LVector3 &

Velocity

)

[inline, virtual]

Reimplemented in clAudioSubSystem_OpenAL.

virtual void iAudioSubSystem::SetListenerVolume

(

float

Volume

)

[inline, virtual]

Reimplemented in clAudioSubSystem_OpenAL.

virtual void iAudioSubSystem::StopAll

(

)

[inline, virtual]

Reimplemented in clAudioSubSystem_OpenAL.

virtual void iAudioSubSystem::StopAllC

(

const LString &

Param

)

[inline, protected, virtual]

Reimplemented in clAudioSubSystem_OpenAL.

void iAudioSubSystem::StopModuleC

(

const LString &

Param

)

[protected, virtual]

virtual void iAudioSubSystem::ToggleAll

(

)

[inline, virtual]

Reimplemented in clAudioSubSystem_OpenAL.

---

Member Data Documentation

clAnnouncersList iAudioSubSystem::FAnnouncers [protected]

iAudioSource* iAudioSubSystem::FModule [protected]

clCVar* iAudioSubSystem::FModuleVolume [protected]

---

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

• Audio.h
• Audio.cpp