FAudioDeviceParams

Parameters passed into [FAudioDeviceManager::RequestAudioDevice](API\Runtime\Engine\FAudioDeviceManager\RequestAudioDevice).

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/AudioDeviceManager.h

Include

#include "AudioDeviceManager.h"

Syntax

struct FAudioDeviceParams

Remarks

Parameters passed into FAudioDeviceManager::RequestAudioDevice.

Variables

Name Description

Public variable

UWorld *

 

AssociatedWorld

Optional world parameter. This allows tools to surface information about which worlds are being rendered through which audio devices.

Public variable

IAudioDeviceMod...

 

AudioModule

Use this to force this audio device to use a specific audio module. If nullptr, uses the default audio module.

Public variable

bool

 

bIsNonRealtime

Set this to true to get a handle to a non realtime audio renderer.

Public variable

EAudioDeviceSco...

 

Scope

This should be set to EAudioDeviceScope::Unique if you'd like to force a new device to be created from scratch, or use EAudioDeviceScope::Shared to use an existing device if possible.

Constructors

Name Description

Public function

FAudioDeviceParams()

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