Dragengine.Scenery.SSGroup Class Reference

Synthesizer source group. More...

Inheritance diagram for Dragengine.Scenery.SSGroup:

Public Member Functions
Constructors
SSGroup	new ()
	Create animator source.
Management
void	setApplicationType (SSGroupApplication applicationType)
	Set application type.
void	addSource (SynthesizerSource source)
	Add source.
void	removeSource (SynthesizerSource source)
	Remove source.
void	removeAllSources ()
	Remove all sources.
void	targetAddLink (SSGroupTarget target, int link)
	Add link to target.
void	targetRemoveAllLinks (SSGroupTarget 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 group.

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

Member Function Documentation

addSource()

void Dragengine.Scenery.SSGroup.addSource

(

SynthesizerSource

source

)

Add source.

new()

SSGroup Dragengine.Scenery.SSGroup.new

(

)

Create animator source.

Reimplemented from Dragengine.Scenery.SynthesizerSource.

removeAllSources()

void Dragengine.Scenery.SSGroup.removeAllSources

(

)

Remove all sources.

removeSource()

void Dragengine.Scenery.SSGroup.removeSource

(

SynthesizerSource

source

)

Remove source.

setApplicationType()

void Dragengine.Scenery.SSGroup.setApplicationType

(

SSGroupApplication

applicationType

)

Set application type.

Exceptions

EInvalidParam

applicationType is not a valid value.

targetAddLink()

void Dragengine.Scenery.SSGroup.targetAddLink	(	SSGroupTarget	target,
		int	link
	)

Add link to target.

Exceptions

EInvalidParam

target is not a valid value.

targetRemoveAllLinks()

void Dragengine.Scenery.SSGroup.targetRemoveAllLinks

(

SSGroupTarget

target

)

Remove all links from target.

Exceptions

EInvalidParam

target is not a valid value.

---

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

• SSGroup.ds