Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Sound > UAudioSettings

Light Theme

Dark Theme

UAudioSettings

Audio settings.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDeveloperSettings

UAudioSettings

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
FAudioSettingsC...	AudioSettingsChanged
uint32: 1	bAllowCenterChannel3DPanning	Enables the surround sound spatialization calculations to include the center channel.
uint32: 1	bAllowPlayWhenSilent	Allows sounds to play at 0 volume.
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)
uint32: 1	bDisableMasterEQ	Disables master EQ effect in the audio DSP graph.
TArray< FSoundD...	DebugSounds	Sounds only packaged in non-shipped builds for debugging.
TArray< FDefaul...	DefaultAudioBuses	Array of AudioBuses that are automatically initialized when the AudioEngine is initialized
FSoftObjectPath	DefaultBaseSoundMix	The SoundMix to use as base when no other system has specified a Base SoundMix
FSoftObjectPath	DefaultMediaSoundClassName	The SoundClass assigned to media player assets
UAudioSettings:...	DefaultSoundClassName	The SoundClass assigned to newly created sounds
FSoftObjectPath	DefaultSoundConcurrencyName	The SoundConcurrency assigned to newly created sounds
FString	DialogueFilenameFormat	The format string to use when generating the filename for contexts within dialogue waves.
FSoftObjectPath	EQSubmix	The submix through which all sounds set to use legacy EQ system are routed
float	GlobalMaxPitchScale	The value to use to clamp the max pitch scale
float	GlobalMinPitchScale	The value to use to clamp the min pitch scale
FSoftObjectPath	MasterSubmix	The default submix through which all sounds are routed to.
int32	MaximumConcurrentStreams	How many streaming sounds can be played at the same time (if more are played they will be sorted by priority)
EMonoChannelUpm...	MonoChannelUpmixMethod	The upmixing method for mono sound sources.
uint32	NumStoppingSources	The max number of sources to reserve for "stopping" sounds.
EPanningMethod	PanningMethod	The method to use when doing non-binaural or object-based panning.
TArray< FAudioQ...	QualityLevels
FSoftObjectPath	ReverbSubmix	The submix through which all sounds set to use reverb are routed
EVoiceSampleRat...	VoiPSampleRate	Sample rate used for voice over IP.
FSoftObjectPath	VoiPSoundClass	Sound class to be used for the VOIP audio component

Constructors

	Name	Description
	UAudioSettings ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
FString	FindQualityNameByIndex ( int32 Index )	Get the quality name level for a given index.
int32	GetHighestMaxChannels()	Returns the highest value for MaxChannels among all quality levels
const FAudio...	GetQualityLevelSettings ( int32 QualityLevel )	Get the quality level settings at the provided level index.
int32	GetQualityLevelSettingsNum()	Get the total number of quality level settings.
const bool	IsAudioMixerEnabled()	Returns if the audio mixer is currently enabled.
FAudioSettin...	OnAudioSettingsChanged()	Returns event to be bound to if caller wants to know when audio settings are modified
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
	void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.
	void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally

Classes

	Name	Description
	FAudioSettingsChanged	Event to listen for when settings reflected properties are changed.

Deprecated Variables

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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss