@camera.ui/sdk 0.0.19 → 0.0.21

package/dist/index.d.ts

@@ -2339,7 +2339,13 @@ declare enum PTZCapability {
     /** Camera supports named position presets */
     Presets = "presets",
     /** Camera supports a home position */
-    Home = "home"
+    Home = "home",
+    /** Camera executes relative displacement moves */
+    RelativeMove = "relativeMove",
+    /** Camera accepts absolute position writes via `setPosition()` */
+    AbsolutePosition = "absolutePosition",
+    /** Camera accepts continuous-move commands via `setVelocity()` */
+    VelocityControl = "velocityControl"
 }
 /**
  * Properties for PTZ controls
@@ -2356,7 +2362,9 @@ declare enum PTZProperty {
     /** Current movement velocity (continuous move) */
     Velocity = "velocity",
     /** Target preset to move to */
-    TargetPreset = "targetPreset"
+    TargetPreset = "targetPreset",
+    /** Relative displacement move command (write-only) */
+    RelativeMove = "relativeMove"
 }
 /** Absolute PTZ position */
 interface PTZPosition {
@@ -2381,6 +2389,20 @@ interface PTZDirection {
     tiltSpeed: number;
     zoomSpeed: number;
 }
+/**
+ * Relative displacement for a single PTZ move.
+ *
+ * Deltas are normalized to the camera's field of view: `panDelta: 1` moves the
+ * view by one full frame width, `tiltDelta: 1` by one full frame height.
+ * Conventions match {@link PTZDirection}: positive `panDelta` = right,
+ * positive `tiltDelta` = up, positive `zoomDelta` = zoom in. Plugins map the
+ * deltas to hardware-specific translation spaces (e.g. ONVIF RelativeMove).
+ */
+interface PTZRelativeMove {
+    panDelta: number;
+    tiltDelta: number;
+    zoomDelta: number;
+}
 /**
  * Property value map for PTZ controls.
  *
@@ -2392,6 +2414,7 @@ interface PTZControlProperties {
     [PTZProperty.Presets]: string[];
     [PTZProperty.Velocity]?: PTZDirection;
     [PTZProperty.TargetPreset]?: string;
+    [PTZProperty.RelativeMove]?: PTZRelativeMove;
 }
 /** Read-only proxy interface for a PTZ control */
 interface PTZControlLike extends SensorLike {
@@ -2403,6 +2426,7 @@ interface PTZControlLike extends SensorLike {
     getValue(property: PTZProperty.Presets): string[] | undefined;
     getValue(property: PTZProperty.Velocity): PTZDirection | undefined;
     getValue(property: PTZProperty.TargetPreset): string | undefined;
+    getValue(property: PTZProperty.RelativeMove): PTZRelativeMove | undefined;
     getValue(property: string): unknown;
 }
 /**
@@ -2449,6 +2473,21 @@ declare class PTZControl<TStorage extends object = Record<string, any>> extends
      * ```
      */
     setVelocity(value: PTZDirection | undefined): Promise<void>;
+    /**
+     * Relative displacement move. Override to drive hardware (e.g. ONVIF
+     * RelativeMove in a translation space) and call
+     * `await super.setRelativeMove(value)` after success to sync the SDK state.
+     * Advertise {@link PTZCapability.RelativeMove} when the camera supports it.
+     *
+     * @param value - Per-axis displacement, normalized to the field of view.
+     *
+     * @example
+     * ```ts
+     * // move the view a third of a frame to the right, a tenth down
+     * await ptz.setRelativeMove({ panDelta: 0.33, tiltDelta: -0.1, zoomDelta: 0 });
+     * ```
+     */
+    setRelativeMove(value: PTZRelativeMove): Promise<void>;
     /**
      * Preset-move command. Override to drive hardware and call
      * `await super.setTargetPreset(value)` after success to sync the SDK state.
@@ -3350,6 +3389,8 @@ interface MotionDetectionSettings {
 interface ObjectDetectionSettings {
     /** Minimum confidence threshold (0-1) */
     confidence: number;
+    /** Suppress events from objects that stay stationary across events (e.g. parked cars). Defaults to true. */
+    suppressStatic?: boolean;
 }
 /**
  * Audio detection settings.
@@ -5794,4 +5835,4 @@ interface OAuthClientCredentialsCapable extends OAuthCapable {
 }
 
 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, ObjectDetectorSensor, ObjectProperty, ObjectSensor, Observable, OccupancyProperty, OccupancySensor, PTZCapability, PTZControl, PTZProperty, PluginCapability, PluginInterface, PluginRole, RING_AUTO_RESET_MS, ReplaySubject, RtpPacket, SecuritySystem, SecuritySystemProperty, SecuritySystemState, Sensor, SensorCategory, SensorType, Severity, SirenCapability, SirenControl, SirenProperty, SmokeProperty, SmokeSensor, Subject, SwitchControl, SwitchProperty, TemperatureInfo, TemperatureProperty, canCreateCameras, canProvideSensorsToAnyCameras, distinctUntilChanged, filter, firstValueFrom, getContractValidationErrors, hasCapability, hasInterface, isHub, map, mergeMap, pairwise, share, 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, CameraConfig, CameraConfigInputSettings, CameraDetectionSettings, CameraDevice, CameraDeviceSource, CameraFrameWorkerSettings, CameraImplementation, CameraInformation, CameraInput, CameraPluginInfo, 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, 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, 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, ObjectDetectionPluginResponse, ObjectDetectionSettings, ObjectModelSpec, ObjectResult, ObjectSensorLike, ObjectSensorProperties, OccupancySensorLike, OccupancySensorProperties, OperatorFn, PTZControlLike, PTZControlProperties, PTZDirection, PTZPosition, PluginAPI, PluginAssignments, PluginConfig, PluginContract, PluginInfo, PluginInterfaces, Point, ProbeAudioCodec, ProbeConfig, ProbeStream, PropertyChangeOf, PtzAutotrackSettings, PythonVersion, RTPInfo, RTSPAudioCodec, RTSPUrlOptions, RtpSession, RtpSessionBackchannelOptions, RtpSessionOptions, SchemaCondition, SchemaConditionOperator, SchemaConfig, SecuritySystemLike, SecuritySystemProperties, SensorCapability, SensorLike, SensorPropertyType, SensorTriggerRef, SensorTriggerSettings, 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 };
+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, CameraConfig, CameraConfigInputSettings, CameraDetectionSettings, CameraDevice, CameraDeviceSource, CameraFrameWorkerSettings, CameraImplementation, CameraInformation, CameraInput, CameraPluginInfo, 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, 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, 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, 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, RtpSession, RtpSessionBackchannelOptions, RtpSessionOptions, SchemaCondition, SchemaConditionOperator, SchemaConfig, SecuritySystemLike, SecuritySystemProperties, SensorCapability, SensorLike, SensorPropertyType, SensorTriggerRef, SensorTriggerSettings, 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

@@ -236,7 +236,9 @@ declare enum PTZProperty {
     /** Current movement velocity (continuous move) */
     Velocity = "velocity",
     /** Target preset to move to */
-    TargetPreset = "targetPreset"
+    TargetPreset = "targetPreset",
+    /** Relative displacement move command (write-only) */
+    RelativeMove = "relativeMove"
 }
 
 /**

package/dist/sensor/ptz.js

@@ -1,4 +1,4 @@
-import { Sensor, SensorType, SensorCategory } from './base.js';
+import { Sensor, SensorCategory, SensorType } from './base.js';
 /** Optional capabilities for PTZ controls. Add to `capabilities` to enable features. */
 export var PTZCapability;
 (function (PTZCapability) {
@@ -9,6 +9,12 @@ export var PTZCapability;
     PTZCapability["Presets"] = "presets";
     /** Camera supports a home position */
     PTZCapability["Home"] = "home";
+    /** Camera executes relative displacement moves */
+    PTZCapability["RelativeMove"] = "relativeMove";
+    /** Camera accepts absolute position writes via `setPosition()` */
+    PTZCapability["AbsolutePosition"] = "absolutePosition";
+    /** Camera accepts continuous-move commands via `setVelocity()` */
+    PTZCapability["VelocityControl"] = "velocityControl";
 })(PTZCapability || (PTZCapability = {}));
 /**
  * Properties for PTZ controls
@@ -27,6 +33,8 @@ export var PTZProperty;
     PTZProperty["Velocity"] = "velocity";
     /** Target preset to move to */
     PTZProperty["TargetPreset"] = "targetPreset";
