UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::FAudioPlatformDeviceInfo Struct Reference

#include <AudioMixer.h>

Public Member Functions

 FAudioPlatformDeviceInfo ()
 
void Reset ()
 

Public Attributes

FString Name
 
FString DeviceId
 
int32 NumChannels
 
int32 NumDirectOutChannels
 
int32 SampleRate
 
EAudioMixerStreamDataFormat::Type Format
 
TArray< EAudioMixerChannel::TypeOutputChannelArray
 
uint8 bIsSystemDefault: 1
 

Detailed Description

Structure to hold platform device information

Constructor & Destructor Documentation

◆ FAudioPlatformDeviceInfo()

Audio::FAudioPlatformDeviceInfo::FAudioPlatformDeviceInfo ( )
inline

Member Function Documentation

◆ Reset()

void Audio::FAudioPlatformDeviceInfo::Reset ( )
inline

Member Data Documentation

◆ bIsSystemDefault

uint8 Audio::FAudioPlatformDeviceInfo::bIsSystemDefault

Whether or not this device is the system default

◆ DeviceId

FString Audio::FAudioPlatformDeviceInfo::DeviceId

ID of the device.

◆ Format

EAudioMixerStreamDataFormat::Type Audio::FAudioPlatformDeviceInfo::Format

The data format of the audio stream

◆ Name

FString Audio::FAudioPlatformDeviceInfo::Name

The name of the audio device

◆ NumChannels

int32 Audio::FAudioPlatformDeviceInfo::NumChannels

The number of channels supported by the audio device

◆ NumDirectOutChannels

int32 Audio::FAudioPlatformDeviceInfo::NumDirectOutChannels

The number of channels above the base stereo or 7.1 channels supported by the audio device

◆ OutputChannelArray

TArray<EAudioMixerChannel::Type> Audio::FAudioPlatformDeviceInfo::OutputChannelArray

The output channel array of the audio device

◆ SampleRate

int32 Audio::FAudioPlatformDeviceInfo::SampleRate

The sample rate of the audio device


The documentation for this struct was generated from the following file: