senza-sdk 4.2.50 → 4.2.51-8029b92.0

package/package.json

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

package/src/remotePlayer.js

@@ -9,7 +9,9 @@ import {
     SeekState,
     TargetPlayingState,
     isSubtitlesTranslationAllowed,
-    isSubtitlesTranslationPattern
+    isSubtitlesTranslationPattern,
+    SetAudioLanguageState,
+    SetSubtitleLanguageState
 } from "./utils";
 import { lifecycle } from "./lifecycle";
 import { writeLicenseResponse } from "./api";
@@ -890,6 +892,8 @@ 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();
@@ -1063,6 +1067,18 @@ class RemotePlayer extends EventTarget {
             }
         }
 
+        if (this._isSetAudioByApplication) {
+            sdkLogger.info("application requesting play during setAudioLanguage");
+            this._targetSetAudioPlayingState = TargetPlayingState.PLAYING_UI;
+            return Promise.resolve(true);
+        }
+
+        if (this._isSetSubtitleByApplication) {
+            sdkLogger.info("application requesting play during setSubtitleLanguage");
+            this._targetSetSubtitlePlayingState = TargetPlayingState.PLAYING_UI;
+            return Promise.resolve(true);
+        }
+
         // If seeking in progress, wait for seek to complete before playing
         if (this._isSeekingByApplication) {
             sdkLogger.info("application requesting play during seek");
@@ -1102,6 +1118,16 @@ class RemotePlayer extends EventTarget {
             this._targetSeekPlayingState = TargetPlayingState.PAUSED;
             return Promise.resolve(true);
         }
+        if (this._isSetAudioByApplication) {
+            sdkLogger.info("application requesting pause during setAudioLanguage");
+            this._targetSetAudioPlayingState = TargetPlayingState.PAUSED;
+            return Promise.resolve(true);
+        }
+        if (this._isSetSubtitleByApplication) {
+            sdkLogger.info("application requesting pause during setSubtitleLanguage");
+            this._targetSetSubtitlePlayingState = TargetPlayingState.PAUSED;
+            return Promise.resolve(true);
+        }
         return this._pause();
     }
 
@@ -1189,7 +1215,6 @@ class RemotePlayer extends EventTarget {
         const prevSelectedAudioTrack = this._selectedAudioTrack;
         for (const track of this.getAudioTracks()) {
             if (track.id === audioTrackId) {
-                this._selectedAudioTrack = audioTrackId;
                 found = true;
                 break;
             }
@@ -1198,19 +1223,34 @@ class RemotePlayer extends EventTarget {
             sdkLogger.warn(`Invalid audioTrackId ${audioTrackId}`);
             return Promise.resolve();
         }
-        if (this._remotePlayerApiVersion < 2) {
-            return Promise.resolve(); // Resolve immediately for older versions
-        }
-        if (prevSelectedAudioTrack === this._selectedAudioTrack) {
+        if (this._selectedAudioTrack === audioTrackId) {
             return Promise.resolve(); // Audio language already selected
         }
 
-        return this._selectAudioTrack(audioTrackId, prevSelectedAudioTrack);
+        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();
+        }
     }
 
-    async _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) {
         const prevIsPlaying = this._isPlaying;
-        sdkLogger.log(`remotePlayer _selectAudioTrack: prevAudioTrack=${prevSelectedAudioTrack} audioTrackId=${audioTrackId} isPlaying=${this._isPlaying}`);
+        sdkLogger.log(`remotePlayer _selectAudioTrackV2: prevAudioTrack=${prevSelectedAudioTrack} audioTrackId=${audioTrackId} isPlaying=${this._isPlaying}`);
         try {
             if (this._isPlaying) await this.pause();
             let position = this.currentTime;
@@ -1218,9 +1258,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 and revert selection
-            this._selectedAudioTrack = prevSelectedAudioTrack;
+            // Do NOT reject - just log
             sdkLogger.warn(`Failed to select audio track ${audioTrackId}: ${e.message}`);
             return;
         }
@@ -1237,6 +1277,63 @@ 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.
@@ -1256,7 +1353,6 @@ class RemotePlayer extends EventTarget {
         const prevSelectedTextTrack = this._selectedSubtitlesTrack;
         for (const track of this.getTextTracks()) {
             if (track.id === textTrackId) {
-                this._selectedSubtitlesTrack = textTrackId;
                 found = true;
                 break;
             }
@@ -1265,14 +1361,21 @@ class RemotePlayer extends EventTarget {
             sdkLogger.warn(`Invalid textTrackId ${textTrackId}`);
             return Promise.resolve();
         }
-        if (this._remotePlayerApiVersion < 2) {
-            return Promise.resolve(); // Resolve immediately for older versions
-        }
-        if (prevSelectedTextTrack === this._selectedSubtitlesTrack) {
+        if (this._selectedSubtitlesTrack === textTrackId) {
             return Promise.resolve(); // Subtitle language already selected
         }
 
-        return this._selectTextTrack(textTrackId, prevSelectedTextTrack);
+        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();
+        }
     }
 
     /**
@@ -1283,9 +1386,9 @@ class RemotePlayer extends EventTarget {
      * @param {string} prevSelectedTextTrack - The previously selected text track ID.
      * @returns {Promise<void>} Resolves when the operation is complete.
      * */
-    async _selectTextTrack(textTrackId, prevSelectedTextTrack) {
+    async _selectTextTrackV2(textTrackId, prevSelectedTextTrack) {
         const prevIsPlaying = this._isPlaying;
-        sdkLogger.log(`remotePlayer _selectTextTrack: prevTextTrack=${prevSelectedTextTrack} textTrackId=${textTrackId} isPlaying=${this._isPlaying}`);
+        sdkLogger.log(`remotePlayer _selectTextTrackV2: prevTextTrack=${prevSelectedTextTrack} textTrackId=${textTrackId} isPlaying=${this._isPlaying}`);
         try {
             if (this._isPlaying) await this.pause();
             let position = this.currentTime;
@@ -1293,9 +1396,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 and revert selection
-            this._selectedSubtitlesTrack = prevSelectedTextTrack;
+            // Do NOT reject - just log
             sdkLogger.warn(`Failed to select text track ${textTrackId}: ${e.message}`);
             return;
         }
@@ -1312,6 +1415,65 @@ 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.
@@ -1538,6 +1700,106 @@ 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._targetSeekPlayingState = this._isPlaying ? TargetPlayingState.PLAYING_UI : TargetPlayingState.PAUSED;
+        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) {
+                    if (this._targetSeekPlayingState === TargetPlayingState.PLAYING_UI) {
+                        this._play();
+                    } else if (this._targetSeekPlayingState === TargetPlayingState.PLAYING_ABR) {
+                        lifecycle._moveToBackground();
+                    }
+                }
+                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._targetSeekPlayingState = this._isPlaying ? TargetPlayingState.PLAYING_UI : TargetPlayingState.PAUSED;
+        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) {
+                    if (this._targetSeekPlayingState === TargetPlayingState.PLAYING_UI) {
+                        this._play();
+                    } else if (this._targetSeekPlayingState === TargetPlayingState.PLAYING_ABR) {
+                        lifecycle._moveToBackground();
+                    }
+                }
+                this._isSetAudioByApplication = false;
+                sdkLogger.info("SetAudioLanguage: local video element set audio end");
+            }
+        }
+        return res
+    }
 }
 /**
  *

package/src/utils.js

@@ -155,6 +155,24 @@ 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",