UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::FAttackRelease Class Reference

#include <EnvelopeFollower.h>

+ Inheritance diagram for Audio::FAttackRelease:

Public Member Functions

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
 

Protected Member Functions

SIGNALPROCESSING_API void SetSampleRate (float InSampleRate)
 

Detailed Description

Conversion between attack/release time and attack/release sample counts.

Constructor & Destructor Documentation

◆ FAttackRelease()

Audio::FAttackRelease::FAttackRelease ( float  InSampleRate,
float  InAttackTimeMsec,
float  InReleaseTimeMsec,
bool  bInIsAnalog 
)

Construct an FAttackRelease object.

Parameters
InSampleRate- The number of frames per a second.
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

◆ GetAnalog()

bool Audio::FAttackRelease::GetAnalog ( ) const
inline

Get whether set to analog or digital time constant. (True is analog, false is digital)

◆ GetAttackTimeMsec()

float Audio::FAttackRelease::GetAttackTimeMsec ( ) const
inline

Get the attack time in milliseconds.

◆ GetAttackTimeSamples()

float Audio::FAttackRelease::GetAttackTimeSamples ( ) const
inline

Get the attack time in samples.

◆ GetReleaseTimeMsec()

float Audio::FAttackRelease::GetReleaseTimeMsec ( ) const
inline

Get the release time in milliseconds.

◆ GetReleaseTimeSamples()

float Audio::FAttackRelease::GetReleaseTimeSamples ( ) const
inline

Get the release time in samples.

◆ GetSampleRate()

float Audio::FAttackRelease::GetSampleRate ( ) const
inline

Get the sample rate.

◆ SetAnalog()

void Audio::FAttackRelease::SetAnalog ( bool  bInIsAnalog)

◆ SetAttackTime()

void Audio::FAttackRelease::SetAttackTime ( float  InAttackTimeMsec)

◆ SetReleaseTime()

void Audio::FAttackRelease::SetReleaseTime ( float  InReleaseTimeMsec)

◆ SetSampleRate()

void Audio::FAttackRelease::SetSampleRate ( float  InSampleRate)
protected

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