This page covers changes to the Client Library. For changes to the platform, see the Release Notes.

Changelog

All notable changes to this package are documented in this file.

[4.2.45] - 2025-03-24

Added

lifecycle:
- Added new event userdisconnected that fires when the user session ends, allowing applications to clean up resources before the application closes

[4.2.44] - 2025-03-23

Fixed

remotePlayer:
lifecycle:
- Fixed internal apis to only enable audio/video sync and seamless transition when configured and the local video is attached.

[4.2.43] - 2025-03-23

Added

Add device model number to deviceManager.deviceInfo api

[4.2.42] - 2025-03-19

Fixed

remotePlayer:
- Fixed License processing to treat all 2xx statusCode as success

[4.2.40] - 2025-03-18

Fixed

remotePlayer:
- Fixed remotePlayer.pause to pause the specific audio/video streams based on the lifecycle.state

[4.2.39] - 2025-03-17

Added

deviceManager:
- deviceInfo now include new field connectionType which indicates whether the current connection is from real device or simulator.

[4.2.38] - 2025-03-16

Fixed

Fix race condition when performing remotePlayer.selectAudioTrack and remotePlayer.selectTextTrack in a short period of time during playback can cause an incorrect selected track

[4.2.37] - 2025-03-13

Fixed

remotePlayer:
- Fixed the internal API remotePlayer.selectAudioTrack to use remotePlayer position if videoElement is not attached.
- Fixed the internal API remotePlayer.selectTextTrack to use remotePlayer position if videoElement is not attached.

[4.2.36] - 2025-03-12

Fixed

lifecycle:
- Update internal API _moveToUiStandby to set _inTransition to false when ended.

[4.2.35] - 2025-03-12

Changed

remotePlayer:
- Enhanced the internal API remotePlayer.selectAudioTrack to skip changes if the language is already selected.
- Enhanced the internal API remotePlayer.selectTextTrack to skip changes if the language is already selected.

[4.2.34] - 2025-03-10

Added

Add log for trigger event of type getLicense

[4.2.33] - 2025-03-10

Added

Enhanse automatic background switching functionality of the lifecycle module to have a different timers according to the play status.

When enabled, the application automatically moves to background state after a configurable period of inactivity
Automatically returns to foreground state on any key press
Configurable separate timeouts for video playback and UI states
Can be configured via API

// Option 1: Configure via JavaScript API
import { lifecycle } from "senza-sdk";

// Enable auto-background with default timers
lifecycle.autoBackground = true;

// Configure custom timeout for video playback (in seconds)
lifecycle.autoBackgroundDelay = 45;  // 45 seconds of inactivity while video is playing

// Configure custom timeout for UI state (in seconds)
lifecycle.autoBackgroundOnUIDelay = 60;  // 60 seconds of inactivity while in UI

// Disable auto-background
lifecycle.autoBackground = false;

[4.2.32] - 2025-03-10

Added

senzaShakaPlayer: Added field request.originatesFromRemotePlayer to the license request to indicate when a license request comes from the remote player.

player.getNetworkingEngine().registerRequestFilter(function(type, request, context) {
  if (type == shaka.net.NetworkingEngine.RequestType.LICENSE) {
    if (request.originatesFromRemotePlayer) { 
       // this license request is from the remote player 
    } else {
      // this license request is from the local player 
   }
  }
});

[4.2.31] - 2025-03-09

Removed

Remove warning of unknown trigger event type (in order to support all types of events)

[4.2.30] - 2025-03-09

Fixed

In remotePlayer, fixed removal of seek related events listeners in detach flow

[4.2.29] - 2025-03-08

Changed

'senzaShakaPlayer':
- The pause will automatically move the application to the foreground.

[4.2.28] - 2025-03-06

Changed

remotePlayer:
- Updated internal API remotePlayer.selectAudioTrack to resolve immediately for API version 1.
- Updated internal API remotePlayer.selectTextTrack to resolve immediately for API version 1.

[4.2.27] - 2025-03-06

Added

Support for Pause and Seek operations on the RemotePlayer.

[4.2.26] - 2025-03-05

Added

senzaShakaPlayer:
- Support for new API getTextLanguages: get a list of supported subtitles languages.
- Support for new API getAudioLanguages: get a list of supported audio languages.
- Support for new API selectTextLanguage: select a specific subtitle language to play.
- Support for new API selectAudioLanguage: select a specific audio language to play.
- Support for new API setTextTrackVisibility: set whether the subtitles are enabled/disabled.

Changed

