Overview
dash.js is a reference client implementation for the playback of MPEG DASH via JavaScript in browser based environments that support the Media Source Extensions.
If your intent is to use the player code without contributing back to this project, then use the master
branch which holds the approved and stable public releases.
If your goal is to improve or extend the code and contribute back to this project, then you should make your changes in, and submit a pull request against, the development
branch.
Quickstart
Using dash.js in your application is very straight forward. Just follow the installation and setup steps in our Quickstart Guide.
For detailed usage instructions refer to the Usage section.
Migration from v4 to v5
dash.js version 5.0 introduces changes to the build files, settings and the APIs. The migration guide will help you migrate your application from dash.js version 4.x to 5.0.
Demos and reference players
All the reference builds and minified files are available under both http and https.
Samples
Multiple dash.js samples covering a wide set of common use cases.
Reference players
The released pre-built reference players if you want direct access without writing any Javascript.
The nightly build of the /dev branch reference player , is pre-release but contains the latest fixes. It is a good place to start if you are debugging playback problems.
CDN hosted files
We provide the latest minified files of all releases on a global CDN. They are free to be used in production environments. An overview of the dash.js releases can be found on GitHub.
Version 4.x and older
All releases prior to version 5.0.0 are available under the following urls. Replace vx.x.x
with the release version, for instance v3.1.0
.
Version 5.x and newer
With version 5.0.0 we introduced new bundle formats. The URLs for the CDN hosted files for these new bundle formats are as follows. Replace vx.x.x
with the release version, for instance v5.0.0
.
UMD legacy
- Minified Build: http://cdn.dashjs.org/vx.x.x/legacy/umd/dash.all.min.js
- Debug Build: http://cdn.dashjs.org/vx.x.x/legacy/umd/dash.all.debug.js
UMD modern
- Minified Build: http://cdn.dashjs.org/vx.x.x/modern/umd/dash.all.min.js
- Debug Build: http://cdn.dashjs.org/vx.x.x/modern/umd/dash.all.debug.js
ESM modern
- Minified Build: http://cdn.dashjs.org/vx.x.x/modern/esm/dash.all.min.js
- Debug Build: http://cdn.dashjs.org/vx.x.x/modern/esm/dash.all.debug.js
Multiple examples how to use dash.js in your Typescript or Webpack based JavaScript project can be found in samples/modules
.
API Documentation
The full API Documentation is available describing all public methods, interfaces, properties, and events.
For help, join our Slack channel, our email list and read the documentation on this website.
License
dash.js is released under BSD license