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

> Unreal Engine API Reference > Runtime > UnrealAudio

Light Theme

Dark Theme

UnrealAudio

Windows

MacOS

Linux

Classes

	Name	Description
	FSoundFileConvertFormat
	FSoundFileDescription	Specifes a sound file description.
	FVoiceInitializationParams	A voice initialization parameters.
	IEmitter	IEmitter interface.
	ISoundFile	ISoundFile
	IUnrealAudioModule	High-level unreal audio module for managing, playing, and updating audio in the unreal engine.
	IVoice	An IVoice interface
	IVoiceListener	An object interface for listening to voice events.

Enums

	Name	Description
	UAudio::EDeviceApi::Type
	UAudio::EDeviceError::Type
	UAudio::ESoundFileChannelMap::Type	Enumeration to specify a sound files intended output channel mapping.
	UAudio::ESoundFileError::Type
	UAudio::ESoundFileFormat::Flags	Specifies the major format type of the sound source.
	UAudio::ESoundFileState::Type
	UAudio::ESpeaker::Type	Values that represent speaker types.
	UAudio::ESystemError::Type
	UAudio::EVoiceError::Type
	UAudio::EVoicePlayingState::Type
	UAudio::EVoiceState::Type

Functions

	Name	Description
const TCHAR ...	UAudio::EDeviceApi::ToString ( EDeviceApi::Type DeviceApi )
const TCHAR ...	UAudio::EDeviceError::ToString ( EDeviceError::Type DeviceError )
const TCHAR ...	UAudio::ESoundFileChannelMap::ToString ( ESoundFileChannelMap::Type ChannelM... )
const TCHAR ...	UAudio::ESoundFileError::ToString ( ESoundFileError::Type SoundFileErro... )
const TCHAR ...	UAudio::ESoundFileFormat::ToStringMajor ( int32 FormatFlags )
const TCHAR ...	UAudio::ESoundFileFormat::ToStringMinor ( int32 FormatFlags )
const TCHAR ...	UAudio::ESpeaker::ToString ( ESpeaker::Type Speaker )
const TCHAR ...	UAudio::ESystemError::ToString ( ESystemError::Type SystemError )
const TCHAR ...	UAudio::EVoiceError::ToString ( EVoiceError::Type VoiceError )
const TCHAR ...	UAudio::EVoicePlayingState::ToString ( EVoicePlayingState::Type PlayingSta... )
const TCHAR ...	UAudio::EVoiceState::ToString ( EVoiceState::Type VoiceState )
bool	UAudio::GetFileExtensionForFormatFlags ( int32 FormatFlags, FString& OutExtension )
bool	UAudio::GetSoundFileDescription ( const FString& FilePath, FSoundFileDescription& OutputDescr... )
bool	UAudio::GetSoundFileDescription ( const FString& FilePath, FSoundFileDescription& OutputDescr..., TArray< ESoundFileChannelMap::Type ... )
void	UAudio::GetSoundFileListInDirectory ( FString& Directory, TArray< FString >& SoundFiles, bool bRecursive )
bool	UAudio::TestDeviceOutputNoisePan ( double TestTime )	TestDeviceOutputNoisePan
bool	UAudio::TestDeviceOutputRandomizedFm ( double TestTime )	TestDeviceOutputRandomizedFm
bool	UAudio::TestDeviceOutputSimple ( double TestTime )	TestDeviceOutputSimple
bool	UAudio::TestDeviceQuery()	TestDeviceQuery
bool	UAudio::TestEmitterManager()	TestEmitterManager
bool	UAudio::TestSoundFileManager ( const FString& FolderOrPath )
bool	UAudio::TestSourceConvert ( const FString& FilePath, const FSoundFileConvertFormat& Con... )	TestSourceConvert Tests converting a sound file.
bool	UAudio::TestVoiceManager ( const FString& FolderOrPath )	TestVoiceManager

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

Take our survey

Dismiss