SDBApplication: Difference between revisions

From MediaMonkey Wiki
Jump to navigation Jump to search
 
(15 intermediate revisions by 4 users not shown)
Line 2: Line 2:
== CoClass SDBApplication ==
== 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.
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 ===
=== ISDBApplication members ===
    
    
{{MethodsList
{{MethodsListMM5
|[[ISDBApplication::AllVisibleSongList|AllVisibleSongList]] |Property Get |
|[[ISDBApplication::AllVisibleSongList|AllVisibleSongList]] |Property Get |   | No
|[[ISDBApplication::ApplicationPath|ApplicationPath]] |Property Get |
|[[ISDBApplication::ApplicationPath|ApplicationPath]] |Property Get |   | Yes
|[[ISDBApplication::EqualizerPath|EqualizerPath]] |Property Get |
|[[ISDBApplication::EqualizerPath|EqualizerPath]] |Property Get | From 3.1 beta 1 | Yes
|[[ISDBApplication::IconsPath|IconsPath]] |Property Get |
|[[ISDBApplication::IconsPath|IconsPath]] |Property Get | From 3.1 beta 1 | Yes
|[[ISDBApplication::PluginsPath|PluginsPath]] |Property Get |   
|[[ISDBApplication::PluginsPath|PluginsPath]] |Property Get | From 3.1 beta 1 | Yes
|[[ISDBApplication::CurrentAddonInstallRoot|CurrentAddonInstallRoot]] |Property Get |  From 4.0
|[[ISDBApplication::CurrentAddonInstallRoot|CurrentAddonInstallRoot]] |Property Get |  From 4.0 | Yes
|[[ISDBApplication::ScriptsPath|ScriptsPath]] |Property Get |   
|[[ISDBApplication::ScriptsPath|ScriptsPath]] |Property Get | From 3.1 beta 1 | Yes
|[[ISDBApplication::SkinsPath|SkinsPath]] |Property Get |
|[[ISDBApplication::SkinsPath|SkinsPath]] |Property Get | From 3.1 beta 1 | Yes
|[[ISDBApplication::CommonDialog|CommonDialog]] |Property Get |
|[[ISDBApplication::CommonDialog|CommonDialog]] |Property Get |   | No
|[[ISDBApplication::CreateTimer|CreateTimer]] |Method |
|[[ISDBApplication::CreateTimer|CreateTimer]] |Method |   |
|[[ISDBApplication::CurrentSongList|CurrentSongList]] |Property Get |
|[[ISDBApplication::CurrentSongList|CurrentSongList]] |Property Get |   | No
|[[ISDBApplication::CursorType|CursorType]] |Property Get/Let |
|[[ISDBApplication::CursorType|CursorType]] |Property Get/Let |   |
|[[ISDBApplication::Database|Database]] |Property Get |
|[[ISDBApplication::Database|Database]] |Property Get |   | Yes
|[[ISDBApplication::Device|Device]] |Property Get |
|[[ISDBApplication::Device|Device]] |Property Get |   | No
|[[ISDBApplication::Format|Format]] |Method |
|[[ISDBApplication::Format|Format]] |Method |   | Yes
|[[ISDBApplication::IniFile|IniFile]] |Property Get |
|[[ISDBApplication::IniFile|IniFile]] |Property Get |   | No
|[[ISDBApplication::IsKnownFiletype|IsKnownFiletype]] |Method |
|[[ISDBApplication::IsKnownFiletype|IsKnownFiletype]] |Method | From 3.0 | Partial
|[[ISDBApplication::IsRunning|IsRunning]] |Property Get |   
|[[ISDBApplication::IsRunning|IsRunning]] |Property Get |  | Yes
|[[ISDBApplication::Localize|Localize]] |Method |
|[[ISDBApplication::InPartyMode|InPartyMode]] |Property Get |  From 4.1 | Partial
|[[ISDBApplication::LocalizedFormat|LocalizedFormat]] |Method |
|[[ISDBApplication::RunningAsService|RunningAsService]] |Property Get |  From 4.1 | Yes
|[[ISDBApplication::LocalizeGen|LocalizeGen]] |Method |
|[[ISDBApplication::Localize|Localize]] |Method |   | Partial
|[[ISDBApplication::MainTracksWindow|MainTracksWindow]] |Property Get |
|[[ISDBApplication::LocalizedFormat|LocalizedFormat]] |Method |   | Partial
|[[ISDBApplication::MainTree|MainTree]] |Property Get |
|[[ISDBApplication::LocalizeGen|LocalizeGen]] |Method |   | Partial
|[[ISDBApplication::MessageBox|MessageBox]] |Method |
|[[ISDBApplication::MainTracksWindow|MainTracksWindow]] |Property Get |   | No
|[[ISDBApplication::MyMusicPath|MyMusicPath]] |Property Get |
|[[ISDBApplication::MainTree|MainTree]] |Property Get |   | Yes
|[[ISDBApplication::NewSongData|NewSongData]] |Property Get |
|[[ISDBApplication::MessageBox|MessageBox]] |Method |   | Partial
|[[ISDBApplication::NewSongList|NewSongList]] |Property Get |
|[[ISDBApplication::MyMusicPath|MyMusicPath]] |Property Get |   | Yes
|[[ISDBApplication::NewStringList|NewStringList]] |Property Get |   
|[[ISDBApplication::NewSongData|NewSongData]] |Property Get |   | Yes
|[[ISDBApplication::Objects|Objects]] |Property Get/Let |
|[[ISDBApplication::NewSongList|NewSongList]] |Property Get |   | Yes
|[[ISDBApplication::Player|Player]] |Property Get |
|[[ISDBApplication::NewStringList|NewStringList]] |Property Get | From 3.0 | Yes
|[[ISDBApplication::PlaylistByTitle|PlaylistByTitle]] |Property Get |
|[[ISDBApplication::Objects|Objects]] |Property Get/Let |   |
|[[ISDBApplication::PlaylistByID|PlaylistByID]] |Property Get | From v4.0
|[[ISDBApplication::Player|Player]] |Property Get |   |
|[[ISDBApplication::ProcessMessages|ProcessMessages]] |Method |
|[[ISDBApplication::PlaylistByTitle|PlaylistByTitle]] |Property Get | |  
|[[ISDBApplication::Progress|Progress]] |Property Get |
|[[ISDBApplication::PlaylistByID|PlaylistByID]] |Property Get | From 4.0   |
|[[ISDBApplication::RefreshScriptItems|RefreshScriptItems]] |Method |
|[[ISDBApplication::ProcessMessages|ProcessMessages]] |Method |   |
|[[ISDBApplication::RegisterIcon|RegisterIcon]] |Method |
|[[ISDBApplication::Progress|Progress]] |Property Get |   |
|[[ISDBApplication::RegisterIconHandle|RegisterIconHandle]] |Method |
|[[ISDBApplication::RefreshScriptItems|RefreshScriptItems]] |Method | From 3.0 |
|[[ISDBApplication::Registry|Registry]] |Property Get |
|[[ISDBApplication::RegisterIcon|RegisterIcon]] |Method |   |
|[[ISDBApplication::SelectedSongList|SelectedSongList]] |Property Get |
|[[ISDBApplication::RegisterIconHandle|RegisterIconHandle]] |Method |   |
|[[ISDBApplication::SelectFolder|SelectFolder]] |Method |
|[[ISDBApplication::Registry|Registry]] |Property Get |   |
|[[ISDBApplication::ShutdownAfterDisconnect|ShutdownAfterDisconnect]] |Property Get/Let |
|[[ISDBApplication::SelectedSongList|SelectedSongList]] |Property Get |   |
|[[ISDBApplication::TemporaryFolder|TemporaryFolder]] |Property Get |
|[[ISDBApplication::SelectFolder|SelectFolder]] |Method |   |
|[[ISDBApplication::toASCII|toASCII]] |Method |
|[[ISDBApplication::ShutdownAfterDisconnect|ShutdownAfterDisconnect]] |Property Get/Let |   |
|[[ISDBApplication::Tools|Tools]] |Property Get |
|[[ISDBApplication::TemporaryFolder|TemporaryFolder]] |Property Get |   |
|[[ISDBApplication::UI|UI]] |Property Get |
|[[ISDBApplication::toASCII|toASCII]] |Method |   |
|[[ISDBApplication::VersionBuild|VersionBuild]] |Property Get |
|[[ISDBApplication::Tools|Tools]] |Property Get |   |
|[[ISDBApplication::VersionHi|VersionHi]] |Property Get |
|[[ISDBApplication::UI|UI]] |Property Get |   |
|[[ISDBApplication::VersionLo|VersionLo]] |Property Get |
|[[ISDBApplication::VersionBuild|VersionBuild]] |Property Get |   |
|[[ISDBApplication::VersionRelease|VersionRelease]] |Property Get |
|[[ISDBApplication::VersionHi|VersionHi]] |Property Get |   |
|[[ISDBApplication::VersionString|VersionString]] |Property Get |
|[[ISDBApplication::VersionLo|VersionLo]] |Property Get |   |
|[[ISDBApplication::ComServerUIActive|ComServerUIActive]] |Property Get/Let |
|[[ISDBApplication::VersionRelease|VersionRelease]] |Property Get |   |
|[[ISDBApplication::WebControl|WebControl]] |Property Get |
|[[ISDBApplication::VersionString|VersionString]] |Property Get |   |
|[[ISDBApplication::Downloader|Downloader]] |Property Get | From v4.0  
|[[ISDBApplication::ComServerUIActive|ComServerUIActive]] |Property Get/Let |   |
|[[ISDBApplication::Collections|Collections]] |Property Get | From v4.0  
|[[ISDBApplication::WebControl|WebControl]] |Property Get |   |
|[[ISDBApplication::VisibleCollectionsCount|VisibleCollectionsCount]] |Property Get | From v4.0
|[[ISDBApplication::Downloader|Downloader]] |Property Get | From 4.0 |
|[[ISDBApplication::VisibleCollectionID|VisibleCollectionID]] |Property Get | From v4.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 |
}}
}}


Line 70: Line 88:
|[[ISDBApplicationEvents::OnBeforeTracksMove|OnBeforeTracksMove]] |Event |   
|[[ISDBApplicationEvents::OnBeforeTracksMove|OnBeforeTracksMove]] |Event |   
|[[ISDBApplicationEvents::OnChangedSelection|OnChangedSelection]] |Event |   
|[[ISDBApplicationEvents::OnChangedSelection|OnChangedSelection]] |Event |   
|[[ISDBApplicationEvents::OnCompletePlaybackEnd|OnCompletePlaybackEnd]] |Event | From v4.0   
|[[ISDBApplicationEvents::OnCompletePlaybackEnd|OnCompletePlaybackEnd]] |Event | From 4.0   
|[[ISDBApplicationEvents::OnDownloadFinished|OnDownloadFinished]] |Event | From v4.0
|[[ISDBApplicationEvents::OnDownloadFinished|OnDownloadFinished]] |Event | From 4.0
|[[ISDBApplicationEvents::OnFilterChange|OnFilterChange]] |Event |
|[[ISDBApplicationEvents::OnFilterChange|OnFilterChange]] |Event | From 3.1
|[[ISDBApplicationEvents::OnIdle|OnIdle]] |Event |
|[[ISDBApplicationEvents::OnIdle|OnIdle]] |Event | From 3.1
|[[ISDBApplicationEvents::OnNowPlayingModified|OnNowPlayingModified]] |Event |
|[[ISDBApplicationEvents::OnNowPlayingModified|OnNowPlayingModified]] |Event | From 3.1
|[[ISDBApplicationEvents::OnNowPlayingSelectionChanged|OnNowPlayingSelectionChanged]] |Event |
|[[ISDBApplicationEvents::OnNowPlayingSelectionChanged|OnNowPlayingSelectionChanged]] |Event | From 3.1
|[[ISDBApplicationEvents::OnOptionsChange|OnOptionsChange]] |Event |
|[[ISDBApplicationEvents::OnOptionsChange|OnOptionsChange]] |Event | From 3.1
|[[ISDBApplicationEvents::OnPause|OnPause]] |Event |   
|[[ISDBApplicationEvents::OnPause|OnPause]] |Event |   
|[[ISDBApplicationEvents::OnPlay|OnPlay]] |Event |   
|[[ISDBApplicationEvents::OnPlay|OnPlay]] |Event |   
|[[ISDBApplicationEvents::OnPlaybackEnd|OnPlaybackEnd]] |Event |  
|[[ISDBApplicationEvents::OnPlaybackEnd|OnPlaybackEnd]] |Event | From 3.1
|[[ISDBApplicationEvents::OnRepeatClicked|OnRepeatClicked]] |Event |
|[[ISDBApplicationEvents::OnRepeatClicked|OnRepeatClicked]] |Event | From 3.1
|[[ISDBApplicationEvents::OnSeek|OnSeek]] |Event |   
|[[ISDBApplicationEvents::OnSeek|OnSeek]] |Event |   
|[[ISDBApplicationEvents::OnShuffleClicked|OnShuffleClicked]] |Event |
|[[ISDBApplicationEvents::OnShuffleClicked|OnShuffleClicked]] |Event | From 3.1
|[[ISDBApplicationEvents::OnShutdown|OnShutdown]] |Event |   
|[[ISDBApplicationEvents::OnShutdown|OnShutdown]] |Event |   
|[[ISDBApplicationEvents::OnStop|OnStop]] |Event |   
|[[ISDBApplicationEvents::OnStop|OnStop]] |Event |   
|[[ISDBApplicationEvents::OnTrackAdded|OnTrackAdded]] |Event |   
|[[ISDBApplicationEvents::OnTrackAdded|OnTrackAdded]] |Event |   
|[[ISDBApplicationEvents::OnTrackConverted|OnTrackConverted]] |Event |   
|[[ISDBApplicationEvents::OnTrackConverted|OnTrackConverted]] |Event |   
|[[ISDBApplicationEvents::OnTrackDeleting|OnTrackDeleting]] |Event |   
|[[ISDBApplicationEvents::OnTrackDeleting|OnTrackDeleting]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackEnd|OnTrackEnd]] |Event |
|[[ISDBApplicationEvents::OnTrackDoubleClick|OnTrackDoubleClick]] |Event |   
|[[ISDBApplicationEvents::OnTrackListFilled|OnTrackListFilled]] |Event |
|[[ISDBApplicationEvents::OnTrackEnd|OnTrackEnd]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackListFilling|OnTrackListFilling]] |Event |
|[[ISDBApplicationEvents::OnTrackListFilled|OnTrackListFilled]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackListModified|OnTrackListModified]] |Event | From v4.0   
|[[ISDBApplicationEvents::OnTrackListFilling|OnTrackListFilling]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackListSelectionChanged|OnTrackListSelectionChanged]] |Event |
|[[ISDBApplicationEvents::OnTrackListModified|OnTrackListModified]] |Event | From 4.0   
|[[ISDBApplicationEvents::OnTrackListSelectionChanged|OnTrackListSelectionChanged]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackProperties|OnTrackProperties]] |Event |   
|[[ISDBApplicationEvents::OnTrackProperties|OnTrackProperties]] |Event |   
|[[ISDBApplicationEvents::OnTrackSkipped|OnTrackSkipped]] |Event | From v4.0  
|[[ISDBApplicationEvents::OnTrackSkipped|OnTrackSkipped]] |Event | From 4.0  
|[[ISDBApplicationEvents::OnPartyModeEnabled|OnPartyModeEnabled]] |Event | From v4.1  
|[[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  
}}
}}


