senza-sdk 4.2.64 → 4.2.65-90c49ac.0

package/dist/bundle.js.LICENSE.txt

@@ -51,7 +51,3 @@
  Copyright 2015 Tobias Nickel
  SPDX-License-Identifier: MIT
 */
-
-//! moment.js
-
-//! moment.js locale configuration

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.2.64",
+    "version": "4.2.65-90c49ac.0",
     "main": "./src/api.js",
     "description": "API for Senza application",
     "license": "MIT",
@@ -15,7 +15,7 @@
         "eslint": "eslint --max-warnings 0  src test",
         "build": "npx webpack --config webpack.config.js",
         "test": "jest --coverage --verbose",
-        "testall" : "jest --coverage --verbose && npm run eslint --fix"
+        "testall": "jest --coverage --verbose && npm run eslint --fix"
     },
     "devDependencies": {
         "@babel/cli": "^7.13.16",
@@ -32,7 +32,6 @@
         "jsdoc-to-markdown": "^7.1.1",
         "webpack": "^5.72.1",
         "webpack-cli": "^5.1.4"
-
     },
     "jest": {
         "verbose": false,
@@ -51,7 +50,6 @@
         }
     },
     "dependencies": {
-        "shaka-player": "^4.12.5",
-        "moment": "^2.30.1"
+        "shaka-player": "^4.12.5"
     }
 }

package/src/devSequence.js

@@ -204,7 +204,6 @@ const setupSequence = (components, items) => {
     };
     methodInject(components, inject, (name) => name.startsWith("_") || name.startsWith("get"));
     handleKeys(items);
-    playersEvents(components, items);
     sdkLogger.log("Sequence initialized.");
 };
 
@@ -258,37 +257,3 @@ export const showSequence = (visible = true) => {
     }
     container.style.visibility = visible ? "visible" : "hidden";
 };
-function playersEvents(components, items) {
-    components.remotePlayer.addEventListener("videoelementattached", () => {
-        const video = components.remotePlayer._videoElement;
-        if (video && !video._devSequenceRateChangeHandler) {
-            video._devSequenceRateChangeHandler = () => {
-                items.push({
-                    component: "localPlayer",
-                    id: "ratechange=" + video.playbackRate,
-                    time: performance.now() - currentTime
-                });
-            };
-            video.addEventListener("ratechange", video._devSequenceRateChangeHandler);
-        }
-
-        if (video && !video._devSequencePlayingHandler) {
-            video._devSequencePlayingHandler = () => {
-                items.push({
-                    component: "localPlayer",
-                    id: "playing event",
-                    time: performance.now() - currentTime
-                });
-            };
-            video.addEventListener("playing", video._devSequencePlayingHandler);
-        }
-    });
-    components.remotePlayer.addEventListener("playing", () => {
-        items.push({
-            component: "remotePlayer",
-            id: "playing event",
-            time: performance.now() - currentTime
-        });
-    });
-}
-

package/src/lifecycle.js

