senza-sdk 4.3.6 → 4.3.7-b2908c5.0

package/dist/bundle.js.LICENSE.txt

@@ -12,9 +12,27 @@
 
 /*
  @license
- EME Encryption Scheme Polyfill
- Copyright 2019 Google LLC
- SPDX-License-Identifier: Apache-2.0
+ Copyright 2013 Ali Al Dallal
+
+ Licensed under the MIT license.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.
 */
 
 /*
@@ -45,6 +63,13 @@
  SPDX-License-Identifier: Apache-2.0
 */
 
+/*
+ @license
+ Shaka Player
+ Copyright 2025 Google LLC
+ SPDX-License-Identifier: Apache-2.0
+*/
+
 /*
  @license
  tXml

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.3.6",
+    "version": "4.3.7-b2908c5.0",
     "main": "./src/api.js",
     "description": "API for Senza application",
     "license": "MIT",
@@ -53,15 +53,15 @@
                 "statements": 93.46
             },
             "src/interface": {
-                "branches": 68.42,
-                "functions":  39.63,
-                "lines": 64.94,
-                "statements":  65.32
+                "branches": 63.9,
+                "functions": 39.28,
+                "lines": 64.61,
+                "statements": 65
             }
         }
     },
     "dependencies": {
-        "shaka-player": "^4.12.5",
+        "shaka-player": "4.15.8",
         "moment": "^2.30.1"
     }
 }

package/src/implementation/alarmManager.js

@@ -63,21 +63,21 @@ class AlarmManager extends AlarmManagerInterface {
                 const alarmHandlingDuration = Date.now() - timeBeforeAlarmHandling;
                 logger.log(`All callbacks for alarm '${e.detail.alarmName}' are finished within ${alarmHandlingDuration}ms`);
                 // If this alarm triggered the application, and moveToForeground has not been called as a result of the alarm
-                // (i.e. the application is still in the background), we want to intentionally terminate the ui in order to save resources.
+                // (i.e. the application is still in the background), we want to intentionally disconnect the ui in order to save resources.
                 const isTriggering = lifecycle.triggerEvent.type === "alarmFiredEvent" && lifecycle._triggerEventFcid && lifecycle._triggerEventFcid === e.detail.fcid;
                 if (isTriggering) {
                     if (!this._moveToForegroundHasBeenCalled && window.cefQuery) {
-                        logger.log("Application is about to be terminated since didn't move to foreground");
-                        const message = { type: "terminating" };
+                        logger.log("Application is about to be disconnected since didn't move to foreground");
+                        const message = { type: "disconnect" };
                         const request = { target: "TC", waitForResponse: false, message: JSON.stringify(message) };
                         window.cefQuery({
                             request: JSON.stringify(request),
                             persistent: false,
                             onSuccess: () => {
-                                logger.log("terminating request successfully sent");
+                                logger.log("disconnect request successfully sent");
                             },
                             onFailure: (code, msg) => {
-                                logger.error(`terminating request failed: ${code} ${msg}`);
+                                logger.error(`disconnect request failed: ${code} ${msg}`);
                             }
                         });
                     }

package/src/implementation/lifecycle.js

@@ -192,7 +192,7 @@ class Lifecycle extends LifecycleInterface {
             // Use the event manager to dispatch the event and wait for all listeners
             await this._eventManager.dispatch("userdisconnected", event);
 
-            this._sendTerminatingMessage();
+            this._sendDisconnectMessage();
         });
 
         typeof document !== "undefined" && document.addEventListener("keydown", () => {
@@ -777,14 +777,14 @@ class Lifecycle extends LifecycleInterface {
     }
 
     /**
-     * Sends the terminating message to the platform
+     * Sends the disconnect message to the platform
      * @private
      */
