Audacity 3.2.0
Public Member Functions | Protected Attributes | List of all members
EffectInstanceWithSampleRate Class Reference

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

#include <EffectInterface.h>

Inheritance diagram for EffectInstanceWithSampleRate:
[legend]
Collaboration diagram for EffectInstanceWithSampleRate:
[legend]

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 () noexcept
 
virtual bool RealtimeProcessStart (EffectSettings &settings)
 settings are possibly changed, since last call, by an asynchronous dialog More...
 
virtual size_t RealtimeProcess (int 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 444 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 171 of file EffectInterface.cpp.

172{
173 mSampleRate = rate;
174}

References mSampleRate.

Member Data Documentation

◆ mSampleRate

double EffectInstanceWithSampleRate::mSampleRate { 0 }
protected

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