Latest revision as of 20:48, 5 December 2020

CoClass SDBApplication

This is the main MediaMonkey scripting object that you initially have accessible as global SDB 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 SongsDB.SDBApplication.

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 Script, pointing to SDBScriptControl object.

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

ISDBApplication members

Name Type Description Supported in MM5?
AllVisibleSongList Property Get No
ApplicationPath Property Get Yes
EqualizerPath Property Get From 3.1 beta 1 Yes
IconsPath Property Get From 3.1 beta 1 Yes
PluginsPath Property Get From 3.1 beta 1 Yes
CurrentAddonInstallRoot Property Get From 4.0 Yes
ScriptsPath Property Get From 3.1 beta 1 Yes
SkinsPath Property Get From 3.1 beta 1 Yes
CommonDialog Property Get No
CreateTimer Method
CurrentSongList Property Get No
CursorType Property Get/Let
Database Property Get Yes
Device Property Get No
Format Method Yes
IniFile Property Get No
IsKnownFiletype Method From 3.0 Partial
IsRunning Property Get Yes
InPartyMode Property Get From 4.1 Partial
RunningAsService Property Get From 4.1 Yes
Localize Method Partial
LocalizedFormat Method Partial
LocalizeGen Method Partial
MainTracksWindow Property Get No
MainTree Property Get Yes
MessageBox Method Partial
MyMusicPath Property Get Yes
NewSongData Property Get Yes
NewSongList Property Get Yes
NewStringList Property Get From 3.0 Yes
Objects Property Get/Let
Player Property Get
PlaylistByTitle Property Get
PlaylistByID Property Get From 4.0
ProcessMessages Method
Progress Property Get
RefreshScriptItems Method From 3.0
RegisterIcon Method
RegisterIconHandle Method
Registry Property Get
SelectedSongList Property Get
SelectFolder Method
ShutdownAfterDisconnect Property Get/Let
TemporaryFolder Property Get
toASCII Method
Tools Property Get
UI Property Get
VersionBuild Property Get
VersionHi Property Get
VersionLo Property Get
VersionRelease Property Get
VersionString Property Get
ComServerUIActive Property Get/Let
WebControl Property Get
Downloader Property Get From 4.0
Collections Property Get From 4.0
VisibleCollectionsCount Property Get From 4.0
VisibleCollectionID Property Get From 4.0


