Skip to content
JavaScript player library / DASH & HLS client / MSE-EME player
JavaScript Python Other
Branch: master
Clone or download

Latest commit

joeyparrish Rename v2.6 to v3.0 and v2.7 to v3.1
We have decided to bump the major version number instead of the minor
number, based primarily on the fact that this release breaks
compatibility with our previous manifest structure.

Change-Id: I67e4c8267c6e103cfc7278e09daac186ae5cbbc6
Latest commit aba5e25 May 29, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Made issue template for questions ask more. Jan 6, 2020
build Add screenshot-based layout tests for subtitles May 26, 2020
demo Rename v2.6 to v3.0 and v2.7 to v3.1 May 29, 2020
docs Rename v2.6 to v3.0 and v2.7 to v3.1 May 29, 2020
externs Propagate UI locale changes to ad manager. May 26, 2020
lib Rename v2.6 to v3.0 and v2.7 to v3.1 May 29, 2020
test Rename v2.6 to v3.0 and v2.7 to v3.1 May 29, 2020
third_party Unfork Closure base and update the compiler May 1, 2020
ui Rename v2.6 to v3.0 and v2.7 to v3.1 May 29, 2020
.csslintrc Use CSS & container attributes to hide controls Jan 14, 2020
.eslintignore Add .eslintrc.js to linter and fix style. May 15, 2019
.eslintrc.js Remove periods from manifest structure Apr 9, 2020
.gitattributes [ES6] Force JS files to use unix newlines on Windows Jan 18, 2018
.gitignore Added new demo page. May 1, 2019
.htmlhintrc Whitelist svg camelcase attributes in htmlhint Jan 18, 2017
.npmignore Add screenshot-based layout tests for subtitles May 26, 2020
AUTHORS Tizen2.4 bugfixes (#2449) Mar 13, 2020
CHANGELOG.md Rename v2.6 to v3.0 and v2.7 to v3.1 May 29, 2020
CODE_OF_CONDUCT.md Fix typo in code of conduct May 15, 2020
CONTRIBUTING.md Remove all.sh and test.sh Feb 3, 2016
CONTRIBUTORS Fix TTML position parsing (#2493) Apr 13, 2020
LICENSE Renaming LICENSE.txt to LICENSE to match google3 requirement Sep 4, 2015
README.md Rename v2.6 to v3.0 and v2.7 to v3.1 May 29, 2020
index.html Fix accessibility issues Oct 17, 2016
karma.conf.js Add screenshot-based layout tests for subtitles May 26, 2020
package.json Add screenshot-based layout tests for subtitles May 26, 2020
roadmap.md Rename v2.6 to v3.0 and v2.7 to v3.1 May 29, 2020
shaka-player.uncompiled.js Add playback speed selection to UI Feb 12, 2020
support.html An external Promise polyfill is no longer required Sep 13, 2018

README.md

Shaka Player

Shaka Player is an open-source JavaScript library for adaptive media. It plays adaptive media formats (such as DASH and HLS) in a browser, without using plugins or Flash. Instead, Shaka Player uses the open web standards MediaSource Extensions and Encrypted Media Extensions.

Shaka Player also supports offline storage and playback of media using IndexedDB. Content can be stored on any browser. Storage of licenses depends on browser support.

Our main goal is to make it as easy as possible to stream adaptive bitrate video and audio using modern browser technologies. We try to keep the library light, simple, and free from third-party dependencies. Everything you need to build and deploy is in the sources.

For details on what's coming next, see our development roadmap.

Platform and browser support matrix

Browser Windows Mac Linux Android iOS >= 12 ChromeOS Other
Chrome¹ Y Y Y Y Native Y -
Firefox¹ Y Y Y untested⁵ Native - -
Edge¹ Y - - - - - -
IE ≤ 10 N - - - - - -
IE 11 Y - - - - - -
Safari¹ - Y - - iPadOS 13
Native
- -
Opera¹ untested⁵ untested⁵ untested⁵ untested⁵ Native - -
Chromecast² - - - - - - Y
Tizen TV³ - - - - - - Y

NOTES:

  • ¹: On macOS, only Safari 12+ is supported. On iOS, only iOS 12+ is supported. Older versions will be rejected.
  • ²: The latest stable Chromecast firmware is tested. Both sender and receiver can be implemented with Shaka Player.
  • ³: Tizen 2017 model is actively tested and supported by the Shaka Player team. Tizen 2016 model is community-supported and untested by us.
  • ⁴: IE 11 offers PlayReady support on Windows 8.1 and Windows 10 only. IE 11 can play clear content on Windows 8.0. IE 11 does not support adaptive playback on Windows 7 and under. (IE support will stop in v3.1: https://github.com/google/shaka-player/issues/2339)
  • ⁵: These are expected to work, but are not actively tested by the Shaka Player team.

We support iOS 12+ through Apple's native HLS player. We provide the same top-level API, but we just set the video's src element to the manifest/media. So we are dependent on the browser supporting the manifests.

Shaka Player Embedded (for native iOS)

We have another project called Shaka Player Embedded that offers the same features and similar APIs for native apps on iOS. This project uses its own media stack, which allows it to play content that would otherwise not be supported. This supports both DASH and HLS manifests.

Manifest format support matrix

Format Video On-Demand Live Event In-Progress Recording
DASH Y Y - Y
HLS Y Y Y -

You can also create a manifest parser plugin to support custom manifest formats.

DASH features

DASH features supported:

  • VOD, Live, and In-Progress Recordings (dynamic VOD content)
  • MPD@timeShiftBufferDepth for seeking backward in Live streams
  • Multi-period content (static and dynamic)
  • Xlink elements (actuate=onLoad only, resolve-to-zero, fallback content)
  • All forms of segment index info: SegmentBase@indexRange, SegmentTimeline, SegmentTemplate@duration, SegmentTemplate@index, SegmentList
  • Multi-codec/multi-container manifests (we will negotiate support with the browser and choose the best ones)
  • Encrypted content (including custom ContentProtection schemas, PSSH in the manifest)
  • Key rotation
  • Trick mode tracks

DASH features not supported:

HLS features

HLS features supported:

  • VOD, Live, and Event types
  • Encrypted content with Widevine
  • ISO-BMFF / MP4 / CMAF support
  • MPEG-2 TS support (transmuxing provided by mux.js v5.6.3+, must be separately included)
  • WebVTT and TTML
  • CEA-608/708 captions
  • Encrypted content with FairPlay (Safari on macOS and iOS 12+ only)

HLS features not supported:

DRM support matrix

Browser Widevine PlayReady FairPlay ClearKey⁶
Chrome¹ Y - - Y
Firefox² Y - - Y
Edge³ - Y - -
IE 11⁴ - Y - -
Safari - - Y -
Opera untested⁵ - - untested⁵
Chromecast Y Y - untested⁵
Tizen TV Y Y - untested⁵

Other DRM systems should work out of the box if they are interoperable and compliant to the EME spec.

NOTES:

  • ¹: Only official Chrome builds contain the Widevine CDM. Chromium built from source does not support DRM.
  • ²: DRM must be enabled by the user. The first time a Firefox user visits a site with encrypted media, the user will be prompted to enable DRM.
  • ³: PlayReady in Edge does not seem to work on a VM or over Remote Desktop.
  • ⁴: IE 11 offers PlayReady support on Windows 8.1 and Windows 10 only. (IE support will stop in v3.1: https://github.com/google/shaka-player/issues/2339)
  • ⁵: These are expected to work, but are not actively tested by the Shaka Player team.
  • ⁶: ClearKey is a useful tool for debugging, and does not provide actual content security.

Media container and subtitle support

Shaka Player supports:

  • ISO-BMFF / CMAF / MP4
    • Depends on browser support for the container via MediaSource
    • Can parse "sidx" box for DASH's SegmentBase@indexRange and SegmentTemplate@index
    • Can find and parse "tfdt" box to find segment start time in HLS
  • WebM
    • Depends on browser support for the container via MediaSource
    • Can parse cueing data elements for DASH's SegmentBase@indexRange and SegmentTemplate@index
    • Not supported in HLS
  • MPEG-2 TS
    • With help from mux.js v5.6.3+, can be played on any browser which supports MP4
    • Can find and parse timestamps to find segment start time in HLS
  • WebVTT
    • Supported in both text form and embedded in MP4
  • TTML
    • Supported in both XML form and embedded in MP4

Subtitles are rendered by the browser by default. Applications can create a text display plugin for customer rendering to go beyond browser-supported attributes.

Important Links

Contributing

If you have improvements or fixes, we would love to have your contributions. Please read CONTRIBUTING.md for more information on the process we would like contributors to follow.

Framework Integrations

The Shaka team doesn't have the bandwidth and experience to provide guidance and support for integrating Shaka Player with specific frameworks, but some of our users have sucessfully done so and created tutorials to help other beginners.

Shaka + ReactJS integrations:

Shaka + Next.js integration:

If you have published Shaka Integration code/tutorials, please feel free to submit PRs to add them to this list, we will gladly approve!

FAQ

For general help and before filing any bugs, please read the FAQ.

You can’t perform that action at this time.