DOWNLOADS EXAMPLES SKINS DOCS SUPPORT
 
 

Options Reference

Options are configured within the Wimpy Javascript file (wimpy.js) or within a custom configuration object. To edit the options, open wimpy.js with a text editor. The available options are already included within the "OPTIONS" section.

Option Variable

Option Explanation

wimpySwf

URL to where you have wimpy.swf uploaded to your server.

Example:

ConfigObject.wimpySwf = "http://www/path/to/wimpy.swf";

wimpyApp

URL to where you have wimpy.php (or wimpy.asp) uploaded to your server.

Example:

ConfigObject.wimpyApp = "http://www/path/to/wimpy.php";

playlist

URL's to MP3 files. To have more than one MP3 file listed, separate each URL with a "pipe" character.

Example:

ConfigObject.wimpyApp = "songA.mp3|songB.mp3";

You may also reference an external XML playlist file here, however the XML playlist will wimply be listed in the player with all the other tracks. To load and OPEN and external playlist, set the wimpyApp option to a URL to an XML playlist.

The "playlist" configuration option is only used to manually list individual files (see example 1 and 2), whereas "wimpyApp" is used to establish and external playlist file that Wimpy should OPEN (see example 3).

wimpySkin

URL to skin_name.xml file

Example:

wimpySkin = "http://www.yoursite.com/path/to/skin_wimpy_vert.xml";

 

wimpyConfigs

URL to config file. if this is used, the config file will over-ride the options set below.

Example:

ConfigObject.wimpyConfigs = "http://www.yoursite.com/path/to/wimpyConfigs.xml";

trackPlays

URL to script that receives information about the file

Example:

ConfigObject.trackPlays = "http://www.yoursite.com/path/to/wimpy_trackplays.php";

Leave as empty string if not using.

Example:

ConfigObject.trackPlays = "";

voteScript

URL to script that receives information about the file

Example:

ConfigObject.voteScript = "http://www.yoursite.com/path/to/wimpy_vote_script.php";

Leave as empty string if not using.

Example:

ConfigObject.voteScript = "";

defaultImage

URL to default image (jpg or swf format only)

Example:

ConfigObject.voteScript = "http://www.yoursite.com/path/to/graphic.jpg";

Leave as empty string if not using.

Example:

ConfigObject.defaultImage = "";

startPlayingOnload

This should be pretty easy to understand.

Options: "yes" or "no"

ConfigObject.startPlayingOnload = "no";

shuffleOnLoad

This should be pretty easy to understand.

Options: "yes" or "no"

ConfigObject.shuffleOnLoad = "no";

randomOnLoad

This should be pretty easy to understand.

Options: "yes" or "no"

ConfigObject.randomOnLoad = "no";

displayDownloadButton

This should be pretty easy to understand. Download links will open files in a new window.

Options: "yes" or "no"

ConfigObject.displayDownloadButton = "no";

 

startOnTrack

This will cause wimpy to start on a specific track in the playlist. The number used will be the track number Wimpy will start to play when Wimpy loads up. Using this option will over-ride "startPlayingOnload" -- if startPlayingOnload is set to "no" and this option is set, then Wimpy will automatically set startPlayingOnload to "yes"

Example:

ConfigObject.startOnTrack = "3";

Leave as empty string if not using.

Example:

ConfigObject.startOnTrack = "";

autoAdvance

Force the user to click "next" to advance to the next track, or automatically advance )keep on playing tracks)

Options: "yes" or "no"

ConfigObject.autoAdvance = "yes";

 

popUpHelp

This should be pretty easy to understand.

Options: "yes" or "no"

ConfigObject.popUpHelp = "yes";

scrollInfoDisplay

This should be pretty easy to understand.

Options: "yes" or "no"

ConfigObject.scrollInfoDisplay = "yes";

infoDisplayTime

This will set the speed of the scroller. Higher values will increase the scroll speed.

ConfigObject.infoDisplayTime = "3";

bufferAudio

This will cause the player to "wait" the specified period of time (in seconds) before the track actually starts to play. This option is good for slow internet connections, since it allows the file to load X number of seconds before it starts to play -- thereby minimizing a "choppy" playback. If the end user has a fast connection, the track may not hesitate for the total number of seconds used for this option and may start to play much sooner.

Options: Number of seconds to "wait" before playing track. (For slow connections only)

ConfigObject.bufferAudio = "3";

theVolume

This will set the "default" volume percentage when the player starts up.
Options: Any number from 0 to 100 (think "percent")

ConfigObject.theVolume = "100";

defaultVisualExt

If you are using a skin that displays cover art, wimpy will automatically attempt  to load an image that has the same name as your audio.mp3 file. For example, if you have a file located here:

http://www.yoursite.com/mp3s/track1.mp3

Then wimpy will attempt to load:

http://www.yoursite.com/mp3s/track1.jpg

Set this to the type of file it should load.
Options: "swf" or "jpg"

ConfigObject.defaultVisualExt = "jpg";

limitPlaytime

Limits the amount of time that the file is allowed to play. Set this to a number of seconds that files should be allowed to play.

The following example above will limit play time to 30 seconds:

ConfigObject.limitPlaytime="30";

 

startupLogo

You can use either a JPG or SWF image as the start up logo, which will replace the default "W" logo when the player starts up.

When the image is loaded, it is centered within the player's bounding box. The image is not resized, it is only centered.

Example:

ConfigObject.startupLogo = "http://www.yoursite.com/images/logo.jpg";

NOTE: If you are using an SWF logo, Wimpy will center the loaded movie based on the dimensions of all of the objects on the main stage, so if there are any "invisible" items, or if objects "hang off the edge" of the main stage, or if the objects are smaller than the main stage, the loaded logo may not get centered properly. Wimpy can not determine the size of the main stage, it can only determine the size of all the objects on the main stage.

ecomWindow

 

Opens hyperlinks in the designated window.

Example:

ConfigObject.ecomWindow = "_self";

By default, Wimpy will target "_blank" -- when this option is set Wimpy directs the 'target" attribute of the <a href> hyperlink to the window name that is defined with this option.

Usually, the <a href> "target" attribute refers to an HTML frame name. However, you can use JavaScript to establish a "window name" for any HTML page. For more information on establishing a "window name" for an HTML page, Google for:

JavaScript window.name

 

 

 

 

 

 

  ©Copyright Plaino LLC. All rights reserved.