UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::FChorus Class Reference

#include <Chorus.h>

Public Member Functions

SIGNALPROCESSING_API FChorus ()
 
SIGNALPROCESSING_API ~FChorus ()
 
SIGNALPROCESSING_API void Init (const float InSampleRate, const int32 InNumChannels, const float InDelayLengthSec=2.0f, const int32 InControlSamplePeriod=256)
 
int32 GetNumChannels () const
 
SIGNALPROCESSING_API void SetDepth (const EChorusDelays::Type InType, const float InDepth)
 
SIGNALPROCESSING_API void SetFrequency (const EChorusDelays::Type InType, const float InFrequency)
 
SIGNALPROCESSING_API void SetFeedback (const EChorusDelays::Type InType, const float InFeedback)
 
SIGNALPROCESSING_API void SetWetLevel (const float InWetLevel)
 
SIGNALPROCESSING_API void SetDryLevel (const float InDryLevel)
 
SIGNALPROCESSING_API void SetSpread (const float InSpread)
 
SIGNALPROCESSING_API void ProcessAudioFrame (const float *InFrame, float *OutFrame)
 
SIGNALPROCESSING_API void ProcessAudio (const float *InBuffer, const int32 InNumSamples, float *OutBuffer)
 

Protected Attributes

FDelay Delays [EChorusDelays::NumDelayTypes]
 
FLFO LFOs [EChorusDelays::NumDelayTypes]
 
FLinearEase Depth [EChorusDelays::NumDelayTypes]
 
float Feedback [EChorusDelays::NumDelayTypes]
 
float MinDelayMsec
 
float MaxDelayMsec
 
float DelayRangeMsec
 
float Spread
 
float MaxFrequencySpread
 
float WetLevel
 
float DryLevel
 
int32 NumChannels
 

Constructor & Destructor Documentation

◆ FChorus()

Audio::FChorus::FChorus ( )

◆ ~FChorus()

Audio::FChorus::~FChorus ( )

Member Function Documentation

◆ GetNumChannels()

int32 Audio::FChorus::GetNumChannels ( ) const
inline

◆ Init()

void Audio::FChorus::Init ( const float  InSampleRate,
const int32  InNumChannels,
const float  InDelayLengthSec = 2.0f,
const int32  InControlSamplePeriod = 256 
)

◆ ProcessAudio()

void Audio::FChorus::ProcessAudio ( const float InBuffer,
const int32  InNumSamples,
float OutBuffer 
)

◆ ProcessAudioFrame()

void Audio::FChorus::ProcessAudioFrame ( const float InFrame,
float OutFrame 
)

◆ SetDepth()

void Audio::FChorus::SetDepth ( const EChorusDelays::Type  InType,
const float  InDepth 
)

◆ SetDryLevel()

void Audio::FChorus::SetDryLevel ( const float  InDryLevel)

◆ SetFeedback()

void Audio::FChorus::SetFeedback ( const EChorusDelays::Type  InType,
const float  InFeedback 
)

◆ SetFrequency()

void Audio::FChorus::SetFrequency ( const EChorusDelays::Type  InType,
const float  InFrequency 
)

◆ SetSpread()

void Audio::FChorus::SetSpread ( const float  InSpread)

◆ SetWetLevel()

void Audio::FChorus::SetWetLevel ( const float  InWetLevel)

Member Data Documentation

◆ DelayRangeMsec

float Audio::FChorus::DelayRangeMsec
protected

◆ Delays

FDelay Audio::FChorus::Delays[EChorusDelays::NumDelayTypes]
protected

◆ Depth

FLinearEase Audio::FChorus::Depth[EChorusDelays::NumDelayTypes]
protected

◆ DryLevel

float Audio::FChorus::DryLevel
protected

◆ Feedback

float Audio::FChorus::Feedback[EChorusDelays::NumDelayTypes]
protected

◆ LFOs

FLFO Audio::FChorus::LFOs[EChorusDelays::NumDelayTypes]
protected

◆ MaxDelayMsec

float Audio::FChorus::MaxDelayMsec
protected

◆ MaxFrequencySpread

float Audio::FChorus::MaxFrequencySpread
protected

◆ MinDelayMsec

float Audio::FChorus::MinDelayMsec
protected

◆ NumChannels

int32 Audio::FChorus::NumChannels
protected

◆ Spread

float Audio::FChorus::Spread
protected

◆ WetLevel

float Audio::FChorus::WetLevel
protected

The documentation for this class was generated from the following files: