UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
Audio::FAudioCaptureWasapiStream Class Reference

#include <AudioCaptureWasapi.h>

+ Inheritance diagram for Audio::FAudioCaptureWasapiStream:

Public Member Functions

 FAudioCaptureWasapiStream ()
 
virtual bool GetCaptureDeviceInfo (FCaptureDeviceInfo &OutInfo, int32 DeviceIndex) override
 
virtual bool OpenAudioCaptureStream (const FAudioCaptureDeviceParams &InParams, FOnAudioCaptureFunction InOnCapture, uint32 NumFramesDesired) override
 
virtual bool CloseStream () override
 
virtual bool StartStream () override
 
virtual bool StopStream () override
 
virtual bool AbortStream () override
 
virtual bool GetStreamTime (double &OutStreamTime) override
 
virtual int32 GetSampleRate () const override
 
virtual bool IsStreamOpen () const override
 
virtual bool IsCapturing () const override
 
virtual void OnAudioCapture (void *InBuffer, uint32 InBufferFrames, double StreamTime, bool bOverflow) override
 
virtual bool GetInputDevicesAvailable (TArray< FCaptureDeviceInfo > &OutDevices) override
 
- Public Member Functions inherited from Audio::IAudioCaptureStream
 IAudioCaptureStream ()
 
virtual ~IAudioCaptureStream ()
 
virtual bool RegisterUser (const TCHAR *UserId)
 
virtual bool UnregisterUser (const TCHAR *UserId)
 
virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS bool OpenCaptureStream (const FAudioCaptureDeviceParams &InParams, FOnCaptureFunction InOnCapture, uint32 NumFramesDesired)
 
virtual bool GetIfHardwareFeatureIsSupported (EHardwareInputFeature FeatureType)
 
virtual void SetHardwareFeatureEnabled (EHardwareInputFeature FeatureType, bool bEnabled)
 

Detailed Description

WASAPI implementation of IAudioCaptureStream which encapsulates capturing audio streams from device.

Constructor & Destructor Documentation

◆ FAudioCaptureWasapiStream()

Audio::FAudioCaptureWasapiStream::FAudioCaptureWasapiStream ( )

Member Function Documentation

◆ AbortStream()

bool Audio::FAudioCaptureWasapiStream::AbortStream ( )
overridevirtual

Implements Audio::IAudioCaptureStream.

◆ CloseStream()

bool Audio::FAudioCaptureWasapiStream::CloseStream ( )
overridevirtual

Implements Audio::IAudioCaptureStream.

◆ GetCaptureDeviceInfo()

bool Audio::FAudioCaptureWasapiStream::GetCaptureDeviceInfo ( FCaptureDeviceInfo &  OutInfo,
int32  DeviceIndex 
)
overridevirtual

Implements Audio::IAudioCaptureStream.

◆ GetInputDevicesAvailable()

bool Audio::FAudioCaptureWasapiStream::GetInputDevicesAvailable ( TArray< FCaptureDeviceInfo > &  OutDevices)
overridevirtual

Implements Audio::IAudioCaptureStream.

◆ GetSampleRate()

virtual int32 Audio::FAudioCaptureWasapiStream::GetSampleRate ( ) const
inlineoverridevirtual

Implements Audio::IAudioCaptureStream.

◆ GetStreamTime()

bool Audio::FAudioCaptureWasapiStream::GetStreamTime ( double &  OutStreamTime)
overridevirtual

Implements Audio::IAudioCaptureStream.

◆ IsCapturing()

bool Audio::FAudioCaptureWasapiStream::IsCapturing ( ) const
overridevirtual

Implements Audio::IAudioCaptureStream.

◆ IsStreamOpen()

bool Audio::FAudioCaptureWasapiStream::IsStreamOpen ( ) const
overridevirtual

Implements Audio::IAudioCaptureStream.

◆ OnAudioCapture()

void Audio::FAudioCaptureWasapiStream::OnAudioCapture ( void *  InBuffer,
uint32  InBufferFrames,
double  StreamTime,
bool  bOverflow 
)
overridevirtual

Implements Audio::IAudioCaptureStream.

◆ OpenAudioCaptureStream()

bool Audio::FAudioCaptureWasapiStream::OpenAudioCaptureStream ( const FAudioCaptureDeviceParams &  InParams,
FOnAudioCaptureFunction  InOnCapture,
uint32  NumFramesDesired 
)
overridevirtual

Implements Audio::IAudioCaptureStream.

◆ StartStream()

bool Audio::FAudioCaptureWasapiStream::StartStream ( )
overridevirtual

Implements Audio::IAudioCaptureStream.

◆ StopStream()

bool Audio::FAudioCaptureWasapiStream::StopStream ( )
overridevirtual

Implements Audio::IAudioCaptureStream.

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