senza-sdk 4.5.4 → 4.5.5

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.5.4",
+    "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/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/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.4";
+export const version = "4.5.5";