Navigation
API > API/Runtime > API/Runtime/AudioMixer > API/Runtime/AudioMixer/SubmixEffects
Inheritance Hierarchy
- FSoundEffectBase
- FSoundEffectSubmix
- FSubmixEffectSubmixEQ
References
| Module | AudioMixer |
| Header | /Engine/Source/Runtime/AudioMixer/Classes/SubmixEffects/AudioMixerSubmixEffectEQ.h |
| Include | #include "SubmixEffects/AudioMixerSubmixEffectEQ.h" |
Syntax
class FSubmixEffectSubmixEQ : public FSoundEffectSubmix
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bEQSettingsSet | ||
| TArray< FEQ > | FiltersPerChannel | Each of these filters is a 2 channel biquad filter. 1 for each stereo pair. | |
| FSubmixEffectSubmixEQSettings | GameThreadEQSettings | Game thread copy of the eq setting. | |
| float | NumOutputChannels | ||
| Audio::TParams< FSubmixEffectSubmixEQSettings > | PendingSettings | A pending eq setting change. | |
| FSubmixEffectSubmixEQSettings | RenderThreadEQSettings | Audio render thread copy of the eq setting. | |
| float | SampleRate | ||
| float[2] | ScratchInBuffer | ||
| float[2] | ScratchOutBuffer |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | UpdateParameters
(
const int32 NumOutputChannels |
Overridden from FSoundEffectSubmix
| Type | Name | Description | |
|---|---|---|---|
| void | Init
(
const FSoundEffectSubmixInitData& InSampleRate |
Called on an audio effect at initialization on main thread before audio processing begins. | |
| void | OnProcessAudio
(
const FSoundEffectSubmixInputData& InData, |
Process the input block of audio. Called on audio thread. | |
| bool | SetParameters
(
const FAudioEffectParameters& InParameters |
Sets the effect parameters using the old audio engine preset setting object. | |
| bool | Whether or not effect supports default EQ system. |
Overridden from FSoundEffectBase
| Type | Name | Description | |
|---|---|---|---|
| void | Called when an audio effect preset is changed. |
Classes
| Type | Name | Description | |
|---|---|---|---|
| FEQ | An EQ effect is a bank of biquad filters. |