@camera.ui/sdk 0.0.28 → 0.0.30

package/dist/index.d.ts

@@ -3684,6 +3684,8 @@ declare enum SensorType {
     Classifier = "classifier",
     /** CLIP embedding generation for semantic search */
     Clip = "clip",
+    /** Object assist that locates objects in a frame so secondaries get real crops from camera-side detections */
+    ObjectAssist = "objectAssist",
     /** Contact/open-close sensor (door, window) */
     Contact = "contact",
     /** Temperature sensor (°C) */
@@ -4537,6 +4539,14 @@ declare const SENSOR_META: readonly [{
         };
     };
     readonly semantics: null;
+}, {
+    readonly type: SensorType.ObjectAssist;
+    readonly category: SensorCategory.Sensor;
+    readonly assignmentKey: "objectAssist";
+    readonly multiProvider: false;
+    readonly isDetectionType: true;
+    readonly properties: {};
+    readonly semantics: null;
 }, {
     readonly type: SensorType.Occupancy;
     readonly category: SensorCategory.Sensor;
@@ -4883,6 +4893,8 @@ interface AudioDetectionSettings {
     minDecibels: number;
     /** Audio dwell time in seconds */
     timeout: number;
+    /** Minimum confidence threshold (0 - 1) for a labelled audio detection to count. */
+    confidence?: number;
 }
 /**
  * Face detection settings.
@@ -5281,6 +5293,8 @@ interface RtpSessionOptions {
         width?: number;
         /** Output height */
         height?: number;
+        /** Maximum output bitrate in bits per second */
+        bitrate?: number;
         /** Additional encoder options */
         encoderOptions?: Record<string, string | number | boolean | undefined | null>;
     };
