FSubmixEffectSubmixEQ Class Reference

#include <AudioMixerSubmixEffectEQ.h>

Inheritance diagram for FSubmixEffectSubmixEQ:

Classes
struct	FEQ

Public Member Functions
AUDIOMIXER_API	FSubmixEffectSubmixEQ ()
virtual AUDIOMIXER_API void	Init (const FSoundEffectSubmixInitData &InSampleRate) override
virtual AUDIOMIXER_API void	OnProcessAudio (const FSoundEffectSubmixInputData &InData, FSoundEffectSubmixOutputData &OutData) override
virtual AUDIOMIXER_API bool	SetParameters (const FAudioEffectParameters &InParameters) override
virtual bool	SupportsDefaultEQ () const override
virtual AUDIOMIXER_API void	OnPresetChanged () override
Public Member Functions inherited from FSoundEffectSubmix
virtual	~FSoundEffectSubmix ()=default
virtual bool	SupportsDefaultReverb () const
virtual void	Tick ()
virtual uint32	GetDesiredInputChannelCountOverride () const
virtual float	GetDryLevel () const
ENGINE_API bool	ProcessAudio (FSoundEffectSubmixInputData &InData, FSoundEffectSubmixOutputData &OutData)
void	Setup (const FSoundEffectSubmixInitData &InInitData)
const FSoundEffectSubmixInitData &	GetInitData () const
Public Member Functions inherited from FSoundEffectBase
virtual	~FSoundEffectBase ()=default
ENGINE_API bool	IsActive () const
ENGINE_API void	SetEnabled (const bool bInIsEnabled)
ENGINE_API bool	Update ()
ENGINE_API USoundEffectPreset *	GetPreset ()
ENGINE_API TWeakObjectPtr< USoundEffectPreset > &	GetPresetPtr ()
ENGINE_API bool	IsPreset (USoundEffectPreset *InPreset) const
ENGINE_API void	EffectCommand (TUniqueFunction< void()> Command)
uint32	GetParentPresetId () const

Protected Member Functions
AUDIOMIXER_API void	UpdateParameters (const int32 NumOutputChannels)
Protected Member Functions inherited from FSoundEffectSubmix
	FSoundEffectSubmix ()
Protected Member Functions inherited from FSoundEffectBase
ENGINE_API	FSoundEffectBase ()
ENGINE_API void	PumpPendingMessages ()

Protected Attributes
TArray< FEQ >	FiltersPerChannel
float	ScratchInBuffer [2]
float	ScratchOutBuffer [2]
float	SampleRate
float	NumOutputChannels
bool	bEQSettingsSet
Audio::TParams< FSubmixEffectSubmixEQSettings >	PendingSettings
FSubmixEffectSubmixEQSettings	GameThreadEQSettings
FSubmixEffectSubmixEQSettings	RenderThreadEQSettings
Protected Attributes inherited from FSoundEffectBase
FCriticalSection	SettingsCritSect
TArray< uint8 >	CurrentAudioThreadSettingsData
FThreadSafeBool	bChanged
TWeakObjectPtr< USoundEffectPreset >	Preset
uint32	ParentPresetUniqueId = uint32(INDEX_NONE)
FThreadSafeBool	bIsRunning
FThreadSafeBool	bIsActive
TQueue< TUniqueFunction< void()> >	CommandQueue

Constructor & Destructor Documentation

FSubmixEffectSubmixEQ()

FSubmixEffectSubmixEQ::FSubmixEffectSubmixEQ

(

)

Member Function Documentation

Init()

void FSubmixEffectSubmixEQ::Init ( const FSoundEffectSubmixInitData &  InInitData )

overridevirtual

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

Reimplemented from FSoundEffectSubmix.

OnPresetChanged()

void FSubmixEffectSubmixEQ::OnPresetChanged ( )

overridevirtual

Called when the sound effect's preset changed.

Reimplemented from FSoundEffectBase.

OnProcessAudio()

void FSubmixEffectSubmixEQ::OnProcessAudio ( const FSoundEffectSubmixInputData &  InData, FSoundEffectSubmixOutputData &  OutData  )

overridevirtual

Reimplemented from FSoundEffectSubmix.

SetParameters()

bool FSubmixEffectSubmixEQ::SetParameters ( const FAudioEffectParameters &  InParameters )

overridevirtual

Reimplemented from FSoundEffectSubmix.

SupportsDefaultEQ()

virtual bool FSubmixEffectSubmixEQ::SupportsDefaultEQ ( ) const

inlineoverridevirtual

Reimplemented from FSoundEffectSubmix.

UpdateParameters()

void FSubmixEffectSubmixEQ::UpdateParameters ( const int32  NumOutputChannels )

protected

Member Data Documentation

bEQSettingsSet

bool FSubmixEffectSubmixEQ::bEQSettingsSet

protected

FiltersPerChannel

TArray<FEQ> FSubmixEffectSubmixEQ::FiltersPerChannel

protected

GameThreadEQSettings

FSubmixEffectSubmixEQSettings FSubmixEffectSubmixEQ::GameThreadEQSettings

protected

NumOutputChannels

float FSubmixEffectSubmixEQ::NumOutputChannels

protected

PendingSettings

Audio::TParams<FSubmixEffectSubmixEQSettings> FSubmixEffectSubmixEQ::PendingSettings

protected

RenderThreadEQSettings

FSubmixEffectSubmixEQSettings FSubmixEffectSubmixEQ::RenderThreadEQSettings

protected

SampleRate

float FSubmixEffectSubmixEQ::SampleRate

protected

ScratchInBuffer

float FSubmixEffectSubmixEQ::ScratchInBuffer[2]

protected

ScratchOutBuffer

float FSubmixEffectSubmixEQ::ScratchOutBuffer[2]

protected

---

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

• Engine/Source/Runtime/AudioMixer/Classes/SubmixEffects/AudioMixerSubmixEffectEQ.h
• Engine/Source/Runtime/AudioMixer/Private/Effects/AudioMixerSubmixEffectEQ.cpp