Difference between revisions of "List of built-in functions"

From Official Kodi Wiki
Jump to: navigation, search
(List of sort methods)
m (Porfile built-in's)
(40 intermediate revisions by 9 users not shown)
Line 18: Line 18:
 
== List of functions ==
 
== List of functions ==
 
<section begin="functions" />
 
<section begin="functions" />
{| class="prettytable sort sortable"
+
 
! Function
+
=== Add-on built-in's ===
! Description
+
 
! Version
+
{| 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>Help</code>
+
| <code>InstallAddon(id)</code>
| This help message (??? probably broken)
+
| Will install the addon with the given id.
 
|  
 
|  
 
|-
 
|-
| <code>Reboot</code>
+
| <code>InstallFromZip</code>
| Cold reboots the system (power cycle)
+
| Opens the "Install from zip"-dialog if "Unknown sources" is enabled. Prompts the warning message if not.
 
|
 
|
 
|-
 
|-
| <code>ShutDown</code>
+
| <code>RunAddon(id)</code>
| Trigger default Shutdown action defined in System Settings
+
| Runs the specified plugin/script
|
+
|  
 
|-
 
|-
| <code>Powerdown</code>
+
| <code>RunAppleScript(script[,args]*)</code>
| Powerdown system
+
| Run the specified AppleScript command
|
+
|  
 
|-
 
|-
| <code>Quit</code>
+
| <code>RunPlugin(plugin)</code>
| Quits Kodi
+
| Runs the plugin. Full path must be specified. Does not work for folder plugins
|
+
|  
 
|-
 
|-
| <code>Hibernate</code>
+
| <code>RunScript(script[,args]*)</code>
| Hibernate (S4) the System
+
| 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>Suspend</code>
+
| <code>StopScript(id)</code>
| Suspends (S3 / S1 depending on bios setting) the System
+
| Stop the script by ID or path, if running
|
 
|-
 
| <code>InhibitIdleShutdown(true/false)</code>
 
| Prevent the system to shutdown on idle.
 
 
| {{nowrap|v12 Addition}}
 
| {{nowrap|v12 Addition}}
|-  
+
|-
| <code>AllowIdleShutdown</code>
+
| <code>UpdateAddonRepos</code>
| Allow the system to shutdown on idle.
+
| 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}}
 
| {{nowrap|v12 Addition}}
 
|-
 
|-
| <code>ActivateScreensaver</code>
+
| <code>ToggleDPMS</code>
| Starts the screensaver
+
| Toggle DPMS (VESA Display Power Management Signaling) mode manually
| {{nowrap|v13 Addition}}
+
|  
 
|-
 
|-
| <code>RestartApp</code>
+
| <code>WakeOnLan(mac)</code>
| Restarts Kodi (only implemented under Windows and Linux)
+
| 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).
|
+
|  
 
|-
 
|-
| <code>Minimize</code>
+
|}
| Minimizes Kodi
+
 
