Skip to content

Commit

Permalink
Updated readme with config options, screenshot
Browse files Browse the repository at this point in the history
Updated readme with config options, screenshot
  • Loading branch information
jfujita1 committed Feb 27, 2019
1 parent 393456d commit 492b6bf
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Expand Up @@ -2,6 +2,31 @@

VideoJS plugin that leverages videojs-contrib-quality-levels plugin to offer manual user-selectable level selection options for adaptive http streams.

![Alt text](doc/images/example.png "Source selector")

Compatible with vjs 7 and up.

### Labels:
Level labels are generated from the ```height``` and ```bitrate``` metadata parsed from the stream QualityLevels sources. If ```height``` isn't available in the stream metadata, the labels will default to ```bitrate```.

### Default settings:
You can configure a bias to lock playback to the highest or lowest resolution by default by passing one of the below plugin options into your videojs initializer.

#### Low:
```js
httpSourceSelector:
{
default: 'low'
}
```
#### High:
```js
httpSourceSelector:
{
default: 'high'
}
```

## Table of Contents

<!-- START doctoc -->
Expand Down
Binary file added doc/images/example.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 492b6bf

Please sign in to comment.