#include <AudioMixer.h>

Public Member Functions
	FAudioMixerOpenStreamParams ()

Public Attributes
uint32	OutputDeviceIndex

uint32	NumFrames

int32	NumBuffers

IAudioMixer *	AudioMixer

uint32	SampleRate

int32	MaxSources

bool	bRestoreIfRemoved

bool	bUseSystemAudioDevice

FString	AudioDeviceId

Detailed Description

Defines parameters needed for opening a new audio stream to device.

Constructor & Destructor Documentation

◆ FAudioMixerOpenStreamParams()

Audio::FAudioMixerOpenStreamParams::FAudioMixerOpenStreamParams ( )

inline

Member Data Documentation

◆ AudioDeviceId

FString Audio::FAudioMixerOpenStreamParams::AudioDeviceId

The device id of an audio output device. May be empty if bUseSystemAudioDevice is true.

◆ AudioMixer

IAudioMixer* Audio::FAudioMixerOpenStreamParams::AudioMixer

Owning platform independent audio mixer ptr.

◆ bRestoreIfRemoved

bool Audio::FAudioMixerOpenStreamParams::bRestoreIfRemoved

Whether or not to try and restore audio to this stream if the audio device is removed (and the device becomes available again).

◆ bUseSystemAudioDevice

bool Audio::FAudioMixerOpenStreamParams::bUseSystemAudioDevice

If true, use the system default audio device. If False, AudioDeviceId must contain a valid device Id.

◆ MaxSources

int32 Audio::FAudioMixerOpenStreamParams::MaxSources

◆ NumBuffers

int32 Audio::FAudioMixerOpenStreamParams::NumBuffers

The number of queued buffers to use for the stream.

◆ NumFrames

uint32 Audio::FAudioMixerOpenStreamParams::NumFrames

The number of desired audio frames in audio callback.

◆ OutputDeviceIndex

uint32 Audio::FAudioMixerOpenStreamParams::OutputDeviceIndex

The audio device index to open.

◆ SampleRate

uint32 Audio::FAudioMixerOpenStreamParams::SampleRate

The desired sample rate

The documentation for this struct was generated from the following file:

Engine/Source/Runtime/AudioMixerCore/Public/AudioMixer.h

Public Member Functions

Public Attributes