1. Epic GamesDeveloper
  3. FAudioDeviceManager

FAudioDeviceManager

Class for managing multiple audio devices.

Unreal Engine C++ API Reference > Runtime > Engine

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

  Type Name Description
Public variable TArray< FSoundBuffer * > Buffers Array of all created buffers
Public variable TMap< int32, FSoundBuffer * > WaveBufferMap Look up associating a USoundWave's resource ID with sound buffers

Constructors

  Type Name Description
Public function   Constructor

Destructors

  Type Name Description
Public function   Destructor

Functions

  Type Name Description
Public function void Tracks objects in the active audio devices.
Public function bool Creates the main audio device.
Public function void

FreeBufferResource ( FSoundBuffer* SoundBuffer
)

 Frees the sound buffer from the device manager.
Public function void

FreeResource ( USoundWave* SoundWave
)

 Frees the given sound wave resource from the device manager
Public function Static FAudioDeviceManager *

Get ()

  
Public function FAudioDeviceHandle Returns a ptr to the active audio device.
Public function FAudioDeviceHandle Returns a strong handle to the audio device associated with the given device ID.
Public function Static FAudioDevice *

GetAudioDeviceFromWorldContext ( const UObject* WorldContextObject
)

  
Public function IAudioDeviceModule * Returns the currently used audio device module for this platform.
Public function Const const FAudioDevice * Returns a raw ptr to the audio device associated with the handle.
Public function FAudioDevice * Returns a raw ptr to the audio device associated with the handle.
Public function Const TArray< FAudioDevice * > Returns all the audio devices managed by device manager.
Public function Const Audio::FAudioFormatSettings &  
Public function Static Audio::FMixerDevice *

GetAudioMixerDeviceFromWorldContext ( const UObject* WorldContextObject
)

  
Public function Audio::FAudioDebugger & Get the audio debugger instance
Public function Const const Audio::FAudioDebugger & Get the audio debugger instance
Public function FAudioDeviceParams  
Public function Const float

GetDynamicSoundVolume ( ESoundType SoundType,
const FName& SoundName
)

 Get, reset, or set a sound cue trim
Public function Const const FAudioDeviceHandle & Returns the handle to the main audio device.
Public function Const Audio::FDeviceId  
Public function Const FAudioDevice *  
Public function Const uint8 Returns the current number of active audio devices.
Public function Const uint8 Returns the number of worlds (e.g. PIE viewports) using the main audio device.
Public function FSoundBuffer *

GetSoundBufferForResourceID ( uint32 ResourceID
)

 Retrieves the sound buffer for the given resource id
Public function Const TArray< UWorld * >  
Public function Static bool Initialize the audio device manager. Return true if successfully initialized.
Public function void Initializes the sound class for all active devices.
Public function void Initialize all sound effect presets.
Public function void Initializes the sound mixes for all active devices.
Public function Const bool Gets whether or not non-realtime devices should play their audio.
Public function Const bool Gets whether or not all devices should play their audio.
Public function Const bool Returns whether the audio device handle is valid (i.e. points to an actual audio device instance)
Public function Const bool Is debug visualization of 3d sounds enabled
Public function Const void Iterates over all managed audio devices
Public function void Iterates over all managed audio devices
Public function void  
Public function void Registers the Sound Class for all active devices.
Public function void Registers the Sound Mix for all active devices.
Public function void

RegisterWorld ( UWorld* InWorld,
Audio::FDeviceId DeviceId
)

 Registers the world with the provided device Id
Public function void

RemoveSoundBufferForResourceID ( uint32 ResourceID
)

 Removes the sound buffer for the given resource id
Public function void

RemoveSoundMix ( USoundMix* SoundMix
)

 Removes sound mix from all audio devices
Public function FAudioDeviceHandle Creates or requests an audio device instance internally and returns a handle to the audio device.
Public function void Reset all sound cue trims
Public function void

ResetDynamicSoundVolume ( ESoundType SoundType,
const FName& SoundName
)

  
Public function void

SetActiveDevice ( uint32 InAudioDeviceHandle
)

 Sets which audio device is the active audio device.
Public function void

SetAudioDevice ( UWorld& InWorld,
Audio::FDeviceId InDeviceID
)

 Sets the device associated with the given world.
Public function void

SetDynamicSoundVolume ( ESoundType SoundType,
const FName& SoundName,
float Volume
)

  
Public function void

SetSoloDevice ( Audio::FDeviceId InAudioDeviceHandle
)

 Sets an audio device to be solo'd
Public function Static void  
Public function void

StopSoundsUsingResource ( USoundWave* InSoundWave,
TArray< UAudioComponent* >* StoppedComponents
)

 Stops sounds using the given resource on all audio devices.
Public function void Stops using the given sound buffer. Called before freeing the buffer
Public function void Toggles playing audio for all active PIE sessions (and all devices).
Public function void Toggles 3d visualization of 3d sounds on/off
Public function void

TrackResource ( USoundWave* SoundWave,
FSoundBuffer* Buffer
)

 Links up the resource data indices for looking up and cleaning up.
Public function void Unregisters the Sound Class for all active devices.
Public function void

UnregisterSoundSubmix ( const USoundSubmixBase* SoundSubmix
)

 Registers the Sound Mix for all active devices.
Public function void

UnregisterWorld ( UWorld* InWorld,
Audio::FDeviceId DeviceId
)

 Unregisters the world from the provided device Id
Public function void

UpdateActiveAudioDevices ( bool bGameTicking
)

 Updates all active audio devices
Public function void

UpdateSourceEffectChain ( const uint32 SourceEffectChainId,
const TArray< FSourceEffectChainEntry >& SourceEffectChain,
const bool bPlayEffectChainTails
)

 Updates source effect chain on all sources currently using the source effect chain.
Public function void

UpdateSubmix ( USoundSubmixBase* SoundSubmix
)

 Updates this submix for any changes made. Broadcasts to all submix instances.

Constants

Name Description
Singleton  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page