Drag[en]gine Script Module DragonScript Script API  1.0
Microphone Class Reference

Microphone. More...

Inheritance diagram for Microphone:

Public Member Functions

Constructors
Microphone new ()
 Create microphone. More...
 
Management
int getType ()
 Type. More...
 
void setType (int type)
 Set type. More...
 
DVector getPosition ()
 Position. More...
 
void setPosition (DVector position)
 Set position. More...
 
Quaternion getOrientation ()
 Orientation. More...
 
void setOrientation (Quaternion orientation)
 Set orientation. More...
 
Vector getVelocity ()
 Velocity in m/s. More...
 
void setVelocity (Vector velocity)
 Set velocity in m/s. More...
 
bool getMuted ()
 Microphone is muted. More...
 
void setMuted (bool muted)
 Set if microphone is muted. More...
 
float getVolume ()
 Volume. More...
 
void setVolume (float volume)
 Set volume. More...
 
Speakers
int getSpeakerCount ()
 Number of speakers. More...
 
Speaker getSpeakerAt (int index)
 Speaker at index. More...
 
void addSpeaker (Speaker speaker)
 Add speaker. More...
 
void removeSpeaker (Speaker speaker)
 Remove speaker. More...
 
void removeAllSpeakers ()
 Remove all speakers. More...
 

Static Public Attributes

Type constants
static final int POINT = 0
 Point microphone. More...
 
static final int DIRECTED = 1
 Directed microphone. More...
 

Detailed Description

Microphone.

This is a native class.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ addSpeaker()

void addSpeaker ( Speaker  speaker)

Add speaker.

§ getMuted()

bool getMuted ( )

Microphone is muted.

§ getOrientation()

Quaternion getOrientation ( )

Orientation.

§ getPosition()

DVector getPosition ( )

Position.

§ getSpeakerAt()

Speaker getSpeakerAt ( int  index)

Speaker at index.

Exceptions
EOutOfBoundatyindex is less than 0 or greater than or equal to getSpeakerCount().

§ getSpeakerCount()

int getSpeakerCount ( )

Number of speakers.

§ getType()

int getType ( )

Type.

§ getVelocity()

Vector getVelocity ( )

Velocity in m/s.

§ getVolume()

float getVolume ( )

Volume.

§ new()

Microphone new ( )

Create microphone.

§ removeAllSpeakers()

void removeAllSpeakers ( )

Remove all speakers.

§ removeSpeaker()

void removeSpeaker ( Speaker  speaker)

Remove speaker.

Exceptions
EInvalidParamspeaker is absent.

§ setMuted()

void setMuted ( bool  muted)

Set if microphone is muted.

§ setOrientation()

void setOrientation ( Quaternion  orientation)

Set orientation.

§ setPosition()

void setPosition ( DVector  position)

Set position.

§ setType()

void setType ( int  type)

Set type.

§ setVelocity()

void setVelocity ( Vector  velocity)

Set velocity in m/s.

§ setVolume()

void setVolume ( float  volume)

Set volume.

Member Data Documentation

§ DIRECTED

final int DIRECTED = 1
static

Directed microphone.

§ POINT

final int POINT = 0
static

Point microphone.


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