|
+
=== CEC built-in's ===
 +
 
 +
{| class="prettytable sort sortable" style="width: 100%;"
 +
!  style="width: 29%"| Function
 +
!  style="width: 66%"| Description
 +
!  style="width: 5%"| Version
 
|-
 
|-
| <code>Reset</code>
+
| <code>CECActivateSource</code>
| Reset the system (same as reboot)
+
| Wake up playing device via a CEC peripheral
|
+
| {{nowrap|v13 Addition}}
 
|-
 
|-
| <code>Mastermode</code>
+
| <code>CECStandby</code>
| Runs Kodi in master mode
+
| Put playing device on standby via a CEC peripheral
|
+
| {{nowrap|v13 Addition}}
 
|-
 
|-
| <code>SetGUILanguage</code>
+
| <code>CECToggleState</code>
| Set GUI Language
+
| Toggle state of playing device via a CEC peripheral
 
| {{nowrap|v13 Addition}}
 
| {{nowrap|v13 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>
 
| <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. [[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 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.
+
| 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>
 
| <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).
 
| 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}}
 
| {{nowrap|v12 Addition}}
 
|-
 
|-
| <code>ReplaceWindow(window,dir)</code>
+
| <code>AlarmClock(name,command,time[,silent,loop])</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.
+
| 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.
|
+
|
 +
|-
 +
| <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>ReplaceWindowAndFocus(id1, id2,item1, id3,item2)</code>
+
| <code>NextStereoMode</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).
+
| Changes the stereo mode of the GUI to the next available mode.
 
| {{nowrap|v13 Addition}}
 
| {{nowrap|v13 Addition}}
 
|-
 
|-
| <code>TakeScreenshot</code>
+
| <code>Notification(header,message[,time,image])</code>
| Takes a Screenshot
+
| 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>RunScript(script[,args]*)</code>
+
| <code>PreviousChannelGroup</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
+
| Navigate to the previous PVR channel group (in DialogPVRChannelsOSD.xml)
|
+
| {{nowrap|v13 Addition}}
|-
 
| <code>StopScript(id)</code>
 
| Stop the script by ID or path, if running
 
| {{nowrap|v12 Addition}}
 
 
|-
 
|-
| <code>RunAppleScript(script[,args]*)</code>
+
| <code>PreviousStereoMode</code>
| Run the specified AppleScript command
+
| Changes the stereo mode of the GUI to the previous available mode.
|
+
| {{nowrap|v13 Addition}}
 
|-
 
|-
| <code>RunPlugin(plugin)</code>
+
| <code>RefreshRSS</code>
| Runs the plugin. Full path must be specified. Does not work for folder plugins
+
| Reload RSS feeds from RSSFeeds.xml
|
+
|  
 
|-
 
|-
| <code>RunAddon(id)</code>
+
| <code>ReplaceWindow(window,dir)</code>
| Runs the specified plugin/script
+
| 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>NotifyAll</code>
+
| <code>ReplaceWindowAndFocus(id1, id2,item1, id3,item2)</code>
| Notify all connected clients
+
| 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}}
 
| {{nowrap|v13 Addition}}
 
|-
 
|-
| <code>Extract</code>
+
| <code>Resolution</code>
| Extracts a specified archive to an optionally specified 'absolute' path.  
+
| Change Kodi's Resolution.  
|
+
|  
 
|-
 
|-
| <code>PlayMedia(media[,isdir][,1],[playoffset=xx])</code>
+
| <code>SetGUILanguage(value)</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.
+
| Set GUI Language, 'value' is the language file to use. SetGUILanguage(resource.language.de_de)
|
+
| {{nowrap|v13 Addition}}
 
|-
 
|-
| <code>Seek(seconds)</code>
+
| <code>SetProperty(key,value[,id])</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.
+
| Sets a window property for the current window (key,value), or the specified window (key,value,id).  
| {{nowrap|v15 Addition}}
+
|  
 
|-
 
|-
| <code>ShowPicture(picture)</code>
+
| <code>SetStereoMode</code>
| Show a picture by its file path/url.
+
| 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}}
 
| {{nowrap|v13 Addition}}
 
|-
 
|-
| <code>SlideShow(dir [,recursive, [not]random])</code>
+
| <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}}
 
|-
 
|-
| <code>RecursiveSlideShow(dir)</code>
+
| <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).
|
+
|  
 
|-
 
|-
| <code>ReloadSkin()</code>
+
| <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}}
 
|-
 
|-
| <code>UnloadSkin()</code>
+
| <code>ToggleStereoMode</code>
| Unloads the current skin
+
| Toggle the stereoscopic mode of the GUI (on/off).
|
+
| {{nowrap|v13 Addition}}
 
|-
 
|-
| <code>Skin.ToggleDebug</code>
+
|}
| Toggles skin debug info on/off
+
 
|
+
=== 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>RefreshRSS</code>
+
| <code>Container.NextSortMethod</code>
| Reload RSS feeds from RSSFeeds.xml
+
| Change to the next sort method.  
|
+
|  
 
|-
 
|-
| <code>PlayerControl(command)</code>
+
| <code>Container.NextViewMode</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.
+
| Select the next view mode.  
|
+
|  
 
|-
 
|-
| <code>Playlist.PlayOffset</code>
+
| <code>Container.PreviousSortMethod</code>
| Start playing from a particular offset in the playlist
+
| Change to the previous sort method.
|
+
|  
 
