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

Synthesizer source chain. More...

Inheritance diagram for SSChain:
SynthesizerSource

Public Member Functions

Constructors
SSChain new ()
 Create animator source. More...
 
Management
int getSoundCount ()
 Number of sound files. More...
 
void addSound (Sound sound)
 Add sound. More...
 
void removeAllSounds ()
 Remove all sounds. More...
 
void setMinSpeed (float speed)
 Set minimum play speed. More...
 
void setMaxSpeed (float speed)
 Set maximum play speed. 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_SPEED = 3
 Speed target. More...
 
static final int TARGET_SELECT = 4
 Select target. More...
 
static final int TARGET_PLAY = 5
 Play state target (0-1 -> play, wait, pause, stop). 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 chain.

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

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ addSound()

void addSound ( Sound  sound)

Add sound.

§ getSoundCount()

int getSoundCount ( )

Number of sound files.

§ new()

SSChain new ( )

Create animator source.

§ removeAllSounds()

void removeAllSounds ( )

Remove all sounds.

§ setMaxSpeed()

void setMaxSpeed ( float  speed)

Set maximum play speed.

A value of 1 plays at orignal speed. A value of 2 would play double as fast. Negative values play backwards. A value of -1 would play backwards at original speed.

§ setMinSpeed()

void setMinSpeed ( float  speed)

Set minimum play speed.

A value of 1 plays at orignal speed. A value of 2 would play double as fast. Negative values play backwards. A value of -1 would play backwards at original speed.

§ 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_PANNING

final int TARGET_PANNING = 2
static

Panning target.

§ TARGET_PLAY

final int TARGET_PLAY = 5
static

Play state target (0-1 -> play, wait, pause, stop).

§ TARGET_SELECT

final int TARGET_SELECT = 4
static

Select target.

§ TARGET_SPEED

final int TARGET_SPEED = 3
static

Speed target.

§ TARGET_VOLUME

final int TARGET_VOLUME = 1
static

Volume target.


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