@camera.ui/sdk / plugin / FaceDetectionInterface
Interface: FaceDetectionInterface ​
Defined in: plugin/interfaces.ts:398
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()? ​
optionaldetectFaces(frame,config?):Promise<FaceDetectionPluginResponse|undefined>
Defined in: plugin/interfaces.ts:405
Run face detection on a pre-decoded video frame.
Parameters ​
frame ​
config? ​
Record<string, unknown>
Returns ​
Promise<FaceDetectionPluginResponse | undefined>
faceDetectionSettings()? ​
optionalfaceDetectionSettings():Promise<JsonSchema[] |undefined>
Defined in: plugin/interfaces.ts:407
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:403
Run face detection on a single image captured by the UI test panel and return the result for preview rendering. A number in config.threshold is the lowest confidence to return, without it the plugin's default applies.
Parameters ​
imageData ​
Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>
metadata ​
config ​
Record<string, unknown>
Returns ​
Promise<FaceDetectionPluginResponse | undefined>