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

Definition of a synthesizer. More...

Inheritance diagram for SynthesizerDefinition:

Public Member Functions

void addController (SDController controller)
 Add controller. More...
 
void addLink (SDLink link)
 Add link. More...
 
void addSource (SDSource source)
 Add source. More...
 
void buildSynthesizer (Synthesizer synthesizer)
 Build synthesizer. More...
 
void debug (Console console)
 
int getBytesPerSample ()
 Bytes per sample. More...
 
int getChannelCount ()
 Channel count. More...
 
SDController getControllerAt (int position)
 Controller at position. More...
 
int getControllerCount ()
 Number of controllers. More...
 
SDLink getLinkAt (int position)
 Link at position. More...
 
int getLinkCount ()
 Number of links. More...
 
String getPathDirectory ()
 Path to directory the synthesizer file is located in. More...
 
String getPathFile ()
 Path the synthesizer has been loaded from. More...
 
int getSampleCount ()
 Number of samples to create. More...
 
int getSampleRate ()
 Sample rate. More...
 
SDSource getSourceAt (int position)
 Source at position. More...
 
int getSourceCount ()
 Number of sources. More...
 
SynthesizerDefinition new (String pathFile)
 Create synthesizer definition. More...
 
void setBytesPerSample (int bytesPerSample)
 Set bytes per sample. More...
 
void setChannelCount (int channelCount)
 Set channel count. More...
 
void setSampleCount (int sampleCount)
 Set number of samples to create. More...
 
void setSampleRate (int sampleRate)
 Set sample rate. More...
 

Detailed Description

Definition of a synthesizer.

Once defined a synthesizer can be updated using the stored definition. Avoids storing real synthesizers as often multiple synthesizer definitions have to be loaded at the beginning of a gaming session.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ addController()

void addController ( SDController  controller)

Add controller.

§ addLink()

void addLink ( SDLink  link)

Add link.

§ addSource()

void addSource ( SDSource  source)

Add source.

§ buildSynthesizer()

void buildSynthesizer ( Synthesizer  synthesizer)

Build synthesizer.

§ debug()

void debug ( Console  console)

§ getBytesPerSample()

int getBytesPerSample ( )

Bytes per sample.

§ getChannelCount()

int getChannelCount ( )

Channel count.

§ getControllerAt()

SDController getControllerAt ( int  position)

Controller at position.

§ getControllerCount()

int getControllerCount ( )

Number of controllers.

§ getLinkAt()

SDLink getLinkAt ( int  position)

Link at position.

§ getLinkCount()

int getLinkCount ( )

Number of links.

§ getPathDirectory()

String getPathDirectory ( )

Path to directory the synthesizer file is located in.

§ getPathFile()

String getPathFile ( )

Path the synthesizer has been loaded from.

§ getSampleCount()

int getSampleCount ( )

Number of samples to create.

§ getSampleRate()

int getSampleRate ( )

Sample rate.

§ getSourceAt()

SDSource getSourceAt ( int  position)

Source at position.

§ getSourceCount()

int getSourceCount ( )

Number of sources.

§ new()

SynthesizerDefinition new ( String  pathFile)

Create synthesizer definition.

Parameters
pathFileAbsolute path the definition has been loaded from.

§ setBytesPerSample()

void setBytesPerSample ( int  bytesPerSample)

Set bytes per sample.

§ setChannelCount()

void setChannelCount ( int  channelCount)

Set channel count.

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