Navigation
Unreal Engine C++ API Reference > Runtime > Engine
References
Module | Engine |
Header | /Engine/Source/Runtime/Engine/Public/AudioDeviceHandle.h |
Include | #include "AudioDeviceHandle.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
Type | Name | Description | |
---|---|---|---|
![]() |
|||
![]() |
FAudioDeviceHandle
(
const FAudioDeviceHandle& Other |
||
![]() |
FAudioDeviceHandle
(
FAudioDeviceHandle&& Other |
Destructors
Type | Name | Description | |
---|---|---|---|
![]() |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
FAudioDevice * | Gets a pointer to the audio device. | |
![]() ![]() |
Audio::FDeviceId | GetDeviceID () |
Returns the device ID for the audio device referenced by this handle. |
![]() ![]() |
TWeakObjectPtr< UWorld > | GetWorld () |
Returns world set when handle was created. |
![]() ![]() |
bool | IsValid () |
Checks whether this points to a valid AudioDevice. |
![]() |
void | Reset () |
Resets handle to invalid state. |
Operators
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
|||
![]() ![]() |
|||
![]() ![]() |
|||
![]() |
FAudioDevice & | operator* () |
|
![]() ![]() |
const FAudioDevice & | operator* () |
These are convenience operators to use an FAudioDeviceHandle like an FAudioDevice* or an Audio::FDeviceId. |
![]() |
FAudioDeviceHandle & | operator=
(
const FAudioDeviceHandle& Other |
|
![]() |
FAudioDeviceHandle & | operator=
(
FAudioDeviceHandle&& Other |
|
![]() ![]() |
bool | operator==
(
const FAudioDeviceHandle& Other |
|
![]() ![]() |
bool | operator==
(
const FAudioDevice*& Other |
|
![]() ![]() |
bool | operator==
(
FAudioDevice*& Other |
|
![]() ![]() |
bool | operator==
(
const Audio::FDeviceId& Other |
|
![]() ![]() |
const FAudioDevice * | operator-> () |
|
![]() |
FAudioDevice * | operator-> () |