Synthesizer sound source. More...

#include <deSynthesizerSourceSound.h>

Inheritance diagram for deSynthesizerSourceSound:

Public Types
typedef deTObjectReference< deSynthesizerSourceSound >	Ref
	Type holding strong reference. More...

Public Types inherited from deSynthesizerSource
enum	eMixModes { emmBlend , emmAdd }
	Mixing modes. More...

typedef deTObjectReference< deSynthesizerSource >	Ref
	Type holding strong reference. More...

Public Types inherited from deObject
typedef deTObjectReference< deObject >	Ref
	Type holding strong reference. More...

Public Member Functions
Management
deSound *	GetSound () const
	Sound or NULL if silent. More...

void	SetSound (deSound *sound)
	Set sound or NULL if silent. More...

float	GetMinSpeed () const
	Minimum play speed. More...

void	SetMinSpeed (float speed)
	Set minimum play speed. More...

float	GetMaxSpeed () const
	Maximum play speed. More...

void	SetMaxSpeed (float speed)
	Set maximum play speed. More...

bool	GetLooping () const
	Sound is played back looping. More...

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

deSynthesizerControllerTarget &	GetTargetSpeed ()
	Play speed target. More...

const deSynthesizerControllerTarget &	GetTargetSpeed () const

deSynthesizerControllerTarget &	GetTargetPlay ()
	Play target. More...

const deSynthesizerControllerTarget &	GetTargetPlay () const

Visiting
virtual void	Visit (deSynthesizerSourceVisitor &visitor)
	Visit source. More...

Public Member Functions inherited from deSynthesizerSource
deSynthesizer *	GetSynthesizer () const
	Parent synthesizer. More...

void	SetSynthesizer (deSynthesizer *synthesizer)
	Set parent synthesizer. More...

bool	GetEnabled () const
	Source is enabled. More...

void	SetEnabled (bool enabled)
	Set if source is enabled. More...

eMixModes	GetMixMode () const
	Mixing mode. More...

void	SetMixMode (eMixModes mode)
	Set mixing mode. More...

float	GetBlendFactor () const
	Blend factor. More...

void	SetBlendFactor (float factor)
	Set blend factor. More...

float	GetMinVolume () const
	Volume minimum relative to speaker volume in the range from 0 to 1. More...

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

float	GetMaxVolume () const
	Maximum 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...

float	GetMinPanning () const
	Minimum panning in the range from -1(left) to 1(right). More...

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

float	GetMaxPanning () const
	Maximum 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...

deSynthesizerControllerTarget &	GetTargetBlendFactor ()
	Blend factor target. More...

const deSynthesizerControllerTarget &	GetTargetBlendFactor () const

deSynthesizerControllerTarget &	GetTargetVolume ()
	Volume target. More...

const deSynthesizerControllerTarget &	GetTargetVolume () const

deSynthesizerControllerTarget &	GetTargetPanning ()
	Panning target. More...

const deSynthesizerControllerTarget &	GetTargetPanning () const

int	GetEffectCount () const
	Number of effects. More...

deSynthesizerEffect *	GetEffectAt (int index) const
	Effect at index. More...

void	AddEffect (deSynthesizerEffect *effect)
	Add effect. More...

void	RemoveEffect (deSynthesizerEffect *effect)
	Remove effect. More...

void	RemoveAllEffects ()
	Remove all effects. More...

	deSynthesizerSource ()
	Create synthesizer source. More...

Public Member Functions inherited from deObject
int	GetRefCount () const
	Reference count. More...

void	AddReference ()
	Add reference increasing reference count by 1. More...

void	FreeReference ()
	Decrease reference count by one and delete object if count reaches 0. More...

	deObject ()
	Create object with reference count of 1. More...

Constructors and Destructors
	deSynthesizerSourceSound ()
	Create synthesizer source. More...

virtual	~deSynthesizerSourceSound ()
	Clean up synthesizer source. More...

Additional Inherited Members
Protected Member Functions inherited from deSynthesizerSource
virtual	~deSynthesizerSource ()
	Clean up synthesizer source. More...

Protected Member Functions inherited from deObject
virtual	~deObject ()
	Clean up object. More...

Detailed Description

Synthesizer sound source.

Member Typedef Documentation

◆ Ref

typedef deTObjectReference<deSynthesizerSourceSound> deSynthesizerSourceSound::Ref

Type holding strong reference.

Constructor & Destructor Documentation

◆ deSynthesizerSourceSound()

deSynthesizerSourceSound::deSynthesizerSourceSound ( )

Create synthesizer source.

◆ ~deSynthesizerSourceSound()

virtual deSynthesizerSourceSound::~deSynthesizerSourceSound ( )

protectedvirtual

Clean up synthesizer source.

Note: Subclasses should set their destructor protected too to avoid users accidently deleting a reference counted object through the object pointer. Only FreeReference() is allowed to delete the object.

Member Function Documentation

◆ GetLooping()

bool deSynthesizerSourceSound::GetLooping ( ) const

inline

Sound is played back looping.

◆ GetMaxSpeed()

float deSynthesizerSourceSound::GetMaxSpeed ( ) const

inline

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.

◆ GetMinSpeed()

float deSynthesizerSourceSound::GetMinSpeed ( ) const

inline

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.

◆ GetSound()

deSound* deSynthesizerSourceSound::GetSound ( ) const

inline

Sound or NULL if silent.

◆ GetTargetPlay() [1/2]

deSynthesizerControllerTarget& deSynthesizerSourceSound::GetTargetPlay ( )

inline

Play target.

Plays, pauses or stops the source. This target is best used with links using constant interpolation curves. A value of 1 plays back the source. A value of 0.5 pauses the playback freezing playback position. A value of 0 stops playback and rewinds playback position to the beginning.

◆ GetTargetPlay() [2/2]

const deSynthesizerControllerTarget& deSynthesizerSourceSound::GetTargetPlay ( ) const

inline

◆ GetTargetSpeed() [1/2]

deSynthesizerControllerTarget& deSynthesizerSourceSound::GetTargetSpeed ( )

inline

Play speed target.

◆ GetTargetSpeed() [2/2]

const deSynthesizerControllerTarget& deSynthesizerSourceSound::GetTargetSpeed ( ) const

inline

◆ SetLooping()

void deSynthesizerSourceSound::SetLooping ( bool looping )

Set if sound is played back looping.

◆ SetMaxSpeed()

void deSynthesizerSourceSound::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 deSynthesizerSourceSound::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 deSynthesizerSourceSound::SetSound ( deSound * sound )

Set sound or NULL if silent.

◆ Visit()

virtual void deSynthesizerSourceSound::Visit ( deSynthesizerSourceVisitor & visitor )

virtual

Visit source.

Reimplemented from deSynthesizerSource.

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

deSynthesizerSourceSound.h

Public Types

Public Member Functions

Constructors and Destructors

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ref

Constructor & Destructor Documentation

◆ deSynthesizerSourceSound()

◆ ~deSynthesizerSourceSound()

Member Function Documentation

◆ GetLooping()

◆ GetMaxSpeed()

◆ GetMinSpeed()

◆ GetSound()

◆ GetTargetPlay() [1/2]

◆ GetTargetPlay() [2/2]

◆ GetTargetSpeed() [1/2]

◆ GetTargetSpeed() [2/2]

◆ SetLooping()

◆ SetMaxSpeed()

◆ SetMinSpeed()

◆ SetSound()

◆ Visit()