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

#include <Filter.h>

Classes

struct  FBiquadCoeff
 

Public Member Functions

SIGNALPROCESSING_API FBiquadFilter ()
 
virtual SIGNALPROCESSING_API ~FBiquadFilter ()
 
SIGNALPROCESSING_API void Init (const float InSampleRate, const int32 InNumChannels, const EBiquadFilter::Type InType, const float InCutoffFrequency=20000.0f, const float InBandwidth=2.0f, const float InGain=0.0f)
 
SIGNALPROCESSING_API int32 GetNumChannels () const
 
SIGNALPROCESSING_API void Reset ()
 
SIGNALPROCESSING_API void ProcessAudioFrame (const float *InFrame, float *OutFrame)
 
SIGNALPROCESSING_API void ProcessAudio (const float *InBuffer, const int32 InNumSamples, float *OutBuffer)
 
SIGNALPROCESSING_API void ProcessAudio (const float *const *InBuffers, const int32 InNumSamples, float *const *OutBuffers)
 
SIGNALPROCESSING_API void SetParams (const EBiquadFilter::Type InFilterType, const float InCutoffFrequency, const float InBandwidth, const float InGainDB)
 
SIGNALPROCESSING_API void SetType (const EBiquadFilter::Type InType)
 
SIGNALPROCESSING_API void SetFrequency (const float InCutoffFrequency)
 
SIGNALPROCESSING_API void SetBandwidth (const float InBandwidth)
 
SIGNALPROCESSING_API void SetGainDB (const float InGainDB)
 
SIGNALPROCESSING_API void SetEnabled (const bool bInEnabled)
 
SIGNALPROCESSING_API void ArrayCalculateResponseInPlace (TArrayView< float > InOutComplexValues) const
 

Protected Member Functions

SIGNALPROCESSING_API void CalculateBiquadCoefficients ()
 
SIGNALPROCESSING_API float ClampCutoffFrequency (float InCutoffFrequency)
 

Protected Attributes

EBiquadFilter::Type FilterType
 
FBiquadCoeffBiquad
 
float SampleRate
 
int32 NumChannels
 
float Frequency
 
float Bandwidth
 
float GainDB
 
bool bEnabled
 

Constructor & Destructor Documentation

◆ FBiquadFilter()

Audio::FBiquadFilter::FBiquadFilter ( )

◆ ~FBiquadFilter()

Audio::FBiquadFilter::~FBiquadFilter ( )
virtual

Member Function Documentation

◆ ArrayCalculateResponseInPlace()

void Audio::FBiquadFilter::ArrayCalculateResponseInPlace ( TArrayView< float InOutComplexValues) const

◆ CalculateBiquadCoefficients()

void Audio::FBiquadFilter::CalculateBiquadCoefficients ( )
protected

◆ ClampCutoffFrequency()

float Audio::FBiquadFilter::ClampCutoffFrequency ( float  InCutoffFrequency)
protected

◆ GetNumChannels()

int32 Audio::FBiquadFilter::GetNumChannels ( ) const

◆ Init()

void Audio::FBiquadFilter::Init ( const float  InSampleRate,
const int32  InNumChannels,
const EBiquadFilter::Type  InType,
const float  InCutoffFrequency = 20000.0f,
const float  InBandwidth = 2.0f,
const float  InGain = 0.0f 
)

◆ ProcessAudio() [1/2]

void Audio::FBiquadFilter::ProcessAudio ( const float *const *  InBuffers,
const int32  InNumSamples,
float *const *  OutBuffers 
)

◆ ProcessAudio() [2/2]

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

◆ ProcessAudioFrame()

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

◆ Reset()

void Audio::FBiquadFilter::Reset ( )

◆ SetBandwidth()

void Audio::FBiquadFilter::SetBandwidth ( const float  InBandwidth)

◆ SetEnabled()

void Audio::FBiquadFilter::SetEnabled ( const bool  bInEnabled)

◆ SetFrequency()

void Audio::FBiquadFilter::SetFrequency ( const float  InCutoffFrequency)

◆ SetGainDB()

void Audio::FBiquadFilter::SetGainDB ( const float  InGainDB)

◆ SetParams()

void Audio::FBiquadFilter::SetParams ( const EBiquadFilter::Type  InFilterType,
const float  InCutoffFrequency,
const float  InBandwidth,
const float  InGainDB 
)

◆ SetType()

void Audio::FBiquadFilter::SetType ( const EBiquadFilter::Type  InType)

Member Data Documentation

◆ Bandwidth

float Audio::FBiquadFilter::Bandwidth
protected

◆ bEnabled

bool Audio::FBiquadFilter::bEnabled
protected

◆ Biquad

FBiquadCoeff* Audio::FBiquadFilter::Biquad
protected

◆ FilterType

EBiquadFilter::Type Audio::FBiquadFilter::FilterType
protected

◆ Frequency

float Audio::FBiquadFilter::Frequency
protected

◆ GainDB

float Audio::FBiquadFilter::GainDB
protected

◆ NumChannels

int32 Audio::FBiquadFilter::NumChannels
protected

◆ SampleRate

float Audio::FBiquadFilter::SampleRate
protected

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