List of built-in functions - Revision history

Hitcher: /* List of sort methods */

2025-03-04T17:36:23Z

List of sort methods

← Older revision		Revision as of 17:36, 4 March 2025
Line 882:		Line 882:
	\| <code>56</code>		\| <code>56</code>
	\| BPM		\| BPM
			\|-
			\| <code>57</code>
			\| OriginalTitle
			\|-
			\| <code>58</code>
			\| Provider
			\|-
			\| <code>59</code>
			\| UserPreference
	\|}		\|}



	== See also ==		== See also ==

Hitcher at 18:26, 3 March 2024

2024-03-03T18:26:02Z

← Older revision		Revision as of 18:26, 3 March 2024
Line 543:		Line 543:
	\|-		\|-
	\| <code>Skin.Reset(setting)</code>		\| <code>Skin.Reset(setting)</code>
	\| Resets the skin setting ?setting?. If ?setting? is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If ?setting? is a string (Set via SetString, SetImage, or SetPath) then it is set to empty.		\| Resets the skin setting <code>(setting)</code>. If <code>(setting)</code> is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If <code>(setting)</code> is a string (Set via SetString, SetImage, or SetPath) then it is set to empty.
	\|		\|
	\|-		\|-
Line 559:		Line 559:
	\|-		\|-
	\| <code>Skin.SetBool(setting)</code>		\| <code>Skin.SetBool(setting)</code>
	\| Sets the skin setting ?setting? to true, for use with the conditional visibility tags containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other Kodi settings.		\| Sets the skin setting <code>(setting)</code> to true, for use with the conditional visibility tags containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other Kodi settings.
	\|		\|
	\|-		\|-
Line 591:		Line 591:
	\|-		\|-
	\| <code>Skin.ToggleSetting(setting)</code>		\| <code>Skin.ToggleSetting(setting)</code>
	\| Toggles the skin setting ?setting? for use with conditional visibility tags containing Skin.HasSetting(setting).		\| Toggles the skin setting <code>(setting)</code> for use with conditional visibility tags containing Skin.HasSetting(setting).
	\|		\|
	\|-		\|-

Karellen: Fix error as advised by @darwindesign

2023-05-22T22:44:18Z

Fix error as advised by @darwindesign

← Older revision		Revision as of 22:44, 22 May 2023
Line 168:		Line 168:
	! style="width: 5%"\| Version		! style="width: 5%"\| Version
	\|-		\|-
	\| <code>EpgGridControl(command)</code>		\| <code>PVR.EpgGridControl(command)</code>
	\| supported commands: firstprogramme (jump to the first programme) / currentprogramme (jump to the current programme) / lastprogramme (jump to the last programme) / selectdate (jump to the selected date & time) / +XX (jump XX hours forward) / -XX (jump XX hours back) / firstchannel (jump to the first channel) / playingchannel (jump to the currently playing channel) / lastchannel (jump to the last channel) / previousgroup (switch the epg to the previous group) / nextgroup (switch the epg to the next group) / selectgroup (select a group)		\| supported commands: firstprogramme (jump to the first programme) / currentprogramme (jump to the current programme) / lastprogramme (jump to the last programme) / selectdate (jump to the selected date & time) / +XX (jump XX hours forward) / -XX (jump XX hours back) / firstchannel (jump to the first channel) / playingchannel (jump to the currently playing channel) / lastchannel (jump to the last channel) / previousgroup (switch the epg to the previous group) / nextgroup (switch the epg to the next group) / selectgroup (select a group)
	\| {{nowrap\|v19 Addition}}		\| {{nowrap\|v19 Addition}}

Karellen: Marked as Outdated

2023-02-22T23:19:50Z

Marked as Outdated

← Older revision		Revision as of 23:19, 22 February 2023
Line 1:		Line 1:
	{{mininav\| [[Python development]] {{l2\| [[Add-on development]] }} {{l2\| [[Skinning]] }} \| [[Built-in scripting]] }}		{{mininav\| [[Python development]] {{l2\| [[Add-on development]] }} {{l2\| [[Skinning]] }} \| [[Built-in scripting]] }}

			{{outdated\|This page has become too large and complex to maintain by volunteer editors, and has been only sporadically updated over the last few years.<br/>This page may have missing data, and may also shows data that has been deprecated.<br/>'''Refer to the up to date [https://xbmc.github.io/docs.kodi.tv/master/kodi-base/d0/d3e/page__list_of_built_in_functions.html Doxygen documentation]'''}}

	<section begin="main content" />		<section begin="main content" />

Karellen at 07:51, 29 January 2023

2023-01-29T07:51:00Z

