Gets background tasks manager
Gets Database support class
Optional debugGets portable devices manager class
Gets dialogs class
Download manager class
Gets class for operating file formats
Gets class for filesystem operations
Gets hotkeys class
Gets class for importer operations
Gets class for masks operations
Gets application platform, possible values are 'win', 'mac'
Gets Player object
Gets playlists manager class
Gets podcasts manager class
Gets settings class
Gets media sharing (UPnP/DLNA) manager class
Sleep timer class
Optional testsTesting functionality for internal builds.
Gets Track operations class
Gets class for tray icon operations
Gets utils class
Gets application version build
Gets application version major
Gets application version minor
Gets application version release
Gets application version string
Rest ...params: any[]Creates new window with URL. Currently these parameters are supported: left, top, width, height - position and size of the window posSaveName - save/restore name of the window isPopup (true/false) - is popup window
Rest ...params: any[]Parameters (optional)
SharedWindow
Finds whether updates are available for the addon list
Gets collections manager class
Creates new SharedIniFile interface to be used for reading and writing values from/to MediaMonkey.ini
Gets object by its type and additional info. Can return nil only if passed JS object contains parameter canReturnEmpty: true
like 'album', 'genre'
JS object with specifying info in its properties, like id, name, mbgid
Rest ...params: any[]Rest ...params: any[]Install new addon or update existing addon.
Filename of the addon to install (or download URL)
Optional addon: AddonAddon to update
Sets event listener for given object.
NOTE: In this documentation, classes and interfaces' events are labeled event_(eventKey), e.g. event_mousestatechanged. Do not include event_ in the eventKey.
Object where to set listener
Event of the listener
Method for callback dispatch
Optional capture: booleanCapture mode
The same callback function that was provided
app.listen(app, 'hotkey', (data) => {
uitools.toastMessage.show('Received ' + data.hotkey.toUpperCase());
});
var serverList = app.sharing.getRemoteServers();
app.listen( serverList, 'change', () => {
// server was added to (or removed) from the serverList
});
Fire the customLessChange event.
Fire the lessChange event (Notify all windows when LESS is recompiled in the main window)
NOTE: Added in 5.0.2
5.0.2
Fire the settingsChange event.
Load defined skin.
File path of skin, OR Skin object i.e. from app.currentSkin()
Optional soft: booleanWhether to do a soft reload of JUST the window (HTML and JS) rather than a full app restart.
Uninstall addon.
Addon to uninstall
Removes event listeners of the object. If event/method are not provided, then all matching listeners are removed.
Object of the listener
Optional eventKey: stringEvent name of the listener
Optional callback: FunctionCallback to be removed from the list of listeners
Optional capture: booleancapture mode
Event is called when app reload is done.
See App.listen
Event is called just before app reload (like when skin is changed).
See App.listen
Event is called when app is going to close.
See App.listen
Event is called when collection is changed.
changed Collection
Event is called when something is changed (like artist were changed, new genre is added to DB etc.). Parameters of this event can be various based on change notification.
See App.listen
Rest ...args: unknown[]Event is called when custom LESS values are modified (see window.setLessValues()).
See App.listen
Event is called when taskbar MM dock orientation changed.
See App.listen
new taskbar dock is in horizontal orientation
Event is called when hotkey is received.
received hotkey
Event is called when app is idle.
See App.listen
Event is called when LESS is modified (e.g. skin options are changed).
See App.listen
Event is called when app menu is closed.
See App.listen
Event is called any object is pinned to / unpinned from the media tree.
See App.listen
Event is called when playlist is changed in some way, additional params can detect the change type and new/old values Note: Introduced in 5.0.3
changed Playlist
(possible values 'title', 'new_child', 'child_removed', 'parent' or undefined)
possible values are playlist object, string or undefined
possible values are playlist object, string or undefined
app.listen(app, 'playlistchange', (playlist, changeType, newValue, oldValue) => {
if (changeType == 'title')
uitools.toastMessage.show(playlist.title + ' renamed from ' + oldValue + ' to ' + newValue);
else if (changeType == 'new_child')
uitools.toastMessage.show(playlist.title + ' has new child ' + newValue.title);
else if (changeType == 'child_removed')
uitools.toastMessage.show(playlist.title + ' -- child was removed ' + newValue.title)
else if (changeType == 'parent')
uitools.toastMessage.show(playlist.title + ' parent changed from ' + oldValue.title + ' to ' + newValue.title);
});
Event is called when a custom http request is received to our MediaServer
received request
Event is called when settings were changed
See App.listen
Event is called when new track is added to DB
See App.listen
added track
Event is called when any track is changed
See App.listen
changed track
Event is called when a track is modified and changes are commited.
See App.listen
modified track
Event is called when app is received any command from taskbar icon. Possible event names are 'click', 'dblclick', 'mousedown', 'mouseup', 'mousemove', 'mouseenter', 'mouseexit', 'hintshow', 'hinthide', 'hinttimeout', 'hintclick'.
See App.listen
name of the event
button index
x mouse position
y mouse position
Main app support classes and functions
App