Module: home_js

Methods

(inner) addAlbumToHome(albumId, name, image) → {void}

Adds an album to the homescreen
Parameters:
Name Type Description
albumId string the albumid
name string name for the home icon
image string image for the home icon
Source:
Returns:
Type
void

(inner) addDirToHome(uri, name) → {void}

Adds a directory to the homescreen
Parameters:
Name Type Description
uri string directory uri
name string name for the home icon
Source:
Returns:
Type
void

(inner) addExternalLinkToHome() → {void}

Adds a external link to the homescreen
Source:
Returns:
Type
void

(inner) addOpenModalToHome() → {void}

Adds a modal shortcut to the homescreen
Source:
Returns:
Type
void

(inner) addPlistToHome(uri, type, name) → {void}

Adds a playlist to the homescreen
Parameters:
Name Type Description
uri string uri of the playlist
type string one of plist, smartpls
name string name for the home icon
Source:
Returns:
Type
void

(inner) addRadioFavoriteToHome(uri, type, name, image) → {void}

Adds a webradio favorite to the homescreen
Parameters:
Name Type Description
uri string uri of the webradio favorite
type string must be webradio
name string name for the home icon
image string image for the home icon
Source:
Returns:
Type
void

(inner) addScriptToHome(name, script) → {void}

Adds a script to the homescreen
Parameters:
Name Type Description
name string name for the home icon
script object script object
Source:
Returns:
Type
void

(inner) addSearchDirToHome() → {void}

Adds the current directory search to the homescreen
Source:
Returns:
Type
void

(inner) addSearchToHome() → {void}

Adds the current search to the homescreen
Source:
Returns:
Type
void

(inner) addSongToHome(uri, type, name) → {void}

Adds a song or stream to the homescreen
Parameters:
Name Type Description
uri string song or stream uri
type string one of song, stream
name string name for the home icon
Source:
Returns:
Type
void

(inner) addStreamToHome() → {void}

Adds a new stream to the homescreen
Source:
Returns:
Type
void

(inner) addViewToHome() → {void}

Adds a link to a view to the homescreen
Source:
Returns:
Type
void

(inner) addWebRadiodbToHome(uri, type, name, image) → {void}

Adds a webradioDB entry to the homescreen
Parameters:
Name Type Description
uri string uri of the stream
type string must be stream
name string name for the home icon
image string image for the home icon
Source:
Returns:
Type
void

(inner) deleteHomeIcon(pos) → {void}

Deletes a home icon
Parameters:
Name Type Description
pos number home icon position
Source:
Returns:
Type
void

(inner) duplicateHomeIcon(pos) → {void}

Duplicates a home icon
Parameters:
Name Type Description
pos number home icon position
Source:
Returns:
Type
void

(inner) editHomeIcon(pos) → {void}

Opens the edit home icon dialog
Parameters:
Name Type Description
pos number home icon position
Source:
Returns:
Type
void

(inner) executeHomeIcon(pos) → {void}

Executes the home icon action
Parameters:
Name Type Description
pos number home icon position
Source:
Returns:
Type
void

(inner) homeIconGoto(type, options) → {void}

Goto handler for home icons
Parameters:
Name Type Description
type string one of dir, search, album, plist, smartpls
options Array type = search: search expression, sort, sortdec type = album: albumId, else uri of directory or playlist
Source:
Returns:
Type
void
Opens the link in a new window
Parameters:
Name Type Description
link string uri to open
Source:
Returns:
Type
void

(inner) refreshHomeWidget(pos) → {void}

Executes the home icon action
Parameters:
Name Type Description
pos number home icon position
Source:
Returns:
Type
void