MediaMonkey Wiki - User contributions [en]

SDBApplication

2014-09-07T21:25:02Z

Mcow: /* CoClass SDBApplication */

{{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>.

Plugins can get to object using exported DLL Procedure:

C++:
extern "C" __declspec(dllexport)
void MMSetInterfaceCookie(DWORD cookie)

Delphi:
procedure MMSetInterfaceCookie( MMInterfCookie : cardinal); cdecl;

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

See also [[MediaMonkey_Automation_Categorized|this page]] which presents the below information organized in a more functional way.

=== 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}}]]

MediaMonkey Automation Categorized

2014-09-07T21:12:41Z

Mcow: /* Path properties */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are as follows, arranged by category:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection; given an index outside that range, VisibleCollectionID will return an error indicator. The returned ID can be used to find the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlists ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* [[ISDBApplication::PlaylistByTitle|SDB.PlaylistByTitle]]
* [[ISDBApplication::PlaylistByID|SDB.PlaylistByID]]
* [[ISDBApplication::NewSongData|SDB.NewSongData]]
* [[ISDBApplication::NewSongList|SDB.NewSongList]]
* [[ISDBApplication::NewStringList|SDB.NewStringList]]

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* [[ISDBApplication::CursorType|SDB.CursorType]]
* [[ISDBApplication::ShutdownAfterDisconnect|SDB.ShutdownAfterDisconnect]]
* [[ISDBApplication::ComServerUIActive|SDB.ComServerUIActive]]
* [[ISDBApplication::Objects|SDB.Objects]]

=== Readable properties ===
==== Operating Status ====
* [[ISDBApplication::IsRunning|SDB.IsRunning]]
* [[ISDBApplication::InPartyMode|SDB.InPartyMode]]
* [[ISDBApplication::RunningAsService|SDB.RunningAsService]]
* [[ISDBApplication::UseAlbumGain|SDB.UseAlbumGain]]

==== Paths ====

These properties allow querying of useful paths in the MediaMonkey environment:

* [[ISDBApplication::ApplicationPath|SDB.ApplicationPath]]
* [[ISDBApplication::EqualizerPath|SDB.EqualizerPath]]
* [[ISDBApplication::IconsPath|SDB.IconsPath]]
* [[ISDBApplication::PluginsPath|SDB.PluginsPath]]
* [[ISDBApplication::LocalPluginsPath|SDB.LocalPluginsPath]]
* [[ISDBApplication::ScriptsPath|SDB.ScriptsPath]]
* [[ISDBApplication::GlobalScriptsPath|SDB.GlobalScriptsPath]]
* [[ISDBApplication::LocalScriptsPath|SDB.LocalScriptsPath]]
* [[ISDBApplication::SkinsPath|SDB.SkinsPath]]
* [[ISDBApplication::MyMusicPath|SDB.MyMusicPath]]
* [[ISDBApplication::TemporaryFolder|SDB.TemporaryFolder]]
* [[ISDBApplication::CurrentAddonInstallRoot|SDB.CurrentAddonInstallRoot]]
* [[ISDBApplication::ScriptsIniFile|SDB.ScriptsIniFile]]

==== Version information ====
These properties allow querying of the MediaMonkey version.
* [[ISDBApplication::VersionHi|SDB.VersionHi]]: integer, e.g. '''4'''
* [[ISDBApplication::VersionLo|SDB.VersionLo]]: integer, e.g. '''1'''
* [[ISDBApplication::VersionRelease|SDB.VersionRelease]]: integer, e.g. '''3'''
* [[ISDBApplication::VersionBuild|SDB.VersionBuild]]: integer, e.g. '''1703'''
* [[ISDBApplication::VersionString|SDB.VersionString]]: string, e.g. '''"4.1.3"'''

=== Methods ===
* [[ISDBApplication::ProcessMessages|SDB.ProcessMessages]]
* [[ISDBApplication::CreateTimer|SDB.CreateTimer]]
* [[ISDBApplication::MessageBox|SDB.MessageBox]]
* [[ISDBApplication::SelectFolder|SDB.SelectFolder]]
* [[ISDBApplication::Format|SDB.Format]]
* [[ISDBApplication::toASCII|SDB.toASCII]]
* [[ISDBApplication::IsKnownFiletype|SDB.IsKnownFiletype]]
* [[ISDBApplication::Localize|SDB.Localize]]
* [[ISDBApplication::LocalizedFormat|SDB.LocalizedFormat]]
* [[ISDBApplication::LocalizeGen|SDB.LocalizeGen]]
* [[ISDBApplication::RefreshScriptItems|SDB.RefreshScriptItems]]
* [[ISDBApplication::RegisterIcon|SDB.RegisterIcon]]
* [[ISDBApplication::RegisterIconHandle|SDB.RegisterIconHandle]]

MediaMonkey Automation Categorized

2014-09-07T21:11:55Z

Mcow: /* Version properties */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are as follows, arranged by category:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection; given an index outside that range, VisibleCollectionID will return an error indicator. The returned ID can be used to find the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlists ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* [[ISDBApplication::PlaylistByTitle|SDB.PlaylistByTitle]]
* [[ISDBApplication::PlaylistByID|SDB.PlaylistByID]]
* [[ISDBApplication::NewSongData|SDB.NewSongData]]
* [[ISDBApplication::NewSongList|SDB.NewSongList]]
* [[ISDBApplication::NewStringList|SDB.NewStringList]]

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* [[ISDBApplication::CursorType|SDB.CursorType]]
* [[ISDBApplication::ShutdownAfterDisconnect|SDB.ShutdownAfterDisconnect]]
* [[ISDBApplication::ComServerUIActive|SDB.ComServerUIActive]]
* [[ISDBApplication::Objects|SDB.Objects]]

=== Readable properties ===
==== Operating Status ====
* [[ISDBApplication::IsRunning|SDB.IsRunning]]
* [[ISDBApplication::InPartyMode|SDB.InPartyMode]]
* [[ISDBApplication::RunningAsService|SDB.RunningAsService]]
* [[ISDBApplication::UseAlbumGain|SDB.UseAlbumGain]]

==== Path properties ====
* [[ISDBApplication::ApplicationPath|SDB.ApplicationPath]]
* [[ISDBApplication::EqualizerPath|SDB.EqualizerPath]]
* [[ISDBApplication::IconsPath|SDB.IconsPath]]
* [[ISDBApplication::PluginsPath|SDB.PluginsPath]]
* [[ISDBApplication::LocalPluginsPath|SDB.LocalPluginsPath]]
* [[ISDBApplication::ScriptsPath|SDB.ScriptsPath]]
* [[ISDBApplication::GlobalScriptsPath|SDB.GlobalScriptsPath]]
* [[ISDBApplication::LocalScriptsPath|SDB.LocalScriptsPath]]
* [[ISDBApplication::SkinsPath|SDB.SkinsPath]]
* [[ISDBApplication::MyMusicPath|SDB.MyMusicPath]]
* [[ISDBApplication::TemporaryFolder|SDB.TemporaryFolder]]
* [[ISDBApplication::CurrentAddonInstallRoot|SDB.CurrentAddonInstallRoot]]
* [[ISDBApplication::ScriptsIniFile|SDB.ScriptsIniFile]]

==== Version information ====
These properties allow querying of the MediaMonkey version.
* [[ISDBApplication::VersionHi|SDB.VersionHi]]: integer, e.g. '''4'''
* [[ISDBApplication::VersionLo|SDB.VersionLo]]: integer, e.g. '''1'''
* [[ISDBApplication::VersionRelease|SDB.VersionRelease]]: integer, e.g. '''3'''
* [[ISDBApplication::VersionBuild|SDB.VersionBuild]]: integer, e.g. '''1703'''
* [[ISDBApplication::VersionString|SDB.VersionString]]: string, e.g. '''"4.1.3"'''

=== Methods ===
* [[ISDBApplication::ProcessMessages|SDB.ProcessMessages]]
* [[ISDBApplication::CreateTimer|SDB.CreateTimer]]
* [[ISDBApplication::MessageBox|SDB.MessageBox]]
* [[ISDBApplication::SelectFolder|SDB.SelectFolder]]
* [[ISDBApplication::Format|SDB.Format]]
* [[ISDBApplication::toASCII|SDB.toASCII]]
* [[ISDBApplication::IsKnownFiletype|SDB.IsKnownFiletype]]
* [[ISDBApplication::Localize|SDB.Localize]]
* [[ISDBApplication::LocalizedFormat|SDB.LocalizedFormat]]
* [[ISDBApplication::LocalizeGen|SDB.LocalizeGen]]
* [[ISDBApplication::RefreshScriptItems|SDB.RefreshScriptItems]]
* [[ISDBApplication::RegisterIcon|SDB.RegisterIcon]]
* [[ISDBApplication::RegisterIconHandle|SDB.RegisterIconHandle]]

MediaMonkey Automation Categorized

2014-09-07T21:11:37Z

Mcow: /* Status properties */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are as follows, arranged by category:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection; given an index outside that range, VisibleCollectionID will return an error indicator. The returned ID can be used to find the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlists ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* [[ISDBApplication::PlaylistByTitle|SDB.PlaylistByTitle]]
* [[ISDBApplication::PlaylistByID|SDB.PlaylistByID]]
* [[ISDBApplication::NewSongData|SDB.NewSongData]]
* [[ISDBApplication::NewSongList|SDB.NewSongList]]
* [[ISDBApplication::NewStringList|SDB.NewStringList]]

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* [[ISDBApplication::CursorType|SDB.CursorType]]
* [[ISDBApplication::ShutdownAfterDisconnect|SDB.ShutdownAfterDisconnect]]
* [[ISDBApplication::ComServerUIActive|SDB.ComServerUIActive]]
* [[ISDBApplication::Objects|SDB.Objects]]

=== Readable properties ===
==== Operating Status ====
* [[ISDBApplication::IsRunning|SDB.IsRunning]]
* [[ISDBApplication::InPartyMode|SDB.InPartyMode]]
* [[ISDBApplication::RunningAsService|SDB.RunningAsService]]
* [[ISDBApplication::UseAlbumGain|SDB.UseAlbumGain]]

==== Path properties ====
* [[ISDBApplication::ApplicationPath|SDB.ApplicationPath]]
* [[ISDBApplication::EqualizerPath|SDB.EqualizerPath]]
* [[ISDBApplication::IconsPath|SDB.IconsPath]]
* [[ISDBApplication::PluginsPath|SDB.PluginsPath]]
* [[ISDBApplication::LocalPluginsPath|SDB.LocalPluginsPath]]
* [[ISDBApplication::ScriptsPath|SDB.ScriptsPath]]
* [[ISDBApplication::GlobalScriptsPath|SDB.GlobalScriptsPath]]
* [[ISDBApplication::LocalScriptsPath|SDB.LocalScriptsPath]]
* [[ISDBApplication::SkinsPath|SDB.SkinsPath]]
* [[ISDBApplication::MyMusicPath|SDB.MyMusicPath]]
* [[ISDBApplication::TemporaryFolder|SDB.TemporaryFolder]]
* [[ISDBApplication::CurrentAddonInstallRoot|SDB.CurrentAddonInstallRoot]]
* [[ISDBApplication::ScriptsIniFile|SDB.ScriptsIniFile]]

==== Version properties ====
These allow querying of the MediaMonkey version.
* [[ISDBApplication::VersionHi|SDB.VersionHi]]: integer, e.g. '''4'''
* [[ISDBApplication::VersionLo|SDB.VersionLo]]: integer, e.g. '''1'''
* [[ISDBApplication::VersionRelease|SDB.VersionRelease]]: integer, e.g. '''3'''
* [[ISDBApplication::VersionBuild|SDB.VersionBuild]]: integer, e.g. '''1703'''
* [[ISDBApplication::VersionString|SDB.VersionString]]: string, e.g. '''"4.1.3"'''

=== Methods ===
* [[ISDBApplication::ProcessMessages|SDB.ProcessMessages]]
* [[ISDBApplication::CreateTimer|SDB.CreateTimer]]
* [[ISDBApplication::MessageBox|SDB.MessageBox]]
* [[ISDBApplication::SelectFolder|SDB.SelectFolder]]
* [[ISDBApplication::Format|SDB.Format]]
* [[ISDBApplication::toASCII|SDB.toASCII]]
* [[ISDBApplication::IsKnownFiletype|SDB.IsKnownFiletype]]
* [[ISDBApplication::Localize|SDB.Localize]]
* [[ISDBApplication::LocalizedFormat|SDB.LocalizedFormat]]
* [[ISDBApplication::LocalizeGen|SDB.LocalizeGen]]
* [[ISDBApplication::RefreshScriptItems|SDB.RefreshScriptItems]]
* [[ISDBApplication::RegisterIcon|SDB.RegisterIcon]]
* [[ISDBApplication::RegisterIconHandle|SDB.RegisterIconHandle]]

MediaMonkey Automation Categorized

2014-09-07T21:08:15Z

Mcow: /* Songlist properties */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are as follows, arranged by category:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection; given an index outside that range, VisibleCollectionID will return an error indicator. The returned ID can be used to find the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlists ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* [[ISDBApplication::PlaylistByTitle|SDB.PlaylistByTitle]]
* [[ISDBApplication::PlaylistByID|SDB.PlaylistByID]]
* [[ISDBApplication::NewSongData|SDB.NewSongData]]
* [[ISDBApplication::NewSongList|SDB.NewSongList]]
* [[ISDBApplication::NewStringList|SDB.NewStringList]]

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* [[ISDBApplication::CursorType|SDB.CursorType]]
* [[ISDBApplication::ShutdownAfterDisconnect|SDB.ShutdownAfterDisconnect]]
* [[ISDBApplication::ComServerUIActive|SDB.ComServerUIActive]]
* [[ISDBApplication::Objects|SDB.Objects]]

=== Readable properties ===
==== Status properties ====
* [[ISDBApplication::IsRunning|SDB.IsRunning]]
* [[ISDBApplication::InPartyMode|SDB.InPartyMode]]
* [[ISDBApplication::RunningAsService|SDB.RunningAsService]]
* [[ISDBApplication::UseAlbumGain|SDB.UseAlbumGain]]

==== Path properties ====
* [[ISDBApplication::ApplicationPath|SDB.ApplicationPath]]
* [[ISDBApplication::EqualizerPath|SDB.EqualizerPath]]
* [[ISDBApplication::IconsPath|SDB.IconsPath]]
* [[ISDBApplication::PluginsPath|SDB.PluginsPath]]
* [[ISDBApplication::LocalPluginsPath|SDB.LocalPluginsPath]]
* [[ISDBApplication::ScriptsPath|SDB.ScriptsPath]]
* [[ISDBApplication::GlobalScriptsPath|SDB.GlobalScriptsPath]]
* [[ISDBApplication::LocalScriptsPath|SDB.LocalScriptsPath]]
* [[ISDBApplication::SkinsPath|SDB.SkinsPath]]
* [[ISDBApplication::MyMusicPath|SDB.MyMusicPath]]
* [[ISDBApplication::TemporaryFolder|SDB.TemporaryFolder]]
* [[ISDBApplication::CurrentAddonInstallRoot|SDB.CurrentAddonInstallRoot]]
* [[ISDBApplication::ScriptsIniFile|SDB.ScriptsIniFile]]

==== Version properties ====
These allow querying of the MediaMonkey version.
* [[ISDBApplication::VersionHi|SDB.VersionHi]]: integer, e.g. '''4'''
* [[ISDBApplication::VersionLo|SDB.VersionLo]]: integer, e.g. '''1'''
* [[ISDBApplication::VersionRelease|SDB.VersionRelease]]: integer, e.g. '''3'''
* [[ISDBApplication::VersionBuild|SDB.VersionBuild]]: integer, e.g. '''1703'''
* [[ISDBApplication::VersionString|SDB.VersionString]]: string, e.g. '''"4.1.3"'''

=== Methods ===
* [[ISDBApplication::ProcessMessages|SDB.ProcessMessages]]
* [[ISDBApplication::CreateTimer|SDB.CreateTimer]]
* [[ISDBApplication::MessageBox|SDB.MessageBox]]
* [[ISDBApplication::SelectFolder|SDB.SelectFolder]]
* [[ISDBApplication::Format|SDB.Format]]
* [[ISDBApplication::toASCII|SDB.toASCII]]
* [[ISDBApplication::IsKnownFiletype|SDB.IsKnownFiletype]]
* [[ISDBApplication::Localize|SDB.Localize]]
* [[ISDBApplication::LocalizedFormat|SDB.LocalizedFormat]]
* [[ISDBApplication::LocalizeGen|SDB.LocalizeGen]]
* [[ISDBApplication::RefreshScriptItems|SDB.RefreshScriptItems]]
* [[ISDBApplication::RegisterIcon|SDB.RegisterIcon]]
* [[ISDBApplication::RegisterIconHandle|SDB.RegisterIconHandle]]

MediaMonkey Automation Categorized

2014-09-07T21:07:33Z

Mcow: /* MainTree */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are as follows, arranged by category:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection; given an index outside that range, VisibleCollectionID will return an error indicator. The returned ID can be used to find the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlist properties ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* [[ISDBApplication::PlaylistByTitle|SDB.PlaylistByTitle]]
* [[ISDBApplication::PlaylistByID|SDB.PlaylistByID]]
* [[ISDBApplication::NewSongData|SDB.NewSongData]]
* [[ISDBApplication::NewSongList|SDB.NewSongList]]
* [[ISDBApplication::NewStringList|SDB.NewStringList]]

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* [[ISDBApplication::CursorType|SDB.CursorType]]
* [[ISDBApplication::ShutdownAfterDisconnect|SDB.ShutdownAfterDisconnect]]
* [[ISDBApplication::ComServerUIActive|SDB.ComServerUIActive]]
* [[ISDBApplication::Objects|SDB.Objects]]

=== Readable properties ===
==== Status properties ====
* [[ISDBApplication::IsRunning|SDB.IsRunning]]
* [[ISDBApplication::InPartyMode|SDB.InPartyMode]]
* [[ISDBApplication::RunningAsService|SDB.RunningAsService]]
* [[ISDBApplication::UseAlbumGain|SDB.UseAlbumGain]]

==== Path properties ====
* [[ISDBApplication::ApplicationPath|SDB.ApplicationPath]]
* [[ISDBApplication::EqualizerPath|SDB.EqualizerPath]]
* [[ISDBApplication::IconsPath|SDB.IconsPath]]
* [[ISDBApplication::PluginsPath|SDB.PluginsPath]]
* [[ISDBApplication::LocalPluginsPath|SDB.LocalPluginsPath]]
* [[ISDBApplication::ScriptsPath|SDB.ScriptsPath]]
* [[ISDBApplication::GlobalScriptsPath|SDB.GlobalScriptsPath]]
* [[ISDBApplication::LocalScriptsPath|SDB.LocalScriptsPath]]
* [[ISDBApplication::SkinsPath|SDB.SkinsPath]]
* [[ISDBApplication::MyMusicPath|SDB.MyMusicPath]]
* [[ISDBApplication::TemporaryFolder|SDB.TemporaryFolder]]
* [[ISDBApplication::CurrentAddonInstallRoot|SDB.CurrentAddonInstallRoot]]
* [[ISDBApplication::ScriptsIniFile|SDB.ScriptsIniFile]]

==== Version properties ====
These allow querying of the MediaMonkey version.
* [[ISDBApplication::VersionHi|SDB.VersionHi]]: integer, e.g. '''4'''
* [[ISDBApplication::VersionLo|SDB.VersionLo]]: integer, e.g. '''1'''
* [[ISDBApplication::VersionRelease|SDB.VersionRelease]]: integer, e.g. '''3'''
* [[ISDBApplication::VersionBuild|SDB.VersionBuild]]: integer, e.g. '''1703'''
* [[ISDBApplication::VersionString|SDB.VersionString]]: string, e.g. '''"4.1.3"'''

=== Methods ===
* [[ISDBApplication::ProcessMessages|SDB.ProcessMessages]]
* [[ISDBApplication::CreateTimer|SDB.CreateTimer]]
* [[ISDBApplication::MessageBox|SDB.MessageBox]]
* [[ISDBApplication::SelectFolder|SDB.SelectFolder]]
* [[ISDBApplication::Format|SDB.Format]]
* [[ISDBApplication::toASCII|SDB.toASCII]]
* [[ISDBApplication::IsKnownFiletype|SDB.IsKnownFiletype]]
* [[ISDBApplication::Localize|SDB.Localize]]
* [[ISDBApplication::LocalizedFormat|SDB.LocalizedFormat]]
* [[ISDBApplication::LocalizeGen|SDB.LocalizeGen]]
* [[ISDBApplication::RefreshScriptItems|SDB.RefreshScriptItems]]
* [[ISDBApplication::RegisterIcon|SDB.RegisterIcon]]
* [[ISDBApplication::RegisterIconHandle|SDB.RegisterIconHandle]]

MediaMonkey Automation Categorized

2014-09-07T21:05:21Z

Mcow: /* SDB */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are as follows, arranged by category:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection, and any other value with return an error indicator. These IDs can be used to access the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlist properties ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* [[ISDBApplication::PlaylistByTitle|SDB.PlaylistByTitle]]
* [[ISDBApplication::PlaylistByID|SDB.PlaylistByID]]
* [[ISDBApplication::NewSongData|SDB.NewSongData]]
* [[ISDBApplication::NewSongList|SDB.NewSongList]]
* [[ISDBApplication::NewStringList|SDB.NewStringList]]

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* [[ISDBApplication::CursorType|SDB.CursorType]]
* [[ISDBApplication::ShutdownAfterDisconnect|SDB.ShutdownAfterDisconnect]]
* [[ISDBApplication::ComServerUIActive|SDB.ComServerUIActive]]
* [[ISDBApplication::Objects|SDB.Objects]]

=== Readable properties ===
==== Status properties ====
* [[ISDBApplication::IsRunning|SDB.IsRunning]]
* [[ISDBApplication::InPartyMode|SDB.InPartyMode]]
* [[ISDBApplication::RunningAsService|SDB.RunningAsService]]
* [[ISDBApplication::UseAlbumGain|SDB.UseAlbumGain]]

==== Path properties ====
* [[ISDBApplication::ApplicationPath|SDB.ApplicationPath]]
* [[ISDBApplication::EqualizerPath|SDB.EqualizerPath]]
* [[ISDBApplication::IconsPath|SDB.IconsPath]]
* [[ISDBApplication::PluginsPath|SDB.PluginsPath]]
* [[ISDBApplication::LocalPluginsPath|SDB.LocalPluginsPath]]
* [[ISDBApplication::ScriptsPath|SDB.ScriptsPath]]
* [[ISDBApplication::GlobalScriptsPath|SDB.GlobalScriptsPath]]
* [[ISDBApplication::LocalScriptsPath|SDB.LocalScriptsPath]]
* [[ISDBApplication::SkinsPath|SDB.SkinsPath]]
* [[ISDBApplication::MyMusicPath|SDB.MyMusicPath]]
* [[ISDBApplication::TemporaryFolder|SDB.TemporaryFolder]]
* [[ISDBApplication::CurrentAddonInstallRoot|SDB.CurrentAddonInstallRoot]]
* [[ISDBApplication::ScriptsIniFile|SDB.ScriptsIniFile]]

==== Version properties ====
These allow querying of the MediaMonkey version.
* [[ISDBApplication::VersionHi|SDB.VersionHi]]: integer, e.g. '''4'''
* [[ISDBApplication::VersionLo|SDB.VersionLo]]: integer, e.g. '''1'''
* [[ISDBApplication::VersionRelease|SDB.VersionRelease]]: integer, e.g. '''3'''
* [[ISDBApplication::VersionBuild|SDB.VersionBuild]]: integer, e.g. '''1703'''
* [[ISDBApplication::VersionString|SDB.VersionString]]: string, e.g. '''"4.1.3"'''

=== Methods ===
* [[ISDBApplication::ProcessMessages|SDB.ProcessMessages]]
* [[ISDBApplication::CreateTimer|SDB.CreateTimer]]
* [[ISDBApplication::MessageBox|SDB.MessageBox]]
* [[ISDBApplication::SelectFolder|SDB.SelectFolder]]
* [[ISDBApplication::Format|SDB.Format]]
* [[ISDBApplication::toASCII|SDB.toASCII]]
* [[ISDBApplication::IsKnownFiletype|SDB.IsKnownFiletype]]
* [[ISDBApplication::Localize|SDB.Localize]]
* [[ISDBApplication::LocalizedFormat|SDB.LocalizedFormat]]
* [[ISDBApplication::LocalizeGen|SDB.LocalizeGen]]
* [[ISDBApplication::RefreshScriptItems|SDB.RefreshScriptItems]]
* [[ISDBApplication::RegisterIcon|SDB.RegisterIcon]]
* [[ISDBApplication::RegisterIconHandle|SDB.RegisterIconHandle]]

MediaMonkey Automation Categorized

2014-09-07T21:01:21Z

Mcow: /* Status properties */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection, and any other value with return an error indicator. These IDs can be used to access the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlist properties ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* PlaylistByTitle
* PlaylistByID

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* [[ISDBApplication::CursorType|SDB.CursorType]]
* [[ISDBApplication::ShutdownAfterDisconnect|SDB.ShutdownAfterDisconnect]]
* [[ISDBApplication::ComServerUIActive|SDB.ComServerUIActive]]
* [[ISDBApplication::Objects|SDB.Objects]]

=== Readable properties ===
==== Status properties ====
* [[ISDBApplication::IsRunning|SDB.IsRunning]]
* [[ISDBApplication::InPartyMode|SDB.InPartyMode]]
* [[ISDBApplication::RunningAsService|SDB.RunningAsService]]
* [[ISDBApplication::UseAlbumGain|SDB.UseAlbumGain]]

==== Path properties ====
* [[ISDBApplication::ApplicationPath|SDB.ApplicationPath]]
* [[ISDBApplication::EqualizerPath|SDB.EqualizerPath]]
* [[ISDBApplication::IconsPath|SDB.IconsPath]]
* [[ISDBApplication::PluginsPath|SDB.PluginsPath]]
* [[ISDBApplication::LocalPluginsPath|SDB.LocalPluginsPath]]
* [[ISDBApplication::ScriptsPath|SDB.ScriptsPath]]
* [[ISDBApplication::GlobalScriptsPath|SDB.GlobalScriptsPath]]
* [[ISDBApplication::LocalScriptsPath|SDB.LocalScriptsPath]]
* [[ISDBApplication::SkinsPath|SDB.SkinsPath]]
* [[ISDBApplication::MyMusicPath|SDB.MyMusicPath]]
* [[ISDBApplication::TemporaryFolder|SDB.TemporaryFolder]]
* [[ISDBApplication::CurrentAddonInstallRoot|SDB.CurrentAddonInstallRoot]]
* [[ISDBApplication::ScriptsIniFile|SDB.ScriptsIniFile]]

==== Version properties ====
These allow querying of the MediaMonkey version.
* [[ISDBApplication::VersionHi|SDB.VersionHi]]: integer, e.g. '''4'''
* [[ISDBApplication::VersionLo|SDB.VersionLo]]: integer, e.g. '''1'''
* [[ISDBApplication::VersionRelease|SDB.VersionRelease]]: integer, e.g. '''3'''
* [[ISDBApplication::VersionBuild|SDB.VersionBuild]]: integer, e.g. '''1703'''
* [[ISDBApplication::VersionString|SDB.VersionString]]: string, e.g. '''"4.1.3"'''

=== Methods ===
* [[ISDBApplication::ProcessMessages|SDB.ProcessMessages]]
* [[ISDBApplication::CreateTimer|SDB.CreateTimer]]
* [[ISDBApplication::MessageBox|SDB.MessageBox]]
* [[ISDBApplication::SelectFolder|SDB.SelectFolder]]
* [[ISDBApplication::Format|SDB.Format]]
* [[ISDBApplication::toASCII|SDB.toASCII]]
* [[ISDBApplication::IsKnownFiletype|SDB.IsKnownFiletype]]
* [[ISDBApplication::Localize|SDB.Localize]]
* [[ISDBApplication::LocalizedFormat|SDB.LocalizedFormat]]
* [[ISDBApplication::LocalizeGen|SDB.LocalizeGen]]
* [[ISDBApplication::RefreshScriptItems|SDB.RefreshScriptItems]]
* [[ISDBApplication::RegisterIcon|SDB.RegisterIcon]]
* [[ISDBApplication::RegisterIconHandle|SDB.RegisterIconHandle]]

MediaMonkey Automation Categorized

2014-09-07T21:00:26Z

Mcow: /* Path properties */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection, and any other value with return an error indicator. These IDs can be used to access the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlist properties ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* PlaylistByTitle
* PlaylistByID

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* [[ISDBApplication::CursorType|SDB.CursorType]]
* [[ISDBApplication::ShutdownAfterDisconnect|SDB.ShutdownAfterDisconnect]]
* [[ISDBApplication::ComServerUIActive|SDB.ComServerUIActive]]
* [[ISDBApplication::Objects|SDB.Objects]]

=== Readable properties ===
==== Status properties ====
* [[ISDBApplication::IsRunning|SDB.IsRunning]]
* [[ISDBApplication::InPartyMode|SDB.InPartyMode]]
* [[ISDBApplication::RunningAsService|SDB.RunningAsService]]

==== Path properties ====
* [[ISDBApplication::ApplicationPath|SDB.ApplicationPath]]
* [[ISDBApplication::EqualizerPath|SDB.EqualizerPath]]
* [[ISDBApplication::IconsPath|SDB.IconsPath]]
* [[ISDBApplication::PluginsPath|SDB.PluginsPath]]
* [[ISDBApplication::LocalPluginsPath|SDB.LocalPluginsPath]]
* [[ISDBApplication::ScriptsPath|SDB.ScriptsPath]]
* [[ISDBApplication::GlobalScriptsPath|SDB.GlobalScriptsPath]]
* [[ISDBApplication::LocalScriptsPath|SDB.LocalScriptsPath]]
* [[ISDBApplication::SkinsPath|SDB.SkinsPath]]
* [[ISDBApplication::MyMusicPath|SDB.MyMusicPath]]
* [[ISDBApplication::TemporaryFolder|SDB.TemporaryFolder]]
* [[ISDBApplication::CurrentAddonInstallRoot|SDB.CurrentAddonInstallRoot]]
* [[ISDBApplication::ScriptsIniFile|SDB.ScriptsIniFile]]

==== Version properties ====
These allow querying of the MediaMonkey version.
* [[ISDBApplication::VersionHi|SDB.VersionHi]]: integer, e.g. '''4'''
* [[ISDBApplication::VersionLo|SDB.VersionLo]]: integer, e.g. '''1'''
* [[ISDBApplication::VersionRelease|SDB.VersionRelease]]: integer, e.g. '''3'''
* [[ISDBApplication::VersionBuild|SDB.VersionBuild]]: integer, e.g. '''1703'''
* [[ISDBApplication::VersionString|SDB.VersionString]]: string, e.g. '''"4.1.3"'''

=== Methods ===
* [[ISDBApplication::ProcessMessages|SDB.ProcessMessages]]
* [[ISDBApplication::CreateTimer|SDB.CreateTimer]]
* [[ISDBApplication::MessageBox|SDB.MessageBox]]
* [[ISDBApplication::SelectFolder|SDB.SelectFolder]]
* [[ISDBApplication::Format|SDB.Format]]
* [[ISDBApplication::toASCII|SDB.toASCII]]
* [[ISDBApplication::IsKnownFiletype|SDB.IsKnownFiletype]]
* [[ISDBApplication::Localize|SDB.Localize]]
* [[ISDBApplication::LocalizedFormat|SDB.LocalizedFormat]]
* [[ISDBApplication::LocalizeGen|SDB.LocalizeGen]]
* [[ISDBApplication::RefreshScriptItems|SDB.RefreshScriptItems]]
* [[ISDBApplication::RegisterIcon|SDB.RegisterIcon]]
* [[ISDBApplication::RegisterIconHandle|SDB.RegisterIconHandle]]

MediaMonkey Automation Categorized

2014-09-07T20:55:34Z

Mcow: /* Methods */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection, and any other value with return an error indicator. These IDs can be used to access the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlist properties ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* PlaylistByTitle
* PlaylistByID

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* [[ISDBApplication::CursorType|SDB.CursorType]]
* [[ISDBApplication::ShutdownAfterDisconnect|SDB.ShutdownAfterDisconnect]]
* [[ISDBApplication::ComServerUIActive|SDB.ComServerUIActive]]
* [[ISDBApplication::Objects|SDB.Objects]]

=== Readable properties ===
==== Status properties ====
* [[ISDBApplication::IsRunning|SDB.IsRunning]]
* [[ISDBApplication::InPartyMode|SDB.InPartyMode]]
* [[ISDBApplication::RunningAsService|SDB.RunningAsService]]

==== Path properties ====
* [[ISDBApplication::ApplicationPath|SDB.ApplicationPath]]
* [[ISDBApplication::EqualizerPath|SDB.EqualizerPath]]
* [[ISDBApplication::IconsPath|SDB.IconsPath]]
* [[ISDBApplication::PluginsPath|SDB.PluginsPath]]
* [[ISDBApplication::ScriptsPath|SDB.ScriptsPath]]
* [[ISDBApplication::SkinsPath|SDB.SkinsPath]]
* [[ISDBApplication::MyMusicPath|SDB.MyMusicPath]]
* [[ISDBApplication::TemporaryFolder|SDB.TemporaryFolder]]
* [[ISDBApplication::CurrentAddonInstallRoot|SDB.CurrentAddonInstallRoot]]
* [[ISDBApplication::ScriptsIniFile|SDB.ScriptsIniFile]]

==== Version properties ====
These allow querying of the MediaMonkey version.
* [[ISDBApplication::VersionHi|SDB.VersionHi]]: integer, e.g. '''4'''
* [[ISDBApplication::VersionLo|SDB.VersionLo]]: integer, e.g. '''1'''
* [[ISDBApplication::VersionRelease|SDB.VersionRelease]]: integer, e.g. '''3'''
* [[ISDBApplication::VersionBuild|SDB.VersionBuild]]: integer, e.g. '''1703'''
* [[ISDBApplication::VersionString|SDB.VersionString]]: string, e.g. '''"4.1.3"'''

=== Methods ===
* [[ISDBApplication::ProcessMessages|SDB.ProcessMessages]]
* [[ISDBApplication::CreateTimer|SDB.CreateTimer]]
* [[ISDBApplication::MessageBox|SDB.MessageBox]]
* [[ISDBApplication::SelectFolder|SDB.SelectFolder]]
* [[ISDBApplication::Format|SDB.Format]]
* [[ISDBApplication::toASCII|SDB.toASCII]]
* [[ISDBApplication::IsKnownFiletype|SDB.IsKnownFiletype]]
* [[ISDBApplication::Localize|SDB.Localize]]
* [[ISDBApplication::LocalizedFormat|SDB.LocalizedFormat]]
* [[ISDBApplication::LocalizeGen|SDB.LocalizeGen]]
* [[ISDBApplication::RefreshScriptItems|SDB.RefreshScriptItems]]
* [[ISDBApplication::RegisterIcon|SDB.RegisterIcon]]
* [[ISDBApplication::RegisterIconHandle|SDB.RegisterIconHandle]]

MediaMonkey Automation Categorized

2014-09-07T20:53:44Z

Mcow: /* Path properties */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection, and any other value with return an error indicator. These IDs can be used to access the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlist properties ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* PlaylistByTitle
* PlaylistByID

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* [[ISDBApplication::CursorType|SDB.CursorType]]
* [[ISDBApplication::ShutdownAfterDisconnect|SDB.ShutdownAfterDisconnect]]
* [[ISDBApplication::ComServerUIActive|SDB.ComServerUIActive]]
* [[ISDBApplication::Objects|SDB.Objects]]

=== Readable properties ===
==== Status properties ====
* [[ISDBApplication::IsRunning|SDB.IsRunning]]
* [[ISDBApplication::InPartyMode|SDB.InPartyMode]]
* [[ISDBApplication::RunningAsService|SDB.RunningAsService]]

==== Path properties ====
* [[ISDBApplication::ApplicationPath|SDB.ApplicationPath]]
* [[ISDBApplication::EqualizerPath|SDB.EqualizerPath]]
* [[ISDBApplication::IconsPath|SDB.IconsPath]]
* [[ISDBApplication::PluginsPath|SDB.PluginsPath]]
* [[ISDBApplication::ScriptsPath|SDB.ScriptsPath]]
* [[ISDBApplication::SkinsPath|SDB.SkinsPath]]
* [[ISDBApplication::MyMusicPath|SDB.MyMusicPath]]
* [[ISDBApplication::TemporaryFolder|SDB.TemporaryFolder]]
* [[ISDBApplication::CurrentAddonInstallRoot|SDB.CurrentAddonInstallRoot]]
* [[ISDBApplication::ScriptsIniFile|SDB.ScriptsIniFile]]

==== Version properties ====
These allow querying of the MediaMonkey version.
* [[ISDBApplication::VersionHi|SDB.VersionHi]]: integer, e.g. '''4'''
* [[ISDBApplication::VersionLo|SDB.VersionLo]]: integer, e.g. '''1'''
* [[ISDBApplication::VersionRelease|SDB.VersionRelease]]: integer, e.g. '''3'''
* [[ISDBApplication::VersionBuild|SDB.VersionBuild]]: integer, e.g. '''1703'''
* [[ISDBApplication::VersionString|SDB.VersionString]]: string, e.g. '''"4.1.3"'''

=== Methods ===
ProcessMessages
CreateTimer
MessageBox
SelectFolder
Format
toASCII
IsKnownFiletype
Localize
LocalizedFormat
LocalizeGen
RefreshScriptItems
RegisterIcon
RegisterIconHandle

MediaMonkey Automation Categorized

2014-09-07T20:52:21Z

Mcow: /* Status properties */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection, and any other value with return an error indicator. These IDs can be used to access the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlist properties ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* PlaylistByTitle
* PlaylistByID

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* [[ISDBApplication::CursorType|SDB.CursorType]]
* [[ISDBApplication::ShutdownAfterDisconnect|SDB.ShutdownAfterDisconnect]]
* [[ISDBApplication::ComServerUIActive|SDB.ComServerUIActive]]
* [[ISDBApplication::Objects|SDB.Objects]]

=== Readable properties ===
==== Status properties ====
* [[ISDBApplication::IsRunning|SDB.IsRunning]]
* [[ISDBApplication::InPartyMode|SDB.InPartyMode]]
* [[ISDBApplication::RunningAsService|SDB.RunningAsService]]

==== Path properties ====
* ApplicationPath
* EqualizerPath
* IconsPath
* PluginsPath
* ScriptsPath
* SkinsPath
* MyMusicPath
* TemporaryFolder
* CurrentAddonInstallRoot
* ScriptsIniFile

==== Version properties ====
These allow querying of the MediaMonkey version.
* [[ISDBApplication::VersionHi|SDB.VersionHi]]: integer, e.g. '''4'''
* [[ISDBApplication::VersionLo|SDB.VersionLo]]: integer, e.g. '''1'''
* [[ISDBApplication::VersionRelease|SDB.VersionRelease]]: integer, e.g. '''3'''
* [[ISDBApplication::VersionBuild|SDB.VersionBuild]]: integer, e.g. '''1703'''
* [[ISDBApplication::VersionString|SDB.VersionString]]: string, e.g. '''"4.1.3"'''

=== Methods ===
ProcessMessages
CreateTimer
MessageBox
SelectFolder
Format
toASCII
IsKnownFiletype
Localize
LocalizedFormat
LocalizeGen
RefreshScriptItems
RegisterIcon
RegisterIconHandle

MediaMonkey Automation Categorized

2014-09-07T20:51:30Z

Mcow: /* Settable properties */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection, and any other value with return an error indicator. These IDs can be used to access the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlist properties ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* PlaylistByTitle
* PlaylistByID

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* [[ISDBApplication::CursorType|SDB.CursorType]]
* [[ISDBApplication::ShutdownAfterDisconnect|SDB.ShutdownAfterDisconnect]]
* [[ISDBApplication::ComServerUIActive|SDB.ComServerUIActive]]
* [[ISDBApplication::Objects|SDB.Objects]]

=== Readable properties ===
==== Status properties ====
* IsRunning
* InPartyMode
* RunningAsService

==== Path properties ====
* ApplicationPath
* EqualizerPath
* IconsPath
* PluginsPath
* ScriptsPath
* SkinsPath
* MyMusicPath
* TemporaryFolder
* CurrentAddonInstallRoot
* ScriptsIniFile

==== Version properties ====
These allow querying of the MediaMonkey version.
* [[ISDBApplication::VersionHi|SDB.VersionHi]]: integer, e.g. '''4'''
* [[ISDBApplication::VersionLo|SDB.VersionLo]]: integer, e.g. '''1'''
* [[ISDBApplication::VersionRelease|SDB.VersionRelease]]: integer, e.g. '''3'''
* [[ISDBApplication::VersionBuild|SDB.VersionBuild]]: integer, e.g. '''1703'''
* [[ISDBApplication::VersionString|SDB.VersionString]]: string, e.g. '''"4.1.3"'''

=== Methods ===
ProcessMessages
CreateTimer
MessageBox
SelectFolder
Format
toASCII
IsKnownFiletype
Localize
LocalizedFormat
LocalizeGen
RefreshScriptItems
RegisterIcon
RegisterIconHandle

MediaMonkey Automation Categorized

2014-09-07T20:49:23Z

Mcow: /* Version properties */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection, and any other value with return an error indicator. These IDs can be used to access the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlist properties ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* PlaylistByTitle
* PlaylistByID

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* CursorType
* ShutdownAfterDisconnect
* ComServerUIActive
* Objects

=== Readable properties ===
==== Status properties ====
* IsRunning
* InPartyMode
* RunningAsService

==== Path properties ====
* ApplicationPath
* EqualizerPath
* IconsPath
* PluginsPath
* ScriptsPath
* SkinsPath
* MyMusicPath
* TemporaryFolder
* CurrentAddonInstallRoot
* ScriptsIniFile

==== Version properties ====
These allow querying of the MediaMonkey version.
* [[ISDBApplication::VersionHi|SDB.VersionHi]]: integer, e.g. '''4'''
* [[ISDBApplication::VersionLo|SDB.VersionLo]]: integer, e.g. '''1'''
* [[ISDBApplication::VersionRelease|SDB.VersionRelease]]: integer, e.g. '''3'''
* [[ISDBApplication::VersionBuild|SDB.VersionBuild]]: integer, e.g. '''1703'''
* [[ISDBApplication::VersionString|SDB.VersionString]]: string, e.g. '''"4.1.3"'''

=== Methods ===
ProcessMessages
CreateTimer
MessageBox
SelectFolder
Format
toASCII
IsKnownFiletype
Localize
LocalizedFormat
LocalizeGen
RefreshScriptItems
RegisterIcon
RegisterIconHandle

MediaMonkey Automation Categorized

2014-09-07T20:45:03Z

Mcow: /* Version properties */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection, and any other value with return an error indicator. These IDs can be used to access the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlist properties ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* PlaylistByTitle
* PlaylistByID

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* CursorType
* ShutdownAfterDisconnect
* ComServerUIActive
* Objects

=== Readable properties ===
==== Status properties ====
* IsRunning
* InPartyMode
* RunningAsService

==== Path properties ====
* ApplicationPath
* EqualizerPath
* IconsPath
* PluginsPath
* ScriptsPath
* SkinsPath
* MyMusicPath
* TemporaryFolder
* CurrentAddonInstallRoot
* ScriptsIniFile

==== Version properties ====
These allow querying of the MediaMonkey version.
* SDB.VersionHi: integer, e.g. '''4'''
* SDB.VersionLo: integer, e.g. '''1'''
* SDB.VersionRelease: integer, e.g. '''3'''
* SDB.VersionBuild: integer, e.g. '''1703'''
* SDB.VersionString: string, e.g. '''"4.1.3"'''

=== Methods ===
ProcessMessages
CreateTimer
MessageBox
SelectFolder
Format
toASCII
IsKnownFiletype
Localize
LocalizedFormat
LocalizeGen
RefreshScriptItems
RegisterIcon
RegisterIconHandle

MediaMonkey Automation Categorized

2014-09-07T20:44:36Z

Mcow: /* Version properties */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection, and any other value with return an error indicator. These IDs can be used to access the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlist properties ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* PlaylistByTitle
* PlaylistByID

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* CursorType
* ShutdownAfterDisconnect
* ComServerUIActive
* Objects

=== Readable properties ===
==== Status properties ====
* IsRunning
* InPartyMode
* RunningAsService

==== Path properties ====
* ApplicationPath
* EqualizerPath
* IconsPath
* PluginsPath
* ScriptsPath
* SkinsPath
* MyMusicPath
* TemporaryFolder
* CurrentAddonInstallRoot
* ScriptsIniFile

==== Version properties ====
These allow querying of the MediaMonkey version.
* VersionHi: integer, e.g. '''4'''
* VersionLo: integer, e.g. '''1'''
* VersionRelease: integer, e.g. '''3'''
* VersionBuild: integer, e.g. '''1703'''
* VersionString: string, e.g. '''"4.1.3"'''

=== Methods ===
ProcessMessages
CreateTimer
MessageBox
SelectFolder
Format
toASCII
IsKnownFiletype
Localize
LocalizedFormat
LocalizeGen
RefreshScriptItems
RegisterIcon
RegisterIconHandle

MediaMonkey Automation Categorized

2014-09-07T20:42:50Z

Mcow: /* Path properties */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection, and any other value with return an error indicator. These IDs can be used to access the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlist properties ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* PlaylistByTitle
* PlaylistByID

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* CursorType
* ShutdownAfterDisconnect
* ComServerUIActive
* Objects

=== Readable properties ===
==== Status properties ====
* IsRunning
* InPartyMode
* RunningAsService

==== Path properties ====
* ApplicationPath
* EqualizerPath
* IconsPath
* PluginsPath
* ScriptsPath
* SkinsPath
* MyMusicPath
* TemporaryFolder
* CurrentAddonInstallRoot
* ScriptsIniFile

==== Version properties ====
VersionHi
VersionLo
VersionRelease
VersionBuild
VersionString

=== Methods ===
ProcessMessages
CreateTimer
MessageBox
SelectFolder
Format
toASCII
IsKnownFiletype
Localize
LocalizedFormat
LocalizeGen
RefreshScriptItems
RegisterIcon
RegisterIconHandle

MediaMonkey Automation Categorized

2014-09-07T20:42:22Z

Mcow: /* Status properties */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection, and any other value with return an error indicator. These IDs can be used to access the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlist properties ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* PlaylistByTitle
* PlaylistByID

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* CursorType
* ShutdownAfterDisconnect
* ComServerUIActive
* Objects

=== Readable properties ===
==== Status properties ====
* IsRunning
* InPartyMode
* RunningAsService

==== Path properties ====
ApplicationPath
EqualizerPath
IconsPath
PluginsPath
ScriptsPath
SkinsPath
MyMusicPath
TemporaryFolder
CurrentAddonInstallRoot
ScriptsIniFile

==== Version properties ====
VersionHi
VersionLo
VersionRelease
VersionBuild
VersionString

=== Methods ===
ProcessMessages
CreateTimer
MessageBox
SelectFolder
Format
toASCII
IsKnownFiletype
Localize
LocalizedFormat
LocalizeGen
RefreshScriptItems
RegisterIcon
RegisterIconHandle

MediaMonkey Automation Categorized

2014-09-07T20:42:07Z

Mcow: /* Settable properties */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection, and any other value with return an error indicator. These IDs can be used to access the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlist properties ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* PlaylistByTitle
* PlaylistByID

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
* CursorType
* ShutdownAfterDisconnect
* ComServerUIActive
* Objects

=== Readable properties ===
==== Status properties ====
IsRunning
InPartyMode
RunningAsService

==== Path properties ====
ApplicationPath
EqualizerPath
IconsPath
PluginsPath
ScriptsPath
SkinsPath
MyMusicPath
TemporaryFolder
CurrentAddonInstallRoot
ScriptsIniFile

==== Version properties ====
VersionHi
VersionLo
VersionRelease
VersionBuild
VersionString

=== Methods ===
ProcessMessages
CreateTimer
MessageBox
SelectFolder
Format
toASCII
IsKnownFiletype
Localize
LocalizedFormat
LocalizeGen
RefreshScriptItems
RegisterIcon
RegisterIconHandle

MediaMonkey Automation Categorized

2014-09-07T20:40:56Z

Mcow: /* Main Window properties */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection, and any other value with return an error indicator. These IDs can be used to access the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlist properties ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object. This object provides access to specific aspects of the MediaMonkey UI, such as the menus, options dialog, property sheets, etc.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object. This object is used to initialize, update, and terminate a progress display in the MediaMonkey main window.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] returns an Object corresponding to the built-in Web Browser panel, which is displayed when the Web node of the MainTree is selected.

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* PlaylistByTitle
* PlaylistByID

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::IniFile|SDB.IniFile]] is an [[SDBIniFile]] object.

==== Registry ====
[[ISDBApplication::Registry|SDB.Registry]] is an [[SDBRegistry]] object.

=== Settable properties ===
CursorType

ShutdownAfterDisconnect
ComServerUIActive

Objects

=== Readable properties ===
==== Status properties ====
IsRunning
InPartyMode
RunningAsService

==== Path properties ====
ApplicationPath
EqualizerPath
IconsPath
PluginsPath
ScriptsPath
SkinsPath
MyMusicPath
TemporaryFolder
CurrentAddonInstallRoot
ScriptsIniFile

==== Version properties ====
VersionHi
VersionLo
VersionRelease
VersionBuild
VersionString

=== Methods ===
ProcessMessages
CreateTimer
MessageBox
SelectFolder
Format
toASCII
IsKnownFiletype
Localize
LocalizedFormat
LocalizeGen
RefreshScriptItems
RegisterIcon
RegisterIconHandle

MediaMonkey Automation Categorized

2014-09-07T20:37:25Z

Mcow: /* Utilities and Tools */

MediaMonkey Automation Categorized

2014-09-07T20:33:58Z

Mcow: /* Main Window properties */

MediaMonkey Automation Categorized

2014-09-07T20:33:34Z

Mcow: /* Utilities and Tools */

MediaMonkey Automation Categorized

2014-09-07T20:28:59Z

Mcow: /* MediaMonkey Automation Objects */

MediaMonkey Automation Categorized

2014-09-07T20:28:04Z

Mcow: /* Registry */

MediaMonkey Automation Categorized

2014-09-07T20:27:42Z

Mcow: /* IniFile */

MediaMonkey Automation Categorized

2014-09-07T20:27:14Z

Mcow: /* Utilities and Tools */

= MediaMonkey Automation Objects =

MediaMonkey's script environment provides two top-level objects accessible from a script running within MediaMonkey: '''SDB''' and '''Script'''. In an external program (written in a language such as C#) or script (such as in Python), these objects can be accessed by instantiating COM instances.

When a program instantiates a COM instance, the returned object connects directly to the running instance of MediaMonkey. MediaMonkey will be started at the time of instantiation if it is not already running.

== SDB ==

SDB is a [[SDBApplication|SongsDB.SDBApplication]] object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== Main Window properties ===
==== MainTracksWindow ====
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

==== MainTree ====
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

Related to MainTree are these properties:
* [[ISDBApplication::VisibleCollectionsCount|SDB.VisibleCollectionsCount]] is the number of collections visible in the Main Tree
* [[ISDBApplication::VisibleCollectionID|SDB.VisibleCollectionID]] accepts an index and returns the ID of the collection at that item.
So if VisibleCollectionsCount returns 3, VisibleCollectionID(0) will return the ID of the first visible collection, VisibleCollectionID(2) will return the ID of the third (and last) visible collection, and any other value with return an error indicator. These IDs can be used to access the collection object from the list of collections found in [[#Collections|SDB.Collections]].

==== Songlist properties ====
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

=== Library properties ===
==== Database ====
[[ISDBApplication::Database|SDB.Database]] is an [[SDBDatabase]] object.

==== Collections ====
[[ISDBApplication::Collections|SDB.Collections]] is an [[SDBCollections]] object, which is just a list of the defined collections. This object has only two members: Count and Item(). Item() returns an [[SDBCollection]] object.

Note that the ID of a collection is not its index; given a collection ID (e.g., from [[#MainTree|SDB.VisibleCollectionID]]), it is necessary to search this list for a collection with a matching ID to get the desired Collection object.

=== Utilities and Tools ===
==== UI ====
[[ISDBApplication::UI|SDB.UI]] is an [[SDBUI]] object.

==== CommonDialog ====
[[ISDBApplication::CommonDialog|SDB.CommonDialog]] is an [[SDBCommonDialog]] object.

==== Progress ====
[[ISDBApplication::Progress|SDB.Progress]] is an [[SDBProgress]] object.

==== WebControl ====
[[ISDBApplication::WebControl|SDB.WebControl]] is an [[SDBWebControl]] object.

==== Downloader ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Tools ====
[[ISDBApplication::Tools|SDB.Tools]] is an [[SDBTools]] object. It is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* PlaylistByTitle
* PlaylistByID

==== Device ====
[[ISDBApplication::Device|SDB.Device]] is an [[SDBDevice]] object. It is used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

==== IniFile ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

==== Registry ====
[[ISDBApplication::Downloader|SDB.Downloader]] is an [[SDBDownloader]] object.

=== Settable properties ===
CursorType

ShutdownAfterDisconnect
ComServerUIActive

Objects

=== Readable properties ===
==== Status properties ====
IsRunning
InPartyMode
RunningAsService

==== Path properties ====
ApplicationPath
EqualizerPath
IconsPath
PluginsPath
ScriptsPath
SkinsPath
MyMusicPath
TemporaryFolder
CurrentAddonInstallRoot
ScriptsIniFile

==== Version properties ====
VersionHi
VersionLo
VersionRelease
VersionBuild
VersionString

=== Methods ===
ProcessMessages
CreateTimer
MessageBox
SelectFolder
Format
toASCII
IsKnownFiletype
Localize
LocalizedFormat
LocalizeGen
RefreshScriptItems
RegisterIcon
RegisterIconHandle

== Script ==
Script is a top-level [[SDBScriptControl|SongsDB.SDBScriptControl]] object.

MediaMonkey Automation Categorized

2014-09-07T20:23:16Z

Mcow: /* Collections */

MediaMonkey Automation Categorized

2014-09-07T20:22:29Z

Mcow: /* Collections */

MediaMonkey Automation Categorized

2014-09-07T20:16:47Z

Mcow: /* SDB */

MediaMonkey Automation Categorized

2014-09-07T20:13:37Z

Mcow: /* MainTree */

MediaMonkey Automation Categorized

2014-09-07T20:12:44Z

Mcow: /* = Collections */

MediaMonkey Automation Categorized

2014-09-07T20:12:31Z

Mcow: /* Library properties */

MediaMonkey Automation Categorized

2014-09-07T20:08:58Z

Mcow: /* MediaMonkey Automation Objects */

MediaMonkey Automation Categorized

2014-09-07T19:35:56Z

Mcow: /* Songlist properties */

= MediaMonkey Automation Objects =

MediaMonkey's scripts provide two top-level objects that are accessible from a script running within MediaMonkey: <code>SDB</code> and <code>Script</code>. In an external program (such as C#) or script (such as Python), these objects can be accessed by instantiating COM instances of the type shown.

== SDB ==

SDB is a '''[[SDBApplication|SongsDB.SDBApplication]]''' object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== MainTracksWindow ===
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

=== MainTree ===
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

=== Songlist properties ===
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* [[ISDBApplication::AllVisibleSongList|SDB.AllVisibleSongList]] is the list of songs visible in the MainTracksWindow
* [[ISDBApplication::SelectedSongList|SDB.SelectedSongList]] is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* [[ISDBApplication::CurrentSongList|SDB.CurrentSongList]] is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

=== [[ISDBApplication::UI|UI]] is an [[SDBUI]] object ===
=== [[ISDBApplication::Tools|Tools]] is an [[SDBTools]] object ===
SDB.Tools is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* PlaylistByTitle
* PlaylistByID

=== [[ISDBApplication::Device|Device]] is an [[SDBDevice]] object ===
SDB.Device is the object used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

=== System Control ===
IniFile
Registry
Database

CursorType

ShutdownAfterDisconnect
ComServerUIActive

Objects

=== Status properties ===
IsRunning
InPartyMode
RunningAsService

=== Path properties ===
ApplicationPath
EqualizerPath
IconsPath
PluginsPath
ScriptsPath
SkinsPath
MyMusicPath
TemporaryFolder
CurrentAddonInstallRoot
ScriptsIniFile

=== Version properties ===
VersionHi
VersionLo
VersionRelease
VersionBuild
VersionString

== '''Script''' is a '''[[SDBScriptControl|SongsDB.SDBScriptControl]]''' object ==

MediaMonkey Automation Categorized

2014-09-07T19:33:02Z

Mcow: Created page with "= MediaMonkey Automation Objects = MediaMonkey's scripts provide two top-level objects that are accessible from a script running within MediaMonkey: <code>SDB</code> and <code>S..."

= MediaMonkey Automation Objects =

MediaMonkey's scripts provide two top-level objects that are accessible from a script running within MediaMonkey: <code>SDB</code> and <code>Script</code>. In an external program (such as C#) or script (such as Python), these objects can be accessed by instantiating COM instances of the type shown.

== SDB ==

SDB is a '''[[SDBApplication|SongsDB.SDBApplication]]''' object. It is the main point of access for MediaMonkey's internals. It has numerous properties which yield objects modeling various components of the program; other properties which yield strings, integers, or flags; and some methods that perform various actions.

SDB is an "evented" object, which means scripts can register functions (callbacks) that will be called when [[SDBApplication#ISDBApplicationEvents_members|certain events]] occur within MediaMonkey. This allows the script to respond without having to poll MediaMonkey repeatedly for conditions.

The members of SDB are:

=== Player ===
[[ISDBApplication::Player|SDB.Player]] is an [[SDBPlayer]] object. It allows access to the player functions: starting, stopping, pausing, skipping and so forth.
The player also generates events, which are part of the SDB's event notifications. Only the simplest scripts to control playback will not need to use events.

=== MainTracksWindow ===
[[ISDBApplication::MainTracksWindow|SDB.MainTracksWindow]] is an [[SDBTracksWindow]] object. It gives access to the track entries shown in MediaMonkey's main window.

=== MainTree ===
[[ISDBApplication::MainTree|SDB.MainTree]] is an [[SDBTree]] object. It gives access to the nodes in the tree in MediaMonkey's main window.

=== Songlist properties ===
Related to MainTracksWindow and MainTree are these properties, each of which yields an [[SDBSongList]] that can be queried for Count and individual Items, and other information.
* AllVisibleSongList is the list of songs visible in the MainTracksWindow
* SelectedSongList is the list of ''selected'' songs in either the MainTracksWindow or the Now Playing pane, depending on which has focus.
* CurrentSongList is the same as either AllVisibleSongList (if the focus is on the MainTree) or SelectedSongList (if the focus is on the MainTracksWindow or the Now Playing pane).

=== [[ISDBApplication::UI|UI]] is an [[SDBUI]] object ===
=== [[ISDBApplication::Tools|Tools]] is an [[SDBTools]] object ===
SDB.Tools is a utility object which contains a number of methods and a few properties of use to scripts.
SDB also has a few properties of its own which are similar to those in Tools:
* PlaylistByTitle
* PlaylistByID

=== [[ISDBApplication::Device|Device]] is an [[SDBDevice]] object ===
SDB.Device is the object used to access "portable devices" in the system. It does not correspond to a single device itself, but can be queried for individual devices which can then be operated on.

=== System Control ===
IniFile
Registry
Database

CursorType

ShutdownAfterDisconnect
ComServerUIActive

Objects

=== Status properties ===
IsRunning
InPartyMode
RunningAsService

=== Path properties ===
ApplicationPath
EqualizerPath
IconsPath
PluginsPath
ScriptsPath
SkinsPath
MyMusicPath
TemporaryFolder
CurrentAddonInstallRoot
ScriptsIniFile

=== Version properties ===
VersionHi
VersionLo
VersionRelease
VersionBuild
VersionString

== '''Script''' is a '''[[SDBScriptControl|SongsDB.SDBScriptControl]]''' object ==

ISDBUI::ShowOptions

2014-09-07T19:16:30Z

Mcow: /* Method description */

{{MethodDeclaration|SDBUI|ISDBUI|Sub ShowOptions(SheetId As Long)}}

===Parameters===

{{MethodParameters
|ParentId |Long |Either an ID returned from a previous call to AddOptionSheet or 0 for the last shown options sheet. See other [[possible option sheet values]].}}

===Method description===

Shows Options dialog where the chosen sheet is selected. The function returns when the options dialog is closed.

===Related Topics===

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBUI|{{PAGENAME}}]]
[[Category:Interface ISDBUI|{{PAGENAME}}]]

Compatible Devices

2013-11-22T04:40:20Z

Mcow: Added link to Android-sync-howto page

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
:[[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]]

Sync MediaMonkey with an Android device

2013-11-22T04:37:25Z

Mcow: /* Syncing tips and tricks */

= Available sync modes with Android devices =

If you sync your Mediamonkey library with a mobile device, the following things will happen: 

*Mediamonkey will transfer songs to the mobile device to play on the road. 
*For subsequent syncs with the same device, Mediamonkey will notice if you have played a song on your device, added it to a playlist or given it a star-rating. Mediamonkey will then import this information into the Mediamonkey library. 
*If you have added music files to your mobile devices from other sources since the last sync, you can optionally tell Mediamonkey to retrieve these files from your mobile phone and import them into your Mediamonkey library. 
*Optionally, you can also tell Mediamonkey to erase all music files on your mobile device that aren't in your Mediamonkey library. 

Note that there are two different syncing types (automatic and manual) and two different ways for connecting your mobile device to Mediamoney (WiFi and USB). 

== Auto-Syncing vs. manual syncing ==

There are two ways in which you can move music files to your mobile device: automatic and manual mode.

Automatic syncing uses a pre-defined list of files and syncs them with your device. These lists are configured in Tools-Options-Portable Device Sync. Here you can choose that you want Mediamoneky to send your entire library to your device (if it is big enough), or only a randomized selection, or only songs of a certain band/genre/album, or only songs from the "Sunday morning" "Driving music" "New purchases" and "Workout" playlists... The point is that once you have to define only once what should be synced - and every time you plug in your device, Mediamonkey will sync it according to your criteria. An auto-sync can either be initiated automatically whenever you connect your device, or by right-clicking on your device icon in the Mediamonkey tree and selecting "Auto-Sync".

Manual syncing in contrast allows you to pick individual songs/albums/playlists etc and send them manually over to your device. To initiate a manual sync, right-click on the desired song/album/playlist and select "Send to", then select your device. Manual syncing requires a USB connection.

== WiFi Syncing vs. USB Syncing ==

Wifi Syncing is the most convenient way to sync your Mediamonkey library to an Android device. It is the most convenient option. However, it is slower than syncing over a USB cable and it requires that you use Mediamonkey for Android as your media player on your Android device. 

If you want to use a different audio player instead, or if you want the fastest transfer speed, you should use USB syncing.

== Setting up WiFi Syncing ==

You will need:

*Mediamonkey for Windows (MMW), version 4.1, available as beta in the [http://www.mediamonkey.com/forum/viewtopic.php?f=6&t=54426 forum], and
*Mediamonkey for Android (MMA), available as beta from [https://play.google.com/store/apps/details?id=com.ventismedia.android.mediamonkeybeta Google play]) 
*Both your computer running MMW as well as your Android device running MMA need to be connected to the same WiFi network. 

 To set up wifi syncing:

#On your desktop machine running MMW, go to Tools - Options - Media Sharing, and set up the sharing options for your library. When MMA (or any UPnP player) is browsing into the MediaMonkey server, it will see only the libraries and playlists that you share. If you use the options in MMA to select items for sync, it will only be able to add items that it can see on the UPnP server.
#On your Android device, start Mediamonkey (MMA) and enter the Options; scroll down to "WI-FI SYNC." Choose "Select Sync Server" and select the MMW server. As an alternative to going to Options, you can just hit the "Sync now" tile on the homescreen (or from the menu).
#Select the Media Sharing server you set up in step 1. Note: If you don't see your shared library in the list, make sure that MMW is running, that both your computer and your Android device are connected to the same network, and that the Windows firewall has an active exception defined for Mediamonkey.
#On your desktop, MMW will show a popup notification that a device wants to connect for syncing. Confirm.
#On your desktop, MMW will create a synchronization profile for your Android device. Go to Tools - Options - Portable Device Sync, highlight your device profile and click on "Configure" to select which Tracks/Artists/Albums/Genres/Folders/Playlists etc should be synced over to your device. Alternately, you can also select what to sync within MMA's options. For some devices, there may be two profiles, one for Internal and one for External storage. You can set up one or the other, or even both (each with a unique sync list).
#Click on the "Sync now" tile on MMA start screen and wait for for the sync to complete. Note that WiFi syncing will be slower than syncing over an USB cable, so be patient, especially during the first sync. It's best to run this overnight

== USB Syncing ==

You will need to use USB Syncing instead of WiFi Syncing if you don't want to use MMA as your Android player, or if you prefer the higher transfer speeds of the USB cable. 

To set up USB sync:

#Plug your device into a USB port of your computer.
#go to Tools - Options - Portable Device Sync and create a device profile using the correct plugin for your device: highlight the plugin, the click on "Configure".
#For devices connected in MSC mode (i.e. as a mass storage device with a drive letter), go to the "Options" tab, click on "device configuration" and tell Mediamonkey how to recognize your device (by USB device ID, by the drive letter, or the drive label).
#Switch to the "Auto-Sync (-> device)" tab to determine which files should get synced over to your device.
#Close the Plugin configuration and the Options panel.
#Now you should see a new node in the tree on the left panel of Mediamonkey for your device. Right-click on it, and select Auto-Sync.
#Wait for the sync to complete (watch the progress bar) - then safely eject your device before unplugging it from your computer.

== Syncing tips and tricks ==

*If you want to use BOTH wifi and usb syncing with the same device (e.g. to do big syncs over the cable and small daily syncs over wifi), you should first set up your device for USB syncing, and then in the plugin configuration on the "Summary" tab, check the "grant remote sync/access rights" box to enable wifi syncing for the same profile as well. If you instead set up wifi syncing first, you will likely use a different plugin - causing you to end up with two different syncing profiles for your device - one for wifi, the other for usb.
*You may not want to share all the playlists; selectivity leads to easier browsing. You can sync playlists that are not shared by selecting them in MMW. Once those have been synced, the playlists will appear in the MMA options; can then deselect them from MMA.
*Auto-playlists will sync whatever content has changed each time. A randomly-generated autoplaylist will replace all the previous entries with a new set of entries with each sync.

Sync MediaMonkey with an Android device

2013-11-22T04:32:06Z

Mcow: Expanded instructions

Sync MediaMonkey with an Android device

2013-11-22T04:16:28Z

Mcow: Add note about manual requiring USB

= Available sync modes with Android devices =

If you sync your Mediamonkey library with a mobile device, the following things will happen: 

*Mediamonkey will transfer songs to the mobile device to play on the road. 
*For subsequent syncs with the same device, Mediamonkey will notice if you have played a song on your device, added it to a playlist or given it a star-rating. Mediamonkey will then import this information into the Mediamonkey library. 
*If you have added music files to your mobile devices from other sources since the last sync, you can optionally tell Mediamonkey to retrieve these files from your mobile phone and import them into your Mediamonkey library. 
*Optionally, you can also tell Mediamonkey to erase all music files on your mobile device that aren't in your Mediamonkey library. 

Note that there are two different syncing types (automatic and manual) and two different ways for connecting your mobile device to Mediamoney (WiFi and USB). 

== Auto-Syncing vs. manual syncing ==

There are two ways in which you can move music files to your mobile device: automatic and manual mode.

Automatic syncing uses a pre-defined list of files and syncs them with your device. These lists are configured in Tools-Options-Portable Device Sync. Here you can choose that you want Mediamoneky to send your entire library to your device (if it is big enough), or only a randomized selection, or only songs of a certain band/genre/album, or only songs from the "Sunday morning" "Driving music" "New purchases" and "Workout" playlists... The point is that once you have to define only once what should be synced - and every time you plug in your device, Mediamonkey will sync it according to your criteria. An auto-sync can either be initiated automatically whenever you connect your device, or by right-clicking on your device icon in the Mediamonkey tree and selecting "Auto-Sync".

Manual syncing in contrast allows you to pick individual songs/albums/playlists etc and send them manually over to your device. To initiate a manual sync, right-click on the desired song/album/playlist and select "Send to", then select your device. Manual syncing requires a USB connection.

== WiFi Syncing vs. USB Syncing ==

Wifi Syncing is the most convenient way to sync your Mediamonkey library to an Android device. It is the most convenient option. However, it is slower than syncing over a USB cable and it requires that you use Mediamonkey for Android as your media player on your Android device. 

If you want to use a different audio player instead, or if you want the fastest transfer speed, you should use USB syncing.

== Setting up WiFi Syncing ==

You will need:

*Mediamonkey for Windows (MMW), version 4.1, available as beta in the [http://www.mediamonkey.com/forum/viewtopic.php?f=6&t=54426 forum], and
*Mediamonkey for Android (MMA), available as beta from [https://play.google.com/store/apps/details?id=com.ventismedia.android.mediamonkeybeta Google play]) 
*Both your computer running MMW as well as your Android device running MMA need to be connected to the same WiFi network. 

 To set up wifi syncing:

#On your desktop machine running MMW, go to Tools - Options - Media Sharing, and set up the sharing options for your library.
#On your Android device, start Mediamonkey (MMA) and hit the "Sync now" tile.
#Select the Media Sharing server you set up in step 1. Note: If you don't see your shared library in the list, make sure that MMW is running, that both your computer and your Android device are connected to the same network, and that the Windows firewall has an active exception defined for Mediamonkey.
#On your desktop, MMW will show a popup notification that a device wants to connect for syncing. Confirm.
#On your desktop, MMW will create a synchronization profile for your Android device. Go to Tools - Options - Portable Device Sync, highlight your device profile and click on "Configure" to select which Tracks/Artists/Albums/Genres/Folders/Playlists etc should be synced over to your device. Alternatively, you can also select what to sync within MMA's options.
#Click on the "Sync now" tile on MMA start screen and wait for for the sync to complete. Note that WiFi syncing will be slower than syncing over an USB cable, so be patient, especially during the first sync. It's best to run this overnight

== USB Syncing ==

You will need to use USB Syncing instead of WiFi Syncing if you don't want to use MMA as your Android player, or if you prefer the higher transfer speeds of the USB cable. 

To set up USB sync:

#Plug your device into a USB port of your computer.
#go to Tools - Options - Portable Device Sync and create a device profile using the correct plugin for your device: highlight the plugin, the click on "Configure".
#For devices connected in MSC mode (i.e. as a mass storage device with a drive letter), go to the "Options" tab, click on "device configuration" and tell Mediamonkey how to recognize your device (by USB device ID, by the drive letter, or the drive label).
#Switch to the "Auto-Sync (-> device)" tab to determine which files should get synced over to your device.
#Close the Plugin configuration and the Options panel.
#Now you should see a new node in the tree on the left panel of Mediamonkey for your device. Right-click on it, and select Auto-Sync.
#Wait for the sync to complete (watch the progress bar) - then safely eject your device before unplugging it from your computer.

== Syncing tips and tricks ==

*If you want to use BOTH wifi and usb syncing with the same device (e.g. to do big syncs over the cable and small daily syncs over wifi), you should first set up your device for USB syncing, and then in the plugin configuration on the "Summary" tab, check the "grant remote sync/access rights" box to enable wifi syncing for the same profile as well. If you instead set up wifi syncing first, you will likely use a different plugin - causing you to end up with two different syncing profiles for your device - one for wifi, the other for usb.

MediaMonkey for Android

2013-07-30T01:16:31Z

Mcow: linkified

= Introduction =

MediaMonkey for Android is an advanced media player for Android, that helps you navigate large music collections on portable devices. It keeps your music library in sync with MediaMonkey for Windows via Wi-Fi. Key features in the initial release include:

*Content Navigation for Music, Audiobooks, Podcasts, Video, ...
*Navigation by various subcategories (e.g. by Artist, Album, Composer, Genre, Playlist)
*Playback (relies on native Android codecs).
*Supports replay gain, bookmarks, quickshuffle.
*UPnP/DLNA client with download manager.
*Contextual functions for single/multiple files (e.g. play, queue, playlist management, delete, use as ringtone, share, edit)
*Playlist management with hierarchy Now Playing views: Individual (swipeable UI for in-car use) / Tracklist Wireless sync with MediaMonkey for Windows

 MediaMonkey for Android is presently in beta testing.

 

For more information see:

[http://www.mediamonkey.com/forum/viewforum.php?f=21 MediaMonkey for Android Beta Forum] 

Download --> [https://play.google.com/store/apps/details?id=com.ventismedia.android.mediamonkeybeta Google Play page]

ISDBApplication::MainTracksWindow

2013-03-19T03:38:08Z

Mcow: Add link to return object type.

{{MethodDeclaration|SDBApplication|ISDBApplication|Property Get MainTracksWindow As ISDBTracksWindow}}

===Property description===

Returns [[SDBTracksWindow]] object for operations on tracklist window.

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

SDBApplication

2013-02-14T06:29:17Z

Mcow: Added entry for OnTrackDoubleClick

{{AutomationObjectsList}}
== CoClass SDBApplication ==

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

=== ISDBApplication members ===

{{MethodsList
|[[ISDBApplication::AllVisibleSongList|AllVisibleSongList]] |Property Get |
|[[ISDBApplication::ApplicationPath|ApplicationPath]] |Property Get |
|[[ISDBApplication::EqualizerPath|EqualizerPath]] |Property Get |
|[[ISDBApplication::IconsPath|IconsPath]] |Property Get |
|[[ISDBApplication::PluginsPath|PluginsPath]] |Property Get |
|[[ISDBApplication::CurrentAddonInstallRoot|CurrentAddonInstallRoot]] |Property Get | From 4.0
|[[ISDBApplication::ScriptsPath|ScriptsPath]] |Property Get |
|[[ISDBApplication::SkinsPath|SkinsPath]] |Property Get |
|[[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 |
|[[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 |
|[[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 |
|[[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 v4.0
|[[ISDBApplicationEvents::OnDownloadFinished|OnDownloadFinished]] |Event | From v4.0
|[[ISDBApplicationEvents::OnFilterChange|OnFilterChange]] |Event |
|[[ISDBApplicationEvents::OnIdle|OnIdle]] |Event |
|[[ISDBApplicationEvents::OnNowPlayingModified|OnNowPlayingModified]] |Event |
|[[ISDBApplicationEvents::OnNowPlayingSelectionChanged|OnNowPlayingSelectionChanged]] |Event |
|[[ISDBApplicationEvents::OnOptionsChange|OnOptionsChange]] |Event |
|[[ISDBApplicationEvents::OnPause|OnPause]] |Event |
|[[ISDBApplicationEvents::OnPlay|OnPlay]] |Event |
|[[ISDBApplicationEvents::OnPlaybackEnd|OnPlaybackEnd]] |Event |
|[[ISDBApplicationEvents::OnRepeatClicked|OnRepeatClicked]] |Event |
|[[ISDBApplicationEvents::OnSeek|OnSeek]] |Event |
|[[ISDBApplicationEvents::OnShuffleClicked|OnShuffleClicked]] |Event |
|[[ISDBApplicationEvents::OnShutdown|OnShutdown]] |Event |
|[[ISDBApplicationEvents::OnStop|OnStop]] |Event |
|[[ISDBApplicationEvents::OnTrackAdded|OnTrackAdded]] |Event |
|[[ISDBApplicationEvents::OnTrackConverted|OnTrackConverted]] |Event |
|[[ISDBApplicationEvents::OnTrackDeleting|OnTrackDeleting]] |Event |
|[[ISDBApplicationEvents::OnTrackDoubleClick|OnTrackDoubleClick]] |Event |
|[[ISDBApplicationEvents::OnTrackEnd|OnTrackEnd]] |Event |
|[[ISDBApplicationEvents::OnTrackListFilled|OnTrackListFilled]] |Event |
|[[ISDBApplicationEvents::OnTrackListFilling|OnTrackListFilling]] |Event |
|[[ISDBApplicationEvents::OnTrackListModified|OnTrackListModified]] |Event | From v4.0
|[[ISDBApplicationEvents::OnTrackListSelectionChanged|OnTrackListSelectionChanged]] |Event |
|[[ISDBApplicationEvents::OnTrackProperties|OnTrackProperties]] |Event |
|[[ISDBApplicationEvents::OnTrackSkipped|OnTrackSkipped]] |Event | From v4.0
|[[ISDBApplicationEvents::OnPartyModeEnabled|OnPartyModeEnabled]] |Event | From v4.1
}}

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

ISDBSongData::Date

2012-04-15T19:55:57Z

Mcow: Wrote description of property

{{MethodDeclaration|SDBSongData|ISDBSongData|Property Get/Let Date As Date}}

===Property description===
Apparently returns the date&time at the moment that you call; that is, returns ''Now''. The value is not a property of the track.

(Ignore the "complete script" below, which is generated by some wiki macro that's too obscure to debug.)

{{Property Summary|SongData|Date|[[DateType|Date]]|||||2/04/2008 4:36 PM|}}

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

DateType

2012-04-15T19:46:34Z

Mcow: fixed erroneous use of BBCode

DateType is a date-identifier. At base, it is a floating-point number expressing seconds since the epoch (nominally 1-Jan-1970 0:00 UTC).

In Python, properties of this value will be returned as PyTime objects. It can be converted to a timestamp using float() or int():
<pre>
lpDate = track.DatePlayed
timestamp = float(lpDate) # or int(lpDate)
dateobj = datetime.utcfromtimestamp(timestamp)
</pre>

DateType

2012-04-15T19:41:53Z

Mcow: Added basic description of DateType

DateType is a date-identifier. At base, it is a floating-point number expressing seconds since the epoch (nominally 1-Jan-1970 0:00 UTC).

In Python, properties of this value will be returned as PyTime objects. It can be converted to a timestamp using float() or int():
[code]
lpDate = track.DatePlayed
timestamp = float(lpDate) # or int(lpDate)
dateobj = datetime.utcfromtimestamp(timestamp)
[/code]

SDBSongData

2012-04-15T19:37:14Z

Mcow: Added DateType return value for date properties

{{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::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}}]]

SDBSongData

2012-04-15T19:35:31Z

Mcow: Update table show types of non-Tag properties

{{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
|
|
|
|
|
|
|-
|[[ISDBSongData::DateAdded|DateAdded]]
|Property Get/Let
|
|
|DateAdded
|REAL
|
|
|-
|[[ISDBSongData::DateDBModified|DateDBModified]]
|Property Get
|
|
|
|
|
|
|-
|[[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::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}}]]

This example

2011-07-20T15:52:40Z

Mcow: This example moved to Python event handling: bad original link

#REDIRECT [[Python event handling]]