FSoundEffectBase Class Reference

#include <SoundEffectBase.h>

Inheritance diagram for FSoundEffectBase:

Public Member Functions
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
ENGINE_API	FSoundEffectBase ()
ENGINE_API void	PumpPendingMessages ()

Protected Attributes
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	USoundEffectPreset

Constructor & Destructor Documentation

~FSoundEffectBase()

virtual FSoundEffectBase::~FSoundEffectBase ( )

virtualdefault

FSoundEffectBase()

FSoundEffectBase::FSoundEffectBase ( )

protected

Member Function Documentation

EffectCommand()

void FSoundEffectBase::EffectCommand

(

TUniqueFunction< void()>

Command

)

Enqueues a lambda command on a thread safe queue which is pumped from the audio render thread.

GetParentPresetId()

uint32 FSoundEffectBase::GetParentPresetId ( ) const

inline

Returns the unique ID of the parent preset.

GetPreset()

USoundEffectPreset * FSoundEffectBase::GetPreset

(

)

GetPresetPtr()

TWeakObjectPtr< USoundEffectPreset > & FSoundEffectBase::GetPresetPtr

(

)

IsActive()

bool FSoundEffectBase::IsActive

(

)

const

Returns if the submix is active or bypassing audio.

IsPreset()

bool FSoundEffectBase::IsPreset

(

USoundEffectPreset *

InPreset

)

const

Queries if the given preset object is the uobject preset for this preset instance, i.e. the preset which spawned this effect instance.

OnPresetChanged()

virtual void FSoundEffectBase::OnPresetChanged ( )

inlinevirtual

Called when the sound effect's preset changed.

Reimplemented in FSubmixEffectDynamicsProcessor, FSubmixEffectSubmixEQ, and FSubmixEffectReverb.

PumpPendingMessages()

void FSoundEffectBase::PumpPendingMessages ( )

protected

Pumps messages awaiting execution on the audio render thread

SetEnabled()

void FSoundEffectBase::SetEnabled

(

const bool

bInIsEnabled

)

Enables the submix effect.

Update()

bool FSoundEffectBase::Update

(

)

Updates preset on audio render thread. Returns true if update processed a preset update, false if not.

Friends And Related Symbol Documentation

USoundEffectPreset

friend class USoundEffectPreset

friend

Member Data Documentation

bChanged

FThreadSafeBool FSoundEffectBase::bChanged

protected

bIsActive

FThreadSafeBool FSoundEffectBase::bIsActive

protected

bIsRunning

FThreadSafeBool FSoundEffectBase::bIsRunning

protected

CommandQueue

TQueue<TUniqueFunction<void()> > FSoundEffectBase::CommandQueue

protected

CurrentAudioThreadSettingsData

TArray<uint8> FSoundEffectBase::CurrentAudioThreadSettingsData

protected

ParentPresetUniqueId

uint32 FSoundEffectBase::ParentPresetUniqueId = uint32(INDEX_NONE)

protected

Preset

TWeakObjectPtr<USoundEffectPreset> FSoundEffectBase::Preset

protected

SettingsCritSect

FCriticalSection FSoundEffectBase::SettingsCritSect

protected

---

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

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