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

#include <Filter.h>

+ Inheritance diagram for Audio::FStateVariableFilter:

Classes

struct  FFilterState
 

Public Member Functions

SIGNALPROCESSING_API FStateVariableFilter ()
 
virtual SIGNALPROCESSING_API ~FStateVariableFilter ()
 
virtual SIGNALPROCESSING_API void Init (const float InSampleRate, const int32 InNumChannels, const int32 InVoiceId=0, FModulationMatrix *InModMatrix=nullptr) override
 
virtual SIGNALPROCESSING_API void SetBandStopControl (const float InBandStop) override
 
virtual SIGNALPROCESSING_API void Reset () override
 
virtual SIGNALPROCESSING_API void Update () override
 
virtual SIGNALPROCESSING_API void ProcessAudio (const float *InSamples, const int32 InNumSamples, float *OutSamples) override
 
virtual SIGNALPROCESSING_API void ProcessAudio (const float *const *InBuffers, const int32 InNumSamples, float *const *OutBuffers) override
 
SIGNALPROCESSING_API void ProcessAudio (const float *InSamples, const int32 InNumSamples, float *LpfOutput, float *HpfOutput, float *BpfOutput, float *BsfOutput)
 
SIGNALPROCESSING_API void ProcessAudio (const float *const *InBuffers, const int32 InNumSamples, float *const *LpfOutBuffers, float *const *HpfOutBuffers, float *const *BpfOutBuffers, float *const *BsfOutBuffers)
 
SIGNALPROCESSING_API void ArrayCalculateResponseInPlace (TArrayView< float > InOutComplexValues) const
 
- Public Member Functions inherited from Audio::IFilter
SIGNALPROCESSING_API IFilter ()
 
SIGNALPROCESSING_API IFilter (const IFilter &)
 
virtual SIGNALPROCESSING_API ~IFilter ()
 
virtual SIGNALPROCESSING_API void SetFrequency (const float InCutoffFrequency)
 
virtual SIGNALPROCESSING_API void SetFrequencyMod (const float InModFrequency)
 
virtual SIGNALPROCESSING_API void SetQ (const float InQ)
 
virtual SIGNALPROCESSING_API void SetQMod (const float InModQ)
 
virtual void SetSaturation (const float InSaturation)
 
virtual void SetPassBandGainCompensation (const float InPassBandGainCompensation)
 
virtual SIGNALPROCESSING_API void SetFilterType (const EFilter::Type InFilterType)
 
virtual void ProcessAudioFrame (const float *InFrame, float *OutFrame)
 
FPatchDestination GetModDestCutoffFrequency () const
 
FPatchDestination GetModDestQ () const
 

Protected Attributes

float InputScale
 
float A0
 
float Feedback
 
float BandStopParam
 
TArray< FFilterStateFilterState
 
- Protected Attributes inherited from Audio::IFilter
int32 VoiceId
 
float SampleRate
 
int32 NumChannels
 
float Frequency
 
float BaseFrequency
 
float ModFrequency
 
float ExternalModFrequency
 
float Q
 
float ModQ
 
float BaseQ
 
float ExternalModQ
 
EFilter::Type FilterType
 
FModulationMatrixModMatrix
 
FPatchDestination ModCutoffFrequencyDest
 
FPatchDestination ModQDest
 
bool bChanged
 

Additional Inherited Members

- Protected Member Functions inherited from Audio::IFilter
float GetGCoefficient () const
 

Constructor & Destructor Documentation

◆ FStateVariableFilter()

Audio::FStateVariableFilter::FStateVariableFilter ( )

◆ ~FStateVariableFilter()

Audio::FStateVariableFilter::~FStateVariableFilter ( )
virtual

Member Function Documentation

◆ ArrayCalculateResponseInPlace()

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

◆ Init()

void Audio::FStateVariableFilter::Init ( const float  InSampleRate,
const int32  InNumChannels,
const int32  InVoiceId = 0,
FModulationMatrix InModMatrix = nullptr 
)
overridevirtual

Reimplemented from Audio::IFilter.

◆ ProcessAudio() [1/4]

void Audio::FStateVariableFilter::ProcessAudio ( const float *const *  InBuffers,
const int32  InNumSamples,
float *const *  LpfOutBuffers,
float *const *  HpfOutBuffers,
float *const *  BpfOutBuffers,
float *const *  BsfOutBuffers 
)

◆ ProcessAudio() [2/4]

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

Implements Audio::IFilter.

◆ ProcessAudio() [3/4]

void Audio::FStateVariableFilter::ProcessAudio ( const float InSamples,
const int32  InNumSamples,
float LpfOutput,
float HpfOutput,
float BpfOutput,
float BsfOutput 
)

◆ ProcessAudio() [4/4]

void Audio::FStateVariableFilter::ProcessAudio ( const float InSamples,
const int32  InNumSamples,
float OutSamples 
)
overridevirtual

Implements Audio::IFilter.

◆ Reset()

void Audio::FStateVariableFilter::Reset ( )
overridevirtual

Reimplemented from Audio::IFilter.

◆ SetBandStopControl()

void Audio::FStateVariableFilter::SetBandStopControl ( const float  InBandStop)
overridevirtual

Reimplemented from Audio::IFilter.

◆ Update()

void Audio::FStateVariableFilter::Update ( )
overridevirtual

Reimplemented from Audio::IFilter.

Member Data Documentation

◆ A0

float Audio::FStateVariableFilter::A0
protected

◆ BandStopParam

float Audio::FStateVariableFilter::BandStopParam
protected

◆ Feedback

float Audio::FStateVariableFilter::Feedback
protected

◆ FilterState

TArray<FFilterState> Audio::FStateVariableFilter::FilterState
protected

◆ InputScale

float Audio::FStateVariableFilter::InputScale
protected

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