Echo Filter Class. More...
#include <echofilter.h>
Public Member Functions | |
Construction | |
CL_EchoFilter (int buffer_size=32 *1024, float shift_factor=2.0f) | |
Echo Filter Constructor. | |
virtual | ~CL_EchoFilter () |
Echo Filter Destructor. | |
Operations | |
CL_EchoFilterProvider * | get_provider () const |
Retrieves the provider. | |
Operators | |
bool | operator== (const CL_SoundFilter &other) const |
Equality operator. | |
bool | operator!= (const CL_SoundFilter &other) const |
Inequality operator. | |
Operations | |
bool | is_null () const |
Returns true if this object is invalid. | |
void | throw_if_null () const |
Throw an exception if this object is invalid. | |
void | filter (float **sample_data, int num_samples, int channels) |
Filter callback. | |
Public Attributes | |
Implementation | |
CL_SharedPtr< CL_SoundFilter_Impl > | impl |
Echo Filter Class.
CL_EchoFilter::CL_EchoFilter | ( | int | buffer_size = 32 *1024 , |
|
float | shift_factor = 2.0f | |||
) |
Echo Filter Constructor.
virtual CL_EchoFilter::~CL_EchoFilter | ( | ) | [virtual] |
Echo Filter Destructor.
void CL_SoundFilter::filter | ( | float ** | sample_data, | |
int | num_samples, | |||
int | channels | |||
) | [inherited] |
Filter callback.
All sound data is passed through this function, which modifies the sample data accordingly to the function of the filter.
The format of the sample data is always 16 bit stereo.
CL_EchoFilterProvider* CL_EchoFilter::get_provider | ( | ) | const |
Retrieves the provider.
Reimplemented from CL_SoundFilter.
bool CL_SoundFilter::is_null | ( | ) | const [inline, inherited] |
Returns true if this object is invalid.
bool CL_SoundFilter::operator!= | ( | const CL_SoundFilter & | other | ) | const [inline, inherited] |
Inequality operator.
References CL_SoundFilter::impl.
bool CL_SoundFilter::operator== | ( | const CL_SoundFilter & | other | ) | const [inline, inherited] |
Equality operator.
References CL_SoundFilter::impl.
void CL_SoundFilter::throw_if_null | ( | ) | const [inherited] |
Throw an exception if this object is invalid.
CL_SharedPtr<CL_SoundFilter_Impl> CL_SoundFilter::impl [inherited] |
Referenced by CL_SoundFilter::operator!=(), and CL_SoundFilter::operator==().