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

IUnrealAudioModule

High-level unreal audio module for managing, playing, and updating audio in the unreal engine.

Windows

MacOS

Linux

Inheritance Hierarchy

IModuleInterface

IUnrealAudioModule

References

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

Syntax

class IUnrealAudioModule : public IModuleInterface

Remarks

High-level unreal audio module for managing, playing, and updating audio in the unreal engine.

Destructors

	Name	Description
	~IUnrealAudioModule()	Destructor.

Functions

	Name	Description
void	ConvertSound ( const FString& FilePath, const FString& OutputFilePath, const FSoundFileConvertFormat& Con... )
void	ConvertSound ( const FString& FilePath, const FString& OutputFilePath )
TSharedPtr< ...	EmitterCreate()	Emitter create.
IUnrealAudio...	GetDeviceModule()
int32	GetNumBackgroundTasks()
int32	GetNumSoundFilesLoaded()	Returns the number of sound files currently loaded
int32	GetNumSoundFilesStreamed()	Returns the number of sound files currently streamed
int32	GetSoundFileNumBytes()	Returns the number of total bytes of sound files loaded
float	GetSoundFilePercentageOfTargetMemoryLimit()	Returns the percentage of loaded memory as fraction of target memory limit
bool	Initialize ( const FString& DeviceModuleName )	Initializes this object.
bool	Initialize()	Initializes this object.
TSharedPtr< ...	LoadSoundFile ( const FName& Path, bool bLoadAsync )
TSharedPtr< ...	LoadSoundFile ( const FName& Name, TArray< uint8 >& InBulkData )
void	LogSoundFileMemoryInfo()	Logs sound file information
void	Shutdown()	Shuts down this object and frees any resources it is using.
TSharedPtr< ...	StreamSoundFile ( const FName& Path, bool bLoadAsync )
void	Update()	Updates this object.
TSharedPtr< ...	VoiceCreate ( const FVoiceInitializationParams& ... )	Voice create.

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

Take our survey

Dismiss