Audio Effects Framework
CAudioEffect Class Reference

audio effect base class More...

#include <AudioEffect.h>

Inheritance diagram for CAudioEffect:

Public Types

enum  EffectParam_t {
  kParamGain, kParamPan, kParamDelayInSecs, kParamFeedback,
  kParamModRateInHz, kParamModWidthInSecs, kParamTremoloAmount, kParamCenterFrequency,
  kParamQ, kParamThreshold, kParamSlope, kParamDryWetMix,
  kParamNumFilters, kParamFilterGains, kParamFilterDelays
}
 

Public Member Functions

 CAudioEffect ()
 
 ~CAudioEffect ()
 
Effect_t getEffectType ()
 

Protected Attributes

bool m_bIsInitialized
 true if initialized More...
 
Effect_t m_eEffectType
 audio effect type More...
 
float m_fSampleRateInHz
 sample rate in Hz More...
 
int m_iNumChannels
 number of channels More...
 

Detailed Description

audio effect base class

Member Enumeration Documentation

◆ EffectParam_t

list of parameters used in audio effects

Enumerator
kParamGain 

Parameter for gain of output audio.

kParamPan 

Parameter for pan value of output audio.

kParamDelayInSecs 

Parameter for delay used in delay-based effects.

kParamFeedback 

Parameter for feedback of output audio.

kParamModRateInHz 

Parameter for Modulation Frequency used in modulated effects.

kParamModWidthInSecs 

Parameter Modulation Amplitude used in modulated effects.

kParamTremoloAmount 

Parameter for amount of Tremolo.

kParamCenterFrequency 

Parameter for Center Frequency of a filter.

kParamQ 

Parameter for Q value of a filter.

kParamThreshold 

Parameter for threshold of a Compressor/Expander.

kParamSlope 

Parameter for slope of a Compressor/Expander.

kParamDryWetMix 

Parameter for amount of dry/wet mix in output audio.

kParamNumFilters 

Parameter for number of filters.

kParamFilterGains 

Parameter for number of gains.

kParamFilterDelays 

Parameter for number of delay lines.

Constructor & Destructor Documentation

◆ CAudioEffect()

CAudioEffect::CAudioEffect ( )

◆ ~CAudioEffect()

CAudioEffect::~CAudioEffect ( )

Member Function Documentation

◆ getEffectType()

Effect_t CAudioEffect::getEffectType ( )

return the value of audio effect type

Returns
Effect_t

Member Data Documentation

◆ m_bIsInitialized

bool CAudioEffect::m_bIsInitialized
protected

true if initialized

◆ m_eEffectType

Effect_t CAudioEffect::m_eEffectType
protected

audio effect type

◆ m_fSampleRateInHz

float CAudioEffect::m_fSampleRateInHz
protected

sample rate in Hz

◆ m_iNumChannels

int CAudioEffect::m_iNumChannels
protected

number of channels


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