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

Public function

FAudioDeviceHandle()

Public function

FAudioDeviceHandle

(
    const FAudioDeviceHandle & Other
)

Public function

FAudioDeviceHandle

(
    FAudioDeviceHandle && Other
)

Destructors

Name Description

Public function

~FAudioDeviceHandle()

Functions

Name Description

Public function Const

FAudioDevice ...

 

GetAudioDevice()

Gets a pointer to the compressed chunk.

Public function Const

Audio::FDevi ...

 

GetDeviceID()

Returns the device ID for the audio device referenced by this handle.

Public function Const

bool

 

IsValid()

Checks whether this points to a valid compressed chunk.

Public function

void

 

Reset()

Operators

Name Description

Public function Const

 

operator Audio::FDeviceId()

Public function Const

 

operator bool()

Public function Const

 

operator FAudioDevice *()

Public function Const

const FAudio ...

 

operator*()

These are convenience operators to use an FAudioDeviceHandle like an FAudioDevice* or an Audio::FDeviceId .

Public function

FAudioDevice ...

 

operator*()

Public function

FAudioDevice ...

 

operator=

(
    const FAudioDeviceHandle & Other
)

Public function

FAudioDevice ...

 

operator=

(
    FAudioDeviceHandle && Other
)

Public function Const

bool

 

operator==

(
    const FAudioDeviceHandle & Other
)

Public function Const

bool

 

operator==

(
    const FAudioDevice *& Other
)

Public function Const

bool

 

operator==

(
    FAudioDevice *& Other
)

Public function Const

bool

 

operator==

(
    const Audio::FDeviceId & Other
)

Public function Const

const FAudio ...

 

operator->()

Public function

FAudioDevice ...

 

operator->()

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback