Navigation
API > API/Plugins > API/Plugins/Synthesis
| Name | FSubmixEffectFilter |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SubmixEffects/SubmixEffectFilter.h |
| Include Path | #include "SubmixEffects/SubmixEffectFilter.h" |
Syntax
class FSubmixEffectFilter : public FSoundEffectSubmix
Inheritance Hierarchy
- FSoundEffectBase → FSoundEffectSubmix → FSubmixEffectFilter
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSubmixEffectFilter() |
SubmixEffects/SubmixEffectFilter.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSubmixEffectFilter() |
SubmixEffects/SubmixEffectFilter.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CurrentFilter | Audio::IFilter * | The current filter selected. | SubmixEffects/SubmixEffectFilter.h | |
| FilterAlgorithm | ESubmixFilterAlgorithm | Filter control data. | SubmixEffects/SubmixEffectFilter.h | |
| FilterFrequency | float | SubmixEffects/SubmixEffectFilter.h | ||
| FilterFrequencyMod | float | SubmixEffects/SubmixEffectFilter.h | ||
| FilterQ | float | SubmixEffects/SubmixEffectFilter.h | ||
| FilterQMod | float | SubmixEffects/SubmixEffectFilter.h | ||
| FilterType | ESubmixFilterType | SubmixEffects/SubmixEffectFilter.h | ||
| LadderFilter | Audio::FLadderFilter | SubmixEffects/SubmixEffectFilter.h | ||
| NumChannels | int32 | SubmixEffects/SubmixEffectFilter.h | ||
| OnePoleFilter | Audio::FOnePoleFilter | Filters for each channel and type. | SubmixEffects/SubmixEffectFilter.h | |
| SampleRate | float | Sample rate of the submix effect. | SubmixEffects/SubmixEffectFilter.h | |
| StateVariableFilter | Audio::FStateVariableFilter | SubmixEffects/SubmixEffectFilter.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Init
(
const FSoundEffectSubmixInitData& InData |
SubmixEffects/SubmixEffectFilter.h | ||
void SetFilterAlgorithm
(
ESubmixFilterAlgorithm InAlgorithm |
Sets the filter algorithm. | SubmixEffects/SubmixEffectFilter.h | |
void SetFilterCutoffFrequency
(
float InFrequency |
Sets the base filter cutoff frequency. | SubmixEffects/SubmixEffectFilter.h | |
void SetFilterCutoffFrequencyMod
(
float InFrequency |
Sets the mod filter cutoff frequency. | SubmixEffects/SubmixEffectFilter.h | |
void SetFilterQ
(
float InQ |
Sets the filter Q. | SubmixEffects/SubmixEffectFilter.h | |
void SetFilterQMod
(
float InQ |
Sets the filter Q. | SubmixEffects/SubmixEffectFilter.h | |
void SetFilterType
(
ESubmixFilterType InType |
Sets the filter type. | SubmixEffects/SubmixEffectFilter.h |
Overridden from FSoundEffectSubmix
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnProcessAudio
(
const FSoundEffectSubmixInputData& InData, |
SubmixEffects/SubmixEffectFilter.h |
Overridden from FSoundEffectBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnPresetChanged() |
SubmixEffects/SubmixEffectFilter.h |