UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
Audio::FAttackReleaseSmoother Class Reference

#include <EnvelopeFollower.h>

+ Inheritance diagram for Audio::FAttackReleaseSmoother:

Public Member Functions

SIGNALPROCESSING_API FAttackReleaseSmoother (float InSampleRate, int32 InNumChannels, float InAttackTimeMsec, float InReleaseTimeMsec, bool bInIsAnalog)
 
SIGNALPROCESSING_API void ProcessAudio (const float *InBuffer, int32 InNumFrames)
 
SIGNALPROCESSING_API void ProcessAudio (const float *InBuffer, int32 InNumFrames, float *OutBuffer)
 
SIGNALPROCESSING_API const TArray< float > & GetEnvelopeValues () const
 
SIGNALPROCESSING_API void SetNumChannels (int32 InNumChannels)
 
SIGNALPROCESSING_API void Reset ()
 
- 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

Smooths signals using attack and release settings.

Constructor & Destructor Documentation

◆ FAttackReleaseSmoother()

Audio::FAttackReleaseSmoother::FAttackReleaseSmoother ( float  InSampleRate,
int32  InNumChannels,
float  InAttackTimeMsec,
float  InReleaseTimeMsec,
bool  bInIsAnalog 
)

Construct an FAttackReleaseSmoother.

Parameters
InSampleRate- The number of samples per a second of incoming data.
InNumChannels- The number of input channels.
InAttackTimeMsec- The desired attack time in milliseconds.
InReleaseTimeMsec- The desired release time in milliseconds.
bInIsAnalog- Whether to model analog RC circuits or use digital models.

Member Function Documentation

◆ GetEnvelopeValues()

const TArray< float > & Audio::FAttackReleaseSmoother::GetEnvelopeValues ( ) const

Retrieve the final values of the envelope for each channel.

◆ ProcessAudio() [1/2]

void Audio::FAttackReleaseSmoother::ProcessAudio ( const float *  InBuffer,
int32  InNumFrames 
)

Process channel interleaved data.

Parameters
InBuffer- Interleaved channel data.
InNumFrames- Number of frames in InBuffer.

◆ ProcessAudio() [2/2]

void Audio::FAttackReleaseSmoother::ProcessAudio ( const float *  InBuffer,
int32  InNumFrames,
float *  OutBuffer 
)

Process channel interleaved data.

Parameters
InBuffer- Interleaved input data.
InNumFrames- Number of frames in InBuffer.
OutBuffer- Output interleaved envelope data. Should be same size as InBuffer.

◆ Reset()

void Audio::FAttackReleaseSmoother::Reset ( )

◆ SetNumChannels()

void Audio::FAttackReleaseSmoother::SetNumChannels ( int32  InNumChannels)

Set the number of input channels

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