Extension:MediawikiPlayer

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
MediawikiPlayer

Release status: stable

Implementation Tag
Description Embeds a media player into a wiki page
Author(s) Swiftlytilting (Frantiktalk)
Latest version 0.3.0 (09:25, 19 October 2010 (UTC))
License GNU GPL (but requires non-free CC BY-NC-SA JW Player)
Download MediawikiPlayer 0.3.0
Parameters

$wgMWPlayerDefaultSettings, $wgMWPlayerDir, $wgMWPlayerConfig, $wgMWPlayerUseSWFObject

Translate the MediawikiPlayer extension if possible

Check usage and version matrix; code metrics

The MediawikiPlayer extension embeds the JW FLV Media Player into a wiki page and supports multiple formats like FLV, MP4 (H264/AAC), MP3, Youtube-related formats, various streaming server-related formats and various XML playlists formats.

It is, however, licensed under a non-free CC BY-NC-SA license with noncommercial restrictions.

Currently working with the latest JW Player as of 2/6/2013. Addon PlayerPointer not working.

Usage[edit | edit source]

<mediaplayer argument=value >mediaURL</mediaplayer>

The argument may be any parameter or "flashvar" supported by the JW FLV Player. See the list of flashvars for more information regarding options of the JW FLV player.

Simple[edit | edit source]

<mediaplayer>http://www.yourdomain.com/mediafile.flv</mediaplayer>

Using arguments[edit | edit source]

<mediaplayer width='500' height='300'>http://www.yourdomain.com/mediafile.flv</mediaplayer>

Using a preview image[edit | edit source]

<mediaplayer image='http://domain.com/image.jpg'>http://www.yourdomain.com/mediafile.flv</mediaplayer>

Youtube[edit | edit source]

<mediaplayer>http://www.youtube.com/watch?v=y8Kyi0WNg40</mediaplayer>

Mp3 player[edit | edit source]

(simply sets default height='20')

<mp3player>http://www.yourdomain.com/mediafile.mp3</mp3player>

or without path to file

<mp3player>File:mediafile.mp3</mp3player>

Media uploaded to the wiki[edit | edit source]

<mediaplayer>File:UploadedMediafile.flv</mediaplayer>

Note about flashvars with dots in the name[edit | edit source]

Beginning with 0.2.5, some flashvars, such as captions.file or logo.position can be used with MediawikiPlayer. Since Mediawiki will not recognize non-alphanumeric characters in tag parameter names, a special code has been designated to signify a dot (period) character: 00.

For example, to represent captions.file, use the following code segment

<mediaplayer captions00file="http://example.com/captions.xml" ....

Currently there are no flashvars which utilize any character besides the dot, but just in case some extras were defined. The following special "escape" codes can be used in parameter names:

00 => . (dot/period)
01 => - (dash)
02 => _ (underscore)
09 => 0 (zero)

Downloads[edit | edit source]

Installation[edit | edit source]

To install this extension:

  1. Install MediawikiPlayer in yourwikidir/extensions/MediawikiPlayer/
  2. Install the following files from the JW FLV Media Player installation (available www.jwplayer.com) in yourwikidir/extensions/MediawikiPlayer/
    • player.swf
    • jwplayer.js
  1. Add the following to LocalSettings.php:
require_once("$IP/extensions/MediawikiPlayer/MediawikiPlayer.php");

Configuration parameters[edit | edit source]

$wgMWPlayerDefaultSettings[edit | edit source]

An array of the default settings for the player.

Default array:

$wgMWPlayerDefaultSettings = array(
              'width' => '400',
              'height' => '300',
              'allowfullscreen' => 'true',
              'backcolor' => 'eeeeee',
              );

$wgMWPlayerDir[edit | edit source]

Directory where the media player flash and javascript files are located. Default is in the same folder as the MediawikiPlayer script.

Default:

$wgMWPlayerDir =  '/w/extensions/MediawikiPlayer';

$wgMWPlayerConfig[edit | edit source]

An array of arrays to define multiple custom configurations.

$wgMWPlayerConfig = array( 
   'MyCustomConfig' => array ( 'width' => '400',
                               'height' => '300',
                               'allowfullscreen' => 'false',
                               'backcolor' => 'cccccc',
   ),
   'AnotherConfig' => array (  'width' => '600',
                               'height' => '400',
                               'allowfullscreen' => 'true',
                               'backcolor' => '000000',
   )
);

To invoke one of these configurations in Mediawiki:

<mediaplayer MWPlayerConfig="MyCustomConfig">http://www.example.com/mediafile.flv</mediaplayer>

$wgMWPlayerUseSWFObject[edit | edit source]

Set this value to true if you wish to use the older style embedding using swfobject.js instead of jwplayer.js.

$wgMWPlayerUseSWFObject = true;

You may also enable/disable this on a video by video basis. (Both swfobject.js and jwplayer.js must be installed for this to work)

<mediaplayer useSWF=true>http://www.example.com/mediafile.flv</mediaplayer>

Using add-ons[edit | edit source]

AddOns are extensions for MediawikiPlayer.

To enable an AddOn, place the file in the /Mediawikiplayer/AddOns folder and add the following code in LocalSettings.php AFTER you have included main MediawikiPlayer extension file

MediawikiPlayer::useAddOn('AddOnName');
PlayerPointer[edit | edit source]

Currently one AddOn is included with MediawikiPlayer: PlayerPointer, created by Anner van Hardenbroek. This AddOn allows you to use the new JWPlayer API to make the mediaplayer seek to a specific location in the media file using the videopointer oraudiopointer tags.

Example:

<mediaplayer>File:MyMediafile.flv</mediaplayer>
<videopointer>30</videopointer>

In this example, a link will be created which will seek to 30 seconds into the clip. You may also use hh:mm:ss notation.

How to configure LocalSettings.php for use with PlayerPointer:

require_once( "$IP/extensions/MediawikiPlayer/MediawikiPlayer.php" );
MediawikiPlayer::useAddOn('PlayerPointer');

Changelog[edit | edit source]

v.0.3.0[edit | edit source]

  • Added support for JWPlayer 5.3's jwplayer.js
  • Added AddOn support
  • Added internationalization for the File: namespace
  • Reorganized code

v.0.2.5[edit | edit source]

  • Added support for flashvars with dots in the name so that captions can be used.

v.0.2.4[edit | edit source]

  • Fixed issue where some FlashParams were showing up as FlashVariables instead.

v.0.2.3[edit | edit source]

  • Additional security fix for servers with register_globals enabled.

v.0.2.2[edit | edit source]

  • Additional XSS security errors fixed.
  • Prevented register_globals injections. All settings must be made after the require_once call in LocalSettings.php

v.0.2.1[edit | edit source]

  • Fixed a bug when loading local files stored on the wiki

v.0.2.0[edit | edit source]

  • Fixed XSS security risk.
  • Added ability to load media directly from the wiki using File:medianame.ext shortcut
  • Added ability to store various default configurations with $wgMWPlayerConfig

v.0.1.0[edit | edit source]

  • First public release

External links[edit | edit source]