-    _sendTerminatingMessage() {
+    _sendDisconnectMessage() {
         if (window.cefQuery) {
             const FCID = getFCID();
             const message = {
-                type: "terminating",
+                type: "disconnect",
                 fcid: FCID
             };
             const request = { target: "TC", waitForResponse: false, message: JSON.stringify(message) };
@@ -793,10 +793,10 @@ class Lifecycle extends LifecycleInterface {
                 request: JSON.stringify(request),
                 persistent: false,
                 onSuccess: () => {
-                    sdkLogger.log("Terminating signal sent after userdisconnected event was processed");
+                    sdkLogger.log("Disconnect signal sent after userdisconnected event was processed");
                 },
                 onFailure: (code, msg) => {
-                    sdkLogger.error(`Failed to send terminating signal: ${code} ${msg}`);
+                    sdkLogger.error(`Failed to send disconnect signal: ${code} ${msg}`);
                 }
             });
         }

package/src/implementation/remotePlayer.js

@@ -1081,24 +1081,30 @@ class RemotePlayer extends RemotePlayerInterface {
      * @throws {RemotePlayerError} If the player is not initialized or not loaded.
      **/
     selectAudioTrack(audioTrackId) {
+        return this._selectAudioTrack(audioTrackId, false);
+    }
+
+    _selectAudioTrack(audioTrackId, force = false) {
         if (!this._isInitialized) {
             throw new RemotePlayerError(6500, "Cannot call selectAudioTrack() if remote player is not initialized");
         }
         if (this._loadMode !== this.LoadMode.LOADED) {
             throw new RemotePlayerError(6001, "Cannot call selectAudioTrack() if remote player is not loaded");
         }
-        let found = false;
-        const prevSelectedAudioTrack = this._selectedAudioTrack;
-        for (const track of this.getAudioTracks()) {
-            if (track.id === audioTrackId) {
-                found = true;
-                break;
+        if (!force) {
+            let found = false;
+            for (const track of this.getAudioTracks()) {
+                if (track.id === audioTrackId) {
+                    found = true;
+                    break;
+                }
+            }
+            if (!found) {
+                sdkLogger.warn(`Invalid audioTrackId ${audioTrackId}`);
+                return Promise.resolve();
             }
         }
-        if (!found) {
-            sdkLogger.warn(`Invalid audioTrackId ${audioTrackId}`);
-            return Promise.resolve();
-        }
+        const prevSelectedAudioTrack = this._selectedAudioTrack;
         if (this._selectedAudioTrack === audioTrackId) {
             return Promise.resolve(); // Audio language already selected
         }
@@ -1115,6 +1121,12 @@ class RemotePlayer extends RemotePlayerInterface {
         }
     }
 
+    async selectAudioLanguage(language, role="", accessibilityPurposeCode=this.AccessibilityPurposeCode.NONE) {
+        const trackId = this._generateSenzaTrackId(language, role, accessibilityPurposeCode);
+        return this._selectAudioTrack(trackId, true);
+    }
+
+
     /**
      * Handles the asynchronous selection of an audio track.
      * If the player is playing, it pauses before changing the track and resumes playback if necessary.
@@ -1208,6 +1220,11 @@ class RemotePlayer extends RemotePlayerInterface {
         return Promise.resolve(undefined);
     }
 
+    async selectTextLanguage(language, role="", accessibilityPurposeCode=this.AccessibilityPurposeCode.NONE) {
+        const trackId = this._generateSenzaTrackId(language, role, accessibilityPurposeCode);
+        return this._selectTextTrack(trackId, true);
+    }
+
     /** Select a specific text (subtitle) track.
      * Track id should come from a call to getTextTracks.
      * If no tracks exist - this is a no-op.
@@ -1217,24 +1234,31 @@ class RemotePlayer extends RemotePlayerInterface {
      * @throws {RemotePlayerError} If the player is not initialized or not loaded.
      * */
     selectTextTrack(textTrackId) {
+        return this._selectTextTrack(textTrackId, false);
+    }
+
+    _selectTextTrack(textTrackId, force = false) {
         if (!this._isInitialized) {
             throw new RemotePlayerError(6500, "Cannot call selectTextTrack() if remote player is not initialized");
         }
         if (this._loadMode !== this.LoadMode.LOADED) {
             throw new RemotePlayerError(6001, "Cannot call selectTextTrack() if remote player is not loaded");
         }
-        let found = false;
-        const prevSelectedTextTrack = this._selectedSubtitlesTrack;
-        for (const track of this.getTextTracks()) {
-            if (track.id === textTrackId) {
-                found = true;
-                break;
+        if (!force) {
+            let found = false;
+            for (const track of this.getTextTracks()) {
+                if (track.id === textTrackId) {
+                    found = true;
+                    break;
+                }
+            }
+            if (!found) {
+                sdkLogger.warn(`Invalid textTrackId ${textTrackId}`);
+                return Promise.resolve();
             }
         }
-        if (!found) {
-            sdkLogger.warn(`Invalid textTrackId ${textTrackId}`);
-            return Promise.resolve();
-        }
+
+        const prevSelectedTextTrack = this._selectedSubtitlesTrack;
         if (this._selectedSubtitlesTrack === textTrackId) {
             return Promise.resolve(); // Subtitle language already selected
         }
@@ -1774,6 +1798,12 @@ class RemotePlayer extends RemotePlayerInterface {
         return setLanguageError ? Promise.reject(setLanguageError) : Promise.resolve();
     }
 
+    _generateSenzaTrackId(language, role, accessibilityPurpose) {
+        const l = language || "";
+        const r = role || "";
+        const ap = accessibilityPurpose || "";
+        return `${l}:${r}:${ap}`;
+    }
     _setScreenBlackout(blackoutTime) {
         if (window.cefQuery) {
             const FCID = getFCID();

package/src/implementation/senzaShakaPlayer.js

@@ -1,10 +1,9 @@
 import { SenzaShakaPlayer as SenzaShakaInterface, shaka } from "../interface/senzaShakaPlayer";
-
+import * as shakaDebug from "shaka-player/dist/shaka-player.compiled.debug.js";
 import { remotePlayer, lifecycle, getPlatformInfo } from "./api";
-import { sdkLogger, iso6393to1 } from "./utils";
+import { sdkLogger } from "./utils";
 import moment from "moment";
 
-
 //  Define custom error category
 shaka.util.Error.Category.SENZA_PLAYER_ERROR = 50;
 shaka.util.Error.Code.SENZA_PLAYER_ERROR = 10500;
@@ -32,7 +31,6 @@ class SenzaError extends shaka.util.Error {
     }
 }
 
-
 export class SenzaShakaPlayer extends SenzaShakaInterface {
     /** @private {SenzaShakaPlayer|null} Previous instance of the player */
     static _prevInstance = null;
@@ -176,32 +174,6 @@ export class SenzaShakaPlayer extends SenzaShakaInterface {
             event.writeLicenseResponse(response.status, responseBody);
 
         },
-        "tracksupdate": () => {
-            this._audioTracksMap = {};
-            this._textTracksMap = {};
-            // create a map between language code and track id to be used for selection. If the language appears more than once the last one will be taken.
-            const audioTracks = remotePlayer.getAudioTracks();
-            for (const track of audioTracks) {
-                let lang = track.lang;
-
-                if (lang.length === 3) {
-                    lang = iso6393to1[lang] || lang;
-                }
-                this._audioTracksMap[lang] = track.id;
-            }
-
-            const textTracks = remotePlayer.getTextTracks();
-            for (const track of textTracks) {
-                if (!track.autoTranslate) {
-                    let lang = track.lang;
-
-                    if (lang.length === 3) {
-                        lang = iso6393to1[lang] || lang;
-                    }
-                    this._textTracksMap[lang] = track.id;
-                }
-            }
-        },
         "playing": async () => {
             sdkLogger.info("remotePlayer playing event received");
             // If playing timeout was not expored, and the feature is set, handle the playing event
@@ -439,8 +411,6 @@ export class SenzaShakaPlayer extends SenzaShakaInterface {
         }
 
         await super.detach(keepAdManager);
-        this._audioTracksMap = {};
-        this._textTracksMap = {};
         this._removeVideoElementEventListeners();
         try {
             if (remotePlayer.getAssetUri() !== "") {
@@ -470,30 +440,65 @@ export class SenzaShakaPlayer extends SenzaShakaInterface {
     }
 
     getTextLanguages() {
-        return Object.keys(this._textTracksMap);
+        const tracks = this.remotePlayer.getTextTracks();
+        return [...new Set(tracks.map(item => item.lang))];
     }
 
     getAudioLanguages() {
-        return Object.keys(this._audioTracksMap);
+        const tracks = this.remotePlayer.getAudioTracks();
+        return [...new Set(tracks.map(item => item.lang))];
+    }
+
+
+    selectVariantTrack(track, clearBuffer = false, safeMargin = 0) {
+        const audioLang = track.language;
+        const audioRole = Array.isArray(track.audioRoles) && track.audioRoles.length > 0
+            ? track.audioRoles[0]
+            : null;
+        const audioId = track.audioId;
+        sdkLogger.log(`selectVariantTrack() called: audio id ${audioId} language ${audioLang}, role ${audioRole}, accessibilityPurpose: ${track.accessibilityPurpose}`);
+
+        const apCode = this._getAccessibilityCodeFromPurpose(track.accessibilityPurpose);
+        remotePlayer.selectAudioLanguage(audioLang, audioRole, apCode);
+
+        super.selectVariantTrack(track, clearBuffer, safeMargin);
+
+    }
+
+    selectAudioTrack(audioTrack, safeMargin = 0) {
+        const audioId = audioTrack.id;
+        const audioLang = audioTrack.language;
+        const role = Array.isArray(audioTrack.roles) && audioTrack.roles.length > 0
+            ? audioTrack.roles[0]
+            : null;
+        sdkLogger.log(`selectAudioTrack() called: audio id ${audioId} language ${audioLang}, role ${role}, accessibilityPurpose: ${audioTrack.accessibilityPurpose}`);
+        const apCode = this._getAccessibilityCodeFromPurpose(audioTrack.accessibilityPurpose);
+        remotePlayer.selectAudioLanguage(audioLang, role, apCode);
+
+        super.selectAudioTrack(audioTrack, safeMargin);
     }
 
     selectAudioLanguage(language, role) {
-        sdkLogger.log("Selecting audio language:", language, "with role: ", role);
-        if (this._audioTracksMap[language]) {
-            remotePlayer.selectAudioTrack(this._audioTracksMap[language]);
-        } else {
-            sdkLogger.warn(`Language ${language} not found in audio tracks map`);
-        }
+        sdkLogger.log("selectAudioLanguage() Selecting audio language:", language, "with role: ", role);
+        remotePlayer.selectAudioLanguage(language, role);
         super.selectAudioLanguage(language, role);
     }
 
+    selectTextTrack(textTrack) {
+        const textId = textTrack.id;
+        const textLang = textTrack.language;
+        const role = Array.isArray(textTrack.roles) && textTrack.roles.length > 0
+            ? textTrack.roles[0]
+            : null;
+        sdkLogger.log(`selectTextTrack() called: text id ${textId} language ${textLang}, role ${role}, accessibilityPurpose: ${textTrack.accessibilityPurpose}`);
+        const apCode = this._getAccessibilityCodeFromPurpose(textTrack.accessibilityPurpose);
+        remotePlayer.selectTextLanguage(textLang, role, apCode);
+
+        super.selectTextTrack(textTrack);
+    }
     selectTextLanguage(language, role) {
-        sdkLogger.log("Selecting text language:", language, "with role:", role);
-        if (this._textTracksMap[language]) {
-            remotePlayer.selectTextTrack(this._textTracksMap[language]);
-        } else {
-            sdkLogger.warn(`Language ${language} not found in text tracks map`);
-        }
+        sdkLogger.log("selectTextLanguage() Selecting text language:", language, "with role: ", role);
+        remotePlayer.selectTextLanguage(language, role);
         super.selectTextLanguage(language, role);
     }
 
@@ -720,7 +725,6 @@ export class SenzaShakaPlayer extends SenzaShakaInterface {
         };
 
         if (!this.isInRemotePlayback || remotePlayer.getAssetUri() !== url) {
-            this._audioTracksMap = {};
             this._videoTracksMap = {};
             try {
                 if (this.remotePlayer.getLoadMode() === this.remotePlayer.LoadMode.UNLOADING) {
@@ -775,6 +779,32 @@ export class SenzaShakaPlayer extends SenzaShakaInterface {
         }
     }
 
+    /**
+     * Returns accessibility code of Shaka's accessibility purpose string
+     * @param {string} purpose
+     * @returns {null|string}
+     * @private
+     */
+    _getAccessibilityCodeFromPurpose(purpose) {
+        switch (purpose) {
+        case shakaDebug.media.ManifestParser.AccessibilityPurpose.VISUALLY_IMPAIRED:
+            return remotePlayer.AccessibilityPurposeCode.VISUALLY_IMPAIRED;
+        case shakaDebug.media.ManifestParser.AccessibilityPurpose.HARD_OF_HEARING:
+            return remotePlayer.AccessibilityPurposeCode.HARD_OF_HEARING;
+        case shakaDebug.media.ManifestParser.AccessibilityPurpose.SPOKEN_SUBTITLES:
+            return remotePlayer.AccessibilityPurposeCode.SPOKEN_SUBTITLES;
+        case undefined:
+        case null:
+        case "":
+            return remotePlayer.AccessibilityPurposeCode.NONE;
+        default:
+            sdkLogger.warn(`_getAccessibilityCodeFromPurpose(): unknown accessibilityPurpose ${purpose}`);
+            return remotePlayer.AccessibilityPurposeCode.NONE;
+        }
+
+    }
+
+
 }
 
 shaka.Player = SenzaShakaPlayer;

package/src/implementation/utils.js

@@ -163,209 +163,3 @@ export const TargetPlayingState = Object.freeze({
     PLAYING_UI: "playingUi",
     PLAYING_ABR: "playingAbr"
 });
-
-export const iso6393to1 = {
-    "aar": "aa",
-    "abk": "ab",
-    "afr": "af",
-    "aka": "ak",
-    "alb": "sq",
-    "amh": "am",
-    "ara": "ar",
-    "arg": "an",
-    "arm": "hy",
-    "asm": "as",
-    "ava": "av",
-    "ave": "ae",
-    "aym": "ay",
-    "aze": "az",
-    "bak": "ba",
-    "bam": "bm",
-    "baq": "eu",
-    "bel": "be",
-    "ben": "bn",
-    "bih": "bh",
-    "bis": "bi",
-    "bod": "bo",
-    "bos": "bs",
-    "bre": "br",
-    "bul": "bg",
-    "bur": "my",
-    "cat": "ca",
-    "ces": "cs",
-    "cha": "ch",
-    "che": "ce",
-    "chi": "zh",
-    "chu": "cu",
-    "chv": "cv",
-    "cor": "kw",
-    "cos": "co",
-    "cre": "cr",
-    "cym": "cy",
-    "dan": "da",
-    "deu": "de",
-    "div": "dv",
-    "dut": "nl",
-    "dzo": "dz",
-    "ell": "el",
-    "eng": "en",
-    "epo": "eo",
-    "est": "et",
-    "eus": "eu",
-    "ewe": "ee",
-    "fao": "fo",
-    "fas": "fa",
-    "fij": "fj",
-    "fin": "fi",
-    "fra": "fr",
-    "fre": "fr",
-    "fry": "fy",
-    "ful": "ff",
-    "geo": "ka",
-    "ger": "de",
-    "gla": "gd",
-    "gle": "ga",
-    "glg": "gl",
-    "glv": "gv",
-    "gre": "el",
-    "grn": "gn",
-    "guj": "gu",
-    "hat": "ht",
-    "hau": "ha",
-    "heb": "he",
-    "her": "hz",
-    "hin": "hi",
-    "hmo": "ho",
-    "hrv": "hr",
-    "hun": "hu",
-    "hye": "hy",
-    "ibo": "ig",
-    "ice": "is",
-    "ido": "io",
-    "iii": "ii",
-    "iku": "iu",
-    "ile": "ie",
-    "ina": "ia",
-    "ind": "id",
-    "ipk": "ik",
-    "isl": "is",
-    "ita": "it",
-    "jav": "jv",
-    "jpn": "ja",
-    "kal": "kl",
-    "kan": "kn",
-    "kas": "ks",
-    "kat": "ka",
-    "kau": "kr",
-    "kaz": "kk",
-    "khm": "km",
-    "kik": "ki",
-    "kin": "rw",
-    "kir": "ky",
-    "kom": "kv",
-    "kon": "kg",
-    "kor": "ko",
-    "kua": "kj",
-    "kur": "ku",
-    "lao": "lo",
-    "lat": "la",
-    "lav": "lv",
-    "lim": "li",
-    "lin": "ln",
-    "lit": "lt",
-    "ltz": "lb",
-    "lub": "lu",
-    "lug": "lg",
-    "mac": "mk",
-    "mah": "mh",
-    "mal": "ml",
-    "mao": "mi",
-    "mar": "mr",
-    "may": "ms",
-    "mkd": "mk",
-    "mlg": "mg",
-    "mlt": "mt",
-    "mon": "mn",
-    "mri": "mi",
-    "msa": "ms",
-    "mya": "my",
-    "nau": "na",
-    "nav": "nv",
-    "nbl": "nr",
-    "nde": "nd",
-    "ndo": "ng",
-    "nep": "ne",
-    "nld": "nl",
-    "nno": "nn",
-    "nob": "nb",
-    "nor": "no",
-    "nya": "ny",
-    "oci": "oc",
-    "oji": "oj",
-    "ori": "or",
-    "orm": "om",
-    "oss": "os",
-    "pan": "pa",
-    "per": "fa",
-    "pli": "pi",
-    "pol": "pl",
-    "por": "pt",
-    "pus": "ps",
-    "que": "qu",
-    "roh": "rm",
-    "ron": "ro",
-    "rum": "ro",
-    "run": "rn",
-    "rus": "ru",
-    "sag": "sg",
-    "san": "sa",
-    "sin": "si",
-    "slk": "sk",
-    "slo": "sk",
-    "slv": "sl",
-    "sme": "se",
-    "smo": "sm",
-    "sna": "sn",
-    "snd": "sd",
-    "som": "so",
-    "sot": "st",
-    "spa": "es",
-    "sqi": "sq",
-    "srd": "sc",
-    "srp": "sr",
-    "ssw": "ss",
-    "sun": "su",
-    "swa": "sw",
-    "swe": "sv",
-    "tah": "ty",
-    "tam": "ta",
-    "tat": "tt",
-    "tel": "te",
-    "tgk": "tg",
-    "tgl": "tl",
-    "tha": "th",
-    "tib": "bo",
-    "tir": "ti",
-    "ton": "to",
-    "tsn": "tn",
-    "tso": "ts",
-    "tuk": "tk",
-    "tur": "tr",
-    "twi": "tw",
-    "uig": "ug",
-    "ukr": "uk",
-    "urd": "ur",
-    "uzb": "uz",
-    "ven": "ve",
-    "vie": "vi",
-    "vol": "vo",
-    "wel": "cy",
-    "wln": "wa",
-    "wol": "wo",
-    "xho": "xh",
-    "yid": "yi",
-    "yor": "yo",
-    "zha": "za",
-    "zho": "zh",
-    "zul": "zu"
-};