Extension:EmbedVideo

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
EmbedVideo

Release status:Extension status stable

ImplementationTemplate:Extension#type Parser function
DescriptionTemplate:Extension#description Adds a parser function called #ev for embedding video clips from popular video sharing services.
Author(s)Template:Extension#username Alexia E. Smith (Alexia E. Smith), Andrew Whitworth (Whiteknight), Jim R. Wilson (Jimbojw), and Mohammad Derakhshani (Mderakhs)
Latest versionTemplate:Extension#version 2.4.1 (2016-08-30)
MediaWikiTemplate:Extension#mediawiki 1.25+
PHPTemplate:Extension#php 5.4+(5.3 up to EmbedVideo 2.2.1)
LicenseTemplate:Extension#license MIT License
Download
ExampleTemplate:Extension#example Gamepedia Help Wiki
Hooks usedTemplate:Extension#hook
ParserFirstCallInitManual:Hooks/ParserFirstCallInit

Translate the EmbedVideo extension if it is available at translatewiki.net

Check usage and version matrix.
Vagrant roleMediaWiki-Vagrant#Using roles embedvideo

The EmbedVideo Extension is a MediaWiki extension which adds a parser function called #ev for embedding video clips from over 24 popular video sharing services in multiple languages and countries. It also adds video and audio media handlers to support transforming standard [[File:Example.mp4]] file links into embedded HTML5 <video> and <audio> tags.

Project Homepage
Documentation at Github
Source Code
Source code at Github
Bugs
issues at Github
Licensing
EmbedVideo is released under The MIT License.

Notice: As of the 2.x series the EmbedVideo extension has a new maintainer and an entirely rewritten code base. It retains backwards compatibility with EmbedVideo 1.0 and EmbedVideoPlus.

Installation[edit]

  • Download and place the file(s) in a directory called EmbedVideo in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'EmbedVideo' );
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing extensions using wfLoadExtension(), since MediaWiki 1.25. If you need to install this extension in earlier versions, instead of wfLoadExtension( 'EmbedVideo' );, you need to use:

require_once "$IP/extensions/EmbedVideo/EmbedVideo.php";

Usage[edit]

Media Handler[edit]

For locally uploaded content the process for displaying it on a page is the same as an image. See the image syntax documentation on MediaWiki.org for complete reference on this feature.

This example would display a video in page using a HTML5 `<video>` tag.

[[File:Example.mp4]]

To specify the start and end timestamps in the media use the start and end parameters. The timestamp can be formatted as one of: ss, :ss, mm:ss, hh:mm:ss, or dd:hh:mm:ss.

[[File:Example.mp4|start=2|end=6]]

Tags[edit]

The EmbedVideo parser function expects to be called in any of the following ways:

