| FDelay
|
Module |
|
Header |
/Engine/Source/Runtime/SignalProcessing/Public/DSP/Delay.h |
Include |
#include "DSP/Delay.h" |
class FDelay
Circular Buffer Delay Line.
Name | Description | ||
---|---|---|---|
|
float * |
AudioBuffer |
Pointer to the circular buffer of audio. |
|
AudioBufferSize |
Max length of buffer (in samples) |
|
|
float |
DelayInSamples |
Delay in samples; float supports fractional delay. |
|
EaseDelayMsec |
Eased delay in msec. |
|
|
float |
OutputAttenuation |
Output attenuation value. |
|
float |
OutputAttenuationDB |
Attenuation in decibel. |
|
ReadIndex |
Read index for circular buffer. |
|
|
float |
SampleRate |
Sample rate. |
|
WriteIndex |
Write index for circular buffer. |
Name | Description | |
---|---|---|
|
FDelay() |
Constructor. |
Name | Description | |
---|---|---|
|
~FDelay() |
Virtual Destructor. |
Name | Description | ||
---|---|---|---|
|
float |
GetDelayLengthSamples() |
Returns the current delay line length (in samples). |
|
Init ( |
Initialization of the delay with given sample rate and max buffer size in samples. |
|
|
float |
ProcessAudioSample ( |
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 ( |
Reads the delay line at an arbitrary time in Msec without writing or incrementing read/write pointers. |
|
Reset() |
Resets the delay line state, flushes buffer and resets read/write pointers. |
|
|
SetDelayMsec ( |
Sets the delay line length. Will clamp to within range of the max initialized delay line length (won't resize). |
|
|
SetDelaySamples ( |
Same as SetDelayMsec, except in samples. |
|
|
SetEasedDelayMsec ( |
Sets the delay line length but using the internal easing function for smooth delay line interpolation. |
|
|
SetEaseFactor ( |
Sets the easing factor for the delay line's internal exponential interpolator. |
|
|
SetOutputAttenuationDB ( |
Sets the output attenuation in DB. |
|
|
Update ( |
Updates delay line based on any recent changes to settings. |
|
|
WriteDelayAndInc ( |
Write the input and increment read/write pointers. |