senza-sdk 4.3.2-3c99350.0 → 4.3.2-ac89491.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.3.2-3c99350.0",
+    "version": "4.3.2-ac89491.0",
     "main": "./src/api.js",
     "description": "API for Senza application",
     "license": "MIT",

package/src/implementation/remotePlayer.js

@@ -1367,6 +1367,15 @@ class RemotePlayer extends RemotePlayerInterface {
         }
     }
 
+    /**
+     * The function sets a blackout time for the screen.
+     * The blackout time is the time when the screen will be blacked out.
+     * This is useful for parental controls where the screen should be blacked out during certain times
+     *
+     * @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 not supported
+     */
     setScreenBlackout(date) {
 
         if (!this._isInitialized) {
@@ -1382,13 +1391,21 @@ class RemotePlayer extends RemotePlayerInterface {
         }
 
         if (this._remotePlayerApiVersion < 2) {
-            throw new RemotePlayerError(6504, `setScreenBlackout is not supported in remotePlayerApiVersion=${this._remotePlayerApiVersion}. remotePlayerApiVersion >= 2 required`);
+            throw new RemotePlayerError(6504, "setScreenBlackout(): internal error");
         }
 
         const blackoutTime = (date.getTime()/1000).toFixed(2);
+        sdkLogger.info(`remotePlayer.setScreenBlackout(): setting blackout time to ${blackoutTime}`);
         return this._setScreenBlackout(blackoutTime);
     }
 
+    /**
+     * The function resets the currently set blackout time for the screen.
+     * This is useful for parental controls to be reset the blackout time after it has been set.
+     *
+     * @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 not supported
+     */
     resetScreenBlackout() {
         if (!this._isInitialized) {
             throw new RemotePlayerError(6500, "Cannot call resetScreenBlackout() if remote player is not initialized");
@@ -1399,8 +1416,9 @@ class RemotePlayer extends RemotePlayerInterface {
         }
 
         if (this._remotePlayerApiVersion < 2) {
-            throw new RemotePlayerError(6504, `resetScreenBlackout is not supported in remotePlayerApiVersion=${this._remotePlayerApiVersion}. remotePlayerApiVersion >= 2 required`);
+            throw new RemotePlayerError(6504, "resetScreenBlackout(): internal error");
         }
+        sdkLogger.info("remotePlayer.resetScreenBlackout(): resetting blackout time");
         return this._setScreenBlackout(0);
     }
 
@@ -1757,11 +1775,10 @@ class RemotePlayer extends RemotePlayerInterface {
     }
 
     _setScreenBlackout(blackoutTime) {
-        const functionName = blackoutTime === 0 ? "resetScreenBlackout" : "setScreenBlackout";
         if (window.cefQuery) {
             const FCID = getFCID();
             const logger = sdkLogger.withFields({ FCID });
-            logger.log(`remotePlayer ${functionName}: sending screenBlackout action at ${blackoutTime}`);
+            logger.log(`sending screenBlackout action at ${blackoutTime}`);
             const message = {
                 type: "remotePlayer.screenBlackout",
                 class: "remotePlayer",
@@ -1790,16 +1807,16 @@ class RemotePlayer extends RemotePlayerInterface {
                     }
                 });
 
-                logger.log(`window.cefQuery for ${functionName} returned query id ${queryId}`);
+                logger.log(`window.cefQuery for screenBlackout returned query id ${queryId}`);
                 const timeout = this._remotePlayerConfirmationTimeout + 1000;
                 timerId = setTimeout(() => {
-                    logger.log(`${functionName} reached timeout of ${timeout} ms, canceling query id ${queryId}`);
+                    logger.log(`screenBlackout reached timeout of ${timeout} ms, canceling query id ${queryId}`);
                     window.cefQueryCancel(queryId);
-                    reject(new RemotePlayerError(6000, `${functionName} reached timeout of ${timeout} ms`));
+                    reject(new RemotePlayerError(6000, `screenBlackout reached timeout of ${timeout} ms`));
                 }, timeout, queryId);
             });
         }
-        sdkLogger.error(`remotePlayer ${functionName}: window.cefQuery is undefined`);
+        sdkLogger.error("screenBlackout: window.cefQuery is undefined");
         return Promise.resolve(undefined);
     }
 }

package/src/interface/remotePlayer.js

@@ -117,7 +117,7 @@ export class RemotePlayerError extends Error {
  * | 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                                              |
+ * | 6504      | Player            | The remote player api internal error                                                            |
  * | 8001      | Player            | Error pulling manifest. bad parameters                                                          |
  * | 8002      | Player            | Error pulling manifest. filters returned no data                                                |
  * | 8003      | Player            | Error pulling manifest. fetch error                                                             |
@@ -400,19 +400,24 @@ class RemotePlayer extends EventTarget {
     }
 
     /**
-     *
+     * The function sets a blackout time for the screen.
+     * The blackout time is the time when the screen will be blacked out.
+     * This is useful for parental controls where the screen should be blacked out during certain times
+     * @alpha API has not yet been released
      * @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
+     * @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 not supported
      */
     setScreenBlackout(date) {
         return noop("RemotePlayer.setScreenBlackout", date);
     }
 
     /**
-     *
+     * The function resets the currently set blackout time for the screen.
+     * This is useful for parental controls to be reset the blackout time after it has been set.
+     * @alpha API has not yet been released
      * @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
+     * @throws {RemotePlayerError} If the player is not initialized or not loaded. if the remote player api version is not supported
      */
     resetScreenBlackout() {
         return noop("RemotePlayer.resetScreenBlackout");