Sound Filter Class. More...

#include <soundfilter.h>

+ Inheritance diagram for clan::SoundFilter:

Public Member Functions

 SoundFilter ()
 Constructs a NULL instance. More...
 
 SoundFilter (SoundFilterProvider *provider)
 Constructs a sound filter. More...
 
 ~SoundFilter ()
 
void filter (float **sample_data, int num_samples, int channels)
 Filter callback. More...
 
SoundFilterProviderget_provider () const
 Retrieves the provider. More...
 
bool is_null () const
 Returns true if this object is invalid. More...
 
bool operator!= (const SoundFilter &other) const
 Inequality operator. More...
 
bool operator== (const SoundFilter &other) const
 Equality operator. More...
 
void throw_if_null () const
 Throw an exception if this object is invalid. More...
 

Public Attributes

std::shared_ptr< SoundFilter_Impl > impl
 

Detailed Description

Sound Filter Class.

Constructor & Destructor Documentation

clan::SoundFilter::SoundFilter ( )
inline

Constructs a NULL instance.

clan::SoundFilter::SoundFilter ( SoundFilterProvider provider)

Constructs a sound filter.

Parameters
provider= The provider
clan::SoundFilter::~SoundFilter ( )

Member Function Documentation

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.

bool clan::SoundFilter::is_null ( ) const
inline

Returns true if this object is invalid.

References impl.

bool clan::SoundFilter::operator!= ( const SoundFilter other) const
inline

Inequality operator.

References impl.

bool clan::SoundFilter::operator== ( const SoundFilter other) const
inline

Equality operator.

References impl.

void clan::SoundFilter::throw_if_null ( ) const

Throw an exception if this object is invalid.

Member Data Documentation

std::shared_ptr<SoundFilter_Impl> clan::SoundFilter::impl

Referenced by is_null(), operator!=(), and operator==().


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