Skip to content

API Reference

Module-by-module reference, auto-generated from the docstrings in camera_ui_sdk.

Module What's in it
Plugin API BasePlugin, the manifest contract, optional interfaces (discovery, notifier, detection).
Camera Camera config, frames, streaming sessions, detection events, runtime device API.
Sensors Detection sensors (motion, object, face, license-plate, audio, classifier, clip) and smart-home sensors (contact, doorbell, lock, garage, light, switch, ptz, security system, environmental).
Storage & Schema Schema-driven per-device config rendered as UI forms by the host.
Manager CoreManager / DeviceManager / DownloadManager for system-level services.
Observable Reactive primitives — Observable, Subject, BehaviorSubject, ReplaySubject — and operators.
Types Shared types (LoggerService, PluginAPI, …).

If you're new to the SDK, start with the Plugin Guide instead — it walks through these modules in the order you'll actually use them.