FSubmixEffectSubmixEQ

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Protected variable

bool

 

bEQSettingsSet

Protected variable

TArray< FEQ >

 

FiltersPerChannel

Each of these filters is a 2 channel biquad filter. 1 for each stereo pair.

Protected variable

FSubmixEffectSu...

 

GameThreadEQSettings

Game thread copy of the eq setting.

Protected variable

float

 

NumOutputChannels

Protected variable

Audio::TParams<...

 

PendingSettings

A pending eq setting change.

Protected variable

FSubmixEffectSu...

 

RenderThreadEQSettings

Audio render thread copy of the eq setting.

Protected variable

float

 

SampleRate

Protected variable

float[2]

 

ScratchInBuffer

Protected variable

float[2]

 

ScratchOutBuffer

Constructors

Name Description

Public function

FSubmixEffectSubmixEQ()

Functions

Name Description

Protected function

void

 

UpdateParameters

(
    const int32 NumOutputChannels
)

Overridden from FSoundEffectSubmix

Name Description

Public function Virtual

void

 

Init

(
    const FSoundEffectSubmixInitData& ...
)

Called on an audio effect at initialization on main thread before audio processing begins.

Public function Virtual

void

 

OnProcessAudio

(
    const FSoundEffectSubmixInputData&...,
    FSoundEffectSubmixOutputData& OutD...
)

Process the input block of audio. Called on audio thread.

Public function Virtual

bool

 

SetParameters

(
    const FAudioEffectParameters& InPa...
)

Sets the effect parameters using the old audio engine preset setting object.

Public function Virtual Const

bool

 

SupportsDefaultEQ()

Whether or not effect supports default EQ system.

Overridden from FSoundEffectBase

Name Description

Public function Virtual

void

 

OnPresetChanged()

Called when an audio effect preset is changed.

Classes

Name

Description

Protected struct

FEQ

An EQ effect is a bank of biquad filters.