MediaMonkey Wiki - User contributions [en]

Working with Native Objects & Data

2025-07-29T20:50:14Z

Ludek: /* Read/Write Locks */

In MediaMonkey 5, data from the database is managed by native objects called ''Shared Objects''. Unless your addon requires heavy customization, you will not need to handle database calls yourself.

=Concepts=

==Shared==
These objects are not normal JavaScript objects with properties. They contain native (compiled) code and their properties are accessible from all windows. So unlike normal JS objects, changing one of their properties will cause it to be immediately updated everywhere else in the code. It's an advantage of the way MM5 was programmed - It lets us do all our intensive database operations in multithreaded native code, freeing up the JavaScript thread to just handle UI.

If you open the Chromium dev tools (on a debug build, by right click > Inspect Element, and print out one of the shared objects to the console, you'll notice that it says "native code" instead of showing a JavaScript function declaration.
<syntaxhighlight>
> trackList.forEach
< ƒ forEach() { [native code] }
</syntaxhighlight>

==Read/Write Locks==
In order for these database operations to be multithreaded, we need to implement a concept called ''read locks'' and ''write locks''. Consider what could happen if one thread attempted to write while another thread attempted to read data. The thread attempting a read will have no guarantee that the data is intact. It could be read either before the new value is written or after, or it could be read at the exact moment while the data is being overwritten, which would produce garbage data.

How do we avoid that issue? We prevent reads and writes from happening at the same time. Before writing data, the thread will wait for all readers to finish, and then it writes. Conversely, before reading data, the thread will wait for a write to finish before starting.
Think of it like a stop light at a highway. Reads are like the highway with multiple lanes; Multiple read cars can pass at once, and while read cars are passing, write cars have to stop. Once the reads finish, the write car can pass through.

[https://www.mediamonkey.com/docs/api/classes/Native.SharedBase.html#locked SharedList.locked()] enters a read lock. If you need to access individual items of a list, and need to work with indices, use <code>locked()</code>.
<syntaxhighlight lang="javascript">
trackList.locked(function () {
// This code will execute as soon as a read lock has been acquired.
// There is NO GUARANTEE that it will execute immediately.
var firstTrack = trackList.getValue(0);
var lastTrack = trackList.getValue(trackList.count - 1);
});
</syntaxhighlight>

[https://www.mediamonkey.com/docs/api/classes/Native.SharedList.html#modifyAsync SharedList.modifyAsync()] enters a write lock. If you need to ''modify'' tracks in a list, use <code>modifyAsync()</code>. Note: You ''are'' allowed to read values in a write lock. It will simply prevent other threads from reading that list until you are done.
<syntaxhighlight lang="javascript">
trackList.modifyAsync(function () {
// This code will execute as soon as a write lock has been acquired.
// There is NO GUARANTEE that it will execute immediately.
var firstTrack = trackList.getValue(0);
firstTrack.custom1 = "Hello World";
});
</syntaxhighlight>

If you do not need to access list items with indices, use the more convenient [https://www.mediamonkey.com/docs/api/classes/Native.SharedList.html#forEach SharedList.forEach()] function. It will execute your callback for each item in the list, and it will automatically wait for a read lock.
<syntaxhighlight lang="javascript">
trackList.forEach(function (track) {
// This code will execute as soon as a write lock has been acquired.
// There is NO GUARANTEE that it will execute immediately.
console.log(track.title);
});
</syntaxhighlight>

Methods like [https://www.mediamonkey.com/docs/api/classes/Native.SharedList.html#clear clear()] and [https://www.mediamonkey.com/docs/api/classes/Native.SharedList.html#selectRangeAsync selectRangeAsync()] automatically enter write locks, so you do not need to call <code>modifyAsync()</code>.

For performance reasons, please use asynchronous methods (with "Async" at the end of the method name) as much as possible, '''especially if you are processing a lot of data'''. Unlike the native objects, JavaScript only has one thread, so if you do a lot of processing, it will block the rest of the UI.

There is one exception to the above rule: If you need to retrieve all values of ''one particular property'' in a large list (For example: a list of all track titles), consider using the synchronous method [https://www.mediamonkey.com/docs/api/classes/Native.SharedList.html#getAllValues getAllValues()]. It is much faster than using forEach().
<syntaxhighlight lang="javascript">
var listOfTitles = trackList.getAllValues('title');
</syntaxhighlight>

''TL;DR:''
# SharedLists work differently from normal JavaScript arrays and objects.
# For most cases, you can use <code>forEach()</code> to get data from each item in the list.
# To modify contents of a list, use <code>modifyAsync()</code>.
# Don't do tons of calculations / operations in a synchronous function; Make your code as asynchronous as possible.

''More coming soon''

Working with Native Objects & Data

2025-07-29T20:49:23Z

Ludek: /* Read/Write Locks */

In MediaMonkey 5, data from the database is managed by native objects called ''Shared Objects''. Unless your addon requires heavy customization, you will not need to handle database calls yourself.

=Concepts=

==Shared==
These objects are not normal JavaScript objects with properties. They contain native (compiled) code and their properties are accessible from all windows. So unlike normal JS objects, changing one of their properties will cause it to be immediately updated everywhere else in the code. It's an advantage of the way MM5 was programmed - It lets us do all our intensive database operations in multithreaded native code, freeing up the JavaScript thread to just handle UI.

If you open the Chromium dev tools (on a debug build, by right click > Inspect Element, and print out one of the shared objects to the console, you'll notice that it says "native code" instead of showing a JavaScript function declaration.
<syntaxhighlight>
> trackList.forEach
< ƒ forEach() { [native code] }
</syntaxhighlight>

==Read/Write Locks==
In order for these database operations to be multithreaded, we need to implement a concept called ''read locks'' and ''write locks''. Consider what could happen if one thread attempted to write while another thread attempted to read data. The thread attempting a read will have no guarantee that the data is intact. It could be read either before the new value is written or after, or it could be read at the exact moment while the data is being overwritten, which would produce garbage data.

How do we avoid that issue? We prevent reads and writes from happening at the same time. Before writing data, the thread will wait for all readers to finish, and then it writes. Conversely, before reading data, the thread will wait for a write to finish before starting.
Think of it like a stop light at a highway. Reads are like the highway with multiple lanes; Multiple read cars can pass at once, and while read cars are passing, write cars have to stop. Once the reads finish, the write car can pass through.

[https://www.mediamonkey.com/docs/api/classes/Native.SharedBase.html#locked SharedList.locked()] enters a read lock. If you need to access individual items of a list, and need to work with indices, use <code>locked()</code>.
<syntaxhighlight lang="javascript">
trackList.locked(function () {
// This code will execute as soon as a read lock has been acquired.
// There is NO GUARANTEE that it will execute immediately.
var firstTrack = trackList.getValue(0);
var lastTrack = trackList.getValue(trackList.count - 1);
});
</syntaxhighlight>

[https://www.mediamonkey.com/docs/api/classes/Native.SharedList.html#modifyAsync SharedList.modifyAsync()] enters a write lock. If you need to ''modify'' tracks in a list, use <code>modifyAsync()</code>. Note: You ''are'' allowed to read values in a write lock. It will simply prevent other threads from reading that list until you are done.
<syntaxhighlight lang="javascript">
trackList.modifyAsync(function () {
// This code will execute as soon as a write lock has been acquired.
// There is NO GUARANTEE that it will execute immediately.
var firstTrack = trackList.getValue(0);
firstTrack.custom1 = "Hello World";
});
</syntaxhighlight>

If you do not need to access list items with indices, use the more convenient [https://www.mediamonkey.com/docs/api/classes/Native.SharedList.html#forEach SharedList.forEach()] function. It will execute your callback for each item in the list, and it will automatically wait for a read lock.
<syntaxhighlight lang="javascript">
trackList.forEach(function (track) {
// This code will execute as soon as a write lock has been acquired.
// There is NO GUARANTEE that it will execute immediately.
console.log(track.title);
});
</syntaxhighlight>

Methods like [https://www.mediamonkey.com/docs/api/classes/SharedList.html#method_clear clear()] and [https://www.mediamonkey.com/docs/api/classes/Native.SharedList.html#selectRangeAsync selectRangeAsync()] automatically enter write locks, so you do not need to call <code>modifyAsync()</code>.

For performance reasons, please use asynchronous methods (with "Async" at the end of the method name) as much as possible, '''especially if you are processing a lot of data'''. Unlike the native objects, JavaScript only has one thread, so if you do a lot of processing, it will block the rest of the UI.

There is one exception to the above rule: If you need to retrieve all values of ''one particular property'' in a large list (For example: a list of all track titles), consider using the synchronous method [https://www.mediamonkey.com/docs/api/classes/Native.SharedList.html#getAllValues getAllValues()]. It is much faster than using forEach().
<syntaxhighlight lang="javascript">
var listOfTitles = trackList.getAllValues('title');
</syntaxhighlight>

''TL;DR:''
# SharedLists work differently from normal JavaScript arrays and objects.
# For most cases, you can use <code>forEach()</code> to get data from each item in the list.
# To modify contents of a list, use <code>modifyAsync()</code>.
# Don't do tons of calculations / operations in a synchronous function; Make your code as asynchronous as possible.

''More coming soon''

Getting Started (Addons)

2024-03-06T18:06:02Z

Ludek: /* MediaMonkey folder structure */

''For a tutorial on developing addons for MediaMonkey 4, see [[Scripting (MM4)]]

=Additional Links=
* The [https://www.mediamonkey.com/forum/viewtopic.php?f=27&t=81285 '''Developer Forum pinned post'''] provides a summary of the information provided here, plus a few additional notes.
* The [https://www.mediamonkey.com/docs/api/ '''API Reference'''] is a complete reference to all the functionality provided both by MM native code and JS libraries.
* [[Important Methods and Utilities (Addons)|'''Important Methods and Utilities''']] provides a list of some of the most notable functionality provided.
* '''[[Methods_Added_Post_5.0|Methods added Post 5.0]]''' provides a list of methods that have been added ''after'' version 5.0.0, which you must be mindful of when publishing an addon.
* '''[[Working_with_Native_Objects_&_Data|Working with Native Objects & Data]]''' covers the concepts of data sources and native objects.
* The [https://www.mediamonkey.com/forum/viewforum.php?f=27 '''MM5 Developer Forum'''] is where you can find and ask questions related to developing MM5 addons.
* The [https://www.mediamonkey.com/wiki/Skinning_Guide '''Skinning Guide'''] provides information on how to create skins.
* [[Controlling MM5 from External Applications|'''Controlling MM5 from External Applications''']] discusses the different methods of controlling MediaMonkey 5 from other applications.

=Introduction to Making Addons in MediaMonkey 5=

MediaMonkey 5 is a fully HTML-based desktop application which uses Chromium for rendering. This means that the entire UI is driven by a '''platform-independent''' HTML/CSS/JS stack, which is fully accessible to developers and skinners. JS in cooperation with native code drives the non-visual aspects, also fully controllable by developers. This gives unprecedented customization options to create beautiful skins, new or enhanced functionality and great addons in general.

Scripting in MediaMonkey 5 differs greatly from MediaMonkey 4 and below, because it has been designed from the ground-up. It is not difficult to learn, especially if you are familiar with web programming. If you are coming from writing MediaMonkey 4 addons, you will get adjusted in no time at all.

=Hello World example=

Here is a basic Hello World example for a MediaMonkey 5 addon.

Inside a new folder, create a file named info.json with the essential information about your addon.

<syntaxhighlight lang="javascript">
{
    "title": "My First Addon",
    "id": "myFirstAddon",
    "description": "Hello world!",
    "version": "1.0.0",
    "type": "general",
    "author": "Jane Doe"
}
</syntaxhighlight>

Next, create a file named mainwindow_add.js. This code will get added to the end of mainwindow.js, and it will run when MediaMonkey starts.

<syntaxhighlight lang="javascript">
// Execute when the window is ready
window.whenReady(() => {
    uitools.toastMessage.show('Hello world!', {
        disableUndo: true
    });
});
</syntaxhighlight>

Then, select your two files and package them into a zip. Make sure that they are in the root of your zip archive and not inside a subfolder. Rename it to myFirstAddon.mmip.

Inside MediaMonkey5, go to Tools > Addons, click Add, and select your addon. After it installs and you reload the window, you will get a popup "toast" message on the bottom of the screen.

=MMIP (MediaMonkey Installer Packages)=
The center of all MediaMonkey add-ons is the MMIP. There is nothing special about the file format itself; it is just a ZIP archive with a different filename. You can use any standard method to zip the files, and then just rename it to a .mmip file.

If you wish to automate the process of zipping the MMIP packages, you are in luck.
* There is a tool named pack-mmip which allows you to automatically package MMIPs from the command line. It is available here: https://github.com/JL102/pack-mmip
* If your code is on Github, you can use a pipeline to automatically package your addon whenever you commit changes: https://www.mediamonkey.com/forum/viewtopic.php?p=476534

==Folder Structure==

===Metadata (info.json)===
At the root of an MMIP, there must be a file named info.json. It includes all essential information about the addon. It cannot be in a subfolder.

Here is an example info.json:
<syntaxhighlight lang="javascript">
{
    "title": "My Addon Name",
    "id": "myFirstAddon",
    "description": "This is my first addon!",
    "version": "1.0.0",
    "minAppVersion": "5.0.0",
    "type": "general",
    "author": "Jane Doe",
    "icon": "icon.png"
}
</syntaxhighlight>

Here are the possible attributes info.json can contain:
{| class="wikitable" style="max-width: 800px;"
|-
! Attribute
! Required?
! Information
|-
| title
| '''yes'''
| This is the name of your addon that is visible to the user.
|-
| id
| '''yes'''
| This is the unique ID of your addon. It does not have to be identical to your title, but it is recommended that your addon's id be similar to its title for organizational purposes. The id can include the following characters: [a-zA-Z0-9 -_'()]. As of 5.0.3, this format will be enforced. We recommend sticking to an alphanumeric string without spaces.
|-
| description
| '''yes'''
| The description of your addon. Make sure your description is brief, yet conveys the meaning and usage of your addon to the user. You can create line breaks in the description with \n.
|-
| version
| '''yes'''
| The version number of your addon. It must be in the format %d.%d.%d, which is three period-separated numbers.
|-
| minAppVersion
| no*
| The minimum compatible version of MediaMonkey for your addon. Please consult [[Methods_Added_Post_5.0]] to view whether your addon is incompatible with older versions of MediaMonkey.
|-
| type
| no
| The category of your addon. The existing categories are: general, skin, layout, sync, metadata, and visualization; but you can create your own categories. If unspecified, the type defaults to general.
|-
| author
| no
| The name of the addon's author.
|-
| icon
| no
| The filename of your addon's icon image. The image file must be in the root of the MMIP.
|-
| config
| no
| The filename of your addon's configuration script. See Adding Configurable Settings for more info.
|-
| updateURL
| no
| Link to a custom URL to check for app updates, for addons that are self-hosted. See: [[#Self-hosted addons|Self-hosted addons]]
|-
| installScript
| no
| The filename of your addon's install script. The script will run once when the addon is being installed. </br>The variable <code>window.__currentAddonPath</code> will be set, pointing to the filesystem folder into which the addon has been installed.

|-
| uninstallScript
| no
| The filename of your addon's uninstall script. The script will run once when the addon is being uninstalled. </br>The variable <code>window.__currentAddonPath</code> will be set, pointing to the filesystem folder into which the addon has been installed.
|-
| files
| no
| This only applies to plugins (type: "plugin"). Contains an array of objects, listing plugin files to be added. "src" is the source file path relative to the root inside mmip and "tgt" is the target file path relative to the Plugins folder. It can only write under the Plugins folder.</br>Example:
<syntaxhighlight lang="js">
"files": [{
    "src": "pluginDLL.dll",
    "tgt": "pluginDLL.dll"
})
</syntaxhighlight>
|-
| showRestartPrompt
| no
| Default is "true". Tells MediaMonkey whether to prompt a user for a restart. </br> Possible values: "true", "false", "install", and "uninstall". </br> If "true", MM will prompt the user for a restart on both install and uninstall. </br> If "install", MM will only prompt on install. </br> If "uninstall", MM will only prompt on uninstall. </br> If "false", neither installing nor uninstalling will prompt a restart. </br> <u>Must be a string if provided. Boolean true/false is not supported.</u>
|}

<nowiki>*</nowiki> May be required in the future.

===License===
You can choose to include a license file in the root of your addon, named license.txt. If present, when the addon is being installed. the license agreement will be shown to the user, and they will be required to accept the terms before installing.

===Code===
All the HTML/CSS/JS code that handles MM functionality is stored in a tree structure. As a developer, you can add new files, replace existing, or even extend functionality of the existing files. This is achieved by replication of the folder structure in Addons. For example, if a file controls\checkbox.js is present in the Addon, it completely replaces the default MM functionality of a checkbox. Similarly, an _add suffix in a filename extends functionality of an existing file. E.g. dialogs\dlgAbout_add.js can contain code that adds new controls to the layout of the About dialog.

For information on how to load other files & scripts into your code, please see the sections on <code>requirejs</code> and <code>localRequirejs</code> here: [[Important_Methods_and_Utilities_(Addons)#requirejs]]

===init.js===
You can choose to include a script named init.js in the root of your addon. If present, the script will run at startup.

===MediaMonkey folder structure===

* '''Root''' - Contains mainly mminit.js, which has the basic MM JS routines, several other utility .js files, maincontent.html which contains the basic definition of the main window. Also important is viewHandlers.js, which defines the tree structure of MM and behaviour of the views.
** '''controls''' - Contains all the controls used in MM UI. This starts with very basic controls, like button.js or dropdown.js, and continues with more complex things like listview.js and goes all the way to the complex UI elements, like equalizer.js, player.js or autoPlaylistEditor.js.
** '''dialogs''' - All the dialogs reside here, e.g. dlgConvertFormat.html + dlgConvertFormat.js
*** '''dlgOptions''' - Panels for the Tools > Options menu reside here.
** '''helpers''' - Contains miscellaneous helper scripts that do not fit into the other categories. For example: butt services, tray icon menus, docking, etc.
** '''layouts''' - Subfolders contain individual layouts, i.e. something that can replace/modify the files in the default folder structure in order to achieve completely different layout of MM (e.g. "Touch mode" layout). Unlike skins, layouts are supposed to mainly modify dimensions, positions and types of UI elements, not their color, etc. See [[Layouts]] for more information.
** '''scripts''' - This contains all non-skin addons that are installed to MediaMonkey, including addons that are preinstalled. They are organized by id.
** '''skin''' - Contains basic skin definitions, mostly a set of LESS files (an extension to CSS). See http://lesscss.org for more information.
*** '''icon''' - Contains all the icons used by MM. They are in SVG format in order to scale nicely to any display resolution. As anything else, they can be easily replaced by any Addon (skin or script).
** '''skins''' - Subfolders contain individual skins, i.e. something that can replace/modify the files in the default folder structure in order to achieve completely different looks of MM. Unlike layouts, this is supposed to mainly modify colors, fonts, icons, etc. See [[Skinning_Guide]] for more information.

Filetypes that can be overridden:
* JS (e.g. controls/artistGrid.js
* HTML (e.g. (root)/player.html)
* LESS (e.g. skin/skin_complete.less)
* SVG (e.g. skin/icon/about.svg)
Filetypes that can be added to:
* JS (e.g. (root)/actions_add.js)
* LESS (e.g. skin/skin_base_add.less)
Filetypes that can be added new:
* JS (e.g. dialogs/dlgOptions/pnl_myAddon.js)
* HTML (e.g. dialogs/dlgOptions/pnl_myAddon.html)
* LESS (e.g. skin/skin_somethingnew.less)
* SVG (e.g. skin/icon/newIcon.svg)
* CSS (e.g. dialogs/dlgOptions/myExtraStylesheet.css) (Not recommended)

==Versioning==
The versioning of addons must be in the format of three period-separated numbers (for example 0.0.1, 1.2.34, etc.) We recommend using semantic versioning (see https://semver.org).

MediaMonkey has a built-in updater for addons. When the user clicks "Find Updates" in the addons screen, it will check online if there are any updates for addons that are installed. If any are found, the user clicks the download button that appears, then it will download and install the updated addon.

==Submitting an addon==
To submit an addon, you must first have an account on the MediaMonkey forum and be signed in.
# Go to https://www.mediamonkey.com/addons/ and click Submit Addon.
# Select the most appropriate sub-category under MediaMonkey 5 that describes your addon.
# Click Submit New Addon.
## Name: Make sure it is the same as your addon's title, so that it does not confuse users after installing.
## Description: This does not have to be the same as the description in info.json. You can be as descriptive as you like.
## Support Link, Author Link, and License Type are optional.
## Image is not required, but highly recommended. We recommend that it be a square image, and the same image as your addon's icon.
# Click next. On this page, you will add the first version of your addon.
## Either upload your MMIP file or specify an external download link.
## Compatibility: Specify the MediaMonkey versions on which you have confirmed your addon works.
## What's New is optional, but you can specify updates here in future versions.
# Click Save. Review your changes, make sure everything is accurate, then click Finish.
# Your addon will appear in red until it is approved by a moderator. When approved, it will appear on the main addons page.
To add a new version of your addon, simply click Add New Version and follow steps 4-5. Each additional version needs to be approved by a moderator.

==Adding to scripts==
To add code to the end of a certain script, create a JS file in its appropriate location, with _add at the end of its name.

For example, if you wish to make an addition to controls/navigationBar.js, make controls/navigationBar_add.js inside your MMIP. You can also entirely replace the file if you name it controls/navigationBar.js inside your MMIP.

==Self-hosted addons==
For addons hosted on external sites, please provide a field '''updateURL''' in info.json to allow MediaMonkey to check for updates to your addon. The server must reply with info on the most recent version of the addon, in either XML or JSON format. More fields can be returned, but will be ignored by current versions of MediaMonkey.

For a working example, see: https://www.happymonkeying.com/update.php?upd=300021
Please note that since the release of that addon, the MinVersionMajor - MaxVersionBuild fields have been replaced with MinAppVersion, as described below.

===XML===
# The sequence of '''VersionMajor''', '''VersionMinor''', and '''VersionRelease''' form the standard version string; in the below example, it would be 3.0.6. '''VersionBuild''' also must be included but can be blank.
# '''UpdateURL''' is the link to download the addon as an MMIP.
# '''MinAppVersion''' refers to the minimum supported version of MediaMonkey. It is optional but highly recommended to include.

Example:
<syntaxhighlight lang="xml">
<VersionMajor>3</VersionMajor>
<VersionMinor>0</VersionMinor>
<VersionRelease>6</VersionRelease>
<VersionBuild></VersionBuild>
<MinAppVersion>5.0.2</MinAppVersion>
<UpdateURL>http://myserver/myAddon.mmip</UpdateURL>
</syntaxhighlight>

===JSON===
In JSON, '''version''' is provided as a single string instead of the four separate VersionX fields.

Example (equivalent to the XML above):
<syntaxhighlight lang="js">
{
"version": "3.0.6",
"minAppVersion": "5.0.2",
"updateUrl":"http://myserver/myAddon.mmip"
}
</syntaxhighlight>

=Important tips=
* '''Minimize the amount of computation your addon does on startup.''' Most scripts in MM run as soon as the window loads, so make sure your addon does not take a long time doing synchronous calculations that can cause the window to take longer to load. Ways to help avoid this:
** Use '''window.whenReady()''' when possible. Using window.whenReady() will cause your callback to only fire when all scripts are loaded, the whole DOM is processed by our parser, and all controls are initialized.
** Use asynchronous code when possible (with either callbacks, Promises, or async/await). If you perform heavy calculations that are synchronous, then it will halt the UI. See https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Async_await for more information.
* '''Put your _add scripts into an anonymous function.''' To prevent potential issues of variables with the same name being used across different scripts, we recommend putting most/all of your logic into an anonymous function. You can do it with arrow notation or function notation.
** <code>(() => { /* Do stuff */ })();</code>
** <code>(function() { /* Do stuff */ })();</code>
* '''Enable Developer Mode.''' Under Help > About, you can enable Developer Mode. This will prevent crash logs from being automatically sent to MediaMonkey staff.
** Additionally, developer mode can be enabled in the code via <code>app.enabledDeveloperMode(true)</code> during testing. But '''do not''' keep it in your published extension.
* '''Use requestFrame and requestTimeout instead of requestAnimationFrame and setTimeout.''' The custom functions automatically check whether the window/control still exists, and do not call the callback when the window/control have already been destroyed, to prevent crashes.

* '''Do not spam console.log''' in your final addon that's distributed to users. While developing it, it is completely okay to use it as much as you want! However, the JavaScript console.log function is relatively computationally expensive, so if it spams logs, then it will degrade performance. If it just logs occasionally, for debugging purposes, it's okay. Just don't overdo it.

* To avoid breaking for...in loops, do not add functions to Array.prototype with the syntax <code>Array.prototype.func = function () {}</code>. Details here: https://www.ventismedia.com/mantis/view.php?id=18145

=Actions, Hotkeys & Menus=
The MediaMonkey interface is controlled largely by actions, which are defined inside actions.js. Most UI elements are tied to actions, and all hotkeys are defined by actions.

'''Note:''' Defining custom actions must be done in actions_add.js. Otherwise, MediaMonkey will not properly register the actions.

==Defining actions==
Actions are defined in the global actions object. Each action contains the following attributes:
{| class="wikitable" style="max-width: 800px;"
|-
! Attribute
! Type
! Required?
! Information
|-
| title
| function (string)
| '''yes'''
| Function that returns the (string) title of the action.
|-
| execute
| function
| '''yes'''
| Function that runs when the action is executed.
|-
| category
| function (string)
| no
| Function that returns the (string) name of the action's category. Categories are defined in the global actionCategories object. Default is general.
|-
| hotkeyAble
| boolean
| no
| Determines whether the action can be tied to a hotkey. Default is false.
|-
| icon
| string
| no
| Icon that shows in menus that contain the action. The icon ids are located in skin/(iconname).svg.
|-
| visible
| function (boolean)
| no
| Determines whether the action will show up in menus. This can be useful for integrating party mode, for example, by disabling your action when party mode is enabled with
<code>visible: window.uitools.getCanEdit</code>.
|}
Additionally, actions can contain any other custom attributes and methods.

Defining your own custom action in actions_add.js:
<syntaxhighlight lang="js">
actions.myCustomAction = {
    title: 'My Custom Action',
    hotkeyAble: true,
    execute: function () {
        messageDlg('This action was created by hotkeyAction script.', 'information', ['btnOK'], {
            defaultButton: 'btnOK'
        }, undefined);
    }
}
</syntaxhighlight>

==Assigning hotkeys to actions==
Assigning hotkeys is very simple. Hotkeys are handled by the global hotkeys object, and you can register a hotkey with the hotkeys.addHotkey method.

Usage:
<syntaxhighlight>hotkeys.addHotkey(hotkey, action, global);</syntaxhighlight>

{| class="wikitable" style="max-width: 800px;"
|-
! Attribute
! Type
! Required?
! Information
|-
| hotkey
| string
| '''yes'''
| The hotkey to assign. See Tools > Options > Hotkeys for the right syntax.
|-
| action
| string
| '''yes'''
| The action (in window.actions) to execute. Caps sensitive.
|-
| global
| boolean
| no
| Determines whether the hotkey is global (accessible outside the MM window). Default is false.
|}

Adding a hotkey to your custom action:
<syntaxhighlight lang="js">hotkeys.addHotkey('Ctrl+Shift+Q', 'myCustomAction');</syntaxhighlight>

The addHotkey method automatically handles duplicates and deletions. So if a user deletes the hotkey, you don't have to worry about it showing up again every time the window reloads; and they can manually re-add it.

To see the syntax that MediaMonkey uses for hotkeys, go to the Tools>Options>Hotkeys window and type in your desired hotkey.

==Adding actions to menus==
MediaMonkey uses a structure for menus that allows infinitely nested sub-menus. The data structure of a menu item is as follows:
<syntaxhighlight lang="js">
menuItem = {
action: {
title: String, // Required
execute: Function, // Usually required
icon: String,
visible: Boolean,
disabled: Boolean,
submenu: Array
},
order: Number, // Required
grouporder: Number // Required
}
</syntaxhighlight>
The <code>submenu</code> field, which is optional, contains an array of as many other menu items as desired. The <code>grouporder</code> field determines which group a menu item will belong to, and groups will be automatically sorted by the <code>order</code> field. Menu items defined in actions.js are intentionally given order and grouporder like 10, 20, 30, etc. to allow addons to insert menu items in between them as desired.

Note: These fields can ''either'' be the datatype as described above ''or'' a function which returns the requested data type. At runtime, the global method <code>resolveToValue</code> is called, which either returns the primitive type or calls the provided function. If you analyze the actions in actions.js, you'll see bits like <code>visible: window.uitools.getCanEdit</code>. This is an example of a function which resolves to a boolean.

There are two menu groups that you will most likely want to add items to: The main menu bar, and tracklist menus.

===Main menu bar===
The File, Edit, View, etc. menus are defined in <code>window._menuItems</code>, from actions.js. See actions.js or look in the devtools console to see all the possible submenus to which to add your action. '''You can only add to these menus inside actions_add.js.'''

For example, if you wish to add an action to the "Tools > Edit tags" submenu, that is under <code>window._menuItems.editTags</code>:
<syntaxhighlight lang="js">
window._menuItems.editTags.submenu.push({
action: actions.myNewAction,
order: 10,
grouporder: 10
});
</syntaxhighlight>

===Tracklist menus===
Tracklist menus, which may also be called media menus, are the ones that contain ''Play now'', ''Play next'', ''Properties'', etc. These are defined in <code>window.menus.tracklistMenuItems</code>, from controls/trackListView.js. '''You should only add to these menus inside controls/trackListView_add.js.'''

For example, if you wish to add an action below Cut, Copy, and Paste, but above Rename:

* First, look in the definition of menus.tracklistMenuItems that Cut/Copy/Paste/Rename are in group 40, Paste's order is 30, and Rename's order is 35.
* This item must go in the same group and have an order between 30 and 35.
<syntaxhighlight lang="js">
window.menus.tracklistMenuItems.push({
action: actions.myNewAction,
order: 31,
grouporder: 40
});
</syntaxhighlight>

==Categories==
''Coming soon''

=Storing Data=

==JSON==
When you wish to save data such as user preferences, the most effective method is to save values in persistent.json. The way you do this is through the app.setValue and app.getValue methods.
Both methods require two parameters.

If retrieving a value that is primitive, set the second parameter as undefined.
<syntaxhighlight lang="javascript">
app.setValue('myExtension_foo', 'bar');

var foo = app.getValue('myExtension_foo', undefined);
</syntaxhighlight>

When retrieving a value that is an object, you must provide the second parameter as an object. The function will take that object and populate each value if it exists, so you can easily manage default settings this way.
<syntaxhighlight lang="javascript">
// Saving settings
app.setValue('myExtension_settings', {
    option1: 0,
    option2: 'electric boogaloo'
});
// Getting settings with hardcoded defaults
var settings = app.getValue('myExtension_settings', {
    option1: 0,
    option2: 'default'
})
// Passing an empty object works too
var settings = app.getValue('myExtension_settings', {});
</syntaxhighlight>
This data is automatically saved in persistent.json, which is saved in the user's AppData folder or the Portable subfolder; for non-portable and portable installations, respectively. Persistent.json is only deleted if the user manually deletes it or removes a portable installation.
'''Important:''' Make sure the keys that you use are unique. Include the addon ID in the key, as demonstrated above, to ensure this.

==Database==
If you need to manage more data, you can use the database. In MM5, you can access the database through the app.db object. For more information, see: https://www.mediamonkey.com/webhelp/MM5Preview/classes/DB.html.

To execute queries that do not need return values, use app.db.executeQueryAsync:

<syntaxhighlight lang="javascript">
app.db.executeQueryAsync('CREATE TABLE IF NOT EXISTS myPlugin (_id INTEGER PRIMARY KEY, value TEXT UNIQUE NOT NULL)')
.then(() => {
app.db.executeQueryAsync('INSERT INTO myPlugin [. . .]');
})
.catch(err => {
    console.error(err)
});

To execute queries that need return values, use app.db.getQueryResultAsync:
app.db.getQueryResultAsync('SELECT * FROM Albums')
.then(result => {
    // do stuff
})
.catch(err => console.error(err));
</syntaxhighlight>

This method returns a QueryResults object, which is a linked list. See https://www.mediamonkey.com/webhelp/MM5Preview/classes/QueryResults.html.

==Adding Configurable Settings to your Addon==
There are two ways to add configurable options to an addon: via the "config" option in info.json, or modifying the options dialog.

===Addon Config===
The recommended way of adding configurable settings to an addon, if the settings are not directly related to an existing options panel, is to use the built-in addon configuration options. To do this, you must specify "config" in info.json:
<syntaxhighlight>"config": "config.js"</syntaxhighlight>

Inside your configuration js file, you must define a window.configInfo object, with two functions: load and save.

Load is executed during page load, and save is executed after "OK" is pressed. Both functions are passed two parameters: pnl and item.
* "pnl" (pnlDiv) is the HTML node of the panel
* "item" (addon) is an object that contains information about the addon, such as title, ext_id, description, version, installType, author, path, etc.

You can opt to add a config HTML as well, by giving it the same base name as your config JS. For example, if it is named config.js, create config.html; if it is named MediaMonkeyRocks.js, create MediaMonkeyRocks.html.

When a configuration script is provided for an addon, the panel will open once the addon is installed. Additionally, a button will appear in its listing to open the configuration panel.

Example usage:

config.html
<syntaxhighlight lang="html">
<div class="uiRows">
    <div>
        <div data-id="chbOption1" data-control-class="Checkbox" data-tip="Option 1 tooltip">Option 1</div>
    </div>
    <div>
        <div data-id="chbOption2" data-control-class="Checkbox" data-tip="Option 2 tooltip">Option 1</div>
    </div>
</div>
</syntaxhighlight>

config.js
<syntaxhighlight lang="js">
window.configInfo = {
    load: function (pnlDiv, addon) {
        // Load config with defaults
        this.config = app.getValue('myAddon_config', {
            option1: true,
            option2: false,
        });
        // Set checkboxes to the configuration settings
        var UI = getAllUIElements(pnlDiv);
        UI.chbOption1.controlClass.checked = this.config.option1;
        UI.chbOption2.controlClass.checked = this.config.option2;
    },
    save: function (pnlDiv, addon) {
        // Save settings according to the checkbox changes
        var UI = getAllUIElements(pnlDiv);
        this.config.option1 = UI.chbOption1.controlClass.checked;
        this.config.option2 = UI.chbOption2.controlClass.checked;
        app.setValue('myAddon_config', this.config);
    }
}
</syntaxhighlight>

===Options Dialog===
When modifying the options dialog, you can either add to / modify an existing panel or create your own panel.

====Adding to an existing panel====
Adding to an existing panel can be done with _add JS files. For more context, take a look at dialogs/dlgOptions.js.

For example, if you wish to add to the General Options panel:
# Create dialogs/dlgOptions/pnl_General_add.js
# Override the optionPanels.pnl_General.load and optionPanels.pnl_General.save functions to add your own code
# Use the divFromSimpleMenu function to automatically create styled checkboxes/radio buttons
# Use app.getValue and app.setValue to retrieve and save the user settings

<syntaxhighlight lang="javascript">
(() => {
    var options = [
        {
            title: 'Option 1', // The label that appears on the checkbox/radio button
            radiogroup: 'myAddon_RadioOptions', // Self-explanatory
            execute: function() {state.RadioOptions = 'option1'} // This function runs whenever the element is clicked
        },
        {
            title: 'Option 2',
            radiogroup: 'myAddon_RadioOptions',
            execute: function() {state.RadioOptions = 'option2'}
        },
        {
            title: 'My Checkbox',
            checkable: true, // Turns it into a checkbox
            execute: function() {state.Checkbox = this.checked;}
        },
    ]
    var state;

    optionPanels.pnl_General.override({
        load: function($super, sett, pnlDiv) {
            $super(sett, pnlDiv);
            console.log('yoyoyoyoyo')

            state = app.getValue('myAddon_settings', {
                RadioOptions: 'option1',
                Checkbox: false
            });
            // Update checkbox/radiobutton state from settings
            if (state.RadioOptions == 'option1') {options[0].checked = true; options[1].checked = false;}
            else {options[0].checked = false; options[1].checked = true}
            if (state.Checkbox == true) options[2].checked = true;
            // Create an HTML menu from the options
            divFromSimpleMenu(pnlDiv, options);
        },
        save: function($super, sett, pnlDiv) {
            $super(sett, pnlDiv);
            // Save settings
            app.setValue('myAddon_settings', state);
        }
    });
})();
</syntaxhighlight>

====Creating a new panel====
You can define your new panel inside dialogs/dlgOptions, and add it inside dialogs/dlgOptions_add.js.

''Coming soon''

=Plugins=
While most functionality can be reached in MediaMonkey 5 via addons using JS/HTML, it still supports the majority of the Winamp 2.0 API. Winamp plugin support for MediaMonkey 5 is the same as in MediaMonkey 4. See [[Winamp Plug-ins (MM4)]] for more details.

==Packaging a Plugin==
To create an MMIP installer for a plugin, you need to include the information about your plugin's file[s] into info.json:
<syntaxhighlight lang="json">
"type": "plugin",
"files": [{
"src": "pluginDLL.dll",
"tgt": "pluginDLL.dll"
}]
</syntaxhighlight>

It can contain more files. "src" is the source file path relative to the root inside mmip, and "tgt" is target file relative to the Plugins folder inside the MediaMonkey installation. It can write only under the Plugins folder.

If needed, you can also include an installScript and uninstallScript:
<syntaxhighlight lang="json">
"installScript": "install.js",
"uninstallScript": "uninstall.js"
</syntaxhighlight>
The install script will run during installation and uninstall script will run after uninstallation.

Both will run inside the main window, allowing full access to the UI. Additionally, the variable <code>window.__currentAddonPath</code> will be set, pointing to the filesystem folder into which the addon has been installed.

=Accessing the main window object from other windows=
Sometimes, you may need to run functions or access properties from the main window in the context of other windows. For example, performing live updates in an options panel. To do this, use the app.dialogs.getMainWindow() method.

If you have a property "x" in the main window, this is how to access it from another window:
<syntaxhighlight lang="js">app.dialogs.getMainWindow().getValue('x')</syntaxhighlight>
If you assign a property or method to "app", you will need to do this to get the version of it that is attached to the main window.
<syntaxhighlight lang="js">app.dialogs.getMainWindow().getValue('app').myObject.myMethod();</syntaxhighlight>

=UI Elements & Controls=

==Icons==
Instead of bitmaps, MediaMonkey uses [https://en.wikipedia.org/wiki/Scalable_Vector_Graphics SVGs] for its icons. They are stored in the <code>skin/icon</code> folder. This is because SVGs can be scaled to any size without appearing pixelated. See [[Skinning_Guide#Creating_Icons|Skinning Guide/Creating Icons]] for an introduction on how to create custom icons.

There are three ways to load icons: The <code>data-icon</code> HTML attribute; <code>loadIconFast()</code>; and <code>loadIcon()</code>.

===data-icon===
Whenever HTML is loaded and/or classes are initialized, any and all elements with the attribute "data-icon" will automatically load the SVG files associated with the icon name provided. For details on how it works, check window.initializeControls in mminit.js. See this example:
<syntaxhighlight lang="html">
<div data-control-class="toolbutton" data-icon="music"></div>
</syntaxhighlight>
This will create a ToolButton control with the icon from music.svg. Using the ToolButton control class is not required, but if you do not add any CSS to limit the size of the icon, it will appear very large.

===loadIconFast===
If you wish to load an icon programmatically, use <code>loadIconFast()</code>. For more details, see [https://www.mediamonkey.com/docs/api/classes/Window.html#method_loadIconFast loadIconFast].

===loadIcon===
Only use <code>loadIcon()</code> if you need to access the raw SVG code before adding it to the DOM. For more details, see [https://www.mediamonkey.com/docs/api/classes/Window.html#method_loadIcon loadIcon].

''More coming soon''

Skinning Guide

2024-03-06T17:58:45Z

Ludek: /* Folder structure */

MediaMonkey 5 offers unprecedented flexibility with its skins and layouts. Skins and layouts can range anywhere from changing colors and text size to overhauling the entire interface. This guide will walk you through the basics of how to create a new skin.

==Introduction to the Skinning Framework==
The structure of the MM5 user interface is controlled by HTML, and its styling (Colors, sizing, positioning, margins, padding, etc.) is controlled by CSS. The skinning framework uses a language extension called LESS. Skins are written in LESS, which is then compiled into CSS in runtime. It allows for cleaner and more modular styling, with extensive support for variables and combining classes. The full documentation is available at http://lesscss.org.

===Folder structure===
All of the LESS styling can be found under the skin folder. The "main" skin file is skin_complete.less, which imports all of the other LESS files. The skinning framework is split into multiple different files for organizational purposes.
* Skin_base controls general properties such as colors;
* Skin_layout controls structural properties such as sizing and structure;
* Skin_animations controls definitions for animations;
* Skin_menu controls pop-up menus (Context menus and header menus);
* Skin_tabs controls tabs in the header;
* Skin_mainwindow controls the general window;
as well as others which are self-explanatory by name.

Icons are held in the skin/icons subfolder. They must all be in SVG format. Icons are organized/named by filename,
(Tip: To more easily browse and preview the icons, check out tibold's "svgsee" program, which shows thumbnail previews of svg files: https://github.com/tibold/svg-explorer-extension/releases)

'''Note:''' When creating your own skin, use the '_add' suffix in the filename to not overwrite the base file. So instead of 'skin_base.less' use 'skin_base_add.less' and thus values/variables defined in 'skin_base_add.less' is just complement to the base 'skin_base_add.less'. See other skin examples (e.g. unzip /skins/MeterialDesign.zip) to see and understand the structure.

===Adding configurable settings to your skin===
As of 5.0.2, you do not have to write JavaScript code to add user-configurable settings to your skin. Simply add an item to your skin's info.json, titled '''skin_options''', containing an array of options. We will write detailed information on the supported controls & syntax soon, but you can get started by following the examples of Material Design and Monkey Groove. Additionally, the specifications are described here: https://www.ventismedia.com/mantis/view.php?id=18449

Make sure your JSON syntax is valid. We recommend using an IDE that supports syntax checking, such as Visual Studio Code (however, it is not necessary).

==Creating Icons==

For creating icons, we recommend a program like [https://inkscape.org Inkscape], a free and open-source vector graphics software. If you use a program like Adobe Illustrator, more work must be done after exporting to clean up the SVG and make it display properly in MediaMonkey.

For info on how to use icons in code, see [[Getting_Started_(Addons)#Icons|Getting Started (Addons)/Icons]].

===Creating a Document===
Click File > New to create a new document.
To resize your icon to 100x100:
# open Document Properties (Ctrl + Shift + D)
# Change ''Display Units'' to px
# Under ''Custom Size'', change Width and Height to 100 and Units to px.

===Creating Shapes and Text===
It is important to convert any prebuilt shapes and text into pure paths, to ensure that the SVGs display properly on all systems. To do this:
# Right click the shape or text
# Click on Path > Object to Path

===Colors===
It is important that icons display properly on all skins. Please do not include colors in your icons, so that the user gets a consistent experience for all icons. To do this:
# Select all objects in the document
# Open the Fill and Stroke menu (Ctrl + Shift + F)
# Under the Fill tab, ensure that "Unset paint" is selected (Usually looks like a question mark)
# Under the Stroke tab, ensure that "Unset paint" is selected (Usually looks like a question mark)

===SVG Export===
To export SVGs correctly, change the export settings:
# Go to Edit > Preferences
# Navigate to Input/Output > SVG output
# Ensure that:
## ''Use named colors'' is unchecked
## ''XML formatting > Inline attributes'' is checked

When saving:
# Click File > Save As...
# Instead of "Inkscape SVG", select "Plain SVG"

===After saving the icon===
After saving, only one extra thing must be done to make sure the icon displays properly.
# Open the SVG icon in a text editor.
# Close to the top, you will see <code><svg width="100" height="100" viewBox...</code>
# Change <code>width="100" height="100"</code> to <code>width="100%" height="100%"</code>. This will prevent the icon from being sized incorrectly.

''More coming soon''

Getting Started (Addons)

2023-08-16T12:58:07Z

Ludek: /* Adding actions to menus */

''For a tutorial on developing addons for MediaMonkey 4, see [[Scripting (MM4)]]

=Additional Links=
* The [https://www.mediamonkey.com/forum/viewtopic.php?f=27&t=81285 '''Developer Forum pinned post'''] provides a summary of the information provided here, plus a few additional notes.
* The [https://www.mediamonkey.com/docs/api/ '''API Reference'''] is a complete reference to all the functionality provided both by MM native code and JS libraries.
* [[Important Methods and Utilities (Addons)|'''Important Methods and Utilities''']] provides a list of some of the most notable functionality provided.
* '''[[Methods_Added_Post_5.0|Methods added Post 5.0]]''' provides a list of methods that have been added ''after'' version 5.0.0, which you must be mindful of when publishing an addon.
* '''[[Working_with_Native_Objects_&_Data|Working with Native Objects & Data]]''' covers the concepts of data sources and native objects.
* The [https://www.mediamonkey.com/forum/viewforum.php?f=27 '''MM5 Developer Forum'''] is where you can find and ask questions related to developing MM5 addons.
* The [https://www.mediamonkey.com/wiki/Skinning_Guide '''Skinning Guide'''] provides information on how to create skins.
* [[Controlling MM5 from External Applications|'''Controlling MM5 from External Applications''']] discusses the different methods of controlling MediaMonkey 5 from other applications.

=Introduction to Making Addons in MediaMonkey 5=

MediaMonkey 5 is a fully HTML-based desktop application which uses Chromium for rendering. This means that the entire UI is driven by a '''platform-independent''' HTML/CSS/JS stack, which is fully accessible to developers and skinners. JS in cooperation with native code drives the non-visual aspects, also fully controllable by developers. This gives unprecedented customization options to create beautiful skins, new or enhanced functionality and great addons in general.

Scripting in MediaMonkey 5 differs greatly from MediaMonkey 4 and below, because it has been designed from the ground-up. It is not difficult to learn, especially if you are familiar with web programming. If you are coming from writing MediaMonkey 4 addons, you will get adjusted in no time at all.

=Hello World example=

Here is a basic Hello World example for a MediaMonkey 5 addon.

Inside a new folder, create a file named info.json with the essential information about your addon.

<syntaxhighlight lang="javascript">
{
    "title": "My First Addon",
    "id": "myFirstAddon",
    "description": "Hello world!",
    "version": "1.0.0",
    "type": "general",
    "author": "Jane Doe"
}
</syntaxhighlight>

Next, create a file named mainwindow_add.js. This code will get added to the end of mainwindow.js, and it will run when MediaMonkey starts.

<syntaxhighlight lang="javascript">
// Execute when the window is ready
window.whenReady(() => {
    uitools.toastMessage.show('Hello world!', {
        disableUndo: true
    });
});
</syntaxhighlight>

Then, select your two files and package them into a zip. Make sure that they are in the root of your zip archive and not inside a subfolder. Rename it to myFirstAddon.mmip.

Inside MediaMonkey5, go to Tools > Addons, click Add, and select your addon. After it installs and you reload the window, you will get a popup "toast" message on the bottom of the screen.

=MMIP (MediaMonkey Installer Packages)=
The center of all MediaMonkey add-ons is the MMIP. There is nothing special about the file format itself; it is just a ZIP archive with a different filename. You can use any standard method to zip the files, and then just rename it to a .mmip file.

If you wish to automate the process of zipping the MMIP packages, you are in luck.
* There is a tool named pack-mmip which allows you to automatically package MMIPs from the command line. It is available here: https://github.com/JL102/pack-mmip
* If your code is on Github, you can use a pipeline to automatically package your addon whenever you commit changes: https://www.mediamonkey.com/forum/viewtopic.php?p=476534

==Folder Structure==

===Metadata (info.json)===
At the root of an MMIP, there must be a file named info.json. It includes all essential information about the addon. It cannot be in a subfolder.

Here is an example info.json:
<syntaxhighlight lang="javascript">
{
    "title": "My Addon Name",
    "id": "myFirstAddon",
    "description": "This is my first addon!",
    "version": "1.0.0",
    "minAppVersion": "5.0.0",
    "type": "general",
    "author": "Jane Doe",
    "icon": "icon.png"
}
</syntaxhighlight>

Here are the possible attributes info.json can contain:
{| class="wikitable" style="max-width: 800px;"
|-
! Attribute
! Required?
! Information
|-
| title
| '''yes'''
| This is the name of your addon that is visible to the user.
|-
| id
| '''yes'''
| This is the unique ID of your addon. It does not have to be identical to your title, but it is recommended that your addon's id be similar to its title for organizational purposes. The id can include the following characters: [a-zA-Z0-9 -_'()]. As of 5.0.3, this format will be enforced. We recommend sticking to an alphanumeric string without spaces.
|-
| description
| '''yes'''
| The description of your addon. Make sure your description is brief, yet conveys the meaning and usage of your addon to the user. You can create line breaks in the description with \n.
|-
| version
| '''yes'''
| The version number of your addon. It must be in the format %d.%d.%d, which is three period-separated numbers.
|-
| minAppVersion
| no*
| The minimum compatible version of MediaMonkey for your addon. Please consult [[Methods_Added_Post_5.0]] to view whether your addon is incompatible with older versions of MediaMonkey.
|-
| type
| no
| The category of your addon. The existing categories are: general, skin, layout, sync, metadata, and visualization; but you can create your own categories. If unspecified, the type defaults to general.
|-
| author
| no
| The name of the addon's author.
|-
| icon
| no
| The filename of your addon's icon image. The image file must be in the root of the MMIP.
|-
| config
| no
| The filename of your addon's configuration script. See Adding Configurable Settings for more info.
|-
| updateURL
| no
| Link to a custom URL to check for app updates, for addons that are self-hosted. See: [[#Self-hosted addons|Self-hosted addons]]
|-
| installScript
| no
| The filename of your addon's install script. The script will run once when the addon is being installed. </br>The variable <code>window.__currentAddonPath</code> will be set, pointing to the filesystem folder into which the addon has been installed.

|-
| uninstallScript
| no
| The filename of your addon's uninstall script. The script will run once when the addon is being uninstalled. </br>The variable <code>window.__currentAddonPath</code> will be set, pointing to the filesystem folder into which the addon has been installed.
|-
| files
| no
| This only applies to plugins (type: "plugin"). Contains an array of objects, listing plugin files to be added. "src" is the source file path relative to the root inside mmip and "tgt" is the target file path relative to the Plugins folder. It can only write under the Plugins folder.</br>Example:
<syntaxhighlight lang="js">
"files": [{
    "src": "pluginDLL.dll",
    "tgt": "pluginDLL.dll"
})
</syntaxhighlight>
|-
| showRestartPrompt
| no
| Default is "true". Tells MediaMonkey whether to prompt a user for a restart. </br> Possible values: "true", "false", "install", and "uninstall". </br> If "true", MM will prompt the user for a restart on both install and uninstall. </br> If "install", MM will only prompt on install. </br> If "uninstall", MM will only prompt on uninstall. </br> If "false", neither installing nor uninstalling will prompt a restart. </br> <u>Must be a string if provided. Boolean true/false is not supported.</u>
|}

<nowiki>*</nowiki> May be required in the future.

===License===
You can choose to include a license file in the root of your addon, named license.txt. If present, when the addon is being installed. the license agreement will be shown to the user, and they will be required to accept the terms before installing.

===Code===
All the HTML/CSS/JS code that handles MM functionality is stored in a tree structure. As a developer, you can add new files, replace existing, or even extend functionality of the existing files. This is achieved by replication of the folder structure in Addons. For example, if a file controls\checkbox.js is present in the Addon, it completely replaces the default MM functionality of a checkbox. Similarly, an _add suffix in a filename extends functionality of an existing file. E.g. dialogs\dlgAbout_add.js can contain code that adds new controls to the layout of the About dialog.

For information on how to load other files & scripts into your code, please see the sections on <code>requirejs</code> and <code>localRequirejs</code> here: [[Important_Methods_and_Utilities_(Addons)#requirejs]]

===init.js===
You can choose to include a script named init.js in the root of your addon. If present, the script will run at startup.

===MediaMonkey folder structure===

* '''Root''' - Contains mainly mminit.js, which has the basic MM JS routines, several other utility .js files, maincontent.html which contains the basic definition of the main window. Also important is viewHandlers.js, which defines the tree structure of MM and behaviour of the views.
** '''controls''' - Contains all the controls used in MM UI. This starts with very basic controls, like button.js or dropdown.js, and continues with more complex things like listview.js and goes all the way to the complex UI elements, like equalizer.js, player.js or autoPlaylistEditor.js.
** '''dialogs''' - All the dialogs reside here, e.g. dlgConvertFormat.html + dlgConvertFormat.js
*** '''dlgOptions''' - Panels for the Tools > Options menu reside here.
** '''helpers''' - Contains miscellaneous helper scripts that do not fit into the other categories. For example: butt services, tray icon menus, docking, etc.
** '''layouts''' - Subfolders contain individual layouts, i.e. something that can replace/modify the files in the default folder structure in order to achieve completely different layout of MM (e.g. "Touch mode" layout). Unlike skins, layouts are supposed to mainly modify dimensions, positions and types of UI elements, not their color, etc. See [[Layouts]] for more information.
** '''scripts''' - This contains all non-skin addons that are installed to MediaMonkey, including addons that are preinstalled. They are organized by id.
** '''skin''' - Contains basic skin definitions, mostly a set of LESS files (an extension to CSS). See http://lesscss.org for more information.
*** '''icon''' - Contains all the icons used by MM. They are in SVG format in order to scale nicely to any display resolution. As anything else, they can be easily replaced by any Addon (skin or script).
** '''skins''' - Subfolders contain individual skins, i.e. something that can replace/modify the files in the default folder structure in order to achieve completely different looks of MM. Unlike layouts, this is supposed to mainly modify colors, fonts, icons, etc. See [[Skinning]] for more information.

Filetypes that can be overridden:
* JS (e.g. controls/artistGrid.js
* HTML (e.g. (root)/player.html)
* LESS (e.g. skin/skin_complete.less)
* SVG (e.g. skin/icon/about.svg)
Filetypes that can be added to:
* JS (e.g. (root)/actions_add.js)
* LESS (e.g. skin/skin_base_add.less)
Filetypes that can be added new:
* JS (e.g. dialogs/dlgOptions/pnl_myAddon.js)
* HTML (e.g. dialogs/dlgOptions/pnl_myAddon.html)
* LESS (e.g. skin/skin_somethingnew.less)
* SVG (e.g. skin/icon/newIcon.svg)
* CSS (e.g. dialogs/dlgOptions/myExtraStylesheet.css) (Not recommended)

==Versioning==
The versioning of addons must be in the format of three period-separated numbers (for example 0.0.1, 1.2.34, etc.) We recommend using semantic versioning (see https://semver.org).

MediaMonkey has a built-in updater for addons. When the user clicks "Find Updates" in the addons screen, it will check online if there are any updates for addons that are installed. If any are found, the user clicks the download button that appears, then it will download and install the updated addon.

==Submitting an addon==
To submit an addon, you must first have an account on the MediaMonkey forum and be signed in.
# Go to https://www.mediamonkey.com/addons/ and click Submit Addon.
# Select the most appropriate sub-category under MediaMonkey 5 that describes your addon.
# Click Submit New Addon.
## Name: Make sure it is the same as your addon's title, so that it does not confuse users after installing.
## Description: This does not have to be the same as the description in info.json. You can be as descriptive as you like.
## Support Link, Author Link, and License Type are optional.
## Image is not required, but highly recommended. We recommend that it be a square image, and the same image as your addon's icon.
# Click next. On this page, you will add the first version of your addon.
## Either upload your MMIP file or specify an external download link.
## Compatibility: Specify the MediaMonkey versions on which you have confirmed your addon works.
## What's New is optional, but you can specify updates here in future versions.
# Click Save. Review your changes, make sure everything is accurate, then click Finish.
# Your addon will appear in red until it is approved by a moderator. When approved, it will appear on the main addons page.
To add a new version of your addon, simply click Add New Version and follow steps 4-5. Each additional version needs to be approved by a moderator.

==Adding to scripts==
To add code to the end of a certain script, create a JS file in its appropriate location, with _add at the end of its name.

For example, if you wish to make an addition to controls/navigationBar.js, make controls/navigationBar_add.js inside your MMIP. You can also entirely replace the file if you name it controls/navigationBar.js inside your MMIP.

==Self-hosted addons==
For addons hosted on external sites, please provide a field '''updateURL''' in info.json to allow MediaMonkey to check for updates to your addon. The server must reply with info on the most recent version of the addon, in either XML or JSON format. More fields can be returned, but will be ignored by current versions of MediaMonkey.

For a working example, see: https://www.happymonkeying.com/update.php?upd=300021
Please note that since the release of that addon, the MinVersionMajor - MaxVersionBuild fields have been replaced with MinAppVersion, as described below.

===XML===
# The sequence of '''VersionMajor''', '''VersionMinor''', and '''VersionRelease''' form the standard version string; in the below example, it would be 3.0.6. '''VersionBuild''' also must be included but can be blank.
# '''UpdateURL''' is the link to download the addon as an MMIP.
# '''MinAppVersion''' refers to the minimum supported version of MediaMonkey. It is optional but highly recommended to include.

Example:
<syntaxhighlight lang="xml">
<VersionMajor>3</VersionMajor>
<VersionMinor>0</VersionMinor>
<VersionRelease>6</VersionRelease>
<VersionBuild></VersionBuild>
<MinAppVersion>5.0.2</MinAppVersion>
<UpdateURL>http://myserver/myAddon.mmip</UpdateURL>
</syntaxhighlight>

===JSON===
In JSON, '''version''' is provided as a single string instead of the four separate VersionX fields.

Example (equivalent to the XML above):
<syntaxhighlight lang="js">
{
"version": "3.0.6",
"minAppVersion": "5.0.2",
"updateUrl":"http://myserver/myAddon.mmip"
}
</syntaxhighlight>

=Important tips=
* '''Minimize the amount of computation your addon does on startup.''' Most scripts in MM run as soon as the window loads, so make sure your addon does not take a long time doing synchronous calculations that can cause the window to take longer to load. Ways to help avoid this:
** Use '''window.whenReady()''' when possible. Using window.whenReady() will cause your callback to only fire when all scripts are loaded, the whole DOM is processed by our parser, and all controls are initialized.
** Use asynchronous code when possible (with either callbacks, Promises, or async/await). If you perform heavy calculations that are synchronous, then it will halt the UI. See https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Async_await for more information.
* '''Put your _add scripts into an anonymous function.''' To prevent potential issues of variables with the same name being used across different scripts, we recommend putting most/all of your logic into an anonymous function. You can do it with arrow notation or function notation.
** <code>(() => { /* Do stuff */ })();</code>
** <code>(function() { /* Do stuff */ })();</code>
* '''Enable Developer Mode.''' Under Help > About, you can enable Developer Mode. This will prevent crash logs from being automatically sent to MediaMonkey staff.
** Additionally, developer mode can be enabled in the code via <code>app.enabledDeveloperMode(true)</code> during testing. But '''do not''' keep it in your published extension.
* '''Use requestFrame and requestTimeout instead of requestAnimationFrame and setTimeout.''' The custom functions automatically check whether the window/control still exists, and do not call the callback when the window/control have already been destroyed, to prevent crashes.

* '''Do not spam console.log''' in your final addon that's distributed to users. While developing it, it is completely okay to use it as much as you want! However, the JavaScript console.log function is relatively computationally expensive, so if it spams logs, then it will degrade performance. If it just logs occasionally, for debugging purposes, it's okay. Just don't overdo it.

* To avoid breaking for...in loops, do not add functions to Array.prototype with the syntax <code>Array.prototype.func = function () {}</code>. Details here: https://www.ventismedia.com/mantis/view.php?id=18145

=Actions, Hotkeys & Menus=
The MediaMonkey interface is controlled largely by actions, which are defined inside actions.js. Most UI elements are tied to actions, and all hotkeys are defined by actions.

'''Note:''' Defining custom actions must be done in actions_add.js. Otherwise, MediaMonkey will not properly register the actions.

==Defining actions==
Actions are defined in the global actions object. Each action contains the following attributes:
{| class="wikitable" style="max-width: 800px;"
|-
! Attribute
! Type
! Required?
! Information
|-
| title
| function (string)
| '''yes'''
| Function that returns the (string) title of the action.
|-
| execute
| function
| '''yes'''
| Function that runs when the action is executed.
|-
| category
| function (string)
| no
| Function that returns the (string) name of the action's category. Categories are defined in the global actionCategories object. Default is general.
|-
| hotkeyAble
| boolean
| no
| Determines whether the action can be tied to a hotkey. Default is false.
|-
| icon
| string
| no
| Icon that shows in menus that contain the action. The icon ids are located in skin/(iconname).svg.
|-
| visible
| function (boolean)
| no
| Determines whether the action will show up in menus. This can be useful for integrating party mode, for example, by disabling your action when party mode is enabled with
<code>visible: window.uitools.getCanEdit</code>.
|}
Additionally, actions can contain any other custom attributes and methods.

Defining your own custom action in actions_add.js:
<syntaxhighlight lang="js">
actions.myCustomAction = {
    title: 'My Custom Action',
    hotkeyAble: true,
    execute: function () {
        messageDlg('This action was created by hotkeyAction script.', 'information', ['btnOK'], {
            defaultButton: 'btnOK'
        }, undefined);
    }
}
</syntaxhighlight>

==Assigning hotkeys to actions==
Assigning hotkeys is very simple. Hotkeys are handled by the global hotkeys object, and you can register a hotkey with the hotkeys.addHotkey method.

Usage:
<syntaxhighlight>hotkeys.addHotkey(hotkey, action, global);</syntaxhighlight>

{| class="wikitable" style="max-width: 800px;"
|-
! Attribute
! Type
! Required?
! Information
|-
| hotkey
| string
| '''yes'''
| The hotkey to assign. See Tools > Options > Hotkeys for the right syntax.
|-
| action
| string
| '''yes'''
| The action (in window.actions) to execute. Caps sensitive.
|-
| global
| boolean
| no
| Determines whether the hotkey is global (accessible outside the MM window). Default is false.
|}

Adding a hotkey to your custom action:
<syntaxhighlight lang="js">hotkeys.addHotkey('Ctrl+Shift+Q', 'myCustomAction');</syntaxhighlight>

The addHotkey method automatically handles duplicates and deletions. So if a user deletes the hotkey, you don't have to worry about it showing up again every time the window reloads; and they can manually re-add it.

To see the syntax that MediaMonkey uses for hotkeys, go to the Tools>Options>Hotkeys window and type in your desired hotkey.

==Adding actions to menus==
MediaMonkey uses a structure for menus that allows infinitely nested sub-menus. The data structure of a menu item is as follows:
<syntaxhighlight lang="js">
menuItem = {
action: {
title: String, // Required
execute: Function, // Usually required
icon: String,
visible: Boolean,
disabled: Boolean,
submenu: Array
},
order: Number, // Required
grouporder: Number // Required
}
</syntaxhighlight>
The <code>submenu</code> field, which is optional, contains an array of as many other menu items as desired. The <code>grouporder</code> field determines which group a menu item will belong to, and groups will be automatically sorted by the <code>order</code> field. Menu items defined in actions.js are intentionally given order and grouporder like 10, 20, 30, etc. to allow addons to insert menu items in between them as desired.

Note: These fields can ''either'' be the datatype as described above ''or'' a function which returns the requested data type. At runtime, the global method <code>resolveToValue</code> is called, which either returns the primitive type or calls the provided function. If you analyze the actions in actions.js, you'll see bits like <code>visible: window.uitools.getCanEdit</code>. This is an example of a function which resolves to a boolean.

There are two menu groups that you will most likely want to add items to: The main menu bar, and tracklist menus.

===Main menu bar===
The File, Edit, View, etc. menus are defined in <code>window._menuItems</code>, from actions.js. See actions.js or look in the devtools console to see all the possible submenus to which to add your action. '''You can only add to these menus inside actions_add.js.'''

For example, if you wish to add an action to the "Tools > Edit tags" submenu, that is under <code>window._menuItems.editTags</code>:
<syntaxhighlight lang="js">
window._menuItems.editTags.submenu.push({
action: actions.myNewAction,
order: 10,
grouporder: 10
});
</syntaxhighlight>

===Tracklist menus===
Tracklist menus, which may also be called media menus, are the ones that contain ''Play now'', ''Play next'', ''Properties'', etc. These are defined in <code>window.menus.tracklistMenuItems</code>, from controls/trackListView.js. '''You should only add to these menus inside controls/trackListView_add.js.'''

For example, if you wish to add an action below Cut, Copy, and Paste, but above Rename:

* First, look in the definition of menus.tracklistMenuItems that Cut/Copy/Paste/Rename are in group 40, Paste's order is 30, and Rename's order is 35.
* This item must go in the same group and have an order between 30 and 35.
<syntaxhighlight lang="js">
window.menus.tracklistMenuItems.push({
action: actions.myNewAction,
order: 31,
grouporder: 40
});
</syntaxhighlight>

==Categories==
''Coming soon''

=Storing Data=

==JSON==
When you wish to save data such as user preferences, the most effective method is to save values in persistent.json. The way you do this is through the app.setValue and app.getValue methods.
Both methods require two parameters.

If retrieving a value that is primitive, set the second parameter as undefined.
<syntaxhighlight lang="javascript">
app.setValue('myExtension_foo', 'bar');

var foo = app.getValue('myExtension_foo', undefined);
</syntaxhighlight>

When retrieving a value that is an object, you must provide the second parameter as an object. The function will take that object and populate each value if it exists, so you can easily manage default settings this way.
<syntaxhighlight lang="javascript">
// Saving settings
app.setValue('myExtension_settings', {
    option1: 0,
    option2: 'electric boogaloo'
});
// Getting settings with hardcoded defaults
var settings = app.getValue('myExtension_settings', {
    option1: 0,
    option2: 'default'
})
// Passing an empty object works too
var settings = app.getValue('myExtension_settings', {});
</syntaxhighlight>
This data is automatically saved in persistent.json, which is saved in the user's AppData folder or the Portable subfolder; for non-portable and portable installations, respectively. Persistent.json is only deleted if the user manually deletes it or removes a portable installation.
'''Important:''' Make sure the keys that you use are unique. Include the addon ID in the key, as demonstrated above, to ensure this.

==Database==
If you need to manage more data, you can use the database. In MM5, you can access the database through the app.db object. For more information, see: https://www.mediamonkey.com/webhelp/MM5Preview/classes/DB.html.

To execute queries that do not need return values, use app.db.executeQueryAsync:

<syntaxhighlight lang="javascript">
app.db.executeQueryAsync('CREATE TABLE IF NOT EXISTS myPlugin (_id INTEGER PRIMARY KEY, value TEXT UNIQUE NOT NULL)')
.then(() => {
app.db.executeQueryAsync('INSERT INTO myPlugin [. . .]');
})
.catch(err => {
    console.error(err)
});

To execute queries that need return values, use app.db.getQueryResultAsync:
app.db.getQueryResultAsync('SELECT * FROM Albums')
.then(result => {
    // do stuff
})
.catch(err => console.error(err));
</syntaxhighlight>

This method returns a QueryResults object, which is a linked list. See https://www.mediamonkey.com/webhelp/MM5Preview/classes/QueryResults.html.

==Adding Configurable Settings to your Addon==
There are two ways to add configurable options to an addon: via the "config" option in info.json, or modifying the options dialog.

===Addon Config===
The recommended way of adding configurable settings to an addon, if the settings are not directly related to an existing options panel, is to use the built-in addon configuration options. To do this, you must specify "config" in info.json:
<syntaxhighlight>"config": "config.js"</syntaxhighlight>

Inside your configuration js file, you must define a window.configInfo object, with two functions: load and save.

Load is executed during page load, and save is executed after "OK" is pressed. Both functions are passed two parameters: pnl and item.
* "pnl" (pnlDiv) is the HTML node of the panel
* "item" (addon) is an object that contains information about the addon, such as title, ext_id, description, version, installType, author, path, etc.

You can opt to add a config HTML as well, by giving it the same base name as your config JS. For example, if it is named config.js, create config.html; if it is named MediaMonkeyRocks.js, create MediaMonkeyRocks.html.

When a configuration script is provided for an addon, the panel will open once the addon is installed. Additionally, a button will appear in its listing to open the configuration panel.

Example usage:

config.html
<syntaxhighlight lang="html">
<div class="uiRows">
    <div>
        <div data-id="chbOption1" data-control-class="Checkbox" data-tip="Option 1 tooltip">Option 1</div>
    </div>
    <div>
        <div data-id="chbOption2" data-control-class="Checkbox" data-tip="Option 2 tooltip">Option 1</div>
    </div>
</div>
</syntaxhighlight>

config.js
<syntaxhighlight lang="js">
window.configInfo = {
    load: function (pnlDiv, addon) {
        // Load config with defaults
        this.config = app.getValue('myAddon_config', {
            option1: true,
            option2: false,
        });
        // Set checkboxes to the configuration settings
        var UI = getAllUIElements(pnlDiv);
        UI.chbOption1.controlClass.checked = this.config.option1;
        UI.chbOption2.controlClass.checked = this.config.option2;
    },
    save: function (pnlDiv, addon) {
        // Save settings according to the checkbox changes
        var UI = getAllUIElements(pnlDiv);
        this.config.option1 = UI.chbOption1.controlClass.checked;
        this.config.option2 = UI.chbOption2.controlClass.checked;
        app.setValue('myAddon_config', this.config);
    }
}
</syntaxhighlight>

===Options Dialog===
When modifying the options dialog, you can either add to / modify an existing panel or create your own panel.

====Adding to an existing panel====
Adding to an existing panel can be done with _add JS files. For more context, take a look at dialogs/dlgOptions.js.

For example, if you wish to add to the General Options panel:
# Create dialogs/dlgOptions/pnl_General_add.js
# Override the optionPanels.pnl_General.load and optionPanels.pnl_General.save functions to add your own code
# Use the divFromSimpleMenu function to automatically create styled checkboxes/radio buttons
# Use app.getValue and app.setValue to retrieve and save the user settings

<syntaxhighlight lang="javascript">
(() => {
    var options = [
        {
            title: 'Option 1', // The label that appears on the checkbox/radio button
            radiogroup: 'myAddon_RadioOptions', // Self-explanatory
            execute: function() {state.RadioOptions = 'option1'} // This function runs whenever the element is clicked
        },
        {
            title: 'Option 2',
            radiogroup: 'myAddon_RadioOptions',
            execute: function() {state.RadioOptions = 'option2'}
        },
        {
            title: 'My Checkbox',
            checkable: true, // Turns it into a checkbox
            execute: function() {state.Checkbox = this.checked;}
        },
    ]
    var state;

    optionPanels.pnl_General.override({
        load: function($super, sett, pnlDiv) {
            $super(sett, pnlDiv);
            console.log('yoyoyoyoyo')

            state = app.getValue('myAddon_settings', {
                RadioOptions: 'option1',
                Checkbox: false
            });
            // Update checkbox/radiobutton state from settings
            if (state.RadioOptions == 'option1') {options[0].checked = true; options[1].checked = false;}
            else {options[0].checked = false; options[1].checked = true}
            if (state.Checkbox == true) options[2].checked = true;
            // Create an HTML menu from the options
            divFromSimpleMenu(pnlDiv, options);
        },
        save: function($super, sett, pnlDiv) {
            $super(sett, pnlDiv);
            // Save settings
            app.setValue('myAddon_settings', state);
        }
    });
})();
</syntaxhighlight>

====Creating a new panel====
You can define your new panel inside dialogs/dlgOptions, and add it inside dialogs/dlgOptions_add.js.

''Coming soon''

=Plugins=
While most functionality can be reached in MediaMonkey 5 via addons using JS/HTML, it still supports the majority of the Winamp 2.0 API. Winamp plugin support for MediaMonkey 5 is the same as in MediaMonkey 4. See [[Winamp Plug-ins (MM4)]] for more details.

==Packaging a Plugin==
To create an MMIP installer for a plugin, you need to include the information about your plugin's file[s] into info.json:
<syntaxhighlight lang="json">
"type": "plugin",
"files": [{
"src": "pluginDLL.dll",
"tgt": "pluginDLL.dll"
}]
</syntaxhighlight>

It can contain more files. "src" is the source file path relative to the root inside mmip, and "tgt" is target file relative to the Plugins folder inside the MediaMonkey installation. It can write only under the Plugins folder.

If needed, you can also include an installScript and uninstallScript:
<syntaxhighlight lang="json">
"installScript": "install.js",
"uninstallScript": "uninstall.js"
</syntaxhighlight>
The install script will run during installation and uninstall script will run after uninstallation.

Both will run inside the main window, allowing full access to the UI. Additionally, the variable <code>window.__currentAddonPath</code> will be set, pointing to the filesystem folder into which the addon has been installed.

=Accessing the main window object from other windows=
Sometimes, you may need to run functions or access properties from the main window in the context of other windows. For example, performing live updates in an options panel. To do this, use the app.dialogs.getMainWindow() method.

If you have a property "x" in the main window, this is how to access it from another window:
<syntaxhighlight lang="js">app.dialogs.getMainWindow().getValue('x')</syntaxhighlight>
If you assign a property or method to "app", you will need to do this to get the version of it that is attached to the main window.
<syntaxhighlight lang="js">app.dialogs.getMainWindow().getValue('app').myObject.myMethod();</syntaxhighlight>

=UI Elements & Controls=

==Icons==
Instead of bitmaps, MediaMonkey uses [https://en.wikipedia.org/wiki/Scalable_Vector_Graphics SVGs] for its icons. They are stored in the <code>skin/icon</code> folder. This is because SVGs can be scaled to any size without appearing pixelated. See [[Skinning_Guide#Creating_Icons|Skinning Guide/Creating Icons]] for an introduction on how to create custom icons.

There are three ways to load icons: The <code>data-icon</code> HTML attribute; <code>loadIconFast()</code>; and <code>loadIcon()</code>.

===data-icon===
Whenever HTML is loaded and/or classes are initialized, any and all elements with the attribute "data-icon" will automatically load the SVG files associated with the icon name provided. For details on how it works, check window.initializeControls in mminit.js. See this example:
<syntaxhighlight lang="html">
<div data-control-class="toolbutton" data-icon="music"></div>
</syntaxhighlight>
This will create a ToolButton control with the icon from music.svg. Using the ToolButton control class is not required, but if you do not add any CSS to limit the size of the icon, it will appear very large.

===loadIconFast===
If you wish to load an icon programmatically, use <code>loadIconFast()</code>. For more details, see [https://www.mediamonkey.com/docs/api/classes/Window.html#method_loadIconFast loadIconFast].

===loadIcon===
Only use <code>loadIcon()</code> if you need to access the raw SVG code before adding it to the DOM. For more details, see [https://www.mediamonkey.com/docs/api/classes/Window.html#method_loadIcon loadIcon].

''More coming soon''

WebHelp:Cloud Services/5.0

2021-06-04T20:06:12Z

Ludek: /* Sync from MediaMonkey to Cloud Service */

[[Main Page|Wiki Home]] > [[{{WebHelp:Links|Content}}|MediaMonkey 5 Help]] > [[{{WebHelp:Links|Sharing Content and Data from your Library}}|Sharing Content and Data from your Library]] > Cloud Services

----

{{WebHelpHeader|Cloud Services}}

== Introduction ==

MediaMonkey can connect with several Cloud Service providers:
* '''Dropbox/Dropbox (app folder)''', whereas Dropbox gives access to all of your Dropbox, Dropbox (app folder) limits the access to to ''/Apps/MediaMonkey app/'' folder on Dropbox.
* '''Google Drive''', MediaMonkey can only access files on Google Drive uploaded by MediaMonkey.
* '''OneDrive'''

Under '''[[{{WebHelp:Links|My Computer}}#Devices_.26_Services|Devices & Services]]''' in the Media Tree use the '''+''' next to ''Storage and Services'' to add a Cloud Service connection to MediaMonkey. Using this will take you to the Cloud Service providers website where you need to log in to your account and set the permissions for MediaMonkey to access your cloud account.

The Cloud Service is designed to be used to work with media files uploaded by MediaMonkey. When MediaMonkey uploads media files it also updates a database of media file info on the Cloud Service. This will be missing if you connect MediaMonkey with a Cloud Service that had files uploaded through other means.

== Playback from a Cloud Service ==

MediaMonkey can play files from Cloud Services. Select any file through the ''Remote Content'' tab of the Service Profile under '''[[{{WebHelp:Links|My Computer}}#Devices_.26_Services|Devices & Services]]''' node in the Media Tree to [[{{WebHelp:Links|Playing_Audio_Tracks}}#Selecting_Files_to_Play|play]] the file.

== Sync from MediaMonkey to Cloud Service ==

'''It's recommended (required for Google Drive) to use MediaMonkey to upload files to the Cloud Service as MediaMonkey creates its own database with the media file's tags. This metadata will be missing if you upload files to the Cloud Service outside of MediaMonkey.''' You can select what content from the MediaMonkey Library and set how this content is synced to the Cloud Service:
* On the ''Library content'' tab of the Service Profile you can select what content from your MediaMonkey Library should be synced to the Cloud Service. The settings are the same as for Syncing to Devices as discussed here: [[{{WebHelp:Links|Exporting_Tracks}}#Sync_List_.28Library_--.3E_Device.29|Sync List (Library --> Device)]].
* On the ''Sync Profile'' tab of the Service Profile you can select how MediaMonkey syncs the selected content to the Cloud Service. The settings are the same as for Syncing to Devices as discussed here: [[{{WebHelp:Links|Exporting_Tracks}}#Sync_Profile|Sync Profile]].

== Sync from Cloud Service to MediaMonkey ==

There are 5 settings controlling how MediaMonkey syncs from a Cloud Service to MediaMonkey on the ''Remote Content'' tab of the Service Profile:
* ''Scan 'Cloud Service' content to the local database'' will add files stored on the Cloud Service to the MediaMonkey Library.
* ''Only include content that matches files already in the database'' will limit this to files from cloud service to files matched based on metadata with files on your PC in the MediaMonkey Library. If disabled the media file is added as remote file with a cloud only icon in the Source column.
* ''Download 'Cloud Service' content that is not accessible locally'' will download any files on the Cloud Service that aren't in the MediaMonkey Library the local device.
* ''Sync 'Cloud Service' metadata to Library''
* ''Sync schedule'' allows you to set when MediaMonkey will automatically Sync between the Cloud Service and MediaMonkey.

You can access files Synced from the Cloud Service to the MediaMonkey Library in the '''[[{{WebHelp:Links|Library}}|Collections]] > [[{{WebHelp:Links|Library}}#Location|Location]]''' node in the Media Tree.

== Related ==

* [[{{WebHelp:Links|Using Playlists}}|Playlists]]
* [[{{WebHelp:Links|Using AutoPlaylists}}|AutoPlaylists]]

{{WebHelpFooter}}

Sample AMG Search script

2018-01-19T09:29:14Z

Ludek:

==Attention==
'''Maybe this script should be changed to one using a website that allows this kind of action. ''AMG does not.'''''

----

This script demonstrates how to plug-in into MediaMonkey Web Search dialog. It searches AMG web a lets user tag some basic fields. Don't forget that it's rather a sample of what [[Search scripts]] can do than fully working script.

It currently searches AllMusic's website for the given album, presents user results found and lets tag these fields:
* Album
* Artist
* Track titles
* Album art
* Release year
* Genres
* Styles
* Moods
* Themes

There's a lot that could be improved, namely:
* Error handling - currently many possible problems aren't solved
* More fields could be tagged
* Results could be formatted using custom HTML page (not the downloaded one)
* Many others...

It's quite well documented, and so it can help in creation of your own Search scripts.

<source lang="vb">
' Sample AMG Search script
'
' This script demonstrates how to plug-in into MediaMonkey Web Search dialog. You should save it to Scripts folder as
' SearchAMG.vbs. It has to be in Scripts.ini file, where entries can be as follows:
'
' [SearchAMG]
' FileName=SearchAMG.vbs
' Order=10
' DisplayName=Search All Music Guide
' Language=VBScript
' ScriptType=3

Dim WB, WB2
Dim FoundLinks
Dim Tmr

' MediaMonkey calls this method whenever a search is started using this script
Sub StartSearch(Panel, SearchTerm, SearchArtist, SearchAlbum)
Set UI = SDB.UI

' This is a web browser that we use to present results to the user
Set WB = UI.NewActiveX(Panel, "Shell.Explorer")
WB.Common.Align = 5 ' Fill whole client rectangle
WB.Common.ControlName = "WB"

' This is a hidden browser that we use to find results (a better solution can be used, but this seems to be the easiest...)
Set WB2 = UI.NewActiveX(Panel, "Shell.Explorer")
WB2.Common.ControlName = "WB2"

WB.Common.BringToFront

' The following HTML is taken from AMG web pages - so that we don't have to load the search page and can post the query directly
' The following line will probably need some better way of retrieving server name from AMG. Using www.allmusicguide.com doesn't work at this moment.
html = "<form name=""search"" action=""http://wm08.allmusic.com/cg/amg.dll"" method=""post"">"
html = html & "<input type=""hidden"" name=""P"" value=""amg"" />"
html = html & "<p><input type=""text"" name=""sql"" id=""search_txt"" />"
html = html & "<input type=""image"" src=""/i/pages/wide/go.gif"" id=""search_button"" /></p>"
html = html & "<p><select name=""opt1"" id=""search_opt"">"
html = html & " <option value=""1"" selected=""selected"">Artist/Group</option>"
html = html & " <option value=""2"">Album</option>"
html = html & " <option value=""3"">Song</option>"
html = html & " <option value=""55"">Classical Work</option>"
html = html & "</select></p>"
html = html & "</form>"

Set WB2Intf = WB2.Interf
WB2Intf.Visible = false

WB2.SetHTMLDocument html

Set Doc2 = WB2Intf.Document
Set SrchTxt = Doc2.getElementById("search_txt")
If SearchAlbum <> "" Then
SrchTxt.Value = SearchAlbum
Else
SrchTxt.Value = SearchTerm
End If

Set SrchType = Doc2.getElementById("search_opt")
SrchType.selectedIndex = 1 ' Search for an album

Set SrchButton = Doc2.getElementById("search_button")
SrchButton.Click

Set Tmr = SDB.CreateTimer(40)
Script.RegisterEvent Tmr, "OnTimer", "ContinueSearch"
End Sub

' We use this procedure as a callback using Timer, so that we can present results as soon as they are downloaded
Sub ContinueSearch(Timer)
Script.UnregisterEvents Tmr
Set Tmr = Nothing

Set WB2Intf = WB2.Interf

If Len(WB2Intf.LocationURL) < 10 Then ' A trick - wait until navigation to the search results page starts
Set Tmr = SDB.CreateTimer(40)
Script.RegisterEvent Tmr, "OnTimer", "ContinueSearch"
Exit Sub
End If

If WB2Intf.ReadyState = 1 Or WB2Intf.Busy Then
Set Tmr = SDB.CreateTimer(40)
Script.RegisterEvent Tmr, "OnTimer", "ContinueSearch"
Exit Sub
End If

Set Doc2 = WB2Intf.Document

Set DivResults = Doc2.body

Set Results = SDB.NewStringList
Set FoundLinks = SDB.NewStringList
If IsObject(DivResults) And Not IsNull(DivResults) Then
Set AColl = DivResults.getElementsByTagName("A")
For Each itm In AColl
Set Imgs = itm.getElementsByTagName("img")
pos = InStr(CStr(itm.href), ".com/")
If pos > 0 Then
href = Mid(itm.href, pos)
If Left(href,Len(".com/cg/amg.dll?p=amg&sql=10:")) = ".com/cg/amg.dll?p=amg&sql=10:" And Imgs.length = 0 Then
Results.Add itm.innerText
FoundLinks.Add itm.href
End If
End If
Next

SDB.Tools.WebSearch.SetSearchResults Results
If Results.Count > 0 Then
SDB.Tools.WebSearch.ResultIndex = 0
End If
Else
WB.SetHTMLDocument = Doc2.documentElement.innerHTML
End If
End Sub

' This procedure is called by MediaMonkey when user selects some of search results
Sub ShowResult(ResultID)
If ResultID >= 0 And ResultID < FoundLinks.Count Then
SDB.Tools.WebSearch.ClearTracksData ' Tell MM to disregard any previously set tracks' data
WB.SetHTMLDocument "" ' To prevent usage of this data
WB.Interf.Navigate FoundLinks.Item(ResultID)

Set Tmr = SDB.CreateTimer(500)
Script.RegisterEvent Tmr, "OnTimer", "ResultFullyLoaded"
End If
End Sub

' This is a callback handled by a timer, so that we can respond as soon as album results are loaded
Sub ResultFullyLoaded(Timer)
Script.UnregisterEvents Tmr
Set Tmr = Nothing

Set Tracks = SDB.NewStringList

Set Doc = WB.Interf.Document

If IsObject(Doc) Then
' Get track titles
Set AColl = Doc.getElementsByTagName("A")
For Each itm In AColl
Set Imgs = itm.getElementsByTagName("img")
pos = InStr(CStr(itm.href), ".com/")
If pos > 0 Then
href = Mid(itm.href, pos)
If Left(href,Len(".com/cg/amg.dll?p=amg&sql=33:")) = ".com/cg/amg.dll?p=amg&sql=33:" And Imgs.length = 0 Then
Tracks.Add itm.innerText
End If
End If
If itm.className = "subtitle" Then
ArtistTitle = itm.innerText
End If
Next

' Get album title
Set SpanColl = Doc.getElementsByTagName("Span")
For Each itm in SpanColl
If itm.className = "title" Then
AlbumTitle = itm.innerText
End If
Next

' Get Album art URL
Set ImgColl = Doc.getElementsByTagName("Img")
For Each itm in ImgColl
If Left(itm.src,Len("http://image.allmusic.com/")) = "http://image.allmusic.com/" Then
SDB.Tools.WebSearch.AlbumArtURL = itm.src
End If
Next

' Get release year
Set SpanColl = Doc.getElementsByTagName("span")
For Each itm In SpanColl
pos = InStr(itm.innerText, "Release Date")
If pos > 0 Then
Set Parnt = itm.parentNode.parentNode.parentNode.parentNode
Set TDColl = Parnt.getElementsByTagName("td")
For Each itm2 In TDColl
If itm2.className = "sub-text" Then
ReleaseYear = Right(itm2.innerText, 4)
Exit For
End If
Next
Exit For
End If
Next

' Get genres/styles/moods/themes
ListCnt = 0
Set DivColl = Doc.getElementsByTagName("div")
For Each itm In DivColl
pos = InStr(itm.id, "left-sidebar-list")
If pos > 0 Then
Set AColl = itm.getElementsByTagName("a")
MyList = ""
For Each itm2 In AColl
If MyList <> "" Then MyList = MyList & ";"
MyList = MyList & itm2.innerText
Next
ListCnt = ListCnt + 1
Select Case ListCnt
Case 1
Genres = MyList
Case 2
Styles = MyList
Case 3
Moods = MyList
Case 4
Themes = MyList
End Select
End If
Next
End If

If Tracks.Count = 0 Then
' Nothing found yet, wait some more time
Set Tmr = SDB.CreateTimer(500)
Script.RegisterEvent Tmr, "OnTimer", "ResultFullyLoaded"
Else
' Some results were found, notify MediaMonkey
SDB.Tools.WebSearch.SmartUpdateTracks Tracks
For i = 0 To SDB.Tools.WebSearch.NewTracks.Count - 1
SDB.Tools.WebSearch.NewTracks.Item(i).ArtistName = ArtistTitle
SDB.Tools.WebSearch.NewTracks.Item(i).AlbumName = AlbumTitle
SDB.Tools.WebSearch.NewTracks.Item(i).Year = ReleaseYear
SDB.Tools.WebSearch.NewTracks.Item(i).Genre = Genres
SDB.Tools.WebSearch.NewTracks.Item(i).Custom1 = Styles
SDB.Tools.WebSearch.NewTracks.Item(i).Custom2 = Moods
SDB.Tools.WebSearch.NewTracks.Item(i).Custom3 = Themes
Next
SDB.Tools.WebSearch.RefreshViews ' Tell MM that we have made some changes
End If
End Sub

' This does the final clean up, so that our script doesn't leave any unwanted traces
Sub FinishSearch(Panel)
' Correctly terminate all the actions we have started
WB.Common.DestroyControl ' Destroy the external control
WB2.Common.DestroyControl ' " " " "
Set WB = Nothing ' Release global variable
Set WB2 = Nothing ' " " "
Set FoundLinks = Nothing ' " " "
If IsObject(Tmr) Then
Script.UnregisterEvents Tmr ' Unregister timer events
Set Tmr = Nothing ' Release global variable
End If
End Sub
</source>

Compatible Devices

2016-01-06T23:30:48Z

Ludek:

This is a list of devices with known compatibility (i.e. these devices have been tested by users) with the current version of MediaMonkey. If you know of additional devices with MediaMonkey compatibility, please add them to this list. Devices are listed by their manufacturer. Click on any device to find any specific settings that are necessary to sync with the device.

==Android devices==
:[[GenericMTP|Any Android device]] over USB/MTP with MediaMonkey 4.0.7
:[[Android device running Android 2.3+]] via [[Sync MediaMonkey with an Android device|Wi-Fi sync]] between MediaMonkey for Android and MediaMonkey for Windows 4.1

==Apple==
:[[iPhone|iOS 4.0 - 6]] as of MediaMonkey 4.0.7
:[[iPhone|iOS 7]] as of MediaMonkey 4.1
:[[iPhone|iOS 8]] as of MediaMonkey 4.1.5
:[[iPhone|iOS 9]] as of MediaMonkey 4.1.10
:[[iPod]] (including 5th Gen)
:[[iPod Classic]]
:[[iPod Video]]
:[[iPod Mini|iPod Mini]] (1st and 2nd Gen)
:[[iPod Nano]] (1st, 2nd, 3rd, 4th, 5th, 6th, and 7th Gen)*
:[[iPod Photo]]
:[[iPod Shuffle]] (1st, 2nd, 3rd and 4th Gen)
:[[iPod Touch]] (1st, 2nd, 3rd, 4th and 5th Gen)
:[[iPhone|iPhone]] (iPhone 2G, iPhone 3G, iPhone 3GS, iPhone 4, iPhone 4s, iPhone 5, iPhone 5c, iPhone 6)
:[[iPhone|iPad]] (1st, 2nd, 3rd Gen)
:[[iTunes|iTunes]] (iTunes 6 to 11.1)

Apple Device Sync Help: http://www.mediamonkey.com/wiki/index.php/WebHelp:iPod_Synchronization/4.0

Note: iPad 4th gen, iPad mini don't have confirmed support yet.

==Archos==
:[[GenericMTP|Archos 5]]
:[[GenericMTP|Archos 605 Wifi]]
:[[USBmass|Archos 604/504]]
:[[GenericMTP|Archos 7]]
:[[GenericMTP|Archos Gemini 200]]
:[[GenericMTP|Archos Gmini (all versions)]]

==Audiovox==
:[[GenericMTP|Audiovox SMP3-xxx]]

==Cowon==
:[[USBmass|iAudio X5]]
:[[USBmass|Cowon Q5W]]
:[[USBmass|Cowon iAudio 7]]
:[[USBmass|Cowon iAudio D2]]
:[[USBmass|Cowon S9]] Both MSC and MTP.

==Creative==
:[[MTPZen|Zen Micro (2.20.05 firmware)]]
:[[MTPZen|Zen Nano]]
:[[MTPZen|Zen Neeon]]
:[[MTPZen|Zen Sleek]]
:[[MTPZen|Zen Stone]]
:[[MTPZen|Zen Touch (with 'Plays for Sure' MTP firmware update)]]
:[[MTPZen|Zen Vision]]
:[[MTPZen|Zen Vision:M]]
:[[MTPZen|Zen xtra ('Plays for Sure' firmware update)]]

Compatible, with workaround:
:[[MTPZen|ZEN MX]] - see http://www.mediamonkey.com/forum/viewtopic.php?f=12&t=44192 http://www.mediamonkey.com/forum/viewtopic.php?f=12&t=44192

Compatible, with restriction:
:[[MTPZen|ZEN]] - see [http://www.mediamonkey.com/forum/viewtopic.php?f=6&t=39965 here]

==Dell==
:[[USBmass|Dell DJ (mostly works--need logs to debug playlist problem)]]

==Eiger labs==
:[[USBmass|MPMan MP-F57]]

==Finis==
:[[USBmass|Finis SwiMP3]]

==HTC==
:HTC Touch Diamond 2

==iRiver==
:[[GenericMTP|iRiver Clix 2nd Gen (MTP mode)]]
:iRiver H10
:iRiver H120/H320/H340
:iRiver ifp-8xx
:[[USBmass|iRiver iFP-9xx]]
:iRiver N-xx
:iRiver PMP-1xx
:iRiver PMC-120

==Motorola==
:[[Motorola RIZR Z3]]
:[[Motorola Q 9 Global]]

==Nokia==
:[[GenericMTP|Nokia 5310]]
:[[GenericMTP|Nokia N8]]

==Palm==
:[[Palm Pre]]

==Phillips==
:[[GenericMTP|Philips HDD6320]] (partial support--need logs to debug)

==Pioneer==
:INNO GEX-INNO2BK (same as Samsung Helix YX-M1Z)

==RCA==
:[[USBmass|Lyra 2780]]

==Samsung==
:[[GenericMTP|Samsung YP-XX]]
:[[GenericMTP|Samsung YP-XXX]]
:[[GenericMTP|Samsung Galaxy Nexus]]
:[[GenericMTP|Samsung Galaxy S2]]
:[[GenericMTP|Samsung Galaxy S3]]
:[[GenericMTP|Samsung Galaxy S4]]
:[[GenericMTP|Samsung Galaxy Note]]
:[[GenericMTP|Samsung Galaxy Note 3 (Android 5 lollipop)]]

==SanDisk==
:[[MTPSansa|Sansa eXXX]]
:[[MTPSansa|Sansa Fuze]]
:[[MTPSansa|Sansa M250]]
:[[MTPSansa|Sandisk Sansa]]
:[[MTPSansa|Sandisk Connect 4Gb]]
:[[MTPSansa|Sandisk Sansa Clip]]
:[[MTPSansa|Sandisk Sansa Clip Zip]]
:[[MTPSansa|Sandisk Clip Sport]]
:[[MTPSansa|Sandisk E250]]
:[[MTPSansa|Sandisk Cruzer Edge]]
:[[MTPSansa#SanDisk_64GB_Mobile_Ultra_MicroSDXC|SanDisk 64GB Mobile Ultra MicroSDXC]]

==Toshiba==
:[[GenericMTP|Toshiba Gigabeat (works but firmware bug limits synch speed)]]

==Trekstor==
:[[TrekstorVibez|Vibez]] (Set as either [[GenericMTP|MTP Device]] or as [[USBmass|MSC Device]])

==Sony==
:[[USBmass|Sony Ericsson W302]]
:[[USBmass|Sony Ericsson W600]]
:[[USBmass|Sony Ericsson W800i]]
:[[USBmass|Sony Ericsson W880i]]
:[[GenericMTP|Sony Walkman NWZ-A829]]
:[[GenericMTP|Sony Walkman NWZ-S638]]
:[[GenericMTP|Sony Walkman NWZ-E385]]

ISDBDevice::GetSyncProgress

2015-10-25T15:34:23Z

Ludek: /* Method description */

{{MethodDeclaration|SDBDevice|ISDBDevice|Property Get GetSyncProgress(DeviceHandle As Long)}}

===Parameters===

{{MethodParameters
|DeviceHandle |Long |Handle of the device}}

===Method description===

Gets progress of sync/copy task (value between 0 and 1).

{{Introduced|4.1.10}}

===Example===

<source lang="vb">
Option Explicit

Dim UI : Set UI = SDB.UI

Sub OnStartUp()
Dim mnuTest
Set mnuTest = SDB.UI.AddMenuItem(SDB.UI.Menu_Edit, 0, 0)
mnuTest.Caption = SDB.Localize("Get sync progress")
mnuTest.OnClickFunc = "SDBOnClick"
mnuTest.UseScript = Script.ScriptPath
End Sub

Sub SDBOnClick(Item)
Dim DeviceHandle : DeviceHandle = -1
Dim Devices : Set Devices = SDB.Device.ActiveDeviceList("VID_05AC&PID_129E")
Dim i : i = 0
For i = 0 To Devices.Count-1
If Devices.DeviceHandle(i) <> -1 Then
DeviceHandle = Devices.DeviceHandle(i)
End If
Next

MsgBox( SDB.Device.GetSyncProgress( DeviceHandle))
End Sub
</source>

To see how to handle copy result see example in CopyFile() method

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]
[[Category:Interface ISDBDevice|{{PAGENAME}}]]

ISDBDevice::GetSyncProgress

2015-10-25T15:33:54Z

Ludek: /* Method description */

{{MethodDeclaration|SDBDevice|ISDBDevice|Property Get GetSyncProgress(DeviceHandle As Long)}}

===Parameters===

{{MethodParameters
|DeviceHandle |Long |Handle of the device}}

===Method description===

Gets progress of sync/copy task (value between 0 and 1).

{{Introduced|4.1.1}}

===Example===

<source lang="vb">
Option Explicit

Dim UI : Set UI = SDB.UI

Sub OnStartUp()
Dim mnuTest
Set mnuTest = SDB.UI.AddMenuItem(SDB.UI.Menu_Edit, 0, 0)
mnuTest.Caption = SDB.Localize("Get sync progress")
mnuTest.OnClickFunc = "SDBOnClick"
mnuTest.UseScript = Script.ScriptPath
End Sub

Sub SDBOnClick(Item)
Dim DeviceHandle : DeviceHandle = -1
Dim Devices : Set Devices = SDB.Device.ActiveDeviceList("VID_05AC&PID_129E")
Dim i : i = 0
For i = 0 To Devices.Count-1
If Devices.DeviceHandle(i) <> -1 Then
DeviceHandle = Devices.DeviceHandle(i)
End If
Next

MsgBox( SDB.Device.GetSyncProgress( DeviceHandle))
End Sub
</source>

To see how to handle copy result see example in CopyFile() method

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]
[[Category:Interface ISDBDevice|{{PAGENAME}}]]

ISDBIniFile::Path

2014-06-30T16:35:24Z

Ludek: Created page with "{{MethodDeclaration|SDBIniFile|ISDBIniFile|Property Get Path As String}} ===Property description=== Gets full filename path of the MediaMonkey.ini conf. file [[Category:Script..."

{{MethodDeclaration|SDBIniFile|ISDBIniFile|Property Get Path As String}}

===Property description===

Gets full filename path of the MediaMonkey.ini conf. file

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBIniFile|{{PAGENAME}}]]
[[Category:Interface ISDBIniFile|{{PAGENAME}}]]

SDBIniFile

2014-06-30T16:33:21Z

Ludek: /* ISDBIniFile members */

{{AutomationObjectsList}}
== CoClass SDBIniFile ==

Object for working with inifiles.

=== ISDBIniFile members ===

{{MethodsList
|[[ISDBIniFile::BoolValue|BoolValue]] |Property Get/Let |
|[[ISDBIniFile::DeleteKey|DeleteKey]] |Method |
|[[ISDBIniFile::DeleteSection|DeleteSection]] |Method |
|[[ISDBIniFile::Flush|Flush]] |Method |
|[[ISDBIniFile::Apply|Apply]] |Method | From v4.0
|[[ISDBIniFile::IntValue|IntValue]] |Property Get/Let |
|[[ISDBIniFile::Keys|Keys]] |Property Get |
|[[ISDBIniFile::Sections|Sections]] |Property Get |
|[[ISDBIniFile::StringValue|StringValue]] |Property Get/Let |
|[[ISDBIniFile::ValueExists|ValueExists]] |Property Get |
|[[ISDBIniFile::Path|Path]] |Property Get | From v4.1.4
}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBIniFile|{{PAGENAME}}]]

ISDBDevice::HandledDeviceList

2014-03-31T17:54:34Z

Ludek:

{{MethodDeclaration|SDBDevice|ISDBDevice|Property Get HandledDeviceList As ISDBDeviceList}}

===Property description===

Returns list of devices connected to the computer as [[SDBDeviceList]]

But inlike ActiveDeviceList it returns only devices that are already handled by a device plugin and thus their DeviceHandle is always valid.

{{Introduced|4.1.1}}

===Example===

<source lang="vb">
Option Explicit

Dim UI : Set UI = SDB.UI

Sub OnStartUp()
Dim mnuTest
Set mnuTest = SDB.UI.AddMenuItem(SDB.UI.Menu_Edit, 0, 0)
mnuTest.Caption = SDB.Localize("Get devices")
mnuTest.OnClickFunc = "SDBOnClick"
mnuTest.UseScript = Script.ScriptPath
End Sub

Sub SDBOnClick(Item)

Dim list : Set list = SDB.Device.HandledDeviceList
If list.Count = 0 Then
Call SDB.MessageBox( "No connected device", mtError, Array(mbOk))
Exit Sub
End If

Dim txt
Dim i : i = 0
For i = 0 To list.Count-1
txt = SDB.Device.Caption( list.DeviceHandle(i))
Call SDB.MessageBox( txt, mtInformation, Array(mbOk))
Next

End Sub
</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]
[[Category:Interface ISDBDevice|{{PAGENAME}}]]

ISDBDevice::Caption

2014-03-31T17:49:31Z

Ludek: Created page with "{{MethodDeclaration|SDBDevice|ISDBDevice|Property Get Caption(DeviceHandle As Long)}} ===Parameters=== {{MethodParameters |DeviceHandle |Long |Handle of the device}} ===Meth..."

{{MethodDeclaration|SDBDevice|ISDBDevice|Property Get Caption(DeviceHandle As Long)}}

===Parameters===

{{MethodParameters
|DeviceHandle |Long |Handle of the device}}

===Method description===

Gets caption of the device as seen in the MediaMonkey interface

{{Introduced|4.1.1}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]
[[Category:Interface ISDBDevice|{{PAGENAME}}]]

SDBDevice

2014-03-31T17:48:17Z

Ludek:

{{AutomationObjectsList}}
== CoClass SDBDevice ==

Mainly for usage in device plug-ins for controling several aspects of portable device functionality.

=== ISDBDevice members ===

{{MethodsList
|[[ISDBDevice::ActiveDeviceList|ActiveDeviceList]] |Property Get |
|[[ISDBDevice::HandledDeviceList|HandledDeviceList]] |Property Get | From 4.1.1
|[[ISDBDevice::AddDeviceNode|AddDeviceNode]] |Method |
|[[ISDBDevice::canEjectDevice|canEjectDevice]] |Property Get |
|[[ISDBDevice::CreateDeviceNode|CreateDeviceNode]] |Method |
|[[ISDBDevice::DeviceEject|DeviceEject]] |Method |
|[[ISDBDevice::DeviceIcon|DeviceIcon]] |Property Get/Let |
|[[ISDBDevice::DeviceMenuIcon|DeviceMenuIcon]] |Property Get/Let |
|[[ISDBDevice::DeviceStart|DeviceStart]] |Method |
|[[ISDBDevice::DeviceStartEx|DeviceStartEx]] |Method |
|[[ISDBDevice::DeviceStop|DeviceStop]] |Method |
|[[ISDBDevice::DeviceThreadedEject|DeviceThreadedEject]] |Method |
|[[ISDBDevice::DriveLetterFree|DriveLetterFree]] |Property Get |
|[[ISDBDevice::FreeSpace|FreeSpace]] |Property Get |
|[[ISDBDevice::GetTrackIDSynchStatus|GetTrackIDSynchStatus]] |Method |
|[[ISDBDevice::GetTrackSynchStatus|GetTrackSynchStatus]] |Method |
|[[ISDBDevice::GetDeviceContent|GetDeviceContent]] |Method | From 4.1
|[[ISDBDevice::ChangeDeviceCaption|ChangeDeviceCaption]] |Method |
|[[ISDBDevice::ChangeDeviceID|ChangeDeviceID]] |Method |
|[[ISDBDevice::isPlaylistForSynch|isPlaylistForSynch]] |Property Get/Let |
|[[ISDBDevice::IsVisible|IsVisible]] |Property Get |
|[[ISDBDevice::LockPlugin|LockPlugin]] |Method |
|[[ISDBDevice::RegisterTreeNode|RegisterTreeNode]] |Method |
|[[ISDBDevice::ShowDeviceConfig|ShowDeviceConfig]] |Method |
|[[ISDBDevice::StartSynch|StartSynch]] |Method |
|[[ISDBDevice::StartAutoSynch|StartAutoSynch]] |Method | From 4.1
|[[ISDBDevice::SynchTerminating|SynchTerminating]] |Property Get |
|[[ISDBDevice::TotalSpace|TotalSpace]] |Property Get |
|[[ISDBDevice::UnlockPlugin|UnlockPlugin]] |Method |
|[[ISDBDevice::TerminateThreads|TerminateThreads]] |Method | From 4.0
|[[ISDBDevice::GetDeviceProfileXML|GetDeviceProfileXML]] |Property Get| From 4.0.3
|[[ISDBDevice::CopyFile|CopyFile]] |Property Get| From 4.1.1
|[[ISDBDevice::CopyFiles|CopyFiles]] |Property Get| From 4.1.1
|[[ISDBDevice::DeleteFiles|DeleteFiles]] |Property Get| From 4.1.1
|[[ISDBDevice::GetSyncProgress|GetSyncProgress]] |Property Get| From 4.1.1
|[[ISDBDevice::Caption|Caption]] |Property Get| From 4.1.1
}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]

ISDBDevice::HandledDeviceList

2014-03-31T17:46:32Z

Ludek:

{{MethodDeclaration|SDBDevice|ISDBDevice|Property Get HandledDeviceList As ISDBDeviceList}}

===Property description===

Returns list of devices connected to the computer as [[SDBDeviceList]]

But inlike ActiveDeviceList it returns only devices that are already handled by a device plugin and thus their DeviceHandle is always valid.

{{Introduced|4.1.1}}

===Example===

<source lang="vb">
Option Explicit

Dim UI : Set UI = SDB.UI

Sub OnStartUp()
Dim mnuTest
Set mnuTest = SDB.UI.AddMenuItem(SDB.UI.Menu_Edit, 0, 0)
mnuTest.Caption = SDB.Localize("Get devices")
mnuTest.OnClickFunc = "SDBOnClick"
mnuTest.UseScript = Script.ScriptPath
End Sub

Sub SDBOnClick(Item)

Dim list : Set list = SDB.Device.HandledDeviceList
If list.Count = 0 Then
Call SDB.MessageBox( "No connected device", mtError, Array(mbOk))
Exit Sub
End If

Dim txt
Dim i : i = 0
For i = 0 To list.Count-1
txt = SDB.Device.Caption( list.DeviceHandle(i))
Call SDB.MessageBox( txt, mtInformation, Array(mbOk))
Exit Sub
Next

End Sub
</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]
[[Category:Interface ISDBDevice|{{PAGENAME}}]]

ISDBDevice::HandledDeviceList

2014-03-31T17:45:29Z

Ludek: Created page with "{{MethodDeclaration|SDBDevice|ISDBDevice|Property Get HandledDeviceList As ISDBDeviceList}} ===Property description=== Returns list of devices connected to the computer as [[S..."

{{MethodDeclaration|SDBDevice|ISDBDevice|Property Get HandledDeviceList As ISDBDeviceList}}

===Property description===

Returns list of devices connected to the computer as [[SDBDeviceList]]

But inlike ActiveDeviceList it returns only devices that are already handled by a device plugin and thus their DeviceHandle is always valid.

===Example===

<source lang="vb">
Option Explicit

Dim UI : Set UI = SDB.UI

Sub OnStartUp()
Dim mnuTest
Set mnuTest = SDB.UI.AddMenuItem(SDB.UI.Menu_Edit, 0, 0)
mnuTest.Caption = SDB.Localize("Get devices")
mnuTest.OnClickFunc = "SDBOnClick"
mnuTest.UseScript = Script.ScriptPath
End Sub

Sub SDBOnClick(Item)

Dim list : Set list = SDB.Device.HandledDeviceList
If list.Count = 0 Then
Call SDB.MessageBox( "No connected device", mtError, Array(mbOk))
Exit Sub
End If

Dim txt
Dim i : i = 0
For i = 0 To list.Count-1
txt = SDB.Device.Caption( list.DeviceHandle(i))
Call SDB.MessageBox( txt, mtInformation, Array(mbOk))
Exit Sub
Next

End Sub
</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]
[[Category:Interface ISDBDevice|{{PAGENAME}}]]

SDBDevice

2014-03-31T17:41:14Z

Ludek:

{{AutomationObjectsList}}
== CoClass SDBDevice ==

Mainly for usage in device plug-ins for controling several aspects of portable device functionality.

=== ISDBDevice members ===

{{MethodsList
|[[ISDBDevice::ActiveDeviceList|ActiveDeviceList]] |Property Get |
|[[ISDBDevice::HandledDeviceList|HandledDeviceList]] |Property Get | From 4.1.1
|[[ISDBDevice::AddDeviceNode|AddDeviceNode]] |Method |
|[[ISDBDevice::canEjectDevice|canEjectDevice]] |Property Get |
|[[ISDBDevice::CreateDeviceNode|CreateDeviceNode]] |Method |
|[[ISDBDevice::DeviceEject|DeviceEject]] |Method |
|[[ISDBDevice::DeviceIcon|DeviceIcon]] |Property Get/Let |
|[[ISDBDevice::DeviceMenuIcon|DeviceMenuIcon]] |Property Get/Let |
|[[ISDBDevice::DeviceStart|DeviceStart]] |Method |
|[[ISDBDevice::DeviceStartEx|DeviceStartEx]] |Method |
|[[ISDBDevice::DeviceStop|DeviceStop]] |Method |
|[[ISDBDevice::DeviceThreadedEject|DeviceThreadedEject]] |Method |
|[[ISDBDevice::DriveLetterFree|DriveLetterFree]] |Property Get |
|[[ISDBDevice::FreeSpace|FreeSpace]] |Property Get |
|[[ISDBDevice::GetTrackIDSynchStatus|GetTrackIDSynchStatus]] |Method |
|[[ISDBDevice::GetTrackSynchStatus|GetTrackSynchStatus]] |Method |
|[[ISDBDevice::GetDeviceContent|GetDeviceContent]] |Method | From 4.1
|[[ISDBDevice::ChangeDeviceCaption|ChangeDeviceCaption]] |Method |
|[[ISDBDevice::ChangeDeviceID|ChangeDeviceID]] |Method |
|[[ISDBDevice::isPlaylistForSynch|isPlaylistForSynch]] |Property Get/Let |
|[[ISDBDevice::IsVisible|IsVisible]] |Property Get |
|[[ISDBDevice::LockPlugin|LockPlugin]] |Method |
|[[ISDBDevice::RegisterTreeNode|RegisterTreeNode]] |Method |
|[[ISDBDevice::ShowDeviceConfig|ShowDeviceConfig]] |Method |
|[[ISDBDevice::StartSynch|StartSynch]] |Method |
|[[ISDBDevice::StartAutoSynch|StartAutoSynch]] |Method | From 4.1
|[[ISDBDevice::SynchTerminating|SynchTerminating]] |Property Get |
|[[ISDBDevice::TotalSpace|TotalSpace]] |Property Get |
|[[ISDBDevice::UnlockPlugin|UnlockPlugin]] |Method |
|[[ISDBDevice::TerminateThreads|TerminateThreads]] |Method | From 4.0
|[[ISDBDevice::GetDeviceProfileXML|GetDeviceProfileXML]] |Property Get| From 4.0.3
|[[ISDBDevice::CopyFile|CopyFile]] |Property Get| From 4.1.1
|[[ISDBDevice::CopyFiles|CopyFiles]] |Property Get| From 4.1.1
|[[ISDBDevice::DeleteFiles|DeleteFiles]] |Property Get| From 4.1.1
|[[ISDBDevice::GetSyncProgress|GetSyncProgress]] |Property Get| From 4.1.1
}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]

ISDBDevice::CopyFile

2014-03-31T12:56:37Z

Ludek:

{{MethodDeclaration|SDBDevice|ISDBDevice|Sub CopyFile(DeviceHandle As Long, Source As String, Destination as String)}}

===Parameters===

{{MethodParameters
|DeviceHandle |Long |Handle of the device
|Source| String | Source file path on PC
|Destination| String | Destination file path on the device}}

===Method description===

Copies file to device.

{{Introduced|4.1.1}}

===Example===

<source lang="vb">
Option Explicit

Dim UI : Set UI = SDB.UI

Sub OnStartUp()
Dim mnuTest
Set mnuTest = SDB.UI.AddMenuItem(SDB.UI.Menu_Edit, 0, 0)
mnuTest.Caption = SDB.Localize("Copy file to iPhone")
mnuTest.OnClickFunc = "SDBOnClick"
mnuTest.UseScript = Script.ScriptPath
Script.RegisterEvent SDB, "OnDeviceFileCopied", "SDBDeviceFileCopied"
End Sub

Dim DeviceHandle : DeviceHandle = -1

Sub SDBOnClick(Item)
Dim Devices : Set Devices = SDB.Device.ActiveDeviceList("VID_05AC&PID_129E")
Dim i : i = 0
For i = 0 To Devices.Count-1
If Devices.DeviceHandle(i) <> -1 Then
DeviceHandle = Devices.DeviceHandle(i)
End If
Next

SDB.Device.CopyFile DeviceHandle, "C:\Temp\MyFile.wmv", "/Temp/MyFile.wmv"
End Sub

Sub SDBDeviceFileCopied( DeviceHandle, Src, Dest, Success)
if Success then
MsgBox("File copied successfuly from "&Src&" to "&Dest)
else
MsgBox("File failed to copy from "&Src&" to "&Dest)
end if
End Sub
</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]
[[Category:Interface ISDBDevice|{{PAGENAME}}]]

ISDBDevice::CopyFiles

2014-03-31T12:55:55Z

Ludek:

{{MethodDeclaration|SDBDevice|ISDBDevice|Sub CopyFiles(DeviceHandle As Long, Sources As [[SDBStringList]], Destinations as [[SDBStringList]])}}

===Parameters===

{{MethodParameters
|DeviceHandle |Long |Handle of the device
|Sources| String | Source file paths on PC
|Destinations| String | Destination file paths on the device}}

===Method description===

Copies file to device.

{{Introduced|4.1.1}}

===Example===

<source lang="vb">
Dim Sources
Set Sources= SDB.NewStringList
Sources.Add "C:\Temp\MyFile.wmv"
Sources.Add "C:\Temp\MyFile2.wmv"
Dim Destinations
Set Destinations= SDB.NewStringList
Destinations.Add "/Temp/MyFile.wmv"
Destinations.Add "/Temp/MyFile2.wmv"
SDB.Device.CopyFiles DeviceHandle, Sources, Destinations
</source>

To see how to handle copy result see example in CopyFile() method

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]
[[Category:Interface ISDBDevice|{{PAGENAME}}]]

ISDBDevice::GetSyncProgress

2014-03-31T12:55:26Z

Ludek:

{{MethodDeclaration|SDBDevice|ISDBDevice|Property Get GetSyncProgress(DeviceHandle As Long)}}

===Parameters===

{{MethodParameters
|DeviceHandle |Long |Handle of the device}}

===Method description===

Gets progress percentage of sync/copy task.

{{Introduced|4.1.1}}

===Example===

<source lang="vb">
Option Explicit

Dim UI : Set UI = SDB.UI

Sub OnStartUp()
Dim mnuTest
Set mnuTest = SDB.UI.AddMenuItem(SDB.UI.Menu_Edit, 0, 0)
mnuTest.Caption = SDB.Localize("Get sync progress")
mnuTest.OnClickFunc = "SDBOnClick"
mnuTest.UseScript = Script.ScriptPath
End Sub

Sub SDBOnClick(Item)
Dim DeviceHandle : DeviceHandle = -1
Dim Devices : Set Devices = SDB.Device.ActiveDeviceList("VID_05AC&PID_129E")
Dim i : i = 0
For i = 0 To Devices.Count-1
If Devices.DeviceHandle(i) <> -1 Then
DeviceHandle = Devices.DeviceHandle(i)
End If
Next

MsgBox( SDB.Device.GetSyncProgress( DeviceHandle))
End Sub
</source>

To see how to handle copy result see example in CopyFile() method

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]
[[Category:Interface ISDBDevice|{{PAGENAME}}]]

ISDBDevice::DeleteFiles

2014-03-31T12:55:04Z

Ludek:

{{MethodDeclaration|SDBDevice|ISDBDevice|Sub CopyFiles(DeviceHandle As Long, Files As [[SDBStringList]])}}

===Parameters===

{{MethodParameters
|DeviceHandle |Long |Handle of the device
|Files| String | Destination file paths on the device}}

===Method description===

Deletes file(s) from device.

{{Introduced|4.1.1}}

===Example===

<source lang="vb">
Dim Files
Set Files = SDB.NewStringList
Files.Add "/Temp/MyFile.wmv"
SDB.Device.DeleteFiles DeviceHandle, Files
</source>

To see how to handle copy result see example in CopyFile() method

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]
[[Category:Interface ISDBDevice|{{PAGENAME}}]]

ISDBApplicationEvents::OnDeviceFileCopied

2014-03-31T12:54:26Z

Ludek: /* Example code */

{{MethodDeclaration|SDBApplication|ISDBApplicationEvents|Sub OnDeviceFileCopied(Source as String, Destination as String, Success as Boolean)}}

===Parameters===

{{MethodParameters
|Source |String | Source path on PC
|Destination |String | Path on device
|Success |Boolean | Copy was successful (true), failed (false) }}

===Event description===

Is called whenever a file copy to device finishes.

{{Introduced|4.1.1}}

===Example code===
<source lang="vb">

Option Explicit

Dim UI : Set UI = SDB.UI

Sub OnStartUp()
Dim mnuTest
Set mnuTest = SDB.UI.AddMenuItem(SDB.UI.Menu_Edit, 0, 0)
mnuTest.Caption = SDB.Localize("Copy file to iPhone")
mnuTest.OnClickFunc = "SDBOnClick"
mnuTest.UseScript = Script.ScriptPath
Script.RegisterEvent SDB, "OnDeviceFileCopied", "SDBDeviceFileCopied"
End Sub

Dim DeviceHandle : DeviceHandle = -1

Sub SDBOnClick(Item)
Dim Devices : Set Devices = SDB.Device.ActiveDeviceList("VID_05AC&PID_129E")
Dim i : i = 0
For i = 0 To Devices.Count-1
If Devices.DeviceHandle(i) <> -1 Then
DeviceHandle = Devices.DeviceHandle(i)
End If
Next

SDB.Device.CopyFile DeviceHandle, "C:\Temp\MyFile.wmv", "/Temp/MyFile.wmv"
End Sub

Sub SDBDeviceFileCopied( DeviceHandle, Src, Dest, Success)
if Success then
MsgBox("File copied successfuly from "&Src&" to "&Dest)
else
MsgBox("File failed to copy from "&Src&" to "&Dest)
end if
End Sub

</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBApplication|{{PAGENAME}}]]
[[Category:Interface ISDBApplicationEvents|{{PAGENAME}}]]

ISDBApplicationEvents::OnDeviceFileCopied

2014-03-31T12:54:08Z

Ludek: Created page with "{{MethodDeclaration|SDBApplication|ISDBApplicationEvents|Sub OnDeviceFileCopied(Source as String, Destination as String, Success as Boolean)}} ===Parameters=== {{MethodParamete..."

{{MethodDeclaration|SDBApplication|ISDBApplicationEvents|Sub OnDeviceFileCopied(Source as String, Destination as String, Success as Boolean)}}

===Parameters===

{{MethodParameters
|Source |String | Source path on PC
|Destination |String | Path on device
|Success |Boolean | Copy was successful (true), failed (false) }}

===Event description===

Is called whenever a file copy to device finishes.

{{Introduced|4.1.1}}

===Example code===
<source lang="vb">

Option Explicit

Dim UI : Set UI = SDB.UI

Sub OnStartUp()
Dim mnuTest
Set mnuTest = SDB.UI.AddMenuItem(SDB.UI.Menu_Edit, 0, 0)
mnuTest.Caption = SDB.Localize("Copy file to iPhone")
mnuTest.OnClickFunc = "SDBOnClick"
mnuTest.UseScript = Script.ScriptPath
Script.RegisterEvent SDB, "OnDeviceFileCopied", "SDBDeviceFileCopied"
End Sub

Dim DeviceHandle : DeviceHandle = -1

Sub SDBOnClick(Item)
Dim Devices : Set Devices = SDB.Device.ActiveDeviceList("VID_05AC&PID_129E")
Dim i : i = 0
For i = 0 To Devices.Count-1
If Devices.DeviceHandle(i) <> -1 Then
DeviceHandle = Devices.DeviceHandle(i)
End If
Next

SDB.Device.CopyFile DeviceHandle, "C:\Temp\MyFile.wmv", "/Temp/MyFile.wmv"
End Sub

Sub SDBDeviceFileCopied( DeviceHandle, Src, Dest, Success)
if Success then
MsgBox("File copied successfuly from "&Src&" to "&Dest)
else
MsgBox("File failed to copy from "&Src&" to "&Dest)
end if

Dim Files
Set Files = SDB.NewStringList
Files.Add "/Temp/MyFile.wmv"
SDB.Device.DeleteFiles DeviceHandle, Files

End Sub

</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBApplication|{{PAGENAME}}]]
[[Category:Interface ISDBApplicationEvents|{{PAGENAME}}]]

SDBApplication

2014-03-31T12:50:16Z

Ludek: /* ISDBApplicationEvents members */

{{AutomationObjectsList}}
== CoClass SDBApplication ==

This is the main MediaMonkey scripting object that you initially have accessible as global <tt>SDB</tt> variable in your scripts launched from MediaMonkey. All your communication with MediaMonkey should start here, you can get references to other objects from properties of this object.

Object is exposed to ActiveX under name <tt>SongsDB.SDBApplication</tt>.

Another global variable also accessibl in scripts is <tt>Script</tt>, pointing to [[SDBScriptControl]] object.

=== ISDBApplication members ===

{{MethodsList
|[[ISDBApplication::AllVisibleSongList|AllVisibleSongList]] |Property Get |
|[[ISDBApplication::ApplicationPath|ApplicationPath]] |Property Get |
|[[ISDBApplication::EqualizerPath|EqualizerPath]] |Property Get | From 3.1 beta 1
|[[ISDBApplication::IconsPath|IconsPath]] |Property Get | From 3.1 beta 1
|[[ISDBApplication::PluginsPath|PluginsPath]] |Property Get | From 3.1 beta 1
|[[ISDBApplication::CurrentAddonInstallRoot|CurrentAddonInstallRoot]] |Property Get | From 4.0
|[[ISDBApplication::ScriptsPath|ScriptsPath]] |Property Get | From 3.1 beta 1
|[[ISDBApplication::SkinsPath|SkinsPath]] |Property Get | From 3.1 beta 1
|[[ISDBApplication::CommonDialog|CommonDialog]] |Property Get |
|[[ISDBApplication::CreateTimer|CreateTimer]] |Method |
|[[ISDBApplication::CurrentSongList|CurrentSongList]] |Property Get |
|[[ISDBApplication::CursorType|CursorType]] |Property Get/Let |
|[[ISDBApplication::Database|Database]] |Property Get |
|[[ISDBApplication::Device|Device]] |Property Get |
|[[ISDBApplication::Format|Format]] |Method |
|[[ISDBApplication::IniFile|IniFile]] |Property Get |
|[[ISDBApplication::IsKnownFiletype|IsKnownFiletype]] |Method | From 3.0
|[[ISDBApplication::IsRunning|IsRunning]] |Property Get |
|[[ISDBApplication::InPartyMode|InPartyMode]] |Property Get | From 4.1
|[[ISDBApplication::RunningAsService|RunningAsService]] |Property Get | From 4.1
|[[ISDBApplication::Localize|Localize]] |Method |
|[[ISDBApplication::LocalizedFormat|LocalizedFormat]] |Method |
|[[ISDBApplication::LocalizeGen|LocalizeGen]] |Method |
|[[ISDBApplication::MainTracksWindow|MainTracksWindow]] |Property Get |
|[[ISDBApplication::MainTree|MainTree]] |Property Get |
|[[ISDBApplication::MessageBox|MessageBox]] |Method |
|[[ISDBApplication::MyMusicPath|MyMusicPath]] |Property Get |
|[[ISDBApplication::NewSongData|NewSongData]] |Property Get |
|[[ISDBApplication::NewSongList|NewSongList]] |Property Get |
|[[ISDBApplication::NewStringList|NewStringList]] |Property Get | From 3.0
|[[ISDBApplication::Objects|Objects]] |Property Get/Let |
|[[ISDBApplication::Player|Player]] |Property Get |
|[[ISDBApplication::PlaylistByTitle|PlaylistByTitle]] |Property Get |
|[[ISDBApplication::PlaylistByID|PlaylistByID]] |Property Get | From 4.0
|[[ISDBApplication::ProcessMessages|ProcessMessages]] |Method |
|[[ISDBApplication::Progress|Progress]] |Property Get |
|[[ISDBApplication::RefreshScriptItems|RefreshScriptItems]] |Method | From 3.0
|[[ISDBApplication::RegisterIcon|RegisterIcon]] |Method |
|[[ISDBApplication::RegisterIconHandle|RegisterIconHandle]] |Method |
|[[ISDBApplication::Registry|Registry]] |Property Get |
|[[ISDBApplication::SelectedSongList|SelectedSongList]] |Property Get |
|[[ISDBApplication::SelectFolder|SelectFolder]] |Method |
|[[ISDBApplication::ShutdownAfterDisconnect|ShutdownAfterDisconnect]] |Property Get/Let |
|[[ISDBApplication::TemporaryFolder|TemporaryFolder]] |Property Get |
|[[ISDBApplication::toASCII|toASCII]] |Method |
|[[ISDBApplication::Tools|Tools]] |Property Get |
|[[ISDBApplication::UI|UI]] |Property Get |
|[[ISDBApplication::VersionBuild|VersionBuild]] |Property Get |
|[[ISDBApplication::VersionHi|VersionHi]] |Property Get |
|[[ISDBApplication::VersionLo|VersionLo]] |Property Get |
|[[ISDBApplication::VersionRelease|VersionRelease]] |Property Get |
|[[ISDBApplication::VersionString|VersionString]] |Property Get |
|[[ISDBApplication::ComServerUIActive|ComServerUIActive]] |Property Get/Let |
|[[ISDBApplication::WebControl|WebControl]] |Property Get |
|[[ISDBApplication::Downloader|Downloader]] |Property Get | From 4.0
|[[ISDBApplication::Collections|Collections]] |Property Get | From 4.0
|[[ISDBApplication::VisibleCollectionsCount|VisibleCollectionsCount]] |Property Get | From 4.0
|[[ISDBApplication::VisibleCollectionID|VisibleCollectionID]] |Property Get | From 4.0
}}

=== ISDBApplicationEvents members ===

{{MethodsList
|[[ISDBApplicationEvents::OnBeforeTracksMove|OnBeforeTracksMove]] |Event |
|[[ISDBApplicationEvents::OnChangedSelection|OnChangedSelection]] |Event |
|[[ISDBApplicationEvents::OnCompletePlaybackEnd|OnCompletePlaybackEnd]] |Event | From 4.0
|[[ISDBApplicationEvents::OnDownloadFinished|OnDownloadFinished]] |Event | From 4.0
|[[ISDBApplicationEvents::OnFilterChange|OnFilterChange]] |Event | From 3.1
|[[ISDBApplicationEvents::OnIdle|OnIdle]] |Event | From 3.1
|[[ISDBApplicationEvents::OnNowPlayingModified|OnNowPlayingModified]] |Event | From 3.1
|[[ISDBApplicationEvents::OnNowPlayingSelectionChanged|OnNowPlayingSelectionChanged]] |Event | From 3.1
|[[ISDBApplicationEvents::OnOptionsChange|OnOptionsChange]] |Event | From 3.1
|[[ISDBApplicationEvents::OnPause|OnPause]] |Event |
|[[ISDBApplicationEvents::OnPlay|OnPlay]] |Event |
|[[ISDBApplicationEvents::OnPlaybackEnd|OnPlaybackEnd]] |Event | From 3.1
|[[ISDBApplicationEvents::OnRepeatClicked|OnRepeatClicked]] |Event | From 3.1
|[[ISDBApplicationEvents::OnSeek|OnSeek]] |Event |
|[[ISDBApplicationEvents::OnShuffleClicked|OnShuffleClicked]] |Event | From 3.1
|[[ISDBApplicationEvents::OnShutdown|OnShutdown]] |Event |
|[[ISDBApplicationEvents::OnStop|OnStop]] |Event |
|[[ISDBApplicationEvents::OnTrackAdded|OnTrackAdded]] |Event |
|[[ISDBApplicationEvents::OnTrackConverted|OnTrackConverted]] |Event |
|[[ISDBApplicationEvents::OnTrackDeleting|OnTrackDeleting]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackDoubleClick|OnTrackDoubleClick]] |Event |
|[[ISDBApplicationEvents::OnTrackEnd|OnTrackEnd]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackListFilled|OnTrackListFilled]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackListFilling|OnTrackListFilling]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackListModified|OnTrackListModified]] |Event | From 4.0
|[[ISDBApplicationEvents::OnTrackListSelectionChanged|OnTrackListSelectionChanged]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackProperties|OnTrackProperties]] |Event |
|[[ISDBApplicationEvents::OnTrackSkipped|OnTrackSkipped]] |Event | From 4.0
|[[ISDBApplicationEvents::OnPartyModeEnabled|OnPartyModeEnabled]] |Event | From 4.1
|[[ISDBApplicationEvents::OnDeviceSyncStarted|OnDeviceSyncStarted]] |Event | From 4.1
|[[ISDBApplicationEvents::OnDeviceSyncCompleted|OnDeviceSyncCompleted]] |Event | From 4.1
|[[ISDBApplicationEvents::OnPlaylistAdded|OnPlaylistAdded]] |Event | From 4.1
|[[ISDBApplicationEvents::OnPlaylistRemoved|OnPlaylistRemoved]] |Event | From 4.1
|[[ISDBApplicationEvents::OnPlaylistChanged|OnPlaylistChanged]] |Event | From 4.1
|[[ISDBApplicationEvents::OnDeviceFileCopied|OnDeviceFileCopied]] |Event | From 4.1.1
}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBApplication|{{PAGENAME}}]]

ISDBDevice::GetSyncProgress

2014-03-31T12:47:18Z

Ludek: Created page with "{{MethodDeclaration|SDBDevice|ISDBDevice|Property Get GetSyncProgress(DeviceHandle As Long)}} ===Parameters=== {{MethodParameters |DeviceHandle |Long |Handle of the device}} ..."

{{MethodDeclaration|SDBDevice|ISDBDevice|Property Get GetSyncProgress(DeviceHandle As Long)}}

===Parameters===

{{MethodParameters
|DeviceHandle |Long |Handle of the device}}

===Method description===

Gets progress percentage of sync/copy task.

===Example===

<source lang="vb">
Option Explicit

Dim UI : Set UI = SDB.UI

Sub OnStartUp()
Dim mnuTest
Set mnuTest = SDB.UI.AddMenuItem(SDB.UI.Menu_Edit, 0, 0)
mnuTest.Caption = SDB.Localize("Get sync progress")
mnuTest.OnClickFunc = "SDBOnClick"
mnuTest.UseScript = Script.ScriptPath
End Sub

Sub SDBOnClick(Item)
Dim DeviceHandle : DeviceHandle = -1
Dim Devices : Set Devices = SDB.Device.ActiveDeviceList("VID_05AC&PID_129E")
Dim i : i = 0
For i = 0 To Devices.Count-1
If Devices.DeviceHandle(i) <> -1 Then
DeviceHandle = Devices.DeviceHandle(i)
End If
Next

MsgBox( SDB.Device.GetSyncProgress( DeviceHandle))
End Sub
</source>

To see how to handle copy result see example in CopyFile() method

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]
[[Category:Interface ISDBDevice|{{PAGENAME}}]]

ISDBDevice::DeleteFiles

2014-03-31T12:45:22Z

Ludek: Created page with "{{MethodDeclaration|SDBDevice|ISDBDevice|Sub CopyFiles(DeviceHandle As Long, Files As SDBStringList)}} ===Parameters=== {{MethodParameters |DeviceHandle |Long |Handle of ..."

{{MethodDeclaration|SDBDevice|ISDBDevice|Sub CopyFiles(DeviceHandle As Long, Files As [[SDBStringList]])}}

===Parameters===

{{MethodParameters
|DeviceHandle |Long |Handle of the device
|Files| String | Destination file paths on the device}}

===Method description===

Deletes file(s) from device.

===Example===

<source lang="vb">
Dim Files
Set Files = SDB.NewStringList
Files.Add "/Temp/MyFile.wmv"
SDB.Device.DeleteFiles DeviceHandle, Files
</source>

To see how to handle copy result see example in CopyFile() method

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]
[[Category:Interface ISDBDevice|{{PAGENAME}}]]

ISDBDevice::CopyFiles

2014-03-31T12:43:58Z

Ludek: Created page with "{{MethodDeclaration|SDBDevice|ISDBDevice|Sub CopyFiles(DeviceHandle As Long, Sources As SDBStringList, Destinations as SDBStringList)}} ===Parameters=== {{MethodParamet..."

{{MethodDeclaration|SDBDevice|ISDBDevice|Sub CopyFiles(DeviceHandle As Long, Sources As [[SDBStringList]], Destinations as [[SDBStringList]])}}

===Parameters===

{{MethodParameters
|DeviceHandle |Long |Handle of the device
|Sources| String | Source file paths on PC
|Destinations| String | Destination file paths on the device}}

===Method description===

Copies file to device.

===Example===

<source lang="vb">
Dim Sources
Set Sources= SDB.NewStringList
Sources.Add "C:\Temp\MyFile.wmv"
Sources.Add "C:\Temp\MyFile2.wmv"
Dim Destinations
Set Destinations= SDB.NewStringList
Destinations.Add "/Temp/MyFile.wmv"
Destinations.Add "/Temp/MyFile2.wmv"
SDB.Device.CopyFiles DeviceHandle, Sources, Destinations
</source>

To see how to handle copy result see example in CopyFile() method

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]
[[Category:Interface ISDBDevice|{{PAGENAME}}]]

ISDBDevice::CopyFile

2014-03-31T12:36:18Z

Ludek: Created page with "{{MethodDeclaration|SDBDevice|ISDBDevice|Sub CopyFile(DeviceHandle As Long, Source As String, Destination as String)}} ===Parameters=== {{MethodParameters |DeviceHandle |Long..."

{{MethodDeclaration|SDBDevice|ISDBDevice|Sub CopyFile(DeviceHandle As Long, Source As String, Destination as String)}}

===Parameters===

{{MethodParameters
|DeviceHandle |Long |Handle of the device
|Source| String | Source file path on PC
|Destination| String | Destination file path on the device}}

===Method description===

Copies file to device.

===Example===

<source lang="vb">
Option Explicit

Dim UI : Set UI = SDB.UI

Sub OnStartUp()
Dim mnuTest
Set mnuTest = SDB.UI.AddMenuItem(SDB.UI.Menu_Edit, 0, 0)
mnuTest.Caption = SDB.Localize("Copy file to iPhone")
mnuTest.OnClickFunc = "SDBOnClick"
mnuTest.UseScript = Script.ScriptPath
Script.RegisterEvent SDB, "OnDeviceFileCopied", "SDBDeviceFileCopied"
End Sub

Dim DeviceHandle : DeviceHandle = -1

Sub SDBOnClick(Item)
Dim Devices : Set Devices = SDB.Device.ActiveDeviceList("VID_05AC&PID_129E")
Dim i : i = 0
For i = 0 To Devices.Count-1
If Devices.DeviceHandle(i) <> -1 Then
DeviceHandle = Devices.DeviceHandle(i)
End If
Next

SDB.Device.CopyFile DeviceHandle, "C:\Temp\MyFile.wmv", "/Temp/MyFile.wmv"
End Sub

Sub SDBDeviceFileCopied( DeviceHandle, Src, Dest, Success)
if Success then
MsgBox("File copied successfuly from "&Src&" to "&Dest)
else
MsgBox("File failed to copy from "&Src&" to "&Dest)
end if
End Sub
</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]
[[Category:Interface ISDBDevice|{{PAGENAME}}]]

SDBDevice

2014-03-31T12:29:45Z

Ludek: /* ISDBDevice members */

{{AutomationObjectsList}}
== CoClass SDBDevice ==

Mainly for usage in device plug-ins for controling several aspects of portable device functionality.

=== ISDBDevice members ===

{{MethodsList
|[[ISDBDevice::ActiveDeviceList|ActiveDeviceList]] |Property Get |
|[[ISDBDevice::AddDeviceNode|AddDeviceNode]] |Method |
|[[ISDBDevice::canEjectDevice|canEjectDevice]] |Property Get |
|[[ISDBDevice::CreateDeviceNode|CreateDeviceNode]] |Method |
|[[ISDBDevice::DeviceEject|DeviceEject]] |Method |
|[[ISDBDevice::DeviceIcon|DeviceIcon]] |Property Get/Let |
|[[ISDBDevice::DeviceMenuIcon|DeviceMenuIcon]] |Property Get/Let |
|[[ISDBDevice::DeviceStart|DeviceStart]] |Method |
|[[ISDBDevice::DeviceStartEx|DeviceStartEx]] |Method |
|[[ISDBDevice::DeviceStop|DeviceStop]] |Method |
|[[ISDBDevice::DeviceThreadedEject|DeviceThreadedEject]] |Method |
|[[ISDBDevice::DriveLetterFree|DriveLetterFree]] |Property Get |
|[[ISDBDevice::FreeSpace|FreeSpace]] |Property Get |
|[[ISDBDevice::GetTrackIDSynchStatus|GetTrackIDSynchStatus]] |Method |
|[[ISDBDevice::GetTrackSynchStatus|GetTrackSynchStatus]] |Method |
|[[ISDBDevice::GetDeviceContent|GetDeviceContent]] |Method | From 4.1
|[[ISDBDevice::ChangeDeviceCaption|ChangeDeviceCaption]] |Method |
|[[ISDBDevice::ChangeDeviceID|ChangeDeviceID]] |Method |
|[[ISDBDevice::isPlaylistForSynch|isPlaylistForSynch]] |Property Get/Let |
|[[ISDBDevice::IsVisible|IsVisible]] |Property Get |
|[[ISDBDevice::LockPlugin|LockPlugin]] |Method |
|[[ISDBDevice::RegisterTreeNode|RegisterTreeNode]] |Method |
|[[ISDBDevice::ShowDeviceConfig|ShowDeviceConfig]] |Method |
|[[ISDBDevice::StartSynch|StartSynch]] |Method |
|[[ISDBDevice::StartAutoSynch|StartAutoSynch]] |Method | From 4.1
|[[ISDBDevice::SynchTerminating|SynchTerminating]] |Property Get |
|[[ISDBDevice::TotalSpace|TotalSpace]] |Property Get |
|[[ISDBDevice::UnlockPlugin|UnlockPlugin]] |Method |
|[[ISDBDevice::TerminateThreads|TerminateThreads]] |Method | From 4.0
|[[ISDBDevice::GetDeviceProfileXML|GetDeviceProfileXML]] |Property Get| From 4.0.3
|[[ISDBDevice::CopyFile|CopyFile]] |Property Get| From 4.1.1
|[[ISDBDevice::CopyFiles|CopyFiles]] |Property Get| From 4.1.1
|[[ISDBDevice::DeleteFiles|DeleteFiles]] |Property Get| From 4.1.1
|[[ISDBDevice::GetSyncProgress|GetSyncProgress]] |Property Get| From 4.1.1
}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBDevice|{{PAGENAME}}]]

Compatible Devices

2013-10-31T21:05:07Z

Ludek: /* Samsung */

This is a list of devices with known compatibility (i.e. these devices have been tested by users) with the current version of MediaMonkey. If you know of additional devices with MediaMonkey compatibility, please add them to this list. Devices are listed by their manufacturer. Click on any device to find any specific settings that are necessary to sync with the device.

==Android devices==
:[[GenericMTP|Any Android device]] over USB/MTP with MediaMonkey 4.0.7
:[[Android device running Android 2.3+]] via Wi-Fi sync between MediaMonkey for Android and MediaMonkey for Windows 4.1

==Apple==
:[[iPhone|iOS 4.0 - 6]] as of MediaMonkey 4.0.7
:[[iPhone|iOS - 7]] as of MediaMonkey 4.1
:[[iPod]] (including 5th Gen)
:[[iPod Classic]]
:[[iPod Mini|iPod Mini]] (1st and 2nd Gen)
:[[iPod Nano]] (1st, 2nd, 3rd, 4th, 5th, 6th, and 7th Gen)*
:[[iPod Photo]]
:[[iPod Shuffle]] (1st, 2nd, 3rd and 4th Gen)
:[[iPod Touch]] (1st, 2nd, 3rd, 4th and 5th Gen)
:[[iPhone|iPhone]] (iPhone 2G, iPhone 3G, iPhone 3GS, iPhone 4, iPhone 4s, iPhone 5, iPhone 5c)
:[[iPhone|iPad]] (1st, 2nd, 3rd Gen)
:[[iTunes|iTunes]] (iTunes 6 to 11.1)

Note: iOS7 support is provided with MediaMonkey 4.1.0

Apple Device Sync Help: http://www.mediamonkey.com/wiki/index.php/WebHelp:iPod_Synchronization/4.0

Note: iPad 4th gen, iPad mini don't have confirmed support yet.

==Archos==
:[[GenericMTP|Archos 5]]
:[[GenericMTP|Archos 605 Wifi]]
:[[USBmass|Archos 604/504]]
:[[GenericMTP|Archos 7]]
:[[GenericMTP|Archos Gemini 200]]
:[[GenericMTP|Archos Gmini (all versions)]]

==Audiovox==
:[[GenericMTP|Audiovox SMP3-xxx]]

==Cowon==
:[[USBmass|iAudio X5]]
:[[USBmass|Cowon Q5W]]
:[[USBmass|Cowon iAudio 7]]
:[[USBmass|Cowon iAudio D2]]
:[[USBmass|Cowon S9]] Both MSC and MTP.

==Creative==
:[[MTPZen|Zen Micro (2.20.05 firmware)]]
:[[MTPZen|Zen Nano]]
:[[MTPZen|Zen Neeon]]
:[[MTPZen|Zen Sleek]]
:[[MTPZen|Zen Stone]]
:[[MTPZen|Zen Touch (with 'Plays for Sure' MTP firmware update)]]
:[[MTPZen|Zen Vision]]
:[[MTPZen|Zen Vision:M]]
:[[MTPZen|Zen xtra ('Plays for Sure' firmware update)]]

Compatible, with workaround:
:[[MTPZen|ZEN MX]] - see http://www.mediamonkey.com/forum/viewtopic.php?f=12&t=44192 http://www.mediamonkey.com/forum/viewtopic.php?f=12&t=44192

Compatible, with restriction:
:[[MTPZen|ZEN]] - see [http://www.mediamonkey.com/forum/viewtopic.php?f=6&t=39965 here]

==Dell==
:[[USBmass|Dell DJ (mostly works--need logs to debug playlist problem)]]

==Eiger labs==
:[[USBmass|MPMan MP-F57]]

==Finis==
:[[USBmass|Finis SwiMP3]]

==HTC==
:HTC Touch Diamond 2

==iRiver==
:[[GenericMTP|iRiver Clix 2nd Gen (MTP mode)]]
:iRiver H10
:iRiver H120/H320/H340
:iRiver ifp-8xx
:[[USBmass|iRiver iFP-9xx]]
:iRiver N-xx
:iRiver PMP-1xx
:iRiver PMC-120

==Motorola==
:[[Motorola RIZR Z3]]
:[[Motorola Q 9 Global]]

==Nokia==
:[[GenericMTP|Nokia 5310]]
:[[GenericMTP|Nokia N8]]

==Palm==
:[[Palm Pre]]

==Phillips==
:[[GenericMTP|Philips HDD6320]] (partial support--need logs to debug)

==Pioneer==
:INNO GEX-INNO2BK (same as Samsung Helix YX-M1Z)

==RCA==
:[[USBmass|Lyra 2780]]

==Samsung==
:[[GenericMTP|Samsung YP-XX]]
:[[GenericMTP|Samsung YP-XXX]]
:[[GenericMTP|Samsung Galaxy Nexus]]
:[[GenericMTP|Samsung Galaxy S2]]
:[[GenericMTP|Samsung Galaxy S3]]
:[[GenericMTP|Samsung Galaxy S4]]
:[[GenericMTP|Samsung Galaxy Note]]

==SanDisk==
:[[MTPSansa|Sansa eXXX]]
:[[MTPSansa|Sansa Fuze]]
:[[MTPSansa|Sansa M250]]
:[[MTPSansa|Sandisk Sansa]]
:[[MTPSansa|Sandisk Connect 4Gb]]
:[[MTPSansa|Sandisk Sansa Clip]]
:[[MTPSansa|Sandisk E250]]

==Toshiba==
:[[GenericMTP|Toshiba Gigabeat (works but firmware bug limits synch speed)]]

==Trekstor==
:[[TrekstorVibez|Vibez]] (Set as either [[GenericMTP|MTP Device]] or as [[USBmass|MSC Device]])

==Sony==
:[[USBmass|Sony Ericsson W302]]
:[[USBmass|Sony Ericsson W600]]
:[[USBmass|Sony Ericsson W800i]]
:[[USBmass|Sony Ericsson W880i]]
:[[GenericMTP|Sony Walkman NWZ-A829]]
:[[GenericMTP|Sony Walkman NWZ-S638]]

Compatible Devices

2013-10-31T21:03:33Z

Ludek: /* Apple */

This is a list of devices with known compatibility (i.e. these devices have been tested by users) with the current version of MediaMonkey. If you know of additional devices with MediaMonkey compatibility, please add them to this list. Devices are listed by their manufacturer. Click on any device to find any specific settings that are necessary to sync with the device.

==Android devices==
:[[GenericMTP|Any Android device]] over USB/MTP with MediaMonkey 4.0.7
:[[Android device running Android 2.3+]] via Wi-Fi sync between MediaMonkey for Android and MediaMonkey for Windows 4.1

==Apple==
:[[iPhone|iOS 4.0 - 6]] as of MediaMonkey 4.0.7
:[[iPhone|iOS - 7]] as of MediaMonkey 4.1
:[[iPod]] (including 5th Gen)
:[[iPod Classic]]
:[[iPod Mini|iPod Mini]] (1st and 2nd Gen)
:[[iPod Nano]] (1st, 2nd, 3rd, 4th, 5th, 6th, and 7th Gen)*
:[[iPod Photo]]
:[[iPod Shuffle]] (1st, 2nd, 3rd and 4th Gen)
:[[iPod Touch]] (1st, 2nd, 3rd, 4th and 5th Gen)
:[[iPhone|iPhone]] (iPhone 2G, iPhone 3G, iPhone 3GS, iPhone 4, iPhone 4s, iPhone 5, iPhone 5c)
:[[iPhone|iPad]] (1st, 2nd, 3rd Gen)
:[[iTunes|iTunes]] (iTunes 6 to 11.1)

Note: iOS7 support is provided with MediaMonkey 4.1.0

Apple Device Sync Help: http://www.mediamonkey.com/wiki/index.php/WebHelp:iPod_Synchronization/4.0

Note: iPad 4th gen, iPad mini don't have confirmed support yet.

==Archos==
:[[GenericMTP|Archos 5]]
:[[GenericMTP|Archos 605 Wifi]]
:[[USBmass|Archos 604/504]]
:[[GenericMTP|Archos 7]]
:[[GenericMTP|Archos Gemini 200]]
:[[GenericMTP|Archos Gmini (all versions)]]

==Audiovox==
:[[GenericMTP|Audiovox SMP3-xxx]]

==Cowon==
:[[USBmass|iAudio X5]]
:[[USBmass|Cowon Q5W]]
:[[USBmass|Cowon iAudio 7]]
:[[USBmass|Cowon iAudio D2]]
:[[USBmass|Cowon S9]] Both MSC and MTP.

==Creative==
:[[MTPZen|Zen Micro (2.20.05 firmware)]]
:[[MTPZen|Zen Nano]]
:[[MTPZen|Zen Neeon]]
:[[MTPZen|Zen Sleek]]
:[[MTPZen|Zen Stone]]
:[[MTPZen|Zen Touch (with 'Plays for Sure' MTP firmware update)]]
:[[MTPZen|Zen Vision]]
:[[MTPZen|Zen Vision:M]]
:[[MTPZen|Zen xtra ('Plays for Sure' firmware update)]]

Compatible, with workaround:
:[[MTPZen|ZEN MX]] - see http://www.mediamonkey.com/forum/viewtopic.php?f=12&t=44192 http://www.mediamonkey.com/forum/viewtopic.php?f=12&t=44192

Compatible, with restriction:
:[[MTPZen|ZEN]] - see [http://www.mediamonkey.com/forum/viewtopic.php?f=6&t=39965 here]

==Dell==
:[[USBmass|Dell DJ (mostly works--need logs to debug playlist problem)]]

==Eiger labs==
:[[USBmass|MPMan MP-F57]]

==Finis==
:[[USBmass|Finis SwiMP3]]

==HTC==
:HTC Touch Diamond 2

==iRiver==
:[[GenericMTP|iRiver Clix 2nd Gen (MTP mode)]]
:iRiver H10
:iRiver H120/H320/H340
:iRiver ifp-8xx
:[[USBmass|iRiver iFP-9xx]]
:iRiver N-xx
:iRiver PMP-1xx
:iRiver PMC-120

==Motorola==
:[[Motorola RIZR Z3]]
:[[Motorola Q 9 Global]]

==Nokia==
:[[GenericMTP|Nokia 5310]]
:[[GenericMTP|Nokia N8]]

==Palm==
:[[Palm Pre]]

==Phillips==
:[[GenericMTP|Philips HDD6320]] (partial support--need logs to debug)

==Pioneer==
:INNO GEX-INNO2BK (same as Samsung Helix YX-M1Z)

==RCA==
:[[USBmass|Lyra 2780]]

==Samsung==
:[[GenericMTP|Samsung YP-XX]]
:[[GenericMTP|Samsung YP-XXX]]

==SanDisk==
:[[MTPSansa|Sansa eXXX]]
:[[MTPSansa|Sansa Fuze]]
:[[MTPSansa|Sansa M250]]
:[[MTPSansa|Sandisk Sansa]]
:[[MTPSansa|Sandisk Connect 4Gb]]
:[[MTPSansa|Sandisk Sansa Clip]]
:[[MTPSansa|Sandisk E250]]

==Toshiba==
:[[GenericMTP|Toshiba Gigabeat (works but firmware bug limits synch speed)]]

==Trekstor==
:[[TrekstorVibez|Vibez]] (Set as either [[GenericMTP|MTP Device]] or as [[USBmass|MSC Device]])

==Sony==
:[[USBmass|Sony Ericsson W302]]
:[[USBmass|Sony Ericsson W600]]
:[[USBmass|Sony Ericsson W800i]]
:[[USBmass|Sony Ericsson W880i]]
:[[GenericMTP|Sony Walkman NWZ-A829]]
:[[GenericMTP|Sony Walkman NWZ-S638]]

Compatible Devices

2013-10-31T21:03:10Z

Ludek: /* Apple */

This is a list of devices with known compatibility (i.e. these devices have been tested by users) with the current version of MediaMonkey. If you know of additional devices with MediaMonkey compatibility, please add them to this list. Devices are listed by their manufacturer. Click on any device to find any specific settings that are necessary to sync with the device.

==Android devices==
:[[GenericMTP|Any Android device]] over USB/MTP with MediaMonkey 4.0.7
:[[Android device running Android 2.3+]] via Wi-Fi sync between MediaMonkey for Android and MediaMonkey for Windows 4.1

==Apple==
:[[iPhone|iOS 4.0 - 6]] as of MediaMonkey 4.0.7
:[[iPhone|iOS - 7]] as of MediaMonkey 4.1
:[[iPod]] (including 5th Gen)
:[[iPod Classic]]
:[[iPod Mini|iPod Mini]] (1st and 2nd Gen)
:[[iPod Nano]] (1st, 2nd, 3rd, 4th, 5th, 6th, and 7th Gen)*
:[[iPod Photo]]
:[[iPod Shuffle]] (1st, 2nd, 3rd and 4th Gen)
:[[iPod Touch]] (1st, 2nd, 3rd, 4th and 5th Gen)
:[[iPhone|iPhone]] (iPhone 2G, iPhone 3G, iPhone 3GS, iPhone 4, iPhone 4s, iPhone 5, iPhone 5c)
:[[iPhone|iPad]] (1st, 2nd, 3rd Gen)
:[[iTunes|iTunes]] (iTunes 6 to 11.1)

Note: iOS7 support is provided with MediaMonkey 4.1.0
Apple Device Sync Help: http://www.mediamonkey.com/wiki/index.php/WebHelp:iPod_Synchronization/4.0

Note: iPad 4th gen, iPad mini don't have confirmed support yet.

==Archos==
:[[GenericMTP|Archos 5]]
:[[GenericMTP|Archos 605 Wifi]]
:[[USBmass|Archos 604/504]]
:[[GenericMTP|Archos 7]]
:[[GenericMTP|Archos Gemini 200]]
:[[GenericMTP|Archos Gmini (all versions)]]

==Audiovox==
:[[GenericMTP|Audiovox SMP3-xxx]]

==Cowon==
:[[USBmass|iAudio X5]]
:[[USBmass|Cowon Q5W]]
:[[USBmass|Cowon iAudio 7]]
:[[USBmass|Cowon iAudio D2]]
:[[USBmass|Cowon S9]] Both MSC and MTP.

==Creative==
:[[MTPZen|Zen Micro (2.20.05 firmware)]]
:[[MTPZen|Zen Nano]]
:[[MTPZen|Zen Neeon]]
:[[MTPZen|Zen Sleek]]
:[[MTPZen|Zen Stone]]
:[[MTPZen|Zen Touch (with 'Plays for Sure' MTP firmware update)]]
:[[MTPZen|Zen Vision]]
:[[MTPZen|Zen Vision:M]]
:[[MTPZen|Zen xtra ('Plays for Sure' firmware update)]]

Compatible, with workaround:
:[[MTPZen|ZEN MX]] - see http://www.mediamonkey.com/forum/viewtopic.php?f=12&t=44192 http://www.mediamonkey.com/forum/viewtopic.php?f=12&t=44192

Compatible, with restriction:
:[[MTPZen|ZEN]] - see [http://www.mediamonkey.com/forum/viewtopic.php?f=6&t=39965 here]

==Dell==
:[[USBmass|Dell DJ (mostly works--need logs to debug playlist problem)]]

==Eiger labs==
:[[USBmass|MPMan MP-F57]]

==Finis==
:[[USBmass|Finis SwiMP3]]

==HTC==
:HTC Touch Diamond 2

==iRiver==
:[[GenericMTP|iRiver Clix 2nd Gen (MTP mode)]]
:iRiver H10
:iRiver H120/H320/H340
:iRiver ifp-8xx
:[[USBmass|iRiver iFP-9xx]]
:iRiver N-xx
:iRiver PMP-1xx
:iRiver PMC-120

==Motorola==
:[[Motorola RIZR Z3]]
:[[Motorola Q 9 Global]]

==Nokia==
:[[GenericMTP|Nokia 5310]]
:[[GenericMTP|Nokia N8]]

==Palm==
:[[Palm Pre]]

==Phillips==
:[[GenericMTP|Philips HDD6320]] (partial support--need logs to debug)

==Pioneer==
:INNO GEX-INNO2BK (same as Samsung Helix YX-M1Z)

==RCA==
:[[USBmass|Lyra 2780]]

==Samsung==
:[[GenericMTP|Samsung YP-XX]]
:[[GenericMTP|Samsung YP-XXX]]

==SanDisk==
:[[MTPSansa|Sansa eXXX]]
:[[MTPSansa|Sansa Fuze]]
:[[MTPSansa|Sansa M250]]
:[[MTPSansa|Sandisk Sansa]]
:[[MTPSansa|Sandisk Connect 4Gb]]
:[[MTPSansa|Sandisk Sansa Clip]]
:[[MTPSansa|Sandisk E250]]

==Toshiba==
:[[GenericMTP|Toshiba Gigabeat (works but firmware bug limits synch speed)]]

==Trekstor==
:[[TrekstorVibez|Vibez]] (Set as either [[GenericMTP|MTP Device]] or as [[USBmass|MSC Device]])

==Sony==
:[[USBmass|Sony Ericsson W302]]
:[[USBmass|Sony Ericsson W600]]
:[[USBmass|Sony Ericsson W800i]]
:[[USBmass|Sony Ericsson W880i]]
:[[GenericMTP|Sony Walkman NWZ-A829]]
:[[GenericMTP|Sony Walkman NWZ-S638]]

ISDBSongData::SetPathByMask

2013-09-26T16:47:10Z

Ludek: Created page with "{{MethodDeclaration|SDBSongData|ISDBSongData|Method SetPathByMask(Mask As String)}} ===Method description=== Similar to Path property and RenameByMask method, but allows you to..."

{{MethodDeclaration|SDBSongData|ISDBSongData|Method SetPathByMask(Mask As String)}}

===Method description===

Similar to Path property and RenameByMask method, but allows you to set path according to Mask without moving the file. The file itself is moved once UpdateDB is called.

Example script:

<source lang="vb">
Option Explicit

Sub OnStartUp()
Dim oMenuItem

Set oMenuItem = SDB.UI.AddMenuItem(SDB.UI.Menu_Pop_TrackList, 0, 0)
oMenuItem.Caption = "PathByMask"
oMenuItem.OnClickFunc = "Test"
oMenuItem.UseScript = Script.ScriptPath
End Sub

Sub Test(oMenuItem)
Dim oSongData
Set oSongData = SDB.SelectedSongList.Item(0)
oSongData.SetPathByMask( SDB.Tools.UFText2Mask _
("C:\Music\<Genre>\<Album Artist>\<Album>\<Track#:2> - <Title>"))
SDB.MessageBox oSongData.Path, mtInformation, Array(mbOK)
oSongData.DiscardChanges
SDB.MessageBox oSongData.Path, mtInformation, Array(mbOK)
End Sub
</source>

Added in MediaMonkey version 4.1

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBSongData|{{PAGENAME}}]]
[[Category:Interface ISDBSongData|{{PAGENAME}}]]

SDBSongData

2013-09-26T16:45:56Z

Ludek: /* ISDBSongData members */

{{AutomationObjectsList}}
== CoClass SDBSongData ==

Object with all properties of a track. Corresponding Songs Table columns.

To apply changes made to a SongData object, be sure to call one or more of the methods [[ISDBSongData::UpdateAlbum|UpdateAlbum]], [[ISDBSongData::UpdateArtist|UpdateArtist]], [[ISDBSongData::UpdateDB|UpdateDB]] and/or [[ISDBSongData::WriteTags|WriteTags]]. In some cases, you can call the [[ISDBSongList::UpdateAll|UpdateAll]] method of the SongList object containing the SongData object.

=== ISDBSongData members ===

{| border="1"
|-
! Name
! Type
! Description
!
! Tag Name
! Value Type
! Possible Values
! Description
|-
|[[ISDBSongData::Actors|Actors]]
|Property Get/Let
|
|
|Actors
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::Album|Album]]
|Property Get
|
|
|
|[[SDBAlbum]]
|
|
|-
|[[ISDBSongData::AlbumArt|AlbumArt]]
|Property Get
|
|
|
|[[SDBAlbumArtList]]
|
|
|-
|[[ISDBSongData::AlbumArtistName|AlbumArtistName]]
|Property Get/Let
|
|
|AlbumArtist
|TEXT
|
|
|-
|[[ISDBSongData::AlbumName|AlbumName]]
|Property Get/Let
|
|
|Album
|TEXT
|
|
|-
|[[ISDBSongData::Artist|Artist]]
|Property Get
|
|
|
|[[SDBArtist]]
|
|
|-
|[[ISDBSongData::ArtistName|ArtistName]]
|Property Get/Let
|
|
|Artist
|TEXT
|
|
|-
|[[ISDBSongData::Author|Author]]
|Property Get/Let
|
|
|Author
|TEXT
|
|The Composer of the Song
|-
|[[ISDBSongData::Band|Band]]
|Property Get/Let
|
|
|Band
|TEXT
|
|
|-
|[[ISDBSongData::Bitrate|Bitrate]]
|Property Get/Let
|
|
|Bitrate
|INTEGER
|
|
|-
|[[ISDBSongData::Bookmark|Bookmark]]
|Property Get/Let
|
|
|PlaybackPos
|INTEGER
|
|
|-
|[[ISDBSongData::StartTime|StartTime]]
|Property Get/Let
|
|
|StartTime
|INTEGER
|
|From MM version 4.0
|-
|[[ISDBSongData::StopTime|StopTime]]
|Property Get/Let
|
|
|StopTime
|INTEGER
|
|From MM version 4.0
|-
|[[ISDBSongData::SkipCount|SkipCount]]
|Property Get/Let
|
|
|SkipCount
|INTEGER
|
|From MM version 4.0
|-
|[[ISDBSongData::TrackType|TrackType]]
|Property Get/Let
|
|
|TrackType
|INTEGER
|
|From MM version 4.0
|-
|[[ISDBSongData::BPM|BPM]]
|Property Get/Let
|
|
|BPM
|INTEGER
|
|Beats Per Minute
|-
|[[ISDBSongData::Cached|Cached]]
|Property Get/Let
|
|
|CacheStatus
|INTEGER
|
|
|-
|[[ISDBSongData::CachedPath|CachedPath]]
|Property Get
|
|
|CacheName
|TEXT
|
|
|-
|[[ISDBSongData::CalculateGapData|CalculateGapData]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::canCrossfade|canCrossfade]]
|Property Get/Set
|
|
|
|BOOLEAN
|
|
|-
|[[ISDBSongData::Channels|Channels]]
|Property Get/Let
|
|
|Stereo
|INTEGER
|
|
|-
|[[ISDBSongData::Comment|Comment]]
|Property Get/Let
|
|
|Comment
|TEXT
|
|
|-
|[[ISDBSongData::Conductor|Conductor]]
|Property Get/Let
|
|
|Conductor
|TEXT
|
|
|-
|[[ISDBSongData::Copyright|Copyright]]
|Property Get/Let
|
|
|Copyright
|TEXT
|
|
|-
|[[ISDBSongData::Custom1|Custom1]]
|Property Get/Let
|
|
|Custom1
|TEXT
|
|
|-
|[[ISDBSongData::Custom2|Custom2]]
|Property Get/Let
|
|
|Custom2
|TEXT
|
|
|-
|[[ISDBSongData::Custom3|Custom3]]
|Property Get/Let
|
|
|Custom3
|TEXT
|
|
|-
|[[ISDBSongData::Custom4|Custom4]]
|Property Get/Let
|
|
|Custom4
|TEXT
|
|
|-
|[[ISDBSongData::Custom5|Custom5]]
|Property Get/Let
|
|
|Custom5
|TEXT
|
|
|-
|[[ISDBSongData::Date|Date]]
|Property Get/Let
|
|
|
|[[DateType|DATE]]
|
|
|-
|[[ISDBSongData::DateAdded|DateAdded]]
|Property Get/Let
|
|
|DateAdded
|[[DateType|DATE]]
|
|
|-
|[[ISDBSongData::DateDBModified|DateDBModified]]
|Property Get
|
|
|
|[[DateType|DATE]]
|
|
|-
|[[ISDBSongData::Day|Day]]
|Property Get/Let
|
|
|Year[7,2]
|INTEGER
|
|
|-
|[[ISDBSongData::DiscNumber|DiscNumber]]
|Property Get/Let
|
|
|
|INTEGER
|
|MM2
|-
|[[ISDBSongData::DiscNumberStr|DiscNumberStr]]
|Property Get/Let
|
|
|DiscNumber
|TEXT
|
|
|-
|[[ISDBSongData::Director|Director]]
|Property Get/Let
|
|
|Artist
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::Encoder|Encoder]]
|Property Get/Let
|
|
|Encoder
|TEXT
|
|
|-
|[[ISDBSongData::EpisodeNumber|EpisodeNumber]]
|Property Get/Let
|
|
|EpisodeNumber
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::FileLength|FileLength]]
|Property Get/Let
|
|
|FileLength
|INTEGER
|
|
|-
|[[ISDBSongData::FileModified|FileModified]]
|Property Get/Let
|
|
|FileModified
|REAL
|
|
|-
|[[ISDBSongData::GaplessBytes|GaplessBytes]]
|Property Get/Let
|
|
|GaplessBytes
|INTEGER
|
|
|-
|[[ISDBSongData::Genre|Genre]]
|Property Get/Let
|
|
|Genre
|TEXT
|
|
|-
|[[ISDBSongData::GetCopy|GetCopy]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::Grouping|Grouping]]
|Property Get/Let
|
|
|GroupDesc
|TEXT
|
|
|-
|[[ISDBSongData::ID|ID]]
|Property Get/Let
|
|
|ID
|INTEGER
|AUTOINCREMENT (1 to inf.)
|
|-
|[[ISDBSongData::InvolvedPeople|InvolvedPeople]]
|Property Get/Let
|
|
|InvolvedPeople
|TEXT
|
|
|-
|[[ISDBSongData::isBookmarkable|isBookmarkable]]
|Property Get/Let
|
|
|
|BOOLEAN
|
|
|-
|[[ISDBSongData::isShuffleIgnored|isShuffleIgnored]]
|Property Get/Let
|
|
|
|BOOLEAN
|
|
|-
|[[ISDBSongData::IsntInDB|IsntInDB]]
|Property Get/Let
|
|
|
|BOOLEAN
|
|Dynamic Check
|-
|[[ISDBSongData::ISRC|ISRC]]
|Property Get/Let
|
|
|ISRC
|TEXT
|
|
|-
|[[ISDBSongData::LastPlayed|LastPlayed]]
|Property Get/Let
|
|
|LastTimePlayed
|REAL
|
|
|-
|[[ISDBSongData::Leveling|Leveling]]
|Property Get/Let
|
|
|NormalizeTrack
|REAL
|
|
|-
|[[ISDBSongData::LevelingAlbum|LevelingAlbum]]
|Property Get/Let
|
|
|NormalizeAlbum
|REAL
|
|
|-
|[[ISDBSongData::Lyricist|Lyricist]]
|Property Get/Let
|
|
|Lyricist
|TEXT
|
|
|-
|[[ISDBSongData::Lyrics|Lyrics]]
|Property Get/Let
|
|
|Lyrics
|TEXT
|
|
|-
|[[ISDBSongData::Media|Media]]
|Property Get
|
|
|IDMedia
|INTEGER
|
|
|-
|[[ISDBSongData::MediaLabel|MediaLabel]]
|Property Get
|
|
|
|TEXT
|
|
|-
|[[ISDBSongData::MetadataFromFilename|MetadataFromFilename]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::Month|Month]]
|Property Get/Let
|
|
|Year[5,2]
|INTEGER
|
|
|-
|[[ISDBSongData::Mood|Mood]]
|Property Get/Let
|
|
|Mood
|TEXT
|
|
|-
|[[ISDBSongData::MusicComposer|MusicComposer]]
|Property Get/Let
|
|
|
|TEXT
|
|Use Author
|-
|[[ISDBSongData::Occasion|Occasion]]
|Property Get/Let
|
|
|Occasion
|TEXT
|
|
|-
|[[ISDBSongData::OriginalArtist|OriginalArtist]]
|Property Get/Let
|
|
|OrigArtist
|TEXT
|
|
|-
|[[ISDBSongData::OriginalLyricist|OriginalLyricist]]
|Property Get/Let
|
|
|OrigLyricist
|TEXT
|
|
|-
|[[ISDBSongData::OriginalTitle|OriginalTitle]]
|Property Get/Let
|
|
|OrigTitle
|TEXT
|
|
|-
|[[ISDBSongData::OriginalYear|OriginalYear]]
|Property Get/Let
|
|
|OrigYear[1,4]
|INTEGER
|
|
|-
|[[ISDBSongData::OriginalMonth|OriginalMonth]]
|Property Get/Let
|
|
|OrigYear[5,2]
|INTEGER
|
|
|-
|[[ISDBSongData::OriginalDay|OriginalDay]]
|Property Get/Let
|
|
|OrigYear[7,2]
|INTEGER
|
|
|-
|[[ISDBSongData::ParseText|ParseText]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::ParentalRating|ParentalRating]]
|Property Get/Let
|
|
|ParentalRating
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::Path|Path]]
|Property Get/Let
|
|
|SongPath
|TEXT
|
|
|-
|[[ISDBSongData::SetPathByMask|SetPathByMask]]
|Method
|
|
|SongPath
|TEXT
|
|From MM version 4.1
|-
|[[ISDBSongData::PeakValue|PeakValue]]
|Property Get/Let
|
|
|
|REAL
|
|
|-
|[[ISDBSongData::PlayCounter|PlayCounter]]
|Property Get/Let
|
|
|PlayCounter
|INTEGER
|
|
|-
|[[ISDBSongData::PlaylistOrder|PlaylistOrder]]
|Property Get/Let
|
|
|
|INTEGER
|
|Dynamic Check
|-
|[[ISDBSongData::PostGap|PostGap]]
|Property Get/Let
|
|
|PostGap
|INTEGER
|
|
|-
|[[ISDBSongData::PreGap|PreGap]]
|Property Get/Let
|
|
|PreGap
|INTEGER
|
|
|-
|[[ISDBSongData::Preview|Preview]]
|Property Get
|
|
|
|INTEGER
|
|
|-
|[[ISDBSongData::PreviewPath|PreviewPath]]
|Property Get
|
|
|PreviewName
|TEXT
|
|
|-
|[[ISDBSongData::Producer|Producer]]
|Property Get/Let
|
|
|Producer
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::Publisher|Publisher]]
|Property Get/Let
|
|
|Publisher
|TEXT
|
|
|-
|[[ISDBSongData::Quality|Quality]]
|Property Get/Let
|
|
|Quality
|TEXT
|
|
|-
|[[ISDBSongData::Rating|Rating]]
|Property Get/Let
|
|
|Rating
|INTEGER
|
|
|-
|[[ISDBSongData::RatingString|RatingString]]
|Property Get/Let
|
|
|
|TEXT
|
|Rating (Not Used?)
|-
|[[ISDBSongData::ReadTags|ReadTags]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::ReadTagsAsExt|ReadTagsAsExt]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::RenameByMask|RenameByMask]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::SampleRate|SampleRate]]
|Property Get/Let
|
|
|SamplingFrequency
|INTEGER
|
|
|-
|[[ISDBSongData::Series|Series]]
|Property Get/Let
|
|
|Album
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::SeasonNumber|SeasonNumber]]
|Property Get/Let
|
|
|SeasonNumber
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::SongID|SongID]]
|Property Get
|
|
|
|INTEGER
|
|Internal Use Only
|-
|[[ISDBSongData::SongLength|SongLength]]
|Property Get/Let
|
|
|SongLength
|INTEGER
|
|
|-
|[[ISDBSongData::SongLengthString|SongLengthString]]
|Property Get
|
|
|
|TEXT
|
|SongLength Formatted
|-
|[[ISDBSongData::Tempo|Tempo]]
|Property Get/Let
|
|
|Tempo
|TEXT
|
|
|-
|[[ISDBSongData::Title|Title]]
|Property Get/Let
|
|
|SongTitle
|TEXT
|
|
|-
|[[ISDBSongData::TotalSamples|TotalSamples]]
|Property Get/Let
|
|
|TotalSamples
|INTEGER
|
|
|-
|[[ISDBSongData::TrackOrder|TrackOrder]]
|Property Get/Let
|
|
|
|INTEGER
|
|MM2
|-
|[[ISDBSongData::TrackOrderStr|TrackOrderStr]]
|Property Get/Let
|
|
|TrackNumber (TrackOrder), formatted (may have leading 0)
|TEXT
|
|
|-
|[[ISDBSongData::UpdateAlbum|UpdateAlbum]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::UpdateArtist|UpdateArtist]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::UpdateDB|UpdateDB]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::DiscardChanges|DiscardChanges]]
|Method
|
|
|Reverts changes made before calling UpdateDB
|
|
|From MM version 4.1
|-
|[[ISDBSongData::VBR|VBR]]
|Property Get/Let
|
|
|VBR
|INTEGER
|
|
|-
|[[ISDBSongData::WriteTags|WriteTags]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::Year|Year]]
|Property Get/Let
|
|
|Year[1,4]
|INTEGER
|
|
|-
|[[ISDBSongData::MarkPlayed|MarkPlayed]]
|Method
|
|
|Time
|REAL
|
|From MM version 4.0
|-}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBSongData|{{PAGENAME}}]]

ISDBSongData::PathByMask

2013-09-26T16:25:50Z

Ludek:

{{MethodDeclaration|SDBSongData|ISDBSongData|Property Let PathByMask As String}}

===Property description===

Similar to Path property, but allows you to set path according to Mask. The file itself is moved once UpdateDB is called.

Example script:

<source lang="vb">
Option Explicit

Sub OnStartUp()
Dim oMenuItem

Set oMenuItem = SDB.UI.AddMenuItem(SDB.UI.Menu_Pop_TrackList, 0, 0)
oMenuItem.Caption = "PathByMask"
oMenuItem.OnClickFunc = "Test"
oMenuItem.UseScript = Script.ScriptPath
End Sub

Sub Test(oMenuItem)
Dim oSongData
Set oSongData = SDB.SelectedSongList.Item(0)
oSongData.PathByMask = SDB.Tools.UFText2Mask _
("C:\Music\<Genre>\<Album Artist>\<Album>\<Track#:2> - <Title>")
SDB.MessageBox oSongData.Path, mtInformation, Array(mbOK)
oSongData.DiscardChanges
SDB.MessageBox oSongData.Path, mtInformation, Array(mbOK)
End Sub
</source>

Added in MediaMonkey version 4.1

Note: Can be used also as SetPathByMask() method.

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBSongData|{{PAGENAME}}]]
[[Category:Interface ISDBSongData|{{PAGENAME}}]]

ISDBApplication::RunningAsService

2013-09-26T15:18:36Z

Ludek: Created page with "{{MethodDeclaration|SDBApplication|ISDBApplication|Property Get RunningAsService As Boolean}} ===Property description=== Returns <tt>TRUE</tt> if MediaMonkey is running on back..."

{{MethodDeclaration|SDBApplication|ISDBApplication|Property Get RunningAsService As Boolean}}

===Property description===

Returns <tt>TRUE</tt> if MediaMonkey is running on background as service (the service is installed via Media Sharing -> [Install as Service...] button).

{{Introduced|4.1}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBApplication|{{PAGENAME}}]]
[[Category:Interface ISDBApplication|{{PAGENAME}}]]

SDBApplication

2013-09-26T15:16:21Z

Ludek: /* ISDBApplication members */

{{AutomationObjectsList}}
== CoClass SDBApplication ==

This is the main MediaMonkey scripting object that you initially have accessible as global <tt>SDB</tt> variable in your scripts launched from MediaMonkey. All your communication with MediaMonkey should start here, you can get references to other objects from properties of this object.

Object is exposed to ActiveX under name <tt>SongsDB.SDBApplication</tt>.

Another global variable also accessibl in scripts is <tt>Script</tt>, pointing to [[SDBScriptControl]] object.

=== ISDBApplication members ===

{{MethodsList
|[[ISDBApplication::AllVisibleSongList|AllVisibleSongList]] |Property Get |
|[[ISDBApplication::ApplicationPath|ApplicationPath]] |Property Get |
|[[ISDBApplication::EqualizerPath|EqualizerPath]] |Property Get | From 3.1 beta 1
|[[ISDBApplication::IconsPath|IconsPath]] |Property Get | From 3.1 beta 1
|[[ISDBApplication::PluginsPath|PluginsPath]] |Property Get | From 3.1 beta 1
|[[ISDBApplication::CurrentAddonInstallRoot|CurrentAddonInstallRoot]] |Property Get | From 4.0
|[[ISDBApplication::ScriptsPath|ScriptsPath]] |Property Get | From 3.1 beta 1
|[[ISDBApplication::SkinsPath|SkinsPath]] |Property Get | From 3.1 beta 1
|[[ISDBApplication::CommonDialog|CommonDialog]] |Property Get |
|[[ISDBApplication::CreateTimer|CreateTimer]] |Method |
|[[ISDBApplication::CurrentSongList|CurrentSongList]] |Property Get |
|[[ISDBApplication::CursorType|CursorType]] |Property Get/Let |
|[[ISDBApplication::Database|Database]] |Property Get |
|[[ISDBApplication::Device|Device]] |Property Get |
|[[ISDBApplication::Format|Format]] |Method |
|[[ISDBApplication::IniFile|IniFile]] |Property Get |
|[[ISDBApplication::IsKnownFiletype|IsKnownFiletype]] |Method | From 3.0
|[[ISDBApplication::IsRunning|IsRunning]] |Property Get |
|[[ISDBApplication::InPartyMode|InPartyMode]] |Property Get | From 4.1
|[[ISDBApplication::RunningAsService|RunningAsService]] |Property Get | From 4.1
|[[ISDBApplication::Localize|Localize]] |Method |
|[[ISDBApplication::LocalizedFormat|LocalizedFormat]] |Method |
|[[ISDBApplication::LocalizeGen|LocalizeGen]] |Method |
|[[ISDBApplication::MainTracksWindow|MainTracksWindow]] |Property Get |
|[[ISDBApplication::MainTree|MainTree]] |Property Get |
|[[ISDBApplication::MessageBox|MessageBox]] |Method |
|[[ISDBApplication::MyMusicPath|MyMusicPath]] |Property Get |
|[[ISDBApplication::NewSongData|NewSongData]] |Property Get |
|[[ISDBApplication::NewSongList|NewSongList]] |Property Get |
|[[ISDBApplication::NewStringList|NewStringList]] |Property Get | From 3.0
|[[ISDBApplication::Objects|Objects]] |Property Get/Let |
|[[ISDBApplication::Player|Player]] |Property Get |
|[[ISDBApplication::PlaylistByTitle|PlaylistByTitle]] |Property Get |
|[[ISDBApplication::PlaylistByID|PlaylistByID]] |Property Get | From 4.0
|[[ISDBApplication::ProcessMessages|ProcessMessages]] |Method |
|[[ISDBApplication::Progress|Progress]] |Property Get |
|[[ISDBApplication::RefreshScriptItems|RefreshScriptItems]] |Method | From 3.0
|[[ISDBApplication::RegisterIcon|RegisterIcon]] |Method |
|[[ISDBApplication::RegisterIconHandle|RegisterIconHandle]] |Method |
|[[ISDBApplication::Registry|Registry]] |Property Get |
|[[ISDBApplication::SelectedSongList|SelectedSongList]] |Property Get |
|[[ISDBApplication::SelectFolder|SelectFolder]] |Method |
|[[ISDBApplication::ShutdownAfterDisconnect|ShutdownAfterDisconnect]] |Property Get/Let |
|[[ISDBApplication::TemporaryFolder|TemporaryFolder]] |Property Get |
|[[ISDBApplication::toASCII|toASCII]] |Method |
|[[ISDBApplication::Tools|Tools]] |Property Get |
|[[ISDBApplication::UI|UI]] |Property Get |
|[[ISDBApplication::VersionBuild|VersionBuild]] |Property Get |
|[[ISDBApplication::VersionHi|VersionHi]] |Property Get |
|[[ISDBApplication::VersionLo|VersionLo]] |Property Get |
|[[ISDBApplication::VersionRelease|VersionRelease]] |Property Get |
|[[ISDBApplication::VersionString|VersionString]] |Property Get |
|[[ISDBApplication::ComServerUIActive|ComServerUIActive]] |Property Get/Let |
|[[ISDBApplication::WebControl|WebControl]] |Property Get |
|[[ISDBApplication::Downloader|Downloader]] |Property Get | From 4.0
|[[ISDBApplication::Collections|Collections]] |Property Get | From 4.0
|[[ISDBApplication::VisibleCollectionsCount|VisibleCollectionsCount]] |Property Get | From 4.0
|[[ISDBApplication::VisibleCollectionID|VisibleCollectionID]] |Property Get | From 4.0
}}

=== ISDBApplicationEvents members ===

{{MethodsList
|[[ISDBApplicationEvents::OnBeforeTracksMove|OnBeforeTracksMove]] |Event |
|[[ISDBApplicationEvents::OnChangedSelection|OnChangedSelection]] |Event |
|[[ISDBApplicationEvents::OnCompletePlaybackEnd|OnCompletePlaybackEnd]] |Event | From 4.0
|[[ISDBApplicationEvents::OnDownloadFinished|OnDownloadFinished]] |Event | From 4.0
|[[ISDBApplicationEvents::OnFilterChange|OnFilterChange]] |Event | From 3.1
|[[ISDBApplicationEvents::OnIdle|OnIdle]] |Event | From 3.1
|[[ISDBApplicationEvents::OnNowPlayingModified|OnNowPlayingModified]] |Event | From 3.1
|[[ISDBApplicationEvents::OnNowPlayingSelectionChanged|OnNowPlayingSelectionChanged]] |Event | From 3.1
|[[ISDBApplicationEvents::OnOptionsChange|OnOptionsChange]] |Event | From 3.1
|[[ISDBApplicationEvents::OnPause|OnPause]] |Event |
|[[ISDBApplicationEvents::OnPlay|OnPlay]] |Event |
|[[ISDBApplicationEvents::OnPlaybackEnd|OnPlaybackEnd]] |Event | From 3.1
|[[ISDBApplicationEvents::OnRepeatClicked|OnRepeatClicked]] |Event | From 3.1
|[[ISDBApplicationEvents::OnSeek|OnSeek]] |Event |
|[[ISDBApplicationEvents::OnShuffleClicked|OnShuffleClicked]] |Event | From 3.1
|[[ISDBApplicationEvents::OnShutdown|OnShutdown]] |Event |
|[[ISDBApplicationEvents::OnStop|OnStop]] |Event |
|[[ISDBApplicationEvents::OnTrackAdded|OnTrackAdded]] |Event |
|[[ISDBApplicationEvents::OnTrackConverted|OnTrackConverted]] |Event |
|[[ISDBApplicationEvents::OnTrackDeleting|OnTrackDeleting]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackDoubleClick|OnTrackDoubleClick]] |Event |
|[[ISDBApplicationEvents::OnTrackEnd|OnTrackEnd]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackListFilled|OnTrackListFilled]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackListFilling|OnTrackListFilling]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackListModified|OnTrackListModified]] |Event | From 4.0
|[[ISDBApplicationEvents::OnTrackListSelectionChanged|OnTrackListSelectionChanged]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackProperties|OnTrackProperties]] |Event |
|[[ISDBApplicationEvents::OnTrackSkipped|OnTrackSkipped]] |Event | From 4.0
|[[ISDBApplicationEvents::OnPartyModeEnabled|OnPartyModeEnabled]] |Event | From 4.1
|[[ISDBApplicationEvents::OnDeviceSyncStarted|OnDeviceSyncStarted]] |Event | From 4.1
|[[ISDBApplicationEvents::OnDeviceSyncCompleted|OnDeviceSyncCompleted]] |Event | From 4.1
|[[ISDBApplicationEvents::OnPlaylistAdded|OnPlaylistAdded]] |Event | From 4.1
|[[ISDBApplicationEvents::OnPlaylistRemoved|OnPlaylistRemoved]] |Event | From 4.1
|[[ISDBApplicationEvents::OnPlaylistChanged|OnPlaylistChanged]] |Event | From 4.1
}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBApplication|{{PAGENAME}}]]

ISDBSongData::PathByMask

2013-09-26T12:48:06Z

Ludek: Created page with "{{MethodDeclaration|SDBSongData|ISDBSongData|Property Let PathByMask As String}} ===Property description=== Similar to Path property, but allows you to set path according to Ma..."

{{MethodDeclaration|SDBSongData|ISDBSongData|Property Let PathByMask As String}}

===Property description===

Similar to Path property, but allows you to set path according to Mask. The file itself is moved once UpdateDB is called.

Example script:

<source lang="vb">
Option Explicit

Sub OnStartUp()
Dim oMenuItem

Set oMenuItem = SDB.UI.AddMenuItem(SDB.UI.Menu_Pop_TrackList, 0, 0)
oMenuItem.Caption = "PathByMask"
oMenuItem.OnClickFunc = "Test"
oMenuItem.UseScript = Script.ScriptPath
End Sub

Sub Test(oMenuItem)
Dim oSongData
Set oSongData = SDB.SelectedSongList.Item(0)
oSongData.PathByMask = SDB.Tools.UFText2Mask _
("C:\Music\<Genre>\<Album Artist>\<Album>\<Track#:2> - <Title>")
SDB.MessageBox oSongData.Path, mtInformation, Array(mbOK)
oSongData.DiscardChanges
SDB.MessageBox oSongData.Path, mtInformation, Array(mbOK)
End Sub
</source>

Added in MediaMonkey version 4.1

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBSongData|{{PAGENAME}}]]
[[Category:Interface ISDBSongData|{{PAGENAME}}]]

SDBSongData

2013-09-26T12:40:31Z

Ludek:

{{AutomationObjectsList}}
== CoClass SDBSongData ==

Object with all properties of a track. Corresponding Songs Table columns.

To apply changes made to a SongData object, be sure to call one or more of the methods [[ISDBSongData::UpdateAlbum|UpdateAlbum]], [[ISDBSongData::UpdateArtist|UpdateArtist]], [[ISDBSongData::UpdateDB|UpdateDB]] and/or [[ISDBSongData::WriteTags|WriteTags]]. In some cases, you can call the [[ISDBSongList::UpdateAll|UpdateAll]] method of the SongList object containing the SongData object.

=== ISDBSongData members ===

{| border="1"
|-
! Name
! Type
! Description
!
! Tag Name
! Value Type
! Possible Values
! Description
|-
|[[ISDBSongData::Actors|Actors]]
|Property Get/Let
|
|
|Actors
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::Album|Album]]
|Property Get
|
|
|
|[[SDBAlbum]]
|
|
|-
|[[ISDBSongData::AlbumArt|AlbumArt]]
|Property Get
|
|
|
|[[SDBAlbumArtList]]
|
|
|-
|[[ISDBSongData::AlbumArtistName|AlbumArtistName]]
|Property Get/Let
|
|
|AlbumArtist
|TEXT
|
|
|-
|[[ISDBSongData::AlbumName|AlbumName]]
|Property Get/Let
|
|
|Album
|TEXT
|
|
|-
|[[ISDBSongData::Artist|Artist]]
|Property Get
|
|
|
|[[SDBArtist]]
|
|
|-
|[[ISDBSongData::ArtistName|ArtistName]]
|Property Get/Let
|
|
|Artist
|TEXT
|
|
|-
|[[ISDBSongData::Author|Author]]
|Property Get/Let
|
|
|Author
|TEXT
|
|The Composer of the Song
|-
|[[ISDBSongData::Band|Band]]
|Property Get/Let
|
|
|Band
|TEXT
|
|
|-
|[[ISDBSongData::Bitrate|Bitrate]]
|Property Get/Let
|
|
|Bitrate
|INTEGER
|
|
|-
|[[ISDBSongData::Bookmark|Bookmark]]
|Property Get/Let
|
|
|PlaybackPos
|INTEGER
|
|
|-
|[[ISDBSongData::StartTime|StartTime]]
|Property Get/Let
|
|
|StartTime
|INTEGER
|
|From MM version 4.0
|-
|[[ISDBSongData::StopTime|StopTime]]
|Property Get/Let
|
|
|StopTime
|INTEGER
|
|From MM version 4.0
|-
|[[ISDBSongData::SkipCount|SkipCount]]
|Property Get/Let
|
|
|SkipCount
|INTEGER
|
|From MM version 4.0
|-
|[[ISDBSongData::TrackType|TrackType]]
|Property Get/Let
|
|
|TrackType
|INTEGER
|
|From MM version 4.0
|-
|[[ISDBSongData::BPM|BPM]]
|Property Get/Let
|
|
|BPM
|INTEGER
|
|Beats Per Minute
|-
|[[ISDBSongData::Cached|Cached]]
|Property Get/Let
|
|
|CacheStatus
|INTEGER
|
|
|-
|[[ISDBSongData::CachedPath|CachedPath]]
|Property Get
|
|
|CacheName
|TEXT
|
|
|-
|[[ISDBSongData::CalculateGapData|CalculateGapData]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::canCrossfade|canCrossfade]]
|Property Get/Set
|
|
|
|BOOLEAN
|
|
|-
|[[ISDBSongData::Channels|Channels]]
|Property Get/Let
|
|
|Stereo
|INTEGER
|
|
|-
|[[ISDBSongData::Comment|Comment]]
|Property Get/Let
|
|
|Comment
|TEXT
|
|
|-
|[[ISDBSongData::Conductor|Conductor]]
|Property Get/Let
|
|
|Conductor
|TEXT
|
|
|-
|[[ISDBSongData::Copyright|Copyright]]
|Property Get/Let
|
|
|Copyright
|TEXT
|
|
|-
|[[ISDBSongData::Custom1|Custom1]]
|Property Get/Let
|
|
|Custom1
|TEXT
|
|
|-
|[[ISDBSongData::Custom2|Custom2]]
|Property Get/Let
|
|
|Custom2
|TEXT
|
|
|-
|[[ISDBSongData::Custom3|Custom3]]
|Property Get/Let
|
|
|Custom3
|TEXT
|
|
|-
|[[ISDBSongData::Custom4|Custom4]]
|Property Get/Let
|
|
|Custom4
|TEXT
|
|
|-
|[[ISDBSongData::Custom5|Custom5]]
|Property Get/Let
|
|
|Custom5
|TEXT
|
|
|-
|[[ISDBSongData::Date|Date]]
|Property Get/Let
|
|
|
|[[DateType|DATE]]
|
|
|-
|[[ISDBSongData::DateAdded|DateAdded]]
|Property Get/Let
|
|
|DateAdded
|[[DateType|DATE]]
|
|
|-
|[[ISDBSongData::DateDBModified|DateDBModified]]
|Property Get
|
|
|
|[[DateType|DATE]]
|
|
|-
|[[ISDBSongData::Day|Day]]
|Property Get/Let
|
|
|Year[7,2]
|INTEGER
|
|
|-
|[[ISDBSongData::DiscNumber|DiscNumber]]
|Property Get/Let
|
|
|
|INTEGER
|
|MM2
|-
|[[ISDBSongData::DiscNumberStr|DiscNumberStr]]
|Property Get/Let
|
|
|DiscNumber
|TEXT
|
|
|-
|[[ISDBSongData::Director|Director]]
|Property Get/Let
|
|
|Artist
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::Encoder|Encoder]]
|Property Get/Let
|
|
|Encoder
|TEXT
|
|
|-
|[[ISDBSongData::EpisodeNumber|EpisodeNumber]]
|Property Get/Let
|
|
|EpisodeNumber
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::FileLength|FileLength]]
|Property Get/Let
|
|
|FileLength
|INTEGER
|
|
|-
|[[ISDBSongData::FileModified|FileModified]]
|Property Get/Let
|
|
|FileModified
|REAL
|
|
|-
|[[ISDBSongData::GaplessBytes|GaplessBytes]]
|Property Get/Let
|
|
|GaplessBytes
|INTEGER
|
|
|-
|[[ISDBSongData::Genre|Genre]]
|Property Get/Let
|
|
|Genre
|TEXT
|
|
|-
|[[ISDBSongData::GetCopy|GetCopy]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::Grouping|Grouping]]
|Property Get/Let
|
|
|GroupDesc
|TEXT
|
|
|-
|[[ISDBSongData::ID|ID]]
|Property Get/Let
|
|
|ID
|INTEGER
|AUTOINCREMENT (1 to inf.)
|
|-
|[[ISDBSongData::InvolvedPeople|InvolvedPeople]]
|Property Get/Let
|
|
|InvolvedPeople
|TEXT
|
|
|-
|[[ISDBSongData::isBookmarkable|isBookmarkable]]
|Property Get/Let
|
|
|
|BOOLEAN
|
|
|-
|[[ISDBSongData::isShuffleIgnored|isShuffleIgnored]]
|Property Get/Let
|
|
|
|BOOLEAN
|
|
|-
|[[ISDBSongData::IsntInDB|IsntInDB]]
|Property Get/Let
|
|
|
|BOOLEAN
|
|Dynamic Check
|-
|[[ISDBSongData::ISRC|ISRC]]
|Property Get/Let
|
|
|ISRC
|TEXT
|
|
|-
|[[ISDBSongData::LastPlayed|LastPlayed]]
|Property Get/Let
|
|
|LastTimePlayed
|REAL
|
|
|-
|[[ISDBSongData::Leveling|Leveling]]
|Property Get/Let
|
|
|NormalizeTrack
|REAL
|
|
|-
|[[ISDBSongData::LevelingAlbum|LevelingAlbum]]
|Property Get/Let
|
|
|NormalizeAlbum
|REAL
|
|
|-
|[[ISDBSongData::Lyricist|Lyricist]]
|Property Get/Let
|
|
|Lyricist
|TEXT
|
|
|-
|[[ISDBSongData::Lyrics|Lyrics]]
|Property Get/Let
|
|
|Lyrics
|TEXT
|
|
|-
|[[ISDBSongData::Media|Media]]
|Property Get
|
|
|IDMedia
|INTEGER
|
|
|-
|[[ISDBSongData::MediaLabel|MediaLabel]]
|Property Get
|
|
|
|TEXT
|
|
|-
|[[ISDBSongData::MetadataFromFilename|MetadataFromFilename]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::Month|Month]]
|Property Get/Let
|
|
|Year[5,2]
|INTEGER
|
|
|-
|[[ISDBSongData::Mood|Mood]]
|Property Get/Let
|
|
|Mood
|TEXT
|
|
|-
|[[ISDBSongData::MusicComposer|MusicComposer]]
|Property Get/Let
|
|
|
|TEXT
|
|Use Author
|-
|[[ISDBSongData::Occasion|Occasion]]
|Property Get/Let
|
|
|Occasion
|TEXT
|
|
|-
|[[ISDBSongData::OriginalArtist|OriginalArtist]]
|Property Get/Let
|
|
|OrigArtist
|TEXT
|
|
|-
|[[ISDBSongData::OriginalLyricist|OriginalLyricist]]
|Property Get/Let
|
|
|OrigLyricist
|TEXT
|
|
|-
|[[ISDBSongData::OriginalTitle|OriginalTitle]]
|Property Get/Let
|
|
|OrigTitle
|TEXT
|
|
|-
|[[ISDBSongData::OriginalYear|OriginalYear]]
|Property Get/Let
|
|
|OrigYear[1,4]
|INTEGER
|
|
|-
|[[ISDBSongData::OriginalMonth|OriginalMonth]]
|Property Get/Let
|
|
|OrigYear[5,2]
|INTEGER
|
|
|-
|[[ISDBSongData::OriginalDay|OriginalDay]]
|Property Get/Let
|
|
|OrigYear[7,2]
|INTEGER
|
|
|-
|[[ISDBSongData::ParseText|ParseText]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::ParentalRating|ParentalRating]]
|Property Get/Let
|
|
|ParentalRating
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::Path|Path]]
|Property Get/Let
|
|
|SongPath
|TEXT
|
|
|-
|[[ISDBSongData::PathByMask|PathByMask]]
|Property Let
|
|
|SongPath
|TEXT
|
|From MM version 4.1
|-
|[[ISDBSongData::PeakValue|PeakValue]]
|Property Get/Let
|
|
|
|REAL
|
|
|-
|[[ISDBSongData::PlayCounter|PlayCounter]]
|Property Get/Let
|
|
|PlayCounter
|INTEGER
|
|
|-
|[[ISDBSongData::PlaylistOrder|PlaylistOrder]]
|Property Get/Let
|
|
|
|INTEGER
|
|Dynamic Check
|-
|[[ISDBSongData::PostGap|PostGap]]
|Property Get/Let
|
|
|PostGap
|INTEGER
|
|
|-
|[[ISDBSongData::PreGap|PreGap]]
|Property Get/Let
|
|
|PreGap
|INTEGER
|
|
|-
|[[ISDBSongData::Preview|Preview]]
|Property Get
|
|
|
|INTEGER
|
|
|-
|[[ISDBSongData::PreviewPath|PreviewPath]]
|Property Get
|
|
|PreviewName
|TEXT
|
|
|-
|[[ISDBSongData::Producer|Producer]]
|Property Get/Let
|
|
|Producer
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::Publisher|Publisher]]
|Property Get/Let
|
|
|Publisher
|TEXT
|
|
|-
|[[ISDBSongData::Quality|Quality]]
|Property Get/Let
|
|
|Quality
|TEXT
|
|
|-
|[[ISDBSongData::Rating|Rating]]
|Property Get/Let
|
|
|Rating
|INTEGER
|
|
|-
|[[ISDBSongData::RatingString|RatingString]]
|Property Get/Let
|
|
|
|TEXT
|
|Rating (Not Used?)
|-
|[[ISDBSongData::ReadTags|ReadTags]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::ReadTagsAsExt|ReadTagsAsExt]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::RenameByMask|RenameByMask]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::SampleRate|SampleRate]]
|Property Get/Let
|
|
|SamplingFrequency
|INTEGER
|
|
|-
|[[ISDBSongData::Series|Series]]
|Property Get/Let
|
|
|Album
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::SeasonNumber|SeasonNumber]]
|Property Get/Let
|
|
|SeasonNumber
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::SongID|SongID]]
|Property Get
|
|
|
|INTEGER
|
|Internal Use Only
|-
|[[ISDBSongData::SongLength|SongLength]]
|Property Get/Let
|
|
|SongLength
|INTEGER
|
|
|-
|[[ISDBSongData::SongLengthString|SongLengthString]]
|Property Get
|
|
|
|TEXT
|
|SongLength Formatted
|-
|[[ISDBSongData::Tempo|Tempo]]
|Property Get/Let
|
|
|Tempo
|TEXT
|
|
|-
|[[ISDBSongData::Title|Title]]
|Property Get/Let
|
|
|SongTitle
|TEXT
|
|
|-
|[[ISDBSongData::TotalSamples|TotalSamples]]
|Property Get/Let
|
|
|TotalSamples
|INTEGER
|
|
|-
|[[ISDBSongData::TrackOrder|TrackOrder]]
|Property Get/Let
|
|
|
|INTEGER
|
|MM2
|-
|[[ISDBSongData::TrackOrderStr|TrackOrderStr]]
|Property Get/Let
|
|
|TrackNumber (TrackOrder), formatted (may have leading 0)
|TEXT
|
|
|-
|[[ISDBSongData::UpdateAlbum|UpdateAlbum]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::UpdateArtist|UpdateArtist]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::UpdateDB|UpdateDB]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::DiscardChanges|DiscardChanges]]
|Method
|
|
|Reverts changes made before calling UpdateDB
|
|
|From MM version 4.1
|-
|[[ISDBSongData::VBR|VBR]]
|Property Get/Let
|
|
|VBR
|INTEGER
|
|
|-
|[[ISDBSongData::WriteTags|WriteTags]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::Year|Year]]
|Property Get/Let
|
|
|Year[1,4]
|INTEGER
|
|
|-
|[[ISDBSongData::MarkPlayed|MarkPlayed]]
|Method
|
|
|Time
|REAL
|
|From MM version 4.0
|-}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBSongData|{{PAGENAME}}]]

SDBSongData

2013-08-14T16:30:07Z

Ludek: /* ISDBSongData members */

{{AutomationObjectsList}}
== CoClass SDBSongData ==

Object with all properties of a track. Corresponding Songs Table columns.

To apply changes made to a SongData object, be sure to call one or more of the methods [[ISDBSongData::UpdateAlbum|UpdateAlbum]], [[ISDBSongData::UpdateArtist|UpdateArtist]], [[ISDBSongData::UpdateDB|UpdateDB]] and/or [[ISDBSongData::WriteTags|WriteTags]]. In some cases, you can call the [[ISDBSongList::UpdateAll|UpdateAll]] method of the SongList object containing the SongData object.

=== ISDBSongData members ===

{| border="1"
|-
! Name
! Type
! Description
!
! Tag Name
! Value Type
! Possible Values
! Description
|-
|[[ISDBSongData::Actors|Actors]]
|Property Get/Let
|
|
|Actors
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::Album|Album]]
|Property Get
|
|
|
|[[SDBAlbum]]
|
|
|-
|[[ISDBSongData::AlbumArt|AlbumArt]]
|Property Get
|
|
|
|[[SDBAlbumArtList]]
|
|
|-
|[[ISDBSongData::AlbumArtistName|AlbumArtistName]]
|Property Get/Let
|
|
|AlbumArtist
|TEXT
|
|
|-
|[[ISDBSongData::AlbumName|AlbumName]]
|Property Get/Let
|
|
|Album
|TEXT
|
|
|-
|[[ISDBSongData::Artist|Artist]]
|Property Get
|
|
|
|[[SDBArtist]]
|
|
|-
|[[ISDBSongData::ArtistName|ArtistName]]
|Property Get/Let
|
|
|Artist
|TEXT
|
|
|-
|[[ISDBSongData::Author|Author]]
|Property Get/Let
|
|
|Author
|TEXT
|
|The Composer of the Song
|-
|[[ISDBSongData::Band|Band]]
|Property Get/Let
|
|
|Band
|TEXT
|
|
|-
|[[ISDBSongData::Bitrate|Bitrate]]
|Property Get/Let
|
|
|Bitrate
|INTEGER
|
|
|-
|[[ISDBSongData::Bookmark|Bookmark]]
|Property Get/Let
|
|
|PlaybackPos
|INTEGER
|
|
|-
|[[ISDBSongData::StartTime|StartTime]]
|Property Get/Let
|
|
|StartTime
|INTEGER
|
|From MM version 4.0
|-
|[[ISDBSongData::StopTime|StopTime]]
|Property Get/Let
|
|
|StopTime
|INTEGER
|
|From MM version 4.0
|-
|[[ISDBSongData::SkipCount|SkipCount]]
|Property Get/Let
|
|
|SkipCount
|INTEGER
|
|From MM version 4.0
|-
|[[ISDBSongData::TrackType|TrackType]]
|Property Get/Let
|
|
|TrackType
|INTEGER
|
|From MM version 4.0
|-
|[[ISDBSongData::BPM|BPM]]
|Property Get/Let
|
|
|BPM
|INTEGER
|
|Beats Per Minute
|-
|[[ISDBSongData::Cached|Cached]]
|Property Get/Let
|
|
|CacheStatus
|INTEGER
|
|
|-
|[[ISDBSongData::CachedPath|CachedPath]]
|Property Get
|
|
|CacheName
|TEXT
|
|
|-
|[[ISDBSongData::CalculateGapData|CalculateGapData]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::canCrossfade|canCrossfade]]
|Property Get/Set
|
|
|
|BOOLEAN
|
|
|-
|[[ISDBSongData::Channels|Channels]]
|Property Get/Let
|
|
|Stereo
|INTEGER
|
|
|-
|[[ISDBSongData::Comment|Comment]]
|Property Get/Let
|
|
|Comment
|TEXT
|
|
|-
|[[ISDBSongData::Conductor|Conductor]]
|Property Get/Let
|
|
|Conductor
|TEXT
|
|
|-
|[[ISDBSongData::Copyright|Copyright]]
|Property Get/Let
|
|
|Copyright
|TEXT
|
|
|-
|[[ISDBSongData::Custom1|Custom1]]
|Property Get/Let
|
|
|Custom1
|TEXT
|
|
|-
|[[ISDBSongData::Custom2|Custom2]]
|Property Get/Let
|
|
|Custom2
|TEXT
|
|
|-
|[[ISDBSongData::Custom3|Custom3]]
|Property Get/Let
|
|
|Custom3
|TEXT
|
|
|-
|[[ISDBSongData::Custom4|Custom4]]
|Property Get/Let
|
|
|Custom4
|TEXT
|
|
|-
|[[ISDBSongData::Custom5|Custom5]]
|Property Get/Let
|
|
|Custom5
|TEXT
|
|
|-
|[[ISDBSongData::Date|Date]]
|Property Get/Let
|
|
|
|[[DateType|DATE]]
|
|
|-
|[[ISDBSongData::DateAdded|DateAdded]]
|Property Get/Let
|
|
|DateAdded
|[[DateType|DATE]]
|
|
|-
|[[ISDBSongData::DateDBModified|DateDBModified]]
|Property Get
|
|
|
|[[DateType|DATE]]
|
|
|-
|[[ISDBSongData::Day|Day]]
|Property Get/Let
|
|
|Year[7,2]
|INTEGER
|
|
|-
|[[ISDBSongData::DiscNumber|DiscNumber]]
|Property Get/Let
|
|
|
|INTEGER
|
|MM2
|-
|[[ISDBSongData::DiscNumberStr|DiscNumberStr]]
|Property Get/Let
|
|
|DiscNumber
|TEXT
|
|
|-
|[[ISDBSongData::Director|Director]]
|Property Get/Let
|
|
|Artist
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::Encoder|Encoder]]
|Property Get/Let
|
|
|Encoder
|TEXT
|
|
|-
|[[ISDBSongData::EpisodeNumber|EpisodeNumber]]
|Property Get/Let
|
|
|EpisodeNumber
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::FileLength|FileLength]]
|Property Get/Let
|
|
|FileLength
|INTEGER
|
|
|-
|[[ISDBSongData::FileModified|FileModified]]
|Property Get/Let
|
|
|FileModified
|REAL
|
|
|-
|[[ISDBSongData::GaplessBytes|GaplessBytes]]
|Property Get/Let
|
|
|GaplessBytes
|INTEGER
|
|
|-
|[[ISDBSongData::Genre|Genre]]
|Property Get/Let
|
|
|Genre
|TEXT
|
|
|-
|[[ISDBSongData::GetCopy|GetCopy]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::Grouping|Grouping]]
|Property Get/Let
|
|
|GroupDesc
|TEXT
|
|
|-
|[[ISDBSongData::ID|ID]]
|Property Get/Let
|
|
|ID
|INTEGER
|AUTOINCREMENT (1 to inf.)
|
|-
|[[ISDBSongData::InvolvedPeople|InvolvedPeople]]
|Property Get/Let
|
|
|InvolvedPeople
|TEXT
|
|
|-
|[[ISDBSongData::isBookmarkable|isBookmarkable]]
|Property Get/Let
|
|
|
|BOOLEAN
|
|
|-
|[[ISDBSongData::isShuffleIgnored|isShuffleIgnored]]
|Property Get/Let
|
|
|
|BOOLEAN
|
|
|-
|[[ISDBSongData::IsntInDB|IsntInDB]]
|Property Get/Let
|
|
|
|BOOLEAN
|
|Dynamic Check
|-
|[[ISDBSongData::ISRC|ISRC]]
|Property Get/Let
|
|
|ISRC
|TEXT
|
|
|-
|[[ISDBSongData::LastPlayed|LastPlayed]]
|Property Get/Let
|
|
|LastTimePlayed
|REAL
|
|
|-
|[[ISDBSongData::Leveling|Leveling]]
|Property Get/Let
|
|
|NormalizeTrack
|REAL
|
|
|-
|[[ISDBSongData::LevelingAlbum|LevelingAlbum]]
|Property Get/Let
|
|
|NormalizeAlbum
|REAL
|
|
|-
|[[ISDBSongData::Lyricist|Lyricist]]
|Property Get/Let
|
|
|Lyricist
|TEXT
|
|
|-
|[[ISDBSongData::Lyrics|Lyrics]]
|Property Get/Let
|
|
|Lyrics
|TEXT
|
|
|-
|[[ISDBSongData::Media|Media]]
|Property Get
|
|
|IDMedia
|INTEGER
|
|
|-
|[[ISDBSongData::MediaLabel|MediaLabel]]
|Property Get
|
|
|
|TEXT
|
|
|-
|[[ISDBSongData::MetadataFromFilename|MetadataFromFilename]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::Month|Month]]
|Property Get/Let
|
|
|Year[5,2]
|INTEGER
|
|
|-
|[[ISDBSongData::Mood|Mood]]
|Property Get/Let
|
|
|Mood
|TEXT
|
|
|-
|[[ISDBSongData::MusicComposer|MusicComposer]]
|Property Get/Let
|
|
|
|TEXT
|
|Use Author
|-
|[[ISDBSongData::Occasion|Occasion]]
|Property Get/Let
|
|
|Occasion
|TEXT
|
|
|-
|[[ISDBSongData::OriginalArtist|OriginalArtist]]
|Property Get/Let
|
|
|OrigArtist
|TEXT
|
|
|-
|[[ISDBSongData::OriginalLyricist|OriginalLyricist]]
|Property Get/Let
|
|
|OrigLyricist
|TEXT
|
|
|-
|[[ISDBSongData::OriginalTitle|OriginalTitle]]
|Property Get/Let
|
|
|OrigTitle
|TEXT
|
|
|-
|[[ISDBSongData::OriginalYear|OriginalYear]]
|Property Get/Let
|
|
|OrigYear[1,4]
|INTEGER
|
|
|-
|[[ISDBSongData::OriginalMonth|OriginalMonth]]
|Property Get/Let
|
|
|OrigYear[5,2]
|INTEGER
|
|
|-
|[[ISDBSongData::OriginalDay|OriginalDay]]
|Property Get/Let
|
|
|OrigYear[7,2]
|INTEGER
|
|
|-
|[[ISDBSongData::ParseText|ParseText]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::ParentalRating|ParentalRating]]
|Property Get/Let
|
|
|ParentalRating
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::Path|Path]]
|Property Get/Let
|
|
|SongPath
|TEXT
|
|
|-
|[[ISDBSongData::PeakValue|PeakValue]]
|Property Get/Let
|
|
|
|REAL
|
|
|-
|[[ISDBSongData::PlayCounter|PlayCounter]]
|Property Get/Let
|
|
|PlayCounter
|INTEGER
|
|
|-
|[[ISDBSongData::PlaylistOrder|PlaylistOrder]]
|Property Get/Let
|
|
|
|INTEGER
|
|Dynamic Check
|-
|[[ISDBSongData::PostGap|PostGap]]
|Property Get/Let
|
|
|PostGap
|INTEGER
|
|
|-
|[[ISDBSongData::PreGap|PreGap]]
|Property Get/Let
|
|
|PreGap
|INTEGER
|
|
|-
|[[ISDBSongData::Preview|Preview]]
|Property Get
|
|
|
|INTEGER
|
|
|-
|[[ISDBSongData::PreviewPath|PreviewPath]]
|Property Get
|
|
|PreviewName
|TEXT
|
|
|-
|[[ISDBSongData::Producer|Producer]]
|Property Get/Let
|
|
|Producer
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::Publisher|Publisher]]
|Property Get/Let
|
|
|Publisher
|TEXT
|
|
|-
|[[ISDBSongData::Quality|Quality]]
|Property Get/Let
|
|
|Quality
|TEXT
|
|
|-
|[[ISDBSongData::Rating|Rating]]
|Property Get/Let
|
|
|Rating
|INTEGER
|
|
|-
|[[ISDBSongData::RatingString|RatingString]]
|Property Get/Let
|
|
|
|TEXT
|
|Rating (Not Used?)
|-
|[[ISDBSongData::ReadTags|ReadTags]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::ReadTagsAsExt|ReadTagsAsExt]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::RenameByMask|RenameByMask]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::SampleRate|SampleRate]]
|Property Get/Let
|
|
|SamplingFrequency
|INTEGER
|
|
|-
|[[ISDBSongData::Series|Series]]
|Property Get/Let
|
|
|Album
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::SeasonNumber|SeasonNumber]]
|Property Get/Let
|
|
|SeasonNumber
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::SongID|SongID]]
|Property Get
|
|
|
|INTEGER
|
|Internal Use Only
|-
|[[ISDBSongData::SongLength|SongLength]]
|Property Get/Let
|
|
|SongLength
|INTEGER
|
|
|-
|[[ISDBSongData::SongLengthString|SongLengthString]]
|Property Get
|
|
|
|TEXT
|
|SongLength Formatted
|-
|[[ISDBSongData::Tempo|Tempo]]
|Property Get/Let
|
|
|Tempo
|TEXT
|
|
|-
|[[ISDBSongData::Title|Title]]
|Property Get/Let
|
|
|SongTitle
|TEXT
|
|
|-
|[[ISDBSongData::TotalSamples|TotalSamples]]
|Property Get/Let
|
|
|TotalSamples
|INTEGER
|
|
|-
|[[ISDBSongData::TrackOrder|TrackOrder]]
|Property Get/Let
|
|
|
|INTEGER
|
|MM2
|-
|[[ISDBSongData::TrackOrderStr|TrackOrderStr]]
|Property Get/Let
|
|
|TrackNumber (TrackOrder), formatted (may have leading 0)
|TEXT
|
|
|-
|[[ISDBSongData::UpdateAlbum|UpdateAlbum]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::UpdateArtist|UpdateArtist]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::UpdateDB|UpdateDB]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::DiscardChanges|DiscardChanges]]
|Method
|
|
|Reverts changes made before calling UpdateDB
|
|
|From MM version 4.1
|-
|[[ISDBSongData::VBR|VBR]]
|Property Get/Let
|
|
|VBR
|INTEGER
|
|
|-
|[[ISDBSongData::WriteTags|WriteTags]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::Year|Year]]
|Property Get/Let
|
|
|Year[1,4]
|INTEGER
|
|
|-
|[[ISDBSongData::MarkPlayed|MarkPlayed]]
|Method
|
|
|Time
|REAL
|
|From MM version 4.0
|-}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBSongData|{{PAGENAME}}]]

SDBSongData

2013-08-14T16:23:47Z

