Gerald Speaks

File name:audio-player.zip
Version: 1.2.3
Last updated:4 September 2006
Requirements: Wordpress 1.5 - 2.3

If you wish to make a donation to the author of the Audio Player plugin (that’s me), use the Paypal button.

Audio Player 2.0 beta is now available!
Table of contents

* Top
* Usage
* Examples
* Podcasting
* RSS feeds
* The “chipmunk” effect
* Colour scheme
* Runtime options
* Installation
* Upgrading
* Upgrade wizard
* Change log
* Download
* Comments

If you want to use this player on a non-WordPress site, Mindy McAdams has written a very detailed tutorial http://www.1pixelout.net/code/audio-player-wordpress-plugin./

Important note: This plugin only works in posts and pages. It does NOT work in headers, sidebars or footers and I do not provide support for placing it there.

Other important note: This plugin only plays MP3 files. This is a limitation of the Adobe Flash Player.
Contents Usage

Once installed, this plugin allows you to insert mp3 audio files into your posts and pages. Use the following syntax:

[audio:name_of_mp3_file.mp3]

This code will insert a flash player and will load the file named name_of_mp3_file.mp3 located in your audio files folder. You can store your audio files anywhere in the web root as long as you update the path in the plugin’s options panel. The default is /audio.

You can also use absolute paths to link to files on other servers:

[audio:http://www.somedomain.com/path/to/name_of_mp3_file.mp3]

Audio Player can also play a sequence of audio clips. Use commas to separate the files:

[audio:name_of_mp3_file1.mp3,name_of_mp3_file2.mp3,name_of_mp3_file3.mp3#093;

You can also pre-append and post-append a clip to all your players. Explained in the Podcasting section.
Contents Examples
Default colour scheme

Custom colour scheme

Contents Podcasting

If you are using the player for a podcasting blog, Audio Player has special options just for you.
Enclosures

If you are unsure what an enclosure is, read the definition on Wikipedia. You have 3 options:

* If you set your enclosures manually, Audio Player can insert a player automatically at the end of your posts. Select the Enclosure integration option in the Audio Player options panel.
* If you let WordPress set enclosures automatically (by reading mp3 links in your posts), you can still use the Enclosure integration option.
* You can also use the [audio] syntax but you must use absolute URLs:

e.g. http://www.somedomain.com/path/to/name_of_mp3_file.mp3

WordPress will automatically detect the file and set the relevant enclosure option for you.

Pre/Post appended clips

You may wish to pre-append or post-append audio clips into your players. To do this, enter the full urls in the relevant section of the options panel. The pre-appended audio will be played before the main audio, and the post-appended will come after. A typical podcasting use-case for this feature is adding a sponsorship message or simple instructions that help casual listeners become subscribers. This will apply to all audio players on your site. Your chosen audio clips should be substantially shorter than your main feature.
Contents RSS Feeds

You have a choice over what to show in your RSS feed:

* A download link: Choose this if you are OK with subscribers downloading the file.
* Nothing: Choose this if you feel that your feed shouldn’t contain any reference to the audio file.
* Custom: Choose this to use your own alternative content for all player instances. You can use this option to tell subscribers that they can listen to the audio file if they read the post on your blog. You can set the content in the options panel.

Go to the options panel to set these options.
Contents The “chipmunk” effect

The Macromedia Flash player has a problem playing files that are encoded at a rate that is not a multiple of 11.025 kHz. This effect is sometimes called the “chipmunk� effect: the file is played at double speed. To avoid this, encode MP3s at 11.025 kHz 22.050 kHz or 44.100 kHz.
Contents Colour scheme

The entire player colour scheme is customisable. Use the Audio Player options panel in your WP admin to set the colour scheme of your player. You can also change the colours per player instance by using runtime options. Here are the colours that you can set:

Player colour options
Contents Runtime options

Use these if you want to use a different colour scheme for a particular player instance. You can also make the player open automatically or loop the loaded clip. You can pass a number of options to a player instance. To do this use the following syntax:

[audio:name_of_mp3_file.mp3|option1=value|option2=value]

Option Effect
autostart=yes The player will automatically open and start to play the track (default value is no)
loop=yes The track will be looped indefinitely (default value is no)
bg=0xHHHHHH Background colour option (where HHHHHH is a valid hexadecimal colour value such as FFFFFF or 009933)
leftbg=0xHHHHHH Left background colour
rightbg=0xHHHHHH Right background colour
rightbghover=0xHHHHHH Right background colour (hover)
lefticon=0xHHHHHH Left icon colour
righticon=0xHHHHHH Right icon colour
righticonhover=0xHHHHHH Right icon colour (hover)
text=0xHHHHHH Text colour
slider=0xHHHHHH Slider colour
loader=0xHHHHHH Loader bar colour
track=0xHHHHHH Progress track colour
border=0xHHHHHH Progress track border colour
Example:

[audio:name_of_mp3_file.mp3|autostart=yes|bgcolor=0x000000]

This will set the main background colour of the player to black and automatically start the player when the page loads.
Contents Installation

1. Extract and upload the files to your plugins folder
You should end up with this folder structure:
Folder structure
2. Create a folder in your blog root (where your wordpress install lives) where you will store all your mp3 files
I recommend an audio folder in the root of your blog so it doesn’t interfere with your WP install. If you wish to use another folder, remember to change the audio files directory option on your options panel.
3. Activate the plugin in your WP admin
4. Go to Options > Audio Player in the WP admin
Here, you can choose how you want to use Audio Player and also set the colours to match your site’s design.

Contents Upgrading from 0.x to 1.x

Once installed, the old player is overwritten with the new one and all colour options should be transfered to the new scheme. Some adjusting to the slider and loader bar colours might be necessary.
Contents Upgrade wizard

Upgrade wizard screenshotAudio Player comes with an upgrade wizard. On the options panel, you can find out if a new update is available by clicking the Check for updates button. If an update is available, you will be prompted to open the upgrade wizard. Simply click Upgrade and the wizard will download the latest version and install it for you. Note: The upgrade wizard relies on some PHP functionality that is not available on all server configurations. You host may have disabled these features, in which case the upgrade wizard will be disabled.