Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition Class Reference

Definition of a synthesizer. More...

Inheritance diagram for Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition:

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

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.

Member Function Documentation

addController()

void Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.addController

(

SDController

controller

)

Add controller.

addLink()

void Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.addLink

(

SDLink

link

)

Add link.

addSource()

void Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.addSource

(

SDSource

source

)

Add source.

buildSynthesizer()

void Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.buildSynthesizer

(

Synthesizer

synthesizer

)

Build synthesizer.

debug()

void Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.debug

(

Console

console

)

getBytesPerSample()

int Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.getBytesPerSample

(

)

Bytes per sample.

getChannelCount()

int Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.getChannelCount

(

)

Channel count.

getControllerAt()

SDController Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.getControllerAt

(

int

position

)

Controller at position.

getControllerCount()

int Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.getControllerCount

(

)

Number of controllers.

getLinkAt()

SDLink Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.getLinkAt

(

int

position

)

Link at position.

getLinkCount()

int Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.getLinkCount

(

)

Number of links.

getPathDirectory()

String Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.getPathDirectory

(

)

Path to directory the synthesizer file is located in.

getPathFile()

String Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.getPathFile

(

)

Path the synthesizer has been loaded from.

getSampleCount()

int Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.getSampleCount

(

)

Number of samples to create.

getSampleRate()

int Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.getSampleRate

(

)

Sample rate.

getSourceAt()

SDSource Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.getSourceAt

(

int

position

)

Source at position.

getSourceCount()

int Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.getSourceCount

(

)

Number of sources.

new()

SynthesizerDefinition Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.new

(

String

pathFile

)

Create synthesizer definition.

Parameters

pathFile

Absolute path the definition has been loaded from.

setBytesPerSample()

void Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.setBytesPerSample

(

int

bytesPerSample

)

Set bytes per sample.

setChannelCount()

void Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.setChannelCount

(

int

channelCount

)

Set channel count.

setSampleCount()

void Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.setSampleCount

(

int

sampleCount

)

Set number of samples to create.

setSampleRate()

void Dragengine.Audio.SynthesizerDefinition.SynthesizerDefinition.setSampleRate

(

int

sampleRate

)

Set sample rate.

---

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

• SynthesizerDefinition.ds