Navigation
API > API/Runtime > API/Runtime/SignalProcessing > API/Runtime/SignalProcessing/DSP
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
| Type | Name | Description | |
|---|---|---|---|
 |
|||
 |
FInlineEnvelopeFollower
(
const FInlineEnvelopeFollowerInitParams& InParams |
Construct an envelope follower. |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
float | GetValue () |
Return the most recent envelope value. |
 |
void | Init
(
const FInlineEnvelopeFollowerInitParams& InParams |
Initialize an envelope follower. |
 |
float | ProcessSample
(
float InSample |
Process a single sample and return the envelope value. |
 |
void | Reset () |
|
 |
void | SetAnalysisWindow
(
float InAnalysisWindowMsec |
Set the analysis window size (for MeanSquared and RootMeanSquared). |
 |
void | SetMode
(
EPeakMode::Type InMode |
Sets the input analysis mode of the envelope follower |