camera.ui Node SDK

Appearance

@camera.ui/sdk / plugin / FaceDetectionInterface

Interface: FaceDetectionInterface ​

Defined in: plugin/interfaces.ts:279

Implemented by plugins that locate faces and emit per-face embeddings. The NVR owns matching against enrolled faces, the plugin only emits raw detections and embeddings.

Methods ​

detectFaces()? ​

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

Defined in: plugin/interfaces.ts:283

Run face detection on a pre-decoded video frame.

Parameters ​

frame ​

VideoFrameData

config? ​

Record<string, unknown>

Returns ​

Promise<FaceDetectionPluginResponse | undefined>

faceDetectionSettings()? ​

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

Defined in: plugin/interfaces.ts:285

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

Returns ​

Promise<JsonSchema[] | undefined>

testFaceDetection() ​

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

Defined in: plugin/interfaces.ts:281

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