EffectInstanceWithSampleRate Class Reference

Inherit to add a state variable to an EffectInstance subclass. More...

#include <EffectInterface.h>

Inheritance diagram for EffectInstanceWithSampleRate:

Collaboration diagram for EffectInstanceWithSampleRate:

Public Member Functions
	~EffectInstanceWithSampleRate () override
void	SetSampleRate (double rate) override
Public Member Functions inherited from EffectInstance
virtual	~EffectInstance ()
virtual bool	Init ()
	Call once to set up state for whole list of tracks to be processed. More...
virtual bool	Process (EffectSettings &settings)=0
	Actually do the effect here. More...
virtual void	SetSampleRate (double rate)=0
virtual size_t	GetBlockSize () const =0
virtual size_t	SetBlockSize (size_t maxBlockSize)=0
virtual bool	RealtimeInitialize (EffectSettings &settings)
virtual bool	RealtimeAddProcessor (EffectSettings &settings, unsigned numChannels, float sampleRate)
virtual bool	RealtimeSuspend ()
virtual bool	RealtimeResume ()
virtual bool	RealtimeProcessStart (EffectSettings &settings)
	settings are possibly changed, since last call, by an asynchronous dialog More...
virtual size_t	RealtimeProcess (size_t group, EffectSettings &settings, const float *const *inBuf, float *const *outBuf, size_t numSamples)
virtual bool	RealtimeProcessEnd (EffectSettings &settings) noexcept
	settings can be updated to let a dialog change appearance at idle More...
virtual bool	RealtimeFinalize (EffectSettings &settings) noexcept
virtual size_t	GetTailSize () const

Protected Attributes
double	mSampleRate { 0 }

Detailed Description

Inherit to add a state variable to an EffectInstance subclass.

Definition at line 460 of file EffectInterface.h.

Constructor & Destructor Documentation

~EffectInstanceWithSampleRate()

EffectInstanceWithSampleRate::~EffectInstanceWithSampleRate ( )

overridedefault

Member Function Documentation

SetSampleRate()

void EffectInstanceWithSampleRate::SetSampleRate ( double  rate )

overridevirtual

Implements EffectInstance.

Definition at line 180 of file EffectInterface.cpp.

{
   mSampleRate = rate;
}

References mSampleRate.

Member Data Documentation

mSampleRate

double EffectInstanceWithSampleRate::mSampleRate { 0 }

protected

Definition at line 467 of file EffectInterface.h.

Referenced by AudioUnitInstance::AudioUnitInstance(), AudioUnitInstance::GetLatency(), EffectDtmf::Instance::ProcessInitialize(), EffectEcho::Instance::ProcessInitialize(), AudioUnitInstance::SetRateAndChannels(), and SetSampleRate().

---

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

• EffectInterface.h
• EffectInterface.cpp