Synthesizer producing dynamic sounds from sources. More...

#include <deSynthesizer.h>

Inheritance diagram for deSynthesizer:

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

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

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

Public Member Functions
Management
int	GetChannelCount () const
	Number of channels. More...

void	SetChannelCount (int channelCount)
	Set number of channels. More...

int	GetSampleRate () const
	Sample rate. More...

void	SetSampleRate (int sampleRate)
	Set sample rate. More...

int	GetBytesPerSample () const
	Bytes per sample. More...

void	SetBytesPerSample (int bytesPerSample)
	Set bytes per sample. More...

int	GetSampleCount () const
	Number of samples to create. More...

void	SetSampleCount (int sampleCount)
	Set number of samples to create. More...

Controllers
int	GetControllerCount () const
	Number of controllers. More...

deSynthesizerController *	GetControllerAt (int index) const
	Controller at index. More...

int	IndexOfController (deSynthesizerController *controller) const
	Index of controller or -1 if absent. More...

int	IndexOfControllerNamed (const char *name) const
	Index of controller or -1 if absent. More...

bool	HasController (deSynthesizerController *controller) const
	Controller is present. More...

void	AddController (deSynthesizerController *controller)
	Add controller. More...

void	RemoveController (deSynthesizerController *controller)
	Remove controller. More...

void	RemoveAllControllers ()
	Remove all controllers. More...

void	NotifyControllersChanged ()
	Notify peers controllers changed. More...

Links
int	GetLinkCount () const
	Number of links. More...

deSynthesizerLink *	GetLinkAt (int index) const
	Link at index. More...

int	IndexOfLink (deSynthesizerLink *link) const
	Index of link or -1 if absent. More...

bool	HasLink (deSynthesizerLink *link) const
	Link is present. More...

void	AddLink (deSynthesizerLink *link)
	Add link. More...

void	RemoveLink (deSynthesizerLink *link)
	Remove link. More...

void	RemoveAllLinks ()
	Remove all links. More...

void	NotifyLinksChanged ()
	Notify peers links changed. More...

Sources
int	GetSourceCount () const
	Number of sources. More...

deSynthesizerSource *	GetSourceAt (int index) const
	Source at index. More...

int	IndexOfSource (deSynthesizerSource *source) const
	Index of source or -1 if absent. More...

bool	HasSource (deSynthesizerSource *source) const
	Source is present. More...

void	AddSource (deSynthesizerSource *source)
	Add source. More...

void	RemoveSource (deSynthesizerSource *source)
	Remove source. More...

void	RemoveAllSources ()
	Remove all sources. More...

void	NotifySourcesChanged ()
	Notify peers sources changed. More...

System Peers
deBaseSynthesizerSynthesizer *	GetPeerSynthesizer () const
	Synthesizer system peer or NULL if not set. More...

void	SetPeerSynthesizer (deBaseSynthesizerSynthesizer *peer)
	Set synthesizer system peer. More...

Public Member Functions inherited from deResource
deResourceManager *	GetResourceManager () const
	Resource manager or NULL if resource is leaking. More...

deEngine *	GetEngine () const
	Game engine object from resource manager. More...

deResource *	GetLLManagerPrev () const
	Previous resource in the resource manager linked list. More...

void	SetLLManagerPrev (deResource *resource)
	Set next resource in the resource manager linked list. More...

deResource *	GetLLManagerNext () const
	Next resource in the resource manager linked list. More...

void	SetLLManagerNext (deResource *resource)
	Set next resource in the resource manager linked list. More...

void	MarkLeaking ()
	Marks the resource leaking. More...

	deResource (deResourceManager *resourceManager)
	Create resource. 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
	deSynthesizer (deSynthesizerManager *manager)
	Create synthesizer. More...

virtual	~deSynthesizer ()
	Clean up synthesizer. More...

Additional Inherited Members
Protected Member Functions inherited from deResource
virtual	~deResource ()
	Clean up resource. More...

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

Detailed Description

Synthesizer producing dynamic sounds from sources.

Contains the definition for producing sounds. Use deSynthesizerInstance for to actually produce sounds using individual parameters. Multiple synthesizer instances can share the same synthesizer.

Member Typedef Documentation

◆ Ref

typedef deTObjectReference<deSynthesizer> deSynthesizer::Ref

Type holding strong reference.

Constructor & Destructor Documentation

◆ deSynthesizer()

deSynthesizer::deSynthesizer ( deSynthesizerManager * manager )

Create synthesizer.

◆ ~deSynthesizer()

virtual deSynthesizer::~deSynthesizer ( )

protectedvirtual

Clean up synthesizer.

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

◆ AddController()

void deSynthesizer::AddController ( deSynthesizerController * controller )

Add controller.

◆ AddLink()

void deSynthesizer::AddLink ( deSynthesizerLink * link )

Add link.

◆ AddSource()

void deSynthesizer::AddSource ( deSynthesizerSource * source )

Add source.

◆ GetBytesPerSample()

int deSynthesizer::GetBytesPerSample ( ) const

inline

Bytes per sample.

◆ GetChannelCount()

int deSynthesizer::GetChannelCount ( ) const

inline

Number of channels.

◆ GetControllerAt()

deSynthesizerController* deSynthesizer::GetControllerAt ( int index ) const

Controller at index.

Exceptions

