1. Epic GamesDeveloper
  3. FSoundEffectBase

FSoundEffectBase

Unreal Engine C++ API Reference > Runtime > Engine > Sound

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Sound/SoundEffectBase.h
Include #include "Sound/SoundEffectBase.h"

Syntax

class FSoundEffectBase

Variables

  Type Name Description
Protected variable FThreadSafeBool bChanged  
Protected variable FThreadSafeBool bIsActive  
Protected variable FThreadSafeBool bIsRunning  
Protected variable TQueue< TUniqueFunction< void()> > CommandQueue Effect command queue.
Protected variable TArray< uint8 > CurrentAudioThreadSettingsData  
Protected variable uint32 ParentPresetUniqueId  
Protected variable TWeakObjectPtr< USoundEffectPreset > Preset  
Protected variable FCriticalSection SettingsCritSect  

Constructors

  Type Name Description
Protected function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type 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 Returns the unique ID of the parent preset.
Public function USoundEffectPreset *  
Public function TWeakObjectPtr< USoundEffectPreset > &  
Public function Const bool Returns if the submix is active or bypassing audio.
Public function Const bool 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 Called when the sound effect's preset changed.
Protected function void 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page