senza-sdk 4.3.1-4a01fcf.0 → 4.3.1-ca3d96f.0

package/src/implementation/senzaShakaPlayer.js

@@ -1,4 +1,4 @@
-import { shaka } from "../interface/senzaShakaPlayer";
+import { SenzaShakaPlayer as SenzaShakaInterface, shaka } from "../interface/senzaShakaPlayer";
 
 import { remotePlayer, lifecycle, getPlatformInfo } from "./api";
 import { sdkLogger, iso6393to1 } from "./utils";
@@ -33,26 +33,7 @@ class SenzaError extends shaka.util.Error {
 }
 
 
-/**
- * SenzaShakaPlayer subclass of Shaka that handles both local and remote playback.
- *
- * @class SenzaShakaPlayer
- *
- * @example
- * import { SenzaShakaPlayer } from "./senzaShakaPlayer.js";
- *
- * try {
- *   const videoElement = document.getElementById("video");
- *   const player = new SenzaShakaPlayer(videoElement);
- *   await player.load("http://playable.url/file.mpd");
- *   await videoElement.play(); // will start the playback
- *
- * } catch (err) {
- *   console.error("SenzaShakaPlayer failed with error", err);
- * }
- */
-
-export class SenzaShakaPlayer extends shaka.Player {
+export class SenzaShakaPlayer extends SenzaShakaInterface {
     /** @private {SenzaShakaPlayer|null} Previous instance of the player */
     static _prevInstance = null;
 
@@ -137,7 +118,7 @@ export class SenzaShakaPlayer extends shaka.Player {
                     });
             }
         },
