oa::AudioCapture

AudioCapture class in the OA Audio public surface.

ClC++ public headers

Public Methods

oa::Status oa::AudioCapture::close()

oa::U64 oa::AudioCapture::droppedFrameCount()

bool oa::AudioCapture::isStarted()

bool oa::AudioCapture::poll(AudioCaptureChunk & outChunk, oa::U32 inMaxFrames = 4096U)

oa::Status oa::AudioCapture::start()

oa::Status oa::AudioCapture::stop()

Static Public Methods

static oa::Result<AudioCapture> oa::AudioCapture::open(Engine & inEngine, const AudioCaptureConfig & inConfig = {})

Constructor & Destructor Documentation

oa::AudioCapture::AudioCapture()

No public source comment is attached to this declaration.

void oa::AudioCapture::~AudioCapture()

No public source comment is attached to this declaration.

Public Method Documentation

oa::Status oa::AudioCapture::close()

Stops callback delivery and releases the device. This is the explicit, result-bearing completion boundary.

Returns

oa::Status

The declared return value.

oa::U64 oa::AudioCapture::droppedFrameCount()

No public source comment is attached to this declaration.

Returns

oa::U64

The declared return value.

bool oa::AudioCapture::isStarted()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.

bool oa::AudioCapture::poll(
	AudioCaptureChunk & outChunk,
	oa::U32 inMaxFrames = 4096U
)

Non-blocking. Returns false when no complete captured frames are ready.

Parameters

outChunk

AudioCaptureChunk &

—

inMaxFrames

oa::U32

Default: 4096U

Returns

bool

The declared return value.

oa::Status oa::AudioCapture::start()

No public source comment is attached to this declaration.

Returns

oa::Status

The declared return value.

oa::Status oa::AudioCapture::stop()

No public source comment is attached to this declaration.

Returns

oa::Status

The declared return value.

static oa::Result<AudioCapture> oa::AudioCapture::open(
	Engine & inEngine,
	const AudioCaptureConfig & inConfig = {}
)

No public source comment is attached to this declaration.

Parameters

inEngine

Engine &

—

inConfig

const AudioCaptureConfig &

Default: {}

Returns

oa::Result<AudioCapture>

The declared return value.