Audio::FWasapiCaptureRunnable Class Reference

#include <WasapiCaptureThread.h>

Inheritance diagram for Audio::FWasapiCaptureRunnable:

Public Member Functions
	FWasapiCaptureRunnable ()=delete
	FWasapiCaptureRunnable (FWasapiCaptureRunnable &&InOther)=delete
	FWasapiCaptureRunnable (const FWasapiCaptureRunnable &InOther)=delete
FWasapiCaptureRunnable &	operator= (FWasapiCaptureRunnable &&InOther)=delete
FWasapiCaptureRunnable &	operator= (const FWasapiCaptureRunnable &InOther)=delete
	FWasapiCaptureRunnable (TSharedPtr< FWasapiInputStream > InStream)
virtual	~FWasapiCaptureRunnable ()=default
virtual uint32	Run () override
virtual void	Stop () override
Public Member Functions inherited from FRunnable
virtual bool	Init ()
virtual void	Exit ()
virtual class FSingleThreadRunnable *	GetSingleThreadInterface ()
virtual	~FRunnable ()

Detailed Description

FWasapiCaptureRunnable - The runnable which executes the main thread loop for FWasapiCaptureThread. It has a pointer to a FWasapiInputStream which it uses to coordinating waiting for new data and delivery of that data to the audio callback.

Constructor & Destructor Documentation

FWasapiCaptureRunnable() [1/4]

Audio::FWasapiCaptureRunnable::FWasapiCaptureRunnable ( )

delete

FWasapiCaptureRunnable() [2/4]

Audio::FWasapiCaptureRunnable::FWasapiCaptureRunnable ( FWasapiCaptureRunnable &&  InOther )

delete

FWasapiCaptureRunnable() [3/4]

Audio::FWasapiCaptureRunnable::FWasapiCaptureRunnable ( const FWasapiCaptureRunnable &  InOther )

delete

FWasapiCaptureRunnable() [4/4]

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

explicit

FWasapiCaptureRunnable - Constructor with given FWasapiInputStream.

Parameters

InStream

- The stream which will receive audio data as it is received.

~FWasapiCaptureRunnable()

virtual Audio::FWasapiCaptureRunnable::~FWasapiCaptureRunnable ( )

virtualdefault

Default destructor

Member Function Documentation

operator=() [1/2]

FWasapiCaptureRunnable & Audio::FWasapiCaptureRunnable::operator= ( const FWasapiCaptureRunnable &  InOther )

delete

operator=() [2/2]

FWasapiCaptureRunnable & Audio::FWasapiCaptureRunnable::operator= ( FWasapiCaptureRunnable &&  InOther )

delete

Run()

uint32 Audio::FWasapiCaptureRunnable::Run ( )

overridevirtual

Runs the runnable object.

This is where all per object thread work is done. This is only called if the initialization was successful.

Returns

The exit code of the runnable object

See also

Init, Stop, Exit

Implements FRunnable.

Stop()

void Audio::FWasapiCaptureRunnable::Stop ( void  )

overridevirtual

Stops the runnable object.

This is called if a thread is requested to terminate early.

See also

Init, Run, Exit

Reimplemented from FRunnable.

---

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