Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomexsans/videojs-quality-selector-hls
https://github.com/tomexsans/videojs-quality-selector-hls
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/tomexsans/videojs-quality-selector-hls
- Owner: tomexsans
- License: mit
- Created: 2023-07-27T10:07:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-27T09:11:29.000Z (over 1 year ago)
- Last Synced: 2025-01-08T17:14:33.279Z (13 days ago)
- Language: JavaScript
- Size: 409 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# videojs-quality-selector-hls
[](https://github.com/tomexsans/videojs-quality-selector-hls/actions/workflows/ci.yml)
[](https://codecov.io/gh/tomexsans/videojs-quality-selector-hls)
This is a Plugin For VideoJS 8+ To select Quality on the Video if available
This is a complete FORK by https://github.com/chrisboustead from https://github.com/chrisboustead/videojs-hls-quality-selector
Changelog
- updated to work for VideoJS 8
- pulled plugin source code from https://github.com/videojs/generator-videojs-plugin
## Table of Contents
## Dependencies
`videojs-contrib-quality-levels ^4`
```sh
npm i videojs-contrib-quality-levels
```
- [Installation](#installation)
- [Usage](#usage)
- [`` Tag](#script-tag)
- [Browserify/CommonJS](#browserifycommonjs)
- [RequireJS/AMD](#requirejsamd)
- [VueJS3](#vuejs3)
- [Options](#options)
- [displayCurrentQuality - `boolean` - _false_](#displaycurrentquality---boolean---_false_)
- [placementIndex - `integer`](#placementindex---integer)
- [vjsIconClass `string` - _"vjs-icon-hd"_](#vjsiconclass-string---_vjs-icon-hd_)
- [License](#license)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## Installation
```sh
npm install --save videojs-quality-selector-hls
```
## Usage
To include videojs-quality-selector-hls on your website or web application, use any of the following methods.
### `<script>` Tag
This is the simplest case. Get the script in whatever way you prefer and include the plugin _after_ you include [video.js][videojs], so that the `videojs` global is available.
```html
<script src="//path/to/video.min.js">
var player = videojs('my-video');
player.qualitySelectorHls();
```
### Browserify/CommonJS
When using with Browserify, install videojs-quality-selector-hls via npm and `require` the plugin as you would any other module.
```js
var videojs = require('video.js');
// The actual plugin function is exported by this module, but it is also
// attached to the `Player.prototype`; so, there is no need to assign it
// to a variable.
require('videojs-quality-selector-hls');
var player = videojs('my-video');
player.qualitySelectorHls();
```
### RequireJS/AMD
When using with RequireJS (or another AMD library), get the script in whatever way you prefer and `require` the plugin as you normally would:
```js
require(['video.js', 'videojs-quality-selector-hls'], function(videojs) {
var player = videojs('my-video');
player.qualitySelectorHls();
});
```
### VueJS3
```js
import 'video.js/dist/video-js.css'
import { ref,onMounted } from 'vue';
import videojs from 'video.js';
import 'videojs-contrib-quality-levels';
import qualitySelectorHls from 'videojs-quality-selector-hls'
const videoPlayer = ref(null)
onMounted(()=>{
// In case an error where qualitySelectorHls not found
videojs.registerPlugin('qualitySelectorHls',qualitySelectorHls);
const player = videojs(videoPlayer.value)
player.qualitySelectorHls()
})
```
## Options
### displayCurrentQuality - `boolean` - _false_
Set to true to display the currently selected resolution in the menu button. When not enabled, displayed an included VJS "HD" icon.
### placementIndex - `integer`
Set this to override the default positioning of the menu button in the control bar relative to the other components in the control bar.
### vjsIconClass `string` - _"vjs-icon-hd"_
Set this to one of the custom VJS icons ([https://videojs.github.io/font/](https://videojs.github.io/font/)) to override the icon for the menu button.
```js
var player = videojs('my-video');
player.qualitySelectorHls({
displayCurrentQuality: true,
placementIndex: 2,
vjsIconClass: 'vjs-icon-hd'
});
```
## License
MIT. Copyright (c) Tomexsans Evaristo <[email protected]>
[videojs]: http://videojs.com/