Navigation
| Name | AudioMixerCore |
| Type | Runtime |
| Location | /Engine/Source/Runtime/AudioMixerCore/ |
| Module Build Rules | AudioMixerCore.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FAudioMixerPlatformSwappable | Audio mixer platform objects can subclass this in order to add device swap capabilities. |
| FMixerNullCallback | FMixerNullCallback This class, when started, spawns a new high priority thread that exists to query an FAudioMixerPlatformInterface and immediately throw out whatever buffers it receives. |
| FOutputBuffer | Class which wraps an output float buffer and handles conversion to device stream formats. |
Structs
| Name | Remarks |
|---|---|
| FAudioMixerOpenStreamParams | Defines parameters needed for opening a new audio stream to device. |
| FAudioOutputStreamInfo | |
| FAudioPlatformDeviceInfo | Structure to hold platform device information |
| FAudioPlatformSettings | |
| FAudioRenderTimeAnalysis | Struct used to store render time analysis data. |
| FDeviceSwapContext | |
| FDeviceSwapResult |
Interfaces
| Name | Remarks |
|---|---|
| IAudioDeviceModule | Defines the interface of a module implementing an audio device and associated classes. |
| IAudioMixer | Platform independent audio mixer interface. |
| IAudioMixerDeviceChangedListener | Abstract interface for receiving audio device changed notifications |
| IAudioMixerPlatformInterface | Abstract interface for mixer platform. |
| IAudioPlatformDeviceInfoCache | Interface for Caching Device Info. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FDeviceId | uint32 | Typed identifier for Audio Device Id | AudioDefines.h |
| FSoundWaveProxyPtr | TSharedPtr< FSoundWaveProxy, ESPMode::ThreadSafe > | AudioMixer.h | |
| FSoundWavePtr | TSharedPtr< FSoundWaveData, ESPMode::ThreadSafe > | AudioMixer.h |
Enums
Public
| Name | Remarks |
|---|---|
| Audio::EAudioDeviceRole | Common Audio namespace Type Definitions/Identifiers |
| Audio::EAudioDeviceState | Common Audio namespace Type Definitions/Identifiers |
| Audio::EAudioMixerStreamDataFormat::Type | |
| Audio::EAudioOutputStreamState::Type | EAudioOutputStreamState Specifies the state of the output audio stream. |
| Audio::EDeviceEndpointType | Common Audio namespace Type Definitions/Identifiers |
| EAudioMixerChannel::Type | Enumeration values represent sound file or speaker channel types. |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| MaxSupportedChannel | int32 | AudioMixer.h | ||
| MonoUpmixEqualPower | float | AudioDefines.h | ||
| MonoUpmixFullVolume | float | Magic numbers for mono upmix method. | AudioDefines.h | |
| MonoUpmixLinear | float | AudioDefines.h | ||
| STATCAT_Advanced | Cycle stats for audio mixer. | AudioMixer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FName Audio::NAME_ADPCM
(
TEXT("ADPCM") |
AudioMixerTypes.h | ||
FName Audio::NAME_BINKA
(
TEXT("BINKA") |
Supported on all platforms: | AudioMixerTypes.h | |
FName Audio::NAME_OGG
(
TEXT("OGG") |
Not yet supported on all platforms as a selectable option so is included under "platform specific" enumeration for now. | AudioMixerTypes.h | |
FName Audio::NAME_OPUS
(
TEXT("OPUS") |
AudioMixerTypes.h | ||
FName Audio::NAME_PCM
(
TEXT("PCM") |
AudioMixerTypes.h | ||
FName Audio::NAME_PLATFORM_SPECIFIC
(
TEXT("PLATFORM_SPECIFIC") |
Indicates a platform-specific format. | AudioMixerTypes.h | |
FName Audio::NAME_PROJECT_DEFINED
(
TEXT("PROJECT_DEFINED") |
AudioMixerTypes.h | ||
FName Audio::NAME_RADA
(
TEXT("RADA") |
AudioMixerTypes.h | ||
const TCHAR * EAudioMixerChannel::ToString
(
EAudioMixerChannel::Type InType |
AudioMixer.h |