Extension:AudioPlayer2

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
AudioPlayer2

Release status:Extension status stable

ImplementationTemplate:Extension#type Tag
DescriptionTemplate:Extension#description Provides embedded audio playback using WordPress Audio Player Standalone.
Author(s)Template:Extension#username Ulrich Christensen (UChristensentalk)
Latest versionTemplate:Extension#version 1.1 (2012-07-05)
MediaWikiTemplate:Extension#mediawiki 1.19.x and up (at least)
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download https://github.com/ubcudvikler/AudioPlayer2
ExampleTemplate:Extension#example http://www.horsensleksikon.dk/
ParametersTemplate:Extension#parameters

$wgAudioPlayerPluginPath, $wgAudioPlayer2Settings

Hooks usedTemplate:Extension#hook
ParserFirstCallInit
ParserAfterTidy
OutputPageParserOutput

Translate the AudioPlayer2 extension if it is available at translatewiki.net

Check usage and version matrix.

The AudioPlayer2 extension lets you embed MP3 audio files on your wiki via WordPress Audio Player Standalone.

Installation[edit]

  • Download and place the file(s) in a directory called AudioPlayer2 in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/AudioPlayer2/AudioPlayer2.php";
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters[edit]

$wgAudioPlayerPluginPath
Set the path to WordPress Audio Player Standalone files which must be installed separately for this extension to work.
$wgAudioPlayer2Settings['width']
If set, specifies the width of the Flash player when opened. (default width: 380)

Example:

   $wgAudioPlayer2Settings['width'] = 380;
$wgAudioPlayer2Settings['tags']
If set, specifies the list of tags that this extension should handle, otherwise "player" is used. This setting is for interoperability and easy drop-in replacement.

Example:

   $wgAudioPlayer2Settings['tags'] = array('player','audioplayer');
$wgAudioPlayer2Settings['colours']
If set, specifies the colours of the different parts of the player. See here for reference of which elements can be changed.

Example:

   $wgAudioPlayer2Settings['colours']['leftbg'] = '00F80F';

Usage[edit]

The <player> (or whichever you choose) tag can be used to embed MP3 audio content into wiki pages:

   <player>test.mp3</player>

Tag Attributes[edit]

The following attributes can be used in <player> tags:

title
sets/overwrites the title of the file being played. If not specified, ID3 data if available is used.
artist
set/overwrites the artist name for the file being played. If not specified, ID3 data if available is used.
   <player title="Title">test.mp3</player>
   
   <player artist="Artist" title="Title">test.mp3</player>