@@ -102,7 +102,9 @@ class Lifecycle extends EventTarget {
          * @private
          */
         this._isInitialized = false;
-        this._inTransition = false;
+        this._inTransitionToForeground = false;
+        this._inTransitionToBackground = false;
+        this._inTransitionToStandby = false;
 
         /**
          * Event listeners manager for the userdisconnected event
@@ -384,7 +386,7 @@ class Lifecycle extends EventTarget {
     // This api is part of epic HSDEV-713
     _moveToUiStandby() {
         if (window.cefQuery) {
-            this._inTransition = true;
+            this._inTransitionToStandby = true;
             return new Promise((resolve, reject) => {
                 const FCID = getFCID();
                 const request = { target: "TC", waitForResponse: false, internalAction: "uiExit", message: JSON.stringify({ type: "uiStandbyRequest", fcid: FCID }) };
@@ -395,12 +397,12 @@ class Lifecycle extends EventTarget {
                     persistent: false,
                     onSuccess: () => {
                         logger.log("[ moveToUiStandby ] moveToUiStandby successfully sent");
-                        this._inTransition = false;
+                        this._inTransitionToStandby = false;
                         resolve(true);
                     },
                     onFailure: (code, msg) => {
                         logger.error(`[ moveToUiStandby ] moveToUiStandby failed: ${code} ${msg}`);
-                        this._inTransition = false;
+                        this._inTransitionToStandby = false;
                         reject(`moveToUiStandby failed: ${code} ${msg}`);
                     }
                 });
@@ -534,6 +536,14 @@ class Lifecycle extends EventTarget {
         this._countdown = null;
     }
 
+    /**
+     * @private
+     */
+    _isInTransition() {
+        return this._inTransitionToForeground || this._inTransitionToBackground || this._inTransitionToStandby;
+    }
+
+
     /**
      * @deprecated use lifecycle.state instead.
      * Async function that returns the ui lifecycle state
@@ -576,14 +586,19 @@ class Lifecycle extends EventTarget {
      */
     moveToForeground() {
         if (window.cefQuery) {
-            if (this._inTransition || this._state === this.UiState.FOREGROUND || this._state === this.UiState.IN_TRANSITION_TO_FOREGROUND) {
-                sdkLogger.warn(`lifecycle moveToForeground: No need to transition to foreground, state: ${this._state} transition: ${this._inTransition}`);
+            const inTransition = this._isInTransition();
+            if (inTransition || this._state === this.UiState.FOREGROUND || this._state === this.UiState.IN_TRANSITION_TO_FOREGROUND) {
+                sdkLogger.warn(`lifecycle moveToForeground: No need to transition to foreground, state: ${this._state} transition: ${inTransition}`);
                 return Promise.resolve(false);
             }
-            this._inTransition = true;
+            this._inTransitionToForeground = true;
             alarmManager._moveToForegroundCalled();
             const FCID = getFCID();
             if (this._remotePlayerApiVersion >= 2) {
+                // Only update to playing UI if we started seeking in ABR. But, if we are seeking while already paused, keep the target seek state as is.
+                if (remotePlayer._isSeekingByApplication && remotePlayer._targetSeekPlayingState === TargetPlayingState.PLAYING_ABR) {
+                    remotePlayer._targetSeekPlayingState = TargetPlayingState.PLAYING_UI;
+                }
                 return new Promise((resolve, reject) => {
                     const FCID = getFCID();
                     const logger = sdkLogger.withFields({ FCID });
@@ -603,14 +618,14 @@ class Lifecycle extends EventTarget {
                         onSuccess: () => {
                             const duration = Date.now() - timeBeforeSendingRequest;
                             logger.withFields({ duration }).log(`stop completed successfully after ${duration} ms`);
-                            this._inTransition = false;
+                            this._inTransitionToForeground = false;
                             timerId = clearTimer(timerId);
                             resolve(true);
                         },
                         onFailure: (code, msg) => {
                             const duration = Date.now() - timeBeforeSendingRequest;
                             logger.withFields({ duration }).log(`stop failed after ${duration} ms. Error code: ${code}, error message: ${msg}`);
-                            this._inTransition = false;
+                            this._inTransitionToForeground = false;
                             timerId = clearTimer(timerId);
                             reject(new SenzaError(code, msg));
                         }
@@ -619,7 +634,7 @@ class Lifecycle extends EventTarget {
                     const timeout = this._remotePlayerConfirmationTimeout + 1000;
                     timerId = setTimeout(() => {
                         logger.log(`stop reached timeout of ${timeout} ms, canceling query id ${queryId}`);
-                        this._inTransition = false;
+                        this._inTransitionToForeground = false;
                         window.cefQueryCancel(queryId);
                         reject(new SenzaError(6000, `stop reached timeout of ${timeout} ms`));
                     }, timeout, queryId);
@@ -634,11 +649,11 @@ class Lifecycle extends EventTarget {
                     persistent: false,
                     onSuccess: () => {
                         logger.log("uiActiveRequest successfully sent");
-                        this._inTransition = false;
+                        this._inTransitionToForeground = false;
                         resolve(true);
                     },
                     onFailure: (code, msg) => {
-                        this._inTransition = false;
+                        this._inTransitionToForeground = false;
                         logger.error(`uiActiveRequest failed: ${code} ${msg}`);
                         reject(`uiActiveRequest failed: ${code} ${msg}`);
                     }
@@ -651,10 +666,6 @@ class Lifecycle extends EventTarget {
 
     _moveToBackground() {
         if (window.cefQuery) {
-            if (this._inTransition || this._state === this.UiState.BACKGROUND || this._state === this.UiState.IN_TRANSITION_TO_BACKGROUND) {
-                sdkLogger.warn(`lifecycle moveToBackground: No need to transition to background, state: ${this._state} transition: ${this._inTransition}`);
-                return Promise.resolve(false);
-            }
             // If audio sync is disabled, we only need to sync before remote player starts playing
             if (!isAudioSyncConfigured()) {
                 remotePlayer._syncRemotePlayerWithLocalPlayer();
@@ -666,7 +677,7 @@ class Lifecycle extends EventTarget {
                 return this._moveToUiStandby();
             }
 
-            this._inTransition = true;
+            this._inTransitionToBackground = true;
             return new Promise((resolve, reject) => {
                 const FCID = getFCID();
                 const logger = sdkLogger.withFields({ FCID });
@@ -707,14 +718,14 @@ class Lifecycle extends EventTarget {
                     onSuccess: () => {
                         const duration = Date.now() - timeBeforeSendingRequest;
                         logger.withFields({ duration }).log(`play completed successfully after ${duration} ms`);
-                        this._inTransition = false;
+                        this._inTransitionToBackground = false;
                         timerId = clearTimer(timerId);
                         resolve();
                     },
                     onFailure: (code, msg) => {
                         const duration = Date.now() - timeBeforeSendingRequest;
                         logger.withFields({ duration }).log(`play failed after ${duration} ms. Error code: ${code}, error message: ${msg}`);
-                        this._inTransition = false;
+                        this._inTransitionToBackground = false;
                         timerId = clearTimer(timerId);
                         reject(new SenzaError(code, msg));
                     }
@@ -724,7 +735,7 @@ class Lifecycle extends EventTarget {
                     const timeout = this._remotePlayerConfirmationTimeout + 1000;
                     timerId = setTimeout(() => {
                         logger.log(`play reached timeout of ${timeout} ms, canceling query id ${queryId}`);
-                        this._inTransition = false;
+                        this._inTransitionToBackground = false;
                         window.cefQueryCancel(queryId);
                         reject(new SenzaError(6000, `play reached timeout of ${timeout} ms`));
                     }, timeout, queryId);
@@ -748,11 +759,11 @@ class Lifecycle extends EventTarget {
      */
     moveToBackground() {
         if (window.cefQuery) {
-            if (this._inTransition || this._state === this.UiState.BACKGROUND || this._state === this.UiState.IN_TRANSITION_TO_BACKGROUND) {
-                sdkLogger.warn(`lifecycle moveToBackground: No need to transition to background, state: ${this._state} transition: ${this._inTransition}`);
+            const inTransition = this._isInTransition();
+            if (inTransition || this._state === this.UiState.BACKGROUND || this._state === this.UiState.IN_TRANSITION_TO_BACKGROUND) {
+                sdkLogger.warn(`lifecycle moveToBackground: No need to transition to background, state: ${this._state} transition: ${inTransition}`);
                 return Promise.resolve(false);
             }
-
             if (remotePlayer._isSeekingByApplication) {
                 remotePlayer._targetSeekPlayingState = TargetPlayingState.PLAYING_ABR;
                 return Promise.resolve(true);

package/src/remotePlayer.js

@@ -68,7 +68,6 @@ function setPlaybackInfo(playbackInfo) {
 * @typedef {Object} Config
 * @property {string} preferredAudioLanguage
 * @property {string} preferredSubtitlesLanguage
-* @property {number} minSuggestedPresentationDelay - minimal delay allowed for live playback in seconds
 * @property {boolean} autoPlay - (Not implemented yet) upon loading start playing automatically
 */
 
@@ -79,9 +78,9 @@ function setPlaybackInfo(playbackInfo) {
  * @fires ended
  * @fires error
  * @fires onloadmodechange
- * @fires playing
  * @fires seeking (Not implemented yet)
  * @fires seeked (Not implemented yet)
+ * @fires loadedmetadata (Not implemented yet)
  */
 class RemotePlayer extends EventTarget {
     constructor() {
@@ -92,8 +91,7 @@ class RemotePlayer extends EventTarget {
          */
         this._config = {
             preferredAudioLanguage: "",
-            preferredSubtitlesLanguage: "",
-            minSuggestedPresentationDelay: 0
+            preferredSubtitlesLanguage: ""
         };
         /**
          * @type {string}
@@ -526,10 +524,10 @@ class RemotePlayer extends EventTarget {
 
     /** setting values for properties in the player configuration using an object.
      * If the config does not support a property this is a no-op.
-     * @param {Config} props the object with all the different properties to change.
+     * @param {Object} props the object with all the different properties to change
      * @example
      * remotePlayer.configure({ preferredAudioLanguage: 'en-US' })
-     * remotePlayer.configure({ minSuggestedPresentationDelay: 6 })
+     *
      * */
     configure(props) {
         Object.entries(props).forEach(([key, value]) => {
@@ -898,9 +896,6 @@ class RemotePlayer extends EventTarget {
                 this._updateSeekListeners(video);
             }
             this._videoElement = video;
-
-            // Emit a custom event to notify about the attachment of the video element
-            this.dispatchEvent(new Event("videoelementattached"));
         }
     }
 
@@ -916,7 +911,7 @@ class RemotePlayer extends EventTarget {
     /** Tell the remote player to load the given URL.
      * @param {string} url url to load
      * @param {number} [position] start position in seconds (if not provided, start from beginning (VOD) or current time (LTV))
-    * @returns {Promise}
+     * @returns {Promise}
      * @throws {RemotePlayerError} error object contains code & msg
      *
      * */
@@ -981,11 +976,6 @@ class RemotePlayer extends EventTarget {
                     message.action = "load";
                     message.audioLanguage = audioLanguage;
                     message.subtitlesLanguage = subtitlesLanguage;
-                    if (this.getConfiguration().minSuggestedPresentationDelay > 0) {
-                        message.cloudPlayerParams = {
-                            "mspd": this.getConfiguration().minSuggestedPresentationDelay
-                        };
-                    }
                 } else {
                     message.type = "setPlayableUri";
                 }
@@ -1143,8 +1133,13 @@ class RemotePlayer extends EventTarget {
 
         // If seeking in progress, wait for seek to complete before playing
         if (this._isSeekingByApplication) {
-            sdkLogger.info("application requesting play during seek");
-            this._targetSeekPlayingState = TargetPlayingState.PLAYING_UI;
+            if (lifecycle.state === lifecycle.UiState.FOREGROUND) {
+                sdkLogger.info("application requesting play during seek. setting targetSeekPlayingState to PLAYING_UI");
+                this._targetSeekPlayingState = TargetPlayingState.PLAYING_UI;
+            } else {
+                sdkLogger.info("application requesting play during seek. setting targetSeekPlayingState to PLAYING_ABR");
+                this._targetSeekPlayingState = TargetPlayingState.PLAYING_ABR;
+            }
             return Promise.resolve(true);
         }
         /*
@@ -1666,9 +1661,7 @@ class RemotePlayer extends EventTarget {
             }
         }
 
-        // Only allow seeking in foreground. Still ignore the initialized local player seeking event above
-        if (this._remotePlayerApiVersion >= 2 && !this._isSeekingByPlatform && !this._isSeekingByApplication &&
-            (lifecycle.state === lifecycle.UiState.FOREGROUND || lifecycle.state === lifecycle.UiState.IN_TRANSITION_TO_FOREGROUND)) {
+        if (this._remotePlayerApiVersion >= 2 && !this._isSeekingByPlatform && !this._isSeekingByApplication) {
             this._atomicSeek();
         } else {
             sdkLogger.info(`Seeking: skipping seeking event to currentTime: ${playbackPosition}, internalSeek: ${this._isSeekingByPlatform}, localPlayerSeek: ${this._isSeekingByApplication}, state: ${lifecycle.state}`);
@@ -1687,16 +1680,16 @@ class RemotePlayer extends EventTarget {
      * */
     async _atomicSeek() {
         sdkLogger.info("Seeking: local video element seeking start while isPlaying: ", this._isPlaying);
-
-        // Initialize the target playing state unless changed during the seek process
-        // In the future, we should allow for seeking in background. Currently, there's no
-        // way to know when the web application will call moveToForeground (i.e Before/After seek)
-        // Therefore, for now, we will assume the target is either paused or playing in ui unless
-        // specifically receiving a moveToBackground during the process.
-        // if (this._isPlaying && (lifecycle.state === lifecycle.UiState.BACKGROUND || lifecycle.state === lifecycle.UiState.IN_TRANSITION_TO_BACKGROUND)) {
-        //     this._targetSeekPlayingState = TargetPlayingState.PLAYING_ABR;
-        // }
-        this._targetSeekPlayingState = this._isPlaying ? TargetPlayingState.PLAYING_UI : TargetPlayingState.PAUSED;
+        if (this._isPlaying) {
+            if (!lifecycle._inTransitionToForeground && (lifecycle._inTransitionToBackground || lifecycle.state === lifecycle.UiState.BACKGROUND || lifecycle.state === lifecycle.UiState.IN_TRANSITION_TO_BACKGROUND)) {
+                sdkLogger.info("seek in background", this._isPlaying);
+                this._targetSeekPlayingState = TargetPlayingState.PLAYING_ABR;
+            } else {
+                this._targetSeekPlayingState = TargetPlayingState.PLAYING_UI;
+            }
+        } else {
+            this._targetSeekPlayingState = TargetPlayingState.PAUSED;
+        }
 
         // The platform could be currently syncing audio/video using playback rate. Reset when performing seek.
         if (this._videoElement) {
@@ -1763,7 +1756,7 @@ class RemotePlayer extends EventTarget {
 
         // If in TargetPlayingState.PAUSE, no need to resume.
         // Resume without awaiting to avoid blocking the seek process anymore
-        // In case where we aborted, we don't want to resume playback.
+        // In case where we aborted (new load or unload called), we don't want to resume playback.
         if (!this._abortSeeking) {
             if (this._targetSeekPlayingState === TargetPlayingState.PLAYING_UI) {
                 if (!this._isAudioSyncEnabled()) {
@@ -1772,6 +1765,8 @@ class RemotePlayer extends EventTarget {
                 // resume audio play only if _isAudioSyncEnabled
                 this._play(StreamType.AUDIO);
             } else if (this._targetSeekPlayingState === TargetPlayingState.PLAYING_ABR) {
+                // When moving back to background, we need to put the remote player back into play mode
+                this._changePlayMode(true);
                 lifecycle._moveToBackground();
             }
         }

package/src/senzaShakaPlayer.js

@@ -1,8 +1,6 @@
 import * as shaka from "shaka-player";
 import { remotePlayer, lifecycle, getPlatformInfo } from "./api";
 import { sdkLogger, iso6393to1 } from "./utils";
-import moment from "moment";
-
 
 //  Define custom error category
 shaka.util.Error.Category.SENZA_PLAYER_ERROR = 50;
@@ -78,7 +76,7 @@ export class SenzaShakaPlayer extends shaka.Player {
      * @private
      * @type {number}
      * @description Timeout in milliseconds to wait for playing event
-     * @default 4000
+     * @default 3000
      */
     _playingTimeout = 4000;
 
@@ -307,45 +305,6 @@ export class SenzaShakaPlayer extends shaka.Player {
 
     }
 
-    /**
-     * @private
-     * @type {number}
-     * @description Minimum suggested presentation delay in seconds
-     * @default 15
-     */
-    _minSuggestedPresentationDelay = 15;
-
-    /**
-     * Modifies the suggestedPresentationDelay in the manifest text
-     * @private
-     * @param {string} manifestText - The MPD manifest text
-     * @returns {string} - Modified manifest text , or undefined if no modification was done
-     */
-    _updateManifestDelayIfBelowMinimum(manifestText) {
-        // Look for suggestedPresentationDelay attribute
-        const match = manifestText.match(/suggestedPresentationDelay="([^"]+)"/);
-        if (match) {
-            const durationString = match[1];
-            const duration = moment.duration(durationString);
-            const currentDelay = duration.asSeconds();
-
-            sdkLogger.info(`Found suggestedPresentationDelay in manifest: ${currentDelay.toFixed(3)}s`);
-
-            if (currentDelay < this._minSuggestedPresentationDelay) {
-                // Replace the value in the manifest text with 3 decimal places
-                manifestText = manifestText.replace(
-                    /suggestedPresentationDelay="[^"]+"/,
-                    `suggestedPresentationDelay="PT${this._minSuggestedPresentationDelay.toFixed(3)}S"`
-                );
-                sdkLogger.info(`Updated manifest suggestedPresentationDelay to ${this._minSuggestedPresentationDelay.toFixed(3)}s`);
-                return manifestText;
-            }
-        } else {
-            sdkLogger.info("suggestedPresentationDelay is not defined at the manifest");
-        }
-        return undefined;
-    }
-
     /**
      * Creates an instance of SenzaShakaPlayer, which is a subclass of shaka.Player.
      *
@@ -373,38 +332,14 @@ export class SenzaShakaPlayer extends shaka.Player {
         const playTimeout = getPlatformInfo()?.sessionInfo?.settings?.["ui-streamer"]?.playingEventTimeout;
         this._playingTimeout = (playTimeout >= 0) ? playTimeout*1000 : this._playingTimeout;
 
-        // Initialize minSuggestedPresentationDelay from UI settings or use default
-        const uiSettings = getPlatformInfo()?.sessionInfo?.settings?.["ui-streamer"];
-        if (uiSettings?.minSuggestedPresentationDelay !== undefined) {
-            this._minSuggestedPresentationDelay = uiSettings.minSuggestedPresentationDelay;
-            sdkLogger.info(`Using configured minSuggestedPresentationDelay: ${this._minSuggestedPresentationDelay}s`);
-        }
-
         // if video element is provided, add the listeres here. In this case ,there is no need to call attach.
         if (videoElement) {
             this._attach(videoElement);
             sdkLogger.warn("SenzaShakaPlayer constructor Adding videoElement in the constructor is going to be deprecated in the future. Please use attach method instead.");
         }
 
-        this.configure({
-            manifest: {
-                defaultPresentationDelay: this._minSuggestedPresentationDelay // in seconds
-            }
-        });
-
-        remotePlayer.configure({
-            minSuggestedPresentationDelay: this._minSuggestedPresentationDelay
-        });
-
-        this.addEventListener("buffering", () => {
-            if (this.videoElement) {
-                sdkLogger.info("Buffering at time:", this.videoElement.currentTime);
-            }
-        });
-
     }
 
-
     _attach(videoElement) {
         this.videoElement = videoElement;
 
@@ -683,30 +618,16 @@ export class SenzaShakaPlayer extends shaka.Player {
 
         // This callbakc will be activated when the manifest is loaded. It will trigger load of the remote player.
         // This will ensure that the remote player is loaded only after the manifest is loaded by local player.
-        const responseFilterCallback = async (type, response) => {
-            if (type === shaka.net.NetworkingEngine.RequestType.MANIFEST) {
+        const responseFilterCallback = async (type) => {
+            if (type === shaka.net.NetworkingEngine.RequestType.MANIFEST && !manifestLoadHandled) {
+                manifestLoadHandled = true;
                 try {
-                    if (response.data && this._minSuggestedPresentationDelay > 0) {
-                        const manifestText = new TextDecoder().decode(response.data);
-                        const modifiedText = this._updateManifestDelayIfBelowMinimum(manifestText);
-                        if (modifiedText) {
-                            const responseData = new TextEncoder().encode(modifiedText).buffer;
-                            response.data = responseData;
-                        }
-                    }
+                    await this._remotePlayerLoad(url, startTime);
+                    remoteLoadResolver();
                 } catch (error) {
-                    sdkLogger.error("Error processing manifest:", error);
+                    remoteLoadRejecter(error);
                 }
 
-                if (!manifestLoadHandled) {
-                    manifestLoadHandled = true;
-                    try {
-                        await this._remotePlayerLoad(url, startTime);
-                        remoteLoadResolver();
-                    } catch (error) {
-                        remoteLoadRejecter(error);
-                    }
-                }
             }
         };