Synthesizer source sound. More...

Inheritance diagram for Dragengine.Scenery.SSSound:

Public Member Functions
Constructors
SSSound	new ()
	Create animator source.

Management
void	setSound (Sound sound)
	Set sound or null if silent.

void	setMinSpeed (float speed)
	Set minimum play speed.

void	setMaxSpeed (float speed)
	Set maximum play speed.

void	setLooping (bool looping)
	Set if sound is played back looping.

void	targetAddLink (SSSoundTarget target, int link)
	Add link to target.

void	targetRemoveAllLinks (SSSoundTarget target)
	Remove all links from target.

Public Member Functions inherited from Dragengine.Scenery.SynthesizerSource
void	setEnabled (bool enabled)
	Source is enabled.

void	setMixMode (SynthesizerSourceMix mixMode)
	Set if source is enabled.

void	setBlendFactor (float factor)
	Set mixing mode.

void	setMinVolume (float volume)
	Set minimum volume relative to speaker volume in the range from 0 to 1.

void	setMaxVolume (float volume)
	Set maximum volume relative to speaker volume in the range from 0 to 1.

void	setMinPanning (float panning)
	Set minimum panning in the range from -1(left) to 1(right).

void	setMaxPanning (float panning)
	Set maximum panning in the range from -1(left) to 1(right).

void	addEffect (SynthesizerEffect effect)
	Add effect.

void	removeAllEffects ()
	Remove all effects.

Additional Inherited Members
Constructors

Detailed Description

Synthesizer source sound.

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

Member Function Documentation

◆ new()

SSSound Dragengine.Scenery.SSSound.new ( )

Create animator source.

Reimplemented from Dragengine.Scenery.SynthesizerSource.

◆ setLooping()

void Dragengine.Scenery.SSSound.setLooping ( bool looping )

Set if sound is played back looping.

◆ setMaxSpeed()

void Dragengine.Scenery.SSSound.setMaxSpeed ( float speed )

Set maximum play speed.

A value of 1 plays at orignal speed. A value of 2 would play double as fast. Negative values play backward. A value of -1 would play backward at original speed.

◆ setMinSpeed()

void Dragengine.Scenery.SSSound.setMinSpeed ( float speed )

Set minimum play speed.

A value of 1 plays at orignal speed. A value of 2 would play double as fast. Negative values play backward. A value of -1 would play backward at original speed.

◆ setSound()

void Dragengine.Scenery.SSSound.setSound ( Sound sound )

Set sound or null if silent.

◆ targetAddLink()

void Dragengine.Scenery.SSSound.targetAddLink	(	SSSoundTarget	target,
		int	link
	)

Add link to target.

Exceptions

EInvalidParam target is not a valid value.

◆ targetRemoveAllLinks()

void Dragengine.Scenery.SSSound.targetRemoveAllLinks ( SSSoundTarget target )

Remove all links from target.