senza-sdk 4.2.59-c9128b1.0 → 4.2.59

package/package.json

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

package/src/deviceManager.js

@@ -85,7 +85,7 @@ class DeviceManager extends EventTarget {
                 connectionId: sessionInfoObj.connectionId,
                 community: sessionInfoObj.community,
                 tenant: sessionInfoObj.tenant,
-                clientIp: sessionInfoObj.clientIp,
+                clientIp: sessionInfoObj?.settings?.["ui-streamer"]?.clientIpOverride || sessionInfoObj.clientIp,
                 countryCode: sessionInfoObj.general?.location?.["x-country-code"],
                 connectionType: (!sessionInfoObj.connectionType || sessionInfoObj.connectionType === "direct") ? "device" : sessionInfoObj.connectionType
             };

package/src/lifecycle.js

@@ -136,7 +136,7 @@ class Lifecycle extends EventTarget {
             const event = new Event("onstatechange");
             event.state = e.detail;
             this._state = event.state;
-            if (this._autoBackground && this.state === this.UiState.FOREGROUND) {
+            if (this._isAutoBackgroundEnabled() && this.state === this.UiState.FOREGROUND) {
                 this._startCountdown();
             }
             this.dispatchEvent(event);
@@ -160,7 +160,7 @@ class Lifecycle extends EventTarget {
         });
 
         typeof document !== "undefined" && document.addEventListener("keydown", () => {
-            if (this._autoBackground) {
+            if (this._isAutoBackgroundEnabled()) {
                 if (this.state === this.UiState.BACKGROUND ||
                     this.state === this.UiState.IN_TRANSITION_TO_BACKGROUND) {
                     this.moveToForeground();
@@ -172,7 +172,7 @@ class Lifecycle extends EventTarget {
 
         // Add playModeChange listener
         remotePlayer.addEventListener("playModeChange", (event) => {
-            if (this._autoBackground && this.state === this.UiState.FOREGROUND) {
+            if (this._isAutoBackgroundEnabled() && this.state === this.UiState.FOREGROUND) {
                 sdkLogger.log("Resetting auto background timer due to play mode change", event.detail.isPlaying);
                 this._startCountdown(event.detail.isPlaying);
             }
@@ -264,6 +264,11 @@ class Lifecycle extends EventTarget {
 
             // Apply autoBackground settings if provided
             if (uiStreamerSettings?.autoBackground) {
+                // Overrides stored before any auto background settings are applied
+                if (uiStreamerSettings.autoBackground.overrides) {
+                    this._autoBackgroundOverrides = uiStreamerSettings.autoBackground.overrides;
+                    sdkLogger.warn(`Using overrides for autoBackground settings: ${JSON.stringify(this._autoBackgroundOverrides)}`);
+                }
                 this.configure({
                     autoBackground: uiStreamerSettings.autoBackground
                 });
@@ -271,6 +276,35 @@ class Lifecycle extends EventTarget {
         }
     }
 
+    /** @private Checks if auto background is enabled including overrides.
+     * @returns {boolean}
+     */
+    _isAutoBackgroundEnabled() {
+        return this._autoBackgroundOverrides?.enabled ?? this._autoBackground;
+    }
+
+    /** @private Gets the auto background video delay including overrides.
+     * @returns {number}
+     */
+    _getAutoBackgroundOnVideoDelay() {
+        const playing = this._autoBackgroundOverrides?.timeout?.playing;
+        if (playing !== undefined) {
+            return playing === false ? -1 : playing;
+        }
+        return this._autoBackgroundOnVideoDelay;
+    }
+
+    /** @private Gets the auto background UI delay including overrides.
+     * @returns {number}
+     */
+    _getAutoBackgroundOnUIDelay() {
+        const idle = this._autoBackgroundOverrides?.timeout?.idle;
+        if (idle !== undefined) {
+            return idle === false ? -1 : idle;
+        }
+        return this._autoBackgroundOnUIDelay;
+    }
+
     /**
      * Configure lifecycle settings
      * @param {Object} config - Configuration object
@@ -309,8 +343,9 @@ class Lifecycle extends EventTarget {
                     }
                 }
             }
+
             // Start or stop countdown based on new configuration
-            if (this._autoBackground) {
+            if (this._isAutoBackgroundEnabled()) {
                 this._startCountdown();
             } else {
                 this._stopCountdown();
@@ -419,7 +454,7 @@ class Lifecycle extends EventTarget {
      */
     set autoBackground(enabled) {
         this._autoBackground = enabled;
-        if (enabled) {
+        if (this._isAutoBackgroundEnabled()) {
             this._startCountdown();
         } else {
             this._stopCountdown();
@@ -440,8 +475,7 @@ class Lifecycle extends EventTarget {
      */
     set autoBackgroundDelay(delay) {
         this._autoBackgroundOnVideoDelay = delay;
-
-        if (this.autoBackground && remotePlayer._isPlaying) {
+        if (this._isAutoBackgroundEnabled() && remotePlayer._isPlaying) {
             this._startCountdown();
         }
     }
@@ -460,8 +494,7 @@ class Lifecycle extends EventTarget {
      */
     set autoBackgroundOnUIDelay(delay) {
         this._autoBackgroundOnUIDelay = delay;
-
-        if (this.autoBackground && !remotePlayer._isPlaying) {
+        if (this._isAutoBackgroundEnabled() && !remotePlayer._isPlaying) {
             this._startCountdown();
         }
     }
@@ -476,7 +509,7 @@ class Lifecycle extends EventTarget {
     _startCountdown(isPlaying = remotePlayer._isPlaying) {
         this._stopCountdown();
 
-        const timeoutDelay = isPlaying ? this._autoBackgroundOnVideoDelay : this._autoBackgroundOnUIDelay;
+        const timeoutDelay = isPlaying ? this._getAutoBackgroundOnVideoDelay() : this._getAutoBackgroundOnUIDelay();
 
         // Only start countdown if delay is positive
         if (timeoutDelay > 0) {
@@ -637,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._selectedSubtitlesTrack || configuration.preferredSubtitlesLanguage || "";
-
+                const subtitlesLanguage = remotePlayer.textTrackVisibility && (remotePlayer._selectedSubtitlesTrack || configuration.preferredSubtitlesLanguage) || "";
                 let request;
                 const message = {
                     action: "play",
@@ -652,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 = remotePlayer.textTrackVisibility ? (StreamType.AUDIO | StreamType.VIDEO | StreamType.SUBTITLE) : (StreamType.AUDIO | StreamType.VIDEO);
+                    message.streamType = StreamType.AUDIO | StreamType.VIDEO | StreamType.SUBTITLE;
                     request = {
                         target: "TC",
                         waitForResponse: true,
@@ -660,12 +693,8 @@ 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,7 +495,13 @@ class RemotePlayer extends EventTarget {
         }
         if (this._availableTextTracks) {
             const selectedTrack = this._availableTextTracks.find((track) => track.selected === true);
-            this._selectedSubtitlesTrack = selectedTrack?.id || "";
+            if (selectedTrack) {
+                this._selectedSubtitlesTrack = selectedTrack.id;
+                this._textTrackVisibility = true;
+            } else {
+                this._selectedSubtitlesTrack = "";
+                this._textTrackVisibility = false;
+            }
         }
     }
 
@@ -692,9 +698,12 @@ 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 || "";
-            const subtitlesLanguage = this._selectedSubtitlesTrack || this._config.preferredSubtitlesLanguage || "";
-
+            let subtitlesLanguage = "";
+            if (this._textTrackVisibility) {
+                subtitlesLanguage = this._selectedSubtitlesTrack || this._config.preferredSubtitlesLanguage || "";
+            }
             const message = {
                 type: "remotePlayer.play",
                 class: "remotePlayer",
@@ -709,23 +718,7 @@ class RemotePlayer extends EventTarget {
                 message.switchMode = this._isAudioSyncEnabled() ? SwitchMode.SEAMLESS : SwitchMode.NON_SEAMLESS;
                 message.streamType = streamType;
                 waitForResponse = true;
-
-                if (!this._textTrackVisibility) {
-                    const onlySubtitle = message.streamType === StreamType.SUBTITLE;
-                    if (onlySubtitle) {
-                        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
-                    }
-                    if (message.streamType && StreamType.SUBTITLE) {
-                        // 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;
@@ -954,7 +947,10 @@ class RemotePlayer extends EventTarget {
                 const playbackPosition = position ?? 0;
                 const logger = sdkLogger.withFields({ FCID, loadUrl: url, playbackPosition });
                 const audioLanguage = audioTrackId || this._selectedAudioTrack || this._config.preferredAudioLanguage || "";
-                const subtitlesLanguage = textTrackId || this._selectedSubtitlesTrack || this._config.preferredSubtitlesLanguage || "";
+                let subtitlesLanguage = "";
+                if (this._textTrackVisibility) {
+                    subtitlesLanguage = textTrackId || this._selectedSubtitlesTrack || this._config.preferredSubtitlesLanguage || "";
+                }
 
                 const message = {
                     url,
@@ -972,7 +968,7 @@ class RemotePlayer extends EventTarget {
                 } else {
                     message.type = "setPlayableUri";
                 }
-                logger.log(`remotePlayer load: sending ${message.type} request. remotePlayer._isPlaying: ${this._isPlaying} audioLanguage=${audioLanguage} subtitlesLanguage=${subtitlesLanguage}`);
+                logger.log(`remotePlayer load: sending ${message.type} request. remotePlayer._isPlaying: ${this._isPlaying}`);
                 const request = { target: "TC", waitForResponse: true, message: JSON.stringify(message) };
                 let timerId = 0;
                 const timeBeforeSendingRequest = Date.now();
@@ -1523,23 +1519,20 @@ 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|0|1} visible whether the subtitles are visible or not
-     * @throws {TypeError} if visible is not a boolean variable or 0/1
+     * @param {boolean} visible whether the subtitles are visible or not
+     * @throws {TypeError} if visible is not a boolean variable
      */
     setTextTrackVisibility(visible) {
         const oldVisibility = this._textTrackVisibility;
-        if (typeof visible !== "boolean" && !(visible === 0 || visible === 1)) {
-            throw new TypeError("visible parameter must be a boolean or 0/1");
+        if (typeof visible !== "boolean") {
+            throw new TypeError("visible parameter must be a boolean");
         }
-        // Convert to boolean in case apps pass 0/1 instead false/true.
-        const newVisibility = !!visible;
-
-        if (oldVisibility === newVisibility) {
+        const newVisibility = visible;
+        if (newVisibility === oldVisibility) {
             return;
         }
-
         this._textTrackVisibility = newVisibility;
-        if (!this._textTrackVisibility) {
+        if (!newVisibility) {
             // Setting the visibility to false clears any previous selections user has done
             this._selectedSubtitlesTrack = "";
         }

package/src/senzaShakaPlayer.js

@@ -502,8 +502,6 @@ 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;
@@ -524,7 +522,6 @@ export class SenzaShakaPlayer extends shaka.Player {
             remoteConfiguration["preferredSubtitlesLanguage"] = config["preferredTextLanguage"];
         }
 
-        sdkLogger.log("configure remote player with: ", JSON.stringify(remoteConfiguration));
         remotePlayer.configure(remoteConfiguration);
     }