Wimpy MP3 Player API

Server Side

Actions:
serveMP3
downloadfile
dir
phpinfo
feedPlaylist
getCoverart
podcast

Directives:
wimpyConfigFile
media_types
wimpy_auth
getMyid3info
ecommerce
ecomWindow
useMysql
defaultVisualBaseName
defaultVisualExt
hide_folders
hide_files
startDir
getid3libPath
httpOption
blockPHPinfo

Client Side

wimpyApp
wimpySkin
startPlayingOnload
randomOnLoad
shuffleOnLoad
displayDownloadButton
autoAdvance
popUpHelp
forceDownload
startOnTrack
trackPlays
voteScript
getMyid3info
forceXMLplaylist
useSysCodePage
ecommerce
ecomWindow
useMysql
scrollInfoDisplay
infoDisplayTime
bufferAudio
theVolume
defaultImage
loopPlaylist
limitPlaytime
startupLogo
wimpyStartFolder

HTML display

wimpySkin
wimpySwf
bkgdColor
tptBkgd
wimpyHTMLpageTitle
useSysCodePage

 

 

 

wimpyApp

wimpyApp -- Sets the proper URL to file that feeds wimpy a playlist.

Usage

wimpy.swf?wimpyApp=http://www/path/to/wimpy.php

Description

the application or file that feeds wimpy the playlist may do so in either in XML or the default SIFT playlist format. If you specify a URL/file that uses an XML extension, wimpy will automatically determine that the incoming wimpyApp is an XML playlist.

When running wimpy off of an XML playlist, certain features of the player will not be available. Features such as forceDownload, serveMP3 will not work -- since these options take advantage server-side scripting environments.

You may also reference an RSS feed (i.e. a PodCast). Wimpy will automatically recognize RSS files files with an RSS extension as XML files.

If you have developed a script that can feed an XML playlist to Wimpy and the URL to the file does not end with foo.xml, you must set the "forceXMLplaylist" option to "yes" so that Wimpy will always read incoming playlist data as if it were and XML playlist and not the default Sift-based playlist.

For more information on the available Wimpy Playlist formats.

There are a couple of different ways to locate the wimpy.php or playlist.xml file. Consider the following scenario:

Let's say you would like to embed Wimpy Player on your home page:
http://www.yoursite.com/index.html

Your Wimpy files + mp3s reside here:
http://www.yoursite.com/mp3s/songs.mp3
http://www.yoursite.com/mp3s/wimpy.swf
http://www.yoursite.com/mp3s/wimpy.php

Even though wimpy.swf is located in the mp3s folder, it is embedded into the HTML page, hence, wimpy "thinks" it is located in the same location as the HTML page... In other words wimpy.swf "thinks" it is located here: http://www.yoursite.com/wimpy.swf (even though it really isn't) This is just the way that flash works.

We have to let wimpy.swf know where wimpy.php is located. There are a number of different ways to do this. You can use a "URL", "absolute" or "relative" path to wimpy.php.

URL:
http://www.yoursite.com/mp3s/wimpy.php
or
http://www.yoursite.com/mp3s/playlist.xml

Absolute:
/mp3/wimpy.php
or
/mp3/playlist.xml

Relative:
../../mp3s/wimpy.php
or
.. /../mp3s/playlist.xml

OR
wimpy.php
or
playlist.xml

OR
mp3s/wimpy.php
or
mp3s/playlist.xml

For our example, you can use any one of the following:
/mp3s/wimpy.php
mp3s/wimpy.php
http://www.yoursite.com/mp3s/wimpy.php

or
/mp3s/playlist.xml
mp3s/
playlist.xml
http://www.yoursite.com/mp3s/
playlist.xml

 

 

See Also:

SIFT, forceXMLplaylist, forceDownload, serveMP3

.

 

wimpyApp

 

 



©2002-2008 Plaino.