@camera.ui/sdk / plugin / PluginContract
Interface: PluginContract ​
Defined in: plugin/contract.ts:98
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? ​
optionalcapabilities?:PublishNotifications[]
Defined in: plugin/contract.ts:110
Permissions the plugin requests to call host system features (see PluginCapability).
consumes ​
consumes:
SensorType[]
Defined in: plugin/contract.ts:106
Sensor types the plugin reads from other plugins (e.g. a face plugin consuming camera video frames).
dependencies? ​
optionaldependencies?:string[]
Defined in: plugin/contract.ts:114
Extra dependencies installed into the plugin's runtime (Go module paths, PyPI or npm names).
interfaces ​
interfaces:
PluginInterface[]
Defined in: plugin/contract.ts:108
Capability flags the plugin implements (see PluginInterface).
name ​
name:
string
Defined in: plugin/contract.ts:100
Stable, unique identifier: registry key, log prefix and storage namespace.
provides ​
provides:
SensorType[]
Defined in: plugin/contract.ts:104
Sensor types the plugin produces. Empty for hubs and pure camera-controllers, required for sensor providers.
pythonVersion? ​
optionalpythonVersion?:PythonVersion
Defined in: plugin/contract.ts:112
Required Python interpreter version for Python plugins. Ignored by Node and Go plugins.
role ​
role:
PluginRole
Defined in: plugin/contract.ts:102
Role of the plugin (see PluginRole).