Skip to content

@camera.ui/sdk / plugin / PluginInterface

Enumeration: PluginInterface ​

Defined in: plugin/contract.ts:41

Capability flags a plugin advertises in its contract. The host uses these to decide which RPC handlers to wire up and which UI affordances to show.

Enumeration Members ​

AssistantModels ​

AssistantModels: "AssistantModels"

Defined in: plugin/contract.ts:81

Implements AssistantModelProvider, so its models appear in the assistant settings.


AssistantTools ​

AssistantTools: "AssistantTools"

Defined in: plugin/contract.ts:79

Implements AssistantToolProvider, so the assistant can offer the plugin's tools to the model.


AudioDetection ​

AudioDetection: "AudioDetection"

Defined in: plugin/contract.ts:47

Implements AudioDetectionInterface (event/keyword audio detection).


ClassifierDetection ​

ClassifierDetection: "ClassifierDetection"

Defined in: plugin/contract.ts:53

Implements ClassifierDetectionInterface (generic image classification emitting attribute/label pairs).


ClipDetection ​

ClipDetection: "ClipDetection"

Defined in: plugin/contract.ts:55

Implements ClipDetectionInterface (CLIP image and text embeddings used for semantic search).


DiscoveryProvider ​

DiscoveryProvider: "DiscoveryProvider"

Defined in: plugin/contract.ts:63

Implements DiscoveryProvider (network scan + adoption). Only valid for camera-controlling roles.


FaceDetection ​

FaceDetection: "FaceDetection"

Defined in: plugin/contract.ts:49

Implements FaceDetectionInterface (face localisation + embeddings). Matching against enrolled faces happens in the NVR.


FaceEmbedding ​

FaceEmbedding: "FaceEmbedding"

Defined in: plugin/contract.ts:57

Implements FaceEmbeddingInterface (turns a face crop into a vector). Matching against enrolled faces happens in the NVR.


LicensePlateDetection ​

LicensePlateDetection: "LicensePlateDetection"

Defined in: plugin/contract.ts:51

Implements LicensePlateDetectionInterface (plate localisation + OCR).


MotionDetection ​

MotionDetection: "MotionDetection"

Defined in: plugin/contract.ts:43

Implements MotionDetectionInterface (video-based motion detection).


Notifier ​

Notifier: "Notifier"

Defined in: plugin/contract.ts:69

Implements NotifierInterface, so the NotificationManager can dispatch notifications to this plugin.


NVR ​

NVR: "NVR"

Defined in: plugin/contract.ts:67

Implements NVRInterface (events and recordings). Exactly one plugin per host fills this role at runtime.


OAuthAuthCodeFlow ​

OAuthAuthCodeFlow: "OAuthAuthCodeFlow"

Defined in: plugin/contract.ts:75

Implements OAuthAuthCodeFlowCapable (Authorization Code Flow + PKCE).


OAuthCapable ​

OAuthCapable: "OAuthCapable"

Defined in: plugin/contract.ts:71

Implements the OAuthCapable base interface plus at least one of the flow sub-interfaces below.


OAuthClientCredentials ​

OAuthClientCredentials: "OAuthClientCredentials"

Defined in: plugin/contract.ts:77

Implements OAuthClientCredentialsCapable (user-supplied client_id + client_secret).


OAuthDeviceFlow ​

OAuthDeviceFlow: "OAuthDeviceFlow"

Defined in: plugin/contract.ts:73

Implements OAuthDeviceFlowCapable (RFC 8628 Device Authorization Grant).


ObjectDetection ​

ObjectDetection: "ObjectDetection"

Defined in: plugin/contract.ts:45

Implements ObjectDetectionInterface (e.g. person, vehicle, animal).


PersonEmbedding ​

PersonEmbedding: "PersonEmbedding"

Defined in: plugin/contract.ts:59

Implements PersonEmbeddingInterface (turns the crop of a person into a vector of their appearance). Searching happens in the NVR.


Segmentation ​

Segmentation: "Segmentation"

Defined in: plugin/contract.ts:61

Implements SegmentationInterface (outlines the object at a box in a picture).


SensorDiscovery ​

SensorDiscovery: "SensorDiscovery"

Defined in: plugin/contract.ts:65

Implements SensorDiscoveryProvider (external sensor inventory the user adopts from).