Skip to content

@camera.ui/sdk / plugin / ObjectDetectionInterface

Interface: ObjectDetectionInterface

Defined in: plugin/interfaces.ts:255

Implemented by plugins that perform object detection (person, vehicle, animal, ...).

Methods

detectObjects()?

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

Defined in: plugin/interfaces.ts:259

Run detection on a pre-decoded video frame. Called from automation / benchmark pipelines.

Parameters

frame

VideoFrameData

config?

Record<string, unknown>

Returns

Promise<ObjectDetectionPluginResponse | undefined>


objectDetectionSettings()?

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

Defined in: plugin/interfaces.ts:261

Return the JSON schema used to render the object-detection settings form in the UI, or undefined for no schema.

Returns

Promise<JsonSchema[] | undefined>


testObjectDetection()

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

Defined in: plugin/interfaces.ts:257

Run detection on a single image captured by the UI test panel; metadata carries the image dimensions.

Parameters

imageData

Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

metadata

ImageMetadata

config

Record<string, unknown>

Returns

Promise<ObjectDetectionPluginResponse | undefined>