FSoundEffectBase

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Sound/SoundEffectBase.h

Include

#include "Sound/SoundEffectBase.h"

Syntax

class FSoundEffectBase

Variables

Name Description

Protected variable

FThreadSafeBool

 

bChanged

Protected variable

FThreadSafeBool

 

bIsActive

Protected variable

FThreadSafeBool

 

bIsRunning

Protected variable

TQueue< TUnique...

 

CommandQueue

Effect command queue.

Protected variable

TArray< uint8 >

 

CurrentAudioThreadSettingsData

Protected variable

uint32

 

ParentPresetUniqueId

Protected variable

TWeakObjectPtr<...

 

Preset

Protected variable

FCriticalSectio...

 

SettingsCritSect

Constructors

Name Description

Protected function

FSoundEffectBase()

Destructors

Name Description

Public function Virtual

~FSoundEffectBase()

Functions

Name Description

Public function

void

 

EffectCommand

(
    TUniqueFunction< void()> Command
)

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

Public function Const

uint32

 

GetParentPresetId()

Returns the unique ID of the parent preset.

Public function

USoundEffect...

 

GetPreset()

Public function Const

bool

 

IsActive()

Returns if the submix is active or bypassing audio.

Public function Const

bool

 

IsPreset

(
    USoundEffectPreset* InPreset
)

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

Public function Virtual

void

 

OnPresetChanged()

Called when the sound effect's preset changed.

Protected function

void

 

PumpPendingMessages()

Pumps messages awaiting execution on the audio render thread

Public function

void

 

SetEnabled

(
    const bool bInIsEnabled
)

Enables the submix effect.

Public function

bool

 

Update()

Updates preset on audio render thread.