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

Light Theme

Dark Theme

FAudioDeviceManager

Class for managing multiple audio devices.

Windows

MacOS

Linux

References

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

Syntax

class FAudioDeviceManager

Remarks

Class for managing multiple audio devices.

Variables

		Name	Description
	TArray< FSoundB...	Buffers	Array of all created buffers
	TMap< int32, FS...	WaveBufferMap	Look up associating a USoundWave's resource ID with sound buffers

Constructors

	Name	Description
	FAudioDeviceManager()	Constructor

Destructors

	Name	Description
	~FAudioDeviceManager()	Destructor

Functions

	Name	Description
void	AddReferencedObjects ( FReferenceCollector& Collector )	Tracks objects in the active audio devices.
void	FreeBufferResource ( FSoundBuffer* SoundBuffer )	Frees the sound buffer from the device manager.
void	FreeResource ( USoundWave* SoundWave )	Frees the given sound wave resource from the device manager
FAudioDevice...	Get()
FAudioDevice...	GetActiveAudioDevice()	Returns a ptr to the active audio device.
FAudioDevice...	GetAudioDevice ( Audio::FDeviceId DeviceID )	Returns a strong handle to the audio device associated with the given device ID.
IAudioDevice...	GetAudioDeviceModule()	Returns the currently used audio device module for this platform.
FAudioDevice...	GetAudioDeviceRaw ( Audio::FDeviceId DeviceID )	Returns a raw ptr to the audio device associated with the handle.
TArray< FAud...	GetAudioDevices()	Returns all the audio devices managed by device manager.
const FAudio...	GetDebugger()	Get the audio debugger instance
FAudioDebugg...	GetDebugger()	Get the audio debugger instance
FAudioDevice...	GetDefaultParamsForNewWorld()
float	GetDynamicSoundVolume ( ESoundType SoundType, const FName& SoundName )	Get, reset, or set a sound cue trim
FAudioDevice...	GetMainAudioDeviceHandle()	Returns the handle to the main audio device.
Audio::FDevi...	GetMainAudioDeviceID()
uint8	GetNumActiveAudioDevices()	Returns the current number of active audio devices.
uint8	GetNumMainAudioDeviceWorlds()	Returns the number of worlds (e.g. PIE viewports) using the main audio device.
FSoundBuffer...	GetSoundBufferForResourceID ( uint32 ResourceID )	Retrieves the sound buffer for the given resource id
TArray< UWor...	GetWorldsUsingAudioDevice ( const Audio::FDeviceId& InID )
bool	Initialize()	Initialize the audio device manager. Return true if successfully initialized.
void	InitSoundClasses()	Initializes the sound class for all active devices.
void	InitSoundEffectPresets()	Initialize all sound effect presets.
void	InitSoundSubmixes()	Initializes the sound mixes for all active devices.
bool	IsPlayAllDeviceAudio()	Gets whether or not all devices should play their audio.
bool	IsUsingAudioMixer()	Returns true if we're currently using the audio mixer.
bool	IsValidAudioDevice ( Audio::FDeviceId DeviceID )	Returns whether the audio device handle is valid (i.e. points to an actual audio device instance)
bool	IsVisualizeDebug3dEnabled()	Is debug visualization of 3d sounds enabled
void	IterateOverAllDevices ( TFunction< void, c... )
void	IterateOverAllDevices ( TFunction< void, F... )
void	LogListOfAudioDevices()
void	RegisterSoundClass ( USoundClass* SoundClass )	Registers the Sound Class for all active devices.
void	RegisterSoundSubmix ( const USoundSubmixBase* SoundS... )	Registers the Sound Mix for all active devices.
void	RemoveSoundBufferForResourceID ( uint32 ResourceID )	Removes the sound buffer for the given resource id
void	RemoveSoundMix ( USoundMix* SoundMix )	Removes sound mix from all audio devices
FAudioDevice...	RequestAudioDevice ( const FAudioDeviceParams& InParams )	Creates or requests an audio device instance internally and returns a handle to the audio device.
void	ResetAllDynamicSoundVolumes()	Reset all sound cue trims
void	ResetDynamicSoundVolume ( ESoundType SoundType, const FName& SoundName )
void	SetActiveDevice ( uint32 InAudioDeviceHandle )	Sets which audio device is the active audio device.
void	SetDynamicSoundVolume ( ESoundType SoundType, const FName& SoundName, float Volume )
void	SetSoloDevice ( Audio::FDeviceId InAudioDeviceHandl... )	Sets an audio device to be solo'd
void	StopSoundsUsingResource ( USoundWave* InSoundWave, TArray< UAudioComponent* >... )	Stops sounds using the given resource on all audio devices.
void	StopSourcesUsingBuffer ( FSoundBuffer* Buffer )	Stops using the given sound buffer. Called before freeing the buffer
void	TogglePlayAllDeviceAudio()	Toggles playing audio for all active PIE sessions (and all devices).
void	ToggleVisualize3dDebug()	Toggles 3d visualization of 3d sounds on/off
void	TrackResource ( USoundWave* SoundWave, FSoundBuffer* Buffer )	Links up the resource data indices for looking up and cleaning up.
void	UnregisterSoundClass ( USoundClass* SoundClass )	Unregisters the Sound Class for all active devices.
void	UnregisterSoundSubmix ( const USoundSubmixBase* SoundS... )	Registers the Sound Mix for all active devices.
void	UpdateActiveAudioDevices ( bool bGameTicking )	Updates all active audio devices
void	UpdateSourceEffectChain ( const uint32 SourceEffectChainId, const TArray< FSourceEffectChainEnt..., const bool bPlayEffectChainTails )	Updates source effect chain on all sources currently using the source effect chain.
void	UpdateSubmix ( USoundSubmixBase* SoundSubmix )	Updates this submix for any changes made. Broadcasts to all submix instances.

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

Take our survey

Dismiss