Dragengine.Scenery.Microphone Class Reference

Microphone. More...

Inheritance diagram for Dragengine.Scenery.Microphone:

Public Member Functions
Constructors
Microphone	new ()
	Create microphone.
Management
MicrophoneType	getType ()
	Type.
void	setType (MicrophoneType type)
	Set type.
DVector	getPosition ()
	Position.
void	setPosition (DVector position)
	Set position.
Quaternion	getOrientation ()
	Orientation.
void	setOrientation (Quaternion orientation)
	Set orientation.
Vector	getVelocity ()
	Velocity in m/s.
void	setVelocity (Vector velocity)
	Set velocity in m/s.
bool	getMuted ()
	Microphone is muted.
void	setMuted (bool muted)
	Set if microphone is muted.
float	getVolume ()
	Volume.
void	setVolume (float volume)
	Set volume.
LayerMask	getLayerMask ()
	Layer mask for visibility masking.
void	setLayerMask (LayerMask layerMask)
	Set layer mask for visibility masking.
float	getSpeakerGain ()
	Gain to multiply all speakers with.
void	setSpeakerGain (float gain)
	Set gain to multiply all speakers with.
World	getParentWorld ()
	Parent world or null if not added to a world.
bool	getEnableAuralization ()
	Enable auralization if supported.
void	setEnableAuralization (bool enable)
	Set to enable auralization if supported.
Speakers
void	addSpeaker (Speaker speaker)
	Add speaker.
void	removeSpeaker (Speaker speaker)
	Remove speaker.
void	removeAllSpeakers ()
	Remove all speakers.

Detailed Description

Microphone.

This is a native class.

Member Function Documentation

addSpeaker()

void Dragengine.Scenery.Microphone.addSpeaker

(

Speaker

speaker

)

Add speaker.

getEnableAuralization()

bool Dragengine.Scenery.Microphone.getEnableAuralization

(

)

Enable auralization if supported.

Version

1.23

getLayerMask()

LayerMask Dragengine.Scenery.Microphone.getLayerMask

(

)

Layer mask for visibility masking.

getMuted()

bool Dragengine.Scenery.Microphone.getMuted

(

)

Microphone is muted.

getOrientation()

Quaternion Dragengine.Scenery.Microphone.getOrientation

(

)

Orientation.

getParentWorld()

World Dragengine.Scenery.Microphone.getParentWorld

(

)

Parent world or null if not added to a world.

getPosition()

DVector Dragengine.Scenery.Microphone.getPosition

(

)

Position.

getSpeakerGain()

float Dragengine.Scenery.Microphone.getSpeakerGain

(

)

Gain to multiply all speakers with.

Version

1.16

getType()

MicrophoneType Dragengine.Scenery.Microphone.getType

(

)

Type.

getVelocity()

Vector Dragengine.Scenery.Microphone.getVelocity

(

)

Velocity in m/s.

getVolume()

float Dragengine.Scenery.Microphone.getVolume

(

)

Volume.

new()

Microphone Dragengine.Scenery.Microphone.new

(

)

Create microphone.

removeAllSpeakers()

void Dragengine.Scenery.Microphone.removeAllSpeakers

(

)

Remove all speakers.

removeSpeaker()

void Dragengine.Scenery.Microphone.removeSpeaker

(

Speaker

speaker

)

Remove speaker.

Exceptions

EInvalidParam

speaker is absent.

setEnableAuralization()

void Dragengine.Scenery.Microphone.setEnableAuralization

(

bool

enable

)

Set to enable auralization if supported.

Version

1.23

setLayerMask()

void Dragengine.Scenery.Microphone.setLayerMask

(

LayerMask

layerMask

)

Set layer mask for visibility masking.

setMuted()

void Dragengine.Scenery.Microphone.setMuted

(

bool

muted

)

Set if microphone is muted.

setOrientation()

void Dragengine.Scenery.Microphone.setOrientation

(

Quaternion

orientation

)

Set orientation.

setPosition()

void Dragengine.Scenery.Microphone.setPosition

(

DVector

position

)

Set position.

setSpeakerGain()

void Dragengine.Scenery.Microphone.setSpeakerGain

(

float

gain

)

Set gain to multiply all speakers with.

Version

1.16

setType()

void Dragengine.Scenery.Microphone.setType

(

MicrophoneType

type

)

Set type.

setVelocity()

void Dragengine.Scenery.Microphone.setVelocity

(

Vector

velocity

)

Set velocity in m/s.

setVolume()

void Dragengine.Scenery.Microphone.setVolume

(

float

volume

)

Set volume.

---

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

• Microphone.ds