@camera.ui/sdk / plugin / PluginContract

Interface: PluginContract

Defined in: plugin/contract.ts:84

Manifest contract a plugin declares so the host knows what it does and what it needs at load time. Validated before the plugin is started.

Properties

capabilities?

optional capabilities?: PublishNotifications[]

Defined in: plugin/contract.ts:96

Permissions the plugin requests to call host system features (see PluginCapability).

---

consumes

consumes: SensorType[]

Defined in: plugin/contract.ts:92

Sensor types the plugin reads from other plugins (e.g. a face plugin consuming camera video frames).

---

dependencies?

optional dependencies?: string[]

Defined in: plugin/contract.ts:100

Extra dependencies installed into the plugin's runtime (Go module paths, PyPI or npm names).

---

interfaces

interfaces: PluginInterface[]

Defined in: plugin/contract.ts:94

Capability flags the plugin implements (see PluginInterface).

---

name

name: string

Defined in: plugin/contract.ts:86

Stable, unique identifier: registry key, log prefix and storage namespace.

---

provides

provides: SensorType[]

Defined in: plugin/contract.ts:90

Sensor types the plugin produces. Empty for hubs and pure camera-controllers, required for sensor providers.

---

pythonVersion?

optional pythonVersion?: PythonVersion

Defined in: plugin/contract.ts:98

Required Python interpreter version for Python plugins. Ignored by Node and Go plugins.

---

role

role: PluginRole

Defined in: plugin/contract.ts:88

Role of the plugin (see PluginRole).