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

Synthesizer instance producing source using a synthesizer. More...

Inheritance diagram for SynthesizerInstance:

Public Member Functions

Constructors
SynthesizerInstance new ()
 Create synthesizer instance. More...
 
Management
Synthesizer getSynthesizer ()
 synthesizer or null if not set. More...
 
void setSynthesizer (Synthesizer synthesizer)
 Set synthesizer or null if not set. More...
 
float getSampleCount ()
 Number of samples to create. More...
 
void setSampleCount (int sampleCount)
 Set number of samples to create. More...
 
Controllers
int getControllerCount ()
 Nnumber of controllers. More...
 
void setControllerCount (int count)
 Set number of controllers. More...
 
CurveBezier controllerGetCurve (int controller)
 Curve of controller. More...
 
void controllerSetCurve (int controller, CurveBezier curve)
 Set curve of controller. More...
 
void controllerSetCurveConstant (int controller, float value)
 Set curve of controller to a constant value. More...
 
void controllerSetCurveTime (int controller)
 Set curve of controller to linear curve along play time. More...
 
float controllerGetMinimum (int controller)
 Minimum limit of a controller. More...
 
float controllerGetMaximum (int controller)
 Maximum limit of a controller. More...
 
void controllerSetRange (int controller, float minValue, float maxValue)
 Set controller value range. More...
 
void controllerSetClamp (int controller, bool clamp)
 Set if controller value is clamped or wrapped around if outside range. More...
 

Detailed Description

Synthesizer instance producing source using a synthesizer.

Every synthesizer contains a set of sources and controllers indicating how the final sound is produced. While synthesizers define this production process the synthesizer instance produces the actual sound using per instance parameters.

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

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ controllerGetCurve()

CurveBezier controllerGetCurve ( int  controller)

Curve of controller.

Exceptions
EOutOfBoundarycontroller is less than 0 or large than or equal to getControllerCount().

§ controllerGetMaximum()

float controllerGetMaximum ( int  controller)

Maximum limit of a controller.

Exceptions
EOutOfBoundarycontroller is less than 0 or large than or equal to getControllerCount().

§ controllerGetMinimum()

float controllerGetMinimum ( int  controller)

Minimum limit of a controller.

Exceptions
EOutOfBoundarycontroller is less than 0 or large than or equal to getControllerCount().

§ controllerSetClamp()

void controllerSetClamp ( int  controller,
bool  clamp 
)

Set if controller value is clamped or wrapped around if outside range.

Exceptions
EOutOfBoundarycontroller is less than 0 or large than or equal to getControllerCount().

§ controllerSetCurve()

void controllerSetCurve ( int  controller,
CurveBezier  curve 
)

Set curve of controller.

Exceptions
EOutOfBoundarycontroller is less than 0 or large than or equal to getControllerCount().

§ controllerSetCurveConstant()

void controllerSetCurveConstant ( int  controller,
float  value 
)

Set curve of controller to a constant value.

Helper method to set curve to constant interpolation with point (0,value).

Exceptions
EOutOfBoundarycontroller is less than 0 or large than or equal to getControllerCount().

§ controllerSetCurveTime()

void controllerSetCurveTime ( int  controller)

Set curve of controller to linear curve along play time.

Helper method to set curve to linear curve from (0,minval) to (playtime,maxval).

Exceptions
EOutOfBoundarycontroller is less than 0 or large than or equal to getControllerCount().

§ controllerSetRange()

void controllerSetRange ( int  controller,
float  minValue,
float  maxValue 
)

Set controller value range.

Exceptions
EOutOfBoundarycontroller is less than 0 or large than or equal to getControllerCount().

§ getControllerCount()

int getControllerCount ( )

Nnumber of controllers.

§ getSampleCount()

float getSampleCount ( )

Number of samples to create.

§ getSynthesizer()

Synthesizer getSynthesizer ( )

synthesizer or null if not set.

§ new()

Create synthesizer instance.

§ setControllerCount()

void setControllerCount ( int  count)

Set number of controllers.

Exceptions
EInvalidParamcount is less than 0.

§ setSampleCount()

void setSampleCount ( int  sampleCount)

Set number of samples to create.

§ setSynthesizer()

void setSynthesizer ( Synthesizer  synthesizer)

Set synthesizer or null if not set.


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