Extension:Video

Warning:

This extension is most likely not feature-complete or otherwise suitable for a production-grade site yet! Proceed with caution. Please use Extension:YouTube to play external videos or Extension:TimedMediaHandler or Extension:EmbedVideo to play locally stored videos, unless you're a developer willing to develop this extension further.

MediaWiki extensions manual

Video Release status: beta
Implementation	Special page
Description	Allows new Video namespace for embeddable media on supported sites
Author(s)	David Pean Jack Phoenix John Du Hart Mainframe98 Universal Omega
Latest version	1.9.4
MediaWiki	1.39+
Database changes	Yes
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (Phabricator · GitHub) commit history repository contributors (GitHub) code review README
Example	Social Tools Development Wiki
Added rights addvideo
Hooks used ArticleFromTitle LoadExtensionSchemaUpdates PageDelete PageUndelete ParserBeforeInternalParse ParserBeforePreprocess ParserFirstCallInit UndeleteForm::showHistory wgQueryPages
Quarterly downloads	32 (Ranked 97th)
Translate the Video extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

Video is an extension that allows you to import videos from different video services, such as YouTube, DailyMotion or Metacafe. The extension adds two new special pages, Special:AddVideo, which all registered users or other users with 'addvideo' permission can access to add new videos to the site and Special:NewVideos, which lists all recently added videos. The extension also adds ‎<videogallerypopulate> parser hook tag.

Video additions are logged into the video log at Special:Log/video.

This extension was originally written by David Pean for Fandom, Inc. Some code cleanup was done by Łukasz 'TOR' Garczewski and Bartek Łapiński for Fandom, Inc. and by Jack Phoenix for ShoutWiki.

Supported video providers

1. DailyMotion
2. MetaCafe
3. MyVideo
4. Sevenload
5. South Park Studios
6. Viddler
7. Vimeo
8. YouTube

Installation

• Download and move the extracted Video folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Video
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'Video' );
  

• Run the update script which will automatically create the necessary database tables that this extension needs.
•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Usage

After adding a video through Special:AddVideo, you can embed it into an article by using the syntax [[Video:Video's Name Here]] or <video name="Video's Name Here"/>.

The extension also has the functionality to display videos in a gallery format, in similar fashion to the <gallery> tag. To achieve this, wrap the videos in the <videogallery> tag.

To-do list/known bugs

1. Write the code for supporting 5min.com, Nicovideo and Tangler.com
2. If a video is embeded in a page and this page is later transcluded, it only shows a link to Video:foo and not the embeded video.

Developer Info

Provider classes for different video hosting sites are stored in the providers directory. Writing a new provider class is easy:

1. copy the example provider class into the providers directory and name it accordingly (for example, ExampleVideo.php)
2. autoload the new provider class in Video.php
3. add the provider to Video::$providers
4. enjoy!

Example provider class

<?php

class ExampleVideoProvider extends BaseVideoProvider {
	// Used to extract the $video_id from the URL
	protected $videoIdRegex = '#/watch/([a-zA-Z0-9_\-]+)/#';
	// Set this to the embed, and use $width, $height and $video_id appropriately
	protected $embedTemplate = '<object width="$width" height="$height"><param name="movie" value="$video_id">...etc';

	/**
	 * Gives all domains that this provider should respond to
	 *
	 * Second level domains are preferred
	 *
	 * @return array
	 */
	public static function getDomains() {
		return array( 'example.com' );
	}

	/**
	 * Return the aspect ratio for the video player
	 *
	 * Just what the player is set to by default: Width / Height
	 *
	 * @return float
	 */
	protected function getRatio() {
		return 512 / 296;
	}

	/**
	 * If there is more complexity to retrieving the $video_id for the embed
	 * code than a single regular expression, override this function.
	 * 
	 * If you make an HTTP call (eg. to an API) you MUST cache it with $wgMemc
	 * 
	 * @param string $url URL to extract the ID from
	 * @return bool|null|Object
	 */
	/*
	protected function extractVideoId( $url ) {
		// Check out HuluVideoProvider or Viddler for an example
	}
	*/
	
	/**
	 * Override this function for cases where the HTML embed code is complex
	 * and has special cases.
	 * 
	 * @return string Raw HTML to display the video
	 */
	/*
	public function getEmbedCode() {
		return '...';
	}
	*/

}