Navigation
API > API/Runtime > API/Runtime/Engine
| Name | FSoundEffectBase |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Sound/SoundEffectBase.h |
| Include Path | #include "Sound/SoundEffectBase.h" |
Syntax
class FSoundEffectBase
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSoundEffectBase() |
Sound/SoundEffectBase.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSoundEffectBase() |
Sound/SoundEffectBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void EffectCommand
(
TUniqueFunction< void()> Command |
Enqueues a lambda command on a thread safe queue which is pumped from the audio render thread. | Sound/SoundEffectBase.h | |
uint32 GetParentPresetId() |
Returns the unique ID of the parent preset. | Sound/SoundEffectBase.h | |
USoundEffectPreset * GetPreset() |
Sound/SoundEffectBase.h | ||
TWeakObjectPtr< USoundEffectPreset > & GetPresetPtr() |
Sound/SoundEffectBase.h | ||
bool IsActive() |
Returns if the submix is active or bypassing audio. | Sound/SoundEffectBase.h | |
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. | Sound/SoundEffectBase.h | |
virtual void OnPresetChanged() |
Called when the sound effect's preset changed. | Sound/SoundEffectBase.h | |
void SetEnabled
(
const bool bInIsEnabled |
Enables the submix effect. | Sound/SoundEffectBase.h | |
bool Update () |
Updates preset on audio render thread. | Sound/SoundEffectBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void PumpPendingMessages() |
Pumps messages awaiting execution on the audio render thread | Sound/SoundEffectBase.h |