Shaka Player

The ShakaPlayer class is a subclass of the Shaka player that keeps the remote player synchronized automatically.

In addition, the full shaka module is exposed under the shaka namespace. Within this namespace, shaka.Player serves as a reference to the ShakaPlayer class provided by the senza-sdk. All other modules, such as net and ui, are also available.

import { shaka } from "senza-sdk";

// shaka.Player
let player = new shaka.Player(video); // the same as "new ShakaPlayer(video)"

// other modules are available
// e.g. shaka.net.NetworkingEngine.RequestType.LICENSE

Constructor

• constructor(mediaElement) — pass in the video element to use in the local player

Functions

These functions are overridden from the Shaka superclass:

• (async) load(url) — loads a video, but does not play it automatically
• configureDrm(server) — allows you specify the DRM server

The class listens for events from the media element to keep the remote player in sync. For example, if you play or pause the video, it will automatically play or pause in the remote player. It automatically keeps the current time in the remote player in sync with the browser. That way when you switch between foreground and background mode, the video will play continuously.

Usage

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

const TEST_VIDEO = "https://dash.akamaized.net/akamai/bbb_30fps/bbb_30fps.mpd";

let player;

window.addEventListener("load", async () => {
  try {
    await init();
    player = new ShakaPlayer(video);
    await player.load(TEST_VIDEO);
    await video.play();
    uiReady();
  } catch (error) {
    console.error(error);
  }
});

async function toggleBackground() {
  if (lifecycle.state == lifecycle.UiState.BACKGROUND) {
    await lifecycle.moveToForeground();
  } else {
    await lifecycle.moveToBackground();
  }
}

Classes

SenzaShakaPlayer

Constants

NON_CRITICAL_REMOTE_PLAYER_ERRORS

List of non-critical remote player error codes that shouldn't stop playback

SenzaShakaPlayer

Kind: global class

• SenzaShakaPlayer
  • new SenzaShakaPlayer()
  • .SenzaShakaPlayer
    • new exports.SenzaShakaPlayer(videoElement, [videoContainer], [dependencyInjector])
  • .isInRemotePlayback
  • .attach(videoElement, [initializeMediaSource])
  • .detach([keepAdManager]) ⇒ Promise
  • .getTextLanguages() ⇒ Array
  • .getAudioLanguages() ⇒ Array
  • .selectAudioLanguage(language, [role])
  • .selectTextLanguage(language, [role])
  • .setTextTrackVisibility(visible)
  • .handleSenzaError(remotePlayerErrorCode, message)
  • .load(url) ⇒ Promise.
  • .configure(config)

new SenzaShakaPlayer()

SenzaShakaPlayer subclass of Shaka that handles both local and remote playback.

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);
}

senzaShakaPlayer.SenzaShakaPlayer

Kind: instance class of SenzaShakaPlayer

new exports.SenzaShakaPlayer(videoElement, [videoContainer], [dependencyInjector])

Creates an instance of SenzaShakaPlayer, which is a subclass of shaka.Player.

senzaShakaPlayer.isInRemotePlayback

Helper function that makes it easier to check if lifecycle.state is
either background or inTransitionToBackground.

Kind: instance property of SenzaShakaPlayer

senzaShakaPlayer.attach(videoElement, [initializeMediaSource])

Overrides the attach method of shaka.Player to attach the video element.

Kind: instance method of SenzaShakaPlayer

senzaShakaPlayer.detach([keepAdManager]) ⇒ Promise

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.

Kind: instance method of SenzaShakaPlayer

senzaShakaPlayer.getTextLanguages() ⇒ Array

Overrides the getTextTracks method to use the remote player's text tracks.

Kind: instance method of SenzaShakaPlayer
Returns: Array - An array of text tracks.

senzaShakaPlayer.getAudioLanguages() ⇒ Array

Overrides the getAudioTracks method to use the remote player's audio tracks.

Kind: instance method of SenzaShakaPlayer
Returns: Array - An array of audio tracks.

senzaShakaPlayer.selectAudioLanguage(language, [role])

Overrides the selectAudioLanguage method to use the remote player's audio track selection.

Kind: instance method of SenzaShakaPlayer

senzaShakaPlayer.selectTextLanguage(language, [role])

Overrides the selectTextLanguage method to use the remote player's text track selection.

Kind: instance method of SenzaShakaPlayer

senzaShakaPlayer.setTextTrackVisibility(visible)

Overrides the setTextTrackVisibility method to use the remote player's text track visibility settings.

Kind: instance method of SenzaShakaPlayer

senzaShakaPlayer.handleSenzaError(remotePlayerErrorCode, message)

Helper function to handle Senza errors, optionally stopping local playback and dispatching error event

Kind: instance method of SenzaShakaPlayer

senzaShakaPlayer.load(url) ⇒ Promise.

Loads a media URL into both local and remote players.

Kind: instance method of SenzaShakaPlayer

senzaShakaPlayer.configure(config)

Override the configure method to add custom configuration handling
Supports the following additional configuration options:

• shouldStopRemotePlayerOnError: boolean - If true, remote player will be stopped on error

Kind: instance method of SenzaShakaPlayer

Example

player.configure({
  shouldStopRemotePlayerOnError: false,  // Don't stop remote player on error
  // ... other shaka configurations
});

NON_CRITICAL_REMOTE_PLAYER_ERRORS

List of non-critical remote player error codes that shouldn't stop playback

Kind: global constant