Drag[en]gine Script Module DragonScript Script API  1.0
SSGroup Class Reference

Synthesizer source group. More...

Inheritance diagram for SSGroup:
SynthesizerSource

Public Member Functions

Constructors
SSGroup new ()
 Create animator source. More...
 
Management
void setApplicationType (int applicationType)
 Set application type. More...
 
void removeSource (SynthesizerSource source)
 Remove source. More...
 
void removeAllSources ()
 Remove all sources. 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_FREQUENCY = 3
 Frequency target. More...
 
Application types.
static final int APPLICATION_ALL = 0
 Output the mix of all sources in the group. More...
 
static final int APPLICATION_SELECT = 1
 Use selection target to output blend between two selected sources. A target vlaue of 0 plays solo the first source in the group. A target value of 1 plays solo the last source in the group. Blends across all other sources in between in a linear way. To simulate blending over to the first source duplicate the first source also as last source. More...
 
static final int APPLICATION_SOLO = 2
 Use selection target to output selected sources solo. Similar to eatSelect but does not blend between the two nearest sources but outputs only the nearest source. Source is chosen in a linear way. 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 group.

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

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ new()

SSGroup new ( )

Create animator source.

§ removeAllSources()

void removeAllSources ( )

Remove all sources.

§ removeSource()

void removeSource ( SynthesizerSource  source)

Remove source.

§ setApplicationType()

void setApplicationType ( int  applicationType)

Set application type.

Exceptions
EInvalidParamapplicationType is not a valid value.

§ targetAddLink()

void targetAddLink ( int  target,
int  link 
)

Add link to target.

Exceptions
EInvalidParamtarget is not a valid value.

§ targetRemoveAllLinks()

void targetRemoveAllLinks ( int  target)

Remove all links from target.

Exceptions
EInvalidParamtarget is not a valid value.

Member Data Documentation

§ APPLICATION_ALL

final int APPLICATION_ALL = 0
static

Output the mix of all sources in the group.

§ APPLICATION_SELECT

final int APPLICATION_SELECT = 1
static

Use selection target to output blend between two selected sources. A target vlaue of 0 plays solo the first source in the group. A target value of 1 plays solo the last source in the group. Blends across all other sources in between in a linear way. To simulate blending over to the first source duplicate the first source also as last source.

§ APPLICATION_SOLO

final int APPLICATION_SOLO = 2
static

Use selection target to output selected sources solo. Similar to eatSelect but does not blend between the two nearest sources but outputs only the nearest source. Source is chosen in a linear way.

§ TARGET_BLEND_FACTOR

final int TARGET_BLEND_FACTOR = 0
static

Blend factor target.

§ TARGET_FREQUENCY

final int TARGET_FREQUENCY = 3
static

Frequency target.

§ TARGET_PANNING

final int TARGET_PANNING = 2
static

Panning target.

§ TARGET_VOLUME

final int TARGET_VOLUME = 1
static

Volume target.


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