lib/mp3player/readme.txt

   1 Many aspects of the appearance and behaviour of the mp3 player can be customised,
   2 these custom values are set by passing variables to the flash movie using "flashvars".
   3 flashvars are supplied to the movie using
   4
   5 <param name="flashvars" value="some value">
   6
   7 alongside the other param tags, and with an extra attribute in the embed tag
   8
   9 flashvars="some value"
  10
  11 the "some value" part is a list of urlencoded variables
  12
  13 &variableName=value&anotherVariable=anotherValue&
  14
  15  +--------------------------------------------------------------------------------------------------------------------+
  16  | Variable Name   | Possible Values                            | What it does                                        |
  17  |--------------------------------------------------------------------------------------------------------------------|
  18  | bgColour        | a colour in the format RRGGBB where        | sets the background colour of the player.           |
  19  |                 | RR, GG and BB are hexadecimal values       |                                                     |
  20  |                 | (00 to FF) representing the Red, Green     |                                                     |
  21  |                 | and Blue parts of the colour. eg           |                                                     |
  22  |                 | ffffff is white, 000000 is black,          |                                                     |
  23  |                 | ff9900 is orange, 000033 is a dark blue.   |                                                     |
  24  |                 | the default colour is black.               |                                                     |
  25  |--------------------------------------------------------------------------------------------------------------------|
  26  | btnColour       | the same as bgColour, the default colour   | sets the colour of the play and pause buttons.      |
  27  |                 | is white.                                  |                                                     |
  28  |--------------------------------------------------------------------------------------------------------------------|
  29  | btnBorderColour | the same as bgColour, the default colour   | the colour of the border around the buttons.        |
  30  |                 | is grey.                                   | make this the same as btnColour if you don't want   |
  31  |                 |                                            | a border.                                           |
  32  |--------------------------------------------------------------------------------------------------------------------|
  33  | iconColour      | the same as bgColour, the default colour   | the colour of the play/pause icons.                 |
  34  |                 | is black.                                  |                                                     |
  35  |--------------------------------------------------------------------------------------------------------------------|
  36  | iconOverColour  | the same as bgColour, the default colour   | the colour of the play/pause icons when the mouse   |
  37  |                 | is green.                                  | is over the button.                                 |
  38  |--------------------------------------------------------------------------------------------------------------------|
  39  | handleColour    | the same as bgColour, the default colour   | the colour of the handles on the playback slider,   |
  40  |                 | is white.                                  | volume and pan controls.                            |
  41  |--------------------------------------------------------------------------------------------------------------------|
  42  | trackColour     | the same as bgColour, the default colour   | the colour of the track for the playback slider,    |
  43  |                 | is grey.                                   | volume and pan controls.                            |
  44  |--------------------------------------------------------------------------------------------------------------------|
  45  | loaderColour    | the same as bgColour, the default colour   | the colour of the loading bar.                      |
  46  |                 | is white.                                  |                                                     |
  47  |--------------------------------------------------------------------------------------------------------------------|
  48  | font            | a name of a font, eg verdana. the          | the font used in the movie.                         |
  49  |                 | default value is Trebuchet MS.             |                                                     |
  50  |--------------------------------------------------------------------------------------------------------------------|
  51  | fontColour      | the same as bgColour, the default colour   | the colour of the text.                             |
  52  |                 | is white                                   |                                                     |
  53  |--------------------------------------------------------------------------------------------------------------------|
  54  | waitForPlay     | yes or no, the default is no.              | should the player wait until the play button is     |
  55  |                 |                                            | pressed before starting to download the file?       |
  56  |--------------------------------------------------------------------------------------------------------------------|
  57  | autoPlay        | yes or no, the default is yes.             | will the player wait until the play button is       |
  58  |                 |                                            | pressed before starting to play the file? if        |
  59  |--------------------------------------------------------------------------------------------------------------------|
  60  | buffer          | a value in seconds, the default is 20.     | how many seconds of the file should be buffered     |
  61  |                 |                                            | before playback starts?                             |
  62  |--------------------------------------------------------------------------------------------------------------------|
  63  | volText         | a string (could this come from the         | the text used in the player to label the volume     |
  64  |                 | language pack?) the default is "Vol".      | control.                                            |
  65  |--------------------------------------------------------------------------------------------------------------------|
  66  | panText         | the same as volText. the default is "Pan". | the text used in the player to label the pan        |
  67  |                 |                                            | control.                                            |
  68  +--------------------------------------------------------------------------------------------------------------------+
  69
  70
  71 a brightly coloured example ;)
  72
  73 <param name="flashvars" value="&bgColour=ffff00&btnColour=00ff00&&btnBorderColour=ff9900iconColour=000000&iconOverColour=ff00ff&handleColour=ff00ff&trackColour=000000&loaderColour=ff9900&font=verdana&fontColour=ff0000&waitForPlay=no&dontAutoPlay=yes&buffer=30&">
  74
  75 the content of the value attribute would need to be repeated and included as the value of
  76 the flashvars attribute in the embed tag.
  77
  78
  79 extra notes...
  80
  81 the song information comes from 2 sources, initally the player displays the filename (minus the file extension)
  82 as the title, once the file is fully loaded it checks the id3 data in the mp3 file for the songname, artist and year
  83 and displays this information instead of the filename.
  84
  85
  86 Andy Walker (www.altoncollege.ac.uk)
  87