Navigation
API > API/Runtime > API/Runtime/SignalProcessing
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.
| Name | FInlineEnvelopeFollower |
| Type | class |
| Header File | /Engine/Source/Runtime/SignalProcessing/Public/DSP/EnvelopeFollower.h |
| Include Path | #include "DSP/EnvelopeFollower.h" |
Syntax
class FInlineEnvelopeFollower : public Audio::FAttackRelease
Inheritance Hierarchy
- FAttackRelease → FInlineEnvelopeFollower
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| DSP/EnvelopeFollower.h | |||
FInlineEnvelopeFollower
(
const FInlineEnvelopeFollowerInitParams& InParams |
Construct an envelope follower. | DSP/EnvelopeFollower.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AnalysisFilterAlpha | float | DSP/EnvelopeFollower.h | ||
| AnalysisFilterBeta | float | DSP/EnvelopeFollower.h | ||
| AnalysisValue | float | DSP/EnvelopeFollower.h | ||
| AnalysisWindowMsec | float | DSP/EnvelopeFollower.h | ||
| Mode | EPeakMode::Type | DSP/EnvelopeFollower.h | ||
| Value | float | DSP/EnvelopeFollower.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetValue() |
Return the most recent envelope value. | DSP/EnvelopeFollower.h | |
void Init
(
const FInlineEnvelopeFollowerInitParams& InParams |
Initialize an envelope follower. | DSP/EnvelopeFollower.h | |
void ProcessBuffer
(
const float* InSamples, |
DSP/EnvelopeFollower.h | ||
float ProcessSample
(
float InSample |
Process a single sample and return the envelope value. | DSP/EnvelopeFollower.h | |
void Reset() |
DSP/EnvelopeFollower.h | ||
void SetAnalysisWindow
(
float InAnalysisWindowMsec |
Set the analysis window size (for MeanSquared and RootMeanSquared). | DSP/EnvelopeFollower.h | |
void SetMode
(
EPeakMode::Type InMode |
Sets the input analysis mode of the envelope follower | DSP/EnvelopeFollower.h |