View source for List of built-in functions

{{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" />
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>.

The latest up-to-date list of built-in functions can be found in the source code files in [https://github.com/xbmc/xbmc/tree/master/xbmc/interfaces/builtins].

In addition to the following list, for most <onclick> and <onfocus> button actions in the skin you can also use the functions from [[Keyboard.xml]].

<poem>
'''Example:'''
<onclick>VolumeUp</onclick>
<onclick>VolumeDown</onclick>
</poem>

'''You can use parameters with all media windows, as can be seen here:'''
* [[Opening Windows and Dialogs]]



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


=== Add-on built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <code>Addon.Default.OpenSettings(extensionpoint)</code>
| Open a settings dialog for the default addon of the given type (extensionpoint)
| 
|-
| <code>Addon.Default.Set(extensionpoint)</code>
| Open a select dialog to allow choosing the default addon of the given type (extensionpoint)
| 
|-
| <code>Addon.OpenSettings(id)</code>
| Open a settings dialog for the addon of the given id 
| 
|-
| <code>EnableAddon(id)</code>
| Enables the specified plugin/script
| v19 addition
|-
| <code>InstallAddon(id)</code>
| Will install the addon with the given id.
| 
|-
| <code>InstallFromZip</code>
| Opens the "Install from zip"-dialog if "Unknown sources" is enabled. Prompts the warning message if not.
|
|-
| <code>RunAddon(id)</code>
| Runs the specified plugin/script 
| 
|-
| <code>RunAppleScript(script[,args]*)</code>
| Run the specified AppleScript command 
| 
|-
| <code>RunPlugin(plugin)</code>
| Runs the plugin. Full path must be specified. Does not work for folder plugins 
| 
|-
| <code>RunScript(script[,args]*)</code>
| Runs the python script. You must specify the add-on id of the script. As of 2007/02/24, all extra parameters are passed to the script as arguments and can be accessed by python using sys.argv 
| 
|-
| <code>StopScript(id)</code>
| Stop the script by ID or path, if running
| {{nowrap|v12 Addition}}
|-
| <code>UpdateAddonRepos</code>
| Triggers a forced update of enabled add-on repositories. 
| 
|-
| <code>UpdateLocalAddons</code>
| Triggers a scan of local add-on directories. 
| 
|-
|}


=== Android built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <code>StartAndroidActivity(package,[intent,dataType,dataURI])</code>
| Launch an Android native app with the given package name. Optional parms (in order): intent, dataType, dataURI. example: <nowiki>StartAndroidActivity(com.android.chrome,android.intent.action.VIEW,,http://kodi.tv/)</nowiki>
| {{nowrap|v13 Addition}}
|-
|}


=== Application built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <code>Extract(archive_url[, destination])</code>
| Extracts a specified archive to an optionally specified 'absolute' path. 
| 
|-
| <code>Mute</code>
| Mutes (or unmutes) the volume. 
| 
|-
| <code>NotifyAll(sender, data [, json])</code>
| Notify all connected clients
| {{nowrap|v13 Addition}}
|-
| <code>SetVolume(percent[,showvolumebar])</code>
| Sets the volume to the percentage specified. Optionally, show the Volume Dialog in Kodi when setting the volume. 
| 
|-
| <code>ToggleDebug</code>
| Enables/disables debug mode
| {{nowrap|v12 Addition}}
|-
| <code>ToggleDPMS</code>
| Toggle DPMS (VESA Display Power Management Signaling) mode manually 
| 
|-
| <code>WakeOnLan(mac)</code>
| Sends the wake-up packet to the broadcast address for the specified MAC address (Format: FF:FF:FF:FF:FF:FF or FF-FF-FF-FF-FF-FF). 
| 
|-
|}


=== CEC built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <code>CECActivateSource</code>
| Wake up playing device via a CEC peripheral
| {{nowrap|v13 Addition}}
|-
| <code>CECStandby</code>
| Put playing device on standby via a CEC peripheral
| {{nowrap|v13 Addition}}
|-
| <code>CECToggleState</code>
| Toggle state of playing device via a CEC peripheral
| {{nowrap|v13 Addition}}
|-
|}


