UAudioSettings

Audio settings.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Sound/AudioSettings.h

Include

#include "Sound/AudioSettings.h"

Syntax

class UAudioSettings : public UDeveloperSettings

Remarks

Audio settings.

Variables

Name Description

Public variable

FAudioSettingsC...

 

AudioSettingsChanged

Public variable

uint32: 1

 

bAllowCenterChannel3DPanning

Enables the surround sound spatialization calculations to include the center channel.

Public variable

uint32: 1

 

bAllowPlayWhenSilent

Allows sounds to play at 0 volume.

Public variable

FSoftObjectPath

 

BaseDefaultSubmix

The default submix to use for implicit submix sends (i.e. if the base submix send is null or if a submix parent is null)

Public variable

uint32: 1

 

bDisableMasterEQ

Disables master EQ effect in the audio DSP graph.

Public variable

TArray< FSoundD...

 

DebugSounds

Sounds only packaged in non-shipped builds for debugging.

Public variable

TArray< FDefaul...

 

DefaultAudioBuses

Array of AudioBuses that are automatically initialized when the AudioEngine is initialized

Public variable

FSoftObjectPath

 

DefaultBaseSoundMix

The SoundMix to use as base when no other system has specified a Base SoundMix

Public variable

FSoftObjectPath

 

DefaultMediaSoundClassName

The SoundClass assigned to media player assets

Public variable

UAudioSettings:...

 

DefaultSoundClassName

The SoundClass assigned to newly created sounds

Public variable

FSoftObjectPath

 

DefaultSoundConcurrencyName

The SoundConcurrency assigned to newly created sounds

Public variable

FString

 

DialogueFilenameFormat

The format string to use when generating the filename for contexts within dialogue waves.

Public variable

FSoftObjectPath

 

EQSubmix

The submix through which all sounds set to use legacy EQ system are routed

Public variable

float

 

GlobalMaxPitchScale

The value to use to clamp the max pitch scale

Public variable

float

 

GlobalMinPitchScale

The value to use to clamp the min pitch scale

Public variable

FSoftObjectPath

 

MasterSubmix

The default submix through which all sounds are routed to.

Public variable

int32

 

MaximumConcurrentStreams

How many streaming sounds can be played at the same time (if more are played they will be sorted by priority)

Public variable

EMonoChannelUpm...

 

MonoChannelUpmixMethod

The upmixing method for mono sound sources.

Public variable

uint32

 

NumStoppingSources

The max number of sources to reserve for "stopping" sounds.

Public variable

EPanningMethod

 

PanningMethod

The method to use when doing non-binaural or object-based panning.

Public variable

TArray< FAudioQ...

 

QualityLevels

Public variable

FSoftObjectPath

 

ReverbSubmix

The submix through which all sounds set to use reverb are routed

Public variable

EVoiceSampleRat...

 

VoiPSampleRate

Sample rate used for voice over IP.

Public variable

FSoftObjectPath

 

VoiPSoundClass

Sound class to be used for the VOIP audio component

Constructors

Name Description

Public function

UAudioSettings

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

FString

 

FindQualityNameByIndex

(
    int32 Index
)

Get the quality name level for a given index.

Public function Const

USoundClass ...

 

GetDefaultMediaSoundClass()

Public function Const

USoundClass ...

 

GetDefaultSoundClass()

Public function Const

USoundConcur...

 

GetDefaultSoundConcurrency()

Public function Const

int32

 

GetHighestMaxChannels()

Returns the highest value for MaxChannels among all quality levels

Public function Const

const FAudio...

 

GetQualityLevelSettings

(
    int32 QualityLevel
)

Get the quality level settings at the provided level index.

Public function Const

int32

 

GetQualityLevelSettingsNum()

Get the total number of quality level settings.

Public function Const

const bool

 

IsAudioMixerEnabled()

Returns if the audio mixer is currently enabled.

Public function

void

 

LoadDefaultObjects()

Loads default object instances from soft object path properties.

Public function

FAudioSettin...

 

OnAudioSettingsChanged()

Returns event to be bound to if caller wants to know when audio settings are modified

Public function

void

 

RegisterParameterInterfaces()

Registers Parameter Interfaces defined by the engine module.

Public function

void

 

SetAudioMixerEnabled

(
    const bool bInAudioMixerEnabled
)

Sets whether audio mixer is enabled. Set once an audio mixer platform module is loaded.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeChainProperty

(
    FPropertyChangedChainEvent& Proper...
)

This alternate version of PostEditChange is called when properties inside structs are modified.

Public function Virtual

void

 

PreEditChange

(
    FProperty* PropertyAboutToChan...
)

This is called when a property is about to be modified externally

Classes

Name

Description

Public class

FAudioSettingsChanged

Event to listen for when settings reflected properties are changed.

Deprecated Variables

Name Description

Public variable

float

 

DefaultReverbSendLevel_DEPRECATED

The amount of audio to send to reverb submixes if no reverb send is setup for the source through attenuation settings.