Navigation
API > API/Runtime > API/Runtime/SignalProcessing
Base class for filters usable in synthesis.
| Name | IFilter |
| Type | class |
| Header File | /Engine/Source/Runtime/SignalProcessing/Public/DSP/Filter.h |
| Include Path | #include "DSP/Filter.h" |
Syntax
class IFilter
Derived Classes
IFilter derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| DSP/Filter.h | |||
IFilter () |
DSP/Filter.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IFilter() |
DSP/Filter.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPatchDestination GetModDestCutoffFrequency() |
Filter patch destinations. | DSP/Filter.h | |
FPatchDestination GetModDestQ() |
DSP/Filter.h | ||
virtual void Init
(
const float InSampleRate, |
Initialize the filter. | DSP/Filter.h | |
void ProcessAudio
(
const float* InBuffer, |
Process a mono buffer or an interleaved buffer of multichannel audio. | DSP/Filter.h | |
void ProcessAudio
(
const float*const* InBuffers, |
Process a non-interleaved buffer of multichannel audio. | DSP/Filter.h | |
virtual void ProcessAudioFrame
(
const float* InFrame, |
Processes a single frame of audio. Number of channels MUST be what was used during filter initialization. | DSP/Filter.h | |
virtual void Reset() |
Reset the filter. | DSP/Filter.h | |
virtual void SetBandStopControl
(
const float InBandStop |
Sets the band stop control param (not used on all filters) | DSP/Filter.h | |
virtual void SetFilterType
(
const EFilter::Type InFilterType |
Sets the filter type. | DSP/Filter.h | |
virtual void SetFrequency
(
const float InCutoffFrequency |
Sets the cutoff frequency of the filter. | DSP/Filter.h | |
virtual void SetFrequencyMod
(
const float InModFrequency |
Sets an external modulated frequency. | DSP/Filter.h | |
virtual void SetPassBandGainCompensation
(
const float InPassBandGainCompensation |
Sets the band pass gain compensation (not used on all filters) | DSP/Filter.h | |
virtual void SetQ
(
const float InQ |
Sets the quality/resonance of the filter. | DSP/Filter.h | |
virtual void SetQMod
(
const float InModQ |
Sets an external modulated quality/resonance of the filter. | DSP/Filter.h | |
virtual void SetSaturation
(
const float InSaturation |
Sets the filter saturation (not used on all filters) | DSP/Filter.h | |
virtual void Update() |
Updates the filter. | DSP/Filter.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetGCoefficient() |
DSP/Filter.h |