FSoundEffectSubmix Class Reference

#include <SoundEffectSubmix.h>

Inheritance diagram for FSoundEffectSubmix:

Public Member Functions
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 void	OnProcessAudio (const FSoundEffectSubmixInputData &InData, FSoundEffectSubmixOutputData &OutData)
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
virtual void	OnPresetChanged ()
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
	FSoundEffectSubmix ()
Protected Member Functions inherited from FSoundEffectBase
ENGINE_API	FSoundEffectBase ()
ENGINE_API void	PumpPendingMessages ()

Friends
class	USoundEffectPreset

Additional Inherited Members
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

~FSoundEffectSubmix()

virtual FSoundEffectSubmix::~FSoundEffectSubmix ( )

virtualdefault

FSoundEffectSubmix()

FSoundEffectSubmix::FSoundEffectSubmix ( )

inlineprotected

Member Function Documentation

GetDesiredInputChannelCountOverride()

virtual uint32 FSoundEffectSubmix::GetDesiredInputChannelCountOverride ( ) const

inlinevirtual

Reimplemented in FSubmixEffectReverb.

GetDryLevel()

virtual float FSoundEffectSubmix::GetDryLevel ( ) const

inlinevirtual

Reimplemented in FSubmixEffectReverb.

GetInitData()

const FSoundEffectSubmixInitData & FSoundEffectSubmix::GetInitData ( ) const

inline

OnProcessAudio()

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

inlinevirtual

Reimplemented in FSubmixEffectDynamicsProcessor, FSubmixEffectSubmixEQ, and FSubmixEffectReverb.

ProcessAudio()

bool FSoundEffectSubmix::ProcessAudio	(	FSoundEffectSubmixInputData &	InData,
		FSoundEffectSubmixOutputData &	OutData
	)

SetParameters()

virtual bool FSoundEffectSubmix::SetParameters ( const FAudioEffectParameters &  InParameters )

inlinevirtual

Reimplemented in FSubmixEffectSubmixEQ, and FSubmixEffectReverb.

Setup()

void FSoundEffectSubmix::Setup ( const FSoundEffectSubmixInitData &  InInitData )

inline

SupportsDefaultEQ()

virtual bool FSoundEffectSubmix::SupportsDefaultEQ ( ) const

inlinevirtual

Reimplemented in FSubmixEffectSubmixEQ.

SupportsDefaultReverb()

virtual bool FSoundEffectSubmix::SupportsDefaultReverb ( ) const

inlinevirtual

Reimplemented in FSubmixEffectReverb.

Tick()

virtual void FSoundEffectSubmix::Tick ( )

inlinevirtual

Friends And Related Symbol Documentation

USoundEffectPreset

friend class USoundEffectPreset

friend

---

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

• Engine/Source/Runtime/Engine/Classes/Sound/SoundEffectSubmix.h
• Engine/Source/Runtime/Engine/Private/SoundEffectSubmix.cpp