clan::EchoFilter Class Reference - ClanLib SDK
Description: clan::EchoFilter Class Reference

Public Member Functions | List of all members
clan::EchoFilter Class Reference
clanSound Filters

Echo Filter Class. More...

`#include <echofilter.h>`

Inheritance diagram for clan::EchoFilter:

## Public Member Functions
| EchoFilter (int buffer_size=32 *1024, float shift_factor=2.0f)
| Echo Filter Constructor.
virtual | ~EchoFilter ()
| Echo Filter Destructor.
EchoFilterProvider * | get_provider () const
| Retrieves the provider.
Public Member Functions inherited from clan::SoundFilter
| 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.

## Additional Inherited Members
Public Attributes inherited from clan::SoundFilter
std::shared_ptr< SoundFilter_Impl > | impl

## Detailed Description

Echo Filter Class.

## Constructor & Destructor Documentation

## ◆ EchoFilter()

clan::EchoFilter::EchoFilter | ( | int | buffer_size = 32 *1024,
|  | float | shift_factor = 2.0f )

Echo Filter Constructor.

## ◆ ~EchoFilter()

virtual clan::EchoFilter::~EchoFilter | ( |  | ) |
| virtual

Echo Filter Destructor.

## Member Function Documentation

## ◆ get_provider()

EchoFilterProvider * clan::EchoFilter::get_provider | ( |  | ) | const

Retrieves the provider.

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

- echofilter.h