CL_SoundFilter Class Reference
[clanSound Audio Mixing]

Sound Filter Class. More...

#include <soundfilter.h>

Inheritance diagram for CL_SoundFilter:

List of all members.

Public Member Functions
Construction
	CL_SoundFilter ()
	Constructs a NULL sound filter.
	CL_SoundFilter (CL_SoundFilterProvider *provider)
	Constructs a sound filter.
	CL_SoundFilter (const CL_SoundFilter &copy)
	Constructs a SoundFilter.
	~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 ()
	Is Null.
CL_SoundFilterProvider *	get_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 sound filter.

CL_SoundFilter::CL_SoundFilter (  CL_SoundFilterProvider *  provider  )

Constructs a sound filter. Parameters: provider  = The provider

CL_SoundFilter::CL_SoundFilter (  const CL_SoundFilter &  copy  )

Constructs a SoundFilter. Parameters: copy  = Sound Filter

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 (   )

Is Null. Returns: true = null

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

Inequality operator.

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

Equality operator.

---

Member Data Documentation

CL_SharedPtr<CL_SoundFilter_Impl> CL_SoundFilter::impl

---

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

• soundfilter.h

---