Manual:Extension/EmbedVideo: Difference between revisions

Revision as of 14:32, 20 December 2021

BlueSpice integrates the MediaWiki extension EmbedVideo to embed video files from external video services such as YouTube or Vimeo. EmbedVideo supports more than 20 video services. In addition, you can also embed videos that have been uploaded to the wiki itself.

Embedding external videos

Embedded external YouTube videos

Template:Box Note

Syntax

Use the following parser tag to embed an external video in source editing mode:

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

You can add additional optional parameter (see list of attributes):

{{#evt:
 service=youtube
 |id=https://www.youtube.com/watch?v=MLIE2642neg
 |dimensions=300
 |alignment=inline
 |description=ISS - Life on the space station <br/> 1:04:27
 |container=frame
 |urlargs=
 |autoresize=
 |valignment=
}}

A shortened syntax is available with the #ev tag:

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

Placeholders for unused arguments between two arguments have to remain empty and cannot be removed::

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

The shortest option to embed a video is by specifying the service name and the video ID:

{{#ev:youtube|MLIE2642neg}}

Example with video description (- you can include a line break with the <br /> tag):

{{#ev:youtube|MLIE2642neg|||ISS - Life on the space station <br/> 1:04:27}}

Attributes for parser tag #evt

attribute	required	default	description
`service="(see supported services below)"`	yes		The video service that is called when the player is created.
`id="[id\|url]"`	yes		The video ID or full URL of the external video.
`dimensions="[width\|widthxheight\|xwidth]"`	no	640	Dimensions in pixelsto size the container for the player. The default format is width x height. It is possible to omit one of the dimensions. The `x` always has to be included before the height. Examples: `480`, `480x320`, `x320`. If the height is not specified, it is calculated using the width and the default ratio of the video service. Some video services such as Gfycat don't have a standard height. Therefore, the height setting should be included for each video. With `$wgEmbedVideoDefaultWidth` the default width can be overwritten in the file `LocalSettings.php` on the server.
`alignment="[left\|center\|right\|inline]"`	no	none	The video can be placed left, center, right, or inline. Inline allows to add multiple videos in one row. In mobile view, the videos are automatically aligned vertically.
`description="[wiki text]"`	no	none	Shows a description below the player container.
`container="[frame]"`	no	none	Determines the container type for the player. `frame`: Places the video player in a Mediawiki preview box.
`urlargs="modestbranding=1&version=3"`	no	none	Allows adding additional URL-arguments to the embedded url. This is useful for settings that are only offered by an individual video service.
`autoresize="false"`	no	true	Automatically adjusts the video size if the video would extend beyond the size of the container.
`valignment="[top\|middle\|bottom\|baseline]"`	no	none	Aligns 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.

Video container for multiple videos

The <evlplayer> tag

Using the tag <evlplayer> and the parser function #evl, you can play multiple videos with one video player.

Play multiple videos in one player

<evlplayer id="Player ID" w="width" h="height" class="class" style="style">defult content</evlplayer>

A default video can be loaded using defaultid:

<evlplayer id="player1" w="480" h="360" service="youtube" defaultid="mCtmECVnrOM" />

Attributes for tag <evlplayer>

attribute	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	16:9 ratio is achieved by the width setting	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.
style	no		Additional inline CSS to apply to the container div.
defaultid	no		Video ID of default video, if you want a default video.
service	no		Service of default video, if you want a default video.

Adding video links

Use the parser tag {{#evl}} to define the videos that should be passed to the player:

{{#evl:<video id>|<Link text>>|<video to play>|service=youtube|player=<player id>}}

Example:

{{#evl:mCtmECVnrOM|Departure to Mars|player=example-player}}

In addition to the attributes for the tag #evt , there are some additional attributes available for the #evl tag.

Attributes for parser tag #evl

attribtute	required	default	description
video id	yes	none	The ID of the video you would like to play.
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.

Example

<evlplayer w="600" id="example-player">
default content
</evlplayer>
{{#evl:OLeWbRdW6rY|Let eet Go|1|player=example-player}}
{{#evl:mCtmECVnrOM|Departure to Mars|2|player=example-player}}
{{#evl:MLIE2642neg|ISS - Life in the space station|3|player=example-player}}

Embedding local videos

Videos that have been uploaded to the Wiki can also be embedded in source editing mode. This can also be done using the extension BlueSpicePlayer. BlueSpicePlayer has no functions to embed external videos, however.

The two extensions have the following differences when embedding local video files:


Syntax/Parameter	EmbedVideo	BlueSpicePlayer
Syntax	corresponds to the syntax of embedding image files: `[[File:samplename.mp4]]`	`<bs:showtime>samplename.mp4</bs:showtime>`
Size	Only the width can be defined. The video fills the entire width of the player container: `[[File:Manual:300px-video-size-showtime-600.PNG]]`	Width and height can be defined separately. If the width of the video is smaller than the video container, the canvas is filled in black. `<bs:showtime width="600">`.. BlueSpicePlayer with 600px width .
Loop	-	`<bs:showtime repeat="yes"</code>`
Autostart	-	`<bs:showtime autostart="yes"</code>`
Star/End	`[[File:samplename.mp4\|start=2\|end=6]]` Time can be added as: ss, mm:ss, hh:mm:ss	-
HTML-Output	embedded as <video> tag	embedded through nested <div> tags
Adjusts to mobile display	yes	no
Player controls
play button	yes	yes
progress bar	yes	yes
volume adjustment	yes	yes
fullscreen mode	yes	yes
picture-in-picture	yes	yes
download	yes	no
speed adjustment	no	yes

Supported video services

The following video services are supported by the extension EmbedVideo. In parentheses, you find the service names that are used with the tags #evt and #ev:

Archive.org Videos (archiveorg), Bambuser (bambuser), Bing (bing), Blip.tv (blip), C3TV (mediaccde), CollegeHumor (collegehumor), Dailymotion (dailymotion), Disclose.tv (disclose), Daum TVPot (tvpot), Div Share (divshare), Facebook (facebook), FunnyOrDie (funnyordie), Gfycat (gfycat), Hitbox (hitbox), JW Player (jwplayer), Kickstarter (kickstarter), Metacafe (metacafe), Microsoft Stream (microsoftstream), Mixer (mixer), Nico Nico Video (nico), RuTube (rutube), SoundCloud (soundcloud), Spotify Album (spotifyalbum), Spotify Artist (spotifyartist), Spotify Song (spotifytrack), TeacherTube (teachertube), TED Talks (ted), Tubi TV (tubitv), Tudou (tudou), Twitch (twitch), Videomaten (videomaten), Vimeo (vimeo), Vine (vine), Yahoo Screen (yahoo), YouTube (youtube), YouTube Playlist (youtubeplaylist), YouTube Video List (youtubevideolist), Youku (youku)

Related info

Technical Reference: EmbedVideo

To submit feedback about this documentation, visit our community forum.

@@ Line 8: / Line 8: @@
 Use the following parser tag to embed an external video in source editing mode:
-<syntaxhighlight>
+<syntaxhighlight lang="text">
 {{#evt:
   service=youtube
@@ Line 14: / Line 14: @@
 }}
 </syntaxhighlight>
-You can add additional optional parameter (see [[#Attributes for parser tag #evt|list of attributes]]):<syntaxhighlight>
+You can add additional optional parameter (see [[#Attributes for parser tag #evt|list of attributes]]):<syntaxhighlight lang="text">
 {{#evt:
   service=youtube
@@ Line 28: / Line 28: @@
 </syntaxhighlight>
 A shortened syntax is available with the <code>#ev</code> tag:
-<syntaxhighlight>
+<syntaxhighlight lang="text">
 {{#ev:service|id|dimensions|alignment|description|container|urlargs|autoresize|valignment}}
 </syntaxhighlight>Placeholders for unused arguments between two arguments have to remain empty and cannot be removed::
-<syntaxhighlight>
+<syntaxhighlight lang="text">
 {{#ev:service|id|||description}}
 </syntaxhighlight>The shortest option to embed a video is by specifying the service name and the video ID:
-<syntaxhighlight>
+<syntaxhighlight lang="text">
 {{#ev:youtube|MLIE2642neg}}
 </syntaxhighlight>Example with video description (- you can include a line break with the <code><nowiki><br /></nowiki></code> tag):
-<syntaxhighlight>
+<syntaxhighlight lang="text">
 {{#ev:youtube|MLIE2642neg|||ISS - Life on the space station <br/> 1:04:27}}
 </syntaxhighlight>
@@ Line 103: / Line 103: @@
 Using the tag <code><nowiki><evlplayer></nowiki></code> and the parser function <code>#evl</code>, you can play multiple videos with one video player.
 [[File:Manual:350px-video-extern-videocontainer-hook.PNG|link=link=Special:FilePath/Manual:video-extern-videocontainer-hook.PNG|alt=|center|thumb|346x346px|Play multiple videos in one player]]
-<syntaxhighlight>
+<syntaxhighlight lang="text">
 <evlplayer id="Player ID" w="width" h="height" class="class" style="style">defult content</evlplayer>
 </syntaxhighlight>A default video can be loaded using <code>defaultid</code>:
-<syntaxhighlight><evlplayer id="player1" w="480" h="360" service="youtube" defaultid="mCtmECVnrOM" /></syntaxhighlight>
+<syntaxhighlight lang="text"><evlplayer id="player1" w="480" h="360" service="youtube" defaultid="mCtmECVnrOM" /></syntaxhighlight>
 ====Attributes for tag <nowiki><evlplayer> </nowiki>====
@@ Line 152: / Line 152: @@
 ===Adding video links===
-Use the parser tag <nowiki>{{#evl}}</nowiki> to define the videos that should be passed to the player:<syntaxhighlight>
+Use the parser tag <nowiki>{{#evl}}</nowiki> to define the videos that should be passed to the player:<syntaxhighlight lang="text">
 {{#evl:<video id>|<Link text>>|<video to play>|service=youtube|player=<player id>}}
-</syntaxhighlight>Example:<syntaxhighlight>
+</syntaxhighlight>Example:<syntaxhighlight lang="text">
 {{#evl:mCtmECVnrOM|Departure to Mars|player=example-player}}
 </syntaxhighlight>In addition to the attributes for the tag  <code>#evt</code> , there are some additional attributes available for the  <code>#evl</code> tag.<br />
@@ Line 182: / Line 182: @@
 ===Example===
-<syntaxhighlight>
+<syntaxhighlight lang="text">
 <evlplayer w="600" id="example-player">
 default content