FDelayStereo

Windows
MacOS
Linux

References

Module

SignalProcessing

Header

/Engine/Source/Runtime/SignalProcessing/Public/DSP/DelayStereo.h

Include

#include "DSP/DelayStereo.h"

Syntax

class FDelayStereo

Variables

Name Description

Protected variable

bool

 

bIsInit

If the delay has started processing yet.

Protected variable

EStereoDelayMod...

 

DelayMode

What mode the stereo delay is in.

Protected variable

float

 

DelayRatio

How much to shift the delays from each other.

Protected variable

TArray< FDelay ...

 

Delays

Left channel delay line.

Protected variable

float

 

DelayTimeMsec

Amount of delay time in msec.

Protected variable

float

 

Feedback

How much delay feedback to use.

Protected variable

int32

 

NumChannels

The number of channels to use (will sum mono)

Protected variable

float

 

WetLevel

The amount of wet level on the output.

Constructors

Name Description

Public function

FDelayStereo()

Destructors

Name Description

Public function

~FDelayStereo()

Functions

Name Description

Public function Const

EStereoDelay...

 

GetMode()

Gets the current stereo dealy mode.

Public function

void

 

Init

(
    const float InSampleRate,
    const int32 InNumChannels,
    const float InDelayLengthSec
)

Initializes the stereo delay with given sample rate and default max delay length.

Public function

void

 

ProcessAudio

(
    const float* InBuffer,
    const int32 InNumSamples,
    float* OutBuffer
)

Process a buffer of audio.

Public function

void

 

ProcessAudioFrame

(
    const float* InFrame,
    float* OutFrame
)

Process a single frame of audio.

Public function

void

 

Reset()

Resets the stereo delay state.

Public function

void

 

SetDelayRatio

(
    const float InDelayRatio
)

Sets the delay ratio (scales difference between left and right stereo delays)

Public function

void

 

SetDelayTimeMsec

(
    const float InDelayTimeMsec
)

Sets the delay time in msec.

Public function

void

 

SetFeedback

(
    const float InFeedback
)

Sets the feedback amount.

Public function

void

 

SetMode

(
    const EStereoDelayMode::Type InMode
)

Sets which delay stereo mode to use.

Public function

void

 

SetWetLevel

(
    const float InWetLevel
)

Sets the amount of the effect to mix in the output.

Protected function

void

 

UpdateDelays()

Updates the delays based on recent parameters.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss