senza-sdk 4.5.3 → 4.5.5

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.5.3",
+    "version": "4.5.5",
     "main": "./src/api.js",
     "description": "API for Senza application",
     "license": "MIT",
@@ -29,12 +29,12 @@
         "@babel/preset-env": "^7.22.0",
         "@eslint/eslintrc": "^3.3.0",
         "@eslint/js": "^9.22.0",
-        "babel-jest": "^30.2.0",
+        "babel-jest": "^30.4.1",
         "eslint": "^9.22.0",
         "eslint-plugin-jest": "^28.11.0",
         "globals": "^16.0.0",
-        "jest": "^30.2.0",
-        "jest-environment-jsdom": "^30.2.0",
+        "jest": "^30.4.2",
+        "jest-environment-jsdom": "^30.4.1",
         "jsdoc-to-markdown": "^7.1.1",
         "webpack": "^5.72.1",
         "webpack-cli": "^5.1.4"
@@ -55,9 +55,9 @@
             },
             "src/interface": {
                 "branches": 64,
-                "functions": 39.23,
+                "functions": 38,
                 "lines": 63,
-                "statements": 64
+                "statements": 63
             }
         }
     },

package/src/implementation/alarmManager.js

@@ -1,5 +1,5 @@
 import { AlarmManager as AlarmManagerInterface } from "../interface/alarmManager.js";
-import { getFCID, sdkLogger } from "./utils.js";
+import { areAlarmsEnabled, getFCID, sdkLogger } from "./utils.js";
 import { EventListenersManager } from "./eventListenersManager.js";
 import { lifecycle } from "./lifecycle.js";
 import { bus, Events } from "./eventBus";
@@ -137,8 +137,13 @@ class AlarmManager extends AlarmManagerInterface {
             throw Error("data must be a string");
         }
         const FCID = getFCID();
