oa::CameraCapture

CameraCapture class in the OA Vision public surface.

ClC++ public headers

Public Methods

Status oa::CameraCapture::close()

U64 oa::CameraCapture::formatGeneration()

I32 oa::CameraCapture::fps()

I32 oa::CameraCapture::height()

bool oa::CameraCapture::isStreaming()

bool oa::CameraCapture::poll()

bool oa::CameraCapture::pollFrame(VideoFrame & frame)

U64 oa::CameraCapture::reconnectCount()

void oa::CameraCapture::release(const VideoFrame & frame)

void oa::CameraCapture::release(const VideoFrame & frame, const Event & consumed)

bool oa::CameraCapture::usesDmaBuf()

I32 oa::CameraCapture::width()

Static Public Methods

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

Constructor & Destructor Documentation

oa::CameraCapture::CameraCapture()

No public source comment is attached to this declaration.

void oa::CameraCapture::~CameraCapture()

No public source comment is attached to this declaration.

Public Method Documentation

Status oa::CameraCapture::close()

Explicit completion and release boundary for producer-owned images and mapped ring slots still referenced by GPU consumers.

Returns

Status

The declared return value.

U64 oa::CameraCapture::formatGeneration()

No public source comment is attached to this declaration.

Returns

U64

The declared return value.

I32 oa::CameraCapture::fps()

No public source comment is attached to this declaration.

Returns

I32

The declared return value.

I32 oa::CameraCapture::height()

No public source comment is attached to this declaration.

Returns

I32

The declared return value.

bool oa::CameraCapture::isStreaming()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.

bool oa::CameraCapture::poll()

acquire and upload the newest available frame. Returns false when the camera has not produced another frame yet.

Returns

bool

The declared return value.

bool oa::CameraCapture::pollFrame(
	VideoFrame & frame
)

No public source comment is attached to this declaration.

Parameters

frame

VideoFrame &

—

Returns

bool

The declared return value.

U64 oa::CameraCapture::reconnectCount()

No public source comment is attached to this declaration.

Returns

U64

The declared return value.

void oa::CameraCapture::release(
	const VideoFrame & frame
)

release a frame after its final consumer. The no-token overload declares immediate reuse; pass the exact completion when GPU work remains live.

Parameters

frame

const VideoFrame &

—

Returns

void

The declared return value.

void oa::CameraCapture::release(
	const VideoFrame & frame,
	const Event & consumed
)

No public source comment is attached to this declaration.

Parameters

frame

const VideoFrame &

—

consumed

const Event &

—

Returns

void

The declared return value.

bool oa::CameraCapture::usesDmaBuf()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.

I32 oa::CameraCapture::width()

No public source comment is attached to this declaration.

Returns

I32

The declared return value.

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

No public source comment is attached to this declaration.

Parameters

inEngine

Engine &

—

inConfig

const CameraCaptureConfig &

Default: {}

Returns

Result<CameraCapture>

The declared return value.