#include <soundfilter.h>
Public Member Functions | |
SoundFilter () | |
Constructs a NULL instance. | |
SoundFilter (SoundFilterProvider *provider) | |
Constructs a sound filter. | |
~SoundFilter () | |
void | filter (float **sample_data, int num_samples, int channels) |
Filter callback. | |
SoundFilterProvider * | get_provider () const |
Retrieves the provider. | |
bool | is_null () const |
Returns true if this object is invalid. | |
bool | operator!= (const SoundFilter &other) const |
Inequality operator. | |
bool | operator== (const SoundFilter &other) const |
Equality operator. | |
void | throw_if_null () const |
Throw an exception if this object is invalid. | |
Public Attributes | |
std::shared_ptr< SoundFilter_Impl > | impl |
Sound Filter Class.
|
inline |
Constructs a NULL instance.
Referenced by operator!=(), and operator==().
clan::SoundFilter::SoundFilter | ( | SoundFilterProvider * | provider | ) |
Constructs a sound filter.
provider | = The provider |
clan::SoundFilter::~SoundFilter | ( | ) |
void clan::SoundFilter::filter | ( | float ** | sample_data, |
int | num_samples, | ||
int | channels ) |
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.
SoundFilterProvider * clan::SoundFilter::get_provider | ( | ) | const |
Retrieves the provider.
|
inline |
Returns true if this object is invalid.
References impl.
|
inline |
Inequality operator.
References SoundFilter(), and impl.
|
inline |
Equality operator.
References SoundFilter(), and impl.
void clan::SoundFilter::throw_if_null | ( | ) | const |
Throw an exception if this object is invalid.
std::shared_ptr<SoundFilter_Impl> clan::SoundFilter::impl |
Referenced by is_null(), operator!=(), and operator==().