=== EPG built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <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)
| {{nowrap|v19 Addition}}
|}


=== GUI built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <code>Action(action[,window])</code>
| Executes an action (same as in keymap) for the given window or the active window if the parameter window is omitted. The parameter window can either be the window's id, or in the case of a standard window, the window's name. See [[Action IDs]] for a list of available actions. 
| 
|-
| <code>ActivateWindow(window[,dir,return])</code>
| Opens the given window. The parameter window can either be the window's id, or in the case of a standard window, the window's name. See [[Window IDs]] for a list of window names, and their respective ids. If, furthermore, the window is Music, Video, Pictures, or Program files, then the optional dir parameter specifies which folder Kodi should default to once the window is opened. This must be a source as specified in sources.xml, or a subfolder of a valid source. For some windows (MusicLibrary and VideoLibrary), the return parameter may be specified, which indicates that Kodi should use this folder as the "root" of the level, and thus the "parent directory" action from within this folder will return the user to where they were prior to the window activating. 
| 
|-
| <code>ActivateWindowAndFocus(id1, id2,item1, id3,item2)</code>
| Activate window with id1, first focus control id2 and then focus control id3. if either of the controls is a container, you can specify which item to focus (else, set it to 0).
| {{nowrap|v12 Addition}}
|-
| <code>AlarmClock(name,command,[time,silent,loop])</code>
| Pops up a dialog asking for the length of time (mm:ss) for the alarm (unless the parameter time is specified), and starts a timer. When the timer runs out, it'll execute the built-in command (the parameter command) if it is specified, otherwise it'll pop up an alarm notice. Add silent to hide the alarm notification. Add loop for the alarm to execute the command each time the specified time interval expires. If defining the last optional parameters (silent and loop) both have to be defined for any to take effect. The parameter "time" accepts an integer value (in minutes) or a timestring in the format "hh:mm:ss" or "mm min".
| 
|-
| <code>CancelAlarm(name[,silent])</code>
| Cancel a running alarm. Set silent to true to hide the alarm notification. 
| 
|-
| <code>ClearProperty(key[,id])</code>
| Clears a window property for the current focused window/dialog(key), or the specified window (key,id). 
| 
|-
| <code>Dialog.Close(dialog[,force])</code>
| Close a dialog. Set force to true to bypass animations. Use (all,true) to close all opened dialogs at once. 
| 
|-
| <code>NextChannelGroup</code>
| Navigate to the next PVR channel group (in DialogPVRChannelsOSD.xml)
| {{nowrap|v13 Addition}}
|-
| <code>NextStereoMode</code>
| Changes the stereo mode of the GUI to the next available mode.
| {{nowrap|v13 Addition}}
|-
| <code>Notification(header,message[,time,image])</code>
| Will display a notification dialog with the specified header and message, in addition you can set the length of time it displays in milliseconds and a icon image. 
| 
|-
| <code>PreviousChannelGroup</code>
| Navigate to the previous PVR channel group (in DialogPVRChannelsOSD.xml)
| {{nowrap|v13 Addition}}
|-
| <code>PreviousStereoMode</code>
| Changes the stereo mode of the GUI to the previous available mode.
| {{nowrap|v13 Addition}}
|-
| <code>RefreshRSS</code>
| Reload RSS feeds from RSSFeeds.xml 
| 
|-
| <code>ReplaceWindow(window,dir)</code>
| Replaces the current window with the given window. This is the same as ActivateWindow() but it doesn't update the window history list, so when you go back from the new window it will not return to the previous window, rather will return to the previous window's previous window. 
| 
|-
| <code>ReplaceWindowAndFocus(id1, id2,item1, id3,item2)</code>
| Replace window with id1, first focus control id2 and then focus control id3. if either of the controls is a container, you can specify which item to focus (else, set it to 0).
| {{nowrap|v13 Addition}}
|-
| <code>Resolution</code>
| Change Kodi's Resolution. 
| 
|-
| <code>SetGUILanguage(value)</code>
| Set GUI Language, 'value' is the language file to use. SetGUILanguage(resource.language.de_de)
| {{nowrap|v13 Addition}}
|-
| <code>SetProperty(key,value[,id])</code>
| Sets a window property for the current window (key,value), or the specified window (key,value,id). 
| 
|-
| <code>SetStereoMode</code>
| Changes the stereo mode of the GUI. Params can be: toggle, next, previous, select, tomono or any of the supported stereomodes (off, split_vertical, split_horizontal, row_interleaved, hardware_based, anaglyph_cyan_red, anaglyph_green_magenta, monoscopic)
| {{nowrap|v13 Addition}}
|-
| <code>settingslevelchange</code>
| Toggles the visible settings (in SettingsCategory.xml) between 'basic', 'standard', 'advanced and 'expert'
| {{nowrap|v13 Addition}}
|-
| <code>TakeScreenshot([filenameandpath,sync])</code>
| Takes a Screenshot. You can optionally specify the filename (including the path). Note: only .png files are supported. Add "sync" parameter to run synchronously (slow).
| 
|-
| <code>ToggleDirtyRegionVisualization</code>
| makes dirty regions visible for debugging proposes.
| {{nowrap|v16 Addition}}
|-
| <code>ToggleStereoMode</code>
| Toggle the stereoscopic mode of the GUI (on/off).
| {{nowrap|v13 Addition}}
|-
|}