deeOutOfBoundary index is less than 0 or larger than or equal to GetControllerCount().

◆ GetControllerCount()

int deSynthesizer::GetControllerCount ( ) const

Number of controllers.

◆ GetLinkAt()

deSynthesizerLink* deSynthesizer::GetLinkAt ( int index ) const

Link at index.

Exceptions

deeOutOfBoundary index is less than 0 or larger than or equal to GetLinkCount().

◆ GetLinkCount()

int deSynthesizer::GetLinkCount ( ) const

Number of links.

◆ GetPeerSynthesizer()

deBaseSynthesizerSynthesizer* deSynthesizer::GetPeerSynthesizer ( ) const

inline

Synthesizer system peer or NULL if not set.

◆ GetSampleCount()

int deSynthesizer::GetSampleCount ( ) const

inline

Number of samples to create.

◆ GetSampleRate()

int deSynthesizer::GetSampleRate ( ) const

inline

Sample rate.

◆ GetSourceAt()

deSynthesizerSource* deSynthesizer::GetSourceAt ( int index ) const

Source at index.

Exceptions

deeOutOfBoundary index is less than 0 or larger than or equal to GetSourceCount().

◆ GetSourceCount()

int deSynthesizer::GetSourceCount ( ) const

Number of sources.

◆ HasController()

bool deSynthesizer::HasController ( deSynthesizerController * controller ) const

Controller is present.

◆ HasLink()

bool deSynthesizer::HasLink ( deSynthesizerLink * link ) const

Link is present.

◆ HasSource()

bool deSynthesizer::HasSource ( deSynthesizerSource * source ) const

Source is present.

◆ IndexOfController()

int deSynthesizer::IndexOfController ( deSynthesizerController * controller ) const

Index of controller or -1 if absent.

◆ IndexOfControllerNamed()

int deSynthesizer::IndexOfControllerNamed ( const char * name ) const

Index of controller or -1 if absent.

◆ IndexOfLink()

int deSynthesizer::IndexOfLink ( deSynthesizerLink * link ) const

Index of link or -1 if absent.

◆ IndexOfSource()

int deSynthesizer::IndexOfSource ( deSynthesizerSource * source ) const

Index of source or -1 if absent.

◆ NotifyControllersChanged()

void deSynthesizer::NotifyControllersChanged ( )

Notify peers controllers changed.

◆ NotifyLinksChanged()

void deSynthesizer::NotifyLinksChanged ( )

Notify peers links changed.

◆ NotifySourcesChanged()

void deSynthesizer::NotifySourcesChanged ( )

Notify peers sources changed.

◆ RemoveAllControllers()

void deSynthesizer::RemoveAllControllers ( )

Remove all controllers.

◆ RemoveAllLinks()

void deSynthesizer::RemoveAllLinks ( )

Remove all links.

◆ RemoveAllSources()

void deSynthesizer::RemoveAllSources ( )

Remove all sources.

◆ RemoveController()

void deSynthesizer::RemoveController ( deSynthesizerController * controller )

Remove controller.

Exceptions

deeInvalidParam controller is absent.

◆ RemoveLink()

void deSynthesizer::RemoveLink ( deSynthesizerLink * link )

Remove link.

Exceptions

deeInvalidParam link is absent.

◆ RemoveSource()

void deSynthesizer::RemoveSource ( deSynthesizerSource * source )

Remove source.

Exceptions

deeOutOfBoundary source is absent.

◆ SetBytesPerSample()

void deSynthesizer::SetBytesPerSample ( int bytesPerSample )

Set bytes per sample.

◆ SetChannelCount()

void deSynthesizer::SetChannelCount ( int channelCount )

Set number of channels.

◆ SetPeerSynthesizer()

void deSynthesizer::SetPeerSynthesizer ( deBaseSynthesizerSynthesizer * peer )

Set synthesizer system peer.

◆ SetSampleCount()

void deSynthesizer::SetSampleCount ( int sampleCount )

Set number of samples to create.

◆ SetSampleRate()

void deSynthesizer::SetSampleRate ( int sampleRate )

Set sample rate.

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

deSynthesizer.h

Public Types

Public Member Functions

Constructors and Destructors

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ref

Constructor & Destructor Documentation

◆ deSynthesizer()

◆ ~deSynthesizer()

Member Function Documentation

◆ AddController()

◆ AddLink()

◆ AddSource()

◆ GetBytesPerSample()

◆ GetChannelCount()

◆ GetControllerAt()

◆ GetControllerCount()

◆ GetLinkAt()

◆ GetLinkCount()

◆ GetPeerSynthesizer()

◆ GetSampleCount()

◆ GetSampleRate()

◆ GetSourceAt()

◆ GetSourceCount()

◆ HasController()

◆ HasLink()

◆ HasSource()

◆ IndexOfController()

◆ IndexOfControllerNamed()

◆ IndexOfLink()

◆ IndexOfSource()

◆ NotifyControllersChanged()

◆ NotifyLinksChanged()

◆ NotifySourcesChanged()

◆ RemoveAllControllers()

◆ RemoveAllLinks()

◆ RemoveAllSources()

◆ RemoveController()

◆ RemoveLink()

◆ RemoveSource()

◆ SetBytesPerSample()

◆ SetChannelCount()

◆ SetPeerSynthesizer()

◆ SetSampleCount()

◆ SetSampleRate()