Dragengine.Audio.SynthesizerDefinition.SDSourceSound Class Reference

Definition of synthesizer source. More...

Inheritance diagram for Dragengine.Audio.SynthesizerDefinition.SDSourceSound:

Public Member Functions
SynthesizerSource	buildSource (Synthesizer synthesizer)
	Build engine synthesizer source using the stored definition.
void	debug (Console console)
bool	getLooping ()
	Sound is played back looping.
float	getMaxSpeed ()
	Maximum speed.
float	getMinSpeed ()
	Minimum speed.
Sound	getSound ()
	Sound.
SDSourceSound	new ()
	Create synthesizer source definition.
void	setLooping (bool looping)
	Set if sound is played back looping.
void	setMaxSpeed (float speed)
	Set maximum speed.
void	setMinSpeed (float speed)
	Set minimum speed.
void	setSound (Sound sound)
	Set sound.
Public Member Functions inherited from Dragengine.Audio.SynthesizerDefinition.SDSource
void	addEffect (SDEffect effect)
	Add effect.
void	addTargetLink (SDSourceTargetLink targetLink)
	Add target link.
void	forEachEffect (Block ablock)
	Visit effects using a block.
void	forEachTarget (Block ablock)
	Visit targets with a block.
float	getBlendFactor ()
	Blend factor.
SDEffect	getEffectAt (int index)
	Effect at index.
int	getEffectCount ()
	Number of effects.
float	getMaxPanning ()
	Maximum panning.
float	getMaxVolume ()
	Maximum volume.
float	getMinPanning ()
	Minimum panning.
float	getMinVolume ()
	Minimum volume.
SynthesizerSourceMix	getMixMode ()
	Mix mode.
String	getName ()
	Name of source.
SDSourceTargetLink	getTargetLinkAt (int index)
	Target link at index.
int	getTargetLinkCount ()
	Number of target links.
void	removeAllEffects ()
	Remove all effects.
void	removeEffect (SDEffect effect)
	Remove effect.
void	setBlendFactor (float factor)
	Set blend factor.
void	setEnabled (bool enabled)
	Set if source is enabled.
void	setMaxPanning (float panning)
	Set maximum panning.
void	setMaxVolume (float volume)
	Set maximum volume.
void	setMinPanning (float panning)
	Set minimum panning.
void	setMinVolume (float volume)
	Set minimum volume.
void	setMixMode (SynthesizerSourceMix mode)
	Set mix mode.
void	setName (String name)
	Set name of source.

Additional Inherited Members
Protected Member Functions inherited from Dragengine.Audio.SynthesizerDefinition.SDSource
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.

Member Function Documentation

buildSource()

SynthesizerSource Dragengine.Audio.SynthesizerDefinition.SDSourceSound.buildSource

(

Synthesizer

synthesizer

)

Build engine synthesizer source using the stored definition.

debug()

void Dragengine.Audio.SynthesizerDefinition.SDSourceSound.debug

(

Console

console

)

Reimplemented from Dragengine.Audio.SynthesizerDefinition.SDSource.

getLooping()

bool Dragengine.Audio.SynthesizerDefinition.SDSourceSound.getLooping

(

)

Sound is played back looping.

getMaxSpeed()

float Dragengine.Audio.SynthesizerDefinition.SDSourceSound.getMaxSpeed

(

)

Maximum speed.

getMinSpeed()

float Dragengine.Audio.SynthesizerDefinition.SDSourceSound.getMinSpeed

(

)

Minimum speed.

getSound()

Sound Dragengine.Audio.SynthesizerDefinition.SDSourceSound.getSound

(

)

Sound.

new()

SDSourceSound Dragengine.Audio.SynthesizerDefinition.SDSourceSound.new

(

)

Create synthesizer source definition.

Reimplemented from Dragengine.Audio.SynthesizerDefinition.SDSource.

setLooping()

void Dragengine.Audio.SynthesizerDefinition.SDSourceSound.setLooping

(

bool

looping

)

Set if sound is played back looping.

setMaxSpeed()

void Dragengine.Audio.SynthesizerDefinition.SDSourceSound.setMaxSpeed

(

float

speed

)

Set maximum speed.

setMinSpeed()

void Dragengine.Audio.SynthesizerDefinition.SDSourceSound.setMinSpeed

(

float

speed

)

Set minimum speed.

setSound()

void Dragengine.Audio.SynthesizerDefinition.SDSourceSound.setSound

(

Sound

sound

)

Set sound.

---

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

• SDSourceSound.ds