XML MP3 WHEELS documentation
 
 
UPDATE

The help documentation will be updated and improved with customer feedback.

* Before starting, check to see if you should download the latest readme.htm file from the server and replace this one (version on right top)
* Check the latest FAQ, tips and help topics on the FORUM

> TOP <

 
Quick Start

When you receive the product you will receive a .zip file. The zip file will contain the following files

  • xml_MP3_WHEELS_hightech_albumlist.fla
    xml_MP3_WHEELS_hightech_albumlist_small.fla
    xml_MP3_WHEELS_hightech_noalbumlist.fla
  • swf files of same file names as above
  • music.xml
  • /classes/player.as
  • Readme.htm
  • /caurina/
  • /albumart/
  • /mp3/

Do the following steps to start using XML MP3 WHEELS ;

  1. Unzip the .zip file
  2. Open Flash CS3
  3. Open any of the .fla files
  4. copy he MP3 WHEELS .fla Library contents to your .fla Library
  5. copy the component from the MP3 WHEELS .fla stage to your own .fla file
  6. In the unzipped directory (folder), copy the /classes/ , /caurina/ , /albumart/ and /mp3/ folder and music.xml to the directory (folder) of your own .fla file
  7. In your .fla select the XML MP3 WHEELS component on stage and open [Component Inspector], make changes to parameters if you need (see Parameters section in this Readme.)
  8. Make changes to the Component library items and change it's assets to create the visual you like.
  9. Change the music.xml to the tracks you want it to play

> TOP <

 
Component Parameters.
When you place the XML MP3 WHEELS component on stage, you will have a number of parameters you can modify to suit the menu to your needs. Below are detailed explanations about what every parameter does or customizes.

xmlmusicdatafile
The name of the .xml file. The component i will include a sample "music.xml" file which you can use as startpoint or template for your own .xml file. In this xml file you define which song/tracks the player will load.

addprogress
If set to true, a progress bar will be added to the player

addtime
If set to true, a time display will be added to the player

addtitledisplay
If set to true, a moving title display will be added to the player

addlist
If set to true, a scrollable music/track list will be added to the player

addlistalbums
If set to true, a scrollable album list will be added to the player

addspectrum
If set to true, a sound spectrum animation will be added to the player

addalbumart
If set to true, a wheel with album art thumbnail will be added to the player

addlisthover
If set to true, a track/album mouse-hover information panel will be added to the player

autonext
If set to true, when finishing a track/song it will automatically go to the next song in the list. If set to false, it will keep repeating the current track

spoolspeed
Speed of rewinding or fastforward-ing a track. Initial value, can be changed by user turning the spool wheel

title_add_album
If set to true, the album name will be added to the track title text

title_add_artist
If set to true, the artist name will be added to the track title text

main_add_album
If set to true, the album name will be added to the main (album headers) title text

main_add_artist
If set to true, the artist name will be added to the main (album headers) title text

spectrumtype
Animation type for the sound spectrum, from 1 to 12

spectrumfr
Visual strength of the spectrum animation.

addspectrumbuttonst
If set to true, 12 spectrum change buttons will be added to the spectrum animation in the player

dorandomspectrum
If set to true, the player will randomly choose a spectrum animation type for each song

albumautonext
Jump to next album when finishing last track in an album.

startvolume
Between 0 and 1, the start volume for the player to start with.

hoverinfoitem
Show information panel on track listing mouse over

hoverinfoalbum
Show information panel on main (album headers) mouse over.

crossdomainurl
Use a cross domain security link.


> TOP <

 
Overriding specific properties of xml node entries

Item options
The following tag can be included into xml <musicitem> nodes

  • main="true" (only include this to make a listitem a "divider" listmaintype item)

The following nodes can be included into xml <musicitem> node.

  • <itemname> (filename of the mp3 file)
  • <title> (name of title which wil appear in player)
  • <artist> (name of artist which wil appear in player)
  • <album> (name of ablbum which wil appear in player)
  • <link> (html link of the icon next to items in the music list)
  • <startpoint> (point where to start the track - format minutes - seconds - miliseconds split by "dots")
  • <endpoint> (point where to stop the track - format minutes - seconds - miliseconds split by "dots")
  • <thumbnail> (html link of the thumbnail image of albums)
  • <extratext> (extra text of information panel hovering mouse over track listings and album listings)

> TOP <