Navigation
API > API/Runtime > API/Runtime/SignalProcessing
An adjustable delay line. Delays values are limited to integer values.
| Name | FIntegerDelay |
| Type | class |
| Header File | /Engine/Source/Runtime/SignalProcessing/Public/DSP/IntegerDelay.h |
| Include Path | #include "DSP/IntegerDelay.h" |
Syntax
class FIntegerDelay
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FIntegerDelay
(
int32 InMaxNumDelaySamples, |
InMaxDelaySamples is the maximum supported delay. InDelaySamples is the initial delay in samples. | DSP/IntegerDelay.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FIntegerDelay() |
Destructor. | DSP/IntegerDelay.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DelayLine | TUniquePtr< FAlignedBlockBuffer > | Buffer for holding delayed data. | DSP/IntegerDelay.h | |
| MaxNumDelaySamples | int32 | Maximum supported number of delay samples. | DSP/IntegerDelay.h | |
| NumBufferOffsetSamples | int32 | Offset to handle delay values which are not multiple of required buffer alignment. | DSP/IntegerDelay.h | |
| NumDelayLineOffsetSamples | int32 | Offset of output delayed samples relative to DelayLine block buffer. | DSP/IntegerDelay.h | |
| NumDelaySamples | int32 | Current number of delay samples. | DSP/IntegerDelay.h | |
| NumInternalBufferSamples | int32 | Number of samples in an internal buffer. | DSP/IntegerDelay.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetNumDelaySamples() |
Returns the current delay length in samples. | DSP/IntegerDelay.h | |
void PeekDelayLine
(
int32 InNum, |
Retrieve a copy of the internal delay line. | DSP/IntegerDelay.h | |
void ProcessAudio
(
const Audio::FAlignedFloatBuffer& InSamples, |
DSP/IntegerDelay.h | ||
void ProcessAudio
(
TArrayView< const float > InSamples, |
Process InSamples, placing delayed versions in OutSamples. | DSP/IntegerDelay.h | |
float ProcessAudioSample
(
float InSample |
Process InSamples, placing delayed versions in OutSamples. | DSP/IntegerDelay.h | |
void Reset() |
Resets the delay line state, flushes buffer and resets read/write pointers. | DSP/IntegerDelay.h | |
void SetDelayLengthSamples
(
int32 InNumDelaySamples |
Sets the current delay in samples. InDelay must be less than or equal to the InMaxDelaySamples set in the constructor. | DSP/IntegerDelay.h |