deMicrophone Class Reference

Microphone Class. More...

#include <deMicrophone.h>

Inheritance diagram for deMicrophone:

List of all members.

Public Types
enum	eMicrophoneType { emtPoint, emtDirected }
Public Member Functions
Constructors and Destructors
	deMicrophone (deMicrophoneManager *manager)
	Creates a new speaker object.
virtual	~deMicrophone ()
	Cleans up the speaker object.
Management
deWorld *	GetParentWorld () const
	Retrieves the parent world.
void	SetParentWorld (deWorld *world)
	Sets the parent world.
int	GetType () const
	Retrieves the type of the speaker.
void	SetType (int type)
	Sets the type of the speaker.
const decDVector &	GetPosition () const
	Retrieves the position.
void	SetPosition (const decDVector &position)
	Sets the position.
const decQuaternion &	GetOrientation () const
	Retrieves the orientation.
void	SetOrientation (const decQuaternion &orientation)
	Sets the orientation.
const decVector &	GetVelocity () const
	Retrieves the linear velocity in m/s.
void	SetVelocity (const decVector &velocity)
	Sets the velocity in m/s.
bool	GetMuted () const
	Determines if the speaker is muted.
void	SetMuted (bool muted)
	Sets if the speaker is muted.
float	GetVolume () const
	Retrieves the volume.
void	SetVolume (float volume)
	Sets the volume.
Speakers Management
int	GetSpeakerCount () const
	Retrieves the count of speakers.
deSpeaker *	GetSpeakerAt (int index) const
	Retrieves the speaker at the given index.
int	IndexOfSpeaker (deSpeaker *speaker) const
	Retrieves the index of the given speaker of -1 if not found.
void	AddSpeaker (deSpeaker *speaker)
	Adds a speaker to the world.
void	RemoveSpeaker (deSpeaker *speaker)
	Removes the given speaker from the world.
void	RemoveAllSpeakers ()
	Removes all speakers from the world.
System Peers
deBaseAudioMicrophone *	GetAudioMicrophone () const
	Retrieves the audio system peer object.
void	SetAudioMicrophone (deBaseAudioMicrophone *audMicrophone)
	Sets the audio system peer object.

---

Detailed Description

Microphone Class.

Defines a microphone object able to record sounds in a world. The recorded sound is audible at the users speakers afterwards. Only one microphone can be active at any time. A microphone only records sound emitted by speakers in the same world. This way you can switch between microphones without the need for changing a lot of properties each time. Microphones can be of point type recording sound from all directions or directed to record only sound coming from a major direction.

Author:

Plüss Roland

Version:

1.0

Date:

2008

---

Member Enumeration Documentation

enum deMicrophone::eMicrophoneType

Enumerator:

emtPoint
emtDirected

---

Constructor & Destructor Documentation

deMicrophone::deMicrophone

(

deMicrophoneManager *

manager )

Creates a new speaker object.

virtual deMicrophone::~deMicrophone

(

)

[virtual]

Cleans up the speaker object.

---

Member Function Documentation

void deMicrophone::AddSpeaker

(

deSpeaker *

speaker )

Adds a speaker to the world.

deBaseAudioMicrophone* deMicrophone::GetAudioMicrophone

(

)

const [inline]

Retrieves the audio system peer object.

bool deMicrophone::GetMuted

(

)

const [inline]

Determines if the speaker is muted.

const decQuaternion& deMicrophone::GetOrientation

(

)

const [inline]

Retrieves the orientation.

deWorld* deMicrophone::GetParentWorld

(

)

const [inline]

Retrieves the parent world.

const decDVector& deMicrophone::GetPosition

(

)

const [inline]

Retrieves the position.

deSpeaker* deMicrophone::GetSpeakerAt

(

int

index )

const

Retrieves the speaker at the given index.

int deMicrophone::GetSpeakerCount

(

)

const [inline]

Retrieves the count of speakers.

int deMicrophone::GetType

(

)

const [inline]

Retrieves the type of the speaker.

const decVector& deMicrophone::GetVelocity

(

)

const [inline]

Retrieves the linear velocity in m/s.

float deMicrophone::GetVolume

(

)

const [inline]

Retrieves the volume.

int deMicrophone::IndexOfSpeaker

(

deSpeaker *

speaker )

const

Retrieves the index of the given speaker of -1 if not found.

void deMicrophone::RemoveAllSpeakers

(

)

Removes all speakers from the world.

void deMicrophone::RemoveSpeaker

(

deSpeaker *

speaker )

Removes the given speaker from the world.

void deMicrophone::SetAudioMicrophone

(

deBaseAudioMicrophone *

audMicrophone )

Sets the audio system peer object.

void deMicrophone::SetMuted

(

bool

muted )

Sets if the speaker is muted.

void deMicrophone::SetOrientation

(

const decQuaternion &

orientation )

Sets the orientation.

void deMicrophone::SetParentWorld

(

deWorld *

world )

Sets the parent world.

void deMicrophone::SetPosition

(

const decDVector &

position )

Sets the position.

void deMicrophone::SetType

(

int

type )

Sets the type of the speaker.

void deMicrophone::SetVelocity

(

const decVector &

velocity )

Sets the velocity in m/s.

void deMicrophone::SetVolume

(

float

volume )

Sets the volume.

---

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

• deMicrophone.h