Navigation
API > API/Runtime > API/Runtime/SignalProcessing
A simple utility that returns a smoothed value given audio input using an RC circuit. Used for following the envelope of an audio stream.
| Name | FEnvelopeFollower |
| Type | class |
| Header File | /Engine/Source/Runtime/SignalProcessing/Public/DSP/EnvelopeFollower.h |
| Include Path | #include "DSP/EnvelopeFollower.h" |
Syntax
class FEnvelopeFollower
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FEnvelopeFollower
(
const FEnvelopeFollowerInitParams& InParams |
Construct an envelope follower. | DSP/EnvelopeFollower.h | |
| Construct an envelope follower. | DSP/EnvelopeFollower.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| EnvMode | EPeakMode::Type | DSP/EnvelopeFollower.h | ||
| MeanSquaredProcessor | FMeanSquaredIIR | DSP/EnvelopeFollower.h | ||
| NumChannels | int32 | DSP/EnvelopeFollower.h | ||
| Smoother | FAttackReleaseSmoother | DSP/EnvelopeFollower.h | ||
| WorkBuffer | FAlignedFloatBuffer | DSP/EnvelopeFollower.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetAnalog() |
Returns whether or not to use analog or digital time constants | DSP/EnvelopeFollower.h | |
float GetAttackTimeMsec() |
Returns the envelope follower attack time (how fast the envelope responds to input) | DSP/EnvelopeFollower.h | |
const TArray< float > & GetEnvelopeValues() |
Retrieve the final values of the envelope for each channel. | DSP/EnvelopeFollower.h | |
EPeakMode::Type GetMode() |
Returns the input mode of the envelope follower | DSP/EnvelopeFollower.h | |
int32 GetNumChannels() |
Returns the number of channels per an input frame | DSP/EnvelopeFollower.h | |
float GetReleaseTimeMsec() |
Returns the envelope follower release time (how slow the envelope dampens from input) | DSP/EnvelopeFollower.h | |
float GetSampleRate() |
Returns the number of frames per a second set on initialization | DSP/EnvelopeFollower.h | |
void Init
(
const FEnvelopeFollowerInitParams& InParams |
Initialize the envelope follower. | DSP/EnvelopeFollower.h | |
void ProcessAudio
(
const float* InBuffer, |
Calculate envelope per sample. | DSP/EnvelopeFollower.h | |
void ProcessAudio
(
const float* InBuffer, |
Calculate envelope | DSP/EnvelopeFollower.h | |
void Reset() |
Resets the state of the envelope follower | DSP/EnvelopeFollower.h | |
void SetAnalog
(
bool bInIsAnalog |
Sets whether or not to use analog or digital time constants | DSP/EnvelopeFollower.h | |
void SetAttackTime
(
float InAttackTimeMsec |
Sets the envelope follower attack time (how fast the envelope responds to input) | DSP/EnvelopeFollower.h | |
void SetMode
(
EPeakMode::Type InMode |
Sets the input mode of the envelope follower | DSP/EnvelopeFollower.h | |
void SetNumChannels
(
int32 InNumChannels |
Set the number of channels per an input frame. | DSP/EnvelopeFollower.h | |
void SetReleaseTime
(
float InReleaseTimeMsec |
Sets the envelope follower release time (how slow the envelope dampens from input) | DSP/EnvelopeFollower.h |