UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::FWasapiRenderStreamParams Struct Reference

#include <IAudioMixerWasapiDeviceManager.h>

Public Member Functions

 FWasapiRenderStreamParams ()=default
 
 FWasapiRenderStreamParams (const TComPtr< IMMDevice > &InMMDevice, const FAudioPlatformDeviceInfo &InDeviceInfo, const uint32 InNumFrames, const uint32 InNumBuffers, const uint32 InSampleRate)
 

Public Attributes

TComPtr< IMMDeviceMMDevice
 
FAudioPlatformDeviceInfo HardwareDeviceInfo
 
uint32 NumFrames = 0
 
int32 NumBuffers = 0
 
uint32 SampleRate = 0
 

Detailed Description

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

Constructor & Destructor Documentation

◆ FWasapiRenderStreamParams() [1/2]

Audio::FWasapiRenderStreamParams::FWasapiRenderStreamParams ( )
default

◆ FWasapiRenderStreamParams() [2/2]

Audio::FWasapiRenderStreamParams::FWasapiRenderStreamParams ( const TComPtr< IMMDevice > &  InMMDevice,
const FAudioPlatformDeviceInfo InDeviceInfo,
const uint32  InNumFrames,
const uint32  InNumBuffers,
const uint32  InSampleRate 
)
inline

Member Data Documentation

◆ HardwareDeviceInfo

FAudioPlatformDeviceInfo Audio::FWasapiRenderStreamParams::HardwareDeviceInfo

Hardware device configuration info.

◆ MMDevice

TComPtr<IMMDevice> Audio::FWasapiRenderStreamParams::MMDevice

The audio device to open.

◆ NumBuffers

int32 Audio::FWasapiRenderStreamParams::NumBuffers = 0

The number of buffers to keep enqueued. More buffers increases latency, but can compensate for variable compute availability in audio callbacks on some platforms.

◆ NumFrames

uint32 Audio::FWasapiRenderStreamParams::NumFrames = 0

The number of desired audio frames in audio callback.

◆ SampleRate

uint32 Audio::FWasapiRenderStreamParams::SampleRate = 0

The desired sample rate


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