UnrealAudio

Windows
MacOS
Linux

Classes

Name

Description

Public struct

FSoundFileConvertFormat

Public struct

FSoundFileDescription

Specifes a sound file description.

Public struct

FVoiceInitializationParams

A voice initialization parameters.

Public class

IEmitter

IEmitter interface.

Public class

ISoundFile

ISoundFile

Public class

IUnrealAudioModule

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

Public class

IVoice

An IVoice interface

Public class

IVoiceListener

An object interface for listening to voice events.

Enums

Functions

Name Description

Public function Static

const TCHAR ...

 

UAudio::EDeviceApi::ToString

(
    EDeviceApi::Type DeviceApi
)

Public function Static

const TCHAR ...

 

UAudio::EDeviceError::ToString

(
    EDeviceError::Type DeviceError
)

Public function

const TCHAR ...

 

UAudio::ESoundFileChannelMap::ToString

(
    ESoundFileChannelMap::Type ChannelM...
)

Public function

const TCHAR ...

 

UAudio::ESoundFileError::ToString

(
    ESoundFileError::Type SoundFileErro...
)

Public function

const TCHAR ...

 

UAudio::ESoundFileFormat::ToStringMajor

(
    int32 FormatFlags
)

Public function

const TCHAR ...

 

UAudio::ESoundFileFormat::ToStringMinor

(
    int32 FormatFlags
)

Public function Static

const TCHAR ...

 

UAudio::ESpeaker::ToString

(
    ESpeaker::Type Speaker
)

Public function Static

const TCHAR ...

 

UAudio::ESystemError::ToString

(
    ESystemError::Type SystemError
)

Public function

const TCHAR ...

 

UAudio::EVoiceError::ToString

(
    EVoiceError::Type VoiceError
)

Public function

const TCHAR ...

 

UAudio::EVoicePlayingState::ToString

(
    EVoicePlayingState::Type PlayingSta...
)

Public function

const TCHAR ...

 

UAudio::EVoiceState::ToString

(
    EVoiceState::Type VoiceState
)

Public function

bool

 

UAudio::GetFileExtensionForFormatFlags

(
    int32 FormatFlags,
    FString& OutExtension
)

Public function

bool

 

UAudio::GetSoundFileDescription

(
    const FString& FilePath,
    FSoundFileDescription& OutputDescr...
)

Public function

bool

 

UAudio::GetSoundFileDescription

(
    const FString& FilePath,
    FSoundFileDescription& OutputDescr...,
    TArray< ESoundFileChannelMap::Type ...
)

Public function

void

 

UAudio::GetSoundFileListInDirectory

(
    FString& Directory,
    TArray< FString >& SoundFiles,
    bool bRecursive
)

Public function

bool

 

UAudio::TestDeviceOutputNoisePan

(
    double TestTime
)

TestDeviceOutputNoisePan

Public function

bool

 

UAudio::TestDeviceOutputRandomizedFm

(
    double TestTime
)

TestDeviceOutputRandomizedFm

Public function

bool

 

UAudio::TestDeviceOutputSimple

(
    double TestTime
)

TestDeviceOutputSimple

Public function

bool

 

UAudio::TestDeviceQuery()

TestDeviceQuery

Public function

bool

 

UAudio::TestEmitterManager()

TestEmitterManager

Public function

bool

 

UAudio::TestSoundFileManager

(
    const FString& FolderOrPath
)

Public function

bool

 

UAudio::TestSourceConvert

(
    const FString& FilePath,
    const FSoundFileConvertFormat& Con...
)

TestSourceConvert

Tests converting a sound file.

Public function

bool

 

UAudio::TestVoiceManager

(
    const FString& FolderOrPath
)

TestVoiceManager

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback