1. Epic GamesDeveloper
  3. FBiquadFilter

FBiquadFilter

Biquad filter class which wraps a biquad filter struct Handles multi-channel audio to avoid calculating filter coefficients for multiple channels of audio.

API > API/Runtime > API/Runtime/SignalProcessing

Biquad filter class which wraps a biquad filter struct Handles multi-channel audio to avoid calculating filter coefficients for multiple channels of audio.

   
Name FBiquadFilter
Type class
Header File /Engine/Source/Runtime/SignalProcessing/Public/DSP/Filter.h
Include Path #include "DSP/Filter.h"

Syntax

class FBiquadFilter

Constructors

Name Remarks Include Path Unreal Specifiers

FBiquadFilter()

 Constructor. DSP/Filter.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FBiquadFilter()

 Destructor. DSP/Filter.h  

Structs

Name Remarks
FBiquadCoeff  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ArrayCalculateResponseInPlace ( TArrayView< float > InOutComplexValues
) const

 Apply the filter transfer function to each z-domain value in the given array (complex numbers given as interleaved floats). Passing in z-domain values on the complex unit circle will give the frequency response. DSP/Filter.h  

int32 GetNumChannels()

 Returns number of channels initialized with. DSP/Filter.h  

void Init ( const float InSampleRate,
const int32 InNumChannels,
const EBiquadFilter::Type InType,
const float InCutoffFrequency,
const float InBandwidth,
const float InGain
)

 Initialize the filter. DSP/Filter.h  

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

 Process a mono buffer or an interleaved buffer of multichannel audio. DSP/Filter.h  

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

 Process a non-interleaved buffer of multichannel audio. DSP/Filter.h  

void ProcessAudioFrame ( const float* InFrame,
float* OutFrame
)

 Processes a single frame of audio. DSP/Filter.h  

void Reset()

 Resets the filter state. DSP/Filter.h  

void SetBandwidth ( const float InBandwidth
)

 Sets the bandwidth (octaves) of the filter. DSP/Filter.h  

void SetEnabled ( const bool bInEnabled
)

 Sets whether or no this filter is enabled (if disabled audio is passed through) DSP/Filter.h  

void SetFrequency ( const float InCutoffFrequency
)

 Sets the filter frequency. DSP/Filter.h  

void SetGainDB ( const float InGainDB
)

 Sets the gain of the filter in decibels. DSP/Filter.h  

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

 Sets all filter parameters with one function. DSP/Filter.h  

void SetType ( const EBiquadFilter::Type InType
)

 Sets the type of the filter to use. DSP/Filter.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CalculateBiquadCoefficients()

 Function computes biquad coefficients based on current filter settings. DSP/Filter.h  

float ClampCutoffFrequency ( float InCutoffFrequency
)

 Function used to clamp the cutoff frequency. DSP/Filter.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page