1. Epic GamesDeveloper
  3. UAudioSettings

UAudioSettings

Audio settings.

API > API/Runtime > API/Runtime/Engine

Audio settings.

   
Name UAudioSettings
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Sound/AudioSettings.h
Include Path #include "Sound/AudioSettings.h"

Syntax

UCLASS (Config=Engine, defaultconfig, Meta=(DisplayName="Audio"), MinimalAPI)  
class UAudioSettings : public UDeveloperSettings

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UAudioSettings ( const FObjectInitializer& ObjectInitializer
)

   Sound/AudioSettings.h  

Classes

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

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AudioSettingsChanged FAudioSettingsChanged   Sound/AudioSettings.h  
bAllowCenterChannel3DPanning uint32 Enables the surround sound spatialization calculations to include the center channel. Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Panning"
  • AdvancedDisplay
bAllowPlayWhenSilent uint32 Allows sounds to play at 0 volume. Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Audio"
  • AdvancedDisplay
BaseDefaultSubmix FSoftObjectPath 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) Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Mix"
  • Meta=(AllowedClasses="/Script/Engine.SoundSubmix")
  • AdvancedDisplay
bDisableMasterEQ uint32 Disables master EQ effect in the audio DSP graph. Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Mix"
  • AdvancedDisplay
bEnableLegacyAssetTypes bool Whether or not project supports the creation of legacy audio asset types. Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Audio"
  • AdvancedDisplay
DebugSounds TArray< FSoundDebugEntry > Sounds only packaged in non-shipped builds for debugging. Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Debug"
DefaultAudioBuses TArray< FDefaultAudioBusSettings > Array of AudioBuses that are automatically initialized when the AudioEngine is initialized Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Mix"
DefaultAudioCompressionType EDefaultAudioCompressionType Default audio compression type to use for audio assets. Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Audio"
DefaultBaseSoundMix FSoftObjectPath The SoundMix to use as base when no other system has specified a Base SoundMix Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Audio"
  • Meta=(AllowedClasses="/Script/Engine.SoundMix")
DefaultMediaSoundClassName FSoftObjectPath The SoundClass assigned to media player assets Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Audio"
  • Meta=(AllowedClasses="/Script/Engine.SoundClass", DisplayName="Default Media Sound Class")
DefaultOcclusionCheckInterval FPerPlatformFloat The default interval at which to re-test occlusion (in seconds). Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category=Occlusion
DefaultSoundClassName UAudioSettings::FAudioSettingsChanged The SoundClass assigned to newly created sounds Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Audio"
  • Meta=(AllowedClasses="/Script/Engine.SoundClass", DisplayName="Default Sound Class")
DefaultSoundConcurrencyName FSoftObjectPath The SoundConcurrency assigned to newly created sounds Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Audio"
  • Meta=(AllowedClasses="/Script/Engine.SoundConcurrency", DisplayName="Default Sound Concurrency")
DialogueFilenameFormat FString The format string to use when generating the filename for contexts within dialogue waves. Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Dialogue"
EQSubmix FSoftObjectPath The submix through which all sounds set to use legacy EQ system are routed Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Mix"
  • Meta=(AllowedClasses="/Script/Engine.SoundSubmix", DisplayName="EQ Submix (Legacy)")
  • AdvancedDisplay
GlobalMaxPitchScale float The value to use to clamp the max pitch scale Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Audio"
  • Meta=(ClampMin=0.001, UIMin=0.001, UIMax=4.0)
GlobalMinPitchScale float The value to use to clamp the min pitch scale Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Audio"
  • Meta=(ClampMin=0.001, UIMin=0.001, UIMax=4.0)
MasterSubmix FSoftObjectPath The default submix through which all sounds are routed to. Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Mix"
  • Meta=(AllowedClasses="/Script/Engine.SoundSubmix")
MaximumConcurrentStreams int32 How many streaming sounds can be played at the same time (if more are played they will be sorted by priority) Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Audio"
  • Meta=(ClampMin=0)
MonoChannelUpmixMethod EMonoChannelUpmixMethod The upmixing method for mono sound sources. Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Mix"
  • AdvancedDisplay
NumStoppingSources uint32 The max number of sources to reserve for "stopping" sounds. Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Audio"
  • AdvancedDisplay
PanningMethod EPanningMethod The method to use when doing non-binaural or object-based panning. Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Panning"
  • AdvancedDisplay
QualityLevels TArray< FAudioQualitySettings >   Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Quality"
ReverbSubmix FSoftObjectPath The submix through which all sounds set to use reverb are routed Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Mix"
  • Meta=(AllowedClasses="/Script/Engine.SoundSubmix")
VoiPSampleRate EVoiceSampleRate Sample rate used for voice over IP. Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Audio"
  • Meta=(DisplayName="VOIP Sample Rate")
VoiPSoundClass FSoftObjectPath Sound class to be used for the VOIP audio component Sound/AudioSettings.h
  • Config
  • EditAnywhere
  • Category="Audio"
  • Meta=(AllowedClasses="/Script/Engine.SoundClass", DisplayName="VOIP Sound Class")

Protected

Name Type Remarks Include Path Unreal Specifiers
bParameterInterfacesRegistered bool   Sound/AudioSettings.h  
CachedAmbisonicSubmix FSoftObjectPath   Sound/AudioSettings.h  
CachedMasterSubmix FSoftObjectPath   Sound/AudioSettings.h  
CachedQualityLevels TArray< FAudioQualitySettings >   Sound/AudioSettings.h  
CachedSoundClass FSoftObjectPath   Sound/AudioSettings.h  
DefaultMediaSoundClass TObjectPtr< USoundClass >   Sound/AudioSettings.h
  • Transient
DefaultSoundClass TObjectPtr< USoundClass >   Sound/AudioSettings.h
  • Transient
DefaultSoundConcurrency TObjectPtr< USoundConcurrency >   Sound/AudioSettings.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

FString FindQualityNameByIndex ( int32 Index
) const

 Get the quality name level for a given index. Sound/AudioSettings.h  

int32 GetDefaultCompressionQuality()

   Sound/AudioSettings.h  

USoundClass * GetDefaultMediaSoundClass()

   Sound/AudioSettings.h  

USoundClass * GetDefaultSoundClass()

   Sound/AudioSettings.h  

USoundConcurrency * GetDefaultSoundConcurrency()

   Sound/AudioSettings.h  

int32 GetHighestMaxChannels()

 Returns the highest value for MaxChannels among all quality levels Sound/AudioSettings.h  

const FAudioQualitySettings & GetQualityLevelSettings ( int32 QualityLevel
) const

 Get the quality level settings at the provided level index. Sound/AudioSettings.h  

int32 GetQualityLevelSettingsNum()

 Get the total number of quality level settings. Sound/AudioSettings.h  

void LoadDefaultObjects()

 Loads default object instances from soft object path properties. Sound/AudioSettings.h  

FAudioSettingsChanged & OnAudioSettingsChanged()

 Returns event to be bound to if caller wants to know when audio settings are modified Sound/AudioSettings.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   Sound/AudioSettings.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   Sound/AudioSettings.h  
Registers Parameter Interfaces defined by the engine module. Sound/AudioSettings.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
DefaultCompressionQuality_DEPRECATED int32 The default compression quality (e.g. for new SoundWaves) Sound/AudioSettings.h
  • Config
DefaultReverbSendLevel_DEPRECATED float The amount of audio to send to reverb submixes if no reverb send is setup for the source through attenuation settings. Sound/AudioSettings.h
  • Config

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page