Audio::FWasapiInputStream Class Reference

#include <WasapiInputStream.h>

Public Member Functions
	FWasapiInputStream ()=delete
	FWasapiInputStream (FWasapiInputStream &&InOther)=delete
	FWasapiInputStream (const FWasapiInputStream &InOther)=delete
	FWasapiInputStream (TComPtr< IMMDevice > InDevice, const FWasapiAudioFormat &InFormat, uint32 InNumFramesDesired, FWasapiOnAudioCaptureFunction InCallback)
	~FWasapiInputStream ()
FWasapiInputStream &	operator= (FWasapiInputStream &&InOther)=delete
FWasapiInputStream &	operator= (const FWasapiInputStream &InOther)=delete
bool	IsInitialized () const
void	StartStream ()
void	StopStream ()
bool	WaitOnBuffer () const
bool	CaptureAudioFrames ()
uint32	GetBufferSizeFrames () const
uint32	GetBufferSizeBytes () const
double	GetStreamPosition () const

Detailed Description

FWasapiInputStream - This class manages the WASPI audio client, capture buffers and audio callback used during capture.

Constructor & Destructor Documentation

FWasapiInputStream() [1/4]

Audio::FWasapiInputStream::FWasapiInputStream ( )

delete

FWasapiInputStream() [2/4]

Audio::FWasapiInputStream::FWasapiInputStream ( FWasapiInputStream &&  InOther )

delete

FWasapiInputStream() [3/4]

Audio::FWasapiInputStream::FWasapiInputStream ( const FWasapiInputStream &  InOther )

delete

FWasapiInputStream() [4/4]

Audio::FWasapiInputStream::FWasapiInputStream	(	TComPtr< IMMDevice >	InDevice,
		const FWasapiAudioFormat &	InFormat,
		uint32	InNumFramesDesired,
		FWasapiOnAudioCaptureFunction	InCallback
	)

~FWasapiInputStream()

Audio::FWasapiInputStream::~FWasapiInputStream

(

)

Member Function Documentation

CaptureAudioFrames()

bool Audio::FWasapiInputStream::CaptureAudioFrames

(

)

The capture thread calls this periodically with new audio data during a capture.

GetBufferSizeBytes()

uint32 Audio::FWasapiInputStream::GetBufferSizeBytes

(

)

const

Returns the buffer size in bytes corresponding to the buffer for the audio callback.

GetBufferSizeFrames()

uint32 Audio::FWasapiInputStream::GetBufferSizeFrames

(

)

const

Returns the buffer size in frames for the buffer for the audio callback.

GetStreamPosition()

double Audio::FWasapiInputStream::GetStreamPosition

(

)

const

Returns the current stream position in seconds.

IsInitialized()

bool Audio::FWasapiInputStream::IsInitialized

(

)

const

Returns whether or not this object has been successfully initialized.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

StartStream()

void Audio::FWasapiInputStream::StartStream

(

)

Starts the audio capture which triggers periodic callbacks with new audio data.

StopStream()

void Audio::FWasapiInputStream::StopStream

(

)

Stops the audio client which will shut down the stream and any further callbacks.

WaitOnBuffer()

bool Audio::FWasapiInputStream::WaitOnBuffer

(

)

const

Waits on the audio client event handle which will get set when new capture data is available.

---

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

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