QSDK 1.1 Documentation

Q::Microphone Struct Reference
[Audio]

The listener in the scene. More...

#include <Q/q.h>

Inheritance diagram for Q::Microphone:

List of all members.

Public Types
enum	InputType {   simple,   head }
Public Member Functions
	Microphone ()
	Microphone (const char *name)
InputType	inputType () const
float	volume () const
AudioEffect	effectOverride () const
Utils::Result	setInputType (InputType)
void	setVolume (float)
Utils::Result	setEffectOverride (const AudioEffect &)
Static Public Member Functions
Microphone	create (const char *name, const Group &parent, const Database &db=Database())
Microphone	find (const char *name)
ClassType	classType ()
Microphone	cast (const ObjectBase &)

---

Detailed Description

The listener in the scene.

The Microphone object is a special kind of instance which defines a listening position within the scene graph. Since the microphone is not visible or audible in the scene, it has no associated geom.

---

Member Enumeration Documentation

enum Q::Microphone::InputType

This enumerated type is used to specify/query the type of microphone. The type can be either Simple, representing a single mono input source, or Head representing a human head shaped stereo input.

---

Constructor & Destructor Documentation

Q::Microphone::Microphone (   )  [inline]

Return a null microphone reference.

Q::Microphone::Microphone (  const char *  name  )

Search the currently attached databases for a microphone with the given name.

---

Member Function Documentation

Microphone Q::Microphone::cast (  const ObjectBase &   )  [static]

If the object referenced by obj is a microphone, then return a suitable Microphone reference to the object. Note: Casting this object will cause it to be loaded from the database if it is not currently resident. Reimplemented from Q::Instance.

ClassType Q::Microphone::classType (   )  [static]

Return the type for this class. Reimplemented from Q::Instance.

Microphone Q::Microphone::create (  const char *  name, const Group &  parent, const Database &  db = Database() )  [static]

Create a new microphone named name in the given database, db, (or the most recently attached read-write database if db is null). The microphone is created at location parent within the scene graph.

AudioEffect Q::Microphone::effectOverride (   )  const

Get the effect override for this microphone. The effect set on the microphone overrides the effect set on the environment of the zone the sound instances are in, if any. However, the effect of the microphone is overridden by the effect of the sound or the sound instance.

Microphone Q::Microphone::find (  const char *  name  )  [static]

Search the currently attached databases for a microphone with the given name and return that object, if it exists. Reimplemented from Q::Instance.

InputType Q::Microphone::inputType (   )  const

Return the type of microphone.

Utils::Result Q::Microphone::setEffectOverride (  const AudioEffect &   )

Set the effect override for this microphone. The effect set on the Microphone overrides the effect set on the Environment of the Zone that the SoundInstance objects are in, if any. However, the effect of the Microphone is overridden by the effect of the Sound or the SoundInstance.

Utils::Result Q::Microphone::setInputType (  InputType   )

Set the input type of microphone.

void Q::Microphone::setVolume (  float   )

Set the volume of the microphone, represented as an attenuation in decibels (dBFS). 0.0f and above is no attenuation. Note: To set the volume to be silence, use SpeakerSet::silenceVolume.

float Q::Microphone::volume (   )  const

Return the volume of the microphone, represented as an attenuation in decibels (dBFS). 0.0f and above is no attenuation.

		Qube Software Limited © 2000-2004