camera.ui Node SDK

Appearance

@camera.ui/sdk / plugin / PluginInterface

Enumeration: PluginInterface ​

Defined in: plugin/contract.ts:49

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 ​

AudioDetection ​

AudioDetection: "AudioDetection"

Defined in: plugin/contract.ts:55

Implements AudioDetectionInterface (event/keyword audio detection).

ClassifierDetection ​

ClassifierDetection: "ClassifierDetection"

Defined in: plugin/contract.ts:68

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

ClipDetection ​

ClipDetection: "ClipDetection"

Defined in: plugin/contract.ts:73

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

DiscoveryProvider ​

DiscoveryProvider: "DiscoveryProvider"

Defined in: plugin/contract.ts:78

Implements DiscoveryProvider — plugin can scan the network for new cameras and adopt them. Only valid for camera-controlling roles.

FaceDetection ​

FaceDetection: "FaceDetection"

Defined in: plugin/contract.ts:61

Implements FaceDetectionInterface (face localisation + embeddings). The NVR owns matching against enrolled faces; the plugin only emits detections + embeddings.

LicensePlateDetection ​

LicensePlateDetection: "LicensePlateDetection"

Defined in: plugin/contract.ts:63

Implements LicensePlateDetectionInterface (plate localisation + OCR).

MotionDetection ​

MotionDetection: "MotionDetection"

Defined in: plugin/contract.ts:51

Implements MotionDetectionInterface (video-based motion detection).

Notifier ​

Notifier: "Notifier"

Defined in: plugin/contract.ts:90

Implements NotifierInterface (getDevices, sendNotification, ...). Lets the central NotificationManager dispatch notifications to this plugin regardless of role — see notifier.ts.

NVR ​

NVR: "NVR"

Defined in: plugin/contract.ts:84

Implements NVRInterface — persists events and recordings, and serves them back to the UI / mobile clients. Exactly one plugin per host fills this role at runtime.

OAuthAuthCodeFlow ​

OAuthAuthCodeFlow: "OAuthAuthCodeFlow"

Defined in: plugin/contract.ts:100

Implements OAuthAuthCodeFlowCapable (Authorization Code Flow + PKCE).

OAuthCapable ​

OAuthCapable: "OAuthCapable"

Defined in: plugin/contract.ts:96

Implements the OAuthCapable base interface (getOAuthMetadata, getOAuthState, disconnect) plus at least one flow sub-interface below — see oauth.ts.

OAuthClientCredentials ​

OAuthClientCredentials: "OAuthClientCredentials"

Defined in: plugin/contract.ts:102

Implements OAuthClientCredentialsCapable (user-supplied client_id + client_secret).

OAuthDeviceFlow ​

OAuthDeviceFlow: "OAuthDeviceFlow"

Defined in: plugin/contract.ts:98

Implements OAuthDeviceFlowCapable (RFC 8628 Device Authorization Grant).

ObjectDetection ​

ObjectDetection: "ObjectDetection"

Defined in: plugin/contract.ts:53

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