Introduction to scripting - Revision history

Michal.kocarek: /* Considerations */ x-link

2014-11-25T23:16:00Z

Considerations: x-link

← Older revision		Revision as of 23:16, 25 November 2014
Line 6:		Line 6:
	*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.		*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].		*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.		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 (see [[Scripting Tips & Tricks#JScript\|Scripting Tips & Tricks]] for some issues), 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://www.sqlite.org SQLite] database from MediaMonkey version 3.0. 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 (almost, except string [[MediaMonkey_Database_structure#Additions_to_SQLite\|collations]]) completely bypassed by using an interface provided by the underlying engine to access the database. (MediaMonkey 2.x used [http://en.wikipedia.org/wiki/Microsoft_Jet_Database_Engine Microsoft Jet] relational database. It could accessed through Jet or ODBC, or even opened directly by Microsoft Access, for example.)		*Other than tags embedded in media files, virtually all of MediaMonkey’s data is stored in a [http://www.sqlite.org SQLite] database from MediaMonkey version 3.0. 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 (almost, except string [[MediaMonkey_Database_structure#Additions_to_SQLite\|collations]]) completely bypassed by using an interface provided by the underlying engine to access the database. (MediaMonkey 2.x used [http://en.wikipedia.org/wiki/Microsoft_Jet_Database_Engine Microsoft Jet] relational database. It could accessed through Jet or ODBC, or even opened directly by Microsoft Access, for example.)

Michal.kocarek: /* Format of the Scripts.ini file */ formatting

2014-11-25T23:11:52Z

Format of the Scripts.ini file: formatting

← Older revision		Revision as of 23:11, 25 November 2014
Line 100:		Line 100:
	: Message shown as tooltip when the mouse is moved over the menu item.		: Message shown as tooltip when the mouse is moved over the menu item.
	; Language		; Language
	: The script language of the referenced script. Usually VBScript, but can be JScript too (although this is not recommended).		: The script language of the referenced script. Usually <tt>VBScript</tt>, but can be <tt>JScript</tt> too (although this is not recommended).
	; Shortcut		; 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.		: 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.

Peke: /* Further reading */

2014-07-25T17:45:20Z

Michal.kocarek: /* Considerations */ Reformatted note about database

2013-04-20T23:16:25Z

Considerations: Reformatted note about database

← Older revision		Revision as of 23:16, 20 April 2013
Line 7:		Line 7:
	*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].		*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.		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 (almost, except string [[MediaMonkey_Database_structure#Additions_to_SQLite\|collations]]) 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.		*Other than tags embedded in media files, virtually all of MediaMonkey’s data is stored in a [http://www.sqlite.org SQLite] database from MediaMonkey version 3.0. 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 (almost, except string [[MediaMonkey_Database_structure#Additions_to_SQLite\|collations]]) completely bypassed by using an interface provided by the underlying engine to access the database. (MediaMonkey 2.x used [http://en.wikipedia.org/wiki/Microsoft_Jet_Database_Engine Microsoft Jet] relational database. It could accessed through Jet or ODBC, or even opened directly by Microsoft Access, for example.)

	== Types of scripts ==		== Types of scripts ==

Steegy at 14:28, 25 June 2011

2011-06-25T14:28:35Z

← Older revision		Revision as of 14:28, 25 June 2011
Line 7:		Line 7:
	*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].		*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.		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.		*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 (almost, except string [[MediaMonkey_Database_structure#Additions_to_SQLite\|collations]]) 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 ==		== Types of scripts ==
Line 38:		Line 38:


	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]].		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]] or, if you are already up to it, take a look at the code of some actively developed [http://www.mediamonkey.com/forum/viewforum.php?f=2 scripts on the forum] (most of them are distributed in [[Installation_Packages#Installation_Packages_structure\|MM installation packages]]).

	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).		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).
Line 60:		Line 60:

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

			You can choose to dynamically add an entry to the Scripts.ini from your code, so your script can be accessed from the Tools > Scripts submenu just like normal scripts. However, most auto-scripts add UI items (e.g. menu items) directly to the MediaMonkey user interface to be more tightly integrated.


Line 104:		Line 106:
	== About external scripts and applications ==		== About external scripts and applications ==

	MediaMonkey exposes an API via the Microsoft COM model. This allows external applications to access and control MediaMonkey directly. These can be written in any language that can access COM objects. VBScript can be used to produce external scripts, but regular Visual Basic (or any COM-aware language) ~~can be used as well, producing a full-fledged application.~~		(see also [[Scripting_Tips_&_Tricks#Interaction_with_MediaMonkey_from_outside\|Interaction with MediaMonkey from outside]])

	~~In order to work with MediaMonkey’s objects from an external script or application, you need to create a reference to the SDB object (an instance~~ of the [[~~SDBApplication~~]] ~~class~~) ~~yourself~~. ~~For .NET-based~~ applications~~, you must also add a reference~~ to MediaMonkey's COM ~~object~~ to ~~your~~ Visual ~~Studio project~~, ~~so that the compiler can find MediaMonkey and the SongsDB namespace~~.		Besides supporting al large part of the Winamp [http://wiki.winamp.com/wiki/Plug-in_Developer plug-in model] and messages ([http://wiki.winamp.com/wiki/SendMessage_API 1],[http://forums.winamp.com/showthread.php?threadid=180297 2]), MediaMonkey exposes an API via the Microsoft COM model. This allows external applications to access and control MediaMonkey directly. These applications can be written in any language that can access COM objects. VBScript can be used to produce external scripts, but regular Visual Basic (or any COM-aware language) can be used as well, producing a full-fledged application.

	If MediaMonkey is already running, creating a SDBApplication object instance 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.		In order to work with MediaMonkey’s objects from an external script or application, you need to create a reference to the SDB object (an instance of the [[SDBApplication]] class) yourself. For .NET-based applications, you must also add a reference to MediaMonkey's COM object "MediaMonkey Library" to your Visual Studio project, so that the compiler can find MediaMonkey and the SongsDB namespace.

			If MediaMonkey is already running, creating a SDBApplication object instance 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 (so MediaMonkey will remain running) by setting SDB's [[ISDBApplication::ShutdownAfterDisconnect\|ShutdownAfterDisconnect]] property to False.


Line 166:		Line 170:
	$SDB->ShutdownAfterDisconnect(true);		$SDB->ShutdownAfterDisconnect(true);
	</source>		</source>


			Developers that require MediaMonkey type library information (e.g. for C++/Delphi, as newer languages usually don't need this) can extract this from the MediaMonkey.exe file ([http://msdn.microsoft.com/en-us/library/ms680581(v=vs.85).aspx more information]), or can use #import on the Exe file as explained in [http://msdn.microsoft.com/en-us/library/8etzzkb6(v=vs.71).aspx this MSDN page].


	== Further reading ==		== Further reading ==
	* [[Scripting\|Scripting main page]]		* [[Scripting\|Scripting main page]]
	* [[.NET\|.NET Tips page]]		* [[.NET\|.NET Tips page]]

Alfonse: /* About external scripts and applications */ Improved explanation.

2011-06-01T18:13:05Z

About external scripts and applications: Improved explanation.

← Older revision		Revision as of 18:13, 1 June 2011
Line 104:		Line 104:
	== About external scripts and applications ==		== 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~~).		MediaMonkey exposes an API via the Microsoft COM model. This allows external applications to access and control MediaMonkey directly. These can be written in any language that can access COM objects. VBScript can be used to produce external scripts, but regular Visual Basic (or any COM-aware language) can be used as well, producing a full-fledged application.

	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~~.		In order to work with MediaMonkey’s objects from an external script or application, you need to create a reference to the SDB object (an instance of the [[SDBApplication]] class) yourself. For .NET-based applications, you must also add a reference to MediaMonkey's COM object to your Visual Studio project, so that the compiler can find MediaMonkey and the SongsDB namespace.

	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.		If MediaMonkey is already running, creating a SDBApplication object instance 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.

Alfonse at 00:37, 1 June 2011

2011-06-01T00:37:08Z

← Older revision		Revision as of 00:37, 1 June 2011
Line 124:		Line 124:
	</source>		</source>

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

Gramatus: /* Further reading */

2011-05-17T12:39:21Z

Johnw3600: /* Types of scripts */

2010-07-25T17:54:02Z

Types of scripts

← Older revision		Revision as of 17:54, 25 July 2010
Line 13:		Line 13:
	There are three major types of scripts that can be launched internally by MediaMonkey:		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]].		*'''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.		*'''Auto-scripts''' are located in the ''Scripts\Auto'' folder and its OnStartup method is executed when MediaMonkey starts. If more than one script exists in the Auto folder the scripts are run in alphabetical order.
	*'''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]].		*'''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]].

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

2010-06-29T14:31:21Z

Format of the ''Scripts.ini'' file

← Older revision		Revision as of 14:31, 29 June 2010
Line 100:		Line 100:
	: The script language of the referenced script. Usually VBScript, but can be JScript too (although this is not recommended).		: The script language of the referenced script. Usually VBScript, but can be JScript too (although this is not recommended).
	; Shortcut		; 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).		: 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 ==		== About external scripts and applications ==

← Older revision		Revision as of 17:45, 25 July 2014
Line 178:		Line 178:
	* [[Scripting\|Scripting main page]]		* [[Scripting\|Scripting main page]]
	* [[.NET\|.NET Tips page]]		* [[.NET\|.NET Tips page]]
			* [http://www.mediamonkey.com/sw/MediaMonkey.idl MediaMonkey Interface Definition Language (IDL) file]

← Older revision		Revision as of 12:39, 17 May 2011
Line 168:		Line 168:

	== Further reading ==		== Further reading ==
			* [[Scripting\|Scripting main page]]
	[[~~Scripting~~]]		* [[.NET\|.NET Tips page]]