AFComponents.com

Simple MP3 Player V. 2.0 API Docs



Properties

Name Type Description
autoPlay Boolean Property indicates whether playback starts immediately (true).
bufferTime Number Property indicates the number of seconds to buffer in memory before beginning to play an audio stream (progressive download).
content Object Object that that defines track properties.
  1. title:Mixed – A String or a Number that appears as track title.
  2. path:String – A String that indicates path to the external audio (MP3) track.
  3. data:Mixed – Additional property
contentRSS String Property indicates path to the RSS 2.0 file. Use this property to define a path to a Podcast feed.

Sample Podcast Feed
http://feeds.feedburner.com/podshowmusic
contentXML String Property indicates path to the XML file.

Sample XML file:
http://www.afcomponents.com/components/simple_mp3/content.xml
fontName String Property indicates primary font.
fontSize Number Property indicates primary font size.
ID3formatString String Property indicates ID3 String formatting.
ID3Title Object Object defines message text.
  1. buffering – displayed during buffering.
  2. error – displayed whenever there is an error loading mp3 track.
  3. id3loading – displayed during ID3 tags loading.
  4. id3notfoud – displayed whenever ID3 tags are not found.
  5. XMLerror – displayed whenever there is an error loading XML file.
  6. track – Displayed track name.
speaker Boolean Property indicates whether speaker icon is displayed (true).
speakerColor Boolean Property defines speaker color.
speakerOverColor Number Property defines speaker color onRollOver.
textDisplay String Property indicates test display parameter.
  1. track number:String – track numbers are displayed.
  2. track title:String – track title is displayed.
textDisplayColor Number Property indicates text display color.
textDisplayOverColor Number Property indicates text display color onRollOver.
volume Number Property (0-100) indicates initial volume.
getTotalItems Number Returns total number of items in the content object.

Example

var items = myPlayer.getTotalItems();

trace(items);

Methods

Name Return Type Description
stop( void ) Void Stops playback of the current track.

Example

myPlayer.stop();
play( [time:Number] ) Void Starts playback of the current track. time – is a non negative integer that indicates staring time.

Example

myPlayer.play();
pause( void ) Void Pauses playback of the current track.

Example

myPlayer.pause();
dspNextItem( void ) Void Loads next item specified in the content object.

Example

myPlayer.dspNextItem();
dspPrevItem( void ) Void Loads previous item specified in the content object.

Example

myPlayer.dspPrevItem();
dspItemNum( track:Number ) Void Loads specified item.

Example

myPlayer.dspItemNum(3);  //Load track number 3
getItemNum( track:Number ) Object Returns content object specified by the attribute.

Example

var item:Object = new Object();

item = myPlayer.getItemNum(2);

trace("Description: "+item.title);
trace("Path: "+item.path);
trace("Data: "+item.data);
addItem( Title:String,
path:String,
data:String )		 Void Adds new item.

Example

myPlayer.addItem("Track TItle", "track.mp3", "1");

Events

Name Return Value Description
stateChanged type
target		 Triggered when component state changes.

Example

function stateChanged (evnt){
 trace(evnt.type);
 trace(evnt.target);
}
myPlayer.addEventListener("stateChanged ", this);
start type
target		 Triggered when playback starts.

Example

function start(evnt){
 trace("playback started");
}
myPlayer.addEventListener("start", this);
stop type
target		 Triggered when playback stops.

Example

function stop(evnt){
 trace("playback stopped");
}
myPlayer.addEventListener("stop", this);
pause type
target		 Triggered when payback paused.

Example

function pause(evnt){
 trace("playback paused");
}
myPlayer.addEventListener("pause", this);
mouseOver type
target
title
path
data
number		 Triggered onMouseOver event.
In order for this event to get triggered textDisplay property has to be set to "track number".

Example

function mouseOver (evnt){
 trace(evnt.title);
 trace(evnt.path);
 trace(evnt.data);
 trace(evnt.number);
}
myPlayer.addEventListener("mouseOver", this);
mouseOut type
target
title
path
data
number		 Triggered onMouseOut event.
In order for this event to get triggered textDisplay property has to be set to "track number".

Example

function mouseOut (evnt){
 trace(evnt.title);
 trace(evnt.path);
 trace(evnt.data);
 trace(evnt.number);
}
myPlayer.addEventListener("mouseOut", this);
mouseClick type
target
title
path
data
number		 Triggered onMouseClick event.
In order for this event to get triggered textDisplay property has to be set to "track number".

Example

 function mouseClick (evnt){
 trace(evnt.title);
 trace(evnt.path);
 trace(evnt.data);
 trace(evnt.number);
}
myPlayer.addEventListener("mouseClick", this);
complete type
target
title
path
data
number		 Triggered once mp3 file finishes loading.

Example

function complete (evnt){
 trace(evnt.title);
 trace(evnt.path);
 trace(evnt.data);
 trace(evnt.number);
}
myPlayer.addEventListener("complete", this);
progress type
target
title
path
data
number		 Triggered during file loading.

Example

function progress (evnt){
 trace(evnt.description);
 trace(evnt.path);
 trace(evnt.data);
 trace(evnt.number);
 trace(evnt.bytesLoaded); // bytes loaded
 trace(evnt.bytesTotal);  // bytes total
 trace(evnt.percentLoaded);
}
myPlayer.addEventListener("progress", this);
time type
target
currentTime
totalTime		 Triggered when playback time is changed.

Example

function time (evnt){
 trace(currentTime);
 trace(totalTime);
}
myPlayer.addEventListener("time", this);
buffer type
target
percentBuffered		 Triggered during file buffering.

Example

function buffer (evnt){
 trace(evnt.percentBuffered);
}
myPlayer.addEventListener("buffer", this);



© 2005-2007 advanced flash components