senza-sdk 4.2.59 → 4.2.60

package/package.json

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

package/src/lifecycle.js

@@ -670,10 +670,10 @@ class Lifecycle extends EventTarget {
             return new Promise((resolve, reject) => {
                 const FCID = getFCID();
                 const logger = sdkLogger.withFields({ FCID });
-                logger.log("lifecycle moveToBackground: sending play action");
                 const configuration = remotePlayer.getConfiguration();
                 const audioLanguage = remotePlayer._selectedAudioTrack || configuration.preferredAudioLanguage || "";
-                const subtitlesLanguage = remotePlayer.textTrackVisibility && (remotePlayer._selectedSubtitlesTrack || configuration.preferredSubtitlesLanguage) || "";
+                const subtitlesLanguage = remotePlayer._selectedSubtitlesTrack || configuration.preferredSubtitlesLanguage || "";
+
                 let request;
                 const message = {
                     action: "play",
@@ -685,7 +685,7 @@ class Lifecycle extends EventTarget {
                     message.type = "remotePlayer.play";
                     message.class = "remotePlayer";
                     message.switchMode = remotePlayer._isAudioSyncEnabled() ? SwitchMode.SEAMLESS : SwitchMode.NON_SEAMLESS;
-                    message.streamType = StreamType.AUDIO | StreamType.VIDEO | StreamType.SUBTITLE;
+                    message.streamType = remotePlayer.textTrackVisibility ? (StreamType.AUDIO | StreamType.VIDEO | StreamType.SUBTITLE) : (StreamType.AUDIO | StreamType.VIDEO);
                     request = {
                         target: "TC",
                         waitForResponse: true,
@@ -693,8 +693,12 @@ class Lifecycle extends EventTarget {
                         message: JSON.stringify(message)
                     };
                 } else {
+                    if (!remotePlayer.textTrackVisibility) {
+                        message.subtitlesLanguage = "";
+                    }
                     request = message;
                 }
+                logger.log(`lifecycle moveToBackground: sending play action audioLanguage=${message.audioLanguage} subtitlesLanguage=${message.subtitlesLanguage} textTrackVisibility=${remotePlayer.textTrackVisibility}`);
                 let timerId = 0;
                 const timeBeforeSendingRequest = Date.now();
                 const queryId = window.cefQuery({

package/src/remotePlayer.js

@@ -495,13 +495,7 @@ class RemotePlayer extends EventTarget {
         }
         if (this._availableTextTracks) {
             const selectedTrack = this._availableTextTracks.find((track) => track.selected === true);
-            if (selectedTrack) {
-                this._selectedSubtitlesTrack = selectedTrack.id;
-                this._textTrackVisibility = true;
-            } else {
-                this._selectedSubtitlesTrack = "";
-                this._textTrackVisibility = false;
-            }
+            this._selectedSubtitlesTrack = selectedTrack?.id || "";
         }
     }
 
@@ -698,12 +692,14 @@ class RemotePlayer extends EventTarget {
         if (window.cefQuery) {
             const FCID = getFCID();
             const logger = sdkLogger.withFields({ FCID });
-            logger.log("remotePlayer play: sending play action");
             const audioLanguage = this._selectedAudioTrack || this._config.preferredAudioLanguage || "";
-            let subtitlesLanguage = "";
-            if (this._textTrackVisibility) {
-                subtitlesLanguage = this._selectedSubtitlesTrack || this._config.preferredSubtitlesLanguage || "";
+            const subtitlesLanguage = this._selectedSubtitlesTrack || this._config.preferredSubtitlesLanguage || "";
+
+            if (this._remotePlayerApiVersion >= 2 && !this._textTrackVisibility && streamType === StreamType.SUBTITLE) {
+                logger.log("remotePlayer play: text track visibility is disabled and streamType is only SUBTITLE. returning early with no action.");
+                return Promise.resolve(undefined); // nothing to do
             }
+
             const message = {
                 type: "remotePlayer.play",
                 class: "remotePlayer",
@@ -718,7 +714,16 @@ class RemotePlayer extends EventTarget {
                 message.switchMode = this._isAudioSyncEnabled() ? SwitchMode.SEAMLESS : SwitchMode.NON_SEAMLESS;
                 message.streamType = streamType;
                 waitForResponse = true;
+
+                if (!this._textTrackVisibility && (message.streamType & StreamType.SUBTITLE) !== 0) {
+                    // remove SUBTITLE
+                    message.streamType = message.streamType & ~StreamType.SUBTITLE;
+                    logger.log("remotePlayer play: text track visibility is disabled. Removed SUBTITLE from streamType.");
+                }
+            } else if (!this.textTrackVisibility) {
+                message.subtitlesLanguage = "";
             }
+            logger.log(`remotePlayer play: sending play action remotePlayer._isPlaying: ${this._isPlaying} audioLanguage=${message.audioLanguage} subtitlesLanguage=${message.subtitlesLanguage} textTrackVisibility=${this.textTrackVisibility}`);
             const request = { target: "TC", waitForResponse: waitForResponse, message: JSON.stringify(message) };
             return new Promise((resolve, reject) => {
                 let timerId = 0;
@@ -947,10 +952,7 @@ class RemotePlayer extends EventTarget {
                 const playbackPosition = position ?? 0;
                 const logger = sdkLogger.withFields({ FCID, loadUrl: url, playbackPosition });
                 const audioLanguage = audioTrackId || this._selectedAudioTrack || this._config.preferredAudioLanguage || "";
-                let subtitlesLanguage = "";
-                if (this._textTrackVisibility) {
-                    subtitlesLanguage = textTrackId || this._selectedSubtitlesTrack || this._config.preferredSubtitlesLanguage || "";
-                }
+                const subtitlesLanguage = textTrackId || this._selectedSubtitlesTrack || this._config.preferredSubtitlesLanguage || "";
 
                 const message = {
                     url,
@@ -968,7 +970,7 @@ class RemotePlayer extends EventTarget {
                 } else {
                     message.type = "setPlayableUri";
                 }
-                logger.log(`remotePlayer load: sending ${message.type} request. remotePlayer._isPlaying: ${this._isPlaying}`);
+                logger.log(`remotePlayer load: sending ${message.type} request. remotePlayer._isPlaying: ${this._isPlaying} audioLanguage=${audioLanguage} subtitlesLanguage=${subtitlesLanguage}`);
                 const request = { target: "TC", waitForResponse: true, message: JSON.stringify(message) };
                 let timerId = 0;
                 const timeBeforeSendingRequest = Date.now();
@@ -1519,20 +1521,23 @@ class RemotePlayer extends EventTarget {
     /**
      * Enable or disable the subtitles.
      * If the player is in an unloaded state, the request will be applied next time content is played.
-     * @param {boolean} visible whether the subtitles are visible or not
-     * @throws {TypeError} if visible is not a boolean variable
+     * @param {boolean|0|1} visible whether the subtitles are visible or not
+     * @throws {TypeError} if visible is not a boolean variable or 0/1
      */
     setTextTrackVisibility(visible) {
         const oldVisibility = this._textTrackVisibility;
-        if (typeof visible !== "boolean") {
-            throw new TypeError("visible parameter must be a boolean");
+        if (typeof visible !== "boolean" && !(visible === 0 || visible === 1)) {
+            throw new TypeError("visible parameter must be a boolean or 0/1");
         }
-        const newVisibility = visible;
-        if (newVisibility === oldVisibility) {
+        // Convert to boolean in case apps pass 0/1 instead false/true.
+        const newVisibility = !!visible;
+
+        if (oldVisibility === newVisibility) {
             return;
         }
+
         this._textTrackVisibility = newVisibility;
-        if (!newVisibility) {
+        if (!this._textTrackVisibility) {
             // Setting the visibility to false clears any previous selections user has done
             this._selectedSubtitlesTrack = "";
         }

package/src/senzaShakaPlayer.js

@@ -502,6 +502,8 @@ export class SenzaShakaPlayer extends shaka.Player {
      * });
      */
     configure(config) {
+        sdkLogger.log("configure player with: ", JSON.stringify(config));
+
         // Handle custom configuration
         if (config.shouldStopRemotePlayerOnError !== undefined) {
             this._shouldStopRemotePlayerOnError = !!config.shouldStopRemotePlayerOnError;
@@ -522,6 +524,7 @@ export class SenzaShakaPlayer extends shaka.Player {
             remoteConfiguration["preferredSubtitlesLanguage"] = config["preferredTextLanguage"];
         }
 
+        sdkLogger.log("configure remote player with: ", JSON.stringify(remoteConfiguration));
         remotePlayer.configure(remoteConfiguration);
     }