/dash.js

A reference client implementation for the playback of MPEG DASH via Javascript and compliant browsers.

Primary LanguageJavaScriptOtherNOASSERTION

Travis CI Status: Travis CI Status

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.

View the /samples folder for many other examples of embedding and using the player. For help, join our email list and read our wiki .

Quick Start for Developers with 2.0 refactor

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 dist
    • grunt release
    • grunt test

Getting Started

Create a video element somewhere in your html. For our purposes, make sure to set the controls property to true.

<video id="videoPlayer" controls="true"></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. We will do this in an anonymous self executing function, that way it will run as soon as the page loads. So, here is how we do it:

(function(){
    var url = "http://dash.edgesuite.net/envivio/Envivio-dash2/manifest.mpd";
    var player = 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>
    </head>
    <body>
        <div>
            <video id="videoPlayer" controls="true"></video>
        </div>
        <script src="yourPathToDash/dash.all.min.js"></script>
        <script>
            (function(){
                var url = "http://dash.edgesuite.net/envivio/Envivio-dash2/manifest.mpd";
                var player = MediaPlayer().create(); 
                player.initialize(document.querySelector("#videoPlayer"), url, true);
            })();
        </script>
    </body>
</html>