=== GUI container built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <code>Container.NextSortMethod</code>
| Change to the next sort method. 
| 
|-
| <code>Container.NextViewMode</code>
| Select the next view mode. 
| 
|-
| <code>Container.PreviousSortMethod</code>
| Change to the previous sort method. 
| 
|-
| <code>Container.PreviousViewMode</code>
| Select the previous view mode. 
| 
|-
| <code>Container.Refresh</code>
| Refresh current listing. 
| 
|-
| <code>Container.SetSortMethod(id)</code>
| Change to the specified sort method. (For list of ID's see [[https://kodi.wiki/view/List_of_built-in_functions#List_of_sort_methods list of sort methods]]) 
| 
|-
| <code>Container.SetViewMode(id)</code>
| Set the current view mode (list, icons etc.) to the given container id. 
| 
|-
| <code>Container.SetSortDirection</code>
| Toggle the sort direction. 
| 
|-
| <code>Container.Update</code>
| Update current listing. Send Container.Update(path,replace) to reset the path history. 
| 
|-
|}


=== GUI control built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <code>Control.Message(id,message,[windowid])</code>
| Sends a given message to a control in a given window (or active window if omitted). Messages can be movedown, moveup, pagedown, pageup, click. 
| 
|-
| <code>Control.Move(id,offset)</code>
| Will make a Container with the "id" specified in the command move focus by "offset". 
| 
|-
| <code>Control.SetFocus(id,position[,absolute])</code>
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Set absolute to focus the first listitem of a container instead of the first visible listitem. Alias SetFocus(id,position) 
| 
|-
| <code>PageDown</code>
| Send a page down event to the pagecontrol with given id. 
| 
|-
| <code>PageUp</code>
| Send a page up event to the pagecontrol with given id. 
| 
|-
| <code>SendClick(windowid,id)</code>
| Sends a click to a control in a given window (or active window if omitted). 
| 
|-
| <code>SetFocus(id,position[,absolute])</code>
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Set absolute to focus the first listitem of a container instead of the first visible listitem. Alias Control.SetFocus(id,position) 
| 
|-
|}


=== Library built-in's ===


{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <code>CleanLibrary(database)</code>
| This funtion will perform a number of 'cleanup' tasks on your video database and can be run if you have moved, deleted or renamed files. Takes either "video" or "music" as a parameter to begin cleaning the corresponding database. 
| 
|-
| <code>exportlibrary(music,false,filepath)</code>
| The music library will be exported to a single file stored at filepath location. 
| 
|-
| <code>exportlibrary(video,true,thumbs,overwrite,actorthumbs)</code>
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false). 
| 
|-
| <code>UpdateLibrary(database,[path])</code>
| Takes either "video" or "music" as a parameter to begin updating the corresponding database. For "video" you can additionally specify a specific path to be scanned. 
| 
|-
| <code>VideoLibrary.Search</code>
| Brings up a search dialog which will search the library 
| 
|-
|}


