Skip to content

@camera.ui/sdk / plugin / ClassifierDetectionInterface

Interface: ClassifierDetectionInterface

Defined in: plugin/interfaces.ts:306

Implemented by plugins that run a generic image classifier and emit attribute/label pairs (e.g. weather, scene, activity).

Methods

classifierDetectionSettings()?

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

Defined in: plugin/interfaces.ts:316

Return the JSON schema for the classifier-detection settings form in the UI, or undefined for no schema.

Returns

Promise<JsonSchema[] | undefined>


detectClassifications()?

optional detectClassifications(frame, config?): Promise<ClassifierDetectionPluginResponse | undefined>

Defined in: plugin/interfaces.ts:314

Run classification on a pre-decoded video frame.

Parameters

frame

VideoFrameData

config?

Record<string, unknown>

Returns

Promise<ClassifierDetectionPluginResponse | undefined>


testClassifierDetection()

testClassifierDetection(imageData, metadata, config): Promise<ClassifierDetectionPluginResponse | undefined>

Defined in: plugin/interfaces.ts:308

Run classification on a single image captured by the UI test panel and return the result for preview rendering.

Parameters

imageData

Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

metadata

ImageMetadata

config

Record<string, unknown>

Returns

Promise<ClassifierDetectionPluginResponse | undefined>