senza-sdk 4.2.51-9f586bc.0 → 4.2.51

package/package.json

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

package/src/lifecycle.js

@@ -87,7 +87,7 @@ class Lifecycle extends EventTarget {
     /**
      * @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.
+     * This event is useful for cleaning up application state or saving data before the application closes. Event callback should return promise to ensure that the event is handled before the application is terminated
      * @example
      * lifecycle.addEventListener("userdisconnected", () => {
      *     console.log("User session ended, cleaning up application state");
@@ -410,12 +410,12 @@ class Lifecycle extends EventTarget {
     }
 
     /**
-     * Controls the autoBackground feature<br>
+     * @deprecated Use `lifecycle.configure()` instead.
+     * Controls the autoBackground feature.<br>
      * When enabled, the application will automatically move to the background state after a configurable
-     * period of inactivity. The delay depends on whether video is playing ({@link Lifecycle#autoBackgroundDelay})
-     * or the UI is idle ({@link Lifecycle#autoBackgroundOnUIDelay}).
-     * The application will return to the foreground state when a key is pressed.
+     * period of inactivity. Use the `configure` method to set timeouts for video playback and UI states.
      * @type {boolean}
+     * @see {@link Lifecycle#configure}
      */
     set autoBackground(enabled) {
         this._autoBackground = enabled;
@@ -431,10 +431,12 @@ class Lifecycle extends EventTarget {
     }
 
     /**
+     * @deprecated Use `lifecycle.configure()` instead.
      * The number of seconds of user inactivity before the application moves to the background state while playing video.
-     * This setting is used when remotePlayer is in playing state.
+     * Use the `configure` method to set this timeout.
      * @type {integer}
      * @default 30
+     * @see {@link Lifecycle#configure}
      */
     set autoBackgroundDelay(delay) {
         this._autoBackgroundOnVideoDelay = delay;
@@ -444,12 +446,18 @@ class Lifecycle extends EventTarget {
         }
     }
 
+    get autoBackgroundDelay() {
+        return this._autoBackgroundOnVideoDelay;
+    }
+
     /**
-    * The number of seconds of user inactivity before the application moves to the background state while in the UI (not playing).
-    * This setting is used when remotePlayer is not in playing state.
-    * @type {integer}
-    * @default 30
-    */
+     * @deprecated Use `lifecycle.configure()` instead.
+     * The number of seconds of user inactivity before the application moves to the background state while in the UI (not playing).
+     * Use the `configure` method to set this timeout.
+     * @type {integer}
+     * @default -1
+     * @see {@link Lifecycle#configure}
+     */
     set autoBackgroundOnUIDelay(delay) {
         this._autoBackgroundOnUIDelay = delay;
 
@@ -458,13 +466,10 @@ class Lifecycle extends EventTarget {
         }
     }
 
-    get autoBackgroundDelay() {
-        return this._autoBackgroundOnVideoDelay;
-    }
-
     get autoBackgroundOnUIDelay() {
         return this._autoBackgroundOnUIDelay;
     }
+
     /**
     * @private
     */
@@ -824,9 +829,9 @@ class Lifecycle extends EventTarget {
     }
 
     /**
-     * Override addEventListener to handle "userdisconnected" event specially
+     * Add event listener for lifecycle events
      * @param {string} type - The event type to listen for
-     * @param {Function} listener - The callback function
+     * @param {Function} listener - The callback function. Listeners for 'userdisconnected' events should return a promise to ensure the event is processed before the application exits.
      * @param {Object} options - Event listener options
      */
     addEventListener(type, listener, options) {
@@ -840,7 +845,7 @@ class Lifecycle extends EventTarget {
     }
 
     /**
-     * Override removeEventListener to handle "userdisconnected" event specially
+     * Remove event listener
      * @param {string} type - The event type
      * @param {Function} listener - The callback function to remove
      * @param {Object} options - Event listener options

package/src/remotePlayer.js

@@ -9,9 +9,7 @@ import {
     SeekState,
     TargetPlayingState,
     isSubtitlesTranslationAllowed,
-    isSubtitlesTranslationPattern,
-    SetAudioLanguageState,
-    SetSubtitleLanguageState
+    isSubtitlesTranslationPattern
 } from "./utils";
 import { lifecycle } from "./lifecycle";
 import { writeLicenseResponse } from "./api";
@@ -892,8 +890,6 @@ class RemotePlayer extends EventTarget {
             if (this._loadMode === this.LoadMode.LOADING || this._loadMode === this.LoadMode.UNLOADING) {
                 throw new RemotePlayerError(6501, "Cannot call load() while previous load/unload is still in progress");
             }
-            this._abortSetAudioLanguage = true;
-            this._abortSetSubtitleLanguage = true;
             this._abortSeeking = true;
             if (reset) {
                 this._reset();
@@ -1193,6 +1189,7 @@ class RemotePlayer extends EventTarget {
         const prevSelectedAudioTrack = this._selectedAudioTrack;
         for (const track of this.getAudioTracks()) {
             if (track.id === audioTrackId) {
+                this._selectedAudioTrack = audioTrackId;
                 found = true;
                 break;
             }
@@ -1201,34 +1198,19 @@ class RemotePlayer extends EventTarget {
             sdkLogger.warn(`Invalid audioTrackId ${audioTrackId}`);
             return Promise.resolve();
         }
-        if (this._selectedAudioTrack === audioTrackId) {
+        if (this._remotePlayerApiVersion < 2) {
+            return Promise.resolve(); // Resolve immediately for older versions
+        }
+        if (prevSelectedAudioTrack === this._selectedAudioTrack) {
             return Promise.resolve(); // Audio language already selected
         }
 
-        switch (this._remotePlayerApiVersion) {
-        case 0:
-        case 1:
-            this._selectedAudioTrack = audioTrackId;
-            return Promise.resolve(); // Resolve immediately for older versions
-        case 2:
-            return this._selectAudioTrackV2(audioTrackId, prevSelectedAudioTrack);
-        default:
-            this._pendingAudioLanguage = audioTrackId;
-            return this._atomicSetAudioLanguage();
-        }
+        return this._selectAudioTrack(audioTrackId, prevSelectedAudioTrack);
     }
 
-    /**
-     * Handles the asynchronous selection of an audio track.
-     * If the player is playing, it pauses before changing the track and resumes playback if necessary.
-     *
-     * @param {string} audioTrackId - The ID of the audio track to select.
-     * @param {string} prevSelectedAudioTrack - The previously selected audio track ID.
-     * @returns {Promise<void>} Resolves when the operation is complete.
-     * */
-    async _selectAudioTrackV2(audioTrackId, prevSelectedAudioTrack) {
+    async _selectAudioTrack(audioTrackId, prevSelectedAudioTrack) {
         const prevIsPlaying = this._isPlaying;
-        sdkLogger.log(`remotePlayer _selectAudioTrackV2: prevAudioTrack=${prevSelectedAudioTrack} audioTrackId=${audioTrackId} isPlaying=${this._isPlaying}`);
+        sdkLogger.log(`remotePlayer _selectAudioTrack: prevAudioTrack=${prevSelectedAudioTrack} audioTrackId=${audioTrackId} isPlaying=${this._isPlaying}`);
         try {
             if (this._isPlaying) await this.pause();
             let position = this.currentTime;
@@ -1236,9 +1218,9 @@ class RemotePlayer extends EventTarget {
                 position = this._videoElement.currentTime;
             }
             await this._load(this._loadedUrl, position, audioTrackId, undefined, false);
-            this._selectedAudioTrack = audioTrackId;
         } catch (e) {
-            // Do NOT reject - just log
+            // Do NOT reject - just log and revert selection
+            this._selectedAudioTrack = prevSelectedAudioTrack;
             sdkLogger.warn(`Failed to select audio track ${audioTrackId}: ${e.message}`);
             return;
         }
@@ -1255,63 +1237,6 @@ class RemotePlayer extends EventTarget {
         }
     }
 
-    /**
-     * Handles the asynchronous selection of an audio track.
-     * If the player is playing, it stops subtitle streamType before changing the track and resumes subtitle streamType playback if necessary.
-     * Available only from v3 and on
-     *
-     * @param {string} audioTrackId - The ID of the audio track to select.
-     * @param {string} prevSelectedAudioTrack - The previously selected audio track ID.
-     * @returns {Promise<void>} Resolves when the operation is complete.
-     * */
-    async _selectAudioTrackV3(audioTrackId, prevSelectedAudioTrack) {
-        sdkLogger.log(`remotePlayer _selectAudioTrackV3: prevAudioTrack=${prevSelectedAudioTrack} audioTrackId=${audioTrackId} isPlaying=${this._isPlaying}`);
-        if (window.cefQuery) {
-            const FCID = getFCID();
-            const logger = sdkLogger.withFields({ FCID });
-            logger.log("remotePlayer _selectAudioTrackV3: sending setAudioLanguage action");
-            const message = {
-                type: "remotePlayer.setAudioLanguage",
-                class: "remotePlayer",
-                action: "setAudioLanguage",
-                fcid: FCID,
-                language: audioTrackId,
-            };
-            const request = { target: "TC", waitForResponse: true, message: JSON.stringify(message) };
-            return new Promise((resolve, reject) => {
-                let timerId = 0;
-                const timeBeforeSendingRequest = Date.now();
-                const queryId = window.cefQuery({
-                    request: JSON.stringify(request),
-                    persistent: false,
-                    onSuccess: () => {
-                        this._selectedAudioTrack = audioTrackId;
-                        const duration = Date.now() - timeBeforeSendingRequest;
-                        logger.withFields({ duration }).log(`setAudioLanguage completed successfully after ${duration} ms`);
-                        timerId = clearTimer(timerId);
-                        resolve();
-                    },
-                    onFailure: (code, msg) => {
-                        const duration = Date.now() - timeBeforeSendingRequest;
-                        logger.withFields({ duration }).log(`setAudioLanguage failed after ${duration} ms. Error code: ${code}, error message: ${msg}`);
-                        timerId = clearTimer(timerId);
-                        reject(new RemotePlayerError(code, msg));
-                    }
-                });
-                logger.log(`window.cefQuery for setAudioLanguage returned query id ${queryId}`);
-                const timeout = this._remotePlayerConfirmationTimeout + 1000;
-                timerId = setTimeout(() => {
-                    logger.log(`setAudioLanguage reached timeout of ${timeout} ms, canceling query id ${queryId}`);
-                    window.cefQueryCancel(queryId);
-                    reject(new RemotePlayerError(6000, `setAudioLanguage reached timeout of ${timeout} ms`));
-                }, timeout, queryId);
-            });
-        }
-
-        sdkLogger.error("remotePlayer _selectAudioTrackV3: window.cefQuery is undefined");
-        return Promise.resolve(undefined);
-    }
-
     /** Select a specific text (subtitle) track.
      * Track id should come from a call to getTextTracks.
      * If no tracks exist - this is a no-op.
@@ -1331,6 +1256,7 @@ class RemotePlayer extends EventTarget {
         const prevSelectedTextTrack = this._selectedSubtitlesTrack;
         for (const track of this.getTextTracks()) {
             if (track.id === textTrackId) {
+                this._selectedSubtitlesTrack = textTrackId;
                 found = true;
                 break;
             }
@@ -1339,21 +1265,14 @@ class RemotePlayer extends EventTarget {
             sdkLogger.warn(`Invalid textTrackId ${textTrackId}`);
             return Promise.resolve();
         }
-        if (this._selectedSubtitlesTrack === textTrackId) {
+        if (this._remotePlayerApiVersion < 2) {
+            return Promise.resolve(); // Resolve immediately for older versions
+        }
+        if (prevSelectedTextTrack === this._selectedSubtitlesTrack) {
             return Promise.resolve(); // Subtitle language already selected
         }
 
-        switch (this._remotePlayerApiVersion) {
-        case 0:
-        case 1:
-            this._selectedSubtitlesTrack = textTrackId;
-            return Promise.resolve(); // Resolve immediately for older versions
-        case 2:
-            return this._selectTextTrackV2(textTrackId, prevSelectedTextTrack);
-        default:
-            this._pendingSubtitleLanguage = textTrackId;
-            return this._atomicSetSubtitleLanguage();
-        }
+        return this._selectTextTrack(textTrackId, prevSelectedTextTrack);
     }
 
     /**
@@ -1364,9 +1283,9 @@ class RemotePlayer extends EventTarget {
      * @param {string} prevSelectedTextTrack - The previously selected text track ID.
      * @returns {Promise<void>} Resolves when the operation is complete.
      * */
-    async _selectTextTrackV2(textTrackId, prevSelectedTextTrack) {
+    async _selectTextTrack(textTrackId, prevSelectedTextTrack) {
         const prevIsPlaying = this._isPlaying;
-        sdkLogger.log(`remotePlayer _selectTextTrackV2: prevTextTrack=${prevSelectedTextTrack} textTrackId=${textTrackId} isPlaying=${this._isPlaying}`);
+        sdkLogger.log(`remotePlayer _selectTextTrack: prevTextTrack=${prevSelectedTextTrack} textTrackId=${textTrackId} isPlaying=${this._isPlaying}`);
         try {
             if (this._isPlaying) await this.pause();
             let position = this.currentTime;
@@ -1374,9 +1293,9 @@ class RemotePlayer extends EventTarget {
                 position = this._videoElement.currentTime;
             }
             await this._load(this._loadedUrl, position, undefined, textTrackId, false);
-            this._selectedSubtitlesTrack = textTrackId;
         } catch (e) {
-            // Do NOT reject - just log
+            // Do NOT reject - just log and revert selection
+            this._selectedSubtitlesTrack = prevSelectedTextTrack;
             sdkLogger.warn(`Failed to select text track ${textTrackId}: ${e.message}`);
             return;
         }
@@ -1393,65 +1312,6 @@ class RemotePlayer extends EventTarget {
         }
     }
 
-    /**
-     * Handles the asynchronous selection of a text track.
-     * If the player is playing, it stops subtitle streamType before changing the track and resumes subtitle streamType playback if necessary.
-     * Available only from v3 and on
-     *
-     * @param {string} textTrackId - The ID of the text track to select.
-     * @param {string} prevSelectedTextTrack - The previously selected text track ID.
-     * @returns {Promise<void>} Resolves when the operation is complete.
-     * */
-    async _selectTextTrackV3(textTrackId, prevSelectedTextTrack) {
-        sdkLogger.log(`remotePlayer _selectTextTrackV3: prevAudioTrack=${prevSelectedTextTrack} textTrackId=${textTrackId} isPlaying=${this._isPlaying}`);
-        if (window.cefQuery) {
-            const FCID = getFCID();
-            const logger = sdkLogger.withFields({ FCID });
-            logger.log("remotePlayer _selectTextTrackV3: sending setSubtitleLanguage action");
-            const message = {
-                type: "remotePlayer.setSubtitleLanguage",
-                class: "remotePlayer",
-                action: "setSubtitleLanguage",
-                fcid: FCID,
-                language: textTrackId,
-            };
-            const request = { target: "TC", waitForResponse: true, message: JSON.stringify(message) };
-            return new Promise((resolve, reject) => {
-                let timerId = 0;
-                const timeBeforeSendingRequest = Date.now();
-                const queryId = window.cefQuery({
-                    request: JSON.stringify(request),
-                    persistent: false,
-                    onSuccess: () => {
-                        this._selectedSubtitlesTrack = textTrackId;
-                        const duration = Date.now() - timeBeforeSendingRequest;
-                        logger.withFields({ duration }).log(`setSubtitleLanguage completed successfully after ${duration} ms`);
-                        timerId = clearTimer(timerId);
-                        resolve();
-                    },
-                    onFailure: (code, msg) => {
-                        const duration = Date.now() - timeBeforeSendingRequest;
-                        logger.withFields({ duration }).log(`setSubtitleLanguage failed after ${duration} ms. Error code: ${code}, error message: ${msg}`);
-                        timerId = clearTimer(timerId);
-                        reject(new RemotePlayerError(code, msg));
-                    }
-                });
-                logger.log(`window.cefQuery for setSubtitleLanguage returned query id ${queryId}`);
-                const timeout = this._remotePlayerConfirmationTimeout + 1000;
-                timerId = setTimeout(() => {
-                    logger.log(`setSubtitleLanguage reached timeout of ${timeout} ms, canceling query id ${queryId}`);
-                    window.cefQueryCancel(queryId);
-                    reject(new RemotePlayerError(6000, `setSubtitleLanguage reached timeout of ${timeout} ms`));
-                }, timeout, queryId);
-            });
-        }
-        sdkLogger.error("remotePlayer _selectAudioTrackV3: window.cefQuery is undefined");
-        return Promise.resolve(undefined);
-
-
-    }
-
-
     /**
      * Enable or disable the subtitles.
      * If the player is in an unloaded state, the request will be applied next time content is played.
@@ -1606,6 +1466,8 @@ class RemotePlayer extends EventTarget {
         // The platform could be currently syncing audio/video using playback rate. Reset when performing seek.
         if (this._videoElement) {
             this._videoElement.playbackRate = 1.0;
+            // on seek we need to reset any on going sync operation
+            this._ptsSessionId++;
         }
 
         // Seeking is in progress
@@ -1678,96 +1540,6 @@ class RemotePlayer extends EventTarget {
         this._isSeekingByApplication = false;
         sdkLogger.info("Seeking: local video element seeking end");
     }
-
-    async _atomicSetSubtitleLanguage() {
-        sdkLogger.info("SetSubtitleLanguage: local video element set start while isPLaying=", this._isPlaying);
-
-        this._abortSetSubtitleLanguage = false;
-        this._isSetSubtitleByApplication = true;
-
-        let state = SetSubtitleLanguageState.INIT;
-
-        let previousPendingSubtitleLanguage = this._pendingSubtitleLanguage;
-        let initialSubtitleLanguage= this._pendingSubtitleLanguage;
-        let res;
-        
-        while (!this._abortSetSubtitleLanguage && state !== SetSubtitleLanguageState.DONE) {
-            try {
-                // TODO - Implement the logic for setting audio language
-                switch(state) {
-                case SetSubtitleLanguageState.INIT:
-                    state = this._isPlaying ? SetSubtitleLanguageState.STOPPED : SetSubtitleLanguageState.SET;
-                    break;
-                case SetSubtitleLanguageState.STOPPED:
-                    await lifecycle.moveToForeground();
-                    state = SetSubtitleLanguageState.SET;
-                    break;
-                case SetSubtitleLanguageState.SET:
-                    initialSubtitleLanguage = this._pendingSubtitleLanguage;
-                    previousPendingSubtitleLanguage = this._selectedSubtitleTrack;
-                    res = await this._selectTextTrackV3(initialSubtitleLanguage, previousPendingSubtitleLanguage);
-                    state = SetSubtitleLanguageState.DONE;
-                    break;
-                }
-            } catch (error) {
-                sdkLogger.error(`Error during set subtitle process: ${error.message}`);
-                state = SetSubtitleLanguageState.DONE;
-                res = Promise.reject(error);
-            } finally {
-                if (!this._abortSetSubtitleLanguage) {
-                    this._play();
-                }
-                this._isSetSubtitleByApplication = false;
-                sdkLogger.info("SetSubtitleLanguage: local video element set subtitle end");
-            }
-        }
-        return res
-    }
-
-    async _atomicSetAudioLanguage() {
-        sdkLogger.info("SetAudioLanguage: local video element set start while isPLaying=", this._isPlaying);
-
-        this._abortSetAudioLanguage = false;
-        this._isSetAudioByApplication = true;
-
-        let state = SetAudioLanguageState.INIT;
-
-        let previousPendingAudioLanguage = this._pendingAudioLanguage;
-        let initialAudioLanguage= this._pendingAudioLanguage;
-        let res;
-        
-        while (!this._abortSetAudioLanguage && state !== SetAudioLanguageState.DONE) {
-            try {
-                // TODO - Implement the logic for setting audio language
-                switch(state) {
-                case SetAudioLanguageState.INIT:
-                    state = this._isPlaying ? SetAudioLanguageState.STOPPED : SetAudioLanguageState.SET;
-                    break;
-                case SetAudioLanguageState.STOPPED:
-                    await lifecycle.moveToForeground();
-                    state = SetAudioLanguageState.SET;
-                    break;
-                case SetAudioLanguageState.SET:
-                    initialAudioLanguage = this._pendingAudioLanguage;
-                    previousPendingAudioLanguage = this._selectedAudioTrack;
-                    res = await this._selectAudioTrackV3(initialAudioLanguage, previousPendingAudioLanguage);
-                    state = SetAudioLanguageState.DONE;
-                    break;
-                }
-            } catch (error) {
-                sdkLogger.error(`Error during set audio process: ${error.message}`);
-                state = SetAudioLanguageState.DONE;
-                res = Promise.reject(error);
-            } finally {
-                if (!this._abortSetAudioLanguage) {
-                    this._play();
-                }
-                this._isSetAudioByApplication = false;
-                sdkLogger.info("SetAudioLanguage: local video element set audio end");
-            }
-        } 
-        return res
-    }
 }
 /**
  *

package/src/utils.js

@@ -155,24 +155,6 @@ export const TargetPlayingState = Object.freeze({
     PLAYING_ABR: "playingAbr"
 });
 
-export const SetAudioLanguageState = Object.freeze({
-    INIT: "init",
-    STOPPED: "stopped",
-    SET: "set",
-    MULTI_SET: "multiSet",
-    WAITING: "waiting",
-    DONE: "done"
-});
-
-export const SetSubtitleLanguageState = Object.freeze({
-    INIT: "init",
-    STOPPED: "stopped",
-    SET: "set",
-    MULTI_SET: "multiSet",
-    WAITING: "waiting",
-    DONE: "done"
-});
-
 export const iso6393to1 = {
     "aar": "aa",
     "abk": "ab",