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

Synthesizer source wave generator. More...

Inheritance diagram for SSWave:
SynthesizerSource

Public Member Functions

Constructors
SSWave new ()
 Create animator source. More...
 
Management
void setType (int type)
 Set wave type. More...
 
void setMinFrequency (float frequency)
 Set minimum frequency in Hz. More...
 
void setMaxFrequency (float frequency)
 Set maximum frequency in Hz. More...
 
void targetAddLink (int target, int link)
 Add link to target. More...
 
void targetRemoveAllLinks (int target)
 Remove all links from target. More...
 
- Public Member Functions inherited from SynthesizerSource
void setEnabled (bool enabled)
 Source is enabled. More...
 
void setMixMode (int mixMode)
 Set if source is enabled. More...
 
void setBlendFactor (float factor)
 Set mixing mode. More...
 
void setMinVolume (float volume)
 Set minimum volume relative to speaker volume in the range from 0 to 1. More...
 
void setMaxVolume (float volume)
 Set maximum volume relative to speaker volume in the range from 0 to 1. More...
 
void setMinPanning (float panning)
 Set minimum panning in the range from -1(left) to 1(right). More...
 
void setMaxPanning (float panning)
 Set maximum panning in the range from -1(left) to 1(right). More...
 
void addEffect (SynthesizerEffect effect)
 Add effect. More...
 
void removeAllEffects ()
 Remove all effects. More...
 

Static Public Attributes

Targets.
static final int TARGET_BLEND_FACTOR = 0
 Blend factor target. More...
 
static final int TARGET_VOLUME = 1
 Volume target. More...
 
static final int TARGET_PANNING = 2
 Panning target. More...
 
static final int TARGET_FREQUENCY = 3
 Frequency target. More...
 
Wave type.
static final int TYPE_SINE = 0
 Sine wave. More...
 
static final int TYPE_SQUARE = 1
 Square wave. More...
 
static final int TYPE_SAWTOOTH = 2
 Saw-tooth wave. More...
 
static final int TYPE_TRIANGLE = 3
 Triangle wave. More...
 
- Static Public Attributes inherited from SynthesizerSource
static final int BLEND = 0
 Blend sound output of this source over the previous sound. More...
 
static final int ADD = 1
 Add sound output to the previous sounds clipping if too loud. More...
 

Additional Inherited Members

- Protected Member Functions inherited from SynthesizerSource
SynthesizerSource new ()
 Create animator source. More...
 

Detailed Description

Synthesizer source wave generator.

This is a native class. It can not be subclassed.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ new()

SSWave new ( )

Create animator source.

§ setMaxFrequency()

void setMaxFrequency ( float  frequency)

Set maximum frequency in Hz.

§ setMinFrequency()

void setMinFrequency ( float  frequency)

Set minimum frequency in Hz.

§ setType()

void setType ( int  type)

Set wave type.

§ targetAddLink()

void targetAddLink ( int  target,
int  link 
)

Add link to target.

Exceptions
EInvalidParamtarget is not a valid value.

§ targetRemoveAllLinks()

void targetRemoveAllLinks ( int  target)

Remove all links from target.

Exceptions
EInvalidParamtarget is not a valid value.

Member Data Documentation

§ TARGET_BLEND_FACTOR

final int TARGET_BLEND_FACTOR = 0
static

Blend factor target.

§ TARGET_FREQUENCY

final int TARGET_FREQUENCY = 3
static

Frequency target.

§ TARGET_PANNING

final int TARGET_PANNING = 2
static

Panning target.

§ TARGET_VOLUME

final int TARGET_VOLUME = 1
static

Volume target.

§ TYPE_SAWTOOTH

final int TYPE_SAWTOOTH = 2
static

Saw-tooth wave.

§ TYPE_SINE

final int TYPE_SINE = 0
static

Sine wave.

§ TYPE_SQUARE

final int TYPE_SQUARE = 1
static

Square wave.

§ TYPE_TRIANGLE

final int TYPE_TRIANGLE = 3
static

Triangle wave.


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