← Older revision		Revision as of 07:51, 29 January 2023
Line 468:		Line 468:
	\|		\|
	\|-		\|-
	\| <code>QueueMedia()</code>		\| <code>QueueMedia()</code> <ref>https://github.com/xbmc/xbmc/pull/22048</ref>
	\| Queues the given media. This can be a playlist\, music\, or video file\, directory\, plugin or an Url. The optional parameter "\,isdir" can be used for playing a directory. "\,1" will start the media without switching to fullscreen. If media is a playlist\, you can use playoffset=xx where xx is the position to start playback from.		\| Queues the given media. This can be a playlist\, music\, or video file\, directory\, plugin or an Url. The optional parameter "\,isdir" can be used for playing a directory. "\,1" will start the media without switching to fullscreen. If media is a playlist\, you can use playoffset=xx where xx is the position to start playback from.
	* @param[in] media URL of media to queue.		* @param[in] media URL of media to queue.
Line 886:		Line 886:
	== See also ==		== See also ==
	* [[Action IDs]]		* [[Action IDs]]


			== References ==
			<references />

Karellen: Updated for v20

2023-01-29T07:47:48Z

Updated for v20

← Older revision		Revision as of 07:47, 29 January 2023
Line 1:		Line 1:
	{{mininav\| [[Python development]] {{l2\| [[Add-on development]] }} {{l2\| [[Skinning]] }} \| [[Built-in scripting]] }}		{{mininav\| [[Python development]] {{l2\| [[Add-on development]] }} {{l2\| [[Skinning]] }} \| [[Built-in scripting]] }}

	<section begin="main content" />		<section begin="main content" />
	Skins can use built-in functions with the <onclick> or <onfocus> tag. Scripts can call built-in functions with <code>xbmc.executebuiltin(function, block)</code>.		Skins can use built-in functions with the <onclick> or <onfocus> tag. Scripts can call built-in functions with <code>xbmc.executebuiltin(function, block)</code>.
Line 15:		Line 16:
	'''You can use parameters with all media windows, as can be seen here:'''		'''You can use parameters with all media windows, as can be seen here:'''
	* [[Opening Windows and Dialogs]]		* [[Opening Windows and Dialogs]]



	== List of functions ==		== List of functions ==
	<section begin="functions" />		<section begin="functions" />


	=== Add-on built-in's ===		=== Add-on built-in's ===
Line 79:		Line 83:
	\|-		\|-
	\|}		\|}


	=== Android built-in's ===		=== Android built-in's ===
Line 92:		Line 97:
	\|-		\|-
	\|}		\|}


	=== Application built-in's ===		=== Application built-in's ===
Line 129:		Line 135:
	\|-		\|-
	\|}		\|}


	=== CEC built-in's ===		=== CEC built-in's ===
Line 150:		Line 157:
	\|-		\|-
	\|}		\|}


	=== EPG built-in's ===		=== EPG built-in's ===
Line 162:		Line 170:
	\| {{nowrap\|v19 Addition}}		\| {{nowrap\|v19 Addition}}
	\|}		\|}


	=== GUI built-in's ===		=== GUI built-in's ===
Line 263:		Line 272:
	\|-		\|-
	\|}		\|}


	=== GUI container built-in's ===		=== GUI container built-in's ===
Line 308:		Line 318:
	\|-		\|-
	\|}		\|}


	=== GUI control built-in's ===		=== GUI control built-in's ===
Line 345:		Line 356:
	\|-		\|-
	\|}		\|}


	=== Library built-in's ===		=== Library built-in's ===
Line 375:		Line 387:
	\|-		\|-
	\|}		\|}


	=== Optical container built-in's ===		=== Optical container built-in's ===
Line 392:		Line 405:
	\|-		\|-
	\|}		\|}


	=== Picture built-in's ===		=== Picture built-in's ===
Line 413:		Line 427:
	\|-		\|-
	\|}		\|}


	=== Player built-in's ===		=== Player built-in's ===
Line 451:		Line 466:
	\| <code>PlayWith()</code>		\| <code>PlayWith()</code>
	\| Play the selected item with the specified player core.		\| Play the selected item with the specified player core.
			\|
			\|-
			\| <code>QueueMedia()</code>
			\| Queues the given media. This can be a playlist\, music\, or video file\, directory\, plugin or an Url. The optional parameter "\,isdir" can be used for playing a directory. "\,1" will start the media without switching to fullscreen. If media is a playlist\, you can use playoffset=xx where xx is the position to start playback from.
			* @param[in] media URL of media to queue.
			* @param[in] isdir Set "isdir" if media is a directory (optional).
			* @param[in] 1 Set "1" to start playback without switching to fullscreen (optional).
			* @param[in] resume Set "resume" to force resuming (optional).
			* @param[in] noresume Set "noresume" to force not resuming (optional).
			* @param[in] playeroffset Set "playoffset=<offset>" to start playback from a given position in a playlist (optional).
			* @param[in] playnext Set "playnext" to play the media right after the currently playing item, if player is currently playing. If player is not playing, append media to current playlist (optional).
	\|		\|
	\|-		\|-
Line 458:		Line 484:
	\|-		\|-
	\|}		\|}


	=== Profile built-in's ===		=== Profile built-in's ===
