List of built-in functions: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(98 intermediate revisions by 16 users not shown)
Line 1: Line 1:
{{mininav|[[Development]]|[[Add-on development]]}}
{{mininav| [[Python development]] {{l2| [[Add-on development]] }} {{l2| [[Skinning]] }} | [[Built-in scripting]] }}
<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>.


{{see also|Python development|Skinning}}
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].
 
{{cleanup}}
The latest up-to-date list of built-in functions can be found in the function '''CBuiltins::Execute()''' in the source code file [https://github.com/xbmc/xbmc/blob/master/xbmc/interfaces/Builtins.cpp xbmc/interfaces/Builtins.cpp].


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]].
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]].
<br />


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


'''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]]<br />
* [[Opening Windows and Dialogs]]


== List of functions ==
== 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>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 full path to the script. One way to specify the full path is through the [[Special protocol|special protocol]]. If the script is an add-on, you can also execute it using its add-on id. 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="wikitable" border="1"
{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
|-
| Help
| <code>CECActivateSource</code>
| This help message
| Wake up playing device via a CEC peripheral
| {{nowrap|v13 Addition}}
|-
|-
| Reboot
| <code>CECStandby</code>
| Cold reboots the system (power cycle)
| Put playing device on standby via a CEC peripheral
| {{nowrap|v13 Addition}}
|-
|-
| ShutDown
| <code>CECToggleState</code>
| Trigger default Shutdown action defined in System Settings
| Toggle state of playing device via a CEC peripheral
| {{nowrap|v13 Addition}}
|-
|-
| Powerdown
|}
| Powerdown system
 
=== GUI built-in's ===
 
{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
|-
| Quit
| <code>Action(action[,window])</code>
| Quits XBMC
| 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.
|  
|-
|-
| Hibernate
| <code>ActivateWindow(window[,dir,return])</code>
| Hibernate (S4) the System
| 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.
|
|-
|-
| Suspend
| <code>ActivateWindowAndFocus(id1, id2,item1, id3,item2)</code>
| Suspends (S3 / S1 depending on bios setting) the System
| 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).
|-{{frodo row}}
| {{nowrap|v12 Addition}}
| InhibitIdleShutdown(true/false)
| Prevent the system to shutdown on idle. '''([[:Category:Frodo feature|Future Frodo addition]])'''
|-{{frodo row}}
| AllowIdleShutdown
| Allow the system to shutdown on idle. '''([[:Category:Frodo feature|Future Frodo addition]])'''
|-
|-
| ActivateScreensaver
| <code>AlarmClock(name,command,time[,silent,loop])</code>
| Starts the screensaver '''([[:Category:Gotham feature|Future Gotham addition]])'''
| 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.
|
|-
|-
| RestartApp
| <code>CancelAlarm(name[,silent])</code>
| Restarts XBMC (not implemented under Win32)
| Cancel a running alarm. Set silent to true to hide the alarm notification.
|  
|-
|-
| Minimize
| <code>ClearProperty(key[,id])</code>
| Minimizes XBMC
| Clears a window property for the current focused window/dialog(key), or the specified window (key,id).
|  
|-
|-
| Reset
| <code>Dialog.Close(dialog[,force])</code>
| Reset the system (same as reboot)
| Close a dialog. Set force to true to bypass animations. Use (all,true) to close all opened dialogs at once.
|
|-
|-
| Mastermode
| <code>NextChannelGroup</code>
| Runs XBMC in master mode
| Navigate to the next PVR channel group (in DialogPVRChannelsOSD.xml)
|- {{gotham row}}
| {{nowrap|v13 Addition}}
| SetGUILanguage
| Set GUI Language
|-
|-
| ActivateWindow(window[,dir,return])
| <code>NextStereoMode</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. [[Window IDs|See here 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 XBMC 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 XBMC 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.
| Changes the stereo mode of the GUI to the next available mode.
|-{{frodo row}}
| {{nowrap|v13 Addition}}
| ActivateWindowAndFocus(id1, id2,item1, id3,item2)
| 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).'''([[:Category:Frodo feature|Future Frodo addition]])'''
|-
|-
| ReplaceWindowAndFocus(id1, id2,item1, id3,item2)
| <code>Notification(header,message[,time,image])</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).'''([[:Category:Gotham feature|Future Gotham addition]])'''
| 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.  
|  
|-
|-
| ReplaceWindow(window,dir)
| <code>PreviousChannelGroup</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.
| Navigate to the previous PVR channel group (in DialogPVRChannelsOSD.xml)
| {{nowrap|v13 Addition}}
|-
|-
| TakeScreenshot
| <code>PreviousStereoMode</code>
| Takes a Screenshot
| Changes the stereo mode of the GUI to the previous available mode.
| {{nowrap|v13 Addition}}
|-
|-
| RunScript(script[,args]*)
| <code>RefreshRSS</code>
| Runs the python script. You must specify the full path to the script. If the script is an add-on, you can also execute it using its add-on id. As of 2007/02/24, all extra parameters are passed to the script as arguments and can be accessed by python using sys.argv
| Reload RSS feeds from RSSFeeds.xml
|
|-
|-
| StopScript(id)
| <code>ReplaceWindow(window,dir)</code>
| Stop the script by ID or path, if running
| 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.
|
|-
|-
| RunAppleScript(script[,args]*)
| <code>ReplaceWindowAndFocus(id1, id2,item1, id3,item2)</code>
| Run the specified AppleScript command
| 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}}
|-
|-
| RunPlugin(plugin)
| <code>Resolution</code>
| Runs the plugin. Full path must be specified. Does not work for folder plugins
| Change Kodi's Resolution.  
|
|-
|-
| RunAddon(id)
| <code>SetGUILanguage(value)</code>
| Runs the specified plugin/script
| Set GUI Language, 'value' is the language file to use. SetGUILanguage(resource.language.de_de)
| {{nowrap|v13 Addition}}
|-
|-
| Extract
| <code>SetProperty(key,value[,id])</code>
| Extracts a specified archive to an optionally specified path. <font color="red">! REQUIRES ABSOLUTE PATHS !</font>
| Sets a window property for the current window (key,value), or the specified window (key,value,id).  
|
|-
|-
| PlayMedia(media[,isdir][,1],[playoffset=xx])
| <code>SetStereoMode</code>
| Plays the 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 a video in a preview window, instead of fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from.
| 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)
|-  {{frodo row}}
| {{nowrap|v13 Addition}}
| Filter <font color="red">! NOT FOUND IN CODE !</font>
| Opens the mediafilter dialog in the video and musiclibrary '''([[:Category:Frodo feature|Future Frodo addition]])'''
|-
|-
| SlideShow(dir [,recursive, [not]random])
| <code>settingslevelchange</code>
| Starts a slideshow of pictures in the folder dir. Optional parameters are "recursive", and "random" or "notrandom" 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.
| Toggles the visible settings (in SettingsCategory.xml) between 'basic', 'standard', 'advanced and 'expert'
| {{nowrap|v13 Addition}}
|-
|-
| RecursiveSlideShow(dir)
| <code>TakeScreenshot([filenameandpath,sync])</code>
| Run a slideshow from the specified directory, including all subdirs
| 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).
|
|-
|-
| ReloadSkin()
| <code>ToggleDirtyRegionVisualization</code>
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)
| makes dirty regions visible for debugging proposes.
| {{nowrap|v16 Addition}}
|-
|-
| UnloadSkin()
| <code>ToggleStereoMode</code>
| uNLOADS the current skin
| Toggle the stereoscopic mode of the GUI (on/off).
| {{nowrap|v13 Addition}}
|-
|-
| RefreshRSS
|}
| Reload RSS feeds from RSSFeeds.xml
 
=== GUI container built-in's ===
 
{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
|-
| PlayerControl(command)
| <code>Container.NextSortMethod</code>
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, Random, RandomOn, RandomOff, Repeat, RepeatOne, RepeatAll, RepeatOff, Partymode(music) or Partymode(video) or Partymode(path to .xsp file), and Record. 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.
| Change to the next sort method.  
|
|-
|-
| Playlist.PlayOffset
| <code>Container.NextViewMode</code>
| Start playing from a particular offset in the playlist
| Select the next view mode.
|
|-
|-
| Playlist.Clear
| <code>Container.PreviousSortMethod</code>
| Clear the current playlist
| Change to the previous sort method.
|
|-
|-
| EjectTray()
| <code>Container.PreviousViewMode</code>
| Either opens or closes the DVD tray, depending on its current state
| Select the previous view mode.
|
|-
|-
| AlarmClock(name,command,time[,silent,loop])
| <code>Container.Refresh</code>
| Pops up a dialog asking for the length of time for the alarm (unless the parameter time is specified), and starts a timer. When the timer runs out, it'll execute the <span class="nobr">built-in</span> 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.
| Refresh current listing.  
|
|-
|-
| CancelAlarm(name[,silent])
| <code>Container.SetSortMethod(id)</code>
| Cancel a running alarm. Set silent to true to hide the alarm notification. only available in trunk >r35674
| Change to the specified sort method. (For list of ID's see List of sort methods below)
|
|-
|-
| Action
| <code>Container.SetViewMode(id)</code>
| Executes an action for the active window (same as in keymap)
| Set the current view mode (list, icons etc.) to the given container id.
|
|-
|-
| Notification(header,message[,time,image])
| <code>Container.SetSortDirection</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.
| Toggle the sort direction.  
|
|-
|-
| PlayDVD
| <code>Container.Update</code>
| Will play the inserted CD or DVD media from the <span class="nobr">DVD-ROM</span> drive.
| Update current listing. Send Container.Update(path,replace) to reset the path history.  
|
|-
|-
| RipCD
|}
| Will rip the inserted CD from the <span class="nobr">DVD-ROM</span> drive.
 
=== GUI control built-in's ===
 
{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
|-
| Skin.ToggleSetting(setting)
| <code>Control.Message(id,message,[windowid])</code>
| Toggles the skin setting ?setting? for use with [[Conditional Visibility|conditional visibility tags]] containing Skin.HasSetting(setting).
| Sends a given message to a control in a given window (or active window if omitted). Messages can be movedown, moveup, pagedown, pageup, click.
|
|-
|-
| Skin.SetString(string[,value])
| <code>Control.Move(id,offset)</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 [[InfoLabels|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.
| Will make a Container with the "id" specified in the command move focus by "offset".
|  
|-
|-
| Skin.SetNumeric(numeric[,value])
| <code>Control.SetFocus(id,position[,absolute])</code>
| Pops up a keyboard dialog and allows the user to input a numerical.
| 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)
|
|-
|-
| Skin.SetPath(string[,value])
| <code>PageDown</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 [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the path is set directly.
| Send a page down event to the pagecontrol with given id.
|  
|-
|-
| Skin.Theme
| <code>PageUp</code>
| Cycles the skin theme. Skin.theme(-1) will go backwards.
| Send a page up event to the pagecontrol with given id.  
|
|-
|-
| Skin.SetImage(string[,value])
| <code>SendClick(windowid,id)</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 [[InfoLabels|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.
| Sends a click to a control in a given window (or active window if omitted).  
|
|-
|-
| Skin.SetLargeImage(string[,value])
| <code>SetFocus(id,position[,absolute])</code>
| Pops up a file browser and allows the user to select an large image file to be used in an image control else where in the skin via the [[InfoLabels|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.
| 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)  
|
|-
|-
| Skin.SetFile(string,mask,folderpath)
|}
| 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 [[InfoLabels|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 "|" minus quotes. If the folderpath parameter is set the file browser will start in that folder.
 
=== Library built-in's ===
 
 
{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
|-
| Skin.SetAddon(string,type)
| <code>CleanLibrary(database)</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'' and ''xbmc.addon.executable''.
| 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.  
|
|-
|-
| Skin.SetBool(setting)
| <code>exportlibrary(music,false,filepath)</code>
| Sets the skin setting ?setting? to true, for use with the [[Conditional Visibility|conditional visibility tags]] containing Skin.HasSetting(setting). The settings are saved <span class="nobr">per-skin</span> in settings.xml just like all the other XBMC settings.
| The music library will be exported to a single file stored at filepath location.  
|
|-
|-
| Skin.Reset(setting)
| <code>exportlibrary(video,true,thumbs,overwrite,actorthumbs)</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.
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).  
|
|-
|-
| Skin.ResetSettings
| <code>UpdateLibrary(database,[path])</code>
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)
| 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.  
|
|-
|-
| Mute
| <code>VideoLibrary.Search</code>
| Mutes (or unmutes) the volume.
| Brings up a search dialog which will search the library
|
|-
|-
| SetVolume(percent[,showvolumebar])
|}
| Sets the volume to the percentage specified. Optionally, show the Volume Dialog in XBMC when setting the volume.
 
=== Optical container built-in's ===
 
{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
|-
| Dialog.Close(dialog[,force])
| <code>EjectTray()</code>
| Close a dialog. Set force to true to bypass animations. Use (all,true) to close all opened dialogs at once.
| Either opens or closes the DVD tray, depending on its current state
|
|-
|-
| System.LogOff
| <code>RipCD</code>
| Log off current user.
| Will rip the inserted CD from the DVD-ROM drive.  
|  
|-
|-
| System.Exec
|}
| Execute shell commands.
 
=== Picture built-in's ===
 
{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
|-
| System.ExecWait
| <code>RecursiveSlideShow(dir)</code>
| Execute shell commands and freezes XBMC until shell is closed.
| Run a slideshow from the specified directory, including all subdirs
|  
|-
|-
| Resolution
| <code>ShowPicture(picture)</code>
| Change XBMC's Resolution.
| Show a picture by its file path/url.
| {{nowrap|v13 Addition}}
|-
|-
| SetFocus(id,position)
| <code>SlideShow(dir[,recursive][,[not]random][,pause][,beginslide="/path/to/start/slide.jpg"])</code>
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position)
| 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.
|
|-
|-
| UpdateLibrary(database,[path])
|}
| 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.
 
=== Player built-in's ===
 
{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
|-
| CleanLibrary(database)
| <code>PlayDisc(param)</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.
| Will play the inserted CD or DVD media from the DVD-ROM drive.  
|
|-
|-
| exportlibrary(music,false,filepath)
| <code>PlayerControl(command)</code>
| The music library will be exported to a single file stored at filepath location.
| 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, 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.
|
|-
|-
| exportlibrary(video,true,thumbs,overwrite,actorthumbs)
| <code>PlayerResolutionSelect</code>
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).
| Select a different resolution
| v18
|-
|-
| PageDown
| <code>Playlist.Clear</code>
| Send a page down event to the pagecontrol with given id.
| Clear the current playlist
|
|-
|-
| PageUp
| <code>Playlist.PlayOffset</code>
| Send a page up event to the pagecontrol with given id.
| Start playing from a particular offset in the playlist
|-{{frodo row}}
|  
| <s>LastFM.Love</s>
| <s>All songs that can be submitted to Last.fm can be loved, optional parameter (false) = direct loving without confirmationdialog.</s> '''([[:Category:Frodo feature|Future Frodo removal]])'''
|-{{frodo row}}
| <s>LastFM.Ban</s>
| <s>Only songs that are playing on last.fm radio can be banned, optional parameter (false) = direct banning without confirmationdialog.</s> '''([[:Category:Frodo feature|Future Frodo removal]])'''
|-
|-
| Container.Refresh
| <code>PlayMedia(media[,isdir][,1],[playoffset=xx])</code>
| Refresh current listing.
| 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 a video in a preview window, instead of fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from.  
|  
|-
|-
| Container.Update
| <code>PlayWith()</code>
| Update current listing. Send Container.Update(path,replace) to reset the path history.
| Play the selected item with the specified player core.  
|
|-
|-
| Container.NextViewMode
| <code>Seek(seconds)</code>
| Select the next view mode.
| 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}}
|-
|-
| Container.PreviousViewMode
|}
| Select the previous view mode.
 
=== Profile built-in's ===
 
{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
|-
| Container.SetViewMode(id)
| <code>LoadProfile(profilename,[prompt])</code>
| Set the current view mode (list, icons etc.) to the given container id.
| 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.  
|
|-
|-
| Container.NextSortMethod
| <code>Mastermode</code>
| Change to the next sort method.
| Runs Kodi in master mode
|  
|-
|-
| Container.PreviousSortMethod
| <code>System.LogOff</code>
| Change to the previous sort method.
| Log off current user.  
|
|-
|-
| Container.SetSortMethod
|}
| Change to the specified sort method.
 
=== PVR built-in's ===
 
{| class="prettytable sort sortable" style="width: 100%;"
!  style="width: 29%"| Function
!  style="width: 66%"| Description
!  style="width: 5%"| Version
|-
|-
| Container.SortDirection
| <code>PVR.SearchMissingChannelIcons</code>
| Toggle the sort direction.
| Will start a search for missing channel icons
| {{nowrap|v16 Addition}}
|-
|-
| Control.Move(id,offset)
| <code>PVR.ToggleRecordPlayingChannel</code>
| Will make a Container with the "id" specified in the command move focus by "offset".
| Will toggle recording on playing channel, if any
| v18
|-
|-
| Control.SetFocus(id,position)
| <code>PVR.SeekPercentage</code>
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position)
| 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
|-
|-
| Control.Message(id,message,[windowid])
| <code>ReloadSkin()</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.
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)  
|
|-
|-
| SendClick(windowid,id)
| <code>Skin.Reset(setting)</code>
| Sends a click to a control in a given window (or active window if omitted).
| 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.  
|
|-
|-
| LoadProfile(profilename,[prompt])
| <code>Skin.ResetSettings</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.
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)  
|  
|-
|-
| SetProperty(key,value[,id])
| <code>Skin.SelectBool(header, label1&#124;setting1, label2&#124;setting2)</code>
| Sets a window property for the current window (key,value), or the specified window (key,value,id).
| Pops up select dialog to select between multiple skin setting options. Skin.SelectBool(424, 31411&#124;RecentWidget, 31412&#124;RandomWidget, 31413&#124;InProgressWidget)
|
|-
|-
| ClearProperty(key[,id])
| <code>Skin.SetAddon(string,type)</code>
| Clears a window property for the current focused window/dialog(key), or the specified window (key,id).
| 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.  
|
|-
|-
| PlayWith()
| <code>Skin.SetBool(setting)</code>
| Play the selected item with the specified player core.
| 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.
|
|-
|-
| WakeOnLan(mac)
| <code>Skin.SetFile(string,mask,folderpath)</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).
| 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.
|
|-
|-
| LCD.Suspend <font color="red">! NOT FOUND IN CODE !</font>
| <code>Skin.SetImage(string[,value,path])</code>
| Suspends LCDproc.
| 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.
|
|-
|-
| LCD.Resume <font color="red">! NOT FOUND IN CODE !</font>
| <code>Skin.SetNumeric(numeric[,value])</code>
| Resumes LCDproc.
| Pops up a keyboard dialog and allows the user to input a numerical.  
|
|-
|-
| Addon.Default.OpenSettings
| <code>Skin.SetPath(string[,folderpath])</code>
| Open a settings dialog for the default addon of the given type
| 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.
|
|-
|-
| Addon.Default.Set
| <code>Skin.SetString(string[,value])</code>
| Open a select dialog to allow choosing the default addon of the given type
| 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.
|
|-
|-
| Addon.OpenSettings(id)
| <code>Skin.Theme(1)</code>
| Open a settings dialog for the addon of the given id
| Cycles the skin theme. Skin.Theme(-1) will go backwards.
|
|-
|-
| UpdateAddonRepos
| <code>Skin.ToggleDebug</code>
| Triggers a forced update of enabled add-on repositories.
| Toggles skin debug info on/off
|
|-
|-
| UpdateLocalAddons
| <code>Skin.ToggleSetting(setting)</code>
| Triggers a scan of local add-on directories.
| Toggles the skin setting ?setting? for use with conditional visibility tags containing Skin.HasSetting(setting).  
|
|-
|-
| ToggleDPMS
| <code>UnloadSkin()</code>
| Toggle DPMS mode manually
| Unloads the current skin
|  
|-
|-
| CECToggleState
|}
| Toggle state of playing device via a CEC peripheral
 
=== 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>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
|  
|-
|-
| CECActivateSource
| <code>Weather.LocationPrevious</code>
| Wake up playing device via a CEC peripheral
| Switch to previous weather location
|  
|-
|-
| CECStandby
| <code>Weather.LocationSet</code>
| Put playing device on standby via a CEC peripheral
| Switch to given weather location (parameter can be 1-3)
|  
|-
|-
| Weather.Refresh
| <code>Weather.Refresh</code>
| Force weather data refresh
| 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/master/xbmc/utils/SortUtils.cpp#L529-L577 here]:
{| class="prettytable"
! ID
! Description
|-
|-
| Weather.LocationNext
| <code>1</code>
| Switch to next weather location
| Name
|-
|-
| Weather.LocationPrevious
| <code>2</code>
| Switch to previous weather location
| Date
|-
|-
| Weather.LocationSet
| <code>3</code>
| Switch to given weather location (parameter can be 1-3)
| Size
|-
|-
| LIRC.Stop
| <code>4</code>
| Removes XBMC as a LIRC client.
| File
|-
|-
| LIRC.Start
| <code>5</code>
| Adds XBMC as a LIRC client.
| Path
|-
|-
| LIRC.Send(command)
| <code>6</code>
| Sends a command to LIRC, syntax is the lirc protocol without the newline.<br />Example: LIRC.Send(SEND_ONCE Onkyo_RC-453S2 volup)
| DriveType
|-
|-
| VideoLibrary.Search
| <code>7</code>
| Brings up a search dialog which will search the library
| Title
|-
|-
| ToggleDebug
| <code>8</code>
| Enables/disables debug mode
| 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
|-
|-
| StartPVRManager
| <code>50</code>
| (Re)Starts the PVR manager
| InstallDate
|-
|-
| StopPVRManager
| <code>51</code>
| Stops the PVR manager
| LastUpdated
|-
|-
| StartAndroidActivity(package,[intent,dataType,dataURI])
| <code>52</code>
| Launch an Android native app with the given package name.  Optional parms (in order): intent, dataType, dataURI.
| LastUsed
|}
|}
{{updated|18}}


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


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

Revision as of 11:02, 28 November 2018

Home icon grey.png   ▶ Python development
▶ Add-on development
▶ Skinning		 ▶ Built-in scripting ▶ List of built-in functions

Skins can use built-in functions with the <onclick> or <onfocus> tag. Scripts can call built-in functions with xbmc.executebuiltin(function, block).

The latest up-to-date list of built-in functions can be found in the source code files in [1].

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.

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

You can use parameters with all media windows, as can be seen here:

List of functions


Add-on built-in's

Function Description Version
Addon.Default.OpenSettings(extensionpoint) Open a settings dialog for the default addon of the given type (extensionpoint)
Addon.Default.Set(extensionpoint) Open a select dialog to allow choosing the default addon of the given type (extensionpoint)
Addon.OpenSettings(id) Open a settings dialog for the addon of the given id
InstallAddon(id) Will install the addon with the given id.
InstallFromZip Opens the "Install from zip"-dialog if "Unknown sources" is enabled. Prompts the warning message if not.
RunAddon(id) Runs the specified plugin/script
RunAppleScript(script[,args]*) Run the specified AppleScript command
RunPlugin(plugin) Runs the plugin. Full path must be specified. Does not work for folder plugins
RunScript(script[,args]*) Runs the python script. You must specify the full path to the script. One way to specify the full path is through the special protocol. If the script is an add-on, you can also execute it using its add-on id. As of 2007/02/24, all extra parameters are passed to the script as arguments and can be accessed by python using sys.argv
StopScript(id) Stop the script by ID or path, if running v12 Addition
UpdateAddonRepos Triggers a forced update of enabled add-on repositories.
UpdateLocalAddons Triggers a scan of local add-on directories.

Android built-in's

Function Description Version
StartAndroidActivity(package,[intent,dataType,dataURI]) Launch an Android native app with the given package name. Optional parms (in order): intent, dataType, dataURI. example: StartAndroidActivity(com.android.chrome,android.intent.action.VIEW,,http://kodi.tv/) v13 Addition

Application built-in's

Function Description Version
Extract(archive_url[, destination]) Extracts a specified archive to an optionally specified 'absolute' path.
Mute Mutes (or unmutes) the volume.
NotifyAll(sender, data [, json]) Notify all connected clients v13 Addition
SetVolume(percent[,showvolumebar]) Sets the volume to the percentage specified. Optionally, show the Volume Dialog in Kodi when setting the volume.
ToggleDebug Enables/disables debug mode v12 Addition
ToggleDPMS Toggle DPMS (VESA Display Power Management Signaling) mode manually
WakeOnLan(mac) 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

Function Description Version
CECActivateSource Wake up playing device via a CEC peripheral v13 Addition
CECStandby Put playing device on standby via a CEC peripheral v13 Addition
CECToggleState Toggle state of playing device via a CEC peripheral v13 Addition

GUI built-in's

Function Description Version
Action(action[,window]) 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.
ActivateWindow(window[,dir,return]) 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.
ActivateWindowAndFocus(id1, id2,item1, id3,item2) 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). v12 Addition
AlarmClock(name,command,time[,silent,loop]) 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.
CancelAlarm(name[,silent]) Cancel a running alarm. Set silent to true to hide the alarm notification.
ClearProperty(key[,id]) Clears a window property for the current focused window/dialog(key), or the specified window (key,id).
Dialog.Close(dialog[,force]) Close a dialog. Set force to true to bypass animations. Use (all,true) to close all opened dialogs at once.
NextChannelGroup Navigate to the next PVR channel group (in DialogPVRChannelsOSD.xml) v13 Addition
NextStereoMode Changes the stereo mode of the GUI to the next available mode. v13 Addition
Notification(header,message[,time,image]) 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.
PreviousChannelGroup Navigate to the previous PVR channel group (in DialogPVRChannelsOSD.xml) v13 Addition
PreviousStereoMode Changes the stereo mode of the GUI to the previous available mode. v13 Addition
RefreshRSS Reload RSS feeds from RSSFeeds.xml
ReplaceWindow(window,dir) 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.
ReplaceWindowAndFocus(id1, id2,item1, id3,item2) 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). v13 Addition
Resolution Change Kodi's Resolution.
SetGUILanguage(value) Set GUI Language, 'value' is the language file to use. SetGUILanguage(resource.language.de_de) v13 Addition
SetProperty(key,value[,id]) Sets a window property for the current window (key,value), or the specified window (key,value,id).
SetStereoMode 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) v13 Addition
settingslevelchange Toggles the visible settings (in SettingsCategory.xml) between 'basic', 'standard', 'advanced and 'expert' v13 Addition
TakeScreenshot([filenameandpath,sync]) 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).
ToggleDirtyRegionVisualization makes dirty regions visible for debugging proposes. v16 Addition
ToggleStereoMode Toggle the stereoscopic mode of the GUI (on/off). v13 Addition

GUI container built-in's

Function Description Version
Container.NextSortMethod Change to the next sort method.
Container.NextViewMode Select the next view mode.
Container.PreviousSortMethod Change to the previous sort method.
Container.PreviousViewMode Select the previous view mode.
Container.Refresh Refresh current listing.
Container.SetSortMethod(id) Change to the specified sort method. (For list of ID's see List of sort methods below)
Container.SetViewMode(id) Set the current view mode (list, icons etc.) to the given container id.
Container.SetSortDirection Toggle the sort direction.
Container.Update Update current listing. Send Container.Update(path,replace) to reset the path history.

GUI control built-in's

Function Description Version
Control.Message(id,message,[windowid]) Sends a given message to a control in a given window (or active window if omitted). Messages can be movedown, moveup, pagedown, pageup, click.
Control.Move(id,offset) Will make a Container with the "id" specified in the command move focus by "offset".
Control.SetFocus(id,position[,absolute]) 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)
PageDown Send a page down event to the pagecontrol with given id.
PageUp Send a page up event to the pagecontrol with given id.
SendClick(windowid,id) Sends a click to a control in a given window (or active window if omitted).
SetFocus(id,position[,absolute]) 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

Function Description Version
CleanLibrary(database) 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.
exportlibrary(music,false,filepath) The music library will be exported to a single file stored at filepath location.
exportlibrary(video,true,thumbs,overwrite,actorthumbs) The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).
UpdateLibrary(database,[path]) 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.
VideoLibrary.Search Brings up a search dialog which will search the library

Optical container built-in's

Function Description Version
EjectTray() Either opens or closes the DVD tray, depending on its current state
RipCD Will rip the inserted CD from the DVD-ROM drive.

Picture built-in's

Function Description Version
RecursiveSlideShow(dir) Run a slideshow from the specified directory, including all subdirs
ShowPicture(picture) Show a picture by its file path/url. v13 Addition
SlideShow(dir[,recursive][,[not]random][,pause][,beginslide="/path/to/start/slide.jpg"]) 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

Function Description Version
PlayDisc(param) Will play the inserted CD or DVD media from the DVD-ROM drive.
PlayerControl(command) 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, 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.

PlayerResolutionSelect Select a different resolution v18
Playlist.Clear Clear the current playlist
Playlist.PlayOffset Start playing from a particular offset in the playlist
PlayMedia(media[,isdir][,1],[playoffset=xx]) 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 a video in a preview window, instead of fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from.
PlayWith() Play the selected item with the specified player core.
Seek(seconds) Seeks to the specified relative amount of seconds within the current playing media. A negative value will seek backward and a positive value forward. v15 Addition

Profile built-in's

Function Description Version
LoadProfile(profilename,[prompt]) 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.
Mastermode Runs Kodi in master mode
System.LogOff Log off current user.

PVR built-in's

Function Description Version
PVR.SearchMissingChannelIcons Will start a search for missing channel icons v16 Addition
PVR.ToggleRecordPlayingChannel Will toggle recording on playing channel, if any v18
PVR.SeekPercentage Performs a seek to the given percentage in timeshift buffer, if timeshifting is supported

Skin built-in's

Function Description Version
ReloadSkin() Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)
Skin.Reset(setting) 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.
Skin.ResetSettings Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)
Skin.SelectBool(header, label1|setting1, label2|setting2) Pops up select dialog to select between multiple skin setting options. Skin.SelectBool(424, 31411|RecentWidget, 31412|RandomWidget, 31413|InProgressWidget)
Skin.SetAddon(string,type) 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.
Skin.SetBool(setting) 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.
Skin.SetFile(string,mask,folderpath) 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 "|" (minus quotes). If the folderpath parameter is set the file browser will start in that folder.
Skin.SetImage(string[,value,path]) 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.
Skin.SetNumeric(numeric[,value]) Pops up a keyboard dialog and allows the user to input a numerical.
Skin.SetPath(string[,folderpath]) 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.
Skin.SetString(string[,value]) 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.
Skin.Theme(1) Cycles the skin theme. Skin.Theme(-1) will go backwards.
Skin.ToggleDebug Toggles skin debug info on/off
Skin.ToggleSetting(setting) Toggles the skin setting ?setting? for use with conditional visibility tags containing Skin.HasSetting(setting).
UnloadSkin() Unloads the current skin

System built-in's

Function Description Version
ActivateScreensaver Starts the screensaver v13 Addition
Hibernate Hibernate (S4) the System
InhibitIdleShutdown(true/false) Prevent the system to shutdown on idle. v12 Addition
Minimize Minimizes Kodi
Powerdown Powerdown system
Quit Quits Kodi
Reboot Cold reboots the system (power cycle)
Reset Reset the system (same as reboot)
RestartApp Restarts Kodi (only implemented under Windows and Linux)
ShutDown Trigger default Shutdown action defined in System Settings
Suspend Suspends (S3 / S1 depending on bios setting) the System
System.Exec(exec) Execute shell commands. The full path to the script has to be placed inside the parentheses.
System.ExecWait(exec) 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

Function Description Version
Weather.LocationNext Switch to next weather location
Weather.LocationPrevious Switch to previous weather location
Weather.LocationSet Switch to given weather location (parameter can be 1-3)
Weather.Refresh Force weather data refresh



Removed functions

  • LastFM.Love - Removed in v13 Gotham
  • LastFM.Ban - Removed in v13 Gotham
  • LCD.Suspend - Removed in v13 Gotham
  • LCD.Resume - Removed in v13 Gotham
  • AllowIdleShutdown
  • Help
  • LIRC.Send(command)
  • LIRC.Start
  • LIRC.Stop
  • StartPVRManager
  • StereoModeToMono
  • StopPVRManager


List of sort methods

These ID's can be used with the Container.SetSortMethod(id) function as listed here:

ID Description
1 Name
2 Date
3 Size
4 File
5 Path
6 DriveType
7 Title
8 TrackNumber
9 Time
10 Artist
11 ArtistThenYear
12 Album
13 AlbumType
14 Genre
15 Country
16 Year
17 Rating
18 UserRating
19 Votes
20 Top250
21 ProgramCount
22 PlaylistOrder
23 EpisodeNumber
24 Season
25 NumberOfEpisodes
26 NumberOfWatchedEpisodes
27 TvShowStatus
28 TvShowTitle
29 SortTitle
30 ProductionCode
31 MPAA
32 VideoResolution
33 VideoCodec
34 VideoAspectRatio
35 AudioChannels
36 AudioCodec
37 AudioLanguage
38 SubtitleLanguage
39 Studio
40 DateAdded
41 LastPlayed
42 Playcount
43 Listeners
44 Bitrate
45 Random
46 Channel
47 ChannelNumber
48 DateTaken
49 Relevance
50 InstallDate
51 LastUpdated
52 LastUsed

See also

Retrieved from "https://kodi.wiki/index.php?title=List_of_built-in_functions&oldid=149099"