SSSound Class Reference

Synthesizer source sound. More...

Inheritance diagram for SSSound:

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 (int target, int link)
	Add link to target. More...
void	targetRemoveAllLinks (int target)
	Remove all links from target. More...
Public Member Functions inherited from SynthesizerSource
void	setEnabled (bool enabled)
	Source is enabled. More...
void	setMixMode (int 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...

Static Public Attributes
Targets.
static final int	TARGET_BLEND_FACTOR = 0
	Blend factor target. More...
static final int	TARGET_VOLUME = 1
	Volume target. More...
static final int	TARGET_PANNING = 2
	Panning target. More...
static final int	TARGET_SPEED = 3
	Speed target. More...
static final int	TARGET_PLAY = 4
	Play state target (0-1 -> play, pause, stop). More...
Static Public Attributes inherited from SynthesizerSource
static final int	BLEND = 0
	Blend sound output of this source over the previous sound. More...
static final int	ADD = 1
	Add sound output to the previous sounds clipping if too loud. More...

Additional Inherited Members
Protected Member Functions inherited from SynthesizerSource
SynthesizerSource	new ()
	Create animator source. More...

Detailed Description

Synthesizer source sound.

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

Author

Roland Plüss

Version

1.0

Date

2015

Member Function Documentation

new()

SSSound new

(

)

Create animator source.

setLooping()

void setLooping

(

bool

looping

)

Set if sound is played back looping.

setMaxSpeed()

void 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 backwards. A value of -1 would play backwards at original speed.

setMinSpeed()

void 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 backwards. A value of -1 would play backwards at original speed.

setSound()

void setSound

(

Sound

sound

)

Set sound or null if silent.

targetAddLink()

void targetAddLink	(	int	target,
		int	link
	)

Add link to target.

Exceptions

EInvalidParam

target is not a valid value.

targetRemoveAllLinks()

void targetRemoveAllLinks

(

int

target

)

Remove all links from target.

Exceptions

EInvalidParam

target is not a valid value.

Member Data Documentation

TARGET_BLEND_FACTOR

final int TARGET_BLEND_FACTOR = 0

static

Blend factor target.

TARGET_PANNING

final int TARGET_PANNING = 2

static

Panning target.

TARGET_PLAY

final int TARGET_PLAY = 4

static

Play state target (0-1 -> play, pause, stop).

TARGET_SPEED

final int TARGET_SPEED = 3

static

Speed target.

TARGET_VOLUME

final int TARGET_VOLUME = 1

static

Volume target.

---

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

• SSSound.ds