Skip to content

@camera.ui/sdk / plugin / ObjectDetectionInterface

Interface: ObjectDetectionInterface

Defined in: plugin/interfaces.ts:214

Interface for plugins that provide object detection. Implement testObjectDetection() to handle detection test requests from the UI.

Methods

detectObjects()?

optional detectObjects(frame, config?): Promise<ObjectDetectionPluginResponse | undefined>

Defined in: plugin/interfaces.ts:218

Run object detection on a pre-processed frame. Used by automations/benchmarks.

Parameters

frame

VideoFrameData

config?

Record<string, unknown>

Returns

Promise<ObjectDetectionPluginResponse | undefined>


objectDetectionSettings()?

optional objectDetectionSettings(): Promise<JsonSchema[] | undefined>

Defined in: plugin/interfaces.ts:220

Optional settings schema for object detection configuration UI

Returns

Promise<JsonSchema[] | undefined>


testObjectDetection()

testObjectDetection(imageData, metadata, config): Promise<ObjectDetectionPluginResponse | undefined>

Defined in: plugin/interfaces.ts:216

Run object detection on image data. Used by the UI for testing/previewing.

Parameters

imageData

Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

metadata

ImageMetadata

config

Record<string, unknown>

Returns

Promise<ObjectDetectionPluginResponse | undefined>