• Stars
    star
    293
  • Rank 141,715 (Top 3 %)
  • Language
    JavaScript
  • License
    Apache License 2.0
  • Created over 9 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Video.js plugin for supporting the MPEG-DASH playback through a video.js player

video.js MPEG-DASH Source Handler

Build Status Greenkeeper badge Slack Status

NPM

A video.js source handler for supporting MPEG-DASH playback through a video.js player on browsers with support for Media Source Extensions.

Supported Dash.js version: 4.x

Maintenance Status: Stable

Drop by our slack channel (#playback) on the Video.js slack.

Table of Contents generated with DocToc

Getting Started

Download Dash.js and videojs-contrib-dash. Include them both in your web page along with video.js:

<video id=example-video width=600 height=300 class="video-js vjs-default-skin" controls></video>
<script src="video.js"></script>

<!-- Dash.js -->
<script src="dash.all.min.js"></script>

<!-- videojs-contrib-dash script -->
<script src="videojs-dash.min.js"></script>

<script>
var player = videojs('example-video');

player.ready(function() {
  player.src({
    src: 'https://example.com/dash.mpd',
    type: 'application/dash+xml'
  });

  player.play();
});
</script>

Checkout our live example if you're having trouble.

Protected Content

If the browser supports Encrypted Media Extensions and includes a Content Decryption Module for one of the protection schemes in the dash manifest, video.js will be able to playback protected content.

For most protection schemes, the license server information (URL & init data) is included inside the manifest. The notable exception to this is Widevine-Modular (WV). To playback WV content, you must provide the URL to a Widevine license server proxy.

For this purpose, videojs-contrib-dash adds support for a "keySystemOptions" array to the object when using the player.src() function:

player.src({
  src: 'http://example.com/my/manifest.mpd',
  type: 'application/dash+xml',
  keySystemOptions: [
    {
      name: 'com.widevine.alpha',
      options: {
        serverURL: 'http://m.widevine.com/proxy'
      }
    }
  ]
});

You may also manipulate the source object by registering a function to the updatesource hook. Your function should take a source object as an argument and should return a source object.

var updateSourceData = function(source) {
  source.keySystemOptions = [{
    name: 'com.widevine.alpha',
    options: {
      serverURL:'https://example.com/anotherlicense'
    }
  }];
  return source;
};

videojs.Html5DashJS.hook('updatesource', updateSourceData);

Captions

As of [email protected], native captions are no longer supported on any browser besides Safari. Dash can handle captions referenced embedded vtt files, embedded captions in the manifest, and with fragmented text streaming. It is impossible to use video.js captions when dash.js is using fragmented text captions, so the user must disable native captions when using videojs-contrib-dash.

videojs('example-video', {
  html5: {
    nativeCaptions: false
  }
});

A warning will be logged if this setting is not applied.

Using TTML Captions

TTML captions require special rendering by dash.js. To enable this rendering, you must set option useTTML to true, like so:

videojs('example-video', {
  html5: {
    dash: {
      useTTML: true
    }
  }
});

This option is not true by default because it will also render CEA608 captions in the same method, and there may be some errors in their display. However, it does enable styling captions via the captions settings dialog.

Multi-Language Labels

When labels in a playlist file are in multiple languages, the 2-character language code should be used if it exists; this allows the player to auto-select the appropriate label.

Passing options to Dash.js

It is possible to pass options to Dash.js during initialiation of video.js. All methods in the Dash.js#MediaPlayer docs are supported.

To set these options, pass the exact function name with a scalar or array value to call the correpsonding MediaPlayer function.

For example:

var player = videojs('example-video', {
  html5: {
    dash: {
      setLimitBitrateByPortal: true,
      setMaxAllowedBitrateFor: ['video', 2000]
    }
  }
});

A warning will be logged if the configuration property is not found.

Deprecation Warning

Previously the set prefix was expected to be omitted. This has been deprecated and will be removed in a future version.

Initialization Hook

Sometimes you may need to extend Dash.js, or have access to the Dash.js MediaPlayer before it is initialized. For these cases, you can register a function to the beforeinitialize hook, which will be called just before the Dash.js MediaPlayer is initialized.

Your function should have two parameters:

  1. The video.js Player instance
  2. The Dash.js MediaPlayer instance
var myCustomCallback = function(player, mediaPlayer) {
  // Log MediaPlayer messages through video.js
  if (videojs && videojs.log) {
    mediaPlayer.getDebug().setLogToBrowserConsole(false);
    mediaPlayer.on('log', function(event) {
      videojs.log(event.message);
    });
  }
};

videojs.Html5DashJS.hook('beforeinitialize', myCustomCallback);

More Repositories

1

video.js

Video.js - open source HTML5 video player
JavaScript
37,903
star
2

videojs-contrib-hls

HLS library for video.js
JavaScript
2,840
star
3

http-streaming

HLS, DASH, and future HTTP streaming protocols library for video.js
JavaScript
2,490
star
4

videojs-youtube

YouTube playback technology for Video.js
JavaScript
1,123
star
5

mux.js

Lightweight utilities for inspecting and manipulating video container formats.
JavaScript
1,104
star
6

videojs-vr

A plugin to add 360 and VR video support to video.js.
JavaScript
540
star
7

m3u8-parser

An m3u8 parser.
JavaScript
475
star
8

videojs-contrib-ads

A Tool for Building Video.js Ad Plugins
JavaScript
382
star
9

videojs-playlist

Playlist plugin for videojs
JavaScript
365
star
10

video-js-swf

Custom Flash Player for VideoJS
JavaScript
336
star
11

videojs-overlay

A video.js plugin to display simple overlays during playback.
JavaScript
245
star
12

videojs-flash

The Flash tech for video.js
JavaScript
215
star
13

videojs-contrib-eme

Supports Encrypted Media Extensions for playback of encrypted content in Video.js
JavaScript
201
star
14

videojs-vimeo

Support Vimeo source for Video.js
JavaScript
196
star
15

hls-fetcher

JavaScript
162
star
16

videojs-contrib-quality-levels

JavaScript
154
star
17

videojs-contrib-media-sources

Code for working with the media source extensions API and video.js
JavaScript
144
star
18

themes

Videojs themes 💅
CSS
140
star
19

videojs-playlist-ui

A playlist video picker for video.js
JavaScript
129
star
20

thumbcoil

Tools for inspecting MPEG2TS, fMP4, and FLV files and the codec bitstreams therein
JavaScript
124
star
21

videojs-errors

A video.js plugin that displays error messages to video viewers.
JavaScript
88
star
22

generator-videojs-plugin

Yeoman generator for video.js plugins.
JavaScript
80
star
23

mpd-parser

JavaScript
78
star
24

vtt.js

A JavaScript implementation of the WebVTT specification, forked from vtt.js for use with Video.js
JavaScript
70
star
25

font

Icon font used for Video.js
CSS
60
star
26

videojs.com

The Video.js Website
MDX
58
star
27

designer

A video.js player skin editor using a live CSS editor
JavaScript
42
star
28

aes-decrypter

JavaScript
34
star
29

videojs-playbackrate-adjuster

A Video.js middleware that adjusts controls based on playback rate
JavaScript
28
star
30

videojs-contextmenu-ui

A cross-device context menu UI for video.js players.
JavaScript
28
star
31

cdn

The video.js CDN
JavaScript
24
star
32

ie8

Video.js files for IE8 compatibility
JavaScript
23
star
33

video.js-component

Video.js - HTML5 Video Player - Component
JavaScript
15
star
34

docs

videojs docs
JavaScript
14
star
35

plugin-concat

Concatenate videos for playback by videojs/http-streaming in a Video.js player
JavaScript
11
star
36

videojs-adaptive

Building support for adaptive streaming video formats into video.js
JavaScript
9
star
37

doc-generator

Auto-generate API docs for the video.js codebase and plugins
JavaScript
8
star
38

videojs-settings-menu

A place to incubate a new settings menu for videojs.
JavaScript
8
star
39

videojs-media-session

Media Session API plugin
JavaScript
8
star
40

vhs-utils

Objects and functions shared throughout @videojs/http-streaming code
JavaScript
7
star
41

videojs-4to5

Tools to ease the transition from video.js 4.x to 5.x.
JavaScript
7
star
42

thumb.co.il

The fancy front-end for Thumbcoil!
JavaScript
7
star
43

monorepo

Monorepo for all videojs packages
TypeScript
7
star
44

standard

JavaScript Standard Style — One Style to Rule Them All
JavaScript
6
star
45

remark-preset-lint-videojs

A remark linting preset for Video.js
JavaScript
5
star
46

blog

The video.js blog
Stylus
5
star
47

videojs-placeholder

A placeholder for videojs packages
5
star
48

videojs-contrib-quality-menu

Adds a quality selector button to the Video.js control bar for Video.js 8+
JavaScript
5
star
49

videojs-languages

JavaScript
4
star
50

grunt-videojs-languages

A grunt task to convert video.js language JSON files in to includable scripts.
JavaScript
4
star
51

autoplay-tests

Autoplay test examples
HTML
3
star
52

videojs-generate-rollup-config

Generate a standard rollup config, so that plugins don't need the same script in every repository.
JavaScript
3
star
53

eslint-config-videojs

JavaScript
3
star
54

webwackify

launch a web worker that can require() in the browser with browserify and webpack
JavaScript
3
star
55

tooling

A monorepo for all videojs project and plugin tooling
JavaScript
2
star
56

spellbook

JavaScript
2
star
57

rfcs

RFCs for changes to Video.js
2
star
58

generator-helpers

A package to keep all of our generator helpers packages, so everything can be updated more easily.
1
star
59

ffrwd

ffrwd is an extensible HTML5 streaming media player capable of playing HLS, MPEG-DASH and more!
1
star
60

.github

1
star
61

xhr

A small xhr wrapper
JavaScript
1
star
62

babel-config

A standard babel config, so that plugins don't need the same script in every repository.
JavaScript
1
star
63

videojs-bundler-sample

sample and test project for using Video.js with various bundler configurations
JavaScript
1
star
64

admin

Video.js organizational documentation
Shell
1
star
65

svg-sprite-generator

1
star