Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > SignalProcessing > DSP > FDelay

Light Theme

Dark Theme

FDelay

Circular Buffer Delay Line.

Windows

MacOS

Linux

Inheritance Hierarchy

FDelay

FDelayAPF

References

Module	SignalProcessing
Header	/Engine/Source/Runtime/SignalProcessing/Public/DSP/Delay.h
Include	#include "DSP/Delay.h"

Syntax

class FDelay

Remarks

Circular Buffer Delay Line.

Variables

	Name	Description
float *	AudioBuffer	Pointer to the circular buffer of audio.
int32	AudioBufferSize	Max length of buffer (in samples)
float	DelayInSamples	Delay in samples; float supports fractional delay.
FExponentialEas...	EaseDelayMsec	Eased delay in msec.
float	OutputAttenuation	Output attenuation value.
float	OutputAttenuationDB	Attenuation in decibel.
int32	ReadIndex	Read index for circular buffer.
float	SampleRate	Sample rate.
int32	WriteIndex	Write index for circular buffer.

Constructors

	Name	Description
	FDelay()	Constructor.

Destructors

	Name	Description
	~FDelay()	Virtual Destructor.

Functions

	Name	Description
float	GetDelayLengthSamples()	Returns the current delay line length (in samples).
void	Init ( const float InSampleRate, const float InBufferLengthSec )	Initialization of the delay with given sample rate and max buffer size in samples.
float	ProcessAudioSample ( const float InAudio )	Process audio in the delay line, return the delayed value.
float	Read()	Reads the delay line at current read index without writing or incrementing read/write pointers.
float	ReadDelayAt ( const float InReadMsec )	Reads the delay line at an arbitrary time in Msec without writing or incrementing read/write pointers.
void	Reset()	Resets the delay line state, flushes buffer and resets read/write pointers.
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).
void	SetDelaySamples ( const float InDelaySamples )	Same as SetDelayMsec, except in samples.
void	SetEasedDelayMsec ( const float InDelayMsec, const bool bIsInit )	Sets the delay line length but using the internal easing function for smooth delay line interpolation.
void	SetEaseFactor ( const float InEaseFactor )	Sets the easing factor for the delay line's internal exponential interpolator.
void	SetOutputAttenuationDB ( const float InDelayAttenDB )	Sets the output attenuation in DB.
void	Update ( bool bForce )	Updates delay line based on any recent changes to settings.
void	WriteDelayAndInc ( const float InDelayInput )	Write the input and increment read/write pointers.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss