senza-sdk 4.2.43 → 4.2.45

package/package.json

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

package/src/lifecycle.js

@@ -1,7 +1,7 @@
 import { alarmManager, getPlatformInfo } from "./api";
 import {
     getFCID,
-    isAudioSyncEnabled,
+    isAudioSyncConfigured,
     clearTimer,
     sdkLogger,
     StreamType,
@@ -21,6 +21,7 @@ const DEFAULT_AUTO_BACKGROUND_ENABLED = false;
   * Lifecycle is a singleton class that manages the application lifecycle states.<br>
   * @fires onstatechange
   * @fires userinactivity
+  * @fires userdisconnected
  */
 class Lifecycle extends EventTarget {
     /**
@@ -60,6 +61,17 @@ class Lifecycle extends EventTarget {
      * });
      * @alpha API has not yet been released
      */
+
+    /**
+     * @event Lifecycle#userdisconnected
+     * @description Fired when the user session ends .
+     * This event is useful for cleaning up application state or saving data before the application closes.
+     * @example
+     * lifecycle.addEventListener("userdisconnected", () => {
+     *     console.log("User session ended, cleaning up application state");
+     *     // Perform any necessary cleanup here
+     * });
+     */
     constructor() {
         super();
 
@@ -106,6 +118,11 @@ class Lifecycle extends EventTarget {
             this.dispatchEvent(event);
         });
 
+        typeof document !== "undefined" && document.addEventListener("hs/endOfSession", () => {
+            const event = new Event("userdisconnected");
+            this.dispatchEvent(event);
+        });
+
         typeof document !== "undefined" && document.addEventListener("keydown", () => {
             if (this._autoBackground) {
                 if (this.state === this.UiState.BACKGROUND ||
@@ -364,7 +381,7 @@ class Lifecycle extends EventTarget {
                         type: "remotePlayer.stop",
                         class: "remotePlayer",
                         action: "stop",
-                        streamType: isAudioSyncEnabled() ? StreamType.VIDEO | StreamType.SUBTITLE : StreamType.AUDIO | StreamType.VIDEO | StreamType.SUBTITLE,
+                        streamType: remotePlayer._isAudioSyncEnabled() ? StreamType.VIDEO | StreamType.SUBTITLE : StreamType.AUDIO | StreamType.VIDEO | StreamType.SUBTITLE,
                         fcid: FCID
                     };
                     let timerId = 0;
@@ -428,7 +445,7 @@ class Lifecycle extends EventTarget {
                 return Promise.resolve(false);
             }
             // If audio sync is disabled, we only need to sync before remote player starts playing
-            if (!isAudioSyncEnabled()) {
+            if (!isAudioSyncConfigured()) {
                 remotePlayer._syncRemotePlayerWithLocalPlayer();
             }
 
@@ -454,7 +471,7 @@ class Lifecycle extends EventTarget {
                 if (this._remotePlayerApiVersion >= 2) {
                     message.type = "remotePlayer.play";
                     message.class = "remotePlayer";
-                    message.switchMode = isAudioSyncEnabled() ? SwitchMode.SEAMLESS : SwitchMode.NON_SEAMLESS;
+                    message.switchMode = remotePlayer._isAudioSyncEnabled() ? SwitchMode.SEAMLESS : SwitchMode.NON_SEAMLESS;
                     message.streamType = StreamType.AUDIO | StreamType.VIDEO | StreamType.SUBTITLE;
                     request = {
                         target: "TC",

package/src/remotePlayer.js

@@ -1,6 +1,6 @@
 import {
     getFCID,
-    isAudioSyncEnabled,
+    isAudioSyncConfigured,
     clearTimer,
     sdkLogger,
     StreamType,
@@ -199,8 +199,8 @@ class RemotePlayer extends EventTarget {
             sdkLogger.info("Got hs/playbackInfoEvent");
             // When attached, the sdk controls the synchronization between the local and remote player.
             if (this._videoElement) {
-                // When audio sync enabled, the local player is already in sync with the remote player.
-                if (!isAudioSyncEnabled() && (lifecycle.state === lifecycle.UiState.BACKGROUND || lifecycle.state === lifecycle.UiState.IN_TRANSITION_TO_BACKGROUND)) {
+                // When audio sync is configured, the local player is already in sync with the remote player.
+                if (!isAudioSyncConfigured() && (lifecycle.state === lifecycle.UiState.BACKGROUND || lifecycle.state === lifecycle.UiState.IN_TRANSITION_TO_BACKGROUND)) {
                     this._syncLocalPlayerWithRemotePlayer();
                 }
             } else {
@@ -250,8 +250,8 @@ class RemotePlayer extends EventTarget {
             this._videoElement.playbackRate = event.detail.rate;
         });
         typeof document !== "undefined" && document.addEventListener("hs/senzaPlayerSetTime", (event) => {
-            // For simplicity, make sure we only accept syncing the current time if audio sync enabled
-            if (!this._videoElement || !isAudioSyncEnabled()) return;
+            // For simplicity, make sure we only accept syncing the current time if audio sync is enabled
+            if (!this._isAudioSyncEnabled()) return;
             if (this._isSeekingByApplication) {
                 sdkLogger.info("Skip senzaPlayerSetTime while seek performed");
                 return;
@@ -504,6 +504,13 @@ class RemotePlayer extends EventTarget {
         }
     }
 
+    /** @private Audio sync is enabled only when the video element is attached and the audio sync is configured
+     * @returns {boolean}
+     */
+    _isAudioSyncEnabled() {
+        return isAudioSyncConfigured() && this._videoElement;
+    }
+
     /** get the player configuration.
      * @returns {Config}
      * */
@@ -708,7 +715,7 @@ class RemotePlayer extends EventTarget {
             let waitForResponse = false;
             this._changePlayMode(true);
             if (this._remotePlayerApiVersion >= 2) {
-                if (isAudioSyncEnabled()) {
+                if (this._isAudioSyncEnabled()) {
                     message.switchMode = SwitchMode.SEAMLESS;
                     message.streamType = StreamType.AUDIO;
                     waitForResponse = true;
@@ -756,7 +763,7 @@ class RemotePlayer extends EventTarget {
         if (window.cefQuery) {
             this._changePlayMode(false);
             const isForegroundState = lifecycle.state === lifecycle.UiState.FOREGROUND || lifecycle.state === lifecycle.UiState.IN_TRANSITION_TO_FOREGROUND;
-            if (this._remotePlayerApiVersion >= 2 && !isAudioSyncEnabled() && isForegroundState) {
+            if (this._remotePlayerApiVersion >= 2 && !this._isAudioSyncEnabled() && isForegroundState) {
                 sdkLogger.info("remotePlayer pause: application in foreground, remote player is not playing.");
                 return Promise.resolve();
             }
@@ -770,7 +777,7 @@ class RemotePlayer extends EventTarget {
                 fcid: FCID
             };
             if (this._remotePlayerApiVersion >= 2) {
-                message.streamType = isAudioSyncEnabled() && isForegroundState ? StreamType.AUDIO : StreamType.AUDIO | StreamType.VIDEO | StreamType.SUBTITLE;
+                message.streamType = this._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) };
@@ -831,7 +838,7 @@ class RemotePlayer extends EventTarget {
             if (this._videoElement) {
                 this.detach();
             }
-            if (isAudioSyncEnabled()) {
+            if (isAudioSyncConfigured()) {
                 this._handleVideoFrameInfo(video);
                 this._updateSeekListeners(video);
             }
@@ -1063,7 +1070,7 @@ class RemotePlayer extends EventTarget {
             return Promise.resolve(true);
         }
         /*
-        else if (this._remotePlayerApiVersion >= 2 && isAudioSyncEnabled() && this._videoElement) {
+        else if (this._remotePlayerApiVersion >= 2 && this._isAudioSyncEnabled()) {
             // If we have the position of the video element, we can sync the remote player with the local player
             // before playing audio.
             if (this._videoElement.currentTime !== 0) {

package/src/utils.js

@@ -110,7 +110,7 @@ export function clearTimer(timerId) {
     return timerId;
 }
 
-export function isAudioSyncEnabled() {
+export function isAudioSyncConfigured() {
     const clientUiAudioSettings = sessionInfo.sessionInfoObj?.settings?.client?.["ui_audio"];
     return clientUiAudioSettings?.enabled && clientUiAudioSettings?.from_cdn && clientUiAudioSettings?.ui_sync_enabled;
 }