FAudioPlatformSettings Struct Reference

#include <AudioMixerTypes.h>

Public Member Functions
	FAudioPlatformSettings ()

Static Public Member Functions
static AUDIOMIXERCORE_API FAudioPlatformSettings	GetPlatformSettings (const TCHAR *PlatformSettingsConfigFile)

Public Attributes
int32	SampleRate
int32	CallbackBufferFrameSize
int32	NumBuffers
int32	MaxChannels
int32	NumSourceWorkers

Constructor & Destructor Documentation

FAudioPlatformSettings()

FAudioPlatformSettings::FAudioPlatformSettings ( )

inline

Member Function Documentation

GetPlatformSettings()

FAudioPlatformSettings FAudioPlatformSettings::GetPlatformSettings ( const TCHAR *  PlatformSettingsConfigFile )

static

Member Data Documentation

CallbackBufferFrameSize

int32 FAudioPlatformSettings::CallbackBufferFrameSize

The amount of audio to compute each callback block. Lower values decrease latency but may increase CPU cost.

MaxChannels

int32 FAudioPlatformSettings::MaxChannels

The max number of channels (simultaneous voices) to use as the limit for this platform. If given a value of 0, it will use the value from the active Global Audio Quality Settings

NumBuffers

int32 FAudioPlatformSettings::NumBuffers

The number of buffers to keep enqueued. More buffers increases latency, but can compensate for variable compute availability in audio callbacks on some platforms.

NumSourceWorkers

int32 FAudioPlatformSettings::NumSourceWorkers

The number of workers to use to compute source audio. Will only use up to the max number of sources. Will evenly divide sources to each source worker.

SampleRate

int32 FAudioPlatformSettings::SampleRate

Sample rate to use on the platform for the mixing engine. Higher sample rates will incur more CPU cost.

---

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

• Engine/Source/Runtime/AudioMixerCore/Public/AudioMixerTypes.h
• Engine/Source/Runtime/AudioMixerCore/Private/AudioMixer.cpp