1. Epic GamesDeveloper
  3. UAudioSettings

UAudioSettings

Audio settings.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Sound

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Sound/AudioSettings.h
Include #include "Sound/AudioSettings.h"

Syntax

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

Remarks

Audio settings.

Variables

  Type Name Description
Public variable FAudioSettingsChanged AudioSettingsChanged  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config uint32: 1 bAllowCenterChannel3DPanning Enables the surround sound spatialization calculations to include the center channel.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config uint32: 1 bAllowPlayWhenSilent Allows sounds to play at 0 volume.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta Config 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 UProperty Category, EditAnywhere, AdvancedDisplay Config uint32: 1 bDisableMasterEQ Disables master EQ effect in the audio DSP graph.
Public variable UProperty Category, EditAnywhere Config TArray< FSoundDebugEntry > DebugSounds Sounds only packaged in non-shipped builds for debugging.
Public variable UProperty Category, EditAnywhere Config TArray< FDefaultAudioBusSettings > DefaultAudioBuses Array of AudioBuses that are automatically initialized when the AudioEngine is initialized
Public variable UProperty Category, EditAnywhere Config EDefaultAudioCompressionType DefaultAudioCompressionType Default audio compression type to use for audio assets.
Public variable UProperty Category, EditAnywhere, Meta Config FSoftObjectPath DefaultBaseSoundMix The SoundMix to use as base when no other system has specified a Base SoundMix
Public variable UProperty Category, EditAnywhere, Meta Config FSoftObjectPath DefaultMediaSoundClassName The SoundClass assigned to media player assets
Public variable UProperty Category, EditAnywhere, Meta Config UAudioSettings::FAudioSettingsChanged DefaultSoundClassName The SoundClass assigned to newly created sounds
Public variable UProperty Category, EditAnywhere, Meta Config FSoftObjectPath DefaultSoundConcurrencyName The SoundConcurrency assigned to newly created sounds
Public variable UProperty Category, EditAnywhere Config FString DialogueFilenameFormat The format string to use when generating the filename for contexts within dialogue waves.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta Config FSoftObjectPath EQSubmix The submix through which all sounds set to use legacy EQ system are routed
Public variable UProperty Category, EditAnywhere, Meta Config float GlobalMaxPitchScale The value to use to clamp the max pitch scale
Public variable UProperty Category, EditAnywhere, Meta Config float GlobalMinPitchScale The value to use to clamp the min pitch scale
Public variable UProperty Category, EditAnywhere, Meta Config FSoftObjectPath MasterSubmix The default submix through which all sounds are routed to.
Public variable UProperty Category, EditAnywhere, Meta Config 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 UProperty Category, EditAnywhere, AdvancedDisplay Config EMonoChannelUpmixMethod MonoChannelUpmixMethod The upmixing method for mono sound sources.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config uint32 NumStoppingSources The max number of sources to reserve for "stopping" sounds.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config EPanningMethod PanningMethod The method to use when doing non-binaural or object-based panning.
Public variable UProperty Category, EditAnywhere Config TArray< FAudioQualitySettings > QualityLevels  
Public variable UProperty Category, EditAnywhere, Meta Config FSoftObjectPath ReverbSubmix The submix through which all sounds set to use reverb are routed
Public variable UProperty Category, EditAnywhere, Meta Config EVoiceSampleRate VoiPSampleRate Sample rate used for voice over IP.
Public variable UProperty Category, EditAnywhere, Meta Config FSoftObjectPath VoiPSoundClass Sound class to be used for the VOIP audio component

Constructors

  Type Name Description
Public function  

UAudioSettings ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const FString Get the quality name level for a given index.
Public function Const int32  
Public function Const USoundClass *  
Public function Const USoundClass *  
Public function Const USoundConcurrency *  
Public function Const int32 Returns the highest value for MaxChannels among all quality levels
Public function Const const FAudioQualitySettings &

GetQualityLevelSettings ( int32 QualityLevel
)

 Get the quality level settings at the provided level index.
Public function Const int32 Get the total number of quality level settings.
Public function void Loads default object instances from soft object path properties.
Public function FAudioSettingsChanged & Returns event to be bound to if caller wants to know when audio settings are modified
Public function void Registers Parameter Interfaces defined by the engine module.

Overridden from UObject

  Type Name Description
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

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

Classes

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

Deprecated Variables

  Type Name Description
Public variable UProperty Config int32 DefaultCompressionQuality_DEPRECATED The default compression quality (e.g. for new SoundWaves)
Public variable UProperty Config float DefaultReverbSendLevel_DEPRECATED The amount of audio to send to reverb submixes if no reverb send is setup for the source through attenuation settings.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page