FAudioDeviceHandle | Unreal Engine 5.7 Documentation

Strong handle to an audio device. Guarantees that the audio device it references will stay alive while it is in scope.


Name	FAudioDeviceHandle
Type	class
Header File	/Engine/Source/Runtime/Engine/Public/AudioDeviceHandle.h
Include Path	#include "AudioDeviceHandle.h"

Syntax

class FAudioDeviceHandle

Name	Remarks	Include Path
FAudioDeviceHandle ( FAudioDevice* InDevice, Audio::FDeviceId InID, UWorld* InWorld )	This constructor should only be called by FAudioDeviceManager.	AudioDeviceHandle.h
FAudioDeviceHandle ( const FAudioDeviceHandle& Other )		AudioDeviceHandle.h
FAudioDeviceHandle ()		AudioDeviceHandle.h
FAudioDeviceHandle ( FAudioDeviceHandle&& Other )		AudioDeviceHandle.h

Name	Remarks	Include Path	Unreal Specifiers
~FAudioDeviceHandle()		AudioDeviceHandle.h

Name	Type	Remarks	Include Path
Device	FAudioDevice *		AudioDeviceHandle.h
DeviceId	Audio::FDeviceId		AudioDeviceHandle.h
World	TWeakObjectPtr< UWorld >	The world that this FAudioDeviceHandle was requested with.	AudioDeviceHandle.h

Name	Remarks	Include Path
FAudioDevice * GetAudioDevice()	Gets a pointer to the audio device.	AudioDeviceHandle.h
Audio::FDeviceId GetDeviceID()	Returns the device ID for the audio device referenced by this handle.	AudioDeviceHandle.h
TWeakObjectPtr< UWorld > GetWorld()	Returns world set when handle was created.	AudioDeviceHandle.h
bool IsValid()	Checks whether this points to a valid AudioDevice.	AudioDeviceHandle.h
void Reset()	Resets handle to invalid state.	AudioDeviceHandle.h

Name	Remarks	Include Path
operator Audio::FDeviceId()		AudioDeviceHandle.h
operator bool()		AudioDeviceHandle.h
operator FAudioDevice *()		AudioDeviceHandle.h
FAudioDevice & operator* ()		AudioDeviceHandle.h
const FAudioDevice & operator* ()	These are convenience operators to use an FAudioDeviceHandle like an FAudioDevice* or an Audio::FDeviceId.	AudioDeviceHandle.h
FAudioDeviceHandle & operator= ( const FAudioDeviceHandle& Other )		AudioDeviceHandle.h
FAudioDeviceHandle & operator= ( FAudioDeviceHandle&& Other )		AudioDeviceHandle.h
bool operator== ( const FAudioDeviceHandle& Other ) const		AudioDeviceHandle.h
bool operator== ( const FAudioDevice*& Other ) const		AudioDeviceHandle.h
bool operator== ( FAudioDevice*& Other ) const		AudioDeviceHandle.h
bool operator== ( const Audio::FDeviceId& Other ) const		AudioDeviceHandle.h
const FAudioDevice * operator-> ()		AudioDeviceHandle.h
FAudioDevice * operator-> ()		AudioDeviceHandle.h