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

#include <AudioCaptureCore.h>

Public Member Functions

UE_API FAudioCapture ()
 
UE_API ~FAudioCapture ()
 
UE_API int32 GetCaptureDevicesAvailable (TArray< FCaptureDeviceInfo > &OutDevices)
 
UE_API bool RegisterUser (const TCHAR *UserId)
 
UE_API bool UnregisterUser (const TCHAR *UserId)
 
UE_API bool GetCaptureDeviceInfo (FCaptureDeviceInfo &OutInfo, int32 DeviceIndex=INDEX_NONE)
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS UE_API bool OpenCaptureStream (const FAudioCaptureDeviceParams &InParams, FOnCaptureFunction OnCapture, uint32 NumFramesDesired)
 
UE_API PRAGMA_ENABLE_DEPRECATION_WARNINGS bool OpenAudioCaptureStream (const FAudioCaptureDeviceParams &InParams, FOnAudioCaptureFunction OnCapture, uint32 NumFramesDesired)
 
UE_API bool CloseStream ()
 
UE_API bool StartStream ()
 
UE_API bool StopStream ()
 
UE_API bool AbortStream ()
 
UE_API bool GetStreamTime (double &OutStreamTime) const
 
UE_API int32 GetSampleRate () const
 
UE_API bool IsStreamOpen () const
 
UE_API bool IsCapturing () const
 
UE_API bool GetIfHardwareFeatureIsSupported (EHardwareInputFeature FeatureType)
 
UE_API void SetHardwareFeatureEnabled (EHardwareInputFeature FeatureType, bool bIsEnabled)
 

Constructor & Destructor Documentation

◆ FAudioCapture()

Audio::FAudioCapture::FAudioCapture ( )

◆ ~FAudioCapture()

Audio::FAudioCapture::~FAudioCapture ( )

Member Function Documentation

◆ AbortStream()

bool Audio::FAudioCapture::AbortStream ( )

◆ CloseStream()

bool Audio::FAudioCapture::CloseStream ( )

◆ GetCaptureDeviceInfo()

bool Audio::FAudioCapture::GetCaptureDeviceInfo ( FCaptureDeviceInfo OutInfo,
int32  DeviceIndex = INDEX_NONE 
)

◆ GetCaptureDevicesAvailable()

int32 Audio::FAudioCapture::GetCaptureDevicesAvailable ( TArray< FCaptureDeviceInfo > &  OutDevices)

◆ GetIfHardwareFeatureIsSupported()

bool Audio::FAudioCapture::GetIfHardwareFeatureIsSupported ( EHardwareInputFeature  FeatureType)

◆ GetSampleRate()

int32 Audio::FAudioCapture::GetSampleRate ( ) const

◆ GetStreamTime()

bool Audio::FAudioCapture::GetStreamTime ( double OutStreamTime) const

◆ IsCapturing()

bool Audio::FAudioCapture::IsCapturing ( ) const

◆ IsStreamOpen()

bool Audio::FAudioCapture::IsStreamOpen ( ) const

◆ OpenAudioCaptureStream()

PRAGMA_ENABLE_DEPRECATION_WARNINGS bool Audio::FAudioCapture::OpenAudioCaptureStream ( const FAudioCaptureDeviceParams InParams,
FOnAudioCaptureFunction  OnCapture,
uint32  NumFramesDesired 
)

◆ OpenCaptureStream()

PRAGMA_DISABLE_DEPRECATION_WARNINGS bool Audio::FAudioCapture::OpenCaptureStream ( const FAudioCaptureDeviceParams InParams,
FOnCaptureFunction  OnCapture,
uint32  NumFramesDesired 
)

◆ RegisterUser()

bool Audio::FAudioCapture::RegisterUser ( const TCHAR UserId)

◆ SetHardwareFeatureEnabled()

void Audio::FAudioCapture::SetHardwareFeatureEnabled ( EHardwareInputFeature  FeatureType,
bool  bIsEnabled 
)

◆ StartStream()

bool Audio::FAudioCapture::StartStream ( )

◆ StopStream()

bool Audio::FAudioCapture::StopStream ( )

◆ UnregisterUser()

bool Audio::FAudioCapture::UnregisterUser ( const TCHAR UserId)

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