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

Speaker. More...

Inheritance diagram for Speaker:

Public Member Functions

Constructors
Speaker new ()
 Create speaker. More...
 
Management
int getType ()
 Type. More...
 
void setType (int type)
 Set type. More...
 
Sound getSound ()
 Sound or null if not set. More...
 
void setSound (Sound sound)
 Set sound or null to not set. More...
 
SynthesizerInstance getSynthesizer ()
 Synthesizer or null if not set. More...
 
void setSynthesizer (SynthesizerInstance synthesizer)
 Set synthesizer or null to not set. More...
 
Synthesizer getSynthesizer ()
 Synthesizer or null if not set. More...
 
void setSynthesizer (Synthesizer synthesizer)
 Set synthesizer or null to not set. 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 ()
 Speaker is muted. More...
 
void setMuted (bool muted)
 Set if speaker is muted. More...
 
bool getLooping ()
 Sound is looping. More...
 
void setLooping (bool looping)
 Set if sound is looping. More...
 
float getPlaySpeed ()
 Play speed. More...
 
void setPlaySpeed (float playSpeed)
 Set play speed. More...
 
float getVolume ()
 Volume. More...
 
void setVolume (float volume)
 Set volume. More...
 
float getRange ()
 Range in meters beyond which the sound is inaudible. More...
 
void setRange (float range)
 Set range in meters beyond which the sound is inaudible. More...
 
float getHalfVolumeDistance ()
 Half volume distance relative to the range. More...
 
void setHalfVolumeDistance (float halfVolumeDistance)
 Set half volume distance relative to the range. More...
 
Playback
int getPlayFrom ()
 Start play position in samples. More...
 
int getPlayTo ()
 End play position in samples. More...
 
void setPlayPosition (int playFrom, int playTo)
 Set play position in samples. More...
 
bool getPlaying ()
 Speaker is playing. More...
 
bool getPaused ()
 Speaker is paused. More...
 
bool getStopped ()
 Speaker is stopped. More...
 
void play ()
 Start playing. More...
 
void stop ()
 Stop playing. More...
 
void pause ()
 Pause playing. More...
 

Static Public Attributes

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

Detailed Description

Speaker.

This is a native class.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ getHalfVolumeDistance()

float getHalfVolumeDistance ( )

Half volume distance relative to the range.

§ getLooping()

bool getLooping ( )

Sound is looping.

§ getMuted()

bool getMuted ( )

Speaker is muted.

§ getOrientation()

Quaternion getOrientation ( )

Orientation.

§ getPaused()

bool getPaused ( )

Speaker is paused.

§ getPlayFrom()

int getPlayFrom ( )

Start play position in samples.

§ getPlaying()

bool getPlaying ( )

Speaker is playing.

§ getPlaySpeed()

float getPlaySpeed ( )

Play speed.

§ getPlayTo()

int getPlayTo ( )

End play position in samples.

§ getPosition()

DVector getPosition ( )

Position.

§ getRange()

float getRange ( )

Range in meters beyond which the sound is inaudible.

§ getSound()

Sound getSound ( )

Sound or null if not set.

§ getStopped()

bool getStopped ( )

Speaker is stopped.

§ getSynthesizer() [1/2]

SynthesizerInstance getSynthesizer ( )

Synthesizer or null if not set.

§ getSynthesizer() [2/2]

Synthesizer getSynthesizer ( )

Synthesizer or null if not set.

§ getType()

int getType ( )

Type.

§ getVelocity()

Vector getVelocity ( )

Velocity in m/s.

§ getVolume()

float getVolume ( )

Volume.

§ new()

Speaker new ( )

Create speaker.

§ pause()

void pause ( )

Pause playing.

§ play()

void play ( )

Start playing.

§ setHalfVolumeDistance()

void setHalfVolumeDistance ( float  halfVolumeDistance)

Set half volume distance relative to the range.

§ setLooping()

void setLooping ( bool  looping)

Set if sound is looping.

§ setMuted()

void setMuted ( bool  muted)

Set if speaker is muted.

§ setOrientation()

void setOrientation ( Quaternion  orientation)

Set orientation.

§ setPlayPosition()

void setPlayPosition ( int  playFrom,
int  playTo 
)

Set play position in samples.

§ setPlaySpeed()

void setPlaySpeed ( float  playSpeed)

Set play speed.

§ setPosition()

void setPosition ( DVector  position)

Set position.

§ setRange()

void setRange ( float  range)

Set range in meters beyond which the sound is inaudible.

§ setSound()

void setSound ( Sound  sound)

Set sound or null to not set.

§ setSynthesizer() [1/2]

void setSynthesizer ( SynthesizerInstance  synthesizer)

Set synthesizer or null to not set.

§ setSynthesizer() [2/2]

void setSynthesizer ( Synthesizer  synthesizer)

Set synthesizer or null to not set.

§ setType()

void setType ( int  type)

Set type.

§ setVelocity()

void setVelocity ( Vector  velocity)

Set velocity in m/s.

§ setVolume()

void setVolume ( float  volume)

Set volume.

§ stop()

void stop ( )

Stop playing.

Member Data Documentation

§ DIRECTED

final int DIRECTED = 1
static

Directed speaker.

§ POINT

final int POINT = 0
static

Point speaker.


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