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

Definition of wave source. More...

Inheritance diagram for SDSourceWave:
SDSource

Public Member Functions

SynthesizerSource buildSource (Synthesizer synthesizer)
 Build engine synthesizer source using the stored definition. More...
 
void debug (Console console)
 
float getMaxFrequency ()
 Maxium frequency. More...
 
float getMinFrequency ()
 Minium frequency. More...
 
int getType ()
 Wave type. More...
 
SDSourceWave new ()
 Create synthesizer source definition. More...
 
void setMaxFrequency (float frequency)
 Set maximum frequency. More...
 
void setMinFrequency (float frequency)
 Set minimum frequency. More...
 
void setType (int type)
 Set wave type. 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 wave 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)

§ getMaxFrequency()

float getMaxFrequency ( )

Maxium frequency.

§ getMinFrequency()

float getMinFrequency ( )

Minium frequency.

§ getType()

int getType ( )

Wave type.

§ new()

SDSourceWave new ( )

Create synthesizer source definition.

§ setMaxFrequency()

void setMaxFrequency ( float  frequency)

Set maximum frequency.

§ setMinFrequency()

void setMinFrequency ( float  frequency)

Set minimum frequency.

§ setType()

void setType ( int  type)

Set wave type.


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