1. Epic GamesDeveloper
  3. FDelay

FDelay

API > API/Plugins > API/Plugins/HarmonixDsp

   
Name FDelay
Type class
Header File /Engine/Plugins/Runtime/Harmonix/Source/HarmonixDsp/Public/HarmonixDsp/Effects/Delay.h
Include Path #include "HarmonixDsp/Effects/Delay.h"

Syntax

class FDelay

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FDelay()

   HarmonixDsp/Effects/Delay.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FDelay()

   HarmonixDsp/Effects/Delay.h  

Structs

Name Remarks
FDelayOutput  

Constants

Name Type Remarks Include Path
AbsoluteMaxChannels int32 The max number of channels we expect to support with the delay. HarmonixDsp/Effects/Delay.h
HopNum int32   HarmonixDsp/Effects/Delay.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveChannels int32   HarmonixDsp/Effects/Delay.h  
CanSlamParams bool   HarmonixDsp/Effects/Delay.h  
DelayInSamples float   HarmonixDsp/Effects/Delay.h  
DelayLineInterleaved Audio::FAlignedFloatBuffer   HarmonixDsp/Effects/Delay.h  
DelayPos uint32   HarmonixDsp/Effects/Delay.h  
DelayRamper TLinearRamper< float >   HarmonixDsp/Effects/Delay.h  
DelaySpreadLeft TLinearRamper< float >   HarmonixDsp/Effects/Delay.h  
DelaySpreadRight TLinearRamper< float >   HarmonixDsp/Effects/Delay.h  
DelayTimeSeconds float   HarmonixDsp/Effects/Delay.h  
DelayType EDelayStereoType   HarmonixDsp/Effects/Delay.h  
DryGain float   HarmonixDsp/Effects/Delay.h  
DryRamper TLinearRamper< float >   HarmonixDsp/Effects/Delay.h  
FeedbackFilters TMultiChannelBiquadFilter< double, 8 >   HarmonixDsp/Effects/Delay.h  
FeedbackGain float   HarmonixDsp/Effects/Delay.h  
FeedbackRamper TLinearRamper< float >   HarmonixDsp/Effects/Delay.h  
FiveOneSurroundLRForce int32   HarmonixDsp/Effects/Delay.h  
FiveOneSurroundRotation int32 Info for bouncing between speakers belongs here rather than GainTable.cpp because this is specific to the ping pong delay effect HarmonixDsp/Effects/Delay.h  
Length uint32   HarmonixDsp/Effects/Delay.h  
Lfo Harmonix::Dsp::Modulators::FLfo   HarmonixDsp/Effects/Delay.h  
LfoBaseFrequency float   HarmonixDsp/Effects/Delay.h  
LfoSettings FLfoSettings   HarmonixDsp/Effects/Delay.h  
LfoSyncOption ETimeSyncOption   HarmonixDsp/Effects/Delay.h  
MaxBlockSize uint32   HarmonixDsp/Effects/Delay.h  
MaxChannels int32   HarmonixDsp/Effects/Delay.h  
MaxDelayInMs float   HarmonixDsp/Effects/Delay.h  
MaxDelayInSamples float   HarmonixDsp/Effects/Delay.h  
OutputGain float   HarmonixDsp/Effects/Delay.h  
PosMask uint32   HarmonixDsp/Effects/Delay.h  
SampleRate int32   HarmonixDsp/Effects/Delay.h  
SevenOneFourSurroundLRForce int32   HarmonixDsp/Effects/Delay.h  
SevenOneFourSurroundRotation int32   HarmonixDsp/Effects/Delay.h  
SevenOneSurroundLRForce int32   HarmonixDsp/Effects/Delay.h  
SevenOneSurroundRotation int32   HarmonixDsp/Effects/Delay.h  
Speed float   HarmonixDsp/Effects/Delay.h  
TempoBpm float   HarmonixDsp/Effects/Delay.h  
TimeSyncOption ETimeSyncOption   HarmonixDsp/Effects/Delay.h  
WetChannelInterleaved Audio::FAlignedFloatBuffer   HarmonixDsp/Effects/Delay.h  
WetFilters TMultiChannelBiquadFilter< double, 8 >   HarmonixDsp/Effects/Delay.h  
WetGain float Also known as feedforward HarmonixDsp/Effects/Delay.h  
WetRamper TLinearRamper< float >   HarmonixDsp/Effects/Delay.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

float CalculateSecsToIdle()

   HarmonixDsp/Effects/Delay.h  

void Clear()

   HarmonixDsp/Effects/Delay.h  

