Built-in scripting - Revision history

Ronie: /* General form of built-in Functions */

2020-09-12T21:44:21Z

General form of built-in Functions

← Older revision		Revision as of 21:44, 12 September 2020
Line 4:		Line 4:
	== General form of built-in Functions ==		== General form of built-in Functions ==
	Built-in functions take the form		Built-in functions take the form
	Function(param1,param2,...).		''Function(param1,param2,...)''.

	TSome parameters may be required, depending on the function. In parsing built-in functions, Kodi first treats quoted (using double quotes ") character strings as literal, and drops the quotes. Thus, when inside a quote, any otherwise special characters will be ignored until the quote is complete. Parameters are separated by commas and, given that functions may be parameters to other functions (such as with the AlarmClock function), anything within brackets () are treated as a single block as well. Finally, prior to passing parameters into the function, any initial and trailing spaces are removed. This system allows you to pass in functions as parameters (the commas used for the passed function are ignored as they're within a () block), as well as allowing you to ignore whitespace around parameter separators. If you wish to pass commas in directly as part of a parameter, simply put quotes around the parameter string - Kodi will strip off the quotes prior to passing it in. Lastly, to pass in an actual quote character, make sure it's escaped (using the \ character), as in "\".		TSome parameters may be required, depending on the function. In parsing built-in functions, Kodi first treats quoted (using double quotes ") character strings as literal, and drops the quotes. Thus, when inside a quote, any otherwise special characters will be ignored until the quote is complete. Parameters are separated by commas and, given that functions may be parameters to other functions (such as with the AlarmClock function), anything within brackets () are treated as a single block as well. Finally, prior to passing parameters into the function, any initial and trailing spaces are removed. This system allows you to pass in functions as parameters (the commas used for the passed function are ignored as they're within a () block), as well as allowing you to ignore whitespace around parameter separators. If you wish to pass commas in directly as part of a parameter, simply put quotes around the parameter string - Kodi will strip off the quotes prior to passing it in. Lastly, to pass in an actual quote character, make sure it's escaped (using the \ character), as in "\".

Ronie: /* General form of built-in Functions */

2020-09-12T21:43:43Z

General form of built-in Functions

← Older revision		Revision as of 21:43, 12 September 2020
Line 4:		Line 4:
	== General form of built-in Functions ==		== General form of built-in Functions ==
	Built-in functions take the form		Built-in functions take the form
			Function(param1,param2,...).

	~~[XBMC.]Function(param1,param2,...).~~		TSome parameters may be required, depending on the function. In parsing built-in functions, Kodi first treats quoted (using double quotes ") character strings as literal, and drops the quotes. Thus, when inside a quote, any otherwise special characters will be ignored until the quote is complete. Parameters are separated by commas and, given that functions may be parameters to other functions (such as with the AlarmClock function), anything within brackets () are treated as a single block as well. Finally, prior to passing parameters into the function, any initial and trailing spaces are removed. This system allows you to pass in functions as parameters (the commas used for the passed function are ignored as they're within a () block), as well as allowing you to ignore whitespace around parameter separators. If you wish to pass commas in directly as part of a parameter, simply put quotes around the parameter string - Kodi will strip off the quotes prior to passing it in. Lastly, to pass in an actual quote character, make sure it's escaped (using the \ character), as in "\".

	~~The XBMC. prefix is optional. Some~~ parameters ~~are~~ required, depending on the function. In parsing built-in functions, Kodi first treats quoted (using double quotes ") character strings as literal, and drops the quotes. Thus, when inside a quote, any otherwise special characters will be ignored until the quote is complete. Parameters are separated by commas and, given that functions may be parameters to other functions (such as with the AlarmClock function), anything within brackets () are treated as a single block as well. Finally, prior to passing parameters into the function, any initial and trailing spaces are removed. This system allows you to pass in functions as parameters (the commas used for the passed function are ignored as they're within a () block), as well as allowing you to ignore whitespace around parameter separators. If you wish to pass commas in directly as part of a parameter, simply put quotes around the parameter string - Kodi will strip off the quotes prior to passing it in. Lastly, to pass in an actual quote character, make sure it's escaped (using the \ character), as in "\".

	Some examples:		Some examples:

Ronie: /* Using Built-in Functions from keymap.xml */

2020-09-12T21:42:49Z

Using Built-in Functions from keymap.xml

← Older revision		Revision as of 21:42, 12 September 2020
Line 36:		Line 36:
	To bind a built-in function to a particular key, you just add the built-in command to the appropriate section and button in keymap.xml		To bind a built-in function to a particular key, you just add the built-in command to the appropriate section and button in keymap.xml

	For example, to map the running of an ~~executeable~~ to the BLACK button, we'd add:		For example, to map the running of an script to the BLACK button, we'd add:

	<syntaxhighlight lang="xml" enclose="div">		<syntaxhighlight lang="xml" enclose="div">
	<gamepad>		<gamepad>
	...		...
	<black>~~XBMC.RunXBE~~(~~E:\Apps\AVALaunch~~.~~xbe~~)</black>		<black>RunScript(script.myscript)</black>
	...		...
	</gamepad>		</gamepad>

Ronie: /* Using Built-in Functions from python */

2020-09-12T21:41:53Z

Using Built-in Functions from python

← Older revision		Revision as of 21:41, 12 September 2020
Line 29:		Line 29:
	== Using Built-in Functions from python ==		== Using Built-in Functions from python ==
	To run a built-in Kodi function from within a python script, you just need to call executebuiltin() with the function name. For example,		To run a built-in Kodi function from within a python script, you just need to call executebuiltin() with the function name. For example,
	xbmc.executebuiltin('~~XBMC.~~RunScript(~~Q:\Scripts\~~myscript~~.py~~)')		xbmc.executebuiltin('RunScript(script.myscript)')
	will run the script myscript.py located in the Scripts directory. There is an optional second argument, a boolean which requests a blocking call. By default built-on functions are non-blocking and executebuiltin() will return before the built-in function has run to completion. By specifying True, you can request executebuiltin() to wait until the built-in function is finished before returning:		will run the script myscript.py located in the Scripts directory. There is an optional second argument, a boolean which requests a blocking call. By default built-on functions are non-blocking and executebuiltin() will return before the built-in function has run to completion. By specifying True, you can request executebuiltin() to wait until the built-in function is finished before returning:
	xbmc.executebuiltin('~~XBMC.~~RunScript(~~Q:\Scripts\~~myscript~~.py~~)', True)		xbmc.executebuiltin('RunScript(script.myscript)', True)

	== Using Built-in Functions from keymap.xml ==		== Using Built-in Functions from keymap.xml ==

ThumbOne: /* Using Built-in Functions from python */ Removing very dated addendum and incorprating it as the new fact

2020-07-04T05:55:12Z

Using Built-in Functions from python: Removing very dated addendum and incorprating it as the new fact

← Older revision		Revision as of 05:55, 4 July 2020
Line 30:		Line 30:
	To run a built-in Kodi function from within a python script, you just need to call executebuiltin() with the function name. For example,		To run a built-in Kodi function from within a python script, you just need to call executebuiltin() with the function name. For example,
	xbmc.executebuiltin('XBMC.RunScript(Q:\Scripts\myscript.py)')		xbmc.executebuiltin('XBMC.RunScript(Q:\Scripts\myscript.py)')
	will run the script myscript.py located in the Scripts directory. ~~On 28.11.2011~~ a ~~optional parameter was added~~. ~~Normal call will be~~ non-blocking ~~- so it returns~~ before the ~~extraction~~ has ~~been finished~~. ~~Now it's possible~~ to ~~call~~ built-in ~~functions blocking by doing~~:		will run the script myscript.py located in the Scripts directory. There is an optional second argument, a boolean which requests a blocking call. By default built-on functions are non-blocking and executebuiltin() will return before the built-in function has run to completion. By specifying True, you can request executebuiltin() to wait until the built-in function is finished before returning:
	xbmc.executebuiltin('XBMC.RunScript(Q:\Scripts\myscript.py)', True)		xbmc.executebuiltin('XBMC.RunScript(Q:\Scripts\myscript.py)', True)

Ned Scott at 02:32, 14 May 2015

2015-05-14T02:32:39Z

← Older revision		Revision as of 02:32, 14 May 2015
Line 1:		Line 1:
			{{mininav\| [[Python development]] {{l2\| [[Add-on development]] }} {{l2\| [[Skinning]] }} }}
	Kodi contains several built-in functions that can be accessed from the skin (via a button), from within a python script, or [[keymap]].		Kodi contains several built-in functions that can be accessed from the skin (via a button), from within a python script, or [[keymap]].

Ronie: /* Using Built-in Functions from the skin */

2015-05-08T22:43:38Z

Using Built-in Functions from the skin

← Older revision		Revision as of 22:43, 8 May 2015
Line 19:		Line 19:
	To have a button (or toggle button) on the skin run a particular function, you just have to add an <onclick> tag (or <onfocus> tag) containing the function you wish to run.<br />		To have a button (or toggle button) on the skin run a particular function, you just have to add an <onclick> tag (or <onfocus> tag) containing the function you wish to run.<br />
	For example, adding the following to a button control will create a stop button.		For example, adding the following to a button control will create a stop button.
	<onclick>~~XBMC.~~PlayerControl(Stop)</onclick>		<onclick>PlayerControl(Stop)</onclick>

	If you want a button in your skin taking you directly to the movie listing, add a parameter to the [[Window IDs\|Window ID]] as follows:		If you want a button in your skin taking you directly to the movie listing, add a parameter to the [[Window IDs\|Window ID]] as follows:
	<onclick>~~XBMC.~~ActivateWindow(myvideolibrary,movietitles)</onclick>		<onclick>ActivateWindow(myvideolibrary,movietitles)</onclick>
	A list of parameters can be found here:		A list of parameters can be found here:
	* [[Opening Windows and Dialogs]]<br />		* [[Opening Windows and Dialogs]]<br />

Ned Scott at 00:16, 27 April 2015

2015-04-27T00:16:36Z

Ned Scott: /* List of Built In Functions */

2015-04-27T00:14:34Z

List of Built In Functions

← Older revision		Revision as of 00:14, 27 April 2015
Line 49:		Line 49:
	For more information on changing the keymapping with keymap.xml see: [[Keyboard.xml\|Changing the keymapping]]		For more information on changing the keymapping with keymap.xml see: [[Keyboard.xml\|Changing the keymapping]]

	=== [[List of ~~Built In Functions]]~~ ===		=== List of built-in functions ===
			{{see\|List of built-in functions}}

	[[Category:Skin development]]		[[Category:Skin development]]

NedBot: Robot: Substituting template: Name

2014-06-05T20:09:44Z

Robot: Substituting template: Name

← Older revision		Revision as of 20:09, 5 June 2014
Line 6:		Line 6:
	[XBMC.]Function(param1,param2,...).		[XBMC.]Function(param1,param2,...).

	The XBMC. prefix is optional. Some parameters are required, depending on the function. In parsing built-in functions, ~~{{name}}~~ first treats quoted (using double quotes ") character strings as literal, and drops the quotes. Thus, when inside a quote, any otherwise special characters will be ignored until the quote is complete. Parameters are separated by commas and, given that functions may be parameters to other functions (such as with the AlarmClock function), anything within brackets () are treated as a single block as well. Finally, prior to passing parameters into the function, any initial and trailing spaces are removed. This system allows you to pass in functions as parameters (the commas used for the passed function are ignored as they're within a () block), as well as allowing you to ignore whitespace around parameter separators. If you wish to pass commas in directly as part of a parameter, simply put quotes around the parameter string - ~~{{name}}~~ will strip off the quotes prior to passing it in. Lastly, to pass in an actual quote character, make sure it's escaped (using the \ character), as in "\".		The XBMC. prefix is optional. Some parameters are required, depending on the function. In parsing built-in functions, XBMC first treats quoted (using double quotes ") character strings as literal, and drops the quotes. Thus, when inside a quote, any otherwise special characters will be ignored until the quote is complete. Parameters are separated by commas and, given that functions may be parameters to other functions (such as with the AlarmClock function), anything within brackets () are treated as a single block as well. Finally, prior to passing parameters into the function, any initial and trailing spaces are removed. This system allows you to pass in functions as parameters (the commas used for the passed function are ignored as they're within a () block), as well as allowing you to ignore whitespace around parameter separators. If you wish to pass commas in directly as part of a parameter, simply put quotes around the parameter string - XBMC will strip off the quotes prior to passing it in. Lastly, to pass in an actual quote character, make sure it's escaped (using the \ character), as in "\".

	Some examples:		Some examples:
Line 27:		Line 27:

	==== Using Built-in Functions from python ====		==== Using Built-in Functions from python ====
	To run a built-in ~~{{name}}~~ function from within a python script, you just need to call executebuiltin() with the function name. For example,		To run a built-in XBMC function from within a python script, you just need to call executebuiltin() with the function name. For example,
	xbmc.executebuiltin('XBMC.RunScript(Q:\Scripts\myscript.py)')		xbmc.executebuiltin('XBMC.RunScript(Q:\Scripts\myscript.py)')
	will run the script myscript.py located in the Scripts directory. On 28.11.2011 a optional parameter was added. Normal call will be non-blocking - so it returns before the extraction has been finished. Now it's possible to call built-in functions blocking by doing:		will run the script myscript.py located in the Scripts directory. On 28.11.2011 a optional parameter was added. Normal call will be non-blocking - so it returns before the extraction has been finished. Now it's possible to call built-in functions blocking by doing:

← Older revision		Revision as of 00:16, 27 April 2015
Line 1:		Line 1:
	~~XBMC~~ contains several built-in functions that can be accessed from the skin (via a button) or from within a python script, ~~XBMC's~~ [[~~HTTP API~~]] ~~or from a press of a button on the remote, gamepad, or keyboard~~.		Kodi contains several built-in functions that can be accessed from the skin (via a button), from within a python script, or [[keymap]].

	==== General form of built-in Functions ====		== General form of built-in Functions ==
	Built-in functions take the form		Built-in functions take the form

	[XBMC.]Function(param1,param2,...).		[XBMC.]Function(param1,param2,...).

	The XBMC. prefix is optional. Some parameters are required, depending on the function. In parsing built-in functions, ~~XBMC~~ first treats quoted (using double quotes ") character strings as literal, and drops the quotes. Thus, when inside a quote, any otherwise special characters will be ignored until the quote is complete. Parameters are separated by commas and, given that functions may be parameters to other functions (such as with the AlarmClock function), anything within brackets () are treated as a single block as well. Finally, prior to passing parameters into the function, any initial and trailing spaces are removed. This system allows you to pass in functions as parameters (the commas used for the passed function are ignored as they're within a () block), as well as allowing you to ignore whitespace around parameter separators. If you wish to pass commas in directly as part of a parameter, simply put quotes around the parameter string - ~~XBMC~~ will strip off the quotes prior to passing it in. Lastly, to pass in an actual quote character, make sure it's escaped (using the \ character), as in "\".		The XBMC. prefix is optional. Some parameters are required, depending on the function. In parsing built-in functions, Kodi first treats quoted (using double quotes ") character strings as literal, and drops the quotes. Thus, when inside a quote, any otherwise special characters will be ignored until the quote is complete. Parameters are separated by commas and, given that functions may be parameters to other functions (such as with the AlarmClock function), anything within brackets () are treated as a single block as well. Finally, prior to passing parameters into the function, any initial and trailing spaces are removed. This system allows you to pass in functions as parameters (the commas used for the passed function are ignored as they're within a () block), as well as allowing you to ignore whitespace around parameter separators. If you wish to pass commas in directly as part of a parameter, simply put quotes around the parameter string - Kodi will strip off the quotes prior to passing it in. Lastly, to pass in an actual quote character, make sure it's escaped (using the \ character), as in "\".

	Some examples:		Some examples:
Line 16:		Line 16:
	will all produce the exact same functionality, under the assumption that path_to_some_files contains no initial or trailing spaces (unlikely) and no unmatched brackets and commas. The "ActivateWindow" function will be called with two parameters: "VideoFiles" (the window to open) and "path_to_some_files" (a starting path for the browsing). If path_to_some_files contains initial or trailing spaces, or contains commas or brackets, then only the last form will function correctly.		will all produce the exact same functionality, under the assumption that path_to_some_files contains no initial or trailing spaces (unlikely) and no unmatched brackets and commas. The "ActivateWindow" function will be called with two parameters: "VideoFiles" (the window to open) and "path_to_some_files" (a starting path for the browsing). If path_to_some_files contains initial or trailing spaces, or contains commas or brackets, then only the last form will function correctly.

	==== Using Built-in Functions from the skin ====		== Using Built-in Functions from the skin ==
	To have a button (or toggle button) on the skin run a particular function, you just have to add an <onclick> tag (or <onfocus> tag) containing the function you wish to run.<br />		To have a button (or toggle button) on the skin run a particular function, you just have to add an <onclick> tag (or <onfocus> tag) containing the function you wish to run.<br />
	For example, adding the following to a button control will create a stop button.		For example, adding the following to a button control will create a stop button.
Line 26:		Line 26:
	* [[Opening Windows and Dialogs]]<br />		* [[Opening Windows and Dialogs]]<br />

	==== Using Built-in Functions from python ====		== Using Built-in Functions from python ==
	To run a built-in ~~XBMC~~ function from within a python script, you just need to call executebuiltin() with the function name. For example,		To run a built-in Kodi function from within a python script, you just need to call executebuiltin() with the function name. For example,
	xbmc.executebuiltin('XBMC.RunScript(Q:\Scripts\myscript.py)')		xbmc.executebuiltin('XBMC.RunScript(Q:\Scripts\myscript.py)')
	will run the script myscript.py located in the Scripts directory. On 28.11.2011 a optional parameter was added. Normal call will be non-blocking - so it returns before the extraction has been finished. Now it's possible to call built-in functions blocking by doing:		will run the script myscript.py located in the Scripts directory. On 28.11.2011 a optional parameter was added. Normal call will be non-blocking - so it returns before the extraction has been finished. Now it's possible to call built-in functions blocking by doing:
	xbmc.executebuiltin('XBMC.RunScript(Q:\Scripts\myscript.py)', True)		xbmc.executebuiltin('XBMC.RunScript(Q:\Scripts\myscript.py)', True)

	==== Using Built-in Functions from keymap.xml ====		== Using Built-in Functions from keymap.xml ==
	To bind a built-in function to a particular key, you just add the built-in command to the appropriate section and button in keymap.xml		To bind a built-in function to a particular key, you just add the built-in command to the appropriate section and button in keymap.xml

Line 49:		Line 49:
	For more information on changing the keymapping with keymap.xml see: [[Keyboard.xml\|Changing the keymapping]]		For more information on changing the keymapping with keymap.xml see: [[Keyboard.xml\|Changing the keymapping]]

	=== List of built-in functions ===		== List of built-in functions ==
	{{see\|List of built-in functions}}		{{see\|List of built-in functions}}

	[[Category:Skin development]]		[[Category:Skin development]]