clanSound Filters

Classes

class  clan::EchoFilter
 Echo Filter Class. More...
 
class  clan::FadeFilter
 Fade Filter Class. More...
 
class  clan::InverseEchoFilter
 Inverse Echo Filter Class. More...
 

Construction

 clan::EchoFilter::EchoFilter (int buffer_size=32 *1024, float shift_factor=2.0f)
 Echo Filter Constructor. More...
 
virtual clan::EchoFilter::~EchoFilter ()
 Echo Filter Destructor. More...
 

Operations

EchoFilterProvider * clan::EchoFilter::get_provider () const
 Retrieves the provider. More...
 

Construction

 clan::FadeFilter::FadeFilter (float initial_volume)
 Fade Filter Constructor. More...
 
virtual clan::FadeFilter::~FadeFilter ()
 Fade Filter Destructor. More...
 

Attributes

float clan::FadeFilter::get_volume () const
 Returns the current volume of the fade filter, from 0.0f (no volume) to 1.0f (full volume). More...
 

Operations

FadeFilterProvider * clan::FadeFilter::get_provider () const
 Retrieves the provider. More...
 
void clan::FadeFilter::set_volume (float new_volume)
 Sets the volume instant. More...
 
void clan::FadeFilter::fade_to_volume (float new_volume, int duration=1000)
 Fade to volume, from 0.0f (no volume) to 1.0f (full volume). More...
 

Construction

 clan::InverseEchoFilter::InverseEchoFilter (int buffer_size=64 *1024)
 Inverse Echo Filter Constructor. More...
 
virtual clan::InverseEchoFilter::~InverseEchoFilter ()
 Inverse Echo Filter Destructor. More...
 

Operations

InverseEchoFilterProvider * clan::InverseEchoFilter::get_provider () const
 Retrieves the provider. More...
 

Detailed Description

Function Documentation

◆ EchoFilter()

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

Echo Filter Constructor.

◆ FadeFilter()

clan::FadeFilter::FadeFilter ( float  initial_volume)

Fade Filter Constructor.

◆ InverseEchoFilter()

clan::InverseEchoFilter::InverseEchoFilter ( int  buffer_size = 64 *1024)

Inverse Echo Filter Constructor.

◆ ~EchoFilter()

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

Echo Filter Destructor.

◆ ~FadeFilter()

virtual clan::FadeFilter::~FadeFilter ( )
virtual

Fade Filter Destructor.

◆ ~InverseEchoFilter()

virtual clan::InverseEchoFilter::~InverseEchoFilter ( )
virtual

Inverse Echo Filter Destructor.

◆ fade_to_volume()

void clan::FadeFilter::fade_to_volume ( float  new_volume,
int  duration = 1000 
)

Fade to volume, from 0.0f (no volume) to 1.0f (full volume).

◆ get_provider() [1/3]

InverseEchoFilterProvider* clan::InverseEchoFilter::get_provider ( ) const

Retrieves the provider.

◆ get_provider() [2/3]

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

Retrieves the provider.

◆ get_provider() [3/3]

FadeFilterProvider* clan::FadeFilter::get_provider ( ) const

Retrieves the provider.

◆ get_volume()

float clan::FadeFilter::get_volume ( ) const

Returns the current volume of the fade filter, from 0.0f (no volume) to 1.0f (full volume).

◆ set_volume()

void clan::FadeFilter::set_volume ( float  new_volume)

Sets the volume instant.