Dragengine.Audio.SynthesizerDefinition.SDSource Class Reference

Definition of synthesizer source. More...

Inheritance diagram for Dragengine.Audio.SynthesizerDefinition.SDSource:

Public Member Functions
void	addEffect (SDEffect effect)
	Add effect. More...
void	addTargetLink (SDSourceTargetLink targetLink)
	Add target link. More...
void	debug (Console console)
void	forEachEffect (Block ablock)
	Visit effects using a block. More...
void	forEachTarget (Block ablock)
	Visit targets with a block. More...
float	getBlendFactor ()
	Blend factor. More...
SDEffect	getEffectAt (int index)
	Effect at index. More...
int	getEffectCount ()
	Number of effects. More...
float	getMaxPanning ()
	Maximum panning. More...
float	getMaxVolume ()
	Maximum volume. More...
float	getMinPanning ()
	Minimum panning. More...
float	getMinVolume ()
	Minimum volume. More...
SynthesizerSourceMix	getMixMode ()
	Mix mode. More...
String	getName ()
	Name of source. More...
SDSourceTargetLink	getTargetLinkAt (int index)
	Target link at index. More...
int	getTargetLinkCount ()
	Number of target links. More...
SDSource	new ()
	Create synthesizer source definition. More...
void	removeAllEffects ()
	Remove all effects. More...
void	removeEffect (SDEffect effect)
	Remove effect. More...
void	setBlendFactor (float factor)
	Set blend factor. More...
void	setEnabled (bool enabled)
	Set if source is enabled. More...
void	setMaxPanning (float panning)
	Set maximum panning. More...
void	setMaxVolume (float volume)
	Set maximum volume. More...
void	setMinPanning (float panning)
	Set minimum panning. More...
void	setMinVolume (float volume)
	Set minimum volume. More...
void	setMixMode (SynthesizerSourceMix mode)
	Set mix mode. More...
void	setName (String name)
	Set name of source. More...

Protected Member Functions
String	debugCommon (Console console, String type)

Detailed Description

Definition of synthesizer source.

Once defined a source can be added to an synthesizer using the stored definition. This is the base source class with the properties shared amongst all source types.

Member Function Documentation

addEffect()

void Dragengine.Audio.SynthesizerDefinition.SDSource.addEffect

(

SDEffect

effect

)

Add effect.

addTargetLink()

void Dragengine.Audio.SynthesizerDefinition.SDSource.addTargetLink

(

SDSourceTargetLink

targetLink

)

Add target link.

debug()

void Dragengine.Audio.SynthesizerDefinition.SDSource.debug

(

Console

console

)

Reimplemented in Dragengine.Audio.SynthesizerDefinition.SDSourceWave, Dragengine.Audio.SynthesizerDefinition.SDSourceSynthesizer, Dragengine.Audio.SynthesizerDefinition.SDSourceSound, Dragengine.Audio.SynthesizerDefinition.SDSourceGroup, and Dragengine.Audio.SynthesizerDefinition.SDSourceChain.

debugCommon()

String Dragengine.Audio.SynthesizerDefinition.SDSource.debugCommon ( Console  console, String  type  )

protected

forEachEffect()

void Dragengine.Audio.SynthesizerDefinition.SDSource.forEachEffect

(

Block

ablock

)

Visit effects using a block.

forEachTarget()

void Dragengine.Audio.SynthesizerDefinition.SDSource.forEachTarget

(

Block

ablock

)

Visit targets with a block.

getBlendFactor()

float Dragengine.Audio.SynthesizerDefinition.SDSource.getBlendFactor

(

)

Blend factor.

getEffectAt()

SDEffect Dragengine.Audio.SynthesizerDefinition.SDSource.getEffectAt

(

int

index

)

Effect at index.

getEffectCount()

int Dragengine.Audio.SynthesizerDefinition.SDSource.getEffectCount

(

)

Number of effects.

getMaxPanning()

float Dragengine.Audio.SynthesizerDefinition.SDSource.getMaxPanning

(

)

Maximum panning.

getMaxVolume()

float Dragengine.Audio.SynthesizerDefinition.SDSource.getMaxVolume

(

)

Maximum volume.

getMinPanning()

float Dragengine.Audio.SynthesizerDefinition.SDSource.getMinPanning

(

)

Minimum panning.

getMinVolume()

float Dragengine.Audio.SynthesizerDefinition.SDSource.getMinVolume

(

)

Minimum volume.

getMixMode()

SynthesizerSourceMix Dragengine.Audio.SynthesizerDefinition.SDSource.getMixMode

(

)

Mix mode.

getName()

String Dragengine.Audio.SynthesizerDefinition.SDSource.getName

(

)

Name of source.

getTargetLinkAt()

SDSourceTargetLink Dragengine.Audio.SynthesizerDefinition.SDSource.getTargetLinkAt

(

int

index

)

Target link at index.

getTargetLinkCount()

int Dragengine.Audio.SynthesizerDefinition.SDSource.getTargetLinkCount

(

)

Number of target links.

new()

SDSource Dragengine.Audio.SynthesizerDefinition.SDSource.new

(

)

Create synthesizer source definition.

Reimplemented in Dragengine.Audio.SynthesizerDefinition.SDSourceWave, Dragengine.Audio.SynthesizerDefinition.SDSourceSynthesizer, Dragengine.Audio.SynthesizerDefinition.SDSourceSound, Dragengine.Audio.SynthesizerDefinition.SDSourceGroup, and Dragengine.Audio.SynthesizerDefinition.SDSourceChain.

removeAllEffects()

void Dragengine.Audio.SynthesizerDefinition.SDSource.removeAllEffects

(

)

Remove all effects.

removeEffect()

void Dragengine.Audio.SynthesizerDefinition.SDSource.removeEffect

(

SDEffect

effect

)

Remove effect.

setBlendFactor()

void Dragengine.Audio.SynthesizerDefinition.SDSource.setBlendFactor

(

float

factor

)

Set blend factor.

setEnabled()

void Dragengine.Audio.SynthesizerDefinition.SDSource.setEnabled

(

bool

enabled

)

Set if source is enabled.

setMaxPanning()

void Dragengine.Audio.SynthesizerDefinition.SDSource.setMaxPanning

(

float

panning

)

Set maximum panning.

setMaxVolume()

void Dragengine.Audio.SynthesizerDefinition.SDSource.setMaxVolume

(

float

volume

)

Set maximum volume.

setMinPanning()

void Dragengine.Audio.SynthesizerDefinition.SDSource.setMinPanning

(

float

panning

)

Set minimum panning.

setMinVolume()

void Dragengine.Audio.SynthesizerDefinition.SDSource.setMinVolume

(

float

volume

)

Set minimum volume.

setMixMode()

void Dragengine.Audio.SynthesizerDefinition.SDSource.setMixMode

(

SynthesizerSourceMix

mode

)

Set mix mode.

setName()

void Dragengine.Audio.SynthesizerDefinition.SDSource.setName

(

String

name

)

Set name of source.

---

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

• SDSource.ds