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

Light Theme

Dark Theme

FAudioDeviceHandle

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

Windows

MacOS

Linux

References

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

Syntax

class FAudioDeviceHandle

Remarks

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

Constructors

	Name	Description
	FAudioDeviceHandle()
	FAudioDeviceHandle ( const FAudioDeviceHandle& Other )
	FAudioDeviceHandle ( FAudioDeviceHandle&& Other )

Destructors

	Name	Description
	~FAudioDeviceHandle()

Functions

	Name	Description
FAudioDevice...	GetAudioDevice()	Gets a pointer to the audio device.
Audio::FDevi...	GetDeviceID()	Returns the device ID for the audio device referenced by this handle.
TWeakObjectP...	GetWorld()	Returns world set when handle was created.
bool	IsValid()	Checks whether this points to a valid compressed chunk.
void	Reset()	Resets handle to invalid state.

Operators

	Name	Description
	operator Audio::FDeviceId()
	operator bool()
	operator FAudioDevice *()
FAudioDevice...	operator*()
const FAudio...	operator*()	These are convenience operators to use an FAudioDeviceHandle like an FAudioDevice* or an Audio::FDeviceId.
FAudioDevice...	operator= ( const FAudioDeviceHandle& Other )
FAudioDevice...	operator= ( FAudioDeviceHandle&& Other )
bool	operator== ( const FAudioDeviceHandle& Other )
bool	operator== ( const FAudioDevice*& Other )
bool	operator== ( FAudioDevice*& Other )
bool	operator== ( const Audio::FDeviceId& Other )
const FAudio...	operator->()
FAudioDevice...	operator->()

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

Take our survey

Dismiss