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

Synthesizer effect stretch time and pitch. More...

Inheritance diagram for SEStretch:
SynthesizerSource

Public Member Functions

Constructors
SEStretch new ()
 Create synthesizer effect. More...
 
Management
void setMinTime (float stretch)
 Set minimum time stretch. More...
 
void setMaxTime (float stretch)
 Set maximum time stretch. More...
 
void setMinPitch (float shift)
 Set minimum pitch shift. More...
 
void setMaxPitch (float shift)
 Set maximum pitch shift. 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_STRENGTH = 0
 Strength target. More...
 
static final int TARGET_TIME = 1
 Time stretch target. More...
 
static final int TARGET_PITCH = 2
 Pitch shift target. 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 effect stretch time and pitch.

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

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ new()

SEStretch new ( )

Create synthesizer effect.

§ setMaxPitch()

void setMaxPitch ( float  shift)

Set maximum pitch shift.

§ setMaxTime()

void setMaxTime ( float  stretch)

Set maximum time stretch.

§ setMinPitch()

void setMinPitch ( float  shift)

Set minimum pitch shift.

§ setMinTime()

void setMinTime ( float  stretch)

Set minimum time stretch.

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

final int TARGET_PITCH = 2
static

Pitch shift target.

§ TARGET_STRENGTH

final int TARGET_STRENGTH = 0
static

Strength target.

§ TARGET_TIME

final int TARGET_TIME = 1
static

Time stretch target.


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