A reference client implementation for the playback of MPEG DASH via Javascript and compliant browsers.
JavaScript HTML CSS
Latest commit 2556ec4 Jul 28, 2016 @LloydW93 LloydW93 committed on GitHub Merge pull request #1519 from bbcrddave/1518
Fix #1518
Failed to load latest commit information.
build/jsdoc Fixed Grunt jsdoc for es6. Added one doc to factory maker to test. Ad… Feb 5, 2016
contrib added missing comma Jun 14, 2016
docs/migration updated migration doc typo. Feb 17, 2016
externals Refactor DASH Parser May 12, 2016
samples Merge pull request #1503 from wilaw/development Jul 27, 2016
src Merge pull request #1519 from bbcrddave/1518 Jul 28, 2016
test Since I moved QUALITY CHANGED event from Core to MediaPlayerEvents I … Jul 20, 2016
.gitignore Add Bola files. Still needs some work for Bola to behave as expected.… Feb 4, 2016
.jscsrc Fix up JSDocs, and make compat with closure Apr 18, 2016
.jshintrc Add BaseURL support Apr 4, 2016
.npmignore Add npmignore file. Feb 17, 2016
.travis.yml Use recent node versions Jul 11, 2016
AUTHORS.md Enable querying time relative to arbitrary Period start time Mar 29, 2016
Gruntfile.js Revert "Add support for Browserify based includes of the player (fixes Jul 20, 2016
ISSUE_TEMPLATE.md Update ISSUE_TEMPLATE.md Jun 20, 2016
LICENSE.md modified license.md Jan 20, 2015
README.md Made all Slack links point to signup page Apr 20, 2016
index.js Solving chicken/egg issue with version string. Some players may need … Apr 27, 2016
mochahook.js Revert "Add support for Browserify based includes of the player (fixes Jul 20, 2016
package.json Revert "Add support for Browserify based includes of the player (fixes Jul 20, 2016
web.config Will now remove previous mimeMap entry to avoid conflicts Jan 27, 2016

README.md

Travis CI Status: Travis CI Status

Join the discussion: Slack Status

Overview

A reference client implementation for the playback of MPEG DASH via JavaScript and compliant browsers. Learn more about DASH IF Reference Client on our wiki.

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. Read through our wiki section on https://github.com/Dash-Industry-Forum/dash.js/wiki/How-to-Contribute for a walk-through of the contribution process.

All new work should be in the development branch. Master is now reserved for tagged builds.

Documentation

Before you get started, please read the Dash.js v2.0 Migration Document found here

Full API Documentation is available describing all public methods, interfaces, properties, and events.

For help, join our Slack channel, our email list and read our wiki.

Reference players

The released pre-built reference players are publicly accessible 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.

A nightly build of the latest minified files are also available: dash.all.min.js and its debug version dash.all.debug.js.

Quick Start for Users

If you just want a DASH player to use and don't need to see the code or commit to this project, then follow the instructions below. If you are a developer and want to work with this code base, then skip down to the "Quick Start for Developers" section.

Put the following code in your web page

<script src="http://cdn.dashjs.org/latest/dash.all.min.js"></script>
...
<style>
    video {
       width: 640px;
       height: 360px;
    }
</style>
...
<body>
   <div>
       <video data-dashjs-player autoplay src="http://dash.edgesuite.net/envivio/EnvivioDash3/manifest.mpd" controls></video>
   </div>
</body>

Then place your page under a web server (do not try to run from the file system) and load it via http in a MSE-enabled browser. The video will start automatically. Switch out the manifest URL to your own manifest once you have everything working. If you prefer to use the latest code from this project (versus the last tagged release) then see the "Quick Start for Developers" section below.

View the /samples folder for many other examples of embedding and using the player.

Quick Start for Developers

Reference Player

  1. Download 'development' branch
  2. Extract dash.js and move the entire folder to localhost (or run any http server instance such as python's SimpleHTTPServer at the root of the dash.js folder).
  3. Open samples/dash-if-reference-player/index.html in your MSE capable web browser.

Install Core Dependencies

  1. install nodejs
  2. install grunt
    • npm install -g grunt-cli

Build / Run tests on commandline.

  1. Install all Node Modules defined in package.json
    • npm install
  2. Run the GruntFile.js default task
    • grunt
  3. You can also target individual tasks: E.g.
    • grunt debug (quickest build)
    • grunt dist
    • grunt release
    • grunt test

Getting Started

The standard setup method uses javascript to initialize and provide video details to dash.js. MediaPlayerFactory provides an alternative declarative setup syntax.

Standard Setup

Create a video element somewhere in your html. For our purposes, make sure the controls attribute is present.

<video id="videoPlayer" controls></video>

Add dash.all.min.js to the end of the body.

<body>
  ...
  <script src="yourPathToDash/dash.all.min.js"></script>
</body>

Now comes the good stuff. We need to create a MediaPlayer and initialize it.

var url = "http://dash.edgesuite.net/envivio/EnvivioDash3/manifest.mpd";
var player = dashjs.MediaPlayer().create();
player.initialize(document.querySelector("#videoPlayer"), url, true);

When it is all done, it should look similar to this:

<!doctype html>
<html>
    <head>
        <title>Dash.js Rocks</title>
        <style>
            video {
                width: 640px;
                height: 360px;
            }
        </style>
    </head>
    <body>
        <div>
            <video id="videoPlayer" controls></video>
        </div>
        <script src="yourPathToDash/dash.all.min.js"></script>
        <script>
            (function(){
                var url = "http://dash.edgesuite.net/envivio/EnvivioDash3/manifest.mpd";
                var player = dashjs.MediaPlayer().create();
                player.initialize(document.querySelector("#videoPlayer"), url, true);
            })();
        </script>
    </body>
</html>

Module Setup

We publish dash.js to npm. Examples of how to use dash.js in different module bundlers can be found in the samples/modules directory.

MediaPlayerFactory Setup

An alternative way to build a Dash.js player in your web page is to use the MediaPlayerFactory. The MediaPlayerFactory will automatically instantiate and initialize the MediaPlayer module on appropriately tagged video elements.

Create a video element somewhere in your html and provide the path to your mpd file as src. Also ensure that your video element has the data-dashjs-player attribute on it.

<video data-dashjs-player autoplay src="http://dash.edgesuite.net/envivio/EnvivioDash3/manifest.mpd" controls>
</video>

Add dash.all.min.js to the end of the body.

<body>
  ...
  <script src="yourPathToDash/dash.all.min.js"></script>
</body>

When it is all done, it should look similar to this:

<!doctype html>
<html>
    <head>
        <title>Dash.js Rocks</title>
        <style>
            video {
                width: 640px;
                height: 360px;
            }
        </style>
    </head>
    <body>
        <div>
            <video data-dashjs-player autoplay src="http://dash.edgesuite.net/envivio/EnvivioDash3/manifest.mpd" controls>
            </video>
        </div>
        <script src="yourPathToDash/dash.all.min.js"></script>
    </body>
</html>

Tested With

Browser Stack Logo