Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FAudioThread

Windows

MacOS

Linux

Inheritance Hierarchy

FRunnable

FAudioThread

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/AudioThread.h
Include	#include "AudioThread.h"

Syntax

class FAudioThread : public FRunnable

Constructors

	Name	Description
	FAudioThread()

Destructors

	Name	Description
	~FAudioThread()

Functions

	Name	Description
FString	GetCurrentAudioThreadStatId()	Retrieves the current audio thread stat id.
void	GetLongestTaskInfo ( FString& OutLongestTask, double& OutLongestTaskTimeMs )
bool	IsUsingThreadedAudio()
void	ProcessAllCommands()	Processes all enqueued audio thread commands.
void	ResetAudioThreadTimers()
void	ResumeAudioThread()
void	RunCommandOnAudioThread ( TFunction< void()> InFunction, const TStatId InStatId )	Execute a command on the audio thread.
void	RunCommandOnGameThread ( TFunction< void()> InFunction, const TStatId InStatId )	Execute a (presumably audio) command on the game thread.
void	SetUseThreadedAudio ( bool bInUseThreadedAudio )
void	StartAudioThread()	Starts the audio thread.
void	StopAudioThread()	Stops the audio thread.
void	SuspendAudioThread()

Overridden from FRunnable

	Name	Description
void	Exit()	Exits the runnable object.
bool	Init()	Initializes the runnable object.
uint32	Run()	Runs the runnable object.

Constants

Name	Description
AudioThreadRunnable	The audio thread itself.
bIsAudioThreadRunning	Whether the audio thread is currently running If this is false, then we have no audio thread and audio commands will be issued directly on the game thread
bUseThreadedAudio	Whether to run with an audio thread
CurrentAudioThreadStatId	Stat id of the currently executing audio thread command.
CurrentAudioThreadStatIdCS
LongestAudioThreadStatId
LongestAudioThreadTimeMsec

Deprecated Functions

		Name	Description
	bool	IsAudioThreadRunning()	Please use global `IsAudioThreadRunning()_

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss