API Docs for: 0.0.1
Show:

App Class

Defined in: native\MediaMonkeyApp.js:1391
Module: Native

Main app support classes and functions

Methods

allowCollect

()

Defined in native\MediaMonkeyApp.js:1707

Allow app to collect garbage.

closeApp

()

Defined in native\BaseApp.js:1347

Close application.

createWindow

(
  • url
  • params
)

Defined in native\BaseApp.js:1297

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

Parameters:

  • url String

    URL to be opened in new window

  • params Object

    Parameters (optional)

Returns:

SharedWindow

currentLayout

() String

Defined in native\MediaMonkeyApp.js:1753

Get current layout name.

Returns:

String:

currentSkin

() String

Defined in native\MediaMonkeyApp.js:1744

Get current skin name.

Returns:

String:

flushState

()

Defined in native\MediaMonkeyApp.js:1690

Stores all persistent values to hard drive

getAddonList

(
  • archiveType
)
AddonList

Defined in native\MediaMonkeyApp.js:1771

Get list of addons. As archiveType parameter script can set type of addons to retrieve or 'all' for all addons.

Parameters:

  • archiveType String

    Type of the addon

Returns:

AddonList:

getCurrentPlayer

() Integer

Defined in native\BaseApp.js:1356

Get's current player type. Possible values: 0 - main player 1 - micro player 2 - mini player

Returns:

Integer:

getIniFile

() IniFileAccess

Defined in native\MediaMonkeyApp.js:1614

Creates new SharedIniFile interface to be used for reading and writing values from/to MediaMonkey.ini

Returns:

IniFileAccess:

getLayouts

() SharedList

Defined in native\MediaMonkeyApp.js:1717

Get {StringList} of available layouts. Selected item in this list is current layout.

Returns:

SharedList:

getObject

(
  • objectType
  • JS
)
Promise

Defined in native\MediaMonkeyApp.js:1655

Gets object by its type and additional info. Can return nil only if passed JS object contains parameter canReturnEmpty: true

Parameters:

  • objectType String

    like 'album', 'genre'

  • JS Object

    object with specifying info in its properties, like id, name, mbgid

Returns:

Promise:

getSkins

() StringList

Defined in native\MediaMonkeyApp.js:1735

Get {StringList} of available skins. Selected item in this list is current skin.

Returns:

StringList:

getValue

(
  • id
  • object
)
Object

Defined in native\MediaMonkeyApp.js:1667

Gets JS value/object previously stored by setValue,

Parameters:

  • id String

    unique id of the stored value

  • object Object

    object to pass (default value)

Returns:

Object:

object (modified object from the second parameter)

inSafeMode

() Boolean

Defined in native\BaseApp.js:1312

Return true when app is on safe mode where scripts are not loaded and default skin/layout is set.

Returns:

Boolean:

installAddonAsync

(
  • path
)
Promise

Defined in native\MediaMonkeyApp.js:1781

Install new addon.

Parameters:

  • path String

    Filename of the addon to install

Returns:

Promise:

listen

(
  • object
  • event
  • callback
  • capture
)

Defined in native\BaseApp.js:1263

Sets event listener of the object. Event function MUST be binded to object's window class.

Parameters:

  • object Object

    Object where to set listener

  • event String

    Event of the listener

  • callback Method

    Method for callback dispatch

  • capture Boolean

    Capture mode

Returns:

Method

loadLayout

(
  • name
)

Defined in native\MediaMonkeyApp.js:1726

Load defined layout.

Parameters:

  • name String

    Name of the layout to load

ODS

(
  • string
)

Defined in native\BaseApp.js:1288

Send debug string to event list.

Parameters:

  • string String

    debug string

preventCollect

()

Defined in native\MediaMonkeyApp.js:1699

Prevent app to collect garbage (must be in pair with allowCollect).

selectSkin

(
  • name
)

Defined in native\MediaMonkeyApp.js:1762

Load defined skin.

Parameters:

  • name String

    Name of the skin

setValue

(
  • id
  • value
)

Defined in native\MediaMonkeyApp.js:1679

Stores JS value/object to be persistent

Parameters:

  • id String

    unique id of the stored value

  • value Object

switchToMainPlayer

()

Defined in native\BaseApp.js:1322

Switch to player in main window.

switchToMicroPlayer

()

Defined in native\BaseApp.js:1330

Switch to player in tray bar.

switchToMiniPlayer

()

Defined in native\BaseApp.js:1338

Switch to player in separate mini window.

uninstallAddonAsync

(
  • addon
)
Promise

Defined in native\MediaMonkeyApp.js:1791

Uninstall addon.

Parameters:

  • addon Addon

    Addon to uninstall

Returns:

Promise:

unlisten

(
  • object
  • event
  • callback
)

Defined in native\BaseApp.js:1276

Removed event listener of the object.

Parameters:

  • object Object

    Object of the listener

  • event Event

    Event of the listener (optional)

  • callback Method

    Method to be removed (optional)

Properties

backgroundTasks

BackgroundTasks

Defined in native\BaseApp.js:1253

Gets background tasks manager

collections

Collections

Defined in native\MediaMonkeyApp.js:1574

Gets collections manager class

db

DB

Defined in native\MediaMonkeyApp.js:1504

Gets Database support class

devices

Devices

Defined in native\MediaMonkeyApp.js:1524

Gets portable devices manager class

dialogs

Dialogs

Defined in native\BaseApp.js:1243

Gets dialogs class

downloader

Downloader

Defined in native\MediaMonkeyApp.js:1514

Download manager class

fileFormats

FileFormats

Defined in native\MediaMonkeyApp.js:1584

Gets class for operating file formats

filesystem

Filesystem

Defined in native\MediaMonkeyApp.js:1594

Gets class for filesystem operations

hotkeys

Hotkeys

Defined in native\MediaMonkeyApp.js:1494

Gets hotkeys class

importer

TImporter

Defined in native\MediaMonkeyApp.js:1450

Gets class for importer operations

inPartyMode

Boolean

Defined in native\MediaMonkeyApp.js:1634

Gets/Sets whether app is in party mode

masks

Masks

Defined in native\MediaMonkeyApp.js:1460

Gets class for masks operations

platform

String

Defined in native\MediaMonkeyApp.js:1645

Gets application platform, possible values are 'win', 'mac'

player

Player

Defined in native\MediaMonkeyApp.js:1624

Gets Player object

playlists

Playlists

Defined in native\MediaMonkeyApp.js:1564

Gets playlists manager class

podcasts

Podcasts

Defined in native\MediaMonkeyApp.js:1554

Gets podcasts manager class

settings

Settings

Defined in native\MediaMonkeyApp.js:1484

Gets settings class

sharing

Sharing

Defined in native\MediaMonkeyApp.js:1534

Gets media sharing (UPnP/DLNA) manager class

sleeper

Shutdowner

Defined in native\MediaMonkeyApp.js:1544

Sleep timer class

trackOperation

TrackOperation

Defined in native\MediaMonkeyApp.js:1604

Gets Track operations class

trayIcon

TrayIcon

Defined in native\MediaMonkeyApp.js:1439

Gets class for tray icon operations

utils

Utils

Defined in native\MediaMonkeyApp.js:1474

Gets utils class