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

#include <Filter.h>

+ Inheritance diagram for Audio::FOnePoleFilter:

Public Member Functions

SIGNALPROCESSING_API FOnePoleFilter ()
 
virtual SIGNALPROCESSING_API ~FOnePoleFilter ()
 
virtual SIGNALPROCESSING_API void Init (const float InSampleRate, const int32 InNumChannels, const int32 InVoiceId=0, FModulationMatrix *InModMatrix=nullptr) override
 
virtual SIGNALPROCESSING_API void Reset () override
 
virtual SIGNALPROCESSING_API void Update () override
 
virtual SIGNALPROCESSING_API void ProcessAudioFrame (const float *InFrame, float *OutFrame) 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
 
void SetCoefficient (const float InCoefficient)
 
float GetCoefficient () const
 
float GetState (const int32 InChannel) const
 
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 SetBandStopControl (const float InBandStop)
 
virtual void SetPassBandGainCompensation (const float InPassBandGainCompensation)
 
virtual SIGNALPROCESSING_API void SetFilterType (const EFilter::Type InFilterType)
 
FPatchDestination GetModDestCutoffFrequency () const
 
FPatchDestination GetModDestQ () const
 

Protected Attributes

float A0
 
floatZ1
 
- 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

◆ FOnePoleFilter()

Audio::FOnePoleFilter::FOnePoleFilter ( )

◆ ~FOnePoleFilter()

Audio::FOnePoleFilter::~FOnePoleFilter ( )
virtual

Member Function Documentation

◆ ArrayCalculateResponseInPlace()

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

◆ GetCoefficient()

float Audio::FOnePoleFilter::GetCoefficient ( ) const
inline

◆ GetState()

float Audio::FOnePoleFilter::GetState ( const int32  InChannel) const
inline

◆ Init()

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

Reimplemented from Audio::IFilter.

◆ ProcessAudio() [1/2]

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

Implements Audio::IFilter.

◆ ProcessAudio() [2/2]

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

Implements Audio::IFilter.

◆ ProcessAudioFrame()

void Audio::FOnePoleFilter::ProcessAudioFrame ( const float InFrame,
float OutFrame 
)
overridevirtual

Reimplemented from Audio::IFilter.

◆ Reset()

void Audio::FOnePoleFilter::Reset ( )
overridevirtual

Reimplemented from Audio::IFilter.

◆ SetCoefficient()

void Audio::FOnePoleFilter::SetCoefficient ( const float  InCoefficient)
inline

◆ Update()

void Audio::FOnePoleFilter::Update ( )
overridevirtual

Reimplemented from Audio::IFilter.

Member Data Documentation

◆ A0

float Audio::FOnePoleFilter::A0
protected

◆ Z1

float* Audio::FOnePoleFilter::Z1
protected

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