senza-sdk 4.2.17 → 4.2.18

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.2.17",
+    "version": "4.2.18",
     "main": "./src/api.js",
     "description": "API for Senza application",
     "license": "MIT",
@@ -48,4 +48,4 @@
     "dependencies": {
         "shaka-player": "^4.12.5"
     }
-}
+}

package/src/lifecycle.js

@@ -1,7 +1,7 @@
 import { alarmManager, getPlatformInfo } from "./api";
 import { getFCID, isAudioSyncEnabled, clearTimer, sdkLogger, StreamType, SwitchMode, SenzaError } from "./utils";
 import { sessionInfo } from "./SessionInfo";
-import { DEFAULT_PLAY_TIMEOUT, DEFAULT_STOP_TIMEOUT, remotePlayer } from "./remotePlayer";
+import { DEFAULT_REMOTE_PLAYER_CONFIRMATION_TIMEOUT, remotePlayer } from "./remotePlayer";
 
 /**
   * Lifecycle is a singleton class that manages the application lifecycle states.<br>
@@ -117,8 +117,7 @@ class Lifecycle extends EventTarget {
                 });
             });
             this._isInitialized = true;
-            this._playTimeout = uiStreamerSettings?.playTimeout ?? DEFAULT_PLAY_TIMEOUT;
-            this._stopTimeout = uiStreamerSettings?.stopTimeout ?? DEFAULT_STOP_TIMEOUT;
+            this._remotePlayerConfirmationTimeout = uiStreamerSettings?.remotePlayerConfirmationTimeout ?? DEFAULT_REMOTE_PLAYER_CONFIRMATION_TIMEOUT;
         }
     }
 
@@ -270,7 +269,7 @@ class Lifecycle extends EventTarget {
                         }
                     });
                     logger.log(`window.cefQuery for stop returned query id ${queryId}`);
-                    const stopTimeout = this._stopTimeout + 1000;
+                    const stopTimeout = this._remotePlayerConfirmationTimeout + 1000;
                     timerId = setTimeout(() => {
                         logger.log(`stop reached timeout of ${stopTimeout} ms, canceling query id ${queryId}`);
                         this._inTransition = false;
@@ -375,7 +374,7 @@ class Lifecycle extends EventTarget {
                 });
                 if (sessionInfo.sessionInfoObj?.settings?.["ui-streamer"]?.remotePlayerApiVersion >= 2) {
                     logger.log(`window.cefQuery for play returned query id ${queryId}`);
-                    const playTimeout = this._playTimeout + 1000;
+                    const playTimeout = this._remotePlayerConfirmationTimeout + 1000;
                     timerId = setTimeout(() => {
                         logger.log(`play reached timeout of ${playTimeout} ms, canceling query id ${queryId}`);
                         this._inTransition = false;

package/src/remotePlayer.js

@@ -3,13 +3,11 @@ import { getFCID, isAudioSyncEnabled, clearTimer, sdkLogger, StreamType, SwitchM
 import { lifecycle } from "./lifecycle";
 import { writeLicenseResponse } from "./api";
 import { mergeAutoTranslationLanguages } from "./subtitlesUtils";
-import { sessionInfo } from "./SessionInfo";
 
 const INVALID_SET_PLAYABLE_URI_CODE = 99;
-const DEFAULT_SET_PLAYABLE_URI_TIMEOUT = 5000;
-const DEFAULT_UNLOAD_TIMEOUT = 5000;
-export const DEFAULT_PLAY_TIMEOUT = 5000;
-export const DEFAULT_STOP_TIMEOUT = 5000;
+
+// Default timeout for waiting for the remote player confirmation
+export const DEFAULT_REMOTE_PLAYER_CONFIRMATION_TIMEOUT = 5000;
 
 const cloneDeep = (element) => {
     return JSON.parse(JSON.stringify(element));
@@ -413,10 +411,9 @@ class RemotePlayer extends EventTarget {
         this._loadMode = playerState?.isLoaded ? this.LoadMode.LOADED : this.LoadMode.NOT_LOADED;
         this._loadedUrl = playerState?.playbackUrl || "";
         this._isInitialized = true;
-        this._setPlayableUriTimeout = uiStreamerSettings?.setPlayableUriTimeout ?? DEFAULT_SET_PLAYABLE_URI_TIMEOUT;
-        this._unloadTimeout = uiStreamerSettings?.unloadTimeout ?? DEFAULT_UNLOAD_TIMEOUT;
-        this._playTimeout = uiStreamerSettings?.playTimeout ?? DEFAULT_PLAY_TIMEOUT;
+        this._remotePlayerConfirmationTimeout = uiStreamerSettings?.remotePlayerConfirmationTimeout ?? DEFAULT_REMOTE_PLAYER_CONFIRMATION_TIMEOUT;
         this._requestVideoFrameInfo = uiStreamerSettings?.requestVideoFrameInfo ?? true;
+        this._remotePlayerApiVersion = uiStreamerSettings?.remotePlayerApiVersion || 1;
 
         let playbackMetadata = {};
         try {
@@ -628,7 +625,7 @@ class RemotePlayer extends EventTarget {
                     playbackPosition,
                     fcid: FCID
                 };
-                if (sessionInfo.sessionInfoObj?.settings?.["ui-streamer"]?.remotePlayerApiVersion >= 2) {
+                if (this._remotePlayerApiVersion >= 2) {
                     message.type = "remotePlayer.load";
                     message.class = "remotePlayer";
                     message.action = "load";
@@ -668,7 +665,7 @@ class RemotePlayer extends EventTarget {
                     }
                 });
                 logger.log(`window.cefQuery for setPlayableUri returned query id ${queryId}`);
-                const loadTimeout = this._setPlayableUriTimeout + 1000;
+                const loadTimeout = this._remotePlayerConfirmationTimeout + 1000;
                 timerId = setTimeout(() => {
                     logger.log(`setPlayableUri reached timeout of ${loadTimeout} ms, canceling query id ${queryId}`);
                     window.cefQueryCancel(queryId);
@@ -733,7 +730,7 @@ class RemotePlayer extends EventTarget {
                     }
                 });
                 logger.log(`window.cefQuery for unload returned query id ${queryId}`);
-                const unLoadTimeout = this._unloadTimeout + 1000;
+                const unLoadTimeout = this._remotePlayerConfirmationTimeout + 1000;
                 timerId = setTimeout(() => {
                     logger.log(`unload reached timeout of ${unLoadTimeout} ms, canceling query id ${queryId}`);
                     window.cefQueryCancel(queryId);
@@ -784,7 +781,7 @@ class RemotePlayer extends EventTarget {
                 playbackPosition: this.currentTime
             };
             let waitForResponse = false;
-            if (sessionInfo.sessionInfoObj?.settings?.["ui-streamer"]?.remotePlayerApiVersion >= 2) {
+            if (this._remotePlayerApiVersion >= 2) {
                 if (isAudioSyncEnabled()) {
                     message.switchMode = SwitchMode.SEAMLESS;
                     message.streamType = StreamType.AUDIO;
@@ -816,7 +813,7 @@ class RemotePlayer extends EventTarget {
                 });
                 logger.log(`window.cefQuery for play returned query id ${queryId}`);
                 if (waitForResponse) {
-                    const playTimeout = this._playTimeout + 1000;
+                    const playTimeout = this._remotePlayerConfirmationTimeout + 1000;
                     timerId = setTimeout(() => {
                         logger.log(`play reached timeout of ${playTimeout} ms, canceling query id ${queryId}`);
                         window.cefQueryCancel(queryId);
@@ -829,7 +826,10 @@ class RemotePlayer extends EventTarget {
         return Promise.resolve(undefined);
     }
 
-    /** pauses the currently playing audio or video
+    /** Pauses the currently playing audio or video
+     * When pausing in background, it will pause all streams (audio, video, subtitles) to support pausing in background.
+     * When pausing in foreground, if audio in ui enabled, it will only pause audio stream.
+     * When pausing in foreground, if audio is not enabled, remote player is not playing and therefore no call is sent.
      * @returns {Promise}
      * @throws {RemotePlayerError} error object contains code & msg
      *
@@ -842,6 +842,11 @@ class RemotePlayer extends EventTarget {
             if (this._loadMode !== this.LoadMode.LOADED) {
                 throw new RemotePlayerError(6001, "Cannot call pause() if player is not loaded");
             }
+            const isForegroundState = lifecycle.state === lifecycle.UiState.FOREGROUND || lifecycle.state === lifecycle.UiState.IN_TRANSITION_TO_FOREGROUND;
+            if (this._remotePlayerApiVersion >= 2 && !isAudioSyncEnabled() && isForegroundState) {
+                sdkLogger.info("remotePlayer pause: application in foreground, remote player is not playing.");
+                return Promise.resolve();
+            }
             const FCID = getFCID();
             const logger = sdkLogger.withFields({ FCID });
             logger.log("remotePlayer pause: sending pause request");
@@ -851,20 +856,39 @@ class RemotePlayer extends EventTarget {
                 action: "pause",
                 fcid: FCID
             };
-            const request = { target: "TC", waitForResponse: false, message: JSON.stringify(message) };
+            if (this._remotePlayerApiVersion >= 2) {
+                message.streamType = isAudioSyncEnabled() && isForegroundState ? StreamType.AUDIO : StreamType.AUDIO | StreamType.VIDEO | StreamType.SUBTITLE;
+            }
+            const waitForResponse = this._remotePlayerApiVersion >= 2;
+            const request = { target: "TC", waitForResponse: waitForResponse, message: JSON.stringify(message) };
             return new Promise((resolve, reject) => {
-                window.cefQuery({
+                let timerId = 0;
+                const timeBeforeSendingRequest = Date.now();
+                const queryId = window.cefQuery({
                     request: JSON.stringify(request),
                     persistent: false,
                     onSuccess: () => {
-                        logger.log("remotePlayer pause request successfully sent");
+                        const duration = Date.now() - timeBeforeSendingRequest;
+                        logger.withFields({ duration }).log(`pause completed successfully after ${duration} ms`);
+                        timerId = clearTimer(timerId);
                         resolve();
                     },
                     onFailure: (code, msg) => {
-                        logger.error(`remotePlayer pause request failed: ${code} ${msg}`);
+                        const duration = Date.now() - timeBeforeSendingRequest;
+                        logger.withFields({ duration }).log(`pause failed after ${duration} ms. Error code: ${code}, error message: ${msg}`);
+                        timerId = clearTimer(timerId);
                         reject(new RemotePlayerError(code, msg));
                     }
                 });
+                logger.log(`window.cefQuery for pause returned query id ${queryId}`);
+                if (waitForResponse) {
+                    const timeout = this._remotePlayerConfirmationTimeout + 1000;
+                    timerId = setTimeout(() => {
+                        logger.log(`pause reached timeout of ${timeout} ms, canceling query id ${queryId}`);
+                        window.cefQueryCancel(queryId);
+                        reject(new RemotePlayerError(6000, `pause reached timeout of ${timeout} ms`));
+                    }, timeout, queryId);
+                }
             });
         }
         sdkLogger.error("remotePlayer pause: window.cefQuery is undefined");