-        "pause" : () => {
+        "pause": () => {
             this._resetPlayPromise();
             this.remotePlayer.pause()
                 .catch(error => {
@@ -342,14 +323,6 @@ export class SenzaShakaPlayer extends shaka.Player {
         return undefined;
     }
 
-    /**
-     * Creates an instance of SenzaShakaPlayer, which is a subclass of shaka.Player.
-     *
-     * @param {HTMLVideoElement} videoElement - The video element to be used for local playback. This parameter is optional. If not provided, the video element can be attached later using the attach method.
-     * @param {HTMLElement=} videoContainer - The videoContainer to construct UITextDisplayer
-     * @param {function(shaka.Player)=} dependencyInjector Optional callback
-   *   which is called to inject mocks into the Player.  Used for testing.
-     */
     constructor(videoElement, videoContainer, dependencyInjector) {
         super(videoElement, videoContainer, dependencyInjector);
 
@@ -367,7 +340,7 @@ export class SenzaShakaPlayer extends shaka.Player {
         this._addRemotePlayerEventListeners();
         SenzaShakaPlayer._prevInstance = this;
         const playTimeout = getPlatformInfo()?.sessionInfo?.settings?.["ui-streamer"]?.playingEventTimeout;
-        this._playingTimeout = (playTimeout >= 0) ? playTimeout*1000 : this._playingTimeout;
+        this._playingTimeout = (playTimeout >= 0) ? playTimeout * 1000 : this._playingTimeout;
 
         // Initialize minSuggestedPresentationDelay from UI settings or use default
         const uiSettings = getPlatformInfo()?.sessionInfo?.settings?.["ui-streamer"];
@@ -447,27 +420,11 @@ export class SenzaShakaPlayer extends shaka.Player {
         this._attachVideoElementToRemotePlayer();
     }
 
-    /**
-     * Overrides the attach method of shaka.Player to attach the video element.
-     *
-     * @param {HTMLVideoElement} videoElement - The video element to be used for local playback.
-     * @param {boolean} [initializeMediaSource=true] - Whether to initialize the media source.
-     */
     async attach(videoElement, initializeMediaSource = true) {
         await super.attach(videoElement, initializeMediaSource);
         this._attach(videoElement);
     }
 
-    /**
-   * Detach the player from the current media element. Leaves the player in a
-   * state where it cannot play media, until it has been attached to something
-   * else.
-   *
-   * @param {boolean=} keepAdManager
-   *
-   * @return {!Promise}
-   * @export
-   */
     async detach(keepAdManager = false) {
         // Clear any pending timeout
         this._resetPlayPromise();
@@ -498,14 +455,6 @@ export class SenzaShakaPlayer extends shaka.Player {
         this.videoElement = null;
     }
 
-    /**
-   * Unloads the currently playing stream, if any.
-   *
-   * @param {boolean=} initializeMediaSource
-   * @param {boolean=} keepAdManager
-   * @return {!Promise}
-   * @export
-   */
     async unload(initializeMediaSource = true, keepAdManager = false) {
         // Call the remote player's unload method
         try {
@@ -520,27 +469,14 @@ export class SenzaShakaPlayer extends shaka.Player {
         await super.unload(initializeMediaSource, keepAdManager);
     }
 
-    /**
-     * Overrides the getTextTracks method to use the remote player's text tracks.
-     * @returns {Array} An array of text tracks.
-     */
     getTextLanguages() {
         return Object.keys(this._textTracksMap);
     }
 
-    /**
-     * Overrides the getAudioTracks method to use the remote player's audio tracks.
-     * @returns {Array} An array of audio tracks.
-     */
     getAudioLanguages() {
         return Object.keys(this._audioTracksMap);
     }
 
-    /**
-     * Overrides the selectAudioLanguage method to use the remote player's audio track selection.
-     * @param {string} language - The language to select.
-     * @param {string=} role - The role of the track to select. (e.g. 'main', 'caption', or 'commentary')
-     */
     selectAudioLanguage(language, role) {
         sdkLogger.log("Selecting audio language:", language, "with role: ", role);
         if (this._audioTracksMap[language]) {
@@ -551,11 +487,6 @@ export class SenzaShakaPlayer extends shaka.Player {
         super.selectAudioLanguage(language, role);
     }
 
-    /**
-     * Overrides the selectTextLanguage method to use the remote player's text track selection.
-     * @param {string} language - The language to select.
-     * @param {string=} role - The role of the track to select.
-     */
     selectTextLanguage(language, role) {
         sdkLogger.log("Selecting text language:", language, "with role:", role);
         if (this._textTracksMap[language]) {
@@ -566,20 +497,12 @@ export class SenzaShakaPlayer extends shaka.Player {
         super.selectTextLanguage(language, role);
     }
 
-    /**
-     * Overrides the setTextTrackVisibility method to use the remote player's text track visibility settings.
-     * @param {boolean} visible - Whether the text tracks should be visible.
-     */
     setTextTrackVisibility(visible) {
         sdkLogger.log("Setting text track visibility to:", visible);
         remotePlayer.setTextTrackVisibility(visible);
         super.setTextTrackVisibility(visible);
     }
 
-    /**
-     * Helper function that makes it easier to check if lifecycle.state is
-     * either background or inTransitionToBackground.
-     */
     get isInRemotePlayback() {
         return lifecycle.state === lifecycle.UiState.BACKGROUND || lifecycle.state === lifecycle.UiState.IN_TRANSITION_TO_BACKGROUND;
     }
@@ -645,12 +568,6 @@ export class SenzaShakaPlayer extends shaka.Player {
         this.dispatchEvent(new shaka.util.FakeEvent("error", errorMap));
     }
 
-    /**
-     * Loads a media URL into both local and remote players.
-     *
-     * @param {string} url - The URL of the media to load.
-     * @returns {Promise<void>}
-     */
     async load(url, startTime, mimeType) {
 
         // Create a promise that will resolve when _remotePlayerLoad is called
@@ -737,13 +654,6 @@ export class SenzaShakaPlayer extends shaka.Player {
 
     }
 
-    /***
-     *
-     * Configure the Player instance.
-     * @param {Object} config the configuration object
-     * @returns {Boolean}
-     */
-
     async destroy() {
         await lifecycle.moveToForeground();
         SenzaShakaPlayer._prevInstance = null;
@@ -751,10 +661,6 @@ export class SenzaShakaPlayer extends shaka.Player {
         return super.destroy();
     }
 
-    /**
-    * A temporary override for older versions of Shaka.
-    * Senza doesn't support out-of-band subtitles
-    */
     addTextTrack(uri, language, kind, mimeType, codec, label, forced = false) {
         sdkLogger.warn("addTextTrack is deprecated, please use addTextTrackAsync");
         super.addTextTrackAsync(uri, language, kind, mimeType, codec, label, forced).then(subs => {
@@ -762,20 +668,6 @@ export class SenzaShakaPlayer extends shaka.Player {
         });
     }
 
-    /**
-     * Override the configure method to add custom configuration handling
-     * Supports the following additional configuration options:
-     * - shouldStopOnRemotePlayerError: boolean - If true, local player will be stopped on remote player error
-     *
-     * @override
-     * @param {Object} config - Configuration object to be merged with existing config
-     * @param {boolean} [config.shouldStopOnRemotePlayerError=true] - Whether to stop local player on remote player error
-     * @example
-     * player.configure({
-     *   shouldStopOnRemotePlayerError: false,  // Don't stop local playback  on remote player error
-     *   // ... other shaka configurations
-     * });
-     */
     configure(config) {
         sdkLogger.log("configure player with: ", JSON.stringify(config));
 

package/src/interface/alarmManager.js

@@ -1,31 +1,28 @@
 import { noop } from "./utils";
+
+/**
+ * alarm event
+ *
+ * @event AlarmManager#MyAlarm
+ * @description Fired when time of 'MyAlarm' arrives. If this alarm triggers the application load and the application doesn't call
+ * lifecycle.moveToForeground() in the alarm callback (i.e. the application remains in the background after the callback is completed),
+ * the application will be unloaded.
+ * NOTE: If you perform async operations in the callback (without moving to foreground), you must wait for the async
+ * operation to finish before returning from the callback, otherwise the application will be unloaded before the async operation is finished.<br>
+ * @example
+ * alarmManager.addEventListener("MyAlarm", async (e) => {
+ *     console.log("alarm MyAlarm arrived with data", e.detail);
+ *     await fetch("http://www.example.com");
+ * });
+ * alarmManager.addAlarm("MyAlarm", Date.now() + 60*60*1000, "MyData");
+ */
+
 /**
- * @class AlarmManager
  * AlarmManager is a singleton class that manages the alarms in the application. It fires events whose types are the names of the alarms.
  * @fires MyAlarm
  */
 export class AlarmManager extends EventTarget {
 
-    /**
-     * alarm event
-     *
-     * @event AlarmManager#MyAlarm
-     * @description Fired when time of 'MyAlarm' arrives. If this alarm triggers the application load and the application doesn't call
-     * lifecycle.moveToForeground() in the alarm callback (i.e. the application remains in the background after the callback is completed),
-     * the application will be unloaded.
-     * NOTE: If you perform async operations in the callback (without moving to foreground), you must wait for the async
-     * operation to finish before returning from the callback, otherwise the application will be unloaded before the async operation is finished.<br>
-     * @example
-     * alarmManager.addEventListener("MyAlarm", async (e) => {
-     *     console.log("alarm MyAlarm arrived with data", e.detail);
-     *     await fetch("http://www.example.com");
-     * });
-     * alarmManager.addAlarm("MyAlarm", Date.now() + 60*60*1000, "MyData");
-     */
-    constructor() {
-        super();
-    }
-
     addEventListener(type, callback) {
         noop("AlarmManager.addEventListener", type, callback);
     }
@@ -67,3 +64,13 @@ export class AlarmManager extends EventTarget {
         return noop("AlarmManager.getActiveAlarms");
     }
 }
+
+/**
+ * @module
+ * @type {AlarmManager}
+ * @example
+ * import { alarmManager } from "senza-sdk";
+ *
+ * @return {AlarmManager} pointer to the AlarmManager singleton
+ */
+"needed for the module doc comment to be recognized";

package/src/interface/deviceManager.js

@@ -1,30 +1,24 @@
 import { sdkLogger, noop } from "./utils.js";
 
-const wifiInfo = {};
-
+const wifiInfo = {
+    level: 0,
+    quality: 0,
+    ssid: "unknown",
+    bssid: "unknown"
+};
+/**
+ * @deprecated Instead, call deviceManager.getWifiInfo() periodically
+ * @event DeviceManager#wifiInfoUpdated
+ * @example
+ * deviceManager.addEventListener("wifiInfoUpdated", () => {
+ *   console.info("Wifi info has been updated to", deviceManager.wifiInfo);
+ * });
+ *
+ */
 /**
- * @class DeviceManager
  * DeviceManager is a singleton class that manages the device
  */
 export class DeviceManager extends EventTarget {
-
-    constructor() {
-        super();
-        wifiInfo.level = 0;
-        wifiInfo.quality = 0;
-        wifiInfo.ssid = "unknown";
-        wifiInfo.bssid = "unknown";
-        /**
-         * @deprecated Instead, call deviceManager.getWifiInfo() periodically
-         * @event DeviceManager#wifiInfoUpdated
-         * @example
-         * deviceManager.addEventListener("wifiInfoUpdated", () => {
-         *   console.info("Wifi info has been updated to", deviceManager.wifiInfo);
-         * });
-         *
-         */
-    }
-
     /**
      * @property {object} DeviceInfo
      * @property {string} DeviceInfo.deviceId
@@ -131,3 +125,18 @@ export class DeviceManager extends EventTarget {
         return Promise.resolve({});
     }
 }
+
+
+/**
+ * @module
+ * @type {DeviceManager}
+ * @example
+ * import { deviceManager } from "senza-sdk";
+ * const wifiInfo = await deviceManager.getWifiInfo();
+ * console.info(wifiInfo.ssid);
+ * await deviceManager.clearWifi();
+ * deviceManager.reboot();
+ *
+ * @return {DeviceManager} pointer to the DeviceManager singleton
+ */
+"needed for the module doc comment to be recognized";

package/src/interface/lifecycle.js

@@ -1,13 +1,42 @@
-/* eslint-disable no-empty-function */
-/* eslint-disable no-unused-vars */
 import {
     sdkLogger,
     noop
 } from "./utils.js";
+/**
+ * @event Lifecycle#onstatechange
+ * @description Fired after transition from one state to another.<br>
+ * The flow is: foreground --> inTransitionToBackground --> background --> inTransitionToForeground --> foreground
+ * @property {UiState} state - Indicates the new state.
+ * @example
+ * lifecycle.addEventListener("onstatechange", (e) => {
+ *     console.log("new state is", e.state);
+ * });
+ */
+
+/**
+ * @event Lifecycle#userinactivity
+ * @description Fired after the ui has been inactive (i.e. no key presses) for a configurable number of seconds.<br>
+ * @property {number} timeout - the number of seconds after which the application will be unloaded.
+ * @example
+ * lifecycle.addEventListener("userinactivity", (e) => {
+ *     console.log(`Application will be unloaded in ${e.timeout} seconds`);
+ * });
+ * @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. 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");
+ *     // Perform any necessary cleanup here
+ * });
+ */
 
 /**
   * Lifecycle is a singleton class that manages the application lifecycle states.<br>
-  * @class Lifecycle
   * @fires onstatechange
   * @fires userinactivity
   * @fires userdisconnected
@@ -50,42 +79,6 @@ export class Lifecycle extends EventTarget {
         IN_TRANSITION_TO_BACKGROUND: "inTransitionToBackground"
     });
 
-    /**
-     * @event Lifecycle#onstatechange
-     * @description Fired after transition from one state to another.<br>
-     * The flow is: foreground --> inTransitionToBackground --> background --> inTransitionToForeground --> foreground
-     * @property {UiState} state - Indicates the new state.
-     * @example
-     * lifecycle.addEventListener("onstatechange", (e) => {
-     *     console.log("new state is", e.state);
-     * });
-     */
-
-    /**
-     * @event Lifecycle#userinactivity
-     * @description Fired after the ui has been inactive (i.e. no key presses) for a configurable number of seconds.<br>
-     * @property {number} timeout - the number of seconds after which the application will be unloaded.
-     * @example
-     * lifecycle.addEventListener("userinactivity", (e) => {
-     *     console.log(`Application will be unloaded in ${e.timeout} seconds`);
-     * });
-     * @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. 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");
-     *     // Perform any necessary cleanup here
-     * });
-     */
-    constructor() {
-        super();
-    }
-
     /**
      * Configure lifecycle settings
      * @param {Object} config - Configuration object
@@ -96,6 +89,7 @@ export class Lifecycle extends EventTarget {
      * @param {number|false} [config.autoBackground.timeout.idle=false] - Timeout in seconds when in UI mode, false to disable
      */
     configure(config) {
+        noop("lifecycle.configure", config);
     }
 
     /**
@@ -276,3 +270,14 @@ export class Lifecycle extends EventTarget {
         super.removeEventListener(type, listener, options);
     }
 }
+
+
+/**
+ * @module
+ * @type {Lifecycle}
+ * @example
+ * import { lifecycle } from "senza-sdk";
+ *
+ * @return {Lifecycle} pointer to the Lifecycle singleton
+ */
+"needed for the module doc comment to be recognized";

package/src/interface/messageManager.js

@@ -1,39 +1,36 @@
 
 import { noop } from "./utils";
+
+/**
+ * @typedef {object} MessageDetails - object which contains the content of the message
+ * @property {string} eventName - The name of the event message, a property of MessageDetails
+ * @property {object} payload - The payload for this event, a property of MessageDetails
+ * @property {string} fcid - The flow context for this message, a property of MessageDetails
+ */
+
+/**
+ * message event
+ *
+ * @event MessageManager#message
+ * @type {CustomEvent}
+ * @property {MessageDetails} detail - object containing data related to the event:
+
+ *
+ * @description Fired when an external event arrives. This is a generic handler for all messages received for any registered group <br>
+ * @example
+ * messageManager.addEventListener("message", (e) => {
+ *     console.log("message arrived with data", e.detail);
+ * });
+ *
+ */
+
 /**
  * MessageManager is a singleton class that manages the external messages received by the application. It fires custom events as "message" with the payload as the content
  * @class MessageManager
  * @fires MessageManager#message
  */
-
 export class MessageManager extends EventTarget {
 
-    /**
-     * @typedef {object} MessageDetails - object which contains the content of the message
-     * @property {string} eventName - The name of the event message, a property of MessageDetails
-     * @property {object} payload - The payload for this event, a property of MessageDetails
-     * @property {string} fcid - The flow context for this message, a property of MessageDetails
-     */
-
-    /**
-     * message event
-     *
-     * @event MessageManager#message
-     * @type {CustomEvent}
-     * @property {MessageDetails} detail - object containing data related to the event:
-
-     *
-     * @description Fired when an external event arrives. This is a generic handler for all messages received for any registered group <br>
-     * @example
-     * messageManager.addEventListener("message", (e) => {
-     *     console.log("message arrived with data", e.detail);
-     * });
-     *
-     */
-    constructor() {
-        super();
-    }
-
     /** Register to specific group(s). This function replaces the previously registered groups
      * @param {Array<String>} groups group events to receive messages.
      * @return {Promise} Promise which is resolved when the registerGroups command has been successfully processed.
@@ -44,3 +41,13 @@ export class MessageManager extends EventTarget {
         return noop("MessageManager.registerGroups", groups);
     }
 }
+
+/**
+ * @module
+ * @type {MessageManager}
+ * @example
+ * import { MessageManager } from "senza-sdk";
+ *
+ * @return {MessageManager} pointer to the MessageManager singleton
+ */
+"needed for the module doc comment to be recognized";

package/src/interface/platformManager.js

@@ -1,14 +1,9 @@
 import { noop } from "./utils";
 /**
- * @class PlatformManager
  * PlatformManager is a singleton class that manages the platform
  */
 export class PlatformManager extends EventTarget {
 
-    constructor() {
-        super();
-    }
-
     /**
      * @returns {Object} appConfig object
      * @property {String[]} territories - a list of territories configured for the tenant.
@@ -33,3 +28,14 @@ export class PlatformManager extends EventTarget {
     }
 }
 
+/**
+ * @module
+ * @type {PlatformManager}
+ * @example
+ * import { platformManager } from "senza-sdk";
+ * console.info(platformManager.appConfig);
+ * platformManager.setTimezone("Europe/Brussels");
+ *
+ * @return {PlatformManager} pointer to the PlatformManager singleton
+ */
+"needed for the module doc comment to be recognized";