+    /** Relative displacement move command (write-only) */
+    PTZProperty["RelativeMove"] = "relativeMove";
 })(PTZProperty || (PTZProperty = {}));
 /**
  * Pan-tilt-zoom camera control. Override `setPosition()` / `setVelocity()` /
@@ -93,6 +101,23 @@ export class PTZControl extends Sensor {
     async setVelocity(value) {
         this._writeState({ [PTZProperty.Velocity]: value });
     }
+    /**
+     * Relative displacement move. Override to drive hardware (e.g. ONVIF
+     * RelativeMove in a translation space) and call
+     * `await super.setRelativeMove(value)` after success to sync the SDK state.
+     * Advertise {@link PTZCapability.RelativeMove} when the camera supports it.
+     *
+     * @param value - Per-axis displacement, normalized to the field of view.
+     *
+     * @example
+     * ```ts
+     * // move the view a third of a frame to the right, a tenth down
+     * await ptz.setRelativeMove({ panDelta: 0.33, tiltDelta: -0.1, zoomDelta: 0 });
+     * ```
+     */
+    async setRelativeMove(value) {
+        this._writeState({ [PTZProperty.RelativeMove]: value });
+    }
     /**
      * Preset-move command. Override to drive hardware and call
      * `await super.setTargetPreset(value)` after success to sync the SDK state.
@@ -167,6 +192,9 @@ export class PTZControl extends Sensor {
             case PTZProperty.TargetPreset:
                 await this.setTargetPreset(value);
                 return;
+            case PTZProperty.RelativeMove:
+                await this.setRelativeMove(value);
+                return;
         }
         // Unknown / non-writable property (incl. moving, presets) — ignored.
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camera.ui/sdk",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "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.63.0",
+    "@typescript-eslint/parser": "^8.64.0",
     "cpy-cli": "^7.0.0",
     "eslint": "9.39.2",
     "eslint-plugin-jsdoc": "^63.0.13",
@@ -48,7 +48,7 @@
     "typedoc-plugin-markdown": "^4.12.0",
     "typedoc-vitepress-theme": "^1.1.3",
     "typescript": "5.9.3",
-    "typescript-eslint": "^8.63.0",
+    "typescript-eslint": "^8.64.0",
     "vitepress": "^1.6.4",
     "vitest": "^4.1.10",
     "werift": "0.23.0",