senza-sdk 4.2.7 → 4.2.8

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.2.7",
+    "version": "4.2.8",
     "main": "./src/api.js",
     "description": "API for Senza application",
     "license": "MIT",

package/src/lifecycle.js

@@ -1,5 +1,5 @@
 import { getPlatformInfo } from "./api";
-import { getFCID, isAudioSyncEnabled, sdkLogger } from "./utils";
+import { getFCID, isAudioSyncEnabled, sdkLogger, StreamType, SwitchMode } from "./utils";
 import { sessionInfo } from "./SessionInfo";
 import { remotePlayer } from "./remotePlayer";
 
@@ -152,6 +152,35 @@ class Lifecycle extends EventTarget {
                 return Promise.resolve(false);
             }
             this._inTransition = true;
+
+            if (sessionInfo.sessionInfoObj?.settings?.["ui-streamer"]?.remotePlayerApiVersion >= 2) {
+                return new Promise((resolve, reject) => {
+                    const FCID = getFCID();
+                    const logger = sdkLogger.withFields({ FCID });
+                    logger.log("lifecycle moveToForeground: sending stop action");
+                    const message = {
+                        type: "remotePlayer.stop",
+                        class: "remotePlayer",
+                        action: "stop",
+                        streamType: isAudioSyncEnabled() ? StreamType.VIDEO | StreamType.SUBTITLE : StreamType.AUDIO | StreamType.VIDEO | StreamType.SUBTITLE
+                    };
+                    window.cefQuery({
+                        request: JSON.stringify({ target: "TC", waitForResponse: false, internalAction: "uiActive", message: JSON.stringify(message) }),
+                        persistent: false,
+                        onSuccess: () => {
+                            logger.log("stop successfully sent");
+                            this._inTransition = false;
+                            resolve(true);
+                        },
+                        onFailure: (code, msg) => {
+                            logger.error(`stop failed: ${code} ${msg}`);
+                            this._inTransition = false;
+                            reject(`stop failed: ${code} ${msg}`);
+                        }
+                    });
+                });
+            }
+
             return new Promise((resolve, reject) => {
                 const FCID = getFCID();
                 const logger = sdkLogger.withFields({ FCID });
@@ -205,8 +234,24 @@ class Lifecycle extends EventTarget {
                 const configuration = remotePlayer.getConfiguration();
                 const audioLanguage = remotePlayer._selectedAudioTrack || configuration.preferredAudioLanguage || "";
                 const subtitlesLanguage = remotePlayer._selectedSubtitlesTrack || configuration.preferredSubtitlesLanguage || "";
+                let request;
+                const message = {
+                    action: "play",
+                    fcid: FCID,
+                    audioLanguage,
+                    subtitlesLanguage
+                };
+                if (sessionInfo.sessionInfoObj?.settings?.["ui-streamer"]?.remotePlayerApiVersion >= 2) {
+                    message.type = "remotePlayer.play";
+                    message.class = "remotePlayer";
+                    message.switchMode = isAudioSyncEnabled() ? SwitchMode.SEAMLESS : SwitchMode.NON_SEAMLESS;
+                    message.streamType = StreamType.AUDIO | StreamType.VIDEO | StreamType.SUBTITLE;
+                    request = { target: "TC", waitForResponse: false, internalAction: "uiExit", message: JSON.stringify(message) };
+                } else {
+                    request = message;
+                }
                 window.cefQuery({
-                    request: JSON.stringify({ action: "play", fcid: FCID, audioLanguage, subtitlesLanguage }),
+                    request: JSON.stringify(request),
                     persistent: false,
                     onSuccess: () => {
                         logger.log("[ moveToBackground ] play successfully sent");
@@ -239,7 +284,7 @@ class Lifecycle extends EventTarget {
         if (window.cefQuery) {
             return new Promise((resolve, reject) => {
                 const FCID = getFCID();
-                const request = { target: "TC", waitForResponse: false, message: JSON.stringify({ type: "uiStandbyRequest", fcid: FCID }) };
+                const request = { target: "TC", waitForResponse: false, internalAction: "uiExit", message: JSON.stringify({ type: "uiStandbyRequest", fcid: FCID }) };
                 const logger = sdkLogger.withFields({ FCID });
                 logger.log("lifecycle moveToUiStandby: sending uiStandbyRequest");
                 window.cefQuery({

package/src/remotePlayer.js

@@ -1,8 +1,9 @@
 
-import { getFCID, isAudioSyncEnabled, sdkLogger } from "./utils";
+import { getFCID, isAudioSyncEnabled, sdkLogger, StreamType, SwitchMode } from "./utils";
 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;
@@ -128,6 +129,20 @@ class RemotePlayer extends EventTarget {
          * });
          * */
 
+        /**
+         * @event RemotePlayer#loadedmetadata
+         * @description loadedmetadata event will be dispatched when the remote player metadata is loaded
+         * and the audio/video tracks are available
+         * @example
+         * remotePlayer.addEventListener("loadedmetadata", () => {
+         *   console.info("remotePlayer loadedmetadata", remotePlayer.getAudioTracks(), remotePlayer.getTextTracks());
+         * });
+         * */
+        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));
+        });
+
         /**
          *
          * @event RemotePlayer#timeupdate
@@ -578,13 +593,19 @@ class RemotePlayer extends EventTarget {
                 const logger = sdkLogger.withFields({ FCID, loadUrl: url, playbackPosition });
                 logger.log("remotePlayer load: sending setPlayableUri request");
                 const message = {
-                    type: "setPlayableUri",
                     url,
                     timeout: this._setPlayableUriTimeout,
                     autoPlay: false,
                     playbackPosition,
                     fcid: FCID
                 };
+                if (sessionInfo.sessionInfoObj?.settings?.["ui-streamer"]?.remotePlayerApiVersion >= 2) {
+                    message.type = "remotePlayer.load";
+                    message.class = "remotePlayer";
+                    message.action = "load";
+                } else {
+                    message.type = "setPlayableUri";
+                }
                 const request = { target: "TC", waitForResponse: true, message: JSON.stringify(message) };
                 let timerId = 0;
                 const timeBeforeSendingRequest = Date.now();
@@ -745,6 +766,15 @@ class RemotePlayer extends EventTarget {
                 subtitlesLanguage,
                 playbackPosition: this.currentTime
             };
+            if (sessionInfo.sessionInfoObj?.settings?.["ui-streamer"]?.remotePlayerApiVersion >= 2) {
+                if (isAudioSyncEnabled()) {
+                    message.switchMode = SwitchMode.SEAMLESS;
+                    message.streamType = StreamType.AUDIO;
+                } else {
+                    logger.log("remotePlayer play request ignored and will be sent with the lifecycle.moveToBackground()");
+                    return Promise.resolve();
+                }
+            }
             const request = { target: "TC", waitForResponse: false, message: JSON.stringify(message) };
             return new Promise((resolve, reject) => {
                 window.cefQuery({

package/src/utils.js

@@ -94,3 +94,16 @@ export function isAudioSyncEnabled() {
     const clientUiAudioSettings = sessionInfo.sessionInfoObj?.settings?.client?.["ui_audio"];
     return clientUiAudioSettings?.enabled && clientUiAudioSettings?.from_cdn && clientUiAudioSettings?.ui_sync_enabled;
 }
+
+// These StreamType constants are used as a mask for the client to play/stop the specific types
+export const StreamType = Object.freeze({
+    NONE: 0,
+    AUDIO: 1,
+    VIDEO: 2,
+    SUBTITLE: 4
+});
+
+export const SwitchMode = Object.freeze({
+    NON_SEAMLESS: 0,
+    SEAMLESS: 1
+});