Skip to content
A reference client implementation for the playback of MPEG DASH via Javascript and compliant browsers.
Branch: development
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci revert circleci Feb 5, 2019
build/jsdoc
contrib getCurrentDroppedFrames doesn't need type attribute Feb 28, 2019
docs Move diagrams to docs folder Feb 7, 2018
externals Move objectiron to src/dash/parser and make it compliant with factory… Apr 9, 2018
samples add metrics maximum list depth in config file Mar 6, 2019
src add BolaRule unit test Mar 15, 2019
test add BolaRule unit test Mar 15, 2019
.editorconfig add .editorconfig Feb 2, 2017
.gitignore
.jscsrc Fix trailing commas, update JSCS and JSHint configs Mar 21, 2017
.jshintrc add predefined words to jshint config Sep 27, 2017
.npmignore removed web.config I do not think it is needed anymore will test Sep 7, 2016
AUTHORS.md Adding minDrift and catchUpPlaybackRate as configurable parameters Nov 19, 2018
CONTRIBUTING.md Update links in contribution guidelines Nov 12, 2018
Gruntfile.js Functional tests improvements to make them work in IE/Edge Jun 6, 2018
ISSUE_TEMPLATE.md update conformance tool url Nov 12, 2018
LICENSE.md modified license.md Jan 20, 2015
README.md Update README with CircleCI status Jan 8, 2019
index.d.ts update typeScript api Mar 6, 2019
index.js update code and message errors Sep 18, 2018
index_mediaplayerOnly.js update code and message errors Sep 18, 2018
mochahook.js
package-lock.json update imsc1 version 1.0.1 => 1.0.2 Jan 17, 2019
package.json Merge pull request #2927 from Orange-OpenSource/functional-tests Feb 13, 2019

README.md

Build status (CircleCI): CircleCI

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 our CONTRIBUTION.md file 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.

All these reference builds and minified files are available under both http and https.

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="https://cdn.dashjs.org/latest/dash.all.min.js"></script>
...
<style>
    video {
       width: 640px;
       height: 360px;
    }
</style>
...
<body>
   <div>
       <video data-dashjs-player autoplay src="https://dash.akamaized.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. If you are interested in captioning support, which requires some additional UI elements, then please view the captioning examples.

Quick Start for Developers

  1. Install Core Dependencies
  2. Checkout project repository (default branch: development)
    • git clone https://github.com/Dash-Industry-Forum/dash.js.git
  3. Install dependencies
    • npm install
  4. Build, watch file changes and launch samples page, which has links that point to reference player and to other examples (basic examples, captioning, ads, live, etc).
    • grunt dev

Other Grunt Tasks to Build / Run Tests on Commandline.

  1. Individual tasks:
    • Quickest build
      • grunt debug
    • Lint
      • grunt lint
    • Run unit tests
      • grunt test
    • Build distribution files (minification included)
      • grunt dist
    • Build distribution files, lint, run unit tests and generate documentation
      • grunt release
  2. GruntFile.js default task (equivalent to grunt dist && grunt test)
    • grunt

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 = "https://dash.akamaized.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 = "https://dash.akamaized.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="https://dash.akamaized.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="https://dash.akamaized.net/envivio/EnvivioDash3/manifest.mpd" controls>
            </video>
        </div>
        <script src="yourPathToDash/dash.all.min.js"></script>
    </body>
</html>

Tested With

Browser Stack Logo

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.