@camera.ui/sdk / plugin / PersonEmbeddingInterface
Interface: PersonEmbeddingInterface ​
Defined in: plugin/interfaces.ts:439
Implemented by plugins that turn the crop of a person into a vector of their appearance. The NVR stores and searches the vectors, the plugin only emits them.
Methods ​
embedPersonImages() ​
embedPersonImages(
images,config?):Promise<(PersonEmbeddingPluginResponse|undefined)[]>
Defined in: plugin/interfaces.ts:446
Embed a batch of encoded images (JPEG/PNG), each showing one person cut tight around their box: one result per input in the same order. An empty embedding means the picture could not be used, undefined that the plugin could not run at all. Meant for searching by a picture the user picked.
Parameters ​
images ​
(Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>)[]
config? ​
Record<string, unknown>
Returns ​
Promise<(PersonEmbeddingPluginResponse | undefined)[]>
personEmbeddingSettings()? ​
optionalpersonEmbeddingSettings():Promise<JsonSchema[] |undefined>
Defined in: plugin/interfaces.ts:448
Return the JSON schema for the person-embedding settings form in the UI, or undefined for no schema.
Returns ​
Promise<JsonSchema[] | undefined>