=== Optical container built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <code>EjectTray()</code>
| Either opens or closes the DVD tray, depending on its current state 
| 
|-
| <code>RipCD</code>
| Will rip the inserted CD from the DVD-ROM drive. 
| 
|-
|}


=== Picture built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <code>RecursiveSlideShow(dir)</code>
| Run a slideshow from the specified directory, including all subdirs 
| 
|-
| <code>ShowPicture(picture)</code>
| Show a picture by its file path/url.
| {{nowrap|v13 Addition}}
|-
| <code>SlideShow(dir[,recursive][,[not]random][,pause][,beginslide="/path/to/start/slide.jpg"])</code>
| Starts a slideshow of pictures in the folder dir. Optional parameters are 'recursive', 'random' or 'notrandom', 'pause' and 'beginslide="/path/to/some/image.jpg"' parameters. The "recursive" parameter starts a recursive slideshow, adding images from sub-folders. The "random" and "notrandom" parameters override the Randomize setting found in the pictures media window. The "pause" parameter will start the slideshow paused. "beginslide" will start the slideshow with the specified image.
| 
|-
|}


=== Player built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <code>PlayDisc(param)</code>
| Will play the inserted CD or DVD media from the DVD-ROM drive. 
| 
|-
| <code>PlayerControl(command)</code>
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, FrameAdvance(#), TempoUp, TempoDown, Tempo(value), Random, RandomOn, RandomOff, Repeat, RepeatOne, RepeatAll, RepeatOff, Partymode(music) or Partymode(video) or Partymode(path to .xsp file) or Reset. 
Play will either pause, resume, or stop ffwding or rewinding. Random toggles random playback and Repeat cycles through the repeat modes (these both take an optional second parameter, Notify, that notifies the user of the new state). Partymode(music/video) toggles the appropriate partymode, defaults to music if no parameter is given, besides the default music or video partymode you can also pass a path to a custom smartplaylist (.xsp) as parameter. Reset only applies to games and will reset the currently playing game.
| 
|-
| <code>PlayerResolutionSelect</code>
| Select a different resolution
| v18
|-
| <code>Playlist.Clear</code>
| Clear the current playlist 
| 
|-
| <code>Playlist.PlayOffset</code>
| Start playing from a particular offset in the playlist 
| 
|-
| <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.

{{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.
| 
|-
| <code>PlayWith()</code>
| Play the selected item with the specified player core. 
| 
|-
| <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.
* @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).
| 
|-
| <code>Seek(seconds)</code>
| Seeks to the specified relative amount of seconds within the current playing media. A negative value will seek backward and a positive value forward.
| {{nowrap|v15 Addition}}
|-
|}


=== Profile built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <code>LoadProfile(profilename,[prompt])</code>
| Load the specified profile. If prompt is not specified, and a password would be required for the requested profile, this command will silently fail. If promp' is specified and a password is required, a password dialog will be shown. 
| 
|-
| <code>Mastermode</code>
| Runs Kodi in master mode 
| 
|-
| <code>System.LogOff</code>
| Log off current user. 
| 
|-
|}


=== PVR built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <code>PVR.SearchMissingChannelIcons</code>
| Will start a search for missing channel icons
| {{nowrap|v16 Addition}}
|-
| <code>PVR.ToggleRecordPlayingChannel</code>
| Will toggle recording on playing channel, if any 
| v18
|-
| <code>PVR.SeekPercentage</code>
| Performs a seek to the given percentage in timeshift buffer, if timeshifting is supported 
|
|}


