CAudioEffectGain Class Reference
audio effect class for gain More...
#include <AudioEffectGain.h>
Inheritance diagram for CAudioEffectGain:
Collaboration diagram for CAudioEffectGain:
Public Member Functions | |
| CAudioEffectGain () | |
| CAudioEffectGain (float fSampleRateInHz, int iNumChannels, EffectParam_t params[]=NULL, float values[]=NULL, int iNumParams=0) | |
| ~CAudioEffectGain () | |
| Error_t | init (float fSampleRateInHz, int iNumChannels, EffectParam_t params[]=NULL, float values[]=NULL, int iNumParams=0) |
| Error_t | reset () |
| Error_t | setParam (EffectParam_t eParam, float fValue) |
| float | getParam (EffectParam_t eParam) |
| Error_t | process (float **ppfInputBuffer, float **ppfOutputBuffer, int iNumberOfFrames) |
 Public Member Functions inherited from CAudioEffect | |
| CAudioEffect () | |
| ~CAudioEffect () | |
| Effect_t | getEffectType () |
Protected Attributes | |
| float | m_fGain |
| amount of gain, 0<gain<1 More... | |
| Protected Attributes inherited from CAudioEffect | |
| 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... | |
Additional Inherited Members | |
| Public Types inherited from CAudioEffect | |
| enum | EffectParam_t { kParamGain, kParamPan, kParamDelayInSecs, kParamFeedback, kParamModRateInHz, kParamModWidthInSecs, kParamTremoloAmount, kParamCenterFrequency, kParamQ, kParamThreshold, kParamSlope, kParamDryWetMix, kParamNumFilters, kParamFilterGains, kParamFilterDelays } |
Detailed Description
audio effect class for gain
Constructor & Destructor Documentation
◆ CAudioEffectGain() [1/2]
| CAudioEffectGain::CAudioEffectGain | ( | ) |
◆ CAudioEffectGain() [2/2]
| CAudioEffectGain::CAudioEffectGain | ( | float | fSampleRateInHz, |
| int | iNumChannels, | ||
| EffectParam_t | params[] = NULL, |
||
| float | values[] = NULL, |
||
| int | iNumParams = 0 |
||
| ) |
◆ ~CAudioEffectGain()
| CAudioEffectGain::~CAudioEffectGain | ( | ) |
Member Function Documentation
◆ getParam()
| float CAudioEffectGain::getParam | ( | EffectParam_t | eParam | ) |
return the value of the specified parameter
- Parameters
-
eParam
- Returns
- float
◆ init()
| Error_t CAudioEffectGain::init | ( | float | fSampleRateInHz, |
| int | iNumChannels, | ||
| EffectParam_t | params[] = NULL, |
||
| float | values[] = NULL, |
||
| int | iNumParams = 0 |
||
| ) |
initializes a gain instance
- Parameters
-
fSampleRateInHz sample rate in Hz iNumChannels number of audio channels params[] list of parameter types values[] list of parameter values iNumParams number of parameters
- Returns
- Error_t
◆ process()
| Error_t CAudioEffectGain::process | ( | float ** | ppfInputBuffer, |
| float ** | ppfOutputBuffer, | ||
| int | iNumberOfFrames | ||
| ) |
processes one block of audio
- Parameters
-
ppfInputBuffer input buffer [numChannels][iNumberOfFrames] ppfOutputBuffer output buffer [numChannels][iNumberOfFrames] iNumberOfFrames buffer length (per channel)
- Returns
- Error_t
◆ reset()
| Error_t CAudioEffectGain::reset | ( | ) |
resets the internal variables (requires new call of init)
- Returns
- Error_t
◆ setParam()
| Error_t CAudioEffectGain::setParam | ( | EffectParam_t | eParam, |
| float | fValue | ||
| ) |
sets a gain parameter
- Parameters
-
eParam what parameter fValue value of the parameter
- Returns
- Error_t
Member Data Documentation
◆ m_fGain
|
protected |
amount of gain, 0<gain<1
The documentation for this class was generated from the following files:
- src/inc/AudioEffectGain.h
- src/AudioEffect/AudioEffectGain.cpp
