JW Player Macro

Last modified by Thomas Mortagne on 2024/07/08 00:06

filmPlay media files using JW Player
Recommended
TypeXAR
CategoryMacro
Developed by

Marius Dumitru Florea, Josef Haimerl

Active Installs80
Rating
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

Description

The JW Player is an open-source embeddable media player for web sites, supporting many commonly-used audio and video formats. The player is easy to configure, customize and extend.

Usage

{{jwplayer attachment="video.mp4" /}}
{{jwplayer attachment="Space.Page@video.mp4" width="600" height="400" /}}

{{jwplayer attachment="http://www.youtube.com/watch?v=1o9efYEmXKA" /}}

{{jwplayer attachment="/path/to/video.mp4" /}}
{{jwplayer attachment="$xwiki.getSkinFile('videos/sample.mp4')" /}}

Parameters definition

NameDescription
attachment (v1.0)The reference to the attached media file that should be played. The reference is resolved relative to the current document. E.g.: Space.Page@video.mp4 or Page@video.mp4 or even simply video.mp4
attachment (v2.0)Starting with version 2.0 you can also play external videos such as those found on YouTube or a file stored on the server. We didn't change the name of the parameter in order to preserve backwards compatibility with v1.0
autostart (v2.1)Automatically start playing the video on page load. Can be true or false (default). Autostart does not work on mobile devices like iOS and Android.
heightThe player height, in pixels. If not defined, the player tries to determine automatically the height from the played media file.
repeatWhether to loop playback of the playlist or not. Can be true (keep playing forever) or false (stop playback when completed). Defaults to false.
widthThe player width, in pixels. If not defined, the player tries to determine automatically the width from the played media file.

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Release Notes

v2.2.1

The following translations have been updated with this release:

v2.2.0

  • Remove dates (date, creationDate and contentUpdateDate) embedded in XWiki documents.
  • Add missing MIME types in XWiki documents.
  • Remove deprecated calls to Velocity  MathTool.toInteger(Object num) and replaced them by NumberTool.toNumber(Object).intValue().
  • Use version 15.2 of xwiki-commons-tool-extension-plugin to allow successful build with Maven 3.9+.
  • Requires Java 11 to run the build to be able to execute xwiki-commons-tool-extension-plugin version 15.2.
  • Bump parent version from 9.5 to 9.8.1 to benefit from https://jira.xwiki.org/browse/XCOMMONS-1230 fix.

v2.1.10

The following translations have been updated with this release:

v2.1.9

The following translations have been updated with this release:

v2.1.8

v2.1.7

v2.1.6

v2.1.5

v2.1.4

The following translations have been updated with this release:

v2.1.3

  • Upgraded to JW Player v7.9.3

v2.1.2

v2.1.1

v2.1

  • Added two new parameters: autostart and repeat.

v2.0

  • Upgrade to JW Player 6.5.3609
  • Add support for playing YouTube URLs and files located on the server
  • Load JW Player using require.js and jQuery
  • Update documentation on macro page.

Dependencies

Dependencies for this extension (org.xwiki.contrib:macro-jwplayer-ui 2.2.1):

Get Connected