Documentation

Demos
Download
Buy
Support
Overview

Getting Started

API Reference

Technical Info

 
litePlayer™ Options

In addition to setting the player width and height as described in setup, you can further customize the appearance and behavior of litePlayer™ using the options below.

APPEARANCE

litePlayer™ has built-in graphics to get you started quickly. Use the color, bgcolor, and bordercolor options to style the built-in graphics. Or, for custom skinning, use the playicon, pauseicon, and loadicon options to suppress the built-in graphics and load your own external images instead. litePlayer™ will default to the built-in graphics if any of the external images is undefined or not successfully loaded.

color
TYPE: string
DEFAULT: 333333
Color of the built-in play, pause, and loading icons.
bgcolor
TYPE: string
DEFAULT: CCCCCC
Background color of the built-in play, pause, and loading icons.
bordercolor
TYPE: string
DEFAULT: none
Border color of the built-in background. If set, border will be 1px in size.
playicon
TYPE: string
DEFAULT: none
Location of an external image to replace the built-in PLAY icon. (See IMAGE NOTES*)
pauseicon
TYPE: string
DEFAULT: none
Location of an external image to replace the built-in PAUSE icon. (See IMAGE NOTES*)
loadicon
TYPE: string
DEFAULT: none
Location of an external image to replace the built-in LOADING icon. (See IMAGE NOTES*)
*IMAGE NOTES: External images can be referenced using absolute or relative URLs. If using relative URLs, location is relative to the document in which litePlayer™ is embedded. Supported image formats are JPG, GIF, PNG, and SWF. GIF transparency and animation are not supported. If transparency is desired, use PNG. If animation is desired, use SWF.


BEHAVIOR

file
TYPE: string (URL)
DEFAULT: none
Location of the audio file or stream to play. This can be referenced using an absolute or relative URL. If using a relative URL, location is relative to the document in which litePlayer™ is embedded. This is the ONLY REQUIRED setting to make litePlayer™ work.
autoplay
TYPE: boolean
DEFAULT: false
If set to true, the audio file will start playing automatically when the page loads.
loop
TYPE: boolean
DEFAULT: false
If set to true, the audio file will automatically repeat until stopped.
volume
TYPE: integer
DEFAULT: 90
Player volume on a percentage scale of 0 to 100.
solo
TYPE: boolean
DEFAULT: true
If set to false, starting the player will not automatically stop other players that are already playing on the same page.
oncomplete
TYPE: string
DEFAULT: none
Name of an external javascript function to be called when the player reaches the end of the file. The named function will not be called if the player does not reach the end of the file or if loop is set to true.
key
TYPE: string
DEFAULT: none
License key to remove trial-mode distinctions. You can purchase a license key here.
© 2024 Globalcentric LLC  •  litePlayer is a trademark of Globalcentric LLC Terms of Use and Licensing Agreement

67043