|-
 
|-
| <code>Playlist.Clear</code>
+
| <code>Container.PreviousViewMode</code>
| Clear the current playlist
+
| Select the previous view mode.
|
+
|  
 
|-
 
|-
| <code>EjectTray()</code>
+
| <code>Container.Refresh</code>
| Either opens or closes the DVD tray, depending on its current state
+
| Refresh current listing.
|
+
|  
 
|-
 
|-
| <code>AlarmClock(name,command,time[,silent,loop])</code>
+
| <code>Container.SetSortMethod(id)</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.
+
| Change to the specified sort method. (For list of ID's see List of sort methods below)  
|
+
|  
 
|-
 
|-
| <code>CancelAlarm(name[,silent])</code>
+
| <code>Container.SetViewMode(id)</code>
| Cancel a running alarm. Set silent to true to hide the alarm notification.  
+
| Set the current view mode (list, icons etc.) to the given container id.  
|
+
|  
 
|-
 
|-
| <code>Action(action[,window])</code>
+
| <code>Container.SetSortDirection</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. [[Window IDs|See here for a list of window names, and their respective ids.]]
+
| Toggle the sort direction.  
|
+
|  
 
|-
 
|-
| <code>Notification(header,message[,time,image])</code>
+
| <code>Container.Update</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.
+
| Update current listing. Send Container.Update(path,replace) to reset the path history.  
|
+
|  
 
|-
 
|-
| <code>PlayDVD</code>
+
|}
| Will play the inserted CD or DVD media 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
 
|-
 
|-
| <code>RipCD</code>
+
| <code>Control.Message(id,message,[windowid])</code>
| Will rip the inserted CD from the <span class="nobr">DVD-ROM</span> drive.
+
| 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>Skin.ToggleSetting(setting)</code>
+
| <code>Control.Move(id,offset)</code>
| Toggles the skin setting ?setting? for use with [[Conditional Visibility|conditional visibility tags]] containing Skin.HasSetting(setting).
+
| Will make a Container with the "id" specified in the command move focus by "offset".  
|
+
|  
 
|-
 
|-
| <code>Skin.SetString(string[,value])</code>
+
| <code>Control.SetFocus(id,position[,absolute])</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 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>Skin.SetNumeric(numeric[,value])</code>
+
| <code>PageDown</code>
| Pops up a keyboard dialog and allows the user to input a numerical.
+
| Send a page down event to the pagecontrol with given id.  
|
+
|  
 
|-
 
|-
| <code>Skin.SetPath(string[,value])</code>
+
| <code>PageUp</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 up event to the pagecontrol with given id.  
|
+
|  
 
|-
 
|-
| <code>Skin.Theme</code>
+
| <code>SendClick(windowid,id)</code>
| Cycles the skin theme. Skin.theme(-1) will go backwards.
+
| Sends a click to a control in a given window (or active window if omitted).  
|
+
|  
 
|-
 
|-
| <code>Skin.SetImage(string[,value,path])</code>
+
| <code>SetFocus(id,position[,absolute])</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. the path option allows you to open the file browser in the specified folder.
+
| 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)  
|
+
|  
 
|-
 
|-
| <code>Skin.SetLargeImage(string[,value])</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.
+
 
|
+
=== Library built-in's ===
 +
 
 +
 
 +
{| class="prettytable sort sortable" style="width: 100%;"
 +
!  style="width: 29%"| Function
 +
!  style="width: 66%"| Description
 +
!  style="width: 5%"| Version
 
|-
 
|-
| <code>Skin.SetFile(string,mask,folderpath)</code>
+
| <code>CleanLibrary(database)</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 [[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.
+
| 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>Skin.SetAddon(string,type)</code>
+
| <code>exportlibrary(music,false,filepath)</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''.
+
| The music library will be exported to a single file stored at filepath location.  
|
+
|  
 
|-
 
|-
| <code>Skin.SetBool(setting)</code>
+
| <code>exportlibrary(video,true,thumbs,overwrite,actorthumbs)</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 Kodi settings.
+
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).  
|
+
|  
 
|-
 
|-
| <code>Skin.Reset(setting)</code>
+
| <code>UpdateLibrary(database,[path])</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.
+
| 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>Skin.ResetSettings</code>
+
| <code>VideoLibrary.Search</code>
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)
+
| Brings up a search dialog which will search the library
|
+
|  
 
|-
 
|-
| <code>Mute</code>
+
|}
| Mutes (or unmutes) 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
 
|-
 
|-
| <code>SetVolume(percent[,showvolumebar])</code>
+
| <code>EjectTray()</code>
| Sets the volume to the percentage specified. Optionally, show the Volume Dialog in Kodi when setting the volume.
+
| Either opens or closes the DVD tray, depending on its current state
|
+
|  
 
|-
 
|-
| <code>Dialog.Close(dialog[,force])</code>
+
| <code>RipCD</code>
| Close a dialog. Set force to true to bypass animations. Use (all,true) to close all opened dialogs at once.
+
| Will rip the inserted CD from the DVD-ROM drive.  
|
+
|  
 
|-
 
|-
| <code>System.LogOff</code>
+
|}
| Log off current user.
+
 
|
+
=== Picture built-in's ===
 +
 
 +
{| class="prettytable sort sortable" style="width: 100%;"
 +
!  style="width: 29%"| Function
 +
!  style="width: 66%"| Description
 +
!  style="width: 5%"| Version
 
|-
 
|-
| <code>System.Exec</code>
+
| <code>RecursiveSlideShow(dir)</code>
| Execute shell commands.
+
| Run a slideshow from the specified directory, including all subdirs
|
+
|  
 
|-
 
|-
| <code>System.ExecWait</code>
+
| <code>ShowPicture(picture)</code>
| Execute shell commands and freezes Kodi until shell is closed.
+
| Show a picture by its file path/url.
|
+
| {{nowrap|v13 Addition}}
 
|-
 
|-
| <code>Resolution</code>
+
| <code>SlideShow(dir[,recursive][,[not]random][,pause][,beginslide="/path/to/start/slide.jpg"])</code>
| Change Kodi's Resolution.
+
| 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.
|
+
|  
 
|-
 
|-
| <code>SetFocus(id,position)</code>
+
|}
| Will make a container with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position)
+
 
|
+
=== Player built-in's ===
 +
 
 +
{| class="prettytable sort sortable" style="width: 100%;"
 +
!  style="width: 29%"| Function
 +
!  style="width: 66%"| Description
 +
!  style="width: 5%"| Version
 
|-
 
|-
| <code>UpdateLibrary(database,[path])</code>
+
| <code>PlayDisc(param)</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.
+
| Will play the inserted CD or DVD media from the DVD-ROM drive.  
|
+
|  
 
|-
 
|-
| <code>CleanLibrary(database)</code>
+
| <code>PlayerControl(command)</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.
+
| 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.
 +
|  
 
|-
 
|-
| <code>exportlibrary(music,false,filepath)</code>
+
| <code>PlayerResolutionSelect</code>
| The music library will be exported to a single file stored at filepath location.
+
| Select a different resolution
|
+
| v18
 
|-
 
|-
| <code>exportlibrary(video,true,thumbs,overwrite,actorthumbs)</code>
+
| <code>Playlist.Clear</code>
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).
+
| Clear the current playlist
|
+
|  
 
|-
 
|-
| <code>PageDown</code>
+
| <code>Playlist.PlayOffset</code>
| Send a page down event to the pagecontrol with given id.
+
| Start playing from a particular offset in the playlist
|
+
|  
 
|-
 
|-
| <code>PageUp</code>
+
| <code>PlayMedia(media[,isdir][,1],[playoffset=xx])</code>
| Send a page up event to the pagecontrol with given id.
+
| 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.  
|
+
|  
 
|-
 
|-
| <code>Container.Refresh</code>
+
| <code>PlayWith()</code>
| Refresh current listing.
+
| Play the selected item with the specified player core.  
|
+
|  
 
|-
 
|-
| <code>Container.Update</code>
+
| <code>Seek(seconds)</code>
| Update current listing. Send Container.Update(path,replace) to reset the path history.
+
| 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}}
 
|-
 
|-
| <code>Container.NextViewMode</code>
+
|}
| Select the next 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
 
|-
 
|-
| <code>Container.PreviousViewMode</code>
+
| <code>LoadProfile(profilename,[prompt])</code>
| Select the previous view mode.
+
| 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>Container.SetViewMode(id)</code>
+
| <code>Mastermode</code>
| Set the current view mode (list, icons etc.) to the given container id.
+
| Runs Kodi in master mode  
|
+
|  
 
|-
 
|-
| <code>Container.NextSortMethod</code>
+
| <code>System.LogOff</code>
| Change to the next sort method.
+
| Log off current user.  
|
+
|  
 
|-
 
|-
| <code>Container.PreviousSortMethod</code>
+
|}
| Change to the previous 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
 
|-
 
|-
| <code>Container.SetSortMethod(id)</code>
+
| <code>PVR.SearchMissingChannelIcons</code>
| Change to the specified sort method. (For list of ID's see '''List of sort methods''' below)
+
| Will start a search for missing channel icons
|
+
| {{nowrap|v16 Addition}}
 
|-
 
|-
| <code>Container.SortDirection</code>
+
| <code>PVR.ToggleRecordPlayingChannel</code>
| Toggle the sort direction.
+
| Will toggle recording on playing channel, if any
|
+
| v18
 
|-
 
|-
| <code>Control.Move(id,offset)</code>
+
| <code>PVR.SeekPercentage</code>
| Will make a Container with the "id" specified in the command move focus by "offset".
+
| 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>Control.SetFocus(id,position)</code>
+
| <code>ReloadSkin()</code>
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position)
+
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)  
|
+
|  
 
|-
 
|-
| <code>Control.Message(id,message,[windowid])</code>
+
| <code>Skin.Reset(setting)</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.
+
| 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.  
|
+
|  
 
|-
 
|-
| <code>SendClick(windowid,id)</code>
+
| <code>Skin.ResetSettings</code>
| Sends a click to a control in a given window (or active window if omitted).
+
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)  
|
+
|  
 
|-
 
|-
| <code>LoadProfile(profilename,[prompt])</code>
+
| <code>Skin.SelectBool(header, label1&#124;setting1, label2&#124;setting2)</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.
+
| Pops up select dialog to select between multiple skin setting options. Skin.SelectBool(424, 31411&#124;RecentWidget, 31412&#124;RandomWidget, 31413&#124;InProgressWidget)
|
+
|  
 
|-
 
|-
| <code>SetProperty(key,value[,id])</code>
+
| <code>Skin.SetAddon(string,type)</code>
| Sets a window property for the current window (key,value), or the specified window (key,value,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.  
|
+
|  
 
|-
 
|-
| <code>ClearProperty(key[,id])</code>
+
| <code>Skin.SetBool(setting)</code>
| Clears a window property for the current focused window/dialog(key), or the specified window (key,id).
+
| 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.  
|
+
|  
 
|-
 
|-
| <code>PlayWith()</code>
+
| <code>Skin.SetFile(string,mask,folderpath)</code>
| Play the selected item with the specified player core.
+
| 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>WakeOnLan(''mac'')</code>
+
| <code>Skin.SetImage(string[,value,path])</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 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>Addon.Default.OpenSettings</code>
+
| <code>Skin.SetNumeric(numeric[,value])</code>
| Open a settings dialog for the default addon of the given type
+
| Pops up a keyboard dialog and allows the user to input a numerical.
|
+
|  
 
|-
 
|-
| <code>Addon.Default.Set</code>
+
| <code>Skin.SetPath(string[,folderpath])</code>
| Open a select dialog to allow choosing 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.
|
+
|  
 
|-
 
|-
| <code>Addon.OpenSettings(id)</code>
+
| <code>Skin.SetString(string[,value])</code>
| Open a settings dialog for the addon of the given id
+
| 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>UpdateAddonRepos</code>
+
| <code>Skin.Theme(1)</code>
| Triggers a forced update of enabled add-on repositories.
+
| Cycles the skin theme. Skin.Theme(-1) will go backwards.  
|
+
|  
 
|-
 
|-
| <code>UpdateLocalAddons</code>
+
| <code>Skin.ToggleDebug</code>
| Triggers a scan of local add-on directories.
+
| Toggles skin debug info on/off
|
+
|  
 
|-
 
|-
| <code>ToggleDPMS</code>
+
| <code>Skin.ToggleSetting(setting)</code>
| Toggle DPMS mode manually
+
| Toggles the skin setting ?setting? for use with conditional visibility tags containing Skin.HasSetting(setting).
|
+
|  
 
|-
 
|-
| <code>CECToggleState</code>
+
| <code>UnloadSkin()</code>
| Toggle state of playing device via a CEC peripheral
+
| Unloads the current skin
| {{nowrap|v13 Addition}}
+
|  
 
|-
 
|-
| <code>CECActivateSource</code>
+
|}
| Wake up playing device via a CEC peripheral
+
 
| {{nowrap|v13 Addition}}
+
=== System built-in's ===
 +
 
 +
{| class="prettytable sort sortable" style="width: 100%;"
 +
!  style="width: 29%"| Function
 +
!  style="width: 66%"| Description
 +
!  style="width: 5%"| Version
 
|-
 
|-
| <code>CECStandby</code>
+
| <code>ActivateScreensaver</code>
| Put playing device on standby via a CEC peripheral
+
| Starts the screensaver
 
| {{nowrap|v13 Addition}}
 
| {{nowrap|v13 Addition}}
 
|-
 
|-
| <code>Weather.Refresh</code>
+
| <code>Hibernate</code>
| Force weather data refresh
+
| Hibernate (S4) the System
|
+
|  
 
|-
 
|-
| <code>Weather.LocationNext</code>
+
| <code>InhibitIdleShutdown(true/false)</code>
| Switch to next weather location
+
| Prevent the system to shutdown on idle.
|
+
| {{nowrap|v12 Addition}}
 
|-
 
|-
| <code>Weather.LocationPrevious</code>
+
| <code>Minimize</code>
| Switch to previous weather location
+
| Minimizes Kodi
|
+
|  
 
|-
 
|-
| <code>Weather.LocationSet</code>
+
| <code>Powerdown</code>
| Switch to given weather location (parameter can be 1-3)
+
| Powerdown system
|
+
|  
 
|-
 
|-
| <code>LIRC.Stop</code>
+
| <code>Quit</code>
| Removes Kodi as a LIRC client.
+
| Quits Kodi  
|
+
|  
 
|-
 
|-
| <code>LIRC.Start</code>
+
| <code>Reboot</code>
| Adds Kodi as a LIRC client.
+
| Cold reboots the system (power cycle)
|
+
|  
 
|-
 
|-
| <code>LIRC.Send(command)</code>
+
| <code>Reset</code>
| Sends a command to LIRC, syntax is the lirc protocol without the newline.<br />Example: LIRC.Send(SEND_ONCE Onkyo_RC-453S2 volup)
+
| Reset the system (same as reboot)  
|
+
|  
 
|-
 
|-
| <code>VideoLibrary.Search</code>
+
| <code>RestartApp</code>
| Brings up a search dialog which will search the library
+
| Restarts Kodi (only implemented under Windows and Linux)  
|
+
|  
|-
 
| <code>ToggleDebug</code>
 
| Enables/disables debug mode
 
| {{nowrap|v12 Addition}}
 
|-
 
| <code>ToggleDirtyRegionVisualization</code>
 
| makes [[dirty regions]] visible for debugging proposes.
 
| v16 addition
 
|-
 
| <code>StartPVRManager</code>
 
| (Re)Starts the PVR manager
 
| {{nowrap|v12 Addition}}
 
|-
 
| <code>StopPVRManager</code>
 
| Stops the PVR manager
 
| {{nowrap|v12 Addition}}
 
|-
 
| <code>PVR.SearchMissingChannelIcons</code>
 
| Will start a search for missing channel icons
 
| {{nowrap|v16 Addition}}
 
 
|-
 
|-
| <code>{{nowrap|StartAndroidActivity(package,[intent,dataType,dataURI])}}</code>
+
| <code>ShutDown</code>
| Launch an Android native app with the given package name.  Optional parms (in order): intent, dataType, dataURI.
+
| Trigger default Shutdown action defined in System Settings
| {{nowrap|v13 Addition}}
+
|  
 
|-
 
|-
| <code>PreviousChannelGroup</code>
+
| <code>Suspend</code>
| Navigate to the previous PVR channel group (in DialogPVRChannelsOSD.xml)
+
| Suspends (S3 / S1 depending on bios setting) the System
| {{nowrap|v13 Addition}}
+
|  
 
|-
 
|-
| <code>NextChannelGroup</code>
+
| <code>System.Exec(exec)</code>
| Navigate to the next PVR channel group (in DialogPVRChannelsOSD.xml)
+
| Execute shell commands. The full path to the script has to be placed inside the parentheses.
| {{nowrap|v13 Addition}}
+
|  
 
|-
 
|-
| <code>settingslevelchange</code>
+
| <code>System.ExecWait(exec)</code>
| Toggles the visible settings (in SettingsCategory.xml) between 'basic', 'standard', 'advanced and 'expert'
+
| 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.
| {{nowrap|v13 Addition}}
+
|  
 
|-
 
|-
| <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}}
+
=== Weather built-in's ===
 +
 
 +
{| class="prettytable sort sortable" style="width: 100%;"
 +
!  style="width: 29%"| Function
 +
!  style="width: 66%"| Description
 +
!  style="width: 5%"| Version
 
|-
 
|-
| <code>NextStereoMode</code>
+
| <code>Weather.LocationNext</code>
| Changes the stereo mode of the GUI to the next available mode.
+
| Switch to next weather location
| {{nowrap|v13 Addition}}
+
|  
 
|-
 
|-
| <code>PreviousStereoMode</code>
+
| <code>Weather.LocationPrevious</code>
| Changes the stereo mode of the GUI to the previous available mode.
+
| Switch to previous weather location
| {{nowrap|v13 Addition}}
+
|  
 
|-
 
|-
| <code>ToggleStereoMode</code>
+
| <code>Weather.LocationSet</code>
| Toggle the stereoscopic mode of the GUI (on/off).
+
| Switch to given weather location (parameter can be 1-3)  
| {{nowrap|v13 Addition}}
+
|  
 
|-
 
|-
| <code>StereoModeToMono</code>
+
| <code>Weather.Refresh</code>
| Toggle the stereoscopic mode to 2D.
+
| Force weather data refresh
| {{nowrap|v13 Addition}}
+
|  
 
|}
 
|}
 
<section end="functions" />
 
<section end="functions" />
 
<section end="main content" />
 
<section end="main content" />
 +
  
 
== Removed functions ==
 
== Removed functions ==
Line 515: Line 643:
 
* <code>LCD.Suspend</code> - Removed in v13 Gotham
 
* <code>LCD.Suspend</code> - Removed in v13 Gotham
 
* <code>LCD.Resume</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 ==
 
== List of sort methods ==
These ID's can be used with the Container.SetSortMethod(id) function as found [https://github.com/xbmc/xbmc/blob/master/xbmc/utils/SortUtils.cpp#L529 here]:
+
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"
 
{| class="prettytable"
 
! ID
 
! ID
Line 553: Line 691:
 
|-
 
|-
 
| <code>11</code>
 
| <code>11</code>
 +
| ArtistThenYear
 +
|-
 +
| <code>12</code>
 
| Album
 
| Album
 
|-
 
|-
| <code>12</code>
+
| <code>13</code>
 
| AlbumType
 
| AlbumType
 
|-
 
|-
| <code>13</code>
+
| <code>14</code>
 
| Genre
 
| Genre
 
|-
 
|-
| <code>14</code>
+
| <code>15</code>
 
| Country
 
| Country
 
|-
 
|-
| <code>15</code>
+
| <code>16</code>
 
| Year
 
| Year
 
|-
 
|-
| <code>16</code>
+
| <code>17</code>
 
| Rating
 
| Rating
 
|-
 
|-
| <code>17</code>
+
| <code>18</code>
 +
| UserRating
 +
|-
 +
| <code>19</code>
 
| Votes
 
| Votes
 
|-
 
|-
| <code>18</code>
+
| <code>20</code>
 
| Top250
 
| Top250
 
|-
 
|-
| <code>19</code>
+
| <code>21</code>
 
| ProgramCount
 
| ProgramCount
 
|-
 
|-
| <code>20</code>
+
| <code>22</code>
 
| PlaylistOrder
 
| PlaylistOrder
 
|-
 
|-
| <code>21</code>
+
| <code>23</code>
 
| EpisodeNumber
 
| EpisodeNumber
 
|-
 
|-
| <code>22</code>
+
| <code>24</code>
 
| Season
 
| Season
 
|-
 
|-
| <code>23</code>
+
| <code>25</code>
 
| NumberOfEpisodes
 
| NumberOfEpisodes
 
|-
 
|-
| <code>24</code>
+
| <code>26</code>
 
| NumberOfWatchedEpisodes
 
| NumberOfWatchedEpisodes
 
|-
 
|-
| <code>25</code>
+
| <code>27</code>
 
| TvShowStatus
 
| TvShowStatus
 
|-
 
|-
| <code>26</code>
+
| <code>28</code>
 
| TvShowTitle
 
| TvShowTitle
 
|-
 
|-
| <code>27</code>
+
| <code>29</code>
 
| SortTitle
 
| SortTitle
 
|-
 
|-
| <code>28</code>
+
| <code>30</code>
 
| ProductionCode
 
| ProductionCode
 
|-
 
|-
| <code>29</code>
+
| <code>31</code>
 
| MPAA
 
| MPAA
 
|-
 
|-
| <code>30</code>
+
| <code>32</code>
 
| VideoResolution
 
| VideoResolution
 
|-
 
|-
| <code>31</code>
+
| <code>33</code>
 
| VideoCodec
 
| VideoCodec
 
|-
 
|-
| <code>32</code>
+
| <code>34</code>
 
| VideoAspectRatio
 
| VideoAspectRatio
 
|-
 
|-
| <code>33</code>
+
| <code>35</code>
 
| AudioChannels
 
| AudioChannels
 
|-
 
|-
| <code>34</code>
+
| <code>36</code>
 
| AudioCodec
 
| AudioCodec
 
|-
 
|-
| <code>35</code>
+
| <code>37</code>
 
| AudioLanguage
 
| AudioLanguage
 
|-
 
|-
| <code>36</code>
+
| <code>38</code>
 
| SubtitleLanguage
 
| SubtitleLanguage
 
|-
 
|-
| <code>37</code>
+
| <code>39</code>
 
| Studio
 
| Studio
 
|-
 
|-
| <code>38</code>
+
| <code>40</code>
 
| DateAdded
 
| DateAdded
 
|-
 
|-
| <code>39</code>
+
| <code>41</code>
 
| LastPlayed
 
| LastPlayed
 
|-
 
|-
| <code>40</code>
+
| <code>42</code>
 
| Playcount
 
| Playcount
 
|-
 
|-
| <code>41</code>
+
| <code>43</code>
 
| Listeners
 
| Listeners
 
|-
 
|-
| <code>42</code>
+
| <code>44</code>
 
| Bitrate
 
| Bitrate
 
|-
 
|-
| <code>43</code>
+
| <code>45</code>
 
| Random
 
| Random
 
|-
 
|-
| <code>44</code>
+
| <code>46</code>
 
| Channel
 
| Channel
 
|-
 
|-
| <code>45</code>
+
| <code>47</code>
 
| ChannelNumber
 
| ChannelNumber
 
|-
 
|-
| <code>46</code>
+
| <code>48</code>
 
| DateTaken
 
| DateTaken
 +
|-
 +
| <code>49</code>
 +
| Relevance
 +
|-
 +
| <code>50</code>
 +
| InstallDate
 +
|-
 +
| <code>51</code>
 +
| LastUpdated
 +
|-
 +
| <code>52</code>
 +
| LastUsed
 
|}
 
|}
 +
{{updated|18}}
  
 
== See also ==
 
== See also ==

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:

1 List of functions


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

1.2 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

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

1.4 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

1.5 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

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

1.7 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)

1.8 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

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

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

1.11 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

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

1.13 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

1.14 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

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

1.16 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



2 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


3 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

4 See also