Extension:AudioPlayer2
AudioPlayer2 Release status: stable |
|
---|---|
Implementation | Tag |
Description | Provides embedded audio playback using WordPress Audio Player Standalone. |
Author(s) | Ulrich Christensen (UChristensentalk) |
Latest version | 1.1 (2012-07-05) |
MediaWiki | 1.19+ |
License | GNU General Public License 2.0 or later |
Download | https://github.com/ubcudvikler/AudioPlayer2 |
Example | http://www.horsensleksikon.dk/ |
$wgAudioPlayerPluginPath, $wgAudioPlayer2Settings |
|
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.
InstallationEdit
- Make sure that the required software is installed before you continue!
- Download and place the file(s) in a directory called
AudioPlayer2
in yourextensions/
folder.
- Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'AudioPlayer2' );
- Configure as required. (see also the examples provided)
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
To users running MediaWiki 1.24 or earlier:
The instructions above describe the new way of installing this extension using wfLoadExtension()
. If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'AudioPlayer2' );
, you need to use:
require_once "$IP/extensions/AudioPlayer2/AudioPlayer2.php";
Configuration parametersEdit
- $wgAudioPlayerPluginPath
- Update 5/16/2018: This step is unclear and the external link is now broken.
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.
Example:
$wgAudioPlayer2Settings['colours']['leftbg'] = '00F80F';
UsageEdit
The <player>
(or whichever you choose) tag can be used to embed MP3 audio content into wiki pages:
<player>test.mp3</player>
Tag attributesEdit
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>