CAudioEffectDelay Class Reference

audio effect class for delay related effects More...

#include <AudioEffectDelay.h>

Inheritance diagram for CAudioEffectDelay:

Collaboration diagram for CAudioEffectDelay:

Public Types
enum	DelayType_t {   kBasicDelay = 16, kChorus = 18, kFlanger = 21, kTremolo = 8,   kVibrato = 2 }
Public Types inherited from CAudioEffect
enum	EffectParam_t {   kParamGain, kParamPan, kParamDelayInSecs, kParamFeedback,   kParamModRateInHz, kParamModWidthInSecs, kParamTremoloAmount, kParamCenterFrequency,   kParamQ, kParamThreshold, kParamSlope, kParamDryWetMix,   kParamNumFilters, kParamFilterGains, kParamFilterDelays }

Public Member Functions
	CAudioEffectDelay ()
	CAudioEffectDelay (float fSampleRateInHz, int iNumChannels, DelayType_t subType=kBasicDelay, float iMaxDelayInSec=1.f, EffectParam_t params[]=NULL, float values[]=NULL, int iNumParams=0)
	~CAudioEffectDelay ()
Error_t	init (float fSampleRateInHz, int iNumChannels, DelayType_t subType=kBasicDelay, float iMaxDelayInSec=1.f, 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	setDelayType (DelayType_t eValue)
DelayType_t	getDelayType ()
Error_t	process (float **ppfInputBuffer, float **ppfOutputBuffer, int iNumberOfFrames)
Public Member Functions inherited from CAudioEffect
	CAudioEffect ()
	~CAudioEffect ()
Effect_t	getEffectType ()

Additional Inherited Members
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...

Detailed Description

audio effect class for delay related effects

Member Enumeration Documentation

DelayType_t

enum CAudioEffectDelay::DelayType_t

list of delay related effect sub types

Enumerator
kBasicDelay
kChorus
kFlanger
kTremolo
kVibrato

Constructor & Destructor Documentation

CAudioEffectDelay() [1/2]

CAudioEffectDelay::CAudioEffectDelay

(

)

CAudioEffectDelay() [2/2]

CAudioEffectDelay::CAudioEffectDelay	(	float	fSampleRateInHz,
		int	iNumChannels,
		DelayType_t	subType = kBasicDelay,
		float	iMaxDelayInSec = 1.f,
		EffectParam_t	params[] = NULL,
		float	values[] = NULL,
		int	iNumParams = 0
	)

~CAudioEffectDelay()

CAudioEffectDelay::~CAudioEffectDelay

(

)

Member Function Documentation

getDelayType()

CAudioEffectDelay::DelayType_t CAudioEffectDelay::getDelayType

(

)

return the value of the specified sub type

Returns

DelayType_t

getParam()

float CAudioEffectDelay::getParam

(

EffectParam_t

eParam

)

return the value of the specified parameter

Parameters

eParam

Returns

float

init()

Error_t CAudioEffectDelay::init	(	float	fSampleRateInHz,
		int	iNumChannels,
		DelayType_t	subType = kBasicDelay,
		float	iMaxDelayInSec = 1.f,
		EffectParam_t	params[] = NULL,
		float	values[] = NULL,
		int	iNumParams = 0
	)

initializes a delay related effect instance

Parameters

fSampleRateInHz	sample rate in Hz
iNumChannels	number of audio channels
iMaxDelayInSec	max delay length in seconds
params[]	list of parameter types
values[]	list of parameter values
iNumParams	number of parameters

Returns

Error_t

process()

Error_t CAudioEffectDelay::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 CAudioEffectDelay::reset

(

)

resets the internal variables (requires new call of init)

Returns

Error_t

setDelayType()

Error_t CAudioEffectDelay::setDelayType

(

DelayType_t

eValue

)

sets a delay related effect sub type

Parameters

eValue

value of the sub type

Returns

Error_t

setParam()

Error_t CAudioEffectDelay::setParam	(	EffectParam_t	eParam,
		float	fValue
	)

sets a delay related effect parameter

Parameters

eParam	what parameter
fValue	value of the parameter

Returns

Error_t

---

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

• src/inc/AudioEffectDelay.h
• src/AudioEffect/AudioEffectDelay.cpp