ISDBApplicationEvents members

Name Type Description
OnBeforeTracksMove Event
OnChangedSelection Event
OnCompletePlaybackEnd Event From 4.0
OnDownloadFinished Event From 4.0
OnFilterChange Event From 3.1
OnIdle Event From 3.1
OnNowPlayingModified Event From 3.1
OnNowPlayingSelectionChanged Event From 3.1
OnOptionsChange Event From 3.1
OnPause Event
OnPlay Event
OnPlaybackEnd Event From 3.1
OnRepeatClicked Event From 3.1
OnSeek Event
OnShuffleClicked Event From 3.1
OnShutdown Event
OnStop Event
OnTrackAdded Event
OnTrackConverted Event
OnTrackDeleting Event From 3.1
OnTrackDoubleClick Event
OnTrackEnd Event From 3.1
OnTrackListFilled Event From 3.1
OnTrackListFilling Event From 3.1
OnTrackListModified Event From 4.0
OnTrackListSelectionChanged Event From 3.1
OnTrackProperties Event
OnTrackSkipped Event From 4.0
OnPartyModeEnabled Event From 4.1
OnDeviceSyncStarted Event From 4.1
OnDeviceSyncCompleted Event From 4.1
OnPlaylistAdded Event From 4.1
OnPlaylistRemoved Event From 4.1
OnPlaylistChanged Event From 4.1
OnDeviceFileCopied Event From 4.1.1
Retrieved from "https://www.mediamonkey.com/wiki/index.php?title=SDBApplication&oldid=9251"