Skip to content

Commit

Permalink
Update README.md to describe nativeCaptions usage requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
justinanastos committed Apr 14, 2017
1 parent e3e16e0 commit ec76129
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,20 @@ var updateSourceData = function(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.

## 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.
Expand Down

0 comments on commit ec76129

Please sign in to comment.