====== jukebox Plugin ======

---- plugin ----
description: Plays a namespace full of MP3s or FLV videos in a flashplayer
author     : Andreas Gohr
email      : andi@splitbrain.org
type       : syntax
lastupdate : 2016-02-03
compatible : elenor of tsort, detritus, frusterick manners, Greebo
depends    : 
conflicts  : 
similar    : mp3play, flowplay, flowplay2, flashplayer
tags       : !obsolete, media, music, video, namespace, flash, embed

downloadurl: https://github.com/splitbrain/dokuwiki-plugin-jukebox/zipball/master
sourcerepo : https://github.com/splitbrain/dokuwiki-plugin-jukebox
bugtracker : https://github.com/splitbrain/dokuwiki-plugin-jukebox/issues
donationurl: http://donate.dokuwiki.org/Jukebox
----

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

This plugin uses Lacy Morrow's [[http://blog.lacymorrow.com/projects/xspf-jukebox/|Xspf Jukebox]] flash player to embed a playlist of MP3 or FLV flash movies. It reads track data from ID3 tags and tries to fetch matching cover art from Amazon.

===== Download and Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

==== Changes ====

{{rss>https://github.com/splitbrain/dokuwiki-plugin-jukebox/commits/master.atom date}}

===== Syntax and Usage =====

To embed the jukebox, you need to use the following syntax, where ''namespace'' is a media namespace with MP3 or FLV files.

  {{jukebox>namespace}}

Optionally you can give additional parameter keywords separated by spaces:

  {{jukebox>namespace wii center}}

The following keywords are supported:

^ Keyword  ^ Result ^
| left     | left aligns the player |
| right    | right aligns the player |
| center   | centers the player |
| shuffle  | enables the shuffle mode |
| repeat   | enables the repeat mode |
| autoplay | automatically start playing after loading |
| //skinname// | Use the given skin to style the player (see below) |

==== Skins ====

The player can be skinned through images and a skin.xml file. The skin format is documented [[http://lacymorrow.com/projects/jukebox/skindoc.html|here]].

The following skins are currently available:

{{gallery>:plugin:jukebox?4&lightbox&crop&75x75}}

  * cassette
  * ipodblack
  * ipodwhite
  * itunes
  * minitunes
  * minitunesreduced
  * orangeeye
  * orangeeyeslim
  * original
  * slim
  * slimoriginal
  * squareone
  * verticalminitunes
  * video
  * walkmerican
  * wii
  * winamp
  * winampsmall

When no skin is given ''original'' is used.

===== Bugs/Caveats/Todos =====

  * Video seems to be of bad quality when used with the video skin
  * TimeBar doesn't work in video skin
  * playlist is currently not cached this might create a high load for large playlists (because of ID3 scanning)
  * Support for local track images should be added
  * Clean up filename when no ID3 tag data is available

Patches and skins welcome.