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

Definition of synthesizer source. More...

Inheritance diagram for SDSourceSound:
SDSource

Public Member Functions

SynthesizerSource buildSource (Synthesizer synthesizer)
 Build engine synthesizer source using the stored definition. More...
 
void debug (Console console)
 
bool getLooping ()
 Sound is played back looping. More...
 
float getMaxSpeed ()
 Maximum speed. More...
 
float getMinSpeed ()
 Minimum speed. More...
 
Sound getSound ()
 Sound. More...
 
SDSourceSound new ()
 Create synthesizer source definition. More...
 
void setLooping (bool looping)
 Set if sound is played back looping. More...
 
void setMaxSpeed (float speed)
 Set maximum speed. More...
 
void setMinSpeed (float speed)
 Set minimum speed. More...
 
void setSound (Sound sound)
 Set sound. More...
 
- Public Member Functions inherited from SDSource
void addEffect (SDEffect effect)
 Add effect. More...
 
void addTargetLink (SDSourceTargetLink targetLink)
 Add target link. More...
 
void debug (Console console)
 
void forEachEffect (Block ablock)
 Visit effects using a block. More...
 
void forEachTarget (Block ablock)
 Visit targets with a block. More...
 
float getBlendFactor ()
 Blend factor. More...
 
SDEffect getEffectAt (int index)
 Effect at index. More...
 
int getEffectCount ()
 Number of effects. More...
 
float getMaxPanning ()
 Maximum panning. More...
 
float getMaxVolume ()
 Maximum volume. More...
 
float getMinPanning ()
 Minimum panning. More...
 
float getMinVolume ()
 Minimum volume. More...
 
int getMixMode ()
 Mix mode. More...
 
String getName ()
 Name of source. More...
 
SDSourceTargetLink getTargetLinkAt (int index)
 Target link at index. More...
 
int getTargetLinkCount ()
 Number of target links. More...
 
SDSource new ()
 Create synthesizer source definition. More...
 
void removeAllEffects ()
 Remove all effects. More...
 
void removeEffect (SDEffect effect)
 Remove effect. More...
 
void setBlendFactor (float factor)
 Set blend factor. More...
 
void setEnabled (bool enabled)
 Set if source is enabled. More...
 
void setMaxPanning (float panning)
 Set maximum panning. More...
 
void setMaxVolume (float volume)
 Set maximum volume. More...
 
void setMinPanning (float panning)
 Set minimum panning. More...
 
void setMinVolume (float volume)
 Set minimum volume. More...
 
void setMixMode (int mode)
 Set mix mode. More...
 
void setName (String name)
 Set name of source. More...
 

Additional Inherited Members

- Protected Member Functions inherited from SDSource
String debugCommon (Console console, String type)
 

Detailed Description

Definition of synthesizer source.

Once defined a source can be added to an synthesizer using the stored definition.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ buildSource()

SynthesizerSource buildSource ( Synthesizer  synthesizer)

Build engine synthesizer source using the stored definition.

§ debug()

void debug ( Console  console)

§ getLooping()

bool getLooping ( )

Sound is played back looping.

§ getMaxSpeed()

float getMaxSpeed ( )

Maximum speed.

§ getMinSpeed()

float getMinSpeed ( )

Minimum speed.

§ getSound()

Sound getSound ( )

Sound.

§ new()

SDSourceSound new ( )

Create synthesizer source definition.

§ setLooping()

void setLooping ( bool  looping)

Set if sound is played back looping.

§ setMaxSpeed()

void setMaxSpeed ( float  speed)

Set maximum speed.

§ setMinSpeed()

void setMinSpeed ( float  speed)

Set minimum speed.

§ setSound()

void setSound ( Sound  sound)

Set sound.


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