History: PluginMediaPlayer
Preview of version: 87
Plugin Media Player
Introduced in Tiki3, and extended in Tiki6 with JQuery#Media
Use this wiki plugin to play a media file, like MP3, MP4, SWF, FLV, AVI, WMV, RAM, MOV, MPEG, PDF, ... To play them, this plugin uses an open source media player based on Flash or a native HTML5 player.
Parameters
Besides the parameters described at http://flash-mp3-player.net and http://flv-player.net you can use the following Tiki parameters:
(Found it at tiki-admin.php?page=textarea&cookietab=2&highlight=wikiplugin_mediaplayer.)
Add a media player to a page
Introduced in Tiki 3.
Go to the source code
Preferences required: wikiplugin_mediaplayer
| Parameters | Accepted Values | Description | Default | Since |
|---|---|---|---|---|
height |
Player height in px or % | 10.0 | ||
width |
Player width in px or % | 10.0 | ||
type |
url | File type for source URL, e.g. mp4, pdf or odp. Specify one of the supported file types when
the URL of the file is missing the file extension. This is the case for File Gallery files which
have a URL such as tiki-download_file.php?fileId=4&display or display4 if you have Clean URLs
enabled. |
10.0 | |
mediatype |
(blank) audio video |
Media type for HTML5 | 13.2 | |
mp3 |
Complete URL to the media to include, which has the appropriate extension. | 27.0 | ||
src |
Complete URL to the media to include, which has the appropriate extension. If your URL doesn't have an extension, use the File type parameter below. | 6.0 |
If you are having difficulty setting the width, try setting with just the number, without 'px' or '%'.
Flash MP3 Player Parameters:
| Name | Description |
|---|---|
| mp3 | The URL of the MP3 file to be played |
| autoplay | 1 to auto-play |
| loop | 1 to loop |
| volume | The initial volume, between 0 and 200. |
| skin | The URL of the JPEG file (not progressive) to load |
| showstop | 1 to show the STOP button |
| showinfo | 1 to show the INFO button |
| loadingcolor | The color of loading bar |
| bgcolor1 | The first color of the background gradient |
| bgcolor2 | The second color of the background gradient |
| buttoncolor | The color of the buttons |
| buttonovercolor | Hover color of buttons |
| slidercolor1 | The first color of the bar gradient |
| slidercolor2 | The second color of the bar gradient |
| sliderovercolor | Hover color of the bar |
| textcolor | The text color |
| bgcolor | The background color |
| byteslimit | If it is an MP3 streaming, the stream will restart at the bytes limit, to prevent overload. |
Troubleshooting
- Make sure you have enabled jQuery Media feature if you are not using mp3 or flv file (using the src param)
- If the player still doesn't appear, you probably got one of the plugin parameters wrong.
- If the player appears but won't play, you probably got the wrong URL to the file.
Examples
MP3 Examples
For files in the file gallery:
{mediaplayer mp3="display10"} {mediaplayer mp3="tiki-download_file.php?fileId=389"}
Using actual file path:
{mediaplayer mp3="http://usuaris.tinet.org/mikell/EntrevistaRadio4.mp3"} {mediaplayer mp3="http://usuaris.tinet.org/mikell/EntrevistaRadio4.mp3", style="mini"} {mediaplayer mp3="/test.mp3", loop="1"}
For files uploaded to the file gallery but stored on the server, the actual file path can also be used. Tiki converts file names to hash values for storage on the server - this name can be found in the database.
And if the mp3 player does not show up in your tiki site, try disabling the "GZip output" feature (feature_obzip) in the Control Panels > Performance ( tiki-admin.php?page=performance ).
FLV files
Use the flv and type parameters to show flv files as shown below:
File gallery flv file:
{mediaplayer flv="http://example.com/display10" type="flv"}
Otherwise upload the file to a directory on your server and use the direct file path. If the file has the .flv extension, then the type parameter doesn't need to be set:
{mediaplayer flv="http://flv-player.net/medias/KyodaiNoGilga.flv"}
Example with the src param (jQuery Media)
It has been enhanced in Tiki6 with jQuery#Media, so that more media formats are supported once you use the param "ur
This code:
{mediaplayer src="https://branding.tiki.org/tiki-download_wiki_attachment.php?attId=37&page=Slideshow" width="100%" height="600" type="pdf"}
Would produce this PDF in the player:
Alternatives to display PDFs.
Wiki Plugin PluginWebDocViewer is similar.
- If you run into problems with one, it's nice to have a second option to try.
FLV
This code:
{mediaplayer flv="http://flv-player.net/medias/KyodaiNoGilga.flv"}
Would produce:
WebM (VP8 codec)
This code:
{mediaplayer src="tiki-download_file.php?fileId=465&display=y" type="webm"}
Would produce something like:
The WebM Project is dedicated to developing a high-quality, open video format for the web that's freely available to everyone.
https://www.webmproject.org
File gallery file in a blog post
An example for a successful use of the maxi Mediaplayer in a blog post looks like this (only caveat is to have access rights for the relevant user group by setting tiki_p_download_files to yes - sometimes, a restart of the browser seems to be necessary to make those rights work...)
{mediaplayer mp3="http://example.com/tiki-download_file.php?fileId=1&showstop=1&showinfo=1&showvolume=1" style="maxi"}
PDF file in a file gallery
This also works for a pdf file in a file gallery beginning in version 10:
{mediaplayer src="tiki-download_file.php?fileId=1134&display=y" type="pdf"}
Would produce something like:
And it displays the PDF file with the ID 7. You will need ViewerJS
Starting in Tiki19, you can get PDF.js viewer via Packages
- An alternative is to use PluginWebDocViewer to display PDFs. (May display better on some smart phones and tablets.)
Collection of References on doc.tiki.org
- Print general info about printing
- PDF general overview about PDF creation in Tiki
- mPDF create PDFs from Tiki content (advanced library that works even on shared hosting). Recommended for Tiki18+
- PluginPDF alter default settings of mPDF per wiki page
- PluginPDFPageBreak add a page break for PDFs created with mPDF
- PluginMediaPlayer display PDF file from file gallery
- PDF.js viewer PDF.js from Mozilla
- ViewerJS: a script to view PDFs and ODFs, which bundles WebODF
- PluginArchiveBuilder Generate a zip file, including PDFs from wiki pages
- WeasyPrint A PDF generation option in Python
- wkhtmltopdf create PDFs from Tiki content (needs root installation)
- dompdf once used for PDF print of slideshows
MP4 Using native player
{mediaplayer type="video/mp4" style="native" width="640px" src="https://doc.tiki.org/tiki-download_wiki_attachment.php?attId=81" }
PluginBlipTV
PluginVimeo
PluginWatershed
PluginYouTube
If you prefer the Flash player you can download the player itself (an .swf file) from http://flash-mp3-player.net or http://flv-player.net or http://code.google.com/p/mp3player or http://code.google.com/p/flvplayer/. If you do, you will need to edit the plugin (at lib/wiki-plugins/wikiplugin_mediaplayer.php) and change the default source in the plugin code or add it as a "where" parameter in that instance of the plugin.