Extension:FramedVideo

From MediaWiki.org

Manual on MediaWiki Extensions
List of MediaWiki Extensions

FramedVideo Release status: stable
Implementation	Tag
Description	Allows embedding videos from various services
Author(s)	RuizTalk
Last Version	1.1.2 (2009-04-07)
MediaWiki	fully tested on 1.11.0 and 1.13.x, should work on 1.8+; PHP 5 is required
License	GPL
Download	from ftp
Example	few examples including error handling; you can use sandbox for testing
check usage (experimental)

FramedVideo extension allows embedding videos from 44 video hosting services.

FramedVideo is based on Video Flash extension by Alberto Sarullo, which is based on YouTube extension by Iubito.

Note for real programmers: This extensions has a really ugly code. It's author is not a PHP programmer but just a guy who really needs this extensions for his website. But hey, this extension works.

Note: Please upgrade to the newest version and keep eye on changes!

[edit] What can this extension do?

• Handle videos from 44 video hosting services.
• Put them into frames that MediaWiki uses by default to show images.
• Provide wikitext-supporting description below videos.
• Scale all video (default width and height values are stored in the extension core).
• Set some global variables for configuration around the whole wiki.
• Handle all errors user may cause.

[edit] What this extension can't do?

• Validate values of id parameter. Videos just won't be loaded if a video id is not valid. A few services show some error messages for invalid id's, most do not.

[edit] Download instructions

The latest version of this extension can be downloaded from ftp. Download files FramedVideo.php and FramedVideo.i18n.php. Create $IP/extensions/FramedVideo/ directory and copy there both files.

[edit] Installation

To install this extension, add the following to LocalSettings.php:

require_once("$IP/extensions/FramedVideo/FramedVideo.php");

[edit] Usage

Full syntax:

<video type="service" id="1234abc" width="270" height="203" desc="Here's lovelly video" frame="true" position="right" size="full" allowfullscreen="true"/>

Usual syntax:

<video type="service" id="1234abc" desc="Here's lovelly video"/>

Note: blip.tv requires width2 parameter for proper scalling.

[edit] Configuration

[edit] MW messages

When installing, the default English messages are used (but see supported languages for more). If you translated this messages into your language, please put them in talk page and claim that you relased it under GPL terms.

Some configuration can be done via MediaWiki messages or through light mode and LocalSettings.php. Here's the full list of messages that extensions creates (they do not exist here and will apear when you done installation):

[edit] Light mode

Light mode is a new feature added in version 1.1 that allow setting some global variables through LocalSetting.php instead of MW messages. Light mode, when properly configurated and no user's errors are made, decreases number of database queries to 0.

To use FramedVideo in light mode you should add the following lines after the line

require_once("$IP/extensions/FramedVideo/FramedVideo.php");

in your LocalSetting.php file:

$wgFramedVideoLightMode = true;
$wgFramedVideoDefaultWidth = 270;
$wgFramedVideoForceDefaultSize = false;
$wgFramedVideoMaxWidth = 852;
$wgFramedVideoMaxHeight = 510;
$wgFramedVideoAllowFullScreen = true;
$wgFramedVideoForceAllowFullScreen = false;
$wgFramedVideoFrames = true;
$wgFramedVideoForceFrames = false;
$wgFramedVideoPosition = "right";
$wgFramedVideoForcePosition = false;

Every of this set overrides setting made by MW message. You can still leave some of this values commented out like this:

#$wgFramedVideoDefaultWidth = 270;

so it can be set via MW message. You can also set

$wgFramedVideoLightMode = false;

so there's no need to comment out everything, when there's a need to configure via MW messages. Every of this set is optional. You can leave only

require_once("$IP/extensions/FramedVideo/FramedVideo.php");

and still set everything via MW messages.

When to use light mode

• If you have big wiki.
• If you have high traffic wiki.
• If you have cheap virtual private servers.
• If you use free hosting.
• If you don't want your admins to change any of FramedVideo's settings.

When not to use light mode

• If you have small or private wiki.
• If you have a strong dedicated server.
• If you have wiki farm and admins have no access to LocalSettings.php.
• If you don't have access to LocalSettings.php by yourself too often.
• If you still want to have FramedVideo's settings ready at hand.

[edit] Supported services

[edit] Supported languages

This languages are supported when handling user's errors. Extension will work well with any wiki language. You can help with translation.

• English
• Polish

[edit] Known issues

[edit] Extension compatibility

This extension will not work with EmbeddedVideo extension since they're using the same <video/> tag. If you already have EmbeddedVideo installed on your wiki, you can change the following line in FramedVideo.php:

$wgParser->setHook('video', 'renderFramedVideo');

to:

$wgParser->setHook('video2', 'renderFramedVideo');

and use <video2/> tag for embedding throught FramedVideo. Or you can change it to whatever you want.

[edit] Video services issues

The following services videos aren't scalable at all (using size="full" is recommended):

• Break
• ClipShack
• Comedy Central (requires widht and height parameters, videos has few sizes)
• Interia (Znajomi)

The following services players are not fully scalable (tested on default width 270):

• Gazeta.pl Wideo (progress bar gets extremelly small)
• Shoutfile (progress bar and volume bar overlaps)
• Viddler (progress bar looks bugged)

[edit] Unwanted services

If you don't want some services to be supported on your wiki, go to lines 40-85 in FramedVideo.php and uncomment what you need, for example change:

	$twidth['youtube'] = 425;		$theight['youtube'] = 344;

to:

	#$twidth['youtube'] = 425;		$theight['youtube'] = 344;

so YouTube will not longer be recognized as supported service.

[edit] Bugs and contribution

• If you find any bugs, please describe it on talk page.
• If you know any other video services that can be added to this extention, leave info on talk page.
• If you can help with translating MW messages into your language, please put them translated (check latest version of FramedVideo.i18n.php for what needs translation) on talk page and claim that you are releasing it under GPL terms.
• If you had an idea on what more this extensions may do, well, you know where talk page is.

[edit] Changelog

[edit] See also

• Extension:VideoFlash on which that one is based