shaka-player
Advanced tools
Shaka Player is an open-source JavaScript library for adaptive media streaming. It supports DASH and HLS formats and provides a wide range of features for media playback, including DRM support, offline storage, and live streaming.
Basic Playback
This code demonstrates how to set up basic video playback using Shaka Player. It initializes the player with a video element and loads a DASH manifest.
const video = document.getElementById('video');
const player = new shaka.Player(video);
player.load('https://example.com/manifest.mpd').then(function() {
console.log('The video has now been loaded!');
}).catch(function(error) {
console.error('Error loading video', error);
});DRM Support
This code demonstrates how to configure Shaka Player to support DRM (Digital Rights Management). It sets up license servers for Widevine and PlayReady and loads a DASH manifest.
const video = document.getElementById('video');
const player = new shaka.Player(video);
player.configure({
drm: {
servers: {
'com.widevine.alpha': 'https://example.com/widevine_license',
'com.microsoft.playready': 'https://example.com/playready_license'
}
}
});
player.load('https://example.com/manifest.mpd').then(function() {
console.log('The video with DRM has now been loaded!');
}).catch(function(error) {
console.error('Error loading video with DRM', error);
});Offline Storage
This code demonstrates how to use Shaka Player's offline storage feature. It initializes the storage module and stores a DASH manifest for offline playback.
const video = document.getElementById('video');
const player = new shaka.Player(video);
const storage = new shaka.offline.Storage(player);
storage.store('https://example.com/manifest.mpd').then(function(content) {
console.log('The content has been stored offline!', content);
}).catch(function(error) {
console.error('Error storing content offline', error);
});Live Streaming
This code demonstrates how to set up live streaming using Shaka Player. It initializes the player with a video element and loads a live DASH manifest.
const video = document.getElementById('video');
const player = new shaka.Player(video);
player.load('https://example.com/live.mpd').then(function() {
console.log('The live stream has now been loaded!');
}).catch(function(error) {
console.error('Error loading live stream', error);
});Video.js is a popular open-source HTML5 video player that supports a wide range of video formats and provides a plugin architecture for extending its functionality. Compared to Shaka Player, Video.js has a larger community and more plugins available, but it does not natively support DASH or HLS streaming.
Hls.js is a JavaScript library that brings HLS (HTTP Live Streaming) to browsers with support for MSE (Media Source Extensions). It is specifically designed for HLS streaming, whereas Shaka Player supports both DASH and HLS. Hls.js is a good choice if you only need HLS support.
Dash.js is an open-source reference client for the playback of MPEG-DASH content. It is maintained by the DASH Industry Forum and provides extensive support for DASH streaming. Compared to Shaka Player, Dash.js is more focused on DASH and may not have as many features for HLS or DRM.
Shaka Player is an open-source JavaScript library for adaptive media. It plays adaptive media formats (such as DASH, HLS and MSS) 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.
See maintained-branches.md for the up-to-date list of maintained branches of Shaka Player.
| Browser | Windows | Mac | Linux | Android | iOS >= 9 | iOS >= 17.1 | iPadOS >= 13 | ChromeOS | Other |
|---|---|---|---|---|---|---|---|---|---|
| Chrome¹ | Y | Y | Y | Y | Native | Native | Native | Y | - |
| Firefox¹ | Y | Y | Y | untested⁵ | Native | Native | Native | - | - |
| Edge¹ | Y | - | - | - | - | - | - | - | - |
| Edge Chromium | Y | Y | Y | untested⁵ | Native | Native | Native | - | - |
| IE | N | - | - | - | - | - | - | - | - |
| Safari¹ | - | Y | - | - | Native | Y | Y | - | - |
| Opera¹ | untested⁵ | untested⁵ | untested⁵ | untested⁵ | Native | - | - | - | - |
| Chromecast². | - | - | - | - | - | - | - | - | Y |
| Tizen TV³ | - | - | - | - | - | - | - | - | Y |
| WebOS⁶ | - | - | - | - | - | - | - | - | Y |
| Hisense⁷ | - | - | - | - | - | - | - | - | Y |
| Xbox One | - | - | - | - | - | - | - | - | Y |
| Playstation 4⁷ | - | - | - | - | - | - | - | - | Y |
| Playstation 5⁷ | - | - | - | - | - | - | - | - | Y |
NOTES:
NOTES for iOS and iPadOS:
src element to the manifest/media.
So we are dependent on the browser supporting the manifests.| Format | Video On-Demand | Live | Event | In-Progress Recording |
|---|---|---|---|---|
| DASH | Y | Y | - | Y |
| HLS | Y | Y | Y | - |
| MSS | Y | - | - | - |
You can also create a manifest parser plugin to support custom manifest formats.
DASH features supported:
DASH features not supported:
HLS features supported:
HLS features not supported:
Only supported on browsers with Media Source Extensions SourceBuffer support
MPEG-5 Part2 LCEVC decoding support (decoding provided by lcevc_dec.js, must be separately included)
Integration documentation : docs
More on MPEG-5 Part2 LCEVC
MSS features supported:
MSS features not supported:
| Browser | Widevine | PlayReady | FairPlay | ClearKey⁶ |
|---|---|---|---|---|
| Chrome¹ | Y | - | - | Y |
| Firefox² | Y | - | - | Y |
| Edge³ | - | Y | - | - |
| Edge Chromium | Y | Y | - | Y |
| Safari | - | - | Y | - |
| Opera | untested⁵ | - | - | untested⁵ |
| Chromecast | Y | Y | - | Y |
| Tizen TV | Y | Y | - | Y |
| WebOS⁷ | untested⁷ | untested⁷ | - | untested⁷ |
| Hisense⁷ | untested⁷ | untested⁷ | - | untested⁷ |
| Xbox One | - | Y | - | - |
| Playstation 4⁷ | - | untested⁷ | - | untested⁷ |
| Playstation 5⁷ | - | untested⁷ | - | untested⁷ |
Other DRM systems should work out of the box if they are interoperable and compliant to the EME spec.
NOTES:
| Manifest | Widevine | PlayReady | FairPlay | ClearKey |
|---|---|---|---|---|
| DASH | Y | Y | - | Y |
| HLS | Y | Y | Y ¹ | - |
| MSS | - | Y | - | - |
NOTES:
streaming.useNativeHlsForFairPlay configuration value.Shaka Player supports:
Subtitles are rendered by the browser by default. Applications can create a text display plugin for customer rendering to go beyond browser-supported attributes.
Shaka Player supports:
Shaka Player supports:
Shaka Player supports:
Shaka Player supports Content Steering (v1) in DASH and HLS.
Content Steering features supported:
Content Steering features not supported:
Shaka Player supports VR when:
prji and hfov boxesVR modes supported:
NOTES:
For general help and before filing any bugs, please read the FAQ.
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.
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 successfully done so and created tutorials to help other beginners.
Shaka + ReactJS Library
Shaka + ReactJS integrations:
Shaka + Next.js integration:
Shaka + Vue.js integrations:
Shaka + Nuxt.js integration:
Shaka + video.js integration:
Shaka + Angular 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!
FAQs
DASH/EME video player library
The npm package shaka-player receives a total of 174,020 weekly downloads. As such, shaka-player popularity was classified as popular.
We found that shaka-player demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.