A playlist video picker for video.js and videojs-playlist
Maintenance Status: Stable
- Getting Started
- Root Element
- Other Options
- Playlists and Advertisements
Include the plugin script in your page, and a placeholder list element with the class
vjs-playlist to house the playlist menu:
<!-- Include the playlist menu styles somewhere in your page: --><!-- The playlist menu will be built automatically in here: --><!-- Include video.js, the videojs-playlist plugin and this plugin: -->
There's also a working example of the plugin you can check out if you're having trouble.
Before this plugin will work at all, it needs an element in the DOM to which to attach itself. There are three ways to find or provide this element.
NOTE: In v2.x of this plugin, the root element was expected to be a list element (i.e.,
<ul>). As of v3.x, the plugin creates a list; so, this root element must be a non-list container element (e.g.,
By default, the plugin will search for the first element in the DOM with the
To defend against problems caused by multiple playlist players on a page, the plugin will only use an element with the
vjs-playlist class if that element has not been used by another player's playlist.
className option can be passed to override the class the plugin will search for to find the root element. The same defense against multiple playlist players is reused in this case.
A custom element can be passed using the
el option to explicitly define a specific root element.
NOTE: Previously, the plugin supported passing the element in lieu of passing options. That feature is deprecated and will be removed in 4.0. Please use the
eloption going forward.
In addition, the options object may contain the following specialized properties:
As mentioned above, the name of the class to search for to populate the playlist menu.
The default behavior is that the play state is expected to stay the same between videos. If the player is playing when switching playlist items, continue playing. If paused, stay paused.
When this boolean is set to
true, clicking on the playlist menu items will always play the video.
Playlists and Advertisements
PlaylistMenu automatically adapts to ad integrations based on videojs-contrib-ads. When a linear ad is being played, the menu will darken and stop responding to click or touch events. If you'd prefer to allow your viewers to change videos during ad playback, you can override this behavior through CSS. You will also need to make sure that your ad integration is properly cancelled and cleaned up before switching -- consult the documentation for your ad library for details on how to do that.