This sound creates a IIR filter reader. More...

Inheritance diagram for DynamicIIRFilter:

[legend]

Public Member Functions
	DynamicIIRFilter (std::shared_ptr< ISound > sound, std::shared_ptr< IDynamicIIRFilterCalculator > calculator)
	Creates a new Dynmic IIR filter sound.

virtual std::shared_ptr< IReader >	createReader ()
	Creates a reader for playback of the sound source.

Public Member Functions inherited from Effect
	Effect (std::shared_ptr< ISound > sound)
	Creates a new sound.

virtual	~Effect ()
	Destroys the sound.

std::shared_ptr< ISound >	getSound () const
	Returns the saved sound.

Public Member Functions inherited from ISound
virtual	~ISound ()
	Destroys the sound.

Protected Attributes
std::shared_ptr< IDynamicIIRFilterCalculator >	m_calculator
	The IDynamicIIRFilterCalculator that calculates the dynamic filter coefficients.

Protected Attributes inherited from Effect
std::shared_ptr< ISound >	m_sound
	If there is no reader it is created out of this sound.

Additional Inherited Members
Protected Member Functions inherited from Effect
std::shared_ptr< IReader >	getReader () const
	Returns the reader created out of the sound.

Detailed Description

This sound creates a IIR filter reader.

This means that on sample rate change the filter recalculates its coefficients.

Constructor & Destructor Documentation

DynamicIIRFilter::DynamicIIRFilter	(	std::shared_ptr< ISound >	sound,
		std::shared_ptr< IDynamicIIRFilterCalculator >	calculator )

Creates a new Dynmic IIR filter sound.

Parameters

sound	The input sound.
calculator	The calculator which recalculates the dynamic filter coefficients.

virtual std::shared_ptr< IReader > DynamicIIRFilter::createReader ( )

virtual

Creates a reader for playback of the sound source.

Returns: A pointer to an IReader object or nullptr if there has been an error.

Exceptions

Exception An exception may be thrown if there has been a more unexpected error during reader creation.

Implements ISound.

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