remotePlayer:
- Updated internal API remotePlayer.selectAudioTrack returns a Promise resolving when the selection process is complete.
- Updated internal API remotePlayer.selectTextTrack returns a Promise resolving when the selection process is complete.

[4.2.25] - 2025-03-04

Changed

lifecycle.moveToUiStandby() is removed and integrated into lifecycle.moveToBackground()
play mode is added in remotePlayer that indicates if the remote player is playing or not.

[4.2.24] - 2025-03-04

Fixed

In senzaShakaPlayer, wait for remotePlayer.unload to finish before calling remotePlater.load

[4.2.23] - 2025-03-03

Changed

Add support for remote player error handing based on Shaka Player error handler. When remote player is sending error, the Shaka player can be configured to stop local playback in case of critical error. The error will be reported with the remote player error code as an extra data.

[4.2.22] - 2025-02-27

Fixed

senzaShakaPlayer: When creating a new instance, if there is already an instance of SenzaShakaPlayer that wasn't destroyed, we disconnect from the previuos instance all of the event listeners between videoElement <-> SenzaShakaPlaye <-> remotePlayer.
remotePlayer: Updated internal API remotePlayer.load to take into consideration the preferred languages in earlier loading stage.

[4.2.21] - 2025-02-25

Fixed

senzaShakaPlayer: Fixed start from position for remotePlayer

[4.2.20] - 2025-02-25

Changed

Disable subtitles auto translation tracks by default.

[4.2.19] - 2025-02-24

Fixed

senzaShakaPlayer: Fixed issue where remote player attachment failed when video element was provided in constructor

[4.2.18] - 2025-02-24

Changed

Updated internal remotePlayer.Pause api

[4.2.17] - 2025-02-20

Added

Added an export of the full shaka module where shaka.Player is our SenzaShakaPlayer

import senza from 'senza-sdk';
const player = new senza.shaka.Player(); 
// all other shaka modules are also available, e.g. senza.shaka.net

// The export of ShakaPlayer still works
const player = new senza.ShakaPlayer();

[4.2.16] - 2025-02-18

Added

Added autobackground/autoforeground functionality to the lifecycle module.
when lifecycle.autoBackground = true we will go to background after lifecycle.autoBackgroundDelay seconds,
and will go to foreground on any keypress.

[4.2.15] - 2025-02-11

Added

Terminate the ui if the application was loaded due to an alarm and didn't move to foreground

[4.2.14] - 2025-02-11

Added

Add a new property APPLICATION_RELOAD to ConnectReason which indicates that ui app has been reloaded (e.g. after HOME keypress)

[4.2.13] - 2025-02-10

Changed

When configured to use the new internal remote apis:
- The lifecycle.moveToForeground and lifecycle.moveToBackground apis will wait for actual confirmation of the remote player connector
- The remotePlayer.play api will wait for actual confirmation of the remote player connector

[4.2.12] - 2025-02-09

Changed

Internal enhancement to alarmManager.addAlarm api

[4.2.11] - 2025-02-04

Changed

Support detaching media element by using Senza Shaka player detach method, or directly in remote player. This enables detaching the video element from the remote plater and attaching it again to a different element.

[4.2.10] - 2025-02-03

Changed

Support adding media element using Senza Shaka player attach method, as alternative to passing it to the constructor. This aligns with Shaka Player API. Note that the API for adding the media element in the constructor is going to be deprecated in version 5.0 of Shaka player.

[4.2.9] - 2025-02-02

Fixed

Fix bug that prevents the subtitles to be turned off

[4.2.8] - 2025-01-28

Added

Implement new internal remote player apis

[4.2.7] - 2025-01-26

Fixed

Reject call to remotePlayer.load if current load mode is remotePlayer.LoadMode.UNLOADING
Reject call to remotePlayer.unload if current load mode is remotePlayer.LoadMode.UNLOADING
Tag remotePlayer.unload as alpha

[4.2.6] - 2025-01-16

Fixed

Fix bug of sync local/remote player in the simulator

[4.2.5] - 2025-01-14

Fixed

Fix mistake in jsdocs of lifecycle.moveToUiStandby function

[4.2.4] - 2025-01-14

Fixed

Fix mistake in jsdocs of timeout property of userinactivity event

[4.2.3] - 2025-01-12

Added

Introducing a new tag alpha to indicate that an API has not yet been released. When released, tag will be removed. If no tagging, API is in released state and fully trusted.
This includes deviceManager.getWifiInfo, lifecycle.moveToUiStandby and userinactivity which are tagged as alpha.

[4.2.2] - 2025-01-06

Changed

Upon receiving a timeupdate event, senza sdk now synchronizes the local player time to the remote player time.
The web application will no longer need to set the local player time if the local player video tag is attached to the remote player.

