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

Synthesizer producing dynamic sounds from sources. More...

Inheritance diagram for Synthesizer:

Public Member Functions

Constructors
Synthesizer new ()
 Create synthesizer. More...
 
Management
int getChannelCount ()
 Number of channels. More...
 
void setChannelCount (int channelCount)
 Set number of channels. More...
 
int getSampleRate ()
 Sample rate. More...
 
void setSampleRate (int sampleRate)
 Set sample rate. More...
 
int getBytesPerSample ()
 Bytes per sample. More...
 
void setBytesPerSample (int bytesPerSample)
 Set bytes per sample. 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...
 
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...
 
Links
int getLinkCount ()
 Number of links. More...
 
int addLink (int controller)
 Add link with controller and no mapping points. More...
 
void removeAllLinks ()
 Remove all links. More...
 
void linkSetController (int link, int controller)
 Set controller of link. More...
 
void linkSetRepeat (int link, int repeat)
 Set repeat count along X axis of link. More...
 
void linkSetCurve (int link, CurveBezier curve)
 Set curve of link. More...
 
Sources
int getSourceCount ()
 Number of sources. More...
 
void addSource (SynthesizerSource source)
 Add source. More...
 
SynthesizerSource getSourceAt (int index)
 Source at index. More...
 
void removeAllSources ()
 Remove all sources. More...
 

Detailed Description

Synthesizer producing dynamic sounds from sources.

Contains the definition for producing sounds. Use SynthesizerInstance for to actually produce sounds using individual parameters. Multiple synthesizer instances can share the same synthesizer.

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

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ addLink()

int addLink ( int  controller)

Add link with controller and no mapping points.

If the controller does not exist the link uses 0 as input value during calculations.

Returns
Index of added link.

§ addSource()

void addSource ( SynthesizerSource  source)

Add source.

§ 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().

§ 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().

§ getBytesPerSample()

int getBytesPerSample ( )

Bytes per sample.

§ getChannelCount()

int getChannelCount ( )

Number of channels.

§ getControllerCount()

int getControllerCount ( )

Nnumber of controllers.

§ getLinkCount()

int getLinkCount ( )

Number of links.

§ getSampleCount()

float getSampleCount ( )

Number of samples to create.

§ getSampleRate()

int getSampleRate ( )

Sample rate.

§ getSourceAt()

SynthesizerSource getSourceAt ( int  index)

Source at index.

Exceptions
EOutOfBoundaryindex is less than 0 or large than or equal to getSourceCount().

§ getSourceCount()

int getSourceCount ( )

Number of sources.

§ linkSetController()

void linkSetController ( int  link,
int  controller 
)

Set controller of link.

If the controller does not exist the link uses 0 as input value during calculations.

Exceptions
EOutOfBoundarylink is less than 0 or large than or equal to getLinkCount().

§ linkSetCurve()

void linkSetCurve ( int  link,
CurveBezier  curve 
)

Set curve of link.

Exceptions
EOutOfBoundarylink is less than 0 or large than or equal to getLinkCount().

§ linkSetRepeat()

void linkSetRepeat ( int  link,
int  repeat 
)

Set repeat count along X axis of link.

Exceptions
EInvalidParamrepeat is less than 1.

§ new()

Synthesizer new ( )

Create synthesizer.

§ removeAllLinks()

void removeAllLinks ( )

Remove all links.

§ removeAllSources()

void removeAllSources ( )

Remove all sources.

§ setBytesPerSample()

void setBytesPerSample ( int  bytesPerSample)

Set bytes per sample.

§ setChannelCount()

void setChannelCount ( int  channelCount)

Set number of channels.

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

§ setSampleRate()

void setSampleRate ( int  sampleRate)

Set sample rate.


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