close
Jump to content

Extension:TimedMediaHandler/VideoJS Player

From mediawiki.org
Image
Screenshot of the VideoJS player in action

The VideoJS Player is the video player for MediaWiki on Wikimedia projects.

It is based on VideoJS, and has a modern, fast user interface with compatibility with mobile devices and HTML5.

Usage

Example video player
Example audio player without subtitle popup
Example audio player with subtitles

There is both an audio and video player. You can find examples of both players on this page. Once launched you will see a control bar when interacting with the video.

Image

The controls in order from left to right are:

  • Image Play/pause control
  • Image Volume control
  • Playback position
  • Remaining playback time
  • Image Subtitle language selector and subtitle style controls
  • Image Resolution selector
  • Image Optional Picture-in-Picture control
  • Image Fullscreen control
  • Image Info button to take you to the file description page

Mouse and keyboard controls

  • Click the play icon above the thumbnail to begin playback of the media file.
  • Right click or middle click the thumbnail to open the file description page
  • Play/Pause the player with a single mouse click inside the player window
  • Double click the player window to enter or leave fullscreen mode
  • The following keyboard controls are available:
    k / Space
    Play/pause the media playback
    f
    Enter/Leave fullscreen
    m
    Mute the audio
    c / s
    Toggle subtitles on / off
    < / >
    Decrease and increase playback speed
    /
    Skip 5 seconds back / forward
    j / l
    Skip 10 seconds back / forward
    Home / End
    Skip to start / end of video
    , / .
    When paused, skip 1 frame back or forward
  • The player is fully keyboard accessible using Tab ↹, ↵ Enter and Space keys

Known issues

The video player is still in development, but if you find any problems, please report these on the talk page or file them in Phabricator.

Developers

Developers working on features that use the Video.js player will need to initialize and configure it appropriately. Below is an example of typical usage.

Basic Configuration Example

This is outdated and should be reworked to make use of our player wrappers, which apply consistent options and settings for videojs playback.
// The first argument can be a string ID or a <video> element
var player = videojs( 'my-player-id', {
    controls: true,
    autoplay: false,
    poster: "https://path/to/poster/image"
    sources: [ /* array of source files in various sizes and formats */ ]
} );

The sources can also be provided in the HTML ‎<video> element instead of in JS:

<video class="video-js">
  <source src="//vjs.zencdn.net/v/oceans.mp4" type="video/mp4">
  <source src="//vjs.zencdn.net/v/oceans.webm" type="video/webm">
</video>