Audio::FInlineEnvelopeFollower Class Reference

#include <EnvelopeFollower.h>

Inheritance diagram for Audio::FInlineEnvelopeFollower:

Public Member Functions
	FInlineEnvelopeFollower (const FInlineEnvelopeFollowerInitParams &InParams)
	FInlineEnvelopeFollower ()
void	Init (const FInlineEnvelopeFollowerInitParams &InParams)
void	SetMode (EPeakMode::Type InMode)
void	SetAnalysisWindow (float InAnalysisWindowMsec)
float	ProcessSample (float InSample)
void	ProcessBuffer (const float *InSamples, const int32 InNumSamples, float *OutSamples)
void	Reset ()
float	GetValue () const
Public Member Functions inherited from Audio::FAttackRelease
SIGNALPROCESSING_API	FAttackRelease (float InSampleRate, float InAttackTimeMsec, float InReleaseTimeMsec, bool bInIsAnalog)
SIGNALPROCESSING_API void	SetAnalog (bool bInIsAnalog)
SIGNALPROCESSING_API void	SetAttackTime (float InAttackTimeMsec)
SIGNALPROCESSING_API void	SetReleaseTime (float InReleaseTimeMsec)
bool	GetAnalog () const
float	GetAttackTimeSamples () const
float	GetReleaseTimeSamples () const
float	GetAttackTimeMsec () const
float	GetReleaseTimeMsec () const
float	GetSampleRate () const

Additional Inherited Members
Protected Member Functions inherited from Audio::FAttackRelease
SIGNALPROCESSING_API void	SetSampleRate (float InSampleRate)

Detailed Description

FInlineEnvelopeFollower is useful for low sample rate use cases and where samples are only available one at a time. This class is inlined because there are situations where it is needed in a CPU intensive situations.

Constructor & Destructor Documentation

FInlineEnvelopeFollower() [1/2]

Audio::FInlineEnvelopeFollower::FInlineEnvelopeFollower ( const FInlineEnvelopeFollowerInitParams &  InParams )

inline

Construct an envelope follower.

FInlineEnvelopeFollower() [2/2]

Audio::FInlineEnvelopeFollower::FInlineEnvelopeFollower ( )

inline

Member Function Documentation

GetValue()

float Audio::FInlineEnvelopeFollower::GetValue ( ) const

inline

Return the most recent envelope value.

Init()

void Audio::FInlineEnvelopeFollower::Init ( const FInlineEnvelopeFollowerInitParams &  InParams )

inline

Initialize an envelope follower.

ProcessBuffer()

void Audio::FInlineEnvelopeFollower::ProcessBuffer ( const float *  InSamples, const int32  InNumSamples, float *  OutSamples  )

inline

ProcessSample()

float Audio::FInlineEnvelopeFollower::ProcessSample ( float  InSample )

inline

Process a single sample and return the envelope value.

Reset()

void Audio::FInlineEnvelopeFollower::Reset ( )

inline

SetAnalysisWindow()

void Audio::FInlineEnvelopeFollower::SetAnalysisWindow ( float  InAnalysisWindowMsec )

inline

Set the analysis window size (for MeanSquared and RootMeanSquared).

SetMode()

void Audio::FInlineEnvelopeFollower::SetMode ( EPeakMode::Type  InMode )

inline

---

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

• Engine/Source/Runtime/SignalProcessing/Public/DSP/EnvelopeFollower.h