senza-sdk 4.3.1 → 4.3.2-f445d5d.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.3.1",
+    "version": "4.3.2-f445d5d.0",
     "main": "./src/api.js",
     "description": "API for Senza application",
     "license": "MIT",
@@ -51,9 +51,9 @@
             },
             "src/interface": {
                 "branches": 68.42,
-                "functions": 40.74,
-                "lines": 65.96,
-                "statements": 66.32
+                "functions": 40,
+                "lines": 65.28,
+                "statements": 65.65
             }
         }
     },

package/src/implementation/lifecycle.js

@@ -623,6 +623,7 @@ class Lifecycle extends LifecycleInterface {
             }
 
             // TODO: Need to discuss checking for a valid tenantId in the Senza platform
+            remotePlayer._blackoutTime = 0;
             const contentHubTenantId = getPlatformInfo().sessionInfo?.homeSessionInfo?.tenantInfo?.contentHubTenantId;
             const homeTenantId = getPlatformInfo().sessionInfo?.homeSessionInfo?.tenantId;
             sdkLogger.log(`SwitchTenant for ${tenantId}`);

package/src/implementation/remotePlayer.js

@@ -141,6 +141,13 @@ class RemotePlayer extends RemotePlayerInterface {
          */
         this._isPlaying = false;
 
+        /**
+         * @type {string}
+         * @description the last set blackout time as epoch seconds.
+         * @private
+         */
+        this._blackoutTime = 0;
+
         typeof document !== "undefined" && document.addEventListener("hs/remotePlayerEvent", (e) => {
             sdkLogger.info("Got hs/remotePlayerEvent event with detail", JSON.stringify(e?.detail));
             this.dispatchEvent(new Event(e?.detail?.eventName));
@@ -744,6 +751,7 @@ class RemotePlayer extends RemotePlayerInterface {
             this._abortSetAudioLanguage = true;
             this._abortSetSubtitleLanguage = true;
             this._abortSeeking = true;
+            this._blackoutTime = 0;
             if (reset) {
                 this._reset();
             }
@@ -1355,6 +1363,129 @@ class RemotePlayer extends RemotePlayerInterface {
         }
     }
 
+    setBlackoutTime(date) {
+
+        if (!this._isInitialized) {
+            throw new RemotePlayerError(6500, "Cannot call setBlackoutTime() if remote player is not initialized");
+        }
+
+        if (this._loadMode !== this.LoadMode.LOADED) {
+            throw new RemotePlayerError(6001, "Cannot call setBlackoutTime() if player is not loaded");
+        }
+
+        if (!(date instanceof Date)) {
+            throw new RemotePlayerError(6503, `date param must be a ${typeof new Date()} object but got ${typeof date}`);
+        }
+
+        if (this._remotePlayerApiVersion < 2) {
+            throw new RemotePlayerError(6504, `setBlackoutTime is not supported in remotePlayerApiVersion=${this._remotePlayerApiVersion}. remotePlayerApiVersion >= 2 required`);
+        }
+
+        const blackoutTime = (date.getTime()/1000).toFixed(2);
+        if (window.cefQuery) {
+            const FCID = getFCID();
+            const logger = sdkLogger.withFields({ FCID });
+            logger.log("remotePlayer setBlackoutTime: sending screenBlackout action");
+            const message = {
+                type: "remotePlayer.screenBlackout",
+                class: "remotePlayer",
+                action: "screenBlackout",
+                fcid: FCID,
+                blackoutTime
+            };
+            const request = { target: "TC", waitForResponse: true, message: JSON.stringify(message) };
+            return new Promise((resolve, reject) => {
+                let timerId = 0;
+                const timeBeforeSendingRequest = Date.now();
+                const queryId = window.cefQuery({
+                    request: JSON.stringify(request),
+                    persistent: false,
+                    onSuccess: () => {
+                        this._blackoutTime = blackoutTime;
+                        const duration = Date.now() - timeBeforeSendingRequest;
+                        logger.withFields({ duration }).log(`setBlackoutTime completed successfully after ${duration} ms`);
+                        timerId = clearTimer(timerId);
+                        resolve();
+                    },
+                    onFailure: (code, msg) => {
+                        const duration = Date.now() - timeBeforeSendingRequest;
+                        logger.withFields({ duration }).log(`setBlackoutTime failed after ${duration} ms. Error code: ${code}, error message: ${msg}`);
+                        timerId = clearTimer(timerId);
+                        reject(new RemotePlayerError(code, msg));
+                    }
+                });
+
+                logger.log(`window.cefQuery for setBlackoutTime returned query id ${queryId}`);
+                const timeout = this._remotePlayerConfirmationTimeout + 1000;
+                timerId = setTimeout(() => {
+                    logger.log(`setBlackoutTime reached timeout of ${timeout} ms, canceling query id ${queryId}`);
+                    window.cefQueryCancel(queryId);
+                    reject(new RemotePlayerError(6000, `setBlackoutTime reached timeout of ${timeout} ms`));
+                }, timeout, queryId);
+            });
+        }
+        sdkLogger.error("remotePlayer setBlackoutTime: window.cefQuery is undefined");
+        return Promise.resolve(undefined);
+    }
+
+    resetBlackoutTime() {
+        if (!this._isInitialized) {
+            throw new RemotePlayerError(6500, "Cannot call resetBlackoutTime() if remote player is not initialized");
+        }
+
+        if (this._loadMode !== this.LoadMode.LOADED) {
+            throw new RemotePlayerError(6001, "Cannot call resetBlackoutTime() if player is not loaded");
+        }
+
+        if (this._remotePlayerApiVersion < 2) {
+            throw new RemotePlayerError(6504, `resetBlackoutTime is not supported in remotePlayerApiVersion=${this._remotePlayerApiVersion}. remotePlayerApiVersion >= 2 required`);
+        }
+
+        if (window.cefQuery) {
+            const FCID = getFCID();
+            const logger = sdkLogger.withFields({ FCID });
+            logger.log("remotePlayer resetBlackoutTime: sending screenBlackout action");
+            const message = {
+                type: "remotePlayer.screenBlackout",
+                class: "remotePlayer",
+                action: "screenBlackout",
+                fcid: FCID,
+                blackoutTime: 0 // Resetting the blackout time
+            };
+            const request = { target: "TC", waitForResponse: true, message: JSON.stringify(message) };
+            return new Promise((resolve, reject) => {
+                let timerId = 0;
+                const timeBeforeSendingRequest = Date.now();
+                const queryId = window.cefQuery({
+                    request: JSON.stringify(request),
+                    persistent: false,
+                    onSuccess: () => {
+                        this._blackoutTime = 0; // Resetting the blackout time
+                        const duration = Date.now() - timeBeforeSendingRequest;
+                        logger.withFields({ duration }).log(`resetBlackoutTime completed successfully after ${duration} ms`);
+                        timerId = clearTimer(timerId);
+                        resolve();
+                    },
+                    onFailure: (code, msg) => {
+                        const duration = Date.now() - timeBeforeSendingRequest;
+                        logger.withFields({ duration }).log(`resetBlackoutTime failed after ${duration} ms. Error code: ${code}, error message: ${msg}`);
+                        timerId = clearTimer(timerId);
+                        reject(new RemotePlayerError(code, msg));
+                    }
+                });
+                logger.log(`window.cefQuery for resetBlackoutTime returned query id ${queryId}`);
+                const timeout = this._remotePlayerConfirmationTimeout + 1000;
+                timerId = setTimeout(() => {
+                    logger.log(`resetBlackoutTime reached timeout of ${timeout} ms, canceling query id ${queryId}`);
+                    window.cefQueryCancel(queryId);
+                    reject(new RemotePlayerError(6000, `resetBlackoutTime reached timeout of ${timeout} ms`));
+                }, timeout, queryId);
+            });
+        }
+        sdkLogger.error("remotePlayer resetBlackoutTime: window.cefQuery is undefined");
+        return Promise.resolve(undefined);
+    }
+
     /**
      * Getter/Setter for currentTime
      */

package/src/interface/remotePlayer.js

@@ -116,6 +116,8 @@ export class RemotePlayerError extends Error {
  * | 6500      | Player            | remotePlayer api was called before initializing remotePlayer                                    |
  * | 6501      | Player            | load() was called while previous load/unload was still in progress                              |
  * | 6502      | Player            | unload() was called while previous unload/load was still in progress                            |
+ * | 6503      | Player            | The remote player api call has invalid parameters                                               |
+ * | 6504      | Player            | The remote player api call has invalid api version                                              |
  * | 8001      | Player            | Error pulling manifest. bad parameters                                                          |
  * | 8002      | Player            | Error pulling manifest. filters returned no data                                                |
  * | 8003      | Player            | Error pulling manifest. fetch error                                                             |
@@ -397,6 +399,25 @@ class RemotePlayer extends EventTarget {
         return noop("RemotePlayer.setTextTrackVisibility", visible);
     }
 
+    /**
+     *
+     * @param {Date} date
+     * @returns {Promise<void>} A Promise that resolves once the blackout time is set.
+     * @throws {RemotePlayerError} If the player is not initialized or not loaded. if date is not a Date object or if the remote player api version is less than 2
+     */
+    setBlackoutTime(date) {
+        return noop("RemotePlayer.setBlackoutTime", date);
+    }
+
+    /**
+     *
+     * @returns {Promise<void>} A Promise that resolves once the blackout time is reset.
+     * @throws {RemotePlayerError} If the player is not initialized or not loaded. if the remote player api version is less than 2
+     */
+    resetBlackoutTime() {
+        return noop("RemotePlayer.resetBlackoutTime");
+    }
+
     /**
      * Getter/Setter for currentTime
      */