Line 479:		Line 506:
	\|-		\|-
	\|}		\|}


	=== PVR built-in's ===		=== PVR built-in's ===
Line 499:		Line 527:
	\|		\|
	\|}		\|}


	=== Skin built-in's ===		=== Skin built-in's ===
Line 568:		Line 597:
	\|-		\|-
	\|}		\|}


	=== System built-in's ===		=== System built-in's ===
Line 633:		Line 663:
	\|-		\|-
	\|}		\|}


	=== Weather built-in's ===		=== Weather built-in's ===

	{\| class="prettytable sort sortable" style="width: 100%;"		{\| class="prettytable sort sortable" style="width: 100%;"
	! style="width: 29%"\| Function		! style="width: 29%"\| Function
Line 851:		Line 881:
	\| BPM		\| BPM
	\|}		\|}
	~~{{updated\|18}}~~


	== See also ==		== See also ==
	* [[Action IDs]]		* [[Action IDs]]



			{{updated\|20}}

	[[Category:Python]]		[[Category:Python]]
	[[Category:Add-on development]]		[[Category:Add-on development]]
	[[Category:Skin development]]		[[Category:Skin development]]

Black eagle: /* List of sort methods */

2023-01-27T13:31:10Z

List of sort methods

@@ Line 838: / Line 838: @@
 | <code>52</code>
 | LastUsed
 |}
 {{updated|18}}

CastagnaIT: /* Player built-in's */ Better name for PlayMedia path param

2022-09-09T18:26:45Z

Player built-in's: Better name for PlayMedia path param

← Older revision		Revision as of 18:26, 9 September 2022
Line 442:		Line 442:
	\|		\|
	\|-		\|-
	\| <code>PlayMedia(~~media~~[,isdir][,1][,playoffset=xx][,resume][,noresume][,playlist_type_hint=x])</code>		\| <code>PlayMedia(mediaPath[,isdir][,1][,playoffset=xx][,resume][,noresume][,playlist_type_hint=x])</code>
	\| Plays the media. This can be a playlist, music, or video file, directory, plugin or a url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start the media without switching to fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. Set "resume" to force resuming. Set "noresume" to force not resuming.		\| Plays the media. This can be a playlist, music, or video file, directory, plugin or a url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start the media without switching to fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. Set "resume" to force resuming. Set "noresume" to force not resuming.

CastagnaIT: /* Player built-in's */ just fix spaces

2022-09-09T18:21:33Z

Player built-in's: just fix spaces

← Older revision		Revision as of 18:21, 9 September 2022
Line 443:		Line 443:
	\|-		\|-
	\| <code>PlayMedia(media[,isdir][,1][,playoffset=xx][,resume][,noresume][,playlist_type_hint=x])</code>		\| <code>PlayMedia(media[,isdir][,1][,playoffset=xx][,resume][,noresume][,playlist_type_hint=x])</code>
	\| Plays the media. This can be a playlist, music, or video file, directory, plugin or a url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start the media without switching to fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. Set "resume" to force resuming. Set "noresume" to force not resuming. {{note\|Following parameters are available from Kodi v20.}} If media is a playlist (e.g. STRM), you can set the type of playlist with "playlist_type_hint=x" where x can be 0 for music playlist or 1 for video playlist, if not set will be used music playlist.		\| Plays the media. This can be a playlist, music, or video file, directory, plugin or a url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start the media without switching to fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. Set "resume" to force resuming. Set "noresume" to force not resuming.

			{{note\|Following parameters are available from Kodi v20.}}
			If media is a playlist (e.g. STRM), you can set the type of playlist with "playlist_type_hint=x" where x can be 0 for music playlist or 1 for video playlist, if not set will be used music playlist.
	\|		\|
	\|-		\|-

CastagnaIT: /* Player built-in's */ add playlist_type_hint param to PlayMedia

2022-09-09T18:20:01Z

Player built-in's: add playlist_type_hint param to PlayMedia

← Older revision		Revision as of 18:20, 9 September 2022
Line 442:		Line 442:
	\|		\|
	\|-		\|-
	\| <code>PlayMedia(media[,isdir][,1],[playoffset=xx],[resume],[~~noresume~~])</code>		\| <code>PlayMedia(media[,isdir][,1][,playoffset=xx][,resume][,noresume][,playlist_type_hint=x])</code>
	\| Plays the media. This can be a playlist, music, or video file, directory, plugin or a url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start the media without switching to fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. Set "resume" to force resuming. Set "noresume" to force not resuming.		\| Plays the media. This can be a playlist, music, or video file, directory, plugin or a url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start the media without switching to fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. Set "resume" to force resuming. Set "noresume" to force not resuming. {{note\|Following parameters are available from Kodi v20.}} If media is a playlist (e.g. STRM), you can set the type of playlist with "playlist_type_hint=x" where x can be 0 for music playlist or 1 for video playlist, if not set will be used music playlist.
	\|		\|
	\|-		\|-