Help:Embed Videos
The EmbedVideo extension 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
{{ ExtensionInstall
/en }}
Usage
Media Handler
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
The EmbedVideo parser function expects to be called in any of the following ways:
#ev
- Classic Parser Tag
{{#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}}
{{#ev:service|id|dimensions|alignment|description|container|urlargs|autoresize|valignment}}
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
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 }}
#evu
- Parser Tag for URLs
The #evu parser tag is like the #evt tag, but its first parameter is a URL that will be parsed to determine the service automatically.
{{#evu:https://www.youtube.com/watch?v=pSsYTj9kCHE |alignment=right }}
====
EmbedVideo is missing a required parameter.
</nowiki> 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>
Alternativly, you can also use the service id as the tag (assuming another extension isn't already using this tag).
<youtube>https://www.youtube.com/watch?v=pSsYTj9kCHE</youtube>
Attributes for Parser Tags
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.
valignment="[top|middle|bottom|baseline]"
Required: no, Default: none
- Align the vertical placement of the video either to the top, middle, bottom, or baseline of the parent element. Using this parameter forces the alignment parameter to be inline.