[4.2.1] - 2025-01-02

Changed

When moving the application to background (by calling lifecycle.moveToBackground()), senza sdk now synchronizes the remote player time to the local player time.
The web application will no longer need to set the remote player time if the local player video tag is attached to the remote player.

[4.2.0] - 2025-01-01

Added

Added SenzaShakaPlayer (experimental). The SenzaShakaPlayer is a subclass of the Shaka player that seamlessly handles playback of both local and remote players. It abstracts the complexities of switching between local playback using Shaka Player and remote playback using the Senza cloud connector.

[4.1.6] - 2024-12-25

Changed

Remove internal calls to deprecated api lifecycle.getState() and use lifecycle.state instead.

[4.1.5] - 2024-12-12

Removed

Remove unused vars that were used only for testing purposes

[4.1.4] - 2024-12-10

Added

Expose all senza APIs on window.senza for testing purposes

[4.1.3] - 2024-12-04

Added

userinactivity event added on lifecycle module. Release stage is alpha.
A new api lifecycle.moveToUiStandby() to move the application into standby mode. Release stage is alpha.

[4.1.2] - 2024-12-09

Changed

added state checks to lifecycle.moveToForeground and lifecycle.moveToBackground

[4.1.1] - 2024-12-05

Changed

lifecycle.moveToForeground and lifecycle.moveToBackground to return promise

[4.1.0] - 2024-12-05

Deprecated

Function lifecycle.getState is deprecated. Use lifecycle.state instead.

Added

A new api lifecycle.state to get the current lifecycle ui state

[4.0.9] - 2024-12-04

Changed

Internal change of property names for testing purposes

[4.0.8] - 2024-12-02

Added

Expose deviceManager on the window object for testing purposes

[4.0.7] - 2024-11-28

Deprecated

Property deviceManager.wifiInfo is deprecated. Use deviceManager.getWifiInfo() instead.
Event DeviceManager#wifiInfoUpdated is deprecated. Call deviceManager.getWifiInfo() as often as you want (the data will be refreshed only every 5 seconds)

Added

A new api deviceManager.getWifiInfo() to get Wi-Fi access point data and status. Release stage is alpha.

[4.0.6] - 2024-11-28

Added

exported devSequence functions in api

[4.0.5] - 2024-11-27

Added

new devSequence component to monitor API calls

[4.0.4] - 2024-11-26

Added

A new api remotePlayer.unload() to unload a previously loaded url in the remote player. Release stage is alpha.

[4.0.3] - 2024-11-19

Changed

remotePlayer.pause and remotePlayer.play to return promise

[4.0.2] - 2024-11-17

Changed

Change remotePlayer event name from canPlay to canplay to comply with HTMLMediaElement event name

[4.0.1] - 2024-11-17

Changed

Enhancement for setting remotePlayer.currentTime, to update the remote player immediately

[4.0.0] - 2024-11-10

Changed

remotePlayer.play api no longer accepts the boolean parameter moveToBackground. In order to move to background the application must explicitly call lifecycle.moveToBackground()

[3.22.5] - 2024-11-04

Removed

Keypress indicator has been removed from the SDK since it's now handled by the ui-streamer

[3.22.4] - 2024-11-03

Changed

Code refactoring, no api changes. Change internal playback event names from "ERR" to "hs/ERR" and from "EOS" to "hs/EOS".

[3.22.2] - 2024-10-01

Added

Improve local player audio sync by performing seek on big gaps

[3.22.1] - 2024-09-24

Added

Add default value of empty string to the data parameter in alarmManager.addAlarm api

[3.22.0] - 2024-09-08

Added

Implemented the appConfig API in the PlatformManager file.
Returns the application config object including the configured tenant's territories.

Deprecated

setTimeZone() is deprecated, use platformManager.setTimeZone instead.

[3.21.1] - 2024-09-03

Added

new event remotePlayer.canPlay

Changed

API remotePlayer.registerVideoElement marked as deprecated use remotePlayer.attach instead

[3.21.0] - 2024-09-02

Changed

Removed webpack bundling from the npm release to ensure IDE code-completion functions correctly, while continuing to bundle for the CDN release.

[3.20.2] - 2024-07-11

Changed

Lifecycle exitApplication API adds the splashUrl to the "reconnect" message.

[3.20.0] - 2024-07-09

Changed

The SDK was migrated from github registry to the default npm public registry and was renamed to senza-sdk

Install

npm install senza-sdk

Import

import { init, uiReady } from "senza-sdk";

[3.19.9] - 2024-07-04

Changed

