FInlineEnvelopeFollower

FInlineEnvlepeFollower is useful for low samplerate use cases and where samples are only available one at a time.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FAttackRelease

FInlineEnvelopeFollower

References

Module

SignalProcessing

Header

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

Include

#include "DSP/EnvelopeFollower.h"

Syntax

class FInlineEnvelopeFollower : public Audio::FAttackRelease

Remarks

FInlineEnvlepeFollower is useful for low samplerate use cases and where samples are only available one at a time. This class is inlined becaused there are situations where it is needed in a CPU intensive situations.

Constructors

Name Description

Public function

FInlineEnvelopeFollower()

Public function

FInlineEnvelopeFollower

(
    const FInlineEnvelopeFollowerInitPa...
)

Construct an envelope follower.

Functions

Name Description

Public function Const

float

 

GetValue()

Return the most recent envelope value.

Public function

void

 

Init

(
    const FInlineEnvelopeFollowerInitPa...
)

Initialize an envelope follower.

Public function

float

 

ProcessSample

(
    float InSample
)

Process a single sample and return the envelope value.

Public function

void

 

Reset()

Public function

void

 

SetAnalysisWindow

(
    float InAnalysisWindowMsec
)

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

Public function

void

 

SetMode

(
    EPeakMode::Type InMode
)

Sets the input analysis mode of the envelope follower