float GetDelaySeconds()

   HarmonixDsp/Effects/Delay.h  

float GetDryGain()

   HarmonixDsp/Effects/Delay.h  

bool GetFeedbackFilterEnabled()

   HarmonixDsp/Effects/Delay.h  

float GetFeedbackGain()

   HarmonixDsp/Effects/Delay.h  

float GetFilterFreq()

   HarmonixDsp/Effects/Delay.h  

float GetFilterQ()

   HarmonixDsp/Effects/Delay.h  

EBiquadFilterType GetFilterType()

   HarmonixDsp/Effects/Delay.h  

float GetLfoDepth()

   HarmonixDsp/Effects/Delay.h  

bool GetLfoEnabled()

   HarmonixDsp/Effects/Delay.h  

float GetLfoFreq()

   HarmonixDsp/Effects/Delay.h  

ETimeSyncOption GetLfoTimeSyncOption()

   HarmonixDsp/Effects/Delay.h  

float GetOutputGain()

   HarmonixDsp/Effects/Delay.h  

float GetSampleRate()

   HarmonixDsp/Effects/Delay.h  

float GetSpeed()

   HarmonixDsp/Effects/Delay.h  

float GetStereoSpreadLeft()

   HarmonixDsp/Effects/Delay.h  

float GetStereoSpreadRight()

   HarmonixDsp/Effects/Delay.h  

EDelayStereoType GetStereoType()

   HarmonixDsp/Effects/Delay.h  

float GetTempo()

   HarmonixDsp/Effects/Delay.h  

ETimeSyncOption GetTimeSyncOption()

   HarmonixDsp/Effects/Delay.h  

bool GetWetFilterEnabled()

   HarmonixDsp/Effects/Delay.h  

float GetWetGain()

   HarmonixDsp/Effects/Delay.h  

void Prepare ( float InSampleRate,
uint32 InMaxChannels,
float InMaxDelayTimeMs
)

   HarmonixDsp/Effects/Delay.h  

void Process ( Audio::FMultichannelBufferView& InOutBuffer
)

   HarmonixDsp/Effects/Delay.h  

void SetDelaySeconds ( float Seconds
)

 Units are either seconds or beats, depending on beat-sync setting HarmonixDsp/Effects/Delay.h  

void SetDryGain ( float Gain
)

   HarmonixDsp/Effects/Delay.h  

void SetFeedbackFilterEnabled ( bool Enabled
)

   HarmonixDsp/Effects/Delay.h  

void SetFeedbackGain ( float Gain
)

   HarmonixDsp/Effects/Delay.h  

void SetFilterFreq ( float Freq
)

   HarmonixDsp/Effects/Delay.h  

void SetFilterQ ( float Q
)

   HarmonixDsp/Effects/Delay.h  
  HarmonixDsp/Effects/Delay.h  
  HarmonixDsp/Effects/Delay.h  

void SetLfoDepth ( float InDepth
)

   HarmonixDsp/Effects/Delay.h  

void SetLfoEnabled ( bool bEnabled
)

   HarmonixDsp/Effects/Delay.h  

void SetLfoFreq ( float Freq
)

   HarmonixDsp/Effects/Delay.h  

void SetLfoTimeSyncOption ( ETimeSyncOption Option
)

   HarmonixDsp/Effects/Delay.h  

void SetOutputGain ( const float InGain
)

   HarmonixDsp/Effects/Delay.h  

void SetParamsToTargets()

   HarmonixDsp/Effects/Delay.h  

void SetSpeed ( float Speed
)

   HarmonixDsp/Effects/Delay.h  

void SetStereoSpreadLeft ( float Spread
)

   HarmonixDsp/Effects/Delay.h  

void SetStereoSpreadRight ( float Spread
)

   HarmonixDsp/Effects/Delay.h  

void SetStereoType ( EDelayStereoType Type
)

   HarmonixDsp/Effects/Delay.h  

void SetTempo ( float Bpm
)

   HarmonixDsp/Effects/Delay.h  

void SetTimeSyncOption ( ETimeSyncOption Option
)

 In beat-sync mode, delays are specified in beats, not seconds, and the delay must be notified when the tempo changes. HarmonixDsp/Effects/Delay.h  

void SetWetFilterEnabled ( bool Enabled
)

   HarmonixDsp/Effects/Delay.h  

void SetWetGain ( float Gain
)

   HarmonixDsp/Effects/Delay.h  

void Unprepare()

   HarmonixDsp/Effects/Delay.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page