FAudioThread Class Reference

#include <AudioThread.h>

Static Public Member Functions
static ENGINE_API void	StartAudioThread ()
static ENGINE_API void	StopAudioThread ()
static ENGINE_API void	RunCommandOnAudioThread (TUniqueFunction< void()> InFunction, const TStatId InStatId=TStatId())
static ENGINE_API void	ProcessAllCommands ()
static ENGINE_API void	RunCommandOnGameThread (TUniqueFunction< void()> InFunction, const TStatId InStatId=TStatId())
static ENGINE_API void	SetUseThreadedAudio (bool bInUseThreadedAudio)
static ENGINE_API bool	IsUsingThreadedAudio ()
static ENGINE_API void	SuspendAudioThread ()
static ENGINE_API void	ResumeAudioThread ()
static ENGINE_API FString	GetCurrentAudioThreadStatId ()
static ENGINE_API void	ResetAudioThreadTimers ()
static ENGINE_API void	GetLongestTaskInfo (FString &OutLongestTask, double &OutLongestTaskTimeMs)

Member Function Documentation

GetCurrentAudioThreadStatId()

FString FAudioThread::GetCurrentAudioThreadStatId ( )

static

Retrieves the current audio thread stat id. Useful for reporting when an audio thread command stalls or deadlocks.

GetLongestTaskInfo()

void FAudioThread::GetLongestTaskInfo ( FString &  OutLongestTask, double &  OutLongestTaskTimeMs  )

static

IsUsingThreadedAudio()

bool FAudioThread::IsUsingThreadedAudio ( )

static

ProcessAllCommands()

void FAudioThread::ProcessAllCommands ( )

static

Processes all enqueued audio thread commands.

ResetAudioThreadTimers()

void FAudioThread::ResetAudioThreadTimers ( )

static

ResumeAudioThread()

void FAudioThread::ResumeAudioThread ( )

static

RunCommandOnAudioThread()

void FAudioThread::RunCommandOnAudioThread ( TUniqueFunction< void()>  InFunction, const TStatId  InStatId = TStatId()  )

static

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

RunCommandOnGameThread()

void FAudioThread::RunCommandOnGameThread ( TUniqueFunction< void()>  InFunction, const TStatId  InStatId = TStatId()  )

static

Execute a (presumably audio) command on the game thread. If GIsAudioThreadRunning is false the command will execute immediately

SetUseThreadedAudio()

void FAudioThread::SetUseThreadedAudio ( bool  bInUseThreadedAudio )

static

StartAudioThread()

void FAudioThread::StartAudioThread ( )

static

Starts the audio thread.

StopAudioThread()

void FAudioThread::StopAudioThread ( )

static

Stops the audio thread.

SuspendAudioThread()

void FAudioThread::SuspendAudioThread ( )

static

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Public/AudioThread.h
• Engine/Source/Runtime/Engine/Private/AudioThread.cpp