1. Epic GamesDeveloper
  3. FDelay

FDelay

Circular Buffer Delay Line.

API > API/Runtime > API/Runtime/SignalProcessing

Circular Buffer Delay Line.

   
Name FDelay
Type class
Header File /Engine/Source/Runtime/SignalProcessing/Public/DSP/Delay.h
Include Path #include "DSP/Delay.h"

Syntax

class FDelay

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FDelay()

 Constructor. DSP/Delay.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FDelay()

 Virtual Destructor. DSP/Delay.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
InputAttenuation float Used to do a quick fade-in of input after a call to "ResetWithFade()". DSP/Delay.h  
InputFadeGainStep float   DSP/Delay.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

float GetDelayLengthSamples()

 Returns the current delay line length (in samples). DSP/Delay.h  

void Init ( const float InSampleRate,
const float InBufferLengthSec
)

 Initialization of the delay with given sample rate and max buffer size in samples. (calls Reset()) DSP/Delay.h  

virtual void ProcessAudioBuffer ( const float* InAudio,
int32 InNumSamples,
float* OutAudio
)

   DSP/Delay.h  

virtual float ProcessAudioSample ( const float InAudio
)

 Process audio in the delay line, return the delayed value. DSP/Delay.h  

float Read()

 Reads the delay line at current read index without writing or incrementing read/write pointers. DSP/Delay.h  

float ReadDelayAt ( const float InReadMsec
) const

 Reads the delay line at an arbitrary time in Msec without writing or incrementing read/write pointers. DSP/Delay.h  

void Reset()

 Resets the delay line state, flushes buffer and resets read/write pointers. (called by Init()) DSP/Delay.h  

void ResetWithFade()

   DSP/Delay.h  

void SetDelayMsec ( const float InDelayMsec
)

 Sets the delay line length. Will clamp to within range of the max initialized delay line length (won't resize). DSP/Delay.h  

void SetDelaySamples ( const float InDelaySamples
)

 Same as SetDelayMsec, except in samples. DSP/Delay.h  

void SetEasedDelayMsec ( const float InDelayMsec,
const bool bIsInit
)

 Sets the delay line length but using the internal easing function for smooth delay line interpolation. DSP/Delay.h  

void SetEaseFactor ( const float InEaseFactor
)

 Sets the easing factor for the delay line's internal exponential interpolator. DSP/Delay.h  

void SetOutputAttenuationDB ( const float InDelayAttenDB
)

 Sets the output attenuation in DB. DSP/Delay.h  

void WriteDelayAndInc ( const float InDelayInput
)

 Write the input and increment read/write pointers. DSP/Delay.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ResizeIfNeeded ( const int32 InNewNumSamples
)

 Updates delay line based on any recent changes to settings. DSP/Delay.h  

void Update ( bool bForce
)

 Updates delay line based on any recent changes to settings. DSP/Delay.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page