Drag[en]gine Script Module DragonScript  1.23
Dragengine.Scenery.SSSound Class Reference

Synthesizer source sound. More...

Inheritance diagram for Dragengine.Scenery.SSSound:
Dragengine.Scenery.SynthesizerSource

Public Member Functions

Constructors
SSSound new ()
 Create animator source. More...
 
Management
void setSound (Sound sound)
 Set sound or null if silent. More...
 
void setMinSpeed (float speed)
 Set minimum play speed. More...
 
void setMaxSpeed (float speed)
 Set maximum play speed. More...
 
void setLooping (bool looping)
 Set if sound is played back looping. More...
 
void targetAddLink (SSSoundTarget target, int link)
 Add link to target. More...
 
void targetRemoveAllLinks (SSSoundTarget target)
 Remove all links from target. More...
 
- Public Member Functions inherited from Dragengine.Scenery.SynthesizerSource
void setEnabled (bool enabled)
 Source is enabled. More...
 
void setMixMode (SynthesizerSourceMix mixMode)
 Set if source is enabled. More...
 
void setBlendFactor (float factor)
 Set mixing mode. More...
 
void setMinVolume (float volume)
 Set minimum volume relative to speaker volume in the range from 0 to 1. More...
 
void setMaxVolume (float volume)
 Set maximum volume relative to speaker volume in the range from 0 to 1. More...
 
void setMinPanning (float panning)
 Set minimum panning in the range from -1(left) to 1(right). More...
 
void setMaxPanning (float panning)
 Set maximum panning in the range from -1(left) to 1(right). More...
 
void addEffect (SynthesizerEffect effect)
 Add effect. More...
 
void removeAllEffects ()
 Remove all effects. More...
 

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
EInvalidParamtarget is not a valid value.

◆ targetRemoveAllLinks()

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

Remove all links from target.

Exceptions
EInvalidParamtarget is not a valid value.

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