camera.ui Node SDK

Appearance

@camera.ui/sdk / plugin / FaceDetectionInterface

Interface: FaceDetectionInterface ​

Defined in: plugin/interfaces.ts:242

Interface for plugins that provide face detection. Implement testFaceDetection() to handle detection test requests from the UI. The NVR owns matching against enrolled faces; the plugin only emits raw detections + embeddings.

Methods ​

detectFaces()? ​

optional detectFaces(frame, config?): Promise<FaceDetectionPluginResponse | undefined>

Defined in: plugin/interfaces.ts:246

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

Parameters ​

frame ​

VideoFrameData

config? ​

Record<string, unknown>

Returns ​

Promise<FaceDetectionPluginResponse | undefined>

faceDetectionSettings()? ​

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

Defined in: plugin/interfaces.ts:248

Optional settings schema for face detection configuration UI

Returns ​

Promise<JsonSchema[] | undefined>

testFaceDetection() ​

testFaceDetection(imageData, metadata, config): Promise<FaceDetectionPluginResponse | undefined>

Defined in: plugin/interfaces.ts:244

Run face 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<FaceDetectionPluginResponse | undefined>