[[PlayerToc(plugins)]]

= Audiodescription plugin = 

This plugin plays a closed audiodescription parallel to the main file, for accessibility or director's comments use. This audiodescription is a single MP3 file.

This plugin is compatible with version 4.1 of the player. For 4.3+, the plugin will place a  button in the controlbar. For 4.5+, the plugin can also place a button in the dock (if the ''dock=true'' flashvar is set).

== Example == 

Here is an example of the audiodescription plugin in action. Below is the string of flashvars used. The female voice represents the AD:

[[JWPlayer(400,250,file=/player/testing/files/corrie.flv&plugins=audiodescription&audiodescription.file=/player/testing/files/corrie.mp3)]]

{{{
file=/player/testing/files/corrie.flv&plugins=audiodescription&audiodescription.file=/player/testing/files/corrie.mp3
}}}

== Configuration == 

The plugin is loaded with the flashvar ''plugins=audiodescription''. This will automatically load the latest version of the plugin straight off our servers. It offers three additional flashvars for tweaking the plugin:

 * '''audiodescription.file''' (''undefined''):  location of the audiodescription MP3 to play.
 * '''audiodescription.state''' (''true''): set this to ''false'' to turn off the audiodescription by default.
 * '''audiodescription.volume''' (''90''):  volume of the audiodescription. Crank this even more up to have the AD overrule the default sound. We're still working on an update of this plugin that will automatically ''duck'' the original audio when there's a significant volume on the audiodescription.

Note that MP3 files should preferably be in a 44.1Khz, constant bit rate format. Flash fails to play back MP3 files in various other formats, resulting in either chipmunk effects or suddens stops halfway the file.

== Source code == 

The source code of this plugin can be obtained [changeset:HEAD/plugins/audiodescription?old_path=%2F&format=zip in a zip] (click the zip links at the bottom) or through [http://subversion.tigris.org/ Subversion]:

{{{
svn co http://developer.longtailvideo.com/svn/plugins/audiodescription
}}}

If you don't have a Subversion client, check out [http://tortoisesvn.tigris.org/ Tortoise] (Windows) or [http://scplugin.tigris.org/ SC Plugin] (MAC).

You don't need Adobe Flash to modify this plugin. Instead, you can edit the plugin with any text editor you like. The plugin can be compiled with the free, cross-platform [http://www.adobe.com/cfusion/entitlement/index.cfm?e=flex3sdk MXMLC compiler]. See our [wiki:PluginsCompiling plugin compiling overview] for more info.