FSubmixEffectReverb Class Reference

#include <AudioMixerSubmixEffectReverb.h>

Inheritance diagram for FSubmixEffectReverb:

Public Member Functions
AUDIOMIXER_API	FSubmixEffectReverb ()
virtual AUDIOMIXER_API void	Init (const FSoundEffectSubmixInitData &InSampleRate) override
virtual AUDIOMIXER_API void	OnPresetChanged () override
virtual uint32	GetDesiredInputChannelCountOverride () const override
virtual AUDIOMIXER_API void	OnProcessAudio (const FSoundEffectSubmixInputData &InData, FSoundEffectSubmixOutputData &OutData) override
virtual AUDIOMIXER_API bool	SetParameters (const FAudioEffectParameters &InParameters) override
virtual bool	SupportsDefaultReverb () const override
virtual float	GetDryLevel () const override
Public Member Functions inherited from FSoundEffectSubmix
virtual	~FSoundEffectSubmix ()=default
virtual bool	SupportsDefaultEQ () const
virtual void	Tick ()
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

Additional Inherited Members
Protected Member Functions inherited from FSoundEffectSubmix
	FSoundEffectSubmix ()
Protected Member Functions inherited from FSoundEffectBase
ENGINE_API	FSoundEffectBase ()
ENGINE_API void	PumpPendingMessages ()
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

FSubmixEffectReverb()

FSubmixEffectReverb::FSubmixEffectReverb

(

)

Member Function Documentation

GetDesiredInputChannelCountOverride()

virtual uint32 FSubmixEffectReverb::GetDesiredInputChannelCountOverride ( ) const

inlineoverridevirtual

Reimplemented from FSoundEffectSubmix.

GetDryLevel()

virtual float FSubmixEffectReverb::GetDryLevel ( ) const

inlineoverridevirtual

Reimplemented from FSoundEffectSubmix.

Init()

void FSubmixEffectReverb::Init ( const FSoundEffectSubmixInitData &  InInitData )

overridevirtual

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

Reimplemented from FSoundEffectSubmix.

OnPresetChanged()

void FSubmixEffectReverb::OnPresetChanged ( )

overridevirtual

Called when the sound effect's preset changed.

Reimplemented from FSoundEffectBase.

OnProcessAudio()

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

overridevirtual

Reimplemented from FSoundEffectSubmix.

SetParameters()

bool FSubmixEffectReverb::SetParameters ( const FAudioEffectParameters &  InParameters )

overridevirtual

Reimplemented from FSoundEffectSubmix.

SupportsDefaultReverb()

virtual bool FSubmixEffectReverb::SupportsDefaultReverb ( ) const

inlineoverridevirtual

Reimplemented from FSoundEffectSubmix.

---

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

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