Audio::FWasapiCaptureThread Class Reference

#include <WasapiCaptureThread.h>

Public Member Functions
	FWasapiCaptureThread ()=delete
	FWasapiCaptureThread (TSharedPtr< FWasapiInputStream > InStream)
bool	Start ()
void	Stop ()
void	Abort ()

Detailed Description

FWasapiCaptureThread - Manages both the FWasapiCaptureRunnable object and the thread whose context it runs in.

Constructor & Destructor Documentation

FWasapiCaptureThread() [1/2]

Audio::FWasapiCaptureThread::FWasapiCaptureThread ( )

delete

FWasapiCaptureThread() [2/2]

Audio::FWasapiCaptureThread::FWasapiCaptureThread ( TSharedPtr< FWasapiInputStream >  InStream )

explicit

FWasapiCaptureThread - Constructor which accepts FWasapiInputStream and creates FWasapiCaptureRunnable with it.

Member Function Documentation

Abort()

void Audio::FWasapiCaptureThread::Abort

(

)

Abort - Performs non-graceful shutdown of capture thread which will close the underyling thread handle without waiting for it to finish.

Start()

bool Audio::FWasapiCaptureThread::Start

(

)

Start - Creates the FRunnableThread object which immediately begins running the FWasapiCaptureRunnable member.

Returns

- Boolean indicating of the thread was succesfully created.

Stop()

void Audio::FWasapiCaptureThread::Stop

(

)

Stop - Gracefully shuts down the capture thread.

---

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

• Engine/Source/Runtime/AudioCaptureImplementations/Windows/AudioCaputureWasapi/Private/WasapiCaptureThread.h
• Engine/Source/Runtime/AudioCaptureImplementations/Windows/AudioCaputureWasapi/Private/WasapiCaptureThread.cpp