SDBApplication: Difference between revisions

From MediaMonkey Wiki
Jump to navigation Jump to search
(Added version information to few paths.)
(10 intermediate revisions by 3 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 ===
Line 23: Line 39:
|[[ISDBApplication::Format|Format]] |Method |   
|[[ISDBApplication::Format|Format]] |Method |   
|[[ISDBApplication::IniFile|IniFile]] |Property Get |   
|[[ISDBApplication::IniFile|IniFile]] |Property Get |   
|[[ISDBApplication::IsKnownFiletype|IsKnownFiletype]] |Method |
|[[ISDBApplication::IsKnownFiletype|IsKnownFiletype]] |Method | From 3.0
|[[ISDBApplication::IsRunning|IsRunning]] |Property Get |   
|[[ISDBApplication::IsRunning|IsRunning]] |Property Get |   
|[[ISDBApplication::InPartyMode|InPartyMode]] |Property Get |  From 4.1
|[[ISDBApplication::InPartyMode|InPartyMode]] |Property Get |  From 4.1
|[[ISDBApplication::RunningAsService|RunningAsService]] |Property Get |  From 4.1
|[[ISDBApplication::Localize|Localize]] |Method |   
|[[ISDBApplication::Localize|Localize]] |Method |   
|[[ISDBApplication::LocalizedFormat|LocalizedFormat]] |Method |   
|[[ISDBApplication::LocalizedFormat|LocalizedFormat]] |Method |   
Line 35: Line 52:
|[[ISDBApplication::NewSongData|NewSongData]] |Property Get |   
|[[ISDBApplication::NewSongData|NewSongData]] |Property Get |   
|[[ISDBApplication::NewSongList|NewSongList]] |Property Get |   
|[[ISDBApplication::NewSongList|NewSongList]] |Property Get |   
|[[ISDBApplication::NewStringList|NewStringList]] |Property Get |
|[[ISDBApplication::NewStringList|NewStringList]] |Property Get | From 3.0
|[[ISDBApplication::Objects|Objects]] |Property Get/Let |   
|[[ISDBApplication::Objects|Objects]] |Property Get/Let |   
|[[ISDBApplication::Player|Player]] |Property Get |   
|[[ISDBApplication::Player|Player]] |Property Get |   
Line 42: Line 59:
|[[ISDBApplication::ProcessMessages|ProcessMessages]] |Method |   
|[[ISDBApplication::ProcessMessages|ProcessMessages]] |Method |   
|[[ISDBApplication::Progress|Progress]] |Property Get |   
|[[ISDBApplication::Progress|Progress]] |Property Get |   
|[[ISDBApplication::RefreshScriptItems|RefreshScriptItems]] |Method |
|[[ISDBApplication::RefreshScriptItems|RefreshScriptItems]] |Method | From 3.0
|[[ISDBApplication::RegisterIcon|RegisterIcon]] |Method |   
|[[ISDBApplication::RegisterIcon|RegisterIcon]] |Method |   
|[[ISDBApplication::RegisterIconHandle|RegisterIconHandle]] |Method |   
|[[ISDBApplication::RegisterIconHandle|RegisterIconHandle]] |Method |   
Line 71: 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::OnTrackDoubleClick|OnTrackDoubleClick]] |Event |   
|[[ISDBApplicationEvents::OnTrackDoubleClick|OnTrackDoubleClick]] |Event |   
|[[ISDBApplicationEvents::OnTrackEnd|OnTrackEnd]] |Event |
|[[ISDBApplicationEvents::OnTrackEnd|OnTrackEnd]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackListFilled|OnTrackListFilled]] |Event |
|[[ISDBApplicationEvents::OnTrackListFilled|OnTrackListFilled]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackListFilling|OnTrackListFilling]] |Event |
|[[ISDBApplicationEvents::OnTrackListFilling|OnTrackListFilling]] |Event | From 3.1
|[[ISDBApplicationEvents::OnTrackListModified|OnTrackListModified]] |Event | From v4.0   
|[[ISDBApplicationEvents::OnTrackListModified|OnTrackListModified]] |Event | From 4.0   
|[[ISDBApplicationEvents::OnTrackListSelectionChanged|OnTrackListSelectionChanged]] |Event |
|[[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 v4.1  
|[[ISDBApplicationEvents::OnDeviceSyncStarted|OnDeviceSyncStarted]] |Event | From 4.1  
|[[ISDBApplicationEvents::OnDeviceSyncCompleted|OnDeviceSyncCompleted]] |Event | From v4.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  
}}
}}


Revision as of 21:25, 7 September 2014

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
AllVisibleSongList Property Get
ApplicationPath Property Get
EqualizerPath Property Get From 3.1 beta 1
IconsPath Property Get From 3.1 beta 1
PluginsPath Property Get From 3.1 beta 1
CurrentAddonInstallRoot Property Get From 4.0
ScriptsPath Property Get From 3.1 beta 1
SkinsPath Property Get From 3.1 beta 1
CommonDialog Property Get
CreateTimer Method
CurrentSongList Property Get
CursorType Property Get/Let
Database Property Get
Device Property Get
Format Method
IniFile Property Get
IsKnownFiletype Method From 3.0
IsRunning Property Get
InPartyMode Property Get From 4.1
RunningAsService Property Get From 4.1
Localize Method
LocalizedFormat Method
LocalizeGen Method
MainTracksWindow Property Get
MainTree Property Get
MessageBox Method
MyMusicPath Property Get
NewSongData Property Get
NewSongList Property Get
NewStringList Property Get From 3.0
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=8713"