Ludek: /* ISDBSongData members */

{{AutomationObjectsList}}
== CoClass SDBSongData ==

Object with all properties of a track. Corresponding Songs Table columns.

To apply changes made to a SongData object, be sure to call one or more of the methods [[ISDBSongData::UpdateAlbum|UpdateAlbum]], [[ISDBSongData::UpdateArtist|UpdateArtist]], [[ISDBSongData::UpdateDB|UpdateDB]] and/or [[ISDBSongData::WriteTags|WriteTags]]. In some cases, you can call the [[ISDBSongList::UpdateAll|UpdateAll]] method of the SongList object containing the SongData object.

=== ISDBSongData members ===

{| border="1"
|-
! Name
! Type
! Description
!
! Tag Name
! Value Type
! Possible Values
! Description
|-
|[[ISDBSongData::Album|Album]]
|Property Get
|
|
|
|[[SDBAlbum]]
|
|
|-
|[[ISDBSongData::AlbumArt|AlbumArt]]
|Property Get
|
|
|
|[[SDBAlbumArtList]]
|
|
|-
|[[ISDBSongData::AlbumArtistName|AlbumArtistName]]
|Property Get/Let
|
|
|AlbumArtist
|TEXT
|
|
|-
|[[ISDBSongData::AlbumName|AlbumName]]
|Property Get/Let
|
|
|Album
|TEXT
|
|
|-
|[[ISDBSongData::Artist|Artist]]
|Property Get
|
|
|
|[[SDBArtist]]
|
|
|-
|[[ISDBSongData::ArtistName|ArtistName]]
|Property Get/Let
|
|
|Artist
|TEXT
|
|
|-
|[[ISDBSongData::Author|Author]]
|Property Get/Let
|
|
|Author
|TEXT
|
|The Composer of the Song
|-
|[[ISDBSongData::Band|Band]]
|Property Get/Let
|
|
|Band
|TEXT
|
|
|-
|[[ISDBSongData::Bitrate|Bitrate]]
|Property Get/Let
|
|
|Bitrate
|INTEGER
|
|
|-
|[[ISDBSongData::Bookmark|Bookmark]]
|Property Get/Let
|
|
|PlaybackPos
|INTEGER
|
|
|-
|[[ISDBSongData::StartTime|StartTime]]
|Property Get/Let
|
|
|StartTime
|INTEGER
|
|From MM version 4.0
|-
|[[ISDBSongData::StopTime|StopTime]]
|Property Get/Let
|
|
|StopTime
|INTEGER
|
|From MM version 4.0
|-
|[[ISDBSongData::SkipCount|SkipCount]]
|Property Get/Let
|
|
|SkipCount
|INTEGER
|
|From MM version 4.0
|-
|[[ISDBSongData::TrackType|TrackType]]
|Property Get/Let
|
|
|TrackType
|INTEGER
|
|From MM version 4.0
|-
|[[ISDBSongData::BPM|BPM]]
|Property Get/Let
|
|
|BPM
|INTEGER
|
|Beats Per Minute
|-
|[[ISDBSongData::Cached|Cached]]
|Property Get/Let
|
|
|CacheStatus
|INTEGER
|
|
|-
|[[ISDBSongData::CachedPath|CachedPath]]
|Property Get
|
|
|CacheName
|TEXT
|
|
|-
|[[ISDBSongData::CalculateGapData|CalculateGapData]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::canCrossfade|canCrossfade]]
|Property Get/Set
|
|
|
|BOOLEAN
|
|
|-
|[[ISDBSongData::Channels|Channels]]
|Property Get/Let
|
|
|Stereo
|INTEGER
|
|
|-
|[[ISDBSongData::Comment|Comment]]
|Property Get/Let
|
|
|Comment
|TEXT
|
|
|-
|[[ISDBSongData::Conductor|Conductor]]
|Property Get/Let
|
|
|Conductor
|TEXT
|
|
|-
|[[ISDBSongData::Copyright|Copyright]]
|Property Get/Let
|
|
|Copyright
|TEXT
|
|
|-
|[[ISDBSongData::Custom1|Custom1]]
|Property Get/Let
|
|
|Custom1
|TEXT
|
|
|-
|[[ISDBSongData::Custom2|Custom2]]
|Property Get/Let
|
|
|Custom2
|TEXT
|
|
|-
|[[ISDBSongData::Custom3|Custom3]]
|Property Get/Let
|
|
|Custom3
|TEXT
|
|
|-
|[[ISDBSongData::Custom4|Custom4]]
|Property Get/Let
|
|
|Custom4
|TEXT
|
|
|-
|[[ISDBSongData::Custom5|Custom5]]
|Property Get/Let
|
|
|Custom5
|TEXT
|
|
|-
|[[ISDBSongData::Date|Date]]
|Property Get/Let
|
|
|
|[[DateType|DATE]]
|
|
|-
|[[ISDBSongData::DateAdded|DateAdded]]
|Property Get/Let
|
|
|DateAdded
|[[DateType|DATE]]
|
|
|-
|[[ISDBSongData::DateDBModified|DateDBModified]]
|Property Get
|
|
|
|[[DateType|DATE]]
|
|
|-
|[[ISDBSongData::Day|Day]]
|Property Get/Let
|
|
|Year[7,2]
|INTEGER
|
|
|-
|[[ISDBSongData::DiscNumber|DiscNumber]]
|Property Get/Let
|
|
|
|INTEGER
|
|MM2
|-
|[[ISDBSongData::DiscNumberStr|DiscNumberStr]]
|Property Get/Let
|
|
|DiscNumber
|TEXT
|
|
|-
|[[ISDBSongData::Encoder|Encoder]]
|Property Get/Let
|
|
|Encoder
|TEXT
|
|
|-
|[[ISDBSongData::FileLength|FileLength]]
|Property Get/Let
|
|
|FileLength
|INTEGER
|
|
|-
|[[ISDBSongData::FileModified|FileModified]]
|Property Get/Let
|
|
|FileModified
|REAL
|
|
|-
|[[ISDBSongData::GaplessBytes|GaplessBytes]]
|Property Get/Let
|
|
|GaplessBytes
|INTEGER
|
|
|-
|[[ISDBSongData::Genre|Genre]]
|Property Get/Let
|
|
|Genre
|TEXT
|
|
|-
|[[ISDBSongData::GetCopy|GetCopy]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::Grouping|Grouping]]
|Property Get/Let
|
|
|GroupDesc
|TEXT
|
|
|-
|[[ISDBSongData::ID|ID]]
|Property Get/Let
|
|
|ID
|INTEGER
|AUTOINCREMENT (1 to inf.)
|
|-
|[[ISDBSongData::InvolvedPeople|InvolvedPeople]]
|Property Get/Let
|
|
|InvolvedPeople
|TEXT
|
|
|-
|[[ISDBSongData::isBookmarkable|isBookmarkable]]
|Property Get/Let
|
|
|
|BOOLEAN
|
|
|-
|[[ISDBSongData::isShuffleIgnored|isShuffleIgnored]]
|Property Get/Let
|
|
|
|BOOLEAN
|
|
|-
|[[ISDBSongData::IsntInDB|IsntInDB]]
|Property Get/Let
|
|
|
|BOOLEAN
|
|Dynamic Check
|-
|[[ISDBSongData::ISRC|ISRC]]
|Property Get/Let
|
|
|ISRC
|TEXT
|
|
|-
|[[ISDBSongData::LastPlayed|LastPlayed]]
|Property Get/Let
|
|
|LastTimePlayed
|REAL
|
|
|-
|[[ISDBSongData::Leveling|Leveling]]
|Property Get/Let
|
|
|NormalizeTrack
|REAL
|
|
|-
|[[ISDBSongData::LevelingAlbum|LevelingAlbum]]
|Property Get/Let
|
|
|NormalizeAlbum
|REAL
|
|
|-
|[[ISDBSongData::Lyricist|Lyricist]]
|Property Get/Let
|
|
|Lyricist
|TEXT
|
|
|-
|[[ISDBSongData::Lyrics|Lyrics]]
|Property Get/Let
|
|
|Lyrics
|TEXT
|
|
|-
|[[ISDBSongData::Media|Media]]
|Property Get
|
|
|IDMedia
|INTEGER
|
|
|-
|[[ISDBSongData::MediaLabel|MediaLabel]]
|Property Get
|
|
|
|TEXT
|
|
|-
|[[ISDBSongData::MetadataFromFilename|MetadataFromFilename]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::Month|Month]]
|Property Get/Let
|
|
|Year[5,2]
|INTEGER
|
|
|-
|[[ISDBSongData::Mood|Mood]]
|Property Get/Let
|
|
|Mood
|TEXT
|
|
|-
|[[ISDBSongData::MusicComposer|MusicComposer]]
|Property Get/Let
|
|
|
|TEXT
|
|Use Author
|-
|[[ISDBSongData::Occasion|Occasion]]
|Property Get/Let
|
|
|Occasion
|TEXT
|
|
|-
|[[ISDBSongData::OriginalArtist|OriginalArtist]]
|Property Get/Let
|
|
|OrigArtist
|TEXT
|
|
|-
|[[ISDBSongData::OriginalLyricist|OriginalLyricist]]
|Property Get/Let
|
|
|OrigLyricist
|TEXT
|
|
|-
|[[ISDBSongData::OriginalTitle|OriginalTitle]]
|Property Get/Let
|
|
|OrigTitle
|TEXT
|
|
|-
|[[ISDBSongData::OriginalYear|OriginalYear]]
|Property Get/Let
|
|
|OrigYear[1,4]
|INTEGER
|
|
|-
|[[ISDBSongData::OriginalMonth|OriginalMonth]]
|Property Get/Let
|
|
|OrigYear[5,2]
|INTEGER
|
|
|-
|[[ISDBSongData::OriginalDay|OriginalDay]]
|Property Get/Let
|
|
|OrigYear[7,2]
|INTEGER
|
|
|-
|[[ISDBSongData::ParseText|ParseText]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::Path|Path]]
|Property Get/Let
|
|
|SongPath
|TEXT
|
|
|-
|[[ISDBSongData::PeakValue|PeakValue]]
|Property Get/Let
|
|
|
|REAL
|
|
|-
|[[ISDBSongData::PlayCounter|PlayCounter]]
|Property Get/Let
|
|
|PlayCounter
|INTEGER
|
|
|-
|[[ISDBSongData::PlaylistOrder|PlaylistOrder]]
|Property Get/Let
|
|
|
|INTEGER
|
|Dynamic Check
|-
|[[ISDBSongData::PostGap|PostGap]]
|Property Get/Let
|
|
|PostGap
|INTEGER
|
|
|-
|[[ISDBSongData::PreGap|PreGap]]
|Property Get/Let
|
|
|PreGap
|INTEGER
|
|
|-
|[[ISDBSongData::Preview|Preview]]
|Property Get
|
|
|
|INTEGER
|
|
|-
|[[ISDBSongData::PreviewPath|PreviewPath]]
|Property Get
|
|
|PreviewName
|TEXT
|
|
|-
|[[ISDBSongData::Publisher|Publisher]]
|Property Get/Let
|
|
|Publisher
|TEXT
|
|
|-
|[[ISDBSongData::Quality|Quality]]
|Property Get/Let
|
|
|Quality
|TEXT
|
|
|-
|[[ISDBSongData::Rating|Rating]]
|Property Get/Let
|
|
|Rating
|INTEGER
|
|
|-
|[[ISDBSongData::RatingString|RatingString]]
|Property Get/Let
|
|
|
|TEXT
|
|Rating (Not Used?)
|-
|[[ISDBSongData::ReadTags|ReadTags]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::ReadTagsAsExt|ReadTagsAsExt]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::RenameByMask|RenameByMask]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::SampleRate|SampleRate]]
|Property Get/Let
|
|
|SamplingFrequency
|INTEGER
|
|
|-
|[[ISDBSongData::SongID|SongID]]
|Property Get
|
|
|
|INTEGER
|
|Internal Use Only
|-
|[[ISDBSongData::SongLength|SongLength]]
|Property Get/Let
|
|
|SongLength
|INTEGER
|
|
|-
|[[ISDBSongData::SongLengthString|SongLengthString]]
|Property Get
|
|
|
|TEXT
|
|SongLength Formatted
|-
|[[ISDBSongData::Tempo|Tempo]]
|Property Get/Let
|
|
|Tempo
|TEXT
|
|
|-
|[[ISDBSongData::Title|Title]]
|Property Get/Let
|
|
|SongTitle
|TEXT
|
|
|-
|[[ISDBSongData::TotalSamples|TotalSamples]]
|Property Get/Let
|
|
|TotalSamples
|INTEGER
|
|
|-
|[[ISDBSongData::TrackOrder|TrackOrder]]
|Property Get/Let
|
|
|
|INTEGER
|
|MM2
|-
|[[ISDBSongData::TrackOrderStr|TrackOrderStr]]
|Property Get/Let
|
|
|TrackNumber (TrackOrder), formatted (may have leading 0)
|TEXT
|
|
|-
|[[ISDBSongData::UpdateAlbum|UpdateAlbum]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::UpdateArtist|UpdateArtist]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::UpdateDB|UpdateDB]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::DiscardChanges|DiscardChanges]]
|Method
|
|
|Reverts changes made before calling UpdateDB
|
|
|From MM version 4.1
|-
|[[ISDBSongData::VBR|VBR]]
|Property Get/Let
|
|
|VBR
|INTEGER
|
|
|-
|[[ISDBSongData::WriteTags|WriteTags]]
|Method
|
|
|
|
|
|
|-
|[[ISDBSongData::Year|Year]]
|Property Get/Let
|
|
|Year[1,4]
|INTEGER
|
|
|-
|[[ISDBSongData::MarkPlayed|MarkPlayed]]
|Method
|
|
|Time
|REAL
|
|From MM version 4.0
|-
|[[ISDBSongData::Series|Series]]
|Property Get/Let
|
|
|Album
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::Director|Director]]
|Property Get/Let
|
|
|Artist
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::Producer|Producer]]
|Property Get/Let
|
|
|Producer
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::Actors|Actors]]
|Property Get/Let
|
|
|Actors
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::ParentalRating|ParentalRating]]
|Property Get/Let
|
|
|ParentalRating
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::EpisodeNumber|EpisodeNumber]]
|Property Get/Let
|
|
|EpisodeNumber
|TEXT
|
|From MM version 4.0
|-
|[[ISDBSongData::SeasonNumber|SeasonNumber]]
|Property Get/Let
|
|
|SeasonNumber
|TEXT
|
|From MM version 4.0
|-
}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBSongData|{{PAGENAME}}]]

ISDBPlaylist::ChildPlaylistExists

2013-07-26T14:40:47Z

Ludek:

{{MethodDeclaration|SDBPlaylist|ISDBPlaylist|Function ChildPlaylistExists(Title As String) As Boolean}}

===Parameters===

{{MethodParameters
|Title |String |Title of the child playlist}}

===Method description===

Returns true if a sub-playlist of the given Title exists.

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBPlaylist|{{PAGENAME}}]]
[[Category:Interface ISDBPlaylist|{{PAGENAME}}]]

ISDBPlaylist::ChildPlaylistExists

2013-07-26T14:38:53Z

Ludek: Created page with "===Parameters=== {{MethodParameters |Title |String |Title of the child playlist}} ===Method description=== Returns true if a sub-playlist of the given Title exists. [[Cate..."

===Parameters===

{{MethodParameters
|Title |String |Title of the child playlist}}

===Method description===

Returns true if a sub-playlist of the given Title exists.

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBPlaylist|{{PAGENAME}}]]
[[Category:Interface ISDBPlaylist|{{PAGENAME}}]]

SDBPlaylist

2013-07-26T14:37:19Z

Ludek: /* ISDBPlaylist members */

{{AutomationObjectsList}}
== CoClass SDBPlaylist ==

Object represents a playlist and allows its manipulations including adding or removing tracks and querying child playlists. Playlists are stored in a tree structure. Root playlist can be retrieved using [[ISDBApplication::PlaylistByID|SDB.PlaylistByID]] method.

=== ISDBPlaylist members ===

{{MethodsList
|[[ISDBPlaylist::AddTrack|AddTrack]] |Method |
|[[ISDBPlaylist::InsertTrack|InsertTrack]] |Method |
|[[ISDBPlaylist::AddTrackById|AddTrackById]] |Method |
|[[ISDBPlaylist::AddTracks|AddTracks]] |Method | Buggy before 3.0
|[[ISDBPlaylist::InsertTracks|InsertTracks]] |Method | From 4.0
|[[ISDBPlaylist::ChildPlaylists|ChildPlaylists]] |Property Get |
|[[ISDBPlaylist::Clear|Clear]] |Method |
|[[ISDBPlaylist::CreateChildPlaylist|CreateChildPlaylist]] |Method |
|[[ISDBPlaylist::ChildPlaylistExists|ChildPlaylistExists]] |Method | From 4.1
|[[ISDBPlaylist::Delete|Delete]] |Method |
|[[ISDBPlaylist::ID|ID]] |Property Get |
|[[ISDBPlaylist::isAutoplaylist|isAutoplaylist]] |Property Get |
|[[ISDBPlaylist::MoveTrack|MoveTrack]] |Method |
|[[ISDBPlaylist::RemoveTrack|RemoveTrack]] |Method |
|[[ISDBPlaylist::RemoveTrackNoConfirmation|RemoveTrackNoConfirmation]] |Method | From 4.0
|[[ISDBPlaylist::Title|Title]] |Property Get/Let |
|[[ISDBPlaylist::Tracks|Tracks]] |Property Get |
|[[ISDBPlaylist::LastModified|LastModified]] |Property Get | From 4.1
}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBPlaylist|{{PAGENAME}}]]

ISDBPlaylist::CreateChildPlaylist

2013-07-26T14:36:07Z

Ludek: /* Method description */

{{MethodDeclaration|SDBPlaylist|ISDBPlaylist|Function CreateChildPlaylist(Title As String) As Object}}

===Parameters===

{{MethodParameters
|Title |String |Title of the playlist to be created.}}

===Method description===

Creates a new sub-playlists of this playlist with the given Title. Reference to the newly created playlist is returned.
If playlist with same Title already exists, then reference to the existing playlist is returned.

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBPlaylist|{{PAGENAME}}]]
[[Category:Interface ISDBPlaylist|{{PAGENAME}}]]

ISDBApplicationEvents::OnPlaylistChanged

2013-07-15T19:54:08Z

Ludek: Created page with "===Parameters=== {{MethodParameters |Playlist |SDBPlaylist |Playlist changed in library.}} ===Event description=== This event is called when a playlist in Library is cha..."

===Parameters===

{{MethodParameters
|Playlist |[[SDBPlaylist]] |Playlist changed in library.}}

===Event description===

This event is called when a playlist in Library is changed in some way (track is deleted or re-ordered).

===Example code===
<source lang="vb">Sub OnStartUp()
Script.RegisterEvent SDB, "OnPlaylistChanged", "PlaylistChanged"
Script.RegisterEvent SDB, "OnPlaylistAdded", "PlaylistAdded"
Script.RegisterEvent SDB, "OnPlaylistRemoved", "PlaylistRemoved"
End Sub

Sub PlaylistChanged( Playlist)
msgbox "Changed playlist " + Playlist.Title
End Sub

Sub PlaylistAdded( Playlist)
msgbox "Added playlist " + Playlist.Title
End Sub

Sub PlaylistRemoved( Playlist)
msgbox "Removed playlist " + Playlist.Title
End Sub</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBApplication|{{PAGENAME}}]]
[[Category:Interface ISDBApplicationEvents|{{PAGENAME}}]]

ISDBApplicationEvents::OnPlaylistRemoved

2013-07-15T19:52:20Z

Ludek: Created page with "===Parameters=== {{MethodParameters |Playlist |SDBPlaylist | Playlist to be removed from library.}} ===Event description=== This event is called when a playlist is delet..."

===Parameters===

{{MethodParameters
|Playlist |[[SDBPlaylist]] | Playlist to be removed from library.}}

===Event description===

This event is called when a playlist is deleting from library.

===Example code===
<source lang="vb">Sub OnStartUp()
Script.RegisterEvent SDB, "OnPlaylistChanged", "PlaylistChanged"
Script.RegisterEvent SDB, "OnPlaylistAdded", "PlaylistAdded"
Script.RegisterEvent SDB, "OnPlaylistRemoved", "PlaylistRemoved"
End Sub

Sub PlaylistChanged( Playlist)
msgbox "Changed playlist " + Playlist.Title
End Sub

Sub PlaylistAdded( Playlist)
msgbox "Added playlist " + Playlist.Title
End Sub

Sub PlaylistRemoved( Playlist)
msgbox "Removed playlist " + Playlist.Title
End Sub</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBApplication|{{PAGENAME}}]]
[[Category:Interface ISDBApplicationEvents|{{PAGENAME}}]]

ISDBApplicationEvents::OnPlaylistAdded

2013-07-15T19:50:51Z

Ludek: Created page with "===Parameters=== {{MethodParameters |Playlist |SDBPlaylist |Newly created library playlist.}} ===Event description=== This event is called when a new playlist is added t..."

===Parameters===

{{MethodParameters
|Playlist |[[SDBPlaylist]] |Newly created library playlist.}}

===Event description===

This event is called when a new playlist is added to Library.

===Example code===
<source lang="vb">Sub OnStartUp()
Script.RegisterEvent SDB, "OnPlaylistChanged", "PlaylistChanged"
Script.RegisterEvent SDB, "OnPlaylistAdded", "PlaylistAdded"
Script.RegisterEvent SDB, "OnPlaylistRemoved", "PlaylistRemoved"
End Sub

Sub PlaylistChanged( Playlist)
msgbox "Changed playlist " + Playlist.Title
End Sub

Sub PlaylistAdded( Playlist)
msgbox "Added playlist " + Playlist.Title
End Sub

Sub PlaylistRemoved( Playlist)
msgbox "Removed playlist " + Playlist.Title
End Sub</source>

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBApplication|{{PAGENAME}}]]
[[Category:Interface ISDBApplicationEvents|{{PAGENAME}}]]

SDBApplication

2013-07-15T19:47:48Z

Ludek: /* ISDBApplicationEvents members */

{{AutomationObjectsList}}
== CoClass SDBApplication ==

This is the main MediaMonkey scripting object that you initially have accessible as global <tt>SDB</tt> variable in your scripts launched from MediaMonkey. All your communication with MediaMonkey should start here, you can get references to other objects from properties of this object.

Object is exposed to ActiveX under name <tt>SongsDB.SDBApplication</tt>.

Another global variable also accessibl in scripts is <tt>Script</tt>, pointing to [[SDBScriptControl]] object.

=== ISDBApplication members ===

{{MethodsList
|[[ISDBApplication::AllVisibleSongList|AllVisibleSongList]] |Property Get |
|[[ISDBApplication::ApplicationPath|ApplicationPath]] |Property Get |
|[[ISDBApplication::EqualizerPath|EqualizerPath]] |Property Get | From 3.1 beta 1
|[[ISDBApplication::IconsPath|IconsPath]] |Property Get | From 3.1 beta 1
|[[ISDBApplication::PluginsPath|PluginsPath]] |Property Get | From 3.1 beta 1
|[[ISDBApplication::CurrentAddonInstallRoot|CurrentAddonInstallRoot]] |Property Get | From 4.0
|[[ISDBApplication::ScriptsPath|ScriptsPath]] |Property Get | From 3.1 beta 1
|[[ISDBApplication::SkinsPath|SkinsPath]] |Property Get | From 3.1 beta 1
|[[ISDBApplication::CommonDialog|CommonDialog]] |Property Get |
|[[ISDBApplication::CreateTimer|CreateTimer]] |Method |
|[[ISDBApplication::CurrentSongList|CurrentSongList]] |Property Get |
|[[ISDBApplication::CursorType|CursorType]] |Property Get/Let |
|[[ISDBApplication::Database|Database]] |Property Get |
|[[ISDBApplication::Device|Device]] |Property Get |
|[[ISDBApplication::Format|Format]] |Method |
|[[ISDBApplication::IniFile|IniFile]] |Property Get |
|[[ISDBApplication::IsKnownFiletype|IsKnownFiletype]] |Method | From 3.0
|[[ISDBApplication::IsRunning|IsRunning]] |Property Get |
|[[ISDBApplication::InPartyMode|InPartyMode]] |Property Get | From 4.1
|[[ISDBApplication::Localize|Localize]] |Method |
|[[ISDBApplication::LocalizedFormat|LocalizedFormat]] |Method |
|[[ISDBApplication::LocalizeGen|LocalizeGen]] |Method |
|[[ISDBApplication::MainTracksWindow|MainTracksWindow]] |Property Get |
|[[ISDBApplication::MainTree|MainTree]] |Property Get |
|[[ISDBApplication::MessageBox|MessageBox]] |Method |
|[[ISDBApplication::MyMusicPath|MyMusicPath]] |Property Get |
|[[ISDBApplication::NewSongData|NewSongData]] |Property Get |
|[[ISDBApplication::NewSongList|NewSongList]] |Property Get |
|[[ISDBApplication::NewStringList|NewStringList]] |Property Get | From 3.0
|[[ISDBApplication::Objects|Objects]] |Property Get/Let |
|[[ISDBApplication::Player|Player]] |Property Get |
|[[ISDBApplication::PlaylistByTitle|PlaylistByTitle]] |Property Get |
|[[ISDBApplication::PlaylistByID|PlaylistByID]] |Property Get | From 4.0
|[[ISDBApplication::ProcessMessages|ProcessMessages]] |Method |
|[[ISDBApplication::Progress|Progress]] |Property Get |
|[[ISDBApplication::RefreshScriptItems|RefreshScriptItems]] |Method | From 3.0
|[[ISDBApplication::RegisterIcon|RegisterIcon]] |Method |
|[[ISDBApplication::RegisterIconHandle|RegisterIconHandle]] |Method |
|[[ISDBApplication::Registry|Registry]] |Property Get |
|[[ISDBApplication::SelectedSongList|SelectedSongList]] |Property Get |
|[[ISDBApplication::SelectFolder|SelectFolder]] |Method |
|[[ISDBApplication::ShutdownAfterDisconnect|ShutdownAfterDisconnect]] |Property Get/Let |
|[[ISDBApplication::TemporaryFolder|TemporaryFolder]] |Property Get |
|[[ISDBApplication::toASCII|toASCII]] |Method |
|[[ISDBApplication::Tools|Tools]] |Property Get |
|[[ISDBApplication::UI|UI]] |Property Get |
|[[ISDBApplication::VersionBuild|VersionBuild]] |Property Get |
|[[ISDBApplication::VersionHi|VersionHi]] |Property Get |
|[[ISDBApplication::VersionLo|VersionLo]] |Property Get |
|[[ISDBApplication::VersionRelease|VersionRelease]] |Property Get |
|[[ISDBApplication::VersionString|VersionString]] |Property Get |
|[[ISDBApplication::ComServerUIActive|ComServerUIActive]] |Property Get/Let |
|[[ISDBApplication::WebControl|WebControl]] |Property Get |
|[[ISDBApplication::Downloader|Downloader]] |Property Get | From 4.0
|[[ISDBApplication::Collections|Collections]] |Property Get | From 4.0
|[[ISDBApplication::VisibleCollectionsCount|VisibleCollectionsCount]] |Property Get | From 4.0
|[[ISDBApplication::VisibleCollectionID|VisibleCollectionID]] |Property Get | From 4.0
}}

=== ISDBApplicationEvents members ===

{{MethodsList
|[[ISDBApplicationEvents::OnBeforeTracksMove|OnBeforeTracksMove]] |Event |
|[[ISDBApplicationEvents::OnChangedSelection|OnChangedSelection]] |Event |
|[[ISDBApplicationEvents::OnCompletePlaybackEnd|OnCompletePlaybackEnd]] |Event | From 4.0
|[[ISDBApplicationEvents::OnDownloadFinished|OnDownloadFinished]] |Event | From 4.0
|[[ISDBApplicationEvents::OnFilterChange|OnFilterChange]] |Event | From 3.1
|[[ISDBApplicationEvents::OnIdle|OnIdle]] |Event | From 3.1
|[[ISDBApplicationEvents::OnNowPlayingModified|OnNowPlayingModified]] |Event | From 3.1
|[[ISDBApplicationEvents::OnNowPlayingSelectionChanged|OnNowPlayingSelectionChanged]] |Event | From 3.1
|[[ISDBApplicationEvents::OnOptionsChange|OnOptionsChange]] |Event | From 3.1
|[[ISDBApplicationEvents::OnPause|OnPause]] |Event |
|[[ISDBApplicationEvents::OnPlay|OnPlay]] |Event |
|[[ISDBApplicationEvents::OnPlaybackEnd|OnPlaybackEnd]] |Event | From 3.1
|[[ISDBApplicationEvents::OnRepeatClicked|OnRepeatClicked]] |Event | From 3.1
|[[ISDBApplicationEvents::OnSeek|OnSeek]] |Event |
|[[ISDBApplicationEvents::OnShuffleClicked|OnShuffleClicked]] |Event | From 3.1
|[[ISDBApplicationEvents::OnShutdown|OnShutdown]] |Event |
|[[ISDBApplicationEvents::OnStop|OnStop]] |Event |
|[[ISDBApplicationEvents::OnTrackAdded|OnTrackAdded]] |Event |
|[[ISDBApplicationEvents::OnTrackConverted|OnTrackConverted]] |Event |
|[[ISDBApplicationEvents::OnTrackDeleting|OnTrackDeleting]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackDoubleClick|OnTrackDoubleClick]] |Event |
|[[ISDBApplicationEvents::OnTrackEnd|OnTrackEnd]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackListFilled|OnTrackListFilled]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackListFilling|OnTrackListFilling]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackListModified|OnTrackListModified]] |Event | From 4.0
|[[ISDBApplicationEvents::OnTrackListSelectionChanged|OnTrackListSelectionChanged]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackProperties|OnTrackProperties]] |Event |
|[[ISDBApplicationEvents::OnTrackSkipped|OnTrackSkipped]] |Event | From 4.0
|[[ISDBApplicationEvents::OnPartyModeEnabled|OnPartyModeEnabled]] |Event | From 4.1
|[[ISDBApplicationEvents::OnDeviceSyncStarted|OnDeviceSyncStarted]] |Event | From 4.1
|[[ISDBApplicationEvents::OnDeviceSyncCompleted|OnDeviceSyncCompleted]] |Event | From 4.1
|[[ISDBApplicationEvents::OnPlaylistAdded|OnPlaylistAdded]] |Event | From 4.1
|[[ISDBApplicationEvents::OnPlaylistRemoved|OnPlaylistRemoved]] |Event | From 4.1
|[[ISDBApplicationEvents::OnPlaylistChanged|OnPlaylistChanged]] |Event | From 4.1
}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBApplication|{{PAGENAME}}]]