FSubmixEffectDynamicsProcessor Class Reference

#include <AudioMixerSubmixEffectDynamicsProcessor.h>

Inheritance diagram for FSubmixEffectDynamicsProcessor:

Public Member Functions
AUDIOMIXER_API	FSubmixEffectDynamicsProcessor ()
virtual AUDIOMIXER_API	~FSubmixEffectDynamicsProcessor ()
AUDIOMIXER_API Audio::FDeviceId	GetDeviceId () const
virtual AUDIOMIXER_API void	Init (const FSoundEffectSubmixInitData &InInitData) override
virtual AUDIOMIXER_API void	OnProcessAudio (const FSoundEffectSubmixInputData &InData, FSoundEffectSubmixOutputData &OutData) override
virtual AUDIOMIXER_API void	OnPresetChanged () override
Public Member Functions inherited from FSoundEffectSubmix
virtual	~FSoundEffectSubmix ()=default
virtual bool	SetParameters (const FAudioEffectParameters &InParameters)
virtual bool	SupportsDefaultReverb () const
virtual bool	SupportsDefaultEQ () 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 Audio::FMixerDevice *	GetMixerDevice ()
AUDIOMIXER_API void	ResetKey ()
AUDIOMIXER_API void	UpdateKeyFromSettings (const FSubmixEffectDynamicsProcessorSettings &InSettings)
AUDIOMIXER_API bool	UpdateKeySourcePatch ()
AUDIOMIXER_API void	OnDeviceCreated (Audio::FDeviceId InDeviceId)
AUDIOMIXER_API void	OnDeviceDestroyed (Audio::FDeviceId InDeviceId)
Protected Member Functions inherited from FSoundEffectSubmix
	FSoundEffectSubmix ()
Protected Member Functions inherited from FSoundEffectBase
ENGINE_API	FSoundEffectBase ()
ENGINE_API void	PumpPendingMessages ()

Protected Attributes
Audio::FAlignedFloatBuffer	AudioExternal
Audio::FDeviceId	DeviceId = INDEX_NONE
bool	bBypass = false
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

Friends
class	USubmixEffectDynamicsProcessorPreset

Constructor & Destructor Documentation

FSubmixEffectDynamicsProcessor()

FSubmixEffectDynamicsProcessor::FSubmixEffectDynamicsProcessor

(

)

~FSubmixEffectDynamicsProcessor()

FSubmixEffectDynamicsProcessor::~FSubmixEffectDynamicsProcessor ( )

virtual

Member Function Documentation

GetDeviceId()

Audio::FDeviceId FSubmixEffectDynamicsProcessor::GetDeviceId

(

)

const

GetMixerDevice()

Audio::FMixerDevice * FSubmixEffectDynamicsProcessor::GetMixerDevice ( )

protected

Init()

void FSubmixEffectDynamicsProcessor::Init ( const FSoundEffectSubmixInitData &  InInitData )

overridevirtual

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

Reimplemented from FSoundEffectSubmix.

OnDeviceCreated()

void FSubmixEffectDynamicsProcessor::OnDeviceCreated ( Audio::FDeviceId  InDeviceId )

protected

OnDeviceDestroyed()

void FSubmixEffectDynamicsProcessor::OnDeviceDestroyed ( Audio::FDeviceId  InDeviceId )

protected

OnPresetChanged()

void FSubmixEffectDynamicsProcessor::OnPresetChanged ( )

overridevirtual

Called when the sound effect's preset changed.

Reimplemented from FSoundEffectBase.

OnProcessAudio()

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

overridevirtual

Reimplemented from FSoundEffectSubmix.

ResetKey()

void FSubmixEffectDynamicsProcessor::ResetKey ( )

protected

UpdateKeyFromSettings()

void FSubmixEffectDynamicsProcessor::UpdateKeyFromSettings ( const FSubmixEffectDynamicsProcessorSettings &  InSettings )

protected

UpdateKeySourcePatch()

bool FSubmixEffectDynamicsProcessor::UpdateKeySourcePatch ( )

protected

Friends And Related Symbol Documentation

USubmixEffectDynamicsProcessorPreset

friend class USubmixEffectDynamicsProcessorPreset

friend

Member Data Documentation

AudioExternal

Audio::FAlignedFloatBuffer FSubmixEffectDynamicsProcessor::AudioExternal

protected

bBypass

bool FSubmixEffectDynamicsProcessor::bBypass = false

protected

DeviceId

Audio::FDeviceId FSubmixEffectDynamicsProcessor::DeviceId = INDEX_NONE

protected

---

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

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