CL_SoundFilter Class Reference
[clanSound Audio Mixing]

Sound Filter Class. More...

#include <soundfilter.h>

Inheritance diagram for CL_SoundFilter:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Construction

 CL_SoundFilter ()
 Constructs a NULL instance.
 CL_SoundFilter (CL_SoundFilterProvider *provider)
 Constructs a sound filter.
 ~CL_SoundFilter ()
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.
CL_SoundFilterProviderget_provider () const
 Retrieves the provider.
void filter (float **sample_data, int num_samples, int channels)
 Filter callback.

Public Attributes

Implementation

CL_SharedPtr< CL_SoundFilter_Impl > impl

Detailed Description

Sound Filter Class.


Constructor & Destructor Documentation

CL_SoundFilter::CL_SoundFilter (  )  [inline]

Constructs a NULL instance.

CL_SoundFilter::CL_SoundFilter ( CL_SoundFilterProvider provider  ) 

Constructs a sound filter.

Parameters:
provider = The provider
CL_SoundFilter::~CL_SoundFilter (  ) 

Member Function Documentation

void CL_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.

CL_SoundFilterProvider* CL_SoundFilter::get_provider (  )  const

Retrieves the provider.

Reimplemented in CL_EchoFilter, CL_FadeFilter, and CL_InverseEchoFilter.

bool CL_SoundFilter::is_null (  )  const [inline]

Returns true if this object is invalid.

bool CL_SoundFilter::operator!= ( const CL_SoundFilter other  )  const [inline]

Inequality operator.

References impl.

bool CL_SoundFilter::operator== ( const CL_SoundFilter other  )  const [inline]

Equality operator.

References impl.

void CL_SoundFilter::throw_if_null (  )  const

Throw an exception if this object is invalid.


Member Data Documentation

CL_SharedPtr<CL_SoundFilter_Impl> CL_SoundFilter::impl

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


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