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 > FAudioDevice

Light Theme

Dark Theme

FAudioDevice

Inheritance Hierarchy

FExec

FAudioDevice

FMixerDevice

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/AudioDevice.h
Include	#include "AudioDevice.h"

Syntax

class FAudioDevice : public FExec

Variables

	Name	Description
double	AudioClock	The audio clock from the audio hardware. Not supported on all platforms.
uint8: 1	bAllowCenterChannel3DPanning	Whether or not we allow center channel panning (audio mixer only feature.)
uint8: 1	bAudioMixerModuleLoaded	Whether or not the audio mixer module is being used by this device.
uint8: 1	bDisableAudioCaching	HACK: Temporarily disable audio caching.
uint8: 1	bIsAudioDeviceHardwareInitialized	Whether or not the lower-level audio device hardware initialized.
uint8: 1	bIsBakedAnalysisEnabled	If baked analysis querying is enabled.
uint8: 1	bIsStoppingVoicesEnabled
uint8: 1	bOcclusionIsExternalSend	Whether or not various audio plugin interfaces are external sends.
uint8: 1	bReverbIsExternalSend
FAudioSpatializ...	CurrentSpatializationInterfaceInfoPtr
FName	CurrentSpatializationPluginInterfaceName	3rd party audio spatialization interface.
FDelegateHandle	DeviceCreatedHandle	Handle for our device created delegate.
float	DeviceDeltaTime
FDelegateHandle	DeviceDestroyedHandle	Handle for our device destroyed delegate.
Audio::FDeviceI...	DeviceID	The handle for this audio device used in the audio device manager.
FAudioEffectsMa...	Effects	Interface to audio effects processing
TArray< FSoundS...	FreeSources
TArray< FListen...	ListenerProxies	Game thread cache of listener transforms.
TArray< FListen...	Listeners	Audio thread representation of listeners.
TAudioModulatio...	ModulationInterface	3rd party modulation interface
int32	NumPrecacheFrames	The number of frames to precache.
int32	NumStoppingSources	The number of sources to reserve for stopping sounds.
TAudioOcclusion...	OcclusionInterface	3rd party occlusion interface.
FOnAudioDeviceP...	OnAudioDevicePostRender	Callback as audio device has just finished rendering a buffer.
FOnAudioDeviceP...	OnAudioDevicePreRender	Callback as audio device is about to render a buffer.
FAudioPlatformS...	PlatformSettings	The platform specific audio settings.
FAudioPluginIni...	PluginInitializationParams	Cached parameters passed to the initialization of various audio plugins
TArray< TAudioP...	PluginListeners	3rd party listener observers registered to this audio device.
FCriticalSectio...	RenderStateCallbackListCritSec
TAudioReverbPtr	ReverbPluginInterface	3rd party reverb interface.
int32	SampleRate	The sample rate of all the audio devices
TAudioSourceDat...	SourceDataOverridePluginInterface	3rd party source data override interface.
TArray< FSoundS...	Sources
TArray< FAudioS...	SpatializationInterfaces

Constructors

	Name	Description
	FAudioDevice()	Constructor

Destructors

	Name	Description
	~FAudioDevice()

Functions

	Name	Description