=== Skin built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <code>ReloadSkin()</code>
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling) 
| 
|-
| <code>Skin.Reset(setting)</code>
| 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. 
| 
|-
| <code>Skin.ResetSettings</code>
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.) 
| 
|-
| <code>Skin.SelectBool(header, label1&#124;setting1, label2&#124;setting2)</code>
| Pops up select dialog to select between multiple skin setting options. Skin.SelectBool(424, 31411&#124;RecentWidget, 31412&#124;RandomWidget, 31413&#124;InProgressWidget)
| 
|-
| <code>Skin.SetAddon(string,type)</code>
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are xbmc.addon.video, xbmc.addon.audio, xbmc.addon.image, xbmc.addon.executable and kodi.gameclient. 
| 
|-
| <code>Skin.SetBool(setting)</code>
| 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. 
| 
|-
| <code>Skin.SetFile(string,mask,folderpath)</code>
| Pops up a folder browser and allows the user to select a file off the hard-disk to be used else where in the skin via the info tag Skin.String(string). If the mask parameter is specified, then the file browser will only search for the extension specified (.avi,.mp3,.m3u,.png,.bmp,etc.,etc.). To use multiple extensions separate them using "<nowiki>|</nowiki>" (minus quotes). If the folderpath parameter is set the file browser will start in that folder. 
| 
|-
| <code>Skin.SetImage(string[,value,path])</code>
| Pops up a file browser and allows the user to select an image file to be used in an image control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly. the path option allows you to open the file browser in the specified folder. 
| 
|-
| <code>Skin.SetNumeric(numeric[,value])</code>
| Pops up a keyboard dialog and allows the user to input a numerical. 
| 
|-
| <code>Skin.SetPath(string[,folderpath])</code>
| Pops up a folder browser and allows the user to select a folder of images to be used in a multi image control else where in the skin via the info tag Skin.String(string). If the folderpath parameter is set the file browser will start in that folder. 
| 
|-
| <code>Skin.SetString(string[,value])</code>
| Pops up a keyboard dialog and allows the user to input a string which can be used in a label control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the keyboard dialog does not pop up, and the string is set directly. 
| 
|-
| <code>Skin.Theme(1)</code>
| Cycles the skin theme. Skin.Theme(-1) will go backwards. 
| 
|-
| <code>Skin.ToggleDebug</code>
| Toggles skin debug info on/off 
| 
|-
| <code>Skin.ToggleSetting(setting)</code>
| Toggles the skin setting <code>(setting)</code> for use with conditional visibility tags containing Skin.HasSetting(setting). 
| 
|-
| <code>UnloadSkin()</code>
| Unloads the current skin 
| 
|-
|}


=== System built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <code>ActivateScreensaver</code>
| Starts the screensaver
| {{nowrap|v13 Addition}}
|-
| <code>Hibernate</code>
| Hibernate (S4) the System 
| 
|-
| <code>InhibitIdleShutdown(true/false)</code>
| Prevent the system to shutdown on idle.
| {{nowrap|v12 Addition}}
|-
| <code>InhibitScreensaver(true/false)</code>
| Prevent activation of the screensaver.
| {{nowrap|v19 Addition}}
|-
| <code>Minimize</code>
| Minimizes Kodi 
| 
|-
| <code>Powerdown</code>
| Powerdown system 
| 
|-
| <code>Quit</code>
| Quits Kodi 
| 
|-
| <code>Reboot</code>
| Cold reboots the system (power cycle) 
| 
|-
| <code>Reset</code>
| Reset the system (same as reboot) 
| 
|-
| <code>RestartApp</code>
| Restarts Kodi (only implemented under Windows and Linux) 
| 
|-
| <code>ShutDown</code>
| Trigger default Shutdown action defined in System Settings 
| 
|-
| <code>Suspend</code>
| Suspends (S3 / S1 depending on bios setting) the System 
| 
|-
| <code>System.Exec(exec)</code>
| Execute shell commands. The full path to the script has to be placed inside the parentheses.
| 
|-
| <code>System.ExecWait(exec)</code>
| Execute shell commands and freezes Kodi until shell is closed. As well as for "System.Exec(exec)", the full path to the script has to be placed inside the parentheses.
| 
|-
|}


