1. Epic GamesDeveloper
  3. FAudioThread

FAudioThread

API > API/Runtime > API/Runtime/Engine

   
Name FAudioThread
Type class
Header File /Engine/Source/Runtime/Engine/Public/AudioThread.h
Include Path #include "AudioThread.h"

Syntax

class FAudioThread

Constants

Name Type Remarks Include Path
bUseThreadedAudio bool Whether to run with an audio thread AudioThread.h
CurrentAudioThreadStatId TStatId Stat id of the currently executing audio thread command. AudioThread.h
CurrentAudioThreadStatIdCS FCriticalSection   AudioThread.h
LongestAudioThreadStatId TStatId   AudioThread.h
LongestAudioThreadTimeMsec double   AudioThread.h
PostGC FDelegateHandle   AudioThread.h
PostGCDestroy FDelegateHandle   AudioThread.h
PreGC FDelegateHandle GC callback handles. AudioThread.h
PreGCDestroy FDelegateHandle   AudioThread.h
ResumeEvent TUniquePtr< UE::Tasks::FTaskEvent >   AudioThread.h
SuspendCount int32   AudioThread.h

Functions

Static

Name Remarks Include Path Unreal Specifiers

static TUniqueFunction< void()> GetCommandWrapper ( TUniqueFunction< void()> InFunction,
const TStatId InStatId
)

 A helper to apply stats and optional additional logging AudioThread.h  
Retrieves the current audio thread stat id. AudioThread.h  

static double GetCurrentLongestTime()

   AudioThread.h  

static void GetLongestTaskInfo ( FString& OutLongestTask,
double& OutLongestTaskTimeMs
)

   AudioThread.h  

static bool IsUsingThreadedAudio()

   AudioThread.h  

static void ProcessAllCommands()

 Processes all enqueued audio thread commands. AudioThread.h  

static void ResetAudioThreadTimers()

   AudioThread.h  

static void ResumeAudioThread()

   AudioThread.h  

static void RunCommandOnAudioThread ( TUniqueFunction< void()> InFunction,
const TStatId InStatId
)

 Execute a command on the audio thread. If it's safe the command will execute immediately. AudioThread.h  

static void RunCommandOnGameThread ( TUniqueFunction< void()> InFunction,
const TStatId InStatId
)

 Execute a (presumably audio) command on the game thread. AudioThread.h  

static void SetCurrentAudioThreadStatId ( TStatId InStatId
)

 Sets the current audio thread stat id. AudioThread.h  

static void SetLongestTimeAndId ( TStatId NewLongestId,
double LongestTimeMsec
)

   AudioThread.h  

static void SetUseThreadedAudio ( bool bInUseThreadedAudio
)

   AudioThread.h  

static void StartAudioThread()

 Starts the audio thread. AudioThread.h  

static void StopAudioThread()

 Stops the audio thread. AudioThread.h  

static void SuspendAudioThread()

   AudioThread.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page