UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Friends | List of all members
FSoundEffectSource Class Referenceabstract

#include <SoundEffectSource.h>

+ Inheritance diagram for FSoundEffectSource:

Public Member Functions

virtual ~FSoundEffectSource ()=default
 
void Setup (const FSoundEffectSourceInitData &InInitData)
 
const FSoundEffectSourceInitData & GetInitializedData () const
 
virtual void ProcessAudio (const FSoundEffectSourceInputData &InData, float *OutAudioBufferData)=0
 
- Public Member Functions inherited from FSoundEffectBase
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
 

Friends

class USoundEffectPreset
 

Additional Inherited Members

- Protected Member Functions inherited from FSoundEffectBase
ENGINE_API FSoundEffectBase ()
 
ENGINE_API void PumpPendingMessages ()
 
- Protected Attributes inherited from FSoundEffectBase
FCriticalSection SettingsCritSect
 
TArray< uint8 > CurrentAudioThreadSettingsData
 
FThreadSafeBool bChanged
 
TWeakObjectPtr< USoundEffectPreset > Preset
 
uint32 ParentPresetUniqueId = uint32(INDEX_NONE)
 
FThreadSafeBool bIsRunning
 
FThreadSafeBool bIsActive
 
TQueue< TUniqueFunction< void()> > CommandQueue
 

Constructor & Destructor Documentation

◆ ~FSoundEffectSource()

virtual FSoundEffectSource::~FSoundEffectSource ( )
virtualdefault

Member Function Documentation

◆ GetInitializedData()

const FSoundEffectSourceInitData & FSoundEffectSource::GetInitializedData ( ) const
inline

◆ ProcessAudio()

virtual void FSoundEffectSource::ProcessAudio ( const FSoundEffectSourceInputData &  InData,
float *  OutAudioBufferData 
)
pure virtual

◆ Setup()

void FSoundEffectSource::Setup ( const FSoundEffectSourceInitData &  InInitData)
inline

Friends And Related Symbol Documentation

◆ USoundEffectPreset

friend class USoundEffectPreset
friend
The documentation for this class was generated from the following file: