Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Sound
Inheritance Hierarchy
- FSoundEffectBase
- FSoundEffectSource
- FSoundEffectSubmix
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Classes/Sound/SoundEffectBase.h |
| Include | #include "Sound/SoundEffectBase.h" |
Syntax
class FSoundEffectBase
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FThreadSafeBool | bChanged | |
 |
FThreadSafeBool | bIsActive | |
 |
FThreadSafeBool | bIsRunning | |
 |
TQueue< TUniqueFunction< void()> > | CommandQueue | Effect command queue. |
 |
TArray< uint8 > | CurrentAudioThreadSettingsData | |
 |
uint32 | ParentPresetUniqueId | |
 |
TWeakObjectPtr< USoundEffectPreset > | Preset | |
 |
FCriticalSection | SettingsCritSect |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | EffectCommand
(
TUniqueFunction< void()> Command |
Enqueues a lambda command on a thread safe queue which is pumped from the audio render thread. |
  |
uint32 | Returns the unique ID of the parent preset. | |
 |
USoundEffectPreset * | GetPreset () |
|
 |
TWeakObjectPtr< USoundEffectPreset > & | GetPresetPtr () |
|
  |
bool | IsActive () |
Returns if the submix is active or bypassing audio. |
  |
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. |
  |
void | Called when the sound effect's preset changed. | |
 |
void | Pumps messages awaiting execution on the audio render thread | |
 |
void | SetEnabled
(
const bool bInIsEnabled |
Enables the submix effect. |
 |
bool | Update () |
Updates preset on audio render thread. |