Jump to content

Extension:EmbedVideo (fork)

From mediawiki.org
Starting with EmbedVideo version 3.4.0, all parser functions and tags have been implemented that were present in EmbedVideo v2.X. Consult the GitHub readme for more information.
MediaWiki extensions manual
EmbedVideo (fork)
Release status: stable
Implementation Parser function
Description Adds a parser function for embedding videos from popular sources
Author(s) Octfx, Alistair3149, Alexia E. Smith, Andrew Whitworth, Jim R. Wilson
Maintainer(s) Octfx
Latest version 3.4.1 (Continuous updates)
Compatibility policy Master maintains backward compatibility.
MediaWiki 1.39+
PHP >=8.0
Composer starcitizenwiki/embedvideo
License MIT License
Download
Translate the EmbedVideo (fork) extension

The EmbedVideo extension is a MediaWiki extension which adds a parser function called #ev and various parser tags like ‎<youtube> for embedding video clips from various video sharing services.

It also adds video and audio media handlers to support transforming standard [[File:Example.mp4]] file links into embedded HTML5 ‎<video> and ‎<audio> tags.

This privacy enhanced fork adds a toggleable setting that only loads external content after the user gave explicit consent by clicking the video.

Do note that thumbnails are still fetched from the respective service, which results in a connection to an external url. This behaviour can be disabled by setting $wgEmbedVideoFetchExternalThumbnails to false.

Installation[edit]

If you want to use this extension for embedding locally uploaded files you will also need to install the "ffmpeg" software on your server.
  • 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 file:
    wfLoadExtension( 'EmbedVideo' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

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]]

Additionally, a cover image can be set for video files by specifying a cover= key.

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

Available options[edit]

The following options are available when using the media handler for local files.

Options are added to the wikitext like |poster=File:... or |start=2.

  • loop
    • Loops the audio / video
  • autoplay
    • Automatically plays the file
  • nocontrols
    • Disables the control elements

Options only available for video files:

  • poster / cover
    • Sets a local image file as the cover of the video
  • muted
    • Mutes the audio track of the video (required for autoplay)
  • gif
    • Special option that sets autoplay, muted, loop and nocontrols e.g. makes the video behave like a gif

When $wgEmbedVideoUseEmbedStyleForLocalVideos is enabled two additional options are available

  • title
    • Title of the video
  • description
    • Description shown below the video

Parser function #ev[edit]

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

  • {{#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}}

Alternatively each parameter can be used in any order as a named parameter. The following parameter are available:

  • id
  • dimensions
  • alignment
  • description
  • container
  • urlArgs
  • autoResize
  • vAlignment
  • width
  • height
  • poster / cover
    • This only has an effect if $wgEmbedVideoRequireConsent is set to true
  • title
    • This only has an effect if $wgEmbedVideoRequireConsent is set to true

Do note mixing named and unnamed parameters will require you to add all unnamed parameters (and blanks) in the previously mentioned order.

E.g. using named id and unnamed description {{#ev:service||||This is the Description|id=abc}}/ {{#ev:service|id=abc|||This is the Description}}

Supported Services[edit]

As of version 3.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-6https://archive.org/embed/electricsheep-flock-244-80000-6
Bilibili bilibili BV1Hz4y1k7ae https://player.bilibili.com/player.html?bvid=1Hz4y1k7ae&page=1
KakaoTV kakaotv 301157950 https://play-tv.kakao.com/embed/player/cliplink/301157950
NaverTV navertv 27831593 https://tv.naver.com/embed/27831593
Niconico niconico sm40807360 https://embed.nicovideo.jp/watch/sm40807360
SoundCloud soundcloud https://soundcloud.com/skrillex/skrillex-rick-ross-purple-lamborghini
Spotify spotifyalbum - Art embed 3B61kSKTxlY36cYgzvf3cP https://open.spotify.com/album/3B61kSKTxlY36cYgzvf3cP
Spotify spotifyartist - Artist embed 0YC192cP3KPCRWx8zr8MfZ https://open.spotify.com/artist/0YC192cP3KPCRWx8zr8MfZ
Spotify spotifytrack - Song embed 6ZFbXIJkuI1dVNWvzJzown https://open.spotify.com/track/6ZFbXIJkuI1dVNWvzJzown
Twitch twitch - Live Streams twitchvod - Archived Videos on Demand twitchplayspokemon
Vimeo vimeo 105035718 http://vimeo.com/105035718
YouTube youtube - Single Videos pSsYTj9kCHE https://www.youtube.com/watch?v=pSsYTj9kCHE
YouTube youtubeplaylist - Playlists PLY0KbDiiFYeNgQkjujixr7qD-FS8qecoP https://www.youtube.com/embed/?listType=playlist&list=PLY0KbDiiFYeNgQkjujixr7qD-FS8qecoP
YouTube youtubevideolist - Video List pSsYTj9kCHE - urlargs=playlist=pSsYTj9kCHE,pSsYTj9kCHE https://www.youtube.com/embed/pSsYTj9kCHE?playlist=pSsYTj9kCHE,pSsYTj9kCHE
New Services

New services can be requested by using the following link or clicking New Issue.

Configuration[edit]

Variable Default Value Description
$wgEmbedVideoAddFileExtensions true Boolean - Enable or disable adding video/audio file extensions to the list of allowable files to be uploaded.
$wgEmbedVideoEnableVideoHandler true Boolean - Enable or disable the video media handlers for displaying embedded video in articles.
$wgEmbedVideoEnableAudioHandler true Boolean - Enable or disable the audio media handlers for displaying embedded audio in articles.
$wgEmbedVideoLazyLoadLocalVideos false Boolean - Sets 'preload="none"' on every
$wgEmbedVideoUseEmbedStyleForLocalVideos false Boolean - Styles local videos like they are embedded content. DO NOTE: When changing this, every page with a local video needs to be updated in the parser cache!
$wgEmbedVideoDefaultWidth 640 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.
$wgEmbedVideoMinWidth null Integer - Minimum width of video players. Widths specified below this value will be automatically bounded to it.
$wgEmbedVideoMaxWidth null Integer - Maximum width of video players. Widths specified above this value will be automatically bounded to it.
$wgFFprobeLocation /usr/bin/ffprobe String - Set the location of the ffprobe binary.
$wgEmbedVideoEnabledServices null Array - Array of service names that are allowed, if empty all services are available.
$wgEmbedVideoRequireConsent true Boolean - Set to true to only load the iframe if the user clicks it.
$wgEmbedVideoFetchExternalThumbnails true Boolean - Set to false to disable fetching video thumbnails from the external video provider. Currently only works for YouTube and Vimeo.

See also[edit]