Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/videojs/videojs-contrib-dash
Video.js plugin for supporting the MPEG-DASH playback through a video.js player
https://github.com/videojs/videojs-contrib-dash
mpeg-dash-playback video videojs
Last synced: 26 days ago
JSON representation
Video.js plugin for supporting the MPEG-DASH playback through a video.js player
- Host: GitHub
- URL: https://github.com/videojs/videojs-contrib-dash
- Owner: videojs
- License: apache-2.0
- Created: 2015-07-07T20:24:45.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2023-05-24T20:02:29.000Z (over 1 year ago)
- Last Synced: 2024-11-08T08:03:07.738Z (about 1 month ago)
- Topics: mpeg-dash-playback, video, videojs
- Language: JavaScript
- Homepage: https://videojs.github.io/videojs-contrib-dash/
- Size: 58.8 MB
- Stars: 294
- Watchers: 45
- Forks: 129
- Open Issues: 64
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-video - videojs/videojs-contrib-dash - Video.js plugin for supporting the MPEG-DASH playback through a video.js player - videojs/videojs-contrib-dash (DASH / Talks Presentations Podcasts)
README
# video.js MPEG-DASH Source Handler
[](https://travis-ci.org/videojs/videojs-contrib-dash)
[](https://greenkeeper.io/)
[](http://slack.videojs.com)
[](https://nodei.co/npm/videojs-contrib-dash/)
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](http://slack.videojs.com).
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
- [Getting Started](#getting-started)
- [Protected Content](#protected-content)
- [Captions](#captions)
- [Using TTML Captions](#using-ttml-captions)
- [Multi-Language Labels](#multi-language-labels)
- [Passing options to Dash.js](#passing-options-to-dashjs)
- [Deprecation Warning](#deprecation-warning)
- [Initialization Hook](#initialization-hook)
## Getting Started
Download [Dash.js](https://github.com/Dash-Industry-Forum/dash.js/releases) and [videojs-contrib-dash](https://github.com/videojs/videojs-contrib-dash/releases). Include them both in your web page along with video.js:
```html
var player = videojs('example-video');
player.ready(function() {
player.src({
src: 'https://example.com/dash.mpd',
type: 'application/dash+xml'
});
player.play();
});
```
Checkout our [live example](http://videojs.github.io/videojs-contrib-dash/) 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:
```javascript
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.
```javascript
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`.
```javascript
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:
```javascript
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](http://cdn.dashjs.org/latest/jsdoc/module-MediaPlayer.html) 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:
```javascript
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
```javascript
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);
```