-        const logger = sdkLogger.withFields({ alarmName, FCID });
-        logger.log(`addAlarm called for ${alarmName} to be fired at ${alarmTime} with tolerance of ${toleranceBefore} minutes before and ${toleranceAfter} minutes after`);
+        const alarmsEnabled = areAlarmsEnabled();
+        const logger = sdkLogger.withFields({ alarmName, FCID, alarmsEnabled });
+        logger.log(`addAlarm called for ${alarmName} to be fired at ${alarmTime} with tolerance of ${toleranceBefore} minutes before and ${toleranceAfter} minutes after. alarmsEnabled=${alarmsEnabled}`);
+        if (!alarmsEnabled) {
+            logger.log("addAlarm is disabled by ui-streamer disableAlarms setting; alarm request will not be sent");
+            return;
+        }
         if (window.cefQuery) {
             const message = {
                 type: "addAlarm",

package/src/implementation/overlay.js

@@ -22,6 +22,8 @@ const OVERLAY_CAPTURE_PRESETS = {
 
 const DEFAULT_CAPTURE_PRESET = "default";
 const VALID_QUALITIES = new Set(["low", "mid", "high"]);
+const DEFAULT_AUTO_HIDE_DURATION_SEC = 600;
+const OVERLAY_DURATION_SEC_MAX = 65535;
 
 class Overlay extends OverlayInterface {
     constructor() {
@@ -31,7 +33,8 @@ class Overlay extends OverlayInterface {
         this._configuration = {
             useTransparency: true,
             overlayCapturePreset: DEFAULT_CAPTURE_PRESET,
-            overlayCapturePlan: null
+            overlayCapturePlan: null,
+            autoHideDurationSec: DEFAULT_AUTO_HIDE_DURATION_SEC
         };
         this._activeCapturePlan = OVERLAY_CAPTURE_PRESETS[DEFAULT_CAPTURE_PRESET];
         this._retryGeneration = 0;
@@ -138,6 +141,7 @@ class Overlay extends OverlayInterface {
                     quality,
                     conditional
                 };
+                message.overlayDurationSec = this._configuration.autoHideDurationSec;
                 sdkLogger.log(`Overlay: rendering frame x=${x} y=${y} width=${width} height=${height} fcid=${FCID} (batchId=${batchId}, quality=${quality}, conditional=${conditional})`);
                 const request = { target: "UI-Streamer", waitForResponse: false, message: JSON.stringify(message) };
                 window.cefQuery({
@@ -226,6 +230,16 @@ class Overlay extends OverlayInterface {
             }
         }
 
+        if (Object.prototype.hasOwnProperty.call(normalizedConfiguration, "autoHideDurationSec")) {
+            const duration = normalizedConfiguration.autoHideDurationSec;
+            if (Number.isInteger(duration) && duration >= 0 && duration <= OVERLAY_DURATION_SEC_MAX) {
+                normalizedConfiguration.autoHideDurationSec = duration;
+            } else {
+                sdkLogger.warn(`Overlay: invalid autoHideDurationSec "${duration}", keeping previous value`);
+                delete normalizedConfiguration.autoHideDurationSec;
+            }
+        }
+
         this._configuration = { ...this._configuration, ...normalizedConfiguration };
         this._activeCapturePlan = this._resolveCapturePlan();
     }

package/src/implementation/remotePlayer.js

@@ -3,6 +3,7 @@ import { RemotePlayer as RemotePlayerInterface, RemotePlayerError as RemotePlaye
 import {
     getFCID,
     generatePlaybackId,
+    getRestResponse,
     isAudioSyncConfigured,
     clearTimer,
     sdkLogger,
@@ -1133,6 +1134,29 @@ class RemotePlayer extends RemotePlayerInterface {
         return this._loadMode;
     }
 
+    /** Get the playback position directly from the connector.
+     * @returns {Promise<number|undefined>} current playback position
+     * @throws {RemotePlayerError} error object contains code & msg
+     */
+    async getPlaybackPosition() {
+        if (!this._isInitialized) {
+            throw new RemotePlayerError(6500, "Cannot call getPlaybackPosition() if remote player is not initialized");
+        }
+        if (this._loadMode !== this.LoadMode.LOADED) {
+            throw new RemotePlayerError(6001, "Cannot call getPlaybackPosition() if player is not loaded");
+        }
+
+        try {
+            const response = await getRestResponse("playback-position");
+            const { currentVideoPosition } = JSON.parse(response || "{}");
+            return currentVideoPosition;
+        } catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            sdkLogger.error(`remotePlayer getPlaybackPosition failed: ${message}`);
+            throw new RemotePlayerError(6504, `getPlaybackPosition() failed: ${message}`);
+        }
+    }
+
     /**
     * @typedef {Object} TextTrack
     * @property {string} id - A unique ID for the track.

package/src/implementation/utils.js

@@ -143,6 +143,11 @@ export function isAudioSyncConfigured() {
 export function isSubtitlesTranslationAllowed() {
     return sessionInfo.sessionInfoObj?.settings?.["ui-streamer"]?.allowSubtitlesTranslation === true;
 }
+
+export function areAlarmsEnabled() {
+    return sessionInfo.sessionInfoObj?.settings?.["ui-streamer"]?.disableAlarms !== true;
+}
+
 export function isSubtitlesTranslationPattern(lang) {
     // This language pattern such as "*:eng" indicates to cloud components to translate subtitles to eng
     return (lang?.toString() || "").startsWith("*:");

package/src/interface/overlay.js

@@ -59,8 +59,8 @@ class Overlay extends EventTarget {
     }
 
     /**
-     * Removes all registered elements, sends a zero-dimension frame to the UI-Streamer,
-     * and deactivates the overlay. After calling removeAllElements(), a new element can be registered.
+     * Removes all registered elements and deactivates the overlay.
+     * After calling removeAllElements(), a new element can be registered.
      *
      * @returns {Promise<boolean>} Resolves to true if successful, rejects with error if failed.
      */
@@ -82,7 +82,7 @@ class Overlay extends EventTarget {
      *
      * @param {Object} configuration - The new configuration to apply.
      * @param {boolean} [configuration.useTransparency=true] - Controls whether the overlay should be rendered with transparency.
-     * When set to `true`, the value is forwarded to UI-Streamer in `displayOverlay` requests.
+     * When set to `true`, the overlay is rendered with transparency.
      * @param {string} [configuration.overlayCapturePreset="default"] - Named capture plan preset:
      * `default` (progressive low→high captures) or `once` (one immediate high-quality conditional step).
      * @param {Array<{quality: "low"|"mid"|"high", conditional: boolean, delay: number}>} [configuration.overlayCapturePlan]
@@ -90,6 +90,9 @@ class Overlay extends EventTarget {
      * the previous step in the batch. Set `conditional` per step (the SDK does not derive it):
      * when `true`, capture only if overlay content changed since the last required (non-conditional)
      * capture in this batch; when `false`, always capture on that step.
+     * @param {number} [configuration.autoHideDurationSec=600] - Client auto-hide duration in seconds.
+     * Defaults to `600` (10 minutes) until configured. Omit the key to keep the current value.
+     * `0` means never auto-hide. Valid range: `0`–`65535`.
      */
     configure(configuration) {
         noop(configuration);

package/src/interface/remotePlayer.js

@@ -357,6 +357,14 @@ class RemotePlayer extends EventTarget {
         return this.LoadMode.NOT_LOADED;
     }
 
+    /** Get the playback position directly from the connector. Note that this function can load the system. It is recommended to use it when accurate time is needed and currentTime can not be used.
+     * @returns {Promise<number|undefined>} current playback position
+     * @throws {RemotePlayerError} error object contains code & msg
+     */
+    async getPlaybackPosition() {
+        return 0;
+    }
+
 
     /**
     * @typedef {Object} TextTrack
@@ -481,7 +489,7 @@ class RemotePlayer extends EventTarget {
     }
 
     /**
-     * Getter/Setter for currentTime
+     * Getter/Setter for currentTime. Current time can be used to get the current playback position in specific use cases like loading from suspend mode or after a key press.
      */
     get currentTime() {
         return 0;

package/src/interface/version.js

@@ -1 +1 @@
-export const version = "4.5.3";
+export const version = "4.5.5";