=== Weather built-in's ===
{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
| <code>Weather.LocationNext</code>
| Switch to next weather location 
| 
|-
| <code>Weather.LocationPrevious</code>
| Switch to previous weather location 
| 
|-
| <code>Weather.LocationSet</code>
| Switch to given weather location (parameter can be 1-3) 
| 
|-
| <code>Weather.Refresh</code>
| Force weather data refresh
| 
|}
<section end="functions" />
<section end="main content" />


== Removed functions ==
* <code>LastFM.Love</code> - Removed in v13 Gotham
* <code>LastFM.Ban</code> - Removed in v13 Gotham
* <code>LCD.Suspend</code> - Removed in v13 Gotham
* <code>LCD.Resume</code> - Removed in v13 Gotham
* <code>AllowIdleShutdown</code>
* <code>Help</code>
* <code>LIRC.Send(command)</code>
* <code>LIRC.Start</code>
* <code>LIRC.Stop</code>
* <code>StartPVRManager</code>
* <code>StereoModeToMono</code>
* <code>StopPVRManager</code>



== List of sort methods ==
These ID's can be used with the Container.SetSortMethod(id) function as listed [https://github.com/xbmc/xbmc/blob/75b31098a8800da653b373cd99a025b483029cfc/xbmc/utils/SortUtils.h#L49-L164 here]:
{| class="prettytable"
! ID
! Description
|-
| <code>1</code>
| Name
|-
| <code>2</code>
| Date
|-
| <code>3</code>
| Size
|-
| <code>4</code>
| File
|-
| <code>5</code>
| Path
|-
| <code>6</code>
| DriveType
|-
| <code>7</code>
| Title
|-
| <code>8</code>
| TrackNumber
|-
| <code>9</code>
| Time
|-
| <code>10</code>
| Artist
|-
| <code>11</code>
| ArtistThenYear
|-
| <code>12</code>
| Album
|-
| <code>13</code>
| AlbumType
|-
| <code>14</code>
| Genre
|-
| <code>15</code>
| Country
|-
| <code>16</code>
| Year
|-
| <code>17</code>
| Rating
|-
| <code>18</code>
| UserRating
|-
| <code>19</code>
| Votes
|-
| <code>20</code>
| Top250
|-
| <code>21</code>
| ProgramCount
|-
| <code>22</code>
| PlaylistOrder
|-
| <code>23</code>
| EpisodeNumber
|-
| <code>24</code>
| Season
|-
| <code>25</code>
| NumberOfEpisodes
|-
| <code>26</code>
| NumberOfWatchedEpisodes
|-
| <code>27</code>
| TvShowStatus
|-
| <code>28</code>
| TvShowTitle
|-
| <code>29</code>
| SortTitle
|-
| <code>30</code>
| ProductionCode
|-
| <code>31</code>
| MPAA
|-
| <code>32</code>
| VideoResolution
|-
| <code>33</code>
| VideoCodec
|-
| <code>34</code>
| VideoAspectRatio
|-
| <code>35</code>
| AudioChannels
|-
| <code>36</code>
| AudioCodec
|-
| <code>37</code>
| AudioLanguage
|-
| <code>38</code>
| SubtitleLanguage
|-
| <code>39</code>
| Studio
|-
| <code>40</code>
| DateAdded
|-
| <code>41</code>
| LastPlayed
|-
| <code>42</code>
| Playcount
|-
| <code>43</code>
| Listeners
|-
| <code>44</code>
| Bitrate
|-
| <code>45</code>
| Random
|-
| <code>46</code>
| Channel
|-
| <code>47</code>
| ChannelNumber
|-
| <code>48</code>	
| DateTaken
|-
| <code>49</code>	
| Relevance
|-
| <code>50</code>	
| InstallDate
|-
| <code>51</code>	
| LastUpdated
|-
| <code>52</code>	
| LastUsed
|-
| <code>53</code>
| ClientChannelOrder
|-
| <code>54</code>
| TotalDiscs
|-
| <code>55</code>
| OriginalDate
|-
| <code>56</code>
| BPM
|}



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


== References ==
<references />



{{updated|20}}

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