#ev - Classic Parser Tag[edit]

  • {{#ev:service|id}}
  • {{#ev:service|id|dimensions}}
  • {{#ev:service|id|dimensions|alignment}}
  • {{#ev:service|id|dimensions|alignment|description}}
  • {{#ev:service|id|dimensions|alignment|description|container}}
  • {{#ev:service|id|dimensions|alignment|description|container|urlargs}}
  • {{#ev:service|id|dimensions|alignment|description|container|urlargs|autoresize}}

However, if needed optional arguments may be left blank by not putting anything between the pipes:

  • {{#ev:service|id|||description}}

#evt - Parser Tag for Templates[edit]

The #evt parser tag allows for key=value pairs which allows for easier templating and readability.

{{#evt:
service=youtube
|id=https://www.youtube.com/watch?v=pSsYTj9kCHE
|alignment=right
}}

<embedvideo> - Tag Hook[edit]

Videos can easily be embedded with the <embedvideo></embedvideo> tag hook. The ID/URL goes as the input between the tags and parameters can be added as the tag arguments.

<embedvideo service="youtube">https://www.youtube.com/watch?v=pSsYTj9kCHE</embedvideo>

Attributes for Parser Tags[edit]

Attribute Description
service="(See Supported Services below.)" Required: yes
The video service to call.
id="[id|url]" Required: yes
The raw ID of the video or URL from the player page.
dimensions="[WIDTH|WIDTHxHEIGHT|xHEIGHT]" Required: no, Default: 640
Dimensions in pixels to size the embed container. The standard format is width x height where either can be omitted, but the x must proceed height to indicate it as the height.
Examples: 480, 480x320, x320. If the height is not provided it will be calculated automatically from the width and service default ratio.
Some services such as Gfycat do not have standard heights and should be specified for each embed. $wgEmbedVideoDefaultWidth can be set in LocalSettings.php to override the default width.
alignment="[left|center|right|inline]" Required: no, Default: none
Align the placement of the video either to the left, centered, or to the right. Inline will allow multiple videos to display side by side without forced line breaks.
description="[wiki text]" Required: no, Default: none
Display a description under the embed container.
container="[frame]" Required: no, Default: none
Specifies the container type to use for the embed.
frame: Wrap the video player in a Mediawiki thumbnail box.
urlargs="modestbranding=1&version=3" Required: no, Default: none
Allows extra URL arguments to be appended to the generated embed URL. This is useful for obscure options only supported on one service.
autoresize="false" Required: no, Default: true
Automatically resize videos when their size will cause them to break outside of their container element.

Examples[edit]

Example #1

For example, a video from YouTube uses the 'youtube' service selector. You can specify either the raw ID:

{{#ev:youtube|pSsYTj9kCHE}}

Or specify the full URL:

{{#ev:youtube|https://www.youtube.com/watch?v=pSsYTj9kCHE}}


Example #2




To display the same video as a right aligned large thumbnail with a description:

{{#ev:youtube|https://www.youtube.com/watch?v=pSsYTj9kCHE|1000|right|Let eet GO|frame}}

For YouTube to have the video start at a specific time code utilize the urlargs(URL arguments) parameter. Take the rest of the URL arguments from the custom URL and place them into the urlargs. Please note that not all video services support extra URL arguments or may have different keys for their URL arguments.

https://www.youtube.com/watch?v=pSsYTj9kCHE&start=76
{{#ev:youtube|https://www.youtube.com/watch?v=pSsYTj9kCHE|||||start=76}}

URL arguments can be used to chop up a video and loop it:

https://www.youtube.com/watch?v=pSsYTj9kCHE&start=160&end=180&loop=1
{{#ev:youtube|https://www.youtube.com/watch?v=pSsYTj9kCHE|||||start=160&end=180&loop=1}}

Supported Services[edit]

As of version 2.x, EmbedVideo supports embedding video content from the following services:

Site Service Name(s) ID Example URL Example(s)
Archive.org Videos archiveorg electricsheep-flock-244-80000-6 https://archive.org/details/electricsheep-flock-244-80000-6
 https://archive.org/embed/electricsheep-flock-244-80000-6
Bambuser bambuser - Broadcasts bambuser_channel - Channels 5262334 http://bambuser.com/v/5262334
Beam beam - Streams RocketBear https://beam.pro/RocketBear
Bing bing 31ncp9r7l http://www.bing.com/videos/watch/video/adorable-cats-attempt-to-eat-invisible-tuna/31ncp9r7l
Blip.tv blip - Blip requires the full URL to the video page and does not accept the raw ID. http://blip.tv/vinylrewind/review-6864612
C3TV mediacccde 32c3-7305-quantum_cryptography https://media.ccc.de/v/32c3-7305-quantum_cryptography
CollegeHumor collegehumor 6875289 http://www.collegehumor.com/video/6875289/batman-says-his-goodbyes
Dailymotion dailymotion x1adiiw_archer-waking-up-as-h-jon-benjamin_shortfilms http://www.dailymotion.com/video/x1adiiw_archer-waking-up-as-h-jon-benjamin_shortfilms
Daum TVPot tvpot - Obtain the URL or ID from the share menu URL. s9011HdLzYwpLwBodQzCHRB http://tvpot.daum.net/v/s9011HdLzYwpLwBodQzCHRB
Div Share divshare
Edutopia Edutopia content moved to YouTube. Please use the youtube service selector below.
FunnyOrDie funnyordie c61fb67ac9 http://www.funnyordie.com/videos/c61fb67ac9/to-catch-a-predator-elastic-heart-edition
Gfycat gfycat BruisedSilentAntarcticfurseal http://www.gfycat.com/BruisedSilentAntarcticfurseal
Hitbox hitbox Washuu http://www.hitbox.tv/Washuu
JW Player jwplayer cr5d8nbu-8ZpoNmmJ https://content.jwplatform.com/players/cr5d8nbu-8ZpoNmmJ.html
Kickstarter kickstarter elanlee/exploding-kittens https://www.kickstarter.com/projects/elanlee/exploding-kittens
Metacafe metacafe 11404579 http://www.metacafe.com/watch/11404579/lan_party_far_cry_4/
Nico Nico Video nico sm24394325 http://www.nicovideo.jp/watch/sm24394325
RuTube rutube b698163ccb67498db74d50cb0f22e556 http://rutube.ru/video/b698163ccb67498db74d50cb0f22e556/
TeacherTube teachertube 370511 http://www.teachertube.com/video/thats-a-noun-sing-along-hd-version-370511
TED Talks ted bruce_aylward_humanity_vs_ebola_the_winning_strategies_in_a_terrifying_war http://www.ted.com/talks/bruce_aylward_humanity_vs_ebola_the_winning_strategies_in_a_terrifying_war
Tubi TV tubitv 318409 http://tubitv.com/video/318409
Tudou tudou mfQXfumwiew http://www.tudou.com/listplay/mfQXfumwiew.html
Twitch twitch - Live Streams twitchvod - Archived Videos on Demand twitchplayspokemon http://www.twitch.tv/twitchplayspokemon
Videomaten videomaten
Vimeo vimeo 105035718 http://vimeo.com/105035718
Vine vine h2B7WMtuX2t https://vine.co/v/h2B7WMtuX2t
Yahoo Screen yahoo katy-perry-dances-sharks-2015-024409668 https://screen.yahoo.com/videos-for-you/katy-perry-dances-sharks-2015-024409668.html
YouTube youtube - Single Videos youtubeplaylist - Playlists pSsYTj9kCHE https://www.youtube.com/watch?v=pSsYTj9kCHE
 https://www.youtube.com/watch?v=CW_PbErQ_c8&list=PL76E80C7F756A2047
Youku youku XODc3NDgzMTY4 http://v.youku.com/v_show/id_XODc3NDgzMTY4.html

Configuration Settings[edit]

Variable Default Value Description
$wgEmbedVideoMinWidth Integer - Minimum width of video players. Widths specified below this value will be automatically bounded to it.
$wgEmbedVideoMaxWidth Integer - Maximum width of video players. Widths specified above this value will be automatically bounded to it.
$wgEmbedVideoDefaultWidth Integer - Globally override the default width of video players. When not set this uses the video service's default width which is typically 640 pixels.
$wgFFmpegLocation /usr/bin/ffmpeg String - Set the location of the ffmpeg binary.
$wgFFprobeLocation /usr/bin/ffprobe String - Set the location of the ffprobe binary.

Patch Notes[edit]

v2.4.1
  • Merged Sophivorus' improvements and fixes.
    • Support for TubiTV.com with the tubitv service identifier.
    • Fixed vimeo aspect ratio.
    • Fixed dailymotion ID regex.
  • Fixed error messages being double parsed.
v2.4.0
  • New media handlers to embed locally uploaded video and audio files.
    • Requires ffmpeg and ffprobe binaries to be installed.
    • Uses HTML5 <video> and <audio> tags.
  • Two new settings:
    • $wgFFmpegLocation - Set the location of the ffmpeg binary.
    • $wgFFprobeLocation - Set the location of the ffprobe binary.
v2.3.3
  • Support for JW Player.
v2.3.2
  • Fix auto resize breaking when leaving full screen.
v2.3.1
  • Fixed issue #54 (EmbedVideo doesn't work with mw-collapsible class)
  • Fixed issue #50 ("arg" should be "args" in addService)
  • Added "inline" alignment option
  • Fixed center alignment option css
  • Auto Resize now targets mobile as well
v2.3.0
  • Hard cut off of support for versions older then MediaWiki 1.25
  • Auto Resize attribute added
  • Reverted array_key_exists() regression to fix the `<embedvideo>` tag being broken.
v2.2.9
v2.2.8
v2.2.7
v2.2.6
  • NicoNico Video ID fixes; will work with new ID formats.
v2.2.5
v2.2.4
  • Fix Bing to work with their new URLs.
  • Remove MSN as their new video service does not support embedding.
  • Standardize Tudou support per their wiki.
v2.2.3
  • Added support for Youku and Tudou.
v2.2.2
  • Updated regular expression replacement pattern for Twitch URLs. Old Twitch embed URLs do not automatically redirect.
v2.2.1
v2.2.0
  • Fixed a bug with alignment that would cause the left align to not work similar to how MediaWiki handles images and other media.
  • New parser tag better suited for templates; #evt.
  • New HTML like tag format that can take parameters.
v2.1.0
  • The width parameter was changed to dimensions. See parameter documentation above.
  • New container parameter to use a standard MediaWiki thumb frame or default to a generic container.
  • The description parameter no longer forces the thumb frame to be used.
  • Added support for Archive.org, Blip.tv, CollegeHumor, Gfycat, Nico Nico Video, TED Talks, and Vine.
  • Ability to center align embeds.
  • CSS resource module.
v2.0
  • URLs from the player pages that contain the raw video ID can now be used as the ID parameter.
  • Validation of the raw IDs is improved.
  • Code base rewritten to have a VideoService class for future extensibility.
  • Switched to HTML5 iframes wherever possible for embeds.
  • All services overhauled to be up to date and working.
  • The 'auto' and 'center' alignment values were removed as they were not working. They are planned to be implement properly in the future.

Developer Notes[edit]

The major benefit of using a parser function as the injection mechanism for video clips (as opposed to an extension tag) is that parser functions can utilize template parameters (of the form {{{1}}}).

For example, say you found yourself making a lot of YouTube videos in thumbnail size, right-aligned like an image. You might make a template called Template:Youtube_tn which could contain this:

<div class="thumb tright">
{{#ev:youtube|{{{1}}}|{{{2|100}}}}}
</div>

And then call it like this:

{{youtube tn|someYoutubeId}}

Reporting Bugs[edit]

There is an issue tracker set up on the Github project page.

Contributing[edit]

Bug reports, feature requests, and patches are always welcome. New contributors can be added to the Github project if there is sufficient interest.

Weblinks[edit]