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

#include <Delay.h>

+ Inheritance diagram for Audio::FDelay:

Public Member Functions

SIGNALPROCESSING_API FDelay ()
 
virtual SIGNALPROCESSING_API ~FDelay ()
 
SIGNALPROCESSING_API void Init (const float InSampleRate, const float InBufferLengthSec=2.0f)
 
SIGNALPROCESSING_API void Reset ()
 
SIGNALPROCESSING_API void ResetWithFade ()
 
SIGNALPROCESSING_API void SetDelayMsec (const float InDelayMsec)
 
SIGNALPROCESSING_API void SetDelaySamples (const float InDelaySamples)
 
SIGNALPROCESSING_API void SetEasedDelayMsec (const float InDelayMsec, const bool bIsInit=false)
 
SIGNALPROCESSING_API void SetEaseFactor (const float InEaseFactor)
 
SIGNALPROCESSING_API void SetOutputAttenuationDB (const float InDelayAttenDB)
 
float GetDelayLengthSamples () const
 
SIGNALPROCESSING_API float Read () const
 
SIGNALPROCESSING_API float ReadDelayAt (const float InReadMsec) const
 
SIGNALPROCESSING_API void WriteDelayAndInc (const float InDelayInput)
 
virtual SIGNALPROCESSING_API float ProcessAudioSample (const float InAudio)
 
virtual SIGNALPROCESSING_API void ProcessAudioBuffer (const float *InAudio, int32 InNumSamples, float *OutAudio)
 

Protected Member Functions

SIGNALPROCESSING_API void Update (bool bForce=false)
 
SIGNALPROCESSING_API void ResizeIfNeeded (const int32 InNewNumSamples)
 

Protected Attributes

FAlignedFloatBuffer AudioBuffer
 
int32 AudioBufferSize
 
int32 ReadIndex
 
int32 WriteIndex
 
float SampleRate
 
float DelayInSamples
 
int32 MaxBufferLengthSamples
 
FExponentialEase EaseDelayMsec
 
float OutputAttenuation
 
float OutputAttenuationDB
 

Constructor & Destructor Documentation

◆ FDelay()

Audio::FDelay::FDelay ( )

◆ ~FDelay()

Audio::FDelay::~FDelay ( )
virtualdefault

Member Function Documentation

◆ GetDelayLengthSamples()

float Audio::FDelay::GetDelayLengthSamples ( ) const
inline

◆ Init()

void Audio::FDelay::Init ( const float  InSampleRate,
const float  InBufferLengthSec = 2.0f 
)

◆ ProcessAudioBuffer()

void Audio::FDelay::ProcessAudioBuffer ( const float InAudio,
int32  InNumSamples,
float OutAudio 
)
virtual

◆ ProcessAudioSample()

float Audio::FDelay::ProcessAudioSample ( const float  InAudio)
virtual

Reimplemented in Audio::FDelayAPF.

◆ Read()

float Audio::FDelay::Read ( ) const

◆ ReadDelayAt()

float Audio::FDelay::ReadDelayAt ( const float  InReadMsec) const

◆ Reset()

void Audio::FDelay::Reset ( )

◆ ResetWithFade()

void Audio::FDelay::ResetWithFade ( )

◆ ResizeIfNeeded()

void Audio::FDelay::ResizeIfNeeded ( const int32  InNewNumSamples)
protected

◆ SetDelayMsec()

void Audio::FDelay::SetDelayMsec ( const float  InDelayMsec)

◆ SetDelaySamples()

void Audio::FDelay::SetDelaySamples ( const float  InDelaySamples)

◆ SetEasedDelayMsec()

void Audio::FDelay::SetEasedDelayMsec ( const float  InDelayMsec,
const bool  bIsInit = false 
)

◆ SetEaseFactor()

void Audio::FDelay::SetEaseFactor ( const float  InEaseFactor)

◆ SetOutputAttenuationDB()

void Audio::FDelay::SetOutputAttenuationDB ( const float  InDelayAttenDB)

◆ Update()

void Audio::FDelay::Update ( bool  bForce = false)
protected

◆ WriteDelayAndInc()

void Audio::FDelay::WriteDelayAndInc ( const float  InDelayInput)

Member Data Documentation

◆ AudioBuffer

FAlignedFloatBuffer Audio::FDelay::AudioBuffer
protected

◆ AudioBufferSize

int32 Audio::FDelay::AudioBufferSize
protected

◆ DelayInSamples

float Audio::FDelay::DelayInSamples
protected

◆ EaseDelayMsec

FExponentialEase Audio::FDelay::EaseDelayMsec
protected

◆ MaxBufferLengthSamples

int32 Audio::FDelay::MaxBufferLengthSamples
protected

◆ OutputAttenuation

float Audio::FDelay::OutputAttenuation
protected

◆ OutputAttenuationDB

float Audio::FDelay::OutputAttenuationDB
protected

◆ ReadIndex

int32 Audio::FDelay::ReadIndex
protected

◆ SampleRate

float Audio::FDelay::SampleRate
protected

◆ WriteIndex

int32 Audio::FDelay::WriteIndex
protected

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