Dynamic quality selector - Reacts to video.js source changes #49
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Merge Upstream
Fixes issue where quality selector does not appear if video.js is not initialized with an HLS file. Dynamically shows and hides quality selector based on loaded video Allows for quality selector to be used in the same player that shows non HLS files
DispatchCommit
commented
Feb 18, 2021
| this.bindPlayerEvents(); | ||
| // Ensure dependencies are met | ||
| if (!this.player.qualityLevels) { | ||
| console.warn(`Error: Missing videojs-contrib-quality-levels plugin (required by videojs-hls-quality-selector)\nhttps://github.com/videojs/videojs-contrib-quality-levels`); |
There was a problem hiding this comment.
Added a reminder warning to the console output in case we are missing a dependency.
| this.bindPlayerEvents(); | ||
|
|
||
| // Listen for video source changes | ||
| this.player.on('loadedmetadata', () => this.updatePlugin()); |
There was a problem hiding this comment.
This is the new event listener added that detects when we've loaded a new video into the player.
| /** | ||
| * Updates the UI when video.js source changes | ||
| */ | ||
| updatePlugin() { |
There was a problem hiding this comment.
These checks are ran everytime the source video changes.
| this._qualityButton.show(); | ||
| } else { | ||
| // Hide the quality selector | ||
| this._qualityButton.hide(); |
There was a problem hiding this comment.
We just toggle .hide() / .show() to add or remove the quality selector on demand when video files change.
| */ | ||
| setupPlugin() { | ||
| // Create the quality selector button. | ||
| this.createQualityButton(); |
There was a problem hiding this comment.
We now always create the button, but modify it's visibility according to video source
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I ran into an issue with videojs-hls-quality-selector on my project where I was loading unknown video file types into the player. Some MP4's, some HLS, some MP3's, and only some of them had multiple quality options.
Currently, this plugin will not work if video.js is initialized with anything but an HLS media. This meant if my player loaded an MP4 file first, and then was given an HLS url, I would have to dispose and recreate the entire video.js instance just to have the quality selector appear. Alternatively I could add the quality levels manually, but why shouldn't this plugin be able to detect and react to changes in player source. Video.js can change tech's on the fly, but this plugin only initializes itself once.
So to improve this, I added 1 new event listener to the plugin that registers when the plugin initializes that listens for when new sources are loaded into video.js. When a new source is loaded, the plugin will then run the check for HLS quality levels. If the tech is HLS, then we will show the quality selector button. However if the tech does not support multiple qualities, such as MP4, then we will hide the quality selector button. Every time the source is changed, we check if the button should be visible or not.
This makes the plugin way more flexible and prevents having to constantly recreate the video.js player just to show or hide the selector. and it does so automatically.
These changes have been applied to a copy of videojs-hls-quality-selector locally in our repo to solve the issue mentioned above.
lbryio/lbry-desktop#5539
Please let me know if you would like any changes or modifications to better suit general use cases.