UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
FVoiceCaptureDeviceWindows Class Reference

#include <VoiceCaptureWindows.h>

Classes

struct  FCaptureDeviceInfo
 

Public Member Functions

 FVoiceCaptureDeviceWindows ()
 
 ~FVoiceCaptureDeviceWindows ()
 
FVoiceCaptureWindows * CreateVoiceCaptureObject (const FString &DeviceName, int32 SampleRate, int32 NumChannels)
 

Static Public Member Functions

static FVoiceCaptureDeviceWindows * Get ()
 

Public Attributes

LPDIRECTSOUND8 DirectSound
 
FString HMDAudioInputDevice
 
FCaptureDeviceInfo DefaultVoiceCaptureDevice
 
TMap< FString, FCaptureDeviceInfo > Devices
 

Detailed Description

DirectSound wrapper for initialization / shutdown

Constructor & Destructor Documentation

◆ FVoiceCaptureDeviceWindows()

FVoiceCaptureDeviceWindows::FVoiceCaptureDeviceWindows ( )

Constructors

◆ ~FVoiceCaptureDeviceWindows()

FVoiceCaptureDeviceWindows::~FVoiceCaptureDeviceWindows ( )

Member Function Documentation

◆ CreateVoiceCaptureObject()

FVoiceCaptureWindows * FVoiceCaptureDeviceWindows::CreateVoiceCaptureObject ( const FString &  DeviceName,
int32  SampleRate,
int32  NumChannels 
)

Create a single voice capture buffer

Parameters
DeviceNamename of device to capture with, empty for default device
SampleRatevalid sample rate to capture audio data (8khz - 48khz)
NumChannelnumber of audio channels (1 - mono, 2 - stereo)
Returns
class capable of recording voice on a given device

◆ Get()

static FVoiceCaptureDeviceWindows * FVoiceCaptureDeviceWindows::Get ( )
static

Singleton accessor

Returns
access to the voice capture device

Member Data Documentation

◆ DefaultVoiceCaptureDevice

FCaptureDeviceInfo FVoiceCaptureDeviceWindows::DefaultVoiceCaptureDevice

GUID of selected voice capture device

◆ Devices

TMap<FString, FCaptureDeviceInfo> FVoiceCaptureDeviceWindows::Devices

All available capture devices

◆ DirectSound

LPDIRECTSOUND8 FVoiceCaptureDeviceWindows::DirectSound

DirectSound8 Interface

◆ HMDAudioInputDevice

FString FVoiceCaptureDeviceWindows::HMDAudioInputDevice

HMD audio input device to use

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