void	ActivateReverbEffect ( UReverbEffect* ReverbEffect, FName TagName, float Priority, float Volume, float FadeTime )	Activates a Reverb Effect without the need for a volume
void	AddAudioVolumeProxy ( const FAudioVolumeProxy& Proxy )
void	AddEnvelopeFollowerDelegate ( USoundSubmix* InSubmix, const FOnSubmixEnvelopeBP& OnSubmi... )	Adds an envelope follower delegate to the submix for this audio device.
void	AddNewActiveSound ( const FActiveSound& ActiveSound, TArray< FAudioParameter >&& InDefa... )	Adds an active sound to the audio device
void	AddNewActiveSound ( const FActiveSound& ActiveSound, const TArray< FAudioParameter >... )	Adds an active sound to the audio device
Audio::FPatc...	AddPatchForSubmix ( uint32 InObjectId, float InPatchGain )
Audio::FPatc...	AddPatchInputForAudioBus ( uint32 InAudioBusId, int32 InFrames, int32 InChannels, float InGain )
Audio::FPatc...	AddPatchOutputForAudioBus ( uint32 InAudioBusId, int32 InFrames, int32 InChannels, float InGain )
FDelegateHan...	AddPostRenderDelegate ( const FOnAudioDevicePostRender::FDe... )
FDelegateHan...	AddPreRenderDelegate ( const FOnAudioDevicePreRender::FDel... )
void	AddReferencedObjects ( FReferenceCollector& Collector )	Track references to UObjects
void	AddSoundToStop ( FActiveSound* SoundToStop )	Marks a sound to be stopped. Returns true if added to stop, false if already pending stop.
void	AddSpectralAnalysisDelegate ( USoundSubmix* InSubmix, const FSoundSpectrumAnalyzerDelegat..., const FOnSubmixSpectralAnalysisBP&... )
void	AddVirtualLoop ( const FAudioVirtualLoop& InVirtual... )
void	ApplyInteriorSettings ( FActiveSound& ActiveSound, FSoundParseParameters& ParseParams )	Applies interior settings from affecting volumes to the active sound (called on audio thread)
bool	AreStartupSoundsPreCached()
bool	CanHaveMultipleActiveSounds ( uint64 AudioComponentID )	Whether a given Audio Component ID should be allowed to have multiple associated Active Sounds
bool	CanUseVRAudioDevice()	Query if the editor is in VR Preview for the current play world.
float	ClampPitch ( float InPitchScale )
void	ClearListenerAttenuationOverride ( int32 ListenerIndex )	Removes a listener attenuation override for the specified listener.
void	ClearSoundMixClassOverride ( USoundMix* InSoundMix, USoundClass* InSoundClass, float FadeOutTime )	Clears a sound class override in the given sound mix.
void	ClearSoundMixModifier ( USoundMix* SoundMix )	Clear the effect of one SoundMix completely.
void	ClearSoundMixModifiers()	Clear the effect of all SoundMix modifiers.
void	ClearSubmixEffectChainOverride ( USoundSubmix* InSoundSubmix, float InCrossfadeTime )	Clears all submix effect chain overrides from the submix.
void	CountBytes ( FArchive& Ar )	Counts the bytes for the structures used in this class
UAudioCompon...	CreateComponent ( USoundBase* Sound, const FCreateComponentParams& Para... )	Creates an audio component to handle playing a sound.
FAudioEffect...	CreateEffectsManager()	Creates a new platform specific sound source
FSoundSource...	CreateSoundSource()	Creates a new platform specific sound source
void	DeactivateReverbEffect ( FName TagName )	Deactivates a Reverb Effect not applied by a volume
void	Deinitialize()	De-initialization step that occurs after device destroyed broadcast, but before removal from the device manager
void	DestroyEffect ( FSoundSource* Source )	Platform dependent call to destroy any effect related data
bool	DisablePCMAudioCaching()	Whether or not the platform disables caching of decompressed PCM data (i.e. to save memory on fixed memory platforms
void	EnableDebugAudioOutput()	Enables the audio device to output debug audio to test audio device output.
void	EnableRadioEffect ( bool bEnable )	Enables or Disables the radio effect.
void	FadeIn()
void	FadeOut()	Optional fadeout and fade in of audio to avoid clicks when closing or opening/reusing audio device.
int32	FindClosestListenerIndex ( const FTransform& SoundTransform )	Returns the index of the listener closest to the given sound transform
int32	FindClosestListenerIndex ( const FVector& Position, float& OutSqDistance, bool AllowAttenuationOverrides )	Returns the index of the listener closest to the given sound transform
int32	FindClosestListenerIndex ( const FTransform& SoundTransform, const TArray< FListener >& InListe... )	Returns the index of the listener closest to the given sound transform
void	Flush ( UWorld* WorldToFlush, bool bClearActivatedReverb )	Stop all the audio components and sources attached to the world.
void	FlushAudioRenderingCommands ( bool bPumpSynchronously )	Allows audio rendering command queue to flush during audio device flush.
void	FlushExtended ( UWorld* WorldToFlush, bool bClearActivatedReverb )	Derived classes can override this method to do their own cleanup.
void	GatherInteriorData ( FActiveSound& ActiveSound, FSoundParseParameters& ParseParams )	Gathers data about interior volumes affecting the active sound (called on audio thread)
const TMap< ...	GetActiveReverb()
const TArray...	GetActiveSounds()
const TArray...	GetActiveWaveInstances()
double	GetAudioClock()	Returns the audio clock of the audio device. Not supported on all platforms.
void	GetAudioDeviceList ( TArray< FString >& OutAudioDeviceN... )	Returns an array of available audio devices names for the platform
FAudioDevice...	GetAudioDeviceManager()	Returns the audio device manager
FName	GetAudioStateProperty ( const FName& PropertyName )
double	GetAudioTime()	Return the audio stream time
void	GetAudioVolumeSettings ( const uint32 WorldID, const FVector& Location, FAudioVolumeSettings& OutSettings )
TArray< FNam...	GetAvailableSpatializationPluginNames()	Get the current list of available spatialization plugins
void	GetAzimuth ( const FAttenuationListenerData& Ou..., float& OutAzimuth, float& AbsoluteAzimuth )	Returns the azimuth angle of the sound relative to the sound's nearest listener.
int32	GetBufferLength()	Returns the buffer length of the audio device.
float	GetCompressionDurationThreshold ( const FSoundGroup& SoundGroup )
UReverbEffec...	GetCurrentReverbEffect()	Returns the currently applied reverb effect if there is one.
bool	GetCurrentSourceEffectChain ( const uint32 SourceEffectChainId, TArray< FSourceEffectChainEntry >&... )	Returns the current source effect chain entries set dynamically from BP or elsewhere.
FAudioSpatia...	GetCurrentSpatializationPluginInterfaceInfo()
bool	GetDefaultAudioSettings ( uint32 WorldID, FReverbSettings& OutReverbSettings, FInteriorSettings& OutInteriorSett... )	Gets the default reverb and interior settings for the provided world.
USoundMix &#...	GetDefaultBaseSoundMixModifier()
float	GetDefaultReverbSendLevel()	Returns the default reverb send level used for sources which have reverb applied but no attenuation settings.
float	GetDeviceDeltaTime()	Returns the current audio device update delta time.
bool	GetDistanceSquaredToListener ( const FVector& Location, int32 ListenerIndex, float& OutSqDistance )	Sets OutSqDistance to the distance from location to the appropriate listener representation, depending on calling thread.
bool	GetDistanceSquaredToNearestListener ( const FVector& Location, float& OutSqDistance )	Sets OutSqDistance to the distance from location the closest listener, depending on calling thread.
float	GetDistanceToNearestListener ( const FVector& Location )	Returns the distance to the nearest listener from the given location
const FAudio...	GetEffects()	Return the pointer to the sound effects handler
FAudioEffect...	GetEffects()	Return the pointer to the sound effects handler
float	GetFocusFactor ( const float Azimuth, const FSoundAttenuationSettings& A... )	Returns the focus factor of a sound based on its position and listener data.
float	GetGameDeltaTime()	Returns the game's delta time
const FGloba...	GetGlobalFocusSettings()
TRange< floa...	GetGlobalPitchRange()	Returns global pitch range
const FDynam...	GetGlobalPitchScale()
const FVecto...	GetListenerAttenuationOverride ( int32 ListenerIndex )	Returns the listener attenuation override for the specified listener
bool	GetListenerPosition ( int32 ListenerIndex, FVector& OutPosition, bool bAllowOverride )	Returns a position from the appropriate listener representation, depending on calling thread.
const TArray...	GetListeners()
bool	GetListenerTransform ( int32 ListenerIndex, FTransform& OutTransform )	Returns the transform of the appropriate listener representation, depending on calling thread
FVector	GetListenerTransformedDirection ( const FVector& Position, float* OutDistance )	Gets the direction of the given position vector transformed relative to listener.
bool	GetListenerWorldID ( int32 ListenerIndex, uint32& OutWorldID )	Returns the WorldID of the appropriate listener representation, depending on calling thread
float	GetLowPassFilterResonance()	Low pass filter OneOverQ value
void	GetMagnitudesForFrequencies ( USoundSubmix* InSubmix, const TArray< float >& InFrequenci..., TArray< float >& OutMagnitudes )
FAudioDevice...	GetMainAudioDevice()	Returns the main audio device of the engine
int32	GetMaxChannels()	Returns the max channels used by the audio device.
void	GetMaxDistanceAndFocusFactor ( USoundBase* Sound, const UWorld* World, const FVector& Location, const FSoundAttenuationSettings..., float& OutMaxDistance, float& OutFocusFactor )	Gets the max distance and focus factor of a sound.
int32	GetMaxSources()	Returns the maximum sources used by the audio device set on initialization, including the number of stopping voices reserved.
float	GetMaxWorldDistance()	Returns the global maximum distance used in the audio engine.
EDebugState	GetMixDebugState()	Gets the current audio debug state
int32	GetNumActiveSources()	Returns the number of active sound sources
int32	GetNumBuffers()	Returns the number of buffers the audio device keeps queued.
int32	GetNumFreeSources()	Returns the number of free sources.
void	GetPhasesForFrequencies ( USoundSubmix* InSubmix, const TArray< float >& InFrequenci..., TArray< float >& OutPhases )
float	GetPlatformAudioHeadroom()
const TArray...	GetPrevPassiveSoundMixModifiers()
float	GetPrimaryVolume()	Returns the volume that combines transient master volume and the FApp::GetVolumeMultiplier() value
const FAudio...	GetQualityLevelSettings()	Returns the quality settings used by the default audio settings.
float	GetSampleRate()	Returns the sample rate used by the audio device.
int32	GetSortedActiveWaveInstances ( TArray< FWaveInstance* >& Wav..., const ESortedActiveWaveGetType::Typ... )	Iterate over the active AudioComponents for wave instances that could be playing.
FSoundClassP...	GetSoundClassCurrentProperties ( USoundClass* InSoundClass )	Gets the current properties of a sound class, if the sound class hasn't been registered, then it returns nullptr
FSoundClassD...	GetSoundClassDynamicProperties ( USoundClass* InSoundClass )	Returns the parameters which are dynamic from the given sound class.
const TMap< ...	GetSoundMixModifiers()
FSoundSource...	GetSoundSource ( FWaveInstance* WaveInstance )
TAudioSpatia...	GetSpatializationPluginInterface()	Return the spatialization plugin interface.
TSubsystemCl...	GetSubsystem ( const FAudioDeviceHandle& InHandle )	Get a Subsystem of specified type from the provided AudioDeviceHandle returns nullptr if the Subsystem cannot be found or the AudioDeviceHandle is invalid
TSubsystemCl...	GetSubsystem()	Get a Subsystem of specified type
const TArray...	GetSubsystemArray()	Gets all Subsystems of specified type, this is only necessary for interfaces that can have multiple implementations instanced at a time.
UAudioEngine...	GetSubsystemBase ( TSubclassOf< UAudioEngineSubsystem ... )	Get a Subsystem of specified type
UAudioCompon...	GetTestComponent ( UWorld* InWorld )
float	GetTransientPrimaryVolume()
const TMap< ...	GetWaveInstanceSourceMap()
void	HandlePause ( bool bGameTicking, bool bGlobalPause )	Handle pausing/unpausing of sources when entering or leaving pause mode, or global pause (like device suspend)
bool	HasCompressedAudioInfoClass ( USoundWave* SoundWave )	Whether this SoundWave has an associated info class to decompress it
bool	Init ( Audio::FDeviceId InDeviceID, int32 InMaxSources, int32 BufferSizeOverride, int32 NumBuffersOverride )	Basic initialization of the platform agnostic layer of the audio system
void	InitDefaultAudioBuses()	Initialized audio buses marked as default that are to be enabled for the duration of the application.
void *	InitEffect ( FSoundSource* Source )	Platform dependent call to init effect data on a sound source
bool	InitializeHardware()	Starts up any platform specific hardware/APIs
void	InitializeSubsystemCollection()	Create our subsystem collection root object and initialize subsystems
void	InitSoundClasses()	Set up the sound class hierarchy
void	InitSoundEffectPresets()
void	InitSoundSources()	Set up the initial sound sources Allows us to initialize sound source early on, allowing for render callback hookups for iOS Audio.
void	InitSoundSubmixes()	Initializes sound submixes.
void	InvalidateCachedInteriorVolumes()	When the set of Audio volumes have changed invalidate the cached values of active sounds
bool	IsAudioBusActive ( uint32 InAudioBusId )
bool	IsAudioDeviceMuted()
bool	IsBakedAnalaysisQueryingEnabled()	Returns if baked analysis querying is enabled.
bool	IsExernalBackgroundSoundActive()	Check if any background music or sound is playing through the audio device
bool	IsHRTFDisabled()	Whether or not HRTF is disabled.
bool	IsHRTFEnabledForAll()	Whether or not HRTF spatialization is enabled for all.
bool	IsInitialized()	Whether the device was initialized.
bool	IsMainAudioDevice()
bool	IsModulationPluginEnabled()	Whether or not there's a modulation plugin enabled.
bool	IsNonRealtime()
bool	IsOcclusionPluginEnabled()	Whether or not there's an occlusion plugin enabled.
bool	IsOcclusionPluginLoaded()
bool	IsPendingStop ( FActiveSound* ActiveSound )	Whether the provided ActiveSound is currently pending to stop
bool	IsReverbPluginEnabled()	Whether or not there's a reverb plugin enabled.
bool	IsReverbPluginLoaded()
bool	IsSourceDataOverridePluginEnabled()
bool	IsSourceDataOverridePluginLoaded()
bool	IsSpatializationPluginEnabled()	Whether or not there's a spatialization plugin enabled.
bool	IsStoppingVoicesEnabled()	Returns if stopping voices is enabled.
bool	IsUsingListenerAttenuationOverride ( int32 ListenerIndex )	Returns if the specific listener is using an attenuation override position.
bool	LegacyReverbDisabled()
bool	LocationIsAudible ( const FVector& Location, int32 ListenerIndex, const float MaxDistance )	Checks to see if a coordinate is within a distance of a specific listener
bool	LocationIsAudible ( const FVector& Location, const float MaxDistance )	Checks to see if a coordinate is within a distance of any listener
void	NotifyActiveSoundOcclusionTraceDone ( FActiveSound* ActiveSound, bool bIsOccluded )	Notify that a pending async occlusion trace finished on the active sound.
void	NotifyAddActiveSound ( FActiveSound& ActiveSound )	Notifies subsystems an active sound has been added (called on audio thread)
void	NotifyAudioDevicePostRender ( const FAudioDeviceRenderInfo& InIn... )
void	NotifyAudioDevicePreRender ( const FAudioDeviceRenderInfo& InIn... )
void	NotifyPendingDeleteInternal ( FActiveSound& ActiveSound )	Notifies subsystems an active sound is about to be deleted (called on audio thread)
void	OnBeginPIE ( const bool bIsSimulating )	Deals with anything audio related that should happen when PIE starts
void	OnDeviceCreated ( Audio::FDeviceId InDeviceID )	Called after FAudioDevice creation and init
void	OnDeviceDestroyed ( Audio::FDeviceId InDeviceID )	Called before FAudioDevice teardown
void	OnEndPIE ( const bool bIsSimulating )	Deals with anything audio related that should happen when PIE ends
void	OnListenerUpdated ( const TArray< FListener >& InListe... )	This is overridden in Audio::FMixerDevice to propogate listener information to the audio thread.
void	OnPreGarbageCollect()
void	PauseActiveSound ( uint64 AudioComponentID, const bool bInIsPaused )	Pauses the active sound for the specified audio component
void	PlaySoundAtLocation ( USoundBase* Sound, UWorld* World, float VolumeMultiplier, float PitchMultiplier, float StartTime, const FVector& Location, const FRotator& Rotation, USoundAttenuation* Attenuation..., USoundConcurrency* Concurrency..., const TArray< FAudioParameter >..., const AActor* OwningActor )	Plays a sound at the given location without creating an audio component.
bool	PlayWhenSilentEnabled()	Whether play when silent is enabled for all sounds associated with this audio device
void	PopSoundMixModifier ( USoundMix* SoundMix, bool bIsPassive )	Pop a SoundMix from the Audio Device's list.
void	Precache ( USoundWave* SoundWave, bool bSynchronous, bool bTrackMemory, bool bForceFullDecompression )	Precaches the passed in sound node wave object. Precaches the passed in sound node wave object.
void	PrecacheStartupSounds()	Precaches all existing sounds. Called when audio setup is complete
void	PushSoundMixModifier ( USoundMix* SoundMix, bool bIsPassive, bool bIsRetrigger )	Push a SoundMix onto the Audio Device's list.
void	RegisterPluginListener ( const TAudioPluginListenerPtr Plugi... )	Registers a third party listener-observer to this audio device.
void	RegisterSoundClass ( USoundClass* InSoundClass )	Registers a sound class with the audio device
void	RegisterSoundSubmix ( USoundSubmixBase* SoundSubmix, bool bInit )	Registers the sound submix
void	RegisterSubmixBufferListener ( ISubmixBufferListener* InSubmi..., USoundSubmix* SoundSubmix )	Registers the submix buffer listener with the given submix.
void	RemoveActiveSound ( FActiveSound* ActiveSound )	Removes an active sound from the active sounds array
void	RemoveAudioVolumeProxy ( uint32 AudioVolumeID )
bool	RemovePostRenderDelegate ( const FDelegateHandle& InHandle )
bool	RemovePreRenderDelegate ( const FDelegateHandle& InHandle )
void	RemoveSoundMix ( USoundMix* SoundMix )	Removes a sound mix - called when SoundMix is unloaded
void	RemoveSpectralAnalysisDelegate ( USoundSubmix* InSubmix, const FOnSubmixSpectralAnalysisBP&... )
void	ResetAudioVolumeProxyChangedState()
void	ResetInterpolation()	Resets all interpolating values to defaults.
void	ResumeContext()	Resume any context related objects
void	RetriggerVirtualLoop ( FAudioVirtualLoop& VirtualLoop )	Attempts to retrigger a provided loop
void	SendCommandToActiveSounds ( uint64 InAudioComponentID, TUniqueFunction< void(FActiveSound ..., const TStatId InStatId )	Performs an operation on all active sounds requested to execute by an audio component
void	SetAudioStateProperty ( const FName& PropertyName, const FName& PropertyValue )
void	SetBaseSoundMix ( USoundMix* SoundMix )	Sets a new sound mix and applies it to all appropriate sound classes
void	SetCanHaveMultipleActiveSounds ( uint64 AudioComponentID, bool InCanHaveMultipleActiveSounds )	Set whether a given Audio Component ID should be allowed to have multiple associated Active Sounds
bool	SetCurrentSpatializationPlugin ( FName PluginName )	Set and initialize the current Spatialization plugin (by name)
void	SetDefaultAudioSettings ( UWorld* World, const FReverbSettings& DefaultReve..., const FInteriorSettings& DefaultIn... )	Sets the default reverb and interior settings for the provided world
void	SetDefaultBaseSoundMix ( USoundMix* SoundMix )	Sets the Sound Mix that should be active by default
void	SetDeviceMuted ( bool bMuted )
void	SetGlobalFocusSettings ( const FGlobalFocusSettings& NewFoc... )
void	SetGlobalPitchModulation ( float PitchScale, float TimeSec )
void	SetHRTFDisabled ( bool InIsHRTFDisabled )
void	SetHRTFEnabledForAll ( bool InbHRTFEnabledForAll )
void	SetListener ( UWorld* World, int32 InListenerIndex, const FTransform& ListenerTransfor..., float InDeltaSeconds )	Sets the details about the listener
void	SetListenerAttenuationOverride ( int32 ListenerIndex, const FVector AttenuationPosition )	Sets an override position for the specified listener to do attenuation calculations.
void	SetMaxChannels ( int32 InMaxChannels )	Sets the maximum number of channels dynamically.
void	SetMaxChannelsScaled ( float InScaledChannelCount )	Sets the maximum number of channels dynamically by scaled percentage.
void	SetMixDebugState ( EDebugState DebugState )
void	SetPlatformAudioHeadroom ( float PlatformHeadRoom )
void	SetSoundClassDistanceScale ( USoundClass* InSoundClass, float DistanceScale, float TimeSec )	Overrides the attenuation scale used on a sound class.
void	SetSoundMixClassOverride ( USoundMix* InSoundMix, USoundClass* InSoundClass, float Volume, float Pitch, float FadeInTime, bool bApplyToChildren )	Sets a sound class override in the given sound mix.
void	SetSoundMixModifiers ( const TMap< USoundMix, FSound..., const TArray< USoundMix >& I..., USoundMix* InDefaultBaseSoundM... )
void	SetSpatializationInterfaceEnabled ( bool InbSpatializationInterfaceEnab... )
void	SetSubmixAutoDisable ( USoundSubmix* InSoundSubmix, bool bInAutoDisable )	Set whether or not a submix is auto-disabled.
void	SetSubmixAutoDisableTime ( USoundSubmix* InSoundSubmix, float InDisableTime )	Set what the auto-disable time is.
void	SetSubmixDryLevel ( USoundSubmix* InSoundSubmix, float InDryLevel )	Set the wet-dry level of the given submix
void	SetSubmixEffectChainOverride ( USoundSubmix* InSoundSubmix, const TArray< FSoundEffectSubmixPtr..., float InCrossfadeTime )	Sets a submix effect chain override for the given submix
void	SetSubmixModulationBaseLevels ( USoundSubmix* InSoundSubmix, float InVolumeModBase, float InWetModBase, float InDryModBase )
void	SetSubmixOutputVolume ( USoundSubmix* InSoundSubmix, float InOutputVolume )	Set the wet-dry level of the given submix
void	SetSubmixWetDryLevel ( USoundSubmix* InSoundSubmix, float InOutputVolume, float InWetLevel, float InDryLevel )	Set the wet-dry level of the given submix
void	SetSubmixWetLevel ( USoundSubmix* InSoundSubmix, float InWetLevel )	Set the wet-dry level of the given submix
void	SetTransientPrimaryVolume ( float TransientPrimaryVolume )
void	SetUseAttenuationForNonGameWorlds ( bool bInUseAttenuationForNonGameWor... )	Set whether or not we force the use of attenuation for non-game worlds (as by default we only care about game worlds)
bool	ShouldUseRealtimeDecompression ( bool bForceFullDecompression, const FSoundGroup& SoundGroup, USoundWave* SoundWave, float CompressedDurationThreshold )	Returns true if a sound wave should be decompressed.
void	ShutdownDefaultAudioBuses()	Shutdown all audio buses marked as default.
bool	SoundIsAudible ( USoundBase* Sound, const UWorld* World, const FVector& Location, const FSoundAttenuationSettings..., float MaxDistance, float FocusFactor )	Checks if the given sound would be audible.
bool	SpatializationPluginInterfacesAvailable()
void	StartAudioBus ( uint32 InAudioBusId, int32 InNumChannels, bool bInIsAutomatic )
void	StartEnvelopeFollowing ( USoundSubmix* InSubmix )	This is called by a USoundSubmix to start envelope following on a submix isntance on this device.
void	StartRecording ( USoundSubmix* InSubmix, float ExpectedRecordingDuration )	This is called by a USoundSubmix to start recording a submix instance on this device.
void	StartSources ( TArray< FWaveInstance* >& Wav..., int32 FirstActiveIndex, bool bGameTicking )	Start and/or update any sources that have a high enough priority to play
void	StartSpectrumAnalysis ( USoundSubmix* InSubmix, const FSoundSpectrumAnalyzerSetting... )
void	StopActiveSound ( FActiveSound* ActiveSound )	(Deprecated in favor of AddSoundToStop). Stops the active sound
void	StopActiveSound ( uint64 AudioComponentID )	Removes the active sound for the specified audio component
void	StopAllSounds ( bool bShouldStopUISounds )	Stops all game sounds (and possibly UI) sounds
void	StopAudioBus ( uint32 InAudioBusId )
void	StopEnvelopeFollowing ( USoundSubmix* InSubmix )	This is called by a USoundSubmix when we stop envelope following a submix instance on this device.
Audio::FAlig...	StopRecording ( USoundSubmix* InSubmix, float& OutNumChannels, float& OutSampleRate )	This is called by a USoundSubmix when we stop recording a submix on this device.
void	StopSoundsUsingResource ( USoundWave* SoundWave, TArray< UAudioComponent* >... )	Stop any playing sounds that are using a particular SoundWave
void	StopSources ( TArray< FWaveInstance* >& Wav..., int32 FirstActiveIndex )	Stop sources that need to be stopped, and touch the ones that need to be kept alive Stop sounds that are too low in priority to be played
void	StopSourcesUsingBuffer ( FSoundBuffer* SoundBuffer )	Stops any sound sources which are using the given buffer.
void	StopSpectrumAnalysis ( USoundSubmix* InSubmix )
void	StopTestComponent()
bool	SupportsRealtimeDecompression()	Whether this device supports realtime decompression of sound waves (i.e. DTYPE_RealTime)
void	Suspend ( bool bGameTicking )	Suspend/resume all sounds (global pause for device suspend/resume, etc.)
void	SuspendContext()	Suspend any context related objects
void	Teardown()	Tears down the audio device
void	TeardownHardware()	Shuts down any platform specific hardware/APIs
void	UnlinkActiveSoundFromComponent ( const FActiveSound& InActiveSound )	Disables ActiveSound from responding to calls from its associated AudioComponent.
void	UnregisterPluginListener ( const TAudioPluginListenerPtr Plugi... )	Unregisters a third party listener-observer to this audio device.
void	UnregisterSoundClass ( USoundClass* SoundClass )	Unregisters a sound class
void	UnregisterSoundSubmix ( const USoundSubmixBase* SoundS... )	Unregisters the sound submix
void	UnregisterSubmixBufferListener ( ISubmixBufferListener* InSubmi..., USoundSubmix* SoundSubmix )	Unregisters the submix buffer listener with the given submix.
void	Update ( bool bGameTicking )	The audio system's main "Tick" function
void	UpdateActiveSoundPlaybackTime ( bool bIsTimeTicking )	Update the active sound playback time. This is done here to do after all audio is updated.
void	UpdateAudioVolumeProxy ( const FAudioVolumeProxy& Proxy )
void	UpdateDeviceDeltaTime()	Sets the update delta time for the audio frame
void *	UpdateEffect ( FSoundSource* Source )	Platform dependent call to update the sound output with new parameters The audio system's main "Tick" function
void	UpdateGameThread()	Update called on game thread.
void	UpdateHardware()	Lets the platform any tick actions
void	UpdateHardwareTiming()	Updates timing information for hardware.
void	UpdateSourceEffectChain ( const uint32 SourceEffectChainId, const TArray< FSourceEffectChainEnt..., const bool bPlayEffectChainTails )	Updates the source effect chain. Only implemented in audio mixer.
void	UpdateSubmixModulationSettings ( USoundSubmix* InSoundSubmix, const TSet< TObjectPtr< USoundModul..., const TSet< TObjectPtr< USoundModul..., const TSet< TObjectPtr< USoundModul... )
void	UpdateSubmixProperties ( USoundSubmixBase* InSubmix )	Updates the submix properties of any playing submix instances.
void	UpdateVirtualLoops ( bool bForceUpdate )
bool	ValidateAPICall ( const TCHAR* Function, uint32 ErrorCode )	Check for errors and output a human readable string

Classes

	Name	Description
	FAudioSpatializationInterfaceInfo
	FAudioVolumeSettings
	FCreateComponentParams

Typedefs

Name	Description
FToggleSoloPtr	Handles all argument parsing for the solo commands in one place

Deprecated Variables

	Name	Description
uint8: 1	bSpatializationIsExternalSend	This member is no longer in use. Use the return value of GetCurrentSpatializationPluginInterfaceInfo()
int32	MaxChannelsSupportedBySpatializationPlugin	This member is no longer in use. Use the return value of GetCurrentSpatializationPluginInterfaceInfo()
TAudioSpatializ...	SpatializationPluginInterface	Do not access this member directly, it is not used. Call GetSpatializationPluginInterface() instead.

Deprecated Functions

	Name	Description
Audio::FPatc...	AddPatchForAudioBus ( uint32 InAudioBusId, float InPatchGain )	AddPatchForAudioBus is deprecated. Use AddPatchOutputForAudioBus.
Audio::FPatc...	AddPatchForAudioBus_GameThread ( uint32 InAudioBusId, float InPatchGain )	AddPatchForAudioBus_GameThread is deprecated. Use AddPatchOutputForAudioBus.
void	AddPatchInputForAudioBus ( const Audio::FPatchInput& InPatchI..., uint32 InAudioBusId, float InPatchGain )	This overload of AddPatchInputForAudioBus is deprecated. Use the overload that takes the number of frames and channels as parameters.
void	AddPatchInputForAudioBus_GameThread ( const Audio::FPatchInput& InPatchI..., uint32 InAudioBusId, float InPatchGain )	AddPatchInputForAudioBus_GameThread is deprecated. Use AddPatchInputForAudioBus.
void	ClearListenerAttenuationOverride()	Use ClearListenerAttenuationOverride that passes a ListenerIndex instead
ICompressedA...	CreateCompressedAudioInfo ( const USoundWave* SoundWave )	CreateCompressedAudioInfo is now deprecated. Please use IAudioInfoFactory::Create() instead
ICompressedA...	CreateCompressedAudioInfo ( const FSoundWaveProxyPtr& SoundWav... )	CreateCompressedAudioInfo is now deprecated. Please use IAudioInfoFactory::Create() instead
FActiveSound...	FindActiveSound ( uint64 AudioComponentID )	This call cannot be called from the GameThread & AudioComponents can now execute multiple ActiveSound instances at once. Use 'SendCommandToActiveSounds' instead.
const FVecto...	GetListenerAttenuationOverride()	Use ParseAttenuation that passes a ListenerIndex instead
float	GetMasterVolume()	GetMasterVolume has been deprecated. Please use GetPrimaryVolume instead.
FName	GetRuntimeFormat ( const USoundWave* SoundWave )	GetRuntimeFormat is now deprecated. Please call SoundWave::GetRuntimeFormat() instead
const TMap< ...	GetSoundClassPropertyMap()	Direct access of SoundClasses is no longer allowed. Instead you should use the SoundMixClassOverride system
float	GetSquaredDistanceToListener ( const FVector& Location, const FTransform& ListenerTransfor... )	Use GetDistanceSquaredToListener to check against a specific Listener
float	GetTransientMasterVolume()	GetTransientMasterVolume has been deprecated. Please use GetTransientPrimaryVolume instead.
bool	IsUsingListenerAttenuationOverride()	Use ParseAttenuation that passes a ListenerIndex instead
bool	LocationIsAudible ( const FVector& Location, const FTransform& ListenerTransfor..., const float MaxDistance )	Use LocationIsAudible that passes a ListenerIndex to check against a specific Listener
void	NotifyPendingDelete ( FActiveSound& ActiveSound )	NotifyPending is deprecated in public scope. Use IActiveSoundUpdateInterface::OnNotifyPendingDelete instead.
void	SetListenerAttenuationOverride ( const FVector AttenuationPosition )	Use SetListenerAttenuationOverride that passes a ListenerIndex instead
void	SetTransientMasterVolume ( float TransientPrimaryVolume )	SetTransientMasterVolume has been deprecated. Please use SetTransientPrimaryVolume instead.
void	UpdateSubmixModulationSettings ( USoundSubmix* InSoundSubmix, USoundModulatorBase* InOutputM..., USoundModulatorBase* InWetLeve..., USoundModulatorBase* InDryLeve... )	UpdateSubmixModulationSettings taking single modulators is deprecated. Use the overload that allows for modulator sets

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

Take our survey

Cancel