Change global library name from 'hs' to 'senza'. For backward compatibility, 'hs' can still be used. This is relevant only for web applications that import the library from the CDN.

[3.19.8] - 2024-06-20

Fixed

Fix build script

[3.19.7] - 2024-06-18

Added

Tests: ES5 import of hs-sdk

[3.19.6] - 2024-06-05

Added

Automatically upload hs-sdk version to the CDN

[3.19.5] - 2024-05-16

Added

Enhance deviceInfo api to return also country code, a 2-letter code as defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

[3.19.4] - 2024-05-13

Fixed

The API registerVideoElement will be listening to video tag info changes all the time without waiting to load and run.

[3.19.3] - 2024-05-02

Fixed

Adding event to videoTag in order to signal remotePlayer about load events on the localPlayer, this is to support sync of audio in UI

[3.19.1] - 2024-03-28

Fixed

deviceManager.deviceInfo now return correct value.

Deprecated

getDeviceInfo() is deprecated, use deviceManager.deviceInfo instead.

[3.18.2] - 2024-03-20

Fixed

Update text and audio tracks when application is loaded after ui release

[3.18.1] - 2024-03-03

Added

New API in remotePlayer module - getPresentationStartTimeAsDate(). It returns the presentation start time as a date.
It should only be called when the player has loaded a live stream. If the player has not loaded a live stream, it will return null.

[3.18.0] - 2024-03-03

Added

Implemented the factoryReset API in the deviceManager file, which issues a factory reset command to the device.
The returned Promise resolves upon receiving device confirmation of a successful reset.

[3.17.3] - 2024-02-29

Added

Override window.close() since it's not allowed on Senza platform (use lifecycle.exitApplication() instead)

[3.17.2] - 2024-02-21

Changed

Increase test coverage

Changed

In logs of remotePlayer load api, change the url field to loadUrl so that it won't override the application url log field.

[3.17.0] - 2024-01-21

Added

In remotePlayer file, added a new registerVideoElement API which will cause the load and play API's
to request for the video element info

[3.16.1] - 2024-01-15

Added

In alarmManager.addAlarm API, a type check was added for the data parameter (must be a string)

[3.16.0] - 2024-01-02

Changed

Move switchTenant and exitApplication APIs from the main entry point to the lifecycle module

[3.15.14] - 2024-01-01

Changed

Upgrade sdk version in sample apps

[3.15.13] - 2024-01-01

Added

Print remote player error event to console log

[3.15.12] - 2023-12-31

Fixed

Handle error and ended events in sample application remotePlayer-startPlayback

[3.15.11] - 2023-12-24

Changed

Change the keys remotePlayer-startPlayback sample app uses. Instead of using only SELECT to toggle start/stop playback, it now uses SELECT to start and BACK to stop.

[3.15.10] - 2023-12-05

Fixed

In order to support server side rendering, set parameters to the window object only if defined

[3.15.8] - 2023-11-08

Added

Add clientIp to getDeviceInfo() returned object

[3.15.7] - 2023-11-08

Changed

Update sample applications and README

[3.15.4] - 2023-11-07

Added

A new api deviceManager.sendDataToDevice(data). This api passes the input data to the device.

[3.15.3] - 2023-10-22

Changed

Improvements for better browser compatibility.

[3.15.2] - 2023-10-19

Added

Documentation for remote player error codes

Changed

If load() is called while the application is in 'background' state, the sdk now throws error 6002 instead of 23

[3.15.1] - 2023-10-18

Changed

Refactored the codebase to use pure ES6 syntax for better browser compatibility.
- Removed usage of require for module imports. Now using ES6 import statements.
- Replaced module.exports with ES6 export statements.
- Code is now bundled into a single file using Webpack, making it easier to import and use in various projects.

[3.14.8] - 2023-10-15

Changed

Load timeout is no longer hard coded 14 seconds, but can be configured in ui-streamer settings and is defaulted to 6 seconds

[3.14.7] - 2023-10-11

Fixed

In case remotePlayer.load() failed due to error 99 (i.e. invalid message), keep the load mode and asset uri as they were before the failure.

[3.14.5] - 2023-09-18

Added

url field has been added to all sdk logs as part of [log-fields]

[3.14.3] - 2023-09-06

Added

Developer helper module that writes to console log "hints" to the developer. Currently, there is one hint implemented - a reminder to call lifecycle.MoveToForeground() upon getting a keypress/error/ended event when in background state.

[3.14.2] - 2023-09-04

Added

Transfer all hs-sdk logs to the following format:
[hs-sdk] <log message> [log-fields] <stringified json of key-value pairs>