Package: | Fabs.boombox.ui |
Defined In: | FullPlayer.js |
Class: | FullPlayer |
Extends: | Object |
Config Options | Defined By | |
---|---|---|
draggable : Boolean True to allow this element to be dragged. The element will
remain in its initial position in the DOM. Defaults to fa... True to allow this element to be dragged. The element will
remain in its initial position in the DOM. Defaults to false. | FullPlayer | |
emptyText : String The text to display in the info bar when no track is playing or active | FullPlayer | |
lang : Object The language strings to use for the player. Check the source to see the values that would need to be replaced | FullPlayer | |
loadingText : String The text to display when loading track information | FullPlayer | |
maxListHeight : Number The maximum size of the playlist | FullPlayer | |
minWidth : Number The minimum allowed width for the player. Only applicable if resizeable is enabled. | FullPlayer | |
opacity : Number The opacity of the player. A number between 0 and 1. Best to keep at 1 for now. | FullPlayer | |
player : Player The player reference for this ui. This is required. | FullPlayer | |
renderTo : HTMLElement/Element/String The element, or id of the element, to render this to upon creation | FullPlayer | |
resizeable : Boolean Allow the player to be resized. The right side will act as the handle.
Defaults to false | FullPlayer | |
scrollHold : Number The number of update intervals to wait before scrolling the opposite direction after the label has reached an end. | FullPlayer | |
scrollIncrement : Number The pixel increment that the track label should scroll. | FullPlayer | |
trackTpl : String The string template to display for tracks with song information | FullPlayer | |
unknownTrackTpl : String The string template to display for tracks without song information | FullPlayer | |
updateInterval : Number Then time in milliseconds to run the update tasks (label scrolling and position updating) | FullPlayer | |
width : Number/String The width of the player in pixels, or 'auto' to fill the containing element. Defaults to 'auto'. | FullPlayer | |
zIndex : Number The zIndex of the boombox element | FullPlayer |
Method | Defined By | |
---|---|---|
FullPlayer( Object config )
Parameters:
| FullPlayer | |
render( Element/HtmlElement/String el )
:
voidRender this function to an element. This can be called multiple times so long as it was unrendered first Render this function to an element. This can be called multiple times so long as it was unrendered first Parameters:
| FullPlayer | |
setWidth( Number/String width )
:
voidDynamically set the width of the player Dynamically set the width of the player Parameters:
| FullPlayer | |
togglePlaylist()
:
void Toggle the playlist visibility Toggle the playlist visibility Parameters:
| FullPlayer | |
unrender()
:
void Safely unrender the UI and remove all events Safely unrender the UI and remove all events Parameters:
| FullPlayer |