====== mp3play Plugin ======

---- plugin ----
description: Embeds an mp3 flash player into a wiki page
author     : Michael Hamann, Michael Klier
email      : michael@content-space.de
type       : syntax
lastupdate : 2013-04-20
compatible : Angua, Adora Belle, Weatherwax, Binky, Ponder Stibbons
depends    : 
conflicts  : 
similar    : flowplay, flowplay2
tags       : !obsolete, media, music, embed, flash
downloadurl: https://github.com/michitux/dokuwiki-plugin-mp3play/archive/master.zip
bugtracker : https://github.com/michitux/dokuwiki-plugin-mp3play/issues
sourcerepo : https://github.com/michitux/dokuwiki-plugin-mp3play/
----

Flash is not available anymore in browsers. Functionality is included in DokuWiki, see the [[wiki:syntax#media_files|media syntax description]].


===== Description =====

This plugin is a DokuWiki port of the [[http://www.1pixelout.net/code/audio-player-wordpress-plugin/|Wordpress Audio Player Plugin]]. It allows you to play mp3 files((and mp3 files only!)) on your wiki page.

If you don't use "loop" and "autostart" - //**this plugin don't need for modern HTML5 compartible browsers**// because of DokuWiki native support for HTML5 tag <audio>. All you need is only delete "!" sign in "mp3     !audio/mpeg" string in ''conf/mime.conf''. "Loop" and "autostart" features already requested

===== Installation =====

Download the archive and unpack it into ''<dokuwiki>/lib/plugins''.

  * [[https://github.com/michitux/dokuwiki-plugin-mp3play/archive/master.zip|.zip]] Plugin Manager
  
The plugin is also available via git.

<code>
% cd <dokuwiki>/lib/plugins
% git clone git://github.com/michitux/dokuwiki-plugin-mp3play.git mp3play
</code>

===== Configuration =====
You can change the colors of the flash player by editing the ''<dokuwiki>lib/plugins/mp3play/colors.conf'' provided by the plugin. The file is pretty self explaining.

===== Syntax =====
The syntax is as follows, you can use the plugin multiple times on a single wiki page.

<code>
{{mp3play>namespace:audiofile.mp3}}
</code>

The plugin has two options ''loop'' and ''autostart''. If ''loop'' is set the playback will start again at the beginning when the player reached the end. When ''autostart'' is set, the player will immediately start playing the mp3 when you visit the wiki page. The syntax is as follows:

<code>
{{mp3play>namespace:audiofile.mp3?autostart}}

{{mp3play>namespace:audiofile.mp3?loop}}

{{mp3play>namespace:audiofile.mp3?autostart&loop}}

{{mp3play>namespace:audiofile.mp3?loop&autostart}}
</code>

===== Demo =====

An example can be found [[http://www.lichterkette2009.at/buch/doku.php?id=medien#markus_meisters_song_stell_dir_vor_-_juni_2010|here]].

===== Changelog =====

  * **2013-04-20**: use jQuery instead of the deprecated old JavaScript library, this makes the plugin compatible with Weatherwax. Note that the plugin is still rather outdated and using a solution which doesn't require flash would be better.

A complete changelog is available [[https://github.com/michitux/dokuwiki-plugin-mp3play/commits/|here]].

{{rss>https://github.com/michitux/dokuwiki-plugin-mp3play/commits/master.atom 10 1d date}}

===== Bugs / Feature Requests =====
Please report bugs and feature requests at the [[https://github.com/michitux/dokuwiki-plugin-mp3play/issues|bug tracker]].

===== Discussion =====

  * Hello, the DEMO page link seems to have gone sadly awol --- //jw/2010-05-27// 
  * I use the mp3 plugin on the following site - feel free to watch it in action :)
  * [[http://www.lichterkette2009.at/buch/doku.php?id=medien| Demo link]]
 
==== file not found ====
  * I think I'm doing something wrong. I insert<code>{{mp3play>:Giga.mp3}}</code>but when I try to play it shows a "file not found". Where the mp3 file should be?

    * Dokuwiki use lowcase names only!

==== Not supported anymore ====

As of January 1st 2021 this plugin is no longer supported by adobe. 
Here is the error I am receiving.
//Since Adobe no longer supports Flash Player after December 31, 2020 and blocked Flash content from running in Flash Player beginning January 12, 2021, Adobe strongly recommends all users immediately uninstall Flash Player to help protect their systems.//

Is there something to replace this plugin?

Thanks.
==== Where to put files ====


I've tried many directories but all say file not found.
==== Is Chinese NS supported？ ====
* I insert<code>{{mp3play>:我的花园:中文名.mp3}}</code>but when I try to play it shows a "file not found". 
* I insert<code>{{mp3play>:my_garden:a_song.mp3}}</code>It plays OK.

**Chinese NS and Chinese filename are not supported？**

Seems that any unicode characters in filenames are not supported?..
When I insert <code>{{mp3play>mp3:эдуард_хиль_-_журавлёнок.mp3}}</code> I get "file not found" error too.

I get file not found also, tried different namespace, in lower case and .mp3 files to no avail. 
Bat
05/04/2013 12:30:31

**<Solution>**Replace the line in syntax.php

<code>
$renderer->doc .= '    <param name="FlashVars" value="' . $params . 'soundFile=' 
. DOKU_URL . 'lib/exe/fetch.php?media=' . $data['mp3'] . '" />' . DOKU_LF;
</code>
with
<code>
$renderer->doc .= '    <param name="FlashVars" value="' . $params . 'soundFile=' 
. DOKU_URL . 'lib/exe/fetch.php?media=' . urlencode(urlencode ($data['mp3']))
. '" />' . DOKU_LF;
</code>
With this double encode trick, you will be able to play files with UTF8 file name and/or namespace.

11/3/2014 
====Where to put the mp3 files (Solution)====
It is not indicated anywhere above, but the mp3 files must me located in the /data/media/ directory. Otherwise you will get the 'File not found' error. And when you invoke it should be this way:
 <code>{{mp3play>xxxxx.mp3}}</code>
**__do not specify__** the media as in 
<code>{{mp3play>media:xxxxx.mp3}}</code>
Bat 07/04/2013 


==== Issues with iPad/iPhone Users ====
I have a couple of people report they don't see the play & speaker symbols when they access the site from iPad/iPhone. No error message, just nothing to "click to play" - java issues?
 --- [[user>charles.minto|charles.minto]] //2014/03/23 20:11//

Update your DokuWiki installation, it can now play single audio files (MP3, OGG & WAV) on mobile devices by default. --- [[user>Laynee|Laynee]] //2016-02-14 21:19//