MediaMonkey Wiki - User contributions [en]

WebHelp:What's New/5.0

2022-12-11T18:30:38Z

Chrisjj: /* What's Different? */

[[Main Page|Wiki Home]] > [[{{WebHelp:Links|Content}}|MediaMonkey {{#titleparts: {{PAGENAME}} | | -1}} Help]] > [[{{WebHelp:Links|Introduction}}|Introduction]] > What's New in MediaMonkey {{#titleparts: {{PAGENAME}} | | -1}}

----

{{WebHelpHeader|What's New in MediaMonkey 5}}

MediaMonkey for Windows 5 is a major new release. It's faster, simpler, and more powerful than ever before.

[https://www.mediamonkey.com/download Get it / Upgrade here].

== What's New? ==

* A slick, modern look and feel that's easier on the eyes and faster to navigate.
* [[{{WebHelp:Links|Getting_Track_Information_from_the_Internet}}|Auto-Tagging]] with audio-fingerprint-based lookup, to quickly lookup metadata and update your tags.
* Play content throughout your home via [[{{WebHelp:Links|Setting_UPnP_DLNA_Media_Servers}}#Streaming.2FCasting_MediaMonkey_Audio_to_a_DLNA_or_Chromecast_Renderer|Google Cast]] (Chromecast) devices (in addition to already-supported UPnP/DLNA devices).
* Use [[{{WebHelp:Links|Cloud Services}}|Cloud Services ''(Dropbox, Google Drive and OneDrive)'']] and [[{{WebHelp:Links|Syncing_with_Services}}|Deezer & Spotify]] for your media content.
* Create and edit more advanced [[{{WebHelp:Links|Using_AutoPlaylists}}|AutoPlaylists]].
* Faster playlist editing via new [[{{WebHelp:Links|Using_Playlists}}#Editing_a_Playlist|Playlist windows]]
* Improved play controls ([[{{WebHelp:Links|Playing_Audio_Tracks}}#More_Options_to_add_files_to_the_Playing_Queue|play shuffled, shuffled by album]], [[{{WebHelp:Links|Player}}#Stopping_Playback|stop after every file]])
* Quick on-the-fly tag editing in the [[{{WebHelp:Links|Customizing_MediaMonkey}}#Customizing_Preview|Preview]] window
* New and improved Views for a better media browsing experience:
** View Artist and Album information from other sources directly in MediaMonkey (via 'Info panel's).
** Full screen 'Playing modes' to display Artist/Album/Lyric information as tracks play.
** [[{{WebHelp:Links|My_Computer}}#Pinned|Pinned]] items (Favorites) to quickly access your favorite content or playlists.
** Improved [[{{WebHelp:Links|Search}}|search]] and filtering functionality, to customize which content to display.
** Quickly [[{{WebHelp:Links|Exploring_Tracks}}|hide/unhide]] panels depending on whether you need extra space for editing or playing.
** Touch mode optimized for tablets
* [[{{WebHelp:Links|Backing_up_the_Library}}|Backup and restore]] the database automatically, for more peace of mind.
* Support for playback of DSD (.dff/.dsf) files has been added.
* Support for more standardized tags and:
** New support for [[{{WebHelp:Links|Editing_Track_Properties}}#Custom_Tags|extended tags]] (available only in the Properties dialog).
** [[{{WebHelp:Links|Editing_Track_Properties}}#Custom_Tags|5 more custom fields]]
* + more...

[[File:Wiki-MM5 What's New.jpg|1000px|center|MediaMonkey]]

== What's Different? ==

* MediaMonkey 5 cannot run existing (MediaMonkey 4) scripts.
* MediaMonkey 5 has new Addons and Skinning engines. The new framework is more powerful and cross-platform, but Addons and Skins from MediaMonkey 4 and older aren't compatible. More [[{{WebHelp:Links|Customizing_MediaMonkey}}#Customizing_the_Skin|Skins]] and [[{{WebHelp:Links|Creating_Custom_Scripts}}#Installing_Addons|Addons]] are being developed all the time.
* The default UI uses a material design theme, but if you prefer the MM4 dark theme just [[{{WebHelp:Links|Customizing_MediaMonkey}}#Customizing_the_Skin|switch]] to it.
* The UI is now divided into configurable panels that are now configured via Options > '[[{{WebHelp:Links|Customizing_MediaMonkey}}#Customizing_the_Layout|Layout]]'.
* The Media Tree by default is only one level deep. If you prefer to navigate using the Media Tree, click the ⋮ symbol in the Media Tree, and enable 'Show all subnodes'.
* The Media Tree can be [[{{WebHelp:Links|Customizing_MediaMonkey}}#Customizing_the_Layout|collapsed]] entirely if desired, and breadcrumbs and the 'Collection Browser' element used to navigate instead.
* [[{{WebHelp:Links|Player}}#Visualization|Visualizations]] have been integrated into the [[{{WebHelp:Links|Customizing_MediaMonkey}}#Customizing_Preview|Preview]] window.
* [[{{WebHelp:Links|My_Computer}}#Devices_.26_Services|Devices (and services)]] are now configurable as 'Media Tree Nodes' instead of via the menu.
* The 'View' switcher still switches between Views, but they are now customizable. Each View defines 'View Type', Columns & Sorts, and incorporated View Elements. Views are saved per Node (where node= Collection > Node, Collection > Node > Subnode , Now Playing, Playlists), so that for example, if you switch from Artists to Albums the View can change. View Type defines non-configurable elements of the View.
* The default views use more Album Art, Artist images, and dynamic content. If you prefer minimalist list views, just switch to the 'List' views which are similar to MediaMonkey 4 default settings.
* Searching the current view can be initiated just by typing a search term when the track list is in focus. Such '[[{{WebHelp:Links|Search}}#Contextual_Search|contextual searches]]' can be configured to 'filter matches' in the current view or to 'scroll to match' the search term (in the field used as the current sort order).
* There's a single customizable [[{{WebHelp:Links|Customizing_MediaMonkey}}#Custom_Toolbar|Toolbar]].

== What's Missing? ==

* MediaMonkey 5 is Windows 10+ only. Older versions of Windows are supported by [https://www.mediamonkey.com/support/knowledge-base/mediamonkey-general/download-mediamonkey/ MediaMonkey 4].
* Winamp ([[{{WebHelp:Links|Player_Plugin_Configuration}}|input, output plugins]] are compatible, but 'General', DSP and Visualization plugins are no longer supported.
* Virtual CD & Previews functionality has been deprecated. Virtual CD tracks are imported as standard library tracks, while Previews are imported but can no longer be created.
* MediaMonkey no longer has an unskinned (Windows Theme) version.
* Artist and Album Comment are not made available in MediaMonkey 5. The data itself is still stored in the database.

== How to make MediaMonkey 5 appear more like MediaMonkey 4 ==

By default new features like the [[{{WebHelp:Links|Filelisting}}#Changing_Views|Browser View]] and a modern [[{{WebHelp:Links|Customizing_MediaMonkey}}#Customizing_the_Skin|Skin]] are used in MediaMonkey 5. However old Views and an old style Skin are available in MediaMonkey 5:
* You can [[{{WebHelp:Links|Customizing_MediaMonkey}}#Customizing_the_Skin|change]] to the Metro M (Classic) Skin under '''Tools > Options > Skins''' from the Main Menu for a more MediaMonkey 4 design.
* You can download and [[{{WebHelp:Links|Creating_Custom_Scripts}}#Installing_Addons|install]] the [https://www.mediamonkey.com/addons/browse/item/3d-flow-album-view/ 3D Flow Album View Addon]
* You can [[{{WebHelp:Links|Filelisting}}#Changing_Views|change]] the way your files are displayed in the Filelisting:
** Show Details now is ''List''
** Show Art now is ''Grid''
** Show art with Details now is '' List by Album''
** Show Art Browser with Details now is ''3d Album View'' (provided by additional [https://www.mediamonkey.com/addons/browse/item/3d-flow-album-view/ 3D Flow Album View Addon])
** Column Browser now is ''Column filter''

== Related ==

* [[{{WebHelp:Links|Installation}}|Installing MediaMonkey]]
* [[{{WebHelp:Links|Upgrading_to_the_Gold_Version}}#Gold_Features|MediaMonkey Gold Features]]

{{WebHelpFooter}}

WebHelp:What's New/5.0

2022-12-11T18:20:57Z

Chrisjj: /* What's New? */

[[Main Page|Wiki Home]] > [[{{WebHelp:Links|Content}}|MediaMonkey {{#titleparts: {{PAGENAME}} | | -1}} Help]] > [[{{WebHelp:Links|Introduction}}|Introduction]] > What's New in MediaMonkey {{#titleparts: {{PAGENAME}} | | -1}}

----

{{WebHelpHeader|What's New in MediaMonkey 5}}

MediaMonkey for Windows 5 is a major new release. It's faster, simpler, and more powerful than ever before.

[https://www.mediamonkey.com/download Get it / Upgrade here].

== What's New? ==

* A slick, modern look and feel that's easier on the eyes and faster to navigate.
* [[{{WebHelp:Links|Getting_Track_Information_from_the_Internet}}|Auto-Tagging]] with audio-fingerprint-based lookup, to quickly lookup metadata and update your tags.
* Play content throughout your home via [[{{WebHelp:Links|Setting_UPnP_DLNA_Media_Servers}}#Streaming.2FCasting_MediaMonkey_Audio_to_a_DLNA_or_Chromecast_Renderer|Google Cast]] (Chromecast) devices (in addition to already-supported UPnP/DLNA devices).
* Use [[{{WebHelp:Links|Cloud Services}}|Cloud Services ''(Dropbox, Google Drive and OneDrive)'']] and [[{{WebHelp:Links|Syncing_with_Services}}|Deezer & Spotify]] for your media content.
* Create and edit more advanced [[{{WebHelp:Links|Using_AutoPlaylists}}|AutoPlaylists]].
* Faster playlist editing via new [[{{WebHelp:Links|Using_Playlists}}#Editing_a_Playlist|Playlist windows]]
* Improved play controls ([[{{WebHelp:Links|Playing_Audio_Tracks}}#More_Options_to_add_files_to_the_Playing_Queue|play shuffled, shuffled by album]], [[{{WebHelp:Links|Player}}#Stopping_Playback|stop after every file]])
* Quick on-the-fly tag editing in the [[{{WebHelp:Links|Customizing_MediaMonkey}}#Customizing_Preview|Preview]] window
* New and improved Views for a better media browsing experience:
** View Artist and Album information from other sources directly in MediaMonkey (via 'Info panel's).
** Full screen 'Playing modes' to display Artist/Album/Lyric information as tracks play.
** [[{{WebHelp:Links|My_Computer}}#Pinned|Pinned]] items (Favorites) to quickly access your favorite content or playlists.
** Improved [[{{WebHelp:Links|Search}}|search]] and filtering functionality, to customize which content to display.
** Quickly [[{{WebHelp:Links|Exploring_Tracks}}|hide/unhide]] panels depending on whether you need extra space for editing or playing.
** Touch mode optimized for tablets
* [[{{WebHelp:Links|Backing_up_the_Library}}|Backup and restore]] the database automatically, for more peace of mind.
* Support for playback of DSD (.dff/.dsf) files has been added.
* Support for more standardized tags and:
** New support for [[{{WebHelp:Links|Editing_Track_Properties}}#Custom_Tags|extended tags]] (available only in the Properties dialog).
** [[{{WebHelp:Links|Editing_Track_Properties}}#Custom_Tags|5 more custom fields]]
* + more...

[[File:Wiki-MM5 What's New.jpg|1000px|center|MediaMonkey]]

== What's Different? ==

* MediaMonkey 5 has new Addons and Skinning engines. The new framework is more powerful and cross-platform, but Addons and Skins from MediaMonkey 4 and older aren't compatible. More [[{{WebHelp:Links|Customizing_MediaMonkey}}#Customizing_the_Skin|Skins]] and [[{{WebHelp:Links|Creating_Custom_Scripts}}#Installing_Addons|Addons]] are being developed all the time.
* The default UI uses a material design theme, but if you prefer the MM4 dark theme just [[{{WebHelp:Links|Customizing_MediaMonkey}}#Customizing_the_Skin|switch]] to it.
* The UI is now divided into configurable panels that are now configured via Options > '[[{{WebHelp:Links|Customizing_MediaMonkey}}#Customizing_the_Layout|Layout]]'.
* The Media Tree by default is only one level deep. If you prefer to navigate using the Media Tree, click the ⋮ symbol in the Media Tree, and enable 'Show all subnodes'.
* The Media Tree can be [[{{WebHelp:Links|Customizing_MediaMonkey}}#Customizing_the_Layout|collapsed]] entirely if desired, and breadcrumbs and the 'Collection Browser' element used to navigate instead.
* [[{{WebHelp:Links|Player}}#Visualization|Visualizations]] have been integrated into the [[{{WebHelp:Links|Customizing_MediaMonkey}}#Customizing_Preview|Preview]] window.
* [[{{WebHelp:Links|My_Computer}}#Devices_.26_Services|Devices (and services)]] are now configurable as 'Media Tree Nodes' instead of via the menu.
* The 'View' switcher still switches between Views, but they are now customizable. Each View defines 'View Type', Columns & Sorts, and incorporated View Elements. Views are saved per Node (where node= Collection > Node, Collection > Node > Subnode , Now Playing, Playlists), so that for example, if you switch from Artists to Albums the View can change. View Type defines non-configurable elements of the View.
* The default views use more Album Art, Artist images, and dynamic content. If you prefer minimalist list views, just switch to the 'List' views which are similar to MediaMonkey 4 default settings.
* Searching the current view can be initiated just by typing a search term when the track list is in focus. Such '[[{{WebHelp:Links|Search}}#Contextual_Search|contextual searches]]' can be configured to 'filter matches' in the current view or to 'scroll to match' the search term (in the field used as the current sort order).
* There's a single customizable [[{{WebHelp:Links|Customizing_MediaMonkey}}#Custom_Toolbar|Toolbar]].

== What's Missing? ==

* MediaMonkey 5 is Windows 10+ only. Older versions of Windows are supported by [https://www.mediamonkey.com/support/knowledge-base/mediamonkey-general/download-mediamonkey/ MediaMonkey 4].
* Winamp ([[{{WebHelp:Links|Player_Plugin_Configuration}}|input, output plugins]] are compatible, but 'General', DSP and Visualization plugins are no longer supported.
* Virtual CD & Previews functionality has been deprecated. Virtual CD tracks are imported as standard library tracks, while Previews are imported but can no longer be created.
* MediaMonkey no longer has an unskinned (Windows Theme) version.
* Artist and Album Comment are not made available in MediaMonkey 5. The data itself is still stored in the database.

== How to make MediaMonkey 5 appear more like MediaMonkey 4 ==

By default new features like the [[{{WebHelp:Links|Filelisting}}#Changing_Views|Browser View]] and a modern [[{{WebHelp:Links|Customizing_MediaMonkey}}#Customizing_the_Skin|Skin]] are used in MediaMonkey 5. However old Views and an old style Skin are available in MediaMonkey 5:
* You can [[{{WebHelp:Links|Customizing_MediaMonkey}}#Customizing_the_Skin|change]] to the Metro M (Classic) Skin under '''Tools > Options > Skins''' from the Main Menu for a more MediaMonkey 4 design.
* You can download and [[{{WebHelp:Links|Creating_Custom_Scripts}}#Installing_Addons|install]] the [https://www.mediamonkey.com/addons/browse/item/3d-flow-album-view/ 3D Flow Album View Addon]
* You can [[{{WebHelp:Links|Filelisting}}#Changing_Views|change]] the way your files are displayed in the Filelisting:
** Show Details now is ''List''
** Show Art now is ''Grid''
** Show art with Details now is '' List by Album''
** Show Art Browser with Details now is ''3d Album View'' (provided by additional [https://www.mediamonkey.com/addons/browse/item/3d-flow-album-view/ 3D Flow Album View Addon])
** Column Browser now is ''Column filter''

== Related ==

* [[{{WebHelp:Links|Installation}}|Installing MediaMonkey]]
* [[{{WebHelp:Links|Upgrading_to_the_Gold_Version}}#Gold_Features|MediaMonkey Gold Features]]

{{WebHelpFooter}}

Devices table

2014-10-07T11:41:26Z

Chrisjj: Created page with "== Fields == {| border="1" |- ! Name ! Value Type ! Other attributes ! Possible Values ! Description |- | ID | INTEGER | PRIMARY KEY AUTOINCREMENT | | |- | PluginName | TEXT | CO..."

== Fields ==
{| border="1"
|-
! Name
! Value Type
! Other attributes
! Possible Values
! Description
|-
| ID
| INTEGER
| PRIMARY KEY AUTOINCREMENT
|
|
|-
| PluginName
| TEXT
| COLLATE IUNICODE
|
|
|-
| SynchAll
| INTEGER
|
|
|
|-
| AdvancedSynch
| INTEGER
|
|
|
|-
| MusicMask
| TEXT
|
|
|
|-
| ClassMusicMask
| TEXT
|
|
|
|-
| AudiobookMask
| TEXT
|
|
|
|-
| PodcastMask
| TEXT
|
|
|
|-
| VideoPodcastMask
| TEXT
|
|
|
|-
| VideoMask
| TEXT
|
|
|
|-
| MusicVideoMask
| TEXT
|
|
|
|-
| TVMask
| TEXT
|
|
|
|-
| SaveAAToFolder
| INTEGER
|
|
|
|-
| SaveAAToTag
| INTEGER
|
|
|
|-
| RemoveAAFromTag
| INTEGER
|
|
|
|-
| RemoveAAByteRate
| INTEGER
|
|
|
|-
| SyncAAMask
| TEXT
| COLLATE IUNICODE
|
|
|-
| DetailedUSBID
| TEXT
| COLLATE IUNICODE
|
|
|-
| CopyM3U
| INTEGER
|
|
|
|-
| PlaylistFormat
| TEXT
| COLLATE IUNICODE
|
|
|-
| M3UFolder
| TEXT
| COLLATE IUNICODE
|
|
|-
| M3UFlags
| INTEGER
|
|
|
|-
| M3UCopyLocations
| INTEGER
|
|
|
|-
| M3UCopyArtists
| INTEGER
|
|
|
|-
| M3UCopyAlbums
| INTEGER
|
|
|
|-
| M3UCopyPlaylists
| INTEGER
|
|
|
|-
| M3UOrganize
| INTEGER
|
|
|
|-
| DeleteUnsynch
| INTEGER
|
|
|
|-
| DeleteConfirm
| INTEGER
|
|
|
|-
| DeleteUnknown
| INTEGER
|
|
|
|-
| DeleteConfirmUnknown
| INTEGER
|
|
|
|-
| ResyncOnMaskChange
| INTEGER
|
|
|
|-
| BiDirSync
| INTEGER
|
|
|
|-
| BiDirConfirm
| INTEGER
|
|
|
|-
| BiDirSyncMetadata
| INTEGER
|
|
|
|-
| SynchOnConnect
| INTEGER
|
|
|
|-
| ScanOnConnect
| INTEGER
|
|
|
|-
| AllowWifiSync
| INTEGER
|
|
|
|-
| DeviceID
| TEXT
| COLLATE IUNICODE
|
|
|-
| DeviceCaption
| TEXT
| COLLATE IUNICODE
|
|
|-
| AutoUnmount
| INTEGER
|
|
|
|-
| DontDelete
| TEXT
| COLLATE IUNICODE
|
|
|-
| SyncBackFolders
| TEXT
| COLLATE IUNICODE
|
|
|-
| ScanFolders
| TEXT
| COLLATE IUNICODE
|
|
|-
| AutoConversions
| TEXT
| COLLATE IUNICODE
|
|
|-
| ImagePath
| TEXT
|
|
|
|-
| WirelessIDString
| TEXT
|
|
|
|-
| CopyToPCFolder
| TEXT
|
|
|
|-
| Invisible
| INTEGER
|
|
|
|-
| LastAutoSynch
| FLOAT
|
|
|
|-
| LastChangedACRulesTm
| FLOAT
|
|
|
|-
| FirstGenre
| INTEGER
|
|
|
|-
| FirstArtist
| INTEGER
|
|
|
|}

Flags

2014-09-07T13:53:09Z

Chrisjj: /* What's a flag in programming? */

=== What's a flag in programming? ===

Flags in programming are like tags that can be added to a certain object: they're either present or not.

These flags are always numbers which are binary, literal values of which usually represented in hexadecimal (e.g. const FLAG = &H0001). E.g. for flags with binary values 0001 (&H0001), 0010 (&H0002), 0100 (&H0004) and 1000 (&H0008), we know that the flag value 1011 contains the 1st, 2nd and 4th flag.

=== Use flags in Visual Basic or VBScript ===

'''To add a flag, use OR (''Or'' or ''+'')'''
<source lang="vb">MyFlags = MyFlags Or FLAG</source>

'''To remove a flag, use AND NOT (''And Not'')'''
<source lang="vb">MyFlags = MyFlags And (Not FLAG)</source>

'''To check for the presence of a flag, use AND (''And'')'''
<source lang="vb">If MyFlags And FLAG
' FLAG is present
End If</source>

Flags

2014-09-07T13:52:09Z

Chrisjj: /* What's a flag in programming? */

=== What's a flag in programming? ===

Flags in programming are like tags that can be added to a certain object: they're either present or not.

These flags are always numbers which are binary exclusive and are usually represented as hexadecimals (e.g. const FLAG = &H0001). E.g. for flags with binary values 0001 (&H0001), 0010 (&H0002), 0100 (&H0004) and 1000 (&H0008), we know that the flag value 1011 contains the 1st, 2nd and 4th flag.

=== Use flags in Visual Basic or VBScript ===

'''To add a flag, use OR (''Or'' or ''+'')'''
<source lang="vb">MyFlags = MyFlags Or FLAG</source>

'''To remove a flag, use AND NOT (''And Not'')'''
<source lang="vb">MyFlags = MyFlags And (Not FLAG)</source>

'''To check for the presence of a flag, use AND (''And'')'''
<source lang="vb">If MyFlags And FLAG
' FLAG is present
End If</source>

Scripting Tips & Tricks (MM4)

2014-09-07T13:51:19Z

Chrisjj: /* Making scripts ready for per-user installations */

==(MediaMonkey) Scripting in general==

=== 'Correctly' update song properties ===
Using the SongData object, you can either update the database/library (UpdateDB) and/or update the file's tags (WriteTags). So there's no way to let the song changes be saved like the user selected in the Options panel (menu Tools > Options > Library > Tags & Playlists > "Update tags when editing properties").
However, the UpdateAll method for the SongList object ''does'' take into account this user-specified option. So you can create a new SongList object using SDB.NewSongList and add your SDBSongData object(s) to it. Then call the UpdateAll method on the songlist, and your song(s) will be saved in user-specified way.

=== See MM debug log via DebugView ===
You can download [http://technet.microsoft.com/en-us/sysinternals/bb896647.aspx DebugView] directly from Microsoft. If used with the debug version of MM, lots of useful messages will be displayed in DebugView. Also, any message set via [[ISDBTools::OutputDebugStringMM]] (e.g. using '''SDB.Tools.OutputDebugString("Test1")''') will also be added to that debug log.

=== See MM Scripting interface using OLEView ===
MS Visual Studio contains a tool called [http://www.microsoft.com/downloads/details.aspx?familyid=5233B70D-D9B2-4CB5-AEB6-45664BE858B6&displaylang=en OLEView] ("OLE Viewer" or "OLE/COM Object Viewer") ([http://download.microsoft.com/download/win2000platform/oleview/1.00.0.1/nt5/en-us/oleview_setup.exe direct link]), which can show the type library of the SongsDB object "MediaMonkey Library". It requires the Iviewers.dll, which is not included, but can be downloaded from [http://www.dlldll.com/downdll/2757.html here] or other 3rd-party locations. There, you can see all supported properties and methods of the MediaMonkey scripting interface. This can be handy to find out new scripting methods in case that the scripting reference isn't up-to-date yet.
<br>The way to get there: ''OleView'' > Type Libraries > MediaMonkey Library > (double click)
<br>and then in the ''ITypeLib Viewer'' > SongsDB (MediaMonkey Library) > Interfaces.

=== Detecting docking of a panel ===
When you un(dock) a dockable panel, the OnResize event is triggered twice:
*Once while the panel is being (un)docked with DockedTo = 0
*Once after the panel has been (undocked): with DockedTo = -1 (panel undocked) or DockedTo = X (panel docked, X is the number that represents the docking position)

=== Keep reference to Form/Panel ===
When you create a form or panel, always add a reference to the SDB.Objects dictionary. If you don't add it, the form/panel will be gone immediately after you created it, with or without error message. Instead of using the SDB.Objects dictionary you can also store a reference as a global script variable, in most cases.

=== Event mechanisms ===
There are still 2 event mechanisms available:
*Using the (mostly deprecated) ''old event mechanism'' (using ''Control''.OnClickFunc and ''Control''.UseScript), your global variables aren't remembered in the event handlers (e.g. kind of like the script is reopened). For those scripts, you had to use ''ParentControl''.ChildControl("control name") or save object references to SDB's ''Objects'' dictionary.
*Using the ''new event mechanism'', your global variables ''are'' remembered so you can use their values in the event handlers. The Objects dictionary is now only necessary to communicate/store object references between different scripts.
So always use the new event mechanism where you can. Only for option panels (sheets) this is not yet possible. There you'll need to store values between the main program and the event handlers in SDB.Objects, in the INI or in the Registry.

=== Internal mechanism of script loading ===

Normally, you don't need to know much about internal handling of scripts by MediaMonkey, but sometimes it might be useful to know, when exactly scripts are loaded.

When some function of a script is about to be executed (e.g. OnStartup function of auto-scripts), the script is loaded to memory and executed as necessary. When the execution finishes, the script is again unloaded from memory. However, there is on exception - if you register some event (by calling RegisterEvent function), the script remains still loaded in memory, until all registered events are unregistered, then it's unloaded.

This is good to know when you plan some sharing of variables. While the script is loaded in memory, you can use its global variables, but if you need to persist some values or objects between script sessions, you have to use some other mechanism (ini files, Objects collection, ...).

Note that starting from MediaMonkey 3.1.0.1205, there is always at most one instance of script loaded in memory. In older versions, if a script registered some events and then e.g. Option sheet functions were called back by MediaMonkey, they were processed in another instance of the script. Now they are processed in the already loaded instance, which helps avoid some memory leaks, is easier to handle and is also faster to process.

=== Changing the current tree node ===
Changing the selected node from a script (using SDB.MainTree.CurrentNode = ...........) takes some time to happen, and it happens asynchronicly (the code execution doesn't wait until the node is really selected). For that reason, you can't use (get value of) SDB.MainTree.CurrentNode directly after you have assigned a new node to it (set value to), because changes won't have happened yet.

=== Interaction with MediaMonkey from outside ===
There are at least three ways to interact with MediaMonkey from an external program:
*Open the MediaMonkey.exe program with command line options (arguments).
*Using the same Windows Messages (SendMessage/PostMessage) as in Winamp (WM_USER and WM_COMMAND). MM partially emulates how WinAmp works (not 100%, but very close) and so it can use WinAmp plug-ins. The class name to communicate with is "Winamp v1.x".
*Using OLE Automation, which can be very easily used e.g. from VB Script.
*:<source lang="vb">Dim SDB : Set SDB = CreateObject("SongsDB.SDBApplication")</source>
*:<source lang="csharp">SongsDB.SDBApplicationClass SDB = new SongsDB.SDBApplicationClass();</source>
*:Be sure to set ''SDB.ShutdownAfterDisconnect'' to ''False'' if you opened the MediaMonkey program by calling the SDB object, and you don't want it to be closed when your external program exits (or if you disconnect the SDB object = COM link).

=== Making scripts ready for per-user installations ===
Starting from MediaMonkey 4.0, scripts can be (and are suggested to be) installed per-user, and so they don't have to be installed in Program Files folder, but are installed in local Windows folders. The mechanism in MM is internally made as transparent as possible, so that scripts don't have to care much about their installed location. That said, some pre-4.0 scripts might need tweaking. For example, a popular script Lyricator has >1000 lines, but there's only one change needed in order to get it working under local installation, namely:
<source lang="vb">Dim sAppPath: sAppPath = sdb.ApplicationPath & "Scripts\Lyricator\"</source>
needs to be changed to
<source lang="vb">Dim sAppPath: sAppPath = sdb.ScriptsPath & "Lyricator\"</source>

==Visual Basic Script==

=== Index in VBScript ===

Usually indexes start from '''0''' (e.g. for normal arrays). However, sometimes (e.g. for string positions or for [[ISDBCommonDialog::FilterIndex]]) they start from '''1'''.

=== Code readability ===

To maintain good readability of your scripting code, make sure to add comments where necessary, split large methods in smaller ones, use appropriate indentation (tabs or 2/3/4 spaces), and if necessary split long lines of code over several lines. To split a line of VBScript code (not text or numbers), add a ''space'' and an ''underscore'', and continue on the next line. Don't forget the space before the underscore or it won't work.
<source lang="vb">
MsgBox "This is quite a long text to display on one single line and for readability we better split it on multiple lines"

MsgBox "This is quite a long text to display on one single line" & " and for readability we better split it on multiple lines"

MsgBox "This is quite a long text to display on one single line" _
& " and for readability we better split it on multiple lines"
</source>
In the third example the code is more readable, but the result is still the same: a message box with one long line of text. To split this over multiple lines, we preferably use the constant vbNewLine. If necessary, you can also use ''vbCr'' (Unix-style) or ''vbCrLf''(Windows-style). Using these constants is more clear than using respectively ''Chr(13)'' (Unix-style) or ''Chr(13) & Chr(10)'' (Windows-style).
<source lang="vb">
MsgBox "This is quite a long text to display on one single line" & vbNewLine _
& " and for readability we better split it on multiple lines"
</source>

=== Using Flags in VBScript ===

The concept of [[Flags]] can be a difficult for novice programmers. Click the link for an explanation of how to use them in VBScript (or Visual Basic).

=== Links ===

'''Helpful sites:'''
* [http://msdn2.microsoft.com/en-us/library/ms950396.aspx Reference for scripting resources]
* [http://www.microsoft.com/technet/scriptcenter/default.mspx Microsoft Script Center]
* [http://msdn2.microsoft.com/en-us/library/t0aew7h6.aspx VBScript User's Guide and Language Reference]
* [http://www.microsoft.com/technet/scriptcenter/scripts/default.mspx?mfr=true VBScript Script Repository]
* [http://www.w3schools.com/vbscript/default.asp W3Schools VBScript learning]
* [http://technet.microsoft.com/en-us/library/cc498722.aspx Microsoft TechNet scripting products and technologies]

'''VBScript editors:'''
* [http://www.vbsedit.com/ VBSEdit] (debugging, object and COM lookup, integrated help)
* [http://notepad-plus.sourceforge.net/ NotePad++]
* [http://www.pspad.com/ PSPad]
* [http://www.sapien.com/ Sapien PrimalScript]
* [http://www.microsoft.com/downloads/details.aspx?familyid=2f465be0-94fd-4569-b3c4-dffdf19ccd99&displaylang=en Microsoft Script Debugger for Windows NT 4.0 and Later ] (debugging)
* [http://www.editpadpro.com/ EditPad (Pro)]
* [http://www.e-texteditor.com/ E-TextEditor]

== JScript ==

=== Passing arrays to MediaMonkey ===

When calling MediaMonkey COM methods which accept array as their argument, you cannot simply pass native JScript array to them. You have to convert them to VBScript-compatible array. (This applies yet in MM 4.1.) One of these methods is [[ISDBApplication::MessageBox]] which takes array of button constants to display.

You can use function from snippet below to JScript native array to the VBScript-compatible array.

<source lang="javascript">
/**
* Return VBSafeArray containing items from JScript array.
*/
function array_to_vbarray(array) {
var dict = new ActiveXObject('Scripting.Dictionary');
for (var i = 0, len = array.length; i < len; i++) {
dict.add(i, array[i]);
}
return dict.Items();
}
</source>

Then, when calling MediaMonkey methods, simply wrap the array argument with <tt>array_to_vbarray(…)</tt> call:

<source lang="javascript">
// Display message box
SDB.MessageBox("Simple message box from JScript with mtWarning icon and one mbOk button.", 0, array_to_vbarray([4]));
</source>

=== Working with dates ===

There are MediaMonkey COM properties of type Date (such as [[ISDBSongData::Date|Date]], [[ISDBSongData::DateAdded|DateAdded]], [[ISDBSongData::LastPlayed|LastPlayed]] in [[SDBSongData]]). When used in JScript, they require special treatment. (This applies yet in MM 4.1.)

'''Reading''': Properties are not converted to native JScript <tt>Date</tt> instance. You have to do it manually – cast them to string and then manually create the <tt>Date</tt> instance.

'''Setting''': You cannot set native JScript <tt>Date</tt> instance to the property. But you can set there a string in the ISO format <tt>YYYY-MM-DD HH:II:SS</tt> (eg. <tt>2012-12-31 01:02:03</tt>).

== Database & SQL ==

=== Database transactions ===

Starting from MM 3.0 transactions are often used when working with database. It can cause some problems to script authors in case they don't know some details. One example where you can face a problem is when you use [[ISDBSongData::UpdateDB]] method while you have some SQL query open. What happens in this case is, that MM wants to start a transaction, but there's still an SQL query open. This results either in an error message (in debug build) or possibly an apparent freeze of MM in the release build.

In order to prevent this problem, you can either:
* Put all these DB operations in an transaction, i.e. use [[ISDBDatabase::BeginTransaction]] and [[ISDBDatabase::Commit]].
* Close already running SQL queries before you call things like [[ISDBSongData::UpdateDB]].

=== Creating complex SQL queries ===
To easily create complex SQL queries, you can use the Query graphical user interface in Access interface, and show the SQL code when you are done. In any case, make sure that your SQL code is organized is such a way that it can be understood easily, e.g. by putting SELECT, INSERT, FROM, ORDER BY, ... on separate lines with appropriate indentation.

=== Avoid SQL date problems ===
One of the problems with SQL is that dates are often confused, which sometimes give programming bugs. The best way to circumvent this problem is by using the format #yyyy-mm-dd# for all dates in SQL (e.g. #2006-10-31# for 31th October 2006).

=== Links ===
'''Helpful sites:'''
*[http://www.w3schools.com/sql/default.asp W3Schools SQL learning]
*[http://www.1keydata.com/sql/sql.html 1Keydata SQL Tutorial]

WebHelp:Playback Rules/4.0

2014-08-13T15:25:10Z

Chrisjj: /* Collections */

{{WebHelpHeader|Customizing Collections and Playback Rules}}

MediaMonkey helps organize your multimedia files into 'Collections' which can be customized to display large numbers of files in a manner most appropriate to the content. In addition, it allows you to define how individual files are handled based on the file 'Type'.

== Collections ==

Collections allow you to segment your library based on specific criteria (e.g. Type=Classical Music, or Type=Music AND Genre=Comedy), and define how those files are displayed. e.g.:

:*which columns are displayed
:*which [[{{WebHelp:Links|Library}}|Tree Nodes]] are displayed in the tree
:*how files are sorted
:*what view is active (e.g. Show Details vs Show Art Browser)

For instance, you might want to create a Collection for 'Kid's Music' (based on Type=Music AND Genre=Children;Kids), where only the Artist and Album nodes are shown to make it easy for Children to browse.

<br>

Note:

:*Playlists display files based on the Collection settings associated with their constituent files, though this can be changed via the Playlist Properties.
:*The '''Entire Library''' Collection lists all your files in the Library and has it's own set of generic settings.
:*'Search' nodes display files using the settings of the last-visited Collection.
:*If your missing Media Files in your Library you should verify in the Entire Library > Location node that the files are actually missing.

To create or edit a Collection, use '''File''' > '''Manage Collections''' or '''Tools''' > '''Options''' > '''Media Tree''' and then:

#Use the Create button to create a new Collection or select a Collection and use the Edit button to edit a Collection
#Set the Criteria associated with the Collection (just as you would define [[{{WebHelp:Links|Search}}|Search Criteria]])
#Set which [[{{WebHelp:Links|Library}}|Tree Nodes]] and Columns should be shown and in what order (you can also change which columns are displayed for the current Collection by right-clicking on the column headers and/or drag and dropping the columns to change their order in the Filelistings)

To enable or disable a Collection, use '''File''' > '''Manage Collections''' or '''Tools''' > '''Options''' > '''Media Tree''' and then:

#Check the Collection to enable it in the MediaMonkey Media Tree
#Use the half-check / filled in checkbox to have the Collection appear in the MediaMonkey Media Tree only when it contains files
#Uncheck it to hide the Collection in the MediaMonkey Media Tree
#The '''Entire Library''' Collection can be enabled/disabled here as well

To change the Type of a file and thus in which Collection it is shown use Properties:

#Right click on a file or files and select Properties
#Modify the Type field
#Click OK

== Types ==

The 'Type' attribute determines how individual files are handled:

*How files are Played:

:*Whether Bookmarking is enabled
:*Whether Shuffle mode is ignored
:*Whether Crossfading is disabled
:*Whether Auto-DJ is active

*How files are displayed:

:*The fields displayed in the Properties dialog
:*The descriptive text for any track that appears in the Player and Now Playing (Summary) column
:*The descriptive text for any track that appears in Art Views

*How files are synced:

:*What categories they're browsable through on an iPod or other portable device

<br> In MediaMonkey 4, there are 8 hardcoded Types: Music, Podcast, Audiobook, Classical Music, Music Video, Video, TV, and Video Podcast. During the first scan into the Library:

*Audio files are added as Type=Music except

:*they're added as 'Audiobook' if Extension=M4B or Genre contains 'Audiobook' or 'Audio Book'
:*they're added as 'Podcast' if Genre contains 'Podcast'
:*they're added as 'Classical Music' if Genre contains 'Classical'

*Video files are added as Type=Video except

:*they're added as 'Video Podcast' if Genre contains 'Podcast'
:*they're added as 'TV' if Genre contains 'TV Show', 'TV Series' or 'Television'
:*they're added as 'Music Video' if Genre contains 'Music Video'

<br> The 'Type' associated with a file can be edited at any time via '''Edit''' > '''Properties''' > '''Type'''.

To edit the behaviors associated with each file 'Type' go to '''Tools''' > '''Options''' > '''Player''' > '''Playback rules'''.

<br>

{{WebHelpFooter}}

Backing up the Library

2013-01-12T15:55:58Z

Chrisjj:

{{WebHelpHeader|Backing up the Library}}
NOTE: http://www.mediamonkey.com/forum/viewtopic.php?p=357309#p357309 reports this article "is referencing MediaMonkey version 3 locations for the DB and ini files."

To back up your database and settings, copy the contents of the directory indicated, depending on what OS you're using:

*XP/Windows 2000: C:\Documents and Settings\<User>\Local Settings\Application Data\MediaMonkey
*Vista / Windows 7: C:\users\<User Name>\AppData\Local\MediaMonkey\
*Windows 9x/Me: C:\WINDOWS\Application Data\MediaMonkey\ or C:...\My Music\MediaMonkey\Data\

Note that some configuration settings that are stored to the registry will not be backed up. they are transcoded and leveled as follows:

*WMA --> WMA 128 kbps CBR
*OGG --> OGG Q4
*Other formats are encoded to the encoder defaults for the given format
*For other tracks that are in a format that isn't supported by the device, they are trancoded and leveled to MP3 128 kbps CBR

Note that any of these defaults can be overridden simply by adding a new conversion rule.

Related Information:

[[Basic_Concepts#Ripping_.26_Digital_Audio_Compression_Formats|Ripping & Digital File Formats]]

[[MP3 Encoding Settings]]
{{WebHelpFooter}}

Compatible Devices

2011-04-20T16:25:43Z

Chrisjj: /* Creative */

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

==Apple==
:[[iOS 4.2.1]] as of MediaMonkey 3.2.4
:[[iPod]] (including 5th Gen)
:[[iPod Classic]]
:[[iPod Mini|iPod Mini]] (1st and 2nd Gen)
:[[iPod Nano]] (1st, 2nd, 3rd, 4th, 5th, and 6th Gen)
:[[iPod Photo]]
:[[iPod Shuffle]] (1st, 2nd, 3rd and 4th Gen)
:[[iPod Touch]] (1st, 2nd, 3rd, and 4th Gen)
:[[iPhone|iPhone]] (iPhone 2G, iPhone 3G, iPhone 3GS, iPhone 4)
:[[iPad]]
:[[iTunes|iTunes]] (iTunes 6 to 10.1)

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

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

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

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

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

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

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

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

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

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

Compatible Devices

2011-04-20T16:24:43Z

Chrisjj: /* Creative */

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

==Apple==
:[[iOS 4.2.1]] as of MediaMonkey 3.2.4
:[[iPod]] (including 5th Gen)
:[[iPod Classic]]
:[[iPod Mini|iPod Mini]] (1st and 2nd Gen)
:[[iPod Nano]] (1st, 2nd, 3rd, 4th, 5th, and 6th Gen)
:[[iPod Photo]]
:[[iPod Shuffle]] (1st, 2nd, 3rd and 4th Gen)
:[[iPod Touch]] (1st, 2nd, 3rd, and 4th Gen)
:[[iPhone|iPhone]] (iPhone 2G, iPhone 3G, iPhone 3GS, iPhone 4)
:[[iPad]]
:[[iTunes|iTunes]] (iTunes 6 to 10.1)

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

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

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

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

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

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

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

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

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

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

User:Chrisjj\MediaMonkey

2011-01-19T18:15:25Z

Chrisjj:

See http://chrisjj.com/tango/MediaMonkey.htm

Scripting Tips & Tricks (MM4)

2010-12-22T14:18:59Z

Chrisjj: /* See MM debug log via DebugView */

==(MediaMonkey) Scripting in general==

=== 'Correctly' update song properties ===
Using the SongData object, you can either update the database/library (UpdateDB) and/or update the file's tags (WriteTags). So there's no way to let the song changes be saved like the user selected in the Options panel (menu Tools > Options > Library > Tags & Playlists > "Update tags when editing properties").
However, the UpdateAll method for the SongList object ''does'' take into account this user-specified option. So you can create a new SongList object using SDB.NewSongList and add your SDBSongData object(s) to it. Then call the UpdateAll method on the songlist, and your song(s) will be saved in user-specified way.

=== See MM debug log via DebugView ===
You can download [http://technet.microsoft.com/en-us/sysinternals/bb896647.aspx DebugView] directly from Microsoft. If used with the debug version of MM, lots of useful messages will be displayed in DebugView. Also, any message set via [[ISDBTools::OutputDebugStringMM]] (e.g. using '''SDB.Tools.OutputDebugString("Test1")''') will also be added to that debug log.

=== See MM Scripting interface using OLEView ===
MS Visual Studio contains a tool called [http://www.microsoft.com/downloads/details.aspx?familyid=5233B70D-D9B2-4CB5-AEB6-45664BE858B6&displaylang=en OLEView] ("OLE Viewer" or "OLE/COM Object Viewer") ([http://download.microsoft.com/download/win2000platform/oleview/1.00.0.1/nt5/en-us/oleview_setup.exe direct link]), which can show the type library of the SongsDB object "MediaMonkey Library". It requires the Iviewers.dll, which is not included, but can be downloaded from [http://www.dlldll.com/downdll/2757.html here] or other 3rd-party locations. There, you can see all supported properties and methods of the MediaMonkey scripting interface. This can be handy to find out new scripting methods in case that the scripting reference isn't up-to-date yet.
<br>The way to get there: ''OleView'' > Type Libraries > MediaMonkey Library > (double click)
<br>and then in the ''ITypeLib Viewer'' > SongsDB (MediaMonkey Library) > Interfaces.

=== Detecting docking of a panel ===
When you un(dock) a dockable panel, the OnResize event is triggered twice:
*Once while the panel is being (un)docked with DockedTo = 0
*Once after the panel has been (undocked): with DockedTo = -1 (panel undocked) or DockedTo = X (panel docked, X is the number that represents the docking position)

=== Keep reference to Form/Panel ===
When you create a form or panel, always add a reference to the SDB.Objects dictionary. If you don't add it, the form/panel will be gone immediately after you created it, with or without error message. Instead of using the SDB.Objects dictionary you can also store a reference as a global script variable, in most cases.

=== Event mechanisms ===
There are still 2 event mechanisms available:
*Using the (mostly deprecated) ''old event mechanism'' (using ''Control''.OnClickFunc and ''Control''.UseScript), your global variables aren't remembered in the event handlers (e.g. kind of like the script is reopened). For those scripts, you had to use ''ParentControl''.ChildControl("control name") or save object references to SDB's ''Objects'' dictionary.
*Using the ''new event mechanism'', your global variables ''are'' remembered so you can use their values in the event handlers. The Objects dictionary is now only necessary to communicate/store object references between different scripts.
So always use the new event mechanism where you can. Only for option panels (sheets) this is not yet possible. There you'll need to store values between the main program and the event handlers in SDB.Objects, in the INI or in the Registry.

=== Internal mechanism of script loading ===

Normally, you don't need to know much about internal handling of scripts by MediaMonkey, but sometimes it might be useful to know, when exactly scripts are loaded.

When some function of a script is about to be executed (e.g. OnStartup function of auto-scripts), the script is loaded to memory and executed as necessary. When the execution finishes, the script is again unloaded from memory. However, there is on exception - if you register some event (by calling RegisterEvent function), the script remains still loaded in memory, until all registered events are unregistered, then it's unloaded.

This is good to know when you plan some sharing of variables. While the script is loaded in memory, you can use its global variables, but if you need to persist some values or objects between script sessions, you have to use some other mechanism (ini files, Objects collection, ...).

Note that starting from MediaMonkey 3.1.0.1205, there is always at most one instance of script loaded in memory. In older versions, if a script registered some events and then e.g. Option sheet functions were called back by MediaMonkey, they were processed in another instance of the script. Now they are processed in the already loaded instance, which helps avoid some memory leaks, is easier to handle and is also faster to process.

=== Changing the current tree node ===
Changing the selected node from a script (using SDB.MainTree.CurrentNode = ...........) takes some time to happen, and it happens asynchronicly (the code execution doesn't wait until the node is really selected). For that reason, you can't use (get value of) SDB.MainTree.CurrentNode directly after you have assigned a new node to it (set value to), because changes won't have happened yet.

=== Interaction with MediaMonkey from outside ===
There are at least three ways to interact with MediaMonkey from an external program:
*Open the MediaMonkey.exe program with command line options (arguments).
*Using the same Windows Messages (SendMessage/PostMessage) as in Winamp (WM_USER and WM_COMMAND). MM partially emulates how WinAmp works (not 100%, but very close) and so it can use WinAmp plug-ins. The class name to communicate with is "Winamp v1.x".
*Using OLE Automation, which can be very easily used e.g. from VB Script.
*:<source lang="vb">Dim SDB : Set SDB = CreateObject("SongsDB.SDBApplication")</source>
*:<source lang="csharp">SongsDB.SDBApplicationClass SDB = new SongsDB.SDBApplicationClass();</source>
*:Be sure to set ''SDB.ShutdownAfterDisconnect'' to ''False'' if you opened the MediaMonkey program by calling the SDB object, and you don't want it to be closed when your external program exits (or if you disconnect the SDB object = COM link).

==Visual Basic Script==

=== Index in VBScript ===

Usually indexes start from '''0''' (e.g. for normal arrays). However, sometimes (e.g. for string positions or for [[ISDBCommonDialog::FilterIndex]]) they start from '''1'''.

=== Code readability ===

To maintain good readability of your scripting code, make sure to add comments where necessary, split large methods in smaller ones, use appropriate indentation (tabs or 2/3/4 spaces), and if necessary split long lines of code over several lines. To split a line of VBScript code (not text or numbers), add a ''space'' and an ''underscore'', and continue on the next line. Don't forget the space before the underscore or it won't work.
<source lang="vb">
MsgBox "This is quite a long text to display on one single line and for readability we better split it on multiple lines"

MsgBox "This is quite a long text to display on one single line" & " and for readability we better split it on multiple lines"

MsgBox "This is quite a long text to display on one single line" _
& " and for readability we better split it on multiple lines"
</source>
In the third example the code is more readable, but the result is still the same: a message box with one long line of text. To split this over multiple lines, we preferably use the constant vbNewLine. If necessary, you can also use ''vbCr'' (Unix-style) or ''vbCrLf''(Windows-style). Using these constants is more clear than using respectively ''Chr(13)'' (Unix-style) or ''Chr(13) & Chr(10)'' (Windows-style).
<source lang="vb">
MsgBox "This is quite a long text to display on one single line" & vbNewLine _
& " and for readability we better split it on multiple lines"
</source>

=== Using Flags in VBScript ===

The concept of [[Flags]] can be a difficult for novice programmers. Click the link for an explanation of how to use them in VBScript (or Visual Basic).

=== Links ===

'''Helpful sites:'''
* [http://msdn2.microsoft.com/en-us/library/ms950396.aspx Reference for scripting resources]
* [http://www.microsoft.com/technet/scriptcenter/default.mspx Microsoft Script Center]
* [http://msdn2.microsoft.com/en-us/library/t0aew7h6.aspx VBScript User's Guide and Language Reference]
* [http://www.microsoft.com/technet/scriptcenter/scripts/default.mspx?mfr=true VBScript Script Repository]
* [http://www.w3schools.com/vbscript/default.asp W3Schools VBScript learning]
* [http://technet.microsoft.com/en-us/library/cc498722.aspx Microsoft TechNet scripting products and technologies]

'''VBScript editors:'''
* [http://www.vbsedit.com/ VBSEdit] (debugging, object and COM lookup, integrated help)
* [http://notepad-plus.sourceforge.net/ NotePad++]
* [http://www.pspad.com/ PSPad]
* [http://www.sapien.com/ Sapien PrimalScript]
* [http://www.microsoft.com/downloads/details.aspx?familyid=2f465be0-94fd-4569-b3c4-dffdf19ccd99&displaylang=en Microsoft Script Debugger for Windows NT 4.0 and Later ] (debugging)
* [http://www.editpadpro.com/ EditPad (Pro)]
* [http://www.e-texteditor.com/ E-TextEditor]

== Database & SQL ==

=== Database transactions ===

Starting from MM 3.0 transactions are often used when working with database. It can cause some problems to script authors in case they don't know some details. One example where you can face a problem is when you use [[ISDBSongData::UpdateDB]] method while you have some SQL query open. What happens in this case is, that MM wants to start a transaction, but there's still an SQL query open. This results either in an error message (in debug build) or possibly an apparent freeze of MM in the release build.

In order to prevent this problem, you can either:
* Put all these DB operations in an transaction, i.e. use [[ISDBDatabase::BeginTransaction]] and [[ISDBDatabase::Commit]].
* Close already running SQL queries before you call things like [[ISDBSongData::UpdateDB]].

=== Creating complex SQL queries ===
To easily create complex SQL queries, you can use the Query graphical user interface in Access interface, and show the SQL code when you are done. In any case, make sure that your SQL code is organized is such a way that it can be understood easily, e.g. by putting SELECT, INSERT, FROM, ORDER BY, ... on separate lines with appropriate indentation.

=== Avoid SQL date problems ===
One of the problems with SQL is that dates are often confused, which sometimes give programming bugs. The best way to circumvent this problem is by using the format #yyyy-mm-dd# for all dates in SQL (e.g. #2006-10-31# for 31th October 2006).

=== Links ===
'''Helpful sites:'''
*[http://www.w3schools.com/sql/default.asp W3Schools SQL learning]
*[http://www.1keydata.com/sql/sql.html 1Keydata SQL Tutorial]

ISDBTools::OutputDebugString

2010-12-22T14:14:26Z

Chrisjj: /* Method description */

{{MethodDeclaration|SDBTools|ISDBTools|Sub OutputDebugString(Value As String)}}

===Parameters===

{{MethodParameters
|Value |String |A string to be added to debug log.}}

===Method description===

This method outputs a debug string using Windows OutputDebugString method. It can be useful for debuging your scripts, you can the view the debug logs using DebugView tool.

Example: SDB.Tools.OutputDebugString("Testing")

===Related items===

* [[ISDBTools::OutputDebugStringMM]]

{{Introduced|3.0}}

[[Category:Scripting|{{PAGENAME}}]]
[[Category:Automation objects|{{PAGENAME}}]]
[[Category:CoClass SDBTools|{{PAGENAME}}]]
[[Category:Interface ISDBTools|{{PAGENAME}}]]

SDBTools

2010-12-22T14:13:47Z

Chrisjj: /* CoClass SDBTools */

{{AutomationObjectsList}}
== CoClass SDBTools ==

Class of object for miscellaneous helper methods.

Example use: SDB.Tools.OutputDebugString("Testing")

=== ISDBTools members ===

{{MethodsList
|[[ISDBTools::AlbumByName|AlbumByName]] |Property Get |
|[[ISDBTools::ArtistByName|ArtistByName]] |Property Get |
|[[ISDBTools::ArtistCompFunc|ArtistCompFunc]] |Property Get |
|[[ISDBTools::DeleteTracks|DeleteTracks]] |Method |
|[[ISDBTools::FileSystem|FileSystem]] |Property Get |
|[[ISDBTools::IniFileByPath|IniFileByPath]] |Property Get |
|[[ISDBTools::LoadImage|LoadImage]] |Method | From v. 4.0
|[[ISDBTools::MainThreadCallFunc|MainThreadCallFunc]] |Property Get |
|[[ISDBTools::Mask2UFText|Mask2UFText]] |Method |
|[[ISDBTools::MultiString2UFText|MultiString2UFText]] |Method |
|[[ISDBTools::OutputDebugString|OutputDebugString]] |Method |
|[[ISDBTools::OutputDebugStringMM|OutputDebugStringMM]] |Method |
|[[ISDBTools::RemapASCII|RemapASCII]] |Method | From v. 4.0
|[[ISDBTools::Sleep|Sleep]] |Method |
|[[ISDBTools::StringForSorting|StringForSorting]] |Method |
|[[ISDBTools::UFText2Mask|UFText2Mask]] |Method |
|[[ISDBTools::UFText2MultiString|UFText2MultiString]] |Method |
|[[ISDBTools::WebSearch|WebSearch]] |Property Get |
}}

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

Introduction to scripting

2010-06-29T14:31:21Z

Chrisjj: /* Format of the ''Scripts.ini'' file */

MediaMonkey can be customized through the use of custom scripts. Scripts are relatively simple computer programs written in a scripting language, such as VBScript. Unlike most computer programs, these scripts do not have to be compiled, which allows them to be tested and modified more easily than with more advanced languages. Still, writing MediaMonkey scripts can be a challenging experience so potential script writers should consider alternatives, particularly if they have little previous experience writing scripts.

== Considerations ==

Before writing their own scripts, users of MediaMonkey may wish to consider the following issues:
*In addition to supporting scripting, MediaMonkey has a [[Plug-ins|plug-in]] interface that allows a large number of Winamp and MediaMonkey plug-ins to be used. There may be no need to write a script if the desired features are already provided by a plug-in.
*Some users of MediaMonkey are willing to share the scripts that they have written with other users. An existing script may already provide the desired features or be relatively easily modified so that it does. The best place to find such scripts or to get support for them is the [http://www.mediamonkey.com/forum/viewforum.php?f=2 Scripts and Components forum].
*Although, in theory, MediaMonkey supports both of the [http://en.wikipedia.org/wiki/VBScript VBScript] (*.vbs) and [http://en.wikipedia.org/wiki/JScript JScript] (*.js) scripting languages, the implementation for JScript is only partial, so for some applications VBScript is required. Programmers not wishing to deal with VBScript may wish to create an [[#About external scripts and applications |external]] script or application using their preferred language and use a script written in VBScript (or JScript) to launch it.
*Other than tags embedded in media files, virtually all of MediaMonkey’s data is stored in a [http://en.wikipedia.org/wiki/Microsoft_Jet_Database_Engine Microsoft Jet] relational database by MediaMonkey 2.x, while MediaMonkey 3.x uses a [http://www.sqlite.org SQLite] database. It is possible to manipulate MediaMonkey’s data, while minimizing the use of MediaMonkey’s API, by using [http://en.wikipedia.org/wiki/SQL SQL]. MediaMonkey's API can be completely bypassed by using an interface provided by the underlying engine to access the database. MediaMonkey 2.x’s database can accessed through Jet or ODBC, or even opened directly by Microsoft Access, for example.

== Types of scripts ==

There are three major types of scripts that can be launched internally by MediaMonkey:
*'''Normal scripts''' are located in the ''Scripts'' folder and are executed according to the script's entry in the [[#Format of the Scripts.ini file|''Scripts\Scripts.ini'' file]].
*'''Auto-scripts''' are located in the ''Scripts\Auto'' folder and its OnStartup method is executed when MediaMonkey starts.
*'''Other scripts''', such as [[Search scripts]] and [[Auto-DJ scripts]] are intended for specific types of customization, but are also defined in the [[#Format of the Scripts.ini file|''Scripts\Scripts.ini'' file]].

In addition to the scripts that are launched by MediaMonkey (internal scripts), you can also work with MediaMonkey by using [[#About external scripts and applications|''external'' scripts and applications]].

== How to create a normal script ==

<ol>
<li>Create a plain text file in the ''Scripts'' folder, e.g. ''MyNormalScript.vbs''.</li>
<li>Write your VBScript script and make sure you have a procedure that can be called, e.g.
<source lang="vb">Sub CallMe

' This script will pop up a simple message box when the procedure CallMe is called.
MsgBox "CallMe was called by the action defined in the Scripts.ini file."

End Sub</source></li>
<li>Create a new entry for your script's ''CallMe'' procedure in the [[#Format of the Scripts.ini file|''Scripts.ini'' file]].</li>
</ol>

From within a MediaMonkey script, a reference to the SDB object (an instance of the [[SDBApplication]] class) is always present. By accessing its properties and methods, you can interact with many aspects of MediaMonkey. Check out the [[MediaMonkey Automation objects]] page for other MediaMonkey objects that can be created starting from the SDB object.
Another available object reference is the Script object (an instance of the [[SDBScriptControl]] class), that contains methods to control the running script's environment, usually to [[ISDBScriptControl::RegisterEvent|attach]] to events of MediaMonkey and its player and controls (see examples [[Sample Event Handlers script|1]] and [[Sample Events for User Interface script|2]]).

The script ''Scripts\MediaMonkey init.vbs'' is always executed just before any other script. It contains some constants that can be used in your own script.

A good and quite complex example is ''Scripts\Export.vbs'' (distributed with MediaMonkey) which contains code that takes care of all export features of MediaMonkey. For more examples, check out the [[Sample scripts|sample scripts page]].

More information about scripting in general can be found at [http://msdn2.microsoft.com/en-us/library/ms950396.aspx Microsoft Scripting] (with official VBScript and JScript documentation).

== How to create an auto-script ==

<ol>
<li>Create a plain text file in the ''Scripts\Auto'' folder, e.g. ''MyAutoScript.vbs''.</li>
<li>Write your VBScript script and use the procedure ''OnStartup'' as start point for execution, e.g.
<source lang="vb">
Sub OnStartup

' This script will pop up a simple "Hello World!" message box when you start MediaMonkey.
MsgBox "Hello World!"

End Sub
</source></li>
</ol>

All VBScript, but not JScript, scripts in the ''Scripts\Auto'' folder are automatically checked during MM start-up, and the '''OnStartup''' procedure (if present) is called. Auto-scripts make it possible to add user interface enhancements such as new menu or toolbar items, new option sheets, etc.

Except that these scripts are automatically executed when MediaMonkey starts, they behave identical as the normal scripts. They also get a reference to the SDB object, and the constants defined in ''Scripts\MediaMonkey init.vbs'' are always usable.

== Format of the ''Scripts.ini'' file ==

<div style="float: right; margin-left: 1em; margin-bottom: 0.5em; clear: right; background-color:#F9F9F9; border:1px solid #CCCCCC; font-size:95%; padding:5px;">
<source lang="ini">
[AutoIncTrackN]
FileName=AutoIncTrackN.vbs
ProcName=AutoIncTrackNumbers
Order=1
DisplayName=Auto-&increment Track #s...
Description=Sequentially numbers Tracks
Language=VBScript
ScriptType=0
</source>
<div style="position: relative; top: -6px; left: 5px">Sample ''Scripts.ini'' entry</div>
</div>

This ''Scripts\Scripts.ini'' file is a standard .ini file where each section defines a procedure in a script. The section starts with a section identifier [SectionName], where ‘SectionName’ is a unique name of the script entry.
These are the entry's properties:
; Filename
: Path of a script file where the procedure is located, relative to the ''Scripts'' folder, e.g. ‘MyScripts.vbs’.
; ProcName
: Name of an existing procedure to be called when the script (specifiedby ‘Filename’) is executed in MM.
; ScriptType
: Defines type of the script:
:* 0 = A ''standard script'' that appears in the <code>Tools > Scripts</code> submenu.
:* 1 = An ''export script'' that can be found in the <code>File > Create Reports</code> submenu.
:* 2 = A ''track-start script'' that is activated whenever a new track is started. This script doesn’t appear in any menu, it’s simply called in the background. When this procedure is executed, a variable 'CurrentTrack' (object of the [[SDBSongData]] class) is defined, and you can use it to get information about the started track. This script type is obsolete, rather register OnPlay event. Also note, that this is the only case, when multiple instances of one script can be executed by MediaMonkey, otherwise only one instance is always executed.
:* 3 = A ''search script'' that allows custom searches to be programmed in the "Auto-tag from Web" dialog. See [[Search scripts]] for more information about this more complex script type.
:* 4 = An ''Auto-DJ script'' that can handle content added by Auto-DJ. See [[Auto-DJ scripts]] for more details.
; Order
: Defines the order of the script in its section. These numbers are sorted and scripts are listed according to the order.
; DisplayName
: The script is listed as menu item with this name.
; Description
: Message shown as tooltip when the mouse is moved over the menu item.
; Language
: The script language of the referenced script. Usually VBScript, but can be JScript too (although this is not recommended).
; Shortcut
: Specifies a shortcut that invokes the script in MM. You can use any of the strings ‘Shift+’, ‘Ctrl+’ or ‘Alt+’, singly or combined, followed a single letter or number, or the name of a special key - BkSp, Tab, Enter, Esc, Space, PgUp, PgDn, End, Home, Left, Up, Right, Down, Ins, Del.

== About external scripts and applications ==

External scripts are launched from outside MediaMonkey. They can be scripts that are started by a MediaMonkey script (e.g. ''helper scripts''), or that originated outside MediaMonkey (regular *.vbs scripts, local html pages, ASP server pages, ...). The same situation applies to applications that are not a part of MediaMonkey, but which use its COM object (the COM and the scripting API are the same).

In order to work with MediaMonkey’s objects from outside a MediaMonkey script, you need to create a reference to the SDB object (an instance of the [[SDBApplication]] class) yourself. For external applications, make sure that you have added a reference to the SongsDB library, first.

If MediaMonkey is already running, a call to the SDB object will return a reference to the running instance. If MediaMonkey is not running yet, it will be started and a reference will be returned. In addition, if MediaMonkey was was not running before, it will normally shut down automatically when the external script/application exits. This can be prevented (MediaMonkey will remain running) by setting SDB's [[ISDBApplication::ShutdownAfterDisconnect|ShutdownAfterDisconnect]] property to False.

'''Visual Basic / VBScript sample:'''
<source lang="vb">
Dim SDB : Set SDB = CreateObject("SongsDB.SDBApplication")

SDB.ShutdownAfterDisconnect = False ' in case you want to keep an opened instance open after disconnecting the SDB object
</source>
'''C# sample:'''
<source lang="csharp">
SongsDB.SDBApplication SDB = new SongsDB.SDBApplication();

SDB.ShutdownAfterDisconnect = false; // in case you want to keep an opened instance open after disconnecting the SDB object
</source>

'''C++ sample:'''
<source lang="cpp">
SongsDB::SDBApplication^ SDB = gcnew SongsDB::SDBApplication();

SDB->ShutdownAfterDisconnect = false; // in case you want to keep an opened instance open after disconnecting the SDB object
</source>

'''Delphi sample:'''
<source lang="delphi">
var
SDB : Variant;
begin
SDB := CreateObject('SongsDB.SDBApplication');
SDB.ShutdownAfterDisconnect := false; // in case you want to keep an opened instance open after disconnecting the SDB object
</source>

'''PHP sample:''' (shows initialization only)
<source lang="php">
$objSDB = new COM('SongsDB.SDBApplication') or die('Cannot create MediaMonkey SDB Object');
</source>

'''Python (with PyWin32) sample:'''
<source lang="python">
try:
import win32com.client
except:
print "Install PyWin32"
# Open connection to COM object
try:
SDB = win32com.client.Dispatch("SongsDB.SDBApplication")
except:
print "Is MediaMonkey up and running?"

SDB.ShutdownAfterDisconnect = False
</source>

'''Perl sample:''' (shows initialization only)
<source lang="perl">
use Win32::OLE;
my $SDB = Win32::OLE->GetActiveObject('SongsDB.SDBApplication') || Win32::OLE->new('SongsDB.SDBApplication', '');
$SDB->ShutdownAfterDisconnect(true);
</source>

== Further reading ==

[[Scripting]]

User:Chrisjj

2010-05-11T01:37:57Z

Chrisjj:

[[User:Chrisjj|Chrisjj]] is a keen supporter of MediaMonkey and since early 2007 has been using it to manage a library of now 16,000 tracks and sync to portable devices.

==Problems with MediaMonkey==
[[User:Chrisjj\MediaMonkey]]

==Using MediaMonkey with Creative ZEN==
[[Creative ZEN]]

User:Chrisjj

2010-05-10T19:21:24Z

Chrisjj:

[[User:Chrisjj|Chrisjj]] is a keen supporter of MediaMonkey and since early 2007 has been using it to manage a library of now 16,000 tracks and sync to portable devices.

==Problems with MediaMonkey==
http://chrisjj.com/tango/MediaMonkey.htm

==Using MediaMonkey with Creative ZEN==
[[Creative ZEN]]

Introduction to scripting

2010-05-10T12:48:23Z

Chrisjj: /* Considerations */

MediaMonkey can be customized through the use of custom scripts. Scripts are relatively simple computer programs written in a scripting language, such as VBScript. Unlike most computer programs, these scripts do not have to be compiled, which allows them to be tested and modified more easily than with more advanced languages. Still, writing MediaMonkey scripts can be a challenging experience so potential script writers should consider alternatives, particularly if they have little previous experience writing scripts.

== Considerations ==

Before writing their own scripts, users of MediaMonkey may wish to consider the following issues:
*In addition to supporting scripting, MediaMonkey has a [[Plug-ins|plug-in]] interface that allows a large number of Winamp and MediaMonkey plug-ins to be used. There may be no need to write a script if the desired features are already provided by a plug-in.
*Some users of MediaMonkey are willing to share the scripts that they have written with other users. An existing script may already provide the desired features or be relatively easily modified so that it does. The best place to find such scripts or to get support for them is the [http://www.mediamonkey.com/forum/viewforum.php?f=2 Scripts and Components forum].
*Although, in theory, MediaMonkey supports both of the [http://en.wikipedia.org/wiki/VBScript VBScript] (*.vbs) and [http://en.wikipedia.org/wiki/JScript JScript] (*.js) scripting languages, the implementation for JScript is only partial, so for some applications VBScript is required. Programmers not wishing to deal with VBScript may wish to create an [[#About external scripts and applications |external]] script or application using their preferred language and use a script written in VBScript (or JScript) to launch it.
*Other than tags embedded in media files, virtually all of MediaMonkey’s data is stored in a [http://en.wikipedia.org/wiki/Microsoft_Jet_Database_Engine Microsoft Jet] relational database by MediaMonkey 2.x, while MediaMonkey 3.x uses a [http://www.sqlite.org SQLite] database. It is possible to manipulate MediaMonkey’s data, while minimizing the use of MediaMonkey’s API, by using [http://en.wikipedia.org/wiki/SQL SQL]. MediaMonkey's API can be completely bypassed by using an interface provided by the underlying engine to access the database. MediaMonkey 2.x’s database can accessed through Jet or ODBC, or even opened directly by Microsoft Access, for example.

== Types of scripts ==

There are three major types of scripts that can be launched internally by MediaMonkey:
*'''Normal scripts''' are located in the ''Scripts'' folder and are executed according to the script's entry in the [[#Format of the Scripts.ini file|''Scripts\Scripts.ini'' file]].
*'''Auto-scripts''' are located in the ''Scripts\Auto'' folder and its OnStartup method is executed when MediaMonkey starts.
*'''Other scripts''', such as [[Search scripts]] and [[Auto-DJ scripts]] are intended for specific types of customization, but are also defined in the [[#Format of the Scripts.ini file|''Scripts\Scripts.ini'' file]].

In addition to the scripts that are launched by MediaMonkey (internal scripts), you can also work with MediaMonkey by using [[#About external scripts and applications|''external'' scripts and applications]].

== How to create a normal script ==

<ol>
<li>Create a plain text file in the ''Scripts'' folder, e.g. ''MyNormalScript.vbs''.</li>
<li>Write your VBScript script and make sure you have a procedure that can be called, e.g.
<source lang="vb">Sub CallMe

' This script will pop up a simple message box when the procedure CallMe is called.
MsgBox "CallMe was called by the action defined in the Scripts.ini file."

End Sub</source></li>
<li>Create a new entry for your script's ''CallMe'' procedure in the [[#Format of the Scripts.ini file|''Scripts.ini'' file]].</li>
</ol>

From within a MediaMonkey script, a reference to the SDB object (an instance of the [[SDBApplication]] class) is always present. By accessing its properties and methods, you can interact with many aspects of MediaMonkey. Check out the [[MediaMonkey Automation objects]] page for other MediaMonkey objects that can be created starting from the SDB object.
Another available object reference is the Script object (an instance of the [[SDBScriptControl]] class), that contains methods to control the running script's environment, usually to [[ISDBScriptControl::RegisterEvent|attach]] to events of MediaMonkey and its player and controls (see examples [[Sample Event Handlers script|1]] and [[Sample Events for User Interface script|2]]).

The script ''Scripts\MediaMonkey init.vbs'' is always executed just before any other script. It contains some constants that can be used in your own script.

A good and quite complex example is ''Scripts\Export.vbs'' (distributed with MediaMonkey) which contains code that takes care of all export features of MediaMonkey. For more examples, check out the [[Sample scripts|sample scripts page]].

More information about scripting in general can be found at [http://msdn2.microsoft.com/en-us/library/ms950396.aspx Microsoft Scripting] (with official VBScript and JScript documentation).

== How to create an auto-script ==

<ol>
<li>Create a plain text file in the ''Scripts\Auto'' folder, e.g. ''MyAutoScript.vbs''.</li>
<li>Write your VBScript script and use the procedure ''OnStartup'' as start point for execution, e.g.
<source lang="vb">
Sub OnStartup

' This script will pop up a simple "Hello World!" message box when you start MediaMonkey.
MsgBox "Hello World!"

End Sub
</source></li>
</ol>

All VBScript, but not JScript, scripts in the ''Scripts\Auto'' folder are automatically checked during MM start-up, and the '''OnStartup''' procedure (if present) is called. Auto-scripts make it possible to add user interface enhancements such as new menu or toolbar items, new option sheets, etc.

Except that these scripts are automatically executed when MediaMonkey starts, they behave identical as the normal scripts. They also get a reference to the SDB object, and the constants defined in ''Scripts\MediaMonkey init.vbs'' are always usable.

== Format of the ''Scripts.ini'' file ==

<div style="float: right; margin-left: 1em; margin-bottom: 0.5em; clear: right; background-color:#F9F9F9; border:1px solid #CCCCCC; font-size:95%; padding:5px;">
<source lang="ini">
[AutoIncTrackN]
FileName=AutoIncTrackN.vbs
ProcName=AutoIncTrackNumbers
Order=1
DisplayName=Auto-&increment Track #s...
Description=Sequentially numbers Tracks
Language=VBScript
ScriptType=0
</source>
<div style="position: relative; top: -6px; left: 5px">Sample ''Scripts.ini'' entry</div>
</div>

This ''Scripts\Scripts.ini'' file is a standard .ini file where each section defines a procedure in a script. The section starts with a section identifier [SectionName], where ‘SectionName’ is a unique name of the script entry.
These are the entry's properties:
; Filename
: Path of a script file where the procedure is located, relative to the ''Scripts'' folder, e.g. ‘MyScripts.vbs’.
; ProcName
: Name of an existing procedure to be called when the script (specifiedby ‘Filename’) is executed in MM.
; ScriptType
: Defines type of the script:
:* 0 = A ''standard script'' that appears in the <code>Tools > Scripts</code> submenu.
:* 1 = An ''export script'' that can be found in the <code>File > Export</code> submenu.
:* 2 = A ''track-start script'' that is activated whenever a new track is started. This script doesn’t appear in any menu, it’s simply called in the background. When this procedure is executed, a variable 'CurrentTrack' (object of the [[SDBSongData]] class) is defined, and you can use it to get information about the started track. This script type is obsolete, rather register OnPlay event. Also note, that this is the only case, when multiple instances of one script can be executed by MediaMonkey, otherwise only one instance is always executed.
:* 3 = A ''search script'' that allows custom searches to be programmed in the "Auto-tag from Web" dialog. See [[Search scripts]] for more information about this more complex script type.
:* 4 = An ''Auto-DJ script'' that can handle content added by Auto-DJ. See [[Auto-DJ scripts]] for more details.
; Order
: Defines the order of the script in its section. These numbers are sorted and scripts are listed according to the order.
; DisplayName
: The script is listed as menu item with this name.
; Description
: Message shown as tooltip when the mouse is moved over the menu item.
; Language
: The script language of the referenced script. Usually VBScript, but can be JScript too (although this is not recommended).
; Shortcut
: Specifies a shortcut that invokes the script in MM. You can use any of the strings ‘Shift+’, ‘Ctrl+’ or ‘Alt+’, even combined together and followed either by a single letter or a special key (BkSp, Tab, Enter, Esc, Space, PgUp, PgDn, End, Home, Left, Up, Right, Down, Ins, Del).

== About external scripts and applications ==

External scripts are launched from outside MediaMonkey. They can be scripts that are started by a MediaMonkey script (e.g. ''helper scripts''), or that originated outside MediaMonkey (regular *.vbs scripts, local html pages, ASP server pages, ...). The same situation applies to applications that are not a part of MediaMonkey, but which use its COM object (the COM and the scripting API are the same).

In order to work with MediaMonkey’s objects from outside a MediaMonkey script, you need to create a reference to the SDB object (an instance of the [[SDBApplication]] class) yourself. For external applications, make sure that you have added a reference to the SongsDB library, first.

If MediaMonkey is already running, a call to the SDB object will return a reference to the running instance. If MediaMonkey is not running yet, it will be started and a reference will be returned. In addition, if MediaMonkey was was not running before, it will normally shut down automatically when the external script/application exits. This can be prevented (MediaMonkey will remain running) by setting SDB's [[ISDBApplication::ShutdownAfterDisconnect|ShutdownAfterDisconnect]] property to False.

'''Visual Basic / VBScript sample:'''
<source lang="vb">
Dim SDB : Set SDB = CreateObject("SongsDB.SDBApplication")

SDB.ShutdownAfterDisconnect = False ' in case you want to keep an opened instance open after disconnecting the SDB object
</source>
'''C# sample:'''
<source lang="csharp">
SongsDB.SDBApplication SDB = new SongsDB.SDBApplication();

SDB.ShutdownAfterDisconnect = false; // in case you want to keep an opened instance open after disconnecting the SDB object
</source>

'''C++ sample:'''
<source lang="cpp">
SongsDB::SDBApplication^ SDB = gcnew SongsDB::SDBApplication();

SDB->ShutdownAfterDisconnect = false; // in case you want to keep an opened instance open after disconnecting the SDB object
</source>

'''Delphi sample:'''
<source lang="delphi">
var
SDB : Variant;
begin
SDB := CreateObject('SongsDB.SDBApplication');
SDB.ShutdownAfterDisconnect := false; // in case you want to keep an opened instance open after disconnecting the SDB object
</source>

'''PHP sample:''' (shows initialization only)
<source lang="php">
$objSDB = new COM('SongsDB.SDBApplication') or die('Cannot create MediaMonkey SDB Object');
</source>

'''Python (with PyWin32) sample:'''
<source lang="python">
try:
import win32com.client
except:
print "Install PyWin32"
# Open connection to COM object
try:
SDB = win32com.client.Dispatch("SongsDB.SDBApplication")
except:
print "Is MediaMonkey up and running?"

SDB.ShutdownAfterDisconnect = False
</source>

'''Perl sample:''' (shows initialization only)
<source lang="perl">
use Win32::OLE;
my $SDB = Win32::OLE->GetActiveObject('SongsDB.SDBApplication') || Win32::OLE->new('SongsDB.SDBApplication', '');
$SDB->ShutdownAfterDisconnect(true);
</source>

== Further reading ==

[[Scripting]]

User:Chrisjj

2010-04-12T20:41:15Z

Chrisjj:

[[User:Chrisjj|Chrisjj]] is a keen supporter of MediaMonkey and since early 2007 has been using it to manage a library of now 16,000 tracks and sync to portable devices.

==Problems with MediaMonkey==
http://wiki.tango.info/mul/User:Chrisjjj/MediaMonkey#Problems

==Using MediaMonkey with Creative ZEN==
[[Creative ZEN]]

2008-10-14T10:44:35Z

Chrisjj:

[[User:Chrisjj|Chrisjj]] is a keen supporter of MediaMonkey and since early 2007 has been using it to manage a library of now 16,000 tracks and sync to portable devices.

==Recommended Configuration==
The installation-default configuration may not be as you want it. Consider the following adjustments:
*Switch to a more Windows-standard (and less colourful) program appearence
**At Tools | Options | Skins, set ''[X] Override Skin theme with Windows System theme (requires restart)''
*Disable the crossfade that occurs on switching tracks
**Click Tools | Options | Output plug-ins, select MediaMonkey DirectSound output, click Configure, uncheck ''Crossfade tracks''
*Disable the end-of-track silence removal that causes track playback transition to lose gaps
**Click Tools | Options | Output plug-ins, select MediaMonkey DirectSound output, click Configure, uncheck ''Remove silence at the beginning / end of track''
**Note: This won't restore gaps if none exist in the track files e.g. if your track files are trimmed of terminal silence
*Disable the fade-in/out that misleads and slows play operations
**Click Tools | Options | Output plug-ins, select MediaMonkey DirectSound output, click Configure, uncheck ''Smooth pause'', ''Smooth seek'' and ''Smooth stop''.
*Change the Windows Regional and Language Settings Date to international standard yyyy-mm-dd - MediaMonkey does respect this setting for its own date display (except for http://www.mediamonkey.com/forum/viewtopic.php?p=151037#151037).

==Problems==
*V3.0.3.1187 1187 Conversion to WAV garbages non-ASCII chars
**Problem: http://mediamonkey.com/forum/viewtopic.php?f=7&t=33456
*V3.0.3.1183 Device config can revert to default Playlist path
**Problem: http://mediamonkey.com/forum/viewtopic.php?f=7&t=33368
*V3.0.3.1183 Same-named playlist causes loss upon sync
**Problem: http://mediamonkey.com/forum/viewtopic.php?f=7&t=33354
*V3.0.3.1183 Failure of Auto-sync to detect tag changes
**Problem and partial workaround: http://mediamonkey.com/forum/viewtopic.php?f=7&t=33369#p170610
*V3.0.3.1170 Blanking Artist can lose Album Artist value
**Problem: http://www.mediamonkey.com/forum/viewtopic.php?f=6&t=29235&p=148639
*V3.0.3.1164 Storage of illegal TDRC frame in MP3 ID3 V2.3 tags
**Workaround: http://www.mediamonkey.com/support/index.php?_m=knowledgebase&_a=viewarticle&kbarticleid=62
*V3.0.3.1164 Muddling together of multiple albums with same title and artist
**Problem and workaround: http://www.mediamonkey.com/forum/viewtopic.php?t=23659
*V3.0.3.1164 Various failures to sync to portable device.
*V3.0.3.1164 "Intentional" failure of sync setting change to take effect
**Problem and workaround: http://www.mediamonkey.com/forum/viewtopic.php?p=146499#146499
*V3.0.3.1164 Rescan of files fails to update library for deleted tags
** Problem and workaround: http://www.mediamonkey.com/forum/viewtopic.php?p=146409#146409
*V3.0.3.1150 No Undo! This makes potentially disasterous a careless drag of tracks to the wrong album.
*V3.0.3.1148 Multiple artist support fails to comply with MP3 standard
**Problem: http://www.mediamonkey.com/forum/viewtopic.php?t=27934
**Update: V3.0.3.1155 release reports a fix that may address this.
*V3.0.3.1148 Tags edits can cause messups on ';' character
**Problem: http://www.mediamonkey.com/forum/viewtopic.php?t=27942
*V3.0.3.1155 Playlist import can miss tracks
**Problem: http://www.mediamonkey.com/forum/viewtopic.php?t=28254
*V3.0.3.1183 Delete from device shows Path on Device wrongly
**Problem: http://www.mediamonkey.com/forum/viewtopic.php?f=6&t=29202&p=148485&hilit=Path+on+device#p148485
*V3.0.3.1148 Fails to show WMA Year tag values having non-digits e.g. 1941-03-14 (such as delivered by tango.info [[tagging]]).
**Problem: http://www.mediamonkey.com/forum/viewtopic.php?t=27627
*V? Reportedly by default can write faulty (i.e. non-compliant) Year in MP3.
**Problem: http://mediamonkey.com/forum/viewtopic.php?t=23192
**Workaround: http://www.mediamonkey.com/support/index.php?_m=knowledgebase&_a=viewarticle&kbarticleid=62&nav=0,9
*V3.0.3.1148 Leading dot on Artist/Album name can cause missing files on device sync
**http://www.mediamonkey.com/forum/viewtopic.php?t=27926
*V3.0.3.1148 default config for Creative ZEN writes unusable playlists
**Problem and workaround: http://www.mediamonkey.com/forum/viewtopic.php?t=27789&highlight=My%20Playlists
*V3.0.3.1148 Playlists synced to Creative ZEN fail to show on ZEN Media Explorer
**Problem: http://www.mediamonkey.com/forum/viewtopic.php?t=140583
*V3.0.3.1148 Multiple-used tracks can be lost from Creative ZEN playlists
**Problem and workaround: http://www.mediamonkey.com/forum/viewtopic.php?p=125919#125919
*V3.0.3.1183 embolding of playing track causes displacement and possibly truncation
**Problem: http://mediamonkey.com/forum/viewtopic.php?f=1&t=32115