wikifab / embed-video
Installs: 2 848
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 3
Forks: 54
Type:mediawiki-extension
This package is auto-updated.
Last update: 2024-04-20 22:14:12 UTC
README
#About
The EmbedVideo Extension is a MediaWiki extension which adds a parser function called #ev for embedding video clips from over 22 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.
For more information about EmbedVideo, to download, to contribute, and to report bugs and problems, visit the GitHub project page:
https://github.com/HydraWiki/mediawiki-embedvideo
Issues, bug reports, and feature requests may be created at the issue tracker:
https://github.com/HydraWiki/mediawiki-embedvideo/issues
The MediaWiki extension page is located at:
https://www.mediawiki.org/wiki/Extension:EmbedVideo
##History
The original version of EmbedVideo was created by Jim R. Wilson. That version was later forked by Mohammed Derakhshani as the EmbedVideoPlus extension. In early 2010 Andrew Whitworth took over active maintenance of both extensions and merged them together as "EmbedVideo". Much later on in September 2014 Alexia E. Smith forcefully took over being unable to contact a current maintainer.
The newer versions of EmbedVideo are intended to be fully backwards-compatible with both older EmbedVideo and EmbedVideoPlus extensions.
#License
EmbedVideo is released under the MIT license
http://www.opensource.org/licenses/mit-license.php
See LICENSE for more details
#Installation
##Download
There are three places to download the EmbedVideo extension. The first is directly from its GitHub project page, where active development takes place. If you have git, you can use this incantation to check out a read-only copy of the extension source:
git clone https://github.com/HydraWiki/mediawiki-embedvideo.git
Downloadable archive packages for numbered releases will also be available from the github project page.
##Installation Instructions
- Download the contents of the extension, as outlined above.
- Create an EmbedVideo folder in the extensions/ folder of your MediaWiki installation.
- Copy the contents of this distribution into that folder
For Mediawiki 1.19 through 1.23 add the following line to your LocalSettings.php:
require_once("$IP/extensions/EmbedVideo/EmbedVideo.php");
For Mediawiki 1.24 and up add the following line to your LocalSettings.php:
wfLoadExtension("EmbedVideo");
#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}}
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> - Tag Hook
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
| Attribute | Required | Default | Description |
|---|---|---|---|
service="(See Supported Services below.)" |
yes | The video service to call. | |
| `id="[id | url]"` | yes | |
| `dimensions="[WIDTH | WIDTHxHEIGHT | xHEIGHT]"` | no |
| `alignment="[left | center | right | inline]"` |
description="[wiki text]" |
no | none | Display a description under the embed container. |
container="[frame]" |
no | 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" |
no | 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" |
no | true | Automatically resize videos when their size will cause them to break outside of their container element |
Examples
Example #1
For example, a video from YouTube use the 'youtube' service selector enter either the raw ID:
{{#ev:youtube|pSsYTj9kCHE}}
Or 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}}
Support for VideoLink Tags
Support for the unmaintained VideoLink extension's tags has been added since version 2.5.
From the original extension documentation:
The VideoLink extension allows embedding of YouTube videos in articles; allowing for multiple linked videos to be played in a single embedded video player, first shown when a user clicks on a video link.
The <vplayer /> specifies where the player should appear within the page, and the {{#vlink}} parser function allows creation of links that load a specific video.
<evlplayer> - Tag Hook for Video Container
Note that the use of the <vplayer> tag is also acceptable here for backwards compatibility.
This evlplayer tag is used to position the video player container within the page.
<vplayer id="player id" w="width" h="height" class="class" style="style">default content</vplayer>
| Attributes | Required | Default | Description |
|---|---|---|---|
| id | no | default | An optional unique identifier for this container |
| w | no | 800 | Width to send to the embedded player when its generated |
| h | no | achieve 16:9 from width | Height to send to the embedded player when its generated |
| class | no | Additional CSS class to add to the container div | |
| style | no | Additional in-line CSS to apply to the container div |
An important caveat to make note of, is that the w and h attributes only effect the video that is being included into the container div, and not the actual container. For styling of the container, please use the class or style attributes.
#evl - Parser Function for Video Links
Note that the use of the {{#vlink}} parser function is also acceptable here for backwards compatibility.
{{#evl:<video id>|<Link text>|service=youtube|player=<player id>}}
In addition to all of the attributes supported by the #evt tag, these specific attributes apply to the #evl (and #vlink) tags. To maintain backwards compatibility, if you do not define a service then youtube is assumed.
| Attributes | Required | Default | Description |
|---|---|---|---|
| video id | yes | none | The ID of the video you would like to play. Please note that the use of multiple video IDs separated by a semicolon is now deprecated. Please use the proper service for playlists if you would like play multiple videos from a single link |
| link text | yes | none | The text to display inside the link |
| player | no | 'default' | Player container to load video in. Note that the ID 'default' will only exist if you've defined a player with no ID. |
| initial video | deprecated | In the original VideoLink, this would define what video to play first if multiple videos were define. Please see notes about in video id and start. |
|
| start | deprecated | 0:00 | In the original VideoLink, this defined the start time of a video. Since we support multiple video services, this feature can now be replicated with the urlargs parameter. For backwards compatibility, this attribute will be respect on videos with the service youtube. |
Supported Services
As of version 2.x, EmbedVideo supports embedding video content from the following services:
#Configuration Settings
| 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. |
#Credits
The original version of EmbedVideo was written by Jim R. Wilson. Additional major upgrades made by Andrew Whitworth, Alexia E. Smith, and other contributors.
See CREDITS for details