@@ -5391,7 +5405,7 @@ interface Fmp4SessionOptions {
         width?: number;
         /** Output height */
         height?: number;
-        /** Maximum video bitrate in bits per second (VBV cap, applied on transcode only) */
+        /** Maximum video bitrate in bits per second */
         bitrate?: number;
         /** Additional encoder options */
         encoderOptions?: Record<string, string | number | boolean | undefined | null>;
@@ -7384,5 +7398,22 @@ interface OAuthClientCredentialsCapable extends OAuthCapable {
     configureClientCredentials(clientId: string, clientSecret: string): Promise<OAuthState>;
 }
 
-export { API_EVENT, AudioDetectorSensor, AudioProperty, AudioSensor, BASE_AUDIO_LABELS, BasePlugin, BatteryCapability, BatteryInfo, BatteryProperty, BehaviorSubject, ChargingState, ClassifierDetectorSensor, ClassifierProperty, ClassifierSensor, ClipDetectorSensor, ContactProperty, ContactSensor, DETECTION_ATTRIBUTES, DETECTION_LABELS, Disposable, DoorbellProperty, DoorbellTrigger, EVENT_TRIGGER_TYPES, FaceDetectorSensor, FaceProperty, FaceSensor, GarageControl, GarageProperty, GarageState, HumidityInfo, HumidityProperty, LeakProperty, LeakSensor, LicensePlateDetectorSensor, LicensePlateProperty, LicensePlateSensor, LightCapability, LightControl, LightProperty, LockControl, LockProperty, LockState, MotionDetectorSensor, MotionProperty, MotionSensor, OBJECT_DETECTION_LABELS, ObjectDetectorSensor, ObjectProperty, ObjectSensor, Observable, OccupancyProperty, OccupancySensor, PTZCapability, PTZControl, PTZProperty, PluginCapability, PluginInterface, PluginRole, RING_AUTO_RESET_MS, ReplaySubject, RtpPacket, SENSOR_META, SecuritySystem, SecuritySystemProperty, SecuritySystemState, Sensor, SensorCategory, SensorDomain, SensorType, Severity, SirenCapability, SirenControl, SirenProperty, SmokeProperty, SmokeSensor, Subject, SwitchControl, SwitchProperty, TemperatureInfo, TemperatureProperty, audioMeta, batteryMeta, canCreateCameras, canProvideSensorsToAnyCameras, classifierMeta, clipMeta, contactMeta, defineSensor, distinctUntilChanged, doorbellMeta, faceMeta, filter, firstValueFrom, garageMeta, getContractValidationErrors, hasCapability, hasInterface, humidityMeta, isHub, leakMeta, licensePlateMeta, lightMeta, lockMeta, map, mergeMap, motionMeta, objectMeta, occupancyMeta, pairwise, ptzMeta, securitySystemMeta, sensorMeta, share, sirenMeta, smokeMeta, switchMeta, temperatureMeta, validateContractConsistency };
+/**
+ * Registry metadata for the object assist slot.
+ *
+ * There is no sensor class for this type: a plugin assigned to the slot serves
+ * it with the {@link ObjectDetectorSensor} it already registers, so plugins
+ * declare and implement object detection only.
+ */
+declare const objectAssistMeta: {
+    readonly type: SensorType.ObjectAssist;
+    readonly category: SensorCategory.Sensor;
+    readonly assignmentKey: "objectAssist";
+    readonly multiProvider: false;
+    readonly isDetectionType: true;
+    readonly properties: {};
+    readonly semantics: null;
+};
+
+export { API_EVENT, AudioDetectorSensor, AudioProperty, AudioSensor, BASE_AUDIO_LABELS, BasePlugin, BatteryCapability, BatteryInfo, BatteryProperty, BehaviorSubject, ChargingState, ClassifierDetectorSensor, ClassifierProperty, ClassifierSensor, ClipDetectorSensor, ContactProperty, ContactSensor, DETECTION_ATTRIBUTES, DETECTION_LABELS, Disposable, DoorbellProperty, DoorbellTrigger, EVENT_TRIGGER_TYPES, FaceDetectorSensor, FaceProperty, FaceSensor, GarageControl, GarageProperty, GarageState, HumidityInfo, HumidityProperty, LeakProperty, LeakSensor, LicensePlateDetectorSensor, LicensePlateProperty, LicensePlateSensor, LightCapability, LightControl, LightProperty, LockControl, LockProperty, LockState, MotionDetectorSensor, MotionProperty, MotionSensor, OBJECT_DETECTION_LABELS, ObjectDetectorSensor, ObjectProperty, ObjectSensor, Observable, OccupancyProperty, OccupancySensor, PTZCapability, PTZControl, PTZProperty, PluginCapability, PluginInterface, PluginRole, RING_AUTO_RESET_MS, ReplaySubject, RtpPacket, SENSOR_META, SecuritySystem, SecuritySystemProperty, SecuritySystemState, Sensor, SensorCategory, SensorDomain, SensorType, Severity, SirenCapability, SirenControl, SirenProperty, SmokeProperty, SmokeSensor, Subject, SwitchControl, SwitchProperty, TemperatureInfo, TemperatureProperty, audioMeta, batteryMeta, canCreateCameras, canProvideSensorsToAnyCameras, classifierMeta, clipMeta, contactMeta, defineSensor, distinctUntilChanged, doorbellMeta, faceMeta, filter, firstValueFrom, garageMeta, getContractValidationErrors, hasCapability, hasInterface, humidityMeta, isHub, leakMeta, licensePlateMeta, lightMeta, lockMeta, map, mergeMap, motionMeta, objectAssistMeta, objectMeta, occupancyMeta, pairwise, ptzMeta, securitySystemMeta, sensorMeta, share, sirenMeta, smokeMeta, switchMeta, temperatureMeta, validateContractConsistency };
 export type { AssignedPlugin, AudioCodec, AudioCodecProperties, AudioDetectionInterface, AudioDetectionPluginResponse, AudioDetectionSettings, AudioFFmpegCodec, AudioFrameData, AudioInputSpec, AudioLabel, AudioMetadata, AudioModelSpec, AudioResult, AudioSensorLike, AudioSensorProperties, AudioStreamInfo, BaseAudioLabel, BaseCamera, BaseCameraConfig, BatteryInfoLike, BatteryInfoProperties, BoundingBox, Camera, CameraAspectRatio, CameraAspectRatioPreset, CameraConfig, CameraConfigInputSettings, CameraDetectionSettings, CameraDevice, CameraDeviceSource, CameraFrameWorkerSettings, CameraImplementation, CameraInformation, CameraInput, CameraPluginInfo, CameraRecordingSettings, CameraRole, CameraSource, CameraType, CameraUiSettings, ClassifierDetection, ClassifierDetectionInterface, ClassifierDetectionPluginResponse, ClassifierResult, ClassifierSensorLike, ClassifierSensorProperties, ClipDetectionInterface, ClipDetectionPluginResponse, ClipEmbedding, ClipResult, ClipTextEmbeddingResult, ContactSensorLike, ContactSensorProperties, CoreManager, CoreManagerEvent, CreateDownloadOptions, CreateStreamDownloadOptions, Detection, DetectionAttribute, DetectionEvent, DetectionEventState, DetectionEventType, DetectionLabel, DetectionLine, DetectionZone, DeviceManager, DeviceStorage, DiscoveredCamera, DiscoveryProvider, DoorbellTriggerLike, DoorbellTriggerProperties, DownloadCleanup, DownloadManager, DownloadToken, EventAttribute, EventDescription, EventDetection, EventSegment, EventTrigger, EventTriggerType, FMTPInfo, FaceDetection, FaceDetectionInterface, FaceDetectionPluginResponse, FaceDetectionSettings, FaceResult, FaceSensorLike, FaceSensorProperties, Fmp4Session, Fmp4SessionOptions, FormSubmitResponse, FormSubmitSchema, GarageControlLike, GarageControlProperties, Go2RtcRTSPSource, Go2RtcSnapshotSource, Go2RtcWSSource, HardwareAcceleration, HumidityInfoLike, HumidityInfoProperties, ImageMetadata, JsonArraySchema, JsonBaseSchema, JsonBaseSchemaWithoutCallbacks, JsonBooleanSchema, JsonEnumSchema, JsonFactorySchema, JsonNumberSchema, JsonSchema, JsonSchemaArray, JsonSchemaArrayWithoutCallbacks, JsonSchemaBoolean, JsonSchemaBooleanWithoutCallbacks, JsonSchemaButton, JsonSchemaEnum, JsonSchemaEnumWithoutCallbacks, JsonSchemaNumber, JsonSchemaNumberWithoutCallbacks, JsonSchemaString, JsonSchemaStringWithoutCallbacks, JsonSchemaSubmit, JsonSchemaType, JsonSchemaWithoutCallbacks, JsonSchemaWithoutKey, JsonStringSchema, LeakSensorLike, LeakSensorProperties, LicensePlateDetection, LicensePlateDetectionInterface, LicensePlateDetectionPluginResponse, LicensePlateDetectionSettings, LicensePlateResult, LicensePlateSensorLike, LicensePlateSensorProperties, LightControlLike, LightControlProperties, LineDirection, LockControlLike, LockControlProperties, LoggerService, ModelSpec, MotionDetectionInterface, MotionDetectionPluginResponse, MotionDetectionSettings, MotionResolution, MotionResult, MotionSensorLike, MotionSensorProperties, Notification, NotificationManager, NotifierDevice, NotifierInterface, OAuthAuthCodeFlowCapable, OAuthCapable, OAuthClientCredentialsCapable, OAuthDeviceFlowCapable, OAuthMetadata, OAuthProviderConfig, OAuthProviderDeclaration, OAuthState, OAuthStatus, ObjectDetectionInterface, ObjectDetectionLabel, ObjectDetectionPluginResponse, ObjectDetectionSettings, ObjectModelSpec, ObjectResult, ObjectSensorLike, ObjectSensorProperties, OccupancySensorLike, OccupancySensorProperties, OperatorFn, PTZControlLike, PTZControlProperties, PTZDirection, PTZPosition, PTZRelativeMove, PluginAPI, PluginAssignments, PluginConfig, PluginContract, PluginInfo, PluginInterfaces, Point, ProbeAudioCodec, ProbeConfig, ProbeStream, PropertyChangeOf, PtzAutotrackSettings, PythonVersion, RTPInfo, RTSPAudioCodec, RTSPUrlOptions, RecordingMode, RecordingSource, RtpSession, RtpSessionBackchannelOptions, RtpSessionOptions, SchemaCondition, SchemaConditionOperator, SchemaConfig, SecuritySystemLike, SecuritySystemProperties, SensorAssignmentKey, SensorCapability, SensorCascadeTrigger, SensorLike, SensorMeta, SensorPropertySpec, SensorPropertyType, SensorPropertyValueType, SensorSemantics, SensorTriggerRef, SensorTriggerSettings, SensorVirtualDefaults, SirenControlLike, SirenControlProperties, SmokeSensorLike, SmokeSensorProperties, SnapshotInterface, SnapshotSettings, SnapshotUrlOptions, StreamDirection, StreamUrls, StreamingInterface, StreamingRole, SwitchControlLike, SwitchControlProperties, TemperatureInfoLike, TemperatureInfoProperties, ToastMessage, TrackedDetection, VideoCodec, VideoCodecProperties, VideoFFmpegCodec, VideoFrameData, VideoInputSpec, VideoStreamInfo, VideoStreamingMode, ZoneFilter, ZoneType };

package/dist/internal/index.d.ts

@@ -358,6 +358,8 @@ declare enum SensorType {
     Classifier = "classifier",
     /** CLIP embedding generation for semantic search */
     Clip = "clip",
+    /** Object assist that locates objects in a frame so secondaries get real crops from camera-side detections */
+    ObjectAssist = "objectAssist",
     /** Contact/open-close sensor (door, window) */
     Contact = "contact",
     /** Temperature sensor (°C) */

package/dist/sensor/base.js

@@ -21,6 +21,8 @@ export var SensorType;
     SensorType["Classifier"] = "classifier";
     /** CLIP embedding generation for semantic search */
     SensorType["Clip"] = "clip";
+    /** Object assist that locates objects in a frame so secondaries get real crops from camera-side detections */
+    SensorType["ObjectAssist"] = "objectAssist";
     // Sensors — read-only state/environment sensors
     /** Contact/open-close sensor (door, window) */
     SensorType["Contact"] = "contact";

package/dist/sensor/index.js

@@ -17,6 +17,7 @@ export * from './registry.js';
 export * from './lock.js';
 export * from './motion.js';
 export * from './object.js';
+export * from './objectAssist.js';
 export * from './occupancy.js';
 export * from './ptz.js';
 export * from './securitySystem.js';

package/dist/sensor/objectAssist.js

@@ -0,0 +1,18 @@
+import { SensorCategory, SensorType } from './base.js';
+import { defineSensor } from './meta.js';
+/**
+ * Registry metadata for the object assist slot.
+ *
+ * There is no sensor class for this type: a plugin assigned to the slot serves
+ * it with the {@link ObjectDetectorSensor} it already registers, so plugins
+ * declare and implement object detection only.
+ */
+export const objectAssistMeta = defineSensor({
+    type: SensorType.ObjectAssist,
+    category: SensorCategory.Sensor,
+    assignmentKey: 'objectAssist',
+    multiProvider: false,
+    isDetectionType: true,
+    properties: {},
+    semantics: null,
+});

package/dist/sensor/registry.js

@@ -13,6 +13,7 @@ import { lightMeta } from './light.js';
 import { lockMeta } from './lock.js';
 import { motionMeta } from './motion.js';
 import { objectMeta } from './object.js';
+import { objectAssistMeta } from './objectAssist.js';
 import { occupancyMeta } from './occupancy.js';
 import { ptzMeta } from './ptz.js';
 import { securitySystemMeta } from './securitySystem.js';
@@ -37,6 +38,7 @@ export const SENSOR_META = [
     lockMeta,
     motionMeta,
     objectMeta,
+    objectAssistMeta,
     occupancyMeta,
     ptzMeta,
     securitySystemMeta,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camera.ui/sdk",
-  "version": "0.0.28",
+  "version": "0.0.30",
   "description": "camera.ui sdk",
   "exports": {
     ".": {
@@ -35,7 +35,7 @@
     "@stylistic/eslint-plugin": "^5.10.0",
     "@types/multicast-dns": "^7.2.4",
     "@types/node": "26.1.1",
-    "@typescript-eslint/parser": "^8.64.0",
+    "@typescript-eslint/parser": "^8.65.0",
     "cpy-cli": "^7.0.0",
     "eslint": "9.39.2",
     "eslint-plugin-jsdoc": "^63.2.0",
@@ -48,7 +48,7 @@
     "typedoc-plugin-markdown": "^4.12.0",
     "typedoc-vitepress-theme": "^1.1.3",
     "typescript": "5.9.3",
-    "typescript-eslint": "^8.64.0",
+    "typescript-eslint": "^8.65.0",
     "vitepress": "^1.6.4",
     "vitest": "^4.1.10",
     "werift": "0.23.0",